diff --git a/Build.fsx b/Build.fsx index 206a319..ee1720b 100644 --- a/Build.fsx +++ b/Build.fsx @@ -1,37 +1,40 @@ -#r @"packages/FAKE.4.11.3/tools/FakeLib.dll" - -open Fake -open Fake.Testing - -Target "Clean" (fun _ -> - directExec (fun info -> - info.FileName <- "git" - info.Arguments <- "clean -xdf") - |> ignore) - -Target "Build" (fun _ -> - !! "Numsense.sln" - |> MSBuildRelease "" "Rebuild" - |> ignore) - -Target "Test" (fun _ -> - !! "*/bin/Release/*Ploeh.*.*Tests*.dll" - |> xUnit2 (fun p -> { p with Parallel = ParallelMode.All })) - -Target "PackageNuGet" (fun _ -> - let version = GetAssemblyVersion "Numsense/bin/Release/Ploeh.Numsense.dll" - let semVerString (v : System.Version) = - sprintf "%i.%i.%i" v.Major v.Minor v.Build - - NuGet (fun p -> - { p with - Version = semVerString version - WorkingDir = "." - OutputPath = "."}) "Numsense.nuspec") +#r @"packages/FAKE.5.16.0/tools/FakeLib.dll" + +open System +open System.Diagnostics +open System.IO +open Fake.Core +open Fake.DotNet +open Fake.Tools +open Fake.Api +open Fake.DotNet.Testing +open Fake.IO +open Fake.Core.TargetOperators +open Fake.IO.Globbing.Operators + +Target.create "Clean" <| fun _ -> + let psi = ProcessStartInfo() + psi.FileName <- "git" + psi.Arguments <- "clean -xdf" + psi.UseShellExecute <- true + + Process.Start psi |> ignore + +Target.create "Build" <| fun _ -> + DotNet.build (fun opts -> { + opts with Configuration = DotNet.Release + }) "Numsense.sln" + +Target.create "Test" <| fun _ -> + DotNet.test (fun opts -> { opts with Configuration = DotNet.Release }) "Numsense.sln" + +Target.create "CopyNuGetPackage" <| fun _ -> + !! "Numsense/bin/Release/*.nupkg" + |> Shell.copy "." "Clean" ==> "Build" ==> "Test" -==> "PackageNuGet" +==> "CopyNuGetPackage" -RunTargetOrDefault "PackageNuGet" \ No newline at end of file +Target.runOrDefault "CopyNuGetPackage" \ No newline at end of file diff --git a/Numsense.UnitTests.CSharp/Numsense.UnitTests.CSharp.csproj b/Numsense.UnitTests.CSharp/Numsense.UnitTests.CSharp.csproj index a3c7f5f..9d144ae 100644 --- a/Numsense.UnitTests.CSharp/Numsense.UnitTests.CSharp.csproj +++ b/Numsense.UnitTests.CSharp/Numsense.UnitTests.CSharp.csproj @@ -1,100 +1,28 @@ - - - + + - Debug - AnyCPU - {5FEBD8A6-3ED8-4E4F-B484-DE4CB77B6034} + netcoreapp3.1 + false + 1.0.0 + Copyright © Mark Seemann 2015 + + + https://github.com/ploeh/Numsense + true Library - Properties - Ploeh.Numsense.UnitTests - Ploeh.Numsense.UnitTests.CSharp - v4.5 - 512 - - - true - full - false - bin\Debug\ - DEBUG;TRACE - prompt - 4 - - - pdbonly - true - bin\Release\ - TRACE - prompt - 4 - - - - ..\packages\FsCheck.2.2.4\lib\net45\FsCheck.dll - True - - - ..\packages\FsCheck.Xunit.2.2.4\lib\net45\FsCheck.Xunit.dll - True - - - ..\packages\FSharp.Core.4.0.0.1\lib\net40\FSharp.Core.dll - True - - - - - - - - - - - ..\packages\xunit.abstractions.2.0.0\lib\net35\xunit.abstractions.dll - True - - - ..\packages\xunit.assert.2.1.0\lib\dotnet\xunit.assert.dll - True - - - ..\packages\xunit.extensibility.core.2.1.0\lib\dotnet\xunit.core.dll - True - - - ..\packages\xunit.extensibility.execution.2.1.0\lib\net45\xunit.execution.desktop.dll - True - - - - - - - - - - - Designer - - - + - - {72a79661-f252-4571-a857-268ce356e88a} - Numsense - + + + + all + runtime; build; native; contentfiles; analyzers; buildtransitive + + - + - - + diff --git a/Numsense.UnitTests.CSharp/Properties/AssemblyInfo.cs b/Numsense.UnitTests.CSharp/Properties/AssemblyInfo.cs deleted file mode 100644 index 8356e9f..0000000 --- a/Numsense.UnitTests.CSharp/Properties/AssemblyInfo.cs +++ /dev/null @@ -1,36 +0,0 @@ -using System.Reflection; -using System.Runtime.CompilerServices; -using System.Runtime.InteropServices; - -// General Information about an assembly is controlled through the following -// set of attributes. Change these attribute values to modify the information -// associated with an assembly. -[assembly: AssemblyTitle("Numsense C# UnitTests")] -[assembly: AssemblyDescription("")] -[assembly: AssemblyConfiguration("")] -[assembly: AssemblyCompany("")] -[assembly: AssemblyProduct("Ploeh.Numsense.UnitTests.CSharp")] -[assembly: AssemblyCopyright("Copyright © Mark Seemann 2015")] -[assembly: AssemblyTrademark("")] -[assembly: AssemblyCulture("")] - -// Setting ComVisible to false makes the types in this assembly not visible -// to COM components. If you need to access a type in this assembly from -// COM, set the ComVisible attribute to true on that type. -[assembly: ComVisible(false)] - -// The following GUID is for the ID of the typelib if this project is exposed to COM -[assembly: Guid("5febd8a6-3ed8-4e4f-b484-de4cb77b6034")] - -// Version information for an assembly consists of the following four values: -// -// Major Version -// Minor Version -// Build Number -// Revision -// -// You can specify all the values or you can default the Build and Revision Numbers -// by using the '*' as shown below: -// [assembly: AssemblyVersion("1.0.*")] -[assembly: AssemblyVersion("0.12.0.0")] -[assembly: AssemblyFileVersion("0.12.0.0")] diff --git a/Numsense.UnitTests.CSharp/app.config b/Numsense.UnitTests.CSharp/app.config deleted file mode 100644 index 8902bcf..0000000 --- a/Numsense.UnitTests.CSharp/app.config +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - - - - - - - diff --git a/Numsense.UnitTests.CSharp/packages.config b/Numsense.UnitTests.CSharp/packages.config deleted file mode 100644 index bb2d35b..0000000 --- a/Numsense.UnitTests.CSharp/packages.config +++ /dev/null @@ -1,11 +0,0 @@ - - - - - - - - - - - \ No newline at end of file diff --git a/Numsense.UnitTests/App.config b/Numsense.UnitTests/App.config deleted file mode 100644 index e97d76a..0000000 --- a/Numsense.UnitTests/App.config +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - - - - diff --git a/Numsense.UnitTests/Numsense.UnitTests.fsproj b/Numsense.UnitTests/Numsense.UnitTests.fsproj index e60610c..ac8e7b7 100644 --- a/Numsense.UnitTests/Numsense.UnitTests.fsproj +++ b/Numsense.UnitTests/Numsense.UnitTests.fsproj @@ -1,55 +1,16 @@ - - - + + - Debug - AnyCPU - 2.0 - fc7bd508-0445-428a-ac8c-2ddca3efeade + netcoreapp3.1 + 1.0.0 + Copyright © Mark Seemann 2015 + + + https://github.com/ploeh/Numsense + true Library - Numsense.UnitTests - Ploeh.Numsense.UnitTests - v4.5 - 4.4.0.0 - true - Numsense.UnitTests - - - true - full - false - false - bin\Debug\ - DEBUG;TRACE - 3 - bin\Debug\Numsense.UnitTests.XML - - - pdbonly - true - true - bin\Release\ - TRACE - 3 - bin\Release\Numsense.UnitTests.XML - - - 11 - - - - - $(MSBuildExtensionsPath32)\..\Microsoft SDKs\F#\3.0\Framework\v4.0\Microsoft.FSharp.Targets - - - - - $(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\FSharp\Microsoft.FSharp.Targets - - - - + @@ -68,55 +29,20 @@ - - + - - ..\packages\FsCheck.2.2.4\lib\net45\FsCheck.dll - True - - - ..\packages\FsCheck.Xunit.2.2.4\lib\net45\FsCheck.Xunit.dll - True - - - ..\packages\FSharp.Core.4.0.0.1\lib\net40\FSharp.Core.dll - True - - - - - - - ..\packages\Unquote.3.1.0\lib\net45\Unquote.dll - True - - - ..\packages\xunit.abstractions.2.0.0\lib\net35\xunit.abstractions.dll - True - - - ..\packages\xunit.extensibility.core.2.1.0\lib\dotnet\xunit.core.dll - True - - - ..\packages\xunit.extensibility.execution.2.1.0\lib\net45\xunit.execution.desktop.dll - True - + + + + + all + runtime; build; native; contentfiles; analyzers; buildtransitive + + - - Numsense - {72a79661-f252-4571-a857-268ce356e88a} - True - + - + diff --git a/Numsense.UnitTests/packages.config b/Numsense.UnitTests/packages.config deleted file mode 100644 index 5b2694c..0000000 --- a/Numsense.UnitTests/packages.config +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - - - - - diff --git a/Numsense.nuspec b/Numsense.nuspec deleted file mode 100644 index 87d0f43..0000000 --- a/Numsense.nuspec +++ /dev/null @@ -1,22 +0,0 @@ - - - - Numsense - @build.number@ - Mark Seemann - Mark Seemann - https://raw.githubusercontent.com/ploeh/Numsense/master/LICENCE.txt - https://github.com/ploeh/Numsense - false - A .NET library for parsing natural-language numerals ("forty-two") to integers, and converting the other way as well. - Copyright Mark Seemann 2016 - Integers Numbers Translation Language - - - - - - - - - diff --git a/Numsense.sln b/Numsense.sln index c70bee8..202c2a3 100644 --- a/Numsense.sln +++ b/Numsense.sln @@ -1,14 +1,8 @@  Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio 14 -VisualStudioVersion = 14.0.24720.0 +# Visual Studio Version 16 +VisualStudioVersion = 16.0.30011.22 MinimumVisualStudioVersion = 10.0.40219.1 -Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "Numsense", "Numsense\Numsense.fsproj", "{72A79661-F252-4571-A857-268CE356E88A}" -EndProject -Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "Numsense.UnitTests", "Numsense.UnitTests\Numsense.UnitTests.fsproj", "{FC7BD508-0445-428A-AC8C-2DDCA3EFEADE}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Numsense.UnitTests.CSharp", "Numsense.UnitTests.CSharp\Numsense.UnitTests.CSharp.csproj", "{5FEBD8A6-3ED8-4E4F-B484-DE4CB77B6034}" -EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{98273287-AB32-4958-B4C2-47D77A7D42F0}" ProjectSection(SolutionItems) = preProject Build.fsx = Build.fsx @@ -19,26 +13,35 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution README.md = README.md EndProjectSection EndProject +Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "Numsense", "Numsense\Numsense.fsproj", "{F18D28CF-A69D-4EF0-9380-D6951472AB7C}" +EndProject +Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "Numsense.UnitTests", "Numsense.UnitTests\Numsense.UnitTests.fsproj", "{24391FC1-87B6-4DC4-8EC9-1D39218DB74A}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Numsense.UnitTests.CSharp", "Numsense.UnitTests.CSharp\Numsense.UnitTests.CSharp.csproj", "{26C1672A-4F61-42BF-BFFB-719DA8ADCA3F}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU Release|Any CPU = Release|Any CPU EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution - {72A79661-F252-4571-A857-268CE356E88A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {72A79661-F252-4571-A857-268CE356E88A}.Debug|Any CPU.Build.0 = Debug|Any CPU - {72A79661-F252-4571-A857-268CE356E88A}.Release|Any CPU.ActiveCfg = Release|Any CPU - {72A79661-F252-4571-A857-268CE356E88A}.Release|Any CPU.Build.0 = Release|Any CPU - {FC7BD508-0445-428A-AC8C-2DDCA3EFEADE}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {FC7BD508-0445-428A-AC8C-2DDCA3EFEADE}.Debug|Any CPU.Build.0 = Debug|Any CPU - {FC7BD508-0445-428A-AC8C-2DDCA3EFEADE}.Release|Any CPU.ActiveCfg = Release|Any CPU - {FC7BD508-0445-428A-AC8C-2DDCA3EFEADE}.Release|Any CPU.Build.0 = Release|Any CPU - {5FEBD8A6-3ED8-4E4F-B484-DE4CB77B6034}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {5FEBD8A6-3ED8-4E4F-B484-DE4CB77B6034}.Debug|Any CPU.Build.0 = Debug|Any CPU - {5FEBD8A6-3ED8-4E4F-B484-DE4CB77B6034}.Release|Any CPU.ActiveCfg = Release|Any CPU - {5FEBD8A6-3ED8-4E4F-B484-DE4CB77B6034}.Release|Any CPU.Build.0 = Release|Any CPU + {F18D28CF-A69D-4EF0-9380-D6951472AB7C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {F18D28CF-A69D-4EF0-9380-D6951472AB7C}.Debug|Any CPU.Build.0 = Debug|Any CPU + {F18D28CF-A69D-4EF0-9380-D6951472AB7C}.Release|Any CPU.ActiveCfg = Release|Any CPU + {F18D28CF-A69D-4EF0-9380-D6951472AB7C}.Release|Any CPU.Build.0 = Release|Any CPU + {24391FC1-87B6-4DC4-8EC9-1D39218DB74A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {24391FC1-87B6-4DC4-8EC9-1D39218DB74A}.Debug|Any CPU.Build.0 = Debug|Any CPU + {24391FC1-87B6-4DC4-8EC9-1D39218DB74A}.Release|Any CPU.ActiveCfg = Release|Any CPU + {24391FC1-87B6-4DC4-8EC9-1D39218DB74A}.Release|Any CPU.Build.0 = Release|Any CPU + {26C1672A-4F61-42BF-BFFB-719DA8ADCA3F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {26C1672A-4F61-42BF-BFFB-719DA8ADCA3F}.Debug|Any CPU.Build.0 = Debug|Any CPU + {26C1672A-4F61-42BF-BFFB-719DA8ADCA3F}.Release|Any CPU.ActiveCfg = Release|Any CPU + {26C1672A-4F61-42BF-BFFB-719DA8ADCA3F}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {8359F41A-8505-43A3-9566-E6F09E4BA719} + EndGlobalSection EndGlobal diff --git a/Numsense/Numsense.fsproj b/Numsense/Numsense.fsproj index ff76b02..b3ceff8 100644 --- a/Numsense/Numsense.fsproj +++ b/Numsense/Numsense.fsproj @@ -1,56 +1,20 @@ - - - + + - Debug - AnyCPU - 2.0 - 72a79661-f252-4571-a857-268ce356e88a - Library - Numsense - Ploeh.Numsense - v4.5 - 4.4.0.0 - true - Numsense - + netstandard2.0 + 1.0.0 + false + true + Copyright © Mark Seemann 2020 + Mark Seemann + Mark Seemann + https://github.com/ploeh/Numsense + true + https://github.com/ploeh/Numsense + Integers Numbers Translation Language + LICENCE.txt - - true - full - false - false - bin\Debug\ - DEBUG;TRACE - 3 - - - - - pdbonly - true - true - bin\Release\ - TRACE - 3 - bin\Release\Ploeh.Numsense.XML - - - 11 - - - - - $(MSBuildExtensionsPath32)\..\Microsoft SDKs\F#\3.0\Framework\v4.0\Microsoft.FSharp.Targets - - - - - $(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\FSharp\Microsoft.FSharp.Targets - - - - + @@ -69,22 +33,18 @@ - + - - - True - - - - + - + + + ..\LICENCE.txt + + + + + + diff --git a/Numsense/packages.config b/Numsense/packages.config deleted file mode 100644 index f06462d..0000000 --- a/Numsense/packages.config +++ /dev/null @@ -1,5 +0,0 @@ - - - - - \ No newline at end of file diff --git a/build.cmd b/build.cmd index 388ca52..9f0e9c3 100644 --- a/build.cmd +++ b/build.cmd @@ -1,4 +1,4 @@ @echo off cls -packages\FAKE.4.11.3\tools\FAKE.exe build.fsx %* +packages\FAKE.5.16.0\tools\FAKE.exe build.fsx %* diff --git a/packages/FAKE.4.11.3/docs/RELEASE_NOTES.html b/packages/FAKE.4.11.3/docs/RELEASE_NOTES.html deleted file mode 100644 index eaebc76..0000000 --- a/packages/FAKE.4.11.3/docs/RELEASE_NOTES.html +++ /dev/null @@ -1,910 +0,0 @@ - - - - - - RELEASE_NOTES - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

4.11.3 - 22.12.2015

- - - -

4.11.1 - 22.12.2015

- - - -

4.11.0 - 19.12.2015

- - - -

4.10.0 - 30.11.2015

- - - -

4.9.1 - 11.11.2015

- - - -

4.8.0 - 04.11.2015

- - - -

4.6.0 - 14.10.2015

- - - -

4.5.0 - 07.10.2015

- - - -

4.4.0 - 11.09.2015

- - - -

4.3.0 - 26.08.2015

- - - -

4.2.0 - 24.08.2015

- - - -

4.1.0 - 10.08.2015

- - - -

4.0.0 - 23.07.2015

- - - -

3.36.0 - 13.07.2015

- - - -

3.35.0 - 09.06.2015

- - - -

3.34.0 - 25.05.2015

- - - -

3.33.0 - 20.05.2015

- - - -

3.32.4 - 18.05.2015

- - - -

3.31.0 - 06.05.2015

- - - -

3.30.1 - 29.04.2015

- - - -

3.29.2 - 27.04.2015

- - - -

3.28.0 - 09.04.2015

- - - -

3.27.0 - 07.04.2015

- - - -

3.26.0 - 25.03.2015

- - - -

3.25.2 - 24.03.2015

- - - -

3.25.1 - 24.03.2015

- - - -

3.25.0 - 23.03.2015

- - - -

3.24.0 - 22.03.2015

- - - -

3.23.0 - 12.03.2015

- - - -

3.22.0 - 12.03.2015

- -
    -
  • Globbing allows to grab folders without a trailing slash
  • -
  • Removed long time obsolete globbing functions
  • -
- -

3.21.0 - 11.03.2015

- - - -

3.20.1 - 10.03.2015

- - - -

3.20.0 - 10.03.2015

- - - -

3.18.0 - 04.03.2015

- - - -

3.17.0 - 12.02.2015

- - - -

3.15.0 - 07.02.2015

- - - -

3.14.0 - 14.01.2015

- - - -

3.13.0 - 03.01.2015

- - - -

3.11.0 - 03.12.2014

- - - -

3.10.0 - 27.11.2014

- - - -

3.9.0 - 07.11.2014

- - - -

3.8.0 - 30.10.2014

- - - -

3.7.0 - 16.10.2014

- - - -

3.6.0 - 14.10.2014

- - - -

3.5.0 - 19.09.2014

- - - -

3.4.0 - 28.08.2014

- - - -

3.3.0 - 25.08.2014

- - - -

3.2.0 - 07.07.2014

- - - -

3.1.0 - 04.07.2014

- - - -

3.0.0 - 27.06.2014

- - - -

2.18.0 - 11.06.2014

- - - -

2.17.0 - 23.05.2014

- -
    -
  • Fake.Deploy agent requires user authentication
  • -
  • Remove AutoOpen von AppVeyor
  • -
  • fix order of arguments in call to CopyFile
  • -
  • Support MSTest test settings - https://github.com/fsharp/FAKE/pull/428
  • -
  • If the NAV error file contains no compile errors return the length
  • -
- -

2.16.0 - 21.05.2014

- - - -

2.15.0 - 24.04.2014

- - - -

2.14.0 - 22.04.2014

- - - -

2.13.0 - 04.04.2014

- -
    -
  • Enumerate the files lazily in the File|Directory active pattern
  • -
  • Using Nuget 2.8.1
  • -
  • Added TypeScript 1.0 support
  • -
  • Added TypeScript support
  • -
  • Fixed ProcessTestRunner
  • -
  • Fixed mono build on Travis
  • -
- -

2.12.0 - 31.03.2014

- -
    -
  • Add getDependencies to NugetHelper
  • -
  • SourceLink support
  • -
  • NancyFx instead of ASP.NET MVC for Fake.Deploy
  • -
  • Allows to execute processes as unit tests.
  • -
  • Adding SourceLinks
  • -
  • Move release management back to the local machine (using this document)
  • -
  • Allow to run MsTest test in isolation
  • -
  • Fixed Nuget.packSymbols
  • -
  • Fixed bug in SemVer parser
  • -
  • New title property in Nuspec parameters
  • -
  • Added option to disabled FAKE's automatic process killing
  • -
  • Better AppyVeyor integration
  • -
  • Added ability to define custom MSBuild loggers
  • -
  • Fix for getting the branch name with Git >= 1.9
  • -
  • Added functions to write and delete from registry
  • -
  • NUnit NoThread, Domain and StopOnError parameters
  • -
  • Add support for VS2013 MSTest
  • -
  • Lots of small fixes
  • -
- -

2.2

- -
    -
  • Created new packages on nuget: -
      -
    • Fake.Deploy - allows to use FAKE scripts in deployment.
    • -
    • Fake.Experimental - new stuff where we aren't sure if we want to support it.
    • -
    • Fake.Gallio - contains the Gallio runner support.
    • -
    • Fake.SQL - Contains tasks for SQL Server.
    • -
    • Fake.Core - All the basic features and FAKE.exe.
    • -
  • -
  • Created documentation and tutorials - see http://fsharp.github.io/FAKE/
  • -
  • New tasks: -
      -
    • Added ReleaseNotes parser
    • -
    • Added Dynamics NAV helper
    • -
    • Added support for MSTest and fixie
    • -
    • Parallel NUnit task
    • -
    • New AssemblyInfoFile task
    • -
    • Support for Octopus Deploy
    • -
    • Support for MAGE
    • -
    • Suppport for Xamarin's xpkg
    • -
    • Many other new tasks
    • -
  • -
  • Fake.Boot
  • -
  • New Globbing system
  • -
  • Tons of bug fixes
  • -
  • Bundles F# 3.0 compiler and FSI.
  • -
- -

1.72.0.0

- -
    -
  • "RestorePackages" allows to restore nuget packages
  • -
- -

1.70.0.0

- -
    -
  • FAKE nuget package comes bundles with a fsi.exe
  • -
  • Self build downloads latest FAKE master via nuget
  • -
- -

1.66.1.0

- -
    -
  • Fixed bug where FAKE.Deploy didn't run the deploy scripts where used as a windows service
  • -
  • It's possible to add file loggers for MSBuild
  • -
  • Fixed path resolution for fsi on *nix
  • -
  • BREAKING CHANGE: Removed version normalization from NuGet package creation
  • -
  • Fixes for NUNit compatibility on mono
  • -
  • Fixes in ProcessHelper for mono compatibility
  • -
  • Fixes in the mono build
  • -
  • Improved error reporting in Fake.exe
  • -
  • Added a SpecFlow helper
  • -
  • Fixed some issues in file helper routines when working with no existing directory chain
  • -
- -

1.64.1.0

- -
    -
  • Fixed bug where FAKE didn't run the correct build script
  • -
- -

1.64.0.0

- -
    -
  • New conditional dependency operator =?>
  • -
  • BREAKING CHANGE: Some AssemblyInfo task parameters are now option types. See type hints.
  • -
- -

1.62.0.0

- -
    -
  • New RegAsm task, allows to create TLBs from a dll.
  • -
  • New MSI task, allows to install or uninstall msi files.
  • -
  • StringHelper.NormalizeVersion fixed for WiX.
  • -
- -

1.58.9.0

- -
    -
  • Allow to choose specific nunit-console runner.
  • -
- -

1.58.6.0

- -
    -
  • Using nuget packages for mspec.
  • -
  • FAKE tries to kill all MSBuild and FSI processes at the end of a build.
  • -
- -

1.58.1.0

- -
    -
  • Removed message system for build output. Back to simpler tracing.
  • -
- -

1.58.0.0

- -
    -
  • ReplaceAssemblyInfoVersions task allows to replace version info in AssemblyVersion-files
  • -
  • New task ConvertFileToWindowsLineBreaks
  • -
- -

1.56.10.0

- -
    -
  • Allows to build .sln files
  • -
- -

1.56.0.0

- -
    -
  • Allows to publish symbols via nuget.exe
  • -
  • Autotrim trailing .0 from version in order to fullfill nuget standards.
  • -
- -

1.54.0.0

- -
    -
  • If the publishment of a Nuget package fails, then FAKE will try it again.
  • -
  • Added Changelog.markdown to FAKE deployment
  • -
  • Added RequireExactly helper function in order to require a specific nuget dependency.
  • -
  • NugetHelper.GetPackageVersion - Gets the version no. for a given package in the packages folder.
  • -
  • EnvironmentHelper.getTargetPlatformDir - Gets the directory for the given target platform.
  • -
- -

1.52.0.0

- -
    -
  • Some smaller bugfixes
  • -
  • New dependency syntax with ==> and <=>
  • -
  • Tracing of StackTrace only if TargetHelper.PrintStackTraceOnError was set to true
  • -
- -

1.50.0.0

- -
    -
  • New task DeleteDirs allows to delete multiple directories.
  • -
  • New parameter for NuGet dependencies.
  • -
- -

1.48.0.0

- -
    -
  • Bundled with docu.exe compiled against .Net 4.0.
  • -
  • Fixed docu calls to run with full filenames.
  • -
  • Added targetplatform, target and log switches for ILMerge task.
  • -
  • Added Git.Information.getLastTag() which gets the last git tag by calling git describe.
  • -
  • Added Git.Information.getCurrentHash() which gets the last current sha1.
  • -
- -

1.46.0.0

- -
    -
  • Fixed Nuget support and allows automatic push.
  • -
- -

1.44.0.0

- -
    -
  • Tracing of all external process starts.
  • -
  • MSpec support.
  • -
- - -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/androidpublisher.html b/packages/FAKE.4.11.3/docs/androidpublisher.html deleted file mode 100644 index 1196de9..0000000 --- a/packages/FAKE.4.11.3/docs/androidpublisher.html +++ /dev/null @@ -1,408 +0,0 @@ - - - - - - Publish Android apk - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

Publish Android apk

- -

This module helps android developers to automatically publish their APKs

- -

Prerequisite

- -

Before using this module, you will need an android keystore for apk signing.

- -

Next, you will need a Google service account described here: -https://developers.google.com/accounts/docs/OAuth2ServiceAccount#creatinganaccount

- -

and here: -https://developers.google.com/android-publisher/getting_started

- -

Usage example:

- - - - -
  1: 
-  2: 
-  3: 
-  4: 
-  5: 
-  6: 
-  7: 
-  8: 
-  9: 
- 10: 
- 11: 
- 12: 
- 13: 
- 14: 
- 15: 
- 16: 
- 17: 
- 18: 
- 19: 
- 20: 
- 21: 
- 22: 
- 23: 
- 24: 
- 25: 
- 26: 
- 27: 
- 28: 
- 29: 
- 30: 
- 31: 
- 32: 
- 33: 
- 34: 
- 35: 
- 36: 
- 37: 
- 38: 
- 39: 
- 40: 
- 41: 
- 42: 
- 43: 
- 44: 
- 45: 
- 46: 
- 47: 
- 48: 
- 49: 
- 50: 
- 51: 
- 52: 
- 53: 
- 54: 
- 55: 
- 56: 
- 57: 
- 58: 
- 59: 
- 60: 
- 61: 
- 62: 
- 63: 
- 64: 
- 65: 
- 66: 
- 67: 
- 68: 
- 69: 
- 70: 
- 71: 
- 72: 
- 73: 
- 74: 
- 75: 
- 76: 
- 77: 
- 78: 
- 79: 
- 80: 
- 81: 
- 82: 
- 83: 
- 84: 
- 85: 
- 86: 
- 87: 
- 88: 
- 89: 
- 90: 
- 91: 
- 92: 
- 93: 
- 94: 
- 95: 
- 96: 
- 97: 
- 98: 
- 99: 
-100: 
-101: 
-102: 
-103: 
-104: 
-105: 
-106: 
-107: 
-108: 
-109: 
-110: 
-111: 
-112: 
-113: 
-114: 
-115: 
-116: 
-117: 
-118: 
-119: 
-120: 
-121: 
-122: 
-123: 
-124: 
-125: 
-126: 
-127: 
-128: 
-129: 
-130: 
-131: 
-132: 
-133: 
-134: 
-135: 
-136: 
-137: 
-138: 
-
#r "packages/FAKE/tools/FakeLib.dll"
-
-let androidBuildDir = "./build/"
-let androidProdDir = "./pack/"
-
-androidProdDir |> ensureDirectory
-
-//Clean old apk
-Target "Clean" (fun _ ->
-    CleanDir androidBuildDir
-    CleanDir androidProdDir
-)
-
-Target "Android-Package" (fun () ->
-    AndroidPackage(fun defaults ->
-                    { defaults with 
-                        ProjectPath = "Path to my project Droid.csproj"
-                        Configuration = "Release"
-                        OutputPath = androidBuildDir
-                        Properties = ["MSBuild property", "MSBuild property value"]
-                    })
-
-    |> AndroidSignAndAlign (fun defaults ->
-        { defaults with 
-            KeystorePath = @"path to my file.keystore"
-            KeystorePassword = "my password"
-            KeystoreAlias = "my key alias"
-        })
-    |> fun file -> file.CopyTo(Path.Combine(androidProdDir, file.Name)) |> ignore
-)
-
-// You can also build one APK per ABI
-Target "Android-MultiPackages" (fun () ->
-    let versionStepper = (fun v t -> match t with
-                                     | AndroidAbiTarget.X86 c -> v + 1
-                                     | AndroidAbiTarget.X86And64 c -> v + 2
-                                     | AndroidAbiTarget.ArmEabi c -> v + 3
-                                     | AndroidAbiTarget.ArmEabiV7a c -> v + 4
-                                     | AndroidAbiTarget.Arm64V8a c -> v + 5
-                                     | _ -> v)
-    let abis = AndroidPackageAbiParam.SpecificAbis
-                    ([ AndroidAbiTarget.X86({ SuffixAndExtension="-x86.apk"; })
-                       AndroidAbiTarget.ArmEabi({ SuffixAndExtension="-armeabi.apk"; })
-                       AndroidAbiTarget.ArmEabiV7a({ SuffixAndExtension="-armeabi-v7a.apk"; })
-                       AndroidAbiTarget.X86And64({ SuffixAndExtension="-x86_64.apk"; })
-                     ])
-    let files = AndroidBuildPackages(fun defaults ->
-                            { defaults with 
-                                ProjectPath = "Path to my project Droid.csproj"
-                                Configuration = "Release"
-                                OutputPath = androidBuildDir
-                                PackageAbiTargets = abis
-                                VersionStepper = Some(versionStepper)
-                            })
-
-    for f in files do
-        printfn "- apk: %s" f.Name
-
-    files 
-    |> Seq.iter (fun file -> file.CopyTo(Path.Combine(androidProdDir, file.Name)) |> ignore)
-)
-
-
-Target "Publish" (fun _ -> 
-    // I like verbose script
-    trace "publishing Android App"
-    let apk = androidProdDir 
-                    |> directoryInfo 
-                    |> filesInDir 
-                    |> Seq.filter(fun f -> f.Name.EndsWith(".apk"))
-                    |> Seq.exactlyOne
-    let apkPath = apk.FullName
-    tracefn "Apk found: %s" apkPath
-    let mail = "my service account mail@developer.gserviceaccount.com"
-    // Path to the certificate file probably named 'Google Play Android Developer-xxxxxxxxxxxx.p12'
-    let certificate = new X509Certificate2
-                                (
-                                    @"Google Play Android Developer-xxxxxxxxxxxx.p12",
-                                    "notasecret",
-                                    X509KeyStorageFlags.Exportable
-                                )
-    let packageName = "my Android package name"
-
-    // to publish an alpha version: 
-    PublishApk 
-        { AlphaSettings with 
-            Config = 
-                { 
-                    Certificate = certificate;
-                    PackageName = packageName;
-                    AccountId = mail;
-                    Apk = apkPath; 
-                }
-        }
-
-    // to publish a beta version: 
-    //
-    //PublishApk 
-    //    { BetaSettings with 
-    //        Config = 
-    //            { 
-    //                Certificate = certificate;
-    //                PackageName = packageName;
-    //                AccountId = mail;
-    //                Apk = apkPath; 
-    //            }
-    //    }
-
-    // to publish a production version: 
-    //
-    //PublishApk 
-    //    { ProductionSettings with 
-    //        Config = 
-    //            { 
-    //                Certificate = certificate;
-    //                PackageName = packageName;
-    //                AccountId = mail;
-    //                Apk = apkPath; 
-    //            }
-    //    }
-)
-
-Target "Android-Build" (fun _ ->
-    !! "**/my project Droid.csproj"
-        |> MSBuildRelease androidBuildDir "Build"
-        |> Log "BuildAndroidLib-Output: "
-)
-
-Target "Default" (fun _ ->
-    trace "Building default target"
-    RestorePackages()
-)
-
-"Clean"
-    ==> "Android-Package"
-    ==> "Default"
-
-RunTargetOrDefault "Default"
-
- -

Default target will not start "Publish" target because apps do not need to be updated too frequently (as explained here: https://developers.google.com/android-publisher/api_usage)

- -

To publish your app, you can run

- - - - -
1: 
-
PS> Fake.exe .
-
- -
val androidBuildDir : string

Full name: androidpublisher.androidBuildDir
-
val androidProdDir : string

Full name: androidpublisher.androidProdDir
-
val ignore : value:'T -> unit

Full name: Microsoft.FSharp.Core.Operators.ignore
-
union case Option.Some: Value: 'T -> Option<'T>
-
val printfn : format:Printf.TextWriterFormat<'T> -> 'T

Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.printfn
-
module Seq

from Microsoft.FSharp.Collections
-
val iter : action:('T -> unit) -> source:seq<'T> -> unit

Full name: Microsoft.FSharp.Collections.Seq.iter
-
val filter : predicate:('T -> bool) -> source:seq<'T> -> seq<'T>

Full name: Microsoft.FSharp.Collections.Seq.filter
-
val exactlyOne : source:seq<'T> -> 'T

Full name: Microsoft.FSharp.Collections.Seq.exactlyOne
- -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-additionalsyntax.html b/packages/FAKE.4.11.3/docs/apidocs/fake-additionalsyntax.html deleted file mode 100644 index 2c05d0c..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-additionalsyntax.html +++ /dev/null @@ -1,491 +0,0 @@ - - - - - AdditionalSyntax - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

AdditionalSyntax

-
-

Provides functions and operators to deal with FAKE targets and target dependencies.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - ( ? ) f s - -
- Signature: f:('?11309 -> '?11310) -> s:'?11309 -> '?11310
- Type parameters: '?11309, '?11310
-
- - - - -

Allows to use Tokens instead of strings

- - - -
- - - ( ?<- ) f str action - -
- Signature: f:('?11312 -> '?11313 -> '?11314) -> str:'?11312 -> action:'?11313 -> '?11314
- Type parameters: '?11312, '?11313, '?11314
-
- - - - -

Allows to use Tokens instead of strings for TargetNames

- - - -
- - - ( ?=> ) x y - -
- Signature: x:string -> y:string -> string
-
-
- - - - -

Defines a soft dependency. x must run before y, if it is present, but y does not require x to be run.

- - - -
- - - ( <=? ) y x - -
- Signature: y:string -> x:string -> string
-
-
- - - - -

Defines a soft dependency. x must run before y, if it is present, but y does not require x to be run.

- - - -
- - - ( <=> ) x y - -
- Signature: x:string -> y:string -> string
-
-
- - - - -

Defines that x and y are not dependent on each other but y is dependent on all dependencies of x.

- - - -
- - - ( =?> ) x (y, condition) - -
- Signature: x:string -> (y:string * condition:bool) -> string
-
-
- - - - -

Defines a conditional dependency - y is dependent on x if the condition is true

- - - -
- - - ( ==> ) x y - -
- Signature: x:string -> y:string -> string
-
-
- - - - -

Defines a dependency - y is dependent on x

- - - -
- - - addDependenciesOnSameLevel (...) - -
- Signature: target:string -> dependency:string -> unit
-
-
- - - - -

Specifies that two targets have the same dependencies

- - - -
- - - addSoftDependenciesOnSameLevel (...) - -
- Signature: target:string -> dependency:string -> unit
-
-
- - - - -

Specifies that two targets have the same dependencies

- - - -
- - - And x y - -
- Signature: x:'?11319 -> y:'?11319 list -> '?11319 list
- Type parameters: '?11319
-
- - - - -

Appends the dependency to the list of dependencies

- - - -
- - - Dependency x - -
- Signature: x:'?11317 -> '?11317 list
- Type parameters: '?11317
-
- - - - -

Converts a dependency into a list

- - - -
- - - For x y - -
- Signature: x:string -> y:string list -> unit
-
-
- - - - -

Allows to use For? syntax for Dependencies

- - - -
- - - Run targetName - -
- Signature: targetName:string -> unit
-
-
- - - - -

Runs a Target and its dependencies

- - - -
- - - RunParameterTargetOrDefault (...) - -
- Signature: parameterName:string -> defaultTarget:string -> unit
-
-
- - - - -

Runs the target given by the build script parameter or the given default target

- - - -
- - - RunTarget () - -
- Signature: unit -> unit
-
-
- - - - -

Runs the target given by the target parameter

- - - -
- - - RunTargetOrDefault defaultTarget - -
- Signature: defaultTarget:string -> unit
-
-
- - - - -

Runs the target given by the target parameter or the given default target

- - - -
- - - RunTargetOrListTargets () - -
- Signature: unit -> unit
-
-
- - - - -

Runs the target given by the target parameter or lists the available targets

- - - -
- - - targetsAreOnSameLevel x y - -
- Signature: x:string -> y:string -> unit
-
-
- - - - -

Specifies that two targets are on the same level of execution

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-androidpublisher-androidpublishconfig.html b/packages/FAKE.4.11.3/docs/apidocs/fake-androidpublisher-androidpublishconfig.html deleted file mode 100644 index d796105..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-androidpublisher-androidpublishconfig.html +++ /dev/null @@ -1,179 +0,0 @@ - - - - - AndroidPublishConfig - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

AndroidPublishConfig

-
-
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - AccountId - -
- Signature: string
-
-
- - - - - -
- - - Apk - -
- Signature: string
-
-
- - - - - -
- - - Certificate - -
- Signature: X509Certificate2
-
-
- - - - - -
- - - PackageName - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-androidpublisher-androidpublishparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-androidpublisher-androidpublishparams.html deleted file mode 100644 index da8f7af..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-androidpublisher-androidpublishparams.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - AndroidPublishParams - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-androidpublisher-apkversion.html b/packages/FAKE.4.11.3/docs/apidocs/fake-androidpublisher-apkversion.html deleted file mode 100644 index c5c20d5..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-androidpublisher-apkversion.html +++ /dev/null @@ -1,125 +0,0 @@ - - - - - ApkVersion - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-androidpublisher-appeditlistapksresult.html b/packages/FAKE.4.11.3/docs/apidocs/fake-androidpublisher-appeditlistapksresult.html deleted file mode 100644 index 8986b60..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-androidpublisher-appeditlistapksresult.html +++ /dev/null @@ -1,125 +0,0 @@ - - - - - AppEditListApksResult - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-androidpublisher-editresourcemodel.html b/packages/FAKE.4.11.3/docs/apidocs/fake-androidpublisher-editresourcemodel.html deleted file mode 100644 index 6b9cdf2..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-androidpublisher-editresourcemodel.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - EditResourceModel - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-androidpublisher-trackmodel.html b/packages/FAKE.4.11.3/docs/apidocs/fake-androidpublisher-trackmodel.html deleted file mode 100644 index bb39012..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-androidpublisher-trackmodel.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - TrackModel - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-androidpublisher.html b/packages/FAKE.4.11.3/docs/apidocs/fake-androidpublisher.html deleted file mode 100644 index 21496f9..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-androidpublisher.html +++ /dev/null @@ -1,319 +0,0 @@ - - - - - AndroidPublisher - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

AndroidPublisher

-
-
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- AndroidPublishConfig -
- AndroidPublishParams -
- ApkVersion -
- AppEditListApksResult -
- EditResourceModel -
- TrackModel -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - AlphaSettings - -
- Signature: AndroidPublishParams
-
-
- - - - - -
- - - AndroidPublisherBaseUrl - -
- Signature: string
-
-
- - - - - -
- - - AndroidPublisherScope - -
- Signature: string
-
-
- - - - - -
- - - AndroidUploadApkBaseUrl - -
- Signature: string
-
-
- - - - - -
- - - BetaSettings - -
- Signature: AndroidPublishParams
-
-
- - - - - -
- - - ProductionSettings - -
- Signature: AndroidPublishParams
-
-
- - - - - -
- - - PublishApk param - -
- Signature: param:AndroidPublishParams -> unit
-
-
- - - - - -
- - - RolloutSettings - -
- Signature: AndroidPublishParams
-
-
- - - - - -
- - - TokenServerUrl - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-appveyor-appveyorenvironment.html b/packages/FAKE.4.11.3/docs/apidocs/fake-appveyor-appveyorenvironment.html deleted file mode 100644 index 062032e..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-appveyor-appveyorenvironment.html +++ /dev/null @@ -1,740 +0,0 @@ - - - - - AppVeyorEnvironment - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

AppVeyorEnvironment

-
-

AppVeyor environment variables as described

- - -
-

Static members

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Static memberDescription
- - - AccountName - -
- Signature: string
-
-
- - - - -

AppVeyor Account Name

- - - -
- - - ApiUrl - -
- Signature: string
-
-
- - - - -

AppVeyor Build Agent API URL

- - - -
- - - BuildFolder - -
- Signature: string
-
-
- - - - -

Path to clone directory

- - - -
- - - BuildId - -
- Signature: string
-
-
- - - - -

AppVeyor unique build ID

- - - -
- - - BuildNumber - -
- Signature: string
-
-
- - - - -

Build number

- - - -
- - - BuildVersion - -
- Signature: string
-
-
- - - - -

Build version

- - - -
- - - Configuration - -
- Signature: string
-
-
- - - - -

Configuration name set on Build tab of project settings (or through configuration parameter in appveyor.yml).

- - - -
- - - IsForcedBuild - -
- Signature: string
-
-
- - - - -

If the build has been started by the "New Build" button or from the same API

- - - -
- - - IsReBuild - -
- Signature: string
-
-
- - - - -

If the build has been started by the "Re-Build commit/PR" button or from the same API

- - - -
- - - IsScheduledBuild - -
- Signature: string
-
-
- - - - -

If the build runs by scheduler;

- - - -
- - - JobId - -
- Signature: string
-
-
- - - - -

AppVeyor unique job ID

- - - -
- - - JobName - -
- Signature: string
-
-
- - - - -

The job name

- - - -
- - - Platform - -
- Signature: string
-
-
- - - - -

Platform name set on Build tab of project settings (or through platform parameter in appveyor.yml).

- - - -
- - - ProjectId - -
- Signature: string
-
-
- - - - -

AppVeyor unique project ID

- - - -
- - - ProjectName - -
- Signature: string
-
-
- - - - -

Project name

- - - -
- - - ProjectSlug - -
- Signature: string
-
-
- - - - -

Project slug (as seen in project details URL)

- - - -
- - - PullRequestNumber - -
- Signature: string
-
-
- - - - -

GitHub Pull Request number

- - - -
- - - PullRequestTitle - -
- Signature: string
-
-
- - - - -

GitHub Pull Request title

- - - -
- - - RepoBranch - -
- Signature: string
-
-
- - - - -

Build branch

- - - -
- - - RepoCommit - -
- Signature: string
-
-
- - - - -

Commit ID (SHA)

- - - -
- - - RepoCommitAuthor - -
- Signature: string
-
-
- - - - -

Commit author's name

- - - -
- - - RepoCommitAuthorEmail - -
- Signature: string
-
-
- - - - -

Commit author's email address

- - - -
- - - RepoCommitMessage - -
- Signature: string
-
-
- - - - -

Commit message

- - - -
- - - RepoCommitMessageExtended - -
- Signature: string
-
-
- - - - -

The rest of the commit message after line break (if exists)

- - - -
- - - RepoCommitTimestamp - -
- Signature: string
-
-
- - - - -

Commit date/time

- - - -
- - - RepoName - -
- Signature: string
-
-
- - - - -

Repository name in format owner-name/repo-name

- - - -
- - - RepoProvider - -
- Signature: string
-
-
- - - - -

GitHub, BitBucket or Kiln

- - - -
- - - RepoScm - -
- Signature: string
-
-
- - - - -

git or mercurial

- - - -
- - - RepoTag - -
- Signature: bool
-
-
- - - - -

true if build has started by pushed tag; otherwise false

- - - -
- - - RepoTagName - -
- Signature: string
-
-
- - - - -

contains tag name for builds started by tag

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-appveyor-testresultstype.html b/packages/FAKE.4.11.3/docs/apidocs/fake-appveyor-testresultstype.html deleted file mode 100644 index b0d0307..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-appveyor-testresultstype.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - TestResultsType - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

TestResultsType

-
-

Union type representing the available test result formats accepted by AppVeyor.

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - MsTest - -
- Signature:
-
-
- - - - - -
- - - NUnit - -
- Signature:
-
-
- - - - - -
- - - Xunit - -
- Signature:
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-appveyor.html b/packages/FAKE.4.11.3/docs/apidocs/fake-appveyor.html deleted file mode 100644 index ddc5d10..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-appveyor.html +++ /dev/null @@ -1,310 +0,0 @@ - - - - - AppVeyor - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

AppVeyor

-
-

Contains code to configure FAKE for AppVeyor integration

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - -
TypeDescription
- AppVeyorEnvironment -

AppVeyor environment variables as described

- - -
- TestResultsType -

Union type representing the available test result formats accepted by AppVeyor.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - FinishTestCase (...) - -
- Signature: testSuiteName:string -> testCaseName:string -> duration:TimeSpan -> unit
-
-
- - - - -

Finishes the test case.

- - - -
- - - FinishTestSuite testSuiteName - -
- Signature: testSuiteName:'?11129 -> unit
- Type parameters: '?11129
-
- - - - -

Finishes the test suite.

- - - -
- - - IgnoreTestCase (...) - -
- Signature: testSuiteName:string -> testCaseName:string -> message:'?11135 -> unit
- Type parameters: '?11135
-
- - - - -

Ignores the test case.

- - - -
- - - StartTestCase testSuiteName testCaseName - -
- Signature: testSuiteName:string -> testCaseName:string -> unit
-
-
- - - - -

Starts the test case.

- - - -
- - - StartTestSuite testSuiteName - -
- Signature: testSuiteName:'?11131 -> unit
- Type parameters: '?11131
-
- - - - -

Starts the test suite.

- - - -
- - - TestFailed (...) - -
- Signature: testSuiteName:string -> testCaseName:string -> message:string -> details:string -> unit
-
-
- - - - -

Reports a failed test.

- - - -
- - - TestSucceeded testSuiteName testCaseName - -
- Signature: testSuiteName:string -> testCaseName:string -> unit
-
-
- - - - -

Reports a succeeded test.

- - - -
- - - UploadTestResultsXml (...) - -
- Signature: testResultsType:TestResultsType -> outputDir:string -> unit
-
-
- - - - -

Uploads all the test results ".xml" files in a directory to make them visible in Test tab of the build console.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-archivefilespec.html b/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-archivefilespec.html deleted file mode 100644 index ba7f8ed..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-archivefilespec.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - ArchiveFileSpec - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ArchiveFileSpec

-
-

A description of a file to be added to an archive.

- - -
-

Record Fields

- - - - - - - - - - - - - - -
Record FieldDescription
- - - ArchiveEntryPath - -
- Signature: string
-
-
- - - - - -
- - - InputFile - -
- Signature: FileInfo
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-bzip2.html b/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-bzip2.html deleted file mode 100644 index 0f896ae..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-bzip2.html +++ /dev/null @@ -1,238 +0,0 @@ - - - - - BZip2 - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

BZip2

-
-

Operations and tasks for working with gzip compressed files.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - CompressFile outFile file - -
- Signature: outFile:FileInfo -> file:FileInfo -> unit
-
-
- - - - -

Compresses a file using bzip2.

- -

Parameters

- -
    -
  • outFile - The compressed output file. If existing, will be overwritten.
  • -
  • file - The file to be compressed.
  • -
- - - -
- - - compressStream inner - -
- Signature: inner:Stream -> BZip2OutputStream
-
-
- - - - -

Wraps an output stream with a bzip2 compressor.

- - - -
- - - createFile file - -
- Signature: file:FileInfo -> BZip2OutputStream
-
-
- - - - -

Creates a BZip2OutputStream wrapping a file.

- -

Parameters

- -
    -
  • file - The FileInfo describing the location to which the compressed file should be written. Will be overwritten if it exists.
  • -
- - - -
- - - ExtractFile outFile file - -
- Signature: outFile:FileInfo -> file:FileInfo -> unit
-
-
- - - - -

Extracts a file compressed with bzip2.

- -

Parameters

- -
    -
  • outFile - The extracted output file. If existing, will be overwritten.
  • -
  • file - The compressed file.
  • -
- - - -
- - - extractStream inner - -
- Signature: inner:Stream -> BZip2InputStream
-
-
- - - - -

Wraps an input stream with a bzip2 decompressor.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-compressionlevel-t.html b/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-compressionlevel-t.html deleted file mode 100644 index aeea225..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-compressionlevel-t.html +++ /dev/null @@ -1,128 +0,0 @@ - - - - - T - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-compressionlevel.html b/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-compressionlevel.html deleted file mode 100644 index 549a95a..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-compressionlevel.html +++ /dev/null @@ -1,196 +0,0 @@ - - - - - CompressionLevel - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

CompressionLevel

-
-

Provides validation of comression levels used for the zip and gzip compression algorithms.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- T -

Defines the compression level type.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - create level - -
- Signature: level:int -> T
-
-
- - - - -

Constructs a CompressionLevel. Level is clipped to a value between 0 and 9.

- - - -
- - - Default - -
- Signature: T
-
-
- - - - -

The default compression level.

- - - -
- - - value arg1 - -
- Signature: T -> int
-
-
- - - - -

Retrieves the numeric compression level.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-gzip-gzipcompressionparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-gzip-gzipcompressionparams.html deleted file mode 100644 index 42ada24..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-gzip-gzipcompressionparams.html +++ /dev/null @@ -1,128 +0,0 @@ - - - - - GZipCompressionParams - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-gzip.html b/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-gzip.html deleted file mode 100644 index 24259bf..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-gzip.html +++ /dev/null @@ -1,315 +0,0 @@ - - - - - GZip - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

GZip

-
-

Operations and tasks for working with gzip compressed files.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- GZipCompressionParams -

The gzip archive compression parameters.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - CompressFile setParams outFile file - -
- Signature: setParams:(GZipCompressionParams -> GZipCompressionParams) -> outFile:FileInfo -> file:FileInfo -> unit
-
-
- - - - -

Compresses a file using gzip.

- -

Parameters

- -
    -
  • setParams - A function which modifies the default compression parameters.
  • -
  • outFile - The compressed output file. If existing, will be overwritten.
  • -
  • file - The file to be compressed.
  • -
- - - -
- - - CompressFileWithDefaults outFile file - -
- Signature: outFile:FileInfo -> file:FileInfo -> unit
-
-
- - - - -

Compresses a file using gzip.

- -

Parameters

- -
    -
  • outFile - The compressed output file. If existing, will be overwritten.
  • -
  • file - The file to be compressed.
  • -
- - - -
- - - compressStream arg1 inner - -
- Signature: GZipCompressionParams -> inner:Stream -> GZipOutputStream
-
-
- - - - -

Wraps an output stream with a gzip compressor.

- - - -
- - - createFile gzipParams file - -
- Signature: gzipParams:GZipCompressionParams -> file:FileInfo -> GZipOutputStream
-
-
- - - - -

Creates a GZipOutputStream wrapping a file using the given parameters.

- -

Parameters

- -
    -
  • gzipParams - The gzip compression parameters.
  • -
  • file - The FileInfo describing the location to which the compressed file should be written. Will be overwritten if it exists.
  • -
- - - -
- - - ExtractFile outFile file - -
- Signature: outFile:FileInfo -> file:FileInfo -> unit
-
-
- - - - -

Extracts a file compressed with gzip.

- -

Parameters

- -
    -
  • outFile - The extracted output file. If existing, will be overwritten.
  • -
  • file - The compressed file.
  • -
- - - -
- - - extractStream inner - -
- Signature: inner:Stream -> GZipInputStream
-
-
- - - - -

Wraps an input stream with a zip decompressor.

- - - -
- - - GZipCompressionDefaults - -
- Signature: GZipCompressionParams
-
-
- - - - -

The default gzip archive compression parameters

- -

Defaults

- -
    -
  • Level - CompressionLevel.Default
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-tar-bzip2.html b/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-tar-bzip2.html deleted file mode 100644 index 7659457..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-tar-bzip2.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - BZip2 - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

BZip2

-
-

Operations and tasks for working with tar archives compressed with BZip2.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - compress - -
- Signature: FileInfo -> seq<ArchiveFileSpec> -> unit
-
-
- - - - -

Constructs a function that will create a tar.bz2 archive from a set of files.

- - - -
- - - Compress (...) - -
- Signature: flatten:bool -> baseDir:DirectoryInfo -> archiveFile:FileInfo -> files:seq<FileInfo> -> unit
-
-
- - - - -

Creates a tar.bz2 archive with the given files.

- -

Parameters

- -
    -
  • flatten - If set to true then all subfolders are merged into the root folder of the archive.
  • -
  • baseDir - The relative directory of the files to be compressed. Use this parameter to influence directory structure within the archive.
  • -
  • archiveFile - The output archive file. If existing, will be overwritten.
  • -
  • files - A sequence of files to compress.
  • -
- - - -
- - - CompressDir flatten baseDir archiveFile - -
- Signature: flatten:bool -> baseDir:DirectoryInfo -> archiveFile:FileInfo -> unit
-
-
- - - - -

Creates a tar.bz2 archive containing all the files in a directory.

- -

Parameters

- -
    -
  • flatten - If set to true then all subfolders are merged into the root folder of the archive.
  • -
  • baseDir - The base directory to be compressed. This directory will be the root of the resulting archive.
  • -
  • archiveFile - The output archive file. If existing, will be overwritten.
  • -
- - - -
- - - CompressDirWithDefaults (...) - -
- Signature: baseDir:DirectoryInfo -> archiveFile:FileInfo -> unit
-
-
- - - - -

Creates a tar.bz2 archive containing all the files in a directory.

- -

Parameters

- -
    -
  • baseDir - The base directory to be compressed. This directory will be the root of the resulting archive.
  • -
  • archiveFile - The output archive file. If existing, will be overwritten.
  • -
- - - -
- - - CompressSpecs archiveFile fileSpecs - -
- Signature: archiveFile:FileInfo -> fileSpecs:seq<ArchiveFileSpec> -> unit
-
-
- - - - -

Creates a tar.bz2 archive with the given archive file specifications.

- -

Parameters

- -
    -
  • archiveFile - The output archive file. If existing, will be overwritten.
  • -
  • fileSpecs - A sequence of archive file specifications.
  • -
- - - -
- - - compressStream - -
- Signature: Stream -> TarOutputStream
-
-
- - - - -

Wraps an output stream with a tar.bz2 compressor.

- - - -
- - - CompressWithDefaults (...) - -
- Signature: baseDir:DirectoryInfo -> archiveFile:FileInfo -> files:seq<FileInfo> -> unit
-
-
- - - - -

Creates a tar.bz2 archive with the given files with default parameters.

- -

Parameters

- -
    -
  • baseDir - The relative directory of the files to be compressed. Use this parameter to influence directory structure within the archive.
  • -
  • archiveFile - The output archive file. If existing, will be overwritten.
  • -
  • files - A sequence of files to compress.
  • -
- - - -
- - - createFile file - -
- Signature: file:FileInfo -> TarOutputStream
-
-
- - - - -

Creates a TarOutputStream wrapping a file.

- -

Parameters

- -
    -
  • file - The FileInfo describing the location to which the archive should be written. Will be overwritten if it exists.
  • -
- - - -
- - - extract extractDir archiveFile - -
- Signature: extractDir:DirectoryInfo -> archiveFile:FileInfo -> unit
-
-
- - - - -

Extracts a tar.bz2 archive to a given directory.

- -

Parameters

- -
    -
  • extractDir - The directory into which the archived files will be extracted.
  • -
  • archiveFile - The archive to be extracted.
  • -
- - - -
- - - extractStream - -
- Signature: Stream -> TarInputStream
-
-
- - - - -

Wraps an input stream with a tar.gz decompressor.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-tar-gzip.html b/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-tar-gzip.html deleted file mode 100644 index 2d0c3b5..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-tar-gzip.html +++ /dev/null @@ -1,379 +0,0 @@ - - - - - GZip - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

GZip

-
-

Operations and tasks for working with tar archives compressed with GZip.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - compress gzipParam - -
- Signature: gzipParam:GZipCompressionParams -> FileInfo -> seq<ArchiveFileSpec> -> unit
-
-
- - - - -

Constructs a function that will create a tar.gz archive from a set of files.

- - - -
- - - Compress (...) - -
- Signature: setParams:(GZipCompressionParams -> GZipCompressionParams) -> flatten:bool -> baseDir:DirectoryInfo -> archiveFile:FileInfo -> files:seq<FileInfo> -> unit
-
-
- - - - -

Creates a tar.gz archive with the given files.

- -

Parameters

- -
    -
  • setParams - A function which modifies the default compression parameters.
  • -
  • flatten - If set to true then all subfolders are merged into the root folder of the archive.
  • -
  • baseDir - The relative directory of the files to be compressed. Use this parameter to influence directory structure within the archive.
  • -
  • archiveFile - The output archive file. If existing, will be overwritten.
  • -
  • files - A sequence of files to compress.
  • -
- - - -
- - - CompressDir (...) - -
- Signature: setParams:(GZipCompressionParams -> GZipCompressionParams) -> flatten:bool -> baseDir:DirectoryInfo -> archiveFile:FileInfo -> unit
-
-
- - - - -

Creates a tar.gz archive containing all the files in a directory.

- -

Parameters

- -
    -
  • setParams - A function which modifies the default compression parameters.
  • -
  • flatten - If set to true then all subfolders are merged into the root folder of the archive.
  • -
  • baseDir - The base directory to be compressed. This directory will be the root of the resulting archive.
  • -
  • archiveFile - The output archive file. If existing, will be overwritten.
  • -
- - - -
- - - CompressDirWithDefaults (...) - -
- Signature: baseDir:DirectoryInfo -> archiveFile:FileInfo -> unit
-
-
- - - - -

Creates a tar.gz archive containing all the files in a directory.

- -

Parameters

- -
    -
  • baseDir - The base directory to be compressed. This directory will be the root of the resulting archive.
  • -
  • archiveFile - The output archive file. If existing, will be overwritten.
  • -
- - - -
- - - CompressSpecs (...) - -
- Signature: setParams:(GZipCompressionParams -> GZipCompressionParams) -> archiveFile:FileInfo -> fileSpecs:seq<ArchiveFileSpec> -> unit
-
-
- - - - -

Creates a tar.gz archive with the given archive file specifications.

- -

Parameters

- -
    -
  • setParams - A function which modifies the default compression parameters.
  • -
  • archiveFile - The output archive file. If existing, will be overwritten.
  • -
  • fileSpecs - A sequence of archive file specifications.
  • -
- - - -
- - - compressStream gzipParams - -
- Signature: gzipParams:GZipCompressionParams -> Stream -> TarOutputStream
-
-
- - - - -

Wraps an output stream with a tar.gz compressor.

- - - -
- - - CompressWithDefaults (...) - -
- Signature: baseDir:DirectoryInfo -> archiveFile:FileInfo -> files:seq<FileInfo> -> unit
-
-
- - - - -

Creates a tar.gz archive with the given files with default parameters.

- -

Parameters

- -
    -
  • baseDir - The relative directory of the files to be compressed. Use this parameter to influence directory structure within the archive.
  • -
  • archiveFile - The output archive file. If existing, will be overwritten.
  • -
  • files - A sequence of files to compress.
  • -
- - - -
- - - createFile gzipParams file - -
- Signature: gzipParams:GZipCompressionParams -> file:FileInfo -> TarOutputStream
-
-
- - - - -

Creates a TarOutputStream wrapping a file using the given parameters.

- -

Parameters

- -
    -
  • gzipParams - The gzip compression parameters.
  • -
  • file - The FileInfo describing the location to which the archive should be written. Will be overwritten if it exists.
  • -
- - - -
- - - Extract extractDir archiveFile - -
- Signature: extractDir:DirectoryInfo -> archiveFile:FileInfo -> unit
-
-
- - - - -

Extracts a tar.gz archive to a given directory.

- -

Parameters

- -
    -
  • extractDir - The directory into which the archived files will be extracted.
  • -
  • archiveFile - The archive to be extracted.
  • -
- - - -
- - - extractStream - -
- Signature: Stream -> TarInputStream
-
-
- - - - -

Wraps an input stream with a tar.gz decompressor.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-tar.html b/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-tar.html deleted file mode 100644 index f76b19e..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-tar.html +++ /dev/null @@ -1,425 +0,0 @@ - - - - - Tar - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Tar

-
-

Operations and tasks for working with tar archives.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - -
ModuleDescription
- BZip2 -

Operations and tasks for working with tar archives compressed with BZip2.

- - -
- GZip -

Operations and tasks for working with tar archives compressed with GZip.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - addEntry outStream - -
- Signature: outStream:TarOutputStream -> ArchiveFileSpec -> unit
-
-
- - - - -

Adds a file, specified by an ArchiveFileSpec, to a TarOutputStream.

- - - -
- - - CompressDir flatten baseDir archiveFile - -
- Signature: flatten:bool -> baseDir:DirectoryInfo -> archiveFile:FileInfo -> unit
-
-
- - - - -

Creates a tar archive containing all the files in a directory.

- -

Parameters

- -
    -
  • flatten - If set to true then all subfolders are merged into the root folder of the archive.
  • -
  • baseDir - The base directory to be archived. This directory will be the root of the resulting archive.
  • -
  • archiveFile - The output archive file. If existing, will be overwritten.
  • -
- - - -
- - - CompressDirWithDefaults (...) - -
- Signature: baseDir:DirectoryInfo -> archiveFile:FileInfo -> unit
-
-
- - - - -

Creates a tar.gz archive containing all the files in a directory.

- -

Parameters

- -
    -
  • baseDir - The base directory to be archived. This directory will be the root of the resulting archive.
  • -
  • archiveFile - The output archive file. If existing, will be overwritten.
  • -
- - - -
- - - createFile file - -
- Signature: file:FileInfo -> TarOutputStream
-
-
- - - - -

Creates a TarOutputStream wrapping a file using the given parameters.

- -

Parameters

- -
    -
  • file - The FileInfo describing the location to which the archive should be written. Will be overwritten if it exists.
  • -
- - - -
- - - Extract extractDir archiveFile - -
- Signature: extractDir:DirectoryInfo -> archiveFile:FileInfo -> unit
-
-
- - - - -

Extracts a tar archive to a given directory.

- -

Parameters

- -
    -
  • targetDir - The directory into which the archived files will be extracted.
  • -
  • archiveFile - The archive to be extracted.
  • -
- - - -
- - - extractStream inner - -
- Signature: inner:Stream -> TarInputStream
-
-
- - - - -

Wraps an input stream with a tar container extractor.

- - - -
- - - store file items - -
- Signature: file:FileInfo -> items:seq<ArchiveFileSpec> -> unit
-
-
- - - - -

Constructs a function that will create a tar archive from a set of files.

- - - -
- - - Store flatten baseDir archiveFile files - -
- Signature: flatten:bool -> baseDir:DirectoryInfo -> archiveFile:FileInfo -> files:seq<FileInfo> -> unit
-
-
- - - - -

Creates a tar archive with the given files.

- -

Parameters

- -
    -
  • flatten - If set to true then all subfolders are merged into the root folder of the archive.
  • -
  • baseDir - The relative directory of the files to be archived. Use this parameter to influence directory structure within the archive.
  • -
  • archiveFile - The output archive file. If existing, will be overwritten.
  • -
  • files - A sequence of files to store.
  • -
- - - -
- - - StoreSpecs archiveFile fileSpecs - -
- Signature: archiveFile:FileInfo -> fileSpecs:seq<ArchiveFileSpec> -> unit
-
-
- - - - -

Creates a tar archive with the given archive file specifications.

- -

Parameters

- -
    -
  • archiveFile - The output archive file. If existing, will be overwritten.
  • -
  • fileSpecs - A sequence of archive file specifications.
  • -
- - - -
- - - storeStream inner - -
- Signature: inner:Stream -> TarOutputStream
-
-
- - - - -

Wraps an output stream with a tar container store.

- - - -
- - - StoreWithDefaults (...) - -
- Signature: baseDir:DirectoryInfo -> archiveFile:FileInfo -> files:seq<FileInfo> -> unit
-
-
- - - - -

Creates a tar archive with the given files with default parameters.

- -

Parameters

- -
    -
  • baseDir - The relative directory of the files to be archived. Use this parameter to influence directory structure within the archive.
  • -
  • archiveFile - The output archive file. If existing, will be overwritten.
  • -
  • files - A sequence of files to store.
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-zip-zipcompressionparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-zip-zipcompressionparams.html deleted file mode 100644 index bb750f8..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-zip-zipcompressionparams.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - ZipCompressionParams - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-zip.html b/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-zip.html deleted file mode 100644 index 02705be..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper-zip.html +++ /dev/null @@ -1,448 +0,0 @@ - - - - - Zip - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Zip

-
-

Operations and tasks for working with zip archives.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- ZipCompressionParams -

The zip archive compression parameters.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - addZipEntry outStream - -
- Signature: outStream:ZipOutputStream -> ArchiveFileSpec -> unit
-
-
- - - - -

Adds a file, specified by an ArchiveFileSpec, to a ZipOutputStream.

- - - -
- - - compress zipParams - -
- Signature: zipParams:ZipCompressionParams -> FileInfo -> seq<ArchiveFileSpec> -> unit
-
-
- - - - -

Constructs a function that will create a zip archive from a set of files.

- - - -
- - - Compress (...) - -
- Signature: setParams:(ZipCompressionParams -> ZipCompressionParams) -> flatten:bool -> baseDir:DirectoryInfo -> archiveFile:FileInfo -> files:seq<FileInfo> -> unit
-
-
- - - - -

Creates a zip archive with the given files.

- -

Parameters

- -
    -
  • setParams - A function which modifies the default compression parameters.
  • -
  • flatten - If set to true then all subfolders are merged into the root folder of the archive.
  • -
  • baseDir - The relative directory of the files to be compressed. Use this parameter to influence directory structure within the archive.
  • -
  • archiveFile - The output archive file. If existing, will be overwritten.
  • -
  • files - A sequence of files to compress.
  • -
- - - -
- - - CompressDir (...) - -
- Signature: setParams:(ZipCompressionParams -> ZipCompressionParams) -> flatten:bool -> baseDir:DirectoryInfo -> archiveFile:FileInfo -> unit
-
-
- - - - -

Creates a zip archive containing all the files in a directory.

- -

Parameters

- -
    -
  • setParams - A function which modifies the default compression parameters.
  • -
  • flatten - If set to true then all subfolders are merged into the root folder of the archive.
  • -
  • baseDir - The base directory to be compressed. This directory will be the root of the resulting archive.
  • -
  • archiveFile - The output archive file. If existing, will be overwritten.
  • -
- - - -
- - - CompressDirWithDefaults (...) - -
- Signature: baseDir:DirectoryInfo -> archiveFile:FileInfo -> unit
-
-
- - - - -

Creates a zip archive containing all the files in a directory.

- -

Parameters

- -
    -
  • baseDir - The base directory to be compressed. This directory will be the root of the resulting archive.
  • -
  • archiveFile - The output archive file. If existing, will be overwritten.
  • -
- - - -
- - - CompressSpecs (...) - -
- Signature: setParams:(ZipCompressionParams -> ZipCompressionParams) -> archiveFile:FileInfo -> fileSpecs:seq<ArchiveFileSpec> -> unit
-
-
- - - - -

Creates a zip archive with the given archive file specifications.

- -

Parameters

- -
    -
  • setParams - A function which modifies the default compression parameters.
  • -
  • archiveFile - The output archive file. If existing, will be overwritten.
  • -
  • fileSpecs - A sequence of archive file specifications.
  • -
- - - -
- - - compressStream arg1 inner - -
- Signature: ZipCompressionParams -> inner:Stream -> ZipOutputStream
-
-
- - - - -

Wraps an output stream with a zip compressor.

- - - -
- - - CompressWithDefaults (...) - -
- Signature: baseDir:DirectoryInfo -> archiveFile:FileInfo -> files:seq<FileInfo> -> unit
-
-
- - - - -

Creates a zip archive with the given files with default parameters.

- -

Parameters

- -
    -
  • baseDir - The relative directory of the files to be compressed. Use this parameter to influence directory structure within the archive.
  • -
  • archiveFile - The output archive file. If existing, will be overwritten.
  • -
  • files - A sequence of files to compress.
  • -
- - - -
- - - createFile zipParams file - -
- Signature: zipParams:ZipCompressionParams -> file:FileInfo -> ZipOutputStream
-
-
- - - - -

Creates a ZipOutputStream wrapping a file using the given parameters.

- -

Parameters

- -
    -
  • zipParams - The zip compression parameters.
  • -
  • file - The FileInfo describing the location to which the archive should be written. Will be overwritten if it exists.
  • -
- - - -
- - - Extract extractDir archiveFile - -
- Signature: extractDir:DirectoryInfo -> archiveFile:FileInfo -> unit
-
-
- - - - -

Extracts a zip archive to a given directory.

- -

Parameters

- -
    -
  • extractDir - The directory into which the archived files will be extracted.
  • -
  • archiveFile - The archive to be extracted.
  • -
- - - -
- - - extractStream inner - -
- Signature: inner:Stream -> ZipInputStream
-
-
- - - - -

Wraps an input stream with a zip decompressor.

- - - -
- - - ZipCompressionDefaults - -
- Signature: ZipCompressionParams
-
-
- - - - -

The default zip archive compression parameters

- -

Defaults

- -
    -
  • Level - CompressionLevel.Default
  • -
  • Comment - None
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper.html deleted file mode 100644 index 17864a9..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-archivehelper.html +++ /dev/null @@ -1,227 +0,0 @@ - - - - - ArchiveHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ArchiveHelper

-
-

Provides utility tasks for storing and compressing files in archives.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- ArchiveFileSpec -

A description of a file to be added to an archive.

- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
ModuleDescription
- BZip2 -

Operations and tasks for working with gzip compressed files.

- - -
- CompressionLevel -

Provides validation of comression levels used for the zip and gzip compression algorithms.

- - -
- GZip -

Operations and tasks for working with gzip compressed files.

- - -
- Tar -

Operations and tasks for working with tar archives.

- - -
- Zip -

Operations and tasks for working with zip archives.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - archiveFileSpec file - -
- Signature: file:FileInfo -> ArchiveFileSpec
-
-
- - - - -

Constructs a file specification which will archive the file at the root.

- - - -
- - - archiveFileSpecWithBaseDir baseDir file - -
- Signature: baseDir:DirectoryInfo -> file:FileInfo -> ArchiveFileSpec
-
-
- - - - -

Constructs a file specification which will archive the file with a path relative to the baseDir.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-assemblyinfofile-assemblyinfofileconfig.html b/packages/FAKE.4.11.3/docs/apidocs/fake-assemblyinfofile-assemblyinfofileconfig.html deleted file mode 100644 index 7f82847..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-assemblyinfofile-assemblyinfofileconfig.html +++ /dev/null @@ -1,198 +0,0 @@ - - - - - AssemblyInfoFileConfig - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

AssemblyInfoFileConfig

-
-

Represents options for configuring the emission of AssemblyInfo

- - -
-

Constructors

- - - - - - - - - - -
ConstructorDescription
- - - new(generateClass, useNamespace) - -
- Signature: (generateClass:bool * useNamespace:string option) -> AssemblyInfoFileConfig
-
-
- - - - - -
-

Instance members

- - - - - - - - - - - - - - -
Instance memberDescription
- - - GenerateClass - -
- Signature: bool
-
-
- - - - - -
- - - UseNamespace - -
- Signature: string
-
-
- - - - - -
-

Static members

- - - - - - - - - - -
Static memberDescription
- - - Default - -
- Signature: AssemblyInfoFileConfig
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-assemblyinfofile-attribute.html b/packages/FAKE.4.11.3/docs/apidocs/fake-assemblyinfofile-attribute.html deleted file mode 100644 index cce2bc4..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-assemblyinfofile-attribute.html +++ /dev/null @@ -1,639 +0,0 @@ - - - - - Attribute - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Attribute

-
-

Represents AssemblyInfo attributes

- - -
-

Constructors

- - - - - - - - - - -
ConstructorDescription
- - - new(name, value, inNamespace) - -
- Signature: (name:string * value:string * inNamespace:string) -> Attribute
-
-
- - - - - -
-

Instance members

- - - - - - - - - - - - - - - - - - -
Instance memberDescription
- - - Name - -
- Signature: string
-
-
- - - - - -
- - - Namespace - -
- Signature: string
-
-
- - - - - -
- - - Value - -
- Signature: string
-
-
- - - - - -
-

Static members

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Static memberDescription
- - - BoolAttribute(name, value, inNamespace) - -
- Signature: (name:string * value:bool * inNamespace:string) -> Attribute
-
-
- - - - -

Creates a simple attribute with boolean values. Used as base for other attributes

- - - -
- - - CLSCompliant(value) - -
- Signature: (value:bool option) -> Attribute
-
-
- - - - -

Creates an attribute which specifies if the assembly is CLS compliant

- - - -
- - - Company(value) - -
- Signature: value:string -> Attribute
-
-
- - - - -

Creates an attribute which holds the company information

- - - -
- - - ComVisible(value) - -
- Signature: (value:bool option) -> Attribute
-
-
- - - - -

Creates an attribute which specifies if the assembly is visible via COM

- - - -
- - - Configuration(value) - -
- Signature: value:string -> Attribute
-
-
- - - - -

Creates an attribute which holds the assembly configuration

- - - -
- - - Copyright(value) - -
- Signature: value:string -> Attribute
-
-
- - - - -

Creates an attribute which holds the copyright information

- - - -
- - - Culture(value) - -
- Signature: value:string -> Attribute
-
-
- - - - -

Creates an attribute which holds the assembly culture information

- - - -
- - - DelaySign(value) - -
- Signature: (value:bool option) -> Attribute
-
-
- - - - -

Creates an attribute which specifies if the assembly uses delayed signing

- - - -
- - - Description(value) - -
- Signature: value:string -> Attribute
-
-
- - - - -

Creates an attribute which holds the product description

- - - -
- - - FileVersion(value) - -
- Signature: value:string -> Attribute
-
-
- - - - -

Creates an attribute which holds the assembly file version

- - - -
- - - Guid(value) - -
- Signature: value:string -> Attribute
-
-
- - - - -

Creates an attribute which holds the Guid

- - - -
- - - InformationalVersion(value) - -
- Signature: value:string -> Attribute
-
-
- - - - -

Creates an attribute which holds an assembly information version

- - - -
- - - InternalsVisibleTo(value) - -
- Signature: value:string -> Attribute
-
-
- - - - -

Creates an attribute which holds the "InternalVisibleTo" data

- - - -
- - - KeyFile(value) - -
- Signature: value:string -> Attribute
-
-
- - - - -

Creates an attribute which holds the assembly key file

- - - -
- - - KeyName(value) - -
- Signature: value:string -> Attribute
-
-
- - - - -

Creates an attribute which holds the assembly key name

- - - -
- - - Metadata(name, value) - -
- Signature: (name:string * value:string) -> Attribute
-
-
- - - - -

Create an attribute which specifies metadata about the assembly

- - - -
- - - Product(value) - -
- Signature: value:string -> Attribute
-
-
- - - - -

Creates an attribute which holds the product name

- - - -
- - - StringAttribute(...) - -
- Signature: (name:string * value:string * inNamespace:string) -> Attribute
-
-
- - - - -

Creates a simple attribute with string values. Used as base for other attributes

- - - -
- - - Title(value) - -
- Signature: value:string -> Attribute
-
-
- - - - -

Creates an attribute which holds the product title

- - - -
- - - Trademark(value) - -
- Signature: value:string -> Attribute
-
-
- - - - -

Creates an attribute which holds the trademark

- - - -
- - - Version(value) - -
- Signature: value:string -> Attribute
-
-
- - - - -

Creates an attribute which holds the assembly version

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-assemblyinfofile.html b/packages/FAKE.4.11.3/docs/apidocs/fake-assemblyinfofile.html deleted file mode 100644 index 95e657d..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-assemblyinfofile.html +++ /dev/null @@ -1,318 +0,0 @@ - - - - - AssemblyInfoFile - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

AssemblyInfoFile

-
-

Contains tasks to generate AssemblyInfo files for C# and F#. -There is also a tutorial about the AssemblyInfo tasks available.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - -
TypeDescription
- AssemblyInfoFileConfig -

Represents options for configuring the emission of AssemblyInfo

- - -
- Attribute -

Represents AssemblyInfo attributes

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - CreateCppCliAssemblyInfo (...) - -
- Signature: outputFileName:string -> attributes:seq<Attribute> -> unit
-
-
- - - - -

Creates a C++/CLI AssemblyInfo file with the given attributes.

- - - -
- - - CreateCppCliAssemblyInfoWithConfig (...) - -
- Signature: outputFileName:string -> attributes:seq<Attribute> -> config:AssemblyInfoFileConfig -> unit
-
-
- - - - -

Creates a C++/CLI AssemblyInfo file with the given attributes and configuration. -Does not generate an AssemblyVersionInformation class.

- - - -
- - - CreateCSharpAssemblyInfo (...) - -
- Signature: outputFileName:string -> attributes:seq<Attribute> -> unit
-
-
- - - - -

Creates a C# AssemblyInfo file with the given attributes. -The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly.

- - - -
- - - CreateCSharpAssemblyInfoWithConfig (...) - -
- Signature: outputFileName:string -> attributes:seq<Attribute> -> config:AssemblyInfoFileConfig -> unit
-
-
- - - - -

Creates a C# AssemblyInfo file with the given attributes and configuration. -The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly.

- - - -
- - - CreateFSharpAssemblyInfo (...) - -
- Signature: outputFileName:string -> attributes:seq<Attribute> -> unit
-
-
- - - - -

Creates a F# AssemblyInfo file with the given attributes. -The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly.

- - - -
- - - CreateFSharpAssemblyInfoWithConfig (...) - -
- Signature: outputFileName:string -> attributes:seq<Attribute> -> config:AssemblyInfoFileConfig -> unit
-
-
- - - - -

Creates a F# AssemblyInfo file with the given attributes and configuration. -The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly.

- - - -
- - - CreateVisualBasicAssemblyInfo (...) - -
- Signature: outputFileName:string -> attributes:seq<Attribute> -> unit
-
-
- - - - -

Creates a VB AssemblyInfo file with the given attributes. -The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly.

- - - -
- - - CreateVisualBasicAssemblyInfoWithConfig (...) - -
- Signature: outputFileName:string -> attributes:seq<Attribute> -> config:AssemblyInfoFileConfig -> unit
-
-
- - - - -

Creates a VB AssemblyInfo file with the given attributes and configuration. -The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-assemblyinfohelper-assemblyinfoparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-assemblyinfohelper-assemblyinfoparams.html deleted file mode 100644 index ec0e667..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-assemblyinfohelper-assemblyinfoparams.html +++ /dev/null @@ -1,467 +0,0 @@ - - - - - AssemblyInfoParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

AssemblyInfoParams

-
-
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - AssemblyCompany - -
- Signature: string
-
-
- - - - - -
- - - AssemblyConfiguration - -
- Signature: string
-
-
- - - - - -
- - - AssemblyCopyright - -
- Signature: string
-
-
- - - - - -
- - - AssemblyCulture - -
- Signature: string
-
-
- - - - - -
- - - AssemblyDelaySign - -
- Signature: bool option
-
-
- - - - - -
- - - AssemblyDescription - -
- Signature: string
-
-
- - - - - -
- - - AssemblyFileVersion - -
- Signature: string
-
-
- - - - - -
- - - AssemblyInformationalVersion - -
- Signature: string
-
-
- - - - - -
- - - AssemblyKeyFile - -
- Signature: string
-
-
- - - - - -
- - - AssemblyKeyName - -
- Signature: string
-
-
- - - - - -
- - - AssemblyProduct - -
- Signature: string
-
-
- - - - - -
- - - AssemblyTitle - -
- Signature: string
-
-
- - - - - -
- - - AssemblyTrademark - -
- Signature: string
-
-
- - - - - -
- - - AssemblyVersion - -
- Signature: string
-
-
- - - - - -
- - - CLSCompliant - -
- Signature: bool option
-
-
- - - - - -
- - - CodeLanguage - -
- Signature: CodeLanguage
-
-
- - - - - -
- - - ComVisible - -
- Signature: bool option
-
-
- - - - - -
- - - GenerateClass - -
- Signature: bool
-
-
- - - - - -
- - - Guid - -
- Signature: string
-
-
- - - - - -
- - - OutputFileName - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-assemblyinfohelper-assemblyinforeplacementparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-assemblyinfohelper-assemblyinforeplacementparams.html deleted file mode 100644 index 18efd65..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-assemblyinfohelper-assemblyinforeplacementparams.html +++ /dev/null @@ -1,251 +0,0 @@ - - - - - AssemblyInfoReplacementParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

AssemblyInfoReplacementParams

-
-
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - AssemblyCompany - -
- Signature: string
-
-
- - - - - -
- - - AssemblyConfiguration - -
- Signature: string
-
-
- - - - - -
- - - AssemblyCopyright - -
- Signature: string
-
-
- - - - - -
- - - AssemblyFileVersion - -
- Signature: string
-
-
- - - - - -
- - - AssemblyInformationalVersion - -
- Signature: string
-
-
- - - - - -
- - - AssemblyMetadata - -
- Signature: (string * string) list
-
-
- - - - - -
- - - AssemblyVersion - -
- Signature: string
-
-
- - - - - -
- - - OutputFileName - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-assemblyinfohelper-codelanguage.html b/packages/FAKE.4.11.3/docs/apidocs/fake-assemblyinfohelper-codelanguage.html deleted file mode 100644 index 56ad759..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-assemblyinfohelper-codelanguage.html +++ /dev/null @@ -1,161 +0,0 @@ - - - - - CodeLanguage - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-assemblyinfohelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-assemblyinfohelper.html deleted file mode 100644 index d40cde3..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-assemblyinfohelper.html +++ /dev/null @@ -1,288 +0,0 @@ - - - - - AssemblyInfoHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

AssemblyInfoHelper

-
-

Generates an AssemblyInfo file

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - -
TypeDescription
- AssemblyInfoParams -
- AssemblyInfoReplacementParams -
- CodeLanguage -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - AssemblyInfo setParams - -
- Signature: setParams:(AssemblyInfoParams -> AssemblyInfoParams) -> unit
-
-
- - - - -

Generates an AssemblyInfo file for projects -Obsolete - Please use the new AssemblyInfoFile tasks

- - - -
- - - AssemblyInfoDefaults - -
- Signature: AssemblyInfoParams
-
-
- - - - -

AssemblyInfo default params

- - - -
- - - AssemblyInfoReplacementDefaults - -
- Signature: AssemblyInfoReplacementParams
-
-
- - - - -

AssemblyInfoReplacement default params

- - - -
- - - BulkReplaceAssemblyInfoVersions (...) - -
- Signature: dir:string -> replacementParameters:(AssemblyInfoReplacementParams -> AssemblyInfoReplacementParams) -> unit
-
-
- - - - -

Update all AssemblyInfo.[fs|cs|vb] files in the specified directory and its subdirectories

- -

Parameters

- -
    -
  • 'dir' - The directory (subdirectories will be included), which inhabits the AssemblyInfo files.
  • -
  • 'replacementParameters' - The replacement parameters for the AssemblyInfo files.
  • -
- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-
   BulkReplaceAssemblyInfoVersions "test/" (fun f -> 
-                                              {f with
-                                                  AssemblyVersion = "1.1.1.1"
-                                                  AssemblyInformationalVersion = "1.1.1.1"})
-
- - - -
- - - generateFile (...) - -
- Signature: param:AssemblyInfoParams -> attributes:Dictionary<string,string> -> imports:seq<string> -> writer:TextWriter -> unit
-
-
- - - - -

generates the assembly info file

- - - -
- - - ReplaceAssemblyInfoVersions param - -
- Signature: param:(AssemblyInfoReplacementParams -> AssemblyInfoReplacementParams) -> unit
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-azure-cloudservices-packagecloudserviceparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-azure-cloudservices-packagecloudserviceparams.html deleted file mode 100644 index faaab5d..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-azure-cloudservices-packagecloudserviceparams.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - PackageCloudServiceParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

PackageCloudServiceParams

-
-

Configuration details for packaging cloud services.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - CloudService - -
- Signature: string
-
-
- - - - -

The name of the Cloud Service.

- - - -
- - - OutputPath - -
- Signature: string option
-
-
- - - - -

The output path for the .cspkg.

- - - -
- - - SdkVersion - -
- Signature: float option
-
-
- - - - -

The SDK version to use e.g. 2.2. If None, the latest available version is used.

- - - -
- - - WorkerRole - -
- Signature: string
-
-
- - - - -

The name of the role in the service.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-azure-cloudservices-vmsizes-vmsize.html b/packages/FAKE.4.11.3/docs/apidocs/fake-azure-cloudservices-vmsizes-vmsize.html deleted file mode 100644 index 29d7141..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-azure-cloudservices-vmsizes-vmsize.html +++ /dev/null @@ -1,125 +0,0 @@ - - - - - VmSize - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-azure-cloudservices-vmsizes.html b/packages/FAKE.4.11.3/docs/apidocs/fake-azure-cloudservices-vmsizes.html deleted file mode 100644 index 5014e1f..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-azure-cloudservices-vmsizes.html +++ /dev/null @@ -1,307 +0,0 @@ - - - - - VmSizes - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

VmSizes

-
-
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- VmSize -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - A5 - -
- Signature: VmSize
-
-
- - - - - -
- - - A6 - -
- Signature: VmSize
-
-
- - - - - -
- - - A7 - -
- Signature: VmSize
-
-
- - - - - -
- - - A8 - -
- Signature: VmSize
-
-
- - - - - -
- - - A9 - -
- Signature: VmSize
-
-
- - - - - -
- - - ExtraLarge - -
- Signature: VmSize
-
-
- - - - - -
- - - ExtraSmall - -
- Signature: VmSize
-
-
- - - - - -
- - - Large - -
- Signature: VmSize
-
-
- - - - - -
- - - Medium - -
- Signature: VmSize
-
-
- - - - - -
- - - Small - -
- Signature: VmSize
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-azure-cloudservices.html b/packages/FAKE.4.11.3/docs/apidocs/fake-azure-cloudservices.html deleted file mode 100644 index d5bf203..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-azure-cloudservices.html +++ /dev/null @@ -1,206 +0,0 @@ - - - - - CloudServices - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

CloudServices

-
-

Contains tasks to package Azure Cloud Services.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- PackageCloudServiceParams -

Configuration details for packaging cloud services.

- - -
- - - - - - - - - - -
ModuleDescription
- VmSizes -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - DefaultCloudServiceParams - -
- Signature: PackageCloudServiceParams
-
-
- - - - - -
- - - ModifyVMSize arg1 cloudService - -
- Signature: VmSize -> cloudService:string -> unit
-
-
- - - - -

Modifies the size of the Worker Role in the csdef.

- - - -
- - - PackageRole packageCloudServiceParams - -
- Signature: packageCloudServiceParams:PackageCloudServiceParams -> int option
-
-
- - - - -

Packages a cloud service role into a .cspkg, ready for deployment.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-azure-webjobs-webclientwithtimeout.html b/packages/FAKE.4.11.3/docs/apidocs/fake-azure-webjobs-webclientwithtimeout.html deleted file mode 100644 index 5d39f90..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-azure-webjobs-webclientwithtimeout.html +++ /dev/null @@ -1,169 +0,0 @@ - - - - - WebClientWithTimeout - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

WebClientWithTimeout

-
-
-

Constructors

- - - - - - - - - - -
ConstructorDescription
- - - new() - -
- Signature: unit -> WebClientWithTimeout
-
-
- - - - - -
-

Instance members

- - - - - - - - - - - - - - -
Instance memberDescription
- - - Timeout() - -
- Signature: unit -> int
-
-
- - - - - -
- - - Timeout() - -
- Signature: unit -> unit
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-azure-webjobs-webjob.html b/packages/FAKE.4.11.3/docs/apidocs/fake-azure-webjobs-webjob.html deleted file mode 100644 index d869ea6..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-azure-webjobs-webjob.html +++ /dev/null @@ -1,215 +0,0 @@ - - - - - WebJob - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

WebJob

-
-

WebJob type

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - DirectoryToPackage - -
- Signature: string
-
-
- - - - -

The directory path of the webjob to zip

- - - -
- - - JobType - -
- Signature: WebJobType
-
-
- - - - -

Specifies what type of webjob this is. Note that this also determines it's deployment location on Azure

- - - -
- - - Name - -
- Signature: string
-
-
- - - - -

The name of the web job, this will also be the name out of zip file.

- - - -
- - - PackageLocation - -
- Signature: string
-
-
- - - - -

The package path to once zipped

- - - -
- - - Project - -
- Signature: string
-
-
- - - - -

The project to be zipped and deployed as a webjob

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-azure-webjobs-webjobtype.html b/packages/FAKE.4.11.3/docs/apidocs/fake-azure-webjobs-webjobtype.html deleted file mode 100644 index 6e1a767..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-azure-webjobs-webjobtype.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - WebJobType - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-azure-webjobs-website.html b/packages/FAKE.4.11.3/docs/apidocs/fake-azure-webjobs-website.html deleted file mode 100644 index d4131e7..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-azure-webjobs-website.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - WebSite - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

WebSite

-
-

The website that webjobs are deployed to

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Password - -
- Signature: string
-
-
- - - - -

The FTP Password

- - - -
- - - Url - -
- Signature: Uri
-
-
- - - - -

The url of the website, usually in the format of https://.scm.azurewebsites.net

- - - -
- - - UserName - -
- Signature: string
-
-
- - - - -

The FTP username, usually the $username from the site's publish profile

- - - -
- - - WebJobs - -
- Signature: WebJob list
-
-
- - - - -

The webjobs to deploy to this web site

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-azure-webjobs.html b/packages/FAKE.4.11.3/docs/apidocs/fake-azure-webjobs.html deleted file mode 100644 index b049e88..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-azure-webjobs.html +++ /dev/null @@ -1,212 +0,0 @@ - - - - - WebJobs - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

WebJobs

-
-

Contains tasks to package and deploy Azure Web Jobs via the Kudu Zip controller

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- WebClientWithTimeout -
- WebJob -

WebJob type

- - -
- WebJobType -

The running modes of webjobs

- - -
- WebSite -

The website that webjobs are deployed to

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - DeployWebJobs webSites - -
- Signature: webSites:WebSite list -> unit
-
-
- - - - -

This task to can be used deploy a prebuilt webjob zip to a website

- -

Parameters

- -
    -
  • webSites - The websites and webjobs to deploy.
  • -
- - - -
- - - PackageWebJobs webSites - -
- Signature: webSites:WebSite list -> unit
-
-
- - - - -

This task to can be used create a zip for each webjob to deploy to a website -The output structure is: outputpath/{websitename}/webjobs/{continuous/triggered}/{webjobname}.zip

- -

Parameters

- -
    -
  • webSites - The websites and webjobs to build zips from.
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-azurehelper-azureemulatorparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-azurehelper-azureemulatorparams.html deleted file mode 100644 index 98c8052..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-azurehelper-azureemulatorparams.html +++ /dev/null @@ -1,272 +0,0 @@ - - - - - AzureEmulatorParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

AzureEmulatorParams

-
-

A type for the controlling parameter

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ClearFabric - -
- Signature: string
-
-
- - - - - -
- - - CSRunToolPath - -
- Signature: string
-
-
- - - - - -
- - - DSInitToolPath - -
- Signature: string
-
-
- - - - - -
- - - ForceCreate - -
- Signature: string
-
-
- - - - - -
- - - StartFabric - -
- Signature: string
-
-
- - - - - -
- - - StartStorage - -
- Signature: string
-
-
- - - - - -
- - - StopFabric - -
- Signature: string
-
-
- - - - - -
- - - StopStorage - -
- Signature: string
-
-
- - - - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-azurehelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-azurehelper.html deleted file mode 100644 index eaead99..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-azurehelper.html +++ /dev/null @@ -1,259 +0,0 @@ - - - - - AzureHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

AzureHelper

-
-

Contains tasks to control the local Azure Emulator

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- AzureEmulatorParams -

A type for the controlling parameter

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - AzureEmulatorDefaults - -
- Signature: AzureEmulatorParams
-
-
- - - - -

The default parameter of emulator

- - - -
- - - ResetDevStorage _arg1 - -
- Signature: _arg1:'?10782 -> unit
- Type parameters: '?10782
-
- - - - -

Resets the devstore (BLOB, Queues and Tables)

- - - -
- - - StartComputeEmulator _arg1 - -
- Signature: _arg1:'?10780 -> unit
- Type parameters: '?10780
-
- - - - -

Starts the compute emulator

- - - -
- - - StartStorageEmulator _arg1 - -
- Signature: _arg1:'?10776 -> unit
- Type parameters: '?10776
-
- - - - -

Starts the storage emulator

- - - -
- - - StopComputeEmulator _arg1 - -
- Signature: _arg1:'?10778 -> unit
- Type parameters: '?10778
-
- - - - -

Stops the compute emulator

- - - -
- - - StopStorageEmulator _arg1 - -
- Signature: _arg1:'?10774 -> unit
- Type parameters: '?10774
-
- - - - -

Stops the storage emulator

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-boot-commandenvironment.html b/packages/FAKE.4.11.3/docs/apidocs/fake-boot-commandenvironment.html deleted file mode 100644 index ffa64a5..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-boot-commandenvironment.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - CommandEnvironment - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

CommandEnvironment

-
-

Abstracts over command-line environment features.

- - -
-

Constructors

- - - - - - - - - - -
ConstructorDescription
- - - new() - -
- Signature: unit -> CommandEnvironment
-
-
- - - - - -
-

Instance members

- - - - - - - - - - - - - - - - - - -
Instance memberDescription
- - - CurrentDirectory - -
- Signature: string
- Modifiers: abstract
-
-
- - - - - -
- - - FakeDirectory - -
- Signature: string
- Modifiers: abstract
-
-
- - - - - -
- - - SendMessage(message) - -
- Signature: message:string -> unit
- Modifiers: abstract
-
-
- - - - - -
-

Static members

- - - - - - - - - - -
Static memberDescription
- - - Default - -
- Signature: CommandEnvironment
-
-
- - - - -

The default environment.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-boot-commandhandler.html b/packages/FAKE.4.11.3/docs/apidocs/fake-boot-commandhandler.html deleted file mode 100644 index 734eb34..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-boot-commandhandler.html +++ /dev/null @@ -1,157 +0,0 @@ - - - - - CommandHandler - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

CommandHandler

-
-

Represents a command line handler.

- - -
-

Record Fields

- - - - - - - - - - -
Record FieldDescription
- - - Run - -
- Signature: CommandEnvironment -> bool
-
-
- - - - - -
-

Instance members

- - - - - - - - - - -
Instance memberDescription
- - - Interact() - -
- Signature: unit -> unit
-
-
- - - - -

Runs the handler with the default environment.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-boot-config.html b/packages/FAKE.4.11.3/docs/apidocs/fake-boot-config.html deleted file mode 100644 index f1fbba4..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-boot-config.html +++ /dev/null @@ -1,286 +0,0 @@ - - - - - Config - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Config

-
-

Configures the boostrapping process.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - FrameworkName - -
- Signature: FrameworkName
-
-
- - - - -

Framework name for assembly resolution.

- - - -
- - - IncludesFile - -
- Signature: string
-
-
- - - - -

Full path to the auto-generated fsx file with include statements.

- - - -
- - - NuGetCredentials - -
- Signature: ICredentials option
-
-
- - - - -

The credentials to use when authenticating to NuGet, if any.

- - - -
- - - NuGetDependencies - -
- Signature: NuGetDependency list
-
-
- - - - -

List of automatically installed and NuGet dependencies.

- - - -
- - - NuGetPackagesDirectory - -
- Signature: string
-
-
- - - - -

Full path to the packages directory for storing NuGet packages.

- - - -
- - - NuGetSourceUrl - -
- Signature: string
-
-
- - - - -

The URL of the NuGet source to use.

- - - -
- - - SourceDirectory - -
- Signature: string
-
-
- - - - -

The full path to the root folder.

- - - -
-

Static members

- - - - - - - - - - -
Static memberDescription
- - - Default(sourceDir) - -
- Signature: sourceDir:string -> Config
-
-
- - - - -

The default configuration for a given source directory.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-boot-nugetdependency.html b/packages/FAKE.4.11.3/docs/apidocs/fake-boot-nugetdependency.html deleted file mode 100644 index adfe18e..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-boot-nugetdependency.html +++ /dev/null @@ -1,181 +0,0 @@ - - - - - NuGetDependency - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NuGetDependency

-
-

Specifies NuGet package dependencies.

- - -
-

Record Fields

- - - - - - - - - - - - - - -
Record FieldDescription
- - - PackageId - -
- Signature: string
-
-
- - - - -

The identifer of the package, such as "FAKE".

- - - -
- - - Version - -
- Signature: NuGetVersion
-
-
- - - - -

The version specification.

- - - -
-

Static members

- - - - - - - - - - -
Static memberDescription
- - - Create(id) - -
- Signature: id:string -> NuGetDependency
-
-
- - - - -

The default pacakage dependency - take latest including pre-release.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-boot-nugetversion.html b/packages/FAKE.4.11.3/docs/apidocs/fake-boot-nugetversion.html deleted file mode 100644 index 6cee974..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-boot-nugetversion.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - NuGetVersion - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NuGetVersion

-
-

Specifies which version of the NuGet package to install.

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - Latest - -
- Signature:
-
-
- - - - -

Pick the latest available version.

- - - -
- - - LatestPreRelease - -
- Signature:
-
-
- - - - -

Pick the latest available version, including pre-release versions.

- - - -
- - - SemanticVersion(string) - -
- Signature: string
-
-
- - - - -

Pick the given semantic version, such as "2.1.170-alpha".

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-boot-stage.html b/packages/FAKE.4.11.3/docs/apidocs/fake-boot-stage.html deleted file mode 100644 index 84b7a83..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-boot-stage.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - Stage - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-boot.html b/packages/FAKE.4.11.3/docs/apidocs/fake-boot.html deleted file mode 100644 index 767dce3..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-boot.html +++ /dev/null @@ -1,246 +0,0 @@ - - - - - Boot - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Boot

-
-

Implements support for boostrapping FAKE scripts. A bootstrapping -build.fsx script executes twice (in two stages), allowing to -download dependencies with NuGet and do other preparatory work in -the first stage, and have these dependencies available in the -second stage.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- CommandEnvironment -

Abstracts over command-line environment features.

- - -
- CommandHandler -

Represents a command line handler.

- - -
- Config -

Configures the boostrapping process.

- - -
- NuGetDependency -

Specifies NuGet package dependencies.

- - -
- NuGetVersion -

Specifies which version of the NuGet package to install.

- - -
- Stage -

Stage of execution for a boot system.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - HandlerForArgs args - -
- Signature: args:string list -> CommandHandler
-
-
- - - - -

Creates the CommandHandler from the

- - - -
- - - ParseCommandLine args - -
- Signature: args:seq<string> -> CommandHandler option
-
-
- - - - -

Detects boot-specific commands.

- - - -
- - - Prepare config - -
- Signature: config:Config -> unit
-
-
- - - - -

The main function intended to be executed in the BOOT phase of -boostrapping scripts.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-buildserverhelper-buildserver.html b/packages/FAKE.4.11.3/docs/apidocs/fake-buildserverhelper-buildserver.html deleted file mode 100644 index a1b439c..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-buildserverhelper-buildserver.html +++ /dev/null @@ -1,272 +0,0 @@ - - - - - BuildServer - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

BuildServer

-
-

The server type option.

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - AppVeyor - -
- Signature:
-
-
- - - - - -
- - - Bamboo - -
- Signature:
-
-
- - - - - -
- - - CCNet - -
- Signature:
-
-
- - - - - -
- - - GitLabCI - -
- Signature:
-
-
- - - - - -
- - - Jenkins - -
- Signature:
-
-
- - - - - -
- - - LocalBuild - -
- Signature:
-
-
- - - - - -
- - - TeamCity - -
- Signature:
-
-
- - - - - -
- - - TeamFoundation - -
- Signature:
-
-
- - - - - -
- - - Travis - -
- Signature:
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-buildserverhelper-tracemode.html b/packages/FAKE.4.11.3/docs/apidocs/fake-buildserverhelper-tracemode.html deleted file mode 100644 index 1c01bfc..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-buildserverhelper-tracemode.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - TraceMode - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-buildserverhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-buildserverhelper.html deleted file mode 100644 index 4d8b584..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-buildserverhelper.html +++ /dev/null @@ -1,249 +0,0 @@ - - - - - BuildServerHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

BuildServerHelper

-
-

Contains functions which allow build scripts to interact with a build server.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - -
TypeDescription
- BuildServer -

The server type option.

- - -
- TraceMode -

The trace mode option.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - buildServer - -
- Signature: BuildServer
-
-
- - - - -

The current build server

- - - -
- - - buildVersion - -
- Signature: string
-
-
- - - - -

The current build version as detected from the current build server.

- - - -
- - - isLocalBuild - -
- Signature: bool
-
-
- - - - -

Is true when the current build is a local build.

- - - -
- - - verbose - -
- Signature: bool
-
-
- - - - -

Defines if FAKE will use verbose tracing. -This flag can be specified by setting the verbose build parameter.

- - - -
- - - xmlOutputFile - -
- Signature: string
-
-
- - - - -

Defines the XML output file - used for build servers like CruiseControl.NET. -This output file can be specified by using the logfile build parameter.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-cachehelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-cachehelper.html deleted file mode 100644 index f700a2f..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-cachehelper.html +++ /dev/null @@ -1,135 +0,0 @@ - - - - - CacheHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

CacheHelper

-
-

Contains functions which allows to deal with a cache.

- - -
- - - -

Functions and values

- - - - - - - - - - -
Function or valueDescription
- - - lookup key newValueF cache - -
- Signature: key:'?10569 -> newValueF:(unit -> '?10570) -> cache:IDictionary<'?10569,'?10570> -> '?10570
- Type parameters: '?10569, '?10570
-
- - - - -

Looks for a key in the cache. -If it is not found the newValueF function is executed and the result is stored in the cache.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-changewatcher-filechange.html b/packages/FAKE.4.11.3/docs/apidocs/fake-changewatcher-filechange.html deleted file mode 100644 index df8c0f4..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-changewatcher-filechange.html +++ /dev/null @@ -1,161 +0,0 @@ - - - - - FileChange - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-changewatcher-filestatus.html b/packages/FAKE.4.11.3/docs/apidocs/fake-changewatcher-filestatus.html deleted file mode 100644 index 2888dfb..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-changewatcher-filestatus.html +++ /dev/null @@ -1,161 +0,0 @@ - - - - - FileStatus - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-changewatcher.html b/packages/FAKE.4.11.3/docs/apidocs/fake-changewatcher.html deleted file mode 100644 index 7d24040..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-changewatcher.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - ChangeWatcher - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ChangeWatcher

-
-

This module contains helpers to react to file system events.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - -
TypeDescription
- FileChange -
- FileStatus -
- -
- -

Functions and values

- - - - - - - - - - -
Function or valueDescription
- - - WatchChanges onChange fileIncludes - -
- Signature: onChange:(seq<FileChange> -> unit) -> fileIncludes:FileIncludes -> IDisposable
-
-
- - - - -

Watches the for changes in the matching files. -Returns an IDisposable which allows to dispose all FileSystemWatchers.

- -

Parameters

- -
    -
  • onChange - function to call when a change is detected.
  • -
  • fileIncludes - The glob pattern for files to watch for changes.
  • -
- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-8: 
-9: 
-
Target "Watch" (fun _ ->
-    use watcher = !! "c:/projects/watchDir/*.txt" |> WatchChanges (fun changes -> 
-        // do something
-    )
-
-    System.Console.ReadLine() |> ignore
-
-    watcher.Dispose() // if you need to cleanup the watches.
-)
-
- -
namespace System
-
type Console =
  static member BackgroundColor : ConsoleColor with get, set
  static member Beep : unit -> unit + 1 overload
  static member BufferHeight : int with get, set
  static member BufferWidth : int with get, set
  static member CapsLock : bool
  static member Clear : unit -> unit
  static member CursorLeft : int with get, set
  static member CursorSize : int with get, set
  static member CursorTop : int with get, set
  static member CursorVisible : bool with get, set
  ...

Full name: System.Console
-
System.Console.ReadLine() : string
-
val ignore : value:'T -> unit

Full name: Microsoft.FSharp.Core.Operators.ignore
- - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-cmakesupport-cmake.html b/packages/FAKE.4.11.3/docs/apidocs/fake-cmakesupport-cmake.html deleted file mode 100644 index b9b3195..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-cmakesupport-cmake.html +++ /dev/null @@ -1,210 +0,0 @@ - - - - - CMake - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

CMake

-
-

Contains tasks which allow to use CMake to build CMakeLists files. -See Samples/CMakeSupport for usage examples.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - Build setParams - -
- Signature: setParams:(CMakeBuildParams -> CMakeBuildParams) -> unit
-
-
- - - - -

Calls cmake --build to build a project.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default CMake parameters. See CMakeBuildParams.
  • -
- - - -
- - - CMakeBuildDefaults - -
- Signature: CMakeBuildParams
-
-
- - - - -

The default option set given to CMakeBuild.

- - - -
- - - CMakeGenerateDefaults - -
- Signature: CMakeGenerateParams
-
-
- - - - -

The default option set given to CMakeGenerate.

- - - -
- - - Generate setParams - -
- Signature: setParams:(CMakeGenerateParams -> CMakeGenerateParams) -> unit
-
-
- - - - -

Calls cmake to generate a project.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default CMake parameters. See CMakeGenerateParams.
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-cmakesupport-cmakebuildparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-cmakesupport-cmakebuildparams.html deleted file mode 100644 index 9e65029..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-cmakesupport-cmakebuildparams.html +++ /dev/null @@ -1,239 +0,0 @@ - - - - - CMakeBuildParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

CMakeBuildParams

-
-

The CMakeBuild parameter type.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - AdditionalArgs - -
- Signature: string
-
-
- - - - -

A character string containing additional arguments to give to CMake.

- - - -
- - - BinaryDirectory - -
- Signature: string
-
-
- - - - -

The binary build directory where CMake will generate the files.

- - - -
- - - Config - -
- Signature: string
-
-
- - - - -

The build configuration to use (e.g. Release). -Equivalent to the --config <cfg> option. -Not supported by every generator.

- - - -
- - - Target - -
- Signature: string
-
-
- - - - -

The CMake target to build instead of the default one. -Equivalent to the --target <target> option.

- - - -
- - - Timeout - -
- Signature: TimeSpan
-
-
- - - - -

The CMake execution timeout.

- - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - -

The location of the CMake executable. Automatically found if null or empty.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-cmakesupport-cmakegenerateparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-cmakesupport-cmakegenerateparams.html deleted file mode 100644 index 714ad9f..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-cmakesupport-cmakegenerateparams.html +++ /dev/null @@ -1,395 +0,0 @@ - - - - - CMakeGenerateParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

CMakeGenerateParams

-
-

The CMakeGenerate parameter type.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - AdditionalArgs - -
- Signature: string
-
-
- - - - -

A character string containing additional arguments to give to CMake.

- - - -
- - - BinaryDirectory - -
- Signature: string
-
-
- - - - -

The binary build directory where CMake will generate the files.

- - - -
- - - CacheEntriesToRemove - -
- Signature: string list
-
-
- - - - -

Remove matching entries from CMake cache. -Equivalent to the -U <globbing_expr> options.

- - - -
- - - Caches - -
- Signature: string list
-
-
- - - - -

A list of the optional CMake cache files to load. -Equivalent to the -C <initial-cache> options.

- - - -
- - - Generator - -
- Signature: string
-
-
- - - - -

The native build system generator to use for writing the files. -See cmake --help for a list of the available entries. -To avoid unpredictable generator usage, it is recommended to define it. -Equivalent to the -G <generator-name> option.

- - - -
- - - InstallDirectory - -
- Signature: string
-
-
- - - - -

The directory where CMake will install the generated files. -Equivalent to the -D CMAKE_INSTALL_PREFIX:DIRPATH="<install-directory>" CMake option.

- - - -
- - - Platform - -
- Signature: string
-
-
- - - - -

An optional CMake platform. -Equivalent to the -A <platform-name> option. -Not supported by every generator.

- - - -
- - - SourceDirectory - -
- Signature: string
-
-
- - - - -

The source directory which should include a CMakeLists.txt file.

- - - -
- - - Timeout - -
- Signature: TimeSpan
-
-
- - - - -

The CMake execution timeout.

- - - -
- - - Toolchain - -
- Signature: string
-
-
- - - - -

An optional toolchain file to load. -Equivalent to the -D CMAKE_TOOLCHAIN_FILE:FILEPATH="<toolchain-file>" CMake option.

- - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - -

The location of the CMake executable. Automatically found if null or empty.

- - - -
- - - Toolset - -
- Signature: string
-
-
- - - - -

An optional toolset (!= toolchain) to use. -Equivalent to the -T <toolset-name> option. -Not supported by every generator.

- - - -
- - - Variables - -
- Signature: CMakeVariable list
-
-
- - - - -

A list of every variable to pass as a CMake argument. -Equivalent to the -D <var>:<type>=<value> options.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-cmakesupport-cmakevalue.html b/packages/FAKE.4.11.3/docs/apidocs/fake-cmakesupport-cmakevalue.html deleted file mode 100644 index 769f50b..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-cmakesupport-cmakevalue.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - CMakeValue - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

CMakeValue

-
-

The possible variable value types for CMake variables.

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - CMakeBoolean(bool) - -
- Signature: bool
-
-
- - - - - -
- - - CMakeDirPath(string) - -
- Signature: string
-
-
- - - - - -
- - - CMakeFilePath(string) - -
- Signature: string
-
-
- - - - - -
- - - CMakeString(string) - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-cmakesupport-cmakevariable.html b/packages/FAKE.4.11.3/docs/apidocs/fake-cmakesupport-cmakevariable.html deleted file mode 100644 index df39e7f..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-cmakesupport-cmakevariable.html +++ /dev/null @@ -1,154 +0,0 @@ - - - - - CMakeVariable - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

CMakeVariable

-
-

A CMake variable.

- - -
-

Record Fields

- - - - - - - - - - - - - - -
Record FieldDescription
- - - Name - -
- Signature: string
-
-
- - - - -

The name of the variable. -It cannot contains spaces and special characters.

- - - -
- - - Value - -
- Signature: CMakeValue
-
-
- - - - -

The value of the variable. -Will be automatically converted to the CMake format when required.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-configurationhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-configurationhelper.html deleted file mode 100644 index 1691e3c..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-configurationhelper.html +++ /dev/null @@ -1,370 +0,0 @@ - - - - - ConfigurationHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ConfigurationHelper

-
-

Contains functions which allow to read and write config files.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - applyXslOnConfig xsl fileName - -
- Signature: xsl:string -> fileName:string -> unit
-
-
- - - - -

Applies a Xsl Stylesheet to a config file and writes it back.

- -

Parameters

- -
    -
  • xsl - The Xsl stylesheet to apply.
  • -
  • fileName - The file name of the config file.
  • -
- -

Sample

- - - - -
1: 
-
applyXslOnConfig (navServicePath @@ DEV.xsl) (navServicePath @@ "CustomSettings.config")
-
- - - -
- - - readConfig fileName - -
- Signature: fileName:string -> XmlDocument
-
-
- - - - -

Reads a config file into an XmlDocument.

- -

Parameters

- -
    -
  • fileName - The file name of the config file.
  • -
- - - -
- - - updateApplicationSetting (...) - -
- Signature: fileName:string -> settingName:string -> value:string -> unit
-
-
- - - - -

Reads a config file from the given file name, replaces the Application Setting (as opposed to AppSetting) value and writes it back.

- -

Parameters

- -
    -
  • settingName - The ApplicationSetting name for which the value should be replaced.
  • -
  • value - The new ApplicationSetting value.
  • -
  • fileName - The file name of the config file.
  • -
- -

Sample

- - - - -
1: 
-
updateApplicationSetting "DatabaseName" targetDatabase (navServicePath @@ "CustomSettings.config")
-
- - - -
- - - updateAppSetting key value fileName - -
- Signature: key:string -> value:string -> fileName:string -> unit
-
-
- - - - -

Reads a config file from the given file name, replaces the app setting value and writes it back.

- -

Parameters

- -
    -
  • key - The AppSettings attribute key name for which the value should be replaced.
  • -
  • value - The new AppSettings attribute value.
  • -
  • fileName - The file name of the config file.
  • -
- -

Sample

- - - - -
1: 
-
updateAppSetting "DatabaseName" targetDatabase (navServicePath @@ "CustomSettings.config")
-
- - - -
- - - updateConfig (...) - -
- Signature: xpath:string -> attribute:string -> value:string -> config:XmlDocument -> XmlDocument
-
-
- - - - -

Reads a config file from the given file name, replaces an attribute using the given xPath and writes it back.

- -

Parameters

- -
    -
  • xpath - An XPath term which can be used to replace the attribute.
  • -
  • attribute - The attribute name for which the value should be replaced.
  • -
  • value - The new attribute value.
  • -
  • config - The XElement representing the config.
  • -
- - - -
- - - updateConfigSetting (...) - -
- Signature: fileName:string -> xpath:string -> attribute:string -> value:string -> unit
-
-
- - - - -

Reads a config file from the given file name, replaces an attribute using the given xPath and writes it back.

- -

Parameters

- -
    -
  • fileName - The file name of the config file.
  • -
  • xpath - An XPath term which can be used to replace the attribute.
  • -
  • attribute - The attribute name for which the value should be replaced.
  • -
  • value - The new attribute value.
  • -
- - - -
- - - updateConnectionString (...) - -
- Signature: connectionStringKey:string -> value:string -> fileName:string -> unit
-
-
- - - - -

Reads a config file from the given file name, replaces the connection string value and writes it back.

- -

Parameters

- -
    -
  • connectionStringKey - The connection string key name for which the value should be replaced.
  • -
  • value - The new connection string value.
  • -
  • fileName - The file name of the config file.
  • -
- - - -
- - - writeConfig fileName config - -
- Signature: fileName:string -> config:XmlDocument -> unit
-
-
- - - - -

Writes an XmlDocument to a config file.

- -

Parameters

- -
    -
  • fileName - The file name of the config file.
  • -
  • config - The XmlDocument representing the config.
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-cschelper-cscparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-cschelper-cscparams.html deleted file mode 100644 index 841379f..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-cschelper-cscparams.html +++ /dev/null @@ -1,286 +0,0 @@ - - - - - CscParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

CscParams

-
-

Compiler parameters

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Debug - -
- Signature: bool
-
-
- - - - -

Specifies whether to emit debug information (default is false).

- - - -
- - - OtherParams - -
- Signature: string list
-
-
- - - - -

Specifies other params for the compilation. Freeform strings.

- - - -
- - - Output - -
- Signature: string
-
-
- - - - -

Specifies the output file name and path.

- - - -
- - - Platform - -
- Signature: CscPlatform
-
-
- - - - -

Specifies the compiled artifact target platform.

- - - -
- - - References - -
- Signature: string list
-
-
- - - - -

Specifies assemblies to reference for the compilation.

- - - -
- - - Target - -
- Signature: CscTarget
-
-
- - - - -

Specifies the compiled artifact target type.

- - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - -

Specifies the tool path to csc.exe.

- - - -
-

Static members

- - - - - - - - - - -
Static memberDescription
- - - Default - -
- Signature: CscParams
-
-
- - - - -

The default parameters to the compiler.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-cschelper-cscplatform.html b/packages/FAKE.4.11.3/docs/apidocs/fake-cschelper-cscplatform.html deleted file mode 100644 index b6f3ae1..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-cschelper-cscplatform.html +++ /dev/null @@ -1,200 +0,0 @@ - - - - - CscPlatform - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

CscPlatform

-
-

Supported platforms

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - AnyCpu - -
- Signature:
-
-
- - - - - -
- - - AnyCpu32BitPreferred - -
- Signature:
-
-
- - - - - -
- - - Itanium - -
- Signature:
-
-
- - - - - -
- - - X64 - -
- Signature:
-
-
- - - - - -
- - - X86 - -
- Signature:
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-cschelper-csctarget.html b/packages/FAKE.4.11.3/docs/apidocs/fake-cschelper-csctarget.html deleted file mode 100644 index b263d12..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-cschelper-csctarget.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - CscTarget - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

CscTarget

-
-

Supported output types

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - Exe - -
- Signature:
-
-
- - - - - -
- - - Library - -
- Signature:
-
-
- - - - - -
- - - Module - -
- Signature:
-
-
- - - - - -
- - - Winexe - -
- Signature:
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-cschelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-cschelper.html deleted file mode 100644 index a6b6c71..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-cschelper.html +++ /dev/null @@ -1,263 +0,0 @@ - - - - - CscHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

CscHelper

-
-

Contains tasks to compile C# source files with CSC.EXE (C# Compiler).

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - -
TypeDescription
- CscParams -

Compiler parameters

- - -
- CscPlatform -

Supported platforms

- - -
- CscTarget -

Supported output types

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - csc setParams inputFiles - -
- Signature: setParams:(CscParams -> CscParams) -> inputFiles:string list -> int
-
-
- - - - -

Compiles the given C# source files with the specified parameters.

- -

Parameters

- -
    -
  • setParams - Function used to overwrite the default CSC parameters.
  • -
  • inputFiles - The C# input files.
  • -
- -

Returns

- -

The exit status code of the compile process.

- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-
["file1.cs"; "file2.cs"]
-|> csc (fun parameters ->
-         { parameters with Output = ...
-                           Target = ...
-                           ... })
-
- - - -
- - - Csc setParams inputFiles - -
- Signature: setParams:(CscParams -> CscParams) -> inputFiles:string list -> unit
-
-
- - - - -

Compiles one or more C# source files with the specified parameters.

- -

Parameters

- -
    -
  • setParams - Function used to overwrite the default CSC parameters.
  • -
  • inputFiles - The C# input files.
  • -
- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-
["file1.cs"; "file2.cs"]
-|> Csc (fun parameters ->
-              { parameters with Output = ...
-                                Target = ...
-                                ... })
-
- - - -
- - - cscExe toolPath srcFiles opts - -
- Signature: toolPath:string -> srcFiles:string list -> opts:string list -> int
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-docuhelper-docuparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-docuhelper-docuparams.html deleted file mode 100644 index 5233180..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-docuhelper-docuparams.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - DocuParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

DocuParams

-
-

The parameter type for docu.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - OutputPath - -
- Signature: string
-
-
- - - - -

The output path of the generated docs. The default is "./output/".

- - - -
- - - TemplatesPath - -
- Signature: string
-
-
- - - - -

The HTML templates for the generated docs.

- - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - -

Allows to specify a timeout for docu. The default is 5 minutes.

- - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - -

The tool path - FAKE tries to find docu.exe automatically in any sub folder.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-docuhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-docuhelper.html deleted file mode 100644 index 07de415..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-docuhelper.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - DocuHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

DocuHelper

-
-

Contains helper functions to run the XML documentation tool "docu".

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- DocuParams -

The parameter type for docu.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - Docu setParams assemblies - -
- Signature: setParams:(DocuParams -> DocuParams) -> assemblies:seq<string> -> unit
-
-
- - - - -

Generates a HTML documentation from XML docs via the docu.exe.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default docu parameters.
  • -
  • assemblies - Sequence of one or more assemblies containing the XML docs.
  • -
- - - -
- - - DocuDefaults - -
- Signature: DocuParams
-
-
- - - - -

The Docu default params

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-dotcover-dotcovermergeparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-dotcover-dotcovermergeparams.html deleted file mode 100644 index 31a6e4e..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-dotcover-dotcovermergeparams.html +++ /dev/null @@ -1,215 +0,0 @@ - - - - - DotCoverMergeParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

DotCoverMergeParams

-
-
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - CustomParameters - -
- Signature: string
-
-
- - - - - -
- - - Output - -
- Signature: string
-
-
- - - - - -
- - - Source - -
- Signature: string list
-
-
- - - - - -
- - - TempDir - -
- Signature: string
-
-
- - - - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-dotcover-dotcoverparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-dotcover-dotcoverparams.html deleted file mode 100644 index c82d3c4..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-dotcover-dotcoverparams.html +++ /dev/null @@ -1,290 +0,0 @@ - - - - - DotCoverParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

DotCoverParams

-
-

The dotCover parameter type for running coverage

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - AttributeFilters - -
- Signature: string
-
-
- - - - - -
- - - CustomParameters - -
- Signature: string
-
-
- - - - - -
- - - ErrorLevel - -
- Signature: TestRunnerErrorLevel
-
-
- - - - - -
- - - Filters - -
- Signature: string
-
-
- - - - - -
- - - Output - -
- Signature: string
-
-
- - - - - -
- - - TargetArguments - -
- Signature: string
-
-
- - - - - -
- - - TargetExecutable - -
- Signature: string
-
-
- - - - - -
- - - TargetWorkingDir - -
- Signature: string
-
-
- - - - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-dotcover-dotcoverreportparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-dotcover-dotcoverreportparams.html deleted file mode 100644 index a5d479a..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-dotcover-dotcoverreportparams.html +++ /dev/null @@ -1,215 +0,0 @@ - - - - - DotCoverReportParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

DotCoverReportParams

-
-
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - CustomParameters - -
- Signature: string
-
-
- - - - - -
- - - Output - -
- Signature: string
-
-
- - - - - -
- - - ReportType - -
- Signature: DotCoverReportType
-
-
- - - - - -
- - - Source - -
- Signature: string
-
-
- - - - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-dotcover-dotcoverreporttype.html b/packages/FAKE.4.11.3/docs/apidocs/fake-dotcover-dotcoverreporttype.html deleted file mode 100644 index 2b1b1d0..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-dotcover-dotcoverreporttype.html +++ /dev/null @@ -1,183 +0,0 @@ - - - - - DotCoverReportType - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

DotCoverReportType

-
-
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Html - -
- Signature: DotCoverReportType
- Modifiers: static
-
-
- - - - - -
- - - Json - -
- Signature: DotCoverReportType
- Modifiers: static
-
-
- - - - - -
- - - NDependXml - -
- Signature: DotCoverReportType
- Modifiers: static
-
-
- - - - - -
- - - Xml - -
- Signature: DotCoverReportType
- Modifiers: static
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-dotcover.html b/packages/FAKE.4.11.3/docs/apidocs/fake-dotcover.html deleted file mode 100644 index 0d1d635..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-dotcover.html +++ /dev/null @@ -1,590 +0,0 @@ - - - - - DotCover - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

DotCover

-
-

Contains a task which can be used to run DotCover on .NET assemblies.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- DotCoverMergeParams -
- DotCoverParams -

The dotCover parameter type for running coverage

- - -
- DotCoverReportParams -
- DotCoverReportType -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - buildDotCoverArgs parameters - -
- Signature: parameters:DotCoverParams -> string
-
-
- - - - - -
- - - buildDotCoverMergeArgs parameters - -
- Signature: parameters:DotCoverMergeParams -> string
-
-
- - - - - -
- - - buildDotCoverReportArgs parameters - -
- Signature: parameters:DotCoverReportParams -> string
-
-
- - - - - -
- - - buildParamsAndExecute (...) - -
- Signature: parameters:'?10467 -> buildArguments:('?10467 -> string) -> toolPath:string -> workingDir:string -> failBuild:bool -> unit
- Type parameters: '?10467
-
- - - - - -
- - - DotCover setParams - -
- Signature: setParams:(DotCoverParams -> DotCoverParams) -> unit
-
-
- - - - -

Runs the dotCover "cover" command, using a target executable (such as NUnit or MSpec) and generates a snapshot file.

- -

Parameters

- -
    -
  • setParams - Function used to overwrite the dotCover default parameters.
  • -
- - - -
- - - DotCoverDefaults - -
- Signature: DotCoverParams
-
-
- - - - -

The dotCover default parameters

- - - -
- - - DotCoverMerge setParams - -
- Signature: setParams:(DotCoverMergeParams -> DotCoverMergeParams) -> unit
-
-
- - - - -

Runs the dotCover "merge" command. This combines dotCover snaphots into a single -snapshot, enabling you to merge test coverage from multiple test running frameworks

- -

Parameters

- -
    -
  • setParams - Function used to overwrite the dotCover merge default parameters.
  • -
- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-
DotCoverMerge (fun p -> { p with 
-                    Source = [artifactsDir @@ "NUnitDotCoverSnapshot.dcvr"
-                              artifactsDir @@ "MSpecDotCoverSnapshot.dcvr"]
-                    Output = artifactsDir @@ "dotCoverSnapshot.dcvr" }) 
-
- - - -
- - - DotCoverMergeDefaults - -
- Signature: DotCoverMergeParams
-
-
- - - - - -
- - - DotCoverMSpec (...) - -
- Signature: setDotCoverParams:(DotCoverParams -> DotCoverParams) -> setMSpecParams:(MSpecParams -> MSpecParams) -> assemblies:seq<string> -> unit
-
-
- - - - -

Runs the dotCover "cover" command against the MSpec test runner.

- -

Parameters

- -
    -
  • setDotCoverParams - Function used to overwrite the dotCover report default parameters.
  • -
  • setMSpecParams - Function used to overwrite the MSpec default parameters.
  • -
- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-
!! (buildDir @@ buildMode @@ "/*.Unit.Tests.dll") 
-    |> DotCoverMSpec 
-        (fun dotCoverOptions -> { dotCoverOptions with 
-                Output = artifactsDir @@ "MSpecDotCoverSnapshot.dcvr" }) 
-        (fun mSpecOptions -> { mSpecOptions with
-                Silent = true })
-
- - - -
- - - DotCoverMSTest (...) - -
- Signature: setDotCoverParams:(DotCoverParams -> DotCoverParams) -> setMSTestParams:(MSTestParams -> MSTestParams) -> assemblies:seq<string> -> unit
-
-
- - - - -

Runs the dotCover "cover" command against the MSTest test runner.

- -

Parameters

- -
    -
  • setDotCoverParams - Function used to overwrite the dotCover report default parameters.
  • -
  • setMSTestParams - Function used to overwrite the MSTest default parameters.
  • -
- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-
!! (buildDir @@ buildMode @@ "/*.Unit.Tests.dll") 
-    |> MSTest 
-        (fun  -> dotCoverOptions )
-        (fun MSTestOptions -> MSTestOptions) 
-
- - - -
- - - DotCoverNUnit (...) - -
- Signature: setDotCoverParams:(DotCoverParams -> DotCoverParams) -> setNUnitParams:(NUnitParams -> NUnitParams) -> assemblies:seq<string> -> unit
-
-
- - - - -

Runs the dotCover "cover" command against the NUnit test runner.

- -

Parameters

- -
    -
  • setDotCoverParams - Function used to overwrite the dotCover report default parameters.
  • -
  • setNUnitParams - Function used to overwrite the NUnit default parameters.
  • -
- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-
!! (buildDir @@ buildMode @@ "/*.Unit.Tests.dll") 
-    |> DotCoverNUnit 
-        (fun dotCoverOptions -> { dotCoverOptions with 
-                Output = artifactsDir @@ "NUnitDotCoverSnapshot.dcvr" }) 
-        (fun nUnitOptions -> { nUnitOptions with
-                DisableShadowCopy = true })
-
- - - -
- - - DotCoverReport setParams - -
- Signature: setParams:(DotCoverReportParams -> DotCoverReportParams) -> bool -> unit
-
-
- - - - -

Runs the dotCover "report" command. This generates a report from a dotCover snapshot

- -

Parameters

- -
    -
  • setParams - Function used to overwrite the dotCover report default parameters.
  • -
- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-
DotCoverReport (fun p -> { p with 
-                    Source = artifactsDir @@ "dotCoverSnapshot.dcvr"
-                    Output = artifactsDir @@ "dotCoverReport.xml"
-                    ReportType = DotCoverReportType.Xml })
-
- - - -
- - - DotCoverReportDefaults - -
- Signature: DotCoverReportParams
-
-
- - - - - -
- - - DotCoverXUnit2 (...) - -
- Signature: setDotCoverParams:(DotCoverParams -> DotCoverParams) -> setXUnit2Params:(XUnit2Params -> XUnit2Params) -> assemblies:seq<string> -> unit
-
-
- - - - -

Runs the dotCover "cover" command against the XUnit2 test runner.

- -

Parameters

- -
    -
  • setDotCoverParams - Function used to overwrite the dotCover report default parameters.
  • -
  • setXUnit2Params - Function used to overwrite the XUnit2 default parameters.
  • -
- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-
!! (buildDir @@ buildMode @@ "/*.Unit.Tests.dll") 
-    |> DotCoverXUnit2 
-        (fun  -> dotCoverOptions )
-        (fun nUnitOptions -> nUnitOptions) 
-
- - - -
- - - getWorkingDir workingDir - -
- Signature: workingDir:string -> string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicscrmhelper-dynamicscrmhelperparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicscrmhelper-dynamicscrmhelperparams.html deleted file mode 100644 index 29860e1..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicscrmhelper-dynamicscrmhelperparams.html +++ /dev/null @@ -1,341 +0,0 @@ - - - - - DynamicsCrmHelperParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

DynamicsCrmHelperParams

-
-

Parameters for executing Dynamics CRM Helper functions

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - AllOrganizations - -
- Signature: bool
-
-
- - - - -

Export all solutions for all organizations that the current user has access to. Be sure to pass discovery service url for URL parameter

- - - -
- - - AllSolutions - -
- Signature: bool
-
-
- - - - -

Export all solutions for given organization

- - - -
- - - FileName - -
- Signature: string
-
-
- - - - -

Set for specifying output file name when exporting solution or input solution name when importing

- - - -
- - - Managed - -
- Signature: bool
-
-
- - - - -

Specify, whether solution should be exported as managed or unmanaged

- - - -
- - - Password - -
- Signature: string
-
-
- - - - -

Password of user that should be used to connect to the CRM Organization. Leave blank to use default credentials

- - - -
- - - Solution - -
- Signature: string
-
-
- - - - -

Set for specifying unique name of solution when exporting single solution

- - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - -

TimeOut for each function. Set to a higher value, i.e. 60 minutes if using AllOrganizations

- - - -
- - - ToolDirectory - -
- Signature: string
-
-
- - - - -

Tool Directory where Solution Exchanger is stored

- - - -
- - - Url - -
- Signature: string
-
-
- - - - -

Url of CRM Organization / Discovery Service URL if using AllOrganizations

- - - -
- - - User - -
- Signature: string
-
-
- - - - -

Username of user that should be used to connect to the CRM Organization. Leave blank to use default credentials

- - - -
- - - WorkingDirectory - -
- Signature: string
-
-
- - - - -

Working Directory for actions, can be used to influence storage locations of files

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicscrmhelper-packagetype.html b/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicscrmhelper-packagetype.html deleted file mode 100644 index 4761aac..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicscrmhelper-packagetype.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - PackageType - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

PackageType

-
-

Specify Package Type for usage with Solution Packager

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - Both - -
- Signature:
-
-
- - - - - -
- - - Managed - -
- Signature:
-
-
- - - - - -
- - - Unmanaged - -
- Signature:
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicscrmhelper-solutionpackageraction.html b/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicscrmhelper-solutionpackageraction.html deleted file mode 100644 index a55a86a..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicscrmhelper-solutionpackageraction.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - SolutionPackagerAction - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicscrmhelper-solutionpackagerparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicscrmhelper-solutionpackagerparams.html deleted file mode 100644 index 095d185..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicscrmhelper-solutionpackagerparams.html +++ /dev/null @@ -1,257 +0,0 @@ - - - - - SolutionPackagerParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

SolutionPackagerParams

-
-

Parameters for invoking Solution Packager

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Action - -
- Signature: SolutionPackagerAction
-
-
- - - - -

Action to start, either pack or extract

- - - -
- - - Folder - -
- Signature: string
-
-
- - - - -

Folder for output of calls

- - - -
- - - PackageType - -
- Signature: PackageType
-
-
- - - - -

PackageType for packing solution, either managed, unmanaged or both

- - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - -

Timeout for calls

- - - -
- - - ToolDirectory - -
- Signature: string
-
-
- - - - -

Directory where SolutionPackager can be found

- - - -
- - - WorkingDirectory - -
- Signature: string
-
-
- - - - -

Working Directory for calls

- - - -
- - - ZipFile - -
- Signature: string
-
-
- - - - -

Path to solution that should be packed or extracted

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicscrmhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicscrmhelper.html deleted file mode 100644 index 57bd62e..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicscrmhelper.html +++ /dev/null @@ -1,361 +0,0 @@ - - - - - DynamicsCRMHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

DynamicsCRMHelper

-
-
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- DynamicsCrmHelperParams -

Parameters for executing Dynamics CRM Helper functions

- - -
- PackageType -

Specify Package Type for usage with Solution Packager

- - -
- SolutionPackagerAction -

Specify which action Solution Packager should be invoked with

- - -
- SolutionPackagerParams -

Parameters for invoking Solution Packager

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - DynamicsCrmHelperDefaults - -
- Signature: DynamicsCrmHelperParams
-
-
- - - - -

Default values for Dynamics CRM Helper -You can obtain the solution exchanger as NuGet Package "Dynamics.CRM.SolutionExchanger"

- - - -
- - - ExportSolution setParams - -
- Signature: setParams:(DynamicsCrmHelperParams -> DynamicsCrmHelperParams) -> unit
-
-
- - - - -

Exports solution from Dynamics CRM and save it to file

- -

Parameters

- -
    -
  • setParams - Parameters for invoking solution exchanger

    -

    Sample

    -

    // This Target will get all solutions of all organizations that the executing user has access to, export them as unmanaged and extract them using Solution Packager. -// Extracted solutions are stored in a folder named according to the name of the organization they were exported from. -Target "SaveAndUnzipAllSolutions" (fun _ -> -CreateDir solutions

    - - - -
     1: 
    - 2: 
    - 3: 
    - 4: 
    - 5: 
    - 6: 
    - 7: 
    - 8: 
    - 9: 
    -10: 
    -11: 
    -12: 
    -13: 
    -14: 
    -15: 
    -16: 
    -17: 
    -18: 
    -19: 
    -20: 
    -21: 
    -
         ExportSolution(fun f -> 
    -                     {f with 
    -                         Url = "http://YourOrganizationDiscoveryService"
    -                         Managed = false
    -                         AllOrganizations = true
    -                         WorkingDirectory = solutions
    -                         TimeOut = TimeSpan.FromMinutes 60.0
    -                     })
    -
    -     !!(solutions @@ @"\**\*.zip")
    -       |> Seq.iter(fun solution -> 
    -                     let dir = DirectoryInfo(solution)                    
    -
    -                     SolutionPackager (fun f ->
    -                         {f with 
    -                             Action = Extract
    -                             ZipFile = solution
    -                             PackageType = Unmanaged
    -                             Folder = extractedDir @@ dir.Parent.Name @@ (Path.GetFileName solution).Replace(".zip", "")
    -                             ToolDirectory = @".\tools\SolutionPackager\"
    -                         }))
    -
    -

    )

  • -
- -
module Seq

from Microsoft.FSharp.Collections
-
val iter : action:('T -> unit) -> source:seq<'T> -> unit

Full name: Microsoft.FSharp.Collections.Seq.iter
-
val solution : obj
-
val dir : 'a
- - -
- - - ImportSolution setParams - -
- Signature: setParams:(DynamicsCrmHelperParams -> DynamicsCrmHelperParams) -> unit
-
-
- - - - -

Imports zipped solution file to Dynamics CRM

- -

Parameters

- -
    -
  • setParams - Parameters for invoking solution exchanger
  • -
- - - -
- - - PublishAll setParams - -
- Signature: setParams:(DynamicsCrmHelperParams -> DynamicsCrmHelperParams) -> unit
-
-
- - - - -

Publishes all solution component changes.

- -

Parameters

- -
    -
  • setParams - Parameters for invoking solution exchanger
  • -
- - - -
- - - SolutionPackager setParams - -
- Signature: setParams:(SolutionPackagerParams -> SolutionPackagerParams) -> unit
-
-
- - - - -

Runs the solution packager tool on the given file for extracting the zip file or packing the extracted XML representation of a solution to a zip file again

- -

Parameters

- -
    -
  • setParams - Parameters for invoking solution packager
  • -
- - - -
- - - SolutionPackagerDefaults - -
- Signature: SolutionPackagerParams
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicsnav-dynamicsnavparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicsnav-dynamicsnavparams.html deleted file mode 100644 index 473c7ae..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicsnav-dynamicsnavparams.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - DynamicsNavParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

DynamicsNavParams

-
-

A parameter type to interact with Dynamics NAV

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Database - -
- Signature: string
-
-
- - - - - -
- - - ServerName - -
- Signature: string
-
-
- - - - - -
- - - TempLogFile - -
- Signature: string
-
-
- - - - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicsnav-navisionservertype.html b/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicsnav-navisionservertype.html deleted file mode 100644 index 37f257d..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicsnav-navisionservertype.html +++ /dev/null @@ -1,172 +0,0 @@ - - - - - NavisionServerType - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NavisionServerType

-
-

A Dynamics NAV server type

- - -
-

Union Cases

- - - - - - - - - - - - - - -
Union CaseDescription
- - - NativeServer - -
- Signature:
-
-
- - - - - -
- - - SqlServer - -
- Signature:
-
-
- - - - - -
-

Instance members

- - - - - - - - - - -
Instance memberDescription
- - - ToTypeString() - -
- Signature: unit -> string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicsnav-replacements.html b/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicsnav-replacements.html deleted file mode 100644 index d75e540..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicsnav-replacements.html +++ /dev/null @@ -1,254 +0,0 @@ - - - - - Replacements - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Replacements

-
-
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - ConvertFileFromWin7ToWin8 fileName - -
- Signature: fileName:string -> unit
-
-
- - - - - -
- - - isWin8 - -
- Signature: bool
-
-
- - - - - -
- - - NormalizeShortcuts fileName - -
- Signature: fileName:string -> unit
-
-
- - - - - -
- - - replaceShortcuts s - -
- Signature: s:string -> string
-
-
- - - - - -
- - - shortcutReplacements - -
- Signature: (string * string) list
-
-
- - - - - -
- - - Win7ToWin8 s - -
- Signature: s:string -> string
-
-
- - - - - -
- - - win8Replacements - -
- Signature: (string * string) list
-
-
- - - - - -
- - - Win8ToWin7 s - -
- Signature: s:string -> string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicsnav-rtcparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicsnav-rtcparams.html deleted file mode 100644 index 2cf8d97..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicsnav-rtcparams.html +++ /dev/null @@ -1,254 +0,0 @@ - - - - - RTCParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

RTCParams

-
-

The parameter type allows to interact with Dynamics NAV RTC.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Company - -
- Signature: string
-
-
- - - - - -
- - - Port - -
- Signature: int
-
-
- - - - - -
- - - ServerName - -
- Signature: string
-
-
- - - - - -
- - - ServiceTierName - -
- Signature: string
-
-
- - - - - -
- - - TempLogFile - -
- Signature: string
-
-
- - - - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicsnav.html b/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicsnav.html deleted file mode 100644 index 86dd723..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicsnav.html +++ /dev/null @@ -1,583 +0,0 @@ - - - - - DynamicsNav - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

DynamicsNav

-
-

Contains helper function which allow to interact with Microsoft Dynamics NAV.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - -
TypeDescription
- DynamicsNavParams -

A parameter type to interact with Dynamics NAV

- - -
- NavisionServerType -

A Dynamics NAV server type

- - -
- RTCParams -

The parameter type allows to interact with Dynamics NAV RTC.

- - -
- - - - - - - - - - -
ModuleDescription
- Replacements -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - analyzeTestResults fileName - -
- Signature: fileName:string -> TestResults option
-
-
- - - - -

Analyzes the Dynamics NAV test results

- - - -
- - - analyzeXmlTestResults fileName testSuite - -
- Signature: fileName:string -> testSuite:string -> TestResults option
-
-
- - - - -

Analyzes the XML-based Dynamics NAV test results from XMLPort 130021

- - - -
- - - CloseAllNavProcesses (...) - -
- Signature: raiseExceptionIfNotFound:bool -> unit
-
-
- - - - -

Closes all running Dynamics NAV instances

- - - -
- - - CompileAll connectionInfo - -
- Signature: connectionInfo:DynamicsNavParams -> unit
-
-
- - - - -

Compiles all uncompiled objects in the Dynamics NAV client.

- - - -
- - - createConnectionInfo (...) - -
- Signature: navClientVersion:string -> serverMode:NavisionServerType -> serverName:string -> targetDatabase:string -> DynamicsNavParams
-
-
- - - - -

Creates the connection information to a Dynamics NAV instance.

- - - -
- - - CreateImportFile importFileName files - -
- Signature: importFileName:string -> files:seq<string> -> unit
-
-
- - - - -

Creates an import file from the given .txt files.

- - - -
- - - createRTCConnectionInfo (...) - -
- Signature: navClientVersion:string -> serverName:string -> serviceTierName:string -> port:int -> company:string -> RTCParams
-
-
- - - - -

Creates the connection information to a Dynamics NAV RTC instance

- - - -
- - - ensureAllNAVProcessesHaveStopped timeout - -
- Signature: timeout:TimeSpan -> unit
-
-
- - - - -

Waits until all NAV processes have stopped or fails after given timeout.

- -

Parameters

- -
    -
  • name - The name of the processes in question.
  • -
  • timeout - The timespan to time out after.
  • -
- - - -
- - - ExportAllObjects connectionInfo fileName - -
- Signature: connectionInfo:DynamicsNavParams -> fileName:string -> unit
-
-
- - - - -

Exports all objects from the Dynamics NAV client to the given .txt or .fob file

- - - -
- - - ExportObjects (...) - -
- Signature: connectionInfo:DynamicsNavParams -> filter:string -> fileName:string -> unit
-
-
- - - - -

Exports objects from the Dynamics NAV client based on the given filter to the given .txt or .fob file

- - - -
- - - getNAVClassicPath navClientVersion - -
- Signature: navClientVersion:string -> string
-
-
- - - - -

Retrieves the the file name of the Dynamics NAV ClassicClient for the given version from the registry.

- - - -
- - - getNAVPath navClientVersion - -
- Signature: navClientVersion:string -> string
-
-
- - - - -

Gets the directory of the Dynamics NAV ClassicClient for the given version from the registry.

- - - -
- - - getNAVProcesses () - -
- Signature: unit -> seq<Process>
-
-
- - - - -

Returns all running NAV processes.

- - - -
- - - getNAVServicePath navClientVersion - -
- Signature: navClientVersion:string -> string
-
-
- - - - - -
- - - ImportFile connectionInfo fileName - -
- Signature: connectionInfo:DynamicsNavParams -> fileName:string -> unit
-
-
- - - - -

Imports the given .txt or .fob file into the Dynamics NAV client

- - - -
- - - ImportFiles (...) - -
- Signature: connectionInfo:DynamicsNavParams -> importFileName:string -> files:seq<string> -> unit
-
-
- - - - -

Creates an import file from the given .txt files and imports it into the Dynamics NAV client. -If the import fails, then every file will be tried alone.

- - - -
- - - OpenPage connectionInfo pageNo - -
- Signature: connectionInfo:RTCParams -> pageNo:int -> bool
-
-
- - - - -

Opens a page with the given ID on the RTC client

- - - -
- - - RunCodeunit connectionInfo codeunitID - -
- Signature: connectionInfo:RTCParams -> codeunitID:int -> unit
-
-
- - - - -

Runs a codeunit with the given ID on the RTC client

- - - -
- - - StartNavServiceTier (...) - -
- Signature: serverMode:NavisionServerType -> navClientVersion:string -> unit
-
-
- - - - - -
- - - StopNavServiceTier (...) - -
- Signature: serverMode:NavisionServerType -> navClientVersion:'?10362 -> unit
- Type parameters: '?10362
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicsnavfile-navobject.html b/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicsnavfile-navobject.html deleted file mode 100644 index 47f08f8..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicsnavfile-navobject.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - NavObject - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NavObject

-
-

A type definition of a Dynamics NAV object.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Id - -
- Signature: int
-
-
- - - - - -
- - - Name - -
- Signature: string
-
-
- - - - - -
- - - Source - -
- Signature: string
-
-
- - - - - -
- - - Type - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicsnavfile.html b/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicsnavfile.html deleted file mode 100644 index 38b6cb5..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-dynamicsnavfile.html +++ /dev/null @@ -1,720 +0,0 @@ - - - - - DynamicsNavFile - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

DynamicsNavFile

-
-

Provides an abstraction over Dynamics NAV object files.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- NavObject -

A type definition of a Dynamics NAV object.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - checkTagsInFile (...) - -
- Signature: requiredTags:seq<string> -> acceptPreTagged:bool -> invalidTags:seq<string> -> fileName:string -> string * string
-
-
- - - - -

Checks a Dynamics NAV file for missing required and invalid tags and raises this as errors

- - - -
- - - checkTagsInObjectString (...) - -
- Signature: requiredTags:seq<string> -> acceptPreTagged:bool -> invalidTags:seq<string> -> objectString:string -> name:string -> string * string
-
-
- - - - -

Checks a Dynamics NAV object for missing required and invalid tags and raises this as errors

- - - -
- - - DateRegex - -
- Signature: Regex
-
-
- - - - -

A Regex which allows to retrieve modified date.

- - - -
- - - fileNameFromObject (...) - -
- Signature: (navObject:NavObject * fileEnding:string) -> string
-
-
- - - - -

Returns a standardized filename based on the given NavObject.

- - - -
- - - getHighestTagVersionInFiles (...) - -
- Signature: versionTag:string -> fileNames:seq<string> -> string
-
-
- - - - -

Gets the highest version number for a specified version tag in a number of Dynamics NAV objects in a set of object files

- - - -
- - - getHighestTagVersionInObjects (...) - -
- Signature: versionTag:string -> sourceCode:string -> string
-
-
- - - - -

Gets the highest version number for a specified version tag in a number of Dynamics NAV objects

- - - -
- - - getInvalidTags invalidTags versionTags - -
- Signature: invalidTags:seq<string> -> versionTags:seq<string> -> seq<string>
-
-
- - - - -

Get all invalid tags from a Dynamics NAV version tag list

- - - -
- - - getMissingRequiredTags (...) - -
- Signature: requiredTags:seq<string> -> versionTags:seq<string> -> seq<string>
-
-
- - - - -

Get all missing required tags from a Dynamics NAV version tag list

- - - -
- - - getTagVersionInObject (...) - -
- Signature: versionTag:string -> sourceCode:string -> string
-
-
- - - - -

Gets the version number for the specified version tag in a Dynamics NAV object

- - - -
- - - getTagVersionInVersionTagList (...) - -
- Signature: versionTag:string -> tagList:string -> string
-
-
- - - - -

Gets the version number for the specified version tag in a Dynamics NAV version tag list

- - - -
- - - getVersionTagList text - -
- Signature: text:string -> string
-
-
- - - - -

Returns the version tag list from Dynamics NAV object.

- - - -
- - - ModifiedRegex - -
- Signature: Regex
-
-
- - - - -

A Regex which allows to retrieve the modified flag.

- - - -
- - - modifyNavisionFiles (...) - -
- Signature: requiredTags:seq<string> -> acceptPreTagged:bool -> invalidTags:seq<string> -> versionTag:string -> newVersion:string -> removeModified:bool -> newDateTime:DateTime -> fileNames:seq<string> -> unit
-
-
- - - - -

Checks a Dynamics NAV object for missing required and invalid tags and raises this as errors. -It also changes the given tag, resets the modified flag and time stamp.

- - - -
- - - NavObjectDateFormat - -
- Signature: string
-
-
- - - - -

A NAV culture-specific date format.

- - - -
- - - ObjectRegex - -
- Signature: Regex
-
-
- - - - -

A Regex which allows to parse objects in a Dynamics NAV file.

- - - -
- - - objectsInObjectString text - -
- Signature: text:string -> NavObject list
-
-
- - - - -

Splits an object string into multiple Dynamics NAV objects of type NavObject.

- - - -
- - - ObjectSplitRegex - -
- Signature: Regex
-
-
- - - - -

A Regex which allows to find objects in a Dynamics NAV file.

- - - -
- - - removeModifiedFlag text - -
- Signature: text:string -> string
-
-
- - - - -

Removes the modified flag from a Dynamics NAV object.

- - - -
- - - replaceDateTimeInString dateTime text - -
- Signature: dateTime:DateTime -> text:string -> string
-
-
- - - - -

Replaces the timestamp in a Dynamics NAV object.

- - - -
- - - replaceDateTimeInStringWithFormat (...) - -
- Signature: dateTime:DateTime -> dateFormat:string -> text:string -> string
-
-
- - - - - -
- - - replaceInVersionTag (...) - -
- Signature: versionTag:string -> newVersion:string -> tagList:string -> string
-
-
- - - - -

Replaces a version tag in a version tag list from Dynamics NAV object

- - - -
- - - replaceVersionTag (...) - -
- Signature: versionTag:string -> newVersion:string -> sourceCode:string -> string
-
-
- - - - -

Replaces a version tag in a Dynamics NAV

- - - -
- - - replaceVersionTagList text newTags - -
- Signature: text:string -> newTags:string -> string
-
-
- - - - -

Replaces a version tag list from a complete Dynamics NAV object with a new version tag list

- - - -
- - - setVersionTags (...) - -
- Signature: requiredTags:seq<string> -> acceptPreTagged:bool -> invalidTags:seq<string> -> versionTag:string -> newVersion:string -> removeModifiedFlag:bool -> newDateTime:DateTime -> fileNames:seq<string> -> unit
-
-
- - - - -

Checks a Dynamics NAV object for missing required and invalid tags and raises this as errors. -It also changes the given tag, resets the modified flag and time stamp.

- - - -
- - - splitNavisionFiles fileNames destDir - -
- Signature: fileNames:seq<string> -> destDir:string -> unit
-
-
- - - - -

Splits the given files into individual object files in the specified destination directory.

- - - -
- - - splitVersionTags tagList - -
- Signature: tagList:string -> string []
-
-
- - - - -

Splits a version tag list from Dynamics NAV object into single tags

- - - -
- - - TimeRegex - -
- Signature: Regex
-
-
- - - - -

A Regex which allows to retrieve the modified time.

- - - -
- - - VersionRegex - -
- Signature: Regex
-
-
- - - - -

A Regex which allows to retrieve the version list.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-environmenthelper-environtarget.html b/packages/FAKE.4.11.3/docs/apidocs/fake-environmenthelper-environtarget.html deleted file mode 100644 index 1c86c4e..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-environmenthelper-environtarget.html +++ /dev/null @@ -1,102 +0,0 @@ - - - - - EnvironTarget - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-environmenthelper-machinedetails.html b/packages/FAKE.4.11.3/docs/apidocs/fake-environmenthelper-machinedetails.html deleted file mode 100644 index 8bf0a79..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-environmenthelper-machinedetails.html +++ /dev/null @@ -1,254 +0,0 @@ - - - - - MachineDetails - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MachineDetails

-
-

A record which allows to display lots of machine specific information like machine name, processor count etc.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - AgentVersion - -
- Signature: string
-
-
- - - - - -
- - - DriveInfo - -
- Signature: seq<string>
-
-
- - - - - -
- - - Is64bit - -
- Signature: bool
-
-
- - - - - -
- - - MachineName - -
- Signature: string
-
-
- - - - - -
- - - NETFrameworks - -
- Signature: seq<string>
-
-
- - - - - -
- - - OperatingSystem - -
- Signature: string
-
-
- - - - - -
- - - ProcessorCount - -
- Signature: int
-
-
- - - - - -
- - - UserDomainName - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-environmenthelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-environmenthelper.html deleted file mode 100644 index 4af31e5..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-environmenthelper.html +++ /dev/null @@ -1,1016 +0,0 @@ - - - - - EnvironmentHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

EnvironmentHelper

-
-

This module contains functions which allow to read and write environment variables and build parameters

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - -
TypeDescription
- EnvironTarget -

Type alias for System.EnvironmentVariableTarget

- - -
- MachineDetails -

A record which allows to display lots of machine specific information like machine name, processor count etc.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - ( @@ ) path1 path2 - -
- Signature: path1:string -> path2:string -> string
-
-
- - - - -

Combines two path strings using Path.Combine

- - - -
- - - ( </> ) path1 path2 - -
- Signature: path1:string -> path2:string -> string
-
-
- - - - - -
- - - appSetting name - -
- Signature: name:string -> string
-
-
- - - - -

Retrieves the application settings variable with the given name

- - - -
- - - clearProcessEnvironVar name - -
- Signature: name:string -> unit
-
-
- - - - -

Clears the environment variable with the given name for the current process.

- - - -
- - - combinePaths path1 path2 - -
- Signature: path1:string -> path2:string -> string
-
-
- - - - -

Combines two path strings using Path.Combine

- - - -
- - - combinePathsNoTrim path1 path2 - -
- Signature: path1:string -> path2:string -> string
-
-
- - - - - -
- - - convertWindowsToCurrentPath windowsPath - -
- Signature: windowsPath:string -> string
-
-
- - - - -

Convert the given windows path to a path in the current system

- - - -
- - - directorySeparator - -
- Signature: string
-
-
- - - - -

The directory separator string. On most systems / or \

- - - -
- - - documentsFolder - -
- Signature: string
-
-
- - - - -

The path to the personal documents

- - - -
- - - encoding - -
- Signature: Encoding
-
-
- - - - -

Contains the IO encoding which is given via build parameter "encoding" or the default encoding if no encoding was specified.

- - - -
- - - environVar name - -
- Signature: name:string -> string
-
-
- - - - -

Retrieves the environment variable with the given name

- - - -
- - - environVarOrDefault name defaultValue - -
- Signature: name:string -> defaultValue:string -> string
-
-
- - - - -

Retrieves the environment variable with the given name or returns the default if no value was set

- - - -
- - - environVarOrFail name - -
- Signature: name:string -> string
-
-
- - - - -

Retrieves the environment variable with the given name or fails if not found

- - - -
- - - environVarOrNone name - -
- Signature: name:string -> string option
-
-
- - - - -

Retrieves the environment variable or None

- - - -
- - - environVars target - -
- Signature: target:EnvironmentVariableTarget -> (obj * obj) list
-
-
- - - - -

Retrieves all environment variables from the given target

- - - -
- - - getBuildParam name - -
- Signature: name:string -> string
-
-
- - - - -

Returns the value of the build parameter with the given name if it was set and otherwise an empty string

- - - -
- - - getBuildParamOrDefault name defaultParam - -
- Signature: name:string -> defaultParam:string -> string
-
-
- - - - -

Returns the value of the build parameter with the given name if it was set and otherwise the given default value

- - - -
- - - getDrivesInfo () - -
- Signature: unit -> seq<string>
-
-
- - - - -

Retrieves information about the hard drives

- - - -
- - - getEnvironmentVarAsBool varName - -
- Signature: varName:string -> bool
-
-
- - - - -

Retrieves the environment variable with the given name or returns the false if no value was set

- - - -
- - - getEnvironmentVarAsBoolOrDefault (...) - -
- Signature: varName:string -> defaultValue:bool -> bool
-
-
- - - - -

Retrieves the environment variable with the given name or returns the default bool if no value was set

- - - -
- - - getInstalledDotNetFrameworks () - -
- Signature: unit -> seq<string>
-
-
- - - - -

Returns a sequence with all installed .NET framework versions

- - - -
- - - getMachineEnvironment () - -
- Signature: unit -> MachineDetails
-
-
- - - - -

Retrieves lots of machine specific information like machine name, processor count etc.

- - - -
- - - getNewestTool possibleToolPaths - -
- Signature: possibleToolPaths:seq<'?10249> -> '?10249
- Type parameters: '?10249
-
- - - - -

Helper function to help find framework or sdk tools from the -newest toolkit available

- - - -
- - - getTargetPlatformDir platformVersion - -
- Signature: platformVersion:string -> string
-
-
- - - - -

Gets the local directory for the given target platform

- - - -
- - - hasBuildParam name - -
- Signature: name:string -> bool
-
-
- - - - -

Returns if the build parameter with the given name was set

- - - -
- - - isLinux - -
- Signature: bool
-
-
- - - - -

Determines if the current system is a Linux system

- - - -
- - - isMacOS - -
- Signature: bool
-
-
- - - - -

Determines if the current system is a MacOs system

- - - -
- - - isMono - -
- Signature: bool
-
-
- - - - -

Determines if the current system is a mono system -Todo: Detect mono on windows

- - - -
- - - isUnix - -
- Signature: bool
-
-
- - - - -

Determines if the current system is an Unix system

- - - -
- - - monoArguments - -
- Signature: string
-
-
- - - - -

Arguments on the Mono executable

- - - -
- - - monoPath - -
- Signature: string
-
-
- - - - - -
- - - normalizePath path - -
- Signature: path:string -> string
-
-
- - - - - -
- - - platformInfoAction psi - -
- Signature: psi:ProcessStartInfo -> unit
-
-
- - - - -

Modifies the ProcessStartInfo according to the platform semantics

- - - -
- - - ProgramFiles - -
- Signature: string
-
-
- - - - -

The path of the "Program Files" folder - might be x64 on x64 machine

- - - -
- - - ProgramFilesX86 - -
- Signature: string
-
-
- - - - -

The path of Program Files (x86) -It seems this covers all cases where PROCESSOR_ARCHITECTURE may misreport and the case where the other variable -PROCESSOR_ARCHITEW6432 can be null

- - - -
- - - sdkBasePath - -
- Signature: string
-
-
- - - - -

Base path for getting tools from windows SDKs

- - - -
- - - setBuildParam name value - -
- Signature: name:string -> value:string -> unit
-
-
- - - - -

Sets the build parameter with the given name for the current process.

- - - -
- - - setEnvironVar name value - -
- Signature: name:string -> value:string -> unit
-
-
- - - - -

Sets the environment variable with the given name

- - - -
- - - setProcessEnvironVar name value - -
- Signature: name:string -> value:string -> unit
-
-
- - - - -

Sets the environment variable with the given name for the current process.

- - - -
- - - splitEnvironVar name - -
- Signature: name:string -> string list
-
-
- - - - -

Splits the entries of an environment variable and removes the empty ones.

- - - -
- - - SystemRoot - -
- Signature: string
-
-
- - - - -

The system root environment variable. Typically "C:\Windows"

- - - -
- - - TargetPlatformPrefix - -
- Signature: string
-
-
- - - - -

The path of the current target platform

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-filehelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-filehelper.html deleted file mode 100644 index d256a49..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-filehelper.html +++ /dev/null @@ -1,1396 +0,0 @@ - - - - - FileHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

FileHelper

-
-

Contains helper function which allow to deal with files and directories.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - allFiles path - -
- Signature: path:string -> bool
-
-
- - - - -

Includes all files

- - - -
- - - AppendTextFiles newFileName files - -
- Signature: newFileName:string -> files:seq<string> -> unit
-
-
- - - - -

Appends all given files to one file.

- -

Parameters

- -
    -
  • newFileName - The target FileName.
  • -
  • files - The original FileNames as a sequence.
  • -
- - - -
- - - changeExt extension fileName - -
- Signature: extension:string -> fileName:string -> string
-
-
- - - - -

Change the extension of the file.

- -

Parameters

- -
    -
  • 'extension' - The new extension containing the leading '.'.
  • -
  • 'fileName' - Name of the file from which the extension is retrieved.
  • -
- - - -
- - - CleanDir path - -
- Signature: path:string -> unit
-
-
- - - - -

Cleans a directory by removing all files and sub-directories.

- - - -
- - - CleanDirs dirs - -
- Signature: dirs:seq<string> -> unit
-
-
- - - - -

Cleans multiple directories

- - - -
- - - CompareFiles (...) - -
- Signature: delete:bool -> originalFileName:string -> compareFileName:string -> bool
-
-
- - - - -

Compares the given files for changes. -If delete is set to true then equal files will be removed.

- - - -
- - - Copy target files - -
- Signature: target:string -> files:seq<string> -> unit
-
-
- - - - -

Copies the files to the target.

- -

Parameters

- -
    -
  • target - The target directory.
  • -
  • files - The original file names as a sequence.
  • -
- - - -
- - - CopyCached target cacheDir files - -
- Signature: target:string -> cacheDir:string -> files:seq<string> -> string list
-
-
- - - - -

Copies the files from a cache folder. -If the files are not cached or the original files have a different write time the cache will be refreshed.

- -

Parameters

- -
    -
  • target - The target FileName.
  • -
  • cacheDir - The cache directory.
  • -
  • files - The orginal files.
  • -
- - - -
- - - CopyDir target source filterFile - -
- Signature: target:string -> source:string -> filterFile:(string -> bool) -> unit
-
-
- - - - -

Copies a directory recursivly. If the target directory does not exist, it will be created.

- -

Parameters

- -
    -
  • target - The target directory.
  • -
  • source - The source directory.
  • -
  • filterFile - A file filter predicate.
  • -
- - - -
- - - CopyFile target fileName - -
- Signature: target:string -> fileName:string -> unit
-
-
- - - - -

Copies a single file to the target and overwrites the existing file.

- -

Parameters

- -
    -
  • target - The target directory or file.
  • -
  • fileName - The FileName.
  • -
- - - -
- - - CopyFileIntoSubFolder target fileName - -
- Signature: target:string -> fileName:string -> unit
-
-
- - - - -

Copies a single file to a relative subfolder of the target.

- -

Parameters

- -
    -
  • target - The target directory
  • -
  • fileName - The fileName
  • -
- - - -
- - - CopyFiles target files - -
- Signature: target:string -> files:seq<string> -> unit
-
-
- - - - -

Copies the files to the target - Alias for Copy

- -

Parameters

- -
    -
  • target - The target directory.
  • -
  • files - The orginal file names.
  • -
- - - -
- - - CopyFileWithSubfolder (...) - -
- Signature: baseDir:string -> target:string -> fileName:string -> unit
-
-
- - - - -

Copies a single file to the target folder preserving the folder structure -starting from the specified base folder.

- -

Parameters

- -
    -
  • baseDir - The base directory.
  • -
  • target - The target directory.
  • -
  • fileName - The file name.
  • -
- - - -
- - - copyRecursive dir outputDir overwrite - -
- Signature: dir:DirectoryInfo -> outputDir:DirectoryInfo -> overwrite:bool -> string list
-
-
- - - - -

Copies the file structure recursively.

- - - -
- - - CopyRecursive dir outputDir - -
- Signature: dir:string -> outputDir:string -> bool -> string list
-
-
- - - - -

Copies the file structure recursively.

- - - -
- - - CopyTo target files - -
- Signature: target:string -> files:seq<string> -> unit
-
-
- - - - -

Copies the given files to the target.

- -

Parameters

- -
    -
  • target - The target directory.
  • -
  • files - The original file names as a sequence.
  • -
- - - -
- - - CopyWithSubfoldersTo target files - -
- Signature: target:string -> files:seq<FileIncludes> -> unit
-
-
- - - - -

Copies several file groups, each represented by a FileIncludes object, -to the target folder preserving the folder structure -starting from the BaseDirectory of each FileIncludes.

- -

Parameters

- -
    -
  • target - The target directory.
  • -
  • files - A sequence of file groups.
  • -
- - - -
- - - CreateDir path - -
- Signature: path:string -> unit
-
-
- - - - -

Creates a directory if it does not exist.

- - - -
- - - CreateFile fileName - -
- Signature: fileName:string -> unit
-
-
- - - - -

Creates a file if it does not exist.

- - - -
- - - DeleteDir path - -
- Signature: path:string -> unit
-
-
- - - - -

Deletes a directory if it exists.

- - - -
- - - DeleteDirs dirs - -
- Signature: dirs:seq<string> -> unit
-
-
- - - - -

Deletes multiple directories

- - - -
- - - DeleteFile fileName - -
- Signature: fileName:string -> unit
-
-
- - - - -

Deletes a file if it exists.

- - - -
- - - DeleteFiles files - -
- Signature: files:seq<string> -> unit
-
-
- - - - -

Deletes the given files.

- - - -
- - - directory path - -
- Signature: path:string -> string
-
-
- - - - -

Get the directory of the specified path

- -

Parameters

- -
    -
  • 'path' - The path from which the directory is retrieved.
  • -
- - - -
- - - excludeSVNFiles path - -
- Signature: path:string -> bool
-
-
- - - - -

Exclude SVN files (path with .svn)

- - - -
- - - ext fileName - -
- Signature: fileName:string -> string
-
-
- - - - -

Get the filename extension including the leading '.', or an empty string if the file has no extension.

- -

Parameters

- -
    -
  • 'fileName' - Name of the file from which the extension is retrieved.
  • -
- - - -
- - - filename path - -
- Signature: path:string -> string
-
-
- - - - -

Get the filename for the specified path

- -

Parameters

- -
    -
  • 'path' - The path from which the filename is retrieved.
  • -
- - - -
- - - filenameWithouExt path - -
- Signature: path:string -> string
-
-
- - - - - -
- - - fileNameWithoutExt path - -
- Signature: path:string -> string
-
-
- - - - -

Get the filename for the specified path without it's extension

- -

Parameters

- -
    -
  • 'path' - The path from which the filename is retrieved.
  • -
- - - -
- - - FilesAreEqual first second - -
- Signature: first:FileInfo -> second:FileInfo -> bool
-
-
- - - - -

Checks if the two files are byte-to-byte equal.

- - - -
- - - FileVersion fileName - -
- Signature: fileName:string -> string
-
-
- - - - -

Get the version a file.

- -

Parameters

- -
    -
  • 'fileName' - Name of file from which the version is retrieved. The path can be relative.
  • -
- - - -
- - - GeneratePatch (...) - -
- Signature: lastReleaseDir:string -> patchDir:string -> srcFiles:seq<string> -> unit
-
-
- - - - -

Checks the srcFiles for changes to the last release.

- -

Parameters

- -
    -
  • lastReleaseDir - The directory of the last release.
  • -
  • patchDir - The target directory.
  • -
  • srcFiles - The source files.
  • -
- - - -
- - - GeneratePatchWithFindOldFileFunction (...) - -
- Signature: lastReleaseDir:string -> patchDir:string -> srcFiles:seq<string> -> findOldFileF:(string -> string -> string) -> unit
-
-
- - - - -

Checks the srcFiles for changes to the last release.

- -

Parameters

- -
    -
  • lastReleaseDir - The directory of the last release
  • -
  • patchDir - The target directory
  • -
  • srcFiles - The source files
  • -
  • findOldFileF - A function which finds the old file
  • -
- - - -
- - - hasExt extension fileName - -
- Signature: extension:string -> fileName:string -> bool
-
-
- - - - -

Tests whether the file has specified extensions (containing the leading '.')

- -

Parameters

- -
    -
  • 'extension' - The extension to fine containing the leading '.'.
  • -
  • 'fileName' - Name of the file from which the extension is retrieved.
  • -
- - - -
- - - MoveFile target fileName - -
- Signature: target:string -> fileName:string -> unit
-
-
- - - - -

Moves a single file to the target and overwrites the existing file.

- -

Parameters

- -
    -
  • target - The target directory.
  • -
  • fileName - The FileName.
  • -
- - - -
- - - ReadCSVFile file - -
- Signature: file:string -> seq<string []>
-
-
- - - - -

Reads a csv file line by line -delimiter is a ,

- - - -
- - - recursively dirF fileF dir - -
- Signature: dirF:(DirectoryInfo -> unit) -> fileF:(FileInfo -> unit) -> dir:DirectoryInfo -> unit
-
-
- - - - -

Performs the given actions on all files and subdirectories

- - - -
- - - RegexReplaceInFilesWithEncoding (...) - -
- Signature: pattern:string -> replacement:string -> encoding:Encoding -> files:seq<string> -> unit
-
-
- - - - -

Replace all occurences of the regex pattern with the given replacement in the specified files

- -

Parameters

- -
    -
  • pattern - The string to search for a match
  • -
  • replacement - The replacement string
  • -
  • encoding - The encoding to use when reading and writing the files
  • -
  • files - The paths of the files to process
  • -
- - - -
- - - RegexReplaceInFileWithEncoding (...) - -
- Signature: pattern:string -> replacement:string -> encoding:Encoding -> file:string -> unit
-
-
- - - - -

Replace all occurences of the regex pattern with the given replacement in the specified file

- -

Parameters

- -
    -
  • pattern - The string to search for a match
  • -
  • replacement - The replacement string
  • -
  • encoding - The encoding to use when reading and writing the file
  • -
  • file - The path of the file to process
  • -
- - - -
- - - Rename target fileName - -
- Signature: target:string -> fileName:string -> unit
-
-
- - - - -

Renames the file to the target file name.

- -

Parameters

- -
    -
  • target - The target file name.
  • -
  • file - The orginal file name.
  • -
- - - -
- - - ReplaceInFiles replacements files - -
- Signature: replacements:seq<string * string> -> files:seq<string> -> unit
-
-
- - - - -

Replaces all occurences of the patterns in the given files with the given replacements.

- -

Parameters

- -
    -
  • replacements - A sequence of tuples with the patterns and the replacements.
  • -
  • files - The files to process.
  • -
- - - -
- - - setDirectoryReadOnly readOnly dir - -
- Signature: readOnly:bool -> dir:DirectoryInfo -> unit
-
-
- - - - -

Sets the directory readonly

- - - -
- - - SetDirReadOnly readOnly dir - -
- Signature: readOnly:bool -> dir:DirectoryInfo -> unit
-
-
- - - - -

Sets all files in the directory readonly.

- - - -
- - - SetReadOnly readOnly files - -
- Signature: readOnly:bool -> files:seq<string> -> unit
-
-
- - - - -

Sets all given files readonly.

- - - -
- - - SilentCopy target files - -
- Signature: target:string -> files:seq<string> -> unit
-
-
- - - - -

Copies a list of files to the specified directory without any output.

- -

Parameters

- -
    -
  • target - The target directory.
  • -
  • files - List of files to copy.
  • -
- - - -
- - - TestDir path - -
- Signature: path:string -> bool
-
-
- - - - -

Checks if the directory exists

- - - -
- - - TestFile path - -
- Signature: path:string -> bool
-
-
- - - - -

Checks if the file exists

- - - -
- - - WriteConfigFile (...) - -
- Signature: configFileName:string -> parameters:seq<'?10120 * '?10121> -> unit
- Type parameters: '?10120, '?10121
-
- - - - -

Creates a config file with the parameters as "key;value" lines

- - - -
-

Active patterns

- - - - - - - - - - - - - - - - - - - - - - -
Active patternDescription
- - - ( |EndsWith|_| ) extension file - -
- Signature: extension:string -> file:string -> unit option
-
-
- - - - -

Active Pattern for determining file extension.

- - - -
- - - ( |File|Directory| ) fileSysInfo - -
- Signature: fileSysInfo:FileSystemInfo -> Choice<FileInfo,(DirectoryInfo * IEnumerable<FileSystemInfo>)>
-
-
- - - - -

Active pattern which discriminates between files and directories.

- - - -
- - - ( |FileInfoFullName| ) f - -
- Signature: f:FileInfo -> string
-
-
- - - - -

Active Pattern for determining file name.

- - - -
- - - ( |FileInfoNameSections| ) f - -
- Signature: f:FileInfo -> string * string * string
-
-
- - - - -

Active Pattern for determining FileInfoNameSections.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-filesystem-fileincludes.html b/packages/FAKE.4.11.3/docs/apidocs/fake-filesystem-fileincludes.html deleted file mode 100644 index 8031468..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-filesystem-fileincludes.html +++ /dev/null @@ -1,256 +0,0 @@ - - - - - FileIncludes - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

FileIncludes

-
-

Internal representation of a file set.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - BaseDirectory - -
- Signature: string
-
-
- - - - - -
- - - Excludes - -
- Signature: string list
-
-
- - - - - -
- - - Includes - -
- Signature: string list
-
-
- - - - - -
-

Instance members

- - - - - - - - - - - - - - - - - - - - - - -
Instance memberDescription
- - - And(pattern) - -
- Signature: pattern:string -> FileIncludes
-
-
- - - - -

Adds the given pattern to the file includes

- - - -
- - - ButNot(pattern) - -
- Signature: pattern:string -> FileIncludes
-
-
- - - - -

Ignores files with the given pattern

- - - -
- - - IsMatch(path) - -
- Signature: path:string -> bool
-
-
- - - - -

Checks if a particular file is matched

- - - -
- - - SetBaseDirectory(dir) - -
- Signature: dir:string -> FileIncludes
-
-
- - - - -

Sets a directory as BaseDirectory.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-filesystem.html b/packages/FAKE.4.11.3/docs/apidocs/fake-filesystem.html deleted file mode 100644 index bb8b795..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-filesystem.html +++ /dev/null @@ -1,280 +0,0 @@ - - - - - FileSystem - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

FileSystem

-
-

This module contains a file pattern globbing implementation.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- FileIncludes -

Internal representation of a file set.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - ( -- ) x pattern - -
- Signature: x:FileIncludes -> pattern:string -> FileIncludes
-
-
- - - - -

Exclude operator

- - - -
- - - ( !! ) x - -
- Signature: x:string -> FileIncludes
-
-
- - - - -

Includes a single pattern and scans the files - !! x = AllFilesMatching x

- - - -
- - - ( ++ ) x pattern - -
- Signature: x:FileIncludes -> pattern:string -> FileIncludes
-
-
- - - - -

Add Include operator

- - - -
- - - findToolFolderInSubPath (...) - -
- Signature: toolname:string -> defaultPath:string -> string
-
-
- - - - -

Looks for a tool in all subfolders - returns the folder where the tool was found.

- - - -
- - - findToolInSubPath toolname defaultPath - -
- Signature: toolname:string -> defaultPath:string -> string
-
-
- - - - -

Looks for a tool first in its default path, if not found in all subfolders of the root folder - returns the tool file name.

- - - -
- - - Include x - -
- Signature: x:string -> FileIncludes
-
-
- - - - -

Include files

- - - -
- - - SetBaseDir dir fileIncludes - -
- Signature: dir:string -> fileIncludes:FileIncludes -> FileIncludes
-
-
- - - - -

Sets a directory as baseDirectory for fileIncludes.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-filesystemhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-filesystemhelper.html deleted file mode 100644 index effe49b..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-filesystemhelper.html +++ /dev/null @@ -1,617 +0,0 @@ - - - - - FileSystemHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

FileSystemHelper

-
-

Contains helpers which allow to interact with the file system.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - allFilesExist files - -
- Signature: files:seq<string> -> bool
-
-
- - - - -

Checks if all given files exist.

- - - -
- - - checkFileExists fileName - -
- Signature: fileName:string -> unit
-
-
- - - - -

Raises an exception if the file doesn't exist on disk.

- - - -
- - - currentDirectory - -
- Signature: string
-
-
- - - - -

Gets the current directory.

- - - -
- - - directoryExists dir - -
- Signature: dir:string -> bool
-
-
- - - - -

Checks if the directory exists on disk.

- - - -
- - - directoryInfo path - -
- Signature: path:string -> DirectoryInfo
-
-
- - - - -

Creates a DirectoryInfo for the given path.

- - - -
- - - DirectoryName fileName - -
- Signature: fileName:string -> string
-
-
- - - - -

Gets the directory part of a filename.

- - - -
- - - ensureDirectory dir - -
- Signature: dir:string -> unit
-
-
- - - - -

Checks if the given directory exists. If not then this functions creates the directory.

- - - -
- - - ensureDirExists dir - -
- Signature: dir:DirectoryInfo -> unit
-
-
- - - - -

Ensure that directory chain exists. Create necessary directories if necessary.

- - - -
- - - fileExists fileName - -
- Signature: fileName:string -> bool
-
-
- - - - -

Checks if the file exists on disk.

- - - -
- - - fileInfo path - -
- Signature: path:string -> FileInfo
-
-
- - - - -

Creates a FileInfo for the given path.

- - - -
- - - filesInDir dir - -
- Signature: dir:DirectoryInfo -> FileInfo []
-
-
- - - - -

Gets all files in the directory.

- - - -
- - - filesInDirMatching pattern dir - -
- Signature: pattern:string -> dir:DirectoryInfo -> FileInfo []
-
-
- - - - -

Finds all the files in the directory matching the search pattern.

- - - -
- - - fileSystemInfo path - -
- Signature: path:string -> FileSystemInfo
-
-
- - - - -

Creates a FileInfo or a DirectoryInfo for the given path

- - - -
- - - FindFirstMatchingFile pattern dir - -
- Signature: pattern:string -> dir:string -> string
-
-
- - - - -

Gets the first file in the directory matching the search pattern or throws an error if nothing was found.

- - - -
- - - fullAssemblyPath - -
- Signature: string
-
-
- - - - -

Get the full location of the current assembly.

- - - -
- - - FullName fileName - -
- Signature: fileName:string -> string
-
-
- - - - -

Converts a filename to it's full file system name.

- - - -
- - - isDirectory path - -
- Signature: path:string -> bool
-
-
- - - - -

Detects whether the given path is a directory.

- - - -
- - - isFile path - -
- Signature: path:string -> bool
-
-
- - - - -

Detects whether the given path is a file.

- - - -
- - - isInFolder dir fileInfo - -
- Signature: dir:DirectoryInfo -> fileInfo:FileInfo -> bool
-
-
- - - - -

Checks if the file is in a subfolder of the dir.

- - - -
- - - isSubfolderOf dir2 dir1 - -
- Signature: dir2:DirectoryInfo -> dir1:DirectoryInfo -> bool
-
-
- - - - -

Checks if dir1 is a subfolder of dir2. If dir1 equals dir2 the function returns also true.

- - - -
- - - isValidPath path - -
- Signature: path:string -> bool
-
-
- - - - -

Detects whether the given path does not contains invalid characters.

- - - -
- - - normalizeFileName fileName - -
- Signature: fileName:string -> string
-
-
- - - - -

Normalizes a filename.

- - - -
- - - subDirectories dir - -
- Signature: dir:DirectoryInfo -> DirectoryInfo []
-
-
- - - - -

Gets all subdirectories of a given directory.

- - - -
- - - TryFindFirstMatchingFile pattern dir - -
- Signature: pattern:string -> dir:string -> string option
-
-
- - - - -

Gets the first file in the directory matching the search pattern as an option value.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-fileutils.html b/packages/FAKE.4.11.3/docs/apidocs/fake-fileutils.html deleted file mode 100644 index 8b0c856..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-fileutils.html +++ /dev/null @@ -1,369 +0,0 @@ - - - - - FileUtils - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

FileUtils

-
-

Shell-like functions. Similar to Ruby's FileUtils.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - cd path - -
- Signature: path:string -> unit
-
-
- - - - -

Changes working directory

- - - -
- - - chdir path - -
- Signature: path:string -> unit
-
-
- - - - -

Changes working directory

- - - -
- - - cp src dest - -
- Signature: src:string -> dest:string -> unit
-
-
- - - - -

Like "cp" in a shell. Copies a single file. -The source -The destination

- - - -
- - - cp_r src dest - -
- Signature: src:string -> dest:string -> unit
-
-
- - - - -

Like "cp -r" in a shell. Copies a file or directory recursively.

- - - -
- - - dirStack - -
- Signature: Stack<string>
-
-
- - - - -

The stack of directories operated on by pushd and popd

- - - -
- - - mkdir path - -
- Signature: path:string -> unit
-
-
- - - - -

Creates a directory if it doesn't exist.

- - - -
- - - mv src dest - -
- Signature: src:string -> dest:string -> unit
-
-
- - - - -

Like "mv" in a shell. Moves/renames a file -The source -The destination

- - - -
- - - popd () - -
- Signature: unit -> unit
-
-
- - - - -

Restore the previous directory stored in the stack

- - - -
- - - pushd path - -
- Signature: path:string -> unit
-
-
- - - - -

Store the current directory in the directory stack before changing to a new one

- - - -
- - - pwd () - -
- Signature: unit -> string
-
-
- - - - -

Gets working directory

- - - -
- - - rm fileName - -
- Signature: fileName:string -> unit
-
-
- - - - -

Deletes a file if it exists

- - - -
- - - rm_rf f - -
- Signature: f:string -> unit
-
-
- - - - -

Like "rm -rf" in a shell. Removes files recursively, ignoring nonexisting files

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-fixiehelper-fixieparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-fixiehelper-fixieparams.html deleted file mode 100644 index df9e084..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-fixiehelper-fixieparams.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - FixieParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

FixieParams

-
-

Parameter type to configure the Fixie runner

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - CustomOptions - -
- Signature: (string * Object) list
-
-
- - - - -

Custom options to pass to Fixie runner

- - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - -

A timeout for the test runner

- - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - -

FileName of the Fixie runner

- - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - -

Working directory (optional)

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-fixiehelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-fixiehelper.html deleted file mode 100644 index e73e757..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-fixiehelper.html +++ /dev/null @@ -1,193 +0,0 @@ - - - - - FixieHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

FixieHelper

-
-

Contains tasks to run Fixie unit tests.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- FixieParams -

Parameter type to configure the Fixie runner

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - Fixie setParams assemblies - -
- Signature: setParams:(FixieParams -> FixieParams) -> assemblies:seq<string> -> unit
-
-
- - - - -

This task to can be used to run Fixie on test libraries.

- -

Parameters

- -
    -
  • setParams - Function used to overwrite the Fixie default parameters.
  • -
  • assemblies - The file names of the test assemblies.
  • -
- -

Sample

- - - - -
1: 
-2: 
-
!! (testDir @@ "Test.*.dll") 
-  |> Fixie (fun p -> { p with CustomOptions = ["custom","1"; "test",2] })
-
- - - -
- - - FixieDefaults - -
- Signature: FixieParams
-
-
- - - - -

Fixie default parameters - tries to locate Fixie.Console.exe in any subfolder.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-fluentmigratorhelper-databaseconnection.html b/packages/FAKE.4.11.3/docs/apidocs/fake-fluentmigratorhelper-databaseconnection.html deleted file mode 100644 index 1814368..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-fluentmigratorhelper-databaseconnection.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - DatabaseConnection - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

DatabaseConnection

-
-

Database connection configuration

- - -
-

Union Cases

- - - - - - - - - - - - - - -
Union CaseDescription
- - - ConnectionString(...) - -
- Signature: string * DatabaseProvider
-
-
- - - - -

Explicit connection string

- - - -
- - - ConnectionStringFromConfig(...) - -
- Signature: string * string * DatabaseProvider
-
-
- - - - -

Connection string specified in application config file

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-fluentmigratorhelper-databaseprovider.html b/packages/FAKE.4.11.3/docs/apidocs/fake-fluentmigratorhelper-databaseprovider.html deleted file mode 100644 index 392de3f..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-fluentmigratorhelper-databaseprovider.html +++ /dev/null @@ -1,272 +0,0 @@ - - - - - DatabaseProvider - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

DatabaseProvider

-
-

Fluent Migrator SQL syntax provider

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - DB2 - -
- Signature:
-
-
- - - - - -
- - - Firebird - -
- Signature:
-
-
- - - - - -
- - - HANA - -
- Signature:
-
-
- - - - - -
- - - Jet - -
- Signature:
-
-
- - - - - -
- - - MySql - -
- Signature:
-
-
- - - - - -
- - - Oracle(version) - -
- Signature: OracleVersion
-
-
- - - - - -
- - - PostgreSQL - -
- Signature:
-
-
- - - - - -
- - - SQLite - -
- Signature:
-
-
- - - - - -
- - - SqlServer(version) - -
- Signature: SqlServerVersion
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-fluentmigratorhelper-databasetask.html b/packages/FAKE.4.11.3/docs/apidocs/fake-fluentmigratorhelper-databasetask.html deleted file mode 100644 index 0ffb609..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-fluentmigratorhelper-databasetask.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - DatabaseTask - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

DatabaseTask

-
-

Database operation to execute

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - ListAppliedMigrations(connection) - -
- Signature: DatabaseConnection
-
-
- - - - - -
- - - MigrateDown(mode,version) - -
- Signature: MigrationRunningMode * int64
-
-
- - - - - -
- - - MigrateUp(mode,version) - -
- Signature: MigrationRunningMode * Option<int64>
-
-
- - - - - -
- - - Rollback(mode,steps) - -
- Signature: MigrationRunningMode * int
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-fluentmigratorhelper-migrationoptions.html b/packages/FAKE.4.11.3/docs/apidocs/fake-fluentmigratorhelper-migrationoptions.html deleted file mode 100644 index 406dba3..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-fluentmigratorhelper-migrationoptions.html +++ /dev/null @@ -1,272 +0,0 @@ - - - - - MigrationOptions - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MigrationOptions

-
-

Fluent Migrator options

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Context - -
- Signature: Object
-
-
- - - - - -
- - - Namespace - -
- Signature: Option<string * bool>
-
-
- - - - - -
- - - Profile - -
- Signature: string
-
-
- - - - - -
- - - ProviderSwitches - -
- Signature: string
-
-
- - - - - -
- - - Tags - -
- Signature: seq<string>
-
-
- - - - - -
- - - Timeout - -
- Signature: int
-
-
- - - - - -
- - - TransactionPerSession - -
- Signature: bool
-
-
- - - - - -
- - - Verbose - -
- Signature: bool
-
-
- - - - - -
- - - WorkingDirectory - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-fluentmigratorhelper-migrationrunningmode.html b/packages/FAKE.4.11.3/docs/apidocs/fake-fluentmigratorhelper-migrationrunningmode.html deleted file mode 100644 index b426fe4..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-fluentmigratorhelper-migrationrunningmode.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - MigrationRunningMode - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MigrationRunningMode

-
-

Fluent Migrator execution mode

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - Execute(connection) - -
- Signature: DatabaseConnection
-
-
- - - - -

Execute migrations on the target database

- - - -
- - - ExecuteAndScript(...) - -
- Signature: DatabaseConnection * string
-
-
- - - - -

Execute migrations on the target database and script SQL to the output file

- - - -
- - - Preview(connection) - -
- Signature: DatabaseConnection
-
-
- - - - -

Execute migrations in preview-only mode

- - - -
- - - Script(...) - -
- Signature: int64 * string * DatabaseProvider
-
-
- - - - -

Create migration script

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-fluentmigratorhelper-oracleversion.html b/packages/FAKE.4.11.3/docs/apidocs/fake-fluentmigratorhelper-oracleversion.html deleted file mode 100644 index 03428ab..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-fluentmigratorhelper-oracleversion.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - OracleVersion - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-fluentmigratorhelper-sqlserverversion.html b/packages/FAKE.4.11.3/docs/apidocs/fake-fluentmigratorhelper-sqlserverversion.html deleted file mode 100644 index b877813..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-fluentmigratorhelper-sqlserverversion.html +++ /dev/null @@ -1,236 +0,0 @@ - - - - - SqlServerVersion - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

SqlServerVersion

-
-

MS SQL Server driver version

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - CE - -
- Signature:
-
-
- - - - - -
- - - Default - -
- Signature:
-
-
- - - - - -
- - - V2000 - -
- Signature:
-
-
- - - - - -
- - - V2005 - -
- Signature:
-
-
- - - - - -
- - - V2008 - -
- Signature:
-
-
- - - - - -
- - - V2012 - -
- Signature:
-
-
- - - - - -
- - - V2014 - -
- Signature:
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-fluentmigratorhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-fluentmigratorhelper.html deleted file mode 100644 index b99bd71..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-fluentmigratorhelper.html +++ /dev/null @@ -1,403 +0,0 @@ - - - - - FluentMigratorHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

FluentMigratorHelper

-
-

Contains functions to run FluentMigrator

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- DatabaseConnection -

Database connection configuration

- - -
- DatabaseProvider -

Fluent Migrator SQL syntax provider

- - -
- DatabaseTask -

Database operation to execute

- - -
- MigrationOptions -

Fluent Migrator options

- - -
- MigrationRunningMode -

Fluent Migrator execution mode

- - -
- OracleVersion -

Oracle database driver version

- - -
- SqlServerVersion -

MS SQL Server driver version

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - DefaultMigrationOptions - -
- Signature: MigrationOptions
-
-
- - - - -

Default migration options

- - - -
- - - ExecuteDatabaseTask (...) - -
- Signature: task:DatabaseTask -> assemblies:seq<string> -> options:MigrationOptions -> unit
-
-
- - - - -

Executes the specified task using configuration options

- -

Parameters

- -
    -
  • task - Database task to execute
  • -
  • assemblies - Assembly files which contain migrations
  • -
  • options - Migration options which are passed to FluentMigrator
  • -
- - - -
- - - ListAppliedMigrations (...) - -
- Signature: connection:DatabaseConnection -> assemblies:seq<string> -> unit
-
-
- - - - -

Lists all migrations which were applied to the database - - connection - Database connection - - assemblies - Assembly files which contain migrations

- - - -
- - - MigrateDown (...) - -
- Signature: version:int64 -> connection:DatabaseConnection -> assemblies:seq<string> -> options:MigrationOptions -> unit
-
-
- - - - -

Migrates database up to the specified version

- -

Parameters

- -
    -
  • version - Target version
  • -
  • connection - Database connection
  • -
  • assemblies - Assembly files which contain migrations
  • -
  • options - Migration options which are passed to FluentMigrator
  • -
- - - -
- - - MigrateToLatest (...) - -
- Signature: connection:DatabaseConnection -> assemblies:seq<string> -> options:MigrationOptions -> unit
-
-
- - - - -

Migrates database up to the latest version

- -

Parameters

- -
    -
  • connection - Database connection
  • -
  • assemblies - Assembly files which contain migrations
  • -
  • options - Migration options which are passed to FluentMigrator
  • -
- - - -
- - - MigrateUp (...) - -
- Signature: version:int64 -> connection:DatabaseConnection -> assemblies:seq<string> -> options:MigrationOptions -> unit
-
-
- - - - -

Migrates database up to the specified version

- -

Parameters

- -
    -
  • version - Target version
  • -
  • connection - Database connection
  • -
  • assemblies - Assembly files which contain migrations
  • -
  • options - Migration options which are passed to FluentMigrator
  • -
- - - -
- - - Rollback (...) - -
- Signature: steps:int -> connection:DatabaseConnection -> assemblies:seq<string> -> options:MigrationOptions -> unit
-
-
- - - - -

Rollbacks several applied migrations

- -

Parameters

- -
    -
  • steps - Number of migrations to rollback
  • -
  • connection - Database connection
  • -
  • assemblies - Assembly files which contain migrations
  • -
  • options - Migration options which are passed to FluentMigrator
  • -
- - - -
- - - RollbackLatest (...) - -
- Signature: connection:DatabaseConnection -> assemblies:seq<string> -> options:MigrationOptions -> unit
-
-
- - - - -

Rollbacks latest applied migration - - connection - Database connection - - assemblies - Assembly files which contain migrations - - options - Migration options which are passed to FluentMigrator

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-fschelper-fscparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-fschelper-fscparams.html deleted file mode 100644 index 0ed927a..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-fschelper-fscparams.html +++ /dev/null @@ -1,265 +0,0 @@ - - - - - FscParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

FscParams

-
-

'fsc.exe' command line parameters

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Debug - -
- Signature: bool
-
-
- - - - -

Specifies whether to emit debug information (default is false).

- - - -
- - - FscTarget - -
- Signature: FscTarget
-
-
- - - - -

Specifies the compiled artifact target type.

- - - -
- - - OtherParams - -
- Signature: string list
-
-
- - - - -

Specifies other params for the compilation. Freeform strings.

- - - -
- - - Output - -
- Signature: string
-
-
- - - - -

Specifies the output file name and path.

- - - -
- - - Platform - -
- Signature: FscPlatform
-
-
- - - - -

Specifies the compiled artifact target platform.

- - - -
- - - References - -
- Signature: string list
-
-
- - - - -

Specifies files to reference for the compilation.

- - - -
-

Static members

- - - - - - - - - - -
Static memberDescription
- - - Default - -
- Signature: FscParams
-
-
- - - - -

The default parameters to the compiler service.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-fschelper-fscplatform.html b/packages/FAKE.4.11.3/docs/apidocs/fake-fschelper-fscplatform.html deleted file mode 100644 index 4a4c3ba..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-fschelper-fscplatform.html +++ /dev/null @@ -1,200 +0,0 @@ - - - - - FscPlatform - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

FscPlatform

-
-

The 'fsc.exe' output platforms

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - AnyCpu - -
- Signature:
-
-
- - - - - -
- - - AnyCpu32BitPreferred - -
- Signature:
-
-
- - - - - -
- - - Itanium - -
- Signature:
-
-
- - - - - -
- - - X64 - -
- Signature:
-
-
- - - - - -
- - - X86 - -
- Signature:
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-fschelper-fsctarget.html b/packages/FAKE.4.11.3/docs/apidocs/fake-fschelper-fsctarget.html deleted file mode 100644 index 67df519..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-fschelper-fsctarget.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - FscTarget - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

FscTarget

-
-

The 'fsc.exe' output target types

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - Exe - -
- Signature:
-
-
- - - - - -
- - - Library - -
- Signature:
-
-
- - - - - -
- - - Module - -
- Signature:
-
-
- - - - - -
- - - Winexe - -
- Signature:
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-fschelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-fschelper.html deleted file mode 100644 index eae472c..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-fschelper.html +++ /dev/null @@ -1,269 +0,0 @@ - - - - - FscHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

FscHelper

-
-

Contains tasks to compiles F# source file with the FSharp.Compiler.Service. -There is also a tutorial about the F# compiler tasks available.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - -
TypeDescription
- FscParams -

'fsc.exe' command line parameters

- - -
- FscPlatform -

The 'fsc.exe' output platforms

- - -
- FscTarget -

The 'fsc.exe' output target types

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - fsc setParams inputFiles - -
- Signature: setParams:(FscParams -> FscParams) -> inputFiles:string list -> int
-
-
- - - - -

Compiles the given F# source files with the specified parameters.

- -

Parameters

- -
    -
  • setParams - Function used to overwrite the default Fsc parameters.
  • -
  • inputFiles - The F# input files.
  • -
- -

Returns

- -

The exit status code of the compile process.

- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-
["file1.fs"; "file2.fs"]
-|> fsc (fun parameters ->
-         { parameters with Output = ...
-                           FscTarget = ...
-                           ... })
-
- - - -
- - - Fsc setParams inputFiles - -
- Signature: setParams:(FscParams -> FscParams) -> inputFiles:string list -> unit
-
-
- - - - -

Compiles one or more F# source files with the specified parameters.

- -

Parameters

- -
    -
  • setParams - Function used to overwrite the default Fsc parameters.
  • -
  • inputFiles - The F# input files.
  • -
- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-
["file1.fs"; "file2.fs"]
-|> Fsc (fun parameters ->
-              { parameters with Output = ...
-                                FscTarget = ...
-                                ... })
-
- - - -
- - - fscList srcFiles opts - -
- Signature: srcFiles:string list -> opts:string list -> int
-
-
- - - - -

Compiles the given source file with the given options. If no options -given (i.e. the second argument is an empty list), by default tries -to behave the same way as would the command-line 'fsc.exe' tool.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-fsharpformatting.html b/packages/FAKE.4.11.3/docs/apidocs/fake-fsharpformatting.html deleted file mode 100644 index 91df619..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-fsharpformatting.html +++ /dev/null @@ -1,191 +0,0 @@ - - - - - FSharpFormatting - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

FSharpFormatting

-
-

Contains tasks which allow to run FSharp.Formatting for generating documentation.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - CreateDocs (...) - -
- Signature: source:string -> outputDir:string -> template:string -> projectParameters:seq<string * string> -> unit
-
-
- - - - - -
- - - CreateDocsForDlls (...) - -
- Signature: outputDir:string -> templatesDir:string -> projectParameters:seq<string * string> -> sourceRepo:string -> dllFiles:seq<string> -> unit
-
-
- - - - - -
- - - run command - -
- Signature: command:string -> unit
-
-
- - - - -

Runs fsformatting.exe with the given command in the given repository directory.

- - - -
- - - toolPath - -
- Signature: string
-
-
- - - - -

Specifies the fsformatting executable

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-fsihelper-fsiargs.html b/packages/FAKE.4.11.3/docs/apidocs/fake-fsihelper-fsiargs.html deleted file mode 100644 index e693f74..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-fsihelper-fsiargs.html +++ /dev/null @@ -1,151 +0,0 @@ - - - - - FsiArgs - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

FsiArgs

-
-
-

Union Cases

- - - - - - - - - - -
Union CaseDescription
- - - FsiArgs(string list,string,string list) - -
- Signature: string list * string * string list
-
-
- - - - - -
-

Static members

- - - - - - - - - - -
Static memberDescription
- - - parse(args) - -
- Signature: (args:string array) -> Choice<FsiArgs,string>
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-fsihelper-script.html b/packages/FAKE.4.11.3/docs/apidocs/fake-fsihelper-script.html deleted file mode 100644 index de2cfbb..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-fsihelper-script.html +++ /dev/null @@ -1,179 +0,0 @@ - - - - - Script - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Script

-
-
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Content - -
- Signature: string
-
-
- - - - - -
- - - IncludedAssemblies - -
- Signature: Lazy<seq<string>>
-
-
- - - - - -
- - - Location - -
- Signature: string
-
-
- - - - - -
- - - SearchPaths - -
- Signature: seq<string>
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-fsihelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-fsihelper.html deleted file mode 100644 index 4d158e7..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-fsihelper.html +++ /dev/null @@ -1,505 +0,0 @@ - - - - - FSIHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

FSIHelper

-
-

Contains helper functions which allow to interact with the F# Interactive.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - -
TypeDescription
- FsiArgs -
- Script -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - createDirectiveRegex id - -
- Signature: id:string -> Regex
-
-
- - - - - -
- - - executeBuildScriptWithArgsAndReturnMessages (...) - -
- Signature: script:string -> scriptArgs:string [] -> useCache:bool -> cleanCache:bool -> bool * ConsoleMessage list
-
-
- - - - -

Run the given buildscript with fsi.exe and allows for extra arguments to the script. Returns output.

- - - -
- - - executeFSI workingDirectory script env - -
- Signature: workingDirectory:string -> script:string -> env:seq<string * string> -> bool * seq<ConsoleMessage>
-
-
- - - - -

Run the given buildscript with fsi.exe

- - - -
- - - executeFSIWithArgs (...) - -
- Signature: workingDirectory:string -> script:string -> extraFsiArgs:string list -> env:seq<string * string> -> bool
-
-
- - - - -

Run the given build script with fsi.exe and allows for extra arguments to FSI.

- - - -
- - - executeFSIWithScriptArgsAndReturnMessages (...) - -
- Signature: script:string -> scriptArgs:string [] -> bool * seq<ConsoleMessage>
-
-
- - - - -

Run the given build script with fsi.exe and allows for extra arguments to the script. Returns output.

- - - -
- - - fsiPath - -
- Signature: string
-
-
- - - - -

The path to the F# Interactive tool.

- - - -
- - - fsiStartInfo (...) - -
- Signature: script:string -> workingDirectory:string -> env:seq<string * string> -> info:ProcessStartInfo -> unit
-
-
- - - - -

Creates a ProcessStartInfo which is configured to the F# Interactive.

- - - -
- - - getAllScriptContents pathsAndContents - -
- Signature: pathsAndContents:seq<Script> -> seq<string>
-
-
- - - - - -
- - - getAllScripts scriptPath - -
- Signature: scriptPath:string -> seq<Script>
-
-
- - - - - -
- - - getIncludedAssembly scriptContents - -
- Signature: scriptContents:string -> seq<string>
-
-
- - - - - -
- - - getScriptHash pathsAndContents - -
- Signature: pathsAndContents:seq<Script> -> string
-
-
- - - - - -
- - - getSearchPaths scriptContents - -
- Signature: scriptContents:string -> seq<string>
-
-
- - - - - -
- - - hashRegex - -
- Signature: Regex
-
-
- - - - - -
- - - loadRegex - -
- Signature: Regex
-
-
- - - - - -
- - - rAssemblyRegex - -
- Signature: Regex
-
-
- - - - - -
- - - runBuildScript (...) - -
- Signature: printDetails:bool -> script:string -> extraFsiArgs:string list -> env:seq<string * string> -> useCache:bool -> cleanCache:bool -> bool
-
-
- - - - -

Run the given buildscript with fsi.exe

- - - -
- - - runBuildScriptAt (...) - -
- Signature: printDetails:bool -> script:string -> extraFsiArgs:string list -> env:seq<string * string> -> useCache:bool -> cleanCache:bool -> bool
-
-
- - - - -

Run the given buildscript with fsi.exe at the given working directory.

- - - -
- - - runBuildScriptWithFsiArgsAt (...) - -
- Signature: printDetails:bool -> FsiArgs -> env:seq<string * string> -> useCache:bool -> cleanCache:bool -> bool
-
-
- - - - -

Run the given buildscript with fsi.exe at the given working directory. Provides full access to Fsi options and args.

- - - -
- - - searchPathRegex - -
- Signature: Regex
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-ftphelper-ftpserverinfo.html b/packages/FAKE.4.11.3/docs/apidocs/fake-ftphelper-ftpserverinfo.html deleted file mode 100644 index 2ece54c..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-ftphelper-ftpserverinfo.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - FtpServerInfo - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-ftphelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-ftphelper.html deleted file mode 100644 index 5f8f79b..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-ftphelper.html +++ /dev/null @@ -1,387 +0,0 @@ - - - - - FtpHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

FtpHelper

-
-

Contains helpers which allow to upload a whole folder/specific file into a FTP Server. -Uses Passive Mode FTP and handles all files as binary (and not ASCII). -Assumes direct network connectivity to destination FTP server (not via a proxy). -Does not support FTPS and SFTP.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- FtpServerInfo -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - createAFolder server user pwd destPath - -
- Signature: server:string -> user:string -> pwd:string -> destPath:string -> unit
-
-
- - - - -

Creates a matching folder in FTP folder, if not already present.

- -

Parameters

- -
    -
  • destPath - The full name of folder which needs to be created, including all its parent folders
  • -
  • server - FTP Server name (ex: "ftp://10.100.200.300:21/")
  • -
  • user - FTP Server login name (ex: "joebloggs")
  • -
  • pwd - FTP Server login password (ex: "J0Eblogg5")
  • -
- - - -
- - - deleteAFile server user pwd destPath - -
- Signature: server:string -> user:string -> pwd:string -> destPath:string -> unit
-
-
- - - - -

Deletes a single file from remote FTP folder.

- -

Parameters

- -
    -
  • destPath - The full path to the file which needs to be deleted, including all its parent folders
  • -
  • server - FTP Server name (ex: "ftp://10.100.200.300:21/")
  • -
  • user - FTP Server login name (ex: "joebloggs")
  • -
  • pwd - FTP Server login password (ex: "J0Eblogg5")
  • -
- - - -
- - - deleteAFolder server user pwd destPath - -
- Signature: server:string -> user:string -> pwd:string -> destPath:string -> unit
-
-
- - - - -

Deletes a single folder from remote FTP folder.

- -

Parameters

- -
    -
  • destPath - The full path to the folder which needs to be deleted, including all its parent folders
  • -
  • server - FTP Server name (ex: "ftp://10.100.200.300:21/")
  • -
  • user - FTP Server login name (ex: "joebloggs")
  • -
  • pwd - FTP Server login password (ex: "J0Eblogg5")
  • -
- - - -
- - - getFtpDirContents (...) - -
- Signature: server:string -> user:string -> pwd:string -> dirPath:string -> string
-
-
- - - - -

Gets the contents/listing of files and folders in a given FTP server folder

- -

Parameters

- -
    -
  • dirPath - The full name of folder whose content need to be listed
  • -
  • server - FTP Server name (ex: "ftp://10.100.200.300:21/")
  • -
  • user - FTP Server login name (ex: "joebloggs")
  • -
  • pwd - FTP Server login password (ex: "J0Eblogg5")
  • -
- - - -
- - - getServerInfo (...) - -
- Signature: serverNameIp:string -> user:string -> password:string -> ftpMethod:string -> FtpServerInfo
-
-
- - - - -

Gets a connection to the FTP server

- - - -
- - - isFolderPresent server user pwd destPath - -
- Signature: server:string -> user:string -> pwd:string -> destPath:string -> bool
-
-
- - - - -

Given a folder path, will check if that folder is present at a given root directory of a FTP server.

- -

Parameters

- -
    -
  • destPath - The full name of folder which needs to be checked for existance, including all its parent folders
  • -
  • server - FTP Server name (ex: "ftp://10.100.200.300:21/")
  • -
  • user - FTP Server login name (ex: "joebloggs")
  • -
  • pwd - FTP Server login password (ex: "J0Eblogg5")
  • -
- - - -
- - - regexCheck fname ftpContents - -
- Signature: fname:string -> ftpContents:string -> bool
-
-
- - - - -

Checks to see if the ftp content string containts the string Given_Folder_Name

- - - -
- - - uploadAFile (...) - -
- Signature: server:string -> user:string -> pwd:string -> destPath:string -> srcPath:string -> unit
-
-
- - - - -

Uploads a single file from local directory into remote FTP folder.

- -

Parameters

- -
    -
  • destPath - The full local file path that needs to be uploaded
  • -
  • srcPath - The full path to file which needs to be created, including all its parent folders
  • -
  • server - FTP Server name (ex: "ftp://10.100.200.300:21/")
  • -
  • user - FTP Server login name (ex: "joebloggs")
  • -
  • pwd - FTP Server login password (ex: "J0Eblogg5")
  • -
- - - -
- - - uploadAFolder (...) - -
- Signature: server:string -> user:string -> pwd:string -> srcPath:string -> rootDir:string -> unit
-
-
- - - - -

Uploads a given local folder to a given root dir on a FTP server.

- -

Parameters

- -
    -
  • srcPath - The local server path from which files need to be uploaded
  • -
  • rootDir - The remote root dir where files need to be uploaded, leave this as empty, if files need to be uploaded to root dir of FTP server
  • -
  • server - FTP Server name (ex: "ftp://10.100.200.300:21/")
  • -
  • user - FTP Server login name (ex: "joebloggs")
  • -
  • pwd - FTP Server login password (ex: "J0Eblogg5")
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-fxcophelper-fxcoperrorlevel.html b/packages/FAKE.4.11.3/docs/apidocs/fake-fxcophelper-fxcoperrorlevel.html deleted file mode 100644 index 6d7b51c..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-fxcophelper-fxcoperrorlevel.html +++ /dev/null @@ -1,224 +0,0 @@ - - - - - FxCopErrorLevel - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

FxCopErrorLevel

-
-

The FxCop error reporting level

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - CriticalError - -
- Signature: FxCopErrorLevel
- Modifiers: static
-
-
- - - - - -
- - - CriticalWarning - -
- Signature: FxCopErrorLevel
- Modifiers: static
-
-
- - - - - -
- - - DontFailBuild - -
- Signature: FxCopErrorLevel
- Modifiers: static
-
-
- - - - - -
- - - Error - -
- Signature: FxCopErrorLevel
- Modifiers: static
-
-
- - - - - -
- - - ToolError - -
- Signature: FxCopErrorLevel
- Modifiers: static
-
-
- - - - - -
- - - Warning - -
- Signature: FxCopErrorLevel
- Modifiers: static
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-fxcophelper-fxcopparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-fxcophelper-fxcopparams.html deleted file mode 100644 index 96a233e..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-fxcophelper-fxcopparams.html +++ /dev/null @@ -1,542 +0,0 @@ - - - - - FxCopParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

FxCopParams

-
-

Parameter type for the FxCop tool

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ApplyOutXsl - -
- Signature: bool
-
-
- - - - - -
- - - ConsoleXslFileName - -
- Signature: string
-
-
- - - - - -
- - - CustomDictionary - -
- Signature: string
-
-
- - - - - -
- - - CustomRuleset - -
- Signature: string
-
-
- - - - - -
- - - DependencyDirectories - -
- Signature: seq<string>
-
-
- - - - - -
- - - DirectOutputToConsole - -
- Signature: bool
-
-
- - - - - -
- - - FailOnError - -
- Signature: FxCopErrorLevel
-
-
- - - - - -
- - - ForceOutput - -
- Signature: bool
-
-
- - - - - -
- - - IgnoreGeneratedCode - -
- Signature: bool
-
-
- - - - - -
- - - ImportFiles - -
- Signature: seq<string>
-
-
- - - - - -
- - - IncludeSummaryReport - -
- Signature: bool
-
-
- - - - - -
- - - OutputXslFileName - -
- Signature: string
-
-
- - - - - -
- - - PlatformDirectory - -
- Signature: string
-
-
- - - - - -
- - - ProjectFile - -
- Signature: string
-
-
- - - - - -
- - - ReportFileName - -
- Signature: string
-
-
- - - - - -
- - - RuleLibraries - -
- Signature: seq<string>
-
-
- - - - - -
- - - Rules - -
- Signature: seq<string>
-
-
- - - - - -
- - - SaveResultsInProjectFile - -
- Signature: bool
-
-
- - - - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - - -
- - - TypeList - -
- Signature: seq<string>
-
-
- - - - - -
- - - UseGACSwitch - -
- Signature: bool
-
-
- - - - - -
- - - Verbose - -
- Signature: bool
-
-
- - - - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-fxcophelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-fxcophelper.html deleted file mode 100644 index cdce641..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-fxcophelper.html +++ /dev/null @@ -1,184 +0,0 @@ - - - - - FxCopHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

FxCopHelper

-
-

Contains a task which can be used to run FxCop on .NET assemblies. There is also a tutorial for this task available.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - -
TypeDescription
- FxCopErrorLevel -

The FxCop error reporting level

- - -
- FxCopParams -

Parameter type for the FxCop tool

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - FxCop setParams assemblies - -
- Signature: setParams:(FxCopParams -> FxCopParams) -> assemblies:seq<string> -> unit
-
-
- - - - -

Run FxCop on a group of assemblies.

- - - -
- - - FxCopDefaults - -
- Signature: FxCopParams
-
-
- - - - -

FxCop Default parameters

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-gachelper-gacparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-gachelper-gacparams.html deleted file mode 100644 index 7937394..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-gachelper-gacparams.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - GACParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

GACParams

-
-

GAC parameters

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - -

The timeout for the process.

- - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - -

(Required) Path to the gacutil

- - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - -

The directory where the process will be started.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-gachelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-gachelper.html deleted file mode 100644 index 6f129a4..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-gachelper.html +++ /dev/null @@ -1,214 +0,0 @@ - - - - - GACHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

GACHelper

-
-

This module contains helper function for the GAC

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- GACParams -

GAC parameters

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - GAC setParams command - -
- Signature: setParams:(GACParams -> GACParams) -> command:string -> unit
-
-
- - - - -

Runs gacutil with the given command.

- - - -
- - - GACDefaults - -
- Signature: GACParams
-
-
- - - - -

GACutil default parameters

- - - -
- - - GACUtil - -
- Signature: string
-
-
- - - - - -
- - - gacutilToolPath - -
- Signature: string
-
-
- - - - -

Path to newest gacutil.exe

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-gallio-gallioparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-gallio-gallioparams.html deleted file mode 100644 index 55898e8..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-gallio-gallioparams.html +++ /dev/null @@ -1,592 +0,0 @@ - - - - - GallioParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

GallioParams

-
-
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ApplicationBaseDirectory - -
- Signature: DirectoryInfo
-
-
- - - - -

Gets or sets the relative or absolute path of the application base directory, -or null to use a default value selected by the consumer.

- - - -
- - - Debug - -
- Signature: bool option
-
-
- - - - -

Attaches the debugger to the test process when set to true.

- - - -
- - - DoNotRun - -
- Signature: bool
-
-
- - - - -

Sets whether to load the tests but not run them.

- - - -
- - - EchoResults - -
- Signature: bool
-
-
- - - - -

Sets whether to echo results to the screen as tests finish.

- - - -
- - - Filters - -
- Signature: string
-
-
- - - - -

Test filters (i.e. exclusion rules)

- - - -
- - - HintDirectories - -
- Signature: seq<string>
-
-
- - - - -

The list of directories used for loading referenced assemblies and other dependent resources.

- - - -
- - - IgnoreAnnotations - -
- Signature: bool
-
-
- - - - -

Sets whether to ignore annotations when determining the result code.

- - - -
- - - PluginDirectories - -
- Signature: seq<string>
-
-
- - - - -

Additional Gallio plugin directories to search recursively.

- - - -
- - - ReportArchive - -
- Signature: ReportArchiveMode option
-
-
- - - - - -
- - - ReportDirectory - -
- Signature: string
-
-
- - - - -

Sets the name of the directory where the reports will be put. -The directory will be created if it doesn't exist. Existing files will be overwritten. -The default report directory is "Reports".

- - - -
- - - ReportFormatterOptions - -
- Signature: (string * string) list
-
-
- - - - -

Specifies option property key/value pairs for the report formatter

- - - -
- - - ReportNameFormat - -
- Signature: string
-
-
- - - - -

Sets the format string to use to generate the reports filenames. -Any occurence of {0} will be replaced by the date, and any occurrence of {1} by the time. -The default format string is test-report-{0}-{1}.

- - - -
- - - RunnerExtensions - -
- Signature: string list
-
-
- - - - -

Specifies the type, assembly, and parameters of custom test runner -extensions to use during the test run. -The value must be in the form '[Namespace.]Type,Assembly[;Parameters]'

- - - -
- - - RunnerType - -
- Signature: string
-
-
- - - - -

The types supported "out of the box" are: Local, IsolatedAppDomain -and IsolatedProcess (default), but more types could be available as plugins.

- - - -
- - - RunTimeLimit - -
- Signature: TimeSpan option
-
-
- - - - -

Sets the maximum amount of time (in seconds) the tests can run -before they are canceled.

- - - -
- - - RuntimeVersion - -
- Signature: string
-
-
- - - - -

Gets or sets the version of the .Net runtime to use for running tests. -For the CLR, this must be the name of one of the framework directories in %SystemRoot%\Microsoft.Net\Framework. eg. 'v2.0.50727'. -The default is null which uses the most recent installed and supported framework.

- - - -
- - - ShadowCopy - -
- Signature: bool option
-
-
- - - - -

Shadow copying allows the original assemblies to be modified while the tests are running. -However, shadow copying may occasionally cause some tests to fail if they depend on their original location.

- - - -
- - - ShowReports - -
- Signature: bool
-
-
- - - - -

Sets whether to show generated reports in a window using the default system application -registered to the report file type.

- - - -
- - - TestExecutionOptions - -
- Signature: (string * string) list
-
-
- - - - - -
- - - TestExplorationOptions - -
- Signature: (string * string) list
-
-
- - - - - -
- - - TestRunnerOptions - -
- Signature: (string * string) list
-
-
- - - - -

Specifies option property key/value pairs for the test runner.

- - - -
- - - Verbosity - -
- Signature: Verbosity
-
-
- - - - - -
- - - WorkingDirectory - -
- Signature: DirectoryInfo
-
-
- - - - -

Gets or sets the relative or absolute path of the working directory -or null to use a default value selected by the consumer.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-gallio-reportarchivemode.html b/packages/FAKE.4.11.3/docs/apidocs/fake-gallio-reportarchivemode.html deleted file mode 100644 index b93d41b..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-gallio-reportarchivemode.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - ReportArchiveMode - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-gallio-verbosity.html b/packages/FAKE.4.11.3/docs/apidocs/fake-gallio-verbosity.html deleted file mode 100644 index 0ac6e25..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-gallio-verbosity.html +++ /dev/null @@ -1,179 +0,0 @@ - - - - - Verbosity - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-gallio.html b/packages/FAKE.4.11.3/docs/apidocs/fake-gallio.html deleted file mode 100644 index 4b358ab..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-gallio.html +++ /dev/null @@ -1,181 +0,0 @@ - - - - - Gallio - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Gallio

-
-
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - -
TypeDescription
- GallioParams -
- ReportArchiveMode -
- Verbosity -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - GallioDefaults - -
- Signature: GallioParams
-
-
- - - - -

Default Gallio parameters

- - - -
- - - Run setParam assemblies - -
- Signature: setParam:(GallioParams -> GallioParams) -> assemblies:seq<string> -> unit
-
-
- - - - -

Runs tests through Gallio.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-git-branches.html b/packages/FAKE.4.11.3/docs/apidocs/fake-git-branches.html deleted file mode 100644 index 835ae4a..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-git-branches.html +++ /dev/null @@ -1,605 +0,0 @@ - - - - - Branches - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Branches

-
-

Contains helper functions which allow to deal with git branches.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - checkout repositoryDir create branch - -
- Signature: repositoryDir:string -> create:bool -> branch:string -> unit
-
-
- - - - -

Performs a checkout of the given branch to the working copy.

- -

Parameters

- -
    -
  • repositoryDir - The git repository.
  • -
  • create - Set this to true if the branch is new.
  • -
  • branch - The new branch.
  • -
- - - -
- - - checkoutBranch repositoryDir branch - -
- Signature: repositoryDir:string -> branch:string -> unit
-
-
- - - - -

Performs a checkout of the given branch to the working copy.

- -

Parameters

- -
    -
  • repositoryDir - The git repository.
  • -
  • branch - The branch for the checkout.
  • -
- - - -
- - - checkoutNewBranch (...) - -
- Signature: repositoryDir:string -> baseBranch:string -> branch:string -> unit
-
-
- - - - -

Creates a new branch based on the given baseBranch and checks it out to the working copy.

- -

Parameters

- -
    -
  • repositoryDir - The git repository.
  • -
  • baseBranch - The base branch.
  • -
  • branch - The new branch.
  • -
- - - -
- - - checkoutTracked (...) - -
- Signature: repositoryDir:string -> trackBranch:string -> branch:string -> unit
-
-
- - - - -

Performs a checkout of the given branch with an additional tracking branch.

- -

Parameters

- -
    -
  • repositoryDir - The git repository.
  • -
  • trackBranch - The tracking branch.
  • -
  • branch - The branch for the checkout.
  • -
- - - -
- - - createBranch (...) - -
- Signature: repositoryDir:string -> newBranchName:string -> commit:string -> unit
-
-
- - - - -

Creates a new branch from the given commit.

- -

Parameters

- -
    -
  • repositoryDir - The git repository.
  • -
  • newBranchName - The new branch.
  • -
  • commit - The commit which git should take as the new HEAD. - can be HEAD, HEAD~1, ... , a branch name or a prefix of a SHA1.
  • -
- - - -
- - - deleteBranch repositoryDir force branch - -
- Signature: repositoryDir:string -> force:bool -> branch:string -> unit
-
-
- - - - -

Deletes the given branch.

- -

Parameters

- -
    -
  • repositoryDir - The git repository.
  • -
  • force - Determines if git should be run with the force flag.
  • -
  • branch - The branch which should be deleted.
  • -
- - - -
- - - deleteTag repositoryDir tag - -
- Signature: repositoryDir:string -> tag:string -> unit
-
-
- - - - -

Deletes the given tag.

- -

Parameters

- -
    -
  • repositoryDir - The git repository.
  • -
  • tag - The tag which should be deleted.
  • -
- - - -
- - - findMergeBase (...) - -
- Signature: repositoryDir:string -> commit1:string -> commit2:string -> string
-
-
- - - - -

Returns the SHA1 of the merge base of the two given commits from the given repository.

- -

Parameters

- -
    -
  • repositoryDir - The git repository.
  • -
  • commit1 - The first commit for which git should find the merge base.
  • -
  • commit2 - The second commit for which git should find the merge base.
  • -
- - - -
- - - getAllBranches repositoryDir - -
- Signature: repositoryDir:string -> string list
-
-
- - - - -

Gets all local and remote branches from the given repository.

- - - -
- - - getLocalBranches repositoryDir - -
- Signature: repositoryDir:string -> string list
-
-
- - - - -

Gets all local branches from the given repository.

- - - -
- - - getRemoteBranches repositoryDir - -
- Signature: repositoryDir:string -> string list
-
-
- - - - -

Gets all remote branches from the given repository.

- - - -
- - - getSHA1 repositoryDir commit - -
- Signature: repositoryDir:string -> commit:string -> string
-
-
- - - - -

Returns the SHA1 of the given commit from the given repository.

- -

Parameters

- -
    -
  • repositoryDir - The git repository.
  • -
  • commit - The commit for which git should return the SHA1 - can be HEAD, HEAD~1, ... , a branch name or a prefix of a SHA1.
  • -
- - - -
- - - pull repositoryDir remote branch - -
- Signature: repositoryDir:string -> remote:string -> branch:string -> unit
-
-
- - - - -

Pulls a given branch from the given remote.

- -

Parameters

- -
    -
  • repositoryDir - The git repository.
  • -
  • remote - The name of the remote.
  • -
  • branch - The name of the branch to pull.
  • -
- - - -
- - - push repositoryDir - -
- Signature: repositoryDir:string -> unit
-
-
- - - - -

Pushes all branches to the default remote.

- -

Parameters

- -
    -
  • repositoryDir - The git repository.
  • -
- - - -
- - - pushBranch repositoryDir remote branch - -
- Signature: repositoryDir:string -> remote:string -> branch:string -> unit
-
-
- - - - -

Pushes the given branch to the given remote.

- -

Parameters

- -
    -
  • repositoryDir - The git repository.
  • -
  • remote - The remote.
  • -
  • branch - The branch.
  • -
- - - -
- - - pushTag repositoryDir remote tag - -
- Signature: repositoryDir:string -> remote:string -> tag:string -> unit
-
-
- - - - -

Pushes the given tag to the given remote.

- -

Parameters

- -
    -
  • repositoryDir - The git repository.
  • -
  • remote - The remote.
  • -
  • tag - The tag.
  • -
- - - -
- - - revisionsBetween (...) - -
- Signature: repositoryDir:string -> commit1:string -> commit2:string -> int
-
-
- - - - -

Returns the number of revisions between the two given commits.

- -

Parameters

- -
    -
  • repositoryDir - The git repository.
  • -
  • commit1 - The first commit for which git should find the merge base.
  • -
  • commit2 - The second commit for which git should find the merge base.
  • -
- - - -
- - - tag repositoryDir tag - -
- Signature: repositoryDir:string -> tag:string -> unit
-
-
- - - - -

Tags the current branch.

- -

Parameters

- -
    -
  • repositoryDir - The git repository.
  • -
  • tag - The new tag.
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-git-commandhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-git-commandhelper.html deleted file mode 100644 index 0d72275..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-git-commandhelper.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - CommandHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

CommandHelper

-
-

Contains helpers which allow to interact with git via the command line.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - directRunGitCommand (...) - -
- Signature: repositoryDir:string -> command:string -> bool
-
-
- - - - -

Runs the given git command, waits for its completion and returns whether it succeeded.

- - - -
- - - findGitDir repositoryDir - -
- Signature: repositoryDir:string -> DirectoryInfo
-
-
- - - - -

Searches the .git directory recursivly up to the root.

- - - -
- - - fireAndForgetGitCommand (...) - -
- Signature: repositoryDir:string -> command:string -> unit
-
-
- - - - -

Fires the given git command ind the given repository directory and returns immediatly.

- - - -
- - - gitCommand repositoryDir command - -
- Signature: repositoryDir:string -> command:string -> unit
-
-
- - - - -

Runs the given git command, waits for its completion.

- - - -
- - - gitPath - -
- Signature: string
-
-
- - - - -

Tries to locate the git.exe via the eviroment variable "GIT".

- - - -
- - - gitTimeOut - -
- Signature: TimeSpan
-
-
- - - - -

Specifies a global timeout for git.exe - default is no timeout

- - - -
- - - runGitCommand repositoryDir command - -
- Signature: repositoryDir:string -> command:string -> bool * List<string> * string
-
-
- - - - -

Runs git.exe with the given command in the given repository directory.

- - - -
- - - runSimpleGitCommand (...) - -
- Signature: repositoryDir:string -> command:string -> string
-
-
- - - - -

Runs the git command and returns the first line of the result.

- - - -
- - - showGitCommand repositoryDir command - -
- Signature: repositoryDir:string -> command:string -> unit
-
-
- - - - -

Runs the given git command, waits for its completion. -This version doesn't throw an exception if an error occurs. It just traces the error.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-git-commit.html b/packages/FAKE.4.11.3/docs/apidocs/fake-git-commit.html deleted file mode 100644 index 823b896..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-git-commit.html +++ /dev/null @@ -1,134 +0,0 @@ - - - - - Commit - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Commit

-
-

Contains helper functions which allow to commit to git repositories.

- - -
- - - -

Functions and values

- - - - - - - - - - -
Function or valueDescription
- - - Commit repositoryDir message - -
- Signature: repositoryDir:string -> message:string -> unit
-
-
- - - - -

Commits all files in the given repository with the given message

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-git-commitmessage.html b/packages/FAKE.4.11.3/docs/apidocs/fake-git-commitmessage.html deleted file mode 100644 index f5a5f0d..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-git-commitmessage.html +++ /dev/null @@ -1,176 +0,0 @@ - - - - - CommitMessage - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

CommitMessage

-
-

Contains helper functions which allow to get and set the git commit message.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - getCommitMessage repositoryDir - -
- Signature: repositoryDir:string -> string
-
-
- - - - -

Gets the commit message

- - - -
- - - getCommitMessageFileInfo repositoryDir - -
- Signature: repositoryDir:string -> FileInfo
-
-
- - - - -

Returns the commit message file.

- - - -
- - - setMessage repositoryDir text - -
- Signature: repositoryDir:string -> text:string -> unit
-
-
- - - - -

Sets the commit message

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-git-filestatus-filestatus.html b/packages/FAKE.4.11.3/docs/apidocs/fake-git-filestatus-filestatus.html deleted file mode 100644 index 8360847..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-git-filestatus-filestatus.html +++ /dev/null @@ -1,190 +0,0 @@ - - - - - FileStatus - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

FileStatus

-
-

A type which represents a file status in git.

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - Added - -
- Signature:
-
-
- - - - - -
- - - Deleted - -
- Signature:
-
-
- - - - - -
- - - Modified - -
- Signature:
-
-
- - - - - -
-

Static members

- - - - - - - - - - -
Static memberDescription
- - - Parse - -
- Signature: string -> FileStatus
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-git-filestatus.html b/packages/FAKE.4.11.3/docs/apidocs/fake-git-filestatus.html deleted file mode 100644 index 4e77706..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-git-filestatus.html +++ /dev/null @@ -1,322 +0,0 @@ - - - - - FileStatus - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

FileStatus

-
-

Contains helper functions which can be used to retrieve file status information from git.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- FileStatus -

A type which represents a file status in git.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - cleanWorkingCopy repositoryDir - -
- Signature: repositoryDir:string -> unit
-
-
- - - - -

Cleans the working copy by doing a git reset --hard and a clean -f.

- - - -
- - - getAllFiles repositoryDir - -
- Signature: repositoryDir:string -> seq<FileStatus * string>
-
-
- - - - -

Gets all changed files in the current revision

- - - -
- - - getChangedFiles (...) - -
- Signature: repositoryDir:string -> revision1:string -> revision2:string -> seq<FileStatus * string>
-
-
- - - - -

Gets the changed files between the given revisions

- - - -
- - - getChangedFilesInWorkingCopy (...) - -
- Signature: repositoryDir:string -> revision:string -> seq<FileStatus * string>
-
-
- - - - -

Gets the changed files since the given revision incl. changes in the working copy

- - - -
- - - getConflictedFiles repositoryDir - -
- Signature: repositoryDir:string -> string list
-
-
- - - - -

Gets all conflicted files

- - - -
- - - getRebaseDir repositoryDir - -
- Signature: repositoryDir:string -> string
-
-
- - - - -

Returns the current rebase directory for the given repository.

- - - -
- - - isInTheMiddleOfConflictedMerge (...) - -
- Signature: repositoryDir:string -> bool
-
-
- - - - -

Returns true if the working copy is in a conflicted merge otherwise false

- - - -
- - - isInTheMiddleOfPatch repositoryDir - -
- Signature: repositoryDir:string -> bool
-
-
- - - - -

Returns true if the given repository is in the middle of a patch process.

- - - -
- - - isInTheMiddleOfRebase repositoryDir - -
- Signature: repositoryDir:string -> bool
-
-
- - - - -

Returns true if the given repository is in the middle of a rebase process.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-git-information.html b/packages/FAKE.4.11.3/docs/apidocs/fake-git-information.html deleted file mode 100644 index 07e8489..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-git-information.html +++ /dev/null @@ -1,398 +0,0 @@ - - - - - Information - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Information

-
-

Contains helper functions which can be used to retrieve status information from git.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - describe repositoryDir - -
- Signature: repositoryDir:string -> string
-
-
- - - - -

Gets the last git tag by calling git describe

- - - -
- - - getBranchName repositoryDir - -
- Signature: repositoryDir:string -> string
-
-
- - - - -

Gets the git branch name

- - - -
- - - getCurrentHash () - -
- Signature: unit -> string
-
-
- - - - -

Gets the current hash of the current repository

- - - -
- - - getCurrentSHA1 repositoryDir - -
- Signature: repositoryDir:string -> string
-
-
- - - - -

Returns the SHA1 of the current HEAD

- - - -
- - - getLastTag () - -
- Signature: unit -> string
-
-
- - - - -

Gets the last git tag of the current repository by calling git describe

- - - -
- - - getVersion repositoryDir - -
- Signature: repositoryDir:string -> string
-
-
- - - - -

Gets the git version

- - - -
- - - isAheadOf repositoryDir rev1 rev2 - -
- Signature: repositoryDir:string -> rev1:string -> rev2:string -> bool
-
-
- - - - -

Returns true if rev1 is ahead of rev2

- - - -
- - - isCleanWorkingCopy repositoryDir - -
- Signature: repositoryDir:string -> bool
-
-
- - - - -

Checks if the working copy is clean

- - - -
- - - isGitVersionHigherOrEqual (...) - -
- Signature: referenceVersion:string -> bool
-
-
- - - - - -
- - - isVersionHigherOrEqual (...) - -
- Signature: currentVersion:string -> referenceVersion:string -> bool
-
-
- - - - - -
- - - shortlog repositoryDir - -
- Signature: repositoryDir:string -> string
-
-
- - - - -

Gets the git log in one line

- - - -
- - - showName repositoryDir sha1 - -
- Signature: repositoryDir:string -> sha1:string -> string
-
-
- - - - -

Returns a friendly name from a SHA1

- - - -
- - - showStatus repositoryDir - -
- Signature: repositoryDir:string -> unit
-
-
- - - - -

Shows the git status

- - - -
- - - versionRegex - -
- Signature: Regex
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-git-merge-mergetype.html b/packages/FAKE.4.11.3/docs/apidocs/fake-git-merge-mergetype.html deleted file mode 100644 index ca34c0f..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-git-merge-mergetype.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - MergeType - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MergeType

-
-

Git merge option.

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - FirstNeedsFastForward - -
- Signature:
-
-
- - - - - -
- - - NeedsRealMerge - -
- Signature:
-
-
- - - - - -
- - - SameCommit - -
- Signature:
-
-
- - - - - -
- - - SecondNeedsFastForward - -
- Signature:
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-git-merge.html b/packages/FAKE.4.11.3/docs/apidocs/fake-git-merge.html deleted file mode 100644 index 168e631..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-git-merge.html +++ /dev/null @@ -1,256 +0,0 @@ - - - - - Merge - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Merge

-
-

Contains helper functions which allow to deal with git merge.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- MergeType -

Git merge option.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - compareBranches (...) - -
- Signature: repositoryDir:string -> local:string -> remote:string -> MergeType
-
-
- - - - -

Tests whether branches and their "origin" counterparts have diverged and need merging first.

- -

Parameters

- -
    -
  • repositoryDir - The git repository.
  • -
  • local - The local branch name.
  • -
  • remote - The remote branch name.
  • -
- - - -
- - - FastForwardFlag - -
- Signature: string
-
-
- - - - -

Allows git to use fast-forward merges

- - - -
- - - getMergeMessage repositoryDir - -
- Signature: repositoryDir:string -> string
-
-
- - - - -

Gets the current merge message.

- - - -
- - - merge repositoryDir flags branch - -
- Signature: repositoryDir:string -> flags:string -> branch:string -> unit
-
-
- - - - -

Performs a merge of the given branch with the current branch

- -

Parameters

- -
    -
  • repositoryDir - The git repository.
  • -
  • flags - Additional flags.
  • -
  • branch - The branch we want to merge in.

    -

    Sample

    -

    merge @"C:\code\Fake" NoFastForwardFlag "master"

  • -
- - - -
- - - NoFastForwardFlag - -
- Signature: string
-
-
- - - - -

Forbids git to use fast-forward merges

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-git-rebase.html b/packages/FAKE.4.11.3/docs/apidocs/fake-git-rebase.html deleted file mode 100644 index 579a2b3..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-git-rebase.html +++ /dev/null @@ -1,220 +0,0 @@ - - - - - Rebase - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Rebase

-
-

Contains helper functions which allow to deal with git rebase.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - abort repositoryDir - -
- Signature: repositoryDir:string -> unit
-
-
- - - - -

Restore the original branch and abort the rebase operation.

- - - -
- - - continueRebase repositoryDir - -
- Signature: repositoryDir:string -> unit
-
-
- - - - -

Restart the rebasing process after having resolved a merge conflict.

- - - -
- - - rebaseOrFallbackOnMerge (...) - -
- Signature: repositoryDir:string -> onTopOfBranch:string -> bool
-
-
- - - - -

Tries to rebase on top of the given branch. -If the rebasing process fails a normal merge will be started. -Returns if the process used merge instead of rebase.

- - - -
- - - skip repositoryDir - -
- Signature: repositoryDir:string -> unit
-
-
- - - - -

Restart the rebasing process by skipping the current patch.

- - - -
- - - start repositoryDir onTopOfBranch - -
- Signature: repositoryDir:string -> onTopOfBranch:string -> unit
-
-
- - - - -

Performs a rebase on top of the given branch with the current branch

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-git-repository.html b/packages/FAKE.4.11.3/docs/apidocs/fake-git-repository.html deleted file mode 100644 index b81447b..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-git-repository.html +++ /dev/null @@ -1,229 +0,0 @@ - - - - - Repository - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Repository

-
-

Contains functions which allow basic operations on git repositories. -All operations assume that the CommandHelper can find git.exe.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - clone workingDir repoUrl toPath - -
- Signature: workingDir:string -> repoUrl:string -> toPath:string -> unit
-
-
- - - - -

Clones a git repository.

- -

Parameters

- -
    -
  • workingDir - The working directory.
  • -
  • repoUrl - The URL to the origin.
  • -
  • toPath - Specifes the new target subfolder.
  • -
- - - -
- - - cloneSingleBranch (...) - -
- Signature: workingDir:string -> repoUrl:string -> branchName:string -> toPath:string -> unit
-
-
- - - - -

Clones a single branch of a git repository.

- -

Parameters

- -
    -
  • workingDir - The working directory.
  • -
  • repoUrl - The URL to the origin.
  • -
  • branchname - Specifes the target branch.
  • -
  • toPath - Specifes the new target subfolder.
  • -
- - - -
- - - fullclean repositoryDir - -
- Signature: repositoryDir:string -> unit
-
-
- - - - -

Cleans a directory by removing all files and sub-directories.

- -

Parameters

- -
    -
  • repositoryDir - The path of the directory to clean.
  • -
- - - -
- - - init repositoryDir bare shared - -
- Signature: repositoryDir:string -> bare:bool -> shared:bool -> unit
-
-
- - - - -

Inits a git repository.

- -

Parameters

- -
    -
  • repositoryDir - The path of the target directory.
  • -
  • bare - If the new directory is a bare directory.
  • -
  • shared - Specifies that the git repository is to be shared amongst several users. This allows users belonging to the same group to push into that repository.
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-git-reset.html b/packages/FAKE.4.11.3/docs/apidocs/fake-git-reset.html deleted file mode 100644 index 4946a21..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-git-reset.html +++ /dev/null @@ -1,287 +0,0 @@ - - - - - Reset - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Reset

-
-

Contains helper functions which allow to deal with git reset.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - hard repositoryDir commit file - -
- Signature: repositoryDir:string -> commit:string -> file:string -> unit
-
-
- - - - -

Performs a git reset "hard". -Resets the index and working tree. Any changes to tracked files in the working tree since are discarded.

- -

Parameters

- -
    -
  • repositoryDir - The git repository.
  • -
  • commit - The commit to which git should perform the reset.
  • -
  • file - The file to reset - null means all files.
  • -
- - - -
- - - mixed repositoryDir commit file - -
- Signature: repositoryDir:string -> commit:string -> file:string -> unit
-
-
- - - - -

Performs a git reset "mixed". -Resets the index but not the working tree and reports what has not been updated.

- -

Parameters

- -
    -
  • repositoryDir - The git repository.
  • -
  • commit - The commit to which git should perform the reset.
  • -
  • file - The file to reset - null means all files.
  • -
- - - -
- - - ResetHard repositoryDir - -
- Signature: repositoryDir:string -> unit
-
-
- - - - -

Performs a git reset "hard" to the current HEAD. -Resets the index and working tree. Any changes to tracked files in the working tree since are discarded.

- -

Parameters

- -
    -
  • repositoryDir - The git repository.
  • -
- - - -
- - - ResetMixed repositoryDir - -
- Signature: repositoryDir:string -> unit
-
-
- - - - -

Performs a git reset "mixed" to the current HEAD. -Resets the index but not the working tree and reports what has not been updated.

- -

Parameters

- -
    -
  • repositoryDir - The git repository.
  • -
- - - -
- - - ResetSoft repositoryDir - -
- Signature: repositoryDir:string -> unit
-
-
- - - - -

Performs a git reset "soft" to the current HEAD. -Does not touch the index file nor the working tree at all.

- -

Parameters

- -
    -
  • repositoryDir - The git repository.
  • -
- - - -
- - - soft repositoryDir commit file - -
- Signature: repositoryDir:string -> commit:string -> file:string -> unit
-
-
- - - - -

Performs a git reset "soft". -Does not touch the index file nor the working tree at all.

- -

Parameters

- -
    -
  • repositoryDir - The git repository.
  • -
  • commit - The commit to which git should perform the reset.
  • -
  • file - The file to reset - null means all files.
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-git-sanitychecks.html b/packages/FAKE.4.11.3/docs/apidocs/fake-git-sanitychecks.html deleted file mode 100644 index 8b765cf..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-git-sanitychecks.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - SanityChecks - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

SanityChecks

-
-

Contains helper function which can be used for sanity checks.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - checkIfBranchExists repositoryDir branch - -
- Signature: repositoryDir:string -> branch:string -> unit
-
-
- - - - -

Checks if the given branch exists.

- - - -
- - - checkIfBranchIsAbsent (...) - -
- Signature: repositoryDir:string -> branch:string -> unit
-
-
- - - - -

Checks if the given branch is absent.

- - - -
- - - checkIsLocalBranch repositoryDir branch - -
- Signature: repositoryDir:string -> branch:string -> unit
-
-
- - - - -

Checks if the given branch is a local branch.

- - - -
- - - checkIsRemoteBranch repositoryDir branch - -
- Signature: repositoryDir:string -> branch:string -> unit
-
-
- - - - -

Checks if the given branch is a remote branch.

- - - -
- - - checkRevisionExists (...) - -
- Signature: repositoryDir:string -> revision1:string -> unit
-
-
- - - - -

Checks if the given branch exists.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-git-sha1.html b/packages/FAKE.4.11.3/docs/apidocs/fake-git-sha1.html deleted file mode 100644 index d17eb7b..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-git-sha1.html +++ /dev/null @@ -1,177 +0,0 @@ - - - - - SHA1 - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

SHA1

-
-

Contains functions which allow the SHA1 of a file with git and without it.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - calcGitSHA1 text - -
- Signature: text:string -> string
-
-
- - - - -

Calculates the SHA1 for a given string like git.

- - - -
- - - calcSHA1 text - -
- Signature: text:string -> string
-
-
- - - - -

Calculates the SHA1 for a given string.

- - - -
- - - showObjectHash repositoryDir fileName - -
- Signature: repositoryDir:string -> fileName:string -> string
-
-
- - - - -

Shows the SHA1 calculated by git. -Assumes that the CommandHelper module can find git.exe.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-git-staging.html b/packages/FAKE.4.11.3/docs/apidocs/fake-git-staging.html deleted file mode 100644 index 2191dfe..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-git-staging.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - Staging - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Staging

-
-

Contains helper functions which allow to deal with git's staging area.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - StageAll repositoryDir - -
- Signature: repositoryDir:string -> unit
-
-
- - - - -

Adds all files to the staging area

- - - -
- - - StageFile repositoryDir file - -
- Signature: repositoryDir:string -> file:string -> bool * List<string> * string
-
-
- - - - -

Adds a file to the staging area

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-git-stash.html b/packages/FAKE.4.11.3/docs/apidocs/fake-git-stash.html deleted file mode 100644 index 995c312..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-git-stash.html +++ /dev/null @@ -1,158 +0,0 @@ - - - - - Stash - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Stash

-
-

Contains helper functions which allow to deal with git stash.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - pop repositoryDir - -
- Signature: repositoryDir:string -> unit
-
-
- - - - -

Remove a single stashed state from the stash list and -apply it on top of the current working tree state, -i.e., do the inverse operation of git stash save. -The working directory must match the index.

- - - -
- - - push repositoryDir message - -
- Signature: repositoryDir:string -> message:string -> unit
-
-
- - - - -

Stash the changes in a dirty working directory away.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-git-submodule-submodule.html b/packages/FAKE.4.11.3/docs/apidocs/fake-git-submodule-submodule.html deleted file mode 100644 index d7a8107..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-git-submodule-submodule.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - - Submodule - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Submodule

-
-

This record represents a git submodule binding.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Branch - -
- Signature: string
-
-
- - - - - -
- - - CurrentCommit - -
- Signature: string
-
-
- - - - - -
- - - Initialized - -
- Signature: bool
-
-
- - - - - -
- - - Name - -
- Signature: string
-
-
- - - - - -
- - - SuperRepositoryDir - -
- Signature: string
-
-
- - - - - -
- - - UpToDate - -
- Signature: bool
-
-
- - - - - -
-

Instance members

- - - - - - - - - - - - - - - - - - -
Instance memberDescription
- - - GetLocalPath() - -
- Signature: unit -> string
-
-
- - - - -

Gets the local path from the config.

- - - -
- - - GetRemotePath() - -
- Signature: unit -> string
-
-
- - - - -

Gets the remote path from the config.

- - - -
- - - Status - -
- Signature: string
-
-
- - - - -

Gets the current status.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-git-submodule.html b/packages/FAKE.4.11.3/docs/apidocs/fake-git-submodule.html deleted file mode 100644 index 35ef3f6..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-git-submodule.html +++ /dev/null @@ -1,212 +0,0 @@ - - - - - Submodule - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Submodule

-
-

Contains helper functions which allow to deal with git submodules.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- Submodule -

This record represents a git submodule binding.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - add (...) - -
- Signature: superRepositoryDir:string -> remotePath:string -> localPath:string -> branch:string -> unit
-
-
- - - - -

Adds a submodule to the given super repository.

- -

Parameters

- -
    -
  • superRepositoryDir - The super repository.
  • -
  • remotePath - The path to the remote repository of the submodule.
  • -
  • localPath - The local path to the submodule.
  • -
  • branch - The branch to clone. (can be null)
  • -
- - - -
- - - getSubModules repositoryDir - -
- Signature: repositoryDir:string -> seq<Submodule>
-
-
- - - - -

Gets all submodules from the given repository directory.

- - - -
- - - init superRepositoryDir name - -
- Signature: superRepositoryDir:string -> name:string -> unit
-
-
- - - - -

Inits a submodule with the given name in a subfolder of the given super repository.

- -

Parameters

- -
    -
  • superRepositoryDir - The super repository.
  • -
  • name - The name of the new repository.
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-globbing.html b/packages/FAKE.4.11.3/docs/apidocs/fake-globbing.html deleted file mode 100644 index 94de354..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-globbing.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - Globbing - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Globbing

-
-

This module contains a file pattern globbing implementation.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - globRegexCache - -
- Signature: ConcurrentDictionary<string,Regex>
-
-
- - - - - -
- - - isMatch pattern path - -
- Signature: pattern:string -> path:string -> bool
-
-
- - - - - -
- - - normalizePath path - -
- Signature: path:string -> string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-hipchatnotificationhelper-hipchatnotificationparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-hipchatnotificationhelper-hipchatnotificationparams.html deleted file mode 100644 index 470b02b..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-hipchatnotificationhelper-hipchatnotificationparams.html +++ /dev/null @@ -1,257 +0,0 @@ - - - - - HipChatNotificationParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

HipChatNotificationParams

-
-

The HipChat notification paramater type

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - AuthToken - -
- Signature: string
-
-
- - - - -

(Required) Auth token from HipChat

- - - -
- - - Color - -
- Signature: string
-
-
- - - - -

The background color for the message, which can be yellow, red, green, purple, gray, or random. Default value: yellow

- - - -
- - - From - -
- Signature: string
-
-
- - - - -

(Required) Name the message will appear to be sent from

- - - -
- - - Message - -
- Signature: string
-
-
- - - - -

(Required) The message body

- - - -
- - - MessageFormat - -
- Signature: string
-
-
- - - - -

The message format, which can either be text or html. Default value: text

- - - -
- - - Notify - -
- Signature: bool
-
-
- - - - -

Whether or not this message should trigger a notification for people in the room. Default value: false

- - - -
- - - RoomId - -
- Signature: string
-
-
- - - - -

(Required) ID or name of the room to send the notification to

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-hipchatnotificationhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-hipchatnotificationhelper.html deleted file mode 100644 index 49b9534..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-hipchatnotificationhelper.html +++ /dev/null @@ -1,181 +0,0 @@ - - - - - HipChatNotificationHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

HipChatNotificationHelper

-
-

Contains a task to send notification messages to a HipChat room

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- HipChatNotificationParams -

The HipChat notification paramater type

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - HipChatNotification setParams - -
- Signature: setParams:(HipChatNotificationParams -> HipChatNotificationParams) -> int
-
-
- - - - -

Sends a notification to a HipChat room

- -

Parameters

- -
    -
  • setParams - Function used to override the default notification parameters
  • -
- - - -
- - - HipChatNotificationDefaults - -
- Signature: HipChatNotificationParams
-
-
- - - - -

The default HipChat notification parameters

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-hockeyapphelper-downloadstatusoption.html b/packages/FAKE.4.11.3/docs/apidocs/fake-hockeyapphelper-downloadstatusoption.html deleted file mode 100644 index ae281d9..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-hockeyapphelper-downloadstatusoption.html +++ /dev/null @@ -1,148 +0,0 @@ - - - - - DownloadStatusOption - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

DownloadStatusOption

-
-

The release download status

- - -
-

Record Fields

- - - - - - - - - - - - - - -
Record FieldDescription
- - - Downloadable - -
- Signature: DownloadStatusOption
- Modifiers: static
-
-
- - - - - -
- - - NotDownloadable - -
- Signature: DownloadStatusOption
- Modifiers: static
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-hockeyapphelper-hockeyappuploadparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-hockeyapphelper-hockeyappuploadparams.html deleted file mode 100644 index 55e701a..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-hockeyapphelper-hockeyappuploadparams.html +++ /dev/null @@ -1,426 +0,0 @@ - - - - - HockeyAppUploadParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

HockeyAppUploadParams

-
-

The HockeyApp parameter type -Based on http://support.hockeyapp.net/kb/api/api-apps#upload-app

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ApiToken - -
- Signature: string
-
-
- - - - -

(Required) API token

- - - -
- - - BuildServerUrl - -
- Signature: string
-
-
- - - - -

Set to the URL of the build job on your build server

- - - -
- - - CommitSHA - -
- Signature: string
-
-
- - - - -

Set to the git commit sha for this build

- - - -
- - - DownloadStatus - -
- Signature: DownloadStatusOption
-
-
- - - - -

Release download status (can only be set with full-access tokens)

- - - -
- - - Dsym - -
- Signature: string
-
-
- - - - -

file data for dsym (IOS: *.dysm.zip or Android: mapping.txt)

- - - -
- - - File - -
- Signature: string
-
-
- - - - -

(Required) file data for the build (.ipa or .apk)

- - - -
- - - Mandatory - -
- Signature: MandatoryOption
-
-
- - - - -

Set version as mandatory

- - - -
- - - Notes - -
- Signature: string
-
-
- - - - -

Release notes for the build

- - - -
- - - NotesType - -
- Signature: NoteType
-
-
- - - - -

Release notes type for the build

- - - -
- - - Notify - -
- Signature: NotifyOption
-
-
- - - - -

Set the notify option

- - - -
- - - OwnerId - -
- Signature: string
-
-
- - - - -

Set the owner of the app

- - - -
- - - Private - -
- Signature: bool
-
-
- - - - -

Set to true to enable the private download page (default is false)

- - - -
- - - ReleaseType - -
- Signature: ReleaseType
-
-
- - - - -

Set the release type of the app

- - - -
- - - RepositoryUrl - -
- Signature: string
-
-
- - - - -

Set to your source repository

- - - -
- - - Teams - -
- Signature: string []
-
-
- - - - -

Restrict download to specific teams

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-hockeyapphelper-hockeyresponse.html b/packages/FAKE.4.11.3/docs/apidocs/fake-hockeyapphelper-hockeyresponse.html deleted file mode 100644 index 05d055e..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-hockeyapphelper-hockeyresponse.html +++ /dev/null @@ -1,290 +0,0 @@ - - - - - HockeyResponse - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

HockeyResponse

-
-

HockeyApp's success response

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - BundleIdentifier - -
- Signature: string
-
-
- - - - - -
- - - ConfigUrl - -
- Signature: string
-
-
- - - - - -
- - - DeviceFamily - -
- Signature: string
-
-
- - - - - -
- - - MinimumOSVersion - -
- Signature: string
-
-
- - - - - -
- - - Platform - -
- Signature: string
-
-
- - - - - -
- - - PublicIdentifier - -
- Signature: string
-
-
- - - - - -
- - - PublicUrl - -
- Signature: string
-
-
- - - - - -
- - - ReleaseType - -
- Signature: ReleaseType
-
-
- - - - - -
- - - Status - -
- Signature: int
-
-
- - - - - -
- - - Title - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-hockeyapphelper-mandatoryoption.html b/packages/FAKE.4.11.3/docs/apidocs/fake-hockeyapphelper-mandatoryoption.html deleted file mode 100644 index f5926f2..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-hockeyapphelper-mandatoryoption.html +++ /dev/null @@ -1,148 +0,0 @@ - - - - - MandatoryOption - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MandatoryOption

-
-

The mandatory options

- - -
-

Record Fields

- - - - - - - - - - - - - - -
Record FieldDescription
- - - Mandatory - -
- Signature: MandatoryOption
- Modifiers: static
-
-
- - - - - -
- - - NotMandatory - -
- Signature: MandatoryOption
- Modifiers: static
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-hockeyapphelper-notetype.html b/packages/FAKE.4.11.3/docs/apidocs/fake-hockeyapphelper-notetype.html deleted file mode 100644 index 0705b96..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-hockeyapphelper-notetype.html +++ /dev/null @@ -1,148 +0,0 @@ - - - - - NoteType - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-hockeyapphelper-notifyoption.html b/packages/FAKE.4.11.3/docs/apidocs/fake-hockeyapphelper-notifyoption.html deleted file mode 100644 index 18e04c5..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-hockeyapphelper-notifyoption.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - NotifyOption - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NotifyOption

-
-

The notification options

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - All - -
- Signature: NotifyOption
- Modifiers: static
-
-
- - - - - -
- - - CanInstallApp - -
- Signature: NotifyOption
- Modifiers: static
-
-
- - - - - -
- - - None - -
- Signature: NotifyOption
- Modifiers: static
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-hockeyapphelper-releasetype.html b/packages/FAKE.4.11.3/docs/apidocs/fake-hockeyapphelper-releasetype.html deleted file mode 100644 index 238de65..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-hockeyapphelper-releasetype.html +++ /dev/null @@ -1,186 +0,0 @@ - - - - - ReleaseType - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ReleaseType

-
-

The release type of the app

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Alpha - -
- Signature: ReleaseType
- Modifiers: static
-
-
- - - - - -
- - - Beta - -
- Signature: ReleaseType
- Modifiers: static
-
-
- - - - - -
- - - Enterprise - -
- Signature: ReleaseType
- Modifiers: static
-
-
- - - - - -
- - - Store - -
- Signature: ReleaseType
- Modifiers: static
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-hockeyapphelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-hockeyapphelper.html deleted file mode 100644 index 9c5e03c..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-hockeyapphelper.html +++ /dev/null @@ -1,236 +0,0 @@ - - - - - HockeyAppHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

HockeyAppHelper

-
-

Contains tasks to interact with HockeyApp

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- DownloadStatusOption -

The release download status

- - -
- HockeyAppUploadParams -

The HockeyApp parameter type -Based on http://support.hockeyapp.net/kb/api/api-apps#upload-app

- - -
- HockeyResponse -

HockeyApp's success response

- - -
- MandatoryOption -

The mandatory options

- - -
- NoteType -

The note types

- - -
- NotifyOption -

The notification options

- - -
- ReleaseType -

The release type of the app

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - HockeyApp setParams - -
- Signature: setParams:(HockeyAppUploadParams -> HockeyAppUploadParams) -> HockeyResponse
-
-
- - - - -

Uploads an app to HockeyApp

- -

Parameters

- -
    -
  • setParams - Function used to override the default parameters
  • -
- - - -
- - - HockeyAppUploadDefaults - -
- Signature: HockeyAppUploadParams
-
-
- - - - -

The default HockeyApp parameters

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-htmlhelpworkshophelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-htmlhelpworkshophelper.html deleted file mode 100644 index 8ca2862..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-htmlhelpworkshophelper.html +++ /dev/null @@ -1,141 +0,0 @@ - - - - - HTMLHelpWorkShopHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

HTMLHelpWorkShopHelper

-
-

Contains a task which allows to use HTML Help Workshop in order to compile a help project.

- - -
- - - -

Functions and values

- - - - - - - - - - -
Function or valueDescription
- - - CompileHTMLHelpProject (...) - -
- Signature: helpCompiler:string -> projectFile:string -> string list
-
-
- - - - -

Uses the HTML Help Workshop to compile a help project and returns the generated file names of the generated files.

- -

Parameters

- -
    -
  • helpCompiler - The filename of the HTML Help WorkShop tool.
  • -
  • projectFile - The fileName of the help project.
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-ilmergehelper-allowduplicatetypes.html b/packages/FAKE.4.11.3/docs/apidocs/fake-ilmergehelper-allowduplicatetypes.html deleted file mode 100644 index ac5d88a..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-ilmergehelper-allowduplicatetypes.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - AllowDuplicateTypes - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

AllowDuplicateTypes

-
-

Option type to configure ILMerge's processing of duplicate types.

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - AllPublicTypes - -
- Signature:
-
-
- - - - -

All public types are allowed to be duplicated and renamed

- - - -
- - - DuplicateTypes(string list) - -
- Signature: string list
-
-
- - - - -

List of types to allow to be duplicated

- - - -
- - - NoDuplicateTypes - -
- Signature:
-
-
- - - - -

No duplicates of public types allowed

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-ilmergehelper-ilmergeparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-ilmergehelper-ilmergeparams.html deleted file mode 100644 index 7ecf077..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-ilmergehelper-ilmergeparams.html +++ /dev/null @@ -1,527 +0,0 @@ - - - - - ILMergeParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ILMergeParams

-
-

Parameter type for ILMerge

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - AllowDuplicateTypes - -
- Signature: AllowDuplicateTypes
-
-
- - - - -

Duplicate types policy

- - - -
- - - AllowMultipleAssemblyLevelAttributes - -
- Signature: bool
-
-
- - - - -

Assembly-level attributes names that have the same type are copied over into the target directory

- - - -
- - - AllowWildcards - -
- Signature: bool
-
-
- - - - -

Wild cards in file names are expanded and all matching files will be used as input.

- - - -
- - - AllowZeroPeKind - -
- Signature: bool
-
-
- - - - - -
- - - AttributeFile - -
- Signature: string
-
-
- - - - -

Path to an assembly that will be used to get all of the assembly-level attributes

- - - -
- - - Closed - -
- Signature: bool
-
-
- - - - -

True -> transitive closure of the input assemblies is computed and added to the list of input assemblies.

- - - -
- - - CopyAttributes - -
- Signature: bool
-
-
- - - - - -
- - - DebugInfo - -
- Signature: bool
-
-
- - - - -

True (default) -> creates a .pdb file for the output assembly and merges into it any .pdb files found for input assemblies.

- - - -
- - - FileAlignment - -
- Signature: int option
-
-
- - - - - -
- - - Internalize - -
- Signature: InternalizeTypes
-
-
- - - - - -
- - - KeyFile - -
- Signature: string
-
-
- - - - - -
- - - Libraries - -
- Signature: seq<string>
-
-
- - - - -

Assemblies to merge with the primary assembly

- - - -
- - - LogFile - -
- Signature: string
-
-
- - - - - -
- - - SearchDirectories - -
- Signature: seq<string>
-
-
- - - - -

Directories to be used to search for input assemblies

- - - -
- - - TargetKind - -
- Signature: TargetKind
-
-
- - - - - -
- - - TargetPlatform - -
- Signature: string
-
-
- - - - -

v1 or v1.1 or v2 or v4 or version,platform

- - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - -

Path to ILMerge.exe

- - - -
- - - UnionMerge - -
- Signature: bool
-
-
- - - - -

True -> types with the same name are all merged into a single type in the target assembly.

- - - -
- - - Version - -
- Signature: string
-
-
- - - - -

Version to use for the merged assembly

- - - -
- - - XmlDocs - -
- Signature: bool
-
-
- - - - -

True -> XML documentation files are merged to produce an XML documentation file for the target assembly.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-ilmergehelper-internalizetypes.html b/packages/FAKE.4.11.3/docs/apidocs/fake-ilmergehelper-internalizetypes.html deleted file mode 100644 index f4645de..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-ilmergehelper-internalizetypes.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - InternalizeTypes - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

InternalizeTypes

-
-

Option type to configure ILMerge's processing of internal types.

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - Internalize - -
- Signature:
-
-
- - - - - -
- - - InternalizeExcept(string) - -
- Signature: string
-
-
- - - - - -
- - - NoInternalize - -
- Signature:
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-ilmergehelper-targetkind.html b/packages/FAKE.4.11.3/docs/apidocs/fake-ilmergehelper-targetkind.html deleted file mode 100644 index a9e3a13..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-ilmergehelper-targetkind.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - TargetKind - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

TargetKind

-
-

Option type to configure ILMerge's target output.

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - Exe - -
- Signature:
-
-
- - - - - -
- - - Library - -
- Signature:
-
-
- - - - - -
- - - WinExe - -
- Signature:
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-ilmergehelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-ilmergehelper.html deleted file mode 100644 index 7516342..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-ilmergehelper.html +++ /dev/null @@ -1,210 +0,0 @@ - - - - - ILMergeHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ILMergeHelper

-
-

Contains task a task which allows to merge .NET assemblies with ILMerge.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- AllowDuplicateTypes -

Option type to configure ILMerge's processing of duplicate types.

- - -
- ILMergeParams -

Parameter type for ILMerge

- - -
- InternalizeTypes -

Option type to configure ILMerge's processing of internal types.

- - -
- TargetKind -

Option type to configure ILMerge's target output.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - ILMerge (...) - -
- Signature: setParams:(ILMergeParams -> ILMergeParams) -> outputFile:string -> primaryAssembly:string -> unit
-
-
- - - - -

Uses ILMerge to merge .NET assemblies.

- -

Parameters

- -
    -
  • setParams - Function used to create an ILMergeParams value with your required settings. Called with an ILMergeParams value configured with the defaults.
  • -
  • outputFile - Output file path for the merged assembly.
  • -
  • primaryAssembly - The assembly you want ILMerge to consider as the primary.
  • -
- - - -
- - - ILMergeDefaults - -
- Signature: ILMergeParams
-
-
- - - - -

ILMerge default parameters. Tries to automatically locate ilmerge.exe in a subfolder.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-magehelper-magecall.html b/packages/FAKE.4.11.3/docs/apidocs/fake-magehelper-magecall.html deleted file mode 100644 index 7fa2d36..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-magehelper-magecall.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - MageCall - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MageCall

-
-

The supported commands of the MAGE tool

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - Deploy - -
- Signature:
-
-
- - - - - -
- - - NewApp - -
- Signature:
-
-
- - - - - -
- - - Sign - -
- Signature:
-
-
- - - - - -
- - - SignDeploy - -
- Signature:
-
-
- - - - - -
- - - UpdateApp - -
- Signature:
-
-
- - - - - -
- - - UpdateDeploy - -
- Signature:
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-magehelper-mageparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-magehelper-mageparams.html deleted file mode 100644 index 144776a..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-magehelper-mageparams.html +++ /dev/null @@ -1,506 +0,0 @@ - - - - - MageParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MageParams

-
-

Needed information to call MAGE

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ApplicationFile - -
- Signature: string
-
-
- - - - - -
- - - CertFile - -
- Signature: string option
-
-
- - - - - -
- - - CertHash - -
- Signature: string option
-
-
- - - - - -
- - - CodeBase - -
- Signature: string option
-
-
- - - - - -
- - - FromDirectory - -
- Signature: string
-
-
- - - - - -
- - - IconFile - -
- Signature: string
-
-
- - - - - -
- - - IconPath - -
- Signature: string
-
-
- - - - - -
- - - IncludeProvider - -
- Signature: bool option
-
-
- - - - - -
- - - Install - -
- Signature: bool option
-
-
- - - - - -
- - - Manifest - -
- Signature: string
-
-
- - - - - -
- - - Name - -
- Signature: string
-
-
- - - - - -
- - - Password - -
- Signature: string option
-
-
- - - - - -
- - - Processor - -
- Signature: MageProcessor
-
-
- - - - - -
- - - ProjectFiles - -
- Signature: seq<string>
-
-
- - - - - -
- - - ProviderURL - -
- Signature: string
-
-
- - - - - -
- - - Publisher - -
- Signature: string option
-
-
- - - - - -
- - - SupportURL - -
- Signature: string option
-
-
- - - - - -
- - - TmpCertFile - -
- Signature: string
-
-
- - - - - -
- - - ToolsPath - -
- Signature: string
-
-
- - - - - -
- - - TrustLevel - -
- Signature: MageTrustLevels option
-
-
- - - - - -
- - - UseManifest - -
- Signature: bool option
-
-
- - - - - -
- - - Version - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-magehelper-mageprocessor.html b/packages/FAKE.4.11.3/docs/apidocs/fake-magehelper-mageprocessor.html deleted file mode 100644 index 21ed902..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-magehelper-mageprocessor.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - MageProcessor - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MageProcessor

-
-

These are the supported processor types of the MAGE tool

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - AMD64 - -
- Signature:
-
-
- - - - - -
- - - IA64 - -
- Signature:
-
-
- - - - - -
- - - MSIL - -
- Signature:
-
-
- - - - - -
- - - X86 - -
- Signature:
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-magehelper-magetrustlevels.html b/packages/FAKE.4.11.3/docs/apidocs/fake-magehelper-magetrustlevels.html deleted file mode 100644 index 50bd646..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-magehelper-magetrustlevels.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - MageTrustLevels - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MageTrustLevels

-
-

The level of trust to grant the application on client computers.

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - FullTrust - -
- Signature:
-
-
- - - - - -
- - - Internet - -
- Signature:
-
-
- - - - - -
- - - LocalIntranet - -
- Signature:
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-magehelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-magehelper.html deleted file mode 100644 index 41719c3..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-magehelper.html +++ /dev/null @@ -1,357 +0,0 @@ - - - - - MageHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MageHelper

-
-

Contains helper functions which allow FAKE to call the Manifest Generation and Editing Tool, in short 'MAGE'. -The intentional use is the creation of a clickonce application.

- - -

Certificates

-

The MAGE tool wants to sign the manifest using a certificate. It should be clear, that this file is not under source control. -On the other hand - you want to be able to run the compile batch on each developer machine. How can we achieve that? -In the parameter structure, we use a CertFile property and a TmpCertFile property. Whenever the CertFile was not found, the manifest is signed with -a temporary certificate. And the latter one can be shared in the source control.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- MageCall -

The supported commands of the MAGE tool

- - -
- MageParams -

Needed information to call MAGE

- - -
- MageProcessor -

These are the supported processor types of the MAGE tool

- - -
- MageTrustLevels -

The level of trust to grant the application on client computers.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - mageCall action mp - -
- Signature: action:MageCall -> mp:MageParams -> unit
-
-
- - - - -

Execute the MAGE tool. Adds some parameters, dependent on the MAGE command.

- - - -
- - - MageCreateApp mp - -
- Signature: mp:MageParams -> unit
-
-
- - - - -

Encapsulates the MAGE call to create a new application's manifest

- - - -
- - - MageDeployApp mp - -
- Signature: mp:MageParams -> unit
-
-
- - - - -

Encapsulates the MAGE call to deploy an application

- - - -
- - - MageRun mp - -
- Signature: mp:MageParams -> unit
-
-
- - - - -

Executes a full run of MAGE commands: first, it creates a new manifest file. Then it signs the manifest, deploys the application and finally signs the deployment.

- - - -
- - - MageSerializeParams action mp - -
- Signature: action:MageCall -> mp:MageParams -> string
-
-
- - - - -

Convert the parameter structure into command line arguments of MAGE

- - - -
- - - MageSignDeploy mp - -
- Signature: mp:MageParams -> unit
-
-
- - - - -

Encapsulates the MAGE call to sign the deployment of an application

- - - -
- - - MageSignManifest mp - -
- Signature: mp:MageParams -> unit
-
-
- - - - -

Encapsulates the MAGE call to sign an application's manifest

- - - -
- - - MageUpdateApp mp - -
- Signature: mp:MageParams -> unit
-
-
- - - - -

Encapsulates the MAGE call to update an existing application's manifest

- - - -
- - - MageUpdateDeploy mp - -
- Signature: mp:MageParams -> unit
-
-
- - - - -

Encapsulates the MAGE call to update the deployment of an application

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-messagehelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-messagehelper.html deleted file mode 100644 index 6d2cd4a..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-messagehelper.html +++ /dev/null @@ -1,157 +0,0 @@ - - - - - MessageHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MessageHelper

-
-

Contains helper function which allow FAKE to interact with other applications via message files.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - WaitForMessageFile file timeOut - -
- Signature: file:string -> timeOut:TimeSpan -> TimeSpan
-
-
- - - - -

Waits for another application to create a output file. -If the timeout is reached an exception will be raised.

- - - -
- - - WaitForMessageFiles files timeOut - -
- Signature: files:seq<string> -> timeOut:TimeSpan -> TimeSpan
-
-
- - - - -

Waits for other applications to create a output files. -If the timeout is reached an exception will be raised.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuild-projectsystem-projectcomparison.html b/packages/FAKE.4.11.3/docs/apidocs/fake-msbuild-projectsystem-projectcomparison.html deleted file mode 100644 index 0cd2c19..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuild-projectsystem-projectcomparison.html +++ /dev/null @@ -1,226 +0,0 @@ - - - - - ProjectComparison - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ProjectComparison

-
-

Result type for project comparisons.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - DuplicateFiles - -
- Signature: seq<string>
-
-
- - - - - -
- - - MissingFiles - -
- Signature: seq<string>
-
-
- - - - - -
- - - ProjectFileName - -
- Signature: string
-
-
- - - - - -
- - - TemplateProjectFileName - -
- Signature: string
-
-
- - - - - -
- - - UnorderedFiles - -
- Signature: seq<string>
-
-
- - - - - -
-

Instance members

- - - - - - - - - - -
Instance memberDescription
- - - HasErrors - -
- Signature: bool
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuild-projectsystem-projectfile.html b/packages/FAKE.4.11.3/docs/apidocs/fake-msbuild-projectsystem-projectfile.html deleted file mode 100644 index f05e46e..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuild-projectsystem-projectfile.html +++ /dev/null @@ -1,309 +0,0 @@ - - - - - ProjectFile - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ProjectFile

-
-

A small abstraction over MSBuild project files.

- - -
-

Constructors

- - - - - - - - - - -
ConstructorDescription
- - - new(projectFileName, documentContent) - -
- Signature: (projectFileName:string * documentContent:string) -> ProjectFile
-
-
- - - - - -
-

Instance members

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Instance memberDescription
- - - AddFile(fileName) - -
- Signature: fileName:string -> ProjectFile
-
-
- - - - -

Add a file to the Compile nodes

- - - -
- - - Files - -
- Signature: string list
-
-
- - - - -

All files which are in "Compile" sections

- - - -
- - - FindDuplicateFiles() - -
- Signature: unit -> string list
-
-
- - - - -

Finds duplicate files which are in "Compile" sections

- - - -
- - - ProjectFileName - -
- Signature: string
-
-
- - - - -

The project file name

- - - -
- - - RemoveDuplicates() - -
- Signature: unit -> ProjectFile
-
-
- - - - - -
- - - RemoveFile(fileName) - -
- Signature: fileName:string -> ProjectFile
-
-
- - - - -

Removes a file from the Compile nodes

- - - -
- - - Save(fileName) - -
- Signature: (fileName:string option) -> unit
-
-
- - - - -

Saves the project file

- - - -
-

Static members

- - - - - - - - - - -
Static memberDescription
- - - FromFile(projectFileName) - -
- Signature: projectFileName:string -> ProjectFile
-
-
- - - - -

Read a Project from a FileName

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuild-projectsystem.html b/packages/FAKE.4.11.3/docs/apidocs/fake-msbuild-projectsystem.html deleted file mode 100644 index 0dfa113..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuild-projectsystem.html +++ /dev/null @@ -1,250 +0,0 @@ - - - - - ProjectSystem - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ProjectSystem

-
-

Contains project file comparion tools for MSBuild project files.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - -
TypeDescription
- ProjectComparison -

Result type for project comparisons.

- - -
- ProjectFile -

A small abstraction over MSBuild project files.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - CompareProjectsTo (...) - -
- Signature: templateProject:string -> projects:seq<string> -> unit
-
-
- - - - -

Compares the given project files againts the template project and fails if any files are missing. -For F# projects it is also reporting unordered files.

- - - -
- - - findMissingFiles (...) - -
- Signature: templateProject:string -> projects:seq<string> -> seq<ProjectComparison>
-
-
- - - - -

Compares the given project files againts the template project and returns which files are missing. -For F# projects it is also reporting unordered files.

- - - -
- - - FixMissingFiles templateProject projects - -
- Signature: templateProject:string -> projects:seq<string> -> unit
-
-
- - - - -

Compares the given projects to the template project and adds all missing files to the projects if needed.

- - - -
- - - FixProjectFiles templateProject projects - -
- Signature: templateProject:string -> projects:seq<string> -> unit
-
-
- - - - -

Compares the given projects to the template project and adds all missing files to the projects if needed. -It also removes duplicate files from the project files.

- - - -
- - - RemoveDuplicateFiles projects - -
- Signature: projects:seq<string> -> unit
-
-
- - - - -

It removes duplicate files from the project files.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuild-specsremovement.html b/packages/FAKE.4.11.3/docs/apidocs/fake-msbuild-specsremovement.html deleted file mode 100644 index ea6cdb6..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuild-specsremovement.html +++ /dev/null @@ -1,268 +0,0 @@ - - - - - SpecsRemovement - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

SpecsRemovement

-
-

Contains functions which allow to remove side-by-side specs during the build.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - AllNUnitReferences elementName s - -
- Signature: elementName:'?9600 -> s:string -> bool
- Type parameters: '?9600
-
- - - - -

All references to nunit.*.dlls

- - - -
- - - AllSpecAndTestDataFiles elementName s - -
- Signature: elementName:string -> s:string -> bool
-
-
- - - - -

All Spec.cs or Spec.fs files and all files containing TestData

- - - -
- - - AllSpecFiles elementName s - -
- Signature: elementName:'?9602 -> s:string -> bool
- Type parameters: '?9602
-
- - - - -

All Spec.cs or Spec.fs files

- - - -
- - - Nothing arg1 arg2 - -
- Signature: '?9605 -> '?9606 -> bool
- Type parameters: '?9605, '?9606
-
- - - - -

A Convetion which matches nothing

- - - -
- - - RemoveAllNUnitReferences projectFileName - -
- Signature: projectFileName:string -> string
-
-
- - - - -

Removes all NUnit references from a project.

- - - -
- - - RemoveAllSpecAndTestDataFiles (...) - -
- Signature: projectFileName:string -> string
-
-
- - - - -

Removes all spec and test data references from a project.

- - - -
- - - RemoveTestsFromProject (...) - -
- Signature: assemblyFilterF:(string -> string -> bool) -> fileFilterF:(string -> string -> bool) -> projectFileName:string -> string
-
-
- - - - -

Removes test data and test files from a given MSBuild project and recursivly from all MSBuild project dependencies.

- -

Parameters

- -
    -
  • assemblyFilterF - A filter function for assembly references.
  • -
  • fileFilterF - A filter function for files in a project.
  • -
  • projectFileName - The MSBuild project to start.
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildhelper-buildexception.html b/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildhelper-buildexception.html deleted file mode 100644 index 5b20bce..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildhelper-buildexception.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - BuildException - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildhelper-msbuilddistributedloggerconfig.html b/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildhelper-msbuilddistributedloggerconfig.html deleted file mode 100644 index df6d13b..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildhelper-msbuilddistributedloggerconfig.html +++ /dev/null @@ -1,161 +0,0 @@ - - - - - MSBuildDistributedLoggerConfig - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MSBuildDistributedLoggerConfig

-
-
-

Record Fields

- - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - AssemblyPath - -
- Signature: string
-
-
- - - - - -
- - - ClassName - -
- Signature: string option
-
-
- - - - - -
- - - Parameters - -
- Signature: (string * string) list option
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildhelper-msbuildfileloggerconfig.html b/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildhelper-msbuildfileloggerconfig.html deleted file mode 100644 index 529f7c6..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildhelper-msbuildfileloggerconfig.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - MSBuildFileLoggerConfig - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MSBuildFileLoggerConfig

-
-

A type for MSBuild configuration

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Filename - -
- Signature: string option
-
-
- - - - - -
- - - Number - -
- Signature: int
-
-
- - - - - -
- - - Parameters - -
- Signature: MSBuildLogParameter list option
-
-
- - - - - -
- - - Verbosity - -
- Signature: MSBuildVerbosity option
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildhelper-msbuildlogparameter.html b/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildhelper-msbuildlogparameter.html deleted file mode 100644 index 6f9afac..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildhelper-msbuildlogparameter.html +++ /dev/null @@ -1,362 +0,0 @@ - - - - - MSBuildLogParameter - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MSBuildLogParameter

-
-

MSBuild log option

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - Append - -
- Signature:
-
-
- - - - - -
- - - DisableConsoleColor - -
- Signature:
-
-
- - - - - -
- - - DisableMPLogging - -
- Signature:
-
-
- - - - - -
- - - EnableMPLogging - -
- Signature:
-
-
- - - - - -
- - - ErrorsOnly - -
- Signature:
-
-
- - - - - -
- - - ForceNoAlign - -
- Signature:
-
-
- - - - - -
- - - NoItemAndPropertyList - -
- Signature:
-
-
- - - - - -
- - - NoSummary - -
- Signature:
-
-
- - - - - -
- - - PerformanceSummary - -
- Signature:
-
-
- - - - - -
- - - ShowCommandLine - -
- Signature:
-
-
- - - - - -
- - - ShowEventId - -
- Signature:
-
-
- - - - - -
- - - ShowTimestamp - -
- Signature:
-
-
- - - - - -
- - - Summary - -
- Signature:
-
-
- - - - - -
- - - WarningsOnly - -
- Signature:
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildhelper-msbuildparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildhelper-msbuildparams.html deleted file mode 100644 index 82fd6cd..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildhelper-msbuildparams.html +++ /dev/null @@ -1,308 +0,0 @@ - - - - - MSBuildParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MSBuildParams

-
-

A type for MSBuild task parameters

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - DistributedLoggers - -
- Signature: (MSBuildDistributedLoggerConfig * MSBuildDistributedLoggerConfig option) list option
-
-
- - - - - -
- - - FileLoggers - -
- Signature: MSBuildFileLoggerConfig list option
-
-
- - - - - -
- - - MaxCpuCount - -
- Signature: int option option
-
-
- - - - - -
- - - NoConsoleLogger - -
- Signature: bool
-
-
- - - - - -
- - - NodeReuse - -
- Signature: bool
-
-
- - - - - -
- - - NoLogo - -
- Signature: bool
-
-
- - - - - -
- - - Properties - -
- Signature: (string * string) list
-
-
- - - - - -
- - - RestorePackagesFlag - -
- Signature: bool
-
-
- - - - - -
- - - Targets - -
- Signature: string list
-
-
- - - - - -
- - - ToolsVersion - -
- Signature: string option
-
-
- - - - - -
- - - Verbosity - -
- Signature: MSBuildVerbosity option
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildhelper-msbuildproject.html b/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildhelper-msbuildproject.html deleted file mode 100644 index 198594d..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildhelper-msbuildproject.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - MSBuildProject - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MSBuildProject

-
-

A type to represent MSBuild project files.

- - -
-

Instance members

- - - - - - - - - - - - - - - - - - - - - - -
Instance memberDescription
- - - Declaration() - -
- Signature: unit -> unit
-
-
- -
- - - DocumentType - -
- Signature: XDocumentType
-
-
- -
- - - NodeType - -
- Signature: XmlNodeType
- Modifiers: abstract
-
-
- -
- - - Root - -
- Signature: XElement
-
-
- -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildhelper-msbuildverbosity.html b/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildhelper-msbuildverbosity.html deleted file mode 100644 index 87c1f1b..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildhelper-msbuildverbosity.html +++ /dev/null @@ -1,200 +0,0 @@ - - - - - MSBuildVerbosity - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MSBuildVerbosity

-
-

MSBuild verbosity option

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - Detailed - -
- Signature:
-
-
- - - - - -
- - - Diagnostic - -
- Signature:
-
-
- - - - - -
- - - Minimal - -
- Signature:
-
-
- - - - - -
- - - Normal - -
- Signature:
-
-
- - - - - -
- - - Quiet - -
- Signature:
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildhelper.html deleted file mode 100644 index 90752ac..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildhelper.html +++ /dev/null @@ -1,548 +0,0 @@ - - - - - MSBuildHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MSBuildHelper

-
-

Contains tasks which allow to use MSBuild (or xBuild on Linux/Unix) to build .NET project files or solution files.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- BuildException -

An exception type to signal build errors.

- - -
- MSBuildDistributedLoggerConfig -
- MSBuildFileLoggerConfig -

A type for MSBuild configuration

- - -
- MSBuildLogParameter -

MSBuild log option

- - -
- MSBuildParams -

A type for MSBuild task parameters

- - -
- MSBuildProject -

A type to represent MSBuild project files.

- - -
- MSBuildVerbosity -

MSBuild verbosity option

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - build setParams project - -
- Signature: setParams:(MSBuildParams -> MSBuildParams) -> project:string -> unit
-
-
- - - - -

Runs a MSBuild project

- -

Parameters

- -
    -
  • setParams - A function that overwrites the default MsBuildParams
  • -
  • project - A string with the path to the project file to build.
  • -
- -

Sample

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-
let buildMode = getBuildParamOrDefault "buildMode" "Release"
-let setParams defaults =
-        { defaults with
-            Verbosity = Some(Quiet)
-            Targets = ["Build"]
-            Properties =
-                [
-                    "Optimize", "True"
-                    "DebugSymbols", "True"
-                    "Configuration", buildMode
-                ]
-         }
-build setParams "./MySolution.sln"
-      |> DoNothing
-
- -
val buildMode : obj

Full name: docs.buildMode
-
val setParams : defaults:'a -> 'a

Full name: docs.setParams
-
val defaults : 'a
-
union case Option.Some: Value: 'T -> Option<'T>
- - -
- - - BuildWebsite outputPath projectFile - -
- Signature: outputPath:string -> projectFile:string -> unit
-
-
- - - - -

Builds the given web project file in debug mode and copies it to the given websiteDir.

- -

Parameters

- -
    -
  • outputPath - The output path.
  • -
  • projectFile - The project file path.
  • -
- - - -
- - - BuildWebsites websiteDir projectFiles - -
- Signature: websiteDir:string -> projectFiles:seq<string> -> unit
-
-
- - - - -

Builds the given web project files in debug mode and copies them to the given websiteDir.

- -

Parameters

- -
    -
  • outputPath - The output path.
  • -
  • projectFiles - The project file paths.
  • -
- - - -
- - - MSBuild (...) - -
- Signature: outputPath:string -> targets:string -> properties:(string * string) list -> projects:seq<string> -> string list
-
-
- - - - -

Builds the given project files or solution files and collects the output files.

- -

Parameters

- -
    -
  • outputPath - If it is null or empty then the project settings are used.
  • -
  • targets - A string with the target names which should be run by MSBuild.
  • -
  • properties - A list with tuples of property name and property values.
  • -
  • projects - A list of project or solution files.
  • -
- - - -
- - - MSBuildDebug outputPath targets projects - -
- Signature: outputPath:string -> targets:string -> projects:seq<string> -> string list
-
-
- - - - -

Builds the given project files or solution files and collects the output files.

- -

Parameters

- -
    -
  • outputPath - If it is null or empty then the project settings are used.
  • -
  • targets - A string with the target names which should be run by MSBuild.
  • -
  • projects - A list of project or solution files.
  • -
- - - -
- - - MSBuildDefaults - -
- Signature: MSBuildParams
-
-
- - - - -

Defines a default for MSBuild task parameters

- - - -
- - - msBuildExe - -
- Signature: string
-
-
- - - - -

Tries to detect the right version of MSBuild. - - On Linux/Unix Systems we use xBuild. - - On Windows we try to find a "MSBuild" build parameter or read the MSBuild tool location from the AppSettings file.

- - - -
- - - MSBuildLoggers - -
- Signature: string list
-
-
- - - - -

Defines the loggers to use for MSBuild task

- - - -
- - - MSBuildRelease (...) - -
- Signature: outputPath:string -> targets:string -> projects:seq<string> -> string list
-
-
- - - - -

Builds the given project files or solution files and collects the output files.

- -

Parameters

- -
    -
  • outputPath - If it is null or empty then the project settings are used.
  • -
  • targets - A string with the target names which should be run by MSBuild.
  • -
  • projects - A list of project or solution files.
  • -
- - - -
- - - MSBuildReleaseExt (...) - -
- Signature: outputPath:string -> properties:(string * string) list -> targets:string -> projects:seq<string> -> string list
-
-
- - - - -

Builds the given project files or solution files in release mode and collects the output files.

- -

Parameters

- -
    -
  • outputPath - If it is null or empty then the project settings are used.
  • -
  • properties - A list with tuples of property name and property values.
  • -
  • targets - A string with the target names which should be run by MSBuild.
  • -
  • projects - A list of project or solution files.
  • -
- - - -
- - - MSBuildWithDefaults targets projects - -
- Signature: targets:string -> projects:seq<string> -> string list
-
-
- - - - -

Builds the given project files or solution files in release mode to the default outputs.

- -

Parameters

- -
    -
  • targets - A string with the target names which should be run by MSBuild.
  • -
  • projects - A list of project or solution files.
  • -
- - - -
- - - MSBuildWithProjectProperties (...) - -
- Signature: outputPath:string -> targets:string -> properties:(string -> (string * string) list) -> projects:seq<string> -> string list
-
-
- - - - -

Builds the given project files and collects the output files.

- -

Parameters

- -
    -
  • outputPath - If it is null or empty then the project settings are used.
  • -
  • targets - A string with the target names which should be run by MSBuild.
  • -
  • properties - A list with tuples of property name and property values.
  • -
  • projects - A list of project or solution files.
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildlogger-errorlogger.html b/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildlogger-errorlogger.html deleted file mode 100644 index 29779c5..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildlogger-errorlogger.html +++ /dev/null @@ -1,128 +0,0 @@ - - - - - ErrorLogger - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildlogger-msbuildlogger.html b/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildlogger-msbuildlogger.html deleted file mode 100644 index 10706c1..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildlogger-msbuildlogger.html +++ /dev/null @@ -1,158 +0,0 @@ - - - - - MSBuildLogger - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MSBuildLogger

-
-

Abstract MSBuild Logger class.

- - -
-

Constructors

- - - - - - - - - - -
ConstructorDescription
- - - new() - -
- Signature: unit -> MSBuildLogger
-
-
- - - - - -
-

Instance members

- - - - - - - - - - -
Instance memberDescription
- - - RegisterEvents(arg1) - -
- Signature: IEventSource -> unit
- Modifiers: abstract
-
-
- - - - -

Abstract function which registers an event listener.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildlogger-teamcitylogger.html b/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildlogger-teamcitylogger.html deleted file mode 100644 index 7d45b8d..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildlogger-teamcitylogger.html +++ /dev/null @@ -1,128 +0,0 @@ - - - - - TeamCityLogger - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildlogger.html b/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildlogger.html deleted file mode 100644 index 5587bde..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-msbuildlogger.html +++ /dev/null @@ -1,172 +0,0 @@ - - - - - MsBuildLogger - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MsBuildLogger

-
-

Contains Logger implementations for MsBuild.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - -
TypeDescription
- ErrorLogger -

TeamCity Logger for MSBuild

- - -
- MSBuildLogger -

Abstract MSBuild Logger class.

- - -
- TeamCityLogger -

TeamCity Logger for MSBuild

- - -
- -
- -

Functions and values

- - - - - - - - - - -
Function or valueDescription
- - - ErrorLoggerFile - -
- Signature: string
-
-
- - - - -

The ErrorLogFile

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-msihelper-msiparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-msihelper-msiparams.html deleted file mode 100644 index 62c0598..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-msihelper-msiparams.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - MSIParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MSIParams

-
-

MSI parameter type

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - LogFile - -
- Signature: string
-
-
- - - - - -
- - - Silent - -
- Signature: bool
-
-
- - - - - -
- - - ThrowIfSetupFails - -
- Signature: bool
-
-
- - - - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-msihelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-msihelper.html deleted file mode 100644 index 938611c..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-msihelper.html +++ /dev/null @@ -1,210 +0,0 @@ - - - - - MSIHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MSIHelper

-
-

Contains tasks which allow to run msiexec in order to install or uninstall msi files.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- MSIParams -

MSI parameter type

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - Install setParams setup - -
- Signature: setParams:(MSIParams -> MSIParams) -> setup:string -> unit
-
-
- - - - -

Installs a msi.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default MSI parameters.
  • -
  • setup - The setup file name.
  • -
- - - -
- - - MSIDefaults - -
- Signature: MSIParams
-
-
- - - - -

MSI default parameters

- - - -
- - - Uninstall setParams setup - -
- Signature: setParams:(MSIParams -> MSIParams) -> setup:string -> unit
-
-
- - - - -

Uninstalls a msi.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default MSI parameters.
  • -
  • setup - The setup file name.
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-mspechelper-mspecparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-mspechelper-mspecparams.html deleted file mode 100644 index 716fdfb..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-mspechelper-mspecparams.html +++ /dev/null @@ -1,299 +0,0 @@ - - - - - MSpecParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MSpecParams

-
-

Parameter type to configure the MSpec runner.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ErrorLevel - -
- Signature: TestRunnerErrorLevel
-
-
- - - - -

An error level setting to specify whether a failed test should break the build

- - - -
- - - ExcludeTags - -
- Signature: string list
-
-
- - - - -

Tests with theses tags are ignored by MSpec

- - - -
- - - HtmlOutputDir - -
- Signature: string
-
-
- - - - -

Output directory for html reports (optional).

- - - -
- - - IncludeTags - -
- Signature: string list
-
-
- - - - -

Tests with theses tags are included by MSpec

- - - -
- - - Silent - -
- Signature: bool
-
-
- - - - -

Can be used to run MSpec in silent mode.

- - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - -

A timeout for the test runner

- - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - -

FileName of the mspec runner exe. Use mspec-clr4.exe if you are on .NET 4.0 or above.

- - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - -

Working directory (optional)

- - - -
- - - XmlOutputPath - -
- Signature: string
-
-
- - - - -

Output file path for xml reports (optional).

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-mspechelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-mspechelper.html deleted file mode 100644 index d5ff547..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-mspechelper.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - - MSpecHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MSpecHelper

-
-

Contains a task to run machine.specifications tests.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- MSpecParams -

Parameter type to configure the MSpec runner.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - MSpec setParams assemblies - -
- Signature: setParams:(MSpecParams -> MSpecParams) -> assemblies:seq<string> -> unit
-
-
- - - - -

This task to can be used to run machine.specifications on test libraries.

- -

Parameters

- -
    -
  • setParams - Function used to overwrite the MSpec default parameters.
  • -
  • assemblies - The file names of the test assemblies.
  • -
- -

Sample

- - - - -
1: 
-2: 
-
!! (testDir @@ "Test.*.dll") 
-  |> MSpec (fun p -> {p with ExcludeTags = ["HTTP"]; HtmlOutputDir = reportDir})
-
- -

Hint

- -

XmlOutputPath expects a full file path whereas the HtmlOutputDir expects a directory name

- - - -
- - - MSpecDefaults - -
- Signature: MSpecParams
-
-
- - - - -

MSpec default parameters - tries to locate mspec-clr4.exe in any subfolder.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-mstest-errorlevel.html b/packages/FAKE.4.11.3/docs/apidocs/fake-mstest-errorlevel.html deleted file mode 100644 index 5d0ec84..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-mstest-errorlevel.html +++ /dev/null @@ -1,102 +0,0 @@ - - - - - ErrorLevel - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-mstest-mstestparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-mstest-mstestparams.html deleted file mode 100644 index e2614a8..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-mstest-mstestparams.html +++ /dev/null @@ -1,299 +0,0 @@ - - - - - MSTestParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MSTestParams

-
-

Parameter type to configure the MSTest.exe.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Category - -
- Signature: string
-
-
- - - - -

Test category filter (optional). The test category filter consists of one or more test category names separated by the logical operators '&', '|', '!', '&!'. The logical operators '&' and '|' cannot be used together to create a test category filter.

- - - -
- - - ErrorLevel - -
- Signature: ErrorLevel
-
-
- - - - -

Option which allow to specify if a MSTest error should break the build.

- - - -
- - - NoIsolation - -
- Signature: bool
-
-
- - - - -

Run tests in isolation (optional).

- - - -
- - - ResultsDir - -
- Signature: string
-
-
- - - - -

Test results directory (optional)

- - - -
- - - TestMetadataPath - -
- Signature: string
-
-
- - - - -

Path to the Test Metadata file (.vdmdi) (optional)

- - - -
- - - TestSettingsPath - -
- Signature: string
-
-
- - - - -

Path to the Test Settings file (.testsettings) (optional)

- - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - -

A timeout for the test runner (optional)

- - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - -

Path to MSTest.exe

- - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - -

Working directory (optional)

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-mstest.html b/packages/FAKE.4.11.3/docs/apidocs/fake-mstest.html deleted file mode 100644 index 4699342..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-mstest.html +++ /dev/null @@ -1,206 +0,0 @@ - - - - - MSTest - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MSTest

-
-

Contains tasks to run MSTest unit tests.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - -
TypeDescription
- ErrorLevel -

Option which allow to specify if a MSTest error should break the build.

- - -
- MSTestParams -

Parameter type to configure the MSTest.exe.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - MSTest setParams assemblies - -
- Signature: setParams:(MSTestParams -> MSTestParams) -> assemblies:seq<string> -> unit
-
-
- - - - -

Runs MSTest command line tool on a group of assemblies.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default MSTestParams value.
  • -
  • assemblies - Sequence of one or more assemblies containing Microsoft Visual Studio Unit Test Framework unit tests.
  • -
- -

Sample usage

- - - - -
1: 
-2: 
-3: 
-4: 
-
Target "Test" (fun _ ->
-    !! (testDir + @"\*.Tests.dll") 
-      |> MSTest (fun p -> { p with Category = "group1" })
-)
-
- - - -
- - - MSTestDefaults - -
- Signature: MSTestParams
-
-
- - - - -

MSTest default parameters.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-ncoverhelper-ncoverparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-ncoverhelper-ncoverparams.html deleted file mode 100644 index 32f9523..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-ncoverhelper-ncoverparams.html +++ /dev/null @@ -1,200 +0,0 @@ - - - - - NCoverParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NCoverParams

-
-

The NCover parameter type.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ProjectName - -
- Signature: string
-
-
- - - - - -
- - - TestRunnerExe - -
- Signature: string
-
-
- - - - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-ncoverhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-ncoverhelper.html deleted file mode 100644 index bf1bf44..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-ncoverhelper.html +++ /dev/null @@ -1,183 +0,0 @@ - - - - - NCoverHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NCoverHelper

-
-

Contains a task which can be used to run NCover on .NET assemblies.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- NCoverParams -

The NCover parameter type.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - NCover (...) - -
- Signature: setParams:(NCoverParams -> NCoverParams) -> assemblies:seq<string> -> excludeAssemblies:seq<string> -> unit
-
-
- - - - -

Runs NCover on a group of assemblies.

- -

Parameters

- -
    -
  • setParams - Function used to overwrite the NCover default parameters.
  • -
  • assemblies - The test assemblies, which should be inspected.
  • -
  • excludeAssemblies - These assemblies are excluded.
  • -
- - - -
- - - NCoverDefaults - -
- Signature: NCoverParams
-
-
- - - - -

NCover default parameters.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-ndepend-ndependparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-ndepend-ndependparams.html deleted file mode 100644 index ca522fa..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-ndepend-ndependparams.html +++ /dev/null @@ -1,179 +0,0 @@ - - - - - NDependParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NDependParams

-
-
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - CoverageFiles - -
- Signature: string list
-
-
- - - - - -
- - - ProjectFile - -
- Signature: string
-
-
- - - - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-ndepend.html b/packages/FAKE.4.11.3/docs/apidocs/fake-ndepend.html deleted file mode 100644 index 060f30f..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-ndepend.html +++ /dev/null @@ -1,226 +0,0 @@ - - - - - NDepend - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NDepend

-
-

Contains a task which allows to run NDepend on .NET project files.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- NDependParams -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - buildNDependArgs parameters - -
- Signature: parameters:NDependParams -> string
-
-
- - - - - -
- - - getWorkingDir workingDir - -
- Signature: workingDir:string -> string
-
-
- - - - - -
- - - NDepend setParams - -
- Signature: setParams:(NDependParams -> NDependParams) -> unit
-
-
- - - - -

Runs NDepend on a .NET project file.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default NDependDefaults value.
  • -
- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-
 NDepend (fun p -> { p with 
-                    ProjectFile = currentDirectory @@ "NDependProjectFile.ndproj"
-                    CoverageFiles = [artifactsDir @@ "DotCover.xml" ]
-         })
-
- - - -
- - - NDependDefaults - -
- Signature: NDependParams
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-ngenhelper-ngenparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-ngenhelper-ngenparams.html deleted file mode 100644 index 2b1863f..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-ngenhelper-ngenparams.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - NGenParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NGenParams

-
-

NGen parameters

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - -

The timeout for the process.

- - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - -

(Required) Path to the NGenutil

- - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - -

The directory where the process will be started.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-ngenhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-ngenhelper.html deleted file mode 100644 index 4c7818a..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-ngenhelper.html +++ /dev/null @@ -1,250 +0,0 @@ - - - - - NGenHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NGenHelper

-
-

This module contains helper function for the ngen.exe

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- NGenParams -

NGen parameters

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - Install setParams assemblies - -
- Signature: setParams:(NGenParams -> NGenParams) -> assemblies:seq<string> -> unit
-
-
- - - - -

Runs ngen.exe install on given assemblies.

- - - -
- - - NGen setParams command - -
- Signature: setParams:(NGenParams -> NGenParams) -> command:string -> unit
-
-
- - - - -

Runs ngen.exe with the given command.

- - - -
- - - NGen32 - -
- Signature: string
-
-
- - - - - -
- - - NGen64 - -
- Signature: string
-
-
- - - - - -
- - - NGenDefaults - -
- Signature: NGenParams
-
-
- - - - -

NGen default parameters

- - - -
- - - UseNGen64 p - -
- Signature: p:NGenParams -> NGenParams
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-npmhelper-installargs.html b/packages/FAKE.4.11.3/docs/apidocs/fake-npmhelper-installargs.html deleted file mode 100644 index e6d4a49..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-npmhelper-installargs.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - InstallArgs - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-npmhelper-npmcommand.html b/packages/FAKE.4.11.3/docs/apidocs/fake-npmhelper-npmcommand.html deleted file mode 100644 index 3bce60c..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-npmhelper-npmcommand.html +++ /dev/null @@ -1,166 +0,0 @@ - - - - - NpmCommand - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NpmCommand

-
-

The list of supported Npm commands. The Custom alternative -can be used for other commands not in the list until they are -implemented

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - Custom(string) - -
- Signature: string
-
-
- - - - - -
- - - Install(InstallArgs) - -
- Signature: InstallArgs
-
-
- - - - - -
- - - Run(string) - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-npmhelper-npmparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-npmhelper-npmparams.html deleted file mode 100644 index 13517c4..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-npmhelper-npmparams.html +++ /dev/null @@ -1,200 +0,0 @@ - - - - - NpmParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NpmParams

-
-

The Npm parameter type

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Command - -
- Signature: NpmCommand
-
-
- - - - - -
- - - NpmFilePath - -
- Signature: string
-
-
- - - - - -
- - - Src - -
- Signature: string
-
-
- - - - - -
- - - Timeout - -
- Signature: TimeSpan
-
-
- - - - - -
- - - WorkingDirectory - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-npmhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-npmhelper.html deleted file mode 100644 index 49d43a2..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-npmhelper.html +++ /dev/null @@ -1,254 +0,0 @@ - - - - - NpmHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NpmHelper

-
-

Contains function to run npm tasks

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - -
TypeDescription
- InstallArgs -

Arguments for the Npm install command

- - -
- NpmCommand -

The list of supported Npm commands. The Custom alternative -can be used for other commands not in the list until they are -implemented

- - -
- NpmParams -

The Npm parameter type

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - defaultNpmParams - -
- Signature: NpmParams
-
-
- - - - -

Npm default parameters

- - - -
- - - Npm setParams - -
- Signature: setParams:(NpmParams -> NpmParams) -> unit
-
-
- - - - -

Runs npm with the given modification function. Make sure to have npm installed, -you can install npm with nuget or a regular install. To change which Npm executable -to use you can set the NpmFilePath parameter with the setParams function.

- -

Parameters

- -
    -
  • setParams - Function used to overwrite the Npm default parameters.
  • -
- -

Sample

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-
   Target "Web" (fun _ ->
-       Npm (fun p ->
-              { p with
-                  Command = Install Standard
-                  WorkingDirectory = "./src/FAKESimple.Web/"
-              })
-
-       Npm (fun p ->
-              { p with
-                  Command = (Run "build")
-                  WorkingDirectory = "./src/FAKESimple.Web/"
-              })
-   )
-
- - - -
- - - run npmParams - -
- Signature: npmParams:NpmParams -> unit
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-nuget-install-nugetinstallparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-nuget-install-nugetinstallparams.html deleted file mode 100644 index e8988b1..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-nuget-install-nugetinstallparams.html +++ /dev/null @@ -1,362 +0,0 @@ - - - - - NugetInstallParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NugetInstallParams

-
-

Nuget install parameters.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ConfigFile - -
- Signature: string option
-
-
- - - - -

NuGet configuration file. Default None.

- - - -
- - - ExcludeVersion - -
- Signature: bool
-
-
- - - - -

If set, the destination directory will contain only the package name, not the version number. Default false.

- - - -
- - - NoCache - -
- Signature: bool
-
-
- - - - -

Disable looking up packages from local machine cache. Default false.

- - - -
- - - NonInteractive - -
- Signature: bool
-
-
- - - - -

Do not prompt for user input or confirmations. Default true.

- - - -
- - - OutputDirectory - -
- Signature: string
-
-
- - - - -

Specifies the directory in which packages will be installed. Default ./packages/.

- - - -
- - - Prerelease - -
- Signature: bool
-
-
- - - - -

Allows updating to prerelease versions. Default false.

- - - -
- - - Retries - -
- Signature: int
-
-
- - - - -

Number of retries if update fails.

- - - -
- - - Sources - -
- Signature: string list
-
-
- - - - -

Nuget feeds to search updates in. Use default if empty.

- - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - -

Timeout for the update.

- - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - -

Path to the nuget.exe.

- - - -
- - - Verbosity - -
- Signature: NugetInstallVerbosity
-
-
- - - - -

Display this amount of details in the output: normal, quiet, detailed. Default normal.

- - - -
- - - Version - -
- Signature: string
-
-
- - - - -

The version of the package to install.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-nuget-install-nugetinstallverbosity.html b/packages/FAKE.4.11.3/docs/apidocs/fake-nuget-install-nugetinstallverbosity.html deleted file mode 100644 index c91af03..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-nuget-install-nugetinstallverbosity.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - NugetInstallVerbosity - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-nuget-install.html b/packages/FAKE.4.11.3/docs/apidocs/fake-nuget-install.html deleted file mode 100644 index 7ba3016..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-nuget-install.html +++ /dev/null @@ -1,191 +0,0 @@ - - - - - Install - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Install

-
-

Contains tasks for installing NuGet packages using the nuget.exe install command.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - -
TypeDescription
- NugetInstallParams -

Nuget install parameters.

- - -
- NugetInstallVerbosity -

Nuget install verbosity mode.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - NugetInstall setParams packageName - -
- Signature: setParams:(NugetInstallParams -> NugetInstallParams) -> packageName:string -> unit
-
-
- - - - -

Installs the given package.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default parameters.
  • -
  • packagesFile - Path to the *.sln, *.*proj or packages.config file, or simply a NuGet package name
  • -
- - - -
- - - NugetInstallDefaults - -
- Signature: NugetInstallParams
-
-
- - - - -

Parameter default values.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-nuget-update-nugetupdateparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-nuget-update-nugetupdateparams.html deleted file mode 100644 index b067a0f..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-nuget-update-nugetupdateparams.html +++ /dev/null @@ -1,341 +0,0 @@ - - - - - NugetUpdateParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NugetUpdateParams

-
-

Nuget update parameters.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ConfigFile - -
- Signature: string option
-
-
- - - - -

NuGet configuration file. Default None.

- - - -
- - - Ids - -
- Signature: string list
-
-
- - - - -

Packages to update. Update all if empty.

- - - -
- - - NonInteractive - -
- Signature: bool
-
-
- - - - -

Do not prompt for user input or confirmations. Default true.

- - - -
- - - Prerelease - -
- Signature: bool
-
-
- - - - -

Allows updating to prerelease versions. Default false.

- - - -
- - - RepositoryPath - -
- Signature: string
-
-
- - - - -

Folder to store packages in. Default ./packages.

- - - -
- - - Retries - -
- Signature: int
-
-
- - - - -

Number of retries if update fails.

- - - -
- - - Safe - -
- Signature: bool
-
-
- - - - -

Looks for updates with the highest version available within the same major and minor version as the installed package. Default false.

- - - -
- - - Sources - -
- Signature: string list
-
-
- - - - -

Nuget feeds to search updates in. Use default if empty.

- - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - -

Timeout for the update.

- - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - -

Path to the nuget.exe.

- - - -
- - - Verbose - -
- Signature: bool
-
-
- - - - -

Show verbose output while updating. Default false.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-nuget-update.html b/packages/FAKE.4.11.3/docs/apidocs/fake-nuget-update.html deleted file mode 100644 index c35ee0d..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-nuget-update.html +++ /dev/null @@ -1,185 +0,0 @@ - - - - - Update - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Update

-
-

Contains tasks for updating NuGet packages including assembly hint paths in the project files using the nuget.exe update command.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- NugetUpdateParams -

Nuget update parameters.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - NugetUpdate setParams packagesFile - -
- Signature: setParams:(NugetUpdateParams -> NugetUpdateParams) -> packagesFile:string -> unit
-
-
- - - - -

Update packages specified in the package file.

- -

Fails if packages are not installed; see nuget bug. -Fails if packages file has no corresponding VS project; see nuget bug.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default parameters.
  • -
  • packagesFile - Path to the *.sln, *.*proj or packages.config file.
  • -
- - - -
- - - NugetUpdateDefaults - -
- Signature: NugetUpdateParams
-
-
- - - - -

Parameter default values.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper-nugetdependencies.html b/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper-nugetdependencies.html deleted file mode 100644 index d80ddbb..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper-nugetdependencies.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - NugetDependencies - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NugetDependencies

-
-
-

Instance members

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Instance memberDescription
- - - Head - -
- Signature: string * string
-
-
- -
- - - IsEmpty - -
- Signature: bool
-
-
- -
- - - [index] - -
- Signature: index:int -> string * string
-
-
- -
- - - Length - -
- Signature: int
-
-
- -
- - - Tail - -
- Signature: (string * string) list
-
-
- -
-

Static members

- - - - - - - - - - -
Static memberDescription
- - - Empty - -
- Signature: (string * string) list
-
-
- -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper-nugetframeworkassemblyreferences.html b/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper-nugetframeworkassemblyreferences.html deleted file mode 100644 index 01076fa..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper-nugetframeworkassemblyreferences.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - NugetFrameworkAssemblyReferences - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper-nugetframeworkdependencies.html b/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper-nugetframeworkdependencies.html deleted file mode 100644 index bff7d17..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper-nugetframeworkdependencies.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - NugetFrameworkDependencies - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper-nugetframeworkreferences.html b/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper-nugetframeworkreferences.html deleted file mode 100644 index 0cb482c..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper-nugetframeworkreferences.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - NugetFrameworkReferences - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper-nugetparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper-nugetparams.html deleted file mode 100644 index a8c0865..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper-nugetparams.html +++ /dev/null @@ -1,632 +0,0 @@ - - - - - NuGetParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NuGetParams

-
-

Nuget parameter type

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - AccessKey - -
- Signature: string
-
-
- - - - - -
- - - Authors - -
- Signature: string list
-
-
- - - - - -
- - - Copyright - -
- Signature: string
-
-
- - - - - -
- - - Dependencies - -
- Signature: NugetDependencies
-
-
- - - - - -
- - - DependenciesByFramework - -
- Signature: NugetFrameworkDependencies list
-
-
- - - - - -
- - - Description - -
- Signature: string
-
-
- - - - - -
- - - Files - -
- Signature: (string * string option * string option) list
-
-
- - - - - -
- - - FrameworkAssemblies - -
- Signature: NugetFrameworkAssemblyReferences list
-
-
- - - - - -
- - - IncludeReferencedProjects - -
- Signature: bool
-
-
- - - - - -
- - - NoDefaultExcludes - -
- Signature: bool
-
-
- - - - - -
- - - NoPackageAnalysis - -
- Signature: bool
-
-
- - - - - -
- - - OutputPath - -
- Signature: string
-
-
- - - - - -
- - - Project - -
- Signature: string
-
-
- - - - - -
- - - ProjectFile - -
- Signature: string
-
-
- - - - - -
- - - Properties - -
- Signature: (string * string) list
-
-
- - - - - -
- - - Publish - -
- Signature: bool
-
-
- - - - - -
- - - PublishTrials - -
- Signature: int
-
-
- - - - - -
- - - PublishUrl - -
- Signature: string
-
-
- - - - - -
- - - References - -
- Signature: NugetReferences
-
-
- - - - - -
- - - ReferencesByFramework - -
- Signature: NugetFrameworkReferences list
-
-
- - - - - -
- - - ReleaseNotes - -
- Signature: string
-
-
- - - - - -
- - - Summary - -
- Signature: string
-
-
- - - - - -
- - - SymbolPackage - -
- Signature: NugetSymbolPackage
-
-
- - - - - -
- - - Tags - -
- Signature: string
-
-
- - - - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - - -
- - - Title - -
- Signature: string
-
-
- - - - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - - -
- - - Version - -
- Signature: string
-
-
- - - - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper-nugetreferences.html b/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper-nugetreferences.html deleted file mode 100644 index deeb1be..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper-nugetreferences.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - NugetReferences - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NugetReferences

-
-
-

Instance members

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Instance memberDescription
- - - Head - -
- Signature: string
-
-
- -
- - - IsEmpty - -
- Signature: bool
-
-
- -
- - - [index] - -
- Signature: index:int -> string
-
-
- -
- - - Length - -
- Signature: int
-
-
- -
- - - Tail - -
- Signature: string list
-
-
- -
-

Static members

- - - - - - - - - - -
Static memberDescription
- - - Empty - -
- Signature: string list
-
-
- -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper-nugetsymbolpackage.html b/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper-nugetsymbolpackage.html deleted file mode 100644 index 477f5f1..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper-nugetsymbolpackage.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - NugetSymbolPackage - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NugetSymbolPackage

-
-
-

Record Fields

- - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - None - -
- Signature: NugetSymbolPackage
- Modifiers: static
-
-
- - - - -

Do not build symbol packages

- - - -
- - - Nuspec - -
- Signature: NugetSymbolPackage
- Modifiers: static
-
-
- - - - -

Build a symbol package using the nuspec file

- - - -
- - - ProjectFile - -
- Signature: NugetSymbolPackage
- Modifiers: static
-
-
- - - - -

Build a symbol package using a project file, if provided

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper-nuspecpackage.html b/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper-nuspecpackage.html deleted file mode 100644 index e55420b..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper-nuspecpackage.html +++ /dev/null @@ -1,478 +0,0 @@ - - - - - NuSpecPackage - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NuSpecPackage

-
-

NuSpec metadata type

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Authors - -
- Signature: string
-
-
- - - - - -
- - - Created - -
- Signature: DateTime
-
-
- - - - - -
- - - Description - -
- Signature: string
-
-
- - - - - -
- - - Id - -
- Signature: string
-
-
- - - - - -
- - - IsLatestVersion - -
- Signature: bool
-
-
- - - - - -
- - - Language - -
- Signature: string
-
-
- - - - - -
- - - LicenseUrl - -
- Signature: string
-
-
- - - - - -
- - - Owners - -
- Signature: string
-
-
- - - - - -
- - - PackageHash - -
- Signature: string
-
-
- - - - - -
- - - PackageHashAlgorithm - -
- Signature: string
-
-
- - - - - -
- - - ProjectUrl - -
- Signature: string
-
-
- - - - - -
- - - Published - -
- Signature: DateTime
-
-
- - - - - -
- - - ReleaseNotes - -
- Signature: string
-
-
- - - - - -
- - - RequireLicenseAcceptance - -
- Signature: bool
-
-
- - - - - -
- - - Tags - -
- Signature: string
-
-
- - - - - -
- - - Url - -
- Signature: string
-
-
- - - - - -
- - - Version - -
- Signature: string
-
-
- - - - - -
-

Instance members

- - - - - - - - - - - - - - - - - - -
Instance memberDescription
- - - DirectoryName - -
- Signature: string
-
-
- - - - - -
- - - FileName - -
- Signature: string
-
-
- - - - - -
- - - Name - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper.html deleted file mode 100644 index ddcd450..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-nugethelper.html +++ /dev/null @@ -1,449 +0,0 @@ - - - - - NuGetHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NuGetHelper

-
-

Contains helper functions and task which allow to inspect, create and publish NuGet packages. -There is also a tutorial about nuget package creating available.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- NuGetParams -

Nuget parameter type

- - -
- NuSpecPackage -

NuSpec metadata type

- - -
- NugetDependencies -
- NugetFrameworkAssemblyReferences -
- NugetFrameworkDependencies -
- NugetFrameworkReferences -
- NugetReferences -
- NugetSymbolPackage -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - feedUrl - -
- Signature: string
-
-
- - - - -

Default NuGet feed

- - - -
- - - getDependencies packagesFile - -
- Signature: packagesFile:string -> (string * string) list
-
-
- - - - -

Returns the dependencies from specified packages.config file

- - - -
- - - GetMetaDataFromPackageFile (...) - -
- Signature: packageFileName:string -> NuSpecPackage
-
-
- - - - -

Returns the NuGet meta data from the given package file name.

- -

Parameters

- -
    -
  • packageFileName - The .nuspec package file name.
  • -
- - - -
- - - getNuspecProperties nuspec - -
- Signature: nuspec:string -> NuSpecPackage
-
-
- - - - -

Parses nuspec metadata from a nuspec file.

- -

Parameters

- -
    -
  • nuspec - The .nuspec file content.
  • -
- - - -
- - - GetPackageVersion deploymentsDir package - -
- Signature: deploymentsDir:string -> package:string -> string
-
-
- - - - -

Gets the version no. for a given package in the deployments folder

- - - -
- - - NuGet setParams nuspecOrProjectFile - -
- Signature: setParams:(NuGetParams -> NuGetParams) -> nuspecOrProjectFile:string -> unit
-
-
- - - - -

Creates a new NuGet package.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default NuGet parameters.
  • -
  • nuspecFile - The .nuspec file name.
  • -
- - - -
- - - NuGetDefaults () - -
- Signature: unit -> NuGetParams
-
-
- - - - -

NuGet default parameters

- - - -
- - - NuGetPack setParams nuspecOrProjectFile - -
- Signature: setParams:(NuGetParams -> NuGetParams) -> nuspecOrProjectFile:string -> unit
-
-
- - - - -

Creates a new NuGet package based on the given .nuspec file.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default NuGet parameters.
  • -
  • nuspecOrProjectFile - The .nuspec or project file name.
  • -
- - - -
- - - NuGetPackDirectly (...) - -
- Signature: setParams:(NuGetParams -> NuGetParams) -> nuspecOrProjectFile:string -> unit
-
-
- - - - -

Creates a new NuGet package based on the given .nuspec file.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default NuGet parameters.
  • -
  • nuspecOrProjectFile - The .nuspec or project file name.
  • -
- - - -
- - - NuGetPublish setParams - -
- Signature: setParams:(NuGetParams -> NuGetParams) -> unit
-
-
- - - - -

Publishes a NuGet package to the nuget server.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default NuGet parameters.
  • -
- - - -
- - - RequireExactly version - -
- Signature: version:string -> string
-
-
- - - - -

Creates a string which tells NuGet that you require exactly this package version.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-nunitcommon-nunitdomainmodel.html b/packages/FAKE.4.11.3/docs/apidocs/fake-nunitcommon-nunitdomainmodel.html deleted file mode 100644 index 61dd81b..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-nunitcommon-nunitdomainmodel.html +++ /dev/null @@ -1,220 +0,0 @@ - - - - - NUnitDomainModel - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NUnitDomainModel

-
-

The /domain option controls of the creation of AppDomains for running tests. See NUnit-Console Command Line Options

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - DefaultDomainModel - -
- Signature:
-
-
- - - - -

The default is to use multiple domains if multiple assemblies are listed on the command line. Otherwise a single domain is used.

- - - -
- - - MultipleDomainModel - -
- Signature:
-
-
- - - - -

A separate test domain is created for each assembly

- - - -
- - - NoDomainModel - -
- Signature:
-
-
- - - - -

No domain is created - the tests are run in the primary domain. This normally requires copying the NUnit assemblies into the same directory as your tests.

- - - -
- - - SingleDomainModel - -
- Signature:
-
-
- - - - -

A test domain is created - this is how NUnit worked prior to version 2.4

- - - -
-

Instance members

- - - - - - - - - - -
Instance memberDescription
- - - ParamString - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-nunitcommon-nuniterrorlevel.html b/packages/FAKE.4.11.3/docs/apidocs/fake-nunitcommon-nuniterrorlevel.html deleted file mode 100644 index 36e882b..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-nunitcommon-nuniterrorlevel.html +++ /dev/null @@ -1,102 +0,0 @@ - - - - - NUnitErrorLevel - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-nunitcommon-nunitparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-nunitcommon-nunitparams.html deleted file mode 100644 index 75cfc06..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-nunitcommon-nunitparams.html +++ /dev/null @@ -1,512 +0,0 @@ - - - - - NUnitParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NUnitParams

-
-

The NUnit Console Parameters type. -FAKE will use NUnitDefaults for values not provided.

- -

For reference, see: NUnit-Console Command Line Options

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - DisableShadowCopy - -
- Signature: bool
-
-
- - - - -

Disables shadow copying of the assembly in order to provide improved performance.

- - - -
- - - Domain - -
- Signature: NUnitDomainModel
-
-
- - - - -

See NUnitDomainModel.

- - - -
- - - DontTestInNewThread - -
- Signature: bool
-
-
- - - - -

Suppresses use of a separate thread for running the tests and uses the main thread instead.

- - - -
- - - ErrorLevel - -
- Signature: NUnitErrorLevel
-
-
- - - - -

Default: TestRunnerErrorLevel.Error

- - - -
- - - ErrorOutputFile - -
- Signature: string
-
-
- - - - -

Redirects error output created by the tests from standard error output (console) to the file specified as value.

- - - -
- - - ExcludeCategory - -
- Signature: string
-
-
- - - - -

The Categories to be excluded in a test run. Multiple categories may be specified on either option, by using commas to separate them.

- - - -
- - - Fixture - -
- Signature: string
-
-
- - - - -

Default: ""

- - - -
- - - Framework - -
- Signature: string
-
-
- - - - -

Allows you to specify the version of the runtime to be used in executing tests.

- - - -
- - - IncludeCategory - -
- Signature: string
-
-
- - - - -

The Categories to be included in a test run. Multiple categories may be specified on either option, by using commas to separate them.

- - - -
- - - Out - -
- Signature: string
-
-
- - - - -

Redirects output created by the tests from standard output (console) to the file specified as value.

- - - -
- - - OutputFile - -
- Signature: string
-
-
- - - - -

The output path of the nUnit XML report.

- - - -
- - - ProcessModel - -
- Signature: NUnitProcessModel
-
-
- - - - -

Controls how NUnit loads tests in processes. See: NUnitProcessModel.

- - - -
- - - ShowLabels - -
- Signature: bool
-
-
- - - - -

Causes an identifying label to be displayed at the start of each test case.

- - - -
- - - StopOnError - -
- Signature: bool
-
-
- - - - -

Causes execution of the test run to terminate immediately on the first test failure or error.

- - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - -

The default timeout to be used for test cases. If any test exceeds the timeout value, it is cancelled and reported as an error.

- - - -
- - - ToolName - -
- Signature: string
-
-
- - - - -

NUnit console runner name. ( nunit-console.exe)

- - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - -

The path to the NUnit console runner: nunit-console.exe

- - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - -

The working directory.

- - - -
- - - XsltTransformFile - -
- Signature: string
-
-
- - - - -

The path to a custom XSLT transform file to be used to process the XML report.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-nunitcommon-nunitprocessmodel.html b/packages/FAKE.4.11.3/docs/apidocs/fake-nunitcommon-nunitprocessmodel.html deleted file mode 100644 index dc0e12b..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-nunitcommon-nunitprocessmodel.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - NUnitProcessModel - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NUnitProcessModel

-
-

Process model for nunit to use, see Project Editor

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - DefaultProcessModel - -
- Signature:
-
-
- - - - - -
- - - MultipleProcessModel - -
- Signature:
-
-
- - - - - -
- - - SeparateProcessModel - -
- Signature:
-
-
- - - - - -
- - - SingleProcessModel - -
- Signature:
-
-
- - - - - -
-

Instance members

- - - - - - - - - - -
Instance memberDescription
- - - ParamString - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-nunitcommon.html b/packages/FAKE.4.11.3/docs/apidocs/fake-nunitcommon.html deleted file mode 100644 index 4440c09..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-nunitcommon.html +++ /dev/null @@ -1,238 +0,0 @@ - - - - - NUnitCommon - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NUnitCommon

-
-

Contains types and utility functions relaited to running NUnit unit tests.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- NUnitDomainModel -

The /domain option controls of the creation of AppDomains for running tests. See NUnit-Console Command Line Options

- - -
- NUnitErrorLevel -

Option which allows to specify if a NUnit error should break the build.

- - -
- NUnitParams -

The NUnit Console Parameters type. -FAKE will use NUnitDefaults for values not provided.

- -

For reference, see: NUnit-Console Command Line Options

- - -
- NUnitProcessModel -

Process model for nunit to use, see Project Editor

- - -
- -
- -

Functions and values

- - - - - - - - - - -
Function or valueDescription
- - - NUnitDefaults - -
- Signature: NUnitParams
-
-
- - - - -

The NUnitParams default parameters.

- -

Defaults

- -
    -
  • IncludeCategory - ""
  • -
  • ExcludeCategory - ""
  • -
  • ToolPath - ""
  • -
  • ToolName - "nunit-console.exe"
  • -
  • DontTestInNewThread- false
  • -
  • StopOnError - false
  • -
  • OutputFile - The nunit-console.exe path if it exists in a subdirectory of the current directory.
  • -
  • Out - ""
  • -
  • ErrorOutputFile - ""
  • -
  • WorkingDir - ""
  • -
  • Framework - ""
  • -
  • ProcessModel - DefaultProcessModel
  • -
  • ShowLabels - true
  • -
  • XsltTransformFile - ""
  • -
  • TimeOut - 5 minutes
  • -
  • DisableShadowCopy - false
  • -
  • Domain - DefaultDomainModel
  • -
  • ErrorLevel - Error
  • -
  • Fixture - ""
  • -
- - - -
-

Active patterns

- - - - - - - - - - -
Active patternDescription
- - - ( |OK|TestsFailed|FatalError| ) (...) - -
- Signature: errorCode:int -> Choice<unit,unit,string>
-
-
- - - - -

NUnit console returns negative error codes for errors and sum of failed, ignored and exceptional tests otherwise. -Zero means that all tests passed.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-nunitparallel.html b/packages/FAKE.4.11.3/docs/apidocs/fake-nunitparallel.html deleted file mode 100644 index c191419..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-nunitparallel.html +++ /dev/null @@ -1,156 +0,0 @@ - - - - - NUnitParallel - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NUnitParallel

-
-

Contains tasks to run NUnit unit tests in parallel.

- - -
- - - -

Functions and values

- - - - - - - - - - -
Function or valueDescription
- - - NUnitParallel setParams assemblies - -
- Signature: setParams:(NUnitParams -> NUnitParams) -> assemblies:seq<string> -> unit
-
-
- - - - -

Runs NUnit in parallel on a group of assemblies.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default NUnitParams value.
  • -
  • assemblies - Sequence of one or more assemblies containing NUnit unit tests.
  • -
- -

Sample usage

- - - - -
1: 
-2: 
-3: 
-4: 
-
Target "Test" (fun _ ->
-    !! (testDir + @"\Test.*.dll") 
-      |> NUnitParallel (fun p -> { p with ErrorLevel = DontFailBuild })
-)
-
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-nunitsequential.html b/packages/FAKE.4.11.3/docs/apidocs/fake-nunitsequential.html deleted file mode 100644 index e124fb8..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-nunitsequential.html +++ /dev/null @@ -1,156 +0,0 @@ - - - - - NUnitSequential - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NUnitSequential

-
-

Contains tasks to run NUnit unit tests.

- - -
- - - -

Functions and values

- - - - - - - - - - -
Function or valueDescription
- - - NUnit setParams assemblies - -
- Signature: setParams:(NUnitParams -> NUnitParams) -> assemblies:seq<string> -> unit
-
-
- - - - -

Runs NUnit on a group of assemblies.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default NUnitParams value.
  • -
  • assemblies - Sequence of one or more assemblies containing NUnit unit tests.
  • -
- -

Sample usage

- - - - -
1: 
-2: 
-3: 
-4: 
-
Target "Test" (fun _ ->
-    !! (testDir + @"\Test.*.dll") 
-      |> NUnit (fun p -> { p with ErrorLevel = DontFailBuild })
-)
-
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-nunitxml.html b/packages/FAKE.4.11.3/docs/apidocs/fake-nunitxml.html deleted file mode 100644 index 8ed77aa..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-nunitxml.html +++ /dev/null @@ -1,134 +0,0 @@ - - - - - NUnitXml - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NUnitXml

-
-

Contains types and functions for working with NUnit unit tests result xml.

- - -
- - - -

Functions and values

- - - - - - - - - - -
Function or valueDescription
- - - AllSucceeded xDocs - -
- Signature: xDocs:seq<'?9207> -> bool
- Type parameters: '?9207
-
- - - - -

Returns whether all tests in the given test result have succeeded

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-octotools-createreleaseoptions.html b/packages/FAKE.4.11.3/docs/apidocs/fake-octotools-createreleaseoptions.html deleted file mode 100644 index fadefe6..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-octotools-createreleaseoptions.html +++ /dev/null @@ -1,320 +0,0 @@ - - - - - CreateReleaseOptions - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

CreateReleaseOptions

-
-

Options for creating a new release

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Channel - -
- Signature: string option
-
-
- - - - -

Channel to use for the new release

- - - -
- - - IgnoreChannelRules - -
- Signature: bool
-
-
- - - - -

Ignore package version matching rules

- - - -
- - - IgnoreExisting - -
- Signature: bool
-
-
- - - - -

If a release with the version number already exists, ignore it

- - - -
- - - Packages - -
- Signature: string list
-
-
- - - - -

Version number to use for a package in the release

- - - -
- - - PackagesFolder - -
- Signature: string option
-
-
- - - - -

A folder containing NuGet packages from which we should get versions

- - - -
- - - PackageVersion - -
- Signature: string
-
-
- - - - -

Default version of all packages to use for this release

- - - -
- - - Project - -
- Signature: string
-
-
- - - - -

Name of the project

- - - -
- - - ReleaseNotes - -
- Signature: string
-
-
- - - - -

Release Notes for the new release

- - - -
- - - ReleaseNotesFile - -
- Signature: string
-
-
- - - - -

Path to a file that contains Release Notes for the new release

- - - -
- - - Version - -
- Signature: string
-
-
- - - - -

Release number to use for the new release

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-octotools-deletereleaseoptions.html b/packages/FAKE.4.11.3/docs/apidocs/fake-octotools-deletereleaseoptions.html deleted file mode 100644 index 3a6160c..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-octotools-deletereleaseoptions.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - DeleteReleaseOptions - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

DeleteReleaseOptions

-
-

Options for deleting a range of releases in a project

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - MaxVersion - -
- Signature: string
-
-
- - - - -

Maximum (inclusive) version number for the range of versions to delete

- - - -
- - - MinVersion - -
- Signature: string
-
-
- - - - -

Minimum (inclusive) version number for the range of versions to delete

- - - -
- - - Project - -
- Signature: string
-
-
- - - - -

Name of the project

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-octotools-deployreleaseoptions.html b/packages/FAKE.4.11.3/docs/apidocs/fake-octotools-deployreleaseoptions.html deleted file mode 100644 index 7ad7882..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-octotools-deployreleaseoptions.html +++ /dev/null @@ -1,284 +0,0 @@ - - - - - DeployReleaseOptions - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

DeployReleaseOptions

-
-

Options for deploying a release to an environment

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - DeploymentCheckSleepCycle - -
- Signature: TimeSpan option
-
-
- - - - -

Specifies how much time should elapse between deployment status -checks (default: 10 seconds)

- - - -
- - - DeploymentTimeout - -
- Signature: TimeSpan option
-
-
- - - - -

Specifies maximum time that deployment can take -(default: 10 minutes)

- - - -
- - - DeployTo - -
- Signature: string
-
-
- - - - -

Environment to deploy to

- - - -
- - - Force - -
- Signature: bool
-
-
- - - - -

If a project is configured to skip packages with already-installed -versions, override this setting to force re-deployment

- - - -
- - - Project - -
- Signature: string
-
-
- - - - -

Name of the project

- - - -
- - - SpecificMachines - -
- Signature: string option
-
-
- - - - -

A comma-separated list of machine names to target in the -deployed environment. If not specified, all machines in -the environment will be considered.

- - - -
- - - Version - -
- Signature: string
-
-
- - - - -

Version number of the release to deploy; Specify "latest" for -the latest release

- - - -
- - - WaitForDeployment - -
- Signature: bool
-
-
- - - - -

Whether to wait synchronously for deployment to finish

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-octotools-octocommand.html b/packages/FAKE.4.11.3/docs/apidocs/fake-octotools-octocommand.html deleted file mode 100644 index 5069002..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-octotools-octocommand.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - OctoCommand - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

OctoCommand

-
-

Option type for selecting one command

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - CreateRelease(...) - -
- Signature: CreateReleaseOptions * DeployReleaseOptions option
-
-
- - - - - -
- - - DeleteRelease(DeleteReleaseOptions) - -
- Signature: DeleteReleaseOptions
-
-
- - - - - -
- - - DeployRelease(DeployReleaseOptions) - -
- Signature: DeployReleaseOptions
-
-
- - - - - -
- - - ListEnvironments - -
- Signature:
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-octotools-octoparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-octotools-octoparams.html deleted file mode 100644 index 90a6710..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-octotools-octoparams.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - OctoParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

OctoParams

-
-

Complete Octo.exe CLI params

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Command - -
- Signature: OctoCommand
-
-
- - - - - -
- - - Server - -
- Signature: OctoServerOptions
-
-
- - - - - -
- - - Timeout - -
- Signature: TimeSpan
-
-
- - - - - -
- - - ToolName - -
- Signature: string
-
-
- - - - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - - -
- - - WorkingDirectory - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-octotools-octoserveroptions.html b/packages/FAKE.4.11.3/docs/apidocs/fake-octotools-octoserveroptions.html deleted file mode 100644 index a577e20..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-octotools-octoserveroptions.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - OctoServerOptions - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

OctoServerOptions

-
-

Octo.exe server options

- - -
-

Record Fields

- - - - - - - - - - - - - - -
Record FieldDescription
- - - ApiKey - -
- Signature: string
-
-
- - - - -

Your API key; retrieved from the user profile page.

- - - -
- - - Server - -
- Signature: string
-
-
- - - - -

The base URL for your Octopus server

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-octotools.html b/packages/FAKE.4.11.3/docs/apidocs/fake-octotools.html deleted file mode 100644 index b50cfd8..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-octotools.html +++ /dev/null @@ -1,333 +0,0 @@ - - - - - OctoTools - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

OctoTools

-
-

Contains tasks which can be used for automated deployment via Octopus Deploy. -There is also a tutorial about the Octopus deployment helper available.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- CreateReleaseOptions -

Options for creating a new release

- - -
- DeleteReleaseOptions -

Options for deleting a range of releases in a project

- - -
- DeployReleaseOptions -

Options for deploying a release to an environment

- - -
- OctoCommand -

Option type for selecting one command

- - -
- OctoParams -

Complete Octo.exe CLI params

- - -
- OctoServerOptions -

Octo.exe server options

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - commandLine command - -
- Signature: command:OctoCommand -> string
-
-
- - - - -

Maps a command to string input for the octopus tools cli.

- - - -
- - - deleteOptions - -
- Signature: DeleteReleaseOptions
-
-
- - - - -

Default options for 'DeleteReleases'

- - - -
- - - deployOptions - -
- Signature: DeployReleaseOptions
-
-
- - - - -

Default options for 'DeployRelease'

- - - -
- - - Octo setParams - -
- Signature: setParams:(OctoParams -> OctoParams) -> unit
-
-
- - - - -

This task calls the Octo.exe CLI. -See Octopus-Tools for more details.

- -

Parameters

- -
    -
  • setParams - Function used to overwrite the OctoTools default parameters.
  • -
- - - -
- - - octoParams - -
- Signature: OctoParams
-
-
- - - - -

Default parameters to call octo.exe.

- - - -
- - - releaseOptions - -
- Signature: CreateReleaseOptions
-
-
- - - - -

Default options for 'CreateRelease'

- - - -
- - - serverOptions - -
- Signature: OctoServerOptions
-
-
- - - - -

Default server options.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-opencoverhelper-opencoverparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-opencoverhelper-opencoverparams.html deleted file mode 100644 index 7939bb7..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-opencoverhelper-opencoverparams.html +++ /dev/null @@ -1,302 +0,0 @@ - - - - - OpenCoverParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

OpenCoverParams

-
-

OpenCover parameters, for more details see: https://github.com/OpenCover/opencover/wiki/Usage#console-application-usage.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ExePath - -
- Signature: string
-
-
- - - - -

(Required) Path to the OpenCover console application

- - - -
- - - Filter - -
- Signature: string
-
-
- - - - -

A list of filters to apply to selectively include or exclude assemblies and classes from coverage results.

- - - -
- - - MergeByHash - -
- Signature: bool
-
-
- - - - -

This option is used to merge the coverage results for an assembly regardless of where it was loaded -assuming the assembly has the same file-hash in each location.

- - - -
- - - OptionalArguments - -
- Signature: string
-
-
- - - - -

This options is used to add additional optional arguments, could be somthing like "-returntargetcode "

- - - -
- - - Output - -
- Signature: string
-
-
- - - - -

The location and name of the output xml file. -If no value is supplied then the current directory -will be used and the output filename will be results.xml.

- - - -
- - - Register - -
- Signature: RegisterType
-
-
- - - - -

Use this to register and de-register the code coverage profiler.

- - - -
- - - TestRunnerExePath - -
- Signature: string
-
-
- - - - -

(Required) Path to the NUnit/XUnit console runner

- - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - -

The timeout for the OpenCover process.

- - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - -

The directory where the OpenCover process will be started.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-opencoverhelper-registertype.html b/packages/FAKE.4.11.3/docs/apidocs/fake-opencoverhelper-registertype.html deleted file mode 100644 index 0d03cd0..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-opencoverhelper-registertype.html +++ /dev/null @@ -1,161 +0,0 @@ - - - - - RegisterType - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-opencoverhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-opencoverhelper.html deleted file mode 100644 index 8bd950e..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-opencoverhelper.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - OpenCoverHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

OpenCoverHelper

-
-

Contains a task which can be used to run OpenCover on .NET assemblies.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - -
TypeDescription
- OpenCoverParams -

OpenCover parameters, for more details see: https://github.com/OpenCover/opencover/wiki/Usage#console-application-usage.

- - -
- RegisterType -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - OpenCover setParams targetArgs - -
- Signature: setParams:(OpenCoverParams -> OpenCoverParams) -> targetArgs:string -> unit
-
-
- - - - -

Runs OpenCover on a group of assemblies.

- -

Parameters

- -
    -
  • setParams - Function used to overwrite the default OpenCover parameters.
  • -
  • targetArgs - Test runner arguments.
  • -
- -

Sample

- - - - -
1: 
-2: 
-
 OpenCover (fun p -> { p with TestRunnerExePath = "./Tools/NUnit/nunit-console.exe" }) 
-    "project-file.nunit /config:Release /noshadow /xml:artifacts/nunit.xml /framework:net-4.0"
-
- - - -
- - - OpenCoverDefaults - -
- Signature: OpenCoverParams
-
-
- - - - -

OpenCover default parameters

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-paket-paketpackparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-paket-paketpackparams.html deleted file mode 100644 index 726272e..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-paket-paketpackparams.html +++ /dev/null @@ -1,308 +0,0 @@ - - - - - PaketPackParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

PaketPackParams

-
-

Paket pack parameter type

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - BuildConfig - -
- Signature: string
-
-
- - - - - -
- - - ExcludedTemplates - -
- Signature: string list
-
-
- - - - - -
- - - LockDependencies - -
- Signature: bool
-
-
- - - - - -
- - - OutputPath - -
- Signature: string
-
-
- - - - - -
- - - ReleaseNotes - -
- Signature: string
-
-
- - - - - -
- - - SpecificVersions - -
- Signature: (string * string) list
-
-
- - - - - -
- - - TemplateFile - -
- Signature: string
-
-
- - - - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - - -
- - - Version - -
- Signature: string
-
-
- - - - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-paket-paketpushparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-paket-paketpushparams.html deleted file mode 100644 index 70f19c4..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-paket-paketpushparams.html +++ /dev/null @@ -1,236 +0,0 @@ - - - - - PaketPushParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

PaketPushParams

-
-

Paket push parameter type

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ApiKey - -
- Signature: string
-
-
- - - - - -
- - - DegreeOfParallelism - -
- Signature: int
-
-
- - - - - -
- - - EndPoint - -
- Signature: string
-
-
- - - - - -
- - - PublishUrl - -
- Signature: string
-
-
- - - - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-paket.html b/packages/FAKE.4.11.3/docs/apidocs/fake-paket.html deleted file mode 100644 index 4d25a14..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-paket.html +++ /dev/null @@ -1,259 +0,0 @@ - - - - - Paket - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Paket

-
-

Contains helper functions and task which allow to inspect, create and publish NuGet packages with Paket.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - -
TypeDescription
- PaketPackParams -

Paket pack parameter type

- - -
- PaketPushParams -

Paket push parameter type

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - GetDependenciesForReferencesFile (...) - -
- Signature: referencesFile:string -> (string * string) []
-
-
- - - - -

Returns the dependencies from specified paket.references file

- - - -
- - - Pack setParams - -
- Signature: setParams:(PaketPackParams -> PaketPackParams) -> unit
-
-
- - - - -

Creates a new NuGet package by using Paket pack on all paket.template files in the working directory.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default parameters.
  • -
- - - -
- - - PaketPackDefaults () - -
- Signature: unit -> PaketPackParams
-
-
- - - - -

Paket pack default parameters

- - - -
- - - PaketPushDefaults () - -
- Signature: unit -> PaketPushParams
-
-
- - - - -

Paket push default parameters

- - - -
- - - Push setParams - -
- Signature: setParams:(PaketPushParams -> PaketPushParams) -> unit
-
-
- - - - -

Pushes all NuGet packages in the working dir to the server by using Paket push.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default parameters.
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-permissionshelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-permissionshelper.html deleted file mode 100644 index d9e25d4..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-permissionshelper.html +++ /dev/null @@ -1,180 +0,0 @@ - - - - - PermissionsHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

PermissionsHelper

-
-

Contains functions which allow to deal with permissions.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - isAdmin identity - -
- Signature: identity:WindowsIdentity -> bool
-
-
- - - - -

Returns whether the given user has administrator permissions.

- -

Parameters

- -
    -
  • identity - The windows identity of the user in question.
  • -
- - - -
- - - requiresAdmin f - -
- Signature: f:(unit -> '?8884) -> '?8884
- Type parameters: '?8884
-
- - - - -

Checks that the current user has administrator permissions - otherwise it throws an exception.

- -

Parameters

- -
    -
  • f - This Function will be excuted if the use has the right permissions.
  • -
- -

Sample

- - - - -
1: 
-2: 
-3: 
-
Target "Install" (fun _ -> 
-     requiresAdmin (fun _ -> installMSI())
- )
-
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-processhelper-consolemessage.html b/packages/FAKE.4.11.3/docs/apidocs/fake-processhelper-consolemessage.html deleted file mode 100644 index 107261d..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-processhelper-consolemessage.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - ConsoleMessage - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ConsoleMessage

-
-

A record type which captures console messages

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - IsError - -
- Signature: bool
-
-
- - - - - -
- - - Message - -
- Signature: string
-
-
- - - - - -
- - - Timestamp - -
- Signature: DateTimeOffset
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-processhelper-execparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-processhelper-execparams.html deleted file mode 100644 index 9050f2b..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-processhelper-execparams.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - - ExecParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ExecParams

-
-

Parameter type for process execution.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Args - -
- Signature: (string * string) list
-
-
- - - - -

Command-line argument pairs. The value will be quoted if it contains -a string, and the result will be appended to the CommandLine property. -If the key ends in a letter or number, a space will be inserted between -the key and the value.

- - - -
- - - CommandLine - -
- Signature: string
-
-
- - - - -

Command-line parameters in a string.

- - - -
- - - Program - -
- Signature: string
-
-
- - - - -

The path to the executable, without arguments.

- - - -
- - - WorkingDirectory - -
- Signature: string
-
-
- - - - -

The working directory for the program. Defaults to "".

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-processhelper-processresult.html b/packages/FAKE.4.11.3/docs/apidocs/fake-processhelper-processresult.html deleted file mode 100644 index 4f09dcf..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-processhelper-processresult.html +++ /dev/null @@ -1,216 +0,0 @@ - - - - - ProcessResult - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ProcessResult

-
-

A process result including error code, message log and errors.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Errors - -
- Signature: List<string>
-
-
- - - - - -
- - - ExitCode - -
- Signature: int
-
-
- - - - - -
- - - Messages - -
- Signature: List<string>
-
-
- - - - - -
-

Instance members

- - - - - - - - - - -
Instance memberDescription
- - - OK - -
- Signature: bool
-
-
- - - - - -
-

Static members

- - - - - - - - - - -
Static memberDescription
- - - New(exitCode messages errors) - -
- Signature: exitCode:int -> messages:List<string> -> errors:List<string> -> ProcessResult
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-processhelper-shell.html b/packages/FAKE.4.11.3/docs/apidocs/fake-processhelper-shell.html deleted file mode 100644 index 77e61cf..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-processhelper-shell.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - Shell - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Shell

-
-

Allows to exec shell operations synchronously and asynchronously.

- - -
-

Constructors

- - - - - - - - - - -
ConstructorDescription
- - - new() - -
- Signature: unit -> Shell
-
-
- - - - - -
-

Static members

- - - - - - - - - - - - - - -
Static memberDescription
- - - AsyncExec(cmd, args, dir) - -
- Signature: (cmd:string * args:string option * dir:string option) -> Async<int>
-
-
- - - - -

Runs the given process asynchronously.

- -

Parameters

- -
    -
  • cmd - The command which should be run in elavated context.
  • -
  • args - The process arguments (optional).
  • -
  • directory - The working directory (optional).
  • -
- - - -
- - - Exec(cmd, args, dir) - -
- Signature: (cmd:string * args:string option * dir:string option) -> int
-
-
- - - - -

Runs the given process, waits for it's completion and returns the exit code.

- -

Parameters

- -
    -
  • cmd - The command which should be run in elavated context.
  • -
  • args - The process arguments (optional).
  • -
  • directory - The working directory (optional).
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-processhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-processhelper.html deleted file mode 100644 index 5363bbc..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-processhelper.html +++ /dev/null @@ -1,769 +0,0 @@ - - - - - ProcessHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ProcessHelper

-
-

Contains functions which can be used to start other tools.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- ConsoleMessage -

A record type which captures console messages

- - -
- ExecParams -

Parameter type for process execution.

- - -
- ProcessResult -

A process result including error code, message log and errors.

- - -
- Shell -

Allows to exec shell operations synchronously and asynchronously.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - asyncShellExec args - -
- Signature: args:ExecParams -> Async<int>
-
-
- - - - -

Execute an external program asynchronously and return the exit code, -logging output and error messages to FAKE output. You can compose the result -with Async.Parallel to run multiple external programs at once, but be -sure that none of them depend on the output of another.

- - - -
- - - defaultParams - -
- Signature: ExecParams
-
-
- - - - -

Default parameters for process execution.

- - - -
- - - directExec configProcessStartInfoF - -
- Signature: configProcessStartInfoF:(ProcessStartInfo -> unit) -> bool
-
-
- - - - -

Runs the given process, waits for its completion and returns if it succeeded.

- - - -
- - - ensureProcessesHaveStopped name timeout - -
- Signature: name:string -> timeout:TimeSpan -> unit
-
-
- - - - -

Waits until the processes with the given name have stopped or fails after given timeout.

- -

Parameters

- -
    -
  • name - The name of the processes in question.
  • -
  • timeout - The timespan to time out after.
  • -
- - - -
- - - ExecProcess (...) - -
- Signature: configProcessStartInfoF:(ProcessStartInfo -> unit) -> timeOut:TimeSpan -> int
-
-
- - - - -

Runs the given process and returns the exit code.

- -

Parameters

- -
    -
  • configProcessStartInfoF - A function which overwrites the default ProcessStartInfo.
  • -
  • timeOut - The timeout for the process.

    -

    Sample

    -

    let result = ExecProcess (fun info ->
    - info.FileName <- "c:/MyProc.exe" - info.WorkingDirectory <- "c:/workingDirectory" - info.Arguments <- "-v") (TimeSpan.FromMinutes 5.0)

    -

    if result <> 0 then failwithf "MyProc.exe returned with a non-zero exit code"

  • -
- - - -
- - - ExecProcessAndReturnMessages (...) - -
- Signature: configProcessStartInfoF:(ProcessStartInfo -> unit) -> timeOut:TimeSpan -> ProcessResult
-
-
- - - - -

Runs the given process and returns the process result.

- -

Parameters

- -
    -
  • configProcessStartInfoF - A function which overwrites the default ProcessStartInfo.
  • -
  • timeOut - The timeout for the process.
  • -
- - - -
- - - ExecProcessElevated cmd args timeOut - -
- Signature: cmd:string -> args:string -> timeOut:TimeSpan -> int
-
-
- - - - -

Runs the given process in an elevated context and returns the exit code.

- -

Parameters

- -
    -
  • cmd - The command which should be run in elavated context.
  • -
  • args - The process arguments.
  • -
  • timeOut - The timeout for the process.
  • -
- - - -
- - - ExecProcessRedirected (...) - -
- Signature: configProcessStartInfoF:(ProcessStartInfo -> unit) -> timeOut:TimeSpan -> bool * seq<ConsoleMessage>
-
-
- - - - -

Runs the given process and returns the process result.

- -

Parameters

- -
    -
  • configProcessStartInfoF - A function which overwrites the default ProcessStartInfo.
  • -
  • timeOut - The timeout for the process.
  • -
- - - -
- - - ExecProcessWithLambdas (...) - -
- Signature: configProcessStartInfoF:(ProcessStartInfo -> unit) -> timeOut:TimeSpan -> silent:bool -> errorF:(string -> unit) -> messageF:(string -> unit) -> int
-
-
- - - - -

Runs the given process and returns the exit code.

- -

Parameters

- -
    -
  • configProcessStartInfoF - A function which overwrites the default ProcessStartInfo.
  • -
  • timeOut - The timeout for the process.
  • -
  • silent - If this flag is set then the process output is redirected to the given output functions errorF and messageF.
  • -
  • errorF - A function which will be called with the error log.
  • -
  • messageF - A function which will be called with the message log.
  • -
- - - -
- - - fireAndForget configProcessStartInfoF - -
- Signature: configProcessStartInfoF:(ProcessStartInfo -> unit) -> unit
-
-
- - - - -

Starts the given process and returns immediatly.

- - - -
- - - getProcessesByName name - -
- Signature: name:string -> seq<Process>
-
-
- - - - -

Returns all processes with the given name

- - - -
- - - kill proc - -
- Signature: proc:Process -> unit
-
-
- - - - -

Kills the given process

- - - -
- - - killAllCreatedProcesses () - -
- Signature: unit -> unit
-
-
- - - - -

Kills all processes that are created by the FAKE build script unless "donotkill" flag was set.

- - - -
- - - killFSI () - -
- Signature: unit -> unit
-
-
- - - - -

Kills the F# Interactive (FSI) process.

- - - -
- - - killMSBuild () - -
- Signature: unit -> unit
-
-
- - - - -

Kills the MSBuild process.

- - - -
- - - killProcess name - -
- Signature: name:string -> unit
-
-
- - - - -

Kills all processes with the given name

- - - -
- - - killProcessById id - -
- Signature: id:int -> unit
-
-
- - - - -

Kills all processes with the given id

- - - -
- - - pathDirectories - -
- Signature: seq<string>
-
-
- - - - -

Gets the list of valid directories included in the PATH environment variable.

- - - -
- - - RunRemoteService (...) - -
- Signature: command:string -> host:string -> serviceName:string -> unit
-
-
- - - - -

Sends a command to a remote windows service.

- - - -
- - - RunService command serviceName - -
- Signature: command:string -> serviceName:string -> unit
-
-
- - - - -

Sends a command to a local windows service.

- - - -
- - - StartProcess configProcessStartInfoF - -
- Signature: configProcessStartInfoF:(ProcessStartInfo -> unit) -> unit
-
-
- - - - -

Starts the given process and forgets about it.

- - - -
- - - StartRemoteService host serviceName - -
- Signature: host:string -> serviceName:string -> unit
-
-
- - - - -

Starts a remote windows service. Waits up to two minutes for a response.

- - - -
- - - StartService serviceName - -
- Signature: serviceName:string -> unit
-
-
- - - - -

Starts a local windows service. Waits up to two minutes for a response.

- - - -
- - - StopRemoteService host serviceName - -
- Signature: host:string -> serviceName:string -> unit
-
-
- - - - -

Stops a remote windows service. Waits up to two minutes for a response.

- - - -
- - - StopService serviceName - -
- Signature: serviceName:string -> unit
-
-
- - - - -

Stops a local windows service. Waits up to two minutes for a response.

- - - -
- - - tryFindFileOnPath file - -
- Signature: file:string -> string option
-
-
- - - - -

Searches the current directory and the directories within the PATH -environment variable for the given file. If successful returns the full -path to the file.

- -

Parameters

- -
    -
  • file - The file to locate
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-processtestrunner-processtestrunnerparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-processtestrunner-processtestrunnerparams.html deleted file mode 100644 index aa779a8..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-processtestrunner-processtestrunnerparams.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - ProcessTestRunnerParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ProcessTestRunnerParams

-
-

The ProcessTestRunner parameter type.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ErrorLevel - -
- Signature: TestRunnerErrorLevel
-
-
- - - - -

Option which allows to specify if a test runner error should break the build.

- - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - -

If the timeout is reached the xUnit task will be killed. Default is 5 minutes.

- - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - -

The working directory (optional).

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-processtestrunner.html b/packages/FAKE.4.11.3/docs/apidocs/fake-processtestrunner.html deleted file mode 100644 index 2640624..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-processtestrunner.html +++ /dev/null @@ -1,241 +0,0 @@ - - - - - ProcessTestRunner - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ProcessTestRunner

-
-

Allows to execute processes as unit tests.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- ProcessTestRunnerParams -

The ProcessTestRunner parameter type.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - ProcessTestRunnerDefaults - -
- Signature: ProcessTestRunnerParams
-
-
- - - - -

The ProcessTestRunner defaults.

- - - -
- - - RunConsoleTest parameters fileName args - -
- Signature: parameters:ProcessTestRunnerParams -> fileName:string -> args:string -> string option
-
-
- - - - -

Runs the given process and returns the process result.

- - - -
- - - runConsoleTests parameters processes - -
- Signature: parameters:ProcessTestRunnerParams -> processes:seq<string * string> -> seq<string * string * string>
-
-
- - - - -

Runs the given processes and returns the process result messages.

- - - -
- - - RunConsoleTests setParams processes - -
- Signature: setParams:(ProcessTestRunnerParams -> ProcessTestRunnerParams) -> processes:seq<string * string> -> unit
-
-
- - - - -

Runs the given processes and returns the process results.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default parameter value.
  • -
  • processes - Sequence of one or more filenames and arguments to run.
  • -
- -

Sample usage

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-
Target "Test" (fun _ ->
-    ["process1.exe","argument1"
-     "process2.exe","argument2"]
-      |> RunConsoleTests (fun p -> {p with TimeOut = TimeSpan.FromMinutes 1. })
-)
-
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-raygunhelper-raygunconnectionsettings.html b/packages/FAKE.4.11.3/docs/apidocs/fake-raygunhelper-raygunconnectionsettings.html deleted file mode 100644 index 1411240..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-raygunhelper-raygunconnectionsettings.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - RaygunConnectionSettings - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

RaygunConnectionSettings

-
-

Connection configuration

- - -
-

Record Fields

- - - - - - - - - - - - - - -
Record FieldDescription
- - - endPoint - -
- Signature: string
-
-
- - - - -

Endpoint to connect to -Required, Defaults to: https://app.raygun.io/deployments

- - - -
- - - externalToken - -
- Signature: string
-
-
- - - - -

Raygun user access token for allowing API -access. (Creatd under User -> My settings in the web application) -Required, no sensible default

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-raygunhelper-raygundeploymentdata.html b/packages/FAKE.4.11.3/docs/apidocs/fake-raygunhelper-raygundeploymentdata.html deleted file mode 100644 index 3b08be2..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-raygunhelper-raygundeploymentdata.html +++ /dev/null @@ -1,268 +0,0 @@ - - - - - RaygunDeploymentData - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

RaygunDeploymentData

-
-

Data describing a deployment to Raygun

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - apiKey - -
- Signature: string
-
-
- - - - -

Application API key -Required, no sensible default

- - - -
- - - comment - -
- Signature: string
-
-
- - - - -

Release notes -Optional, defaults to empty string

- - - -
- - - createdAt - -
- Signature: DateTime
-
-
- - - - -

Datetime of the deployment -Optional, Defaults to System.DateTime.UtcNow

- - - -
- - - emailAddress - -
- Signature: string
-
-
- - - - -

Email address of person responsible for deployment -Optional, defaults to empty string

- - - -
- - - ownerName - -
- Signature: string
-
-
- - - - -

Name of person responsible for deployment -Optional, defaults to empty string

- - - -
- - - scmIdentifier - -
- Signature: string
-
-
- - - - -

Hash code (or other commit identifier) from -source control system -Optional, Defaults to current git hash if executed from a git repository - else defaults to empty string

- - - -
- - - version - -
- Signature: string
-
-
- - - - -

Version string describing deployed version -Should be the same as reported by the application -to raygun when posting an error -Required, no sensible default

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-raygunhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-raygunhelper.html deleted file mode 100644 index ae87548..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-raygunhelper.html +++ /dev/null @@ -1,175 +0,0 @@ - - - - - RaygunHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

RaygunHelper

-
-

Enables deployment tracking using Raygun.io

- -

Thin wrapper around the Raygun HTTP deployment API

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - -
TypeDescription
- RaygunConnectionSettings -

Connection configuration

- - -
- RaygunDeploymentData -

Data describing a deployment to Raygun

- - -
- -
- -

Functions and values

- - - - - - - - - - -
Function or valueDescription
- - - ReportDeployment settings data - -
- Signature: settings:(RaygunConnectionSettings -> RaygunConnectionSettings) -> data:(RaygunDeploymentData -> RaygunDeploymentData) -> unit
-
-
- - - - -

Report a deployment to raygun

- -

Reports a deployment to raygun so reported errors can be -correlated with deployments

- -

Paramteres

- -
    -
  • settings : Function that sets the raygun connection settings.
  • -
  • data : Function that sets the deployment data
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-regasmhelper-regasmparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-regasmhelper-regasmparams.html deleted file mode 100644 index 504bfed..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-regasmhelper-regasmparams.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - RegAsmParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

RegAsmParams

-
-

RegAsm parameter type

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ExportTypeLibrary - -
- Signature: bool
-
-
- - - - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-regasmhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-regasmhelper.html deleted file mode 100644 index 790543a..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-regasmhelper.html +++ /dev/null @@ -1,251 +0,0 @@ - - - - - RegAsmHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

RegAsmHelper

-
-

Contains a task which can be used to run regasm .NET assembly

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- RegAsmParams -

RegAsm parameter type

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - RegAsm setParams lib - -
- Signature: setParams:(RegAsmParams -> RegAsmParams) -> lib:string -> unit
-
-
- - - - -

Runs regasm on the given lib

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default RegAsm parameters.
  • -
  • lib - The assembly file name.
  • -
- - - -
- - - RegAsmDefaults - -
- Signature: RegAsmParams
-
-
- - - - -

RegAsm default params

- - - -
- - - regAsmToolPath - -
- Signature: string
-
-
- - - - -

Path to newest regasm.exe

- - - -
- - - RegisterAssembliesWithCodebase (...) - -
- Signature: workingDir:string -> assemblies:seq<string> -> unit
-
-
- - - - -

Executes RegAsm.exe with the /codebase /tlb option

- -

Used to temporarily register any .net dependencies before running -a VB6 build

- - - -
- - - UnregisterAssemblies (...) - -
- Signature: workingDir:string -> assemblies:seq<string> -> unit
-
-
- - - - -

Executes Regasm.exe with the /codebase /tlb /unregister options

- -

Used to unregegister any temporarily registerd .net dependencies -after running a VB6 build

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-registryhelper-registrybasekey.html b/packages/FAKE.4.11.3/docs/apidocs/fake-registryhelper-registrybasekey.html deleted file mode 100644 index 9485994..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-registryhelper-registrybasekey.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - RegistryBaseKey - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

RegistryBaseKey

-
-

Registry base keys.

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - HKEYClassesRoot - -
- Signature:
-
-
- - - - - -
- - - HKEYCurrentConfig - -
- Signature:
-
-
- - - - - -
- - - HKEYCurrentUser - -
- Signature:
-
-
- - - - - -
- - - HKEYLocalMachine - -
- Signature:
-
-
- - - - - -
- - - HKEYPerformanceData - -
- Signature:
-
-
- - - - - -
- - - HKEYUsers - -
- Signature:
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-registryhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-registryhelper.html deleted file mode 100644 index 85b53ea..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-registryhelper.html +++ /dev/null @@ -1,364 +0,0 @@ - - - - - RegistryHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

RegistryHelper

-
-

Contains functions which allow to read and write information from/to the registry.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- RegistryBaseKey -

Registry base keys.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - createRegistrySubKey baseKey subKey - -
- Signature: baseKey:RegistryBaseKey -> subKey:string -> unit
-
-
- - - - -

Create a registry subKey

- - - -
- - - deleteRegistrySubKey baseKey subKey - -
- Signature: baseKey:RegistryBaseKey -> subKey:string -> unit
-
-
- - - - -

Deletes a registry subKey

- - - -
- - - deleteRegistryValue baseKey subKey name - -
- Signature: baseKey:RegistryBaseKey -> subKey:string -> name:string -> unit
-
-
- - - - -

Deletes the registry value from its key

- - - -
- - - getRegistryKey (...) - -
- Signature: baseKey:RegistryBaseKey -> subKey:string -> writePermission:bool -> RegistryKey
-
-
- - - - -

Gets a registy key and falls back to 32 bit if the 64bit key is not there

- - - -
- - - getRegistryKey64 (...) - -
- Signature: baseKey:RegistryBaseKey -> subKey:string -> writePermission:bool -> RegistryKey
-
-
- - - - -

Gets a 64-bit registy key

- - - -
- - - getRegistrySubKeyNames baseKey subKey - -
- Signature: baseKey:RegistryBaseKey -> subKey:string -> string []
-
-
- - - - -

Returns all the subKey names of a registry key

- - - -
- - - getRegistryValue baseKey subKey name - -
- Signature: baseKey:RegistryBaseKey -> subKey:string -> name:string -> string
-
-
- - - - -

Gets a registy value as string

- - - -
- - - getRegistryValue64 baseKey subKey name - -
- Signature: baseKey:RegistryBaseKey -> subKey:string -> name:string -> string
-
-
- - - - -

Gets a registy value as string

- - - -
- - - getRegistryValueNames baseKey subKey - -
- Signature: baseKey:RegistryBaseKey -> subKey:string -> string []
-
-
- - - - -

Returns all the value names of a registry key

- - - -
- - - setRegistryValue (...) - -
- Signature: baseKey:RegistryBaseKey -> subKey:string -> name:string -> value:'T -> unit
- Type parameters: 'T
-
- - - - -

Sets a registry value

- - - -
- - - valueExistsForKey baseKey subKey name - -
- Signature: baseKey:RegistryBaseKey -> subKey:string -> name:string -> bool
-
-
- - - - -

Returns whether or not a registry value name exists for a key

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-releasenoteshelper-releasenotes.html b/packages/FAKE.4.11.3/docs/apidocs/fake-releasenoteshelper-releasenotes.html deleted file mode 100644 index 6f9f567..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-releasenoteshelper-releasenotes.html +++ /dev/null @@ -1,256 +0,0 @@ - - - - - ReleaseNotes - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ReleaseNotes

-
-

Contains the parsed information of the release notes text file.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - AssemblyVersion - -
- Signature: string
-
-
- - - - -

The parsed version.

- - - -
- - - Date - -
- Signature: DateTime option
-
-
- - - - -

Release date

- - - -
- - - Notes - -
- Signature: string list
-
-
- - - - - -
- - - NugetVersion - -
- Signature: string
-
-
- - - - -

The nuget package version.

- - - -
- - - SemVer - -
- Signature: SemVerInfo
-
-
- - - - -

Semantic version

- - - -
-

Static members

- - - - - - - - - - - - - - -
Static memberDescription
- - - New(...) - -
- Signature: (assemblyVersion:string * nugetVersion:string * notes:string list) -> ReleaseNotes
-
-
- - - - - -
- - - New(...) - -
- Signature: (assemblyVersion:string * nugetVersion:string * date:DateTime option * notes:string list) -> ReleaseNotes
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-releasenoteshelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-releasenoteshelper.html deleted file mode 100644 index a4c8306..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-releasenoteshelper.html +++ /dev/null @@ -1,323 +0,0 @@ - - - - - ReleaseNotesHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ReleaseNotesHelper

-
-

Contains helpers which allow to parse Release Notes text files. Either "simple" or "complex" format is accepted.

- - -

Formats

-

Simple format

- - - - -
1: 
-2: 
-
* 1.1.10 - Support for heterogeneous XML attributes. Make CsvFile re-entrant.
-* 1.1.9 - Infer booleans for ints that only manifest 0 and 1.
-
- -

Complex format

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-
## New in 1.1.10 (Released 2013/09/12)
-* Support for heterogeneous XML attributes.
-* Make CsvFile re-entrant. 
-* Support for compressed HTTP responses. 
-* Fix JSON conversion of 0 and 1 to booleans.
-
-## New in 1.1.9 (Released 2013/07/21)
-* Infer booleans for ints that only manifest 0 and 1.    
-* Support for partially overriding the Schema in CsvProvider.
-* PreferOptionals and SafeMode parameters for CsvProvider.
-
- - -

Sample

- - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-
let release =
-    ReadFile "RELEASE_NOTES.md"
-    |> ReleaseNotesHelper.parseReleaseNotes
-
-
-Target "AssemblyInfo" (fun _ ->
-    CreateFSharpAssemblyInfo "src/Common/AssemblyInfo.fs"
-      [ Attribute.Title project
-        Attribute.Product project
-        Attribute.Description summary
-        Attribute.Version release.AssemblyVersion
-        Attribute.FileVersion release.AssemblyVersion]
-)
-
- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- ReleaseNotes -

Contains the parsed information of the release notes text file.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - LoadReleaseNotes fileName - -
- Signature: fileName:string -> ReleaseNotes
-
-
- - - - -

Parses a Release Notes text file and returns the lastest release notes.

- -

Parameters

- -
    -
  • fileName - Release notes text file name
  • -
- - - -
- - - parseAllReleaseNotes data - -
- Signature: data:seq<string> -> ReleaseNotes list
-
-
- - - - -

Parses a Release Notes text and returns all release notes.

- -

Parameters

- -
    -
  • data - Release notes text
  • -
- - - -
- - - parseDate - -
- Signature: string -> DateTime option
-
-
- - - - - -
- - - parseReleaseNotes data - -
- Signature: data:seq<string> -> ReleaseNotes
-
-
- - - - -

Parses a Release Notes text and returns the lastest release notes.

- -

Parameters

- -
    -
  • data - Release notes text
  • -
- - - -
- - - parseVersions - -
- Signature: string -> Match * Match
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-reportgeneratorhelper-reportgeneratorlogverbosity.html b/packages/FAKE.4.11.3/docs/apidocs/fake-reportgeneratorhelper-reportgeneratorlogverbosity.html deleted file mode 100644 index 358f3c1..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-reportgeneratorhelper-reportgeneratorlogverbosity.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - ReportGeneratorLogVerbosity - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ReportGeneratorLogVerbosity

-
-
-

Record Fields

- - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Error - -
- Signature: ReportGeneratorLogVerbosity
- Modifiers: static
-
-
- - - - - -
- - - Info - -
- Signature: ReportGeneratorLogVerbosity
- Modifiers: static
-
-
- - - - - -
- - - Verbose - -
- Signature: ReportGeneratorLogVerbosity
- Modifiers: static
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-reportgeneratorhelper-reportgeneratorparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-reportgeneratorhelper-reportgeneratorparams.html deleted file mode 100644 index 7cd011a..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-reportgeneratorhelper-reportgeneratorparams.html +++ /dev/null @@ -1,302 +0,0 @@ - - - - - ReportGeneratorParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ReportGeneratorParams

-
-

ReportGenerator parameters, for more details see: https://github.com/danielpalme/ReportGenerator.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ExePath - -
- Signature: string
-
-
- - - - -

(Required) Path to the ReportGenerator exe file.

- - - -
- - - Filters - -
- Signature: string list
-
-
- - - - -

Optional list of assemblies that should be included or excluded -in the report. Exclusion filters take precedence over inclusion -filters. Wildcards are allowed.

- - - -
- - - HistoryDir - -
- Signature: string
-
-
- - - - -

Optional directory for storing persistent coverage information. -Can be used in future reports to show coverage evolution.

- - - -
- - - LogVerbosity - -
- Signature: ReportGeneratorLogVerbosity
-
-
- - - - -

The verbosity level of the log messages.

- - - -
- - - ReportTypes - -
- Signature: ReportGeneratorReportType list
-
-
- - - - -

The output formats and scope.

- - - -
- - - SourceDirs - -
- Signature: string list
-
-
- - - - -

Optional directories which contain the corresponding source code.

- - - -
- - - TargetDir - -
- Signature: string
-
-
- - - - -

(Required) The directory where the generated report should be saved.

- - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - -

The timeout for the ReportGenerator process.

- - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - -

The directory where the ReportGenerator process will be started.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-reportgeneratorhelper-reportgeneratorreporttype.html b/packages/FAKE.4.11.3/docs/apidocs/fake-reportgeneratorhelper-reportgeneratorreporttype.html deleted file mode 100644 index 8e0ac7d..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-reportgeneratorhelper-reportgeneratorreporttype.html +++ /dev/null @@ -1,240 +0,0 @@ - - - - - ReportGeneratorReportType - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ReportGeneratorReportType

-
-
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Badges - -
- Signature: ReportGeneratorReportType
- Modifiers: static
-
-
- - - - - -
- - - Html - -
- Signature: ReportGeneratorReportType
- Modifiers: static
-
-
- - - - - -
- - - HtmlSummary - -
- Signature: ReportGeneratorReportType
- Modifiers: static
-
-
- - - - - -
- - - Latex - -
- Signature: ReportGeneratorReportType
- Modifiers: static
-
-
- - - - - -
- - - LatexSummary - -
- Signature: ReportGeneratorReportType
- Modifiers: static
-
-
- - - - - -
- - - Xml - -
- Signature: ReportGeneratorReportType
- Modifiers: static
-
-
- - - - - -
- - - XmlSummary - -
- Signature: ReportGeneratorReportType
- Modifiers: static
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-reportgeneratorhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-reportgeneratorhelper.html deleted file mode 100644 index a62c2e6..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-reportgeneratorhelper.html +++ /dev/null @@ -1,204 +0,0 @@ - - - - - ReportGeneratorHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ReportGeneratorHelper

-
-

Contains a task which can be used to run ReportGenerator, -which converts XML reports generated by PartCover, OpenCover or NCover into a readable report in various formats.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - -
TypeDescription
- ReportGeneratorLogVerbosity -
- ReportGeneratorParams -

ReportGenerator parameters, for more details see: https://github.com/danielpalme/ReportGenerator.

- - -
- ReportGeneratorReportType -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - ReportGenerator setParams reports - -
- Signature: setParams:(ReportGeneratorParams -> ReportGeneratorParams) -> reports:string list -> unit
-
-
- - - - -

Runs ReportGenerator on one or more coverage reports.

- -

Parameters

- -
    -
  • setParams - Function used to overwrite the default ReportGenerator parameters.
  • -
  • reports - Coverage reports.
  • -
- -

Sample

- - - - -
1: 
-
 ReportGenerator (fun p -> { p with TargetDir = "c:/reports/" }) [ "c:/opencover.xml" ]
-
- - - -
- - - ReportGeneratorDefaultParams - -
- Signature: ReportGeneratorParams
-
-
- - - - -

ReportGenerator default parameters

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-rest-postmethod.html b/packages/FAKE.4.11.3/docs/apidocs/fake-rest-postmethod.html deleted file mode 100644 index d985025..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-rest-postmethod.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - PostMethod - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-rest.html b/packages/FAKE.4.11.3/docs/apidocs/fake-rest.html deleted file mode 100644 index 27457cb..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-rest.html +++ /dev/null @@ -1,227 +0,0 @@ - - - - - REST - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

REST

-
-

Contains functions to execute typical HTTP/REST calls.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- PostMethod -

Option type for the HTTP verb

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - ExecuteGetCommand userName password url - -
- Signature: userName:string -> password:string -> url:string -> string
-
-
- - - - -

Executes an HTTP GET command and retrives the information. -It returns the response of the request, or null if we got 404 or nothing.

- -

Parameters

- -
    -
  • userName - The username to use with the request.
  • -
  • password - The password to use with the request.
  • -
  • url - The URL to perform the GET operation.
  • -
- - - -
- - - ExecutePost url userName password data - -
- Signature: url:string -> userName:string -> password:string -> data:string -> string
-
-
- - - - -

Executes an HTTP POST command and retrives the information. -It returns the response of the request, or null if we got 404 or nothing.

- -

Parameters

- -
    -
  • url - The URL to perform the POST operation.
  • -
  • userName - The username to use with the request.
  • -
  • password - The password to use with the request.
  • -
  • data - The data to post.
  • -
- - - -
- - - ExecutePostCommand (...) - -
- Signature: headerF:(WebHeaderCollection -> unit) -> url:string -> userName:string -> password:string -> data:string -> string
-
-
- - - - -

Executes an HTTP POST command and retrives the information.
-This function will automatically include a "source" parameter if the "Source" property is set. -It returns the response of the request, or null if we got 404 or nothing.

- -

Parameters

- -
    -
  • headerF - A function which allows to manipulate the HTTP headers.
  • -
  • url - The URL to perform the POST operation.
  • -
  • userName - The username to use with the request.
  • -
  • password - The password to use with the request.
  • -
  • data - The data to post.
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-restorepackagehelper-restorepackageparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-restorepackagehelper-restorepackageparams.html deleted file mode 100644 index ae5271e..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-restorepackagehelper-restorepackageparams.html +++ /dev/null @@ -1,203 +0,0 @@ - - - - - RestorePackageParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

RestorePackageParams

-
-

RestorePackages parameter path

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - OutputPath - -
- Signature: string
-
-
- - - - - -
- - - Retries - -
- Signature: int
-
-
- - - - -

Specifies how often nuget should try to restore the packages - default is 5

- - - -
- - - Sources - -
- Signature: string list
-
-
- - - - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-restorepackagehelper-restoresinglepackageparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-restorepackagehelper-restoresinglepackageparams.html deleted file mode 100644 index f18945f..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-restorepackagehelper-restoresinglepackageparams.html +++ /dev/null @@ -1,257 +0,0 @@ - - - - - RestoreSinglePackageParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

RestoreSinglePackageParams

-
-

RestorePackages parameter path for single packages

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ExcludeVersion - -
- Signature: bool
-
-
- - - - - -
- - - IncludePreRelease - -
- Signature: bool
-
-
- - - - - -
- - - OutputPath - -
- Signature: string
-
-
- - - - - -
- - - Retries - -
- Signature: int
-
-
- - - - -

Specifies how often nuget should try to restore the packages - default is 5

- - - -
- - - Sources - -
- Signature: string list
-
-
- - - - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - - -
- - - Version - -
- Signature: Version option
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-restorepackagehelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-restorepackagehelper.html deleted file mode 100644 index 28827a3..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-restorepackagehelper.html +++ /dev/null @@ -1,350 +0,0 @@ - - - - - RestorePackageHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

RestorePackageHelper

-
-

Contains tasks which allow to restore NuGet packages from a NuGet package feed like nuget.org. -There is also a tutorial about nuget package restore available.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - -
TypeDescription
- RestorePackageParams -

RestorePackages parameter path

- - -
- RestoreSinglePackageParams -

RestorePackages parameter path for single packages

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - findNuget defaultPath - -
- Signature: defaultPath:string -> string
-
-
- - - - -

Looks for NuGet.exe in [1] the specified defaultPath, [2] a list of standard tool folders, [3] any subfolder in the current directory, [4] the PATH - returns the first path where NuGet.exe was found.

- - - -
- - - RestoreMSSolutionPackages (...) - -
- Signature: setParams:(RestorePackageParams -> RestorePackageParams) -> solutionFile:string -> unit
-
-
- - - - -

Restores the packages in the given solution file file from NuGet.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default NuGet parameters.
  • -
  • solutionFile - The microsoft sln file name.
  • -
- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-8: 
-
Target "RestorePackages" (fun _ -> 
-     "./scr/Everything.sln"
-     |> RestoreMSSolutionPackages (fun p ->
-         { p with
-             Sources = "http:://myNugetSources.com" :: p.Sources
-             OutputPath = outputDir
-             Retries = 4 })
- )
-
- - - -
- - - RestorePackage setParams packageFile - -
- Signature: setParams:(RestorePackageParams -> RestorePackageParams) -> packageFile:string -> unit
-
-
- - - - -

Restores the packages in the given packages.config file from NuGet.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default NuGet parameters.
  • -
  • packageFile - The packages.config file name.
  • -
- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-8: 
-
Target "RestorePackages" (fun _ -> 
-     "./scr/ProjectA/packages.config"
-     |> RestorePackage (fun p ->
-         { p with
-             Sources = "http:://myNugetSources.com" :: p.Sources
-             OutputPath = outputDir
-             Retries = 4 })
- )
-
- - - -
- - - RestorePackageDefaults - -
- Signature: RestorePackageParams
-
-
- - - - -

RestorePackage defaults parameters

- - - -
- - - RestorePackageId setParams packageId - -
- Signature: setParams:(RestoreSinglePackageParams -> RestoreSinglePackageParams) -> packageId:string -> unit
-
-
- - - - -

Restores the given package from NuGet

- - - -
- - - RestorePackages () - -
- Signature: unit -> unit
-
-
- - - - -

Restores all packages from NuGet to the default directories by scanning for packages.config files in any subdirectory.

- - - -
- - - RestoreSinglePackageDefaults - -
- Signature: RestoreSinglePackageParams
-
-
- - - - -

RestoreSinglePackageParams defaults parameters

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-robocopyhelper-robocopyoptions.html b/packages/FAKE.4.11.3/docs/apidocs/fake-robocopyhelper-robocopyoptions.html deleted file mode 100644 index 487288a..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-robocopyhelper-robocopyoptions.html +++ /dev/null @@ -1,125 +0,0 @@ - - - - - RoboCopyOptions - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-robocopyhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-robocopyhelper.html deleted file mode 100644 index ee678d4..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-robocopyhelper.html +++ /dev/null @@ -1,186 +0,0 @@ - - - - - RoboCopyHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

RoboCopyHelper

-
-

Contains a task to use robocopy on Windows.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- RoboCopyOptions -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - RoboCopy source destination - -
- Signature: source:string -> destination:string -> unit
-
-
- - - - -

Executes a RoboCopy command

- -

Parameters

- -
    -
  • source - The source directory
  • -
  • destination - The target directory
  • -
- - - -
- - - RoboCopyMirror source destination - -
- Signature: source:string -> destination:string -> unit
-
-
- - - - -

Executes a RoboCopy mirror command (potentially destructive)

- -

Parameters

- -
    -
  • source - The source directory
  • -
  • destination - The target directory
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-roundhousehelper-roundhouseparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-roundhousehelper-roundhouseparams.html deleted file mode 100644 index 90d0544..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-roundhousehelper-roundhouseparams.html +++ /dev/null @@ -1,866 +0,0 @@ - - - - - RoundhouseParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

RoundhouseParams

-
-

Parameter type to configure the RoundhousE runner

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - AlterDatabaseFolderName - -
- Signature: string
-
-
- - - - -

The name of the folder where you keep your alter database scripts. Read up on token replacement. You will want to use {{DatabaseName}} here instead of specifying a database name.

- - - -
- - - CommandTimeout - -
- Signature: int
-
-
- - - - -

This is the timeout when commands are run. This is not for admin commands or restore.

- - - -
- - - CommandTimeoutAdmin - -
- Signature: int
-
-
- - - - -

This is the timeout when administration commands are run (except for restore, which has its own).

- - - -
- - - ConnectionString - -
- Signature: string
-
-
- - - - -

As an alternative to ServerName and Database - You can provide an entire connection string instead.

- - - -
- - - ConnectionStringAdmin - -
- Signature: string
-
-
- - - - -

This is used for connecting to master when you may have a different uid and password than normal.

- - - -
- - - CustomCreateScript - -
- Signature: string
-
-
- - - - -

This instructs RH to use this script for creating a database instead of the default based on the SQLType.

- - - -
- - - DatabaseName - -
- Signature: string
-
-
- - - - -

The database you want to create/migrate.

- - - -
- - - DatabaseType - -
- Signature: string
-
-
- - - - -

Database Type (fully qualified class name implementing [roundhouse.sql.Database, roundhouse])

- - - -
- - - Drop - -
- Signature: bool
-
-
- - - - -

This instructs RH to remove a database and not run migration scripts.

- - - -
- - - Environment - -
- Signature: string
-
-
- - - - -

This allows RH to be environment aware and only run scripts that are in a particular environment based on the namingof the script. LOCAL.something.ENV.sql would only be run in the LOCAL environment.

- - - -
- - - FunctionsFolderName - -
- Signature: string
-
-
- - - - -

The name of the folder where you keep your functions.

- - - -
- - - IndexesFolderName - -
- Signature: string
-
-
- - - - -

The name of the folder where you keep your indexes.

- - - -
- - - OutputPath - -
- Signature: string
-
-
- - - - -

Output path. Path to where migration artifacts are stored.

- - - -
- - - PermissionsFolderName - -
- Signature: string
-
-
- - - - -

The name of the folder where you keep your permissions scripts.

- - - -
- - - RepositoryPath - -
- Signature: string
-
-
- - - - -

Path to code repository to be able to correlate versions

- - - -
- - - Restore - -
- Signature: bool
-
-
- - - - -

This instructs RH to do a restore (with the restorefrompath parameter) of a database before running migration scripts.

- - - -
- - - RestoreFilePath - -
- Signature: string
-
-
- - - - -

File path of back when Restore is set to true

- - - -
- - - RunAfterCreateDatabaseFolderName - -
- Signature: string
-
-
- - - - -

The name of the folder where you will keep scripts that ONLY run after a database is created.

- - - -
- - - RunAfterOtherAnyTimeScriptsFolderName - -
- Signature: string
-
-
- - - - -

The name of the folder where you keep scripts that will be run after all of the other any time scripts complete.

- - - -
- - - RunBeforeUpFolderName - -
- Signature: string
-
-
- - - - -

The name of the folder where you keep scripts that you want to run before your update scripts.

- - - -
- - - RunFirstAfterUpdateFolderName - -
- Signature: string
-
-
- - - - -

The name of the folder where you keep any functions, views, or sprocs that are order dependent. If you have a function that depends on a view, you definitely need the view in this folder.

- - - -
- - - SchemaName - -
- Signature: string
-
-
- - - - -

The schema where RH stores it's tables

- - - -
- - - ServerDatabase - -
- Signature: string
-
-
- - - - -

The server and instance you would like to run on. (local) and (local)\SQL2008 are both valid values.

- - - -
- - - Silent - -
- Signature: bool
-
-
- - - - -

Tells RH not to ask for any input when it runs.

- - - -
- - - Simple - -
- Signature: bool
-
-
- - - - -

This instructs RH to set the database recovery mode to simple recovery. Only works with SqlServer.

- - - -
- - - SprocsFolderName - -
- Signature: string
-
-
- - - - -

The name of the folder where you keep your stored procedures.

- - - -
- - - SqlFilesDirectory - -
- Signature: string
-
-
- - - - -

The directory where your SQL scripts are.

- - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - -

A timeout for the runner.

- - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - -

FileName of the Roundhouse runner.

- - - -
- - - UpFolderName - -
- Signature: string
-
-
- - - - -

The name of the folder where you keep your update scripts.

- - - -
- - - VersionFile - -
- Signature: string
-
-
- - - - -

Path to the file to use for versioning. Either a .XML file, a .DLL or a .TXT file that a version can be resolved from.

- - - -
- - - VersionXPath - -
- Signature: string
-
-
- - - - -

Works in conjunction with an XML version file.

- - - -
- - - ViewsFolderName - -
- Signature: string
-
-
- - - - -

The name of the folder where you keep your views.

- - - -
- - - WarnOnOneTimeScriptChanges - -
- Signature: bool
-
-
- - - - -

Instructs RH to execute changed one time scripts (DDL/DML in Up folder) that have previously been run against the database instead of failing. A warning is logged for each one time scripts that is rerun.

- - - -
- - - WithTransaction - -
- Signature: bool
-
-
- - - - -

This instructs RH to run inside of a transaction.

- - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - -

Working directory (optional).

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-roundhousehelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-roundhousehelper.html deleted file mode 100644 index cb9e7b1..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-roundhousehelper.html +++ /dev/null @@ -1,198 +0,0 @@ - - - - - RoundhouseHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

RoundhouseHelper

-
-

Contains tasks to run RoundhousE database migrations.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- RoundhouseParams -

Parameter type to configure the RoundhousE runner

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - Roundhouse setParams - -
- Signature: setParams:(RoundhouseParams -> RoundhouseParams) -> unit
-
-
- - - - -

This task to can be used to run RoundhousE for database migrations.

- -

Parameters

- -
    -
  • setParams - Function used to overwrite the Roundhouse default parameters.
  • -
- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-
Roundhouse (fun p -> { p with 
-   SqlFilesDirectory = ".\database"
-   ServerDatabase = "(local)"
-   DatabaseName = "atxc"
-   WarnOnOneTimeScriptChanges = true })
-
- - - -
- - - RoundhouseDefaults - -
- Signature: RoundhouseParams
-
-
- - - - -

Roundhouse default parameters - tries to locate rh.exe in any subfolder.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-scphelper-scpparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-scphelper-scpparams.html deleted file mode 100644 index be66609..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-scphelper-scpparams.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - SCPParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

SCPParams

-
-

The SCP parameter type.

- - -
-

Record Fields

- - - - - - - - - - - - - - -
Record FieldDescription
- - - PrivateKeyPath - -
- Signature: string
-
-
- - - - -

Path of the private key file (optional)

- - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - -

Path of the scp.exe

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-scphelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-scphelper.html deleted file mode 100644 index eb44a92..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-scphelper.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - SCPHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

SCPHelper

-
-

Conatins a task which allows to perform file copies using SCP, which is based on the Secure Shell (SSH) protocol.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- SCPParams -

The SCP parameter type.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - SCP setParams source target - -
- Signature: setParams:(SCPParams -> SCPParams) -> source:string -> target:string -> unit
-
-
- - - - -

Performs a SCP copy from the given source directory to the target path.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default SCPParams value.
  • -
  • source - The source path. Can be something like user@host:directory/SourceFile or a local path.
  • -
  • target - The target path. Can be something like user@host:directory/TargetFile or a local path.
  • -
- -

Sample

- - - - -
1: 
-
SCP (fun p -> { p with ToolPath = "tools/scp.exe" }) source target
-
- - - -
- - - SCPDefaults - -
- Signature: SCPParams
-
-
- - - - -

The SCP default parameters

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-semverhelper-prerelease.html b/packages/FAKE.4.11.3/docs/apidocs/fake-semverhelper-prerelease.html deleted file mode 100644 index 092baea..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-semverhelper-prerelease.html +++ /dev/null @@ -1,187 +0,0 @@ - - - - - PreRelease - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

PreRelease

-
-
-

Record Fields

- - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Name - -
- Signature: string
-
-
- - - - - -
- - - Number - -
- Signature: int option
-
-
- - - - - -
- - - Origin - -
- Signature: string
-
-
- - - - - -
-

Static members

- - - - - - - - - - -
Static memberDescription
- - - TryParse(str) - -
- Signature: str:string -> PreRelease option
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-semverhelper-semverinfo.html b/packages/FAKE.4.11.3/docs/apidocs/fake-semverhelper-semverinfo.html deleted file mode 100644 index dcc9f8a..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-semverhelper-semverinfo.html +++ /dev/null @@ -1,215 +0,0 @@ - - - - - SemVerInfo - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

SemVerInfo

-
-

Contains the version information.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Build - -
- Signature: string
-
-
- - - - -

The optional build no.

- - - -
- - - Major - -
- Signature: int
-
-
- - - - -

MAJOR version when you make incompatible API changes.

- - - -
- - - Minor - -
- Signature: int
-
-
- - - - -

MINOR version when you add functionality in a backwards-compatible manner.

- - - -
- - - Patch - -
- Signature: int
-
-
- - - - -

PATCH version when you make backwards-compatible bug fixes.

- - - -
- - - PreRelease - -
- Signature: PreRelease option
-
-
- - - - -

The optional PreRelease version

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-semverhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-semverhelper.html deleted file mode 100644 index f30cd05..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-semverhelper.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - SemVerHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

SemVerHelper

-
-

Contains helpers which allow to deal with Semantic Versioning (SemVer).

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - -
TypeDescription
- PreRelease -
- SemVerInfo -

Contains the version information.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - isValidSemVer input - -
- Signature: input:string -> bool
-
-
- - - - -

Returns true if input appears to be a parsable semver string

- - - -
- - - parse version - -
- Signature: version:string -> SemVerInfo
-
-
- - - - -

Parses the given version string into a SemVerInfo which can be printed using ToString() or compared -according to the rules described in the SemVer docs.

- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-
parse "1.0.0-rc.1"     < parse "1.0.0"          // true
-parse "1.2.3-alpha"    > parse "1.2.2"          // true
-parse "1.2.3-alpha2"   > parse "1.2.3-alpha"    // true
-parse "1.2.3-alpha002" > parse "1.2.3-alpha1"   // true
-parse "1.5.0-beta.2"   > parse "1.5.0-rc.1"     // false
-
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-servicecontrollerhelpers.html b/packages/FAKE.4.11.3/docs/apidocs/fake-servicecontrollerhelpers.html deleted file mode 100644 index 6ad538e..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-servicecontrollerhelpers.html +++ /dev/null @@ -1,585 +0,0 @@ - - - - - ServiceControllerHelpers - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ServiceControllerHelpers

-
-

Contains tasks which allow to control NT services.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - checkRemoteServiceExists host name - -
- Signature: host:string -> name:string -> bool
-
-
- - - - -

Returns whether a remote service with the given name exists.

- -

Parameters

- -
    -
  • host - The hostname of the remote machine.
  • -
  • name - The name of the service in question.
  • -
- - - -
- - - checkServiceExists name - -
- Signature: name:string -> bool
-
-
- - - - -

Returns whether a local service with the given name exists.

- -

Parameters

- -
    -
  • name - The name of the service in question.
  • -
- - - -
- - - ensureRemoteServiceHasStarted (...) - -
- Signature: host:string -> name:string -> timeout:TimeSpan -> unit
-
-
- - - - -

Waits until the remote service with the given name has been started or fails after given timeout

- -

Parameters

- -
    -
  • host - The hostname of the remote machine.
  • -
  • name - The name of the service in question.
  • -
  • timeout - The timespan to time out after.
  • -
- - - -
- - - ensureRemoteServiceHasStopped (...) - -
- Signature: host:string -> name:string -> timeout:TimeSpan -> unit
-
-
- - - - -

Waits until the remote service with the given name has been stopped or fails after given timeout

- -

Parameters

- -
    -
  • host - The hostname of the remote machine.
  • -
  • name - The name of the service in question.
  • -
  • timeout - The timespan to time out after.
  • -
- - - -
- - - ensureServiceHasStarted name timeout - -
- Signature: name:string -> timeout:TimeSpan -> unit
-
-
- - - - -

Waits until the local service with the given name has been started or fails after given timeout

- -

Parameters

- -
    -
  • name - The name of the service in question.
  • -
  • timeout - The timespan to time out after.
  • -
- - - -
- - - ensureServiceHasStopped name timeout - -
- Signature: name:string -> timeout:TimeSpan -> unit
-
-
- - - - -

Waits until the local service with the given name has been stopped or fails after given timeout

- -

Parameters

- -
    -
  • name - The name of the service in question.
  • -
  • timeout - The timespan to time out after.
  • -
- - - -
- - - getRemoteService host name - -
- Signature: host:string -> name:string -> ServiceController option
-
-
- - - - -

Returns the first remote service with given name or None.

- -

Parameters

- -
    -
  • host - The hostname of the remote machine.
  • -
  • name - The name of the service in question.
  • -
- - - -
- - - getRemoteServices host name - -
- Signature: host:string -> name:string -> seq<ServiceController>
-
-
- - - - -

Returns sequence of remote services with given name.

- -

Parameters

- -
    -
  • host - The hostname of the remote machine.
  • -
  • name - The name of the services in question.
  • -
- - - -
- - - getRemoteServiceStatus host name - -
- Signature: host:string -> name:string -> ServiceControllerStatus
-
-
- - - - -

Returns status of the remote service with given name or fails when service is not found.

- -

Parameters

- -
    -
  • host - The hostname of the remote machine.
  • -
  • name - The name of the service in question.
  • -
- - - -
- - - getService name - -
- Signature: name:string -> ServiceController option
-
-
- - - - -

Returns the first local service with given name or None.

- -

Parameters

- -
    -
  • name - The name of the service in question.
  • -
- - - -
- - - getServices name - -
- Signature: name:string -> seq<ServiceController>
-
-
- - - - -

Returns sequence of local services with given name.

- -

Parameters

- -
    -
  • name - The name of the services in question.
  • -
- - - -
- - - getServiceStatus name - -
- Signature: name:string -> ServiceControllerStatus
-
-
- - - - -

Returns status of the local service with given name or fails when service is not found.

- -

Parameters

- -
    -
  • name - The name of the service in question.
  • -
- - - -
- - - isService name service - -
- Signature: name:string -> service:ServiceController -> bool
-
-
- - - - -

Returns whether the given service has the given name as display or service name.

- -

Parameters

- -
    -
  • name - The name to check for.
  • -
  • service - The service in question.
  • -
- - - -
- - - startRemoteService host name - -
- Signature: host:string -> name:string -> unit
-
-
- - - - -

Starts all remote services with given name.

- -

Parameters

- -
    -
  • host - The hostname of the remote machine.
  • -
  • name - The name of the services in question.
  • -
- - - -
- - - startService name - -
- Signature: name:string -> unit
-
-
- - - - -

Starts all local services with given name.

- -

Parameters

- -
    -
  • name - The name of the services in question.
  • -
- - - -
- - - stopRemoteService host name - -
- Signature: host:string -> name:string -> unit
-
-
- - - - -

Stops all services with given name.

- -

Parameters

- -
    -
  • host - The hostname of the remote machine.
  • -
  • name - The name of the services in question.
  • -
- - - -
- - - stopService name - -
- Signature: name:string -> unit
-
-
- - - - -

Stops all local services with given name.

- -

Parameters

- -
    -
  • name - The name of the services in question.
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-signtoolhelper-signcert.html b/packages/FAKE.4.11.3/docs/apidocs/fake-signtoolhelper-signcert.html deleted file mode 100644 index ceee0f8..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-signtoolhelper-signcert.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - SignCert - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

SignCert

-
-

Represents a certificate file and an optional password

- - -
-

Record Fields

- - - - - - - - - - - - - - -
Record FieldDescription
- - - CertFile - -
- Signature: string
-
-
- - - - -

The certificate files

- - - -
- - - PasswordFile - -
- Signature: string option
-
-
- - - - -

The file containing the password

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-signtoolhelper-signparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-signtoolhelper-signparams.html deleted file mode 100644 index 304fcb6..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-signtoolhelper-signparams.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - SignParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

SignParams

-
-

Parameters used for signing.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Certificate - -
- Signature: SignCert option
-
-
- - - - -

The optional real certificate that will be used when it is found

- - - -
- - - DevCertificate - -
- Signature: SignCert
-
-
- - - - -

The dev certificate that will be used when the real certificate can not be found

- - - -
- - - TimeStampUrl - -
- Signature: Uri option
-
-
- - - - -

The optional url of the timestamp server to use

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-signtoolhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-signtoolhelper.html deleted file mode 100644 index 01b2eb8..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-signtoolhelper.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - SignToolHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

SignToolHelper

-
-

Contains a task to sign assemblies using the SignTool.

- - -

Certificates

-

The SignTool needs a certificate to sign assemblies. It is not a good idea to include a certficate in your -source control system, but the sign step should be usable on developer machines. Because of this, you can -specify a dev certificate that can safely included in your source control system. Whenever the real certificate -can not be found, the dev certificate will be used.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - -
TypeDescription
- SignCert -

Represents a certificate file and an optional password

- - -
- SignParams -

Parameters used for signing.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - Sign toolsPath parameters filesToSign - -
- Signature: toolsPath:string -> parameters:SignParams -> filesToSign:seq<string> -> unit
-
-
- - - - -

Signs assemblies according to the settings specified in the parameters using signtool.exe. -This will be looked up using the toolsPath parameter.

- - - -
- - - SignTool (...) - -
- Signature: toolsPath:string -> certFile:string -> passFile:string option -> filesToSign:seq<string> -> unit
-
-
- - - - -

Signs all files in filesToSign with the certification file certFile, -protected with the password in the file passFile. -The signtool will be search in the toolPath.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-specflowhelper-specflowparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-specflowhelper-specflowparams.html deleted file mode 100644 index 3887a0e..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-specflowhelper-specflowparams.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - SpecFlowParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

SpecFlowParams

-
-

SpecFlow execution parameter type.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - BinFolder - -
- Signature: string
-
-
- - - - - -
- - - ForceRegeneration - -
- Signature: bool
-
-
- - - - - -
- - - OutputFile - -
- Signature: string
-
-
- - - - - -
- - - ProjectFile - -
- Signature: string
-
-
- - - - - -
- - - SubCommand - -
- Signature: string
-
-
- - - - - -
- - - TestOutputFile - -
- Signature: string
-
-
- - - - - -
- - - ToolName - -
- Signature: string
-
-
- - - - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - - -
- - - Verbose - -
- Signature: bool
-
-
- - - - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - - -
- - - XmlTestResultFile - -
- Signature: string
-
-
- - - - - -
- - - XsltFile - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-specflowhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-specflowhelper.html deleted file mode 100644 index ef28756..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-specflowhelper.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - - SpecFlowHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

SpecFlowHelper

-
-

Contains a task which allows to run SpecFlow tests.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- SpecFlowParams -

SpecFlow execution parameter type.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - SpecFlow setParams - -
- Signature: setParams:(SpecFlowParams -> SpecFlowParams) -> unit
-
-
- - - - -

Parameters

- -
    -
  • setParams - Function used to manipulate the default SpecFlow parameter value.
  • -
- - - -
- - - SpecFlowDefaults - -
- Signature: SpecFlowParams
-
-
- - - - -

SpecFlow default execution parameters.

- - - -
- - - toolname - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-sql-sqlserver-serverinfo.html b/packages/FAKE.4.11.3/docs/apidocs/fake-sql-sqlserver-serverinfo.html deleted file mode 100644 index ceab78f..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-sql-sqlserver-serverinfo.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - ServerInfo - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-sql-sqlserver.html b/packages/FAKE.4.11.3/docs/apidocs/fake-sql-sqlserver.html deleted file mode 100644 index 9ea110a..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-sql-sqlserver.html +++ /dev/null @@ -1,548 +0,0 @@ - - - - - SqlServer - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

SqlServer

-
-
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- ServerInfo -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - Attach serverInfo attachOptions files - -
- Signature: serverInfo:ServerInfo -> attachOptions:(type) -> files:seq<string> -> ServerInfo
-
-
- - - - -

Attach a database

- - - -
- - - CreateDb serverInfo - -
- Signature: serverInfo:ServerInfo -> ServerInfo
-
-
- - - - -

Creates a new db on the given server

- - - -
- - - Detach serverInfo - -
- Signature: serverInfo:ServerInfo -> ServerInfo
-
-
- - - - -

Detaches a database

- - - -
- - - Disconnect serverInfo - -
- Signature: serverInfo:ServerInfo -> unit
-
-
- - - - -

Closes the connection to the server

- - - -
- - - DropAndCreateDatabase connectionString - -
- Signature: connectionString:string -> unit
-
-
- - - - -

Drops and creates the database (dropped if db exists. created nonetheless)

- - - -
- - - DropDb serverInfo - -
- Signature: serverInfo:ServerInfo -> ServerInfo
-
-
- - - - -

Drops the given InitialCatalog from the server (if it exists)

- - - -
- - - existDBOnServer serverInfo dbName - -
- Signature: serverInfo:ServerInfo -> dbName:string -> bool
-
-
- - - - -

Checks whether the given Database exists on the server

- - - -
- - - getDatabase serverInfo - -
- Signature: serverInfo:ServerInfo -> (type)
-
-
- - - - -

Gets the initial catalog as database instance

- - - -
- - - getDatabaseNamesFromServer serverInfo - -
- Signature: serverInfo:ServerInfo -> seq<string>
-
-
- - - - -

gets the DatabaseNames from the server

- - - -
- - - getDatabasesFromServer serverInfo - -
- Signature: serverInfo:ServerInfo -> seq<(type)>
-
-
- - - - -

gets the DatabaseNames from the server

- - - -
- - - getDBName serverInfo - -
- Signature: serverInfo:ServerInfo -> string
-
-
- - - - -

Gets the initial catalog name

- - - -
- - - getServerInfo connectionString - -
- Signature: connectionString:string -> ServerInfo
-
-
- - - - -

Gets a connection to the SQL server and an instance to the ConnectionStringBuilder

- - - -
- - - getServerName serverInfo - -
- Signature: serverInfo:ServerInfo -> string
-
-
- - - - -

Gets the name of the server

- - - -
- - - intitialCatalogExistsOnServer serverInfo - -
- Signature: serverInfo:ServerInfo -> bool
-
-
- - - - -

Checks whether the given InitialCatalog exists on the server

- - - -
- - - KillAllProcesses serverInfo - -
- Signature: serverInfo:ServerInfo -> ServerInfo
-
-
- - - - -

Kills all processes with the given server info

- - - -
- - - ReplaceDatabaseFiles (...) - -
- Signature: connectionString:string -> targetDir:string -> files:seq<string> -> attachOptions:(type) -> unit
-
-
- - - - -

Replaces the database files

- - - -
- - - ReplaceDatabaseFilesWithCache (...) - -
- Signature: connectionString:string -> targetDir:string -> cacheDir:string -> files:seq<string> -> attachOptions:(type) -> unit
-
-
- - - - -

Replaces the database files from a cache. - If the files in the cache are not up to date, they will be refreshed.

- - - -
- - - runScript serverInfo sqlFile - -
- Signature: serverInfo:ServerInfo -> sqlFile:string -> unit
-
-
- - - - -

Runs a sql script on the server.

- - - -
- - - RunScripts connectionString scripts - -
- Signature: connectionString:string -> scripts:seq<string> -> unit
-
-
- - - - -

Runs the given sql scripts on the server.

- - - -
- - - RunScriptsFromDirectory (...) - -
- Signature: connectionString:string -> scriptDirectory:string -> unit
-
-
- - - - -

Runs all sql scripts from the given directory on the server.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-squirrel-squirrelparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-squirrel-squirrelparams.html deleted file mode 100644 index 3b65ece..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-squirrel-squirrelparams.html +++ /dev/null @@ -1,344 +0,0 @@ - - - - - SquirrelParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

SquirrelParams

-
-

The Squirrel Console Parameters type. -FAKE will use SquirrelDefaults for values not provided.

- -

For reference, see: Squirrel Command Line Options

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - BootstrapperExe - -
- Signature: string option
-
-
- - - - -

The full path to an optional setup.exe template

- - - -
- - - LoadingGif - -
- Signature: string option
-
-
- - - - -

The full path to an optional animated gif to be displayed during installation

- - - -
- - - NoMsi - -
- Signature: bool
-
-
- - - - -

Do not create an MSI file

- - - -
- - - ReleaseDir - -
- Signature: string
-
-
- - - - -

The output directory for the generated installer

- - - -
- - - SetupIcon - -
- Signature: string option
-
-
- - - - -

The full path to an optional icon, which will be used for the generated installer.

- - - -
- - - SignExecutable - -
- Signature: bool option
-
-
- - - - -

Sign the installer with signtool.exe

- - - -
- - - SigningKeyFile - -
- Signature: string option
-
-
- - - - -

The code signing certificate to be used for signing

- - - -
- - - SigningSecret - -
- Signature: string option
-
-
- - - - -

The secret key for the code signing certificate

- - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - -

Maximum time to allow Squirrel to run before being killed.

- - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - -

The path to Squirrel: squirrel.exe

- - - -
- - - WorkingDir - -
- Signature: string option
-
-
- - - - -

The working directory.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-squirrel.html b/packages/FAKE.4.11.3/docs/apidocs/fake-squirrel.html deleted file mode 100644 index 1741b8a..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-squirrel.html +++ /dev/null @@ -1,216 +0,0 @@ - - - - - Squirrel - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Squirrel

-
-

Contains types and utility functions related to creating Squirrel installer.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- SquirrelParams -

The Squirrel Console Parameters type. -FAKE will use SquirrelDefaults for values not provided.

- -

For reference, see: Squirrel Command Line Options

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - SquirrelDefaults - -
- Signature: SquirrelParams
-
-
- - - - -

The Squirrel default parameters.

- -

Defaults

- -
    -
  • ReleaseDir - ""
  • -
  • WorkingDir - None
  • -
  • BootstrapperExe - None
  • -
  • LoadingGif - None
  • -
  • SetupIcon - None
  • -
  • NoMsi - false
  • -
  • ToolPath - The squirrel.exe path if it exists in a subdirectory of the current directory.
  • -
  • TimeOut - 10 minutes
  • -
  • SignExecutable - None
  • -
  • SigningSecret - None
  • -
  • SigningSecret - None
  • -
- - - -
- - - SquirrelPack setParams nugetPackage - -
- Signature: setParams:(SquirrelParams -> SquirrelParams) -> nugetPackage:string -> unit
-
-
- - - - -

Creates a Squirrel installer for given NuGet package -Will fail if Squirrel terminates with non-zero exit code.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default SquirrelParams value.
  • -
  • nugetPackage - The package to create an installer for
  • -
- -

Sample usage

- - - - -
1: 
-2: 
-3: 
-
Target "CreatePackage" (fun _ ->
-    SquirrelPack (fun p -> { p with WorkingDir = Some "./tmp" }) "./my.nuget"
-)
-
- -
union case Option.Some: Value: 'T -> Option<'T>
- - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-stringhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-stringhelper.html deleted file mode 100644 index a414e46..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-stringhelper.html +++ /dev/null @@ -1,1474 +0,0 @@ - - - - - StringHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

StringHelper

-
-

Contains basic functions for string manipulation.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - ( <* ) prefix text - -
- Signature: prefix:string -> text:string -> bool
-
-
- - - - -

Checks whether the given text starts with the given prefix

- - - -
- - - ( >** ) pattern text - -
- Signature: pattern:string -> text:string -> bool
-
-
- - - - -

Determines if a text matches a given regex pattern.

- - - -
- - - ( >=> ) pattern replacement text - -
- Signature: pattern:string -> replacement:string -> text:string -> string
-
-
- - - - -

Find a regex pattern in a text and replaces it with the given replacement.

- - - -
- - - append text builder - -
- Signature: text:string -> builder:StringBuilder -> StringBuilder
-
-
- - - - -

Appends a text to a StringBuilder.

- - - -
- - - appendFileNamesIfNotNull (...) - -
- Signature: fileNames:seq<string> -> builder:StringBuilder -> StringBuilder
-
-
- - - - -

Appends all notnull fileNames.

- - - -
- - - appendIfFalse p - -
- Signature: p:bool -> string -> StringBuilder -> StringBuilder
-
-
- - - - -

Appends a text if the predicate is false.

- - - -
- - - appendIfNotNull value s - -
- Signature: value:Object -> s:string -> StringBuilder -> StringBuilder
-
-
- - - - -

Appends a text if the value is not null.

- - - -
- - - appendIfNotNullOrEmpty value s - -
- Signature: value:string -> s:string -> StringBuilder -> StringBuilder
-
-
- - - - -

Appends a text if the value is not null or empty.

- - - -
- - - appendIfSome o f builder - -
- Signature: o:'?8409 option -> f:('?8409 -> string) -> builder:StringBuilder -> StringBuilder
- Type parameters: '?8409
-
- - - - -

Appends string of function value if option has some value

- - - -
- - - appendIfTrue p s builder - -
- Signature: p:bool -> s:string -> builder:StringBuilder -> StringBuilder
-
-
- - - - -

Appends a text if the predicate is true.

- - - -
- - - appendIfTrueWithoutQuotes p s builder - -
- Signature: p:bool -> s:string -> builder:StringBuilder -> StringBuilder
-
-
- - - - - -
- - - appendQuotedIfNotNull value s builder - -
- Signature: value:Object -> s:string -> builder:StringBuilder -> StringBuilder
-
-
- - - - -

Appends a quoted text if the value is not null.

- - - -
- - - appendStringIfValueIsNotNull value - -
- Signature: value:'?8417 -> string -> StringBuilder -> StringBuilder
- Type parameters: '?8417
-
- - - - -

Appends a text if the value is not null.

- - - -
- - - appendStringIfValueIsNotNullOrEmpty (...) - -
- Signature: value:string -> string -> StringBuilder -> StringBuilder
-
-
- - - - -

Appends a text if the value is not null or empty.

- - - -
- - - AppendToFile file lines - -
- Signature: file:string -> lines:seq<string> -> unit
-
-
- - - - -

Appends all lines to a file line by line

- - - -
- - - appendWithoutQuotes text builder - -
- Signature: text:string -> builder:StringBuilder -> StringBuilder
-
-
- - - - -

Appends a text to a StringBuilder without surrounding quotes.

- - - -
- - - appendWithoutQuotesIfNotNull value s - -
- Signature: value:Object -> s:string -> StringBuilder -> StringBuilder
-
-
- - - - -

Appends a text without quoting if the value is not null.

- - - -
- - - charsAndDigits - -
- Signature: char list
-
-
- - - - -

Returns all standard chars and digits.

- - - -
- - - Colon - -
- Signature: char
-
-
- - - - - -
- - - ConvertFileToWindowsLineBreaks fileName - -
- Signature: fileName:string -> unit
-
-
- - - - -

Reads a file line by line and replaces all line breaks to windows line breaks - - uses a temp file to store the contents in order to prevent OutOfMemory exceptions

- - - -
- - - ConvertTextToWindowsLineBreaks text - -
- Signature: text:string -> string
-
-
- - - - -

Converts all line breaks in a text to windows line breaks

- - - -
- - - DecodeBase64Utf8String text - -
- Signature: text:string -> string
-
-
- - - - -

Decodes a Base64-encoded UTF-8-encoded string

- - - -
- - - EncapsulateApostrophe text - -
- Signature: text:string -> string
-
-
- - - - -

Encapsulates the Apostrophe

- - - -
- - - endsWith suffix text - -
- Signature: suffix:string -> text:string -> bool
-
-
- - - - -

Checks whether the given text ends with the given suffix

- - - -
- - - endsWithSlash - -
- Signature: string -> bool
-
-
- - - - -

Determines whether the last character of the given -matches Path.DirectorySeparatorChar.

- - - -
- - - isLetterOrDigit c - -
- Signature: c:char -> bool
-
-
- - - - -

Checks whether the given char is a standard char or digit.

- - - -
- - - isNotNullOrEmpty value - -
- Signature: value:string -> bool
-
-
- - - - -

Returns if the string is not null or empty

- - - -
- - - isNullOrEmpty value - -
- Signature: value:string -> bool
-
-
- - - - -

Returns if the string is null or empty

- - - -
- - - isNullOrWhiteSpace value - -
- Signature: value:string -> bool
-
-
- - - - -

Returns if the string is null or empty or completely whitespace

- - - -
- - - isUmlaut c - -
- Signature: c:char -> bool
-
-
- - - - -

Checks whether the given char is a german umlaut.

- - - -
- - - liftString x - -
- Signature: x:string -> string option
-
-
- - - - -

Lifts a string to an option

- - - -
- - - LinuxLineBreaks - -
- Signature: string
-
-
- - - - -

Represents Linux line breaks

- - - -
- - - MacLineBreaks - -
- Signature: string
-
-
- - - - -

Represents Mac line breaks

- - - -
- - - NormalizeVersion version - -
- Signature: version:string -> string
-
-
- - - - -

Removes all trailing .0 from a version string

- - - -
- - - ProduceRelativePath (...) - -
- Signature: baseLocation:string -> targetLocation:string -> string
-
-
- - - - -

Produces relative path when possible to go from baseLocation to targetLocation.

- - - -
- - - ReadFile file - -
- Signature: file:string -> seq<string>
-
-
- - - - -

Reads a file line by line

- - - -
- - - ReadFileAsBytes file - -
- Signature: file:string -> byte []
-
-
- - - - -

Reads a file as one array of bytes

- - - -
- - - ReadFileAsString file - -
- Signature: file:string -> string
-
-
- - - - -

Reads a file as one text

- - - -
- - - ReadLine file - -
- Signature: file:string -> string
-
-
- - - - -

Reads the first line of a file. This can be helpful to read a password from file.

- - - -
- - - RemoveLineBreaks text - -
- Signature: text:string -> string
-
-
- - - - -

Removes linebreaks from the given string

- - - -
- - - replace pattern replacement text - -
- Signature: pattern:string -> replacement:string -> text:string -> string
-
-
- - - - -

Replaces the given pattern in the given text with the replacement

- - - -
- - - ReplaceFile fileName text - -
- Signature: fileName:string -> text:string -> unit
-
-
- - - - -

Replaces the file with the given string

- - - -
- - - replaceFirst pattern replacement text - -
- Signature: pattern:string -> replacement:string -> text:string -> string
-
-
- - - - -

Replaces the first occurrence of the pattern with the given replacement.

- - - -
- - - ReplaceInFile replaceF fileName - -
- Signature: replaceF:(string -> string) -> fileName:string -> unit
-
-
- - - - -

Replaces the text in the given file

- - - -
- - - separated delimiter items - -
- Signature: delimiter:string -> items:seq<string> -> string
-
-
- - - - -

Converts a sequence of strings to a string with delimiters

- - - -
- - - shortenCurrentDirectory value - -
- Signature: value:string -> string
-
-
- - - - -

Replaces any occurence of the currentDirectory with .

- - - -
- - - split delimiter text - -
- Signature: delimiter:char -> text:string -> string list
-
-
- - - - -

Splits the given string at the given char delimiter

- - - -
- - - splitStr delimiterStr text - -
- Signature: delimiterStr:string -> text:string -> string list
-
-
- - - - -

Splits the given string at the given string delimiter

- - - -
- - - startsWith prefix text - -
- Signature: prefix:string -> text:string -> bool
-
-
- - - - -

Checks whether the given text starts with the given prefix

- - - -
- - - toLines text - -
- Signature: text:seq<string> -> string
-
-
- - - - -

Converts a sequence of strings into a string separated with line ends

- - - -
- - - toLower s - -
- Signature: s:string -> string
-
-
- - - - -

Converts all characters in a string to lower case.

- - - -
- - - toRelativePath value - -
- Signature: value:string -> string
-
-
- - - - -

Replaces the absolute path to a relative path.

- - - -
- - - toText builder - -
- Signature: builder:StringBuilder -> string
-
-
- - - - -

Returns the text from the StringBuilder

- - - -
- - - trim x - -
- Signature: x:string -> string
-
-
- - - - -

Trims the given string

- - - -
- - - trimChars chars x - -
- Signature: chars:char [] -> x:string -> string
-
-
- - - - -

Trims the given string

- - - -
- - - trimEndChars chars x - -
- Signature: chars:char [] -> x:string -> string
-
-
- - - - -

Trims the end of the given string

- - - -
- - - trimSeparator s - -
- Signature: s:string -> string
-
-
- - - - -

Trims the given string with the DirectorySeparatorChar

- - - -
- - - trimSlash s - -
- Signature: s:string -> string
-
-
- - - - -

Removes the slashes from the end of the given string

- - - -
- - - trimSpecialChars text - -
- Signature: text:string -> string
-
-
- - - - -

Trims all special characters from a string.

- - - -
- - - trimStartChars chars x - -
- Signature: chars:char [] -> x:string -> string
-
-
- - - - -

Trims the start of the given string

- - - -
- - - WindowsLineBreaks - -
- Signature: string
-
-
- - - - -

Represents Windows line breaks

- - - -
- - - WriteBytesToFile file bytes - -
- Signature: file:string -> bytes:byte [] -> unit
-
-
- - - - -

Writes a byte array to a file

- - - -
- - - WriteFile file lines - -
- Signature: file:string -> lines:seq<string> -> unit
-
-
- - - - -

Writes a file line by line

- - - -
- - - WriteStringToFile append fileName text - -
- Signature: append:bool -> fileName:string -> text:string -> unit
-
-
- - - - -

Writes a string to a file

- - - -
- - - WriteToFile append fileName lines - -
- Signature: append:bool -> fileName:string -> lines:seq<string> -> unit
-
-
- - - - -

Writes a file line by line

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-strongnaminghelper-strongnameparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-strongnaminghelper-strongnameparams.html deleted file mode 100644 index d4e0b13..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-strongnaminghelper-strongnameparams.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - StrongNameParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

StrongNameParams

-
-

Strong naming parameters

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - -

The timeout for the Strong naming process.

- - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - -

(Required) Path to the sn.exe

- - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - -

The directory where the Strong naming process will be started.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-strongnaminghelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-strongnaminghelper.html deleted file mode 100644 index 4e6738c..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-strongnaminghelper.html +++ /dev/null @@ -1,232 +0,0 @@ - - - - - StrongNamingHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

StrongNamingHelper

-
-

This module contains helper function for Microsoft's sn.exe

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- StrongNameParams -

Strong naming parameters

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - DisableVerification assembly key - -
- Signature: assembly:string -> key:string -> unit
-
-
- - - - -

Registers the given assembly for verification skipping.

- - - -
- - - SN32 - -
- Signature: string
-
-
- - - - - -
- - - SN64 - -
- Signature: string
-
-
- - - - - -
- - - StrongName setParams command - -
- Signature: setParams:(StrongNameParams -> StrongNameParams) -> command:string -> unit
-
-
- - - - -

Runs sn.exe with the given command.

- - - -
- - - StrongNameDefaults - -
- Signature: StrongNameParams
-
-
- - - - -

Strong naming default parameters

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-sxshelper-interopapplicationdata.html b/packages/FAKE.4.11.3/docs/apidocs/fake-sxshelper-interopapplicationdata.html deleted file mode 100644 index a850c12..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-sxshelper-interopapplicationdata.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - InteropApplicationData - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

InteropApplicationData

-
-

Represents an executable to create an application manifest for

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Dependencies - -
- Signature: seq<InteropAssemblyData>
-
-
- - - - -

Dependent .NET assemblies of the executable

- - - -
- - - ExecutablePath - -
- Signature: string
-
-
- - - - -

Path of the executable binary file

- - - -
- - - Version - -
- Signature: String
-
-
- - - - -

Version of the executable

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-sxshelper-interopassemblydata.html b/packages/FAKE.4.11.3/docs/apidocs/fake-sxshelper-interopassemblydata.html deleted file mode 100644 index cef988c..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-sxshelper-interopassemblydata.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - InteropAssemblyData - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

InteropAssemblyData

-
-

Represents a .NET assembly that may be used in COM interop projects

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Guid - -
- Signature: Guid
-
-
- - - - -

Guid from the System.Runtime.Interopservice.GuidAttribute of the assembly

- - - -
- - - Name - -
- Signature: string
-
-
- - - - -

Assembly name

- - - -
- - - Path - -
- Signature: string
-
-
- - - - -

Path to the assembly file

- - - -
- - - Version - -
- Signature: string
-
-
- - - - -

Assembly version

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-sxshelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-sxshelper.html deleted file mode 100644 index 65be62d..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-sxshelper.html +++ /dev/null @@ -1,253 +0,0 @@ - - - - - SxsHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

SxsHelper

-
-

Module that enables creating and embedding Side-by-Side interop -manifests for registration free deployment of Com-.net interop projects

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - -
TypeDescription
- InteropApplicationData -

Represents an executable to create an application manifest for

- - -
- InteropAssemblyData -

Represents a .NET assembly that may be used in COM interop projects

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - AddEmbeddedApplicationManifest (...) - -
- Signature: workingDir:string -> applications:seq<InteropApplicationData> -> unit
-
-
- - - - -

Creates and adds application interop side-by-side manifests to provided executables

- -

Parameters

- -
    -
  • workingdir - somewhere to put any temporary files
  • -
  • applications - Metadata about executables to create manifests for.
  • -
- - - -
- - - AddEmbeddedAssemblyManifest (...) - -
- Signature: workingDir:string -> assemblies:seq<string> -> unit
-
-
- - - - -

Created and embeds assembly Side-by-side interop manifests for provided assemblies

- -

Parameters

- -
    -
  • workingDir - somewhere to put any temp files created
  • -
  • assemblies - .net assemblies to create manifests for
  • -
- -

Process

- -

This function will use mt.exe (ref: https://msdn.microsoft.com/en-us/library/aa375649(v=vs.85).aspx) -to create a manifest for each assembly. This created manifest is unfortunately not a valid -interop Side-by-Side manifest, but it has the important clrClass elements, + version and nameinfo that would be the most -difficult to create through other means. -The important info is then put into a valid base manifest and embedded into the assembly as a resource.

- - - -
- - - GetInteropAssemblyData (...) - -
- Signature: workingDir:string -> assemblies:seq<string> -> InteropAssemblyData list
-
-
- - - - -

Gets name, path',versionand interopGuid` for those of the provided assemblies that have -all of the required information.

- -

Parameters

- -
    -
  • workingDir - Somewhere to put temporary files
  • -
  • assemblies - assemblies to get data from
  • -
- -

Purpose

- -

In order to create application interop side-by-side manifests we need to know some metadata -about the assemblies that may be referenced from COM executables. -For the manifest we need the assembly version and assembly name. And in addition to that -the interop guid is collected so we can determine if the assembly is referenced by vb6 projects

- -

Process

- -

This function is a hack. To avoid using reflection and loading all potential assemblies into the -appdomain (with all the possible problems that may cause). I wanted to get this metadata by other means. -I ended up using the windows sdk dissasembler ildasm.exe (ref: https://msdn.microsoft.com/en-us/library/f7dy01k1(v=vs.110).aspx) -to create the smallest dissasembly I could (Really only need the manifest part), and the parse the IL file to get the metadata -(If anyone knows a cleaner / better way, pls improve on the code)

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-targethelper-builderror.html b/packages/FAKE.4.11.3/docs/apidocs/fake-targethelper-builderror.html deleted file mode 100644 index 6c85cb9..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-targethelper-builderror.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - BuildError - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-targethelper-target.html b/packages/FAKE.4.11.3/docs/apidocs/fake-targethelper-target.html deleted file mode 100644 index 3ff881a..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-targethelper-target.html +++ /dev/null @@ -1,102 +0,0 @@ - - - - - Target - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-targethelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-targethelper.html deleted file mode 100644 index b727f38..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-targethelper.html +++ /dev/null @@ -1,800 +0,0 @@ - - - - - TargetHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

TargetHelper

-
-

Contains infrastructure code and helper functions for FAKE's target feature.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - -
TypeDescription
- BuildError -

Represents build errors

- - -
- Target -

A Target can be run during the build

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - ( <== ) x ys - -
- Signature: x:string -> ys:string list -> unit
-
-
- - - - -

Backwards dependencies operator - x is dependent on ys.

- - - -
- - - ActivateBuildFailureTarget name - -
- Signature: name:string -> unit
-
-
- - - - -

Activates the BuildFailureTarget.

- - - -
- - - ActivateFinalTarget name - -
- Signature: name:string -> unit
-
-
- - - - -

Activates the FinalTarget.

- - - -
- - - addExecutedTarget target time - -
- Signature: target:string -> time:TimeSpan -> unit
-
-
- - - - - -
- - - BuildFailureTarget name body - -
- Signature: name:string -> body:(unit -> unit) -> unit
-
-
- - - - -

Registers a BuildFailureTarget (not activated).

- - - -
- - - BuildFailureTargets - -
- Signature: Dictionary<string,bool>
-
-
- - - - -

BuildFailureTargets - stores build failure targets and if they are activated.

- - - -
- - - dependencyString target - -
- Signature: target:'?8256 TargetTemplate -> string
- Type parameters: '?8256
-
- - - - -

Returns the DependencyString for the given target.

- - - -
- - - determineBuildOrder target - -
- Signature: target:string -> unit TargetTemplate [] list
-
-
- - - - -

Determines a parallel build order for the given set of targets

- - - -
- - - doesTargetMeanListTargets target - -
- Signature: target:string -> bool
-
-
- - - - - -
- - - DoNothing () - -
- Signature: unit -> unit
-
-
- - - - -

Do nothing - fun () -> () - Can be used to define empty targets.

- - - -
- - - ExecutedTargets - -
- Signature: HashSet<string>
-
-
- - - - -

The executed targets.

- - - -
- - - FinalTarget name body - -
- Signature: name:string -> body:(unit -> unit) -> unit
-
-
- - - - -

Registers a final target (not activated).

- - - -
- - - FinalTargets - -
- Signature: Dictionary<string,bool>
-
-
- - - - -

Final Targets - stores final targets and if they are activated.

- - - -
- - - getAllTargetsNames () - -
- Signature: unit -> string list
-
-
- - - - -

Returns a list with all target names.

- - - -
- - - getTarget name - -
- Signature: name:string -> unit TargetTemplate
-
-
- - - - -

Gets a target with the given name from the target dictionary.

- - - -
- - - listTargets () - -
- Signature: unit -> unit
-
-
- - - - -

Prints all available targets.

- - - -
- - - PrintDependencyGraph verbose target - -
- Signature: verbose:bool -> target:string -> unit
-
-
- - - - -

Writes a dependency graph.

- - - -
- - - PrintTargets () - -
- Signature: unit -> unit
-
-
- - - - -

Prints all targets.

- - - -
- - - run targetName - -
- Signature: targetName:string -> unit
-
-
- - - - -

Runs a target and its dependencies.

- - - -
- - - runSingleTarget target - -
- Signature: target:unit TargetTemplate -> unit
-
-
- - - - -

Runs a single target without its dependencies

- - - -
- - - runTargetsParallel count targets - -
- Signature: count:int -> targets:Target [] -> unit
-
-
- - - - -

Runs the given array of targets in parallel using count tasks

- - - -
- - - softDependencyString target - -
- Signature: target:'?8258 TargetTemplate -> string
- Type parameters: '?8258
-
- - - - -

Returns the soft DependencyString for the given target.

- - - -
- - - Target name body - -
- Signature: name:string -> body:(unit -> unit) -> unit
-
-
- - - - -

Creates a Target.

- - - -
- - - TargetTemplate body - -
- Signature: body:('?8280 -> unit) -> string -> '?8280 -> unit
- Type parameters: '?8280
-
- - - - -

Creates a TargetTemplate.

- - - -
- - - TargetTemplateWithDependecies (...) - -
- Signature: dependencies:string list -> ('?8278 -> unit) -> string -> '?8278 -> unit
- Type parameters: '?8278
-
- - - - - -
- - - TargetTemplateWithDependencies (...) - -
- Signature: dependencies:string list -> body:('?8276 -> unit) -> name:string -> parameters:'?8276 -> unit
- Type parameters: '?8276
-
- - - - -

Creates a TargetTemplate with dependencies.

- -

Sample

- -

The following sample creates 4 targets using TargetTemplateWithDependencies and hooks them into the build pipeline.

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-21: 
-22: 
-23: 
-24: 
-25: 
-26: 
-27: 
-28: 
-29: 
-30: 
-31: 
-32: 
-
// Create target creation functions
-let createCompileTarget name strategy = 
-TargetTemplateWithDependencies 
-    ["Clean"; "ResolveDependencies"] // dependencies to other targets 
-    (fun targetParameter -> 
-      tracefn "--- start compile product..."  
-      if targetParameter = "a" then
-        tracefn "    ---- Strategy A"
-      else
-        tracefn "    ---- Strategy B"
-      tracefn "--- finish compile product ..."    
-    ) name strategy
-
-let createTestTarget name dependencies filePattern = 
-  TargetTemplateWithDependencies 
-    dependencies 
-    (fun filePattern ->   
-      tracefn "--- start compile tests ..."
-      !! filePattern
-      |> RunTests
-      tracefn "--- finish compile tests ...")
-    name filePattern
-
-// create some targets
-createCompileTarget "C1" "a"
-createCompileTarget "C2" "b"
-
-createTestTarget "T1" ["C1"] "**/C1/*.*"
-createTestTarget "T2" ["C1"; "C2"] "**/C?/*.*"
-
-// hook targets to normal build pipeline
-"T1" ==> "T2" ==> "Test"
-
- -
val createCompileTarget : name:'a -> strategy:'b -> obj

Full name: docs.createCompileTarget
-
val name : 'a
-
val strategy : 'a
-
val createTestTarget : ('a -> 'b -> 'c -> 'd)
-
val dependencies : 'a
-
val filePattern : 'a
- - -
- - - WriteErrors () - -
- Signature: unit -> unit
-
-
- - - - -

Writes a summary of errors reported during build.

- - - -
- - - WriteTaskTimeSummary total - -
- Signature: total:'?8304 -> unit
- Type parameters: '?8304
-
- - - - -

Writes a build time report.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-taskrunnerhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-taskrunnerhelper.html deleted file mode 100644 index 6101ab7..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-taskrunnerhelper.html +++ /dev/null @@ -1,171 +0,0 @@ - - - - - TaskRunnerHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

TaskRunnerHelper

-
-

Contains a helper which can be used to implement timeouts and retries.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - runWithRetries f retries - -
- Signature: f:(unit -> '?8242) -> retries:int -> '?8242
- Type parameters: '?8242
-
- - - - -

Retries the given function until a retry limit is reached or the function succeeds without exception.

- -

Parameters

- -
    -
  • f - This function will be started.
  • -
  • retries - A retry limit.
  • -
- - - -
- - - waitFor f timeout testMS timeoutF - -
- Signature: f:(unit -> bool) -> timeout:TimeSpan -> testMS:int -> timeoutF:(unit -> unit) -> TimeSpan
-
-
- - - - -

Waits until the given function returns true or the timeout is reached.

- -

Parameters

- -
    -
  • f - This function will be started.
  • -
  • timeout - A System.TimeSpan representing the timeout.
  • -
  • testMS - An interval at which FAKE checks if the function has succeeded.
  • -
  • timeoutF - This function will be run if the timeout has been reached.
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-teamcityhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-teamcityhelper.html deleted file mode 100644 index 3ca66bf..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-teamcityhelper.html +++ /dev/null @@ -1,1055 +0,0 @@ - - - - - TeamCityHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

TeamCityHelper

-
-

Contains helper functions which allow FAKE to communicate with a TeamCity agent

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - ComparisonFailure (...) - -
- Signature: name:string -> message:string -> details:string -> expected:string -> actual:string -> unit
-
-
- - - - -

Reports a failed comparison.

- - - -
- - - EncapsulateSpecialChars text - -
- Signature: text:string -> string
-
-
- - - - -

Encapsulates special chars

- - - -
- - - FinishTestCase testCaseName duration - -
- Signature: testCaseName:string -> duration:TimeSpan -> unit
-
-
- - - - -

Finishes the test case.

- - - -
- - - FinishTestSuite testSuiteName - -
- Signature: testSuiteName:string -> unit
-
-
- - - - -

Finishes the test suite.

- - - -
- - - getChangedFilesInCurrentBuild () - -
- Signature: unit -> seq<string>
-
-
- - - - -

Gets the changed files

- - - -
- - - getRecentlyFailedTests () - -
- Signature: unit -> seq<string>
-
-
- - - - -

Gets the recently failed tests

- - - -
- - - IgnoreTestCase name message - -
- Signature: name:string -> message:string -> unit
-
-
- - - - -

Ignores the test case.

- - - -
- - - IgnoreTestCaseWithDetails (...) - -
- Signature: name:string -> message:string -> details:string -> unit
-
-
- - - - -

Ignores the test case.

- - - -
- - - PublishArticfact path - -
- Signature: path:string -> unit
-
-
- - - - - -
- - - PublishArtifact path - -
- Signature: path:string -> unit
-
-
- - - - -

Publishes an artifact on the TeamcCity build server.

- - - -
- - - ReportBuildStatus status message - -
- Signature: status:string -> message:string -> unit
-
-
- - - - -

Reports the build status.

- - - -
- - - ReportProgress message - -
- Signature: message:string -> unit
-
-
- - - - -

Reports the progress.

- - - -
- - - ReportProgressFinish message - -
- Signature: message:string -> unit
-
-
- - - - -

Reports the progress end.

- - - -
- - - ReportProgressStart message - -
- Signature: message:string -> unit
-
-
- - - - -

Reports the progress start.

- - - -
- - - sendCloseBlock - -
- Signature: string -> unit
-
-
- - - - -

Close Named Block

- - - -
- - - sendOpenBlock - -
- Signature: string -> unit
-
-
- - - - -

Open Named Block

- - - -
- - - sendStrToTeamCity s - -
- Signature: s:string -> unit
-
-
- - - - -

Send message to TeamCity

- - - -
- - - sendTeamCityCheckstyleImport path - -
- Signature: path:string -> unit
-
-
- - - - -

Sends an Checkstyle results filename to TeamCity

- - - -
- - - sendTeamCityDotNetCoverageImport path - -
- Signature: path:string -> unit
-
-
- - - - -

Sends an dotcover, partcover, ncover or ncover3 results filename to TeamCity

- - - -
- - - sendTeamCityDotNetDupFinderImport path - -
- Signature: path:string -> unit
-
-
- - - - -

Sends an ReSharper dupfinder.exe results filename to TeamCity

- - - -
- - - sendTeamCityError error - -
- Signature: error:string -> unit
-
-
- - - - -

Sends an error to TeamCity

- - - -
- - - sendTeamCityFindBugsImport path - -
- Signature: path:string -> unit
-
-
- - - - -

Sends an FindBugs results filename to TeamCity

- - - -
- - - sendTeamCityFxCopImport path - -
- Signature: path:string -> unit
-
-
- - - - -

Sends an FxCop inspection results filename to TeamCity

- - - -
- - - sendTeamCityFXCopImport path - -
- Signature: path:string -> unit
-
-
- - - - -

Sends an FXCop results filename to TeamCity

- - - -
- - - sendTeamCityGTestImport path - -
- Signature: path:string -> unit
-
-
- - - - -

Sends an Google Test results filename to TeamCity

- - - -
- - - sendTeamCityJSLintImport path - -
- Signature: path:string -> unit
-
-
- - - - -

Sends an JSLint results filename to TeamCity

- - - -
- - - sendTeamCityJUnitImport path - -
- Signature: path:string -> unit
-
-
- - - - -

Sends an JUnit Ant task results filename to TeamCity

- - - -
- - - sendTeamCityMSTestImport path - -
- Signature: path:string -> unit
-
-
- - - - -

Sends an MSTest results filename to TeamCity

- - - -
- - - sendTeamCityNUnitImport path - -
- Signature: path:string -> unit
-
-
- - - - -

Sends an NUnit results filename to TeamCity

- - - -
- - - sendTeamCityPmdCpdImport path - -
- Signature: path:string -> unit
-
-
- - - - -

Sends an PMD Copy/Paste Detector results filename to TeamCity

- - - -
- - - sendTeamCityPmdImport path - -
- Signature: path:string -> unit
-
-
- - - - -

Sends an PMD inspections results filename to TeamCity

- - - -
- - - sendTeamCityReSharperInspectCodeImport (...) - -
- Signature: path:string -> unit
-
-
- - - - -

Sends an ReSharper inspectCode.exe results filename to TeamCity

- - - -
- - - sendTeamCitySurefireImport path - -
- Signature: path:string -> unit
-
-
- - - - -

Sends an Maven Surefire results filename to TeamCity

- - - -
- - - sendToTeamCity format message - -
- Signature: format:StringFormat<(string -> string)> -> message:string -> unit
-
-
- - - - -

Send message to TeamCity

- - - -
- - - SetBuildNumber buildNumber - -
- Signature: buildNumber:string -> unit
-
-
- - - - -

Sets the TeamCity build number.

- - - -
- - - SetBuildStatistic key value - -
- Signature: key:string -> value:string -> unit
-
-
- - - - -

Reports a build statistic.

- - - -
- - - SetTeamCityParameter name value - -
- Signature: name:string -> value:string -> unit
-
-
- - - - -

Reports a parameter value

- - - -
- - - StartTestCase testCaseName - -
- Signature: testCaseName:string -> unit
-
-
- - - - -

Starts the test case.

- - - -
- - - StartTestSuite testSuiteName - -
- Signature: testSuiteName:string -> unit
-
-
- - - - -

Starts the test suite.

- - - -
- - - TeamCityBuildConfigurationName - -
- Signature: string option
-
-
- - - - -

The Name of the Build Configuration the current build belongs to or None if it's not on TeamCity.

- - - -
- - - TeamCityBuildIsPersonal - -
- Signature: bool
-
-
- - - - -

Is set to true if the build is a personal one.

- - - -
- - - TeamCityBuildNumber - -
- Signature: string option
-
-
- - - - -

The Build number assigned to the build by TeamCity using the build number format or None if it's not on TeamCity.

- - - -
- - - TeamCityProjectName - -
- Signature: string option
-
-
- - - - -

The Name of the project the current build belongs to or None if it's not on TeamCity.

- - - -
- - - TeamCityVersion - -
- Signature: string option
-
-
- - - - -

The Version of the TeamCity server. This property can be used to determine the build is run within TeamCity.

- - - -
- - - TestFailed name message details - -
- Signature: name:string -> message:string -> details:string -> unit
-
-
- - - - -

Reports a failed test.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-teamcityresthelper-build.html b/packages/FAKE.4.11.3/docs/apidocs/fake-teamcityresthelper-build.html deleted file mode 100644 index 06b6440..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-teamcityresthelper-build.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - Build - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Build

-
-

Record type which stores Build properties

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ID - -
- Signature: string
-
-
- - - - - -
- - - Number - -
- Signature: string
-
-
- - - - - -
- - - Status - -
- Signature: string
-
-
- - - - - -
- - - WebURL - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-teamcityresthelper-buildconfiguration.html b/packages/FAKE.4.11.3/docs/apidocs/fake-teamcityresthelper-buildconfiguration.html deleted file mode 100644 index 4743ff1..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-teamcityresthelper-buildconfiguration.html +++ /dev/null @@ -1,236 +0,0 @@ - - - - - BuildConfiguration - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

BuildConfiguration

-
-

Record type which stores Build configuration properties

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Builds - -
- Signature: seq<Build>
-
-
- - - - - -
- - - Description - -
- Signature: string
-
-
- - - - - -
- - - ID - -
- Signature: string
-
-
- - - - - -
- - - Name - -
- Signature: string
-
-
- - - - - -
- - - Paused - -
- Signature: bool
-
-
- - - - - -
- - - ProjectID - -
- Signature: string
-
-
- - - - - -
- - - WebURL - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-teamcityresthelper-project.html b/packages/FAKE.4.11.3/docs/apidocs/fake-teamcityresthelper-project.html deleted file mode 100644 index 9883ec2..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-teamcityresthelper-project.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - Project - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Project

-
-

Record type which stores TeamCity project properties

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Archived - -
- Signature: bool
-
-
- - - - - -
- - - BuildConfigs - -
- Signature: seq<string>
-
-
- - - - - -
- - - Description - -
- Signature: string
-
-
- - - - - -
- - - ID - -
- Signature: string
-
-
- - - - - -
- - - Name - -
- Signature: string
-
-
- - - - - -
- - - WebURL - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-teamcityresthelper-vcsroot.html b/packages/FAKE.4.11.3/docs/apidocs/fake-teamcityresthelper-vcsroot.html deleted file mode 100644 index 9c458ef..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-teamcityresthelper-vcsroot.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - VCSRoot - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

VCSRoot

-
-

Record type which stores VCSRoot properties

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Name - -
- Signature: string
-
-
- - - - - -
- - - Properties - -
- Signature: Map<string,string>
-
-
- - - - - -
- - - URL - -
- Signature: string
-
-
- - - - - -
- - - VCSName - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-teamcityresthelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-teamcityresthelper.html deleted file mode 100644 index 69212e2..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-teamcityresthelper.html +++ /dev/null @@ -1,244 +0,0 @@ - - - - - TeamCityRESTHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

TeamCityRESTHelper

-
-

Contains functions which allow FAKE to interact with the TeamCity REST API.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- Build -

Record type which stores Build properties

- - -
- BuildConfiguration -

Record type which stores Build configuration properties

- - -
- Project -

Record type which stores TeamCity project properties

- - -
- VCSRoot -

Record type which stores VCSRoot properties

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - getBuildConfig (...) - -
- Signature: serverURL:string -> username:string -> password:string -> id:string -> BuildConfiguration
-
-
- - - - -

Gets information about a build configuration from the TeamCity server.

- - - -
- - - getProject (...) - -
- Signature: serverURL:string -> username:string -> password:string -> id:string -> Project
-
-
- - - - -

Gets informnation about a project from the TeamCity server.

- - - -
- - - getProjects serverURL username password - -
- Signature: serverURL:string -> username:string -> password:string -> seq<string>
-
-
- - - - -

Gets all projects on the TeamCity server.

- - - -
- - - getRESTVersion (...) - -
- Signature: serverURL:string -> username:string -> password:string -> string
-
-
- - - - -

Returns the REST version of the TeamCity server

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-templatehelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-templatehelper.html deleted file mode 100644 index b0f13da..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-templatehelper.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - - TemplateHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

TemplateHelper

-
-

Contains basic templating functions. Used in other helpers.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - loadTemplates seq - -
- Signature: seq:seq<string> -> seq<string * seq<string>>
-
-
- - - - -

Loads all templates (lazy - line by line!)

- - - -
- - - processTemplates replacements files - -
- Signature: replacements:seq<string * string> -> files:seq<string> -> unit
-
-
- - - - -

Replaces the templates with the given replacements

- - - -
- - - replaceKeywords replacements - -
- Signature: replacements:seq<string * string> -> seq<'?8145 * '?8146> -> seq<'?8145 * seq<string>>
- Type parameters: '?8145, '?8146
-
- - - - -

Replaces a bunch of the keywords in all files (lazy - line by line!)

- - - -
- - - saveFiles - -
- Signature: seq<string * seq<string>> -> unit
-
-
- - - - -

Saves all files (lazy - file by file!)

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-testflighthelper-testflightparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-testflighthelper-testflightparams.html deleted file mode 100644 index 9bad087..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-testflighthelper-testflightparams.html +++ /dev/null @@ -1,278 +0,0 @@ - - - - - TestFlightParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

TestFlightParams

-
-

The TestFlight parameter type.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ApiToken - -
- Signature: string
-
-
- - - - -

(Required) API token from testflightapp.com/account/#api

- - - -
- - - DistributionLists - -
- Signature: string list
-
-
- - - - -

Distribution list names which will receive access to the build

- - - -
- - - DSym - -
- Signature: string option
-
-
- - - - -

iOS ONLY - the .dSYM corresponding to the build

- - - -
- - - File - -
- Signature: string
-
-
- - - - -

(Required) file data for the build (.ipa or .apk)

- - - -
- - - Notes - -
- Signature: string option
-
-
- - - - -

Release notes for the build

- - - -
- - - Notify - -
- Signature: bool
-
-
- - - - -

Notify permitted teammates to install the build

- - - -
- - - Replace - -
- Signature: bool
-
-
- - - - -

Replace binary for an existing build if one is found with the same name/bundle version

- - - -
- - - TeamToken - -
- Signature: string
-
-
- - - - -

(Required) Team token from testflightapp.com/dashboard/team/edit

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-testflighthelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-testflighthelper.html deleted file mode 100644 index de7bcc5..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-testflighthelper.html +++ /dev/null @@ -1,181 +0,0 @@ - - - - - TestFlightHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

TestFlightHelper

-
-

Contains tasks to upload apps to TestFlight

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- TestFlightParams -

The TestFlight parameter type.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - TestFlight setParams - -
- Signature: setParams:(TestFlightParams -> TestFlightParams) -> unit
-
-
- - - - -

Uploads the app build to TestFlight.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default TestFlightParams value.
  • -
- - - -
- - - TestFlightDefaults - -
- Signature: TestFlightParams
-
-
- - - - -

The default TestFlight upload parameters.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-testing-xunit-xunitparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-testing-xunit-xunitparams.html deleted file mode 100644 index b0f2654..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-testing-xunit-xunitparams.html +++ /dev/null @@ -1,362 +0,0 @@ - - - - - XUnitParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

XUnitParams

-
-

The xUnit parameter type.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ErrorLevel - -
- Signature: TestRunnerErrorLevel
-
-
- - - - -

Test runner error level.

- - - -
- - - ExcludeTraits - -
- Signature: (string * string) list
-
-
- - - - -

List of traits to exclude.

- - - -
- - - ForceTeamCity - -
- Signature: bool
-
-
- - - - -

Forces TeamCity mode (normally auto-detected)

- - - -
- - - HtmlOutputPath - -
- Signature: string option
-
-
- - - - -

The output path of the xUnit HTML report.

- - - -
- - - IncludeTraits - -
- Signature: (string * string) list
-
-
- - - - -

List of traits to include.

- - - -
- - - NUnitXmlOutputPath - -
- Signature: string option
-
-
- - - - -

The output path of the xUnit XML report (in the NUnit style).

- - - -
- - - ShadowCopy - -
- Signature: bool
-
-
- - - - -

Run xUnit with shadow copy enabled.

- - - -
- - - Silent - -
- Signature: bool
-
-
- - - - -

Run xUnit without reporting test progress.

- - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - -

Maximum time to allow xUnit to run before being killed.

- - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - -

The path to the xUnit console runner: xunit.console.clr4.exe

- - - -
- - - WorkingDir - -
- Signature: string option
-
-
- - - - -

The working directory for running the xunit console rnner.

- - - -
- - - XmlOutputPath - -
- Signature: string option
-
-
- - - - -

The output path of the xUnit XML report.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-testing-xunit.html b/packages/FAKE.4.11.3/docs/apidocs/fake-testing-xunit.html deleted file mode 100644 index 06e09e4..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-testing-xunit.html +++ /dev/null @@ -1,270 +0,0 @@ - - - - - XUnit - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

XUnit

-
-

Contains tasks to run xUnit v1 unit tests.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- XUnitParams -

The xUnit parameter type.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - xUnit setParams assemblies - -
- Signature: setParams:(XUnitParams -> XUnitParams) -> assemblies:seq<string> -> unit
-
-
- - - - -

Runs xUnit unit tests in the given assemblies via the given xUnit runner. -Will fail if the runner terminates with non-zero exit code for any of the assemblies.

- -

The xUnit runner terminates with a non-zero exit code if any of the tests -in the given assembly fail.

- -

This task runs xUnit once per assembly specified, prepending the assembly file name to -the output report filenames to ensure that there is a unique report file for each -assembly tested.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default XUnitParams value.
  • -
  • assemblies - Sequence of one or more assemblies containing xUnit unit tests.
  • -
- -

Sample usage

- -

The sample below will generate HTML reports in testDir with names following the -pattern xUnit.Test.Example.dll.html.

- - - - -
1: 
-2: 
-3: 
-4: 
-
Target "Test" (fun _ ->
-    !! (testDir @@ "xUnit.Test.*.dll")
-      |> xUnit (fun p -> {p with HtmlOutputPath = testDir @@ "html"})
-)
-
- - - -
- - - XUnitDefaults - -
- Signature: XUnitParams
-
-
- - - - -

The xUnit default parameters.

- -

Defaults

- -
    -
  • HtmlOutputPath - None
  • -
  • XmlOutputPath - None
  • -
  • NUnitXmlOutputPath - None
  • -
  • IncludeTraits - []
  • -
  • ExcludeTraits - []
  • -
  • ShadowCopy - true
  • -
  • ErrorLevel - Error
  • -
  • ToolPath - The xunit.console.clr4.exe path if it exists in a subdirectory of the current directory.
  • -
  • WorkingDir - None
  • -
  • TimeOut - 5 minutes
  • -
  • ForceTeamCity - false
  • -
  • Silent - false
  • -
- - - -
- - - xUnitSingle setParams assembly - -
- Signature: setParams:(XUnitParams -> XUnitParams) -> assembly:string -> unit
-
-
- - - - -

Runs xUnit unit tests in the given assemblies via the given xUnit runner. -Will fail if the runner terminates with non-zero exit code for any of the assemblies.

- -

The xUnit runner terminates with a non-zero exit code if any of the tests -in the given assembly fail.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default XUnitParams value.
  • -
  • assemblies - Sequence of one or more assemblies containing xUnit unit tests.
  • -
- -

Sample usage

- - - - -
1: 
-2: 
-3: 
-
Target "Test" (fun _ ->
-    xUnit (fun p -> {p with HtmlOutputPath = testDir @@ "xunit.html"}) "xUnit.Test.dll"
-)
-
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-testing-xunit2-collectionconcurrencymode.html b/packages/FAKE.4.11.3/docs/apidocs/fake-testing-xunit2-collectionconcurrencymode.html deleted file mode 100644 index 405cb19..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-testing-xunit2-collectionconcurrencymode.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - CollectionConcurrencyMode - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

CollectionConcurrencyMode

-
-

The collection concurrency mode used by the xUnit2 runner.

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - Default - -
- Signature:
-
-
- - - - -

Uses the default concurrency mode for collections.

- - - -
- - - MaxThreads(count) - -
- Signature: int
-
-
- - - - -

Limits the number of concurrently executing collections to count.

- - - -
- - - Unlimited - -
- Signature:
-
-
- - - - -

Does not limit the number of concurrently executing collections.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-testing-xunit2-parallelmode.html b/packages/FAKE.4.11.3/docs/apidocs/fake-testing-xunit2-parallelmode.html deleted file mode 100644 index 684b4fd..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-testing-xunit2-parallelmode.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - ParallelMode - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ParallelMode

-
-

The parallelization mode of the xUnit2 runner.

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - All - -
- Signature:
-
-
- - - - -

Parallelize assemblies and collections.

- - - -
- - - Assemblies - -
- Signature:
-
-
- - - - -

Only parallelize assemblies.

- - - -
- - - Collections - -
- Signature:
-
-
- - - - -

Only parallelize collections.

- - - -
- - - NoParallelization - -
- Signature:
-
-
- - - - -

Turn off all parallelization.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-testing-xunit2-xunit2params.html b/packages/FAKE.4.11.3/docs/apidocs/fake-testing-xunit2-xunit2params.html deleted file mode 100644 index e77b6c2..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-testing-xunit2-xunit2params.html +++ /dev/null @@ -1,488 +0,0 @@ - - - - - XUnit2Params - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

XUnit2Params

-
-

The xUnit2 parameter type.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ErrorLevel - -
- Signature: TestRunnerErrorLevel
-
-
- - - - -

Test runner error level.

- - - -
- - - ExcludeTraits - -
- Signature: (string * string) list
-
-
- - - - -

List of traits to exclude.

- - - -
- - - ForceAppVeyor - -
- Signature: bool
-
-
- - - - -

Forces AppVeyor CI mode (normally auto-detected).

- - - -
- - - ForceTeamCity - -
- Signature: bool
-
-
- - - - -

Forces TeamCity mode (normally auto-detected).

- - - -
- - - HtmlOutputPath - -
- Signature: string option
-
-
- - - - -

The output path of the xUnit HTML report.

- - - -
- - - IncludeTraits - -
- Signature: (string * string) list
-
-
- - - - -

List of traits to include.

- - - -
- - - MaxThreads - -
- Signature: CollectionConcurrencyMode
-
-
- - - - -

The xUnit thread limiting strategy.

- - - -
- - - NoAppDomain - -
- Signature: bool
-
-
- - - - -

Do not use app domains to run test code.

- - - -
- - - NUnitXmlOutputPath - -
- Signature: string option
-
-
- - - - -

The output path of the NUnit XML report.

- - - -
- - - Parallel - -
- Signature: ParallelMode
-
-
- - - - -

The xUnit parallelization mode.

- - - -
- - - ShadowCopy - -
- Signature: bool
-
-
- - - - -

Run xUnit with shadow copy enabled.

- - - -
- - - Silent - -
- Signature: bool
-
-
- - - - -

Run xUnit without reporting test progress.

- - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - -

Maximum time to allow xUnit to run before being killed.

- - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - -

The path to the xUnit console runner: xunit.console.exe

- - - -
- - - Wait - -
- Signature: bool
-
-
- - - - -

Waits for input after completion.

- - - -
- - - WorkingDir - -
- Signature: string option
-
-
- - - - -

The working directory for running the xunit console runner.

- - - -
- - - XmlOutputPath - -
- Signature: string option
-
-
- - - - -

The output path of the xUnit XML report.

- - - -
- - - XmlV1OutputPath - -
- Signature: string option
-
-
- - - - -

The output path of the xUnit XML report (in the xUnit v1 style).

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-testing-xunit2.html b/packages/FAKE.4.11.3/docs/apidocs/fake-testing-xunit2.html deleted file mode 100644 index 7d9ca29..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-testing-xunit2.html +++ /dev/null @@ -1,260 +0,0 @@ - - - - - XUnit2 - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

XUnit2

-
-

Contains tasks to run xUnit v2 unit tests.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - -
TypeDescription
- CollectionConcurrencyMode -

The collection concurrency mode used by the xUnit2 runner.

- - -
- ParallelMode -

The parallelization mode of the xUnit2 runner.

- - -
- XUnit2Params -

The xUnit2 parameter type.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - buildXUnit2Args assemblies parameters - -
- Signature: assemblies:seq<string> -> parameters:XUnit2Params -> string
-
-
- - - - - -
- - - xUnit2 setParams assemblies - -
- Signature: setParams:(XUnit2Params -> XUnit2Params) -> assemblies:seq<string> -> unit
-
-
- - - - -

Runs xUnit v2 unit tests in the given assemblies via the given xUnit2 runner. -Will fail if the runner terminates with non-zero exit code.

- -

The xUnit2 runner terminates with a non-zero exit code if any of the tests -in the given assembly fail.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default XUnit2Params value.
  • -
  • assemblies - Sequence of one or more assemblies containing xUnit unit tests.
  • -
- -

Sample usage

- - - - -
1: 
-2: 
-3: 
-4: 
-
Target "Test" (fun _ ->
-    !! (testDir @@ "xUnit.Test.*.dll")
-    |> xUnit2 (fun p -> { p with HtmlOutputPath = Some (testDir @@ "xunit.html") })
-)
-
- -
union case Option.Some: Value: 'T -> Option<'T>
- - -
- - - XUnit2Defaults - -
- Signature: XUnit2Params
-
-
- - - - -

The xUnit2 default parameters.

- -

Defaults

- -
    -
  • NoAppDomain - false
  • -
  • Parallel - NoParallelization
  • -
  • MaxThreads - Default
  • -
  • HtmlOutputPath - None
  • -
  • XmlOutputPath - None
  • -
  • XmlV1OutputPath - None
  • -
  • IncludeTraits - []
  • -
  • ExcludeTraits - []
  • -
  • ShadowCopy - true
  • -
  • ErrorLevel - Error
  • -
  • ToolPath - The xunit.console.exe path if it exists in a subdirectory of the current directory.
  • -
  • WorkingDir - None
  • -
  • TimeOut - 5 minutes
  • -
  • ForceTeamCity - false
  • -
  • ForceAppVeyor - false
  • -
  • Silent - false
  • -
  • Wait - false
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-tracehelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-tracehelper.html deleted file mode 100644 index 36e539a..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-tracehelper.html +++ /dev/null @@ -1,737 +0,0 @@ - - - - - TraceHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

TraceHelper

-
-

This module contains function which allow to trace build output

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - closeAllOpenTags () - -
- Signature: unit -> unit
-
-
- - - - - -
- - - closeTag tag - -
- Signature: tag:string -> unit
-
-
- - - - -

Removes an opening tag from the internal tag stack

- - - -
- - - console - -
- Signature: ITraceListener
-
-
- - - - - -
- - - fakePath - -
- Signature: string
-
-
- - - - -

Gets the path of the current FAKE instance

- - - -
- - - fakeVersion - -
- Signature: string
-
-
- - - - -

Gets the FAKE version no.

- - - -
- - - fakeVersionStr - -
- Signature: string
-
-
- - - - -

Gets the FAKE Version string

- - - -
- - - log message - -
- Signature: message:string -> unit
-
-
- - - - -

Logs the specified string

- - - -
- - - Log message files - -
- Signature: message:string -> files:seq<string> -> unit
-
-
- - - - -

Logs the given files with the message.

- - - -
- - - logf fmt - -
- Signature: fmt:StringFormat<'?8023,unit> -> '?8023
- Type parameters: '?8023
-
- - - - -

Logs the specified message (without line break)

- - - -
- - - logfn fmt - -
- Signature: fmt:StringFormat<'?8021,unit> -> '?8021
- Type parameters: '?8021
-
- - - - -

Logs the specified message

- - - -
- - - logToConsole (msg, eventLogEntry) - -
- Signature: (msg:string * eventLogEntry:EventLogEntryType) -> unit
-
-
- - - - -

Traces the message to the console

- - - -
- - - logVerbosefn fmt - -
- Signature: fmt:StringFormat<'?8025,unit> -> '?8025
- Type parameters: '?8025
-
- - - - -

Logs the specified string if the verbose mode is activated.

- - - -
- - - openTag tag - -
- Signature: tag:string -> unit
-
-
- - - - -

Puts an opening tag on the internal tag stack

- - - -
- - - trace message - -
- Signature: message:string -> unit
-
-
- - - - -

Writes a trace to the command line (in green)

- - - -
- - - traceEndBuild () - -
- Signature: unit -> unit
-
-
- - - - -

Traces the end of the build

- - - -
- - - traceEndTarget name - -
- Signature: name:string -> unit
-
-
- - - - -

Traces the end of a target

- - - -
- - - traceEndTask task description - -
- Signature: task:string -> description:string -> unit
-
-
- - - - -

Traces the end of a task

- - - -
- - - TraceEnvironmentVariables () - -
- Signature: unit -> unit
-
-
- - - - -

Traces the EnvironmentVariables

- - - -
- - - traceError error - -
- Signature: error:string -> unit
-
-
- - - - -

Traces an error (in red)

- - - -
- - - traceException ex - -
- Signature: ex:Exception -> unit
-
-
- - - - -

Traces an exception details (in red)

- - - -
- - - tracef fmt - -
- Signature: fmt:StringFormat<'?8030,unit> -> '?8030
- Type parameters: '?8030
-
- - - - -

Writes a message to the command line (in green) and without a line break

- - - -
- - - traceFAKE fmt - -
- Signature: fmt:StringFormat<'?8034,unit> -> '?8034
- Type parameters: '?8034
-
- - - - -

Writes a trace to the command line (in yellow)

- - - -
- - - tracefn fmt - -
- Signature: fmt:StringFormat<'?8028,unit> -> '?8028
- Type parameters: '?8028
-
- - - - -

Writes a message to the command line (in green)

- - - -
- - - traceHeader name - -
- Signature: name:string -> unit
-
-
- - - - -

Traces a header

- - - -
- - - traceImportant text - -
- Signature: text:string -> unit
-
-
- - - - -

Writes a trace to stderr (in yellow)

- - - -
- - - traceLine () - -
- Signature: unit -> unit
-
-
- - - - -

Traces a line

- - - -
- - - traceStartBuild () - -
- Signature: unit -> unit
-
-
- - - - -

Traces the begin of the build

- - - -
- - - traceStartTarget (...) - -
- Signature: name:string -> description:string -> dependencyString:string -> unit
-
-
- - - - -

Traces the begin of a target

- - - -
- - - traceStartTask task description - -
- Signature: task:string -> description:string -> unit
-
-
- - - - -

Traces the begin of a task

- - - -
- - - traceVerbose s - -
- Signature: s:string -> unit
-
-
- - - - -

Writes a trace to the command line (in green) if the verbose mode is activated.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-tracelistener-consoletracelistener.html b/packages/FAKE.4.11.3/docs/apidocs/fake-tracelistener-consoletracelistener.html deleted file mode 100644 index 12ca08f..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-tracelistener-consoletracelistener.html +++ /dev/null @@ -1,135 +0,0 @@ - - - - - ConsoleTraceListener - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ConsoleTraceListener

-
-

Implements a TraceListener for System.Console.

- - -

Parameters

-
    -
  • importantMessagesToStdErr - Defines whether to trace important messages to StdErr.
  • -
  • colorMap - A function which maps TracePriorities to ConsoleColors.
  • -
- - -
-

Constructors

- - - - - - - - - - -
ConstructorDescription
- - - new(importantMessagesToStdErr, colorMap) - -
- Signature: (importantMessagesToStdErr:bool * colorMap:(TraceData -> ConsoleColor)) -> ConsoleTraceListener
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-tracelistener-itracelistener.html b/packages/FAKE.4.11.3/docs/apidocs/fake-tracelistener-itracelistener.html deleted file mode 100644 index 92aedab..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-tracelistener-itracelistener.html +++ /dev/null @@ -1,129 +0,0 @@ - - - - - ITraceListener - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-tracelistener-nantxmltracelistener.html b/packages/FAKE.4.11.3/docs/apidocs/fake-tracelistener-nantxmltracelistener.html deleted file mode 100644 index f6b5f26..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-tracelistener-nantxmltracelistener.html +++ /dev/null @@ -1,134 +0,0 @@ - - - - - NAntXmlTraceListener - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

NAntXmlTraceListener

-
-

Implements a TraceListener which writes NAnt like XML files.

- - -

Parameters

-
    -
  • xmlOutputFile - Defines the xml output file.
  • -
- - -
-

Constructors

- - - - - - - - - - -
ConstructorDescription
- - - new(xmlOutputFile) - -
- Signature: xmlOutputFile:string -> NAntXmlTraceListener
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-tracelistener-tracedata.html b/packages/FAKE.4.11.3/docs/apidocs/fake-tracelistener-tracedata.html deleted file mode 100644 index 0f4bd79..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-tracelistener-tracedata.html +++ /dev/null @@ -1,254 +0,0 @@ - - - - - TraceData - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

TraceData

-
-

Defines Tracing information for TraceListeners

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - CloseTag(string) - -
- Signature: string
-
-
- - - - - -
- - - ErrorMessage(string) - -
- Signature: string
-
-
- - - - - -
- - - FinishedMessage - -
- Signature:
-
-
- - - - - -
- - - ImportantMessage(string) - -
- Signature: string
-
-
- - - - - -
- - - LogMessage(string,bool) - -
- Signature: string * bool
-
-
- - - - - -
- - - OpenTag(string,string) - -
- Signature: string * string
-
-
- - - - - -
- - - StartMessage - -
- Signature:
-
-
- - - - - -
- - - TraceMessage(string,bool) - -
- Signature: string * bool
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-tracelistener.html b/packages/FAKE.4.11.3/docs/apidocs/fake-tracelistener.html deleted file mode 100644 index ffbf9ca..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-tracelistener.html +++ /dev/null @@ -1,286 +0,0 @@ - - - - - TraceListener - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

TraceListener

-
-

Defines default listeners for build output traces

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- ConsoleTraceListener -

Implements a TraceListener for System.Console.

- - -
- ITraceListener -

Defines a TraceListener interface

- - -
- NAntXmlTraceListener -

Implements a TraceListener which writes NAnt like XML files.

- - -
- TraceData -

Defines Tracing information for TraceListeners

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - addXmlListener xmlOutputFile - -
- Signature: xmlOutputFile:string -> unit
-
-
- - - - -

Allows to register a new Xml listeners

- - - -
- - - AutoCloseXmlWriter - -
- Signature: bool
-
-
- - - - -

Specifies if the XmlWriter should close tags automatically

- - - -
- - - colorMap traceData - -
- Signature: traceData:TraceData -> ConsoleColor
-
-
- - - - -

A default color map which maps TracePriorities to ConsoleColors

- - - -
- - - defaultConsoleTraceListener - -
- Signature: ConsoleTraceListener
-
-
- - - - -

The default TraceListener for Console.

- - - -
- - - listeners - -
- Signature: List<ITraceListener>
-
-
- - - - -

A List with all registered listeners

- - - -
- - - postMessage x - -
- Signature: x:TraceData -> unit
-
-
- - - - -

Allows to post messages to all trace listeners

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-typescript-ecmascript.html b/packages/FAKE.4.11.3/docs/apidocs/fake-typescript-ecmascript.html deleted file mode 100644 index 4f44035..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-typescript-ecmascript.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - ECMAScript - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-typescript-modulegeneration.html b/packages/FAKE.4.11.3/docs/apidocs/fake-typescript-modulegeneration.html deleted file mode 100644 index ecbd671..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-typescript-modulegeneration.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - ModuleGeneration - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-typescript-typescriptparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-typescript-typescriptparams.html deleted file mode 100644 index 8009e95..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-typescript-typescriptparams.html +++ /dev/null @@ -1,341 +0,0 @@ - - - - - TypeScriptParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

TypeScriptParams

-
-

TypeScript task parameter type

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ECMAScript - -
- Signature: ECMAScript
-
-
- - - - -

Specifies which ECMAScript version the TypeScript compiler should generate. Default is ES3.

- - - -
- - - EmitComments - -
- Signature: bool
-
-
- - - - -

Specifies if the TypeScript compiler should generate comments. Default is false.

- - - -
- - - EmitDeclarations - -
- Signature: bool
-
-
- - - - -

Specifies if the TypeScript compiler should generate declarations. Default is false.

- - - -
- - - EmitSourceMaps - -
- Signature: bool
-
-
- - - - -

Specifies if the TypeScript compiler should emit source maps. Default is false.

- - - -
- - - ModuleGeneration - -
- Signature: ModuleGeneration
-
-
- - - - -

Specifies which JavaScript module type the TypeScript compiler should generate. Default is CommonJs.

- - - -
- - - NoLib - -
- Signature: bool
-
-
- - - - -

Specifies if the TypeScript compiler should not use libs. Default is false.

- - - -
- - - OutputPath - -
- Signature: string
-
-
- - - - -

Specifies the TypeScript compiler output path.

- - - -
- - - OutputSingleFile - -
- Signature: string option
-
-
- - - - -

Specifies if the TypeScript compiler should generate a single output file and its filename.

- - - -
- - - RemoveComments - -
- Signature: bool
-
-
- - - - -

Specifies if the TypeScript compiler should remove comments. Default is false.

- - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - -

Specifies the timeout for the TypeScript compiler.

- - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - -

Specifies the TypeScript compiler path.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-typescript.html b/packages/FAKE.4.11.3/docs/apidocs/fake-typescript.html deleted file mode 100644 index d8c487c..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-typescript.html +++ /dev/null @@ -1,212 +0,0 @@ - - - - - TypeScript - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

TypeScript

-
-

Contains code to call the typescript compiler. There is also a tutorial for this task available.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - -
TypeDescription
- ECMAScript -

Generated ECMAScript version

- - -
- ModuleGeneration -

Generated JavaScript module type

- - -
- TypeScriptParams -

TypeScript task parameter type

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - TypeScriptCompiler setParams files - -
- Signature: setParams:(TypeScriptParams -> TypeScriptParams) -> files:seq<string> -> unit
-
-
- - - - -

This task to can be used to call the TypeScript compiler. -There is also a tutorial for this task available.

- -

Parameters

- -
    -
  • setParams - Function used to overwrite the TypeScript compiler flags.
  • -
  • files - The type script files to compile.
  • -
- -

Sample

- - - - -
1: 
-2: 
-
    !! "src/**/*.ts"
-        |> TypeScriptCompiler (fun p -> { p with TimeOut = TimeSpan.MaxValue }) 
-
- - - -
- - - TypeScriptDefaultParams - -
- Signature: TypeScriptParams
-
-
- - - - -

Default parameters for the TypeScript task

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-unittestcommon-failedtestsexception.html b/packages/FAKE.4.11.3/docs/apidocs/fake-unittestcommon-failedtestsexception.html deleted file mode 100644 index 3e3d8c4..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-unittestcommon-failedtestsexception.html +++ /dev/null @@ -1,125 +0,0 @@ - - - - - FailedTestsException - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-unittestcommon-testrunnererrorlevel.html b/packages/FAKE.4.11.3/docs/apidocs/fake-unittestcommon-testrunnererrorlevel.html deleted file mode 100644 index 17acdd7..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-unittestcommon-testrunnererrorlevel.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - TestRunnerErrorLevel - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

TestRunnerErrorLevel

-
-

Option which allows to specify if a test runner error should break the build.

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - DontFailBuild - -
- Signature:
-
-
- - - - -

With this option set, no exception is thrown if a test is broken.

- - - -
- - - Error - -
- Signature:
-
-
- - - - -

This option instructs FAKE to break the build if a test runner reports an error.

- - - -
- - - FailOnFirstError - -
- Signature:
-
-
- - - - -

This option instructs FAKE to break the build if a test runner finds the first error.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-unittestcommon.html b/packages/FAKE.4.11.3/docs/apidocs/fake-unittestcommon.html deleted file mode 100644 index b823591..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-unittestcommon.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - UnitTestCommon - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

UnitTestCommon

-
-

This module contains types and functions that are common for unit test helpers.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - -
TypeDescription
- FailedTestsException -
- TestRunnerErrorLevel -

Option which allows to specify if a test runner error should break the build.

- - -
- -
- - -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-unittesthelper-test.html b/packages/FAKE.4.11.3/docs/apidocs/fake-unittesthelper-test.html deleted file mode 100644 index 72a1547..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-unittesthelper-test.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - Test - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Test

-
-

Basic data type to represent tests

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Name - -
- Signature: string
-
-
- - - - - -
- - - RunTime - -
- Signature: TimeSpan
-
-
- - - - - -
- - - Status - -
- Signature: TestStatus
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-unittesthelper-testresults.html b/packages/FAKE.4.11.3/docs/apidocs/fake-unittesthelper-testresults.html deleted file mode 100644 index e302a6c..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-unittesthelper-testresults.html +++ /dev/null @@ -1,190 +0,0 @@ - - - - - TestResults - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

TestResults

-
-

Basic data type to represent test results

- - -
-

Record Fields

- - - - - - - - - - - - - - -
Record FieldDescription
- - - SuiteName - -
- Signature: string
-
-
- - - - - -
- - - Tests - -
- Signature: Test list
-
-
- - - - - -
-

Instance members

- - - - - - - - - - - - - - -
Instance memberDescription
- - - GetFailed() - -
- Signature: unit -> Test list
-
-
- - - - - -
- - - GetTestCount() - -
- Signature: unit -> int
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-unittesthelper-teststatus.html b/packages/FAKE.4.11.3/docs/apidocs/fake-unittesthelper-teststatus.html deleted file mode 100644 index c2c5137..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-unittesthelper-teststatus.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - TestStatus - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

TestStatus

-
-

Basic data type to represent test status

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - Failure(string,string) - -
- Signature: string * string
-
-
- - - - - -
- - - Ignored(string,string) - -
- Signature: string * string
-
-
- - - - - -
- - - Ok - -
- Signature:
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-unittesthelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-unittesthelper.html deleted file mode 100644 index d350f91..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-unittesthelper.html +++ /dev/null @@ -1,214 +0,0 @@ - - - - - UnitTestHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

UnitTestHelper

-
-

This module contains functions which allow to report unit test results to build servers.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - -
TypeDescription
- Test -

Basic data type to represent tests

- - -
- TestResults -

Basic data type to represent test results

- - -
- TestStatus -

Basic data type to represent test status

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - reportTestResults testResults - -
- Signature: testResults:TestResults -> unit
-
-
- - - - -

Reports the given test results to the detected build server

- - - -
- - - reportToAppVeyor testResults - -
- Signature: testResults:TestResults -> unit
-
-
- - - - -

Reports the given test results to AppVeyor.

- - - -
- - - reportToTeamCity testResults - -
- Signature: testResults:TestResults -> unit
-
-
- - - - -

Reports the given test results to TeamCity.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-userinputhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-userinputhelper.html deleted file mode 100644 index 38c5c6a..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-userinputhelper.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - UserInputHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

UserInputHelper

-
-

This module contains functions which allow to interactively input values

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - getUserInput prompt - -
- Signature: prompt:string -> string
-
-
- - - - -

Return a string entered by the user followed by enter. The input is echoed to the screen.

- - - -
- - - getUserPassword prompt - -
- Signature: prompt:string -> string
-
-
- - - - -

Return a string entered by the user followed by enter. The input is replaced by '*' on the screen.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-vb6helper-vb6buildparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-vb6helper-vb6buildparams.html deleted file mode 100644 index 9f25719..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-vb6helper-vb6buildparams.html +++ /dev/null @@ -1,195 +0,0 @@ - - - - - Vb6BuildParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Vb6BuildParams

-
-

Parameters for running a VB6 build

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Logdir - -
- Signature: string
-
-
- - - - -

Directory to put logs and other temporary files -created during the build process

- - - -
- - - Outdir - -
- Signature: string
-
-
- - - - -

Directory to put generated binaries

- - - -
- - - Timeout - -
- Signature: TimeSpan
-
-
- - - - -

Maximum amount of time the entire build is allowed to take

- - - -
- - - Toolpath - -
- Signature: string
-
-
- - - - -

Path to the VB6 executable

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-vb6helper-vb6project.html b/packages/FAKE.4.11.3/docs/apidocs/fake-vb6helper-vb6project.html deleted file mode 100644 index 9f4d471..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-vb6helper-vb6project.html +++ /dev/null @@ -1,198 +0,0 @@ - - - - - Vb6Project - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Vb6Project

-
-

Represents a VB6 project

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - BinaryName - -
- Signature: string
-
-
- - - - -

Name of binary that will -be generated from this project

- - - -
- - - ProjectFile - -
- Signature: string
-
-
- - - - -

Path to the Propject file representing -Representing this project

- - - -
- - - References - -
- Signature: seq<Vb6Reference>
-
-
- - - - -

All references and components used -in this VBV6 project

- - - -
- - - Version - -
- Signature: string
-
-
- - - - -

Version of the project -in Major.Minor.Revision.Patch format

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-vb6helper-vb6reference.html b/packages/FAKE.4.11.3/docs/apidocs/fake-vb6helper-vb6reference.html deleted file mode 100644 index 1306d30..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-vb6helper-vb6reference.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - Vb6Reference - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-vb6helper-vb6referenceversion.html b/packages/FAKE.4.11.3/docs/apidocs/fake-vb6helper-vb6referenceversion.html deleted file mode 100644 index 03c9bd4..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-vb6helper-vb6referenceversion.html +++ /dev/null @@ -1,147 +0,0 @@ - - - - - Vb6ReferenceVersion - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Vb6ReferenceVersion

-
-

Represents the version of a VB6 reference -References from VB6 projects only care about Major.Minor versions

- - -
-

Record Fields

- - - - - - - - - - - - - - -
Record FieldDescription
- - - Major - -
- Signature: int
-
-
- - - - - -
- - - Minor - -
- Signature: int
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-vb6helper-vb6version.html b/packages/FAKE.4.11.3/docs/apidocs/fake-vb6helper-vb6version.html deleted file mode 100644 index a911d42..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-vb6helper-vb6version.html +++ /dev/null @@ -1,183 +0,0 @@ - - - - - Vb6Version - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Vb6Version

-
-

Represents the version of a VB6 project -ToString () will return a Maj.Min.Rev.Patch version string

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - AutoIncrementVer - -
- Signature: int
-
-
- - - - - -
- - - MajorVer - -
- Signature: int
-
-
- - - - - -
- - - MinorVer - -
- Signature: int
-
-
- - - - - -
- - - RevisionVer - -
- Signature: int
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-vb6helper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-vb6helper.html deleted file mode 100644 index c1f6a48..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-vb6helper.html +++ /dev/null @@ -1,380 +0,0 @@ - - - - - Vb6Helper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Vb6Helper

-
-

Enables building of Visual Basic 6 projects -Also includes a do-it-all function that will embed interop -side-by-side manifest to executables from Vb6 using -functions from the Side-by-side helper module

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- Vb6BuildParams -

Parameters for running a VB6 build

- - -
- Vb6Project -

Represents a VB6 project

- - -
- Vb6Reference -

Represents a VB6 Reference

- - -
- Vb6ReferenceVersion -

Represents the version of a VB6 reference -References from VB6 projects only care about Major.Minor versions

- - -
- Vb6Version -

Represents the version of a VB6 project -ToString () will return a Maj.Min.Rev.Patch version string

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - BuildAndEmbedInteropManifests (...) - -
- Signature: getConfig:(Vb6BuildParams -> Vb6BuildParams) -> vb6Projects:seq<string> -> possibleAssemblies:seq<string> -> unit
-
-
- - - - -

All-In-one build and manifest function for VB6 applications referencing .net libraries

- -

Paramteters

- -
    -
  • getConfig- function to alter default VB6 build parameters
  • -
  • vb6Projects - Paths to all .vbp files to build
  • -
  • possibleAssemblies - Paths to assemblies that may be referenced by the VB6 projects
  • -
- -

Process

- -

This function will:

- -
    -
  1. Determine which of the possibleAssemnblies are referenced by any of the provided .vbp files
  2. -
  3. Temporarily register any referenced assemblies using RegAsm /codebase /tlb
  4. -
  5. Run VB6 command line make on all provided .vbp projects
  6. -
  7. Unregister all registered assemblies
  8. -
  9. Generate and embed Side-By-Side interop appplication manifests in all generated VB6 executables
  10. -
  11. Generate and embed Side-By-Side interop assembly manifest in all referenced assemblies
  12. -
- - - -
- - - GetVb6ApplicationProjDetails projects - -
- Signature: projects:seq<string> -> seq<Vb6Project>
-
-
- - - - -

Returns application details for provided .vbp files.

- -

Information returned

- -
    -
  • Name of created binary file
  • -
  • Version as saved in .vbpfile
  • -
  • GUIDs of all referenced libraries and components
  • -
- -

Usage

- -

This is used for creating Side-By-Side interop manifests.

- - - -
- - - RegisterDependenciesForDevelopment (...) - -
- Signature: getConfig:(Vb6BuildParams -> Vb6BuildParams) -> vb6Projects:seq<string> -> possibleAssemblies:seq<string> -> unit
-
-
- - - - -

Determines which of the provided assemblies are referenced by the -provided VB6 projects, and registers them so the VB6 ide can -find them.

- -

Paramteters

- -
    -
  • getConfig- function to alter default VB6 build parameters
  • -
  • vb6Projects - Paths to all .vbp files to build
  • -
  • possibleAssemblies - Paths to assemblies that may be referenced by the VB6 projects
  • -
- - - -
- - - UnRegisterDependenciesForDevelopment (...) - -
- Signature: getConfig:(Vb6BuildParams -> Vb6BuildParams) -> vb6Projects:seq<string> -> possibleAssemblies:seq<string> -> unit
-
-
- - - - -

Determins which of the provided assemblies are referenced by the -provided VB6 projects, and un-registers them

- -

Paramteters

- -
    -
  • getConfig- function to alter default VB6 build parameters
  • -
  • vb6Projects - Paths to all .vbp files to build
  • -
  • possibleAssemblies - Paths to assemblies that may be referenced by the VB6 projects
  • -
- - - -
- - - UpdateDependencyVersions (...) - -
- Signature: getConfig:(Vb6BuildParams -> Vb6BuildParams) -> vb6Projects:seq<string> -> possibleAssemblies:seq<string> -> unit
-
-
- - - - -

Fixes dependency versions in VB6 project files

- -

Paramteters

- -
    -
  • getConfig- function to alter default VB6 build parameters
  • -
  • vb6Projects - Paths to all .vbp to update references in
  • -
  • possibleAssemblies - Paths to assemblies that may be referenced by the VB6 projects
  • -
- -

Running this task will:

- -
    -
  1. In all VB6 projects provided: Get all references that intersects with the provided assemblies arg
  2. -
  3. Check if there is a version difference
  4. -
  5. Update the VB6 project file to reflect the actual version used.
  6. -
- -

Note: Vb6 Reference versions are hex numbers not decimals like .net verions. This task handles - this difference automatically.

- - - -
- - - Vb6Make getConfig vb6Projects - -
- Signature: getConfig:(Vb6BuildParams -> Vb6BuildParams) -> vb6Projects:seq<string> -> unit
-
-
- - - - -

Executes a VB6 command line make on all provided VB6 projects

- -

Builds will be executed in paralell

- -

Parameters

- -
    -
  • getConfig - function to modify the build params record from default values
  • -
  • vb6Projects- Seq of paths to .vbp files to build
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-versionhelper-verinfo.html b/packages/FAKE.4.11.3/docs/apidocs/fake-versionhelper-verinfo.html deleted file mode 100644 index 95c5f9b..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-versionhelper-verinfo.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - VerInfo - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

VerInfo

-
-

Contains the version information.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Major - -
- Signature: int
-
-
- - - - -

MAJOR version when you make incompatible API changes.

- - - -
- - - Minor - -
- Signature: int
-
-
- - - - -

MINOR version when you add functionality in a backwards-compatible manner.

- - - -
- - - Patch - -
- Signature: int
-
-
- - - - -

PATCH version when you make backwards-compatible bug fixes.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-versionhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-versionhelper.html deleted file mode 100644 index 846d122..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-versionhelper.html +++ /dev/null @@ -1,202 +0,0 @@ - - - - - VersionHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

VersionHelper

-
-
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- VerInfo -

Contains the version information.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - GetAssemblyVersion assemblyFile - -
- Signature: assemblyFile:string -> Version
-
-
- - - - -

Gets file assembly version.

- -

Parameters

- -
    -
  • assemblyFile - The assembly file path.
  • -
- - - -
- - - GetAssemblyVersionString assemblyFile - -
- Signature: assemblyFile:string -> string
-
-
- - - - -

Gets file assembly version in form of major.minor.build.revision.

- -

Parameters

- -
    -
  • assemblyFile - The assembly file path.
  • -
- - - -
- - - parseVersion version - -
- Signature: version:string -> VerInfo
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-vsshelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-vsshelper.html deleted file mode 100644 index c147669..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-vsshelper.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - VSSHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

VSSHelper

-
-

Contains helper functions for Microsoft Visual SourceSafe

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - getVSSProject (...) - -
- Signature: toolPath:string -> srcSafeIni:string -> username:string -> password:string -> project:string -> localSpec:string -> unit
-
-
- - - - -

Retrieves the given project from Microsoft Visual SourceSafe

- - - -
- - - getVSSProjectWithLabel (...) - -
- Signature: toolPath:string -> srcSafeIni:string -> username:string -> password:string -> project:string -> localSpec:string -> label:string -> unit
-
-
- - - - -

Retrieves the given label of the given project from Microsoft Visual SourceSafe

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-vstest-errorlevel.html b/packages/FAKE.4.11.3/docs/apidocs/fake-vstest-errorlevel.html deleted file mode 100644 index b13482c..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-vstest-errorlevel.html +++ /dev/null @@ -1,102 +0,0 @@ - - - - - ErrorLevel - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-vstest-vstestparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-vstest-vstestparams.html deleted file mode 100644 index 4dccbeb..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-vstest-vstestparams.html +++ /dev/null @@ -1,509 +0,0 @@ - - - - - VSTestParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

VSTestParams

-
-

Parameter type to configure VSTest.Console.exe

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - EnableCodeCoverage - -
- Signature: bool
-
-
- - - - -

Enables code coverage collection (optional).

- - - -
- - - ErrorLevel - -
- Signature: ErrorLevel
-
-
- - - - -

Error level for controlling how VSTest failures should break the build (optional).

- - - -
- - - Framework - -
- Signature: string
-
-
- - - - -

Target .NET framework version to use for test execution (optional).

- - - -
- - - InIsolation - -
- Signature: bool
-
-
- - - - -

Run the tests in an isolated process (optional).

- - - -
- - - ListDiscoverers - -
- Signature: bool
-
-
- - - - -

List installed test discoverers (optional).

- - - -
- - - ListExecutors - -
- Signature: bool
-
-
- - - - -

List installed test executors (optional).

- - - -
- - - ListLoggers - -
- Signature: bool
-
-
- - - - -

List installed loggers (optional).

- - - -
- - - ListSettingsProviders - -
- Signature: bool
-
-
- - - - -

List installed settings providers (optional).

- - - -
- - - ListTestsPath - -
- Signature: string
-
-
- - - - -

List discovered tests from the given container path (optional).

- - - -
- - - Logger - -
- Signature: string
-
-
- - - - -

The logger to use for test results (optional).

- - - -
- - - Platform - -
- Signature: string
-
-
- - - - -

Target platform architecture for test execution (optional). Valid options include "x86", "x64" and "ARM".

- - - -
- - - SettingsPath - -
- Signature: string
-
-
- - - - -

Path to the run settings file to run tests with additional settings such as data collectors (optional).

- - - -
- - - TestAdapterPath - -
- Signature: string
-
-
- - - - -

Path to test adapter e.g. xUnit (optional)

- - - -
- - - TestCaseFilter - -
- Signature: string
-
-
- - - - -

Run tests that match the given expression (optional). Cannot be used with the Tests argument

- - - -
- - - Tests - -
- Signature: seq<string>
-
-
- - - - -

Names of the tests that should be run (optional).

- - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - -

A timeout for the test runner (optional).

- - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - -

Path to VSTest.Console.exe (optional). By default the default install location is searched.

- - - -
- - - UseVsixExtensions - -
- Signature: bool
-
-
- - - - -

Use installed VSIX extensions in VSTest (optional).

- - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - -

Working directory (optional).

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-vstest.html b/packages/FAKE.4.11.3/docs/apidocs/fake-vstest.html deleted file mode 100644 index 08aaec4..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-vstest.html +++ /dev/null @@ -1,206 +0,0 @@ - - - - - VSTest - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

VSTest

-
-

Contains tasks to run VSTest unit tests.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - -
TypeDescription
- ErrorLevel -

Option which allow to specify if a VSTest error should break the build.

- - -
- VSTestParams -

Parameter type to configure VSTest.Console.exe

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - -
Function or valueDescription
- - - VSTest setParams assemblies - -
- Signature: setParams:(VSTestParams -> VSTestParams) -> assemblies:seq<string> -> unit
-
-
- - - - -

Runs VSTest command line tool (VSTest.Console.exe) on a group of assemblies.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default VSTestParams values.
  • -
  • assemblies - Sequence of one or more assemblies containing Microsoft Visual Studio Unit Test Framework unit tests.
  • -
- -

Sample usage

- - - - -
1: 
-2: 
-3: 
-4: 
-
Target "Test" (fun _ ->
-    !! (testDir + @"\*.Tests.dll") 
-      |> VSTest (fun p -> { p with SettingsPath = "Local.RunSettings" })
-)
-
- - - -
- - - VSTestDefaults - -
- Signature: VSTestParams
-
-
- - - - -

VSTest default parameters.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-actionexecutionverb.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-actionexecutionverb.html deleted file mode 100644 index f4359af..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-actionexecutionverb.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - ActionExecutionVerb - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ActionExecutionVerb

-
-

Used for specifying the point of time for action execution in WiXCustomActionExecution

- - -
-

Union Cases

- - - - - - - - - - - - - - -
Union CaseDescription
- - - After - -
- Signature:
-
-
- - - - -

Specifies that action should be executed after some standard or custom action

- - - -
- - - Before - -
- Signature:
-
-
- - - - -

Specifies that action should be executed before some standard or custom action

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-customactionexecute.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-customactionexecute.html deleted file mode 100644 index 85578b3..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-customactionexecute.html +++ /dev/null @@ -1,257 +0,0 @@ - - - - - CustomActionExecute - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

CustomActionExecute

-
-

Used in WiXCustomAction for determing when to run the custom action

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - Commit - -
- Signature:
-
-
- - - - -

Indicates that the custom action will run after successful completion of the installation script (at the end of the installation).

- - - -
- - - Deferred - -
- Signature:
-
-
- - - - -

Indicates that the custom action runs in-script (possibly with elevated privileges).

- - - -
- - - FirstSequence - -
- Signature:
-
-
- - - - -

Indicates that the custom action will only run in the first sequence that runs it.

- - - -
- - - Immediate - -
- Signature:
-
-
- - - - -

Indicates that the custom action will run during normal processing time with user privileges. This is the default.

- - - -
- - - OncePerProcess - -
- Signature:
-
-
- - - - -

Indicates that the custom action will only run in the first sequence that runs it in the same process.

- - - -
- - - Rollback - -
- Signature:
-
-
- - - - -

Indicates that a custom action will run in the rollback sequence when a failure occurs during installation, usually to undo changes made by a deferred custom action.

- - - -
- - - SecondSequence - -
- Signature:
-
-
- - - - -

Indicates that a custom action should be run a second time if it was previously run in an earlier sequence.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-customactionreturn.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-customactionreturn.html deleted file mode 100644 index b19e070..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-customactionreturn.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - CustomActionReturn - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

CustomActionReturn

-
-

Used in WiXCustomAction for determing the return type

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - AsyncNoWait - -
- Signature:
-
-
- - - - -

Indicates that the custom action will run asyncronously and execution may continue after the installer terminates.

- - - -
- - - AsyncWait - -
- Signature:
-
-
- - - - -

Indicates that the custom action will run asynchronously but the installer will wait for the return code at sequence end.

- - - -
- - - Check - -
- Signature:
-
-
- - - - -

Indicates that the custom action will run synchronously and the return code will be checked for success. This is the default.

- - - -
- - - Ignore - -
- Signature:
-
-
- - - - -

Indicates that the custom action will run synchronously and the return code will not be checked.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-feature.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-feature.html deleted file mode 100644 index 1a98e2c..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-feature.html +++ /dev/null @@ -1,268 +0,0 @@ - - - - - Feature - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Feature

-
-

Parameters for creating WiX Feature, use ToString for creating the string xml nodes

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Components - -
- Signature: seq<WiXComponentRef>
-
-
- - - - -

Components included in this feature

- - - -
- - - Description - -
- Signature: string
-
-
- - - - -

Longer string of text describing the feature. This localizable string is displayed by the Text Control of the Selection Dialog.

- - - -
- - - Display - -
- Signature: FeatureDisplay
-
-
- - - - -

Determines the initial display of this feature in the feature tree. This attribute's value should be one of the following: -collapse - Initially shows the feature collapsed. This is the default value. -expand - Initially shows the feature expanded. -hidden - Prevents the feature from displaying in the user interface. - - For advanced users only, it is possible to directly set the integer value of the display value that will appear in the Feature row.

- - - -
- - - Id - -
- Signature: string
-
-
- - - - -

Unique identifier of the feature.

- - - -
- - - Level - -
- Signature: int
-
-
- - - - -

Sets the install level of this feature. A value of 0 will disable the feature. -Processing the Condition Table can modify the level value (this is set via the Condition child element). -The default value is "1".

- - - -
- - - NestedFeatures - -
- Signature: seq<Feature>
-
-
- - - - -

Nest sub features

- - - -
- - - Title - -
- Signature: string
-
-
- - - - -

Short string of text identifying the feature. -This string is listed as an item by the SelectionTree control of the Selection Dialog.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-featuredisplay.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-featuredisplay.html deleted file mode 100644 index be94a57..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-featuredisplay.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - FeatureDisplay - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

FeatureDisplay

-
-

Used for determing whether the feature should be visible in the select features installer pane or not

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - Collapse - -
- Signature:
-
-
- - - - -

Initially shows the feature collapsed. This is the default value.

- - - -
- - - Expand - -
- Signature:
-
-
- - - - -

Initially shows the feature expanded.

- - - -
- - - Hidden - -
- Signature:
-
-
- - - - -

Prevents the feature from displaying in the user interface.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-installuninstall.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-installuninstall.html deleted file mode 100644 index 26f36b2..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-installuninstall.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - InstallUninstall - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

InstallUninstall

-
-

Specifies whether an action occur on install, uninstall or both.

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - Both - -
- Signature:
-
-
- - - - - -
- - - Install - -
- Signature:
-
-
- - - - - -
- - - Uninstall - -
- Signature:
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-majorupgradeschedule.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-majorupgradeschedule.html deleted file mode 100644 index 37a2b1e..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-majorupgradeschedule.html +++ /dev/null @@ -1,224 +0,0 @@ - - - - - MajorUpgradeSchedule - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

MajorUpgradeSchedule

-
-

Used for determing when to run RemoveExistingProducts on major upgrade

- - -
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - AfterInstallExecute - -
- Signature:
-
-
- - - - -

Schedules RemoveExistingProducts between the InstallExecute and InstallFinalize standard actions. This scheduling installs the upgrade product "on top of" the installed product then lets -RemoveExistingProducts uninstall any components that don't also exist in the upgrade product. Note that this scheduling requires strict adherence to the component rules because it relies -on component reference counts to be accurate during installation of the upgrade product and removal of the installed product. For more information, see Bob Arnson's blog post -"Paying for Upgrades" for details. If installation of the upgrade product fails, Windows Installer also rolls back the removal of the installed product -- in other words, reinstalls it.

- - - -
- - - AfterInstallExecuteAgain - -
- Signature:
-
-
- - - - -

Schedules RemoveExistingProducts between the InstallExecuteAgain and InstallFinalize standard actions. -This is identical to the afterInstallExecute scheduling but after the InstallExecuteAgain standard action instead of InstallExecute.

- - - -
- - - AfterInstallFinalize - -
- Signature:
-
-
- - - - -

Schedules RemoveExistingProducts after the InstallFinalize standard action. This is similar to the afterInstallExecute and afterInstallExecuteAgain schedulings but takes place outside -the installation transaction so if installation of the upgrade product fails, Windows Installer does not roll back the removal of the installed product, -so the machine will have both versions installed.

- - - -
- - - AfterInstallInitialize - -
- Signature:
-
-
- - - - -

Schedules RemoveExistingProducts after the InstallInitialize standard action. This is similar to the afterInstallValidate scheduling, but if the installation of the upgrade product fails, -Windows Installer also rolls back the removal of the installed product -- in other words, reinstalls it.

- - - -
- - - AfterInstallValidate - -
- Signature:
-
-
- - - - -

(Default) Schedules RemoveExistingProducts after the InstallValidate standard action. This scheduling removes the installed product entirely before installing the upgrade product. -It's slowest but gives the most flexibility in changing components and features in the upgrade product. Note that if the installation of the upgrade product fails, -the machine will have neither version installed.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-programfilesfolder.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-programfilesfolder.html deleted file mode 100644 index 39d8058..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-programfilesfolder.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - ProgramFilesFolder - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ProgramFilesFolder

-
-

Type for defining, which program directory should be used for installation. ProgramFiles32 refers to 'Program Files (x86)', ProgramFiles64 refers to 'Program Files'

- - -
-

Union Cases

- - - - - - - - - - - - - - -
Union CaseDescription
- - - ProgramFiles32 - -
- Signature:
-
-
- - - - - -
- - - ProgramFiles64 - -
- Signature:
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-script.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-script.html deleted file mode 100644 index 9406921..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-script.html +++ /dev/null @@ -1,488 +0,0 @@ - - - - - Script - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

Script

-
-

Parameters for WiX Script properties, use ToString for creating the string xml nodes

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ActionSequences - -
- Signature: seq<WiXCustomActionExecution>
-
-
- - - - -

You can nest InstallExecuteSequence actions in here

- - - -
- - - BuildNumber - -
- Signature: string
-
-
- - - - -

Build Number of product

- - - -
- - - Components - -
- Signature: seq<WiXComponent>
-
-
- - - - -

Nest Components in here

- - - -
- - - CustomActions - -
- Signature: seq<WiXCustomAction>
-
-
- - - - -

You can nest custom actions in here

- - - -
- - - Description - -
- Signature: string
-
-
- - - - -

Product description

- - - -
- - - Directories - -
- Signature: seq<WiXDir>
-
-
- - - - -

Nest directories in here

- - - -
- - - Features - -
- Signature: seq<Feature>
-
-
- - - - -

You can nest feature elements in here

- - - -
- - - MajorUpgrade - -
- Signature: seq<WiXMajorUpgrade>
-
-
- - - - -

Nest major upgrade elements in here

- - - -
- - - ProductCode - -
- Signature: Guid
-
-
- - - - -

The product code GUID for the product.

- - - -
- - - ProductLanguage - -
- Signature: int
-
-
- - - - -

The decimal language ID (LCID) for the product.

- - - -
- - - ProductName - -
- Signature: string
-
-
- - - - -

The descriptive name of the product.

- - - -
- - - ProductPublisher - -
- Signature: string
-
-
- - - - -

The manufacturer of the product.

- - - -
- - - ProductVersion - -
- Signature: string
-
-
- - - - -

The product's version string.

- - - -
- - - ProgramFilesFolder - -
- Signature: ProgramFilesFolder
-
-
- - - - -

The program files folder

- - - -
- - - UIRefs - -
- Signature: seq<WiXUIRef>
-
-
- - - - -

Nest UIRefs in here

- - - -
- - - Upgrade - -
- Signature: seq<WiXUpgrade>
-
-
- - - - -

You can nest upgrade elements in here

- - - -
- - - UpgradeGuid - -
- Signature: Guid
-
-
- - - - -

The upgrade code GUID for the product.

- - - -
- - - WiXVariables - -
- Signature: seq<WiXVariable>
-
-
- - - - -

Nest WiXVariables in here

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixcomponent.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixcomponent.html deleted file mode 100644 index 9506fd3..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixcomponent.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - WiXComponent - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

WiXComponent

-
-

Component which wraps files into logical components and which allows to

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Files - -
- Signature: seq<WiXFile>
-
-
- - - - - -
- - - Guid - -
- Signature: string
-
-
- - - - - -
- - - Id - -
- Signature: string
-
-
- - - - - -
- - - ServiceControls - -
- Signature: seq<WiXServiceControl>
-
-
- - - - - -
-

Instance members

- - - - - - - - - - -
Instance memberDescription
- - - ToComponentRef() - -
- Signature: unit -> WiXComponentRef
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixcomponentref.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixcomponentref.html deleted file mode 100644 index 3ac01d3..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixcomponentref.html +++ /dev/null @@ -1,128 +0,0 @@ - - - - - WiXComponentRef - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixcustomaction.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixcustomaction.html deleted file mode 100644 index beecae2..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixcustomaction.html +++ /dev/null @@ -1,244 +0,0 @@ - - - - - WiXCustomAction - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

WiXCustomAction

-
-

Parameters for WiX custom action, use ToString for creating the string xml nodes

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ExeCommand - -
- Signature: string
-
-
- - - - -

This attribute specifies the command line parameters to supply to an externally run executable. -This attribute is typically used with the BinaryKey attribute for a type 2 custom action, the FileKey attribute for a type 18 -custom action, the Property attribute for a type 50 custom action, or the Directory attribute for a type 34 custom action that -specify the executable to run.

- - - -
- - - Execute - -
- Signature: CustomActionExecute
-
-
- - - - -

This attribute indicates the scheduling of the custom action.

- - - -
- - - FileKey - -
- Signature: string
-
-
- - - - -

This attribute specifies a reference to a File element with matching Id attribute that will execute the custom action code -in the file after the file is installed. This attribute is typically used with the ExeCommand attribute to specify -a type 18 custom action that runs an installed executable, with the DllEntry attribute to specify an installed custom action -DLL to use for a type 17 custom action, or with the VBScriptCall or JScriptCall attributes to specify a type 21 or 22 custom action.

- - - -
- - - Id - -
- Signature: string
-
-
- - - - -

The identifier of the custom action.

- - - -
- - - Impersonate - -
- Signature: YesOrNo
-
-
- - - - -

This attribute specifies whether the Windows Installer, which executes as LocalSystem, should impersonate the user context of -the installing user when executing this custom action. Typically the value should be 'yes', except when the custom action needs -elevated privileges to apply changes to the machine.

- - - -
- - - Return - -
- Signature: CustomActionReturn
-
-
- - - - -

Set this attribute to set the return behavior of the custom action.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixcustomactionexecution.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixcustomactionexecution.html deleted file mode 100644 index bd3f959..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixcustomactionexecution.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - WiXCustomActionExecution - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

WiXCustomActionExecution

-
-

Parameters for WiX Custom Action executions (In InstallExecuteSequence), use ToString for creating the string xml nodes

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ActionId - -
- Signature: string
-
-
- - - - -

The action to which the Custom element applies.

- - - -
- - - Condition - -
- Signature: string
-
-
- - - - -

Conditions that have to be fulfilled for running execution

- - - -
- - - Target - -
- Signature: string
-
-
- - - - -

Name of the standard or custom action that the verb points to

- - - -
- - - Verb - -
- Signature: ActionExecutionVerb
-
-
- - - - -

Specify if action should be executed before or after target action

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixdir.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixdir.html deleted file mode 100644 index b2bda51..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixdir.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - WiXDir - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

WiXDir

-
-

WiX Directories define a logical directory which can include components and files

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Components - -
- Signature: seq<WiXComponent>
-
-
- - - - - -
- - - Files - -
- Signature: seq<WiXFile>
-
-
- - - - - -
- - - Id - -
- Signature: string
-
-
- - - - - -
- - - Name - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixfeature.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixfeature.html deleted file mode 100644 index 1b7bf73..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixfeature.html +++ /dev/null @@ -1,247 +0,0 @@ - - - - - WiXFeature - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

WiXFeature

-
-

Parameters for creating WiX Feature, use ToString for creating the string xml nodes

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Description - -
- Signature: string
-
-
- - - - -

Longer string of text describing the feature. This localizable string is displayed by the Text Control of the Selection Dialog.

- - - -
- - - Display - -
- Signature: FeatureDisplay
-
-
- - - - -

Determines the initial display of this feature in the feature tree. This attribute's value should be one of the following: -collapse - Initially shows the feature collapsed. This is the default value. -expand - Initially shows the feature expanded. -hidden - Prevents the feature from displaying in the user interface. - - For advanced users only, it is possible to directly set the integer value of the display value that will appear in the Feature row.

- - - -
- - - Id - -
- Signature: string
-
-
- - - - -

Unique identifier of the feature.

- - - -
- - - InnerContent - -
- Signature: string
-
-
- - - - -

Nest sub features or components in here

- - - -
- - - Level - -
- Signature: int
-
-
- - - - -

Sets the install level of this feature. A value of 0 will disable the feature. -Processing the Condition Table can modify the level value (this is set via the Condition child element). -The default value is "1".

- - - -
- - - Title - -
- Signature: string
-
-
- - - - -

Short string of text identifying the feature. -This string is listed as an item by the SelectionTree control of the Selection Dialog.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixfile.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixfile.html deleted file mode 100644 index 563e30a..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixfile.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - WiXFile - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixmajorupgrade.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixmajorupgrade.html deleted file mode 100644 index 182049a..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixmajorupgrade.html +++ /dev/null @@ -1,175 +0,0 @@ - - - - - WiXMajorUpgrade - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

WiXMajorUpgrade

-
-

Parameters for WiX Major Upgrade

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - AllowDowngrades - -
- Signature: YesOrNo
-
-
- - - - -

When set to no (the default), products with lower version numbers are blocked from installing when a product with a higher version is installed; the DowngradeErrorMessage -attribute must also be specified. When set to yes, any version can be installed over any other version.

- - - -
- - - DowngradeErrorMessage - -
- Signature: string
-
-
- - - - -

The message displayed if users try to install a product with a lower version number when a product with a higher version is installed. Used only when AllowDowngrades is no (the default).

- - - -
- - - Schedule - -
- Signature: MajorUpgradeSchedule
-
-
- - - - -

Determines the scheduling of the RemoveExistingProducts standard action, which is when the installed product is removed. The default is "afterInstallValidate" which removes the -installed product entirely before installing the upgrade product. It's slowest but gives the most flexibility in changing components and features in the upgrade product.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixparams.html deleted file mode 100644 index 8a6a9c4..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixparams.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - WiXParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

WiXParams

-
-

WiX parameter type

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - AdditionalCandleArgs - -
- Signature: string list
-
-
- - - - - -
- - - AdditionalLightArgs - -
- Signature: string list
-
-
- - - - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - - -
- - - ToolDirectory - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixscript.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixscript.html deleted file mode 100644 index cd33afc..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixscript.html +++ /dev/null @@ -1,467 +0,0 @@ - - - - - WiXScript - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

WiXScript

-
-

Parameters for WiX Script properties, use ToString for creating the string xml nodes

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ActionSequences - -
- Signature: string
-
-
- - - - -

You can nest InstallExecuteSequence actions in here

- - - -
- - - BuildNumber - -
- Signature: string
-
-
- - - - -

Build Number of product

- - - -
- - - CustomActions - -
- Signature: string
-
-
- - - - -

You can nest custom actions in here

- - - -
- - - Description - -
- Signature: string
-
-
- - - - -

Product description

- - - -
- - - Directories - -
- Signature: string
-
-
- - - - -

Nest directories in here

- - - -
- - - Features - -
- Signature: string
-
-
- - - - -

You can nest feature elements in here

- - - -
- - - MajorUpgrade - -
- Signature: string
-
-
- - - - -

Nest major upgrade elements in here

- - - -
- - - ProductCode - -
- Signature: Guid
-
-
- - - - -

The product code GUID for the product.

- - - -
- - - ProductLanguage - -
- Signature: string
-
-
- - - - -

The decimal language ID (LCID) for the product.

- - - -
- - - ProductName - -
- Signature: string
-
-
- - - - -

The descriptive name of the product.

- - - -
- - - ProductPublisher - -
- Signature: string
-
-
- - - - -

The manufacturer of the product.

- - - -
- - - ProductVersion - -
- Signature: string
-
-
- - - - -

The product's version string.

- - - -
- - - ProgramFilesFolder - -
- Signature: ProgramFilesFolder
-
-
- - - - -

The program files folder

- - - -
- - - UIRefs - -
- Signature: string
-
-
- - - - -

Nest UIRefs in here

- - - -
- - - Upgrade - -
- Signature: string
-
-
- - - - -

You can nest upgrade elements in here

- - - -
- - - UpgradeGuid - -
- Signature: Guid
-
-
- - - - -

The upgrade code GUID for the product.

- - - -
- - - WiXVariables - -
- Signature: string
-
-
- - - - -

Nest WiXVariables in here

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixservicecontrol.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixservicecontrol.html deleted file mode 100644 index fa850e6..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixservicecontrol.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - WiXServiceControl - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

WiXServiceControl

-
-

Service Control Element. Can Start, Stop and Remove services

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Id - -
- Signature: string
-
-
- - - - - -
- - - Name - -
- Signature: string
-
-
- - - - - -
- - - Remove - -
- Signature: InstallUninstall
-
-
- - - - - -
- - - Start - -
- Signature: InstallUninstall
-
-
- - - - - -
- - - Stop - -
- Signature: InstallUninstall
-
-
- - - - - -
- - - Wait - -
- Signature: YesOrNo
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixuiref.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixuiref.html deleted file mode 100644 index 8926ec3..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixuiref.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - WiXUIRef - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixupgrade.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixupgrade.html deleted file mode 100644 index 60a8c0f..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixupgrade.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - WiXUpgrade - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

WiXUpgrade

-
-

Parameters for WiX Upgrade

- - -
-

Record Fields

- - - - - - - - - - - - - - -
Record FieldDescription
- - - Id - -
- Signature: Guid
-
-
- - - - -

This value specifies the upgrade code for the products that are to be detected by the FindRelatedProducts action.

- - - -
- - - UpgradeVersion - -
- Signature: string
-
-
- - - - -

You can nest WiXUpgradeVersion sequences in here

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixupgradeversion.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixupgradeversion.html deleted file mode 100644 index 40cb69a..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixupgradeversion.html +++ /dev/null @@ -1,240 +0,0 @@ - - - - - WiXUpgradeVersion - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

WiXUpgradeVersion

-
-

Parameters for WiX Upgrade Version

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - IncludeMaximum - -
- Signature: YesOrNo
-
-
- - - - -

Set to "yes" to make the range of versions detected include the value specified in Maximum.

- - - -
- - - IncludeMinimum - -
- Signature: YesOrNo
-
-
- - - - -

Set to "no" to make the range of versions detected exclude the value specified in Minimum. This attribute is "yes" by default.

- - - -
- - - Maximum - -
- Signature: string
-
-
- - - - -

Specifies the upper boundary of the range of product versions detected by FindRelatedProducts.

- - - -
- - - Minimum - -
- Signature: string
-
-
- - - - -

Specifies the lower bound on the range of product versions to be detected by FindRelatedProducts.

- - - -
- - - OnlyDetect - -
- Signature: YesOrNo
-
-
- - - - -

Set to "yes" to detect products and applications but do not uninstall.

- - - -
- - - Property - -
- Signature: string
-
-
- - - - -

When the FindRelatedProducts action detects a related product installed on the system, it appends the product code to the property specified in this field. -Windows Installer documentation for the Upgrade table states that the property specified in this field must be a public property and must be added to the -SecureCustomProperties property. WiX automatically appends the property specified in this field to the SecureCustomProperties property when creating an MSI. -Each UpgradeVersion must have a unique Property value. After the FindRelatedProducts action is run, the value of this property is a list of product codes, -separated by semicolons (;), detected on the system.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixvariable.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixvariable.html deleted file mode 100644 index f2b4fb7..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-wixvariable.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - WiXVariable - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

WiXVariable

-
-

Parameters for WiX Variable, use ToString for creating the string xml nodes

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Id - -
- Signature: string
-
-
- - - - -

The name of the variable.

- - - -
- - - Overridable - -
- Signature: YesOrNo
-
-
- - - - -

Set this value to 'yes' in order to make the variable's value overridable either by another WixVariable entry or via the command-line option -d= for light.exe. -If the same variable is declared overridable in multiple places it will cause an error (since WiX won't know which value is correct). The default value is 'no'.

- - - -
- - - Value - -
- Signature: string
-
-
- - - - -

The value of the variable. The value cannot be an empty string because that would make it possible to accidentally set a column to null.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-yesorno.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-yesorno.html deleted file mode 100644 index 1f3e71a..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper-yesorno.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - YesOrNo - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper.html deleted file mode 100644 index 9120977..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-wixhelper.html +++ /dev/null @@ -1,1799 +0,0 @@ - - - - - WiXHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

WiXHelper

-
-

Contains tasks to create msi installers using the WiX toolset

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- ActionExecutionVerb -

Used for specifying the point of time for action execution in WiXCustomActionExecution

- - -
- CustomActionExecute -

Used in WiXCustomAction for determing when to run the custom action

- - -
- CustomActionReturn -

Used in WiXCustomAction for determing the return type

- - -
- Feature -

Parameters for creating WiX Feature, use ToString for creating the string xml nodes

- - -
- FeatureDisplay -

Used for determing whether the feature should be visible in the select features installer pane or not

- - -
- InstallUninstall -

Specifies whether an action occur on install, uninstall or both.

- - -
- MajorUpgradeSchedule -

Used for determing when to run RemoveExistingProducts on major upgrade

- - -
- ProgramFilesFolder -

Type for defining, which program directory should be used for installation. ProgramFiles32 refers to 'Program Files (x86)', ProgramFiles64 refers to 'Program Files'

- - -
- Script -

Parameters for WiX Script properties, use ToString for creating the string xml nodes

- - -
- WiXComponent -

Component which wraps files into logical components and which allows to

- - -
- WiXComponentRef -

Reference to a component for including it in a feature

- - -
- WiXCustomAction -

Parameters for WiX custom action, use ToString for creating the string xml nodes

- - -
- WiXCustomActionExecution -

Parameters for WiX Custom Action executions (In InstallExecuteSequence), use ToString for creating the string xml nodes

- - -
- WiXDir -

WiX Directories define a logical directory which can include components and files

- - -
- WiXFeature -

Parameters for creating WiX Feature, use ToString for creating the string xml nodes

- - -
- WiXFile -

WiX File Element

- - -
- WiXMajorUpgrade -

Parameters for WiX Major Upgrade

- - -
- WiXParams -

WiX parameter type

- - -
- WiXScript -

Parameters for WiX Script properties, use ToString for creating the string xml nodes

- - -
- WiXServiceControl -

Service Control Element. Can Start, Stop and Remove services

- - -
- WiXUIRef -

Parameters for WiX UI Reference, use ToString for creating the string xml nodes

- - -
- WiXUpgrade -

Parameters for WiX Upgrade

- - -
- WiXUpgradeVersion -

Parameters for WiX Upgrade Version

- - -
- WiXVariable -

Parameters for WiX Variable, use ToString for creating the string xml nodes

- - -
- YesOrNo -

These are used in many methods for generating WiX nodes, regard them as booleans

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - attachServiceControlToComponents (...) - -
- Signature: components:seq<WiXComponent> -> fileFilter:(WiXComponent -> bool) -> serviceControls:seq<WiXServiceControl> -> seq<WiXComponent>
-
-
- - - - -

Use this to attach service controls to your components.

- - - -
- - - bulkComponentCreation (...) - -
- Signature: fileFilter:(FileInfo -> bool) -> directoryInfo:DirectoryInfo -> seq<WiXComponent>
-
-
- - - - -

Creates WiX component with directories and files from the given DirectoryInfo -The function will create one component for each file best practice -and set the GUID to "*", which will make WiX produce consistent Component Guids if the Component's target path doesn't change. -This is vital for major upgrades, since windows installer needs a consistent component guid for tracking each of them. -You can use the getComponentIdsFromWiXString function for getting all created component refs and adding them to features.

- - - -
- - - bulkComponentCreationAsSubDir (...) - -
- Signature: fileFilter:(FileInfo -> bool) -> directoryInfo:DirectoryInfo -> WiXDir
-
-
- - - - -

Creates WiX component with directories and files from the given DirectoryInfo -The function will create one component for each file best practice -and set the GUID to "*", which will make WiX produce consistent Component Guids if the Component's target path doesn't change. -This is vital for major upgrades, since windows installer needs a consistent component guid for tracking each of them. -The components are embedded into the passed in root directory.

- - - -
- - - Candle parameters wixScript - -
- Signature: parameters:WiXParams -> wixScript:string -> string
-
-
- - - - -

Runs the Candle tool on the given WiX script with the given parameters

- - - -
- - - compName comp - -
- Signature: comp:string -> string
-
-
- - - - - -
- - - compRefName compRef - -
- Signature: compRef:string -> string
-
-
- - - - - -
- - - dirName dir - -
- Signature: dir:string -> string
-
-
- - - - - -
- - - FeatureDefaults - -
- Signature: Feature
-
-
- - - - -

Default values for creating WiX Feature

- - - -
- - - FillInWixScript wiXPath setParams - -
- Signature: wiXPath:string -> setParams:(WiXScript -> WiXScript) -> unit
-
-
- - - - -

Takes path where script files reside and sets all parameters as defined

- -

Parameters

- -
    -
  • wiXPath - Pass path where your script is located at. Function will search for all Scripts in that location and fill in parameters
  • -
  • setParams - Function used to manipulate the WiX default parameters.
  • -
- -

Sample

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-
FillInWixScript "" (fun f ->
-                       {f with
-                           ProductCode = WiXProductCode
-                           ProductName = WiXProductName
-                           Description = projectDescription
-                           ProductLanguage = WiXProductLanguage
-                           ProductVersion = WiXProductVersion
-                           ProductPublisher = WixProductPublisher
-                           UpgradeGuid = WixProductUpgradeGuid
-                           UIRefs = uiRef1.ToString() + uiRef2.ToString()
-                           WiXVariables = wiXLicense.ToString()
-                           Directories = directories
-                           BuildNumber = "1.0.0"
-                           Features = rootFeature.ToString()
-                           CustomActions = action1.ToString() + action2.ToString()
-                           ActionSequences = actionExecution1.ToString() + actionExecution2.ToString()
-                       })
-
- - - -
- - - FillInWiXTemplate wiXPath setParams - -
- Signature: wiXPath:string -> setParams:(Script -> Script) -> unit
-
-
- - - - -

Takes path where script files reside and sets all parameters as defined

- -

Parameters

- -
    -
  • wiXPath - Pass path where your script is located at. Function will search for all Scripts in that location and fill in parameters
  • -
  • setParams - Function used to manipulate the WiX default parameters.
  • -
- -

Sample

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-
FillInWixScript "" (fun f ->
-                       {f with
-                           ProductCode = WiXProductCode
-                           ProductName = WiXProductName
-                           Description = projectDescription
-                           ProductLanguage = WiXProductLanguage
-                           ProductVersion = WiXProductVersion
-                           ProductPublisher = WixProductPublisher
-                           UpgradeGuid = WixProductUpgradeGuid
-                           UIRefs = uiRef1.ToString() + uiRef2.ToString()
-                           WiXVariables = wiXLicense.ToString()
-                           Directories = directories
-                           BuildNumber = "1.0.0"
-                           Features = rootFeature.ToString()
-                           CustomActions = action1.ToString() + action2.ToString()
-                           ActionSequences = actionExecution1.ToString() + actionExecution2.ToString()
-                       })
-
- - - -
- - - generateComponent setParams - -
- Signature: setParams:(WiXComponent -> WiXComponent) -> WiXComponent
-
-
- - - - -

Use this for generating single components

- - - -
- - - generateComponentRef setParams - -
- Signature: setParams:(WiXComponentRef -> WiXComponentRef) -> WiXComponentRef
-
-
- - - - -

Use this for generating component refs

- - - -
- - - generateCustomAction setParams - -
- Signature: setParams:(WiXCustomAction -> WiXCustomAction) -> WiXCustomAction
-
-
- - - - -

Generates a customAction based on the given parameters, use toString on it when embedding it -Be careful to make Id unique. FileKey is a reference to a file Id which you added by using wixDir or wixFile -Set impersonate to no if your action needs elevated privileges, you should then also set execute as "deferred" -ExeCommand are the parameters passed to your executable

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the WiX default parameters.
  • -
- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-8: 
-9: 
-
let action = generateCustomAction (fun f ->
-                                       {f with
-                                           Id = "UniqueActionId"
-                                           FileKey = "fi_5"
-                                           Execute = "deferred"
-                                           Impersonate = "no"
-                                           ExeCommand = "install"
-                                           Return = "check"
-                                       })
-
- -
val action : obj

Full name: docs.action
- - -
- - - generateCustomActionExecution setParams - -
- Signature: setParams:(WiXCustomActionExecution -> WiXCustomActionExecution) -> WiXCustomActionExecution
-
-
- - - - -

Generates a custom action execution based on the given parameters, use toString on it when embedding it -Condition in sample makes execute only on install

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the WiX default parameters.
  • -
- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-
let actionExecution = generateCustomActionExecution (fun f ->
-                                                           {f with 
-                                                               ActionId = action.Id
-                                                               Verb = "After"
-                                                               Target = "InstallFiles"                                                                        
-                                                               Condition = "<![CDATA[(&" + feature.Id + " = 3) AND NOT (!" + feature.Id + " = 3)]]>"
-                                                           })
-
- -
val actionExecution : obj

Full name: docs.actionExecution
- - -
- - - generateDirectory setParams - -
- Signature: setParams:(WiXDir -> WiXDir) -> WiXDir
-
-
- - - - -

Use this for generating directories

- - - -
- - - generateFeature setParams - -
- Signature: setParams:(WiXFeature -> WiXFeature) -> WiXFeature
-
-
- - - - -

Generates a feature based on the given parameters, use toString on it when embedding it -You can pass other features into InnerContent for making a hierarchy

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the WiX default parameters.
  • -
- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-8: 
-9: 
-
let feature = generateFeature (fun f -> 
-                                   {f with  
-                                       Id = "UniqueName"
-                                       Title = "Title which is shown"
-                                       Level = 1 
-                                       Description = "Somewhat longer description" 
-                                       Display = "expand" 
-                                       InnerContent = otherFeature.ToString()
-                                   })
-
- -
val feature : obj

Full name: docs.feature
- - -
- - - generateFeatureElement setParams - -
- Signature: setParams:(Feature -> Feature) -> Feature
-
-
- - - - -

Generates a feature based on the given parameters, use toString on it when embedding it -You can pass other features into InnerContent for making a hierarchy

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the WiX default parameters.
  • -
- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-8: 
-9: 
-
let feature = generateFeature (fun f -> 
-                                   {f with  
-                                       Id = "UniqueName"
-                                       Title = "Title which is shown"
-                                       Level = 1 
-                                       Description = "Somewhat longer description" 
-                                       Display = "expand" 
-                                       InnerContent = [otherFeature1; otherFeature2]
-                                   })
-
- -
val feature : obj

Full name: docs.feature
- - -
- - - generateMajorUpgradeVersion setParams - -
- Signature: setParams:(WiXMajorUpgrade -> WiXMajorUpgrade) -> WiXMajorUpgrade
-
-
- - - - -

Generates a major upgrade based on the given parameters, use toString on it when embedding it

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the WiX default parameters.
  • -
- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-
let majorUpgradeVersion = generateMajorUpgradeVersion(fun f ->
-                                                {f with 
-                                                    DowngradeErrorMessage = "A later version is already installed, exiting."
-                                                })
-
- -
val majorUpgradeVersion : obj

Full name: docs.majorUpgradeVersion
- - -
- - - generateServiceControl setParams - -
- Signature: setParams:(WiXServiceControl -> WiXServiceControl) -> WiXServiceControl
-
-
- - - - -

Use this for generating service controls

- - - -
- - - generateUIRef setParams - -
- Signature: setParams:(WiXUIRef -> WiXUIRef) -> WiXUIRef
-
-
- - - - -

Generates a ui ref based on the given parameters, use toString on it when embedding it

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the WiX default parameters.
  • -
- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-
let UIRef = generateUIRef (fun f ->
-                               {f with
-                                   Id = "WixUI_Mondo"
-                               })
-
- -
val UIRef : obj

Full name: docs.UIRef
- - -
- - - generateUpgrade setParams - -
- Signature: setParams:(WiXUpgrade -> WiXUpgrade) -> WiXUpgrade
-
-
- - - - -

Generates an upgrade based on the given parameters, use toString on it when embedding it

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the WiX default parameters.
  • -
- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-
let upgrade = generateUpgrade (fun f ->
-                                  {f with
-                                     Id = productUpgradeCode
-                                  })
-
- -
val upgrade : obj

Full name: docs.upgrade
- - -
- - - generateUpgradeVersion setParams - -
- Signature: setParams:(WiXUpgradeVersion -> WiXUpgradeVersion) -> WiXUpgradeVersion
-
-
- - - - -

Generates an upgrade version based on the given parameters, use toString on it when embedding it

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the WiX default parameters.
  • -
- -

Sample

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-
let upgradeVersion = generateUpgradeVersion (fun f ->
-                                                {f with
-                                                   Minimum = productVersion
-                                                   OnlyDetect = "yes"
-                                                })
-
- -
val upgradeVersion : obj

Full name: docs.upgradeVersion
- - -
- - - generateWiXScript fileName - -
- Signature: fileName:string -> unit
-
-
- - - - -

Generates WiX Template with specified file name (you can prepend location too) -You need to run this once every build an then use FillInWiXScript to replace placeholders

- -

Parameters

- -
    -
  • fileName - Pass desired fileName for your wiXScript file
  • -
- -

Sample

- - - - -
1: 
-
generateWiXScript "Setup.wxs"
-
- - - -
- - - getComponentIdsFromWiXString wiXString - -
- Signature: wiXString:string -> string
-
-
- - - - -

Retrieves all component ids from given WiX directory string

- -

Parameters

- -
    -
  • wiXString - The directory string which was generated by wixDir
  • -
- -

Sample

- - - - -
1: 
-2: 
-
let directoryString = wixDir (fun file -> true) true (DirectoryInfo directoryWithFilesForSetup)
-let componentIds = getComponentIdsFromWiXString directoryString
-
- -
val directoryString : obj

Full name: docs.directoryString
-
val componentIds : obj

Full name: docs.componentIds
- - -
- - - getFileIdFromWiXString (...) - -
- Signature: wiXString:string -> fileRegex:string -> string
-
-
- - - - -

Retrieves the file id of the first file in WiXString, which name matches fileRegex

- -

Parameters

- -
    -
  • wiXString - The directory string which was generated by wixDir
  • -
  • fileRegex - Regex which matches the file name
  • -
- -

Sample

- - - - -
1: 
-2: 
-
let directoryString = wixDir (fun file -> true) true (DirectoryInfo directoryWithFilesForSetup)
-let executableFileId = getFileIdFromWiXString directoryString "\S*.exe"
-
- -
val directoryString : obj

Full name: docs.directoryString
-
val executableFileId : obj

Full name: docs.executableFileId
- - -
- - - getFilesAsWiXString files - -
- Signature: files:seq<string> -> string
-
-
- - - - -

Creates WiX File tags from the given files

- - - -
- - - Light parameters outputFile wixObj - -
- Signature: parameters:WiXParams -> outputFile:string -> wixObj:string -> unit
-
-
- - - - -

Runs the Light tool on the given WiX script with the given parameters

- - - -
- - - ScriptDefaults - -
- Signature: Script
-
-
- - - - -

Default values for WiX Script properties

- - - -
- - - setComponentsNeverOverwrite components - -
- Signature: components:string -> string
-
-
- - - - -

Take a component string and set "neverOverwrite" Tag -This is useful for config files, since they are not replaced on upgrade like that

- - - -
- - - WiX setParams outputFile wixScript - -
- Signature: setParams:(WiXParams -> WiXParams) -> outputFile:string -> wixScript:string -> unit
-
-
- - - - -

Uses the WiX tools Candle and Light to create an msi.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the WiX default parameters.
  • -
  • outputFile - The msi output file path (given to Light).
  • -
  • wixScript - The path to a WiX script that will be used with Candle.
  • -
- -

Sample

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-21: 
-22: 
-23: 
-24: 
-
Target "BuildSetup" (fun _ ->
-    // Copy all important files to the deploy directory
-    !! (buildDir + "/**/*.dll")
-      ++ (buildDir + "/**/*.exe")
-      ++ (buildDir + "/**/*.config")
-      |> Copy deployPrepDir 
-
-    // replace tags in a template file in order to generate a WiX script
-    let ALLFILES = fun _ -> true
-
-    let replacements = [
-        "@build.number@",if not isLocalBuild then buildVersion else "0.1.0.0"
-        "@product.productcode@",System.Guid.NewGuid().ToString()
-        "@HelpFiles@",getFilesAsWiXString helpFiles
-        "@ScriptFiles@",getFilesAsWiXString scriptFiles
-        "@icons@",wixDir ALLFILES true (directoryInfo(bundledDir @@ "icons"))]
-
-    processTemplates replacements setupFiles
-
-    // run the WiX tools
-    WiX (fun p -> {p with ToolDirectory = WiXPath}) 
-        setupFileName
-        (setupBuildDir + "Setup.wxs.template")
-)
-
- -
val not : value:bool -> bool

Full name: Microsoft.FSharp.Core.Operators.not
-
namespace System
-
Multiple items
type Guid =
  struct
    new : b:byte[] -> Guid + 4 overloads
    member CompareTo : value:obj -> int + 1 overload
    member Equals : o:obj -> bool + 1 overload
    member GetHashCode : unit -> int
    member ToByteArray : unit -> byte[]
    member ToString : unit -> string + 2 overloads
    static val Empty : Guid
    static member NewGuid : unit -> Guid
    static member Parse : input:string -> Guid
    static member ParseExact : input:string * format:string -> Guid
    ...
  end

Full name: System.Guid

--------------------
System.Guid()
System.Guid(b: byte []) : unit
System.Guid(g: string) : unit
System.Guid(a: int, b: int16, c: int16, d: byte []) : unit
System.Guid(a: uint32, b: uint16, c: uint16, d: byte, e: byte, f: byte, g: byte, h: byte, i: byte, j: byte, k: byte) : unit
System.Guid(a: int, b: int16, c: int16, d: byte, e: byte, f: byte, g: byte, h: byte, i: byte, j: byte, k: byte) : unit
-
System.Guid.NewGuid() : System.Guid
- - -
- - - WiXComponentDefaults - -
- Signature: WiXComponent
-
-
- - - - -

Defaults for component

- - - -
- - - WiXComponentRefDefaults - -
- Signature: WiXComponentRef
-
-
- - - - -

Defaults for component ref

- - - -
- - - wixComponentRefs directoryInfo - -
- Signature: directoryInfo:DirectoryInfo -> string
-
-
- - - - -

Creates WiX ComponentRef tags from the given DirectoryInfo

- - - -
- - - WiXCustomActionDefaults - -
- Signature: WiXCustomAction
-
-
- - - - -

Default values for WiX custom actions

- - - -
- - - WixCustomActionExecutionDefaults - -
- Signature: WiXCustomActionExecution
-
-
- - - - -

Default values for WiX custom action executions

- - - -
- - - WiXDefaults - -
- Signature: WiXParams
-
-
- - - - -

Contains the WiX default parameters

- - - -
- - - wixDir fileFilter asSubDir directoryInfo - -
- Signature: fileFilter:(FileInfo -> bool) -> asSubDir:bool -> directoryInfo:DirectoryInfo -> string
-
-
- - - - -

Creates recursive WiX directory and file tags from the given DirectoryInfo -The function will create one component for each file best practice -and set the GUID to "*", which will make WiX produce consistent Component Guids if the Component's target path doesn't change. -This is vital for major upgrades, since windows installer needs a consistent component guid for tracking each of them. -You can use the getComponentIdsFromWiXString function for getting all created component refs and adding them to features.

- - - -
- - - WiXDirDefaults - -
- Signature: WiXDir
-
-
- - - - -

Defaults for directories

- - - -
- - - WiXFeatureDefaults - -
- Signature: WiXFeature
-
-
- - - - -

Default values for creating WiX Feature

- - - -
- - - wixFile fileInfo - -
- Signature: fileInfo:FileInfo -> string
-
-
- - - - -

Creates a WiX File tag from the given FileInfo

- - - -
- - - WiXFileDefaults - -
- Signature: WiXFile
-
-
- - - - -

Defaults for WiX file

- - - -
- - - WiXMajorUpgradeDefaults - -
- Signature: WiXMajorUpgrade
-
-
- - - - -

Default value for WiX Major Upgrade

- - - -
- - - WiXScriptDefaults - -
- Signature: WiXScript
-
-
- - - - -

Default values for WiX Script properties

- - - -
- - - WiXServiceControlDefaults - -
- Signature: WiXServiceControl
-
-
- - - - -

Defaults for service control element

- - - -
- - - WiXUIRefDefaults - -
- Signature: WiXUIRef
-
-
- - - - -

Default value for WiX UI Reference (WixUI_Minimal)

- - - -
- - - WiXUpgradeDefaults - -
- Signature: WiXUpgrade
-
-
- - - - -

Default value for WiX Upgrade

- - - -
- - - WiXUpgradeVersionDefaults - -
- Signature: WiXUpgradeVersion
-
-
- - - - -

Default value for WiX Upgrade

- - - -
- - - WiXVariableDefaults - -
- Signature: WiXVariable
-
-
- - - - -

Default value for WiX Variable

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-androidabitarget.html b/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-androidabitarget.html deleted file mode 100644 index 702b9b8..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-androidabitarget.html +++ /dev/null @@ -1,215 +0,0 @@ - - - - - AndroidAbiTarget - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

AndroidAbiTarget

-
-
-

Union Cases

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Union CaseDescription
- - - AllAbi - -
- Signature:
-
-
- - - - - -
- - - Arm64V8a(AndroidAbiTargetConfig) - -
- Signature: AndroidAbiTargetConfig
-
-
- - - - - -
- - - ArmEabi(AndroidAbiTargetConfig) - -
- Signature: AndroidAbiTargetConfig
-
-
- - - - - -
- - - ArmEabiV7a(AndroidAbiTargetConfig) - -
- Signature: AndroidAbiTargetConfig
-
-
- - - - - -
- - - X86(AndroidAbiTargetConfig) - -
- Signature: AndroidAbiTargetConfig
-
-
- - - - - -
- - - X86And64(AndroidAbiTargetConfig) - -
- Signature: AndroidAbiTargetConfig
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-androidabitargetconfig.html b/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-androidabitargetconfig.html deleted file mode 100644 index 9cd31bf..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-androidabitargetconfig.html +++ /dev/null @@ -1,125 +0,0 @@ - - - - - AndroidAbiTargetConfig - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-androidpackageabiparam.html b/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-androidpackageabiparam.html deleted file mode 100644 index 3cec36b..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-androidpackageabiparam.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - AndroidPackageAbiParam - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-androidpackageparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-androidpackageparams.html deleted file mode 100644 index 40b5631..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-androidpackageparams.html +++ /dev/null @@ -1,236 +0,0 @@ - - - - - AndroidPackageParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

AndroidPackageParams

-
-

The Android packaging parameter type

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Configuration - -
- Signature: string
-
-
- - - - -

Build configuration, defaults to 'Release'

- - - -
- - - OutputPath - -
- Signature: string
-
-
- - - - -

Output path for build, defaults to 'bin/Release'

- - - -
- - - PackageAbiTargets - -
- Signature: AndroidPackageAbiParam
-
-
- - - - -

Build an APK Targetting One ABI (used to reduce the size of the APK and support different CPU architectures)

- - - -
- - - ProjectPath - -
- Signature: string
-
-
- - - - -

(Required) Path to the Android project file (not the solution file!)

- - - -
- - - Properties - -
- Signature: (string * string) list
-
-
- - - - -

Additional MSBuild properties, defaults to empty list

- - - -
- - - VersionStepper - -
- Signature: IncrementerVersion option
-
-
- - - - -

Used for multiple APK packaging to set different version code par ABI

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-androidsignandalignparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-androidsignandalignparams.html deleted file mode 100644 index 64de9cc..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-androidsignandalignparams.html +++ /dev/null @@ -1,254 +0,0 @@ - - - - - AndroidSignAndAlignParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

AndroidSignAndAlignParams

-
-
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - JarsignerPath - -
- Signature: string
-
-
- - - - -

Path to jarsigner tool, defaults to assuming it is in your path

- - - -
- - - KeystoreAlias - -
- Signature: string
-
-
- - - - -

(Required) Alias for keystore

- - - -
- - - KeystorePassword - -
- Signature: string
-
-
- - - - -

(Required) Password for keystore

- - - -
- - - KeystorePath - -
- Signature: string
-
-
- - - - -

(Required) Path to keystore used to sign the app

- - - -
- - - MessageDigestAlgorithm - -
- Signature: string
-
-
- - - - -

Specifies the name of the message digest algorithm to use when digesting the entries of a JAR file.

- - - -
- - - SignatureAlgorithm - -
- Signature: string
-
-
- - - - -

Specifies the name of the signature algorithm to use to sign the JAR file.

- - - -
- - - ZipalignPath - -
- Signature: string
-
-
- - - - -

Path to zipalign tool, defaults to assuming it is in your path

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-incrementerversion.html b/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-incrementerversion.html deleted file mode 100644 index b4e3d29..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-incrementerversion.html +++ /dev/null @@ -1,99 +0,0 @@ - - - - - IncrementerVersion - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-iosarchiveparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-iosarchiveparams.html deleted file mode 100644 index 9e0e34f..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-iosarchiveparams.html +++ /dev/null @@ -1,195 +0,0 @@ - - - - - iOSArchiveParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

iOSArchiveParams

-
-

The iOS archive paramater type

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Configuration - -
- Signature: string
-
-
- - - - -

Build configuration, defaults to 'Debug|iPhoneSimulator'

- - - -
- - - MDToolPath - -
- Signature: string
-
-
- - - - -

Path to mdtool, defaults to Xamarin Studio's usual path

- - - -
- - - ProjectName - -
- Signature: string
-
-
- - - - -

Project name within a solution file

- - - -
- - - SolutionPath - -
- Signature: string
-
-
- - - - -

Path to desired solution file. If not provided, mdtool finds the first solution in the current directory. -Although mdtool can take a project file, the archiving seems to fail to work without a solution.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-iosbuildparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-iosbuildparams.html deleted file mode 100644 index 11821b7..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-iosbuildparams.html +++ /dev/null @@ -1,257 +0,0 @@ - - - - - iOSBuildParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

iOSBuildParams

-
-

The iOS build paramater type

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - BuildIpa - -
- Signature: bool
-
-
- - - - -

Indicates if an IPA file should be generated

- - - -
- - - Configuration - -
- Signature: string
-
-
- - - - -

Build configuration, defaults to 'Debug'

- - - -
- - - OutputPath - -
- Signature: string
-
-
- - - - -

Output path for build, defaults to project settings

- - - -
- - - Platform - -
- Signature: string
-
-
- - - - -

Build platform, defaults to 'iPhoneSimulator'

- - - -
- - - ProjectPath - -
- Signature: string
-
-
- - - - -

(Required) Path to solution or project file

- - - -
- - - Properties - -
- Signature: (string * string) list
-
-
- - - - -

Additional MSBuild properties, defaults to empty list

- - - -
- - - Target - -
- Signature: string
-
-
- - - - -

Build target, defaults to Build

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-xamarincomponentrestoreparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-xamarincomponentrestoreparams.html deleted file mode 100644 index 168d7ce..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper-xamarincomponentrestoreparams.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - XamarinComponentRestoreParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

XamarinComponentRestoreParams

-
-

The package restore paramater type

- - -
-

Record Fields

- - - - - - - - - - -
Record FieldDescription
- - - ToolPath - -
- Signature: string
-
-
- - - - -

Path to xamarin-component.exe, defaults to checking tools/xpkg

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper.html deleted file mode 100644 index 213ccc0..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-xamarinhelper.html +++ /dev/null @@ -1,504 +0,0 @@ - - - - - XamarinHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

XamarinHelper

-
-

Contains tasks for building Xamarin.iOS and Xamarin.Android apps

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- AndroidAbiTarget -
- AndroidAbiTargetConfig -
- AndroidPackageAbiParam -
- AndroidPackageParams -

The Android packaging parameter type

- - -
- AndroidSignAndAlignParams -
- IncrementerVersion -
- XamarinComponentRestoreParams -

The package restore paramater type

- - -
- iOSArchiveParams -

The iOS archive paramater type

- - -
- iOSBuildParams -

The iOS build paramater type

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - AllAndroidAbiTargets - -
- Signature: AndroidPackageAbiParam
-
-
- - - - - -
- - - AndroidBuildPackages setParams - -
- Signature: setParams:(AndroidPackageParams -> AndroidPackageParams) -> FileInfo list
-
-
- - - - -

Packages a Xamarin.Android app, returning a multiple FileInfo objects for the unsigned APK files

- -

Parameters

- -
    -
  • setParams - Function used to override the default build parameters
  • -
- - - -
- - - AndroidPackage setParams - -
- Signature: setParams:(AndroidPackageParams -> AndroidPackageParams) -> FileInfo
-
-
- - - - -

Packages a Xamarin.Android app, returning a FileInfo object for the unsigned APK file

- -

Parameters

- -
    -
  • setParams - Function used to override the default build parameters
  • -
- - - -
- - - AndroidPackageDefaults - -
- Signature: AndroidPackageParams
-
-
- - - - -

The default Android packaging parameters

- - - -
- - - AndroidSignAndAlign setParams apkFile - -
- Signature: setParams:(AndroidSignAndAlignParams -> AndroidSignAndAlignParams) -> apkFile:FileInfo -> FileInfo
-
-
- - - - -

Signs and aligns a Xamarin.Android package, returning a FileInfo object for the signed APK file

- -

Parameters

- -
    -
  • setParams - Function used to override the default build parameters
  • -
  • apkFile - FileInfo object for an unsigned APK file to sign and align
  • -
- - - -
- - - AndroidSignAndAlignDefaults - -
- Signature: AndroidSignAndAlignParams
-
-
- - - - -

The default Android signing and aligning parameters

- - - -
- - - AndroidSignAndAlignPackages (...) - -
- Signature: setParams:(AndroidSignAndAlignParams -> AndroidSignAndAlignParams) -> apkFiles:seq<FileInfo> -> seq<FileInfo>
-
-
- - - - -

Signs and aligns multiple Xamarin.Android packages, returning multiple FileInfo objects for the signed APK file

- -

Parameters

- -
    -
  • setParams - Function used to override the default build parameters
  • -
  • apkFiles - FileInfo object for an unsigned APK file to sign and align
  • -
- - - -
- - - iOSArchive setParams - -
- Signature: setParams:(iOSArchiveParams -> iOSArchiveParams) -> unit
-
-
- - - - -

Archive a project using Xamarin's iOS archive tools

- -

Parameters

- -
    -
  • setParams - Function used to override the default archive parameters
  • -
- - - -
- - - iOSArchiveDefaults - -
- Signature: iOSArchiveParams
-
-
- - - - -

The default iOS archive parameters

- - - -
- - - iOSBuild setParams - -
- Signature: setParams:(iOSBuildParams -> iOSBuildParams) -> unit
-
-
- - - - -

Builds a project or solution using Xamarin's iOS build tools

- -

Parameters

- -
    -
  • setParams - Function used to override the default build parameters
  • -
- - - -
- - - iOSBuildDefaults - -
- Signature: iOSBuildParams
-
-
- - - - -

The default iOS build parameters

- - - -
- - - RestoreComponents setParams projectFile - -
- Signature: setParams:(XamarinComponentRestoreParams -> XamarinComponentRestoreParams) -> projectFile:string -> unit
-
-
- - - - -

Restores NuGet packages and Xamarin Components for a project or solution

- -

Parameters

- -
    -
  • setParams - Function used to override the default package restore parameters
  • -
- - - -
- - - XamarinComponentRestoreDefaults - -
- Signature: XamarinComponentRestoreParams
-
-
- - - - -

The default package restore parameters

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-xcopyhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-xcopyhelper.html deleted file mode 100644 index 6fb8f98..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-xcopyhelper.html +++ /dev/null @@ -1,141 +0,0 @@ - - - - - XCopyHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

XCopyHelper

-
-

Contains a task to use XCOPY on Windows.

- - -
- - - -

Functions and values

- - - - - - - - - - -
Function or valueDescription
- - - XCopy source destination - -
- Signature: source:string -> destination:string -> unit
-
-
- - - - -

Executes a XCopy command

- -

Parameters

- -
    -
  • source - The source directory
  • -
  • destination - The target directory
  • -
- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-xdthelper-fakexmltransformationlogger.html b/packages/FAKE.4.11.3/docs/apidocs/fake-xdthelper-fakexmltransformationlogger.html deleted file mode 100644 index 351ff7f..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-xdthelper-fakexmltransformationlogger.html +++ /dev/null @@ -1,128 +0,0 @@ - - - - - FakeXmlTransformationLogger - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-xdthelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-xdthelper.html deleted file mode 100644 index ec7ea2a..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-xdthelper.html +++ /dev/null @@ -1,196 +0,0 @@ - - - - - XDTHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

XDTHelper

-
-

Contains functions used to transform config (or any XML) files using Microsoft's XML Document Transformations.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- FakeXmlTransformationLogger -

Integrates XDT logging into FAKE logging.

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - TransformFile (...) - -
- Signature: inXmlFile:string -> transformFile:string -> outXmlFile:string -> unit
-
-
- - - - -

Reads XML file (typically a config file), makes changes according to XDT transform syntax, saves result.

- - - -
- - - TransformFilesWithConfigName (...) - -
- Signature: configName:string -> files:FileIncludes -> unit
-
-
- - - - -

Modifies XML files in place using an XDT file named by inserting a .configName in between each filename and .extension.

- - - -
- - - TransformFileWithConfigName (...) - -
- Signature: configName:string -> xmlFile:string -> unit
-
-
- - - - -

Modifies an XML file in place using an XDT file named by inserting a .configName in between the filename and .extension.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-xmlhelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-xmlhelper.html deleted file mode 100644 index 030564f..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-xmlhelper.html +++ /dev/null @@ -1,695 +0,0 @@ - - - - - XMLHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

XMLHelper

-
-

Contains functions to read and write XML files.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - DocElement doc - -
- Signature: doc:XmlDocument -> XmlElement
-
-
- - - - -

Gets the DocumentElement of the XmlDocument

- - - -
- - - getAttribute name node - -
- Signature: name:string -> node:'?7387 -> string
- Type parameters: '?7387
-
- - - - -

Gets the attribute with the given name from the given XmlNode

- - - -
- - - getChilds node - -
- Signature: node:'?7389 -> seq<XmlNode>
- Type parameters: '?7389
-
- - - - -

Gets a sequence of all child nodes for the given XmlNode

- - - -
- - - getSubNode name node - -
- Signature: name:string -> node:XmlNode -> XmlNode
-
-
- - - - -

Gets the first sub node with the given name from the given XmlNode

- - - -
- - - parse name f node - -
- Signature: name:string -> f:('?7392 -> '?7393) -> node:'?7392 -> '?7393
- Type parameters: '?7392, '?7393
-
- - - - -

Parses a XmlNode

- - - -
- - - parseSubNode name f - -
- Signature: name:string -> f:(XmlNode -> '?7395) -> XmlNode -> '?7395
- Type parameters: '?7395
-
- - - - -

Parses a XML subnode

- - - -
- - - XmlAttribute name value writer - -
- Signature: name:string -> value:'?7384 -> writer:XmlTextWriter -> XmlTextWriter
- Type parameters: '?7384
-
- - - - -

Writes an XML attribute to current element of the given XmlTextWriter

- - - -
- - - XmlCDataElement elementName data writer - -
- Signature: elementName:string -> data:string -> writer:XmlTextWriter -> XmlTextWriter
-
-
- - - - -

Writes an CData element to the given XmlTextWriter

- - - -
- - - XmlComment comment writer - -
- Signature: comment:string -> writer:XmlTextWriter -> XmlTextWriter
-
-
- - - - -

Writes an XML comment to the given XmlTextWriter

- - - -
- - - XMLDoc text - -
- Signature: text:string -> XmlDocument
-
-
- - - - -

Loads the given text into a XmlDocument

- - - -
- - - XmlEndElement writer - -
- Signature: writer:XmlTextWriter -> XmlTextWriter
-
-
- - - - -

Writes an XML end element to the given XmlTextWriter

- - - -
- - - XmlPoke fileName xpath value - -
- Signature: fileName:string -> xpath:string -> value:string -> unit
-
-
- - - - -

Replaces text in a XML file at the location specified by a XPath expression.

- - - -
- - - XmlPokeInnerText (...) - -
- Signature: fileName:string -> xpath:string -> innerTextValue:string -> unit
-
-
- - - - -

Replaces the inner text of an xml node in a XML file at the location specified by a XPath expression.

- - - -
- - - XmlPokeInnerTextNS (...) - -
- Signature: fileName:string -> namespaces:seq<string * string> -> xpath:string -> innerTextValue:string -> unit
-
-
- - - - -

Replaces inner text of an xml node in a XML file at the location specified by a XPath expression, with support for namespaces.

- - - -
- - - XmlPokeNS (...) - -
- Signature: fileName:string -> namespaces:seq<string * string> -> xpath:string -> value:string -> unit
-
-
- - - - -

Replaces text in a XML file at the location specified by a XPath expression, with support for namespaces.

- - - -
- - - XMLRead (...) - -
- Signature: failOnError:bool -> xmlFileName:string -> nameSpace:string -> prefix:string -> xPath:string -> seq<string>
-
-
- - - - -

Reads a value from a XML document using a XPath

- - - -
- - - XMLRead_Int (...) - -
- Signature: failOnError:bool -> xmlFileName:string -> nameSpace:string -> prefix:string -> xPath:string -> bool * int
-
-
- - - - -

Reads a value from a XML document using a XPath -Returns if the value is an int and the value

- - - -
- - - XmlStartElement name writer - -
- Signature: name:string -> writer:XmlTextWriter -> XmlTextWriter
-
-
- - - - -

Writes an XML start element to the given XmlTextWriter

- - - -
- - - XmlTransform stylesheetUri fileName - -
- Signature: stylesheetUri:string -> fileName:string -> unit
-
-
- - - - -

Transforms a XML file using a XSL stylesheet file.

- -

Parameters

- -
    -
  • stylesheetUri - The Uri for the XSL stylesheet file.
  • -
  • fileName - The XML file to transform.
  • -
- - - -
- - - XmlWriter fileName - -
- Signature: fileName:string -> XmlTextWriter
-
-
- - - - -

Creates a XmlWriter which writes to the given file name

- - - -
- - - XPathReplace xpath value doc - -
- Signature: xpath:string -> value:string -> doc:XmlDocument -> XmlDocument
-
-
- - - - -

Replaces text in the XML document specified by a XPath expression.

- - - -
- - - XPathReplaceInnerText (...) - -
- Signature: xpath:string -> innerTextValue:string -> doc:XmlDocument -> XmlDocument
-
-
- - - - -

Replaces the inner text of an xml node in the XML document specified by a XPath expression.

- - - -
- - - XPathReplaceInnerTextNS (...) - -
- Signature: xpath:string -> innerTextValue:string -> namespaces:'?7407 -> doc:XmlDocument -> XmlDocument
- Type parameters: '?7407
-
- - - - -

Replaces inner text in a XML document specified by a XPath expression, with support for namespaces.

- - - -
- - - XPathReplaceNS (...) - -
- Signature: xpath:string -> value:string -> namespaces:'?7405 -> doc:XmlDocument -> XmlDocument
- Type parameters: '?7405
-
- - - - -

Replaces text in a XML document specified by a XPath expression, with support for namespaces.

- - - -
- - - XPathValue xpath namespaces doc - -
- Signature: xpath:string -> namespaces:'?7401 -> doc:XmlDocument -> string
- Type parameters: '?7401
-
- - - - -

Selects a xml node value via XPath from the given document

- - - -
- - - XslTransform xsl doc - -
- Signature: xsl:XslCompiledTransform -> doc:XmlDocument -> XmlDocument
-
-
- - - - -

Transforms a XmlDocument using a XslCompiledTransform.

- -

Parameters

- -
    -
  • xsl - The XslCompiledTransform which should be applied.
  • -
  • doc - The XmlDocument to transform.
  • -
- - - -
- - - XslTransformer text - -
- Signature: text:string -> XslCompiledTransform
-
-
- - - - -

Loads the given text into a XslCompiledTransform.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-xpkghelper-xpkgparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-xpkghelper-xpkgparams.html deleted file mode 100644 index b8b8114..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-xpkghelper-xpkgparams.html +++ /dev/null @@ -1,398 +0,0 @@ - - - - - xpkgParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

xpkgParams

-
-

Parameter type for xpkg tasks

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Details - -
- Signature: string
-
-
- - - - - -
- - - GettingStarted - -
- Signature: string
-
-
- - - - - -
- - - Icons - -
- Signature: string list
-
-
- - - - - -
- - - Libraries - -
- Signature: (string * string) list
-
-
- - - - - -
- - - License - -
- Signature: string
-
-
- - - - - -
- - - OutputPath - -
- Signature: string
-
-
- - - - - -
- - - Package - -
- Signature: string
-
-
- - - - - -
- - - Project - -
- Signature: string
-
-
- - - - - -
- - - Publisher - -
- Signature: string
-
-
- - - - - -
- - - Samples - -
- Signature: (string * string) list
-
-
- - - - - -
- - - Summary - -
- Signature: string
-
-
- - - - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - - -
- - - Version - -
- Signature: string
-
-
- - - - - -
- - - Website - -
- Signature: string
-
-
- - - - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-xpkghelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-xpkghelper.html deleted file mode 100644 index fe309cf..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-xpkghelper.html +++ /dev/null @@ -1,247 +0,0 @@ - - - - - XpkgHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

XpkgHelper

-
-

Contains tasks to create packages in Xamarin's xpkg format

- - -
- - -

Nested types and modules

-
- - - - - - - - - - -
TypeDescription
- xpkgParams -

Parameter type for xpkg tasks

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - XpkgDefaults () - -
- Signature: unit -> xpkgParams
-
-
- - - - -

Creates xpkg default parameters

- - - -
- - - xpkgPack setParams - -
- Signature: setParams:(xpkgParams -> xpkgParams) -> unit
-
-
- - - - -

Creates a new xpkg package based on the package file name

- -

Sample

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-21: 
-22: 
-
Target "PackageXamarinDistribution" (fun _ -> 
-     xpkgPack (fun p ->
-         {p with
-             ToolPath = xpkgExecutable;
-             Package = "Portable.Licensing";
-             Version = assemblyFileVersion;
-             OutputPath = publishDir
-             Project = "Portable.Licensing"
-             Summary = "Portable.Licensing is a cross platform licensing tool"
-             Publisher = "Nauck IT KG"
-             Website = "http://dev.nauck-it.de"
-             Details = "./Xamarin/Details.md"
-             License = "License.md"
-             GettingStarted = "./Xamarin/GettingStarted.md"
-             Icons = ["./Xamarin/Portable.Licensing_512x512.png"
-                      "./Xamarin/Portable.Licensing_128x128.png"]
-             Libraries = ["mobile", "./Distribution/lib/Portable.Licensing.dll"]
-             Samples = ["Android Sample.", "./Samples/Android/Android.Sample.sln"
-                        "iOS Sample.", "./Samples/iOS/iOS.Sample.sln"]
-         }
-     )
- )
-
- - - -
- - - xpkgValidate setParams - -
- Signature: setParams:(xpkgParams -> xpkgParams) -> unit
-
-
- - - - -

Validates a xpkg package based on the package file name

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-xunit2helper-paralleloption.html b/packages/FAKE.4.11.3/docs/apidocs/fake-xunit2helper-paralleloption.html deleted file mode 100644 index fc21b84..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-xunit2helper-paralleloption.html +++ /dev/null @@ -1,186 +0,0 @@ - - - - - ParallelOption - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ParallelOption

-
-

DEPRECATED.

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - All - -
- Signature: ParallelOption
- Modifiers: static
-
-
- - - - - -
- - - Assemblies - -
- Signature: ParallelOption
- Modifiers: static
-
-
- - - - - -
- - - Collections - -
- Signature: ParallelOption
- Modifiers: static
-
-
- - - - - -
- - - None - -
- Signature: ParallelOption
- Modifiers: static
-
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-xunit2helper-xunit2errorlevel.html b/packages/FAKE.4.11.3/docs/apidocs/fake-xunit2helper-xunit2errorlevel.html deleted file mode 100644 index d2923f6..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-xunit2helper-xunit2errorlevel.html +++ /dev/null @@ -1,103 +0,0 @@ - - - - - XUnit2ErrorLevel - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-xunit2helper-xunit2params.html b/packages/FAKE.4.11.3/docs/apidocs/fake-xunit2helper-xunit2params.html deleted file mode 100644 index 720c421..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-xunit2helper-xunit2params.html +++ /dev/null @@ -1,495 +0,0 @@ - - - - - XUnit2Params - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

XUnit2Params

-
-

DEPRECATED. -The xUnit parameter type

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - Appveyor - -
- Signature: bool
-
-
- - - - -

forces AppVeyor CI mode (normally auto-detected)

- - - -
- - - ConfigFile - -
- Signature: string
-
-
- - - - -

The file name of the config file (optional).

- - - -
- - - ErrorLevel - -
- Signature: XUnit2ErrorLevel
-
-
- - - - -

Test runner error level. Option which allows to specify if an xUnit error should break the build.

- - - -
- - - ExcludeTraits - -
- Signature: (string * string) option
-
-
- - - - -

Exclude named traits with comma separated values

- - - -
- - - HtmlOutput - -
- Signature: bool
-
-
- - - - -

output results to HTML file

- - - -
- - - IncludeTraits - -
- Signature: (string * string) option
-
-
- - - - -

Include named traits with comma separated values

- - - -
- - - MaxThreads - -
- Signature: int
-
-
- - - - -

maximum thread count for collection parallelization -0 - run with unbounded thread count

- -
-

0 - limit task thread pool size to 'count'

-
- - - -
- - - OutputDir - -
- Signature: string
-
-
- - - - -

output directory

- - - -
- - - Parallel - -
- Signature: ParallelOption
-
-
- - - - -

set parallelization based on option - none - turn off all parallelization - collections - only parallelize collections - assemblies - only parallelize assemblies - all - parallelize assemblies & collections

- - - -
- - - ShadowCopy - -
- Signature: bool
-
-
- - - - -

Shadow copy

- - - -
- - - Silent - -
- Signature: bool
-
-
- - - - -

Output running test count

- - - -
- - - Teamcity - -
- Signature: bool
-
-
- - - - -

forces TeamCity mode (normally auto-detected)

- - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - -

If the timeout is reached the xUnit task will be killed. Default is 5 minutes.

- - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - -

The path to the xunit.console.exe - FAKE will scan all subfolders to find it automatically.

- - - -
- - - Wait - -
- Signature: bool
-
-
- - - - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - -

The working directory (optional).

- - - -
- - - XmlOutput - -
- Signature: bool
-
-
- - - - -

output results to xUnit.net v2 style XML file

- - - -
- - - XmlOutputV1 - -
- Signature: bool
-
-
- - - - -

output results to xUnit.net v1 style XML file

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-xunit2helper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-xunit2helper.html deleted file mode 100644 index 4258120..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-xunit2helper.html +++ /dev/null @@ -1,248 +0,0 @@ - - - - - XUnit2Helper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

XUnit2Helper

-
-

DEPRECATED. See Fake.Testing.XUnit2.

- -

Contains tasks to run xUnit unit tests.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - - - - - -
TypeDescription
- ParallelOption -

DEPRECATED.

- - -
- XUnit2ErrorLevel -

DEPRECATED. -Option which allows to specify if an xUnit error should break the build.

- - -
- XUnit2Params -

DEPRECATED. -The xUnit parameter type

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - empty2Trait - -
- Signature: (string * string) option
-
-
- - - - -

DEPRECATED. -The xUnit default parameters

- - - -
- - - xUnit2 setParams assemblies - -
- Signature: setParams:(XUnit2Params -> XUnit2Params) -> assemblies:seq<string> -> unit
-
-
- - - - -

DEPRECATED. See Fake.Testing.XUnit2.xUnit2.

- -

Runs xUnit unit tests in the given assemblies via the given xUnit runner. -Will fail if the runner terminates with non-zero exit code for any of the assemblies. -Offending assemblies will be listed in the error message.

- -

The xUnit runner terminates with a non-zero exit code if any of the tests -in the given assembly fail.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default XUnitParams value.
  • -
  • assemblies - Sequence of one or more assemblies containing xUnit unit tests.
  • -
- -

Sample usage

- - - - -
1: 
-2: 
-3: 
-4: 
-
Target "Test" (fun _ ->
-    !! (testDir + @"\xUnit.Test.*.dll")
-      |> xUnit2 (fun p -> {p with OutputDir = testDir })
-)
-
- - - -
- - - XUnit2Defaults - -
- Signature: XUnit2Params
-
-
- - - - -

DEPRECATED.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-xunithelper-xuniterrorlevel.html b/packages/FAKE.4.11.3/docs/apidocs/fake-xunithelper-xuniterrorlevel.html deleted file mode 100644 index 05407a6..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-xunithelper-xuniterrorlevel.html +++ /dev/null @@ -1,103 +0,0 @@ - - - - - XUnitErrorLevel - FAKE - F# Make - - - - - - - - - - - - - - - - - - Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-xunithelper-xunitparams.html b/packages/FAKE.4.11.3/docs/apidocs/fake-xunithelper-xunitparams.html deleted file mode 100644 index 5eb2755..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-xunithelper-xunitparams.html +++ /dev/null @@ -1,384 +0,0 @@ - - - - - XUnitParams - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

XUnitParams

-
-

DEPRECATED. -The xUnit parameter type

- - -
-

Record Fields

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Record FieldDescription
- - - ConfigFile - -
- Signature: string
-
-
- - - - -

The file name of the config file (optional).

- - - -
- - - ErrorLevel - -
- Signature: XUnitErrorLevel
-
-
- - - - -

Test runner error level. Option which allows to specify if an xUnit error should break the build.

- - - -
- - - ExcludeTraits - -
- Signature: (string * string) option
-
-
- - - - -

Exclude named traits with comma separated values

- - - -
- - - HtmlOutput - -
- Signature: bool
-
-
- - - - -

If set to true a HTML output file will be generated.

- - - -
- - - IncludeTraits - -
- Signature: (string * string) option
-
-
- - - - -

Include named traits with comma separated values

- - - -
- - - NUnitXmlOutput - -
- Signature: bool
-
-
- - - - -

If set to true a HTML output file will be generated in NUnit format.

- - - -
- - - OutputDir - -
- Signature: string
-
-
- - - - -

The output directory. It's the current directoy if nothing else is specified.

- - - -
- - - ShadowCopy - -
- Signature: bool
-
-
- - - - -

If set to true xUnit will run in ShadowCopy mode.

- - - -
- - - TimeOut - -
- Signature: TimeSpan
-
-
- - - - -

If the timeout is reached the xUnit task will be killed. Default is 5 minutes.

- - - -
- - - ToolPath - -
- Signature: string
-
-
- - - - -

The path to the xunit.console.clr4.exe - FAKE will scan all subfolders to find it automatically.

- - - -
- - - Verbose - -
- Signature: bool
-
-
- - - - -

If set to true xUnit will generate verbose output.

- - - -
- - - WorkingDir - -
- Signature: string
-
-
- - - - -

The working directory (optional).

- - - -
- - - XmlOutput - -
- Signature: bool
-
-
- - - - -

If set to true XML output will be generated.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-xunithelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-xunithelper.html deleted file mode 100644 index c124bfc..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-xunithelper.html +++ /dev/null @@ -1,239 +0,0 @@ - - - - - XUnitHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

XUnitHelper

-
-

DEPRECATED. See Fake.Testing.XUnit.

- -

Contains tasks to run xUnit unit tests.

- - -
- - -

Nested types and modules

-
- - - - - - - - - - - - - - -
TypeDescription
- XUnitErrorLevel -

DEPRECATED. -Option which allows to specify if an xUnit error should break the build.

- - -
- XUnitParams -

DEPRECATED. -The xUnit parameter type

- - -
- -
- -

Functions and values

- - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - emptyTrait - -
- Signature: (string * string) option
-
-
- - - - -

DEPRECATED. -The xUnit default parameters

- - - -
- - - xUnit setParams assemblies - -
- Signature: setParams:(XUnitParams -> XUnitParams) -> assemblies:seq<string> -> unit
-
-
- - - - -

DEPRECATED. See Fake.Testing.XUnit.xUnit.

- -

Runs xUnit unit tests in the given assemblies via the given xUnit runner. -Will fail if the runner terminates with non-zero exit code for any of the assemblies. -Offending assemblies will be listed in the error message.

- -

The xUnit runner terminates with a non-zero exit code if any of the tests -in the given assembly fail.

- -

Parameters

- -
    -
  • setParams - Function used to manipulate the default XUnitParams value.
  • -
  • assemblies - Sequence of one or more assemblies containing xUnit unit tests.
  • -
- -

Sample usage

- - - - -
1: 
-2: 
-3: 
-4: 
-
Target "Test" (fun _ ->
-    !! (testDir + @"\xUnit.Test.*.dll")
-      |> xUnit (fun p -> {p with OutputDir = testDir })
-)
-
- - - -
- - - XUnitDefaults - -
- Signature: XUnitParams
-
-
- - - - -

DEPRECATED.

- - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/fake-ziphelper.html b/packages/FAKE.4.11.3/docs/apidocs/fake-ziphelper.html deleted file mode 100644 index fe74089..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/fake-ziphelper.html +++ /dev/null @@ -1,406 +0,0 @@ - - - - - ZipHelper - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

ZipHelper

-
-

This module contains helper function to create and extract zip archives.

- - -
- - - -

Functions and values

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Function or valueDescription
- - - CreateZip (...) - -
- Signature: workingDir:string -> fileName:string -> comment:string -> level:int -> flatten:bool -> files:seq<string> -> unit
-
-
- - - - -

Creates a zip file with the given files

- -

Parameters

- -
    -
  • workingDir - The relative dir of the zip files. Use this parameter to influence directory structure within zip file.
  • -
  • fileName - The fileName of the resulting zip file.
  • -
  • comment - A comment for the resulting zip file.
  • -
  • level - The compression level.
  • -
  • flatten - If set to true then all subfolders are merged into the root folder.
  • -
  • files - A sequence with files to zip.
  • -
- - - -
- - - CreateZipOfIncludes (...) - -
- Signature: fileName:string -> comment:string -> level:int -> files:seq<string * FileIncludes> -> unit
-
-
- - - - -

Creates a zip file with the given files.

- -

Parameters

- -
    -
  • fileName - The file name of the resulting zip file.
  • -
  • comment - A comment for the resulting zip file.
  • -
  • level - The compression level.
  • -
  • files - A sequence of target folders and files to include relative to their base directory.
  • -
- - - -
- - - DefaultZipLevel - -
- Signature: int
-
-
- - - - -

The default zip level

- - - -
- - - Unzip target fileName - -
- Signature: target:string -> fileName:string -> unit
-
-
- - - - -

Unzips a file with the given file name.

- -

Parameters

- -
    -
  • target - The target directory.
  • -
  • fileName - The file name of the zip file.
  • -
- - - -
- - - UnzipFirstMatchingFileInMemory (...) - -
- Signature: predicate:(ZipEntry -> bool) -> zipFileName:string -> string
-
-
- - - - -

Unzips a single file from the archive with the given file name.

- -

Parameters

- -
    -
  • predicate - The predictae for the searched file in the archive.
  • -
  • zipFileName - The file name of the zip file.
  • -
- - - -
- - - UnzipSingleFileInMemory (...) - -
- Signature: fileToUnzip:string -> zipFileName:string -> string
-
-
- - - - -

Unzips a single file from the archive with the given file name.

- -

Parameters

- -
    -
  • fileToUnzip - The file inside the archive.
  • -
  • zipFileName - The file name of the zip file.
  • -
- - - -
- - - Zip workingDir fileName files - -
- Signature: workingDir:string -> fileName:string -> files:seq<string> -> unit
-
-
- - - - -

Creates a zip file with the given files.

- -

Parameters

- -
    -
  • workingDir - The relative dir of the zip files. Use this parameter to influence directory structure within zip file.
  • -
  • fileName - The file name of the resulting zip file.
  • -
  • files - A sequence with files to zip.
  • -
- - - -
- - - ZipFile fileName targetFileName - -
- Signature: fileName:string -> targetFileName:string -> unit
-
-
- - - - -

Creates a zip file with the given file.

- -

Parameters

- -
    -
  • fileName - The file name of the resulting zip file.
  • -
  • targetFileName - The file to zip.
  • -
- - - -
- - - ZipOfIncludes fileName files - -
- Signature: fileName:string -> files:seq<string * FileIncludes> -> unit
-
-
- - - - -

Creates a zip file with the given files.

- -

Parameters

- -
    -
  • fileName - The file name of the resulting zip file.
  • -
  • files - A sequence of target folders and files to include relative to their base directory.
  • -
- -

Sample

- -

The following sample creates a zip file containing the files from the two target folders and FileIncludes.

- -
    -
  • The files from the first FileInclude will be placed in the root of the zip file.
  • -
  • The files from the second FileInclude will be placed under the directory app_data\jobs\continuous\MyWebJob in the zip file.
  • -
- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-
Target "Zip" (fun _ ->
-    [   "", !! "MyWebApp/*.html"
-            ++ "MyWebApp/bin/**/*.dll"
-            ++ "MyWebApp/bin/**/*.pdb"
-            ++ "MyWebApp/fonts/**"
-            ++ "MyWebApp/img/**"
-            ++ "MyWebApp/js/**"
-            -- "MyWebApp/js/_references.js"
-            ++ "MyWebApp/web.config"
-        @"app_data\jobs\continuous\MyWebJob", !! "MyWebJob/bin/Release/*.*"
-    ]
-    |> ZipOfIncludes (sprintf @"bin\MyWebApp.%s.zip" buildVersion)
-)
-
- -
val sprintf : format:Printf.StringFormat<'T> -> 'T

Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.sprintf
- - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/index.html b/packages/FAKE.4.11.3/docs/apidocs/index.html deleted file mode 100644 index e139d12..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/index.html +++ /dev/null @@ -1,1366 +0,0 @@ - - - - - Namespaces - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - -

FAKE - F# Make

- -

Fake Namespace

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ModuleDescription
- AdditionalSyntax -

Provides functions and operators to deal with FAKE targets and target dependencies.

- - -
- AndroidPublisher -
- AppVeyor -

Contains code to configure FAKE for AppVeyor integration

- - -
- ArchiveHelper -

Provides utility tasks for storing and compressing files in archives.

- - -
- AssemblyInfoFile -

Contains tasks to generate AssemblyInfo files for C# and F#. -There is also a tutorial about the AssemblyInfo tasks available.

- - -
- AssemblyInfoHelper -

Generates an AssemblyInfo file

- - -
- AzureHelper -

Contains tasks to control the local Azure Emulator

- - -
- Boot -

Implements support for boostrapping FAKE scripts. A bootstrapping -build.fsx script executes twice (in two stages), allowing to -download dependencies with NuGet and do other preparatory work in -the first stage, and have these dependencies available in the -second stage.

- - -
- BuildServerHelper -

Contains functions which allow build scripts to interact with a build server.

- - -
- CacheHelper -

Contains functions which allows to deal with a cache.

- - -
- ChangeWatcher -

This module contains helpers to react to file system events.

- - -
- ConfigurationHelper -

Contains functions which allow to read and write config files.

- - -
- CscHelper -

Contains tasks to compile C# source files with CSC.EXE (C# Compiler).

- - -
- DocuHelper -

Contains helper functions to run the XML documentation tool "docu".

- - -
- DotCover -

Contains a task which can be used to run DotCover on .NET assemblies.

- - -
- DynamicsCRMHelper -
- DynamicsNav -

Contains helper function which allow to interact with Microsoft Dynamics NAV.

- - -
- DynamicsNavFile -

Provides an abstraction over Dynamics NAV object files.

- - -
- EnvironmentHelper -

This module contains functions which allow to read and write environment variables and build parameters

- - -
- FSIHelper -

Contains helper functions which allow to interact with the F# Interactive.

- - -
- FSharpFormatting -

Contains tasks which allow to run FSharp.Formatting for generating documentation.

- - -
- FileHelper -

Contains helper function which allow to deal with files and directories.

- - -
- FileSystem -

This module contains a file pattern globbing implementation.

- - -
- FileSystemHelper -

Contains helpers which allow to interact with the file system.

- - -
- FileUtils -

Shell-like functions. Similar to Ruby's FileUtils.

- - -
- FixieHelper -

Contains tasks to run Fixie unit tests.

- - -
- FscHelper -

Contains tasks to compiles F# source file with the FSharp.Compiler.Service. -There is also a tutorial about the F# compiler tasks available.

- - -
- FtpHelper -

Contains helpers which allow to upload a whole folder/specific file into a FTP Server. -Uses Passive Mode FTP and handles all files as binary (and not ASCII). -Assumes direct network connectivity to destination FTP server (not via a proxy). -Does not support FTPS and SFTP.

- - -
- FxCopHelper -

Contains a task which can be used to run FxCop on .NET assemblies. There is also a tutorial for this task available.

- - -
- GACHelper -

This module contains helper function for the GAC

- - -
- Globbing -

This module contains a file pattern globbing implementation.

- - -
- HTMLHelpWorkShopHelper -

Contains a task which allows to use HTML Help Workshop in order to compile a help project.

- - -
- HipChatNotificationHelper -

Contains a task to send notification messages to a HipChat room

- - -
- HockeyAppHelper -

Contains tasks to interact with HockeyApp

- - -
- ILMergeHelper -

Contains task a task which allows to merge .NET assemblies with ILMerge.

- - -
- MSBuildHelper -

Contains tasks which allow to use MSBuild (or xBuild on Linux/Unix) to build .NET project files or solution files.

- - -
- MSIHelper -

Contains tasks which allow to run msiexec in order to install or uninstall msi files.

- - -
- MSTest -

Contains tasks to run MSTest unit tests.

- - -
- MSpecHelper -

Contains a task to run machine.specifications tests.

- - -
- MageHelper -

Contains helper functions which allow FAKE to call the Manifest Generation and Editing Tool, in short 'MAGE'. -The intentional use is the creation of a clickonce application.

- - -
- MessageHelper -

Contains helper function which allow FAKE to interact with other applications via message files.

- - -
- MsBuildLogger -

Contains Logger implementations for MsBuild.

- - -
- NCoverHelper -

Contains a task which can be used to run NCover on .NET assemblies.

- - -
- NDepend -

Contains a task which allows to run NDepend on .NET project files.

- - -
- NGenHelper -

This module contains helper function for the ngen.exe

- - -
- NUnitCommon -

Contains types and utility functions relaited to running NUnit unit tests.

- - -
- NUnitParallel -

Contains tasks to run NUnit unit tests in parallel.

- - -
- NUnitSequential -

Contains tasks to run NUnit unit tests.

- - -
- NUnitXml -

Contains types and functions for working with NUnit unit tests result xml.

- - -
- NpmHelper -

Contains function to run npm tasks

- - -
- NuGetHelper -

Contains helper functions and task which allow to inspect, create and publish NuGet packages. -There is also a tutorial about nuget package creating available.

- - -
- OctoTools -

Contains tasks which can be used for automated deployment via Octopus Deploy. -There is also a tutorial about the Octopus deployment helper available.

- - -
- OpenCoverHelper -

Contains a task which can be used to run OpenCover on .NET assemblies.

- - -
- Paket -

Contains helper functions and task which allow to inspect, create and publish NuGet packages with Paket.

- - -
- PermissionsHelper -

Contains functions which allow to deal with permissions.

- - -
- ProcessHelper -

Contains functions which can be used to start other tools.

- - -
- ProcessTestRunner -

Allows to execute processes as unit tests.

- - -
- REST -

Contains functions to execute typical HTTP/REST calls.

- - -
- RaygunHelper -

Enables deployment tracking using Raygun.io

- -

Thin wrapper around the Raygun HTTP deployment API

- - -
- RegAsmHelper -

Contains a task which can be used to run regasm .NET assembly

- - -
- RegistryHelper -

Contains functions which allow to read and write information from/to the registry.

- - -
- ReleaseNotesHelper -

Contains helpers which allow to parse Release Notes text files. Either "simple" or "complex" format is accepted.

- - -
- ReportGeneratorHelper -

Contains a task which can be used to run ReportGenerator, -which converts XML reports generated by PartCover, OpenCover or NCover into a readable report in various formats.

- - -
- RestorePackageHelper -

Contains tasks which allow to restore NuGet packages from a NuGet package feed like nuget.org. -There is also a tutorial about nuget package restore available.

- - -
- RoboCopyHelper -

Contains a task to use robocopy on Windows.

- - -
- RoundhouseHelper -

Contains tasks to run RoundhousE database migrations.

- - -
- SCPHelper -

Conatins a task which allows to perform file copies using SCP, which is based on the Secure Shell (SSH) protocol.

- - -
- SemVerHelper -

Contains helpers which allow to deal with Semantic Versioning (SemVer).

- - -
- ServiceControllerHelpers -

Contains tasks which allow to control NT services.

- - -
- SignToolHelper -

Contains a task to sign assemblies using the SignTool.

- - -
- SpecFlowHelper -

Contains a task which allows to run SpecFlow tests.

- - -
- Squirrel -

Contains types and utility functions related to creating Squirrel installer.

- - -
- StringHelper -

Contains basic functions for string manipulation.

- - -
- StrongNamingHelper -

This module contains helper function for Microsoft's sn.exe

- - -
- SxsHelper -

Module that enables creating and embedding Side-by-Side interop -manifests for registration free deployment of Com-.net interop projects

- - -
- TargetHelper -

Contains infrastructure code and helper functions for FAKE's target feature.

- - -
- TaskRunnerHelper -

Contains a helper which can be used to implement timeouts and retries.

- - -
- TeamCityHelper -

Contains helper functions which allow FAKE to communicate with a TeamCity agent

- - -
- TeamCityRESTHelper -

Contains functions which allow FAKE to interact with the TeamCity REST API.

- - -
- TemplateHelper -

Contains basic templating functions. Used in other helpers.

- - -
- TestFlightHelper -

Contains tasks to upload apps to TestFlight

- - -
- TraceHelper -

This module contains function which allow to trace build output

- - -
- TraceListener -

Defines default listeners for build output traces

- - -
- TypeScript -

Contains code to call the typescript compiler. There is also a tutorial for this task available.

- - -
- UnitTestCommon -

This module contains types and functions that are common for unit test helpers.

- - -
- UnitTestHelper -

This module contains functions which allow to report unit test results to build servers.

- - -
- UserInputHelper -

This module contains functions which allow to interactively input values

- - -
- VSSHelper -

Contains helper functions for Microsoft Visual SourceSafe

- - -
- VSTest -

Contains tasks to run VSTest unit tests.

- - -
- Vb6Helper -

Enables building of Visual Basic 6 projects -Also includes a do-it-all function that will embed interop -side-by-side manifest to executables from Vb6 using -functions from the Side-by-side helper module

- - -
- VersionHelper -
- WiXHelper -

Contains tasks to create msi installers using the WiX toolset

- - -
- XCopyHelper -

Contains a task to use XCOPY on Windows.

- - -
- XDTHelper -

Contains functions used to transform config (or any XML) files using Microsoft's XML Document Transformations.

- - -
- XMLHelper -

Contains functions to read and write XML files.

- - -
- XUnit2Helper -

DEPRECATED. See Fake.Testing.XUnit2.

- -

Contains tasks to run xUnit unit tests.

- - -
- XUnitHelper -

DEPRECATED. See Fake.Testing.XUnit.

- -

Contains tasks to run xUnit unit tests.

- - -
- XamarinHelper -

Contains tasks for building Xamarin.iOS and Xamarin.Android apps

- - -
- XpkgHelper -

Contains tasks to create packages in Xamarin's xpkg format

- - -
- ZipHelper -

This module contains helper function to create and extract zip archives.

- - -
- -
-

Fake.Azure Namespace

-
- - - - - - - - - - - - - - -
ModuleDescription
- CloudServices -

Contains tasks to package Azure Cloud Services.

- - -
- WebJobs -

Contains tasks to package and deploy Azure Web Jobs via the Kudu Zip controller

- - -
- -
-

Fake.CMakeSupport Namespace

-
- - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- CMakeBuildParams -

The CMakeBuild parameter type.

- - -
- CMakeGenerateParams -

The CMakeGenerate parameter type.

- - -
- CMakeValue -

The possible variable value types for CMake variables.

- - -
- CMakeVariable -

A CMake variable.

- - -
- - - - - - - - - - -
ModuleDescription
- CMake -

Contains tasks which allow to use CMake to build CMakeLists files. -See Samples/CMakeSupport for usage examples.

- - -
- -
-

Fake.Git Namespace

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ModuleDescription
- Branches -

Contains helper functions which allow to deal with git branches.

- - -
- CommandHelper -

Contains helpers which allow to interact with git via the command line.

- - -
- Commit -

Contains helper functions which allow to commit to git repositories.

- - -
- CommitMessage -

Contains helper functions which allow to get and set the git commit message.

- - -
- FileStatus -

Contains helper functions which can be used to retrieve file status information from git.

- - -
- Information -

Contains helper functions which can be used to retrieve status information from git.

- - -
- Merge -

Contains helper functions which allow to deal with git merge.

- - -
- Rebase -

Contains helper functions which allow to deal with git rebase.

- - -
- Repository -

Contains functions which allow basic operations on git repositories. -All operations assume that the CommandHelper can find git.exe.

- - -
- Reset -

Contains helper functions which allow to deal with git reset.

- - -
- SHA1 -

Contains functions which allow the SHA1 of a file with git and without it.

- - -
- SanityChecks -

Contains helper function which can be used for sanity checks.

- - -
- Staging -

Contains helper functions which allow to deal with git's staging area.

- - -
- Stash -

Contains helper functions which allow to deal with git stash.

- - -
- Submodule -

Contains helper functions which allow to deal with git submodules.

- - -
- -
-

Fake.MSBuild Namespace

-
- - - - - - - - - - - - - - -
ModuleDescription
- ProjectSystem -

Contains project file comparion tools for MSBuild project files.

- - -
- SpecsRemovement -

Contains functions which allow to remove side-by-side specs during the build.

- - -
- -
-

Fake.NuGet Namespace

-
- - - - - - - - - - - - - - -
ModuleDescription
- Install -

Contains tasks for installing NuGet packages using the nuget.exe install command.

- - -
- Update -

Contains tasks for updating NuGet packages including assembly hint paths in the project files using the nuget.exe update command.

- - -
- -
-

Fake.Testing Namespace

-
- - - - - - - - - - - - - - -
ModuleDescription
- XUnit -

Contains tasks to run xUnit v1 unit tests.

- - -
- XUnit2 -

Contains tasks to run xUnit v2 unit tests.

- - -
- -
-

Test.FAKECore Namespace

-
- - - - - - - - - - -
TypeDescription
- FSharpFuncUtil -
- -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/apidocs/test-fakecore-fsharpfuncutil.html b/packages/FAKE.4.11.3/docs/apidocs/test-fakecore-fsharpfuncutil.html deleted file mode 100644 index 328612d..0000000 --- a/packages/FAKE.4.11.3/docs/apidocs/test-fakecore-fsharpfuncutil.html +++ /dev/null @@ -1,269 +0,0 @@ - - - - - FSharpFuncUtil - FAKE - F# Make - - - - - - - - - - - - - - - - -
- -
-
-
- - - - -

FSharpFuncUtil

-
-
-

Static members

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Static memberDescription
- - - Create(func) - -
- Signature: func:Func<'a,'b,'c,'d> -> 'a -> 'b -> 'c -> 'd
- Type parameters: 'a, 'b, 'c, 'd
-
- - - - - -
- - - Create(func) - -
- Signature: func:Func<'a,'b,'c> -> 'a -> 'b -> 'c
- Type parameters: 'a, 'b, 'c
-
- - - - - -
- - - Create(func) - -
- Signature: func:Func<'a,'b> -> 'a -> 'b
- Type parameters: 'a, 'b
-
- - - - - -
- - - ToFSharpFunc(func) - -
- Signature: func:Action<'a> -> 'a -> unit
- Type parameters: 'a
-
- - - - - -
- - - ToFSharpFunc(func) - -
- Signature: func:Action -> unit -> unit
- Type parameters: 'a
-
- - - - - -
- - - ToFSharpFunc(func) - -
- Signature: func:Func<'a,'b,'c,'d> -> 'a -> 'b -> 'c -> 'd
- Type parameters: 'a, 'b, 'c, 'd
-
- - - - - -
- - - ToFSharpFunc(func) - -
- Signature: func:Func<'a,'b,'c> -> 'a -> 'b -> 'c
- Type parameters: 'a, 'b, 'c
-
- - - - - -
- - - ToFSharpFunc(func) - -
- Signature: func:Func<'a,'b> -> 'a -> 'b
- Type parameters: 'a, 'b
-
- - - - - -
- - - ToFSharpFunc(func) - -
- Signature: func:Func<'a> -> unit -> 'a
- Type parameters: 'a
-
- - - - - -
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/assemblyinfo.html b/packages/FAKE.4.11.3/docs/assemblyinfo.html deleted file mode 100644 index 483a177..0000000 --- a/packages/FAKE.4.11.3/docs/assemblyinfo.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - Generating AssemblyInfo files - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

Generating AssemblyInfo files

- -

In this article the AssemblyInfo task is used in order to set specific version information to .NET assemblies.

- -

If you succeeded with the Getting Started tutorial, then you just have to modify your BuildApp target to the following:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-21: 
-22: 
-
open Fake.AssemblyInfoFile
-
-Target "BuildApp" (fun _ ->
-    CreateCSharpAssemblyInfo "./src/app/Calculator/Properties/AssemblyInfo.cs"
-        [Attribute.Title "Calculator Command line tool"
-         Attribute.Description "Sample project for FAKE - F# MAKE"
-         Attribute.Guid "A539B42C-CB9F-4a23-8E57-AF4E7CEE5BAA"
-         Attribute.Product "Calculator"
-         Attribute.Version version
-         Attribute.FileVersion version]
-
-    CreateCSharpAssemblyInfo "./src/app/CalculatorLib/Properties/AssemblyInfo.cs"
-        [Attribute.Title "Calculator library"
-         Attribute.Description "Sample project for FAKE - F# MAKE"
-         Attribute.Guid "EE5621DB-B86B-44eb-987F-9C94BCC98441"
-         Attribute.Product "Calculator"
-         Attribute.Version version
-         Attribute.FileVersion version]
-
-    MSBuildRelease buildDir "Build" appReferences
-      |> Log "AppBuild-Output: "
-)
-
- -

As you can see generating an AssemblyInfo.cs file is pretty easy with FAKE. You can read more about the C# and F# AssemblyInfo tasks in the API docs.

- -

Setting the version no.

- -

The version parameter can be declared as a property or fetched from a build server like TeamCity:

- - - - -
1: 
-2: 
-3: 
-4: 
-
let version =
-  match buildServer with
-  | TeamCity -> buildVersion
-  | _ -> "0.2"
-
- -

alt text

- -

Storing the githash in the AssemblyInfo

- -

Storing the githash with the assembly can make it easier to identify exactly what code is running. There isn't an attribute that -directly fits with doing this, but one way is by storing it as Metadata (warning: this attribute is only available in .NET 4.5 and above)

- -

If your solution is inside a git repository you can get the git hash like this:

- - - - -
1: 
-
let commitHash = Information.getCurrentSHA1()
-
- -

And set like this:

- - - - -
1: 
-
Attribute.Metadata("githash", commitHash)
-
- -

One of the easiest ways to retrieve this hash is to load use a reflector program, like ILSpy:

- -

alt text

- -

Using the SolutionInfo approach

- -

Some companies split their AssemblyInfo into a SolutionInfo.cs which is shared by all projects and a specific AssemblyInfo per project which contains the product data. -All versioning data is generated by the AssemblyInfo task into the SolutionInfo.cs and the AssemblyInfo files are editied manually. This could look like this:

- -

alt text

- -

The generated SolutionInfo.cs looks like this:

- -

alt text

- -
val version : string

Full name: assemblyinfo.version
-
val TeamCity : obj
-
val commitHash : obj

Full name: assemblyinfo.commitHash
- -
- -
-
- Fork me on GitHub - - diff --git a/packages/FAKE.4.11.3/docs/azurecloudservices.html b/packages/FAKE.4.11.3/docs/azurecloudservices.html deleted file mode 100644 index 8412354..0000000 --- a/packages/FAKE.4.11.3/docs/azurecloudservices.html +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - Packaging Azure Cloud Services - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

Packaging Azure Cloud Services

- -

FAKE can be used to create a Azure Cloud Service package (.cspkg) for use with e.g. Worker Roles.

- -

Currently it does not support publishing, and has several restrictions: -

- -
    -
  1. The service definition file must be called ServiceDefinition.csdef.
  2. -
  3. It only works for single-role workers.
  4. -
  5. It does not perform a build of the worker role project - this should be done beforehand.
  6. -
  7. Always packages from the Release outputs.
  8. -
- -

Assume a solution with the following structure: -

- -
    -
  • MyCloudService.ccproj -
      -
    • Contains a single role, "MyRole".
    • -
    • Contains a ServiceDefinition.cscfg file.
    • -
  • -
  • MyWorkerRole.fsproj -
      -
    • Referenced by MyCloudService as a Role.
    • -
    • Contains a typical RoleEntryPoint class.
    • -
  • -
- -

You can package this cloud service thus: -

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-
Target "PackageCloudService" (fun _ ->
-    PackageRole
-        { CloudService = "MyCloudService"
-          WorkerRole = "MyWorkerRole"
-          SdkVersion = None
-          OutputPath = None })
-
- -

This will build MyCloudService.cspkg in the current directory (override using OutputPath).

- -

When packaging occurs, the task will scan the local machine for installed Azure SDK versions; if none is specified, -it will pick the highest version installed. You can override this with the SdkVersion property e.g. Some 2.4. -You can plug this into a regular FAKE pipeline as follows: -

- - - - -
1: 
-2: 
-3: 
-
"Clean"
-  ==> "BuildApp"
-  ==> "PackageCloudService"
-
- -
union case Option.None: Option<'T>
- -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/azurewebjobs.html b/packages/FAKE.4.11.3/docs/azurewebjobs.html deleted file mode 100644 index 7ffc313..0000000 --- a/packages/FAKE.4.11.3/docs/azurewebjobs.html +++ /dev/null @@ -1,207 +0,0 @@ - - - - - - Packaging and Deploying Azure WebJobs - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

Packaging and Deploying Azure WebJobs

- -

FAKE can be used to zip the output directory of a project and push it to Azure via the zip controller.

- -

You'll need to know the ftp details of the website to publish the web jobs to. Also the web jobs need to already exist on the azure dashboard.

- -

In your build.fsx add the following:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-21: 
-22: 
-23: 
-24: 
-25: 
-26: 
-27: 
-28: 
-29: 
-30: 
-31: 
-32: 
-
type Uri with
-    member this.SubDomain = this.Host.Split([|'.'|],2).[0]
-
-let private jobTypePath webJobType =
-    match webJobType with
-    | WebJobType.Continuous -> "continuous"
-    | WebJobType.Triggered -> "triggered"
-
-// a function to create webjobs based on the projects structure
-let private createWebJob site name jobType project =
-    let path = jobTypePath jobType
-    { Name = name
-      JobType = jobType
-      Project = project
-      DirectoryToPackage = sprintf "src/%s/bin/Release" project
-      PackageLocation = sprintf "bin/%s/webjobs/%s/%s.zip" site path project }
-
-let webJobs site = [createWebJob site "webjob1" WebJobType.Continuous "MyProject.WebJob1"
-                    createWebJob site "webjob2" WebJobType.Triggered "MyProject.WebJob2"]
-
-let site = Uri("https://yoursite.scm.azurewebsites.net")
-let webSite = {WebSite.Url = site
-               UserName = "$yoursite"
-               Password = "password"
-               WebJobs = webJobs site.SubDomain }
-
-Target "PackageWebJobs" (fun _ ->
-    PackageWebJobs [webSite]
-)
-Target "DeployWebJobs" (fun _ ->
-    DeployWebJobs [webSite]
-)
-
- -

In the dependencies section add the targets to the build order after the build action:

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-
"Clean"
-  ==> "BuildApp"
-  ==> "BuildTest"
-  ==> "Test"
-  ==> "PackageWebJobs"
-  ==> "DeployWebJobs"
-  ==> "Default"
-
- -

The will create a zip file in the bin folder in the root which contains the contents of the bin/release folder of each web job to deploy and push it to azure.

- -

Caveats

- -

The zip controller will not remove files.

- -
val private jobTypePath : webJobType:'a -> 'b

Full name: azurewebjobs.jobTypePath
-
val webJobType : 'a
-
val private createWebJob : site:'a -> name:'b -> jobType:'c -> project:'d -> 'e

Full name: azurewebjobs.createWebJob
-
val site : 'a
-
val name : 'a
-
val jobType : 'a
-
val project : 'a
-
val path : obj
-
val sprintf : format:Printf.StringFormat<'T> -> 'T

Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.sprintf
-
val webJobs : site:'a -> 'b list

Full name: azurewebjobs.webJobs
-
val site : obj

Full name: azurewebjobs.site
-
val webSite : obj

Full name: azurewebjobs.webSite
- -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/cache.html b/packages/FAKE.4.11.3/docs/cache.html deleted file mode 100644 index bdb41ad..0000000 --- a/packages/FAKE.4.11.3/docs/cache.html +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Caching of build scripts - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

Caching of build scripts

- -

Starting with version 4.0.0 of FAKE, the first time a script is run the -compiled assembly that is generated is saved into the hidden .fake directory. This -allows FAKE to start in milliseconds instead of seconds. Your script files are -cached with a crc32 key generated from the first scripts contents, and then each -#loaded scripts contents. This prevents you from having to manually clear the -cache whenever you are working on your script or pulling in changes from a -remote repository. If for some reason you would like to disable saving the -compiled assembly to disk, you can call FAKE with the --nocache argument, -which stops FAKE from dumping the compiled assembly to disk. Do note that the -assembly is still being compiled by FSI, all you are disabling is the saving -to disk.

- -

You should add the .fake folder to your .gitignore file.

- - -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/canopy.html b/packages/FAKE.4.11.3/docs/canopy.html deleted file mode 100644 index e8c1f81..0000000 --- a/packages/FAKE.4.11.3/docs/canopy.html +++ /dev/null @@ -1,216 +0,0 @@ - - - - - - Running canopy tests with FAKE - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

Running canopy tests with FAKE

- -

FAKE can be used to run a variety of different testing frameworks. -In this tutorial we are looking at Canopy support.

- -

alt text

- -

Setup your canopy project

- -

Consider a simple canopy program.fs file:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-21: 
-22: 
-23: 
-24: 
-
#r "canopy.dll"
-
-open canopy
-open runner
-open System
-
-//overwrite default path
-canopy.configuration.phantomJSDir <- @".\"
-
-//start an instance of the browser
-start phantomJS
-
-"taking canopy for a spin" &&& fun _ ->
-
-    //go to url
-    url "http://localhost:81/canopy/testpages/"
-
-    //assert that the element with an id of 'welcome' has the text 'Welcome'
-    "#welcome" == "Welcome"
-
-//run all tests
-run()
-
-quit()
-
- -

Although Selenium (which is the framework behind canopy) supports all browsers you might want to run your tests with the headless browser PhantomJS. To grab the latest version just install the NuGet package:

- - - - -
1: 
-
install-package PhantomJS
-
- -

Normally canopy loads PhantomJS.exe from C:\ but in our case we want to use the installed one so we have to override the path in our test script and set the current path as location of PhantomJS.exe.

- -

Run canopy tests in FAKE

- -

The target in FAKE basically hosts the website in IIS Express and starts the canopy tests. IISExpress requires a configuration template ("iisexpress-template.config") which can be copied from %ProgramFiles%\IIS Express\AppServer\applicationhost.config.

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-
Target "CanopyTests" (fun _ ->
-    let hostName = "localhost"
-    let port = 81
-
-    let config = createConfigFile(project, 1, "iisexpress-template.config", websiteDir + "/" + project, hostName, port)
-    let webSiteProcess = HostWebsite id config 1
-
-    let result =
-        ExecProcess (fun info ->
-            info.FileName <- (buildDir @@ "CanopyTests.exe")
-            info.WorkingDirectory <- buildDir
-        ) (System.TimeSpan.FromMinutes 5.)
-
-    ProcessHelper.killProcessById webSiteProcess.Id
-
-    if result <> 0 then failwith "Failed result from canopy tests"
-)
-
- -

Please note that HostWebsite starts the IISExpress process asynchronous and does NOT wait until the IISExpress successfully started. Issue #403

- -
namespace System
-
val id : x:'T -> 'T

Full name: Microsoft.FSharp.Core.Operators.id
-
Multiple items
type TimeSpan =
  struct
    new : ticks:int64 -> TimeSpan + 3 overloads
    member Add : ts:TimeSpan -> TimeSpan
    member CompareTo : value:obj -> int + 1 overload
    member Days : int
    member Duration : unit -> TimeSpan
    member Equals : value:obj -> bool + 1 overload
    member GetHashCode : unit -> int
    member Hours : int
    member Milliseconds : int
    member Minutes : int
    ...
  end

Full name: System.TimeSpan

--------------------
TimeSpan()
TimeSpan(ticks: int64) : unit
TimeSpan(hours: int, minutes: int, seconds: int) : unit
TimeSpan(days: int, hours: int, minutes: int, seconds: int) : unit
TimeSpan(days: int, hours: int, minutes: int, seconds: int, milliseconds: int) : unit
-
TimeSpan.FromMinutes(value: float) : TimeSpan
-
val failwith : message:string -> 'T

Full name: Microsoft.FSharp.Core.Operators.failwith
- -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/commandline.html b/packages/FAKE.4.11.3/docs/commandline.html deleted file mode 100644 index accf594..0000000 --- a/packages/FAKE.4.11.3/docs/commandline.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - FAKE Command Line - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

FAKE Command Line

- -

Note: This documentation is for FAKE.exe version 2.18 or later.

- -

The FAKE.exe command line interface (CLI) is defined as follows:

- -

fake.exe [<buildScriptPath>] [<targetName>] [options]

- -

Basic Examples

- -

No arguments: fake.exe (FAKE will try and locate your build script).

- -

Specify build script only: fake.exe mybuildscript.fsx

- -

Specify target name only: fake.exe clean (runs the clean target).

- -

Specify build script and target: fake.exe mybuildscript.fsx clean

- -

buildScriptPath

- -

Optional. The path to your .fsx build file. If not specified, FAKE will pick the first .fsx it finds in your working directory (and fail if none exist).

- -

targetName

- -

Optional. The name of the build script target you wish to run. This will any target you specified to run in the build script.

- -

Options

- -

Options begin with -- (long name) or - (short name).

- -

--envvar [-ev] <name:string> <value:string>

- -

Set environment variable name value pair. Supports multiple.

- -

--envflag [-ef] <name:string>

- -

Set environment variable flag name to 'true'. Supports multiple.

- -

--logfile [-lf] <path:string>

- -

Set the build output log file path.

- -

--printdetails [-pd]

- -

Print details of FAKE's activity.

- -

--version [-v]

- -

Print FAKE version information.

- -

--fsiargs [-fa] <string>

- -

Pass args after this switch to FSI when running the build script. This consumes all arguments after it. See F# Interactive Options for the fsi CLI details.

- -

Important: If you use this option, you must include your build script path as one of the fsi args. For example:

- -

--fsiargs --debug+ buildscript.fsx someArg1 anotherArg2

- -

The entire argument string following the build script path is set as the value of an environment variable named fsiargs-buildscriptargs. This means you can access this specific set of arguments from within your build script.

- -

--boot [-b] <string>

- -

Bootstrap your FAKE script. A bootstrapping build.fsx script executes twice (in two stages), allowing you to download dependencies with NuGet and do other preparatory work in the first stage, and have these dependencies available in the second stage.

- -

--help [-h|/h|/help|/?]

- -

Display CLI help.

- -

Running FAKE targets from the command line

- -

For this short sample we assume you have the latest version of FAKE in ./tools/. Now consider the following small FAKE script:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-
#r "FAKE/tools/FakeLib.dll"
-open Fake 
-
-Target "Clean" (fun () ->  trace " --- Cleaning stuff --- ")
-
-Target "Build" (fun () ->  trace " --- Building the app --- ")
-
-Target "Deploy" (fun () -> trace " --- Deploying app --- ")
-
-
-"Clean"
-  ==> "Build"
-  ==> "Deploy"
-
-RunTargetOrDefault "Deploy"
-
- -

If you are on windows then create this small redirect script:

- - -
1: 
-2: 
-3: 
-
@echo off
-"tools\Fake.exe" "%1"
-exit /b %errorlevel%
-
- -

On mono you can use:

- - -
1: 
-2: 
-
#!/bin/bash
-mono ./tools/FAKE.exe "$@"
-
- -

Now you can run FAKE targets easily from the command line:

- -

alt text

- - -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/content/img/github-blue.png b/packages/FAKE.4.11.3/docs/content/img/github-blue.png deleted file mode 100644 index 57432a0..0000000 Binary files a/packages/FAKE.4.11.3/docs/content/img/github-blue.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/content/img/github.png b/packages/FAKE.4.11.3/docs/content/img/github.png deleted file mode 100644 index 5d48d83..0000000 Binary files a/packages/FAKE.4.11.3/docs/content/img/github.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/content/style.css b/packages/FAKE.4.11.3/docs/content/style.css deleted file mode 100644 index d087f11..0000000 --- a/packages/FAKE.4.11.3/docs/content/style.css +++ /dev/null @@ -1,197 +0,0 @@ -@import url(https://fonts.googleapis.com/css?family=Droid+Sans|Droid+Sans+Mono|Open+Sans:400,600,700); - -/*-------------------------------------------------------------------------- - Formatting for F# code snippets -/*--------------------------------------------------------------------------*/ - -/* identifier */ -span.i { color:#d1d1d1; } -/* string */ -span.s { color:#d4b43c; } -/* keywords */ -span.k { color:#4e98dc; } -/* comment */ -span.c { color:#96C71D; } -/* operators */ -span.o { color:#af75c1; } -/* numbers */ -span.n { color:#96C71D; } -/* line number */ -span.l { color:#80b0b0; } - -/* inactive code */ -span.inactive { color:#808080; } -/* preprocessor */ -span.prep { color:#af75c1; } -/* fsi output */ -span.fsi { color:#808080; } - -/* omitted */ -span.omitted { - background:#3c4e52; - border-radius:5px; - color:#808080; - padding:0px 0px 1px 0px; -} -/* tool tip */ -div.tip { - background:#475b5f; - border-radius:4px; - font:11pt 'Droid Sans', arial, sans-serif; - padding:6px 8px 6px 8px; - display:none; - color:#d1d1d1; -} -table.pre pre { - padding:0px; - margin:0px; - border:none; -} -table.pre, pre.fssnip, pre { - line-height:13pt; - border:1px solid #d8d8d8; - border-collapse:separate; - white-space:pre; - font: 9pt 'Droid Sans Mono',consolas,monospace; - width:90%; - margin:10px 20px 20px 20px; - background-color:#212d30; - padding:10px; - border-radius:5px; - color:#d1d1d1; -} -table.pre pre { - padding:0px; - margin:0px; - border-radius:0px; - width: 100%; -} -table.pre td { - padding:0px; - white-space:normal; - margin:0px; -} -table.pre td.lines { - width:30px; -} - -/*-------------------------------------------------------------------------- - Formatting for page & standard document content -/*--------------------------------------------------------------------------*/ - -body { - font-family: 'Open Sans', serif; - padding-top: 0px; - padding-bottom: 40px; -} - -pre { - word-wrap: inherit; -} - -/* Format the heading - nicer spacing etc. */ -.masthead { - overflow: hidden; -} -.masthead .muted a { - text-decoration:none; - color:#999999; -} -.masthead ul, .masthead li { - margin-bottom:0px; -} -.masthead .nav li { - margin-top: 15px; - font-size:110%; -} -.masthead h3 { - margin-bottom:5px; - font-size:170%; -} -hr { - margin:0px 0px 20px 0px; -} - -/* Make table headings and td.title bold */ -td.title, thead { - font-weight:bold; -} - -/* Format the right-side menu */ -#menu { - margin-top:50px; - font-size:11pt; - padding-left:20px; -} - -#menu .nav-header { - font-size:12pt; - color:#606060; - margin-top:20px; -} - -#menu li { - line-height:25px; -} - -/* Change font sizes for headings etc. */ -#main h1 { font-size: 26pt; margin:10px 0px 15px 0px; font-weight:400; } -#main h2 { font-size: 20pt; margin:20px 0px 0px 0px; font-weight:400; } -#main h3 { font-size: 14pt; margin:15px 0px 0px 0px; font-weight:600; } -#main p { font-size: 11pt; margin:5px 0px 15px 0px; } -#main ul { font-size: 11pt; margin-top:10px; } -#main li { font-size: 11pt; margin: 5px 0px 5px 0px; } -#main strong { font-weight:700; } - -/*-------------------------------------------------------------------------- - Formatting for API reference -/*--------------------------------------------------------------------------*/ - -.type-list .type-name, .module-list .module-name { - width:25%; - font-weight:bold; -} -.member-list .member-name { - width:35%; -} -#main .xmldoc h2 { - font-size:14pt; - margin:10px 0px 0px 0px; -} -#main .xmldoc h3 { - font-size:12pt; - margin:10px 0px 0px 0px; -} -.github-link { - float:right; - text-decoration:none; -} -.github-link img { - border-style:none; - margin-left:10px; -} -.github-link .hover { display:none; } -.github-link:hover .hover { display:block; } -.github-link .normal { display: block; } -.github-link:hover .normal { display: none; } - -/*-------------------------------------------------------------------------- - Additional formatting for the homepage -/*--------------------------------------------------------------------------*/ - -#nuget { - margin-top:20px; - font-size: 11pt; - padding:20px; -} - -#nuget pre { - font-size:11pt; - -moz-border-radius: 0px; - -webkit-border-radius: 0px; - border-radius: 0px; - background: #404040; - border-style:none; - color: #e0e0e0; - margin-top:15px; -} \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/content/style.css.bak b/packages/FAKE.4.11.3/docs/content/style.css.bak deleted file mode 100644 index 397eddc..0000000 --- a/packages/FAKE.4.11.3/docs/content/style.css.bak +++ /dev/null @@ -1,193 +0,0 @@ -@import url(http://fonts.googleapis.com/css?family=Droid+Sans|Droid+Sans+Mono|Open+Sans:400,600,700); - -/*-------------------------------------------------------------------------- - Formatting for F# code snippets -/*--------------------------------------------------------------------------*/ - -/* identifier */ -span.i { color:#d1d1d1; } -/* string */ -span.s { color:#d4b43c; } -/* keywords */ -span.k { color:#4e98dc; } -/* comment */ -span.c { color:#96C71D; } -/* operators */ -span.o { color:#af75c1; } -/* numbers */ -span.n { color:#96C71D; } -/* line number */ -span.l { color:#80b0b0; } - -/* inactive code */ -span.inactive { color:#808080; } -/* preprocessor */ -span.prep { color:#af75c1; } -/* fsi output */ -span.fsi { color:#808080; } - -/* omitted */ -span.omitted { - background:#3c4e52; - border-radius:5px; - color:#808080; - padding:0px 0px 1px 0px; -} -/* tool tip */ -div.tip { - background:#475b5f; - border-radius:4px; - font:11pt 'Droid Sans', arial, sans-serif; - padding:6px 8px 6px 8px; - display:none; - color:#d1d1d1; -} -table.pre pre { - padding:0px; - margin:0px; - border:none; -} -table.pre, pre.fssnip, pre { - line-height:13pt; - border:1px solid #d8d8d8; - border-collapse:separate; - white-space:pre; - font: 9pt 'Droid Sans Mono',consolas,monospace; - width:90%; - margin:10px 20px 20px 20px; - background-color:#212d30; - padding:10px; - border-radius:5px; - color:#d1d1d1; -} -table.pre pre { - padding:0px; - margin:0px; - border-radius:0px; - width: 100%; -} -table.pre td { - padding:0px; - white-space:normal; - margin:0px; -} -table.pre td.lines { - width:30px; -} - -/*-------------------------------------------------------------------------- - Formatting for page & standard document content -/*--------------------------------------------------------------------------*/ - -body { - font-family: 'Open Sans', serif; - padding-top: 0px; - padding-bottom: 40px; -} - -pre { - word-wrap: inherit; -} - -/* Format the heading - nicer spacing etc. */ -.masthead { - overflow: hidden; -} -.masthead ul, .masthead li { - margin-bottom:0px; -} -.masthead .nav li { - margin-top: 15px; - font-size:110%; -} -.masthead h3 { - margin-bottom:5px; - font-size:170%; -} -hr { - margin:0px 0px 20px 0px; -} - -/* Make table headings and td.title bold */ -td.title, thead { - font-weight:bold; -} - -/* Format the right-side menu */ -#menu { - margin-top:50px; - font-size:11pt; - padding-left:20px; -} - -#menu .nav-header { - font-size:12pt; - color:#606060; - margin-top:20px; -} - -#menu li { - line-height:25px; -} - -/* Change font sizes for headings etc. */ -#main h1 { font-size: 26pt; margin:10px 0px 15px 0px; font-weight:400; } -#main h2 { font-size: 20pt; margin:20px 0px 0px 0px; font-weight:400; } -#main h3 { font-size: 14pt; margin:15px 0px 0px 0px; font-weight:600; } -#main p { font-size: 11pt; margin:5px 0px 15px 0px; } -#main ul { font-size: 11pt; margin-top:10px; } -#main li { font-size: 11pt; margin: 5px 0px 5px 0px; } -#main strong { font-weight:700; } - -/*-------------------------------------------------------------------------- - Formatting for API reference -/*--------------------------------------------------------------------------*/ - -.type-list .type-name, .module-list .module-name { - width:25%; - font-weight:bold; -} -.member-list .member-name { - width:35%; -} -#main .xmldoc h2 { - font-size:14pt; - margin:10px 0px 0px 0px; -} -#main .xmldoc h3 { - font-size:12pt; - margin:10px 0px 0px 0px; -} -.github-link { - float:right; - text-decoration:none; -} -.github-link img { - border-style:none; - margin-left:10px; -} -.github-link .hover { display:none; } -.github-link:hover .hover { display:block; } -.github-link .normal { display: block; } -.github-link:hover .normal { display: none; } - -/*-------------------------------------------------------------------------- - Additional formatting for the homepage -/*--------------------------------------------------------------------------*/ - -#nuget { - margin-top:20px; - font-size: 11pt; - padding:20px; -} - -#nuget pre { - font-size:11pt; - -moz-border-radius: 0px; - -webkit-border-radius: 0px; - border-radius: 0px; - background: #404040; - border-style:none; - color: #e0e0e0; - margin-top:15px; -} \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/content/tips.js b/packages/FAKE.4.11.3/docs/content/tips.js deleted file mode 100644 index 2b125ba..0000000 --- a/packages/FAKE.4.11.3/docs/content/tips.js +++ /dev/null @@ -1,46 +0,0 @@ -var currentTip = null; -var currentTipElement = null; - -function hideTip(evt, name, unique) { - var el = document.getElementById(name); - el.style.display = "none"; - currentTip = null; -} - -function findPos(obj) { - // no idea why, but it behaves differently in webbrowser component - if (window.location.search == "?inapp") - return [obj.offsetLeft + 10, obj.offsetTop + 30]; - - var curleft = 0; - var curtop = obj.offsetHeight; - while (obj) { - curleft += obj.offsetLeft; - curtop += obj.offsetTop; - obj = obj.offsetParent; - }; - return [curleft, curtop]; -} - -function hideUsingEsc(e) { - if (!e) { e = event; } - hideTip(e, currentTipElement, currentTip); -} - -function showTip(evt, name, unique, owner) { - document.onkeydown = hideUsingEsc; - if (currentTip == unique) return; - currentTip = unique; - currentTipElement = name; - - var pos = findPos(owner ? owner : (evt.srcElement ? evt.srcElement : evt.target)); - var posx = pos[0]; - var posy = pos[1]; - - var el = document.getElementById(name); - var parent = (document.documentElement == null) ? document.body : document.documentElement; - el.style.position = "absolute"; - el.style.left = posx + "px"; - el.style.top = posy + "px"; - el.style.display = "block"; -} \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/contributing.html b/packages/FAKE.4.11.3/docs/contributing.html deleted file mode 100644 index b4ca98d..0000000 --- a/packages/FAKE.4.11.3/docs/contributing.html +++ /dev/null @@ -1,185 +0,0 @@ - - - - - - Contributing to FAKE - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

Contributing to FAKE

- -

This page should provide you with some basic information if you're thinking about contributing to FAKE.

- -
    -
  • This page can be edited by sending a pull request to the FAKE project on GitHub, so if you learn something when playing with FAKE please record your findings here!

  • -
  • If you want to discuss a feature (a good idea!), or if you want to look at suggestions how you might contribute, check out the Issue list on GitHub or send an email to the FAKE mailing list.

  • -
  • Unless you explicitly state otherwise, any contribution intentionally -submitted for inclusion in the Project shall be under the terms and -conditions of the Apache 2.0 license. See License.txt for details.

  • -
- -

Documentation

- -

The documentation for FAKE is automatically generated using the amazing F# Formatting library. -It turns *.md (Markdown with embedded code snippets) and *.fsx files (F# script file with embedded Markdown documentation) into a nice HTML documentation.

- -
    -
  • The code for all the documents can be found in the help directory on GitHub. If you find a bug or add a new feature, make sure you document it!

  • -
  • If you want to build the documentation, simply run the build script (GitHub link) which builds the documentation.

  • -
- -

Creating pull requests

- -

Prerequisites

- -

Git / GitHub

- -
    -
  • Fork the FAKE repo on GitHub.

  • -
  • Clone your personal fork locally.

  • -
  • Add a new git remote in order to retrieve upstream changes.

    - - - -
    1: 
    -
      git remote add upstream https://github.com/fsharp/FAKE.git
    -
  • -
- -

Build tools

- - - -

Programming

- -
    -
  • Checkout the master branch.

  • -
  • Run the build in order to check if everything works. -
      -
    • On Mono run build.sh
    • -
    • On Windows run build.cmd

    • -
  • -
  • Create a new feature branch.

    - - - -
    1: 
    -
      git checkout -b myfeature
    -
  • -
  • Implement your bugfix/feature.

  • -
  • Add a bit of documentation (see above).

  • -
  • Commit and push to your fork.

  • -
  • Use GitHub's UI to create a pull request. -Write "WIP" into the pull request description if it's not completely ready

  • -
  • If you need to rebase you can do:

    - - - -
    1: 
    -2: 
    -3: 
    -
      git fetch upstream
    -  git rebase upstream/master
    -  git push origin myfeature -f
    -
  • -
  • The pull request will be updated automatically.

  • -
- -

Text editor / Code style

- - - - -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/create-nuget-package.html b/packages/FAKE.4.11.3/docs/create-nuget-package.html deleted file mode 100644 index 8b6c779..0000000 --- a/packages/FAKE.4.11.3/docs/create-nuget-package.html +++ /dev/null @@ -1,376 +0,0 @@ - - - - - - Creating NuGet packages - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

Creating NuGet packages

- -

Creating a .nuspec template

- -

The basic idea to create nuget packages is to create a .nuspec template and let FAKE fill out the missing parts. -The following code shows such .nuspec file from the OctoKit project.

- - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-21: 
-
<?xml version="1.0" encoding="utf-8"?>
-<package xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
-  <metadata xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">    
-    <id>@project@</id>
-    <version>@build.number@</version>
-    <authors>@authors@</authors>
-    <owners>@authors@</owners>
-    <summary>@summary@</summary>
-    <licenseUrl>https://github.com/octokit/octokit.net/blob/master/LICENSE.txt</licenseUrl>
-    <projectUrl>https://github.com/octokit/octokit.net</projectUrl>
-    <iconUrl>https://github.com/octokit/octokit.net/icon.png</iconUrl>
-    <requireLicenseAcceptance>false</requireLicenseAcceptance>
-    <description>@description@</description>
-    <releaseNotes>@releaseNotes@</releaseNotes>
-    <copyright>Copyright GitHub 2013</copyright>    
-    <tags>GitHub API Octokit</tags>
-    @dependencies@
-    @references@
-  </metadata>
-  @files@
-</package>
-
- -

The .nuspec template contains some placeholders like @build.number@ which can be replaced later by the build script. -It also contains some specific information like the copyright which is not handled by FAKE.

- -

The following table gives the correspondence between the placeholders and the fields of the record type used by the NuGet task.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Placeholder

replaced by (NuGetParams record field)

@build.number@

Version

@authors@

Authors

@project@

Project

@summary@

Summary

@description@

Description

@tags@

Tags

@releaseNotes@

ReleaseNotes

@copyright@

Copyright

@dependencies@

a combination of Dependencies and DependenciesByFramework

@references@

a combination of References and ReferencesByFramework

@files@

a list of source, target, and exclude strings for files to be included in the nuget package

- - -

Setting up the build script

- -

In the build script you need to create a target which executes the NuGet task:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-
Target "CreatePackage" (fun _ ->
-    // Copy all the package files into a package folder
-    CopyFiles packagingDir allPackageFiles
-
-    NuGet (fun p -> 
-        {p with
-            Authors = authors
-            Project = projectName
-            Description = projectDescription                               
-            OutputPath = packagingRoot
-            Summary = projectSummary
-            WorkingDir = packagingDir
-            Version = buildVersion
-            AccessKey = myAccesskey
-            Publish = true }) 
-            "myProject.nuspec"
-)
-
- -

There are a couple of interesting things happening here. In this sample FAKE created:

- -
    -
  • a copy of the .nuspec file
  • -
  • filled in all the specified parameters
  • -
  • created the NuGet package
  • -
  • pushed it to nuget.org using the given myAccessKey.
  • -
- -

Handling package dependencies

- -

If your project dependends on other projects it is possible to specify these dependencies in the .nuspec definition (see also Nuget docs). -Here is a small sample which sets up dependencies for different framework versions:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-
    NuGet (fun p -> 
-            {p with
-                    Authors = authors
-                    // ...
-                    Dependencies =  // fallback - for all unspecified frameworks
-                ["Octokit", "0.1"
-                "Rx-Main", GetPackageVersion "./packages/" "Rx-Main"]
-                    DependenciesByFramework =
-                                    [{ FrameworkVersion  = "net40"
-                                    Dependencies = 
-                                            ["Octokit", "0.1"
-                                             "Rx-Main", GetPackageVersion "./packages/" "Rx-Main"
-                                             "SignalR", GetPackageVersion "./packages/" "SignalR"]}
-                                    { FrameworkVersion  = "net45"
-                                    Dependencies = 
-                                            ["Octokit", "0.1"
-                                             "SignalR", GetPackageVersion "./packages/" "SignalR"]}]
-                    // ...
-                    Publish = true }) 
-                    "myProject.nuspec"
-
- -

Explicit assembly references

- -

If you want to have auxiliary assemblies next to the ones that get referenced by the target project, you can place all the needed files in the lib directory and explicitly specify which of them should be referenced (see Nuget docs) via the References and ReferencesByFramework fields. -Here is a code snippet showing how to use these:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-
NuGet (fun p -> 
-    {p with
-        Authors = authors
-        // ...
-        References = ["a.dll"]
-        ReferencesByFramework =
-            [{ FrameworkVersion  = "net40"; References = ["b.dll"]}
-             { FrameworkVersion  = "net45"; References = ["c.dll"]}]
-        // ...
-        Publish = false })
-        "template.nuspec"
-
- -

Explicit file specifications

- -

If you want to specify exactly what files are packaged and where they are placed in the resulting NuGet package you can specify the Files property directly. This is exactly like having the Files element of a nuspec filled out ahead of time. -Here is a code snippet showing how to use this:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-
// Here we are specifically only taking the js and css folders from our project and placing them in matching target folder in the resulting nuspec.
-// Note that the include paths are relative to the location of the .nuspec file
-// See [Nuget docs](http://docs.nuget.org/docs/reference/nuspec-reference#Specifying_Files_to_Include_in_the_Package) for more detailed examples of how to specify file includes, as this follows the same syntax.
-NuGet (fun p ->
-    {p with
-        // ...
-        Files = [
-            (@"tools\**\*.*", None, None)
-            (@"bin\Debug\*.dll", Some "lib", Some "badfile.css;otherbadfile.css")
-        ]
-        // ...
-    })
-    "template.nuspec"
-
- -
union case Option.None: Option<'T>
-
union case Option.Some: Value: 'T -> Option<'T>
- -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/customtasks.html b/packages/FAKE.4.11.3/docs/customtasks.html deleted file mode 100644 index 10eafff..0000000 --- a/packages/FAKE.4.11.3/docs/customtasks.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - Writing custom C# tasks for FAKE - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

Writing custom C# tasks for FAKE

- -

"FAKE - F# Make" is intended to be an extensible build framework and therefor it should be as easy as possible to create custom tasks. -This tutorial shows how to create a (very simple) custom task in C#.

- -

Creating a custom task

- -

Open Visual Studio and create a new C# class library called my MyCustomTask and create a class called RandomNumberTask:

- - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-
using System;
-
-namespace MyCustomTask
-{
-    public class RandomNumberTask
-    {
-        public static int RandomNumber(int min, int max)
-        {
-            var random = new Random();
-            return random.Next(min, max);
-        }
-    }
-}
-
- -

Using the custom task

- -

Compile the project and put the generated assembly into the tools/FAKE path of your project. Now you can use your CustomTask in the build script:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-
// include Fake libs
-#I @"tools\FAKE"
-#r "FakeLib.dll"
-
-// include CustomTask
-#r "MyCustomTask.dll"
-open Fake 
-
-// open CustomNamespace
-open MyCustomTask
-
-// use custom functionality
-RandomNumberTask.RandomNumber(2,13)
-  |> tracefn "RandomNumber: %d"
-
- -

If you want to use FAKE's standard functionality (like globbing) within your CustomTask project, just reference FakeLib.dll and explore the FAKE namespace.

- - -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/deploy.html b/packages/FAKE.4.11.3/docs/deploy.html deleted file mode 100644 index edbc2f4..0000000 --- a/packages/FAKE.4.11.3/docs/deploy.html +++ /dev/null @@ -1,317 +0,0 @@ - - - - - - Deployment using FAKE - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

Deployment using FAKE

- -

This introduction assumes Fake.Deploy.exe is available in the current directory or path.

- -

Introduction

- -

The FAKE deployment tool allows users to deploy applications to remote computers and to run scripts on these remote agents. A typical scenario maybe as follows:

- -
    -
  • Build an application -> run tests -> create artifacts and save on build server (Classical FAKE build workflow)
  • -
  • Extract artifacts from build server and create a NuGet deployment package
  • -
  • Push the NuGet package to the desired computer this will run the package's FAKE script on the remote machine
  • -
- -

Installing Fake deployment services

- -

In order to deploy application to a remote computer a deployment agent needs to be running on that server.

- -

The simplest way to install the agent on a remote server is to use the Nuget command line tool to download the FAKE nuget and extract the binaries into a fake/tools subfolder. Once nuget.exe is available on the path, use the following command in a command shell:

- - -
1: 
-
nuGet.exe Install FAKE -ExcludeVersion
-
- -

Adding the .../fake/tools folder to the path will simplify executing the Fake.Deploy.exe.

- -

To run an agent in a console, simply run:

- - - - -
1: 
-
Fake.Deploy
-
- -

To install a windows service on that agent:

- -
    -
  • Open a command prompt with Administrator Priviledges
  • -
  • Run Fake.Deploy /install
  • -
- -

By default the service starts a listener on port 8080. This can however be configured by editing the Fake.Deploy.exe.config file -and changing

- - - - -
1: 
-2: 
-
<add key="ServerName" value="localhost" />
-<add key="Port" value="8080" />
-
- -

to the desired value. If you use the asterisk as port no. then Fake.Deploy will assign the first open port behind of 8080.

- -

To ensure the service is running you can navigate to http://{computer}:{port}/fake/ and you should be presented with a page giving the -status if the service

- -

Uninstalling Fake deployment services

- -

To uninstall an agent

- -
    -
  • Open a command prompt with Administrator Priviledges
  • -
  • Run Fake.Deploy /uninstall
  • -
- -

Running a FAKE Deployment Package

- -

Getting help

- -

If you want to learn about Fake.Deploy's command line switches then run:

- - - - -
1: 
-
Fake.Deploy /help
-
- -

Creating a Deployment package

- -

Since Fake.Deploy uses Nuget packages for deployment you only need to create one of those and include a .fsx file in the root folder of the package.

- -

Instructions for creating nuget packages can be found at the NuGet document page

- -

Running deployment

- -

Fake deployment packages can be run manually on the current machine or they can be pushed to an agent on a remote machine.

- -

To run a package on the local machine located at C:\Appdev\MyDeployment.nupkg you would run the following command:

- - - - -
1: 
-
Fake.Deploy /deploy C:
-
- -

To run the same package on a remote computer (e.g. integration-1) you can run:

- - - - -
1: 
-
Fake.Deploy /deployRemote http://integration-1:8080 C:\Appdev\MyDeployment.nupkg
-
- -

It's also possible to just make a HTTP-POST with the package to http://integration-1:8080/fake

- -

This will push the directory to the given url. It is worth noting that the port may well be different, as this depends on the configuration of the -listening agent (see. Installing Fake deployment service)

- -

Getting information about the deployments

- - - - -
1: 
-
The following assumes you have Fake.Deploy running.
-
- -

It's easy to get information about the deployments. Just make a HTTP request to server with:

- - - - -
1: 
-2: 
-3: 
-4: 
-
fake/deployments/                     -> gives all releases
-fake/deployments?status=active        -> gives all active releases
-fake/deployments/{app}                -> gives all releases of app
-fake/deployments/{app}?status=active  -> gives the active release of the app
-
- -

Rollback of releases

- -

If you want to perform a rollback of a release so do a HTTP-PUT to:

- - - - -
1: 
-2: 
-
fake/deployments/{app}?version={version} -> rolls the app back to the given version
-fake/deployments/{app}?version=HEAD~2    -> relative rollback of the app (two versions earlier)
-
- -

Security

- -

To turn on authentication in Fake.Deploy set the configuration value for 'Authorization' to 'On' (default is 'Off') in fake.deploy.config. -When you set this value to 'On' you must also set the configuration key 'AuthorizedKeysFile' to point to a file that that contains the mapping between keys and usernames.

- - - - -
1: 
-2: 
-
<add key="Authorization" value="On" />
-<add key="AuthorizedKeysFile" value="c:\fake_deploy\authorized_keys" />
-
- -

If you deploy from a fake buildscript you need to make a call to FakeDeployAgentHelper.authenticate before you perfrom any other call to the agent. -authenticate takes 4 parameters, server, userId, pathToPrivateKey and the password for the private key

- -

AuthorizedKeysFile

- -

Is a rsa-pub key file where each line represents one user.

- - - - -
1: 
-
ssh-rsa AAAAB3NzaC1yc2EAAAABJ_some_parts_removed_E91p+8JLFCaF3tLc8Aw== Test@Fake.org
-
- -

Each row has 3 values separated by space

- - - - -
1: 
-2: 
-3: 
-
* which type of key it is, it must be 'ssh-rsa'
-* public key in base64 format
-* username the key maps to.
-
- -

How to authorize against Fake.Deploy

- -

First you must perform a HTTP-GET to: - fake/login/yourUserId

- -

From the response from this request, you take the body and base64 decode it, then you sign that value with your private key. -Then you submit a HTTP-POST to - /fake/login. -There are 2 values you need to supply in the HTTP-POST.

- -
    -
  1. challenge which should have the same base64 encoded value you received in the body of get fake/login/userId.
  2. -
  3. signature which should contain the signature you created using the challenge value and your private key.
  4. -
- -

The body of the response from the HTTP-POST contains a guid, this guid should be passed in the header with the name AuthToken. -To logout make a HTTP-GET to: - fake/logout

- -

How do I generate a key on Windows?

- -

Get PuTTYgen. -Run it. -Make sure the key is 'SSH-2 RSA' and number of bits is (at least) 2048. -Click Generate and follow the instructions to genereate the key. -When the key is generated, change Key comment to be your username and set a passphrase. -Then save the public key, you need to put this into Fake.Deploy's authorized keys file. -To save the private key, click Conversions menu option and then click Export OpenSSH key

- -

Linux

- -

ssh-keygen -t rsa -b 2048 -N password

- - -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/fluentmigrator.html b/packages/FAKE.4.11.3/docs/fluentmigrator.html deleted file mode 100644 index cd02287..0000000 --- a/packages/FAKE.4.11.3/docs/fluentmigrator.html +++ /dev/null @@ -1,251 +0,0 @@ - - - - - - Running database migrations with FluentMigrator - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

Running database migrations with FluentMigrator

- -

FluentMigrator is a .NET library which helps to version database schema using incremental migrations which are described in C#. -The basic idea of the FAKE helper is to run FluentMigrator over the existing database using compiled assembly with migrations.

- -

Migrating your database to the latest version

- -

FAKE's support for FluentMigrator ships with a separate NuGet package called FAKE.FluentMigrator. -Usually your FAKE setup will look as follows:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-21: 
-22: 
-23: 
-24: 
-25: 
-26: 
-27: 
-28: 
-29: 
-30: 
-
// Reference required dlls
-#r @"packages/FAKE/tools/FakeLib.dll"
-#r @"packages/FAKE/tools/Fake.FluentMigrator.dll"
-
-open Fake
-open Fake.FluentMigratorHelper
-
-// Assemblies with migrations
-let assemblies = ["Migrations.dll"]
-
-// Using SQL Server 2014 LocalDB
-let connection = 
-  ConnectionString(
-      @"Data Source=(localdb)\MSSQLLocalDb;Initial Catalog=MyDB;Integrated Security=True", 
-      SqlServer(V2014))
-
-// Specify additional options or just use the defaults
-let options = {DefaultMigrationOptions with Profile="Staging"; Tags = ["US"; "Canada"]}
-
-Target "Build" (fun _ 
-    // Build your Migrations.dll assembly using MSBuild or whatever
-)
-
-Target "MigrateDatabase" (fun _ 
-    MigrateToLatest connection [assembly] options
-)
-
-"Build" ==> "MigrateDatabase"
-
-RunTargetOrDefault "MigrateDatabase"
-
- -

ConnectionStrings

- -

Specify connection string in build script:

- - - - -
1: 
-
let connection = ConnectionString("Server=.;Database=TestDb;User Id=admin;Password=pss;", SqlServer(V2008))
-
- -

Use connection string from config file:

- - - - -
1: 
-
let connection = ConnectionStringFromConfig("ConnectionStringKey", "Project\\Web.config", SqlServer(V2012))
-
- -

Providers / drivers / SQL dialects

- -

The following drivers are supported:

- -
    -
  • SqlServer (SqlServerVersion.Default, V2000, V2005, V2008, V2012, V2014)
  • -
  • SqlServer (CE)
  • -
  • Oracle (OracleVersion.Default, Managed, DotConnect)
  • -
  • DB2
  • -
  • Firebird
  • -
  • HANA
  • -
  • Jet
  • -
  • MySql
  • -
  • PostgreSQL
  • -
  • SQLite
  • -
- -

Available commands

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-
// Migrate to the latest available version
-MigrateToLatest connection assemblies options
-
-// Migrate to the specified version
-MigrateUp version connection assemblies options
-
-// Rollback to the specified version
-MigrateDown version connection assemblies options
-
-// Rollback N migrations
-Rollback N connection assemblies options
-
-// Rollback N migrations
-Rollback N connection assemblies options
-
-// List applied migrations
-ListAppliedMigrations connection assemblies
-
- -

Advanced usage

- -

For advanced usage see the source code.

- -
val assemblies : string list

Full name: fluentmigrator.assemblies
-
val connection : obj

Full name: fluentmigrator.connection
-
val options : obj

Full name: fluentmigrator.options
- -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/fsc.html b/packages/FAKE.4.11.3/docs/fsc.html deleted file mode 100644 index 8d3e895..0000000 --- a/packages/FAKE.4.11.3/docs/fsc.html +++ /dev/null @@ -1,259 +0,0 @@ - - - - - - Compiling F# Sources - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

Compiling F# Sources

- -

The Fsc task set in FAKE can be used to build F# source files and output libraries, modules, -and executables by using the bundled -FSharp.Compiler.Service. -In this tutorial we will look at these compile tasks.

- -

The Fsc task

- -

The Fsc task can be used in standard FAKE targets:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-21: 
-22: 
-23: 
-24: 
-25: 
-26: 
-27: 
-28: 
-
#r "/path/to/FakeLib.dll"
-open Fake
-open Fake.FscHelper
-
-Target "Something.dll" (fun _ ->
-  !! "src/**/*.fs"
-  |> Fsc (fun p ->
-           { p with Output = "Something.dll"
-                    FscTarget = Library })
-)
-
-Target "Otherthing.dll" (fun _ ->
-  ["Otherthing.fs"; "Otherthing2.fs"]
-  |> Fsc (fun p -> { p with FscTarget = Library })
-)
-
-Target "Main.exe" (fun _ ->
-  ["Main.fs"]
-  |> Fsc (fun p ->
-           { p with References =
-                      [ "Something.dll"
-                        "Otherthing.dll" ] })
-)
-
-"Something.dll"
-  ==> "Otherthing.dll"
-  ==> "Main.exe"
-RunTargetOrDefault "Main.exe"
-
- -

The Fsc task takes two arguments:

- -
    -
  1. a function which overrides the default compile parameters, and
  2. -
  3. a list of source files.
  4. -
- -

We start with the list of source files, and send it into the Fsc task using F#'s -|> operator. The parameter override function takes the default compile parameters and -needs to return the parameters with any, all, or no parameters overridden.

- -

In the above examples, notice that we don't always override the output -file name. By default Fsc will behave exactly the same way as -fsc.exe. If you don't specify an output file: it will use the name of -the first input file, and the appropriate filename extension.

- -

The FscTarget slot also behaves in the same way as the fsc.exe ---target: switch: if you don't override it, it defaults to an -executable output type.

- -

You can override all fsc.exe compile parameters using the override -function. Several of them, like Output, References, etc., are made -directly available; the others can all be set inside the OtherParams -slot as a list of strings:

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-8: 
-9: 
-
Target "Something.dll" (fun _ ->    
-    ["Something.fs"]
-    |> Fsc (fun p ->
-             { p with Output = "Something.dll"
-                      FscTarget = Library
-                      OtherParams =
-                         [ "--nooptimizationdata"
-                           "--checked+" ] })
-)
-
- -

See the API docs for Fsc for details of -the available parameters.

- -

The Fsc task will print any compile warnings or errors. If there's any -compile error, it will notify you and immediately quit.

- -

The fsc task

- -

The next task that can compile F# sources starts with a lowercase 'f'. -It takes exactly the same arguments and can be called in exactly the -same way as the Fsc task. The only difference is that fsc doesn't -raise any error--instead, it returns the exit status of the compile -process. It still does print warnings and errors, though.

- -

Having an exit status code returned can be useful when you're trying to -integrate FAKE with other build management tools, e.g. your own CI -server or a test runner.

- -

The fscList helper

- -

This task is lower level than the previous two. It takes a list of -source files and a list of strings which contains the same arguments -you'd pass in to the fsc.exe command-line tool. Think of it as exactly -like the OtherParams slot shown above, only here it's used to specify -all the parameters. It too prints warnings and errors, and returns a -compile exit status code. E.g.:

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-
Target "Something.dll" (fun _ ->
-    ["Something.fs"]
-    |> fscList ["-o"; "Something.dll"; "--target:library"]
-    |> ignore
-)
-
- -

This task may be useful when you already have compile options in string -format and just need to pass them in to your build tool. You'd just need -to split the string on whitespace, and pass the resulting list into -fscList.

- -
val ignore : value:'T -> unit

Full name: Microsoft.FSharp.Core.Operators.ignore
- -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/fxcop.html b/packages/FAKE.4.11.3/docs/fxcop.html deleted file mode 100644 index 0716302..0000000 --- a/packages/FAKE.4.11.3/docs/fxcop.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - - - Adding FxCop to a FAKE build script - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

Adding FxCop to a FAKE build script

- -

This article is an extension to the getting started guide. You will improve the same Calculator sample with a task for FxCop.

- -

If you need more details please see the API docs for the FxCop task.

- -

Setting up FxCop

- -

Open build.fsx from your Calculator sample folder and add a new target FxCop to the targets section:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-
Target "FxCop" (fun () ->  
-    !! (buildDir + @"\**\*.dll") 
-    ++ (buildDir + @"\**\*.exe") 
-    |> FxCop 
-        (fun p -> 
-            {p with 
-              // override default parameters
-              ReportFileName = testDir + "FXCopResults.xml"
-              ToolPath = "FxCopCmd.exe"})
-)
-
- -

In the dependencies section modify the build order to:

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-
"Clean"
-  ==> "BuildApp"
-  ==> "FxCop"
-  ==> "BuildTest"
-  ==> "Test"
-  ==> "Deploy"
-  ==> "Default"
-
- -

That's it. If you run your build script you will get new .xml file in the ./test* folder:

- -

alt text

- -

Letting the build fail

- -

If you want to let the build fail in the case that FxCop reports any errors or warnings you can use the FailOnError parameter:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-
Target "FxCop" (fun () ->  
-    !! (buildDir + @"\**\*.dll") 
-    ++ (buildDir + @"\**\*.exe") 
-    |> FxCop 
-        (fun p -> 
-            {p with 
-              // override default parameters
-              ReportFileName = testDir + "FXCopResults.xml"
-              FailOnError = FxCopErrorLevel.CriticalWarning
-              ToolPath = "FxCopCmd.exe"})
-)
-
- -

alt text

- -

If you activate this option FxCop errors will cause your build to fail. Possible values are:

- -
    -
  • FxCopErrorLevel.Warning
  • -
  • FxCopErrorLevel.CriticalWarning
  • -
  • FxCopErrorLevel.Error
  • -
  • FxCopErrorLevel.CriticalError
  • -
  • FxCopErrorLevel.ToolError
  • -
  • FxCopErrorLevel.DontFailBuild
  • -
- -

The values are cummulative. If you choose FxCopErrorLevel.CriticalWarning the build will fail for critical warnings, errors, critical errors and FxCop tool errors but not for simple warnings. The default is FxCopErrorLevel.DontFailBuild.

- - -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/gettingstarted.html b/packages/FAKE.4.11.3/docs/gettingstarted.html deleted file mode 100644 index d1f9669..0000000 --- a/packages/FAKE.4.11.3/docs/gettingstarted.html +++ /dev/null @@ -1,794 +0,0 @@ - - - - - - Getting started with FAKE - F# Make - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

Getting started with FAKE - F# Make

- -

In this tutorial you will learn how to set up a complete build infrastructure with "FAKE - F# Make". This includes:

- -
    -
  • how to install the latest FAKE version
  • -
  • how to automatically compile your C# or F# projects
  • -
  • how to automatically resolve nuget dependencies
  • -
  • how to automatically run NUnit tests on your projects
  • -
  • how to zip the output to a deployment folder
  • -
- -

Install the F# compiler

- -

"FAKE - F# Make" is completely written in F# and all build scripts will also be written in F#, but this doesn't imply that you have to learn programming in F#. In fact the "FAKE - F# Make" syntax is hopefully very easy to learn.

- -

Download Calculator Sample

- -

Now download the latest FAKE-Calculator.zip from the FAKE project site. This sample includes 3 tiny projects and has basically the following structure:

- -
    -
  • src/app -
      -
    • Calculator (command line)
    • -
    • CalculatorLib (class library)
    • -
  • -
  • src/test -
      -
    • Test.CalculatorLib
    • -
  • -
  • tools -
      -
    • NUnit
    • -
    • FxCop
    • -
  • -
  • build.bat
  • -
  • build.fsx
  • -
  • completeBuild.bat
  • -
  • completeBuild.fsx
  • -
  • Calculator.sln
  • -
- -

Getting "FAKE - F# Make" started

- -

In the root of the project you will find a build.bat file:

- - -
1: 
-2: 
-3: 
-4: 
-5: 
-
@echo off
-cls
-".nuget\NuGet.exe" "Install" "FAKE" "-OutputDirectory" "packages" "-ExcludeVersion"
-"packages\FAKE\tools\Fake.exe" build.fsx
-pause
-
- -

If you run this batch file from the command line then the latest FAKE version will be downloaded via nuget and your first FAKE script (build.fsx) will be executed. If everything works fine you will get the following output:

- -

alt text

- -

Paket Setup

- -

Alternatively you can configure Paket to install and manage FAKE as a dependency. You will have to setup Paket following the instructions specified in its documentation. In this example, the installation per repository will be used.

- -
    -
  • Create a .paket folder in the root of the FAKE-Calculator solution.
  • -
  • Download the latest paket.bootstrapper.exe into that folder.
  • -
  • Run $ .paket/paket.bootstrapper.exe This will download the latest paket.exe.
  • -
  • Commit .paket/paket.bootstrapper.exe into your repo and add .paket/paket.exe to your .gitignore file.
  • -
- -

Specifying dependencies

- -

Create a paket.dependencies file in your project's root and specify FAKE as a dependency in it. -The file might look like this:

- - - - -
1: 
-2: 
-3: 
-
source https://nuget.org/api/v2
-
-nuget FAKE
-
- -

You can now run Paket from the command line:

- - - - -
1: 
-
$ .paket/paket.exe install
-
- -

This will create the paket.lock file in your project's root. The file might look like this:

- - - - -
1: 
-2: 
-3: 
-4: 
-
NUGET
-    remote: https://nuget.org/api/v2
-    specs:
-        FAKE (4.7.2)
-
- -

You will have to replace the build.bat file contents with the following:

- - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-
@echo off
-cls
-
-.paket\paket.bootstrapper.exe
-if errorlevel 1 (
-    exit /b %errorlevel%
-)
-
-.paket\paket.exe restore
-if errorlevel 1 (
-    exit /b %errorlevel%
-)
-
-packages\FAKE\tools\FAKE.exe build.fsx %*
-
- -

If you run this batch file from the command line, Paket will be bootstrapped and the paket dependencies will be restored before running the build script. -In this case, then the latest FAKE version will be downloaded via nuget. -If everything works fine you will get the following output:

- -

alt text

- -

The build script

- -

Now open the build.fsx in Visual Studio or any text editor. It should look like this:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-
// include Fake lib
-#r @"packages/FAKE/tools/FakeLib.dll"
-open Fake
-
-// Default target
-Target "Default" (fun _ ->
-    trace "Hello World from FAKE"
-)
-
-// start build
-RunTargetOrDefault "Default"
-
- -

As you can see the code is really simple. The first line includes the FAKE library and is vital for all FAKE build scripts.

- -

After this header the Default target is defined. A target definition contains two important parts. The first is the name of the target (here "Default") and the second is an action (here a simple trace of "Hello world").

- -

The last line runs the "Default" target - which means it executes the defined action of the target.

- -

Cleaning the last build output

- -

A typical first step in most build scenarios is to clean the output of the last build. We can achieve this by modifying the build.fsx to the following:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-21: 
-22: 
-
// include Fake lib
-#r "packages/FAKE/tools/FakeLib.dll"
-open Fake
-
-// Properties
-let buildDir = "./build/"
-
-// Targets
-Target "Clean" (fun _ ->
-    CleanDir buildDir
-)
-
-Target "Default" (fun _ ->
-    trace "Hello World from FAKE"
-)
-
-// Dependencies
-"Clean"
-  ==> "Default"
-
-// start build
-RunTargetOrDefault "Default"
-
- -

We introduced some new concepts in this snippet. At first we defined a global property called "buildDir" with the relative path of a temporary build folder.

- -

In the Clean target we use the CleanDir task to clean up this build directory. This simply deletes all files in the folder or creates the directory if necessary.

- -

In the dependencies section we say that the Default target has a dependency on the Clean target. In other words Clean is a prerequisite of Default and will be run before the execution of Default:

- -

alt text

- -

Compiling the application

- -

In the next step we want to compile our C# libraries, which means we want to compile all csproj-files under /src/app with MSBuild:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-21: 
-22: 
-23: 
-24: 
-25: 
-26: 
-27: 
-28: 
-29: 
-
// include Fake lib
-#r "packages/FAKE/tools/FakeLib.dll"
-open Fake
-
-// Properties
-let buildDir = "./build/"
-
-// Targets
-Target "Clean" (fun _ ->
-    CleanDir buildDir
-)
-
-Target "BuildApp" (fun _ ->
-    !! "src/app/**/*.csproj"
-      |> MSBuildRelease buildDir "Build"
-      |> Log "AppBuild-Output: "
-)
-
-Target "Default" (fun _ ->
-    trace "Hello World from FAKE"
-)
-
-// Dependencies
-"Clean"
-  ==> "BuildApp"
-  ==> "Default"
-
-// start build
-RunTargetOrDefault "Default"
-
- -

We defined a new build target named "BuildApp" which compiles all csproj-files with the MSBuild task and the build output will be copied to buildDir.

- -

In order to find the right project files FAKE scans the folder src/app/ and all subfolders with the given pattern. Therefore a similar FileSet definition like in NAnt or MSBuild (see project page for details) is used.

- -

In addition the target dependencies are extended again. Now Default is dependent on BuildApp and BuildApp needs Clean as a prerequisite.

- -

This means the execution order is: Clean ==> BuildApp ==> Default.

- -

alt text

- -

Compiling test projects

- -

Now our main application will be built automatically and it's time to build the test project. We use the same concepts as before:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-21: 
-22: 
-23: 
-24: 
-25: 
-26: 
-27: 
-28: 
-29: 
-30: 
-31: 
-32: 
-33: 
-34: 
-35: 
-36: 
-37: 
-
// include Fake lib
-#r "packages/FAKE/tools/FakeLib.dll"
-open Fake
-
-// Properties
-let buildDir = "./build/"
-let testDir  = "./test/"
-
-// Targets
-Target "Clean" (fun _ ->
-    CleanDirs [buildDir; testDir]
-)
-
-Target "BuildApp" (fun _ ->
-   !! "src/app/**/*.csproj"
-     |> MSBuildRelease buildDir "Build"
-     |> Log "AppBuild-Output: "
-)
-
-Target "BuildTest" (fun _ ->
-    !! "src/test/**/*.csproj"
-      |> MSBuildDebug testDir "Build"
-      |> Log "TestBuild-Output: "
-)
-
-Target "Default" (fun _ ->
-    trace "Hello World from FAKE"
-)
-
-// Dependencies
-"Clean"
-  ==> "BuildApp"
-  ==> "BuildTest"
-  ==> "Default"
-
-// start build
-RunTargetOrDefault "Default"
-
- -

This time we defined a new target "BuildTest" which compiles all C# projects below src/test/ in Debug mode and we put the target into our build order.

- -

If we run build.bat again we get an error like this:

- -

alt text

- -

The problem is that we didn't download the NUnit package from nuget. So let's fix this in the build script:

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-
// include Fake lib
-#r "packages/FAKE/tools/FakeLib.dll"
-open Fake
-
-RestorePackages()
-// ...
-
- -

With this simple command FAKE will use nuget.exe to install all the package dependencies.

- -

Running the tests with NUnit

- -

Now all our projects will be compiled and we can use FAKE's NUnit task in order to let NUnit test our assembly:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-21: 
-22: 
-23: 
-24: 
-25: 
-26: 
-27: 
-28: 
-29: 
-30: 
-31: 
-32: 
-33: 
-34: 
-35: 
-36: 
-37: 
-38: 
-39: 
-40: 
-41: 
-42: 
-43: 
-44: 
-45: 
-46: 
-47: 
-48: 
-
// include Fake lib
-#r "packages/FAKE/tools/FakeLib.dll"
-open Fake
-
-RestorePackages()
-
-// Properties
-let buildDir = "./build/"
-let testDir  = "./test/"
-
-// Targets
-Target "Clean" (fun _ ->
-    CleanDirs [buildDir; testDir]
-)
-
-Target "BuildApp" (fun _ ->
-   !! "src/app/**/*.csproj"
-     |> MSBuildRelease buildDir "Build"
-     |> Log "AppBuild-Output: "
-)
-
-Target "BuildTest" (fun _ ->
-    !! "src/test/**/*.csproj"
-      |> MSBuildDebug testDir "Build"
-      |> Log "TestBuild-Output: "
-)
-
-Target "Test" (fun _ ->
-    !! (testDir + "/NUnit.Test.*.dll")
-      |> NUnit (fun p ->
-          {p with
-             DisableShadowCopy = true;
-             OutputFile = testDir + "TestResults.xml" })
-)
-
-Target "Default" (fun _ ->
-    trace "Hello World from FAKE"
-)
-
-// Dependencies
-"Clean"
-  ==> "BuildApp"
-  ==> "BuildTest"
-  ==> "Test"
-  ==> "Default"
-
-// start build
-RunTargetOrDefault "Default"
-
- -

Our new Test target scans the test directory for test assemblies and runs them with the NUnit runner. FAKE automatically tries to locate the runner in one of your subfolders. See the NUnit task documentation if you need to specify the tool path explicitly.

- -

The mysterious part (fun p -> ...) simply overrides the default parameters of the NUnit task and allows to specify concrete parameters.

- -

alt text

- -

Alternatively you could also run the tests in parallel using the NUnitParallel task:

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-
Target "Test" (fun _ ->
-    !! (testDir + "/NUnit.Test.*.dll")
-      |> NUnitParallel (fun p ->
-          {p with
-             DisableShadowCopy = true;
-             OutputFile = testDir + "TestResults.xml" })
-)
-
- -

Deploying a zip file

- -

Now we want to deploy a *.zip file containing our application:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-21: 
-22: 
-23: 
-24: 
-25: 
-26: 
-27: 
-28: 
-29: 
-30: 
-31: 
-32: 
-33: 
-34: 
-35: 
-36: 
-37: 
-38: 
-39: 
-40: 
-41: 
-42: 
-43: 
-44: 
-45: 
-46: 
-47: 
-48: 
-49: 
-50: 
-51: 
-52: 
-53: 
-54: 
-55: 
-56: 
-57: 
-58: 
-59: 
-
// include Fake lib
-#r "tools/FAKE/tools/FakeLib.dll"
-open Fake
-
-RestorePackages()
-
-// Properties
-let buildDir = "./build/"
-let testDir  = "./test/"
-let deployDir = "./deploy/"
-
-// version info
-let version = "0.2"  // or retrieve from CI server
-
-// Targets
-Target "Clean" (fun _ ->
-    CleanDirs [buildDir; testDir; deployDir]
-)
-
-Target "BuildApp" (fun _ ->
-   !! "src/app/**/*.csproj"
-     |> MSBuildRelease buildDir "Build"
-     |> Log "AppBuild-Output: "
-)
-
-Target "BuildTest" (fun _ ->
-    !! "src/test/**/*.csproj"
-      |> MSBuildDebug testDir "Build"
-      |> Log "TestBuild-Output: "
-)
-
-Target "Test" (fun _ ->
-    !! (testDir + "/NUnit.Test.*.dll")
-      |> NUnit (fun p ->
-          {p with
-             DisableShadowCopy = true;
-             OutputFile = testDir + "TestResults.xml" })
-)
-
-Target "Zip" (fun _ ->
-    !! (buildDir + "/**/*.*")
-        -- "*.zip"
-        |> Zip buildDir (deployDir + "Calculator." + version + ".zip")
-)
-
-Target "Default" (fun _ ->
-    trace "Hello World from FAKE"
-)
-
-// Dependencies
-"Clean"
-  ==> "BuildApp"
-  ==> "BuildTest"
-  ==> "Test"
-  ==> "Zip"
-  ==> "Default"
-
-// start build
-RunTargetOrDefault "Default"
-
- -

The new Deploy target scans the build directory for all files. The result will be zipped to /deploy/Calculator.zip via the Zip task.

- -

What's next?

- -

If you want you could now add a FxCop target to your build in order to check specific naming rules or framework guidelines.

- - -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/iis.html b/packages/FAKE.4.11.3/docs/iis.html deleted file mode 100644 index 5d2f0a2..0000000 --- a/packages/FAKE.4.11.3/docs/iis.html +++ /dev/null @@ -1,172 +0,0 @@ - - - - - - FAKE.IIS - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

FAKE.IIS

- -

FAKE.IIS provides extensions around the Microsoft.Web.Administration library to provide clean interfaces to easily configure IIS Sites and Application Pools.

- -

Creating a ApplicationPool and Site

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-
#r "Fake.IIS.dll"
-#load "IISHelper.fs"
-
-open Fake.IISHelper
-
-let siteName = "fake.site"
-let appPoolName = "fake.appPool"
-let port = ":80:"
-let path =  @"C:\inetpub\wwwroot"
-
-let siteConfig = SiteConfig(siteName, port, path, appPoolName)
-let appPoolConfig = ApplicationPoolConfig(appPoolName)
-
-(IIS
-  (Site siteConfig)
-  (ApplicationPool appPoolConfig)
-  (None))
-
- -

Deleting an Application Pool and Site

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-
#r "Fake.IIS.dll"
-
-#load "IISHelper.fs"
-
-open Fake.IISHelper
-
-let siteName = "fake.site"
-let appPoolName = "fake.appPool"
-
-deleteSite siteName
-deleteApplicationPool appPool
-
- -
val siteName : string

Full name: iis.siteName
-
val appPoolName : string

Full name: iis.appPoolName
-
val port : string

Full name: iis.port
-
val path : string

Full name: iis.path
-
val siteConfig : obj

Full name: iis.siteConfig
-
val appPoolConfig : obj

Full name: iis.appPoolConfig
-
union case Option.None: Option<'T>
- -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/index.html b/packages/FAKE.4.11.3/docs/index.html deleted file mode 100644 index 5fd7fb5..0000000 --- a/packages/FAKE.4.11.3/docs/index.html +++ /dev/null @@ -1,589 +0,0 @@ - - - - - - FAKE - F# Make - A DSL for build tasks - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

FAKE - F# Make - A DSL for build tasks

- -

"FAKE - F# Make" is a build automation system with capabilities which are similar to make and rake. -It is using an easy domain-specific language (DSL) so that you can start using it without learning F#. -If you need more than the default functionality you can either write F# or simply reference .NET assemblies.

- -

Simple Example

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-
#r "tools/FAKE/tools/FakeLib.dll" // include Fake lib
-open Fake 
-
-
-Target "Test" (fun _ ->
-    trace "Testing stuff..."
-)
-
-Target "Deploy" (fun _ ->
-    trace "Heavy deploy action"
-)
-
-"Test"            // define the dependencies
-   ==> "Deploy"
-
-Run "Deploy"
-
- -

This build script has two targets. The "Deploy" target has exactly one dependency, namely the "Test" target. Invoking the "Deploy" target (line 16) will cause FAKE to invoke the "Test" target as well.

- -

Who is using FAKE?

- -

Some of our users are:

- - - -

You can find more users here.

- -

How to get FAKE

- -
-
-
-
- FAKE is available on NuGet. - To install the tool, run the following command in the Package Manager Console: -
PM> Install-Package FAKE
-
-
-
-
- - - -

Using FAKE

- -

If you want to learn about FAKE you should read the "Getting started with FAKE" tutorial.

- -

Targets

- -

Targets are the main unit of work in a "FAKE - F# Make" script. Targets have a name and an action (given as a code block).

- - - - -
1: 
-2: 
-3: 
-4: 
-
// The clean target cleans the build and deploy folders
-Target "Clean" (fun _ -> 
-    CleanDirs ["./build/"; "./deploy/"]
-)
-
- -

Build target order

- -

You can specify the build order using the ==> operator:

- - - - -
1: 
-2: 
-3: 
-4: 
-
// "FAKE - F# Make" will run these targets in the order Clean, BuildApp, Default
-"Clean" 
-  ==> "BuildApp" 
-  ==> "Default"
-
- -

If one target should only be run on a specific condition you can use the =?> operator:

- - - - -
1: 
-2: 
-3: 
-4: 
-
"Clean" 
-  ==> "BuildApp"
-  =?> ("Test",hasBuildParam "xUnitTest")  // only if FAKE was called with parameter xUnitTest
-  ==> "Default"
-
- -

Running targets

- -

You can execute targets with the "RunTargetOrDefault"-function (for more details see Running specific targets):

- - - - -
1: 
-
RunTargetOrDefault "Default"
-
- -

FileSets

- -

"FAKE - F# Make" uses similar include and exclude patterns as NAnt and MSBuild.

- -

File includes

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-
// Includes all *.csproj files under /src/app by using the !! operator
-!! "src/app/**/*.csproj"
-
-// Includes all *.csproj files under /src/app and /test with the ++ operator
-!! "src/app/**/*.csproj"
-  ++ "test/**/*.csproj"
-
- -

File excludes

- - - - -
1: 
-2: 
-3: 
-
// Includes all files under /src/app but excludes *.zip files
-!! "src/app/**/*.*"
-  -- "*.zip"
-
- -

UnitTests

- -

NUnit

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-
// define test dlls
-let testDlls = !! (testDir + "/Test.*.dll")
-
-Target "NUnitTest" (fun _ ->
-    testDlls
-        |> NUnit (fun p -> 
-            {p with
-                DisableShadowCopy = true; 
-                OutputFile = testDir + "TestResults.xml"})
-)
-
- -

MSpec

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-
// define test dlls
-let testDlls = !! (testDir + "/Test.*.dll")
-
-Target "MSpecTest" (fun _ ->
-    testDlls
-        |> MSpec (fun p -> 
-            {p with 
-                ExcludeTags = ["LongRunning"]
-                HtmlOutputDir = testOutputDir})
-)
-
- -

xUnit.net

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-
// define test dlls
-let testDlls = !! (testDir + "/Test.*.dll")
-
-Target "xUnitTest" (fun _ ->
-    testDlls
-        |> xUnit (fun p -> 
-            {p with 
-                ShadowCopy = false;
-                HtmlOutput = true;
-                XmlOutput = true;
-                OutputDir = testDir })
-)
-
- -

Sample script

- -

This sample script

- -
    -
  • Assumes "FAKE - F# Make" is located at ./tools/FAKE
  • -
  • Assumes NUnit is located at ./tools/NUnit
  • -
  • Cleans the build and deploy paths
  • -
  • Builds all C# projects below src/app/ and puts the output to ./build
  • -
  • Builds all NUnit test projects below src/test/ and puts the output to ./build
  • -
  • Uses NUnit to test the generated Test.*.dll's
  • -
  • Zips all generated files to deploy/MyProject-0.1.zip
  • -
- -

You can read the getting started guide to build such a script.

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-21: 
-22: 
-23: 
-24: 
-25: 
-26: 
-27: 
-28: 
-29: 
-30: 
-31: 
-32: 
-33: 
-34: 
-35: 
-36: 
-37: 
-38: 
-39: 
-40: 
-41: 
-42: 
-43: 
-44: 
-45: 
-46: 
-47: 
-48: 
-49: 
-50: 
-51: 
-52: 
-53: 
-54: 
-55: 
-56: 
-57: 
-58: 
-59: 
-60: 
-61: 
-62: 
-63: 
-64: 
-65: 
-66: 
-67: 
-68: 
-69: 
-70: 
-71: 
-72: 
-73: 
-74: 
-75: 
-76: 
-77: 
-78: 
-79: 
-80: 
-81: 
-82: 
-83: 
-84: 
-85: 
-86: 
-87: 
-88: 
-89: 
-90: 
-91: 
-92: 
-93: 
-94: 
-95: 
-96: 
-97: 
-98: 
-99: 
-
// include Fake libs
-#r "tools/FAKE/FakeLib.dll"
-
-open Fake
-
-// Directories
-let buildDir  = "./build/"
-let testDir   = "./test/"
-let deployDir = "./deploy/"
-
-// tools
-let fxCopRoot = "./Tools/FxCop/FxCopCmd.exe"
-
-// Filesets
-let appReferences  = 
-    !! "src/app/**/*.csproj" 
-      ++ "src/app/**/*.fsproj"
-
-let testReferences = !! "src/test/**/*.csproj"
-
-// version info
-let version = "0.2"  // or retrieve from CI server
-
-// Targets
-Target "Clean" (fun _ -> 
-    CleanDirs [buildDir; testDir; deployDir]
-)
-
-Target "BuildApp" (fun _ ->
-    CreateCSharpAssemblyInfo "./src/app/Calculator/Properties/AssemblyInfo.cs"
-        [Attribute.Title "Calculator Command line tool"
-         Attribute.Description "Sample project for FAKE - F# MAKE"
-         Attribute.Guid "A539B42C-CB9F-4a23-8E57-AF4E7CEE5BAA"
-         Attribute.Product "Calculator"
-         Attribute.Version version
-         Attribute.FileVersion version]
-
-    CreateCSharpAssemblyInfo "./src/app/CalculatorLib/Properties/AssemblyInfo.cs"
-        [Attribute.Title "Calculator library"
-         Attribute.Description "Sample project for FAKE - F# MAKE"
-         Attribute.Guid "EE5621DB-B86B-44eb-987F-9C94BCC98441"
-         Attribute.Product "Calculator"
-         Attribute.Version version
-         Attribute.FileVersion version]
-
-    // compile all projects below src/app/
-    MSBuildRelease buildDir "Build" appReferences
-        |> Log "AppBuild-Output: "
-)
-
-Target "BuildTest" (fun _ ->
-    MSBuildDebug testDir "Build" testReferences
-        |> Log "TestBuild-Output: "
-)
-
-Target "NUnitTest" (fun _ ->  
-    !! (testDir + "/NUnit.Test.*.dll")
-        |> NUnit (fun p -> 
-            {p with
-                DisableShadowCopy = true; 
-                OutputFile = testDir + "TestResults.xml"})
-)
-
-Target "xUnitTest" (fun _ ->  
-    !! (testDir + "/xUnit.Test.*.dll")
-        |> xUnit (fun p -> 
-            {p with 
-                ShadowCopy = false;
-                HtmlOutput = true;
-                XmlOutput = true;
-                OutputDir = testDir })
-)
-
-Target "FxCop" (fun _ ->
-    !! (buildDir + "/**/*.dll") 
-        ++ (buildDir + "/**/*.exe")
-        |> FxCop (fun p -> 
-            {p with                     
-                ReportFileName = testDir + "FXCopResults.xml";
-                ToolPath = fxCopRoot})
-)
-
-Target "Deploy" (fun _ ->
-    !! (buildDir + "/**/*.*") 
-        -- "*.zip" 
-        |> Zip buildDir (deployDir + "Calculator." + version + ".zip")
-)
-
-// Build order
-"Clean"
-  ==> "BuildApp"
-  ==> "BuildTest"
-  ==> "FxCop"
-  ==> "NUnitTest"
-  =?> ("xUnitTest",hasBuildParam "xUnitTest")  // only if FAKE was called with parameter xUnitTest
-  ==> "Deploy"
-
-// start build
-RunTargetOrDefault "Deploy"
-
- -
val testDlls : '_arg2

Full name: index.testDlls
-
val buildDir : string

Full name: index.buildDir
-
val testDir : string

Full name: index.testDir
-
val deployDir : string

Full name: index.deployDir
-
val fxCopRoot : string

Full name: index.fxCopRoot
-
val appReferences : '_arg3

Full name: index.appReferences
-
val version : string

Full name: index.version
- -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/literate/build.html b/packages/FAKE.4.11.3/docs/literate/build.html deleted file mode 100644 index b5003c6..0000000 --- a/packages/FAKE.4.11.3/docs/literate/build.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - build - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
- - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-21: 
-22: 
-23: 
-24: 
-25: 
-26: 
-27: 
-28: 
-29: 
-30: 
-31: 
-32: 
-33: 
-34: 
-35: 
-36: 
-37: 
-38: 
-39: 
-40: 
-41: 
-42: 
-43: 
-44: 
-45: 
-46: 
-47: 
-48: 
-49: 
-50: 
-51: 
-52: 
-53: 
-54: 
-55: 
-56: 
-57: 
-58: 
-59: 
-60: 
-61: 
-62: 
-63: 
-64: 
-65: 
-66: 
-67: 
-68: 
-69: 
-70: 
-71: 
-72: 
-73: 
-74: 
-75: 
-76: 
-77: 
-
// Given a typical setup (with 'FSharp.Formatting' referenced using NuGet),
-// the following will include binaries and load the literate script
-#I "../lib/net40/"
-#r "FSharp.Literate.dll"
-#r "FSharp.CodeFormat.dll"
-#r "FSharp.MetadataFormat.dll"
-open System.IO
-open FSharp.Literate
-
-// ----------------------------------------------------------------------------
-// SETUP
-// ----------------------------------------------------------------------------
-
-/// Return path relative to the current file location
-let relative subdir = Path.Combine(__SOURCE_DIRECTORY__, subdir)
-
-// Create output directories & copy content files there
-// (We have two sets of samples in "output" and "output-all" directories,
-//  for simplicitly, this just creates them & copies content there)
-if not (Directory.Exists(relative "/output")) then
-  Directory.CreateDirectory(relative "/output") |> ignore
-  Directory.CreateDirectory (relative "/output/content") |> ignore
-if not (Directory.Exists(relative "/output-all")) then
-  Directory.CreateDirectory(relative "/output-all") |> ignore
-  Directory.CreateDirectory (relative "/output-all/content") |> ignore
-
-for fileInfo in DirectoryInfo(relative "/../content").EnumerateFiles() do
-  fileInfo.CopyTo(Path.Combine(relative "/output/content", fileInfo.Name)) |> ignore
-  fileInfo.CopyTo(Path.Combine(relative "/output-all/content", fileInfo.Name)) |> ignore
-
-// ----------------------------------------------------------------------------
-// EXAMPLES
-// ----------------------------------------------------------------------------
-
-/// Processes a single F# Script file and produce HTML output
-let processScriptAsHtml () =
-  let file = relative "/demo.fsx"
-  let output = relative "/output/demo-script.html"
-  let template = relative "/templates/template-file.html"
-  Literate.ProcessScriptFile(file, template, output)
-
-/// Processes a single F# Script file and produce LaTeX output
-let processScriptAsHtml () =
-  let file = relative "/demo.fsx"
-  let output = relative "/output/demo-script.html"
-  let template = relative "/templates/template-color.tex"
-  Literate.ProcessScriptFile(file, template, output, format = OutputKind.Latex)
-
-
-/// Processes a single Markdown document and produce HTML output
-let processDocument templateFile outputKind =
-  let file = relative "/demo.md"
-  let output = relative "/output/demo-markdown.html"
-  let template = relative "/templates/template-file.html"
-  Literate.ProcessMarkdown(file, template, output)
-
-/// Processes a single Markdown document and produce LaTeX output
-let processDocument templateFile outputKind =
-  let file = relative "/demo.md"
-  let output = relative "/output/demo-markdown.tex"
-  let template = relative "/templates/template-color.tex"
-  Literate.ProcessMarkdown(file, template, output, format = outputKind)
-
-
-/// Processes an entire directory containing multiple script files 
-/// (*.fsx) and Markdown documents (*.md) and it specifies additional 
-/// replacements for the template file
-let processDirectory() =
-  let template = relative "/templates/template-project.html"
-  let projInfo =
-    [ "page-description", "F# Literate Programming"
-      "page-author", "Tomas Petricek"
-      "github-link", "https://github.com/tpetricek/FSharp.Formatting"
-      "project-name", "F# Formatting" ]
-  Literate.ProcessDirectory
-    ( __SOURCE_DIRECTORY__, template, dir + "/output-all", 
-      OutputKind.Html, replacements = projInfo)
-
- -
namespace System
-
namespace System.IO
-
namespace Microsoft.FSharp
-
val relative : subdir:string -> string

Full name: Build.relative


 Return path relative to the current file location
-
val subdir : string
-
type Path =
  static val DirectorySeparatorChar : char
  static val AltDirectorySeparatorChar : char
  static val VolumeSeparatorChar : char
  static val InvalidPathChars : char[]
  static val PathSeparator : char
  static member ChangeExtension : path:string * extension:string -> string
  static member Combine : [<ParamArray>] paths:string[] -> string + 3 overloads
  static member GetDirectoryName : path:string -> string
  static member GetExtension : path:string -> string
  static member GetFileName : path:string -> string
  ...

Full name: System.IO.Path
-
Path.Combine([<System.ParamArray>] paths: string []) : string
Path.Combine(path1: string, path2: string) : string
Path.Combine(path1: string, path2: string, path3: string) : string
Path.Combine(path1: string, path2: string, path3: string, path4: string) : string
-
val not : value:bool -> bool

Full name: Microsoft.FSharp.Core.Operators.not
-
type Directory =
  static member CreateDirectory : path:string -> DirectoryInfo + 1 overload
  static member Delete : path:string -> unit + 1 overload
  static member EnumerateDirectories : path:string -> IEnumerable<string> + 2 overloads
  static member EnumerateFileSystemEntries : path:string -> IEnumerable<string> + 2 overloads
  static member EnumerateFiles : path:string -> IEnumerable<string> + 2 overloads
  static member Exists : path:string -> bool
  static member GetAccessControl : path:string -> DirectorySecurity + 1 overload
  static member GetCreationTime : path:string -> DateTime
  static member GetCreationTimeUtc : path:string -> DateTime
  static member GetCurrentDirectory : unit -> string
  ...

Full name: System.IO.Directory
-
Directory.Exists(path: string) : bool
-
Directory.CreateDirectory(path: string) : DirectoryInfo
Directory.CreateDirectory(path: string, directorySecurity: System.Security.AccessControl.DirectorySecurity) : DirectoryInfo
-
val ignore : value:'T -> unit

Full name: Microsoft.FSharp.Core.Operators.ignore
-
val fileInfo : FileInfo
-
Multiple items
type DirectoryInfo =
  inherit FileSystemInfo
  new : path:string -> DirectoryInfo
  member Create : unit -> unit + 1 overload
  member CreateSubdirectory : path:string -> DirectoryInfo + 1 overload
  member Delete : unit -> unit + 1 overload
  member EnumerateDirectories : unit -> IEnumerable<DirectoryInfo> + 2 overloads
  member EnumerateFileSystemInfos : unit -> IEnumerable<FileSystemInfo> + 2 overloads
  member EnumerateFiles : unit -> IEnumerable<FileInfo> + 2 overloads
  member Exists : bool
  member GetAccessControl : unit -> DirectorySecurity + 1 overload
  member GetDirectories : unit -> DirectoryInfo[] + 2 overloads
  ...

Full name: System.IO.DirectoryInfo

--------------------
DirectoryInfo(path: string) : unit
-
FileInfo.CopyTo(destFileName: string) : FileInfo
FileInfo.CopyTo(destFileName: string, overwrite: bool) : FileInfo
-
property FileInfo.Name: string
-
val processScriptAsHtml : unit -> 'a

Full name: Build.processScriptAsHtml


 Processes a single F# Script file and produce HTML output
-
val file : string
-
val output : string
-
val template : string
-
val processScriptAsHtml : unit -> 'a

Full name: Build.processScriptAsHtml


 Processes a single F# Script file and produce LaTeX output
-
val processDocument : templateFile:'a -> outputKind:'b -> 'c

Full name: Build.processDocument


 Processes a single Markdown document and produce HTML output
-
val templateFile : 'a
-
val outputKind : 'b
-
val processDocument : templateFile:'a -> outputKind:'b -> 'c

Full name: Build.processDocument


 Processes a single Markdown document and produce LaTeX output
-
val processDirectory : unit -> 'a

Full name: Build.processDirectory


 Processes an entire directory containing multiple script files
 (*.fsx) and Markdown documents (*.md) and it specifies additional
 replacements for the template file
-
val projInfo : (string * string) list
- -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/literate/demo.html b/packages/FAKE.4.11.3/docs/literate/demo.html deleted file mode 100644 index 4023b31..0000000 --- a/packages/FAKE.4.11.3/docs/literate/demo.html +++ /dev/null @@ -1,211 +0,0 @@ - - - - - - Literate sample - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

Literate sample

- -

This file demonstrates how to write literate F# script -files (*.fsx) that can be transformed into nice HTML -using the literate.fsx script from the F# Formatting -package.

- -

As you can see, a comment starting with double asterisk -is treated as part of the document and is transformed -using Markdown, which means that you can use:

- -
    -
  • Unordered or ordered lists
  • -
  • Text formatting including bold and emphasis
  • -
- -

And numerous other Markdown features.

- -

Writing F# code

- -

Code that is not inside comment will be formatted as -a sample snippet (which also means that you can -run it in Visual Studio or MonoDevelop).

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-
/// The Hello World of functional languages!
-let rec factorial x = 
-  if x = 0 then 1 
-  else x * (factorial (x - 1))
-
-let f10 = factorial 10
-
- -

Hiding code

- -

If you want to include some code in the source code, -but omit it from the output, you can use the hide -command.

- -

The value will be deffined in the F# code and so you -can use it from other (visible) code and get correct -tool tips:

- - - - -
1: 
-
let answer = hidden
-
- -

Moving code around

- -

Sometimes, it is useful to first explain some code that -has to be located at the end of the snippet (perhaps -because it uses some definitions discussed in the middle). -This can be done using include and define commands.

- -

The following snippet gets correct tool tips, even though -it uses laterFunction:

- - - - -
1: 
-2: 
-3: 
-
let sample = 
-  laterFunction()
-  |> printfn "Got: %s"
-
- -

Then we can explain how laterFunction is defined:

- - - - -
1: 
-2: 
-
let laterFunction() = 
-  "Not very difficult, is it?"
-
- -

This example covers pretty much all features that are -currently implemented in literate.fsx, but feel free -to fork the project on GitHub and add more -features or report bugs!

- -

Other features

- -

The tool-tips also work for double-backtick identifiers. -This might be useful to generate nice documents from tests:

- - - - -
1: 
-2: 
-
let ``1 + 1 should be equal to 2``() =
-  1 + 1 = 2
-
- -

Others examples follow here.

- -
val factorial : x:int -> int

Full name: Demo.factorial


 The Hello World of functional languages!
-
val x : int
-
val f10 : int

Full name: Demo.f10
-
val hidden : int

Full name: Demo.hidden


 This is a hidden answer
-
val answer : int

Full name: Demo.answer
-
val laterFunction : unit -> string

Full name: Demo.laterFunction
-
val sample : unit

Full name: Demo.sample
-
val printfn : format:Printf.TextWriterFormat<'T> -> 'T

Full name: Microsoft.FSharp.Core.ExtraTopLevelOperators.printfn
-
val ( 1 + 1 should be equal to 2 ) : unit -> bool

Full name: Demo.( 1 + 1 should be equal to 2 )
- -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/nuget.html b/packages/FAKE.4.11.3/docs/nuget.html deleted file mode 100644 index b24943a..0000000 --- a/packages/FAKE.4.11.3/docs/nuget.html +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - NuGet package restore - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

NuGet package restore

- -

If you are using a source control system like git you probably don't want to store all binary dependencies in it. -With FAKE we can use NuGet to download all dependent packages during the build.

- -

Setting the stage for NuGet

- -

In order to download the packages during the build we need to add NuGet.exe to our repository. -You can download the "NuGet.exe Command Line Tool" from the release page.

- -

Restore packages from the build script

- -

Modify your build script and add RestorePackages() near the beginning of the script. -This will use the following default parameters to retrieve all NuGet packages which are specified in "./**/packages.config" files.

- -

If you need to use different parameters please use the RestorePackage task directly.

- -

Download latest version of FAKE via NuGet

- -

If you don't want to store FAKE.exe and it components in your repository you can use a batch file which downloads it before the build:

- - -
1: 
-2: 
-3: 
-4: 
-5: 
-
@echo off
-cls
-"tools\nuget\nuget.exe" "install" "FAKE" "-OutputDirectory" "tools" "-ExcludeVersion"
-"tools\FAKE\tools\Fake.exe" build.fsx
-pause
- - -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/octopusdeploy.html b/packages/FAKE.4.11.3/docs/octopusdeploy.html deleted file mode 100644 index 9c32744..0000000 --- a/packages/FAKE.4.11.3/docs/octopusdeploy.html +++ /dev/null @@ -1,238 +0,0 @@ - - - - - - Automating Deployment using FAKE and Octopus Deploy - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

Automating Deployment using FAKE and Octopus Deploy

- -

Octopus Deploy is a great tool for simple and user-friendly release management.

- -

Installing Octopus Deploy

- -

You can download the free community edition of Octopus Deploy from http://octopusdeploy.com/downloads - and then follow the Installation Instructions to get yourself up and running.

- -

You will also need to install and configure at least one Tentacle which you will deploy your software and services to.

- -

Octopus Deploy HTTP API and Octopus Tools

- -

Octopus Deploy has a REST-style HTTP API available at http://your-octopus-server/api which we will be using via the Octopus Tools, controlled from a FAKE script.

- -

You should add the OctopusTools NuGet package to your solution, which you can also resolve from a FAKE script - which you will need in order to use the OctoTools from a FAKE script.

- -

Generate an API Key

- -

In order to communicate with the Octopus Deploy API you will need an API key to authenticate with.

- -

It is a good idea to create an account in Octopus Deploy for your Continuous Integration systems (eg: TeamCity) - and then generate a new API key for that account, that can be safely used from within your build process.

- -

My Profile

- -

Generate API Key

- -

Create a Release

- -

Octopus Deploy relies on the concept of a release, which should be an immutable NuGet Package which has been built, tested, packaged and published from your Continuous Integration systems - which you can of course completely manage with your FAKE script.

- -

So once you have created a project you are able to create and push a release into Octopus Deploy. This can be done through the Octopus UI, command line tool, or in our case - from a FAKE script.

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-
open Fake.OctoTools
-
-Target "Release" (fun _ ->
-    let release = { releaseOptions with Project = "Order Processor" }
-    let server = { Server = "http://your-octopus-server/api"; ApiKey   = "YOUR-CI-API-KEY-HERE" }
-
-    Octo (fun octoParams ->
-        { octoParams with
-            ToolPath = "./packages/octopustools/tools"
-            Server   = server
-            Command  = CreateRelease (release, None) }
-    )
-)
-
- -

In this instance both the releaseOptions and octoParams contain assumed default values that will fail by default. CreateRelease allows you to also deploy the release at the same time, but since we're not interested in doing this at this moment - we'll set our deployOptions to None.

- -

Deploy a Release

- -

You can automatically deploy a release when you create it, but using the optional deploy options when you create your release.

- -

This is often a good idea when you want your FAKE build script to continue on to a second set of perhaps slower, unit tests that exercise behaviours in a more complete and perhaps integrated environment.

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-
open Fake.OctoTools
-
-Target "ReleaseAndDeploy" (fun _ ->
-    let release = { releaseOptions with Project = "Order Processor" }
-    let deploy  = { deployOptions with DeployTo = "TestEnvironment" }
-    let server = { Server = "http://your-octopus-server/api"; ApiKey   = "YOUR-CI-API-KEY-HERE" }
-
-    Octo (fun octoParams ->
-        { octoParams with
-            ToolPath = "./packages/octopustools/tools"
-            Server   = server
-            Command  = CreateRelease (release, Some deploy) }
-    )
-)
-
- -

In this instance we've used the default deployOptions and modified the environment that we're going to deploy to - this is then passed into the CreateRelease.

- -

Promote a Release

- -

Finally when you are absolutely happy that your release is good to go the next stage (be that some manual or exploratory testing, or perhaps a staging environment). We can use a DeployRelease command to promote an existing release to the next environment:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-
open Fake.OctoTools
-
-Target "PromoteRelease" (fun _ ->
-    let promote = { deployOptions with 
-                      Project = "Order Processor"
-                      DeployTo = "UatEnvironment" }
-    let server = { Server = "http://your-octopus-server/api"; ApiKey   = "YOUR-CI-API-KEY-HERE" }
-
-    Octo (fun octoParams ->
-        { octoParams with
-            ToolPath = "./packages/octopustools/tools"
-            Server   = server
-            Command  = DeployRelease (promote) }
-    )
-)
-
- -
union case Option.None: Option<'T>
-
union case Option.Some: Value: 'T -> Option<'T>
- -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/parallel-build.html b/packages/FAKE.4.11.3/docs/parallel-build.html deleted file mode 100644 index f6454d6..0000000 --- a/packages/FAKE.4.11.3/docs/parallel-build.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - Using FAKE's parallel option - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

Using FAKE's parallel option

- -

Since multithreading is beneficial (especially for large projects) FAKE allows to specify the -number of threads used for traversing the dependency tree. -This option of course only affects independent targets whereas dependent targets will -still be exectued in order.

- -

Setting the number of threads

- -

The number of threads used can be set using the environment variable parallel-jobs. -This can be achieved in various ways where the easiest one is to use FAKE's built-in support for -setting environment variables:

- -

FAKE.exe *YourBuildScript* "parallel-jobs=8"

- -

Note that the dependency tree will be traversed as usual whenever setting parallel-jobs to a value <= 1 or omiting it entirely.

- -

Issues

- -
    -
  • Running targets in parallel is of course only possible when the target-functions themselves are thread-safe.
  • -
  • Parallel execution may also cause races on stdout and build-logs may therefore be quite obfuscated.
  • -
  • Error detection may suffer since it's not possible to determine a first error when targets are running in parallel
  • -
- -

Due to these limitations it is recommended to use the standard sequential build whenever checking for errors (CI, etc.) -However when a fast build is desired (and the project is e.g. known to build successfully) the parallel option might be helpful

- -

Example

- -

When using this parallel option, Fake resolves the build dependency hierearchies from the described paths and builds independend paths as parallel if you have multiple CPUs available. -For example this dependency tree:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-
"Task 1"
- ==> "Task A2"
- ==> "Task 3"
-
-"Task 1"
- ==> "Task B2"
- ==> "Task 3"
-
-"Task C2"
- ==> "Task 3"
-
-"Task 3"
- ==> "Task A4"
-
-"Task 3"
- ==> "Task B4"
-
- -

...would be treated as follows:

- -

- -

This is in addition to that that MsBuild may use multiple threads when building one solution having multiple independent project-files.

- - -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/pics/assemblyinfo/assemblymetadata.png b/packages/FAKE.4.11.3/docs/pics/assemblyinfo/assemblymetadata.png deleted file mode 100644 index 9a87b0c..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/assemblyinfo/assemblymetadata.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/assemblyinfo/generated.png b/packages/FAKE.4.11.3/docs/pics/assemblyinfo/generated.png deleted file mode 100644 index 004eeb7..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/assemblyinfo/generated.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/assemblyinfo/result.png b/packages/FAKE.4.11.3/docs/pics/assemblyinfo/result.png deleted file mode 100644 index 0734bab..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/assemblyinfo/result.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/assemblyinfo/solutioninfo.png b/packages/FAKE.4.11.3/docs/pics/assemblyinfo/solutioninfo.png deleted file mode 100644 index bd085db..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/assemblyinfo/solutioninfo.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/canopy/logo.jpg b/packages/FAKE.4.11.3/docs/pics/canopy/logo.jpg deleted file mode 100644 index 33195d1..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/canopy/logo.jpg and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/commandline/cmd.png b/packages/FAKE.4.11.3/docs/pics/commandline/cmd.png deleted file mode 100644 index 69448c2..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/commandline/cmd.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/fxcop/failonerror.png b/packages/FAKE.4.11.3/docs/pics/fxcop/failonerror.png deleted file mode 100644 index 5a2d883..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/fxcop/failonerror.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/fxcop/report.png b/packages/FAKE.4.11.3/docs/pics/fxcop/report.png deleted file mode 100644 index 24532fa..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/fxcop/report.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/gettingstarted/afterclean.png b/packages/FAKE.4.11.3/docs/pics/gettingstarted/afterclean.png deleted file mode 100644 index 055bd8f..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/gettingstarted/afterclean.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/gettingstarted/aftercompile.png b/packages/FAKE.4.11.3/docs/pics/gettingstarted/aftercompile.png deleted file mode 100644 index bce782b..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/gettingstarted/aftercompile.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/gettingstarted/afterdownload.png b/packages/FAKE.4.11.3/docs/pics/gettingstarted/afterdownload.png deleted file mode 100644 index 01536d9..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/gettingstarted/afterdownload.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/gettingstarted/afterdownloadpaket.png b/packages/FAKE.4.11.3/docs/pics/gettingstarted/afterdownloadpaket.png deleted file mode 100644 index b79327c..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/gettingstarted/afterdownloadpaket.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/gettingstarted/alltestsgreen.png b/packages/FAKE.4.11.3/docs/pics/gettingstarted/alltestsgreen.png deleted file mode 100644 index 4993810..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/gettingstarted/alltestsgreen.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/gettingstarted/compileerror.png b/packages/FAKE.4.11.3/docs/pics/gettingstarted/compileerror.png deleted file mode 100644 index 1c85b7a..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/gettingstarted/compileerror.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/logo.pdn b/packages/FAKE.4.11.3/docs/pics/logo.pdn deleted file mode 100644 index 749a838..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/logo.pdn and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/logo.png b/packages/FAKE.4.11.3/docs/pics/logo.png deleted file mode 100644 index 330fbfb..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/logo.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/octopusdeploy/apikey.png b/packages/FAKE.4.11.3/docs/pics/octopusdeploy/apikey.png deleted file mode 100644 index 6dd0d70..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/octopusdeploy/apikey.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/octopusdeploy/myprofile.png b/packages/FAKE.4.11.3/docs/pics/octopusdeploy/myprofile.png deleted file mode 100644 index 0439e82..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/octopusdeploy/myprofile.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/parallel/ParallelExample.png b/packages/FAKE.4.11.3/docs/pics/parallel/ParallelExample.png deleted file mode 100644 index 3065f66..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/parallel/ParallelExample.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/teamcity/auth.png b/packages/FAKE.4.11.3/docs/pics/teamcity/auth.png deleted file mode 100644 index 3af4931..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/teamcity/auth.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/teamcity/buildstep1.png b/packages/FAKE.4.11.3/docs/pics/teamcity/buildstep1.png deleted file mode 100644 index 63c37e2..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/teamcity/buildstep1.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/teamcity/buildstep2.png b/packages/FAKE.4.11.3/docs/pics/teamcity/buildstep2.png deleted file mode 100644 index a00fb90..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/teamcity/buildstep2.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/teamcity/checkoutrules.png b/packages/FAKE.4.11.3/docs/pics/teamcity/checkoutrules.png deleted file mode 100644 index ea1ca09..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/teamcity/checkoutrules.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/teamcity/createproject.png b/packages/FAKE.4.11.3/docs/pics/teamcity/createproject.png deleted file mode 100644 index b4cf64e..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/teamcity/createproject.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/teamcity/generalsettings.png b/packages/FAKE.4.11.3/docs/pics/teamcity/generalsettings.png deleted file mode 100644 index b62b4bd..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/teamcity/generalsettings.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/teamcity/nunit.png b/packages/FAKE.4.11.3/docs/pics/teamcity/nunit.png deleted file mode 100644 index 0f17233..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/teamcity/nunit.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/teamcity/output.png b/packages/FAKE.4.11.3/docs/pics/teamcity/output.png deleted file mode 100644 index 6983c80..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/teamcity/output.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/teamcity/trigger.png b/packages/FAKE.4.11.3/docs/pics/teamcity/trigger.png deleted file mode 100644 index d32d5f8..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/teamcity/trigger.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/pics/teamcity/vcsroot.png b/packages/FAKE.4.11.3/docs/pics/teamcity/vcsroot.png deleted file mode 100644 index 1a6402a..0000000 Binary files a/packages/FAKE.4.11.3/docs/pics/teamcity/vcsroot.png and /dev/null differ diff --git a/packages/FAKE.4.11.3/docs/soft-dependencies.html b/packages/FAKE.4.11.3/docs/soft-dependencies.html deleted file mode 100644 index 7f6fe58..0000000 --- a/packages/FAKE.4.11.3/docs/soft-dependencies.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Soft dependencies - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

Soft dependencies

- -

Typically you will define dependencies among your targets using the ==> and <== operators, and these -dependencies define the order in which the targets are executed during a build.

- -

You can also define soft dependencies among targets using the ?=> and <=? operators. For example, you might -say that target B has a soft dependency on target A:

- - - - -
1: 
-2: 
-3: 
-
"A" ?=> "B"
-// Or equivalently
-"B" <=? "A"
-
- -

With this soft dependency, running B will not require that A be run first. However it does mean that if A is run -(due to other dependencies) it must be run before B.

- -

Example

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-
// *** Define Targets ***
-Target "Clean" (fun () -> 
-    trace " --- Cleaning stuff --- "
-)
-
-Target "Build" (fun () -> 
-    trace " --- Building the app --- "
-)
-
-Target "Rebuild" DoNothing
-
-// *** Define Dependencies ***
-"Build" ==> "Rebuild"
-"Clean" ==> "Rebuild"
-// Make sure "Clean" happens before "Build", if "Clean" is executed during a build.
-"Clean" ?=> "Build"
-
- - -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/specifictargets.html b/packages/FAKE.4.11.3/docs/specifictargets.html deleted file mode 100644 index 63f96bc..0000000 --- a/packages/FAKE.4.11.3/docs/specifictargets.html +++ /dev/null @@ -1,217 +0,0 @@ - - - - - - Running targets in "FAKE - F# Make" - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

Running targets in "FAKE - F# Make"

- -

Listing targets

- -

Before running any specific target it is useful to know all the targets that are available in a build script. -FAKE can list all the avaiable targets including the dependencies by running the following command:

- -
    -
  • Fake.exe YourBuildScript -lt
  • -
- -

The option -lt stands for "list targets". It is an abbreviation of the option --listTargets.

- -

Running specific targets

- -

FAKE has a special param "target" which can be used to run specific targets in a build. We assume the following build script:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-21: 
-22: 
-23: 
-24: 
-25: 
-
// include Fake libs
-#I @"tools\FAKE"
-#r "FakeLib.dll"
-open Fake 
-
-// *** Define Targets ***
-Target "Clean" (fun () -> 
-    trace " --- Cleaning stuff --- "
-)
-
-Target "Build" (fun () -> 
-    trace " --- Building the app --- "
-)
-
-Target "Deploy" (fun () -> 
-    trace " --- Deploying app --- "
-)
-
-// *** Define Dependencies ***
-"Clean"
-  ==> "Build"
-  ==> "Deploy"
-
-// *** Start Build ***
-RunTargetOrDefault "Deploy"
-
- -

Now we have the following options:

- -
    -
  • Fake.exe "target=Build" --> starts the Build target and runs the dependency Clean
  • -
  • Fake.exe Build --> starts the Build target and runs the dependency Clean
  • -
  • Fake.exe Build --single-target --> starts only the Build target and runs no dependencies
  • -
  • Fake.exe Build -st --> starts only the Build target and runs no dependencies
  • -
  • Fake.exe --> starts the Deploy target (and runs the dependencies Clean and Build)
  • -
- -

Final targets

- -

Final targets can be used for TearDown functionality. -These targets will be executed even if the build fails but have to be activated via ActivateFinalTarget().

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-
FinalTarget "CloseSomePrograms" (fun _ ->
-    // close stuff and release resources
-)
-
-// Activate FinalTarget somewhere during build
-ActivateFinalTarget "CloseSomePrograms"
-
- -

Build failure targets

- -

Build failure targets can be used to execute tasks after a build failure. -These targets will be executed only after a build failure but have to be activated via ActivateBuildFailureTarget().

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-
BuildFailureTarget "ReportErrorViaMail" (fun _ ->
-    // send mail about the failure
-)
-
-// Activate BuildFailureTarget somewhere during build
-ActivateBuildFailureTarget "ReportErrorViaMail"
-
- - -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/teamcity.html b/packages/FAKE.4.11.3/docs/teamcity.html deleted file mode 100644 index cff3bcd..0000000 --- a/packages/FAKE.4.11.3/docs/teamcity.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - Integrating a FAKE build script into TeamCity - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

Integrating a FAKE build script into TeamCity

- -

Easy TeamCity integration was one of the major goals for the FAKE build system.

- -

In this article you will learn how to set up a FAKE build script in TeamCity. We will use the CalculatorSample which you can build from the getting started guide.

- -

Installing TeamCity

- -

You can download the free professional edition of TeamCity from http://www.jetbrains.com/teamcity/. After the installation process you should be ready to configure your first build.

- -

Creating a FAKE project on TeamCity

- -

Now create a new project and add a build configuration:

- -

alt text

- -

You also need to set the artifacts paths:

- -

alt text

- -

Attach a VCS root

- -

The next step is to attach a VCS root. For this sample we will use the official FAKE repository at https://github.com/forki/FAKE/.

- -

alt text -alt text -alt text

- -

Creating the build step

- -

Now is the time to create two build steps. The first one downloads FAKE via Nuget and the second one runs the build script:

- -

alt text -alt text

- -

If you want you could also add a build trigger to your build script:

- -

alt text

- -

Running the build

- -

Now if everything is configured correctly, you can run your build and the output should look like:

- -

alt text

- -

You can also inspect the NUnit results:

- -

alt text

- - -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/typescript.html b/packages/FAKE.4.11.3/docs/typescript.html deleted file mode 100644 index 8a08889..0000000 --- a/packages/FAKE.4.11.3/docs/typescript.html +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - Compiling TypeScript applications - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

Compiling TypeScript applications

- -

FAKE can be used to build a variety of different application types. -In this tutorial we are looking at the TypeScript support.

- -

Consider a greetings.ts file:

- - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-
interface Person {
-    firstname: string;
-    lastname: string;
-}
-
-function greeter(person : Person) {
-    return "Hello, " + person.firstname + " " + person.lastname;
-}
-
-var user = {firstname: "Jane", lastname: "User"};
-
-document.body.innerHTML = greeter(user);
-
- -

Now create a build.fsx and run it via FAKE.exe:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-
#I @"../../tools/FAKE/tools/"
-#r @"FakeLib.dll"
-
-open Fake
-open System
-open TypeScript
-
-Target "CompileTypeScript" (fun _ ->
-    !! "**/*.ts"
-      |> TypeScriptCompiler (fun p -> { p with OutputPath = "./out" }) 
-)
-
-RunTargetOrDefault "CompileTypeScript"
-
- -

This small script will run all *.ts files through the TypeScript compiler and put them into the ./out/ folder. In this case we will find a greetings.js:

- - -
1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-
function greeter(person) {
-    return "Hello, " + person.firstname + " " + person.lastname;
-}
-
-var user = { firstname: "Jane", lastname: "User" };
-
-document.body.innerHTML = greeter(user);
-
- -

If you need more details please see the API docs for the TypeScript task.

- -
namespace System
- -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/users.html b/packages/FAKE.4.11.3/docs/users.html deleted file mode 100644 index 5815877..0000000 --- a/packages/FAKE.4.11.3/docs/users.html +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - Who is using FAKE? - - - - - - - - - - - - - - - - - Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/vagrant.html b/packages/FAKE.4.11.3/docs/vagrant.html deleted file mode 100644 index ac4be46..0000000 --- a/packages/FAKE.4.11.3/docs/vagrant.html +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - How to use Vagrant and quickly setup a reproducible development environment for FAKE - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

How to use Vagrant and quickly setup a reproducible development environment for FAKE

- -

Since #711, it is possible to deploy an fresh Ubuntu -Linux virtual machine with one simple command thanks to Vagrant. Here -is how to proceed...

- -

Install the system-wide prerequisites

- -

VirtualBox and its Extension Pack

- -
-

VirtualBox is a powerful x86 and AMD64/Intel64 virtualization product for enterprise as well as -home use. Not only is VirtualBox an extremely feature rich, high performance product for -enterprise customers, it is also the only professional solution that is freely available as Open -Source Software under the terms of the GNU General Public License (GPL) version 2.

-
- -

You can install VirtualBox and the VirtualBox Extension Pack from www.virtualbox.org/wiki/Downloads -or with your package manager.

- -

Vagrant

- -
-

Vagrant is a tool for building complete development environments. With an easy-to-use workflow -and focus on automation, Vagrant lowers development environment setup time, increases -development/production parity, and makes the "works on my machine" excuse a relic of the past.

-
- -

You can install Vagrant from www.vagrantup.com/downloads.html -or with your package manager.

- -

Start a new VM

- -

Simply cd to the root directory of the FAKE source code and run vagrant up.

- -

The VM will be automatically downloaded, imported into VirtualBox, configured and started. The FAKE -source directory is automatically shared with the VM under the /vagrant directory.

- -

Run vagrant ssh to directly connect via SSH to the VM and start working.

- -

Alternately, you can directly execute any command with vagrant ssh -c "<command>". -As example, you can directly invoke the build.sh script with the -vagrant ssh -c "cd /vagrant && bash ./build.sh" command.

- -

Once you have finished, you can either:

- -
    -
  • Run vagrant suspend to pause the VM.
  • -
  • Run vagrant halt to shutdown the VM.
  • -
  • Run vagrant destroy to delete the imported VM.
  • -
  • Run vagrant box remove ubuntu/trusty64 to remove the base box from your computer.
  • -
  • Re-run vagrant up to reload the VM.
  • -
- -

The full command line documentation is available at docs.vagrantup.com.

- -

Further information

- - - - -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/watch.html b/packages/FAKE.4.11.3/docs/watch.html deleted file mode 100644 index 8f2f9e8..0000000 --- a/packages/FAKE.4.11.3/docs/watch.html +++ /dev/null @@ -1,223 +0,0 @@ - - - - - - Watching for file changes with "FAKE - F# Make" - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

Watching for file changes with "FAKE - F# Make"

- -

FAKE makes it easy to setup monitoring for filesystem changes. Using the standard glob patterns you can -watch for changes, and automatically run a function or another target.

- -

Using WatchChanges

- -

Add a new target named "Watch" to your build:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-
Target "GenerateDocs" (fun _ ->
-    tracefn "Generating docs."
-)
-
-Target "Watch" (fun _ ->
-    use watcher = !! "docs/**/*.*" |> WatchChanges (fun changes -> 
-        tracefn "%A" changes
-        Run "GenerateDocs"
-    )
-
-    System.Console.ReadLine() |> ignore //Needed to keep FAKE from exiting
-
-    watcher.Dispose() // Use to stop the watch from elsewhere, ie another task.
-)
-
- -

Now run build.fsx and make some changes to the docs directory. They should be printed out to the console as they happen, -and the GenerateDocs target should be rerun.

- -

If you need to watch only a subset of the files, say you want to rerun tests as soon as the compiled DLLs change:

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-
Target "RunTests" (fun _ ->
-    tracefn "Running tests."
-)
-
-Target "Watch" (fun _ ->
-    use watcher = !! "tests/**/bin/debug/*.dll" |> WatchChanges (fun changes -> 
-        tracefn "%A" changes
-        Run "RunTests"
-    )
-
-    System.Console.ReadLine() |> ignore //Needed to keep FAKE from exiting
-
-    watcher.Dispose() // Use to stop the watch from elsewhere, ie another task.
-)
-
- -

Running on Linux or Mac OSX

- -

WatchChanges requires additional care when running on Linux or Mac OSX. The following sections describe potential issues you may encounter.

- -

Maximum Number of Files to Watch Exception

- -

When running on Linux or Mac OSX, you should add the following export to your .bashrc or .bash_profile:

- - - - -
1: 
-
export MONO_MANAGED_WATCHER=false
-
- -

If you don't add this, you may see the following exception when attempting to run the WatchChanges task:

- - - - -
1: 
-2: 
-3: 
-4: 
-5: 
-6: 
-7: 
-
Running build failed.
-Error:
-System.IO.IOException: kqueue() FileSystemWatcher has reached the maximum nunmber of files to watch.
-  at System.IO.KqueueMonitor.Add (System.String path, Boolean postEvents, System.Collections.Generic.List`1& fds) [0x00000] in <filename unknown>0
-  at System.IO.KqueueMonitor.Scan (System.String path, Boolean postEvents, System.Collections.Generic.List`1& fds) [0x00000] in <filename unknown>0
-  at System.IO.KqueueMonitor.Setup () [0x00000] in <filename unknown>0
-  at System.IO.KqueueMonitor.DoMonitor () [0x00000] in <filename unknown>0
-
- -

Watching Changes from Windows over Parallels

- -

The Windows file watcher does not appear to be able to correctly identify changes that occur within a folder shared by Parallels between Mac OSX and Windows. If you want to run WatchChanges, you will need to run your FAKE script from Mac OSX.

- -

At this time, only Parallels is known to have this problem, but you should assume that any other virtualization solutions will have the same problem. If you confirm a similar problem with other Linux distros or VM platforms, please update this document accordingly.

- -
namespace System
-
type Console =
  static member BackgroundColor : ConsoleColor with get, set
  static member Beep : unit -> unit + 1 overload
  static member BufferHeight : int with get, set
  static member BufferWidth : int with get, set
  static member CapsLock : bool
  static member Clear : unit -> unit
  static member CursorLeft : int with get, set
  static member CursorSize : int with get, set
  static member CursorTop : int with get, set
  static member CursorVisible : bool with get, set
  ...

Full name: System.Console
-
System.Console.ReadLine() : string
-
val ignore : value:'T -> unit

Full name: Microsoft.FSharp.Core.Operators.ignore
-
namespace System.IO
-
Multiple items
type IOException =
  inherit SystemException
  new : unit -> IOException + 3 overloads

Full name: System.IO.IOException

--------------------
System.IO.IOException() : unit
System.IO.IOException(message: string) : unit
System.IO.IOException(message: string, hresult: int) : unit
System.IO.IOException(message: string, innerException: exn) : unit
-
Multiple items
type String =
  new : value:char -> string + 7 overloads
  member Chars : int -> char
  member Clone : unit -> obj
  member CompareTo : value:obj -> int + 1 overload
  member Contains : value:string -> bool
  member CopyTo : sourceIndex:int * destination:char[] * destinationIndex:int * count:int -> unit
  member EndsWith : value:string -> bool + 2 overloads
  member Equals : obj:obj -> bool + 2 overloads
  member GetEnumerator : unit -> CharEnumerator
  member GetHashCode : unit -> int
  ...

Full name: System.String

--------------------
System.String(value: nativeptr<char>) : unit
System.String(value: nativeptr<sbyte>) : unit
System.String(value: char []) : unit
System.String(c: char, count: int) : unit
System.String(value: nativeptr<char>, startIndex: int, length: int) : unit
System.String(value: nativeptr<sbyte>, startIndex: int, length: int) : unit
System.String(value: char [], startIndex: int, length: int) : unit
System.String(value: nativeptr<sbyte>, startIndex: int, length: int, enc: System.Text.Encoding) : unit
-
namespace System.Collections
-
namespace System.Collections.Generic
-
Multiple items
type List<'T> =
  new : unit -> List<'T> + 2 overloads
  member Add : item:'T -> unit
  member AddRange : collection:IEnumerable<'T> -> unit
  member AsReadOnly : unit -> ReadOnlyCollection<'T>
  member BinarySearch : item:'T -> int + 2 overloads
  member Capacity : int with get, set
  member Clear : unit -> unit
  member Contains : item:'T -> bool
  member ConvertAll<'TOutput> : converter:Converter<'T, 'TOutput> -> List<'TOutput>
  member CopyTo : array:'T[] -> unit + 2 overloads
  ...
  nested type Enumerator

Full name: System.Collections.Generic.List<_>

--------------------
System.Collections.Generic.List() : unit
System.Collections.Generic.List(capacity: int) : unit
System.Collections.Generic.List(collection: System.Collections.Generic.IEnumerable<'T>) : unit
- -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/docs/wix.html b/packages/FAKE.4.11.3/docs/wix.html deleted file mode 100644 index 65b1f32..0000000 --- a/packages/FAKE.4.11.3/docs/wix.html +++ /dev/null @@ -1,301 +0,0 @@ - - - - - - Create WiX Setup - - - - - - - - - - - - - - - -
-
- -

FAKE - F# Make

-
-
-
-
-

Create WiX Setup

- -

If you often ship software to customers, it might be comfortable for you to install it using setups rather than manually deploying. -FAKE provides you with support for creating MSI setups using the WiX Toolset (http://wixtoolset.org/).

- -

Minimal working example

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-19: 
-20: 
-21: 
-22: 
-23: 
-24: 
-25: 
-26: 
-27: 
-28: 
-29: 
-30: 
-31: 
-32: 
-33: 
-34: 
-35: 
-36: 
-37: 
-38: 
-39: 
-40: 
-41: 
-42: 
-43: 
-44: 
-45: 
-46: 
-47: 
-48: 
-49: 
-50: 
-51: 
-52: 
-53: 
-54: 
-55: 
-56: 
-57: 
-58: 
-59: 
-60: 
-61: 
-62: 
-63: 
-64: 
-65: 
-66: 
-67: 
-68: 
-69: 
-
Target "BuildWiXSetup" (fun _ ->
-    // This defines, which files should be collected when running bulkComponentCreation
-    let fileFilter = fun (file : FileInfo) -> 
-        if file.Extension = ".dll" || file.Extension = ".exe" || file.Extension = ".config" then 
-            true 
-        else 
-            false
-
-    // Collect Files which should be shipped. Pass directory with your deployment output for deployDir
-    let components = bulkComponentCreation fileFilter (DirectoryInfo deployDir)
-
-    // Collect component references for usage in features
-    let componentRefs = components |> Seq.map(fun comp -> comp.ToComponentRef())
-
-    let completeFeature = generateFeatureElement (fun f -> 
-                                                    {f with  
-                                                        Id = "Complete"
-                                                        Title = "Complete Feature"
-                                                        Level = 1 
-                                                        Description = "Installs all features"
-                                                        Components = componentRefs
-                                                        Display = Expand 
-                                                    })
-
-    // Generates a predefined WiX template with placeholders which will be replaced in "FillInWiXScript"
-    generateWiXScript "SetupTemplate.wxs"
-
-    let WiXUIMondo = generateUIRef (fun f ->
-                                        {f with
-                                            Id = "WixUI_Mondo"
-                                        })
-
-    let WiXUIError = generateUIRef (fun f ->
-                                        {f with
-                                            Id = "WixUI_ErrorProgressText"
-                                        })
-
-    let MajorUpgrade = generateMajorUpgradeVersion(
-                            fun f ->
-                                {f with 
-                                    Schedule = MajorUpgradeSchedule.AfterInstallExecute
-                                    DowngradeErrorMessage = "A later version is already installed, exiting."
-                                })
-
-    FillInWiXTemplate "" (fun f ->
-                            {f with
-                                // Guid which should be generated on every build
-                                ProductCode = Guid.NewGuid()
-                                ProductName = "Test Setup"
-                                Description = "Description of Test Setup"
-                                ProductLanguage = 1033
-                                ProductVersion = "1.0.0"
-                                ProductPublisher = "YouOrYourCompany"
-                                // Set fixed upgrade guid, this should never change for this project!
-                                UpgradeGuid = WixProductUpgradeGuid
-                                MajorUpgrade = [MajorUpgrade]
-                                UIRefs = [WiXUIMondo; WiXUIError]
-                                ProgramFilesFolder = ProgramFiles32
-                                Components = components
-                                BuildNumber = "Build number"
-                                Features = [completeFeature]
-                            })
-
-
-    // run the WiX tools
-    WiX (fun p -> {p with ToolDirectory = WiXPath}) 
-        setupFileName
-        @".\SetupTemplate.wxs"
-)
-
- -

Further possibilities

- -

Besides just plainly shipping those files as setup you can also use the custom action and custom action execution elements to execute various commands before or after certain events during the installation. -This gives you the possibility to for example install, uninstall, start or stop certain services when you need to. -If your software is for example running as a service at your customer's side, you would need to manually stop and start the services on upgrades. -WiX knows the "ServiceControl" element for starting, stopping and removing services. You attach it to components. -If a component's files change and it has a Service Control element, the service that is referred to will be started, stopped or uninstalled, just as you defined it. -You can use the attachServiceToControlComponents function for attaching service controls to components. You would only have to slightly change the above example:

- -

Example

- - - - -
 1: 
- 2: 
- 3: 
- 4: 
- 5: 
- 6: 
- 7: 
- 8: 
- 9: 
-10: 
-11: 
-12: 
-13: 
-14: 
-15: 
-16: 
-17: 
-18: 
-
let serviceControl = generateServiceControl(fun f -> {f with 
-                                                        Id = "PickAnId"
-                                                        Name = "QualifiedNameOfYourService"
-                                                        Start = InstallUninstall.Install
-                                                        Stop = InstallUninstall.Both
-                                                        Remove = InstallUninstall.Uninstall})
-
-// This defines, that all executable files should be tagged with the service control element
-let componentSelector = fun (comp : WiXComponent) -> comp.Files |> Seq.exists(fun file -> file.Name.EndsWith(".exe")) 
-
-let components = attachServiceControlToComponents
-                    (bulkComponentCreation (fun file -> 
-                        if file.Extension = ".dll" || file.Extension = ".exe" || file.Extension = ".config" then 
-                            true 
-                        else 
-                            false) (DirectoryInfo deployDir))
-                    componentSelector 
-                    [serviceControl]
-
- -
module Seq

from Microsoft.FSharp.Collections
-
val map : mapping:('T -> 'U) -> source:seq<'T> -> seq<'U>

Full name: Microsoft.FSharp.Collections.Seq.map
-
val serviceControl : obj

Full name: wix.serviceControl
-
val componentSelector : comp:'a -> bool

Full name: wix.componentSelector
-
val comp : 'a
-
val exists : predicate:('T -> bool) -> source:seq<'T> -> bool

Full name: Microsoft.FSharp.Collections.Seq.exists
-
val file : obj
-
val components : obj

Full name: wix.components
- -
- -
-
- Fork me on GitHub - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/tools/Argu.dll b/packages/FAKE.4.11.3/tools/Argu.dll deleted file mode 100644 index 201a49a..0000000 Binary files a/packages/FAKE.4.11.3/tools/Argu.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/Argu.xml b/packages/FAKE.4.11.3/tools/Argu.xml deleted file mode 100644 index 7696331..0000000 --- a/packages/FAKE.4.11.3/tools/Argu.xml +++ /dev/null @@ -1,628 +0,0 @@ - - -Argu - - - - Sets alternative command line names. - - - - - Create a new argument parsing scheme using given 'Template type - which must be an F# Discriminated Union. - - Specify a usage text to prefixed at the '--help' output. - - - - Argu static methods - - - - Returns the usage string. - The message to be displayed on top of the usage string. - - - Prints command line syntax. Useful for generating documentation. - - - Prints parameters in command line format. Useful for argument string generation. - - - Prints parameters in command line format. Useful for argument string generation. - - - Prints parameters in App.Config format. - The parameters that fill out the XML document. - Print XML comments over every configuration entry. - - - Parse command line arguments only. - The command line input. Taken from System.Environment if not specified. - The implementation of IExiter used for error handling. ArgumentException is default. - Ignore errors caused by the Mandatory attribute. Defaults to false. - Ignore CLI arguments that do not match the schema. Defaults to false. - Treat '--help' parameters as parse errors. Defaults to true. - - - Parse AppSettings section of XML configuration of given assembly. - assembly to get application configuration from. - The implementation of IExiter used for error handling. ArgumentException is default. - Ignore errors caused by the Mandatory attribute. Defaults to false. - - - Parse AppSettings section of XML configuration only. - If specified, parse AppSettings configuration from given xml configuration file. - The implementation of IExiter used for error handling. ArgumentException is default. - Ignore errors caused by the Mandatory attribute. Defaults to false. - - - Parse both command line args and AppSettings section of XML configuration. - Results are merged with command line args overriding XML config. - The command line input. Taken from System.Environment if not specified. - If specified, parse AppSettings configuration from given configuration file. - The implementation of IExiter used for error handling. ArgumentException is default. - Ignore errors caused by the Mandatory attribute. Defaults to false. - Ignore CLI arguments that do not match the schema. Defaults to false. - Treat '--help' parameters as parse errors. Defaults to false. - - - - The Argu type generates an argument parser given a type argument - that is an F# discriminated union. It can then be used to parse command line arguments - or XML configuration. - - - - - No CLI prefix - - - - - Single Dash prefix - - - - - Double Dash prefix - - - - - CLI prefix enumeration - - - - - Specifies a custom prefix for auto generated CLI names. - - - - - Sets a custom AppSettings key name. - - - - - Sets a custom command line name. - - - - - Use '--param=arg' assignment syntax in CLI. - - - - - Handles argument parser errors by raising an exception - - - - - Argument can only be placed at the beginning of the command line. - - - - - Gathers all parsed results from both AppSettings and command line. - - - - - Hide from command line argument documentation. - - - - - returns a usage string for every union case - - - - - Interface that must be implemented by all Argu template types - - - - - An interface for error handling in the argument parser - - - - - Demands at least one parsed result for this branch; an exception is raised otherwise. - - - - - Disable AppSettings parsing for this branch. - - - - - Disable command line parsing for this branch. - - - - - Parse comma separated values in AppSettings - - - - - Returns true if '--help' parameter has been specified in the command line. - - - - Returns the usage string. - The message to be displayed on top of the usage string. - - - Returns the *last* specified parameter of given type. - Command line parameters have precedence over AppSettings parameters. - Results are passed to a post-processing function that is error handled by the parser. - - The name of the parameter, expressed as quotation of DU constructor. - The post-processing parser. - Optional source restriction: AppSettings or CommandLine. - - - Returns the *last* specified parameter of given type, if it exists. - Command line parameters have precedence over AppSettings parameters. - The name of the parameter, expressed as quotation of DU constructor. - Optional source restriction: AppSettings or CommandLine. - - - Returns the *last* specified parameter of given type, if it exists. - Command line parameters have precedence over AppSettings parameters. - The name of the parameter, expressed as quotation of DU constructor. - Optional source restriction: AppSettings or CommandLine. - - - Raise an error through the argument parser's exiter mechanism. Display usage optionally. - The error to be displayed. - The error code to returned. - Print usage together with error message. - - - Raise an error through the argument parser's exiter mechanism. Display usage optionally. - The error message to be displayed. - The error code to returned. - Print usage together with error message. - - - Query parse results for given argument kind. - Command line parameters have precedence over AppSettings parameters. - Results are passed to a post-processing function that is error handled by the parser. - - The name of the parameter, expressed as quotation of DU constructor. - The post-processing parser. - Optional source restriction: AppSettings or CommandLine. - - - Returns the *last* specified parameter of given type. - Command line parameters have precedence over AppSettings parameters. - Results are passed to a post-processing function that is error handled by the parser. - - The name of the parameter, expressed as quotation of DU constructor. - The post-processing parser. - Optional source restriction: AppSettings or CommandLine. - - - - Iterates through *all* parse results for a given argument kind. - Command line parameters have precedence over AppSettings parameters. - Results are passed to an iterator function that is error handled by the parser. - - The name of the parameter, expressed as quotation of DU constructor. - The iterator body. - Option source restriction: AppSettings or CommandLine. - - - - Iterates through the *last* parse result for a given argument kind. - Command line parameters have precedence over AppSettings parameters. - Results are passed to an iterator function that is error handled by the parser. - - The name of the parameter, expressed as quotation of DU constructor. - The iterator body. - Option source restriction: AppSettings or CommandLine. - - - Query parse results for argument with parameters. - The name of the parameter, expressed as quotation of DU constructor. - Optional source restriction: AppSettings or CommandLine. - - - Query parse results for parameterless argument. - The name of the parameter, expressed as quotation of DU constructor. - Optional source restriction: AppSettings or CommandLine. - - - Returns the *last* specified parameter of given type. - Command line parameters have precedence over AppSettings parameters. - The name of the parameter, expressed as quotation of DU constructor. - Return this of no parameter of specific kind has been specified. - Optional source restriction: AppSettings or CommandLine. - - - Returns the *last* specified parameter of given type. - Command line parameters have precedence over AppSettings parameters. - The name of the parameter, expressed as quotation of DU constructor. - Return this of no parameter of specific kind has been specified. - Optional source restriction: AppSettings or CommandLine. - - - Gets all parse results. - Optional source restriction: AppSettings or CommandLine. - - - Checks if parameter of specific kind has been specified. - The name of the parameter, expressed as quotation of DU constructor. - Optional source restriction: AppSettings or CommandLine. - - - Checks if parameter of specific kind has been specified. - The name of the parameter, expressed as quotation of DU constructor. - Optional source restriction: AppSettings or CommandLine. - - - Handles any raised exception through the argument parser's exiter mechanism. Display usage optionally. - The operation to be executed. - The error code to returned. - Print usage together with error message. - - - - Argument parsing result holder. - - - - - Source from which to parse arguments - - - - - Print F# 3.1 field labels in 'Usage' string. - - - - - Handles argument parser errors by exiting the process - after printing a parse error. - - - - - Consume all remaining command line arguments. - - - - - unparser - - - - - parser - - - - - field type - - - - - field label - - - - - Type name - - - - - Union Case Field info - - - - - parse source - - - - - metadata provided by the parser - - - - - ArgInfo used to parse parameter - - - - - untyped version of tuple of branch contents - - - - - union case value - - - - - Combine AppSettings with CLI inputs - - - - - Hide from Usage - - - - - Fails if no argument of this type is specified - - - - - If specified, multiple parameters can be added in AppSettings in CSV form. - - - - - Print labels in Usage () - - - - - If specified, use '--param=arg' CLI parsing syntax - - - - - If specified, parameter can only be at start of CLI parameters - - - - - If specified, should consume remaining tokens from the CLI - - - - - Description of the parameter - - - - - name used in AppSettings - - - - - head element denotes primary command line arg - - - - - Composes case fields into a tuple, if not nullary - - - - - Builds a union case out of its field parameters - - - - - Field parser definitions - - - - - Argument identifier - - - - - Represents a parsing schema for a single parameter - - - - - IComparable UnionCaseInfo wrapper - - - - - construct a parse result from untyped collection of parsed arguments - - - - - generate argument parsing schema from given UnionCaseInfo - - - - - recognize exprs that strictly contain DU constructors - e.g. <@ Case @> is valid but <@ fun x y -> Case y x @> is invalid - - - - - dummy argInfo for --help arg - - - - - get CL arguments from environment - - - - - construct an App.Config param from UCI name - - - - - construct a CLI param from UCI name - - - - - checks if given parameter name is contained in argument - - - - - gets the default name of the argument - - - - - NET35 support - - - - - Combines two parse results, AppConfig and CLI, overriding where appropriate. - By default, CLI parameters override AppConfig parameters. - - List of all possible arguments. - do not raise exception if missing mandatory parameters. - parsed results from AppSettings - parsed results from CLI - - - - Parse a given AppSettings file. - - AppConfig file to parsed. Defaults to ConfigutionManager resolution. - List of all possible arguments. - - - - Parse single AppSettings entry - - AppSettings key-value reader function. - threaded parse state. - Argument Info to parse. - - - - Parse the entire command line - - Dictionary of all possible CL arguments. - Ignored unrecognized parameters. - CL inputs - - - - parse the next command line argument and append to state - - - - - returns an App.Config XElement given a set of config parameters - - - - - - - - print the command line syntax - - - - - - print a command line argument for a set of parameters - - - - - - - print usage string for a collection of arg infos - - - - - - - print usage string for given arg info - - - - - - inherit this type for easy comparison semantics - - - - - reflected version of Unchecked.defaultof - - - - - gets the top-Level methodInfo call in a quotation - - - - - Nondeterministic Map active pattern combinator - - - - - Map active pattern combinator - - - - - returns `Some (map f ts)` iff `(forall t) ((f t).IsSome)` - - - - - - - try fetching last element of a list - - - - - fetch last element of a non-empty list - - - - diff --git a/packages/FAKE.4.11.3/tools/FAKE.exe b/packages/FAKE.4.11.3/tools/FAKE.exe deleted file mode 100644 index c1b9eba..0000000 Binary files a/packages/FAKE.4.11.3/tools/FAKE.exe and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/FAKE.exe.config b/packages/FAKE.4.11.3/tools/FAKE.exe.config deleted file mode 100644 index 7d9a1d8..0000000 --- a/packages/FAKE.4.11.3/tools/FAKE.exe.config +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/tools/FAKE.pdb.srcsrv b/packages/FAKE.4.11.3/tools/FAKE.pdb.srcsrv deleted file mode 100644 index 28fb428..0000000 --- a/packages/FAKE.4.11.3/tools/FAKE.pdb.srcsrv +++ /dev/null @@ -1,10 +0,0 @@ -SRCSRV: ini ------------------------------------------------ -VERSION=2 -SRCSRV: variables ------------------------------------------ -SRCSRVVERCTRL=https -SRCSRVTRG=https://raw.github.com/fsharp/FAKE/522aa8f1c7128bbee047e3f42deebdc7785cd072/%var2% -SRCSRV: source files --------------------------------------- -C:\code\fake\src\app\FAKE\CommandlineParams.fs*src/app/FAKE/CommandlineParams.fs -C:\code\fake\src\app\FAKE\Cli.fs*src/app/FAKE/Cli.fs -C:\code\fake\src\app\FAKE\Program.fs*src/app/FAKE/Program.fs -SRCSRV: end ------------------------------------------------ diff --git a/packages/FAKE.4.11.3/tools/FSharp.Compiler.Service.xml b/packages/FAKE.4.11.3/tools/FSharp.Compiler.Service.xml deleted file mode 100644 index 8cd78b7..0000000 --- a/packages/FAKE.4.11.3/tools/FSharp.Compiler.Service.xml +++ /dev/null @@ -1,25255 +0,0 @@ - - -FSharp.Compiler.Service - - - - The value '%s' is not accessible from this code location - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:964) - - - - - The union cases or fields of the type '%s' are not accessible from this code location - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:963) - - - - - The union case '%s' is not accessible from this code location - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:965) - - - - - The value or constructor '%s' is not defined - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:6) - - - - - The value, namespace, type or module '%s' is not defined - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:7) - - - - - The value, constructor, namespace or type '%s' is not defined - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:5) - - - - - The type parameter '%s' is not defined - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:12) - - - - - The type '%s' is not defined - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:9) - - - - - The record label or namespace '%s' is not defined - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:10) - - - - - The record label '%s' is not defined - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:11) - - - - - The pattern discriminator '%s' is not defined - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:13) - - - - - The namespace or module '%s' is not defined - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:3) - - - - - The namespace '%s' is not defined - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:2) - - - - - The field, constructor or member '%s' is not defined - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:4) - - - - - The constructor, module or namespace '%s' is not defined - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:8) - - - - - The type '%s' implements 'System.IComparable'. Consider also adding an explicit override for 'Object.Equals' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:172) - - - - - The type '%s' implements 'System.IComparable' explicitly but provides no corresponding override for 'Object.Equals'. An implementation of 'Object.Equals' has been automatically provided, implemented via 'System.IComparable'. Consider implementing the override 'Object.Equals' explicitly - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:173) - - - - - The signature and implementation are not compatible because the respective type parameter counts differ - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:168) - - - - - The signature and implementation are not compatible because the type parameter '%s' has a constraint of the form %s but the implementation does not. Either remove this constraint from the signature or add it to the implementation. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:171) - - - - - The signature and implementation are not compatible because the declaration of the type parameter '%s' requires a constraint of the form %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:170) - - - - - The signature and implementation are not compatible because the type parameter in the class/signature has a different compile-time requirement to the one in the member/implementation - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:169) - - - - - The override for '%s' was ambiguous - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:188) - - - - - The override '%s' implements more than one abstract slot, e.g. '%s' and '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:191) - - - - - No implementations of '%s' had the correct number of arguments and type parameters. The required signature is '%s'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:187) - - - - - No implementation was given for '%s'. Note that all interface members must be implemented and listed under an appropriate 'interface' declaration, e.g. 'interface ... with member ...'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:196) - - - - - No implementation was given for '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:195) - - - - - The interface '%s' is included in multiple explicitly implemented interface types. Add an explicit implementation of this interface. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:193) - - - - - A named argument has been assigned more than one value - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:194) - - - - - More than one override implements '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:189) - - - - - The namespace or module attributes differ between signature and implementation - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:185) - - - - - The method '%s' is sealed and cannot be overridden - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:190) - - - - - This method is over-constrained in its type parameters - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:186) - - - - - The member '%s' does not have the correct number of method type parameters. The required signature is '%s'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:198) - - - - - The member '%s' does not have the correct number of arguments. The required signature is '%s'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:197) - - - - - The member '%s' does not have the correct kinds of generic parameters. The required signature is '%s'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:199) - - - - - The member '%s' cannot be used to implement '%s'. The required signature is '%s'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:200) - - - - - Invalid value - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:167) - - - - - The struct, record or union type '%s' has an explicit implementation of 'Object.GetHashCode' or 'Object.Equals'. You must apply the 'CustomEquality' attribute to the type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:174) - - - - - The struct, record or union type '%s' has an explicit implementation of 'Object.GetHashCode'. Consider implementing a matching override for 'Object.Equals(obj)' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:175) - - - - - The struct, record or union type '%s' has an explicit implementation of 'Object.Equals'. Consider implementing a matching override for 'Object.GetHashCode()' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:176) - - - - - Duplicate or redundant interface - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:192) - - - - - The implicit instantiation of a generic construct at or near this point could not be resolved because it could resolve to multiple unrelated types, e.g. '%s' and '%s'. Consider using type annotations to resolve the ambiguity - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:162) - - - - - Could not resolve the ambiguity in the use of a generic construct with an 'unmanaged' constraint at or near this position - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1102) - - - - - Could not resolve the ambiguity inherent in the use of a 'printf'-style format string - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:164) - - - - - Could not resolve the ambiguity inherent in the use of the operator '%s' at or near this program point. Consider using type annotations to resolve the ambiguity. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:163) - - - - - Could not resolve the ambiguity in the use of a generic construct with an 'enum' constraint at or near this position - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:165) - - - - - Could not resolve the ambiguity in the use of a generic construct with a 'delegate' constraint at or near this position - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:166) - - - - - The type '%s' is not accessible from this code location - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:962) - - - - - union case - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:935) - - - - - property - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:940) - - - - - patvar - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:944) - - - - - and %d other overloads - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:934) - - - - - namespace/module - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:947) - - - - - namespace - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:945) - - - - - module - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:946) - - - - - generated type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:951) - - - - - generated property - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:950) - - - - - Full name - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:930) - - - - - also from %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:949) - - - - - from %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:948) - - - - - field - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:938) - - - - - extension - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:941) - - - - - event - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:939) - - - - - custom operation - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:942) - - - - - Calls - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1277) - - - - - argument - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:943) - - - - - active recognizer - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:937) - - - - - active pattern result - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:936) - - - - - Unexpected Expr.TyChoose - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:975) - - - - - Note: Lambda-lifting optimizations have not been applied because of the use of this local constrained generic function as a first class value. Adding type constraints may resolve this condition. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:976) - - - - - The 'VolatileField' attribute may only be used on 'let' bindings in classes - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:679) - - - - - Volatile fields must be marked 'mutable' and cannot be thread-static - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:734) - - - - - A declaration may only be given a value in a signature if the declaration has the [<Literal>] attribute - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:732) - - - - - In sequence expressions, multiple results are generated using 'yield!' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:654) - - - - - Character range matches have been removed in F#. Consider using a 'when' pattern guard instead. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:588) - - - - - 'use' expressions may not be used in queries - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1294) - - - - - The use of 'let! x = coll' in sequence expressions is not permitted. Use 'for x in coll' instead. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:652) - - - - - This attribute cannot be used in this version of F# - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:706) - - - - - This is not a known query operator. Query operators are identifiers such as 'select', 'where', 'sortBy', 'thenBy', 'groupBy', 'groupValBy', 'join', 'groupJoin', 'sumBy' and 'averageBy', defined using corresponding methods on the 'QueryBuilder' type. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1297) - - - - - Arguments to query operators may require parentheses, e.g. 'where (x > y)' or 'groupBy (x.Length / 10)' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1305) - - - - - Unrecognized attribute target. Valid attribute targets are 'assembly', 'module', 'type', 'method', 'property', 'return', 'param', 'field', 'event', 'constructor'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:696) - - - - - The unnamed arguments do not form a prefix of the arguments of the method called - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:673) - - - - - Unknown union case - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:527) - - - - - Unit-of-measure cannot be used in type constructor application - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:564) - - - - - This union case takes one argument - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:582) - - - - - The union case named '%s' conflicts with the generated type '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1123) - - - - - Union case/exception field '%s' cannot be used more than once. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1330) - - - - - This union case expects %d arguments in tupled form - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:583) - - - - - This union case does not take arguments - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:581) - - - - - Union case/exception '%s' does not have field named '%s'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1329) - - - - - Uninitialized 'val' fields must be mutable and marked with the '[<DefaultValue>]' attribute. Consider using a 'let' binding instead of a 'val' field. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:735) - - - - - Unexpected type arguments - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:573) - - - - - Unexpected %s in type expression - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:567) - - - - - Unexpected / in type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:572) - - - - - Unexpected source-level property specification - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:538) - - - - - Unexpected source-level property specification in syntax tree - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:532) - - - - - Unexpected SynMeasure.Anon - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:488) - - - - - Unexpected expression at recursive inference point - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:517) - - - - - Unexpected Const_uint16array - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:493) - - - - - Unexpected Const_bytearray - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:494) - - - - - Unexpected condition in imported assembly: failed to decode AttributeUsage attribute - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:695) - - - - - Unexpected big rational constant - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:491) - - - - - The field '%s' has been given a value, but is not present in the type '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:620) - - - - - Unable to parse format string '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:598) - - - - - Types cannot inherit from multiple concrete types - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:784) - - - - - Types cannot contain nested type definitions - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:764) - - - - - Struct types are always sealed - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:796) - - - - - Record types are always sealed - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:794) - - - - - Enum types are always sealed - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:798) - - - - - Delegate types are always sealed - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:797) - - - - - Discriminated union types are always sealed - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:793) - - - - - Assembly code types are always sealed - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:795) - - - - - The type '%s' is used in an invalid way. A value prior to '%s' has an inferred type involving '%s', which is an invalid forward reference. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:821) - - - - - This type test or downcast will erase the provided type '%s' to the type '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1216) - - - - - This type test or downcast will ignore the unit-of-measure '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1137) - - - - - This type test with a provided type '%s' is not allowed because this provided type will be erased to '%s' at runtime. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1218) - - - - - This type requires a definition - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:781) - - - - - The type parameters inferred for this value are not stable under the erasure of type abbreviations. This is due to the use of type abbreviations which drop or reorder type parameters, e.g. \n\ttype taggedInt<'a> = int or\n\ttype swap<'a,'b> = 'b * 'a.\nConsider declaring the type parameters for this value explicitly, e.g.\n\tlet f<'a,'b> ((x,y) : swap<'b,'a>) : swap<'a,'b> = (y,x). - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:522) - - - - - Type parameter cannot be used as type constructor - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:568) - - - - - This type parameter has been used in a way that constrains it to always be '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:521) - - - - - This value, type or method expects %d type parameter(s) but was given %d - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:544) - - - - - type or module - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:766) - - - - - The type '%s' is not an interface type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:742) - - - - - This type is not an interface type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:759) - - - - - This type is not a record type. Values of class and struct types must be created using calls to object constructors. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:647) - - - - - This type is not a record type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:648) - - - - - This type is not accessible from this code location - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:694) - - - - - This type has no nested types - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:566) - - - - - This type has no accessible object constructors - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:657) - - - - - type, exception or module - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:765) - - - - - Type definitions may only have one 'inherit' specification and it must be the first declaration - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:814) - - - - - 'let' and 'do' bindings must come before member and interface definitions in type definitions - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:815) - - - - - This type definition involves an immediate cyclic reference through a struct field or inheritance relation - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:810) - - - - - This type definition involves an immediate cyclic reference through an abbreviation - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:809) - - - - - This downcast will erase the provided type '%s' to the type '%s'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1217) - - - - - The type '%s' is not a type whose values can be enumerated with this syntax, i.e. is not compatible with either seq<_>, IEnumerable<_> or IEnumerable and does not have a GetEnumerator method - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:551) - - - - - Type abbreviations cannot have members - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:749) - - - - - Type abbreviations cannot have interface declarations - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:757) - - - - - Type abbreviations cannot have augmentations - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:819) - - - - - This type abbreviation has one or more declared type parameters that do not appear in the type being abbreviated. Type abbreviations must use all declared type parameters in the type being abbreviated. Consider removing one or more type parameters, or use a concrete type definition that wraps an underlying type, such as 'type C<'a> = C of ...'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:782) - - - - - 'try/with' expressions may not be used in queries - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1298) - - - - - 'try'/'with' cannot be used within sequence expressions - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:653) - - - - - Thread-static and context-static variables must be static and given the [<DefaultValue>] attribute to indicate that the value is initialized to the default value on each new thread - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:733) - - - - - This member, function or value declaration may not be declared 'inline' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1303) - - - - - This type definition may not have the 'CLIMutable' attribute. Only record types may have this attribute. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1285) - - - - - Invalid provided field. Provided fields of erased provided types must be literals. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1315) - - - - - The syntax 'expr.id' may only be used with record labels, properties and fields - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:668) - - - - - Syntax error - unexpected '?' symbol - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:590) - - - - - '%s' may only be used to construct object types - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:618) - - - - - The struct, record or union type '%s' has the 'StructuralEquality' attribute but the component type '%s' does not satisfy the 'equality' constraint - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1080) - - - - - The struct, record or union type '%s' has the 'StructuralEquality' attribute but the type parameter '%s' does not satisfy the 'equality' constraint. Consider adding the 'equality' constraint to the type parameter - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1079) - - - - - The struct, record or union type '%s' has the 'StructuralComparison' attribute but the component type '%s' does not satisfy the 'comparison' constraint - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1074) - - - - - The struct, record or union type '%s' has the 'StructuralComparison' attribute but the type parameter '%s' does not satisfy the 'comparison' constraint. Consider adding the 'comparison' constraint to the type parameter - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1073) - - - - - Each argument of the primary constructor for a struct must be given a type, for example 'type S(x1:int, x2: int) = ...'. These arguments determine the fields of the struct. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1081) - - - - - Structs cannot contain value definitions because the default constructor for structs will not execute these bindings. Consider adding additional arguments to the primary constructor for the type. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:753) - - - - - Structs cannot contain 'do' bindings because the default constructor for structs would not execute these bindings - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:752) - - - - - Structs, interfaces, enums and delegates cannot inherit from other types - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:783) - - - - - Structs cannot have an object constructor with no arguments. This is a restriction imposed on all CLI languages as structs automatically support a default constructor. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:725) - - - - - Structs may only bind a 'this' parameter at member declarations - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:516) - - - - - Struct types cannot contain abstract members - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:803) - - - - - Static 'val' fields in types must be mutable, private and marked with the '[<DefaultValue>]' attribute. They are initialized to the 'null' or 'zero' value for their type. Consider also using a 'static let mutable' binding in a class type. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:736) - - - - - Static optimization conditionals are only for use within the F# library - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:674) - - - - - This static member should not have a 'this' parameter. Consider using the notation 'member Member(args) = ...'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:535) - - - - - Static value definitions may only be used in types with a primary constructor. Consider adding arguments to the type definition, e.g. 'type X(args) = ...'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:754) - - - - - Interfaces cannot contain definitions of static initializers - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:720) - - - - - A static initializer requires an argument - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:533) - - - - - A static field was used where an instance field is expected - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:484) - - - - - A simple method name is required here - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:627) - - - - - In sequence expressions, results are generated using 'yield' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:490) - - - - - Array method '%s' is supplied by the runtime and cannot be directly used in code. For operations with array elements consider using family of GetArray/SetArray functions from LanguagePrimitives.IntrinsicFunctions module. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1328) - - - - - Return values cannot have names - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:496) - - - - - Return types of union cases must be identical to the type being defined, up to abbreviations - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:740) - - - - - 'return' and 'return!' may not be used in queries - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1296) - - - - - The syntax 'type X with ...' is reserved for augmentations. Types whose representations are hidden but which have members are now declared in signatures using 'type X = ...'. You may also need to add the '[<Sealed>] attribute to the type definition in the signature - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:811) - - - - - This is not a variable, constant, active recognizer or literal - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:586) - - - - - This control construct may only be used if the computation expression builder defines a '%s' method - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:565) - - - - - Only active patterns returning exactly one result may accept arguments - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:578) - - - - - The representation of this type is hidden by the signature. It must be given an attribute such as [<Sealed>], [<Class>] or [<Interface>] to indicate the characteristics of the type. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:789) - - - - - Recursive bindings that include member specifications can only occur as a direct augmentation of a type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:727) - - - - - Records, union, abbreviations and struct types cannot have the 'AllowNullLiteral' attribute - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:785) - - - - - This record contains fields from inconsistent types - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:514) - - - - - A property cannot have explicit type parameters. Consider using a method instead. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:529) - - - - - This property or field was not found on this custom attribute type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:701) - - - - - Property '%s' is static - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:665) - - - - - Property '%s' is not static - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:662) - - - - - Property '%s' is not readable - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:663) - - - - - Property '%s' cannot be set - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:666) - - - - - This property cannot be set - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:700) - - - - - The types System.ValueType, System.Enum, System.Delegate, System.MulticastDelegate and System.Array cannot be used as super types in an object expression or class - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:628) - - - - - A parameter with attributes must also be given a name, e.g. '[<Attribute>] Name : Type' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:495) - - - - - The parameter '%s' was inferred to have byref type. Parameters of byref type must be given an explicit type annotation, e.g. 'x1: byref<int>'. When used, a byref parameter is implicitly dereferenced. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1098) - - - - - You must explicitly declare either all or no type parameters when overriding a generic abstract method - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:524) - - - - - Accessibility modifiers are not permitted on overrides or interface implementations - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:792) - - - - - This override takes a different number of arguments to the corresponding abstract member - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:712) - - - - - One or more of the overloads of this method has curried arguments. Consider redesigning these members to take arguments in tupled form. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:672) - - - - - Optional arguments cannot be used in custom attributes - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:699) - - - - - Optional arguments are only permitted on type members - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:574) - - - - - Optional arguments must come at the end of the argument list, after any non-optional arguments - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1116) - - - - - '%s' must be followed by 'in'. Usage: %s. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1322) - - - - - Incorrect syntax for '%s'. Usage: %s. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1249) - - - - - The operator '%s' does not accept the use of 'into' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1283) - - - - - This declaration opens the namespace or module '%s' through a partially qualified path. Adjust this code to use the full path of the namespace. This change will make your code more robust as new constructs are added to the F# and CLI libraries. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:747) - - - - - Only types representing units-of-measure may be given the 'Measure' attribute - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:791) - - - - - Only structs and classes without primary constructors may be given the 'StructLayout' attribute - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:788) - - - - - Only simple variable patterns can be bound in 'let rec' constructs - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:728) - - - - - Only simple bindings of the form 'id = expr' can be used in construction expressions - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:634) - - - - - Only record fields and simple 'let' bindings may be marked mutable - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:729) - - - - - Only functions may be marked 'inline' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:688) - - - - - Only classes may be given the 'AbstractClass' attribute - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:790) - - - - - Objects must be initialized by an object construction expression that calls an inherited object constructor and assigns a value to each field - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:635) - - - - - The operator 'expr.[idx]' has been used on an object of indeterminate type based on information prior to this program point. Consider adding further type constraints - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:609) - - - - - Only overrides of abstract and virtual members may be specified in object expressions - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:623) - - - - - This form of object expression is not used in F#. Use 'member this.MemberName ... = ...' to define member implementations in object expressions. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:539) - - - - - Calls to object constructors on type parameters cannot be given arguments - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:611) - - - - - Interfaces cannot contain definitions of object constructors - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:721) - - - - - An object constructor requires an argument - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:534) - - - - - Object construction expressions (i.e. record expressions with inheritance specifications) may only be used to implement constructors in object model types. Use 'new ObjectType(args)' to construct instances of object model types outside of constructors - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:645) - - - - - Object construction expressions may only be used to implement constructors in class types - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:633) - - - - - This numeric literal requires that a module '%s' defining functions FromZero, FromOne, FromInt32, FromInt64 and FromString be in scope - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:641) - - - - - This is not a valid name for an enumeration case - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:602) - - - - - This code is not sufficiently generic. The type variable %s could not be generalized because it would escape its scope. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:528) - - - - - Not an exception - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:774) - - - - - Non-zero constants cannot have generic units. For generic zero, write 0.0<_>. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:489) - - - - - The generic member '%s' has been used at a non-uniform instantiation prior to this program point. Consider reordering the members so this member occurs first. Alternatively, specify the full type of the member explicitly, including argument types, return type and any additional generic parameters and constraints. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1099) - - - - - This 'let' definition may not be used in a query. Only simple value definitions may be used in queries. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1299) - - - - - This value is not a literal and cannot be used in a pattern - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:547) - - - - - 'while' expressions may not be used in queries - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1292) - - - - - 'try/finally' expressions may not be used in queries - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1293) - - - - - No abstract property was found that corresponds to this override - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:715) - - - - - No abstract or interface member was found that corresponds to this override - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:711) - - - - - Interface implementations cannot be given on construction expressions - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:632) - - - - - In queries, use the form 'for x in n .. m do ...' for ranging over integers - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1291) - - - - - The struct, record or union type '%s' does not support structural equality because the type '%s' does not satisfy the 'equality' constraint. Consider adding the 'NoEquality' attribute to the type '%s' to clarify that the type does not support structural equality - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1078) - - - - - The struct, record or union type '%s' does not support structural equality because the type parameter %s does not satisfy the 'equality' constraint. Consider adding the 'NoEquality' attribute to the type '%s' to clarify that the type does not support structural equality - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1077) - - - - - The struct, record or union type '%s' is not structurally comparable because the type '%s' does not satisfy the 'comparison' constraint. Consider adding the 'NoComparison' attribute to the type '%s' to clarify that the type is not comparable - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1076) - - - - - The struct, record or union type '%s' is not structurally comparable because the type parameter %s does not satisfy the 'comparison' constraint. Consider adding the 'NoComparison' attribute to the type '%s' to clarify that the type is not comparable - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1075) - - - - - No arguments may be given when constructing a record value - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:631) - - - - - The member '%s' does not correspond to any abstract or virtual method available to override or implement - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:624) - - - - - 'new' may only be used with object constructors - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:639) - - - - - 'new' must be used with a named type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:629) - - - - - This new member hides the abstract member '%s' once tuples, functions, units of measure and/or provided types are erased. Rename the member or use 'override' instead. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:719) - - - - - This new member hides the abstract member '%s'. Rename the member or use 'override' instead. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:718) - - - - - 'new' cannot be used on interface types. Consider using an object expression '{ new ... with ... }' instead. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:615) - - - - - Namespaces cannot contain values. Consider using a module to hold your value declarations. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:498) - - - - - Namespaces cannot contain extension members except in the same file and namespace where the type is defined. Consider using a module to hold declarations of extension members. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:499) - - - - - '%s' may only be used with named types - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:613) - - - - - Named arguments cannot be given to member trait calls - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:601) - - - - - The named argument '%s' did not match any argument or mutable property - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:671) - - - - - Name '%s' not bound in pattern context - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:575) - - - - - Named arguments must appear after all other arguments - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:549) - - - - - Mutable function values should be written 'let mutable f = (fun args -> ...)' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:687) - - - - - Mutable values cannot have generic parameters - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:686) - - - - - Mutable values cannot be marked 'inline' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:685) - - - - - Multiple visibility attributes have been specified for this identifier. 'let' bindings in classes are always private, as are any 'let' bindings inside expressions. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:501) - - - - - Multiple visibility attributes have been specified for this identifier - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:500) - - - - - This declaration opens the module '%s', which is marked as 'RequireQualifiedAccess'. Adjust your code to use qualified references to the elements of the module instead, e.g. 'List.map' instead of 'map'. This change will ensure that your code is robust as new constructs are added to libraries. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:746) - - - - - The path '%s' is a namespace. A module abbreviation may not abbreviate a namespace. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:820) - - - - - A custom query operation for '%s' is required but not specified - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1230) - - - - - Method overrides and interface implementations are not permitted here - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:710) - - - - - Method '%s' is not accessible from this code location - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:485) - - - - - Members that extend interface, delegate or enum types must be placed in a module separate to the definition of the type. This module must either have the AutoOpen attribute or be opened explicitly by client code to bring the extension members into scope. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:812) - - - - - The member '%s' is used in an invalid way. A use of '%s' has been inferred prior to the definition of '%s', which is an invalid forward reference. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:822) - - - - - Interfaces cannot contain definitions of member overrides - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:722) - - - - - Extension members cannot provide operator overloads. Consider defining the operator as part of the type definition instead. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1119) - - - - - This member is not permitted in an interface implementation - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:762) - - - - - MemberKind.PropertyGetSet only expected in parse trees - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:497) - - - - - This member is not sufficiently generic - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:730) - - - - - A member and a local class binding both have the name '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:756) - - - - - Measure definitions cannot have type parameters - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:780) - - - - - Measure declarations may have only static members: constructors are not available - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:755) - - - - - Measure declarations may have only static members - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:751) - - - - - 'match' expressions may not be used in queries - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1319) - - - - - This lookup cannot be used here - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:664) - - - - - Local class bindings cannot be marked inline. Consider lifting the definition out of the class or else do not mark it as inline. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:748) - - - - - Literal values cannot have generic parameters - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:692) - - - - - A literal value cannot be marked 'mutable' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:690) - - - - - A literal value cannot be marked 'inline' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:691) - - - - - A declaration may only be the [<Literal>] attribute if a constant value is also given, e.g. 'val x : int = 1' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:731) - - - - - This list expression exceeds the maximum size for list literals. Use an array for larger literals and call Array.ToList. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:599) - - - - - This definition may only be used in a type with a primary constructor. Consider adding arguments to your type definition, e.g. 'type X(args) = ...'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:818) - - - - - This code is less generic than required by its annotations because the explicit type variable '%s' could not be generalized. It was constrained to be '%s'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:518) - - - - - The kind of the type specified by its attributes does not match the kind implied by its definition - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:779) - - - - - In queries, '%s' must use a simple pattern - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1229) - - - - - Invalid use of a type name - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:656) - - - - - Invalid use of an interface type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:660) - - - - - Invalid use of a delegate constructor. Use the syntax 'new Type(args)' or just 'Type(args)'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:661) - - - - - The 'UseNullAsTrueValue' attribute flag may only be used with union types that have one nullary case and at least one non-nullary case - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1097) - - - - - 'use' bindings must be of the form 'use <var> = <expr>' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:708) - - - - - 'use!' bindings must be of the form 'use! <var> = <expr>' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1132) - - - - - Units-of-measure cannot be used as prefix arguments to a type. Rewrite as postfix arguments in angle brackets. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:563) - - - - - Units-of-measure supported only on float, float32, decimal and signed integer types - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:492) - - - - - Literal enumerations must have type int, uint, int16, uint16, int64, uint64, byte, sbyte or char - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:807) - - - - - Invalid type extension - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:777) - - - - - Type arguments cannot be specified here - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:577) - - - - - The number of type arguments did not match: '%d' given, '%d' expected. This may be related to a previously reported error. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1223) - - - - - Invalid signature for set member - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:717) - - - - - Invalid record, sequence or computation expression. Sequence expressions should be of the form 'seq { ... }' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:596) - - - - - Invalid join relation in '%s'. Expected 'expr <op> expr', where <op> is =, =?, ?= or ?=?. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1276) - - - - - Invalid record construction - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:642) - - - - - This property has an invalid type. Properties taking multiple indexer arguments should have types of the form 'ty1 * ty2 -> ty3'. Properties returning functions should have types of the form '(ty1 -> ty2)'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:558) - - - - - This is not a valid pattern - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:587) - - - - - Invalid optional assignment to a property or field - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:676) - - - - - The '%s' operator should not normally be redefined. To define overloaded comparison semantics for a particular type, implement the 'System.IComparable' interface in the definition of that type. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:506) - - - - - The '%s' operator should not normally be redefined. To define equality semantics for a type, override the 'Object.Equals' member in the definition of that type. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:507) - - - - - The '%s' operator should not normally be redefined. Consider using a different operator name - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:508) - - - - - Invalid object, sequence or record expression - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:595) - - - - - Invalid object expression. Objects without overrides or interfaces should use the expression form 'new Type(args)' without braces. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:594) - - - - - This is not a valid object construction expression. Explicit object constructors must either call an alternate constructor or initialize all fields of the object and specify a call to a super class constructor. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:553) - - - - - Non-primitive numeric literal constants cannot be used in pattern matches because they can be mapped to multiple different types through the use of a NumericLiteral module. Consider using replacing with a variable, and use 'when <variable> = <constant>' at the end of the match clause. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:576) - - - - - 'new' constraints must take one argument of type 'unit' and return the constructed type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:557) - - - - - Invalid namespace, module, type or union case name - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:738) - - - - - Invalid module name - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:776) - - - - - This recursive binding uses an invalid mixture of recursive forms - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:552) - - - - - The name '(%s)' should not be used as a member name. To define comparison semantics for a type, implement the 'System.IComparable' interface. If defining a static member for use from other CLI languages then use the name '%s' instead. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:502) - - - - - The name '(%s)' should not be used as a member name. To define equality semantics for a type, override the 'Object.Equals' member. If defining a static member for use from other CLI languages then use the name '%s' instead. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:503) - - - - - The name '(%s)' should not be used as a member name because it is given a standard definition in the F# library over fixed types - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:505) - - - - - Invalid member name. Members may not have name '.ctor' or '.cctor' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1221) - - - - - The name '(%s)' should not be used as a member name. If defining a static member for use from other CLI languages then use the name '%s' instead. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:504) - - - - - Invalid inline specification - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:707) - - - - - Invalid indexer expression - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:608) - - - - - The '%s' operator cannot be redefined. Consider using a different operator name - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:509) - - - - - Internal error. Invalid index into active pattern array - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:580) - - - - - This is not a valid value for an enumeration literal - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:741) - - - - - An 'enum' constraint must be of the form 'enum<type>' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:556) - - - - - Delegate specifications must be of the form 'typ -> typ' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:805) - - - - - Invalid declaration - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:540) - - - - - Invalid constraint: the type used for the constraint is sealed, which means the constraint could only be satisfied by at most one solution - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:555) - - - - - Invalid constraint - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:554) - - - - - This is not a valid constant expression - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:693) - - - - - Invalid assignment - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:655) - - - - - Invalid argument to parameterized pattern label - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:579) - - - - - This is not a valid name for an active pattern - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:683) - - - - - A use of 'into' must be followed by the remainder of the computation - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1282) - - - - - Interfaces inherited by other interfaces should be declared using 'inherit ...' instead of 'interface ...' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1108) - - - - - Interface types cannot be sealed - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:804) - - - - - Interface types and delegate types cannot contain fields - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:799) - - - - - This instance member needs a parameter to represent the object being invoked. Make the member static or use the notation 'member x.Member(args) = ...'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:531) - - - - - The inherited type is not an object model type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:644) - - - - - A inheritance declaration is not permitted here - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:745) - - - - - This 'inherit' declaration specifies the inherited type but no arguments. Consider supplying arguments, e.g. 'inherit BaseType(args)'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:816) - - - - - This 'inherit' declaration has arguments, but is not in a type with a primary constructor. Consider adding arguments to your type definition, e.g. 'type X(args) = ...'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:817) - - - - - 'inherit' cannot be used on interface types. Consider implementing the interface by using 'interface ... with ... end' instead. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:614) - - - - - The function or member '%s' is used in a way that requires further type annotations at its definition to ensure consistency of inferred types. The inferred signature is '%s'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1222) - - - - - Implicit product of measures following / - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:487) - - - - - The struct, record or union type '%s' implements the interface 'System.IStructuralEquatable' explicitly. Apply the 'CustomEquality' attribute to the type. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:767) - - - - - The struct, record or union type '%s' implements the interface 'System.IStructuralComparable' explicitly. Apply the 'CustomComparison' attribute to the type. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:513) - - - - - The struct, record or union type '%s' implements the interface 'System.IEquatable<_>' explicitly. Apply the 'CustomEquality' attribute to the type and provide a consistent implementation of the non-generic override 'System.Object.Equals(obj)'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:768) - - - - - The struct, record or union type '%s' implements the interface 'System.IComparable' explicitly. You must apply the 'CustomComparison' attribute to the type. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:511) - - - - - The struct, record or union type '%s' implements the interface 'System.IComparable<_>' explicitly. You must apply the 'CustomComparison' attribute to the type, and should also provide a consistent implementation of the non-generic interface System.IComparable. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:512) - - - - - Illegal syntax in type expression - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:569) - - - - - This is not valid literal expression. The [<Literal>] attribute will be ignored. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1334) - - - - - Illegal pattern - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:589) - - - - - Explicit type declarations for constructors must be of the form 'ty1 * ... * tyN -> resTy'. Parentheses may be required around 'resTy' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:739) - - - - - A literal value cannot be given the [<ThreadStatic>] or [<ContextStatic>] attributes - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:689) - - - - - An if/then/else expression may not be used within queries. Consider using either an if/then expression, or use a sequence expression instead. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1239) - - - - - It is recommended that objects supporting the IDisposable interface are created using the syntax 'new Type(args)', rather than 'Type(args)' or 'Type' as a function value representing the constructor, to indicate that resources may be owned by the generated value - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:617) - - - - - Generic types cannot be given the 'StructLayout' attribute - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:787) - - - - - A generic type parameter has been used in a way that constrains it to always be '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:520) - - - - - The provided types generated by this use of a type provider may not be used from other F# assemblies and should be marked internal or private. Consider using 'type internal TypeName = ...' or 'type private TypeName = ...'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1326) - - - - - The generic function '%s' must be given explicit type argument(s) - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:542) - - - - - This function value is being used to construct a delegate type whose signature includes a byref argument. You must use an explicit lambda expression taking %d arguments. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:550) - - - - - The corresponding formal argument is not optional - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:675) - - - - - The field labels and expected type of this record expression or pattern do not uniquely determine a corresponding record type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:525) - - - - - A field/val declaration is not permitted here - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:744) - - - - - This field requires a name - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:737) - - - - - No assignment given for field '%s' of type '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:621) - - - - - This field is not a literal and cannot be used in a pattern - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:585) - - - - - Named field '%s' is used more than once. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1331) - - - - - Named field '%s' conflicts with autogenerated name for anonymous field. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1332) - - - - - This field is readonly - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:548) - - - - - Field '%s' is not static - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:584) - - - - - This field is not mutable - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:603) - - - - - The field '%s' appears twice in this record expression or pattern - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:526) - - - - - All record, union and struct types in FSharp.Core.dll must be explicitly labelled with 'StructuralComparison' or 'NoComparison' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1072) - - - - - Extraneous fields have been given values - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:622) - - - - - This list or array expression includes an element of the form 'if ... then ... else'. Parenthesize this expression to indicate it is an individual element of the list or array, to disambiguate this from a list generated using a sequence expression - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:597) - - - - - This expression form may only be used in sequence and computation expressions - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:593) - - - - - The expression form { expr with ... } may only be used with record types. To build object types use { new Type(...) with ... } - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:643) - - - - - The expression form 'expr then expr' may only be used as part of an explicit object constructor - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:600) - - - - - Expected %d expressions, got %d - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:591) - - - - - TcExprUndelayed: delayed - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:592) - - - - - Explicit type specifications cannot be used for exception constructors - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:769) - - - - - Explicit type parameters may only be used on module or member bindings - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:523) - - - - - An explicit static initializer should use the syntax 'static new(args) = expr' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:536) - - - - - An explicit object constructor should use the syntax 'new(args) = expr' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:537) - - - - - Expected unit-of-measure, not type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:562) - - - - - Expected unit-of-measure parameter, not type parameter. Explicit unit-of-measure parameters must be marked with the [<Measure>] attribute. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:559) - - - - - Expected type parameter, not unit-of-measure parameter - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:560) - - - - - Expected type, not unit-of-measure - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:561) - - - - - Expected an interface type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:636) - - - - - Expected module or namespace parent %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:510) - - - - - Exception abbreviations should not have argument lists - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:770) - - - - - Exception abbreviations must refer to existing exceptions or F# types deriving from System.Exception - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:772) - - - - - Event '%s' is static - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:669) - - - - - Event '%s' is not static - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:670) - - - - - Enumerations cannot have members - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:750) - - - - - Enumerations cannot have interface declarations - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:758) - - - - - The type '%s' is not a valid enumerator type , i.e. does not have a 'MoveNext()' method returning a bool, and a 'Current' property - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1134) - - - - - The 'EntryPointAttribute' attribute may only be used on function definitions in modules - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:684) - - - - - '{ }' is not a valid expression. Records must include at least one field. Empty sequences are specified by using Seq.empty or an empty list '[]'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:646) - - - - - Copy-and-update record expressions must include at least one field. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1324) - - - - - Duplicate specification of an interface - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:743) - - - - - The method or function '%s' should not be given explicit type argument(s) because it does not declare its type parameters explicitly - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:543) - - - - - 'do!' cannot be used within sequence expressions - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:651) - - - - - DLLImport stubs cannot be inlined - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:515) - - - - - DLLImport bindings must be static members in a class or function definitions in a module - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1125) - - - - - Delegate specifications must not be curried types. Use 'typ * ... * typ -> typ' for multi-argument delegates, and 'typ -> (typ -> typ)' for delegates returning function values. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:806) - - - - - A delegate constructor must be passed a single function value - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:677) - - - - - The 'DefaultValue' attribute may only be used on 'val' declarations - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:681) - - - - - The default, zero-initializing constructor of a struct type may only be used if all the fields of the struct type admit default initialization - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:545) - - - - - A default implementation of this interface has already been added because the explicit implementation of the interface was not specified at the definition of the type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:761) - - - - - This method already has a default implementation - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:713) - - - - - The method implemented by this default is ambiguous - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:714) - - - - - The declared type parameters for this type extension do not match the declared type parameters on the original type '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:813) - - - - - This declaration element is not permitted in an augmentation - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:763) - - - - - '%s' is not used correctly. Usage: %s. This is a custom operation in this query or computation expression. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1244) - - - - - '%s' is not used correctly. This is a custom operation in this query or computation expression. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1243) - - - - - A custom operation may not be used in conjunction with a non-value or recursive 'let' binding in another part of this computation expression - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1236) - - - - - A custom operation may not be used in conjunction with 'use', 'try/with', 'try/finally', 'if/then/else' or 'match' operators within this computation expression - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1237) - - - - - The custom operation '%s' refers to a method which is overloaded. The implementations of custom operations may not be overloaded. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1238) - - - - - The definition of the custom operator '%s' does not use a valid combination of attribute flags - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1284) - - - - - '%s' is used with an incorrect number of arguments. This is a custom operation in this query or computation expression. Expected %d argument(s), but given %d. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1251) - - - - - A custom attribute must invoke an object constructor - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:704) - - - - - A custom attribute must be a reference type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:702) - - - - - The number of args for a custom attribute does not match the expected number of args for the attribute constructor - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:703) - - - - - Couldn't find Dispose on IDisposable, or it was overloaded - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:546) - - - - - Constructors cannot be defined for this type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:726) - - - - - Constructors cannot be specified in exception augmentations - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:724) - - - - - Constructors must be applied to arguments and cannot be used as first-class values. If necessary use an anonymous function '(fun arg1 ... argN -> new Type(arg1,...,argN))'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:667) - - - - - Constructors for the type '%s' must directly or indirectly call its implicit object constructor. Use a call to the implicit object constructor instead of a record expression. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:619) - - - - - This object constructor requires arguments - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:638) - - - - - Constructor expressions for interfaces do not take arguments - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:637) - - - - - A constructor cannot have explicit type parameters. Consider using a static construction method instead. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:530) - - - - - This construct may only be used within sequence or computation expressions - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:606) - - - - - This construct may only be used within list, array and sequence expressions, e.g. expressions of the form 'seq { ... }', '[ ... ]' or '[| ... |]'. These use the syntax 'for ... in ... do ... yield...' to generate elements - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:604) - - - - - This construct may only be used within computation expressions. To return a value from an ordinary function simply write the expression without 'return'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:605) - - - - - This construct may only be used within computation expressions - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:607) - - - - - This construct is ambiguous as part of a sequence expression. Nested expressions may be written using 'let _ = (...)' and nested sequences using 'yield! seq {... }'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:650) - - - - - This construct is ambiguous as part of a computation expression. Nested expressions may be written using 'let _ = (...)' and nested computations using 'let! res = builder { ... }'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:649) - - - - - One or more of the explicit class or function type variables for this binding could not be generalized, because they were constrained to other types - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:519) - - - - - Attribute 'System.Diagnostics.ConditionalAttribute' is only valid on methods or attribute classes - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1117) - - - - - The 'ConditionalAttribute' attribute may only be used on members - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:682) - - - - - Interfaces cannot contain definitions of concrete members. You may need to define a constructor on your type to indicate that the type is a class. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:723) - - - - - The 'CompiledName' attribute cannot be used with this language element - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:612) - - - - - Cannot override inherited member '%s' because it is sealed - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1224) - - - - - Cannot inherit from a variable type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:610) - - - - - Cannot inherit a sealed type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:801) - - - - - Cannot inherit from interface type. Use interface ... with instead. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:802) - - - - - Cannot inherit from erased provided type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1219) - - - - - Cannot create an extension of a sealed type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:630) - - - - - Cannot call an abstract base member: '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1101) - - - - - A binding cannot be marked both 'use' and 'rec' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:678) - - - - - 'let!', 'use!' and 'do!' expressions may not be used in queries - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1295) - - - - - '%s' must be followed by a variable name. Usage: %s. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1248) - - - - - '%s' must come after a 'for' selection clause and be followed by the rest of the query. Syntax: ... %s ... - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1250) - - - - - 'member val' definitions are only permitted in types with a primary constructor. Consider adding arguments to your type definition, e.g. 'type X(args) = ...'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1286) - - - - - The attributes of this type specify multiple kinds for the type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:778) - - - - - Attributes are not allowed within patterns - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:541) - - - - - Attributes are not permitted on 'let' bindings in expressions - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:680) - - - - - This attribute is not valid for use on this language element. Assembly attributes should be attached to a 'do ()' declaration, if necessary within an F# module. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:697) - - - - - This attribute is not valid for use on this language element - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:698) - - - - - Attribute expressions must be calls to object constructors - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:705) - - - - - The attribute 'AutoOpen(\"%s\")' in the assembly '%s' did not refer to a valid module or namespace in that assembly and has been ignored - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:825) - - - - - The attribute '%s' appears in both the implementation and the signature, but the attribute arguments differ. Only the attribute from the signature will be included in the compiled code. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1100) - - - - - At least one override did not correctly implement its corresponding abstract member - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:640) - - - - - The member '%s' does not accept the correct number of arguments. One overload accepts %d arguments. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:626) - - - - - The member '%s' does not accept the correct number of arguments, %d arguments are expected - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:625) - - - - - Anonymous unit-of-measure cannot be nested inside another unit-of-measure expression - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:570) - - - - - Anonymous type variables are not permitted in this declaration - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:571) - - - - - Types with the 'AllowNullLiteral' attribute may only inherit from or implement types which also allow the use of the null literal - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:786) - - - - - All implemented interfaces should be declared on the initial declaration of the type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:760) - - - - - Instances of this type cannot be created since it has been marked abstract or not all methods have been given implementations. Consider using an object expression '{ new ... with ... }' instead. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:616) - - - - - This property overrides or implements an abstract property but the abstract property doesn't have a corresponding %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:716) - - - - - Abstract members are not permitted in an augmentation - they must be defined as part of the type itself - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:709) - - - - - Abbreviations for Common IL exception types must have a matching object constructor - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:773) - - - - - Abbreviations for Common IL exceptions cannot take arguments - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:771) - - - - - Abbreviated types cannot be given the 'Sealed' attribute - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:800) - - - - - F# supports a maximum array rank of 32 - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1290) - - - - - A value must be mutable in order to mutate the contents or take the address of a value type, e.g. 'let mutable x = ...' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:82) - - - - - The value has been copied to ensure the original is not mutated by this operation - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:84) - - - - - This value does not have a valid property setter type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:78) - - - - - Unexpected decode of InternalsVisibleToAttribute - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:89) - - - - - Unexpected decode of InterfaceDataVersionAttribute - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:90) - - - - - Unexpected decode of AutoOpenAttribute - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:88) - - - - - Unexpected use of a byref-typed variable - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:81) - - - - - The module/namespace '%s' from compilation unit '%s' did not contain the val '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1095) - - - - - The module/namespace '%s' from compilation unit '%s' did not contain the namespace, module or type '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1096) - - - - - The module/namespace '%s' from compilation unit '%s' did not contain the module/namespace '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1094) - - - - - The type/module '%s' is not a concrete module or type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:68) - - - - - The type '%s' has an inline assembly code representation - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:69) - - - - - Two modules named '%s' occur in two parts of this assembly - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:71) - - - - - Recursively defined values cannot appear directly as part of the construction of a tuple value within a recursive binding - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:85) - - - - - Recursive values cannot be directly assigned to the non-mutable field '%s' of the type '%s' within a recursive binding. Consider using a mutable field instead. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:87) - - - - - Recursive values cannot appear directly as a construction of the type '%s' within a recursive binding. This feature has been removed from the F# language. Consider using a record instead. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:86) - - - - - This is not a valid constant expression or custom attribute value - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:92) - - - - - A namespace and a module named '%s' both occur in two parts of this assembly - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:70) - - - - - Invalid mutation of a constant expression. Consider copying the expression to a mutable local, e.g. 'let mutable x = ...'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:83) - - - - - Invalid member signature encountered because of an earlier error - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:77) - - - - - Invalid form for a property setter. At least one argument is required. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:80) - - - - - Invalid form for a property getter. At least one '()' argument is required when using the explicit syntax. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:79) - - - - - This operation accesses a mutable top-level value defined in another assembly in an unsupported way. The value cannot be accessed through its address. Consider copying the expression to a mutable local, e.g. 'let mutable x = ...', and if necessary assigning the value back after the completion of the operation - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1088) - - - - - Two type definitions named '%s' occur in namespace '%s' in two parts of this assembly - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:72) - - - - - This literal expression or attribute argument results in an arithmetic overflow. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1333) - - - - - A module and a type definition named '%s' occur in namespace '%s' in two parts of this assembly - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:73) - - - - - Active patterns cannot return more than 7 possibilities - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:91) - - - - - The struct or class field '%s' is not accessible from this code location - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:967) - - - - - If set to true, then all error messages will just return the filled 'holes' delimited by ',,,'s - this is for language-neutral testing (e.g. localization-invariant baselines). - - - - - Recursive class hierarchy in type '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:959) - - - - - Unexpected token '%s' in preprocessor expression - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1340) - - - - - Missing token '%s' in preprocessor expression - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1342) - - - - - Incomplete preprocessor expression - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1341) - - - - - Unexpected character '%s' in preprocessor expression - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1339) - - - - - Expected single line comment or end of line - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1068) - - - - - An error occurred while reading the F# metadata node at position %d in table '%s' of assembly '%s'. The node had no matching declaration. Please report this warning. You may need to recompile the F# assembly you are using. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1343) - - - - - Error reading/writing metadata for the F# compiled DLL '%s'. Was the DLL compiled with an earlier version of the F# compiler? (error: '%s'). - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:64) - - - - - Problem with filename '%s': Illegal characters in path. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1165) - - - - - Partial active patterns may only generate one result - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:986) - - - - - Missing variable '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:985) - - - - - Missing 'do' in 'while' expression. Expected 'while <expr> do <expr>'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1274) - - - - - Accessibility modifiers are not permitted on an 'inherits' declaration - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:433) - - - - - Accessibility modifiers should come immediately prior to the identifier naming a construct - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:404) - - - - - 'use' bindings are not permitted in modules and are treated as 'let' bindings - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:397) - - - - - 'use' bindings are not permitted in primary constructors - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:396) - - - - - Unmatched 'with' or badly formatted 'with' block - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:420) - - - - - Incomplete value definition. If this is in an expression, the body of the expression must be indented to the same column as the 'use!' keyword. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1272) - - - - - Incomplete value definition. If this is in an expression, the body of the expression must be indented to the same column as the 'use' keyword. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1273) - - - - - Unmatched '(' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:446) - - - - - Incomplete value definition. If this is in an expression, the body of the expression must be indented to the same column as the 'let!' keyword. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1271) - - - - - Incomplete value or function definition. If this is in an expression, the body of the expression must be indented to the same column as the 'let' keyword. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1270) - - - - - Unmatched '[<'. Expected closing '>]' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1254) - - - - - Unmatched 'class', 'interface' or 'struct' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:418) - - - - - Unmatched '[|' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:462) - - - - - Unmatched '[' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:457) - - - - - Unmatched '{' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:463) - - - - - Unmatched 'begin' or 'struct' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:411) - - - - - Unmatched 'begin' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:423) - - - - - Unmatched '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:461) - - - - - Accessibility modifiers are not permitted on union cases. Use 'type U = internal ...' or 'type U = private ...' to give an accessibility to the whole representation. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:441) - - - - - Unexpected token '%s' or incomplete expression - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1311) - - - - - Accessibility modifiers are not permitted here - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:402) - - - - - Syntax error: unexpected type parameter specification - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:473) - - - - - A semicolon is not expected at this point - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:400) - - - - - Unexpected quotation operator '<@' in type definition. If you intend to pass a verbatim string as a static argument to a type provider, put a space between the '<' and '@' characters. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1140) - - - - - Unexpected infix operator in unit-of-measure expression. Legal operators are '*', '/' and '^'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:471) - - - - - Unexpected integer literal in unit-of-measure expression - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:472) - - - - - Unexpected infix operator in type expression - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:468) - - - - - Unexpected identifier: '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:440) - - - - - Unexpected end of input in 'match' or 'try' expression - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1259) - - - - - Unexpected end of input in 'while' expression. Expected 'while <expr> do <expr>'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1257) - - - - - Unexpected end of input in type signature - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1264) - - - - - Unexpected end of input in type definition - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1265) - - - - - Unexpected end of input in type arguments - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1263) - - - - - Unexpected end of input in 'try' expression. Expected 'try <expr> with <rules>' or 'try <expr> finally <expr>'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1256) - - - - - Unexpected end of input in 'then' branch of conditional expression. Expected 'if <expr> then <expr>' or 'if <expr> then <expr> else <expr>'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1260) - - - - - Unexpected end of input in object members - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1266) - - - - - Unexpected end of input in 'match' expression. Expected 'match <expr> with | <pat> -> <expr> | <pat> -> <expr> ...'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1255) - - - - - Unexpected end of input in body of lambda expression. Expected 'fun <pat> ... <pat> -> <expr>'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1262) - - - - - Unexpected end of input in 'for' expression. Expected 'for <pat> in <expr> do <expr>'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1258) - - - - - Unexpected end of input in expression - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1268) - - - - - Unexpected end of input in 'else' branch of conditional expression. Expected 'if <expr> then <expr>' or 'if <expr> then <expr> else <expr>'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1261) - - - - - Unexpected end of input in value, function or member definition - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1267) - - - - - Unexpected end of input - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:401) - - - - - Unexpected empty type moduleDefn list - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:413) - - - - - '_' cannot be used as field name - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1325) - - - - - Unclosed block - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:410) - - - - - Type name cannot be empty. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1313) - - - - - Type annotations on property getters and setters must be given after the 'get()' or 'set(v)', e.g. 'with get() : string = ...' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:426) - - - - - Accessibility modifiers are not permitted in this position for type abbreviations - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:436) - - - - - The syntax 'module ... = struct .. end' is not used in F# code. Consider using 'module ... = begin .. end' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:479) - - - - - The syntax 'module ... : sig .. end' is not used in F# code. Consider using 'module ... = begin .. end' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:480) - - - - - Syntax error in labelled type argument - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:467) - - - - - Syntax error - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:416) - - - - - Successive patterns should be separated by spaces or tupled - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:447) - - - - - Successive arguments should be separated by spaces or tupled, and arguments involving function or method applications should be parenthesized - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:456) - - - - - A setter property may have at most two argument groups - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1085) - - - - - Property setters must be defined using 'set value = ', 'set idx value = ' or 'set (idx1,...,idxN) value = ... ' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:429) - - - - - Accessibility modifiers are not permitted on record fields. Use 'type R = internal ...' or 'type R = private ...' to give an accessibility to the whole representation. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:444) - - - - - In F# code you may use 'expr.[expr]'. A type annotation may be required to indicate the first expression is an array - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:459) - - - - - At most one 'with' augmentation is permitted - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:399) - - - - - Only '#' compiler directives may occur prior to the first 'namespace' declaration - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:403) - - - - - Only class types may take value arguments - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:422) - - - - - The use of the type syntax 'int C' and 'C <int>' is not permitted here. Consider adjusting this type to be written in the form 'C<int>' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1091) - - - - - Type parameters must be placed directly adjacent to the type name, e.g. \"type C<'T>\", not type \"C <'T>\" - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1089) - - - - - Type arguments must be placed directly adjacent to the type name, e.g. \"C<'T>\", not \"C <'T>\" - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1090) - - - - - No matching 'in' found for this 'let' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:448) - - - - - No #endif found for #if or #else - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:394) - - - - - No '=' symbol should follow a 'namespace' declaration - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:478) - - - - - Files should begin with either a namespace or module declaration, e.g. 'namespace SomeNamespace.SubNamespace' or 'module SomeNamespace.SomeModule', but not both. To define a module within a namespace use 'module SomeModule = ...' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:405) - - - - - To indicate that this property can be set, use 'member val PropertyName = expr with get,set'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1288) - - - - - Property definitions may not be declared mutable. To indicate that this property can be set, use 'member val PropertyName = expr with get,set'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1287) - - - - - Multiple accessibilities given for property getter or setter - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:428) - - - - - The syntax '(typ,...,typ) ident' is not used in F# code. Consider using 'ident<typ,...,typ>' instead - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:469) - - - - - A module name must be a simple name, not a path - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:412) - - - - - A module abbreviation must be a simple name, not a path - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:406) - - - - - Expected type argument or static argument - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1138) - - - - - Missing qualification after '.' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:458) - - - - - Unmatched '<'. Expected closing '>' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1139) - - - - - Missing function body - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:466) - - - - - Mismatched quotation, beginning with '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:460) - - - - - Mismatched quotation operator name, beginning with '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:474) - - - - - This member is not permitted in an object implementation - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:465) - - - - - The declaration form 'let ... and ...' for non-recursive bindings is not used in F# code. Consider using a sequence of 'let' bindings - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:445) - - - - - Invalid property getter or setter - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1086) - - - - - Invalid operator definition. Prefix operator definitions must use a valid prefix operator name. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1110) - - - - - Invalid prefix operator - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1109) - - - - - Invalid literal in type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:470) - - - - - Invalid declaration syntax - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:424) - - - - - Interfaces always have the same visibility as the enclosing type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:430) - - - - - An integer for loop must use a simple identifier - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:398) - - - - - Accessibility modifiers are not permitted on inline assembly code types - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:439) - - - - - 'inherit' declarations cannot have 'as' bindings. To access members of the base class when overriding a method, the syntax 'base.SomeMember' may be used; 'base' is a keyword. Remove this 'as' binding. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:434) - - - - - An indexer property must be given at least one argument - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1087) - - - - - Incomplete conditional. Expected 'if <expr> then <expr>' or 'if <expr> then <expr> else <expr>'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:451) - - - - - 'in' or '=' expected - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:454) - - - - - Neither 'member val' nor 'override val' definitions are permitted in object expressions. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1323) - - - - - Denominator must not be 0 in unit-of-measure exponent - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:477) - - - - - Ignoring visibility attribute on module abbreviation. Module abbreviations are always private. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:409) - - - - - Ignoring accessibility attribute on module abbreviation. Module abbreviations are always private. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:408) - - - - - Ignoring attributes on module abbreviation - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:407) - - - - - Identifier expected - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:453) - - - - - A getter property is expected to be a function, e.g. 'get() = ...' or 'get(index) = ...' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:427) - - - - - A getter property may have at most one argument group - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1084) - - - - - 'get', 'set' or 'get,set' required - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:421) - - - - - 'get' and/or 'set' required - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:425) - - - - - Missing 'do' in 'for' expression. Expected 'for <pat> in <expr> do <expr>'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1275) - - - - - Field bindings must have the form 'id = expr;' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:464) - - - - - Expected a type after this point - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1253) - - - - - Block following this '%s' is unfinished. Expect an expression. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:450) - - - - - Unexpected end of type. Expected a name after this point. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1269) - - - - - Expected an expression after this point - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1252) - - - - - Attempted to parse this as an operator name, but failed - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1141) - - - - - Error in the return expression for this 'let'. Possible incorrect indentation. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:449) - - - - - End of file in verbatim string embedded in comment begun at or before here - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:391) - - - - - End of file in verbatim string begun at or before here - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:388) - - - - - End of file in triple-quote string embedded in comment begun at or before here - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1136) - - - - - End of file in triple-quote string begun at or before here - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1135) - - - - - End of file in string embedded in comment begun at or before here - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:390) - - - - - End of file in string begun at or before here - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:387) - - - - - End of file in IF-OCAML section begun at or before here - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:392) - - - - - End of file in #if section begun at or after here - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:386) - - - - - End of file in directive begun at or before here - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:393) - - - - - End of file in comment begun at or before here - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:389) - - - - - Accessibility modifiers are not permitted in this position for enum types - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:437) - - - - - Accessibility modifiers are not permitted on enumeration fields - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:442) - - - - - A type definition requires one or more members or other declarations. If you intend to define an empty class, struct or interface, then use 'type ... = class end', 'interface end' or 'struct end'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:419) - - - - - Accessibility modifiers are not permitted on 'do' bindings - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:385) - - - - - Consider using a separate record type instead - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:443) - - - - - Augmentations are not permitted on delegate type moduleDefns - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:417) - - - - - Attributes should be placed before 'val' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:414) - - - - - Attributes are not permitted on 'inherit' declarations - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:432) - - - - - Attributes are not allowed here - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:435) - - - - - Attributes have been ignored in this construct - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:395) - - - - - Attributes are not permitted on interface implementations - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:415) - - - - - Cannot find code target for this attribute, possibly because the code after the attribute is incomplete. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1312) - - - - - 'assert' may not be used as a first class value. Use 'assert <expr>' instead. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:452) - - - - - The use of '->' in sequence and computation expressions is limited to the form 'for pat in expr -> expr'. Use the syntax 'for ... in ... do ... yield...' to generate elements in more complex sequence expressions. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:455) - - - - - All enum fields must be given values - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:438) - - - - - Active pattern case identifiers must begin with an uppercase letter - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:475) - - - - - The '|' character is not permitted in active pattern case identifiers - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:476) - - - - - Accessibility modifiers are not allowed on this member. Abstract slots always have the same visibility as the enclosing type. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:431) - - - - - Write the xmldoc of the assembly to the given file - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:861) - - - - - Specify a Win32 resource file (.res) - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:869) - - - - - Specify a Win32 manifest file - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:870) - - - - - Report all warnings as errors - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:879) - - - - - Report specific warnings as errors - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:880) - - - - - Enable specific warnings that may be off by default - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:883) - - - - - Set a warning level (0-5) - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:881) - - - - - Output messages in UTF-8 encoding - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:890) - - - - - Enable high-entropy ASLR - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:921) - - - - - Unrecognized target '%s', expected 'exe', 'winexe', 'library' or 'module' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:900) - - - - - Unrecognized debug type '%s', expected 'pdbonly' or 'full' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:901) - - - - - Unrecognized platform '%s', valid values are 'x86', 'x64', 'Itanium', 'anycpu32bitpreferred', and 'anycpu' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:915) - - - - - Unknown --test argument: '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:914) - - - - - Specify target framework profile of this assembly. Valid values are mscorlib or netcore. Default - mscorlib - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:923) - - - - - Enable or disable tailcalls - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:877) - - - - - Specify subsystem version of this assembly - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:922) - - - - - Specify a strong name key file - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:862) - - - - - Specify a strong name key container - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:863) - - - - - Statically link the given assembly and all referenced DLLs that depend on this assembly. Use an assembly name e.g. mylib, not a DLL name. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:896) - - - - - Statically link the F# library and all referenced DLLs that depend on it into the assembly being generated - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:895) - - - - - Resolve assembly references using directory-based rules rather than MSBuild resolution - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:899) - - - - - Print the inferred interface of the assembly to a file - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:867) - - - - - Short form of '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:903) - - - - - Embed the specified managed resource - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:872) - - - - - Use a resident background compilation service to improve compiler startup times. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:897) - - - - - Reference an assembly (Short form: -r) - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:868) - - - - - Problem with codepage '%d': %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:853) - - - - - Limit which platforms this code can run on: x86, Itanium, x64, anycpu32bitpreferred, or anycpu. The default is anycpu. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:864) - - - - - Name the output debug file - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:898) - - - - - Enable optimizations (Short form: -O) - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:876) - - - - - Do not include the default Win32 manifest - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:871) - - - - - Disable specific warning messages - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:882) - - - - - Suppress compiler copyright message - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:887) - - - - - Do not reference the default CLI assemblies by default - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:894) - - - - - Only include optimization information essential for implementing inlined constructs. Inhibits cross-module inlining but improves binary compatibility. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:865) - - - - - Don't add a resource to the generated assembly containing F#-specific metadata - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:866) - - - - - Name of the output file (Short form: -o) - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:855) - - - - - Ignore ML compatibility warnings - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:886) - - - - - Link the specified resource to this assembly where the resinfo format is <file>[,<string name>[,public|private]] - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:873) - - - - - Specify a directory for the include path which is used to resolve source files and assemblies (Short form: -I) - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:892) - - - - - Invalid warning level '%d' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:902) - - - - - Invalid value '%s' for '--targetprofile', valid values are 'mscorlib' or 'netcore'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:926) - - - - - Invalid version '%s' for '--subsystemversion'. The version must be 4.00 or greater. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:925) - - - - - The command-line option '%s' is for test purposes only - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:916) - - - - - - RESOURCES - - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:908) - - - - - - OUTPUT FILES - - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:906) - - - - - - MISCELLANEOUS - - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:911) - - - - - - LANGUAGE - - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:912) - - - - - - INPUT FILES - - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:907) - - - - - - ERRORS AND WARNINGS - - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:913) - - - - - - CODE GENERATION - - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:909) - - - - - - ADVANCED - - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:910) - - - - - Display this usage message (Short form: -?) - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:888) - - - - - Output messages with fully qualified paths - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:891) - - - - - Emit debug information in quotations - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:924) - - - - - Delay-sign the assembly using only the public portion of the strong name key - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:860) - - - - - Define conditional compilation symbols (Short form: -d) - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:885) - - - - - Emit debug information (Short form: -g) - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:874) - - - - - Specify debugging type: full, pdbonly. ('full' is the default and enables attaching a debugger to a running program). - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:875) - - - - - The command-line option '%s' has been deprecated - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:917) - - - - - The command-line option '%s' has been deprecated. HTML document generation is now part of the F# Power Pack, via the tool FsHtmlDoc.exe. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:919) - - - - - The command-line option '%s' has been deprecated. Use '%s' instead. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:918) - - - - - Enable or disable cross-module optimizations - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:878) - - - - - Freely distributed under the Apache 2.0 Open Source License - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:854) - - - - - Output warning and error messages in color - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:920) - - - - - Specify the codepage used to read source files - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:889) - - - - - Use to override where the compiler looks for mscorlib.dll and framework components - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:905) - - - - - The command-line option '--cliroot' has been deprecated. Use an explicit reference to a specific copy of mscorlib.dll instead. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:904) - - - - - Generate overflow checks - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:884) - - - - - Build a Windows executable - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:857) - - - - - Build a module that can be added to another assembly - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:859) - - - - - Build a library (Short form: -a) - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:858) - - - - - Build a console executable - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:856) - - - - - Base address for the library to be built - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:893) - - - - - A value marked as 'inline' has an unexpected value - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1001) - - - - - A value marked as 'inline' could not be inlined - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1002) - - - - - The value '%s' was marked inline but was not bound in the optimization environment - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:999) - - - - - The value '%s' was marked inline but its implementation makes use of an internal or private function which is not sufficiently accessible - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:998) - - - - - Recursive ValValue %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1004) - - - - - Local value %s not found during optimization - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1000) - - - - - Failed to inline the value '%s' marked 'inline', perhaps because a recursive value was marked 'inline' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1003) - - - - - The union type for union case '%s' was defined with the RequireQualifiedAccessAttribute. Include the name of the union type ('%s') in the name you are using. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1024) - - - - - Unexpected empty long identifier - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1019) - - - - - Multiple types exist called '%s', taking different numbers of generic parameters. Provide a type instantiation to disambiguate the type resolution, e.g. '%s'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1015) - - - - - The instantiation of the generic type '%s' is missing and can't be inferred from the arguments or return type of this member. Consider providing a type instantiation when accessing this type, e.g. '%s'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1016) - - - - - The type '%s' does not contain a field '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1020) - - - - - The record type for the record field '%s' was defined with the RequireQualifiedAccessAttribute. Include the name of the record type ('%s') in the name you are using. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1025) - - - - - No constructors are available for the type '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1023) - - - - - This is not a constructor or literal, or a constructor is being used incorrectly - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1018) - - - - - Invalid module/expression/type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1014) - - - - - Invalid field label - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1021) - - - - - Invalid expression '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1022) - - - - - 'global' may only be used as the first name in a qualified path - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1017) - - - - - No Invoke methods found for delegate type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:969) - - - - - + %d overloads - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1309) - - - - - + 1 overload - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1308) - - - - - More than one Invoke method found for delegate type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:970) - - - - - This construct is for ML compatibility. %s. You can disable this warning by using '--mlcompatibility' or '--nowarn:62'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1105) - - - - - Infix operator member '%s' has %d initial argument(s). Expected a tuple of 3 arguments - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1320) - - - - - Infix operator member '%s' has %d initial argument(s). Expected a tuple of 2 arguments, e.g. static member (+) (x,y) = ... - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1070) - - - - - Infix operator member '%s' has no arguments. Expected a tuple of 2 arguments, e.g. static member (+) (x,y) = ... - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1069) - - - - - Infix operator member '%s' has extra curried arguments. Expected a tuple of 2 arguments, e.g. static member (+) (x,y) = ... - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1071) - - - - - (loading description...) - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1316) - - - - - Identifiers containing '@' are reserved for use in F# code generation - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:980) - - - - - The identifier '%s' is reserved for future use by F# - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:981) - - - - - Possible incorrect indentation: this token is offside of context started at position %s. Try indenting this token further or using standard formatting conventions. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1009) - - - - - The '|' tokens separating rules of this pattern match are misaligned by one column. Consider realigning your code or using further indentation. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1010) - - - - - The indentation of this 'in' token is incorrect with respect to the corresponding 'let' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1008) - - - - - Syntax error. Wrong nested #endif, unexpected tokens before it. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1066) - - - - - Unexpected character '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1035) - - - - - This token is reserved for future use - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1056) - - - - - This Unicode encoding is only valid in string literals - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1055) - - - - - TABs are not allowed in F# code unless the #indent \"off\" option is used - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1057) - - - - - This number is outside the allowable range for 32-bit unsigned integers - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1044) - - - - - This number is outside the allowable range for 32-bit signed integers - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1043) - - - - - This number is outside the allowable range for 64-bit unsigned integers - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1046) - - - - - This number is outside the allowable range for 64-bit signed integers - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1045) - - - - - This number is outside the allowable range for 16-bit unsigned integers - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1042) - - - - - This number is outside the allowable range for 16-bit signed integers - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1041) - - - - - This number is outside the allowable range for unsigned native integers - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1048) - - - - - This number is outside the allowable range for signed native integers - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1047) - - - - - This number is outside the allowable range for this integer type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1033) - - - - - This number is outside the allowable range for 8-bit unsigned integers - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1040) - - - - - This number is outside the allowable range for hexadecimal 8-bit signed integers - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1039) - - - - - This number is outside the allowable range for 8-bit signed integers - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1038) - - - - - This number is outside the allowable range for 32-bit floats - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1051) - - - - - This number is outside the allowable range for decimal literals - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1050) - - - - - \U%s is not a valid Unicode character escape sequence - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1142) - - - - - This is not a valid numeric literal. Sample formats include 4, 0x4, 0b0100, 4L, 4UL, 4u, 4s, 4us, 4y, 4uy, 4.0, 4.0f, 4I. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1052) - - - - - Invalid line number: '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1058) - - - - - Invalid floating point number - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1049) - - - - - This is not a valid character literal - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1054) - - - - - This is not a valid byte literal - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1053) - - - - - Consider using a file with extension '.ml' or '.mli' instead - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1112) - - - - - Identifiers followed by '%s' are reserved for future use - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1037) - - - - - #if directive should be immediately followed by an identifier - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1065) - - - - - #if directive must appear as the first non-whitespace character on a line - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1059) - - - - - #endif has no matching #if - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1063) - - - - - #endif required for #else - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1061) - - - - - #endif directive must appear as the first non-whitespace character on a line - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1064) - - - - - #else has no matching #if - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1060) - - - - - #else directive must appear as the first non-whitespace character on a line - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1062) - - - - - #! may only appear as the first line at the start of a file. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1067) - - - - - '%s' is not permitted as a character in operator names and is reserved for future use - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1034) - - - - - This byte array literal contains characters that do not encode as a single byte - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1036) - - - - - The 'anycpu32bitpreferred' platform flag may only be used with .NET Framework versions 4.5 and greater. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1306) - - - - - The 'anycpu32bitpreferred' platform can only be used with EXE targets. You must use 'anycpu' instead. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1302) - - - - - invalid namespace for provided type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1208) - - - - - invalid full name for provided type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1209) - - - - - Invalid provided literal value '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1301) - - - - - The type '%s' is required here and is unavailable. You must add a reference to assembly '%s'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:990) - - - - - A reference to the type '%s' in assembly '%s' was found, but the type could not be found in that assembly - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:991) - - - - - A reference to the DLL %s is required by assembly %s. The imported type %s is located in the first assembly and could not be resolved. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:993) - - - - - Internal error or badly formed metadata: not enough type parameters were in scope while importing - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:992) - - - - - Invalid number of generic arguments to type '%s' in provided type. Expected '%d' arguments, given '%d'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1278) - - - - - Invalid value unit-of-measure parameter '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1280) - - - - - Invalid value '%s' for unit-of-measure parameter '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1279) - - - - - An imported assembly uses the type '%s' but that type is not public - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:994) - - - - - Invalid argument to 'methodhandleof' during codegen - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1240) - - - - - MDB generation failed. Could not find compatible member %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1121) - - - - - The name of the MDB file must be <assembly-file-name>.mdb. The --pdb option will be ignored. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1120) - - - - - Unexpected error creating debug information file '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1029) - - - - - Cannot generate MDB debug information. Failed to load the 'MonoSymbolWriter' type from the 'Mono.CompilerServices.SymbolWriter.dll' assembly. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1122) - - - - - Compiler error: unexpected unrealized value - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:842) - - - - - Unexpected GetSet annotation on a property - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:845) - - - - - Undefined value '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:829) - - - - - This type cannot be used for a literal field - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:844) - - - - - The StructLayout attribute could not be decoded - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:847) - - - - - GenSetStorage: %s was represented as a static method but was not an appropriate lambda expression - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:840) - - - - - The signature for this external function contains type parameters. Constrain the argument and return types to indicate the types of the corresponding C function. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:837) - - - - - Reflected definitions cannot contain uses of the prefix splice operator '%%' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:849) - - - - - Mutable variables cannot escape their method - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:841) - - - - - The MarshalAs attribute could not be decoded - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:836) - - - - - Main module of program is empty: nothing will happen when it is run - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:843) - - - - - Literal fields cannot be set - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:839) - - - - - Label %s not found - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:830) - - - - - Incorrect number of type arguments to local call - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:831) - - - - - The FieldOffset attribute could not be decoded - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:846) - - - - - The FieldOffset attribute can only be placed on members of types marked with the StructLayout(LayoutKind.Explicit) - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1115) - - - - - The type '%s' has been marked as having an Explicit layout, but the field '%s' has not been marked with the 'FieldOffset' attribute - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1107) - - - - - Dynamic invocation of %s is not supported - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:832) - - - - - The DllImport attribute could not be decoded - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:838) - - - - - The DefaultAugmentation attribute could not be decoded - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:848) - - - - - Custom marshallers cannot be specified in F# code. Consider using a C# helper function. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:835) - - - - - This operation involves taking the address of a value '%s' represented using a local variable or other special representation. This is invalid. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:834) - - - - - Taking the address of a literal field is invalid - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:833) - - - - - If set to true, then all error messages will just return the filled 'holes' delimited by ',,,'s - this is for language-neutral testing (e.g. localization-invariant baselines). - - - - - Conflicting options specified: 'win32manifest' and 'win32res'. Only one of these can be used. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1148) - - - - - Exiting - too many errors - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1144) - - - - - System.Runtime.InteropServices assembly is required to use UnknownWrapper\DispatchWrapper classes. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1335) - - - - - Static linking may not use assembly that targets different profile. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1167) - - - - - Static linking may not include a mixed managed/unmanaged DLL - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1152) - - - - - Static linking may not include a .EXE - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1151) - - - - - Passing a .resx file (%s) as a source file to the compiler is deprecated. Use resgen.exe to transform the .resx file into a .resources file to pass as a --resource option. If you are using MSBuild, this can be done via an <EmbeddedResource> item in the .fsproj project file. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1166) - - - - - The resident compilation service was not used because a problem occured in communicating with the server. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1164) - - - - - The assembly '%s' is listed on the command line. Assemblies should be referenced using a command line flag such as '-r'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1163) - - - - - Code in this assembly makes uses of quotation literals. Static linking may not include components that make use of quotation literals unless all assemblies are compiled with at least F# 4.0. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1150) - - - - - The code in assembly '%s' makes uses of quotation literals. Static linking may not include components that make use of quotation literals unless all assemblies are compiled with at least F# 4.0. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1149) - - - - - A problem occurred writing the binary '%s': %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1157) - - - - - No implementation files specified - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1146) - - - - - Option '--keycontainer' overrides attribute 'System.Reflection.AssemblyNameAttribute' given in a source file or added module - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1162) - - - - - Option '--keyfile' overrides attribute 'System.Reflection.AssemblyKeyFileAttribute' given in a source file or added module - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1161) - - - - - The key file '%s' could not be opened - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1156) - - - - - Ignoring mixed managed/unmanaged assembly '%s' during static linking - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1153) - - - - - Option '--delaysign' overrides attribute 'System.Reflection.AssemblyDelaySignAttribute' given in a source file or added module - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1160) - - - - - An %s specified version '%s', but this value is invalid and has been ignored - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1147) - - - - - Assembly '%s' was referenced transitively and the assembly could not be resolved automatically. Static linking will assume this DLL has no dependencies on the F# library or other statically linked DLLs. Consider adding an explicit reference to this DLL. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1154) - - - - - The 'AssemblyVersionAttribute' has been ignored because a version was given using a command line option - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1158) - - - - - Assembly '%s' not found in dependency set of target binary. Statically linked roots should be specified using an assembly name, without a DLL or EXE extension. If this assembly was referenced explicitly then it is possible the assembly was not actually required by the generated binary, in which case it should not be statically linked. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1155) - - - - - Error emitting 'System.Reflection.AssemblyCultureAttribute' attribute -- 'Executables cannot be satellite assemblies, Culture should always be empty' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1159) - - - - - Prefix flag (' ' or '+') set twice - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:230) - - - - - Precision missing after the '.' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:235) - - - - - Positional specifiers are not permitted in format strings - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:227) - - - - - Missing format specifier - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:228) - - - - - The 'l' or 'L' in this format specifier is unnecessary. In F# code you can use %%d, %%x, %%o or %%u instead, which are overloaded to work with all basic integer types. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:238) - - - - - The # formatting modifier is invalid in F# - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:231) - - - - - The 'h' or 'H' in this format specifier is unnecessary. You can use %%d, %%x, %%o or %%u instead, which are overloaded to work with all basic integer types.. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:239) - - - - - '%s' format does not support precision - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:236) - - - - - '%s' flag set twice - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:229) - - - - - '%s' format does not support '0' flag - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:234) - - - - - '%s' does not support prefix '%s' flag - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:240) - - - - - Bad width in format specifier - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:233) - - - - - Bad precision in format specifier - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:232) - - - - - Bad format specifier: '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:241) - - - - - Bad format specifier (after l or L): Expected ld,li,lo,lu,lx or lX. In F# code you can use %%d, %%x, %%o or %%u instead, which are overloaded to work with all basic integer types. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:237) - - - - - The record, struct or class field '%s' is not accessible from this code location - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:966) - - - - - This construct is experimental - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:968) - - - - - The event '%s' has a non-standard type. If this event is declared in another CLI language, you may need to access this event using the explicit %s and %s methods for the event. If this event is declared in F#, make the type of the event an instantiation of either 'IDelegateEvent<_>' or 'IEvent<_,_>'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:961) - - - - - Unsupported expression '%s' from type provider. If you are the author of this type provider, consider adjusting it to provide a different provided expression. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1190) - - - - - Invalid member '%s' on provided type '%s'. Only properties, methods and constructors are allowed - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1182) - - - - - Unsupported constant type '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1189) - - - - - Unknown static argument kind '%s' when resolving a reference to a provided type or method '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1207) - - - - - Unexpected 'null' return value from provided type '%s' member '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1202) - - - - - Unexpected exception from provided type '%s' member '%s': %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1188) - - - - - Unexpected exception from member '%s' of provided type '%s' member '%s': %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1203) - - - - - The type provider constructor has thrown an exception: %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1212) - - - - - Too many static parameters. Expected at most %d parameters, but got %d unnamed and %d named parameters. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1300) - - - - - The static parameter '%s' of the provided type or method '%s' requires a value. Static parameters to type providers may be optionally specified using named arguments, e.g. '%s<%s=...>'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1232) - - - - - The static parameter '%s' has already been given a value - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1234) - - - - - The type provider returned 'null', which is not a valid return value from '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1211) - - - - - Assembly attribute '%s' refers to a designer assembly '%s' which cannot be loaded or doesn't exist. %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1194) - - - - - The type provider '%s' reported an error in the context of provided type '%s', member '%s'. The error: %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1225) - - - - - The type provider '%s' reported an error: %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1196) - - - - - The type provider does not have a valid constructor. A constructor taking either no arguments or one argument of type 'TypeProviderConfig' was expected. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1195) - - - - - The '%s' of a provided type was null or empty. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1227) - - - - - An exception occurred when accessing the '%s' of a provided type: %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1226) - - - - - A reference to a provided type was missing a value for the static parameter '%s'. You may need to recompile one or more referenced assemblies. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1241) - - - - - A reference to a provided type had an invalid value '%s' for a static parameter. You may need to recompile one or more referenced assemblies. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1242) - - - - - Expected provided type with path '%s' but provided type has path '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1201) - - - - - Expected provided type named '%s' but provided type has 'Name' with value '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1191) - - - - - The type provider '%s' returned an invalid type from 'ApplyStaticArguments'. A type with name '%s' was expected, but a type with name '%s' was returned. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1214) - - - - - The type provider '%s' returned an invalid method from 'ApplyStaticArgumentsForMethod'. A method with name '%s' was expected, but a method with name '%s' was returned. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1215) - - - - - Property '%s' on provided type '%s' is neither readable nor writable as it has CanRead=false and CanWrite=false - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1281) - - - - - Property '%s' on provided type '%s' has CanWrite=false but GetSetMethod() returned a method - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1186) - - - - - Property '%s' on provided type '%s' has CanRead=false but GetGetMethod() returned a method - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1184) - - - - - Property '%s' on provided type '%s' has CanWrite=true but there was no value from GetSetMethod() - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1185) - - - - - Property '%s' on provided type '%s' has CanRead=true but there was no value from GetGetMethod() - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1183) - - - - - One or more errors seen during provided type setup - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1187) - - - - - Type provider '%s' returned null from GetInvokerExpression. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1213) - - - - - The provided type '%s' returned a member with a null or empty member name - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1172) - - - - - The provided type '%s' has member '%s' which has declaring type '%s'. Expected declaring type to be the same as provided type. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1175) - - - - - The provided type '%s' member info '%s' has null declaring type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1174) - - - - - The provided type '%s' returned a null member - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1173) - - - - - No static parameter exists with name '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1233) - - - - - Nested provided types do not take static arguments or generic parameters - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1204) - - - - - Provided type '%s' has 'IsGenericType' as true, but generic types are not supported. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1179) - - - - - Provided type '%s' has 'IsArray' as true, but array types are not supported. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1180) - - - - - Multiple static parameters exist with name '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1235) - - - - - Invalid member '%s' on provided type '%s'. Provided type members must be public, and not be generic, virtual, or abstract. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1181) - - - - - Assembly '%s' hase TypeProviderAssembly attribute with invalid value '%s'. The value should be a valid assembly name - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1220) - - - - - Invalid static argument to provided type. Expected an argument of kind '%s'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1205) - - - - - The type provider '%s' provided a method with a name '%s' and metadata token '%d', which is not reported among its methods of its declaring type '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1198) - - - - - The type provider '%s' provided a constructor which is not reported among the constructors of its declaring type '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1199) - - - - - The type provider '%s' used an invalid parameter in the ParameterExpression: %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1197) - - - - - Character '%s' is not allowed in provided type name '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1228) - - - - - Character '%s' is not allowed in provided namespace name '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1171) - - - - - Referenced assembly '%s' has assembly level attribute '%s' but no public type provider classes were found - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1176) - - - - - Event '%s' on provided type '%s' has no value from GetRemoveMethod() - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1193) - - - - - Event '%s' on provided type '%s' has no value from GetAddMethod() - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1192) - - - - - An error occured applying the static arguments to a provided type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1206) - - - - - An error occured applying the static arguments to a provided method - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1338) - - - - - The provider '%s' returned a non-generated type '%s' in the context of a set of generated types. Consider adjusting the type provider to only return generated types. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1304) - - - - - Type '%s' from type provider '%s' has an empty namespace. Use 'null' for the global namespace. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1177) - - - - - Empty namespace found from the type provider '%s'. Use 'null' for the global namespace. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1178) - - - - - A direct reference to the generated type '%s' is not permitted. Instead, use a type definition, e.g. 'type TypeAlias = <path>'. This indicates that a type provider adds generated types to your assembly. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1200) - - - - - Named static arguments must come after all unnamed static arguments - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1231) - - - - - A type provider implemented GetStaticParametersForMethod, but ApplyStaticArgumentsForMethod was not implemented or invalid - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1337) - - - - - Erased to - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1310) - - - - - System.Environment.Exit did not exit - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:245) - - - - - The treatment of this operator is now handled directly by the F# compiler and its meaning cannot be redefined - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:246) - - - - - The documentation file has no .xml suffix - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1145) - - - - - (description unavailable...) - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1317) - - - - - Delegates are not allowed to have curried signatures - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:971) - - - - - %s var in collection - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1247) - - - - - %s var in collection %s (outerKey = innerKey). Note that parentheses are required after '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1245) - - - - - %s var in collection %s (outerKey = innerKey) into group. Note that parentheses are required after '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1246) - - - - - None of the types '%s' support the operator '%s'. Consider opening the module 'Microsoft.FSharp.Linq.NullableOperators'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:327) - - - - - None of the types '%s' support the operator '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:325) - - - - - This type parameter cannot be instantiated to 'Nullable'. This is a restriction imposed in order to ensure the meaning of 'null' in some CLI languages is not confusing when used in conjunction with 'Nullable' values. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:344) - - - - - The type '%s' is not compatible with any of the types %s, arising from the use of a printf-style format string - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:347) - - - - - The type '%s' is not a CLI enum type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:341) - - - - - The type '%s' is not a CLI delegate type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:343) - - - - - Type instantiation length mismatch - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:351) - - - - - Type inference problem too complicated (maximum iteration depth reached). Consider adding further type annotations. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:320) - - - - - The type '%s' has a non-standard delegate type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:342) - - - - - The type '%s' does not support the operator '%s'. Consider opening the module 'Microsoft.FSharp.Linq.NullableOperators'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:328) - - - - - The type '%s' does not support the operator '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:326) - - - - - The type '%s' does not support the 'equality' constraint because it is a record, union or struct with one or more structural element types which do not support the 'equality' constraint. Either avoid the use of equality with this type, or add the 'StructuralEquality' attribute to the type to determine which field type does not support equality - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:340) - - - - - The type '%s' does not support the 'equality' constraint because it is a function type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:339) - - - - - The type '%s' does not support the 'equality' constraint because it has the 'NoEquality' attribute - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:338) - - - - - The type '%s' does not support a conversion to the type '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:329) - - - - - The type '%s' does not support the 'comparison' constraint because it is a record, union or struct with one or more structural element types which do not support the 'comparison' constraint. Either avoid the use of comparison with this type, or add the 'StructuralComparison' attribute to the type to determine which field type does not support comparison - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:337) - - - - - The type '%s' does not support the 'comparison' constraint. For example, it does not support the 'System.IComparable' interface - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:336) - - - - - The type '%s' does not support the 'comparison' constraint because it has the 'NoComparison' attribute - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:335) - - - - - The type '%s' does not have 'null' as a proper value - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:333) - - - - - The declared type parameter '%s' cannot be used here since the type parameter cannot be resolved at compile time - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:318) - - - - - The constraints 'struct' and 'not struct' are inconsistent - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:332) - - - - - The available overloads are shown below (or in the Error List window). - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:381) - - - - - The required signature is %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:363) - - - - - Optional arguments not permitted here - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:352) - - - - - The type '%s' does not have 'null' as a proper value. To create a null value for a Nullable type use 'System.Nullable()'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:334) - - - - - No overloads match for method '%s'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:378) - - - - - No %s member or object constructor named '%s' takes %d arguments. The named argument '%s' doesn't correspond to any argument or settable return property for any overload. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:376) - - - - - No %s member or object constructor named '%s' takes %d arguments. Note the call to this member also provides %d named arguments. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:375) - - - - - No %s member or object constructor named '%s' takes %d arguments - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:374) - - - - - Method or object constructor '%s' not found - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:377) - - - - - A unique overload for method '%s' could not be determined based on type information prior to this program point. A type annotation may be needed. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:379) - - - - - %s is not an instance method - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:361) - - - - - %s is not a static method - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:360) - - - - - The type '%s' has a method '%s' (full name '%s'), but the method is static - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:330) - - - - - The type '%s' has a method '%s' (full name '%s'), but the method is not static - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:331) - - - - - This method expects a CLI 'params' parameter in this position. 'params' is a way of passing a variable number of arguments to a method in languages such as C#. Consider passing an array for this argument - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:357) - - - - - The member or object constructor '%s' takes %d type argument(s) but is here given %d. The required signature is '%s'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:370) - - - - - The member or object constructor '%s' requires %d argument(s) but is here given %d unnamed and %d named argument(s). The required signature is '%s'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:368) - - - - - The member or object constructor '%s' takes %d argument(s) but is here given %d. The required signature is '%s'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:369) - - - - - The member or object constructor '%s' requires %d additional argument(s). The required signature is '%s'. Some names for missing arguments are %s. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:367) - - - - - The member or object constructor '%s' requires %d argument(s). The required signature is '%s'. Some names for missing arguments are %s. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:366) - - - - - The member or object constructor '%s' requires %d additional argument(s). The required signature is '%s'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:365) - - - - - The member or object constructor '%s' requires %d argument(s). The required signature is '%s'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:364) - - - - - The member or object constructor '%s' does not take %d argument(s). An overload was found taking %d arguments. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:373) - - - - - The member or object constructor '%s' taking %d arguments are not accessible from this code location. All accessible versions of method '%s' take %d arguments. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:371) - - - - - %s is not a static member - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:353) - - - - - %s is not an instance member - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:354) - - - - - The member or object constructor '%s' is not %s. Private members may only be accessed from within the declaring type. Protected members may only be accessed from an extending type and cannot be accessed from inner lambda expressions. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:359) - - - - - The member or object constructor '%s' is not %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:358) - - - - - The member or object constructor '%s' has no argument or settable return property '%s'. %s. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:362) - - - - - This indexer expects %d arguments but is here given %d - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:322) - - - - - Incorrect generic instantiation. No %s member named '%s' takes %d generic arguments. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:372) - - - - - A generic construct requires that the type '%s' is an unmanaged type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:346) - - - - - A generic construct requires that the type '%s' is a CLI or F# struct type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:345) - - - - - A generic construct requires that the type '%s' have reference semantics, but it does not, i.e. it is a struct - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:348) - - - - - A generic construct requires that the type '%s' have a public default constructor - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:350) - - - - - A generic construct requires that the type '%s' be non-abstract - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:349) - - - - - Expected arguments to an instance member - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:321) - - - - - Expecting a type supporting the operator '%s' but given a tuple type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:324) - - - - - Expecting a type supporting the operator '%s' but given a function type. You may be missing an argument to a function. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:323) - - - - - This code is less generic than indicated by its annotations. A unit-of-measure specified using '_' has been determined to be '1', i.e. dimensionless. Consider making the code generic, or removing the use of '_'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:319) - - - - - Candidates: %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:380) - - - - - The argument types don't match - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:356) - - - - - Argument length mismatch - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:355) - - - - - Quotations cannot contain expressions that set union case fields - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:307) - - - - - Quotations cannot contain expressions that set fields in exception values - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:308) - - - - - Quotations cannot contain expressions that require byref pointers - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:309) - - - - - Quotations cannot contain expressions that fetch union case indexes - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:306) - - - - - Quotations cannot contain this kind of type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:314) - - - - - Quotations cannot contain this kind of pattern match - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:312) - - - - - Quotations cannot contain this kind of constant - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:311) - - - - - Quotations cannot contain expressions that fetch static fields - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:303) - - - - - Quotations cannot contain object expressions - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:301) - - - - - Quotations cannot contain inline assembly code or pattern matching on arrays - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:304) - - - - - Quotations cannot contain function definitions that are inferred or declared to be generic. Consider adding some type constraints to make this a valid quoted expression. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:300) - - - - - Quotations cannot contain uses of generic expressions - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:299) - - - - - Quotations cannot contain descending for loops - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:305) - - - - - Quotations cannot contain array pattern matching - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:313) - - - - - Quotations cannot contain expressions that take the address of a field - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:302) - - - - - Quotations cannot contain expressions that make member constraint calls, or uses of operators that implicitly resolve to a member constraint call - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:310) - - - - - A quotation may not involve an assignment to or taking the address of a captured local variable - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1307) - - - - - Inner generic functions are not permitted in quoted expressions. Consider adding some type constraints until this function is no longer generic. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1133) - - - - - The variable '%s' is bound in a quotation but is used as part of a spliced expression. This is not permitted since it may escape its scope. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:298) - - - - - The variable '%s' is used in an invalid way - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:253) - - - - - The type of a field using the 'DefaultValue' attribute must admit default initialization, i.e. have 'null' as a proper value or be a struct type whose fields all admit default initialization. You can use 'DefaultValue(false)' to disable this check - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:293) - - - - - The value '%s' is unused - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1082) - - - - - The recursive object reference '%s' is unused. The presence of a recursive object reference adds runtime initialization checks to members in this and derived types. Consider removing this recursive object reference. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1083) - - - - - default augmentation of the union case - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:278) - - - - - compiled form of the union case - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:277) - - - - - The type '%s' is less accessible than the value, member or type '%s' it is used in - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:254) - - - - - A type variable has been constrained by multiple different class types. A type variable may only have one class constraint. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1318) - - - - - 'System.Void' can only be used as 'typeof<System.Void>' in F# - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:255) - - - - - Expression-splicing operators may only be used within quotations - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:258) - - - - - A method return type would contain byrefs which is not permitted - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:270) - - - - - [<ReflectedDefinition>] terms cannot contain uses of the prefix splice operator '%%' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:275) - - - - - A protected member is called or 'base' is being used. This is only allowed in the direct implementation of members since they could escape their object scope. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:250) - - - - - Name clash. The property '%s' has the same name as a method in this type. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:279) - - - - - The property '%s' has the same name as another property in this type, but one takes indexer arguments and the other does not. You may be missing an indexer argument to one of your properties. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:281) - - - - - Object constructors cannot directly use try/with and try/finally prior to the initialization of the object. This includes constructs such as 'for x in ...' that may elaborate to uses of these constructs. This is a limitation imposed by Common IL. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:264) - - - - - ReflectedDefinitionAttribute may not be applied to an instance member on a struct type, because the instance member takes an implicit 'this' byref parameter - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1124) - - - - - First-class uses of the expression-splicing operator are not permitted - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:259) - - - - - First-class uses of the 'reraise' function is not permitted - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:261) - - - - - First-class uses of the address-of operators are not permitted - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:260) - - - - - Type '%s' is illegal because in byref<T>, T cannot contain byref types. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1289) - - - - - The type abbreviation contains byrefs. This is not permitted by F#. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:294) - - - - - The byref typed value '%s' cannot be used at this point - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:262) - - - - - A byref typed value would be stored here. Top-level let-bound byref values are not permitted. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:274) - - - - - The address of the static field '%s' cannot be used at this point - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:266) - - - - - The address of the variable '%s' cannot be used at this point - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:265) - - - - - The address of an array element cannot be used at this point - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:268) - - - - - The address of the field '%s' cannot be used at this point - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:267) - - - - - This type implements the same interface at different generic instantiations '%s' and '%s'. This is not permitted in this version of F#. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:292) - - - - - The member '%s' is used in an invalid way. A use of '%s' has been inferred prior to its definition at or near '%s'. This is an invalid forward reference. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:273) - - - - - 'base' values may only be used to make direct calls to the base implementations of overridden members - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:263) - - - - - Invalid custom attribute value (not a constant or literal) - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:271) - - - - - The property '%s' has a getter and a setter that do not match. If one is abstract then the other must be as well. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:280) - - - - - A property's getter and setter must have the same type. Property '%s' has getter of type '%s' but setter of type '%s'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1327) - - - - - The type of a first-class function cannot contain byrefs - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:269) - - - - - A type instantiation involves a byref type. This is not permitted by the rules of Common IL. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:256) - - - - - Calls to 'reraise' may only occur directly in a handler of a try-with - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:257) - - - - - A function labeled with the 'EntryPointAttribute' attribute must be the last declaration in the last file in the compilation sequence, and can only be used when compiling to a .exe - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:276) - - - - - Duplicate property. The property '%s' has the same name and signature as another property in this type once tuples, functions, units of measure and/or provided types are erased. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:289) - - - - - Duplicate property. The property '%s' has the same name and signature as another property in this type. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:288) - - - - - Duplicate method. The method '%s' has the same name and signature as another method in this type once tuples, functions, units of measure and/or provided types are erased. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:285) - - - - - Duplicate method. The abstract method '%s' has the same name and signature as an abstract method in an inherited type once tuples, functions, units of measure and/or provided types are erased. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:291) - - - - - Duplicate method. The abstract method '%s' has the same name and signature as an abstract method in an inherited type. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:290) - - - - - The method '%s' has curried arguments but has the same name as another method in this type. Methods with curried arguments cannot be overloaded. Consider using a method taking tupled arguments. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:286) - - - - - Duplicate method. The method '%s' has the same name and signature as another method in this type. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:284) - - - - - Methods with curried arguments cannot declare 'out', 'ParamArray', 'optional', 'ReflectedDefinition' or 'byref' arguments - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:287) - - - - - A type would store a byref typed value. This is not permitted by Common IL. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:282) - - - - - The byref-typed variable '%s' is used in an invalid way. Byrefs cannot be captured by closures or passed to inner functions. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:251) - - - - - The 'base' keyword is used in an invalid way. Base calls cannot be used in closures. Consider using a private member to make base calls. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:252) - - - - - The attribute type '%s' has 'AllowMultiple=false'. Multiple instances of this attribute cannot be attached to a single language element. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:272) - - - - - Redundant arguments are being ignored in function '%s'. Expected %d but got %d arguments. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1346) - - - - - Type inference caused an inference type variable to escape its scope. Consider adding type annotations to make your code less generic. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1345) - - - - - Type inference caused the type variable %s to escape its scope. Consider adding an explicit type parameter declaration or adjusting your code to be less generic. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1344) - - - - - Lowercase literal '%s' is being shadowed by a new pattern with the same name. Only uppercase and module-prefixed literals can be used as named patterns. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1347) - - - - - The operator '%s' cannot be resolved. Consider opening the module 'Microsoft.FSharp.Linq.NullableOperators'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1321) - - - - - Unrecognized option: '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:59) - - - - - The non-generic type '%s' does not expect any type arguments, but here is given %d type argument(s) - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:17) - - - - - Filename '%s' contains invalid character '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1131) - - - - - The signature file '%s' does not have a corresponding implementation file. If an implementation file exists then check the 'module' and 'namespace' declarations in the signature and implementation files match. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:56) - - - - - A signature for the file or module '%s' has already been specified - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:53) - - - - - The search directory '%s' could not be found - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:27) - - - - - The file '%s' is a CLI 1.x version of mscorlib. F# requires CLI version 2.0 or greater. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:32) - - - - - F# Compiler for F# 4.0 %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:21) - - - - - Problem with filename '%s': %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:22) - - - - - Problem reading assembly '%s': %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1314) - - - - - The '--pdb' option requires the '--debug' option to be used - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:25) - - - - - Option requires parameter: %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:41) - - - - - No inputs specified - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:23) - - - - - This file contains multiple declarations of the form 'module SomeNamespace.SomeModule'. Only one declaration of this form is permitted in a file. Change your file to use an initial namespace declaration and/or use 'module ModuleName = ...' to define your modules. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:40) - - - - - Multiple references to '%s.dll' are not permitted - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:31) - - - - - Files in libraries or multiple-file applications must begin with a namespace or module declaration, e.g. 'namespace SomeNamespace.SubNamespace' or 'module SomeNamespace.SomeModule'. Only the last source file of an application may omit such a declaration. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:39) - - - - - The referenced or default base CLI library 'mscorlib' is binary-incompatible with the referenced library '%s'. Consider recompiling the library or making an explicit reference to a version of this library that matches the CLI version you are using. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:34) - - - - - The referenced or default base CLI library 'mscorlib' is binary-incompatible with the referenced F# core library '%s'. Consider recompiling the library or making an explicit reference to a version of this library that matches the CLI version you are using. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:36) - - - - - The output name extension doesn't match the options used. If '-a' or '--target:library' is used the output file name must end with '.dll', if '--target:module' is used the output extension must be '.netmodule', otherwise '.exe'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:24) - - - - - Invalid warning number '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:18) - - - - - Invalid version string '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:19) - - - - - Invalid version file '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:20) - - - - - The file extension of '%s' is not recognized. Source files must have extension .fs, .fsi, .fsx, .fsscript, .ml or .mli. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:43) - - - - - The search directory '%s' is invalid - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:26) - - - - - Unrecognized privacy setting '%s' for managed resource, valid options are 'public' and 'private' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:30) - - - - - Invalid module or namespace name - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:60) - - - - - Invalid directive. Expected '#time', '#time \"on\"' or '#time \"off\"'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:51) - - - - - Invalid directive. Expected '#r \"<file-or-assembly>\"'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:49) - - - - - Invalid directive. Expected '#load \"<file>\" ... \"<file>\"'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:50) - - - - - Invalid directive. Expected '#I \"<path>\"'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:48) - - - - - '%s' is not a valid filename - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:28) - - - - - '%s' is not a valid assembly name - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:29) - - - - - The declarations in this file will be placed in an implicit module '%s' based on the file name '%s'. However this is not a valid F# identifier, so the contents will not be accessible from other files. Consider renaming the file or adding a 'module' or 'namespace' declaration at the top of the file. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:38) - - - - - An implementation of file or module '%s' has already been given. Compilation order is significant in F# because of type inference. You may need to adjust the order of your files to place the signature file before the implementation. In Visual Studio files are type-checked in the order they appear in the project file, which can be edited manually or adjusted using the solution explorer. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:54) - - - - - An implementation of the file or module '%s' has already been given - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:55) - - - - - When mscorlib.dll or FSharp.Core.dll is explicitly referenced the %s option must also be passed - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1126) - - - - - FSharp.Core.sigdata not found alongside FSharp.Core - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1127) - - - - - File '%s' not found alongside FSharp.Core - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1129) - - - - - Error opening binary file '%s': %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:46) - - - - - Directives inside modules are ignored - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:52) - - - - - The F#-compiled DLL '%s' needs to be recompiled to be used with this version of F# - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:47) - - - - - Did not expect to find sigdata resource in FSharp.Core.dll - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1130) - - - - - Did not expect to find optdata resource in FSharp.Core.dll - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1128) - - - - - Could not resolve assembly '%s' required by '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:45) - - - - - Could not resolve assembly '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:44) - - - - - Could not read version from mscorlib.dll - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:33) - - - - - Source file '%s' could not be found - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:42) - - - - - The file extensions '.ml' and '.mli' are for ML compatibility - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1111) - - - - - Unable to read assembly '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:35) - - - - - Assembly resolution failure at or near this location - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:37) - - - - - '%s' is not a valid integer argument - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:57) - - - - - '%s' is not a valid floating point argument - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:58) - - - - - A type cannot have both the 'ReferenceEquality' and 'StructuralEquality' or 'StructuralComparison' attributes - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:216) - - - - - The 'StructuralEquality' attribute must be used in conjunction with the 'NoComparison' or 'StructuralComparison' attributes - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:215) - - - - - The 'StructuralComparison' attribute must be used in conjunction with the 'StructuralEquality' attribute - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:214) - - - - - A type with attribute 'ReferenceEquality' cannot have an explicit implementation of 'Object.Equals(obj)', 'System.IEquatable<_>' or 'System.Collections.IStructuralEquatable' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:218) - - - - - Only record, union, exception and struct types may be augmented with the 'ReferenceEquality', 'StructuralEquality' and 'StructuralComparison' attributes - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:217) - - - - - The 'ReferenceEquality' attribute cannot be used on structs. Consider using the 'StructuralEquality' attribute instead, or implement an override for 'System.Object.Equals(obj)'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:211) - - - - - The 'NoEquality' attribute must be used in conjunction with the 'NoComparison' attribute - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:213) - - - - - A type with attribute 'NoEquality' should not usually have an explicit implementation of 'Object.Equals(obj)'. Disable this warning if this is intentional for interoperability purposes - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:221) - - - - - A type with attribute 'NoComparison' should not usually have an explicit implementation of 'System.IComparable', 'System.IComparable<_>' or 'System.Collections.IStructuralComparable'. Disable this warning if this is intentional for interoperability purposes - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:222) - - - - - This type uses an invalid mix of the attributes 'NoEquality', 'ReferenceEquality', 'StructuralEquality', 'NoComparison' and 'StructuralComparison' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:212) - - - - - A type with attribute 'CustomEquality' must have an explicit implementation of at least one of 'Object.Equals(obj)', 'System.IEquatable<_>' or 'System.Collections.IStructuralEquatable' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:219) - - - - - The 'CustomEquality' attribute must be used in conjunction with the 'NoComparison' or 'CustomComparison' attributes - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:223) - - - - - A type with attribute 'CustomComparison' must have an explicit implementation of at least one of 'System.IComparable' or 'System.Collections.IStructuralComparable' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:220) - - - - - Error while parsing embedded IL type - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:205) - - - - - Error while parsing embedded IL - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:204) - - - - - Invalid expression on left of assignment - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:207) - - - - - This indexer notation has been removed from the F# language - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:206) - - - - - .NET Framework - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:954) - - - - - Global Assembly Cache - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:955) - - - - - Found by AssemblyFolders registry key - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:952) - - - - - Found by AssemblyFoldersEx registry key - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:953) - - - - - Active pattern '%s' is not a function - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1113) - - - - - Active pattern '%s' has a result type containing type variables that are not determined by the input. The common cause is a when a result case is not mentioned, e.g. 'let (|A|B|) (x:int) = A x'. This can be fixed with a type constraint, e.g. 'let (|A|B|) (x:int) : Choice<int,unit> = A x' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1114) - - - - - The mutable local '%s' is implicitly allocated as a reference cell because it has been captured by a closure. This warning is for informational purposes only to indicate where implicit allocations are performed. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:1336) - - - - - Module '%s' contains\n %s \nbut its signature specifies\n %s \nOne is virtual and the other isn't - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:113) - - - - - Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe types differ - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:105) - - - - - Module '%s' contains\n %s \nbut its signature specifies\n %s \nOne is static and the other isn't - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:112) - - - - - Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe compiled representation of this method is as a static member but the signature indicates its compiled representation is as an instance member - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:118) - - - - - Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe respective type parameter counts differ - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:104) - - - - - Module '%s' contains\n %s \nbut its signature specifies\n %s \nOne is marked as an override and the other isn't - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:116) - - - - - Module '%s' contains\n %s \nbut its signature specifies\n %s \nOne is a type function and the other is not. The signature requires explicit type parameters if they are present in the implementation. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:103) - - - - - Module '%s' contains\n %s \nbut its signature specifies\n %s \nOne is a constructor/property and the other is not - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:117) - - - - - Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe names differ - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:97) - - - - - Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe literal constant values and/or attributes differ - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:102) - - - - - Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe compiled representation of this method is as an instance member, but the signature indicates its compiled representation is as a static member - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:119) - - - - - Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe inline flags differ - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:101) - - - - - Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe number of generic parameters in the signature and implementation differ (the signature declares %s but the implementation declares %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:108) - - - - - Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe generic parameters in the signature and implementation have different kinds. Perhaps there is a missing [<Measure>] attribute. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:109) - - - - - Module '%s' contains\n %s \nbut its signature specifies\n %s \nOne is final and the other isn't - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:115) - - - - - Module '%s' contains\n %s \nbut its signature specifies\n %s \nOne is an extension member and the other is not - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:106) - - - - - Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe CLI member names differ - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:111) - - - - - Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe display names differ - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:99) - - - - - Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe compiled names differ - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:98) - - - - - Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe mutability attributes differ - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:96) - - - - - Module '%s' contains\n %s \nbut its signature specifies\n %s \nAn arity was not inferred for this value - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:107) - - - - - Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe arities in the signature and implementation differ. The signature specifies that '%s' is function definition or lambda expression accepting at least %s argument(s), but the implementation is a computed function value. To declare that a computed function value is a permitted implementation simply parenthesize its type in the signature, e.g.\n\tval %s: int -> (int -> int)\ninstead of\n\tval %s: int -> int -> int. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:110) - - - - - Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe accessibility specified in the signature is more than that specified in the implementation - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:100) - - - - - Module '%s' contains\n %s \nbut its signature specifies\n %s \nOne is abstract and the other isn't - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:114) - - - - - Call this method once to validate that all known resources are valid; throws if not - - - - - The module contains the constructor\n %s \nbut its signature specifies\n %s \nThe types of the fields differ - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:154) - - - - - The module contains the constructor\n %s \nbut its signature specifies\n %s \nThe names differ - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:152) - - - - - The module contains the constructor\n %s \nbut its signature specifies\n %s \nThe respective number of data fields differ - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:153) - - - - - The module contains the constructor\n %s \nbut its signature specifies\n %s \nthe accessibility specified in the signature is more than that specified in the implementation - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:155) - - - - - Invalid recursive reference to an abstract slot - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:960) - - - - - The module contains the field\n %s \nbut its signature specifies\n %s \nThe types differ - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:161) - - - - - The module contains the field\n %s \nbut its signature specifies\n %s \nThe 'static' modifiers differ - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:158) - - - - - The module contains the field\n %s \nbut its signature specifies\n %s \nThe names differ - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:156) - - - - - The module contains the field\n %s \nbut its signature specifies\n %s \nThe 'mutable' modifiers differ - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:159) - - - - - The module contains the field\n %s \nbut its signature specifies\n %s \nThe 'literal' modifiers differ - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:160) - - - - - The module contains the field\n %s \nbut its signature specifies\n %s \nthe accessibility specified in the signature is more than that specified in the implementation - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:157) - - - - - The exception definitions are not compatible because the exception abbreviations in the signature and implementation differ. The module contains the exception definition\n %s \nbut its signature specifies\n\t%s. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:180) - - - - - The exception definitions are not compatible because a CLI exception mapping is being hidden by a signature. The exception mapping must be visible to other modules. The module contains the exception definition\n %s \nbut its signature specifies\n\t%s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:177) - - - - - The exception definitions are not compatible because the order of the fields is different in the signature and implementation. The module contains the exception definition\n %s \nbut its signature specifies\n\t%s. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:184) - - - - - The exception definitions are not compatible because the field '%s' was required by the signature but was not specified by the implementation. The module contains the exception definition\n %s \nbut its signature specifies\n\t%s. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:182) - - - - - The exception definitions are not compatible because the field '%s' was present in the implementation but not in the signature. The module contains the exception definition\n %s \nbut its signature specifies\n\t%s. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:183) - - - - - The exception definitions are not compatible because the exception declarations differ. The module contains the exception definition\n %s \nbut its signature specifies\n\t%s. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:181) - - - - - The exception definitions are not compatible because the CLI representations differ. The module contains the exception definition\n %s \nbut its signature specifies\n\t%s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:178) - - - - - The exception definitions are not compatible because the exception abbreviation is being hidden by the signature. The abbreviation must be visible to other CLI languages. Consider making the abbreviation visible in the signature. The module contains the exception definition\n %s \nbut its signature specifies\n\t%s. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:179) - - - - - The %s definitions in the signature and implementation are not compatible because the types have different base types - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:132) - - - - - The %s definitions in the signature and implementation are not compatible because a type representation is being hidden by a signature - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:138) - - - - - The %s definitions in the signature and implementation are not compatible because the types are of different kinds - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:139) - - - - - The %s definitions in the signature and implementation are not compatible because the signature says this type may use nulls as an extra value but the implementation does not - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:127) - - - - - The %s definitions in the signature and implementation are not compatible because the signature says this type may use nulls as a representation but the implementation does not - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:126) - - - - - The %s definitions in the signature and implementation are not compatible because the signature is an abstract class but the implementation is not. Consider adding the [<AbstractClass>] attribute to the implementation. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:131) - - - - - The %s definitions in the signature and implementation are not compatible because the signature defines the %s '%s' but the implementation does not (or does, but not in the same order) - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:134) - - - - - The %s definitions in the signature and implementation are not compatible because the signature declares a %s while the implementation declares a %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:148) - - - - - The %s definitions in the signature and implementation are not compatible because the signature has an abbreviation while the implementation does not - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:151) - - - - - The %s definitions in the signature and implementation are not compatible because the representations differ - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:141) - - - - - The %s definitions in the signature and implementation are not compatible because the respective type parameter counts differ - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:121) - - - - - The %s definitions in the signature and implementation are not compatible because the number of %ss differ - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:133) - - - - - The %s definitions in the signature and implementation are not compatible because the names differ - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:120) - - - - - The %s definitions in the signature and implementation are not compatible because the signature requires that the type supports the interface %s but the interface has not been implemented - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:123) - - - - - The %s definitions in the signature and implementation are not compatible because the implementation type is sealed but the signature implies it is not. Consider adding the [<Sealed>] attribute to the signature. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:128) - - - - - The %s definitions in the signature and implementation are not compatible because the implementation says this type may use nulls as an extra value but the signature does not - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:125) - - - - - The %s definitions in the signature and implementation are not compatible because the implementation says this type may use nulls as a representation but the signature does not - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:124) - - - - - The %s definitions in the signature and implementation are not compatible because the implementation type is not sealed but signature implies it is. Consider adding the [<Sealed>] attribute to the implementation. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:129) - - - - - The %s definitions in the signature and implementation are not compatible because the implementation is an abstract class but the signature is not. Consider adding the [<AbstractClass>] attribute to the signature. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:130) - - - - - The %s definitions in the signature and implementation are not compatible because the implementation defines a struct but the signature defines a type with a hidden representation - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:136) - - - - - The %s definitions in the signature and implementation are not compatible because the implementation defines the %s '%s' but the signature does not (or does, but not in the same order) - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:135) - - - - - The %s definitions in the signature and implementation are not compatible because the IL representations differ - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:140) - - - - - The %s definitions in the signature and implementation are not compatible because the field %s was present in the implementation but not in the signature - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:142) - - - - - The %s definitions in the signature and implementation are not compatible because the field %s was required by the signature but was not specified by the implementation - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:144) - - - - - The %s definitions in the signature and implementation are not compatible because the order of the fields is different in the signature and implementation - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:143) - - - - - The %s definitions in the signature and implementation are not compatible because the field '%s' was present in the implementation but not in the signature. Struct types must now reveal their fields in the signature for the type, though the fields may still be labelled 'private' or 'internal'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:145) - - - - - The %s definitions in the signature and implementation are not compatible because a CLI type representation is being hidden by a signature - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:137) - - - - - The %s definitions in the signature and implementation are not compatible because the accessibility specified in the signature is more than that specified in the implementation - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:122) - - - - - The %s definitions in the signature and implementation are not compatible because the abstract member '%s' was present in the implementation but not in the signature - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:147) - - - - - The %s definitions in the signature and implementation are not compatible because the abstract member '%s' was required by the signature but was not specified by the implementation - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:146) - - - - - The %s definitions in the signature and implementation are not compatible because the abbreviations differ: %s versus %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:149) - - - - - The %s definitions in the signature and implementation are not compatible because an abbreviation is being hidden by a signature. The abbreviation must be visible to other CLI languages. Consider making the abbreviation visible in the signature. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\FSComp.txt:150) - - - - - Stopped due to error\n - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:2) - - - - - Prevents references from being locked by the F# Interactive process - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:53) - - - - - If set to true, then all error messages will just return the filled 'holes' delimited by ',,,'s - this is for language-neutral testing (e.g. localization-invariant baselines). - - - - - If set to true, then all error messages will just return the filled 'holes' delimited by ',,,'s - this is for language-neutral testing (e.g. localization-invariant baselines). - - - - - Use the given file on startup as initial input - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:11) - - - - - Usage: %s <options> [script.fsx [<arguments>]] - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:3) - - - - - - Unexpected ThreadAbortException (Ctrl-C) during event handling: Trying to restart... - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:49) - - - - - --> Timing now on - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:47) - - - - - --> Timing now off - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:48) - - - - - Real: %s, CPU: %s, GC %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:26) - - - - - gen - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:27) - - - - - Treat remaining arguments as command line arguments, accessed using fsi.CommandLineArgs - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:13) - - - - - Support TAB completion in console (on by default) - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:18) - - - - - Suppress fsi writing to stdout - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:17) - - - - - F# Interactive for F# 4.0 %s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:52) - - - - - - MISCELLANEOUS - - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:8) - - - - - Loading - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:38) - - - - - #load the given file on startup - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:12) - - - - - Warning: line too long, ignoring some characters\n - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:25) - - - - - - LANGUAGE - - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:7) - - - - - Invalid directive '#%s %s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:24) - - - - - '%s' is not a valid assembly name - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:22) - - - - - See '%s' for options - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:37) - - - - - F# Interactive command line options: - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:36) - - - - - F# Interactive directives: - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:29) - - - - - Toggle timing on/off - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:33) - - - - - Reference (dynamically load) the given DLL - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:30) - - - - - Exit - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:35) - - - - - Load the given file(s) as if compiled and referenced - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:32) - - - - - Display help - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:34) - - - - - Add the given search path for referenced DLLs - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:31) - - - - - \n- Interrupt\n - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:39) - - - - - - INPUT FILES - - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:4) - - - - - Display this usage message (Short form: -?) - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:14) - - - - - Execute interactions on a Windows Forms event loop (on by default) - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:16) - - - - - Failed to resolve assembly '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:50) - - - - - \n- Exit...\n - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:40) - - - - - Exit fsi after loading the files or running the .fsx script given on the command line - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:15) - - - - - Exception raised when starting remoting server.\n%s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:10) - - - - - \n\nException raised during pretty printing.\nPlease report this so it can be fixed.\nTrace: %s\n - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:28) - - - - - - ERRORS AND WARNINGS - - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:6) - - - - - Emit debug information in quotations - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:19) - - - - - Directory '%s' doesn't exist - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:23) - - - - - --> Referenced '%s' (an assembly with a different timestamp has already been referenced from this location, reset fsi to load the updated assembly) - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:45) - - - - - --> Referenced '%s' (file may be locked by F# Interactive process) - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:44) - - - - - --> Referenced '%s' - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:43) - - - - - --> Added '%s' to library include path - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:46) - - - - - Failed to install ctrl-c handler - Ctrl-C handling will not be available. Error was:\n\t%s - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:42) - - - - - A problem occurred starting the F# Interactive process. This may be due to a known problem with background process console support for Unicode-enabled applications on some Windows systems. Try selecting Tools->Options->F# Interactive for Visual Studio and enter '--fsi-server-no-unicode'. - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:21) - - - - - - CODE GENERATION - - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:5) - - - - - Binding session to '%s'... - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:51) - - - - - For help type #help;; - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:20) - - - - - - ADVANCED - - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:9) - - - - - - Aborting main thread... - (Originally from C:\GitHub\fsharp\FSharp.Compiler.Service\src\fsharp\fsi\FSIstrings.txt:41) - - - - - Call this method once to validate that all known resources are valid; throws if not - - - - - Note this operation is O(n) anyway, so executing ToFlatList() here is OK - - - - - Note this operation is O(1), unless a push happens, which is rare - - - - - Iterable functional collection with O(1) append-1 time. Useful for data structures where elements get added at the - end but the collection must occasionally be iterated. Iteration is slower and may allocate because - a suffix of elements is stored in reverse order. - - The type doesn't support structural hashing or comparison. - - - - - Lookup the value without making it the most recent. - Returns the original key value because the areSame function - may have unified two different keys. - - - - - Lookup a value and make it the most recent. - Returns the original key value because the areSame function - may have unified two different keys. - - - - - Lookup a value and make it the most recent. Return None if it wasn't there. - - - - - Resize - - - - - Remove the given value from the collection. - - - - - Add an element to the collection. Make it the most recent. - - - - - Remove all elements. - - - - - Simple aging lookup table. When a member is accessed it's - moved to the top of the list and when there are too many elements - the least-recently-accessed element falls of the end. - - - - - Lookup or set the given element in the table. Set replaces all existing bindings for a value with a single - bindings. Raise <c>KeyNotFoundException</c> if the element is not found. - - - - - Lookup or set the given element in the table. Set replaces all existing bindings for a value with a single - bindings. Raise <c>KeyNotFoundException</c> if the element is not found. - - - - - The total number of keys in the hash table - - - - - Lookup the given element in the table, returning the result as an Option - - - - - Replace the latest binding (if any) for the given element. - - - - - Remove the latest binding (if any) for the given element from the table - - - - -Apply the given function to each binding in the hash table - - - - - Apply the given function to each element in the collection threading the accumulating parameter - through the sequence of function applications - - - - - Find all bindings for the given element in the table, if any - - - - - Make a shallow copy of the collection - - - - - Test if the collection contains any bindings for the given element - - - - - Clear all elements from the collection - - - - - Add a binding for the element to the table - - - - - Build a map that contains the bindings of the given IEnumerable - - - - - Create a new empty mutable HashMultiMap with an internal bucket array of the given approximate size - and with the given key hash/equality functions - - - - - Create a new empty mutable HashMultiMap with the given key hash/equality functions - - - - - Hash tables, by default based on F# structural "hash" and (=) functions. - The table may map a single key to multiple bindings. - - - - - Return each distinct item in the list using reference equality. - - - - - Return a new list with one element for each unique 'TKey. Multiple 'TValues are flattened. The original order of the first instance of 'TKey is preserved. - - - - - Get the value for the given key or None if not already available - - - - - Get the value for the given key or None if not already available - - - - - Set the given key. - - - - - Resize - - - - - Remove the given value from the mru cache. - - - - - Clear out the cache. - - - - - Simple priority caching for a small number of key\value associations. - This cache may age-out results that have been Set by the caller. - Because of this, the caller must be able to tolerate values - that aren't what was originally passed to the Set function. - - - - - Lookup an element in the map. Raise <c>KeyNotFoundException</c> if no binding - exists in the map. - - - - - Return true if there are no bindings in the map. - - - - - The number of bindings in the map - - - - - Lookup an element in the map, returning a <c>Some</c> value if the element is in the domain - of the map and <c>None</c> if not. - - - - - The elements of the set as a list. - - - - - The elements of the set as an array - - - - - Remove an element from the domain of the map. No exception is raised if the element is not present. - - - - - Build two new maps, one containing the bindings for which the given predicate returns 'true', - and the other the remaining bindings. - - - - - Build a new collection whose elements are the results of applying the given function - to each of the elements of the collection. - - - - - Build a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The index passed to the - function indicates the index of element being transformed. - - - - - Apply the given function to each binding in the dictionary - - - - - Return true if the given predicate returns true for all of the - bindings in the map. Always returns true if the map is empty. - - - - - Given the start and end points of a key range, - Fold over the bindings in the map that are in the range, - and the end points are included if present (the range is considered a closed interval). - - - - - Fold over the bindings in the map. - - - - - Fold over the bindings in the map. - - - - - Search the map looking for the first element where the given function returns a <c>Some</c> value - - - - - Build a new map containing the bindings for which the given predicate returns 'true'. - - - - - Return true if the given predicate returns true for one of the - bindings in the map. Always returns false if the map is empty. - - - - - The empty map, and use the given comparer comparison function for all operations associated - with any maps built from this map. - - - - - Build a map that contains the bindings of the given IEnumerable - and where comparison of elements is based on the given comparison function - - - - - Test is an element is in the domain of the map - - - - - Return a new map with the binding added to the given map. - - - - - Immutable maps. Keys are ordered by construction function specified - when creating empty maps or by F# structural comparison if no - construction function is specified. - - <performance> - Maps based on structural comparison are - efficient for small keys. They are not a suitable choice if keys are recursive data structures - or require non-structural comparison semantics. - </performance> - Immutable maps. A constraint tag carries information about the class of key-comparers being used. - - - - - Return a new set with the elements of the second set removed from the first. - - - - - Compute the union of the two sets. - - - - - Returns the lowest element in the set according to the ordering being used for the set - - - - - Returns the highest element in the set according to the ordering being used for the set - - - - - A useful shortcut for Set.isEmpty. See the Set module for further operations on sets. - - - - - Return the number of elements in the set - - - - - The number of elements in the set - - - - - Compute the union of the two sets. - - - - - The elements of the set as a list. - - - - - The elements of the set as an array. - - - - - A singleton set based on the given comparison operator - - - - - A useful shortcut for Set.remove. Note this operation produces a new set - and does not mutate the original set. The new set will share many storage - nodes with the original. See the Set module for further operations on sets. - - - - - Build two new sets, one containing the elements for which the given predicate returns 'true', - and the other the remaining elements. - - - - - Apply the given function to each binding in the collection - - - - - Evaluates to "true" if all elements of the first set are in the second - - - - - Evaluates to "true" if all elements of the second set are in the first - - - - - Compute the intersection of the two sets. - - - - - Test if all elements of the collection satisfy the given predicate. - If the input function is <c>f</c> and the elements are <c>i0...iN</c> and <c>j0...jN</c> then - computes <c>p i0 && ... && p iN</c>. - - - - - Apply the given accumulating function to all the elements of the set - - - - - Return a new collection containing only the elements of the collection - for which the given predicate returns "true" - - - - - Test if any element of the collection satisfies the given predicate. - If the input function is <c>f</c> and the elements are <c>i0...iN</c> then computes - <c>p i0 or ... or p iN</c>. - - - - - Compares two sets and returns true if they are equal or false otherwise - - - - - The empty set based on the given comparer - - - - - Return a new set with the elements of the second set removed from the first. - - - - - A set based on the given comparer containing the given initial elements - - - - - A useful shortcut for Set.contains. See the Set module for further operations on sets. - - - - - Compares a and b and returns 1 if a > b, -1 if b < a and 0 if a = b - - - - - A useful shortcut for Set.add. Note this operation produces a new set - and does not mutate the original set. The new set will share many storage - nodes with the original. See the Set module for further operations on sets. - - - - - Immutable sets based on binary trees, default tag - Immutable sets where a constraint tag carries information about the class of key-comparer being used. - - - - - Try to find the F# compiler location by looking at the "fsharpi" script installed by F# packages - - - - - The F# version reported in the banner - - - - - Convert string into Option string where null and String.Empty result in None - - - - - Get the filename without extension of the given path - - - - - Get the filename of the given path - - - - - Return true if the filename has a "." extension - - - - - "directoryName" " decomposes a filename into a directory name - - - - - "chopExtension f" removes the extension from the given - filename. Raises ArgumentException if no extension is present. - - - - - "checkSuffix f s" returns true if filename "f" ends in suffix "s", - e.g. checkSuffix "abc.fs" ".fs" returns true. - - - - - Some filename operations. - - - - - Split an array of pairs into two arrays - - - - - Combine the two arrays into an array of pairs. The two arrays must have equal lengths, otherwise an <c>ArgumentException</c> is - raised.. - - - - - Return the index of the first element in the array - that satisfies the given predicate. - - - - - Return the index of the first element in the array - that satisfies the given predicate. - - - - - Return an array containing the given element - - - - - Like <c>foldBack</c>, but return both the intermediary and final results - - - - - Like <c>fold</c>, but return the intermediary and final results - - - - - Build a new collection whose elements are the results of applying the given function - to the corresponding elements of the two collections pairwise. The two input - arrays must have the same lengths, otherwise an <c>ArgumentException</c> is - raised. - - - - - Apply the given function to pair of elements drawn from matching indices in two arrays, - also passing the index of the elements. The two arrays must have the same lengths, - otherwise an <c>ArgumentException</c> is raised. - - - - - Return true if the given array is empty, otherwise false - - - - - Test elements of the two arrays pairwise to see if all pairs of elements satisfy the given predicate. - Raise ArgumentException if the arrays have different lengths. - - - - - Apply a function to pairs of elements drawn from the two collections, right-to-left, - threading an accumulator argument through the computation. The two input - arrays must have the same lengths, otherwise an <c>ArgumentException</c> is - raised. - - - - - Apply a function to pairs of elements drawn from the two collections, - left-to-right, threading an accumulator argument - through the computation. The two input - arrays must have the same lengths, otherwise an <c>ArgumentException</c> is - raised. - - - - - Apply a function to each element of the array, threading an accumulator argument - through the computation. If the input function is <c>f</c> and the elements are <c>i0...iN</c> then - computes <c>f i0 (...(f iN-1 iN))</c>. Raises ArgumentException if the array has size zero. - - - - - Apply a function to each element of the array, threading an accumulator argument - through the computation. If the input function is <c>f</c> and the elements are <c>i0...iN</c> - then computes <c>f (... (f i0 i1)...) iN</c>. Raises ArgumentException if the array has size zero. - - - - - Return the index of the first element in the array - that satisfies the given predicate. Raise <c>KeyNotFoundException</c> if - none of the elements satisfy the predicate. - - - - - Return the index of the first element in the array - that satisfies the given predicate. Raise <c>KeyNotFoundException</c> if - none of the elements satisfy the predicate. - - - - - Test elements of the two arrays pairwise to see if any pair of element satisfies the given predicate. - Raise ArgumentException if the arrays have different lengths. - - - - - Return a view of the array as an enumerable object - - - - - Build a ResizeArray from the given elements - - - - - Return a fixed-length array containing the elements of the input ResizeArray - - - - - Sort the elements using the key extractor and generic comparison on the keys - - - - - Sort the elements using the given comparison function - - - - -Return a new array with the elements in reverse order - - - - -Apply the given function to successive elements, returning the first -result where function returns "Some(x)" for some x. - - - - -Return the first element for which the given function returns <c>true</c>. -Return None if no such element exists. - - - - -Return the first element for which the given function returns <c>true</c>. -Raise <c>KeyNotFoundException</c> if no such element exists. - - - - -Apply the given function to each element of the array. Return -the array comprised of the results "x" for each element where -the function returns Some(x) - - - - -Split the collection into two collections, containing the -elements for which the given predicate returns <c>true</c> and <c>false</c> -respectively - - - - -Return a new collection containing only the elements of the collection -for which the given predicate returns <c>true</c> - - - - - Test if all elements of the array satisfy the given predicate. - If the input function is <c>f</c> and the elements are <c>i0...iN</c> and "j0...jN" - then computes <c>p i0 && ... && p iN</c>. - - - - - Test if any element of the array satisfies the given predicate. - If the input function is <c>f</c> and the elements are <c>i0...iN</c> - then computes <c>p i0 or ... or p iN</c>. - - - - -Build a new array whose elements are the results of applying the given function -to each of the elements of the array. The integer index passed to the -function indicates the index of element being transformed. - - - - -Apply the given function to each element of the array. The integer passed to the -function indicates the index of element. - - - - -Build a new collection whose elements are the results of applying the given function -to the corresponding elements of the two collections pairwise. The two input -arrays must have the same lengths. - - - - -Apply the given function to two arrays simultaneously. The -two arrays must have the same lengths, otherwise an Invalid_argument exception is -raised. - - - - -Build a new array whose elements are the results of applying the given function -to each of the elements of the array. - - - - -Apply the given function to each element of the array. - - - - - Apply a function to each element of the array, threading an accumulator argument - through the computation. If the input function is <c>f</c> and the elements are <c>i0...iN</c> then - computes <c>f i0 (...(f iN s))</c>. - - - - - Apply a function to each element of the collection, threading an accumulator argument - through the computation. If the input function is <c>f</c> and the elements are <c>i0...iN</c> - then computes <c>f (... (f s i0)...) iN</c> - - - - -Build an array from the given list - - - - -Build a list from the given array - - - - -Read a range of elements from the first array and write them into the second. - - - - -Fill a range of the collection with the given element - - - - -Build a new array that contains the elements of the given array - - - - -Build a new array that contains the given subrange specified by -starting index and length. - - - - -Build a new array that contains the elements of each of the given list of arrays - - - - -Build a new array that contains the elements of the first array followed by the elements of the second array - - - - - Create an array by calling the given generator on each index. - - - - - Create an array whose elements are all initially the given value. - - - - - Set the value of an element in the collection. You can also use the syntax <c>arr.[idx] <- e</c>. - - - - - Fetch an element from the collection. You can also use the syntax <c>arr.[idx]</c>. - - - - - Return the length of the collection. You can also use property <c>arr.Length</c>. - - - - - Generic operations on the type System.Collections.Generic.List, which is called ResizeArray in the F# libraries. - - - - - A record of options to control structural formatting. - For F# Interactive properties matching those of this value can be accessed via the 'fsi' - value. - - Floating Point format given in the same format accepted by System.Double.ToString, - e.g. f6 or g15. - - If ShowProperties is set the printing process will evaluate properties of the values being - displayed. This may cause additional computation. - - The ShowIEnumerable is set the printing process will force the evaluation of IEnumerable objects - to a small, finite depth, as determined by the printing parameters. - This may lead to additional computation being performed during printing. - - <example> - From F# Interactive the default settings can be adjusted using, for example, - <pre> - open Microsoft.FSharp.Compiler.Interactive.Settings;; - setPrintWidth 120;; - </pre> - </example> - - - - - The maximum number of rows for which to generate layout for table-like - structures. -1 if no maximum. - - - - - The maximum number of elements for which to generate layout for - list-like structures, or columns in table-like - structures. -1 if no maximum. - - - - - Return to the layout-generation - environment to layout any otherwise uninterpreted object - - - - - Data representing structured layouts of terms. The representation - of this data type is only for the consumption of formatting engines. - - - - - Data representing structured layouts of terms. - Data representing joints in structured layouts of terms. The representation - of this data type is only for the consumption of formatting engines. - - - - - Convert any value to a layout using the given formatting options. The - layout can then be processed using formatting display engines such as - those in the LayoutOps module. any_to_string and output_any are - built using any_to_layout with default format options. - - - - - Output any value to a channel using the same set of formatting rules - as any_to_string - - - - - Convert any value to a string using a standard formatter - Data is typically formatted in a structured format, e.g. - lists are formatted using the "[1;2]" notation. - The details of the format are not specified and may change - from version to version and according to the flags given - to the F# compiler. The format is intended to be human-readable, - not machine readable. If alternative generic formats are required - you should develop your own formatter, using the code in the - implementation of this file as a starting point. - - Data from other .NET languages is formatted using a virtual - call to Object.ToString() on the boxed version of the input. - - - - - For limiting layout of list-like sequences (lists,arrays,etc). - unfold a list of items using (project and z) making layout list via itemL. - If reach maxLength (before exhausting) then truncate. - - - - - See tagL - - - - - Layout like an F# list. - - - - - Layout like an F# option. - - - - - Layout list vertically. - - - - - Layout two vertically. - - - - - Form tuple of layouts. - - - - - Wrap braces around layout. - - - - - Wrap square brackets around layout. - - - - - Wrap round brackets around Layout. - - - - - Join layouts into a list separated using the given Layout. - - - - - Join layouts into a semi-colon separated list. - - - - - Join layouts into a space separated list. - - - - - Join layouts into a comma separated list. - - - - - Join broken with ident=2 - - - - - Join broken with ident=1 - - - - - Join broken with ident=0 - - - - - Join, possible break with indent=2 - - - - - Join, possible break with indent=1 - - - - - Join, possible break with indent=0 - - - - - Join, unbreakable. - - - - - An string which is left parenthesis (no space on the right). - - - - - An string which is right parenthesis (no space on the left). - - - - - An string which requires no spaces either side. - - - - - An string leaf - - - - - An uninterpreted leaf, to be interpreted into a string - by the layout engine. This allows leaf layouts for numbers, strings and - other atoms to be customized according to culture. - - - - - Is it the empty layout? - - - - - The empty layout - - - - - A layout is a sequence of strings which have been joined together. - The strings are classified as words, separators and left and right parenthesis. - This classification determines where spaces are inserted. - A joint is either unbreakable, breakable or broken. - If a joint is broken the RHS layout occurs on the next line with optional indentation. - A layout can be squashed to for given width which forces breaks as required. - - - - - Interpret tables for a unicode lexer generated by fslex. - - - - - The type of tables for an unicode lexer generated by fslex. - - - - - The start position for the lexeme - - - - - True if the refill of the buffer ever failed , or if explicitly set to true. - - - - - The end position for the lexeme - - - - - The start position for the lexeme - - - - - The matched string - - - - - True if the refill of the buffer ever failed , or if explicitly set to true. - - - - - The end position for the lexeme - - - - - Dynamically typed, non-lexically scoped parameter table - - - - - Fast helper to turn the matched characters into a string, avoiding an intermediate array - - - - - Create a lex buffer that reads character or byte inputs by using the given function - - - - - Create a lex buffer suitable for Unicode lexing that reads characters from the given array - - - - - Input buffers consumed by lexers generated by <c>fslex.exe </c> - - - - - Return absolute offset of the start of the line marked by the position - - - - - The character number in the input stream - - - - - The line number for the position in the input stream, assuming fresh positions have been updated - using for the new line - - - - - The line number in the input stream, assuming fresh positions have been updated - for the new line by modifying the EndPos property of the LexBuffer. - - - - - The file index for the file associated with the input stream, use fileOfFileIndex in range.fs to decode - - - - - Get an arbitrary position, with the empty string as filename, and - - - - - Return the column number marked by the position, i.e. the difference between the AbsoluteOffset and the StartOfLineAbsoluteOffset - - - - - Gives a position shifted by specified number of characters - - - - - Given a position at the start of a token of length n, return a position just beyond the end of the token - - - - - Apply a #line directive - - - - - Position information stored for lexing tokens - - - - - The tag of the error terminal - - - - - The total number of terminals - - - - - This function is used to hold the user specified "parse_error" or "parse_error_rich" functions - - - - - This table is logically part of the Goto table - - - - - The sparse table offsets for the productions active for each state - - - - - The sparse table for the productions active for each state - - - - - The sparse goto table row offsets - - - - - The sparse goto table - - - - - The immediate action table - - - - - The number of symbols for each reduction - - - - - The sparse action table row offsets - - - - - The sparse action table elements - - - - - A function to compute the data carried by a token - - - - - A function to compute the tag of a token - - - - - The token number indicating the end of input - - - - - The reduction table - - - - - Interpret the parser table taking input from the given lexer, using the given lex buffer, and the given start state. - Returns an object indicating the final synthesized value for the parse. - - - - - Tables generated by fsyacc - The type of the tables contained in a file produced by the fsyacc.exe parser generator. - - - - - The stack of state indexes active at the parse error - - - - - The token that would cause a shift at the parse error - - - - - The stack of productions that would be reduced at the parse error - - - - - The tokens that would cause a reduction at the parse error - - - - - The state active at the parse error - - - - - The message associated with the parse error - - - - - The token that caused the parse error - - - - - The context provided when a parse error occurs - - - - - Get the start of the range of positions matched by the production - - - - - Get the full range of positions matched by the production - - - - - Get the end of the range of positions matched by the production - - - - - Return the LexBuffer for this parser instance - - - - - Raise an error in this parse context - - - - - Get the start position for the terminal or non-terminal at a given index matched by the production - - - - - Get the start and end position for the terminal or non-terminal at a given index matched by the production - - - - - Get the end position for the terminal or non-terminal at a given index matched by the production - - - - - Get the value produced by the terminal or non-terminal at the given position - - - - - Indicates a parse error has occurred and parse recovery is in progress - - - - - Indicates an accept action has occurred - - - - - The default implementation of the parse_error function - - - - - The default implementation of the parse_error_rich function - - - - - Helpers used by generated parsers. - - - - - Renamed to FSharpErrorInfo - - - - - Lookup the global static cache for building the FrameworkTcImports - - - - - Whether there are any 'live' type providers that may need a refresh when a project is Cleaned - - - - - The TcConfig passed in to the builder creation. - - - - - The full set of source files including those from options - - - - - Raised just after the whole project has finished type checking. At this point, accessing the - overall analysis results for the project will be quick. - - - - - Check if the builder is not disposed - - - - - Raised when a type provider invalidates the build. - - - - - Raised just after a file is parsed - - - - - Raised just after a file is checked - - - - - The list of files the build depends on - - - - - Raised just before a file is type-checked, to invalidate the state of the file in VS and force VS to request a new direct typecheck of the file. - The incremental builder also typechecks the file (error and intellisense results from the backgroud builder are not - used by VS). - - - - - Perform one step in the F# build. Return true if the background work is finished. - - - - - Increment the usage count on the IncrementalBuilder by 1. Ths initial usage count is 0. The returns an IDisposable which will - decrement the usage count on the entire build by 1 and dispose if it is no longer used by anyone. - - - - - Await the untyped parse results for a particular slot in the vector of parse results. - - This may be a marginally long-running operation (parses are relatively quick, only one file needs to be parsed) - - - - - Get the logical time stamp that is associated with the output of the project if it were gully built immediately - - - - - Get the preceding typecheck state of a slot, without checking if it is up-to-date w.r.t. - the timestamps on files and referenced DLLs prior to this one. Return None if the result is not available. - This is a very quick operation. - - - - - Get the preceding typecheck state of a slot. Compute the entire type check of the project up - to the necessary point if the result is not available. This may be a long-running operation. - - - - - - Get the final typecheck result. If 'generateTypedImplFiles' was set on Create then the TypedAssembly will contain implementations. - This may be a long-running operation. - - - - - - Get the typecheck result after the end of the last file. The typecheck of the project is not 'completed'. - This may be a long-running operation. - - - - - - Get the typecheck state after checking a file. Compute the entire type check of the project up - to the necessary point if the result is not available. This may be a long-running operation. - - - - - - Get the preceding typecheck state of a slot, but only if it is up-to-date w.r.t. - the timestamps on files and referenced DLLs prior to this one. Return None if the result is not available. - This is a relatively quick operation. - - - - - Manages an incremental build graph for the build of an F# project - - - - - Represents the state in the incremental graph assocaited with checking a file - - - - - Renamed to FSharpErrorSeverity - - - - - Test to report for the name of the type provider that produced the value - - - - - The ILScopeRef of the runtime assembly reference for type provider that produced the value - - - - - A type provider that produced the value - - - - - Apply an operation and 'untaint' the result. This can be used if the return type - is guaranteed not to be implemented by a type provider - - - - - Apply an operation and 'untaint' the result. The result must be marshallable. Any exception will be attributed to the type provider with an error located at the given range - - - - - Apply an operation. Any exception will be attributed to the type provider with an error located at the given range - - - - - Apply an operation that returns an option. Unwrap option. Any exception will be attributed to the type provider with an error located at the given range - - - - - Apply an operation. No exception may be raised by 'f' - - - - - Apply an operation that returns an array. Unwrap array. Any exception will be attributed to the type provider with an error located at the given range. String is method name of thing-returning-array, to diagnostically attribute if it is null - - - - - Apply an operation. Any exception will be attributed to the type provider with an error located at the given range - - - - - Apply an operation. Any exception will be attributed to the type provider with an error located at the given range - - - - - Apply an operation. Any exception will be attributed to the type provider with an error located at the given range - - - - - Apply an operation. Any exception will be attributed to the type provider with an error located at the given range - - - - - Conditionally coerce the value - - - - - Create an initial tainted value - - - - - Assert that the value is of 'U and coerce the value. - If coercion fails, the failure will be blamed on a type provider - - - - - This struct wraps a value produced by a type provider to properly attribute any failures. - - - - - creates new instance of TypeProviderError with specified type\method names - - - - - creates new instance of TypeProviderError based on current instance information(message) - - - - - provides uniform way to process aggregated errors - - - - - creates new instance of TypeProviderError that represents collection of errors - - - - - creates new instance of TypeProviderError that represents one error - - - - - Stores and transports aggregated list of errors reported by the type provider - - - - - Diagnostics from the AbsIL toolkit. You can reset the diagnostics - stream to point elsewhere, or turn it - off altogether by setting it to 'None'. The logging channel initially - points to stderr. All functions call flush() automatically. - - REVIEW: review if we should just switch to System.Diagnostics - - - - - Compiler use only. Erase closures - - - - - Scope references for FSharp.Core.dll - - - - - Debug info for generated code for classunions - - - - - Generate the helpers? - - - - - Are the representation helpers public? - - - - - Is the representation public? - - - - - ILX extensions to the instruction set - - - - - - IlxClosureApps - i.e. types being applied at a callsite - - - - - The name used for the field in parameter or IL field position - - - - - ILX extensions to Abstract IL types and instructions F# - - - - - Decompose a type definition according to its kind. - - - - - Helpers for codegen: scopes for allocating new temporary variables. - - - - - Some commonly used custom attibutes - - - - - A table of common references to items in primary assebly (System.Runtime or mscorlib). - If you have already loaded a particular version of system runtime assembly you should reference items via an ILGlobals for that particular - version of system runtime assembly built using mkILGlobals. - - - - - Represents the capabilities of target framework profile. - Different profiles may omit some types or contain them in different assemblies - - - - - e.g. win86 resources, as the exact contents of a .res or .obj file - - - - - One module in the "current" assembly, either a main-module or - an auxiliary module. The main module will have a manifest. - - An assembly is built by joining together a "main" module plus - several auxiliary modules. - - - - - Records whether the entrypoint resides in another module. - - - - - Records the types impemented by this asssembly in auxiliary - modules. - - - - - This is the public key used to sign this - assembly (the signature itself is stored elsewhere: see the - binary format, and may not have been written if delay signing - is used). (member Name, member PublicKey) forms the full - public name of the assembly. - - - - - This is ID of the algorithm used for the hashes of auxiliary - files in the assembly. These hashes are stored in the - ILModuleRef.Hash fields of this assembly. These are not cryptographic - hashes: they are simple file hashes. The algorithm is normally - 0x00008004 indicating the SHA1 hash algorithm. - - - - - The main module of an assembly is a module plus some manifest information. - - - - - Table of resources in a module - - - - - "Manifest ILResources" are chunks of resource data, being one of: - - the data section of the current module (byte[] of resource given directly) - - in an external file in this assembly (offset given in the ILResourceLocation field) - - as a resources in another assembly of the same name. - - - - - [Namespace.]Name - - - - - these are only found in the ILExportedTypesAndForwarders table in the manifest - - - - - "Classes Elsewhere" - classes in auxiliary modules. - - Manifests include declarations for all the classes in an - assembly, regardless of which module they are in. - - The ".class extern" construct describes so-called exported types -- - these are public classes defined in the auxiliary modules of this assembly, - i.e. modules other than the manifest-carrying module. - - For example, if you have a two-module - assembly (A.DLL and B.DLL), and the manifest resides in the A.DLL, - then in the manifest all the public classes declared in B.DLL should - be defined as exported types, i.e., as ".class extern". The public classes - defined in A.DLL should not be defined as ".class extern" -- they are - already available in the manifest-carrying module. The union of all - public classes defined in the manifest-carrying module and all - exported types defined there is the set of all classes exposed by - this assembly. Thus, by analysing the metadata of the manifest-carrying - module of an assembly, you can identify all the classes exposed by - this assembly, and where to find them. - - Nested classes found in external modules should also be located in - this table, suitably nested inside another "ILExportedTypeOrForwarder" - definition. - these are only found in the "Nested" field of ILExportedTypeOrForwarder objects - - - - - Note: some classes are marked "HasSecurity" even if there are no permissions attached, e.g. if they use SuppressUnmanagedCodeSecurityAttribute - - - - - Class or interface generated for COM interop - - - - - Type Definitions - - As for methods there are several important constraints not encoded - in the type definition below, for example that the super class of - an interface type is always None, or that enumerations always - have a very specific form. - - - - - Get some information about the type defs, but do not force the read of the type defs themselves - - - - - Calls to [FindByName] will result in any laziness in the overall - set of ILTypeDefs being read in in addition - to the details for the type found, but the remaining individual - type definitions will not be read. - - - - - Tables of named type definitions. The types and table may contain on-demand - (lazy) computations, e.g. the actual reading of some aspects - of a type definition may be delayed if the reader being used supports - this. - - This is an abstract type equivalent to "ILTypeDef list" - - - - - A categorization of type definitions into "kinds" - - - - - Type Access - - - - - Default Unicode encoding for P/Invoke within a type - - - - - Indicate the initialization semantics of a type - - - - - Type Layout information - - - - - Method Impls - - If there is an entry (pms --&gt; ms) in this table, then method [ms] - is used to implement method [pms] for the purposes of this class - and its subclasses. - - - - - Table of those properties in a type definition. - - - - - Property definitions - - - - - Table of those events in a type definition. - - - - - Event definitions - - - - - Tables of fields. Logically equivalent to a list of fields but - the table is kept in a form optimized for looking up fields by - name. - - - - - The explicit offset in bytes when explicit layout is used. - - - - - Field definitions - - - - - Tables of methods. Logically equivalent to a list of methods but - the table is kept in a form optimized for looking up methods by - name and arity. - abstract type equivalent to [ILMethodDef list] - - - - - .NET 2.0 feature: SafeHandle finalizer must be run - - - - - The method is exported to unmanaged code using COM interop. - - - - - Note: some methods are marked "HasSecurity" even if there are no permissions attached, e.g. if they use SuppressUnmanagedCodeSecurityAttribute - - - - - instance methods that are virtual or abstract or implement an interface slot. The predicates (IsClassInitializer,IsConstructor,IsStatic,IsNonVirtualInstance,IsVirtual) form a complete, non-overlapping classification of this type - - - - - static methods. The predicates (IsClassInitializer,IsConstructor,IsStatic,IsNonVirtualInstance,IsVirtual) form a complete, non-overlapping classification of this type - - - - - instance methods that are not virtual. The predicates (IsClassInitializer,IsConstructor,IsStatic,IsNonVirtualInstance,IsVirtual) form a complete, non-overlapping classification of this type - - - - - .ctor methods. The predicates (IsClassInitializer,IsConstructor,IsStatic,IsNonVirtualInstance,IsVirtual) form a complete, non-overlapping classification of this type - - - - - .cctor methods. The predicates (IsClassInitializer,IsConstructor,IsStatic,IsNonVirtualInstance,IsVirtual) form a complete, non-overlapping classification of this type - - - - - Method definitions. - - There are several different flavours of methods (constructors, - abstract, virtual, static, instance, class constructors). There - is no perfect factorization of these as the combinations are not - independent. - - - - - Indicates the type argument must have a public nullary constructor - - - - - Indicates the type argument must be a value type, but not Nullable - - - - - Indicates the type argument must be a reference type - - - - - Variance of type parameters, only applicable to generic parameters for generic interfaces and delegates - - - - - At most one is the parent type, the others are interface types - - - - - Generic parameters. Formal generic parameter declarations - may include the bounds, if any, on the generic parameter. - - - - - [OverridesSpec] - refer to a method declaration in a superclass - or superinterface. Used for overriding/method impls. Includes - a type for the parent for the same reason that a method specs - includes the type of the enclosing type, i.e. the type - gives the "ILGenericArgs" at which the parent type is being used. - - - - - PInvoke attributes. - - - - - Abstract type equivalent to ILPermission list - use helpers - below to construct/destruct these - - - - - Security ILPermissions - - Attached to various structures... - - - - - Method return values - - - - - Marshalling map for parameters. COM Interop only. - - - - - Method parameters and return values - - - - - Custom attributes. See 'decodeILAttribData' for a helper to parse the byte[] - to ILAttribElem's as best as possible. - - - - - Named args: values and flags indicating if they are fields or properties - - - - - Represents a custom attribute parameter of type 'string'. These may be null, in which case they are encoded in a special - way as indicated by Ecma-335 Partition II. - - - - - Member Access - - - - - strictly speakin should be a uint16 - - - - - IL method bodies - - - - - Local variables - - - - - Native Types, for marshalling to the native C interface. - These are taken directly from the ILASM syntax, see ECMA Spec (Partition II, 7.4). - - - - - Field Init - - - - - The 'seh' specification can have several forms: - - FilterCatchBlock - A multi-try-filter-catch block. Execute the - filters in order to determine which 'catch' block to catch the - exception with. There are two kinds of filters - one for - filtering exceptions by type and one by an instruction sequence. - Note that filter blocks can't contain any exception blocks. - - - - - - ILCode - - The code for a method is made up of a "code" object. Each "code" - object gives the contents of the method in a "semi-structured" form, i.e. - 1. The structure implicit in the IL exception handling tables - has been made explicit - 2. No relative offsets are used in the code: all branches and - switch targets are made explicit as labels. - 3. All "fallthroughs" from one basic block to the next have - been made explicit, by adding extra "branch" instructions to - the end of basic blocks which simply fallthrough to another basic - block. - - You can convert a straight-line sequence of instructions to structured - code by using buildILCode and - Most of the interesting code is contained in BasicBlocks. If you're - just interested in getting started with the format then begin - by simply considering methods which do not contain any branch - instructions, or methods which do not contain any exception handling - constructs. - - The above format has the great advantage that you can insert and - delete new code blocks without needing to fixup relative offsets - or exception tables. - - ILBasicBlock(bblock) - See above - - GroupBlock(localDebugInfo, blocks) - A set of blocks, with interior branching between the blocks. For example - B1: ldarg 1 - br B2 - - B2: pop - ret - - will be two basic blocks - let b1 = ILBasicBlock("B1", [| I_ldarg(1); I_br("B2") |]) - let b2 = ILBasicBlock("B2", [| I_arith(AI_pop); I_ret |]) - GroupBlock([], [b1; b2]) - - A GroupBlock can include a list of debug info records for locally - scoped local variables. These indicate that within the given blocks - the given local variables are used for the given Debug info - will only be recorded for local variables - declared in these nodes, and the local variable will only appear live - in the debugger for the instructions covered by this node. So if you - omit or erase these nodes then no debug info will be emitted for local - variables. If necessary you can have one outer ScopeBlock which specifies - the information for all the local variables - - Not all the destination labels used within a group of blocks need - be satisfied by that group alone. For example, the interior "try" code - of "try"-"catch" construct may be: - B1: ldarg 1 - br B2 - - B2: pop - leave B3 - - Again there will be two basic blocks grouped together: - let b1 = ILBasicBlock("B1", [| I_ldarg(1); I_br("B2") |]) - let b2 = ILBasicBlock("B2", [| I_arith(AI_pop); I_leave("B3") |]) - GroupBlock([], [b1; b2]) - Here the code must be embedded in a method where "B3" is a label - somewhere in the method. - - RestrictBlock(labels,code) - This block hides labels, i.e. the given set of labels represent - wiring which is purely internal to the given code block, and may not - be used as the target of a branch by any blocks which this block - is placed alongside. - - For example, if a method is made up of: - B1: ldarg 1 - br B2 - - B2: ret - - then the label "B2" is internal. The overall code will - be two basic blocks grouped together, surrounded by a RestrictBlock. - The label "B1" is then the only remaining visible entry to the method - and execution will begin at that label. - - let b1 = ILBasicBlock("B1", [| I_ldarg(1); I_br("B2") |]) - let b2 = ILBasicBlock("B2", [| I_arith(AI_pop); I_leave("B3") |]) - let gb1 = GroupBlock([], [b1; b2]) - RestrictBlock(["B2"], gb1) - - RestrictBlock is necessary to build well-formed code. - - TryBlock(trycode,seh) - - A try-catch, try-finally or try-fault block. - If an exception is raised while executing - an instruction in 'trycode' then the exception handler given by - 'seh' is executed. - - Well-formedness conditions for code: - - Well-formed code includes nodes which explicitly "hide" interior labels. - For example, the code object for a method may have only one entry - label which is not hidden, and this label will be the label where - execution begins. - - Both filter and catch blocks must have one - and only one entry. These entry labels are not visible - outside the filter and catch blocks. Filter has no - exits (it always uses endfilter), catch may have exits. - The "try" block can have multiple entries, i.e. you can branch - into a try from outside. They can have multiple exits, each of - which will be a "leave". - - - - - - Indicates that a particular local variable has a particular source - language name within a GroupBlock. This does not effect local - variable numbering, which is global over the whole method. - - - - - A list of instructions ending in an unconditionally - branching instruction. A basic block has a label which must be unique - within the method it is located in. Only the first instruction of - a basic block can be the target of a branch. - - - - - The instruction set. - - In general we don't categorize instructions, as different - instruction groups are relevant for different types of operations. - However we do collect the branch and compare instructions together - because they all take an address, and the ILArithInstr ones because - none of them take any direct arguments. - - - - - ILCode labels. In structured code each code label - refers to a basic block somewhere in the code of the method. - - - - - Field specs. The data given for a ldfld, stfld etc. instruction. - - - - - The information at the callsite of a method - - - - - Formal identities of fields. - - - - - Formal identities of methods. Method refs refer to methods on - named types. In general you should work with ILMethodSpec objects - rather than MethodRef objects, because ILMethodSpec objects carry - information about how generic methods are instantiated. MethodRef - objects are only used at a few places in the Abstract IL syntax - and if analyzing or generating IL you will be unlikely to come across - these. - - - - - Actual generic parameters are always types. - - - - - Custom modifiers. - - - - - Reference a generic arg. - - - - - ILCode pointers. - - - - - Managed pointers. - - - - - Unmanaged pointers. Nb. the type is used by tools and for binding only, not by the verifier. - - - - - Reference types. Also may be used for parents of members even if for members in value types. - - - - - Unboxed types, including builtin types. - - - - - Array types - - - - - Used only in return and pointer types. - - - - - True if modifier is "required" - The class of the custom modifier. - The type being modified. - - - - - Which type is being referred to? - - - - - The type instantiation if the type is generic, otherwise empty - - - - - Type specs and types. - - These are the types that appear syntactically in .NET binaries. - - Generic type definitions must be combined with - an instantiation to form a type. Throughout this file, - a "ref" refers to something that is uninstantiated, and - a "spec" to a ref that is combined with the relevant instantiations. - - - - - Where is the type, i.e. is it in this module, in another module in this assembly or in another assembly? - - - - - The name of the type. This also contains the namespace if Enclosing is empty - - - - - The name of the type in the assembly using the '.' notation for nested types - - - - - The list of enclosing type names for a nested type. If non-nil then the first of these also contains the namespace. - - - - - The name of the type in the assembly using the '+' notation for nested types - - - - - Create a ILTypeRef - - - - - Type refs, i.e. references to types in some .NET assembly - - - - - Bounds for a single dimensional, zero based array - - - - - Array shapes. For most purposes, including verification, the - rank is the only thing that matters. - - - - - no 'this' pointer is passed - - - - - accepts an explicit 'this' pointer - - - - - accepts an implicit 'this' pointer - - - - - A reference to a type in another assembly - - - - - A reference to a type in a module in the same assembly - - - - - A reference to the type in the current module - - - - - CLI says this indicates if the assembly can be retargeted (at runtime) to be from a different publisher. - - - - - The fully qualified name of the assembly reference, e.g. mscorlib, Version=1.0.3705 etc. - - - - - Represents an extension to the algebra of instructions - - - - - Represents an extension to the algebra of type kinds - - - - - Extensibility: ignore these unless you are generating ILX - structures directly. - - - - - Debug info. Values of type "source" can be attached at sequence - points and some other locations. - - - - - The type used to store relatively small lists in the Abstract IL data structures, i.e. for ILTypes, ILGenericArgs, ILParameters and ILLocals. - See comments in il.fs for why we've isolated this representation and the possible future choices we might use here. - - - - - Find the full set of assemblies referenced by a module - - - - - Get a version number from a CLR version string, e.g. 1.0.3705.0 - - - - - Get a public key token from a public key. - - - - - Discriminating different important built-in types - - - - - Some commonly used methods - - - - - This is a 'vendor neutral' way of referencing mscorlib. - - - - - Instantiate type variables that occur within types and other items. - - - - - Instantiate type variables that occur within types and other items. - - - - - buildILCode: Build code from a sequence of instructions. - - e.g. "buildILCode meth resolver instrs exns locals" - - This makes the basic block structure of code from more primitive - information, i.e. an array of instructions. - [meth]: for debugging and should give the name of the method. - [resolver]: should return the instruction indexes referred to - by code-label strings in the instruction stream. - [instrs]: the instructions themselves, perhaps with attributes giving - debugging information - [exns]: the table of exception-handling specifications - for the method. These are again given with respect to labels which will - be mapped to pc's by [resolver]. - [locals]: the table of specifications of when local variables are live and - should appear in the debug info. - - If the input code is well-formed, the function will returns the - chop up the instruction sequence into basic blocks as required for - the exception handlers and then return the tree-structured code - corresponding to the instruction stream. - A new set of code labels will be used throughout the resulting code. - - The input can be badly formed in many ways: exception handlers might - overlap, or scopes of local variables may overlap badly with - exception handlers. - - - - - Rescoping. The first argument tells the function how to reference the original scope from - the new scope. - - - - - Rescoping. The first argument tells the function how to reference the original scope from - the new scope. - - - - - Rescoping. The first argument tells the function how to reference the original scope from - the new scope. - - - - - Rescoping. The first argument tells the function how to reference the original scope from - the new scope. - - - - - Rescoping. The first argument tells the function how to reference the original scope from - the new scope. - - - - - Generate references to existing type definitions, method definitions - etc. Useful for generating references, e.g. to a class we're processing - Also used to reference type definitions that we've generated. [ILScopeRef] - is normally ILScopeRef.Local, unless we've generated the ILTypeDef in - an auxiliary module or are generating multiple assemblies at - once. - - - - - Making modules - - - - - Create table of types which is loaded/computed on-demand, and whose individual - elements are also loaded/computed on-demand. Any call to tdefs.AsList will - result in the laziness being forced. Operations can examine the - custom attributes and name of each type in order to decide whether - to proceed with examining the other details of the type. - - Note that individual type definitions may contain further delays - in their method, field and other tables. - - - - - Making tables of custom attributes, etc. - - - - - The toplevel "class" for a module or assembly. - - - - - Given a delegate type definition which lies in a particular scope, - make a reference to its constructor - - - - - Derived functions for making some simple constructors - - - - - Injecting initialization code into a class. - Add some code to the end of the .cctor for a type. Create a .cctor - if one doesn't exist already. - - - - - Injecting code into existing code blocks. A branch will - be added from the given instructions to the (unique) entry of - the code, and the first instruction will be the new entry - of the method. The instructions should be non-branching. - - - - - Make a type definition for a value type used to point to raw data. - These are useful when generating array initialization code - according to the - ldtoken field valuetype '<PrivateImplementationDetails>'/'$$struct0x6000127-1' '<PrivateImplementationDetails>'::'$$method0x6000127-1' - call void System.Runtime.CompilerServices.RuntimeHelpers::InitializeArray(class System.Array,valuetype System.RuntimeFieldHandle) - idiom. - - - - - Make a type definition - - - - - Make field definitions - - - - - Make method definitions - - - - - Make a formal generic parameters - - - - - Derived functions for making return, parameter and local variable - objects for use in method definitions. - - - - - Derived functions for making some common patterns of instructions - - - - - Some more primitive helpers - - - - - Make a basic block. The final instruction must be control flow - - - - - Make some code that is a straight line sequence of instructions, then do - some control flow. The first code label is the entry label of the generated code. - - - - - Make some code that is a straight line sequence of instructions. - The function will add a "return" if the last instruction is not an exiting instruction - - - - - Making code. - - - - - Make custom attributes - - - - - Make generalized verions of possibly-generic types, - e.g. Given the ILTypeDef for List, return the type "List<T>". - - - - - Construct references to fields - - - - - Construct references to constructors - - - - - Construct references to static, non-generic methods - - - - - Construct references to static methods - - - - - Construct references to instance methods - - - - - Construct references to instance methods - - - - - Construct references to methods on a given type - - - - - Make method references and specs - - - - - Make types - - - - - Make type specs - - - - - Make type refs - - - - - Generate simple references to assemblies and modules - - - - - Note: not all custom attribute data can be decoded without binding types. In particular - enums must be bound in order to discover the size of the underlying integer. - The following assumes enums have size int32. - - - - - When writing a binary the fake "toplevel" type definition (called <Module>) - must come first. This function puts it first, and creates it in the returned list as an empty typedef if it - doesn't already exist. - - - - - Build the table of commonly used references given a ILScopeRef for system runtime assembly. - - - - - splitTypeNameRight is like splitILTypeName except the - namespace is kept as a whole string, rather than split at dots. - - - - - The splitILTypeName utility helps you split a string representing - a type name into the leading namespace elements (if any), the - names of any nested types and the type name itself. This function - memoizes and interns the splitting of the namespace portion of - the type name. - - - - - Find the method definition corresponding to the given property or - event operation. These are always in the same class as the property - or event. This is useful especially if your code is not using the Ilbind - API to bind references. - - - - - The "unlinked" view of .NET metadata and code. Central to - to Abstract IL library - - - - - Printer for the abstract syntax. - - - - - Open a binary reader based on the given bytes. - - - - - Open a binary reader, except first copy the entire contents of the binary into - memory, close the file and ensure any subsequent reads happen from the in-memory store. - PDB files may not be read with this option. - - - - - Binary reader. Read a .NET binary and concert it to Abstract IL data - structures. - - Notes: - - The metadata in the loaded modules will be relative to - those modules, e.g. ILScopeRef.Local will mean "local to - that module". You must use [rescopeILType] etc. if you want to include - (i.e. copy) the metadata into your own module. - - - PDB (debug info) reading/folding: - The PDB reader is invoked if you give a PDB path - This indicates if you want to search for PDB files and have the - reader fold them in. You cannot currently name the pdb file - directly - you can only name the path. Giving "None" says - "do not read the PDB file even if one exists" - - The debug info appears primarily as I_seqpoint annotations in - the instruction streams. Unfortunately the PDB information does - not, for example, tell you how to map back from a class definition - to a source code line number - you will need to explicitly search - for a sequence point in the code for one of the methods of the - class. That is not particularly satisfactory, and it may be - a good idea to build a small library which extracts the information - you need. - - - - - Write a binary to the file system. Extra configuration parameters can also be specified. - - - - - The IL Binary writer - - - - - The (local) emitter env (state). Some of these fields are effectively global accumulators - and could be placed as hash tables in the global environment. - - - - - The global environment - - - - - Emit the tail. prefix if necessary - - - - - Emit the align. prefix - - - - - Emit the volatile. prefix - - - - -Emit comparison instructions - - - - - Uses the .CreateType() for emitted type (if available) - - - - - Uses TypeBuilder/TypeBuilderInstantiation for emitted types - - - - - Convert an Abstract IL type reference to Reflection.Emit System.Type value - - - - - Imperative buffers and streams of byte[] - - - - - Maps with a specific comparison function - - - - - Sets with a specific comparison function - - - - - Various constants and utilities used when parsing the ILASM format for IL - - - - - vararg sentinels - - - - - This function maps production indexes returned in syntax errors to strings representing the non terminal that would be produced by that production - - - - - Compiler use only. Code and constants shared between binary reader/writer. - - - - - each int will be 0 <= x <= 255 - - - - - each int must be 0 <= x <= 255 - - - - - returned int will be 0 <= x <= 255 - - - - - Immutable map collection, with explicit flattening to a backing dictionary - - - - - A helper to ensure we rethrow the "original" exception - - - - - This field holds either the function to run or a LazyWithContextFailure object recording the exception raised - from running the function. It is null if the thunk has been evaluated successfully. - - - - - This field holds the result of a successful computation. It's initial value is Unchecked.defaultof - - - - - Just like "Lazy" but EVERY forcer must provide an instance of "ctxt", e.g. to help track errors - on forcing back to at least one sensible user location - - - - - Computations that can cooperatively yield by returning a continuation - - - Any yield of a NotYetDone should typically be "abandonable" without adverse consequences. No resource release - will be called when the computation is abandoned. - - - Computations suspend via a NotYetDone may use local state (mutables), where these are - captured by the NotYetDone closure. Computations do not need to be restartable. - - - The key thing is that you can take an Eventually value and run it with - Eventually.repeatedlyProgressUntilDoneOrTimeShareOver - - - - - Get an initialization hole - - - - - Take in a filename with an absolute path, and return the same filename - but canonicalized with respect to extra path separators (e.g. C:\\\\foo.txt) - and '..' portions - - - - - For every entry in m2 find an entry in m1 and fold - - - - - Union entries by identical key, using the provided function to union sets of values - - - - - Not a very useful function - only called in one place - should be changed - - - - - Keep running the computation bit by bit until a time limit is reached. - The runner gets called each time the computation is restarted - - - - - PDB reader and associated types - - - - - Unmanaged resource file linker - for native resources (not managed ones). - The function may be called twice, once with a zero-RVA and - arbitrary buffer, and once with the real buffer. The size of the - required buffer is returned. - - - - - Takes the output file name and returns debug file name. - - - - - Functions associated with writing binaries which - vary between supported implementations of the CLI Common Language - Runtime, e.g. between the SSCLI, Mono and the Microsoft CLR. - - The implementation of the functions can be found in ilsupp-*.fs - - - - - Morph all type references throughout an entire module. - - - - - Morph all tables of ILTypeDefs in "ILModuleDef" - - - - - nb. does not do nested tdefs - - - - - Morph each scope reference inside a type signature - - - - - A set of "IL rewrites" ("morphs"). These map each sub-construct - of particular ILTypeDefs. The morphing functions are passed - some details about the context in which the item being - morphed occurs, e.g. the module being morphed itself, the - ILTypeDef (possibly nested) where the item occurs, - the ILMethodDef (if any) where the item occurs. etc. - - - - - Generates compiler-generated names marked up with a source code location, but if given the same unique value then - return precisely the same name. Each name generated also includes the StartLine number of the range passed in - at the point of first generation. - - - - - Generates compiler-generated names. Each name generated also includes the StartLine number of the range passed in - at the point of first generation. - - - - - The parser defines a number of tokens for whitespace and - comments eliminated by the lexer. These carry a specification of - a continuation for the lexer for continued processing after we've dealt with - the whitespace. - - - - - Specifies how the 'endline' function in the lexer should continue after - it reaches end of line or eof. The options are to continue with 'token' function - or to continue with 'skip' function. - - - - - The syntactic elements associated with the "return" of a function or method. Some of this is - mostly dummy information to make the return element look like an argument, - the important thing is that (a) you can give a return type for the function or method, and - (b) you can associate .NET attributes to return of a function or method and these get stored in .NET metadata. - - - - - ImplFile(modname,isScript,qualName,hashDirectives,modules,isLastCompiland) - QualifiedNameOfFile acts to fully-qualify module specifications and implementations, - most importantly the ones that simply contribute fragments to a namespace (i.e. the ParsedSigFileFragment.NamespaceFragment case) - There may be multiple such fragments in a single assembly. There may thus also - be multiple matching pairs of these in an assembly, all contributing types to the same - namespace. - - - - - SynModuleOrNamespace(lid,isModule,decls,xmlDoc,attribs,SynAccess,m) - - - - - SynMemberDefn.AutoProperty (attribs,isStatic,id,tyOpt,propKind,memberFlags,xmlDoc,access,synExpr,mGetSet,mWholeAutoProp). - - F# syntax: 'member val X = expr' - - - - - A feature that is not implemented - - - - - LetBindings(bindingList, isStatic, isRecursive, wholeRange) - - localDefns - - - - - inherit <typ>(args...) as base - - - - - implicit ctor args as a defn line, 'as' specification - - - - - 'exception E = ... with ...' - - - - - 'exception E = ... ' - - - - - The names and other metadata for the type parameters for a member or function - - - - - The argument names and other metadata for a parameter for a member or function - - - - - SynValInfo(curriedArgInfos, returnInfo) - - - - - The argument names and other metadata for a member or function - - - - - The untyped, unchecked syntax tree associated with the name of a type definition or module - in signature or implementation. - - THis includes the name, attributes, type parameters, constraints, documentation and accessibility - for a type definition or module. For modules, entries such as the type parameters are - always empty. - - - - - The untyped, unchecked syntax tree for a field declaration in a record or class - - - - - The information for a type definition in a signature - - - - - The untyped, unchecked syntax tree for a type definition in a signature - - - - - Indicates the right right-hand-side is a record, union or other simple type. - - - - - Indicates the right right-hand-side is a class, struct, interface or other object-model type - - - - - The untyped, unchecked syntax tree for the right-hand-side of a type definition in a signature. - Note: in practice, using a discriminated union to make a distinction between - "simple" types and "object oriented" types is not particularly useful. - - - - - Full type spec given by 'UnionCase : ty1 * tyN -> rty'. Only used in FSharp.Core, otherwise a warning. - - - - - Normal style declaration - - - - - The untyped, unchecked syntax tree for the right-hand-side of union definition, excluding members, - in either a signature or implementation. - - - - - The untyped, unchecked syntax tree for one case in a union definition. - - - - - The untyped, unchecked syntax tree for one case in an enum definition. - - - - - An abstract definition , "type X" - - - - - A type abbreviation, "type X = A.B.C" - - - - - A type defined by using an IL assembly representation. Only used in FSharp.Core. - - F# syntax: "type X = (# "..."#) - - - - - An object oriented type definition. This is not a parse-tree form, but represents the core - type representation which the type checker splits out from the "ObjectModel" cases of type definitions. - - - - - A record type definition, type X = { A : int; B : int } - - - - - An enum type definition, type X = A = 1 | B = 2 - - - - - A union type definition, type X = A | B - - - - - The untyped, unchecked syntax tree for the core of a simple type definition, in either signature - or implementation. - - - - - The untyped, unchecked syntax tree for a member signature, used in signature files, abstract member declarations - and member constraints. - - - - - An artifical member kind used prior to the point where a get/set property is split into two distinct members. - - - - - Note the member kind is actually computed partially by a syntax tree transformation in tc.fs - - - - - Is this attribute being applied to a property getter or setter? - - - - - Target specifier, e.g. "assembly","module",etc. - - - - - A pattern arising from a parse error - - - - - Used internally in the type checker - - - - - Deprecated character ranges - - - - - &lt;@ expr @&gt;, used for active pattern arguments - - - - - ':? type ' - - - - - '?id' -- for optional argument names - - - - - 'null' - - - - - Represents a simple set of variable bindings a, (a,b) or (a:Type,b:Type) at a lambda, - function definition or other binding point, after the elimination of pattern matching - from the construct, e.g. after changing a "function pat1 -> rule1 | ..." to a - "fun v -> match v with ..." - - - - - We have decided to use an alternative name in tha pattern and related expression - - - - - We have not decided to use an alternative name in tha pattern and related expression - - - - - Id (ident, altNameRefCell, isCompilerGenerated, isThisVar, isOptArg, range) - - Indicates a simple pattern variable. - - altNameRefCell - Normally 'None' except for some compiler-generated variables in desugaring pattern matching. - Pattern processing sets this reference for hidden variable introduced by desugaring pattern matching in arguments. - The info indicates an alternative (compiler generated) identifier to be used because the name of the identifier is already bound. - See Product Studio FSharp 1.0, bug 6389. - - isCompilerGenerated : true if a compiler generated name - isThisVar: true if 'this' variable in member - isOptArg: true if a '?' is in front of the name - - - - - Inserted for error recovery when there is "expr." and missing tokens or error recovery after the dot - - - - - Inserted for error recovery - - - - - Inserted for error recovery - - - - - Only used in FSharp.Core - - - - - Only used in FSharp.Core - - - - - Only used in FSharp.Core - - - - - Only used in FSharp.Core - - - - - F# syntax: do! expr - Computation expressions only - - - - - SynExpr.LetOrUseBang(spBind, isUse, isFromSource, pat, rhsExpr, bodyExpr, mWholeExpr). - - F# syntax: let! pat = expr in expr - F# syntax: use! pat = expr in expr - Computation expressions only - - - - - F# syntax: yield! expr - F# syntax: return! expr - Computation expressions only - - - - - F# syntax: yield expr - F# syntax: return expr - Computation expressions only - - - - - F# syntax: <implicit> - Computation expressions only, implied by final "do" or "do!" - - - - - F# syntax: ... in ... - Computation expressions only, based on JOIN_IN token from lex filter - - - - - F# syntax: ((typar1 or ... or typarN): (member-dig) expr) - - - - - F# syntax: &expr, &&expr - - - - - F# syntax: null - - - - - F# syntax: downcast expr - - - - - F# syntax: upcast expr - - - - - F# syntax: expr :?> type - - - - - F# syntax: expr :> type - - - - - F# syntax: expr :? type - - - - - F# syntax: expr.Items(e1) <- e2 , rarely used named-property-setter notation, e.g. (stringExpr).Chars(3) <- 'a' - - - - - F# syntax: Type.Items(e1) <- e2 , rarely used named-property-setter notation, e.g. Foo.Bar.Chars(3) <- 'a' - - - - - DotIndexedSet (objectExpr, indexExprs, valueExpr, rangeOfLeftOfSet, rangeOfDot, rangeOfWholeExpr) - - F# syntax: expr.[expr,...,expr] <- expr - - - - - F# syntax: expr.[expr,...,expr] - - - - - F# syntax: expr.ident...ident <- expr - - - - - DotGet(expr, rangeOfDot, lid, wholeRange) - - F# syntax: expr.ident.ident - - - - - F# syntax: ident.ident...ident <- expr - - - - - F# syntax: ident.ident...ident - LongIdent(isOptional, longIdent, altNameRefCell, m) - isOptional: true if preceded by a '?' for an optional named parameter - altNameRefCell: Normally 'None' except for some compiler-generated variables in desugaring pattern matching. See SynSimplePat.Id - - - - - F# syntax: ident - Optimized representation, = SynExpr.LongIdent(false,[id],id.idRange) - - - - - IfThenElse(exprGuard,exprThen,optionalExprElse,spIfToThen,isFromErrorRecovery,mIfToThen,mIfToEndOfLastBranch) - - F# syntax: if expr then expr - F# syntax: if expr then expr else expr - - - - - Seq(seqPoint, isTrueSeq, e1, e2, m) - isTrueSeq: false indicates "let v = a in b; v" - - F# syntax: expr; expr - - - - - F# syntax: lazy expr - - - - - F# syntax: try expr finally expr - - - - - F# syntax: try expr with pat -> expr - - - - - LetOrUse(isRecursive, isUse, bindings, body, wholeRange) - - F# syntax: let pat = expr in expr - F# syntax: let f pat1 .. patN = expr in expr - F# syntax: let rec f pat1 .. patN = expr in expr - F# syntax: use pat = expr in expr - - - - - TypeApp(expr, mLessThan, types, mCommas, mGreaterThan, mTypeArgs, mWholeExpr) - "mCommas" are the ranges for interstitial commas, these only matter for parsing/design-time tooling, the typechecker may munge/discard them - - F# syntax: expr<type1,...,typeN> - - - - - App(exprAtomicFlag, isInfix, funcExpr, argExpr, m) - - exprAtomicFlag: indicates if the application is syntactically atomic, e.g. f.[1] is atomic, but 'f x' is not - - isInfix is true for the first app of an infix operator, e.g. 1+2 becomes App(App(+,1),2), where the inner node is marked isInfix - (or more generally, for higher operator fixities, if App(x,y) is such that y comes before x in the source code, then the node is marked isInfix=true) - - F# syntax: f x - - - - - F# syntax: assert expr - - - - - F# syntax: do expr - - - - - F# syntax: match expr with pat1 -> expr | ... | patN -> exprN - - - - - F# syntax: function pat1 -> expr | ... | patN -> exprN - - - - - First bool indicates if lambda originates from a method. Patterns here are always "simple" - Second bool indicates if this is a "later" part of an iterated sequence of lambdas - - F# syntax: fun pat -> expr - - - - - CompExpr(isArrayOrList, isNotNakedRefCell, expr) - - F# syntax: { expr } - - - - - F# syntax: [ expr ], [| expr |] - - - - - SynExpr.ForEach (spBind, seqExprOnly, isFromSource, pat, enumExpr, bodyExpr, mWholeExpr). - - F# syntax: 'for ... in ... do ...' - - - - - F# syntax: 'for i = ... to ... do ...' - - - - - F# syntax: 'while ... do ...' - - - - - SynExpr.ObjExpr(objTy,argOpt,binds,extraImpls,mNewExpr,mWholeExpr) - - F# syntax: { new ... with ... } - - - - - F# syntax: new C(...) - The flag is true if known to be 'family' ('protected') scope - - - - - F# syntax: { f1=e1; ...; fn=en } - SynExpr.Record((baseType, baseCtorArgs, mBaseCtor, sepAfterBase, mInherits), (copyExpr, sepAfterCopyExpr), (recordFieldName, fieldValue, sepAfterField), mWholeExpr) - inherit includes location of separator (for tooling) - copyOpt contains range of the following WITH part (for tooling) - every field includes range of separator after the field (for tooling) - - - - - F# syntax: [ e1; ...; en ], [| e1; ...; en |] - - - - - F# syntax: e1, ..., eN - - - - - F# syntax: expr : type - - - - - F# syntax: 1, 1.3, () etc. - - - - - F# syntax: <@ expr @>, <@@ expr @@> - - Quote(operator,isRaw,quotedSynExpr,isFromQueryExpression,m) - - - - - F# syntax: (expr) - - Paren(expr, leftParenRange, rightParenRange, wholeRangeIncludingParentheses) - - Parenthesized expressions. Kept in AST to distinguish A.M((x,y)) - from A.M(x,y), among other things. - - - - - range ignoring any (parse error) extra trailing dots - - - - - Attempt to get the range of the first token or initial portion only - this is extremely ad-hoc, just a cheap way to improve a certain 'query custom operation' error range - - - - - Get the syntactic range of source code covered by this construct. - - - - - F# syntax : ident=1 etc., used in static parameters to type providers - - - - - F# syntax : const expr, used in static parameters to type providers - - - - - F# syntax : 1, "abc" etc, used in parameters to type providers - For the dimensionless units i.e. 1 , and static parameters to provided types - - - - - F# syntax : for units of measure e.g. m^3, kg^1/2 - - - - - F# syntax : for units of measure e.g. m / s - - - - - F# syntax : #type - - - - - F# syntax : typ with constraints - - - - - F# syntax : _ - - - - - F# syntax : 'Var - - - - - F# syntax : type -> type - - - - - F# syntax : type[] - - - - - F# syntax : type * ... * type - - - - - LongIdentApp(typeName, longId, LESSm, tyArgs, commasm, GREATERm, wholem) - - F# syntax : type.A.B.C<type, ..., type> - commasm: ranges for interstitial commas, these only matter for parsing/design-time tooling, the typechecker may munge/discard them - - - - - App(typeName, LESSm, typeArgs, commasm, GREATERm, isPostfix, m) - - F# syntax : type<type, ..., type> or type type or (type,...,type) type - isPostfix: indicates a postfix type application e.g. "int list" or "(int,string) dict" - commasm: ranges for interstitial commas, these only matter for parsing/design-time tooling, the typechecker may munge/discard them - - - - - F# syntax : A.B.C - - - - - Get the syntactic range of source code covered by this construct. - - - - - The unchecked abstract syntax tree of F# types - - - - - F# syntax is 'typar : delegate<'Args,unit> - - - - - F# syntax is 'typar : enum<'UnderlyingType> - - - - - F# syntax is ^T : (static member MemberName : ^T * int -> ^T) - - - - - F# syntax is 'typar :> type - - - - - F# syntax is default ^T : type - - - - - F# syntax is 'typar : equality - - - - - F# syntax is 'typar : comparison - - - - - F# syntax is 'typar : null - - - - - F# syntax is 'typar : unmanaged - - - - - F# syntax : is 'typar : not struct - - - - - F# syntax : is 'typar : struct - - - - - The unchecked abstract syntax tree of F# type constraints - - - - - Represents the explicit declaration of a type parameter - - - - - A 'do' binding in a module. Must have type 'unit' - - - - - A normal 'let' binding in a module - - - - - A standalone expression in a module - - - - - The kind associated with a binding - "let", "do" or a standalone expression - - - - - Says that the expression is an atomic expression, i.e. is of a form that has no whitespace unless - enclosed in parentheses, e.g. 1, "3", ident, ident.[expr] and (expr). If an atomic expression has - type T, then the largest expression ending at the same range as the atomic expression also has type T. - - - - - stores pair: record field name + (true if given record field name is syntactically correct and can be used in name resolution) - - - - - denotes location of the separator block + optional position of the semicolon (used for tooling support) - - - - - Indicates if a for loop is 'for x in e1 -> e2', only valid in sequence expressions - - - - - The unchecked abstract syntax tree of F# unit of measure exponents. - - - - - The unchecked abstract syntax tree of F# unit of measure annotations. - This should probably be merged with the representation of SynType. - - - - - Old comment: "we never iterate, so the const here is not another SynConst.Measure" - - - - - Used internally in the typechecker once an array of unit16 constants - is detected, to allow more efficient processing of large arrays of uint16 constants. - - - - - F# syntax: verbatim or regular byte string, e.g. "abc"B. - - Also used internally in the typechecker once an array of unit16 constants - is detected, to allow more efficient processing of large arrays of uint16 constants. - - - - - F# syntax: verbatim or regular string, e.g. "abc" - - - - - UserNum(value, suffix) - - F# syntax: 1Q, 1Z, 1R, 1N, 1G - - - - - F# syntax: 23.4M - - - - - F# syntax: 'a' - - - - - F# syntax: 1.30, 1.40e10 etc. - - - - - F# syntax: 1.30f, 1.40e10f etc. - - - - - F# syntax: 13un - - - - - F# syntax: 13n - - - - - F# syntax: 13UL - - - - - F# syntax: 13L - - - - - F# syntax: 13u, 0x4000u, 0o0777u - - - - - F# syntax: 13, 0x4000, 0o0777 - - - - - F# syntax: 13us, 0x4000us, 0o0777us, 0b0111101us - - - - - F# syntax: 13s, 0x4000s, 0o0777s, 0b0111101s - - - - - F# syntax: 13uy, 0x40uy, 0oFFuy, 0b0111101uy - - - - - F# syntax: 13y, 0xFFy, 0o077y, 0b0111101y - - - - - F# syntax: true, false - - - - - F# syntax: () - - - - - The unchecked abstract syntax tree of constants in F# types and expressions. - - - - - LongIdentWithDots(lid, dotms) - Typically dotms.Length = lid.Length-1, but they may be same if (incomplete) code ends in a dot, e.g. "Foo.Bar." - The dots mostly matter for parsing, and are typically ignored by the typechecker, but - if dotms.Length = lid.Length, then the parser must have reported an error, so the typechecker is allowed - more freedom about typechecking these expressions. - LongIdent can be empty list - it is used to denote that name of some AST element is absent (i.e. empty type name in inherit) - - - - - Used to collect XML documentation during lexing and parsing. - - - - - Reset the generator used for compiler-generated argument names. - - - - - Get the generator used for compiler-generated argument names. - - - - - Get the range corresponding to one of the r.h.s. symbols of a grammar rule while it is being reduced - - - - - Get the range covering two of the r.h.s. symbols of a grammar rule while it is being reduced - - - - - Get the range corresponding to the result of a grammar rule while it is being reduced - - - - - Get an F# compiler range from a lexer range - - - - - Get an F# compiler position from a lexer position - - - - - Helper for parsing the inline IL fragments. - - - - - Helper for parsing the inline IL fragments. - - - - - "fun (UnionCase x) (UnionCase y) -> body" - ==> - "fun tmp1 tmp2 -> - let (UnionCase x) = tmp1 in - let (UnionCase y) = tmp2 in - body" - - - - - Push non-simple parts of a patten match over onto the r.h.s. of a lambda. - Return a simple pattern and a function to build a match on the r.h.s. if the pattern is complex - - - - - Recognize the '()' in 'new()' - - - - - Extract the argument for patterns corresponding to the declaration of 'new ... = ...' - - - - - This affects placement of sequence points - - - - - Match a long identifier, including the case for single identifiers which gets a more optimized node in the syntax tree. - - - - - The prefix of the names used for the fake namespace path added to all dynamic code entries in FSI.EXE - - - - - The error raised by the parse_error_rich function, which is called by the parser engine - when a syntax error occurs. The first object is the ParseErrorContext which contains a dump of - information about the grammar at the point where the error occured, e.g. what tokens - are valid to shift next at that point in the grammar. This information is processed in CompileOps.fs. - - - - - Called from the parser each time we parse a construct that marks the end of an XML doc comment range, - e.g. a 'type' declaration. The markerRange is the range of the keyword that delimits the construct. - - - - - Called from the lexer to save a single line of XML doc comment. - - - - - XmlDoc F# lexer/parser state, held in the BufferLocalStore for the lexer. - This is the only use of the lexer BufferLocalStore in the codebase. - - - - - Infer the syntactic information for a 'let' or 'member' definition, based on the argument pattern, - any declared return information (e.g. .NET attributes on the return element), and the r.h.s. expression - in the case of 'let' definitions. - - - - - For 'let' definitions, we infer syntactic argument information from the r.h.s. of a definition, if it - is an immediate 'fun ... -> ...' or 'function ...' expression. This is noted in the F# language specification. - This does not apply to member definitions. - - - - - Transform a property declared using '[static] member P = expr' to a method taking a "unit" argument. - This is similar to IncorporateEmptyTupledArgForPropertyGetter, but applies to member definitions - rather than member signatures. - - - - - Make sure only a solitary unit argument has unit elimination - - - - - Infer the syntactic argument info for one or more arguments a pattern. - - - - - Infer the syntactic argument info for one or more arguments one or more simple patterns. - - - - - Infer the syntactic argument info for a single argument from a simple pattern. - - - - - Get the argument attributes from the syntactic information for an argument. - - - - - Get the argument counts for each curried argument group. Used in some adhoc places in tc.fs. - - - - - Add a parameter entry to the syntactic value information to represent the value argument for a property setter. This is - used for the implicit value argument in property setter signature specifications. - - - - - Add a parameter entry to the syntactic value information to represent the 'this' argument. This is - used for the implicit 'this' argument in member signature specifications. - - - - - Add a parameter entry to the syntactic value information to represent the '()' argument to a property getter. This is - used for the implicit '()' argument in property getter signature specifications. - - - - - Check if there are any optional arguments in the syntactic argument information. Used when adjusting the - types of optional arguments for function and member signatures. - - - - - Check if one particular argument is an optional argument. Used when adjusting the - types of optional arguments for function and member signatures. - - - - - Determine if a syntactic information represents a member without arguments (which is implicitly a property getter) - - - - - The 'argument' information for the 'this'/'self' parameter in the cases where it is not given explicitly - - - - - The 'argument' information for a return value where no attributes are given for the return value (the normal case) - - - - - The argument information for a '()' argument - - - - - The argument information for a curried argument without a name - - - - - The argument information for an argument without a name - - - - - Operations related to the syntactic analysis of arguments of value, function and member definitions and signatures. - - Function and member definitions have strongly syntactically constrained arities. We infer - the arity from the syntax. - - For example, we record the arity for: - StaticProperty --> [1] -- for unit arg - this.InstanceProperty --> [1;1] -- for unit arg - StaticMethod(args) --> map InferSynArgInfoFromSimplePat args - this.InstanceMethod() --> 1 :: map InferSynArgInfoFromSimplePat args - this.InstanceProperty with get(argpat) --> 1 :: [InferSynArgInfoFromSimplePat argpat] - StaticProperty with get(argpat) --> [InferSynArgInfoFromSimplePat argpat] - this.InstanceProperty with get() --> 1 :: [InferSynArgInfoFromSimplePat argpat] - StaticProperty with get() --> [InferSynArgInfoFromSimplePat argpat] - - this.InstanceProperty with set(argpat)(v) --> 1 :: [InferSynArgInfoFromSimplePat argpat; 1] - StaticProperty with set(argpat)(v) --> [InferSynArgInfoFromSimplePat argpat; 1] - this.InstanceProperty with set(v) --> 1 :: [1] - StaticProperty with set(v) --> [1] - - - - - This predicate can be used once type inference is complete, before then it is an approximation - that doesn't assert any new constraints - - - - - Generate the hash/compare functions we add to user-defined types by default. - - - - - Rewrite mutable locals to reference cells across an entire implementation file - - - - - Rewrite bindings for mutable locals which we are transforming - - - - - Rewrite fetches, stores and address-of expressions for mutable locals which we are transforming - - - - - Find all the mutable locals to promote to reference cells in an implementation file - - - - - Find all the mutable locals that escape a set of bindings - - - - - Find all the mutable locals that escape a binding - - - - - Find all the mutable locals that escape a lambda expression or object expression - - - - -Special cases where representation uses Lambda. - - - - - Find all the mutable locals that escape a lambda expression, ignoring the arguments to the lambda - - - - - Find all the mutable locals that escape a method, function or lambda expression - - - - - Parse "printf-style" format specifiers at compile time, producing - a list of items that specify the types of the things that follow. - - Must be updated if the Printf runtime component is updated. - - - - - *Parse* warnings seen while parsing root of closure - - - - - *Parse* errors seen while parsing root of closure - - - - - The #nowarns - - - - - The list of all sources in the closure with inputs when available - - - - - The list of references that were not resolved during load closure. These may still be extension references. - - - - - The resolved references along with the ranges of the #r positions in each file. - - - - - The source files along with the ranges of the #load positions in each file. - - - - - Used from fsi.fs and fsc.fs, for #load and command line. The resulting references are then added to a TcConfig. - - - - - Get the typing environment implied by the set of signature files and/or inferred signatures of implementation files checked so far - - - - - Get the typing environment implied by the set of implemetation files checked so far - - - - - The inferred contents of the assembly, containing the signatures of all implemented files. - - - - - The CcuThunk for the current assembly being checked - - - - - Represents the incremental type checking state for a set of inputs - - - - - Try to resolve a referenced assembly based on TcConfig settings. - - - - - Try to find a provider-generated assembly - - - - - Try to find the given assembly reference. - - - - - Resolve a referenced assembly and report an error if the resolution fails. - - - - - Report unresolved references that also weren't consumed by any type providers. - - - - - This excludes any framework imports (which may be shared between multiple builds) - - - - - Repreesnts a table of imported assemblies with their resolutions. - - - - - Represents a resolved imported assembly - - - - - Represents a resolved imported binary - - - - - Get a TcConfigProvider which will return only the exact TcConfig. - - - - - Get a TcConfigProvider which will continue to respect changes in the underlying - TcConfigBuilder rather than delivering snapshots. - - - - - Represents a computation to return a TcConfig. Normally this is just a constant immutable TcConfig, - but for F# Interactive it may be based on an underlying mutable TcConfigBuilder. - - - - - Set if the user has explicitly turned indentation-aware syntax on/off - - - - - If true, indicates all type checking and code generation is in the context of fsi.exe - - - - - File system query based on TcConfig settings - - - - - File system query based on TcConfig settings - - - - - Get the loaded sources that exist and issue a warning for the ones that don't - - - - - If true, indicates all type checking and code generation is in the context of fsi.exe - - - - - Sources added into the build with #load - - - - - Set if the user has explicitly turned indentation-aware syntax on/off - - - - - Represents the file or string used for the --version flag - - - - - Whether or not this is an installed system assembly (for example, System.dll) - - - - - Name of the redist, if any, that the assembly was found in. - - - - - The qualified name of the assembly - - - - - Search path used to find this spot. - - - - - Path to the resolvedFile - - - - - The original reference to the assembly. - - - - - The name of the assembly file generated by the project - - - - - Get the logical timestamp that would be the timestamp of the assembly file generated by the project - - - - - Evaluate raw contents of the assembly file generated by the project - - - - - The identity of the module - - - - - The raw IL module definition in the assembly, if any. This is not present for cross-project references - in the language service - - - - - The table of type forwarders in the assembly - - - - - The raw F# signature data in the assembly, if any - - - - - The raw F# optimization data in the assembly, if any - - - - - The raw list InternalsVisibleToAttribute attributes in the assembly - - - - - The raw list AutoOpenAttribute attributes in the assembly - - - - - Represents a reference to an F# assembly. May be backed by a real assembly on disk (read by Abstract IL), or a cross-project - reference in FSharp.Compiler.Service. - - - - - Represents the style being used to format errros - - - - - Indicates if we should report a warning as an error - - - - - Indicates if we should report a warning - - - - - Check a single input and finish the checking - - - - - Check a closed set of inputs - - - - - Finish the checking of a closed set of inputs - - - - - Finish the checking of multiple inputs - - - - - Check one input, returned as an Eventually computation - - - - - Get the initial type checking state for a set of inputs - - - - - Get the initial type checking environment including the loading of mscorlib/System.Core, FSharp.Core - applying the InternalsVisibleTo in referenced assemblies and opening 'Checked' if requested. - - - - - Parse one input file - - - - - This list is the default set of references for "non-project" files. - - - - - Get an error logger that filters the reporting of warnings based on scoped pragma information - - - - - Find the scoped #nowarn pragmas with their range information - - - - - Process the #nowarn in an input - - - - - Process all the #r, #I etc. in an input - - - - - Processing # commands - - - - - Process #r in F# Interactive. - Adds the reference to the tcImports and add the ccu to the type checking environment. - - - - - Write F# optimization data as an IL resource - - - - - Write F# signature data as an IL resource - - - - - Determine if an IL resource attached to an F# assemnly is an F# quotation data resource for reflected definitions - - - - - Determine if an IL resource attached to an F# assemnly is an F# optimization data resource - - - - - Determine if an IL resource attached to an F# assemnly is an F# signature data resource - - - - - Output extra context information for an error or warning to a buffer - - - - - Output an error or warning to a buffer - - - - - Output an error to a buffer - - - - - Split errors into a "main" error and a set of associated errors - - - - - Get the number associated with an error - - - - - Get the location associated with an error - - - - - Get the name used for FSharp.Core - - - - - File suffixes where #light is the default - - - - - Script file suffixes - - - - - Implementation file suffixes - - - - - Signature file suffixes - - - - - Coordinating compiler operations - configuration, loading initial context, reporting errors etc. - - - - - CompilerOption(name, argumentDescriptionString, actionSpec, exceptionOpt, helpTextOpt - - - - - The spec value describes the action of the argument, - and whether it expects a following parameter. - - - - - Parse and process a set of compiler options - - - - - A function that denotes captured tcVal, Used in constraint solver and elsewhere to get appropriate expressions for a ValRef. - - - - - Given a set of formal type parameters and their constraints, make new inference type variables for - each and ensure that the constraints on the new type variables are adjusted to refer to these. - - - - - Create a list of inference type variables, one for each element in the input list - - - - - Create an inference type variable representing an error condition when checking a measure - - - - - Create an inference type variable representing an error condition when checking an expression - - - - - Create an inference type variable - - - - - Create a type variable representing the use of a "_" in F# code - - - - - Solves constraints using a mutable constraint-solver state - - - - - top of expr toplevel? (true) - - - - - val not defined under lambdas - - - - - v -> recursive? * v list -- the others in the mutual binding - - - - - bound in a decision tree? - - - - - v -> binding repr - - - - - v -> context / APP inst args - - - - - Results is "expr information". - This could extend to be a full graph view of the expr. - Later could support "safe" change operations, and optimisations could be in terms of those. - - - - - Proccess the given set of command line arguments - - - - - Read the bytes from a resource local to an assembly - - - - - Type holds thread-static globals for use by the compile - - - - - This is the textual subcategory to display in error and warning messages (shows only under --vserrors): - - file1.fs(72): subcategory warning FS0072: This is a warning message - - - - - - Return true if the textual phase given is from the compile part of the build process. - This set needs to be equal to the set of subcategories that the language service can produce. - - - - - Return true if this phase is one that's known to be part of the 'compile'. This is the initial phase of the entire compilation that - the language service knows about. - - - - - Construct a phased error - - - - - Closed enumeration of build phases. - - - - - fixes given string by replacing all control chars with spaces. - NOTE: newlines are recognized and replaced with stringThatIsAProxyForANewlineInFlatErrors (ASCII 29, the 'group separator'), - which is decoded by the IDE with 'NewlineifyErrorString' back into newlines, so that multi-line errors can be displayed in QuickInfo - - - - - Stop on first error. Accumulate warnings and continue. - - - - - Stop on first error. Report index - - - - - Stop on first error. Accumulate warnings and continue. - - - - - Stop on first error. Accumulate warnings and continue. - - - - - The bind in the monad. Stop on first error. Accumulate warnings and continue. - - - - - NOTE: The change will be undone when the returned "unwind" object disposes - - - - - NOTE: The change will be undone when the returned "unwind" object disposes - - - - - When no errorLogger is installed (on the thread) use this one. - - - - - Thrown when we stop processing the F# Interactive entry or #load. - - - - - Thrown when immediate, local error recovery is not possible. This indicates - we've reported an error but need to make a non-local transfer of control. - Error recovery may catch this and continue (see 'errorRecovery') - - The exception that caused the report is carried as data because in some - situations (LazyWithContext) we may need to re-report the original error - when a lazy thunk is re-evaluated. - - - - - Thrown when want to add some range information to some .NET exception - - - - - Literal build phase subcategory strings. - - - - - The table of remappings from type names in the provided assembly to type - names in the statically linked, embedded assembly. - - - - - Create a new static linking map, ready to populate with data. - - - - - The table of information recording remappings from type names in the provided assembly to type - names in the statically linked, embedded assembly, plus what types are nested in side what types. - - - - - Represents the remapping information for a generated provided type and its nested types. - - There is one overall tree for each root 'type X = ... type generation expr...' specification. - - - - - Convert the expression to a string for diagnostics - - - - - Map the TyconRef objects, if any - - - - - The context used to interpret information in the closure of System.Type, System.MethodInfo and other - info objects coming from the type provider. - - At the moment this is the "Type --> ILTypeRef" and "Type --> Tycon" remapping - context for generated types (it is empty for erased types). This is computed from - while processing the [<Generate>] declaration related to the type. - - Immutable (after type generation for a [<Generate>] declaration populates the dictionaries). - - The 'obj' values are all TyconRef, but obj is used due to a forward reference being required. Not particularly - pleasant, but better than intertwining the whole "ProvidedType" with the TAST structure. - - - - - The folder for temporary files - - - - - All referenced assemblies, including the type provider itself, and possibly other type providers. - - - - - Whether or not the --showextensionresolution flag was supplied to the compiler. - - - - - Output file name - - - - - The folder from which an extension provider is resolving from. This is typically the project folder. - - - - - Carries information about the type provider resolution environment. - - - - - Check if this is a direct reference to a non-embedded generated type. This is not permitted at any name resolution. - We check by seeing if the type is absent from the remapping context. - - - - - Get the ILTypeRef for the provided type (including for nested types). Do not take into account - any type relocations or static linking for generated types. - - - - - Get the ILTypeRef for the provided type (including for nested types). Take into account - any type relocations or static linking for generated types. - - - - - Decompose the enclosing name of a type (including any class nestings) into a list of parts. - e.g. System.Object -> ["System"; "Object"] - - - - - Get the parts of a .NET namespace. Special rules: null means global, empty is not allowed. - - - - - Try to resolve a type in the given extension type resolver - - - - - Try to resolve a type in the given extension type resolver - - - - - Try to apply a provided method to the given static arguments. - - - - - Try to apply a provided type to the given static arguments. If successful also return a function - to check the type name is as expected (this function is called by the caller of TryApplyProvidedType - after other checks are made). - - - - - Validate that the given provided type meets some of the rules for F# provided types - - - - - Get the provided expression for a particular use of a method. - - - - - Detect a provided 'Var' expression - - - - - Detect a provided 'IfThenElse' expression - - - - - Detect a provided 'set variable' expression - - - - - Detect a provided 'let' expression - - - - - Detect a provided type-test expression - - - - - Detect a provided type-as expression - - - - - Detect a provided tuple-get expression - - - - - Detect a provided new-tuple expression - - - - - Detect a provided default-value expression - - - - - Detect a provided constant expression - - - - - Detect a provided call expression - - - - - Detect a provided lambda expression - - - - - Detect a provided try/finally expression - - - - - Detect a provided try/with expression - - - - - Detect a provided sequential expression - - - - - Detect a provided expression which is a for-loop over integers - - - - - Detect a provided new-delegate expression - - - - - Detect a provided while-loop expression - - - - - Detect a provided new-object expression - - - - - Detect a provided new-array expression - - - - - Given an extension type resolver, supply a human-readable name suitable for error messages. - - - - - Find and instantiate the set of ITypeProvider components for the given assembly reference - - - - - Raised when an type provider has thrown an exception. - - - - - Raised when a type provider has thrown an exception. - - - - - Invert the compilation of the given value and return its current dynamic value and its compiled System.Type - - - - - Generate ILX code for an assembly fragment - - - - - Create the CAS permission sets for an assembly fragment - - - - - Invert the compilation of the given value and clear the storage of the value - - - - - Register a fragment of the current assembly with the ILX code generator. If 'isIncrementalFragment' is true then the input - is assumed to be a fragment 'typed' into FSI.EXE, otherwise the input is assumed to be the result of a '#load' - - - - - Register a set of referenced assemblies with the ILX code generator - - - - - Create an incremental ILX code generator for a single assembly - - - - - An incremental ILX code generator for a single assembly - - - - - Used to support the compilation-inversion operations "ClearGeneratedValue" and "LookupGeneratedValue" - - - - - The generated IL/ILX resources associated with F# quotations - - - - - The generated IL/ILX .NET module attributes - - - - - The generated IL/ILX assembly attributes - - - - - The generated IL/ILX type definitions - - - - - The results of the ILX compilation of one fragment of an assembly - - - - - Indicates that, whenever possible, use callvirt instead of call - - - - - Indicates the code is being generated in FSI.EXE and is executed immediately after code generation - This includes all interactively compiled code, including #load, definitions, and expressions - - - - - If this is set, then the last module becomes the "main" module - - - - - Indicates how the generated IL code is ultimately emitted - - - - - The TcGlobals for the import context - - - - - The AssemblyLoader for the import context - - - - - Represents a context used for converting AbstractIL .NET and provided types to F# internal compiler data structures. - Also cache the conversion of AbstractIL ILTypeRef nodes, based on hashes of these. - - There is normally only one ImportMap for any assembly compilation, though additional instances can be created - using tcImports.GetImportMap() if needed, and it is not harmful if multiple instances are used. The object - serves as an interface through to the tables stored in the primary TcImports structures defined in CompileOps.fs. - - - - - Record a root for a [<Generate>] type to help guide static linking & type relocation - - - - - Resolve an Abstract IL assembly reference to a Ccu - - - - - Get a flag indicating if an assembly is a provided assembly, plus the - table of information recording remappings from type names in the provided assembly to type - names in the statically linked, embedded assembly. - - - - - Represents an interface to some of the functionality of TcImports, for loading assemblies - and accessing information about generated provided assemblies. - - - - - Import the type forwarder table for an IL assembly - - - - - Import an IL assembly as a new TAST CCU - - - - - Import a set of Abstract IL generic parameter specifications as a list of new F# generic parameters. - - - - - Import a provided method reference as an Abstract IL method reference - - - - - Import a provided type as an AbstractIL type - - - - - Import a provided type reference as an F# type TyconRef - - - - - Import a provided type as an F# type. - - - - - Pre-check for ability to import an IL type as an F# type. - - - - - Import an IL type as an F# type. - - - - - Pre-check for ability to import a reference to a type definition, given an AbstractIL ILTypeRef, with caching - - - - - Import a reference to a type definition, given an AbstractIL ILTypeRef, with caching - - - - - Functions to import .NET binary metadata as TAST objects - - - - - The Invoke MethInfo, the function argument types, the function return type - and the overall F# function type for the function type associated with a .NET delegate type - - - - - Get the item sets - - - - - Get an empty set of items - - - - - Get the items with a particular name - - - - - Filter a set of new items to add according to the content of the list. Only keep an item - if it passes 'keepTest' for all matching items already in the list. - - - - - Add new items, extracting the names using the given function. - - - - - The input list is sorted from most-derived to least-derived type, so any System.Object methods - are at the end of the list. Return a filtered list where prior/subsequent members matching by name and - that are in the same equivalence class have been removed. We keep a name-indexed table to - be more efficient when we check to see if we've already seen a particular named method. - - - - - Get overrides instead of abstract slots when measuring whether a class/interface implements all its required slots. - - - - - Prefer items toward the top of the hierarchy, which we do if the items are virtual - but not when resolving base calls. - - - - - Indicates if we prefer overrides or abstract slots. - - - - - Try and find a record or class field for a type. - - - - - Try and find an item with the given name in a type. - - - - - Read the record or class fields of a type, including inherited ones. Cache the result for monomorphic types. - - - - - Read the raw property sets of a type, including inherited ones. Cache the result for monomorphic types - - - - - Read the raw method sets of a type, including inherited ones. Cache the result for monomorphic types - - - - - Get the super-types of a type, excluding interface types. - - - - - Read the IL fields of a type, including inherited ones. Cache the result for monomorphic types. - - - - - Read the events of a type, including inherited ones. Cache the result for monomorphic types. - - - - - Get the super-types of a type, including interface types. - - - - - An InfoReader is an object to help us read and cache infos. - We create one of these for each file we typecheck. - - REVIEW: We could consider sharing one InfoReader across an entire compilation - run or have one global one for each (g,amap) pair. - - - - - Sets of methods up the hierarchy, ignoring duplicates by name and sig. - Used to collect sets of virtual methods, protected methods, protected - properties etc. - - - - - A helper type to help collect properties. - - Join up getters and setters which are not associated in the F# data structure - - - - - An AccessorDomain which returns all items - - - - - An AccessorDomain which returns everything but .NET private/internal items. - This is used - - when solving member trait constraints, which are solved independently of accessibility - - for failure paths in error reporting, e.g. to produce an error that an F# item is not accessible - - an adhoc use in service.fs to look up a delegate signature - - - - - An AccessorDomain which returns public items - - - - - AccessibleFrom(cpaths, tyconRefOpt) - - cpaths: indicates we have the keys to access any members private to the given paths - tyconRefOpt: indicates we have the keys to access any protected members of the super types of 'TyconRef' - - - - - Represents the 'keys' a particular piece of code can use to access other constructs?. - - - - - Represents the information about the compiled form of a method signature. Used when analyzing implementation - relations between members and abstract slots. - - - - - An F# use of an event backed by provided metadata - - - - - An F# use of an event backed by .NET metadata - - - - - An F# use of an event backed by F#-declared metadata - - - - - Get the intra-assembly XML documentation for the property. - - - - - Get the TcGlobals associated with the object - - - - - Indicates if the enclosing type for the event is a value type. - - For an extension event, this indicates if the event extends a struct type. - - - - - Indicates if this property is static. - - - - - Indicates if this event has an associated XML comment authored in this assembly. - - - - - Get the logical name of the event. - - - - - Get the enclosing type of the event. - - If this is an extension member, then this is the apparent parent, i.e. the type the event appears to extend. - - - - - Try to get an arbitrary F# ValRef associated with the member. This is to determine if the member is virtual, amongst other things. - - - - - Get the 'remove' method associated with an event - - - - - Get the delegate type associated with the event. - - - - - Get the 'add' method associated with an event - - - - - Test whether two event infos have the same underlying definition. - - - - - Calculates a hash code of event info (similar as previous) - - - - - Describes an F# use of an event - - - - - Get the declaring type of the event as an ILTypeRef - - - - - Get the raw Abstract IL metadata for the event - - - - - Get the name of the event - - - - - Get the declaring IL type of the event as an ILTypeInfo - - - - - Get the ILMethInfo describing the 'remove' method associated with the event - - - - - Indicates if the property is static - - - - - Get the ILMethInfo describing the 'add' method associated with the event - - - - - Describes an F# use of an event backed by Abstract IL metadata - - - - - An F# use of a property backed by provided metadata - - - - - An F# use of a property backed by Abstract IL metadata - - - - - An F# use of a property backed by F#-declared metadata - - - - - Get the intra-assembly XML documentation for the property. - - - - - Get the TcGlobals associated with the object - - - - - Get a MethInfo for the 'setter' method associated with the property - - - - - Get the logical name of the property. - - - - - True if the getter (or, if absent, the setter) is a virtual method - - - - - Indicates if the enclosing type for the property is a value type. - - For an extension property, this indicates if the property extends a struct type. - - - - - Indicates if this property is static. - - - - - Indicates if the property is logically a 'newslot', i.e. hides any previous slots of the same name. - - - - - Indicates if this property is an indexer property, i.e. a property with arguments. - - - - - Indicates if this is an F# property compiled as a CLI event, e.g. a [<CLIEvent>] property. - - - - - Indicates if this is an extension member - - - - - Indicates if the getter (or, if absent, the setter) for the property is a dispatch slot. - - - - - Indicates if this property is marked 'override' and thus definitely overrides another property. - - - - - Indicates if this property has an associated setter method. - - - - - Indicates if this property has an associated getter method. - - - - - Indicates if this property has an associated XML comment authored in this assembly. - - - - - Get a MethInfo for the 'getter' method associated with the property - - - - - Get the enclosing type of the proeprty. - - If this is an extension member, then this is the apparent parent, i.e. the type the property appears to extend. - - - - - Return a new property info where there is no associated setter, only an associated getter. - - Property infos can combine getters and setters, assuming they are consistent w.r.t. 'virtual', indexer argument types etc. - When checking consistency we split these apart - - - - - Return a new property info where there is no associated getter, only an associated setter. - - - - - Try to get an arbitrary F# ValRef associated with the member. This is to determine if the member is virtual, amongst other things. - - - - - Test whether two property infos have the same underlying definition. - - Uses the same techniques as 'MethInfosUseIdenticalDefinitions'. - - - - - Get the result type of the property - - - - - Get the types of the indexer parameters associated with the property - - - - - Get the names and types of the indexer parameters associated with the property - - - - - Get the details of the indexer parameters associated with the property - - - - - Calculates a hash code of property info (similar as previous) - - - - - Describes an F# use of a property - - - - - Get the raw Abstract IL metadata for the IL property - - - - - Get the name of the IL property - - - - - Indicates if the IL property is static - - - - - Get the declaring IL type of the IL property, including any generic instantiation - - - - - Indicates if the IL property has a 'set' method - - - - - Indicates if the IL property has a 'get' method - - - - - Gets the ILMethInfo of the 'set' method for the IL property - - - - - Indicates if the IL property is virtual - - - - - Indicates if the IL property is logically a 'newslot', i.e. hides any previous slots of the same name. - - - - - Gets the ILMethInfo of the 'get' method for the IL property - - - - - Get the return type of the IL property. - - - - - Get the types of the indexer arguments associated with the IL property. - - - - - Get the names and types of the indexer arguments associated with the IL property. - - - - - Describes an F# use of a property backed by Abstract IL metadata - - - - - Get a reference to the F# metadata for the uninstantiated union case - - - - - Get the F# metadata for the uninstantiated union case - - - - - Get the generic instantiation of the declaring type of the union case - - - - - Get a reference to the F# metadata for the declaring union type - - - - - Get the F# metadata for the declaring union type - - - - - Get the name of the union case - - - - - Describes an F# use of a union case - - - - - Get the generic instantiation of the declaring type of the field - - - - - Get a reference to the F# metadata for the F#-declared record, class or struct type - - - - - Get the F# metadata for the F#-declared record, class or struct type - - - - - Get a reference to the F# metadata for the uninstantiated field - - - - - Get the F# metadata for the uninstantiated field - - - - - Get the name of the field in an F#-declared record, class or struct type - - - - - Indicate if the field is a literal field in an F#-declared record, class or struct type - - - - - Indicate if the field is a static field in an F#-declared record, class or struct type - - - - - Get the (instantiated) type of the field in an F#-declared record, class or struct type - - - - - Get the enclosing (declaring) type of the field in an F#-declared record, class or struct type - - - - - Describes an F# use of a field in an F#-declared record, class or struct type - - - - - Represents a single use of a field backed by provided metadata - - - - - Represents a single use of a field backed by Abstract IL metadata - - - - - Get the type instantiation of the declaring type of the field - - - - - Get the scope used to interpret IL metadata - - - - - Indicates if the field is a literal field with an associated literal value - - - - - Indicates if the field is a member of a struct or enum type - - - - - Indicates if the field is static - - - - - Indicates if the field has the 'specialname' property in the .NET IL - - - - - Indicates if the field is readonly (in the .NET/C# sense of readonly) - - - - - Get a reference to the declaring type of the field as an ILTypeRef - - - - - Get the type of the field as an IL type - - - - - Get an (uninstantiated) reference to the field as an Abstract IL ILFieldRef - - - - - GENERIC TYPE PROVIDERS - Get the name of the field - - - - - Get the enclosing ("parent"/"declaring") type of the field. - - - - - Get the type of the field as an F# type - - - - - Represents a single use of a IL or provided field from one point in an F# program - - - - - Describes a use of a method backed by provided metadata - - - - - Describes a use of a pseudo-method corresponding to the default constructor for a .NET struct type - - - - - ILMeth(tcGlobals, ilMethInfo, extensionMethodPriority). - - Describes a use of a method backed by Abstract IL # metadata - - - - - FSMeth(tcGlobals, declaringType, valRef, extensionMethodPriority). - - Describes a use of a method declared in F# code and backed by F# metadata. - - - - - Get the XML documentation associated with the method - - - - - Get the TcGlobals value that governs the method declaration - - - - - Get the information about provided static parameters, if any - - - - - Get a list of argument-number counts, one count for each set of curried arguments. - - For an extension member, drop the 'this' argument. - - - - - Get the method name in LogicalName form, i.e. the name as it would be stored in .NET metadata - - - - - Indicates if the enclosing type for the method is a value type. - - For an extension method, this indicates if the method extends a struct type. - - - - - Indicates if this method takes no arguments - - - - - Does the method appear to the user as an instance method? - - - - - Indicates if this is an F# extension member. - - - - - Check if this method is an explicit implementation of an interface member - - - - - Indicates if this method is a generated method associated with an F# CLIEvent property compiled as a .NET event - - - - - Indicates if this is an extension member. - - - - - Check if this method is marked 'override' and thus definitely overrides another method. - - - - - Indicates if this is an C#-style extension member. - - - - - Indicates if this is a method defined in this assembly with an internal XML comment - - - - - Get the number of generic method parameters for a method. - For an extension method this includes all type parameters, even if it is extending a generic type. - - - - - Get the formal generic method parameters for the method as a list of type variables. - - For an extension method this includes all type parameters, even if it is extending a generic type. - - - - - Get the formal generic method parameters for the method as a list of variable types. - - - - - Get the extension method priority of the method, if it has one. - - - - - Get the extension method priority of the method. If it is not an extension method - then use the highest possible value since non-extension methods always take priority - over extension members. - - - - - Get the enclosing type of the method info. - - If this is an extension member, then this is the apparent parent, i.e. the type the method appears to extend. - This may be a variable type. - - - - - Get the method name in DisplayName form - - - - - Get the actual type instantiation of the declaring type associated with this use of the method. - - For extension members this is empty (the instantiation of the declaring type). - - - - - Get the declaring type or module holding the method. If this is an C#-style extension method then this is the type - holding the static member that is the extension method. If this is an F#-style extension method it is the logical module - holding the value for the extension method. - - - - - Try to get an arbitrary F# ValRef associated with the member. This is to determine if the member is virtual, amongst other things. - - - - - Tests whether two method infos have the same underlying definition. - Used to merge operator overloads collected from left and right of an operator constraint. - - - - - Apply a type instantiation to a method info, i.e. apply the instantiation to the enclosing type. - - - - - Get the signature of an abstract method slot. - - - - - Get the parameter types of a method info - - - - - Get the ParamData objects for the parameters of a MethInfo - - - - - Get the parameter attributes of a method info, which get combined with the parameter names and types - - - - - Get the (zero or one) 'self'/'this'/'object' arguments associated with a method. - An instance method returns one object argument. - - - - - Select all the type parameters of the declaring type of a method. - - For extension methods, no type parameters are returned, because all the - type parameters are part of the apparent type, rather the - declaring type, even for extension methods extending generic types. - - - - - Get the return type of a method info, where 'void' is returned as 'unit' - - - - - Get the return type of a method info, where 'void' is returned as 'None' - - - - - Build IL method infos. - - - - - Build IL method infos for a C#-style extension method - - - - - Calculates a hash code of method info. Note: this is a very imperfect implementation, - but it works decently for comparing methods in the language service... - - - - - Add the actual type instantiation of the apparent type of an F# extension method. - - - - - Describes an F# use of a method - - - - - ILMethInfo(g, ilApparentType, ilDeclaringTyconRefOpt, ilMethodDef, ilGenericMethodTyArgs) - - Describes an F# use of an IL method. - - If ilDeclaringTyconRefOpt is 'Some' then this is an F# use of an C#-style extension method. - If ilDeclaringTyconRefOpt is 'None' then ilApparentType is an IL type definition. - - - - - Get the Abstract IL metadata associated with the method. - - - - - Get the Abstract IL metadata corresponding to the parameters of the method. - If this is an C#-style extension method then drop the object argument. - - - - - Get the number of parameters of the method - - - - - Get the Abstract IL scope information associated with interpreting the Abstract IL metadata that backs this method. - - - - - Indicates if the IL method is marked virtual. - - - - - Does it appear to the user as a static method? - - - - - Indicates if the method has protected accessibility, - - - - - Does it have the .NET IL 'newslot' flag set, and is also a virtual? - - - - - Does it appear to the user as an instance method? - - - - - Indicates if the method is an extension method - - - - - Indicates if the IL method is marked final. - - - - - Indicates if the method is a constructor - - - - - Indicates if the method is a class initializer. - - - - - Indicates if the IL method is marked abstract. - - - - - Get the IL name of the method - - - - - Get a reference to the method (dropping all generic instantiations), as an Abstract IL ILMethodRef. - - - - - Get the formal method type parameters associated with a method. - - - - - Get the instantiation of the declaring type of the method. - If this is an C#-style extension method then this is empty because extension members - are never in generic classes. - - - - - Get the declaring type associated with an extension member, if any. - - - - - Get the declaring type of the method. If this is an C#-style extension method then this is the IL type - holding the static member that is the extension method. - - - - - Get the apparent declaring type of the method as an F# type. - If this is an C#-style extension method then this is the type which the method - appears to extend. This may be a variable type. - - - - - Indicates if the method is marked as a DllImport (a PInvoke). This is done by looking at the IL custom attributes on - the method. - - - - - Get all the argument types of the IL method. Include the object argument even if this is - an C#-style extension method. - - - - - Get the argument types of the the IL method. If this is an C#-style extension method - then drop the object argument. - - - - - Get info about the arguments of the IL method. If this is an C#-style extension method then - drop the object argument. - - - - - Get the (zero or one) 'self'/'this'/'object' arguments associated with an IL method. - An instance extension method returns one object argument. - - - - - Get the F# view of the return type of the method, where 'void' is 'unit'. - - - - - Get the compiled return type of the method, where 'void' is None. - - - - - Describes an F# use of an IL method. - - - - - ILTypeInfo (tyconRef, ilTypeRef, typeArgs, ilTypeDef). - - - - - Describes an F# use of an IL type, including the type instantiation associated with the type at a particular usage point. - - This is really just 1:1 with the subset ot TType which result from building types using IL type definitions. - - - - - Full information about a parameter returned for use by the type checker and language service. - - - - - Partial information about a parameter returned for use by the Language Service - - - - - The argument is optional, and is a caller-side .NET optional or default arg - - - - - The argument is optional, and is an F# callee-side optional arg - - - - - The argument is not optional - - - - - Compute the OptionalArgInfo for an IL parameter - - This includes the Visual Basic rules for IDispatchConstant and IUnknownConstant and optional arguments. - - - - - Represents information about a parameter indicating if it is optional. - - - - - The caller-side value for the optional arg, is any - - - - - Describes the sequence order of the introduction of an extension method. Extension methods that are introduced - later through 'open' get priority in overload resolution. - - - - - Indicates whether we should visit multiple instantiations of the same generic interface or not - - - - - Indicates whether we can skip interface types that lie outside the reference set - - - - - Get the type of the event when looked at as if it is a property - Used when displaying the property in Intellisense - - - - - Get the (perhaps tupled) argument type accepted by an event - - - - - Indicates if an event info is associated with a delegate type that is a "standard" .NET delegate type - with a sender parameter. - In the F# design, we take advantage of the following idiom to simplify away the bogus "object" parameter of the - of the "Add" methods associated with events. If you want to access it you - can use AddHandler instead. - The .NET Framework guidelines indicate that the delegate type used for - an event should take two parameters, an "object source" parameter - indicating the source of the event, and an "e" parameter that - encapsulates any additional information about the event. The type of - the "e" parameter should derive from the EventArgs class. For events - that do not use any additional information, the .NET Framework has - already defined an appropriate delegate type: EventHandler. - (from http://msdn.microsoft.com/library/default.asp?url=/library/en-us/csref/html/vcwlkEventsTutorial.asp) - - - - - Try and interpret a delegate type as a "standard" .NET delegate type associated with an event, with a "sender" parameter. - - - - - Given a delegate type work out the minfo, argument types, return type - and F# function type by looking at the Invoke signature of the delegate. - - - - - Try to find a particular named property on a type. Only used to ensure that local 'let' definitions and property names - are distinct, a somewhat adhoc check in tc.fs. - - - - - Try to detect the existence of a method on a type. - Used for - -- getting the GetEnumerator, get_Current, MoveNext methods for enumerable types - -- getting the Dispose method when resolving the 'use' construct - -- getting the various methods used to desugar the computation expression syntax - - - - - Perform type-directed name resolution of a particular named member in an F# type - - - - - Get the flattened list of intrinsic properties in the hierarchy - - - - - Get the flattened list of intrinsic methods in the hierarchy - - - - - Get the sets intrinsic properties in the hierarchy (not including extension properties) - - - - - Get the sets of intrinsic methods in the hierarchy (not including extension methods) - - - - - Exclude properties from super types which have the same name as a property in a more specific type. - - - - - Exclude methods from super types which have the same signature as a method in a more specific type. - - - - - Filter the overrides of properties, either keeping the overrides or keeping the dispatch slots. - - - - - (a) not virtual - Filter the overrides of methods, either keeping the overrides or keeping the dispatch slots. - - - - - Filter the overrides of methods or properties, either keeping the overrides or keeping the dispatch slots. - - - - - Add all the items to the IndexedList, preferring the ones in the sub-types. - - - - - Add all the items to the IndexedList, preferring the ones in the super-types. This is used to hide methods - in super classes and/or hide overrides of methods in subclasses. - - Assume no items in 'items' are equivalent according to 'equivTest'. This is valid because each step in a - .NET class hierarchy introduces a consistent set of methods, none of which hide each other within the - given set. This is an important optimization because it means we don't have filter for equivalence between the - large overload sets introduced by methods like System.WriteLine. - - Assume items can be given names by 'nmf', where two items with different names are - not equivalent. - - - - - Get the declared constructors of any F# type - - - - - Query the immediate properties of an F# type, not taking into account inherited properties. The optFilter - parameter is an optional name to restrict the set of properties returned. - - - - - Query the immediate methods of an F# type, not taking into account inherited methods. The optFilter - parameter is an optional name to restrict the set of properties returned. - - - - - Try to select an F# value when querying members, and if so return a MethInfo that wraps the F# value. - - - - - Check whether a name matches an optional filter - - - - - Use the given function to select some of the member values from the members of an F# type - - - - - Make a call to a method info. Used by the optimizer and code generator to build - calls to the type-directed solutions to member constraints. - - - - - Build a call to an F# method. - - - - - Build a call to an F# method. - - Consume the arguments in chunks and build applications. This copes with various F# calling signatures - all of which ultimately become 'methods'. - - QUERY: this looks overly complex considering that we are doing a fundamentally simple - thing here. - - - - - Build a call to the System.Object constructor taking no arguments, - - - - - Build an expression node that is a call to a .NET method. - - - - - Used to hide/filter members from super classes based on signature - - - - - Used to hide/filter members from super classes based on signature - - - - - Used to hide/filter members from super classes based on signature - - - - - Used to hide/filter members from super classes based on signature - - - - - Get the information about the compiled form of a method signature. Used when analyzing implementation - relations between members and abstract slots. - - - - - Find the delegate type that an F# event property implements by looking through the type hierarchy of the type of the property - for the first instantiation of IDelegateEvent. - - - - - Create an error object to raise should an event not have the shape expected by the .NET idiom described further below - - - - - Properties compatible with type IDelegateEvent and attributed with CLIEvent are special: - we generate metadata and add/remove methods - to make them into a .NET event, and mangle the name of a property. - We don't handle static, indexer or abstract properties correctly. - Note the name mangling doesn't affect the name of the get/set methods for the property - and so doesn't affect how we compile F# accesses to the property. - - - - - Try to get an arbitrary ProvidedMethodInfo associated with a property. - - - - - Compute the ILFieldInit for the given provided constant value for a provided enum type. - - - - - Compute the OptionalArgInfo for a provided parameter. - - This is the same logic as OptionalArgInfoOfILParameter except we do not apply the - Visual Basic rules for IDispatchConstant and IUnknownConstant to optional - provided parameters. - - - - - Compute the ILFieldInit for the given provided constant value for a provided enum type. - - - - - Work out the instantiation relevant to interpret the backing metadata for a property. - - - - - Work out the instantiation relevant to interpret the backing metadata for a member. - - The 'minst' is the instantiation of any generic method type parameters (this instantiation is - not included in the MethInfo objects, but carreid separately). - - - - - Combine the type instantiation and generic method instantiation - - - - - Get the object type for a member value which is a C#-style extension method - - - - - Get the object type for a member value which is an extension method (C#-style or F#-style) - - - - - Split the type of an F# member value into - - the type parameters associated with method but matching those of the enclosing type - - the type parameters associated with a generic method - - the return type of the method - - the actual type arguments of the enclosing type. - - - - - Construct the data representing the signature of an abstract method slot - - - - - Construct the data representing a parameter in the signature of an abstract method slot - - - - - The slotsig returned by methInfo.GetSlotSig is in terms of the type parameters on the parent type of the overriding method. - Reverse-map the slotsig so it is in terms of the type parameters for the overriding method - - - - - Get the return type of a provided method, where 'void' is returned as 'None' - - - - - Check if an F#-declared member value is an explicit interface member implementation - - - - - Check if an F#-declared member value is an 'override' or explicit member implementation - - - - - Check if an F#-declared member value is a dispatch slot - - - - - Check if an F#-declared member value is a virtual method - - - - - Indicates if an F#-declared function or member value is a CLIEvent property compiled as a .NET event - - - - - The constraints for each typar copied from another typar can only be fixed up once - we have generated all the new constraints, e.g. f<A :> List<B>, B :> List<A>> ... - - - - - Copy constraints. If the constraint comes from a type parameter associated - with a type constructor then we are simply renaming type variables. If it comes - from a generic method in a generic class (e.g. typ.M<_>) then we may be both substituting the - instantiation associated with 'typ' as well as copying the type parameters associated with - M and instantiating their constraints - - Note: this now looks identical to constraint instantiation. - - - - - Get the return type of an IL method, taking into account instantiations for type and method generic parameters, and - translating 'void' to 'None'. - - - - - Read an Abstract IL type from metadata and convert to an F# type. - - - - - Check if a type exists somewhere in the hierarchy which has the given head type. - - - - - Check if a type exists somewhere in the hierarchy which has the same head type as the given type (note, the given type need not have a head type at all) - - - - - Check if a type has a particular head type - - - - - Check if two types have the same nominal head type - - - - - Get all interfaces of a type, including the type itself if it is an interface - - - - - Get all super types of the type, including the type itself - - - - - Search for one element where a function returns a 'Some' result, following interfaces - - - - - Search for one element satisfying a predicate, following interfaces - - - - - Iterate, following interfaces. Skipping interfaces that lie outside the referenced assembly set is allowed. - - - - - Fold, following interfaces. Skipping interfaces that lie outside the referenced assembly set is allowed. - - - - - Fold, do not follow interfaces (unless the type is itself an interface) - - - - - Traverse the type hierarchy, e.g. f D (f C (f System.Object acc)). - Visit base types and interfaces first. - - - - - Collect the set of immediate declared interface types for an F# type, but do not - traverse the type hierarchy to collect further interfaces. - - - - - Make a type for System.Collections.Generic.IList<ty> - - - - - Get the base type of a type, taking into account type instantiations. Return None if the - type has no base type. - - - - - Indicates if an F# type is the type associated with an F# exception declaration - - - - - Import an IL type as an F# type. importInst gives the context for interpreting type variables. - - - - - An exception type used to raise an error using the old error system. - - Error text: "A definition to be compiled as a .NET event does not have the expected form. Only property members can be compiled as .NET events." - - - - - Check the attributes on a record field, returning errors and warnings as data. - - - - - Check the attributes on an F# value, returning errors and warnings as data. - - - - - Check the attributes on a record field, returning errors and warnings as data. - - - - - Check the attributes on a union case, returning errors and warnings as data. - - - - - Check the attributes on an entity, returning errors and warnings as data. - - - - - Indicate if a property has 'Obsolete' or 'CompilerMessageAttribute'. - Used to suppress the item in intellisense. - - - - - Indicate if a method has 'Obsolete', 'CompilerMessageAttribute' or 'TypeProviderEditorHideMethodsAttribute'. - Used to suppress the item in intellisense. - - - - - Check the attributes associated with a method, returning warnings and errors as data. - - - - - Check the attributes associated with a IL field, returning warnings and errors as data. - - - - - Check the attributes associated with a property, returning warnings and errors as data. - - - - - Indicate if a list of provided attributes contains 'ObsoleteAttribute'. Used to suppress the item in intellisense. - - - - - Indicate if a list of F# attributes contains 'ObsoleteAttribute'. Used to suppress the item in intellisense. - Also check the attributes for CompilerMessageAttribute, which has an IsHidden argument that allows - items to be suppressed from intellisense. - - - - - Indicate if a list of F# attributes contains 'ObsoleteAttribute'. Used to suppress the item in intellisense. - - - - - Checks the attributes for CompilerMessageAttribute, which has an IsHidden argument that allows - items to be suppressed from intellisense. - - - - - Indicate if a list of IL attributes contains 'ObsoleteAttribute'. Used to suppress the item in intellisense. - - - - - Check a list of provided attributes for 'ObsoleteAttribute', returning errors and warnings as data - - - - - Check F# attributes for 'ObsoleteAttribute', 'CompilerMessageAttribute' and 'ExperimentalAttribute', - returning errors and warnings as data - - - - - Check IL attributes for 'ObsoleteAttribute', returning errors and warnings as data - - - - - Check if a method has a specific attribute. - - - - - Try to find a specific attribute on a method, where the attribute accepts a string argument. - - This is just used for the 'ConditionalAttribute' attribute - - - - - Analyze three cases for attributes declared on methods: IL-declared attributes, F#-declared attributes and - provided attributes. - - - - - Analyze three cases for attributes declared on methods: IL-declared attributes, F#-declared attributes and - provided attributes. - - - - - Analyze three cases for attributes declared on type definitions: IL-declared attributes, F#-declared attributes and - provided attributes. - - - - - Check custom attributes. This is particularly messy because custom attributes come in in three different - formats. - - - - - Uses a separate accessibility domains for containing type and method itself - This makes sense cases like - type A() = - type protected B() = - member this.Public() = () - member protected this.Protected() = () - type C() = - inherit A() - let x = A.B() - do x.Public() - when calling x.SomeMethod() we need to use 'adTyp' do verify that type of x is accessible from C - and 'ad' to determine accessibility of SomeMethod. - I.e when calling x.Public() and x.Protected() -in both cases first check should succeed and second - should fail in the latter one. - - - - - IndiCompute the accessibility of a provided member - - - - - Compute the accessibility of a provided member - - - - - Indicate if a provided member is accessible - - - - - Indicates if a type is accessible (both definition and instantiation) - - - - - Check that a type definition and its representation contents are accessible - - - - - Indicates if a type definition and its representation contents are accessible - - - - - Check that an entity is accessible - - - - - Indicates if an entity is accessible - - - - - Indicates if an IL member associated with the given ILType is accessible - - - - - Indicates if given IL based TyconRef is accessible. If TyconRef is nested then we'll - walk though the list of enclosing types and test if all of them are accessible - - - - - Indicates if a TyconRef is visible through the AccessibleFrom(cpaths,_). - Note that InternalsVisibleTo extends those cpaths. - - - - - Indicates if tdef is accessible. If tdef.Access = ILTypeDefAccess.Nested then encTyconRefOpt s TyconRef of enclosing type - and visibility of tdef is obtained using member access rules - - - - - Indicates if an IL member is accessible (ignoring its enclosing type) - - - - - Indicates if an F# item is accessible - - - - - tinfos, minfos, finfos, pinfos - summaries of information for references - to .NET and F# constructs. - - - - - Defines a write-only stream used to capture output of the hosted F# Interactive dynamic compiler. - - - - - Feeds content into the stream. - - - - - Defines a read-only input stream used to feed content to the hosted F# Interactive dynamic compiler. - - - - - Raised when an interaction is successfully typechecked and executed, resulting in an update to the - type checking state. - - This event is triggered after parsing and checking, either via input from 'stdin', or via a call to EvalInteraction. - - - - - A host calls this to get the active language ID if provided by fsi-server-lcid - - - - - A host calls this to determine if the --gui parameter is active - - - - - The single, global interactive checker to use in conjunction with other operations - on the FsiEvaluationSession. - - If you are using an FsiEvaluationSession in this process, you should only use this InteractiveChecker - for additional checking operations. - - - - - Get a handle to the dynamicly generated assembly - - - - - Get a handle to the resolved view of the current signature of the incrementally generated assembly. - - - - - Load the dummy interaction, load the initial files, and, - if interacting, start the background thread to read the standard input. - - Performs these steps: - - Load the dummy interaction, if any - - Set up exception handling, if any - - Load the initial files, if any - - Start the background thread to read the standard input, if any - - Sit in the GUI event loop indefinitely, if needed - - - - - A host calls this to report an unhandled exception in a standard way, e.g. an exception on the GUI thread gets printed to stderr - - - - - Typecheck the given script fragment in the type checking context implied by the current state - of F# Interactive. The results can be used to access intellisense, perform resolutions, - check brace matching and other information. - - Operations may be run concurrently with other requests to the InteractiveChecker. - - Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered - by input from 'stdin'. - - - - - A host calls this to request an interrupt on the evaluation thread. - - - - - Get a configuration that uses a private inbuilt implementation of the 'fsi' object and does not - implicitly reference FSharp.Compiler.Interactive.Settings.dll. - - - - - Get a configuration that uses the 'fsi' object (normally from FSharp.Compiler.Interactive.Settings.dll, - an object from another DLL with identical characteristics) to provide an implementation of the configuration. - FSharp.Compiler.Interactive.Settings.dll is referenced by default. - - - - - Get a configuration that uses the 'fsi' object (normally from FSharp.Compiler.Interactive.Settings.dll, - an object from another DLL with identical characteristics) to provide an implementation of the configuration. - The flag indicates if FSharp.Compiler.Interactive.Settings.dll is referenced by default. - - - - - A host calls this to get the completions for a long identifier, e.g. in the console - - Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered - by input from 'stdin'. - - - - - Execute the given script. Stop on first error, discarding the rest - of the script. Errors are sent to the output writer, a 'true' return value indicates there - were no errors overall. Execution is performed on the 'Run()' thread. - - Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered - by input from 'stdin'. - - - - - Execute the code as if it had been entered as one or more interactions, with an - implicit termination at the end of the input. Stop on first error, discarding the rest - of the input. Errors are sent to the output writer, a 'true' return value indicates there - were no errors overall. Execution is performed on the 'Run()' thread. - - Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered - by input from 'stdin'. - - - - - Execute the code as if it had been entered as one or more interactions, with an - implicit termination at the end of the input. Stop on first error, discarding the rest - of the input. Errors are sent to the output writer, a 'true' return value indicates there - were no errors overall. Parsing is performed on the current thread, and execution is performed - sycnhronously on the 'main' thread. - - Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered - by input from 'stdin'. - - - - - Create an FsiEvaluationSession, reading from the given text input, writing to the given text output and error writers. - - <summary>Create an FsiEvaluationSession, reading from the given text input, writing to the given text output and error writers</summary> - - <param name="fsiConfig">The dynamic configuration of the evaluation session</param> - <param name="argv">The commmand line arguments for the evaluation session</param> - <param name="inReader">Read input from the given reader</param> - <param name="outWriter">Write output to the given writer</param> - <param name="collectible">Optionally make the dynamic assmbly for the session collectible</param> - - - - - Create an FsiEvaluationSession, reading from the given text input, writing to the given text output and error writers. - - - - - Represents an F# Interactive evaluation session. - - - - - Implicitly reference FSharp.Compiler.Interactive.Settings.dll - - - - - Called by the evaluation session to ask the host for parameters to format text for output - - - - - Called by the evaluation session to ask the host for parameters to format text for output - - - - - Called by the evaluation session to ask the host for parameters to format text for output - - - - - Called by the evaluation session to ask the host for parameters to format text for output - - - - - Called by the evaluation session to ask the host for parameters to format text for output - - - - - Called by the evaluation session to ask the host for parameters to format text for output - - - - - Called by the evaluation session to ask the host for parameters to format text for output - - - - - Indicate a special console "readline" reader for the evaluation session, if any. - - A "console" gets used if --readline is specified (the default on Windows + .NET); and --fsi-server is not - given (always combine with --readline-), and OptionalConsoleReadLine is given. - When a console is used, special rules apply to "peekahead", which allows early typing on the console. - Peekahead happens if --peekahead- is not specified (the default). - In this case, a prompt is printed early, a background thread is created and - the OptionalConsoleReadLine is used to read the first line. - If a console is not used, then inReader.Peek() is called early instead. - - - Further lines are read using OptionalConsoleReadLine(). - If not provided, lines are read using inReader.ReadLine(). - - - - - - Hook for listening for evaluation bindings - - - - - Called by the evaluation session to ask the host for parameters to format text for output - - - - - Called by the evaluation session to ask the host for parameters to format text for output - - - - - Called by the evaluation session to ask the host for parameters to format text for output - - - - - The evaluation session calls this at an appropriate point in the startup phase if the --fsi-server parameter was given - - - - - The evaluation session calls this to report the preferred view of the command line arguments after - stripping things like "/use:file.fsx", "-r:Foo.dll" etc. - - - - - Schedule a restart for the event loop. - - - - - Called by the evaluation session to ask the host to enter a dispatch loop like Application.Run(). - Only called if --gui option is used (which is the default). - Gets called towards the end of startup and every time a ThreadAbort escaped to the backup driver loop. - Return true if a 'restart' is required, which is a bit meaningless. - - - - - Request that the given operation be run synchronously on the event loop. - - - - - The FSharpSymbolUse for the symbol defined - - - - - The symbol defined - - - - - The display name of the symbol defined - - - - - The details of the expression defined - - - - - The value of the symbol defined, if any - - - - - The value, as an object - - - - - The type of the value, from the point of view of the .NET type system - - - - - The type of the value, from the point of view of the F# type system - - - - - Represents an evaluated F# value - - - - When set to 'false', disables the display of properties of evaluated objects in the output of the interactive session. - - - When set to 'false', disables the display of sequences in the output of the interactive session. - - - When set to 'false', disables the display of declaration values in the output of the interactive session. - - - Get or set the print width of the interactive session. - - - Get or set the total print size of the interactive session. - - - Get or set the total print length of the interactive session. - - - Get or set the print depth of the interactive session. - - - Get or set the format provider used in the output of the interactive session. - - - Get or set the floating point format used in the output of the interactive session. - - - Gets or sets a the current event loop being used to process interactions. - - - The command line arguments after ignoring the arguments relevant to the interactive - environment and replacing the first argument with the name of the last script file, - if any. Thus 'fsi.exe test1.fs test2.fs -- hello goodbye' will give arguments - 'test2.fs', 'hello', 'goodbye'. This value will normally be different to those - returned by System.Environment.GetCommandLineArgs. - - - When set to 'false', disables the display of properties of evaluated objects in the output of the interactive session. - - - When set to 'false', disables the display of sequences in the output of the interactive session. - - - When set to 'false', disables the display of declaration values in the output of the interactive session. - - - Get or set the print width of the interactive session. - - - Get or set the total print size of the interactive session. - - - Get or set the total print length of the interactive session. - - - Get or set the print depth of the interactive session. - - - Get or set the format provider used in the output of the interactive session. - - - Get or set the floating point format used in the output of the interactive session. - - - Gets or sets a the current event loop being used to process interactions. - - - The command line arguments after ignoring the arguments relevant to the interactive - environment and replacing the first argument with the name of the last script file, - if any. Thus 'fsi.exe test1.fs test2.fs -- hello goodbye' will give arguments - 'test2.fs', 'hello', 'goodbye'. This value will normally be different to those - returned by System.Environment.GetCommandLineArgs. - - - Register a printer that controls the output of the interactive session. - - - Register a print transformer that controls the output of the interactive session. - - - Operations supported by the currently executing F# Interactive session. - - - Schedule a restart for the event loop. - - - Run the event loop. - True if the event loop was restarted; false otherwise. - - - Request that the given operation be run synchronously on the event loop. - The result of the operation. - - - An event loop used by the currently executing F# Interactive session to execute code - in the context of a GUI or another event-based system. - - - - A default implementation of the 'fsi' object, used by GetDefaultConfiguration(). Note this - is a different object to FSharp.Compiler.Interactive.Settings.fsi in FSharp.Compiler.Interactive.Settings.dll, - which can be used as an alternative implementation of the interactiev settings if passed as a parameter - to GetDefaultConfiguration(fsiObj). - - - - - A default implementation of the 'fsi' object, used by GetDefaultConfiguration() - - - - - render a Layout yielding an 'a using a 'b (hidden state) type - - - - - Primitive renders - - - - - Run a render on a Layout - - - - - Returns starting position of the token - - - - - Returns end position of the token - - - - - Returns a token 'tok' with the same position as this token, except that - it is shifted by specified number of characters from the left and from the right - Note: positive value means shift to the right in both cases - - - - - Returns a token 'tok' with the same position as this token - - - - - Used to save the state related to a token - - - - - Used to save some aspects of the lexbuffer state - - - - - Determine the token that may align with the 'try' of a 'try/catch' or 'try/finally' without closing - the construct - - - - - Determine the tokens that may align with the 'if' of an 'if/then/elif/else' without closing - the construct - - - - - Used for warning strings, which should display columns as 1-based and display - the lines after taking '# line' directives into account (i.e. do not use - p.OriginalLine) - - - - - LexFilter - process the token stream prior to parsing. - Implements the offside rule and a copule of other lexical transformations. - - - - - is this the developer-debug build? - - - - - Get the result and commit it - - - - - Get the reified result - - - - - When using .NET 4.0 you can replace this type by Task<'T> - - - - - Represents the reified result of an asynchronous computation - - - - - Treat a list of key-value pairs as a lookup collection. - This function returns true if two keys are the same according to the predicate - function passed in. - - - - - Treat a list of key-value pairs as a lookup collection. - This function looks up a value based on a match from the supplied - predicate function. - - - - - Throw System.ArgumentNullException() if string argument is null. - Throw System.ArgumentOutOfRangeException() is string argument is empty. - - - - - Throw System.ArgumentNullException() if array argument is null. - Throw System.ArgumentOutOfRangeException() is array argument is empty. - - - - - Throw System.ArgumentNullException() if argument is null. - - - - - Throw System.InvalidOperationException() if argument is None. - If there is a value (e.g. Some(value)) then value is returned. - - - - - The state variables allocated for one portion of the sequence expression (i.e. the local let-bound variables which become state variables) - - - - - any actual work done in Close - - - - - The labels allocated for one portion of the sequence expression - - - - - The code to run in the second phase, to rebuild the expressions, once all code labels and their mapping to program counters have been determined - 'nextVar' is the argument variable for the GenerateNext method that represents the byref argument that holds the "goto" destination for a tailcalling sequence expression - - - - - Analyze a TAST expression to detect the elaborated form of a sequence expression. - Then compile it to a state machine represented as a TAST containing goto, return and label nodes. - The returned state machine will also contain references to state variables (from internal 'let' bindings), - a program counter (pc) that records the current state, and a current generated value (current). - All these variables are then represented as fields in a hosting closure object along with any additional - free variables of the sequence expression. - - The analysis is done in two phases. The first phase determines the state variables and state labels (as Abstract IL code labels). - We then allocate an integer pc for each state label and proceed with the second phase, which builds two related state machine - expressions: one for 'MoveNext' and one for 'Dispose'. - - - - - An "expr -> expr" pass that eta-expands under-applied values of - known arity to lambda expressions and beta-var-reduces to bind - any known arguments. The results are later optimized by the peephole - optimizer in opt.fs - - - - - Binding redirects that reference resolution recommends for the app.config file. - - - - - Paths to files that reference resolution recommend be copied to the local directory - - - - - Additional files required to support multi-file assemblies. - - - - - Paths to satellite assemblies used for localization. - - - - - Paths to related files (like .xml and .pdb) - - - - - Paths to dependencies - - - - - Paths to primary references - - - - - Reference resolution results. All paths are fully qualified. - - - - - Round-tripped baggage string - - - - - The name of the redist the assembly was found in - - - - - The version of the assembly (like 4.0.0.0) - - - - - The long fusion name of the assembly - - - - - Location that the assembly was resolved from - - - - - Item specification - - - - - Information about a resolved file. - - - - - Indicates whether the resolve should follow compile-time rules or runtime rules. - - - - - Describes the location where the reference was found. - - - - - Perform the resolution on rooted and unrooted paths, and then combine the results. - - - - - Perform assembly resolution by instantiating the ResolveAssemblyReference task directly from the MSBuild SDK. - - - - - Decode the ResolvedFrom code from MSBuild. - - - - - Derive the target framework directories. - - - - - The list of supported .NET Framework version numbers, using the monikers of the Reference Assemblies folder. - - - - - When targeting .NET 2.0-3.5 on Windows, we expand the {WindowsFramework} and {ReferenceAssemblies} paths manually - - - - - Get the Reference Assemblies directory for the .NET Framework on Window - - - - - Find override among given overrides and notify the sink. The 'Item' contains the candidate overrides. - - - - - Notify the sink - - - - - Notification is not needed - - - - - Specifies if overload resolution needs to notify Language Service of overload resolution - - - - - An adjustment to perform to the name resolution results if overload resolution fails. - If overload resolution succeeds, the specific overload resolution is reported. If it fails, the - set of possible overloads is reported via this adjustment. - - - - - Indicates whether we permit a direct reference to a type generator. Only set when resolving the - right-hand-side of a [<Generate>] declaration. - - - - - Indicates if a warning should be given for the use of upper-case identifiers in patterns - - - - - Indicates the kind of lookup being performed. Note, this type should be made private to nameres.fs. - - - - - An abstract type for reporting the results of name resolution and type checking, and which allows - temporary suspension and/or redirection of reporting. - - - - - An abstract type for reporting the results of name resolution and type checking - - - - - Exact name resolutions - - - - - Information of exact types found for expressions, that can be to the left of a dot. - typ - the inferred type for an expression - - - - - Name resolution environments for every interesting region in the file. These regions may - overlap, in which case the smallest region applicable should be used. - - - - - The starting and ending position - - - - - line and column - - - - - Naming environment--for example, currently open namespaces. - - - - - Named item - - - - - Information about printing. For example, should redundant keywords be hidden? - - - - - Represents the kind of the occurrence when reporting a name in name resolution - - - - - Represents information which guides name resolution of types. - - - - - Indicates definite knowledge of empty type arguments, i.e. the logical equivalent of name< > - - - - - Deduce definite knowledge of type arguments - - - - - Represents information about the generic argument count of a type name when resolving it. - - In some situations we resolve "List" to any type definition with that name regardless of the number - of generic arguments. In others, we know precisely how many generic arguments are needed. - - - - - Indicates we are resolving type names to type definitions - - - - - Indicates we are resolving type names to constructor methods. - - - - - Indicates whether we are resolving type names to type definitions or to constructor methods. - - - - - A flag which indicates if it is an error to have two declared type parameters with identical names - in the name resolution environment. - - - - - The environment of information used to resolve names - - - - - Information about an extension member held in the name resolution environment - - - - - Represents a record field resolution and the information if the usage is deprecated. - - - - - Represents the resolution of a source identifier to a named argument - - - - - Represents the resolution of a source identifier to an implicit use of an infix operator (+solution if such available) - - - - - CustomOperation(operationName, operationHelpText, operationImplementation). - - Used to indicate the availability or resolution of a custom query operation such as 'sortBy' or 'where' in computation expression syntax - - - - - Represents an item that results from name resolution - - - - - The named argument is a static parameter to a union case constructor - - - - - The named argument is a static parameter to a provided type or a parameter to an F# exception constructor - - - - - The named argument is an argument of a method - - - - - Represents the item with which a named argument is associated. - - - - - A NameResolver is a context for name resolution. It primarily holds an InfoReader. - - - - - Resolve a (possibly incomplete) long identifier to a set of possible resolutions, qualified by type. - - - - - Resolve a (possibly incomplete) long identifier to a set of possible resolutions. - - - - - A generator of type instantiations used when no more specific type instantiation is known. - - - - - Resolve a long identifier occurring in an expression position, qualified by a type. - - - - - Resolve a long identifier occurring in an expression position. - - - - - Return the fields for the given class or record - - - - - Resolve a (possibly incomplete) long identifier to a loist of possible class or record fields - - - - - Resolve a long identifier occurring in an expression position - - - - - Resolve a long identifier to a field - - - - - Resolve a long identifier to a type definition - - - - - Resolve a long identifier representing a type name - - - - - Resolve a long identifier when used in a pattern. - - - - - Resolve a long identifier using type-qualified name resolution. - - - - - Resolve a long identifier to an object constructor. - - - - - Resolve a long identifier to a namespace or module. - - - - - Generate a new reference to a record field with a fresh type instantiation - - - - - Get the available methods of a type (both declared and inherited) - - - - - Get all the available properties of a type (only extension) - - - - - Get all the available properties of a type (both intrinsic and extension) - - - - - Report a specific name resolution at a source range - - - - - Report a specific name resolution at a source range - - - - - Report the active name resolution environment for a source range - - - - - Temporarily suspend reporting of name resolution and type checking results - - - - - Temporarily redirect reporting of name resolution and type checking results - - - - - Check for equality, up to signature matching - - - - - Qualified lookup of type names in the environment - - - - - Add some declared type parameters to the name resolution environment - - - - - Add a list of modules or namespaces to the name resolution environment - - - - - Add a single modules or namespace to the name resolution environment - - - - - Add a list of module or namespace to the name resolution environment, including any sub-modules marked 'AutoOpen' - - - - - Add a module abbreviation to the name resolution environment - - - - - Add an F# exception definition to the name resolution environment - - - - - Add a list of type definitions to the name resolution environment - - - - - Add active pattern result tags to the environment. - - - - - Add a single F# value to the environment. - - - - - Add some extra items to the environment for Visual Studio, e.g. record members - - - - - Add extra items to the environment for Visual Studio, e.g. static members - - - - - Lookup patterns in name resolution environment - - - - - Detect a use of a nominal type, including type abbreviations. - When reporting symbols, we care about abbreviations, e.g. 'int' and 'int32' count as two separate symbols. - - - - - Used to report a warning condition for the use of upper-case identifiers in patterns - - - - - Used to report an error condition where name resolution failed due to an indeterminate type - - - - - Generate text for comparing two types. - - If the output text is different without showing constraints and/or imperative type variable - annotations and/or fully qualifying paths then don't show them! - - - - - Pass negative number as pos in case of single cased discriminated unions - - - - - Convert a ParamData to a string - - - - - Convert a MethInfo to a string - - - - - Convert a MethInfo to a string - - - - - Print members with a qualification showing the type they are contained in - - - - - Nice printing of a subset of expressions, e.g. for refutations in pattern matching - - - - - Layout the inferred signature of a compilation unit - - - - - Another re-implementation of type printing, this time based off provided info objects. - - - - - When to force a break? "type tyname = <HERE> repn" - When repn is class or datatype constructors (not single one). - - - - - Printing TAST objects - - - - - Format a method to a layout (actually just containing a string) using "free style" (aka "standalone"). - - - - - Format a method to a buffer using "standalone" display style. - For example, these are the formats used when printing signatures of methods that have not been overridden, - and the format used when showing the individual member in QuickInfo and DeclarationInfo. - The formats differ between .NET/provided methods and F# methods. Surprisingly people don't really seem - to notice this, or they find it helpful. It feels that moving from this position should not be done lightly. - - - - - Format a method info using "half C# style". - - - - - Format a method info using "F# style". - - - - - Format the arguments of a method to a buffer. - - This uses somewhat "old fashioned" printf-style buffer printing. - - - - - Printing info objects - - - - - Printing TAST objects - - - - - Layout type parameters - - - - - Layout a single type used as the type of a member or value - - - - - Layout a single type, taking TypeSimplificationInfo into account - - - - - Layout a list of types, separated with the given separator, either '*' or ',' - - - - - Layout a type, taking precedence into account to insert brackets where needed *) - - - - - Layout type arguments, either NAME<ty,...,ty> or (ty,...,ty) NAME *) - - - - - Layout a unit expression - - - - - Layout constraints, taking TypeSimplificationInfo into account - - - - - Layout type parameter constraints, taking TypeSimplificationInfo into account - - - - - Layout a single type parameter declaration, taking TypeSimplificationInfo into account - There are several printing-cases for a typar: - - 'a - is multiple occurrence. - _ - singleton occurrence, an underscore preferred over 'b. (OCAML accepts but does not print) - #Type - inplace coercion constraint and singleton. - ('a :> Type) - inplace coercion constraint not singleton. - ('a.opM : S->T) - inplace operator constraint. - - - - - - Layout '[<attribs>]' above another block - - - - - Layout an attribute 'Type(arg1, ..., argN)' - - - - - Layout arguments of an attribute 'arg1, ..., argN' - - - - - Layout a single attibute arg, following the cases of 'gen_attr_arg' in ilxgen.fs - This is the subset of expressions we display in the NicePrint pretty printer - See also dataExprL - there is overlap between these that should be removed - - - - - Layout the flags of a member - - - - - Layout a reference to a type - - - - - Layout a method's signature using type-only-F#-style. No argument names are printed. - - In the case that we've a constructor, we - pull off the class name from the `path`; naturally, it's the - most-deeply-nested element. - - - - - Layout a function pointer signature using type-only-F#-style. No argument names are printed. - - - - - Layout a function pointer signature using type-only-F#-style. No argument names are printed. - - - - - Layout a function pointer signature using type-only-F#-style. No argument names are printed. - - - - - this fixes up a name just like adjustILName but also handles F# - operators - - - - - fix up a name coming from IL metadata by quoting "funny" names (keywords, otherwise invalid identifiers) - - - - - Optimization information - - - - - Check if an expression has an effect - - - - - Combine optimization infos - - - - - Ensure that 'internal' items are not exported in the optimization info - - - - - Rewrite the module info using the export remapping - - - - - Saving and re-reading optimization information - - - - - Optimize one implementation file in the given environment - - - - - For building optimization environments incrementally - - - - - This function maps production indexes returned in syntax errors to strings representing the non terminal that would be produced by that production - - - - - This function maps production indexes returned in syntax errors to strings representing the non terminal that would be produced by that production - - - - - Represents the typechecked, elaborated form of a pattern, prior to pattern-match compilation. - - - - - What should the decision tree contain for any incomplete match? - - - - - Compile a pattern into a decision tree and a set of targets. - - - - - Implements a set of checks on the TAST for a file that can only be performed after type inference - is complete. - - - - - Determines if the specified name is a valid name for an active pattern. - - - - - Try to chop "get_" or "set_" from a string. - If the string does not start with "get_" or "set_", this function raises an exception. - - - - - Try to chop "get_" or "set_" from a string - - - - - Is this character a part of a long identifier? - - - - - The characters that are allowed to be in an identifier. - - - - - The characters that are allowed to be the first character of an identifier. - - - - - Decompiles a mangled operator name back into an operator. - For example, "op_DereferencePercent" becomes "!%". - This function accepts mangled names for both built-in and custom operators. - - - - - Decompiles the mangled name of a custom operator back into an operator. - For example, "op_DereferencePercent" becomes "!%". - This function should only be used for mangled names of custom operators; - if a mangled name potentially represents a built-in operator, - use the 'DecompileOpName' function instead. - - - - - Compiles an operator into a mangled operator name. - For example, "!%" becomes "op_DereferencePercent". - This function accepts both built-in and custom operators. - - - - - Compiles a custom operator into a mangled operator name. - For example, "!%" becomes "op_DereferencePercent". - This function should only be used for custom operators; - if an operator is or potentially may be a built-in operator, - use the 'CompileOpName' function instead. - - - - - The set of characters usable in custom operators. - - - - - Prefix for compiled (mangled) operator names. - - - - - Anything to do with special names of identifiers and other lexical rules - - - - - Indicates an F# 3.0+ reference to a named type in an assembly loaded by name - - - - - Indicates an F# 4.0+ reference into the supplied table of type definition references, ultimately resolved by TypeRef/TypeDef data - - - - - Code to pickle out quotations in the quotation binary format. - - - - - Indicates that type references are emitted as integer indexes into a supplied table - - - - - Represents a range using zero-based line counting (used by Visual Studio) - - - - - Represents a position using zero-based line counting (used by Visual Studio) - - - - - Represents a line number when using zero-based line counting (used by Visual Studio) - - - - - Synthetic marks ranges which are produced by intermediate compilation phases. This - bit signifies that the range covers something that should not be visible to language - service operations like dot-completion. - - - - - The maximum number of bits needed to store an encoded position - - - - - not a total order, but enough to sort on ranges - - - - - This view hides the use of file indexes and just uses filenames - - - - - This view of range marks uses file indexes explicitly - - - - - Create a position for the given line and column - - - - - Convert a range from one-based line counting (used internally in the F# compiler and in F# error messages) to zero-based line counting (used by Visual Studio) - - - - - Convert a position from one-based line counting (used internally in the F# compiler and in F# error messages) to zero-based line counting (used by Visual Studio) - - - - - Convert a position from zero-based line counting (used by Visual Studio) to one-based line counting (used internally in the F# compiler and in F# error messages) - - - - - Convert a line number from one-based line counting (used internally in the F# compiler and in F# error messages) to zero-based line counting (used by Visual Studio) - - - - - Convert a line number from zero-based line counting (used by Visual Studio) to one-based line counting (used internally in the F# compiler and in F# error messages) - - - - - Rational arithmetic, used for exponents on units-of-measure - - - - - Tokenize a single line, returning token information and a tokenization state represented by an integer - - - - - Tokenize an entire file, line by line - - - - - For errors, quick info, goto-definition, declaration list intellisense, method overload intellisense - - - - - For analysis of a project - - - - - Return information about matching braces in a single file. - - - - - TypeCheck and compile provided AST - - - - - Compiles to a dynamic assembly usinng the given flags. Any source files names - are resolved via the FileSystem API. An output file name must be given by a -o flag, but this will not - be written - instead a dynamic assembly will be created and loaded. - - If the 'execute' parameter is given the entry points for the code are executed and - the given TextWriters are used for the stdout and stderr streams respectively. In this - case, a global setting is modified during the execution. - - - - - TypeCheck and compile provided AST - - - - - Compile using the given flags. Source files names are resolved via the FileSystem API. The output file must be given by a -o flag. - - - - - Create a singleton global isntance for checking and compiling F# scripts - - - - - Provides simpler version of services for checking and compiling F# scripts - - - - - Get the full type checking results - - - - - Return the errors resulting from the type-checking - - - - - Get the data tip text at the given position - - - - - Get the Visual Studio F1-help keyword for the item at the given position - - - - - Get the location of the declaration at the given position - - - - - Get the declarations at the given code location. - - - - - Represents the results of type checking. A mild simplification of SourceCodeService's CheckFileResults. - Normally it is better to use the full CheckFileResults directly, available from 'FullResults'. - - - - - Get the name of a declaration - - - - - Compute the description for a declaration - - - - - Represents a declaration returned by GetDeclarations. Simpler than the one in 'SourceCodeServices' because - it formats the XML content for you (apart from ones read from XML doc files using xmlCommentRetriever) - - - - - Renamed to FSharpCheckFileAnswer - - - - - Renamed to FSharpCheckFileResults - - - - - Renamed to FSharpProjectOptions - - - - - Renamed to FSharpCheckProjectResults - - - - - Renamed to FSharpTokenizerColorState - - - - - The default location of FSharp.Core.dll and fsc.exe based on the version of fsc.exe that is running - - - - - Information about the compilation environment - - - - - Renamed to FSharpToolTipText - - - - - Renamed to FSharpDeclarationListItem - - - - - Renamed to FSharpDeclarationListInfo - - - - - Renamed to FSharpNavigationDeclarationItem - - - - - Renamed to FSharpNavigationDeclarationItemKind - - - - - Renamed to FSharpDeclarationListInfo - - - - - The declared or inferred type of the parameter - - - - - The optional name of the parameter - - - - - Indicate this is an out argument - - - - - Indicate this is an optional argument - - - - - Indicate this is an in argument - - - - - The declared attributes of the parameter - - - - - Represents a parameter in an abstract method of a class or interface - - - - - Get the name of the abstract slot - - - - - Get the generic arguments of the abstract slot - - - - - Get the generic arguments of the type defining the abstract slot - - - - - Get the declaring type of the abstract slot - - - - - Get the return type of the abstract slot - - - - - Get the arguments of the abstract slot - - - - - Represents the signature of an abstract slot of a class or interface - - - - - Indicates the symbol has public accessibility - - - - - Indicates the symbol has private accessibility - - - - - Indicates the symbol has internal accessibility - - - - - Indicates the accessibility of a symbol, as seen by the F# language - - - - - Represents the rights of a compilation to access symbols - - - - - XML documentation signature for the active pattern case, used for .xml file lookup for compiled code - - - - - Get the in-memory XML documentation for the active pattern case, used when code is checked in-memory - - - - - The name of the active pattern case - - - - - The group of active pattern cases this belongs to - - - - - The location of declaration of the active pattern case - - - - - A subtype of FSharpSymbol that represents a single case within an active pattern - - - - - Get the type indicating signature of the active pattern - - - - - The names of the active pattern cases - - - - - Indicate this is a total active pattern - - - - - Try to get the enclosing entity of the active pattern - - - - - Represents all cases within an active pattern - - - - - The simple name for the assembly - - - - - The qualified name of the assembly - - - - - Indicates if the assembly was generated by a type provider and is due for static linking - - - - - The file name for the assembly, if any - - - - - The contents of the this assembly - - - - - Represents an assembly as seen by the F# language - - - - - The contents of the implementation files in the assembly - - - - - Represents the definitional contents of an assembly, as seen by the F# language - - - - - The (non-nested) module and type definitions in this signature - - - - - Get the declared attributes for the assembly. - Only available when parsing an entire project. - - - - - Represents an inferred signature of part of an assembly as seen by the F# language - - - - - The named arguments for the attribute - - - - - Indicates if the attribute type is in an unresolved assembly - - - - - The arguments to the constructor for the attribute - - - - - The type of the attribute - - - - - Format the attribute using the rules of the given display context - - - - - Represents a custom attribute attached to F# source code or a compiler .NET component - - - - - The result of calling TypeCheckResult including the possibility of abort and background compiler not caught up. - - - - - Get the resolution of the ProjectOptions - - - - - Get a view of the contents of the assembly up to and including the file just checked - - - - - Indicates whether type checking successfully occured with some results returned. If false, indicates that - an unrecoverable error in earlier checking/parsing/resolution steps. - - - - - The errors returned by parsing a source file. - - - - - Get the textual usages that resolved to the given symbol throughout the file - - - - Compute a formatted tooltip for the given location - - The line number where the information is being requested. - The column number at the end of the identifiers where the information is being requested. - The text of the line where the information is being requested. - The identifiers at the location where the information is being requested. - Used to discriminate between 'identifiers', 'strings' and others. For strings, an attempt is made to give a tooltip for a #r "..." location. Use a value from FSharpTokenInfo.Tag, or FSharpTokenTag.Identifier, unless you have other information available. - - - Resolve the names at the given location to a use of symbol. - - The line number where the information is being requested. - The column number at the end of the identifiers where the information is being requested. - The text of the line where the information is being requested. - The identifiers at the location where the information is being requested. - - - Compute a set of method overloads to show in a dialog relevant to the given code location. The resulting method overloads are returned as symbols. - The line number where the information is being requested. - The column number at the end of the identifiers where the information is being requested. - The text of the line where the information is being requested. - The identifiers at the location where the information is being requested. - - - Compute a set of method overloads to show in a dialog relevant to the given code location. - - The line number where the information is being requested. - The column number at the end of the identifiers where the information is being requested. - The text of the line where the information is being requested. - The identifiers at the location where the information is being requested. - - - Get the locations of format specifiers - - - Compute the Visual Studio F1-help key identifier for the given location, based on name resolution results - - The line number where the information is being requested. - The column number at the end of the identifiers where the information is being requested. - The text of the line where the information is being requested. - The identifiers at the location where the information is being requested. - - - Get any extra colorization info that is available after the typecheck - - - Resolve the names at the given location to the declaration location of the corresponding construct. - - The line number where the information is being requested. - The column number at the end of the identifiers where the information is being requested. - The text of the line where the information is being requested. - The identifiers at the location where the information is being requested. - If not given, then get the location of the symbol. If false, then prefer the location of the corresponding symbol in the implementation of the file (rather than the signature if present). If true, prefer the location of the corresponding symbol in the signature of the file (rather than the implementation). - - - Get the items for a declaration list in FSharpSymbol format - - - If this is present, it is used to filter declarations based on location in the - parse tree, specifically at 'open' declarations, 'inherit' of class or interface - 'record field' locations and r.h.s. of 'range' operator a..b - - The line number where the completion is happening - The column number (1-based) at the end of the 'names' text - The long identifier to the left of the '.' - The residue of a partial long identifier to the right of the '.' - The residue of a partial long identifier to the right of the '.' - - The text of the line where the completion is happening. This is only used to make a couple - of adhoc corrections to completion accuracy (e.g. checking for "..") - - - If text has been used from a captured name resolution from the typecheck, then - callback to the client to check if the text has changed. If it has, then give up - and assume that we're going to repeat the operation later on. - - - - Get the items for a declaration list - - - If this is present, it is used to filter declarations based on location in the - parse tree, specifically at 'open' declarations, 'inherit' of class or interface - 'record field' locations and r.h.s. of 'range' operator a..b - - The line number where the completion is happening - The column number (1-based) at the end of the 'names' text - The long identifier to the left of the '.' - The residue of a partial long identifier to the right of the '.' - The residue of a partial long identifier to the right of the '.' - - The text of the line where the completion is happening. This is only used to make a couple - of adhoc corrections to completion accuracy (e.g. checking for "..") - - - If text has been used from a captured name resolution from the typecheck, then - callback to the client to check if the text has changed. If it has, then give up - and assume that we're going to repeat the operation later on. - - - - - Get all textual usages of all symbols throughout the file - - - - - A handle to the results of CheckFileInProject. - - - - - Get the resolution of the ProjectOptions - - - - - Indicates if critical errors existed in the project options - - - - - The errors returned by processing the project - - - - - Get a view of the overall signature of the assembly. Only valid to use if HasCriticalErrors is false. - - - - - Get a view of the overall contents of the assembly. Only valid to use if HasCriticalErrors is false. - - - - - Get the textual usages that resolved to the given symbol throughout the project - - - - - Get all textual usages of all symbols throughout the project - - - - - A handle to the results of CheckFileInProject. - - - - - Get or set the pause time in milliseconds before background work is started. - - - - - A maximum number of megabytes of allocated memory. If the figure reported by <c>System.GC.GetTotalMemory(false)</c> goes over this limit, the FSharpChecker object will attempt to free memory and reduce cache sizes to a minimum.</param> - - - - - Get or set a flag which controls if background work is started implicitly. - - If true, calls to CheckFileInProject implicitly start a background check of that project, replacing - any other background checks in progress. This is useful in IDE applications with spare CPU cycles as - it prepares the project analysis results for use. The default is 'true'. - - - - - Notify the host that a project has been fully checked in the background (using file contents provided by the file system API) - - The event may be raised on a background thread. - - - - - Get or set the pause time in milliseconds before background work is started. - - - - - Raised after the maxMB memory threshold limit is reached - - - - - A maximum number of megabytes of allocated memory. If the figure reported by <c>System.GC.GetTotalMemory(false)</c> goes over this limit, the FSharpChecker object will attempt to free memory and reduce cache sizes to a minimum.</param> - - - - - Get or set a flag which controls if background work is started implicitly. - - If true, calls to CheckFileInProject implicitly start a background check of that project, replacing - any other background checks in progress. This is useful in IDE applications with spare CPU cycles as - it prepares the project analysis results for use. The default is 'true'. - - - - - Report a statistic for testability - - - - - Report a statistic for testability - - - - - Raised after a parse of a file in the background analysis. - - The event will be raised on a background thread. - - - - - Raised after a check of a file in the background analysis. - - The event will be raised on a background thread. - - - - - Current queue length of the service, for debug purposes. - In addition, a single async operation or a step of a background build - may be in progress - such an operation is not counted in the queue length. - - - - - Notify the host that the logical type checking context for a file has now been updated internally - and that the file has become eligible to be re-typechecked for errors. - - The event will be raised on a background thread. - - - - - Block until the background compile finishes. - - - - - Try to get type check results for a file. This looks up the results of recent type checks of the - same file, regardless of contents. The version tag specified in the original check of the file is returned. - If the source of the file has changed the results returned by this function may be out of date, though may - still be usable for generating intellisense menus and information. - - The filename for the file. - The options for the project or script, used to determine active --define conditionals and other options relevant to parsing. - Optionally, specify source that must match the previous parse precisely. - - - - Stop the background compile. - - - - - Parse a source code file, returning a handle that can be used for obtaining navigation bar information - To get the full information, call 'CheckFileInProject' method on the result - All files except the one being checked are read from the FileSystem API - - - The filename for the file. - The full source for the file. - The options for the project or script, used to determine active --define conditionals and other options relevant to parsing. - - - - Parse and typecheck all files in a project. - All files are read from the FileSystem API - - - The options for the project or script. - - - - - Parse and check a source code file, returning a handle to the results - - - Note: all files except the one being checked are read from the FileSystem API - - - Return FSharpCheckFileAnswer.Aborted if a parse tree was not available or if the check - - - - The name of the file in the project whose source is being checked. - An integer that can be used to indicate the version of the file. This will be returned by TryGetRecentTypeCheckResultsForFile when looking up the file. - The full source for the file. - The options for the project or script. - - A callback to check if a requested result is already obsolete, e.g. because of changed - - - An item passed back to 'hasTextChangedSinceLastTypecheck' to help determine if - an approximate intellisense resolution is inaccurate because a range of text has changed. This - can be used to marginally increase accuracy of intellisense results in some situations. - - - - - - This function is called when a project has been cleaned/rebuilt, and thus any live type providers should be refreshed. - - - - - Parse a source code file, returning information about brace matching in the file. - Return an enumeration of the matching parenthetical tokens in the file. - - - The filename for the file, used to help caching of results. - The full source for the file. - The options for the project or script, used to determine active --define conditionals and other options relevant to parsing. - - - - This function is called when the configuration is known to have changed for reasons not encoded in the ProjectOptions. - For example, dependent references may have been deleted or created. - - - - - This function is called when the entire environment is known to have changed for reasons not encoded in the ProjectOptions of any project/compilation. - For example, the type provider approvals file may have changed. - - - - - For a given script file, get the FSharpProjectOptions implied by the #load closure. - All files are read from the FileSystem API, except the file being checked. - - - Used to differentiate between scripts, to consider each script a separate project. - Also used in formatted error messages. - - Indicates when the script was loaded into the editing environment, - so that an 'unload' and 'reload' action will cause the script to be considered as a new project, - so that references are re-resolved. - - - - Get the FSharpProjectOptions implied by a set of command line arguments. - - - Used to differentiate between projects and for the base directory of the project. - The command line arguments for the project build. - Indicates when the script was loaded into the editing environment, - so that an 'unload' and 'reload' action will cause the script to be considered as a new project, - so that references are re-resolved. - - - - Like ParseFileInProject, but uses results from the background builder. - All files are read from the FileSystem API, including the file being checked. - - - The filename for the file. - The options for the project or script, used to determine active --define conditionals and other options relevant to parsing. - - - - Like ParseFileInProject, but uses the existing results from the background builder. - All files are read from the FileSystem API, including the file being checked. - - - The filename for the file. - The options for the project or script, used to determine active --define conditionals and other options relevant to parsing. - - - - Create an instance of an FSharpChecker. - - - - - Create an instance of an FSharpChecker. - - - The optional size of the project checking cache. - Keep the checked contents of projects. - If false, do not keep full intermediate checking results from background checking suitable for returning from GetBackgroundCheckResultsForFileInProject. This reduces memory usage. - - - - Flush all caches and garbage collect - - - - - Set the project to be checked in the background. Overrides any previous call to <c>CheckProjectInBackground</c> - - - - - Check a source code file, returning a handle to the results of the parse including - the reconstructed types in the file. - - All files except the one being checked are read from the FileSystem API - Note: returns NoAntecedent if the background builder is not yet done preparing the type check context for the - file (e.g. loading references and parsing/checking files in the project that this file depends upon). - In this case, the caller can either retry, or wait for FileTypeCheckStateIsDirty to be raised for this file. - - - - The results of ParseFileInProject for this file. - The name of the file in the project whose source is being checked. - An integer that can be used to indicate the version of the file. This will be returned by TryGetRecentTypeCheckResultsForFile when looking up the file. - The full source for the file. - The options for the project or script. - - A callback to check if a requested result is already obsolete, e.g. because of changed - - - An item passed back to 'hasTextChangedSinceLastTypecheck' to help determine if - an approximate intellisense resolution is inaccurate because a range of text has changed. This - can be used to marginally increase accuracy of intellisense results in some situations. - - - - - - - Check a source code file, returning a handle to the results - - - Note: all files except the one being checked are read from the FileSystem API - - - Return FSharpCheckFileAnswer.Aborted if a parse tree was not available or if the check - - - - The results of ParseFileInProject for this file. - The name of the file in the project whose source is being checked. - An integer that can be used to indicate the version of the file. This will be returned by TryGetRecentTypeCheckResultsForFile when looking up the file. - The full source for the file. - The options for the project or script. - - A callback to check if a requested result is already obsolete, e.g. because of changed - - - An item passed back to 'hasTextChangedSinceLastTypecheck' to help determine if - an approximate intellisense resolution is inaccurate because a range of text has changed. This - can be used to marginally increase accuracy of intellisense results in some situations. - - - - - - Used to parse and check F# source code. - - - - - Renamed to FSharpDeclarationListItem - - - - - Represents a set of declarations in F# source code, with information attached ready for display by an editor. - Returned by GetDeclarations. - - - - - Get the display name for the declaration. - - - - - Get the glyph integer for the declaration as used by Visual Studio. - - - - - Get the description text, asynchronously. Never returns "Loading...". - - - - - Get the description text for the declaration. Commputing this property may require using compiler - resources and may trigger execution of a type provider method to retrieve documentation. - - May return "Loading..." if timeout occurs - - - - - Represents a declaration in F# source code, with information attached ready for display by an editor. - Returned by GetDeclarations. - - - - - Renamed to FSharpDeclarationListInfo - - - - - Get the return type of the delegate signature - - - - - Get the argument types of the delegate signature - - - - - Represents a delegate signature in an F# symbol - - - - - Represents the information needed to format types and other information in a style - suitable for use in F# source text at a particular source location. - - Acquired via GetDisplayEnvAtLocationAlternate and simialr methods. May be passed - to the Format method on FSharpType and other methods. - - - - - Get the XML documentation signature for the entity, used for .xml file lookup for compiled code - - - - - Get the in-memory XML documentation for the entity, used when code is checked in-memory - - - - - Indicates if the type prefers the "tycon<a,b>" syntax for display etc. - - - - - Get the cases of a union type - - - - - Get the full name of the type or module if it is available - - - - - Get the static parameters for a provided type - - - - - Get the declared accessibility of the representation, not taking signatures into account - - - - - Get the fully qualified name of the type or module - - - - - Get the modules and types defined in a module, or the nested types of a type - - - - - Get the namespace containing the type or module, if any. Use 'None' for item not in a namespace. - - - - - Get the properties, events and methods of a type definitions, or the functions and values of a module - - - - - Get the name of the type or module, possibly with `n mangling - - - - - Indicates if the entity is a struct or enum - - - - - Indicates if the entity is in an unresolved assembly - - - - - Indicates if the entity is a 'fake' symbol related to a static instantiation of a type provider - - - - - Indicates if the entity is a generated provided type - - - - - Indicates if the entity is an erased provided type - - - - - Indicates if the entity is a provided type - - - - - Indicates if the entity is a type definitio for a reference type where the implementation details are hidden by a signature - - - - - Indicates if the entity is a part of a namespace path - - - - - Indicates if the entity is a measure definition - - - - - Indicates if the entity is an interface type definition - - - - - Indicates if the entity is union type - - - - - Indicates if the entity is record type - - - - - Indicates if the entity is an F# module definition - - - - - Indicates an F# exception declaration - - - - - Indicates if the entity is a measure, type or exception abbreviation - - - - - Indicates if this is a reference to something in an F#-compiled assembly - - - - - Indicates if the entity is an enum type definition - - - - - Indicates if the entity is a delegate type definition - - - - - Indicates if the entity is a class type definition - - - - - Indicates if is the 'byref<_>' type definition used for byref types in F#-compiled assemblies - - - - - Indicates if the entity is an array type - - - - - Indicates that a module is compiled to a class with the given mangled name. The mangling is reversed during lookup - - - - - Indicates if the type is implemented through a mapping to IL assembly code. This is only - true for types in FSharp.Core.dll - - - - - Get the generic parameters, possibly including unit-of-measure parameters - - - - - Get the full name of the type or module - - - - - Get the fields of a record, class, struct or enum from the perspective of the F# language. - This includes static fields, the 'val' bindings in classes and structs, and the value definitions in enums. - For classes, the list may include compiler generated fields implied by the use of primary constructors. - - - - - Indicates if the type is a delegate with the given Invoke signature - - - - - Get the name of the type or module as displayed in F# code - - - - - Get the declared interface implementations - - - - - Get the declaration location for the type constructor - - - - - Get the compiled name of the type or module, possibly with `n mangling. This is identical to LogicalName - unless the CompiledName attribute is used. - - - - - Get the base type, if any - - - - - Get the declared attributes for the type - - - - - Get all the interface implementations, by walking the type hierarchy - - - - - Get the declared accessibility of the type - - - - - Get the path used to address the entity (e.g. "Namespace.Module1.NestedModule2"). Gives - "global" for items not in a namespace. - - - - - Get the type abbreviated by an F# type abbreviation - - - - - A subtype of FSharpSymbol that represents a type definition or module as seen by the F# language - - - - - The type of the expression - - - - - The range of the expression - - - - - The immediate sub-expressions of the expression. - - - - - Represents a checked and reduced expression, as seen by the F# language. The active patterns - in 'FSharp.Compiler.SourceCodeServices' can be used to analyze information about the expression. - - Pattern matching is reduced to decision trees and conditional tests. Some other - constructs may be represented in reduced form. - - - - - Get the XML documentation signature for .xml file lookup for the field, used for .xml file lookup for compiled code - - - - - Get the in-memory XML documentation for the field, used when code is checked in-memory - - - - - Get the attributes attached to generated property - - - - - Get the name of the field - - - - - Get the default initialization info, for static literals - - - - - Indicates if the field is declared volatile - - - - - Indicates if the record field is for a type in an unresolved assembly - - - - - Indicates a static field - - - - - Indicates if the field is declared 'static' - - - - - Indicates if the field has a literal value - - - - - Indicates if the field declared is declared 'DefaultValue' - - - - - Indicates a compiler generated field, not visible to Intellisense or name resolution - - - - - Get the type of the field, w.r.t. the generic parameters of the enclosing type constructor - - - - - Get the attributes attached to generated field - - - - - Get the declaring entity of this field - - - - - Get the declaration location of the field - - - - - Indicates if the declared visibility of the field, not taking signatures into account - - - - - A subtype of FSharpSymbol that represents a record or union case field as seen by the F# language - - - - - Trying to find declaration of ProvidedMember without TypeProviderDefinitionLocationAttribute - - - - - Trying to find declaration of ProvidedType without TypeProviderDefinitionLocationAttribute - - - - - Source code file is not available - - - - - Generic reason: no particular information about error - - - - - Represents the reason why the GetDeclarationLocation operation failed. - - - - - Indicates a declaration location was found - - - - - Indicates a declaration location was not found, with an additional reason - - - - - Represents the result of the GetDeclarationLocation operation. - - - - - Get the in-memory XML documentation for the type parameter, used when code is checked in-memory - - - - - Get the name of the generic parameter - - - - - Indicates if this is a statically resolved type variable - - - - - Indicates if this is a measure variable - - - - - Indicates if this is a compiler generated type parameter - - - - - Get the range of the generic parameter - - - - - Get the declared or inferred constraints for the type parameter - - - - - Get the declared attributes of the type parameter. - - - - - A subtype of FSharpSymbol that represents a generic parameter for an FSharpSymbol - - - - - Gets further information about a choice constraint - - - - - Gets further information about a member constraint - - - - - Indicates a constraint that a type is an unmanaged type - - - - - Indicates a constraint that a type has a 'null' value - - - - - Indicates a constraint that is a type is a simple choice between one of the given ground types. Used by printf format strings. - - - - - Indicates a constraint that a type has a parameterless constructor - - - - - Indicates a constraint that a type is a reference type - - - - - Indicates a constraint that a type is a non-Nullable value type - - - - - Indicates a constraint that a type has a member with the given signature - - - - - Indicates a constraint that a type supports F# generic equality - - - - - Indicates a constraint that a type is an enum with the given underlying - - - - - Indicates a constraint that a type is a delegate from the given tuple of args to the given return type - - - - - Indicates a default value for an inference type variable should it be netiher generalized nor solved - - - - - Indicates a constraint that a type supports F# generic comparison - - - - - Indicates a constraint that a type is a subtype of the given type - - - - - Gets further information about an enumeration constraint - - - - - Gets further information about a delegate constraint - - - - - Gets further information about a defaults-to constraint - - - - - Gets further information about a coerces-to constraint - - - - - Represents a constraint on a generic type parameter - - - - - Get the default type associated with the 'defaults to' constraint - - - - - Get the priority off the 'defaults to' constraint - - - - - Represents further information about a 'defaults to' constraint on a generic type parameter - - - - - Get the tupled argument type required by the constraint - - - - - Get the return type required by the constraint - - - - - Represents further information about a delegate constraint on a generic type parameter - - - - - Get the types that may be used to satisfy the constraint - - - - - Get the return type of the method required by the constraint - - - - - Get the name of the method required by the constraint - - - - - Indicates if the the method required by the constraint must be static - - - - - Get the argument types of the method required by the constraint - - - - - Represents further information about a member constraint on a generic type parameter - - - - - Indicates if the implementation file is a script - - - - - Indicates if the implementation file has an explicit entry point - - - - - Get the declarations that make up this implementation file - - - - - Represents the definitional contents of a single file or fragment in an assembly, as seen by the F# language - - - - - Represents the declaration of a static initialization action - - - - - Represents the declaration of a member, function or value, including the parameters and body of the member - - - - - Represents the declaration of a type - - - - - Represents a declaration in an implementation file, as seen by the F# language - - - - - Indictes the value is never inlined - - - - - Indictes the value is optionally inlined - - - - - Indictes the value is inlined but compiled code for the function still exists, e.g. to satisfy interfaces on objects, but that it is also always inlined - - - - - Indictes the value is inlined and compiled code for the function does not exist - - - - - Scan one token from the line - - - - - Object to tokenize a line of F# source code, starting with the given lexState. The lexState should be 0 for - the first line of text. Returns an array of ranges of the text and two enumerations categorizing the - tokens and characters covered by that range, i.e. FSharpTokenColorKind and FSharpTokenCharKind. The enumerations - are somewhat adhoc but useful enough to give good colorization options to the user in an IDE. - - A new lexState is also returned. An IDE-plugin should in general cache the lexState - values for each line of the edited code. - - - - - Renamed to FSharpMemberOrFunctionOrValue - - - - - XML documentation signature for the value, used for .xml file lookup for compiled code - - - - - Get the in-memory XML documentation for the value, used when code is checked in-memory - - - - - Get an associated setter method of the property - - - - - Get the logical name of the member - - - - - Get the logical enclosing entity, which for an extension member is type being extended - - - - - Indicates if this is a [<Literal>] value, and if so what value? (may be null) - - - - - Indicates if the member, function or value is in an unresolved assembly - - - - - Indicates if this is an F# type function - - - - - Indicates if this is a setter method for a property, or a use of a property in setter mode - - - - - Indicates if this is a setter method for a property, or a use of a property in setter mode - - - - - Indicates if this is a getter method for a property, or a use of a property in getter mode - - - - - Indicates if this is a property member - - - - - Indicates if this is an 'override', 'default' or an explicit implementation of an interface member - - - - - Indicates if this is a mutable value - - - - - Indicates if this is a module or member value - - - - - Indicates if this is the "x" in "member x.M = ..." - - - - - Indicates if this is a member, including extension members? - - - - - Indicates if this is an instance member, when seen from F#? - - - - - Indicates if this is an implicit constructor? - - - - - Indicates if this is a getter method for a property, or a use of a property in getter mode - - - - - Indicates if this is an extension member? - - - - - Indicates if this is an explicit implementation of an interface member - - - - - Indicates if this is a remove method for an event - - - - - Indicates if this is an add method for an event - - - - - Indicates if this is an event member - - - - - Indicates if this is an abstract member? - - - - - Indicates if this is the "x" in "type C() as x = ..." - - - - - Indicates if this is a compiler generated value - - - - - Indicates if this is "base" in "base.M(...)" - - - - - Indicates if this value or member is an F# active pattern - - - - - Get a result indicating if this is a must-inline value - - - - - Gets the list of the abstract slot signatures implemented by the member - - - - - Indicates if this is a property and there exists an associated setter method - - - - - Indicates if this is a property and there exists an associated getter method - - - - - Get an associated getter method of the property - - - - - Get the typars of the member, function or value - - - - - Get the full type of the member, function or value when used as a first class value - - - - - Get an associated remove method of an event - - - - - Indicate if an event can be considered to be a property for the F# type system of type IEvent or IDelegateEvent. - In this case ReturnParameter will have a type corresponding to the property type. For - non-standard events, ReturnParameter will have a type corresponding to the delegate type. - - - - - Gets the event symbol implied by the use of a property, - for the case where the property is actually an F#-declared CLIEvent. - - Uses of F#-declared events are considered to be properties as far as the language specification - and this API are concerned. - - - - - Get an associated delegate type of an event - - - - - Get an associated add method of an event - - - - - Get the enclosing entity for the definition - - - - - Get the name as presented in F# error messages and documentation - - - - - Get the declaration location of the member, function or value - - - - - Get the member name in compiled code - - - - - Custom attributes attached to the value. These contain references to other values (i.e. constructors in types). Mutable to fixup - these value references after copying a colelction of values. - - - - - Get the accessibility information for the member, function or value - - - - - Gets the overloads for the current method - matchParameterNumber indicates whether to filter the overloads to match the number of parameters in the current symbol - - - - - A subtype of F# symbol that represents an F# method, property, event, function or value, including extension members. - - - - - Renamed to FSharpMemberOrFunctionOrValue - - - - - The methods (or other items) in the group - - - - - The shared name of the methods (or other items) in the group - - - - - Represents a group of methods (or other items) returned by GetMethods. - - - - - The formatted type text for the method (or other item) - - - - - The parameters of the method in the overload set - - - - - Indicates that this not really a method, but actually a static arguments list, like TP<42,"foo"> - - - - - The formatted description text for the method (or other item) - - - - - Represents one method (or other item) in a method group. The item may represent either a method or - a single, non-overloaded item such as union case or a named function value. - - - - - The name of the parameter. - - - - - The text to display for the parameter including its name, its type and visual indicators of other - information such as whether it is optional. - - - - - The descriptive help text to display for the parameter. - - - - - A key that can be used for sorting the parameters, used to help sort overloads. - - - - - Represents one parameter for one method (or other item) in a group. - - - - - Represents an item to be displayed in the navigation bar - - - - - Indicates a kind of item to show in an F# navigation bar - - - - - Represents result of 'GetNavigationItems' operation - this contains - all the members and currently selected indices. First level correspond to - types & modules and second level are methods etc. - - - - - Represents top-level declarations (that should be in the type drop-down) - with nested declarations (that can be shown in the member drop-down) - - - - - The generic parameters of the method - - - - - The parameters of the method - - - - - The expression that forms the body of the method - - - - - Represents a checked method in an object expression, as seen by the F# language. - - - - - The declared or inferred type of the parameter - - - - - The optional name of the parameter - - - - - Indicate this is a param array argument - - - - - Indicate this is an out argument - - - - - Indicate this is an optional argument - - - - - The declaration location of the parameter - - - - - The declared attributes of the parameter - - - - - A subtype of FSharpSymbol that represents a parameter - - - - - The syntax tree resulting from the parse - - - - - Indicates if any errors occured during the parse - - - - - Name of the file for which this information were created - - - - - Get the errors and warnings for the parse - - - - - When these files change then the build is invalid - - - - - Return the inner-most range associated with a possible breakpoint location - - - - - Get declared items and the selected item at the specified location - - - - - Notable parse info for ParameterInfo at a given location - - - - - Represents the results of parsing an F# file - - - - - Get the accessibility rights for this project context w.r.t. InternalsVisibleTo attributes granting access to other assemblies - - - - - Get the resolution and full contents of the assemblies referenced by the project options - - - - - Represents the checking context implied by the ProjectOptions - - - - - Unused in this API and should be 'None' - - - - - Timestamp of project/script load, used to differentiate between different instances of a project load. - This ensures that a complete reload of the project or script type checking - context occurs on project or script unload/reload. - - - - - When true, use the reference resolution rules for scripts rather than the rules for compiler. - - - - - When true, the typechecking environment is known a priori to be incomplete, for - example when a .fs file is opened outside of a project. In this case, the number of error - messages reported is reduced. - - - - - The command line arguments for the other projects referenced by this project, indexed by the - exact text used in the "-r:" reference in FSharpProjectOptions. - - - - - Additional command line argument options for the project. These can include additional files and references. - - - - - The files in the project - - - - A set of information describing a project or script build configuration. - - - - Renamed to FSharpField - - - - - Tokenizer for a source file. Holds some expensive-to-compute resources at the scope of the file. - - - - - Get the name of the static parameter - - - - - Get the kind of the static parameter - - - - - Indicates if the static parameter is optional - - - - - Get the default value for the static parameter - - - - - Get the declaration location of the static parameter - - - - - A subtype of FSharpSymbol that represents a static parameter to an F# type provider - - - - - Get the signature location for the symbol if it was declared in an implementation - - - - - Get the implementation location for the symbol if it was declared in a signature that has an implementation - - - - - Get a textual representation of the full name of the symbol. The text returned for some symbols - may not be a valid identifier path in F# code, but rather a human-readable representation of the symbol. - - - - - Gets the short display name for the symbol - - - - - Get the declaration location for the symbol - - - - - Get the assembly declaring this symbol - - - - - Return true if two symbols are effectively the same when referred to in F# source code text. - This sees through signatures (a symbol in a signature will be considered effectively the same as - the matching symbol in an implementation). In addition, other equivalances are applied - when the same F# source text implies the same declaration name - for example, constructors - are considered to be effectively the same symbol as the corresponding type definition. - - This is the relation used by GetUsesOfSymbol and GetUsesOfSymbolInFile. - - - - - Computes if the symbol is accessible for the given accessibilty rights - - - - - Internal use only. - - - - - Represents a symbol in checked F# source code or a compiled .NET component. - - The subtype of the symbol may reveal further information and can be one of FSharpEntity, FSharpUnionCase - FSharpField, FSharpGenericParameter, FSharpStaticParameter, FSharpMemberOrFunctionOrValue, FSharpParameter, - or FSharpActivePatternCase. - - - - - The symbol referenced - - - - - The range of text representing the reference to the symbol - - - - - Indicates if the reference is in a syntactic type - - - - - Indicates if the reference is in a pattern - - - - - Indicates if the reference is via the member being implemented in a class or object expression - - - - - Indicates if the reference is a definition for the symbol, either in a signature or implementation - - - - - Indicates if the reference is either a builder or a custom operation in a compuation expression - - - - - Indicates if the reference is in an attribute - - - - - The file name the reference occurs in - - - - - The display context active at the point where the symbol is used. Can be passed to FSharpType.Format - and other methods to format items in a way that is suitable for a specific source code location. - - - - - Represents the use of an F# symbol from F# source code - - - - - Gives an indication of the class to assign to the characters of the token an IDE - - - - - Gives an indicattion of the color class to assign to the token an IDE - - - - - The full length consumed by this match, including delayed tokens (which can be ignored in naive lexers) - - - - - Provides additional information about the token - - - - - The tag is an integer identifier for the token - - - - - Actions taken when the token is typed - - - - - Gives an indication of the class to assign to the token an IDE - - - - - Right column of the token. - - - - - Left column of the token. - - - - - Information about a particular token from the tokenizer - - - - - Gives an indication of what should happen when the token is typed in an IDE - - - - - Represents stable information for the state of the laxing engine at the end of a line - - - - - Represents encoded information for the end-of-line continutation of lexing - - - - - An error occurred formatting this element - - - - - For example, a method overload group. - - - - - A single type, method, etc with comment. - - - - - A single tool tip display element - - - - - A list of data tip elements to display. - - - - - Information for building a tool tip box. - - - - - Get the type definition for a type - - - - - Indicates this is a named type in an unresolved assembly - - - - - Indicates if the type is a tuple type. The GenericArguments property returns the elements of the tuple type. - - - - - Indicates if the type is a variable type, whether declared, generalized or an inference type parameter - - - - - Indicates if the type is a function type. The GenericArguments property returns the domain and range of the function type. - - - - - Indicates this is an abbreviation for another type - - - - - Indicates if the type is constructed using a named entity, including array and byref types - - - - - Get the generic parameter data for a generic parameter type - - - - - Get the generic arguments for a tuple type, a function type or a type constructed using a named entity - - - - - Get the base type, if any, taking into account the instantiation of this type - if it is an instantiation of a generic type. - - - - - Get all the interface implementations, by walking the type hierarchy, taking into account the instantiation of this type - if it is an instantiation of a generic type. - - - - - Get the type for which this is an abbreviation - - - - - Adjust the types in a group of curried parameters and return type by removing any occurrences of type inference variables, replacing them - systematically with lower-case type inference variables such as <c>'a</c>. - - - - - Adjust the types in a group of curried parameters by removing any occurrences of type inference variables, replacing them - systematically with lower-case type inference variables such as <c>'a</c>. - - - - - Adjust the types in a group of parameters by removing any occurrences of type inference variables, replacing them - systematically with lower-case type inference variables such as <c>'a</c>. - - - - - Adjust the type in a single parameter by removing any occurrences of type inference variables, replacing them - systematically with lower-case type inference variables such as <c>'a</c>. - - - - - Adjust a group of types by removing any occurrences of type inference variables, replacing them - systematically with lower-case type inference variables such as <c>'a</c>. - - - - - Adjust the type by removing any occurrences of type inference variables, replacing them - systematically with lower-case type inference variables such as <c>'a</c>. - - - - - Instantiate generic type parameters in a type - - - - - Format the type using the rules of the given display context - - - - - Internal use only. Create a ground type. - - - - - Get the XML documentation signature for .xml file lookup for the union case, used for .xml file lookup for compiled code - - - - - Get the in-memory XML documentation for the union case, used when code is checked in-memory - - - - - Get the data carried by the case. - - - - - Get the type constructed by the case. Normally exactly the type of the enclosing type, sometimes an abbreviation of it - - - - - Get the name of the union case - - - - - Indicates if the union case is for a type in an unresolved assembly - - - - - Get the range of the name of the case - - - - - Get the name of the case in generated IL code - - - - - Get the attributes for the case, attached to the generated static method to make instances of the case - - - - - Indicates if the declared visibility of the union constructor, not taking signatures into account - - - - - A subtype of FSharpSymbol that represents a union case as seen by the F# language - - - - - Indicates that the text for the documentation can be found in a .xml documentation file, using the given signature key - - - - - The text for documentation - - - - - No documentation is available - - - - - Describe a comment as either a block of text or a file+signature reference into an intellidoc file. - - - - - Renamed to FSharpFindDeclFailureReason - - - - - Renamed to FSharpFindDeclResult - - - - - Enqueue an operation and return immediately. - - - - - Put the operation in thq queue, and return an async handle to its result. - - - - - Represents the capability to schedule work in the compiler service operations queue for the compilation thread - - - - - Renamed to FSharpChecker - - - - - Callback which can be used by the host to indicate to the checker that a requested result has become obsolete, - e.g. because of typing by the user in the editor window. This can be used to marginally increase accuracy - of intellisense results in some situations. - - - - - Renamed to FSharpTokenizerLexState - - - - - Renamed to FSharpLineTokenizer - - - - - Renamed to FSharpMethodGroupItem - - - - - Renamed to FSharpMethodGroup - - - - - Renamed to FSharpMethodGroupItem - - - - - Renamed to FSharpNavigationItems - - - - - Renamed to FSharpNoteworthyParamInfoLocations - - - - - Obsolete and replaced - - - - - Renamed to FSharpMethodGroupItemParameter - - - - - Renamed to FSharpParseFileResults - - - - - Renamed to FSharpProjectContext - - - - - Renamed to FSharpProjectOptions - - - - - The timespan in milliseconds before background work begins after the operations queue is empty - - - - - Get the reactor for FSharp.Compiler.dll - - - - - The timespan in milliseconds before background work begins after the operations queue is empty - - - - - For debug purposes - - - - - Block until the current implicit background build is complete. Unit test only. - - - - - Set the background building function, which is called repeatedly - until it returns 'false'. If None then no background operation is used. - - - - - Enqueue an uncancellable operation and return immediately. - - - - - Put the operation in the queue, and return an async handle to its result. - - - - - Block until all operations in the queue are complete - - - - - Reactor is intended for long-running but interruptible operations, interleaved - with one-off asynchronous operations. - - It is used to guard the global compiler state while maintaining responsiveness on - the UI thread. - Reactor operations - - - - - Renamed to FSharpSourceTokenizer - - - - - Renamed to FSharpTokenCharKind - - - - - Renamed to FSharpTokenColorKind - - - - - Renamed to FSharpTokenInfo - - - - - Renamed to FSharpToolTipElement - - - - - Renamed to FSharpToolTipText - - - - - Renamed to FSharpNavigationTopLevelDeclaration - - - - - Renamed to FSharpTokenTriggerClass - - - - - Renamed to FSharpCheckFileAnswer - - - - - Renamed to FSharpCheckFileResults - - - - Unused in this API - - - - Renamed to FSharpParseFileResults - - - - - Renamed to FSharpXmlDoc - - - - - VisitTypeAbbrev(ty,m), defaults to ignoring this leaf of the AST - - - - - VisitModuleDecl allows overriding module declaration behavior - - - - - VisitMatchClause allows overriding clause behavior (note: by default it would defaultTraverse expression) - - - - - VisitImplicitInherit(defaultTraverse,ty,expr,m), defaults to just visiting expr - - - - - VisitExpr(path, traverseSynExpr, defaultTraverse, expr) - controls the behavior when a SynExpr is reached; it can just do - defaultTraverse(expr) if you have no special logic for this node, and want the default processing to pick which sub-node to dive deeper into - or can inject non-default behavior, which might incorporate: - traverseSynExpr(subExpr) to recurse deeper on some particular sub-expression based on your own logic - path helps to track AST nodes that were passed during traversal - - - - - VisitBinding allows overriding binding behavior (note: by default it would defaultTraverse expression) - - - - - used to track route during traversal AST - - - - - traverse an implementation file walking all the way down to SynExpr or TypeAbbrev at a particular location - - - - - - A range of utility functions to assist with traversing an AST - - - - - Matches expressions for an unresolved call to a trait - - - - - Matches object expressions, returning the base type, the base call, the overrides and the interface implementations - - - - - Matches expressions which set a field in a .NET type - - - - - Matches expressions which fetch a field from a .NET type - - - - - Matches expressions which are IL assembly code - - - - - Matches expressions which create an instance of a delegate type - - - - - Matches try/with expressions - - - - - Matches try/finally expressions - - - - - Matches while loops - - - - - Matches fast-integer loops (up or down) - - - - - Matches sequential expressions - - - - - Matches expressions which take the address of a location - - - - - Matches constant expressions, including signed and unsigned integers, strings, characters, booleans, arrays - of bytes and arrays of unit16. - - - - - Matches default-value expressions, including null expressions - - - - - Matches expressions which set the contents of a mutable variable - - - - - Matches expressions which set the contents of an address - - - - - Matches expressions which test the runtime type of a value - - - - - Matches array expressions - - - - - Matches expressions which coerce the type of a value - - - - - Matches expressions which get a value from a tuple - - - - - Matches tuple expressions - - - - - Matches expressions which test if an expression corresponds to a particular union case - - - - - Matches expressions which gets the tag for a union case - - - - - Matches expressions which set a field from a union case (only used in FSharp.Core itself) - - - - - Matches expressions which get a field from a union case - - - - - Matches expressions which create an object corresponding to a union case - - - - - Matches expressions which set a field in a record or class - - - - - Matches expressions which get a field from a record or class - - - - - Matches record expressions - - - - - Matches expressions which are let-rec definitions - - - - - Matches expressions which are quotation literals - - - - - Matches expressions which are uses of the 'base' value - - - - - Matches expressions which are uses of the 'this' value - - - - - Matches expressions which are calls to object constructors - - - - - Matches expressions which are calls to members or module-defined functions. When calling curried functions and members the - arguments are collapsed to a single collection of arguments, as done in the compiled version of these. - - - - - Matches expressions which are let definitions - - - - - Matches expressions which are conditionals - - - - - Matches expressions which are lambda abstractions - - - - - Special expressions at the end of a conditional decision structure in the decision expression node of a DecisionTree . - The given expressions are passed as values to the decision tree target. - - - - - Matches expressions with a decision expression, each branch of which ends in DecisionTreeSuccess pasing control and values to one of the targets. - - - - - Matches expressions which are type abstractions - - - - - Matches expressions which are the application of function values - - - - - Matches expressions which are uses of values - - - - - A collection of active patterns to analyze expressions - - - - - Return true if this is a subcategory of error or warning message that the language service can emit - - - - - Return the compilation defines that should be used when editing the given file. - - - - - These are the names of assemblies that should be referenced for .fs or .fsi files that - are not asscociated with a project. - - - - - Information about the compilation environment - - - - - Return the language ID, which is the expression evaluator id that the - debugger will use. - - - - - Information about the debugging environment - - - - - Indicates the token is a `"` - - - - - Indicates the token is a `->` - - - - - Indicates the token is a `||` - - - - - Indicates the token is a `:=` - - - - - Indicates the token is a `~` - - - - - Indicates the token is a `@@` - - - - - Indicates the token is a `::` - - - - - Indicates the token is a `|` - - - - - Indicates the token is a `|` - - - - - Indicates the token is a `:?` - - - - - Indicates the token is a `:?>` - - - - - Indicates the token is a `:>` - - - - - Indicates the token is a `_` - - - - - Indicates the token is a `..` - - - - - Indicates the token is a `..` - - - - - Indicates the token is a `..` - - - - - Indicates the token is a `.` - - - - - Indicates the token is a `,` - - - - - Indicates the token is a `;` - - - - - Indicates the token is a `=` - - - - - Indicates the token is a `:` - - - - - Indicates the token is a `?` - - - - - Indicates the token is a `^` - - - - - Indicates the token is a `%` - - - - - Indicates the token is a `%` - - - - - Indicates the token is a `*` - - - - - Indicates the token is a `-` - - - - - Indicates the token is a `+` or `-` - - - - - Indicates the token is a `|]` - - - - - Indicates the token is a `[|` - - - - - Indicates the token is a `>` - - - - - Indicates the token is a `<` - - - - - Indicates the token is a `>]` - - - - - Indicates the token is a `[<` - - - - - Indicates the token is a `}` - - - - - Indicates the token is a `{` - - - - - Indicates the token is a `]` - - - - - Indicates the token is a `[` - - - - - Indicates the token is a `)` - - - - - Indicates the token is a `(` - - - - - Indicates the token is an string (synonym for FSharpTokenTag.String) - - - - - Indicates the token is an identifier (synonym for FSharpTokenTag.Identifer) - - - - - Indicates the token is a string - - - - - Indicates the token is an identifier - - - - - Some of the values in the field FSharpTokenInfo.Tag - - - - - All the keywords in the F# langauge - - - - - A utility to help determine if an identifier needs to be quoted - - - - - A set of helpers related to naming of identifiers - - - - - Whether or not this file should be a single-file project - - - - - Whether or not this file is compilable - - - - - Information about F# source file names - - - - - Compute the hash value for the tainted value - - - - - Test whether the tainted value equals given value. Type providers are ignored (equal tainted values produced by different type providers are equal) - Failure in call to equality operation will be blamed on type provider of first operand - - - - - Test whether the tainted value equals given value. - Failure in call to equality operation will be blamed on type provider of first operand - - - - - Test whether the tainted value is null - - - - - An AbstractIL type representation that may include type variables - - - - - An AbstractIL type representation that is just the name of a type. - - CompiledTypeRepr.ILAsmNamed (ilTypeRef, ilBoxity, ilTypeOpt) - - The ilTypeOpt is present for non-generic types. It is an ILType corresponding to the first two elements of the case. This - prevents reallocation of the ILType each time we need to generate it. For generic types, it is None. - - - - - Specifies the compiled representations of type and exception definitions. Basically - just an ILTypeRef. Computed and cached by later phases. Stored in - type and exception definitions. Not pickled. Store an optional ILType object for - non-generic types. - - - - - See FreeTyvars above. - - - - - The summary of union constructors used in the expression. These may be - marked 'internal' or 'private' and we have to check various conditions associated with that. - - - - - The summary of fields used in the expression. These may be made private by a signature - or marked 'internal' or 'private' and we have to check various conditions associated with that. - - - - - The summary of locally defined tycon representations used in the expression. These may be made private by a signature - or marked 'internal' or 'private' and we have to check various conditions associated with that. - - - - - Indicates if the expression contains a call to rethrow that is not bound under a (try-)with branch. - Rethrow may only occur in such locations. - - - - - Indicates if the expression contains a call to a protected member or a base call. - Calls to protected members and direct calls to super classes can't escape, also code can't be inlined - - - - - The summary of locally defined variables used in the expression. These may be hidden at let bindings etc. - or made private by a signature or marked 'internal' or 'private', and we have to check various conditions associated with that. - - - - - Represents the set of free variables in an expression - - - - - Represents an amortized computation of the free variables in an expression - - - - - The summary of type parameters used in the expression. These may not escape the enclosing generic construct - and we have to check various conditions associated with that. - - - - - The summary of values used as trait solutions - - - - - The summary of locally defined type definitions used in the expression. These may be made private by a signature - and we have to check various conditions associated with that. - - - - - Represents a set of 'free' type-related elements, including named types, trait solutions, union cases and - record fields. - - - - - Represents a set of 'free' union cases. Used to collect the union cases referred to from an expression. - - - - - Represents a set of 'free' record field definitions. Used to collect the record field definitions referred to - from an expression. - - - - - Represents a set of 'free' named type definitions. Used to collect the named type definitions referred to - from a type or expression. - - - - - Represents a set of free type parameters - - - - - Represents a set of free local values. - - - - - Represents a complete typechecked assembly, made up of multiple implementation files. - - - - - - This ModuleOrNamespace that represents the compilation of a module as a class. - The same set of tycons etc. are bound in the ModuleOrNamespace as in the ModuleOrNamespaceExpr - This is the body of the module/namespace - Represents a complete typechecked implementation file, including its typechecked signature if any. - - TImplFile(qualifiedNameOfFile,pragmas,implementationExpressionWithSignature,hasExplicitEntryPoint,isScript) - - - - - A named module-or-namespace-fragment definition - - - - - Indicates the module fragment is a 'rec' definition of types, values and modules - - - - - Indicates the module fragment is an evaluation of expression for side-effects - - - - - Indicates the module fragment is a 'let' definition - - - - - Indicates the module fragment is made of several module fragments in succession - - - - - Indicates the module is a module with a signature - - - - - The contents of a module-or-namespace-fragment definition - - - - - The ModuleOrNamespaceType is a binder. However it is not used in the ModuleOrNamespaceExpr: it is only referenced from the 'outside' - - - - - A type for a module-or-namespace-fragment and the actual definition of the module-or-namespace-fragment - - - - - Represents a parameter to an abstract method slot. - - TSlotParam(nm,ty,inFlag,outFlag,optionalFlag,attribs) - - - - - Represents an abstract method slot, or delegate signature. - - TSlotSig(methodName,declaringType,declaringTypeParameters,methodTypeParameters,slotParameters,returnTy) - - - - - A representation of a method in an object expression. - - TObjExprMethod(slotsig,attribs,methTyparsOfOverridingMethod,methodParams,methodBodyExpr,m) - - - - - Indicates the kind of an F# core library static optimization construct - - - - - A call to a base method, e.g. 'base.OnPaint(args)' - - - - - A call to a constructor, e.g. 'new C() = new C(3)' - - - - - A call to a constructor, e.g. 'inherit C()' - - - - - A normal use of a value - - - - - Indicates a use of a value represents a call to a method that may require - a .NET 2.0 constrained call. A constrained call is only used for calls where - - - - - Indicates how a value, function or member is being used at a particular usage point. - - - - - let res = a in b;res - - - - - a ; b - - - - - Indicates the kind of sequential operation, i.e. "normal" or "to a before returning b" - - - - - In C syntax this is: *localv_ptr = e - - - - - In C syntax this is: localv = e , note == *(&localv) = e == LGetAddr; LByrefSet - - - - - In C syntax this is: *localv_ptr - - - - - In C syntax this is: &localv - - - - - Indicates what kind of pointer operation this is. - - - - - Evaluate start once and end multiple times, loop up - - - - - Evaluate start and end once, loop down - - - - - Evaluate start and end once, loop up - - - - - Indicates the kind of looping operation. - - - - - Indicates the kind of looping operation. - - - - - If this is Some(ty) then it indicates that a .NET 2.0 constrained call is required, with the given type as the - static type of the object argument. - - - - - Normal record construction - - - - - We're in an explicit constructor. The purpose of the record expression is to - fill in the fields of a pre-created but uninitialized object - - - - - Indicates the kind of record construction operation. - - - - - ILCall(useCallvirt,isProtected,valu,newobj,valUseFlags,isProp,noTailCall,mref,actualTypeInst,actualMethInst, retTy) - - IL method calls. - value -- is the object a value type? - isProp -- used for quotation reflection. - noTailCall - DllImport? if so don't tailcall - actualTypeInst -- instantiation of the enclosing type - actualMethInst -- instantiation of the method - retTy -- the types of pushed values, if any - - - - - Operation nodes representing C-style operations on byrefs and mutable vals (l-values) - - - - - Pseudo method calls. This is used for overloaded operations like op_Addition. - - - - - Used for state machine compilation - - - - - Used for state machine compilation - - - - - Used for state machine compilation - - - - - Represents a "rethrow" operation. May not be rebound, or used outside of try-finally, expecting a unit argument - - - - - Conversion node, compiled via type-directed translation or to box/unbox - - - - - Generate a ldflda on an 'a ref. - - - - - IL assembly code - type list are the types pushed on the stack - - - - - An operation representing a field-get from an F# tuple value. - - - - - An operation representing a field-set on an F# exception value. - - - - - An operation representing a field-get from an F# exception value. - - - - - An operation representing a field-get from a union value. The value is not assumed to have been proven to be of the corresponding union case. - - - - - An operation representing a field-get from a union value, where that value has been proven to be of the corresponding union case. - - - - - An operation representing a coercion that proves a union value is of a particular union case. This is not a test, its - simply added proof to enable us to generate verifiable code for field access on union types - - - - - An operation representing getting an integer tag for a union value representing the union case number - - - - - An operation representing getting the address of a record field - - - - - An operation representing getting a record or class field - - - - - An operation representing setting a record or class field - - - - - Construct a record or object-model value. The ValRef is for self-referential class constructors, otherwise - it indicates that we're in a constructor and the purpose of the expression is to - fill in the fields of a pre-created but uninitialized object, and to assign the initialized - version of the object into the optional mutable cell pointed to be the given value. - - - - - An operation representing a lambda-encoded try/finally - - - - - An operation representing a lambda-encoded try/catch - - - - - An operation representing a lambda-encoded for loop - - - - - An operation representing a lambda-encoded while loop. The special while loop marker is used to mark compilations of 'foreach' expressions - - - - - Constant uint16 arrays (used for parser tables) - - - - - Constant byte arrays (used for parser tables and other embedded data) - - - - - An operation representing the creation of an array value - - - - - An operation representing the creation of a tuple value - - - - - An operation representing the creation of an exception value using an F# exception declaration - - - - - An operation representing the creation of a union value of the particular union case - - - - - Typechecking residue: A Expr.Link occurs for every use of a recursively bound variable. While type-checking - the recursive bindings a dummy expression is stored in the mutable reference cell. - After type checking the bindings this is replaced by a use of the variable, perhaps at an - appropriate type instantiation. These are immediately eliminated on subsequent rewrites. - - - - - Typechecking residue: Indicates a free choice of typars that arises due to - minimization of polymorphism at let-rec bindings. These are - resolved to a concrete instantiation on subsequent rewrites. - - - - - An intrinsic applied to some (strictly evaluated) arguments - A few of intrinsics (TOp_try, TOp.While, TOp.For) expect arguments kept in a normal form involving lambdas - - - - - If we statically know some information then in many cases we can use a more optimized expression - This is primarily used by terms in the standard library, particularly those implementing overloaded - operators. - - - - - Matches are a more complicated form of "let" with multiple possible destinations - and possibly multiple ways to get to each destination. - The first mark is that of the expression being matched, which is used - as the mark for all the decision making and binding that happens during the match. - - - - - Bind a value. - - - - - Bind a recursive set of values. - - - - - Applications. - Applications combine type and term applications, and are normalized so - that sequential applications are combined, so "(f x y)" becomes "f [[x];[y]]". - The type attached to the function is the formal function type, used to ensure we don't build application - nodes that over-apply when instantiating at function types. - - - - - Type lambdas. These are used for the r.h.s. of polymorphic 'let' bindings and - for expressions that implement first-class polymorphic values. - - - - - Lambda expressions. - Why multiple vspecs? A Expr.Lambda taking multiple arguments really accepts a tuple. - But it is in a convenient form to be compile accepting multiple - arguments, e.g. if compiled as a toplevel static method. - - - - - Sequence expressions, used for "a;b", "let a = e in b;a" and "a then b" (the last an OO constructor). - - - - - Reference a value. The flag is only relevant if the value is an object model member - and indicates base calls and special uses of object constructors. - - - - - A constant expression. - - - - - The big type of expressions. - - - - - Records the extra metadata stored about typars for type parameters - compiled as "real" IL type parameters, specifically for values with - ValReprInfo. Any information here is propagated from signature through - to the compiled code. - - - - - Records the "extra information" for an argument compiled as a real - method argument, specifically the argument name and attributes. - - - - - ValReprInfo (numTypars, args, result) - - - - - Records the "extra information" for a value compiled as a method (rather - than a closure or a local), including argument names, attributes etc. - - - - - A target of a decision tree. Can be thought of as a little function, though is compiled as a local block. - - - - - Test.ActivePatternCase(activePatExpr, activePatResTys, activePatIdentity, idx, activePatInfo) - - Run the active pattern and bind a successful result to a - variable in the remaining tree. - activePatExpr -- The active pattern function being called, perhaps applied to some active pattern parameters. - activePatResTys -- The result types (case types) of the active pattern. - activePatIdentity -- The value and the types it is applied to. If there are any active pattern parameters then this is empty. - idx -- The case number of the active pattern which the test relates to. - activePatternInfo -- The extracted info for the active pattern. - - - - - IsInst(source, target) - - Test if the input to a decision tree is an instance of the given type - - - - - Test if the input to a decision tree is null - - - - - Test if the input to a decision tree is the given constant value - - - - - Test if the input to a decision tree is an array of the given length - - - - - Test if the input to a decision tree matches the given union case - - - - - TDBind(binding, body) - - Bind the given value through the remaining cases of the dtree. - These arise from active patterns and some optimizations to prevent - repeated computations in decision trees. - binding -- the value and the expression it is bound to - body -- the rest of the decision tree - - - - - TDSuccess(results, targets) - - Indicates the decision tree has terminated with success, calling the given target with the given parameters. - results -- the expressions to be bound to the variables at the target - target -- the target number for the continuation - - - - - TDSwitch(input, cases, default, range) - - Indicates a decision point in a decision tree. - input -- the expression being tested - cases -- the list of tests and their subsequent decision trees - default -- the default decision tree, if any - range -- (precise documentation needed) - - - - - Decision trees. Pattern matching has been compiled down to - a decision tree by this point. The right-hand-sides (actions) of - the decision tree are labelled by integers that are unique for that - particular tree. - - - - - Constants in expressions - - - - - AttribNamedArg(name,type,isField,value) - - - - - AttribExpr(source, evaluated) - - - - - We keep both source expression and evaluated expression around to help intellisense and signature printing - - - - - Attrib(kind,unnamedArgs,propVal,appliedToAGetterOrSetter,targetsOpt,range) - - - - - Indicates an attribute refers to a type defined in an imported F# assembly - - - - - Indicates an attribute refers to a type defined in an imported .NET assembly - - - - - Represents the information saved in the assembly signature data resource for an F# assembly - - - - - The result of attempting to resolve an assembly name to a full ccu. - UnresolvedCcu will contain the name of the assembly that could not be resolved. - - - - - ccu.orphanfixup is true when a reference is missing in the transitive closure of static references that - may potentially be required for the metadata of referenced DLLs. It is set to true if the "loader" - used in the F# metadata-deserializer or the .NET metadata reader returns a failing value (e.g. None). - Note: When used from Visual Studio, the loader will not automatically chase down transitively referenced DLLs - they - must be in the explicit references in the project. - - - - - Indicates that this DLL uses F# 2.0+ quotation literals somewhere. This is used to implement a restriction on static linking. - - - - - Indicates that this DLL uses F# 2.0+ quotation literals somewhere. This is used to implement a restriction on static linking. - - - - - The table of type forwarders for this assembly - - - - - A unique stamp for this DLL - - - - - A hint as to where does the code for the CCU live (e.g what was the tcConfig.implicitIncludeDir at compilation time for this DLL?) - - - - - The table of type definitions at the "root" of the assembly - - - - - The table of modules and namespaces at the "root" of the assembly - - - - - The fully qualified assembly reference string to refer to this assembly. This is persisted in quotations - - - - - Is the CCu an EST injected assembly - - - - - Indicates that this DLL was compiled using the F# compiler and has F# metadata - - - - - Holds the data indicating how this assembly/module is referenced from the code being compiled. - - - - - Holds the filename for the DLL, if any - - - - - A handle to the full specification of the contents of the module contained in this ccu - - - - - Try to resolve a path into the CCU by referencing the .NET/CLI type forwarder table of the CCU - - - - - Used to make forward calls into the type/assembly loader when comparing member signatures during linking - - - - - Used to make 'forward' calls into the loader during linking - - - - - Fixup a CCU to record it as "orphaned", i.e. not available - - - - - Fixup a CCU to have the given contents - - - - - Ensure the ccu is derefable in advance. Supply a path to attach to any resulting error message. - - - - - Create a CCU with the given name but where the contents have not yet been specified - - - - - Create a CCU with the given name and contents - - - - - A relinkable handle to the contents of a compilation unit. Relinking is performed by mutation. - A compilation unit is, more or less, the new material created in one - invocation of the compiler. Due to static linking assemblies may hold more - than one compilation unit (i.e. when two assemblies are merged into a compilation - the resulting assembly will contain 3 CUs). Compilation units are also created for referenced - .NET assemblies. - - References to items such as type constructors are via - cross-compilation-unit thunks, which directly reference the data structures that define - these modules. Thus, when saving out values to disk we only wish - to save out the "current" part of the term graph. When reading values - back in we "fixup" the links to previously referenced modules. - - All non-local accesses to the data structures are mediated - by ccu-thunks. Ultimately, a ccu-thunk is either a (named) element of - the data structure, or it is a delayed fixup, i.e. an invalid dangling - reference that has not had an appropriate fixup applied. - - - - - Represents a table of .NET CLI type forwarders for an assembly - - - - - The table of .NET CLI type forwarders for this assembly - - - - - A helper function used to link method signatures using type equality. This is effectively a forward call to the type equality - logic in tastops.fs - - - - - A handle to the full specification of the contents of the module contained in this ccu - - - - - Indicates that this DLL uses pre-F#-4.0 quotation literals somewhere. This is used to implement a restriction on static linking - - - - - A helper function used to link method signatures using type equality. This is effectively a forward call to the type equality - logic in tastops.fs - - - - - Triggered when the contents of the CCU are invalidated - - - - - Is the CCu an assembly injected by a type provider - - - - - Indicates that this DLL was compiled using the F# compiler and has F# metadata - - - - - A hint as to where does the code for the CCU live (e.g what was the tcConfig.implicitIncludeDir at compilation time for this DLL?) - - - - - The fully qualified assembly reference string to refer to this assembly. This is persisted in quotations - - - - - A unique stamp for this DLL - - - - - Holds the data indicating how this assembly/module is referenced from the code being compiled. - - - - - Holds the filename for the DLL, if any - - - - - Raising a measure to a rational power - - - - - The unit of measure '1', e.g. float = float<1> - - - - - An inverse of a units of measure expression - - - - - A product of two units of measure - - - - - A constant, leaf unit-of-measure such as 'kg' or 'm' - - - - - A variable unit-of-measure - - - - - Indicates the type is a unit-of-measure expression being used as an argument to a type or member - - - - - Indicates the type is a variable type, whether declared, generalized or an inference type parameter - - - - - TType_ucase(unionCaseRef, typeInstantiation) - - Indicates the type is a non-F#-visible type representing a "proof" that a union value belongs to a particular union case - These types are not user-visible and will never appear as an inferred type. They are the types given to - the temporaries arising out of pattern matching on union values. - - - - - TType_fun(domainType,rangeType). - - Indicates the type is a function type - - - - - TType_tuple(elementTypes). - - Indicates the type is a tuple type. elementTypes must be of length 2 or greater. - - - - - TType_app(tyconRef, typeInstantiation). - - Indicates the type is build from a named type and a number of type arguments - - - - - TType_forall(typars, bodyTy). - - Indicates the type is a universal type, only used for types of values and members - - - - - The algebra of types - - - - - Indicates a reference to something bound in another CCU - - - - - Indicates a reference to something bound in this CCU - - - - - Get or set the signature for the value's XML documentation - - - - - Get the declared documentation for the value - - - - - Records the "extra information" for a value compiled as a method. - - This indicates the number of arguments in each position for a curried function. - - - - - Get the type of the value including any generic type parameters - - - - - The type of the value. May be a TType_forall for a generic value. - May be a type variable or type containing type variables during type inference. - - - - - Dereference the ValRef to a Val option. - - - - - Get the actual parent entity for the value (a module or a type), i.e. the entity under which the - value will appear in compiled code. For extension members this is the module where the extension member - is declared. - - - - - Get the type of the value after removing any generic type parameters - - - - - A unique stamp within the context of this invocation of the compiler process - - - - - The quotation expression associated with a value given the [<ReflectedDefinition>] tag - - - - - Get the information about a recursive value used during type inference - - - - - Get the public path to the value, if any? Should be set if and only if - IsMemberOrModuleBinding is set. - - - - - Get the name of the value, assuming it is compiled as a property. - - If this is a property then this is 'Foo' - - If this is an implementation of an abstract slot then this is the name of the property implemented by the abstract slot - - - - - Indicates if this value allows the use of an explicit type instantiation (i.e. does it itself have explicit type arguments, - or does it have a signature?) - - - - - Get the number of 'this'/'self' object arguments for the member. Instance extension members return '1'. - - - - - Indicates whether the inline declaration for the value indicate that the value must be inlined? - - - - - Is this a member, if so some more data about the member. - - - - - Get the apparent parent entity for a member - - - - - Indicates if this is inferred to be a method or function that definitely makes no critical tailcalls? - - - - - The value of a value or member marked with [<LiteralAttribute>] - - - - - Indicates if this value was a member declared 'override' or an implementation of an interface slot - - - - - Indicates if this value is declared 'mutable' - - - - - Indicates if this is an F#-defined value in a module, or an extension member, but excluding compiler generated bindings from optimizations - - - - - Is this a member definition or module definition? - - - - - Indicates if this is a member - - - - - Indicates if this is an F#-defined instance member. - - Note, the value may still be (a) an extension member or (b) and abstract slot without - a true body. These cases are often causes of bugs in the compiler. - - - - - Indicates if this is a member generated from the de-sugaring of 'let' function bindings in the implicit class syntax? - - - - - Indicates if this is a constructor member generated from the de-sugaring of implicit constructor for a class type? - - - - - Indicates if this is an F#-defined extension member - - - - - Indicates if this member is an F#-defined dispatch slot. - - - - - Indicates if this is an F#-defined 'new' constructor member - - - - - Indicates whether this value was generated by the compiler. - - Note: this is true for the overrides generated by hash/compare augmentations - - - - - Is this represented as a "top level" static binding (i.e. a static field, static member, - instance member), rather than an "inner" binding that may result in a closure. - - - - - Get the inline declaration on the value - - - - - Dereference the ValRef to a Val. - - - - - The name of the method in compiled code (with some exceptions where ilxgen.fs decides not to use a method impl) - - - - - Indicates if this is a 'base' or 'this' value? - - - - - Get the declared attributes for the value - - - - - Get the apparent parent entity for the value, i.e. the entity under with which the - value is associated. For extension members this is the nominal type the member extends. - For other values it is just the actual parent. - - - - - The parent type or module, if any (None for expression bindings and parameters) - - - - - Get the value representing the accessibility of an F# type definition or module. - - - - - References are either local or nonlocal - - - - - note: ModuleOrNamespaceRef and TyconRef are type equivalent - - - - - Indicates a reference to something bound in another CCU - - - - - Indicates a reference to something bound in this CCU - - - - - The XML documentation sig-string of the entity, if any, to use to lookup an .xml doc file. This also acts - as a cache for this sig-string computation. - - - - - The XML documentation of the entity, if any. If the entity is backed by provided metadata - then this _does_ include this documentation. If the entity is backed by Abstract IL metadata - or comes from another F# assembly then it does not (because the documentation will get read from - an XML file). - - - - - Get the union cases and other union-type information for a type, if any - - - - - Get the union cases for a type, if any, as a list - - - - - Get the union cases for a type, if any - - - - - The information about the r.h.s. of a type definition, if any. For example, the r.h.s. of a union or record type. - - - - - Get the value representing the accessibility of the r.h.s. of an F# type definition. - - - - - The kind of the type definition - is it a measure definition or a type definition? - - - - - The logical contents of the entity when it is a type definition. - - - - - Indicates if this entity is an F# type abbreviation definition - - - - - Get the type parameters for an entity that is a type declaration, otherwise return the empty list. - - - - - Dereference the TyconRef to a Tycon option. - - - - - Get a list of all instance fields for F#-defined record, struct and class fields in this type definition, - excluding compiler-generate fields. - - - - - Get a list of all fields for F#-defined record, struct and class fields in this type definition, - including static fields, but excluding compiler-generate fields. - - - - - A unique stamp for this module, namespace or type definition within the context of this compilation. - Note that because of signatures, there are situations where in a single compilation the "same" - module, namespace or type may have two distinct Entity objects that have distinct stamps. - - - - - The signature definition location of the namespace, module or type - - - - - The code location where the module, namespace or type is defined. - - - - - Get a blob of data indicating how this type is nested in other namespaces, modules or types. - - - - - Indicates if we have pre-determined that a type definition has a default constructor. - - - - - The logical contents of the entity when it is a module or namespace fragment. - - - - - Gets the immediate members of an F# type definition, excluding compiler-generated ones. - Note: result is alphabetically sorted, then for each name the results are in declaration order - - - - - Gets all immediate members of an F# type definition keyed by name, including compiler-generated ones. - Note: result is a indexed table, and for each name the results are in reverse declaration order - - - - - The name of the namespace, module or type, possibly with mangling, e.g. List`1, List or FailureException - - - - - Indicate if this is a type whose r.h.s. is known to be a union type definition. - - - - - Indicates if this entity is an F# type abbreviation definition - - - - - Indicates if this is a struct or enum type definition , i.e. a value type definition - - - - - Indicates if the entity is an erased provided type definition that incorporates a static instantiation (and therefore in some sense compiler generated) - - - - - Indicates if this is an F# type definition whose r.h.s. is known to be a record type definition. - - - - - Indicates if the entity is a provided namespace fragment - - - - - Indicates if the entity is a generated provided type definition, i.e. not erased. - - - - - Indicates if the entity is an erased provided type definition - - - - - Indicates if the entity is a provided namespace fragment - - - - - Indicates the type prefers the "tycon<a,b>" syntax for display etc. - - - - - Indicates if the entity is a namespace - - - - - Indicates the "tycon blob" is actually a module - - - - - Indicates if the entity is an F# module definition - - - - - Indicates if this is an F# type definition which is one of the special types in FSharp.Core.dll like 'float<_>' which - defines a measure type with a relation to an existing non-measure type as a representation. - - - - - Indicate if this is a type definition backed by Abstract IL metadata. - - - - - Indicates if this is a .NET-defined struct or enum type definition , i.e. a value type definition - - - - - Indicates if this is a .NET-defined enum type definition - - - - - Indicates if this is an F# type definition whose r.h.s. definition is unknown (i.e. a traditional ML 'abstract' type in a signature, - which in F# is called a 'unknown representation' type). - - - - - Indicates if this is an F#-defined struct or enum type definition , i.e. a value type definition - - - - - Indicates if this is an F# type definition whose r.h.s. is known to be some kind of F# object model definition - - - - - Indicates if this is an F#-defined interface type definition - - - - - Indicates if this is an F#-defined enum type definition - - - - - Indicates if this is an F#-defined delegate type definition - - - - - Indicates if the entity represents an F# exception declaration. - - - - - Indicates if the entity is erased, either a measure definition, or an erased provided type definition - - - - - Indicates if this is an enum type definition - - - - - Indicates if this is an F# type definition which is one of the special types in FSharp.Core.dll which uses - an assembly-code representation for the type, e.g. the primitive array type constructor. - - - - - Gets the immediate interface definitions of an F# type definition. Further interfaces may be supported through class and interface inheritance. - - - - - Gets the immediate interface types of an F# type definition. Further interfaces may be supported through class and interface inheritance. - - - - - The identifier at the point of declaration of the type definition. - - - - - Get the Abstract IL metadata for this type definition, assuming it is backed by Abstract IL metadata. - - - - - Get the Abstract IL scope, nesting and metadata for this - type definition, assuming it is backed by Abstract IL metadata. - - - - - Indicates if we have pre-determined that a type definition has a self-referential constructor using 'as x' - - - - - Gets any implicit hash/equals (with comparer argument) methods added to an F# record, union or struct type definition. - - - - - Gets any implicit hash/equals methods added to an F# record, union or struct type definition. - - - - - Gets any implicit CompareTo (with comparer argument) methods added to an F# record, union or struct type definition. - - - - - Gets any implicit CompareTo methods added to an F# record, union or struct type definition. - - - - - Get the blob of information associated with an F# object-model type definition, i.e. class, interface, struct etc. - - - - - The information about the r.h.s. of an F# exception definition, if any. - - - - - The display name of the namespace, module or type with <_,_,_> added for generic types, including static parameters - - - - - The display name of the namespace, module or type, e.g. List instead of List`1, including static parameters - - - - - The display name of the namespace, module or type, e.g. List instead of List`1, not including static parameters - - - - - Dereference the TyconRef to a Tycon. Amortize the cost of doing this. - This path should not allocate in the amortized case - - - - - Demangle the module name, if FSharpModuleWithSuffix is used - - - - - The implementation definition location of the namespace, module or type - - - - - Gets the data indicating the compiled representation of a named type or module in terms of Abstract IL data structures. - - - - - Gets the data indicating the compiled representation of a type or module in terms of Abstract IL data structures. - - - - - Get the cache of the compiled ILTypeRef representation of this module or type. - - - - - The compiled name of the namespace, module or type, e.g. FSharpList`1, ListModule or FailureException - - - - - Get a blob of data indicating how this type is nested inside other namespaces, modules and types. - - - - - Get a blob of data indicating how this type is nested inside other namespaces, modules and types. - - - - - Is the destination assembly available? - - - - - The F#-defined custom attributes of the entity, if any. If the entity is backed by Abstract IL or provided metadata - then this does not include any attributes from those sources. - - - - - Get a list of all instance fields for F#-defined record, struct and class fields in this type definition. - including hidden fields from the compilation of implicit class constructions. - - - - - Get a list of fields for all the F#-defined record, struct and class fields in this type definition, including - static fields, 'val' declarations and hidden fields from the compilation of implicit class constructions. - - - - - Get an array of fields for all the F#-defined record, struct and class fields in this type definition, including - static fields, 'val' declarations and hidden fields from the compilation of implicit class constructions. - - - - - Get a table of fields for all the F#-defined record, struct and class fields in this type definition, including - static fields, 'val' declarations and hidden fields from the compilation of implicit class constructions. - - - - - Get the value representing the accessibility of an F# type definition or module. - - - - - Get the type parameters for an entity that is a type declaration, otherwise return the empty list. - - Lazy because it may read metadata, must provide a context "range" in case error occurs reading metadata. - - - - - Get a union case of a type by name - - - - - Get a field by name. - - - - - Get a field by index in definition order - - - - - Get the path into the CCU referenced by the nonlocal reference. - - - - - Get the details of the module or namespace fragment for the entity referred to by this non-local reference. - - - - - Get the mangled name of the last item in the path of the nonlocal reference. - - - - - Get the all-but-last names of the path of the nonlocal reference. - - - - - Dereference the nonlocal reference, and raise an error if this fails. - - - - - Get the CCU referenced by the nonlocal reference. - - - - - Get the name of the assembly referenced by the nonlocal reference. - - - - - Try to find the entity corresponding to the given path, using type-providers to link the data - - - - - Try to find the entity corresponding to the given path in the given CCU - - - - - Try to link a non-local entity reference to an actual entity - - - - - Index into the namespace/module structure of a particular CCU - - - - - The name of the value, or the full signature of the member - - - - - A reference to the entity containing the value or member. THis will always be a non-local reference - - - - - Gets updated with 'true' if an abstract slot is implemented in the file being typechecked. Internal only. - - - - - Updated with the full implemented slotsig after interface implementation relation is checked - - - - - The parent type. For an extension member this is the type being extended - - - - - XML documentation signature for the value - - - - - XML documentation attached to a value. - - - - - Custom attributes attached to the value. These contain references to other values (i.e. constructors in types). Mutable to fixup - these value references after copying a collection of values. - - - - - Is the value actually an instance method/property/event that augments - a type, and if so what name does it take in the IL? - - - - - How visible is this? - - - - - What is the original, unoptimized, closed-term definition, if any? - Used to implement [<ReflectedDefinition>] - - - - - See vflags section further below for encoding/decodings here - - - - - If this field is populated, this is the implementation range for an item in a signature, otherwise it is - the signature range for an item in an implementation - - - - -Get the signature for the value's XML documentation - - - - -Get the signature for the value's XML documentation - - - - - Get the declared documentation for the value - - - - - Records the "extra information" for a value compiled as a method. - - This indicates the number of arguments in each position for a curried - functions, and relates to the F# spec for arity analysis. - For module-defined values, the currying is based - on the number of lambdas, and in each position the elements are - based on attempting to deconstruct the type of the argument as a - tuple-type. - - The field is mutable because arities for recursive - values are only inferred after the r.h.s. is analyzed, but the - value itself is created before the r.h.s. is analyzed. - - TLR also sets this for inner bindings that it wants to - represent as "top level" bindings. - - - - - Get the type of the value including any generic type parameters - - - - - The type of the value. - May be a TType_forall for a generic value. - May be a type variable or type containing type variables during type inference. - - - - - Get the generic type parameters for the value - - - - - Get the actual parent entity for the value (a module or a type), i.e. the entity under which the - value will appear in compiled code. For extension members this is the module where the extension member - is declared. - - - - - Get the type of the value after removing any generic type parameters - - - - - A unique stamp within the context of this invocation of the compiler process - - - - - Range of the definition (signature) of the value, used by Visual Studio - - - - - The quotation expression associated with a value given the [<ReflectedDefinition>] tag - - - - - Get the information about the value used during type inference - - - - - The place where the value was defined. - - - - - Get the public path to the value, if any? Should be set if and only if - IsMemberOrModuleBinding is set. - - - - - - If this is a property then this is 'Foo' - - If this is an implementation of an abstract slot then this is the name of the property implemented by the abstract slot - - - - - Indicates if this value allows the use of an explicit type instantiation (i.e. does it itself have explicit type arguments, - or does it have a signature?) - - - - - Get the number of 'this'/'self' object arguments for the member. Instance extension members return '1'. - - - - - Indicates whether the inline declaration for the value indicate that the value must be inlined? - - - - - Is this a member, if so some more data about the member. - - Note, the value may still be (a) an extension member or (b) and abstract slot without - a true body. These cases are often causes of bugs in the compiler. - - - - - Get the apparent parent entity for a member - - - - - Indicates if this is inferred to be a method or function that definitely makes no critical tailcalls? - - - - - The name of the method. - - If this is a property then this is 'get_Foo' or 'set_Foo' - - If this is an implementation of an abstract slot then this is the name of the method implemented by the abstract slot - - If this is an extension member then this will be the simple name - - - - - The value of a value or member marked with [<LiteralAttribute>] - - - - - The partial information used to index the methods of all those in a ModuleOrNamespace. - - - - - The full information used to identify a specific overloaded method amongst all those in a ModuleOrNamespace. - - - - - Indicates if this value was a member declared 'override' or an implementation of an interface slot - - - - - Indicates if this is declared 'mutable' - - - - - Indicates if this is an F#-defined value in a module, or an extension member, but excluding compiler generated bindings from optimizations - - - - - Is this a member definition or module definition? - - - - - Indicates if this is a member - - - - - Indicates if a value is linked to backing data yet. Only used during unpickling of F# metadata. - - - - - Indicates if this is a member, excluding extension members - - - - - Indicates if this is an F#-defined instance member. - - Note, the value may still be (a) an extension member or (b) and abstract slot without - a true body. These cases are often causes of bugs in the compiler. - - - - - Indicates if this is a member generated from the de-sugaring of 'let' function bindings in the implicit class syntax? - - - - - Indicates if this is a constructor member generated from the de-sugaring of implicit constructor for a class type? - - - - - Indicates if this is an F#-defined extension member - - - - - Indicates if this member is an F#-defined dispatch slot. - - - - - Indicates if this is an F#-defined 'new' constructor member - - - - - Indicates whether this value was generated by the compiler. - - Note: this is true for the overrides generated by hash/compare augmentations - - - - - Indicates if this is something compiled into a module, i.e. a user-defined value, an extension member or a compiler-generated value - - - - - Is this represented as a "top level" static binding (i.e. a static field, static member, - instance member), rather than an "inner" binding that may result in a closure. - - This is implied by IsMemberOrModuleBinding, however not vice versa, for two reasons. - Some optimizations mutate this value when they decide to change the representation of a - binding to be IsCompiledAsTopLevel. Second, even immediately after type checking we expect - some non-module, non-member bindings to be marked IsCompiledAsTopLevel, e.g. 'y' in - 'let x = let y = 1 in y + y' (NOTE: check this, don't take it as gospel) - - - - - Indicates if the backing field for a static value is suppressed. - - - - - Indicates if this is a compiler-generated class constructor member - - - - - Get the inline declaration on the value - - - - - Indicates if this is ever referenced? - - - - - - If this is a property then this is 'Foo' - - If this is an implementation of an abstract slot then this is the name of the method implemented by the abstract slot - - If this is an operator then this is '(+)' - - - - - Range of the definition (implementation) of the value, used by Visual Studio - - - - - The name of the method. - - If this is a property then this is 'Foo' - - If this is an implementation of an abstract slot then this is the name of the method implemented by the abstract slot - - If this is an operator then this is 'op_Addition' - - - - - The name of the method in compiled code (with some exceptions where ilxgen.fs decides not to use a method impl) - - If this is a property then this is 'get_Foo' or 'set_Foo' - - If this is an implementation of an abstract slot then this may be a mangled name - - If this is an extension member then this will be a mangled name - - If this is an operator then this is 'op_Addition' - - - - - Indicates if this is a 'base' or 'this' value? - - - - - Get the declared attributes for the value - - - - - Get the apparent parent entity for the value, i.e. the entity under with which the - value is associated. For extension members this is the nominal type the member extends. - For other values it is just the actual parent. - - - - - The parent type or module, if any (None for expression bindings and parameters) - - - - - How visible is this value, function or member? - - - - - Create a new value with empty, unlinked data. Only used during unpickling of F# metadata. - - - - - Create a new value with the given backing data. Only used during unpickling of F# metadata. - - - - - Link a value based on empty, unlinked data to the given data. Only used during unpickling of F# metadata. - - - - - The full type of the value for the purposes of linking. May be None for non-members, since they can't be overloaded. - - - - - The partial information used to index the value in a ModuleOrNamespace. - - - - - The full information used to identify a specific overloaded method - amongst all those in a ModuleOrNamespace. - - - - - Indicates the total argument count of the member. - - - - - Indicates the logical name of the member. - - - - - Indicates if the member is an override. - - - - - The name of the type with which the member is associated. None for non-member values. - - - - - The partial information used to index the methods of all those in a ModuleOrNamespace. - - - - - Indicates a trait is solved by a 'fake' instance of an operator, like '+' on integers - - - - - ClosedExprSln(expr) - - Indicates a trait is solved by an erased provided expression - - - - - ILMethSln(typ, extOpt, ilMethodRef, minst) - - Indicates a trait is solved by a .NET method. - typ -- the type and its instantiation - extOpt -- information about an extension member, if any - ilMethodRef -- the method that solves the trait constraint - minst -- the generic method instantiation - - - - - FSRecdFieldSln(tinst, rfref, isSetProp) - - Indicates a trait is solved by an F# record field. - tinst -- the instantiation of the declaring type - rfref -- the reference to the record field - isSetProp -- indicates if this is a set of a record field - - - - - FSMethSln(typ, vref, minst) - - Indicates a trait is solved by an F# method. - typ -- the type and its instantiation - vref -- the method that solves the trait constraint - minst -- the generic method instantiation - - - - - Indicates the solution of a member constraint during inference. - - - - - TTrait(tys,nm,memFlags,argtys,rty,colution) - - Indicates the signature of a member constraint. Contains a mutable solution cell - to store the inferred solution of the constraint. - - - - - Get or set the solution of the member constraint during inference - - - - - Get or set the solution of the member constraint during inference - - - - - Get the return type recorded in the member constraint. - - - - - Get the member name associated with the member constraint. - - - - - The specification of a member constraint that must be solved - - - - - Indicates a constraint that a type is .NET unmanaged type - - - - - Indicates a constraint that a type is a delegate from the given tuple of args to the given return type - - - - - Indicates a constraint that a type does not have the Equality(false) attribute, or is not a structural type with this attribute, with special rules for some known structural container types - - - - - Indicates a constraint that a type implements IComparable, with special rules for some known structural container types - - - - - Indicates a constraint that a type is an enum with the given underlying - - - - - Indicates a constraint that a type has a parameterless constructor - - - - - Indicates a constraint that a type is a simple choice between one of the given ground types. Only arises from 'printf' format strings. See format.fs - - - - - Indicates a constraint that a type is a reference type - - - - - Indicates a constraint that a type is a non-Nullable value type - These are part of .NET's model of generic constraints, and in order to - generate verifiable code we must attach them to F# generalized type variables as well. - - - - - Indicates a constraint that a type has a member with the given signature - - - - - Indicates a constraint that a type has a 'null' value - - - - - Indicates a default value for an inference type variable should it be neither generalized nor solved - - - - - Indicates a constraint that a type is a subtype of the given type - - - - - A cached TAST type used when this type variable is used as type. - - - - - Indicates if the type variable has a static "head type" requirement, i.e. ^a variables used in FSharp.Core and member constraints. - - - - - The unique stamp of the type parameter - - - - - The inferred equivalence for the type inference variable, if any. - - - - - Indicates if the type variable can be solved or given new constraints. The status of a type variable - generally always evolves towards being either rigid or solved. - - - - - The range of the identifier for the type parameter definition - - - - - The name of the type parameter - - - - - Indicates whether a type variable can be instantiated by types or units-of-measure. - - - - - Indicates if a type variable has been solved. - - - - - Indicates if a type variable has been linked. Only used during unpickling of F# metadata. - - - - - Indicates if the type inference variable was generated after an error when type checking expressions or patterns - - - - - Indicates whether a type variable is erased in compiled .NET IL code, i.e. whether it is a unit-of-measure variable - - - - - Indicates if the type variable is compiler generated, i.e. is an implicit type inference variable - - - - - The identifier for a type parameter definition - - - - - Indicates that whether or not a generic type definition satisfies the equality constraint is dependent on whether this type variable satisfies the equality constraint. - - - - - Indicates if a type parameter is needed at runtime and may not be eliminated - - - - - Indicates the display name of a type variable - - - - - The inferred constraints for the type inference variable, if any - - - - - Indicates that whether or not a generic type definition satisfies the comparison constraint is dependent on whether this type variable satisfies the comparison constraint. - - - - - The declared attributes of the type parameter. Empty for type inference variables and parameters from .NET - - - - - Sets whether a type variable has a static requirement - - - - - Sets the rigidity of a type variable - - - - - Sets the identifier associated with a type variable - - - - - Sets whether the equality constraint of a type definition depends on this type variable - - - - - Sets whether a type variable is required at runtime - - - - - Sets whether a type variable is compiler generated - - - - - Sets whether the comparison constraint of a type definition depends on this type variable - - - - - Creates a type variable that contains empty data, and is not yet linked. Only used during unpickling of F# metadata. - - - - - Creates a type variable based on the given data. Only used during unpickling of F# metadata. - - - - - Links a previously unlinked type variable to the given data. Only used during unpickling of F# metadata. - - - - - Adjusts the constraints associated with a type variable - - - - - A declared generic type/measure parameter, or a type/measure inference variable. - - - - - The inferred constraints for the type inference variable - - - - - An inferred equivalence for a type inference variable. - - - - - The declared attributes of the type parameter. Empty for type inference variables. - - - - - The documentation for the type parameter. Empty for type inference variables. - - - - - The unique stamp of the typar blob. - - - - - MUTABILITY: we set the names of generalized inference type parameters to make the look nice for IL code generation - - - - - MUTABILITY: we set the names of generalized inference type parameters to make the look nice for IL code generation - - - - - Backing data for type parameters and type inference variables - - - - - Indicates the construct can only be accessed from any code in the given type constructor, module or assembly. [] indicates global scope. - - - - - A set of static methods for constructing types. - - - - - Mutation used during compilation of FSharp.Core.dll - - - - - Get a table of types defined within this module, namespace or type. The - table is indexed by both name and, for generic types, also by mangled name. - - - - - Get a list of types defined within this module, namespace or type. - - - - - Get a list of type and exception definitions defined within this module, namespace or type. - - - - - Get a table of nested module and namespace fragments indexed by demangled name (so 'ListModule' becomes 'List') - - - - - Namespace or module-compiled-as-type? - - - - - Get a list of module and namespace definitions defined within this module, namespace or type. - - - - - Get a table of F# exception definitions indexed by demangled name, so 'FailureException' is indexed by 'Failure' - - - - - Get a list of F# exception definitions defined within this module, namespace or type. - - - - - Get a table of values indexed by logical name - - - - - Get a table of values and members indexed by partial linkage key, which includes name, the mangled name of the parent type (if any), - and the method argument count (if any). - - - - - Compute a table of values and members indexed by logical name. - - - - - Values, including members in F# types in this module-or-namespace-fragment. - - - - - Get a table of entities indexed by both logical name - - - - - Get a table of entities indexed by both logical and compiled names - - - - - Type, mapping mangled name to Tycon, e.g. - - - - - Get a table of the active patterns defined in this module. - - - - - Get a table of types defined within this module, namespace or type. The - table is indexed by both name and generic arity. This means that for generic - types "List`1", the entry (List,1) will be present. - - - - - Try to find the member with the given linkage key in the given module. - - - - - Return a new module or namespace type with a value added. - - - - - Mutation used in hosting scenarios to hold the hosted types in this module or namespace - - - - - Mutation used during compilation of FSharp.Core.dll - - - - - Return a new module or namespace type with an entity added. - - - - - Indicates that an exception is abstract, i.e. is in a signature file, and we do not know the representation - - - - - Indicates that an exception carries the given record of values - - - - - Indicates that an exception is shorthand for the given .NET exception type - - - - - Indicates that an exception is an abbreviation for the given exception - - - - - If this field is populated, this is the implementation range for an item in a signature, otherwise it is - the signature range for an item in an implementation - - - - - Name/declaration-location of the field - - - - - Attributes attached to generated field - - - - - Attributes attached to generated property - - - - - Indicates the declared visibility of the field, not taking signatures into account - - - - - The default initialization info, for static literals - - - - - Indicates a compiler generated field, not visible to Intellisense or name resolution - - - - - Indicates a volatile field - - - - - Indicates a static field - - - - - The type of the field, w.r.t. the generic parameters of the enclosing type constructor - - - - - XML Documentation signature for the field - - - - - Documentation for the field - - - - - Is the field declared mutable in F#? - - - - - Get or set the XML documentation signature for the field - - - - - Get or set the XML documentation signature for the field - - - - - XML Documentation signature for the field - - - - - Declaration-location of the field - - - - - Attributes attached to generated property - - - - - Name of the field - - - - - The default initialization info, for static literals - - - - - Indicates if the field is zero-initialized - - - - - Indicates a volatile field - - - - - Indicates a static field - - - - - Is the field declared mutable in F#? - - - - - Indicates a compiler generated field, not visible to Intellisense or name resolution - - - - - Name/declaration-location of the field - - - - - The type of the field, w.r.t. the generic parameters of the enclosing type constructor - - - - - Attributes attached to generated field - - - - - Indicates the declared visibility of the field, not taking signatures into account - - - - - This may represent a "field" in either a struct, class, record or union - It is normally compiled to a property. - - - - - Attributes, attached to the generated static method to make instances of the case - - - - - Indicates the declared visibility of the union constructor, not taking signatures into account - - - - - If this field is populated, this is the implementation range for an item in a signature, otherwise it is - the signature range for an item in an implementation - - - - - Name/range of the case - - - - - XML documentation signature for the case - - - - - Documentation for the case - - - - - Name of the case in generated IL code - - - - - Return type constructed by the case. Normally exactly the type of the enclosing type, sometimes an abbreviation of it - - - - - Data carried by the case. - - - - - The ILX data structure representing the discriminated union. - - - - - The cases contained in the discriminated union. - - - - - The cases of the discriminated union, indexed by name. - - - - - The cases of the discriminated union, in declaration order. - - - - - The fields of the record, indexed by name. - - - - - The fields of the record, in declaration order. - - - - - The fields of the class, struct or enum - - - - - The declared abstract slots of the class, interface or struct - - - - - Indicates whether the type declaration is a class, interface, enum, delegate or struct - - - - - Indicates the type is an enumeration - - - - - Indicates the type is a delegate with the given Invoke signature - - - - - Indicates the type is a struct - - - - - Indicates the type is an interface - - - - - Indicates the type is a class (also used for units-of-measure) - - - - - Indicates the type is generated, but type-relocation is suppressed - - - - - Indicates the type is erased - - - - - A flag read from the provided type and used to compute basic properties of the type definition. - Reading is delayed, since it looks at the .BaseType - - - - - A type read from the provided type and used to compute basic properties of the type definition. - Reading is delayed, since it does an import on the underlying type - - - - - A flag read eagerly from the provided type and used to compute basic properties of the type definition. - - - - - A flag read eagerly from the provided type and used to compute basic properties of the type definition. - - - - - A flag read eagerly from the provided type and used to compute basic properties of the type definition. - - - - - A flag read eagerly from the provided type and used to compute basic properties of the type definition. - - - - - A flag read eagerly from the provided type and used to compute basic properties of the type definition. - - - - - The base type of the type. We use it to compute the compiled representation of the type for erased types. - Reading is delayed, since it does an import on the underlying type - - - - - The underlying System.Type (wrapped as a ProvidedType to make sure we don't call random things on - System.Type, and wrapped as Tainted to make sure we track which provider this came from, for reporting - error messages) - - - - - The parameters given to the provider that provided to this type. - - - - - The information kept about a provided type - - - - - The 'NoRepr' value here has four meanings: - (1) it indicates 'not yet known' during the first 2 phases of establishing type definitions - (2) it indicates 'no representation', i.e. 'type X' in signatures - (3) it is the setting used for exception definitions (!) - (4) it is the setting used for modules and namespaces. - - It would be better to separate the "not yet known" and other cases out. - The information for exception definitions should be folded into here. - - - - - Indicates the representation information for a provided namespace. - - - - - TProvidedTypeExtensionPoint - - Indicates the representation information for a provided type. - - - - - Indicates the type is parameterized on a measure (e.g. float<_>) but erases to some other type (e.g. float) - - - - - Indicates the type is implemented as IL assembly code using the given closed Abstract IL type - - - - - TILObjModelRepr(scope, nesting, definition) - - Indicates the type is a type from a .NET assembly without F# metadata. - - - - - Indicates the type is a discriminated union - - - - - Indicates the type is a record - - - - - Indicates the type is a class, struct, enum, delegate or interface - - - - - The information for the contents of a type. Also used for a provided namespace. - - - - - Set to true if the type is determined to be abstract - - - - - Set to true at the end of the scope where proper augmentations are allowed - - - - - Super type, if any - - - - - Interface implementations - boolean indicates compiler-generated - - - - - Properties, methods etc. as lookup table - - - - - Properties, methods etc. in declaration order. The boolean flag for each indicates if the - member is known to be an explicit interface implementation. This must be computed and - saved prior to remapping assembly information. - - - - - True if the type defined an Object.GetHashCode method. In this - case we give a warning if we auto-generate a hash method since the semantics may not match up - - - - - This is the value implementing the auto-generated comparison - semantics if any. It is not present if the type defines its own implementation - of IStructuralEquatable or if the type doesn't implement IComparable implicitly. - - - - - This is the value implementing the auto-generated equality - semantics if any. It is not present if the type defines its own implementation - of Object.Equals or if the type doesn't override Object.Equals implicitly. - - - - - This is the value implementing the auto-generated comparison - semantics if any. It is not present if the type defines its own implementation - of IStructuralComparable or if the type doesn't implement IComparable implicitly. - - - - - This is the value implementing the auto-generated comparison - semantics if any. It is not present if the type defines its own implementation - of IComparable or if the type doesn't implement IComparable implicitly. - - - - - Used during codegen to hold the ILX representation indicating how to access the type - - - - - The stable path to the type, e.g. Microsoft.FSharp.Core.FSharpFunc`2 - - - - - Indicates how visible is the entity is. - - - - - The stable path to the type, e.g. Microsoft.FSharp.Core.FSharpFunc`2 - - - - - The XML document signature for this entity - - - - - The declared documentation for the type or module - - - - - This field is used when the 'tycon' is really a module definition. It holds statically nested type definitions and nested modules - - - - - Field used when the 'tycon' is really an exception definition - - - - - The methods and properties of the type - - - - - If non-None, indicates the type is an abbreviation for another type. - - - - - The declared representation of the type, i.e. record, union, class etc. - - - - - The declared attributes for the type - - - - - The declared accessibility of the representation, not taking signatures into account - - - - - If this field is populated, this is the implementation range for an item in a signature, otherwise it is - the signature range for an item in an implementation - - - - - The declaration location for the type constructor - - - - - The name of the type, possibly with `n mangling - - - - - The name of the type, possibly with `n mangling - - - - - The unique stamp of the "tycon blob". Note the same tycon in signature and implementation get different stamps - - - - - The declared type parameters of the type - - - - - The XML documentation sig-string of the entity, if any, to use to lookup an .xml doc file. This also acts - as a cache for this sig-string computation. - - - - - The XML documentation sig-string of the entity, if any, to use to lookup an .xml doc file. This also acts - as a cache for this sig-string computation. - - - - - The XML documentation of the entity, if any. If the entity is backed by provided metadata - then this _does_ include this documentation. If the entity is backed by Abstract IL metadata - or comes from another F# assembly then it does not (because the documentation will get read from - an XML file). - - - - - Get the union cases and other union-type information for a type, if any - - - - - Get the union cases for a type, if any, as a list - - - - - Get the union cases for a type, if any - - - - - The information about the r.h.s. of a type definition, if any. For example, the r.h.s. of a union or record type. - - - - - Get the value representing the accessibility of the r.h.s. of an F# type definition. - - - - - The kind of the type definition - is it a measure definition or a type definition? - - - - - The logical contents of the entity when it is a type definition. - - - - - Get the type abbreviated by this type definition, if it is an F# type abbreviation definition - - - - - Get the type parameters for an entity that is a type declaration, otherwise return the empty list. - - - - - Get a list of all instance fields for F#-defined record, struct and class fields in this type definition, - excluding compiler-generate fields. - - - - - Get a list of all fields for F#-defined record, struct and class fields in this type definition, - including static fields, but excluding compiler-generate fields. - - - - - A unique stamp for this module, namespace or type definition within the context of this compilation. - Note that because of signatures, there are situations where in a single compilation the "same" - module, namespace or type may have two distinct Entity objects that have distinct stamps. - - - - - The code location where the module, namespace or type is defined. - - - - - Get a blob of data indicating how this type is nested in other namespaces, modules or types. - - - - - Indicates if we have pre-determined that a type definition has a default constructor. - - - - - The logical contents of the entity when it is a module or namespace fragment. - - - - - Gets the immediate members of an F# type definition, excluding compiler-generated ones. - Note: result is alphabetically sorted, then for each name the results are in declaration order - - - - - Gets all immediate members of an F# type definition keyed by name, including compiler-generated ones. - Note: result is a indexed table, and for each name the results are in reverse declaration order - - - - - The name of the namespace, module or type, possibly with mangling, e.g. List`1, List or FailureException - - - - - Indicate if this is a type whose r.h.s. is known to be a union type definition. - - - - - Indicates if this entity is an F# type abbreviation definition - - - - - Indicates if this is a struct or enum type definition , i.e. a value type definition - - - - - Indicates if this is an F# type definition whose r.h.s. is known to be a record type definition. - - - - - Indicates if the entity is a provided namespace fragment - - - - - Indicates if the entity is a generated provided type definition, i.e. not erased. - - - - - Indicates if the entity is an erased provided type definition - - - - - Indicates if the entity is a provided type or namespace definition - - - - - Indicates the type prefers the "tycon<a,b>" syntax for display etc. - - - - - Indicates if the entity is a namespace - - - - - Indicates the "tycon blob" is actually a module - - - - - Indicates if the entity is an F# module definition - - - - - Indicates if this is an F# type definition which is one of the special types in FSharp.Core.dll like 'float<_>' which - defines a measure type with a relation to an existing non-measure type as a representation. - - - - - Indicates if the entity is linked to backing data. Only used during unpickling of F# metadata. - - - - - Indicate if this is a type definition backed by Abstract IL metadata. - - - - - Indicates if this is a .NET-defined struct or enum type definition , i.e. a value type definition - - - - - Indicates if this is a .NET-defined enum type definition - - - - - Indicates if this is an F# type definition whose r.h.s. definition is unknown (i.e. a traditional ML 'abstract' type in a signature, - which in F# is called a 'unknown representation' type). - - - - - Indicates if this is an F#-defined struct or enum type definition , i.e. a value type definition - - - - - Indicates if this is an F# type definition whose r.h.s. is known to be some kind of F# object model definition - - - - - Indicates if this is an F#-defined interface type definition - - - - - Indicates if this is an F#-defined enum type definition - - - - - Indicates if this is an F#-defined delegate type definition - - - - - Indicates if this is an F#-defined class type definition - - - - - Indicates if the entity represents an F# exception declaration. - - - - - Indicates if the entity is erased, either a measure definition, or an erased provided type definition - - - - - Indicates if this is an enum type definition - - - - - Indicates if this is an F# type definition which is one of the special types in FSharp.Core.dll which uses - an assembly-code representation for the type, e.g. the primitive array type constructor. - - - - - Gets the immediate interface definitions of an F# type definition. Further interfaces may be supported through class and interface inheritance. - - - - - Gets the immediate interface types of an F# type definition. Further interfaces may be supported through class and interface inheritance. - - - - - The identifier at the point of declaration of the type definition. - - - - - Get the Abstract IL metadata for this type definition, assuming it is backed by Abstract IL metadata. - - - - - Get the Abstract IL scope, nesting and metadata for this - type definition, assuming it is backed by Abstract IL metadata. - - - - - Indicates if we have pre-determined that a type definition has a self-referential constructor using 'as x' - - - - - Gets any implicit hash/equals (with comparer argument) methods added to an F# record, union or struct type definition. - - - - - Gets any implicit hash/equals methods added to an F# record, union or struct type definition. - - - - - Gets any implicit CompareTo (with comparer argument) methods added to an F# record, union or struct type definition. - - - - - Gets any implicit CompareTo methods added to an F# record, union or struct type definition. - - - - - Get the blob of information associated with an F# object-model type definition, i.e. class, interface, struct etc. - - - - - The information about the r.h.s. of an F# exception definition, if any. - - - - - The display name of the namespace, module or type with <_,_,_> added for generic types, plus static parameters if any - - - - - The display name of the namespace, module or type, e.g. List instead of List`1, including static parameters if any - - - - - The display name of the namespace, module or type, e.g. List instead of List`1, and no static parameters - - - - - Demangle the module name, if FSharpModuleWithSuffix is used - - - - - The range in the implementation, adjusted for an item in a signature - - - - - Gets the data indicating the compiled representation of a named type or module in terms of Abstract IL data structures. - - - - - Gets the data indicating the compiled representation of a type or module in terms of Abstract IL data structures. - - - - - Get the cache of the compiled ILTypeRef representation of this module or type. - - - - - The compiled name of the namespace, module or type, e.g. FSharpList`1, ListModule or FailureException - - - - - Get a blob of data indicating how this type is nested inside other namespaces, modules and types. - - - - - Get a blob of data indicating how this type is nested inside other namespaces, modules and types. - - - - - The F#-defined custom attributes of the entity, if any. If the entity is backed by Abstract IL or provided metadata - then this does not include any attributes from those sources. - - - - - Get a list of all instance fields for F#-defined record, struct and class fields in this type definition. - including hidden fields from the compilation of implicit class constructions. - - - - - Gets all implicit hash/equals/compare methods added to an F# record, union or struct type definition. - - - - - Get a list of fields for all the F#-defined record, struct and class fields in this type definition, including - static fields, 'val' declarations and hidden fields from the compilation of implicit class constructions. - - - - - Get an array of fields for all the F#-defined record, struct and class fields in this type definition, including - static fields, 'val' declarations and hidden fields from the compilation of implicit class constructions. - - - - - Get a table of fields for all the F#-defined record, struct and class fields in this type definition, including - static fields, 'val' declarations and hidden fields from the compilation of implicit class constructions. - - - - - Get the value representing the accessibility of an F# type definition or module. - - - - - Get the type parameters for an entity that is a type declaration, otherwise return the empty list. - - Lazy because it may read metadata, must provide a context "range" in case error occurs reading metadata. - - - - - Set the custom attributes on an F# type definition. - - - - - Create a new entity with empty, unlinked data. Only used during unpickling of F# metadata. - - - - - Create a new entity with the given backing data. Only used during unpickling of F# metadata. - - - - - Link an entity based on empty, unlinked data to the given data. Only used during unpickling of F# metadata. - - - - - Get a union case of a type by name - - - - - Get a field by name. - - - - - Get a field by index in definition order - - - - - String 'Module' off an F# module name, if FSharpModuleWithSuffix is used - - - - - Represents a type definition, exception definition, module definition or namespace definition. - - - - - The information ILXGEN needs about the location of an item - - - - - A public path records where a construct lives within the global namespace - of a CCU. - - - - - Indicates that a 'module' is really a namespace - - - - - Indicates that a module is compiled to a class with the same name as the original module - - - - - Indicates that a module is compiled to a class with the "Module" suffix added. - - - - - This bit is reserved for us in the pickle format, see pickle.fs, it's bing listed here to stop it ever being used for anything else - - - - - Get the flags as included in the F# binary metadata - - - - - Encode entity flags into a bit field. We leave lots of space to allow for future expansion. - - - - - Indicates if the type variable has a static "head type" requirement, i.e. ^a variables used in FSharp.Core and member constraints. - - - - - Indicates if the type variable can be solved or given new constraints. The status of a type variable - generally always evolves towards being either rigid or solved. - - - - - Get the flags as included in the F# binary metadata. We pickle this as int64 to allow for future expansion - - - - - Indicates whether a type variable can be instantiated by types or units-of-measure. - - - - - Indicates if the type inference variable was generated after an error when type checking expressions or patterns - - - - - Indicates if the type variable is compiler generated, i.e. is an implicit type inference variable - - - - - Indicates that whether or not a generic type definition satisfies the equality constraint is dependent on whether this type variable satisfies the equality constraint. - - - - - Indicates if a type parameter is needed at runtime and may not be eliminated - - - - - Indicates that whether or not a generic type definition satisfies the comparison constraint is dependent on whether this type variable satisfies the comparison constraint. - - - - - Encode typar flags into a bit field - - - - - Indicates the type parameter derives from an '_' anonymous type - For units-of-measure, we give a warning if this gets solved to '1' - - - - - Indicates the type parameter is an inference variable may be solved - - - - - Indicates we give a warning if the type parameter is ever solved - - - - - Indicates the type parameter can't be solved, but the variable is not set to "rigid" until after inference is complete - - - - - Indicates the type parameter can't be solved - - - - - Indicates if the type variable can be solved or given new constraints. The status of a type variable - evolves towards being either rigid or solved. - - - - - Represents the kind of a type parameter - - - - - Get the flags as included in the F# binary metadata - - - - - Indicates the 'this' value specified in a memberm e.g. 'x' in 'member x.M() = 1' - - - - - Indicates a normal value - - - - - Indicates the value called 'base' available for calling base class members - - - - - Indicates a ref-cell holding 'this' or the implicit 'this' used throughout an - implicit constructor to access and set values - - - - - Indicates the type parameter is needed at runtime and may not be eliminated - - - - - Indicates the type parameter is not needed at runtime and may be eliminated - - - - - Indicates if a type parameter is needed at runtime and may not be eliminated - - - - - The normal value for this flag when the value is not within its recursive scope - - - - - Set while the value is within its recursive scope. The flag indicates if the value has been eagerly generalized and accepts generic-recursive calls - - - - - A flag associated with values that indicates whether the recursive scope of the value is currently being processed, and - if the value has been generalized or not as yet. - - - - - Indicates the value must never be inlined by the optimizer - - - - - Indicates the value may optionally be inlined by the optimizer - - - - - Indicates the value is inlined but the .NET IL code for the function still exists, e.g. to satisfy interfaces on objects, but that it is also always inlined - - - - - Indicates the value must always be inlined and no .NET IL code is generated for the value/function - - - - - Unique name generator for stamps attached to lambdas and object expressions - - - - - Combine a list of ModuleOrNamespaceType's making up the description of a CCU. checking there are now - duplicate modules etc. - - - - - Create a Val based on an existing one using the function 'f'. - We require that we be given the parent for the new Val. - - - - - Create a module Tycon based on an existing one using the function 'f'. - We require that we be given the parent for the new module. - We pass the new module to 'f' in case it needs to reparent the - contents of the module. - - - - - Create a tycon based on an existing one using the function 'f'. - We require that we be given the new parent for the new tycon. - We pass the new tycon to 'f' in case it needs to reparent the - contents of the tycon. - - - - - Given (newPath,oldPath) replace oldPath by newPath in the TAccess. - - - - - Primitive routine to compare two ValRef's for equality. On the whole value identity is not particularly - significant in F#. However it is significant for - (a) Active Patterns - (b) detecting uses of "special known values" from FSharp.Core.dll, such as 'seq' - and quotation splicing - - Note this routine doesn't take type forwarding into account - - - - - Primitive routine to compare two UnionCaseRef's for equality - - - - - Primitive routine to compare two EntityRef's for equality - This takes into account the possibility that they may have type forwarders - - - - - This predicate tests if non-local resolution paths are definitely known to resolve - to different entities. All references with different named paths always resolve to - different entities. Two references with the same named paths may resolve to the same - entities even if they reference through different CCUs, because one reference - may be forwarded to another via a .NET TypeForwarder. - - - - - From Ref_private to Ref_nonlocal when exporting data. - - - - - From Ref_private to Ref_nonlocal when exporting data. - - - - - Make a reference to a union case for type in a module or namespace - - - - - For dereferencing in the middle of a pattern - - - - - Equality on CCU references, implemented as reference equality except when unresolved - - - - - Equality on value specs, implemented as reference equality - - - - - Equality on type variables, implemented as reference equality. This should be equivalent to using typarEq. - - - - - Generic types can be accessed either by 'List' or 'List`1'. This lists both keys. The second form should really be deprecated. - - - - - Returns true if the implementation of a value must always be inlined - - - - - A global generator of stable compiler generated names - - - - - A global generator of compiler generated names - - - - - Unique name generator for stamps attached to to val_specs, tycon_specs etc. - - - - - Metadata on values (names of arguments etc. - - - - - A function to read a value from a given state - - - - - The type of state unpicklers read from - - - - - A function to pickle a value into a given stateful writer - - - - - The type of state written to by picklers - - - - - The assumptions that need to be fixed up - - - - - The data that uses a collection of CcuThunks internally - - - - - Like Fixup but loader may return None, in which case there is no fixup. - - - - - Represents deserialized data with a dangling set of CCU fixup thunks indexed by name - - - - - Deserialize an arbitrary object which may have holes referring to other compilation units - - - - - Deserialize a TAST description of a compilation unit - - - - - Deserialize a TAST type - - - - - Deserialize a TAST expression - - - - - Deserialize a TAST union case reference - - - - - Deserialize a TAST type reference - - - - - Deserialize a TAST value reference - - - - - Deserialize a TAST constant - - - - - Deserialize a namemap - - - - - Deserialize an array of values - - - - - Deserialize a tuple - - - - - Deserialize a tuple - - - - - Deserialize a tuple - - - - - Deserialize a lazy value (eagerly) - - - - - Deserialize a string - - - - - Deserialize an integer - - - - - Deserialize a bool - - - - - Deserialize a byte - - - - - Serialize an arbitrary object using the given pickler - - - - - Serialize a TAST description of a compilation unit - - - - - Serialize a TAST type - - - - - Serialize a TAST expression - - - - - Serialize a TAST union case reference - - - - - Serialize a TAST type or entity reference - - - - - Serialize a TAST value reference - - - - - Serialize a TAST constant - - - - - Serialize a namemap of data - - - - - Serialize an array of data - - - - - Serialize a tuple of data - - - - - Serialize a tuple of data - - - - - Serialize a tuple of data - - - - - Serialize a lazy value (eagerly) - - - - - Serialize a string - - - - - Serialize an integer - - - - - Serialize a boolean value - - - - - Serialize a byte - - - - - Defines the framework for serializing and de-serializing TAST data structures as binary blobs for the F# metadata format. - - - - - Maps TyconRef to list of T based on stamp keys - - - - - Maps TyconRef to T based on stamp keys - - - - - Maps Typar to T based on stamp keys - - - - - Maps Val's to list of T based on stamp keys - - - - - Mutable data structure mapping Val's to T based on stamp keys - - - - - Maps Val to T, based on stamps - - - - - TypeSchme (generalizedTypars, tauTy) - - generalizedTypars -- the truly generalized type parameters - tauTy -- the body of the generalized type. A 'tau' type is one with its type parameters stripped off. - - - - - Determines types that are potentially known to satisfy the 'comparable' constraint and returns - a set of residual types that must also satisfy the constraint - - - - - returns Some(assemblyName) for success - - - - - Try to find the AttributeUsage attribute, looking for the value of the AllowMultiple named parameter - - - - - Try to find a specific attribute on a type definition - - - - - Try to find a specific attribute on a type definition, where the attribute accepts a bool argument. - - - - - Try to find a specific attribute on a type definition, where the attribute accepts a string argument. - - This is used to detect the 'DefaultMemberAttribute' and 'ConditionalAttribute' attributes (on type definitions) - - - - - For "type Class as self", 'self' is fixed up after initialization. To support this, - it is converted behind the scenes to a ref. This function strips off the ref and - returns the underlying type. - - - - - Get the rank of an array type - - - - - Get the element type of an array type - - - - - &localv - - - - - *localv_ptr - - - - - *localv_ptr = e - - - - - localv <- e - - - - - Query SignatureRepackageInfo - - - - - Get the free variables in the right hand side of a binding. - - - - - Get the free variables in an expression. - - - - - Get the free variables in a module definition. - - - - - A unique qualified name for each type definition, used to qualify the names of interface implementation methods - - - - - Return the full text for an item as we want it displayed to the user as a fully qualified entity - - - - - Returns (parentTypars,memberParentTypars,memberMethodTypars,memberToParentInst,tinst) - - - - - Returns (parentTypars,memberParentTypars,memberMethodTypars,memberToParentInst,tinst) - - - - - Returns (parentTypars,memberParentTypars,memberMethodTypars,memberToParentInst,tinst) - - - - - Try to get a TyconRef for a type without erasing type abbreviations - - - - - See through F# exception abbreviations - - - - - set bool to 'true' to allow shortcutting of type parameter equation chains during stripping - - - - - Return the local and an expression to reference it - - - - - Note: try to use exprForValRef or the expression returned from mkLocal instead of this. - - - - - Utilities used in simplifying types for visual presentation - - - - - Defines derived expression manipulation and construction functions. - - - - - Memoization table to help minimize the number of ILSourceDocument objects we create - - - - - Defines the global environment for all type checking. - - The environment (TcGlobals) are well-known types and values are hard-wired - into the compiler. This lets the compiler perform particular optimizations - for these types and values, for example emitting optimized calls for - comparison and hashing functions. - - - - - unnamed called out args: return these as part of the return tuple - - - - - unnamed called optional args: pass defaults for these - - - - - unassigned args - - - - - return type - - - - - the method we're attempting to call - - - - - the formal instantiation of the method we're attempting to call - - - - - The types of the actual object arguments, if any - - - - - the instantiation of the method we're attempting to call - - - - - args assigned to specify values for attribute fields and properties (these are not necessarily "property sets") - - - - - the property related to the method we're attempting to call, if any - - - - - named setters - - - - - The argument analysis for each set of curried arguments - - - - - Represents the syntactic matching between a caller of a method and the called method. - - The constructor takes all the information about the caller and called side of a method, match up named arguments, property setters etc., - and returns a CalledMeth object for further analysis. - - - - - Named args - - - - - Any unnamed caller arguments assigned to a "param array" argument - - - - - The called "ParamArray" argument, if any - - - - - Any unnamed caller arguments not otherwise assigned - - - - - The called arguments corresponding to "unnamed" arguments - - - - - Represents the resolution of a caller argument as a named-setter argument - - - - - Represents the possibilities for a named-setter argument (a property, field , or a record field setter) - - - - - The argument on the caller side - - - - - The called argument in the method - - - - - The identifier for a named argument, if any - - - - - Represents a match between a caller argument and a called argument, arising from either - a named argument or an unnamed argument. - - - - - Represents the information about an argument in the method being called - - - - - CallerArg(ty, range, isOpt, exprInfo) - - - - - In the following, 'T gets instantiated to: - 1. the expression being supplied for an argument - 2. "unit", when simply checking for the existence of an overload that satisfies - a signature, or when finding the corresponding witness. - Note the parametricity helps ensure that overload resolution doesn't depend on the - expression on the callside (though it is in some circumstances allowed - to depend on some type information inferred syntactically from that - expression, e.g. a lambda expression may be converted to a delegate as - an adhoc conversion. - - The bool indicates if named using a '?' - - - - - The overall information about a method implementation in a class or object expression - - - - - Implements the elaborated form of adhoc conversions from functions to delegates at member callsites - - - - - Build an expression that calls a given method info. - This is called after overload resolution, and also to call other - methods such as 'setters' for properties. - - - - - Adjust the 'this' pointer before making a call - Take the address of a struct, and coerce to an interface/base/constraint type if necessary - - - - - Compute whether we insert a 'coerce' on the 'this' pointer for an object model call - For example, when calling an interface method on a struct, or a method on a constrained - variable type. - - - - - Is this a 'base' call (in the sense of C#) - - - - - Get the properties relevant to determining if a uniquely-identified-override exists based on the syntactic information - at the member signature prior to type inference. This is used to pre-assign type information if it does - - - - - Get the methods relevant to determining if a uniquely-identified-override exists based on the syntactic information - at the member signature prior to type inference. This is used to pre-assign type information if it does - - - - - "Single Feasible Type" inference - Look for the unique supertype of ty2 for which ty2 :> ty1 might feasibly hold - - - - - "Type Completion" inference and a few other checks at the end of the inference scope - - - - - Do AdjustArityOfLambdaBody for a series of - iterated lambdas, producing one method. - The required iterated function arity (List.length topValInfo) must be identical - to the iterated function arity of the input lambda (List.length vsl) - - - - - Break apart lambdas. Needs ChooseTyparSolutionsForFreeChoiceTypars because it's used in - PostTypeCheckSemanticChecks before we've eliminated these nodes. - - - - - Choose solutions for Expr.TyChoose type "hidden" variables introduced - by letrec nodes. Also used by the pattern match compiler to choose type - variables when compiling patterns at generalized bindings. - e.g. let ([],x) = ([],[]) - Here x gets a generalized type "list<'T>". - - - - - The feasible coercion relation. Part of the language spec. - - - - - The feasible equivalence relation. Part of the language spec. - - - - - Erasure over System.Type. - - This is a reimplementation of the logic of provided-type erasure, working entirely over (tainted, provided) System.Type - values. This is used when preparing ParameterInfo objects to give to the provider in GetInvokerExpression. - These ParameterInfo have erased ParameterType - giving the provider an erased type makes it considerably easier - to implement a correct GetInvokerExpression. - - Ideally we would implement this operation by converting to an F# TType using ImportSystemType, and then erasing, and then converting - back to System.Type. However, there is currently no way to get from an arbitrary F# TType (even the TType for - System.Object) to a System.Type to give to the type provider. - - - - - Check that a type definition implements all its required interfaces after processing all declarations - within a file. - - - - - Get the slots of a type that can or must be implemented. This depends - partly on the full set of interface types that are being implemented - simultaneously, e.g. - { new C with interface I2 = ... interface I3 = ... } - allReqdTys = {C;I2;I3} - - allReqdTys can include one class/record/union type. - - - - - Check all implementations implement some dispatch slot. - - - - - Check all dispatch slots are implemented by some override. - - - - - Check if a dispatch slot is already implemented - - - - - Check if an override implements a dispatch slot - - - - - Check if an override exactly matches the requirements for a dispatch slot - - - - - Compose two instantiations of type parameters. - - - - - Compute the reverse of a type parameter renaming. - - - - - Check if an override is a partial match for the requirements for a dispatch slot - - - - - Check if the kinds of type parameters match between a dispatch slot and an override. - - - - - Check if an override matches a dispatch slot by name - - - - - Check if an override matches a dispatch slot by name - - - - - Get the override information for an object expression method being used to implement dispatch slots - - - - - Get the override info for a value being used to implement a dispatch slot. - - - - - Get the override info for an existing (inherited) method being used to implement a dispatch slot. - - - - - Format the signature of a MethInfo as a string as part of an error message - - - - - Format the signature of an override as a string as part of an error message - - - - - Print the signature of a MethInfo to a buffer as part of an error message - - - - - Print the signature of an override to a buffer as part of an error message - - - - - Check the names add up between a signature and its implementation. We check this first. - - - - - Containment relation for module types - - - - - Primary relations on types and signatures, with the exception of - constraint solving and method overload resolution. - - - - diff --git a/packages/FAKE.4.11.3/tools/FSharp.Core.dll b/packages/FAKE.4.11.3/tools/FSharp.Core.dll deleted file mode 100644 index ae969ce..0000000 Binary files a/packages/FAKE.4.11.3/tools/FSharp.Core.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/FSharp.Core.optdata b/packages/FAKE.4.11.3/tools/FSharp.Core.optdata deleted file mode 100644 index 61f4802..0000000 Binary files a/packages/FAKE.4.11.3/tools/FSharp.Core.optdata and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/FSharp.Core.sigdata b/packages/FAKE.4.11.3/tools/FSharp.Core.sigdata deleted file mode 100644 index 33f7be9..0000000 Binary files a/packages/FAKE.4.11.3/tools/FSharp.Core.sigdata and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/FSharp.Core.xml b/packages/FAKE.4.11.3/tools/FSharp.Core.xml deleted file mode 100644 index 2482a25..0000000 --- a/packages/FAKE.4.11.3/tools/FSharp.Core.xml +++ /dev/null @@ -1,11118 +0,0 @@ - - -FSharp.Core - - - Gets the tail of the list, which is a list containing all the elements of the list, excluding the first element - - - Gets the number of items contained in the list - - - Gets the element of the list at the given position. - Lists are represented as linked lists so this is an O(n) operation. - The index. - The value at the given index. - - - Gets a value indicating if the list contains no entries - - - Gets the first element of the list - - - Returns an empty list of a particular type - - - Gets a slice of the list, the elements of the list from the given start index to the given end index. - The start index. - The end index. - The sub list specified by the input indices. - - - Returns a list with head as its first element and tail as its subsequent elements - A new head value for the list. - The existing list. - The list with head appended to the front of tail. - - - The type of immutable singly-linked lists. - - Use the constructors [] and :: (infix) to create values of this type, or - the notation [1;2;3]. Use the values in the List module to manipulate - values of this type, or pattern match against the values directly. - - - Lookup an element in the map. Raise KeyNotFoundException if no binding - exists in the map. - The input key. - Thrown when the key is not found. - The value mapped to the key. - - - Returns true if there are no bindings in the map. - - - The number of bindings in the map. - - - Lookup an element in the map, returning a Some value if the element is in the domain - of the map and None if not. - The input key. - The mapped value, or None if the key is not in the map. - - - Removes an element from the domain of the map. No exception is raised if the element is not present. - The input key. - The resulting map. - - - Tests if an element is in the domain of the map. - The input key. - True if the map contains the given key. - - - Returns a new map with the binding added to the given map. - The input key. - The resulting map. - - - Builds a map that contains the bindings of the given IEnumerable. - The input sequence of key/value pairs. - The resulting map. - - - Immutable maps. Keys are ordered by F# generic comparison. - - Maps based on generic comparison are efficient for small keys. They are not a suitable choice if keys are recursive data structures - or if keys require bespoke comparison semantics. - - All members of this class are thread-safe and may be used concurrently from multiple threads. - - - An abbreviation for the CLI type System.Collections.Generic.List<_> - - - Returns a new set with the elements of the second set removed from the first. - The first input set. - The second input set. - A set containing elements of the first set that are not contained in the second set. - - - Compute the union of the two sets. - The first input set. - The second input set. - The union of the two input sets. - - - Returns the lowest element in the set according to the ordering being used for the set. - - - Returns the highest element in the set according to the ordering being used for the set. - - - A useful shortcut for Set.isEmpty. See the Set module for further operations on sets. - - - The number of elements in the set - - - A useful shortcut for Set.remove. Note this operation produces a new set - and does not mutate the original set. The new set will share many storage - nodes with the original. See the Set module for further operations on sets. - The value to remove from the set. - The result set. - - - Evaluates to "true" if all elements of the second set are in the first. - The set to test against. - True if this set is a superset of otherSet. - - - Evaluates to "true" if all elements of the first set are in the second. - The set to test against. - True if this set is a subset of otherSet. - - - Evaluates to "true" if all elements of the second set are in the first, and at least - one element of the first is not in the second. - The set to test against. - True if this set is a proper superset of otherSet. - - - Evaluates to "true" if all elements of the first set are in the second, and at least - one element of the second is not in the first. - The set to test against. - True if this set is a proper subset of otherSet. - - - A useful shortcut for Set.contains. See the Set module for further operations on sets. - The value to check. - True if the set contains value. - - - A useful shortcut for Set.add. Note this operation produces a new set - and does not mutate the original set. The new set will share many storage - nodes with the original. See the Set module for further operations on sets. - The value to add to the set. - The result set. - - - Create a set containing elements drawn from the given sequence. - The input sequence. - The result set. - - - Immutable sets based on binary trees, where comparison is the - F# structural comparison function, potentially using implementations - of the IComparable interface on key values. - - See the Set module for further operations on sets. - - All members of this class are thread-safe and may be used concurrently from multiple threads. - - - An abbreviation for the type of immutable singly-linked lists. - - Use the constructors [] and :: (infix) to create values of this type, or - the notation [1;2;3]. Use the values in the List module to manipulate - values of this type, or pattern match against the values directly. - - - An abbreviation for the CLI type System.Collections.Generic.IEnumerable<_> - - - Fetches an element from a 2D array. You can also use the syntax array.[index1,index2]. - - The input array. - The index along the first dimension. - The index along the second dimension. - - The value of the array at the given index. - Thrown when the indices are negative or exceed the bounds of the array. - - - Sets the value of an element in an array. You can also use the syntax array.[index1,index2] <- value. - - The input array. - The index along the first dimension. - The index along the second dimension. - The value to set in the array. - Thrown when the indices are negative or exceed the bounds of the array. - - - Builds a new array whose elements are the same as the input array but - where a non-zero-based input array generates a corresponding zero-based - output array. - - The input array. - - The zero-based output array. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer indices passed to the - function indicates the element being transformed. - - For non-zero-based arrays the basing on an input array will be propagated to the output - array. - - A function that is applied to transform each element of the array. The two integers - provide the index of the element. - The input array. - - An array whose elements have been transformed by the given mapping. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - - A function that is applied to transform each item of the input array. - The input array. - - An array whose elements have been transformed by the given mapping. - - - Returns the length of an array in the second dimension. - - The input array. - - The length of the array in the second dimension. - - - Returns the length of an array in the first dimension. - - The input array. - - The length of the array in the first dimension. - - - Applies the given function to each element of the array. The integer indices passed to the - function indicates the index of element. - - A function to apply to each element of the array with the indices available as an argument. - The input array. - - - Applies the given function to each element of the array. - - A function to apply to each element of the array. - The input array. - - - Creates a based array where the entries are initially Unchecked.defaultof<'T>. - - The base for the first dimension of the array. - The base for the second dimension of the array. - The length of the first dimension of the array. - The length of the second dimension of the array. - - The created array. - Thrown when base1, base2, length1, or length2 is negative. - - - Creates a based array whose elements are all initially the given value. - - The base for the first dimension of the array. - The base for the second dimension of the array. - The length of the first dimension of the array. - The length of the second dimension of the array. - The value to populate the new array. - - The created array. - Thrown when base1, base2, length1, or length2 is negative. - - - Creates a based array given the dimensions and a generator function to compute the elements. - - The base for the first dimension of the array. - The base for the second dimension of the array. - The length of the first dimension of the array. - The length of the second dimension of the array. - A function to produce elements of the array given the two indices. - - The created array. - Thrown when base1, base2, length1, or length2 is negative. - - - Creates an array where the entries are initially Unchecked.defaultof<'T>. - - The length of the first dimension of the array. - The length of the second dimension of the array. - - The created array. - Thrown when length1 or length2 is negative. - - - Creates an array whose elements are all initially the given value. - - The length of the first dimension of the array. - The length of the second dimension of the array. - The value to populate the new array. - - The created array. - Thrown when length1 or length2 is negative. - - - Creates an array given the dimensions and a generator function to compute the elements. - - The length of the first dimension of the array. - The length of the second dimension of the array. - A function to produce elements of the array given the two indices. - - The generated array. - Thrown when either of the lengths is negative. - - - Reads a range of elements from the first array and write them into the second. - - The source array. - The first-dimension index to begin copying from in the source array. - The second-dimension index to begin copying from in the source array. - The target array. - The first-dimension index to begin copying into in the target array. - The second-dimension index to begin copying into in the target array. - The number of elements to copy across the first dimension of the arrays. - The number of elements to copy across the second dimension of the arrays. - Thrown when any of the indices are negative or if either of - the counts are larger than the dimensions of the array allow. - - - Builds a new array whose elements are the same as the input array. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - - The input array. - - A copy of the input array. - - - Fetches the base-index for the second dimension of the array. - - The input array. - - The base-index of the second dimension of the array. - - - Fetches the base-index for the first dimension of the array. - - The input array. - - The base-index of the first dimension of the array. - - - Basic operations on 2-dimensional arrays. - - F# and CLI multi-dimensional arrays are typically zero-based. - However, CLI multi-dimensional arrays used in conjunction with external - libraries (e.g. libraries associated with Visual Basic) be - non-zero based, using a potentially different base for each dimension. - The operations in this module will accept such arrays, and - the basing on an input array will be propagated to a matching output - array on the Array2D.map and Array2D.mapi operations. - Non-zero-based arrays can also be created using Array2D.zeroCreateBased, - Array2D.createBased and Array2D.initBased. - - - Creates an array where the entries are initially the "default" value. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The created array. - - - Sets the value of an element in an array. You can also - use the syntax 'array.[index1,index2,index3] <- value'. - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The value to set at the given index. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer indices passed to the - function indicates the element being transformed. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - The function to transform the elements at each index in the array. - The input array. - The array created from the transformed elements. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - The function to transform each element of the array. - The input array. - The array created from the transformed elements. - - - Returns the length of an array in the third dimension. - The input array. - The length of the array in the third dimension. - - - Returns the length of an array in the second dimension. - The input array. - The length of the array in the second dimension. - - - Returns the length of an array in the first dimension - The input array. - The length of the array in the first dimension. - - - Applies the given function to each element of the array. The integer indicies passed to the - function indicates the index of element. - The function to apply to each element of the array. - The input array. - - - Applies the given function to each element of the array. - The function to apply to each element of the array. - The input array. - - - Fetches an element from a 3D array. You can also use the syntax 'array.[index1,index2,index3]' - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The value at the given index. - - - Creates an array given the dimensions and a generator function to compute the elements. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The function to create an initial value at each index into the array. - The created array. - - - Creates an array whose elements are all initially the given value. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The value of the array elements. - The created array. - - - Basic operations on rank 3 arrays. - - - Sets the value of an element in an array. You can also - use the syntax 'array.[index1,index2,index3,index4] <- value'. - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The index along the fourth dimension. - The value to set. - - - Fetches an element from a 4D array. You can also use the syntax 'array.[index1,index2,index3,index4]' - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The index along the fourth dimension. - The value at the given index. - - - Creates an array where the entries are initially the "default" value. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The length of the fourth dimension. - The created array. - - - Returns the length of an array in the fourth dimension. - The input array. - The length of the array in the fourth dimension. - - - Returns the length of an array in the third dimension. - The input array. - The length of the array in the third dimension. - - - Returns the length of an array in the second dimension. - The input array. - The length of the array in the second dimension. - - - Returns the length of an array in the first dimension - The input array. - The length of the array in the first dimension. - - - Creates an array given the dimensions and a generator function to compute the elements. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The length of the fourth dimension. - The function to create an initial value at each index in the array. - The created array. - - - Creates an array whose elements are all initially the given value - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The length of the fourth dimension. - The initial value for each element of the array. - The created array. - - - Basic operations on rank 4 arrays. - - - Combines three arrays into an array of pairs. The three arrays must have equal lengths, otherwise an ArgumentException is - raised. - The first input array. - The second input array. - The third input array. - Thrown when any of the input arrays are null. - Thrown when the input arrays differ in length. - The array of tupled elements. - - - Combines the two arrays into an array of pairs. The two arrays must have equal lengths, otherwise an ArgumentException is - raised. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The array of tupled elements. - - - Returns an array of sliding windows containing elements drawn from the input - array. Each window is returned as a fresh array. - The number of elements in each window. - The input array. - The result array. - Thrown when the input array is null. - Thrown when windowSize is not positive. - - - Returns a new array containing only the elements of the array - for which the given predicate returns "true". - The function to test the input elements. - The input array. - An array containing the elements for which the given predicate returns true. - - Thrown when the input array is null. - - - Splits an array of triples into three arrays. - The input array. - The tuple of three arrays. - Thrown when the input array is null. - - - Splits an array of pairs into two arrays. - The input array. - The two arrays. - Thrown when the input array is null. - - - Returns an array that contains the elements generated by the given computation. - The given initial state argument is passed to the element generator. - A function that takes in the current state and returns an option tuple of the next - element of the array and the next state value. - The initial state value. - The result array. - - - Returns the index of the last element in the array - that satisfies the given predicate. - The function to test the input elements. - The input array. - Thrown when the input array is null. - The index of the last element that satisfies the predicate, or None. - - - Tries to find the nth element in the array. - Returns None if index is negative or the input array does not contain enough elements. - The index of element to retrieve. - The input array. - The nth element of the array or None. - Thrown when the input array is null. - - - Returns the index of the first element in the array - that satisfies the given predicate. - The function to test the input elements. - The input array. - Thrown when the input array is null. - The index of the first element that satisfies the predicate, or None. - - - Returns the last element for which the given function returns true. - Return None if no such element exists. - The function to test the input elements. - The input array. - Thrown when the input array is null. - The last element that satisfies the predicate, or None. - - - Returns the first element for which the given function returns true. - Return None if no such element exists. - The function to test the input elements. - The input array. - The first element that satisfies the predicate, or None. - Thrown when the input array is null. - - - Returns at most N elements in a new array. - The maximum number of items to return. - The input array. - The result array. - Thrown when the input array is null. - - - Views the given array as a sequence. - The input array. - The sequence of array elements. - Thrown when the input array is null. - - - Builds a list from the given array. - The input array. - The list of array elements. - Thrown when the input array is null. - - - Returns a new array containing the elements of the original except the first element. - - The input array. - Thrown when the array is empty. - Thrown when the input array is null. - A new array containing the elements of the original except the first element. - - - Returns an array that contains all elements of the original array while the - given predicate returns true, and then returns no further elements. - - A function that evaluates to false when no more items should be returned. - The input array. - - The result array. - - Thrown when the input array is null. - - - Returns the first N elements of the array. - Throws InvalidOperationException - if the count exceeds the number of elements in the array. Array.truncate - returns as many items as the array contains instead of throwing an exception. - - The number of items to take. - The input array. - - The result array. - - Thrown when the input array is null. - Thrown when the input array is empty. - Thrown when count exceeds the number of elements - in the list. - - - Returns the sum of the results generated by applying the function to each element of the array. - The function to transform the array elements into the type to be summed. - The input array. - The resulting sum. - Thrown when the input array is null. - - - Returns the sum of the elements in the array. - The input array. - The resulting sum. - Thrown when the input array is null. - - - Sorts the elements of an array, in descending order, using the given projection for the keys and returning a new array. - Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to transform array elements into the type that is compared. - The input array. - The sorted array. - - - Sorts the elements of an array, in descending order, returning a new array. Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The input array. - The sorted array. - - - Splits an array into two arrays, at the given index. - The index at which the array is split. - The input array. - The two split arrays. - - Thrown when the input array is null. - Thrown when split index exceeds the number of elements - in the array. - - - Sorts the elements of an array by mutating the array in-place, using the given comparison function. - Elements are compared using Operators.compare. - The input array. - Thrown when the input array is null. - - - Sorts the elements of an array by mutating the array in-place, using the given comparison function as the order. - The function to compare pairs of array elements. - The input array. - Thrown when the input array is null. - - - Sorts the elements of an array by mutating the array in-place, using the given projection for the keys. - Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to transform array elements into the type that is compared. - The input array. - Thrown when the input array is null. - - - Sorts the elements of an array, using the given comparison function as the order, returning a new array. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to compare pairs of array elements. - The input array. - The sorted array. - Thrown when the input array is null. - - - Sorts the elements of an array, using the given projection for the keys and returning a new array. - Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to transform array elements into the type that is compared. - The input array. - The sorted array. - Thrown when the input array is null. - - - Sorts the elements of an array, returning a new array. Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The input array. - The sorted array. - Thrown when the input array is null. - - - Builds a new array that contains the given subrange specified by - starting index and length. - The input array. - The index of the first element of the sub array. - The length of the sub array. - The created sub array. - Thrown when the input array is null. - Thrown when either startIndex or count is negative, - or when there aren't enough elements in the input array. - - - Bypasses elements in an array while the given predicate returns true, and then returns - the remaining elements in a new array. - A function that evaluates an element of the array to a boolean value. - The input array. - The created sub array. - Thrown when the input array is null. - - - Builds a new array that contains the elements of the given array, excluding the first N elements. - The number of elements to skip. - The input array. - A copy of the input array, after removing the first N elements. - Thrown when the input array is null. - Thrown when count is negative or exceeds the number of - elements in the array. - - - Sets an element of an array. - The input array. - The input index. - The input value. - Thrown when the input array is null. - Thrown when the index is negative or the input array does not contain enough elements. - - - Returns an array that contains one item only. - - The input item. - - The result array of one item. - - - Like foldBack, but return both the intermediary and final results. - The function to update the state given the input elements. - The input array. - The initial state. - The array of state values. - Thrown when the input array is null. - - - Like fold, but return the intermediary and final results. - The function to update the state given the input elements. - The initial state. - The input array. - The array of state values. - Thrown when the input array is null. - - - Returns a new array with the elements in reverse order. - The input array. - The reversed array. - Thrown when the input array is null. - - - Creates an array by replicating the given initial value. - The number of elements to replicate. - The value to replicate - The generated array. - Thrown when count is negative. - - - Applies a function to each element of the array, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f i0 (...(f iN-1 iN)). - A function that takes in the next-to-last element of the list and the - current accumulated result to produce the next accumulated result. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The final result of the reductions. - - - Applies a function to each element of the array, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f (... (f i0 i1)...) iN. - Raises ArgumentException if the array has size zero. - The function to reduce a pair of elements to a single element. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The final result of the redcutions. - - - Returns an array with all elements permuted according to the - specified permutation. - The function that maps input indices to output indices. - The input array. - The output array. - Thrown when the input array is null. - Thrown when indexMap does not produce a valid permutation. - - - Splits the collection into two collections, containing the - elements for which the given predicate returns "true" and "false" - respectively. - The function to test the input elements. - The input array. - A pair of arrays. The first containing the elements the predicate evaluated to true, - and the second containing those evaluated to false. - Thrown when the input array is null. - - - Returns an array of each element in the input array and its predecessor, with the - exception of the first element which is only returned as the predecessor of the second element. - - The input array. - - The result array. - - Thrown when the input sequence is null. - - - Builds a new array from the given enumerable object. - The input sequence. - The array of elements from the sequence. - Thrown when the input sequence is null. - - - Builds an array from the given list. - The input list. - The array of elements from the list. - - - Returns the lowest of all elements of the array, compared via Operators.min on the function result. - - Throws ArgumentException for empty arrays. - The function to transform the elements into a type supporting comparison. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The minimum element. - - - Returns the lowest of all elements of the array, compared via Operators.min. - - Throws ArgumentException for empty arrays - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The minimum element. - - - Returns the greatest of all elements of the array, compared via Operators.max on the function result. - - Throws ArgumentException for empty arrays. - The function to transform the elements into a type supporting comparison. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The maximum element. - - - Returns the greatest of all elements of the array, compared via Operators.max on the function result. - - Throws ArgumentException for empty arrays. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The maximum element. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer index passed to the - function indicates the index of element being transformed. - The function to transform elements and their indices. - The input array. - The array of transformed elements. - Thrown when the input array is null. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the two collections pairwise, also passing the index of - the elements. The two input arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to transform pairs of input elements and their indices. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The array of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding triples from the three collections. The three input - arrays must have the same length, otherwise an ArgumentException is - raised. - The function to transform the pairs of the input elements. - The first input array. - The second input array. - The third input array. - Thrown when the input arrays differ in length. - Thrown when any of the input arrays is null. - The array of transformed elements. - - - Combines map and foldBack. Builds a new array whose elements are the results of applying the given function - to each of the elements of the input array. The function is also used to accumulate a final value. - The function to transform elements from the input array and accumulate the final value. - The input array. - The initial state. - Thrown when the input array is null. - The array of transformed elements, and the final accumulated value. - - - Combines map and fold. Builds a new array whose elements are the results of applying the given function - to each of the elements of the input array. The function is also used to accumulate a final value. - The function to transform elements from the input array and accumulate the final value. - The initial state. - The input array. - Thrown when the input array is null. - The array of transformed elements, and the final accumulated value. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the two collections pairwise. The two input - arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to transform the pairs of the input elements. - The first input array. - The second input array. - Thrown when the input arrays differ in length. - Thrown when either of the input arrays is null. - The array of transformed elements. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. - The function to transform elements of the array. - The input array. - The array of transformed elements. - Thrown when the input array is null. - - - Returns the last element of the array. - Return None if no such element exists. - The input array. - The last element of the array or None. - Thrown when the input sequence is null. - - - Returns the length of an array. You can also use property arr.Length. - The input array. - The length of the array. - Thrown when the input array is null. - - - Gets an element from an array. - The input index. - The input array. - The value of the array at the given index. - Thrown when the input array is null. - Thrown when the index is negative or the input array does not contain enough elements. - - - Returns the last element of the array. - The input array. - The last element of the array. - Thrown when the input array is null. - Thrown when the input does not have any elements. - - - Applies the given function to pair of elements drawn from matching indices in two arrays, - also passing the index of the elements. The two arrays must have the same lengths, - otherwise an ArgumentException is raised. - The function to apply to each index and pair of elements. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - - - Applies the given function to each element of the array. The integer passed to the - function indicates the index of element. - The function to apply to each index and element. - The input array. - Thrown when the input array is null. - - - Applies the given function to pair of elements drawn from matching indices in two arrays. The - two arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to apply. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - - - Applies the given function to each element of the array. - The function to apply. - The input array. - Thrown when the input array is null. - - - Returns true if the given array is empty, otherwise false. - The input array. - True if the array is empty. - Thrown when the input array is null. - - - Creates an array where the entries are initially the default value Unchecked.defaultof<'T>. - The length of the array to create. - The created array. - Thrown when count is negative. - - - Creates an array given the dimension and a generator function to compute the elements. - The number of elements to initialize. - The function to generate the initial values for each index. - The created array. - Thrown when count is negative. - - - Builds a new array whose elements are the corresponding elements of the input array - paired with the integer index (from 0) of each element. - The input array. - The array of indexed elements. - Thrown when the input array is null. - - - Applies a key-generating function to each element of an array and yields an array of - unique keys. Each unique key contains an array of all elements that match - to this key. - - A function that transforms an element of the array into a comparable key. - The input array. - - The result array. - - Thrown when the input array is null. - - - Returns the first element of the array. - - The input array. - - The first element of the array. - - Thrown when the input array is null. - Thrown when the input array is empty. - - - Gets an element from an array. - The input array. - The input index. - The value of the array at the given index. - Thrown when the input array is null. - Thrown when the index is negative or the input array does not contain enough elements. - - - Apply a function to pairs of elements drawn from the two collections, right-to-left, - threading an accumulator argument through the computation. The two input - arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to update the state given the input elements. - The first input array. - The second input array. - The initial state. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The final state. - - - Applies a function to pairs of elements drawn from the two collections, - left-to-right, threading an accumulator argument - through the computation. The two input - arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to update the state given the input elements. - The initial state. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The final state. - - - Applies a function to each element of the array, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then computes - f i0 (...(f iN s)) - The function to update the state given the input elements. - The input array. - The initial state. - The state object after the folding function is applied to each element of the array. - Thrown when the input array is null. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then computes - f (... (f s i0)...) iN - The function to update the state given the input elements. - The initial state. - The input array. - The final state. - Thrown when the input array is null. - - - Tests if all corresponding elements of the array satisfy the given predicate pairwise. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns false then the overall result is - false and no further elements are tested. Otherwise, if one collection is longer - than the other then the ArgumentException exception is raised. - Otherwise, true is returned. - The function to test the input elements. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - True if all of the array elements satisfy the predicate. - - - Tests if all elements of the array satisfy the given predicate. - - The predicate is applied to the elements of the input collection. If any application - returns false then the overall result is false and no further elements are tested. - Otherwise, true is returned. - The function to test the input elements. - The input array. - True if all of the array elements satisfy the predicate. - Thrown when the input array is null. - - - Returns the index of the last element in the array - that satisfies the given predicate. Raise KeyNotFoundException if - none of the elements satisfy the predicate. - The function to test the input elements. - The input array. - Thrown if predicate - never returns true. - Thrown when the input array is null. - The index of the last element in the array that satisfies the given predicate. - - - Returns the index of the first element in the array - that satisfies the given predicate. Raise KeyNotFoundException if - none of the elements satisfy the predicate. - The function to test the input elements. - The input array. - Thrown if predicate - never returns true. - Thrown when the input array is null. - The index of the first element in the array that satisfies the given predicate. - - - Returns the last element for which the given function returns 'true'. - Raise KeyNotFoundException if no such element exists. - The function to test the input elements. - The input array. - Thrown if predicate - never returns true. - Thrown when the input array is null. - The last element for which predicate returns true. - - - Returns the first element for which the given function returns 'true'. - Raise KeyNotFoundException if no such element exists. - The function to test the input elements. - The input array. - Thrown when the input array is null. - Thrown if predicate - never returns true. - The first element for which predicate returns true. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true". - The function to test the input elements. - The input array. - An array containing the elements for which the given predicate returns true. - Thrown when the input array is null. - - - Tests if any pair of corresponding elements of the arrays satisfies the given predicate. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns true then the overall result is - true and no further elements are tested. Otherwise, if one collections is longer - than the other then the ArgumentException exception is raised. - Otherwise, false is returned. - The function to test the input elements. - The first input array. - The second input array. - True if any result from predicate is true. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - - - Tests if any element of the array satisfies the given predicate. - - The predicate is applied to the elements of the input array. If any application - returns true then the overall result is true and no further elements are tested. - Otherwise, false is returned. - The function to test the input elements. - The input array. - True if any result from predicate is true. - Thrown when the input array is null. - - - Returns a new list with the distinct elements of the input array which do not appear in the itemsToExclude sequence, - using generic hash and equality comparisons to compare values. - - A sequence whose elements that also occur in the input array will cause those elements to be - removed from the result. - An array whose elements that are not also in itemsToExclude will be returned. - - An array that contains the distinct elements of array that do not appear in itemsToExclude. - - Thrown when either itemsToExclude or array is null. - - - Returns the only element of the array. - - The input array. - - The only element of the array. - - Thrown when the input array is null. - Thrown when the input does not have precisely one element. - - - Returns an empty array of the given type. - The empty array. - - - Splits the input array into at most count chunks. - The maximum number of chunks. - The input array. - The array split into chunks. - Thrown when the input array is null. - Thrown when count is not positive. - - - Returns an array that contains no duplicate entries according to the - generic hash and equality comparisons on the keys returned by the given key-generating function. - If an element occurs multiple times in the array then the later occurrences are discarded. - - A function transforming the array items into comparable keys. - The input array. - - The result array. - - Thrown when the input array is null. - - - Returns an array that contains no duplicate entries according to generic hash and - equality comparisons on the entries. - If an element occurs multiple times in the array then the later occurrences are discarded. - - The input array. - - The result array. - - Thrown when the input array is null. - - - Divides the input array into chunks of size at most chunkSize. - The maximum size of each chunk. - The input array. - The array divided into chunks. - Thrown when the input array is null. - Thrown when chunkSize is not positive. - - - Applies the given function to each element of the array. Returns - the array comprised of the results "x" for each element where - the function returns Some(x) - The function to generate options from the elements. - The input array. - The array of results. - Thrown when the input array is null. - - - Applies the given function to successive elements, returning the first - result where function returns Some(x) for some x. If the function - never returns Some(x) then KeyNotFoundException is raised. - The function to generate options from the elements. - The input array. - Thrown when the input array is null. - Thrown if every result from - chooser is None. - The first result. - - - Fills a range of elements of the array with the given value. - The target array. - The index of the first element to set. - The number of elements to set. - The value to set. - Thrown when the input array is null. - Thrown when either targetIndex or count is negative. - - - Applies the given function to successive elements, returning the first - result where function returns Some(x) for some x. If the function - never returns Some(x) then None is returned. - The function to transform the array elements into options. - The input array. - The first transformed element that is Some(x). - Thrown when the input array is null. - - - Returns the first element of the array, or - None if the array is empty. - The input array. - Thrown when the input array is null. - The first element of the array or None. - - - Creates an array whose elements are all initially the given value. - The length of the array to create. - The value for the elements. - The created array. - Thrown when count is negative. - - - Applies a key-generating function to each element of an array and returns an array yielding unique - keys and their number of occurrences in the original array. - - A function transforming each item of the input array into a key to be - compared against the others. - The input array. - - The result array. - - Thrown when the input array is null. - - - Builds a new array that contains the elements of the given array. - The input array. - A copy of the input array. - Thrown when the input array is null. - - - Tests if the array contains the specified element. - The value to locate in the input array. - The input array. - True if the input array contains the specified element; false otherwise. - Thrown when the input array is null. - - - Builds a new array that contains the elements of each of the given sequence of arrays. - The input sequence of arrays. - The concatenation of the sequence of input arrays. - Thrown when the input sequence is null. - - - Compares two arrays using the given comparison function, element by element. - Returns the first non-zero result from the comparison function. If the end of an array - is reached it returns a -1 if the first array is shorter and a 1 if the second array - is shorter. - - A function that takes an element from each array and returns an int. - If it evaluates to a non-zero value iteration is stopped and that value is returned. - The first input array. - The second input array. - - The first non-zero value from the comparison function. - - Thrown when either of the input arrays - is null. - - - For each element of the array, applies the given function. Concatenates all the results and return the combined array. - The function to create sub-arrays from the input array elements. - The input array. - The concatenation of the sub-arrays. - Thrown when the input array is null. - - - Reads a range of elements from the first array and write them into the second. - The source array. - The starting index of the source array. - The target array. - The starting index of the target array. - The number of elements to copy. - Thrown when either of the input arrays is null. - Thrown when any of sourceIndex, targetIndex or count are negative, - or when there aren't enough elements in source or target. - - - Returns the average of the elements generated by applying the function to each element of the array. - The function to transform the array elements before averaging. - The input array. - Thrown when array is empty. - The computed average. - Thrown when the input array is null. - - - Returns the average of the elements in the array. - The input array. - Thrown when array is empty. - The average of the elements in the array. - Thrown when the input array is null. - - - Builds a new array that contains the elements of the first array followed by the elements of the second array. - The first input array. - The second input array. - The resulting array. - Thrown when either of the input arrays is null. - - - Split the collection into two collections, containing the - elements for which the given predicate returns "true" and "false" - respectively - - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to indicies is not specified. - The function to test the input elements. - The input array. - 'T[] * 'T[] - Thrown when the input array is null. - - - Create an array given the dimension and a generator function to compute the elements. - - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to indicies is not specified. - - - 'T[] - - - Apply the given function to each element of the array. The integer passed to the - function indicates the index of element. - - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to elements of the input array is not specified. - - The input array. - Thrown when the input array is null. - - - Apply the given function to each element of the array. - - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to elements of the input array is not specified. - - The input array. - Thrown when the input array is null. - - - Build a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer index passed to the - function indicates the index of element being transformed. - - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to elements of the input array is not specified. - - The input array. - 'U[] - Thrown when the input array is null. - - - Build a new array whose elements are the results of applying the given function - to each of the elements of the array. - - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to elements of the input array is not specified. - - The input array. - 'U[] - Thrown when the input array is null. - - - For each element of the array, apply the given function. Concatenate all the results and return the combined array. - - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to elements of the input array is not specified. - - The input array. - 'U[] - Thrown when the input array is null. - - - Apply the given function to each element of the array. Return - the array comprised of the results "x" for each element where - the function returns Some(x). - - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to elements of the input array is not specified. - The function to generate options from the elements. - The input array. - 'U[] - Thrown when the input array is null. - - - Provides parallel operations on arrays - - - Basic operations on arrays. - - - Compare using the given comparer function. - A function to compare two values. - An object implementing IComparer using the supplied comparer. - - - Non-structural comparison. Compare using NonStructuralComparison.compare. - - - Structural comparison. Compare using Operators.compare. - - - Common notions of comparison identity used with sorted data structures. - - - Hash using the given hashing and equality functions. - A function to generate a hash code from a value. - A function to test equality of two values. - An object implementing IEqualityComparer using the supplied functions. - - - Physical hashing (hash on reference identity of objects, and the contents of value types). - Hash using LanguagePrimitives.PhysicalEquality and LanguagePrimitives.PhysicalHash, - That is, for value types use GetHashCode and Object.Equals (if no other optimization available), - and for reference types use System.Runtime.CompilerServices.RuntimeHelpers.GetHashCode and - reference equality. - - - Non-structural hashing. Equality using NonStructuralComparison.(=) and NonStructuralComparison.hash. - - - Structural hashing. Hash using Operators.(=) and Operators.hash. - - - Common notions of value identity used with hash tables. - - - Combines the three lists into a list of triples. The lists must have equal lengths. - The first input list. - The second input list. - The third input list. - A single list containing triples of matching elements from the input lists. - - - Combines the two lists into a list of pairs. The two lists must have equal lengths. - The first input list. - The second input list. - A single list containing pairs of matching elements from the input lists. - - - Returns a list of sliding windows containing elements drawn from the input - list. Each window is returned as a fresh list. - The number of elements in each window. - The input list. - The result list. - Thrown when windowSize is not positive. - - - Returns a new list containing only the elements of the list - for which the given predicate returns "true" - The function to test the input elements. - The input list. - A list containing only the elements that satisfy the predicate. - - - Splits a list of triples into three lists. - The input list. - Three lists of split elements. - - - Splits a list of pairs into two lists. - The input list. - Two lists of split elements. - - - Returns a list that contains the elements generated by the given computation. - The given initial state argument is passed to the element generator. - A function that takes in the current state and returns an option tuple of the next - element of the list and the next state value. - The initial state value. - The result list. - - - Returns the index of the last element in the list - that satisfies the given predicate. - Return None if no such element exists. - The function to test the input elements. - The input list. - The index of the last element for which the predicate returns true, or None if - every element evaluates to false. - - - Tries to find the nth element in the list. - Returns None if index is negative or the list does not contain enough elements. - The index to retrieve. - The input list. - The value at the given index or None. - - - Returns the index of the first element in the list - that satisfies the given predicate. - Return None if no such element exists. - The function to test the input elements. - The input list. - The index of the first element for which the predicate returns true, or None if - every element evaluates to false. - - - Returns the last element for which the given function returns true.. - Return None if no such element exists. - The function to test the input elements. - The input list. - The last element for which the predicate returns true, or None if - every element evaluates to false. - - - Returns the first element for which the given function returns true.. - Return None if no such element exists. - The function to test the input elements. - The input list. - The first element for which the predicate returns true, or None if - every element evaluates to false. - - - Applies the given function to successive elements, returning Some(x) the first - result where function returns Some(x) for some x. If no such element - exists then return None. - The function to generate options from the elements. - The input list. - The first resulting value or None. - - - Returns at most N elements in a new list. - The maximum number of items to return. - The input list. - The result list. - - - Returns the first element of the list, or - None if the list is empty. - The input list. - The first element of the list or None. - - - Views the given list as a sequence. - The input list. - The sequence of elements in the list. - - - Builds an array from the given list. - The input list. - The array containing the elements of the list. - - - Returns a list that contains all elements of the original list while the - given predicate returns true, and then returns no further elements. - - A function that evaluates to false when no more items should be returned. - The input list. - - The result list. - - - Returns the first N elements of the list. - Throws InvalidOperationException - if the count exceeds the number of elements in the list. List.truncate - returns as many items as the list contains instead of throwing an exception. - - The number of items to take. - The input list. - - The result list. - - Thrown when the input list is empty. - Thrown when count exceeds the number of elements - in the list. - - - Returns the list after removing the first element. - - The input list. - Thrown when the list is empty. - The list after removing the first element. - - - Returns the sum of the results generated by applying the function to each element of the list. - The function to transform the list elements into the type to be summed. - The input list. - The resulting sum. - - - Returns the sum of the elements in the list. - The input list. - The resulting sum. - - - Sorts the given list in descending order using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The input list. - The sorted list. - - - Sorts the given list in descending order using keys given by the given projection. Keys are compared using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The function to transform the list elements into the type to be compared. - The input list. - The sorted list. - - - Splits a list into two lists, at the given index. - The index at which the list is split. - The input list. - The two split lists. - - Thrown when split index exceeds the number of elements - in the list. - - - Sorts the given list using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The input list. - The sorted list. - - - Sorts the given list using keys given by the given projection. Keys are compared using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The function to transform the list elements into the type to be compared. - The input list. - The sorted list. - - - Sorts the given list using the given comparison function. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The function to compare the list elements. - The input list. - The sorted list. - - - Bypasses elements in a list while the given predicate returns true, and then returns - the remaining elements of the list. - A function that evaluates an element of the list to a boolean value. - The input list. - The result list. - - - Returns the list after removing the first N elements. - The number of elements to skip. - The input list. - The list after removing the first N elements. - Thrown when count is negative or exceeds the number of - elements in the list. - - - Returns a list that contains one item only. - - The input item. - - The result list of one item. - - - Like foldBack, but returns both the intermediary and final results - The function to update the state given the input elements. - The input list. - The initial state. - The list of states. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. Take the second argument, and apply the function to it - and the first element of the list. Then feed this result into the function along - with the second element and so on. Returns the list of intermediate results and the final result. - The function to update the state given the input elements. - The initial state. - The input list. - The list of states. - - - Returns a new list with the elements in reverse order. - The input list. - The reversed list. - - - Creates a list by replicating the given initial value. - The number of elements to replicate. - The value to replicate - The generated list. - - - Applies a function to each element of the collection, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then computes - f i0 (...(f iN-1 iN)). - A function that takes in the next-to-last element of the list and the - current accumulated result to produce the next accumulated result. - The input list. - Thrown when the list is empty. - The final result of the reductions. - - - Apply a function to each element of the collection, threading an accumulator argument - through the computation. Apply the function to the first two elements of the list. - Then feed this result into the function along with the third element and so on. - Return the final result. If the input function is f and the elements are i0...iN then computes - f (... (f i0 i1) i2 ...) iN. - - Raises System.ArgumentException if list is empty - The function to reduce two list elements to a single element. - The input list. - Thrown when the list is empty. - The final reduced value. - - - Returns a list with all elements permuted according to the - specified permutation. - The function to map input indices to output indices. - The input list. - The permuted list. - Thrown when indexMap does not produce a valid permutation. - - - Applies the given function to successive elements, returning the first - result where function returns Some(x) for some x. If no such - element exists then raise System.Collections.Generic.KeyNotFoundException - The function to generate options from the elements. - The input list. - Thrown when the list is empty. - The first resulting value. - - - Splits the collection into two collections, containing the - elements for which the given predicate returns true and false - respectively. Element order is preserved in both of the created lists. - The function to test the input elements. - The input list. - A list containing the elements for which the predicate evaluated to false and a list - containing the elements for which the predicate evaluated to true. - - - Returns a list of each element in the input list and its predecessor, with the - exception of the first element which is only returned as the predecessor of the second element. - - The input list. - - The result list. - - - Builds a new list from the given enumerable object. - The input sequence. - The list of elements from the sequence. - - - Builds a list from the given array. - The input array. - The list of elements from the array. - - - Indexes into the list. The first element has index 0. - The input list. - The index to retrieve. - The value at the given index. - Thrown when the index is negative or the input list does not contain enough elements. - - - Returns the lowest of all elements of the list, compared via Operators.min on the function result - - Raises System.ArgumentException if list is empty. - The function to transform list elements into the type to be compared. - The input list. - Thrown when the list is empty. - The minimum value. - - - Returns the lowest of all elements of the list, compared via Operators.min. - - Raises System.ArgumentException if list is empty - The input list. - Thrown when the list is empty. - The minimum value. - - - Returns the greatest of all elements of the list, compared via Operators.max on the function result. - - Raises System.ArgumentException if list is empty. - The function to transform the list elements into the type to be compared. - The input list. - Thrown when the list is empty. - The maximum element. - - - Return the greatest of all elements of the list, compared via Operators.max. - - Raises System.ArgumentException if list is empty - The input list. - Thrown when the list is empty. - The maximum element. - - - Like mapi, but mapping corresponding elements from two lists of equal length. - The function to transform pairs of elements from the two lists and their index. - The first input list. - The second input list. - The list of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The integer index passed to the - function indicates the index (from 0) of element being transformed. - The function to transform elements and their indices. - The input list. - The list of transformed elements. - - - Combines map and foldBack. Builds a new list whose elements are the results of applying the given function - to each of the elements of the input list. The function is also used to accumulate a final value. - The function to transform elements from the input list and accumulate the final value. - The input list. - The initial state. - The list of transformed elements, and the final accumulated value. - - - Combines map and fold. Builds a new list whose elements are the results of applying the given function - to each of the elements of the input list. The function is also used to accumulate a final value. - The function to transform elements from the input list and accumulate the final value. - The initial state. - The input list. - The list of transformed elements, and the final accumulated value. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the three collections simultaneously. - The function to transform triples of elements from the input lists. - The first input list. - The second input list. - The third input list. - The list of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the two collections pairwise. - The function to transform pairs of elements from the input lists. - The first input list. - The second input list. - The list of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. - The function to transform elements from the input list. - The input list. - The list of transformed elements. - - - Returns the last element of the list. - Return None if no such element exists. - The input list. - The last element of the list or None. - - - Returns the length of the list. - The input list. - The length of the list. - - - Returns the last element of the list. - The input list. - The last element of the list. - Thrown when the input does not have any elements. - - - Applies the given function to two collections simultaneously. The - collections must have identical size. The integer passed to the - function indicates the index of element. - The function to apply to a pair of elements from the input lists along with their index. - The first input list. - The second input list. - - - Applies the given function to each element of the collection. The integer passed to the - function indicates the index of element. - The function to apply to the elements of the list along with their index. - The input list. - - - Applies the given function to two collections simultaneously. The - collections must have identical size. - The function to apply to pairs of elements from the input lists. - The first input list. - The second input list. - - - Applies the given function to each element of the collection. - The function to apply to elements from the input list. - The input list. - - - Indexes into the list. The first element has index 0. - The index to retrieve. - The input list. - The value at the given index. - Thrown when the index is negative or the input list does not contain enough elements. - - - Returns true if the list contains no elements, false otherwise. - The input list. - True if the list is empty. - - - Creates a list by calling the given generator on each index. - The length of the list to generate. - The function to generate an element from an index. - The list of generated elements. - - - Returns a new list whose elements are the corresponding elements - of the input list paired with the index (from 0) of each element. - The input list. - The list of indexed elements. - - - Returns the first element of the list. - - The input list. - Thrown when the list is empty. - The first element of the list. - - - Applies a key-generating function to each element of a list and yields a list of - unique keys. Each unique key contains a list of all elements that match - to this key. - - A function that transforms an element of the list into a comparable key. - The input list. - - The result list. - - - Tests if all corresponding elements of the collection satisfy the given predicate pairwise. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns false then the overall result is - false and no further elements are tested. Otherwise, if one collection is longer - than the other then the System.ArgumentException exception is raised. - Otherwise, true is returned. - The function to test the input elements. - The first input list. - The second input list. - Thrown when the input lists differ in length. - True if all of the pairs of elements satisfy the predicate. - - - Tests if all elements of the collection satisfy the given predicate. - - The predicate is applied to the elements of the input list. If any application - returns false then the overall result is false and no further elements are tested. - Otherwise, true is returned. - The function to test the input elements. - The input list. - True if all of the elements satisfy the predicate. - - - Applies a function to corresponding elements of two collections, threading an accumulator argument - through the computation. The collections must have identical sizes. - If the input function is f and the elements are i0...iN and j0...jN - then computes f i0 j0 (...(f iN jN s)). - The function to update the state given the input elements. - The first input list. - The second input list. - The initial state. - The final state value. - - - Applies a function to each element of the collection, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then - computes f i0 (...(f iN s)). - The function to update the state given the input elements. - The input list. - The initial state. - The state object after the folding function is applied to each element of the list. - - - Applies a function to corresponding elements of two collections, threading an accumulator argument - through the computation. The collections must have identical sizes. - If the input function is f and the elements are i0...iN and j0...jN - then computes f (... (f s i0 j0)...) iN jN. - The function to update the state given the input elements. - The initial state. - The first input list. - The second input list. - The final state value. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. Take the second argument, and apply the function to it - and the first element of the list. Then feed this result into the function along - with the second element and so on. Return the final result. - If the input function is f and the elements are i0...iN then - computes f (... (f s i0) i1 ...) iN. - The function to update the state given the input elements. - The initial state. - The input list. - The final state value. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true" - The function to test the input elements. - The input list. - A list containing only the elements that satisfy the predicate. - - - Returns the index of the last element in the list - that satisfies the given predicate. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for all the - elements of the list. - The index of the last element that satisfies the predicate. - - - Returns the index of the first element in the list - that satisfies the given predicate. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for all the - elements of the list. - The index of the first element that satisfies the predicate. - - - Returns the last element for which the given function returns true. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for - all the elements of the list. - The last element that satisfies the predicate. - - - Returns the first element for which the given function returns true. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for - all the elements of the list. - The first element that satisfies the predicate. - - - Tests if any pair of corresponding elements of the lists satisfies the given predicate. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns true then the overall result is - true and no further elements are tested. Otherwise, if one collections is longer - than the other then the System.ArgumentException exception is raised. - Otherwise, false is returned. - The function to test the input elements. - The first input list. - The second input list. - Thrown when the input lists differ in length. - True if any pair of elements satisfy the predicate. - - - Tests if any element of the list satisfies the given predicate. - - The predicate is applied to the elements of the input list. If any application - returns true then the overall result is true and no further elements are tested. - Otherwise, false is returned. - The function to test the input elements. - The input list. - True if any element satisfies the predicate. - - - Returns the only element of the list. - - The input list. - - The only element of the list. - - Thrown when the input does not have precisely one element. - - - Returns a new list with the distinct elements of the input list which do not appear in the itemsToExclude sequence, - using generic hash and equality comparisons to compare values. - - A sequence whose elements that also occur in the input list will cause those elements to be - removed from the result. - A list whose elements that are not also in itemsToExclude will be returned. - - A list that contains the distinct elements of list that do not appear in itemsToExclude. - - Thrown when itemsToExclude is null. - - - Returns an empty list of the given type. - - - Splits the input list into at most count chunks. - The maximum number of chunks. - The input list. - The list split into chunks. - Thrown when count is not positive. - - - Applies a key-generating function to each element of a list and returns a list yielding unique - keys and their number of occurrences in the original list. - - A function transforming each item of the input list into a key to be - compared against the others. - The input list. - - The result list. - - - Returns a list that contains no duplicate entries according to the - generic hash and equality comparisons on the keys returned by the given key-generating function. - If an element occurs multiple times in the list then the later occurrences are discarded. - - A function transforming the list items into comparable keys. - The input list. - - The result list. - - - Returns a list that contains no duplicate entries according to generic hash and - equality comparisons on the entries. - If an element occurs multiple times in the list then the later occurrences are discarded. - - The input list. - - The result list. - - - Tests if the list contains the specified element. - The value to locate in the input list. - The input list. - True if the input list contains the specified element; false otherwise. - - - Returns a new list that contains the elements of each the lists in order. - The input sequence of lists. - The resulting concatenated list. - - - Compares two lists using the given comparison function, element by element. - Returns the first non-zero result from the comparison function. If the end of a list - is reached it returns a -1 if the first list is shorter and a 1 if the second list - is shorter. - - A function that takes an element from each list and returns an int. - If it evaluates to a non-zero value iteration is stopped and that value is returned. - The first input list. - The second input list. - - The first non-zero value from the comparison function. - - - For each element of the list, applies the given function. Concatenates all the results and return the combined list. - The function to transform each input element into a sublist to be concatenated. - The input list. - The concatenation of the transformed sublists. - - - Divides the input list into chunks of size at most chunkSize. - The maximum size of each chunk. - The input list. - The list divided into chunks. - Thrown when chunkSize is not positive. - - - Applies the given function to each element of the list. Returns - the list comprised of the results x for each element where - the function returns Some(x) - The function to generate options from the elements. - The input list. - The list comprising the values selected from the chooser function. - - - Returns the average of the elements generated by applying the function to each element of the list. - - Raises System.ArgumentException if list is empty. - The function to transform the list elements into the type to be averaged. - The input list. - Thrown when the list is empty. - The resulting average. - - - Returns the average of the elements in the list. - - Raises System.ArgumentException if list is empty. - The input list. - Thrown when the list is empty. - The resulting average. - - - Returns a new list that contains the elements of the first list - followed by elements of the second. - The first input list. - The second input list. - The resulting list. - - - Basic operations on lists. - - - Returns the key of the first mapping in the collection that satisfies the given predicate. - Returns 'None' if no such element exists. - The function to test the input elements. - The input map. - The first key for which the predicate returns true or None if the predicate evaluates to false for each key/value pair. - - - Evaluates the function on each mapping in the collection. Returns the key for the first mapping - where the function returns 'true'. Raise KeyNotFoundException if no such element exists. - The function to test the input elements. - The input map. - Thrown if the key does not exist in the map. - The first key for which the predicate evaluates true. - - - Lookup an element in the map, returning a Some value if the element is in the domain - of the map and None if not. - The input key. - The input map. - The found Some value or None. - - - Removes an element from the domain of the map. No exception is raised if the element is not present. - The input key. - The input map. - The resulting map. - - - Builds two new maps, one containing the bindings for which the given predicate returns 'true', - and the other the remaining bindings. - The function to test the input elements. - The input map. - A pair of maps in which the first contains the elements for which the predicate returned true - and the second containing the elements for which the predicated returned false. - - - Tests if an element is in the domain of the map. - The input key. - The input map. - True if the map contains the key. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The key passed to the - function indicates the key of element being transformed. - The function to transform the key/value pairs. - The input map. - The resulting map of keys and transformed values. - - - Returns true if the given predicate returns true for all of the - bindings in the map. - The function to test the input elements. - The input map. - True if the predicate evaluates to true for all of the bindings in the map. - - - Builds a new map containing only the bindings for which the given predicate returns 'true'. - The function to test the key/value pairs. - The input map. - The filtered map. - - - Returns true if the given predicate returns true for one of the - bindings in the map. - The function to test the input elements. - The input map. - True if the predicate returns true for one of the key/value pairs. - - - Applies the given function to each binding in the dictionary - The function to apply to each key/value pair. - The input map. - - - Folds over the bindings in the map - The function to update the state given the input key/value pairs. - The initial state. - The input map. - The final state value. - - - Folds over the bindings in the map. - The function to update the state given the input key/value pairs. - The input map. - The initial state. - The final state value. - - - Searches the map looking for the first element where the given function returns a Some value - The function to generate options from the key/value pairs. - The input map. - The first result. - - - Searches the map looking for the first element where the given function returns a Some value. - The function to generate options from the key/value pairs. - The input map. - The first result. - - - Lookup an element in the map, raising KeyNotFoundException if no binding - exists in the map. - The input key. - The input map. - Thrown when the key does not exist in the map. - The value mapped to the given key. - - - The empty map. - - - Is the map empty? - The input map. - True if the map is empty. - - - Returns an array of all key-value pairs in the mapping. - The array will be ordered by the keys of the map. - The input map. - The array of key/value pairs. - - - Returns a list of all key-value pairs in the mapping. - The list will be ordered by the keys of the map. - The input map. - The list of key/value pairs. - - - Views the collection as an enumerable sequence of pairs. - The sequence will be ordered by the keys of the map. - The input map. - The sequence of key/value pairs. - - - Returns a new map made from the given bindings. - The input sequence of key/value pairs. - The resulting map. - - - Returns a new map made from the given bindings. - The input array of key/value pairs. - The resulting map. - - - Returns a new map made from the given bindings. - The input list of key/value pairs. - The resulting map. - - - Returns a new map with the binding added to the given map. - The input key. - The input value. - The input map. - The resulting map. - - - Functional programming operators related to the Map<_,_> type. - - - Combines the three sequences into a list of triples. The sequences need not have equal lengths: - when one sequence is exhausted any remaining elements in the other - sequences are ignored. - - The first input sequence. - The second input sequence. - The third input sequence. - - The result sequence. - - Thrown when any of the input sequences is null. - - - Combines the two sequences into a list of pairs. The two sequences need not have equal lengths: - when one sequence is exhausted any remaining elements in the other - sequence are ignored. - - The first input sequence. - The second input sequence. - - The result sequence. - - Thrown when either of the input sequences is null. - - - Returns a sequence that yields sliding windows containing elements drawn from the input - sequence. Each window is returned as a fresh array. - The number of elements in each window. - The input sequence. - The result sequence. - Thrown when the input sequence is null. - Thrown when windowSize is not positive. - - - Returns a sequence that contains the elements generated by the given computation. - The given initial state argument is passed to the element generator. - For each IEnumerator elements in the stream are generated on-demand by applying the element - generator, until a None value is returned by the element generator. Each call to the element - generator returns a new residual state. - - The stream will be recomputed each time an IEnumerator is requested and iterated for the Seq. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - A function that takes in the current state and returns an option tuple of the next - element of the sequence and the next state value. - The initial state value. - - The result sequence. - - - Returns a sequence that when enumerated returns at most N elements. - - The maximum number of items to enumerate. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Applies the given function to successive elements, returning the first - result where the function returns "Some(x)". - - A function that transforms items from the input sequence into options. - The input sequence. - - The chosen element or None. - - Thrown when the input sequence is null. - - - Returns the index of the last element in the sequence - that satisfies the given predicate. Return None if no such element exists. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - The found index or None. - Thrown when the input sequence is null. - - - Tries to find the nth element in the sequence. - Returns None if index is negative or the input sequence does not contain enough elements. - The index of element to retrieve. - The input sequence. - The nth element of the sequence or None. - Thrown when the input sequence is null. - - - Returns the index of the first element in the sequence - that satisfies the given predicate. Return None if no such element exists. - - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - - The found index or None. - - Thrown when the input sequence is null. - - - Returns the last element for which the given function returns true. - Return None if no such element exists. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - The found element or None. - Thrown when the input sequence is null. - - - Returns the first element for which the given function returns true. - Return None if no such element exists. - - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - - The found element or None. - - Thrown when the input sequence is null. - - - Builds a list from the given collection. - - The input sequence. - - The result list. - - Thrown when the input sequence is null. - - - Builds an array from the given collection. - - The input sequence. - - The result array. - - Thrown when the input sequence is null. - - - Returns a sequence that, when iterated, yields elements of the underlying sequence while the - given predicate returns true, and then returns no further elements. - - A function that evaluates to false when no more items should be returned. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns the first N elements of the sequence. - Throws InvalidOperationException - if the count exceeds the number of elements in the sequence. Seq.truncate - returns as many items as the sequence contains instead of throwing an exception. - - The number of items to take. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - Thrown when count exceeds the number of elements - in the sequence. - - - Returns a sequence that skips 1 element of the underlying sequence and then yields the - remaining elements of the sequence. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the sum of the results generated by applying the function to each element of the sequence. - The generated elements are summed using the + operator and Zero property associated with the generated type. - - A function to transform items from the input sequence into the type that will be summed. - The input sequence. - - The computed sum. - - - Returns the sum of the elements in the sequence. - - The elements are summed using the + operator and Zero property associated with the generated type. - - The input sequence. - - The computed sum. - - - Applies a key-generating function to each element of a sequence and yield a sequence ordered - descending by keys. The keys are compared using generic comparison as implemented by Operators.compare. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - A function to transform items of the input sequence into comparable keys. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Yields a sequence ordered descending by keys. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Applies a key-generating function to each element of a sequence and yield a sequence ordered - by keys. The keys are compared using generic comparison as implemented by Operators.compare. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - A function to transform items of the input sequence into comparable keys. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Yields a sequence ordered using the given comparison function. - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - The function to compare the collection elements. - The input sequence. - The result sequence. - - - Yields a sequence ordered by keys. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that, when iterated, skips elements of the underlying sequence while the - given predicate returns true, and then yields the remaining elements of the sequence. - - A function that evaluates an element of the sequence to a boolean value. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that skips N elements of the underlying sequence and then yields the - remaining elements of the sequence. - - The number of items to skip. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when count exceeds the number of elements - in the sequence. - - - Returns a sequence that yields one item only. - - The input item. - - The result sequence of one item. - - - Like foldBack, but returns the sequence of intermediary and final results. - This function returns a sequence that digests the whole initial sequence as soon as that - sequence is iterated. As a result this function should not be used with large or infinite sequences. - - A function that updates the state with each element from the sequence. - The input sequence. - The initial state. - The resulting sequence of computed states. - Thrown when the input sequence is null. - - - Like fold, but computes on-demand and returns the sequence of intermediary and final results. - - A function that updates the state with each element from the sequence. - The initial state. - The input sequence. - - The resulting sequence of computed states. - - Thrown when the input sequence is null. - - - Returns a new sequence with the elements in reverse order. - The input sequence. - The reversed sequence. - Thrown when the input sequence is null. - - - Applies a function to each element of the sequence, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f i0 (...(f iN-1 iN)). - A function that takes in the next-to-last element of the sequence and the - current accumulated result to produce the next accumulated result. - The input sequence. - The final result of the reductions. - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Creates a sequence by replicating the given initial value. - The number of elements to replicate. - The value to replicate - The generated sequence. - - - Applies a function to each element of the sequence, threading an accumulator argument - through the computation. Begin by applying the function to the first two elements. - Then feed this result into the function along with the third element and so on. - Return the final result. - - A function that takes in the current accumulated result and the next - element of the sequence to produce the next accumulated result. - The input sequence. - - The final result of the reduction function. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Builds a new sequence object that delegates to the given sequence object. This ensures - the original sequence cannot be rediscovered and mutated by a type cast. For example, - if given an array the returned sequence will return the elements of the array, but - you cannot cast the returned sequence object to an array. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Applies the given function to successive elements, returning the first - x where the function returns "Some(x)". - - A function to transform each item of the input sequence into an option of the output type. - The input sequence. - - The selected element. - - Thrown when the input sequence is null. - Thrown when every item of the sequence - evaluates to None when the given function is applied. - - - Returns a sequence with all elements permuted according to the - specified permutation. - - Note that this function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. - - The function that maps input indices to output indices. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when indexMap does not produce a valid permutation. - - - Returns a sequence of each element in the input sequence and its predecessor, with the - exception of the first element which is only returned as the predecessor of the second element. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Views the given list as a sequence. - - The input list. - - The result sequence. - - - Views the given array as a sequence. - - The input array. - - The result sequence. - - Thrown when the input sequence is null. - - - Computes the nth element in the collection. - - The index of element to retrieve. - The input sequence. - - The nth element of the sequence. - - Thrown when the input sequence is null. - Thrown when the index is negative or the input sequence does not contain enough elements. - - - Returns the lowest of all elements of the sequence, compared via Operators.min on the function result. - - A function to transform items from the input sequence into comparable keys. - The input sequence. - - The smallest element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the lowest of all elements of the sequence, compared via Operators.min. - - The input sequence. - - The smallest element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the greatest of all elements of the sequence, compared via Operators.max on the function result. - - A function to transform items from the input sequence into comparable keys. - The input sequence. - - The largest element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the greatest of all elements of the sequence, compared via Operators.max - - The input sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - The largest element of the sequence. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding pairs of elements from the two sequences. If one input sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. The integer index passed to the - function indicates the index (from 0) of element being transformed. - - A function to transform pairs of items from the input sequences that also supplies the current index. - The first input sequence. - The second input sequence. - - The result sequence. - - Thrown when either of the input sequences is null. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The integer index passed to the - function indicates the index (from 0) of element being transformed. - - A function to transform items from the input sequence that also supplies the current index. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding triples of elements from the three sequences. If one input sequence if shorter than - the others then the remaining elements of the longer sequences are ignored. - - The function to transform triples of elements from the input sequences. - The first input sequence. - The second input sequence. - The third input sequence. - - The result sequence. - - Thrown when any of the input sequences is null. - - - Combines map and foldBack. Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The function is also used to accumulate a final value. - This function digests the whole initial sequence as soon as it is called. As a result this function should - not be used with large or infinite sequences. - The function to transform elements from the input collection and accumulate the final value. - The input collection. - The initial state. - Thrown when the input collection is null. - The collection of transformed elements, and the final accumulated value. - - - Combines map and fold. Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The function is also used to accumulate a final value. - This function digests the whole initial sequence as soon as it is called. As a result this function should - not be used with large or infinite sequences. - The function to transform elements from the input collection and accumulate the final value. - The initial state. - The input collection. - Thrown when the input collection is null. - The collection of transformed elements, and the final accumulated value. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding pairs of elements from the two sequences. If one input sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to transform pairs of items from the input sequences. - The first input sequence. - The second input sequence. - - The result sequence. - - Thrown when either of the input sequences is null. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The given function will be applied - as elements are demanded using the MoveNext method on enumerators retrieved from the - object. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - A function to transform items from the input sequence. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns the length of the sequence - - The input sequence. - - The length of the sequence. - - Thrown when the input sequence is null. - - - Applies the given function to two collections simultaneously. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. The integer passed to the - function indicates the index of element. - - A function to apply to each pair of elements from the input sequences along with their index. - The first input sequence. - The second input sequence. - - Thrown when either of the input sequences is null. - - - Applies the given function to two collections simultaneously. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to apply to each pair of elements from the input sequences. - The first input sequence. - The second input sequence. - - Thrown when either of the input sequences is null. - - - Applies the given function to each element of the collection. The integer passed to the - function indicates the index of element. - - A function to apply to each element of the sequence that can also access the current index. - The input sequence. - - Thrown when the input sequence is null. - - - Applies the given function to each element of the collection. - - A function to apply to each element of the sequence. - The input sequence. - - Thrown when the input sequence is null. - - - Computes the element at the specified index in the collection. - The index of the element to retrieve. - The input sequence. - The element at the specified index of the sequence. - Thrown when the input sequence is null. - Thrown when the index is negative or the input sequence does not contain enough elements. - - - Generates a new sequence which, when iterated, will return successive - elements by calling the given function. The results of calling the function - will not be saved, that is the function will be reapplied as necessary to - regenerate the elements. The function is passed the index of the item being - generated. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - Iteration can continue up to Int32.MaxValue. - - A function that generates an item in the sequence from a given index. - - The result sequence. - - - Generates a new sequence which, when iterated, will return successive - elements by calling the given function, up to the given count. Each element is saved after its - initialization. The function is passed the index of the item being - generated. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - The maximum number of items to generate for the sequence. - A function that generates an item in the sequence from a given index. - - The result sequence. - - Thrown when count is negative. - - - Builds a new collection whose elements are the corresponding elements of the input collection - paired with the integer index (from 0) of each element. - The input sequence. - The result sequence. - Thrown when the input sequence is null. - - - Returns true if the sequence contains no elements, false otherwise. - - The input sequence. - - True if the sequence is empty; false otherwise. - - Thrown when the input sequence is null. - - - Returns the only element of the sequence. - - The input sequence. - - The only element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input does not have precisely one element. - - - Returns the last element of the sequence. - Return None if no such element exists. - - The input sequence. - - The last element of the sequence or None. - - Thrown when the input sequence is null. - - - Returns the last element of the sequence. - The input sequence. - The last element of the sequence. - Thrown when the input sequence is null. - Thrown when the input does not have any elements. - - - Returns the first element of the sequence, or None if the sequence is empty. - - The input sequence. - - The first element of the sequence or None. - - Thrown when the input sequence is null. - - - Returns the first element of the sequence. - - The input sequence. - - The first element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input does not have any elements. - - - Applies a key-generating function to each element of a sequence and yields a sequence of - unique keys. Each unique key contains a sequence of all elements that match - to this key. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - A function that transforms an element of the sequence into a comparable key. - The input sequence. - - The result sequence. - - - Tests the all pairs of elements drawn from the two sequences satisfy the - given predicate. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to test pairs of elements from the input sequences. - The first input sequence. - The second input sequence. - - True if all pairs satisfy the predicate; false otherwise. - - Thrown when either of the input sequences is null. - - - Tests if all elements of the sequence satisfy the given predicate. - - The predicate is applied to the elements of the input sequence. If any application - returns false then the overall result is false and no further elements are tested. - Otherwise, true is returned. - - A function to test an element of the input sequence. - The input sequence. - - True if every element of the sequence satisfies the predicate; false otherwise. - - Thrown when the input sequence is null. - - - Applies a function to corresponding elements of two collections, starting from the end of the shorter collection, - threading an accumulator argument through the computation. The two sequences need not have equal lengths. - If the input function is f and the elements are i0...iN and j0...jM, N < M - then computes f i0 j0 (... (f iN jN s)...). - The function to update the state given the input elements. - The first input sequence. - The second input sequence. - The initial state. - The final state value. - Thrown when the either of the input sequences is null. - - - Applies a function to each element of the collection, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f i0 (... (f iN s)...) - The function to update the state given the input elements. - The input sequence. - The initial state. - The state object after the folding function is applied to each element of the sequence. - Thrown when the input sequence is null. - - - Applies a function to corresponding elements of two collections, threading an accumulator argument - through the computation. The two sequences need not have equal lengths: - when one sequence is exhausted any remaining elements in the other sequence are ignored. - If the input function is f and the elements are i0...iN and j0...jN - then computes f (... (f s i0 j0)...) iN jN. - The function to update the state given the input elements. - The initial state. - The first input sequence. - The second input sequence. - The final state value. - Thrown when the either of the input sequences is null. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f (... (f s i0)...) iN - - A function that updates the state with each element from the sequence. - The initial state. - The input sequence. - - The state object after the folding function is applied to each element of the sequence. - - Thrown when the input sequence is null. - - - Returns the index of the last element for which the given function returns true. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function to test whether the index of a particular element should be returned. - The input sequence. - The index of the last element for which the predicate returns true. - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns the index of the first element for which the given function returns true. - - A function to test whether the index of a particular element should be returned. - The input sequence. - - The index of the first element for which the predicate returns true. - - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns the last element for which the given function returns true. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function to test whether an item in the sequence should be returned. - The input sequence. - The last element for which the predicate returns true. - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns the first element for which the given function returns true. - - A function to test whether an item in the sequence should be returned. - The input sequence. - - The first element for which the predicate returns true. - - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true". - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - Remember sequence is lazy, effects are delayed until it is enumerated. - - A synonym for Seq.filter. - - A function to test whether each item in the input sequence should be included in the output. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true". This is a synonym for Seq.where. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - Remember sequence is lazy, effects are delayed until it is enumerated. - - A function to test whether each item in the input sequence should be included in the output. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Tests if any pair of corresponding elements of the input sequences satisfies the given predicate. - - The predicate is applied to matching elements in the two sequences up to the lesser of the - two lengths of the collections. If any application returns true then the overall result is - true and no further elements are tested. Otherwise, false is returned. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to test each pair of items from the input sequences. - The first input sequence. - The second input sequence. - - True if any result from the predicate is true; false otherwise. - - Thrown when either of the two input sequences is null. - - - Tests if any element of the sequence satisfies the given predicate. - - The predicate is applied to the elements of the input sequence. If any application - returns true then the overall result is true and no further elements are tested. - Otherwise, false is returned. - - A function to test each item of the input sequence. - The input sequence. - - True if any result from the predicate is true; false otherwise. - - Thrown when the input sequence is null. - - - Returns a new sequence with the distinct elements of the second sequence which do not apear in the first sequence, - using generic hash and equality comparisons to compare values. - - Note that this function returns a sequence that digests the whole of the first input sequence as soon as - the result sequence is iterated. As a result this function should not be used with - large or infinite sequences in the first parameter. The function makes no assumption on the ordering of the first input - sequence. - - A sequence whose elements that also occur in the second sequence will cause those elements to be - removed from the returned sequence. - A sequence whose elements that are not also in first will be returned. - - A sequence that contains the set difference of the elements of two sequences. - - Thrown when either of the two input sequences is null. - - - Creates an empty sequence. - - An empty sequence. - - - Splits the input sequence into at most count chunks. - This function returns a sequence that digests the whole initial sequence as soon as that - sequence is iterated. As a result this function should not be used with large or infinite sequences. - The maximum number of chunks. - The input sequence. - The sequence split into chunks. - Thrown when the input sequence is null. - Thrown when count is not positive. - - - Returns a sequence that contains no duplicate entries according to the - generic hash and equality comparisons on the keys returned by the given key-generating function. - If an element occurs multiple times in the sequence then the later occurrences are discarded. - - A function transforming the sequence items into comparable keys. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that contains no duplicate entries according to generic hash and - equality comparisons on the entries. - If an element occurs multiple times in the sequence then the later occurrences are discarded. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that is built from the given delayed specification of a - sequence. - - The input function is evaluated each time an IEnumerator for the sequence - is requested. - - The generating function for the sequence. - - - Applies a key-generating function to each element of a sequence and returns a sequence yielding unique - keys and their number of occurrences in the original sequence. - - Note that this function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - A function transforming each item of the input sequence into a key to be - compared against the others. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Tests if the sequence contains the specified element. - The value to locate in the input sequence. - The input sequence. - True if the input sequence contains the specified element; false otherwise. - Thrown when the input sequence is null. - - - Combines the given enumeration-of-enumerations as a single concatenated - enumeration. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - The input enumeration-of-enumerations. - - The result sequence. - - Thrown when the input sequence is null. - - - Compares two sequences using the given comparison function, element by element. - Returns the first non-zero result from the comparison function. If the end of a sequence - is reached it returns a -1 if the first sequence is shorter and a 1 if the second sequence - is shorter. - - A function that takes an element from each sequence and returns an int. - If it evaluates to a non-zero value iteration is stopped and that value is returned. - The first input sequence. - The second input sequence. - - The first non-zero value from the comparison function. - - Thrown when either of the input sequences - is null. - - - Applies the given function to each element of the sequence and concatenates all the - results. - - Remember sequence is lazy, effects are delayed until it is enumerated. - - A function to transform elements of the input sequence into the sequences - that will then be concatenated. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Divides the input sequence into chunks of size at most chunkSize. - The maximum size of each chunk. - The input sequence. - The sequence divided into chunks. - Thrown when the input sequence is null. - Thrown when chunkSize is not positive. - - - Applies the given function to each element of the list. Return - the list comprised of the results "x" for each element where - the function returns Some(x). - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not - be accessed concurrently. - - A function to transform items of type T into options of type U. - The input sequence of type T. - - The result sequence. - - Thrown when the input sequence is null. - - - Wraps a loosely-typed System.Collections sequence as a typed sequence. - - The use of this function usually requires a type annotation. - An incorrect type annotation may result in runtime type - errors. - Individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that corresponds to a cached version of the input sequence. - This result sequence will have the same elements as the input sequence. The result - can be enumerated multiple times. The input sequence will be enumerated at most - once and only as far as is necessary. Caching a sequence is typically useful when repeatedly - evaluating items in the original sequence is computationally expensive or if - iterating the sequence causes side-effects that the user does not want to be - repeated multiple times. - - Enumeration of the result sequence is thread safe in the sense that multiple independent IEnumerator - values may be used simultaneously from different threads (accesses to - the internal lookaside table are thread safe). Each individual IEnumerator - is not typically thread safe and should not be accessed concurrently. - - Once enumeration of the input sequence has started, - it's enumerator will be kept live by this object until the enumeration has completed. - At that point, the enumerator will be disposed. - - The enumerator may be disposed and underlying cache storage released by - converting the returned sequence object to type IDisposable, and calling the Dispose method - on this object. The sequence object may then be re-enumerated and a fresh enumerator will - be used. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns the average of the results generated by applying the function to each element - of the sequence. - - The elements are averaged using the + operator, DivideByInt method and Zero property - associated with the generated type. - - A function applied to transform each element of the sequence. - The input sequence. - - The average. - - Thrown when the input sequence is null. - Thrown when the input sequence has zero elements. - - - Returns the average of the elements in the sequence. - - The elements are averaged using the + operator, DivideByInt method and Zero property - associated with the element type. - - The input sequence. - - The average. - - Thrown when the input sequence is null. - Thrown when the input sequence has zero elements. - - - Wraps the two given enumerations as a single concatenated - enumeration. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed - concurrently. - - The first sequence. - The second sequence. - - The result sequence. - - Thrown when either of the two provided sequences is - null. - - - Basic operations on IEnumerables. - - - Returns a new set with the elements of the second set removed from the first. - The first input set. - The set whose elements will be removed from set1. - The set with the elements of set2 removed from set1. - - - Builds a new collection from the given enumerable object. - The input sequence. - The set containing elements. - - - Returns an ordered view of the collection as an enumerable object. - The input set. - An ordered sequence of the elements of set. - - - Builds an array that contains the elements of the set in order. - The input set. - An ordered array of the elements of set. - - - Builds a set that contains the same elements as the given array. - The input array. - A set containing the elements of array. - - - Builds a list that contains the elements of the set in order. - The input set. - An ordered list of the elements of set. - - - Builds a set that contains the same elements as the given list. - The input list. - A set containing the elements form the input list. - - - Returns the highest element in the set according to the ordering being used for the set. - The input set. - The max value from the set. - - - Returns the lowest element in the set according to the ordering being used for the set. - The input set. - The min value from the set. - - - Returns a new set with the given element removed. No exception is raised if - the set doesn't contain the given element. - The element to remove. - The input set. - The input set with value removed. - - - Splits the set into two sets containing the elements for which the given predicate - returns true and false respectively. - The function to test set elements. - The input set. - A pair of sets with the first containing the elements for which predicate returns - true and the second containing the elements for which predicate returns false. - - - Applies the given function to each element of the set, in order according - to the comparison function. - The function to apply to each element. - The input set. - - - Returns "true" if the set is empty. - The input set. - True if set is empty. - - - Computes the union of a sequence of sets. - The sequence of sets to untion. - The union of the input sets. - - - Computes the union of the two sets. - The first input set. - The second input set. - The union of set1 and set2. - - - Computes the intersection of a sequence of sets. The sequence must be non-empty. - The sequence of sets to intersect. - The intersection of the input sets. - - - Computes the intersection of the two sets. - The first input set. - The second input set. - The intersection of set1 and set2. - - - Tests if all elements of the collection satisfy the given predicate. - If the input function is f and the elements are i0...iN and "j0...jN" - then computes p i0 && ... && p iN. - The function to test set elements. - The input set. - True if all elements of set satisfy predicate. - - - Applies the given accumulating function to all the elements of the set. - The accumulating function. - The input set. - The initial state. - The final state. - - - Applies the given accumulating function to all the elements of the set - The accumulating function. - The initial state. - The input set. - The final state. - - - Returns a new collection containing the results of applying the - given function to each element of the input set. - The function to transform elements of the input set. - The input set. - A set containing the transformed elements. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns true. - The function to test set elements. - The input set. - The set containing only the elements for which predicate returns true. - - - Tests if any element of the collection satisfies the given predicate. - If the input function is predicate and the elements are i0...iN - then computes p i0 or ... or p iN. - The function to test set elements. - The input set. - True if any element of set satisfies predicate. - - - Returns the number of elements in the set. Same as size. - The input set. - The number of elements in the set. - - - Evaluates to "true" if all elements of the second set are in the first, and at least - one element of the first is not in the second. - The potential superset. - The set to test against. - True if set1 is a proper superset of set2. - - - Evaluates to "true" if all elements of the second set are in the first. - The potential superset. - The set to test against. - True if set1 is a superset of set2. - - - Evaluates to "true" if all elements of the first set are in the second, and at least - one element of the second is not in the first. - The potential subset. - The set to test against. - True if set1 is a proper subset of set2. - - - Evaluates to "true" if all elements of the first set are in the second - The potential subset. - The set to test against. - True if set1 is a subset of set2. - - - Evaluates to "true" if the given element is in the given set. - The element to test. - The input set. - True if element is in set. - - - Returns a new set with an element added to the set. No exception is raised if - the set already contains the given element. - The value to add. - The input set. - A new set containing value. - - - The set containing the given element. - The value for the set to contain. - The set containing value. - - - The empty set for the type 'T. - - - Functional programming operators related to the Set<_> type. - - - Gets the default cancellation token for executing asynchronous computations. - The default CancellationToken. - - - Creates an asynchronous computation that returns the CancellationToken governing the execution - of the computation. - In async { let! token = Async.CancellationToken ...} token can be used to initiate other - asynchronous operations that will cancel cooperatively with this workflow. - An asynchronous computation capable of retrieving the CancellationToken from a computation - expression. - - - Creates an asynchronous computation that executes computation. - If this computation is cancelled before it completes then the computation generated by - running compensation is executed. - The input asynchronous computation. - The function to be run if the computation is cancelled. - An asynchronous computation that runs the compensation if the input computation - is cancelled. - - - Creates an asynchronous computation that queues a work item that runs - its continuation. - A computation that generates a new work item in the thread pool. - - - Creates an asynchronous computation that creates a new thread and runs - its continuation in that thread. - A computation that will execute on a new thread. - - - Creates an asynchronous computation that runs - its continuation using syncContext.Post. If syncContext is null - then the asynchronous computation is equivalent to SwitchToThreadPool(). - The synchronization context to accept the posted computation. - An asynchronous computation that uses the syncContext context to execute. - - - Runs an asynchronous computation, starting immediately on the current operating system - thread. Call one of the three continuations when the operation completes. - If no cancellation token is provided then the default cancellation token - is used. - The asynchronous computation to execute. - The function called on success. - The function called on exception. - The function called on cancellation. - The CancellationToken to associate with the computation. - The default is used if this parameter is not provided. - - - Runs an asynchronous computation, starting immediately on the current operating system - thread. - If no cancellation token is provided then the default cancellation token is used. - The asynchronous computation to execute. - The CancellationToken to associate with the computation. - The default is used if this parameter is not provided. - - - Creates an asynchronous computation which starts the given computation as a System.Threading.Tasks.Task - - - Starts a child computation within an asynchronous workflow. - This allows multiple asynchronous computations to be executed simultaneously. - - This method should normally be used as the immediate - right-hand-side of a let! binding in an F# asynchronous workflow, that is, - - async { ... - let! completor1 = childComputation1 |> Async.StartChild - let! completor2 = childComputation2 |> Async.StartChild - ... - let! result1 = completor1 - let! result2 = completor2 - ... } - - When used in this way, each use of StartChild starts an instance of childComputation - and returns a completor object representing a computation to wait for the completion of the operation. - When executed, the completor awaits the completion of childComputation. - The child computation. - The timeout value in milliseconds. If one is not provided - then the default value of -1 corresponding to System.Threading.Timeout.Infinite. - A new computation that waits for the input computation to finish. - - - Executes a computation in the thread pool. - If no cancellation token is provided then the default cancellation token is used. - A System.Threading.Tasks.Task that will be completed - in the corresponding state once the computation terminates (produces the result, throws exception or gets canceled) - - - - Starts the asynchronous computation in the thread pool. Do not await its result. - - If no cancellation token is provided then the default cancellation token is used. - The computation to run asynchronously. - The cancellation token to be associated with the computation. - If one is not supplied, the default cancellation token is used. - - - Creates an asynchronous computation that will sleep for the given time. This is scheduled - using a System.Threading.Timer object. The operation will not block operating system threads - for the duration of the wait. - The number of milliseconds to sleep. - An asynchronous computation that will sleep for the given time. - Thrown when the due time is negative - and not infinite. - - - Runs the asynchronous computation and await its result. - - If an exception occurs in the asynchronous computation then an exception is re-raised by this - function. - - If no cancellation token is provided then the default cancellation token is used. - - The timeout parameter is given in milliseconds. A value of -1 is equivalent to - System.Threading.Timeout.Infinite. - The computation to run. - The amount of time in milliseconds to wait for the result of the - computation before raising a System.TimeoutException. If no value is provided - for timeout then a default of -1 is used to correspond to System.Threading.Timeout.Infinite. - The cancellation token to be associated with the computation. - If one is not supplied, the default cancellation token is used. - The result of the computation. - - - Creates an asynchronous computation that executes all the given asynchronous computations, - initially queueing each as work items and using a fork/join pattern. - - If all child computations succeed, an array of results is passed to the success continuation. - - If any child computation raises an exception, then the overall computation will trigger an - exception, and cancel the others. - - The overall computation will respond to cancellation while executing the child computations. - If cancelled, the computation will cancel any remaining child computations but will still wait - for the other child computations to complete. - A sequence of distinct computations to be parallelized. - A computation that returns an array of values from the sequence of input computations. - - - Generates a scoped, cooperative cancellation handler for use within an asynchronous workflow. - - For example, - async { use! holder = Async.OnCancel interruption ... } - generates an asynchronous computation where, if a cancellation happens any time during - the execution of the asynchronous computation in the scope of holder, then action - interruption is executed on the thread that is performing the cancellation. This can - be used to arrange for a computation to be asynchronously notified that a cancellation - has occurred, e.g. by setting a flag, or deregistering a pending I/O action. - The function that is executed on the thread performing the - cancellation. - An asynchronous computation that triggers the interruption if it is cancelled - before being disposed. - - - Creates an asynchronous computation that runs the given computation and ignores - its result. - The input computation. - A computation that is equivalent to the input computation, but disregards the result. - - - Creates an asynchronous computation that captures the current - success, exception and cancellation continuations. The callback must - eventually call exactly one of the given continuations. - The function that accepts the current success, exception, and cancellation - continuations. - An asynchronous computation that provides the callback with the current continuations. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. This overlaod should be used if the operation is - qualified by three arguments. For example, - Async.FromBeginEnd(arg1,arg2,arg3,ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The first argument for the operation. - The second argument for the operation. - The third argument for the operation. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. This overlaod should be used if the operation is - qualified by two arguments. For example, - Async.FromBeginEnd(arg1,arg2,ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The first argument for the operation. - The second argument for the operation. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. This overlaod should be used if the operation is - qualified by one argument. For example, - Async.FromBeginEnd(place,ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The argument for the operation. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. For example, - Async.FromBeginEnd(ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation that executes computation. - If this computation completes successfully then return Choice1Of2 with the returned - value. If this computation raises an exception before it completes then return Choice2Of2 - with the raised exception. - The input computation that returns the type T. - A computation that returns a choice of type T or exception. - - - Raises the cancellation condition for the most recent set of asynchronous computations started - without any specific CancellationToken. Replaces the global CancellationTokenSource with a new - global token source for any asynchronous computations created after this point without any - specific CancellationToken. - - - Creates an asynchronous computation that will wait on the given WaitHandle. - - The computation returns true if the handle indicated a result within the given timeout. - The WaitHandle that can be signalled. - The timeout value in milliseconds. If one is not provided - then the default value of -1 corresponding to System.Threading.Timeout.Infinite. - An asynchronous computation that waits on the given WaitHandle. - - - - Return an asynchronous computation that will wait for the given task to complete and return - its result. - - - - - Return an asynchronous computation that will wait for the given task to complete and return - its result. - - - - Creates an asynchronous computation that will wait on the IAsyncResult. - - The computation returns true if the handle indicated a result within the given timeout. - The IAsyncResult to wait on. - The timeout value in milliseconds. If one is not provided - then the default value of -1 corresponding to System.Threading.Timeout.Infinite. - An asynchronous computation that waits on the given IAsyncResult. - - - Creates an asynchronous computation that waits for a single invocation of a CLI - event by adding a handler to the event. Once the computation completes or is - cancelled, the handler is removed from the event. - - The computation will respond to cancellation while waiting for the event. If a - cancellation occurs, and cancelAction is specified, then it is executed, and - the computation continues to wait for the event. - - If cancelAction is not specified, then cancellation causes the computation - to cancel immediately. - The event to handle once. - An optional function to execute instead of cancelling when a - cancellation is issued. - An asynchronous computation that waits for the event to be invoked. - - - Creates three functions that can be used to implement the .NET Asynchronous - Programming Model (APM) for a given asynchronous computation. - - The functions should normally be published as members with prefix Begin, - End and Cancel, and can be used within a type definition as follows: - - let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun arg -> computation) - member x.BeginSomeOperation(arg,callback,state:obj) = beginAction(arg,callback,state) - member x.EndSomeOperation(iar) = endAction(iar) - member x.CancelSomeOperation(iar) = cancelAction(iar) - - - If the asynchronous computation takes no arguments, then AsBeginEnd is used as follows: - - let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun () -> computation) - member x.BeginSomeOperation(callback,state:obj) = beginAction((),callback,state) - member x.EndSomeOperation(iar) = endAction(iar) - member x.CancelSomeOperation(iar) = cancelAction(iar) - - - - If the asynchronous computation takes two arguments, then AsBeginEnd is used as follows: - - let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun arg1 arg2 -> computation) - member x.BeginSomeOperation(arg1,arg2,callback,state:obj) = beginAction((),callback,state) - member x.EndSomeOperation(iar) = endAction(iar) - member x.CancelSomeOperation(iar) = cancelAction(iar) - - - In each case, the resulting API will be familiar to programmers in other CLI languages and - is a useful way to publish asynchronous computations in CLI components. - A function generating the asynchronous computation to split into the traditional - .NET Asynchronous Programming Model. - A tuple of the begin, end, and cancel members. - - - This static class holds members for creating and manipulating asynchronous computations. - - - Creates an asynchronous computation that just returns (). - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of empty else branches in the - async { ... } computation expression syntax. - An asynchronous computation that returns (). - - - Creates an asynchronous computation that runs computation repeatedly - until guard() becomes false. - - A cancellation check is performed whenever the computation is executed. - - The existence of this method permits the use of while in the - async { ... } computation expression syntax. - The function to determine when to stop executing computation. - The function to be executed. Equivalent to the body - of a while expression. - An asynchronous computation that behaves similarly to a while loop when run. - - - Creates an asynchronous computation that runs binder(resource). - The action resource.Dispose() is executed as this computation yields its result - or if the asynchronous computation exits by an exception or by cancellation. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of use and use! in the - async { ... } computation expression syntax. - The resource to be used and disposed. - The function that takes the resource and returns an asynchronous - computation. - An asynchronous computation that binds and eventually disposes resource. - - - Creates an asynchronous computation that runs computation and returns its result. - If an exception happens then catchHandler(exn) is called and the resulting computation executed instead. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of try/with in the - async { ... } computation expression syntax. - The input computation. - The function to run when computation throws an exception. - An asynchronous computation that executes computation and calls catchHandler if an - exception is thrown. - - - Creates an asynchronous computation that runs computation. The action compensation is executed - after computation completes, whether computation exits normally or by an exception. If compensation raises an exception itself - the original exception is discarded and the new exception becomes the overall result of the computation. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of try/finally in the - async { ... } computation expression syntax. - The input computation. - The action to be run after computation completes or raises an - exception (including cancellation). - An asynchronous computation that executes computation and compensation aftewards or - when an exception is raised. - - - Delegates to the input computation. - - The existence of this method permits the use of return! in the - async { ... } computation expression syntax. - The input computation. - The input computation. - - - Creates an asynchronous computation that returns the result v. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of return in the - async { ... } computation expression syntax. - The value to return from the computation. - An asynchronous computation that returns value when executed. - - - Creates an asynchronous computation that enumerates the sequence seq - on demand and runs body for each element. - - A cancellation check is performed on each iteration of the loop. - - The existence of this method permits the use of for in the - async { ... } computation expression syntax. - The sequence to enumerate. - A function to take an item from the sequence and create - an asynchronous computation. Can be seen as the body of the for expression. - An asynchronous computation that will enumerate the sequence and run body - for each element. - - - Creates an asynchronous computation that runs generator. - - A cancellation check is performed when the computation is executed. - The function to run. - An asynchronous computation that runs generator. - - - Creates an asynchronous computation that first runs computation1 - and then runs computation2, returning the result of computation2. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of expression sequencing in the - async { ... } computation expression syntax. - The first part of the sequenced computation. - The second part of the sequenced computation. - An asynchronous computation that runs both of the computations sequentially. - - - Creates an asynchronous computation that runs computation, and when - computation generates a result T, runs binder res. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of let! in the - async { ... } computation expression syntax. - The computation to provide an unbound result. - The function to bind the result of computation. - An asynchronous computation that performs a monadic bind on the result - of computation. - - - - Generate an object used to build asynchronous computations using F# computation expressions. The value - 'async' is a pre-defined instance of this type. - - A cancellation check is performed when the computation is executed. - - - - The type of the async operator, used to build workflows for asynchronous computations. - - - Sends a reply to a PostAndReply message. - The value to send. - - - A handle to a capability to reply to a PostAndReply message. - - - A compositional asynchronous computation, which, when run, will eventually produce a value - of type T, or else raises an exception. - - Asynchronous computations are normally specified using an F# computation expression. - - When run, asynchronous computations have two modes: as a work item (executing synchronous - code), or as a wait item (waiting for an event or I/O completion). - - When run, asynchronous computations can be governed by CancellationToken. This can usually - be specified when the async computation is started. The associated CancellationTokenSource - may be used to cancel the asynchronous computation. Asynchronous computations built using - computation expressions can check the cancellation condition regularly. Synchronous - computations within an asynchronous computation do not automatically check this condition. - - - Publishes the event as a first class event value. - - - Triggers the event using the given parameters. - The parameters for the event. - - - Creates an event object suitable for implementing an arbitrary type of delegate. - The event object. - - - Event implementations for an arbitrary type of delegate. - - - Publishes an observation as a first class value. - - - Triggers an observation using the given parameters. - The event parameters. - - - Creates an observable object. - The created event. - - - Event implementations for the IEvent<_> type. - - - Publishes the event as a first class event value. - - - Triggers the event using the given sender object and parameters. The sender object may be null. - The object triggering the event. - The parameters for the event. - - - Creates an event object suitable for delegate types following the standard .NET Framework convention of a first 'sender' argument. - The created event. - - - Event implementations for a delegate types following the standard .NET Framework convention of a first 'sender' argument. - - - A delegate type associated with the F# event type IEvent<_> - The object that fired the event. - The event arguments. - - - Remove a listener delegate from an event listener store. - The delegate to be removed from the event listener store. - - - Connect a handler delegate object to the event. A handler can - be later removed using RemoveHandler. The listener will - be invoked when the event is fired. - A delegate to be invoked when the event is fired. - - - First class event values for arbitrary delegate types. - - F# gives special status to member properties compatible with type IDelegateEvent and - tagged with the CLIEventAttribute. In this case the F# compiler generates approriate - CLI metadata to make the member appear to other CLI languages as a CLI event. - - - First-class listening points (i.e. objects that permit you to register a callback - activated when the event is triggered). - - - First class event values for CLI events conforming to CLI Framework standards. - - - The type of delayed computations. - - Use the values in the Lazy module to manipulate - values of this type, and the notation lazy expr to create values - of type . - - - Raises a timeout exception if a message not received in this amount of time. By default - no timeout is used. - - - Occurs when the execution of the agent results in an exception. - - - Occurs when the execution of the agent results in an exception. - - - Raises a timeout exception if a message not received in this amount of time. By default - no timeout is used. - - - Returns the number of unprocessed messages in the message queue of the agent. - - - Occurs when the execution of the agent results in an exception. - - - Scans for a message by looking through messages in arrival order until scanner - returns a Some value. Other messages remain in the queue. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - The function to return None if the message is to be skipped - or Some if the message is to be processed and removed from the queue. - An optional timeout in milliseconds. Defaults to -1 which corresponds - to System.Threading.Timeout.Infinite. - An asynchronous computation that scanner built off the read message. - - - Waits for a message. This will consume the first message in arrival order. - - This method is for use within the body of the agent. - - Returns None if a timeout is given and the timeout is exceeded. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - An optional timeout in milliseconds. Defaults to -1 which - corresponds to System.Threading.Timeout.Infinite. - An asynchronous computation that returns the received message or - None if the timeout is exceeded. - - - Like PostAndReply, but returns None if no reply within the timeout period. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - The reply from the agent or None if the timeout expires. - - - Starts the agent. - - - Creates and starts an agent. The body function is used to generate the asynchronous - computation executed by the agent. - The function to produce an asynchronous computation that will be executed - as the read loop for the MailboxProcessor when Start is called. - An optional cancellation token for the body. - Defaults to Async.DefaultCancellationToken. - The created MailboxProcessor. - - - Scans for a message by looking through messages in arrival order until scanner - returns a Some value. Other messages remain in the queue. - - Returns None if a timeout is given and the timeout is exceeded. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - The function to return None if the message is to be skipped - or Some if the message is to be processed and removed from the queue. - An optional timeout in milliseconds. Defaults to -1 which corresponds - to System.Threading.Timeout.Infinite. - An asynchronous computation that scanner built off the read message. - Thrown when the timeout is exceeded. - - - Waits for a message. This will consume the first message in arrival order. - - This method is for use within the body of the agent. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - An optional timeout in milliseconds. Defaults to -1 which corresponds - to System.Threading.Timeout.Infinite. - An asynchronous computation that returns the received message. - Thrown when the timeout is exceeded. - - - Like AsyncPostAndReply, but returns None if no reply within the timeout period. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - An asynchronous computation that will return the reply or None if the timeout expires. - - - Posts a message to an agent and await a reply on the channel, synchronously. - - The message is generated by applying buildMessage to a new reply channel - to be incorporated into the message. The receiving agent must process this - message and invoke the Reply method on this reply channel precisely once. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - The reply from the agent. - - - Posts a message to an agent and await a reply on the channel, asynchronously. - - The message is generated by applying buildMessage to a new reply channel - to be incorporated into the message. The receiving agent must process this - message and invoke the Reply method on this reply channel precisely once. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - An asychronous computation that will wait for the reply from the agent. - - - Posts a message to the message queue of the MailboxProcessor, asynchronously. - The message to post. - - - Creates an agent. The body function is used to generate the asynchronous - computation executed by the agent. This function is not executed until - Start is called. - The function to produce an asynchronous computation that will be executed - as the read loop for the MailboxProcessor when Start is called. - An optional cancellation token for the body. - Defaults to Async.DefaultCancellationToken. - The created MailboxProcessor. - - - A message-processing agent which executes an asynchronous computation. - - The agent encapsulates a message queue that supports multiple-writers and - a single reader agent. Writers send messages to the agent by using the Post - method and its variations. - - The agent may wait for messages using the Receive or TryReceive methods or - scan through all available messages using the Scan or TryScan method. - - - Connects a listener function to the observable. The listener will - be invoked for each observation. The listener can be removed by - calling Dispose on the returned IDisposable object. - The function to be called for each observation. - An object that will remove the listener if disposed. - - - Permanently connects a listener function to the observable. The listener will - be invoked for each observation. - The function to be called for each observation. - - - Returns an asynchronous computation that will write the given bytes to the stream. - The buffer to write from. - An optional offset as a number of bytes in the stream. - An optional number of bytes to write to the stream. - An asynchronous computation that will write the given bytes to the stream. - Thrown when the sum of offset and count is longer than - the buffer length. - Thrown when offset or count is negative. - - - Returns an asynchronous computation that will read the given number of bytes from the stream. - The number of bytes to read. - An asynchronous computation that returns the read byte[] when run. - - - Returns an asynchronous computation that will read from the stream into the given buffer. - The buffer to read into. - An optional offset as a number of bytes in the stream. - An optional number of bytes to read from the stream. - An asynchronous computation that will read from the stream into the given buffer. - Thrown when the sum of offset and count is longer than - the buffer length. - Thrown when offset or count is negative. - - - A module of extension members providing asynchronous operations for some basic CLI types related to concurrency and I/O. - - - Returns a new event that triggers on the second and subsequent triggerings of the input event. - The Nth triggering of the input event passes the arguments from the N-1th and Nth triggering as - a pair. The argument passed to the N-1th triggering is held in hidden internal state until the - Nth triggering occurs. - The input event. - An event that triggers on pairs of consecutive values passed from the source event. - - - Runs the given function each time the given event is triggered. - The function to call when the event is triggered. - The input event. - - - Returns a new event consisting of the results of applying the given accumulating function - to successive values triggered on the input event. An item of internal state - records the current value of the state parameter. The internal state is not locked during the - execution of the accumulation function, so care should be taken that the - input IEvent not triggered by multiple threads simultaneously. - The function to update the state with each event value. - The initial state. - The input event. - An event that fires on the updated state values. - - - Returns a new event which fires on a selection of messages from the original event. - The selection function takes an original message to an optional new message. - The function to select and transform event values to pass on. - The input event. - An event that fires only when the chooser returns Some. - - - Returns a new event that listens to the original event and triggers the - first resulting event if the application of the function to the event arguments - returned a Choice1Of2, and the second event if it returns a Choice2Of2. - The function to transform event values into one of two types. - The input event. - A tuple of events. The first fires whenever splitter evaluates to Choice1of1 and - the second fires whenever splitter evaluates to Choice2of2. - - - Returns a new event that listens to the original event and triggers the - first resulting event if the application of the predicate to the event arguments - returned true, and the second event if it returned false. - The function to determine which output event to trigger. - The input event. - A tuple of events. The first is triggered when the predicate evaluates to true - and the second when the predicate evaluates to false. - - - Returns a new event that listens to the original event and triggers the resulting - event only when the argument to the event passes the given function. - The function to determine which triggers from the event to propagate. - The input event. - An event that only passes values that pass the predicate. - - - Returns a new event that passes values transformed by the given function. - The function to transform event values. - The input event. - An event that passes the transformed values. - - - Fires the output event when either of the input events fire. - The first input event. - The second input event. - An event that fires when either of the input events fire. - - - Forces the execution of this value and return its result. Same as Value. Mutual exclusion is used to - prevent other threads also computing the value. - The value of the Lazy object. - - - Creates a lazy computation that evaluates to the given value when forced. - The input value. - The created Lazy object. - - - Creates a lazy computation that evaluates to the result of the given function when forced. - The function to provide the value when needed. - The created Lazy object. - - - Extensions related to Lazy values. - - - Returns a new observable that triggers on the second and subsequent triggerings of the input observable. - The Nth triggering of the input observable passes the arguments from the N-1th and Nth triggering as - a pair. The argument passed to the N-1th triggering is held in hidden internal state until the - Nth triggering occurs. - - For each observer, the registered intermediate observing object is not thread safe. - That is, observations arising from the source must not be triggered concurrently - on different threads. - The input Observable. - An Observable that triggers on successive pairs of observations from the input Observable. - - - Creates an observer which subscribes to the given observable and which calls - the given function for each observation. - The function to be called on each observation. - The input Observable. - An object that will remove the callback if disposed. - - - Creates an observer which permanently subscribes to the given observable and which calls - the given function for each observation. - The function to be called on each observation. - The input Observable. - - - Returns an observable which, for each observer, allocates an item of state - and applies the given accumulating function to successive values arising from - the input. The returned object will trigger observations for each computed - state value, excluding the initial value. The returned object propagates - all errors arising from the source and completes when the source completes. - - For each observer, the registered intermediate observing object is not thread safe. - That is, observations arising from the source must not be triggered concurrently - on different threads. - The function to update the state with each observation. - The initial state. - The input Observable. - An Observable that triggers on the updated state values. - - - Returns an observable which chooses a projection of observations from the source - using the given function. The returned object will trigger observations x - for which the splitter returns Some x. The returned object also propagates - all errors arising from the source and completes when the source completes. - The function that returns Some for observations to be propagated - and None for observations to ignore. - The input Observable. - An Observable that only propagates some of the observations from the source. - - - Returns two observables which split the observations of the source by the - given function. The first will trigger observations x for which the - splitter returns Choice1Of2 x. The second will trigger observations - y for which the splitter returns Choice2Of2 y The splitter is - executed once for each subscribed observer. Both also propagate error - observations arising from the source and each completes when the source - completes. - The function that takes an observation an transforms - it into one of the two output Choice types. - The input Observable. - A tuple of Observables. The first triggers when splitter returns Choice1of2 - and the second triggers when splitter returns Choice2of2. - - - Returns two observables which partition the observations of the source by - the given function. The first will trigger observations for those values - for which the predicate returns true. The second will trigger observations - for those values where the predicate returns false. The predicate is - executed once for each subscribed observer. Both also propagate all error - observations arising from the source and each completes when the source - completes. - The function to determine which output Observable will trigger - a particular observation. - The input Observable. - A tuple of Observables. The first triggers when the predicate returns true, and - the second triggers when the predicate returns false. - - - Returns an observable which filters the observations of the source - by the given function. The observable will see only those observations - for which the predicate returns true. The predicate is executed once for - each subscribed observer. The returned object also propagates error - observations arising from the source and completes when the source completes. - The function to apply to observations to determine if it should - be kept. - The input Observable. - An Observable that filters observations based on filter. - - - Returns an observable which transforms the observations of the source by the - given function. The transformation function is executed once for each - subscribed observer. The returned object also propagates error observations - arising from the source and completes when the source completes. - The function applied to observations from the source. - The input Observable. - An Observable of the type specified by mapping. - - - Returns an observable for the merged observations from the sources. - The returned object propagates success and error values arising - from either source and completes when both the sources have completed. - - For each observer, the registered intermediate observing object is not - thread safe. That is, observations arising from the sources must not - be triggered concurrently on different threads. - The first Observable. - The second Observable. - An Observable that propagates information from both sources. - - - Basic operations on first class event and other observable objects. - - - Returns an asynchronous computation that, when run, will wait for the download of the given URI to specified file. - The URI to retrieve. - The filename to save download to. - An asynchronous computation that will wait for the download of the URI to specified file. - - - Returns an asynchronous computation that, when run, will wait for the download of the given URI. - The URI to retrieve. - An asynchronous computation that will wait for the download of the URI. - - - Returns an asynchronous computation that, when run, will wait for the download of the given URI. - The URI to retrieve. - An asynchronous computation that will wait for the download of the URI. - - - Returns an asynchronous computation that, when run, will wait for a response to the given WebRequest. - An asynchronous computation that waits for response to the WebRequest. - - - A module of extension members providing asynchronous operations for some basic Web operations. - - - Creates an instance of the attribute - AbstractClassAttribute - - - Adding this attribute to class definition makes it abstract, which means it need not - implement all its methods. Instances of abstract classes may not be constructed directly. - - - The value of the attribute, indicating whether the type allows the null literal or not - - - Creates an instance of the attribute with the specified value - AllowNullLiteralAttribute - - - Creates an instance of the attribute - AllowNullLiteralAttribute - - - Adding this attribute to a type lets the 'null' literal be used for the type - within F# code. This attribute may only be added to F#-defined class or - interface types. - - - Indicates the namespace or module to be automatically opened when an assembly is referenced - or an enclosing module opened. - - - Creates an attribute used to mark a namespace or module path to be 'automatically opened' when an assembly is referenced - The namespace or module to be automatically opened when an assembly is referenced - or an enclosing module opened. - AutoOpenAttribute - - - Creates an attribute used to mark a module as 'automatically opened' when the enclosing namespace is opened - AutoOpenAttribute - - - This attribute is used for two purposes. When applied to an assembly, it must be given a string - argument, and this argument must indicate a valid module or namespace in that assembly. Source - code files compiled with a reference to this assembly are processed in an environment - where the given path is automatically opened. - - When applied to a module within an assembly, then the attribute must not be given any arguments. - When the enclosing namespace is opened in user source code, the module is also implicitly opened. - - - The value of the attribute, indicating whether the type is automatically marked serializable or not - - - Creates an instance of the attribute - Indicates whether the type should be serializable by default. - AutoSerializableAttribute - - - Adding this attribute to a type with value 'false' disables the behaviour where F# makes the - type Serializable by default. - - - Creates an instance of the attribute - CLIEventAttribute - - - Adding this attribute to a property with event type causes it to be compiled with as a CLI - metadata event, through a syntactic translation to a pair of 'add_EventName' and - 'remove_EventName' methods. - - - Creates an instance of the attribute - CLIMutableAttribute - - - Adding this attribute to a record type causes it to be compiled to a CLI representation - with a default constructor with property getters and setters. - - - Choice 2 of 2 choices - - - Choice 1 of 2 choices - - - Helper types for active patterns with 2 choices. - - - Choice 3 of 3 choices - - - Choice 2 of 3 choices - - - Choice 1 of 3 choices - - - Helper types for active patterns with 3 choices. - - - Choice 4 of 4 choices - - - Choice 3 of 4 choices - - - Choice 2 of 4 choices - - - Choice 1 of 4 choices - - - Helper types for active patterns with 4 choices. - - - Choice 5 of 5 choices - - - Choice 4 of 5 choices - - - Choice 3 of 5 choices - - - Choice 2 of 5 choices - - - Choice 1 of 5 choices - - - Helper types for active patterns with 5 choices. - - - Choice 6 of 6 choices - - - Choice 5 of 6 choices - - - Choice 4 of 6 choices - - - Choice 3 of 6 choices - - - Choice 2 of 6 choices - - - Choice 1 of 6 choices - - - Helper types for active patterns with 6 choices. - - - Choice 7 of 7 choices - - - Choice 6 of 7 choices - - - Choice 5 of 7 choices - - - Choice 4 of 7 choices - - - Choice 3 of 7 choices - - - Choice 2 of 7 choices - - - Choice 1 of 7 choices - - - Helper types for active patterns with 7 choices. - - - Creates an instance of the attribute - ClassAttribute - - - Adding this attribute to a type causes it to be represented using a CLI class. - - - Creates an instance of the attribute - ComparisonConditionalOnAttribute - - - This attribute is used to indicate a generic container type satisfies the F# 'comparison' - constraint only if a generic argument also satisfies this constraint. For example, adding - this attribute to parameter 'T on a type definition C<'T> means that a type C<X> only supports - comparison if the type X also supports comparison and all other conditions for C<X> to support - comparison are also met. The type C<'T> can still be used with other type arguments, but a type such - as C<(int -> int)> will not support comparison because the type (int -> int) is an F# function type - and does not support comparison. - - This attribute will be ignored if it is used on the generic parameters of functions or methods. - - - Indicates the number of arguments in each argument group - - - Creates an instance of the attribute - Indicates the number of arguments in each argument group. - CompilationArgumentCountsAttribute - - - This attribute is generated automatically by the F# compiler to tag functions and members - that accept a partial application of some of their arguments and return a residual function - - - Indicates the variant number of the entity, if any, in a linear sequence of elements with F# source code - - - Indicates the type definitions needed to resolve the source construct - - - Indicates the relationship between the compiled entity and F# source code - - - Indicates the sequence number of the entity, if any, in a linear sequence of elements with F# source code - - - Indicates the resource the source construct relates to - - - Creates an instance of the attribute - Indicates the type definitions needed to resolve the source construct. - CompilationMappingAttribute - - - Creates an instance of the attribute - Indicates the type of source construct. - CompilationMappingAttribute - - - Creates an instance of the attribute - Indicates the type of source construct. - CompilationMappingAttribute - - - Creates an instance of the attribute - Indicates the type of source construct. - CompilationMappingAttribute - - - This attribute is inserted automatically by the F# compiler to tag types - and methods in the generated CLI code with flags indicating the correspondence - with original source constructs. It is used by the functions in the - Microsoft.FSharp.Reflection namespace to reverse-map compiled constructs to - their original forms. It is not intended for use from user code. - - - Indicates one or more adjustments to the compiled representation of an F# type or member - - - Creates an instance of the attribute - Indicates adjustments to the compiled representation of the type or member. - CompilationRepresentationAttribute - - - This attribute is used to adjust the runtime representation for a type. - For example, it may be used to note that the null representation - may be used for a type. This affects how some constructs are compiled. - - - Compile a property as a CLI event. - - - Permit the use of null as a representation for nullary discriminators in a discriminated union. - - - append 'Module' to the end of a module whose name clashes with a type name in the same namespace. - - - Compile a member as 'instance' even if null is used as a representation for this type. - - - Compile an instance member as 'static' . - - - No special compilation representation. - - - Indicates one or more adjustments to the compiled representation of an F# type or member. - - - Indicates the name of the entity in F# source code - - - Creates an instance of the attribute - The name of the method in source. - CompilationSourceNameAttribute - - - This attribute is inserted automatically by the F# compiler to tag - methods which are given the 'CompiledName' attribute. It is not intended - for use from user code. - - - The name of the value as it appears in compiled code - - - Creates an instance of the attribute - The name to use in compiled code. - CompiledNameAttribute - - - Adding this attribute to a value or function definition in an F# module changes the name used - for the value in compiled CLI code. - - - Indicates if the construct should always be hidden in an editing environment. - - - Indicates if the message should indicate a compiler error. Error numbers less than - 10000 are considered reserved for use by the F# compiler and libraries. - - - Indicates the number associated with the message. - - - Indicates the warning message to be emitted when F# source code uses this construct - - - Indicates if the construct should always be hidden in an editing environment. - - - Indicates if the message should indicate a compiler error. Error numbers less than - 10000 are considered reserved for use by the F# compiler and libraries. - - - Creates an instance of the attribute. - - - Indicates that a message should be emitted when F# source code uses this construct. - - - Creates an instance of the attribute - CustomComparisonAttribute - - - Adding this attribute to a type indicates it is a type with a user-defined implementation of comparison. - - - Creates an instance of the attribute - CustomEqualityAttribute - - - Adding this attribute to a type indicates it is a type with a user-defined implementation of equality. - - - Indicates if the custom operation maintains the variable space of the query of computation expression through the use of a bind operation - - - Indicates if the custom operation maintains the variable space of the query of computation expression - - - Indicates the name used for the 'on' part of the custom query operator for join-like operators - - - Indicates if the custom operation is an operation similar to a zip in a sequence computation, supporting two inputs - - - Indicates if the custom operation is an operation similar to a join in a sequence computation, supporting two inputs and a correlation constraint - - - Indicates if the custom operation is an operation similar to a group join in a sequence computation, supporting two inputs and a correlation constraint, and generating a group - - - Indicates if the custom operation supports the use of 'into' immediately after the use of the operation in a query or other computation expression to consume the results of the operation - - - Get the name of the custom operation when used in a query or other computation expression - - - Indicates if the custom operation maintains the variable space of the query of computation expression through the use of a bind operation - - - Indicates if the custom operation maintains the variable space of the query of computation expression - - - Indicates the name used for the 'on' part of the custom query operator for join-like operators - - - Indicates if the custom operation is an operation similar to a zip in a sequence computation, supporting two inputs - - - Indicates if the custom operation is an operation similar to a join in a sequence computation, supporting two inputs and a correlation constraint - - - Indicates if the custom operation is an operation similar to a group join in a sequence computation, supporting two inputs and a correlation constraint, and generating a group - - - Indicates if the custom operation supports the use of 'into' immediately after the use of the operation in a query or other computation expression to consume the results of the operation - - - Creates an instance of the attribute - CustomOperationAttribute - - - - Indicates that a member on a computation builder type is a custom query operator, - and indicates the name of that operator. - - - - The value of the attribute, indicating whether the type has a default augmentation or not - - - Creates an instance of the attribute - Indicates whether to generate helper members on the CLI class representing a discriminated - union. - DefaultAugmentationAttribute - - - Adding this attribute to a discriminated union with value false - turns off the generation of standard helper member tester, constructor - and accessor members for the generated CLI class for that type. - - - Indicates if a constraint is asserted that the field type supports 'null' - - - Creates an instance of the attribute - Indicates whether to assert that the field type supports null. - DefaultValueAttribute - - - Creates an instance of the attribute - DefaultValueAttribute - - - Adding this attribute to a field declaration means that the field is - not initialized. During type checking a constraint is asserted that the field type supports 'null'. - If the 'check' value is false then the constraint is not asserted. - - - Creates an instance of the attribute - EntryPointAttribute - - - Adding this attribute to a function indicates it is the entrypoint for an application. - If this attribute is not specified for an EXE then the initialization implicit in the - module bindings in the last file in the compilation sequence are used as the entrypoint. - - - Creates an instance of the attribute - EqualityConditionalOnAttribute - - - This attribute is used to indicate a generic container type satisfies the F# 'equality' - constraint only if a generic argument also satisfies this constraint. For example, adding - this attribute to parameter 'T on a type definition C<'T> means that a type C<X> only supports - equality if the type X also supports equality and all other conditions for C<X> to support - equality are also met. The type C<'T> can still be used with other type arguments, but a type such - as C<(int -> int)> will not support equality because the type (int -> int) is an F# function type - and does not support equality. - - This attribute will be ignored if it is used on the generic parameters of functions or methods. - - - Indicates the warning message to be emitted when F# source code uses this construct - - - Creates an instance of the attribute - The warning message to be emitted when code uses this construct. - ExperimentalAttribute - - - This attribute is used to tag values that are part of an experimental library - feature. - - - Convert an value of type System.Converter to a F# first class function value - The input System.Converter. - An F# function of the same type. - - - Convert an F# first class function value to a value of type System.Converter - The input function. - A System.Converter of the function type. - - - Convert an F# first class function value to a value of type System.Converter - The input function. - System.Converter<'T,'U> - - - Invoke an F# first class function value with two curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The function result. - - - Invoke an F# first class function value with three curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The third arg. - The function result. - - - Invoke an F# first class function value with four curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The third arg. - The fourth arg. - The function result. - - - Invoke an F# first class function value with five curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The third arg. - The fourth arg. - The fifth arg. - The function result. - - - Invoke an F# first class function value with one argument - - 'U - - - Convert an value of type System.Converter to a F# first class function value - The input System.Converter. - An F# function of the same type. - - - Construct an instance of an F# first class function value - The created F# function. - - - The CLI type used to represent F# function values. This type is not - typically used directly, though may be used from other CLI languages. - - - The release number of the F# version associated with the attribute - - - The minor version number of the F# version associated with the attribute - - - The major version number of the F# version associated with the attribute - - - Creates an instance of the attribute - The major version number. - The minor version number. - The release number. - FSharpInterfaceDataVersionAttribute - - - This attribute is added to generated assemblies to indicate the - version of the data schema used to encode additional F# - specific information in the resource attached to compiled F# libraries. - - - Specialize the type function at a given type - The specialized type. - - - Construct an instance of an F# first class type function value - FSharpTypeFunc - - - The CLI type used to represent F# first-class type function values. This type is for use - by compiled F# code. - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - Tuple of values generated by scan or match. - - - Convert the given Converter delegate object to an F# function value - The input Converter. - The F# function. - - - Convert the given Action delegate object to an F# function value - The input action. - The F# function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - Helper functions for converting F# first class function values to and from CLI representaions - of functions using delegates. - - - Creates an instance of the attribute - GeneralizableValueAttribute - - - Adding this attribute to a non-function value with generic parameters indicates that - uses of the construct can give rise to generic code through type inference. - - - Creates an instance of the attribute - InterfaceAttribute - - - Adding this attribute to a type causes it to be represented using a CLI interface. - - - Creates an instance of the attribute - LiteralAttribute - - - Adding this attribute to a value causes it to be compiled as a CLI constant literal. - - - Creates an instance of the attribute - MeasureAnnotatedAbbreviationAttribute - - - Adding this attribute to a type causes it to be interpreted as a refined type, currently limited to measure-parameterized types. - This may only be used under very limited conditions. - - - Creates an instance of the attribute - MeasureAttribute - - - Adding this attribute to a type causes it to be interpreted as a unit of measure. - This may only be used under very limited conditions. - - - Creates an instance of the attribute - NoComparisonAttribute - - - Adding this attribute to a type indicates it is a type where comparison is an abnormal operation. - This means that the type does not satisfy the F# 'comparison' constraint. Within the bounds of the - F# type system, this helps ensure that the F# generic comparison function is not instantiated directly - at this type. The attribute and checking does not constrain the use of comparison with base or child - types of this type. - - - Creates an instance of the attribute - NoDynamicInvocationAttribute - - - This attribute is used to tag values that may not be dynamically invoked at runtime. This is - typically added to inlined functions whose implementations include unverifiable code. It - causes the method body emitted for the inlined function to raise an exception if - dynamically invoked, rather than including the unverifiable code in the generated - assembly. - - - Creates an instance of the attribute - NoEqualityAttribute - - - Adding this attribute to a type indicates it is a type where equality is an abnormal operation. - This means that the type does not satisfy the F# 'equality' constraint. Within the bounds of the - F# type system, this helps ensure that the F# generic equality function is not instantiated directly - at this type. The attribute and checking does not constrain the use of comparison with base or child - types of this type. - - - The representation of "Value of type 'T" - The input value. - An option representing the value. - - - The representation of "No value" - - - Get the value of a 'Some' option. A NullReferenceException is raised if the option is 'None'. - - - Create an option value that is a 'None' value. - - - Return 'true' if the option is a 'Some' value. - - - Return 'true' if the option is a 'None' value. - - - Create an option value that is a 'Some' value. - The input value - An option representing the value. - - - The type of optional values. When used from other CLI languages the - empty option is the null value. - - Use the constructors Some and None to create values of this type. - Use the values in the Option module to manipulate values of this type, - or pattern match against the values directly. - - None values will appear as the value null to other CLI languages. - Instance methods on this type will appear as static methods to other CLI languages - due to the use of null as a value representation. - - - Creates an instance of the attribute - OptionalArgumentAttribute - - - This attribute is added automatically for all optional arguments. - - - The raw text of the format string. - - - Construct a format string - The input string. - The PrintfFormat containing the formatted result. - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - - - Construct a format string - The input string. - The created format string. - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - Tuple of values generated by scan or match. - - - Creates an instance of the attribute - ProjectionParameterAttribute - - - Indicates that, when a custom operator is used in a computation expression, - a parameter is automatically parameterized by the variable space of the computation expression - - - - The current value of the reference cell - - - - The current value of the reference cell - - - The current value of the reference cell - - - The type of mutable references. Use the functions [:=] and [!] to get and - set values of this type. - - - Creates an instance of the attribute - ReferenceEqualityAttribute - - - Adding this attribute to a record or union type disables the automatic generation - of overrides for 'System.Object.Equals(obj)', 'System.Object.GetHashCode()' - and 'System.IComparable' for the type. The type will by default use reference equality. - - - The value of the attribute, indicating whether to include the evaluated value of the definition as the outer node of the quotation - - - Creates an instance of the attribute - Indicates whether to include the evaluated value of the definition as the outer node of the quotation - ReflectedDefinitionAttribute - - - Creates an instance of the attribute - ReflectedDefinitionAttribute - - - Adding this attribute to the let-binding for the definition of a top-level - value makes the quotation expression that implements the value available - for use at runtime. - - - Creates an instance of the attribute - RequireQualifiedAccessAttribute - - - This attribute is used to indicate that references to the elements of a module, record or union - type require explicit qualified access. - - - Creates an instance of the attribute - RequiresExplicitTypeArgumentsAttribute - - - Adding this attribute to a type, value or member requires that - uses of the construct must explicitly instantiate any generic type parameters. - - - The value of the attribute, indicating whether the type is sealed or not. - - - Creates an instance of the attribute - Indicates whether the class is sealed. - SealedAttribute - - - Creates an instance of the attribute. - The created attribute. - - - Adding this attribute to class definition makes it sealed, which means it may not - be extended or implemented. - - - Indicates that the compiled entity had private or internal representation in F# source code. - - - The mask of values related to the kind of the compiled entity. - - - Indicates that the compiled entity is part of the representation of an F# value declaration. - - - Indicates that the compiled entity is part of the representation of an F# union case declaration. - - - Indicates that the compiled entity is part of the representation of an F# module declaration. - - - Indicates that the compiled entity is part of the representation of an F# closure. - - - Indicates that the compiled entity is part of the representation of an F# exception declaration. - - - Indicates that the compiled entity is part of the representation of an F# record or union case field declaration. - - - Indicates that the compiled entity is part of the representation of an F# class or other object type declaration. - - - Indicates that the compiled entity is part of the representation of an F# record type declaration. - - - Indicates that the compiled entity is part of the representation of an F# union type declaration. - - - Indicates that the compiled entity has no relationship to an element in F# source code. - - - Indicates the relationship between a compiled entity in a CLI binary and an element in F# source code. - - - Creates an instance of the attribute - StructAttribute - - - Adding this attribute to a type causes it to be represented using a CLI struct. - - - Creates an instance of the attribute - StructuralComparisonAttribute - - - Adding this attribute to a record, union, exception, or struct type confirms the - automatic generation of implementations for 'System.IComparable' for the type. - - - Creates an instance of the attribute - StructuralEqualityAttribute - - - Adding this attribute to a record, union or struct type confirms the automatic - generation of overrides for 'System.Object.Equals(obj)' and - 'System.Object.GetHashCode()' for the type. - - - Indicates the text to display by default when objects of this type are displayed - using '%A' printf formatting patterns and other two-dimensional text-based display - layouts. - - - Creates an instance of the attribute - Indicates the text to display when using the '%A' printf formatting. - StructuredFormatDisplayAttribute - - - This attribute is used to mark how a type is displayed by default when using - '%A' printf formatting patterns and other two-dimensional text-based display layouts. - In this version of F# valid values are of the form PreText {PropertyName1} PostText {PropertyName2} ... {PropertyNameX} PostText. - The property names indicate properties to evaluate and to display instead of the object itself. - - - The type 'unit', which has only one value "()". This value is special and - always uses the representation 'null'. - - - Creates an instance of the attribute - UnverifiableAttribute - - - This attribute is used to tag values whose use will result in the generation - of unverifiable code. These values are inevitably marked 'inline' to ensure that - the unverifiable constructs are not present in the actual code for the F# library, - but are rather copied to the source code of the caller. - - - Creates an instance of the attribute - VolatileFieldAttribute - - - Adding this attribute to an F# mutable binding causes the "volatile" - prefix to be used for all accesses to the field. - - - Thirty-two dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Thirty-one dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Thirty dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-nine dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-eight dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-seven dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-six dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-five dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-four dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-three dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-two dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-one dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Nineteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Eighteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Seventeen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Sixteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Fifteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Fourteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Thirteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twelve dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Eleven dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Ten dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Nine dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Eight dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Seven dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Six dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Five dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Four dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - Use the values in the Array4D module - to manipulate values of this type, or the notation arr.[x1,x2,x3,x4] to get and set array - values. - - - Three dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - Use the values in the Array3D module - to manipulate values of this type, or the notation arr.[x1,x2,x3] to get and set array - values. - - - Two dimensional arrays, typically zero-based. - - Use the values in the Array2D module - to manipulate values of this type, or the notation arr.[x,y] to get/set array - values. - - Non-zero-based arrays can also be created using methods on the System.Array type. - - - Single dimensional, zero-based arrays, written int[], string[] etc. - Use the values in the Array module to manipulate values - of this type, or the notation arr.[x] to get/set array - values. - - - Single dimensional, zero-based arrays, written int[], string[] etc. - - Use the values in the Array module to manipulate values - of this type, or the notation arr.[x] to get/set array - values. - - - An abbreviation for the CLI type System.Boolean. - - - Represents a managed pointer in F# code. - - - An abbreviation for the CLI type System.Byte. - - - An abbreviation for the CLI type System.Char. - - - An abbreviation for the CLI type System.Decimal. - - - The type of decimal numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Decimal. - - - An abbreviation for the CLI type System.Double. - - - An abbreviation for the CLI type System.Exception. - - - An abbreviation for the CLI type System.Double. - - - An abbreviation for the CLI type System.Single. - - - The type of floating point numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Single. - - - The type of floating point numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Double. - - - This type is for internal use by the F# code generator. - - - An abbreviation for the CLI type System.Int32. - - - An abbreviation for the CLI type System.Int16. - - - The type of 16-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Int16. - - - An abbreviation for the CLI type System.Int32. - - - An abbreviation for the CLI type System.Int64. - - - The type of 64-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Int64. - - - An abbreviation for the CLI type System.SByte. - - - The type of 32-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Int32. - - - An abbreviation for the CLI type System.IntPtr. - - - Represents an unmanaged pointer in F# code. - - This type should only be used when writing F# code that interoperates - with native code. Use of this type in F# code may result in - unverifiable code being generated. Conversions to and from the - nativeint type may be required. Values of this type can be generated - by the functions in the NativeInterop.NativePtr module. - - - An abbreviation for the CLI type System.Object. - - - The type of optional values. When used from other CLI languages the - empty option is the null value. - - Use the constructors Some and None to create values of this type. - Use the values in the Option module to manipulate values of this type, - or pattern match against the values directly. - - 'None' values will appear as the value null to other CLI languages. - Instance methods on this type will appear as static methods to other CLI languages - due to the use of null as a value representation. - - - The type of mutable references. Use the functions [:=] and [!] to get and - set values of this type. - - - An abbreviation for the CLI type System.SByte. - - - The type of 8-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.SByte. - - - An abbreviation for the CLI type System.Single. - - - An abbreviation for the CLI type System.String. - - - An abbreviation for the CLI type System.UInt16. - - - An abbreviation for the CLI type System.UInt32. - - - An abbreviation for the CLI type System.UInt64. - - - An abbreviation for the CLI type System.Byte. - - - An abbreviation for the CLI type System.UIntPtr. - - - The type 'unit', which has only one value "()". This value is special and - always uses the representation 'null'. - - - Non-exhaustive match failures will raise the MatchFailureException exception - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - A new enumerator for the sequence. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - A reference to the sequence. - - A 0, 1, and 2 respectively indicate Stop, Yield, and Goto conditions for the sequence generator. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - A new sequence generator for the expression. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - - Namespace name the provider injects types into. - - - - - Compilers call this method to query a type provider for a type name. - - Resolver should return a type called name in namespace NamespaceName or null if the type is unknown. - - - - - - The top-level types - - - - - - The sub-namespaces in this namespace. An optional member to prevent generation of namespaces until an outer namespace is explored. - - - - - Represents a namespace provided by a type provider component. - - - - - Triggered when an assumption changes that invalidates the resolutions so far reported by the provider - - - - - Triggered when an assumption changes that invalidates the resolutions so far reported by the provider - - - - - Triggered when an assumption changes that invalidates the resolutions so far reported by the provider - - - - - Get the static parameters for a provided type. - - A type returned by GetTypes or ResolveTypeName - - - - - Namespace name the this TypeProvider injects types into. - - - - - Called by the compiler to ask for an Expression tree to replace the given MethodBase with. - - MethodBase that was given to the compiler by a type returned by a GetType(s) call. - Expressions that represent the parameters to this call. - An expression that the compiler will use in place of the given method base. - - - - Get the physical contents of the given logical provided assembly. - - - - - Apply static arguments to a provided type that accepts static arguments. - - The provider must return a type with the given mangled name. - the provided type definition which has static parameters - the full path of the type, including encoded representations of static parameters - the static parameters, indexed by name - - - - - Represents an instantiation of a type provider component. - - - - - Get the static parameters for a provided method. - - A method returned by GetMethod on a provided type - The static parameters of the provided method, if any - - - - Apply static arguments to a provided method that accepts static arguments. - - The provider must return a provided method with the given mangled name. - the provided method definition which has static parameters - the full name of the method that must be returned, including encoded representations of static parameters - the values of the static parameters, indexed by name - The provided method definition corresponding to the given static parameter values - - - - Represents additional, optional information for a type provider component - - - - Represents the inverse of a measure expressions when returned as a generic argument of a provided type. - - - Represents the '1' measure expression when returned as a generic argument of a provided type. - - - Represents the product of two measure expressions when returned as a generic argument of a provided type. - - - Creates an instance of the attribute - TypeProviderAssemblyAttribute - The name of the design-time assembly for this type provider. - - - Creates an instance of the attribute - TypeProviderAssemblyAttribute - - - Place attribute on runtime assembly to indicate that there is a corresponding design-time - assembly that contains a type provider. Runtime and designer assembly may be the same. - - - Creates an instance of the attribute - TypeProviderAttribute - - - Place on a class that implements ITypeProvider to extend the compiler - - - - Get the full path to use for temporary files for the type provider instance. - - - - - version of referenced system runtime assembly - - - - - Get the full path to referenced assembly that caused this type provider instance to be created. - - - - - Get the full path to use to resolve relative paths in any file name arguments given to the type provider instance. - - - - - Get the referenced assemblies for the type provider instance. - - - - - Indicates if the type provider host responds to invalidation events for type provider instances. - - - - - Indicates if the type provider instance is used in an environment which executes provided code such as F# Interactive. - - - - - Get the full path to use for temporary files for the type provider instance. - - - - - version of referenced system runtime assembly - - - - - Get the full path to referenced assembly that caused this type provider instance to be created. - - - - - Get the full path to use to resolve relative paths in any file name arguments given to the type provider instance. - - - - - Get the referenced assemblies for the type provider instance. - - - - - Indicates if the type provider host responds to invalidation events for type provider instances. - - - - - Indicates if the type provider instance is used in an environment which executes provided code such as F# Interactive. - - - - - Checks if given type exists in target system runtime library - - - - - If the class that implements ITypeProvider has a constructor that accepts TypeProviderConfig - then it will be constructed with an instance of TypeProviderConfig. - - - - Creates an instance of the attribute - TypeProviderEditorHideMethodsAttribute - - - Indicates that a code editor should hide all System.Object methods from the intellisense menus for instances of a provided type - - - Additional type attribute flags related to provided types - - - Creates an instance of the attribute - TypeProviderXmlDocAttribute - - - - The TypeProviderXmlDocAttribute attribute can be added to types and members. - The language service will display the CommentText property from the attribute - in the appropriate place when the user hovers over a type or member. - - - - Creates an anonymous event with the given handlers. - - A function to handle adding a delegate for the event to trigger. - A function to handle removing a delegate that the event triggers. - A function to produce the delegate type the event can trigger. - - The initialized event. - - - The F# compiler emits calls to this function to implement the use operator for F# sequence - expressions. - - The resource to be used and disposed. - The input sequence. - - The result sequence. - - - The F# compiler emits calls to this function to implement the compiler-intrinsic - conversions from untyped System.Collections.IEnumerable sequences to typed sequences. - - An initializer function. - A function to iterate and test if end of sequence is reached. - A function to retrieve the current element. - - The resulting typed sequence. - - - The F# compiler emits calls to this function to - implement the try/finally operator for F# sequence expressions. - - The input sequence. - A computation to be included in an enumerator's Dispose method. - - The result sequence. - - - The F# compiler emits calls to this function to - implement the while operator for F# sequence expressions. - - A function that indicates whether iteration should continue. - The input sequence. - - The result sequence. - - - A group of functions used as part of the compiled representation of F# sequence expressions. - - - Builds a query using query syntax and operators. - - - An active pattern to force the execution of values of type Lazy<_>. - - - Special prefix operator for splicing untyped expressions into quotation holes. - - - Special prefix operator for splicing typed expressions into quotation holes. - - - Builds a 2D array from a sequence of sequences of elements. - - - Builds a read-only lookup table from a sequence of key/value pairs. The key objects are indexed using generic hashing and equality. - - - Converts the argument to signed byte. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using SByte.Parse() with InvariantCulture settings. - Otherwise the operation requires and invokes a ToSByte method on the input type. - - - Converts the argument to byte. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Byte.Parse() on strings and otherwise requires a ToByte method on the input type. - - - Converts the argument to 64-bit float. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Double.Parse() with InvariantCulture settings. Otherwise the operation requires and invokes a ToDouble method on the input type. - - - Converts the argument to 32-bit float. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Single.Parse() with InvariantCulture settings. Otherwise the operation requires and invokes a ToSingle method on the input type. - - - Builds an aysnchronous workflow using computation expression syntax. - - - Builds a set from a sequence of objects. The objects are indexed using generic comparison. - The input sequence of elements. - The created set. - - - Print to a file using the given format, and add a newline. - The file TextWriter. - The formatter. - The formatted result. - - - Print to a file using the given format. - The file TextWriter. - The formatter. - The formatted result. - - - Print to a string buffer and raise an exception with the given - result. Helper printers must return strings. - The formatter. - The formatted result. - - - Print to a string using the given format. - The formatter. - The formatted result. - - - Print to stderr using the given format, and add a newline. - The formatter. - The formatted result. - - - Print to stderr using the given format. - The formatter. - The formatted result. - - - Print to stdout using the given format, and add a newline. - The formatter. - The formatted result. - - - Print to stdout using the given format. - The formatter. - The formatted result. - - - Converts the argument to signed byte. - This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using SByte.Parse() with InvariantCulture settings. - Otherwise the operation requires and invokes a ToSByte method on the input type. - - - Converts the argument to byte. - This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using Byte.Parse() on strings and otherwise requires a ToByte method on the input type. - - - Divides a value by an integer. - The input value. - The input int. - The division result. - - - Resolves to the value 'one' for any primitive numeric type or any type with a static member called 'One' - - - Resolves to the zero value for any primitive numeric type or any type with a static member called 'Zero' - - - A compiler intrinsic that implements dynamic invocations for the DivideByInt primitive. - - - A compiler intrinsic that implements dynamic invocations to the checked '*' operator. - - - A compiler intrinsic that implements dynamic invocations to the '*' operator. - - - A compiler intrinsic that implements dynamic invocations to the checked '+' operator. - - - A compiler intrinsic that implements dynamic invocations to the '+' operator. - - - Resolves to the value 'one' for any primitive numeric type or any type with a static member called 'One'. - - - Resolves to the zero value for any primitive numeric type or any type with a static member called 'Zero'. - - - Parse an uint64 according to the rules used by the overloaded 'uint64' conversion operator when applied to strings - The input string. - The parsed value. - - - Parse an int64 according to the rules used by the overloaded 'int64' conversion operator when applied to strings - The input string. - The parsed value. - - - Parse an uint32 according to the rules used by the overloaded 'uint32' conversion operator when applied to strings - The input string. - The parsed value. - - - Parse an int32 according to the rules used by the overloaded 'int32' conversion operator when applied to strings - The input string. - The parsed value. - - - Creates an sbyte value with units-of-measure - The input sbyte. - The sbyte with units-of-measure. - - - Creates an int16 value with units-of-measure - The input int16. - The int16 with units-of-measure. - - - Creates an int64 value with units-of-measure - The input int64. - The int64 with units of measure. - - - Creates an int32 value with units-of-measure - The input int. - The int with units of measure. - - - Creates a decimal value with units-of-measure - The input decimal. - The decimal with units of measure. - - - Creates a float32 value with units-of-measure - The input float. - The float with units-of-measure. - - - Creates a float value with units-of-measure - The input float. - The float with units-of-measure. - - - Get the underlying value for an enum value - The input enum. - The enumeration as a value. - - - Build an enum value from an underlying value - The input value. - The value as an enumeration. - - - Recursively hash a part of a value according to its structure. - The comparison function. - The input object. - The hashed value. - - - Hash a value according to its structure. Use the given limit to restrict the hash when hashing F# - records, lists and union types. - The limit on the number of nodes. - The input object. - The hashed value. - - - Hash a value according to its structure. This hash is not limited by an overall node count when hashing F# - records, lists and union types. - The input object. - The hashed value. - - - Make an F# comparer object for the given type - - - Make an F# hash/equality object for the given type - - - Make an F# hash/equality object for the given type using node-limited hashing when hashing F# - records, lists and union types. - The input limit on the number of nodes. - System.Collections.Generic.IEqualityComparer<'T> - - - Make an F# hash/equality object for the given type - - - Make an F# comparer object for the given type, where it can be null if System.Collections.Generic.Comparer<'T>.Default - - - Make an F# comparer object for the given type - - - A static F# comparer object - - - Return an F# comparer object suitable for hashing and equality. This hashing behaviour - of the returned comparer is not limited by an overall node count when hashing F# - records, lists and union types. This equality comparer has equivalence - relation semantics ([nan] = [nan]). - - - Return an F# comparer object suitable for hashing and equality. This hashing behaviour - of the returned comparer is not limited by an overall node count when hashing F# - records, lists and union types. - - - The physical hash. Hashes on the object identity, except for value types, - where we hash on the contents. - The input object. - The hashed value. - - - Reference/physical equality. - True if the inputs are reference-equal, false otherwise. - The first value. - The second value. - The result of the comparison. - - - Take the maximum of two values structurally according to the order given by GenericComparison - The first value. - The second value. - The maximum value. - - - Take the minimum of two values structurally according to the order given by GenericComparison - The first value. - The second value. - The minimum value. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values. May be called as a recursive case from an implementation of System.IComparable to - ensure consistent NaN comparison semantics. - The function to compare the values. - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values for equality - - The first value. - The second value. - The result of the comparison. - - - Compare two values for equality using equivalence relation semantics ([nan] = [nan]) - The first value. - The second value. - The result of the comparison. - - - Compare two values for equality using partial equivalence relation semantics ([nan] <> [nan]) - The first value. - The second value. - The result of the comparison. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs - - - - The standard overloaded associative (4-indexed) mutation operator - - - - The standard overloaded associative (3-indexed) mutation operator - - - The standard overloaded associative (2-indexed) mutation operator - - - The standard overloaded associative (indexed) mutation operator - - - The standard overloaded associative (4-indexed) lookup operator - - - The standard overloaded associative (3-indexed) lookup operator - - - The standard overloaded associative (2-indexed) lookup operator - - - The standard overloaded associative (indexed) lookup operator - - - A compiler intrinsic for checking initialization soundness of recursive bindings - - - A compiler intrinsic for checking initialization soundness of recursive static bindings - - - A compiler intrinsic for checking initialization soundness of recursive bindings - - - A compiler intrinsic for the efficient compilation of sequence expressions - - - This function implements parsing of decimal constants - - - This function implements calls to default constructors - acccessed by 'new' constraints. - - - Primitive used by pattern match compilation - - - A compiler intrinsic that implements the ':?' operator - - - A compiler intrinsic that implements the ':?' operator - - - A compiler intrinsic that implements the ':?>' operator - - - A compiler intrinsic that implements the ':?>' operator - - - The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs - - - Address-of. Uses of this value may result in the generation of unverifiable code. - The input object. - The unmanaged pointer. - - - Address-of. Uses of this value may result in the generation of unverifiable code. - The input object. - The managed pointer. - - - Binary 'or'. When used as a binary operator the right hand value is evaluated only on demand - The first value. - The second value. - The result of the operation. - - - Binary 'or'. When used as a binary operator the right hand value is evaluated only on demand. - - - Binary 'and'. When used as a binary operator the right hand value is evaluated only on demand - The first value. - The second value. - The result of the operation. - - - Binary 'and'. When used as a binary operator the right hand value is evaluated only on demand. - - - The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs - - - For compiler use only - - - Language primitives associated with the F# language - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - An active pattern to match values of type System.Collections.Generic.KeyValuePair - The input key/value pair. - A tuple containing the key and value. - - - Converts the argument to character. Numeric inputs are converted according to the UTF-16 - encoding for characters. String inputs must be exactly one character long. For other - input types the operation requires an appropriate static conversion method on the input type. - The input value. - The converted char. - - - Converts the argument to System.Decimal using a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted decimal. - - - Converts the argument to a string using ToString. - - For standard integer and floating point values the ToString conversion - uses CultureInfo.InvariantCulture. - The input value. - The converted string. - - - Converts the argument to unsigned native integer using a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted unativeint - - - Converts the argument to signed native integer. This is a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted nativeint - - - Converts the argument to 64-bit float. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Double.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float - - - Converts the argument to 32-bit float. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Single.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float32 - - - Converts the argument to unsigned 64-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint64 - - - Converts the argument to signed 64-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int64 - - - Converts the argument to unsigned 32-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint32 - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int32 - - - Converts the argument to a particular enum type. - The input value. - The converted enum type. - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int - - - Converts the argument to unsigned 16-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint16 - - - Converts the argument to signed 16-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int16 - - - Converts the argument to signed byte. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using SByte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to byte. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Byte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - Overloaded power operator. If n > 0 then equivalent to x*...*x for n occurrences of x. - The input base. - The input exponent. - The base raised to the exponent. - - - Overloaded power operator. - The input base. - The input exponent. - The base raised to the exponent. - - - Overloaded truncate operator. - The input value. - The truncated value. - - - Hyperbolic tangent of the given number - The input value. - The hyperbolic tangent of the input. - - - Tangent of the given number - The input value. - The tangent of the input. - - - Hyperbolic sine of the given number - The input value. - The hyperbolic sine of the input. - - - Sine of the given number - The input value. - The sine of the input. - - - Hyperbolic cosine of the given number - The input value. - The hyperbolic cosine of the input. - - - Cosine of the given number - The input value. - The cosine of the input. - - - Square root of the given number - The input value. - The square root of the input. - - - Logarithm to base 10 of the given number - The input value. - The logarithm to base 10 of the input. - - - Natural logarithm of the given number - The input value. - The natural logarithm of the input. - - - Round the given number - The input value. - The nearest integer to the input value. - - - Sign of the given number - The input value. - -1, 0, or 1 depending on the sign of the input. - - - Floor of the given number - The input value. - The floor of the input. - - - Exponential of the given number - The input value. - The exponential of the input. - - - Ceiling of the given number - The input value. - The ceiling of the input. - - - Inverse tangent of x/y where x and y are specified separately - The y input value. - The x input value. - The inverse tangent of the input ratio. - - - Inverse tangent of the given number - The input value. - The inverse tangent of the input. - - - Inverse sine of the given number - The input value. - The inverse sine of the input. - - - Inverse cosine of the given number - The input value. - The inverse cosine of the input. - - - Absolute value of the given number. - The input value. - The absolute value of the input. - - - A generic hash function. This function has the same behaviour as 'hash', - however the default structural hashing for F# union, record and tuple - types stops when the given limit of nodes is reached. The exact behaviour of - the function can be adjusted on a type-by-type basis by implementing - GetHashCode for each type. - The limit of nodes. - The input object. - The computed hash. - - - A generic hash function, designed to return equal hash values for items that are - equal according to the "=" operator. By default it will use structural hashing - for F# union, record and tuple types, hashing the complete contents of the - type. The exact behaviour of the function can be adjusted on a - type-by-type basis by implementing GetHashCode for each type. - The input object. - The computed hash. - - - Returns the internal size of a type in bytes. For example, sizeof<int> returns 4. - - - Generate a System.Type representation for a type definition. If the - input type is a generic type instantiation then return the - generic type definition associated with all such instantiations. - - - An internal, library-only compiler intrinsic for compile-time - generation of a RuntimeMethodHandle. - - - Generate a System.Type runtime representation of a static type. - - - Clean up resources associated with the input object after the completion of the given function. - Cleanup occurs even when an exception is raised by the protected - code. - The resource to be disposed after action is called. - The action that accepts the resource. - The resulting value. - - - Execute the function as a mutual-exclusion region using the input value as a lock. - The object to be locked. - The action to perform during the lock. - The resulting value. - - - The standard overloaded skip range operator, e.g. [n..skip..m] for lists, seq {n..skip..m} for sequences - The start value of the range. - The step value of the range. - The end value of the range. - The sequence spanning the range using the specified step size. - - - The standard overloaded range operator, e.g. [n..m] for lists, seq {n..m} for sequences - The start value of the range. - The end value of the range. - The sequence spanning the range. - - - Reads the value of the property System.Console.Out. - - - Reads the value of the property System.Console.Error. - - - Reads the value of the property System.Console.In. - - - Equivalent to System.Single.NaN - - - Equivalent to System.Single.PositiveInfinity - - - Equivalent to System.Double.NaN - - - Equivalent to System.Double.PositiveInfinity - - - Exit the current hardware isolated process, if security settings permit, - otherwise raise an exception. Calls System.Environment.Exit. - The exit code to use. - The result value. - - - Builds a sequence using sequence expression syntax - The input sequence. - The result sequence. - - - Negate a logical value. not true equals false and not false equals true - The value to negate. - The result of the negation. - - - Concatenate two lists. - The first list. - The second list. - The concatenation of the lists. - - - Increment a mutable reference cell containing an integer - The reference cell. - - - Decrement a mutable reference cell containing an integer - The reference cell. - - - Dereference a mutable reference cell - The cell to dereference. - The value contained in the cell. - - - Assign to a mutable reference cell - The cell to mutate. - The value to set inside the cell. - - - Create a mutable reference cell - The value to contain in the cell. - The created reference cell. - - - The identity function - The input value. - The same value. - - - Throw a System.InvalidOperationException exception - The exception message. - The result value. - - - Throw a System.ArgumentNullException exception - The argument name. - The result value. - - - Throw a System.ArgumentException exception with - the given argument name and message. - The argument name. - The exception message. - The result value. - - - Throw a System.Exception exception. - The exception message. - The result value. - - - Determines whether the given value is null. - The value to check. - True when value is null, false otherwise. - - - Try to unbox a strongly typed value. - The boxed value. - The unboxed result as an option. - - - Boxes a strongly typed value. - The value to box. - The boxed object. - - - Unboxes a strongly typed value. - The boxed value. - The unboxed result. - - - Ignore the passed value. This is often used to throw away results of a computation. - The value to ignore. - - - Minimum based on generic comparison - The first value. - The second value. - The minimum value. - - - Maximum based on generic comparison - The first value. - The second value. - The maximum value. - - - Generic comparison. - The first value. - The second value. - The result of the comparison. - - - Return the second element of a tuple, snd (a,b) = b. - The input tuple. - The second value. - - - Return the first element of a tuple, fst (a,b) = a. - The input tuple. - The first value. - - - Matches System.Exception objects whose runtime type is precisely System.Exception - The input exception. - A string option. - - - Builds a System.Exception object. - The message for the Exception. - A System.Exception. - - - Rethrows an exception. This should only be used when handling an exception - The result value. - - - Rethrows an exception. This should only be used when handling an exception - The result value. - - - Raises an exception - The exception to raise. - The result value. - - - Concatenate two strings. The operator '+' may also be used. - - - Used to specify a default value for an optional argument in the implementation of a function - An option representing the argument. - The default value of the argument. - The argument value. If it is None, the defaultValue is returned. - - - Apply a function to three values, the values being a triple on the right, the function on the left - The function. - The first argument. - The second argument. - The third argument. - The function result. - - - Apply a function to two values, the values being a pair on the right, the function on the left - The function. - The first argument. - The second argument. - The function result. - - - Apply a function to a value, the value being on the right, the function on the left - The function. - The argument. - The function result. - - - Apply a function to three values, the values being a triple on the left, the function on the right - The first argument. - The second argument. - The third argument. - The function. - The function result. - - - Apply a function to two values, the values being a pair on the left, the function on the right - The first argument. - The second argument. - The function. - The function result. - - - Apply a function to a value, the value being on the left, the function on the right - The argument. - The function. - The function result. - - - Compose two functions, the function on the right being applied first - The second function to apply. - The first function to apply. - The composition of the input functions. - - - Compose two functions, the function on the left being applied first - The first function to apply. - The second function to apply. - The composition of the input functions. - - - Structural inequality - The first parameter. - The second parameter. - The result of the comparison. - - - Structural equality - The first parameter. - The second parameter. - The result of the comparison. - - - Structural less-than-or-equal comparison - The first parameter. - The second parameter. - The result of the comparison. - - - Structural greater-than-or-equal - The first parameter. - The second parameter. - The result of the comparison. - - - Structural greater-than - The first parameter. - The second parameter. - The result of the comparison. - - - Structural less-than comparison - The first parameter. - The second parameter. - The result of the comparison. - - - Overloaded prefix-plus operator - The input value. - The result of the operation. - - - Overloaded bitwise-NOT operator - The input value. - The result of the operation. - - - Overloaded byte-shift right operator by a specified number of bits - The input value. - The amount to shift. - The result of the operation. - - - Overloaded byte-shift left operator by a specified number of bits - The input value. - The amount to shift. - The result of the operation. - - - Overloaded bitwise-XOR operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded bitwise-OR operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded bitwise-AND operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded modulo operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded division operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded multiplication operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded subtraction operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded addition operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded unary negation. - The value to negate. - The result of the operation. - - - Converts the argument to char. Numeric inputs are converted using a checked - conversion according to the UTF-16 encoding for characters. String inputs must - be exactly one character long. For other input types the operation requires an - appropriate static conversion method on the input type. - The input value. - The converted char - - - Converts the argument to unativeint. This is a direct, checked conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted unativeint - - - Converts the argument to nativeint. This is a direct, checked conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted nativeint - - - Converts the argument to uint64. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.UInt64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint64 - - - Converts the argument to int64. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int64 - - - Converts the argument to uint32. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.UInt32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint32 - - - Converts the argument to int32. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int32 - - - Converts the argument to int. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int - - - Converts the argument to uint16. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.UInt16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint16 - - - Converts the argument to int16. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int16 - - - Converts the argument to sbyte. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.SByte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to byte. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Byte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - Overloaded multiplication operator (checks for overflow) - The first value. - The second value. - The product of the two input values. - - - Overloaded addition operator (checks for overflow) - The first value. - The second value. - The sum of the two input values. - - - Overloaded subtraction operator (checks for overflow) - The first value. - The second value. - The first value minus the second value. - - - Overloaded unary negation (checks for overflow) - The input value. - The negated value. - - - This module contains the basic arithmetic operations with overflow checks. - - - Calls GetHashCode() on the value - The value. - The hash code. - - - Minimum of the two values - The first value. - The second value. - The minimum value. - - - Maximum of the two values - The first value. - The second value. - The maximum value. - - - Compares the two values - The first value. - The second value. - The result of the comparison. - - - Compares the two values for inequality - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for equality - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for less-than-or-equal - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for greater-than-or-equal - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for greater-than - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for less-than - The first parameter. - The second parameter. - The result of the comparison. - - - A module of comparison and equality operators that are statically resolved, but which are not fully generic and do not make structural comparison. Opening this - module may make code that relies on structural or generic comparison no longer compile. - - - Perform generic hashing on a value where the type of the value is not - statically required to satisfy the 'equality' constraint. - The computed hash value. - - - Perform generic equality on two values where the type of the values is not - statically required to satisfy the 'equality' constraint. - The result of the comparison. - - - Perform generic comparison on two values where the type of the values is not - statically required to have the 'comparison' constraint. - The result of the comparison. - - - Generate a default value for any type. This is null for reference types, - For structs, this is struct value where all fields have the default value. - This function is unsafe in the sense that some F# values do not have proper null values. - - - Unboxes a strongly typed value. This is the inverse of box, unbox<t>(box<t> a) equals a. - The boxed value. - The unboxed result. - - - This module contains basic operations which do not apply runtime and/or static checks - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'decimal' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'float' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'float32' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'unativeint' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'nativeint' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint64' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int64' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint32' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int32' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint16' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int16' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'sbyte' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'byte' - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - Generate a range of values using the given zero, add, start, step and stop values - - - Generate a range of values using the given zero, add, start, step and stop values - - - Generate a range of char values - - - Generate a range of byte values - - - Generate a range of sbyte values - - - Generate a range of uint16 values - - - Generate a range of int16 values - - - Generate a range of unativeint values - - - Generate a range of nativeint values - - - Generate a range of uint32 values - - - Generate a range of uint64 values - - - Generate a range of int64 values - - - Generate a range of float32 values - - - Generate a range of float values - - - Generate a range of integers - - - Gets a slice from a string - The source string. - The index of the first character of the slice. - The index of the last character of the slice. - The substring from the given indices. - - - Sets a slice of an array - The target array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The start index of the fourth dimension. - The end index of the fourth dimension. - The source array. - - - Gets a slice of an array - The source array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The start index of the fourth dimension. - The end index of the fourth dimension. - The four dimensional sub array from the given indices. - - - Sets a slice of an array - The target array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The source array. - - - Gets a slice of an array - The source array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The three dimensional sub array from the given indices. - - - Sets a vector slice of a 2D array. The index of the second dimension is fixed. - The target array. - The start index of the first dimension. - The end index of the first dimension. - The index of the second dimension. - The source array. - - - Sets a vector slice of a 2D array. The index of the first dimension is fixed. - The target array. - The index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The source array. - - - Sets a region slice of an array - The target array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The source array. - - - Gets a vector slice of a 2D array. The index of the second dimension is fixed. - The source array. - The start index of the first dimension. - The end index of the first dimension. - The fixed index of the second dimension. - The sub array from the input indices. - - - Gets a vector slice of a 2D array. The index of the first dimension is fixed. - The source array. - The index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The sub array from the input indices. - - - Gets a region slice of an array - The source array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The two dimensional sub array from the input indices. - - - Sets a slice of an array - The target array. - The start index. - The end index. - The source array. - - - Gets a slice of an array - The input array. - The start index. - The end index. - The sub array from the input indices. - - - A module of compiler intrinsic functions for efficient implementations of F# integer ranges - and dynamic invocations of other F# operators - - - Basic F# Operators. This module is automatically opened in all F# code. - - - Invoke an F# first class function value that accepts five curried arguments - without intervening execution - The first arg. - The second arg. - The third arg. - The fourth arg. - The fifth arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept five curried arguments without intervening execution. - The input function. - The optimized function. - - - Construct an optimized function value that can accept five curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept five curried arguments - without intervening execution. This type should not typically used directly from - either F# code or from other CLI languages. - - - Invoke an F# first class function value that accepts four curried arguments - without intervening execution - The first arg. - The second arg. - The third arg. - The fourth arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept four curried arguments without intervening execution. - The input function. - The optimized function. - - - Construct an optimized function value that can accept four curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept four curried arguments - without intervening execution. This type should not typically used directly from - either F# code or from other CLI languages. - - - Invoke an F# first class function value that accepts three curried arguments - without intervening execution - The first arg. - The second arg. - The third arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept three curried arguments without intervening execution. - The input function. - The adapted function. - - - Construct an optimized function value that can accept three curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept - three iterated (curried) arguments without intervening execution. This type should not - typically used directly from either F# code or from other CLI languages. - - - Invoke the optimized function value with two curried arguments - The first arg. - The second arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept two curried arguments without intervening execution. - The input function. - The adapted function. - - - Construct an optimized function value that can accept two curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept - two iterated (curried) arguments without intervening execution. This type should not - typically used directly from either F# code or from other CLI languages. - - - An implementation module used to hold some private implementations of function - value invocation. - - - Convert an option to a potentially null value. - The input value. - The result value, which is null if the input was None. - - - Convert a potentially null value to an option. - The input value. - The result option. - - - Convert a Nullable value to an option. - The input nullable value. - The result option. - - - Convert the option to a Nullable value. - The input option. - The result value. - - - Convert the option to a list of length 0 or 1. - The input option. - The result list. - - - Convert the option to an array of length 0 or 1. - The input option. - The result array. - - - filter f inp evaluates to match inp with None -> None | Some x -> if f x then Some x else None. - A function that evaluates whether the value contained in the option should remain, or be filtered out. - The input option. - The input if the predicate evaluates to true; otherwise, None. - - - bind f inp evaluates to match inp with None -> None | Some x -> f x - A function that takes the value of type T from an option and transforms it into - an option containing a value of type U. - The input option. - An option of the output type of the binder. - - - map f inp evaluates to match inp with None -> None | Some x -> Some (f x). - A function to apply to the option value. - The input option. - An option of the input value after applying the mapping function, or None if the input is None. - - - iter f inp executes match inp with None -> () | Some x -> f x. - A function to apply to the option value. - The input option. - Unit if the option is None, otherwise it returns the result of applying the predicate - to the option value. - - - forall p inp evaluates to match inp with None -> true | Some x -> p x. - A function that evaluates to a boolean when given a value from the option type. - The input option. - True if the option is None, otherwise it returns the result of applying the predicate - to the option value. - - - exists p inp evaluates to match inp with None -> false | Some x -> p x. - A function that evaluates to a boolean when given a value from the option type. - The input option. - False if the option is None, otherwise it returns the result of applying the predicate - to the option value. - - - fold f inp s evaluates to match inp with None -> s | Some x -> f x s. - A function to update the state data when given a value from an option. - The input option. - The initial state. - The original state if the option is None, otherwise it returns the updated state with the folder - and the option value. - - - fold f s inp evaluates to match inp with None -> s | Some x -> f s x. - A function to update the state data when given a value from an option. - The initial state. - The input option. - The original state if the option is None, otherwise it returns the updated state with the folder - and the option value. - - - count inp evaluates to match inp with None -> 0 | Some _ -> 1. - The input option. - A zero if the option is None, a one otherwise. - - - Gets the value associated with the option. - The input option. - The value within the option. - Thrown when the option is None. - - - Returns true if the option is None. - The input option. - True if the option is None. - - - Returns true if the option is not None. - The input option. - True if the option is not None. - - - Basic operations on options. - - - Represents a statically-analyzed format associated with writing to a System.IO.TextWriter. The type parameter indicates the - arguments and return type of the format operation. - - - Represents a statically-analyzed format when formatting builds a string. The type parameter indicates the - arguments and return type of the format operation. - - - Represents a statically-analyzed format associated with writing to a System.Text.StringBuilder. The type parameter indicates the - arguments and return type of the format operation. - - - Represents a statically-analyzed format associated with writing to a System.IO.TextWriter. The first type parameter indicates the - arguments of the format operation and the last the overall return type. - - - Represents a statically-analyzed format when formatting builds a string. The first type parameter indicates the - arguments of the format operation and the last the overall return type. - - - Represents a statically-analyzed format associated with writing to a System.Text.StringBuilder. The first type parameter indicates the - arguments of the format operation and the last the overall return type. - - - Print to a string buffer and raise an exception with the given - result. Helper printers must return strings. - The input formatter. - The arguments of the formatter. - - - sprintf, but call the given 'final' function to generate the result. - See kprintf. - The function called to generate a result from the formatted string. - The input formatter. - The arguments of the formatter. - - - printf, but call the given 'final' function to generate the result. - For example, these let the printing force a flush after all output has - been entered onto the channel, but not before. - The function called after formatting to generate the format result. - The input formatter. - The arguments of the formatter. - - - fprintf, but call the given 'final' function to generate the result. - See kprintf. - The function called after formatting to generate the format result. - The input TextWriter. - The input formatter. - The arguments of the formatter. - - - bprintf, but call the given 'final' function to generate the result. - See kprintf. - The function called after formatting to generate the format result. - The input StringBuilder. - The input formatter. - The arguments of the formatter. - - - Print to a string via an internal string buffer and return - the result as a string. Helper printers must return strings. - The input formatter. - The formatted string. - - - Formatted printing to stdout, adding a newline. - The input formatter. - The return type and arguments of the formatter. - - - Formatted printing to stdout - The input formatter. - The return type and arguments of the formatter. - - - Formatted printing to stderr, adding a newline - The input formatter. - The return type and arguments of the formatter. - - - Formatted printing to stderr - The input formatter. - The return type and arguments of the formatter. - - - Print to a text writer, adding a newline - The TextWriter to print to. - The input formatter. - The return type and arguments of the formatter. - - - Print to a text writer. - The TextWriter to print to. - The input formatter. - The return type and arguments of the formatter. - - - Print to a System.Text.StringBuilder - The StringBuilder to print to. - The input formatter. - The return type and arguments of the formatter. - - - Extensible printf-style formatting for numbers and other datatypes - - Format specifications are strings with "%" markers indicating format - placeholders. Format placeholders consist of: - - %[flags][width][.precision][type] - - where the type is interpreted as follows: - - %b: bool, formatted as "true" or "false" - %s: string, formatted as its unescaped contents - %c: character literal - %d, %i: any basic integer type formatted as a decimal integer, signed if the basic integer type is signed. - %u: any basic integer type formatted as an unsigned decimal integer - %x, %X, %o: any basic integer type formatted as an unsigned hexadecimal - (a-f)/Hexadecimal (A-F)/Octal integer - - %e, %E, %f, %F, %g, %G: - any basic floating point type (float,float32) formatted - using a C-style floating point format specifications, i.e - - %e, %E: Signed value having the form [-]d.dddde[sign]ddd where - d is a single decimal digit, dddd is one or more decimal - digits, ddd is exactly three decimal digits, and sign - is + or - - - %f: Signed value having the form [-]dddd.dddd, where dddd is one - or more decimal digits. The number of digits before the - decimal point depends on the magnitude of the number, and - the number of digits after the decimal point depends on - the requested precision. - - %g, %G: Signed value printed in f or e format, whichever is - more compact for the given value and precision. - - - %M: System.Decimal value - - %O: Any value, printed by boxing the object and using it's ToString method(s) - - %A: Any value, printed with the default layout settings - - %a: A general format specifier, requires two arguments: - (1) a function which accepts two arguments: - (a) a context parameter of the appropriate type for the - given formatting function (e.g. an #System.IO.TextWriter) - (b) a value to print - and which either outputs or returns appropriate text. - - (2) the particular value to print - - - %t: A general format specifier, requires one argument: - (1) a function which accepts a context parameter of the - appropriate type for the given formatting function (e.g. - an System.IO.TextWriter)and which either outputs or returns - appropriate text. - - Basic integer types are: - byte,sbyte,int16,uint16,int32,uint32,int64,uint64,nativeint,unativeint - Basic floating point types are: - float, float32 - - The optional width is an integer indicating the minimal width of the - result. For instance, %6d prints an integer, prefixing it with spaces - to fill at least 6 characters. If width is '*', then an extra integer - argument is taken to specify the corresponding width. - - any number - '*': - - Valid flags are: - - 0: add zeros instead of spaces to make up the required width - '-': left justify the result within the width specified - '+': add a '+' character if the number is positive (to match a '-' sign - for negatives) - ' ': add an extra space if the number is positive (to match a '-' - sign for negatives) - - The printf '#' flag is invalid and a compile-time error will be reported if it is used. - - - Returns the length of the string. - The input string. - The number of characters in the string. - - - Returns a string by concatenating count instances of str. - The number of copies of the input string will be copied. - The input string. - The concatenated string. - Thrown when count is negative. - - - Tests if any character of the string satisfies the given predicate. - The function to test each character of the string. - The input string. - True if any character returns true for the predicate and false otherwise. - - - Tests if all characters in the string satisfy the given predicate. - The function to test each character of the string. - The input string. - True if all characters return true for the predicate and false otherwise. - - - Builds a new string whose characters are the results of applying the function mapping - to each index from 0 to count-1 and concatenating the resulting - strings. - The number of strings to initialize. - The function to take an index and produce a string to - be concatenated with the others. - The constructed string. - Thrown when count is negative. - - - Builds a new string containing only the characters of the input string - for which the given predicate returns "true". - - Returns an empty string if the input string is null - - A function to test whether each character in the input sequence should be included in the output string. - The input string. - The resulting string. - - - Builds a new string whose characters are the results of applying the function mapping - to each of the characters of the input string and concatenating the resulting - strings. - The function to produce a string from each character of the input string. - The input string. - The concatenated string. - - - Builds a new string whose characters are the results of applying the function mapping - to each character and index of the input string. - The function to apply to each character and index of the string. - The input string. - The resulting string. - - - Builds a new string whose characters are the results of applying the function mapping - to each of the characters of the input string. - The function to apply to the characters of the string. - The input string. - The resulting string. - - - Applies the function action to the index of each character in the string and the - character itself. - The function to apply to each character and index of the string. - The input string. - - - Applies the function action to each character in the string. - The function to be applied to each character of the string. - The input string. - - - Returns a new string made by concatenating the given strings - with separator sep, that is a1 + sep + ... + sep + aN. - The separator string to be inserted between the strings - of the input sequence. - The sequence of strings to be concatenated. - A new string consisting of the concatenated strings separated by - the separation string. - Thrown when strings is null. - - - Functional programming operators for string processing. Further string operations - are available via the member functions on strings and other functionality in - System.String - and System.Text.RegularExpressions types. - - - - The SI unit of catalytic activity - - - - - The SI unit of does equivalent - - - - - The SI unit of absorbed dose - - - - - The SI unit of activity referred to a radionuclide - - - - - The SI unit of illuminance - - - - - The SI unit of luminous flux - - - - - The SI unit of inductance - - - - - The SI unit of magnetic flux density - - - - - The SI unit of magnetic flux - - - - - The SI unit of electric conductance - - - - - The SI unit of electric resistance - - - - - The SI unit of capacitance - - - - - The SI unit of electric potential difference, electromotive force - - - - - The SI unit of electric charge, amount of electricity - - - - - The SI unit of power, radiant flux - - - - - The SI unit of energy, work, amount of heat - - - - - The SI unit of pressure, stress - - - - - The SI unit of force - - - - - The SI unit of frequency - - - - - The SI unit of luminous intensity - - - - - The SI unit of amount of substance - - - - - The SI unit of thermodynamic temperature - - - - - The SI unit of electric current - - - - - The SI unit of time - - - - - The SI unit of mass - - - - - The SI unit of length - - - - - The SI unit of length - - - - - A synonym for henry, the SI unit of inductance - - - - - A synonym for katal, the SI unit of catalytic activity - - - - - A synonym for sievert, the SI unit of does equivalent - - - - - A synonym for gray, the SI unit of absorbed dose - - - - - A synonym for becquerel, the SI unit of activity referred to a radionuclide - - - - - A synonym for lux, the SI unit of illuminance - - - - - A synonym for lumen, the SI unit of luminous flux - - - - - A synonym for tesla, the SI unit of magnetic flux density - - - - - A synonym for weber, the SI unit of magnetic flux - - - - - A synonym for UnitNames.ohm, the SI unit of electric resistance. - - - - - A synonym for siemens, the SI unit of electric conductance - - - - - A synonym for farad, the SI unit of capacitance - - - - - A synonym for volt, the SI unit of electric potential difference, electromotive force - - - - - A synonym for coulomb, the SI unit of electric charge, amount of electricity - - - - - A synonym for watt, the SI unit of power, radiant flux - - - - - A synonym for joule, the SI unit of energy, work, amount of heat - - - - - A synonym for pascal, the SI unit of pressure, stress - - - - - A synonym for newton, the SI unit of force - - - - - A synonym for hertz, the SI unit of frequency - - - - - A synonym for candela, the SI unit of luminous intensity - - - - - A synonym for mole, the SI unit of amount of substance - - - - - A synonym for kelvin, the SI unit of thermodynamic temperature - - - - - A synonym for ampere, the SI unit of electric current - - - - - A synonym for second, the SI unit of time - - - - - A synonym for kilogram, the SI unit of mass - - - - - A synonym for Metre, the SI unit of length - - - - - A method used to support the F# query syntax. Returns an empty sequence that has the specified type argument. - - - - - A method used to support the F# query syntax. Returns a sequence that contains the specified values. - - - - - A method used to support the F# query syntax. Returns a sequence of length one that contains the specified value. - - - - A query operator that selects those elements based on a specified predicate. - - - - A query operator that performs a subsequent ordering of the elements selected so far in descending order by the given nullable sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - - - - A query operator that performs a subsequent ordering of the elements selected so far in ascending order by the given nullable sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - - - - A query operator that performs a subsequent ordering of the elements selected so far in descending order by the given sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - - - - A query operator that performs a subsequent ordering of the elements selected so far in ascending order by the given sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - - - - A query operator that selects elements from a sequence as long as a specified condition is true, and then skips the remaining elements. - - - - A query operator that selects a specified number of contiguous elements from those selected so far. - - - - A query operator that selects a nullable value for each element selected so far and returns the sum of these values. - If any nullable does not have a value, it is ignored. - - - - A query operator that selects a value for each element selected so far and returns the sum of these values. - - - - - A method used to support the F# query syntax. Inputs to queries are implicitly wrapped by a call to one of the overloads of this method. - - - - - A method used to support the F# query syntax. Inputs to queries are implicitly wrapped by a call to one of the overloads of this method. - - - - A query operator that sorts the elements selected so far in descending order by the given nullable sorting key. - - - - A query operator that sorts the elements selected so far in ascending order by the given nullable sorting key. - - - - A query operator that sorts the elements selected so far in descending order by the given sorting key. - - - - A query operator that sorts the elements selected so far in ascending order by the given sorting key. - - - - A query operator that bypasses elements in a sequence as long as a specified condition is true and then selects the remaining elements. - - - - A query operator that bypasses a specified number of the elements selected so far and selects the remaining elements. - - - - A query operator that projects each of the elements selected so far. - - - - - A method used to support the F# query syntax. Runs the given quotation as a query using LINQ IQueryable rules. - - - - - A method used to support the F# query syntax. Indicates that the query should be passed as a quotation to the Run method. - - - - A query operator that selects the element at a specified index amongst those selected so far. - - - - A query operator that selects a nullable value for each element selected so far and returns the minimum of these values. - If any nullable does not have a value, it is ignored. - - - - A query operator that selects a value for each element selected so far and returns the minimum resulting value. - - - - A query operator that selects a nullable value for each element selected so far and returns the maximum of these values. - If any nullable does not have a value, it is ignored. - - - - A query operator that selects a value for each element selected so far and returns the maximum resulting value. - - - - A query operator that correlates two sets of selected values based on matching keys and groups the results. - If any group is empty, a group with a single default value is used instead. - Normal usage is 'leftOuterJoin y in elements2 on (key1 = key2) into group'. - - - - A query operator that selects the last element of those selected so far, or a default value if no element is found. - - - - A query operator that selects the last element of those selected so far. - - - - A query operator that correlates two sets of selected values based on matching keys. - Normal usage is 'join y in elements2 on (key1 = key2)'. - - - - A query operator that selects the first element of those selected so far, or a default value if the sequence contains no elements. - - - - A query operator that selects the first element from those selected so far. - - - - A query operator that selects a value for each element selected so far and groups the elements by the given key. - - - - A query operator that correlates two sets of selected values based on matching keys and groups the results. - Normal usage is 'groupJoin y in elements2 on (key1 = key2) into group'. - - - - A query operator that groups the elements selected so far according to a specified key selector. - - - - - A method used to support the F# query syntax. Projects each element of a sequence to another sequence and combines the resulting sequences into one sequence. - - - - A query operator that selects the first element selected so far that satisfies a specified condition. - - - - A query operator that determines whether any element selected so far satisfies a condition. - - - - A query operator that selects the single, specific element of those selected so far, or a default value if that element is not found. - - - - A query operator that selects the single, specific element selected so far - - - - A query operator that selects distinct elements from the elements selected so far. - - - - A query operator that returns the number of selected elements. - - - - A query operator that determines whether the selected elements contains a specified element. - - - - A query operator that selects a nullable value for each element selected so far and returns the average of these values. - If any nullable does not have a value, it is ignored. - - - - A query operator that selects a value for each element selected so far and returns the average of these values. - - - - A query operator that determines whether all elements selected so far satisfies a condition. - - - - Create an instance of this builder. Use 'query { ... }' to use the query syntax. - - - - The type used to support the F# query syntax. Use 'query { ... }' to use the query syntax. - - - - - A property used to support the F# query syntax. - - - - - A method used to support the F# query syntax. - - - - - A partial input or result in an F# query. This type is used to support the F# query syntax. - - - - Converts the argument to character. Numeric inputs are converted according to the UTF-16 - encoding for characters. The operation requires an appropriate static conversion method on the input type. - The input value. - The converted char. - - - Converts the argument to System.Decimal using a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted decimal. - - - Converts the argument to unsigned native integer using a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted unativeint - - - Converts the argument to signed native integer. This is a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted nativeint - - - Converts the argument to 64-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float - - - Converts the argument to 32-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float32 - - - Converts the argument to 64-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float - - - Converts the argument to 32-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float32 - - - Converts the argument to unsigned 64-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint64 - - - Converts the argument to signed 64-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int64 - - - Converts the argument to unsigned 32-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint32 - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int32 - - - Converts the argument to a particular enum type. - The input value. - The converted enum type. - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int - - - Converts the argument to unsigned 16-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint16 - - - Converts the argument to signed 16-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int16 - - - Converts the argument to signed byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to signed byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - Converts the argument to byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - - Functions for converting nullable values - - - - - The division operator where a nullable value appears on both left and right sides - - - - - The division operator where a nullable value appears on the right - - - - - The division operator where a nullable value appears on the left - - - - - The modulus operator where a nullable value appears on both left and right sides - - - - - The modulus operator where a nullable value appears on the right - - - - - The modulus operator where a nullable value appears on the left - - - - - The multiplication operator where a nullable value appears on both left and right sides - - - - - The multiplication operator where a nullable value appears on the right - - - - - The multiplication operator where a nullable value appears on the left - - - - - The subtraction operator where a nullable value appears on both left and right sides - - - - - The subtraction operator where a nullable value appears on the right - - - - - The subtraction operator where a nullable value appears on the left - - - - - The addition operator where a nullable value appears on both left and right sides - - - - - The addition operator where a nullable value appears on the right - - - - - The addition operator where a nullable value appears on the left - - - - - The '<>' operator where a nullable value appears on both left and right sides - - - - - The '=' operator where a nullable value appears on both left and right sides - - - - - The '<' operator where a nullable value appears on both left and right sides - - - - - The '<=' operator where a nullable value appears on both left and right sides - - - - - The '>' operator where a nullable value appears on both left and right sides - - - - - The '>=' operator where a nullable value appears on both left and right sides - - - - - The '<>' operator where a nullable value appears on the right - - - - - The '=' operator where a nullable value appears on the right - - - - - The '<' operator where a nullable value appears on the right - - - - - The '<=' operator where a nullable value appears on the right - - - - - The '>' operator where a nullable value appears on the right - - - - - The '>=' operator where a nullable value appears on the right - - - - - The '<>' operator where a nullable value appears on the left - - - - - The '=' operator where a nullable value appears on the left - - - - - The '<' operator where a nullable value appears on the left - - - - - The '<=' operator where a nullable value appears on the left - - - - - The '>' operator where a nullable value appears on the left - - - - - The '>=' operator where a nullable value appears on the left - - - - - Operators for working with nullable values - - - - - A method used to support the F# query syntax. Runs the given quotation as a query using LINQ IEnumerable rules. - - - - - A method used to support the F# query syntax. Runs the given quotation as a query using LINQ rules. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - A type used to reconstruct a grouping after applying a mutable->immutable mapping transformation - on a result of a query. - - - - - The generic MethodInfo for Select function - Describes how we got from productions of immutable objects to productions of anonymous objects, with enough information - that we can invert the process in final query results. - - - - - Given the expression part of a "yield" or "select" which produces a result in terms of immutable tuples or immutable records, - generate an equivalent expression yielding anonymous objects. Also return the conversion for the immutable-to-mutable correspondence - so we can reverse this later. - - - - - Simplify gets of tuples and gets of record fields. - - - - - Cleanup the use of property-set object constructions in leaf expressions that form parts of F# queries. - - - - - Given an type involving immutable tuples and records, logically corresponding to the type produced at a - "yield" or "select", convert it to a type involving anonymous objects according to the conversion data. - - - - - Recognize anonymous type construction written using 'new AnonymousObject(<e1>, <e2>, ...)' - - - - - Recognize object construction written using 'new O(Prop1 = <e>, Prop2 = <e>, ...)' - - - - - Tests whether a list consists only of assignments of properties of the - given variable, null values (ignored) and ends by returning the given variable - (pattern returns only property assignments) - - - - - Recognize sequential series written as (... ((<e>; <e>); <e>); ...) - - - - - A runtime helper used to evaluate nested quotation literals. - - - - - A runtime helper used to evaluate nested quotation literals. - - - - - Evaluates a subset of F# quotations by first converting to a LINQ expression, for the subset of LINQ expressions represented by the - expression syntax in the C# language. - - - - - Converts a subset of F# quotations to a LINQ expression, for the subset of LINQ expressions represented by the - expression syntax in the C# language. - - - - - Converts a subset of F# quotations to a LINQ expression, for the subset of LINQ expressions represented by the - expression syntax in the C# language. - - - - - When used in a quotation, this function indicates a specific conversion - should be performed when converting the quotation to a LINQ expression. - - This function should not be called directly. - - - - - When used in a quotation, this function indicates a specific conversion - should be performed when converting the quotation to a LINQ expression. - - This function should not be called directly. - - - - - When used in a quotation, this function indicates a specific conversion - should be performed when converting the quotation to a LINQ expression. - - This function should not be called directly. - - - - Allocates a region of memory on the stack. - The number of objects of type T to allocate. - A typed pointer to the allocated memory. - - - Assigns the value into the memory location referenced by the typed native - pointer computed by adding index * sizeof<'T> to the given input pointer. - The input pointer. - The index by which to offset the pointer. - The value to assign. - - - Assigns the value into the memory location referenced by the given typed native pointer. - The input pointer. - The value to assign. - - - Dereferences the given typed native pointer. - The input pointer. - The value at the pointer address. - - - Dereferences the typed native pointer computed by adding index * sizeof<'T> to the - given input pointer. - The input pointer. - The index by which to offset the pointer. - The value at the pointer address. - - - Returns a typed native pointer by adding index * sizeof<'T> to the - given input pointer. - The input pointer. - The index by which to offset the pointer. - A typed pointer. - - - Returns a machine address for a given typed native pointer. - The input pointer. - The machine address. - - - Returns a typed native pointer for a given machine address. - The pointer address. - A typed pointer. - - - Contains operations on native pointers. Use of these operators may - result in the generation of unverifiable code. - - - Gets the raw expression associated with this type-carrying expression - - - Type-carrying quoted expressions. Expressions are generated either - by quotations in source text or programatically - - - Returns type of an expression. - - - Returns the custom attributes of an expression. - - - Builds an expression that represents a value and its associated reflected definition as a quotation - The untyped object. - The type of the object. - The definition of the value being quoted. - The resulting expression. - - - Builds an expression that represents a value and its associated reflected definition as a quotation - The value being quoted. - The definition of the value being quoted. - The resulting expression. - - - Builds an expression that represents a while loop - The predicate to control the loop iteration. - The body of the while loop. - The resulting expression. - - - Builds an expression that represents setting a mutable variable - The input variable. - The value to set. - The resulting expression. - - - Builds an expression that represents a variable - The input variable. - The resulting expression. - - - Builds an expression that represents a constant value of a particular type, arising from a variable of the given name - The untyped object. - The type of the object. - The name of the variable. - The resulting expression. - - - Builds an expression that represents a constant value, arising from a variable of the given name - The typed value. - The name of the variable. - The resulting expression. - - - Builds an expression that represents a constant value - The typed value. - The resulting expression. - - - Builds an expression that represents a constant value of a particular type - The untyped object. - The type of the object. - The resulting expression. - - - Builds an expression that represents a test of a value is of a particular union case - The expression to test. - The description of the union case. - The resulting expression. - - - Builds an expression that represents a type test. - The expression to test. - The target type. - The resulting expression. - - - Builds an expression that represents getting a field of a tuple - The input tuple. - The index of the tuple element to get. - The resulting expression. - - - Builds an expression that represents a try/with construct for exception filtering and catching. - The body of the try expression. - - - The variable to bind to a caught exception. - The expression evaluated when an exception is caught. - The resulting expression. - - - Try and find a stored reflection definition for the given method. Stored reflection - definitions are added to an F# assembly through the use of the [<ReflectedDefinition>] attribute. - The description of the method to find. - The reflection definition or None if a match could not be found. - - - Builds an expression that represents a try/finally construct - The body of the try expression. - The final part of the expression to be evaluated. - The resulting expression. - - - Format the expression as a string - Indicates if method, property, constructor and type objects should be printed in detail. If false, these are abbreviated to their name. - The formatted string. - - - Substitutes through the given expression using the given functions - to map variables to new values. The functions must give consistent results - at each application. Variable renaming may occur on the target expression - if variable capture occurs. - The function to map variables into expressions. - The expression with the given substitutions. - - - Builds an expression that represents the sequential execution of one expression followed by another - The first expression. - The second expression. - The resulting expression. - - - Permits interactive environments such as F# Interactive - to explicitly register new pickled resources that represent persisted - top level definitions. - The assembly associated with the resource. - The unique name for the resources being added. - The type definitions referenced. - The serialized resource to register with the environment. - - - Permits interactive environments such as F# Interactive - to explicitly register new pickled resources that represent persisted - top level definitions. - The assembly associated with the resource. - The unique name for the resources being added. - The serialized resource to register with the environment. - - - Builds an expression that represents a nested typed quotation literal - The expression being quoted. - The resulting expression. - - - Builds an expression that represents a nested raw quotation literal - The expression being quoted. - The resulting expression. - - - Builds an expression that represents a nested typed or raw quotation literal - The expression being quoted. - The resulting expression. - - - Builds an expression that represents writing to a static property - The description of the property. - The value to set. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents writing to a property of an object - The input object. - The description of the property. - The value to set. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents reading a static property - The description of the property. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents reading a property of an object - The input object. - The description of the property. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents the creation of a union case value - The description of the union case. - The list of arguments for the case. - The resulting expression. - - - Builds an expression that represents the creation of an F# tuple value - The list of elements of the tuple. - The resulting expression. - - - Builds record-construction expressions - The type of record. - The list of elements of the record. - The resulting expression. - - - Builds an expression that represents the invocation of an object constructor - The description of the constructor. - The list of arguments to the constructor. - The resulting expression. - - - Builds an expression that represents the creation of a delegate value for the given type - The type of delegate. - The parameters for the delegate. - The body of the function. - The resulting expression. - - - Builds an expression that represents the creation of an array value initialized with the given elements - The type for the elements of the array. - The list of elements of the array. - The resulting expression. - - - Builds recursives expressions associated with 'let rec' constructs - The list of bindings for the let expression. - The sub-expression where the bindings are in scope. - The resulting expression. - - - Builds expressions associated with 'let' constructs - The variable in the let expression. - The expression bound to the variable. - The sub-expression where the binding is in scope. - The resulting expression. - - - Builds an expression that represents the constrution of an F# function value - The parameter to the function. - The body of the function. - The resulting expression. - - - Builds 'if ... then ... else' expressions. - The condition expression. - The then sub-expression. - The else sub-expression. - The resulting expression. - - - Fetches or creates a new variable with the given name and type from a global pool of shared variables - indexed by name and type. The type is given by the expicit or inferred type parameter - The variable name. - The created of fetched typed global variable. - - - Gets the free expression variables of an expression as a list. - A sequence of the free variables in the expression. - - - Builds a 'for i = ... to ... do ...' expression that represent loops over integer ranges - The sub-expression declaring the loop variable. - The sub-expression setting the initial value of the loop variable. - The sub-expression declaring the final value of the loop variable. - The sub-expression representing the body of the loop. - The resulting expression. - - - Builds an expression that represents writing to a field of an object - The input object. - The description of the field to write to. - The value to set to the field. - The resulting expression. - - - Builds an expression that represents writing to a static field - The description of the field to write to. - The value to the set to the field. - The resulting expression. - - - Builds an expression that represents the access of a field of an object - The input object. - The description of the field to access. - The resulting expression. - - - Builds an expression that represents the access of a static field - The description of the field to access. - The resulting expression. - - - This function is called automatically when quotation syntax (<@ @>) and other sources of - quotations are used. - A type in the assembly where the quotation occurs. - The type definitions referenced. - The spliced types, to replace references to type variables. - The spliced expressions to replace references to spliced expressions. - The serialized form of the quoted expression. - The resulting expression. - - - This function is called automatically when quotation syntax (<@ @>) and other sources of - quotations are used. - A type in the assembly where the quotation occurs. - The spliced types, to replace references to type variables. - The spliced expressions to replace references to spliced expressions. - The serialized form of the quoted expression. - The resulting expression. - - - Builds an expression that represents the invocation of a default object constructor - The type on which the constructor is invoked. - The resulting expression. - - - Builds an expression that represents the coercion of an expression to a type - The expression to coerce. - The target type. - The resulting expression. - - - Returns a new typed expression given an underlying runtime-typed expression. - A type annotation is usually required to use this function, and - using an incorrect type annotation may result in a later runtime exception. - The expression to cast. - The resulting typed expression. - - - Builds an expression that represents a call to an instance method associated with an object - The input object. - The description of the method to call. - The list of arguments to the method. - The resulting expression. - - - Builds an expression that represents a call to an static method or module-bound function - The MethodInfo describing the method to call. - The list of arguments to the method. - The resulting expression. - - - Builds an expression that represents the application of a first class function value to multiple arguments - The function to apply. - The list of lists of arguments to the function. - The resulting expression. - - - Builds an expression that represents the application of a first class function value to a single argument. - The function to apply. - The argument to the function. - The resulting expression. - - - Builds an expression that represents setting the value held at a particular address. - The target expression. - The value to set at the address. - The resulting expression. - - - Builds an expression that represents getting the address of a value. - The target expression. - The resulting expression. - - - Quoted expressions annotated with System.Type values. - - - The type associated with the variable - - - The declared name of the variable - - - Indicates if the variable represents a mutable storage location - - - Fetches or create a new variable with the given name and type from a global pool of shared variables - indexed by name and type - The name of the variable. - The type associated with the variable. - The retrieved or created variable. - - - Creates a new variable with the given name, type and mutability - The declared name of the variable. - The type associated with the variable. - Indicates if the variable represents a mutable storage location. Default is false. - The created variable. - - - Information at the binding site of a variable - - - Re-build combination expressions. The first parameter should be an object - returned by the ShapeCombination case of the active pattern in this module. - The input shape. - The list of arguments. - The rebuilt expression. - - - An active pattern that performs a complete decomposition viewing the expression tree as a binding structure - The input expression. - The decomposed Var, Lambda, or ConstApp. - - - Active patterns for traversing, visiting, rebuilding and tranforming expressions in a generic way - - - An active pattern to recognize property setters that have an associated ReflectedDefinition - The description of the property. - The expression of the method definition if found, or None. - - - An active pattern to recognize property getters or values in modules that have an associated ReflectedDefinition - The description of the property. - The expression of the method definition if found, or None. - - - An active pattern to recognize methods that have an associated ReflectedDefinition - The description of the method. - The expression of the method definition if found, or None. - - - A parameterized active pattern to recognize calls to a specified function or method. - The returned elements are the optional target object (present if the target is an - instance method), the generic type instantation (non-empty if the target is a generic - instantiation), and the arguments to the function or method. - The input template expression to specify the method to call. - The optional target object (present if the target is an - instance method), the generic type instantation (non-empty if the target is a generic - instantiation), and the arguments to the function or method. - - - An active pattern to recognize constant decimal expressions - The input expression to match against. - decimal option - - - An active pattern to recognize constant unsigned int64 expressions - The input expression to match against. - uint64 option - - - An active pattern to recognize constant int64 expressions - The input expression to match against. - int64 option - - - An active pattern to recognize constant unsigned int32 expressions - The input expression to match against. - uint32 option - - - An active pattern to recognize constant int32 expressions - The input expression to match against. - int32 option - - - An active pattern to recognize constant unsigned int16 expressions - The input expression to match against. - uint16 option - - - An active pattern to recognize constant int16 expressions - The input expression to match against. - int16 option - - - An active pattern to recognize constant byte expressions - The input expression to match against. - byte option - - - An active pattern to recognize constant signed byte expressions - The input expression to match against. - sbyte option - - - An active pattern to recognize constant unicode character expressions - The input expression to match against. - char option - - - An active pattern to recognize constant 64-bit floating point number expressions - The input expression to match against. - float option - - - An active pattern to recognize constant 32-bit floating point number expressions - The input expression to match against. - float32 option - - - An active pattern to recognize constant string expressions - The input expression to match against. - string option - - - An active pattern to recognize constant boolean expressions - The input expression to match against. - bool option - - - An active pattern to recognize () constant expressions - The input expression to match against. - unit option - - - An active pattern to recognize expressions of the form a || b - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions of the form a && b - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent the application of a (possibly curried or tupled) first class function value - The input expression to match against. - (Expr * Expr list list) option - - - An active pattern to recognize expressions that represent a (possibly curried or tupled) first class function value - The input expression to match against. - (Var list list * Expr) option - - - Contains a set of derived F# active patterns to analyze F# expression objects - - - An active pattern to recognize expressions that represent setting a mutable variable - The input expression to match against. - (Var * Expr) option - - - An active pattern to recognize expressions that represent a variable - The input expression to match against. - Var option - - - An active pattern to recognize expressions that are a value with an associated definition - The input expression to match against. - The boxed value, its static type and its definition - - - An active pattern to recognize expressions that represent a constant value - The input expression to match against. - The boxed value, its static type and its name - - - An active pattern to recognize expressions that represent a constant value. This also matches expressions matched by ValueWithName. - The input expression to match against. - The boxed value and its static type - - - An active pattern to recognize expressions that represent a test if a value is of a particular union case - The input expression to match against. - The expression and union case being tested - - - An active pattern to recognize expressions that represent a dynamic type test - The input expression to match against. - The expression and type being tested - - - An active pattern to recognize expressions that represent getting a tuple field - The input expression to match against. - The expression and tuple field being accessed - - - An active pattern to recognize expressions that represent a try/finally construct - The input expression to match against. - The body and handler parts of the try/finally expression - - - An active pattern to recognize expressions that represent a try/with construct for exception filtering and catching - The input expression to match against. - (Expr * Var * Expr * Var * Expr) option - - - An active pattern to recognize expressions that represent sequential exeuction of one expression followed by another - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent a nested typed quotation literal - The input expression to match against. - Expr option - - - An active pattern to recognize expressions that represent a nested raw quotation literal - The input expression to match against. - Expr option - - - An active pattern to recognize expressions that represent a nested quotation literal - The input expression to match against. - Expr option - - - An active pattern to recognize expressions that represent setting a static or instance property, or a non-function value declared in a module - The input expression to match against. - (Expr option * PropertyInfo * Expr list * Expr) option - - - An active pattern to recognize expressions that represent the read of a static or instance property, or a non-function value declared in a module - The input expression to match against. - (Expr option * PropertyInfo * Expr list) option - - - An active pattern to recognize expressions that represent construction of tuple values - The input expression to match against. - (Expr list) option - - - An active pattern to recognize expressions that represent construction of particular union case values - The input expression to match against. - (UnionCaseInfo * Expr list) option - - - An active pattern to recognize expressions that represent construction of record values - The input expression to match against. - (Type * Expr list) option - - - An active pattern to recognize expressions that represent invocation of object constructors - The input expression to match against. - (ConstructorInfo * Expr list) option - - - An active pattern to recognize expressions that represent construction of delegate values - The input expression to match against. - (Type * Var list * Expr) option - - - An active pattern to recognize expressions that represent invocations of a default constructor of a struct - The input expression to match against. - Type option - - - An active pattern to recognize expressions that represent the construction of arrays - The input expression to match against. - (Type * Expr list) option - - - An active pattern to recognize expressions that represent recursive let bindings of one or more variables - The input expression to match against. - ((Var * Expr) list * Expr) option - - - An active pattern to recognize expressions that represent let bindings - The input expression to match against. - (Var * Expr * Expr) option - - - An active pattern to recognize expressions that represent first class function values - The input expression to match against. - (Var * Expr) option - - - An active pattern to recognize expressions that represent conditionals - The input expression to match against. - (Expr * Expr * Expr) option - - - An active pattern to recognize expressions that represent while loops - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent loops over integer ranges - The input expression to match against. - (Var * Expr * Expr * Expr) option - - - An active pattern to recognize expressions that represent setting a static or instance field - The input expression to match against. - (Expr option * FieldInfo * Expr) option - - - An active pattern to recognize expressions that represent getting a static or instance field - The input expression to match against. - (Expr option * FieldInfo) option - - - An active pattern to recognize expressions that represent coercions from one type to another - The input expression to match against. - (Expr * Type) option - - - An active pattern to recognize expressions that represent calls to static and instance methods, and functions defined in modules - The input expression to match against. - (Expr option * MethodInfo * Expr list) option - - - An active pattern to recognize expressions that represent applications of first class function values - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent setting the value held at an address - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent getting the address of a value - The input expression to match against. - Expr option - - - Contains a set of primitive F# active patterns to analyze F# expression objects - - - Returns a System.Type representing an F# tuple type with the given element types - An array of types for the tuple elements. - The type representing the tuple containing the input elements. - - - Returns a System.Type representing the F# function type with the given domain and range - The input type of the function. - The output type of the function. - The function type with the given domain and range. - - - Returns true if the typ is a representation of an F# union type or the runtime type of a value of that type - The type to check. - Optional binding flags. - True if the type check succeeds. - - - Return true if the typ is a representation of an F# tuple type - The type to check. - True if the type check succeeds. - - - Return true if the typ is a representation of an F# record type - The type to check. - Optional binding flags. - True if the type check succeeds. - - - Return true if the typ is a System.Type value corresponding to the compiled form of an F# module - The type to check. - True if the type check succeeds. - - - Return true if the typ is a representation of an F# function type or the runtime type of a closure implementing an F# function type - The type to check. - True if the type check succeeds. - - - Returns true if the typ is a representation of an F# exception declaration - The type to check. - Optional binding flags. - True if the type check is an F# exception. - - - Gets the cases of a union type. - - Assumes the given type is a union type. If not, ArgumentException is raised during pre-computation. - The input union type. - Optional binding flags. - Thrown when the input type is not a union type. - An array of descriptions of the cases of the given union type. - - - Gets the tuple elements from the representation of an F# tuple type. - The input tuple type. - An array of the types contained in the given tuple type. - - - Reads all the fields from a record value, in declaration order - - Assumes the given input is a record value. If not, ArgumentException is raised. - The input record type. - Optional binding flags. - An array of descriptions of the properties of the record type. - - - Gets the domain and range types from an F# function type or from the runtime type of a closure implementing an F# type - The input function type. - A tuple of the domain and range types of the input function. - - - Reads all the fields from an F# exception declaration, in declaration order - - Assumes exceptionType is an exception representation type. If not, ArgumentException is raised. - The exception type to read. - Optional binding flags. - Thrown if the given type is not an exception. - An array containing the PropertyInfo of each field in the exception. - - - Contains operations associated with constructing and analyzing F# types such as records, unions and tuples - - - Assumes the given type is a union type. - If not, ArgumentException is raised during pre-computation. - - Using the computed function is more efficient than calling GetUnionCase - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The type of union to optimize reading. - Optional binding flags. - An optimized function to read the tags of the given union type. - - - Precompute a property or static method for reading an integer representing the case tag of a union type. - The type of union to read. - Optional binding flags. - The description of the union case reader. - - - Precomputes a function for reading all the fields for a particular discriminator case of a union type - - Using the computed function will typically be faster than executing a corresponding call to GetFields - The description of the union case to read. - Optional binding flags. - A function to for reading the fields of the given union case. - - - A method that constructs objects of the given case - The description of the union case. - Optional binding flags. - The description of the constructor of the given union case. - - - Precomputes a function for constructing a discriminated union value for a particular union case. - The description of the union case. - Optional binding flags. - A function for constructing values of the given union case. - - - Precomputes a function for reading the values of a particular tuple type - - Assumes the given type is a TupleType. - If not, ArgumentException is raised during pre-computation. - The tuple type to read. - Thrown when the given type is not a tuple type. - A function to read values of the given tuple type. - - - Gets information that indicates how to read a field of a tuple - The input tuple type. - The index of the tuple element to describe. - The description of the tuple element and an optional type and index if the tuple is big. - - - Gets a method that constructs objects of the given tuple type. - For small tuples, no additional type will be returned. - - For large tuples, an additional type is returned indicating that - a nested encoding has been used for the tuple type. In this case - the suffix portion of the tuple type has the given type and an - object of this type must be created and passed as the last argument - to the ConstructorInfo. A recursive call to PreComputeTupleConstructorInfo - can be used to determine the constructor for that the suffix type. - The input tuple type. - The description of the tuple type constructor and an optional extra type - for large tuples. - - - Precomputes a function for reading the values of a particular tuple type - - Assumes the given type is a TupleType. - If not, ArgumentException is raised during pre-computation. - The type of tuple to read. - Thrown when the given type is not a tuple type. - A function to read a particular tuple type. - - - Precompute a function for reading all the fields from a record. The fields are returned in the - same order as the fields reported by a call to Microsoft.FSharp.Reflection.Type.GetInfo for - this type. - - Assumes the given type is a RecordType. - If not, ArgumentException is raised during pre-computation. - - Using the computed function will typically be faster than executing a corresponding call to Value.GetInfo - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The type of record to read. - Optional binding flags. - Thrown when the input type is not a record type. - An optimized reader for the given record type. - - - Precompute a function for reading a particular field from a record. - Assumes the given type is a RecordType with a field of the given name. - If not, ArgumentException is raised during pre-computation. - - Using the computed function will typically be faster than executing a corresponding call to Value.GetInfo - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The PropertyInfo of the field to read. - Thrown when the input type is not a record type. - A function to read the specified field from the record. - - - Get a ConstructorInfo for a record type - The record type. - Optional binding flags. - A ConstructorInfo for the given record type. - - - Precompute a function for constructing a record value. - - Assumes the given type is a RecordType. - If not, ArgumentException is raised during pre-computation. - The type of record to construct. - Optional binding flags. - Thrown when the input type is not a record type. - A function to construct records of the given type. - - - Create a union case value. - The description of the union case to create. - The array of arguments to construct the given case. - Optional binding flags. - The constructed union case. - - - Creates an instance of a tuple type - - Assumes at least one element is given. If not, ArgumentException is raised. - The array of tuple fields. - The tuple type to create. - Thrown if no elements are given. - An instance of the tuple type with the given elements. - - - Creates an instance of a record type. - - Assumes the given input is a record type. - The type of record to make. - The array of values to initialize the record. - Optional binding flags for the record. - Thrown when the input type is not a record type. - The created record. - - - Builds a typed function from object from a dynamic function implementation - The function type of the implementation. - The untyped lambda of the function implementation. - A typed function from the given dynamic implementation. - - - Identify the union case and its fields for an object - - Assumes the given input is a union case value. If not, ArgumentException is raised. - - If the type is not given, then the runtime type of the input object is used to identify the - relevant union type. The type should always be given if the input object may be null. For example, - option values may be represented using the 'null'. - The input union case. - The union type containing the value. - Optional binding flags. - Thrown when the input type is not a union case value. - The description of the union case and its fields. - - - Reads all fields from a tuple. - - Assumes the given input is a tuple value. If not, ArgumentException is raised. - The input tuple. - Thrown when the input is not a tuple value. - An array of the fields from the given tuple. - - - Reads a field from a tuple value. - - Assumes the given input is a tuple value. If not, ArgumentException is raised. - The input tuple. - The index of the field to read. - The value of the field. - - - Reads all the fields from a record value. - - Assumes the given input is a record value. If not, ArgumentException is raised. - The record object. - Optional binding flags for the record. - Thrown when the input type is not a record type. - The array of fields from the record. - - - Reads a field from a record value. - - Assumes the given input is a record value. If not, ArgumentException is raised. - The record object. - The PropertyInfo describing the field to read. - Thrown when the input type is not a record type. - The field from the record. - - - Reads all the fields from a value built using an instance of an F# exception declaration - - Assumes the given input is an F# exception value. If not, ArgumentException is raised. - The exception instance. - Optional binding flags. - Thrown when the input type is not an F# exception. - The fields from the given exception. - - - Contains operations associated with constructing and analyzing values associated with F# types - such as records, unions and tuples. - - - The integer tag for the case. - - - The name of the case. - - - The type in which the case occurs. - - - The fields associated with the case, represented by a PropertyInfo. - The fields associated with the case. - - - Returns the custom attributes data associated with the case. - An list of custom attribute data items. - - - Returns the custom attributes associated with the case matching the given attribute type. - The type of attributes to return. - An array of custom attributes. - - - Returns the custom attributes associated with the case. - An array of custom attributes. - - - Represents a case of a discriminated union type - - - Returns true if the typ is a representation of an F# exception declaration - The type to check. - Optional flag that denotes accessibility of the private representation. - True if the type check is an F# exception. - - - Reads all the fields from an F# exception declaration, in declaration order - - Assumes exceptionType is an exception representation type. If not, ArgumentException is raised. - The exception type to read. - Optional flag that denotes accessibility of the private representation. - Thrown if the given type is not an exception. - An array containing the PropertyInfo of each field in the exception. - - - Returns true if the typ is a representation of an F# union type or the runtime type of a value of that type - The type to check. - Optional flag that denotes accessibility of the private representation. - True if the type check succeeds. - - - Return true if the typ is a representation of an F# record type - The type to check. - Optional flag that denotes accessibility of the private representation. - True if the type check succeeds. - - - Gets the cases of a union type. - - Assumes the given type is a union type. If not, ArgumentException is raised during pre-computation. - The input union type. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a union type. - An array of descriptions of the cases of the given union type. - - - Reads all the fields from a record value, in declaration order - - Assumes the given input is a record value. If not, ArgumentException is raised. - The input record type. - Optional flag that denotes accessibility of the private representation. - An array of descriptions of the properties of the record type. - - - Reads all the fields from a value built using an instance of an F# exception declaration - - Assumes the given input is an F# exception value. If not, ArgumentException is raised. - The exception instance. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not an F# exception. - The fields from the given exception. - - - A method that constructs objects of the given case - The description of the union case. - Optional flag that denotes accessibility of the private representation. - The description of the constructor of the given union case. - - - Precomputes a function for constructing a discriminated union value for a particular union case. - The description of the union case. - Optional flag that denotes accessibility of the private representation. - A function for constructing values of the given union case. - - - Precomputes a function for reading all the fields for a particular discriminator case of a union type - - Using the computed function will typically be faster than executing a corresponding call to GetFields - The description of the union case to read. - Optional flag that denotes accessibility of the private representation. - A function to for reading the fields of the given union case. - - - Precompute a property or static method for reading an integer representing the case tag of a union type. - The type of union to read. - Optional flag that denotes accessibility of the private representation. - The description of the union case reader. - - - Assumes the given type is a union type. - If not, ArgumentException is raised during pre-computation. - - Using the computed function is more efficient than calling GetUnionCase - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The type of union to optimize reading. - Optional flag that denotes accessibility of the private representation. - An optimized function to read the tags of the given union type. - - - Identify the union case and its fields for an object - - Assumes the given input is a union case value. If not, ArgumentException is raised. - - If the type is not given, then the runtime type of the input object is used to identify the - relevant union type. The type should always be given if the input object may be null. For example, - option values may be represented using the 'null'. - The input union case. - The union type containing the value. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a union case value. - The description of the union case and its fields. - - - Create a union case value. - The description of the union case to create. - The array of arguments to construct the given case. - Optional flag that denotes accessibility of the private representation. - The constructed union case. - - - Get a ConstructorInfo for a record type - The record type. - Optional flag that denotes accessibility of the private representation. - A ConstructorInfo for the given record type. - - - Precompute a function for constructing a record value. - - Assumes the given type is a RecordType. - If not, ArgumentException is raised during pre-computation. - The type of record to construct. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - A function to construct records of the given type. - - - Precompute a function for reading all the fields from a record. The fields are returned in the - same order as the fields reported by a call to Microsoft.FSharp.Reflection.Type.GetInfo for - this type. - - Assumes the given type is a RecordType. - If not, ArgumentException is raised during pre-computation. - - Using the computed function will typically be faster than executing a corresponding call to Value.GetInfo - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The type of record to read. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - An optimized reader for the given record type. - - - Reads all the fields from a record value. - - Assumes the given input is a record value. If not, ArgumentException is raised. - The record object. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - The array of fields from the record. - - - Creates an instance of a record type. - - Assumes the given input is a record type. - The type of record to make. - The array of values to initialize the record. - Optional flags that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - The created record. - - - - A record of options to control structural formatting. - For F# Interactive properties matching those of this value can be accessed via the 'fsi' - value. - - Floating Point format given in the same format accepted by System.Double.ToString, - e.g. f6 or g15. - - If ShowProperties is set the printing process will evaluate properties of the values being - displayed. This may cause additional computation. - - The ShowIEnumerable is set the printing process will force the evalution of IEnumerable objects - to a small, finite depth, as determined by the printing parameters. - This may lead to additional computation being performed during printing. - - <example> - From F# Interactive the default settings can be adjusted using, for example, - <pre> - open Microsoft.FSharp.Compiler.Interactive.Settings;; - setPrintWidth 120;; - </pre> - </example> - - - - - Data representing structured layouts of terms. - - - - - Convert any value to a layout using the given formatting options. The - layout can then be processed using formatting display engines such as - those in the LayoutOps module. any_to_string and output_any are - built using any_to_layout with default format options. - - - - - Ouput any value to a channel using the same set of formatting rules - as any_to_string - - - - - Convert any value to a string using a standard formatter - Data is typically formatted in a structured format, e.g. - lists are formatted using the "[1;2]" notation. - The details of the format are not specified and may change - from version to version and according to the flags given - to the F# compiler. The format is intended to be human-readable, - not machine readable. If alternative generic formats are required - you should develop your own formatter, using the code in the - implementation of this file as a starting point. - - Data from other .NET languages is formatted using a virtual - call to Object.ToString() on the boxed version of the input. - - - - - For limitting layout of list-like sequences (lists,arrays,etc). - unfold a list of items using (project and z) making layout list via itemL. - If reach maxLength (before exhausting) then truncate. - - - - - See tagL - - - - - Layout like an F# list. - - - - - Layout like an F# option. - - - - - Layout list vertically. - - - - - Layout two vertically. - - - - - Form tuple of layouts. - - - - - Wrap braces around layout. - - - - - Wrap square brackets around layout. - - - - - Wrap round brackets around Layout. - - - - - Join layouts into a list separated using the given Layout. - - - - - Join layouts into a semi-colon separated list. - - - - - Join layouts into a space separated list. - - - - - Join layouts into a comma separated list. - - - - - Join broken with ident=2 - - - - - Join broken with ident=1 - - - - - Join broken with ident=0 - - - - - Join, possible break with indent=2 - - - - - Join, possible break with indent=1 - - - - - Join, possible break with indent=0 - - - - - Join, unbreakable. - - - - - An string which is left parenthesis (no space on the right). - - - - - An string which is right parenthesis (no space on the left). - - - - - An string which requires no spaces either side. - - - - - An string leaf - - - - - An uninterpreted leaf, to be interpreted into a string - by the layout engine. This allows leaf layouts for numbers, strings and - other atoms to be customized according to culture. - - - - - Is it the empty layout? - - - - - The empty layout - - - - - A layout is a sequence of strings which have been joined together. - The strings are classified as words, separators and left and right parenthesis. - This classification determines where spaces are inserted. - A joint is either unbreakable, breakable or broken. - If a joint is broken the RHS layout occurs on the next line with optional indentation. - A layout can be squashed to for given width which forces breaks as required. - - - - diff --git a/packages/FAKE.4.11.3/tools/Fake.Deploy.Lib.dll b/packages/FAKE.4.11.3/tools/Fake.Deploy.Lib.dll deleted file mode 100644 index 480a2bd..0000000 Binary files a/packages/FAKE.4.11.3/tools/Fake.Deploy.Lib.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/Fake.Deploy.Lib.dll.config b/packages/FAKE.4.11.3/tools/Fake.Deploy.Lib.dll.config deleted file mode 100644 index 97a1858..0000000 --- a/packages/FAKE.4.11.3/tools/Fake.Deploy.Lib.dll.config +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/tools/Fake.Deploy.Lib.pdb.srcsrv b/packages/FAKE.4.11.3/tools/Fake.Deploy.Lib.pdb.srcsrv deleted file mode 100644 index 811c3d2..0000000 --- a/packages/FAKE.4.11.3/tools/Fake.Deploy.Lib.pdb.srcsrv +++ /dev/null @@ -1,12 +0,0 @@ -SRCSRV: ini ------------------------------------------------ -VERSION=2 -SRCSRV: variables ------------------------------------------ -SRCSRVVERCTRL=https -SRCSRVTRG=https://raw.github.com/fsharp/FAKE/522aa8f1c7128bbee047e3f42deebdc7785cd072/%var2% -SRCSRV: source files --------------------------------------- -C:\code\fake\src\app\Fake.Deploy.Lib\SshRsaModule.fs*src/app/Fake.Deploy.Lib/SshRsaModule.fs -C:\code\fake\src\app\Fake.Deploy.Lib\Json.fs*src/app/Fake.Deploy.Lib/Json.fs -C:\code\fake\src\app\Fake.Deploy.Lib\HttpHeaderHelper.fs*src/app/Fake.Deploy.Lib/HttpHeaderHelper.fs -C:\code\fake\src\app\Fake.Deploy.Lib\HttpListenerHelper.fs*src/app/Fake.Deploy.Lib/HttpListenerHelper.fs -C:\code\fake\src\app\Fake.Deploy.Lib\FakeDeployAgentHelper.fs*src/app/Fake.Deploy.Lib/FakeDeployAgentHelper.fs -SRCSRV: end ------------------------------------------------ diff --git a/packages/FAKE.4.11.3/tools/Fake.Deploy.Lib.xml b/packages/FAKE.4.11.3/tools/Fake.Deploy.Lib.xml deleted file mode 100644 index f654d3f..0000000 --- a/packages/FAKE.4.11.3/tools/Fake.Deploy.Lib.xml +++ /dev/null @@ -1,223 +0,0 @@ - - -Fake.Deploy.Lib - - - - Deployment result type. - - - - - A http response type. - - - - - Authentication token received from a successful login - - - - - Performs a rollback of the given app at the given URL and handles the response. - - - - - Posts a deployment package to the given URL and handles the response. - Deprecated, use DeployPackage - - - - - Posts a deployment package to the given URL, executes the script inside it with given arguments and handles the response. - Deprecated, use DeployPackage - - - - - Posts a deployment package to the given URL, executes the script inside it with given arguments and handles the response. - - - - - Posts a deployment package to the given URL. - - - - - Returns all releases from the given server. - - - - - Returns all releases of the given app from the given server. - - - - - Returns the active release of the given app from the given server. - - - - - Returns all active releases from the given server. - - - - - Performs a rollback of the given app on the server. - - - - - Returns all releases of the given app from the given server. - - - - - Authenticate against the given server with the given userId and private key - - - - - Puts the given body to the given URL. - - - - - Posts the given file to the given URL. - - - - - sends the given body using the given action (POST or PUT) to the given url - - - - - Gets the http response from the given URL and runs it with the given function. - - - - - Contains a http helper functions for FAKE.Deploy. - - - - - Represents a http listener. - - - - - Represents a route result. - - - - - Represents a route. - - - - - Starts a http listener on the given server and port - uses the console logger. - - - - - Starts a http listener on the given server and port. - - - - - Checks whether the http listener can be bound to the given port. - - - - - Returns if the http listener can listen to the given port. - - - - - [omit] - - - - - Creates an empty http listener. - - - - - Returns the specified port from the config or the first free port if no port was specified. - - - - - Returns the first free port which can be used for the http listener. - - - - - [omit] - - - - - Matches an URL with the given routes. - - - - - [omit] - - - - - Creates routes for the http listener. - - - - - Contains the default routes. - - - - - [omit] - - - - - [omit] - - - - - Contains basic HTTP listener functions for FAKE.Deploy. - - - - - Deserializes a file into a object of type 'a - - - - - Deserializes a text into a object of type 'a - - - - - Serializes a object to json - - - - - Contains extensions for Newtonsoft.Json. **Don't use it directly. It's likely to be changed in further versions.** - - - - diff --git a/packages/FAKE.4.11.3/tools/Fake.Deploy.exe b/packages/FAKE.4.11.3/tools/Fake.Deploy.exe deleted file mode 100644 index f7bc7a4..0000000 Binary files a/packages/FAKE.4.11.3/tools/Fake.Deploy.exe and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/Fake.Deploy.exe.config b/packages/FAKE.4.11.3/tools/Fake.Deploy.exe.config deleted file mode 100644 index 647ed56..0000000 --- a/packages/FAKE.4.11.3/tools/Fake.Deploy.exe.config +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/packages/FAKE.4.11.3/tools/Fake.Deploy.pdb.srcsrv b/packages/FAKE.4.11.3/tools/Fake.Deploy.pdb.srcsrv deleted file mode 100644 index 9101a67..0000000 --- a/packages/FAKE.4.11.3/tools/Fake.Deploy.pdb.srcsrv +++ /dev/null @@ -1,20 +0,0 @@ -SRCSRV: ini ------------------------------------------------ -VERSION=2 -SRCSRV: variables ------------------------------------------ -SRCSRVVERCTRL=https -SRCSRVTRG=https://raw.github.com/fsharp/FAKE/522aa8f1c7128bbee047e3f42deebdc7785cd072/%var2% -SRCSRV: source files --------------------------------------- -C:\code\fake\src\app\Fake.Deploy\AppConfig.fs*src/app/Fake.Deploy/AppConfig.fs -C:\code\fake\src\app\Fake.Deploy\Logger.fs*src/app/Fake.Deploy/Logger.fs -C:\code\fake\src\app\Fake.Deploy\DeploymentHelper.fs*src/app/Fake.Deploy/DeploymentHelper.fs -C:\code\fake\src\app\Fake.Deploy\DeployAgentModule.fs*src/app/Fake.Deploy/DeployAgentModule.fs -C:\code\fake\src\app\Fake.Deploy\DeploymentAgent.fs*src/app/Fake.Deploy/DeploymentAgent.fs -C:\code\fake\src\app\Fake.Deploy\AuthenticatedUser.fs*src/app/Fake.Deploy/AuthenticatedUser.fs -C:\code\fake\src\app\Fake.Deploy\UserMapper.fs*src/app/Fake.Deploy/UserMapper.fs -C:\code\fake\src\app\Fake.Deploy\AuthModule.fs*src/app/Fake.Deploy/AuthModule.fs -C:\code\fake\src\app\Fake.Deploy\JSonSerializers.fs*src/app/Fake.Deploy/JSonSerializers.fs -C:\code\fake\src\app\Fake.Deploy\NancyBootStrapper.fs*src/app/Fake.Deploy/NancyBootStrapper.fs -C:\code\fake\src\app\Fake.Deploy\Services.fs*src/app/Fake.Deploy/Services.fs -C:\code\fake\src\app\Fake.Deploy\Installers.fs*src/app/Fake.Deploy/Installers.fs -C:\code\fake\src\app\Fake.Deploy\Program.fs*src/app/Fake.Deploy/Program.fs -SRCSRV: end ------------------------------------------------ diff --git a/packages/FAKE.4.11.3/tools/Fake.Experimental.dll b/packages/FAKE.4.11.3/tools/Fake.Experimental.dll deleted file mode 100644 index c0ea1c0..0000000 Binary files a/packages/FAKE.4.11.3/tools/Fake.Experimental.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/Fake.Experimental.pdb.srcsrv b/packages/FAKE.4.11.3/tools/Fake.Experimental.pdb.srcsrv deleted file mode 100644 index db826ea..0000000 --- a/packages/FAKE.4.11.3/tools/Fake.Experimental.pdb.srcsrv +++ /dev/null @@ -1,8 +0,0 @@ -SRCSRV: ini ------------------------------------------------ -VERSION=2 -SRCSRV: variables ------------------------------------------ -SRCSRVVERCTRL=https -SRCSRVTRG=https://raw.github.com/fsharp/FAKE/522aa8f1c7128bbee047e3f42deebdc7785cd072/%var2% -SRCSRV: source files --------------------------------------- -C:\code\fake\src\app\Fake.Experimental\ComputationExpressions.fs*src/app/Fake.Experimental/ComputationExpressions.fs -SRCSRV: end ------------------------------------------------ diff --git a/packages/FAKE.4.11.3/tools/Fake.FluentMigrator.dll b/packages/FAKE.4.11.3/tools/Fake.FluentMigrator.dll deleted file mode 100644 index 2411430..0000000 Binary files a/packages/FAKE.4.11.3/tools/Fake.FluentMigrator.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/Fake.FluentMigrator.pdb.srcsrv b/packages/FAKE.4.11.3/tools/Fake.FluentMigrator.pdb.srcsrv deleted file mode 100644 index 0b42a25..0000000 --- a/packages/FAKE.4.11.3/tools/Fake.FluentMigrator.pdb.srcsrv +++ /dev/null @@ -1,8 +0,0 @@ -SRCSRV: ini ------------------------------------------------ -VERSION=2 -SRCSRV: variables ------------------------------------------ -SRCSRVVERCTRL=https -SRCSRVTRG=https://raw.github.com/fsharp/FAKE/522aa8f1c7128bbee047e3f42deebdc7785cd072/%var2% -SRCSRV: source files --------------------------------------- -C:\code\fake\src\app\Fake.FluentMigrator\FluentMigratorHelper.fs*src/app/Fake.FluentMigrator/FluentMigratorHelper.fs -SRCSRV: end ------------------------------------------------ diff --git a/packages/FAKE.4.11.3/tools/Fake.Gallio.dll b/packages/FAKE.4.11.3/tools/Fake.Gallio.dll deleted file mode 100644 index 280aaa8..0000000 Binary files a/packages/FAKE.4.11.3/tools/Fake.Gallio.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/Fake.Gallio.pdb.srcsrv b/packages/FAKE.4.11.3/tools/Fake.Gallio.pdb.srcsrv deleted file mode 100644 index 850f172..0000000 --- a/packages/FAKE.4.11.3/tools/Fake.Gallio.pdb.srcsrv +++ /dev/null @@ -1,8 +0,0 @@ -SRCSRV: ini ------------------------------------------------ -VERSION=2 -SRCSRV: variables ------------------------------------------ -SRCSRVVERCTRL=https -SRCSRVTRG=https://raw.github.com/fsharp/FAKE/522aa8f1c7128bbee047e3f42deebdc7785cd072/%var2% -SRCSRV: source files --------------------------------------- -C:\code\fake\src\app\Fake.Gallio\GallioHelper.fs*src/app/Fake.Gallio/GallioHelper.fs -SRCSRV: end ------------------------------------------------ diff --git a/packages/FAKE.4.11.3/tools/Fake.IIS.dll b/packages/FAKE.4.11.3/tools/Fake.IIS.dll deleted file mode 100644 index 3355018..0000000 Binary files a/packages/FAKE.4.11.3/tools/Fake.IIS.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/Fake.IIS.pdb.srcsrv b/packages/FAKE.4.11.3/tools/Fake.IIS.pdb.srcsrv deleted file mode 100644 index 1087d12..0000000 --- a/packages/FAKE.4.11.3/tools/Fake.IIS.pdb.srcsrv +++ /dev/null @@ -1,9 +0,0 @@ -SRCSRV: ini ------------------------------------------------ -VERSION=2 -SRCSRV: variables ------------------------------------------ -SRCSRVVERCTRL=https -SRCSRVTRG=https://raw.github.com/fsharp/FAKE/522aa8f1c7128bbee047e3f42deebdc7785cd072/%var2% -SRCSRV: source files --------------------------------------- -C:\code\fake\src\app\Fake.IIS\IISExpress.fs*src/app/Fake.IIS/IISExpress.fs -C:\code\fake\src\app\Fake.IIS\IISHelper.fs*src/app/Fake.IIS/IISHelper.fs -SRCSRV: end ------------------------------------------------ diff --git a/packages/FAKE.4.11.3/tools/Fake.SQL.dll b/packages/FAKE.4.11.3/tools/Fake.SQL.dll deleted file mode 100644 index 66be8fb..0000000 Binary files a/packages/FAKE.4.11.3/tools/Fake.SQL.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/Fake.SQL.pdb.srcsrv b/packages/FAKE.4.11.3/tools/Fake.SQL.pdb.srcsrv deleted file mode 100644 index f1c388c..0000000 --- a/packages/FAKE.4.11.3/tools/Fake.SQL.pdb.srcsrv +++ /dev/null @@ -1,8 +0,0 @@ -SRCSRV: ini ------------------------------------------------ -VERSION=2 -SRCSRV: variables ------------------------------------------ -SRCSRVVERCTRL=https -SRCSRVTRG=https://raw.github.com/fsharp/FAKE/522aa8f1c7128bbee047e3f42deebdc7785cd072/%var2% -SRCSRV: source files --------------------------------------- -C:\code\fake\src\app\Fake.SQL\SQLServer.fs*src/app/Fake.SQL/SQLServer.fs -SRCSRV: end ------------------------------------------------ diff --git a/packages/FAKE.4.11.3/tools/FakeLib.XML b/packages/FAKE.4.11.3/tools/FakeLib.XML deleted file mode 100644 index 34b5323..0000000 --- a/packages/FAKE.4.11.3/tools/FakeLib.XML +++ /dev/null @@ -1,12567 +0,0 @@ - - -FakeLib - - - - Defines a conditional dependency - y is dependent on x if the condition is true - - - - - Defines that x and y are not dependent on each other but y is dependent on all dependencies of x. - - - - - Defines a soft dependency. x must run before y, if it is present, but y does not require x to be run. - - - - - Defines a soft dependency. x must run before y, if it is present, but y does not require x to be run. - - - - - Defines a dependency - y is dependent on x - - - - - Specifies that two targets have the same dependencies - - - - - Specifies that two targets have the same dependencies - - - - - Specifies that two targets are on the same level of execution - - - - - Stores which targets are on the same level - - - - - Runs the target given by the target parameter - - - - - Runs the target given by the target parameter or lists the available targets - - - - - Runs the target given by the target parameter or the given default target - - - - - Runs the target given by the build script parameter or the given default target - - - - - Runs a Target and its dependencies - - - - - Appends the dependency to the list of dependencies - - - - - Converts a dependency into a list - - - - - Allows to use For? syntax for Dependencies - - - - - Allows to use Tokens instead of strings for TargetNames - - - - - Allows to use Tokens instead of strings - - - - - Provides functions and operators to deal with FAKE targets and target dependencies. - - - - - Union type representing the available test result formats accepted by AppVeyor. - - - - - contains tag name for builds started by tag - - - - - true if build has started by pushed tag; otherwise false - - - - - git or mercurial - - - - - GitHub, BitBucket or Kiln - - - - - Repository name in format owner-name/repo-name - - - - - Commit date/time - - - - - The rest of the commit message after line break (if exists) - - - - - Commit message - - - - - Commit author's email address - - - - - Commit author's name - - - - - Commit ID (SHA) - - - - - Build branch - - - - - GitHub Pull Request title - - - - - GitHub Pull Request number - - - - - Project slug (as seen in project details URL) - - - - - Project name - - - - - AppVeyor unique project ID - - - - - Platform name set on Build tab of project settings (or through platform parameter in appveyor.yml). - - - - - The job name - - - - - AppVeyor unique job ID - - - - - If the build runs by scheduler; - - - - - If the build has been started by the "Re-Build commit/PR" button or from the same API - - - - - If the build has been started by the "New Build" button or from the same API - - - - - Configuration name set on Build tab of project settings (or through configuration parameter in appveyor.yml). - - - - - Build version - - - - - Build number - - - - - AppVeyor unique build ID - - - - - Path to clone directory - - - - - AppVeyor Build Agent API URL - - - - - AppVeyor Account Name - - - - - AppVeyor environment variables as [described](http://www.appveyor.com/docs/environment-variables) - - - - - Uploads all the test results ".xml" files in a directory to make them visible in Test tab of the build console. - - - - - Finishes the test case. - - - - - Reports a succeeded test. - - - - - Ignores the test case. - - - - - Reports a failed test. - - - - - Starts the test case. - - - - - Starts the test suite. - - - - - Finishes the test suite. - - - - - Contains code to configure FAKE for AppVeyor integration - - - - - A description of a file to be added to an archive. - - - - - Constructs a file specification which will archive the file with a path relative to the `baseDir`. - - - - - Constructs a file specification which will archive the file at the root. - - - - - Creates a tar.gz archive containing all the files in a directory. - ## Parameters - - `baseDir` - The base directory to be archived. This directory will be the root of the resulting archive. - - `archiveFile` - The output archive file. If existing, will be overwritten. - - - - - Creates a tar archive containing all the files in a directory. - ## Parameters - - `flatten` - If set to true then all subfolders are merged into the root folder of the archive. - - `baseDir` - The base directory to be archived. This directory will be the root of the resulting archive. - - `archiveFile` - The output archive file. If existing, will be overwritten. - - - - - Creates a tar archive with the given files with default parameters. - ## Parameters - - `baseDir` - The relative directory of the files to be archived. Use this parameter to influence directory structure within the archive. - - `archiveFile` - The output archive file. If existing, will be overwritten. - - `files` - A sequence of files to store. - - - - - Creates a tar archive with the given archive file specifications. - ## Parameters - - `archiveFile` - The output archive file. If existing, will be overwritten. - - `fileSpecs` - A sequence of archive file specifications. - - - - - Creates a tar archive with the given files. - ## Parameters - - `flatten` - If set to true then all subfolders are merged into the root folder of the archive. - - `baseDir` - The relative directory of the files to be archived. Use this parameter to influence directory structure within the archive. - - `archiveFile` - The output archive file. If existing, will be overwritten. - - `files` - A sequence of files to store. - - - - - Extracts a tar archive to a given directory. - ## Parameters - - `targetDir` - The directory into which the archived files will be extracted. - - `archiveFile` - The archive to be extracted. - - - - - Constructs a function that will create a tar archive from a set of files. - - - - - Creates a `TarOutputStream` wrapping a file using the given parameters. - ## Parameters - - `file` - The `FileInfo` describing the location to which the archive should be written. Will be overwritten if it exists. - - - - - Wraps an input stream with a tar container extractor. - - - - - Wraps an output stream with a tar container store. - - - - - Adds a file, specified by an `ArchiveFileSpec`, to a `TarOutputStream`. - - - - - Creates a tar.bz2 archive containing all the files in a directory. - ## Parameters - - `baseDir` - The base directory to be compressed. This directory will be the root of the resulting archive. - - `archiveFile` - The output archive file. If existing, will be overwritten. - - - - - Creates a tar.bz2 archive containing all the files in a directory. - ## Parameters - - `flatten` - If set to true then all subfolders are merged into the root folder of the archive. - - `baseDir` - The base directory to be compressed. This directory will be the root of the resulting archive. - - `archiveFile` - The output archive file. If existing, will be overwritten. - - - - - Creates a tar.bz2 archive with the given files with default parameters. - ## Parameters - - `baseDir` - The relative directory of the files to be compressed. Use this parameter to influence directory structure within the archive. - - `archiveFile` - The output archive file. If existing, will be overwritten. - - `files` - A sequence of files to compress. - - - - - Creates a tar.bz2 archive with the given archive file specifications. - ## Parameters - - `archiveFile` - The output archive file. If existing, will be overwritten. - - `fileSpecs` - A sequence of archive file specifications. - - - - - Creates a tar.bz2 archive with the given files. - ## Parameters - - `flatten` - If set to true then all subfolders are merged into the root folder of the archive. - - `baseDir` - The relative directory of the files to be compressed. Use this parameter to influence directory structure within the archive. - - `archiveFile` - The output archive file. If existing, will be overwritten. - - `files` - A sequence of files to compress. - - - - - Extracts a tar.bz2 archive to a given directory. - ## Parameters - - `extractDir` - The directory into which the archived files will be extracted. - - `archiveFile` - The archive to be extracted. - - - - - Constructs a function that will create a tar.bz2 archive from a set of files. - - - - - Creates a `TarOutputStream` wrapping a file. - ## Parameters - - `file` - The `FileInfo` describing the location to which the archive should be written. Will be overwritten if it exists. - - - - - Wraps an input stream with a tar.gz decompressor. - - - - - Wraps an output stream with a tar.bz2 compressor. - - - - - Operations and tasks for working with tar archives compressed with BZip2. - - - - - Creates a tar.gz archive containing all the files in a directory. - ## Parameters - - `baseDir` - The base directory to be compressed. This directory will be the root of the resulting archive. - - `archiveFile` - The output archive file. If existing, will be overwritten. - - - - - Creates a tar.gz archive containing all the files in a directory. - ## Parameters - - `setParams` - A function which modifies the default compression parameters. - - `flatten` - If set to true then all subfolders are merged into the root folder of the archive. - - `baseDir` - The base directory to be compressed. This directory will be the root of the resulting archive. - - `archiveFile` - The output archive file. If existing, will be overwritten. - - - - - Creates a tar.gz archive with the given files with default parameters. - ## Parameters - - `baseDir` - The relative directory of the files to be compressed. Use this parameter to influence directory structure within the archive. - - `archiveFile` - The output archive file. If existing, will be overwritten. - - `files` - A sequence of files to compress. - - - - - Creates a tar.gz archive with the given archive file specifications. - ## Parameters - - `setParams` - A function which modifies the default compression parameters. - - `archiveFile` - The output archive file. If existing, will be overwritten. - - `fileSpecs` - A sequence of archive file specifications. - - - - - Creates a tar.gz archive with the given files. - ## Parameters - - `setParams` - A function which modifies the default compression parameters. - - `flatten` - If set to true then all subfolders are merged into the root folder of the archive. - - `baseDir` - The relative directory of the files to be compressed. Use this parameter to influence directory structure within the archive. - - `archiveFile` - The output archive file. If existing, will be overwritten. - - `files` - A sequence of files to compress. - - - - - Extracts a tar.gz archive to a given directory. - ## Parameters - - `extractDir` - The directory into which the archived files will be extracted. - - `archiveFile` - The archive to be extracted. - - - - - Constructs a function that will create a tar.gz archive from a set of files. - - - - - Creates a `TarOutputStream` wrapping a file using the given parameters. - ## Parameters - - `gzipParams` - The gzip compression parameters. - - `file` - The `FileInfo` describing the location to which the archive should be written. Will be overwritten if it exists. - - - - - Wraps an input stream with a tar.gz decompressor. - - - - - Wraps an output stream with a tar.gz compressor. - - - - - Operations and tasks for working with tar archives compressed with GZip. - - - - - Operations and tasks for working with tar archives. - - - - - Compresses a file using bzip2. - ## Parameters - - `outFile` - The compressed output file. If existing, will be overwritten. - - `file` - The file to be compressed. - - - - - Extracts a file compressed with bzip2. - ## Parameters - - `outFile` - The extracted output file. If existing, will be overwritten. - - `file` - The compressed file. - - - - - Creates a `BZip2OutputStream` wrapping a file. - ## Parameters - - `file` - The `FileInfo` describing the location to which the compressed file should be written. Will be overwritten if it exists. - - - - - Wraps an input stream with a bzip2 decompressor. - - - - - Wraps an output stream with a bzip2 compressor. - - - - - Operations and tasks for working with gzip compressed files. - - - - - The gzip archive compression parameters. - - - - - Compresses a file using gzip. - ## Parameters - - `outFile` - The compressed output file. If existing, will be overwritten. - - `file` - The file to be compressed. - - - - - Compresses a file using gzip. - ## Parameters - - `setParams` - A function which modifies the default compression parameters. - - `outFile` - The compressed output file. If existing, will be overwritten. - - `file` - The file to be compressed. - - - - - Extracts a file compressed with gzip. - ## Parameters - - `outFile` - The extracted output file. If existing, will be overwritten. - - `file` - The compressed file. - - - - - Creates a `GZipOutputStream` wrapping a file using the given parameters. - ## Parameters - - `gzipParams` - The gzip compression parameters. - - `file` - The `FileInfo` describing the location to which the compressed file should be written. Will be overwritten if it exists. - - - - - Wraps an input stream with a zip decompressor. - - - - - Wraps an output stream with a gzip compressor. - - - - - The default gzip archive compression parameters - ## Defaults - - `Level` - `CompressionLevel.Default` - - - - - Operations and tasks for working with gzip compressed files. - - - - - The zip archive compression parameters. - - - - - Creates a zip archive containing all the files in a directory. - ## Parameters - - `baseDir` - The base directory to be compressed. This directory will be the root of the resulting archive. - - `archiveFile` - The output archive file. If existing, will be overwritten. - - - - - Creates a zip archive containing all the files in a directory. - ## Parameters - - `setParams` - A function which modifies the default compression parameters. - - `flatten` - If set to true then all subfolders are merged into the root folder of the archive. - - `baseDir` - The base directory to be compressed. This directory will be the root of the resulting archive. - - `archiveFile` - The output archive file. If existing, will be overwritten. - - - - - Creates a zip archive with the given files with default parameters. - ## Parameters - - `baseDir` - The relative directory of the files to be compressed. Use this parameter to influence directory structure within the archive. - - `archiveFile` - The output archive file. If existing, will be overwritten. - - `files` - A sequence of files to compress. - - - - - Creates a zip archive with the given archive file specifications. - ## Parameters - - `setParams` - A function which modifies the default compression parameters. - - `archiveFile` - The output archive file. If existing, will be overwritten. - - `fileSpecs` - A sequence of archive file specifications. - - - - - Creates a zip archive with the given files. - ## Parameters - - `setParams` - A function which modifies the default compression parameters. - - `flatten` - If set to true then all subfolders are merged into the root folder of the archive. - - `baseDir` - The relative directory of the files to be compressed. Use this parameter to influence directory structure within the archive. - - `archiveFile` - The output archive file. If existing, will be overwritten. - - `files` - A sequence of files to compress. - - - - - Extracts a zip archive to a given directory. - ## Parameters - - `extractDir` - The directory into which the archived files will be extracted. - - `archiveFile` - The archive to be extracted. - - - - - Constructs a function that will create a zip archive from a set of files. - - - - - Creates a `ZipOutputStream` wrapping a file using the given parameters. - ## Parameters - - `zipParams` - The zip compression parameters. - - `file` - The `FileInfo` describing the location to which the archive should be written. Will be overwritten if it exists. - - - - - Wraps an input stream with a zip decompressor. - - - - - Wraps an output stream with a zip compressor. - - - - - Adds a file, specified by an `ArchiveFileSpec`, to a `ZipOutputStream`. - - - - - The default zip archive compression parameters - ## Defaults - - `Level` - `CompressionLevel.Default` - - `Comment` - `None` - - - - - Operations and tasks for working with zip archives. - - - - - Defines the compression level type. - - - - - Retrieves the numeric compression level. - - - - - Constructs a `CompressionLevel`. Level is clipped to a value between 0 and 9. - - - - - The default compression level. - - - - - Provides validation of comression levels used for the zip and gzip compression algorithms. - - - - - Provides utility tasks for storing and compressing files in archives. - - - - - Creates an attribute which holds the assembly version - - - - - Creates an attribute which holds the trademark - - - - - Creates an attribute which holds the product title - - - - - Creates a simple attribute with string values. Used as base for other attributes - - - - - Creates an attribute which holds the product name - - - - - Create an attribute which specifies metadata about the assembly - - - - - Creates an attribute which holds the assembly key name - - - - - Creates an attribute which holds the assembly key file - - - - - Creates an attribute which holds the "InternalVisibleTo" data - - - - - Creates an attribute which holds an assembly information version - - - - - Creates an attribute which holds the Guid - - - - - Creates an attribute which holds the assembly file version - - - - - Creates an attribute which holds the product description - - - - - Creates an attribute which specifies if the assembly uses delayed signing - - - - - Creates an attribute which holds the assembly culture information - - - - - Creates an attribute which holds the copyright information - - - - - Creates an attribute which holds the assembly configuration - - - - - Creates an attribute which holds the company information - - - - - Creates an attribute which specifies if the assembly is visible via COM - - - - - Creates an attribute which specifies if the assembly is CLS compliant - - - - - Creates a simple attribute with boolean values. Used as base for other attributes - - - - - Represents AssemblyInfo attributes - - - - - Represents options for configuring the emission of AssemblyInfo - - - - - Creates a C++/CLI AssemblyInfo file with the given attributes. - - - - - Creates a VB AssemblyInfo file with the given attributes. - The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly. - - - - - Creates a F# AssemblyInfo file with the given attributes. - The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly. - - - - - Creates a C# AssemblyInfo file with the given attributes. - The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly. - - - - - Creates a C++/CLI AssemblyInfo file with the given attributes and configuration. - Does not generate an AssemblyVersionInformation class. - - - - - Creates a VB AssemblyInfo file with the given attributes and configuration. - The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly. - - - - - Creates a F# AssemblyInfo file with the given attributes and configuration. - The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly. - - - - - Creates a C# AssemblyInfo file with the given attributes and configuration. - The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly. - - - - - Contains tasks to generate AssemblyInfo files for C# and F#. - There is also a tutorial about the [AssemblyInfo tasks](../assemblyinfo.html) available. - - - - - Update all AssemblyInfo.[fs|cs|vb] files in the specified directory and its subdirectories - ## Parameters - - - 'dir' - The directory (subdirectories will be included), which inhabits the AssemblyInfo files. - - 'replacementParameters' - The replacement parameters for the AssemblyInfo files. - - ## Sample - - BulkReplaceAssemblyInfoVersions "test/" (fun f -> - {f with - AssemblyVersion = "1.1.1.1" - AssemblyInformationalVersion = "1.1.1.1"}) - - - - - AssemblyInfoReplacement default params - - - - - Generates an AssemblyInfo file for projects - **Obsolete - Please use the new AssemblyInfoFile tasks** - - - - - generates the assembly info file - - - - - AssemblyInfo default params - - - - - Generates an AssemblyInfo file - - - - - The output path for the .cspkg. - - - - - The SDK version to use e.g. 2.2. If None, the latest available version is used. - - - - - The name of the role in the service. - - - - - The name of the Cloud Service. - - - - - Configuration details for packaging cloud services. - - - - - Packages a cloud service role into a .cspkg, ready for deployment. - - - - - Modifies the size of the Worker Role in the csdef. - - - - - Contains tasks to package Azure Cloud Services. - - - - - The webjobs to deploy to this web site - - - - - The FTP Password - - - - - The FTP username, usually the $username from the site's publish profile - - - - - The url of the website, usually in the format of https://<yourwebsite>.scm.azurewebsites.net - - - - - The website that webjobs are deployed to - - - - - The package path to once zipped - - - - - The directory path of the webjob to zip - - - - - The project to be zipped and deployed as a webjob - - - - - Specifies what type of webjob this is. Note that this also determines it's deployment location on Azure - - - - - The name of the web job, this will also be the name out of zip file. - - - - - WebJob type - - - - - The running modes of webjobs - - - - - This task to can be used deploy a prebuilt webjob zip to a website - ## Parameters - - - `webSites` - The websites and webjobs to deploy. - - - - - This task to can be used create a zip for each webjob to deploy to a website - The output structure is: `outputpath/{websitename}/webjobs/{continuous/triggered}/{webjobname}.zip` - ## Parameters - - - `webSites` - The websites and webjobs to build zips from. - - - - - Contains tasks to package and deploy [Azure Web Jobs](http://azure.microsoft.com/en-gb/documentation/articles/web-sites-create-web-jobs/) via the [Kudu](https://github.com/projectkudu/kudu) Zip controller - - - - - A type for the controlling parameter - - - - - Resets the devstore (BLOB, Queues and Tables) - - - - - Starts the compute emulator - - - - - Stops the compute emulator - - - - - Starts the storage emulator - - - - - Stops the storage emulator - - - - - The default parameter of emulator - - - - - Contains tasks to control the local Azure Emulator - - - - - Runs the handler with the default environment. - - - - - Represents a command line handler. - - - - - The default environment. - - - - - Abstracts over command-line environment features. - - - - - Stage of execution for a boot system. - - - - - The full path to the root folder. - - - - - The URL of the NuGet source to use. - - - - - Full path to the `packages` directory for storing NuGet packages. - - - - - List of automatically installed and NuGet dependencies. - - - - - The credentials to use when authenticating to NuGet, if any. - - - - - Full path to the auto-generated fsx file with include statements. - - - - - Framework name for assembly resolution. - - - - - The default configuration for a given source directory. - - - - - Configures the boostrapping process. - - - - - The version specification. - - - - - The identifer of the package, such as "FAKE". - - - - - The default pacakage dependency - take latest including pre-release. - - - - - Specifies NuGet package dependencies. - - - - - Pick the given semantic version, such as "2.1.170-alpha". - - - - - Pick the latest available version, including pre-release versions. - - - - - Pick the latest available version. - - - - - Specifies which version of the NuGet package to install. - - - - - The main function intended to be executed in the BOOT phase of - boostrapping scripts. - - - - - Detects boot-specific commands. - - - - - Creates the CommandHandler from the - - - - - Checks if the F# script file is a bootstrapping script. - - - - - Computes extra command-line arguments to enable bootstrapping FAKE scripts. - - - - - Implements support for boostrapping FAKE scripts. A bootstrapping - `build.fsx` script executes twice (in two stages), allowing to - download dependencies with NuGet and do other preparatory work in - the first stage, and have these dependencies available in the - second stage. - - - - - The trace mode option. - - - - - The server type option. - - - - - Is true when the current build is a local build. - - - - - The current build version as detected from the current build server. - - - - - The current build server - - - - - AppVeyor build number - [omit] - - - - - CruiseControl.NET Build label - [omit] - - - - - Build number retrieved from Jenkins - [omit] - - - - - Build number retrieved from GitLab CI - [omit] - - - - - Checks if we are on GitLab CI - [omit] - - - - - Build number retrieved from Travis - [omit] - - - - - Build number retrieved from TeamCity - [omit] - - - - - Build number retrieved from Team Foundation - [omit] - - - - - Checks if we are on Team Foundation - [omit] - - - - - Checks if we are on Bamboo - [omit] - - - - - Build number retrieved from Bamboo - [omit] - - - - - Defines the XML output file - used for build servers like CruiseControl.NET. - This output file can be specified by using the *logfile* build parameter. - - - - - A constant label for local builds - [omit] - - - - - Defines if FAKE will use verbose tracing. - This flag can be specified by setting the *verbose* build parameter. - - - - - Contains functions which allow build scripts to interact with a build server. - - - - - A character string containing additional arguments to give to CMake. - - - - - The CMake execution timeout. - - - - - The build configuration to use (e.g. `Release`). - Equivalent to the `--config <cfg>` option. - Not supported by every generator. - - - - - The CMake target to build instead of the default one. - Equivalent to the `--target <target>` option. - - - - - The binary build directory where CMake will generate the files. - - - - - The location of the CMake executable. Automatically found if null or empty. - - - - - The CMakeBuild parameter type. - - - - - A character string containing additional arguments to give to CMake. - - - - - The CMake execution timeout. - - - - - Remove matching entries from CMake cache. - Equivalent to the `-U <globbing_expr>` options. - - - - - A list of every variable to pass as a CMake argument. - Equivalent to the `-D <var>:<type>=<value>` options. - - - - - The directory where CMake will install the generated files. - Equivalent to the `-D CMAKE_INSTALL_PREFIX:DIRPATH="<install-directory>"` CMake option. - - - - - A list of the optional CMake cache files to load. - Equivalent to the `-C <initial-cache>` options. - - - - - An optional CMake platform. - Equivalent to the `-A <platform-name>` option. - Not supported by every generator. - - - - - An optional toolset (!= toolchain) to use. - Equivalent to the `-T <toolset-name>` option. - Not supported by every generator. - - - - - The native build system generator to use for writing the files. - See `cmake --help` for a list of the available entries. - *To avoid unpredictable generator usage, it is recommended to define it.* - Equivalent to the `-G <generator-name>` option. - - - - - An optional toolchain file to load. - Equivalent to the `-D CMAKE_TOOLCHAIN_FILE:FILEPATH="<toolchain-file>"` CMake option. - - - - - The binary build directory where CMake will generate the files. - - - - - The source directory which should include a `CMakeLists.txt` file. - - - - - The location of the CMake executable. Automatically found if null or empty. - - - - - The CMakeGenerate parameter type. - - - - - The value of the variable. - Will be automatically converted to the CMake format when required. - - - - - The name of the variable. - It cannot contains spaces and special characters. - - - - - A CMake variable. - - - - - The possible variable value types for CMake variables. - - - - - Calls `cmake --build` to build a project. - ## Parameters - - `setParams` - Function used to manipulate the default CMake parameters. See `CMakeBuildParams`. - - - - - Calls `cmake` to generate a project. - ## Parameters - - `setParams` - Function used to manipulate the default CMake parameters. See `CMakeGenerateParams`. - - - - - [omit] - Invokes the CMake executable with the specified arguments. - ## Parameters - - `toolPath` - The location of the executable. Automatically found if null or empty. - - `binaryDir` - The location of the binary directory. - - `args` - The arguments given to the executable. - - `timeout` - The CMake execution timeout - - - - - [omit] - Converts a file path to a valid CMake format. - ## Parameters - - `path` - The path to reformat. - - - - - [omit] - Tries to find the specified CMake executable: - - 1. Locally in `./<tools|packages>/<cmake.portable>|<cmake>/bin` - 3. In the `PATH` environment variable. - 4. In the `<ProgramFilesx86>\CMake\bin` directory. - ## Parameters - - `exeName` - The name of the CMake executable (e.g. `cmake`, `ctest`, etc.) to find. - The `.exe` suffix will be automatically appended on Windows. - - - - - The default option set given to CMakeBuild. - - - - - The default option set given to CMakeGenerate. - - - - - Contains tasks which allow to use CMake to build CMakeLists files. - See `Samples/CMakeSupport` for usage examples. - - - - - Looks for a key in the cache. - If it is not found the newValueF function is executed and the result is stored in the cache. - - - - - Contains functions which allows to deal with a cache. - - - - - Watches the for changes in the matching files. - Returns an IDisposable which allows to dispose all FileSystemWatchers. - - ## Parameters - - `onChange` - function to call when a change is detected. - - `fileIncludes` - The glob pattern for files to watch for changes. - - ## Sample - - Target "Watch" (fun _ -> - use watcher = !! "c:/projects/watchDir/*.txt" |> WatchChanges (fun changes -> - // do something - ) - - System.Console.ReadLine() |> ignore - - watcher.Dispose() // if you need to cleanup the watches. - ) - - - - - - This module contains helpers to react to file system events. - - - - - Applies a Xsl Stylesheet to a config file and writes it back. - ## Parameters - - `xsl` - The Xsl stylesheet to apply. - - `fileName` - The file name of the config file. - - ## Sample - - applyXslOnConfig (navServicePath @@ DEV.xsl) (navServicePath @@ "CustomSettings.config") - - - - - Reads a config file from the given file name, replaces the connection string value and writes it back. - ## Parameters - - `connectionStringKey` - The connection string key name for which the value should be replaced. - - `value` - The new connection string value. - - `fileName` - The file name of the config file. - - - - - Reads a config file from the given file name, replaces the Application Setting (as opposed to AppSetting) value and writes it back. - ## Parameters - - `settingName` - The ApplicationSetting name for which the value should be replaced. - - `value` - The new ApplicationSetting value. - - `fileName` - The file name of the config file. - - ## Sample - - updateApplicationSetting "DatabaseName" targetDatabase (navServicePath @@ "CustomSettings.config") - - - - - Reads a config file from the given file name, replaces the app setting value and writes it back. - ## Parameters - - `key` - The AppSettings attribute key name for which the value should be replaced. - - `value` - The new AppSettings attribute value. - - `fileName` - The file name of the config file. - - ## Sample - - updateAppSetting "DatabaseName" targetDatabase (navServicePath @@ "CustomSettings.config") - - - - - Reads a config file from the given file name, replaces an attribute using the given xPath and writes it back. - ## Parameters - - `fileName` - The file name of the config file. - - `xpath` - An XPath term which can be used to replace the attribute. - - `attribute` - The attribute name for which the value should be replaced. - - `value` - The new attribute value. - - - - - Reads a config file from the given file name, replaces an attribute using the given xPath and writes it back. - ## Parameters - - `xpath` - An XPath term which can be used to replace the attribute. - - `attribute` - The attribute name for which the value should be replaced. - - `value` - The new attribute value. - - `config` - The XElement representing the config. - - - - - Writes an XmlDocument to a config file. - ## Parameters - - `fileName` - The file name of the config file. - - `config` - The XmlDocument representing the config. - - - - - Reads a config file into an XmlDocument. - ## Parameters - - `fileName` - The file name of the config file. - - - - - Contains functions which allow to read and write config files. - - - - - Specifies other params for the compilation. Freeform strings. - - - - - Specifies whether to emit debug information (default is false). - - - - - Specifies assemblies to reference for the compilation. - - - - - Specifies the compiled artifact target platform. - - - - - Specifies the compiled artifact target type. - - - - - Specifies the tool path to csc.exe. - - - - - Specifies the output file name and path. - - - - - The default parameters to the compiler. - - - - - Compiler parameters - - - - - Supported platforms - - - - - Supported output types - - - - - Compiles one or more C# source files with the specified parameters. - ## Parameters - - - `setParams` - Function used to overwrite the default CSC parameters. - - `inputFiles` - The C# input files. - - ## Sample - - ["file1.cs"; "file2.cs"] - |> Csc (fun parameters -> - { parameters with Output = ... - Target = ... - ... }) - - - - - Compiles the given C# source files with the specified parameters. - - ## Parameters - - - `setParams` - Function used to overwrite the default CSC parameters. - - `inputFiles` - The C# input files. - - ## Returns - - The exit status code of the compile process. - - ## Sample - - ["file1.cs"; "file2.cs"] - |> csc (fun parameters -> - { parameters with Output = ... - Target = ... - ... }) - - - - - Contains tasks to compile C# source files with CSC.EXE (C# Compiler). - - - - - The output path of the generated docs. The default is "./output/". - - - - - Allows to specify a timeout for docu. The default is 5 minutes. - - - - - The HTML templates for the generated docs. - - - - - The tool path - FAKE tries to find docu.exe automatically in any sub folder. - - - - - The parameter type for docu. - - - - - Generates a HTML documentation from XML docs via the docu.exe. - ## Parameters - - - `setParams` - Function used to manipulate the default docu parameters. - - `assemblies` - Sequence of one or more assemblies containing the XML docs. - - - - - The Docu default params - - - - - Contains helper functions to run the XML documentation tool "docu". - - - - - The dotCover parameter type for running coverage - - - - - Runs the dotCover "cover" command against the MSpec test runner. - ## Parameters - - - `setDotCoverParams` - Function used to overwrite the dotCover report default parameters. - - `setMSpecParams` - Function used to overwrite the MSpec default parameters. - - ## Sample - - !! (buildDir @@ buildMode @@ "/*.Unit.Tests.dll") - |> DotCoverMSpec - (fun dotCoverOptions -> { dotCoverOptions with - Output = artifactsDir @@ "MSpecDotCoverSnapshot.dcvr" }) - (fun mSpecOptions -> { mSpecOptions with - Silent = true }) - - - - - Runs the dotCover "cover" command against the MSTest test runner. - ## Parameters - - - `setDotCoverParams` - Function used to overwrite the dotCover report default parameters. - - `setMSTestParams` - Function used to overwrite the MSTest default parameters. - - ## Sample - - !! (buildDir @@ buildMode @@ "/*.Unit.Tests.dll") - |> MSTest - (fun -> dotCoverOptions ) - (fun MSTestOptions -> MSTestOptions) - - - - - Builds the command line arguments from the given parameter record and the given assemblies. - Runs all test assemblies in the same run for easier coverage management. - [omit] - - - - - Runs the dotCover "cover" command against the XUnit2 test runner. - ## Parameters - - - `setDotCoverParams` - Function used to overwrite the dotCover report default parameters. - - `setXUnit2Params` - Function used to overwrite the XUnit2 default parameters. - - ## Sample - - !! (buildDir @@ buildMode @@ "/*.Unit.Tests.dll") - |> DotCoverXUnit2 - (fun -> dotCoverOptions ) - (fun nUnitOptions -> nUnitOptions) - - - - - Runs the dotCover "cover" command against the NUnit test runner. - ## Parameters - - - `setDotCoverParams` - Function used to overwrite the dotCover report default parameters. - - `setNUnitParams` - Function used to overwrite the NUnit default parameters. - - ## Sample - - !! (buildDir @@ buildMode @@ "/*.Unit.Tests.dll") - |> DotCoverNUnit - (fun dotCoverOptions -> { dotCoverOptions with - Output = artifactsDir @@ "NUnitDotCoverSnapshot.dcvr" }) - (fun nUnitOptions -> { nUnitOptions with - DisableShadowCopy = true }) - - - - - Runs the dotCover "report" command. This generates a report from a dotCover snapshot - ## Parameters - - - `setParams` - Function used to overwrite the dotCover report default parameters. - - ## Sample - - DotCoverReport (fun p -> { p with - Source = artifactsDir @@ "dotCoverSnapshot.dcvr" - Output = artifactsDir @@ "dotCoverReport.xml" - ReportType = DotCoverReportType.Xml }) - - - - - Runs the dotCover "merge" command. This combines dotCover snaphots into a single - snapshot, enabling you to merge test coverage from multiple test running frameworks - ## Parameters - - - `setParams` - Function used to overwrite the dotCover merge default parameters. - - ## Sample - - DotCoverMerge (fun p -> { p with - Source = [artifactsDir @@ "NUnitDotCoverSnapshot.dcvr" - artifactsDir @@ "MSpecDotCoverSnapshot.dcvr"] - Output = artifactsDir @@ "dotCoverSnapshot.dcvr" }) - - - - - Runs the dotCover "cover" command, using a target executable (such as NUnit or MSpec) and generates a snapshot file. - - ## Parameters - - - `setParams` - Function used to overwrite the dotCover default parameters. - - - - - The dotCover default parameters - - - - - Contains a task which can be used to run [DotCover](http://www.jetbrains.com/dotcover/) on .NET assemblies. - - - - - Folder for output of calls - - - - - Timeout for calls - - - - - Working Directory for calls - - - - - Directory where SolutionPackager can be found - - - - - PackageType for packing solution, either managed, unmanaged or both - - - - - Path to solution that should be packed or extracted - - - - - Action to start, either pack or extract - - - - - Parameters for invoking Solution Packager - - - - - Export all solutions for all organizations that the current user has access to. Be sure to pass discovery service url for URL parameter - - - - - Export all solutions for given organization - - - - - Specify, whether solution should be exported as managed or unmanaged - - - - - Set for specifying unique name of solution when exporting single solution - - - - - Set for specifying output file name when exporting solution or input solution name when importing - - - - - Working Directory for actions, can be used to influence storage locations of files - - - - - Tool Directory where Solution Exchanger is stored - - - - - TimeOut for each function. Set to a higher value, i.e. 60 minutes if using AllOrganizations - - - - - Password of user that should be used to connect to the CRM Organization. Leave blank to use default credentials - - - - - Username of user that should be used to connect to the CRM Organization. Leave blank to use default credentials - - - - - Url of CRM Organization / Discovery Service URL if using AllOrganizations - - - - - Parameters for executing Dynamics CRM Helper functions - - - - - Specify Package Type for usage with Solution Packager - - - - - Specify which action Solution Packager should be invoked with - - - - - Runs the solution packager tool on the given file for extracting the zip file or packing the extracted XML representation of a solution to a zip file again - ## Parameters - - - `setParams` - Parameters for invoking solution packager - - - - - Imports zipped solution file to Dynamics CRM - ## Parameters - - - `setParams` - Parameters for invoking solution exchanger - - - - - Exports solution from Dynamics CRM and save it to file - ## Parameters - - - `setParams` - Parameters for invoking solution exchanger - ## Sample - // This Target will get all solutions of all organizations that the executing user has access to, export them as unmanaged and extract them using Solution Packager. - // Extracted solutions are stored in a folder named according to the name of the organization they were exported from. - Target "SaveAndUnzipAllSolutions" (fun _ -> - CreateDir solutions - - ExportSolution(fun f -> - {f with - Url = "http://YourOrganizationDiscoveryService" - Managed = false - AllOrganizations = true - WorkingDirectory = solutions - TimeOut = TimeSpan.FromMinutes 60.0 - }) - - !!(solutions @@ @"\**\*.zip") - |> Seq.iter(fun solution -> - let dir = DirectoryInfo(solution) - - SolutionPackager (fun f -> - {f with - Action = Extract - ZipFile = solution - PackageType = Unmanaged - Folder = extractedDir @@ dir.Parent.Name @@ (Path.GetFileName solution).Replace(".zip", "") - ToolDirectory = @".\tools\SolutionPackager\" - })) - ) - - - - - Publishes all solution component changes. - ## Parameters - - - `setParams` - Parameters for invoking solution exchanger - - - - - Default values for Dynamics CRM Helper - You can obtain the solution exchanger as NuGet Package "Dynamics.CRM.SolutionExchanger" - - - - - The parameter type allows to interact with Dynamics NAV RTC. - - - - - A parameter type to interact with Dynamics NAV - - - - - A Dynamics NAV server type - - - - - Analyzes the XML-based Dynamics NAV test results from XMLPort 130021 - - - - - Analyzes the Dynamics NAV test results - - - - - Waits until all NAV processes have stopped or fails after given timeout. - ## Parameters - - `name` - The name of the processes in question. - - `timeout` - The timespan to time out after. - - - - - Closes all running Dynamics NAV instances - - - - - Returns all running NAV processes. - - - - - Opens a page with the given ID on the RTC client - - - - - Runs a codeunit with the given ID on the RTC client - - - - - Creates the connection information to a Dynamics NAV RTC instance - - - - - Compiles all uncompiled objects in the Dynamics NAV client. - - - - - Creates an import file from the given .txt files and imports it into the Dynamics NAV client. - If the import fails, then every file will be tried alone. - - - - - Creates an import file from the given .txt files. - - - - - Imports the given .txt or .fob file into the Dynamics NAV client - - - - - Exports all objects from the Dynamics NAV client to the given .txt or .fob file - - - - - Exports objects from the Dynamics NAV client based on the given filter to the given .txt or .fob file - - - - - Creates the connection information to a Dynamics NAV instance. - - - - - Gets the directory of the Dynamics NAV ClassicClient for the given version from the registry. - - - - - Retrieves the the file name of the Dynamics NAV ClassicClient for the given version from the registry. - - - - - Contains helper function which allow to interact with Microsoft Dynamics NAV. - - - - - A type definition of a Dynamics NAV object. - - - - - Gets the highest version number for a specified version tag in a number of Dynamics NAV objects in a set of object files - - - - - Gets the highest version number for a specified version tag in a number of Dynamics NAV objects - - - - - Gets the version number for the specified version tag in a Dynamics NAV object - - - - - Gets the version number for the specified version tag in a Dynamics NAV version tag list - - - - - Splits the given files into individual object files in the specified destination directory. - - - - - Returns a standardized filename based on the given NavObject. - - - - - Splits an object string into multiple Dynamics NAV objects of type NavObject. - - - - - Checks a Dynamics NAV object for missing required and invalid tags and raises this as errors. - It also changes the given tag, resets the modified flag and time stamp. - - - - - Checks a Dynamics NAV object for missing required and invalid tags and raises this as errors. - It also changes the given tag, resets the modified flag and time stamp. - - - - - Checks a Dynamics NAV file for missing required and invalid tags and raises this as errors - - - - - Checks a Dynamics NAV object for missing required and invalid tags and raises this as errors - - - - - Get all invalid tags from a Dynamics NAV version tag list - - - - - Get all missing required tags from a Dynamics NAV version tag list - - - - - Replaces a version tag in a Dynamics NAV - - - - - Replaces a version tag list from a complete Dynamics NAV object with a new version tag list - - - - - Replaces a version tag in a version tag list from Dynamics NAV object - - - - - Splits a version tag list from Dynamics NAV object into single tags - - - - - Returns the version tag list from Dynamics NAV object. - - - - - Removes the modified flag from a Dynamics NAV object. - - - - - Replaces the timestamp in a Dynamics NAV object. - - - - - A NAV culture-specific date format. - - - - - A Regex which allows to find objects in a Dynamics NAV file. - - - - - A Regex which allows to parse objects in a Dynamics NAV file. - - - - - A Regex which allows to retrieve the modified time. - - - - - A Regex which allows to retrieve modified date. - - - - - A Regex which allows to retrieve the version list. - - - - - A Regex which allows to retrieve the modified flag. - - - - - Provides an abstraction over Dynamics NAV object files. - - - - - A record which allows to display lots of machine specific information like machine name, processor count etc. - - - - - Type alias for System.EnvironmentVariableTarget - - - - - Retrieves lots of machine specific information like machine name, processor count etc. - - - - - Retrieves information about the hard drives - - - - - Returns a sequence with all installed .NET framework versions - - - - - Contains the IO encoding which is given via build parameter "encoding" or the default encoding if no encoding was specified. - - - - - Convert the given windows path to a path in the current system - - - - - The directory separator string. On most systems / or \ - - - - - The path to the personal documents - - - - - Gets the local directory for the given target platform - - - - - Helper function to help find framework or sdk tools from the - newest toolkit available - - - - - Base path for getting tools from windows SDKs - - - - - The path of the current target platform - - - - - Modifies the ProcessStartInfo according to the platform semantics - - - - - Arguments on the Mono executable - - - - - Determines if the current system is a mono system - Todo: Detect mono on windows - - - - - Determines if the current system is a Linux system - - - - - Determines if the current system is a MacOs system - - - - - Determines if the current system is an Unix system - - - - - The system root environment variable. Typically "C:\Windows" - - - - - The path of Program Files (x86) - It seems this covers all cases where PROCESSOR\_ARCHITECTURE may misreport and the case where the other variable - PROCESSOR\_ARCHITEW6432 can be null - - - - - The path of the "Program Files" folder - might be x64 on x64 machine - - - - - Returns the value of the build parameter with the given name if it was set and otherwise an empty string - - - - - Returns the value of the build parameter with the given name if it was set and otherwise the given default value - - - - - Returns if the build parameter with the given name was set - - - - - Retrieves the application settings variable with the given name - - - - - Splits the entries of an environment variable and removes the empty ones. - - - - - Retrieves the environment variable or None - - - - - Retrieves the environment variable with the given name or returns the false if no value was set - - - - - Retrieves the environment variable with the given name or returns the default bool if no value was set - - - - - Retrieves the environment variable with the given name or fails if not found - - - - - Retrieves the environment variable with the given name or returns the default if no value was set - - - - - Sets the build parameter with the given name for the current process. - - - - - Clears the environment variable with the given name for the current process. - - - - - Sets the environment variable with the given name for the current process. - - - - - Sets the environment variable with the given name - - - - - Retrieves all environment variables from the given target - - - - - Combines two path strings using Path.Combine - - - - - Combines two path strings using Path.Combine - - - - - Retrieves the environment variable with the given name - - - - - This module contains functions which allow to read and write environment variables and build parameters - - - - - Run the given buildscript with fsi.exe - - - - - Run the given buildscript with fsi.exe at the given working directory. - - - - - Run the given buildscript with fsi.exe at the given working directory. Provides full access to Fsi options and args. - - - - - Run the given buildscript with fsi.exe and allows for extra arguments to the script. Returns output. - - - - - Run the given FAKE script with fsi.exe at the given working directory. Provides full access to Fsi options and args. Redirect output and error messages. - - - - - Run the given build script with fsi.exe and allows for extra arguments to the script. Returns output. - - - - - Run the given build script with fsi.exe and allows for extra arguments to FSI. - - - - - Run the given buildscript with fsi.exe - - - - - Creates a ProcessStartInfo which is configured to the F# Interactive. - - - - - The path to the F# Interactive tool. - - - - - Contains helper functions which allow to interact with the F# Interactive. - - - - - Runs fsformatting.exe with the given command in the given repository directory. - - - - - Specifies the fsformatting executable - - - - - Contains tasks which allow to run FSharp.Formatting for generating documentation. - - - - - Get the directory of the specified path - ## Parameters - - - 'path' - The path from which the directory is retrieved. - - - - - Get the filename for the specified path without it's extension - ## Parameters - - - 'path' - The path from which the filename is retrieved. - - - - - Get the filename for the specified path - ## Parameters - - - 'path' - The path from which the filename is retrieved. - - - - - Tests whether the file has specified extensions (containing the leading '.') - ## Parameters - - - 'extension' - The extension to fine containing the leading '.'. - - 'fileName' - Name of the file from which the extension is retrieved. - - - - - Change the extension of the file. - ## Parameters - - - 'extension' - The new extension containing the leading '.'. - - 'fileName' - Name of the file from which the extension is retrieved. - - - - - Get the filename extension including the leading '.', or an empty string if the file has no extension. - ## Parameters - - - 'fileName' - Name of the file from which the extension is retrieved. - - - - - Get the version a file. - ## Parameters - - - 'fileName' - Name of file from which the version is retrieved. The path can be relative. - - - - - Replace all occurences of the regex pattern with the given replacement in the specified files - ## Parameters - - - `pattern` - The string to search for a match - - `replacement` - The replacement string - - `encoding` - The encoding to use when reading and writing the files - - `files` - The paths of the files to process - - - - - Replace all occurences of the regex pattern with the given replacement in the specified file - ## Parameters - - - `pattern` - The string to search for a match - - `replacement` - The replacement string - - `encoding` - The encoding to use when reading and writing the file - - `file` - The path of the file to process - - - - - Replaces all occurences of the patterns in the given files with the given replacements. - ## Parameters - - - `replacements` - A sequence of tuples with the patterns and the replacements. - - `files` - The files to process. - - - - - Creates a config file with the parameters as "key;value" lines - - - - - Moves a single file to the target and overwrites the existing file. - ## Parameters - - - `target` - The target directory. - - `fileName` - The FileName. - - - - - Copies the file structure recursively. - - - - - Copies the file structure recursively. - - - - - Checks the srcFiles for changes to the last release. - ## Parameters - - - `lastReleaseDir` - The directory of the last release. - - `patchDir` - The target directory. - - `srcFiles` - The source files. - - - - - Checks the srcFiles for changes to the last release. - ## Parameters - - - `lastReleaseDir` - The directory of the last release - - `patchDir` - The target directory - - `srcFiles` - The source files - - `findOldFileF` - A function which finds the old file - - - - - Checks if the file exists - - - - - Checks if the directory exists - - - - - Compares the given files for changes. - If delete is set to true then equal files will be removed. - - - - - Checks if the two files are byte-to-byte equal. - - - - - Appends all given files to one file. - ## Parameters - - - `newFileName` - The target FileName. - - `files` - The original FileNames as a sequence. - - - - - Reads a csv file line by line - delimiter is a , - - - - - Deletes multiple directories - - - - - Cleans multiple directories - - - - - Cleans a directory by removing all files and sub-directories. - - - - - Copies a directory recursivly. If the target directory does not exist, it will be created. - ## Parameters - - - `target` - The target directory. - - `source` - The source directory. - - `filterFile` - A file filter predicate. - - - - - Includes all files - - - - - Exclude SVN files (path with .svn) - - - - - Copies the files to the target - Alias for Copy - ## Parameters - - - `target` - The target directory. - - `files` - The orginal file names. - - - - - Copies a list of files to the specified directory without any output. - ## Parameters - - - `target` - The target directory. - - `files` - List of files to copy. - - - - - Renames the file to the target file name. - ## Parameters - - - `target` - The target file name. - - `file` - The orginal file name. - - - - - Copies the files from a cache folder. - If the files are not cached or the original files have a different write time the cache will be refreshed. - ## Parameters - - - `target` - The target FileName. - - `cacheDir` - The cache directory. - - `files` - The orginal files. - - - - - Copies the given files to the target. - ## Parameters - - - `target` - The target directory. - - `files` - The original file names as a sequence. - - - - - Copies the files to the target. - ## Parameters - - - `target` - The target directory. - - `files` - The original file names as a sequence. - - - - - Copies several file groups, each represented by a FileIncludes object, - to the target folder preserving the folder structure - starting from the BaseDirectory of each FileIncludes. - ## Parameters - - - `target` - The target directory. - - `files` - A sequence of file groups. - - - - - Copies a single file to the target folder preserving the folder structure - starting from the specified base folder. - ## Parameters - - - `baseDir` - The base directory. - - `target` - The target directory. - - `fileName` - The file name. - - - - - Copies a single file to a relative subfolder of the target. - ## Parameters - - - `target` - The target directory - - `fileName` - The fileName - - - - - Copies a single file to the target and overwrites the existing file. - ## Parameters - - - `target` - The target directory or file. - - `fileName` - The FileName. - - - - - Active Pattern for determining FileInfoNameSections. - - - - - Active Pattern for determining file name. - - - - - Active Pattern for determining file extension. - - - - - Active pattern which discriminates between files and directories. - - - - - Deletes the given files. - - - - - Deletes a file if it exists. - - - - - Creates a file if it does not exist. - - - - - Creates a directory if it does not exist. - - - - - Deletes a directory if it exists. - - - - - Sets all given files readonly. - - - - - Sets all files in the directory readonly. - - - - - Sets the directory readonly - - - - - Performs the given actions on all files and subdirectories - - - - - Contains helper function which allow to deal with files and directories. - - - - - Sets a directory as BaseDirectory. - - - - - Checks if a particular file is matched - - - - - Ignores files with the given pattern - - - - - Adds the given pattern to the file includes - - - - - Internal representation of a file set. - - - - - Looks for a tool in all subfolders - returns the folder where the tool was found. - - - - - Looks for a tool first in its default path, if not found in all subfolders of the root folder - returns the tool file name. - - - - - Includes a single pattern and scans the files - !! x = AllFilesMatching x - - - - - Exclude operator - - - - - Add Include operator - - - - - Sets a directory as baseDirectory for fileIncludes. - - - - - Include files - - - - - This module contains a file pattern globbing implementation. - - - - - Detects whether the given path does not contains invalid characters. - - - - - Detects whether the given path is a file. - - - - - Detects whether the given path is a directory. - - - - - Checks if the given directory exists. If not then this functions creates the directory. - - - - - Ensure that directory chain exists. Create necessary directories if necessary. - - - - - Checks if the directory exists on disk. - - - - - Checks if the file is in a subfolder of the dir. - - - - - Checks if dir1 is a subfolder of dir2. If dir1 equals dir2 the function returns also true. - - - - - Normalizes a filename. - - - - - Checks if all given files exist. - - - - - Raises an exception if the file doesn't exist on disk. - - - - - Checks if the file exists on disk. - - - - - Get the full location of the current assembly. - - - - - Gets the current directory. - - - - - Gets the first file in the directory matching the search pattern or throws an error if nothing was found. - - - - - Gets the first file in the directory matching the search pattern as an option value. - - - - - Finds all the files in the directory matching the search pattern. - - - - - Gets all files in the directory. - - - - - Gets all subdirectories of a given directory. - - - - - Gets the directory part of a filename. - - - - - Converts a filename to it's full file system name. - - - - - Creates a FileInfo or a DirectoryInfo for the given path - - - - - Creates a FileInfo for the given path. - - - - - Creates a DirectoryInfo for the given path. - - - - - Contains helpers which allow to interact with the file system. - - - - - Like "mv" in a shell. Moves/renames a file - <param name="src">The source</param> - <param name="dest">The destination</param> - - - - - Restore the previous directory stored in the stack - - - - - Store the current directory in the directory stack before changing to a new one - - - - - The stack of directories operated on by pushd and popd - - - - - Gets working directory - - - - - Changes working directory - - - - - Changes working directory - - - - - Like "cp" in a shell. Copies a single file. - <param name="src">The source</param> - <param name="dest">The destination</param> - - - - - Like "cp -r" in a shell. Copies a file or directory recursively. - - The source - The destination - - - - Creates a directory if it doesn't exist. - - - - - Like "rm -rf" in a shell. Removes files recursively, ignoring nonexisting files - - - - - Deletes a file if it exists - - - - - Shell-like functions. Similar to [Ruby's FileUtils](http://www.ruby-doc.org/stdlib-2.0.0/libdoc/rake/rdoc/FileUtils.html). - - - - - A timeout for the test runner - - - - - Custom options to pass to Fixie runner - - - - - Working directory (optional) - - - - - FileName of the Fixie runner - - - - - Parameter type to configure the Fixie runner - - - - - This task to can be used to run [Fixie](http://patrick.lioi.net/fixie/) on test libraries. - ## Parameters - - - `setParams` - Function used to overwrite the Fixie default parameters. - - `assemblies` - The file names of the test assemblies. - - ## Sample - - !! (testDir @@ "Test.*.dll") - |> Fixie (fun p -> { p with CustomOptions = ["custom","1"; "test",2] }) - - - - - Fixie default parameters - tries to locate Fixie.Console.exe in any subfolder. - - - - - Contains tasks to run [Fixie](http://fixie.github.io/) unit tests. - - - - - Specifies other params for the compilation. Freeform strings. - - - - - Specifies whether to emit debug information (default is false). - - - - - Specifies files to reference for the compilation. - - - - - Specifies the compiled artifact target platform. - - - - - Specifies the compiled artifact target type. - - - - - Specifies the output file name and path. - - - - - The default parameters to the compiler service. - - - - - 'fsc.exe' command line parameters - - - - - The 'fsc.exe' output platforms - - - - - The 'fsc.exe' output target types - - - - - Compiles one or more F# source files with the specified parameters. - ## Parameters - - - `setParams` - Function used to overwrite the default Fsc parameters. - - `inputFiles` - The F# input files. - - ## Sample - - ["file1.fs"; "file2.fs"] - |> Fsc (fun parameters -> - { parameters with Output = ... - FscTarget = ... - ... }) - - - - - Compiles the given F# source files with the specified parameters. - - ## Parameters - - - `setParams` - Function used to overwrite the default Fsc parameters. - - `inputFiles` - The F# input files. - - ## Returns - - The exit status code of the compile process. - - ## Sample - - ["file1.fs"; "file2.fs"] - |> fsc (fun parameters -> - { parameters with Output = ... - FscTarget = ... - ... }) - - - - - Compiles the given source file with the given options. If no options - given (i.e. the second argument is an empty list), by default tries - to behave the same way as would the command-line 'fsc.exe' tool. - - - - - Contains tasks to compiles F# source file with the [FSharp.Compiler.Service](https://github.com/fsharp/FSharp.Compiler.Service). - There is also a tutorial about the [F# compiler tasks](../fsc.html) available. - - - - - Deletes a single folder from remote FTP folder. - ## Parameters - - `destPath` - The full path to the folder which needs to be deleted, including all its parent folders - - `server` - FTP Server name (ex: "ftp://10.100.200.300:21/") - - `user` - FTP Server login name (ex: "joebloggs") - - `pwd` - FTP Server login password (ex: "J0Eblogg5") - - - - - Deletes a single file from remote FTP folder. - ## Parameters - - `destPath` - The full path to the file which needs to be deleted, including all its parent folders - - `server` - FTP Server name (ex: "ftp://10.100.200.300:21/") - - `user` - FTP Server login name (ex: "joebloggs") - - `pwd` - FTP Server login password (ex: "J0Eblogg5") - - - - - Uploads a given local folder to a given root dir on a FTP server. - ## Parameters - - `srcPath` - The local server path from which files need to be uploaded - - `rootDir` - The remote root dir where files need to be uploaded, leave this as empty, if files need to be uploaded to root dir of FTP server - - `server` - FTP Server name (ex: "ftp://10.100.200.300:21/") - - `user` - FTP Server login name (ex: "joebloggs") - - `pwd` - FTP Server login password (ex: "J0Eblogg5") - - - - - Creates a matching folder in FTP folder, if not already present. - ## Parameters - - `destPath` - The full name of folder which needs to be created, including all its parent folders - - `server` - FTP Server name (ex: "ftp://10.100.200.300:21/") - - `user` - FTP Server login name (ex: "joebloggs") - - `pwd` - FTP Server login password (ex: "J0Eblogg5") - - - - - Given a folder path, will check if that folder is present at a given root directory of a FTP server. - ## Parameters - - `destPath` - The full name of folder which needs to be checked for existance, including all its parent folders - - `server` - FTP Server name (ex: "ftp://10.100.200.300:21/") - - `user` - FTP Server login name (ex: "joebloggs") - - `pwd` - FTP Server login password (ex: "J0Eblogg5") - - - - - Given a folder name, will check if that folder is present at a given root directory of a FTP server. - ## Parameters - - `server` - FTP Server name (ex: "ftp://10.100.200.300:21/") - - `user` - FTP Server login name (ex: "joebloggs") - - `pwd` - FTP Server login password (ex: "J0Eblogg5") - - - - - Uploads a single file from local directory into remote FTP folder. - ## Parameters - - `destPath` - The full local file path that needs to be uploaded - - `srcPath` - The full path to file which needs to be created, including all its parent folders - - `server` - FTP Server name (ex: "ftp://10.100.200.300:21/") - - `user` - FTP Server login name (ex: "joebloggs") - - `pwd` - FTP Server login password (ex: "J0Eblogg5") - - - - - Gets the contents/listing of files and folders in a given FTP server folder - ## Parameters - - `dirPath` - The full name of folder whose content need to be listed - - `server` - FTP Server name (ex: "ftp://10.100.200.300:21/") - - `user` - FTP Server login name (ex: "joebloggs") - - `pwd` - FTP Server login password (ex: "J0Eblogg5") - - - - - Checks to see if the `ftp content` string containts the string `Given_Folder_Name` - - - - -Partial validation for folder name, based on http://msdn.microsoft.com/en-us/library/aa365247.aspx - - - - - Writes given byte array into the given stream - - - - - Gets a connection to the FTP server - - - - - Contains helpers which allow to upload a whole folder/specific file into a FTP Server. - Uses `Passive Mode` FTP and handles all files as binary (and not ASCII). - Assumes direct network connectivity to destination FTP server (not via a proxy). - Does not support FTPS and SFTP. - - - - - Parameter type for the FxCop tool - - - - - The FxCop error reporting level - - - - - Run FxCop on a group of assemblies. - - - - - FxCop Default parameters - - - - - This checks the result file with some XML queries for errors - [omit] - - - - - Contains a task which can be used to run [FxCop](http://msdn.microsoft.com/en-us/library/bb429476(v=vs.80).aspx) on .NET assemblies. There is also a [tutorial](../fxcop.html) for this task available. - - - - - The directory where the process will be started. - - - - - The timeout for the process. - - - - - (Required) Path to the gacutil - - - - - GAC parameters - - - - - Runs gacutil with the given command. - - - - - GACutil default parameters - - - - - Path to newest `gacutil.exe` - - - - - This module contains helper function for the GAC - - - - - Pulls a given branch from the given remote. - ## Parameters - - - `repositoryDir` - The git repository. - - `remote` - The name of the remote. - - `branch` - The name of the branch to pull. - - - - - Pushes the given branch to the given remote. - ## Parameters - - - `repositoryDir` - The git repository. - - `remote` - The remote. - - `branch` - The branch. - - - - - Pushes the given tag to the given remote. - ## Parameters - - - `repositoryDir` - The git repository. - - `remote` - The remote. - - `tag` - The tag. - - - - - Pushes all branches to the default remote. - ## Parameters - - - `repositoryDir` - The git repository. - - - - - Deletes the given tag. - ## Parameters - - - `repositoryDir` - The git repository. - - `tag` - The tag which should be deleted. - - - - - Tags the current branch. - ## Parameters - - - `repositoryDir` - The git repository. - - `tag` - The new tag. - - - - - Deletes the given branch. - ## Parameters - - - `repositoryDir` - The git repository. - - `force` - Determines if git should be run with the *force* flag. - - `branch` - The branch which should be deleted. - - - - - Creates a new branch from the given commit. - ## Parameters - - - `repositoryDir` - The git repository. - - `newBranchName` - The new branch. - - `commit` - The commit which git should take as the new HEAD. - can be HEAD, HEAD~1, ... , a branch name or a prefix of a SHA1. - - - - - Performs a checkout of the given branch to the working copy. - ## Parameters - - - `repositoryDir` - The git repository. - - `create` - Set this to true if the branch is new. - - `branch` - The new branch. - - - - - Creates a new branch based on the given baseBranch and checks it out to the working copy. - ## Parameters - - - `repositoryDir` - The git repository. - - `baseBranch` - The base branch. - - `branch` - The new branch. - - - - - Performs a checkout of the given branch with an additional tracking branch. - ## Parameters - - - `repositoryDir` - The git repository. - - `trackBranch` - The tracking branch. - - `branch` - The branch for the checkout. - - - - - Performs a checkout of the given branch to the working copy. - ## Parameters - - - `repositoryDir` - The git repository. - - `branch` - The branch for the checkout. - - - - - Returns the number of revisions between the two given commits. - ## Parameters - - - `repositoryDir` - The git repository. - - `commit1` - The first commit for which git should find the merge base. - - `commit2` - The second commit for which git should find the merge base. - - - - - Returns the SHA1 of the merge base of the two given commits from the given repository. - ## Parameters - - - `repositoryDir` - The git repository. - - `commit1` - The first commit for which git should find the merge base. - - `commit2` - The second commit for which git should find the merge base. - - - - - Returns the SHA1 of the given commit from the given repository. - ## Parameters - - - `repositoryDir` - The git repository. - - `commit` - The commit for which git should return the SHA1 - can be HEAD, HEAD~1, ... , a branch name or a prefix of a SHA1. - - - - - Gets all local and remote branches from the given repository. - - - - - Gets all remote branches from the given repository. - - - - - Gets all local branches from the given repository. - - - - - Contains helper functions which allow to deal with git branches. - - - - - Searches the .git directory recursivly up to the root. - - - - - [omit] - - - - - Runs the git command and returns the first line of the result. - - - - - Runs the given git command, waits for its completion. - This version doesn't throw an exception if an error occurs. It just traces the error. - - - - - [omit] - - - - - Runs the given git command, waits for its completion. - - - - - Runs the given git command, waits for its completion and returns whether it succeeded. - - - - - Fires the given git command ind the given repository directory and returns immediatly. - - - - - [omit] - - - - - [omit] - - - - - Runs git.exe with the given command in the given repository directory. - - - - - Tries to locate the git.exe via the eviroment variable "GIT". - - - - - Specifies a global timeout for git.exe - default is *no timeout* - - - - - Contains helpers which allow to interact with [git](http://git-scm.com/) via the command line. - - - - - Commits all files in the given repository with the given message - - - - - Contains helper functions which allow to commit to git repositories. - - - - - Sets the commit message - - - - - Gets the commit message - - - - - Returns the commit message file. - - - - - Contains helper functions which allow to get and set the git commit message. - - - - - A type which represents a file status in git. - - - - - Cleans the working copy by doing a git reset --hard and a clean -f. - - - - - Returns true if the given repository is in the middle of a patch process. - - - - - Returns true if the given repository is in the middle of a rebase process. - - - - - Returns the current rebase directory for the given repository. - - - - - Returns true if the working copy is in a conflicted merge otherwise false - - - - - Gets all conflicted files - - - - - Gets the changed files since the given revision incl. changes in the working copy - - - - - Gets all changed files in the current revision - - - - - Gets the changed files between the given revisions - - - - - Contains helper functions which can be used to retrieve file status information from git. - - - - - Gets the current hash of the current repository - - - - - Gets the last git tag of the current repository by calling git describe - - - - - Gets the git log in one line - - - - - Gets the last git tag by calling git describe - - - - - Returns true if rev1 is ahead of rev2 - - - - - Returns a friendly name from a SHA1 - - - - - Checks if the working copy is clean - - - - - Shows the git status - - - - - Returns the SHA1 of the current HEAD - - - - - Gets the git branch name - - - - - [omit] - - - - - Gets the git version - - - - - Contains helper functions which can be used to retrieve status information from git. - - - - - Git merge option. - - - - - Performs a merge of the given branch with the current branch - ## Parameters - - - `repositoryDir` - The git repository. - - `flags` - Additional flags. - - `branch` - The branch we want to merge in. - ## Sample - - merge @"C:\code\Fake" NoFastForwardFlag "master" - - - - - Tests whether branches and their "origin" counterparts have diverged and need merging first. - ## Parameters - - - `repositoryDir` - The git repository. - - `local` - The local branch name. - - `remote` - The remote branch name. - - - - - Forbids git to use fast-forward merges - - - - - Allows git to use fast-forward merges - - - - - Gets the current merge message. - - - - - Contains helper functions which allow to deal with git merge. - - - - - Tries to rebase on top of the given branch. - If the rebasing process fails a normal merge will be started. - Returns if the process used merge instead of rebase. - - - - - rebase failed ==> fallback on merge - [omit] - - - - - Restart the rebasing process by skipping the current patch. - - - - - Restart the rebasing process after having resolved a merge conflict. - - - - - Restore the original branch and abort the rebase operation. - - - - - Performs a rebase on top of the given branch with the current branch - - - - - Contains helper functions which allow to deal with git rebase. - - - - - Cleans a directory by removing all files and sub-directories. - ## Parameters - - - `repositoryDir` - The path of the directory to clean. - - - - - Inits a git repository. - ## Parameters - - - `repositoryDir` - The path of the target directory. - - `bare` - If the new directory is a bare directory. - - `shared` - Specifies that the git repository is to be shared amongst several users. This allows users belonging to the same group to push into that repository. - - - - - Clones a single branch of a git repository. - ## Parameters - - - `workingDir` - The working directory. - - `repoUrl` - The URL to the origin. - - `branchname` - Specifes the target branch. - - `toPath` - Specifes the new target subfolder. - - - - - Clones a git repository. - ## Parameters - - - `workingDir` - The working directory. - - `repoUrl` - The URL to the origin. - - `toPath` - Specifes the new target subfolder. - - - - - Contains functions which allow basic operations on git repositories. - All operations assume that the CommandHelper can find git.exe. - - - - - Performs a git reset "hard" to the current HEAD. - Resets the index and working tree. Any changes to tracked files in the working tree since <commit> are discarded. - ## Parameters - - - `repositoryDir` - The git repository. - - - - - Performs a git reset "mixed" to the current HEAD. - Resets the index but not the working tree and reports what has not been updated. - ## Parameters - - - `repositoryDir` - The git repository. - - - - - Performs a git reset "soft" to the current HEAD. - Does not touch the index file nor the working tree at all. - ## Parameters - - - `repositoryDir` - The git repository. - - - - - Performs a git reset "hard". - Resets the index and working tree. Any changes to tracked files in the working tree since <commit> are discarded. - ## Parameters - - - `repositoryDir` - The git repository. - - `commit` - The commit to which git should perform the reset. - - `file` - The file to reset - null means all files. - - - - - Performs a git reset "mixed". - Resets the index but not the working tree and reports what has not been updated. - ## Parameters - - - `repositoryDir` - The git repository. - - `commit` - The commit to which git should perform the reset. - - `file` - The file to reset - null means all files. - - - - - Performs a git reset "soft". - Does not touch the index file nor the working tree at all. - ## Parameters - - - `repositoryDir` - The git repository. - - `commit` - The commit to which git should perform the reset. - - `file` - The file to reset - null means all files. - - - - - Contains helper functions which allow to deal with git reset. - - - - - Shows the SHA1 calculated by git. - Assumes that the CommandHelper module can find git.exe. - - - - - Calculates the SHA1 for a given string like git. - - - - - Calculates the SHA1 for a given string. - - - - - Contains functions which allow the SHA1 of a file with git and without it. - - - - - Checks if the given branch is a remote branch. - - - - - Checks if the given branch is a local branch. - - - - - Checks if the given branch is absent. - - - - - Checks if the given branch exists. - - - - - Checks if the given branch exists. - - - - - Contains helper function which can be used for sanity checks. - - - - - Adds all files to the staging area - - - - - Adds a file to the staging area - - - - - Contains helper functions which allow to deal with git's staging area. - - - - - Remove a single stashed state from the stash list and - apply it on top of the current working tree state, - i.e., do the inverse operation of git stash save. - The working directory must match the index. - - - - - Stash the changes in a dirty working directory away. - - - - - Contains helper functions which allow to deal with git stash. - - - - - Gets the current status. - - - - - Gets the remote path from the config. - - - - - Gets the local path from the config. - - - - - This record represents a git submodule binding. - - - - - Adds a submodule to the given super repository. - ## Parameters - - - `superRepositoryDir` - The super repository. - - `remotePath` - The path to the remote repository of the submodule. - - `localPath` - The local path to the submodule. - - `branch` - The branch to clone. (can be null) - - - - - Inits a submodule with the given name in a subfolder of the given super repository. - ## Parameters - - - `superRepositoryDir` - The super repository. - - `name` - The name of the new repository. - - - - - Gets all submodules from the given repository directory. - - - - - Contains helper functions which allow to deal with git submodules. - - - - - This module contains a file pattern globbing implementation. - - - - - Behaves like AwaitObservable, but calls the specified guarding function - after a subscriber is registered with the observable. - - - - - Helper that can be used for writing CPS-style code that resumes - on the same thread where the operation was started. - - - - - Uses the HTML Help Workshop to compile a help project and returns the generated file names of the generated files. - ## Parameters - - - `helpCompiler` - The filename of the HTML Help WorkShop tool. - - `projectFile` - The fileName of the help project. - - - - - Contains a task which allows to use [HTML Help Workshop](http://msdn.microsoft.com/en-us/library/windows/desktop/ms670169(v=vs.85).aspx) in order to compile a help project. - - - - - The background color for the message, which can be yellow, red, green, purple, gray, or random. Default value: yellow - - - - - Whether or not this message should trigger a notification for people in the room. Default value: false - - - - - The message format, which can either be text or html. Default value: text - - - - - (Required) The message body - - - - - (Required) Name the message will appear to be sent from - - - - - (Required) ID or name of the room to send the notification to - - - - - (Required) Auth token from HipChat - - - - - The HipChat notification paramater type - - - - - Sends a notification to a HipChat room - ## Parameters - - `setParams` - Function used to override the default notification parameters - - - - - [omit] - - - - - The default HipChat notification parameters - - - - - Contains a task to send notification messages to a [HipChat](https://www.hipchat.com/) room - - - - - Restrict download to specific teams - - - - - Release download status (can only be set with full-access tokens) - - - - - Set to your source repository - - - - - Set to the URL of the build job on your build server - - - - - Set to the git commit sha for this build - - - - - Set to true to enable the private download page (default is false) - - - - - Set version as mandatory - - - - - Set the notify option - - - - - Set the owner of the app - - - - - Set the release type of the app - - - - - Release notes type for the build - - - - - Release notes for the build - - - - - file data for dsym (IOS: *.dysm.zip or Android: mapping.txt) - - - - - (Required) file data for the build (.ipa or .apk) - - - - - (Required) API token - - - - - The HockeyApp parameter type - Based on http://support.hockeyapp.net/kb/api/api-apps#upload-app - - - - - HockeyApp's success response - - - - - The release download status - - - - - The mandatory options - - - - - The note types - - - - - The notification options - - - - - The release type of the app - - - - - Uploads an app to HockeyApp - ## Parameters - - `setParams` - Function used to override the default parameters - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - The default HockeyApp parameters - - - - - Contains tasks to interact with [HockeyApp](http://hockeyapp.com) - - - - - True -> XML documentation files are merged to produce an XML documentation file for the target assembly. - - - - - True -> types with the same name are all merged into a single type in the target assembly. - - - - - v1 or v1.1 or v2 or v4 or version,platform - - - - - Directories to be used to search for input assemblies - - - - - True (default) -> creates a .pdb file for the output assembly and merges into it any .pdb files found for input assemblies. - - - - - True -> transitive closure of the input assemblies is computed and added to the list of input assemblies. - - - - - Path to an assembly that will be used to get all of the assembly-level attributes - - - - - Wild cards in file names are expanded and all matching files will be used as input. - - - - - Assembly-level attributes names that have the same type are copied over into the target directory - - - - - Duplicate types policy - - - - - Assemblies to merge with the primary assembly - - - - - Version to use for the merged assembly - - - - - Path to ILMerge.exe - - - - - Parameter type for ILMerge - - - - - Option type to configure ILMerge's target output. - - - - - Option type to configure ILMerge's processing of internal types. - - - - - List of types to allow to be duplicated - - - - - All public types are allowed to be duplicated and renamed - - - - - No duplicates of public types allowed - - - - - Option type to configure ILMerge's processing of duplicate types. - - - - - Uses ILMerge to merge .NET assemblies. - ## Parameters - - - `setParams` - Function used to create an ILMergeParams value with your required settings. Called with an ILMergeParams value configured with the defaults. - - `outputFile` - Output file path for the merged assembly. - - `primaryAssembly` - The assembly you want ILMerge to consider as the primary. - - - - - Builds the arguments for the ILMerge task - [omit] - - - - - ILMerge default parameters. Tries to automatically locate ilmerge.exe in a subfolder. - - - - - Contains task a task which allows to merge .NET assemblies with [ILMerge](http://research.microsoft.com/en-us/people/mbarnett/ilmerge.aspx). - - - - - Result type for project comparisons. - - - - - The project file name - - - - - All files which are in "Compile" sections - - - - - Saves the project file - - - - - Removes a file from the Compile nodes - - - - - Read a Project from a FileName - - - - - Finds duplicate files which are in "Compile" sections - - - - - Add a file to the Compile nodes - - - - - A small abstraction over MSBuild project files. - - - - - Compares the given project files againts the template project and fails if any files are missing. - For F# projects it is also reporting unordered files. - - - - - Compares the given projects to the template project and adds all missing files to the projects if needed. - It also removes duplicate files from the project files. - - - - - It removes duplicate files from the project files. - - - - - Compares the given projects to the template project and adds all missing files to the projects if needed. - - - - - Compares the given project files againts the template project and returns which files are missing. - For F# projects it is also reporting unordered files. - - - - - Contains project file comparion tools for MSBuild project files. - - - - - Removes all spec and test data references from a project. - - - - - Removes all NUnit references from a project. - - - - - A Convetion which matches nothing - - - - - All Spec.cs or Spec.fs files and all files containing TestData - - - - - All Spec.cs or Spec.fs files - - - - - All references to nunit.*.dlls - - - - - Removes test data and test files from a given MSBuild project and recursivly from all MSBuild project dependencies. - ## Parameters - - - `assemblyFilterF` - A filter function for assembly references. - - `fileFilterF` - A filter function for files in a project. - - `projectFileName` - The MSBuild project to start. - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - Converts a MSBuildProject to XML - [omit] - - - - - Contains functions which allow to remove side-by-side specs during the build. - - - - - A type for MSBuild task parameters - - - - - A type for MSBuild configuration - - - - - MSBuild log option - - - - - MSBuild verbosity option - - - - - A type to represent MSBuild project files. - - - - - Builds the given web project files in debug mode and copies them to the given websiteDir. - ## Parameters - - `outputPath` - The output path. - - `projectFiles` - The project file paths. - - - - - Builds the given web project file in debug mode and copies it to the given websiteDir. - ## Parameters - - `outputPath` - The output path. - - `projectFile` - The project file path. - - - - - Builds the given project files or solution files in release mode and collects the output files. - ## Parameters - - `outputPath` - If it is null or empty then the project settings are used. - - `properties` - A list with tuples of property name and property values. - - `targets` - A string with the target names which should be run by MSBuild. - - `projects` - A list of project or solution files. - - - - - Builds the given project files or solution files in release mode to the default outputs. - ## Parameters - - `targets` - A string with the target names which should be run by MSBuild. - - `projects` - A list of project or solution files. - - - - - Builds the given project files or solution files and collects the output files. - ## Parameters - - `outputPath` - If it is null or empty then the project settings are used. - - `targets` - A string with the target names which should be run by MSBuild. - - `projects` - A list of project or solution files. - - - - - Builds the given project files or solution files and collects the output files. - ## Parameters - - `outputPath` - If it is null or empty then the project settings are used. - - `targets` - A string with the target names which should be run by MSBuild. - - `projects` - A list of project or solution files. - - - - - Builds the given project files or solution files and collects the output files. - ## Parameters - - `outputPath` - If it is null or empty then the project settings are used. - - `targets` - A string with the target names which should be run by MSBuild. - - `properties` - A list with tuples of property name and property values. - - `projects` - A list of project or solution files. - - - - - Builds the given project files and collects the output files. - ## Parameters - - `outputPath` - If it is null or empty then the project settings are used. - - `targets` - A string with the target names which should be run by MSBuild. - - `properties` - A list with tuples of property name and property values. - - `projects` - A list of project or solution files. - - - - - Runs a MSBuild project - ## Parameters - - `setParams` - A function that overwrites the default MsBuildParams - - `project` - A string with the path to the project file to build. - - ## Sample - - let buildMode = getBuildParamOrDefault "buildMode" "Release" - let setParams defaults = - { defaults with - Verbosity = Some(Quiet) - Targets = ["Build"] - Properties = - [ - "Optimize", "True" - "DebugSymbols", "True" - "Configuration", buildMode - ] - } - build setParams "./MySolution.sln" - |> DoNothing - - - - - Defines the loggers to use for MSBuild task - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - Defines a default for MSBuild task parameters - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - Tries to detect the right version of MSBuild. - - On Linux/Unix Systems we use xBuild. - - On Windows we try to find a "MSBuild" build parameter or read the MSBuild tool location from the AppSettings file. - - - - - An exception type to signal build errors. - - - - - Contains tasks which allow to use MSBuild (or xBuild on Linux/Unix) to build .NET project files or solution files. - - - - - MSI parameter type - - - - - Uninstalls a msi. - ## Parameters - - - `setParams` - Function used to manipulate the default MSI parameters. - - `setup` - The setup file name. - - - - - Installs a msi. - ## Parameters - - - `setParams` - Function used to manipulate the default MSI parameters. - - `setup` - The setup file name. - - - - - MSI default parameters - - - - - Contains tasks which allow to run msiexec in order to install or uninstall msi files. - - - - - Run tests in isolation (optional). - - - - - Option which allow to specify if a MSTest error should break the build. - - - - - Path to MSTest.exe - - - - - A timeout for the test runner (optional) - - - - - Working directory (optional) - - - - - Path to the Test Settings file (.testsettings) (optional) - - - - - Path to the Test Metadata file (.vdmdi) (optional) - - - - - Test results directory (optional) - - - - - Test category filter (optional). The test category filter consists of one or more test category names separated by the logical operators '&', '|', '!', '&!'. The logical operators '&' and '|' cannot be used together to create a test category filter. - - - - - Parameter type to configure the MSTest.exe. - - - - - Option which allow to specify if a MSTest error should break the build. - - - - - Runs MSTest command line tool on a group of assemblies. - ## Parameters - - - `setParams` - Function used to manipulate the default MSTestParams value. - - `assemblies` - Sequence of one or more assemblies containing Microsoft Visual Studio Unit Test Framework unit tests. - - ## Sample usage - - Target "Test" (fun _ -> - !! (testDir + @"\*.Tests.dll") - |> MSTest (fun p -> { p with Category = "group1" }) - ) - - - - - Builds the command line arguments from the given parameter record and the given assemblies. - [omit] - - - - - MSTest default parameters. - - - - - [omit] - - - - - [omit] - - - - - Contains tasks to run [MSTest](http://en.wikipedia.org/wiki/Visual_Studio_Unit_Testing_Framework/) unit tests. - - - - - An error level setting to specify whether a failed test should break the build - - - - - A timeout for the test runner - - - - - Tests with theses tags are included by MSpec - - - - - Tests with theses tags are ignored by MSpec - - - - - Can be used to run MSpec in silent mode. - - - - - Working directory (optional) - - - - - Output file path for xml reports (optional). - - - - - Output directory for html reports (optional). - - - - - FileName of the mspec runner exe. Use mspec-clr4.exe if you are on .NET 4.0 or above. - - - - - Parameter type to configure the MSpec runner. - - - - - This task to can be used to run [machine.specifications](https://github.com/machine/machine.specifications) on test libraries. - ## Parameters - - - `setParams` - Function used to overwrite the MSpec default parameters. - - `assemblies` - The file names of the test assemblies. - - ## Sample - - !! (testDir @@ "Test.*.dll") - |> MSpec (fun p -> {p with ExcludeTags = ["HTTP"]; HtmlOutputDir = reportDir}) - - ## Hint - - XmlOutputPath expects a full file path whereas the HtmlOutputDir expects a directory name - - - - - Builds the command line arguments from the given parameter record and the given assemblies. - [omit] - - - - - MSpec default parameters - tries to locate mspec-clr4.exe in any subfolder. - - - - - Contains a task to run [machine.specifications](https://github.com/machine/machine.specifications) tests. - - - - - Needed information to call MAGE - - - - - The level of trust to grant the application on client computers. - - - - - The supported commands of the MAGE tool - - - - - These are the supported processor types of the MAGE tool - - - - - Executes a full run of MAGE commands: first, it creates a new manifest file. Then it signs the manifest, deploys the application and finally signs the deployment. - - - - - Encapsulates the MAGE call to sign the deployment of an application - - - - - Encapsulates the MAGE call to update the deployment of an application - - - - - Encapsulates the MAGE call to deploy an application - - - - - Encapsulates the MAGE call to sign an application's manifest - - - - - Encapsulates the MAGE call to update an existing application's manifest - - - - - Encapsulates the MAGE call to create a new application's manifest - - - - - Execute the MAGE tool. Adds some parameters, dependent on the MAGE command. - - - - - Convert the parameter structure into command line arguments of MAGE - - - - - Contains helper functions which allow FAKE to call the [Manifest Generation and Editing Tool](http://msdn.microsoft.com/en-us/library/acz3y3te.aspx), in short 'MAGE'. - The intentional use is the creation of a clickonce application. - - ## Certificates - The MAGE tool wants to sign the manifest using a certificate. It should be clear, that this file is not under source control. - On the other hand - you want to be able to run the compile batch on each developer machine. How can we achieve that? - In the parameter structure, we use a CertFile property and a TmpCertFile property. Whenever the CertFile was not found, the manifest is signed with - a temporary certificate. And the latter one can be shared in the source control. - - - - - Waits for another application to create a output file. - If the timeout is reached an exception will be raised. - - - - - Waits for other applications to create a output files. - If the timeout is reached an exception will be raised. - - - - - Contains helper function which allow FAKE to interact with other applications via message files. - - - - - TeamCity Logger for MSBuild - - - - - TeamCity Logger for MSBuild - - - - - Abstract function which registers an event listener. - - - - - Abstract MSBuild Logger class. - - - - - The ErrorLogFile - - - - - [omit] - - - - - Contains Logger implementations for MsBuild. - - - - - The NCover parameter type. - - - - - Runs NCover on a group of assemblies. - ## Parameters - - - `setParams` - Function used to overwrite the NCover default parameters. - - `assemblies` - The test assemblies, which should be inspected. - - `excludeAssemblies` - These assemblies are excluded. - - - - - NCover default parameters. - - - - - Contains a task which can be used to run [NCover](http://www.ncover.com/) on .NET assemblies. - - - - - Runs [NDepend](http://www.ndepend.com/) on a .NET project file. - ## Parameters - - - `setParams` - Function used to manipulate the default NDependDefaults value. - - ## Sample - - NDepend (fun p -> { p with - ProjectFile = currentDirectory @@ "NDependProjectFile.ndproj" - CoverageFiles = [artifactsDir @@ "DotCover.xml" ] - }) - - - - - Contains a task which allows to run [NDepend](http://www.ndepend.com/) on .NET project files. - - - - - The directory where the process will be started. - - - - - The timeout for the process. - - - - - (Required) Path to the NGenutil - - - - - NGen parameters - - - - - Runs ngen.exe install on given assemblies. - - - - - Runs ngen.exe with the given command. - - - - - NGen default parameters - - - - - This module contains helper function for the ngen.exe - - - - - Default: "" - - - - - Default: [TestRunnerErrorLevel](fake-unittestcommon-testrunnererrorlevel.html).Error - - - - - See [NUnitDomainModel](fake-nunitcommon-nunitdomainmodel.html). - - - - - Disables shadow copying of the assembly in order to provide improved performance. - - - - - The default timeout to be used for test cases. If any test exceeds the timeout value, it is cancelled and reported as an error. - - - - - The path to a custom XSLT transform file to be used to process the XML report. - - - - - The working directory. - - - - - Causes an identifying label to be displayed at the start of each test case. - - - - - Controls how NUnit loads tests in processes. See: [NUnitProcessModel](fake-nunitcommon-nunitprocessmodel.html). - - - - - Allows you to specify the version of the runtime to be used in executing tests. - - - - - Redirects error output created by the tests from standard error output (console) to the file specified as value. - - - - - Redirects output created by the tests from standard output (console) to the file specified as value. - - - - - The output path of the nUnit XML report. - - - - - Causes execution of the test run to terminate immediately on the first test failure or error. - - - - - Suppresses use of a separate thread for running the tests and uses the main thread instead. - - - - - NUnit console runner name. ( `nunit-console.exe`) - - - - - The path to the NUnit console runner: `nunit-console.exe` - - - - - The [Categories](http://www.nunit.org/index.php?p=category&r=2.6.4) to be excluded in a test run. Multiple categories may be specified on either option, by using commas to separate them. - - - - - The [Categories](http://www.nunit.org/index.php?p=category&r=2.6.4) to be included in a test run. Multiple categories may be specified on either option, by using commas to separate them. - - - - - The [NUnit](http://www.nunit.org/) Console Parameters type. - FAKE will use [NUnitDefaults](fake-nunitcommon.html) for values not provided. - - For reference, see: [NUnit-Console Command Line Options](http://www.nunit.org/index.php?p=consoleCommandLine&r=2.6.4) - - - - - A separate test domain is created for each assembly - - - - - A test domain is created - this is how NUnit worked prior to version 2.4 - - - - - No domain is created - the tests are run in the primary domain. This normally requires copying the NUnit assemblies into the same directory as your tests. - - - - - The default is to use multiple domains if multiple assemblies are listed on the command line. Otherwise a single domain is used. - - - - - The /domain option controls of the creation of AppDomains for running tests. See [NUnit-Console Command Line Options](http://www.nunit.org/index.php?p=consoleCommandLine&r=2.6.4) - - - - - Process model for nunit to use, see [Project Editor](http://www.nunit.org/index.php?p=projectEditor&r=2.6.4) - - - - - Option which allows to specify if a NUnit error should break the build. - - - - - NUnit console returns negative error codes for errors and sum of failed, ignored and exceptional tests otherwise. - Zero means that all tests passed. - - - - - Tries to detect the working directory as specified in the parameters or via TeamCity settings - [omit] - - - - - Builds the command line arguments from the given parameter record and the given assemblies. - [omit] - - - - - The [NUnitParams](fake-nunitcommon-nunitparams.html) default parameters. - - ## Defaults - - `IncludeCategory` - `""` - - `ExcludeCategory` - `""` - - `ToolPath` - `""` - - `ToolName` - `"nunit-console.exe"` - - `DontTestInNewThread`- `false` - - `StopOnError` - `false` - - `OutputFile` - The `nunit-console.exe` path if it exists in a subdirectory of the current directory. - - `Out` - `""` - - `ErrorOutputFile` - `""` - - `WorkingDir` - `""` - - `Framework` - `""` - - `ProcessModel` - `DefaultProcessModel` - - `ShowLabels` - `true` - - `XsltTransformFile` - `""` - - `TimeOut` - 5 minutes - - `DisableShadowCopy` - `false` - - `Domain` - `DefaultDomainModel` - - `ErrorLevel` - `Error` - - `Fixture` - `""` - - - - - Contains types and utility functions relaited to running [NUnit](http://www.nunit.org/) unit tests. - - - - - Runs NUnit in parallel on a group of assemblies. - ## Parameters - - - `setParams` - Function used to manipulate the default [NUnitParams](fake-nunitcommon-nunitparams.html) value. - - `assemblies` - Sequence of one or more assemblies containing NUnit unit tests. - - ## Sample usage - - Target "Test" (fun _ -> - !! (testDir + @"\Test.*.dll") - |> NUnitParallel (fun p -> { p with ErrorLevel = DontFailBuild }) - ) - - - - - Contains tasks to run [NUnit](http://www.nunit.org/) unit tests in parallel. - - - - - Runs NUnit on a group of assemblies. - ## Parameters - - - `setParams` - Function used to manipulate the default [NUnitParams](fake-nunitcommon-nunitparams.html) value. - - `assemblies` - Sequence of one or more assemblies containing NUnit unit tests. - - ## Sample usage - - Target "Test" (fun _ -> - !! (testDir + @"\Test.*.dll") - |> NUnit (fun p -> { p with ErrorLevel = DontFailBuild }) - ) - - - - - Contains tasks to run [NUnit](http://www.nunit.org/) unit tests. - - - - - Returns whether all tests in the given test result have succeeded - - - - - [omit] - - - - - Merges non-empty list of test result XDocuments into a single XElement - - - - - Used by the NUnitParallel helper, can also be used to merge test results - from multiple calls to the normal NUnit helper. - - - - - Contains types and functions for working with [NUnit](http://www.nunit.org/) unit tests result xml. - - - - - The Npm parameter type - - - - - The list of supported Npm commands. The `Custom` alternative - can be used for other commands not in the list until they are - implemented - - - - - Arguments for the Npm install command - - - - - Runs npm with the given modification function. Make sure to have npm installed, - you can install npm with nuget or a regular install. To change which `Npm` executable - to use you can set the `NpmFilePath` parameter with the `setParams` function. - - ## Parameters - - - `setParams` - Function used to overwrite the Npm default parameters. - - ## Sample - - Target "Web" (fun _ -> - Npm (fun p -> - { p with - Command = Install Standard - WorkingDirectory = "./src/FAKESimple.Web/" - }) - - Npm (fun p -> - { p with - Command = (Run "build") - WorkingDirectory = "./src/FAKESimple.Web/" - }) - ) - - - - - Npm default parameters - - - - - Default paths to Npm - - - - - Contains function to run npm tasks - - - - - NuGet configuration file. Default `None`. - - - - - Disable looking up packages from local machine cache. Default `false`. - - - - - Do not prompt for user input or confirmations. Default `true`. - - - - - Display this amount of details in the output: normal, quiet, detailed. Default `normal`. - - - - - Specifies the directory in which packages will be installed. Default `./packages/`. - - - - - Allows updating to prerelease versions. Default `false`. - - - - - If set, the destination directory will contain only the package name, not the version number. Default `false`. - - - - - The version of the package to install. - - - - - Nuget feeds to search updates in. Use default if empty. - - - - - Number of retries if update fails. - - - - - Timeout for the update. - - - - - Path to the nuget.exe. - - - - - Nuget install parameters. - - - - - Nuget install verbosity mode. - - - - - Installs the given package. - - ## Parameters - - - `setParams` - Function used to manipulate the default parameters. - - `packagesFile` - Path to the `*.sln`, `*.*proj` or `packages.config` file, or simply a NuGet package name - - - - - [omit] - - - - - [omit] - - - - - Parameter default values. - - - - - Contains tasks for installing NuGet packages using the [nuget.exe install command](http://docs.nuget.org/docs/reference/command-line-reference#Install_Command). - - - - - NuGet configuration file. Default `None`. - - - - - Do not prompt for user input or confirmations. Default `true`. - - - - - Allows updating to prerelease versions. Default `false`. - - - - - Show verbose output while updating. Default `false`. - - - - - Looks for updates with the highest version available within the same major and minor version as the installed package. Default `false`. - - - - - Folder to store packages in. Default `./packages`. - - - - - Packages to update. Update all if empty. - - - - - Nuget feeds to search updates in. Use default if empty. - - - - - Number of retries if update fails. - - - - - Timeout for the update. - - - - - Path to the nuget.exe. - - - - - Nuget update parameters. - - - - - Update packages specified in the package file. - - Fails if packages are not installed; see [nuget bug](https://nuget.codeplex.com/workitem/3874). - Fails if packages file has no corresponding VS project; see [nuget bug](https://nuget.codeplex.com/workitem/3875). - ## Parameters - - - `setParams` - Function used to manipulate the default parameters. - - `packagesFile` - Path to the `*.sln`, `*.*proj` or `packages.config` file. - - - - - [omit] - - - - - Parameter default values. - - - - - Contains tasks for updating NuGet packages including assembly hint paths in the project files using the [nuget.exe update command](http://docs.nuget.org/docs/reference/command-line-reference#Update_Command). - - - - - NuSpec metadata type - - - - - Nuget parameter type - - - - - Build a symbol package using the nuspec file - - - - - Build a symbol package using a project file, if provided - - - - - Do not build symbol packages - - - - - Returns the dependencies from specified packages.config file - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - Default NuGet feed - - - - - Returns the NuGet meta data from the given package file name. - ## Parameters - - - `packageFileName` - The .nuspec package file name. - - - - - Parses nuspec metadata from a nuspec file. - ## Parameters - - - `nuspec` - The .nuspec file content. - - - - - Creates a new NuGet package. - ## Parameters - - - `setParams` - Function used to manipulate the default NuGet parameters. - - `nuspecFile` - The .nuspec file name. - - - - - Publishes a NuGet package to the nuget server. - ## Parameters - - - `setParams` - Function used to manipulate the default NuGet parameters. - - - - - Creates a new NuGet package based on the given .nuspec file. - ## Parameters - - - `setParams` - Function used to manipulate the default NuGet parameters. - - `nuspecOrProjectFile` - The .nuspec or project file name. - - - - - Creates a new NuGet package based on the given .nuspec file. - ## Parameters - - - `setParams` - Function used to manipulate the default NuGet parameters. - - `nuspecOrProjectFile` - The .nuspec or project file name. - - - - - push package to symbol server (and try again if something fails) - - - - - push package (and try again if something fails) - - - - - Creates a NuGet package without templating (including symbols package if enabled) - - - - - Gets the version no. for a given package in the deployments folder - - - - - Creates a string which tells NuGet that you require exactly this package version. - - - - - NuGet default parameters - - - - - Contains helper functions and task which allow to inspect, create and publish [NuGet](https://www.nuget.org/) packages. - There is also a tutorial about [nuget package creating](../create-nuget-package.html) available. - - - - - Complete Octo.exe CLI params - - - - - Option type for selecting one command - - - - - Maximum (inclusive) version number for the range of versions to delete - - - - - Minimum (inclusive) version number for the range of versions to delete - - - - - Name of the project - - - - - Options for deleting a range of releases in a project - - - - - A comma-separated list of machine names to target in the - deployed environment. If not specified, all machines in - the environment will be considered. - - - - - Specifies how much time should elapse between deployment status - checks (default: 10 seconds) - - - - - Specifies maximum time that deployment can take - (default: 10 minutes) - - - - - Whether to wait synchronously for deployment to finish - - - - - If a project is configured to skip packages with already-installed - versions, override this setting to force re-deployment - - - - - Version number of the release to deploy; Specify "latest" for - the latest release - - - - - Environment to deploy to - - - - - Name of the project - - - - - Options for deploying a release to an environment - - - - - Ignore package version matching rules - - - - - Channel to use for the new release - - - - - If a release with the version number already exists, ignore it - - - - - Path to a file that contains Release Notes for the new release - - - - - Release Notes for the new release - - - - - A folder containing NuGet packages from which we should get versions - - - - - Version number to use for a package in the release - - - - - Default version of all packages to use for this release - - - - - Release number to use for the new release - - - - - Name of the project - - - - - Options for creating a new release - - - - - Your API key; retrieved from the user profile page. - - - - - The base URL for your Octopus server - - - - - Octo.exe server options - - - - - This task calls the Octo.exe CLI. - See [Octopus-Tools](https://github.com/OctopusDeploy/Octopus-Tools) for more details. - ## Parameters - - - `setParams` - Function used to overwrite the OctoTools default parameters. - - - - - Maps a command to string input for the octopus tools cli. - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - Default parameters to call octo.exe. - - - - - Default options for 'DeleteReleases' - - - - - Default options for 'DeployRelease' - - - - - Default options for 'CreateRelease' - - - - - Default server options. - - - - - Contains tasks which can be used for automated deployment via [Octopus Deploy](http://octopusdeploy.com/). - There is also a tutorial about the [Octopus deployment helper](../octopusdeploy.html) available. - - - - - This options is used to add additional optional arguments, could be somthing like "-returntargetcode " - - - - - This option is used to merge the coverage results for an assembly regardless of where it was loaded - assuming the assembly has the same file-hash in each location. - - - - - The directory where the OpenCover process will be started. - - - - - The timeout for the OpenCover process. - - - - - A list of filters to apply to selectively include or exclude assemblies and classes from coverage results. - - - - - Use this to register and de-register the code coverage profiler. - - - - - The location and name of the output xml file. - If no value is supplied then the current directory - will be used and the output filename will be results.xml. - - - - - (Required) Path to the NUnit/XUnit console runner - - - - - (Required) Path to the OpenCover console application - - - - - OpenCover parameters, for more details see: https://github.com/OpenCover/opencover/wiki/Usage#console-application-usage. - - - - - Runs OpenCover on a group of assemblies. - ## Parameters - - - `setParams` - Function used to overwrite the default OpenCover parameters. - - `targetArgs` - Test runner arguments. - - ## Sample - - OpenCover (fun p -> { p with TestRunnerExePath = "./Tools/NUnit/nunit-console.exe" }) - "project-file.nunit /config:Release /noshadow /xml:artifacts/nunit.xml /framework:net-4.0" - - - - - Builds the command line arguments from the given parameter record - [omit] - - - - - OpenCover default parameters - - - - - Contains a task which can be used to run [OpenCover](https://github.com/sawilde/opencover) on .NET assemblies. - - - - - Paket push parameter type - - - - - Paket pack parameter type - - - - - Returns the dependencies from specified paket.references file - - - - - Pushes all NuGet packages in the working dir to the server by using Paket push. - ## Parameters - - - `setParams` - Function used to manipulate the default parameters. - - - - - Creates a new NuGet package by using Paket pack on all paket.template files in the working directory. - ## Parameters - - - `setParams` - Function used to manipulate the default parameters. - - - - - Paket push default parameters - - - - - Paket pack default parameters - - - - - Contains helper functions and task which allow to inspect, create and publish [NuGet](https://www.nuget.org/) packages with [Paket](http://fsprojects.github.io/Paket/index.html). - - - - - Checks that the current user has administrator permissions - otherwise it throws an exception. - ## Parameters - - `f` - This Function will be excuted if the use has the right permissions. - - ## Sample - - Target "Install" (fun _ -> - requiresAdmin (fun _ -> installMSI()) - ) - - - - - Returns whether the given user has administrator permissions. - ## Parameters - - `identity` - The windows identity of the user in question. - - - - - Contains functions which allow to deal with permissions. - - - - - Runs the given process, waits for it's completion and returns the exit code. - ## Parameters - - - `cmd` - The command which should be run in elavated context. - - `args` - The process arguments (optional). - - `directory` - The working directory (optional). - - - - - Runs the given process asynchronously. - ## Parameters - - - `cmd` - The command which should be run in elavated context. - - `args` - The process arguments (optional). - - `directory` - The working directory (optional). - - - - - Allows to exec shell operations synchronously and asynchronously. - - - - - Command-line argument pairs. The value will be quoted if it contains - a string, and the result will be appended to the CommandLine property. - If the key ends in a letter or number, a space will be inserted between - the key and the value. - - - - - Command-line parameters in a string. - - - - - The working directory for the program. Defaults to "". - - - - - The path to the executable, without arguments. - - - - - Parameter type for process execution. - - - - - A process result including error code, message log and errors. - - - - - A record type which captures console messages - - - - - Execute an external program and return the exit code. - [omit] - - - - - Waits until the processes with the given name have stopped or fails after given timeout. - ## Parameters - - `name` - The name of the processes in question. - - `timeout` - The timespan to time out after. - - - - - Kills all processes that are created by the FAKE build script unless "donotkill" flag was set. - - - - - [omit] - - - - - Kills the MSBuild process. - - - - - Kills the F# Interactive (FSI) process. - - - - - Kills all processes with the given name - - - - - Returns all processes with the given name - - - - - Kills all processes with the given id - - - - - Kills the given process - - - - - Execute an external program asynchronously and return the exit code, - logging output and error messages to FAKE output. You can compose the result - with Async.Parallel to run multiple external programs at once, but be - sure that none of them depend on the output of another. - - - - - Default parameters for process execution. - - - - - Tries to find the tool via AppSettings. If no path has the right tool we are trying the PATH system variable. - [omit] - - - - - Tries to find the tool via AppSettings. If no path has the right tool we are trying the PATH system variable. - [omit] - - - - - Returns the AppSettings for the key - Splitted on ; - [omit] - - - - - Searches the current directory and the directories within the PATH - environment variable for the given file. If successful returns the full - path to the file. - ## Parameters - - `file` - The file to locate - - - - - Searches the given directories for the given file, failing if not found. - [omit] - - - - - Searches the given directories for all occurrences of the given file name - [omit] - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - Use default Parameters - [omit] - - - - - Adds quotes and a blank around the string´. - [omit] - - - - - Adds quotes around the string if needed - [omit] - - - - - Adds quotes around the string - [omit] - - - - - Starts a remote windows service. Waits up to two minutes for a response. - - - - - Starts a local windows service. Waits up to two minutes for a response. - - - - - Stops a remote windows service. Waits up to two minutes for a response. - - - - - Stops a local windows service. Waits up to two minutes for a response. - - - - - Sends a command to a local windows service. - - - - - Sends a command to a remote windows service. - - - - - Starts the given process and forgets about it. - - - - - Runs the given process, waits for its completion and returns if it succeeded. - - - - - Starts the given process and returns immediatly. - - - - - Runs the given process and returns true if the exit code was 0. - [omit] - - - - - Sets the environment Settings for the given startInfo. - Existing values will be overriden. - [omit] - - - - - Gets the list of valid directories included in the PATH environment variable. - - - - - Runs the given process in an elevated context and returns the exit code. - ## Parameters - - - `cmd` - The command which should be run in elavated context. - - `args` - The process arguments. - - `timeOut` - The timeout for the process. - - - - - Runs the given process and returns the exit code. - ## Parameters - - - `configProcessStartInfoF` - A function which overwrites the default ProcessStartInfo. - - `timeOut` - The timeout for the process. - ## Sample - - let result = ExecProcess (fun info -> - info.FileName <- "c:/MyProc.exe" - info.WorkingDirectory <- "c:/workingDirectory" - info.Arguments <- "-v") (TimeSpan.FromMinutes 5.0) - - if result <> 0 then failwithf "MyProc.exe returned with a non-zero exit code" - - - - - Runs the given process and returns if the exit code was 0. - ## Parameters - - - `configProcessStartInfoF` - A function which overwrites the default ProcessStartInfo. - - `timeOut` - The timeout for the process. - [omit] - - - - - Runs the given process and returns the exit code. - ## Parameters - - - `configProcessStartInfoF` - A function which overwrites the default ProcessStartInfo. - - `timeOut` - The timeout for the process. - [omit] - - - - - Runs the given process and returns the exit code. - ## Parameters - - - `configProcessStartInfoF` - A function which overwrites the default ProcessStartInfo. - - `timeOut` - The timeout for the process. - - `silent` - If this flag is set then the process output is redicted to the trace. - [omit] - - - - - Runs the given process and returns the process result. - ## Parameters - - - `configProcessStartInfoF` - A function which overwrites the default ProcessStartInfo. - - `timeOut` - The timeout for the process. - - - - - Runs the given process and returns the process result. - ## Parameters - - - `configProcessStartInfoF` - A function which overwrites the default ProcessStartInfo. - - `timeOut` - The timeout for the process. - - - - - Runs the given process and returns the exit code. - ## Parameters - - - `configProcessStartInfoF` - A function which overwrites the default ProcessStartInfo. - - `timeOut` - The timeout for the process. - - `silent` - If this flag is set then the process output is redirected to the given output functions `errorF` and `messageF`. - - `errorF` - A function which will be called with the error log. - - `messageF` - A function which will be called with the message log. - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - Contains functions which can be used to start other tools. - - - - - Option which allows to specify if a test runner error should break the build. - - - - - If the timeout is reached the xUnit task will be killed. Default is 5 minutes. - - - - - The working directory (optional). - - - - - The ProcessTestRunner parameter type. - - - - - Runs the given processes and returns the process results. - ## Parameters - - - `setParams` - Function used to manipulate the default parameter value. - - `processes` - Sequence of one or more filenames and arguments to run. - - ## Sample usage - - Target "Test" (fun _ -> - ["process1.exe","argument1" - "process2.exe","argument2"] - |> RunConsoleTests (fun p -> {p with TimeOut = TimeSpan.FromMinutes 1. }) - ) - - - - - Runs the given processes and returns the process result messages. - - - - - Runs the given process and returns the process result. - - - - - The ProcessTestRunner defaults. - - - - - Allows to execute processes as unit tests. - - - - - Option type for the HTTP verb - - - - - Executes an HTTP POST command and retrives the information. - It returns the response of the request, or null if we got 404 or nothing. - ## Parameters - - - `url` - The URL to perform the POST operation. - - `userName` - The username to use with the request. - - `password` - The password to use with the request. - - `data` - The data to post. - - - - - Executes an HTTP POST command and retrives the information. - This function will automatically include a "source" parameter if the "Source" property is set. - It returns the response of the request, or null if we got 404 or nothing. - ## Parameters - - - `headerF` - A function which allows to manipulate the HTTP headers. - - `url` - The URL to perform the POST operation. - - `userName` - The username to use with the request. - - `password` - The password to use with the request. - - `data` - The data to post. - - - - - Executes an HTTP GET command and retrives the information. - It returns the response of the request, or null if we got 404 or nothing. - ## Parameters - - - `userName` - The username to use with the request. - - `password` - The password to use with the request. - - `url` - The URL to perform the GET operation. - - - - - Contains functions to execute typical HTTP/REST calls. - - - - - Raygun user access token for allowing API - access. (Creatd under User -> My settings in the web application) - Required, no sensible default - - - - - Endpoint to connect to - Required, Defaults to: https://app.raygun.io/deployments - - - - - Connection configuration - - - - - Datetime of the deployment - Optional, Defaults to System.DateTime.UtcNow - - - - - Hash code (or other commit identifier) from - source control system - Optional, Defaults to current git hash if executed from a git repository - else defaults to empty string - - - - - Release notes - Optional, defaults to empty string - - - - - Email address of person responsible for deployment - Optional, defaults to empty string - - - - - Name of person responsible for deployment - Optional, defaults to empty string - - - - - Version string describing deployed version - Should be the same as reported by the application - to raygun when posting an error - Required, no sensible default - - - - - Application API key - Required, no sensible default - - - - - Data describing a deployment to Raygun - - - - - ### Report a deployment to raygun - - Reports a deployment to raygun so reported errors can be - correlated with deployments - - ### Paramteres - - * settings : Function that sets the raygun connection settings. - * data : Function that sets the deployment data - - - - - Enables deployment tracking using Raygun.io - - Thin wrapper around [the Raygun HTTP deployment API](https://raygun.io/docs/deployments/api) - - - - - RegAsm parameter type - - - - - Executes `Regasm.exe` with the `/codebase /tlb /unregister` options - - Used to unregegister any temporarily registerd .net dependencies - _after_ running a VB6 build - - - - - Executes `RegAsm.exe` with the `/codebase` `/tlb` option - - Used to temporarily register any .net dependencies before running - a VB6 build - - - - - Runs regasm on the given lib - ## Parameters - - - `setParams` - Function used to manipulate the default RegAsm parameters. - - `lib` - The assembly file name. - - - - - RegAsm default params - - - - - Path to newest `regasm.exe` - - - - - Contains a task which can be used to run regasm .NET assembly - - - - - Registry base keys. - - - - - Returns all the subKey names of a registry key - - - - - Deletes a registry subKey - - - - - Create a registry subKey - - - - - Returns whether or not a registry value name exists for a key - - - - - Returns all the value names of a registry key - - - - - Deletes the registry value from its key - - - - - Sets a registry value - - - - - Gets a registy value as string - - - - - Gets a registy value as string - - - - - Gets a registy key and falls back to 32 bit if the 64bit key is not there - - - - - Gets a 64-bit registy key - - - - - Maps the RegistryBaseKey to a RegistryKey for a 32bit System - [omit] - - - - - Maps the RegistryBaseKey to a RegistryKey for a 64bit System - [omit] - - - - - Maps the RegistryBaseKey to a RegistryKey - [omit] - - - - - Contains functions which allow to read and write information from/to the registry. - - - - - Release date - - - - - Semantic version - - - - - The nuget package version. - - - - - The parsed version. - - - - - Contains the parsed information of the release notes text file. - - - - - Parses a Release Notes text file and returns the lastest release notes. - - ## Parameters - - `fileName` - Release notes text file name - - - - - Parses a Release Notes text and returns the lastest release notes. - - ## Parameters - - `data` - Release notes text - - - - - Parses a Release Notes text and returns all release notes. - - ## Parameters - - `data` - Release notes text - - - - - Parse "complex" release notes text sequence - - - - - Parse simple release notes sequence - - - - - Contains helpers which allow to parse Release Notes text files. Either "simple" or "complex" format is accepted. - - ## Formats - - ### Simple format - - * 1.1.10 - Support for heterogeneous XML attributes. Make CsvFile re-entrant. - * 1.1.9 - Infer booleans for ints that only manifest 0 and 1. - - ### Complex format - - ### New in 1.1.10 (Released 2013/09/12) - * Support for heterogeneous XML attributes. - * Make CsvFile re-entrant. - * Support for compressed HTTP responses. - * Fix JSON conversion of 0 and 1 to booleans. - - ### New in 1.1.9 (Released 2013/07/21) - * Infer booleans for ints that only manifest 0 and 1. - * Support for partially overriding the Schema in CsvProvider. - * PreferOptionals and SafeMode parameters for CsvProvider. - - ## Sample - - let release = - ReadFile "RELEASE_NOTES.md" - |> ReleaseNotesHelper.parseReleaseNotes - - - Target "AssemblyInfo" (fun _ -> - CreateFSharpAssemblyInfo "src/Common/AssemblyInfo.fs" - [ Attribute.Title project - Attribute.Product project - Attribute.Description summary - Attribute.Version release.AssemblyVersion - Attribute.FileVersion release.AssemblyVersion] - ) - - - - - The timeout for the ReportGenerator process. - - - - - The directory where the ReportGenerator process will be started. - - - - - The verbosity level of the log messages. - - - - - Optional list of assemblies that should be included or excluded - in the report. Exclusion filters take precedence over inclusion - filters. Wildcards are allowed. - - - - - Optional directory for storing persistent coverage information. - Can be used in future reports to show coverage evolution. - - - - - Optional directories which contain the corresponding source code. - - - - - The output formats and scope. - - - - - (Required) The directory where the generated report should be saved. - - - - - (Required) Path to the ReportGenerator exe file. - - - - - ReportGenerator parameters, for more details see: https://github.com/danielpalme/ReportGenerator. - - - - - Runs ReportGenerator on one or more coverage reports. - ## Parameters - - - `setParams` - Function used to overwrite the default ReportGenerator parameters. - - `reports` - Coverage reports. - - ## Sample - - ReportGenerator (fun p -> { p with TargetDir = "c:/reports/" }) [ "c:/opencover.xml" ] - - - - - Builds the report generator command line arguments from the given parameters and reports - [omit] - - - - - ReportGenerator default parameters - - - - - Contains a task which can be used to run [ReportGenerator](https://github.com/danielpalme/ReportGenerator), - which converts XML reports generated by PartCover, OpenCover or NCover into a readable report in various formats. - - - - - Specifies how often nuget should try to restore the packages - default is 5 - - - - - RestorePackages parameter path for single packages - - - - - Specifies how often nuget should try to restore the packages - default is 5 - - - - - RestorePackages parameter path - - - - - Restores the packages in the given solution file file from NuGet. - ## Parameters - - - `setParams` - Function used to manipulate the default NuGet parameters. - - `solutionFile` - The microsoft sln file name. - - ## Sample - - Target "RestorePackages" (fun _ -> - "./scr/Everything.sln" - |> RestoreMSSolutionPackages (fun p -> - { p with - Sources = "http:://myNugetSources.com" :: p.Sources - OutputPath = outputDir - Retries = 4 }) - ) - - - - - Restores all packages from NuGet to the default directories by scanning for packages.config files in any subdirectory. - - - - - Restores the packages in the given packages.config file from NuGet. - ## Parameters - - - `setParams` - Function used to manipulate the default NuGet parameters. - - `packageFile` - The packages.config file name. - - ## Sample - - Target "RestorePackages" (fun _ -> - "./scr/ProjectA/packages.config" - |> RestorePackage (fun p -> - { p with - Sources = "http:://myNugetSources.com" :: p.Sources - OutputPath = outputDir - Retries = 4 }) - ) - - - - - Restores the given package from NuGet - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - RestoreSinglePackageParams defaults parameters - - - - - RestorePackage defaults parameters - - - - - Looks for NuGet.exe in [1] the specified defaultPath, [2] a list of standard tool folders, [3] any subfolder in the current directory, [4] the PATH - returns the first path where NuGet.exe was found. - - - - - Contains tasks which allow to restore NuGet packages from a NuGet package feed like [nuget.org](http://www.nuget.org). - There is also a tutorial about [nuget package restore](../nuget.html) available. - - - - - Executes a RoboCopy mirror command (potentially destructive) - ## Parameters - - `source` - The source directory - - `destination` - The target directory - - - - - Executes a RoboCopy command - ## Parameters - - `source` - The source directory - - `destination` - The target directory - - - - - Executes a RoboCopy command with options - ## Parameters - - `source` - The source directory - - `destination` - The target directory - - `options` - The options to pass to robocopy - - - - - Contains a task to use [robocopy](https://en.wikipedia.org/wiki/Robocopy) on Windows. - - - - - The schema where RH stores it's tables - - - - - A timeout for the runner. - - - - - Working directory (optional). - - - - - FileName of the Roundhouse runner. - - - - - Instructs RH to execute changed one time scripts (DDL/DML in Up folder) that have previously been run against the database instead of failing. A warning is logged for each one time scripts that is rerun. - - - - - The name of the folder where you keep your permissions scripts. - - - - - The name of the folder where you keep scripts that will be run after all of the other any time scripts complete. - - - - - The name of the folder where you keep your indexes. - - - - - The name of the folder where you keep your stored procedures. - - - - - The name of the folder where you keep your views. - - - - - The name of the folder where you keep your functions. - - - - - The name of the folder where you keep any functions, views, or sprocs that are order dependent. If you have a function that depends on a view, you definitely need the view in this folder. - - - - - The name of the folder where you keep your update scripts. - - - - - The name of the folder where you keep scripts that you want to run before your update scripts. - - - - - The name of the folder where you will keep scripts that ONLY run after a database is created. - - - - - The name of the folder where you keep your alter database scripts. Read up on token replacement. You will want to use {{DatabaseName}} here instead of specifying a database name. - - - - - Tells RH not to ask for any input when it runs. - - - - - This instructs RH to do a restore (with the restorefrompath parameter) of a database before running migration scripts. - - - - - This instructs RH to run inside of a transaction. - - - - - This instructs RH to set the database recovery mode to simple recovery. Only works with SqlServer. - - - - - This instructs RH to remove a database and not run migration scripts. - - - - - File path of back when Restore is set to true - - - - - This instructs RH to use this script for creating a database instead of the default based on the SQLType. - - - - - This allows RH to be environment aware and only run scripts that are in a particular environment based on the namingof the script. LOCAL.something**.ENV.**sql would only be run in the LOCAL environment. - - - - - Path to code repository to be able to correlate versions - - - - - Works in conjunction with an XML version file. - - - - - Path to the file to use for versioning. Either a .XML file, a .DLL or a .TXT file that a version can be resolved from. - - - - - Output path. Path to where migration artifacts are stored. - - - - - Database Type (fully qualified class name implementing [roundhouse.sql.Database, roundhouse]) - - - - - This is the timeout when administration commands are run (except for restore, which has its own). - - - - - This is the timeout when commands are run. This is not for admin commands or restore. - - - - - This is used for connecting to master when you may have a different uid and password than normal. - - - - - As an alternative to ServerName and Database - You can provide an entire connection string instead. - - - - - The server and instance you would like to run on. (local) and (local)\SQL2008 are both valid values. - - - - - The directory where your SQL scripts are. - - - - - The database you want to create/migrate. - - - - - Parameter type to configure the RoundhousE runner - - - - - This task to can be used to run [RoundhousE](http://projectroundhouse.org/) for database migrations. - ## Parameters - - - `setParams` - Function used to overwrite the Roundhouse default parameters. - - ## Sample - - Roundhouse (fun p -> { p with - SqlFilesDirectory = ".\database" - ServerDatabase = "(local)" - DatabaseName = "atxc" - WarnOnOneTimeScriptChanges = true }) - - - - - - Roundhouse default parameters - tries to locate rh.exe in any subfolder. - - - - - Contains tasks to run [RoundhousE](http://projectroundhouse.org/) database migrations. - - - - - Path of the private key file (optional) - - - - - Path of the scp.exe - - - - - The SCP parameter type. - - - - - Performs a SCP copy from the given source directory to the target path. - ## Parameters - - - `setParams` - Function used to manipulate the default SCPParams value. - - `source` - The source path. Can be something like user@host:directory/SourceFile or a local path. - - `target` - The target path. Can be something like user@host:directory/TargetFile or a local path. - - ## Sample - - SCP (fun p -> { p with ToolPath = "tools/scp.exe" }) source target - - - - - The SCP default parameters - - - - - Conatins a task which allows to perform file copies using [SCP](http://en.wikipedia.org/wiki/Secure_copy), which is based on the Secure Shell (SSH) protocol. - - - - - The optional build no. - - - - - The optional PreRelease version - - - - - PATCH version when you make backwards-compatible bug fixes. - - - - - MINOR version when you add functionality in a backwards-compatible manner. - - - - - MAJOR version when you make incompatible API changes. - - - - - Contains the version information. - - - - - Parses the given version string into a SemVerInfo which can be printed using ToString() or compared - according to the rules described in the [SemVer docs](http://semver.org/). - ## Sample - - parse "1.0.0-rc.1" < parse "1.0.0" // true - parse "1.2.3-alpha" > parse "1.2.2" // true - parse "1.2.3-alpha2" > parse "1.2.3-alpha" // true - parse "1.2.3-alpha002" > parse "1.2.3-alpha1" // true - parse "1.5.0-beta.2" > parse "1.5.0-rc.1" // false - - - - - Returns true if input appears to be a parsable semver string - - - - - Contains helpers which allow to deal with [Semantic Versioning](http://semver.org/) (SemVer). - - - - - Waits until the local service with the given name has been stopped or fails after given timeout - ## Parameters - - `name` - The name of the service in question. - - `timeout` - The timespan to time out after. - - - - - Waits until the remote service with the given name has been stopped or fails after given timeout - ## Parameters - - `host` - The hostname of the remote machine. - - `name` - The name of the service in question. - - `timeout` - The timespan to time out after. - - - - - Waits until the local service with the given name has been started or fails after given timeout - ## Parameters - - `name` - The name of the service in question. - - `timeout` - The timespan to time out after. - - - - - Waits until the remote service with the given name has been started or fails after given timeout - ## Parameters - - `host` - The hostname of the remote machine. - - `name` - The name of the service in question. - - `timeout` - The timespan to time out after. - - - - - Stops all local services with given name. - ## Parameters - - `name` - The name of the services in question. - - - - - Stops all services with given name. - ## Parameters - - `host` - The hostname of the remote machine. - - `name` - The name of the services in question. - - - - - Starts all local services with given name. - ## Parameters - - `name` - The name of the services in question. - - - - - Starts all remote services with given name. - ## Parameters - - `host` - The hostname of the remote machine. - - `name` - The name of the services in question. - - - - - Returns status of the local service with given name or fails when service is not found. - ## Parameters - - `name` - The name of the service in question. - - - - - Returns status of the remote service with given name or fails when service is not found. - ## Parameters - - `host` - The hostname of the remote machine. - - `name` - The name of the service in question. - - - - - Returns whether a local service with the given name exists. - ## Parameters - - `name` - The name of the service in question. - - - - - Returns whether a remote service with the given name exists. - ## Parameters - - `host` - The hostname of the remote machine. - - `name` - The name of the service in question. - - - - - Returns the first local service with given name or None. - ## Parameters - - `name` - The name of the service in question. - - - - - Returns the first remote service with given name or None. - ## Parameters - - `host` - The hostname of the remote machine. - - `name` - The name of the service in question. - - - - - Returns sequence of local services with given name. - ## Parameters - - `name` - The name of the services in question. - - - - - Returns sequence of remote services with given name. - ## Parameters - - `host` - The hostname of the remote machine. - - `name` - The name of the services in question. - - - - - Returns whether the given service has the given name as display or service name. - ## Parameters - - `name` - The name to check for. - - `service` - The service in question. - - - - - Get friendly service name for displaying in logs - - - - - Host value used for querying local services. - - - - - Contains tasks which allow to control NT services. - - - - - The optional url of the timestamp server to use - - - - - The optional real certificate that will be used when it is found - - - - - The dev certificate that will be used when the real certificate can not be found - - - - - Parameters used for signing. - - - - - The file containing the password - - - - - The certificate files - - - - - Represents a certificate file and an optional password - - - - - Signs all files in filesToSign with the certification file certFile, - protected with the password in the file passFile. - The signtool will be search in the toolPath. - - - - - Signs assemblies according to the settings specified in the parameters using signtool.exe. - This will be looked up using the toolsPath parameter. - - - - - Contains a task to sign assemblies using the [SignTool](http://msdn.microsoft.com/en-us/library/windows/desktop/aa387764(v=vs.85).aspx). - - ## Certificates - The SignTool needs a certificate to sign assemblies. It is not a good idea to include a certficate in your - source control system, but the sign step should be usable on developer machines. Because of this, you can - specify a dev certificate that can safely included in your source control system. Whenever the real certificate - can not be found, the dev certificate will be used. - - - - - SpecFlow execution parameter type. - - - - - ## Parameters - - - `setParams` - Function used to manipulate the default SpecFlow parameter value. - - - - - SpecFlow default execution parameters. - - - - - Contains a task which allows to run [SpecFlow](http://www.specflow.org/) tests. - - - - - The secret key for the code signing certificate - - - - - The code signing certificate to be used for signing - - - - - Sign the installer with signtool.exe - - - - - Maximum time to allow Squirrel to run before being killed. - - - - - The path to Squirrel: `squirrel.exe` - - - - - Do not create an MSI file - - - - - The full path to an optional icon, which will be used for the generated installer. - - - - - The full path to an optional animated gif to be displayed during installation - - - - - The full path to an optional setup.exe template - - - - - The working directory. - - - - - The output directory for the generated installer - - - - - The [Squirrel](https://github.com/Squirrel/Squirrel.Windows) Console Parameters type. - FAKE will use [SquirrelDefaults](fake-squirrel.html) for values not provided. - - For reference, see: [Squirrel Command Line Options](https://github.com/Squirrel/Squirrel.Windows/blob/master/docs/advanced-releasify.md) - - - - - Creates a Squirrel installer for given NuGet package - Will fail if Squirrel terminates with non-zero exit code. - - ## Parameters - - - `setParams` - Function used to manipulate the default `SquirrelParams` value. - - `nugetPackage` - The package to create an installer for - - ## Sample usage - - Target "CreatePackage" (fun _ -> - SquirrelPack (fun p -> { p with WorkingDir = Some "./tmp" }) "./my.nuget" - ) - - - - - The Squirrel default parameters. - - ## Defaults - - - `ReleaseDir` - `""` - - `WorkingDir` - `None` - - `BootstrapperExe` - `None` - - `LoadingGif` - `None` - - `SetupIcon` - `None` - - `NoMsi` - `false` - - `ToolPath` - The `squirrel.exe` path if it exists in a subdirectory of the current directory. - - `TimeOut` - 10 minutes - - `SignExecutable` - `None` - - `SigningSecret` - `None` - - `SigningSecret` - `None` - - - - - Contains types and utility functions related to creating [Squirrel](https://github.com/Squirrel/Squirrel.Windows) installer. - - - - - Decodes a Base64-encoded UTF-8-encoded string - - - - - Determines if a text matches a given regex pattern. - - - - - Find a regex pattern in a text and replaces it with the given replacement. - - - - - Replaces the absolute path to a relative path. - - - - Produces relative path when possible to go from baseLocation to targetLocation. - The root folder - The target folder - The relative path relative to baseLocation - base or target locations are null or empty - - - - A cache of relative path names. - [omit] - - - - - Encapsulates the Apostrophe - - - - - Removes linebreaks from the given string - - - - - Reads a file line by line and replaces all line breaks to windows line breaks - - uses a temp file to store the contents in order to prevent OutOfMemory exceptions - - - - - Converts all line breaks in a text to windows line breaks - - - - - Represents Mac line breaks - - - - - Represents Windows line breaks - - - - - Represents Linux line breaks - - - - - Replaces the text in the given file - - - - - Checks whether the given text starts with the given prefix - - - - - Replaces any occurence of the currentDirectory with . - - - - - Reads a file as one array of bytes - - - - - Reads a file as one text - - - - - Appends all lines to a file line by line - - - - - Writes a file line by line - - - - - Replaces the file with the given string - - - - - Writes a string to a file - - - - - Writes a byte array to a file - - - - - Removes all trailing .0 from a version string - - - - - Writes a file line by line - - - - - Reads the first line of a file. This can be helpful to read a password from file. - - - - - Reads a file line by line - - - - - Lifts a string to an option - - - - - Trims the end of the given string - - - - - Trims the start of the given string - - - - - Trims the given string - - - - - Trims the given string - - - - - Trims all special characters from a string. - - - - - Trims the given string with the DirectorySeparatorChar - - - - - Checks whether the given char is a standard char or digit. - - - - - Returns all standard chars and digits. - - - - - Converts all characters in a string to lower case. - - - - - Checks whether the given char is a german umlaut. - - - - - [omit] - - - - - [omit] - - - - - [omit] - - - - - Returns the text from the StringBuilder - - - - - Appends all notnull fileNames. - - - - - Appends a text if the value is not null or empty. - - - - - Appends a text if the value is not null or empty. - - - - - Appends a text if the value is not null. - - - - - Appends a quoted text if the value is not null. - - - - - Appends a text if the value is not null. - - - - - Appends a text without quoting if the value is not null. - - - - - Appends a text if the predicate is false. - - - - - Appends a text if the predicate is true. - - - - - Appends string of function value if option has some value - - - - - Appends a text to a StringBuilder without surrounding quotes. - - - - - Appends a text to a StringBuilder. - - - - - Replaces the first occurrence of the pattern with the given replacement. - - - - - Determines whether the last character of the given <see cref="string" /> - matches Path.DirectorySeparatorChar. - - - - - Checks whether the given text ends with the given suffix - - - - - Checks whether the given text starts with the given prefix - - - - - Converts a sequence of strings into a string separated with line ends - - - - - Splits the given string at the given string delimiter - - - - - Splits the given string at the given char delimiter - - - - - Removes the slashes from the end of the given string - - - - - Converts a sequence of strings to a string with delimiters - - - - - Replaces the given pattern in the given text with the replacement - - - - - Returns if the string is null or empty or completely whitespace - - - - - Returns if the string is not null or empty - - - - - Returns if the string is null or empty - - - - - [omit] - - - - - Contains basic functions for string manipulation. - - - - - The directory where the Strong naming process will be started. - - - - - The timeout for the Strong naming process. - - - - - (Required) Path to the sn.exe - - - - - Strong naming parameters - - - - - Registers the given assembly for verification skipping. - - - - - Runs sn.exe with the given command. - - - - - Strong naming default parameters - - - - - This module contains helper function for Microsoft's sn.exe - - - - - Failed to find all reguired data - Includes an error message - - - - - Found all required data - Includes structured assembly data - - - - - Represents status of attempted parsing - of IL file created from executing `ildasm.exe` - on a binary - - - - - Dependent `.NET` assemblies of the executable - - - - - Version of the executable - - - - - Path of the executable binary file - - - - - Represents an executable to create an _application manifest_ for - - - - - Guid from the `System.Runtime.Interopservice.GuidAttribute` of the assembly - - - - - Assembly version - - - - - Path to the assembly file - - - - - Assembly name - - - - - Represents a `.NET` assembly that may be used in COM interop projects - - - - - Creates and adds _application interop side-by-side manifests_ to provided executables - - ## Parameters - - `workingdir` - somewhere to put any temporary files - - `applications` - Metadata about executables to create manifests for. - - - - - Gets `name`, `path', `version` and interop `Guid` for those of the provided assemblies that have - all of the required information. - - ## Parameters - - `workingDir` - Somewhere to put temporary files - - `assemblies` - assemblies to get data from - - ## Purpose - - In order to create _application_ interop side-by-side manifests we need to know some metadata - about the assemblies that may be referenced from COM executables. - For the manifest we need the _assembly version_ and _ assembly name_. And in addition to that - the interop _guid_ is collected so we can determine if the assembly is referenced by _vb6 projects_ - - ## Process - - This function is a _hack_. To avoid using reflection and loading all potential assemblies into the - appdomain (with all the possible problems that may cause). I wanted to get this metadata by other means. - I ended up using the windows sdk dissasembler `ildasm.exe` (ref: https://msdn.microsoft.com/en-us/library/f7dy01k1(v=vs.110).aspx) - to create the smallest dissasembly I could (Really only need the manifest part), and the parse the IL file to get the metadata - (If anyone knows a cleaner / better way, pls improve on the code) - - - - - Created and embeds assembly Side-by-side interop manifests for provided assemblies - - ## Parameters - - `workingDir` - somewhere to put any temp files created - - `assemblies` - .net assemblies to create manifests for - - ## Process - - This function will use `mt.exe` (ref: https://msdn.microsoft.com/en-us/library/aa375649(v=vs.85).aspx) - to create a manifest for each assembly. This created manifest is unfortunately _not_ a valid - interop Side-by-Side manifest, but it has the important `clrClass` elements, + `version` and `name`info that would be the most - difficult to create through other means. - The important info is then put into a valid base manifest and embedded into the assembly as a resource. - - - - - Embeds a manifest file in a binary using `mt.exe` - - - - - create XName from string __without__ manifest namespace - - - - - create XName from string with manifest namepace - - - - - XLM namespace of manifest files - - - - - Path to `ildasm.exe - .net fx dissasembly tool - ref: https://msdn.microsoft.com/en-us/library/f7dy01k1(v=vs.110).aspx - - - - - Path to `mt.exe` - ref: https://msdn.microsoft.com/en-us/library/aa375649(v=vs.85).aspx - - - - - Module that enables creating and embedding Side-by-Side interop - manifests for registration free deployment of Com-.net interop projects - - - - - Represents build errors - - - - - A Target can be run during the build - - - - - [omit] - - - - - [omit] - - - - - Activates the FinalTarget. - - - - - Registers a final target (not activated). - - - - - Activates the BuildFailureTarget. - - - - - Registers a BuildFailureTarget (not activated). - - - - - Runs a target and its dependencies. - - - - - Runs the given array of targets in parallel using count tasks - - - - - Runs a single target without its dependencies - - - - - Determines a parallel build order for the given set of targets - - - - - Prints all available targets. - - - - - [omit] - - - - Writes a build time report. - The total runtime. - - - - Writes a summary of errors reported during build. - - - - Writes a dependency graph. - Whether to print verbose output or not. - The target for which the dependencies should be printed. - - - - Prints all targets. - - - - - Runs all build failure targets. - [omit] - - - - - Runs all activated final targets (in alphabetically order). - [omit] - - - - - [omit] - - - - - Creates a Target. - - - - - Creates a TargetTemplate. - - - - - Creates a TargetTemplate with dependencies. - - ## Sample - - The following sample creates 4 targets using TargetTemplateWithDependencies and hooks them into the build pipeline. - - // Create target creation functions - let createCompileTarget name strategy = - TargetTemplateWithDependencies - ["Clean"; "ResolveDependencies"] // dependencies to other targets - (fun targetParameter -> - tracefn "--- start compile product..." - if targetParameter = "a" then - tracefn " ---- Strategy A" - else - tracefn " ---- Strategy B" - tracefn "--- finish compile product ..." - ) name strategy - - let createTestTarget name dependencies filePattern = - TargetTemplateWithDependencies - dependencies - (fun filePattern -> - tracefn "--- start compile tests ..." - !! filePattern - |> RunTests - tracefn "--- finish compile tests ...") - name filePattern - - // create some targets - createCompileTarget "C1" "a" - createCompileTarget "C2" "b" - - createTestTarget "T1" ["C1"] "**/C1/*.*" - createTestTarget "T2" ["C1"; "C2"] "**/C?/*.*" - - // hook targets to normal build pipeline - "T1" ==> "T2" ==> "Test" - - - - - - Creates a target from template. - [omit] - - - - - Set a dependency for all registered targets. - [omit] - - - - - Set a dependency for all given targets. - [omit] - - - - - Backwards dependencies operator - x is dependent on ys. - - - - - Adds the dependencies to the list of soft dependencies. - [omit] - - - - - Adds the dependencies to the list of dependencies. - [omit] - - - - - Adds the dependency to the list of soft dependencies. - [omit] - - - - - Adds the dependency to the list of dependencies. - [omit] - - - - - Appends the dependency to the list of soft dependencies. - [omit] - - - - - Appends the dependency to the list of dependencies. - [omit] - - - - - Adds the dependency to the front of the list of dependencies. - [omit] - - - - - Checks whether the soft dependency can be added. - [omit] - - - - - Checks whether the dependency can be added. - [omit] - - - - - Checks whether the dependency (soft or normal) can be added. - [omit] - - - - - Do nothing - fun () -> () - Can be used to define empty targets. - - - - - Returns the soft DependencyString for the given target. - - - - - Returns the DependencyString for the given target. - - - - - Gets a target with the given name from the target dictionary. - - - - - Returns a list with all target names. - - - - - Resets the state so that a deployment can be invoked multiple times - [omit] - - - - - The executed target time. - [omit] - - - - - The executed targets. - - - - - BuildFailureTargets - stores build failure targets and if they are activated. - - - - - Final Targets - stores final targets and if they are activated. - - - - - TargetDictionary - [omit] - - - - - Sets the Description for the next target. - [omit] - - - - - [omit] - - - - - [omit] - - - - - Contains infrastructure code and helper functions for FAKE's target feature. - - - - - Retries the given function until a retry limit is reached or the function succeeds without exception. - ## Parameters - - - `f` - This function will be started. - - `retries` - A retry limit. - - - - - Waits until the given function returns true or the timeout is reached. - ## Parameters - - - `f` - This function will be started. - - `timeout` - A System.TimeSpan representing the timeout. - - `testMS` - An interval at which FAKE checks if the function has succeeded. - - `timeoutF` - This function will be run if the timeout has been reached. - - - - - Contains a helper which can be used to implement timeouts and retries. - - - - - The Build number assigned to the build by TeamCity using the build number format or None if it's not on TeamCity. - - - - - Is set to true if the build is a personal one. - - - - - The Name of the Build Configuration the current build belongs to or None if it's not on TeamCity. - - - - - The Name of the project the current build belongs to or None if it's not on TeamCity. - - - - - The Version of the TeamCity server. This property can be used to determine the build is run within TeamCity. - - - - - Gets the changed files - - - - - Gets the recently failed tests - - - - - Reports a failed comparison. - - - - - Reports a failed test. - - - - - Reports a parameter value - - - - - Reports a build statistic. - - - - - Sets the TeamCity build number. - - - - - Publishes an artifact on the TeamcCity build server. - - - - - Reports the build status. - - - - - Create the build status. - [omit] - - - - - Reports the progress end. - - - - - Reports the progress start. - - - - - Reports the progress. - - - - - Starts the test suite. - - - - - Finishes the test suite. - - - - - Ignores the test case. - - - - - Ignores the test case. - - - - - Finishes the test case. - - - - - Starts the test case. - - - - - Sends an dotcover, partcover, ncover or ncover3 results filename to TeamCity - - - - - Sends an ReSharper dupfinder.exe results filename to TeamCity - - - - - Sends an PMD Copy/Paste Detector results filename to TeamCity - - - - - Sends an PMD inspections results filename to TeamCity - - - - - Sends an FxCop inspection results filename to TeamCity - - - - - Sends an ReSharper inspectCode.exe results filename to TeamCity - - - - - Sends an JSLint results filename to TeamCity - - - - - Sends an FindBugs results filename to TeamCity - - - - - Sends an Checkstyle results filename to TeamCity - - - - - Sends an Google Test results filename to TeamCity - - - - - Sends an MSTest results filename to TeamCity - - - - - Sends an Maven Surefire results filename to TeamCity - - - - - Sends an JUnit Ant task results filename to TeamCity - - - - - Sends an FXCop results filename to TeamCity - - - - - Sends an NUnit results filename to TeamCity - - - - - Sends an error to TeamCity - - - - - Close Named Block - - - - - Open Named Block - - - - - Send message to TeamCity - - - - - Send message to TeamCity - - - - - Encapsulates special chars - - - - - Contains helper functions which allow FAKE to communicate with a TeamCity agent - - - - - Record type which stores TeamCity project properties - - - - - Record type which stores Build configuration properties - - - - - Record type which stores Build properties - - - - - Record type which stores VCSRoot properties - - - - - Gets all projects on the TeamCity server. - - - - - Gets informnation about a project from the TeamCity server. - - - - - Gets information about a build configuration from the TeamCity server. - - - - - [omit] - - - - - Returns the REST version of the TeamCity server - - - - - [omit] - - - - - Contains functions which allow FAKE to interact with the [TeamCity REST API](http://confluence.jetbrains.com/display/TCD8/REST+API). - - - - - Replaces the templates with the given replacements - - - - - Saves all files (lazy - file by file!) - - - - - Replaces a bunch of the keywords in all files (lazy - line by line!) - - - - - Loads all templates (lazy - line by line!) - - - - - Contains basic templating functions. Used in other helpers. - - - - - Replace binary for an existing build if one is found with the same name/bundle version - - - - - Notify permitted teammates to install the build - - - - - Distribution list names which will receive access to the build - - - - - iOS ONLY - the .dSYM corresponding to the build - - - - - Release notes for the build - - - - - (Required) file data for the build (.ipa or .apk) - - - - - (Required) Team token from testflightapp.com/dashboard/team/edit - - - - - (Required) API token from testflightapp.com/account/#api - - - - - The TestFlight parameter type. - - - - - Uploads the app build to TestFlight. - ## Parameters - - `setParams` - Function used to manipulate the default TestFlightParams value. - - - - - [omit] - - - - - [omit] - - - - - The default TestFlight upload parameters. - - - - - Contains tasks to upload apps to [TestFlight](http://testflightapp.com) - - - - - Forces TeamCity mode (normally auto-detected) - - - - - List of traits to exclude. - - - - - List of traits to include. - - - - - Test runner error level. - - - - - Maximum time to allow xUnit to run before being killed. - - - - - Run xUnit without reporting test progress. - - - - - Run xUnit with shadow copy enabled. - - - - - The working directory for running the xunit console rnner. - - - - - The output path of the xUnit XML report. - - - - - The output path of the xUnit XML report (in the NUnit style). - - - - - The output path of the xUnit HTML report. - - - - - The path to the xUnit console runner: `xunit.console.clr4.exe` - - - - - The xUnit parameter type. - - - - - Runs xUnit unit tests in the given assemblies via the given xUnit runner. - Will fail if the runner terminates with non-zero exit code for any of the assemblies. - - The xUnit runner terminates with a non-zero exit code if any of the tests - in the given assembly fail. - - This task runs xUnit once per assembly specified, prepending the assembly file name to - the output report filenames to ensure that there is a unique report file for each - assembly tested. - - ## Parameters - - - `setParams` - Function used to manipulate the default XUnitParams value. - - `assemblies` - Sequence of one or more assemblies containing xUnit unit tests. - - ## Sample usage - The sample below will generate HTML reports in `testDir` with names following the - pattern `xUnit.Test.Example.dll.html`. - - Target "Test" (fun _ -> - !! (testDir @@ "xUnit.Test.*.dll") - |> xUnit (fun p -> {p with HtmlOutputPath = testDir @@ "html"}) - ) - - - - - Runs xUnit unit tests in the given assemblies via the given xUnit runner. - Will fail if the runner terminates with non-zero exit code for any of the assemblies. - - The xUnit runner terminates with a non-zero exit code if any of the tests - in the given assembly fail. - - ## Parameters - - - `setParams` - Function used to manipulate the default `XUnitParams` value. - - `assemblies` - Sequence of one or more assemblies containing xUnit unit tests. - - ## Sample usage - - Target "Test" (fun _ -> - xUnit (fun p -> {p with HtmlOutputPath = testDir @@ "xunit.html"}) "xUnit.Test.dll" - ) - - - - - The xUnit default parameters. - - ## Defaults - - - `HtmlOutputPath` - `None` - - `XmlOutputPath` - `None` - - `NUnitXmlOutputPath` - `None` - - `IncludeTraits` - `[]` - - `ExcludeTraits` - `[]` - - `ShadowCopy` - `true` - - `ErrorLevel` - `Error` - - `ToolPath` - The `xunit.console.clr4.exe` path if it exists in a subdirectory of the current directory. - - `WorkingDir` - `None` - - `TimeOut` - 5 minutes - - `ForceTeamCity` - `false` - - `Silent` - `false` - - - - - Contains tasks to run [xUnit](https://github.com/xunit/xunit) v1 unit tests. - - - - - Waits for input after completion. - - - - - Forces AppVeyor CI mode (normally auto-detected). - - - - - Forces TeamCity mode (normally auto-detected). - - - - - List of traits to exclude. - - - - - List of traits to include. - - - - - Test runner error level. - - - - - Maximum time to allow xUnit to run before being killed. - - - - - Run xUnit without reporting test progress. - - - - - Run xUnit with shadow copy enabled. - - - - - The working directory for running the xunit console runner. - - - - - The output path of the NUnit XML report. - - - - - The output path of the xUnit XML report (in the xUnit v1 style). - - - - - The output path of the xUnit XML report. - - - - - The output path of the xUnit HTML report. - - - - - The xUnit thread limiting strategy. - - - - - The xUnit parallelization mode. - - - - - Do not use app domains to run test code. - - - - - The path to the xUnit console runner: `xunit.console.exe` - - - - - The xUnit2 parameter type. - - - - - Limits the number of concurrently executing collections to `count`. - - - - - Does not limit the number of concurrently executing collections. - - - - - Uses the default concurrency mode for collections. - - - - - The collection concurrency mode used by the xUnit2 runner. - - - - - Parallelize assemblies and collections. - - - - - Only parallelize assemblies. - - - - - Only parallelize collections. - - - - - Turn off all parallelization. - - - - - The parallelization mode of the xUnit2 runner. - - - - - Runs xUnit v2 unit tests in the given assemblies via the given xUnit2 runner. - Will fail if the runner terminates with non-zero exit code. - - The xUnit2 runner terminates with a non-zero exit code if any of the tests - in the given assembly fail. - - ## Parameters - - - `setParams` - Function used to manipulate the default `XUnit2Params` value. - - `assemblies` - Sequence of one or more assemblies containing xUnit unit tests. - - ## Sample usage - - Target "Test" (fun _ -> - !! (testDir @@ "xUnit.Test.*.dll") - |> xUnit2 (fun p -> { p with HtmlOutputPath = Some (testDir @@ "xunit.html") }) - ) - - - - - Helper method to detect if the xunit console runner supports the -noappdomain flag. - If the xunit console runner does not support this flag, it will change the value to false - so it does not interfere with older versions. - - - - - The xUnit2 default parameters. - - ## Defaults - - - `NoAppDomain` - `false` - - `Parallel` - `NoParallelization` - - `MaxThreads` - `Default` - - `HtmlOutputPath` - `None` - - `XmlOutputPath` - `None` - - `XmlV1OutputPath` - `None` - - `IncludeTraits` - `[]` - - `ExcludeTraits` - `[]` - - `ShadowCopy` - `true` - - `ErrorLevel` - `Error` - - `ToolPath` - The `xunit.console.exe` path if it exists in a subdirectory of the current directory. - - `WorkingDir` - `None` - - `TimeOut` - 5 minutes - - `ForceTeamCity` - `false` - - `ForceAppVeyor` - `false` - - `Silent` - `false` - - `Wait` - `false` - - - - - Contains tasks to run [xUnit](https://github.com/xunit/xunit) v2 unit tests. - - - - - Logs the given files with the message. - - - - - Traces the message to the console - - - - - Traces the end of a task - - - - - Traces the begin of a task - - - - - Traces the end of a target - - - - - Traces the begin of a target - - - - - Removes an opening tag from the internal tag stack - - - - - Puts an opening tag on the internal tag stack - - - - - Traces the end of the build - - - - - Traces the begin of the build - - - - - Traces a header - - - - - Traces a line - - - - - Gets the FAKE Version string - - - - - Traces the EnvironmentVariables - - - - - Traces an exception details (in red) - - - - - Traces an error (in red) - - - - - Writes a trace to the command line (in yellow) - - - - - Writes a trace to stderr (in yellow) - - - - - Writes a trace to the command line (in green) if the verbose mode is activated. - - - - - Writes a message to the command line (in green) and without a line break - - - - - Writes a message to the command line (in green) - - - - - Writes a trace to the command line (in green) - - - - - Logs the specified string if the verbose mode is activated. - - - - - Logs the specified message (without line break) - - - - - Logs the specified message - - - - - Logs the specified string - - - - - Gets the FAKE version no. - - - - - Gets the path of the current FAKE instance - - - - - This module contains function which allow to trace build output - - - - - Writes the given message to the xml file. - - - - - Implements a TraceListener which writes NAnt like XML files. - ## Parameters - - `xmlOutputFile` - Defines the xml output file. - - - - - Writes the given message to the Console. - - - - - Implements a TraceListener for System.Console. - ## Parameters - - `importantMessagesToStdErr` - Defines whether to trace important messages to StdErr. - - `colorMap` - A function which maps TracePriorities to ConsoleColors. - - - - - Defines a TraceListener interface - - - - - Defines Tracing information for TraceListeners - - - - - Allows to post messages to all trace listeners - - - - - Allows to register a new Xml listeners - - - - - A List with all registered listeners - - - - - Specifies if the XmlWriter should close tags automatically - - - - - The default TraceListener for Console. - - - - - A default color map which maps TracePriorities to ConsoleColors - - - - - Defines default listeners for build output traces - - - - - Specifies the timeout for the TypeScript compiler. - - - - - Specifies the TypeScript compiler output path. - - - - - Specifies the TypeScript compiler path. - - - - - Specifies if the TypeScript compiler should remove comments. Default is false. - - - - - Specifies if the TypeScript compiler should not use libs. Default is false. - - - - - Specifies if the TypeScript compiler should emit source maps. Default is false. - - - - - Specifies which JavaScript module type the TypeScript compiler should generate. Default is CommonJs. - - - - - Specifies if the TypeScript compiler should generate declarations. Default is false. - - - - - Specifies if the TypeScript compiler should generate a single output file and its filename. - - - - - Specifies if the TypeScript compiler should generate comments. Default is false. - - - - - Specifies which ECMAScript version the TypeScript compiler should generate. Default is ES3. - - - - - TypeScript task parameter type - - - - - Generated JavaScript module type - - - - - Generated ECMAScript version - - - - - This task to can be used to call the [TypeScript](http://www.typescriptlang.org/) compiler. - There is also a [tutorial](../typescript.html) for this task available. - ## Parameters - - - `setParams` - Function used to overwrite the TypeScript compiler flags. - - `files` - The type script files to compile. - - ## Sample - - !! "src/**/*.ts" - |> TypeScriptCompiler (fun p -> { p with TimeOut = TimeSpan.MaxValue }) - - - - - Default parameters for the TypeScript task - - - - - Contains code to call the typescript compiler. There is also a [tutorial](../typescript.html) for this task available. - - - - - With this option set, no exception is thrown if a test is broken. - - - - - This option instructs FAKE to break the build if a test runner finds the first error. - - - - - This option instructs FAKE to break the build if a test runner reports an error. - - - - - Option which allows to specify if a test runner error should break the build. - - - - - This module contains types and functions that are common for unit test helpers. - - - - - Basic data type to represent test results - - - - - Basic data type to represent tests - - - - - Basic data type to represent test status - - - - - Reports the given test results to the detected build server - - - - - Reports the given test results to [AppVeyor](http://www.appveyor.com/). - - - - - Reports the given test results to [TeamCity](http://www.jetbrains.com/teamcity/). - - - - - This module contains functions which allow to report unit test results to build servers. - - - - - Return a string entered by the user followed by enter. The input is replaced by '*' on the screen. - - - - - Return a string entered by the user followed by enter. The input is echoed to the screen. - - - - - This module contains functions which allow to interactively input values - - - - - Retrieves the given project from Microsoft Visual SourceSafe - - - - - Retrieves the given label of the given project from Microsoft Visual SourceSafe - - - - - Contains helper functions for [Microsoft Visual SourceSafe](http://en.wikipedia.org/wiki/Microsoft_Visual_SourceSafe) - - - - - Path to test adapter e.g. xUnit (optional) - - - - - Error level for controlling how VSTest failures should break the build (optional). - - - - - A timeout for the test runner (optional). - - - - - Working directory (optional). - - - - - Path to VSTest.Console.exe (optional). By default the default install location is searched. - - - - - List installed settings providers (optional). - - - - - List installed loggers (optional). - - - - - List installed test executors (optional). - - - - - List installed test discoverers (optional). - - - - - List discovered tests from the given container path (optional). - - - - - The logger to use for test results (optional). - - - - - Run tests that match the given expression (optional). Cannot be used with the Tests argument - - - - - Target .NET framework version to use for test execution (optional). - - - - - Target platform architecture for test execution (optional). Valid options include "x86", "x64" and "ARM". - - - - - Use installed VSIX extensions in VSTest (optional). - - - - - Run the tests in an isolated process (optional). - - - - - Enables code coverage collection (optional). - - - - - Names of the tests that should be run (optional). - - - - - Path to the run settings file to run tests with additional settings such as data collectors (optional). - - - - - Parameter type to configure [VSTest.Console.exe](https://msdn.microsoft.com/en-us/library/jj155800.aspx) - - - - - Option which allow to specify if a VSTest error should break the build. - - - - - Runs VSTest command line tool (VSTest.Console.exe) on a group of assemblies. - ## Parameters - - - `setParams` - Function used to manipulate the default VSTestParams values. - - `assemblies` - Sequence of one or more assemblies containing Microsoft Visual Studio Unit Test Framework unit tests. - - ## Sample usage - - Target "Test" (fun _ -> - !! (testDir + @"\*.Tests.dll") - |> VSTest (fun p -> { p with SettingsPath = "Local.RunSettings" }) - ) - - - - - Builds the command line arguments from the given parameter record and the given assemblies. - [omit] - - - - - VSTest default parameters. - - - - - [omit] - - - - - [omit] - - - - - Contains tasks to run [VSTest](https://msdn.microsoft.com/en-us/library/ms182486.aspx) unit tests. - - - - - All references and components used - in this VBV6 project - - - - - Version of the project - in Major.Minor.Revision.Patch format - - - - - Name of binary that will - be generated from this project - - - - - Path to the Propject file representing - Representing this project - - - - - Represents a VB6 project - - - - - Represents a VB6 Reference - - - - - Represents the version of a VB6 reference - References from VB6 projects only care about Major.Minor versions - - - - - Represents the version of a VB6 project - `ToString ()` will return a Maj.Min.Rev.Patch version string - - - - - Maximum amount of time the entire build is allowed to take - - - - - Directory to put logs and other temporary files - created during the build process - - - - - Directory to put generated binaries - - - - - Path to the VB6 executable - - - - - Parameters for running a VB6 build - - - - - Fixes dependency versions in VB6 project files - - ## Paramteters - - `getConfig`- function to alter default VB6 build parameters - - `vb6Projects` - Paths to all `.vbp` to update references in - - `possibleAssemblies` - Paths to assemblies that may be referenced by the VB6 projects - - Running this task will: - - 1. In all VB6 projects provided: Get all references that intersects with the provided assemblies arg - 2. Check if there is a version difference - 3. Update the VB6 project file to reflect the actual version used. - - Note: Vb6 Reference versions are __hex numbers__ not decimals like .net verions. This task handles - this difference automatically. - - - - - All-In-one build and manifest function for VB6 __applications__ referencing .net __libraries__ - - ## Paramteters - - `getConfig`- function to alter default VB6 build parameters - - `vb6Projects` - Paths to all `.vbp` files to build - - `possibleAssemblies` - Paths to assemblies that may be referenced by the VB6 projects - - ## Process - - This function will: - - 1. Determine which of the `possibleAssemnblies` are referenced by any of the provided `.vbp` files - 2. Temporarily register any referenced assemblies using `RegAsm /codebase /tlb` - 3. Run VB6 command line make on all provided `.vbp` projects - 4. Unregister all registered assemblies - 5. Generate and embed Side-By-Side interop appplication manifests in all generated VB6 executables - 6. Generate and embed Side-By-Side interop assembly manifest in all referenced assemblies - - - - - Determins which of the provided assemblies are referenced by the - provided VB6 projects, and __un-registers__ them - - ## Paramteters - - `getConfig`- function to alter default VB6 build parameters - - `vb6Projects` - Paths to all `.vbp` files to build - - `possibleAssemblies` - Paths to assemblies that may be referenced by the VB6 projects - - - - - Determines which of the provided assemblies are referenced by the - provided VB6 projects, and registers them so the VB6 ide can - find them. - - ## Paramteters - - `getConfig`- function to alter default VB6 build parameters - - `vb6Projects` - Paths to all `.vbp` files to build - - `possibleAssemblies` - Paths to assemblies that may be referenced by the VB6 projects - - - - - Returns application details for provided `.vbp` files. - - ## Information returned - - Name of created binary file - - Version as saved in `.vbp`file - - GUIDs of all referenced libraries and components - - ## Usage - - This is used for creating Side-By-Side interop manifests. - - - - - Executes a VB6 command line make on all provided VB6 projects - - Builds will be executed in paralell - - ## Parameters - - `getConfig` - function to modify the build params record from default values - - `vb6Projects`- `Seq` of paths to `.vbp` files to build - - - - - Helper methods for working with Vb6 project files - - - - - Enables building of Visual Basic 6 projects - Also includes a do-it-all function that will embed interop - side-by-side manifest to executables from Vb6 using - functions from the Side-by-side helper module - - - - - PATCH version when you make backwards-compatible bug fixes. - - - - - MINOR version when you add functionality in a backwards-compatible manner. - - - - - MAJOR version when you make incompatible API changes. - - - - - Contains the version information. - - - - - Gets file assembly version in form of major.minor.build.revision. - ## Parameters - - `assemblyFile` - The assembly file path. - - - - - Gets file assembly version. - ## Parameters - - `assemblyFile` - The assembly file path. - - - - - You can nest InstallExecuteSequence actions in here - - - - - You can nest custom actions in here - - - - - You can nest feature elements in here - - - - - Build Number of product - - - - - Nest Components in here - - - - - Nest directories in here - - - - - Nest WiXVariables in here - - - - - Nest UIRefs in here - - - - - Nest major upgrade elements in here - - - - - You can nest upgrade elements in here - - - - - The upgrade code GUID for the product. - - - - - The manufacturer of the product. - - - - - The product's version string. - - - - - The decimal language ID (LCID) for the product. - - - - - Product description - - - - - The program files folder - - - - - The descriptive name of the product. - - - - - The product code GUID for the product. - - - - - Parameters for WiX Script properties, use ToString for creating the string xml nodes - - - - - The value of the variable. The value cannot be an empty string because that would make it possible to accidentally set a column to null. - - - - - Set this value to 'yes' in order to make the variable's value overridable either by another WixVariable entry or via the command-line option -d<name>=<value> for light.exe. - If the same variable is declared overridable in multiple places it will cause an error (since WiX won't know which value is correct). The default value is 'no'. - - - - - The name of the variable. - - - - - Parameters for WiX Variable, use ToString for creating the string xml nodes - - - - - The message displayed if users try to install a product with a lower version number when a product with a higher version is installed. Used only when AllowDowngrades is no (the default). - - - - - When set to no (the default), products with lower version numbers are blocked from installing when a product with a higher version is installed; the DowngradeErrorMessage - attribute must also be specified. When set to yes, any version can be installed over any other version. - - - - - Determines the scheduling of the RemoveExistingProducts standard action, which is when the installed product is removed. The default is "afterInstallValidate" which removes the - installed product entirely before installing the upgrade product. It's slowest but gives the most flexibility in changing components and features in the upgrade product. - - - - - Parameters for WiX Major Upgrade - - - - - Schedules RemoveExistingProducts after the InstallFinalize standard action. This is similar to the afterInstallExecute and afterInstallExecuteAgain schedulings but takes place outside - the installation transaction so if installation of the upgrade product fails, Windows Installer does not roll back the removal of the installed product, - so the machine will have both versions installed. - - - - - Schedules RemoveExistingProducts between the InstallExecuteAgain and InstallFinalize standard actions. - This is identical to the afterInstallExecute scheduling but after the InstallExecuteAgain standard action instead of InstallExecute. - - - - - Schedules RemoveExistingProducts between the InstallExecute and InstallFinalize standard actions. This scheduling installs the upgrade product "on top of" the installed product then lets - RemoveExistingProducts uninstall any components that don't also exist in the upgrade product. Note that this scheduling requires strict adherence to the component rules because it relies - on component reference counts to be accurate during installation of the upgrade product and removal of the installed product. For more information, see Bob Arnson's blog post - "Paying for Upgrades" for details. If installation of the upgrade product fails, Windows Installer also rolls back the removal of the installed product -- in other words, reinstalls it. - - - - - Schedules RemoveExistingProducts after the InstallInitialize standard action. This is similar to the afterInstallValidate scheduling, but if the installation of the upgrade product fails, - Windows Installer also rolls back the removal of the installed product -- in other words, reinstalls it. - - - - - (Default) Schedules RemoveExistingProducts after the InstallValidate standard action. This scheduling removes the installed product entirely before installing the upgrade product. - It's slowest but gives the most flexibility in changing components and features in the upgrade product. Note that if the installation of the upgrade product fails, - the machine will have neither version installed. - - - - - Used for determing when to run RemoveExistingProducts on major upgrade - - - - - Set to "yes" to make the range of versions detected include the value specified in Maximum. - - - - - Set to "no" to make the range of versions detected exclude the value specified in Minimum. This attribute is "yes" by default. - - - - - When the FindRelatedProducts action detects a related product installed on the system, it appends the product code to the property specified in this field. - Windows Installer documentation for the Upgrade table states that the property specified in this field must be a public property and must be added to the - SecureCustomProperties property. WiX automatically appends the property specified in this field to the SecureCustomProperties property when creating an MSI. - Each UpgradeVersion must have a unique Property value. After the FindRelatedProducts action is run, the value of this property is a list of product codes, - separated by semicolons (;), detected on the system. - - - - - Specifies the upper boundary of the range of product versions detected by FindRelatedProducts. - - - - - Specifies the lower bound on the range of product versions to be detected by FindRelatedProducts. - - - - - Set to "yes" to detect products and applications but do not uninstall. - - - - - Parameters for WiX Upgrade Version - - - - - You can nest WiXUpgradeVersion sequences in here - - - - - This value specifies the upgrade code for the products that are to be detected by the FindRelatedProducts action. - - - - - Parameters for WiX Upgrade - - - - - Name of referenced UI - - - - - Parameters for WiX UI Reference, use ToString for creating the string xml nodes - - - - - Conditions that have to be fulfilled for running execution - - - - - Name of the standard or custom action that the verb points to - - - - - Specify if action should be executed before or after target action - - - - - The action to which the Custom element applies. - - - - - Parameters for WiX Custom Action executions (In InstallExecuteSequence), use ToString for creating the string xml nodes - - - - - Specifies that action should be executed before some standard or custom action - - - - - Specifies that action should be executed after some standard or custom action - - - - - Used for specifying the point of time for action execution in WiXCustomActionExecution - - - - - Set this attribute to set the return behavior of the custom action. - - - - - This attribute specifies the command line parameters to supply to an externally run executable. - This attribute is typically used with the BinaryKey attribute for a type 2 custom action, the FileKey attribute for a type 18 - custom action, the Property attribute for a type 50 custom action, or the Directory attribute for a type 34 custom action that - specify the executable to run. - - - - - This attribute specifies whether the Windows Installer, which executes as LocalSystem, should impersonate the user context of - the installing user when executing this custom action. Typically the value should be 'yes', except when the custom action needs - elevated privileges to apply changes to the machine. - - - - - This attribute indicates the scheduling of the custom action. - - - - - This attribute specifies a reference to a File element with matching Id attribute that will execute the custom action code - in the file after the file is installed. This attribute is typically used with the ExeCommand attribute to specify - a type 18 custom action that runs an installed executable, with the DllEntry attribute to specify an installed custom action - DLL to use for a type 17 custom action, or with the VBScriptCall or JScriptCall attributes to specify a type 21 or 22 custom action. - - - - - The identifier of the custom action. - - - - - Parameters for WiX custom action, use ToString for creating the string xml nodes - - - - - Indicates that the custom action will run synchronously and the return code will not be checked. - - - - - Indicates that the custom action will run synchronously and the return code will be checked for success. This is the default. - - - - - Indicates that the custom action will run asynchronously but the installer will wait for the return code at sequence end. - - - - - Indicates that the custom action will run asyncronously and execution may continue after the installer terminates. - - - - - Used in WiXCustomAction for determing the return type - - - - - Indicates that a custom action should be run a second time if it was previously run in an earlier sequence. - - - - - Indicates that a custom action will run in the rollback sequence when a failure occurs during installation, usually to undo changes made by a deferred custom action. - - - - - Indicates that the custom action will only run in the first sequence that runs it in the same process. - - - - - Indicates that the custom action will run during normal processing time with user privileges. This is the default. - - - - - Indicates that the custom action will only run in the first sequence that runs it. - - - - - Indicates that the custom action runs in-script (possibly with elevated privileges). - - - - - Indicates that the custom action will run after successful completion of the installation script (at the end of the installation). - - - - - Used in WiXCustomAction for determing when to run the custom action - - - - - You can nest InstallExecuteSequence actions in here - - - - - You can nest custom actions in here - - - - - You can nest feature elements in here - - - - - Build Number of product - - - - - Nest directories in here - - - - - Nest WiXVariables in here - - - - - Nest UIRefs in here - - - - - Nest major upgrade elements in here - - - - - You can nest upgrade elements in here - - - - - The upgrade code GUID for the product. - - - - - The manufacturer of the product. - - - - - The product's version string. - - - - - The decimal language ID (LCID) for the product. - - - - - Product description - - - - - The program files folder - - - - - The descriptive name of the product. - - - - - The product code GUID for the product. - - - - - Parameters for WiX Script properties, use ToString for creating the string xml nodes - - - - - Type for defining, which program directory should be used for installation. ProgramFiles32 refers to 'Program Files (x86)', ProgramFiles64 refers to 'Program Files' - - - - - Components included in this feature - - - - - Nest sub features - - - - -Determines the initial display of this feature in the feature tree. This attribute's value should be one of the following: -collapse - Initially shows the feature collapsed. This is the default value. -expand - Initially shows the feature expanded. -hidden - Prevents the feature from displaying in the user interface. -<an explicit integer value> - For advanced users only, it is possible to directly set the integer value of the display value that will appear in the Feature row. - - - - - Longer string of text describing the feature. This localizable string is displayed by the Text Control of the Selection Dialog. - - - - - Sets the install level of this feature. A value of 0 will disable the feature. - Processing the Condition Table can modify the level value (this is set via the Condition child element). - The default value is "1". - - - - - Short string of text identifying the feature. - This string is listed as an item by the SelectionTree control of the Selection Dialog. - - - - - Unique identifier of the feature. - - - - - Parameters for creating WiX Feature, use ToString for creating the string xml nodes - - - - - Nest sub features or components in here - - - - -Determines the initial display of this feature in the feature tree. This attribute's value should be one of the following: -collapse - Initially shows the feature collapsed. This is the default value. -expand - Initially shows the feature expanded. -hidden - Prevents the feature from displaying in the user interface. -<an explicit integer value> - For advanced users only, it is possible to directly set the integer value of the display value that will appear in the Feature row. - - - - - Longer string of text describing the feature. This localizable string is displayed by the Text Control of the Selection Dialog. - - - - - Sets the install level of this feature. A value of 0 will disable the feature. - Processing the Condition Table can modify the level value (this is set via the Condition child element). - The default value is "1". - - - - - Short string of text identifying the feature. - This string is listed as an item by the SelectionTree control of the Selection Dialog. - - - - - Unique identifier of the feature. - - - - - Parameters for creating WiX Feature, use ToString for creating the string xml nodes - - - - - Prevents the feature from displaying in the user interface. - - - - - Initially shows the feature expanded. - - - - - Initially shows the feature collapsed. This is the default value. - - - - - Used for determing whether the feature should be visible in the select features installer pane or not - - - - - WiX parameter type - - - - - WiX Directories define a logical directory which can include components and files - - - - - Component which wraps files into logical components and which allows to - - - - - Reference to a component for including it in a feature - - - - - Service Control Element. Can Start, Stop and Remove services - - - - - These are used in many methods for generating WiX nodes, regard them as booleans - - - - - Specifies whether an action occur on install, uninstall or both. - - - - - WiX File Element - - - - - Uses the WiX tools [Candle](http://wixtoolset.org/documentation/manual/v3/overview/candle.html) and [Light](http://wixtoolset.org/documentation/manual/v3/overview/light.html) to create an msi. - ## Parameters - - `setParams` - Function used to manipulate the WiX default parameters. - - `outputFile` - The msi output file path (given to Light). - - `wixScript` - The path to a WiX script that will be used with Candle. - - ## Sample - Target "BuildSetup" (fun _ -> - // Copy all important files to the deploy directory - !! (buildDir + "/**/*.dll") - ++ (buildDir + "/**/*.exe") - ++ (buildDir + "/**/*.config") - |> Copy deployPrepDir - - // replace tags in a template file in order to generate a WiX script - let ALLFILES = fun _ -> true - - let replacements = [ - "@build.number@",if not isLocalBuild then buildVersion else "0.1.0.0" - "@product.productcode@",System.Guid.NewGuid().ToString() - "@HelpFiles@",getFilesAsWiXString helpFiles - "@ScriptFiles@",getFilesAsWiXString scriptFiles - "@icons@",wixDir ALLFILES true (directoryInfo(bundledDir @@ "icons"))] - - processTemplates replacements setupFiles - - // run the WiX tools - WiX (fun p -> {p with ToolDirectory = WiXPath}) - setupFileName - (setupBuildDir + "Setup.wxs.template") - ) - - - - - Runs the [Light tool](http://wixtoolset.org/documentation/manual/v3/overview/light.html) on the given WiX script with the given parameters - - - - - Runs the [Candle tool](http://wixtoolset.org/documentation/manual/v3/overview/candle.html) on the given WiX script with the given parameters - - - - - Generates a major upgrade based on the given parameters, use toString on it when embedding it - ## Parameters - - `setParams` - Function used to manipulate the WiX default parameters. - - ## Sample - let majorUpgradeVersion = generateMajorUpgradeVersion(fun f -> - {f with - DowngradeErrorMessage = "A later version is already installed, exiting." - }) - - - - - Generates an upgrade version based on the given parameters, use toString on it when embedding it - ## Parameters - - `setParams` - Function used to manipulate the WiX default parameters. - - ## Sample - let upgradeVersion = generateUpgradeVersion (fun f -> - {f with - Minimum = productVersion - OnlyDetect = "yes" - }) - - - - - Generates an upgrade based on the given parameters, use toString on it when embedding it - ## Parameters - - `setParams` - Function used to manipulate the WiX default parameters. - - ## Sample - let upgrade = generateUpgrade (fun f -> - {f with - Id = productUpgradeCode - }) - - - - - Generates a ui ref based on the given parameters, use toString on it when embedding it - ## Parameters - - `setParams` - Function used to manipulate the WiX default parameters. - - ## Sample - let UIRef = generateUIRef (fun f -> - {f with - Id = "WixUI_Mondo" - }) - - - - - Generates a custom action execution based on the given parameters, use toString on it when embedding it - Condition in sample makes execute only on install - ## Parameters - - `setParams` - Function used to manipulate the WiX default parameters. - - ## Sample - let actionExecution = generateCustomActionExecution (fun f -> - {f with - ActionId = action.Id - Verb = "After" - Target = "InstallFiles" - Condition = "<![CDATA[(&" + feature.Id + " = 3) AND NOT (!" + feature.Id + " = 3)]]>" - }) - - - - - Generates a customAction based on the given parameters, use toString on it when embedding it - Be careful to make Id unique. FileKey is a reference to a file Id which you added by using wixDir or wixFile - Set impersonate to no if your action needs elevated privileges, you should then also set execute as "deferred" - ExeCommand are the parameters passed to your executable - ## Parameters - - `setParams` - Function used to manipulate the WiX default parameters. - - ## Sample - let action = generateCustomAction (fun f -> - {f with - Id = "UniqueActionId" - FileKey = "fi_5" - Execute = "deferred" - Impersonate = "no" - ExeCommand = "install" - Return = "check" - }) - - - - - Generates a feature based on the given parameters, use toString on it when embedding it - You can pass other features into InnerContent for making a hierarchy - ## Parameters - - `setParams` - Function used to manipulate the WiX default parameters. - - ## Sample - let feature = generateFeature (fun f -> - {f with - Id = "UniqueName" - Title = "Title which is shown" - Level = 1 - Description = "Somewhat longer description" - Display = "expand" - InnerContent = [otherFeature1; otherFeature2] - }) - - - - - Generates a feature based on the given parameters, use toString on it when embedding it - You can pass other features into InnerContent for making a hierarchy - ## Parameters - - `setParams` - Function used to manipulate the WiX default parameters. - - ## Sample - let feature = generateFeature (fun f -> - {f with - Id = "UniqueName" - Title = "Title which is shown" - Level = 1 - Description = "Somewhat longer description" - Display = "expand" - InnerContent = otherFeature.ToString() - }) - - - - - Takes path where script files reside and sets all parameters as defined - ## Parameters - - `wiXPath` - Pass path where your script is located at. Function will search for all Scripts in that location and fill in parameters - - `setParams` - Function used to manipulate the WiX default parameters. - - ## Sample - FillInWixScript "" (fun f -> - {f with - ProductCode = WiXProductCode - ProductName = WiXProductName - Description = projectDescription - ProductLanguage = WiXProductLanguage - ProductVersion = WiXProductVersion - ProductPublisher = WixProductPublisher - UpgradeGuid = WixProductUpgradeGuid - UIRefs = uiRef1.ToString() + uiRef2.ToString() - WiXVariables = wiXLicense.ToString() - Directories = directories - BuildNumber = "1.0.0" - Features = rootFeature.ToString() - CustomActions = action1.ToString() + action2.ToString() - ActionSequences = actionExecution1.ToString() + actionExecution2.ToString() - }) - - - - - Takes path where script files reside and sets all parameters as defined - ## Parameters - - `wiXPath` - Pass path where your script is located at. Function will search for all Scripts in that location and fill in parameters - - `setParams` - Function used to manipulate the WiX default parameters. - - ## Sample - FillInWixScript "" (fun f -> - {f with - ProductCode = WiXProductCode - ProductName = WiXProductName - Description = projectDescription - ProductLanguage = WiXProductLanguage - ProductVersion = WiXProductVersion - ProductPublisher = WixProductPublisher - UpgradeGuid = WixProductUpgradeGuid - UIRefs = uiRef1.ToString() + uiRef2.ToString() - WiXVariables = wiXLicense.ToString() - Directories = directories - BuildNumber = "1.0.0" - Features = rootFeature.ToString() - CustomActions = action1.ToString() + action2.ToString() - ActionSequences = actionExecution1.ToString() + actionExecution2.ToString() - }) - - - - - Generates WiX Template with specified file name (you can prepend location too) - You need to run this once every build an then use FillInWiXScript to replace placeholders - ## Parameters - - `fileName` - Pass desired fileName for your wiXScript file - - ## Sample - generateWiXScript "Setup.wxs" - - - - - Default values for WiX Script properties - - - - - Default value for WiX Variable - - - - - Default value for WiX Major Upgrade - - - - - Default value for WiX Upgrade - - - - - Default value for WiX Upgrade - - - - - Default value for WiX UI Reference (WixUI_Minimal) - - - - - Default values for WiX custom action executions - - - - - Default values for WiX custom actions - - - - - Default values for WiX Script properties - - - - - Default values for creating WiX Feature - - - - - Default values for creating WiX Feature - - - - - Contains the WiX default parameters - - - - - Take a component string and set "neverOverwrite" Tag - This is useful for config files, since they are not replaced on upgrade like that - - - - - Creates WiX ComponentRef tags from the given DirectoryInfo - - - - - Retrieves all component ids from given WiX directory string - ## Parameters - - `wiXString` - The directory string which was generated by wixDir - - ## Sample - let directoryString = wixDir (fun file -> true) true (DirectoryInfo directoryWithFilesForSetup) - let componentIds = getComponentIdsFromWiXString directoryString - - - - - Retrieves the file id of the first file in WiXString, which name matches fileRegex - ## Parameters - - `wiXString` - The directory string which was generated by wixDir - - `fileRegex` - Regex which matches the file name - - ## Sample - let directoryString = wixDir (fun file -> true) true (DirectoryInfo directoryWithFilesForSetup) - let executableFileId = getFileIdFromWiXString directoryString "\S*.exe" - - - - - Creates recursive WiX directory and file tags from the given DirectoryInfo - The function will create one component for each file [best practice](https://support.microsoft.com/de-de/kb/290997/en-us) - and set the GUID to "*", which will make WiX produce consistent Component Guids if the Component's target path doesn't change. - This is vital for major upgrades, since windows installer needs a consistent component guid for tracking each of them. - You can use the getComponentIdsFromWiXString function for getting all created component refs and adding them to features. - - - - - Use this to attach service controls to your components. - - - - - Creates WiX component with directories and files from the given DirectoryInfo - The function will create one component for each file [best practice](https://support.microsoft.com/de-de/kb/290997/en-us) - and set the GUID to "*", which will make WiX produce consistent Component Guids if the Component's target path doesn't change. - This is vital for major upgrades, since windows installer needs a consistent component guid for tracking each of them. - The components are embedded into the passed in root directory. - - - - - Creates WiX component with directories and files from the given DirectoryInfo - The function will create one component for each file [best practice](https://support.microsoft.com/de-de/kb/290997/en-us) - and set the GUID to "*", which will make WiX produce consistent Component Guids if the Component's target path doesn't change. - This is vital for major upgrades, since windows installer needs a consistent component guid for tracking each of them. - You can use the getComponentIdsFromWiXString function for getting all created component refs and adding them to features. - - - - - Use this for generating directories - - - - - Defaults for directories - - - - - Use this for generating single components - - - - - Defaults for component - - - - - Use this for generating component refs - - - - - Defaults for component ref - - - - - Use this for generating service controls - - - - - Defaults for service control element - - - - - Defaults for WiX file - - - - - Creates WiX File tags from the given files - - - - - Creates a WiX File tag from the given FileInfo - - - - - Contains tasks to create msi installers using the [WiX toolset](http://wixtoolset.org/) - - - - - Executes a XCopy command - ## Parameters - - `source` - The source directory - - `destination` - The target directory - - - - - Contains a task to use [XCOPY](http://en.wikipedia.org/wiki/XCOPY) on Windows. - - - - - Integrates XDT logging into FAKE logging. - - - - - Modifies XML files in place using an XDT file named by inserting a .configName in between each filename and .extension. - - - - - Modifies an XML file in place using an XDT file named by inserting a .configName in between the filename and .extension. - - - - - Reads XML file (typically a config file), makes changes according to XDT transform syntax, saves result. - - - - - Contains functions used to transform config (or any XML) files using Microsoft's XML Document Transformations. - - - - - Transforms a XML file using a XSL stylesheet file. - ## Parameters - - - `stylesheetUri` - The Uri for the XSL stylesheet file. - - `fileName` - The XML file to transform. - - - - - Transforms a XmlDocument using a XslCompiledTransform. - ## Parameters - - - `xsl` - The XslCompiledTransform which should be applied. - - `doc` - The XmlDocument to transform. - - - - - Loads the given text into a XslCompiledTransform. - - - - - Replaces inner text of an xml node in a XML file at the location specified by a XPath expression, with support for namespaces. - - - - - Replaces text in a XML file at the location specified by a XPath expression, with support for namespaces. - - - - - Replaces inner text in a XML document specified by a XPath expression, with support for namespaces. - - - - - Replaces text in a XML document specified by a XPath expression, with support for namespaces. - - - - - Replaces the inner text of an xml node in a XML file at the location specified by a XPath expression. - - - - - Replaces text in a XML file at the location specified by a XPath expression. - - - - - Selects a xml node value via XPath from the given document - - - - - Replaces the inner text of an xml node in the XML document specified by a XPath expression. - - - - - Replaces text in the XML document specified by a XPath expression. - - - - - Gets the DocumentElement of the XmlDocument - - - - - Loads the given text into a XmlDocument - - - - - Parses a XML subnode - - - - - Parses a XmlNode - - - - - Gets the first sub node with the given name from the given XmlNode - - - - - Gets a sequence of all child nodes for the given XmlNode - - - - - Gets the attribute with the given name from the given XmlNode - - - - - Writes an CData element to the given XmlTextWriter - - - - - Writes an XML attribute to current element of the given XmlTextWriter - - - - - Writes an XML end element to the given XmlTextWriter - - - - - Writes an XML start element to the given XmlTextWriter - - - - - Writes an XML comment to the given XmlTextWriter - - - - - Creates a XmlWriter which writes to the given file name - - - - - Reads a value from a XML document using a XPath - Returns if the value is an int and the value - - - - - Reads a value from a XML document using a XPath - - - - - Contains functions to read and write XML files. - - - - - output directory - - - - - output results to HTML file - - - - - output results to xUnit.net v1 style XML file - - - - - output results to xUnit.net v2 style XML file - - - - - Exclude named traits with comma separated values - - - - - Include named traits with comma separated values - - - - - Test runner error level. Option which allows to specify if an xUnit error should break the build. - - - - - If the timeout is reached the xUnit task will be killed. Default is 5 minutes. - - - - - The working directory (optional). - - - - - forces AppVeyor CI mode (normally auto-detected) - - - - - forces TeamCity mode (normally auto-detected) - - - - - Shadow copy - - - - - Output running test count - - - - - maximum thread count for collection parallelization - 0 - run with unbounded thread count - >0 - limit task thread pool size to 'count' - - - - - set parallelization based on option - none - turn off all parallelization - collections - only parallelize collections - assemblies - only parallelize assemblies - all - parallelize assemblies & collections - - - - - The file name of the config file (optional). - - - - - The path to the xunit.console.exe - FAKE will scan all subfolders to find it automatically. - - - - - DEPRECATED. - The xUnit parameter type - - - - - DEPRECATED. - Option which allows to specify if an xUnit error should break the build. - - - - - DEPRECATED. - - - - - DEPRECATED. See [`Fake.Testing.XUnit2.xUnit2`](fake-testing-xunit2.html). - - Runs xUnit unit tests in the given assemblies via the given xUnit runner. - Will fail if the runner terminates with non-zero exit code for any of the assemblies. - Offending assemblies will be listed in the error message. - - The xUnit runner terminates with a non-zero exit code if any of the tests - in the given assembly fail. - ## Parameters - - - `setParams` - Function used to manipulate the default XUnitParams value. - - `assemblies` - Sequence of one or more assemblies containing xUnit unit tests. - - ## Sample usage - - Target "Test" (fun _ -> - !! (testDir + @"\xUnit.Test.*.dll") - |> xUnit2 (fun p -> {p with OutputDir = testDir }) - ) - - - - - DEPRECATED. - Builds the command line arguments from the given parameter record and the given assemblies. - [omit] - - - - - DEPRECATED. - - - - - DEPRECATED. - The xUnit default parameters - - - - - DEPRECATED. See [`Fake.Testing.XUnit2`](fake-testing-xunit2.html). - - Contains tasks to run [xUnit](https://github.com/xunit/xunit) unit tests. - - - - - Exclude named traits with comma separated values - - - - - Include named traits with comma separated values - - - - - Test runner error level. Option which allows to specify if an xUnit error should break the build. - - - - - The output directory. It's the current directoy if nothing else is specified. - - - - - If the timeout is reached the xUnit task will be killed. Default is 5 minutes. - - - - - If set to true xUnit will generate verbose output. - - - - - If set to true xUnit will run in ShadowCopy mode. - - - - - The working directory (optional). - - - - - If set to true XML output will be generated. - - - - - If set to true a HTML output file will be generated in NUnit format. - - - - - If set to true a HTML output file will be generated. - - - - - The file name of the config file (optional). - - - - - The path to the xunit.console.clr4.exe - FAKE will scan all subfolders to find it automatically. - - - - - DEPRECATED. - The xUnit parameter type - - - - - DEPRECATED. - Option which allows to specify if an xUnit error should break the build. - - - - - DEPRECATED. See [`Fake.Testing.XUnit.xUnit`](fake-testing-xunit.html). - - Runs xUnit unit tests in the given assemblies via the given xUnit runner. - Will fail if the runner terminates with non-zero exit code for any of the assemblies. - Offending assemblies will be listed in the error message. - - The xUnit runner terminates with a non-zero exit code if any of the tests - in the given assembly fail. - ## Parameters - - - `setParams` - Function used to manipulate the default XUnitParams value. - - `assemblies` - Sequence of one or more assemblies containing xUnit unit tests. - - ## Sample usage - - Target "Test" (fun _ -> - !! (testDir + @"\xUnit.Test.*.dll") - |> xUnit (fun p -> {p with OutputDir = testDir }) - ) - - - - - DEPRECATED. - Builds the command line arguments from the given parameter record and the given assemblies. - [omit] - - - - - DEPRECATED. - - - - - DEPRECATED. - The xUnit default parameters - - - - - DEPRECATED. See [`Fake.Testing.XUnit`](fake-testing-xunit.html). - - Contains tasks to run [xUnit](https://github.com/xunit/xunit) unit tests. - - - - - Path to mdtool, defaults to Xamarin Studio's usual path - - - - - Build configuration, defaults to 'Debug|iPhoneSimulator' - - - - - Project name within a solution file - - - - - Path to desired solution file. If not provided, mdtool finds the first solution in the current directory. - Although mdtool can take a project file, the archiving seems to fail to work without a solution. - - - - - The iOS archive paramater type - - - - - Path to zipalign tool, defaults to assuming it is in your path - - - - - Path to jarsigner tool, defaults to assuming it is in your path - - - - - Specifies the name of the message digest algorithm to use when digesting the entries of a JAR file. - - - - - Specifies the name of the signature algorithm to use to sign the JAR file. - - - - - (Required) Alias for keystore - - - - - (Required) Password for keystore - - - - - (Required) Path to keystore used to sign the app - - - - - Used for multiple APK packaging to set different version code par ABI - - - - - Build an APK Targetting One ABI (used to reduce the size of the APK and support different CPU architectures) - - - - - Additional MSBuild properties, defaults to empty list - - - - - Output path for build, defaults to 'bin/Release' - - - - - Build configuration, defaults to 'Release' - - - - - (Required) Path to the Android project file (not the solution file!) - - - - - The Android packaging parameter type - - - - - Additional MSBuild properties, defaults to empty list - - - - - Indicates if an IPA file should be generated - - - - - Output path for build, defaults to project settings - - - - - Build platform, defaults to 'iPhoneSimulator' - - - - - Build configuration, defaults to 'Debug' - - - - - Build target, defaults to Build - - - - - (Required) Path to solution or project file - - - - - The iOS build paramater type - - - - - Path to xamarin-component.exe, defaults to checking tools/xpkg - - - - - The package restore paramater type - - - - - Archive a project using Xamarin's iOS archive tools - ## Parameters - - `setParams` - Function used to override the default archive parameters - - - - - The default iOS archive parameters - - - - - Signs and aligns multiple Xamarin.Android packages, returning multiple FileInfo objects for the signed APK file - ## Parameters - - `setParams` - Function used to override the default build parameters - - `apkFiles` - FileInfo object for an unsigned APK file to sign and align - - - - - Signs and aligns a Xamarin.Android package, returning a FileInfo object for the signed APK file - ## Parameters - - `setParams` - Function used to override the default build parameters - - `apkFile` - FileInfo object for an unsigned APK file to sign and align - - - - - The default Android signing and aligning parameters - - - - - Packages a Xamarin.Android app, returning a FileInfo object for the unsigned APK file - ## Parameters - - `setParams` - Function used to override the default build parameters - - - - - Packages a Xamarin.Android app, returning a multiple FileInfo objects for the unsigned APK files - ## Parameters - - `setParams` - Function used to override the default build parameters - - - - - The default Android packaging parameters - - - - - Builds a project or solution using Xamarin's iOS build tools - ## Parameters - - `setParams` - Function used to override the default build parameters - - - - - The default iOS build parameters - - - - - Restores NuGet packages and Xamarin Components for a project or solution - ## Parameters - - `setParams` - Function used to override the default package restore parameters - - - - - The default package restore parameters - - - - - Contains tasks for building Xamarin.iOS and Xamarin.Android apps - - - - - Parameter type for xpkg tasks - - - - - Validates a xpkg package based on the package file name - - - - - Creates a new xpkg package based on the package file name - - ## Sample - - Target "PackageXamarinDistribution" (fun _ -> - xpkgPack (fun p -> - {p with - ToolPath = xpkgExecutable; - Package = "Portable.Licensing"; - Version = assemblyFileVersion; - OutputPath = publishDir - Project = "Portable.Licensing" - Summary = "Portable.Licensing is a cross platform licensing tool" - Publisher = "Nauck IT KG" - Website = "http://dev.nauck-it.de" - Details = "./Xamarin/Details.md" - License = "License.md" - GettingStarted = "./Xamarin/GettingStarted.md" - Icons = ["./Xamarin/Portable.Licensing_512x512.png" - "./Xamarin/Portable.Licensing_128x128.png"] - Libraries = ["mobile", "./Distribution/lib/Portable.Licensing.dll"] - Samples = ["Android Sample.", "./Samples/Android/Android.Sample.sln" - "iOS Sample.", "./Samples/iOS/iOS.Sample.sln"] - } - ) - ) - - - - - Creates xpkg default parameters - - - - - Contains tasks to create packages in [Xamarin's xpkg format](http://components.xamarin.com/) - - - - - Creates a zip file with the given files. - ## Parameters - - `fileName` - The file name of the resulting zip file. - - `files` - A sequence of target folders and files to include relative to their base directory. - - ## Sample - - The following sample creates a zip file containing the files from the two target folders and FileIncludes. - - - The files from the first FileInclude will be placed in the root of the zip file. - - The files from the second FileInclude will be placed under the directory `app_data\jobs\continuous\MyWebJob` in the zip file. - - - Target "Zip" (fun _ -> - [ "", !! "MyWebApp/*.html" - ++ "MyWebApp/bin/**/*.dll" - ++ "MyWebApp/bin/**/*.pdb" - ++ "MyWebApp/fonts/**" - ++ "MyWebApp/img/**" - ++ "MyWebApp/js/**" - -- "MyWebApp/js/_references.js" - ++ "MyWebApp/web.config" - @"app_data\jobs\continuous\MyWebJob", !! "MyWebJob/bin/Release/*.*" - ] - |> ZipOfIncludes (sprintf @"bin\MyWebApp.%s.zip" buildVersion) - ) - - - - - - Creates a zip file with the given files. - ## Parameters - - `fileName` - The file name of the resulting zip file. - - `comment` - A comment for the resulting zip file. - - `level` - The compression level. - - `files` - A sequence of target folders and files to include relative to their base directory. - - - - - Unzips a single file from the archive with the given file name. - ## Parameters - - `predicate` - The predictae for the searched file in the archive. - - `zipFileName` - The file name of the zip file. - - - - - Unzips a single file from the archive with the given file name. - ## Parameters - - `fileToUnzip` - The file inside the archive. - - `zipFileName` - The file name of the zip file. - - - - - Unzips a file with the given file name. - ## Parameters - - `target` - The target directory. - - `fileName` - The file name of the zip file. - - - - - Creates a zip file with the given file. - ## Parameters - - `fileName` - The file name of the resulting zip file. - - `targetFileName` - The file to zip. - - - - - Creates a zip file with the given files. - ## Parameters - - `workingDir` - The relative dir of the zip files. Use this parameter to influence directory structure within zip file. - - `fileName` - The file name of the resulting zip file. - - `files` - A sequence with files to zip. - - - - - Creates a zip file with the given files - ## Parameters - - `workingDir` - The relative dir of the zip files. Use this parameter to influence directory structure within zip file. - - `fileName` - The fileName of the resulting zip file. - - `comment` - A comment for the resulting zip file. - - `level` - The compression level. - - `flatten` - If set to true then all subfolders are merged into the root folder. - - `files` - A sequence with files to zip. - - - - - The default zip level - - - - - This module contains helper function to create and extract zip archives. - - - - diff --git a/packages/FAKE.4.11.3/tools/FakeLib.dll b/packages/FAKE.4.11.3/tools/FakeLib.dll deleted file mode 100644 index 6fba7fc..0000000 Binary files a/packages/FAKE.4.11.3/tools/FakeLib.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/FakeLib.pdb.srcsrv b/packages/FAKE.4.11.3/tools/FakeLib.pdb.srcsrv deleted file mode 100644 index 3ae4b9a..0000000 --- a/packages/FAKE.4.11.3/tools/FakeLib.pdb.srcsrv +++ /dev/null @@ -1,133 +0,0 @@ -SRCSRV: ini ------------------------------------------------ -VERSION=2 -SRCSRV: variables ------------------------------------------ -SRCSRVVERCTRL=https -SRCSRVTRG=https://raw.github.com/fsharp/FAKE/522aa8f1c7128bbee047e3f42deebdc7785cd072/%var2% -SRCSRV: source files --------------------------------------- -C:\code\fake\src\app\FakeLib\UserInputHelper.fs*src/app/FakeLib/UserInputHelper.fs -C:\code\fake\src\app\FakeLib\CSharpHelper.fs*src/app/FakeLib/CSharpHelper.fs -C:\code\fake\src\app\FakeLib\EnvironmentHelper.fs*src/app/FakeLib/EnvironmentHelper.fs -C:\code\fake\src\app\FakeLib\RegistryHelper.fs*src/app/FakeLib/RegistryHelper.fs -C:\code\fake\src\app\FakeLib\FileSystemHelper.fs*src/app/FakeLib/FileSystemHelper.fs -C:\code\fake\src\app\FakeLib\StringHelper.fs*src/app/FakeLib/StringHelper.fs -C:\code\fake\src\app\FakeLib\TemplateHelper.fs*src/app/FakeLib/TemplateHelper.fs -C:\code\fake\src\app\FakeLib\CacheHelper.fs*src/app/FakeLib/CacheHelper.fs -C:\code\fake\src\app\FakeLib\XMLHelper.fs*src/app/FakeLib/XMLHelper.fs -C:\code\fake\src\app\FakeLib\REST.fs*src/app/FakeLib/REST.fs -C:\code\fake\src\app\FakeLib\BuildServerHelper.fs*src/app/FakeLib/BuildServerHelper.fs -C:\code\fake\src\app\FakeLib\TraceListener.fs*src/app/FakeLib/TraceListener.fs -C:\code\fake\src\app\FakeLib\TeamCityHelper.fs*src/app/FakeLib/TeamCityHelper.fs -C:\code\fake\src\app\FakeLib\TeamCityRESTHelper.fs*src/app/FakeLib/TeamCityRESTHelper.fs -C:\code\fake\src\app\FakeLib\TraceHelper.fs*src/app/FakeLib/TraceHelper.fs -C:\code\fake\src\app\FakeLib\ServiceControllerHelper.fs*src/app/FakeLib/ServiceControllerHelper.fs -C:\code\fake\src\app\FakeLib\GuardedAwaitObservable.fs*src/app/FakeLib/GuardedAwaitObservable.fs -C:\code\fake\src\app\FakeLib\ProcessHelper.fs*src/app/FakeLib/ProcessHelper.fs -C:\code\fake\src\app\FakeLib\NpmHelper.fs*src/app/FakeLib/NpmHelper.fs -C:\code\fake\src\app\FakeLib\AppVeyor.fs*src/app/FakeLib/AppVeyor.fs -C:\code\fake\src\app\FakeLib\TaskRunnerHelper.fs*src/app/FakeLib/TaskRunnerHelper.fs -C:\code\fake\src\app\FakeLib\Globbing\Globbing.fs*src/app/FakeLib/Globbing/Globbing.fs -C:\code\fake\src\app\FakeLib\Globbing\FileSystem.fs*src/app/FakeLib/Globbing/FileSystem.fs -C:\code\fake\src\app\FakeLib\FileHelper.fs*src/app/FakeLib/FileHelper.fs -C:\code\fake\src\app\FakeLib\FileUtils.fs*src/app/FakeLib/FileUtils.fs -C:\code\fake\src\app\FakeLib\UnitTest\UnitTestCommon.fs*src/app/FakeLib/UnitTest/UnitTestCommon.fs -C:\code\fake\src\app\FakeLib\UnitTest\UnitTestHelper.fs*src/app/FakeLib/UnitTest/UnitTestHelper.fs -C:\code\fake\src\app\FakeLib\UnitTest\NUnit\Xml.fs*src/app/FakeLib/UnitTest/NUnit/Xml.fs -C:\code\fake\src\app\FakeLib\UnitTest\NUnit\Common.fs*src/app/FakeLib/UnitTest/NUnit/Common.fs -C:\code\fake\src\app\FakeLib\UnitTest\NUnit\Sequential.fs*src/app/FakeLib/UnitTest/NUnit/Sequential.fs -C:\code\fake\src\app\FakeLib\UnitTest\NUnit\Parallel.fs*src/app/FakeLib/UnitTest/NUnit/Parallel.fs -C:\code\fake\src\app\FakeLib\UnitTest\XUnit\XUnit.fs*src/app/FakeLib/UnitTest/XUnit/XUnit.fs -C:\code\fake\src\app\FakeLib\UnitTest\XUnit\XUnitHelper.fs*src/app/FakeLib/UnitTest/XUnit/XUnitHelper.fs -C:\code\fake\src\app\FakeLib\UnitTest\XUnit\XUnit2.fs*src/app/FakeLib/UnitTest/XUnit/XUnit2.fs -C:\code\fake\src\app\FakeLib\UnitTest\XUnit\XUnit2Helper.fs*src/app/FakeLib/UnitTest/XUnit/XUnit2Helper.fs -C:\code\fake\src\app\FakeLib\UnitTest\MSpecHelper.fs*src/app/FakeLib/UnitTest/MSpecHelper.fs -C:\code\fake\src\app\FakeLib\UnitTest\MSTest.fs*src/app/FakeLib/UnitTest/MSTest.fs -C:\code\fake\src\app\FakeLib\UnitTest\ProcessTestRunner.fs*src/app/FakeLib/UnitTest/ProcessTestRunner.fs -C:\code\fake\src\app\FakeLib\UnitTest\VSTest.fs*src/app/FakeLib/UnitTest/VSTest.fs -C:\code\fake\src\app\FakeLib\AssemblyInfoFile.fs*src/app/FakeLib/AssemblyInfoFile.fs -C:\code\fake\src\app\FakeLib\AssemblyInfoHelper.fs*src/app/FakeLib/AssemblyInfoHelper.fs -C:\code\fake\src\app\FakeLib\FXCopHelper.fs*src/app/FakeLib/FXCopHelper.fs -C:\code\fake\src\app\FakeLib\FSharpFormattingHelper.fs*src/app/FakeLib/FSharpFormattingHelper.fs -C:\code\fake\src\app\FakeLib\NCoverHelper.fs*src/app/FakeLib/NCoverHelper.fs -C:\code\fake\src\app\FakeLib\NDependHelper.fs*src/app/FakeLib/NDependHelper.fs -C:\code\fake\src\app\FakeLib\MsBuildLogger.fs*src/app/FakeLib/MsBuildLogger.fs -C:\code\fake\src\app\FakeLib\MSBuildHelper.fs*src/app/FakeLib/MSBuildHelper.fs -C:\code\fake\src\app\FakeLib\ArchiveHelper.fs*src/app/FakeLib/ArchiveHelper.fs -C:\code\fake\src\app\FakeLib\ZipHelper.fs*src/app/FakeLib/ZipHelper.fs -C:\code\fake\src\app\FakeLib\StrongNamingHelper.fs*src/app/FakeLib/StrongNamingHelper.fs -C:\code\fake\src\app\FakeLib\GACHelper.fs*src/app/FakeLib/GACHelper.fs -C:\code\fake\src\app\FakeLib\NGenHelper.fs*src/app/FakeLib/NGenHelper.fs -C:\code\fake\src\app\FakeLib\DocuHelper.fs*src/app/FakeLib/DocuHelper.fs -C:\code\fake\src\app\FakeLib\ILMergeHelper.fs*src/app/FakeLib/ILMergeHelper.fs -C:\code\fake\src\app\FakeLib\WiXHelper.fs*src/app/FakeLib/WiXHelper.fs -C:\code\fake\src\app\FakeLib\MSIHelper.fs*src/app/FakeLib/MSIHelper.fs -C:\code\fake\src\app\FakeLib\RegAsmHelper.fs*src/app/FakeLib/RegAsmHelper.fs -C:\code\fake\src\app\FakeLib\RestorePackageHelper.fs*src/app/FakeLib/RestorePackageHelper.fs -C:\code\fake\src\app\FakeLib\VSSHelper.fs*src/app/FakeLib/VSSHelper.fs -C:\code\fake\src\app\FakeLib\DynamicsNavHelper.fs*src/app/FakeLib/DynamicsNavHelper.fs -C:\code\fake\src\app\FakeLib\DynamicsNavFile.fs*src/app/FakeLib/DynamicsNavFile.fs -C:\code\fake\src\app\FakeLib\SCPHelper.fs*src/app/FakeLib/SCPHelper.fs -C:\code\fake\src\app\FakeLib\RoboCopyHelper.fs*src/app/FakeLib/RoboCopyHelper.fs -C:\code\fake\src\app\FakeLib\XpkgHelper.fs*src/app/FakeLib/XpkgHelper.fs -C:\code\fake\src\app\FakeLib\VersionHelper.fs*src/app/FakeLib/VersionHelper.fs -C:\code\fake\src\app\FakeLib\MSBuild\ProjectSystem.fs*src/app/FakeLib/MSBuild/ProjectSystem.fs -C:\code\fake\src\app\FakeLib\MSBuild\SpecsRemovement.fs*src/app/FakeLib/MSBuild/SpecsRemovement.fs -C:\code\fake\src\app\FakeLib\Git\CommandHelper.fs*src/app/FakeLib/Git/CommandHelper.fs -C:\code\fake\src\app\FakeLib\Git\Sha1.fs*src/app/FakeLib/Git/Sha1.fs -C:\code\fake\src\app\FakeLib\Git\Repository.fs*src/app/FakeLib/Git/Repository.fs -C:\code\fake\src\app\FakeLib\Git\Submodule.fs*src/app/FakeLib/Git/Submodule.fs -C:\code\fake\src\app\FakeLib\Git\Branches.fs*src/app/FakeLib/Git/Branches.fs -C:\code\fake\src\app\FakeLib\Git\Reset.fs*src/app/FakeLib/Git/Reset.fs -C:\code\fake\src\app\FakeLib\Git\Merge.fs*src/app/FakeLib/Git/Merge.fs -C:\code\fake\src\app\FakeLib\Git\Stash.fs*src/app/FakeLib/Git/Stash.fs -C:\code\fake\src\app\FakeLib\Git\SanityChecks.fs*src/app/FakeLib/Git/SanityChecks.fs -C:\code\fake\src\app\FakeLib\Git\Information.fs*src/app/FakeLib/Git/Information.fs -C:\code\fake\src\app\FakeLib\Git\FileStatus.fs*src/app/FakeLib/Git/FileStatus.fs -C:\code\fake\src\app\FakeLib\Git\Rebase.fs*src/app/FakeLib/Git/Rebase.fs -C:\code\fake\src\app\FakeLib\Git\CommitMessage.fs*src/app/FakeLib/Git/CommitMessage.fs -C:\code\fake\src\app\FakeLib\Git\Staging.fs*src/app/FakeLib/Git/Staging.fs -C:\code\fake\src\app\FakeLib\Git\Commit.fs*src/app/FakeLib/Git/Commit.fs -C:\code\fake\src\app\FakeLib\FSIHelper.fs*src/app/FakeLib/FSIHelper.fs -C:\code\fake\src\app\FakeLib\Boot.fs*src/app/FakeLib/Boot.fs -C:\code\fake\src\app\FakeLib\MessageHelper.fs*src/app/FakeLib/MessageHelper.fs -C:\code\fake\src\app\FakeLib\HTMLHelpWorkShopHelper.fs*src/app/FakeLib/HTMLHelpWorkShopHelper.fs -C:\code\fake\src\app\FakeLib\ConfigurationHelper.fs*src/app/FakeLib/ConfigurationHelper.fs -C:\code\fake\src\app\FakeLib\TargetHelper.fs*src/app/FakeLib/TargetHelper.fs -C:\code\fake\src\app\FakeLib\AdditionalSyntax.fs*src/app/FakeLib/AdditionalSyntax.fs -C:\code\fake\src\app\FakeLib\PermissionsHelper.fs*src/app/FakeLib/PermissionsHelper.fs -C:\code\fake\src\app\FakeLib\SpecFlowHelper.fs*src/app/FakeLib/SpecFlowHelper.fs -C:\code\fake\src\app\FakeLib\OctoTools.fs*src/app/FakeLib/OctoTools.fs -C:\code\fake\src\app\FakeLib\SignToolHelper.fs*src/app/FakeLib/SignToolHelper.fs -C:\code\fake\src\app\FakeLib\MageHelper.fs*src/app/FakeLib/MageHelper.fs -C:\code\fake\src\app\FakeLib\SemVerHelper.fs*src/app/FakeLib/SemVerHelper.fs -C:\code\fake\src\app\FakeLib\ReleaseNotesHelper.fs*src/app/FakeLib/ReleaseNotesHelper.fs -C:\code\fake\src\app\FakeLib\FixieHelper.fs*src/app/FakeLib/FixieHelper.fs -C:\code\fake\src\app\FakeLib\NuGet\NugetHelper.fs*src/app/FakeLib/NuGet/NugetHelper.fs -C:\code\fake\src\app\FakeLib\NuGet\Update.fs*src/app/FakeLib/NuGet/Update.fs -C:\code\fake\src\app\FakeLib\NuGet\Install.fs*src/app/FakeLib/NuGet/Install.fs -C:\code\fake\src\app\FakeLib\TestFlightHelper.fs*src/app/FakeLib/TestFlightHelper.fs -C:\code\fake\src\app\FakeLib\DotCover.fs*src/app/FakeLib/DotCover.fs -C:\code\fake\src\app\FakeLib\PaketHelper.fs*src/app/FakeLib/PaketHelper.fs -C:\code\fake\src\app\FakeLib\AzureHelper.fs*src/app/FakeLib/AzureHelper.fs -C:\code\fake\src\app\FakeLib\FtpHelper.fs*src/app/FakeLib/FtpHelper.fs -C:\code\fake\src\app\FakeLib\TypeScript.fs*src/app/FakeLib/TypeScript.fs -C:\code\fake\src\app\FakeLib\OpenCoverHelper.fs*src/app/FakeLib/OpenCoverHelper.fs -C:\code\fake\src\app\FakeLib\ReportGeneratorHelper.fs*src/app/FakeLib/ReportGeneratorHelper.fs -C:\code\fake\src\app\FakeLib\RoundhouseHelper.fs*src/app/FakeLib/RoundhouseHelper.fs -C:\code\fake\src\app\FakeLib\FscHelper.fs*src/app/FakeLib/FscHelper.fs -C:\code\fake\src\app\FakeLib\CscHelper.fs*src/app/FakeLib/CscHelper.fs -C:\code\fake\src\app\FakeLib\HipChatNotificationHelper.fs*src/app/FakeLib/HipChatNotificationHelper.fs -C:\code\fake\src\app\FakeLib\XamarinHelper.fs*src/app/FakeLib/XamarinHelper.fs -C:\code\fake\src\app\FakeLib\XDTHelper.fs*src/app/FakeLib/XDTHelper.fs -C:\code\fake\src\app\FakeLib\AzureWebJobs.fs*src/app/FakeLib/AzureWebJobs.fs -C:\code\fake\src\app\FakeLib\HockeyAppHelper.fs*src/app/FakeLib/HockeyAppHelper.fs -C:\code\fake\src\app\FakeLib\AzureCloudServices.fs*src/app/FakeLib/AzureCloudServices.fs -C:\code\fake\src\app\FakeLib\Sxshelper.fs*src/app/FakeLib/Sxshelper.fs -C:\code\fake\src\app\FakeLib\Vb6helper.fs*src/app/FakeLib/Vb6helper.fs -C:\code\fake\src\app\FakeLib\AndroidPublisher.fs*src/app/FakeLib/AndroidPublisher.fs -C:\code\fake\src\app\FakeLib\ChangeWatcher.fs*src/app/FakeLib/ChangeWatcher.fs -C:\code\fake\src\app\FakeLib\CMake.fs*src/app/FakeLib/CMake.fs -C:\code\fake\src\app\FakeLib\RaygunHelper.fs*src/app/FakeLib/RaygunHelper.fs -C:\code\fake\src\app\FakeLib\SquirrelHelper.fs*src/app/FakeLib/SquirrelHelper.fs -C:\code\fake\src\app\FakeLib\XCopyHelper.fs*src/app/FakeLib/XCopyHelper.fs -C:\code\fake\src\app\FakeLib\DynamicsCRMHelper.fs*src/app/FakeLib/DynamicsCRMHelper.fs -SRCSRV: end ------------------------------------------------ diff --git a/packages/FAKE.4.11.3/tools/FluentMigrator.Runner.dll b/packages/FAKE.4.11.3/tools/FluentMigrator.Runner.dll deleted file mode 100644 index bbd864d..0000000 Binary files a/packages/FAKE.4.11.3/tools/FluentMigrator.Runner.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/FluentMigrator.dll b/packages/FAKE.4.11.3/tools/FluentMigrator.dll deleted file mode 100644 index 2681b44..0000000 Binary files a/packages/FAKE.4.11.3/tools/FluentMigrator.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/FluentMigrator.xml b/packages/FAKE.4.11.3/tools/FluentMigrator.xml deleted file mode 100644 index fad70df..0000000 --- a/packages/FAKE.4.11.3/tools/FluentMigrator.xml +++ /dev/null @@ -1,427 +0,0 @@ - - - - FluentMigrator - - - - - Represents a stage in the migration run. - - - - - Migration will be run before all standard migrations. - - - - - Migration will be run before each standard migration. - - - - - Migration will be run after each standard migration. - - - - - Migration will be run after all standard migrations, but before profiles. - - - - - Migration will be run after all standard migrations and profiles. - - - - - Annotates migrations that should always be executed at a specified stage. - - - Migration annotated with will be always executed - when migrating the database to the latest version. The execution stage in which it would - be executed is defined by . The transaction behavior can also be defined - with the , which if not specified defaults to the default - transaction behavior. - - - - - Describes common attributes for expression builders which have a current table/column. - - - - - The value to set against existing rows for the new column. Only used for creating columns, not altering them. - - - - - The value to set against existing rows for the new column. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Allows for conditional inclusion of expresions based on the migration context - - - - - Defines fluent expressions that can be conditionally executed - - - - - The context to add expressions into - - If the database type doe snot apply then this will be a new context that is not used by the caller - - - - Constricts a new instance of a that will only add expressions to the provided if matches the migration processor - - If the database type does not apply then a will be used as a container to void any fluent expressions that would have been executed - The context to add expressions to if the database type applies - The database type that the expressions relate to - - - - Checks if the database type matches the name of the context migration processor - - The context to evaluate - The type to be checked - True if the database type applies, False if not - - - - Alter the schema of an existing object - - - - - Create a new database object - - - - - Delete a database object, table, or row - - - - - Rename tables / columns - - - - - Insert data into a table - - - - - Execute SQL statements - - - - - Update an existing row - - - - - Provides a null implmentation of a procesor that does not do any work - - - - - Insert text with unicode data. Primarily for Sql Server, it prefixes the string with 'N - - - - - Insert text with unicode data. Primarily for Sql Server, it prefixes the string with 'N - - Unicode string - - - - - This class provides a common location for logic pertaining to setting and maintaining - expressions for expression builders which manipulate the the ColumnDefinition. - - - This is a support class for the migrator framework and is not intended for external use. - TODO: make this internal, and the change assmebly info so InternalsVisibleTo is set for the test assemblies. - - - - - For easy mockability only. - - - - - Either updates the IsNullable flag on the column, or creates/removes the SetNotNull expression, depending - on whether the column has a 'Set existing rows' expression. - - - - - Adds the existing row default value. If the column has a value for IsNullable, this will also - call SetNullable to create the expression, and will then set the column IsNullable to false. - - - - - For each distinct column which has an existing row default, an instance of this - will be stored in the _expressionsByColumn. - - - - - A bundle of one or more Assembly instances - - - - - The result of this method is equivalent to calling GetExportedTypes - on each Assembly in Assemblies. - - - - - - Gets a array of resources defined in each of the assemblies that are - contained in this collection, plus which assembly it is defined in. - - An array of value pairs of resource name plus assembly. - - - - The Assemblies contained in this collection - - - - - Combines a ManifestResourceName with the assembly it belongs to - - - - - A simple wrapper which is equivalent to a collection with a single Assembly - - - - - This adapter wraps a migration into a MigrationInfo instance, used to keep IMigration backwards compatible with new IMigrationInfo. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - The arbitrary application context passed to the task runner. - - - The arbitrary application context passed to the task runner. - - - - Connection String that is used to execute migrations. - - - - - Initializes a new instance of the class. - - - - - Used to filter which migrations are run. - - - - - Creates a MigrationAttribute which executes in order based on the given date and time. - - - - - Initializes a new instance of the class whose version is based on date and time information. - - The year the migration was created. - The month the migration was created. - The day the migration was created. - The hour the migration was created. - The minute the migration was created. - The second the migration was created. - - - - Initializes a new instance of the class whose version is based on date and time information. - - The year the migration was created. - The month the migration was created. - The day the migration was created. - The hour the migration was created. - The minute the migration was created. - - - - Initializes a new instance of the class whose version is based on date and time information. - - The year the migration was created. - The month the migration was created. - The day the migration was created. - The hour the migration was created. - The minute the migration was created. - A description for the migration. - - - - Initializes a new instance of the class whose version is based on date and time information. - - The year the migration was created. - The month the migration was created. - The day the migration was created. - The hour the migration was created. - The minute the migration was created. - The second the migration was created. - A description for the migration. - - - - Initializes a new instance of the class whose version is based on date and time information. - - The year the migration was created. - The month the migration was created. - The day the migration was created. - The hour the migration was created. - The minute the migration was created. - The the migration will use. - - - - Initializes a new instance of the class whose version is based on date and time information. - - The year the migration was created. - The month the migration was created. - The day the migration was created. - The hour the migration was created. - The minute the migration was created. - The second the migration was created. - The the migration will use. - - - - Initializes a new instance of the class whose version is based on date and time information. - - The year the migration was created. - The month the migration was created. - The day the migration was created. - The hour the migration was created. - The minute the migration was created. - The the migration will use. - A description for the migration. - - - - Initializes a new instance of the class whose version is based on date and time information. - - The year the migration was created. - The month the migration was created. - The day the migration was created. - The hour the migration was created. - The minute the migration was created. - The second the migration was created. - The the migration will use. - A description for the migration. - - - - The default transaction behavior, meaning 1 transaction per migration if the Processor allows it. - - - - - A migration will not use a transaction. - - - - - Provides access to ApplicationContext object. - - - ApplicationContext value is set by FluentMigrator immediately after instantiation of a class - implementing IVersionTableMetaData and before any of properties of IVersionTableMetaData - is called. Properties can use ApplicationContext value to implement context-depending logic. - - - - - Provides access to ApplicationContext object. - - - ApplicationContext value is set by FluentMigrator immediately after instantiation of a class - implementing IVersionTableMetaData and before any of properties of IVersionTableMetaData - is called. Properties can use ApplicationContext value to implement context-depending logic. - - - - - Deletes an index - - the name of the index - - - - - Deletes an index, based on the naming convention in effect - - - - - - Deletes a named Primary Key from a table - - - - - - - Deletes a named Unique Constraint From a table - - - - - - The arbitrary application context passed to the task runner. - - - The arbitrary application context passed to the task runner. - - - - Connection String from the runner. - - - - diff --git a/packages/FAKE.4.11.3/tools/License.txt b/packages/FAKE.4.11.3/tools/License.txt deleted file mode 100644 index 2f2d5da..0000000 --- a/packages/FAKE.4.11.3/tools/License.txt +++ /dev/null @@ -1,263 +0,0 @@ -Copyright 2008 "FAKE - F# Make" Project -Copyright 2010 Steffen Forkmann - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this project except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. - - -You may choose to use this library under either the MS-PL or Apache 2.0 -licenses. Both are included here for reference. - -Unless you explicitly state otherwise, any Contribution intentionally -submitted for inclusion in the Project shall be under the terms and -conditions of the Apache 2.0 license. - - - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - ------------------------------------------ - -Microsoft Public License (MS-PL) - -This license governs use of the accompanying software. If you use the software, you accept this license. If you do not accept the license, do not use the software. - -1. Definitions - -The terms "reproduce," "reproduction," "derivative works," and "distribution" have the same meaning here as under U.S. copyright law. - -A "contribution" is the original software, or any additions or changes to the software. - -A "contributor" is any person that distributes its contribution under this license. - -"Licensed patents" are a contributor's patent claims that read directly on its contribution. - -2. Grant of Rights - -(A) Copyright Grant- Subject to the terms of this license, including the license conditions and limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free copyright license to reproduce its contribution, prepare derivative works of its contribution, and distribute its contribution or any derivative works that you create. - -(B) Patent Grant- Subject to the terms of this license, including the license conditions and limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free license under its licensed patents to make, have made, use, sell, offer for sale, import, and/or otherwise dispose of its contribution in the software or derivative works of the contribution in the software. - -3. Conditions and Limitations - -(A) No Trademark License- This license does not grant you rights to use any contributors' name, logo, or trademarks. - -(B) If you bring a patent claim against any contributor over patents that you claim are infringed by the software, your patent license from such contributor to the software ends automatically. - -(C) If you distribute any portion of the software, you must retain all copyright, patent, trademark, and attribution notices that are present in the software. - -(D) If you distribute any portion of the software in source code form, you may do so only under this license by including a complete copy of this license with your distribution. If you distribute any portion of the software in compiled or object code form, you may only do so under a license that complies with this license. - -(E) The software is licensed "as-is." You bear the risk of using it. The contributors give no express warranties, guarantees or conditions. You may have additional consumer rights under your local laws which this license cannot change. To the extent permitted under your local laws, the contributors exclude the implied warranties of merchantability, fitness for a particular purpose and non-infringement. - - diff --git a/packages/FAKE.4.11.3/tools/Microsoft.Web.XmlTransform.dll b/packages/FAKE.4.11.3/tools/Microsoft.Web.XmlTransform.dll deleted file mode 100644 index 98c9d56..0000000 Binary files a/packages/FAKE.4.11.3/tools/Microsoft.Web.XmlTransform.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/Mono.Cecil.Mdb.dll b/packages/FAKE.4.11.3/tools/Mono.Cecil.Mdb.dll deleted file mode 100644 index fe7874d..0000000 Binary files a/packages/FAKE.4.11.3/tools/Mono.Cecil.Mdb.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/Mono.Cecil.Pdb.dll b/packages/FAKE.4.11.3/tools/Mono.Cecil.Pdb.dll deleted file mode 100644 index 78897c0..0000000 Binary files a/packages/FAKE.4.11.3/tools/Mono.Cecil.Pdb.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/Mono.Cecil.Rocks.dll b/packages/FAKE.4.11.3/tools/Mono.Cecil.Rocks.dll deleted file mode 100644 index 79245e9..0000000 Binary files a/packages/FAKE.4.11.3/tools/Mono.Cecil.Rocks.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/Mono.Cecil.dll b/packages/FAKE.4.11.3/tools/Mono.Cecil.dll deleted file mode 100644 index bf3acf1..0000000 Binary files a/packages/FAKE.4.11.3/tools/Mono.Cecil.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/NLog.dll b/packages/FAKE.4.11.3/tools/NLog.dll deleted file mode 100644 index e3747be..0000000 Binary files a/packages/FAKE.4.11.3/tools/NLog.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/NLog.xml b/packages/FAKE.4.11.3/tools/NLog.xml deleted file mode 100644 index 21bbb99..0000000 --- a/packages/FAKE.4.11.3/tools/NLog.xml +++ /dev/null @@ -1,20738 +0,0 @@ - - - - NLog - - - - - Indicates that the value of the marked element could be null sometimes, - so the check for null is necessary before its usage - - - [CanBeNull] public object Test() { return null; } - public void UseTest() { - var p = Test(); - var s = p.ToString(); // Warning: Possible 'System.NullReferenceException' - } - - - - - Indicates that the value of the marked element could never be null - - - [NotNull] public object Foo() { - return null; // Warning: Possible 'null' assignment - } - - - - - Indicates that the marked method builds string by format pattern and (optional) arguments. - Parameter, which contains format string, should be given in constructor. The format string - should be in -like form - - - [StringFormatMethod("message")] - public void ShowError(string message, params object[] args) { /* do something */ } - public void Foo() { - ShowError("Failed: {0}"); // Warning: Non-existing argument in format string - } - - - - - Specifies which parameter of an annotated method should be treated as format-string - - - - - Indicates that the function argument should be string literal and match one - of the parameters of the caller function. For example, ReSharper annotates - the parameter of - - - public void Foo(string param) { - if (param == null) - throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol - } - - - - - Indicates that the method is contained in a type that implements - interface - and this method is used to notify that some property value changed - - - The method should be non-static and conform to one of the supported signatures: - - NotifyChanged(string) - NotifyChanged(params string[]) - NotifyChanged{T}(Expression{Func{T}}) - NotifyChanged{T,U}(Expression{Func{T,U}}) - SetProperty{T}(ref T, T, string) - - - - internal class Foo : INotifyPropertyChanged { - public event PropertyChangedEventHandler PropertyChanged; - [NotifyPropertyChangedInvocator] - protected virtual void NotifyChanged(string propertyName) { ... } - - private string _name; - public string Name { - get { return _name; } - set { _name = value; NotifyChanged("LastName"); /* Warning */ } - } - } - - Examples of generated notifications: - - NotifyChanged("Property") - NotifyChanged(() => Property) - NotifyChanged((VM x) => x.Property) - SetProperty(ref myField, value, "Property") - - - - - - Describes dependency between method input and output - - -

Function Definition Table syntax:

- - FDT ::= FDTRow [;FDTRow]* - FDTRow ::= Input => Output | Output <= Input - Input ::= ParameterName: Value [, Input]* - Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} - Value ::= true | false | null | notnull | canbenull - - If method has single input parameter, it's name could be omitted.
- Using halt (or void/nothing, which is the same) - for method output means that the methos doesn't return normally.
- canbenull annotation is only applicable for output parameters.
- You can use multiple [ContractAnnotation] for each FDT row, - or use single attribute with rows separated by semicolon.
-
- - - [ContractAnnotation("=> halt")] - public void TerminationMethod() - - - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method - - - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() - - - // A method that returns null if the parameter is null, and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) - - - [ContractAnnotation("s:null=>false; =>true,result:notnull; =>false, result:null")] - public bool TryParse(string s, out Person result) - - -
- - - Indicates that marked element should be localized or not - - - [LocalizationRequiredAttribute(true)] - internal class Foo { - private string str = "my string"; // Warning: Localizable string - } - - - - - Indicates that the value of the marked type (or its derivatives) - cannot be compared using '==' or '!=' operators and Equals() - should be used instead. However, using '==' or '!=' for comparison - with null is always permitted. - - - [CannotApplyEqualityOperator] - class NoEquality { } - class UsesNoEquality { - public void Test() { - var ca1 = new NoEquality(); - var ca2 = new NoEquality(); - if (ca1 != null) { // OK - bool condition = ca1 == ca2; // Warning - } - } - } - - - - - When applied to a target attribute, specifies a requirement for any type marked - with the target attribute to implement or inherit specific type or types. - - - [BaseTypeRequired(typeof(IComponent)] // Specify requirement - internal class ComponentAttribute : Attribute { } - [Component] // ComponentAttribute requires implementing IComponent interface - internal class MyComponent : IComponent { } - - - - - Indicates that the marked symbol is used implicitly - (e.g. via reflection, in external library), so this symbol - will not be marked as unused (as well as by other usage inspections) - - - - - Should be used on attributes and causes ReSharper - to not mark symbols marked with such attributes as unused - (as well as by other usage inspections) - - - - Only entity marked with attribute considered used - - - Indicates implicit assignment to a member - - - - Indicates implicit instantiation of a type with fixed constructor signature. - That means any unused constructor parameters won't be reported as such. - - - - Indicates implicit instantiation of a type - - - - Specify what is considered used implicitly - when marked with - or - - - - Members of entity marked with attribute are considered used - - - Entity marked with attribute and all its members considered used - - - - This attribute is intended to mark publicly available API - which should not be removed and so is treated as used - - - - - Tells code analysis engine if the parameter is completely handled - when the invoked method is on stack. If the parameter is a delegate, - indicates that delegate is executed while the method is executed. - If the parameter is an enumerable, indicates that it is enumerated - while the method is executed - - - - - Indicates that a method does not make any observable state changes. - The same as System.Diagnostics.Contracts.PureAttribute - - - [Pure] private int Multiply(int x, int y) { return x * y; } - public void Foo() { - const int a = 2, b = 2; - Multiply(a, b); // Waring: Return value of pure method is not used - } - - - - - Indicates that a parameter is a path to a file or a folder - within a web project. Path can be relative or absolute, - starting from web root (~) - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC action. If applied to a method, the MVC action name is calculated - implicitly from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String) - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC area. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String) - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that - the parameter is an MVC controller. If applied to a method, - the MVC controller name is calculated implicitly from the context. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String, String) - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC Master. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Controller.View(String, String) - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC model type. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Controller.View(String, Object) - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that - the parameter is an MVC partial view. If applied to a method, - the MVC partial view name is calculated implicitly from the context. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.RenderPartialExtensions.RenderPartial(HtmlHelper, String) - - - - - ASP.NET MVC attribute. Allows disabling all inspections - for MVC views within a class or a method. - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC display template. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.DisplayExtensions.DisplayForModel(HtmlHelper, String) - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC editor template. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.EditorExtensions.EditorForModel(HtmlHelper, String) - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC template. - Use this attribute for custom wrappers similar to - System.ComponentModel.DataAnnotations.UIHintAttribute(System.String) - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view. If applied to a method, the MVC view name is calculated implicitly - from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Controller.View(Object) - - - - - ASP.NET MVC attribute. When applied to a parameter of an attribute, - indicates that this parameter is an MVC action name - - - [ActionName("Foo")] - public ActionResult Login(string returnUrl) { - ViewBag.ReturnUrl = Url.Action("Foo"); // OK - return RedirectToAction("Bar"); // Error: Cannot resolve action - } - - - - - Razor attribute. Indicates that a parameter or a method is a Razor section. - Use this attribute for custom wrappers similar to - System.Web.WebPages.WebPageBase.RenderSection(String) - - - - - Asynchronous continuation delegate - function invoked at the end of asynchronous - processing. - - Exception during asynchronous processing or null if no exception - was thrown. - - - - Helpers for asynchronous operations. - - - - - Iterates over all items in the given collection and runs the specified action - in sequence (each action executes only after the preceding one has completed without an error). - - Type of each item. - The items to iterate. - The asynchronous continuation to invoke once all items - have been iterated. - The action to invoke for each item. - - - - Repeats the specified asynchronous action multiple times and invokes asynchronous continuation at the end. - - The repeat count. - The asynchronous continuation to invoke at the end. - The action to invoke. - - - - Modifies the continuation by pre-pending given action to execute just before it. - - The async continuation. - The action to pre-pend. - Continuation which will execute the given action before forwarding to the actual continuation. - - - - Attaches a timeout to a continuation which will invoke the continuation when the specified - timeout has elapsed. - - The asynchronous continuation. - The timeout. - Wrapped continuation. - - - - Iterates over all items in the given collection and runs the specified action - in parallel (each action executes on a thread from thread pool). - - Type of each item. - The items to iterate. - The asynchronous continuation to invoke once all items - have been iterated. - The action to invoke for each item. - - - - Runs the specified asynchronous action synchronously (blocks until the continuation has - been invoked). - - The action. - - Using this method is not recommended because it will block the calling thread. - - - - - Wraps the continuation with a guard which will only make sure that the continuation function - is invoked only once. - - The asynchronous continuation. - Wrapped asynchronous continuation. - - - - Gets the combined exception from all exceptions in the list. - - The exceptions. - Combined exception or null if no exception was thrown. - - - - Asynchronous action. - - Continuation to be invoked at the end of action. - - - - Asynchronous action with one argument. - - Type of the argument. - Argument to the action. - Continuation to be invoked at the end of action. - - - - Represents the logging event with asynchronous continuation. - - - - - Initializes a new instance of the struct. - - The log event. - The continuation. - - - - Implements the operator ==. - - The event info1. - The event info2. - The result of the operator. - - - - Implements the operator ==. - - The event info1. - The event info2. - The result of the operator. - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - A value of true if the specified is equal to this instance; otherwise, false. - - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Gets the log event. - - - - - Gets the continuation. - - - - - NLog internal logger. - - - - - Initializes static members of the InternalLogger class. - - - - - Logs the specified message at the specified level. - - Log level. - Message which may include positional parameters. - Arguments to the message. - - - - Logs the specified message at the specified level. - - Log level. - Log message. - - - - Logs the specified message at the Trace level. - - Message which may include positional parameters. - Arguments to the message. - - - - Logs the specified message at the Trace level. - - Log message. - - - - Logs the specified message at the Debug level. - - Message which may include positional parameters. - Arguments to the message. - - - - Logs the specified message at the Debug level. - - Log message. - - - - Logs the specified message at the Info level. - - Message which may include positional parameters. - Arguments to the message. - - - - Logs the specified message at the Info level. - - Log message. - - - - Logs the specified message at the Warn level. - - Message which may include positional parameters. - Arguments to the message. - - - - Logs the specified message at the Warn level. - - Log message. - - - - Logs the specified message at the Error level. - - Message which may include positional parameters. - Arguments to the message. - - - - Logs the specified message at the Error level. - - Log message. - - - - Logs the specified message at the Fatal level. - - Message which may include positional parameters. - Arguments to the message. - - - - Logs the specified message at the Fatal level. - - Log message. - - - - Logs the assembly version and file version of the given Assembly. - - The assembly to log. - - - - Gets or sets the internal log level. - - - - - Gets or sets a value indicating whether internal messages should be written to the console output stream. - - - - - Gets or sets a value indicating whether internal messages should be written to the console error stream. - - - - - Gets or sets the file path of the internal log file. - - A value of value disables internal logging to a file. - - - - Gets or sets the text writer that will receive internal logs. - - - - - Gets or sets a value indicating whether timestamp should be included in internal log output. - - - - - Gets a value indicating whether internal log includes Trace messages. - - - - - Gets a value indicating whether internal log includes Debug messages. - - - - - Gets a value indicating whether internal log includes Info messages. - - - - - Gets a value indicating whether internal log includes Warn messages. - - - - - Gets a value indicating whether internal log includes Error messages. - - - - - Gets a value indicating whether internal log includes Fatal messages. - - - - - A cyclic buffer of object. - - - - - Initializes a new instance of the class. - - Buffer size. - Whether buffer should grow as it becomes full. - The maximum number of items that the buffer can grow to. - - - - Adds the specified log event to the buffer. - - Log event. - The number of items in the buffer. - - - - Gets the array of events accumulated in the buffer and clears the buffer as one atomic operation. - - Events in the buffer. - - - - Gets the number of items in the array. - - - - - Condition and expression. - - - - - Base class for representing nodes in condition expression trees. - - - - - Converts condition text to a condition expression tree. - - Condition text to be converted. - Condition expression tree. - - - - Evaluates the expression. - - Evaluation context. - Expression result. - - - - Returns a string representation of the expression. - - - A that represents the condition expression. - - - - - Evaluates the expression. - - Evaluation context. - Expression result. - - - - Initializes a new instance of the class. - - Left hand side of the AND expression. - Right hand side of the AND expression. - - - - Returns a string representation of this expression. - - A concatenated '(Left) and (Right)' string. - - - - Evaluates the expression by evaluating and recursively. - - Evaluation context. - The value of the conjunction operator. - - - - Gets the left hand side of the AND expression. - - - - - Gets the right hand side of the AND expression. - - - - - Exception during evaluation of condition expression. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - The message. - The inner exception. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - - The parameter is null. - - - The class name is null or is zero (0). - - - - - Condition layout expression (represented by a string literal - with embedded ${}). - - - - - Initializes a new instance of the class. - - The layout. - - - - Returns a string representation of this expression. - - String literal in single quotes. - - - - Evaluates the expression by calculating the value - of the layout in the specified evaluation context. - - Evaluation context. - The value of the layout. - - - - Gets the layout. - - The layout. - - - - Condition level expression (represented by the level keyword). - - - - - Returns a string representation of the expression. - - The 'level' string. - - - - Evaluates to the current log level. - - Evaluation context. Ignored. - The object representing current log level. - - - - Condition literal expression (numeric, LogLevel.XXX, true or false). - - - - - Initializes a new instance of the class. - - Literal value. - - - - Returns a string representation of the expression. - - The literal value. - - - - Evaluates the expression. - - Evaluation context. - The literal value as passed in the constructor. - - - - Gets the literal value. - - The literal value. - - - - Condition logger name expression (represented by the logger keyword). - - - - - Returns a string representation of this expression. - - A logger string. - - - - Evaluates to the logger name. - - Evaluation context. - The logger name. - - - - Condition message expression (represented by the message keyword). - - - - - Returns a string representation of this expression. - - The 'message' string. - - - - Evaluates to the logger message. - - Evaluation context. - The logger message. - - - - Marks class as a log event Condition and assigns a name to it. - - - - - Attaches a simple name to an item (such as , - , , etc.). - - - - - Initializes a new instance of the class. - - The name of the item. - - - - Gets the name of the item. - - The name of the item. - - - - Initializes a new instance of the class. - - Condition method name. - - - - Condition method invocation expression (represented by method(p1,p2,p3) syntax). - - - - - Initializes a new instance of the class. - - Name of the condition method. - of the condition method. - The method parameters. - - - - Returns a string representation of the expression. - - - A that represents the condition expression. - - - - - Evaluates the expression. - - Evaluation context. - Expression result. - - - - Gets the method info. - - - - - Gets the method parameters. - - The method parameters. - - - - A bunch of utility methods (mostly predicates) which can be used in - condition expressions. Partially inspired by XPath 1.0. - - - - - Compares two values for equality. - - The first value. - The second value. - true when two objects are equal, false otherwise. - - - - Compares two strings for equality. - - The first string. - The second string. - Optional. If true, case is ignored; if false (default), case is significant. - true when two strings are equal, false otherwise. - - - - Gets or sets a value indicating whether the second string is a substring of the first one. - - The first string. - The second string. - Optional. If true (default), case is ignored; if false, case is significant. - true when the second string is a substring of the first string, false otherwise. - - - - Gets or sets a value indicating whether the second string is a prefix of the first one. - - The first string. - The second string. - Optional. If true (default), case is ignored; if false, case is significant. - true when the second string is a prefix of the first string, false otherwise. - - - - Gets or sets a value indicating whether the second string is a suffix of the first one. - - The first string. - The second string. - Optional. If true (default), case is ignored; if false, case is significant. - true when the second string is a prefix of the first string, false otherwise. - - - - Returns the length of a string. - - A string whose lengths is to be evaluated. - The length of the string. - - - - Marks the class as containing condition methods. - - - - - Condition not expression. - - - - - Initializes a new instance of the class. - - The expression. - - - - Returns a string representation of the expression. - - - A that represents the condition expression. - - - - - Evaluates the expression. - - Evaluation context. - Expression result. - - - - Gets the expression to be negated. - - The expression. - - - - Condition or expression. - - - - - Initializes a new instance of the class. - - Left hand side of the OR expression. - Right hand side of the OR expression. - - - - Returns a string representation of the expression. - - - A that represents the condition expression. - - - - - Evaluates the expression by evaluating and recursively. - - Evaluation context. - The value of the alternative operator. - - - - Gets the left expression. - - The left expression. - - - - Gets the right expression. - - The right expression. - - - - Exception during parsing of condition expression. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - The message. - The inner exception. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - - The parameter is null. - - - The class name is null or is zero (0). - - - - - Condition parser. Turns a string representation of condition expression - into an expression tree. - - - - - Initializes a new instance of the class. - - The string reader. - Instance of used to resolve references to condition methods and layout renderers. - - - - Parses the specified condition string and turns it into - tree. - - The expression to be parsed. - The root of the expression syntax tree which can be used to get the value of the condition in a specified context. - - - - Parses the specified condition string and turns it into - tree. - - The expression to be parsed. - Instance of used to resolve references to condition methods and layout renderers. - The root of the expression syntax tree which can be used to get the value of the condition in a specified context. - - - - Parses the specified condition string and turns it into - tree. - - The string reader. - Instance of used to resolve references to condition methods and layout renderers. - - The root of the expression syntax tree which can be used to get the value of the condition in a specified context. - - - - - Condition relational (==, !=, <, <=, - > or >=) expression. - - - - - Initializes a new instance of the class. - - The left expression. - The right expression. - The relational operator. - - - - Returns a string representation of the expression. - - - A that represents the condition expression. - - - - - Evaluates the expression. - - Evaluation context. - Expression result. - - - - Compares the specified values using specified relational operator. - - The first value. - The second value. - The relational operator. - Result of the given relational operator. - - - - Gets the left expression. - - The left expression. - - - - Gets the right expression. - - The right expression. - - - - Gets the relational operator. - - The operator. - - - - Relational operators used in conditions. - - - - - Equality (==). - - - - - Inequality (!=). - - - - - Less than (<). - - - - - Greater than (>). - - - - - Less than or equal (<=). - - - - - Greater than or equal (>=). - - - - - Hand-written tokenizer for conditions. - - - - - Initializes a new instance of the class. - - The string reader. - - - - Asserts current token type and advances to the next token. - - Expected token type. - If token type doesn't match, an exception is thrown. - - - - Asserts that current token is a keyword and returns its value and advances to the next token. - - Keyword value. - - - - Gets or sets a value indicating whether current keyword is equal to the specified value. - - The keyword. - - A value of true if current keyword is equal to the specified value; otherwise, false. - - - - - Gets or sets a value indicating whether the tokenizer has reached the end of the token stream. - - - A value of true if the tokenizer has reached the end of the token stream; otherwise, false. - - - - - Gets or sets a value indicating whether current token is a number. - - - A value of true if current token is a number; otherwise, false. - - - - - Gets or sets a value indicating whether the specified token is of specified type. - - The token type. - - A value of true if current token is of specified type; otherwise, false. - - - - - Gets the next token and sets and properties. - - - - - Try the comparison tokens (greater, smaller, greater-equals, smaller-equals) - - current char - is match - - - - Try the logical tokens (and, or, not, equals) - - current char - is match - - - - Gets the token position. - - The token position. - - - - Gets the type of the token. - - The type of the token. - - - - Gets the token value. - - The token value. - - - - Gets the value of a string token. - - The string token value. - - - - Mapping between characters and token types for punctuations. - - - - - Initializes a new instance of the CharToTokenType struct. - - The character. - Type of the token. - - - - Token types for condition expressions. - - - - - Marks the class or a member as advanced. Advanced classes and members are hidden by - default in generated documentation. - - - - - Initializes a new instance of the class. - - - - - Identifies that the output of layout or layout render does not change for the lifetime of the current appdomain. - - - - - Used to mark configurable parameters which are arrays. - Specifies the mapping between XML elements and .NET types. - - - - - Initializes a new instance of the class. - - The type of the array item. - The XML element name that represents the item. - - - - Gets the .NET type of the array item. - - - - - Gets the XML element name. - - - - - NLog configuration section handler class for configuring NLog from App.config. - - - - - Creates a configuration section handler. - - Parent object. - Configuration context object. - Section XML node. - The created section handler object. - - - - Constructs a new instance the configuration item (target, layout, layout renderer, etc.) given its type. - - Type of the item. - Created object of the specified type. - - - - Provides registration information for named items (targets, layouts, layout renderers, etc.) managed by NLog. - - - - - Initializes a new instance of the class. - - The assemblies to scan for named items. - - - - Registers named items from the assembly. - - The assembly. - - - - Registers named items from the assembly. - - The assembly. - Item name prefix. - - - - Clears the contents of all factories. - - - - - Registers the type. - - The type to register. - The item name prefix. - - - - Builds the default configuration item factory. - - Default factory. - - - - Registers items in NLog.Extended.dll using late-bound types, so that we don't need a reference to NLog.Extended.dll. - - - - - Gets or sets default singleton instance of . - - - This property implements lazy instantiation so that the is not built before - the internal logger is configured. - - - - - Gets or sets the creator delegate used to instantiate configuration objects. - - - By overriding this property, one can enable dependency injection or interception for created objects. - - - - - Gets the factory. - - The target factory. - - - - Gets the factory. - - The filter factory. - - - - Gets the factory. - - The layout renderer factory. - - - - Gets the factory. - - The layout factory. - - - - Gets the ambient property factory. - - The ambient property factory. - - - - Gets the time source factory. - - The time source factory. - - - - Gets the condition method factory. - - The condition method factory. - - - - Attribute used to mark the default parameters for layout renderers. - - - - - Initializes a new instance of the class. - - - - - Factory for class-based items. - - The base type of each item. - The type of the attribute used to annotate items. - - - - Represents a factory of named items (such as targets, layouts, layout renderers, etc.). - - Base type for each item instance. - Item definition type (typically or ). - - - - Registers new item definition. - - Name of the item. - Item definition. - - - - Tries to get registered item definition. - - Name of the item. - Reference to a variable which will store the item definition. - Item definition. - - - - Creates item instance. - - Name of the item. - Newly created item instance. - - - - Tries to create an item instance. - - Name of the item. - The result. - True if instance was created successfully, false otherwise. - - - - Provides means to populate factories of named items (such as targets, layouts, layout renderers, etc.). - - - - - Scans the assembly. - - The types to scan. - The prefix. - - - - Registers the type. - - The type to register. - The item name prefix. - - - - Registers the item based on a type name. - - Name of the item. - Name of the type. - - - - Clears the contents of the factory. - - - - - Registers a single type definition. - - The item name. - The type of the item. - - - - Tries to get registered item definition. - - Name of the item. - Reference to a variable which will store the item definition. - Item definition. - - - - Tries to create an item instance. - - Name of the item. - The result. - True if instance was created successfully, false otherwise. - - - - Creates an item instance. - - The name of the item. - Created item. - - - - Implemented by objects which support installation and uninstallation. - - - - - Performs installation which requires administrative permissions. - - The installation context. - - - - Performs uninstallation which requires administrative permissions. - - The installation context. - - - - Determines whether the item is installed. - - The installation context. - - Value indicating whether the item is installed or null if it is not possible to determine. - - - - - Provides context for install/uninstall operations. - - - - - Mapping between log levels and console output colors. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The log output. - - - - Logs the specified trace message. - - The message. - The arguments. - - - - Logs the specified debug message. - - The message. - The arguments. - - - - Logs the specified informational message. - - The message. - The arguments. - - - - Logs the specified warning message. - - The message. - The arguments. - - - - Logs the specified error message. - - The message. - The arguments. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Creates the log event which can be used to render layouts during installation/uninstallations. - - Log event info object. - - - - Gets or sets the installation log level. - - - - - Gets or sets a value indicating whether to ignore failures during installation. - - - - - Gets the installation parameters. - - - - - Gets or sets the log output. - - - - - Keeps logging configuration and provides simple API - to modify it. - - - - - Variables defined in xml or in API. name is case case insensitive. - - - - - Initializes a new instance of the class. - - - - - Registers the specified target object. The name of the target is read from . - - - The target object with a non - - when is - - - - Registers the specified target object under a given name. - - - Name of the target. - - - The target object. - - - - - Finds the target with the specified name. - - - The name of the target to be found. - - - Found target or when the target is not found. - - - - - Finds the target with the specified name and specified type. - - - The name of the target to be found. - - Type of the target - - Found target or when the target is not found of not of type - - - - - Called by LogManager when one of the log configuration files changes. - - - A new instance of that represents the updated configuration. - - - - - Removes the specified named target. - - - Name of the target. - - - - - Installs target-specific objects on current system. - - The installation context. - - Installation typically runs with administrative permissions. - - - - - Uninstalls target-specific objects from current system. - - The installation context. - - Uninstallation typically runs with administrative permissions. - - - - - Closes all targets and releases any unmanaged resources. - - - - - Log to the internal (NLog) logger the information about the and associated with this instance. - - - The information are only recorded in the internal logger if Debug level is enabled, otherwise nothing is - recorded. - - - - - Flushes any pending log messages on all appenders. - - The asynchronous continuation. - - - - Validates the configuration. - - - - - Use the old exception log handling of NLog 3.0? - - - - - Gets the variables defined in the configuration. - - - - - Gets a collection of named targets specified in the configuration. - - - A list of named targets. - - - Unnamed targets (such as those wrapped by other targets) are not returned. - - - - - Gets the collection of file names which should be watched for changes by NLog. - - - - - Gets the collection of logging rules. - - - - - Gets or sets the default culture info to use as . - - - Specific culture info or null to use - - - - - Gets all targets. - - - - - Arguments for events. - - - - - Initializes a new instance of the class. - - The old configuration. - The new configuration. - - - - Gets the old configuration. - - The old configuration. - - - - Gets the new configuration. - - The new configuration. - - - - Arguments for . - - - - - Initializes a new instance of the class. - - Whether configuration reload has succeeded. - The exception during configuration reload. - - - - Gets a value indicating whether configuration reload has succeeded. - - A value of true if succeeded; otherwise, false. - - - - Gets the exception which occurred during configuration reload. - - The exception. - - - - Represents a logging rule. An equivalent of <logger /> configuration element. - - - - - Create an empty . - - - - - Create a new with a which writes to . - - Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends. - Minimum log level needed to trigger this rule. - Target to be written to when the rule matches. - - - - Create a (disabled) . You should call to enable logging. - - Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends. - Target to be written to when the rule matches. - - - - Enables logging for a particular level. - - Level to be enabled. - - - - Disables logging for a particular level. - - Level to be disabled. - - - - Returns a string representation of . Used for debugging. - - - A that represents the current . - - - - - Checks whether te particular log level is enabled for this rule. - - Level to be checked. - A value of when the log level is enabled, otherwise. - - - - Checks whether given name matches the logger name pattern. - - String to be matched. - A value of when the name matches, otherwise. - - - - Gets a collection of targets that should be written to when this rule matches. - - - - - Gets a collection of child rules to be evaluated when this rule matches. - - - - - Gets a collection of filters to be checked before writing to targets. - - - - - Gets or sets a value indicating whether to quit processing any further rule when this one matches. - - - - - Gets or sets logger name pattern. - - - Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends but not anywhere else. - - - - - Gets the collection of log levels enabled by this rule. - - - - - Factory for locating methods. - - The type of the class marker attribute. - The type of the method marker attribute. - - - - Scans the assembly for classes marked with - and methods marked with and adds them - to the factory. - - The types to scan. - The prefix to use for names. - - - - Registers the type. - - The type to register. - The item name prefix. - - - - Clears contents of the factory. - - - - - Registers the definition of a single method. - - The method name. - The method info. - - - - Tries to retrieve method by name. - - The method name. - The result. - A value of true if the method was found, false otherwise. - - - - Retrieves method by name. - - Method name. - MethodInfo object. - - - - Tries to get method definition. - - The method . - The result. - A value of true if the method was found, false otherwise. - - - - Gets a collection of all registered items in the factory. - - - Sequence of key/value pairs where each key represents the name - of the item and value is the of - the item. - - - - - Indicates NLog should not scan this property during configuration. - - - - - Initializes a new instance of the class. - - - - - Marks the object as configuration item for NLog. - - - - - Initializes a new instance of the class. - - - - - Represents simple XML element with case-insensitive attribute semantics. - - - - - Initializes a new instance of the class. - - The input URI. - - - - Initializes a new instance of the class. - - The reader to initialize element from. - - - - Prevents a default instance of the class from being created. - - - - - Returns children elements with the specified element name. - - Name of the element. - Children elements with the specified element name. - - - - Gets the required attribute. - - Name of the attribute. - Attribute value. - Throws if the attribute is not specified. - - - - Gets the optional boolean attribute value. - - Name of the attribute. - Default value to return if the attribute is not found. - Boolean attribute value or default. - - - - Gets the optional attribute value. - - Name of the attribute. - The default value. - Value of the attribute or default value. - - - - Asserts that the name of the element is among specified element names. - - The allowed names. - - - - Gets the element name. - - - - - Gets the dictionary of attribute values. - - - - - Gets the collection of child elements. - - - - - Gets the value of the element. - - - - - Attribute used to mark the required parameters for targets, - layout targets and filters. - - - - - Provides simple programmatic configuration API used for trivial logging cases. - - - - - Configures NLog for console logging so that all messages above and including - the level are output to the console. - - - - - Configures NLog for console logging so that all messages above and including - the specified level are output to the console. - - The minimal logging level. - - - - Configures NLog for to log to the specified target so that all messages - above and including the level are output. - - The target to log all messages to. - - - - Configures NLog for to log to the specified target so that all messages - above and including the specified level are output. - - The target to log all messages to. - The minimal logging level. - - - - Configures NLog for file logging so that all messages above and including - the level are written to the specified file. - - Log file name. - - - - Configures NLog for file logging so that all messages above and including - the specified level are written to the specified file. - - Log file name. - The minimal logging level. - - - - Value indicating how stack trace should be captured when processing the log event. - - - - - Stack trace should not be captured. - - - - - Stack trace should be captured without source-level information. - - - - - Stack trace should be captured including source-level information such as line numbers. - - - - - Capture maximum amount of the stack trace information supported on the platform. - - - - - Marks the layout or layout renderer as producing correct results regardless of the thread - it's running on. - - - - - A class for configuring NLog through an XML configuration file - (App.config style or App.nlog style). - - - - - Initializes a new instance of the class. - - Configuration file to be read. - - - - Initializes a new instance of the class. - - Configuration file to be read. - Ignore any errors during configuration. - - - - Initializes a new instance of the class. - - containing the configuration section. - Name of the file that contains the element (to be used as a base for including other files). - - - - Initializes a new instance of the class. - - containing the configuration section. - Name of the file that contains the element (to be used as a base for including other files). - Ignore any errors during configuration. - - - - Initializes a new instance of the class. - - The XML element. - Name of the XML file. - - - - Initializes a new instance of the class. - - The XML element. - Name of the XML file. - If set to true errors will be ignored during file processing. - - - - Re-reads the original configuration file and returns the new object. - - The new object. - - - - Remove all spaces, also in between text. - - text - text without spaces - Tabs and other whitespace is not removed! - - - - Remove the namespace (before :) - - - x:a, will be a - - - - - - - Initializes the configuration. - - containing the configuration section. - Name of the file that contains the element (to be used as a base for including other files). - Ignore any errors during configuration. - - - - Parse the root - - - path to directory of config file. - - - - Parse {configuration} xml element. - - - path to directory of config file. - - - - Parse {NLog} xml element. - - - path to directory of config file. - - - - Parse {Rules} xml element - - - Rules are added to this parameter. - - - - Parse {Logger} xml element - - - Rules are added to this parameter. - - - - Replace a simple variable with a value. The orginal value is removed and thus we cannot redo this in a later stage. - - Use for that: - - - - - - - Gets the default object by parsing - the application configuration file (app.exe.config). - - - - - Did the Succeeded? true= success, false= error, null = initialize not started yet. - - - - - Gets or sets a value indicating whether the configuration files - should be watched for changes and reloaded automatically when changed. - - - - - Gets the collection of file names which should be watched for changes by NLog. - This is the list of configuration files processed. - If the autoReload attribute is not set it returns empty collection. - - - - - Matches when the specified condition is met. - - - Conditions are expressed using a simple language - described here. - - - - - An abstract filter class. Provides a way to eliminate log messages - based on properties other than logger name and log level. - - - - - Initializes a new instance of the class. - - - - - Gets the result of evaluating filter against given log event. - - The log event. - Filter result. - - - - Checks whether log event should be logged or not. - - Log event. - - - if the log event should be ignored
- - if the filter doesn't want to decide
- - if the log event should be logged
- .
-
- - - Gets or sets the action to be taken when filter matches. - - - - - - Checks whether log event should be logged or not. - - Log event. - - - if the log event should be ignored
- - if the filter doesn't want to decide
- - if the log event should be logged
- .
-
- - - Gets or sets the condition expression. - - - - - - Marks class as a layout renderer and assigns a name to it. - - - - - Initializes a new instance of the class. - - Name of the filter. - - - - Filter result. - - - - - The filter doesn't want to decide whether to log or discard the message. - - - - - The message should be logged. - - - - - The message should not be logged. - - - - - The message should be logged and processing should be finished. - - - - - The message should not be logged and processing should be finished. - - - - - A base class for filters that are based on comparing a value to a layout. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the layout to be used to filter log messages. - - The layout. - - - - - Matches when the calculated layout contains the specified substring. - This filter is deprecated in favor of <when /> which is based on conditions. - - - - - Checks whether log event should be logged or not. - - Log event. - - - if the log event should be ignored
- - if the filter doesn't want to decide
- - if the log event should be logged
- .
-
- - - Gets or sets a value indicating whether to ignore case when comparing strings. - - - - - - Gets or sets the substring to be matched. - - - - - - Matches when the calculated layout is equal to the specified substring. - This filter is deprecated in favor of <when /> which is based on conditions. - - - - - Checks whether log event should be logged or not. - - Log event. - - - if the log event should be ignored
- - if the filter doesn't want to decide
- - if the log event should be logged
- .
-
- - - Gets or sets a value indicating whether to ignore case when comparing strings. - - - - - - Gets or sets a string to compare the layout to. - - - - - - Matches when the calculated layout does NOT contain the specified substring. - This filter is deprecated in favor of <when /> which is based on conditions. - - - - - Checks whether log event should be logged or not. - - Log event. - - - if the log event should be ignored
- - if the filter doesn't want to decide
- - if the log event should be logged
- .
-
- - - Gets or sets the substring to be matched. - - - - - - Gets or sets a value indicating whether to ignore case when comparing strings. - - - - - - Matches when the calculated layout is NOT equal to the specified substring. - This filter is deprecated in favor of <when /> which is based on conditions. - - - - - Initializes a new instance of the class. - - - - - Checks whether log event should be logged or not. - - Log event. - - - if the log event should be ignored
- - if the filter doesn't want to decide
- - if the log event should be logged
- .
-
- - - Gets or sets a string to compare the layout to. - - - - - - Gets or sets a value indicating whether to ignore case when comparing strings. - - - - - - A fluent class to build log events for NLog. - - - - - Initializes a new instance of the class. - - The to send the log event. - - - - Initializes a new instance of the class. - - The to send the log event. - The for the log event. - - - - Sets the information of the logging event. - - The exception information of the logging event. - - - - - Sets the level of the logging event. - - The level of the logging event. - - - - - Sets the logger name of the logging event. - - The logger name of the logging event. - - - - - Sets the log message on the logging event. - - The log message for the logging event. - - - - - Sets the log message and parameters for formatting on the logging event. - - A composite format string. - The object to format. - - - - - Sets the log message and parameters for formatting on the logging event. - - A composite format string. - The first object to format. - The second object to format. - - - - - Sets the log message and parameters for formatting on the logging event. - - A composite format string. - The first object to format. - The second object to format. - The third object to format. - - - - - Sets the log message and parameters for formatting on the logging event. - - A composite format string. - The first object to format. - The second object to format. - The third object to format. - The fourth object to format. - - - - - Sets the log message and parameters for formatting on the logging event. - - A composite format string. - An object array that contains zero or more objects to format. - - - - - Sets the log message and parameters for formatting on the logging event. - - An object that supplies culture-specific formatting information. - A composite format string. - An object array that contains zero or more objects to format. - - - - - Sets a per-event context property on the logging event. - - The name of the context property. - The value of the context property. - - - - - Sets multiple per-event context properties on the logging event. - - The properties to set. - - - - - Sets the timestamp of the logging event. - - The timestamp of the logging event. - - - - - Sets the stack trace for the event info. - - The stack trace. - Index of the first user stack frame within the stack trace. - - - - - Writes the log event to the underlying logger. - - - - - Writes the log event to the underlying logger. - - If condition is true, write log event; otherwise ignore event. - - - - Writes the log event to the underlying logger. - - If condition is true, write log event; otherwise ignore event. - - - - Gets the created by the builder. - - - - - Extension methods for NLog . - - - - - Starts building a log event with the specified . - - The logger to write the log event to. - The log level. - - - - - Starts building a log event at the Trace level. - - The logger to write the log event to. - - - - - Starts building a log event at the Debug level. - - The logger to write the log event to. - - - - - Starts building a log event at the Info level. - - The logger to write the log event to. - - - - - Starts building a log event at the Warn level. - - The logger to write the log event to. - - - - - Starts building a log event at the Error level. - - The logger to write the log event to. - - - - - Starts building a log event at the Fatal level. - - The logger to write the log event to. - - - - - Global Diagnostics Context - used for log4net compatibility. - - - - - Sets the Global Diagnostics Context item to the specified value. - - Item name. - Item value. - - - - Gets the Global Diagnostics Context named item. - - Item name. - The value of , if defined; otherwise . - - - - Gets the Global Diagnostics Context item. - - Item name. - to use when converting the item's value to a string. - The value of as a string, if defined; otherwise . - - - - Gets the Global Diagnostics Context named item. - - Item name. - The value of , if defined; otherwise null. - - - - Checks whether the specified item exists in the Global Diagnostics Context. - - Item name. - A boolean indicating whether the specified item exists in current thread GDC. - - - - Removes the specified item from the Global Diagnostics Context. - - Item name. - - - - Clears the content of the GDC. - - - - - Global Diagnostics Context - a dictionary structure to hold per-application-instance values. - - - - - Sets the Global Diagnostics Context item to the specified value. - - Item name. - Item value. - - - - Sets the Global Diagnostics Context item to the specified value. - - Item name. - Item value. - - - - Gets the Global Diagnostics Context named item. - - Item name. - The value of , if defined; otherwise . - - - - Gets the Global Diagnostics Context item. - - Item name. - to use when converting the item's value to a string. - The value of as a string, if defined; otherwise . - - - - Gets the Global Diagnostics Context named item. - - Item name. - The item value, if defined; otherwise null. - - - - Checks whether the specified item exists in the Global Diagnostics Context. - - Item name. - A boolean indicating whether the specified item exists in current thread GDC. - - - - Removes the specified item from the Global Diagnostics Context. - - Item name. - - - - Clears the content of the GDC. - - - - - Provides logging interface and utility functions. - - - Auto-generated Logger members for binary compatibility with NLog 1.0. - - - - - Logger with only generic methods (passing 'LogLevel' to methods) and core properties. - - - Auto-generated Logger members for binary compatibility with NLog 1.0. - - - - - Gets a value indicating whether logging is enabled for the specified level. - - Log level to be checked. - A value of if logging is enabled for the specified level, otherwise it returns . - - - - Writes the specified diagnostic message. - - Log event. - - - - Writes the specified diagnostic message. - - The name of the type that wraps Logger. - Log event. - - - - Writes the diagnostic message at the specified level using the specified format provider and format parameters. - - - Writes the diagnostic message at the specified level. - - Type of the value. - The log level. - The value to be written. - - - - Writes the diagnostic message at the specified level. - - Type of the value. - The log level. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the specified level. - - The log level. - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the specified level. - - The log level. - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the specified level. - - The log level. - A to be written. - Arguments to format. - An exception to be logged. - - - - Writes the diagnostic message and exception at the specified level. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - Arguments to format. - An exception to be logged. - - - - Writes the diagnostic message at the specified level using the specified parameters and formatting them with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the specified level. - - The log level. - Log message. - - - - Writes the diagnostic message at the specified level using the specified parameters. - - The log level. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the specified level. - - The log level. - A to be written. - An exception to be logged. - - - - Writes the diagnostic message at the specified level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified parameter. - - The type of the argument. - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the specified level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The log level. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the specified level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the specified level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - The log level. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the specified level. - - The log level. - A to be written. - - - - Writes the diagnostic message at the specified level. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the specified level using the specified parameters. - - The log level. - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the specified level using the specified parameters. - - The log level. - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Occurs when logger configuration changes. - - - - - Gets the name of the logger. - - - - - Gets the factory that created this logger. - - - - - Provides an interface to execute System.Actions without surfacing any exceptions raised for that action. - - - - - Runs action. If the action throws, the exception is logged at Error level. The exception is not propagated outside of this method. - - Action to execute. - - - - Runs the provided function and returns its result. If an exception is thrown, it is logged at Error level. - The exception is not propagated outside of this method; a default value is returned instead. - - Return type of the provided function. - Function to run. - Result returned by the provided function or the default value of type in case of exception. - - - - Runs the provided function and returns its result. If an exception is thrown, it is logged at Error level. - The exception is not propagated outside of this method; a fallback value is returned instead. - - Return type of the provided function. - Function to run. - Fallback value to return in case of exception. - Result returned by the provided function or fallback value in case of exception. - - - - Writes the diagnostic message at the Trace level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Trace level. - - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Trace level. - - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Trace level. - - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Trace level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the Trace level. - - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Trace level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Trace level using the specified parameters and formatting them with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Trace level. - - Log message. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the Trace level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message at the Trace level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified parameter. - - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Trace level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Debug level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Debug level. - - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Debug level. - - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Debug level. - - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Debug level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the Debug level. - - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Debug level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Debug level using the specified parameters and formatting them with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Debug level. - - Log message. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the Debug level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message at the Debug level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified parameter. - - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Debug level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Info level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Info level. - - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Info level. - - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Info level. - - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Info level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the Info level. - - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Info level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Info level using the specified parameters and formatting them with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Info level. - - Log message. - - - - Writes the diagnostic message at the Info level using the specified parameters. - - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the Info level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message at the Info level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified parameter. - - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Info level using the specified parameters. - - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Info level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Info level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Warn level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Warn level. - - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Warn level. - - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Warn level. - - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Warn level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the Warn level. - - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Warn level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Warn level using the specified parameters and formatting them with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Warn level. - - Log message. - - - - Writes the diagnostic message at the Warn level using the specified parameters. - - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the Warn level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message at the Warn level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified parameter. - - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Warn level using the specified parameters. - - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Warn level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Warn level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Error level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Error level. - - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Error level. - - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Error level. - - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Error level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the Error level. - - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Error level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Error level using the specified parameters and formatting them with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Error level. - - Log message. - - - - Writes the diagnostic message at the Error level using the specified parameters. - - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the Error level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message at the Error level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified parameter. - - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Error level using the specified parameters. - - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Error level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Error level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Fatal level. - - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Fatal level. - - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Fatal level. - - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Fatal level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the Fatal level. - - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Fatal level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Fatal level using the specified parameters and formatting them with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Fatal level. - - Log message. - - - - Writes the diagnostic message at the Fatal level using the specified parameters. - - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the Fatal level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message at the Fatal level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified parameter. - - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified parameters. - - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Trace level. - - A to be written. - - - - Writes the diagnostic message at the Trace level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format.s - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level. - - A to be written. - - - - Writes the diagnostic message at the Debug level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level. - - A to be written. - - - - Writes the diagnostic message at the Info level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Info level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Info level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level. - - A to be written. - - - - Writes the diagnostic message at the Warn level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Warn level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Warn level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level. - - A to be written. - - - - Writes the diagnostic message at the Error level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Error level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Error level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level. - - A to be written. - - - - Writes the diagnostic message at the Fatal level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Fatal level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Gets a value indicating whether logging is enabled for the Trace level. - - A value of if logging is enabled for the Trace level, otherwise it returns . - - - - Gets a value indicating whether logging is enabled for the Debug level. - - A value of if logging is enabled for the Debug level, otherwise it returns . - - - - Gets a value indicating whether logging is enabled for the Info level. - - A value of if logging is enabled for the Info level, otherwise it returns . - - - - Gets a value indicating whether logging is enabled for the Warn level. - - A value of if logging is enabled for the Warn level, otherwise it returns . - - - - Gets a value indicating whether logging is enabled for the Error level. - - A value of if logging is enabled for the Error level, otherwise it returns . - - - - Gets a value indicating whether logging is enabled for the Fatal level. - - A value of if logging is enabled for the Fatal level, otherwise it returns . - - - - Various helper methods for accessing state of ASP application. - - - - - Internal configuration manager used to read .NET configuration files. - Just a wrapper around the BCL ConfigurationManager, but used to enable - unit testing. - - - - - Interface for the wrapper around System.Configuration.ConfigurationManager. - - - - - Gets the wrapper around ConfigurationManager.AppSettings. - - - - - Gets the wrapper around ConfigurationManager.AppSettings. - - - - - Provides untyped IDictionary interface on top of generic IDictionary. - - The type of the key. - The type of the value. - - - - Initializes a new instance of the DictionaryAdapter class. - - The implementation. - - - - Adds an element with the provided key and value to the object. - - The to use as the key of the element to add. - The to use as the value of the element to add. - - - - Removes all elements from the object. - - - - - Determines whether the object contains an element with the specified key. - - The key to locate in the object. - - True if the contains an element with the key; otherwise, false. - - - - - Returns an object for the object. - - - An object for the object. - - - - - Removes the element with the specified key from the object. - - The key of the element to remove. - - - - Copies the elements of the to an , starting at a particular index. - - The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing. - The zero-based index in at which copying begins. - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Gets an object containing the values in the object. - - - - An object containing the values in the object. - - - - - Gets the number of elements contained in the . - - - - The number of elements contained in the . - - - - - Gets a value indicating whether access to the is synchronized (thread safe). - - - true if access to the is synchronized (thread safe); otherwise, false. - - - - - Gets an object that can be used to synchronize access to the . - - - - An object that can be used to synchronize access to the . - - - - - Gets a value indicating whether the object has a fixed size. - - - true if the object has a fixed size; otherwise, false. - - - - - Gets a value indicating whether the object is read-only. - - - true if the object is read-only; otherwise, false. - - - - - Gets an object containing the keys of the object. - - - - An object containing the keys of the object. - - - - - Gets or sets the with the specified key. - - Dictionary key. - Value corresponding to key or null if not found - - - - Wrapper IDictionaryEnumerator. - - - - - Initializes a new instance of the class. - - The wrapped. - - - - Advances the enumerator to the next element of the collection. - - - True if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - - - - Sets the enumerator to its initial position, which is before the first element in the collection. - - - - - Gets both the key and the value of the current dictionary entry. - - - - A containing both the key and the value of the current dictionary entry. - - - - - Gets the key of the current dictionary entry. - - - - The key of the current element of the enumeration. - - - - - Gets the value of the current dictionary entry. - - - - The value of the current element of the enumeration. - - - - - Gets the current element in the collection. - - - - The current element in the collection. - - - - - UTF-8 BOM 239, 187, 191 - - - - - Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. A parameter specifies whether the operation is case-sensitive. The return value indicates whether the conversion succeeded. - - The enumeration type to which to convert value. - The string representation of the enumeration name or underlying value to convert. - When this method returns, result contains an object of type TEnum whose value is represented by value if the parse operation succeeds. If the parse operation fails, result contains the default value of the underlying type of TEnum. Note that this value need not be a member of the TEnum enumeration. This parameter is passed uninitialized. - true if the value parameter was converted successfully; otherwise, false. - Wrapper because Enum.TryParse is not present in .net 3.5 - - - - Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. A parameter specifies whether the operation is case-sensitive. The return value indicates whether the conversion succeeded. - - The enumeration type to which to convert value. - The string representation of the enumeration name or underlying value to convert. - true to ignore case; false to consider case. - When this method returns, result contains an object of type TEnum whose value is represented by value if the parse operation succeeds. If the parse operation fails, result contains the default value of the underlying type of TEnum. Note that this value need not be a member of the TEnum enumeration. This parameter is passed uninitialized. - true if the value parameter was converted successfully; otherwise, false. - Wrapper because Enum.TryParse is not present in .net 3.5 - - - - Enum.TryParse implementation for .net 3.5 - - - - Don't uses reflection - - - - IsNullOrWhiteSpace for .net 3.5 - - - - - - - Safe way to get environment variables. - - - - - Helper class for dealing with exceptions. - - - - - Determines whether the exception must be rethrown. - - The exception. - True if the exception must be rethrown, false otherwise. - - - - Object construction helper. - - - - - Adapter for to - - - - - Interface for fakeable the current . Not fully implemented, please methods/properties as necessary. - - - - - Gets or sets the base directory that the assembly resolver uses to probe for assemblies. - - - - - Gets or sets the name of the configuration file for an application domain. - - - - - Gets or sets the list of directories under the application base directory that are probed for private assemblies. - - - - - Gets or set the friendly name. - - - - - Gets an integer that uniquely identifies the application domain within the process. - - - - - Process exit event. - - - - - Domain unloaded event. - - - - - Initializes a new instance of the class. - - The to wrap. - - - - Gets a the current wrappered in a . - - - - - Gets or sets the base directory that the assembly resolver uses to probe for assemblies. - - - - - Gets or sets the name of the configuration file for an application domain. - - - - - Gets or sets the list of directories under the application base directory that are probed for private assemblies. - - - - - Gets or set the friendly name. - - - - - Gets an integer that uniquely identifies the application domain within the process. - - - - - Process exit event. - - - - - Domain unloaded event. - - - - - Base class for optimized file appenders. - - - - - Initializes a new instance of the class. - - Name of the file. - The create parameters. - - - - Writes the specified bytes. - - The bytes. - - - - Flushes this instance. - - - - - Closes this instance. - - - - - Gets the file info. - - The last file write time. The value must be of UTC kind. - Length of the file in bytes. - True if the operation succeeded, false otherwise. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Releases unmanaged and - optionally - managed resources. - - True to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Records the last write time for a file. - - - - - Records the last write time for a file to be specific date. - - Date and time when the last write occurred. The value must be of UTC kind. - - - - Creates the file stream. - - If set to true sets the file stream to allow shared writing. - A object which can be used to write to the file. - - - - Gets the path of the file, including file extension. - - The name of the file. - - - - Gets the last write time. - - The last write time. DateTime value must be of UTC kind. - - - - Gets the open time of the file. - - The open time. DateTime value must be of UTC kind. - - - - Gets the file creation parameters. - - The file creation parameters. - - - - Implementation of which caches - file information. - - - - - Initializes a new instance of the class. - - Name of the file. - The parameters. - - - - Closes this instance of the appender. - - - - - Flushes this current appender. - - - - - Gets the file info. - - The last file write time. The value must be of UTC kind. - Length of the file. - True if the operation succeeded, false otherwise. - - - - Writes the specified bytes to a file. - - The bytes to be written. - - - - Factory class which creates objects. - - - - - Interface implemented by all factories capable of creating file appenders. - - - - - Opens the appender for given file name and parameters. - - Name of the file. - Creation parameters. - Instance of which can be used to write to the file. - - - - Opens the appender for given file name and parameters. - - Name of the file. - Creation parameters. - - Instance of which can be used to write to the file. - - - - - Maintains a collection of file appenders usually associated with file targets. - - - - - Initializes a new "empty" instance of the class with zero size and empty - list of appenders. - - - - - Initializes a new "empty" instance of the class with zero size and empty - list of appenders. - - - - - Initializes a new instance of the class. - - - The size of the list should be positive. No validations are performed during initialisation as it is an - intenal class. - - Total number of appenders allowed in list. - Factory used to create each appender. - Parameters used for creating a file. - - - - It allocates the first slot in the list when the file name does not already in the list and clean up any - unused slots. - - File name associated with a single appender. - The allocated appender. - - Thrown when is called on an Empty instance. - - - - - Close all the allocated appenders. - - - - - Close the allocated appenders initialised before the supplied time. - - The time which prior the appenders considered expired - - - - Fluch all the allocated appenders. - - - - - Gets the file info for a particular appender. - - The file name associated with a particular appender. - The last file write time. The value must be of UTC kind. - Length of the file. - when the operation succeeded; otherwise. - - - - Closes the specified appender and removes it from the list. - - File name of the appender to be closed. - - - - Gets the parameters which will be used for creating a file. - - - - - Gets the file appender factory used by all the appenders in this list. - - - - - Gets the number of appenders which the list can hold. - - - - - Interface that provides parameters for create file function. - - - - - Gets or sets the delay in milliseconds to wait before attempting to write to the file again. - - - - - Gets or sets the number of times the write is appended on the file before NLog - discards the log message. - - - - - Gets or sets a value indicating whether concurrent writes to the log file by multiple processes on the same host. - - - This makes multi-process logging possible. NLog uses a special technique - that lets it keep the files open for writing. - - - - - Gets or sets a value indicating whether to create directories if they do not exist. - - - Setting this to false may improve performance a bit, but you'll receive an error - when attempting to write to a directory that's not present. - - - - - Gets or sets a value indicating whether to enable log file(s) to be deleted. - - - - - Gets or sets the log file buffer size in bytes. - - - - - Gets or set a value indicating whether a managed file stream is forced, instead of used the native implementation. - - - - - Gets or sets the file attributes (Windows only). - - - - - Provides a multiprocess-safe atomic file appends while - keeping the files open. - - - On Unix you can get all the appends to be atomic, even when multiple - processes are trying to write to the same file, because setting the file - pointer to the end of the file and appending can be made one operation. - On Win32 we need to maintain some synchronization between processes - (global named mutex is used for this) - - - - - Initializes a new instance of the class. - - Name of the file. - The parameters. - - - - Writes the specified bytes. - - The bytes to be written. - - - - Closes this instance. - - - - - Flushes this instance. - - - - - Gets the file info. - - The last file write time. The value must be of UTC kind. - Length of the file. - - True if the operation succeeded, false otherwise. - - - - - Factory class. - - - - - Opens the appender for given file name and parameters. - - Name of the file. - Creation parameters. - - Instance of which can be used to write to the file. - - - - - Multi-process and multi-host file appender which attempts - to get exclusive write access and retries if it's not available. - - - - - Initializes a new instance of the class. - - Name of the file. - The parameters. - - - - Writes the specified bytes. - - The bytes. - - - - Flushes this instance. - - - - - Closes this instance. - - - - - Gets the file info. - - The last file write time. The value must be of UTC kind. - Length of the file. - - True if the operation succeeded, false otherwise. - - - - - Factory class. - - - - - Opens the appender for given file name and parameters. - - Name of the file. - Creation parameters. - - Instance of which can be used to write to the file. - - - - - Optimized single-process file appender which keeps the file open for exclusive write. - - - - - Initializes a new instance of the class. - - Name of the file. - The parameters. - - - - Writes the specified bytes. - - The bytes. - - - - Flushes this instance. - - - - - Closes this instance. - - - - - Gets the file info. - - The last file write time. The value must be of UTC kind. - Length of the file. - - True if the operation succeeded, false otherwise. - - - - - Factory class. - - - - - Opens the appender for given file name and parameters. - - Name of the file. - Creation parameters. - - Instance of which can be used to write to the file. - - - - - Optimized routines to get the size and last write time of the specified file. - - - - - Initializes static members of the FileInfoHelper class. - - - - - Gets the information about a file. - - Name of the file. - The file handle. - The last write time of the file in UTC. - Length of the file. - A value of true if file information was retrieved successfully, false otherwise. - - - - toString(format) if the object is a - - value to be converted - format value - provider, for example culture - - - - - Interface implemented by layouts and layout renderers. - - - - - Renders the the value of layout or layout renderer in the context of the specified log event. - - The log event. - String representation of a layout. - - - - Supports mocking of SMTP Client code. - - - - - Sends an e-mail message to an SMTP server for delivery. These methods block while the message is being transmitted. - - - System.Net.Mail.MailMessage - MailMessage - A MailMessage that contains the message to send. - - - - Specifies how outgoing email messages will be handled. - - - - - Gets or sets the name or IP address of the host used for SMTP transactions. - - - - - Gets or sets the port used for SMTP transactions. - - - - - Gets or sets a value that specifies the amount of time after which a synchronous Send call times out. - - - - - Gets or sets the credentials used to authenticate the sender. - - - - - Gets or sets the folder where applications save mail messages to be processed by the local SMTP server. - - - - - Supports object initialization and termination. - - - - - Initializes this instance. - - The configuration. - - - - Closes this instance. - - - - - Allows components to request stack trace information to be provided in the . - - - - - Gets the level of stack trace information required by the implementing class. - - - - - Logger configuration. - - - - - Initializes a new instance of the class. - - The targets by level. - Use the old exception log handling of NLog 3.0? - - - - - Gets targets for the specified level. - - The level. - Chain of targets with attached filters. - - - - Determines whether the specified level is enabled. - - The level. - - A value of true if the specified level is enabled; otherwise, false. - - - - - Use the old exception log handling of NLog 3.0? - - - - - Watches multiple files at the same time and raises an event whenever - a single change is detected in any of those files. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Stops the watching. - - - - - Watches the specified files for changes. - - The file names. - - - - Occurs when a change is detected in one of the monitored files. - - - - - Supports mocking of SMTP Client code. - - - - - Network sender which uses HTTP or HTTPS POST. - - - - - A base class for all network senders. Supports one-way sending of messages - over various protocols. - - - - - Initializes a new instance of the class. - - The network URL. - - - - Finalizes an instance of the NetworkSender class. - - - - - Initializes this network sender. - - - - - Closes the sender and releases any unmanaged resources. - - The continuation. - - - - Flushes any pending messages and invokes a continuation. - - The continuation. - - - - Send the given text over the specified protocol. - - Bytes to be sent. - Offset in buffer. - Number of bytes to send. - The asynchronous continuation. - - - - Closes the sender and releases any unmanaged resources. - - - - - Performs sender-specific initialization. - - - - - Performs sender-specific close operation. - - The continuation. - - - - Performs sender-specific flush. - - The continuation. - - - - Actually sends the given text over the specified protocol. - - The bytes to be sent. - Offset in buffer. - Number of bytes to send. - The async continuation to be invoked after the buffer has been sent. - To be overridden in inheriting classes. - - - - Parses the URI into an endpoint address. - - The URI to parse. - The address family. - Parsed endpoint. - - - - Gets the address of the network endpoint. - - - - - Gets the last send time. - - - - - Initializes a new instance of the class. - - The network URL. - - - - Actually sends the given text over the specified protocol. - - The bytes to be sent. - Offset in buffer. - Number of bytes to send. - The async continuation to be invoked after the buffer has been sent. - To be overridden in inheriting classes. - - - - Creates instances of objects for given URLs. - - - - - Creates a new instance of the network sender based on a network URL. - - - URL that determines the network sender to be created. - - - The maximum queue size. - - - A newly created network sender. - - - - - Interface for mocking socket calls. - - - - - Default implementation of . - - - - - Creates a new instance of the network sender based on a network URL:. - - - URL that determines the network sender to be created. - - - The maximum queue size. - - /// - A newly created network sender. - - - - - Socket proxy for mocking Socket code. - - - - - Initializes a new instance of the class. - - The address family. - Type of the socket. - Type of the protocol. - - - - Closes the wrapped socket. - - - - - Invokes ConnectAsync method on the wrapped socket. - - The instance containing the event data. - Result of original method. - - - - Invokes SendAsync method on the wrapped socket. - - The instance containing the event data. - Result of original method. - - - - Invokes SendToAsync method on the wrapped socket. - - The instance containing the event data. - Result of original method. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Gets underlying socket instance. - - - - - Sends messages over a TCP network connection. - - - - - Initializes a new instance of the class. - - URL. Must start with tcp://. - The address family. - - - - Creates the socket with given parameters. - - The address family. - Type of the socket. - Type of the protocol. - Instance of which represents the socket. - - - - Performs sender-specific initialization. - - - - - Closes the socket. - - The continuation. - - - - Performs sender-specific flush. - - The continuation. - - - - Sends the specified text over the connected socket. - - The bytes to be sent. - Offset in buffer. - Number of bytes to send. - The async continuation to be invoked after the buffer has been sent. - To be overridden in inheriting classes. - - - - Facilitates mocking of class. - - - - - Raises the Completed event. - - - - - Sends messages over the network as UDP datagrams. - - - - - Initializes a new instance of the class. - - URL. Must start with udp://. - The address family. - - - - Creates the socket. - - The address family. - Type of the socket. - Type of the protocol. - Implementation of to use. - - - - Performs sender-specific initialization. - - - - - Closes the socket. - - The continuation. - - - - Sends the specified text as a UDP datagram. - - The bytes to be sent. - Offset in buffer. - Number of bytes to send. - The async continuation to be invoked after the buffer has been sent. - To be overridden in inheriting classes. - - - - Scans (breadth-first) the object graph following all the edges whose are - instances have attached and returns - all objects implementing a specified interfaces. - - - - - Finds the objects which have attached which are reachable - from any of the given root objects when traversing the object graph over public properties. - - Type of the objects to return. - The root objects. - Ordered list of objects implementing T. - - - - Parameter validation utilities. - - - - - Asserts that the value is not null and throws otherwise. - - The value to check. - Name of the parameter. - - - - Detects the platform the NLog is running on. - - - - - Gets the current runtime OS. - - - - - Gets a value indicating whether current OS is a desktop version of Windows. - - - - - Gets a value indicating whether current OS is Win32-based (desktop or mobile). - - - - - Gets a value indicating whether current OS is Unix-based. - - - - - Portable implementation of . - - - - - Gets the information about a file. - - Name of the file. - The file handle. - The last write time of the file in UTC. - Length of the file. - - A value of true if file information was retrieved successfully, false otherwise. - - - - - Portable implementation of . - - - - - Returns details about current process and thread in a portable manner. - - - - - Initializes static members of the ThreadIDHelper class. - - - - - Gets the singleton instance of PortableThreadIDHelper or - Win32ThreadIDHelper depending on runtime environment. - - The instance. - - - - Gets current process ID. - - - - - Gets current process name. - - - - - Gets current process name (excluding filename extension, if any). - - - - - Initializes a new instance of the class. - - - - - Gets the name of the process. - - - - - Gets current process ID. - - - - - - Gets current process name. - - - - - - Gets current process name (excluding filename extension, if any). - - - - - - Reflection helpers for accessing properties. - - - - - Reflection helpers. - - - - - Gets all usable exported types from the given assembly. - - Assembly to scan. - Usable types from the given assembly. - Types which cannot be loaded are skipped. - - - - Is this a static class? - - - - This is a work around, as Type doesn't have this property. - From: http://stackoverflow.com/questions/1175888/determine-if-a-type-is-static - - - - - Supported operating systems. - - - If you add anything here, make sure to add the appropriate detection - code to - - - - - Any operating system. - - - - - Unix/Linux operating systems. - - - - - Windows CE. - - - - - Desktop versions of Windows (95,98,ME). - - - - - Windows NT, 2000, 2003 and future versions based on NT technology. - - - - - Unknown operating system. - - - - - Simple character tokenizer. - - - - - Initializes a new instance of the class. - - The text to be tokenized. - - - - Check current char while not changing the position. - - - - - - Read the current char and change position - - - - - - Get the substring of the - - - - - - - - Current position in - - - - - Full text to be parsed - - - - - Implements a single-call guard around given continuation function. - - - - - Initializes a new instance of the class. - - The asynchronous continuation. - - - - Continuation function which implements the single-call guard. - - The exception. - - - - Provides helpers to sort log events and associated continuations. - - - - - Performs bucket sort (group by) on an array of items and returns a dictionary for easy traversal of the result set. - - The type of the value. - The type of the key. - The inputs. - The key selector function. - - Dictionary where keys are unique input keys, and values are lists of . - - - - - Key selector delegate. - - The type of the value. - The type of the key. - Value to extract key information from. - Key selected from log event. - - - - Utilities for dealing with values. - - - - - Stream helpers - - - - - Copy stream input to output. Skip the first bytes - - stream to read from - stream to write to - first bytes to skip (optional) - - - - Represents target with a chain of filters which determine - whether logging should happen. - - - - - Initializes a new instance of the class. - - The target. - The filter chain. - - - - Gets the stack trace usage. - - A value that determines stack trace handling. - - - - Gets the target. - - The target. - - - - Gets the filter chain. - - The filter chain. - - - - Gets or sets the next item in the chain. - - The next item in the chain. - - - - Helper for dealing with thread-local storage. - - - - - Allocates the data slot for storing thread-local information. - - Allocated slot key. - - - - Gets the data for a slot in thread-local storage. - - Type of the data. - The slot to get data for. - - Slot data (will create T if null). - - - - - Wraps with a timeout. - - - - - Initializes a new instance of the class. - - The asynchronous continuation. - The timeout. - - - - Continuation function which implements the timeout logic. - - The exception. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - URL Encoding helper. - - - - - Win32-optimized implementation of . - - - - - Gets the information about a file. - - Name of the file. - The file handle. - The last write time of the file in UTC. - Length of the file. - - A value of true if file information was retrieved successfully, false otherwise. - - - - - Win32-optimized implementation of . - - - - - Initializes a new instance of the class. - - - - - Gets current process ID. - - - - - - Gets current process name. - - - - - - Gets current process name (excluding filename extension, if any). - - - - - - Helper class for XML - - - - - removes any unusual unicode characters that can't be encoded into XML - - - - - Safe version of WriteAttributeString - - - - - - - - - - Safe version of WriteAttributeString - - - - - - - - Safe version of WriteElementSafeString - - - - - - - - - - Safe version of WriteCData - - - - - - - Log event context data. - - - - - Render environmental information related to logging events. - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Renders the the value of layout renderer in the context of the specified log event. - - The log event. - String representation of a layout renderer. - - - - Initializes this instance. - - The configuration. - - - - Closes this instance. - - - - - Initializes this instance. - - The configuration. - - - - Closes this instance. - - - - - Renders the specified environmental information and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Initializes the layout renderer. - - - - - Closes the layout renderer. - - - - - Releases unmanaged and - optionally - managed resources. - - True to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Gets the logging configuration this target is part of. - - - - - Initializes a new instance of the class. - - - - - Renders all log event's properties and appends them to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets string that will be used to separate key/value pairs. - - - - - - Gets or sets how key/value pairs will be formatted. - - - - - - Designates a property of the class as an ambient property. - - - - - Initializes a new instance of the class. - - Ambient property name. - - - - Used to render the application domain name. - - - - - Create a new renderer - - - - - Create a new renderer - - - - - Render the layout - - - - - - - Convert the formatting string - - - - - - - Format string. Possible values: "Short", "Long" or custom like {0} {1}. Default "Long" - The first parameter is the , the second the second the - This string is used in - - - - - ASP Application variable. - - - - - Renders the specified ASP Application variable and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the ASP Application variable name. - - - - - - ASP Request variable. - - - - - Renders the specified ASP Request variable and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the item name. The QueryString, Form, Cookies, or ServerVariables collection variables having the specified name are rendered. - - - - - - Gets or sets the QueryString variable to be rendered. - - - - - - Gets or sets the form variable to be rendered. - - - - - - Gets or sets the cookie to be rendered. - - - - - - Gets or sets the ServerVariables item to be rendered. - - - - - - ASP Session variable. - - - - - Renders the specified ASP Session variable and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the session variable name. - - - - - - Assembly version. - - - - - Renders assembly version and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - The current application domain's base directory. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Renders the application base directory and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the name of the file to be Path.Combine()'d with with the base directory. - - - - - - Gets or sets the name of the directory to be Path.Combine()'d with with the base directory. - - - - - - The call site (class name, method name and source information). - - - - - Initializes a new instance of the class. - - - - - Renders the call site and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets a value indicating whether to render the class name. - - - - - - Gets or sets a value indicating whether to render the method name. - - - - - - Gets or sets a value indicating whether the method name will be cleaned up if it is detected as an anonymous delegate. - - - - - - Gets or sets the number of frames to skip. - - - - - Gets or sets a value indicating whether to render the source file name and line number. - - - - - - Gets or sets a value indicating whether to include source file path. - - - - - - Gets the level of stack trace information required by the implementing class. - - - - - The call site source line number. Full callsite - - - - - Renders the call site and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the number of frames to skip. - - - - - Gets the level of stack trace information required by the implementing class. - - - - - A counter value (increases on each layout rendering). - - - - - Initializes a new instance of the class. - - - - - Renders the specified counter value and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the initial value of the counter. - - - - - - Gets or sets the value to be added to the counter after each layout rendering. - - - - - - Gets or sets the name of the sequence. Different named sequences can have individual values. - - - - - - Current date and time. - - - - - Initializes a new instance of the class. - - - - - Renders the current date and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the culture used for rendering. - - - - - - Gets or sets the date format. Can be any argument accepted by DateTime.ToString(format). - - - - - - Gets or sets a value indicating whether to output UTC time instead of local time. - - - - - - The environment variable. - - - - - Renders the specified environment variable and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the name of the environment variable. - - - - - - Gets or sets the default value to be used when the environment variable is not set. - - - - - - Log event context data. - - - - - Renders the specified log event context item and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the name of the item. - - - - - - Log event context data. See . - - - - - Log event context data with default options. - - - - - Renders the specified log event context item and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the name of the item. - - - - - - Format string for conversion from object to string. - - - - - Gets or sets the culture used for rendering. - - - - - - Exception information provided through - a call to one of the Logger.*Exception() methods. - - - - - Initializes a new instance of the class. - - - - - Renders the specified exception information and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Appends the Message of an Exception to the specified . - - The to append the rendered data to. - The exception containing the Message to append. - - - - Appends the method name from Exception's stack trace to the specified . - - The to append the rendered data to. - The Exception whose method name should be appended. - - - - Appends the stack trace from an Exception to the specified . - - The to append the rendered data to. - The Exception whose stack trace should be appended. - - - - Appends the result of calling ToString() on an Exception to the specified . - - The to append the rendered data to. - The Exception whose call to ToString() should be appended. - - - - Appends the type of an Exception to the specified . - - The to append the rendered data to. - The Exception whose type should be appended. - - - - Appends the short type of an Exception to the specified . - - The to append the rendered data to. - The Exception whose short type should be appended. - - - - Appends the contents of an Exception's Data property to the specified . - - The to append the rendered data to. - The Exception whose Data property elements should be appended. - - - - Gets or sets the format of the output. Must be a comma-separated list of exception - properties: Message, Type, ShortType, ToString, Method, StackTrace. - This parameter value is case-insensitive. - - - - - - Gets or sets the format of the output of inner exceptions. Must be a comma-separated list of exception - properties: Message, Type, ShortType, ToString, Method, StackTrace. - This parameter value is case-insensitive. - - - - - - Gets or sets the separator used to concatenate parts specified in the Format. - - - - - - Gets or sets the maximum number of inner exceptions to include in the output. - By default inner exceptions are not enabled for compatibility with NLog 1.0. - - - - - - Gets or sets the separator between inner exceptions. - - - - - - Renders contents of the specified file. - - - - - Initializes a new instance of the class. - - - - - Renders the contents of the specified file and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the name of the file. - - - - - - Gets or sets the encoding used in the file. - - The encoding. - - - - - The information about the garbage collector. - - - - - Initializes a new instance of the class. - - - - - Renders the selected process information. - - The to append the rendered data to. - Logging event. - - - - Gets or sets the property to retrieve. - - - - - - Gets or sets the property of System.GC to retrieve. - - - - - Total memory allocated. - - - - - Total memory allocated (perform full garbage collection first). - - - - - Gets the number of Gen0 collections. - - - - - Gets the number of Gen1 collections. - - - - - Gets the number of Gen2 collections. - - - - - Maximum generation number supported by GC. - - - - - Global Diagnostics Context item. Provided for compatibility with log4net. - - - - - Renders the specified Global Diagnostics Context item and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the name of the item. - - - - - - Globally-unique identifier (GUID). - - - - - Initializes a new instance of the class. - - - - - Renders a newly generated GUID string and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the GUID format as accepted by Guid.ToString() method. - - - - - - Thread identity information (name and authentication information). - - - - - Initializes a new instance of the class. - - - - - Renders the specified identity information and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the separator to be used when concatenating - parts of identity information. - - - - - - Gets or sets a value indicating whether to render Thread.CurrentPrincipal.Identity.Name. - - - - - - Gets or sets a value indicating whether to render Thread.CurrentPrincipal.Identity.AuthenticationType. - - - - - - Gets or sets a value indicating whether to render Thread.CurrentPrincipal.Identity.IsAuthenticated. - - - - - - Installation parameter (passed to InstallNLogConfig). - - - - - Renders the specified installation parameter and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the name of the parameter. - - - - - - Marks class as a layout renderer and assigns a format string to it. - - - - - Initializes a new instance of the class. - - Name of the layout renderer. - - - - The log level. - - - - - Renders the current log level and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - A string literal. - - - This is used to escape '${' sequence - as ;${literal:text=${}' - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The literal text value. - This is used by the layout compiler. - - - - Renders the specified string literal and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the literal text. - - - - - - XML event description compatible with log4j, Chainsaw and NLogViewer. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Renders the XML logging event and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets a value indicating whether to include NLog-specific extensions to log4j schema. - - - - - - Gets or sets a value indicating whether the XML should use spaces for indentation. - - - - - - Gets or sets the AppInfo field. By default it's the friendly name of the current AppDomain. - - - - - - Gets or sets a value indicating whether to include call site (class and method name) in the information sent over the network. - - - - - - Gets or sets a value indicating whether to include source info (file name and line number) in the information sent over the network. - - - - - - Gets or sets a value indicating whether to include contents of the dictionary. - - - - - - Gets or sets a value indicating whether to include contents of the stack. - - - - - - Gets or sets the NDC item separator. - - - - - - Gets the level of stack trace information required by the implementing class. - - - - - The logger name. - - - - - Renders the logger name and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets a value indicating whether to render short logger name (the part after the trailing dot character). - - - - - - The date and time in a long, sortable format yyyy-MM-dd HH:mm:ss.mmm. - - - - - Renders the date in the long format (yyyy-MM-dd HH:mm:ss.mmm) and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets a value indicating whether to output UTC time instead of local time. - - - - - - The machine name that the process is running on. - - - - - Initializes the layout renderer. - - - - - Renders the machine name and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Mapped Diagnostic Context item. Provided for compatibility with log4net. - - - - - Renders the specified MDC item and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the name of the item. - - - - - - Mapped Diagnostic Logical Context item (based on CallContext). - - - - - Renders the specified MDLC item and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the name of the item. - - - - - - The formatted log message. - - - - - Initializes a new instance of the class. - - - - - Renders the log message including any positional parameters and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets a value indicating whether to log exception along with message. - - - - - - Gets or sets the string that separates message from the exception. - - - - - - Nested Diagnostic Context item. Provided for compatibility with log4net. - - - - - Initializes a new instance of the class. - - - - - Renders the specified Nested Diagnostics Context item and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the number of top stack frames to be rendered. - - - - - - Gets or sets the number of bottom stack frames to be rendered. - - - - - - Gets or sets the separator to be used for concatenating nested diagnostics context output. - - - - - - A newline literal. - - - - - Renders the specified string literal and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - The directory where NLog.dll is located. - - - - - Initializes static members of the NLogDirLayoutRenderer class. - - - - - Renders the directory where NLog is located and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the name of the file to be Path.Combine()'d with the directory name. - - - - - - Gets or sets the name of the directory to be Path.Combine()'d with the directory name. - - - - - - The performance counter. - - - - - Initializes the layout renderer. - - - - - Closes the layout renderer. - - - - - Renders the specified environment variable and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the name of the counter category. - - - - - - Gets or sets the name of the performance counter. - - - - - - Gets or sets the name of the performance counter instance (e.g. this.Global_). - - - - - - Gets or sets the name of the machine to read the performance counter from. - - - - - - The identifier of the current process. - - - - - Renders the current process ID. - - The to append the rendered data to. - Logging event. - - - - The information about the running process. - - - - - Initializes a new instance of the class. - - - - - Initializes the layout renderer. - - - - - Closes the layout renderer. - - - - - Renders the selected process information. - - The to append the rendered data to. - Logging event. - - - - Gets or sets the property to retrieve. - - - - - - Property of System.Diagnostics.Process to retrieve. - - - - - Base Priority. - - - - - Exit Code. - - - - - Exit Time. - - - - - Process Handle. - - - - - Handle Count. - - - - - Whether process has exited. - - - - - Process ID. - - - - - Machine name. - - - - - Handle of the main window. - - - - - Title of the main window. - - - - - Maximum Working Set. - - - - - Minimum Working Set. - - - - - Non-paged System Memory Size. - - - - - Non-paged System Memory Size (64-bit). - - - - - Paged Memory Size. - - - - - Paged Memory Size (64-bit).. - - - - - Paged System Memory Size. - - - - - Paged System Memory Size (64-bit). - - - - - Peak Paged Memory Size. - - - - - Peak Paged Memory Size (64-bit). - - - - - Peak Virtual Memory Size. - - - - - Peak Virtual Memory Size (64-bit).. - - - - - Peak Working Set Size. - - - - - Peak Working Set Size (64-bit). - - - - - Whether priority boost is enabled. - - - - - Priority Class. - - - - - Private Memory Size. - - - - - Private Memory Size (64-bit). - - - - - Privileged Processor Time. - - - - - Process Name. - - - - - Whether process is responding. - - - - - Session ID. - - - - - Process Start Time. - - - - - Total Processor Time. - - - - - User Processor Time. - - - - - Virtual Memory Size. - - - - - Virtual Memory Size (64-bit). - - - - - Working Set Size. - - - - - Working Set Size (64-bit). - - - - - The name of the current process. - - - - - Renders the current process name (optionally with a full path). - - The to append the rendered data to. - Logging event. - - - - Gets or sets a value indicating whether to write the full path to the process executable. - - - - - - The process time in format HH:mm:ss.mmm. - - - - - Renders the current process running time and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - High precision timer, based on the value returned from QueryPerformanceCounter() optionally converted to seconds. - - - - - Initializes a new instance of the class. - - - - - Initializes the layout renderer. - - - - - Renders the ticks value of current time and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets a value indicating whether to normalize the result by subtracting - it from the result of the first call (so that it's effectively zero-based). - - - - - - Gets or sets a value indicating whether to output the difference between the result - of QueryPerformanceCounter and the previous one. - - - - - - Gets or sets a value indicating whether to convert the result to seconds by dividing - by the result of QueryPerformanceFrequency(). - - - - - - Gets or sets the number of decimal digits to be included in output. - - - - - - Gets or sets a value indicating whether to align decimal point (emit non-significant zeros). - - - - - - A value from the Registry. - - - - - Reads the specified registry key and value and appends it to - the passed . - - The to append the rendered data to. - Logging event. Ignored. - - - - Gets or sets the registry value name. - - - - - - Gets or sets the value to be output when the specified registry key or value is not found. - - - - - - Gets or sets the registry key. - - - Must have one of the forms: -
    -
  • HKLM\Key\Full\Name
  • -
  • HKEY_LOCAL_MACHINE\Key\Full\Name
  • -
  • HKCU\Key\Full\Name
  • -
  • HKEY_CURRENT_USER\Key\Full\Name
  • -
-
- -
- - - The short date in a sortable format yyyy-MM-dd. - - - - - Renders the current short date string (yyyy-MM-dd) and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets a value indicating whether to output UTC time instead of local time. - - - - - - System special folder path (includes My Documents, My Music, Program Files, Desktop, and more). - - - - - Renders the directory where NLog is located and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the system special folder to use. - - - Full list of options is available at MSDN. - The most common ones are: -
    -
  • ApplicationData - roaming application data for current user.
  • -
  • CommonApplicationData - application data for all users.
  • -
  • MyDocuments - My Documents
  • -
  • DesktopDirectory - Desktop directory
  • -
  • LocalApplicationData - non roaming application data
  • -
  • Personal - user profile directory
  • -
  • System - System directory
  • -
-
- -
- - - Gets or sets the name of the file to be Path.Combine()'d with the directory name. - - - - - - Gets or sets the name of the directory to be Path.Combine()'d with the directory name. - - - - - - Format of the ${stacktrace} layout renderer output. - - - - - Raw format (multiline - as returned by StackFrame.ToString() method). - - - - - Flat format (class and method names displayed in a single line). - - - - - Detailed flat format (method signatures displayed in a single line). - - - - - Stack trace renderer. - - - - - Initializes a new instance of the class. - - - - - Renders the call site and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the output format of the stack trace. - - - - - - Gets or sets the number of top stack frames to be rendered. - - - - - - Gets or sets the number of frames to skip. - - - - - - Gets or sets the stack frame separator string. - - - - - - Gets the level of stack trace information required by the implementing class. - - - - - - A temporary directory. - - - - - Renders the directory where NLog is located and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the name of the file to be Path.Combine()'d with the directory name. - - - - - - Gets or sets the name of the directory to be Path.Combine()'d with the directory name. - - - - - - The identifier of the current thread. - - - - - Renders the current thread identifier and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - The name of the current thread. - - - - - Renders the current thread name and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - The Ticks value of current date and time. - - - - - Renders the ticks value of current time and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - The time in a 24-hour, sortable format HH:mm:ss.mmm. - - - - - Renders time in the 24-h format (HH:mm:ss.mmm) and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets a value indicating whether to output UTC time instead of local time. - - - - - - A renderer that puts into log a System.Diagnostics trace correlation id. - - - - - Renders the current trace activity ID. - - The to append the rendered data to. - Logging event. - - - - Render a NLog variable (xml or config) - - - - - Renders the specified variable and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets the name of the NLog variable. - - - - - - Gets or sets the default value to be used when the variable is not set. - - Not used if Name is null - - - - - Thread Windows identity information (username). - - - - - Initializes a new instance of the class. - - - - - Renders the current thread windows identity information and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Gets or sets a value indicating whether domain name should be included. - - - - - - Gets or sets a value indicating whether username should be included. - - - - - - Applies caching to another layout output. - - - The value of the inner layout will be rendered only once and reused subsequently. - - - - - Decodes text "encrypted" with ROT-13. - - - See http://en.wikipedia.org/wiki/ROT13. - - - - - Renders the inner message, processes it and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Transforms the output of another layout. - - Output to be transform. - Transformed text. - - - - Renders the inner layout contents. - - The log event. - Contents of inner layout. - - - - Gets or sets the wrapped layout. - - - - - - Initializes a new instance of the class. - - - - - Initializes the layout renderer. - - - - - Closes the layout renderer. - - - - - Transforms the output of another layout. - - Output to be transform. - Transformed text. - - - - Renders the inner layout contents. - - The log event. - Contents of inner layout. - - - - Gets or sets a value indicating whether this is enabled. - - - - - - Gets or sets a value indicating when the cache is cleared. - - - - - A value indicating when the cache is cleared. - - - - Never clear the cache. - - - Clear the cache whenever the is initialized. - - - Clear the cache whenever the is closed. - - - - Filters characters not allowed in the file names by replacing them with safe character. - - - - - Initializes a new instance of the class. - - - - - Post-processes the rendered message. - - The text to be post-processed. - Padded and trimmed string. - - - - Gets or sets a value indicating whether to modify the output of this renderer so it can be used as a part of file path - (illegal characters are replaced with '_'). - - - - - - Escapes output of another layout using JSON rules. - - - - - Initializes a new instance of the class. - - - - - Post-processes the rendered message. - - The text to be post-processed. - JSON-encoded string. - - - - Gets or sets a value indicating whether to apply JSON encoding. - - - - - - Converts the result of another layout output to lower case. - - - - - Initializes a new instance of the class. - - - - - Post-processes the rendered message. - - The text to be post-processed. - Padded and trimmed string. - - - - Gets or sets a value indicating whether lower case conversion should be applied. - - A value of true if lower case conversion should be applied; otherwise, false. - - - - - Gets or sets the culture used for rendering. - - - - - - Only outputs the inner layout when exception has been defined for log message. - - - - - Transforms the output of another layout. - - Output to be transform. - Transformed text. - - - - Renders the inner layout contents. - - The log event. - - Contents of inner layout. - - - - - Horizontal alignment for padding layout renderers. - - - - - When layout text is too long, align it to the left - (remove characters from the right). - - - - - When layout text is too long, align it to the right - (remove characters from the left). - - - - - Applies padding to another layout output. - - - - - Initializes a new instance of the class. - - - - - Transforms the output of another layout. - - Output to be transform. - Transformed text. - - - - Gets or sets the number of characters to pad the output to. - - - Positive padding values cause left padding, negative values - cause right padding to the desired width. - - - - - - Gets or sets the padding character. - - - - - - Gets or sets a value indicating whether to trim the - rendered text to the absolute value of the padding length. - - - - - - Gets or sets a value indicating whether a value that has - been truncated (when is true) - will be left-aligned (characters removed from the right) - or right-aligned (characters removed from the left). The - default is left alignment. - - - - - Replaces a string in the output of another layout with another string. - - - - - Initializes the layout renderer. - - - - - Post-processes the rendered message. - - The text to be post-processed. - Post-processed text. - - - - A match evaluator for Regular Expression based replacing - - - - - - - - - - Gets or sets the text to search for. - - The text search for. - - - - - Gets or sets a value indicating whether regular expressions should be used. - - A value of true if regular expressions should be used otherwise, false. - - - - - Gets or sets the replacement string. - - The replacement string. - - - - - Gets or sets the group name to replace when using regular expressions. - Leave null or empty to replace without using group name. - - The group name. - - - - - Gets or sets a value indicating whether to ignore case. - - A value of true if case should be ignored when searching; otherwise, false. - - - - - Gets or sets a value indicating whether to search for whole words. - - A value of true if whole words should be searched for; otherwise, false. - - - - - This class was created instead of simply using a lambda expression so that the "ThreadAgnosticAttributeTest" will pass - - - - - Replaces newline characters from the result of another layout renderer with spaces. - - - - - Initializes a new instance of the class. - - - - - Post-processes the rendered message. - - The text to be post-processed. - String with newline characters replaced with spaces. - - - - Gets or sets a value indicating the string that should be used for separating lines. - - - - - Decodes text "encrypted" with ROT-13. - - - See http://en.wikipedia.org/wiki/ROT13. - - - - - Encodes/Decodes ROT-13-encoded string. - - The string to be encoded/decoded. - Encoded/Decoded text. - - - - Transforms the output of another layout. - - Output to be transform. - Transformed text. - - - - Gets or sets the layout to be wrapped. - - The layout to be wrapped. - This variable is for backwards compatibility - - - - - Trims the whitespace from the result of another layout renderer. - - - - - Initializes a new instance of the class. - - - - - Post-processes the rendered message. - - The text to be post-processed. - Trimmed string. - - - - Gets or sets a value indicating whether lower case conversion should be applied. - - A value of true if lower case conversion should be applied; otherwise, false. - - - - - Converts the result of another layout output to upper case. - - - - - Initializes a new instance of the class. - - - - - Post-processes the rendered message. - - The text to be post-processed. - Padded and trimmed string. - - - - Gets or sets a value indicating whether upper case conversion should be applied. - - A value of true if upper case conversion should be applied otherwise, false. - - - - - Gets or sets the culture used for rendering. - - - - - - Encodes the result of another layout output for use with URLs. - - - - - Initializes a new instance of the class. - - - - - Transforms the output of another layout. - - Output to be transform. - Transformed text. - - - - Gets or sets a value indicating whether spaces should be translated to '+' or '%20'. - - A value of true if space should be translated to '+'; otherwise, false. - - - - - Outputs alternative layout when the inner layout produces empty result. - - - - - Transforms the output of another layout. - - Output to be transform. - Transformed text. - - - - Renders the inner layout contents. - - The log event. - - Contents of inner layout. - - - - - Gets or sets the layout to be rendered when original layout produced empty result. - - - - - - Only outputs the inner layout when the specified condition has been met. - - - - - Transforms the output of another layout. - - Output to be transform. - Transformed text. - - - - Renders the inner layout contents. - - The log event. - - Contents of inner layout. - - - - - Gets or sets the condition that must be met for the inner layout to be printed. - - - - - - Converts the result of another layout output to be XML-compliant. - - - - - Initializes a new instance of the class. - - - - - Post-processes the rendered message. - - The text to be post-processed. - Padded and trimmed string. - - - - Gets or sets a value indicating whether to apply XML encoding. - - - - - - A column in the CSV. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The name of the column. - The layout of the column. - - - - Gets or sets the name of the column. - - - - - - Gets or sets the layout of the column. - - - - - - Specifies allowed column delimiters. - - - - - Automatically detect from regional settings. - - - - - Comma (ASCII 44). - - - - - Semicolon (ASCII 59). - - - - - Tab character (ASCII 9). - - - - - Pipe character (ASCII 124). - - - - - Space character (ASCII 32). - - - - - Custom string, specified by the CustomDelimiter. - - - - - A specialized layout that renders CSV-formatted events. - - - - - A specialized layout that supports header and footer. - - - - - Abstract interface that layouts must implement. - - - - - Converts a given text to a . - - Text to be converted. - object represented by the text. - - - - Implicitly converts the specified string to a . - - The layout string. - Instance of . - - - - Implicitly converts the specified string to a . - - The layout string. - The NLog factories to use when resolving layout renderers. - Instance of . - - - - Precalculates the layout for the specified log event and stores the result - in per-log event cache. - - The log event. - - Calling this method enables you to store the log event in a buffer - and/or potentially evaluate it in another thread even though the - layout may contain thread-dependent renderer. - - - - - Renders the event info in layout. - - The event info. - String representing log event. - - - - Initializes this instance. - - The configuration. - - - - Closes this instance. - - - - - Initializes this instance. - - The configuration. - - - - Closes this instance. - - - - - Initializes the layout. - - - - - Closes the layout. - - - - - Renders the layout for the specified logging event by invoking layout renderers. - - The logging event. - The rendered layout. - - - - Gets a value indicating whether this layout is thread-agnostic (can be rendered on any thread). - - - Layout is thread-agnostic if it has been marked with [ThreadAgnostic] attribute and all its children are - like that as well. - Thread-agnostic layouts only use contents of for its output. - - - - - Gets the logging configuration this target is part of. - - - - - Renders the layout for the specified logging event by invoking layout renderers. - - The logging event. - The rendered layout. - - - - Gets or sets the body layout (can be repeated multiple times). - - - - - - Gets or sets the header layout. - - - - - - Gets or sets the footer layout. - - - - - - Initializes a new instance of the class. - - - - - Initializes the layout. - - - - - Formats the log event for write. - - The log event to be formatted. - A string representation of the log event. - - - - Gets the array of parameters to be passed. - - - - - - Gets or sets a value indicating whether CVS should include header. - - A value of true if CVS should include header; otherwise, false. - - - - - Gets or sets the column delimiter. - - - - - - Gets or sets the quoting mode. - - - - - - Gets or sets the quote Character. - - - - - - Gets or sets the custom column delimiter value (valid when ColumnDelimiter is set to 'Custom'). - - - - - - Header for CSV layout. - - - - - Initializes a new instance of the class. - - The parent. - - - - Renders the layout for the specified logging event by invoking layout renderers. - - The logging event. - The rendered layout. - - - - Specifies CSV quoting modes. - - - - - Quote all column. - - - - - Quote nothing. - - - - - Quote only whose values contain the quote symbol or - the separator. - - - - - JSON attribute. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The name of the attribute. - The layout of the attribute's value. - - - - Initializes a new instance of the class. - - The name of the attribute. - The layout of the attribute's value. - Encode value with json-encode - - - - Gets or sets the name of the attribute. - - - - - Gets or sets the layout that will be rendered as the attribute's value. - - - - - Determines wether or not this attribute will be Json encoded. - - - - - A specialized layout that renders JSON-formatted events. - - - - - Initializes a new instance of the class. - - - - - Formats the log event as a JSON document for writing. - - The log event to be formatted. - A JSON string representation of the log event. - - - - Gets the array of attributes' configurations. - - - - - - Gets or sets the option to suppress the extra spaces in the output json - - - - - Marks class as a layout renderer and assigns a format string to it. - - - - - Initializes a new instance of the class. - - Layout name. - - - - Parses layout strings. - - - - - A specialized layout that renders Log4j-compatible XML events. - - - This layout is not meant to be used explicitly. Instead you can use ${log4jxmlevent} layout renderer. - - - - - Initializes a new instance of the class. - - - - - Renders the layout for the specified logging event by invoking layout renderers. - - The logging event. - The rendered layout. - - - - Gets the instance that renders log events. - - - - - Represents a string with embedded placeholders that can render contextual information. - - - This layout is not meant to be used explicitly. Instead you can just use a string containing layout - renderers everywhere the layout is required. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The layout string to parse. - - - - Initializes a new instance of the class. - - The layout string to parse. - The NLog factories to use when creating references to layout renderers. - - - - Converts a text to a simple layout. - - Text to be converted. - A object. - - - - Escapes the passed text so that it can - be used literally in all places where - layout is normally expected without being - treated as layout. - - The text to be escaped. - The escaped text. - - Escaping is done by replacing all occurrences of - '${' with '${literal:text=${}' - - - - - Evaluates the specified text by expanding all layout renderers. - - The text to be evaluated. - Log event to be used for evaluation. - The input text with all occurrences of ${} replaced with - values provided by the appropriate layout renderers. - - - - Evaluates the specified text by expanding all layout renderers - in new context. - - The text to be evaluated. - The input text with all occurrences of ${} replaced with - values provided by the appropriate layout renderers. - - - - Returns a that represents the current object. - - - A that represents the current object. - - - - - Renders the layout for the specified logging event by invoking layout renderers - that make up the event. - - The logging event. - The rendered layout. - - - - Original text before compile to Layout renderes - - - - - Gets or sets the layout text. - - - - - - Is the message fixed? (no Layout renderers used) - - - - - Get the fixed text. Only set when is true - - - - - Gets a collection of objects that make up this layout. - - - - - Represents the logging event. - - - - - Gets the date of the first log event created. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Log level. - Logger name. - Log message including parameter placeholders. - - - - Initializes a new instance of the class. - - Log level. - Logger name. - An IFormatProvider that supplies culture-specific formatting information. - Log message including parameter placeholders. - Parameter array. - - - - Initializes a new instance of the class. - - Log level. - Logger name. - An IFormatProvider that supplies culture-specific formatting information. - Log message including parameter placeholders. - Parameter array. - Exception information. - - - - Creates the null event. - - Null log event. - - - - Creates the log event. - - The log level. - Name of the logger. - The message. - Instance of . - - - - Creates the log event. - - The log level. - Name of the logger. - The format provider. - The message. - The parameters. - Instance of . - - - - Creates the log event. - - The log level. - Name of the logger. - The format provider. - The message. - Instance of . - - - - Creates the log event. - - The log level. - Name of the logger. - The message. - The exception. - Instance of . - - - - Creates the log event. - - The log level. - Name of the logger. - The exception. - The format provider. - The message. - Instance of . - - - - Creates the log event. - - The log level. - Name of the logger. - The exception. - The format provider. - The message. - The parameters. - Instance of . - - - - Creates from this by attaching the specified asynchronous continuation. - - The asynchronous continuation. - Instance of with attached continuation. - - - - Returns a string representation of this log event. - - String representation of the log event. - - - - Sets the stack trace for the event info. - - The stack trace. - Index of the first user stack frame within the stack trace. - - - - Gets the unique identifier of log event which is automatically generated - and monotonously increasing. - - - - - Gets or sets the timestamp of the logging event. - - - - - Gets or sets the level of the logging event. - - - - - Gets a value indicating whether stack trace has been set for this event. - - - - - Gets the stack frame of the method that did the logging. - - - - - Gets the number index of the stack frame that represents the user - code (not the NLog code). - - - - - Gets the entire stack trace. - - - - - Gets or sets the exception information. - - - - - Gets or sets the logger name. - - - - - Gets the logger short name. - - - - - Gets or sets the log message including any parameter placeholders. - - - - - Gets or sets the parameter values or null if no parameters have been specified. - - - - - Gets or sets the format provider that was provided while logging or - when no formatProvider was specified. - - - - - Gets the formatted message. - - - - - Gets the dictionary of per-event context properties. - - - - - Gets the dictionary of per-event context properties. - - - - - Creates and manages instances of objects. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The config. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting - unmanaged resources. - - - - - Creates a logger that discards all log messages. - - Null logger instance. - - - - Gets the logger with the name of the current class. - - The logger. - This is a slow-running method. - Make sure you're not doing this in a loop. - - - - Gets a custom logger with the name of the current class. Use to pass the type of the needed Logger. - - The type of the logger to create. The type must inherit from - NLog.Logger. - The logger of type . - This is a slow-running method. Make sure you are not calling this method in a - loop. - - - - Gets the specified named logger. - - Name of the logger. - The logger reference. Multiple calls to GetLogger with the same argument - are not guaranteed to return the same logger reference. - - - - Gets the specified named logger. Use to pass the type of the needed Logger. - - Name of the logger. - The type of the logger to create. The type must inherit from . - The logger of type . Multiple calls to GetLogger with the - same argument aren't guaranteed to return the same logger reference. - - - - Loops through all loggers previously returned by GetLogger and recalculates their - target and filter list. Useful after modifying the configuration programmatically - to ensure that all loggers have been properly configured. - - - - - Flush any pending log messages (in case of asynchronous targets). - - - - - Flush any pending log messages (in case of asynchronous targets). - - Maximum time to allow for the flush. Any messages after that time - will be discarded. - - - - Flush any pending log messages (in case of asynchronous targets). - - Maximum time to allow for the flush. Any messages - after that time will be discarded. - - - - Flush any pending log messages (in case of asynchronous targets). - - The asynchronous continuation. - - - - Flush any pending log messages (in case of asynchronous targets). - - The asynchronous continuation. - Maximum time to allow for the flush. Any messages - after that time will be discarded. - - - - Flush any pending log messages (in case of asynchronous targets). - - The asynchronous continuation. - Maximum time to allow for the flush. Any messages after that time will be discarded. - - - - Decreases the log enable counter and if it reaches -1 the logs are disabled. - - - Logging is enabled if the number of calls is greater than - or equal to calls. - - An object that implements IDisposable whose Dispose() method re-enables logging. - To be used with C# using () statement. - - - - Increases the log enable counter and if it reaches 0 the logs are disabled. - - - Logging is enabled if the number of calls is greater than - or equal to calls. - - - - Decreases the log enable counter and if it reaches -1 the logs are disabled. - - - Logging is enabled if the number of calls is greater than - or equal to calls. - - An object that implements IDisposable whose Dispose() method re-enables logging. - To be used with C# using () statement. - - - - Increases the log enable counter and if it reaches 0 the logs are disabled. - - Logging is enabled if the number of calls is greater - than or equal to calls. - - - - Returns if logging is currently enabled. - - A value of if logging is currently enabled, - otherwise. - Logging is enabled if the number of calls is greater - than or equal to calls. - - - - Invoke the Changed event; called whenever list changes - - Event arguments. - - - - Releases unmanaged and - optionally - managed resources. - - True to release both managed and unmanaged resources; - false to release only unmanaged resources. - - - - Currenty this logfactory is disposing? - - - - - Occurs when logging changes. - - - - - Occurs when logging gets reloaded. - - - - - Gets the current . - - - - - Gets or sets a value indicating whether exceptions should be thrown. - - A value of true if exception should be thrown; otherwise, false. - By default exceptions are not thrown under any circumstances. - - - - Gets or sets the current logging configuration. After setting this property all - existing loggers will be re-configured, so that there is no need to call - manually. - - - - - Gets or sets the global log threshold. Log events below this threshold are not logged. - - - - - Gets the default culture info to use as . - - - Specific culture info or null to use - - - - - Logger cache key. - - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - - Determines if two objects are equal in value. - - Other object to compare to. - True if objects are equal, false otherwise. - - - - Determines if two objects of the same type are equal in value. - - Other object to compare to. - True if objects are equal, false otherwise. - - - - Logger cache. - - - - - Inserts or updates. - - - - - - - Enables logging in implementation. - - - - - Initializes a new instance of the class. - - The factory. - - - - Enables logging. - - - - - Specialized LogFactory that can return instances of custom logger types. - - The type of the logger to be returned. Must inherit from . - - - - Gets the logger with type . - - The logger name. - An instance of . - - - - Gets a custom logger with the name of the current class and type . - - An instance of . - This is a slow-running method. - Make sure you're not doing this in a loop. - - - - Provides logging interface and utility functions. - - - Provides logging interface and utility functions. - - - Logging methods which only are executed when the DEBUG conditional compilation symbol is set. - - - The DEBUG conditional compilation symbol is default enabled (only) in a debug build. - - If the DEBUG conditional compilation symbol isn't set in the calling library, the compiler will remove all the invocations to these methods. - This could lead to better performance. - - See: https://msdn.microsoft.com/en-us/library/4xssyw96%28v=vs.90%29.aspx - - - Auto-generated Logger members for binary compatibility with NLog 1.0. - - - - - Initializes a new instance of the class. - - - - - Gets a value indicating whether logging is enabled for the specified level. - - Log level to be checked. - A value of if logging is enabled for the specified level, otherwise it returns . - - - - Writes the specified diagnostic message. - - Log event. - - - - Writes the specified diagnostic message. - - The name of the type that wraps Logger. - Log event. - - - - Writes the diagnostic message at the specified level using the specified format provider and format parameters. - - - Writes the diagnostic message at the specified level. - - Type of the value. - The log level. - The value to be written. - - - - Writes the diagnostic message at the specified level. - - Type of the value. - The log level. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the specified level. - - The log level. - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the specified level. - - The log level. - A to be written. - An exception to be logged. - - - - Writes the diagnostic message at the specified level using the specified parameters and formatting them with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the specified level. - - The log level. - Log message. - - - - Writes the diagnostic message at the specified level using the specified parameters. - - The log level. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the specified level. - - The log level. - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the specified level. - - The log level. - A to be written. - Arguments to format. - An exception to be logged. - - - - Writes the diagnostic message and exception at the specified level. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - Arguments to format. - An exception to be logged. - - - - Writes the diagnostic message at the specified level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified parameter. - - The type of the argument. - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the specified level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The log level. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the specified level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the specified level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - The log level. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Runs action. If the action throws, the exception is logged at Error level. The exception is not propagated outside of this method. - - Action to execute. - - - - Runs the provided function and returns its result. If an exception is thrown, it is logged at Error level. - The exception is not propagated outside of this method; a default value is returned instead. - - Return type of the provided function. - Function to run. - Result returned by the provided function or the default value of type in case of exception. - - - - Runs the provided function and returns its result. If an exception is thrown, it is logged at Error level. - The exception is not propagated outside of this method; a fallback value is returned instead. - - Return type of the provided function. - Function to run. - Fallback value to return in case of exception. - Result returned by the provided function or fallback value in case of exception. - - - - Writes the diagnostic message at the Trace level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Trace level. - - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Trace level. - - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Trace level. - - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Trace level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message at the Trace level using the specified parameters and formatting them with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Trace level. - - Log message. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the Trace level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the Trace level. - - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Trace level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Trace level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified parameter. - - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Trace level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Debug level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Debug level. - - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Debug level. - - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Debug level. - - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Debug level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message at the Debug level using the specified parameters and formatting them with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Debug level. - - Log message. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the Debug level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the Debug level. - - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Debug level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Debug level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified parameter. - - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Debug level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Info level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Info level. - - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Info level. - - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Info level. - - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Info level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message at the Info level using the specified parameters and formatting them with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Info level. - - Log message. - - - - Writes the diagnostic message at the Info level using the specified parameters. - - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the Info level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the Info level. - - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Info level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Info level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified parameter. - - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Info level using the specified parameters. - - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Info level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Info level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Warn level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Warn level. - - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Warn level. - - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Warn level. - - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Warn level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message at the Warn level using the specified parameters and formatting them with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Warn level. - - Log message. - - - - Writes the diagnostic message at the Warn level using the specified parameters. - - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the Warn level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the Warn level. - - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Warn level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Warn level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified parameter. - - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Warn level using the specified parameters. - - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Warn level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Warn level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Error level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Error level. - - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Error level. - - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Error level. - - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Error level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message at the Error level using the specified parameters and formatting them with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Error level. - - Log message. - - - - Writes the diagnostic message at the Error level using the specified parameters. - - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the Error level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the Error level. - - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Error level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Error level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified parameter. - - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Error level using the specified parameters. - - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Error level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Error level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Fatal level. - - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Fatal level. - - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Fatal level. - - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Fatal level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message at the Fatal level using the specified parameters and formatting them with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Fatal level. - - Log message. - - - - Writes the diagnostic message at the Fatal level using the specified parameters. - - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the Fatal level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the Fatal level. - - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Fatal level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Fatal level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified parameter. - - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified parameters. - - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Debug level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Debug level. - Only executed when the DEBUG conditional compilation symbol is set. - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Debug level. - Only executed when the DEBUG conditional compilation symbol is set. - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Debug level. - Only executed when the DEBUG conditional compilation symbol is set. - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Debug level. - Only executed when the DEBUG conditional compilation symbol is set. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Debug level. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Debug level using the specified parameters and formatting them with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Debug level. - Only executed when the DEBUG conditional compilation symbol is set. - Log message. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - Only executed when the DEBUG conditional compilation symbol is set. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Debug level using the specified parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified parameter. - Only executed when the DEBUG conditional compilation symbol is set. - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified arguments formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - Only executed when the DEBUG conditional compilation symbol is set. - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Debug level using the specified arguments formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - Only executed when the DEBUG conditional compilation symbol is set. - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Debug level. - Only executed when the DEBUG conditional compilation symbol is set. - A to be written. - - - - Writes the diagnostic message at the Debug level. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - Only executed when the DEBUG conditional compilation symbol is set. - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - Only executed when the DEBUG conditional compilation symbol is set. - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Trace level. - Only executed when the DEBUG conditional compilation symbol is set. - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Trace level. - Only executed when the DEBUG conditional compilation symbol is set. - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Trace level. - Only executed when the DEBUG conditional compilation symbol is set. - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Trace level. - Only executed when the DEBUG conditional compilation symbol is set. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Trace level. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Trace level using the specified parameters and formatting them with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Trace level. - Only executed when the DEBUG conditional compilation symbol is set. - Log message. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - Only executed when the DEBUG conditional compilation symbol is set. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Trace level using the specified parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified parameter. - Only executed when the DEBUG conditional compilation symbol is set. - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified arguments formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - Only executed when the DEBUG conditional compilation symbol is set. - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Trace level using the specified arguments formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - Only executed when the DEBUG conditional compilation symbol is set. - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Trace level. - Only executed when the DEBUG conditional compilation symbol is set. - A to be written. - - - - Writes the diagnostic message at the Trace level. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - Only executed when the DEBUG conditional compilation symbol is set. - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - Only executed when the DEBUG conditional compilation symbol is set. - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level. - - The log level. - A to be written. - - - - Writes the diagnostic message at the specified level. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the specified level using the specified parameters. - - The log level. - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the specified level using the specified parameters. - - The log level. - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level. - - A to be written. - - - - Writes the diagnostic message at the Trace level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level. - - A to be written. - - - - Writes the diagnostic message at the Debug level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level. - - A to be written. - - - - Writes the diagnostic message at the Info level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Info level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Info level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level. - - A to be written. - - - - Writes the diagnostic message at the Warn level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Warn level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Warn level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level. - - A to be written. - - - - Writes the diagnostic message at the Error level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Error level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Error level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level. - - A to be written. - - - - Writes the diagnostic message at the Fatal level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Fatal level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Occurs when logger configuration changes. - - - - - Gets the name of the logger. - - - - - Gets the factory that created this logger. - - - - - Gets a value indicating whether logging is enabled for the Trace level. - - A value of if logging is enabled for the Trace level, otherwise it returns . - - - - Gets a value indicating whether logging is enabled for the Debug level. - - A value of if logging is enabled for the Debug level, otherwise it returns . - - - - Gets a value indicating whether logging is enabled for the Info level. - - A value of if logging is enabled for the Info level, otherwise it returns . - - - - Gets a value indicating whether logging is enabled for the Warn level. - - A value of if logging is enabled for the Warn level, otherwise it returns . - - - - Gets a value indicating whether logging is enabled for the Error level. - - A value of if logging is enabled for the Error level, otherwise it returns . - - - - Gets a value indicating whether logging is enabled for the Fatal level. - - A value of if logging is enabled for the Fatal level, otherwise it returns . - - - - Implementation of logging engine. - - - - - Finds first user stack frame in a stack trace - - The stack trace of the logging method invocation - Type of the logger or logger wrapper - Index of the first user stack frame or 0 if all stack frames are non-user - - - - - Defines whether a stack frame belongs to non-user code - - Method of the stack frame - Type of the logger or logger wrapper - , if the method is from non-user code and should be skipped - - The method is classified as non-user if its declaring assembly is from hidden assemblies list - or its declaring type is or one of its subtypes. - - - - - Gets the filter result. - - The filter chain. - The log event. - The result of the filter. - - - - Defines available log levels. - - - - - Trace log level. - - - - - Debug log level. - - - - - Info log level. - - - - - Warn log level. - - - - - Error log level. - - - - - Fatal log level. - - - - - Off log level. - - - - - Initializes a new instance of . - - The log level name. - The log level ordinal number. - - - - Compares two objects - and returns a value indicating whether - the first one is equal to the second one. - - The first level. - The second level. - The value of level1.Ordinal == level2.Ordinal. - - - - Compares two objects - and returns a value indicating whether - the first one is not equal to the second one. - - The first level. - The second level. - The value of level1.Ordinal != level2.Ordinal. - - - - Compares two objects - and returns a value indicating whether - the first one is greater than the second one. - - The first level. - The second level. - The value of level1.Ordinal > level2.Ordinal. - - - - Compares two objects - and returns a value indicating whether - the first one is greater than or equal to the second one. - - The first level. - The second level. - The value of level1.Ordinal >= level2.Ordinal. - - - - Compares two objects - and returns a value indicating whether - the first one is less than the second one. - - The first level. - The second level. - The value of level1.Ordinal < level2.Ordinal. - - - - Compares two objects - and returns a value indicating whether - the first one is less than or equal to the second one. - - The first level. - The second level. - The value of level1.Ordinal <= level2.Ordinal. - - - - Gets the that corresponds to the specified ordinal. - - The ordinal. - The instance. For 0 it returns , 1 gives and so on. - - - - Returns the that corresponds to the supplied . - - The textual representation of the log level. - The enumeration value. - - - - Returns a string representation of the log level. - - Log level name. - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - Value of true if the specified is equal to - this instance; otherwise, false. - - - - Determines whether the specified instance is equal to this instance. - - The to compare with this instance. - Value of true if the specified is equal to - this instance; otherwise, false. - - - - Compares the level to the other object. - - - The object object. - - - A value less than zero when this logger's is - less than the other logger's ordinal, 0 when they are equal and - greater than zero when this ordinal is greater than the - other ordinal. - - - - - Gets the name of the log level. - - - - - Gets the ordinal of the log level. - - - - - Creates and manages instances of objects. - - - - - Initializes static members of the LogManager class. - - - - - Prevents a default instance of the LogManager class from being created. - - - - - Gets the logger with the name of the current class. - - The logger. - This is a slow-running method. - Make sure you're not doing this in a loop. - - - - Adds the given assembly which will be skipped - when NLog is trying to find the calling method on stack trace. - - The assembly to skip. - - - - Gets a custom logger with the name of the current class. Use to pass the type of the needed Logger. - - The logger class. The class must inherit from . - The logger of type . - This is a slow-running method. - Make sure you're not doing this in a loop. - - - - Creates a logger that discards all log messages. - - Null logger which discards all log messages. - - - - Gets the specified named logger. - - Name of the logger. - The logger reference. Multiple calls to GetLogger with the same argument aren't guaranteed to return the same logger reference. - - - - Gets the specified named custom logger. Use to pass the type of the needed Logger. - - Name of the logger. - The logger class. The class must inherit from . - The logger of type . Multiple calls to GetLogger with the same argument aren't guaranteed to return the same logger reference. - The generic way for this method is - - - - Loops through all loggers previously returned by GetLogger. - and recalculates their target and filter list. Useful after modifying the configuration programmatically - to ensure that all loggers have been properly configured. - - - - - Flush any pending log messages (in case of asynchronous targets). - - - - - Flush any pending log messages (in case of asynchronous targets). - - Maximum time to allow for the flush. Any messages after that time will be discarded. - - - - Flush any pending log messages (in case of asynchronous targets). - - Maximum time to allow for the flush. Any messages after that time will be discarded. - - - - Flush any pending log messages (in case of asynchronous targets). - - The asynchronous continuation. - - - - Flush any pending log messages (in case of asynchronous targets). - - The asynchronous continuation. - Maximum time to allow for the flush. Any messages after that time will be discarded. - - - - Flush any pending log messages (in case of asynchronous targets). - - The asynchronous continuation. - Maximum time to allow for the flush. Any messages after that time will be discarded. - - - - Decreases the log enable counter and if it reaches -1 the logs are disabled. - - Logging is enabled if the number of calls is greater - than or equal to calls. - An object that implements IDisposable whose Dispose() method reenables logging. - To be used with C# using () statement. - - - - Increases the log enable counter and if it reaches 0 the logs are disabled. - - Logging is enabled if the number of calls is greater - than or equal to calls. - - - - Checks if logging is currently enabled. - - if logging is currently enabled, - otherwise. - Logging is enabled if the number of calls is greater - than or equal to calls. - - - - Dispose all targets, and shutdown logging. - - - - - Gets the fully qualified name of the class invoking the LogManager, including the - namespace but not the assembly. - - - - - Occurs when logging changes. - - - - - Occurs when logging gets reloaded. - - - - - Gets or sets a value indicating whether NLog should throw exceptions. - By default exceptions are not thrown under any circumstances. - - - - - Gets or sets the current logging configuration. - - - - - - Gets or sets the global log threshold. Log events below this threshold are not logged. - - - - - Gets or sets the default culture to use. - - - - - Delegate used to set/get the culture in use. - - - - - Returns a log message. Used to defer calculation of - the log message until it's actually needed. - - Log message. - - - - Base implementation of a log receiver server which forwards received logs through or a given . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The log factory. - - - - Processes the log messages. - - The events to process. - - - - Processes the log messages. - - The log events. - - - - Service contract for Log Receiver client. - - - - - Begins processing of log messages. - - The events. - The callback. - Asynchronous state. - - IAsyncResult value which can be passed to . - - - - - Ends asynchronous processing of log messages. - - The result. - - - - Service contract for Log Receiver client. - - - - - Begins processing of log messages. - - The events. - The callback. - Asynchronous state. - - IAsyncResult value which can be passed to . - - - - - Ends asynchronous processing of log messages. - - The result. - - - - Service contract for Log Receiver server. - - - - - Processes the log messages. - - The events. - - - - Service contract for Log Receiver server. - - - - - Processes the log messages. - - The events. - - - - Service contract for Log Receiver client. - - - - - Begins processing of log messages. - - The events. - The callback. - Asynchronous state. - - IAsyncResult value which can be passed to . - - - - - Ends asynchronous processing of log messages. - - The result. - - - - Client of - - - - - Opens the client asynchronously. - - - - - Opens the client asynchronously. - - User-specific state. - - - - Closes the client asynchronously. - - - - - Closes the client asynchronously. - - User-specific state. - - - - Processes the log messages asynchronously. - - The events to send. - - - - Processes the log messages asynchronously. - - The events to send. - User-specific state. - - - - Begins processing of log messages. - - The events to send. - The callback. - Asynchronous state. - - IAsyncResult value which can be passed to . - - - - - Ends asynchronous processing of log messages. - - The result. - - - - Instructs the inner channel to display a user interface if one is required to initialize the channel prior to using it. - - - - - Occurs when the log message processing has completed. - - - - - Occurs when Open operation has completed. - - - - - Occurs when Close operation has completed. - - - - - Enables the user to configure client and service credentials as well as service credential authentication settings for use on the client side of communication. - - - - - Gets the underlying implementation. - - - - - Gets the target endpoint for the service to which the WCF client can connect. - - - - - Implementation of which forwards received logs through or a given . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The log factory. - - - - Implementation of which forwards received logs through or a given . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The log factory. - - - - Internal configuration of Log Receiver Service contracts. - - - - - Wire format for NLog Event. - - - - - Initializes a new instance of the class. - - - - - Converts the to . - - The object this is part of.. - The logger name prefix to prepend in front of the logger name. - Converted . - - - - Gets or sets the client-generated identifier of the event. - - - - - Gets or sets the ordinal of the log level. - - - - - Gets or sets the logger ordinal (index into . - - The logger ordinal. - - - - Gets or sets the time delta (in ticks) between the time of the event and base time. - - - - - Gets or sets the message string index. - - - - - Gets or sets the collection of layout values. - - - - - Gets the collection of indexes into array for each layout value. - - - - - Wire format for NLog event package. - - - - - Converts the events to sequence of objects suitable for routing through NLog. - - The logger name prefix to prepend in front of each logger name. - - Sequence of objects. - - - - - Converts the events to sequence of objects suitable for routing through NLog. - - - Sequence of objects. - - - - - Gets or sets the name of the client. - - The name of the client. - - - - Gets or sets the base time (UTC ticks) for all events in the package. - - The base time UTC. - - - - Gets or sets the collection of layout names which are shared among all events. - - The layout names. - - - - Gets or sets the collection of logger names. - - The logger names. - - - - Gets or sets the list of events. - - The events. - - - - List of strings annotated for more terse serialization. - - - - - Initializes a new instance of the class. - - - - - Log Receiver Client using WCF. - - - This will be removed when ILogReceiverClient is removed. - This provides an implementation of the legacy interface. - - - - Abstract base class for the WcfLogReceiverXXXWay classes. It can only be - used internally (see internal constructor). It passes off any Channel usage - to the inheriting class. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the endpoint configuration. - - - - Initializes a new instance of the class. - - Name of the endpoint configuration. - The remote address. - - - - Initializes a new instance of the class. - - Name of the endpoint configuration. - The remote address. - - - - Initializes a new instance of the class. - - The binding. - The remote address. - - - - Opens the client asynchronously. - - - - - Opens the client asynchronously. - - User-specific state. - - - - Closes the client asynchronously. - - - - - Closes the client asynchronously. - - User-specific state. - - - - Processes the log messages asynchronously. - - The events to send. - - - - Processes the log messages asynchronously. - - The events to send. - User-specific state. - - - - Begins processing of log messages. - - The events to send. - The callback. - Asynchronous state. - - IAsyncResult value which can be passed to . - - - - - Ends asynchronous processing of log messages. - - The result. - - - - Occurs when the log message processing has completed. - - - - - Occurs when Open operation has completed. - - - - - Occurs when Close operation has completed. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the endpoint configuration. - - - - Initializes a new instance of the class. - - Name of the endpoint configuration. - The remote address. - - - - Initializes a new instance of the class. - - Name of the endpoint configuration. - The remote address. - - - - Initializes a new instance of the class. - - The binding. - The remote address. - - - - Begins processing of log messages. - - The events to send. - The callback. - Asynchronous state. - - IAsyncResult value which can be passed to . - - - - - Ends asynchronous processing of log messages. - - The result. - - - - Log Receiver Client facade. It allows the use either of the one way or two way - service contract using WCF through its unified interface. - - - Delegating methods are generated with Resharper. - 1. change ProxiedClient to private field (instead of public property) - 2. delegate members - 3. change ProxiedClient back to public property. - - - - - - Initializes a new instance of the class. - - Whether to use the one way or two way WCF client. - - - - Initializes a new instance of the class. - - Whether to use the one way or two way WCF client. - Name of the endpoint configuration. - - - - Initializes a new instance of the class. - - Whether to use the one way or two way WCF client. - Name of the endpoint configuration. - The remote address. - - - - Initializes a new instance of the class. - - Whether to use the one way or two way WCF client. - Name of the endpoint configuration. - The remote address. - - - - Initializes a new instance of the class. - - Whether to use the one way or two way WCF client. - The binding. - The remote address. - - - - Causes a communication object to transition immediately from its current state into the closed state. - - - - - Begins an asynchronous operation to close a communication object. - - - The that references the asynchronous close operation. - - The delegate that receives notification of the completion of the asynchronous close operation.An object, specified by the application, that contains state information associated with the asynchronous close operation. was called on an object in the state.The default timeout elapsed before the was able to close gracefully. - - - - Begins an asynchronous operation to close a communication object with a specified timeout. - - - The that references the asynchronous close operation. - - The that specifies how long the send operation has to complete before timing out.The delegate that receives notification of the completion of the asynchronous close operation.An object, specified by the application, that contains state information associated with the asynchronous close operation. was called on an object in the state.The specified timeout elapsed before the was able to close gracefully. - - - - Begins an asynchronous operation to open a communication object. - - - The that references the asynchronous open operation. - - The delegate that receives notification of the completion of the asynchronous open operation.An object, specified by the application, that contains state information associated with the asynchronous open operation.The was unable to be opened and has entered the state.The default open timeout elapsed before the was able to enter the state and has entered the state. - - - - Begins an asynchronous operation to open a communication object within a specified interval of time. - - - The that references the asynchronous open operation. - - The that specifies how long the send operation has to complete before timing out.The delegate that receives notification of the completion of the asynchronous open operation.An object, specified by the application, that contains state information associated with the asynchronous open operation.The was unable to be opened and has entered the state.The specified timeout elapsed before the was able to enter the state and has entered the state. - - - - Begins processing of log messages. - - The events to send. - The callback. - Asynchronous state. - - IAsyncResult value which can be passed to . - - - - - Causes a communication object to transition from its current state into the closed state. - - The that specifies how long the send operation has to complete before timing out. was called on an object in the state.The timeout elapsed before the was able to close gracefully. - - - - Causes a communication object to transition from its current state into the closed state. - - was called on an object in the state.The default close timeout elapsed before the was able to close gracefully. - - - - Closes the client asynchronously. - - User-specific state. - - - - Closes the client asynchronously. - - - - - Instructs the inner channel to display a user interface if one is required to initialize the channel prior to using it. - - - - - Completes an asynchronous operation to close a communication object. - - The that is returned by a call to the method. was called on an object in the state.The timeout elapsed before the was able to close gracefully. - - - - Completes an asynchronous operation to open a communication object. - - The that is returned by a call to the method.The was unable to be opened and has entered the state.The timeout elapsed before the was able to enter the state and has entered the state. - - - - Ends asynchronous processing of log messages. - - The result. - - - - Causes a communication object to transition from the created state into the opened state. - - The was unable to be opened and has entered the state.The default open timeout elapsed before the was able to enter the state and has entered the state. - - - - Causes a communication object to transition from the created state into the opened state within a specified interval of time. - - The that specifies how long the send operation has to complete before timing out.The was unable to be opened and has entered the state.The specified timeout elapsed before the was able to enter the state and has entered the state. - - - - Opens the client asynchronously. - - - - - Opens the client asynchronously. - - User-specific state. - - - - Processes the log messages asynchronously. - - The events to send. - - - - Processes the log messages asynchronously. - - The events to send. - User-specific state. - - - - Causes a communication object to transition from its current state into the closed state. - - - - - The client getting proxied - - - - - Do we use one-way or two-way messaging? - - - - - Enables the user to configure client and service credentials as well as service credential authentication settings for use on the client side of communication. - - - - - Occurs when Close operation has completed. - - - - - Occurs when the communication object completes its transition from the closing state into the closed state. - - - - - Occurs when the communication object first enters the closing state. - - - - - Gets the target endpoint for the service to which the WCF client can connect. - - - - - Occurs when the communication object first enters the faulted state. - - - - - Gets the underlying implementation. - - - - - Occurs when Open operation has completed. - - - - - Occurs when the communication object completes its transition from the opening state into the opened state. - - - - - Occurs when the communication object first enters the opening state. - - - - - Occurs when the log message processing has completed. - - - - - Gets the current state of the communication-oriented object. - - - The value of the of the object. - - - - - Log Receiver Client using WCF. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the endpoint configuration. - - - - Initializes a new instance of the class. - - Name of the endpoint configuration. - The remote address. - - - - Initializes a new instance of the class. - - Name of the endpoint configuration. - The remote address. - - - - Initializes a new instance of the class. - - The binding. - The remote address. - - - - Begins processing of log messages. - - The events to send. - The callback. - Asynchronous state. - - IAsyncResult value which can be passed to . - - - - - Ends asynchronous processing of log messages. - - The result. - - - - Log Receiver Client using WCF. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the endpoint configuration. - - - - Initializes a new instance of the class. - - Name of the endpoint configuration. - The remote address. - - - - Initializes a new instance of the class. - - Name of the endpoint configuration. - The remote address. - - - - Initializes a new instance of the class. - - The binding. - The remote address. - - - - Begins processing of log messages. - - The events to send. - The callback. - Asynchronous state. - - IAsyncResult value which can be passed to . - - - - - Ends asynchronous processing of log messages. - - The result. - - - - Mapped Diagnostics Context - a thread-local structure that keeps a dictionary - of strings and provides methods to output them in layouts. - Mostly for compatibility with log4net. - - - - - Sets the current thread MDC item to the specified value. - - Item name. - Item value. - - - - Sets the current thread MDC item to the specified value. - - Item name. - Item value. - - - - Gets the current thread MDC named item, as . - - Item name. - The value of , if defined; otherwise . - - - - Gets the current thread MDC named item, as . - - Item name. - The to use when converting a value to a string. - The value of , if defined; otherwise . - - - - Gets the current thread MDC named item, as . - - Item name. - The value of , if defined; otherwise null. - - - - Checks whether the specified item exists in current thread MDC. - - Item name. - A boolean indicating whether the specified exists in current thread MDC. - - - - Removes the specified from current thread MDC. - - Item name. - - - - Clears the content of current thread MDC. - - - - - Async version of Mapped Diagnostics Context - a logical context structure that keeps a dictionary - of strings and provides methods to output them in layouts. Allows for maintaining state across - asynchronous tasks and call contexts. - - - Ideally, these changes should be incorporated as a new version of the MappedDiagnosticsContext class in the original - NLog library so that state can be maintained for multiple threads in asynchronous situations. - - - - - Gets the current logical context named item, as . - - Item name. - The value of , if defined; otherwise . - - - - Gets the current logical context named item, as . - - Item name. - The to use when converting a value to a string. - The value of , if defined; otherwise . - - - - Gets the current logical context named item, as . - - Item name. - The value of , if defined; otherwise null. - - - - Sets the current logical context item to the specified value. - - Item name. - Item value. - - - - Sets the current logical context item to the specified value. - - Item name. - Item value. - - - - Checks whether the specified exists in current logical context. - - Item name. - A boolean indicating whether the specified exists in current logical context. - - - - Removes the specified from current logical context. - - Item name. - - - - Clears the content of current logical context. - - - - - Mapped Diagnostics Context - used for log4net compatibility. - - - - - Sets the current thread MDC item to the specified value. - - Item name. - Item value. - - - - Gets the current thread MDC named item. - - Item name. - The value of , if defined; otherwise . - - - - Gets the current thread MDC named item. - - Item name. - The value of , if defined; otherwise null. - - - - Checks whether the specified item exists in current thread MDC. - - Item name. - A boolean indicating whether the specified item exists in current thread MDC. - - - - Removes the specified item from current thread MDC. - - Item name. - - - - Clears the content of current thread MDC. - - - - - Nested Diagnostics Context - for log4net compatibility. - - - - - Pushes the specified text on current thread NDC. - - The text to be pushed. - An instance of the object that implements IDisposable that returns the stack to the previous level when IDisposable.Dispose() is called. To be used with C# using() statement. - - - - Pops the top message off the NDC stack. - - The top message which is no longer on the stack. - - - - Pops the top object off the NDC stack. The object is removed from the stack. - - The top object from the NDC stack, if defined; otherwise null. - - - - Clears current thread NDC stack. - - - - - Gets all messages on the stack. - - Array of strings on the stack. - - - - Gets all objects on the NDC stack. The objects are not removed from the stack. - - Array of objects on the stack. - - - - Gets the top NDC message but doesn't remove it. - - The top message. . - - - - Gets the top NDC object but doesn't remove it. - - The object from the top of the NDC stack, if defined; otherwise null. - - - - Nested Diagnostics Context - a thread-local structure that keeps a stack - of strings and provides methods to output them in layouts - Mostly for compatibility with log4net. - - - - - Pushes the specified text on current thread NDC. - - The text to be pushed. - An instance of the object that implements IDisposable that returns the stack to the previous level when IDisposable.Dispose() is called. To be used with C# using() statement. - - - - Pushes the specified object on current thread NDC. - - The object to be pushed. - An instance of the object that implements IDisposable that returns the stack to the previous level when IDisposable.Dispose() is called. To be used with C# using() statement. - - - - Pops the top message off the NDC stack. - - The top message which is no longer on the stack. - - - - Pops the top message from the NDC stack. - - The to use when converting the value to a string. - The top message, which is removed from the stack, as a string value. - - - - Pops the top object off the NDC stack. - - The object from the top of the NDC stack, if defined; otherwise null. - - - - Clears current thread NDC stack. - - - - - Gets all messages on the stack. - - Array of strings on the stack. - - - - Gets all messages from the stack, without removing them. - - The to use when converting a value to a string. - Array of strings. - - - - Gets all objects on the stack. - - Array of objects on the stack. - - - - Gets the top NDC message but doesn't remove it. - - The top message. . - - - - Gets the top NDC object but doesn't remove it. - - The object at the top of the NDC stack if defined; otherwise null. - - - - Resets the stack to the original count during . - - - - - Initializes a new instance of the class. - - The stack. - The previous count. - - - - Reverts the stack to original item count. - - - - - Exception thrown during NLog configuration. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - The message. - The inner exception. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - - The parameter is null. - - - The class name is null or is zero (0). - - - - - Exception thrown during log event processing. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - The message. - Parameters for the message - - - - Initializes a new instance of the class. - - The message. - The inner exception. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - - The parameter is null. - - - The class name is null or is zero (0). - - - - - TraceListener which routes all messages through NLog. - - - - - Initializes a new instance of the class. - - - - - When overridden in a derived class, writes the specified message to the listener you create in the derived class. - - A message to write. - - - - When overridden in a derived class, writes a message to the listener you create in the derived class, followed by a line terminator. - - A message to write. - - - - When overridden in a derived class, closes the output stream so it no longer receives tracing or debugging output. - - - - - Emits an error message. - - A message to emit. - - - - Emits an error message and a detailed error message. - - A message to emit. - A detailed message to emit. - - - - Flushes the output buffer. - - - - - Writes trace information, a data object and event information to the listener specific output. - - A object that contains the current process ID, thread ID, and stack trace information. - A name used to identify the output, typically the name of the application that generated the trace event. - One of the values specifying the type of event that has caused the trace. - A numeric identifier for the event. - The trace data to emit. - - - - Writes trace information, an array of data objects and event information to the listener specific output. - - A object that contains the current process ID, thread ID, and stack trace information. - A name used to identify the output, typically the name of the application that generated the trace event. - One of the values specifying the type of event that has caused the trace. - A numeric identifier for the event. - An array of objects to emit as data. - - - - Writes trace and event information to the listener specific output. - - A object that contains the current process ID, thread ID, and stack trace information. - A name used to identify the output, typically the name of the application that generated the trace event. - One of the values specifying the type of event that has caused the trace. - A numeric identifier for the event. - - - - Writes trace information, a formatted array of objects and event information to the listener specific output. - - A object that contains the current process ID, thread ID, and stack trace information. - A name used to identify the output, typically the name of the application that generated the trace event. - One of the values specifying the type of event that has caused the trace. - A numeric identifier for the event. - A format string that contains zero or more format items, which correspond to objects in the array. - An object array containing zero or more objects to format. - - - - Writes trace information, a message, and event information to the listener specific output. - - A object that contains the current process ID, thread ID, and stack trace information. - A name used to identify the output, typically the name of the application that generated the trace event. - One of the values specifying the type of event that has caused the trace. - A numeric identifier for the event. - A message to write. - - - - Writes trace information, a message, a related activity identity and event information to the listener specific output. - - A object that contains the current process ID, thread ID, and stack trace information. - A name used to identify the output, typically the name of the application that generated the trace event. - A numeric identifier for the event. - A message to write. - A object identifying a related activity. - - - - Gets the custom attributes supported by the trace listener. - - - A string array naming the custom attributes supported by the trace listener, or null if there are no custom attributes. - - - - - Translates the event type to level from . - - Type of the event. - Translated log level. - - - - Process the log event - The log level. - The name of the logger. - The log message. - The log parameters. - The event id. - The event type. - The related activity id. - - - - - Gets or sets the log factory to use when outputting messages (null - use LogManager). - - - - - Gets or sets the default log level. - - - - - Gets or sets the log which should be always used regardless of source level. - - - - - Gets or sets a value indicating whether flush calls from trace sources should be ignored. - - - - - Gets a value indicating whether the trace listener is thread safe. - - - true if the trace listener is thread safe; otherwise, false. The default is false. - - - - Gets or sets a value indicating whether to use auto logger name detected from the stack trace. - - - - - Specifies the way archive numbering is performed. - - - - - Sequence style numbering. The most recent archive has the highest number. - - - - - Rolling style numbering (the most recent is always #0 then #1, ..., #N. - - - - - Date style numbering. Archives will be stamped with the prior period - (Year, Month, Day, Hour, Minute) datetime. - - - - - Date and sequence style numbering. - Archives will be stamped with the prior period (Year, Month, Day) datetime. - The most recent archive has the highest number (in combination with the date). - - - - - Outputs log messages through the ASP Response object. - - Documentation on NLog Wiki - - - - Represents target that supports string formatting using layouts. - - - - - Represents logging target. - - - - - Initializes this instance. - - The configuration. - - - - Closes this instance. - - - - - Closes the target. - - - - - Flush any pending log messages (in case of asynchronous targets). - - The asynchronous continuation. - - - - Calls the on each volatile layout - used by this target. - - - The log event. - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Writes the log to the target. - - Log event to write. - - - - Writes the array of log events. - - The log events. - - - - Initializes this instance. - - The configuration. - - - - Closes this instance. - - - - - Releases unmanaged and - optionally - managed resources. - - True to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Initializes the target. Can be used by inheriting classes - to initialize logging. - - - - - Closes the target and releases any unmanaged resources. - - - - - Flush any pending log messages asynchronously (in case of asynchronous targets). - - The asynchronous continuation. - - - - Writes logging event to the log target. - classes. - - - Logging event to be written out. - - - - - Writes log event to the log target. Must be overridden in inheriting - classes. - - Log event to be written out. - - - - Writes an array of logging events to the log target. By default it iterates on all - events and passes them to "Write" method. Inheriting classes can use this method to - optimize batch writes. - - Logging events to be written out. - - - - Merges (copies) the event context properties from any event info object stored in - parameters of the given event info object. - - The event info object to perform the merge to. - - - - Gets or sets the name of the target. - - - - - - Gets the object which can be used to synchronize asynchronous operations that must rely on the . - - - - - Gets the logging configuration this target is part of. - - - - - Gets a value indicating whether the target has been initialized. - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - Gets or sets the layout used to format log messages. - - - - - - Outputs the rendered logging event through the OutputDebugString() Win32 API. - - The logging event. - - - - Gets or sets a value indicating whether to add <!-- --> comments around all written texts. - - - - - - Sends log messages to the remote instance of Chainsaw application from log4j. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- -

- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -

-
-
- - - Sends log messages to the remote instance of NLog Viewer. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- -

- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -

-
-
- - - Sends log messages over the network. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- -

- To print the results, use any application that's able to receive messages over - TCP or UDP. NetCat is - a simple but very powerful command-line tool that can be used for that. This image - demonstrates the NetCat tool receiving log messages from Network target. -

- -

- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will be very slow. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -

-

- There are two specialized versions of the Network target: Chainsaw - and NLogViewer which write to instances of Chainsaw log4j viewer - or NLogViewer application respectively. -

-
-
- - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - Flush any pending log messages asynchronously (in case of asynchronous targets). - - The asynchronous continuation. - - - - Closes the target. - - - - - Sends the - rendered logging event over the network optionally concatenating it with a newline character. - - The logging event. - - - - Try to remove. - - - - - removed something? - - - - Gets the bytes to be written. - - Log event. - Byte array. - - - - Gets or sets the network address. - - - The network address can be: -
    -
  • tcp://host:port - TCP (auto select IPv4/IPv6) (not supported on Windows Phone 7.0)
  • -
  • tcp4://host:port - force TCP/IPv4 (not supported on Windows Phone 7.0)
  • -
  • tcp6://host:port - force TCP/IPv6 (not supported on Windows Phone 7.0)
  • -
  • udp://host:port - UDP (auto select IPv4/IPv6, not supported on Silverlight and on Windows Phone 7.0)
  • -
  • udp4://host:port - force UDP/IPv4 (not supported on Silverlight and on Windows Phone 7.0)
  • -
  • udp6://host:port - force UDP/IPv6 (not supported on Silverlight and on Windows Phone 7.0)
  • -
  • http://host:port/pageName - HTTP using POST verb
  • -
  • https://host:port/pageName - HTTPS using POST verb
  • -
- For SOAP-based webservice support over HTTP use WebService target. -
- -
- - - Gets or sets a value indicating whether to keep connection open whenever possible. - - - - - - Gets or sets a value indicating whether to append newline at the end of log message. - - - - - - Gets or sets the maximum message size in bytes. - - - - - - Gets or sets the size of the connection cache (number of connections which are kept alive). - - - - - - Gets or sets the maximum current connections. 0 = no maximum. - - - - - - Gets or sets the action that should be taken if the will be more connections than . - - - - - - Gets or sets the maximum queue size. - - - - - Gets or sets the action that should be taken if the message is larger than - maxMessageSize. - - - - - - Gets or sets the encoding to be used. - - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - Gets or sets a value indicating whether to include NLog-specific extensions to log4j schema. - - - - - - Gets or sets the AppInfo field. By default it's the friendly name of the current AppDomain. - - - - - - Gets or sets a value indicating whether to include call site (class and method name) in the information sent over the network. - - - - - - Gets or sets a value indicating whether to include source info (file name and line number) in the information sent over the network. - - - - - - Gets or sets a value indicating whether to include dictionary contents. - - - - - - Gets or sets a value indicating whether to include stack contents. - - - - - - Gets or sets the NDC item separator. - - - - - - Gets the collection of parameters. Each parameter contains a mapping - between NLog layout and a named parameter. - - - - - - Gets the layout renderer which produces Log4j-compatible XML events. - - - - - Gets or sets the instance of that is used to format log messages. - - - - - - Initializes a new instance of the class. - - - - - Writes log messages to the console with customizable coloring. - - Documentation on NLog Wiki - - - - Represents target that supports string formatting using layouts. - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - Gets or sets the text to be rendered. - - - - - - Gets or sets the footer. - - - - - - Gets or sets the header. - - - - - - Gets or sets the layout with header and footer. - - The layout with header and footer. - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - Initializes the target. - - - - - Closes the target and releases any unmanaged resources. - - - - - Writes the specified log event to the console highlighting entries - and words based on a set of defined rules. - - Log event. - - - - Gets or sets a value indicating whether the error stream (stderr) should be used instead of the output stream (stdout). - - - - - - Gets or sets a value indicating whether to use default row highlighting rules. - - - The default rules are: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ConditionForeground ColorBackground Color
level == LogLevel.FatalRedNoChange
level == LogLevel.ErrorYellowNoChange
level == LogLevel.WarnMagentaNoChange
level == LogLevel.InfoWhiteNoChange
level == LogLevel.DebugGrayNoChange
level == LogLevel.TraceDarkGrayNoChange
-
- -
- - - The encoding for writing messages to the . - - Has side effect - - - - Gets the row highlighting rules. - - - - - - Gets the word highlighting rules. - - - - - - Color pair (foreground and background). - - - - - Colored console output color. - - - Note that this enumeration is defined to be binary compatible with - .NET 2.0 System.ConsoleColor + some additions - - - - - Black Color (#000000). - - - - - Dark blue Color (#000080). - - - - - Dark green Color (#008000). - - - - - Dark Cyan Color (#008080). - - - - - Dark Red Color (#800000). - - - - - Dark Magenta Color (#800080). - - - - - Dark Yellow Color (#808000). - - - - - Gray Color (#C0C0C0). - - - - - Dark Gray Color (#808080). - - - - - Blue Color (#0000FF). - - - - - Green Color (#00FF00). - - - - - Cyan Color (#00FFFF). - - - - - Red Color (#FF0000). - - - - - Magenta Color (#FF00FF). - - - - - Yellow Color (#FFFF00). - - - - - White Color (#FFFFFF). - - - - - Don't change the color. - - - - - The row-highlighting condition. - - - - - Initializes static members of the ConsoleRowHighlightingRule class. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The condition. - Color of the foreground. - Color of the background. - - - - Checks whether the specified log event matches the condition (if any). - - - Log event. - - - A value of if the condition is not defined or - if it matches, otherwise. - - - - - Gets the default highlighting rule. Doesn't change the color. - - - - - Gets or sets the condition that must be met in order to set the specified foreground and background color. - - - - - - Gets or sets the foreground color. - - - - - - Gets or sets the background color. - - - - - - Writes log messages to the console. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- -
-
- - - Initializes the target. - - - - - Closes the target and releases any unmanaged resources. - - - - - Writes the specified logging event to the Console.Out or - Console.Error depending on the value of the Error flag. - - The logging event. - - Note that the Error option is not supported on .NET Compact Framework. - - - - - Write to output - - text to be written. - - - - Gets or sets a value indicating whether to send the log messages to the standard error instead of the standard output. - - - - - - The encoding for writing messages to the . - - Has side effect - - - - Highlighting rule for Win32 colorful console. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The text to be matched.. - Color of the foreground. - Color of the background. - - - - Gets or sets the regular expression to be matched. You must specify either text or regex. - - - - - - Gets or sets the text to be matched. You must specify either text or regex. - - - - - - Gets or sets a value indicating whether to match whole words only. - - - - - - Gets or sets a value indicating whether to ignore case when comparing texts. - - - - - - Gets the compiled regular expression that matches either Text or Regex property. - - - - - Gets or sets the foreground color. - - - - - - Gets or sets the background color. - - - - - - Information about database command + parameters. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the type of the command. - - The type of the command. - - - - - Gets or sets the connection string to run the command against. If not provided, connection string from the target is used. - - - - - - Gets or sets the command text. - - - - - - Gets or sets a value indicating whether to ignore failures. - - - - - - Gets the collection of parameters. Each parameter contains a mapping - between NLog layout and a database named or positional parameter. - - - - - - Represents a parameter to a Database target. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the parameter. - The parameter layout. - - - - Gets or sets the database parameter name. - - - - - - Gets or sets the layout that should be use to calcuate the value for the parameter. - - - - - - Gets or sets the database parameter size. - - - - - - Gets or sets the database parameter precision. - - - - - - Gets or sets the database parameter scale. - - - - - - Writes log messages to the database using an ADO.NET provider. - - Documentation on NLog Wiki - - - The configuration is dependent on the database type, because - there are differnet methods of specifying connection string, SQL - command and command parameters. - - MS SQL Server using System.Data.SqlClient: - - Oracle using System.Data.OracleClient: - - Oracle using System.Data.OleDBClient: - - To set up the log target programmatically use code like this (an equivalent of MSSQL configuration): - - - - - - Initializes a new instance of the class. - - - - - Performs installation which requires administrative permissions. - - The installation context. - - - - Performs uninstallation which requires administrative permissions. - - The installation context. - - - - Determines whether the item is installed. - - The installation context. - - Value indicating whether the item is installed or null if it is not possible to determine. - - - - - Initializes the target. Can be used by inheriting classes - to initialize logging. - - - - - Closes the target and releases any unmanaged resources. - - - - - Writes the specified logging event to the database. It creates - a new database command, prepares parameters for it by calculating - layouts and executes the command. - - The logging event. - - - - Writes an array of logging events to the log target. By default it iterates on all - events and passes them to "Write" method. Inheriting classes can use this method to - optimize batch writes. - - Logging events to be written out. - - - - Gets or sets the name of the database provider. - - - - The parameter name should be a provider invariant name as registered in machine.config or app.config. Common values are: - -
    -
  • System.Data.SqlClient - SQL Sever Client
  • -
  • System.Data.SqlServerCe.3.5 - SQL Sever Compact 3.5
  • -
  • System.Data.OracleClient - Oracle Client from Microsoft (deprecated in .NET Framework 4)
  • -
  • Oracle.DataAccess.Client - ODP.NET provider from Oracle
  • -
  • System.Data.SQLite - System.Data.SQLite driver for SQLite
  • -
  • Npgsql - Npgsql driver for PostgreSQL
  • -
  • MySql.Data.MySqlClient - MySQL Connector/Net
  • -
- (Note that provider invariant names are not supported on .NET Compact Framework). - - Alternatively the parameter value can be be a fully qualified name of the provider - connection type (class implementing ) or one of the following tokens: - -
    -
  • sqlserver, mssql, microsoft or msde - SQL Server Data Provider
  • -
  • oledb - OLEDB Data Provider
  • -
  • odbc - ODBC Data Provider
  • -
-
- -
- - - Gets or sets the name of the connection string (as specified in <connectionStrings> configuration section. - - - - - - Gets or sets the connection string. When provided, it overrides the values - specified in DBHost, DBUserName, DBPassword, DBDatabase. - - - - - - Gets or sets the connection string using for installation and uninstallation. If not provided, regular ConnectionString is being used. - - - - - - Gets the installation DDL commands. - - - - - - Gets the uninstallation DDL commands. - - - - - - Gets or sets a value indicating whether to keep the - database connection open between the log events. - - - - - - Obsolete - value will be ignored! The logging code always runs outside of transaction. - - Gets or sets a value indicating whether to use database transactions. - Some data providers require this. - - - - This option was removed in NLog 4.0 because the logging code always runs outside of transaction. - This ensures that the log gets written to the database if you rollback the main transaction because of an error and want to log the error. - - - - - Gets or sets the database host name. If the ConnectionString is not provided - this value will be used to construct the "Server=" part of the - connection string. - - - - - - Gets or sets the database user name. If the ConnectionString is not provided - this value will be used to construct the "User ID=" part of the - connection string. - - - - - - Gets or sets the database password. If the ConnectionString is not provided - this value will be used to construct the "Password=" part of the - connection string. - - - - - - Gets or sets the database name. If the ConnectionString is not provided - this value will be used to construct the "Database=" part of the - connection string. - - - - - - Gets or sets the text of the SQL command to be run on each log level. - - - Typically this is a SQL INSERT statement or a stored procedure call. - It should use the database-specific parameters (marked as @parameter - for SQL server or :parameter for Oracle, other data providers - have their own notation) and not the layout renderers, - because the latter is prone to SQL injection attacks. - The layout renderers should be specified as <parameter /> elements instead. - - - - - - Gets or sets the type of the SQL command to be run on each log level. - - - This specifies how the command text is interpreted, as "Text" (default) or as "StoredProcedure". - When using the value StoredProcedure, the commandText-property would - normally be the name of the stored procedure. TableDirect method is not supported in this context. - - - - - - Gets the collection of parameters. Each parameter contains a mapping - between NLog layout and a database named or positional parameter. - - - - - - A descriptor for an archive created with the DateAndSequence numbering mode. - - - - - Determines whether produces the same string as the current instance's date once formatted with the current instance's date format. - - The date to compare the current object's date to. - True if the formatted dates are equal, otherwise False. - - - - Initializes a new instance of the class. - - - - - The full name of the archive file. - - - - - The parsed date contained in the file name. - - - - - The parsed sequence number contained in the file name. - - - - - Writes log messages to the attached managed debugger. - - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- -
-
- - - Initializes the target. - - - - - Closes the target and releases any unmanaged resources. - - - - - Writes the specified logging event to the attached debugger. - - The logging event. - - - - Mock target - useful for testing. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- -
-
- - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - Increases the number of messages. - - The logging event. - - - - Gets the number of times this target has been called. - - - - - - Gets the last message rendered by this target. - - - - - - Writes log message to the Event Log. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- -
-
- - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Performs installation which requires administrative permissions. - - The installation context. - - - - Performs uninstallation which requires administrative permissions. - - The installation context. - - - - Determines whether the item is installed. - - The installation context. - - Value indicating whether the item is installed or null if it is not possible to determine. - - - - - Initializes the target. - - - - - Writes the specified logging event to the event log. - - The logging event. - - - - Get the entry type for logging the message. - - The logging event - for rendering the - - - - - Get the source, if and only if the source is fixed. - - null when not - Internal for unit tests - - - - Get the eventlog to write to. - - Event if the source needs to be rendered. - - - - - (re-)create a event source, if it isn't there. Works only with fixed sourcenames. - - sourcenaam. If source is not fixed (see , then pass null or emptystring. - always throw an Exception when there is an error - - - - Gets or sets the name of the machine on which Event Log service is running. - - - - - - Gets or sets the layout that renders event ID. - - - - - - Gets or sets the layout that renders event Category. - - - - - - Optional entrytype. When not set, or when not convertable to then determined by - - - - - Gets or sets the value to be used as the event Source. - - - By default this is the friendly name of the current AppDomain. - - - - - - Gets or sets the name of the Event Log to write to. This can be System, Application or - any user-defined name. - - - - - - Modes of archiving files based on time. - - - - - Don't archive based on time. - - - - - AddToArchive every year. - - - - - AddToArchive every month. - - - - - AddToArchive daily. - - - - - AddToArchive every hour. - - - - - AddToArchive every minute. - - - - - Writes log messages to one or more files. - - Documentation on NLog Wiki - - - - Default clean up period of the initilized files. When a file exceeds the clean up period is removed from the list. - - Clean up period is defined in days. - - - - The maximum number of initialised files at any one time. Once this number is exceeded clean up procedures - are initiated to reduce the number of initialised files. - - - - - This value disables file archiving based on the size. - - - - - Gets or sets a value indicating whether to compress archive files into the zip archive format. - - - - - Cached directory separator char array to avoid memory allocation on each method call. - - - - - Cached invalid filenames char array to avoid memory allocation everytime Path.GetInvalidFileNameChars() is called. - - - - - Holds the initialised files each given time by the instance. Against each file, the last write time is stored. - - Last write time is store in local time (no UTC). - - - - Factory used to create the file appeanders in the instance. - - File appenders are stored in an instance of . - - - - List of the associated file appenders with the instance. - - - - - The number of initialised files at any one time. - - - - - The maximum number of archive files that should be kept. - - - - - It holds the file names of existing archives in order for the oldest archives to be removed when the list of - filenames becomes too long. - - - - - The filename as target - - - - - The filename if is a fixed string - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - Removes records of initialized files that have not been - accessed in the last two days. - - - Files are marked 'initialized' for the purpose of writing footers when the logging finishes. - - - - - Removes records of initialized files that have not been - accessed after the specified date. - - The cleanup threshold. - - Files are marked 'initialized' for the purpose of writing footers when the logging finishes. - - - - - Flushes all pending file operations. - - The asynchronous continuation. - - The timeout parameter is ignored, because file APIs don't provide - the needed functionality. - - - - - Returns the suitable appender factory ( ) to be used to generate the file - appenders associated with the instance. - - The type of the file appender factory returned depends on the values of various properties. - - suitable for this instance. - - - - Initializes file logging by creating data structures that - enable efficient multi-file logging. - - - - - Closes the file(s) opened for writing. - - - - - Writes the specified logging event to a file specified in the FileName - parameter. - - The logging event. - - - - Writes the specified array of logging events to a file specified in the FileName - parameter. - - An array of objects. - - This function makes use of the fact that the events are batched by sorting - the requests by filename. This optimizes the number of open/close calls - and can help improve performance. - - - - - Formats the log event for write. - - The log event to be formatted. - A string representation of the log event. - - - - Gets the bytes to be written to the file. - - Log event. - Array of bytes that are ready to be written. - - - - Modifies the specified byte array before it gets sent to a file. - - The byte array. - The modified byte array. The function can do the modification in-place. - - - - Replaces the numeric pattern i.e. {#} in a file name with the parameter value. - - File name which contains the numeric pattern. - Value which will replace the numeric pattern. - File name with the value of in the position of the numberic pattern. - - - - Determines if the file name as contains a numeric pattern i.e. {#} in it. - - Example: - trace{#}.log Contains the numeric pattern. - trace{###}.log Contains the numeric pattern. - trace{#X#}.log Contains the numeric pattern (See remarks). - trace.log Does not contain the pattern. - - Occationally, this method can identify the existance of the {#} pattern incorrectly. - File name to be checked. - when the pattern is found; otherwise. - - - - Archives the using a rolling style numbering (the most recent is always #0 then - #1, ..., #N. When the number of archive files exceed the obsolete archives - are deleted. - - - This method is called recursively. This is the reason the is required. - - File name to be archived. - File name template which contains the numeric pattern to be replaced. - Value which will replace the numeric pattern. - - - - Archives the using a sequence style numbering. The most recent archive has the - highest number. When the number of archive files exceed the obsolete - archives are deleted. - - File name to be archived. - File name template which contains the numeric pattern to be replaced. - - - - Creates an archive copy of source file either by compressing it or moving to a new location in the file - system. Which action will be used is determined by the value of parameter. - - File name to be archived. - Name of the archive file. - Enables file compression - - - - - Archives the using a date and sequence style numbering. Archives will be stamped - with the prior period (Year, Month, Day) datetime. The most recent archive has the highest number (in - combination with the date). - - - When the number of archive files exceed the obsolete archives are deleted. - - - File name to be archived. - File name template which contains the numeric pattern to be replaced. - Log event that the instance is currently processing. - - - - Determines whether a file with a different name from is needed to receive the - . This is determined based on the last date and time which the file has been - written compared to the time the log event was initiated. - - - when log event time is "different" than the last write time; otherwise. - - - - - Deletes files among a given list, and stops as soon as the remaining files are fewer than the setting. - - List of the file archives. - - Items are deleted in the same order as in . No file is deleted if property is zero. - - - - - Searches a given directory for archives that comply with the current archive pattern. - - An enumeration of archive infos, ordered by their file creation date. - - - - Gets the collection of files in the specified directory which they match the . - - Directory to searched. - Pattern whihc the files will be searched against. - Lisf of files matching the pattern. - - - - Replaces the string-based pattern i.e. {#} in a file name with the value passed in parameter. - - File name which contains the string-based pattern. - Value which will replace the string-based pattern. - - File name with the value of in the position of the string-based pattern. - - - - - Archives the using a date style numbering. Archives will be stamped with the - prior period (Year, Month, Day, Hour, Minute) datetime. When the number of archive files exceed the obsolete archives are deleted. - - File name to be archived. - File name template which contains the numeric pattern to be replaced. - - - - Deletes archive files in reverse chronological order until only the - MaxArchiveFiles number of archive files remain. - - The pattern that archive filenames will match - - - - Gets the correct formating to be used based on the value of for converting values which will be inserting into file - names during archiving. - - This value will be computed only when a empty value or is passed into - - Date format to used irrespectively of value. - Formatting for dates. - - - - Invokes the archiving process after determining when and which type of archiving is required. - - File name to be checked and archived. - Log event that the instance is currently processing. - - - - Gets the pattern that archive files will match - - Filename of the log file - Log event that the instance is currently processing. - A string with a pattern that will match the archive filenames - - - - Indicates if the automatic archiving process should be executed. - - File name to be written. - Log event that the instance is currently processing. - The size in bytes of the next chunk of data to be written in the file. - when archiving should be executed; otherwise. - - - - Indicates if the automatic archiving process should be executed based on file size constrains. - - File name to be written. - The size in bytes of the next chunk of data to be written in the file. - when archiving should be executed; otherwise. - - - - Indicates if the automatic archiving process should be executed based on date/time constrains. - - File name to be written. - Log event that the instance is currently processing. - when archiving should be executed; otherwise. - - - - The sequence of to be written for the file header. - - Sequence of to be written. - - - - The sequence of to be written for the file footer. - - Sequence of to be written. - - - - Evaluates which parts of a file should be written (header, content, footer) based on various properties of - instance and writes them. - - File name to be written. - Log event that the instance is currently processing. - Raw sequence of to be written into the content part of the file. - Indicates that only content section should be written in the file. - - - - Initialise a file to be used by the instance. Based on the number of initialised - files and the values of various instance properties clean up and/or archiving processes can be invoked. - - File name to be written. - Log event that the instance is currently processing. - Indicates that only content section should be written in the file. - when file header should be written; otherwise. - - - - Writes the file footer and uninitialise the file in instance internal structures. - - File name to be written. - - - - Invokes the archiving and clean up of older archive file based on the values of and properties respectively. - - File name to be written. - Log event that the instance is currently processing. - - - - Creates the file specified in and writes the file content in each entirety i.e. - Header, Content and Footer. - - The name of the file to be written. - Sequence of to be written in the content section of the file. - This method is used when the content of the log file is re-written on every write. - - - - Writes the header information to a file. - - File appender associated with the file. - - - - Returns the length of a specified file and the last time it has been written. File appender is queried before the file system. - - File which the information are requested. - The last time the file has been written is returned. - The length of the file is returned. - when file details returned; otherwise. - - - - The sequence of to be written in a file after applying any formating and any - transformations required from the . - - The layout used to render output message. - Sequence of to be written. - Usually it is used to render the header and hooter of the files. - - - - Replaces any invalid characters found in the with underscore i.e _ character. - Invalid characters are defined by .NET framework and they returned by method. - Note: not implemented in Silverlight - - The original file name which might contain invalid characters. - The cleaned up file name without any invalid characters. - - - - Gets or sets the name of the file to write to. - - - This FileName string is a layout which may include instances of layout renderers. - This lets you use a single target to write to multiple files. - - - The following value makes NLog write logging events to files based on the log level in the directory where - the application runs. - ${basedir}/${level}.log - All Debug messages will go to Debug.log, all Info messages will go to Info.log and so on. - You can combine as many of the layout renderers as you want to produce an arbitrary log file name. - - - - - - Cleanup invalid values in a filename, e.g. slashes in a filename. If set to true, this can impact the performance of massive writes. - If set to false, nothing gets written when the filename is wrong. - - - - - Gets or sets a value indicating whether to create directories if they do not exist. - - - Setting this to false may improve performance a bit, but you'll receive an error - when attempting to write to a directory that's not present. - - - - - - Gets or sets a value indicating whether to delete old log file on startup. - - - This option works only when the "FileName" parameter denotes a single file. - - - - - - Gets or sets a value indicating whether to replace file contents on each write instead of appending log message at the end. - - - - - - Gets or sets a value indicating whether to keep log file open instead of opening and closing it on each logging event. - - - Setting this property to True helps improve performance. - - - - - - Gets or sets the maximum number of log filenames that should be stored as existing. - - - The bigger this number is the longer it will take to write each log record. The smaller the number is - the higher the chance that the clean function will be run when no new files have been opened. - - - - - - Gets or sets a value indicating whether to enable log file(s) to be deleted. - - - - - - Gets or sets the file attributes (Windows only). - - - - - - Gets or sets the line ending mode. - - - - - - Gets or sets a value indicating whether to automatically flush the file buffers after each log message. - - - - - - Gets or sets the number of files to be kept open. Setting this to a higher value may improve performance - in a situation where a single File target is writing to many files - (such as splitting by level or by logger). - - - The files are managed on a LRU (least recently used) basis, which flushes - the files that have not been used for the longest period of time should the - cache become full. As a rule of thumb, you shouldn't set this parameter to - a very high value. A number like 10-15 shouldn't be exceeded, because you'd - be keeping a large number of files open which consumes system resources. - - - - - - Gets or sets the maximum number of seconds that files are kept open. If this number is negative the files are - not automatically closed after a period of inactivity. - - - - - - Gets or sets the log file buffer size in bytes. - - - - - - Gets or sets the file encoding. - - - - - - Gets or sets a value indicating whether concurrent writes to the log file by multiple processes on the same host. - - - This makes multi-process logging possible. NLog uses a special technique - that lets it keep the files open for writing. - - - - - - Gets or sets a value indicating whether concurrent writes to the log file by multiple processes on different network hosts. - - - This effectively prevents files from being kept open. - - - - - - Gets or sets the number of times the write is appended on the file before NLog - discards the log message. - - - - - - Gets or sets the delay in milliseconds to wait before attempting to write to the file again. - - - The actual delay is a random value between 0 and the value specified - in this parameter. On each failed attempt the delay base is doubled - up to times. - - - Assuming that ConcurrentWriteAttemptDelay is 10 the time to wait will be:

- a random value between 0 and 10 milliseconds - 1st attempt
- a random value between 0 and 20 milliseconds - 2nd attempt
- a random value between 0 and 40 milliseconds - 3rd attempt
- a random value between 0 and 80 milliseconds - 4th attempt
- ...

- and so on. - - - - -

- Gets or sets a value indicating whether to archive old log file on startup. - - - This option works only when the "FileName" parameter denotes a single file. - After archiving the old file, the current log file will be empty. - - -
- - - Gets or sets a value specifying the date format to use when archving files. - - - This option works only when the "ArchiveNumbering" parameter is set either to Date or DateAndSequence. - - - - - - Gets or sets the size in bytes above which log files will be automatically archived. - - Warning: combining this with isn't supported. We cannot create multiple archive files, if they should have the same name. - Choose: - - - Caution: Enabling this option can considerably slow down your file - logging in multi-process scenarios. If only one process is going to - be writing to the file, consider setting ConcurrentWrites - to false for maximum performance. - - - - - - Gets or sets a value indicating whether to automatically archive log files every time the specified time passes. - - - Files are moved to the archive as part of the write operation if the current period of time changes. For example - if the current hour changes from 10 to 11, the first write that will occur - on or after 11:00 will trigger the archiving. -

- Caution: Enabling this option can considerably slow down your file - logging in multi-process scenarios. If only one process is going to - be writing to the file, consider setting ConcurrentWrites - to false for maximum performance. -

-
- -
- - - Gets or sets the name of the file to be used for an archive. - - - It may contain a special placeholder {#####} - that will be replaced with a sequence of numbers depending on - the archiving strategy. The number of hash characters used determines - the number of numerical digits to be used for numbering files. - - - - - - Gets or sets the maximum number of archive files that should be kept. - - - - - - Gets or sets the way file archives are numbered. - - - - - - Gets or set a value indicating whether a managed file stream is forced, instead of used the native implementation. - - - - - Gets the characters that are appended after each line. - - - - - Creates an instance of class. - - Maximum number of archive files to be kept. - - - - Adds a file into archive. - - File name of the archive - Original file name - Create a directory, if it does not exist - Enables file compression - if the file has been moved successfully; otherwise. - - - - Creates an instance of class. - - - - - Archives the file, either by copying it to a new file system location or by compressing it, and add the file name into the list of archives. - - Target file name. - Original file name. - Create a directory, if it does not exist. - Enables file compression. - - - - Remove old archive files when the files on the queue are more than the . - - - - - Creates a new unique filename by appending a number to it. This method tests that - the filename created does not exist. - - This process can be slow as it increments the number sequentially from a specified - starting point until it finds a number which produces a filename which does not - exist. - - Example: - Original Filename trace.log - Target Filename trace.15.log - - Original file name. - Number starting point - File name suitable for archiving - - - - Gets or sets the maximum number of archive files that should be kept. - - - - - Characters determining the start of the . - - - - - Characters determining the end of the . - - - - - Replace the pattern with the specified String. - - - - - - - File name which is used as template for matching and replacements. - It is expected to contain a pattern to match. - - - - - The begging position of the - within the . -1 is returned - when no pattern can be found. - - - - - The ending position of the - within the . -1 is returned - when no pattern can be found. - - - - - Line ending mode. - - - - - Insert platform-dependent end-of-line sequence after each line. - - - - - Insert CR LF sequence (ASCII 13, ASCII 10) after each line. - - - - - Insert CR character (ASCII 13) after each line. - - - - - Insert LF character (ASCII 10) after each line. - - - - - Do not insert any line ending. - - - - - Initializes a new instance of . - - The mode name. - The new line characters to be used. - - - - Returns the that corresponds to the supplied . - - - The textual representation of the line ending mode, such as CRLF, LF, Default etc. - Name is not case sensitive. - - The value, that corresponds to the . - There is no line ending mode with the specified name. - - - - Compares two objects and returns a - value indicating whether the first one is equal to the second one. - - The first level. - The second level. - The value of mode1.NewLineCharacters == mode2.NewLineCharacters. - - - - Compares two objects and returns a - value indicating whether the first one is not equal to the second one. - - The first mode - The second mode - The value of mode1.NewLineCharacters != mode2.NewLineCharacters. - - - - Returns a string representation of the log level. - - Log level name. - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms - and data structures like a hash table. - - - - - Determines whether the specified is - equal to this instance. - - The to compare with - this instance. - - Value of true if the specified - is equal to this instance; otherwise, false. - - - The parameter is null. - - - - - Gets the name of the LineEndingMode instance. - - - - - Gets the new line characters (value) of the LineEndingMode instance. - - - - - Provides a type converter to convert objects to and from other representations. - - - - - Returns whether this converter can convert an object of the given type to the type of this converter, using the specified context. - - - true if this converter can perform the conversion; otherwise, false. - - An that provides a format context. A that represents the type you want to convert from. - - - - Converts the given object to the type of this converter, using the specified context and culture information. - - - An that represents the converted value. - - An that provides a format context. The to use as the current culture. The to convert. The conversion cannot be performed. - - - - Sends log messages to a NLog Receiver Service (using WCF or Web Services). - - Documentation on NLog Wiki - - - - Initializes a new instance of the class. - - - - - Called when log events are being sent (test hook). - - The events. - The async continuations. - True if events should be sent, false to stop processing them. - - - - Writes logging event to the log target. Must be overridden in inheriting - classes. - - Logging event to be written out. - - - - Writes an array of logging events to the log target. By default it iterates on all - events and passes them to "Append" method. Inheriting classes can use this method to - optimize batch writes. - - Logging events to be written out. - - - - Flush any pending log messages asynchronously (in case of asynchronous targets). - - The asynchronous continuation. - - - - Creating a new instance of WcfLogReceiverClient - - Inheritors can override this method and provide their own - service configuration - binding and endpoint address - - - - - - Creating a new instance of IWcfLogReceiverClient - - Inheritors can override this method and provide their own - service configuration - binding and endpoint address - - - virtual is used by endusers - - - - Gets or sets the endpoint address. - - The endpoint address. - - - - - Gets or sets the name of the endpoint configuration in WCF configuration file. - - The name of the endpoint configuration. - - - - - Gets or sets a value indicating whether to use binary message encoding. - - - - - - Gets or sets a value indicating whether to use a WCF service contract that is one way (fire and forget) or two way (request-reply) - - - - - - Gets or sets the client ID. - - The client ID. - - - - - Gets the list of parameters. - - The parameters. - - - - - Gets or sets a value indicating whether to include per-event properties in the payload sent to the server. - - - - - - Sends log messages by email using SMTP protocol. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- -

- Mail target works best when used with BufferingWrapper target - which lets you send multiple log messages in single mail -

-

- To set up the buffered mail target in the configuration file, - use the following syntax: -

- -

- To set up the buffered mail target programmatically use code like this: -

- -
-
- - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - Renders the logging event message and adds it to the internal ArrayList of log messages. - - The logging event. - - - - Renders an array logging events. - - Array of logging events. - - - - Initializes the target. Can be used by inheriting classes - to initialize logging. - - - - - Create mail and send with SMTP - - event printed in the body of the event - - - - Create buffer for body - - all events - first event for header - last event for footer - - - - - Set properties of - - last event for username/password - client to set properties on - - - - Create key for grouping. Needed for multiple events in one mailmessage - - event for rendering layouts - string to group on - - - - Append rendered layout to the stringbuilder - - append to this - event for rendering - append if not null - - - - Create the mailmessage with the addresses, properties and body. - - - - - Render and add the addresses to - - Addresses appended to this list - layout with addresses, ; separated - event for rendering the - added a address? - - - - Gets or sets sender's email address (e.g. joe@domain.com). - - - - - - Gets or sets recipients' email addresses separated by semicolons (e.g. john@domain.com;jane@domain.com). - - - - - - Gets or sets CC email addresses separated by semicolons (e.g. john@domain.com;jane@domain.com). - - - - - - Gets or sets BCC email addresses separated by semicolons (e.g. john@domain.com;jane@domain.com). - - - - - - Gets or sets a value indicating whether to add new lines between log entries. - - A value of true if new lines should be added; otherwise, false. - - - - - Gets or sets the mail subject. - - - - - - Gets or sets mail message body (repeated for each log message send in one mail). - - Alias for the Layout property. - - - - - Gets or sets encoding to be used for sending e-mail. - - - - - - Gets or sets a value indicating whether to send message as HTML instead of plain text. - - - - - - Gets or sets SMTP Server to be used for sending. - - - - - - Gets or sets SMTP Authentication mode. - - - - - - Gets or sets the username used to connect to SMTP server (used when SmtpAuthentication is set to "basic"). - - - - - - Gets or sets the password used to authenticate against SMTP server (used when SmtpAuthentication is set to "basic"). - - - - - - Gets or sets a value indicating whether SSL (secure sockets layer) should be used when communicating with SMTP server. - - . - - - - Gets or sets the port number that SMTP Server is listening on. - - - - - - Gets or sets a value indicating whether the default Settings from System.Net.MailSettings should be used. - - - - - - Specifies how outgoing email messages will be handled. - - - - - - Gets or sets the folder where applications save mail messages to be processed by the local SMTP server. - - - - - - Gets or sets the priority used for sending mails. - - - - - Gets or sets a value indicating whether NewLine characters in the body should be replaced with
tags. -
- Only happens when is set to true. -
- - - Gets or sets a value indicating the SMTP client timeout. - - Warning: zero is not infinit waiting - - - - Writes log messages to an ArrayList in memory for programmatic retrieval. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- -
-
- - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - Renders the logging event message and adds it to the internal ArrayList of log messages. - - The logging event. - - - - Gets the list of logs gathered in the . - - - - - A parameter to MethodCall. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The layout to use for parameter value. - - - - Initializes a new instance of the class. - - Name of the parameter. - The layout. - - - - Initializes a new instance of the class. - - The name of the parameter. - The layout. - The type of the parameter. - - - - Gets or sets the name of the parameter. - - - - - - Gets or sets the type of the parameter. - - - - - - Gets or sets the layout that should be use to calculate the value for the parameter. - - - - - - Calls the specified static method on each log message and passes contextual parameters to it. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- -
-
- - - The base class for all targets which call methods (local or remote). - Manages parameters and type coercion. - - - - - Initializes a new instance of the class. - - - - - Prepares an array of parameters to be passed based on the logging event and calls DoInvoke(). - - - The logging event. - - - - - Calls the target method. Must be implemented in concrete classes. - - Method call parameters. - The continuation. - - - - Calls the target method. Must be implemented in concrete classes. - - Method call parameters. - - - - Gets the array of parameters to be passed. - - - - - - Initializes the target. - - - - - Calls the specified Method. - - Method parameters. - - - - Gets or sets the class name. - - - - - - Gets or sets the method name. The method must be public and static. - - - - - - The action to be taken when there are more connections then the max. - - - - - Just allow it. - - - - - Discard the connection item. - - - - - Block until there's more room in the queue. - - - - - Action that should be taken if the message overflows. - - - - - Report an error. - - - - - Split the message into smaller pieces. - - - - - Discard the entire message. - - - - - Represents a parameter to a NLogViewer target. - - - - - Initializes a new instance of the class. - - - - - Gets or sets viewer parameter name. - - - - - - Gets or sets the layout that should be use to calcuate the value for the parameter. - - - - - - Discards log messages. Used mainly for debugging and benchmarking. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- -
-
- - - Does nothing. Optionally it calculates the layout text but - discards the results. - - The logging event. - - - - Gets or sets a value indicating whether to perform layout calculation. - - - - - - Outputs log messages through the OutputDebugString() Win32 API. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- -
-
- - - Outputs the rendered logging event through the OutputDebugString() Win32 API. - - The logging event. - - - - Increments specified performance counter on each write. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- -
- - TODO: - 1. Unable to create a category allowing multiple counter instances (.Net 2.0 API only, probably) - 2. Is there any way of adding new counters without deleting the whole category? - 3. There should be some mechanism of resetting the counter (e.g every day starts from 0), or auto-switching to - another counter instance (with dynamic creation of new instance). This could be done with layouts. - -
- - - Initializes a new instance of the class. - - - - - Performs installation which requires administrative permissions. - - The installation context. - - - - Performs uninstallation which requires administrative permissions. - - The installation context. - - - - Determines whether the item is installed. - - The installation context. - - Value indicating whether the item is installed or null if it is not possible to determine. - - - - - Increments the configured performance counter. - - Log event. - - - - Closes the target and releases any unmanaged resources. - - - - - Ensures that the performance counter has been initialized. - - True if the performance counter is operational, false otherwise. - - - - Gets or sets a value indicating whether performance counter should be automatically created. - - - - - - Gets or sets the name of the performance counter category. - - - - - - Gets or sets the name of the performance counter. - - - - - - Gets or sets the performance counter instance name. - - - - - - Gets or sets the counter help text. - - - - - - Gets or sets the performance counter type. - - - - - - The value by which to increment the counter. - - - - - - SMTP authentication modes. - - - - - No authentication. - - - - - Basic - username and password. - - - - - NTLM Authentication. - - - - - Marks class as a logging target and assigns a name to it. - - - - - Initializes a new instance of the class. - - Name of the target. - - - - Gets or sets a value indicating whether to the target is a wrapper target (used to generate the target summary documentation page). - - - - - Gets or sets a value indicating whether to the target is a compound target (used to generate the target summary documentation page). - - - - - Sends log messages through System.Diagnostics.Trace. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- -
-
- - - Writes the specified logging event to the facility. - If the log level is greater than or equal to it uses the - method, otherwise it uses - method. - - The logging event. - - - - Web service protocol. - - - - - Use SOAP 1.1 Protocol. - - - - - Use SOAP 1.2 Protocol. - - - - - Use HTTP POST Protocol. - - - - - Use HTTP GET Protocol. - - - - - Calls the specified web service on each log message. - - Documentation on NLog Wiki - - The web service must implement a method that accepts a number of string parameters. - - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- -

The example web service that works with this example is shown below

- -
-
- - - Initializes a new instance of the class. - - - - - Calls the target method. Must be implemented in concrete classes. - - Method call parameters. - - - - Invokes the web service method. - - Parameters to be passed. - The continuation. - - - - Helper for creating soap POST-XML request - - - - - - - - - - Write from input to output. Fix the UTF-8 bom - - - - - - - - - Gets or sets the web service URL. - - - - - - Gets or sets the Web service method name. Only used with Soap. - - - - - - Gets or sets the Web service namespace. Only used with Soap. - - - - - - Gets or sets the protocol to be used when calling web service. - - - - - - Should we include the BOM (Byte-order-mark) for UTF? Influences the property. - - This will only work for UTF-8. - - - - - Gets or sets the encoding. - - - - - - Win32 file attributes. - - - For more information see http://msdn.microsoft.com/library/default.asp?url=/library/en-us/fileio/fs/createfile.asp. - - - - - Read-only file. - - - - - Hidden file. - - - - - System file. - - - - - File should be archived. - - - - - Device file. - - - - - Normal file. - - - - - File is temporary (should be kept in cache and not - written to disk if possible). - - - - - Sparse file. - - - - - Reparse point. - - - - - Compress file contents. - - - - - File should not be indexed by the content indexing service. - - - - - Encrypted file. - - - - - The system writes through any intermediate cache and goes directly to disk. - - - - - The system opens a file with no system caching. - - - - - Delete file after it is closed. - - - - - A file is accessed according to POSIX rules. - - - - - Asynchronous request queue. - - - - - Initializes a new instance of the AsyncRequestQueue class. - - Request limit. - The overflow action. - - - - Enqueues another item. If the queue is overflown the appropriate - action is taken as specified by . - - The log event info. - - - - Dequeues a maximum of count items from the queue - and adds returns the list containing them. - - Maximum number of items to be dequeued. - The array of log events. - - - - Clears the queue. - - - - - Gets or sets the request limit. - - - - - Gets or sets the action to be taken when there's no more room in - the queue and another request is enqueued. - - - - - Gets the number of requests currently in the queue. - - - - - Provides asynchronous, buffered execution of target writes. - - Documentation on NLog Wiki - -

- Asynchronous target wrapper allows the logger code to execute more quickly, by queueing - messages and processing them in a separate thread. You should wrap targets - that spend a non-trivial amount of time in their Write() method with asynchronous - target to speed up logging. -

-

- Because asynchronous logging is quite a common scenario, NLog supports a - shorthand notation for wrapping all targets with AsyncWrapper. Just add async="true" to - the <targets/> element in the configuration file. -

- - - ... your targets go here ... - - ]]> -
- -

- To set up the target in the configuration file, - use the following syntax: -

- -

- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -

- -
-
- - - Base class for targets wrap other (single) targets. - - - - - Returns the text representation of the object. Used for diagnostics. - - A string that describes the target. - - - - Flush any pending log messages (in case of asynchronous targets). - - The asynchronous continuation. - - - - Writes logging event to the log target. Must be overridden in inheriting - classes. - - Logging event to be written out. - - - - Gets or sets the target that is wrapped by this target. - - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The wrapped target. - - - - Initializes a new instance of the class. - - The wrapped target. - Maximum number of requests in the queue. - The action to be taken when the queue overflows. - - - - Waits for the lazy writer thread to finish writing messages. - - The asynchronous continuation. - - - - Initializes the target by starting the lazy writer timer. - - - - - Shuts down the lazy writer timer. - - - - - Starts the lazy writer thread which periodically writes - queued log messages. - - - - - Starts the lazy writer thread. - - - - - Adds the log event to asynchronous queue to be processed by - the lazy writer thread. - - The log event. - - The is called - to ensure that the log event can be processed in another thread. - - - - - Gets or sets the number of log events that should be processed in a batch - by the lazy writer thread. - - - - - - Gets or sets the time in milliseconds to sleep between batches. - - - - - - Gets or sets the action to be taken when the lazy writer thread request queue count - exceeds the set limit. - - - - - - Gets or sets the limit on the number of requests in the lazy writer thread request queue. - - - - - - Gets the queue of lazy writer thread requests. - - - - - The action to be taken when the queue overflows. - - - - - Grow the queue. - - - - - Discard the overflowing item. - - - - - Block until there's more room in the queue. - - - - - Causes a flush after each write on a wrapped target. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -

- -
-
- - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - Initializes a new instance of the class. - - The wrapped target. - - - - Forwards the call to the .Write() - and calls on it. - - Logging event to be written out. - - - - A target that buffers log events and sends them in batches to the wrapped target. - - Documentation on NLog Wiki - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The wrapped target. - - - - Initializes a new instance of the class. - - The wrapped target. - Size of the buffer. - - - - Initializes a new instance of the class. - - The wrapped target. - Size of the buffer. - The flush timeout. - - - - Flushes pending events in the buffer (if any). - - The asynchronous continuation. - - - - Initializes the target. - - - - - Closes the target by flushing pending events in the buffer (if any). - - - - - Adds the specified log event to the buffer and flushes - the buffer in case the buffer gets full. - - The log event. - - - - Gets or sets the number of log events to be buffered. - - - - - - Gets or sets the timeout (in milliseconds) after which the contents of buffer will be flushed - if there's no write in the specified period of time. Use -1 to disable timed flushes. - - - - - - Gets or sets a value indicating whether to use sliding timeout. - - - This value determines how the inactivity period is determined. If sliding timeout is enabled, - the inactivity timer is reset after each write, if it is disabled - inactivity timer will - count from the first event written to the buffer. - - - - - - A base class for targets which wrap other (multiple) targets - and provide various forms of target routing. - - - - - Initializes a new instance of the class. - - The targets. - - - - Returns the text representation of the object. Used for diagnostics. - - A string that describes the target. - - - - Writes logging event to the log target. - - Logging event to be written out. - - - - Flush any pending log messages for all wrapped targets. - - The asynchronous continuation. - - - - Gets the collection of targets managed by this compound target. - - - - - Provides fallback-on-error. - - Documentation on NLog Wiki - -

This example causes the messages to be written to server1, - and if it fails, messages go to server2.

-

- To set up the target in the configuration file, - use the following syntax: -

- -

- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -

- -
-
- - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The targets. - - - - Forwards the log event to the sub-targets until one of them succeeds. - - The log event. - - The method remembers the last-known-successful target - and starts the iteration from it. - If is set, the method - resets the target to the first target - stored in . - - - - - Gets or sets a value indicating whether to return to the first target after any successful write. - - - - - - Filtering rule for . - - - - - Initializes a new instance of the FilteringRule class. - - - - - Initializes a new instance of the FilteringRule class. - - Condition to be tested against all events. - Filter to apply to all log events when the first condition matches any of them. - - - - Gets or sets the condition to be tested. - - - - - - Gets or sets the resulting filter to be applied when the condition matches. - - - - - - Filters log entries based on a condition. - - Documentation on NLog Wiki - -

This example causes the messages not contains the string '1' to be ignored.

-

- To set up the target in the configuration file, - use the following syntax: -

- -

- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -

- -
-
- - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The wrapped target. - The condition. - - - - Checks the condition against the passed log event. - If the condition is met, the log event is forwarded to - the wrapped target. - - Log event. - - - - Gets or sets the condition expression. Log events who meet this condition will be forwarded - to the wrapped target. - - - - - - Impersonates another user for the duration of the write. - - Documentation on NLog Wiki - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The wrapped target. - - - - Initializes the impersonation context. - - - - - Closes the impersonation context. - - - - - Changes the security context, forwards the call to the .Write() - and switches the context back to original. - - The log event. - - - - Changes the security context, forwards the call to the .Write() - and switches the context back to original. - - Log events. - - - - Flush any pending log messages (in case of asynchronous targets). - - The asynchronous continuation. - - - - Gets or sets username to change context to. - - - - - - Gets or sets the user account password. - - - - - - Gets or sets Windows domain name to change context to. - - - - - - Gets or sets the Logon Type. - - - - - - Gets or sets the type of the logon provider. - - - - - - Gets or sets the required impersonation level. - - - - - - Gets or sets a value indicating whether to revert to the credentials of the process instead of impersonating another user. - - - - - - Helper class which reverts the given - to its original value as part of . - - - - - Initializes a new instance of the class. - - The windows impersonation context. - - - - Reverts the impersonation context. - - - - - Logon provider. - - - - - Use the standard logon provider for the system. - - - The default security provider is negotiate, unless you pass NULL for the domain name and the user name - is not in UPN format. In this case, the default provider is NTLM. - NOTE: Windows 2000/NT: The default security provider is NTLM. - - - - - Filters buffered log entries based on a set of conditions that are evaluated on a group of events. - - Documentation on NLog Wiki - - PostFilteringWrapper must be used with some type of buffering target or wrapper, such as - AsyncTargetWrapper, BufferingWrapper or ASPNetBufferingWrapper. - - -

- This example works like this. If there are no Warn,Error or Fatal messages in the buffer - only Info messages are written to the file, but if there are any warnings or errors, - the output includes detailed trace (levels >= Debug). You can plug in a different type - of buffering wrapper (such as ASPNetBufferingWrapper) to achieve different - functionality. -

-

- To set up the target in the configuration file, - use the following syntax: -

- -

- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -

- -
-
- - - Initializes a new instance of the class. - - - - - Evaluates all filtering rules to find the first one that matches. - The matching rule determines the filtering condition to be applied - to all items in a buffer. If no condition matches, default filter - is applied to the array of log events. - - Array of log events to be post-filtered. - - - - Gets or sets the default filter to be applied when no specific rule matches. - - - - - - Gets the collection of filtering rules. The rules are processed top-down - and the first rule that matches determines the filtering condition to - be applied to log events. - - - - - - Sends log messages to a randomly selected target. - - Documentation on NLog Wiki - -

This example causes the messages to be written to either file1.txt or file2.txt - chosen randomly on a per-message basis. -

-

- To set up the target in the configuration file, - use the following syntax: -

- -

- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -

- -
-
- - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The targets. - - - - Forwards the log event to one of the sub-targets. - The sub-target is randomly chosen. - - The log event. - - - - Repeats each log event the specified number of times. - - Documentation on NLog Wiki - -

This example causes each log message to be repeated 3 times.

-

- To set up the target in the configuration file, - use the following syntax: -

- -

- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -

- -
-
- - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The wrapped target. - The repeat count. - - - - Forwards the log message to the by calling the method times. - - The log event. - - - - Gets or sets the number of times to repeat each log message. - - - - - - Retries in case of write error. - - Documentation on NLog Wiki - -

This example causes each write attempt to be repeated 3 times, - sleeping 1 second between attempts if first one fails.

-

- To set up the target in the configuration file, - use the following syntax: -

- -

- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -

- -
-
- - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The wrapped target. - The retry count. - The retry delay milliseconds. - - - - Writes the specified log event to the wrapped target, retrying and pausing in case of an error. - - The log event. - - - - Gets or sets the number of retries that should be attempted on the wrapped target in case of a failure. - - - - - - Gets or sets the time to wait between retries in milliseconds. - - - - - - Distributes log events to targets in a round-robin fashion. - - Documentation on NLog Wiki - -

This example causes the messages to be written to either file1.txt or file2.txt. - Each odd message is written to file2.txt, each even message goes to file1.txt. -

-

- To set up the target in the configuration file, - use the following syntax: -

- -

- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -

- -
-
- - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The targets. - - - - Forwards the write to one of the targets from - the collection. - - The log event. - - The writes are routed in a round-robin fashion. - The first log event goes to the first target, the second - one goes to the second target and so on looping to the - first target when there are no more targets available. - In general request N goes to Targets[N % Targets.Count]. - - - - - Impersonation level. - - - - - Anonymous Level. - - - - - Identification Level. - - - - - Impersonation Level. - - - - - Delegation Level. - - - - - Logon type. - - - - - Interactive Logon. - - - This logon type is intended for users who will be interactively using the computer, such as a user being logged on - by a terminal server, remote shell, or similar process. - This logon type has the additional expense of caching logon information for disconnected operations; - therefore, it is inappropriate for some client/server applications, - such as a mail server. - - - - - Network Logon. - - - This logon type is intended for high performance servers to authenticate plaintext passwords. - The LogonUser function does not cache credentials for this logon type. - - - - - Batch Logon. - - - This logon type is intended for batch servers, where processes may be executing on behalf of a user without - their direct intervention. This type is also for higher performance servers that process many plaintext - authentication attempts at a time, such as mail or Web servers. - The LogonUser function does not cache credentials for this logon type. - - - - - Logon as a Service. - - - Indicates a service-type logon. The account provided must have the service privilege enabled. - - - - - Network Clear Text Logon. - - - This logon type preserves the name and password in the authentication package, which allows the server to make - connections to other network servers while impersonating the client. A server can accept plaintext credentials - from a client, call LogonUser, verify that the user can access the system across the network, and still - communicate with other servers. - NOTE: Windows NT: This value is not supported. - - - - - New Network Credentials. - - - This logon type allows the caller to clone its current token and specify new credentials for outbound connections. - The new logon session has the same local identifier but uses different credentials for other network connections. - NOTE: This logon type is supported only by the LOGON32_PROVIDER_WINNT50 logon provider. - NOTE: Windows NT: This value is not supported. - - - - - Writes log events to all targets. - - Documentation on NLog Wiki - -

This example causes the messages to be written to both file1.txt or file2.txt -

-

- To set up the target in the configuration file, - use the following syntax: -

- -

- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -

- -
-
- - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The targets. - - - - Forwards the specified log event to all sub-targets. - - The log event. - - - - Writes an array of logging events to the log target. By default it iterates on all - events and passes them to "Write" method. Inheriting classes can use this method to - optimize batch writes. - - Logging events to be written out. - - - - Current local time retrieved directly from DateTime.Now. - - - - - Defines source of current time. - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Converts the specified system time to the same form as the time value originated from this time source. - - The system originated time value to convert. - - The value of converted to the same form - as time values originated from this source. - - - - There are situations when NLog have to compare the time originated from TimeSource - to the time originated externally in the system. - To be able to provide meaningful result of such comparisons the system time must be expressed in - the same form as TimeSource time. - - - Examples: - - If the TimeSource provides time values of local time, it should also convert the provided - to the local time. - - If the TimeSource shifts or skews its time values, it should also apply - the same transform to the given . - - - - - - Gets current time. - - - - - Gets or sets current global time source used in all log events. - - - Default time source is . - - - - - Converts the specified system time to the same form as the time value originated from this time source. - - The system originated time value to convert. - - The value of converted to local time. - - - - - Gets current local time directly from DateTime.Now. - - - - - Current UTC time retrieved directly from DateTime.UtcNow. - - - - - Converts the specified system time to the same form as the time value originated from this time source. - - The system originated time value to convert. - - The value of converted to UTC time. - - - - - Gets current UTC time directly from DateTime.UtcNow. - - - - - Fast time source that updates current time only once per tick (15.6 milliseconds). - - - - - Gets raw uncached time from derived time source. - - - - - Gets current time cached for one system tick (15.6 milliseconds). - - - - - Fast local time source that is updated once per tick (15.6 milliseconds). - - - - - Converts the specified system time to the same form as the time value originated from this time source. - - The system originated time value to convert. - - The value of converted to local time. - - - - - Gets uncached local time directly from DateTime.Now. - - - - - Fast UTC time source that is updated once per tick (15.6 milliseconds). - - - - - Converts the specified system time to the same form as the time value originated from this time source. - - The system originated time value to convert. - - The value of converted to UTC time. - - - - - Gets uncached UTC time directly from DateTime.UtcNow. - - - - - Marks class as a time source and assigns a name to it. - - - - - Initializes a new instance of the class. - - Name of the time source. - -
-
diff --git a/packages/FAKE.4.11.3/tools/Nancy.Authentication.Stateless.dll b/packages/FAKE.4.11.3/tools/Nancy.Authentication.Stateless.dll deleted file mode 100644 index 4e3fbac..0000000 Binary files a/packages/FAKE.4.11.3/tools/Nancy.Authentication.Stateless.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/Nancy.Authentication.Stateless.xml b/packages/FAKE.4.11.3/tools/Nancy.Authentication.Stateless.xml deleted file mode 100644 index 01e9caa..0000000 --- a/packages/FAKE.4.11.3/tools/Nancy.Authentication.Stateless.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - Nancy.Authentication.Stateless - - - - - Nancy stateless authentication implementation - - - - - Enables stateless authentication for the application - - Pipelines to add handlers to (usually "this") - Stateless authentication configuration - - - - Enables stateless authentication for a module - - Module to add handlers to (usually "this") - Stateless authentication configuration - - - - Gets the pre request hook for loading the authenticated user's details - from apikey given in request. - - Stateless authentication configuration to use - Pre request hook delegate - - - - Configuration options for stateless authentication - - - - - Initializes a new instance of the class. - - - - - Gets a value indicating whether the configuration is valid or not. - - - - diff --git a/packages/FAKE.4.11.3/tools/Nancy.Hosting.Self.dll b/packages/FAKE.4.11.3/tools/Nancy.Hosting.Self.dll deleted file mode 100644 index 6a7d39a..0000000 Binary files a/packages/FAKE.4.11.3/tools/Nancy.Hosting.Self.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/Nancy.Hosting.Self.xml b/packages/FAKE.4.11.3/tools/Nancy.Hosting.Self.xml deleted file mode 100644 index 209f26a..0000000 --- a/packages/FAKE.4.11.3/tools/Nancy.Hosting.Self.xml +++ /dev/null @@ -1,216 +0,0 @@ - - - - Nancy.Hosting.Self - - - - - A helper class that checks for a header against a list of headers that should be ignored - when populating the headers of an object. - - - - - Determines if a header is ignored when populating the headers of an - object. - - The name of the header. - true if the header is ignored; otherwise, false. - - - - Configuration for automatic url reservation creation - - - - - Gets or sets a value indicating whether url reservations - are automatically created when necessary. - Defaults to false. - - - - - Gets or sets a value for the user to use to create the url reservations for. - Defaults to the "Everyone" group. - - - - - Helpers for UAC - - - - - Run an executable elevated - - File to execute - Arguments to pass to the executable - True if successful, false otherwise - - - - Host configuration for the self host - - - - - Gets or sets a property that determines if localhost uris are - rewritten to htp://+:port/ style uris to allow for listening on - all ports, but requiring either a url reservation, or admin - access - Defaults to true. - - - - - Configuration around automatically creating url reservations - - - - - Gets or sets a property that determines if Transfer-Encoding: Chunked is allowed - for the response instead of Content-Length (default: true). - - - - - Gets or sets a property that provides a callback to be called - if there's an unhandled exception in the self host. - Note: this will *not* be called for normal nancy Exceptions - that are handled by the Nancy handlers. - Defaults to writing to debug out. - - - - - Gets or sets a property that determines whether client certificates - are enabled or not. - When set to true the self host will request a client certificate if the - request is running over SSL. - Defaults to false. - - - - - Gets or sets a property determining if base uri matching can fall back to just - using Authority (Schema + Host + Port) as base uri if it cannot match anything in - the known list. This should only be set to True if you have issues with port forwarding - (e.g. on Azure). - - - - - Allows to host Nancy server inside any application - console or windows service. - - - NancyHost uses internally. Therefore, it requires full .net 4.0 profile (not client profile) - to run. will launch a thread that will listen for requests and then process them. Each request is processed in - its own execution thread. NancyHost needs in order to be used from another appdomain under - mono. Working with AppDomains is necessary if you want to unload the dependencies that come with NancyHost. - - - - - Initializes a new instance of the class for the specified . - Uses the default configuration - - The s that the host will listen to. - - - - Initializes a new instance of the class for the specified . - Uses the specified configuration. - - The s that the host will listen to. - Configuration to use - - - - Initializes a new instance of the class for the specified , using - the provided . - Uses the default configuration - - The bootstrapper that should be used to handle the request. - The s that the host will listen to. - - - - Initializes a new instance of the class for the specified , using - the provided . - Uses the specified configuration. - - The bootstrapper that should be used to handle the request. - Configuration to use - The s that the host will listen to. - - - - Initializes a new instance of the class for the specified , using - the provided . - Uses the default configuration - - The that the host will listen to. - The bootstrapper that should be used to handle the request. - - - - Initializes a new instance of the class for the specified , using - the provided . - Uses the specified configuration. - - The that the host will listen to. - The bootstrapper that should be used to handle the request. - Configuration to use - - - - Stops the host if it is running. - - - - - Start listening for incoming requests with the given configuration - - - - - Stop listening for incoming requests. - - - - - Executes NetSh commands - - - - - Add a url reservation - - Url to add - User to add the reservation for - True if successful, false otherwise. - - - - Exception for when automatic address reservation creation fails. - Provides the user with manual instructions. - - - - - Gets a message that describes the current exception. - - - The error message that explains the reason for the exception, or an empty string(""). - - 1 - - - - Extension methods for working with instances. - - - - diff --git a/packages/FAKE.4.11.3/tools/Nancy.Serialization.JsonNet.dll b/packages/FAKE.4.11.3/tools/Nancy.Serialization.JsonNet.dll deleted file mode 100644 index ba616bc..0000000 Binary files a/packages/FAKE.4.11.3/tools/Nancy.Serialization.JsonNet.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/Nancy.dll b/packages/FAKE.4.11.3/tools/Nancy.dll deleted file mode 100644 index efb3da7..0000000 Binary files a/packages/FAKE.4.11.3/tools/Nancy.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/Nancy.xml b/packages/FAKE.4.11.3/tools/Nancy.xml deleted file mode 100644 index 79c3d5c..0000000 --- a/packages/FAKE.4.11.3/tools/Nancy.xml +++ /dev/null @@ -1,13315 +0,0 @@ - - - - Nancy - - - - - Pipeline items to execute - - - - - Add an item to the start of the pipeline - - Item to add - - - - Add an item to the start of the pipeline - - Item to add - - - - Add an item to the start of the pipeline - - Item to add - - Whether to replace an existing item with the same name in its current place, - rather than at the position requested. Defaults to false. - - - - - Add an item to the start of the pipeline - - Item to add - - Whether to replace an existing item with the same name in its current place, - rather than at the position requested. Defaults to false. - - - - - Add an item to the end of the pipeline - - Item to add - - - - Add an item to the end of the pipeline - - Item to add - - - - Add an item to the end of the pipeline - - Item to add - - Whether to replace an existing item with the same name in its current place, - rather than at the position requested. Defaults to false. - - - - - Add an item to the end of the pipeline - - Item to add - - Whether to replace an existing item with the same name in its current place, - rather than at the position requested. Defaults to false. - - - - - Add an item to a specific place in the pipeline. - - Index to add at - Item to add - - - - Add an item to a specific place in the pipeline. - - Index to add at - Item to add - - - - Add an item to a specific place in the pipeline. - - Index to add at - Item to add - - Whether to replace an existing item with the same name in its current place, - rather than at the position requested. Defaults to false. - - - - - Add an item to a specific place in the pipeline. - - Index to add at - Item to add - - Whether to replace an existing item with the same name in its current place, - rather than at the position requested. Defaults to false. - - - - - Insert an item before a named item. - If the named item does not exist the item is inserted at the start of the pipeline. - - Name of the item to insert before - Item to insert - - - - Insert an item before a named item. - If the named item does not exist the item is inserted at the start of the pipeline. - - Name of the item to insert before - Item to insert - - - - Insert an item before a named item. - If the named item does not exist the item is inserted at the start of the pipeline. - - Name of the item to insert before - Item to insert - - - - Insert an item before a named item. - If the named item does not exist the item is inserted at the start of the pipeline. - - Name of the item to insert before - Item to insert - - - - Insert an item after a named item. - If the named item does not exist the item is inserted at the end of the pipeline. - - Name of the item to insert after - Item to insert - - - - Insert an item after a named item. - If the named item does not exist the item is inserted at the end of the pipeline. - - Name of the item to insert after - Item to insert - - - - Insert an item after a named item. - If the named item does not exist the item is inserted at the end of the pipeline. - - Name of the item to insert after - Item to insert - - - - Insert an item after a named item. - If the named item does not exist the item is inserted at the end of the pipeline. - - Name of the item to insert after - Item to insert - - - - Remove a named pipeline item - - Name - Index of item that was removed or -1 if nothing removed - - - - Wraps a sync delegate into it's async form - - Sync pipeline instance - Async pipeline instance - - - - Gets the current pipeline items - - - - - Gets the current pipeline item delegates - - - - - Scans the app domain for assemblies and types - - - - - Nancy core assembly - - - - - App domain type cache - - - - - App domain assemblies cache - - - - - Indicates whether the all Assemblies, that references a Nancy assembly, have already been loaded - - - - - The default assemblies for scanning. - Includes the nancy assembly and anything referencing a nancy assembly - - - - - Add assemblies to the list of assemblies to scan for Nancy types - - One or more assembly names - - - - Add assemblies to the list of assemblies to scan for Nancy types - - One of more assemblies - - - - Add predicates for determining which assemblies to scan for Nancy types - - One or more predicates - - - - Load assemblies from a the app domain base directory matching a given wildcard. - Assemblies will only be loaded if they aren't already in the appdomain. - - Wildcard to match the assemblies to load - - - - Load assemblies from a given directory matching a given wildcard. - Assemblies will only be loaded if they aren't already in the appdomain. - - Directory containing the assemblies - Wildcard to match the assemblies to load - - - - Refreshes the type cache if additional assemblies have been loaded. - Note: This is called automatically if assemblies are loaded using LoadAssemblies. - - - - - Updates the assembly cache from the appdomain - - - - - Loads any assembly that references a Nancy assembly. - - - - - Gets all types implementing a particular interface/base class - - Type to search for - An of types. - Will scan with . - - - - Gets all types implementing a particular interface/base class - - Type to search for - A value to determine which type set to scan in. - An of types. - - - - Gets all types implementing a particular interface/base class - - Type to search for - An of types. - Will scan with . - - - - Gets all types implementing a particular interface/base class - - Type to search for - A value to determine which type set to scan in. - An of types. - - - - Returns the directories containing dll files. It uses the default convention as stated by microsoft. - - - - - - Gets or sets a set of rules for which assemblies are scanned - Defaults to just assemblies that have references to nancy, and nancy - itself. - Each item in the enumerable is a delegate that takes the assembly and - returns true if it is to be included. Returning false doesn't mean it won't - be included as a true from another delegate will take precedence. - - - - - Gets app domain types. - - - - - Gets app domain types. - - - - - Provides a hook to perform registrations during application startup. - - - - - Provides a hook to perform registrations during application startup. - - - - - Gets the type registrations to register for this startup task - - - - - Gets the collection registrations to register for this startup task - - - - - Gets the instance registrations to register for this startup task - - - - - Provides a hook to execute code during request startup. - - - - - Perform any initialisation tasks - - Application pipelines - The current context - - - - Helper class for providing application registrations - - - - - Scans for the implementation of and registers it. - - Lifetime of the registration, defaults to singleton - The to scan for and register as. - - - - Scans for all implementations of and registers them. - - Lifetime of the registration, defaults to singleton - The to scan for and register as. - - - - Registers the types provided by the parameters - as . - - The to register as. - The types to register. - Lifetime of the registration, defaults to singleton - - - - Registers the type provided by the parameter - as . - - Lifetime of the registration, defaults to singleton - The to register as. - The to register as . - - - - Registers an instance as . - - The to register as. - The instance to register. - - - - Scans for a that implements . If found, then it - will be used for the registration, else it will use . - - Lifetime of the registration, defaults to singleton - The to register as. - The implementation of that will be use if no other implementation can be found. - - When scanning, it will exclude the assembly that the instance is defined in and it will also ignore - the type specified by . - - - - - Scans for an implementation of and registers it if found. If no implementation could - be found, it will retrieve an instance of using the provided , - which will be used in the registration. - - The to register as. - Factory that provides an instance of . - When scanning, it will exclude the assembly that the instance is defined in - - - - Scans for all implementations of . If no implementations could be found, then it - will register the types specified by . - - Lifetime of the registration, defaults to singleton - The to register as. - The types to register if non could be located while scanning. - - When scanning, it will exclude the assembly that the instance is defined in and it will also ignore - the types specified by . - - - - - Scans for all implementations of and registers them, followed by the - types defined by the parameter. - - The to register as. - The types to register last. - Lifetime of the registration, defaults to singleton - - When scanning, it will exclude the assembly that the instance is defined in and it will also ignore - the types specified by . - - - - - Gets the collection registrations to register for this startup task - - - - - Gets the instance registrations to register for this startup task - - - - - Gets the type registrations to register for this startup task - - - - - Exception that is raised from inside the type or one of - the inheriting types. - - - - - Initializes a new instance of the class, with - the provided . - - The message that describes the error. - - - - Initializes a new instance of the class, with - the provided and . - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - - - - Represents a type to be registered multiple times into the - container to later be resolved using an IEnumerable{RegistrationType} - constructor dependency. - - - - - Base class for container registrations - - - - - Checks if all implementation types are assignable from the registration type, otherwise throws an exception. - - The implementation types. - One or more of the implementation types is not assignable from the registration type. - The property must be assigned before the method is invoked. - - - - Gets the lifetime of the registration - - - - - Registration type i.e. IMyInterface - - - - - Represents a type to be registered multiple times into the - container to later be resolved using an IEnumerable{RegistrationType} - constructor dependency. - - Registration type i.e. IMyInterface - Collection of implementation type i.e. MyClassThatImplementsIMyInterface - Lifetime to register the type as - - - - Collection of implementation type i.e. MyClassThatImplementsIMyInterface - - - - - Application startup task that attempts to locate a favicon. The startup will first scan all - folders in the path defined by the provided and if it cannot - find one, it will fall back and use the default favicon that is embedded in the Nancy.dll file. - - - - - Provides a hook to execute code during application startup. - - - - - Perform any initialisation tasks - - Application pipelines - - - - Initializes a new instance of the class, with the - provided instance. - - The that should be used to scan for a favicon. - - - - Perform any initialisation tasks - - Application pipelines - - - - Gets the default favicon - - A byte array, containing a favicon.ico file. - - - - - The pre-request hook - - - The PreRequest hook is called prior to processing a request. If a hook returns - a non-null response then processing is aborted and the response provided is - returned. - - - - - - - The post-request hook - - - The post-request hook is called after the response is created. It can be used - to rewrite the response or add/remove items from the context. - - - - - - - The error hook - - - The error hook is called if an exception is thrown at any time during the pipeline. - If no error hook exists a standard InternalServerError response is returned - - - - - - Represents an instance to be registered into the container - - - - - Initializes a new instance of the class. - - The registration type. - The implementation. - - - - Implementation object instance i.e. instance of MyClassThatImplementsIMyInterface - - - - - Represents the lifetime of a container registration - - - - - Transient lifetime - each request to the container for - the type will result in a new version being returned. - - - - - Singleton - each request to the container for the type - will result in the same instance being returned. - - - - - PerRequest - within the context of each request each request - for the type will result in the same instance being returned. - Different requests will have different versions. - - - - - Exception raised when the discovers more than one - implementation in the loaded assemblies. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message that describes the error. - - - - Initializes a new instance of the class. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. - - - - Initializes a new instance of the class. - - The provider types. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - - - - Stores the provider types. - - The provider types. - - - - Gets the provider types. - - - The provider types. - - - - - Returns a more friendly and informative message if the list of providers is available. - - - Message generated will be of the format: - - More than one IRootPathProvider was found: - Nancy.Tests.Functional.Tests.CustomRootPathProvider2 - Nancy.Tests.Functional.Tests.CustomRootPathProvider - and since we do not know which one you want to use, you need to override the RootPathProvider property on your bootstrapper and specify which one to use. Sorry for the inconvenience. - - - - - - Configuration class for Nancy's internals. - Contains implementation types/configuration for Nancy that usually - do not require overriding in "general use". - - - - - Default Nancy configuration with specific overloads - - Configuration builder for overriding the default configuration properties. - Nancy configuration instance - - - - Returns the configuration types as a TypeRegistration collection - - TypeRegistration collection representing the configuration types - - - - Returns the collection configuration types as a CollectionTypeRegistration collection - - CollectionTypeRegistration collection representing the configuration types - - - - Gets the Nancy default configuration - - - - - Gets a value indicating whether the configuration is valid. - - - - - Default implementation of the Nancy pipelines - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class and clones the hooks from - the provided instance. - - - - - - The pre-request hook - - - The PreRequest hook is called prior to processing a request. If a hook returns - a non-null response then processing is aborted and the response provided is - returned. - - - - - - - The post-request hook - - - The post-request hook is called after the response is created. It can be used - to rewrite the response or add/remove items from the context. - - - - - - - The error hook - - - The error hook is called if an exception is thrown at any time during the pipeline. - If no error hook exists a standard InternalServerError response is returned - - - - - - Determines which set of types that the should scan in. - - - - - All available types. - - - - - Only in types that are defined in the Nancy assembly. - - - - - Only types that are defined outside the Nancy assembly. - - - - - Only Namespaces that starts with 'Nancy' - - - - - Only Namespaces that does not start with Nancy - - - - - Collection of accept header coercions - - - - - Built in functions for coercing accept headers. - - - - - - Adds a default accept header if there isn't one. - - Current headers - Context - Modified headers or original if no modification required - - - - Replaces the accept header of stupid browsers that request XML instead - of HTML. - - Current headers - Context - Modified headers or original if no modification required - - - - Boosts the priority of HTML for browsers that ask for xml and html with the - same priority. - - Current headers - Context - Modified headers or original if no modification required - - - - Built in functions for determining current culture - - - - - - Checks to see if the Form has a CurrentCulture key. - - NancyContext - CultureInfo if found in Form otherwise null - - - - Checks to see if the first argument in the Path can be used to make a CultureInfo. - - NancyContext - CultureInfo if found in Path otherwise null - - - - Checks to see if the AcceptLanguage in the Headers can be used to make a CultureInfo. Uses highest weighted if multiple defined. - - NancyContext - CultureInfo if found in Headers otherwise null - - - - Checks to see if the Session has a CurrentCulture key - - NancyContext - CultureInfo if found in Session otherwise null - - - - Checks to see if the Cookies has a CurrentCulture key - - NancyContext - CultureInfo if found in Cookies otherwise null - - - - Uses the Thread.CurrentThread.CurrentCulture - - NancyContext - CultureInfo from CurrentThread - - - - Validates culture name - - Culture name eg\en-GB - True/False if valid culture - - - - Gets a set of all valid cultures - - - - - Collection class for static culture conventions - - - - - Creates a new instance of CultureConventions - - - - - - Wires up the default conventions for the accept header coercion - - - - - Provides Nancy convention defaults and validation - - - - - Initialise any conventions this class "owns" - - Convention object instance - - - - Asserts that the conventions that this class "owns" are valid - - Conventions object instance - Tuple containing true/false for valid/invalid, and any error messages - - - - Initialise culture conventions - - - - - - Determine if culture conventions are valid - - - - - - - Setup default conventions - - - - - - Defines the default static contents conventions. - - - - - Initialise any conventions this class "owns". - - Convention object instance. - - - - Asserts that the conventions that this class "owns" are valid - - Conventions object instance. - Tuple containing true/false for valid/invalid, and any error messages. - - - - Defines the default static contents conventions. - - - - - Initialise any conventions this class "owns". - - Convention object instance. - - - - Asserts that the conventions that this class "owns" are valid. - - Conventions object instance. - Tuple containing true/false for valid/invalid, and any error messages. - - - - Nancy configurable conventions - - - - - Discovered conventions - - - - - Initializes a new instance of the class. - - - - - Validates the conventions - - A tuple containing a flag indicating validity, and any error messages - - - - Gets the instance registrations for registering into the container - - Enumeration of InstanceRegistration types - - - - Locates all the default conventions and calls them in - turn to build up the default conventions. - - - - - Gets or sets the conventions for locating view templates - - - - - Gets or sets the conventions for locating and serving static content - - - - - Gets or sets the conventions for coercing accept headers from their source - values to the real values for content negotiation - - - - - - Gets or sets the conventions for determining request culture - - - - - Helper class for defining directory-based conventions for static contents. - - - - - Adds a directory-based convention for static convention. - - The path that should be matched with the request. - The path to where the content is stored in your application, relative to the root. If this is then it will be the same as . - A list of extensions that is valid for the conventions. If not supplied, all extensions are valid. - A instance for the requested static contents if it was found, otherwise . - - - - Adds a file-based convention for static convention. - - The file that should be matched with the request. - The file that should be served when the requested path is matched. - - - - Returns whether the given filename is contained within the content folder - - Content root path - Filename requested - True if contained within the content root, false otherwise - - - - Used to uniquely identify a request. Needed for when two Nancy applications want to serve up static content of the same - name from within the same AppDomain. - - - - - The path of the static content for which this response is being issued - - - - - The root folder path of the Nancy application for which this response will be issued - - - - - Nancy static convention helper - - - - - Extension method for NancyConventions - - conventions.MapStaticContent((File, Directory) => - { - File["/page.js"] = "page.js"; - Directory["/images"] = "images"; - }); - - - The conventions to add to. - The callback method allows you to describe the static content - - - - Collection class for static content conventions - - - - - Extension methods to adding static content conventions. - - - - - Adds a directory-based convention for static convention. - - The conventions to add to. - The path that should be matched with the request. - The path to where the content is stored in your application, relative to the root. If this is then it will be the same as . - A list of extensions that is valid for the conventions. If not supplied, all extensions are valid. - - - - Adds a directory-based convention for static convention. - - The conventions to add to. - The file that should be matched with the request. - The file that should be served when the requested path is matched. - - - - Nancy static directory convention helper - - - - - Creates a new instance of StaticDirectoryContent - - NancyConventions, to which static directories get added - - - - Adds a new static directory to the nancy conventions - - The route of the file - A list of extensions that is valid for the conventions. If not supplied, all extensions are valid - - - - Nancy static file convention helper - - - - - Creates a new instance of StaticFileContent - - NancyConventions, to which static files get added - - - - Adds a new static file to the nancy conventions - - The route of the file - - - - Determines current culture for context - - - - - Provides current culture for Nancy context - - - - - Determine current culture for NancyContext - - NancyContext - CultureInfo - - - - Creates a new instance of DefaultCultureService - - CultureConventions to use for determining culture - - - - Determine current culture for NancyContext - - NancyContext - CultureInfo - - - - The default implementation of the interface. - - - - - Defines the functionality of a factory. - - - - - Creates a new instance. - - The instance that should be used by the response formatter. - An instance. - - - - Initializes a new instance of the class, with the - provided . - - - - - - Creates a new instance. - - The instance that should be used by the response formatter. - An instance. - - - - Default implementation of . - - - - - Defines the functionality to retrieve the root folder path of the current Nancy application. - - - - - Helper interface used to hide the base members from the fluent API to make it much cleaner - in Visual Studio intellisense. - - Created by Daniel Cazzulino http://www.clariusconsulting.net/blogs/kzu/archive/2008/03/10/58301.aspx - - - - Hides the method. - - - - - Hides the method. - - - - - Hides the method. - - - - - Hides the method. - - - - - Returns the root folder path of the current Nancy application. - - A containing the path of the root folder. - - - - Returns the root folder path of the current Nancy application. - - A containing the path of the root folder. - - - - The default static content provider that uses - to determine what static content to serve. - - - - - Provides static content delivery - - - - - Gets the static content response, if possible. - - Current context - Response if serving content, null otherwise - - - - Initializes a new instance of the class, using the - provided and . - - The current root path provider. - The static content conventions. - - - - Gets the static content response, if possible. - - Current context - Response if serving content, null otherwise - - - - Default implementation of the interface. - - - - - Defines the functionality for creating an instance. - - - - - Creates an instance. - - A instance. - An instance. - - - - Creates an instance. - - A instance. - An instance. - - - - Default implementation of the interface. - - - - - Provides request trace logging. - Uses a delegate to write to the log, rather than creating strings regardless - of whether the log is enabled or not. - - - - - Write to the log - - Log writing delegate - - - - Creates a new instance of the class. - - - - - Write to the log - - Log writing delegate - - - - Returns a string that represents the current object. - - - A string that represents the current object. - - - - - Settings for the diagnostics dashboard - - - - - Initializes a new instance of the class, - using the cryptographic - configuration. - - - - - Initializes a new instance of the class, - using the cryptographic - configuration. - - The to use with diagnostics. - - - - Gets or sets the name of the cookie used by the diagnostics dashboard. - - The default is __ncd - - - - Gets or sets the cryptography config to use for securing the diagnostics dashboard - - - - - Gets or sets password for accessing the diagnostics screen. - This should be secure :-) - - - - - Gets or sets the path that the diagnostics dashboard will be accessible on. - - The default is /_Nancy. The path should always start with a forward slash. - - - - The number of minutes that expiry of the diagnostics dashboard will be extended each time it is used. - - The default is 15 minutes. - - - - Gets a value indicating whether the configuration is valid - - - - - Provides a thread safe, limited size, collection of objects - If the collection is full the oldest item gets removed. - - Type to store - - - - Creates a new instance of the ConcurrentLimitedCollection class - - Maximum size for the collection - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - 1 - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - 2 - - - - Adds an item to the collection. - If the collection is full, the oldest item is removed and the new item - is added to the end of the collection. - - Item to add - - - - Clear the collection - - - - - Implementation of the interface that does nothing. - - - - - Initialise diagnostics - - Application pipelines - - - - Initialise diagnostics - - Application pipelines - - - - Defines the functionality for tracing a request. - - - - - Gets or sets the generic item store. - - An instance containing the items. - - - - Gets or sets the information about the request. - - An instance. - - - - Gets or sets the information about the response. - - An instance. - - - - Gets the trace log. - - A instance. - - - - Implementation of that does not log anything. - - - - - Write to the log - - Log writing delegate - - - - Returns a string that represents the current object. - - - A string that represents the current object. - - - - - Stores request trace information about the request. - - - - - Implicitly casts a instance into a instance. - - A instance. - A instance. - - - - Gets or sets the content type of the request. - - A containing the content type. - - - - Gets or sets the headers of the request. - - A instance containing the headers. - - - - Gets the HTTP verb of the request. - - A containing the HTTP verb. - - - - Gets or sets the that was requested. - - - - - Stores request trace information about the response. - - - - - Implicitly casts a instance into a instance. - - A instance. - A instance. - - - - Gets or sets the content type of the response. - - A containing the content type. - - - - Gets or sets the headers of the response. - - A instance containing the headers. - - - - Gets or sets the of the response. - - - - - Gets or sets the of the response. - - A instance. - - - - A "disabled" static content provider - always returns null - so no content is served. - - - - - Gets the static content response, if possible. - - Current context - Response if serving content, null otherwise - - - - Here Be Dragons - Using an exception for flow control to hotwire route execution. - It can be useful to call a method inside a route definition and have that method - immediately return a response (such as for authentication). This exception is used - to allow that flow. - - - - - Initializes a new instance of the class. - - - The response. - - - The reason for the early exit. - - - - - Gets or sets the reason for the early exit - - - - - Gets or sets the response - - - - - Containing extensions for the property. - - - - - Adds a new to the validation results. - - A reference to the property. - The name of the property. - The validation error message. - A reference to the property. - - - - Extensions for RequestStream. - - - - - Gets the request body as a string. - - The request body stream. - The encoding to use, by default. - The request body as a . - - - - Containing extensions for the object. - - - - - Buffer size for copy operations - - - - - Copies the contents between two instances in an async fashion. - - The source stream to copy from. - The destination stream to copy to. - Delegate that should be invoked when the operation has completed. Will pass the source, destination and exception (if one was thrown) to the function. Can pass in . - - - - Containing extensions for the object. - - - - - Gets the path of the assembly that contains the provided type. - - The to look up the assembly path for. - A string containing the path of the assembly that contains the type. - - - - Checks if a type is an array or not - - The type to check. - if the type is an array, otherwise . - - - - Determines whether the is assignable from - taking into account generic definitions - - - Borrowed from: http://tmont.com/blargh/2011/3/determining-if-an-open-generic-type-isassignablefrom-a-type - - - - - Checks if a type is an collection or not - - The type to check. - if the type is an collection, otherwise . - - - - Checks if a type is enumerable or not - - The type to check. - if the type is an enumerable, otherwise . - - - - Determines if a type is numeric. Nullable numeric types are considered numeric. - - - Boolean is not considered numeric. - - - - - Default implementation of the interface. - - - - - Defines the functionality for request tracing. - - - - - Adds the , of the provided, to the trace log. - - The identifier of the trace. - A instance. - - - - Clears the trace log. - - - - - Creates a new trace session. - - A which represents the identifier of the new trace session. - - - - Gets all the available instances. - - - - - - Checks if the provided is valid or not. - - A representing the session to check. - if the session is valid, otherwise . - - - - Adds the , of the provided, to the trace log. - - The identifier of the trace. - A instance. - - - - Clears the trace log. - - - - - Creates a new trace session. - - A which represents the identifier of the new trace session. - - - - Gets all the available instances. - - - - - - Checks if the provided is valid or not. - - A representing the session to check. - if the session is valid, otherwise . - - - - Basic class containing the functionality for defining routes and actions in Nancy. - - - - - Nancy module base interface - Defines all the properties / behaviour needed by Nancy internally - - - - - The post-request hook - - The post-request hook is called after the response is created by the route execution. - It can be used to rewrite the response or add/remove items from the context. - - - - - The pre-request hook - - The PreRequest hook is called prior to executing a route. If any item in the - pre-request pipeline returns a response then the route is not executed and the - response is returned. - - - - - The error hook - - The error hook is called if an exception is thrown at any time during executing - the PreRequest hook, a route and the PostRequest hook. It can be used to set - the response and/or finish any ongoing tasks (close database session, etc). - - - - - Gets or sets the current Nancy context - A instance. - - - - An extension point for adding support for formatting response contents. - This property will always return because it acts as an extension point.Extension methods to this property should always return or one of the types that can implicitly be types into a . - - - - Gets or sets the model binder locator - - - - - Gets or sets the model validation result - - - - - Gets or sets the validator locator. - - - - - Gets or sets an instance that represents the current request. - An instance. - - - - The extension point for accessing the view engines in Nancy. - An instance.This is automatically set by Nancy at runtime. - - - - Get the root path of the routes in the current module. - A containing the root path of the module or if no root path should be used.All routes will be relative to this root path. - - - - Gets all declared routes by the module. - A instance, containing all instances declared by the module. - - - - Gets or sets the dynamic object used to locate text resources. - - - - - Renders a view from inside a route handler. - - A instance that is used to determine which view that should be rendered. - - - - Used to negotiate the content returned based on Accepts header. - - A instance that is used to negotiate the content returned. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - A containing the root relative path that all paths in the module will be a subset of. - - - - Non-model specific data for rendering in the response - - - - - Gets for declaring actions for DELETE requests. - - A instance. - - - - Gets for declaring actions for GET requests. - - A instance. - - - - Gets for declaring actions for HEAD requests. - - A instance. - - - - Gets for declaring actions for OPTIONS requests. - - A instance. - - - - Gets for declaring actions for PATCH requests. - - A instance. - - - - Gets for declaring actions for POST requests. - - A instance. - - - - Gets for declaring actions for PUT requests. - - A instance. - - - - Get the root path of the routes in the current module. - - - A containing the root path of the module or - if no root path should be used.All routes will be relative to this root path. - - - - - Gets all declared routes by the module. - - A instance, containing all instances declared by the module. - This is automatically set by Nancy at runtime. - - - - Gets the current session. - - - - - Renders a view from inside a route handler. - - A instance that is used to determine which view that should be rendered. - - - - Used to negotiate the content returned based on Accepts header. - - A instance that is used to negotiate the content returned. - - - - Gets or sets the validator locator. - - This is automatically set by Nancy at runtime. - - - - Gets or sets an instance that represents the current request. - - An instance. - - - - The extension point for accessing the view engines in Nancy. - An instance. - This is automatically set by Nancy at runtime. - - - - The post-request hook - - The post-request hook is called after the response is created by the route execution. - It can be used to rewrite the response or add/remove items from the context. - - This is automatically set by Nancy at runtime. - - - - - - The pre-request hook - - - The PreRequest hook is called prior to executing a route. If any item in the - pre-request pipeline returns a response then the route is not executed and the - response is returned. - - This is automatically set by Nancy at runtime. - - - - - - The error hook - - - The error hook is called if an exception is thrown at any time during executing - the PreRequest hook, a route and the PostRequest hook. It can be used to set - the response and/or finish any ongoing tasks (close database session, etc). - - This is automatically set by Nancy at runtime. - - - - - Gets or sets the current Nancy context - - A instance. - This is automatically set by Nancy at runtime. - - - - An extension point for adding support for formatting response contents. - This property will always return because it acts as an extension point.Extension methods to this property should always return or one of the types that can implicitly be types into a . - - - - Gets or sets the model binder locator - - This is automatically set by Nancy at runtime. - - - - Gets or sets the model validation result - - This is automatically set by Nancy at runtime when you run validation. - - - - Helper class for configuring a route handler in a module. - - - - - Initializes a new instance of the class. - - The HTTP request method that the route should be available for. - The that the route is being configured for. - - - - Defines a Nancy route for the specified . - - A delegate that is used to invoke the route. - - - - Defines a Nancy route for the specified and . - - A delegate that is used to invoke the route. - - - - Defines an async route for the specified - - - - - Defines an async route for the specified and . - - - - - Defines a Nancy route for the specified and - - A delegate that is used to invoke the route. - - - - Defines a Nancy route for the specified , and - - A delegate that is used to invoke the route. - - - - Defines an async route for the specified and - - - - - Defines an async route for the specified , and - - - - - Defines the functionality to build a fully configured NancyModule instance. - - - - - Builds a fully configured instance, based upon the provided . - - The that should be configured. - The current request context. - A fully configured instance. - - - - Builds a fully configured instance, based upon the provided . - - The that should be configured. - The current request context. - A fully configured instance. - - - - Catalog of instances. - - - - - Get all NancyModule implementation instances - should be per-request lifetime - - The current context - An instance containing instances. - - - - Retrieves a specific implementation - should be per-request lifetime - - Module type - The current context - The instance - - - - Get all NancyModule implementation instances - should be per-request lifetime - - The current context - An instance containing instances. - - - - Retrieves a specific implementation - should be per-request lifetime - - Module type - The current context - The instance - - - - Wires up the diagnostics support at application startup. - - - - - Creates a new instance of the class. - - - - - - - - - - - - - - - - - Initialise diagnostics - - Application pipelines - - - - Renders diagnostics views from embedded resources. - - - - - Creates a new instance of the class. - - A instance. - - - - Renders the diagnostics view with the provided . - - The name of the view to render. - A of the rendered view. - - - - Renders the diagnostics view with the provided and . - - The name of the view to render. - The model that should be passed to the view engine during rendering. - A of the rendered view. - - - - Defines the functionality for resolving the requested view. - - - - - Locates a view based on the provided information. - - The name of the view to locate. - The model that will be used with the view. - A instance, containing information about the context for which the view is being located. - A instance if the view could be found, otherwise . - - - - Locates a view based on the provided information. - - The name of the view to locate. - The model that will be used with the view. - A instance, containing information about the context for which the view is being located. - A instance if the view could be found, otherwise . - - - - Used to return string values - - - - - Gets a translation based on the provided key. - - The key to look up the translation for. - The current instance. - - - - Helper class for caching related functions - - - - - Returns whether to return a not modified response, based on the etag and last modified date - of the resource, and the current nancy context - - Current resource etag, or null - Current resource last modified, or null - Current nancy context - True if not modified should be sent, false otherwise - - - - Add this attribute to an assembly to make sure - it is included in Nancy's assembly scanning. - - - Apply the attribute, typically in AssemblyInfo.(cs|fs|vb), as follows: - [assembly: IncludeInNancyAssemblyScanning] - - - - - Returns text from an implemented ITextResource - - - - - Initializes a new instance of the class. - - The that should be used by the TextResourceFinder - The that should be used by the TextResourceFinder - - - - Finds text resource - - GetMemberBinder with dynamic text key - Text item - Returns a value or a non existing value from the implementation - - - - Gets the that is being used to locate texts. - - An instance. - - - - Gets a translation based on the provided key. - - The key to look up the translation for. - - - - Configurations that controls the behavior of the binder at runtime. - - - - - Initializes a new instance of the class. - - - - - Binding configuration that permits that the binder overwrites non-default values. - - - - - Default binding configuration. - - - - - Gets or sets whether the binder should be happy once it has bound to the request body. In this case, - request and context parameters will not be bound to. If there is no body and this option is enabled, - no binding will take place at all. - - if the binder will stop once the body has been bound, otherwise . - - - - Gets or sets whether binding error should be ignored and the binder should continue with the next property. - - Setting this property to means that no will be thrown if an error occurs. - If the binder should ignore errors, otherwise . - - - - Gets or sets whether the binder is allowed to overwrite properties that does not have a default value. - - if the binder is allowed to overwrite non-default values, otherwise . - - - - Represents a bindable member of a type, which can be a property or a field. - - - - - Constructs a BindingMemberInfo instance for a property. - - The bindable property to represent. - - - - Constructs a BindingMemberInfo instance for a field. - - The bindable field to represent. - - - - Gets the value from a specified object associated with the property or field represented by this BindingMemberInfo. - - The object whose property or field should be retrieved. - The value for this BindingMemberInfo's property or field in the specified object. - - - - Sets the value from a specified object associated with the property or field represented by this BindingMemberInfo. - - The object whose property or field should be assigned. - The value to assign in the specified object to this BindingMemberInfo's property or field. - - - - - - - Compares two BindingMemberInfo's with eachother on their respective values rather then their reference - - the other BindingMemberInfo - true when they are equal and false otherwise - - - - - - - Returns an enumerable sequence of bindable properties for the specified type. - - The type to enumerate. - Bindable properties. - - - - Returns an enumerable sequence of bindable properties for the specified type. - - The type to enumerate. - Bindable properties. - - - - Gets a reference to the MemberInfo that this BindingMemberInfo represents. This can be a property or a field. - - - - - Gets the name of the property or field represented by this BindingMemberInfo. - - - - - Gets the data type of the property or field represented by this BindingMemberInfo. - - - - - Converter for datetime types - - - - - Provides a way to convert from the incoming string representation - of a type to the type itself. - - - - - Whether the converter can convert to the destination type - - Destination type - The current binding context - True if conversion supported, false otherwise - - - - Convert the string representation to the destination type - - Input string - Destination type - Current context - Converted object of the destination type - - - - Whether the converter can convert to the destination type - - Destination type - The current binding context - True if conversion supported, false otherwise - - - - Convert the string representation to the destination type - - Input string - Destination type - Current context - Converted object of the destination type - - - - Converter for numeric types - - - - - Whether the converter can convert to the destination type - - Destination type - The current binding context - True if conversion supported, false otherwise - - - - Convert the string representation to the destination type - - Input string - Destination type - Current context - Converted object of the destination type - - - - Contains extension methods for the type. - - - - - Retrieves the member that an expression is defined for. - - The expression to retrieve the member from. - A instance if the member could be found; otherwise . - - - - Creates new instance - - the name of the property which failed to bind - the value attempted to set - the underlying exception - - - - Gets the property name for which the bind failed - - - - - Gets the value which was attempted to be assigned to the property - - - - - Handles an incoming . - - The instance. - An instance, containing the information about the current request. - A instance containing the request/response context. - - - - Handles an incoming . - - The instance. - An instance, containing the information about the current request. - Delegate to call before the request is processed - A instance containing the request/response context. - - - - Handles an incoming async. - - The instance. - An instance, containing the information about the current request. - Delegate to call before the request is processed - Delegate to call when the request is complete - Delegate to call when any errors occur - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - - Handles an incoming async. - - The instance. - An instance, containing the information about the current request. - Delegate to call when the request is complete - Delegate to call when any errors occur - - - - Add a cookie to the response. - - The instance. - The instance that should be added. - The modified instance. - - - - Add a collection of cookies to the response. - - The instance. - The instances that should be added. - The modified instance. - - - - Add a header to the response - - Negotiator object - Header name - Header value - Modified negotiator - - - - Add a content type to the response - - Negotiator object - Content type value - Modified negotiator - - - - Adds headers to the response using anonymous types - - Negotiator object - - Array of headers - each header should be an anonymous type with two string properties - 'Header' and 'Value' to represent the header name and its value. - - Modified negotiator - - - - Adds headers to the response using anonymous types - - Negotiator object - - Array of headers - each header should be a Tuple with two string elements - for header name and header value - - Modified negotiator - - - - Allows the response to be negotiated with any processors available for any content type - - Negotiator object - Modified negotiator - - - - Allows the response to be negotiated with a specific media range - This will remove the wildcard range if it is already specified - - Negotiator object - Media range to add - Modified negotiator - - - - Uses the specified model as the default model for negotiation - - Negotiator object - Model object - Modified negotiator - - - - Uses the specified view for html output - - Negotiator object - View name - Modified negotiator - - - - Sets the model to use for a particular media range. - Will also add the MediaRange to the allowed list - - Negotiator object - Range to match against - Model object - Updated negotiator object - - - - Sets the model to use for a particular media range. - Will also add the MediaRange to the allowed list - - Negotiator object - Range to match against - Model factory for returning the model object - Updated negotiator object - - - - Sets the to use for a particular media range. - Will also add the MediaRange to the allowed list - - Negotiator object - Range to match against - A object - Updated negotiator object - - - - Sets the to use for a particular media range. - Will also add the MediaRange to the allowed list - - Negotiator object - Range to match against - Factory for returning the object - Updated negotiator object - - - - Sets the status code that should be assigned to the final response. - - Negotiator object - The status code that should be used. - Updated negotiator object - - - - Sets the description of the status code that should be assigned to the final response. - - Negotiator object - The status code description that should be used. - Updated negotiator object - - - - Sets the status code that should be assigned to the final response. - - Negotiator object - The status code that should be used. - Updated negotiator object - - - - OWIN extensions for the delegate-based approach. - - - - - Adds Nancy to the OWIN pipeline. - - The application builder delegate. - A configuration builder action. - The application builder delegate. - - - - Adds Nancy to the OWIN pipeline. - - The application builder delegate. - The Nancy options. - The application builder delegate. - - - - OWIN extensions for the NancyContext. - - - - - Gets the OWIN environment dictionary. - - The Nancy context. - The OWIN environment dictionary. - - - - Options for hosting Nancy with OWIN. - - - - - Gets or sets the bootstrapper. If none is set, NancyBootstrapperLocator.Bootstrapper is used. - - - - - Gets or sets the delegate that determines if NancyMiddleware performs pass through. - - - - - Gets or sets a value indicating whether to request a client certificate or not. - Defaults to false. - - - - - Extensions for the NancyOptions class. - - - - - Tells the NancyMiddleware to pass through when - response has one of the given status codes. - - The Nancy options. - The HTTP status code. - - - - Nancy middleware for OWIN. - - - - - The request environment key - - - - - Use Nancy in an OWIN pipeline - - A delegate to configure the . - An OWIN middleware delegate. - - - - Use Nancy in an OWIN pipeline - - An to configure the Nancy middleware - An OWIN middleware delegate. - - - - Gets a delegate to handle converting a nancy response - to the format required by OWIN and signals that the we are - now complete. - - OWIN environment. - The next stage in the OWIN pipeline. - The task completion source to signal. - A predicate that will allow the caller to determine if the request passes through to the - next stage in the owin pipeline. - Delegate - - - - Gets a delegate to handle request errors - - Completion source to signal - Delegate - - - - Creates the Nancy URL - - OWIN Hostname - OWIN Scheme - OWIN Base path - OWIN Path - OWIN Querystring - - - - - Gets a delegate to store the OWIN environment into the NancyContext - - OWIN Environment - Delegate - - - - Encapsulates HTTP-response information from an Nancy operation. - - - - - Null object representing no body - - - - - Initializes a new instance of the class. - - - - - Executes at the end of the nancy execution pipeline and before control is passed back to the hosting. - Can be used to pre-render/validate views while still inside the main pipeline/error handling. - - Nancy context - Task for completion/erroring - - - - Adds a to the response. - - The name of the cookie. - The value of the cookie. - The instance. - - - - Adds a to the response. - - The name of the cookie. - The value of the cookie. - The expiration date of the cookie. Can be if it should expire at the end of the session. - The instance. - - - - Adds a to the response. - - The name of the cookie. - The value of the cookie. - The expiration date of the cookie. Can be if it should expire at the end of the session. - The domain of the cookie. - The path of the cookie. - The instance. - - - - Adds a to the response. - - A instance. - - - - - Implicitly cast an value to a instance, with the - set to the value of the . - - The value that is being cast from. - A instance. - - - - Implicitly cast an int value to a instance, with the - set to the value of the int. - - The int value that is being cast from. - A instance. - - - - Implicitly cast an string instance to a instance, with the - set to the value of the string. - - The string that is being cast from. - A instance. - - - - Implicitly cast an , where T is a , instance to - a instance, with the set to the value of the action. - - The instance that is being cast from. - A instance. - - - - Implicitly cast a instance to a instance, - with the set to the value of the . - - The instance that is being cast from. - A instance. - - - - Converts a string content value to a response action. - - The string containing the content. - A response action that will write the content of the string to the response stream. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - This method can be overridden in sub-classes to dispose of response specific resources. - - - - Gets or sets the type of the content. - - The type of the content. - The default value is text/html. - - - - Gets the delegate that will render contents to the response stream. - - An delegate, containing the code that will render contents to the response stream. - The host of Nancy will pass in the output stream after the response has been handed back to it by Nancy. - - - - Gets the collection of HTTP response headers that should be sent back to the client. - - An instance, containing the key/value pair of headers. - - - - Gets or sets the HTTP status code that should be sent back to the client. - - A value. - - - - Gets or sets a text description of the HTTP status code returned to the client. - - The HTTP status code description. - - - - Gets the instances that are associated with the response. - - A instance, containing instances. - - - - Defines the functionality a diagnostics provider. - - - - - Gets the name of the provider. - - A containing the name of the provider. - - - - Gets the description of the provider. - - A containing the description of the provider. - - - - Gets the object that contains the interactive diagnostics methods. - - An instance of the interactive diagnostics object. - - - - Gets the name of the provider. - - A containing the name of the provider. - - - - Gets the description of the provider. - - A containing the description of the provider. - - - - Gets the object that contains the interactive diagnostics methods. - - An instance of the interactive diagnostics object. - - - - Enable JSONP support in the application - - Application Pipeline to Hook into - - - - Disable JSONP support in the application - - Application Pipeline to Hook into - - - - Transmogrify original response and apply JSONP Padding - - Current Nancy Context - - - - Enables JSONP support at application startup. - - - - - Perform any initialisation tasks - - Application pipelines - - - - Exception that is thrown when an unhandled exception occurred during - the execution of the current request. - - - - - Initializes a new instance of the , with - the specified . - - - - - - Takes an existing response and materialises the body. - Can be used as a wrapper to force execution of the deferred body for - error checking etc. - Copies the existing response into memory, so use with caution. - - - - - Response that indicates that the response format should be negotiated between the client and the server. - - - - - Initializes a new instance of the response for the - provided . - - The response value that should be negotiated. - - - - Gets or sets the value that should be negotiated. - - - - - The default implementation for a response negotiator. - - - - - Creates a response from a given result and context. - - - - - Negotiates the response based on the given result and context. - - The route result. - The context. - A . - - - - Initializes a new instance of the class. - - The response processors. - The Accept header coercion conventions. - - - - Negotiates the response based on the given result and context. - - The route result. - The context. - A . - - - - Tries to cast the dynamic result to a . - - The result. - The response. - true if the result is a , false otherwise. - - - - Gets a based on the given result and context. - - The route result. - The context. - A . - - - - Gets the coerced accept headers based on the . - - The context. - IEnumerable{Tuple{System.String, System.Decimal}}. - - - - Gets compatible response processors by header. - - The accept header. - The model. - The context. - IEnumerable{Tuple{IResponseProcessor, ProcessorMatch}}. - - - - Creates a response from the compatible headers. - - The compatible headers. - The negotiation context. - The context. - A . - - - - Prioritizes the response processors and tries to negotiate a response. - - The compatible headers. - The negotiation context. - The context. - Response. - - - - Adds a link header to the . - - The compatible headers. - The response. - The request URL. - - - - Gets the link processors based on the compatible headers and content-type. - - The compatible headers. - The content-type of the response. - Dictionary{System.String, MediaRange}. - - - - Creates the link header with the different media ranges. - - The request URL. - The link processors. - The link header. - - - - Adds the content type header from the to the . - - The negotiation context. - The response. - - - - Adds the negotiated headers from the to the . - - The negotiation context. - The response. - - - - Sets the status code from the on the . - - The negotiation context. - The response. - - - - Sets the reason phrase from the on the . - - The negotiation context. - The response. - - - - Adds the cookies from the to the . - - The negotiation context. - The response. - - - - Content negotiation response processor - - - - - Determines whether the processor can handle a given content type and model. - - Content type requested by the client. - The model for the given media range. - The nancy context. - A result that determines the priority of the processor. - - - - Process the response. - - Content type requested by the client. - The model for the given media range. - The nancy context. - A instance. - - - - Gets a set of mappings that map a given extension (such as .json) - to a media range that can be sent to the client in a vary header. - - - - - Processes the model for json media types and extension. - - - - - Initializes a new instance of the class, - with the provided . - - The serializes that the processor will use to process the request. - - - - Determines whether the processor can handle a given content type and model - - Content type requested by the client - The model for the given media range - The nancy context - A ProcessorMatch result that determines the priority of the processor - - - - Process the response - - Content type requested by the client - The model for the given media range - The nancy context - A response - - - - Gets a set of mappings that map a given extension (such as .json) - to a media range that can be sent to the client in a vary header. - - - - - Represents whether a processor has matched/can handle processing the response. - Values are of increasing priority. - - - - - No match, nothing to see here, move along - - - - - Will accept anything - - - - - Matched, but in a non-specific way such as a wildcard match or fallback - - - - - Exact specific match - - - - - Represents a media range from an accept header - - - - - Initializes a new instance of the class from a string representation of a media range - - the content type - - - - Initializes a new instance of the class. - - - - - Whether or not a media range matches another, taking into account wildcards - - Other media range - True if matching, false if not - - - - Whether or not a media range matches another, taking into account wildcards and parameters - - Other media range - True if matching, false if not - - - - Creates a MediaRange from a "Type/SubType" string - - - - - - - Media range type - - - - - Media range subtype - - - - - Media range parameters - - - - - Gets a value indicating if the media range is the */* wildcard - - - - - Provides strongly-typed access to media range parameters. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The parameters. - - - - Returns an enumerator that iterates through the collection. - - A that can be used to iterate through the collection. - - - - Whether or not a set of media range parameters matches another, regardless of order - - Other media range parameters - True if matching, false if not - - - - Returns an enumerator that iterates through a collection. - - An object that can be used to iterate through the collection. - - - - Creates a MediaRangeParameters collection from a "a=1,b=2" string - - - - - - - Gets the names of the available parameters. - - An containing the names of the parameters. - - - - Gets all the parameters values. - - An that contains all the parameters values. - - - - Gets the value for the parameter identified by the parameter. - - The name of the parameter to return the value for. - The value for the parameter. If the parameter is not defined then null is returned. - - - - Represents a media type or subtype in a . - - - - - Initializes a new instance of the class for the media type part. - - - - - - Matched the media type with another media type. - - The media type that should be matched against. - if the media types match, otherwise . - - - - Gets a value indicating whether the media type is a wildcard or not - - if the media type is a wildcard, otherwise . - - - - Context for content negotiation. - - - - - Initializes a new instance of the class. - - - - - Gets the correct model for the given media range - - The to get the model for. - The model for the provided if it has been mapped, otherwise the will be returned. - - - - Gets or sets additional cookies to assign to the response. - - An of instances. - - - - Gets or sets the default model that will be used if a content type specific model is not specified. - - The default model instance. - - - - Gets or sets the additional response headers required. - - An containing the headers. - - - - Gets or sets the model mappings for media ranges. - - An containing the media range model mappings. - - - - The name of the that is locating a view. - - A containing the name of the module. - - - - The module path of the that is locating a view. - - A containing the module path. - - - - Gets or sets allowed media ranges. - - A list of the allowed media ranges. - - - - Gets or sets the status code of the response. - - A value. - - - - Gets or sets a text description of the HTTP status code returned to the client. - - The HTTP status code description. - - - - Gets or sets the view name if one is required. - - The name of the view that should be rendered. - - - - Initializes a new instance of the class, - with the provided . - - The context that should be negotiated. - - - - Gets the used by the negotiator. - - A instance. - - - - Represents whether a processor has matched / can handle a requested response - - - - - A with both and set to . - - - - - Gets or sets the match result based on the content type - - - - - Gets or sets the match result based on the model - - - - - Processes negotiated responses of model type . - - - - - Determines whether the processor can handle a given content type and model. - - Content type requested by the client. - The model for the given media range. - The nancy context. - A result that determines the priority of the processor. - - - - Process the response. - - Content type requested by the client. - The model for the given media range. - The nancy context. - A instance. - - - - Gets a set of mappings that map a given extension (such as .json) - to a media range that can be sent to the client in a vary header. - - - - - Processes the model for view requests. - - - - - Initializes a new instance of the class, - with the provided . - - The view factory that should be used to render views. - - - - Determines whether the processor can handle a given content type and model. - - Content type requested by the client. - The model for the given media range. - The nancy context. - A result that determines the priority of the processor. - - - - Process the response. - - Content type requested by the client. - The model for the given media range. - The nancy context. - A instance. - - - - Gets a set of mappings that map a given extension (such as .json) - to a media range that can be sent to the client in a vary header. - - - - - Processes the model for xml media types and extension. - - - - - Initializes a new instance of the class, - with the provided . - - The serializes that the processor will use to process the request. - - - - Determines whether the processor can handle a given content type and model. - - Content type requested by the client. - The model for the given media range. - The nancy context. - A result that determines the priority of the processor. - - - - Process the response. - - Content type requested by the client. - The model for the given media range. - The nancy context. - A instance. - - - - Gets a set of mappings that map a given extension (such as .json) - to a media range that can be sent to the client in a vary header. - - - - - Response with status code 406 (Not Acceptable). - - - - - Initializes a new instance of the class. - - - - - Response that returns the contents of a stream of a given content-type. - - - - - Initializes a new instance of the class with the - provided stream provider and content-type. - - The value producer for the response. - The content-type of the stream contents. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - To close the unclosable stream.. - To fight the unbeatable foe.. - To bear with unbearable sorrow.. - To run where the brave dare not go.. - - - - - The wrapped stream - - - - - Initializes a new instance of the class. - - The base stream to wrap. - - - - Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. - - 1 - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - 2 - - - - When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device. - - An I/O error occurs. 2 - - - - When overridden in a derived class, sets the position within the current stream. - - - The new position within the current stream. - - A byte offset relative to the parameter. A value of type indicating the reference point used to obtain the new position. An I/O error occurs. The stream does not support seeking, such as if the stream is constructed from a pipe or console output. Methods were called after the stream was closed. 1 - - - - When overridden in a derived class, sets the length of the current stream. - - The desired length of the current stream in bytes. An I/O error occurs. The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output. Methods were called after the stream was closed. 2 - - - - When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. - - - The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached. - - An array of bytes. When this method returns, the buffer contains the specified byte array with the values between and ( + - 1) replaced by the bytes read from the current source. The zero-based byte offset in at which to begin storing the data read from the current stream. The maximum number of bytes to be read from the current stream. The sum of and is larger than the buffer length. is null. or is negative. An I/O error occurs. The stream does not support reading. Methods were called after the stream was closed. 1 - - - - When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. - - An array of bytes. This method copies bytes from to the current stream. The zero-based byte offset in at which to begin copying bytes to the current stream. The number of bytes to be written to the current stream. The sum of and is greater than the buffer length. is null. or is negative. An I/O error occurs. The stream does not support writing. Methods were called after the stream was closed. 1 - - - - Begins an asynchronous read operation. - - - An that represents the asynchronous read, which could still be pending. - - The buffer to read the data into. The byte offset in at which to begin writing data read from the stream. The maximum number of bytes to read. An optional asynchronous callback, to be called when the read is complete. A user-provided object that distinguishes this particular asynchronous read request from other requests. Attempted an asynchronous read past the end of the stream, or a disk error occurs. One or more of the arguments is invalid. Methods were called after the stream was closed. The current Stream implementation does not support the read operation. 2 - - - - Begins an asynchronous write operation. - - - An IAsyncResult that represents the asynchronous write, which could still be pending. - - The buffer to write data from. The byte offset in from which to begin writing. The maximum number of bytes to write. An optional asynchronous callback, to be called when the write is complete. A user-provided object that distinguishes this particular asynchronous write request from other requests. Attempted an asynchronous write past the end of the stream, or a disk error occurs. One or more of the arguments is invalid. Methods were called after the stream was closed. The current Stream implementation does not support the write operation. 2 - - - - Waits for the pending asynchronous read to complete. - - - The number of bytes read from the stream, between zero (0) and the number of bytes you requested. Streams return zero (0) only at the end of the stream, otherwise, they should block until at least one byte is available. - - The reference to the pending asynchronous request to finish. is null. did not originate from a method on the current stream. The stream is closed or an internal error has occurred.2 - - - - Ends an asynchronous write operation. - - A reference to the outstanding asynchronous I/O request. is null. did not originate from a method on the current stream. The stream is closed or an internal error has occurred.2 - - - - Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream. - - - The unsigned byte cast to an Int32, or -1 if at the end of the stream. - - The stream does not support reading. Methods were called after the stream was closed. 2 - - - - Writes a byte to the current position in the stream and advances the position within the stream by one byte. - - The byte to write to the stream. An I/O error occurs. The stream does not support writing, or the stream is already closed. Methods were called after the stream was closed. 2 - - - - Releases the unmanaged resources used by the and optionally releases the managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Gets the base stream that the wrapper is wrapping - - - - - When overridden in a derived class, gets a value indicating whether the current stream supports reading. - - - true if the stream supports reading; otherwise, false. - - 1 - - - - When overridden in a derived class, gets a value indicating whether the current stream supports seeking. - - - true if the stream supports seeking; otherwise, false. - - 1 - - - - When overridden in a derived class, gets a value indicating whether the current stream supports writing. - - - true if the stream supports writing; otherwise, false. - - 1 - - - - When overridden in a derived class, gets the length in bytes of the stream. - - - A long value representing the length of the stream in bytes. - - A class derived from Stream does not support seeking. Methods were called after the stream was closed. 1 - - - - When overridden in a derived class, gets or sets the position within the current stream. - - - The current position within the stream. - - An I/O error occurs. The stream does not support seeking. Methods were called after the stream was closed. 1 - - - - Gets a value that determines whether the current stream can time out. - - - A value that determines whether the current stream can time out. - - 2 - - - - Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out. - - - A value, in milliseconds, that determines how long the stream will attempt to read before timing out. - - The method always throws an . 2 - - - - Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out. - - - A value, in milliseconds, that determines how long the stream will attempt to write before timing out. - - The method always throws an . 2 - - - - Whether the serializer can serialize the content type - - Content type to serialise - True if supported, false otherwise - - - - Serialize the given model with the given contentType - - Content type to serialize into - Model to serialize - Output stream to serialize to - Serialised object - - - - Gets the list of extensions that the serializer can handle. - - An of extensions if any are available, otherwise an empty enumerable. - - - - JSON serializer settings - - - - - Max length of JSON output - - - - - Maximum number of recursions - - - - - Default charset for JSON responses. - - - - - Gets the default encoding for JSON responses. - - - The default value is - - - - - Set to true to retain the casing used in the C# code in produced JSON. - Set to false to use camelCasing in the produced JSON. - False by default. - - - - - Serialized date format - - - - - Whether the serializer can serialize the content type - - Content type to serialise - True if supported, false otherwise - - - - Serialize the given model with the given contentType - - Content type to serialize into - Model to serialize - Stream to serialize to - Serialised object - - - - Attempts to detect if the content type is JSON. - Supports: - application/json - text/json - application/vnd[something]+json - Matches are case insentitive to try and be as "accepting" as possible. - - Request content type - True if content type is JSON, false otherwise - - - - Gets the list of extensions that the serializer can handle. - - An of extensions if any are available, otherwise an empty enumerable. - - - - Set to true to retain the casing used in the C# code in produced JSON. - Set to false to use camelCasig in the produced JSON. - False by default. - - - - - Set to true to use the ISO8601 format for datetimes in produced JSON. - Set to false to use the WCF \/Date()\/ format in the produced JSON. - True by default. - - - - - Whether the serializer can serialize the content type - - Content type to serialise - True if supported, false otherwise - - - - Serialize the given model with the given contentType - - Content type to serialize into - Model to serialize - Output stream to serialize to - Serialised object - - - - Gets the list of extensions that the serializer can handle. - - An of extensions if any are available, otherwise an empty enumerable. - - - - Represents a text (text/plain) response - - - - - Creates a new instance of the TextResponse class - - Text content - defaults to empty if null - Content Type - defaults to text/plain - String encoding - UTF8 if null - - - - Creates a new instance of the TextResponse class - - Status code - defaults to OK - Text content - defaults to empty if null - String encoding - UTF8 if null - Headers if required - Cookies if required - - - - Constraint for alphabetical route segments. - - - - - Convenience class for implementing a route segment constraint. - - The type of parameter to capture. - - - - Defines the functionality to constrain route matching. - - - - - Determines whether the given constraint should be matched. - - The route constraint. - true if the constraint matches, false otherwise. - - - - Matches the segment and parameter name against the constraint. - - The constraint. - The segment. - Name of the parameter. - A containing information about the captured parameters. - - - - Tries to match the given segment against the constraint. - - The constraint. - The segment to match. - The matched value. - true if the segment matches the constraint, false otherwise. - - - - Gets the name of the constraint, i.e. "int". - - The constraint's name. - - - - Constraint for route segments. - - - - - Constraint for route segments with custom format. - - - - - Convenience class for implementing a route segment constraint that expects parameters. - - The type of parameter to capture. - - - - Tries to parse an integer using . - - The string value. - The resulting integer. - true if the parsing was successful, false otherwise. - - - - Tries to match the given segment and parameters against the constraint. - - The segment to match. - The parameters to match. - The matched value. - true if the segment and parameters matches the constraint, false otherwise. - - - - Constraint for route segments. - - - - - Constraint for route segments. - - - - - Constraint for route segments. - - - - - Constraint for route segments. - - - - - Constraint for route segments. - - - - - Constraint for route segments with a specific length. - - - - - Constraint for route segments with a maximum length. - - - - - Constraint for route segments with a maximum value. - - - - - Constraint for route segments with a minimum length. - - - - - Constraint for route segments with a minimum length. - - - - - Constraint for route segments with value within a specified range. - - - - - Constraint for version route segments. - - - - - Default implementation of a request dispatcher. - - - - - Functionality for processing an incoming request. - - - - - Dispatches a requests. - - The for the current request. - Cancellation token - - - - Initializes a new instance of the class, with - the provided , and . - - - - - - - - - Dispatches a requests. - - The for the current request. - - - - Default implementation of the interface. Will look for - route descriptions in resource files. The resource files should have the same name as the module - for which it defines routes. - - - - - Defines the functionality for retrieving a description for a specific route. - - - - - Get the description for a route. - - The module that the route is defined in. - The path of the route that the description should be retrieved for. - A containing the description of the route if it could be found, otherwise . - - - - Get the description for a route. - - The module that the route is defined in. - The path of the route that the description should be retrieved for. - A containing the description of the route if it could be found, otherwise . - - - - Default route invoker implementation. - - - - - Defines the functionality for invoking a and returning a - - - - - Invokes the specified with the provided . - - The route that should be invoked. - Cancellation token - The parameters that the route should be invoked with. - The context of the route that is being invoked. - A instance that represents the result of the invoked route. - - - - Initializes a new instance of the class. - - The response negotiator. - - - - Invokes the specified with the provided . - - The route that should be invoked. - Cancellation token - The parameters that the route should be invoked with. - The context of the route that is being invoked. - A instance that represents the result of the invoked route. - - - - Default implementation of the interface. - - - - - Defines the functionality for extracting the individual segments from a route path. - - - - - Extracts the segments from the ; - - The path that the segments should be extracted from. - An , containing the extracted segments. - - - - Extracts the segments from the ; - - The path that the segments should be extracted from. - An , containing the extracted segments. - - - - Defines the functionality for retrieving metadata for routes. - - - - - Gets the of the metadata that is created by the provider. - - The instance that the route is declared in. - A for the route. - A instance, or if nothing is found. - - - - Gets the metadata for the provided route. - - The instance that the route is declared in. - A for the route. - An object representing the metadata for the given route, or if nothing is found. - - - - Information about a segment parameter. - - - - - Initializes a new instance of the class. - - The name of the parameter - The default value, if any, of the parameter. - if the parameter is optional, otherwise . - - - - Gets the default value for the parameter. - - - - - Gets the full name of the segment. - - Returns a string in one of the formats: {name}, {name?}, {name?defaultValue} depending on the kind of parameter. - - - - Gets whether or not the parameter is optional. - - if the parameter is optional, otherwise . - - - - Gets the name of the parameter. - - - - - A class representing a route resolution result - - - - - Gets or sets the route - - - - - Gets or sets the captured parameters - - - - - Gets or sets the before module pipeline - - - - - Gets or sets the after module pipeline - - - - - Gets or sets the on error module pipeline - - - - - Route that is returned when the path could be matched but, the method was OPTIONS and there was no user defined handler for OPTIONS. - - - - - Stores information about a declared route in Nancy. - - - - - Initializes a new instance of the type, with the specified . - - - The action that should take place when the route is invoked. - - - - Initializes a new instance of the type, with the specified definition. - - Route name - The HTTP method that the route is declared for. - The path that the route is declared for. - A condition that needs to be satisfied inorder for the route to be eligible for invocation. - The action that should take place when the route is invoked. - - - - Initializes a new instance of the type, with the specified definition. - - The HTTP method that the route is declared for. - The path that the route is declared for. - A condition that needs to be satisfied inorder for the route to be eligiable for invocation. - The action that should take place when the route is invoked. - - - - Invokes the route with the provided . - - A that contains the parameters that should be passed to the route. - Cancellation token - A (hot) task of instance. - - - - Creates a route from a sync delegate signature - - - The action that should take place when the route is invoked. - A Route instance - - - - Creates a route from a sync delegate signature - - The HTTP method that the route is declared for. - The path that the route is declared for. - A condition that needs to be satisfied inorder for the route to be eligiable for invocation. - The action that should take place when the route is invoked. - A Route instance - - - - Creates a route from a sync delegate signature - - Route name - The HTTP method that the route is declared for. - The path that the route is declared for. - A condition that needs to be satisfied inorder for the route to be eligible for invocation. - The action that should take place when the route is invoked. - A Route instance - - - - Wraps a sync delegate in a delegate that returns a task - - Sync delegate - Task wrapped version - - - - Gets or sets the action that should take place when the route is invoked. - - A that represents the action of the route. - - - - Gets the description of the route. - - A instance. - - - - Contains extensions for the type. - - - - - Retrieves metadata for all declared routes. - - The type of the metadata to retrieve. - The to retrieve the metadata. - An containing instances of the type. - - - - Stores metadata created by instances. - - - - - Creates a new instance of the class. - - An containing the metadata, organised by the type that it is stored in. - - - - Gets a boolean that indicates if the specific type of metadata is stored. - - The type of the metadata to check for. - if metadata, of the requested type is stored, otherwise . - - - - Retrieves metadata of the provided type. - - The type of the metadata to retrieve. - The metadata instance if available, otherwise . - - - - Gets the raw metadata . - - An instance. - - - - Defines the functionality for retrieving metadata for routes. - - The metadata type. - - - - Gets the of the metadata that is created by the provider. - - The instance that the route is declared in. - A for the route. - A instance, or null if none are found. - - - - Gets the metadata for the provided route. - - The instance that the route is declared in. - A for the route. - An instance of . - - - - Gets the metadata for the provided route. - - The instance that the route is declared in. - A for the route. - An instance of . - - - - Trie structure for resolving routes - - - - - Build the trie from the route cache - - The route cache - - - - Get all matches for the given method and path - - HTTP method - Requested path - Current Nancy context - An array of elements - - - - Get all method options for the given path - - Requested path - Current Nancy context - A collection of strings, each representing an allowed method - - - - Factory for creating trie nodes from route definition segments - - - - - Gets the correct Trie node type for the given segment - - Parent node - Segment - Corresponding TrieNode instance - - - - Match result for a matched route - - - - - Represents a route that ends at a particular node. - We store/calculate as much as we can at build time to save - time during route matching. - - - - - Gets or sets the module type from the matching module - - - - - Gets or sets the route method - - - - - Gets or sets the index in the module routing table - - - - - Gets or sets the number of segments in the route - - - - - Gets or sets the route score - - - - - Gets or sets the route condition delegate - - - - - Compares the current object with another object of the same type. - - - A value that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the parameter.Zero This object is equal to . Greater than zero This object is greater than . - - An object to compare with this object. - - - - Gets or sets the captured parameters - - - - - Gets the "no match" - - - - - Gets the "no matches" collection - - - - - Helpers methods for NodeData - - - - - Converts a instance into a - - Node data - Captured parameters - A instance - - - - A node for standard captures e.g. {foo} - - - - - A base class representing a node in the route trie - - - - - Initializes a new instance of the class - - Parent node - Segment of the route definition - Factory for creating new nodes - - - - Add a new route to the trie - - The segments of the route definition - The module key the route comes from - The route index in the module - The route description - - - - Add a new route to the trie - - The segments of the route definition - Current index in the segments array - Current score for this route - Number of nodes added for this route - The module key the route comes from - The route index in the module - The route description - - - - Gets all matches for a given requested route - - Requested route segments - Current Nancy context - A collection of objects - - - - Gets all matches for a given requested route - - Requested route segments - Current index in the route segments - Currently captured parameters - Current Nancy context - A collection of objects - - - - Gets a string representation of all routes - - Collection of strings, each representing a route - - - - Build the node data that will be used to create the - We calculate/store as much as possible at build time to reduce match time. - - Number of nodes in the route - Score for the route - The module key the route comes from - The route index in the module - The route description - A NodeData instance - - - - Returns whether we are at the end of the segments - - Route segments - Current index - True if no more segments left, false otherwise - - - - Build the results collection from the captured parameters if - this node is the end result - - Currently captured parameters - Parameters captured by the local matching - Array of objects corresponding to each set of stored at this node - - - - Gets all the matches from this node's children - - Requested route segments - Current index - Currently captured parameters - Parameters captured by the local matching - Current Nancy context - Collection of objects - - - - Matches the segment for a requested route - - Segment string - A instance representing the result of the match - - - - Gets or sets the parent node - - - - - Gets or sets the segment from the route definition that this node represents - - - - - Gets or sets the children of this node - - - - - Gets or sets the node data stored at this node, which will be converted - into the if a match is found - - - - - Additional parameters to set that can be determined at trie build time - - - - - Score for this node - - - - - Matches the segment for a requested route - - Segment string - A instance representing the result of the match - - - - Score for this node - - - - - A node for constraint captures e.g. {foo:alpha}, {foo:datetime} - - - - - Matches the segment for a requested route - - Segment string - A instance representing the result of the match - - - - Score for this node - - - - - A capture node with a default value e.g. {foo?default} - - - - - Add a new route to the trie - Adds itself as a normal capture node, but also sets a default capture - on the parent and adds this node's children as children of the parent - too (so it can effectively be "skipped" during matching) - - The segments of the route definition - Current index in the segments array - Current score for this route - Number of nodes added for this route - The module key the route comes from - The route index in the module - The route description - - - - Matches the segment for a requested route - - Segment string - A instance representing the result of the match - - - - Score for this node - - - - - A node multiple standard captures combined with a literal e.g. {id}.png.{thing}.{otherthing} - - - - - Captures parameters within segments that contain literals. - i.e: - /{file}.{name} - /{file}.html - /{major}.{minor}.{revision}B{build} - - The parent node - The segment to match upon - The factory - - - - - Determines whether this TrieNode should be used for the given segment. - - The route segment - a boolean - - - - Matches the segment for a requested route - - Segment string - A instance representing the result of the match - - - - Extracts the parameter name and the literals for the segment - - - - - Score for this node - - - - - A greedy regular expression capture node e.g. ^(?<id>\d{0,100})$ - For use on an entire route path, regular expression must be surrounded by ^( )$ - e.g. @"^(?:(?<id>videos/\d{1,10})(?:/{0,1}(?<slug>.*)))$" - This will match for a Url like /videos/123/some-random-slug - and capture 'videos/123' and 'some-random-slug' - - - - - Gets all matches for a given requested route - Overridden to handle greedy capturing - - Requested route segments - Current index in the route segments - Currently captured parameters - Current Nancy context - A collection of objects - - - - Matches the segment for a requested route - Not-required or called for this node type - - Segment string - A instance representing the result of the match - - - - Score for this node - - - - - A greedy capture node e.g. {greedy*} - e.g. /foo/bar/{greedy*} - this node will be hit for /foo/bar/[anything that doesn't match another route], but - not for just /foo/bar - e.g. /foo/{greedy*}/bar - this node will be hit for /foo/[anything that doesn't match another route]/bar - - - - - Gets all matches for a given requested route - Overridden to handle greedy capturing - - Requested route segments - Current index in the route segments - Currently captured parameters - Current Nancy context - A collection of objects - - - - Matches the segment for a requested route - Not-required or called for this node type - - Segment string - A instance representing the result of the match - - - - Score for this node - - - - - Literal string node e.g. goo - - - - - Matches the segment for a requested route - - Segment string - A instance representing the result of the match - - - - Score for this node - - - - - An optional capture node e.g. {foo?} - - - - - Add a new route to the trie - Adds itself as a normal capture node, but also adds this node's - children as children of the parent too - (so it can effectively be "skipped" during matching) - - The segments of the route definition - Current index in the segments array - Current score for this route - Number of nodes added for this route - The module key the route comes from - The route index in the module - The route description - - - - Matches the segment for a requested route - - Segment string - A instance representing the result of the match - - - - Score for this node - - - - - A regular expression capture node e.g. (?<foo>\d{2,4}) - - - - - Matches the segment for a requested route - - Segment string - A instance representing the result of the match - - - - Score for this node - - - - - Root node of a trie - - - - - Gets all matches for a given requested route - - Requested route segments - Current index in the route segments - Currently captured parameters - Current Nancy context - A collection of objects - - - - Matches the segment for a requested route - - Segment string - A instance representing the result of the match - - - - Score for this node - - - - - The default route resolution trie - - - - - Build the trie from the route cache - - The route cache - - - - Get all matches for the given method and path - - HTTP method - Requested path - Current Nancy context - An array of elements - - - - Get all method options for the given path - - Requested path - Current Nancy context - A collection of strings, each representing an allowed method - - - - Returns a string that represents the current object. - - - A string that represents the current object. - - 2 - - - - A segment match result - - - - - Gets a value indicating whether the match was successful or not - - - - - Gets a representing "no match" - - - - - Gets the captured parameters from the match, if the match was successful - - - - - Factory for creating the correct type of TrieNode - - - - - Gets the correct Trie node type for the given segment - - Parent node - Segment - TrieNode instance - - - - Allows a BeforeRequest hook to change Url to HTTPS if X-Forwarded-Proto header present - - - - - Checks for Forwarded or X-Forwarded-Proto header and if so makes current url scheme https - - Application pipelines - - - - Configuration options for cookie based sessions - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the cryptography configuration - - - - - Formatter for de/serializing the session objects - - - - - Cookie name for storing session information - - - - - Gets or sets the domain of the session cookie - - - - - Gets or sets the path of the session cookie - - - - - Gets a value indicating whether the configuration is valid or not. - - - - - Registers the static contents hook in the application pipeline at startup. - - - - - Initializes a new instance of the class, using the - provided and . - - The current root path provider. - The static content conventions. - - - - Perform any initialisation tasks - - - - - Enable "manual" static content. - Only use this if you want to manually configure a pipeline hook to have static - content server, for example, after authentication. - - The pipelines to hook into - - - - This is a wrapper around the type - IEnumerable<Func<string, object, ViewLocationContext, string>> and its - only purpose is to make Ninject happy which was throwing an exception - when constructor injecting this type. - - - - - Calculates how long a byte array of X length will be after base64 encoding - - The normal, 8bit per byte, length of the byte array - Base64 encoded length - - - - Cryptographic setup for classes that use encryption and HMAC - - - - - Creates a new instance of the CryptographyConfiguration class - - Encryption provider - HMAC provider - - - - Gets the default configuration - Rijndael encryption, HMACSHA256 HMAC, random keys - - - - - Gets configuration with no encryption and HMACSHA256 HMAC with a random key - - - - - Gets the encryption provider - - - - - Gets the hmac provider - - - - - Provides SHA-256 HMACs - - - - - Creates Hash-based Message Authentication Codes (HMACs) - - - - - Create a hmac from the given data - - Data to create hmac from - Hmac bytes - - - - Create a hmac from the given data - - Data to create hmac from - Hmac bytes - - - - Gets the length of the HMAC signature in bytes - - - - - Preferred key size for HMACSHA256 - - - - - HMAC length - - - - - Key - - - - - Creates a new instance of the DefaultHmacProvider type - - Key generator to use to generate the key - - - - Create a hmac from the given data using the given passPhrase - - Data to create hmac from - String representation of the hmac - - - - Create a hmac from the given data - - Data to create hmac from - Hmac bytes - - - - Gets the length of the HMAC signature - - - - - Compare two hmac byte arrays without any early exits - - First hmac - Second hmac - Expected length of the hash - True if equal, false otherwise - - - - Provides key byte generation - - - - - Generate a sequence of bytes - - Number of bytes to return - Array bytes - - - - A "no op" encryption provider - Useful for debugging or performance. - - - - - Provides symmetrical encryption support - - - - - Encrypt and base64 encode the string - - Data to encrypt - Encrypted string - - - - Decrypt string - - Data to decrypt - Decrypted string - - - - Encrypt data - - Data to encrypt - Encrypted string - - - - Decrypt string - - Data to decrypt - Decrypted string - - - - Provides key generation using PBKDF2 / Rfc2898 - NOTE: the salt is static so the passphrase should be long and complex - (As the bytes are generated at app startup, because it's too slow to do per - request, so the salt cannot be randomly generated and stored) - - - - - Initializes a new instance of the class, with - the provided , and optional - number of - - The passphrase that should be used. - The salt - The number of iterations. The default value is 10000. - - - - Generate a sequence of bytes - - Number of bytes to return - Array bytes - - - - Generates random secure keys using RNGCryptoServiceProvider - - - - - Creates NancyContext instances - - - - - Creates NancyContext instances - - - - - Create a new NancyContext - - NancyContext instance - - - - Creates a new instance of the class. - - An instance. - An instance. - An instance. - - - - Create a new instance. - - A instance. - - - - The default implementation of the interface. - - - - - Gets the generic item store. - - An instance containing the items. - - - - Gets or sets the information about the request. - - An instance. - - - - Gets or sets the information about the response. - - An instance. - - - - Gets or sets the trace log. - - A instance. - - - - Initializes a new instance of the class. - - The value to store in the instance - - - - Returns a default value if Value is null - - When no default value is supplied, required to supply the default type - Optional parameter for default value, if not given it returns default of type T - If value is not null, value is returned, else default value is returned - - - - Attempts to convert the value to type of T, failing to do so will return the defaultValue. - - When no default value is supplied, required to supply the default type - Optional parameter for default value, if not given it returns default of type T - If value is not null, value is returned, else default value is returned - - - - Indicates whether the current object is equal to another object of the same type. - - true if the current object is equal to the parameter; otherwise, false. - - An to compare with this instance. - - - - Determines whether the specified is equal to the current . - - true if the specified is equal to the current ; otherwise, false. - The to compare with the current . - - - - Serves as a hash function for a particular type. - - A hash code for the current instance. - - - - Provides implementation for binary operations. Classes derived from the class can override this method to specify dynamic behavior for operations such as addition and multiplication. - - true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a language-specific run-time exception is thrown.) - Provides information about the binary operation. The binder.Operation property returns an object. For example, for the sum = first + second statement, where first and second are derived from the DynamicObject class, binder.Operation returns ExpressionType.Add.The right operand for the binary operation. For example, for the sum = first + second statement, where first and second are derived from the DynamicObject class, is equal to second.The result of the binary operation. - - - - Provides implementation for type conversion operations. Classes derived from the class can override this method to specify dynamic behavior for operations that convert an object from one type to another. - - true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a language-specific run-time exception is thrown.) - Provides information about the conversion operation. The binder.Type property provides the type to which the object must be converted. For example, for the statement (String)sampleObject in C# (CType(sampleObject, Type) in Visual Basic), where sampleObject is an instance of the class derived from the class, binder.Type returns the type. The binder.Explicit property provides information about the kind of conversion that occurs. It returns true for explicit conversion and false for implicit conversion.The result of the type conversion operation. - - - - Returns the for this instance. - - - The enumerated constant that is the of the class or value type that implements this interface. - - 2 - - - - Converts the value of this instance to an equivalent Boolean value using the specified culture-specific formatting information. - - - A Boolean value equivalent to the value of this instance. - - An interface implementation that supplies culture-specific formatting information. 2 - - - - Converts the value of this instance to an equivalent Unicode character using the specified culture-specific formatting information. - - - A Unicode character equivalent to the value of this instance. - - An interface implementation that supplies culture-specific formatting information. 2 - - - - Converts the value of this instance to an equivalent 8-bit signed integer using the specified culture-specific formatting information. - - - An 8-bit signed integer equivalent to the value of this instance. - - An interface implementation that supplies culture-specific formatting information. 2 - - - - Converts the value of this instance to an equivalent 8-bit unsigned integer using the specified culture-specific formatting information. - - - An 8-bit unsigned integer equivalent to the value of this instance. - - An interface implementation that supplies culture-specific formatting information. 2 - - - - Converts the value of this instance to an equivalent 16-bit signed integer using the specified culture-specific formatting information. - - - An 16-bit signed integer equivalent to the value of this instance. - - An interface implementation that supplies culture-specific formatting information. 2 - - - - Converts the value of this instance to an equivalent 16-bit unsigned integer using the specified culture-specific formatting information. - - - An 16-bit unsigned integer equivalent to the value of this instance. - - An interface implementation that supplies culture-specific formatting information. 2 - - - - Converts the value of this instance to an equivalent 32-bit signed integer using the specified culture-specific formatting information. - - - An 32-bit signed integer equivalent to the value of this instance. - - An interface implementation that supplies culture-specific formatting information. 2 - - - - Converts the value of this instance to an equivalent 32-bit unsigned integer using the specified culture-specific formatting information. - - - An 32-bit unsigned integer equivalent to the value of this instance. - - An interface implementation that supplies culture-specific formatting information. 2 - - - - Converts the value of this instance to an equivalent 64-bit signed integer using the specified culture-specific formatting information. - - - An 64-bit signed integer equivalent to the value of this instance. - - An interface implementation that supplies culture-specific formatting information. 2 - - - - Converts the value of this instance to an equivalent 64-bit unsigned integer using the specified culture-specific formatting information. - - - An 64-bit unsigned integer equivalent to the value of this instance. - - An interface implementation that supplies culture-specific formatting information. 2 - - - - Converts the value of this instance to an equivalent single-precision floating-point number using the specified culture-specific formatting information. - - - A single-precision floating-point number equivalent to the value of this instance. - - An interface implementation that supplies culture-specific formatting information. 2 - - - - Converts the value of this instance to an equivalent double-precision floating-point number using the specified culture-specific formatting information. - - - A double-precision floating-point number equivalent to the value of this instance. - - An interface implementation that supplies culture-specific formatting information. 2 - - - - Converts the value of this instance to an equivalent number using the specified culture-specific formatting information. - - - A number equivalent to the value of this instance. - - An interface implementation that supplies culture-specific formatting information. 2 - - - - Converts the value of this instance to an equivalent using the specified culture-specific formatting information. - - - A instance equivalent to the value of this instance. - - An interface implementation that supplies culture-specific formatting information. 2 - - - - Converts the value of this instance to an equivalent using the specified culture-specific formatting information. - - - A instance equivalent to the value of this instance. - - An interface implementation that supplies culture-specific formatting information. 2 - - - - Converts the value of this instance to an of the specified that has an equivalent value, using the specified culture-specific formatting information. - - - An instance of type whose value is equivalent to the value of this instance. - - The to which the value of this instance is converted. An interface implementation that supplies culture-specific formatting information. 2 - - - - Gets a value indicating whether this instance has value. - - true if this instance has value; otherwise, false. - is considered as not being a value. - - - - Gets the inner value - - - - - Default error handler - - - - - Provides informative responses for particular HTTP status codes - - - - - Check if the error handler can handle errors of the provided status code. - - Status code - The instance of the current request. - True if handled, false otherwise - - - - Handle the error code - - Status code - Current context - - - - Initializes a new instance of the type. - - The response negotiator. - - - - Whether the status code is handled - - Status code - The instance of the current request. - True if handled, false otherwise - - - - Handle the error code - - Status code - The instance of the current request. - Nancy Response - - - - - A simple pipeline for on-error hooks. - Hooks will be executed until either a hook returns a response, or every - hook has been executed. - - - Can be implictly cast to/from the on-error hook delegate signature - (Func NancyContext, Exception, Response) for assigning to NancyEngine or for building - composite pipelines. - - - - - - Pipeline items to execute - - - - - Add an item to the start of the pipeline - - Item to add - - - - Add an item to the start of the pipeline - - Item to add - - Whether to replace an existing item with the same name in its current place, - rather than at the position requested. Defaults to false. - - - - - Add an item to the end of the pipeline - - Item to add - - - - Add an item to the end of the pipeline - - Item to add - - Whether to replace an existing item with the same name in its current place, - rather than at the position requested. Defaults to false. - - - - - Add an item to a specific place in the pipeline. - - Index to add at - Item to add - - - - Add an item to a specific place in the pipeline. - - Index to add at - Item to add - - Whether to replace an existing item with the same name in its current place, - rather than at the position requested. Defaults to false. - - - - - Insert an item before a named item. - If the named item does not exist the item is inserted at the start of the pipeline. - - Name of the item to insert before - Item to insert - - - - Insert an item before a named item. - If the named item does not exist the item is inserted at the start of the pipeline. - - Name of the item to insert before - Item to insert - - - - Insert an item after a named item. - If the named item does not exist the item is inserted at the end of the pipeline. - - Name of the item to insert after - Item to insert - - - - Insert an item after a named item. - If the named item does not exist the item is inserted at the end of the pipeline. - - Name of the item to insert after - Item to insert - - - - Remove a named pipeline item - - Name - Index of item that was removed or -1 if nothing removed - - - - Gets the current pipeline items - - - - - Gets the current pipeline item delegates - - - - - Invoke the pipeline. Each item will be invoked in turn until either an - item returns a Response, or all items have been invoked. - - - The current context to pass to the items. - - - The exception currently being handled by the error pipeline - - - Response from an item invocation, or null if no response was generated. - - - - - Assembly extension methods - - - - - Gets exported types from an assembly and catches common errors - that occur when running under test runners. - - Assembly to retrieve from - An array of types - - - - Bootstrapper for the Nancy Engine - - - - - Initialise the bootstrapper. Must be called prior to GetEngine. - - - - - Gets the configured INancyEngine - - Configured INancyEngine - - - - Represents a module type for registration into a container - - Type of the module - - - - Nancy bootstrapper base class - - IoC container type - - - - Stores whether the bootstrapper has been initialised - prior to calling GetEngine. - - - - - Stores whether the bootstrapper is in the process of - being disposed. - - - - - Stores the used by Nancy - - - - - Default Nancy conventions - - - - - Internal configuration - - - - - Nancy modules - built on startup from the app domain scanner - - - - - Initializes a new instance of the class. - - - - - Initialise the bootstrapper. Must be called prior to GetEngine. - - - - - Gets the diagnostics for initialisation - - IDiagnostics implementation - - - - Gets all registered application startup tasks - - An instance containing instances. - - - - Registers and resolves all request startup tasks - - Container to use - Types to register - An instance containing instances. - - - - Gets all registered application registration tasks - - An instance containing instances. - - - - Get all NancyModule implementation instances - - The current context - An instance containing instances. - - - - Retrieves a specific implementation - should be per-request lifetime - - Module type - The current context - The instance - - - - Gets the configured INancyEngine - - Configured INancyEngine - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - 2 - - - - Hides Equals from the overrides list - - Object to compare - Boolean indicating equality - - - - Hides GetHashCode from the overrides list - - Hash code integer - - - - Creates and initializes the request pipelines. - - The used by the request. - An instance. - - - - Hides ToString from the overrides list - - String representation - - - - Initialise the bootstrapper - can be used for adding pre/post hooks and - any other initialisation tasks that aren't specifically container setup - related - - Container instance for resolving types if required. - - - - Initialise the request - can be used for adding pre/post hooks and - any other per-request initialisation tasks that aren't specifically container setup - related - - Container - Current pipelines - Current context - - - - Configure the application level container with any additional registrations. - - Container instance - - - - Overrides/configures Nancy's conventions - - Convention object instance - - - - Resolve INancyEngine - - INancyEngine implementation - - - - Gets the application level container - - Container instance - - - - Register the bootstrapper's implemented types into the container. - This is necessary so a user can pass in a populated container but not have - to take the responsibility of registering things like INancyModuleCatalog manually. - - Application container to register into - - - - Register the default implementations of internally used types into the container as singletons - - Container to register into - Type registrations to register - - - - Register the various collections into the container as singletons to later be resolved - by IEnumerable{Type} constructor dependencies. - - Container to register into - Collection type registrations to register - - - - Register the given module types into the container - - Container to register into - NancyModule types - - - - Register the given instances into the container - - Container to register into - Instance registration types - - - - Gets additional required type registrations - that don't form part of the core Nancy configuration - - Collection of TypeRegistration types - - - - Gets any additional instance registrations that need to - be registered into the container - - Collection of InstanceRegistration types - - - - Creates a list of types for the collection types that are - required to be registered in the application scope. - - Collection of CollectionTypeRegistration types - - - - Takes the registration tasks and calls the relevant methods to register them - - Registration tasks - - - - Application pipelines. - Pipelines are "cloned" per request so they can be modified - at the request level. - - - - - Cache of request startup task types - - - - - Gets the Container instance - automatically set during initialise. - - - - - Nancy internal configuration - - - - - Nancy conventions - - - - - Gets all available module types - - - - - Gets the available view engine types - - - - - Gets the available custom model binders - - - - - Gets the available custom type converters - - - - - Gets the available custom body deserializers - - - - - Gets all application startup tasks - - - - - Gets all request startup tasks - - - - - Gets all registration tasks - - - - - Gets the root path provider - - - - - Gets the validator factories. - - - - - Gets the default favicon - - - - - Gets the cryptography configuration - - - - - Gets the diagnostics / dashboard configuration (password etc) - - - - - Class for locating an INancyBootstrapper implementation. - - Will search the app domain for a non-abstract one, and if it can't find one - it will use the default nancy one that uses TinyIoC. - - - - - Gets the located bootstrapper - - - - - Represents a type to be registered into the container - - - - - Represents a type to be registered into the container - - Registration type i.e. IMyInterface - Implementation type i.e. MyClassThatImplementsIMyInterface - Lifetime to register the type as - - - - Implementation type i.e. MyClassThatImplementsIMyInterface - - - - - Default cookie implementation for Nancy. - - - - - The domain to restrict the cookie to - - - - - When the cookie should expire - - A instance containing the date and time when the cookie should expire; otherwise if it should expire at the end of the session. - - - - The name of the cookie - - - - - Gets the encoded name of the cookie - - - - - The path to restrict the cookie to - - - - - The value of the cookie - - - - - Gets the encoded value of the cookie - - - - - Whether the cookie is http only - - - - - Whether the cookie is secure (i.e. HTTPS only) - - - - - Initializes a new instance of the class. - - The name of the cookie. - The value of the cookie. - - - - Initializes a new instance of the class. - - The name of the cookie. - The value of the cookie. - The expiration date of the cookie. Can be if it should expire at the end of the session. - - - - Initializes a new instance of the class. - - The name of the cookie. - The value of the cookie. - Whether the cookie is http only. - - - - Initializes a new instance of the class. - - The name of the cookie. - The value of the cookie. - Whether the cookie is http only. - Whether the cookie is secure (i.e. HTTPS only). - - - - Initializes a new instance of the class. - - The name of the cookie. - The value of the cookie. - Whether the cookie is http only. - Whether the cookie is secure (i.e. HTTPS only). - The expiration date of the cookie. Can be if it should expire at the end of the session. - - - - The domain to restrict the cookie to - - - - - When the cookie should expire - - A instance containing the date and time when the cookie should expire; otherwise if it should expire at the end of the session. - - - - The name of the cookie - - - - - Gets the encoded name of the cookie - - - - - The path to restrict the cookie to - - - - - The value of the cookie - - - - - Gets the encoded value of the cookie - - - - - Whether the cookie is http only - - - - - Whether the cookie is secure (i.e. HTTPS only) - - - - - TinyIoC bootstrapper - registers default route resolver and registers itself as - INancyModuleCatalog for resolving modules but behaviour can be overridden if required. - - - - - Nancy bootstrapper base with per-request container support. - Stores/retrieves the child container in the context to ensure that - only one child container is stored per request, and that the child - container will be disposed at the end of the request. - - IoC container type - - - - Context key for storing the child container in the context - - - - - Stores the module registrations to be registered into the request container - - - - - Get all implementation instances - - The current context - An instance containing instances. - - - - Retrieves a specific implementation - should be per-request lifetime - - Module type - The current context - The instance - - - - Creates and initializes the request pipelines. - - The used by the request. - An instance. - - - - Takes the registration tasks and calls the relevant methods to register them - - Registration tasks - - - - Gets the per-request container - - Current context - Request container instance - - - - Configure the request container - - Request container instance - - - - - Register the given module types into the container - - Container to register into - NancyModule types - - - - Creates a per request child/nested container - - Current context - Request container instance - - - - Register the given module types into the request container - - Container to register into - NancyModule types - - - - Retrieve all module instances from the container - - Container to use - Collection of NancyModule instances - - - - Retrieve a specific module instance from the container - - Container to use - Type of the module - NancyModule instance - - - - Stores the per-request type registrations - - - - - Stores the per-request collection registrations - - - - - Gets the context key for storing the child container in the context - - - - - Default assemblies that are ignored for autoregister - - - - - Configures the container using AutoRegister followed by registration - of default INancyModuleCatalog and IRouteResolver. - - Container instance - - - - Resolve INancyEngine - - INancyEngine implementation - - - - Create a default, unconfigured, container - - Container instance - - - - Register the bootstrapper's implemented types into the container. - This is necessary so a user can pass in a populated container but not have - to take the responsibility of registering things like INancyModuleCatalog manually. - - Application container to register into - - - - Register the default implementations of internally used types into the container as singletons - - Container to register into - Type registrations to register - - - - Register the various collections into the container as singletons to later be resolved - by IEnumerable{Type} constructor dependencies. - - Container to register into - Collection type registrations to register - - - - Register the given module types into the container - - Container to register into - NancyModule types - - - - Register the given instances into the container - - Container to register into - Instance registration types - - - - Creates a per request child/nested container - - Current context - Request container instance - - - - Gets the diagnostics for initialisation - - IDiagnostics implementation - - - - Gets all registered startup tasks - - An instance containing instances. - - - - Gets all registered request startup tasks - - An instance containing instances. - - - - Gets all registered application registration tasks - - An instance containing instances. - - - - Retrieve all module instances from the container - - Container to use - Collection of NancyModule instances - - - - Retrieve a specific module instance from the container - - Container to use - Type of the module - NancyModule instance - - - - Executes auto registation with the given container. - - Container instance - - - - Gets the assemblies to ignore when autoregistering the application container - Return true from the delegate to ignore that particular assembly, returning false - does not mean the assembly *will* be included, a true from another delegate will - take precedence. - - - - - Containing extensions for the object - - - - - Ascertains if a request originated from an Ajax request or not. - - The current nancy context - True if the request was done using ajax, false otherwise - - - - Expands a path to take into account a base path (if any) - - Nancy context - Path to expand - Expanded path - - - - Returns a redirect response with the redirect path expanded to take into - account a base path (if any) - - Nancy context - Path to redirect to - Redirect response - - - - Retrieves exception details from the context, if any exist - - Nancy context - Exception details - - - - Get a thrown exception from the context. - - The context. - The thrown exception or null if not exception has been thrown. - - - - Get a thrown exception of the given type from the context. - - The type of exception to get. - The context. - The thrown exception or null if not exception has been thrown. - - - - Tries to get a thrown exception from the context. - - The context. - The thrown exception. - true if an exception has been thrown during the request, false otherwise. - - - - Tries to get a thrown exception of the given type from the context. - - The type of exception to get. - The context. - The thrown exception. - true if an exception of the given type has been thrown during the request, false otherwise. - - - - Shortcut extension method for writing trace information - - Nancy context - Log delegate - - - - Returns a boolean indicating whether a given url string is local or not - - Nancy context - Url string (relative or absolute) - True if local, false otherwise - - - - Containing extensions for implementations. - - - - - A regular expression used to manipulate parameterized route segments. - - A object. - - - - Extracts the friendly name of a Nancy module given its type. - - The module instance - A string containing the name of the parameter. - - - - - Returns a boolean indicating whether the route is executing, or whether the module is - being constructed. - - The module instance - True if the route is being executed, false if the module is being constructed - - - - Adds the before delegate to the Before pipeline if the module is not currently executing, - or executes the delegate directly and returns any response returned if it is. - Uses - - Current module - Delegate to add or execute - Optional reason for the early exit (if necessary) - - - - Containing extensions for the object - - - - - An extension method making it easy to check if the request was done using ajax - - The request made by client - if the request was done using ajax, otherwise . - - - - Gets a value indicating whether the request is local. - - The request made by client - if the request is local, otherwise . - - - - Containing extensions for the object. - - - - - A regular expression used to manipulate parameterized route segments. - - A object. - - - - Extracts information about the parameters in the . - - The segment that the information should be extracted from. - An , containing instances for the parameters in the segment. - - - - Checks if a segment contains any parameters. - - The segment to check for parameters. - true if the segment contains a parameter; otherwise false. - A parameter is defined as a string which is surrounded by a pair of curly brackets. - The provided value for the segment parameter was null or empty. - - - - Gets a dynamic dictionary back from a Uri query string - - The query string to extract values from - A dynamic dictionary containing the query string values - - - - Converts the value from PascalCase to camelCase. - - The value. - System.String. - - - - Converts the value from camelCase to PascalCase. - - The value. - System.String. - - - - Provides strongly-typed access to HTTP request headers. - - - - - Initializes a new instance of the class. - - The headers. - - - - Returns an enumerator that iterates through the collection. - - A that can be used to iterate through the collection. - - - - Returns an enumerator that iterates through a collection. - - An object that can be used to iterate through the collection. - - - - Content-types that are acceptable. - - An that contains the header values if they are available; otherwise it will be empty. - - - - Character sets that are acceptable. - - An that contains the header values if they are available; otherwise it will be empty. - - - - Acceptable encodings. - - An that contains the header values if they are available; otherwise it will be empty. - - - - Acceptable languages for response. - - An that contains the header values if they are available; otherwise it will be empty. - - - - Authorization header value for request. - - A containing the header value if it is available; otherwise . - - - - Used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. - - An that contains the header values if they are available; otherwise it will be empty. - - - - Contains name/value pairs of information stored for that URL. - - An that contains instances if they are available; otherwise it will be empty. - - - - What type of connection the user-agent would prefer. - - A containing the header value if it is available; otherwise . - - - - The length of the request body in octets (8-bit bytes). - - The length of the contents if it is available; otherwise 0. - - - - The mime type of the body of the request (used with POST and PUT requests). - - A containing the header value if it is available; otherwise . - - - - The date and time that the message was sent. - - A instance that specifies when the message was sent. If not available then will be returned. - - - - The domain name of the server (for virtual hosting), mandatory since HTTP/1.1 - - A containing the header value if it is available; otherwise . - - - - Only perform the action if the client supplied entity matches the same entity on the server. This is mainly for methods like PUT to only update a resource if it has not been modified since the user last updated it. - - An that contains the header values if they are available; otherwise it will be empty. - - - - Allows a 304 Not Modified to be returned if content is unchanged - - A instance that specifies when the requested resource must have been changed since. If not available then will be returned. - - - - Allows a 304 Not Modified to be returned if content is unchanged - - An that contains the header values if they are available; otherwise it will be empty. - - - - If the entity is unchanged, send me the part(s) that I am missing; otherwise, send me the entire new entity. - - A containing the header value if it is available; otherwise . - - - - Only send the response if the entity has not been modified since a specific time. - - A instance that specifies when the requested resource may not have been changed since. If not available then will be returned. - - - - Gets the names of the available request headers. - - An containing the names of the headers. - - - - Limit the number of times the message can be forwarded through proxies or gateways. - - The number of the maximum allowed number of forwards if it is available; otherwise 0. - - - - This is the address of the previous web page from which a link to the currently requested page was followed. - - A containing the header value if it is available; otherwise . - - - - The user agent string of the user agent - - A containing the header value if it is available; otherwise . - - - - Gets all the header values. - - An that contains all the header values. - - - - Gets the values for the header identified by the parameter. - - The name of the header to return the values for. - An that contains the values for the header. If the header is not defined then is returned. - - - - Represents a HTML (text/html) response - - - - - Creates a new instance of the HtmlResponse class - - Status code - defaults to OK - Response body delegate - defaults to empty if null - Headers if required - Cookies if required - - - - Csrf protection methods - - - - - Enables Csrf token generation. - This is disabled by default. - - Application pipelines - - - - Disable csrf token generation - - Application pipelines - - - - Creates a new csrf token for this response with an optional salt. - Only necessary if a particular route requires a new token for each request. - - Nancy module - - - - - Creates a new csrf token with an optional salt. - Does not store the token in context. - - The generated token - - - - Validate that the incoming request has valid CSRF tokens. - Throws if validation fails. - - Module object - Optional validity period before it times out - If validation fails - - - - Wires up the CSRF (anti-forgery token) support at application startup. - - - - - Initializes a new instance of the class, using the - provided , and . - - The cryptographic configuration to use. - The serializer that should be used. - The token validator that should be used. - - - - Perform any initialisation tasks - - Application pipelines - - - - Gets the configured crypto config - - - - - Gets the configured object serialiser - - - - - Gets the configured token validator - - - - - Represents a Csrf protection token - - - - - The default key for the csrf cookie/form value/querystring value - - - - - Determines whether the specified is equal to the current . - - - true if the specified is equal to the current ; otherwise, false. - - The to compare with the current . 2 - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - 2 - - - - Randomly generated bytes - - - - - Date and time the token was created - - - - - Tamper prevention hmac - - - - - Gets a byte array representation of the csrf token for generating - hmacs - - Token - Byte array representing the token - - - - Calculates and sets the Hmac property on a given token - - Token - Hmac provider to use - Hmac bytes - - - - Creates random bytes for the csrf token - - Random byte array - - - - The default implementation of the interface. - - - - - Validates Csrf tokens - - - - - Validates a pair of tokens - - First token (usually from either a form post or querystring) - Second token (usually from a cookie) - Optional period that the tokens are valid for - Token validation result - - - - Validates that a cookie token is still valid with the current configuration / keys - - Token to validate - True if valid, false otherwise - - - - Initializes a new instance of the class, - using the provided . - - The that should be used. - - - - Validates a pair of tokens - - First token (usually from either a form post or querystring) - Second token (usually from a cookie) - Optional period that the tokens are valid for - Token validation result - - - - Validates that a cookie token is still valid with the current configuration / keys - - Token to validate - True if valid, false otherwise - - - - Result of Csrf Token validation - - - - - Validated ok - - - - - One or both of the tokens appears to have been tampered with - - - - - One or both of the tokens are missing - - - - - Tokens to not match - - - - - Token is valid, but has expired - - - - - Containing extensions for the object. - - - - - Force the response to be downloaded as an attachment - - Response object - Filename for the download - Optional content type - Modified Response object - - - - Adds a to the response. - - Response object - The name of the cookie. - The value of the cookie. - The instance. - - - - Adds a to the response. - - Response object - The name of the cookie. - The value of the cookie. - The expiration date of the cookie. Can be if it should expire at the end of the session. - The instance. - - - - Adds a to the response. - - Response object - The name of the cookie. - The value of the cookie. - The expiration date of the cookie. Can be if it should expire at the end of the session. - The domain of the cookie. - The path of the cookie. - The instance. - - - - Adds a to the response. - - Response object - A instance. - - - - - Add a header to the response - - Response object - Header name - Header value - Modified response - - - - Adds headers to the response using anonymous types - - Response object - - Array of headers - each header should be an anonymous type with two string properties - 'Header' and 'Value' to represent the header name and its value. - - Modified response - - - - Adds headers to the response using anonymous types - - Response object - - Array of headers - each header should be a Tuple with two string elements - for header name and header value - - Modified response - - - - Sets the content type of the response - - Response object - The type of the content - Modified response - - - - Sets the status code of the response - - Response object - The http status code - Modified response - - - - Sets the status code of the response - - Response object - The http status code - Modified response - - - - Assigns the root path of the application whom ever needs it. - - This task is run at application startup. - - - - Initializes a new instance of the class. - - An instance. - - - - Perform any initialisation tasks - - - - - Defines the core functionality of an identity - - - - - The username of the authenticated user. - - A containing the username. - - - - The claims of the authenticated user. - - An , containing the claims. - - - - Gets or sets a value indicating whether or not to disable traces in error messages - - - - - Gets or sets a value indicating whether or not to respond with 405 responses - - - - - Gets or sets a value indicating whether or not to enable case sensitivity in query, parameters (DynamicDictionary) and model binding. Enable this to conform with RFC3986. - - - - - Gets or sets a value indicating whether or not to route HEAD requests explicitly. - - - - - Gets a value indicating whether we are running in debug mode or not. - Checks the entry assembly to see whether it has been built in debug mode. - If anything goes wrong it returns false. - - - - - Gets or sets the limit on the number of query string variables, form fields, - or multipart sections in a request. - - - - - Gets or sets a value indicating whether or not to enable request tracing - - - - - Gets or sets a value indicating whether or not to disable request stream switching - - - - - Gets or sets a value indicating whether this allow file stream - upload async due to mono issues before v4. Uploads of over 80mb would result in extra padded chars to the filestream corrupting the file. - - true if allow file stream upload async; otherwise, false. - - - - Gets or sets a value indicating whether or not to enable runtime view discovery - Defaults to True in debug mode and False in release mode - - - - - Gets or sets a value indicating whether or not to allow runtime changes of views - Defaults to True in debug mode and False in release mode - - - - - Represents a full Url of the form scheme://hostname:port/basepath/path?query - - Since this is for internal use, and fragments are not passed to the server, fragments are not supported. - - - - Creates an instance of the class - - - - - Creates an instance of the class - - A containing a URL. - - - - Clones the url. - - Returns a new cloned instance of the url. - - - - Clones the url. - - Returns a new cloned instance of the url. - - - - Casts the current instance to a instance. - - The instance that should be cast. - A representation of the . - - - - Casts the current instance to a instance. - - The instance that should be cast. - An representation of the . - - - - Casts the current instance to a instance. - - The instance that should be cast. - An representation of the . - - - - Casts a instance to a instance - - The instance that should be cast. - An representation of the . - - - - Gets or sets the HTTP protocol used by the client. - - The protocol. - - - - Gets the hostname of the request - - - - - Gets the port name of the request - - - - - Gets the base path of the request i.e. the "Nancy root" - - - - - Gets the path of the request, relative to the base path - This property drives the route matching - - - - - Gets the querystring data of the requested resource. - - - - - Gets the domain part of the request - - - - - Gets whether the url is secure or not. - - - - - A composite validator to combine other validators. - - - - - Provides a way to validate a type as well as a description to use for client-side validation. - - - - - Validates the specified instance. - - The instance that should be validated. - The of the current request. - A with the result of the validation. - - - - Gets the description of the validator. - - - - - Gets the of the model that is being validated by the validator. - - - - - Initializes a new instance of the class. - - The validators. - The type of the model that is being validated. - - - - Validates the specified instance. - - The instance that should be validated. - The of the current request. - A with the result of the validation. - - - - Gets the description of the validator. - - - - - The type of the model that is being validated by the validator. - - - - - The default Nancy implementation of IValidatorLocator. - - - - - Locates a validator for a given type. - - - - - Gets a validator for a given type. - - The type to validate. - An instance or if none found. - - - - Initializes a new instance of the class. - - The factories. - - - - Gets a validator for a given type. - - The type to validate. - An instance or if none found. - - - - Creates instances of IValidator. - - - - - Creates a validator for the given type. - - The type. - A validator for the given type or null if none exists. - - - - Exception that is thrown during problems with model validation. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class, - with the provided . - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class, - with the provided and - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or a null reference if no inner exception is specified. - - - - Extensions to for validation. - - - - - Performs validation on the specified . - - The type of the that is being validated. - The module that the validation is performed from. - The instance that is being validated. - A instance. - - - - Specifies the validation comparison operators used by the type. - - - - - A comparison for greater than. - - - - - A comparison for greater than or equal to. - - - - - A comparison for less than. - - - - - A comparison for less than or equal to. - - - - - A comparison for equality. - - - - - A comparison for inequality. - - - - - Implementation of for ensuring a string does not - contain an empty value. - - - - - A description of a validation rule. - - - - - Initializes a new instance of the class. - - Type of the rule. - The error message formatter. - - - - Initializes a new instance of the class. - - Type of the rule. - The error message formatter. - Name of the member. - - - - Gets the error message that this rule will provide upon error. - - The name. - The error message. - - - - Gets the names of the members this rule validates. - - An that contains the name of the member. - - - - Gets the type of the rule. - - The type of the rule. - - - - Initializes a new instance of the class. - - The error message formatter. - The member names. - - - - Implementation of for ensuring a string is not null. - - - - - Initializes a new instance of the class. - - The error message formatter. - The member names. - - - - Implementation of for comparing two values using a - provided . - - - - - Initializes a new instance of the class. - - The error message formatter. - The member names. - The that should be used when comparing values. - Gets the value to compare against. - - - - The that should be used when comparing values. - - A value. - - - - Gets the value to compare against. - - - - - Implementation of for ensuring a string matches the - pattern which is defined by a regex. - - - - - Initializes a new instance of the class. - - The error message formatter. - The member names. - The regex pattern that should be used to check for a match. - - - - The regex pattern that should be used to check for a match. - - - - - Implementation of for ensuring that the length of a string - is withing the specified range. - - - - - Initializes a new instance of the class. - - The error message formatter. - The member names. - Minimum allowed length of the string - Maximum allowed length of the string - - - - Gets the length of the min. - - The length of the min. - - - - Gets the length of the max. - - The length of the max. - - - - A description of the rules a validator provides. - - - - - Initializes a new instance of the class. - - The rules that describes the model. - The type of the model that the rules are defined for. - - - - Initializes a new instance of the class. - - The rules that describes the model, grouped by member name. - The type of the model that the rules are defined for. - - - - The type of the model that is being described. - - - - - Gets the rules. - - An instance that contains instances grouped by property name. - - - - Represents a model validation error. - - - - - Initializes a new instance of the class. - - Name of the member that the error describes. - - - - - Initializes a new instance of the class. - - The member names that the error describes. - - - - - Implicitly cast a validation error to a string. - - The that should be cast. - A containing the validation error description. - - - - Returns the . - - A string containing the error message. - - - - Gets the member names that are a part of the error. - - An that contains the name of the members. - - - - - - - - - Represents the result of a model validation. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The instances that makes up the result. - - - - Initializes a new instance of the class. - - The instances that makes up the result, grouped by member name. - - - - Gets the errors. - - An instance that contains instances grouped by property name. - - - - Gets a clean representation of the errors. - - - - - - Gets a value indicating whether the validated instance is valid or not. - - if the validated instance is valid; otherwise, . - - - - Default implementation for retrieving information about views that are stored on the file system. - - - - - Defines the functionality for retrieving information about views that are stored on the file system. - - - - - Gets information about view that are stored in folders below the applications root path. - - The path of the folder where the views should be looked for. - A list of view extensions to look for. - An containing view locations and contents readers. - - - - Gets the last modified time for the file specified - - Filename - Time the file was last modified - - - - Gets information about specific views that are stored in folders below the applications root path. - - The path of the folder where the views should be looked for. - Name of the view to search for - A list of view extensions to look for. - An containing view locations and contents readers. - - - - Gets information about view that are stored in folders below the applications root path. - - The path of the folder where the views should be looked for. - A list of view extensions to look for. - An containing view locations and contents readers. - - - - Gets the last modified time for the file specified - - Filename - Time the file was last modified - - - - Gets information about specific views that are stored in folders below the applications root path. - - The path of the folder where the views should be looked for. - Name of the view to search for - A list of view extensions to look for. - An containing view locations and contents readers. - - - - Default render context implementation. - - - - - Defines the functionality of the context that is passed into a view engine when the view is requested to be rendered. - - - - - Parses a path and returns an absolute url path, taking into account - base directory etc. - - Input url such as ~/styles/main.css - Parsed absolute url path - - - - HTML encodes a string. - - The string that should be HTML encoded. - A HTML encoded . - - - - Locates a view that matches the provided and . - - The name of the view that should be located. - The model that should be used when locating the view. - A instance if the view could be located; otherwise, . - - - - Gets the current Csrf token. - The token should be stored in a cookie and the form as a hidden field. - In both cases the name should be the key of the returned key value pair. - - A tuple containing the name (cookie name and form/querystring name) and value - - - - Gets the context of the current request. - - A instance. - - - - Gets the view cache that is used by Nancy. - - An instance. - - - - Gets the text resource for localisation - - - - - Gets the text resource finder for localisation - - - - - Initializes a new instance of the class. - - - - - - - - - Parses a path and returns an absolute url path, taking into account - base directory etc. - - Input url such as ~/styles/main.css - Parsed absolute url path - - - - HTML encodes a string. - - The string that should be HTML encoded. - A HTML encoded . - - - - Locates a view that matches the provided and . - - The name of the view that should be located. - The model that should be used when locating the view. - A instance if the view could be located; otherwise, . - - - - Generates a Csrf token. - The token should be stored in a cookie and the form as a hidden field. - In both cases the name should be the key of the returned key value pair. - - A tuple containing the name (cookie name and form/querystring name) and value - - - - Gets the context of the current request. - - A instance. - - - - Gets the view cache that is used by Nancy. - - An instance. - - - - Gets the text resource for localisation - - - - - Gets the text resource finder for localisation - - - - - Default render context factory implementation. - - - - - Defines the functionality required to manufacture instances. - - - - - Gets a for the specified . - - The for which the context should be created. - A instance. - - - - Initializes a new instance of the class. - - The view cache that should be used by the created render context. - The view resolver that should be used by the created render context. - The that should be used by the engine. - - - - Gets a for the specified . - - The for which the context should be created. - A instance. - - - - Default set of assemblies that should be scanned for items (views, text, content etc) - embedded as resources. - - The default convention will scan all assemblies that references another assemblies that has a name that starts with Nancy* - - - - Defines the functionality for retrieving which assemblies that should be used by Nancy. - - - - - Gets a list of assemblies that should be scanned. - - An of instances. - - - - Gets a list of assemblies that should be scanned for views. - - An of instances. - - - - Default implementation for extracting view information form an assembly. - - - - - Defines the functionality of a reader that extracts embedded views from an assembly. - - - - - Gets information about the resources that are embedded in the assembly. - - The to retrieve view information from. - A list of view extensions to look for. - A of resource locations and content readers. - - - - Gets information about the resources that are embedded in the assembly. - - The to retrieve view information from. - A list of view extensions to look for. - A of resource locations and content readers. - - - - Resource based implementation of - - - - - Initializes a new instance of to read strings from *.resx files - - The that should be used when scanning. - - - - Used to return a string value from *.resx files - - The key to look for in the resource file - The used to determine the culture for returning culture specific values. - Returns a string value from culture specific or default file or null if key does not exist as determined by . - - - - Default implementation of the interface. - - - - - Interface for manually rendering views to a Response object, rather - than going through content negotiation. - - - - - Renders a view to a response object, bypassing content negotiation. - - Current Nancy context - View name - Model object (or null) - Response object containing the rendered view (if found) - - - - Initializes an instance of the type, with - the provided . - - The that should be used to render the views. - - - - Renders a view to a response object, bypassing content negotiation. - - Current Nancy context - View name - Model object (or null) - Response object containing the rendered view (if found) - - - - View cache that supports expiring content if it is stale - - - - - Defines the functionality of a Nancy view cache. - - - - - Gets or adds a view from the cache. - - The type of the cached view instance. - A instance that describes the view that is being added or retrieved from the cache. - A function that produces the value that should be added to the cache in case it does not already exist. - An instance of the type specified by the type. - - - - Initializes a new instance of the class. - - - - - Gets or adds a view from the cache. - - The type of the cached view instance. - A instance that describes the view that is being added or retrieved from the cache. - A function that produces the value that should be added to the cache in case it does not already exist. - An instance of the type specified by the type. - - - - Contains miscellaneous extension methods. - - - - - Checks if the evaluated instance is an anonymous - - The object instance to check. - if the object is an anonymous type; otherwise . - - - - Contains the functionality for locating a view that is located on the file system. - - - - - Defines the functionality used by Nancy to located a view. - - - - - Returns an instance for all the views that could be located by the provider. - - An instance, containing the view engine file extensions that is supported by the running instance of Nancy. - An instance, containing instances for the located views. - If no views could be located, this method should return an empty enumerable, never . - - - - Returns an instance for all the views matching the viewName that could be located by the provider. - - An instance, containing the view engine file extensions that is supported by the running instance of Nancy. - Location of the view - The name of the view to try and find - An instance, containing instances for the located views. - If no views could be located, this method should return an empty enumerable, never . - - - - Initializes a new instance of the class. - - A instance. - Creating an instance using this constructor will result in the being used internally. - - - - Initializes a new instance of the class. - - A instance. - An instance that should be used when retrieving view information from the file system. - - - - Returns an instance for all the views that could be located by the provider. - - An instance, containing the view engine file extensions that is supported by the running instance of Nancy. - An instance, containing instances for the located views. - If no views could be located, this method should return an empty enumerable, never . - - - - Returns an instance for all the views matching the viewName that could be located by the provider. - - An instance, containing the view engine file extensions that is supported by the running instance of Nancy. - The name of the view to try and find - An instance, containing instances for the located views. - If no views could be located, this method should return an empty enumerable, never . - - - - Represents a HEAD only response. - - - - - Initializes a new instance of the class. - - - The full response to create the head response from. - - - - - Containing extensions for the collection objects. - - - - - Converts a to a instance. - - The to convert. - An instance. - - - - Converts an instance to a instance. - - The instance to convert. - A instance. - - - - Merges a collection of instances into a single one. - - The list of instances to merge. - An instance containing the keys and values from the other instances. - - - - Filters a collection based on a provided key selector. - - The collection filter. - The predicate to filter by. - The type of the collection to filter. - The type of the key to filter by. - A instance with the filtered values. - - - - Decodes an HTML-encoded string and returns the decoded string. - - The HTML string to decode. - The decoded text. - - - - Decodes an HTML-encoded string and sends the resulting output to a TextWriter output stream. - - The HTML string to decode - The TextWriter output stream containing the decoded string. - - - - HTML-encodes a string and sends the resulting output to a TextWriter output stream. - - The string to encode. - The TextWriter output stream containing the encoded string. - - - - Represents a file that was captured in a HTTP multipart/form-data request - - - - - Initializes a new instance of the class, - using the provided . - - The that contains the file information. - - - - Initializes a new instance of the class, - using the provided values - - The content type of the file. - The name of the file. - The content of the file. - The name of the field that uploaded the file. - - - - Gets or sets the type of the content. - - A containing the content type of the file. - - - - Gets or sets the name of the file. - - A containing the name of the file. - - - - Gets or sets the form element name of this file. - - A containing the key. - - - - Gets or sets the value stream. - - A containing the contents of the file. - This is a instance that sits ontop of the request stream. - - - - Retrieves instances from a request stream. - - - - - Initializes a new instance of the class. - - The request stream to parse. - The boundary marker to look for. - - - - Gets the instances from the request stream. - - An instance, containing the found instances. - - - - Represents the content boundary of a HTTP multipart/form-data boundary in a stream. - - - - - Initializes a new instance of the class. - - The stream that contains the boundary information. - - - - Gets the contents type of the boundary value. - - A containing the name of the value if it is available; otherwise . - - - - Gets or the filename for the boundary value. - - A containing the filename value if it is available; otherwise . - This is the RFC2047 decoded value of the filename attribute of the Content-Disposition header. - - - - Gets name of the boundary value. - - This is the RFC2047 decoded value of the name attribute of the Content-Disposition header. - - - - A stream containing the value of the boundary. - - This is the RFC2047 decoded value of the Content-Type header. - - - - A buffer that is used to locate a HTTP multipart/form-data boundary in a stream. - - - - - Initializes a new instance of the class. - - The boundary as a byte-array. - The closing boundary as byte-array - - - - Resets the buffer so that inserts happens from the start again. - - This does not clear any previously written data, just resets the buffer position to the start. Data that is inserted after Reset has been called will overwrite old data. - - - - Inserts the specified value into the buffer and advances the internal position. - - The value to insert into the buffer. - This will throw an is you attempt to call insert more times then the of the buffer and was not invoked. - - - - Gets a value indicating whether the buffer contains the same values as the boundary. - - if buffer contains the same values as the boundary; otherwise, . - - - - Gets a value indicating whether this buffer is full. - - if buffer is full; otherwise, . - - - - Gets the number of bytes that can be stored in the buffer. - - The number of bytes that can be stored in the buffer. - - - - HTTP Status Codes - - The values are based on the list found at http://en.wikipedia.org/wiki/List_of_HTTP_status_codes - - - - 100 Continue - - - - - 101 SwitchingProtocols - - - - - 102 Processing - - - - - 103 Checkpoint - - - - - 200 OK - - - - - 201 Created - - - - - 202 Accepted - - - - - 203 NonAuthoritativeInformation - - - - - 204 NoContent - - - - - 205 ResetContent - - - - - 206 PartialContent - - - - - 207 MultipleStatus - - - - - 226 IMUsed - - - - - 300 MultipleChoices - - - - - 301 MovedPermanently - - - - - 302 Found - - - - - 303 SeeOther - - - - - 304 NotModified - - - - - 305 UseProxy - - - - - 306 SwitchProxy - - - - - 307 TemporaryRedirect - - - - - 308 ResumeIncomplete - - - - - 400 BadRequest - - - - - 401 Unauthorized - - - - - 402 PaymentRequired - - - - - 403 Forbidden - - - - - 404 NotFound - - - - - 405 MethodNotAllowed - - - - - 406 NotAcceptable - - - - - 407 ProxyAuthenticationRequired - - - - - 408 RequestTimeout - - - - - 409 Conflict - - - - - 410 Gone - - - - - 411 LengthRequired - - - - - 412 PreconditionFailed - - - - - 413 RequestEntityTooLarge - - - - - 414 RequestUriTooLong - - - - - 415 UnsupportedMediaType - - - - - 416 RequestedRangeNotSatisfiable - - - - - 417 ExpectationFailed - - - - - 418 ImATeapot - - - - - 420 Enhance Your Calm - - - - - 422 UnprocessableEntity - - - - - 423 Locked - - - - - 424 FailedDependency - - - - - 425 UnorderedCollection - - - - - 426 UpgradeRequired - - - - - 429 Too Many Requests - - - - - 444 NoResponse - - - - - 449 RetryWith - - - - - 450 BlockedByWindowsParentalControls - - - - - 499 ClientClosedRequest - - - - - 500 InternalServerError - - - - - 501 NotImplemented - - - - - 502 BadGateway - - - - - 503 ServiceUnavailable - - - - - 504 GatewayTimeout - - - - - 505 HttpVersionNotSupported - - - - - 506 VariantAlsoNegotiates - - - - - 507 InsufficientStorage - - - - - 509 BandwidthLimitExceeded - - - - - 510 NotExtended - - - - - An extension point for adding support for formatting response contents. No members should be added to this interface without good reason. - - Extension methods to this interface should always return or one of the types that can implicitly be types into a . - - - - Gets all serializers currently registered - - - - - Gets the context for which the response is being formatted. - - A instance. - - - - Gets the root path of the application. - - A containing the root path. - - - - Attempts to detect if the content type is JSON. - Supports: - application/json - text/json - [something]+json - Matches are case insensitive to try and be as "accepting" as possible. - - Request content type - True if content type is JSON, false otherwise - - - - Gets the type of the typed list's items. - - The type. - The type of the typed list's items. - - - - Determines whether the member is an indexed property. - - The member. - - true if the member is an indexed property; otherwise, false. - - - - - Determines whether the property is an indexed property. - - The property. - - true if the property is an indexed property; otherwise, false. - - - - - Gets the member's value on the object. - - The member. - The target object. - The member's value on the object. - - - - Sets the member's value on the target object. - - The member. - The target. - The value. - - - - Determines whether the specified MemberInfo can be read. - - The MemberInfo to determine whether can be read. - - true if the specified MemberInfo can be read; otherwise, false. - - - - - Determines whether the specified MemberInfo can be set. - - The MemberInfo to determine whether can be set. - - true if the specified MemberInfo can be set; otherwise, false. - - - - - Model binding context object - - - - - The binding configuration - - - - - Current Nancy context - - - - - Binding destination type - - - - - The generic type of a collection is only used when DestinationType is a enumerable. - - - - - The current model object (or null for body deserialization) - - - - - DestinationType properties that are not black listed - - - - - The incoming data fields - - - - - Available type converters - user converters followed by any defaults - - - - - Provides default binding converters/deserializers - The defaults have less precedence than any user supplied ones - - - - - Initializes a new instance of the class. - - - - - Gets the default type converters - - - - - Gets the default type converters - - - - - Default binder - used as a fallback when a specific modelbinder - is not available. - - - - - Binds incoming request data to a model type - - - - - Bind to the given model type - - Current context - Model type to bind to - The that should be applied during binding. - Blacklisted property names - Existing instance of the object - Bound model - - - - Bind to the given model type - - Current context - Model type to bind to - Optional existing instance - The that should be applied during binding. - Blacklisted binding property names - Bound model - - - - Gets the number of distinct indexes from context: - - i.e: - IntProperty_5 - StringProperty_5 - IntProperty_7 - StringProperty_8 - You'll end up with a list of 3 matches: 5,7,8 - - - Current Context - An int containing the number of elements - - - - Deserializes request bodies in JSON format - - - - - Provides a way to deserialize the contents of a request - into a bound model. - - - - - Whether the deserializer can deserialize the content type - - Content type to deserialize - Current . - True if supported, false otherwise - - - - Deserialize the request body to a model - - Content type to deserialize - Request body stream - Current . - Model instance - - - - Whether the deserializer can deserialize the content type - - Content type to deserialize - Current . - True if supported, false otherwise - - - - Deserialize the request body to a model - - Content type to deserialize - Request body stream - Current context - Model instance - - - - Deserializes request bodies in XML format - - - - - Whether the deserializer can deserialize the content type - - Content type to deserialize - Current . - True if supported, false otherwise - - - - Deserialize the request body to a model - - Content type to deserialize - Request body stream - Current . - Model instance - - - - Converter for handling enumerable types - - - - - Whether the converter can convert to the destination type - - Destination type - The current binding context - True if conversion supported, false otherwise - - - - Convert the string representation to the destination type - - Input string - Destination type - Current context - Converted object of the destination type - - - - A fallback converter that uses TypeDescriptor.GetConverter to try - and convert the value. - - - - - Whether the converter can convert to the destination type - - Destination type - The current binding context - True if conversion supported, false otherwise - - - - Convert the string representation to the destination type - - Input string - Destination type - Current context - Converted object of the destination type - - - - Default field name converter - Converts camel case to pascal case - - - - - Provides the capability to supply a convention to - convert form field names to property names if required. - - - - - Converts a field name to a property name - - Field name - Property name - - - - Converts a field name to a property name - - Field name - Property name - - - - Provides wiring up of a model binder when cast to a destination type - - - - - Initializes a new instance of the class. - - Model binder locator - Nancy context - Optional existing instance, or null - The that should be applied during binding. - Blacklisted property names - - - - Provides implementation for type conversion operations. Classes derived from the class can override this method to specify dynamic behavior for operations that convert an object from one type to another. - - - true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a language-specific run-time exception is thrown.) - - Provides information about the conversion operation. The binder.Type property provides the type to which the object must be converted. For example, for the statement (String)sampleObject in C# (CType(sampleObject, Type) in Visual Basic), where sampleObject is an instance of the class derived from the class, binder.Type returns the type. The binder.Explicit property provides information about the kind of conversion that occurs. It returns true for explicit conversion and false for implicit conversion.The result of the type conversion operation. - - - - Provides a way to bind an incoming request, via the context, to a model type - - - - - Whether the binder can bind to the given model type - - Required model type - True if binding is possible, false otherwise - - - - Locates model binders for a particular model - - - - - Gets a binder for the given type - - Destination type to bind to - The instance of the current request. - IModelBinder instance or null if none found - - - - Locates model binders for a particular model - - - - - Available model binders - - - - - Default model binder to fall back on - - - - - Initializes a new instance of the class. - - Available model binders - Fallback binder - - - - Gets a binder for the given type - - Destination type to bind to - The instance of the current request. - IModelBinder instance or null if none found - - - - Represents an exception when attempting to bind to a model - - - - - Initializes a new instance of the ModelBindingException class with a specified model type, - property name and the original exception, which caused the problem - - the model type to bind to - the original exceptions, thrown while binding the property - The inner exception. - - - - Initializes a new instance of the class with serialized data. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - - - - Gets all failures - - - - - Gets the model type, which caused the exception - - - - - Parses an array of expressions like t => t.Property to a list of strings containing the property names; - - Type of the model - Expressions that tell which property should be ignored - Array of strings containing the names of the properties. - - - - Bind the incoming request to a model - - Current module - Property names to blacklist from binding - Model adapter - cast to a model type to bind it - - - - Bind the incoming request to a model - - Current module - The that should be applied during binding. - Property names to blacklist from binding - Model adapter - cast to a model type to bind it - - - - Bind the incoming request to a model - - Model type - Current module - Bound model instance - - - - Bind the incoming request to a model - - Model type - Current module - Property names to blacklist from binding - Bound model instance - - - - Bind the incoming request to a model - - Model type - Current module - Expressions that tell which property should be ignored - this.Bind<Person>(p => p.Name, p => p.Age) - Bound model instance - - - - Bind the incoming request to a model and validate - - Model type - Current module - Property names to blacklist from binding - Bound model instance - is stored in NancyModule.ModelValidationResult and NancyContext.ModelValidationResult. - - - - Bind the incoming request to a model and validate - - Model type - Current module - Expressions that tell which property should be ignored - this.Bind<Person>(p => p.Name, p => p.Age) - Bound model instance - is stored in NancyModule.ModelValidationResult and NancyContext.ModelValidationResult. - - - - Bind the incoming request to a model and validate - - Model type - Current module - Bound model instance - is stored in NancyModule.ModelValidationResult and NancyContext.ModelValidationResult. - - - - Bind the incoming request to a model - - Model type - Current module - The that should be applied during binding. - Bound model instance - - - - Bind the incoming request to a model - - Model type - Current module - The that should be applied during binding. - Property names to blacklist from binding - Bound model instance - - - - Bind the incoming request to a model - - Model type - Current module - The that should be applied during binding. - Expressions that tell which property should be ignored - this.Bind<Person>(p => p.Name, p => p.Age) - Bound model instance - - - - Bind the incoming request to a model - - Model type - Current module - The that should be applied during binding. - Expressions that tell which property should be ignored - this.Bind<Person>(p => p.Name, p => p.Age) - Bound model instance - - - - Bind the incoming request to a model and validate - - Model type - Current module - The that should be applied during binding. - Property names to blacklist from binding - Bound model instance - is stored in NancyModule.ModelValidationResult and NancyContext.ModelValidationResult. - - - - Bind the incoming request to a model and validate - - Model type - Current module - The that should be applied during binding. - Expressions that tell which property should be ignored - this.Bind<Person>(p => p.Name, p => p.Age) - Bound model instance - is stored in NancyModule.ModelValidationResult and NancyContext.ModelValidationResult. - - - - Bind the incoming request to a model and validate - - Model type - Current module - The that should be applied during binding. - Bound model instance - is stored in NancyModule.ModelValidationResult and NancyContext.ModelValidationResult. - - - - Bind the incoming request to an existing instance - - Model type - Current module - The class instance to bind properties to - Property names to blacklist from binding - - - - Bind the incoming request to an existing instance - - Model type - Current module - The class instance to bind properties to - Expressions that tell which property should be ignored - this.Bind<Person>(p => p.Name, p => p.Age) - - - - Bind the incoming request to an existing instance - - Model type - Current module - The class instance to bind properties to - - - - Bind the incoming request to an existing instance and validate - - Model type - Current module - The class instance to bind properties to - Property names to blacklist from binding - is stored in NancyModule.ModelValidationResult and NancyContext.ModelValidationResult. - - - - Bind the incoming request to an existing instance and validate - - Model type - Current module - The class instance to bind properties to - Expressions that tell which property should be ignored - this.Bind<Person>(p => p.Name, p => p.Age) - is stored in NancyModule.ModelValidationResult and NancyContext.ModelValidationResult. - - - - Bind the incoming request to an existing instance and validate - - Model type - Current module - The class instance to bind properties to - is stored in NancyModule.ModelValidationResult and NancyContext.ModelValidationResult. - - - - Bind the incoming request to an existing instance - - Model type - Current module - The class instance to bind properties to - The that should be applied during binding. - Property names to blacklist from binding - - - - Bind the incoming request to an existing instance - - Model type - Current module - The class instance to bind properties to - The that should be applied during binding. - Expressions that tell which property should be ignored - this.Bind<Person>(p => p.Name, p => p.Age) - - - - Bind the incoming request to an existing instance - - Model type - Current module - The class instance to bind properties to - The that should be applied during binding. - - - - Bind the incoming request to an existing instance and validate - - Model type - Current module - The class instance to bind properties to - The that should be applied during binding. - Property names to blacklist from binding - is stored in NancyModule.ModelValidationResult and NancyContext.ModelValidationResult. - - - - Bind the incoming request to an existing instance and validate - - Model type - Current module - The class instance to bind properties to - The that should be applied during binding. - Expressions that tell which property should be ignored - is stored in NancyModule.ModelValidationResult and NancyContext.ModelValidationResult. - this.BindToAndValidate(person, config, p => p.Name, p => p.Age) - - - - Bind the incoming request to an existing instance and validate - - Model type - Current module - The class instance to bind properties to - The that should be applied during binding. - is stored in NancyModule.ModelValidationResult and NancyContext.ModelValidationResult. - - - - Nancy context. - - - - - Initializes a new instance of the class. - - - - - Disposes any disposable items in the dictionary. - - - - - Gets the dictionary for storage of per-request items. Disposable items will be disposed when the context is. - - - - - Gets or sets the resolved route - - - - - Gets or sets the parameters for the resolved route - - - - - Gets or sets the incoming request - - - - - Gets or sets the outgoing response - - - - - Gets or sets the current user - - - - - Diagnostic request tracing - - - - - Gets a value indicating whether control panel access is enabled for this request - - - - - Non-model specific data for rendering in the response - - - - - Gets or sets the model validation result. - - - - - Gets or sets the context's culture - - - - - Context of content negotiation (if relevant) - - - - - Gets or sets the dynamic object used to locate text resources. - - - - - Wraps a sync delegate into it's async form - - Sync pipeline item instance - Async pipeline item instance - - - - Wraps a sync delegate into it's async form - - Sync pipeline item instance - Async pipeline item instance - - - - The default implementation of the interface. - - - - - Initializes a new instance of the class. - - The that should be used by the instance. - The that should be used by the instance. - - - - Gets all serializers currently registered - - - - - Gets the context for which the response is being formatted. - - A instance. - - - - Gets the root path of the application. - - A containing the root path. - - - - A decorator that can handle moving the stream out from memory and on to disk when the contents reaches a certain length. - - - - - Initializes a new instance of the class. - - The expected length of the contents in the stream. - The content length that will trigger the stream to be moved out of memory. - if set to the stream will never explicitly be moved to disk. - - - - Initializes a new instance of the class. - - The that should be handled by the request stream - The expected length of the contents in the stream. - if set to the stream will never explicitly be moved to disk. - - - - Initializes a new instance of the class. - - The expected length of the contents in the stream. - if set to the stream will never explicitly be moved to disk. - - - - Initializes a new instance of the class. - - The that should be handled by the request stream - The expected length of the contents in the stream. - The content length that will trigger the stream to be moved out of memory. - if set to the stream will never explicitly be moved to disk. - - - - Begins an asynchronous read operation. - - An that represents the asynchronous read, which could still be pending. - The buffer to read the data into. - The byte offset in at which to begin writing data read from the stream. - The maximum number of bytes to read. - An optional asynchronous callback, to be called when the read is complete. - A user-provided object that distinguishes this particular asynchronous read request from other requests. - - - - Begins an asynchronous write operation. - - An that represents the asynchronous write, which could still be pending. - The buffer to write data from. - The byte offset in from which to begin writing. - The maximum number of bytes to write. - An optional asynchronous callback, to be called when the write is complete. - A user-provided object that distinguishes this particular asynchronous write request from other requests. - - - - Waits for the pending asynchronous read to complete. - - - The number of bytes read from the stream, between zero (0) and the number of bytes you requested. Streams return zero (0) only at the end of the stream, otherwise, they should block until at least one byte is available. - - The reference to the pending asynchronous request to finish. - - - - Ends an asynchronous write operation. - - A reference to the outstanding asynchronous I/O request. - - - - Clears all buffers for this stream and causes any buffered data to be written to the underlying device. - - - - - Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. - - The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached. - An array of bytes. When this method returns, the buffer contains the specified byte array with the values between and ( + - 1) replaced by the bytes read from the current source. - The zero-based byte offset in at which to begin storing the data read from the current stream. - The maximum number of bytes to be read from the current stream. - - - - Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream. - - The unsigned byte cast to an Int32, or -1 if at the end of the stream. - - - - Sets the position within the current stream. - - The new position within the current stream. - A byte offset relative to the parameter. - A value of type indicating the reference point used to obtain the new position. - - - - Sets the length of the current stream. - - The desired length of the current stream in bytes. - The stream does not support having it's length set. - This functionality is not supported by the type and will always throw . - - - - Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. - - An array of bytes. This method copies bytes from to the current stream. - The zero-based byte offset in at which to begin copying bytes to the current stream. - The number of bytes to be written to the current stream. - - - - Gets a value indicating whether the current stream supports reading. - - Always returns . - - - - Gets a value indicating whether the current stream supports seeking. - - Always returns . - - - - Gets a value that determines whether the current stream can time out. - - Always returns . - - - - Gets a value indicating whether the current stream supports writing. - - Always returns . - - - - Gets the length in bytes of the stream. - - A long value representing the length of the stream in bytes. - - - - Gets a value indicating whether the current stream is stored in memory. - - if the stream is stored in memory; otherwise, . - The stream is moved to disk when either the length of the contents or expected content length exceeds the threshold specified in the constructor. - - - - Gets or sets the position within the current stream. - - The current position within the stream. - - - - A response representing a file. - - If the response contains an invalid file (not found, empty name, missing extension and so on) the status code of the response will be set to . - - - - Size of buffer for transmitting file. Default size 4 Mb - - - - - Initializes a new instance of the for the file specified - by the parameter. - - The name of the file, including path relative to the root of the application, that should be returned. - The method will be used to determine the mimetype of the file and will be used as the content-type of the response. If no match if found the content-type will be set to application/octet-stream. - - - - Initializes a new instance of the for the file specified - by the parameter. - - The name of the file, including path relative to the root of the application, that should be returned. - The method will be used to determine the mimetype of the file and will be used as the content-type of the response. If no match if found the content-type will be set to application/octet-stream. - Current context - - - - Initializes a new instance of the for the file specified - by the parameter and the content-type specified by the parameter. - - The name of the file, including path relative to the root of the application, that should be returned. - The content-type of the response. - Current context - - - - Represents a list of "base paths" where it is safe to - serve files from. - Attempting to server a file outside of these safe paths - will fail with a 404. - - - - - Gets the filename of the file response - - A string containing the name of the file. - - - - A response representing an HTTP redirect - - - - - - - Initializes a new instance of the class. - - Location to redirect to - Type of redirection to perform - - - - Which type of redirect - - - - - HTTP 301 - All future requests should be to this URL - - - - - HTTP 307 - Redirect this request but allow future requests to the original URL - - - - - HTTP 303 - Redirect this request using an HTTP GET - - - - - Default implementation for building a full configured instance. - - - - - Initializes a new instance of the class. - - The instance that should be assigned to the module. - An instance that should be used to create a response formatter for the module. - A instance that should be assigned to the module. - A instance that should be assigned to the module. - - - - Builds a fully configured instance, based upon the provided . - - The that should be configured. - The current request context. - A fully configured instance. - - - - It's not safe for a module to take a dependency on the cache (cyclic dependency) - - We provide an IRouteCacheProvider instead - the default implementation uses - TinyIoC'd Func based lazy factory. - - - - - It's not safe for a module to take a dependency on the cache (cyclic dependency) - - We provide an instead. - - It is *not* safe to call GetCache() inside a NancyModule constructor, although that shouldn't be necessary anyway. - - - - - Gets an instance of the route cache. - - An instance. - - - - Initializes a new instance of the DefaultRouteCacheProvider class. - - - - - - Gets an instance of the route cache. - - An instance. - - - - Gets the name of the provider. - - A containing the name of the provider. - - - - Gets the description of the provider. - - A containing the description of the provider. - - - - Gets the object that contains the interactive diagnostics methods. - - An instance of the interactive diagnostics object. - - - - Default implementation of a route pattern matcher. - - - - - Defined the functionality that is required by a route pattern matcher. - - Implement this interface if you want to support a custom route syntax. - - - - Attempts to match a requested path with a route pattern. - - The path that was requested. - The route pattern that the requested path should be attempted to be matched with. - - The instance for the current request. - An instance, containing the outcome of the match. - - - - Attempts to match a requested path with a route pattern. - - The path that was requested. - The route pattern that the requested path should be attempted to be matched with. - - The instance for the current request. - An instance, containing the outcome of the match. - - - - Contains a cache of all routes registered in the system - - - - - Gets a boolean value that indicates of the cache is empty or not. - - if the cache is empty, otherwise . - - - - Caches information about all the available routes that was discovered by the bootstrapper. - - - - - Initializes a new instance of the class. - - The that should be used by the cache. - The that should be used to create a context instance. - - - - - - - - Gets a boolean value that indicates of the cache is empty or not. - - if the cache is empty, otherwise . - - - - Defines the functionality that is required by a route pattern match result. - - - - - Gets the that was active when the result was produced. - - A instance. - - - - Gets a value indicating whether or not a match was made. - - if a match was made; otherwise . - - - - The parameters that could be captured in the route. - - A instance containing the captured parameters and values. - Should be empty if is . - - - - Route that is returned when the path could be matched but it was for the wrong request method. - - This is equal to sending back the 405 HTTP status code. - - - - Initializes a new instance of the type, for the - specified , and . - - The path of the route. - The HTTP method of the route. - The HTTP methods that can be used to invoke the route. - - - - Represents the various parts of a route lambda. - - - - - Initializes a new instance of the class. - - Route name - The request method of the route. - The path that the route will be invoked for. - The condition that has to be fulfilled for the route to be a valid match. - - - - The name of the route - - - - - The condition that has to be fulfilled inorder for the route to be a valid match. - - A function that evaluates the condition when a instance is passed in. - - - - The description of what the route is for. - - A containing the description of the route. - - - - Gets or sets the metadata information for a route. - - A instance. - - - - Gets the method of the route. - - A containing the method of the route. - - - - Gets the path that the route will be invoked for. - - A containing the path of the route. - - - - Gets or set the segments, for the route, that was returned by the . - - An , containing the segments for the route. - - - - The default implementation of a route pattern matching result. - - - - - Initializes a new instance of the class. - - A value indicating if the result was a match or not. - A instance containing the parameters and values that was captured in the match. - The instance of the current request. - - - - Gets the that was active when the result was produced. - - A instance. - - - - Gets a value indicating whether or not a match was made. - - if a match was made; otherwise . - - - - The parameters that could be captured in the route. - - A instance containing the captured parameters and values. - Should be empty if is . - - - - Some simple helpers give some nice authentication syntax in the modules. - - - - - This module requires authentication - - Module to enable - - - - This module requires authentication and certain claims to be present. - - Module to enable - Claim(s) required - - - - This module requires authentication and certain claims to be present. - - Module to enable - Claim(s) required - - - - This module requires authentication and any one of certain claims to be present. - - Module to enable - Claim(s) required - - - - This module requires authentication and any one of certain claims to be present. - - Module to enable - Claim(s) required - - - - This module requires claims to be validated - - Module to enable - Claims validator - - - - This module requires https. - - The that requires HTTPS. - - - - This module requires https. - - The that requires HTTPS. - if the user should be redirected to HTTPS (no port number) if the incoming request was made using HTTP, otherwise if should be returned. - - - - This module requires https. - - The that requires HTTPS. - if the user should be redirected to HTTPS if the incoming request was made using HTTP, otherwise if should be returned. - The HTTPS port number to use - - - - Hooks to be used in a request pipeline. - - - - - Creates a hook to be used in a pipeline before a route handler to ensure that - the request was made by an authenticated user. - - Hook that returns an Unauthorized response if not authenticated in, - null otherwise - - - - Creates a hook to be used in a pipeline before a route handler to ensure - that the request was made by an authenticated user having the required claims. - - Claims the authenticated user needs to have - Hook that returns an Unauthorized response if the user is not - authenticated or does not have the required claims, null otherwise - - - - Creates a hook to be used in a pipeline before a route handler to ensure - that the request was made by an authenticated user having at least one of - the required claims. - - Claims the authenticated user needs to have at least one of - Hook that returns an Unauthorized response if the user is not - authenticated or does not have at least one of the required claims, null - otherwise - - - - Creates a hook to be used in a pipeline before a route handler to ensure - that the request was made by an authenticated user whose claims satisfy the - supplied validation function. - - Validation function to be called with the authenticated - users claims - Hook that returns an Unauthorized response if the user is not - authenticated or does not pass the supplied validation function, null - otherwise - - - - Creates a hook to be used in a pipeline before a route handler to ensure that - the request satisfies a specific test. - - Test that must return true for the request to continue - Hook that returns an Unauthorized response if the test fails, null otherwise - - - - Creates a hook to be used in a pipeline before a route handler to ensure that - the request satisfies a specific test. - - Test that must return true for the request to continue - Hook that returns an Forbidden response if the test fails, null otherwise - - - - Creates a hook to be used in a pipeline before a route handler to ensure that - the request satisfies a specific test. - - HttpStatusCode to use for the response - Test that must return true for the request to continue - Hook that returns a response with a specific HttpStatusCode if the test fails, null otherwise - - - - Creates a hook to be used in a pipeline before a route handler to ensure that - the resource is served over HTTPS - - if the user should be redirected to HTTPS (no port number) if the incoming request was made using HTTP, otherwise if should be returned. - Hook that returns a RedirectResponse with the Url scheme set to HTTPS, - or a Response with a Forbidden HTTP status code if redirect is false or the method is not GET, - null otherwise - - - - Creates a hook to be used in a pipeline before a route handler to ensure that - the resource is served over HTTPS - - if the user should be redirected to HTTPS (no port number) if the incoming request was made using HTTP, otherwise if should be returned. - The HTTPS port number to use - Hook that returns a with the Url scheme set to HTTPS, - or a with a status code if redirect is false or the method is not GET, - null otherwise - - - - Extension methods for working with IUserIdentity. - - - - - Tests if the user is authenticated. - - User to be verified - True if the user is authenticated, false otherwise - - - - Tests if the user has a required claim. - - User to be verified - Claim the user needs to have - True if the user has the required claim, false otherwise - - - - Tests if the user has all of the required claims. - - User to be verified - Claims the user needs to have - True if the user has all of the required claims, false otherwise - - - - Tests if the user has at least one of the required claims. - - User to be verified - Claims the user needs to have at least one of - True if the user has at least one of the required claims, false otherwise - - - - Tests if the user has claims that satisfy the supplied validation function. - - User to be verified - Validation function to be called with the authenticated - users claims - True if the user does pass the supplied validation function, false otherwise - - - - Cookie based session storage - - - - - Allows setting of the serializer for session object storage - - - - - Using the specified serializer - - Serializer to use - - - - Initializes a new instance of the class. - - The encryption provider. - The hmac provider - Session object serializer to use - - - - Initializes a new instance of the class. - - Cookie based sessions configuration. - - - - Initialise and add cookie based session hooks to the application pipeline - - Application pipelines - Cookie based sessions configuration. - Formatter selector for choosing a non-default serializer - - - - Initialise and add cookie based session hooks to the application pipeline - - Application pipelines - Cryptography configuration - Formatter selector for choosing a non-default serializer - - - - Initialise and add cookie based session hooks to the application pipeline with the default encryption provider. - - Application pipelines - Formatter selector for choosing a non-default serializer - - - - Using the specified serializer - - Formatter to use - - - - Save the session into the response - - Session to save - Response to save into - - - - Loads the session from the request - - Request to load from - ISession containing the load session values - - - - Saves the request session into the response - - Nancy context - Session store - - - - Loads the request session - - Nancy context - Session store - Always returns null - - - - Gets the cookie name that the session is stored in - - Cookie name - - - - Default encryption provider using Rijndael - - - - - Creates a new instance of the RijndaelEncryptionProvider class - - Key generator to use to generate the key and iv - - - - Encrypt data - - Data to encrypt - Encrypted string - - - - Decrypt string - - Data to decrypt - Decrypted string - - - - De/Serialisation for cookie objects - - - - - Serialize an object - - Source object - Serialised object string - - - - Deserialize an object string - - Source object string - Deserialized object - - - - Serialize an object - - Source object - Serialised object string - - - - Deserialize an object string - - Source object string - Deserialized object - - - - Defines the interface for a session - - - - - Deletes the session and all associated information - - - - - Deletes the specific key from the session - - - - - The number of session values - - - - - - Retrieves the value from the session - - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - 1 - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - 2 - - - - Deletes the session and all associated information - - - - - Deletes the specific key from the session - - - - - The number of session values - - - - - - Retrieves the value from the session - - - - - Session implementation - - - - - Deletes all items - - - - - Delete an item with the given key - - Key to delete - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - 2 - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - 1 - - - - Gets the number of items stored - - - - - Gets or sets values - - The key whos value to get or set - The value, or null or the key didn't exist - - - - Gets whether the session has changed - - - - - A decorator stream that sits on top of an existing stream and appears as a unique stream. - - - - - Initializes a new instance of the class. - - The stream to create the sub-stream ontop of. - The start offset on the parent stream where the sub-stream should begin. - The end offset on the parent stream where the sub-stream should end. - - - - When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device. - - In the type this method is implemented as no-op. - - - - When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. - - The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached. - An array of bytes. When this method returns, the buffer contains the specified byte array with the values between and ( + - 1) replaced by the bytes read from the current source. - The zero-based byte offset in at which to begin storing the data read from the current stream. - The maximum number of bytes to be read from the current stream. - - - - Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream. - - The unsigned byte cast to an Int32, or -1 if at the end of the stream. - - - - When overridden in a derived class, sets the position within the current stream. - - The new position within the current stream. - A byte offset relative to the parameter. - A value of type indicating the reference point used to obtain the new position. - - - - When overridden in a derived class, sets the length of the current stream. - - The desired length of the current stream in bytes. - This will always throw a for the type. - - - - When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. - - An array of bytes. This method copies bytes from to the current stream. - The zero-based byte offset in at which to begin copying bytes to the current stream. - The number of bytes to be written to the current stream. - This will always throw a for the type. - - - - When overridden in a derived class, gets a value indicating whether the current stream supports reading. - - if the stream supports reading; otherwise, . - - - - When overridden in a derived class, gets a value indicating whether the current stream supports seeking. - - if the stream supports seeking; otherwise, . - - - - When overridden in a derived class, gets a value indicating whether the current stream supports writing. - - if the stream supports writing; otherwise, . - - - - When overridden in a derived class, gets the length in bytes of the stream. - - A long value representing the length of the stream in bytes. - A class derived from Stream does not support seeking. Methods were called after the stream was closed. - - - - When overridden in a derived class, gets or sets the position within the current stream. - - - The current position within the stream. - - An I/O error occurs. The stream does not support seeking. Methods were called after the stream was closed. 1 - - - - Gets a generic method from a type given the method name, binding flags, generic types and parameter types - - Source type - Binding flags - Name of the method - Generic types to use to make the method generic - Method parameters - MethodInfo or null if no matches found - - - - - - Name/Value pairs for specifying "user" parameters when resolving - - - - - Attempt to resolve type, even if the type isn't registered. - - Registered types/options will always take precedence. - - - - - Fail resolution if type not explicitly registered - - - - - Attempt to resolve unregistered type if requested type is generic - and no registration exists for the specific generic parameters used. - - Registered types/options will always take precedence. - - - - - Resolution settings - - - - - Gets the default options (attempt resolution of unregistered types, fail on named resolution if name not found) - - - - - Preconfigured option for attempting resolution of unregistered types and failing on named resolution if name not found - - - - - Preconfigured option for failing on resolving unregistered types and on named resolution if name not found - - - - - Preconfigured option for failing on resolving unregistered types, but attempting unnamed resolution if name not found - - - - - Attempt to automatically register all non-generic classes and interfaces in the current app domain. - - If more than one class implements an interface then only one implementation will be registered - although no error will be thrown. - - - - - Attempt to automatically register all non-generic classes and interfaces in the current app domain. - Types will only be registered if they pass the supplied registration predicate. - - If more than one class implements an interface then only one implementation will be registered - although no error will be thrown. - - Predicate to determine if a particular type should be registered - - - - Attempt to automatically register all non-generic classes and interfaces in the current app domain. - - What action to take when encountering duplicate implementations of an interface/base class. - - - - - Attempt to automatically register all non-generic classes and interfaces in the current app domain. - Types will only be registered if they pass the supplied registration predicate. - - What action to take when encountering duplicate implementations of an interface/base class. - Predicate to determine if a particular type should be registered - - - - - Attempt to automatically register all non-generic classes and interfaces in the specified assemblies - - If more than one class implements an interface then only one implementation will be registered - although no error will be thrown. - - Assemblies to process - - - - Attempt to automatically register all non-generic classes and interfaces in the specified assemblies - Types will only be registered if they pass the supplied registration predicate. - - If more than one class implements an interface then only one implementation will be registered - although no error will be thrown. - - Assemblies to process - Predicate to determine if a particular type should be registered - - - - Attempt to automatically register all non-generic classes and interfaces in the specified assemblies - - Assemblies to process - What action to take when encountering duplicate implementations of an interface/base class. - - - - - Attempt to automatically register all non-generic classes and interfaces in the specified assemblies - Types will only be registered if they pass the supplied registration predicate. - - Assemblies to process - What action to take when encountering duplicate implementations of an interface/base class. - Predicate to determine if a particular type should be registered - - - - - Creates/replaces a container class registration with default options. - - Type to register - RegisterOptions for fluent API - - - - Creates/replaces a named container class registration with default options. - - Type to register - Name of registration - RegisterOptions for fluent API - - - - Creates/replaces a container class registration with a given implementation and default options. - - Type to register - Type to instantiate that implements RegisterType - RegisterOptions for fluent API - - - - Creates/replaces a named container class registration with a given implementation and default options. - - Type to register - Type to instantiate that implements RegisterType - Name of registration - RegisterOptions for fluent API - - - - Creates/replaces a container class registration with a specific, strong referenced, instance. - - Type to register - Instance of RegisterType to register - RegisterOptions for fluent API - - - - Creates/replaces a named container class registration with a specific, strong referenced, instance. - - Type to register - Instance of RegisterType to register - Name of registration - RegisterOptions for fluent API - - - - Creates/replaces a container class registration with a specific, strong referenced, instance. - - Type to register - Type of instance to register that implements RegisterType - Instance of RegisterImplementation to register - RegisterOptions for fluent API - - - - Creates/replaces a named container class registration with a specific, strong referenced, instance. - - Type to register - Type of instance to register that implements RegisterType - Instance of RegisterImplementation to register - Name of registration - RegisterOptions for fluent API - - - - Creates/replaces a container class registration with a user specified factory - - Type to register - Factory/lambda that returns an instance of RegisterType - RegisterOptions for fluent API - - - - Creates/replaces a container class registration with a user specified factory - - Type to register - Factory/lambda that returns an instance of RegisterType - Name of registation - RegisterOptions for fluent API - - - - Creates/replaces a container class registration with default options. - - Type to register - RegisterOptions for fluent API - - - - Creates/replaces a named container class registration with default options. - - Type to register - Name of registration - RegisterOptions for fluent API - - - - Creates/replaces a container class registration with a given implementation and default options. - - Type to register - Type to instantiate that implements RegisterType - RegisterOptions for fluent API - - - - Creates/replaces a named container class registration with a given implementation and default options. - - Type to register - Type to instantiate that implements RegisterType - Name of registration - RegisterOptions for fluent API - - - - Creates/replaces a container class registration with a specific, strong referenced, instance. - - Type to register - Instance of RegisterType to register - RegisterOptions for fluent API - - - - Creates/replaces a named container class registration with a specific, strong referenced, instance. - - Type to register - Instance of RegisterType to register - Name of registration - RegisterOptions for fluent API - - - - Creates/replaces a container class registration with a specific, strong referenced, instance. - - Type to register - Type of instance to register that implements RegisterType - Instance of RegisterImplementation to register - RegisterOptions for fluent API - - - - Creates/replaces a named container class registration with a specific, strong referenced, instance. - - Type to register - Type of instance to register that implements RegisterType - Instance of RegisterImplementation to register - Name of registration - RegisterOptions for fluent API - - - - Creates/replaces a container class registration with a user specified factory - - Type to register - Factory/lambda that returns an instance of RegisterType - RegisterOptions for fluent API - - - - Creates/replaces a named container class registration with a user specified factory - - Type to register - Factory/lambda that returns an instance of RegisterType - Name of registation - RegisterOptions for fluent API - - - - Register multiple implementations of a type. - - Internally this registers each implementation using the full name of the class as its registration name. - - Type that each implementation implements - Types that implement RegisterType - MultiRegisterOptions for the fluent API - - - - Register multiple implementations of a type. - - Internally this registers each implementation using the full name of the class as its registration name. - - Type that each implementation implements - Types that implement RegisterType - MultiRegisterOptions for the fluent API - - - - Attempts to resolve a type using default options. - - Type to resolve - Instance of type - Unable to resolve the type. - - - - Attempts to resolve a type using specified options. - - Type to resolve - Resolution options - Instance of type - Unable to resolve the type. - - - - Attempts to resolve a type using default options and the supplied name. - - Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists). - All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail. - - Type to resolve - Name of registration - Instance of type - Unable to resolve the type. - - - - Attempts to resolve a type using supplied options and name. - - Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists). - All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail. - - Type to resolve - Name of registration - Resolution options - Instance of type - Unable to resolve the type. - - - - Attempts to resolve a type using default options and the supplied constructor parameters. - - Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists). - All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail. - - Type to resolve - User specified constructor parameters - Instance of type - Unable to resolve the type. - - - - Attempts to resolve a type using specified options and the supplied constructor parameters. - - Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists). - All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail. - - Type to resolve - User specified constructor parameters - Resolution options - Instance of type - Unable to resolve the type. - - - - Attempts to resolve a type using default options and the supplied constructor parameters and name. - - Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists). - All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail. - - Type to resolve - User specified constructor parameters - Name of registration - Instance of type - Unable to resolve the type. - - - - Attempts to resolve a named type using specified options and the supplied constructor parameters. - - Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists). - All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail. - - Type to resolve - Name of registration - User specified constructor parameters - Resolution options - Instance of type - Unable to resolve the type. - - - - Attempts to resolve a type using default options. - - Type to resolve - Instance of type - Unable to resolve the type. - - - - Attempts to resolve a type using specified options. - - Type to resolve - Resolution options - Instance of type - Unable to resolve the type. - - - - Attempts to resolve a type using default options and the supplied name. - - Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists). - All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail. - - Type to resolve - Name of registration - Instance of type - Unable to resolve the type. - - - - Attempts to resolve a type using supplied options and name. - - Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists). - All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail. - - Type to resolve - Name of registration - Resolution options - Instance of type - Unable to resolve the type. - - - - Attempts to resolve a type using default options and the supplied constructor parameters. - - Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists). - All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail. - - Type to resolve - User specified constructor parameters - Instance of type - Unable to resolve the type. - - - - Attempts to resolve a type using specified options and the supplied constructor parameters. - - Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists). - All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail. - - Type to resolve - User specified constructor parameters - Resolution options - Instance of type - Unable to resolve the type. - - - - Attempts to resolve a type using default options and the supplied constructor parameters and name. - - Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists). - All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail. - - Type to resolve - User specified constructor parameters - Name of registration - Instance of type - Unable to resolve the type. - - - - Attempts to resolve a named type using specified options and the supplied constructor parameters. - - Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists). - All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail. - - Type to resolve - Name of registration - User specified constructor parameters - Resolution options - Instance of type - Unable to resolve the type. - - - - Attempts to predict whether a given type can be resolved with default options. - - Note: Resolution may still fail if user defined factory registations fail to construct objects when called. - - Type to resolve - Name of registration - Bool indicating whether the type can be resolved - - - - Attempts to predict whether a given named type can be resolved with default options. - - Note: Resolution may still fail if user defined factory registations fail to construct objects when called. - - Type to resolve - Bool indicating whether the type can be resolved - - - - Attempts to predict whether a given type can be resolved with the specified options. - - Note: Resolution may still fail if user defined factory registrations fail to construct objects when called. - - Type to resolve - Name of registration - Resolution options - Bool indicating whether the type can be resolved - - - - Attempts to predict whether a given named type can be resolved with the specified options. - - Note: Resolution may still fail if user defined factory registrations fail to construct objects when called. - - Type to resolve - Name of registration - Resolution options - Bool indicating whether the type can be resolved - - - - Attempts to predict whether a given type can be resolved with the supplied constructor parameters and default options. - - Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists). - All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail. - - Note: Resolution may still fail if user defined factory registations fail to construct objects when called. - - Type to resolve - User supplied named parameter overloads - Bool indicating whether the type can be resolved - - - - Attempts to predict whether a given named type can be resolved with the supplied constructor parameters and default options. - - Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists). - All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail. - - Note: Resolution may still fail if user defined factory registations fail to construct objects when called. - - Type to resolve - Name of registration - User supplied named parameter overloads - Bool indicating whether the type can be resolved - - - - Attempts to predict whether a given type can be resolved with the supplied constructor parameters options. - - Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists). - All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail. - - Note: Resolution may still fail if user defined factory registations fail to construct objects when called. - - Type to resolve - User supplied named parameter overloads - Resolution options - Bool indicating whether the type can be resolved - - - - Attempts to predict whether a given named type can be resolved with the supplied constructor parameters options. - - Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists). - All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail. - - Note: Resolution may still fail if user defined factory registations fail to construct objects when called. - - Type to resolve - Name of registration - User supplied named parameter overloads - Resolution options - Bool indicating whether the type can be resolved - - - - Attempts to predict whether a given type can be resolved with default options. - - Note: Resolution may still fail if user defined factory registations fail to construct objects when called. - - Type to resolve - Name of registration - Bool indicating whether the type can be resolved - - - - Attempts to predict whether a given named type can be resolved with default options. - - Note: Resolution may still fail if user defined factory registations fail to construct objects when called. - - Type to resolve - Bool indicating whether the type can be resolved - - - - Attempts to predict whether a given type can be resolved with the specified options. - - Note: Resolution may still fail if user defined factory registations fail to construct objects when called. - - Type to resolve - Name of registration - Resolution options - Bool indicating whether the type can be resolved - - - - Attempts to predict whether a given named type can be resolved with the specified options. - - Note: Resolution may still fail if user defined factory registations fail to construct objects when called. - - Type to resolve - Name of registration - Resolution options - Bool indicating whether the type can be resolved - - - - Attempts to predict whether a given type can be resolved with the supplied constructor parameters and default options. - - Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists). - All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail. - - Note: Resolution may still fail if user defined factory registations fail to construct objects when called. - - Type to resolve - User supplied named parameter overloads - Bool indicating whether the type can be resolved - - - - Attempts to predict whether a given named type can be resolved with the supplied constructor parameters and default options. - - Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists). - All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail. - - Note: Resolution may still fail if user defined factory registations fail to construct objects when called. - - Type to resolve - Name of registration - User supplied named parameter overloads - Bool indicating whether the type can be resolved - - - - Attempts to predict whether a given type can be resolved with the supplied constructor parameters options. - - Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists). - All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail. - - Note: Resolution may still fail if user defined factory registrations fail to construct objects when called. - - Type to resolve - User supplied named parameter overloads - Resolution options - Bool indicating whether the type can be resolved - - - - Attempts to predict whether a given named type can be resolved with the supplied constructor parameters options. - - Parameters are used in conjunction with normal container resolution to find the most suitable constructor (if one exists). - All user supplied parameters must exist in at least one resolvable constructor of RegisterType or resolution will fail. - - Note: Resolution may still fail if user defined factory registations fail to construct objects when called. - - Type to resolve - Name of registration - User supplied named parameter overloads - Resolution options - Bool indicating whether the type can be resolved - - - - Attemps to resolve a type using the default options - - Type to resolve - Resolved type or default if resolve fails - True if resolved sucessfully, false otherwise - - - - Attemps to resolve a type using the given options - - Type to resolve - Resolution options - Resolved type or default if resolve fails - True if resolved sucessfully, false otherwise - - - - Attemps to resolve a type using the default options and given name - - Type to resolve - Name of registration - Resolved type or default if resolve fails - True if resolved successfully, false otherwise - - - - Attemps to resolve a type using the given options and name - - Type to resolve - Name of registration - Resolution options - Resolved type or default if resolve fails - True if resolved sucessfully, false otherwise - - - - Attemps to resolve a type using the default options and supplied constructor parameters - - Type to resolve - User specified constructor parameters - Resolved type or default if resolve fails - True if resolved sucessfully, false otherwise - - - - Attemps to resolve a type using the default options and supplied name and constructor parameters - - Type to resolve - Name of registration - User specified constructor parameters - Resolved type or default if resolve fails - True if resolved successfully, false otherwise - - - - Attemps to resolve a type using the supplied options and constructor parameters - - Type to resolve - Name of registration - User specified constructor parameters - Resolution options - Resolved type or default if resolve fails - True if resolved successfully, false otherwise - - - - Attemps to resolve a type using the supplied name, options and constructor parameters - - Type to resolve - Name of registration - User specified constructor parameters - Resolution options - Resolved type or default if resolve fails - True if resolved successfully, false otherwise - - - - Attemps to resolve a type using the default options - - Type to resolve - Resolved type or default if resolve fails - True if resolved successfully, false otherwise - - - - Attemps to resolve a type using the given options - - Type to resolve - Resolution options - Resolved type or default if resolve fails - True if resolved successfully, false otherwise - - - - Attemps to resolve a type using the default options and given name - - Type to resolve - Name of registration - Resolved type or default if resolve fails - True if resolved successfully, false otherwise - - - - Attemps to resolve a type using the given options and name - - Type to resolve - Name of registration - Resolution options - Resolved type or default if resolve fails - True if resolved successfully, false otherwise - - - - Attemps to resolve a type using the default options and supplied constructor parameters - - Type to resolve - User specified constructor parameters - Resolved type or default if resolve fails - True if resolved successfully, false otherwise - - - - Attemps to resolve a type using the default options and supplied name and constructor parameters - - Type to resolve - Name of registration - User specified constructor parameters - Resolved type or default if resolve fails - True if resolved successfully, false otherwise - - - - Attemps to resolve a type using the supplied options and constructor parameters - - Type to resolve - Name of registration - User specified constructor parameters - Resolution options - Resolved type or default if resolve fails - True if resolved successfully, false otherwise - - - - Attemps to resolve a type using the supplied name, options and constructor parameters - - Type to resolve - Name of registration - User specified constructor parameters - Resolution options - Resolved type or default if resolve fails - True if resolved successfully, false otherwise - - - - Returns all registrations of a type - - Type to resolveAll - Whether to include un-named (default) registrations - IEnumerable - - - - Returns all registrations of a type, both named and unnamed - - Type to resolveAll - IEnumerable - - - - Returns all registrations of a type - - Type to resolveAll - Whether to include un-named (default) registrations - IEnumerable - - - - Returns all registrations of a type, both named and unnamed - - Type to resolveAll - Whether to include un-named (default) registrations - IEnumerable - - - - Attempts to resolve all public property dependencies on the given object. - - Object to "build up" - - - - Attempts to resolve all public property dependencies on the given object using the given resolve options. - - Object to "build up" - Resolve options to use - - - - Lazy created Singleton instance of the container for simple scenarios - - - - - Registration options for "fluent" API - - - - - Make registration a singleton (single instance) if possible - - RegisterOptions - - - - - Make registration multi-instance if possible - - RegisterOptions - - - - - Make registration hold a weak reference if possible - - RegisterOptions - - - - - Make registration hold a strong reference if possible - - RegisterOptions - - - - - Switches to a custom lifetime manager factory if possible. - - Usually used for RegisterOptions "To*" extension methods such as the ASP.Net per-request one. - - RegisterOptions instance - Custom lifetime manager - Error string to display if switch fails - RegisterOptions - - - - Registration options for "fluent" API when registering multiple implementations - - - - - Initializes a new instance of the MultiRegisterOptions class. - - Registration options - - - - Make registration a singleton (single instance) if possible - - RegisterOptions - - - - - Make registration multi-instance if possible - - MultiRegisterOptions - - - - - Switches to a custom lifetime manager factory if possible. - - Usually used for RegisterOptions "To*" extension methods such as the ASP.Net per-request one. - - MultiRegisterOptions instance - Custom lifetime manager - Error string to display if switch fails - MultiRegisterOptions - - - - Provides custom lifetime management for ASP.Net per-request lifetimes etc. - - - - - Gets the stored object if it exists, or null if not - - Object instance or null - - - - Store the object - - Object to store - - - - Release the object - - - - - Create the type - - Type user requested to be resolved - Container that requested the creation - Any user parameters passed - - - - - - Whether to assume this factory successfully constructs its objects - - Generally set to true for delegate style factories as CanResolve cannot delve - into the delegates they contain. - - - - - The type the factory instantiates - - - - - Constructor to use, if specified - - - - - IObjectFactory that creates new instances of types for each resolution - - - - - IObjectFactory that invokes a specified delegate to construct the object - - - - - IObjectFactory that invokes a specified delegate to construct the object - Holds the delegate using a weak reference - - - - - Stores an particular instance to return for a type - - - - - Stores an particular instance to return for a type - - Stores the instance with a weak reference - - - - - A factory that lazy instantiates a type and always returns the same instance - - - - - A factory that offloads lifetime to an external lifetime provider - - - - - Defines the functionality of an engine that can handle Nancy s. - - - - - Handles an incoming async. - - An instance, containing the information about the current request. - Delegate to call before the request is processed - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - The task object representing the asynchronous operation. - - - - Factory for creating an instance for a incoming request. - - An instance. - - - - Encapsulates HTTP-request information to an Nancy application. - - - - - Initializes a new instance of the class. - - The HTTP data transfer method used by the client. - The path of the requested resource, relative to the "Nancy root". This should not include the scheme, host name, or query portion of the URI. - The HTTP protocol that was used by the client. - - - - Initializes a new instance of the class. - - The HTTP data transfer method used by the client. - The of the requested resource - The headers that was passed in by the client. - The that represents the incoming HTTP body. - The client's IP address - The client's certificate when present. - The HTTP protocol version. - - - - Gets the cookie data from the request header if it exists - - Cookies dictionary - - - - Gets the certificate sent by the client. - - - - - Gets the HTTP protocol version. - - - - - Gets the IP address of the client - - - - - Gets or sets the HTTP data transfer method used by the client. - - The method. - - - - Gets the url - - - - - Gets the request path, relative to the base path. - Used for route matching etc. - - - - - Gets the query string data of the requested resource. - - A instance, containing the key/value pairs of query string data. - - - - Gets a that can be used to read the incoming HTTP body - - A object representing the incoming HTTP body. - - - - Gets the request cookies. - - - - - Gets the current session. - - - - - Gets a collection of files sent by the client- - - An instance, containing an instance for each uploaded file. - - - - Gets the form data of the request. - - A instance, containing the key/value pairs of form data. - Currently Nancy will only parse form data sent using the application/x-www-url-encoded mime-type. - - - - Gets the HTTP headers sent by the client. - - An containing the name and values of the headers. - The values are stored in an of string to be compliant with multi-value headers. - - - - Default engine for handling Nancy s. - - - - - Initializes a new instance of the class. - - An instance that will be used to resolve a route, from the modules, that matches the incoming . - A factory for creating contexts - Error handlers - The request tracing instance. - The provider to use for serving static content - The response negotiator. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Factory for creating an instance for a incoming request. - - An instance. - - - - Returns a route that matches the request - - - - - Gets the route, and the corresponding parameter dictionary from the URL - - Current context - A containing the resolved route information. - - - - Route that is returned when the path could not be matched. - - This is equal to sending back the 404 HTTP status code. - - - - Initializes a new instance of the type, for the - specified and . - - The HTTP method of the route. - The path of the route. - - - - A dictionary that supports dynamic access. - - - - - Creates a dynamic dictionary from an instance. - - An instance, that the dynamic dictionary should be created from. - An instance. - - - - Provides the implementation for operations that set member values. Classes derived from the class can override this method to specify dynamic behavior for operations such as setting a value for a property. - - true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a language-specific run-time exception is thrown.) - Provides information about the object that called the dynamic operation. The binder.Name property provides the name of the member to which the value is being assigned. For example, for the statement sampleObject.SampleProperty = "Test", where sampleObject is an instance of the class derived from the class, binder.Name returns "SampleProperty". The binder.IgnoreCase property specifies whether the member name is case-sensitive.The value to set to the member. For example, for sampleObject.SampleProperty = "Test", where sampleObject is an instance of the class derived from the class, the is "Test". - - - - Provides the implementation for operations that get member values. Classes derived from the class can override this method to specify dynamic behavior for operations such as getting a value for a property. - - true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a run-time exception is thrown.) - Provides information about the object that called the dynamic operation. The binder.Name property provides the name of the member on which the dynamic operation is performed. For example, for the Console.WriteLine(sampleObject.SampleProperty) statement, where sampleObject is an instance of the class derived from the class, binder.Name returns "SampleProperty". The binder.IgnoreCase property specifies whether the member name is case-sensitive.The result of the get operation. For example, if the method is called for a property, you can assign the property value to . - - - - Returns the enumeration of all dynamic member names. - - A that contains dynamic member names. - - - - Returns the enumeration of all dynamic member names. - - A that contains dynamic member names. - - - - Returns the enumeration of all dynamic member names. - - A that contains dynamic member names. - - - - Indicates whether the current is equal to another object of the same type. - - if the current instance is equal to the parameter; otherwise, . - An instance to compare with this instance. - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - if the specified is equal to this instance; otherwise, . - - - - Returns an enumerator that iterates through the collection. - - A that can be used to iterate through the collection. - - - - Returns a hash code for this . - - A hash code for this , suitable for use in hashing algorithms and data structures like a hash table. - - - - Adds an element with the provided key and value to the . - - The object to use as the key of the element to add. - The object to use as the value of the element to add. - - - - Adds an item to the . - - The object to add to the . - - - - Determines whether the contains an element with the specified key. - - if the contains an element with the key; otherwise, . - - The key to locate in the . - - - - Gets the value associated with the specified key. - - if the contains an element with the specified key; otherwise, . - The key whose value to get. - When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the parameter. This parameter is passed uninitialized. - - - - Removes all items from the . - - - - - Determines whether the contains a specific value. - - if is found in the ; otherwise, . - - The object to locate in the . - - - - Copies the elements of the to an , starting at a particular index. - - The one-dimensional that is the destination of the elements copied from the . The must have zero-based indexing. - The zero-based index in at which copying begins. - - - - Removes the element with the specified key from the . - - if the element is successfully removed; otherwise, . - The key of the element to remove. - - - - Removes the first occurrence of a specific object from the . - - if was successfully removed from the ; otherwise, . - The object to remove from the . - - - - Gets a typed Dictionary of from - - Gets a typed Dictionary of from - - - - Returns an empty dynamic dictionary. - - A instance. - - - - Gets or sets the with the specified name. - - A instance containing a value. - - - - Gets an containing the keys of the . - - An containing the keys of the . - - - - Gets the number of elements contained in the . - - The number of elements contained in the . - - - - Gets a value indicating whether the is read-only. - - Always returns . - - - - Gets an containing the values in the . - - An containing the values in the . - - - - Default implementation of the interface. - - - - - Initializes a new instance of the class, using - the provided , , - and . - - A instance. - A instance. - A instance. - A instance. - - - - Gets the route, and the corresponding parameter dictionary from the URL - - Current context - A containing the resolved route information. - - - - Thrown when multiple instances describe the exact same view. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message that should be displayed with the exception. - - - - The default implementation for how views are resolved and rendered by Nancy. - - - - - Defines the functionality used by a to render a view to the response. - - - - - Renders the view with the name and model defined by the and parameters. - - The name of the view to render. - The module path of the module that is rendering the view. - A instance, containing information about the context for which the view is being rendered. - A response. - - - - Initializes a new instance of the class. - - An instance that should be used to resolve the location of a view. - An instance containing the instances that should be able to be used to render a view - A instance that should be used to create an when a view is rendered. - An instance that should be used to resolve all possible view locations - An instance. - - - - Renders the view with the name and model defined by the and parameters. - - The name of the view to render. - The model that should be passed into the view. - A instance, containing information about the context for which the view is being rendered. - A delegate that can be invoked with the that the view should be rendered to. - - - - The default implementation for how views are located by Nancy. - - - - - Defines the functionality for locating the requested view. - - - - - Gets the location of the view defined by the parameter. - - Name of the view to locate. - The instance for the current request. - A instance if the view could be located; otherwise . - - - - Gets all the views that are currently discovered - Note: this is *not* the recommended way to deal with the view locator - as it doesn't allow for runtime discovery of views with the - settings. - - A collection of instances - - - - Gets the location of the view defined by the parameter. - - Name of the view to locate. - The instance for the current request. - A instance if the view could be located; otherwise . - - - - Gets all the views that are currently discovered - Note: this is *not* the recommended way to deal with the view locator - as it doesn't allow for runtime discovery of views with the - settings. - - A collection of instances - - - - Default implementation on how views are resolved by Nancy. - - - - - Initializes a new instance of the class. - - The view locator that should be used to locate views. - The conventions that the view resolver should use to figure out where to look for views. - - - - Locates a view based on the provided information. - - The name of the view to locate. - The model that will be used with the view. - A instance, containing information about the context for which the view is being located. - A instance if the view could be found, otherwise . - - - - View location result for file system based views. - Supports detecting if the contents have changed since it - was last read. - - - - - Contains the result of an attempt to locate a view. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The location of where the view was found. - The name of the view. - The file extension of the located view. - A that can be used to read the contents of the located view. - - - - Gets a value indicating whether the current item is stale - - True if stale, false otherwise - - - - Indicates whether the current object is equal to another object of the same type. - - if the current object is equal to the parameter; otherwise, . - An to compare with this instance. - - - - Determines whether the specified is equal to the current . - - if the specified is equal to the current ; otherwise, . - The to compare with the current . - - - - Serves as a hash function for a particular type. - - A hash code for the current . - - - - Gets a function that produces a reader for retrieving the contents of the view. - - A instance that can be used to produce a reader for retrieving the contents of the view. - - - - Gets the extension of the view that was located. - - A containing the extension of the view that was located. - The extension should not contain a leading dot. - - - - Gets the location of where the view was found. - - A containing the location of the view. - - - - Gets the full name of the view that was found - - A containing the name of the view. - - - - Initializes a new instance of the class. - - The location of where the view was found. - The name of the view. - The file extension of the located view. - A that can be used to read the contents of the located view. - Full filename of the file - An instance that should be used when retrieving view information from the file system. - - - - Gets a value indicating whether the current item is stale - - True if stale, false otherwise - - - - Wraps the real contents delegate to set the last modified date first - - TextReader to read the file - - - - Defines the functionality that a view engine must support to be integrated into Nancy. - - - - - Initialise the view engine (if necessary) - - Startup context - - - - Renders the view. - - A instance, containing information on how to get the view template. - The model that should be passed into the view - - A response - - - - Gets the extensions file extensions that are supported by the view engine. - - An instance containing the extensions. - The extensions should not have a leading dot in the name. - - - - Contains the functionality for locating a view that has been embedded into an assembly resource. - - - - - User-configured root namespaces for assemblies. - - - - - A list of assemblies to ignore when scanning for embedded views. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - An instance that should be used when extracting embedded views. - An instance that should be used to determine which assemblies to scan for embedded views. - - - - Returns an instance for all the views that could be located by the provider. - - An instance, containing the view engine file extensions that is supported by the running instance of Nancy. - An instance, containing instances for the located views. - If no views could be located, this method should return an empty enumerable, never . - - - - Returns an instance for all the views matching the viewName that could be located by the provider. - - An instance, containing the view engine file extensions that is supported by the running instance of Nancy. - The name of the view to try and find - An instance, containing instances for the located views. - If no views could be located, this method should return an empty enumerable, never . - - - - Matches and modifies the content of a rendered SuperSimpleViewEngine view. - - - - - Invokes the matcher on the content of the rendered view. - - The content of the rendered view. - The model that was passed to the view. - The host. - The modified version of the view. - - - - Provides the view engine with utility functions for - encoding, locating partial view templates etc. - - - - - Html "safe" encode a string - - Input string - Encoded string - - - - Get the contents of a template - - Name/location of the template - Model to use to locate the template via conventions - Contents of the template, or null if not found - - - - Gets a uri string for a named route - - Named route name - Parameters to use to expand the uri string - Expanded uri string, or null if not found - - - - Expands a path to include any base paths - - Path to expand - Expanded path - - - - Get the anti forgery token form element - - String containing the form element - - - - Context object of the host application. - - An instance of the context object from the host. - - - - Initializes a new instance of the class. - - - The render context. - - - - - Html "safe" encode a string - - Input string - Encoded string - - - - Get the contents of a template - - Name/location of the template - Model to use to locate the template via conventions - Contents of the template, or null if not found - - - - Gets a uri string for a named route - - Named route name - Parameters to use to expand the uri string - Expanded uri string, or null if not found - - - - Expands a path to include any base paths - - Path to expand - Expanded path - - - - Get the anti forgery token form element - - String containing the form element - - - - Context object of the host application. - - An instance of the context object from the host. - - - - A super-simple view engine - - - - - Compiled Regex for viewbag substitutions - - - - - Compiled Regex for single substitutions - - - - - Compiled Regex for context subsituations - - - - - Compiled Regex for each blocks - - - - - Compiled Regex for each block current substitutions - - - - - Compiled Regex for if blocks - - - - - Compiled regex for partial blocks - - - - - Compiled RegEx for section block declarations - - - - - Compiled RegEx for section block contents - - - - - Compiled RegEx for master page declaration - - - - - Compiled RegEx for path expansion - - - - - Compiled RegEx for path expansion in attribute values - - - - - Compiled RegEx for the CSRF anti forgery token - - - - - View engine transform processors - - - - - View engine extensions - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class, using - the provided extensions. - - The matchers to use with the engine. - - - - Renders a template - - The template to render. - The model to user for rendering. - The view engine host - A string containing the expanded template. - - - - - Gets a property value from the given model. - - - Anonymous types, standard types and ExpandoObject are supported. - Arbitrary dynamics (implementing IDynamicMetaObjectProvider) are not, unless - they also implement IDictionary string, object for accessing properties. - - - The model. - The property name to evaluate. - Tuple - Item1 being a bool for whether the evaluation was successful, Item2 being the value. - Model type is not supported. - - - - A property extractor for standard types. - - The model. - The property name. - Tuple - Item1 being a bool for whether the evaluation was successful, Item2 being the value. - - - - A property extractor designed for ExpandoObject, but also for any - type that implements IDictionary string object for accessing its - properties. - - The model. - The property name. - Tuple - Item1 being a bool for whether the evaluation was successful, Item2 being the value. - - - - Gets an IEnumerable of capture group values - - The match to use. - Group name containing the capture group. - IEnumerable of capture group values as strings. - - - - Gets a property value from a collection of nested parameter names - - The model containing properties. - A collection of nested parameters (e.g. User, Name - Tuple - Item1 being a bool for whether the evaluation was successful, Item2 being the value. - - - - Gets the predicate result for an If or IfNot block - - The item to evaluate - Property list to evaluate - Whether to check for null, rather than straight boolean - Bool representing the predicate result - - - - Returns the predicate result if the substitionObject is a valid bool - - The substitution object. - - Bool value of the substitutionObject, or false if unable to cast. - - - - Returns the predicate result if the substitionObject is a valid ICollection - - The substitution object. - Bool value of the whether the ICollection has items, or false if unable to cast. - - - - Performs single @ViewBag.PropertyName substitutions. - - The template. - This parameter is not used, the model is based on the "host.Context.ViewBag". - View engine host - Template with @ViewBag.PropertyName blocks expanded. - - - - Performs single @Model.PropertyName substitutions. - - The template. - The model. - View engine host - Template with @Model.PropertyName blocks expanded. - - - - Performs single @Context.PropertyName substitutions. - - The template. - The model. - View engine host - Template with @Context.PropertyName blocks expanded. - - - - Performs @Each.PropertyName substitutions - - The template. - The model. - View engine host - Template with @Each.PropertyName blocks expanded. - - - - Expand a @Current match inside an @Each iterator - - Contents of the @Each block - Current item from the @Each enumerable - View engine host - String result of the expansion of the @Each. - - - - Performs @If.PropertyName and @IfNot.PropertyName substitutions - - The template. - The model. - View engine host - Template with @If.PropertyName @IfNot.PropertyName blocks removed/expanded. - - - - Perform path expansion substitutions - - The template. - The model. - View engine host - Template with paths expanded - - - - Perform CSRF anti forgery token expansions - - The template. - The model. - View engine host - Template with anti forgery tokens expanded - - - - Perform @Partial partial view expansion - - The template. - The model. - View engine host - Template with partials expanded - - - - Invokes the master page rendering with current sections if necessary - - The template. - The model. - View engine host - Template with master page applied and sections substituted - - - - Renders a master page - does a normal render then replaces any section tags with sections passed in - - The master page template - Dictionary of section contents - The model. - View engine host - Template with the master page applied and sections substituted - - - - Gets the master page name, if one is specified - - The template - Master page name or String.Empty - - - - Performs application registrations for the SuperSimpleViewEngine. - - - - - Gets the type registrations to register for this startup task - - - - - Gets the collection registrations to register for this startup task - - - - - Gets the instance registrations to register for this startup task - - - - - Nancy IViewEngine wrapper for the super simple view engine - - - - - Extensions that the view engine supports - - - - - The engine itself - - - - - Initializes a new instance of the class, using - the provided extensions. - - The matchers to use with the engine. - - - - Initialise the view engine (if necessary) - - Startup context - - - - Renders the view. - - A instance, containing information on how to get the view template. - The model that should be passed into the view - An instance. - A response - - - - Gets the extensions file extensions that are supported by the view engine. - - An instance containing the extensions. - The extensions should not have a leading dot in the name. - - - - Calls the initialize method on all implementations, at application startup. - - - - - Initializes a new instance of the class, with the - provided , and . - - The available view engines. - The view cache. - The view locator. - - - - Perform any initialisation tasks - - Application pipelines - - - - Context passed to each view engine on startup - - - - - Gets the Nancy view cache - can be used to precompile views at startup - if necessary. - - - - - Gets the Nancy view locator - - - - - The context for which a view is being located. - - - - - The module path of the that is locating a view. - - A containing the module path. - - - - The name of the that is locating a view. - - A containing the name of the module. - - - - The request/response context - - - - - Exception that is thrown when a view could not be located. - - - - - Initializes a new instance of the . - - The name of the view that was being located. - List of available view extensions that can be rendered by the available view engines. - The locations that were inspected for the view. - An instance. - - - - Initializes a new instance of the . - - The name of the view that was being located. - List of available view extensions that can be rendered by the available view engines. - - - - Initializes a new instance of the - - A message describing the problem - - - - Gets a message that describes the current exception. - - The error message that explains the reason for the exception, or an empty string(""). - - - - An exception that indicates the view could not be rendered - - - - - Create an instance of - - A description of the rendering problem - - - - Create an instance of - - A description of the rendering problem - The exception that is the cause of the current exception. - - - - Helper class for rendering a view from a route handler. - - - - - Initializes a new instance of the class. - - The instance that is rendering the view. - - - - Renders the view with its name resolved from the model type, and model defined by the parameter. - - The model that should be passed into the view. - A delegate that can be invoked with the that the view should be rendered to. - The view name is model.GetType().Name with any Model suffix removed. - - - - Renders the view with the name defined by the parameter. - - The name of the view to render. - A delegate that can be invoked with the that the view should be rendered to. - The extension in the view name is optional. If it is omitted, then Nancy will try to resolve which of the available engines that should be used to render the view. - - - - Renders the view with the name and model defined by the and parameters. - - The name of the view to render. - The model that should be passed into the view. - A delegate that can be invoked with the that the view should be rendered to. - The extension in the view name is optional. If it is omitted, then Nancy will try to resolve which of the available engines that should be used to render the view. - - - - Gets or sets whether character encoding should be enabled, or not, for XML responses. - - - The default value is - - - - - Gets the default encoding for XML responses. - - - The default value is - - - - diff --git a/packages/FAKE.4.11.3/tools/Newtonsoft.Json.dll b/packages/FAKE.4.11.3/tools/Newtonsoft.Json.dll deleted file mode 100644 index ae725c4..0000000 Binary files a/packages/FAKE.4.11.3/tools/Newtonsoft.Json.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/NuGet.Core.dll b/packages/FAKE.4.11.3/tools/NuGet.Core.dll deleted file mode 100644 index 5734564..0000000 Binary files a/packages/FAKE.4.11.3/tools/NuGet.Core.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/README.markdown b/packages/FAKE.4.11.3/tools/README.markdown deleted file mode 100644 index 13c6567..0000000 --- a/packages/FAKE.4.11.3/tools/README.markdown +++ /dev/null @@ -1,30 +0,0 @@ -# FAKE - F# Make - -[![Join the chat at https://gitter.im/fsharp/FAKE](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/fsharp/FAKE?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) - -"FAKE - F# Make" is a cross platform build automation system. Due to its integration -in F#, all benefits of the .NET Framework and functional programming can be used, including -the extensive class library, powerful debuggers and integrated development environments like -Visual Studio or MonoDevelop, which provide syntax highlighting and code completion. - -The new DSL was designed to be succinct, typed, declarative, extensible and easy to use. - -See the [project home page](http://fsharp.github.com/FAKE/) for tutorials and [API documentation](http://fsharp.github.io/FAKE/apidocs/index.html). - -# Build the project - -* Mono: Run *build.sh* [![Travis build status](https://travis-ci.org/fsharp/FAKE.png)](https://travis-ci.org/fsharp/FAKE) -* Windows: Run *build.cmd* [![AppVeyor build status](https://ci.appveyor.com/api/projects/status/lk1dfo1qi99ri78f)](https://ci.appveyor.com/project/SteffenForkmann/fake) - -[![Issue Stats](http://www.issuestats.com/github/fsharp/FAKE/badge/pr)](http://www.issuestats.com/github/fsharp/FAKE) [![Issue Stats](http://www.issuestats.com/github/fsharp/FAKE/badge/issue)](http://www.issuestats.com/github/fsharp/FAKE) - -[![NuGet Status](http://img.shields.io/nuget/v/FAKE.svg?style=flat)](https://www.nuget.org/packages/FAKE/) -[![Nuget](https://img.shields.io/nuget/dt/FAKE.svg)](http://nuget.org/packages/FAKE) - -## How to contribute code - -See the [contributing page](http://fsharp.github.com/FAKE/contributing.html). - -## Maintainers - -Although this project is hosted in the [fsharp](https://github.com/fsharp) repository for historical reasons, it is _not_ maintained and managed by the F# Core Engineering Group. The F# Core Engineering Group acknowledges that the independent owner and maintainer of this project is [Steffen Forkmann](http://github.com/forki). diff --git a/packages/FAKE.4.11.3/tools/RELEASE_NOTES.md b/packages/FAKE.4.11.3/tools/RELEASE_NOTES.md deleted file mode 100644 index abe8878..0000000 --- a/packages/FAKE.4.11.3/tools/RELEASE_NOTES.md +++ /dev/null @@ -1,606 +0,0 @@ -#### 4.11.3 - 22.12.2015 -* BUGFIX: Use UTF-8 encoding of AssemblyInfo as written by ReplaceAssemblyInfoVersions - https://github.com/fsharp/FAKE/pull/1055 - -#### 4.11.1 - 22.12.2015 -* New Open/Close block helpers for TeamCity - https://github.com/fsharp/FAKE/pull/1049 - -#### 4.11.0 - 19.12.2015 -* Add specific version parameter in PaketPackParams - https://github.com/fsharp/FAKE/pull/1046 -* Fixed isMacOS function - https://github.com/fsharp/FAKE/pull/1044 -* Added more comfortable types to WiXHelper, flagged old ones obsolete - https://github.com/fsharp/FAKE/pull/1036 -* Use FSharp.Compiler.Service 1.4.2.3 -* Only add relative path prefix if not rooted path in MSBuildHelper - https://github.com/fsharp/FAKE/pull/1033 -* Replaced hard reference on gacutil path with automatic search - https://github.com/fsharp/FAKE/pull/1040 -* Wrap OutputPath in quotes in paket helper - https://github.com/fsharp/FAKE/pull/1027 -* Allow override of the signature algorithm and message digest algorithm in Xamarin helper - https://github.com/fsharp/FAKE/pull/1025 -* Expose excluded templates in Pack helper - https://github.com/fsharp/FAKE/pull/1026 -* Added initial implementation of DynamicsCRMHelper - https://github.com/fsharp/FAKE/pull/1009 - -#### 4.10.0 - 30.11.2015 -* Added support for Squirrel's --no-msi option - https://github.com/fsharp/FAKE/pull/1013 -* Upload has longer timeout - https://github.com/fsharp/FAKE/pull/1004 -* Added the History Directory argument of ReportGenerator - https://github.com/fsharp/FAKE/pull/1003 -* Support for Bamboo build server - https://github.com/fsharp/FAKE/pull/1015 -* Added APPVEYOR_JOB_NAME appveyor environment variable - https://github.com/fsharp/FAKE/pull/1022 -* Updated octopus sample to reflect 3.3.0 package - https://github.com/fsharp/FAKE/pull/1021 -* Added functionality for deleting files and folders in FTP Helper - https://github.com/fsharp/FAKE/pull/1018 -* BASH completion for FAKE targets - https://github.com/fsharp/FAKE/pull/1020 -* BUGFIX: Fix case on MsBuild LogFile option - https://github.com/fsharp/FAKE/pull/1008 -* BUGFIX: Fix git version on Mac - https://github.com/fsharp/FAKE/pull/1006 - -#### 4.9.1 - 11.11.2015 -* Added support for channels to OctoTools - https://github.com/fsharp/FAKE/pull/1001 -* BUGFIX: Create AssemblyInfo directory only where required - https://github.com/fsharp/FAKE/pull/997 -* COSMETICS: Renamed confusing parameter in FSI helper - https://github.com/fsharp/FAKE/pull/1000 - -#### 4.8.0 - 04.11.2015 -* Basic npm support - https://github.com/fsharp/FAKE/pull/993 -* New RoboCopy helper - https://github.com/fsharp/FAKE/pull/988 -* Option ignore failing tests DotCover https://github.com/fsharp/FAKE/pull/990 -* Add code to replace new assemblyinfo attributes - https://github.com/fsharp/FAKE/pull/991 -* Cleanup Registry helpers - https://github.com/fsharp/FAKE/pull/980 -* FAKE.Deploy scans for default scripts - https://github.com/fsharp/FAKE/pull/981 -* BUGFIX: Use WorkingDir in Paket helpers -* BUGFIX: support caching even when running RazorEngine as part of the build script - https://github.com/fsharp/FAKE/pull/979 - -#### 4.6.0 - 14.10.2015 -* New Registry functions - https://github.com/fsharp/FAKE/pull/976 -* Add attribute filters to DotCover - https://github.com/fsharp/FAKE/pull/974 -* Always use FullName of nuspec for NuGet pack -* DotCover support for MSTest - https://github.com/fsharp/FAKE/pull/972 -* Added new functions: replace and poke for inner xml - https://github.com/fsharp/FAKE/pull/970 -* Adding TestFile helper - https://github.com/fsharp/FAKE/pull/962 - -#### 4.5.0 - 07.10.2015 -* Ensure FSI-ASSEMBLY.dll path exists - https://github.com/fsharp/FAKE/pull/969 -* New dotCover runner for Xunit2 - https://github.com/fsharp/FAKE/pull/965 -* Make FAKE compatible with Microsoft Dynamics 2016 -* Don't assume that mono is on the path for El Capitan - https://github.com/fsharp/FAKE/pull/963/files -* Better target handling - https://github.com/fsharp/FAKE/pull/954 -* Ignore group lines in paket.references parser -* Revert breaking change in FCS -* Support for Android-MultiPackages - https://github.com/fsharp/FAKE/pull/964 -* BUGFIX: Exclude long directories from globbing - https://github.com/fsharp/FAKE/pull/955 -* BUGFIX: Encode script path in cache - https://github.com/fsharp/FAKE/pull/956 - -#### 4.4.0 - 11.09.2015 -* iOSBuild relies on xbuild instead of mdtool - https://github.com/fsharp/FAKE/pull/945 -* New method to return whether or not a value exists for a registry key - https://github.com/fsharp/FAKE/pull/944 -* Extended ReportGeneratorHelper to add Badges report type - https://github.com/fsharp/FAKE/pull/943 -* HockeyAppHelper download team restriction - https://github.com/fsharp/FAKE/pull/939 -* Use TFS variables as fallback, fixes #933 - https://github.com/fsharp/FAKE/pull/937 -* Deployment configurable timeouts in FAKE.Deploy - https://github.com/fsharp/FAKE/pull/927 -* Fixed bug where only first 1024 bytes were uploaded using FTP - https://github.com/fsharp/FAKE/pull/932 -* FAKE 4.2 or newer started with wrong Target - https://github.com/fsharp/FAKE/pull/931 -* Better user input helper - https://github.com/fsharp/FAKE/pull/930 -* Add support for new Xunit2 runner -noappdomain flag - https://github.com/fsharp/FAKE/pull/928 - -#### 4.3.0 - 26.08.2015 -* FluentMigrator helper library - http://fsharp.github.io/FAKE/fluentmigrator.html - -#### 4.2.0 - 24.08.2015 -* Support for soft dependencies for targets - http://fsharp.github.io/FAKE/soft-dependencies.html -* Added support for builds within Team Foundation Server (and VSO) - https://github.com/fsharp/FAKE/pull/915 -* New options in the SquirrelHelper - https://github.com/fsharp/FAKE/pull/910 -* Logging improvement in Fake.Deploy - https://github.com/fsharp/FAKE/pull/914 -* New RunTargetOrListTargets function - https://github.com/fsharp/FAKE/pull/921 -* Added date to ReleaseNotes type definition - https://github.com/fsharp/FAKE/pull/917 -* Added `createClientWithToken` & `createRelease` to Octokit.fsx - https://github.com/fsharp/FAKE/pull/913 -* Fixed WatchChanges not properly removing subdirectories from watch list - https://github.com/fsharp/FAKE/pull/908 -* Added ability to optionally pass in SiteId to configure IIS Site - https://github.com/fsharp/FAKE/pull/905 -* Pass OutputDataReceived to logfn instead of trace in shellExec - https://github.com/fsharp/FAKE/pull/906 -* Add GetDependenciesForReferencesFile - -#### 4.1.0 - 10.08.2015 -* Using FSharp.Compiler.Server for F# 4.0 -* Added Squirrel helpers to generate Squirrel installers - https://github.com/fsharp/FAKE/pull/899 -* Added Ability to specify Identity for AppPool - https://github.com/fsharp/FAKE/pull/902 -* Dynamics NAV: version helpers - https://github.com/fsharp/FAKE/pull/900 -* Added ReleaseNotes to NugetHelper - https://github.com/fsharp/FAKE/pull/893 -* BUGFIX: running from a network drive - https://github.com/fsharp/FAKE/pull/892 -* BUGFIX: Align NUnitDomainModel with NUnit documentation - https://github.com/fsharp/FAKE/pull/897 -* BUGFIX: Skip Octokit retry logic on Mono where it causes a crash - https://github.com/fsharp/FAKE/pull/895 -* BUGFIX: FAKE removes mono debug file after cache is saved - https://github.com/fsharp/FAKE/pull/891 -* BUGFIX: Nunit Domain Fix - https://github.com/fsharp/FAKE/pull/883 -* BUGGFIX: Dynamic assembly handling for caching - https://github.com/fsharp/FAKE/pull/884 -* BUGFIX: Loaded dlls versions are used to invalidate FAKE's cache - https://github.com/fsharp/FAKE/pull/882 - -#### 4.0.0 - 23.07.2015 -* Automatic caching of FAKE build scripts - https://github.com/fsharp/FAKE/pull/859 -* Added MSBuild properties to AndroidPackageParams - https://github.com/fsharp/FAKE/pull/863 -* Add support for outputting NUnit style test result XML to Fake.Testing.XUnit2 - https://github.com/fsharp/FAKE/pull/870 -* Add support for VS2015 VSTest executable - https://github.com/fsharp/FAKE/pull/877 -* Add lock-dependencies parameter to Paket.Pack - https://github.com/fsharp/FAKE/pull/876 - -#### 3.36.0 - 13.07.2015 -* NoLogo parameter for MSBuildHelper - https://github.com/fsharp/FAKE/pull/850 -* Expose Globbing.isMatch for use by external code - https://github.com/fsharp/FAKE/pull/860 -* VB6 dependency updater - https://github.com/fsharp/FAKE/pull/857 -* Added BuildConfig/TemplateFile options to PaketHelper's Pack command - https://github.com/fsharp/FAKE/pull/854 -* Add a UserInputHelper to allow interactive input - https://github.com/fsharp/FAKE/pull/858 -* Look for MSTest in VS2015 location - https://github.com/fsharp/FAKE/pull/843 -* Add caching to globbing -* BUGFIX: Fix for single * glob not working - https://github.com/fsharp/FAKE/pull/836 -* BUGFIX: Get package version from nuspec file - https://github.com/fsharp/FAKE/pull/829 -* Report all NuGet errors, even if ExitCode = 0 - -#### 3.35.0 - 09.06.2015 -* Added Raygun.io helper - https://github.com/fsharp/FAKE/pull/826 -* Re-added internal class generated for AssemblyInfo.vb - https://github.com/fsharp/FAKE/pull/827 -* Allow test nUnit test assemblies containing SetupFixture attributes be compatible with NUnitParallel - https://github.com/fsharp/FAKE/pull/824 -* Fix FtpHelper -* Trace no. of files in a patch -* CMake support improvements - https://github.com/fsharp/FAKE/pull/821 -* Wix Helper Improvements - https://github.com/fsharp/FAKE/pull/818 -* Wix Helper Improvements - https://github.com/fsharp/FAKE/pull/817 -* Wix Helper Improvements - https://github.com/fsharp/FAKE/pull/815 -* Added SemVerHelper.isValidSemVer - https://github.com/fsharp/FAKE/pull/811 - -#### 3.34.0 - 25.05.2015 -* Support for CMake configuration and builds - https://github.com/fsharp/FAKE/pull/785 -* New task to create C++ AssemblyInfo files - https://github.com/fsharp/FAKE/pull/812 -* New environVarOrFail helper - https://github.com/fsharp/FAKE/pull/814 -* New WiX helper functions - https://github.com/fsharp/FAKE/pull/804 - -#### 3.33.0 - 20.05.2015 -* IMPORTANT: Rewrite of the xUnit tasks. Deprecating existing xUnit and xUnit2 tasks - https://github.com/fsharp/FAKE/pull/800 -* Better NUnit docs - https://github.com/fsharp/FAKE/pull/802 - -#### 3.32.4 - 18.05.2015 -* Add test adapter path to vs test params - https://github.com/fsharp/FAKE/pull/793 -* BUGFIX: Fix WatchChanges on Mac, fix Dispose, improve Timer usage - https://github.com/fsharp/FAKE/pull/799 -* REVERT: FCS simplification - https://github.com/fsharp/FAKE/pull/773 -* BUGFIX: Don't use MSBuild from invalid path -* BUGFIX: Improved detection of MSBuild.exe on TeamCity - https://github.com/fsharp/FAKE/pull/789 - -#### 3.31.0 - 06.05.2015 -* BUGFIX: close stdin in asyncShellExec to avoid hangs - https://github.com/fsharp/FAKE/pull/786 -* Fix FAKE not working on machines with only F# 4.0 installed - https://github.com/fsharp/FAKE/pull/784 -* Fix for watching files via relative paths - https://github.com/fsharp/FAKE/pull/782 -* Fix package id parsing and avoid NPE when feed is missing some properties - https://github.com/fsharp/FAKE/pull/776 - -#### 3.30.1 - 29.04.2015 -* FCS simplification - https://github.com/fsharp/FAKE/pull/773 -* Paket push task runs in parallel - https://github.com/fsharp/FAKE/pull/768 - -#### 3.29.2 - 27.04.2015 -* New file system change watcher - http://fsharp.github.io/FAKE/watch.html -* NuGet pack task treats non csproj files as nuspec files - https://github.com/fsharp/FAKE/pull/767 -* New helpers to start and stop DynamicsNAV ServiceTiers -* Automatically replace Win7ToWin8 import files for Dynamics NAV during Import -* OpenSourced DynamicsNAV replacement helpers -* Use Microsoft.AspNet.Razor 2.0.30506 for FAKE.Deploy - https://github.com/fsharp/FAKE/pull/756 -* New build parameter functions -* Fix http://stackoverflow.com/questions/29572870/f-fake-unable-to-get-fake-to-merge-placeholder-arguments-in-nuspec-file -* New environment variable helpers - -#### 3.28.0 - 09.04.2015 -* Don't run package restore during MSBuild run from FAKE - https://github.com/fsharp/FAKE/pull/753 -* Added support for Mage's CertHash parameter - https://github.com/fsharp/FAKE/pull/750 -* Force build server output in xUnit2 if the user wishes to - https://github.com/fsharp/FAKE/pull/749 -* Reverting 0df4569b3bdeef99edf2eec6013dab784e338b7e due to backwards compat issues -* Improvements for FAKE.Deploy - https://github.com/fsharp/FAKE/pull/745 -* Set debug flag on mono - https://github.com/fsharp/FAKE/pull/744 - -#### 3.27.0 - 07.04.2015 -* New Android publisher - http://fsharp.github.io/FAKE/androidpublisher.html -* New Archive helpers allow to build zip, gzip, bzip2, tar, and tar.gz/tar.bz2 - https://github.com/fsharp/FAKE/pull/727 -* Download Status Parameter for HockeyAppHelper - https://github.com/fsharp/FAKE/pull/741 -* Added more parameters for HockeyApp Upload API - https://github.com/fsharp/FAKE/pull/723 -* `NuGetPack` task allows to set framework references - https://github.com/fsharp/FAKE/pull/721 -* New task `NuGetPackDirectly` works without template files. -* Find NuGet.exe in current folder (and sub-folders) first, then look in PATH - https://github.com/fsharp/FAKE/pull/718 -* New tutorial about Vagrant - http://fsharp.github.io/FAKE/vagrant.html -* REVERTING: SystemRoot also works on mono - https://github.com/fsharp/FAKE/pull/706 (see https://github.com/fsharp/FAKE/issues/715) -* BUGFIX: Use DocumentNamespace for Nuspec files - https://github.com/fsharp/FAKE/pull/736 -* BUGFIX: Display agent success / error messages in UI for FAKE.Deploy - https://github.com/fsharp/FAKE/pull/735 -* BUGFIX: Add build directory for doc generation - https://github.com/fsharp/FAKE/pull/734 - -#### 3.26.0 - 25.03.2015 -* Detect GitLab CI as build server - https://github.com/fsharp/FAKE/pull/712 - -#### 3.25.2 - 24.03.2015 -* Look into PATH when scanning for NuGet.exe - https://github.com/fsharp/FAKE/pull/708 -* SystemRoot also works on mono - https://github.com/fsharp/FAKE/pull/706 -* Use EditorConfig - http://editorconfig.org/ - -#### 3.25.1 - 24.03.2015 -* More AppVeyor properties added - https://github.com/fsharp/FAKE/pull/704 - -#### 3.25.0 - 23.03.2015 -* Look into PATH when scanning for tools - https://github.com/fsharp/FAKE/pull/703 - -#### 3.24.0 - 22.03.2015 -* BREAKING CHANGE: Better support for AssemblyMetadata in AssemblyInfoHelper - https://github.com/fsharp/FAKE/pull/694 -* Added modules for building VB6 projects with SxS manifest - https://github.com/fsharp/FAKE/pull/697 -* Use parameter quoting for Paket helpers - -#### 3.23.0 - 12.03.2015 -* BREAKING CHANGE: Adjusted Xamarin.iOS archive helper params - https://github.com/fsharp/FAKE/pull/693 -* New operator allows to combine paths similar to @@ but with no trimming operations - https://github.com/fsharp/FAKE/pull/695 - -#### 3.22.0 - 12.03.2015 -* Globbing allows to grab folders without a trailing slash -* Removed long time obsolete globbing functions - -#### 3.21.0 - 11.03.2015 -* FAKE allows to run parallel builds - http://fsharp.github.io/FAKE/parallel-build.html - -#### 3.20.1 - 10.03.2015 -* Proper source index - https://github.com/fsharp/FAKE/issues/678 - -#### 3.20.0 - 10.03.2015 -* Always use FCS in FAKE and FSI in FAke.Deploy -* Modify VM size on a .csdef for Azure Cloud Services - https://github.com/fsharp/FAKE/pull/687 -* Added ZipHelper.ZipOfIncludes - https://github.com/fsharp/FAKE/pull/686 -* Added AppVeyorEnvironment.RepoTag & .RepoTagName - https://github.com/fsharp/FAKE/pull/685 -* New tutorial about Azure Cloud Service - http://fsharp.github.io/FAKE/azurecloudservices.html -* Added basic support for creating Azure Cloud Services - http://fsharp.github.io/FAKE/apidocs/fake-azure-cloudservices.html -* Added metadata property for AssemblyInfoReplacementParams - https://github.com/fsharp/FAKE/pull/675 - -#### 3.18.0 - 04.03.2015 -* Remvoved internal class generated in AssemblyInfo.Vb - https://github.com/fsharp/FAKE/pull/673 -* Adding ability to control type library export (/tlb flag) of RegAsm - https://github.com/fsharp/FAKE/pull/668 -* Adding ability to run nuget package restore on a visual studio solution - https://github.com/fsharp/FAKE/pull/662 -* Add OwnerId, type docs, and better error handling for HockeyAppHelper - https://github.com/fsharp/FAKE/pull/661 -* Don't report unit test failure twice to TeamCity - https://github.com/fsharp/FAKE/pull/659 -* New tasks for `paket pack` and `paket push`- http://fsprojects.github.io/Paket/index.html -* Allow csproj being passed as a NuSpec file - https://github.com/fsharp/FAKE/pull/644 -* Helper for uploading mobile apps to HockeyApp - https://github.com/fsharp/FAKE/pull/656 -* SCPHelper does allow copying single files - https://github.com/fsharp/FAKE/issues/671 -* BUGFIX: Paket helper should not submit the endpoint if no endpoint was given - https://github.com/fsharp/FAKE/issues/667 -* BUGFIX: Paket helper should not override version for project packages - https://github.com/fsharp/FAKE/issues/666 -* BUGFIX: Allow endpoint in push task - https://github.com/fsprojects/Paket/pull/652 -* BUGFIX: Use correct apikey for paket push - https://github.com/fsharp/FAKE/pull/664 - -#### 3.17.0 - 12.02.2015 -* Revert to fsi in Fake.Deploy - https://github.com/fsharp/FAKE/pull/653 -* Added MergeByHash option for OpenCover - https://github.com/fsharp/FAKE/pull/650 -* New functions to replace text in one or more files using regular expressions - https://github.com/fsharp/FAKE/pull/649 -* BUGFIX: Fix SpecFlow MSTest integration - https://github.com/fsharp/FAKE/pull/652 -* BUGFIX: Fix TeamCity integration - https://github.com/fsharp/FAKE/pull/651 - -#### 3.15.0 - 07.02.2015 -* New VSTest module for working with VSTest.Console - https://github.com/fsharp/FAKE/pull/648 -* Add Verbose to argument list for NuGet update - https://github.com/fsharp/FAKE/pull/645 -* BUGFIX: Fix jarsigner executing on Windows environment - https://github.com/fsharp/FAKE/pull/640 -* Adding UploadTestResultsXml function to the AppVeyor module - https://github.com/fsharp/FAKE/pull/636 -* Adding the NoDefaultExcludes NugGet parameter - https://github.com/fsharp/FAKE/pull/637 -* Adding `SpecificMachines` option to OctoTools - https://github.com/fsharp/FAKE/pull/631 -* Allow to run gacutil on mono -* Ignore unknown project references in MSBuild task - https://github.com/fsharp/FAKE/pull/630 - -#### 3.14.0 - 14.01.2015 -* BUGFIX: Added a reset step before starting a deployment - https://github.com/fsharp/FAKE/pull/621 -* Report fatal git errors to command line - -#### 3.13.0 - 03.01.2015 -* New FAKE.Lib nuget package which contains the FakeLib - https://github.com/fsharp/FAKE/pull/607 -* New AppVeyor properties - https://github.com/fsharp/FAKE/pull/605 -* Use FSharp.Core from NuGet - https://github.com/fsharp/FAKE/pull/602 -* Build and deploy Azure web jobs - https://github.com/fsharp/FAKE/pull/613 - -#### 3.11.0 - 03.12.2014 -* Dual-license under Apache 2 and MS-PL, with Apache as default - https://github.com/fsharp/FAKE/pull/598 -* BUGFIX: FSC compilation fix - https://github.com/fsharp/FAKE/pull/601 -* BUGFIX: Unescape special MSBuild characters - https://github.com/fsharp/FAKE/pull/600 - -#### 3.10.0 - 27.11.2014 -* Support for MSBuild 14.0 - https://github.com/fsharp/FAKE/pull/595 -* New C# compiler helper - https://github.com/fsharp/FAKE/pull/592/files -* Added support for NUnit Fixture parameter - https://github.com/fsharp/FAKE/pull/591 -* OpenSourcing some DynamicsNAV helpers from gitnav -* BUGFIX: Fix 64bit mode -* BUGFIX: Dynamics NAV helper - "Ignored" tests should report the message - -#### 3.9.0 - 07.11.2014 -* Create a new package with a x64 version - https://github.com/fsharp/FAKE/pull/582 -* Added a Xamarin.iOS Archiving helper - https://github.com/fsharp/FAKE/pull/581 -* DynamicsNAV helper should use the correct ServiveTier - -#### 3.8.0 - 30.10.2014 -* [xUnit 2](http://xunit.github.io/) support - https://github.com/fsharp/FAKE/pull/575 -* New RegistryKey helpers for a 64bit System - https://github.com/fsharp/FAKE/pull/580 -* New XDTHelper - https://github.com/fsharp/FAKE/pull/556 -* Version NAV 800 added - https://github.com/fsharp/FAKE/pull/576 -* Feature/list targets in command line - http://fsharp.github.io/FAKE/specifictargets.html -* Use priority list for nuget.exe selection - https://github.com/fsharp/FAKE/issues/572 -* BUGFIX: RoundhouseHelper was setting an incorrect switch for CommandTimoutAdmin - https://github.com/fsharp/FAKE/pull/566 - -#### 3.7.0 - 16.10.2014 -* BUGFIX: --single-target didn't work -* NDepend support - https://github.com/fsharp/FAKE/pull/564 - -#### 3.6.0 - 14.10.2014 -* FAKE got a new logo - https://github.com/fsharp/FAKE/pull/553 -* Use Paket to handle dependencies - http://fsprojects.github.io/Paket/ -* Single target mode --single-target - http://fsharp.github.io/FAKE/specifictargets.html -* New recursive copy functions - https://github.com/fsharp/FAKE/pull/559 -* NuGetPack allows to manipulate nuspec files - https://github.com/fsharp/FAKE/pull/554 -* Support for MSpec --xml parameter - https://github.com/fsharp/FAKE/pull/545 -* Make GetPackageVersion work with Paket - http://fsprojects.github.io/Paket/ -* Added missing schemaName parameter for Roundhouse helper - https://github.com/fsharp/FAKE/pull/551 -* Roundhouse Cleanup - https://github.com/fsharp/FAKE/pull/550 -* Update FSharp.Compiler.Service to 0.0.62 -* BUGFIX: If site exists then the site will be modified by IISHelper with the given parameters - https://github.com/fsharp/FAKE/pull/548 -* BUGFIX: Messages in FSC task to stderr stream can break the build - https://github.com/fsharp/FAKE/pull/546 -* BUGFIX: Use AppVeyor's build version instead of the build number - https://github.com/fsharp/FAKE/pull/560 - -#### 3.5.0 - 19.09.2014 -* Added new SignToolHelper - https://github.com/fsharp/FAKE/pull/535 -* Look first in default path for a tool - https://github.com/fsharp/FAKE/pull/542 -* Add support for MSBuild Distributed Loggers - https://github.com/fsharp/FAKE/pull/536 -* Don't fail on nuget path scanning - https://github.com/fsharp/FAKE/pull/537 - -#### 3.4.0 - 28.08.2014 -* New Xamarin.iOS and Xamarin.Android helpers - https://github.com/fsharp/FAKE/pull/527 - -#### 3.3.0 - 25.08.2014 -* Using JSON.NET 6.0.4 -* FAKE.Deploy switched to FCS - https://github.com/fsharp/FAKE/pull/519 -* FAKE.Deploy WorkDirectory fix - https://github.com/fsharp/FAKE/pull/520 -* HipChat notification helper - https://github.com/fsharp/FAKE/pull/523 -* Don't crash during tool discovery -* NuGet: support fallback framework groups - https://github.com/fsharp/FAKE/pull/514 -* New pushd/popd command in FileUtils - https://github.com/fsharp/FAKE/pull/513 -* New AppVeyor properties -* FSC - support of compilation for different versions of F# -* Provide env var access to --fsiargs build script args so works on FAKE -* Adding NGen Install task -* Allow to use gacutil -* Allow to use ngen.exe -* Allow to use all sn.exe features -* Adding DisableVerification for StrongNames -* Adding helpers which allow to strong name assemblies -* Allow to use empty MSBuild targets -* Adding setProcessEnvironVar and clearProcessEnvironVar -* Try to reference local nuspec in order to fix https://github.com/fsprojects/FSharp.TypeProviders.StarterPack/pull/33 -* Better log messages to fix https://github.com/fsprojects/FSharp.TypeProviders.StarterPack/pull/33 -* Fix fsiargs and -d options - https://github.com/fsharp/FAKE/pull/498 https://github.com/fsharp/FAKE/pull/500 -* Change RemoveDuplicateFiles & FixMissingFiles to only save on change - https://github.com/fsharp/FAKE/pull/499 - -#### 3.2.0 - 07.07.2014 -* BREAKING CHANGE: API for CreateAssemblyInfoWithConfig was set back to original version - This resets the breaking change introduced in https://github.com/fsharp/FAKE/pull/471 -* Automatic tool search for SpecFlowHelper - https://github.com/fsharp/FAKE/pull/496 -* GuardedAwaitObservable was made public by accident - this was fixed -* Add support for remote service admin - https://github.com/fsharp/FAKE/pull/492 - -#### 3.1.0 - 04.07.2014 -* New FSC helper allows to call F# compiler directly from FAKE - https://github.com/fsharp/FAKE/pull/485 -* "CustomDictionary" support for FxCop - https://github.com/fsharp/FAKE/pull/489 -* Check if file exists before delete in AssemblyInfoFile -* Use FSharp.Compiler.Service 0.0.58 -* Report all targets if a target error occurs -* Use FSharp.Compiler.Service with better FSharp.Core resolution - https://github.com/fsharp/FSharp.Compiler.Service/issues/156 -* Don't break in MSBuildHelper -* Put FSharp.Core.optdata and FSharp.Core.sigdata into nuget package -* Fixed TargetTracing -* Fixed SourceLinking of FAKE -* Added new exception trap for Fsi creation -* -br in command line will run debugger in F# scripts - https://github.com/fsharp/FAKE/pull/483 -* Null check in NuGet helper - https://github.com/fsharp/FAKE/pull/482 - -#### 3.0.0 - 27.06.2014 -* Use FSharp.Compiler.Service 0.0.57 instead of fsi.exe -* Better error message for registry access -* Fall back to 32bit registry keys if 64bit cannot be found -* Improved SqlServer Disconnect error message -* Log "kill all processes" only when needed -* Try to run as x86 due to Dynamics NAV problems -* Allow to use /gac for FxCop -* Make NuGet description fit into single line -* Use Nuget.Core 2.8.2 -* Fix NUnitProcessModel.SeparateProcessModel - https://github.com/fsharp/FAKE/pull/474 -* Improved CLI documentation - https://github.com/fsharp/FAKE/pull/472 -* Added Visual Basic support to AssemblyFileInfo task and make Namespace optional in config - https://github.com/fsharp/FAKE/pull/471 -* Added support for OctoTools ignoreExisting flag - https://github.com/fsharp/FAKE/pull/470 -* OctoTools samples fixed - https://github.com/fsharp/FAKE/pull/468 https://github.com/fsharp/FAKE/pull/469 -* Added support for FxCop /ignoregeneratedcode parameter - https://github.com/fsharp/FAKE/pull/467 -* CreateAssemblyInfo works with nonexisting directories - https://github.com/fsharp/FAKE/pull/466 - -#### 2.18.0 - 11.06.2014 -* New (backwards compat) CLI for FAKE that includes FSI cmd args passing - https://github.com/fsharp/FAKE/pull/455 -* New updateApplicationSetting method - https://github.com/fsharp/FAKE/pull/462 -* Support for msbuild /noconlog - https://github.com/fsharp/FAKE/pull/463 -* RoundhouseHelper - https://github.com/fsharp/FAKE/pull/456 -* Pass optional arguments to deployment scripts -* Support building source packages without project file -* Display messages when deploy fails -* Fix formatting in FAKE.Deploy docs -* Fix memory usage in FAKE.Deploy -* Increase WebClient's request timeout to 20 minutes - https://github.com/fsharp/FAKE/pull/442 -* Mainly Layout fixes and disabling authenticate in FAKE.Deploy https://github.com/fsharp/FAKE/pull/441 -* Deploy PDBs via nuget https://github.com/fsharp/FAKE/issues/435 -* Release Notes parser should not drop asterisk at end of lines -* Corrected location of @files@ in nuspec sample -* Allow to report tests to AppVeyor -* fix appveyor msbuild logger -* Don't add Teamcity logger if not needed - -#### 2.17.0 - 23.05.2014 -* Fake.Deploy agent requires user authentication -* Remove AutoOpen von AppVeyor -* fix order of arguments in call to CopyFile -* Support MSTest test settings - https://github.com/fsharp/FAKE/pull/428 -* If the NAV error file contains no compile errors return the length - -#### 2.16.0 - 21.05.2014 -* Promoted the master branch as default branch and removed develop branch -* Remove AutoOpen from TaskRunnerHelper -* Adding Metadata to AsssemblyInfo -* Analyze the Dynamics NAV log file and report the real error count -* Allow to retrieve version no. from assemblies -* Fix issue with symbol packages in NugetHelper -* Fix issues in the ProcessHelper - https://github.com/fsharp/FAKE/pull/412 and https://github.com/fsharp/FAKE/pull/411 -* Allow to register BuildFailureTargets - https://github.com/fsharp/FAKE/issues/407 -* UnionConverter no longer needed for Json.Net - -#### 2.15.0 - 24.04.2014 -* Handle problems with ProgramFilesX86 on mono - https://github.com/tpetricek/FsLab/pull/32 -* Change the MSBuild 12.0 path settings according to https://github.com/tpetricek/FsLab/pull/32 -* Silent mode for MSIHelper - https://github.com/fsharp/FAKE/issues/400 - -#### 2.14.0 - 22.04.2014 -* Support for OpenCover - https://github.com/fsharp/FAKE/pull/398 -* Support for ReportsGenerator - https://github.com/fsharp/FAKE/pull/399 -* Adding AppVeyor environment variables -* New BulkReplaceAssemblyInfoVersions task - https://github.com/fsharp/FAKE/pull/394 -* Fixed default nuspec file -* "Getting started" tutorial uses better folder structure -* Allows explicit file specification on the NuGetParams Type -* Fix TypeScript output dir -* Add better docs for the TypeScript compiler. -* Don't call the TypeScript compiler more than once -* New parameters for TypeScript - -#### 2.13.0 - 04.04.2014 -* Enumerate the files lazily in the File|Directory active pattern -* Using Nuget 2.8.1 -* Added TypeScript 1.0 support -* Added TypeScript support -* Fixed ProcessTestRunner -* Fixed mono build on Travis - -#### 2.12.0 - 31.03.2014 -* Add getDependencies to NugetHelper -* SourceLink support -* NancyFx instead of ASP.NET MVC for Fake.Deploy -* Allows to execute processes as unit tests. -* Adding SourceLinks -* Move release management back to the local machine (using this document) -* Allow to run MsTest test in isolation -* Fixed Nuget.packSymbols -* Fixed bug in SemVer parser -* New title property in Nuspec parameters -* Added option to disabled FAKE's automatic process killing -* Better AppyVeyor integration -* Added ability to define custom MSBuild loggers -* Fix for getting the branch name with Git >= 1.9 -* Added functions to write and delete from registry -* NUnit NoThread, Domain and StopOnError parameters -* Add support for VS2013 MSTest -* Lots of small fixes - -#### 2.2 -* Created new packages on nuget: - * Fake.Deploy - allows to use FAKE scripts in deployment. - * Fake.Experimental - new stuff where we aren't sure if we want to support it. - * Fake.Gallio - contains the Gallio runner support. - * Fake.SQL - Contains tasks for SQL Server. - * Fake.Core - All the basic features and FAKE.exe. -* Created documentation and tutorials - see http://fsharp.github.io/FAKE/ -* New tasks: - * Added ReleaseNotes parser - * Added Dynamics NAV helper - * Added support for MSTest and fixie - * Parallel NUnit task - * New AssemblyInfoFile task - * Support for Octopus Deploy - * Support for MAGE - * Suppport for Xamarin's xpkg - * Many other new tasks -* Fake.Boot -* New Globbing system -* Tons of bug fixes -* Bundles F# 3.0 compiler and FSI. - -#### 1.72.0.0 - -* "RestorePackages" allows to restore nuget packages - -#### 1.70.0.0 - -* FAKE nuget package comes bundles with a fsi.exe -* Self build downloads latest FAKE master via nuget - -#### 1.66.1.0 - -* Fixed bug where FAKE.Deploy didn't run the deploy scripts where used as a windows service -* It's possible to add file loggers for MSBuild -* Fixed path resolution for fsi on *nix -* BREAKING CHANGE: Removed version normalization from NuGet package creation -* Fixes for NUNit compatibility on mono -* Fixes in ProcessHelper for mono compatibility -* Fixes in the mono build -* Improved error reporting in Fake.exe -* Added a SpecFlow helper -* Fixed some issues in file helper routines when working with no existing directory chain - -#### 1.64.1.0 - -* Fixed bug where FAKE didn't run the correct build script - -#### 1.64.0.0 - -* New conditional dependency operator =?> -* BREAKING CHANGE: Some AssemblyInfo task parameters are now option types. See type hints. - -#### 1.62.0.0 - -* New RegAsm task, allows to create TLBs from a dll. -* New MSI task, allows to install or uninstall msi files. -* StringHelper.NormalizeVersion fixed for WiX. - -#### 1.58.9.0 - -* Allow to choose specific nunit-console runner. - -#### 1.58.6.0 - -* Using nuget packages for mspec. -* FAKE tries to kill all MSBuild and FSI processes at the end of a build. - -#### 1.58.1.0 - -* Removed message system for build output. Back to simpler tracing. - -#### 1.58.0.0 - -* ReplaceAssemblyInfoVersions task allows to replace version info in AssemblyVersion-files -* New task ConvertFileToWindowsLineBreaks - -#### 1.56.10.0 - -* Allows to build .sln files - -#### 1.56.0.0 - -* Allows to publish symbols via nuget.exe -* Autotrim trailing .0 from version in order to fullfill nuget standards. - -#### 1.54.0.0 - -* If the publishment of a Nuget package fails, then FAKE will try it again. -* Added Changelog.markdown to FAKE deployment -* Added RequireExactly helper function in order to require a specific nuget dependency. -* NugetHelper.GetPackageVersion - Gets the version no. for a given package in the packages folder. -* EnvironmentHelper.getTargetPlatformDir - Gets the directory for the given target platform. - -#### 1.52.0.0 - -* Some smaller bugfixes -* New dependency syntax with ==> and <=> -* Tracing of StackTrace only if TargetHelper.PrintStackTraceOnError was set to true - -#### 1.50.0.0 - -* New task DeleteDirs allows to delete multiple directories. -* New parameter for NuGet dependencies. - -#### 1.48.0.0 - -* Bundled with docu.exe compiled against .Net 4.0. -* Fixed docu calls to run with full filenames. -* Added targetplatform, target and log switches for ILMerge task. -* Added Git.Information.getLastTag() which gets the last git tag by calling git describe. -* Added Git.Information.getCurrentHash() which gets the last current sha1. - -#### 1.46.0.0 - -* Fixed Nuget support and allows automatic push. - -#### 1.44.0.0 - -* Tracing of all external process starts. -* MSpec support. diff --git a/packages/FAKE.4.11.3/tools/Renci.SshNet.dll b/packages/FAKE.4.11.3/tools/Renci.SshNet.dll deleted file mode 100644 index 58f517f..0000000 Binary files a/packages/FAKE.4.11.3/tools/Renci.SshNet.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/Renci.SshNet.xml b/packages/FAKE.4.11.3/tools/Renci.SshNet.xml deleted file mode 100644 index a90ca67..0000000 --- a/packages/FAKE.4.11.3/tools/Renci.SshNet.xml +++ /dev/null @@ -1,14726 +0,0 @@ - - - - Renci.SshNet - - - - - Base class for all supported authentication methods - - - - - Initializes a new instance of the class. - - The username. - is whitespace or null. - - - - Authenticates the specified session. - - The session to authenticate. - Result of authentication process. - - - - Gets authentication method name - - - - - Gets connection username. - - - - - Gets the authentication error message. - - - - - Gets list of allowed authentications. - - - - - Represents possible authentication methods results - - - - - Authentication was successful. - - - - - Authentication completed with partial success. - - - - - Authentication failed. - - - - - Serves as base class for client implementations, provides common client functionality. - - - - - Initializes a new instance of the class. - - The connection info. - is null. - - - - Connects client to the server. - - - - - Disconnects client from the server. - - - - - Sends keep-alive message to the server. - - - - - Called when client is connecting to the server. - - - - - Called when client is connected to the server. - - - - - Called when client is disconnecting from the server. - - - - - Called when client is disconnected from the server. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged ResourceMessages. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged ResourceMessages. - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Gets current session. - - - - - Gets the connection info. - - - - - Gets a value indicating whether this client is connected to the server. - - - true if this client is connected; otherwise, false. - - - - - Gets or sets the keep alive interval in seconds. - - - The keep alive interval in seconds. - - - - - Occurs when an error occurred. - - - - - - - - Occurs when host key received. - - - - - - - - Provides additional information for asynchronous command execution - - - - - Gets or sets the command that async result was created for. - - The channel. - - - - Initializes a new instance of the class. - - The command. - - - - Gets or sets the bytes received. If SFTP only file bytes are counted. - - Total bytes received. - - - - Gets or sets the bytes sent by SFTP. - - Total bytes sent. - - - - Gets a user-defined object that qualifies or contains information about an asynchronous operation. - - A user-defined object that qualifies or contains information about an asynchronous operation. - - - - Gets a that is used to wait for an asynchronous operation to complete. - - A that is used to wait for an asynchronous operation to complete. - - - - Gets a value that indicates whether the asynchronous operation completed synchronously. - - true if the asynchronous operation completed synchronously; otherwise, false. - - - - Gets a value that indicates whether the asynchronous operation has completed. - - true if the operation is complete; otherwise, false. - - - - Represents base class for SSH channel implementations. - - - - - Initializes a new instance of the class. - - - - - Initializes the channel. - - The session. - The server channel number. - Size of the window. - Size of the packet. - - - - Sends the SSH_MSG_CHANNEL_EOF message. - - - - - Closes the channel. - - - - - Called when channel need to be open on the client. - - Channel open information. - - - - Called when channel is opened by the server. - - The remote channel number. - Initial size of the window. - Maximum size of the packet. - - - - Called when channel failed to open. - - The reason code. - The description. - The language. - - - - Called when channel window need to be adjust. - - The bytes to add. - - - - Called when channel data is received. - - The data. - - - - Called when channel extended data is received. - - The data. - The data type code. - - - - Called when channel has no more data to receive. - - - - - Called when channel is closed by the server. - - - - - Called when channel request received. - - Channel request information. - - - - Called when channel request was successful - - - - - Called when channel request failed. - - - - - Sends SSH message to the server. - - The message. - - - - Send message to open a channel. - - Message to send - - - - Sends close channel message to the server - - Message to send. - - - - Sends channel data message to the servers. - - This method takes care of managing the window size. - Channel data message. - - - - Sends channel extended data message to the servers. - - This method takes care of managing the window size. - Channel data message. - - - - Waits for the handle to be signaled or for an error to occurs. - - The wait handle. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Gets the type of the channel. - - - The type of the channel. - - - - - Gets the local channel number. - - - - - Gets the remote channel number assigned by the server. - - - - - Gets the size of the local window. - - - The size of the local window. - - - - - Gets or sets the size of the server window. - - - The size of the server window. - - - - - Gets the size of the packet. - - - The size of the packet. - - - - - Gets a value indicating whether this channel is open. - - - true if this channel is open; otherwise, false. - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Gets a value indicating whether the session is connected. - - - true if the session is connected; otherwise, false. - - - - - Gets the connection info. - - The connection info. - - - - Gets the session semaphore to control number of session channels - - The session semaphore. - - - - Implements "direct-tcpip" SSH channel. - - - Implements "direct-tcpip" SSH channel. - - - - - Initializes a new instance of the class. - - - - - Binds channel to remote host. - - - - - Called when channel data is received. - - The data. - - - - Called when channel is opened by the server. - - The remote channel number. - Initial size of the window. - Maximum size of the packet. - - - - Called when channel has no more data to receive. - - - - - Gets the type of the channel. - - - The type of the channel. - - - - - Implements "forwarded-tcpip" SSH channel. - - - Implements "forwarded-tcpip" SSH channel. - - - - - Initializes a new instance of the class. - - - - - Binds channel to specified connected host. - - The connected host. - The connected port. - - - - Called when channel data is received. - - The data. - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Gets the type of the channel. - - - The type of the channel. - - - - - Implements Session SSH channel. - - - - - Counts faile channel open attempts - - - - - Wait handle to signal when response was received to open the channel - - - - - Opens the channel. - - - - - Called when channel is opened by the server. - - The remote channel number. - Initial size of the window. - Maximum size of the packet. - - - - Called when channel failed to open. - - The reason code. - The description. - The language. - - - - Called when channel is closed by the server. - - - - - Sends the pseudo terminal request. - - The environment variable. - The columns. - The rows. - The width. - The height. - The terminal mode values. - - true if request was successful; otherwise false. - - - - - Sends the X11 forwarding request. - - if set to true the it is single connection. - The protocol. - The cookie. - The screen number. - true if request was successful; otherwise false. - - - - Sends the environment variable request. - - Name of the variable. - The variable value. - true if request was successful; otherwise false. - - - - Sends the shell request. - - true if request was successful; otherwise false. - - - - Sends the exec request. - - The command. - true if request was successful; otherwise false. - - - - Sends the exec request. - - Length of the break. - true if request was successful; otherwise false. - - - - Sends the subsystem request. - - The subsystem. - true if request was successful; otherwise false. - - - - Sends the window change request. - - The columns. - The rows. - The width. - The height. - true if request was successful; otherwise false. - - - - Sends the local flow request. - - if set to true [client can do]. - true if request was successful; otherwise false. - - - - Sends the signal request. - - Name of the signal. - true if request was successful; otherwise false. - - - - Sends the exit status request. - - The exit status. - true if request was successful; otherwise false. - - - - Sends the exit signal request. - - Name of the signal. - if set to true [core dumped]. - The error message. - The language. - true if request was successful; otherwise false. - - - - Sends eow@openssh.com request. - - true if request was successful; otherwise false. - - - - Sends keepalive@openssh.com request. - - true if request was successful; otherwise false. - - - - Called when channel request was successful - - - - - Called when channel request failed. - - - - - Sends the channel open message. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Gets the type of the channel. - - - The type of the channel. - - - - - Lists channel types as defined by the protocol. - - - - - session - - - - - x11 - - - - - forwarded-tcpip - - - - - direct-tcpip - - - - - Holds information about key size and cipher to use - - - - - Initializes a new instance of the class. - - Size of the key. - The cipher. - - - - Gets the size of the key. - - - The size of the key. - - - - - Gets the cipher. - - - - - Implementation of ASCII Encoding - - - - - Initializes a new instance of the class. - - - - - Calculates the number of bytes produced by encoding a set of characters from the specified character array. - - The character array containing the set of characters to encode. - The index of the first character to encode. - The number of characters to encode. - - The number of bytes produced by encoding the specified characters. - - - is null. - - - or is less than zero.-or- and do not denote a valid range in . - - A fallback occurred (see Understanding Encodings for complete explanation)-and- is set to . - - - - Encodes a set of characters from the specified character array into the specified byte array. - - The character array containing the set of characters to encode. - The index of the first character to encode. - The number of characters to encode. - The byte array to contain the resulting sequence of bytes. - The index at which to start writing the resulting sequence of bytes. - - The actual number of bytes written into . - - - is null.-or- is null. - - - or or is less than zero.-or- and do not denote a valid range in .-or- is not a valid index in . - - - does not have enough capacity from to the end of the array to accommodate the resulting bytes. - - A fallback occurred (see Understanding Encodings for complete explanation)-and- is set to . - - - - Calculates the number of characters produced by decoding a sequence of bytes from the specified byte array. - - The byte array containing the sequence of bytes to decode. - The index of the first byte to decode. - The number of bytes to decode. - - The number of characters produced by decoding the specified sequence of bytes. - - - is null. - - - or is less than zero.-or- and do not denote a valid range in . - - A fallback occurred (see Understanding Encodings for complete explanation)-and- is set to . - - - - Decodes a sequence of bytes from the specified byte array into the specified character array. - - The byte array containing the sequence of bytes to decode. - The index of the first byte to decode. - The number of bytes to decode. - The character array to contain the resulting set of characters. - The index at which to start writing the resulting set of characters. - - The actual number of characters written into . - - - is null.-or- is null. - - - or or is less than zero.-or- and do not denote a valid range in .-or- is not a valid index in . - - - does not have enough capacity from to the end of the array to accommodate the resulting characters. - - A fallback occurred (see Understanding Encodings for complete explanation)-and- is set to . - - - - Calculates the maximum number of bytes produced by encoding the specified number of characters. - - The number of characters to encode. - - The maximum number of bytes produced by encoding the specified number of characters. - - - is less than zero. - - A fallback occurred (see Understanding Encodings for complete explanation)-and- is set to . - - - - Calculates the maximum number of characters produced by decoding the specified number of bytes. - - The number of bytes to decode. - - The maximum number of characters produced by decoding the specified number of bytes. - - - is less than zero. - - A fallback occurred (see Understanding Encodings for complete explanation)-and- is set to . - - - - Base class to encapsulates the results of an asynchronous operation. - - - - - Initializes a new instance of the class. - - The async callback. - The state. - - - - Marks asynchronous operation as completed. - - The exception. - if set to true [completed synchronously]. - - - - Waits until the asynchronous operation completes, and then returns. - - - - - Gets or sets a value indicating whether EndInvoke has been called on the current AsyncResult. - - - true if EndInvoke has been called on the current AsyncResult; otherwise, false. - - - - - Gets a user-defined object that qualifies or contains information about an asynchronous operation. - - A user-defined object that qualifies or contains information about an asynchronous operation. - - - - Gets a value that indicates whether the asynchronous operation completed synchronously. - - true if the asynchronous operation completed synchronously; otherwise, false. - - - - Gets a that is used to wait for an asynchronous operation to complete. - - A that is used to wait for an asynchronous operation to complete. - - - - Gets a value that indicates whether the asynchronous operation has completed. - - true if the operation is complete; otherwise, false. - - - - Base class to encapsulates the results of an asynchronous operation that returns result. - - The type of the result. - - - - Initializes a new instance of the class. - - The async callback. - The state. - - - - Marks asynchronous operation as completed. - - The result. - if set to true [completed synchronously]. - - - - Waits until the asynchronous operation completes, and then returns the value generated by the asynchronous operation. - - Invocation result - - - - Provides data for event. - - - - - Base class for authentication events. - - - - - Initializes a new instance of the class. - - The username. - - - - Gets the username. - - - - - Initializes a new instance of the class. - - The username. - Banner message. - Banner language. - - - - Gets banner message. - - - - - Gets banner language. - - - - - Provides data for event. - - - - - Initializes a new instance of the class. - - The username. - - - - Gets or sets the new password. - - - The new password. - - - - - Provides prompt information when is raised - - - - - Initializes a new instance of the class. - - The sequence id. - if set to true the user input should be echoed. - The request. - - - - Gets the prompt sequence id. - - - - - Gets or sets a value indicating whether the user input should be echoed as characters are typed. - - - true if the user input should be echoed as characters are typed; otherwise, false. - - - - - Gets server information request. - - - - - Gets or sets server information response. - - - The response. - - - - - Provides data for event. - - - - - Initializes a new instance of the class. - - The username. - The instruction. - The language. - The information request prompts. - - - - Gets prompt language. - - - - - Gets prompt instruction. - - - - - Gets server information request prompts. - - - - - Represents an arbitrarily large signed integer. - - - - - Initializes a new instance of the struct. - - The sign. - The data. - - - - Initializes a new instance of the struct. - - The value. - - - - Initializes a new instance of the struct. - - The value. - - - - Initializes a new instance of the struct. - - The value. - - - - Initializes a new instance of the struct. - - The value. - - - - Initializes a new instance of the struct. - - The value. - - - - Initializes a new instance of the struct. - - The value. - - - - Initializes a new instance of the struct. - - The value. - - - - Initializes a new instance of the struct. - - The value. - - - - Defines an explicit conversion of a System.Numerics.BigInteger object to a 32-bit signed integer value. - - The value to convert to a 32-bit signed integer. - - An object that contains the value of the value parameter. - - - - - Defines an explicit conversion of a System.Numerics.BigInteger object to an unsigned 32-bit integer value. - - The value to convert to an unsigned 32-bit integer. - - An object that contains the value of the value parameter. - - - - - Defines an explicit conversion of a System.Numerics.BigInteger object to a 16-bit signed integer value. - - The value to convert to a 16-bit signed integer. - - An object that contains the value of the value parameter. - - - - - Defines an explicit conversion of a System.Numerics.BigInteger object to an unsigned 16-bit integer value. - - The value to convert to an unsigned 16-bit integer. - - An object that contains the value of the value parameter - - - - - Defines an explicit conversion of a System.Numerics.BigInteger object to an unsigned byte value. - - The value to convert to a System.Byte. - - An object that contains the value of the value parameter. - - - - - Defines an explicit conversion of a System.Numerics.BigInteger object to a signed 8-bit value. - - The value to convert to a signed 8-bit value. - - An object that contains the value of the value parameter. - - - - - Defines an explicit conversion of a System.Numerics.BigInteger object to a 64-bit signed integer value. - - The value to convert to a 64-bit signed integer. - - An object that contains the value of the value parameter. - - - - - Defines an explicit conversion of a System.Numerics.BigInteger object to an unsigned 64-bit integer value. - - The value to convert to an unsigned 64-bit integer. - - An object that contains the value of the value parameter. - - - - - Defines an explicit conversion of a System.Numerics.BigInteger object to a value. - - The value to convert to a . - - An object that contains the value of the value parameter. - - - - - Defines an explicit conversion of a System.Numerics.BigInteger object to a single-precision floating-point value. - - The value to convert to a single-precision floating-point value. - - An object that contains the closest possible representation of the value parameter. - - - - - Defines an explicit conversion of a System.Numerics.BigInteger object to a value. - - The value to convert to a . - - An object that contains the value of the value parameter. - - - - - Defines an implicit conversion of a signed 32-bit integer to a System.Numerics.BigInteger value. - - The value to convert to a System.Numerics.BigInteger. - - An object that contains the value of the value parameter. - - - - - Defines an implicit conversion of a 32-bit unsigned integer to a System.Numerics.BigInteger value. - - The value to convert to a System.Numerics.BigInteger. - - An object that contains the value of the value parameter. - - - - - Defines an implicit conversion of a signed 16-bit integer to a System.Numerics.BigInteger value. - - The value to convert to a System.Numerics.BigInteger. - - An object that contains the value of the value parameter. - - - - - Defines an implicit conversion of a 16-bit unsigned integer to a System.Numerics.BigInteger value. - - The value to convert to a System.Numerics.BigInteger. - - An object that contains the value of the value parameter. - - - - - Defines an implicit conversion of an unsigned byte to a System.Numerics.BigInteger value. - - The value to convert to a System.Numerics.BigInteger. - - An object that contains the value of the value parameter. - - - - - Defines an implicit conversion of an 8-bit signed integer to a System.Numerics.BigInteger value. - - The value to convert to a System.Numerics.BigInteger. - - An object that contains the value of the value parameter. - - - - - Defines an implicit conversion of a signed 64-bit integer to a System.Numerics.BigInteger value. - - The value to convert to a System.Numerics.BigInteger. - - An object that contains the value of the value parameter. - - - - - Defines an implicit conversion of a 64-bit unsigned integer to a System.Numerics.BigInteger value. - - The value to convert to a System.Numerics.BigInteger. - - An object that contains the value of the value parameter. - - - - - Defines an explicit conversion of a value to a System.Numerics.BigInteger value. - - The value to convert to a System.Numerics.BigInteger. - - An object that contains the value of the value parameter. - - - - - Defines an explicit conversion of a object to a System.Numerics.BigInteger value. - - The value to convert to a System.Numerics.BigInteger. - - An object that contains the value of the value parameter. - - - - - Defines an explicit conversion of a object to a System.Numerics.BigInteger value. - - The value to convert to a System.Numerics.BigInteger. - - An object that contains the value of the value parameter. - - - - - Adds the values of two specified objects. - - The first value to add. - The second value to add. - - The sum of left and right. - - - - - Subtracts a value from another value. - - The value to subtract from (the minuend). - The value to subtract (the subtrahend). - - The result of subtracting right from left. - - - - - Multiplies two specified values. - - The first value to multiply. - The second value to multiply. - - The product of left and right. - - - - - Divides a specified value by another specified value by using integer division. - - The value to be divided. - The value to divide by. - - The integral result of the division. - - - - - Returns the remainder that results from division with two specified values. - - The value to be divided. - The value to divide by. - - The remainder that results from the division. - - - - - Negates a specified BigInteger value. - - The value to negate. - - The result of the value parameter multiplied by negative one (-1). - - - - - Returns the value of the operand. (The sign of the operand is unchanged.) - - An integer value. - - The value of the value operand. - - - - - Increments a value by 1. - - The value to increment. - - The value of the value parameter incremented by 1. - - - - - Decrements a value by 1. - - The value to decrement. - - The value of the value parameter decremented by 1. - - - - - Performs a bitwise And operation on two values. - - The first value. - The second value. - - The result of the bitwise And operation. - - - - - Performs a bitwise Or operation on two values. - - The first value. - The second value. - - The result of the bitwise Or operation. - - - - - Performs a bitwise exclusive Or (XOr) operation on two values. - - The first value. - The second value. - - The result of the bitwise Or operation. - - - - - Returns the bitwise one's complement of a value. - - An integer value. - - The bitwise one's complement of value. - - - - - Shifts a value a specified number of bits to the left. - - The value whose bits are to be shifted. - The number of bits to shift value to the left. - - A value that has been shifted to the left by the specified number of bits. - - - - - Shifts a System.Numerics.BigInteger value a specified number of bits to the right. - - The value whose bits are to be shifted. - The number of bits to shift value to the right. - - A value that has been shifted to the right by the specified number of bits. - - - - - Returns a value that indicates whether a value is less than another value. - - The first value to compare. - The second value to compare. - - true if left is less than right; otherwise, false. - - - - - Returns a value that indicates whether a value is less than a 64-bit signed integer. - - The first value to compare. - The second value to compare. - - true if left is less than right; otherwise, false. - - - - - Returns a value that indicates whether a 64-bit signed integer is less than a value. - - The first value to compare. - The second value to compare. - - true if left is less than right; otherwise, false. - - - - - Returns a value that indicates whether a value is less than a 64-bit unsigned integer. - - The first value to compare. - The second value to compare. - - true if left is less than right; otherwise, false. - - - - - Returns a value that indicates whether a 64-bit unsigned integer is less than a value. - - The first value to compare. - The second value to compare. - - true if left is less than right; otherwise, false. - - - - - Returns a value that indicates whether a System.Numerics.BigInteger value is less than or equal to another System.Numerics.BigInteger value. - - The first value to compare. - The second value to compare. - - true if left is less than or equal to right; otherwise, false. - - - - - Returns a value that indicates whether a System.Numerics.BigInteger value is less than or equal to a 64-bit signed integer. - - The first value to compare. - The second value to compare. - - true if left is less than or equal to right; otherwise, false. - - - - - Returns a value that indicates whether a 64-bit signed integer is less than or equal to a System.Numerics.BigInteger value. - - The first value to compare. - The second value to compare. - - true if left is less than or equal to right; otherwise, false. - - - - - Returns a value that indicates whether a System.Numerics.BigInteger value is less than or equal to a 64-bit unsigned integer. - - The first value to compare. - The second value to compare. - - true if left is less than or equal to right; otherwise, false. - - - - - Returns a value that indicates whether a 64-bit unsigned integer is less than or equal to a System.Numerics.BigInteger value. - - The first value to compare. - The second value to compare. - - true if left is less than or equal to right; otherwise, false. - - - - - Returns a value that indicates whether a System.Numerics.BigInteger value is greater than another System.Numerics.BigInteger value. - - The first value to compare. - The second value to compare. - - true if left is greater than right; otherwise, false. - - - - - Returns a value that indicates whether a System.Numerics.BigInteger is greater than a 64-bit signed integer value. - - The first value to compare. - The second value to compare. - - true if left is greater than right; otherwise, false. - - - - - Returns a value that indicates whether a 64-bit signed integer is greater than a System.Numerics.BigInteger value. - - The first value to compare. - The second value to compare. - - true if left is greater than right; otherwise, false. - - - - - Returns a value that indicates whether a System.Numerics.BigInteger value is greater than a 64-bit unsigned integer. - - The first value to compare. - The second value to compare. - - true if left is greater than right; otherwise, false. - - - - - Returns a value that indicates whether a System.Numerics.BigInteger value is greater than a 64-bit unsigned integer. - - The first value to compare. - The second value to compare. - - true if left is greater than right; otherwise, false. - - - - - Returns a value that indicates whether a System.Numerics.BigInteger value is greater than or equal to another System.Numerics.BigInteger value. - - The first value to compare. - The second value to compare. - - true if left is greater than or equal right; otherwise, false. - - - - - Returns a value that indicates whether a System.Numerics.BigInteger value is greater than or equal to a 64-bit signed integer value. - - The first value to compare. - The second value to compare. - - true if left is greater than or equal right; otherwise, false. - - - - - Returns a value that indicates whether a 64-bit signed integer is greater than or equal to a System.Numerics.BigInteger value. - - The first value to compare. - The second value to compare. - - true if left is greater than or equal right; otherwise, false. - - - - - Returns a value that indicates whether a System.Numerics.BigInteger value is greater than or equal to a 64-bit unsigned integer value. - - The first value to compare. - The second value to compare. - - true if left is greater than or equal right; otherwise, false. - - - - - Returns a value that indicates whether a 64-bit unsigned integer is greater than or equal to a System.Numerics.BigInteger value. - - The first value to compare. - The second value to compare. - - true if left is greater than or equal right; otherwise, false. - - - - - Returns a value that indicates whether the values of two System.Numerics.BigInteger objects are equal. - - The first value to compare. - The second value to compare. - - true if the left and right parameters have the same value; otherwise, false. - - - - - Returns a value that indicates whether a System.Numerics.BigInteger value and a signed long integer value are equal. - - The first value to compare. - The second value to compare. - - true if the left and right parameters have the same value; otherwise, false. - - - - - Returns a value that indicates whether a signed long integer value and a System.Numerics.BigInteger value are equal. - - The first value to compare. - The second value to compare. - - true if the left and right parameters have the same value; otherwise, false. - - - - - Returns a value that indicates whether a System.Numerics.BigInteger value and an unsigned long integer value are equal. - - The first value to compare. - The second value to compare. - - true if the left and right parameters have the same value; otherwise, false. - - - - - Returns a value that indicates whether an unsigned long integer value and a System.Numerics.BigInteger value are equal. - - The first value to compare. - The second value to compare. - - true if the left and right parameters have the same value; otherwise, false. - - - - - Returns a value that indicates whether two objects have different values. - - The first value to compare. - The second value to compare. - - true if left and right are not equal; otherwise, false. - - - - - Returns a value that indicates whether a value and a 64-bit signed integer are not equal. - - The first value to compare. - The second value to compare. - - true if left and right are not equal; otherwise, false. - - - - - Returns a value that indicates whether a 64-bit signed integer and a value are not equal. - - The first value to compare. - The second value to compare. - - true if left and right are not equal; otherwise, false. - - - - - Returns a value that indicates whether a value and a 64-bit unsigned integer are not equal. - - The first value to compare. - The second value to compare. - - true if left and right are not equal; otherwise, false. - - - - - Returns a value that indicates whether a 64-bit unsigned integer and a value are not equal. - - The first value to compare. - The second value to compare. - - true if left and right are not equal; otherwise, false. - - - - - Gets the absolute value of a System.Numerics.BigInteger object. - - A number. - The absolute value of value. - - - - Adds two System.Numerics.BigInteger values and returns the result. - - The first value to add. - The second value to add. - The sum of left and right. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - - A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance is less than . Zero This instance is equal to . Greater than zero This instance is greater than . - - - is not the same type as this instance. - - - - Compares this instance to a second System.Numerics.BigInteger and returns - an integer that indicates whether the value of this instance is less than, - equal to, or greater than the value of the specified object. - - The object to compare. - - A signed integer value that indicates the relationship of this instance to - other, as shown in the following table.Return valueDescriptionLess than zeroThe - current instance is less than other.ZeroThe current instance equals other.Greater - than zeroThe current instance is greater than other. - - - - - Compares this instance to an unsigned 64-bit integer and returns an integer - that indicates whether the value of this instance is less than, equal to, - or greater than the value of the unsigned 64-bit integer. - - The unsigned 64-bit integer to compare. - A signed integer that indicates the relative value of this instance and other, - as shown in the following table.Return valueDescriptionLess than zeroThe - current instance is less than other.ZeroThe current instance equals other.Greater - than zeroThe current instance is greater than other. - - - - Generates random BigInteger number - - Length of random number in bits. - Big random number. - - - - Divides one System.Numerics.BigInteger value by another and returns the result. - - The value to be divided. - The value to divide by. - The quotient of the division. - - - - Divides one System.Numerics.BigInteger value by another, returns the result, and returns the remainder in an output parameter. - - The value to be divided. - The value to divide by. - When this method returns, contains a System.Numerics.BigInteger value that - represents the remainder from the division. This parameter is passed uninitialized. - The quotient of the division. - - - - Returns a value that indicates whether the current instance and a specified System.Numerics.BigInteger object have the same value. - - The object to compare. - - true if this System.Numerics.BigInteger object and other have the same value; otherwise, false. - - - - - Returns a value that indicates whether the current instance and a signed 64-bit integer have the same value. - - The signed 64-bit integer value to compare. - true if the signed 64-bit integer and the current instance have the same value; otherwise, false. - - - - Returns a value that indicates whether the current instance and a specified object have the same value. - - The object to compare. - - true if the obj parameter is a System.Numerics.BigInteger object or a type - capable of implicit conversion to a System.Numerics.BigInteger value, and - its value is equal to the value of the current System.Numerics.BigInteger - object; otherwise, false. - - - - - Returns a value that indicates whether the current instance and an unsigned 64-bit integer have the same value. - - The unsigned 64-bit integer to compare. - true if the current instance and the unsigned 64-bit integer have the same value; otherwise, false. - - - - Returns the hash code for the current System.Numerics.BigInteger object. - - - A 32-bit signed integer hash code. - - - - - Finds the greatest common divisor of two System.Numerics.BigInteger values. - - The first value. - The second value. - The greatest common divisor of left and right. - - - - Returns the logarithm of a specified number in a specified base. - - A number whose logarithm is to be found. - The base of the logarithm. - The base baseValue logarithm of value, as shown in the table in the Remarks section. - - - - Returns the natural (base e) logarithm of a specified number. - - The number whose logarithm is to be found. - The natural (base e) logarithm of value, as shown in the table in the Remarks section. - - - - Returns the base 10 logarithm of a specified number. - - A number whose logarithm is to be found. - The base 10 logarithm of value, as shown in the table in the Remarks section. - - - - Returns the larger of two System.Numerics.BigInteger values. - - The first value to compare. - The second value to compare. - The left or right parameter, whichever is larger. - - - - Returns the smaller of two System.Numerics.BigInteger values. - - The first value to compare. - The second value to compare. - The left or right parameter, whichever is smaller. - - - - Performs modulus division on a number raised to the power of another number. - - The number to raise to the exponent power. - The exponent to raise value by. - The value to divide valueexponent by. - The remainder after dividing valueexponent by modulus. - - - - Mods the inverse. - - The bi. - The modulus. - Modulus inverted number. - - - - Returns positive remainder that results from division with two specified values. - - The value to be divided. - The value to divide by. - - Positive remainder that results from the division. - - - - - Returns the product of two System.Numerics.BigInteger values. - - The first number to multiply. - The second number to multiply. - The product of the left and right parameters. - - - - Negates a specified System.Numerics.BigInteger value. - - The value to negate. - The result of the value parameter multiplied by negative one (-1). - - - - Converts the string representation of a number in a specified style and culture-specific format to its equivalent. - - A string that contains a number to convert. - A bitwise combination of the enumeration values that specify the permitted format of value. - An object that provides culture-specific formatting information about value. - Parsed number - - - - Converts the string representation of a number in a specified culture-specific format to its System.Numerics.BigInteger equivalent. - - A string that contains a number to convert. - An object that provides culture-specific formatting information about value. - A value that is equivalent to the number specified in the value parameter. - - - - Converts the string representation of a number in a specified style to its System.Numerics.BigInteger equivalent. - - A string that contains a number to convert. - A bitwise combination of the enumeration values that specify the permitted format of value. - A value that is equivalent to the number specified in the value parameter. - - - - Raises a System.Numerics.BigInteger value to the power of a specified value. - - The number to raise to the exponent power. - The exponent to raise value by. - The result of raising value to the exponent power. - - - - Performs integer division on two System.Numerics.BigInteger values and returns the remainder. - - The value to be divided. - The value to divide by. - The remainder after dividing dividend by divisor. - - - - Subtracts one System.Numerics.BigInteger value from another and returns the result. - - The value to subtract from (the minuend). - The value to subtract (the subtrahend). - The result of subtracting right from left. - - - - Converts a System.Numerics.BigInteger value to a byte array. - - The value of the current System.Numerics.BigInteger object converted to an array of bytes. - - - - Converts the numeric value of the current System.Numerics.BigInteger object to its equivalent string representation. - - - The string representation of the current System.Numerics.BigInteger value. - - - - - Converts the numeric value of the current System.Numerics.BigInteger object - to its equivalent string representation by using the specified culture-specific - formatting information. - - An object that supplies culture-specific formatting information. - - The string representation of the current System.Numerics.BigInteger value - in the format specified by the provider parameter. - - - - - Converts the numeric value of the current System.Numerics.BigInteger object - to its equivalent string representation by using the specified format. - - A standard or custom numeric format string. - - The string representation of the current System.Numerics.BigInteger value - in the format specified by the format parameter. - - - - - Converts the numeric value of the current System.Numerics.BigInteger object - to its equivalent string representation by using the specified format and - culture-specific format information. - - A standard or custom numeric format string. - An object that supplies culture-specific formatting information. - - The string representation of the current System.Numerics.BigInteger value - as specified by the format and provider parameters. - - - - - Tries to convert the string representation of a number in a specified style - and culture-specific format to its System.Numerics.BigInteger equivalent, - and returns a value that indicates whether the conversion succeeded. - - The string representation of a number. The string is interpreted using the style specified by style. - A bitwise combination of enumeration values that indicates the style elements - that can be present in value. A typical value to specify is System.Globalization.NumberStyles.Integer. - An object that supplies culture-specific formatting information about value. - When this method returns, contains the System.Numerics.BigInteger equivalent - to the number that is contained in value, or System.Numerics.BigInteger.Zero - if the conversion failed. The conversion fails if the value parameter is - null or is not in a format that is compliant with style. This parameter is - passed uninitialized. - true if the value parameter was converted successfully; otherwise, false. - - - - Tries to convert the string representation of a number to its System.Numerics.BigInteger - equivalent, and returns a value that indicates whether the conversion succeeded. - - The string representation of a number. - When this method returns, contains the System.Numerics.BigInteger equivalent - to the number that is contained in value, or zero (0) if the conversion fails. - The conversion fails if the value parameter is null or is not of the correct - format. This parameter is passed uninitialized. - true if value was converted successfully; otherwise, false. - - - - Compares this instance to a signed 64-bit integer and returns an integer - that indicates whether the value of this instance is less than, equal to, - or greater than the value of the signed 64-bit integer. - - The signed 64-bit integer to compare. - A signed integer value that indicates the relationship of this instance to - other, as shown in the following table.Return valueDescriptionLess than zeroThe - current instance is less than other.ZeroThe current instance equals other.Greater - than zero.The current instance is greater than other. - - - - Compares two System.Numerics.BigInteger values and returns an integer that - indicates whether the first value is less than, equal to, or greater than the second value. - - The first value to compare. - The second value to compare. - A signed integer that indicates the relative values of left and right, - as shown in the following table.ValueConditionLess than zeroleft is less than right.Zeroleft - equals right.Greater than zeroleft is greater than right. - - - - Populations the count. - - The x. - Returns the number of bits set in x - - - - Returns the 0-based index of the most significant set bit - - The word. - 0 if no bit is set - - - - Gets number of bits used by the number. - - - The number of the bit used. - - - - - Indicates whether the value of the current System.Numerics.BigInteger object is an even number. - - - true if the value of the System.Numerics.BigInteger object is an even number; otherwise, false. - - - - - Indicates whether the value of the current System.Numerics.BigInteger object is System.Numerics.BigInteger.One. - - - true if the value of the System.Numerics.BigInteger object is System.Numerics.BigInteger.One; otherwise, false. - - - - - Indicates whether the value of the current System.Numerics.BigInteger object is a power of two. - - - true if the value of the System.Numerics.BigInteger object is a power of two; otherwise, false. - - - - - Indicates whether the value of the current System.Numerics.BigInteger object is System.Numerics.BigInteger.Zero. - - - true if the value of the System.Numerics.BigInteger object is System.Numerics.BigInteger.Zero; otherwise, false. - - - - - Gets a value that represents the number negative one (-1). - - - - - Gets a value that represents the number one (1). - - - - - Gets a number that indicates the sign (negative, positive, or zero) of the current System.Numerics.BigInteger object. - - - - - Gets a value that represents the number 0 (zero). - - - - - Provides data for event and events. - - - - - Base class for all channel related events. - - - - - Initializes a new instance of the class. - - The channel number. - - - - Gets the channel number. - - - - - Initializes a new instance of the class. - - Channel number. - Channel data. - - - - Initializes a new instance of the class. - - Channel number. - Channel data. - Channel data type code. - - - - Gets channel data. - - - - - Gets the data type code. - - - - - Provides data for event. - - - - - Initializes a new instance of the class. - - Channel number. - Failure reason code. - Failure description. - Failure language. - - - - Gets failure reason code. - - - - - Gets failure description. - - - - - Gets failure language. - - - - - Provides data for event. - - - - - Initializes a new instance of the class. - - Request information. - - - - Gets request information. - - - - - Collection of different extension method specific for .NET 4.0 - - - Collection of different extension method - - - - - Determines whether [is null or white space] [the specified value]. - - The value. - - true if [is null or white space] [the specified value]; otherwise, false. - - - - - Checks whether a collection is the same as another collection - - The current instance object - The collection to compare with - The comparer object to use to compare each item in the collection. If null uses EqualityComparer(T).Default - True if the two collections contain all the same items in the same order - - - - Checks whether a collection is the same as another collection - - The current instance object - The collection to compare with - True if the two collections contain all the same items in the same order - - - - Prints out - - The bytes. - - - - Trims the leading zero from bytes array. - - The data. - Data without leading zeros. - - - - Creates an instance of the specified type using that type's default constructor. - - The type to create. - Type of the instance to create. - A reference to the newly created object. - - - - Returns the specified 16-bit unsigned integer value as an array of bytes. - - The number to convert. - An array of bytes with length 2. - - - - Returns the specified 32-bit unsigned integer value as an array of bytes. - - The number to convert. - An array of bytes with length 4. - - - - Returns the specified 64-bit unsigned integer value as an array of bytes. - - The number to convert. - An array of bytes with length 8. - - - - Returns the specified 64-bit signed integer value as an array of bytes. - - The number to convert. - An array of bytes with length 8. - - - - The exception that is thrown when SCP error occurred. - - - - - The exception that is thrown when SSH exception occurs. - - - The exception that is thrown when SSH exception occurs. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - The message. - The inner. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - - The class name is null or is zero (0). - - - - When overridden in a derived class, sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is a null reference (Nothing in Visual Basic). - - - - - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - The message. - The inner exception. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - - The class name is null or is zero (0). - - - - Provides data for the HostKeyReceived event. - - - - - Initializes a new instance of the class. - - The host. - - - - Gets or sets a value indicating whether host key can be trusted. - - - true if host key can be trusted; otherwise, false. - - - - - Gets the host key. - - - - - Gets the host key name. - - - - - Gets the finger print. - - - - - Gets the length of the key in bits. - - - The length of the key in bits. - - - - - The exception that is thrown when there is something wrong with the server capabilities. - - - The exception that is thrown when there is something wrong with the server capabilities. - - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - - The class name is null or is zero (0). - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - The message. - The inner exception. - - - - Base class for DER encoded data. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - DER encoded data. - - - - Encodes written data as DER byte array. - - DER Encoded array. - - - - Reads next mpint data type from internal buffer. - - mpint read. - - - - Reads next int data type from internal buffer. - - int read. - - - - Writes BOOLEAN data into internal buffer. - - UInt32 data to write. - - - - Writes UInt32 data into internal buffer. - - UInt32 data to write. - - - - Writes INTEGER data into internal buffer. - - BigInteger data to write. - - - - Writes OCTETSTRING data into internal buffer. - - The data. - - - - Writes OBJECTIDENTIFIER data into internal buffer. - - The identifier. - - - - Writes NULL data into internal buffer. - - - - - Writes DerData data into internal buffer. - - DerData data to write. - - - - Gets a value indicating whether end of data is reached. - - - true if end of data is reached; otherwise, false. - - - - - Provides data for the ErrorOccured events. - - - - - Initializes a new instance of the class. - - An System.Exception that represents the error that occurred. - - - - Gets the System.Exception that represents the error that occurred. - - - - - Describes object identifier for DER encoding - - - - - Initializes a new instance of the class. - - The identifiers. - - - - Gets the object identifier. - - - - - PipeStream is a thread-safe read/write data stream for use between two threads in a - single-producer/single-consumer type problem. - - 2006/10/13 1.0 - Update on 2008/10/9 1.1 - uses Monitor instead of Manual Reset events for more elegant synchronicity. - - Copyright (c) 2006 James Kolpack (james dot kolpack at google mail) - - Permission is hereby granted, free of charge, to any person obtaining a copy of this software and - associated documentation files (the "Software"), to deal in the Software without restriction, - including without limitation the rights to use, copy, modify, merge, publish, distribute, - sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is - furnished to do so, subject to the following conditions: - - The above copyright notice and this permission notice shall be included in all copies or - substantial portions of the Software. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, - INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR - PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE - LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT - OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR - OTHER DEALINGS IN THE SOFTWARE. - - - - - Queue of bytes provides the datastructure for transmitting from an - input stream to an output stream. - - Possible more effecient ways to accomplish this. - - - - Indicates that the input stream has been flushed and that - all remaining data should be written to the output stream. - - - - - Maximum number of bytes to store in the buffer. - - - - - Setting this to true will cause Read() to block if it appears - that it will run out of data. - - - - - When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device. - - - An I/O error occurs. 2 - - - - When overridden in a derived class, sets the position within the current stream. - - - The new position within the current stream. - - A byte offset relative to the origin parameter. - A value of type indicating the reference point used to obtain the new position. - An I/O error occurs. - The stream does not support seeking, such as if the stream is constructed from a pipe or console output. - Methods were called after the stream was closed. 1 - - - - When overridden in a derived class, sets the length of the current stream. - - The desired length of the current stream in bytes. - The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output. - An I/O error occurs. - Methods were called after the stream was closed. 2 - - - - When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. - - - The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached. - - The zero-based byte offset in buffer at which to begin storing the data read from the current stream. - The maximum number of bytes to be read from the current stream. - An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source. - The sum of offset and count is larger than the buffer length. - Methods were called after the stream was closed. - The stream does not support reading. - buffer is null. - An I/O error occurs. - offset or count is negative. 1 - - - - Returns true if there are - - The count. - True if data available; otherwisefalse. - - - - When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. - - The zero-based byte offset in buffer at which to begin copying bytes to the current stream. - The number of bytes to be written to the current stream. - An array of bytes. This method copies count bytes from buffer to the current stream. - An I/O error occurs. - The stream does not support writing. - Methods were called after the stream was closed. - buffer is null. - The sum of offset and count is greater than the buffer length. - offset or count is negative. 1 - - - - Gets or sets the maximum number of bytes to store in the buffer. - - The length of the max buffer. - - - - Gets or sets a value indicating whether to block last read method before the buffer is empty. - When true, Read() will block until it can fill the passed in buffer and count. - When false, Read() will not block, returning all the available buffer data. - - - Setting to true will remove the possibility of ending a stream reader prematurely. - - - true if block last read method before the buffer is empty; otherwise, false. - - - - - When overridden in a derived class, gets a value indicating whether the current stream supports reading. - - - true if the stream supports reading; otherwise, false. - - 1 - - - - When overridden in a derived class, gets a value indicating whether the current stream supports seeking. - - - true if the stream supports seeking; otherwise, false. - - 1 - - - - When overridden in a derived class, gets a value indicating whether the current stream supports writing. - - - true if the stream supports writing; otherwise, false. - - 1 - - - - When overridden in a derived class, gets the length in bytes of the stream. - - - A long value representing the length of the stream in bytes. - - - A class derived from Stream does not support seeking. - Methods were called after the stream was closed. 1 - - - - When overridden in a derived class, gets or sets the position within the current stream. - - - The current position within the stream. - - An I/O error occurs. - The stream does not support seeking. - Methods were called after the stream was closed. 1 - - - - Provides data for event. - - - - - Initializes a new instance of the class. - - The host. - The port. - - - - Gets request originator host. - - - - - Gets request originator port. - - - - - Provides data for the Downloading event. - - - - - Initializes a new instance of the class. - - The downloaded filename. - The downloaded file size. - The number of downloaded bytes so far. - - - - Gets the downloaded filename. - - - - - Gets the downloaded file size. - - - - - Gets number of downloaded bytes so far. - - - - - The exception that is thrown when SCP error occurred. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - The message. - The inner exception. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - - The class name is null or is zero (0). - - - - Provides data for the Uploading event. - - - - - Initializes a new instance of the class. - - The uploaded filename. - The the uploaded file size. - The number of uploaded bytes so far. - - - - Gets the uploaded filename. - - - - - Gets the uploaded file size. - - - - - Gets number of uploaded bytes so far. - - - - - Light implementation of SemaphoreSlim. - - - - - Initializes a new instance of the class, specifying - the initial number of requests that can be granted concurrently. - - The initial number of requests for the semaphore that can be granted concurrently. - is a negative number. - - - - Exits the once. - - The previous count of the . - - - - Exits the a specified number of times. - - The number of times to exit the semaphore. - The previous count of the . - - - - Blocks the current thread until it can enter the . - - - - - Gets the current count of the . - - - - - The exception that is thrown when file or directory is not found. - - - The exception that is thrown when file or directory is not found. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - The message. - The inner exception. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - - The class name is null or is zero (0). - - - - The exception that is thrown when operation permission is denied. - - - The exception that is thrown when operation permission is denied. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - The message. - The inner exception. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - - The class name is null or is zero (0). - - - - Provides data for Shell DataReceived event - - - - - Initializes a new instance of the class. - - The data. - - - - Initializes a new instance of the class. - - The line. - - - - Gets the data. - - - - - Gets the line data. - - - - - The exception that is thrown when authentication failed. - - - The exception that is thrown when authentication failed. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - The message. - The inner exception. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - - The class name is null or is zero (0). - - - - The exception that is thrown when connection was terminated. - - - The exception that is thrown when connection was terminated. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - The message. - The disconnect reason code. - - - - Initializes a new instance of the class. - - The message. - The disconnect reason code. - The inner. - - - - Initializes a new instance of the class. - - The message. - The inner exception. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - - The class name is null or is zero (0). - - - - Gets the object data. - - The info. - The context. - - - - Gets the disconnect reason if provided by the server or client. Otherwise None. - - - - - Base ssh data serialization type - - - - - Data byte array that hold message unencrypted data - - - - - Gets data bytes array - - Byte array representation of data structure. - - - - Loads data from specified bytes. - - Bytes array. - is null. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Loads data bytes into internal buffer. - - The bytes. - is null. - - - - Resets internal data reader index. - - - - - Reads all data left in internal buffer at current position. - - An array of bytes containing the remaining data in the internal buffer. - - - - Reads next specified number of bytes data type from internal buffer. - - Number of bytes to read. - An array of bytes that was read from the internal buffer. - is greater than the internal buffer size. - - - - Reads next byte data type from internal buffer. - - Byte read. - - - - Reads next boolean data type from internal buffer. - - Boolean read. - - - - Reads next uint16 data type from internal buffer. - - uint16 read - - - - Reads next uint32 data type from internal buffer. - - uint32 read - - - - Reads next uint64 data type from internal buffer. - - uint64 read - - - - Reads next int64 data type from internal buffer. - - int64 read - - - - Reads next string data type from internal buffer. - - string read - - - - Reads next string data type from internal buffer. - - string read - - - - Reads next string data type from internal buffer. - - string read - - - - Reads next string data type from internal buffer. - - string read - - - - Reads next mpint data type from internal buffer. - - mpint read. - - - - Reads next name-list data type from internal buffer. - - String array or read data.. - - - - Reads next extension-pair data type from internal buffer. - - Extensions pair dictionary. - - - - Writes bytes array data into internal buffer. - - Byte array data to write. - is null. - - - - Writes byte data into internal buffer. - - Byte data to write. - - - - Writes boolean data into internal buffer. - - Boolean data to write. - - - - Writes uint16 data into internal buffer. - - uint16 data to write. - - - - Writes uint32 data into internal buffer. - - uint32 data to write. - - - - Writes uint64 data into internal buffer. - - uint64 data to write. - - - - Writes int64 data into internal buffer. - - int64 data to write. - - - - Writes string data into internal buffer as ASCII. - - string data to write. - - - - Writes string data into internal buffer using default encoding. - - string data to write. - is null. - - - - Writes string data into internal buffer. - - string data to write. - is null. - - - - Writes mpint data into internal buffer. - - mpint data to write. - - - - Writes name-list data into internal buffer. - - name-list data to write. - - - - Writes extension-pair data into internal buffer. - - extension-pair data to write. - - - - Gets a value indicating whether all data from the buffer has been read. - - - true if this instance is end of data; otherwise, false. - - - - - Gets the index that represents zero in current data type. - - - The index of the zero reader. - - - - - The exception that is thrown when operation is timed out. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - The message. - The inner exception. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - - The class name is null or is zero (0). - - - - The exception that is thrown when pass phrase for key file is empty or null - - - The exception that is thrown when pass phrase for key file is empty or null - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - The message. - The inner exception. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - - The class name is null or is zero (0). - - - - Specifies the initial assignments of the opcode values that are used in the 'encoded terminal modes' valu - - - - - Indicates end of options. - - - - - Interrupt character; 255 if none. Similarly for the other characters. Not all of these characters are supported on all systems. - - - - - The quit character (sends SIGQUIT signal on POSIX systems). - - - - - Erase the character to left of the cursor. - - - - - Kill the current input line. - - - - - End-of-file character (sends EOF from the terminal). - - - - - End-of-line character in addition to carriage return and/or linefeed. - - - - - Additional end-of-line character. - - - - - Continues paused output (normally control-Q). - - - - - Pauses output (normally control-S). - - - - - Suspends the current program. - - - - - Another suspend character. - - - - - Reprints the current input line. - - - - - Erases a word left of cursor. - - - - - Enter the next character typed literally, even if it is a special character - - - - - Character to flush output. - - - - - Switch to a different shell layer. - - - - - Prints system status line (load, command, pid, etc). - - - - - Toggles the flushing of terminal output. - - - - - The ignore parity flag. The parameter SHOULD be 0 if this flag is FALSE, and 1 if it is TRUE. - - - - - Mark parity and framing errors. - - - - - Enable checking of parity errors. - - - - - Strip 8th bit off characters. - - - - - Map NL into CR on input. - - - - - Ignore CR on input. - - - - - Map CR to NL on input. - - - - - Translate uppercase characters to lowercase. - - - - - Enable output flow control. - - - - - Any char will restart after stop. - - - - - Enable input flow control. - - - - - Ring bell on input queue full. - - - - - Enable signals INTR, QUIT, [D]SUSP. - - - - - Canonicalize input lines. - - - - - Enable input and output of uppercase characters by preceding their lowercase equivalents with "\". - - - - - Enable echoing. - - - - - Visually erase chars. - - - - - Kill character discards current line. - - - - - Echo NL even if ECHO is off. - - - - - Don't flush after interrupt. - - - - - Stop background jobs from output. - - - - - Enable extensions. - - - - - Echo control characters as ^(Char). - - - - - Visual erase for line kill. - - - - - Retype pending input. - - - - - Enable output processing. - - - - - Convert lowercase to uppercase. - - - - - Map NL to CR-NL. - - - - - Translate carriage return to newline (output). - - - - - Translate newline to carriage return-newline (output). - - - - - Newline performs a carriage return (output). - - - - - 7 bit mode. - - - - - 8 bit mode. - - - - - Parity enable. - - - - - Odd parity, else even. - - - - - Specifies the input baud rate in bits per second. - - - - - Specifies the output baud rate in bits per second. - - - - - Specifies compression modes - - - - - Specifies that content should be compressed. - - - - - Specifies that content should be decompressed. - - - - - Represents base class for compression algorithm implementation - - - - - Represents the abstract base class from which all implementations of algorithms must inherit. - - - - - Gets algorithm name. - - - - - Initializes a new instance of the class. - - - - - Initializes the algorithm - - The session. - - - - Compresses the specified data. - - Data to compress. - Compressed data - - - - Decompresses the specified data. - - Compressed data. - Decompressed data. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged ResourceMessages. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged ResourceMessages. - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Gets or sets a value indicating whether compression is active. - - - true if compression is active; otherwise, false. - - - - - Gets the session. - - - - - Represents "zlib" compression implementation - - - - - Initializes the algorithm - - The session. - - - - Gets algorithm name. - - - - - Represents "zlib@openssh.org" compression implementation - - - - - Initializes the algorithm - - The session. - - - - Gets algorithm name. - - - - - Implements Zlib compression algorithm. - - - - - Initializes a new instance of the class. - - The stream. - The mode. - - - - Writes the specified buffer. - - The buffer. - The offset. - The count. - - - - Represents remote connection information class. - - - - - Initializes a new instance of the class. - - The host. - The username. - The authentication methods. - - - - Initializes a new instance of the class. - - The host. - The port. - The username. - The authentication methods. - - - - Initializes a new instance of the class. - - Connection host. - Connection port. - Connection username. - Type of the proxy. - The proxy host. - The proxy port. - The proxy username. - The proxy password. - The authentication methods. - host - proxyPort - is invalid, or is null or contains whitespace characters. - is not within and . - is invalid, or is null or contains whitespace characters. - - - - Authenticates the specified session. - - The session to be authenticated. - true if authenticated; otherwise false. - is null. - No suitable authentication method found to complete authentication. - - - - Gets supported key exchange algorithms for this connection. - - - - - Gets supported encryptions for this connection. - - - - - Gets supported hash algorithms for this connection. - - - - - Gets supported host key algorithms for this connection. - - - - - Gets supported authentication methods for this connection. - - - - - Gets supported compression algorithms for this connection. - - - - - Gets supported channel requests for this connection. - - - - - Gets a value indicating whether connection is authenticated. - - - true if connection is authenticated; otherwise, false. - - - - - Gets connection host. - - - - - Gets connection port. - - - - - Gets connection username. - - - - - Gets proxy type. - - - The type of the proxy. - - - - - Gets proxy connection host. - - - - - Gets proxy connection port. - - - - - Gets proxy connection username. - - - - - Gets proxy connection password. - - - - - Gets or sets connection timeout. - - - Connection timeout. - - - - - - - - Gets or sets the default encoding. - - - The default encoding. - - - - - Gets or sets number of retry attempts when session channel creation failed. - - - Number of retry attempts. - - - - - Gets or sets maximum number of session channels to be open simultaneously. - - - The max sessions. - - - - - Occurs when authentication banner is sent by the server. - - - - - - - - Gets the current key exchange algorithm. - - - - - Gets the current server encryption. - - - - - Gets the current client encryption. - - - - - Gets the current server hash algorithm. - - - - - Gets the current client hash algorithm. - - - - - Gets the current host key algorithm. - - - - - Gets the current server compression algorithm. - - - - - Gets the server version. - - - - - Get the client version. - - - - - Gets the current client compression algorithm. - - - - - Provides functionality for remote port forwarding - - - Provides functionality for remote port forwarding - - - Provides functionality for remote port forwarding - - - - - Base class for port forwarding functionality. - - - - - Starts port forwarding. - - - - - Stops port forwarding. - - - - - Raises event. - - The exception. - - - - Raises event. - - Request originator host. - Request originator port. - - - - Handles session ErrorOccured event. - - The source of the event. - The instance containing the event data. - - - - Gets or sets the session. - - - The session. - - - - - Gets or sets a value indicating whether port forwarding started. - - - true if port forwarding started; otherwise, false. - - - - - Occurs when exception is thrown. - - - - - Occurs when port forwarding request received. - - - - - Initializes a new instance of the class. - - The bound port. - The host. - The port. - - - - - - - Initializes a new instance of the class. - - The bound host. - The bound port. - The host. - The port. - - - - Initializes a new instance of the class. - - The bound host address. - The bound port. - The host address. - The port. - boundHost - boundPort - - - - Starts remote port forwarding. - - - - - Stops remote port forwarding. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Gets the bound host. - - - - - Gets the bound host. - - - - - Gets the bound port. - - - - - Gets the forwarded host. - - - - - Gets the forwarded host. - - - - - Gets the forwarded port. - - - - - Holds information about key size and cipher to use - - - - - Initializes a new instance of the class. - - Size of the key. - The cipher. - - - - Gets the size of the key. - - - The size of the key. - - - - - Gets the cipher. - - - - - Represents SSH_MSG_KEXECDH_INIT message. - - - - - Base class for all SSH protocol messages - - - - - Gets data bytes array - - Byte array representation of the message - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Gets the index that represents zero in current data type. - - - The index of the zero reader. - - - - - Indicates that message that implement this interface is allowed during key exchange phase - - - - - Initializes a new instance of the class. - - The client exchange value. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the client's ephemeral contribution to the ECDH exchange, encoded as an octet string - - - - - Represents SSH_MSG_KEXECDH_REPLY message. - - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets a string encoding an X.509v3 certificate containing the server's ECDSA public host key - - The host key. - - - - Gets the the server's ephemeral contribution to the ECDH exchange, encoded as an octet string. - - - - - Gets the an octet string containing the server's signature of the newly established exchange hash value. - - The signature. - - - - - - - - - Initializes an implementation of the class. - - - - - Initializes a new instance of the class. - - - - - Reset the chaining variables to the IV values. - - - - - Rounds 0-15 - - The x. - The y. - The z. - - - - - Rounds 16-31 - - The x. - The y. - The z. - - - - - ounds 32-47 - - The x. - The y. - The z. - - - - - Rounds 48-63 - - The x. - The y. - The z. - - - - - ounds 64-79 - - The x. - The y. - The z. - - - - - Gets the size, in bits, of the computed hash code. - - The size, in bits, of the computed hash code. - - - - Gets the input block size. - - The input block size. - - - - Gets the output block size. - - The output block size. - - - - Gets a value indicating whether the current transform can be reused. - - Always true. - - - - Gets a value indicating whether multiple blocks can be transformed. - - true if multiple blocks can be transformed; otherwise, false. - - - - SHA256 algorithm implementation. - - - - - Initializes a new instance of the class. - - - - - Adjust the byte counts so that byteCount2 represents the upper long (less 3 bits) word of the byte count. - - - - - Gets a value indicating whether the current transform can be reused. - - Always true. - - - - Gets a value indicating whether multiple blocks can be transformed. - - true if multiple blocks can be transformed; otherwise, false. - - - - Gets the size, in bits, of the computed hash code. - - The size, in bits, of the computed hash code. - - - - When overridden in a derived class, gets the input block size. - - The input block size. - - - - When overridden in a derived class, gets the output block size. - - The output block size. - - - - Gets the size, in bits, of the computed hash code. - - The size, in bits, of the computed hash code. - - - - When overridden in a derived class, gets the input block size. - - The input block size. - - - - When overridden in a derived class, gets the output block size. - - The output block size. - - - - Represents base class for Diffie Hellman key exchange algorithm - - - - - Represents base class for different key exchange algorithm implementations - - - - - Starts key exchange algorithm - - The session. - Key exchange init message. - - - - Finishes key exchange algorithm. - - - - - Creates the server side cipher to use. - - Server cipher. - - - - Creates the client side cipher to use. - - Client cipher. - - - - Creates the server side hash algorithm to use. - - Hash algorithm - - - - Creates the client side hash algorithm to use. - - Hash algorithm - - - - Creates the compression algorithm to use to deflate data. - - Compression method. - - - - Creates the compression algorithm to use to inflate data. - - Compression method. - - - - Determines whether the specified host key can be trusted. - - The host algorithm. - - true if the specified host can be trusted; otherwise, false. - - - - - Validates the exchange hash. - - true if exchange hash is valid; otherwise false. - - - - Calculates key exchange hash value. - - Key exchange hash. - - - - Hashes the specified data bytes. - - The hash data. - - Hashed bytes - - - - - Sends SSH message to the server - - The message. - - - - Generates the session key. - - The shared key. - The exchange hash. - The key. - The size. - - - - - Generates the session key. - - The shared key. - The exchange hash. - The p. - The session id. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged ResourceMessages. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged ResourceMessages. - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Gets or sets the session. - - - The session. - - - - - Gets or sets key exchange shared key. - - - The shared key. - - - - - Gets the exchange hash. - - The exchange hash. - - - - Occurs when host key received. - - - - - Specifies client payload - - - - - Specifies server payload - - - - - Specifies client exchange number. - - - - - Specifies server exchange number. - - - - - Specifies random generated number. - - - - - Specifies host key data. - - - - - Specifies signature data. - - - - - Starts key exchange algorithm - - The session. - Key exchange init message. - - - - Validates the exchange hash. - - - true if exchange hash is valid; otherwise false. - - - - - Populates the client exchange value. - - - - - Represents instance of the SSH shell object - - - Contains operation for working with SSH Shell. - - - - is null. - - - - Clears all buffers for this stream and causes any buffered data to be written to the underlying device. - - An I/O error occurs. - - - - Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. - - An array of bytes. When this method returns, the buffer contains the specified byte array with the values between and ( + - 1) replaced by the bytes read from the current source. - The zero-based byte offset in at which to begin storing the data read from the current stream. - The maximum number of bytes to be read from the current stream. - - The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached. - - The sum of and is larger than the buffer length. - - - is null. - - - or is negative. - - An I/O error occurs. - - The stream does not support reading. - - Methods were called after the stream was closed. - - - - This method is not supported. - - A byte offset relative to the parameter. - A value of type indicating the reference point used to obtain the new position. - - The new position within the current stream. - - An I/O error occurs. - - The stream does not support seeking, such as if the stream is constructed from a pipe or console output. - - Methods were called after the stream was closed. - - - - This method is not supported. - - The desired length of the current stream in bytes. - An I/O error occurs. - - The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output. - - Methods were called after the stream was closed. - - - - Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. - - An array of bytes. This method copies bytes from to the current stream. - The zero-based byte offset in at which to begin copying bytes to the current stream. - The number of bytes to be written to the current stream. - The sum of and is greater than the buffer length. - - - is null. - - - or is negative. - - An I/O error occurs. - - The stream does not support writing. - - Methods were called after the stream was closed. - - - - Expects the specified expression and performs action when one is found. - - The expected expressions and actions to perform. - - - - Expects the specified expression and performs action when one is found. - - Time to wait for input. - The expected expressions and actions to perform, if the specified time elapsed and expected condition have not met, that method will exit without executing any action. - - - - Begins the expect. - - The expect actions. - - An that references the asynchronous operation. - - - - - Begins the expect. - - The callback. - The expect actions. - - An that references the asynchronous operation. - - - - - Begins the expect. - - The callback. - The state. - The expect actions. - - An that references the asynchronous operation. - - - - - Begins the expect. - - The timeout. - The callback. - The state. - The expect actions. - - An that references the asynchronous operation. - - - - - Ends the execute. - - The async result. - Either the IAsyncResult object did not come from the corresponding async method on this type, or EndExecute was called multiple times with the same IAsyncResult. - - - - Expects the expression specified by text. - - The text to expect. - - Text available in the shell that ends with expected text. - - - - - Expects the expression specified by text. - - The text to expect. - Time to wait for input. - - Text available in the shell that ends with expected text, if the specified time elapsed returns null. - - - - - Expects the expression specified by regular expression. - - The regular expression to expect. - Text available in the shell that contains all the text that ends with expected expression. - - - - Expects the expression specified by regular expression. - - The regular expression to expect. - Time to wait for input. - - Text available in the shell that contains all the text that ends with expected expression, if the specified time elapsed returns null. - - - - - Reads the line from the shell. If line is not available it will block the execution and will wait for new line. - - The line read from the shell. - - - - Reads the line from the shell. If line is not available it will block the execution and will wait for new line. - - Time to wait for input. - - The line read from the shell, if the specified time elapsed returns null. - - - - - Reads text available in the shell. - - The text available in the shell. - - - - Writes the specified text to the shell. - - The text to be written to the shell. - - - - Writes the line to the shell. - - The line to be written to the shell. - - - - Releases the unmanaged resources used by the and optionally releases the managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Waits for the handle to be signaled or for an error to occurs. - - The wait handle. - - - - Occurs when data was received. - - - - - Occurs when an error occurred. - - - - - Gets a value that indicates whether data is available on the to be read. - - - true if data is available to be read; otherwise, false. - - - - - Gets a value indicating whether the current stream supports reading. - - true if the stream supports reading; otherwise, false. - - - - Gets a value indicating whether the current stream supports seeking. - - true if the stream supports seeking; otherwise, false. - - - - Gets a value indicating whether the current stream supports writing. - - true if the stream supports writing; otherwise, false. - - - - Gets the length in bytes of the stream. - - A long value representing the length of the stream in bytes. - - A class derived from Stream does not support seeking. - - Methods were called after the stream was closed. - - - - Gets or sets the position within the current stream. - - The current position within the stream. - - An I/O error occurs. - - The stream does not support seeking. - - Methods were called after the stream was closed. - - - - Provides additional information for asynchronous command execution - - - - - Initializes a new instance of the class. - - The shell stream. - The async callback. - The state. - - - - Represents "diffie-hellman-group1-sha1" algorithm implementation. - - - - - Represents base class for Diffie Hellman key exchange algorithm - - - - - Specifies key exchange group number. - - - - - Specifies key exchange prime number. - - - - - Specifies client payload - - - - - Specifies server payload - - - - - Specifies client exchange number. - - - - - Specifies server exchange number. - - - - - Specifies random generated number. - - - - - Specifies host key data. - - - - - Specifies signature data. - - - - - Validates the exchange hash. - - - true if exchange hash is valid; otherwise false. - - - - - Starts key exchange algorithm - - The session. - Key exchange init message. - - - - Populates the client exchange value. - - - - - Handles the server DH reply message. - - The host key. - The server exchange value. - The signature. - - - - Calculates key exchange hash value. - - - Key exchange hash. - - - - - Starts key exchange algorithm - - The session. - Key exchange init message. - - - - Finishes key exchange algorithm. - - - - - Gets the group prime. - - - The group prime. - - - - - Implementation of the SSH File Transfer Protocol (SFTP) over SSH. - - - Implementation of the SSH File Transfer Protocol (SFTP) over SSH. - - - - - - - - Synchronizes the directories. - - The source path. - The destination path. - The search pattern. - List of uploaded files. - - - - Begins the synchronize directories. - - The source path. - The destination path. - The search pattern. - The async callback. - The state. - - An that represents the asynchronous directory synchronization. - - sourceDir - destDir - - - - Ends the synchronize directories. - - The async result. - List of uploaded files. - Either the IAsyncResult object did not come from the corresponding async method on this type, or EndExecute was called multiple times with the same IAsyncResult. - - - - Holds SftpSession instance that used to communicate to the SFTP server - - - - - Initializes a new instance of the class. - - The connection info. - is null. - - - - Initializes a new instance of the class. - - Connection host. - Connection port. - Authentication username. - Authentication password. - is null. - is invalid. -or- is null or contains whitespace characters. - is not within and . - - - - Initializes a new instance of the class. - - Connection host. - Authentication username. - Authentication password. - is null. - is invalid. -or- is null contains whitespace characters. - - - - Initializes a new instance of the class. - - Connection host. - Connection port. - Authentication username. - Authentication private key file(s) . - is null. - is invalid. -or- is nunullll or contains whitespace characters. - is not within and . - - - - Initializes a new instance of the class. - - Connection host. - Authentication username. - Authentication private key file(s) . - is null. - is invalid. -or- is null or contains whitespace characters. - - - - Changes remote directory to path. - - New directory path. - is null. - Client is not connected. - Permission to change directory denied by remote host. -or- A SSH command was denied by the server. - The path in was not found on the remote host. - A SSH error where is the message from the remote host. - - - - Changes permissions of file(s) to specified mode. - - File(s) path, may match multiple files. - The mode. - is null. - Client is not connected. - Permission to change permission on the path(s) was denied by the remote host. -or- A SSH command was denied by the server. - The path in was not found on the remote host. - A SSH error where is the message from the remote host. - - - - Creates remote directory specified by path. - - Directory path to create. - is null or contains whitespace characters. - Client is not connected. - Permission to create the directory was denied by the remote host. -or- A SSH command was denied by the server. - A SSH error where is the message from the remote host. - - - - Deletes remote directory specified by path. - - Directory to be deleted path. - is null or contains whitespace characters. - Client is not connected. - Permission to delete the directory was denied by the remote host. -or- A SSH command was denied by the server. - A SSH error where is the message from the remote host. - - - - Deletes remote file specified by path. - - File to be deleted path. - is null or contains whitespace characters. - Client is not connected. - Permission to delete the file was denied by the remote host. -or- A SSH command was denied by the server. - A SSH error where is the message from the remote host. - - - - Renames remote file from old path to new path. - - Path to the old file location. - Path to the new file location. - is null. -or- or is null. - Client is not connected. - Permission to rename the file was denied by the remote host. -or- A SSH command was denied by the server. - A SSH error where is the message from the remote host. - - - - Renames remote file from old path to new path. - - Path to the old file location. - Path to the new file location. - if set to true then perform a posix rename. - oldPath - is null. -or- or is null. - Client is not connected. - Permission to rename the file was denied by the remote host. -or- A SSH command was denied by the server. - A SSH error where is the message from the remote host. - - - - Creates a symbolic link from old path to new path. - - The old path. - The new path. - is null. -or- is null or contains whitespace characters. - Client is not connected. - Permission to create the symbolic link was denied by the remote host. -or- A SSH command was denied by the server. - A SSH error where is the message from the remote host. - - - - Retrieves list of files in remote directory. - - The path. - The list callback. - - List of directory entries - - is null. - Client is not connected. - Permission to list the contents of the directory was denied by the remote host. -or- A SSH command was denied by the server. - A SSH error where is the message from the remote host. - - - - Begins an asynchronous operation of retrieving list of files in remote directory. - - The path. - The method to be called when the asynchronous write operation is completed. - A user-provided object that distinguishes this particular asynchronous write request from other requests. - The list callback. - - An that references the asynchronous operation. - - - - - Ends an asynchronous operation of retrieving list of files in remote directory. - - The pending asynchronous SFTP request. - - List of files - - The IAsyncResult object () did not come from the corresponding async method on this type. -or- EndExecute was called multiple times with the same IAsyncResult. - - - - Gets reference to remote file or directory. - - The path. - Reference to file object. - path - Client is not connected. - is null. - - - - Checks whether file pr directory exists; - - The path. - true if directory or file exists; otherwise false. - is null or contains whitespace characters. - Client is not connected. - Permission to perform the operation was denied by the remote host. -or- A SSH command was denied by the server. - A SSH error where is the message from the remote host. - - - - Downloads remote file specified by the path into the stream. - - File to download. - Stream to write the file into. - The download callback. - is null. - is null or contains whitespace characters. - Client is not connected. - Permission to perform the operation was denied by the remote host. -or- A SSH command was denied by the server. - A SSH error where is the message from the remote host. - - Method calls made by this method to , may under certain conditions result in exceptions thrown by the stream. - - - - - Begins an asynchronous file downloading into the stream. - - The path. - The output. - - An that references the asynchronous operation. - - path - output - is null. - is null or contains whitespace characters. - Client is not connected. - Permission to perform the operation was denied by the remote host. -or- A SSH command was denied by the server. - A SSH error where is the message from the remote host. - - Method calls made by this method to , may under certain conditions result in exceptions thrown by the stream. - - - - - Begins an asynchronous file downloading into the stream. - - The path. - The output. - The method to be called when the asynchronous write operation is completed. - - An that references the asynchronous operation. - - path - output - is null. - is null or contains whitespace characters. - Client is not connected. - Permission to perform the operation was denied by the remote host. -or- A SSH command was denied by the server. - A SSH error where is the message from the remote host. - - Method calls made by this method to , may under certain conditions result in exceptions thrown by the stream. - - - - - Begins an asynchronous file downloading into the stream. - - The path. - The output. - The method to be called when the asynchronous write operation is completed. - A user-provided object that distinguishes this particular asynchronous write request from other requests. - The download callback. - - An that references the asynchronous operation. - - path - output - is null. - is null or contains whitespace characters. - Client is not connected. - Permission to perform the operation was denied by the remote host. -or- A SSH command was denied by the server. - A SSH error where is the message from the remote host. - - Method calls made by this method to , may under certain conditions result in exceptions thrown by the stream. - - - - - Ends an asynchronous file downloading into the stream. - - The pending asynchronous SFTP request. - The IAsyncResult object () did not come from the corresponding async method on this type. -or- EndExecute was called multiple times with the same IAsyncResult. - - - - Uploads stream into remote file.. - - Data input stream. - Remote file path. - The upload callback. - is null. - is null or contains whitespace characters. - Client is not connected. - Permission to upload the file was denied by the remote host. -or- A SSH command was denied by the server. - A SSH error where is the message from the remote host. - - Method calls made by this method to , may under certain conditions result in exceptions thrown by the stream. - - - - - Uploads stream into remote file.. - - Data input stream. - Remote file path. - if set to true then existing file will be overwritten. - The upload callback. - is null. - is null or contains whitespace characters. - Client is not connected. - Permission to upload the file was denied by the remote host. -or- A SSH command was denied by the server. - A SSH error where is the message from the remote host. - - Method calls made by this method to , may under certain conditions result in exceptions thrown by the stream. - - - - - Begins an asynchronous uploading the steam into remote file. - - Data input stream. - Remote file path. - - An that references the asynchronous operation. - - is null. - is null or contains whitespace characters. - Client is not connected. - Permission to list the contents of the directory was denied by the remote host. -or- A SSH command was denied by the server. - A SSH error where is the message from the remote host. - - Method calls made by this method to , may under certain conditions result in exceptions thrown by the stream. - - - - - Begins an asynchronous uploading the steam into remote file. - - Data input stream. - Remote file path. - The method to be called when the asynchronous write operation is completed. - - An that references the asynchronous operation. - - is null. - is null or contains whitespace characters. - Client is not connected. - Permission to list the contents of the directory was denied by the remote host. -or- A SSH command was denied by the server. - A SSH error where is the message from the remote host. - - Method calls made by this method to , may under certain conditions result in exceptions thrown by the stream. - - - - - Begins an asynchronous uploading the steam into remote file. - - Data input stream. - Remote file path. - The method to be called when the asynchronous write operation is completed. - A user-provided object that distinguishes this particular asynchronous write request from other requests. - The upload callback. - - An that references the asynchronous operation. - - is null. - is null or contains whitespace characters. - Client is not connected. - Permission to list the contents of the directory was denied by the remote host. -or- A SSH command was denied by the server. - A SSH error where is the message from the remote host. - - Method calls made by this method to , may under certain conditions result in exceptions thrown by the stream. - - - - - Begins an asynchronous uploading the steam into remote file. - - Data input stream. - Remote file path. - if set to true then existing file will be overwritten. - The method to be called when the asynchronous write operation is completed. - A user-provided object that distinguishes this particular asynchronous write request from other requests. - The upload callback. - - An that references the asynchronous operation. - - input - path - is null. - is null or contains whitespace characters. - Client is not connected. - Permission to list the contents of the directory was denied by the remote host. -or- A SSH command was denied by the server. - A SSH error where is the message from the remote host. - - Method calls made by this method to , may under certain conditions result in exceptions thrown by the stream. - - - - - Ends an asynchronous uploading the steam into remote file. - - The pending asynchronous SFTP request. - Either the IAsyncResult object did not come from the corresponding async method on this type, or EndExecute was called multiple times with the same IAsyncResult. - The IAsyncResult object () did not come from the corresponding async method on this type. -or- EndExecute was called multiple times with the same IAsyncResult. - - - - Gets status using statvfs@openssh.com request. - - The path. - Reference to object that contains file status information. - path - Client is not connected. - is null. - - - - Appends lines to a file, and then closes the file. - - The file to append the lines to. The file is created if it does not already exist. - The lines to append to the file. - isnull -or- is null. - - - - Appends lines to a file by using a specified encoding, and then closes the file. - - The file to append the lines to. The file is created if it does not already exist. - The lines to append to the file. - The character encoding to use. - is null. -or- is null. -or- is null. - - - - Opens a file, appends the specified string to the file, and then closes the file. - If the file does not exist, this method creates a file, writes the specified string to the file, then closes the file. - - The file to append the specified string to. - The string to append to the file. - is null. -or- is null. - - - - Opens a file, appends the specified string to the file, and then closes the file. - If the file does not exist, this method creates a file, writes the specified string to the file, then closes the file. - - The file to append the specified string to. - The string to append to the file. - The character encoding to use. - is null. -or- is null. -or- is null. - - - - Creates a that appends UTF-8 encoded text to an existing file. - - The path to the file to append to. - A StreamWriter that appends UTF-8 encoded text to an existing file. - is null. - - - - Creates a that appends UTF-8 encoded text to an existing file. - - The path to the file to append to. - The character encoding to use. - - A StreamWriter that appends UTF-8 encoded text to an existing file. - - is null. -or- is null. - - - - Creates or overwrites a file in the specified path. - - The path and name of the file to create. - A that provides read/write access to the file specified in path - is null. - - - - Creates or overwrites the specified file. - - The path and name of the file to create. - The number of bytes buffered for reads and writes to the file. - A that provides read/write access to the file specified in path - is null. - - - - Creates or opens a file for writing UTF-8 encoded text. - - The file to be opened for writing. - A that writes to the specified file using UTF-8 encoding. - is null. - - - - Creates or opens a file for writing UTF-8 encoded text. - - The file to be opened for writing. - The character encoding to use. - A that writes to the specified file using UTF-8 encoding. - is null. - - - - Deletes the specified file or directory. An exception is not thrown if the specified file does not exist. - - The name of the file or directory to be deleted. Wildcard characters are not supported. - is null. - Client is not connected. - - - - Returns the date and time the specified file or directory was last accessed. - - The file or directory for which to obtain access date and time information. - A structure set to the date and time that the specified file or directory was last accessed. This value is expressed in local time. - is null. - Client is not connected. - - - - Returns the date and time, in coordinated universal time (UTC), that the specified file or directory was last accessed. - - The file or directory for which to obtain access date and time information. - A structure set to the date and time that the specified file or directory was last accessed. This value is expressed in UTC time. - is null. - Client is not connected. - - - - Returns the date and time the specified file or directory was last written to. - - The file or directory for which to obtain write date and time information. - A structure set to the date and time that the specified file or directory was last written to. This value is expressed in local time. - is null. - Client is not connected. - - - - Returns the date and time, in coordinated universal time (UTC), that the specified file or directory was last written to. - - The file or directory for which to obtain write date and time information. - A structure set to the date and time that the specified file or directory was last written to. This value is expressed in UTC time. - is null. - Client is not connected. - - - - Opens a on the specified path with read/write access. - - The file to open. - A value that specifies whether a file is created if one does not exist, and determines whether the contents of existing files are retained or overwritten. - An unshared that provides access to the specified file, with the specified mode and access. - is null. - - - - Opens a on the specified path, with the specified mode and access. - - The file to open. - A value that specifies whether a file is created if one does not exist, and determines whether the contents of existing files are retained or overwritten. - A value that specifies the operations that can be performed on the file. - An unshared that provides access to the specified file, with the specified mode and access. - is null. - - - - Opens an existing file for reading. - - The file to be opened for reading. - A read-only System.IO.FileStream on the specified path. - is null. - - - - Opens an existing UTF-8 encoded text file for reading. - - The file to be opened for reading. - A on the specified path. - is null. - - - - Opens an existing file for writing. - - The file to be opened for writing. - An unshared object on the specified path with access. - is null. - - - - Opens a binary file, reads the contents of the file into a byte array, and then closes the file. - - The file to open for reading. - A byte array containing the contents of the file. - is null. - - - - Opens a text file, reads all lines of the file, and then closes the file. - - The file to open for reading. - A string array containing all lines of the file. - is null. - - - - Opens a file, reads all lines of the file with the specified encoding, and then closes the file. - - The file to open for reading. - The encoding applied to the contents of the file. - A string array containing all lines of the file. - is null. - - - - Opens a text file, reads all lines of the file, and then closes the file. - - The file to open for reading. - A string containing all lines of the file. - is null. - - - - Opens a file, reads all lines of the file with the specified encoding, and then closes the file. - - The file to open for reading. - The encoding applied to the contents of the file. - A string containing all lines of the file. - is null. - - - - Reads the lines of a file. - - The file to read. - The lines of the file. - is null. - - - - Read the lines of a file that has a specified encoding. - - The file to read. - The encoding that is applied to the contents of the file. - The lines of the file. - is null. - - - - Sets the date and time the specified file was last accessed. - - The file for which to set the access date and time information. - A containing the value to set for the last access date and time of path. This value is expressed in local time. - - - - Sets the date and time, in coordinated universal time (UTC), that the specified file was last accessed. - - The file for which to set the access date and time information. - A containing the value to set for the last access date and time of path. This value is expressed in UTC time. - - - - Sets the date and time that the specified file was last written to. - - The file for which to set the date and time information. - A System.DateTime containing the value to set for the last write date and time of path. This value is expressed in local time. - - - - Sets the date and time, in coordinated universal time (UTC), that the specified file was last written to. - - The file for which to set the date and time information. - A System.DateTime containing the value to set for the last write date and time of path. This value is expressed in UTC time. - - - - Creates a new file, writes the specified byte array to the file, and then closes the file. If the target file already exists, it is overwritten. - - The file to write to. - The bytes to write to the file. - is null. - - - - Creates a new file, writes a collection of strings to the file, and then closes the file. - - The file to write to. - The lines to write to the file. - is null. - - - - Creates a new file, write the specified string array to the file, and then closes the file. - - The file to write to. - The string array to write to the file. - is null. - - - - Creates a new file by using the specified encoding, writes a collection of strings to the file, and then closes the file. - - The file to write to. - The lines to write to the file. - The character encoding to use. - is null. - - - - Creates a new file, writes the specified string array to the file by using the specified encoding, and then closes the file. - - The file to write to. - The string array to write to the file. - An object that represents the character encoding applied to the string array. - is null. - - - - Creates a new file, writes the specified string to the file, and then closes the file. If the target file already exists, it is overwritten. - - The file to write to. - The string to write to the file. - is null. - - - - Creates a new file, writes the specified string to the file using the specified encoding, and then closes the file. If the target file already exists, it is overwritten. - - The file to write to. - The string to write to the file. - The encoding to apply to the string. - is null. - - - - Gets the of the file on the path. - - The path to the file. - The of the file on the path. - is null. - - - - Sets the specified of the file on the specified path. - - The path to the file. - The desired . - is null. - - - - Internals the list directory. - - The path. - The list callback. - - path - is null. - Client not connected. - - - - Internals the download file. - - The path. - The output. - The download callback. - output - path - is null or contains whitespace. - is null. - Client not connected. - - - - Internals the upload file. - - The input. - The path. - The flags. - The upload callback. - input - path - is null. - is null or contains whitespace. - Client not connected. - - - - Called when client is connected to the server. - - - - - Called when client is disconnecting from the server. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged ResourceMessages. - - - - - - - is null. - - - - Gets or sets the operation timeout. - - The operation timeout. - - - - Gets or sets the size of the buffer. - - The size of the buffer. - - - - Gets remote working directory. - - - - - Gets sftp protocol version. - - - - - Provides functionality to perform keyboard interactive authentication. - - - - - Initializes a new instance of the class. - - The username. - is whitespace or null. - - - - Authenticates the specified session. - - The session to authenticate. - Result of authentication process. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - is null. - - - - Gets authentication method name - - - - - Occurs when server prompts for more authentication information. - - - - - Provides connection information when keyboard interactive authentication method is used - - - - - - - - Initializes a new instance of the class. - - The host. - The username. - - - - Initializes a new instance of the class. - - The host. - The port. - The username. - - - - Initializes a new instance of the class. - - Connection host. - Connection port. - Connection username. - Type of the proxy. - The proxy host. - The proxy port. - - - - Initializes a new instance of the class. - - Connection host. - Connection port. - Connection username. - Type of the proxy. - The proxy host. - The proxy port. - The proxy username. - - - - Initializes a new instance of the class. - - Connection host. - Connection username. - Type of the proxy. - The proxy host. - The proxy port. - - - - Initializes a new instance of the class. - - Connection host. - Connection username. - Type of the proxy. - The proxy host. - The proxy port. - The proxy username. - - - - Initializes a new instance of the class. - - Connection host. - Connection username. - Type of the proxy. - The proxy host. - The proxy port. - The proxy username. - The proxy password. - - - - Initializes a new instance of the class. - - Connection host. - Connection port. - Connection username. - Type of the proxy. - The proxy host. - The proxy port. - The proxy username. - The proxy password. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Occurs when server prompts for more authentication information. - - - - - - - - Provides functionality for "none" authentication method - - - - - Initializes a new instance of the class. - - The username. - is whitespace or null. - - - - Authenticates the specified session. - - The session. - - Result of authentication process. - - is null. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Gets connection name - - - - - Provides functionality to perform password authentication. - - - - - Initializes a new instance of the class. - - The username. - The password. - is whitespace or null. - is null. - - - - Initializes a new instance of the class. - - The username. - The password. - is whitespace or null. - is null. - - - - Authenticates the specified session. - - The session to authenticate. - - Result of authentication process. - - is null. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - is null. - - - - Gets authentication method name - - - - - Occurs when user's password has expired and needs to be changed. - - - - - Specifies behavior for expected expression - - - - - Initializes a new instance of the class. - - The expect regular expression. - The action to perform. - or is null. - - - - Initializes a new instance of the class. - - The expect expression. - The action to perform. - or is null. - - - - Gets the expected regular expression. - - - - - Gets the action to perform when expected expression is found. - - - - - Provides functionality for dynamic port forwarding - - - - - Initializes a new instance of the class. - - The port. - - - - Initializes a new instance of the class. - - The host. - The port. - - - - Starts local port forwarding. - - - - - Stops local port forwarding. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged ResourceMessages. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged ResourceMessages. - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Gets the bound host. - - - - - Gets the bound port. - - - - - Provides functionality for local port forwarding - - - Provides functionality for local port forwarding - - - Provides functionality for local port forwarding - - - - - Initializes a new instance of the class. - - The bound port. - The host. - The port. - - - - - - - Initializes a new instance of the class. - - The bound host. - The bound port. - The host. - The port. - - - - Starts local port forwarding. - - - - - Stops local port forwarding. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged ResourceMessages. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged ResourceMessages. - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Gets the bound host. - - - - - Gets the bound port. - - - - - Gets the forwarded host. - - - - - Gets the forwarded port. - - - - - Provides connection information when password authentication method is used - - - - - - - - - - Initializes a new instance of the class. - - Connection host. - Connection username. - Connection password. - - - - is null. - is invalid, or is null or contains whitespace characters. - is not within and . - - - - Initializes a new instance of the class. - - Connection host. - Connection port. - Connection username. - Connection password. - is null. - is invalid, or is null or contains whitespace characters. - is not within and . - - - - Initializes a new instance of the class. - - Connection host. - The port. - Connection username. - Connection password. - Type of the proxy. - The proxy host. - The proxy port. - - - - Initializes a new instance of the class. - - Connection host. - The port. - Connection username. - Connection password. - Type of the proxy. - The proxy host. - The proxy port. - The proxy username. - - - - Initializes a new instance of the class. - - Connection host. - Connection username. - Connection password. - Type of the proxy. - The proxy host. - The proxy port. - - - - Initializes a new instance of the class. - - Connection host. - Connection username. - Connection password. - Type of the proxy. - The proxy host. - The proxy port. - The proxy username. - - - - Initializes a new instance of the class. - - Connection host. - Connection username. - Connection password. - Type of the proxy. - The proxy host. - The proxy port. - The proxy username. - The proxy password. - - - - Initializes a new instance of the class. - - Connection host. - Connection username. - Connection password. - - - - Initializes a new instance of the class. - - Connection host. - Connection port. - Connection username. - Connection password. - is null. - is invalid, or is null or contains whitespace characters. - is not within and . - - - - Initializes a new instance of the class. - - Connection host. - The port. - Connection username. - Connection password. - Type of the proxy. - The proxy host. - The proxy port. - - - - Initializes a new instance of the class. - - Connection host. - The port. - Connection username. - Connection password. - Type of the proxy. - The proxy host. - The proxy port. - The proxy username. - - - - Initializes a new instance of the class. - - Connection host. - Connection username. - Connection password. - Type of the proxy. - The proxy host. - The proxy port. - - - - Initializes a new instance of the class. - - Connection host. - Connection username. - Connection password. - Type of the proxy. - The proxy host. - The proxy port. - The proxy username. - - - - Initializes a new instance of the class. - - Connection host. - Connection username. - Connection password. - Type of the proxy. - The proxy host. - The proxy port. - The proxy username. - The proxy password. - - - - Initializes a new instance of the class. - - Connection host. - The port. - Connection username. - Connection password. - Type of the proxy. - The proxy host. - The proxy port. - The proxy username. - The proxy password. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Occurs when user's password has expired and needs to be changed. - - - - - - - - Provides functionality to perform private key authentication. - - - - - Initializes a new instance of the class. - - The username. - The key files. - is whitespace or null. - - - - Authenticates the specified session. - - The session to authenticate. - - Result of authentication process. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Gets authentication method name - - - - - Gets the key files used for authentication. - - - - - Provides connection information when private key authentication method is used - - - - - - - - Initializes a new instance of the class. - - Connection host. - Connection username. - Connection key files. - - - - - - - - Initializes a new instance of the class. - - Connection host. - Connection port. - Connection username. - Connection key files. - - - - Initializes a new instance of the class. - - Connection host. - The port. - Connection username. - Type of the proxy. - The proxy host. - The proxy port. - The key files. - - - - Initializes a new instance of the class. - - Connection host. - The port. - Connection username. - Type of the proxy. - The proxy host. - The proxy port. - The proxy username. - The key files. - - - - Initializes a new instance of the class. - - Connection host. - Connection username. - Type of the proxy. - The proxy host. - The proxy port. - The key files. - - - - Initializes a new instance of the class. - - Connection host. - Connection username. - Type of the proxy. - The proxy host. - The proxy port. - The proxy username. - The key files. - - - - Initializes a new instance of the class. - - Connection host. - Connection username. - Type of the proxy. - The proxy host. - The proxy port. - The proxy username. - The proxy password. - The key files. - - - - Initializes a new instance of the class. - - Connection host. - The port. - Connection username. - Type of the proxy. - The proxy host. - The proxy port. - The proxy username. - The proxy password. - The key files. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Gets the key files used for authentication. - - - - - Specifies the type of proxy client will use to connect to server. - - - - No proxy server. - - - A SOCKS4 proxy server. - - - A SOCKS5 proxy server. - - - A HTTP proxy server. - - - - Provides SCP client functionality. - - - Provides SCP client functionality. - - - - - Initializes a new instance of the class. - - The connection info. - is null. - - - - Initializes a new instance of the class. - - Connection host. - Connection port. - Authentication username. - Authentication password. - is null. - is invalid, or is null or contains whitespace characters. - is not within and . - - - - Initializes a new instance of the class. - - Connection host. - Authentication username. - Authentication password. - is null. - is invalid, or is null or contains whitespace characters. - - - - Initializes a new instance of the class. - - Connection host. - Connection port. - Authentication username. - Authentication private key file(s) . - is null. - is invalid, -or- is null or contains whitespace characters. - is not within and . - - - - Initializes a new instance of the class. - - Connection host. - Authentication username. - Authentication private key file(s) . - is null. - is invalid, -or- is null or contains whitespace characters. - - - - Uploads the specified stream to the remote host. - - Stream to upload. - Remote host file name. - - - - Downloads the specified file from the remote host to the stream. - - Remote host file name. - The stream where to download remote file. - is null or contains whitespace characters. - is null. - Method calls made by this method to , may under certain conditions result in exceptions thrown by the stream. - - - - Checks the return code. - - The output stream. - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged ResourceMessages. - - - - Uploads the specified file to the remote host. - - The file system info. - The path. - fileSystemInfo - path - - or is null. - - - - Uploads the specified directory to the remote host. - - The directory info. - The path. - fileSystemInfo - path - - - - Downloads the specified file from the remote host to local file. - - Remote host file name. - Local file information. - or is null. - - - - Downloads the specified directory from the remote host to local directory. - - Remote host directory name. - Local directory information. - or is null. - - - - Gets or sets the operation timeout. - - The operation timeout. - - - - Gets or sets the size of the buffer. - - The size of the buffer. - - - - Occurs when downloading file. - - - - - Occurs when uploading file. - - - - - Provides data for message events. - - Message type - - - - Initializes a new instance of the class. - - The message. - is null. - - - - Gets the message. - - - - - Represents SSH_MSG_USERAUTH_BANNER message. - - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets banner message. - - - - - Gets banner language. - - - - - Represents SSH_MSG_USERAUTH_FAILURE message. - - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets or sets the allowed authentications if available. - - - The allowed authentications. - - - - - Gets failure message. - - - - - Gets a value indicating whether authentication is partially successful. - - - true if partially successful; otherwise, false. - - - - - Represents SSH_MSG_USERAUTH_INFO_REQUEST message. - - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets information request name. - - - - - Gets information request instruction. - - - - - Gets information request language. - - - - - Gets information request prompts. - - - - - Represents SSH_MSG_USERAUTH_INFO_RESPONSE message. - - - - - Initializes a new instance of the class. - - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets authentication responses. - - - - - Represents SSH_MSG_USERAUTH_PASSWD_CHANGEREQ message. - - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets password change request message. - - - - - Gets message language. - - - - - Represents SSH_MSG_USERAUTH_PK_OK message. - - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the name of the public key algorithm. - - - The name of the public key algorithm. - - - - - Gets the public key data. - - - - - Represents SSH_MSG_USERAUTH_REQUEST message. Server as a base message for other user authentication requests. - - - - - Initializes a new instance of the class. - - Name of the service. - Authentication username. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets authentication username. - - - - - Gets the name of the service. - - - The name of the service. - - - - - Gets the name of the authentication method. - - - The name of the method. - - - - - Represents "hostbased" SSH_MSG_USERAUTH_REQUEST message. - - - - - Initializes a new instance of the class. - - Name of the service. - Authentication username. - The public key algorithm. - The public host key. - Name of the client host. - The client username. - - - - Called when type specific data need to be saved. - - - - - Gets the name of the authentication method. - - - The name of the method. - - - - - Gets the public key algorithm for host key - - - - - Gets or sets the public host key and certificates for client host. - - - The public host key. - - - - - Gets or sets the name of the client host. - - - The name of the client host. - - - - - Gets or sets the client username on the client host - - - The client username. - - - - - Gets or sets the signature. - - - The signature. - - - - - Represents "keyboard-interactive" SSH_MSG_USERAUTH_REQUEST message. - - - - - Initializes a new instance of the class. - - Name of the service. - Authentication username. - - - - Called when type specific data need to be saved. - - - - - Gets the name of the authentication method. - - - The name of the method. - - - - - Gets message language. - - - - - Gets authentication sub methods. - - - - - Represents "none" SSH_MSG_USERAUTH_REQUEST message. - - - - - Initializes a new instance of the class. - - Name of the service. - Authentication username. - - - - Called when type specific data need to be saved. - - - - - Gets the name of the authentication method. - - - The name of the method. - - - - - Represents "password" SSH_MSG_USERAUTH_REQUEST message. - - - - - Initializes a new instance of the class. - - Name of the service. - Authentication username. - Authentication password. - - - - Initializes a new instance of the class. - - Name of the service. - Authentication username. - Authentication password. - New authentication password. - - - - Called when type specific data need to be saved. - - - - - Gets the name of the authentication method. - - - The name of the method. - - - - - Gets authentication password. - - - - - Gets new authentication password. - - - - - Represents "publickey" SSH_MSG_USERAUTH_REQUEST message. - - - - - Initializes a new instance of the class. - - Name of the service. - Authentication username. - Name of private key algorithm. - Private key data. - - - - Initializes a new instance of the class. - - Name of the service. - Authentication username. - Name of private key algorithm. - Private key data. - Private key signature. - - - - Called when type specific data need to be saved. - - - - - Gets the name of the authentication method. - - - The name of the method. - - - - - Gets the name of the public key algorithm. - - - The name of the public key algorithm. - - - - - Gets the public key data. - - - - - Gets or sets public key signature. - - - The signature. - - - - - Represents SSH_MSG_USERAUTH_SUCCESS message. - - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Represents SSH_MSG_CHANNEL_CLOSE message. - - - - - Base class for all channel specific SSH messages. - - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Gets or sets the local channel number. - - - The local channel number. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The local channel number. - - - - Represents SSH_MSG_CHANNEL_DATA message. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The local channel number. - Message data. - - - - Loads the data. - - - - - Saves the data. - - - - - Gets or sets message data. - - - The data. - - - - - Represents SSH_MSG_CHANNEL_EOF message. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The local channel number. - - - - Represents SSH_MSG_CHANNEL_EXTENDED_DATA message. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The local channel number. - - - - Loads the data. - - - - - Saves the data. - - - - - Gets message data type code. - - - - - Gets message data. - - - - - Represents SSH_MSG_CHANNEL_FAILURE message. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The local channel number. - - - - Represents SSH_MSG_CHANNEL_OPEN_CONFIRMATION message. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The local channel number. - Initial size of the window. - Maximum size of the packet. - The remote channel number. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the remote channel number. - - - - - Gets the initial size of the window. - - - The initial size of the window. - - - - - Gets the maximum size of the packet. - - - The maximum size of the packet. - - - - - Represents SSH_MSG_CHANNEL_OPEN_FAILURE message. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The local channel number. - The description. - The reason code. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets failure reason code. - - - - - Gets description for failure. - - - - - Gets message language. - - - - - List channel open failure reasons defined by the protocol. - - - - - SSH_OPEN_ADMINISTRATIVELY_PROHIBITED - - - - - SSH_OPEN_CONNECT_FAILED - - - - - SSH_OPEN_UNKNOWN_CHANNEL_TYPE - - - - - SSH_OPEN_RESOURCE_SHORTAGE - - - - - Base class for open channel messages - - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the type of the channel to open. - - - The type of the channel to open. - - - - - Represents SSH_MSG_CHANNEL_OPEN message. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The channel number. - Initial size of the window. - Maximum size of the packet. - The info. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the type of the channel. - - - The type of the channel. - - - - - Gets the initial size of the window. - - - The initial size of the window. - - - - - Gets the maximum size of the packet. - - - The maximum size of the packet. - - - - - Gets channel specific open information. - - - - - Used to open "direct-tcpip" channel type - - - - - Specifies channel open type - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The host to connect. - The port to connect. - The originator address. - The originator port. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the type of the channel to open. - - - The type of the channel to open. - - - - - Gets the host to connect. - - - - - Gets the port to connect. - - - - - Gets the originator address. - - - - - Gets the originator port. - - - - - Used to open "forwarded-tcpip" channel type - - - - - Specifies channel open type - - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the type of the channel to open. - - - The type of the channel to open. - - - - - Gets the connected address. - - - - - Gets the connected port. - - - - - Gets the originator address. - - - - - Gets the originator port. - - - - - Used to open "session" channel type - - - - - Specifies channel open type - - - - - Gets the type of the channel to open. - - - The type of the channel to open. - - - - - Used to open "x11" channel type - - - - - Specifies channel open type - - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the type of the channel to open. - - - The type of the channel to open. - - - - - Gets the originator address. - - - - - Gets the originator port. - - - - - Represents "break" type channel request information - - - - - Represents type specific information for channel request. - - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the name of the request. - - - The name of the request. - - - - - Gets or sets a value indicating whether reply message is needed. - - - true if reply message is needed; otherwise, false. - - - - - Channel request name - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Length of the break. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the name of the request. - - - The name of the request. - - - - - Gets break length in milliseconds. - - - - - Represents SSH_MSG_CHANNEL_REQUEST message. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the local channel. - The info. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the name of the request. - - - The name of the request. - - - - - Gets channel request data. - - - - - Represents "eow@openssh.com" type channel request information - - - - - Channel request name - - - - - Initializes a new instance of the class. - - - - - Gets the name of the request. - - - The name of the request. - - - - - Represents "env" type channel request information - - - - - Channel request name - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the variable. - The variable value. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the name of the request. - - - The name of the request. - - - - - Gets or sets the name of the variable. - - - The name of the variable. - - - - - Gets or sets the variable value. - - - The variable value. - - - - - Represents "exec" type channel request information - - - - - Channel request name - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The command. - is null. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the name of the request. - - - The name of the request. - - - - - Gets command to execute. - - - The command. - - - - - Gets the encoding. - - - The encoding. - - - - - Represents "exit-signal" type channel request information - - - - - Channel request name - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the signal. - if set to true then core is dumped. - The error message. - The language. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the name of the request. - - - The name of the request. - - - - - Gets the name of the signal. - - - The name of the signal. - - - - - Gets a value indicating whether core is dumped. - - - true if core is dumped; otherwise, false. - - - - - Gets the error message. - - - - - Gets message language. - - - - - Represents "exit-status" type channel request information - - - - - Channel request name. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The exit status number. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the name of the request. - - - The name of the request. - - - - - Gets the exit status number. - - - - - Represents "keepalive@openssh.com" type channel request information - - - - - Channel request name - - - - - Initializes a new instance of the class. - - - - - Gets the name of the request. - - - The name of the request. - - - - - Represents "pty-req" type channel request information - - - - - Channel request name - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The environment variable. - The columns. - The rows. - The width. - The height. - The terminal mode values. - - - - Called when type specific data need to be saved. - - - - - Gets the name of the request. - - - The name of the request. - - - - - Gets or sets the environment variable. - - - The environment variable. - - - - - Gets or sets the columns. - - - The columns. - - - - - Gets or sets the rows. - - - The rows. - - - - - Gets or sets the width of the pixel. - - - The width of the pixel. - - - - - Gets or sets the height of the pixel. - - - The height of the pixel. - - - - - Gets or sets the terminal mode. - - - The terminal mode. - - - - - Represents "shell" type channel request information - - - - - Channel request name - - - - - Initializes a new instance of the class. - - - - - Gets the name of the request. - - - The name of the request. - - - - - Represents "signal" type channel request information - - - - - Channel request name. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the signal. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the name of the request. - - - The name of the request. - - - - - Gets the name of the signal. - - - The name of the signal. - - - - - Represents "subsystem" type channel request information - - - - - Channel request name - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The subsystem. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the name of the request. - - - The name of the request. - - - - - Gets the name of the subsystem. - - - The name of the subsystem. - - - - - Represents "window-change" type channel request information - - - - - Channe request name - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The columns. - The rows. - The width. - The height. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the name of the request. - - - The name of the request. - - - - - Gets the columns. - - - - - Gets the rows. - - - - - Gets the width. - - - - - Gets the height. - - - - - Represents "x11-req" type channel request information - - - - - Channel request name - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - if set to true it is a single connection. - The protocol. - The cookie. - The screen number. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the name of the request. - - - The name of the request. - - - - - Gets or sets a value indicating whether it is a single connection. - - - true if it is a single connection; otherwise, false. - - - - - Gets or sets the authentication protocol. - - - The authentication protocol. - - - - - Gets or sets the authentication cookie. - - - The authentication cookie. - - - - - Gets or sets the screen number. - - - The screen number. - - - - - Represents "xon-xoff" type channel request information - - - - - Channel request type - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - if set to true [client can do]. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the name of the request. - - - The name of the request. - - - - - Gets or sets a value indicating whether client can do. - - - true if client can do; otherwise, false. - - - - - Represents SSH_MSG_CHANNEL_SUCCESS message. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The local channel number. - - - - Represents SSH_MSG_CHANNEL_SUCCESS message. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The local channel number. - The bytes to add. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets number of bytes to add to the window. - - - - - Represents SSH_MSG_GLOBAL_REQUEST message. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the request. - if set to true [want reply]. - - - - Initializes a new instance of the class. - - Name of the request. - if set to true [want reply]. - The address to bind. - The port to bind. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the name of the request. - - - The name of the request. - - - - - Gets a value indicating whether message reply should be sent.. - - - true if message reply should be sent; otherwise, false. - - - - - Gets the address to bind to. - - - - - Gets port number to bind to. - - - - - Specifies supported request names. - - - - - tcpip-forward - - - - - cancel-tcpip-forward - - - - - Represents SSH_MSG_REQUEST_FAILURE message. - - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Represents SSH_MSG_REQUEST_SUCCESS message. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The bound port. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the bound port. - - - - - Indicates that a class represents SSH message. This class cannot be inherited. - - - - - Initializes a new instance of the class. - - The name. - The number. - - - - Gets or sets message name as defined in RFC 4250. - - - The name. - - - - - Gets or sets message number as defined in RFC 4250. - - - The number. - - - - - Specifies list of supported services - - - - - ssh-userauth - - - - - ssh-connection - - - - - Represents SSH_MSG_DEBUG message. - - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets a value indicating whether the message to be always displayed. - - - true if the message always to be displayed; otherwise, false. - - - - - Gets debug message. - - - - - Gets message language. - - - - - Represents SSH_MSG_DISCONNECT message. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The reason code. - The message. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets disconnect reason code. - - - - - Gets disconnect description. - - - - - Gets message language. - - - - - Provides list of disconnect reason as specified by the protocol. - - - - - Disconnect reason is not provided. - - - - - SSH_DISCONNECT_HOST_NOT_ALLOWED_TO_CONNECT - - - - - SSH_DISCONNECT_PROTOCOL_ERROR - - - - - SSH_DISCONNECT_KEY_EXCHANGE_FAILED - - - - - SSH_DISCONNECT_RESERVED - - - - - SSH_DISCONNECT_MAC_ERROR - - - - - SSH_DISCONNECT_COMPRESSION_ERROR - - - - - SSH_DISCONNECT_SERVICE_NOT_AVAILABLE - - - - - SSH_DISCONNECT_PROTOCOL_VERSION_NOT_SUPPORTED - - - - - SSH_DISCONNECT_HOST_KEY_NOT_VERIFIABLE - - - - - SSH_DISCONNECT_CONNECTION_LOST - - - - - SSH_DISCONNECT_BY_APPLICATION - - - - - SSH_DISCONNECT_TOO_MANY_CONNECTIONS - - - - - SSH_DISCONNECT_AUTH_CANCELLED_BY_USER - - - - - SSH_DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE - - - - - SSH_DISCONNECT_ILLEGAL_USER_NAME - - - - - Represents SSH_MSG_IGNORE message. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The data. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets ignore message data if any. - - - - - Represents SSH_MSG_KEX_DH_GEX_GROUP message. - - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets or sets the safe prime. - - - The safe prime. - - - - - Gets or sets the generator for subgroup in GF(p). - - - The sub group. - - - - - Represents SSH_MSG_KEX_DH_GEX_INIT message. - - - - - Initializes a new instance of the class. - - The client exchange value. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the E value. - - - - - Represents SSH_MSG_KEX_DH_GEX_REPLY message. - - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets server public host key and certificates - - The host key. - - - - Gets the F value. - - - - - Gets the signature of H. - - The signature. - - - - Represents SSH_MSG_KEX_DH_GEX_REQUEST message. - - - - - Initializes a new instance of the class. - - The minimum. - The preferred. - The maximum. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets or sets the minimal size in bits of an acceptable group. - - - The minimum. - - - - - Gets or sets the preferred size in bits of the group the server will send. - - - The preferred. - - - - - Gets or sets the maximal size in bits of an acceptable group. - - - The maximum. - - - - - Represents SSH_MSG_KEXDH_INIT message. - - - - - Initializes a new instance of the class. - - The client exchange value. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the E value. - - - - - Represents SSH_MSG_KEXDH_REPLY message. - - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets server public host key and certificates - - The host key. - - - - Gets the F value. - - - - - Gets the signature of H. - - The signature. - - - - Represents SSH_MSG_KEXINIT message. - - - - - Initializes a new instance of the class. - - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets session cookie. - - - - - Gets or sets supported key exchange algorithms. - - - Supported key exchange algorithms. - - - - - Gets or sets supported server host key algorithms. - - - Supported server host key algorithms. - - - - - Gets or sets supported encryption algorithms client to server. - - - Supported encryption algorithms client to server. - - - - - Gets or sets supported encryption algorithms server to client. - - - Supported encryption algorithms server to client. - - - - - Gets or sets supported hash algorithms client to server. - - - Supported hash algorithms client to server. - - - - - Gets or sets supported hash algorithms server to client. - - - Supported hash algorithms server to client. - - - - - Gets or sets supported compression algorithms client to server. - - - Supported compression algorithms client to server. - - - - - Gets or sets supported compression algorithms server to client. - - - Supported compression algorithms server to client. - - - - - Gets or sets supported languages client to server. - - - Supported languages client to server. - - - - - Gets or sets supported languages server to client. - - - The languages server to client. - - - - - Gets or sets a value indicating whether first key exchange packet follows. - - - true if first key exchange packet follows; otherwise, false. - - - - - Gets or sets the reserved value. - - - The reserved value. - - - - - Represents SSH_MSG_KEXINIT message. - - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Represents SSH_MSG_SERVICE_ACCEPT message. - - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the name of the service. - - - The name of the service. - - - - - Represents SSH_MSG_SERVICE_REQUEST message. - - - - - Initializes a new instance of the class. - - Name of the service. - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets the name of the service. - - - The name of the service. - - - - - Represents SSH_MSG_UNIMPLEMENTED message. - - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Contains operation for working with NetConf server. - - - - - Holds SftpSession instance that used to communicate to the SFTP server - - - - - Initializes a new instance of the class. - - The connection info. - is null. - - - - Initializes a new instance of the class. - - Connection host. - Connection port. - Authentication username. - Authentication password. - is null. - is invalid, or is null or contains whitespace characters. - is not within and . - - - - Initializes a new instance of the class. - - Connection host. - Authentication username. - Authentication password. - is null. - is invalid, or is null or contains whitespace characters. - - - - Initializes a new instance of the class. - - Connection host. - Connection port. - Authentication username. - Authentication private key file(s) . - is null. - is invalid, -or- is null or contains whitespace characters. - is not within and . - - - - Initializes a new instance of the class. - - Connection host. - Authentication username. - Authentication private key file(s) . - is null. - is invalid, -or- is null or contains whitespace characters. - - - - Sends the receive RPC. - - The RPC. - Reply message to RPC request - Client is not connected. - - - - Sends the receive RPC. - - The XML. - Reply message to RPC request - - - - Sends the close RPC. - - Reply message to closing RPC request - Client is not connected. - - - - Called when client is connected to the server. - - - - - Called when client is disconnecting from the server. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged ResourceMessages. - - - - Gets or sets the operation timeout. - - The operation timeout. - - - - Gets NetConf server capabilities. - - Client is not connected. - - - - Gets NetConf client capabilities. - - Client is not connected. - - - - Gets or sets a value indicating whether [automatic message id handling]. - - - true if [automatic message id handling]; otherwise, false. - - - - - Base class for SSH subsystem implementations - - - - - Specifies a timeout to wait for operation to complete - - - - - Initializes a new instance of the SubsystemSession class. - - The session. - Name of the subsystem. - The operation timeout. - session - or is null. - - - - Connects subsystem on SSH channel. - - - - - Disconnects subsystem channel. - - - - - Sends data to the subsystem. - - The data to be sent. - - - - Called when channel is open. - - - - - Called when data is received. - - The data type code. - The data. - - - - Raises the error. - - The error. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Finalizes an instance of the class. - - - - - Occurs when an error occurred. - - - - - Occurs when session has been disconnected form the server. - - - - - Gets the channel number. - - - - - Initializes a new instance of the class. - - The session. - The operation timeout. - - - - Gets NetConf server capabilities. - - - - - Gets NetConf client capabilities. - - - - - Represents private key information - - - - - - - - Initializes a new instance of the class. - - The private key. - - - - Initializes a new instance of the class. - - Name of the file. - is null or empty. - This method calls internally, this method does not catch exceptions from . - - - - Initializes a new instance of the class. - - Name of the file. - The pass phrase. - is null or empty, or is null. - This method calls internally, this method does not catch exceptions from . - - - - Initializes a new instance of the class. - - The private key. - The pass phrase. - or is null. - - - - Opens the specified private key. - - The private key. - The pass phrase. - - - - Decrypts encrypted private key file data. - - The cipher info. - Encrypted data. - Decryption pass phrase. - Decryption binary salt. - Decrypted byte array. - cipherInfo - , , or is null. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged ResourceMessages. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged ResourceMessages. - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Gets the host key. - - - - - Reads next mpint data type from internal buffer where length specified in bits. - - mpint read. - - - - Implements certificate support for host algorithm. - - - - - Base class for SSH host algorithms. - - - - - Initializes a new instance of the class. - - The host key name. - - - - Signs the specified data. - - The data. - Signed data. - - - - Verifies the signature. - - The data. - The signature. - True is signature was successfully verifies; otherwise false. - - - - Gets the host key name. - - - - - Gets the host key data. - - - - - Initializes a new instance of the class. - - The host key name. - - - - Signs the specified data. - - The data. - Signed data. - - - - - Verifies the signature. - - The data. - The signature. - True if signature was successfully verified; otherwise false. - - - - - Gets the host key data. - - - - - Base class for asymmetric cipher implementations. - - - - - Base class for cipher implementation. - - - - - Encrypts the specified input. - - The input. - Encrypted data. - - - - Decrypts the specified input. - - The input. - Decrypted data. - - - - Populates buffer with big endian number representation. - - The number to convert. - The buffer. - - - - Populates buffer with big endian number representation. - - The number to convert. - The buffer. - The buffer offset. - - - - Converts big endian bytes into number. - - The buffer. - Converted . - - - - Converts big endian bytes into number. - - The buffer. - The buffer offset. - Converted . - - - - Converts big endian bytes into number. - - The buffer. - Converted . - - - - Converts big endian bytes into number. - - The buffer. - The buffer offset. - Converted . - - - - Populates buffer with big endian number representation. - - The number to convert. - The buffer. - - - - Populates buffer with big endian number representation. - - The number to convert. - The buffer. - The buffer offset. - - - - Populates buffer with little endian number representation. - - The number to convert. - The buffer. - - - - Populates buffer with little endian number representation. - - The number to convert. - The buffer. - The buffer offset. - - - - Converts little endian bytes into number. - - The buffer. - Converted . - - - - Converts little endian bytes into number. - - The buffer. - The buffer offset. - Converted . - - - - Converts little endian bytes into number. - - The buffer. - Converted . - - - - Converts little endian bytes into number. - - The buffer. - The buffer offset. - Converted . - - - - Populates buffer with little endian number representation. - - The number to convert. - The buffer. - - - - Populates buffer with little endian number representation. - - The number to convert. - The buffer. - The buffer offset. - - - - Gets the minimum data size. - - - The minimum data size. - - - - - Base class for block cipher implementations. - - - - - Base class for symmetric cipher implementations. - - - - - Initializes a new instance of the class. - - The key. - is null. - - - - Encrypts the specified region of the input byte array and copies the encrypted data to the specified region of the output byte array. - - The input data to encrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write encrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes encrypted. - - - - - Decrypts the specified region of the input byte array and copies the decrypted data to the specified region of the output byte array. - - The input data to decrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write decrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes decrypted. - - - - - Gets the key. - - - - - Gets the size of the block in bytes. - - - The size of the block in bytes. - - - - - Initializes a new instance of the class. - - The key. - Size of the block. - Cipher mode. - Cipher padding. - is null. - - - - Encrypts the specified data. - - The data. - Encrypted data - - - - Decrypts the specified data. - - The data. - Decrypted data - - - - Gets the minimum data size. - - - The minimum data size. - - - - - Gets the size of the block. - - - The size of the block. - - - - - Implements digital signature where where asymmetric cipher is used, - - - - - Base class for signature implementations - - - - - Verifies the signature. - - The input. - The signature. - True if signature was successfully verified; otherwise false. - - - - Creates the signature. - - The input. - Signed input data. - - - - Initializes a new instance of the class. - - The object identifier. - The cipher. - - - - Verifies the signature. - - The input. - The signature. - - True if signature was successfully verified; otherwise false. - - - - - Creates the signature. - - The input. - - Signed input data. - - - - - Hashes the specified input. - - The input. - Hashed data. - - - - Encodes hash using DER. - - The hash data. - DER Encoded byte array - - - - AES cipher implementation. - - - - - Initializes a new instance of the class. - - The key. - The mode. - The padding. - is null. - Keysize is not valid for this algorithm. - - - - Encrypts the specified region of the input byte array and copies the encrypted data to the specified region of the output byte array. - - The input data to encrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write encrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes encrypted. - - or is null. - or is too short. - - - - Decrypts the specified region of the input byte array and copies the decrypted data to the specified region of the output byte array. - - The input data to decrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write decrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes decrypted. - - or is null. - or is too short. - - - - Implements ARCH4 cipher algorithm - - - - - Base class of stream cipher algorithms. - - - - - Initializes a new instance of the class. - - The key. - is null. - - - - Holds the state of the RC4 engine - - - - - Initializes a new instance of the class. - - The key. - if set to true will disharged first 1536 bytes. - is null. - - - - Encrypts the specified region of the input byte array and copies the encrypted data to the specified region of the output byte array. - - The input data to encrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write encrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes encrypted. - - - - - Decrypts the specified region of the input byte array and copies the decrypted data to the specified region of the output byte array. - - The input data to decrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write decrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes decrypted. - - - - - Encrypts the specified input. - - The input. - - Encrypted data. - - - - - - Decrypts the specified input. - - The input. - - Decrypted data. - - - - - - Gets the minimum data size. - - - The minimum data size. - - - - - Blowfish cipher implementation. - - - - - The s-boxes - - - - - The s-boxes - - - - - The s-boxes - - - - - The s-boxes - - - - - The p-array - - - - - Initializes a new instance of the class. - - The key. - The mode. - The padding. - is null. - Keysize is not valid for this algorithm. - - - - Encrypts the specified region of the input byte array and copies the encrypted data to the specified region of the output byte array. - - The input data to encrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write encrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes encrypted. - - - - - Decrypts the specified region of the input byte array and copies the decrypted data to the specified region of the output byte array. - - The input data to decrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write decrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes decrypted. - - - - - apply the encryption cycle to each value pair in the table. - - The xl. - The xr. - The table. - - - - Implements CAST cipher algorithm - - - - - The rotating round key - - - - - The masking round key - - - - - Initializes a new instance of the class. - - The key. - The mode. - The padding. - is null. - Keysize is not valid for this algorithm. - - - - Encrypts the specified region of the input byte array and copies the encrypted data to the specified region of the output byte array. - - The input data to encrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write encrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes encrypted. - - - - - Decrypts the specified region of the input byte array and copies the decrypted data to the specified region of the output byte array. - - The input data to decrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write decrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes decrypted. - - - - - Sets the subkeys using the same nomenclatureas described in RFC2144. - - The key. - - - - The first of the three processing functions for the encryption and decryption. - - The input to be processed. - The mask to be used from Km[n]. - The rotation value to be used. - - - - - The second of the three processing functions for the encryption and decryption. - - The input to be processed. - The mask to be used from Km[n]. - The rotation value to be used. - - - - - The third of the three processing functions for the encryption and decryption. - - The input to be processed. - The mask to be used from Km[n]. - The rotation value to be used. - - - - - Does the 16 rounds to encrypt the block. - - The LH-32bits of the plaintext block. - The RH-32bits of the plaintext block. - The result. - - - - Base class for cipher mode implementations - - - - - Gets the cipher. - - - - - Gets the IV vector. - - - - - Holds block size of the cipher. - - - - - Initializes a new instance of the class. - - The iv. - - - - Initializes the specified cipher mode. - - The cipher. - - - - Encrypts the specified region of the input byte array and copies the encrypted data to the specified region of the output byte array. - - The input data to encrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write encrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes encrypted. - - - - - Decrypts the specified region of the input byte array and copies the decrypted data to the specified region of the output byte array. - - The input data to decrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write decrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes decrypted. - - - - - Base class for cipher padding implementations - - - - - Pads specified input to match block size. - - Size of the block. - The input. - Padded data array. - - - - Implements DES cipher algorithm. - - - - - Initializes a new instance of the class. - - The key. - The mode. - The padding. - is null. - - - - Encrypts the specified region of the input byte array and copies the encrypted data to the specified region of the output byte array. - - The input data to encrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write encrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes encrypted. - - - - - Decrypts the specified region of the input byte array and copies the decrypted data to the specified region of the output byte array. - - The input data to decrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write decrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes decrypted. - - - - - Generates the working key. - - if set to true [encrypting]. - The key. - Generated working key. - - - - Validates the key. - - - - - Performs DES function. - - The w key. - The input. - The in off. - The out bytes. - The out off. - - - - Implements CBC cipher mode - - - - - Initializes a new instance of the class. - - The iv. - - - - Encrypts the specified region of the input byte array and copies the encrypted data to the specified region of the output byte array. - - The input data to encrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write encrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes encrypted. - - - - - Decrypts the specified region of the input byte array and copies the decrypted data to the specified region of the output byte array. - - The input data to decrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write decrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes decrypted. - - - - - Implements CFB cipher mode - - - - - Initializes a new instance of the class. - - The iv. - - - - Encrypts the specified region of the input byte array and copies the encrypted data to the specified region of the output byte array. - - The input data to encrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write encrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes encrypted. - - - - - Decrypts the specified region of the input byte array and copies the decrypted data to the specified region of the output byte array. - - The input data to decrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write decrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes decrypted. - - - - - Implements CTR cipher mode - - - - - Initializes a new instance of the class. - - The iv. - - - - Encrypts the specified region of the input byte array and copies the encrypted data to the specified region of the output byte array. - - The input data to encrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write encrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes encrypted. - - - - - Decrypts the specified region of the input byte array and copies the decrypted data to the specified region of the output byte array. - - The input data to decrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write decrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes decrypted. - - - - - Implements OFB cipher mode - - - - - Initializes a new instance of the class. - - The iv. - - - - Encrypts the specified region of the input byte array and copies the encrypted data to the specified region of the output byte array. - - The input data to encrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write encrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes encrypted. - - - - - Decrypts the specified region of the input byte array and copies the decrypted data to the specified region of the output byte array. - - The input data to decrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write decrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes decrypted. - - - - - Implements PKCS5 cipher padding - - - - - Transforms the specified input. - - Size of the block. - The input. - - Padded data array. - - - - - Implements PKCS7 cipher padding - - - - - Transforms the specified input. - - Size of the block. - The input. - - Padded data array. - - - - - Implements RSA cipher algorithm. - - - - - Initializes a new instance of the class. - - The RSA key. - - - - Encrypts the specified data. - - The data. - Encrypted data. - - - - Decrypts the specified data. - - The data. - - Decrypted data. - - Only block type 01 or 02 are supported. - Thrown when decrypted block type is not supported. - - - - Implements Serpent cipher algorithm. - - - - - Initializes a new instance of the class. - - The key. - The mode. - The padding. - is null. - Keysize is not valid for this algorithm. - - - - Encrypts the specified region of the input byte array and copies the encrypted data to the specified region of the output byte array. - - The input data to encrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write encrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes encrypted. - - - - - Decrypts the specified region of the input byte array and copies the decrypted data to the specified region of the output byte array. - - The input data to decrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write decrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes decrypted. - - - - Expand a user-supplied key material into a session key. - - @param key The user-key bytes (multiples of 4) to use. - @exception ArgumentException - - - - S0 - { 3, 8,15, 1,10, 6, 5,11,14,13, 4, 2, 7, 0, 9,12 } - 15 terms. - - A. - The b. - The c. - The d. - - - - InvSO - {13, 3,11, 0,10, 6, 5,12, 1,14, 4, 7,15, 9, 8, 2 } - 15 terms. - - A. - The b. - The c. - The d. - - - - S1 - {15,12, 2, 7, 9, 0, 5,10, 1,11,14, 8, 6,13, 3, 4 } - 14 terms. - - A. - The b. - The c. - The d. - - - - InvS1 - { 5, 8, 2,14,15, 6,12, 3,11, 4, 7, 9, 1,13,10, 0 } - 14 steps. - - A. - The b. - The c. - The d. - - - - S2 - { 8, 6, 7, 9, 3,12,10,15,13, 1,14, 4, 0,11, 5, 2 } - 16 terms. - - A. - The b. - The c. - The d. - - - - InvS2 - {12, 9,15, 4,11,14, 1, 2, 0, 3, 6,13, 5, 8,10, 7 } - 16 steps. - - A. - The b. - The c. - The d. - - - - S3 - { 0,15,11, 8,12, 9, 6, 3,13, 1, 2, 4,10, 7, 5,14 } - 16 terms. - - A. - The b. - The c. - The d. - - - - InvS3 - { 0, 9,10, 7,11,14, 6,13, 3, 5,12, 2, 4, 8,15, 1 } - 15 terms - - A. - The b. - The c. - The d. - - - - S4 - { 1,15, 8, 3,12, 0,11, 6, 2, 5, 4,10, 9,14, 7,13 } - 15 terms. - - A. - The b. - The c. - The d. - - - - InvS4 - { 5, 0, 8, 3,10, 9, 7,14, 2,12,11, 6, 4,15,13, 1 } - 15 terms. - - A. - The b. - The c. - The d. - - - - S5 - {15, 5, 2,11, 4,10, 9,12, 0, 3,14, 8,13, 6, 7, 1 } - 16 terms. - - A. - The b. - The c. - The d. - - - - InvS5 - { 8,15, 2, 9, 4, 1,13,14,11, 6, 5, 3, 7,12,10, 0 } - 16 terms. - - A. - The b. - The c. - The d. - - - - S6 - { 7, 2,12, 5, 8, 4, 6,11,14, 9, 1,15,13, 3,10, 0 } - 15 terms. - - A. - The b. - The c. - The d. - - - - InvS6 - {15,10, 1,13, 5, 3, 6, 0, 4, 9,14, 7, 2,12, 8,11 } - 15 terms. - - A. - The b. - The c. - The d. - - - - S7 - { 1,13,15, 0,14, 8, 2,11, 7, 4,12,10, 9, 3, 5, 6 } - 16 terms. - - A. - The b. - The c. - The d. - - - - InvS7 - { 3, 0, 6,13, 9,14,15, 8, 5,12,11, 7,10, 1, 4, 2 } - 17 terms. - - A. - The b. - The c. - The d. - - - - Apply the linear transformation to the register set. - - - - - Apply the inverse of the linear transformation to the register set. - - - - - Implements 3DES cipher algorithm. - - - - - Initializes a new instance of the class. - - The key. - The mode. - The padding. - is null. - - - - Encrypts the specified region of the input byte array and copies the encrypted data to the specified region of the output byte array. - - The input data to encrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write encrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes encrypted. - - - - - Decrypts the specified region of the input byte array and copies the decrypted data to the specified region of the output byte array. - - The input data to decrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write decrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes decrypted. - - - - - Validates the key. - - - - - Implements Twofish cipher algorithm - - - - Define the fixed p0/p1 permutations used in keyed S-box lookup. - By changing the following constant definitions, the S-boxes will - automatically Get changed in the Twofish engine. - - - - Initializes a new instance of the class. - - The key. - The mode. - The padding. - is null. - Keysize is not valid for this algorithm. - - - - Encrypts the specified region of the input byte array and copies the encrypted data to the specified region of the output byte array. - - The input data to encrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write encrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes encrypted. - - - - - Decrypts the specified region of the input byte array and copies the decrypted data to the specified region of the output byte array. - - The input data to decrypt. - The offset into the input byte array from which to begin using data. - The number of bytes in the input byte array to use as data. - The output to which to write decrypted data. - The offset into the output byte array from which to begin writing data. - - The number of bytes decrypted. - - - - gSubKeys[] and gSBox[] are eventually used in the - encryption and decryption methods. - - - Use (12, 8) Reed-Solomon code over GF(256) to produce - a key S-box 32-bit entity from 2 key material 32-bit - entities. - - @param k0 first 32-bit entity - @param k1 second 32-bit entity - @return Remainder polynomial Generated using RS code - - - Reed-Solomon code parameters: (12,8) reversible code: -

-

-            G(x) = x^4 + (a+1/a)x^3 + ax^2 + (a+1/a)x + 1
-            
- where a = primitive root of field generator 0x14D -

-
- - - Implements DSA digital signature algorithm. - - - - - Initializes a new instance of the class. - - The DSA key. - key - - - - Verifies the signature. - - The input. - The signature. - - True if signature was successfully verified; otherwise false. - - Invalid signature. - - - - Creates the signature. - - The input. - - Signed input data. - - Invalid DSA key. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged ResourceMessages. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged ResourceMessages. - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Contains DSA private and public key - - - - - Base class for asymmetric cipher algorithms - - - - - Specifies array of big integers that represent private key - - - - - Initializes a new instance of the class. - - DER encoded private key data. - - - - Initializes a new instance of the class. - - - - - Signs the specified data with the key. - - The data to sign. - - Signed data. - - - - - Verifies the signature. - - The data to verify. - The signature to verify against. - True is signature was successfully verifies; otherwise false. - - - - Gets the key specific digital signature. - - - - - Gets or sets the public key. - - - The public. - - - - - Gets the length of the key. - - - The length of the key. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - DER encoded private key data. - - - - Initializes a new instance of the class. - - The p. - The q. - The g. - The y. - The x. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged ResourceMessages. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged ResourceMessages. - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Gets the P. - - - - - Gets the Q. - - - - - Gets the G. - - - - - Gets public key Y. - - - - - Gets private key X. - - - - - Gets the length of the key. - - - The length of the key. - - - - - Gets the digital signature. - - - - - Gets or sets the public. - - - The public. - - - - - MD5 algorithm implementation - - - - - Initializes a new instance of the class. - - - - - Routes data written to the object into the hash algorithm for computing the hash. - - The input to compute the hash code for. - The offset into the byte array from which to begin using data. - The number of bytes in the byte array to use as data. - - - - Finalizes the hash computation after the last data is processed by the cryptographic stream object. - - - The computed hash code. - - - - - Initializes an implementation of the class. - - - - - Gets the size, in bits, of the computed hash code. - - The size, in bits, of the computed hash code. - - - - Gets the input block size. - - The input block size. - - - - Gets the output block size. - - The output block size. - - - - Gets a value indicating whether the current transform can be reused. - - Always true. - - - - Gets a value indicating whether multiple blocks can be transformed. - - true if multiple blocks can be transformed; otherwise, false. - - - - SHA1 algorithm implementation - - - - - Initializes a new instance of the class. - - - - - Routes data written to the object into the hash algorithm for computing the hash. - - The input to compute the hash code for. - The offset into the byte array from which to begin using data. - The number of bytes in the byte array to use as data. - - - - Finalizes the hash computation after the last data is processed by the cryptographic stream object. - - - The computed hash code. - - - - - Initializes an implementation of the class. - - - - - Gets the size, in bits, of the computed hash code. - - The size, in bits, of the computed hash code. - - - - Gets the input block size. - - The input block size. - - - - Gets the output block size. - - The output block size. - - - - Gets a value indicating whether the current transform can be reused. - - Always true. - - - - Gets a value indicating whether multiple blocks can be transformed. - - true if multiple blocks can be transformed; otherwise, false. - - - - SHA256 algorithm implementation. - - - - - Initializes a new instance of the class. - - - - - Routes data written to the object into the hash algorithm for computing the hash. - - The input to compute the hash code for. - The offset into the byte array from which to begin using data. - The number of bytes in the byte array to use as data. - - - - Finalizes the hash computation after the last data is processed by the cryptographic stream object. - - - The computed hash code. - - - - - Initializes an implementation of the class. - - - - - The SHA-256 Constants (represent the first 32 bits of the fractional parts of the cube roots of the first sixty-four prime numbers) - - - - - Gets the size, in bits, of the computed hash code. - - The size, in bits, of the computed hash code. - - - - Gets the input block size. - - The input block size. - - - - Gets the output block size. - - The output block size. - - - - Gets a value indicating whether the current transform can be reused. - - Always true. - - - - Gets a value indicating whether multiple blocks can be transformed. - - true if multiple blocks can be transformed; otherwise, false. - - - - Provides HMAC algorithm implementation. - - Class that implements . - - - - Rfc 2104. - - The key. - - - - Initializes an implementation of the class. - - - - - Hashes the core. - - The RGB. - The ib. - The cb. - - - - Finalizes the hash computation after the last data is processed by the cryptographic stream object. - - - The computed hash code. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged ResourceMessages. - - - - Gets the size of the block. - - - The size of the block. - - - - - Gets or sets the key to use in the hash algorithm. - - The key to use in the hash algorithm. - - - - Implements RSA digital signature algorithm. - - - - - Initializes a new instance of the class. - - The RSA key. - - - - Hashes the specified input. - - The input. - - Hashed data. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged ResourceMessages. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged ResourceMessages. - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Contains RSA private and public key - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - DER encoded private key data. - - - - Initializes a new instance of the class. - - The modulus. - The exponent. - The d. - The p. - The q. - The inverse Q. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged ResourceMessages. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged ResourceMessages. - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Gets the modulus. - - - - - Gets the exponent. - - - - - Gets the D. - - - - - Gets the P. - - - - - Gets the Q. - - - - - Gets the DP. - - - - - Gets the DQ. - - - - - Gets the inverse Q. - - - - - Gets the length of the key. - - - The length of the key. - - - - - Gets the digital signature. - - - - - Gets or sets the public. - - - The public. - - - - - Represents "diffie-hellman-group14-sha1" algorithm implementation. - - - - - Gets algorithm name. - - - - - Gets the group prime. - - - The group prime. - - - - - Represents "diffie-hellman-group1-sha1" algorithm implementation. - - - - - Gets algorithm name. - - - - - Gets the group prime. - - - The group prime. - - - - - Represents "diffie-hellman-group-exchange-sha1" algorithm implementation. - - - - - Calculates key exchange hash value. - - - Key exchange hash. - - - - - Starts key exchange algorithm - - The session. - Key exchange init message. - - - - Finishes key exchange algorithm. - - - - - Gets algorithm name. - - - - - Represents "diffie-hellman-group-exchange-sha256" algorithm implementation. - - - - - Starts key exchange algorithm - - The session. - Key exchange init message. - - - - Finishes key exchange algorithm. - - - - - Calculates key exchange hash value. - - - Key exchange hash. - - - - - Hashes the specified data bytes. - - Data to hash. - - Hashed bytes - - - - - Gets algorithm name. - - - - - Implements key support for host algorithm. - - - - - Initializes a new instance of the class. - - Host key name. - Host key. - - - - Initializes a new instance of the class. - - Host key name. - Host key. - Host key encoded data. - - - - Signs the specified data. - - The data. - - Signed data. - - - - - Verifies the signature. - - The data. - The signature. - - True is signature was successfully verifies; otherwise false. - - - - - Gets the key. - - - - - Gets the public key data. - - - - - Called when type specific data need to be loaded. - - - - - Called when type specific data need to be saved. - - - - - Gets or sets the name of the algorithm. - - - The name of the algorithm. - - - - - Gets or sets the signature. - - - The signature. - - - - - Provides functionality to connect and interact with SSH server. - - - Provides functionality to connect and interact with SSH server. - - - - - Specifies maximum packet size defined by the protocol. - - - - - Specifies maximum payload size defined by the protocol. - - - - - Controls how many authentication attempts can take place at the same time. - - - Some server may restrict number to prevent authentication attacks - - - - - Holds metada about session messages - - - - - Holds connection socket. - - - - - Holds locker object for the socket - - - - - Holds reference to task that listens for incoming messages - - - - - Specifies outbound packet number - - - - - Specifies incoming packet number - - - - - WaitHandle to signal that last service request was accepted - - - - - WaitHandle to signal that exception was thrown by another thread. - - - - - WaitHandle to signal that key exchange was completed. - - - - - WaitHandle to signal that key exchange is in progress. - - - - - Exception that need to be thrown by waiting thread - - - - - Specifies whether connection is authenticated - - - - - Specifies whether user issued Disconnect command or not - - - - - Initializes a new instance of the class. - - The connection info. - - - - Connects to the server. - - - - - Disconnects from the server - - - - - Sends "keep alive" message to keep connection alive. - - - - - Waits for handle to signal while checking other handles as well including timeout check to prevent waiting for ever - - The wait handle. - - - - Sends packet message to the server. - - The message. - - - - Receives the message from the server. - - Incoming SSH message. - - - - - Handles the message. - - - The message. - - - - Called when received. - - message. - - - - Called when received. - - message. - - - - Called when message received. - - message. - - - - Called when message received. - - message. - - - - Called when message received. - - message. - - - - Called when message received. - - message. - - - - Called when message received. - - message. - - - - Called when message received. - - message. - - - - Called when message received. - - message. - - - - Called when message received. - - message. - - - - Called when message received. - - message. - - - - Called when message received. - - message. - - - - Called when message received. - - message. - - - - Called when message received. - - message. - - - - Called when message received. - - message. - - - - Called when message received. - - message. - - - - Called when message received. - - message. - - - - Called when message received. - - message. - - - - Called when message received. - - message. - - - - Called when message received. - - message. - - - - Called when message received. - - message. - - - - Called when message received. - - message. - - - - Called when message received. - - message. - - - - Called when message received. - - message. - - - - Called when message received. - - message. - - - - Called when message received. - - message. - - - - Called when message received. - - message. - - - - Reads the specified length of bytes from the server - - The length. - - - - - Registers SSH Message with the session. - - Name of the message. - - - - Removes SSH message from the session - - Name of the message. - - - - Loads the message. - - Message data. - New message - - - - Listens for incoming message from the server and handles them. This method run as a task on separate thread. - - - - - Raises the event. - - The exp. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged ResourceMessages. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged ResourceMessages. - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Function to read amount of data before returning, or throwing an exception. - - The amount wanted. - The buffer to read to. - Happens when the socket is closed. - Unhandled exception. - - - - Gets the session semaphore that controls session channels. - - The session semaphore. - - - - Gets the next channel number. - - The next channel number. - - - - Gets a value indicating whether socket connected. - - - true if socket connected; otherwise, false. - - - - - Gets or sets the session id. - - The session id. - - - - Gets the client init message. - - The client init message. - - - - Gets or sets the server version string. - - The server version. - - - - Gets or sets the client version string. - - The client version. - - - - Gets or sets the connection info. - - The connection info. - - - - Occurs when an error occurred. - - - - - Occurs when session has been disconnected form the server. - - - - - Occurs when host key received. - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received - - - - - Occurs when message received and is not handled by any of the event handlers - - - - - SSH_FXF_READ - - - - - SSH_FXF_WRITE - - - - - SSH_FXF_APPEND - - - - - SSH_FXF_CREAT - - - - - SSH_FXF_TRUNC - - - - - SSH_FXF_EXCL - - - - - Initializes a new instance of the class. - - The protocol version. - The request id. - Specifies the path name of the new link to create. - Specifies the path of a target object to which the newly created link will refer. In the case of a symbolic link, this path may not exist. - if set to false the link should be a hard link, or a second directory entry referring to the same file or directory object. - The status action. - - - - Encapsulates the results of an asynchronous download operation. - - - - - Initializes a new instance of the class. - - The async callback. - The state. - - - - Updates asynchronous operation status information. - - Number of downloaded bytes. - - - - Gets or sets a value indicating whether to cancel asynchronous download operation. - - - true if download operation to be canceled; otherwise, false. - - - Download operation will be canceled after finishing uploading current buffer. - - - - - Gets the number of downloaded bytes. - - - - - Represents SFTP file information - - - - - Initializes a new instance of the class. - - The SFTP session. - Full path of the directory or file. - Attributes of the directory or file. - or is null. - - - - Sets file permissions. - - The mode. - - - - Permanently deletes a file on remote machine. - - - - - Moves a specified file to a new location on remote machine, providing the option to specify a new file name. - - The path to move the file to, which can specify a different file name. - is null. - - - - Updates file status on the server. - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Gets the file attributes. - - - - - Gets the full path of the directory or file. - - - - - For files, gets the name of the file. For directories, gets the name of the last directory in the hierarchy if a hierarchy exists. - Otherwise, the Name property gets the name of the directory. - - - - - Gets or sets the time the current file or directory was last accessed. - - - The time that the current file or directory was last accessed. - - - - - Gets or sets the time when the current file or directory was last written to. - - - The time the current file was last written. - - - - - Gets or sets the time, in coordinated universal time (UTC), the current file or directory was last accessed. - - - The time that the current file or directory was last accessed. - - - - - Gets or sets the time, in coordinated universal time (UTC), when the current file or directory was last written to. - - - The time the current file was last written. - - - - - Gets or sets the size, in bytes, of the current file. - - - The size of the current file in bytes. - - - - - Gets or sets file user id. - - - File user id. - - - - - Gets or sets file group id. - - - File group id. - - - - - Gets a value indicating whether file represents a socket. - - - true if file represents a socket; otherwise, false. - - - - - Gets a value indicating whether file represents a symbolic link. - - - true if file represents a symbolic link; otherwise, false. - - - - - Gets a value indicating whether file represents a regular file. - - - true if file represents a regular file; otherwise, false. - - - - - Gets a value indicating whether file represents a block device. - - - true if file represents a block device; otherwise, false. - - - - - Gets a value indicating whether file represents a directory. - - - true if file represents a directory; otherwise, false. - - - - - Gets a value indicating whether file represents a character device. - - - true if file represents a character device; otherwise, false. - - - - - Gets a value indicating whether file represents a named pipe. - - - true if file represents a named pipe; otherwise, false. - - - - - Gets or sets a value indicating whether the owner can read from this file. - - - true if owner can read from this file; otherwise, false. - - - - - Gets or sets a value indicating whether the owner can write into this file. - - - true if owner can write into this file; otherwise, false. - - - - - Gets or sets a value indicating whether the owner can execute this file. - - - true if owner can execute this file; otherwise, false. - - - - - Gets or sets a value indicating whether the group members can read from this file. - - - true if group members can read from this file; otherwise, false. - - - - - Gets or sets a value indicating whether the group members can write into this file. - - - true if group members can write into this file; otherwise, false. - - - - - Gets or sets a value indicating whether the group members can execute this file. - - - true if group members can execute this file; otherwise, false. - - - - - Gets or sets a value indicating whether the others can read from this file. - - - true if others can read from this file; otherwise, false. - - - - - Gets or sets a value indicating whether the others can write into this file. - - - true if others can write into this file; otherwise, false. - - - - - Gets or sets a value indicating whether the others can execute this file. - - - true if others can execute this file; otherwise, false. - - - - - Gets the extension part of the file. - - - File extensions. - - - - - Contains SFTP file attributes. - - - - - Sets the permissions. - - The mode. - - - - Gets or sets the time the current file or directory was last accessed. - - - The time that the current file or directory was last accessed. - - - - - Gets or sets the time when the current file or directory was last written to. - - - The time the current file was last written. - - - - - Gets or sets the size, in bytes, of the current file. - - - The size of the current file in bytes. - - - - - Gets or sets file user id. - - - File user id. - - - - - Gets or sets file group id. - - - File group id. - - - - - Gets a value indicating whether file represents a socket. - - - true if file represents a socket; otherwise, false. - - - - - Gets a value indicating whether file represents a symbolic link. - - - true if file represents a symbolic link; otherwise, false. - - - - - Gets a value indicating whether file represents a regular file. - - - true if file represents a regular file; otherwise, false. - - - - - Gets a value indicating whether file represents a block device. - - - true if file represents a block device; otherwise, false. - - - - - Gets a value indicating whether file represents a directory. - - - true if file represents a directory; otherwise, false. - - - - - Gets a value indicating whether file represents a character device. - - - true if file represents a character device; otherwise, false. - - - - - Gets a value indicating whether file represents a named pipe. - - - true if file represents a named pipe; otherwise, false. - - - - - Gets a value indicating whether the owner can read from this file. - - - true if owner can read from this file; otherwise, false. - - - - - Gets a value indicating whether the owner can write into this file. - - - true if owner can write into this file; otherwise, false. - - - - - Gets a value indicating whether the owner can execute this file. - - - true if owner can execute this file; otherwise, false. - - - - - Gets a value indicating whether the group members can read from this file. - - - true if group members can read from this file; otherwise, false. - - - - - Gets a value indicating whether the group members can write into this file. - - - true if group members can write into this file; otherwise, false. - - - - - Gets a value indicating whether the group members can execute this file. - - - true if group members can execute this file; otherwise, false. - - - - - Gets a value indicating whether the others can read from this file. - - - true if others can read from this file; otherwise, false. - - - - - Gets a value indicating whether the others can write into this file. - - - true if others can write into this file; otherwise, false. - - - - - Gets a value indicating whether the others can execute this file. - - - true if others can execute this file; otherwise, false. - - - - - Gets or sets the extensions. - - - The extensions. - - - - - Exposes a System.IO.Stream around a remote SFTP file, supporting both synchronous and asynchronous read and write operations. - - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Begins an asynchronous read operation. - - The buffer to read the data into. - The byte offset in at which to begin writing data read from the stream. - The maximum number of bytes to read. - An optional asynchronous callback, to be called when the read is complete. - A user-provided object that distinguishes this particular asynchronous read request from other requests. - - An that represents the asynchronous read, which could still be pending. - - Attempted an asynchronous read past the end of the stream, or a disk error occurs. - - One or more of the arguments is invalid. - - Methods were called after the stream was closed. - - The current Stream implementation does not support the read operation. - - - - Waits for the pending asynchronous read to complete. - - The reference to the pending asynchronous request to finish. - - The number of bytes read from the stream, between zero (0) and the number of bytes you requested. Streams return zero (0) only at the end of the stream, otherwise, they should block until at least one byte is available. - - - is null. - - - did not originate from a method on the current stream. - - The stream is closed or an internal error has occurred. - - - - Begins an asynchronous write operation. - - The buffer to write data from. - The byte offset in from which to begin writing. - The maximum number of bytes to write. - An optional asynchronous callback, to be called when the write is complete. - A user-provided object that distinguishes this particular asynchronous write request from other requests. - - An IAsyncResult that represents the asynchronous write, which could still be pending. - - Attempted an asynchronous write past the end of the stream, or a disk error occurs. - - One or more of the arguments is invalid. - - Methods were called after the stream was closed. - - The current Stream implementation does not support the write operation. - - - - Ends an asynchronous write operation. - - A reference to the outstanding asynchronous I/O request. - - is null. - - - did not originate from a method on the current stream. - - The stream is closed or an internal error has occurred. - - - - Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. - - - - - Clears all buffers for this stream and causes any buffered data to be written to the file. - - An I/O error occurs. - Stream is closed. - - - - Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. - - An array of bytes. When this method returns, the buffer contains the specified byte array with the values between and ( + - 1) replaced by the bytes read from the current source. - The zero-based byte offset in at which to begin storing the data read from the current stream. - The maximum number of bytes to be read from the current stream. - - The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached. - - The sum of and is larger than the buffer length. - - - is null. - - - or is negative. - - An I/O error occurs. - - The stream does not support reading. - - Methods were called after the stream was closed. - - - - Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream. - - - The unsigned byte cast to an Int32, or -1 if at the end of the stream. - - The stream does not support reading. - - Methods were called after the stream was closed. - Read operation failed. - - - - Sets the position within the current stream. - - A byte offset relative to the parameter. - A value of type indicating the reference point used to obtain the new position. - - The new position within the current stream. - - An I/O error occurs. - - The stream does not support seeking, such as if the stream is constructed from a pipe or console output. - - Methods were called after the stream was closed. - - - - When overridden in a derived class, sets the length of the current stream. - - The desired length of the current stream in bytes. - An I/O error occurs. - - The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output. - - Methods were called after the stream was closed. - must be greater than zero. - - - - Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. - - An array of bytes. This method copies bytes from to the current stream. - The zero-based byte offset in at which to begin copying bytes to the current stream. - The number of bytes to be written to the current stream. - The sum of and is greater than the buffer length. - - - is null. - - - or is negative. - - An I/O error occurs. - - The stream does not support writing. - - Methods were called after the stream was closed. - - - - Writes a byte to the current position in the stream and advances the position within the stream by one byte. - - The byte to write to the stream. - An I/O error occurs. - - The stream does not support writing, or the stream is already closed. - - Methods were called after the stream was closed. - - - - Releases the unmanaged resources used by the and optionally releases the managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Flushes the read data from the buffer. - - - - - Flush any buffered write data to the file. - - - - - Setups the read. - - - - - Setups the write. - - - - - Gets a value indicating whether the current stream supports reading. - - true if the stream supports reading; otherwise, false. - - - - Gets a value indicating whether the current stream supports seeking. - - true if the stream supports seeking; otherwise, false. - - - - Gets a value indicating whether the current stream supports writing. - - true if the stream supports writing; otherwise, false. - - - - Gets the length in bytes of the stream. - - A long value representing the length of the stream in bytes. - A class derived from Stream does not support seeking. - Methods were called after the stream was closed. - IO operation failed. - - - - Gets or sets the position within the current stream. - - The current position within the stream. - - An I/O error occurs. - - The stream does not support seeking. - - Methods were called after the stream was closed. - - - - Gets a value indicating whether the FileStream was opened asynchronously or synchronously. - - - true if this instance is async; otherwise, false. - - - - - Gets the name of the FileStream that was passed to the constructor. - - - - - Gets the operating system file handle for the file that the current SftpFileStream object encapsulates. - - - - - Gets or sets the operation timeout. - - - The timeout. - - - - - Contains File system information exposed by statvfs@openssh.com request. - - - - - Initializes a new instance of the class. - - The bsize. - The frsize. - The blocks. - The bfree. - The bavail. - The files. - The ffree. - The favail. - The sid. - The flag. - The namemax. - - - - Gets the size of the block. - - - The size of the block. - - - - - Gets the total blocks. - - - The total blocks. - - - - - Gets the free blocks. - - - The free blocks. - - - - - Gets the available blocks. - - - The available blocks. - - - - - Gets the total nodes. - - - The total nodes. - - - - - Gets the free nodes. - - - The free nodes. - - - - - Gets the available nodes. - - - The available nodes. - - - - - Gets the sid. - - - The sid. - - - - - Gets a value indicating whether this instance is read only. - - - true if this instance is read only; otherwise, false. - - - - - Gets a value indicating whether [supports set uid]. - - - true if [supports set uid]; otherwise, false. - - - - - Gets the max name lenght. - - - The max name lenght. - - - - - Encapsulates the results of an asynchronous directory list operation. - - - - - Initializes a new instance of the class. - - The async callback. - The state. - - - - Updates asynchronous operation status information. - - The files read. - - - - Gets the number of files read so far. - - - - - SSH_FXP_INIT - - - - - SSH_FXP_VERSION - - - - - SSH_FXP_OPEN - - - - - SSH_FXP_CLOSE - - - - - SSH_FXP_READ - - - - - SSH_FXP_WRITE - - - - - SSH_FXP_LSTAT - - - - - SSH_FXP_FSTAT - - - - - SSH_FXP_SETSTAT - - - - - SSH_FXP_FSETSTAT - - - - - SSH_FXP_OPENDIR - - - - - SSH_FXP_READDIR - - - - - SSH_FXP_REMOVE - - - - - SSH_FXP_MKDIR - - - - - SSH_FXP_RMDIR - - - - - SSH_FXP_REALPATH - - - - - SSH_FXP_STAT - - - - - SSH_FXP_RENAME - - - - - SSH_FXP_READLINK - - - - - SSH_FXP_SYMLINK - - - - - SSH_FXP_LINK - - - - - SSH_FXP_BLOCK - - - - - SSH_FXP_UNBLOCK - - - - - SSH_FXP_STATUS - - - - - SSH_FXP_HANDLE - - - - - SSH_FXP_DATA - - - - - SSH_FXP_NAME - - - - - SSH_FXP_ATTRS - - - - - SSH_FXP_EXTENDED - - - - - SSH_FXP_EXTENDED_REPLY - - - - - Resolves path into absolute path on the server. - - Path to resolve. - Absolute path - - - - Performs SSH_FXP_OPEN request - - The path. - The flags. - if set to true returns null instead of throwing an exception. - File handle. - - - - Performs SSH_FXP_CLOSE request. - - The handle. - - - - Performs SSH_FXP_READ request. - - The handle. - The offset. - The length. - data array; null if EOF - - - - Performs SSH_FXP_WRITE request. - - The handle. - The offset. - The data to send. - The wait event handle if needed. - - - - Performs SSH_FXP_LSTAT request. - - The path. - if set to true returns null instead of throwing an exception. - - File attributes - - - - - Performs SSH_FXP_FSTAT request. - - The handle. - if set to true returns null instead of throwing an exception. - - File attributes - - - - - Performs SSH_FXP_SETSTAT request. - - The path. - The attributes. - - - - Performs SSH_FXP_FSETSTAT request. - - The handle. - The attributes. - - - - Performs SSH_FXP_OPENDIR request - - The path. - if set to true returns null instead of throwing an exception. - File handle. - - - - Performs SSH_FXP_READDIR request - - The handle. - - - - - Performs SSH_FXP_REMOVE request. - - The path. - - - - Performs SSH_FXP_MKDIR request. - - The path. - - - - Performs SSH_FXP_RMDIR request. - - The path. - - - - Performs SSH_FXP_REALPATH request - - The path. - if set to true returns null instead of throwing an exception. - - - - - Performs SSH_FXP_STAT request. - - The path. - if set to true returns null instead of throwing an exception. - - File attributes - - - - - Performs SSH_FXP_RENAME request. - - The old path. - The new path. - - - - Performs SSH_FXP_READLINK request. - - The path. - if set to true returns null instead of throwing an exception. - - - - - Performs SSH_FXP_SYMLINK request. - - The linkpath. - The targetpath. - - - - Performs posix-rename@openssh.com extended request. - - The old path. - The new path. - - - - Performs statvfs@openssh.com extended request. - - The path. - if set to true [null on error]. - - - - - Performs fstatvfs@openssh.com extended request. - - The file handle. - if set to true [null on error]. - - - - - - Performs hardlink@openssh.com extended request. - - The old path. - The new path. - - - - Gets remote working directory. - - - - - Gets SFTP protocol version. - - - - - Gets the next request id for sftp session. - - - - - Encapsulates the results of an asynchronous directory synchronization operation. - - - - - Initializes a new instance of the class. - - The async callback. - The state. - - - - Updates asynchronous operation status information. - - The files read. - - - - Gets the number of files read so far. - - - - - Encapsulates the results of an asynchronous upload operation. - - - - - Initializes a new instance of the class. - - The async callback. - The state. - - - - Updates asynchronous operation status information. - - Number of uploaded bytes. - - - - Gets or sets a value indicating whether to cancel asynchronous upload operation - - - true if upload operation to be canceled; otherwise, false. - - - Upload operation will be canceled after finishing uploading current buffer. - - - - - Gets the number of uploaded bytes. - - - - - SSH_FX_OK - - - - - SSH_FX_EOF - - - - - SSH_FX_NO_SUCH_FILE - - - - - SSH_FX_PERMISSION_DENIED - - - - - SSH_FX_FAILURE - - - - - SSH_FX_BAD_MESSAGE - - - - - SSH_FX_NO_CONNECTION - - - - - SSH_FX_CONNECTION_LOST - - - - - SSH_FX_OP_UNSUPPORTED - - - - - SSH_FX_INVALID_HANDLE - - - - - SSH_FX_NO_SUCH_PATH - - - - - SSH_FX_FILE_ALREADY_EXISTS - - - - - SSH_FX_WRITE_PROTECT - - - - - SSH_FX_NO_MEDIA - - - - - SSH_FX_NO_SPACE_ON_FILESYSTEM - - - - - SSH_FX_QUOTA_EXCEEDED - - - - - SSH_FX_UNKNOWN_PRINCIPAL - - - - - SSH_FX_LOCK_CONFLICT - - - - - SSH_FX_DIR_NOT_EMPTY - - - - - SSH_FX_NOT_A_DIRECTORY - - - - - SSH_FX_INVALID_FILENAME - - - - - SSH_FX_LINK_LOOP - - - - - SSH_FX_CANNOT_DELETE - - - - - SSH_FX_INVALID_PARAMETER - - - - - SSH_FX_FILE_IS_A_DIRECTORY - - - - - SSH_FX_BYTE_RANGE_LOCK_CONFLICT - - - - - SSH_FX_BYTE_RANGE_LOCK_REFUSED - - - - - SSH_FX_DELETE_PENDING - - - - - SSH_FX_FILE_CORRUPT - - - - - SSH_FX_OWNER_INVALID - - - - - SSH_FX_GROUP_INVALID - - - - - SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK - - - - - Represents instance of the SSH shell object - - - Represents instance of the SSH shell object - - - - - Initializes a new instance of the class. - - The session. - The input. - The output. - The extended output. - Name of the terminal. - The columns. - The rows. - The width. - The height. - The terminal mode. - Size of the buffer for output stream. - - - - Starts this shell. - - Shell is started. - - - - Stops this shell. - - Shell is not started. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged ResourceMessages. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged ResourceMessages. - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - is null. - - - - Gets a value indicating whether this shell is started. - - - true if started is started; otherwise, false. - - - - - Occurs when shell is starting. - - - - - Occurs when shell is started. - - - - - Occurs when shell is stopping. - - - - - Occurs when shell is stopped. - - - - - Occurs when an error occurred. - - - - - Provides client connection to SSH server. - - - - - Holds the list of forwarded ports - - - - - If true, causes the connectionInfo object to be disposed. - - - - - Initializes a new instance of the class. - - The connection info. - - - - - - - is null. - - - - Initializes a new instance of the class. - - Connection host. - Connection port. - Authentication username. - Authentication password. - is null. - is invalid, or is null or contains whitespace characters. - is not within and . - - - - Initializes a new instance of the class. - - Connection host. - Authentication username. - Authentication password. - - - - is null. - is invalid, or is null or contains whitespace characters. - - - - Initializes a new instance of the class. - - Connection host. - Connection port. - Authentication username. - Authentication private key file(s) . - - - - - is null. - is invalid, -or- is null or contains whitespace characters. - is not within and . - - - - Initializes a new instance of the class. - - Connection host. - Authentication username. - Authentication private key file(s) . - - - - - is null. - is invalid, -or- is null or contains whitespace characters. - - - - Called when client is disconnecting from the server. - - - - - Adds the forwarded port. - - The port. - - - - - Forwarded port is already added to a different client. - is null. - Client is not connected. - - - - Stops and removes the forwarded port from the list. - - Forwarded port. - is null. - - - - Creates the command to be executed. - - The command text. - object. - Client is not connected. - - - - Creates the command to be executed with specified encoding. - - The command text. - The encoding to use for results. - object which uses specified encoding. - TThis method will change current default encoding. - Client is not connected. - or is null. - - - - Creates and executes the command. - - The command text. - Returns an instance of with execution results. - This method internally uses asynchronous calls. - - - - - CommandText property is empty. - Invalid Operation - An existing channel was used to execute this command. - Asynchronous operation is already in progress. - Client is not connected. - is null. - - - - Creates the shell. - - The input. - The output. - The extended output. - Name of the terminal. - The columns. - The rows. - The width. - The height. - The terminal mode. - Size of the internal read buffer. - - Returns a representation of a object. - - - - - Creates the shell. - - The input. - The output. - The extended output. - Name of the terminal. - The columns. - The rows. - The width. - The height. - The terminal mode. - - Returns a representation of a object. - - - - - Creates the shell. - - The input. - The output. - The extended output. - - Returns a representation of a object. - - - - - Creates the shell. - - The encoding to use to send the input. - The input. - The output. - The extended output. - Name of the terminal. - The columns. - The rows. - The width. - The height. - The terminal mode. - Size of the internal read buffer. - - Returns a representation of a object. - - - - - Creates the shell. - - The encoding. - The input. - The output. - The extended output. - Name of the terminal. - The columns. - The rows. - The width. - The height. - The terminal modes. - - Returns a representation of a object. - - - - - Creates the shell. - - The encoding. - The input. - The output. - The extended output. - - Returns a representation of a object. - - - - - Creates the shell stream. - - Name of the terminal. - The columns. - The rows. - The width. - The height. - Size of the buffer. - - Reference to Created ShellStream object. - - - - - Creates the shell stream. - - Name of the terminal. - The columns. - The rows. - The width. - The height. - Size of the buffer. - The terminal mode values. - - Reference to Created ShellStream object. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged ResourceMessages. - - - - Gets the list of forwarded ports. - - - - - Represents SSH command that can be executed. - - - Represents SSH command that can be executed. - - - - - Initializes a new instance of the class. - - The session. - The command text. - The encoding. - Either , or is null. - - - - Begins an asynchronous command execution. - - - An that represents the asynchronous command execution, which could still be pending. - - - - - Asynchronous operation is already in progress. - Invalid operation. - CommandText property is empty. - Client is not connected. - Operation has timed out. - Asynchronous operation is already in progress. - CommandText property is empty. - - - - Begins an asynchronous command execution. - - An optional asynchronous callback, to be called when the command execution is complete. - - An that represents the asynchronous command execution, which could still be pending. - - Asynchronous operation is already in progress. - Invalid operation. - CommandText property is empty. - Client is not connected. - Operation has timed out. - Asynchronous operation is already in progress. - CommandText property is empty. - - - - Begins an asynchronous command execution. - - An optional asynchronous callback, to be called when the command execution is complete. - A user-provided object that distinguishes this particular asynchronous read request from other requests. - - An that represents the asynchronous command execution, which could still be pending. - - Asynchronous operation is already in progress. - Invalid operation. - CommandText property is empty. - Client is not connected. - Operation has timed out. - Asynchronous operation is already in progress. - CommandText property is empty. - - - - Begins an asynchronous command execution. 22 - - The command text. - An optional asynchronous callback, to be called when the command execution is complete. - A user-provided object that distinguishes this particular asynchronous read request from other requests. - - An that represents the asynchronous command execution, which could still be pending. - - Client is not connected. - Operation has timed out. - - - - Waits for the pending asynchronous command execution to complete. - - The reference to the pending asynchronous request to finish. - Command execution result. - - - - Either the IAsyncResult object did not come from the corresponding async method on this type, or EndExecute was called multiple times with the same IAsyncResult. - Either the IAsyncResult object did not come from the corresponding async method on this type, or EndExecute was called multiple times with the same IAsyncResult. - - - - Executes command specified by property. - - Command execution result - - - - - - Client is not connected. - Operation has timed out. - - - - Cancels command execution in asynchronous scenarios. - - - - - Executes the specified command text. - - The command text. - Command execution result - Client is not connected. - Operation has timed out. - - - Command '{0}' has timed out. - The actual command will be included in the exception message. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged ResourceMessages. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged ResourceMessages. - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - is null. - - - - Gets the command text. - - - - - Gets or sets the command timeout. - - - The command timeout. - - - - - - - - Gets the command exit status. - - - - - - - - Gets the output stream. - - - - - - - - Gets the extended output stream. - - - - - - - - Gets the command execution result. - - - - - - - - Gets the command execution error. - - - - - -
-
diff --git a/packages/FAKE.4.11.3/tools/Serilog.FullNetFx.dll b/packages/FAKE.4.11.3/tools/Serilog.FullNetFx.dll deleted file mode 100644 index a3c0faa..0000000 Binary files a/packages/FAKE.4.11.3/tools/Serilog.FullNetFx.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/Serilog.FullNetFx.xml b/packages/FAKE.4.11.3/tools/Serilog.FullNetFx.xml deleted file mode 100644 index 68a1c92..0000000 --- a/packages/FAKE.4.11.3/tools/Serilog.FullNetFx.xml +++ /dev/null @@ -1,414 +0,0 @@ - - - - Serilog.FullNetFx - - - - - Holds ambient properties that can be attached to log events. To - configure, use the - extension method. - - - Configuration: - - var log = new LoggerConfiguration() - .Enrich.FromLogContext() - ... - - Usage: - - using (LogContext.PushProperty("MessageId", message.Id)) - { - Log.Information("The MessageId property will be attached to this event"); - } - - - The scope of the context is the current logical thread, using - (and so is - preserved across async/await calls). - - - - When calling into appdomains without Serilog loaded, e.g. via remoting or during unit testing, - it may be necesary to set this value to true so that serialization exceptions are avoided. When possible, - using the method in a using block around the call has a lower overhead and - should be preferred. - - - - - Push a property onto the context, returning an - that can later be used to remove the property, along with any others that - may have been pushed on top of it and not yet popped. The property must - be popped from the same thread/logical call context. - - The name of the property. - The value of the property. - A handle to later remove the property from the context. - If true, and the value is a non-primitive, non-array type, - then the value will be converted to a structure; otherwise, unknown types will - be converted to scalars, which are generally stored as strings. - A token that must be disposed, in order, to pop properties back off the stack. - - - - Push multiple properties onto the context, returning an - that can later be used to remove the properties. The properties must - be popped from the same thread/logical call context. - - Log Properties to push onto the log context - A token that must be disposed, in order, to pop properties back off the stack. - - - - - Remove all data from the context so that - cross- calls can be made without requiring - Serilog assemblies to be present in the remote domain. - - A token that will restore the suspended log context data, if any. - The should not be manipulated further - until the return value from this method has been disposed. - - - - - Enriches log events with a ProcessId property containing the current . - - - - - The property name added to enriched log events. - - - - - Enrich the log event. - - The log event to enrich. - Factory for creating new properties to add to the event. - - - - Enriches log events with a MachineName property containing . - - - - - The property name added to enriched log events. - - - - - Enrich the log event. - - The log event to enrich. - Factory for creating new properties to add to the event. - - - - Enriches log events with a ThreadId property containing the current . - - - - - The property name added to enriched log events. - - - - - Enrich the log event. - - The log event to enrich. - Factory for creating new properties to add to the event. - - - - Extends to add Full .NET Framework - capabilities. - - - - - Writes log events to . - - Logger sink configuration. - The minimum level for - events passed through the sink. - A message template describing the format used to write to the sink. - the default is "{Timestamp} [{Level}] {Message}{NewLine}{Exception}". - Supplies culture-specific formatting information, or null. - Configuration object allowing method chaining. - - - - Writes log events to , using color to differentiate - between levels. - - Logger sink configuration. - The minimum level for - events passed through the sink. - A message template describing the format used to write to the sink. - the default is "{Timestamp} [{Level}] {Message}{NewLine}{Exception}". - Supplies culture-specific formatting information, or null. - Configuration object allowing method chaining. - - - - Write log events in a simple text dump format to the specified file. - - Logger sink configuration. - Path to the dump file. - The minimum level for - events passed through the sink. - Configuration object allowing method chaining. - - - - Write log events to the specified file. - - Logger sink configuration. - Path to the file. - The minimum level for - events passed through the sink. - Supplies culture-specific formatting information, or null. - A message template describing the format used to write to the sink. - the default is "{Timestamp} [{Level}] {Message}{NewLine}{Exception}". - The maximum size, in bytes, to which a log file will be allowed to grow. - For unrestricted growth, pass null. The default is 1 GB. - Configuration object allowing method chaining. - The file will be written using the UTF-8 character set. - - - - Write log events to a series of files. Each file will be named according to - the date of the first log entry written to it. Only simple date-based rolling is - currently supported. - - Logger sink configuration. - String describing the location of the log files, - with {Date} in the place of the file date. E.g. "Logs\myapp-{Date}.log" will result in log - files such as "Logs\myapp-2013-10-20.log", "Logs\myapp-2013-10-21.log" and so on. - The minimum level for - events passed through the sink. - A message template describing the format used to write to the sink. - the default is "{Timestamp} [{Level}] {Message}{NewLine}{Exception}". - Supplies culture-specific formatting information, or null. - The maximum size, in bytes, to which any single log file will be allowed to grow. - For unrestricted growth, pass null. The default is 1 GB. - The maximum number of log files that will be retained, - including the current log file. For unlimited retention, pass null. The default is 31. - Configuration object allowing method chaining. - The file will be written using the UTF-8 character set. - - - - Write log events to the . - - Logger sink configuration. - The minimum level for - events passed through the sink. - A message template describing the format used to write to the sink. - the default is "{Timestamp} [{Level}] {Message}{NewLine}{Exception}". - Supplies culture-specific formatting information, or null. - Configuration object allowing method chaining. - - - - Enrich log events with properties from . - - Logger enrichment configuration. - Configuration object allowing method chaining. - - - - - Enrich log events with a ThreadId property containing the current . - - Logger enrichment configuration. - Configuration object allowing method chaining. - - - - - Enrich log events with a ProcessId property containing the current . - - Logger enrichment configuration. - Configuration object allowing method chaining. - - - - Enrich log events with a MachineName property containing the current . - - Logger enrichment configuration. - Configuration object allowing method chaining. - - - - Reads the <appSettings> element of App.config or Web.config, searching for for keys - that look like: serilog:*, which are used to configure - the logger. To add a sink, use a key like serilog:write-to:File.path for - each parameter to the sink's configuration method. To add an additional assembly - containing sinks, use serilog:using. To set the level use - serilog:minimum-level. - - Logger setting configuration - An object allowing configuration to continue. - - - - Write log events to a disk file. - - - - Construct a . - Path to the file. - Formatter used to convert log events to text. - The maximum size, in bytes, to which a log file will be allowed to grow. - For unrestricted growth, pass null. The default is 1 GB. - Character encoding used to write the text file. The default is UTF-8. - Configuration object allowing method chaining. - The file will be written using the UTF-8 character set. - - - - - Emit the provided log event to the sink. - - The log event to write. - - - - Performs application-defined tasks associated with freeing, releasing, or - resetting unmanaged resources. - - - - - An instance of this sink may be substituted when an instance of the - is unable to be constructed. - - - - - Manages reconnection period and transient fault response for . - During normal operation an object of this type will simply echo the configured batch transmission - period. When availabilty fluctuates, the class tracks the number of failed attempts, each time - increasing the interval before reconnection is attempted (up to a set maximum) and at predefined - points indicating that either the current batch, or entire waiting queue, should be dropped. This - Serves two purposes - first, a loaded receiver may need a temporary reduction in traffic while coming - back online. Second, the sender needs to account for both bad batches (the first fault response) and - also overproduction (the second, queue-dropping response). In combination these should provide a - reasonable delivery effort but ultimately protect the sender from memory exhaustion. - - - Currently used only by , but may - provide the basis for a "smart" exponential backoff timer. There are other factors to consider - including the desire to send batches "when full" rather than continuing to buffer, and so-on. - - - - - Base class for sinks that log events in batches. Batching is - triggered asynchronously on a timer. - - - To avoid unbounded memory growth, events are discarded after attempting - to send a batch, regardless of whether the batch succeeded or not. Implementers - that want to change this behavior need to either implement from scratch, or - embed retry logic in the batch emitting functions. - - - - - Construct a sink posting to the specified database. - - The maximum number of events to include in a single batch. - The time to wait between checking for event batches. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - 2 - - - - Free resources held by the sink. - - If true, called because the object is being disposed; if false, - the object is being disposed from the finalizer. - - - - Emit a batch of log events, running to completion synchronously. - - The events to emit. - - - - Emit the provided log event to the sink. If the sink is being disposed or - the app domain unloaded, then the event is ignored. - - Log event to emit. - The event is null. - - The sink implements the contract that any events whose Emit() method has - completed at the time of sink disposal will be flushed (or attempted to, - depending on app domain state). - - - - - Determine whether a queued log event should be included in the batch. If - an override returns false, the event will be dropped. - - - - - - - Allows derived sinks to perform periodic work without requiring additional threads - or timers (thus avoiding additional flush/shut-down complexity). - - - - - Write log events to a series of files. Each file will be named according to - the date of the first log entry written to it. Only simple date-based rolling is - currently supported. - - - - Construct a . - String describing the location of the log files, - with {Date} in the place of the file date. E.g. "Logs\myapp-{Date}.log" will result in log - files such as "Logs\myapp-2013-10-20.log", "Logs\myapp-2013-10-21.log" and so on. - Formatter used to convert log events to text. - The maximum size, in bytes, to which a log file will be allowed to grow. - For unrestricted growth, pass null. The default is 1 GB. - The maximum number of log files that will be retained, - including the current log file. For unlimited retention, pass null. The default is 31. - Character encoding used to write the text file. The default is UTF-8. - Configuration object allowing method chaining. - The file will be written using the UTF-8 character set. - - - - Emit the provided log event to the sink. - - The log event to write. - Events that come in out-of-order (e.g. around the rollovers) - may end up written to a later file than their timestamp - would indicate. - - - - Performs application-defined tasks associated with freeing, releasing, or - resetting unmanaged resources. - - - - diff --git a/packages/FAKE.4.11.3/tools/Serilog.dll b/packages/FAKE.4.11.3/tools/Serilog.dll deleted file mode 100644 index 57abe3b..0000000 Binary files a/packages/FAKE.4.11.3/tools/Serilog.dll and /dev/null differ diff --git a/packages/FAKE.4.11.3/tools/Serilog.xml b/packages/FAKE.4.11.3/tools/Serilog.xml deleted file mode 100644 index d9ea771..0000000 --- a/packages/FAKE.4.11.3/tools/Serilog.xml +++ /dev/null @@ -1,2360 +0,0 @@ - - - - Serilog - - - - - Implemented on types that apply settings to a logger configuration. - - - - - Apply the settings to the logger configuration. - - The logger configuration to apply settings to. - - - - Controls template parameter destructuring configuration. - - - - - Treat objects of the specified type as scalar values, i.e., don't break - them down into properties event when destructuring complex types. - - Type to treat as scalar. - Configuration object allowing method chaining. - - - - Treat objects of the specified type as scalar values, i.e., don't break - them down into properties event when destructuring complex types. - - Type to treat as scalar. - Configuration object allowing method chaining. - - - - When destructuring objects, transform instances with the provided policies. - - Policies to apply when destructuring. - Configuration object allowing method chaining. - - - - When destructuring objects, transform instances with the provided policy. - - Policy to apply when destructuring. - Configuration object allowing method chaining. - - - - When destructuring objects, transform instances of the specified type with - the provided function. - - Function mapping instances of - to an alternative representation. - Type of values to transform. - Configuration object allowing method chaining. - - - - - When destructuring objects, depth will be limited to 5 property traversals deep to - guard against ballooning space when recursive/cyclic structures are accidentally passed. To - increase this limit pass a higher value. - - The maximum depth to use. - Configuration object allowing method chaining. - - - - - Controls filter configuration. - - - - - Filter out log events from the stream based on the provided filter. - - The filters to apply. - Configuration object allowing method chaining. - - - - Filter out log events from the stream based on the provided filter. - - The filters to apply. - Configuration object allowing method chaining. - - - - Filter out log events that match a predicate. - - Function that returns true when an event - should be excluded (silenced). - Configuration object allowing method chaining. - - - - Filter log events to include only those that match a predicate. - - Function that returns true when an event - should be included (emitted). - Configuration object allowing method chaining. - - - - Controls enrichment configuration. - - - - - Specifies one or more enrichers that may add properties dynamically to - log events. - - Enrichers to apply to all events passing through - the logger. - Configuration object allowing method chaining. - - - - Specifies an enricher that may add properties dynamically to - log events. - - Enricher type to apply to all events passing through - the logger. - Configuration object allowing method chaining. - - - - Include the specified property value in all events logged to the logger. - - The name of the property to add. - The property value to add. - If true, objects of unknown type will be logged as structures; otherwise they will be converted using . - Configuration object allowing method chaining. - - - - Controls sink configuration. - - - - - Sets the minimum level at which events will be passed to sinks. - - The minimum level to set. - Configuration object allowing method chaining. - - - - Sets the minimum level to be dynamically controlled by the provided switch. - - The switch. - Configuration object allowing method chaining. - - - - Anything and everything you might want to know about - a running block of code. - - - - - Internal system events that aren't necessarily - observable from the outside. - - - - - The lifeblood of operational intelligence - things - happen. - - - - - Service is degraded or endangered. - - - - - Functionality is unavailable, invariants are broken - or data is lost. - - - - - If you have a pager, it goes off when one of these - occurs. - - - - - Allows additional setting sources to drive the logger configuration. - - - - - Apply external settings to the logger configuration. - - Configuration object allowing method chaining. - - - - Apply settings specified in the Serilog key-value setting format to the logger configuration. - - A list of key-value pairs describing logger settings. - Configuration object allowing method chaining. - - - - Controls sink configuration. - - - - - Write log events to the specified . - - The sink. - The minimum level for - events passed through the sink. - Configuration object allowing method chaining. - - - - Write log events to the specified . - - The sink. - The minimum level for - events passed through the sink. - Configuration object allowing method chaining. - - - - Write log events to the provided . - - The text writer to write log events to. - Message template describing the output format. - The minimum level for - events passed through the sink. - Configuration object allowing method chaining. - Supplies culture-specific formatting information, or null. - - - - - Write log events to a sub-logger, where further processing may occur. Events through - the sub-logger will be constrained by filters and enriched by enrichers that are - active in the parent. A sub-logger cannot be used to log at a more verbose level, but - a less verbose level is possible. - - An action that configures the sub-logger. - The minimum level for - events passed through the sink. - Configuration object allowing method chaining. - - - - Write log events to a sub-logger, where further processing may occur. Events through - the sub-logger will be constrained by filters and enriched by enrichers that are - active in the parent. A sub-logger cannot be used to log at a more verbose level, but - a less verbose level is possible. - - The sub-logger. This will not be shut down automatically when the - parent logger is disposed. - The minimum level for - events passed through the sink. - Configuration object allowing method chaining. - - - - Write events to Rx observers. - - An action that provides an observable - to which observers can subscribe. - The minimum level for - events passed through the sink. - Configuration object allowing method chaining. - - - - Constants used in the core logging pipeline and associated types. - - - - - The name of the property included in the emitted log events - when ForContext<T>() and overloads are - applied. - - - - - Adds a new property encricher to the log event. - - - - - Create a new property enricher. - - The name of the property. - The value of the property. - A handle to later remove the property from the context. - If true, and the value is a non-primitive, non-array type, - then the value will be converted to a structure; otherwise, unknown types will - be converted to scalars, which are generally stored as strings. - - - - - - Enrich the log event. - - The log event to enrich. - Factory for creating new properties to add to the event. - - - - Determine how a simple value is carried through the logging - pipeline as an immutable . - - - - - If supported, convert the provided value into an immutable scalar. - - The value to convert. - Recursively apply policies to convert additional values. - The converted value, or null. - True if the value could be converted under this policy. - - - - Dynamically controls logging level. - - - - - Create a at the initial - minimum level. - - The initial level to which the switch is set. - - - - The current minimum level, below which no events - should be generated. - - - - - Indicates that the marked method logs data using a message template and (optional) arguments. - The name of the parameter which contains the message template should be given in the constructor. - - - - [LoggerMethod("messageTemplate")] - public void Information(string messageTemplate, params object[] propertyValues) - { - // Do something - } - - public void Foo() - { - Information("Hello, {Name}!") // Warning: Non-existing argument in message template. - } - - - - - - Initializes a new instance of the class. - - Name of the message template parameter. - - - - Gets the name of the message template parameter. - - The name of the message template parameter. - - - - Forwards log events to another logging pipeline. Copies the events so - that mutations performed on the copies do not affect the originals. - - The properties dictionary is copied, however the values within - the dictionary (of type are expected to - be immutable. - - - - Determine how, when destructuring, a supplied value is represented - as a complex log event property. - - - - - If supported, destructure the provided value. - - The value to destructure. - Recursively apply policies to destructure additional values. - The destructured value, or null. - True if the value could be destructured under this policy. - - - - Provides filtering of the log event stream. - - - - - Returns true if the provided event is enabled. Otherwise, false. - - The event to test. - True if the event is enabled by this filter. If false - is returned, the event will not be emitted. - - - - Creates log event properties from regular .NET objects, applying policies as - required. - - - - - Construct a with the specified name and value. - - The name of the property. - The value of the property. - If true, and the value is a non-primitive, non-array type, - then the value will be converted to a structure; otherwise, unknown types will - be converted to scalars, which are generally stored as strings. - - - - - Supports the policy-driven construction of s given - regular .NET objects. - - - - - Create a given a .NET object and destructuring - strategy. - - The value of the property. - If true, and the value is a non-primitive, non-array type, - then the value will be converted to a structure; otherwise, unknown types will - be converted to scalars, which are generally stored as strings. - The value. - - - - A destination for log events. - - - - - Emit the provided log event to the sink. - - The log event to write. - - - - Applied during logging to add additional information to log events. - - - - - Enrich the log event. - - The log event to enrich. - Factory for creating new properties to add to the event. - - - - A value represented as a mapping from keys to values. - - - - - Create a with the provided . - - The key-value mappings represented in the dictionary. - - - - - The dictionary mapping. - - - - - Render the value to the output. - - The output. - A format string applied to the value, or null. - A format provider to apply to the value, or null to use the default. - . - - - - Descriptive aliases for . - - These do not appear as members of the enumeration - as duplicated underlying values result in issues when presenting - enum values with . - - - - The least significant level of event. - - - - - The most significant level of event. - - - - - Represents a message template passed to a log method. The template - can subsequently render the template in textual form given the list - of properties. - - - - - Construct a message template using manually-defined text and property tokens. - - The text and property tokens defining the template. - - - - Construct a message template using manually-defined text and property tokens. - - The full text of the template; used by Serilog internally to avoid unneeded - string concatenation. - The text and property tokens defining the template. - - - - The raw text describing the template. - - - - - Render the template as a string. - - The string representation of the template. - - - - The tokens parsed from the template. - - - - - Convert the message template into a textual message, given the - properties matching the tokens in the message template. - - Properties matching template tokens. - Supplies culture-specific formatting information, or null. - The message created from the template and properties. If the - properties are mismatched with the template, the template will be - returned with incomplete substitution. - - - - Convert the message template into a textual message, given the - properties matching the tokens in the message template. - - Properties matching template tokens. - The message created from the template and properties. If the - properties are mismatched with the template, the template will be - returned with incomplete substitution. - Supplies culture-specific formatting information, or null. - - - - A log event. - - - - - Construct a new . - - The time at which the event occurred. - The level of the event. - An exception associated with the event, or null. - The message template describing the event. - Properties associated with the event, including those presented in . - - - - The time at which the event occurred. - - - - - The level of the event. - - - - - The message template describing the event. - - - - - Render the message template to the specified output, given the properties associated - with the event. - - The output. - Supplies culture-specific formatting information, or null. - - - - Render the message template given the properties associated - with the event, and return the result. - - Supplies culture-specific formatting information, or null. - - - - Properties associated with the event, including those presented in . - - - - - An exception associated with the event, or null. - - - - - Add a property to the event if not already present, otherwise, update its value. - - The property to add or update. - - - - - Add a property to the event if not already present. - - The property to add. - - - - - Remove a property from the event, if present. Otherwise no action - is performed. - - The name of the property to remove. - - - - Specifies the meaning and relative importance of a log event. - - - - - Anything and everything you might want to know about - a running block of code. - - - - - Internal system events that aren't necessarily - observable from the outside. - - - - - The lifeblood of operational intelligence - things - happen. - - - - - Service is degraded or endangered. - - - - - Functionality is unavailable, invariants are broken - or data is lost. - - - - - If you have a pager, it goes off when one of these - occurs. - - - - - A property associated with a . - - - - - Construct a with the specified name and value. - - The name of the property. - The value of the property. - - - - - - The name of the property. - - - - - The value of the property. - - - - - Test to determine if it is a valid property name. - - The name to check. - True if the name is valid; otherwise, false. - - - - A value represented as a collection of name-value properties. - - - - - Construct a with the provided properties. - - Optionally, a piece of metadata describing the "type" of the - structure. - The properties of the structure. - - - - - A piece of metadata describing the "type" of the - structure, or null. - - - - - The properties of the structure. - - Not presented as a dictionary because dictionary construction is - relatively expensive; it is cheaper to build a dictionary over properties only - when the structure is of interest. - - - - Render the value to the output. - - The output. - A format string applied to the value, or null. - A format provider to apply to the value, or null to use the default. - . - - - - A value represented as an ordered sequence of values. - - - - - Create a with the provided . - - The elements of the sequence. - - - - - The elements of the sequence. - - - - - Render the value to the output. - - The output. - A format string applied to the value, or null. - A format provider to apply to the value, or null to use the default. - . - - - - A property value corresponding to a simple, scalar type. - - - - - Construct a with the specified - value. - - The value, which may be null. - - - - The value, which may be null. - - - - - Render the value to the output. - - The output. - A format string applied to the value, or null. - A format provider to apply to the value, or null to use the default. - . - - - - Determine if this instance is equal to . - - The instance to compare with. - True if the instances are equal; otherwise, false. - - - - Get a hash code representing the value. - - The instance's hash code. - - - - The value associated with a . Divided into scalar, - sequence and structure values to direct serialization into various formats. - - - - - Render the value to the output. - - The output. - A format string applied to the value, or null. - A format provider to apply to the value, or null to use the default. - . - - - - Returns a string that represents the current object. - - - A string that represents the current object. - - 2 - - - - Formats the value of the current instance using the specified format. - - - The value of the current instance in the specified format. - - The format to use.-or- A null reference (Nothing in Visual Basic) to use - the default format defined for the type of the implementation. - The provider to use to format the value.-or- A null reference - (Nothing in Visual Basic) to obtain the numeric format information from the current locale - setting of the operating system. 2 - - - - Predicates applied to log events that can be used - - - - - Matches events from the specified source type. - - The source type. - A predicate for matching events. - - - - Matches events from the specified source type or namespace and - nested types or namespaces. - - A dotted source type or namespace identifier. - A function that matches log events emitted by the source. - - - - Matches events with the specified property attached, - regardless of its value. - - The name of the property to match. - A predicate for matching events. - - - - Matches events with the specified property value. - - The name of the property to match. - The property value to match; must be a scalar type. - Null is allowed. - A predicate for matching events. - - - - Matches events with the specified property value. - - The name of the property to match. - A predicate for testing - The type of scalar values to match. - A predicate for matching events. - - - - A that supports the Serilog - message template format. Formatting log events for display - has a different set of requirements and expectations from - rendering the data within them. To meet this, the formatter - overrides some behavior: First, strings are always output - as literals (not quoted) unless some other format is applied - to them. Second, tokens without matching properties are skipped - rather than being written as raw text. - - - - - Construct a . - - A message template describing the - output messages. - Supplies culture-specific formatting information, or null. - - - - Format the log event into the output. - - The event to format. - The output. - - - - Describes the properties available in standard message template-based - output format strings. - - - - - The message rendered from the log event. - - - - - The timestamp of the log event. - - - - - The level of the log event. - - - - - A new line. - - - - - The exception associated with the log event. - - - - - Create properties from the provided log event. - - The log event. - A dictionary with properties representing the log event. - - - - Formats log events as a raw dump of the message template and properties. - - - - - Format the log event into the output. - - The event to format. - The output. - - - - Formats log events in a textual representation. - - - - - Format the log event into the output. - - The event to format. - The output. - - - - Formats log events in a simple JSON structure. Instances of this class - are safe for concurrent access by multiple threads. - - - - - Construct a . Obsolete, please use named arguments - when calling this constructor. - - - - - Construct a . - - If true, the properties of the event will be written to - the output without enclosing braces. Otherwise, if false, each event will be written as a well-formed - JSON object. - A string that will be written after each log event is formatted. - If null, will be used. Ignored if - is true. - If true, the message will be rendered and written to the output as a - property named RenderedMessage. - Supplies culture-specific formatting information, or null. - - - - Format the log event into the output. - - The event to format. - The output. - - - - Adds a writer function for a given type. - - The type of values, which handles. - The function, which writes the values. - - - - Writes out individual renderings of attached properties - - - - - Writes out the values of individual renderings of attached properties - - - - - Writes out the attached properties - - - - - Writes out the attached properties values - - - - - Writes out the attached exception - - - - - (Optionally) writes out the rendered message - - - - - Writes out the message template for the logevent. - - - - - Writes out the log level - - - - - Writes out the log timestamp - - - - - Writes out a structure property - - - - - Writes out a sequence property - - - - - Writes out a dictionary - - - - - Writes out a json property with the specified value on output writer - - - - - Allows a subclass to write out objects that have no configured literal writer. - - The value to be written as a json construct - The writer to write on - - - - Perform simple JSON string escaping on . - - A raw string. - A JSON-escaped version of . - - - - Create properties based on an ordered list of provided values. - - The template that the parameters apply to. - Objects corresponding to the properties - represented in the message template. - A list of properties; if the template is malformed then - this will be empty. - - - - A simple source of information generated by Serilog itself, - for example when exceptions are thrown and caught internally. - - - - - The output mechanism for self-log events. - - - SelfLog.Out = Console.Error; - - - - - Write a message to the self-log. - - Standard .NET format string containing the message. - First argument, if supplied. - Second argument, if supplied. - Third argument, if supplied. - - - - The core Serilog logging API, used for writing log events. - - - var log = new LoggerConfiguration() - .WithConsoleSink() - .CreateLogger(); - - var thing = "World"; - log.Information("Hello, {Thing}!", thing); - - - The methods on (and its static sibling ) are guaranteed - never to throw exceptions. Methods on all other types may. - - - - - Create a logger that enriches log events via the provided enrichers. - - Enrichers that apply in the context. - A logger that will enrich log events as specified. - - - - Create a logger that enriches log events with the specified property. - - A logger that will enrich log events as specified. - - - - Create a logger that marks log events as being from the specified - source type. - - Type generating log messages in the context. - A logger that will enrich log events as specified. - - - - Create a logger that marks log events as being from the specified - source type. - - Type generating log messages in the context. - A logger that will enrich log events as specified. - - - - Write an event to the log. - - The event to write. - - - - Write a log event with the specified level. - - The level of the event. - - - - - - Write a log event with the specified level and associated exception. - - The level of the event. - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - - - Determine if events at the specified level will be passed through - to the log sinks. - - Level to check. - True if the level is enabled; otherwise, false. - - - - Write a log event with the level and associated exception. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Verbose("Staring into space, wondering if we're alone."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Verbose(ex, "Staring into space, wondering where this comet came from."); - - - - - Write a log event with the level and associated exception. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Debug("Starting up at {StartedAt}.", DateTime.Now); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Debug(ex, "Swallowing a mundane exception."); - - - - - Write a log event with the level and associated exception. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level and associated exception. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level and associated exception. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Error("Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level and associated exception. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Fatal("Process terminating."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Fatal(ex, "Process terminating."); - - - - - An optional static entry point for logging that can be easily referenced - by different parts of an application. To configure the - set the Logger static property to a logger instance. - - - Log.Logger = new LoggerConfiguration() - .WithConsoleSink() - .CreateLogger(); - - var thing = "World"; - Log.Logger.Information("Hello, {Thing}!", thing); - - - The methods on (and its dynamic sibling ) are guaranteed - never to throw exceptions. Methods on all other types may. - - - - - The globally-shared logger. - - - - - - Create a logger that enriches log events via the provided enrichers. - - Enrichers that apply in the context. - A logger that will enrich log events as specified. - - - - Create a logger that enriches log events with the specified property. - - A logger that will enrich log events as specified. - - - - Create a logger that marks log events as being from the specified - source type. - - Type generating log messages in the context. - A logger that will enrich log events as specified. - - - - Create a logger that marks log events as being from the specified - source type. - - Type generating log messages in the context. - A logger that will enrich log events as specified. - - - - Write an event to the log. - - The event to write. - - - - Write a log event with the specified level. - - The level of the event. - Message template describing the event. - Object positionally formatted into the message template. - - - - Write a log event with the specified level. - - The level of the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - - - Write a log event with the specified level. - - The level of the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - - - Write a log event with the specified level. - - The level of the event. - Message template describing the event. - Objects positionally formatted into the message template. - - - - Write a log event with the specified level and associated exception. - - The level of the event. - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - - - Write a log event with the specified level and associated exception. - - The level of the event. - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - - - Write a log event with the specified level and associated exception. - - The level of the event. - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - - - Write a log event with the specified level and associated exception. - - The level of the event. - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - - - Determine if events at the specified level will be passed through - to the log sinks. - - Level to check. - True if the level is enabled; otherwise, false. - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - - Log.Verbose("Staring into space, wondering if we're alone."); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Verbose("Staring into space, wondering if we're alone."); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Verbose("Staring into space, wondering if we're alone."); - - - - - Write a log event with the level. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Verbose("Staring into space, wondering if we're alone."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - Log.Verbose(ex, "Staring into space, wondering where this comet came from."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Verbose(ex, "Staring into space, wondering where this comet came from."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Verbose(ex, "Staring into space, wondering where this comet came from."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Verbose(ex, "Staring into space, wondering where this comet came from."); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - - Log.Debug("Starting up at {StartedAt}.", DateTime.Now); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Debug("Starting up at {StartedAt}.", DateTime.Now); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Debug("Starting up at {StartedAt}.", DateTime.Now); - - - - - Write a log event with the level. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Debug("Starting up at {StartedAt}.", DateTime.Now); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - Log.Debug(ex, "Swallowing a mundane exception."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Debug(ex, "Swallowing a mundane exception."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Debug(ex, "Swallowing a mundane exception."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Debug(ex, "Swallowing a mundane exception."); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - - Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Information("Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Information(ex, "Processed {RecordCount} records in {TimeMS}.", records.Length, sw.ElapsedMilliseconds); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - - Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Warning("Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Warning(ex, "Skipped {SkipCount} records.", skippedRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - - Log.Error("Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Error("Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Error("Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Error("Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Error(ex, "Failed {ErrorCount} records.", brokenRecords.Length); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - - Log.Fatal("Process terminating."); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Fatal("Process terminating."); - - - - - Write a log event with the level. - - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Fatal("Process terminating."); - - - - - Write a log event with the level. - - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Fatal("Process terminating."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - - Log.Fatal(ex, "Process terminating."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Fatal(ex, "Process terminating."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - Object positionally formatted into the message template. - - Log.Fatal(ex, "Process terminating."); - - - - - Write a log event with the level and associated exception. - - Exception related to the event. - Message template describing the event. - Objects positionally formatted into the message template. - - Log.Fatal(ex, "Process terminating."); - - - - - A structure representing the alignment settings to apply when rendering a property. - - - - - Initializes a new instance of . - - The text alignment direction. - The width of the text, in characters. - - - - The text alignment direction. - - - - - The width of the text. - - - - - Defines the direction of the alignment. - - - - - Text will be left-aligned. - - - - - Text will be right-aligned. - - - - - Instructs the logger on how to store information about provided - parameters. - - - - - Convert known types and objects to scalars, arrays to sequences. - - - - - Convert all types to scalar strings. Prefix name with '$'. - - - - - Convert known types to scalars, destructure objects and collections - into sequences and structures. Prefix name with '@'. - - - - - A message template token representing a log event property. - - - - - Construct a . - - The name of the property. - The token as it appears in the message template. - The format applied to the property, if any. - The destructuring strategy applied to the property, if any. - - - - - Construct a . - - The name of the property. - The token as it appears in the message template. - The format applied to the property, if any. - The alignment applied to the property, if any. - The destructuring strategy applied to the property, if any. - The token's start index in the template. - - - - - The token's length. - - - - - Render the token to the output. - - Properties that may be represented by the token. - Output for the rendered string. - Supplies culture-specific formatting information, or null. - - - - The property name. - - - - - Destructuring strategy applied to the property. - - - - - Format applied to the property. - - - - - Alignment applied to the property. - - - - - True if the property name is a positional index; otherwise, false. - - - - - Try to get the integer value represented by the property name. - - The integer value, if present. - True if the property is positional, otherwise false. - - - - Determines whether the specified is equal to the current . - - - true if the specified object is equal to the current object; otherwise, false. - - The object to compare with the current object. 2 - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - 2 - - - - Returns a string that represents the current object. - - - A string that represents the current object. - - 2 - - - - An element parsed from a message template string. - - - - - Construct a . - - The token's start index in the template. - - - - The token's start index in the template. - - - - - The token's length. - - - - - Render the token to the output. - - Properties that may be represented by the token. - Output for the rendered string. - Supplies culture-specific formatting information, or null. - - - - Parses message template strings into sequences of text or property - tokens. - - - - - Parse the supplied message template. - - The message template to parse. - A sequence of text or property tokens. Where the template - is not syntactically valid, text tokens will be returned. The parser - will make a best effort to extract valid property tokens even in the - presence of parsing issues. - - - - A message template token representing literal text. - - - - - Construct a . - - The text of the token. - The token's start index in the template. - - - - - The token's length. - - - - - Render the token to the output. - - Properties that may be represented by the token. - Output for the rendered string. - Supplies culture-specific formatting information, or null. - - - - Determines whether the specified is equal to the current . - - - true if the specified object is equal to the current object; otherwise, false. - - The object to compare with the current object. 2 - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - 2 - - - - Returns a string that represents the current object. - - - A string that represents the current object. - - 2 - - - - The text of the token. - - - - - Configuration object for creating instances. - - - - - Configures the sinks that log events will be emitted to. - - - - - Configures the minimum level at which events will be passed to sinks. If - not specified, only events at the - level and above will be passed through. - - Configuration object allowing method chaining. - - - - Configures enrichment of s. Enrichers can add, remove and - modify the properties associated with events. - - - - - Configures global filtering of s. - - - - - Configures destructuring of message template parameters. - - - - - Apply external settings to the logger configuration. - - - - - Create a logger using the configured sinks, enrichers and minimum level. - - The logger. - To free resources held by sinks ahead of program shutdown, - the returned logger may be cast to and - disposed. - - - - Backport of .Net 4.5 features - - - - - Backport of .Net 4.5 TypeInfo concept - - - - diff --git a/packages/FAKE.5.16.0/tools/Argu.dll b/packages/FAKE.5.16.0/tools/Argu.dll new file mode 100644 index 0000000..642fde9 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/Argu.dll differ diff --git a/packages/FAKE.5.16.0/tools/Argu.xml b/packages/FAKE.5.16.0/tools/Argu.xml new file mode 100644 index 0000000..b2e0e8f --- /dev/null +++ b/packages/FAKE.5.16.0/tools/Argu.xml @@ -0,0 +1,1309 @@ + + +Argu + + + + Combine AppSettings with CLI inputs + + + + + Declares that the parameter should gather any unrecognized CLI params + + + + + Hide from Usage + + + + + Specifies that argument should be specified at most once in CLI + + + + + Fails if no argument of this type is specified + + + + + If specified, multiple parameters can be added in AppSettings in CSV form. + + + + + Separator token used for EqualsAssignment syntax; e.g. '=' forces '--param=arg' syntax + + + + + If specified, should consume remaining tokens from the CLI + + + + + Specifies that this argument is the main CLI command + + + + + Mandated Cli position for the argument + + + + + AppSettings parameter split options + + + + + AppSettings parameter separator + + + + + Description of the parameter + + + + + name used in AppSettings + + + + + head element denotes primary command line arg + + + + + Type of argument parser + + + + + Union case reflection identifier + + + + + Human readable name identifier + + + + + Union argument metadata + + + + + Argument specifies a subcommand + + + + + Argument specifies a list of parameters of specific primitive type + + + + + Argument specifies an optional parameter which is primitive + + + + + Argument specifies primitive parameters like strings or integers + + + + + Argument parameter type identifier + + + + + Handles argument parser errors by exiting the process + after printing a parse error. + + + + + Handles argument parser errors by raising an exception + + + + + IExiter identifier + + + + + handle error of given message and error code + + + + + An interface for error handling in the argument parser + + + + + Parse exception raised by Argu + + + + + Exception raised by Argu + + + + + Cli Position required to place argument + + + + + Error codes reported by Argu + + + + + Source from which to parse arguments + + + + + returns a usage string for every union case + + + + + Interface that must be implemented by all Argu template types + + + + + Create a configuration reader that always returns null + + + + + Create a configuration reader instance using an F# function + + + + + Create a configuration reader instance using environment variables + + + + + Create a configuration reader instance using an IDictionary instance + + + + + Create a configuration reader instance using a local xml App.Config file + + + + + Create a configuration reader instance using the location of an assembly file + + + + + Create a configuration reader instance using the application's resident AppSettings configuration + + + + + Configuration reader implementations + + + + + Create used supplied XML file path + + + + + AppSettings XML configuration reader + + + + + AppSettings XML configuration reader + + + + + Function configuration reader proxy + + + + + Configuration reader dictionary proxy + + + + + Environment variable-based configuration reader + + + + + Configuration reader that never returns a value + + + + + Configuration reader identifier + + + + + Gets value corresponding to supplied key + + + + + Abstract key/value configuration reader + + + + + Gets all parse results that are not part of the current parsing context + This is only applicable to subcommand parsing operations + + + + + Gets all unrecognized CLI parameters which + accumulates if parsed with 'ignoreUnrecognized = true' + + + + + Returns true if '--help' parameter has been specified in the command line. + + + + Returns the *last* specified parameter of given type. + Command line parameters have precedence over AppSettings parameters. + Results are passed to a post-processing function that is error handled by the parser. + + The name of the parameter, expressed as quotation of DU constructor. + The post-processing parser. + Optional source restriction: AppSettings or CommandLine. + + + + Attempts to recover the subcommand parameter from the results, + if one has been specified. + + + + Returns the *last* specified parameter of given type, if it exists. + Command line parameters have precedence over AppSettings parameters. + The name of the parameter, expressed as quotation of DU constructor. + Optional source restriction: AppSettings or CommandLine. + + + Returns the *last* specified parameter of given type, if it exists. + Command line parameters have precedence over AppSettings parameters. + The name of the parameter, expressed as quotation of DU constructor. + Optional source restriction: AppSettings or CommandLine. + + + Raise an error through the argument parser's exiter mechanism. Display usage optionally. + The error to be displayed. + The error code to be returned. + Print usage together with error message. + + + Raise an error through the argument parser's exiter mechanism. Display usage optionally. + The error message to be displayed. + The error code to be returned. + Print usage together with error message. + + + Query parse results for given argument kind. + Command line parameters have precedence over AppSettings parameters. + Results are passed to a post-processing function that is error handled by the parser. + + The name of the parameter, expressed as quotation of DU constructor. + The post-processing parser. + Optional source restriction: AppSettings or CommandLine. + + + Returns the *last* specified parameter of given type. + Command line parameters have precedence over AppSettings parameters. + Results are passed to a post-processing function that is error handled by the parser. + + The name of the parameter, expressed as quotation of DU constructor. + The post-processing parser. + Optional source restriction: AppSettings or CommandLine. + + + + Iterates through *all* parse results for a given argument kind. + Command line parameters have precedence over AppSettings parameters. + Results are passed to an iterator function that is error handled by the parser. + + The name of the parameter, expressed as quotation of DU constructor. + The iterator body. + Option source restriction: AppSettings or CommandLine. + + + + Iterates through the *last* parse result for a given argument kind. + Command line parameters have precedence over AppSettings parameters. + Results are passed to an iterator function that is error handled by the parser. + + The name of the parameter, expressed as quotation of DU constructor. + The iterator body. + Option source restriction: AppSettings or CommandLine. + + + + Attempts to recover the subcommand parameter from the results, + if one has been specified. + + + + Query parse results for argument with parameters. + The name of the parameter, expressed as quotation of DU constructor. + Optional source restriction: AppSettings or CommandLine. + + + Query parse results for parameterless argument. + The name of the parameter, expressed as quotation of DU constructor. + Optional source restriction: AppSettings or CommandLine. + + + Returns the *last* specified parameter of given type. + Command line parameters have precedence over AppSettings parameters. + The name of the parameter, expressed as quotation of DU constructor. + Return this of no parameter of specific kind has been specified. + Optional source restriction: AppSettings or CommandLine. + + + Returns the *last* specified parameter of given type. + Command line parameters have precedence over AppSettings parameters. + The name of the parameter, expressed as quotation of DU constructor. + Return this of no parameter of specific kind has been specified. + Optional source restriction: AppSettings or CommandLine. + + + Gets all parse results. + Optional source restriction: AppSettings or CommandLine. + + + Checks if parameter of specific kind has been specified. + The name of the parameter, expressed as quotation of DU constructor. + Optional source restriction: AppSettings or CommandLine. + + + Checks if parameter of specific kind has been specified. + The name of the parameter, expressed as quotation of DU constructor. + Optional source restriction: AppSettings or CommandLine. + + + Handles any raised exception through the argument parser's exiter mechanism. Display usage optionally. + The operation to be executed. + The error code to be returned. + Print usage together with error message. + + + + Argument parsing result holder. + + + + + Visit argument parser of generic type. + + Supplied argument parser. + + + + Rank-2 function used for accessing typed APIs of untyped parsers + + + + + Converts a sequence of template argument inputs into a ParseResults instance + + Argument input sequence. + + + Prints parameters in command line format. Useful for argument string generation. + + + Prints parameters in command line format. Useful for argument string generation. + + + Prints parameters in App.Config format. + The parameters that fill out the XML document. + Print XML comments over every configuration entry. + + + Parse arguments using specified configuration reader only. This defaults to the AppSettings configuration of the current process. + Configuration reader used to source the arguments. Defaults to the AppSettings configuration of the current process. + Ignore errors caused by the Mandatory attribute. Defaults to false. + + + Parse command line arguments only. + The command line input. Taken from System.Environment if not specified. + Ignore errors caused by the Mandatory attribute. Defaults to false. + Ignore CLI arguments that do not match the schema. Defaults to false. + Treat '--help' parameters as parse errors. Defaults to true. + + + Parse both command line args and supplied configuration reader. + Results are merged with command line args overriding configuration parameters. + The command line input. Taken from System.Environment if not specified. + Configuration reader used to source the arguments. Defaults to the AppSettings configuration of the current process. + Ignore errors caused by the Mandatory attribute. Defaults to false. + Ignore CLI arguments that do not match the schema. Defaults to false. + Treat '--help' parameters as parse errors. Defaults to true. + + + + Gets the F# union tag representation for given argument + + Argument instance. + + + + Gets a subparser associated with specific subcommand instance + + Expression providing the subcommand union constructor. + + + + Gets argument metadata for given union case constructor + + Quoted union case constructor. + + + + Gets argument metadata for given argument instance. + + Argument instance. + + + Force a check of the discriminated union structure. + + + + Creates a new parser instance based on supplied F# union template. + + Program identifier, e.g. 'cat'. Defaults to the current executable name. + Message that will be displayed at the top of the help text. + Text width used when formatting the usage string. Defaults to 80 chars. + The implementation of IExiter used for error handling. Exception is default. + Indicate if the structure of the arguments discriminated union should be checked for errors. + + + + The Argu type generates an argument parser given a type argument + that is an F# discriminated union. It can then be used to parse command line arguments + or XML configuration. + + + + + If subcommand parser, gets parent argument metadata + + + + + Returns true if parser corresponds to a subcommand + + + + + Gets the message that will be displayed at the top of the help text + + + + + Gets the help flags specified for the CLI parser + + + + + Gets the help description specified for the CLI parser + + + + + Gets the default error handler used by the instance + + + + Formats a usage string for the argument parser. + The message to be displayed on top of the usage string. + Override the default program name settings. + Do not display 'USAGE: [syntax]' at top of usage string. Defaults to false. + Text width used when formatting the usage string. + + + + Prints command line syntax. Useful for generating documentation. + + Program name identifier placed at start of syntax string + Text width used when formatting the usage string. + + + + Gets all subcommand parsers for given parser + + + + + Gets metadata for all union cases used by parser + + + + + Create a new argument parsing scheme using given 'Template type + which must be an F# Discriminated Union. + + Program identifier, e.g. 'cat'. Defaults to the current executable name. + Message that will be displayed at the top of the help text. + Text width used when formatting the usage string. Defaults to 80 chars. + The implementation of IExiter used for error handling. Exception is default. + Indicate if the structure of the arguments discriminated union should be checked for errors. + + + + Enables access to the typed API of an ArgumentParser + when template type is unknown. + + Visitor used to access the parser. + + + + The Argu type generates an argument parser given a type argument + that is an F# discriminated union. It can then be used to parse command line arguments + or XML configuration. + + + + + Double Dash prefix '--' + + + + + Single Dash prefix '-' + + + + + No Cli Prefix + + + + + Predefined CLI prefixes to be added + + + + + Specifies a custom prefix for auto-generated CLI names. + This defaults to double dash ('--'). + + + + + Specify a custom value separator in AppSettings parsing parameters. + Used in CSV or list-based parameter parsing. + + + + + Declares a custom key identifier for the current parameter in AppSettings parsing. + Replaces the auto-generated identifier name. + + + + + Declares a set of secondary CLI identifiers for the current parameter. + Does not replace the default identifier which is either auto-generated + or specified by the CustomCommandLine attribute. + + + + + Declares a custom default CLI identifier for the current parameter. + Replaces the auto-generated identifier name. + + + + + Use '--param:arg' or '--param key:value' assignment syntax in CLI. + Requires that the argument should have parameters of arity 1 or 2 only. + + + + + Use '--param=arg' or '--param key=value' assignment syntax in CLI. + Requires that the argument should have parameters of arity 1 or 2 only. + + + + + Use '--param=arg' or '--param key=value' assignment syntax in CLI. + Requires that the argument should have parameters of arity 1 or 2 only. + Can be used to specify any assignment separator. + + + + + Print F# 3.1 field labels in usage string. OBSOLETE + + + + + Declares that argument is the main command of the CLI syntax. + Arguments are specified without requiring a switch. + + + + + Declares that argument is a subcommand. + A parse exception will be raised if the argument has parameters + and their type is not ParseResults<_>. + Implicit if the argument does have a parameter of type ParseResults<_>. + + + + + Declares that argument can only be placed at the end of the CLI syntax. + A parse exception will be raised if that is not the case. + + + + + Declares that argument can only be placed at the beginning of the CLI syntax. + A parse exception will be raised if that is not the case. + + + + + Declares that argument should be placed at specific position. + + + + + Specifies a custom description text for the Help/Usage switches in the usage string. + + + + + Specifies that Help/Usage switches should be disabled for the CLI. + + + + + Specifies a custom set of Help/Usage switches for the CLI. + + + + + Disable AppSettings parsing for this branch. Use for CLI parsing only. + + + + + Disable CLI parsing for this argument. Use for AppSettings parsing only. + + + + + Requires that CLI parameters should not override AppSettings parameters. + Will return parsed results from both AppSettings and CLI. + + + + + Demands that at least one subcommand is specified in the CLI; a parse exception is raised otherwise. + + + + + Denotes that the given argument should accummulate any unrecognized arguments it encounters. + Must contain a single field of type string + + + + + Denotes that the given argument should be inherited in the scope of any subcommands. + + + + + Demands that the argument should be specified exactly once; a parse exception is raised otherwise. + Equivalent to attaching both the Mandatory and Unique attribute on the parameter. + + + + + Demands that the argument should be specified at most once; a parse exception is raised otherwise. + + + + + Demands at least one parsed result for this argument; a parse exception is raised otherwise. + + + + + Hides argument from command line argument usage string. + + + + + Consume all remaining CLI tokens using this parameter wherever it might occur. OBSOLETE + + + + + Parse multiple parameters in AppSettings as comma separated values. OBSOLETE + + + + + Argu Attribute declaration module + + + + + Look up best matching key entry by prefix + + + + + Gets the value corresponding to supplied key + + + + + Dictionary enabling lookups by string prefix + e.g. the string '--foo=bar' can be used to look up the key '--foo' + + + + + reflected version of Unchecked.defaultof + + + + + Gets the default width of the current console window, + if available. + + + + + these chars require quoting or escaping + + + + + these chars can't be roundtripped through a cmd-line -> should fail with an exception + + + + + recognize exprs that strictly contain DU constructors + e.g. <@ Case @> is valid but <@ fun x y -> Case y x @> is invalid + + + + + get CL arguments from environment + + + + + partition sequence according to predicate + + + + + try fetching last element of a sequence + + + + + try fetching first element of a sequence + + + + + try fetching last element of a list + + + + + Usage string requested by the caller + + + + + CLI parse objects not belonging to the current parser context + + + + + CLI tokens not recognized by the parser + + + + + Results by union case + + + + + parse source + + + + + metadata provided by the parser + + + + + ArgInfo used to parse parameter + + + + + Index denoting order of parse result + + + + + Parsed field parameters + + + + + Main command parameter used by the CLI syntax + + + + + Union case parameter used to gather unrecognized CLI params + + + + + Union cases indexed by cli parameter names + + + + + Union cases indexed by appsettings parameter names + + + + + Single character switches + + + + + Single character switches (Regex) + + + + + Arguments inherited by parent commands + + + + + Precomputed union tag reader + + + + + Specifies that CLI parse results require a subcommand + + + + + Denotes that the current argument contains subcommands + + + + + Help flags specified by the library + + + + + Union cases + + + + + If subcommand, attempt to retrieve the parent record + + + + + Contextual depth of current argument w.r.t subcommands + + + + + Union Case Argument Info + + + + + Combine AppSettings with CLI inputs + + + + + Declares that the parameter should gather any unrecognized CLI params + + + + + Hide from Usage + + + + + Specifies that argument should be specified at most once in CLI + + + + + Indicates that argument should be inherited in the scope of any sibling subcommands. + + + + + Fails if no argument of this type is specified + + + + + If specified, multiple parameters can be added in Configuration in CSV form. + + + + + If specified, should consume remaining tokens from the CLI + + + + + Specifies that this argument is the main CLI command + + + + + Mandated Cli position for the argument + + + + + Reads assignment for that specific value + + + + + Separator token used for EqualsAssignment syntax; e.g. '=' forces '--param=arg' syntax + + + + + Configuration parsing split options + + + + + Configuration parsing parameter separator + + + + + Description of the parameter + + + + + name used in AppSettings + + + + + head element denotes primary command line arg + + + + + Decomposes a case instance into an array of fields + + + + + Composes case fields into a parametric tuple, if not nullary + + + + + Builds a union case out of its field parameters + + + + + Gets the parent record for union case + + + + + Type of argument in ParameterInfo + + + + + Field parser definitions or nested union argument + + + + + UCI identifier + + + + + Same as UnionCaseInfo.Tag + + + + + Numbers of parameters in the given union case + + + + + Contextual depth of current argument w.r.t subcommands + + + + + Human readable name identifier + + + + + Represents a parsing schema for a single parameter + + + + + Help Param description + + + + + field value to string unparser + + + + + string to field value parser + + + + + field type + + + + + field label + + + + + Type name + + + + + Union Case Field info + + + + + generate argument parsing schema from given UnionCaseInfo + + + + + extracts the subcommand argument hierarchy for given UnionArgInfo + + + + + Creates a primitive parser from an F# DU enumeration + (i.e. one with no parameters in any of its union cases) + + + + + Creates a primitive parser from an enumeration + + + + + Creates a primitive field parser from given parser/unparser lambdas + + + + + Generates an argument label name from given PropertyInfo + + + + + construct a command identifier from UCI name + + + + + construct an App.Config param from UCI name + + + + + construct a CLI param from UCI name + + + + + Generate a CLI Param for enumeration cases + + + + + recognizes and extracts grouped switches + e.g. -efx --> -e -f -x + + + + + returns an App.Config XDocument given a set of config parameters + + + + + print a command line argument for a set of parameters + + + + + print usage string for a collection of arg infos + + + + + print usage string for given help param + + + + + print usage string for given arg info + + + + + print the command line syntax + + + + + Number of spaces to be inserted before a cli switch description text + + + + + Number of spaces to be inserted before a cli switch name in the usage string + + + + + Combines two parse results, AppSettings and CLI, overriding where appropriate. + By default, CLI parameters override AppSettings parameters. + + + + + Create a ParseResults<_> instance from a set of template parameters + + + + + construct a parse result from untyped collection of parsed arguments + + + + + returns the substring that corresponds to the current argument being parsed + e.g "-port 2" from "-Cf -port 2 -bar" + + + + + Parse the entire command line + + + + + parse the next command line argument and append to state + + + + + Parse a given key/value configuration + + + + + Parse single entry from key/value configuration + + + + + gets the F# union tag representation of given argument instance + + + + + converts a sequence of inputs to a ParseResults instance + + + + + Gets the parser instance corresponding to the parse result + + + + diff --git a/packages/FAKE.5.16.0/tools/Chessie.dll b/packages/FAKE.5.16.0/tools/Chessie.dll new file mode 100644 index 0000000..628394b Binary files /dev/null and b/packages/FAKE.5.16.0/tools/Chessie.dll differ diff --git a/packages/FAKE.5.16.0/tools/Chessie.xml b/packages/FAKE.5.16.0/tools/Chessie.xml new file mode 100644 index 0000000..c2e9b91 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/Chessie.xml @@ -0,0 +1,332 @@ + + +Chessie + + + + Represents the result of an async computation + + + + + Represents the result of a failed computation. + + + + + Represents the result of a successful computation. + + + + + Executes the given function on a given success or captures the failure + + + + + Converts the result into a string. + + + + + Creates a Success result with the given value and the given message. + + + + + Creates a Success result with the given value and the given message. + + + + + Creates a Success result with the given value. + + + + + Creates a Failure result with the given message. + + + + + Creates a Failure result with the given messages. + + + + + Represents the result of a computation. + + + + + Creates an async computation from an asyncTrial computation + + + + + Creates an async computation that runs a mapping function on the result of an async computation + + + + + Creates an async computation that runs a computation and + when it generates a result run a binding function on the said result + + + + + Creates an async computation that return the given value + + + + + Useful functions for combining error handling computations with async computations. + + + + + Useful functions for combining error handling computations with async computations. + + + + + Builder type for error handling in async computation expressions. + + + + + Basic support for async error handling computation + + + + + Converts an option into a Result. + + + + + Returns the result or fails if the result was an error. + + + + + If the result is a Success it executes the given Func on the value. + If the result of the Func is a Success it maps it using the given Func. + Otherwise the exisiting failure is propagated. + + + + + If the result is a Success it executes the given Func on the value. + Otherwise the exisiting failure is propagated. + + + + + Lifts a Func into a Result and applies it on the given result. + + + + + Allows pattern matching on Results from C#. + + + + + Maps a function over the existing error messages in case of failure. In case of success, the message type will be changed and warnings will be discarded. + + + + + Lifts a Func into a Result and applies it on the given result. + + + + + Joins two results. + If both are a success the resultSelector Func is applied to the values and the existing success messages are propagated. + Otherwise the exisiting error messages are propagated. + + + + + Collects a sequence of Results and accumulates their values. + If the sequence contains an error the error will be propagated. + + + + + Returns the error messages or fails if the result was a success. + + + + + Allows pattern matching on Results from C#. + + + + + Collects a sequence of Results and accumulates their values. + If the sequence contains an error the error will be propagated. + + + + + Extensions methods for easier C# usage. + + + + + Builder type for error handling computation expressions. + + + + + Wraps computations in an error handling computation expression. + + + + + Categorizes a result based on its state and the presence of extra messages + + + + + Converts a Choice into a Result. + + + + + Converts an option into a Result. + + + + + Collects a sequence of Results and accumulates their values. + If the sequence contains an error the error will be propagated. + + + + + If the result is a Failure it executes the given function on the messages. + Result is propagated unchanged. + + + + + If the result is a Success it executes the given function on the value and the messages. + Result is propagated unchanged. + + + + + If the result is a Success it executes the given success function on the value and the messages. + If the result is a Failure it executes the given failure function on the messages. + Result is propagated unchanged. + + + + + Promote a function to a monad/applicative, scanning the monadic/applicative arguments from left to right. + + + + + Lifts a function into a Result and applies it on the given result. + This is the infix operator version of ErrorHandling.lift + + + + + Maps a function over the existing error messages in case of failure. In case of success, the message type will be changed and warnings will be discarded. + + + + + Lifts a function into a Result container and applies it on the given result. + + + + + If the wrapped function is a success and the given result is a success the function is applied on the value. + Otherwise the exisiting error messages are propagated. + This is the infix operator version of ErrorHandling.apply + + + + + If the wrapped function is a success and the given result is a success the function is applied on the value. + Otherwise the exisiting error messages are propagated. + + + + + If the result is a Success it executes the given function on the value. + Otherwise the exisiting failure is propagated. + This is the infix operator version of ErrorHandling.bind + + + + + Flattens a nested result given the Failure types are equal + + + + + If the result is a Success it executes the given function on the value. + Otherwise the exisiting failure is propagated. + + + + + Appends the given messages with the messages in the given result. + + + + + If the given result is a Success the wrapped value will be returned. +Otherwise the function throws an exception with Failure message of the result. + + + + + Takes a Result and maps it with fSuccess if it is a Success otherwise it maps it with fFailure. + + + + + Returns true if the result was not successful. + + + + + Executes the given function on a given success or captures the exception in a failure + + + + + Wraps a message in a Failure + + + + + Wraps a value in a Success and adds a message + + + + + Wraps a value in a Success + + + + + Wraps a value in a Success + + + + + Basic combinators and operators for error handling. + + + + diff --git a/packages/FAKE.4.11.3/tools/FSharp.Compiler.Service.dll b/packages/FAKE.5.16.0/tools/FAKE.FSharp.Compiler.Service.dll similarity index 58% rename from packages/FAKE.4.11.3/tools/FSharp.Compiler.Service.dll rename to packages/FAKE.5.16.0/tools/FAKE.FSharp.Compiler.Service.dll index 1f82890..e119c0f 100644 Binary files a/packages/FAKE.4.11.3/tools/FSharp.Compiler.Service.dll and b/packages/FAKE.5.16.0/tools/FAKE.FSharp.Compiler.Service.dll differ diff --git a/packages/FAKE.5.16.0/tools/FAKE.exe b/packages/FAKE.5.16.0/tools/FAKE.exe new file mode 100644 index 0000000..1a460c7 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FAKE.exe differ diff --git a/packages/FAKE.5.16.0/tools/FAKE.exe.config b/packages/FAKE.5.16.0/tools/FAKE.exe.config new file mode 100644 index 0000000..9bd0b4c --- /dev/null +++ b/packages/FAKE.5.16.0/tools/FAKE.exe.config @@ -0,0 +1,461 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + True + + + + + True + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/packages/FAKE.5.16.0/tools/FParsec.dll b/packages/FAKE.5.16.0/tools/FParsec.dll new file mode 100644 index 0000000..d5370aa Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FParsec.dll differ diff --git a/packages/FAKE.5.16.0/tools/FParsec.xml b/packages/FAKE.5.16.0/tools/FParsec.xml new file mode 100644 index 0000000..2336962 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/FParsec.xml @@ -0,0 +1,1544 @@ + + +FParsec + + + + breaks a string into multiple lines along text element boundaries. + + + + + A primitive pretty printer. + + + + + Writes a string representation of the `ParserError` to the given `TextWriter` value. + + The format of the position information can be customized by specifying the `positionPrinter` + argument. The given function is expected to print a representation of the passed `Position` value + to the passed `TextWriter` value. If possible, it should indent text lines with the passed string + and take into account the maximum column count (including indention) passed as the last argument. + + + + + Writes a string representation of the `ParserError` to the given `TextWriter` value. + + For each error position `getStreamByName` is called with the `StreamName` of the `Position`. + The returned `CharStream` must be `null` or contain the content of the `CharStream` for which + the error was generated (at the original indices). + + If `getStreamByName` returns a non-null `CharStream`, the printed error position information is + augmented with the line of text surrounding the error position, together with a '^'-marker + pointing to the exact location of the error in the input stream. + + + + + Writes a string representation of the `ParserError` to the given `TextWriter` value. + + The given `CharStream` must contain the content of the original `CharStream` + for which this `ParserError` was generated (at the original indices). + + For each error location the printed position information is augmented + with the line of text surrounding the error position, together with a '^'-marker + pointing to the exact location of the error in the input stream. + + + + + Returns a string representation of the `ParserError`. + + The given `CharStream` must contain the content of the original `CharStream` + for which this `ParserError` was generated (at the original indices). + + For each error location the printed position information is augmented + with the line of text surrounding the error position, together with a '^'-marker + pointing to the exact location of the error in the input stream. + + + + + Returns a string representation of the `ParserError`. + + + + + Represents a simple container type that brings together the position, user state and error messages of a parser error. + + + + + `mergeErrors error1 error2` is equivalent to `ErrorMessageList.Merge(error1, error2)`. + + + + + `compoundError label state msgs` creates an `ErrorMessageList` with a single `CompoundError label stream.Position msgs` message, + except if `msgs` is an `ErrorMessageList` with a single `BacktrackPoint(pos2, msgs2)` message, + in which case an `ErrorMessageList` with a single `CompoundError label pos2 msgs2` message is returned instead. + + + + + `backtrackError stream msgs` creates an `ErrorMessageList` with a single `BacktrackPoint stream.Position msgs` message, + except if `msgs` is already an `ErrorMessageList` with a single `BacktrackPoint(_, _)` message, + in which case `msgs` is returned instead. + + + + + `otherError o` creates an `ErrorMessageList` with a single `OtherError o` message. + + + + + `messageError msg` creates an `ErrorMessageList` with a single `Message msg` message. + + + + + `unexpectedStringCIError str` creates an `ErrorMessageList` with a single `UnexpectedStringCI str` message. + + + + + `unexpectedStringError str` creates an `ErrorMessageList` with a single `UnexpectedString str` message. + + + + + `unexpectedError label` creates an `ErrorMessageList` with a single `Unexpected label` message. + + + + + `expectedStringCIError str` creates an `ErrorMessageList` with a single `ExpectedStringCI str` message. + + + + + `expectedStringError str` creates an `ErrorMessageList` with a single `ExpectedString str` message. + + + + + `expectedError label` creates an `ErrorMessageList` with a single `Expected label` message. + + + + + The type of the "builder object" that can be used to build parsers with + F#'s "computation expression" syntax a.k.a. "workflow" syntax. + + + + + The type of the parser functions supported by FParsec combinators. + + + + + `let p, pRef = createParserForwardedToRef()` creates a parser `p` that forwards all + calls to the parser in the reference cell `pRef`. Initially, `pRef` holds a reference + to a dummy parser that raises an exception on any invocation. + + + + + The builder object for building parsers using F#'s computation expression syntax. + + + + + The parser `chainr p op defVal` is equivalent to `chainr1 p op <|>% defVal`. + + + + + The parser `chainr1 p op` parses one or more occurrences of `p` separated by `op` + (in EBNF notation: `p (op p)*`). + It returns the value obtained by *right* associative application of all functions + returned by `op` to the results returned by `p`, + i.e. `f1 x_1 (f_2 x_2 (... (f_n x_n x_n+1) ...))`, + where `f_1` to `f_n` are the functions returned by the parser `op` and + `x_1` to `x_n+1` are the values returned by `p`. If only a single occurance + of `p` and no occurance of `op` is parsed, the result of `p` is returned directly. + + + + + The parser `chainl p op defVal` is equivalent to `chainl1 p op <|>% defVal`. + + + + + The parser `chainl1 p op` parses one or more occurrences of `p` separated by `op` + (in EBNF notation: `p (op p)*`). + It returns the value obtained by *left* associative application of all functions + returned by `op` to the results returned by `p`, + i.e. `f_n (... (f_2 (f_1 x_1 x_2) x_3) ...) x_n+1`, + where `f_1` to `f_n` are the functions returned by the parser `op` and + `x_1` to `x_n+1` are the values returned by `p`. If only a single occurance + of `p` and no occurance of `op` is parsed, the result of `p` is returned directly. + + + + + The parser `many1Till p endp` behaves like `manyTill p endp`, except that it requires `p` to succeed at least one time. + `many1Till p endp` is an optimized implementation of `pipe2 p (manyTill p endp) (fun hd tl -> hd::tl)`. + + + + + The parser `skipManyTill p endp` is an optimized implementation of `manyTill p endp |>> ignore`. + + + + + The `parser manyTill p endp` repeatedly applies the parser `p` + for as long as `endp` fails (without changing the parser state). + It returns a list of the results returned by `p`. + + + + + The parser `skipSepEndBy1 p sep` is an optimized implementation of `sepEndBy1 p sep |>> ignore`. + + + + + The parser `sepEndBy1 p sep` parses *one* or more occurrences of `p` separated and + optionally ended by `sep` (in EBNF notation: `p (sep p)* sep?`). + It returns a list of the results returned by `p`. + + + + + The parser `skipSepEndBy p sep` is an optimized implementation of `sepEndBy p sep |>> ignore`. + + + + + The parser `sepEndBy p sep` parses *zero* or more occurrences of `p` separated and + optionally ended by `sep` (in EBNF notation: `(p (sep p)* sep?)?`). + It returns a list of the results returned by `p`. + + + + + The parser `skipSepBy1 p sep` is an optimized implementation of `sepBy1 p sep |>> ignore`. + + + + + The parser `sepBy1 p sep` parses *one* or more occurrences of `p` separated by `sep` + (in EBNF notation: `p (sep p)*`). + + + + + The parser `skipSepBy p sep` is an optimized implementation of `sepBy p sep |>> ignore`. + + + + + The parser `sepBy p sep` parses *zero* or more occurrences of `p` separated by `sep` + (in EBNF notation: `(p (sep p)*)?`). + + + + + The parser `skipMany1 p` is an optimized implementation of `many1 p |>> ignore`. + + + + + The parser `many1 p` behaves like `many p`, except that it requires `p` to succeed at least one time. + `many1 p` is an optimized implementation of `pipe2 p (many p) (fun hd tl -> hd::tl)`. + + + + + The parser `skipMany p` is an optimized implementation of `many p |>> ignore`. + + + + + The parser `many p` repeatedly applies the parser `p` until `p` fails. + It returns a list of the results returned by `p`. + At the end of the sequence `p` must fail without changing the parser state and without + signalling a `FatalError`, otherwise `many p` will fail with the error reported by `p`. + `many p` tries to guard against an infinite loop by throwing an exception + if `p` succeeds without changing the parser state. + + + + + The parser `skipArray n p` is an optimized implementation of `parray n p |>> ignore`. + + + + + The parser `parray n p` parses `n` occurences of `p` and + returns the returns the results in an array. + For example, `parray 3 p` is equivalent to `pipe3 p p p (fun a b c -> [|a;b;c|])`. + + + + + The parser `tuple5 p1 p2 p3 p4 p5` applies the parsers `p1`, `p2`, `p3`, `p4` and `p5` in sequence and + returns the results in a tuple. + + + + + The parser `tuple4 p1 p2 p3 p4` applies the parsers `p1`, `p2`, `p3` and `p4` in sequence and + returns the results in a tuple. + + + + + The parser `tuple3 p1 p2 p3` applies the parsers `p1`, `p2` and `p3` in sequence and + returns the results in a tuple. + + + + + The parser `tuple2 p1 p2` applies the parsers `p1` and `p2` in sequence and + returns the results in a tuple. + `tuple2 p1 p2` is defined as `p1 .>>. p2`. + + + + + The parser `failFatally msg` always fails with a `messageError msg`. It signals a + FatalError, so that no error recovery is attempted (except via backtracking constructs). + + + + + The parser `fail msg` always fails with a `messageError msg`. + The error message will be displayed together with other error messages generated for + the same input position. + + + + + The parser `p <??> label` behaves like `p <?> label`, except that when `p` fails + after changing the parser state (for example, because `p` consumes input before it fails), + a `CompoundError` message is generated with both the given string `label` and the + error messages generated by `p`. + + + + + The parser `p <?> label` applies the parser `p`. If `p` does not change the parser state + (usually because `p` failed), the error messages are replaced with `expected label`. + + + + + The parser `lookAhead p` parses `p` and restores the original parse state afterwards. + In case `p` fails after changing the parser state, the error messages are wrapped in a `NestedError`. + If it succeeds, any error messages are discarded. Fatal errors are turned into normal errors. + + + + + The parser `notFollowedByL p` behaves like `notFollowedBy p`, + except that it returns an `Unexpected label` error message when the parser `p` fails. + + + + + The parser `notFollowedBy p` succeeds if the parser `p` fails to parse at the current position. + Otherwise it fails with a non-fatal error. This parser never changes the parser state. + If the parser `notFollowedBy p` fails, it returns no descriptive error message. + Hence it should only be used together with other parsers that take care of a potential error. + Alternatively, `notFollowedByL p label` can be used to ensure a more descriptive error message. + + + + + The parser `followedByL p` behaves like `followedBy p`, + except that it returns an `Expected label` error message when the parser `p` fails. + + + + + The parser `followedBy p` succeeds if the parser `p` succeeds at the current position. + Otherwise it fails with a non-fatal error. This parser never changes the parser state. + If the parser `followedBy p` fails, it returns no descriptive error message. + Hence it should only be used together with other parsers that take care of a potential error. + Alternatively, `followedByL p label` can be used to ensure a more descriptive error message. + + + + + The parser `notEmpty p` behaves like `p`, + except that it fails when `p` succeeds without consuming input + or changing the parser state in any other way. + + + + + The parser `p1 .>>.? p2` behaves like `p1 .>>. p2`, except that it will backtrack + to the beginning if `p2` fails with a non-fatal error and without changing the parser state, + even if `p1` has changed the parser state. + + + + + The parser `p1 .>>? p2` behaves like `p1 .>> p2`, except that it will backtrack + to the beginning if `p2` fails with a non-fatal error and without changing the parser state, + even if `p1` has changed the parser state. + + + + + The parser `p1 >>? p2` behaves like `p1 >>. p2`, except that it will backtrack + to the beginning if `p2` fails with a non-fatal error and without changing the parser state, + even if `p1` has changed the parser state. + + + + + The parser `p >>=? f` behaves like `p >>= f`, except that it will backtrack to the beginning + if the parser returned by `f` fails with a non-fatal error and without changing the parser state, + even if `p` has changed the parser state. + + + + + The parser `attempt p` applies the parser `p`. + If `p` fails after changing the parser state or with a fatal error, + `attempt p` will backtrack to the original parser state and report a non-fatal error. + + + + + The parser `optional p` skips over an optional occurrence of `p`. + `optional p` is an optimized implementation of `(p >>% ()) <|>% ()`. + + + + + The parser `opt p` parses an optional occurrence of `p` as an option value. + `opt p` is an optimized implementation of `(p |>> Some) <|>% None`. + + + + + The parser `p <|>% x` is an optimized implementation of `p <|> preturn x`. + + + + + The parser `choiceL ps label` is an optimized implementation of `choice ps <?> label`. + + + + + The parser `choice ps` is an optimized implementation of `p1 <|> p2 <|> ... <|> pn`, + where `p1` ... `pn` are the parsers in the sequence `ps`. + + + + + The parser `p1 <|> p2` first applies the parser `p1`. + If `p1` succeeds, the result of `p1` is returned. + If `p1` fails with a non-fatal error and *without changing the parser state*, + the parser `p2` is applied. + Note: The stream position is part of the parser state, so if `p1` fails after consuming input, + `p2` will not be applied. + + + + + The parser `pipe5 p1 p2 p3 p4 p5 f` applies the parsers `p1`, `p2`, `p3`, `p4` and `p5` in sequence. + It returns the result of the function application `f a b c d e`, where `a`, `b`, `c`, `d` and `e` are the results returned by `p1`, `p2`, `p3`, `p4` and `p5`. + + + + + The parser `pipe4 p1 p2 p3 p4 f` applies the parsers `p1`, `p2`, `p3` and `p4` in sequence. + It returns the result `f a b c d`, where `a`, `b`, `c` and `d` are the results returned by `p1`, `p2`, `p3` and `p4`. + + + + + The parser `pipe3 p1 p2 p3 f` applies the parsers `p1`, `p2` and `p3` in sequence. + It returns the result `f a b c`, where `a`, `b` and `c` are the results returned by `p1`, `p2` and `p3`. + + + + + The parser `pipe2 p1 p2 f` applies the parsers `p1` and `p2` in sequence. + It returns the result `f a b`, where `a` and `b` are the results returned by `p1` and `p2`. + + + + + The parser `p |>> f` applies the parser `p` and + returns the result `f x`, where `x` is the result returned by `p`. + + + + + The parser `between popen pclose p` applies the parsers `pOpen`, `p` and `pEnd` in sequence. + It returns the result of `p`. + + + + + The parser `p1 .>>. p2` applies the parsers `p1` and `p2` in sequence and returns the results in a tuple. + + + + + The parser `p1 .>> p2` applies the parsers `p1` and `p2` in sequence and returns the result of `p1`. + + + + + The parser `p1 >>. p2` applies the parsers `p1` and `p2` in sequence and returns the result of `p2`. + + + + + The parser `p >>% x` applies the parser `p` and returns the result `x`. + + + + + The parser `p >>= f` first applies the parser `p` to the input, then applies the function `f` + to the result returned by `p` and finally applies the parser returned by `f` to the input. + + + + + The parser `pzero` always fails with an empty error message list, i.e. an unspecified error. + `pzero x` is defined as `fun stream -> Reply(Error, NoErrorMessages)`. + + + + + The parser `preturn x` always succeeds with the result `x` (without changing the parser state). + `preturn x` is defined as `fun stream -> Reply(x)`. + + + + + The parser failed and no error recovery (except after backtracking) should be tried. + + + + + The parser failed. + + + + + The parser succeeded. + + + + + Encodes various bits of information about a parsed number literal. + + + + + Returns the fourth suffix char, or EOS if less than four suffix chars were parsed + + + + + Returns the third suffix char, or EOS if less than three suffix chars were parsed + + + + + Returns the second suffix char, or EOS if less than two suffix chars were parsed. + + + + + Returns the first suffix char, or EOS if no suffix char was parsed. + + + + + The parsed number literal string. Only includes the parsed suffix chars if the + `NumberLiteralOptions` passed to the `numberLiteral` parser have the `IncludeSuffixCharsInString` flag set. + + + + + Eencodes various bits of information on the string literal. + + + + + The return type of the `numberLiteral` parser. An instance contains the parsed + number literal and various bits of information about it. + Note that the `String` member contains the string literal without the suffix chars, + except if the `NumberLiteralOptions` passed to the `numberLiteral` parser have the + `IncludeSuffixCharsInString` flag set. + Any parsed suffix chars are always available through the `SuffixChar1` - `4` members. + + + + + Encodes the various options of the `numberLiteral` parser. + + + + + Failure(errorAsString, error, suserState) holds the parser error and the user state returned by a failing parser, + together with a string representation of the parser error. + + + + + Success(result, userState, endPos) holds the result and the user state returned by a successful parser, + together with the position where the parser stopped. + + + + + Values of this type are returned by the runParser functions (not by `Parser<_,_>` functions). + + + + + Returns the `float32` value represented by the given string in hexadecimal format. + Raises a `System.FormatException` in case the string representation is invalid. + Raises a `System.OverflowException` if the (absolute) value is too large to be represented by a `float32`. + + + + + Returns a hexadecimal string representation of the `float32` argument. + + + + + Returns the `float` value represented by the given string in hexadecimal format. + Raises a `System.FormatException` in case the string representation is invalid. + Raises a `System.OverflowException` if the (absolute) value is too large to be represented by a `float`. + + + + + Returns a hexadecimal string representation of the `float` argument. + + + + + `normalizeNewlines str` returns a version of `str` + with all occurances of "\r\n" and "\r" replaced by "\n". + If the argument is `null`, `null` is returned. + + + + + `foldCase str` returns a case-folded version of `str` + with all chars mappend using the (non-Turkic) Unicode 1-to-1 case folding mappings + for chars below 0x10000. If the argument is `null`, `null` is returned. + + + + + `EOS` is equal to `CharStream<'u>.EndOfStreamChar`. + + + + + `previousCharSatisfies f` succeeds if the predicate function `f` returns `false` + when applied to the previous char in the stream, otherwise it fails. + If there is no previous char (because the stream is at the beginning), + this parser succeeds (as opposed to `previousCharSatisfies`). + This parser never changes the parser state. + Any newline ("\n", "\r\n" or "\r") in the input is interpreted as a single char '\n'. + If this parser fails, it returns no descriptive error message; hence it should only be + used together with parsers that take care of a potential error. + + + + + `previousCharSatisfies f` succeeds if the predicate function `f` returns `true` + when applied to the previous char in the stream, otherwise it fails. + If there is no previous char (because the stream is at the beginning), + this parser fails (as opposed to `previousCharSatisfiesNot`). + This parser never changes the parser state. + Any newline ("\n", "\r\n" or "\r") in the input is interpreted as a single char '\n'. + If this parser fails, it returns no descriptive error message; hence it should only be + used together with parsers that take care of a potential error. + + + + + `next2CharsSatisfyNot f` succeeds if the predicate function `f` returns `false` + when applied to the next 2 chars in the input stream, otherwise it fails. + If there aren't 2 chars remaining in the input stream, this parser succeeds (as opposed to `next2CharsSatisfy`). + This parser never changes the parser state. + Any newline ("\n", "\r\n" or "\r") in the input is interpreted as a single char '\n'. + If this parser fails, it returns no descriptive error message; hence it should only be + used together with parsers that take care of a potential error. + + + + + `next2CharsSatisfy f` succeeds if the predicate function `f` returns `true` + when applied to the next 2 chars in the input stream, otherwise it fails. + If there aren't 2 chars remaining in the input stream, this parser fails (as opposed to `next2CharsSatisfyNot`). + This parser never changes the parser state. + Any newline ("\n", "\r\n" or "\r") in the input is interpreted as a single char '\n'. + If this parser fails, it returns no descriptive error message; hence it should only be + used together with parsers that take care of a potential error. + + + + + `nextCharSatisfiesNot f` is an optimized implementation of `notFollowedBy (satisfy f)`. + + + + + `nextCharSatisfies f` is an optimized implementation of `followedBy (satisfy f)`. + + + + + `notFollowedByStringCI str` is an optimized implementation of `notFollowedByL (pstringCI str) ("'" + str + "'")`. + + + + + `notFollowedByString str` is an optimized implementation of `notFollowedByL (pstring str) ("'" + str + "'")`. + + + + + `followedByStringCI str` is an optimized implementation of `followedByL (pstringCI str) ("'" + str + "'")`. + + + + + `followedByString str` is an optimized implementation of `followedByL (pstring str) ("'" + str + "'")`. + + + + + `notFollowedByNewline` is an optimized implementation of `notFollowedByL newline "newline"`. + + + + + `followedByNewline` is an optimized implementation of `followedByL newline "newline"`. + + + + + `notFollowedByEOF` is an optimized implementation of `notFollowedByL eof "end of input"`. + + + + + Parses an unsigned integer in decimal, hexadecimal ("0x" prefix), octal ("0o") or binary ("0b") format. + The parser fails + without consuming input, if not at least one digit (including the '0' in the format specifiers "0x" etc.) can be parsed, + after consuming input, if no digit comes after an exponent marker or no hex digit comes after a format specifier, + after consuming input, if the value represented by the input string is greater than 255. + + + + + Parses an unsigned integer in decimal, hexadecimal ("0x" prefix), octal ("0o") or binary ("0b") format. + The parser fails + without consuming input, if not at least one digit (including the '0' in the format specifiers "0x" etc.) can be parsed, + after consuming input, if no digit comes after an exponent marker or no hex digit comes after a format specifier, + after consuming input, if the value represented by the input string is greater than `System.UInt16.MaxValue`. + + + + + Parses an unsigned integer in decimal, hexadecimal ("0x" prefix), octal ("0o") or binary ("0b") format. + The parser fails + without consuming input, if not at least one digit (including the '0' in the format specifiers "0x" etc.) can be parsed, + after consuming input, if no digit comes after an exponent marker or no hex digit comes after a format specifier, + after consuming input, if the value represented by the input string is greater than `System.UInt32.MaxValue`. + + + + + Parses an unsigned integer in decimal, hexadecimal ("0x" prefix), octal ("0o") or binary ("0b") format. + The parser fails + without consuming input, if not at least one digit (including the '0' in the format specifiers "0x" etc.) can be parsed, + after consuming input, if no digit comes after an exponent marker or no hex digit comes after a format specifier, + after consuming input, if the value represented by the input string is greater than `System.UInt64.MaxValue`. + + + + + Parses an integer in decimal, hexadecimal ("0x" prefix), octal ("0o") or binary ("0b") format. + The parser fails + without consuming input, if not at least one digit (including the '0' in the format specifiers "0x" etc.) can be parsed, + after consuming input, if no digit comes after an exponent marker or no hex digit comes after a format specifier, + after consuming input, if the value represented by the input string is greater than 127 or less than -128. + + + + + Parses an integer in decimal, hexadecimal ("0x" prefix), octal ("0o") or binary ("0b") format. + The parser fails + without consuming input, if not at least one digit (including the '0' in the format specifiers "0x" etc.) can be parsed, + after consuming input, if no digit comes after an exponent marker or no hex digit comes after a format specifier, + after consuming input, if the value represented by the input string is greater than `System.Int16.MaxValue` or less than `System.Int16.MinValue`. + + + + + Parses an integer in decimal, hexadecimal ("0x" prefix), octal ("0o") or binary ("0b") format. + The parser fails + without consuming input, if not at least one digit (including the '0' in the format specifiers "0x" etc.) can be parsed, + after consuming input, if no digit comes after an exponent marker or no hex digit comes after a format specifier, + after consuming input, if the value represented by the input string is greater than `System.Int32.MaxValue` or less than `System.Int32.MinValue`. + + + + + Parses an integer in decimal, hexadecimal ("0x" prefix), octal ("0o") or binary ("0b") format. + The parser fails + without consuming input, if not at least one digit (including the '0' in the format specifiers "0x" etc.) can be parsed, + after consuming input, if no digit comes after an exponent marker or no hex digit comes after a format specifier, + after consuming input, if the value represented by the input string is greater than `System.Int64.MaxValue` or less than `System.Int64.MinValue`. + + + + + Parses a floating-point number in decimal or hexadecimal format. + The special values NaN and Inf(inity)? (case insensitive) are also recognized. + + The parser fails + without consuming input, if not at least one digit (including the '0' in "0x") can be parsed, + after consuming input, if no digit comes after an exponent marker or no hex digit comes after "0x", + after consuming input, if the value represented by the input string (after rounding) is greater than `System.Double.MaxValue` or less than `System.Double.MinValue`. + + + + + `numberLiteralE` is an uncurried version of `numberLiteral` that can be used to + implement number parsers without having to construct a `numberLiteral` closure. + + + + + `numberLiteral options label` parses a number literal and returns the result in form + of a `NumberLiteral` value. The given `NumberLiteralOptions` argument determines the kind + of number literals accepted. The string `label` is used in the `Expected` error message + that is generated when the parser fails without consuming input. + + The parser fails without consuming input, if not at least one digit (including the 0 in the + format specifiers "0x" etc.) can be parsed. It fails after consuming input, if no decimal + digit comes after an exponent marker or no valid digit comes after a format specifier. + + + + + `p |> withSkippedString f` applies the parser `p` and returns the result of `f str x`, + where `str` is the string skipped over by `p` and `x` is the result returned by `p`. + + + + + `skipped p` applies the parser `p` and returns the chars skipped over by `p` as a string. + All newlines ("\r\n", "\r" or "\n") are normalized to "\n". + + + + + `stringsSepBy1 sp sep` parses *one* or more occurrences of `sp` separated by `sep`. + It returns the strings parsed by `sp` *and* `sep` in concatenated form. + + + + + `stringsSepBy sp sep` parses *zero* or more occurrences of `sp` separated by `sep`. + It returns the strings parsed by `sp` *and* `sep` in concatenated form. + + + + + `many1Strings2 sp1 sp` behaves like `many1Strings sp`, except that it parses the first string with `sp1` instead of `sp`. + + + + + `many1Strings sp` parses a sequence of *one* or more strings with the string parser `sp`. + It returns the strings in concatenated form. + Note that `many1Strings sp` does not require the first string to be non-empty. + + + + + `manyStrings2 sp1 sp` behaves like `manyStrings sp`, except that it parses the first string with `sp1` instead of `sp`. + + + + + `manyStrings sp` parses a sequence of *zero* or more strings with the string parser `sp`. + It returns the strings in concatenated form. + `manyStrings sp` is an optimized implementation of `manyReduce (+) "" sp`. + + + + + `many1CharsTillApply2 cp1 cp endp` behaves like `many1CharsTillApply cp endp`, except that it parses the first char with `cp1` instead of `cp`. + + + + + `many1CharsTillApply cp endp` parses one char with the char parser `cp`. + Then it parses more chars with `cp` until the parser `endp` succeeds. + It stops after `endp` and returns the result of the function application `f str b`, + where `str` is the parsed string and `b` is result returned by `endp`. + + + + + `many1CharsTill2 cp1 cp endp` behaves like `many1CharsTill cp endp`, except that it parses the first char with `cp1` instead of `cp`. + + + + + `many1CharsTill cp endp` parses one char with the char parser `cp`. + Then it parses more chars with `cp` until the parser `endp` succeeds. + It stops after `endp` and returns the parsed chars as a string. + + `many1CharsTill cp endp` is an optimized implementation of `pipe2 cp (manyCharsTill cp endp) (fun c1 str -> c1.ToString() + str)` + + + + + `manyCharsTillApply2 cp1 cp endp` behaves like `manyCharsTillApply cp endp`, except that it parses the first char with `cp1` instead of `cp`. + + + + + `manyCharsTillApply cp endp f` parses chars with the char parser `cp` until the parser `endp` succeeds. + It stops after `endp` and returns the result of the function application `f str b`, + where `str` is the parsed string and `b` is result returned by `endp`. + + + + + `manyCharsTill2 cp1 cp endp` behaves like `manyCharsTill cp endp`, except that it parses the first char with `cp1` instead of `cp`. + + + + + `manyCharsTill cp endp` parses chars with the char parser `cp` until the parser `endp` succeeds. + It stops after `endp` and returns the parsed chars as a string. + + + + + `many1Chars2 cp1 cp` behaves like `many1Chars2 cp`, except that it parses the first char with `cp1` instead of `cp`. + + + + + `many1Chars cp` parses a sequence of *one* or more chars with the char parser `cp`. + It returns the parsed chars as a string. + + `many1Chars cp` is an optimized implementation of `many1 (attempt cp)` that returns + the chars as a string instead of a char list. The equivalence to `many1 (attempt p)` + instead of `many1 p` implies that `many1Chars` never fails after consuming input. + + + + + `manyChars2 cp1 cp` behaves like `manyChars2 cp`, except that it parses the first char with `cp1` instead of `cp`. + + + + + `manyChars cp` parses a sequence of *zero* or more chars with the char parser `cp`. + It returns the parsed chars as a string. + + `manyChars cp` is an optimized implementation of `many (attempt cp)` that returns + the chars as a string instead of a char list. The equivalence to `many (attempt p)` + instead of `many p` implies that `manyChars` never fails. + + + + + The `identifier` parser is a configurable parser for the XID identifier syntax + specified in Unicode Standard Annex #31. + + + + + `regexL pattern label` is an optimized implementation of `regex pattern <?> label`. + + + + + `regex pattern` matches the .NET regular expression given by the string `pattern` on the chars + beginning at the current index in the input stream. It returns the string matched by the regular expression. + If the regular expression does not match, the parser fails without consuming input. + + The `System.Text.RegularExpressions.Regex` object that is internally used to match the pattern is constructed + with the `RegexOptions` `MultiLine` and `ExplicitCapture`. In order to ensure that the regular expression + can only match at the beginning of a string, "\\A" is automatically prepended to the pattern. + + Newline chars ('\r' and '\n') in the pattern are interpreted literally. + For example, an '\n' char in the pattern will only match "\n", not "\r" or "\r\n". + However, in the returned string all newlines ("\n", "\r\n" or "\r") are normalized to "\n". + + For large files the regular expression is *not* applied to a string containing *all* the remaining chars + in the stream. The number of chars that are guaranteed to be visible to the regular expression is specified + during construction of the `CharStream`. If one of the `runParser` function` is used to run the parser, + this number is 43690. + + + + + `skipManyMinMaxSatisfy2L minCount maxCount f1 f label` is an optimized implementation of `skipManyMinMaxSatisfy2 minCount maxCount f1 f <?> label`. + + + + + `skipManyMinMaxSatisfyL minCount maxCount f label` is an optimized implementation of `skipManyMinMaxSatisfy minCount maxCount f <?> label`. + + + + + `manyMinMaxSatisfy2L minCount maxCount f1 f label` is an optimized implementation of `manyMinMaxSatisfy2 minCount maxCount f1 f <?> label`. + + + + + `manyMinMaxSatisfyL minCount maxCount f label` is an optimized implementation of `manyMinMaxSatisfy minCount maxCount f <?> label`. + + + + + `skipManyMinMaxSatisfy2 minCount maxCount f1 f` is an optimized implementation of `manyMinMaxSatisfy2 minCount maxCount f1 f |>> ignore`. + + + + + `skipManyMinMaxSatisfy minCount maxCount f` is an optimized implementation of `manyMinMaxSatisfy minCount maxCount f |>> ignore`. + + + + + `manyMinMaxSatisfy2 minCount maxCount f1 f` behaves like `manyMinMaxSatisfy minCount maxCount f`, except that the first char of the parsed string must satisfy `f1` instead of `f`. + + + + + `manyMinMaxSatisfy minCount maxCount f` parses a sequence of `minCount` or more chars that satisfy the + predicate function `f` (i.e. chars for which `f` returns `true`), but not more than `maxCount` chars. + It returns the parsed chars as a string. This parser is atomic, i.e. if the first `minCount` chars + do not all satisfy `f`, the parser fails without consuming any input. + + Any newline ("\n", "\r\n" or "\r") is converted to the single char '\n'. + Thus, to accept a newline `f '\n'` must return `true`. `f` will never be called with '\r' + and the string returned by `manyMinMaxSatisfy minCount maxCount f` will never contain an '\r'. + + `manyMinMaxSatisfy` throws an `ArgumentOutOfRangeException` if `maxCount` is negative. + + + + + `skipMany1Satisfy2L f1 f label` is an optimized implementation of `skipMany1Satisfy2 f1 f <?> label`. + + + + + `skipMany1SatisfyL f label` is an optimized implementation of `skipMany1Satisfy f <?> label`. + + + + + `many1Satisfy2L f1 f label` is an optimized implementation of `many1Satisfy2 f1 f <?> label`. + + + + + `many1SatisfyL f label` is an optimized implementation of `many1Satisfy f <?> label`. + + + + + `skipMany1Satisfy2 f1 f` is an optimized implementation of `many1Satisfy2 f1 f |>> ignore`. + + + + + `skipMany1Satisfy f` is an optimized implementation of `many1Satisfy f |>> ignore`. + + + + + `many1Satisfy2 f1 f` behaves like `many1Satisfy f`, except that the + first char of the parsed string must satisfy `f1` instead of `f`. + + + + + `many1Satisfy f` parses a sequence of *one* or more chars that satisfy the predicate function `f` + (i.e. chars for which `f` returns `true`). It returns the parsed chars as a string. + If the first char does not satisfy `f`, this parser fails without consuming input. + + Any newline ("\n", "\r\n" or "\r") is converted to the single char '\n'. + Thus, to accept a newline `f '\n'` must return `true`. `f` will never be called + with '\r' and the string returned by `many1Satisfy f` will never contain an '\r'. + + + + + `skipManySatisfy2 f1 f` is an optimized implementation of `manySatisfy2 f1 f |>> ignore`. + + + + + `skipManySatisfy f` is an optimized implementation of `manySatisfy f |>> ignore`. + + + + + `manySatisfy2 f1 f` behaves like `manySatisfy f`, except that the + first char of the parsed string must satisfy `f1` instead of `f`. + + + + + `manySatisfy f` parses a sequence of *zero* or more chars that satisfy the predicate function `f` + (i.e. chars for which `f` returns `true`). It returns the parsed chars as a string. + + Any newline ("\n", "\r\n" or "\r") is converted to the single char '\n'. + Thus, to accept a newline `f '\n'` must return `true`. `f` will never be called + with '\r' and the string returned by `manySatisfy f` will never contain an '\r'. + + + + + `skipCharsTillStringCI str maxCount` is an optimized implementation of `charsTillStringCI str maxCount |>> ignore`. + + + + + `charsTillStringCI str skipString maxCount` parses all chars before the first case-insensitive occurance of the string `str` and, + if `skipString` is `true`, skips over it. It returns the parsed chars before the string. + If more than `maxCount` chars come before the first case-insensitive occurance of `str`, + the parser *fails* after consuming `maxCount` chars. + Newlines ("\n", "\r\n" or "\r") are counted as single chars and + in the returned string all newlines are normalized to "\n". + `charsTillStringCI str maxCount` throws an `ArgumentOutOfRangeException` if `maxCount` is negative. + + + + + `skipCharsTillString str maxCount` is an optimized implementation of `charsTillString str maxCount |>> ignore`. + + + + + `charsTillString str skipString maxCount` parses all chars before the first occurance of the string `str` and, + if `skipString` is `true`, skips over `str`. It returns the parsed chars before the string. + If more than `maxCount` chars come before the first occurance of `str`, the parser *fails after consuming* `maxCount` chars. + Newlines ("\n", "\r\n" or "\r") are counted as single chars and + in the returned string all newlines are normalized to "\n". + `charsTillString str maxCount` throws an `ArgumentOutOfRangeException` if `maxCount` is negative. + + + + + `skipRestOfLine skipNewline` is an optimized implementation of `restOfLine skipNewline |>> ignore`. + + + + + `restOfLine skipNewline` parses any chars before the end of the line + and, if `skipNewline` is `true`, skips to the beginning of the next line (if there is one). + It returns the parsed chars before the end of the line as a string (without a newline). + A line is terminated by a newline ("\n", "\r\n" or "\r") or the end of the input stream. + + + + + `skipAnyString n` is an optimized implementation of `anyString n |>> ignore`. + + + + + `anyString n` parses any sequence of `n` chars or newlines ("\n", "\r\n" or "\r"). + It returns the parsed string. In the returned string all newlines are normalized to "\n". + `anyString n` is an atomic parser: either it succeeds or it fails without consuming any input. + + + + + `stringCIReturn str x` is an optimized implementation of `pstringCI str >>% x`. + + + + + `skipStringCI str` is an optimized implementation of `pstringCI str |>> ignore`. + + + + + `pstringCI str` parses any string that case-insensitively matches the string `str`. + It returns the *parsed* string. + `str` may not contain newline chars ('\n' or '\r'). + + + + + `stringReturn str x` is an optimized implementation of `pstring str >>% x`. + + + + + `skipString str` is an optimized implementation of `pstring str |>> ignore`. + + + + + `pstring str` parses the string `str` and returns `str`. + It is an atomic parser: either it succeeds or it fails without consuming any input. + `str` may not contain newline chars ('\n' or '\r'). + + + + + The parser `eof` only succeeds at the end of the input. It never consumes input. + + + + + Skips over any sequence of *one* or more unicode whitespaces and + registers any unicode newline ("\n", "\r\n", "\r", "\u0085, "\u000C", + "\u2028"or "\u2029") as a newline. + + + + + Skips over any sequence of *one* or more unicode whitespaces and + registers any unicode newline ("\n", "\r\n", "\r", "\u0085, "\u000C", + "\u2028"or "\u2029") as a newline. + + + + + Skips over any sequence of *one* or more whitespaces (space (' '), tab('\t') + or newline ("\n", "\r\n" or "\r")). + + + + + Skips over any sequence of *zero* or more whitespaces (space (' '), tab ('\t') + or newline ("\n", "\r\n" or "\r")). + + + + + `newlineReturn x` is an optimized implementation of `unicodeNewline >>% x`. + + + + + `skipNewline` is an optimized implementation of `unicodeNewline |>> ignore`. + + + + + Parses a unicode newline ("\n", "\r\n", "\r", "\u0085", "\u2028", or "\u2029"). + Returns '\n'. Note that this parser does not accept the formfeed char '\f' as a newline. + In contrast to most other parsers in FParsec this parser also increments + the internal line count for unicode newline characters other than '\n' and '\r'. + + + + + `newlineReturn x` is an optimized implementation of `newline >>% x`. + + + + + `skipNewline` is an optimized implementation of `newline |>> ignore`. + + + + + Parses a newline ("\n", "\r\n" or "\r"). Returns '\n'. + Is equivalent to `pchar '\n'`. + + + + + Parses the tab char '\t' and returns '\t'. Note that a tab char is treated like any other non-newline char: + the column number is incremented by (only) 1. + + + + + Returns `true` for any char in the range '0' - '7' and `false` for all other chars. + + + + + Returns `true` for any char in the range '0' - '9', 'a' - 'f', 'A' - 'F' and `false` for all other chars. + + + + + Returns `true` for any char in the range '0' - '9' and `false` for all other chars. + + + + + `isLetter` is equivalent to `System.Char.IsLetter`. + + + + + `isLower` is equivalent to `System.Char.IsLower`. + + + + + `isUpper` is equivalent to `System.Char.IsUpper`. + + + + + Returns `true` for any char in the range 'a' - 'z', 'A' - 'Z' and `false` for all other chars. + + + + + Returns `true` for any char in the range 'a' - 'z' and `false` for all other chars. + + + + + Returns `true` for any char in the range 'A' - 'Z' and `false` for all other chars. + + + + + `isNoneOf str` returns a predicate function. + When this predicate function is applied to a char, it returns `true` if and only if the char is not contained in `str`. + + + + + `isAnyOf str` returns a predicate function. + When this predicate function is applied to a char, it returns `true` if and only if the char is contained in `str`. + + + + + Parses any char in the range '0' - '7'. Returns the parsed char. + + + + + Parses any char in the range '0' - '9', 'a' - 'f' and 'A' - 'F'. Returns the parsed char. + + + + + Parses any char in the range '0' - '9'. Returns the parsed char. + + + + + Parses any UTF-16 letter char identified by `System.Char.IsLetter`. + Returns the parsed char. + + + + + Parses any UTF-16 lowercase letter char identified by `System.Char.IsLower`. + Returns the parsed char. + + + + + Parses any UTF-16 uppercase letter char identified by `System.Char.IsUpper`. + Returns the parsed char. + + + + + Parses any char in the range 'a' - 'z' and 'A' - 'Z'. Returns the parsed char. + + + + + Parses any char in the range 'a' - 'z'. Returns the parsed char. + + + + + Parses any char in the range 'A' - 'Z'. Returns the parsed char. + + + + + `skipNoneOf s` is an optimized implementation of `noneOf s |>> ignore`. + + + + + `noneOf str` parses any char not contained in the string `str`. It returns the parsed char. + If `str` does not contain the char '\n', `noneOf str` parses any newline ("\n", "\r\n" or "\r") + and returns it as as '\n'. (Note that it does not make a difference whether or not + `str` contains '\r'; `noneOf str` will never return '\r'.) + + + + + `skipAnyOf str` is an optimized implementation of `anyOf str |>> ignore`. + + + + + `anyOf str` parses any char contained in the string `str`. It returns the parsed char. + If `str` contains the char '\n', `anyOf str` parses any newline ("\n", "\r\n" or "\r") + and returns it as '\n'. (Note that it does not make a difference whether or not + `str` contains '\r'; `anyOf str` will never return '\r'.) + + + + + `skipSatisfyL f label` is an optimized implementation of `skipSatisfy f <?> label`. + + + + + `satisfy f label` is an optimized implementation of `satisfy f <?> label`. + + + + + `skipSatisfy f` is an optimized implementation of `satisfy f |>> ignore`. + + + + + `satisfy f` parses any one char or newline for which the predicate function `f` returns `true`. + It returns the parsed char. + Any newline ("\n", "\r\n" or "\r") is converted to the single char '\n'. + Thus, to accept a newline `f '\n'` must return `true`. `f` will never be called + with '\r' and `satisfy f` will never return the result '\r'. + + + + + `skipAnyChar` is an optimized implementation of `anyChar |>> ignore`. + + + + + `anyChar` parses any single char or newline ("\n", "\r\n" or "\r"). + Returns the parsed char, or '\n' in case a newline was parsed. + + + + + `charReturn c x` is an optimized implementation of `pchar c >>% x`. + + + + + `skipChar c` is an optimized implementation of `pchar c |>> ignore`. + + + + + `pchar c` parses the char `c` and returns `c`. + If `c = '\r'` or `c = '\n'` then `pchar c` will parse any one newline ("\n", "\r\n" or "\r") and return `c`. + + + + + The parser `userStateSatisfies f` succeeds if `f` returns `true` + when applied to the current user state, otherwise it fails. + + + + + `updateUserState f` is equivalent to `fun stream -> stream.UserState <- f stream.UserState; Reply(())`. + + + + + The parser `setUserState u` sets the user state to `u`. + `setUserState u` is equivalent to `fun stream -> stream.UserState <- u; Reply(())`. + + + + + The parser `getUserState` returns the current user state. + `getUserState` is equivalent to `fun stream -> Reply(stream.UserState)`. + + + + + The parser `getPosition` returns the current position in the input Stream. + `getPosition` is equivalent to `fun stream -> Reply(stream.Position)`. + + + + + `run parser str` is a convenient abbreviation for `runParserOnString parser () "" str`. + + + + + `runParserOnFile p ustate path encoding` runs the parser `p` on the content of the file + at the given `path`, starting with the initial user state `ustate`. + In case no unicode byte order mark is found, the file data is assumed to be encoded with the given `encoding`. + The parser's `Reply` is captured and returned as a `ParserResult` value. + + + + + `runParserOnStream p ustate streamName stream encoding` runs the parser `p` on the content of + the `System.IO.Stream` `stream`, starting with the initial user state `ustate`. The `streamName` + is used in error messages to describe the source of the input (e.g. a file path) and may be empty. + In case no unicode byte order mark is found, the stream data is assumed to be encoded with the given `encoding`. + The parser's `Reply` is captured and returned as a `ParserResult` value. + + + + + `runParserOnSubstring p ustate streamName str index count` runs the parser `p` directly on the content + of the string `str` between the indices `index` (inclusive) and `index + count` (exclusive), + starting with the initial user state `ustate`. The `streamName` is used in error messages to describe + the source of the input (e.g. a file path) and may be empty. + The parser's `Reply` is captured and returned as a `ParserResult` value. + + + + + `runParserOnString p ustate streamName str` runs the parser `p` directly on the content of the string `str`, + starting with the initial user state `ustate`. The `streamName` is used in error messages to describe + the source of the input (e.g. a file path) and may be empty. + The parser's `Reply` is captured and returned as a `ParserResult` value. + + + + diff --git a/packages/FAKE.5.16.0/tools/FParsecCS.dll b/packages/FAKE.5.16.0/tools/FParsecCS.dll new file mode 100644 index 0000000..4b8566f Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FParsecCS.dll differ diff --git a/packages/FAKE.5.16.0/tools/FParsecCS.xml b/packages/FAKE.5.16.0/tools/FParsecCS.xml new file mode 100644 index 0000000..c0a3272 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/FParsecCS.xml @@ -0,0 +1,101 @@ + + + + FParsecCS + + + + An opaque representation of a CharStream index. + + + Returns -1 if the IndexToken was zero-initialized. + + + Provides read‐access to a sequence of UTF‐16 chars. + + + The current index in the string, or Int32.MinValue if the end of the stream has been reached. + + + Index of the first char in the string belonging to the stream. Is always non-negative. + + + 1 + index of the last char in the string belonging to the stream. Equals IndexBegin if the stream is empty. + + + Any CharStream method or property setter increments this value when it changes the CharStream state. + Backtracking to an old state also restores the old value of the StateTag. + + + IndexOfFirstChar - IndexBegin + + + Indicates whether the Iterator points to the beginning of the CharStream. + If the CharStream is empty, this property is always true. + + + Indicates whether the Iterator points to the end of the CharStream, + i.e. whether it points to one char beyond the last char in the CharStream. + + + The UTF‐16 column number of the next char, i.e. Index ‐ LineBegin + 1. + + + The low trust version of the CharStream class implements the IDisposable + interface only for API compatibility. The Dispose method does not need to be called on + low trust CharStream instances, because the instances hold no resources that need to be disposed. + + + Provides read‐access to a sequence of UTF‐16 chars. + + + For reference types it's faster to call Instance.Equals directly + (due to limitations of the inliner of the .NET JIT.) + + + Forwards all work to F#'s GenericEqualityERComparer. + + + Returns the normalized string, or null in case an invalid identifier + character is found. If an invalid character is found, the string index of the + invalid character is assigned to the out parameter, otherwise -1. + + + The length of LhsOps and RhsOps. Must be a power of 2. + + + ParsePrefixOp returns this value to signal that it backtracked and we should try to parse a term. + + + Can not be readonly because it is passed as as a ref (for performance reasons), but it is never mutated. + + + Parses the following prefix operators, plus the expression the operators apply to. + + + Parses (higher-precedence) infix and postfix operators after the first term, together with the argument expressions. + + + Detects the presence of an encoding preamble in the first count bytes of the byte buffer. + If detectEncoding is false, this function only searches for the preamble of the given default encoding, + otherwise also for any of the standard unicode byte order marks (UTF-8, UTF-16 LE/BE, UTF-32 LE/BE). + If an encoding different from the given default encoding is detected, the new encoding + is assigned to the encoding reference. + Returns the number of bytes in the detected preamble, or 0 if no preamble is detected. + + + + Returns a case-folded copy of the string argument. All chars are mapped + using the (non-Turkic) 1-to-1 case folding mappings (v. 6.0) for Unicode code + points in the Basic Multilingual Plane, i.e. code points below 0x10000. + If the argument is null, null is returned. + + + Returns the given string with all occurrences of "\r\n" and "\r" replaced + by "\n". If the argument is null, null is returned. + + + A faster implementation of System.Globalization.StringInfo(str).LengthInTextElements. + + + diff --git a/packages/FAKE.4.11.3/FAKE.4.11.3.nupkg b/packages/FAKE.5.16.0/tools/FSharp.Compiler.Service.dll similarity index 61% rename from packages/FAKE.4.11.3/FAKE.4.11.3.nupkg rename to packages/FAKE.5.16.0/tools/FSharp.Compiler.Service.dll index 32ad070..892304b 100644 Binary files a/packages/FAKE.4.11.3/FAKE.4.11.3.nupkg and b/packages/FAKE.5.16.0/tools/FSharp.Compiler.Service.dll differ diff --git a/packages/FAKE.5.16.0/tools/FSharp.Compiler.Service.xml b/packages/FAKE.5.16.0/tools/FSharp.Compiler.Service.xml new file mode 100644 index 0000000..78a1424 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/FSharp.Compiler.Service.xml @@ -0,0 +1,30759 @@ + + +FSharp.Compiler.Service + + + + Consider using 'yield!' instead of 'yield'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:31) + + + + + The byref pointer is readonly, so this write is not permitted. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1444) + + + + + The value '%s' is not accessible from this code location + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:950) + + + + + Use reference assemblies for .NET framework references when available (Enabled by default). + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1466) + + + + + The union cases or fields of the type '%s' are not accessible from this code location + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:949) + + + + + The union case '%s' is not accessible from this code location + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:951) + + + + + The value or constructor '%s' is not defined. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:8) + + + + + The value, namespace, type or module '%s' is not defined. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:9) + + + + + The value, constructor, namespace or type '%s' is not defined. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:7) + + + + + The type parameter %s is not defined. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:16) + + + + + The type '%s' is not defined in '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:12) + + + + + The type '%s' is not defined. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:11) + + + + + Maybe you want one of the following: + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:15) + + + + + The record label or namespace '%s' is not defined. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:13) + + + + + The record label '%s' is not defined. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:14) + + + + + The pattern discriminator '%s' is not defined. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:17) + + + + + The namespace or module '%s' is not defined. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:5) + + + + + The namespace '%s' is not defined. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:4) + + + + + The field, constructor or member '%s' is not defined. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:6) + + + + + The constructor, module or namespace '%s' is not defined. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:10) + + + + + The type '%s' implements 'System.IComparable'. Consider also adding an explicit override for 'Object.Equals' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:171) + + + + + The type '%s' implements 'System.IComparable' explicitly but provides no corresponding override for 'Object.Equals'. An implementation of 'Object.Equals' has been automatically provided, implemented via 'System.IComparable'. Consider implementing the override 'Object.Equals' explicitly + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:172) + + + + + The signature and implementation are not compatible because the respective type parameter counts differ + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:167) + + + + + The signature and implementation are not compatible because the type parameter '%s' has a constraint of the form %s but the implementation does not. Either remove this constraint from the signature or add it to the implementation. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:170) + + + + + The signature and implementation are not compatible because the declaration of the type parameter '%s' requires a constraint of the form %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:169) + + + + + The signature and implementation are not compatible because the type parameter in the class/signature has a different compile-time requirement to the one in the member/implementation + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:168) + + + + + The override for '%s' was ambiguous + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:187) + + + + + The override '%s' implements more than one abstract slot, e.g. '%s' and '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:190) + + + + + No implementations of '%s' had the correct number of arguments and type parameters. The required signature is '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:186) + + + + + No implementation was given for '%s'. Note that all interface members must be implemented and listed under an appropriate 'interface' declaration, e.g. 'interface ... with member ...'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:195) + + + + + No implementation was given for those members: %sNote that all interface members must be implemented and listed under an appropriate 'interface' declaration, e.g. 'interface ... with member ...'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:197) + + + + + No implementation was given for those members (some results omitted): %sNote that all interface members must be implemented and listed under an appropriate 'interface' declaration, e.g. 'interface ... with member ...'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:199) + + + + + No implementation was given for those members (some results omitted): %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:198) + + + + + No implementation was given for those members: %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:196) + + + + + No implementation was given for '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:194) + + + + + The interface '%s' is included in multiple explicitly implemented interface types. Add an explicit implementation of this interface. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:192) + + + + + A named argument has been assigned more than one value + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:193) + + + + + More than one override implements '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:188) + + + + + The namespace or module attributes differ between signature and implementation + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:184) + + + + + The method '%s' is sealed and cannot be overridden + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:189) + + + + + This method is over-constrained in its type parameters + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:185) + + + + + The member '%s' matches multiple overloads of the same method.\nPlease restrict it to one of the following:%s. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1351) + + + + + The member '%s' does not have the correct number of method type parameters. The required signature is '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:201) + + + + + The member '%s' does not have the correct number of arguments. The required signature is '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:200) + + + + + The member '%s' does not have the correct kinds of generic parameters. The required signature is '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:202) + + + + + The member '%s' cannot be used to implement '%s'. The required signature is '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:203) + + + + + Invalid value + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:166) + + + + + The struct, record or union type '%s' has an explicit implementation of 'Object.GetHashCode' or 'Object.Equals'. You must apply the 'CustomEquality' attribute to the type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:173) + + + + + The struct, record or union type '%s' has an explicit implementation of 'Object.GetHashCode'. Consider implementing a matching override for 'Object.Equals(obj)' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:174) + + + + + The struct, record or union type '%s' has an explicit implementation of 'Object.Equals'. Consider implementing a matching override for 'Object.GetHashCode()' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:175) + + + + + Duplicate or redundant interface + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:191) + + + + + The implicit instantiation of a generic construct at or near this point could not be resolved because it could resolve to multiple unrelated types, e.g. '%s' and '%s'. Consider using type annotations to resolve the ambiguity + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:162) + + + + + Could not resolve the ambiguity in the use of a generic construct with an 'unmanaged' constraint at or near this position + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1064) + + + + + Could not resolve the ambiguity inherent in the use of a 'printf'-style format string + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:163) + + + + + Could not resolve the ambiguity in the use of a generic construct with an 'enum' constraint at or near this position + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:164) + + + + + Could not resolve the ambiguity in the use of a generic construct with a 'delegate' constraint at or near this position + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:165) + + + + + The type '%s' is not accessible from this code location + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:948) + + + + + union case + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:923) + + + + + property + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:928) + + + + + patvar + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:933) + + + + + and %d other overloads + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:922) + + + + + namespace/module + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:936) + + + + + namespace + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:934) + + + + + module + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:935) + + + + + generated type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:940) + + + + + generated property + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:939) + + + + + Full name + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:918) + + + + + also from %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:938) + + + + + from %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:937) + + + + + field + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:926) + + + + + extension + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:929) + + + + + event + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:927) + + + + + custom operation + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:930) + + + + + Calls + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1255) + + + + + argument + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:931) + + + + + anonymous record field + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:932) + + + + + active recognizer + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:925) + + + + + active pattern result + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:924) + + + + + \nA tuple type is required for one or more arguments. Consider wrapping the given arguments in additional parentheses or review the definition of the interface. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:32) + + + + + The specified .NET Framework version '%s' is not supported. Please specify a value from the enumeration Microsoft.Build.Utilities.TargetDotNetFrameworkVersion. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1106) + + + + + Unexpected Expr.TyChoose + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:958) + + + + + Note: Lambda-lifting optimizations have not been applied because of the use of this local constrained generic function as a first class value. Adding type constraints may resolve this condition. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:959) + + + + + The 'VolatileField' attribute may only be used on 'let' bindings in classes + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:660) + + + + + Volatile fields must be marked 'mutable' and cannot be thread-static + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:715) + + + + + A declaration may only be given a value in a signature if the declaration has the [<Literal>] attribute + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:713) + + + + + In sequence expressions, multiple results are generated using 'yield!' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:635) + + + + + Character range matches have been removed in F#. Consider using a 'when' pattern guard instead. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:568) + + + + + 'use' expressions may not be used in queries + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1272) + + + + + The use of 'let! x = coll' in sequence expressions is not permitted. Use 'for x in coll' instead. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:633) + + + + + This declaration is not supported in recursive declaration groups + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1341) + + + + + This attribute cannot be used in this version of F# + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:687) + + + + + This is not a known query operator. Query operators are identifiers such as 'select', 'where', 'sortBy', 'thenBy', 'groupBy', 'groupValBy', 'join', 'groupJoin', 'sumBy' and 'averageBy', defined using corresponding methods on the 'QueryBuilder' type. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1275) + + + + + Arguments to query operators may require parentheses, e.g. 'where (x > y)' or 'groupBy (x.Length / 10)' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1283) + + + + + Unrecognized attribute target. Valid attribute targets are 'assembly', 'module', 'type', 'method', 'property', 'return', 'param', 'field', 'event', 'constructor'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:677) + + + + + The unnamed arguments do not form a prefix of the arguments of the method called + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:654) + + + + + Unknown union case + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:507) + + + + + Unit-of-measure cannot be used in type constructor application + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:544) + + + + + This union case takes one argument + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:562) + + + + + The union case named '%s' conflicts with the generated type '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1085) + + + + + Union case/exception field '%s' cannot be used more than once. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1310) + + + + + This union case expects %d arguments in tupled form + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:563) + + + + + This union case does not take arguments + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:561) + + + + + The union case '%s' does not have a field named '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1306) + + + + + Uninitialized 'val' fields must be mutable and marked with the '[<DefaultValue>]' attribute. Consider using a 'let' binding instead of a 'val' field. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:716) + + + + + Unexpected type arguments + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:553) + + + + + Unexpected %s in type expression + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:547) + + + + + Unexpected / in type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:552) + + + + + Unexpected source-level property specification + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:518) + + + + + Unexpected source-level property specification in syntax tree + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:512) + + + + + Unexpected SynMeasure.Anon + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:468) + + + + + Unexpected expression at recursive inference point + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:497) + + + + + Unexpected Const_uint16array + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:473) + + + + + Unexpected Const_bytearray + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:474) + + + + + Unexpected condition in imported assembly: failed to decode AttributeUsage attribute + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:676) + + + + + Unexpected big rational constant + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:471) + + + + + The field '%s' has been given a value, but is not present in the type '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:600) + + + + + Unable to parse format string '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:578) + + + + + Types cannot inherit from multiple concrete types + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:766) + + + + + Types cannot contain nested type definitions + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:746) + + + + + Struct types are always sealed + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:778) + + + + + Record types are always sealed + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:776) + + + + + Enum types are always sealed + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:780) + + + + + Delegate types are always sealed + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:779) + + + + + Discriminated union types are always sealed + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:775) + + + + + Assembly code types are always sealed + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:777) + + + + + The type '%s' is used in an invalid way. A value prior to '%s' has an inferred type involving '%s', which is an invalid forward reference. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:803) + + + + + This type test or downcast will erase the provided type '%s' to the type '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1194) + + + + + This type test or downcast will ignore the unit-of-measure '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1097) + + + + + This type test with a provided type '%s' is not allowed because this provided type will be erased to '%s' at runtime. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1196) + + + + + This type requires a definition + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:763) + + + + + The type parameters inferred for this value are not stable under the erasure of type abbreviations. This is due to the use of type abbreviations which drop or reorder type parameters, e.g. \n\ttype taggedInt<'a> = int or\n\ttype swap<'a,'b> = 'b * 'a.\nConsider declaring the type parameters for this value explicitly, e.g.\n\tlet f<'a,'b> ((x,y) : swap<'b,'a>) : swap<'a,'b> = (y,x). + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:502) + + + + + Type parameter cannot be used as type constructor + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:548) + + + + + This type parameter has been used in a way that constrains it to always be '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:501) + + + + + This value, type or method expects %d type parameter(s) but was given %d + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:524) + + + + + type or module + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:748) + + + + + The type '%s' is not an interface type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:723) + + + + + This type is not an interface type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:741) + + + + + This type is not a record type. Values of class and struct types must be created using calls to object constructors. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:628) + + + + + This type is not a record type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:629) + + + + + This type is not accessible from this code location + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:675) + + + + + This type has no nested types + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:546) + + + + + This type has no accessible object constructors + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:638) + + + + + type, exception or module + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:747) + + + + + This type does not inherit Attribute, it will not work correctly with other .NET languages. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1460) + + + + + Type definitions may only have one 'inherit' specification and it must be the first declaration + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:796) + + + + + 'let' and 'do' bindings must come before member and interface definitions in type definitions + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:797) + + + + + This type definition involves an immediate cyclic reference through a struct field or inheritance relation + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:792) + + + + + This type definition involves an immediate cyclic reference through an abbreviation + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:791) + + + + + This downcast will erase the provided type '%s' to the type '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1195) + + + + + The type '%s' is not a type whose values can be enumerated with this syntax, i.e. is not compatible with either seq<_>, IEnumerable<_> or IEnumerable and does not have a GetEnumerator method + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:531) + + + + + Type abbreviations cannot have members + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:730) + + + + + As of F# 4.1, the accessibility of type abbreviations is checked at compile-time. Consider changing the accessibility of the type abbreviation. Ignoring this warning might lead to runtime errors. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:731) + + + + + Type abbreviations cannot have interface declarations + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:739) + + + + + Type abbreviations cannot have augmentations + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:801) + + + + + This type abbreviation has one or more declared type parameters that do not appear in the type being abbreviated. Type abbreviations must use all declared type parameters in the type being abbreviated. Consider removing one or more type parameters, or use a concrete type definition that wraps an underlying type, such as 'type C<'a> = C of ...'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:764) + + + + + One tuple type is a struct tuple, the other is a reference tuple + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1334) + + + + + This method or property is not normally used from F# code, use an explicit tuple pattern for deconstruction instead. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1440) + + + + + 'try/with' expressions may not be used in queries + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1276) + + + + + 'try'/'with' cannot be used within sequence expressions + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:634) + + + + + Thread-static and context-static variables must be static and given the [<DefaultValue>] attribute to indicate that the value is initialized to the default value on each new thread + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:714) + + + + + This member, function or value declaration may not be declared 'inline' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1281) + + + + + This type definition may not have the 'CLIMutable' attribute. Only record types may have this attribute. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1263) + + + + + Invalid provided field. Provided fields of erased provided types must be literals. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1292) + + + + + The syntax 'expr.id' may only be used with record labels, properties and fields + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:649) + + + + + Syntax error - unexpected '?' symbol + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:570) + + + + + '%s' may only be used to construct object types + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:598) + + + + + The struct, record or union type '%s' has the 'StructuralEquality' attribute but the component type '%s' does not satisfy the 'equality' constraint + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1042) + + + + + The struct, record or union type '%s' has the 'StructuralEquality' attribute but the type parameter '%s' does not satisfy the 'equality' constraint. Consider adding the 'equality' constraint to the type parameter + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1041) + + + + + The struct, record or union type '%s' has the 'StructuralComparison' attribute but the component type '%s' does not satisfy the 'comparison' constraint + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1036) + + + + + The struct, record or union type '%s' has the 'StructuralComparison' attribute but the type parameter '%s' does not satisfy the 'comparison' constraint. Consider adding the 'comparison' constraint to the type parameter + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1035) + + + + + Each argument of the primary constructor for a struct must be given a type, for example 'type S(x1:int, x2: int) = ...'. These arguments determine the fields of the struct. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1043) + + + + + Structs cannot contain value definitions because the default constructor for structs will not execute these bindings. Consider adding additional arguments to the primary constructor for the type. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:735) + + + + + Structs cannot contain 'do' bindings because the default constructor for structs would not execute these bindings + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:734) + + + + + Structs, interfaces, enums and delegates cannot inherit from other types + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:765) + + + + + Structs cannot have an object constructor with no arguments. This is a restriction imposed on all CLI languages as structs automatically support a default constructor. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:706) + + + + + Structs may only bind a 'this' parameter at member declarations + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:496) + + + + + If a union type has more than one case and is a struct, then all fields within the union type must be given unique names. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1343) + + + + + Struct types cannot contain abstract members + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:785) + + + + + Static 'val' fields in types must be mutable, private and marked with the '[<DefaultValue>]' attribute. They are initialized to the 'null' or 'zero' value for their type. Consider also using a 'static let mutable' binding in a class type. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:717) + + + + + Static optimization conditionals are only for use within the F# library + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:655) + + + + + This static member should not have a 'this' parameter. Consider using the notation 'member Member(args) = ...'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:515) + + + + + Static value definitions may only be used in types with a primary constructor. Consider adding arguments to the type definition, e.g. 'type X(args) = ...'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:736) + + + + + Interfaces cannot contain definitions of static initializers + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:701) + + + + + A static initializer requires an argument + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:513) + + + + + A static field was used where an instance field is expected + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:464) + + + + + A simple method name is required here + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:608) + + + + + In sequence expressions, results are generated using 'yield' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:470) + + + + + Array method '%s' is supplied by the runtime and cannot be directly used in code. For operations with array elements consider using family of GetArray/SetArray functions from LanguagePrimitives.IntrinsicFunctions module. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1305) + + + + + Return values cannot have names + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:476) + + + + + Return types of union cases must be identical to the type being defined, up to abbreviations + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:721) + + + + + 'return' and 'return!' may not be used in queries + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1274) + + + + + The syntax 'type X with ...' is reserved for augmentations. Types whose representations are hidden but which have members are now declared in signatures using 'type X = ...'. You may also need to add the '[<Sealed>] attribute to the type definition in the signature + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:793) + + + + + This is not a variable, constant, active recognizer or literal + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:566) + + + + + This control construct may only be used if the computation expression builder defines a '%s' method + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:545) + + + + + Only active patterns returning exactly one result may accept arguments + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:558) + + + + + The representation of this type is hidden by the signature. It must be given an attribute such as [<Sealed>], [<Class>] or [<Interface>] to indicate the characteristics of the type. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:771) + + + + + Recursive bindings that include member specifications can only occur as a direct augmentation of a type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:708) + + + + + Records, union, abbreviations and struct types cannot have the 'AllowNullLiteral' attribute + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:767) + + + + + This record contains fields from inconsistent types + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:494) + + + + + The 'rec' on this module is implied by an outer 'rec' declaration and is being ignored + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1338) + + + + + A property cannot have explicit type parameters. Consider using a method instead. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:509) + + + + + This property or field was not found on this custom attribute type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:682) + + + + + Property '%s' is static + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:646) + + + + + Property '%s' is not static + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:643) + + + + + Property '%s' is not readable + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:644) + + + + + Property '%s' cannot be set + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:647) + + + + + This property cannot be set + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:681) + + + + + The types System.ValueType, System.Enum, System.Delegate, System.MulticastDelegate and System.Array cannot be used as super types in an object expression or class + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:609) + + + + + A parameter with attributes must also be given a name, e.g. '[<Attribute>] Name : Type' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:475) + + + + + The parameter '%s' was inferred to have byref type. Parameters of byref type must be given an explicit type annotation, e.g. 'x1: byref<int>'. When used, a byref parameter is implicitly dereferenced. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1060) + + + + + You must explicitly declare either all or no type parameters when overriding a generic abstract method + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:504) + + + + + Accessibility modifiers are not permitted on overrides or interface implementations + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:774) + + + + + This override takes a different number of arguments to the corresponding abstract member. The following abstract members were found:%s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:693) + + + + + One or more of the overloads of this method has curried arguments. Consider redesigning these members to take arguments in tupled form. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:653) + + + + + Optional arguments cannot be used in custom attributes + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:680) + + + + + Optional arguments are only permitted on type members + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:554) + + + + + Optional arguments must come at the end of the argument list, after any non-optional arguments + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1078) + + + + + '%s' must be followed by 'in'. Usage: %s. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1299) + + + + + Incorrect syntax for '%s'. Usage: %s. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1227) + + + + + The operator '%s' does not accept the use of 'into' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1261) + + + + + This declaration opens the namespace or module '%s' through a partially qualified path. Adjust this code to use the full path of the namespace. This change will make your code more robust as new constructs are added to the F# and CLI libraries. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:728) + + + + + In a recursive declaration group, 'open' declarations must come first in each module + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1339) + + + + + Only types representing units-of-measure may be given the 'Measure' attribute + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:773) + + + + + Only structs and classes without primary constructors may be given the 'StructLayout' attribute + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:770) + + + + + Only simple variable patterns can be bound in 'let rec' constructs + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:709) + + + + + Only simple bindings of the form 'id = expr' can be used in construction expressions + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:615) + + + + + Only record fields and simple, non-recursive 'let' bindings may be marked mutable + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:710) + + + + + Only functions may be marked 'inline' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:669) + + + + + Only classes may be given the 'AbstractClass' attribute + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:772) + + + + + Objects must be initialized by an object construction expression that calls an inherited object constructor and assigns a value to each field + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:616) + + + + + The operator 'expr.[idx]' has been used on an object of indeterminate type based on information prior to this program point. Consider adding further type constraints + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:589) + + + + + Only overrides of abstract and virtual members may be specified in object expressions + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:603) + + + + + This form of object expression is not used in F#. Use 'member this.MemberName ... = ...' to define member implementations in object expressions. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:519) + + + + + Calls to object constructors on type parameters cannot be given arguments + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:591) + + + + + Interfaces cannot contain definitions of object constructors + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:702) + + + + + An object constructor requires an argument + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:514) + + + + + Object construction expressions (i.e. record expressions with inheritance specifications) may only be used to implement constructors in object model types. Use 'new ObjectType(args)' to construct instances of object model types outside of constructors + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:626) + + + + + Object construction expressions may only be used to implement constructors in class types + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:614) + + + + + This numeric literal requires that a module '%s' defining functions FromZero, FromOne, FromInt32, FromInt64 and FromString be in scope + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:622) + + + + + This is not a valid name for an enumeration case + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:582) + + + + + This code is not sufficiently generic. The type variable %s could not be generalized because it would escape its scope. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:508) + + + + + Not an exception + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:756) + + + + + Non-zero constants cannot have generic units. For generic zero, write 0.0<_>. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:469) + + + + + The generic member '%s' has been used at a non-uniform instantiation prior to this program point. Consider reordering the members so this member occurs first. Alternatively, specify the full type of the member explicitly, including argument types, return type and any additional generic parameters and constraints. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1061) + + + + + This 'let' definition may not be used in a query. Only simple value definitions may be used in queries. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1277) + + + + + This value is not a literal and cannot be used in a pattern + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:527) + + + + + 'while' expressions may not be used in queries + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1270) + + + + + 'try/finally' expressions may not be used in queries + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1271) + + + + + No abstract property was found that corresponds to this override + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:696) + + + + + No abstract or interface member was found that corresponds to this override + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:692) + + + + + Interface implementations cannot be given on construction expressions + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:613) + + + + + In queries, use the form 'for x in n .. m do ...' for ranging over integers + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1269) + + + + + The struct, record or union type '%s' does not support structural equality because the type '%s' does not satisfy the 'equality' constraint. Consider adding the 'NoEquality' attribute to the type '%s' to clarify that the type does not support structural equality + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1040) + + + + + The struct, record or union type '%s' does not support structural equality because the type parameter %s does not satisfy the 'equality' constraint. Consider adding the 'NoEquality' attribute to the type '%s' to clarify that the type does not support structural equality + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1039) + + + + + The struct, record or union type '%s' is not structurally comparable because the type '%s' does not satisfy the 'comparison' constraint. Consider adding the 'NoComparison' attribute to the type '%s' to clarify that the type is not comparable + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1038) + + + + + The struct, record or union type '%s' is not structurally comparable because the type parameter %s does not satisfy the 'comparison' constraint. Consider adding the 'NoComparison' attribute to the type '%s' to clarify that the type is not comparable + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1037) + + + + + No arguments may be given when constructing a record value + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:612) + + + + + The member '%s' does not correspond to any abstract or virtual method available to override or implement. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:604) + + + + + 'new' may only be used with object constructors + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:620) + + + + + 'new' must be used with a named type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:610) + + + + + This new member hides the abstract member '%s' once tuples, functions, units of measure and/or provided types are erased. Rename the member or use 'override' instead. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:700) + + + + + This new member hides the abstract member '%s'. Rename the member or use 'override' instead. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:699) + + + + + 'new' cannot be used on interface types. Consider using an object expression '{ new ... with ... }' instead. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:595) + + + + + Namespaces cannot contain values. Consider using a module to hold your value declarations. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:478) + + + + + Namespaces cannot contain extension members except in the same file and namespace declaration group where the type is defined. Consider using a module to hold declarations of extension members. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:479) + + + + + '%s' may only be used with named types + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:593) + + + + + Named arguments cannot be given to member trait calls + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:581) + + + + + The named argument '%s' did not match any argument or mutable property + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:652) + + + + + %s is an active pattern and cannot be treated as a discriminated union case with named fields. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1348) + + + + + Name '%s' not bound in pattern context + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:555) + + + + + Named arguments must appear after all other arguments + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:529) + + + + + Mutable function values should be written 'let mutable f = (fun args -> ...)' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:668) + + + + + Mutable values cannot have generic parameters + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:667) + + + + + Mutable values cannot be marked 'inline' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:666) + + + + + Multiple visibility attributes have been specified for this identifier. 'let' bindings in classes are always private, as are any 'let' bindings inside expressions. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:481) + + + + + Multiple visibility attributes have been specified for this identifier + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:480) + + + + + This declaration opens the module '%s', which is marked as 'RequireQualifiedAccess'. Adjust your code to use qualified references to the elements of the module instead, e.g. 'List.map' instead of 'map'. This change will ensure that your code is robust as new constructs are added to libraries. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:727) + + + + + The path '%s' is a namespace. A module abbreviation may not abbreviate a namespace. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:802) + + + + + In a recursive declaration group, module abbreviations must come after all 'open' declarations and before other declarations + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1340) + + + + + A custom query operation for '%s' is required but not specified + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1208) + + + + + Method overrides and interface implementations are not permitted here + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:691) + + + + + Method '%s' is not accessible from this code location + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:465) + + + + + Members that extend interface, delegate or enum types must be placed in a module separate to the definition of the type. This module must either have the AutoOpen attribute or be opened explicitly by client code to bring the extension members into scope. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:794) + + + + + The member '%s' is used in an invalid way. A use of '%s' has been inferred prior to the definition of '%s', which is an invalid forward reference. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:804) + + + + + Interfaces cannot contain definitions of member overrides + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:703) + + + + + Extension members cannot provide operator overloads. Consider defining the operator as part of the type definition instead. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1081) + + + + + This member is not permitted in an interface implementation + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:744) + + + + + MemberKind.PropertyGetSet only expected in parse trees + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:477) + + + + + This member is not sufficiently generic + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:711) + + + + + The type %s contains the member '%s' but it is not a virtual or abstract method that is available to override or implement. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:605) + + + + + A member and a local class binding both have the name '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:738) + + + + + Measure definitions cannot have type parameters + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:762) + + + + + Measure declarations may have only static members: constructors are not available + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:737) + + + + + Measure declarations may have only static members + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:733) + + + + + 'match' expressions may not be used in queries + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1296) + + + + + This lookup cannot be used here + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:645) + + + + + Local class bindings cannot be marked inline. Consider lifting the definition out of the class or else do not mark it as inline. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:729) + + + + + This literal pattern does not take arguments + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1328) + + + + + Literal values cannot have generic parameters + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:673) + + + + + A literal value cannot be marked 'mutable' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:671) + + + + + A literal value cannot be marked 'inline' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:672) + + + + + A declaration may only be the [<Literal>] attribute if a constant value is also given, e.g. 'val x : int = 1' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:712) + + + + + This list expression exceeds the maximum size for list literals. Use an array for larger literals and call Array.ToList. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:579) + + + + + This definition may only be used in a type with a primary constructor. Consider adding arguments to your type definition, e.g. 'type X(args) = ...'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:800) + + + + + This code is less generic than required by its annotations because the explicit type variable '%s' could not be generalized. It was constrained to be '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:498) + + + + + The kind of the type specified by its attributes does not match the kind implied by its definition + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:761) + + + + + In queries, '%s' must use a simple pattern + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1207) + + + + + A type annotated with IsReadOnly must also be a struct. Consider adding the [<Struct>] attribute to the type. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1451) + + + + + Invalid use of a type name + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:637) + + + + + Invalid use of an interface type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:641) + + + + + Invalid use of a delegate constructor. Use the syntax 'new Type(args)' or just 'Type(args)'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:642) + + + + + The 'UseNullAsTrueValue' attribute flag may only be used with union types that have one nullary case and at least one non-nullary case + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1059) + + + + + 'use' bindings must be of the form 'use <var> = <expr>' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:689) + + + + + 'use!' bindings must be of the form 'use! <var> = <expr>' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1092) + + + + + Units-of-measure cannot be used as prefix arguments to a type. Rewrite as postfix arguments in angle brackets. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:543) + + + + + Units-of-measure supported only on float, float32, decimal and signed integer types + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:472) + + + + + Literal enumerations must have type int, uint, int16, uint16, int64, uint64, byte, sbyte or char + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:789) + + + + + Invalid type extension + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:759) + + + + + Type arguments cannot be specified here + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:557) + + + + + The number of type arguments did not match: '%d' given, '%d' expected. This may be related to a previously reported error. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1201) + + + + + Invalid signature for set member + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:698) + + + + + Invalid record, sequence or computation expression. Sequence expressions should be of the form 'seq { ... }' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:576) + + + + + Invalid join relation in '%s'. Expected 'expr <op> expr', where <op> is =, =?, ?= or ?=?. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1254) + + + + + Invalid record construction + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:623) + + + + + This property has an invalid type. Properties taking multiple indexer arguments should have types of the form 'ty1 * ty2 -> ty3'. Properties returning functions should have types of the form '(ty1 -> ty2)'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:538) + + + + + This is not a valid pattern + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:567) + + + + + Invalid optional assignment to a property or field + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:657) + + + + + The '%s' operator should not normally be redefined. To define overloaded comparison semantics for a particular type, implement the 'System.IComparable' interface in the definition of that type. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:486) + + + + + The '%s' operator should not normally be redefined. To define equality semantics for a type, override the 'Object.Equals' member in the definition of that type. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:487) + + + + + The '%s' operator should not normally be redefined. Consider using a different operator name + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:488) + + + + + Invalid object, sequence or record expression + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:575) + + + + + Invalid object expression. Objects without overrides or interfaces should use the expression form 'new Type(args)' without braces. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:574) + + + + + This is not a valid object construction expression. Explicit object constructors must either call an alternate constructor or initialize all fields of the object and specify a call to a super class constructor. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:533) + + + + + Non-primitive numeric literal constants cannot be used in pattern matches because they can be mapped to multiple different types through the use of a NumericLiteral module. Consider using replacing with a variable, and use 'when <variable> = <constant>' at the end of the match clause. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:556) + + + + + 'new' constraints must take one argument of type 'unit' and return the constructed type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:537) + + + + + Invalid namespace, module, type or union case name + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:719) + + + + + Invalid module name + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:758) + + + + + This recursive binding uses an invalid mixture of recursive forms + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:532) + + + + + The name '(%s)' should not be used as a member name. To define comparison semantics for a type, implement the 'System.IComparable' interface. If defining a static member for use from other CLI languages then use the name '%s' instead. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:482) + + + + + The name '(%s)' should not be used as a member name. To define equality semantics for a type, override the 'Object.Equals' member. If defining a static member for use from other CLI languages then use the name '%s' instead. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:483) + + + + + The name '(%s)' should not be used as a member name because it is given a standard definition in the F# library over fixed types + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:485) + + + + + Invalid member name. Members may not have name '.ctor' or '.cctor' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1199) + + + + + The name '(%s)' should not be used as a member name. If defining a static member for use from other CLI languages then use the name '%s' instead. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:484) + + + + + Invalid inline specification + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:688) + + + + + Invalid indexer expression + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:588) + + + + + The '%s' operator cannot be redefined. Consider using a different operator name + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:489) + + + + + Internal error. Invalid index into active pattern array + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:560) + + + + + This is not a valid value for an enumeration literal + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:722) + + + + + An 'enum' constraint must be of the form 'enum<type>' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:536) + + + + + Delegate specifications must be of the form 'typ -> typ' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:787) + + + + + Invalid declaration + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:520) + + + + + Invalid constraint: the type used for the constraint is sealed, which means the constraint could only be satisfied by at most one solution + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:535) + + + + + Invalid constraint + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:534) + + + + + This is not a valid constant expression + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:674) + + + + + Invalid assignment + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:636) + + + + + Invalid argument to parameterized pattern label + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:559) + + + + + This is not a valid name for an active pattern + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:664) + + + + + A use of 'into' must be followed by the remainder of the computation + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1260) + + + + + Interfaces inherited by other interfaces should be declared using 'inherit ...' instead of 'interface ...' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1070) + + + + + Interface types cannot be sealed + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:786) + + + + + Interface types and delegate types cannot contain fields + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:781) + + + + + This instance member needs a parameter to represent the object being invoked. Make the member static or use the notation 'member x.Member(args) = ...'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:511) + + + + + The inherited type is not an object model type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:625) + + + + + A inheritance declaration is not permitted here + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:726) + + + + + This 'inherit' declaration specifies the inherited type but no arguments. Consider supplying arguments, e.g. 'inherit BaseType(args)'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:798) + + + + + This 'inherit' declaration has arguments, but is not in a type with a primary constructor. Consider adding arguments to your type definition, e.g. 'type X(args) = ...'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:799) + + + + + 'inherit' cannot be used on interface types. Consider implementing the interface by using 'interface ... with ... end' instead. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:594) + + + + + The function or member '%s' is used in a way that requires further type annotations at its definition to ensure consistency of inferred types. The inferred signature is '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1200) + + + + + Implicit product of measures following / + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:467) + + + + + The struct, record or union type '%s' implements the interface 'System.IStructuralEquatable' explicitly. Apply the 'CustomEquality' attribute to the type. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:749) + + + + + The struct, record or union type '%s' implements the interface 'System.IStructuralComparable' explicitly. Apply the 'CustomComparison' attribute to the type. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:493) + + + + + The struct, record or union type '%s' implements the interface 'System.IEquatable<_>' explicitly. Apply the 'CustomEquality' attribute to the type and provide a consistent implementation of the non-generic override 'System.Object.Equals(obj)'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:750) + + + + + The struct, record or union type '%s' implements the interface 'System.IComparable' explicitly. You must apply the 'CustomComparison' attribute to the type. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:491) + + + + + The struct, record or union type '%s' implements the interface 'System.IComparable<_>' explicitly. You must apply the 'CustomComparison' attribute to the type, and should also provide a consistent implementation of the non-generic interface System.IComparable. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:492) + + + + + Illegal syntax in type expression + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:549) + + + + + This is not valid literal expression. The [<Literal>] attribute will be ignored. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1314) + + + + + Illegal pattern + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:569) + + + + + Explicit type declarations for constructors must be of the form 'ty1 * ... * tyN -> resTy'. Parentheses may be required around 'resTy' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:720) + + + + + A literal value cannot be given the [<ThreadStatic>] or [<ContextStatic>] attributes + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:670) + + + + + An if/then/else expression may not be used within queries. Consider using either an if/then expression, or use a sequence expression instead. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1217) + + + + + It is recommended that objects supporting the IDisposable interface are created using the syntax 'new Type(args)', rather than 'Type(args)' or 'Type' as a function value representing the constructor, to indicate that resources may be owned by the generated value + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:597) + + + + + The system type '%s' was required but no referenced system DLL contained this type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1350) + + + + + Generic types cannot be given the 'StructLayout' attribute + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:769) + + + + + A generic type parameter has been used in a way that constrains it to always be '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:500) + + + + + The provided types generated by this use of a type provider may not be used from other F# assemblies and should be marked internal or private. Consider using 'type internal TypeName = ...' or 'type private TypeName = ...'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1303) + + + + + The generic function '%s' must be given explicit type argument(s) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:522) + + + + + This function value is being used to construct a delegate type whose signature includes a byref argument. You must use an explicit lambda expression taking %d arguments. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:530) + + + + + The corresponding formal argument is not optional + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:656) + + + + + Invalid use of 'fixed'. 'fixed' may only be used in a declaration of the form 'use x = fixed expr' where the expression is an array, the address of a field, the address of an array element or a string' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1345) + + + + + The field labels and expected type of this record expression or pattern do not uniquely determine a corresponding record type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:505) + + + + + A field/val declaration is not permitted here + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:725) + + + + + This field requires a name + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:718) + + + + + No assignment given for field '%s' of type '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:601) + + + + + This field is not a literal and cannot be used in a pattern + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:565) + + + + + Named field '%s' is used more than once. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1311) + + + + + Named field '%s' conflicts with autogenerated name for anonymous field. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1312) + + + + + This field is readonly + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:528) + + + + + Field '%s' is not static + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:564) + + + + + This field is not mutable + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:583) + + + + + The field '%s' appears twice in this record expression or pattern + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:506) + + + + + All record, union and struct types in FSharp.Core.dll must be explicitly labelled with 'StructuralComparison' or 'NoComparison' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1034) + + + + + Extraneous fields have been given values + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:602) + + + + + This list or array expression includes an element of the form 'if ... then ... else'. Parenthesize this expression to indicate it is an individual element of the list or array, to disambiguate this from a list generated using a sequence expression + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:577) + + + + + This expression form may only be used in sequence and computation expressions + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:573) + + + + + The expression form { expr with ... } may only be used with record types. To build object types use { new Type(...) with ... } + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:624) + + + + + The expression form 'expr then expr' may only be used as part of an explicit object constructor + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:580) + + + + + Expected %d expressions, got %d + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:571) + + + + + TcExprUndelayed: delayed + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:572) + + + + + Explicit type specifications cannot be used for exception constructors + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:751) + + + + + Explicit type parameters may only be used on module or member bindings + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:503) + + + + + An explicit static initializer should use the syntax 'static new(args) = expr' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:516) + + + + + An explicit object constructor should use the syntax 'new(args) = expr' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:517) + + + + + Expected unit-of-measure, not type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:542) + + + + + Expected unit-of-measure parameter, not type parameter. Explicit unit-of-measure parameters must be marked with the [<Measure>] attribute. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:539) + + + + + Expected type parameter, not unit-of-measure parameter + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:540) + + + + + Expected type, not unit-of-measure + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:541) + + + + + Expected an interface type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:617) + + + + + Expected module or namespace parent %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:490) + + + + + The exception '%s' does not have a field named '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1307) + + + + + Exception abbreviations should not have argument lists + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:752) + + + + + Exception abbreviations must refer to existing exceptions or F# types deriving from System.Exception + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:754) + + + + + Event '%s' is static + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:650) + + + + + Event '%s' is not static + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:651) + + + + + Enumerations cannot have members + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:732) + + + + + Enumerations cannot have interface declarations + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:740) + + + + + The type '%s' is not a valid enumerator type , i.e. does not have a 'MoveNext()' method returning a bool, and a 'Current' property + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1094) + + + + + The 'EntryPointAttribute' attribute may only be used on function definitions in modules + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:665) + + + + + '{ }' is not a valid expression. Records must include at least one field. Empty sequences are specified by using Seq.empty or an empty list '[]'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:627) + + + + + Copy-and-update record expressions must include at least one field. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1301) + + + + + Duplicate specification of an interface + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:724) + + + + + The method or function '%s' should not be given explicit type argument(s) because it does not declare its type parameters explicitly + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:523) + + + + + 'do!' cannot be used within sequence expressions + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:632) + + + + + DLLImport stubs cannot be inlined + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:495) + + + + + DLLImport bindings must be static members in a class or function definitions in a module + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1087) + + + + + Delegate specifications must not be curried types. Use 'typ * ... * typ -> typ' for multi-argument delegates, and 'typ -> (typ -> typ)' for delegates returning function values. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:788) + + + + + A delegate constructor must be passed a single function value + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:658) + + + + + The 'DefaultValue' attribute may only be used on 'val' declarations + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:662) + + + + + The default, zero-initializing constructor of a struct type may only be used if all the fields of the struct type admit default initialization + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:525) + + + + + A default implementation of this interface has already been added because the explicit implementation of the interface was not specified at the definition of the type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:743) + + + + + This method already has a default implementation + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:694) + + + + + The method implemented by this default is ambiguous + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:695) + + + + + One or more of the declared type parameters for this type extension have a missing or wrong type constraint not matching the original type constraints on '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:795) + + + + + This declaration element is not permitted in an augmentation + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:745) + + + + + '%s' is not used correctly. Usage: %s. This is a custom operation in this query or computation expression. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1222) + + + + + '%s' is not used correctly. This is a custom operation in this query or computation expression. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1221) + + + + + A custom operation may not be used in conjunction with a non-value or recursive 'let' binding in another part of this computation expression + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1214) + + + + + A custom operation may not be used in conjunction with 'use', 'try/with', 'try/finally', 'if/then/else' or 'match' operators within this computation expression + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1215) + + + + + The custom operation '%s' refers to a method which is overloaded. The implementations of custom operations may not be overloaded. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1216) + + + + + The definition of the custom operator '%s' does not use a valid combination of attribute flags + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1262) + + + + + '%s' is used with an incorrect number of arguments. This is a custom operation in this query or computation expression. Expected %d argument(s), but given %d. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1229) + + + + + A custom attribute must invoke an object constructor + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:685) + + + + + A custom attribute must be a reference type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:683) + + + + + The number of args for a custom attribute does not match the expected number of args for the attribute constructor + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:684) + + + + + Could not find method System.Runtime.CompilerServices.OffsetToStringData in references when building 'fixed' expression. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1346) + + + + + Couldn't find Dispose on IDisposable, or it was overloaded + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:526) + + + + + The input to a copy-and-update expression that creates an anonymous record must be either an anonymous record or a record + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1463) + + + + + Constructors are not permitted as extension members - they must be defined as part of the original definition of the type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1329) + + + + + Constructors cannot be defined for this type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:707) + + + + + Constructors cannot be specified in exception augmentations + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:705) + + + + + Constructors must be applied to arguments and cannot be used as first-class values. If necessary use an anonymous function '(fun arg1 ... argN -> new Type(arg1,...,argN))'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:648) + + + + + Constructors for the type '%s' must directly or indirectly call its implicit object constructor. Use a call to the implicit object constructor instead of a record expression. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:599) + + + + + This object constructor requires arguments + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:619) + + + + + Constructor expressions for interfaces do not take arguments + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:618) + + + + + The constructor does not have a field named '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1309) + + + + + A constructor cannot have explicit type parameters. Consider using a static construction method instead. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:510) + + + + + This construct may only be used within sequence or computation expressions + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:586) + + + + + This construct may only be used within list, array and sequence expressions, e.g. expressions of the form 'seq { ... }', '[ ... ]' or '[| ... |]'. These use the syntax 'for ... in ... do ... yield...' to generate elements + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:584) + + + + + This construct may only be used within computation expressions. To return a value from an ordinary function simply write the expression without 'return'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:585) + + + + + This construct may only be used within computation expressions + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:587) + + + + + This construct is ambiguous as part of a sequence expression. Nested expressions may be written using 'let _ = (...)' and nested sequences using 'yield! seq {... }'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:631) + + + + + This construct is ambiguous as part of a computation expression. Nested expressions may be written using 'let _ = (...)' and nested computations using 'let! res = builder { ... }'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:630) + + + + + One or more of the explicit class or function type variables for this binding could not be generalized, because they were constrained to other types + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:499) + + + + + Attribute 'System.Diagnostics.ConditionalAttribute' is only valid on methods or attribute classes + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1079) + + + + + The 'ConditionalAttribute' attribute may only be used on members + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:663) + + + + + Interfaces cannot contain definitions of concrete members. You may need to define a constructor on your type to indicate that the type is a class. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:704) + + + + + The 'CompiledName' attribute cannot be used with this language element + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:592) + + + + + Cannot partially apply the extension method '%s' because the first parameter is a byref type. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1459) + + + + + Cannot override inherited member '%s' because it is sealed + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1202) + + + + + Cannot inherit from a variable type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:590) + + + + + Cannot inherit a sealed type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:783) + + + + + Cannot inherit from interface type. Use interface ... with instead. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:784) + + + + + Cannot inherit from erased provided type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1197) + + + + + Cannot create an extension of a sealed type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:611) + + + + + Cannot call the byref extension method '%s. The first parameter requires the value to be mutable or a non-readonly byref type. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1457) + + + + + Cannot call an abstract base member: '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1063) + + + + + '%s' must be applied to an argument of type '%s', but has been applied to an argument of type '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1103) + + + + + '%s' can only be applied to optional arguments + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1104) + + + + + Byref types are not allowed to have optional type extensions. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1458) + + + + + A byref pointer returned by a function or method is implicitly dereferenced as of F# 4.5. To acquire the return value as a pointer, use the address-of operator, e.g. '&f(x)' or '&obj.Method(arg1, arg2)'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1446) + + + + + A type annotated with IsByRefLike must also be a struct. Consider adding the [<Struct>] attribute to the type. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1447) + + + + + A binding cannot be marked both 'use' and 'rec' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:659) + + + + + 'let!', 'use!' and 'do!' expressions may not be used in queries + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1273) + + + + + '%s' must be followed by a variable name. Usage: %s. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1226) + + + + + '%s' must come after a 'for' selection clause and be followed by the rest of the query. Syntax: ... %s ... + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1228) + + + + + 'member val' definitions are only permitted in types with a primary constructor. Consider adding arguments to your type definition, e.g. 'type X(args) = ...'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1264) + + + + + The attributes of this type specify multiple kinds for the type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:760) + + + + + Attributes are not allowed within patterns + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:521) + + + + + Attributes are not permitted on 'let' bindings in expressions + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:661) + + + + + This attribute is not valid for use on this language element. Assembly attributes should be attached to a 'do ()' declaration, if necessary within an F# module. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:678) + + + + + This attribute is not valid for use on this language element + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:679) + + + + + Attribute expressions must be calls to object constructors + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:686) + + + + + The attribute 'AutoOpen(\"%s\")' in the assembly '%s' did not refer to a valid module or namespace in that assembly and has been ignored + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:807) + + + + + The attribute '%s' appears in both the implementation and the signature, but the attribute arguments differ. Only the attribute from the signature will be included in the compiled code. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1062) + + + + + At least one override did not correctly implement its corresponding abstract member + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:621) + + + + + The member '%s' does not accept the correct number of arguments. One overload accepts %d arguments, but %d were given. The required signature is '%s'.%s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:607) + + + + + The member '%s' does not accept the correct number of arguments. %d argument(s) are expected, but %d were given. The required signature is '%s'.%s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:606) + + + + + Anonymous unit-of-measure cannot be nested inside another unit-of-measure expression + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:550) + + + + + Anonymous type variables are not permitted in this declaration + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:551) + + + + + Two anonymous record types have mismatched sets of field names '%s' and '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1355) + + + + + Two anonymous record types are from different assemblies '%s' and '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1354) + + + + + Types with the 'AllowNullLiteral' attribute may only inherit from or implement types which also allow the use of the null literal + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:768) + + + + + All implemented interfaces should be declared on the initial declaration of the type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:742) + + + + + Active patterns do not have fields. This syntax is invalid. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1308) + + + + + Instances of this type cannot be created since it has been marked abstract or not all methods have been given implementations. Consider using an object expression '{ new ... with ... }' instead. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:596) + + + + + This property overrides or implements an abstract property but the abstract property doesn't have a corresponding %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:697) + + + + + Abstract members are not permitted in an augmentation - they must be defined as part of the type itself + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:690) + + + + + Abbreviations for Common IL exception types must have a matching object constructor + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:755) + + + + + Abbreviations for Common IL exceptions cannot take arguments + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:753) + + + + + Abbreviated types cannot be given the 'Sealed' attribute + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:782) + + + + + F# supports array ranks between 1 and 32. The value %d is not allowed. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1268) + + + + + A value must be mutable in order to mutate the contents or take the address of a value type, e.g. 'let mutable x = ...' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:85) + + + + + A value defined in a module must be mutable in order to take its address, e.g. 'let mutable x = ...' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1450) + + + + + The value has been copied to ensure the original is not mutated by this operation or because the copy is implicit when returning a struct from a member and another member is then accessed + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:87) + + + + + This value does not have a valid property setter type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:81) + + + + + Unexpected decode of InternalsVisibleToAttribute + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:92) + + + + + Unexpected decode of InterfaceDataVersionAttribute + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:93) + + + + + Unexpected decode of AutoOpenAttribute + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:91) + + + + + Unexpected use of a byref-typed variable + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:84) + + + + + The module/namespace '%s' from compilation unit '%s' did not contain the val '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1057) + + + + + The module/namespace '%s' from compilation unit '%s' did not contain the namespace, module or type '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1058) + + + + + The module/namespace '%s' from compilation unit '%s' did not contain the module/namespace '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1056) + + + + + The type/module '%s' is not a concrete module or type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:74) + + + + + The type '%s' has an inline assembly code representation + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:75) + + + + + Two modules named '%s' occur in two parts of this assembly + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:77) + + + + + Recursively defined values cannot appear directly as part of the construction of a tuple value within a recursive binding + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:88) + + + + + Recursive values cannot be directly assigned to the non-mutable field '%s' of the type '%s' within a recursive binding. Consider using a mutable field instead. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:90) + + + + + Recursive values cannot appear directly as a construction of the type '%s' within a recursive binding. This feature has been removed from the F# language. Consider using a record instead. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:89) + + + + + This is not a valid constant expression or custom attribute value + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:95) + + + + + A namespace and a module named '%s' both occur in two parts of this assembly + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:76) + + + + + Invalid mutation of a constant expression. Consider copying the expression to a mutable local, e.g. 'let mutable x = ...'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:86) + + + + + Invalid member signature encountered because of an earlier error + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:80) + + + + + Invalid form for a property setter. At least one argument is required. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:83) + + + + + Invalid form for a property getter. At least one '()' argument is required when using the explicit syntax. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:82) + + + + + This operation accesses a mutable top-level value defined in another assembly in an unsupported way. The value cannot be accessed through its address. Consider copying the expression to a mutable local, e.g. 'let mutable x = ...', and if necessary assigning the value back after the completion of the operation + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1050) + + + + + Two type definitions named '%s' occur in namespace '%s' in two parts of this assembly + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:78) + + + + + This literal expression or attribute argument results in an arithmetic overflow. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1313) + + + + + A module and a type definition named '%s' occur in namespace '%s' in two parts of this assembly + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:79) + + + + + Cannot take the address of the value returned from the expression. Assign the returned value to a let-bound value before taking the address. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1456) + + + + + Active patterns cannot return more than 7 possibilities + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:94) + + + + + The struct or class field '%s' is not accessible from this code location + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:953) + + + + + Source file is too large to embed in a portable PDB + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:855) + + + + + If set to true, then all error messages will just return the filled 'holes' delimited by ',,,'s - this is for language-neutral testing (e.g. localization-invariant baselines). + + + + + Consider using 'return!' instead of 'return'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:30) + + + + + Replace with '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:18) + + + + + Recursive class hierarchy in type '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:945) + + + + + A ReadOnly attribute has been applied to a struct type with a mutable field. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1445) + + + + + Unexpected token '%s' in preprocessor expression + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1320) + + + + + Missing token '%s' in preprocessor expression + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1322) + + + + + Incomplete preprocessor expression + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1321) + + + + + Unexpected character '%s' in preprocessor expression + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1319) + + + + + Expected single line comment or end of line + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1030) + + + + + An error occurred while reading the F# metadata of assembly '%s'. A reserved construct was utilized. You may need to upgrade your F# compiler or use an earlier version of the assembly that doesn't make use of a specific construct. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1439) + + + + + An error occurred while reading the F# metadata node at position %d in table '%s' of assembly '%s'. The node had no matching declaration. Please report this warning. You may need to recompile the F# assembly you are using. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1323) + + + + + Error reading/writing metadata for the F# compiled DLL '%s'. Was the DLL compiled with an earlier version of the F# compiler? (error: '%s'). + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:73) + + + + + A pattern match guard must be of type 'bool', but this 'when' expression is of type '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:26) + + + + + Problem with filename '%s': Illegal characters in path. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1142) + + + + + Partial active patterns may only generate one result + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:963) + + + + + Missing variable '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:962) + + + + + Missing 'do' in 'while' expression. Expected 'while <expr> do <expr>'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1252) + + + + + Accessibility modifiers are not permitted on an 'inherits' declaration + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:415) + + + + + Accessibility modifiers should come immediately prior to the identifier naming a construct + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:386) + + + + + 'use' bindings are not permitted in modules and are treated as 'let' bindings + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:379) + + + + + 'use' bindings are not permitted in primary constructors + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:378) + + + + + Unmatched 'with' or badly formatted 'with' block + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:402) + + + + + Incomplete value definition. If this is in an expression, the body of the expression must be indented to the same column as the 'use!' keyword. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1250) + + + + + Incomplete value definition. If this is in an expression, the body of the expression must be indented to the same column as the 'use' keyword. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1251) + + + + + Unmatched '(' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:428) + + + + + Incomplete value definition. If this is in an expression, the body of the expression must be indented to the same column as the 'let!' keyword. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1249) + + + + + Incomplete value or function definition. If this is in an expression, the body of the expression must be indented to the same column as the 'let' keyword. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1248) + + + + + Unmatched '[<'. Expected closing '>]' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1232) + + + + + Unmatched 'class', 'interface' or 'struct' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:400) + + + + + Unmatched '[|' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:444) + + + + + Unmatched '[' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:439) + + + + + Unmatched '{|' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:446) + + + + + Unmatched '{' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:445) + + + + + Unmatched 'begin' or 'struct' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:393) + + + + + Unmatched 'begin' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:405) + + + + + Unmatched '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:443) + + + + + Accessibility modifiers are not permitted on union cases. Use 'type U = internal ...' or 'type U = private ...' to give an accessibility to the whole representation. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:423) + + + + + Unexpected token '%s' or incomplete expression + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1288) + + + + + Accessibility modifiers are not permitted here, but '%s' was given. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:384) + + + + + Syntax error: unexpected type parameter specification + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:456) + + + + + Unexpected symbol '=' in expression. Did you intend to use 'for x in y .. z do' instead? + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1353) + + + + + A semicolon is not expected at this point + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:382) + + + + + Unexpected quotation operator '<@' in type definition. If you intend to pass a verbatim string as a static argument to a type provider, put a space between the '<' and '@' characters. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1100) + + + + + Unexpected infix operator in unit-of-measure expression. Legal operators are '*', '/' and '^'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:454) + + + + + Unexpected integer literal in unit-of-measure expression + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:455) + + + + + Unexpected infix operator in type expression + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:451) + + + + + Unexpected identifier: '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:422) + + + + + Unexpected end of input in 'match' or 'try' expression + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1237) + + + + + Unexpected end of input in 'while' expression. Expected 'while <expr> do <expr>'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1235) + + + + + Unexpected end of input in type signature + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1242) + + + + + Unexpected end of input in type definition + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1243) + + + + + Unexpected end of input in type arguments + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1241) + + + + + Unexpected end of input in 'try' expression. Expected 'try <expr> with <rules>' or 'try <expr> finally <expr>'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1234) + + + + + Unexpected end of input in 'then' branch of conditional expression. Expected 'if <expr> then <expr>' or 'if <expr> then <expr> else <expr>'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1238) + + + + + Unexpected end of input in object members + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1244) + + + + + Unexpected end of input in 'match' expression. Expected 'match <expr> with | <pat> -> <expr> | <pat> -> <expr> ...'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1233) + + + + + Unexpected end of input in body of lambda expression. Expected 'fun <pat> ... <pat> -> <expr>'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1240) + + + + + Unexpected end of input in 'for' expression. Expected 'for <pat> in <expr> do <expr>'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1236) + + + + + Unexpected end of input in expression + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1246) + + + + + Unexpected end of input in 'else' branch of conditional expression. Expected 'if <expr> then <expr>' or 'if <expr> then <expr> else <expr>'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1239) + + + + + Unexpected end of input in value, function or member definition + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1245) + + + + + Unexpected end of input + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:383) + + + + + Unexpected empty type moduleDefn list + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:395) + + + + + '_' cannot be used as field name + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1302) + + + + + Unclosed block + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:392) + + + + + Type name cannot be empty. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1290) + + + + + Type annotations on property getters and setters must be given after the 'get()' or 'set(v)', e.g. 'with get() : string = ...' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:408) + + + + + Accessibility modifiers are not permitted in this position for type abbreviations + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:418) + + + + + The syntax 'module ... = struct .. end' is not used in F# code. Consider using 'module ... = begin .. end' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:462) + + + + + The syntax 'module ... : sig .. end' is not used in F# code. Consider using 'module ... = begin .. end' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:463) + + + + + Syntax error in labelled type argument + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:450) + + + + + Syntax error + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:398) + + + + + Successive patterns should be separated by spaces or tupled + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:429) + + + + + Successive arguments should be separated by spaces or tupled, and arguments involving function or method applications should be parenthesized + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:438) + + + + + A setter property may have at most two argument groups + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1047) + + + + + Property setters must be defined using 'set value = ', 'set idx value = ' or 'set (idx1,...,idxN) value = ... ' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:411) + + + + + Accessibility modifiers are not permitted on record fields. Use 'type R = internal ...' or 'type R = private ...' to give an accessibility to the whole representation. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:426) + + + + + In F# code you may use 'expr.[expr]'. A type annotation may be required to indicate the first expression is an array + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:441) + + + + + At most one 'with' augmentation is permitted + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:381) + + + + + Only '#' compiler directives may occur prior to the first 'namespace' declaration + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:385) + + + + + Only class types may take value arguments + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:404) + + + + + The use of the type syntax 'int C' and 'C <int>' is not permitted here. Consider adjusting this type to be written in the form 'C<int>' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1053) + + + + + Remove spaces between the type name and type parameter, e.g. \"type C<'T>\", not type \"C <'T>\". Type parameters must be placed directly adjacent to the type name. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1051) + + + + + Remove spaces between the type name and type parameter, e.g. \"C<'T>\", not \"C <'T>\". Type parameters must be placed directly adjacent to the type name. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1052) + + + + + No matching 'in' found for this 'let' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:430) + + + + + No #endif found for #if or #else + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:376) + + + + + No '=' symbol should follow a 'namespace' declaration + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:461) + + + + + Files should begin with either a namespace or module declaration, e.g. 'namespace SomeNamespace.SubNamespace' or 'module SomeNamespace.SomeModule', but not both. To define a module within a namespace use 'module SomeModule = ...' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:387) + + + + + To indicate that this property can be set, use 'member val PropertyName = expr with get,set'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1266) + + + + + Property definitions may not be declared mutable. To indicate that this property can be set, use 'member val PropertyName = expr with get,set'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1265) + + + + + Multiple accessibilities given for property getter or setter + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:410) + + + + + The syntax '(typ,...,typ) ident' is not used in F# code. Consider using 'ident<typ,...,typ>' instead + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:452) + + + + + A module name must be a simple name, not a path + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:394) + + + + + A module abbreviation must be a simple name, not a path + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:388) + + + + + Expected type argument or static argument + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1098) + + + + + Missing qualification after '.' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:440) + + + + + Unmatched '<'. Expected closing '>' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1099) + + + + + Missing function body + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:449) + + + + + Mismatched quotation, beginning with '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:442) + + + + + Mismatched quotation operator name, beginning with '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:457) + + + + + This member is not permitted in an object implementation + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:448) + + + + + The declaration form 'let ... and ...' for non-recursive bindings is not used in F# code. Consider using a sequence of 'let' bindings + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:427) + + + + + Invalid use of 'rec' keyword + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1342) + + + + + Invalid property getter or setter + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1048) + + + + + Invalid operator definition. Prefix operator definitions must use a valid prefix operator name. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1072) + + + + + Invalid prefix operator + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1071) + + + + + Invalid literal in type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:453) + + + + + Invalid declaration syntax + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:406) + + + + + Invalid anonymous record type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1462) + + + + + Invalid anonymous record expression + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1461) + + + + + Interfaces always have the same visibility as the enclosing type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:412) + + + + + An integer for loop must use a simple identifier + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:380) + + + + + Accessibility modifiers are not permitted on inline assembly code types + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:421) + + + + + 'inherit' declarations cannot have 'as' bindings. To access members of the base class when overriding a method, the syntax 'base.SomeMember' may be used; 'base' is a keyword. Remove this 'as' binding. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:416) + + + + + An indexer property must be given at least one argument + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1049) + + + + + Incomplete conditional. Expected 'if <expr> then <expr>' or 'if <expr> then <expr> else <expr>'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:433) + + + + + 'in' or '=' expected + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:436) + + + + + Neither 'member val' nor 'override val' definitions are permitted in object expressions. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1300) + + + + + Denominator must not be 0 in unit-of-measure exponent + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:460) + + + + + The '%s' visibility attribute is not allowed on module abbreviation. Module abbreviations are always private. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:391) + + + + + The '%s' accessibility attribute is not allowed on module abbreviation. Module abbreviations are always private. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:390) + + + + + Ignoring attributes on module abbreviation + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:389) + + + + + Identifier expected + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:435) + + + + + A getter property is expected to be a function, e.g. 'get() = ...' or 'get(index) = ...' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:409) + + + + + A getter property may have at most one argument group + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1046) + + + + + 'get', 'set' or 'get,set' required + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:403) + + + + + 'get' and/or 'set' required + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:407) + + + + + Missing 'do' in 'for' expression. Expected 'for <pat> in <expr> do <expr>'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1253) + + + + + Field bindings must have the form 'id = expr;' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:447) + + + + + Expected a type after this point + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1231) + + + + + Unexpected end of type. Expected a name after this point. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1247) + + + + + Expected an expression after this point + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1230) + + + + + The block following this '%s' is unfinished. Every code block is an expression and must have a result. '%s' cannot be the final code element in a block. Consider giving this block an explicit result. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:432) + + + + + Attempted to parse this as an operator name, but failed + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1101) + + + + + Error in the return expression for this 'let'. Possible incorrect indentation. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:431) + + + + + End of file in verbatim string embedded in comment begun at or before here + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:373) + + + + + End of file in verbatim string begun at or before here + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:370) + + + + + End of file in triple-quote string embedded in comment begun at or before here + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1096) + + + + + End of file in triple-quote string begun at or before here + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1095) + + + + + End of file in string embedded in comment begun at or before here + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:372) + + + + + End of file in string begun at or before here + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:369) + + + + + End of file in IF-OCAML section begun at or before here + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:374) + + + + + End of file in #if section begun at or after here + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:368) + + + + + End of file in directive begun at or before here + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:375) + + + + + End of file in comment begun at or before here + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:371) + + + + + Accessibility modifiers are not permitted in this position for enum types + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:419) + + + + + Accessibility modifiers are not permitted on enumeration fields + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:424) + + + + + A type definition requires one or more members or other declarations. If you intend to define an empty class, struct or interface, then use 'type ... = class end', 'interface end' or 'struct end'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:401) + + + + + Accessibility modifiers are not permitted on 'do' bindings, but '%s' was given. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:367) + + + + + Consider using a separate record type instead + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:425) + + + + + Augmentations are not permitted on delegate type moduleDefns + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:399) + + + + + Attributes should be placed before 'val' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:396) + + + + + Attributes are not permitted on 'inherit' declarations + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:414) + + + + + Attributes are not allowed here + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:417) + + + + + Attributes have been ignored in this construct + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:377) + + + + + Attributes are not permitted on interface implementations + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:397) + + + + + Cannot find code target for this attribute, possibly because the code after the attribute is incomplete. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1289) + + + + + 'assert' may not be used as a first class value. Use 'assert <expr>' instead. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:434) + + + + + The use of '->' in sequence and computation expressions is limited to the form 'for pat in expr -> expr'. Use the syntax 'for ... in ... do ... yield...' to generate elements in more complex sequence expressions. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:437) + + + + + All enum fields must be given values + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:420) + + + + + Active pattern case identifiers must begin with an uppercase letter + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:458) + + + + + The '|' character is not permitted in active pattern case identifiers + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:459) + + + + + Accessibility modifiers are not allowed on this member. Abstract slots always have the same visibility as the enclosing type. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:413) + + + + + Write the xmldoc of the assembly to the given file + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:839) + + + + + Specify a Win32 resource file (.res) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:847) + + + + + Specify a Win32 manifest file + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:848) + + + + + Report all warnings as errors + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:865) + + + + + Report specific warnings as errors + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:866) + + + + + Enable specific warnings that may be off by default + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:869) + + + + + Set a warning level (0-5) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:867) + + + + + Output messages in UTF-8 encoding + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:877) + + + + + Enable high-entropy ASLR + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:910) + + + + + Unrecognized target '%s', expected 'exe', 'winexe', 'library' or 'module' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:888) + + + + + Unrecognized debug type '%s', expected 'pdbonly' or 'full' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:889) + + + + + Unrecognized platform '%s', valid values are 'x86', 'x64', 'Itanium', 'anycpu32bitpreferred', and 'anycpu' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:903) + + + + + Algorithm '%s' is not supported + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:904) + + + + + Unknown --test argument: '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:902) + + + + + Specify target framework profile of this assembly. Valid values are mscorlib, netcore or netstandard. Default - mscorlib + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:912) + + + + + Enable or disable tailcalls + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:861) + + + + + Specify subsystem version of this assembly + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:911) + + + + + Specify a strong name key file + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:840) + + + + + Specify a strong name key container + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:841) + + + + + Statically link the given assembly and all referenced DLLs that depend on this assembly. Use an assembly name e.g. mylib, not a DLL name. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:884) + + + + + Statically link the F# library and all referenced DLLs that depend on it into the assembly being generated + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:883) + + + + + --sourcelink switch only supported when emitting a Portable PDB (--debug:portable or --debug:embedded) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:854) + + + + + Source link information file to embed in the portable PDB file + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:852) + + + + + Resolve assembly references using directory-based rules rather than MSBuild resolution + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:887) + + + + + Print the inferred interface of the assembly to a file + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:845) + + + + + Short form of '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:891) + + + + + Response file '%s' not found in '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1331) + + + + + Response file name '%s' is empty, contains invalid characters, has a drive specification without an absolute path, or is too long + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1332) + + + + + Read response file for more options + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:875) + + + + + Embed the specified managed resource + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:856) + + + + + Use a resident background compilation service to improve compiler startup times. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:885) + + + + + Reference an assembly (Short form: -r) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:846) + + + + + Public-sign the assembly using only the public portion of the strong name key, and mark the assembly as signed + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:838) + + + + + Problem with codepage '%d': %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:829) + + + + + Specify the preferred output language culture name (e.g. es-ES, ja-JP) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:914) + + + + + Limit which platforms this code can run on: x86, Itanium, x64, anycpu32bitpreferred, or anycpu. The default is anycpu. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:842) + + + + + Name the output debug file + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:886) + + + + + Maps physical paths to source path names output by the compiler + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:863) + + + + + Enable optimizations (Short form: -O) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:860) + + + + + Do not include the default Win32 manifest + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:849) + + + + + Disable specific warning messages + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:868) + + + + + Suppress compiler copyright message + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:873) + + + + + Do not reference the default CLI assemblies by default + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:882) + + + + + Only include optimization information essential for implementing inlined constructs. Inhibits cross-module inlining but improves binary compatibility. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:843) + + + + + Don't add a resource to the generated assembly containing F#-specific metadata + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:844) + + + + + Don't copy FSharp.Core.dll along the produced binaries + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:915) + + + + + Name of the output file (Short form: -o) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:832) + + + + + Ignore ML compatibility warnings + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:872) + + + + + Link the specified resource to this assembly where the resinfo format is <file>[,<string name>[,public|private]] + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:857) + + + + + Specify a directory for the include path which is used to resolve source files and assemblies (Short form: -I) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:879) + + + + + Invalid warning level '%d' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:890) + + + + + Invalid value '%s' for '--targetprofile', valid values are 'mscorlib', 'netcore' or 'netstandard'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:917) + + + + + Invalid version '%s' for '--subsystemversion'. The version must be 4.00 or greater. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:916) + + + + + Invalid response file '%s' ( '%s' ) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1330) + + + + + Invalid path map. Mappings must be comma separated and of the format 'path=sourcePath' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1148) + + + + + The command-line option '%s' is for test purposes only + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:905) + + + + + - RESOURCES - + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:896) + + + + + - OUTPUT FILES - + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:894) + + + + + - MISCELLANEOUS - + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:899) + + + + + - LANGUAGE - + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:900) + + + + + - INPUT FILES - + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:895) + + + + + - ERRORS AND WARNINGS - + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:901) + + + + + - CODE GENERATION - + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:897) + + + + + - ADVANCED - + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:898) + + + + + Display this usage message (Short form: -?) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:874) + + + + + Output messages with fully qualified paths + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:878) + + + + + Emit debug information in quotations + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:913) + + + + + --embed switch only supported when emitting a Portable PDB (--debug:portable or --debug:embedded) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:853) + + + + + Embed specific source files in the portable PDB file + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:851) + + + + + Embed all source files in the portable PDB file + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:850) + + + + + Produce a deterministic assembly (including module version GUID and timestamp) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:862) + + + + + Delay-sign the assembly using only the public portion of the strong name key + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:837) + + + + + Define conditional compilation symbols (Short form: -d) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:871) + + + + + Emit debug information (Short form: -g) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:858) + + + + + Specify debugging type: full, portable, embedded, pdbonly. ('%s' is the default if no debuggging type specified and enables attaching a debugger to a running program, 'portable' is a cross-platform format, 'embedded' is a cross-platform format embedded into the output file). + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:859) + + + + + The command-line option '%s' has been deprecated + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:906) + + + + + The command-line option '%s' has been deprecated. HTML document generation is now part of the F# Power Pack, via the tool FsHtmlDoc.exe. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:908) + + + + + The command-line option '%s' has been deprecated. Use '%s' instead. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:907) + + + + + Enable or disable cross-module optimizations + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:864) + + + + + Freely distributed under the MIT Open Source License. https://github.com/Microsoft/visualfsharp/blob/master/License.txt + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:831) + + + + + Copyright (c) Microsoft Corporation. All Rights Reserved. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:830) + + + + + Output warning and error messages in color + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:909) + + + + + Specify the codepage used to read source files + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:876) + + + + + Use to override where the compiler looks for mscorlib.dll and framework components + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:893) + + + + + The command-line option '--cliroot' has been deprecated. Use an explicit reference to a specific copy of mscorlib.dll instead. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:892) + + + + + Specify algorithm for calculating source file checksum stored in PDB. Supported values are: SHA1 or SHA256 (default) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:881) + + + + + Generate overflow checks + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:870) + + + + + Build a Windows executable + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:834) + + + + + Build a module that can be added to another assembly + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:836) + + + + + Build a library (Short form: -a) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:835) + + + + + Build a console executable + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:833) + + + + + Base address for the library to be built + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:880) + + + + + A value marked as 'inline' has an unexpected value + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:972) + + + + + A value marked as 'inline' could not be inlined + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:973) + + + + + The value '%s' was marked inline but was not bound in the optimization environment + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:970) + + + + + The value '%s' was marked inline but its implementation makes use of an internal or private function which is not sufficiently accessible + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:969) + + + + + Recursive ValValue %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:975) + + + + + Local value %s not found during optimization + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:971) + + + + + Failed to inline the value '%s' marked 'inline', perhaps because a recursive value was marked 'inline' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:974) + + + + + The union type for union case '%s' was defined with the RequireQualifiedAccessAttribute. Include the name of the union type ('%s') in the name you are using. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:989) + + + + + Unexpected empty long identifier + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:984) + + + + + Multiple types exist called '%s', taking different numbers of generic parameters. Provide a type instantiation to disambiguate the type resolution, e.g. '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:980) + + + + + The instantiation of the generic type '%s' is missing and can't be inferred from the arguments or return type of this member. Consider providing a type instantiation when accessing this type, e.g. '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:981) + + + + + The record type for the record field '%s' was defined with the RequireQualifiedAccessAttribute. Include the name of the record type ('%s') in the name you are using. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:990) + + + + + The record type '%s' does not contain a label '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:985) + + + + + No constructors are available for the type '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:988) + + + + + This is not a constructor or literal, or a constructor is being used incorrectly + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:983) + + + + + Invalid module/expression/type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:979) + + + + + Invalid field label + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:986) + + + + + Invalid expression '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:987) + + + + + 'global' may only be used as the first name in a qualified path + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:982) + + + + + This value is not a function and cannot be applied. Did you intend to access the indexer via %s.[index] instead? + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1434) + + + + + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1436) + + + + + This expression is not a function and cannot be applied. Did you intend to access the indexer via expr.[index] instead? + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1435) + + + + + This value is not a function and cannot be applied. Did you forget to terminate a declaration? + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1437) + + + + + This value is not a function and cannot be applied. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1433) + + + + + No Invoke methods found for delegate type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:955) + + + + + Files in libraries or multiple-file applications must begin with a namespace or module declaration. When using a module declaration at the start of a file the '=' sign is not allowed. If this is a top-level module, consider removing the = to resolve this error. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:51) + + + + + + %d overloads + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1286) + + + + + + 1 overload + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1285) + + + + + More than one Invoke method found for delegate type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:956) + + + + + This construct is for ML compatibility. %s. You can disable this warning by using '--mlcompatibility' or '--nowarn:62'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1067) + + + + + This 'if' expression is missing an 'else' branch. Because 'if' is an expression, and not a statement, add an 'else' branch which also returns a value of type '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:22) + + + + + Method or object constructor '%s' is not static + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1352) + + + + + Infix operator member '%s' has %d initial argument(s). Expected a tuple of 3 arguments + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1297) + + + + + Infix operator member '%s' has %d initial argument(s). Expected a tuple of 2 arguments, e.g. static member (+) (x,y) = ... + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1032) + + + + + Infix operator member '%s' has no arguments. Expected a tuple of 2 arguments, e.g. static member (+) (x,y) = ... + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1031) + + + + + Infix operator member '%s' has extra curried arguments. Expected a tuple of 2 arguments, e.g. static member (+) (x,y) = ... + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1033) + + + + + (loading description...) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1293) + + + + + All elements of a list must be of the same type as the first element, which here is '%s'. This element has type '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:20) + + + + + Identifiers containing '@' are reserved for use in F# code generation + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:960) + + + + + The identifier '%s' is reserved for future use by F# + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:961) + + + + + Possible incorrect indentation: this token is offside of context started at position %s. Try indenting this token further or using standard formatting conventions. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:977) + + + + + The '|' tokens separating rules of this pattern match are misaligned by one column. Consider realigning your code or using further indentation. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:978) + + + + + The indentation of this 'in' token is incorrect with respect to the corresponding 'let' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:976) + + + + + Syntax error. Wrong nested #endif, unexpected tokens before it. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1028) + + + + + Unexpected character '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:997) + + + + + This token is reserved for future use + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1018) + + + + + This Unicode encoding is only valid in string literals + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1017) + + + + + TABs are not allowed in F# code unless the #indent \"off\" option is used + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1019) + + + + + This number is outside the allowable range for 32-bit unsigned integers + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1006) + + + + + This number is outside the allowable range for 32-bit signed integers + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1005) + + + + + This number is outside the allowable range for 64-bit unsigned integers + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1008) + + + + + This number is outside the allowable range for 64-bit signed integers + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1007) + + + + + This number is outside the allowable range for 16-bit unsigned integers + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1004) + + + + + This number is outside the allowable range for 16-bit signed integers + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1003) + + + + + This number is outside the allowable range for unsigned native integers + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1010) + + + + + This number is outside the allowable range for signed native integers + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1009) + + + + + This number is outside the allowable range for this integer type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:992) + + + + + This number is outside the allowable range for 8-bit unsigned integers + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1002) + + + + + This number is outside the allowable range for hexadecimal 8-bit signed integers + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1001) + + + + + This number is outside the allowable range for 8-bit signed integers + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1000) + + + + + This number is outside the allowable range for 32-bit floats + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1013) + + + + + This number is outside the allowable range for decimal literals + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1012) + + + + + \U%s is not a valid Unicode character escape sequence + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1102) + + + + + This is not a valid numeric literal. Valid numeric literals include 1, 0x1, 0b0001 (int), 1u (uint32), 1L (int64), 1UL (uint64), 1s (int16), 1y (sbyte), 1uy (byte), 1.0 (float), 1.0f (float32), 1.0m (decimal), 1I (BigInteger). + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1014) + + + + + Invalid line number: '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1020) + + + + + Invalid floating point number + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1011) + + + + + This is not a valid character literal + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1016) + + + + + This is not a valid byte literal + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1015) + + + + + Consider using a file with extension '.ml' or '.mli' instead + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1074) + + + + + Identifiers followed by '%s' are reserved for future use + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:999) + + + + + #if directive should be immediately followed by an identifier + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1027) + + + + + #if directive must appear as the first non-whitespace character on a line + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1021) + + + + + #endif has no matching #if + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1025) + + + + + #endif required for #else + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1023) + + + + + #endif directive must appear as the first non-whitespace character on a line + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1026) + + + + + #else has no matching #if + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1022) + + + + + #else directive must appear as the first non-whitespace character on a line + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1024) + + + + + #! may only appear as the first line at the start of a file. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1029) + + + + + '%s' is not permitted as a character in operator names and is reserved for future use + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:996) + + + + + This byte array literal contains characters that do not encode as a single byte + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:998) + + + + + Used in mutually recursive bindings, in property declarations, and with multiple constraints on generic parameters. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1357) + + + + + Used in a computation expression to append the result of a given computation expression to a collection of results for the containing computation expression. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1423) + + + + + Used in a sequence expression to produce a value for a sequence. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1422) + + + + + Used together with the match keyword in pattern matching expressions. Also used in object expressions, record copying expressions, and type extensions to introduce member definitions, and to introduce exception handlers. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1421) + + + + + Introduces a looping construct. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1420) + + + + + Used for Boolean conditions (when guards) on pattern matches and to introduce a constraint clause for a generic type parameter. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1419) + + + + + Indicates the .NET void type. Used when interoperating with other .NET languages. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1418) + + + + + Used in a signature to indicate a value, or in a type to declare a member, in limited situations. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1417) + + + + + Used instead of let! in computation expressions for computation expression results that implement IDisposable. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1416) + + + + + Used instead of let for values that implement IDisposable + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1415) + + + + + Used to convert to a type that is higher in the inheritance chain. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1414) + + + + + Delimits a untyped code quotation. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1429) + + + + + Delimits a typed code quotation. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1428) + + + + + Used to declare a class, record, structure, discriminated union, enumeration type, unit of measure, or type abbreviation. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1413) + + + + + Used to introduce a block of code that might generate an exception. Used together with with or finally. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1412) + + + + + Used as a Boolean literal. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1374) + + + + + Used in for loops to indicate a range. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1411) + + + + + Used in conditional expressions. Also used to perform side effects after object construction. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1410) + + + + + Used to declare a structure type. Also used in generic parameter constraints. Used for OCaml compatibility in module definitions. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1409) + + + + + Used to indicate a method or property that can be called without an instance of a type, or a value member that is shared among all instances of a type. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1408) + + + + + Used in query expressions to specify what fields or columns to extract. Note that this is a contextual keyword, which means that it is not actually a reserved word and it only acts like a keyword in appropriate context. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1407) + + + + + In function types, delimits arguments and return values. Yields an expression (in sequence expressions); equivalent to the yield keyword. Used in match expressions + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1424) + + + + + Used to provide a value for the result of the containing computation expression, where that value itself comes from the result another computation expression. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1406) + + + + + Used to provide a value for the result of the containing computation expression. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1405) + + + + + Used to indicate that a function is recursive. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1404) + + + + + Allows access to a member from outside the type. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1403) + + + + + Restricts access to a member to code in the same type or module. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1402) + + + + + Used to implement a version of an abstract or virtual method that differs from the base version. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1401) + + + + + Used with Boolean conditions as a Boolean or operator. Equivalent to ||. Also used in member constraints. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1400) + + + + + Used to make the contents of a namespace or module available without qualification. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1399) + + + + + Used in discriminated unions to indicate the type of categories of values, and in delegate and exception declarations. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1398) + + + + + Indicates the absence of an object. Also used in generic parameter constraints. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1397) + + + + + Not actually a keyword. However, not struct in combination is used as a generic parameter constraint. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1396) + + + + + Used to declare, define, or invoke a constructor that creates or that can create an object. Also used in generic parameter constraints to indicate that a type must have a certain constructor. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1395) + + + + + Used to associate a name with a group of related types and modules, to logically separate it from other code. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1394) + + + + + Used to declare a variable, that is, a value that can be changed. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1393) + + + + + Used to associate a name with a group of related types, values, and functions, to logically separate it from other code. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1392) + + + + + Used to declare a property or method in an object type. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1391) + + + + + Used in computation expressions to pattern match directly over the result of another computation expression. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1390) + + + + + Used to branch by comparing a value to a pattern. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1389) + + + + + Used in computation expressions to bind a name to the result of another computation expression. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1388) + + + + + Used to associate, or bind, a name to a value or function. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1387) + + + + + Assigns a value to a variable. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1425) + + + + + Used to specify a computation that is to be performed only when a result is needed. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1386) + + + + + Used to specify that a member is visible inside an assembly but not outside it. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1385) + + + + + Used to declare and implement interfaces. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1384) + + + + + Used to indicate a function that should be integrated directly into the caller's code. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1383) + + + + + Used to specify a base class or base interface. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1382) + + + + + Used for sequence expressions and, in verbose syntax, to separate expressions from bindings. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1381) + + + + + Used in conditional branching constructs. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1380) + + + + + Used to reference the top-level .NET namespace. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1379) + + + + + Used as a shorter alternative to the fun keyword and a match expression in a lambda expression that has pattern matching on a single argument. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1378) + + + + + Used in lambda expressions, also known as anonymous functions. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1377) + + + + + Used in looping constructs. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1376) + + + + + Used together with try to introduce a block of code that executes regardless of whether an exception occurs. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1375) + + + + + Indicates that a declared program element is defined in another binary or assembly. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1373) + + + + + Used to declare an exception type. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1372) + + + + + In type definitions and type extensions, indicates the end of a section of member definitions. In verbose syntax, used to specify the end of a code block that starts with the begin keyword. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1371) + + + + + Used in conditional branching. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1370) + + + + + Used in conditional branching. A short form of else if. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1369) + + + + + Converts a type to a type that is lower in the hierarchy. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1427) + + + + + In a for expression, used when counting in reverse. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1368) + + + + + Used to convert to a type that is lower in the inheritance chain. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1367) + + + + + In verbose syntax, indicates the end of a block of code in a looping expression. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1366) + + + + + Used in looping constructs or to execute imperative code. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1365) + + + + + Used to declare a delegate. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1364) + + + + + Indicates an implementation of an abstract method; used together with an abstract method declaration to create a virtual method. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1363) + + + + + In verbose syntax, indicates the start of a class definition. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1362) + + + + + Converts a type to type that is higher in the hierarchy. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1426) + + + + + In verbose syntax, indicates the start of a code block. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1361) + + + + + Used as the name of the base class object. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1360) + + + + + Used to verify code during debugging. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1359) + + + + + Used to give the current class object an object name. Also used to give a name to a whole pattern within a pattern match. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1358) + + + + + Indicates a method that either has no implementation in the type in which it is declared or that is virtual and has a default implementation. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1356) + + + + + %s '%s' not found in type '%s' from assembly '%s'. A possible cause may be a version incompatibility. You may need to explicitly reference the correct version of this assembly to allow all referenced components to use the correct version. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1431) + + + + + %s '%s' not found in assembly '%s'. A possible cause may be a version incompatibility. You may need to explicitly reference the correct version of this assembly to allow all referenced components to use the correct version. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1430) + + + + + The 'anycpu32bitpreferred' platform can only be used with EXE targets. You must use 'anycpu' instead. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1280) + + + + + invalid namespace for provided type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1186) + + + + + invalid full name for provided type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1187) + + + + + Invalid provided literal value '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1279) + + + + + This expression returns a value of type '%s' but is implicitly discarded. Consider using 'let' to bind the result to a name, e.g. 'let result = expression'. If you intended to use the expression as a value in the sequence then use an explicit 'yield!'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1442) + + + + + This expression returns a value of type '%s' but is implicitly discarded. Consider using 'let' to bind the result to a name, e.g. 'let result = expression'. If you intended to use the expression as a value in the sequence then use an explicit 'yield'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1441) + + + + + The type '%s' is required here and is unavailable. You must add a reference to assembly '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:964) + + + + + A reference to the type '%s' in assembly '%s' was found, but the type could not be found in that assembly + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:965) + + + + + A reference to the DLL %s is required by assembly %s. The imported type %s is located in the first assembly and could not be resolved. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:967) + + + + + Internal error or badly formed metadata: not enough type parameters were in scope while importing + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:966) + + + + + Invalid number of generic arguments to type '%s' in provided type. Expected '%d' arguments, given '%d'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1256) + + + + + Invalid value unit-of-measure parameter '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1258) + + + + + Invalid value '%s' for unit-of-measure parameter '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1257) + + + + + An imported assembly uses the type '%s' but that type is not public + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:968) + + + + + Invalid argument to 'methodhandleof' during codegen + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1218) + + + + + MDB generation failed. Could not find compatible member %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1083) + + + + + The name of the MDB file must be <assembly-file-name>.mdb. The --pdb option will be ignored. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1082) + + + + + Unexpected error creating debug information file '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:991) + + + + + Cannot generate MDB debug information. Failed to load the 'MonoSymbolWriter' type from the 'Mono.CompilerServices.SymbolWriter.dll' assembly. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1084) + + + + + The file '%s' changed on disk unexpectedly, please reload. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1443) + + + + + Compiler error: unexpected unrealized value + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:821) + + + + + Unexpected GetSet annotation on a property + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:824) + + + + + Undefined value '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:808) + + + + + This type cannot be used for a literal field + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:823) + + + + + The StructLayout attribute could not be decoded + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:826) + + + + + GenSetStorage: %s was represented as a static method but was not an appropriate lambda expression + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:819) + + + + + The signature for this external function contains type parameters. Constrain the argument and return types to indicate the types of the corresponding C function. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:816) + + + + + RSA key expected + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1113) + + + + + Private key expected + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1112) + + + + + No signature directory + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1118) + + + + + Invalid signature size + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1117) + + + + + Invalid RSAParameters structure - '{0}' expected + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1115) + + + + + Invalid Public Key blob + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1119) + + + + + Invalid Magic value in CLR Header + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1110) + + + + + Invalid bit Length + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1114) + + + + + Invalid algId - 'Exponent' expected + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1116) + + + + + Bad image format + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1111) + + + + + Reflected definitions cannot contain uses of the prefix splice operator '%%' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:828) + + + + + Mutable variables cannot escape their method + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:820) + + + + + The MarshalAs attribute could not be decoded + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:815) + + + + + Main module of program is empty: nothing will happen when it is run + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:822) + + + + + Literal fields cannot be set + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:818) + + + + + Label %s not found + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:809) + + + + + Incorrect number of type arguments to local call + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:810) + + + + + The FieldOffset attribute could not be decoded + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:825) + + + + + The FieldOffset attribute can only be placed on members of types marked with the StructLayout(LayoutKind.Explicit) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1077) + + + + + The type '%s' has been marked as having an Explicit layout, but the field '%s' has not been marked with the 'FieldOffset' attribute + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1069) + + + + + Dynamic invocation of %s is not supported + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:811) + + + + + The DllImport attribute could not be decoded + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:817) + + + + + The DefaultAugmentation attribute could not be decoded + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:827) + + + + + Custom marshallers cannot be specified in F# code. Consider using a C# helper function. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:814) + + + + + This operation involves taking the address of a value '%s' represented using a local variable or other special representation. This is invalid. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:813) + + + + + Taking the address of a literal field is invalid + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:812) + + + + + The 'if' expression needs to have type '%s' to satisfy context type requirements. It currently has type '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:23) + + + + + If set to true, then all error messages will just return the filled 'holes' delimited by ',,,'s - this is for language-neutral testing (e.g. localization-invariant baselines). + + + + + Cannot find FSharp.Core.dll in compiler's directory + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1333) + + + + + Conflicting options specified: 'win32manifest' and 'win32res'. Only one of these can be used. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1125) + + + + + Exiting - too many errors + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1121) + + + + + System.Runtime.InteropServices assembly is required to use UnknownWrapper\DispatchWrapper classes. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1315) + + + + + Static linking may not be used on an assembly referencing mscorlib (e.g. a .NET Framework assembly) when generating an assembly that references System.Runtime (e.g. a .NET Core or Portable assembly). + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1144) + + + + + Static linking may not include a mixed managed/unmanaged DLL + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1129) + + + + + Static linking may not include a .EXE + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1128) + + + + + Passing a .resx file (%s) as a source file to the compiler is deprecated. Use resgen.exe to transform the .resx file into a .resources file to pass as a --resource option. If you are using MSBuild, this can be done via an <EmbeddedResource> item in the .fsproj project file. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1143) + + + + + The resident compilation service was not used because a problem occured in communicating with the server. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1141) + + + + + The assembly '%s' is listed on the command line. Assemblies should be referenced using a command line flag such as '-r'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1140) + + + + + Code in this assembly makes uses of quotation literals. Static linking may not include components that make use of quotation literals unless all assemblies are compiled with at least F# 4.0. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1127) + + + + + The code in assembly '%s' makes uses of quotation literals. Static linking may not include components that make use of quotation literals unless all assemblies are compiled with at least F# 4.0. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1126) + + + + + A problem occurred writing the binary '%s': %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1134) + + + + + --pathmap can only be used with portable PDBs (--debug:portable or --debug:embedded) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1147) + + + + + No implementation files specified + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1123) + + + + + Option '--keycontainer' overrides attribute 'System.Reflection.AssemblyNameAttribute' given in a source file or added module + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1139) + + + + + Option '--keyfile' overrides attribute 'System.Reflection.AssemblyKeyFileAttribute' given in a source file or added module + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1138) + + + + + The key file '%s' could not be opened + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1133) + + + + + Ignoring mixed managed/unmanaged assembly '%s' during static linking + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1130) + + + + + Deterministic builds only support portable PDBs (--debug:portable or --debug:embedded) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1146) + + + + + Option '--delaysign' overrides attribute 'System.Reflection.AssemblyDelaySignAttribute' given in a source file or added module + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1137) + + + + + The attribute %s specified version '%s', but this value is invalid and has been ignored + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1124) + + + + + Assembly '%s' was referenced transitively and the assembly could not be resolved automatically. Static linking will assume this DLL has no dependencies on the F# library or other statically linked DLLs. Consider adding an explicit reference to this DLL. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1131) + + + + + An %s specified version '%s', but this value is a wildcard, and you have requested a deterministic build, these are in conflict. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1145) + + + + + The 'AssemblyVersionAttribute' has been ignored because a version was given using a command line option + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1135) + + + + + Assembly '%s' not found in dependency set of target binary. Statically linked roots should be specified using an assembly name, without a DLL or EXE extension. If this assembly was referenced explicitly then it is possible the assembly was not actually required by the generated binary, in which case it should not be statically linked. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1132) + + + + + Error emitting 'System.Reflection.AssemblyCultureAttribute' attribute -- 'Executables cannot be satellite assemblies, Culture should always be empty' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1136) + + + + + Prefix flag (' ' or '+') set twice + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:224) + + + + + Precision missing after the '.' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:229) + + + + + Positional specifiers are not permitted in format strings + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:221) + + + + + Missing format specifier + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:222) + + + + + The 'l' or 'L' in this format specifier is unnecessary. In F# code you can use %%d, %%x, %%o or %%u instead, which are overloaded to work with all basic integer types. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:232) + + + + + The # formatting modifier is invalid in F# + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:225) + + + + + The 'h' or 'H' in this format specifier is unnecessary. You can use %%d, %%x, %%o or %%u instead, which are overloaded to work with all basic integer types. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:233) + + + + + '%s' format does not support precision + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:230) + + + + + '%s' flag set twice + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:223) + + + + + '%s' format does not support '0' flag + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:228) + + + + + '%s' does not support prefix '%s' flag + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:234) + + + + + Bad width in format specifier + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:227) + + + + + Bad precision in format specifier + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:226) + + + + + Bad format specifier: '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:235) + + + + + Bad format specifier (after l or L): Expected ld,li,lo,lu,lx or lX. In F# code you can use %%d, %%x, %%o or %%u instead, which are overloaded to work with all basic integer types. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:231) + + + + + All branches of a pattern match expression must return values of the same type as the first branch, which here is '%s'. This branch returns a value of type '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:25) + + + + + The record, struct or class field '%s' is not accessible from this code location + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:952) + + + + + %s for F# %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1467) + + + + + This construct is experimental + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:954) + + + + + The event '%s' has a non-standard type. If this event is declared in another CLI language, you may need to access this event using the explicit %s and %s methods for the event. If this event is declared in F#, make the type of the event an instantiation of either 'IDelegateEvent<_>' or 'IEvent<_,_>'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:947) + + + + + Unsupported expression '%s' from type provider. If you are the author of this type provider, consider adjusting it to provide a different provided expression. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1168) + + + + + Invalid member '%s' on provided type '%s'. Only properties, methods and constructors are allowed + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1160) + + + + + Unsupported constant type '%s'. Quotations provided by type providers can only contain simple constants. The implementation of the type provider may need to be adjusted by moving a value declared outside a provided quotation literal to be a 'let' binding inside the quotation literal. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1167) + + + + + Unknown static argument kind '%s' when resolving a reference to a provided type or method '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1185) + + + + + Unexpected 'null' return value from provided type '%s' member '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1180) + + + + + Unexpected exception from provided type '%s' member '%s': %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1166) + + + + + Unexpected exception from member '%s' of provided type '%s' member '%s': %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1181) + + + + + The type provider constructor has thrown an exception: %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1190) + + + + + Too many static parameters. Expected at most %d parameters, but got %d unnamed and %d named parameters. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1278) + + + + + The static parameter '%s' of the provided type or method '%s' requires a value. Static parameters to type providers may be optionally specified using named arguments, e.g. '%s<%s=...>'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1210) + + + + + The static parameter '%s' has already been given a value + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1212) + + + + + The type provider returned 'null', which is not a valid return value from '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1189) + + + + + Assembly attribute '%s' refers to a designer assembly '%s' which cannot be loaded or doesn't exist. %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1172) + + + + + The type provider '%s' reported an error in the context of provided type '%s', member '%s'. The error: %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1203) + + + + + The type provider '%s' reported an error: %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1174) + + + + + The type provider does not have a valid constructor. A constructor taking either no arguments or one argument of type 'TypeProviderConfig' was expected. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1173) + + + + + The '%s' of a provided type was null or empty. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1205) + + + + + An exception occurred when accessing the '%s' of a provided type: %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1204) + + + + + A reference to a provided type was missing a value for the static parameter '%s'. You may need to recompile one or more referenced assemblies. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1219) + + + + + A reference to a provided type had an invalid value '%s' for a static parameter. You may need to recompile one or more referenced assemblies. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1220) + + + + + Expected provided type with path '%s' but provided type has path '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1179) + + + + + Expected provided type named '%s' but provided type has 'Name' with value '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1169) + + + + + The type provider '%s' returned an invalid type from 'ApplyStaticArguments'. A type with name '%s' was expected, but a type with name '%s' was returned. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1192) + + + + + The type provider '%s' returned an invalid method from 'ApplyStaticArgumentsForMethod'. A method with name '%s' was expected, but a method with name '%s' was returned. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1193) + + + + + Property '%s' on provided type '%s' is neither readable nor writable as it has CanRead=false and CanWrite=false + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1259) + + + + + Property '%s' on provided type '%s' has CanWrite=false but GetSetMethod() returned a method + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1164) + + + + + Property '%s' on provided type '%s' has CanRead=false but GetGetMethod() returned a method + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1162) + + + + + Property '%s' on provided type '%s' has CanWrite=true but there was no value from GetSetMethod() + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1163) + + + + + Property '%s' on provided type '%s' has CanRead=true but there was no value from GetGetMethod() + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1161) + + + + + One or more errors seen during provided type setup + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1165) + + + + + Type provider '%s' returned null from GetInvokerExpression. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1191) + + + + + The provided type '%s' returned a member with a null or empty member name + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1150) + + + + + The provided type '%s' has member '%s' which has declaring type '%s'. Expected declaring type to be the same as provided type. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1153) + + + + + The provided type '%s' member info '%s' has null declaring type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1152) + + + + + The provided type '%s' returned a null member + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1151) + + + + + No static parameter exists with name '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1211) + + + + + Nested provided types do not take static arguments or generic parameters + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1182) + + + + + Provided type '%s' has 'IsGenericType' as true, but generic types are not supported. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1157) + + + + + Provided type '%s' has 'IsArray' as true, but array types are not supported. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1158) + + + + + Multiple static parameters exist with name '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1213) + + + + + This provided method requires static parameters + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1335) + + + + + Invalid member '%s' on provided type '%s'. Provided type members must be public, and not be generic, virtual, or abstract. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1159) + + + + + Assembly '%s' hase TypeProviderAssembly attribute with invalid value '%s'. The value should be a valid assembly name + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1198) + + + + + Invalid static argument to provided type. Expected an argument of kind '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1183) + + + + + The type provider '%s' provided a method with a name '%s' and metadata token '%d', which is not reported among its methods of its declaring type '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1176) + + + + + The type provider '%s' provided a constructor which is not reported among the constructors of its declaring type '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1177) + + + + + The type provider '%s' used an invalid parameter in the ParameterExpression: %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1175) + + + + + Character '%s' is not allowed in provided type name '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1206) + + + + + Character '%s' is not allowed in provided namespace name '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1149) + + + + + Referenced assembly '%s' has assembly level attribute '%s' but no public type provider classes were found + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1154) + + + + + Event '%s' on provided type '%s' has no value from GetRemoveMethod() + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1171) + + + + + Event '%s' on provided type '%s' has no value from GetAddMethod() + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1170) + + + + + An error occured applying the static arguments to a provided type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1184) + + + + + An error occured applying the static arguments to a provided method + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1318) + + + + + The provider '%s' returned a non-generated type '%s' in the context of a set of generated types. Consider adjusting the type provider to only return generated types. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1282) + + + + + Type '%s' from type provider '%s' has an empty namespace. Use 'null' for the global namespace. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1155) + + + + + Empty namespace found from the type provider '%s'. Use 'null' for the global namespace. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1156) + + + + + A direct reference to the generated type '%s' is not permitted. Instead, use a type definition, e.g. 'type TypeAlias = <path>'. This indicates that a type provider adds generated types to your assembly. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1178) + + + + + Named static arguments must come after all unnamed static arguments + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1209) + + + + + A type provider implemented GetStaticParametersForMethod, but ApplyStaticArgumentsForMethod was not implemented or invalid + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1317) + + + + + Erased to + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1287) + + + + + All branches of an 'if' expression must return values of the same type as the first branch, which here is '%s'. This branch returns a value of type '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:24) + + + + + System.Environment.Exit did not exit + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:236) + + + + + The treatment of this operator is now handled directly by the F# compiler and its meaning cannot be redefined + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:237) + + + + + The documentation file has no .xml suffix + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1122) + + + + + is + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1432) + + + + + (description unavailable...) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1294) + + + + + The '!' operator is used to dereference a ref cell. Consider using 'not expr' here. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:28) + + + + + Delegates are not allowed to have curried signatures + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:957) + + + + + %s var in collection + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1225) + + + + + %s var in collection %s (outerKey = innerKey). Note that parentheses are required after '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1223) + + + + + %s var in collection %s (outerKey = innerKey) into group. Note that parentheses are required after '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1224) + + + + + None of the types '%s' support the operator '%s'. Consider opening the module 'Microsoft.FSharp.Linq.NullableOperators'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:309) + + + + + None of the types '%s' support the operator '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:307) + + + + + This type parameter cannot be instantiated to 'Nullable'. This is a restriction imposed in order to ensure the meaning of 'null' in some CLI languages is not confusing when used in conjunction with 'Nullable' values. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:326) + + + + + The type '%s' is not compatible with any of the types %s, arising from the use of a printf-style format string + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:329) + + + + + The type '%s' is not a CLI enum type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:323) + + + + + The type '%s' is not a CLI delegate type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:325) + + + + + Type instantiation length mismatch + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:333) + + + + + Type inference problem too complicated (maximum iteration depth reached). Consider adding further type annotations. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:302) + + + + + The type '%s' has a non-standard delegate type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:324) + + + + + The type '%s' does not support the operator '%s'. Consider opening the module 'Microsoft.FSharp.Linq.NullableOperators'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:310) + + + + + The type '%s' does not support the operator '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:308) + + + + + The type '%s' does not support the 'equality' constraint because it is a record, union or struct with one or more structural element types which do not support the 'equality' constraint. Either avoid the use of equality with this type, or add the 'StructuralEquality' attribute to the type to determine which field type does not support equality + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:322) + + + + + The type '%s' does not support the 'equality' constraint because it is a function type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:321) + + + + + The type '%s' does not support the 'equality' constraint because it has the 'NoEquality' attribute + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:320) + + + + + The type '%s' does not support a conversion to the type '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:311) + + + + + The type '%s' does not support the 'comparison' constraint because it is a record, union or struct with one or more structural element types which do not support the 'comparison' constraint. Either avoid the use of comparison with this type, or add the 'StructuralComparison' attribute to the type to determine which field type does not support comparison + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:319) + + + + + The type '%s' does not support the 'comparison' constraint. For example, it does not support the 'System.IComparable' interface + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:318) + + + + + The type '%s' does not support the 'comparison' constraint because it has the 'NoComparison' attribute + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:317) + + + + + The type '%s' does not have 'null' as a proper value + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:315) + + + + + The declared type parameter '%s' cannot be used here since the type parameter cannot be resolved at compile time + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:300) + + + + + The constraints 'struct' and 'not struct' are inconsistent + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:314) + + + + + The available overloads are shown below. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:366) + + + + + The required signature is %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:346) + + + + + Optional arguments not permitted here + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:334) + + + + + The type '%s' does not have 'null' as a proper value. To create a null value for a Nullable type use 'System.Nullable()'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:316) + + + + + No overloads match for method '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:363) + + + + + No %s member or object constructor named '%s' takes %d arguments. The named argument '%s' doesn't correspond to any argument or settable return property for any overload. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:361) + + + + + No %s member or object constructor named '%s' takes %d arguments. Note the call to this member also provides %d named arguments. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:360) + + + + + No %s member or object constructor named '%s' takes %d arguments + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:359) + + + + + Method or object constructor '%s' not found + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:362) + + + + + A unique overload for method '%s' could not be determined based on type information prior to this program point. A type annotation may be needed. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:364) + + + + + %s is not an instance method + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:343) + + + + + %s is not a static method + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:342) + + + + + The type '%s' has a method '%s' (full name '%s'), but the method is static + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:312) + + + + + The type '%s' has a method '%s' (full name '%s'), but the method is not static + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:313) + + + + + This method expects a CLI 'params' parameter in this position. 'params' is a way of passing a variable number of arguments to a method in languages such as C#. Consider passing an array for this argument + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:339) + + + + + The member or object constructor '%s' takes %d type argument(s) but is here given %d. The required signature is '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:355) + + + + + The member or object constructor '%s' requires %d argument(s) but is here given %d unnamed and %d named argument(s). The required signature is '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:351) + + + + + The member or object constructor '%s' takes %d argument(s) but is here given %d. The required signature is '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:352) + + + + + The member or object constructor '%s' requires %d additional argument(s). The required signature is '%s'. Some names for missing arguments are %s. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:350) + + + + + The member or object constructor '%s' requires %d argument(s). The required signature is '%s'. Some names for missing arguments are %s. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:349) + + + + + The member or object constructor '%s' requires %d additional argument(s). The required signature is '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:348) + + + + + The member or object constructor '%s' requires %d argument(s). The required signature is '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:347) + + + + + The member or object constructor '%s' does not take %d argument(s). An overload was found taking %d arguments. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:358) + + + + + A member or object constructor '%s' taking %d arguments is not accessible from this code location. All accessible versions of method '%s' take %d arguments. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:356) + + + + + %s is not a static member + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:335) + + + + + %s is not an instance member + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:336) + + + + + The member or object constructor '%s' is not %s. Private members may only be accessed from within the declaring type. Protected members may only be accessed from an extending type and cannot be accessed from inner lambda expressions. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:341) + + + + + The member or object constructor '%s' is not %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:340) + + + + + The member or object constructor '%s' has no argument or settable return property '%s'. %s. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:344) + + + + + This indexer expects %d arguments but is here given %d + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:304) + + + + + Incorrect generic instantiation. No %s member named '%s' takes %d generic arguments. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:357) + + + + + A generic construct requires that the type '%s' is an unmanaged type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:328) + + + + + A generic construct requires that the type '%s' is a CLI or F# struct type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:327) + + + + + A generic construct requires that the type '%s' have reference semantics, but it does not, i.e. it is a struct + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:330) + + + + + A generic construct requires that the type '%s' have a public default constructor + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:332) + + + + + A generic construct requires that the type '%s' be non-abstract + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:331) + + + + + Expected arguments to an instance member + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:303) + + + + + Expecting a type supporting the operator '%s' but given a tuple type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:306) + + + + + Expecting a type supporting the operator '%s' but given a function type. You may be missing an argument to a function. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:305) + + + + + The object constructor '%s' takes %d argument(s) but is here given %d. The required signature is '%s'. If some of the arguments are meant to assign values to properties, consider separating those arguments with a comma (','). + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:354) + + + + + The object constructor '%s' takes %d argument(s) but is here given %d. The required signature is '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:353) + + + + + The object constructor '%s' has no argument or settable return property '%s'. %s. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:345) + + + + + This code is less generic than indicated by its annotations. A unit-of-measure specified using '_' has been determined to be '1', i.e. dimensionless. Consider making the code generic, or removing the use of '_'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:301) + + + + + Candidates: %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:365) + + + + + The argument types don't match + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:338) + + + + + Argument length mismatch + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:337) + + + + + Quotations cannot contain expressions that set union case fields + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:292) + + + + + Quotations cannot contain expressions that set fields in exception values + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:293) + + + + + Quotations cannot contain expressions that require byref pointers + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:294) + + + + + Quotations cannot contain expressions that fetch union case indexes + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:291) + + + + + Quotations cannot contain this kind of type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:299) + + + + + Quotations cannot contain this kind of pattern match + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:297) + + + + + Quotations cannot contain this kind of constant + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:296) + + + + + Quotations cannot contain expressions that fetch static fields + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:288) + + + + + Quotations cannot contain object expressions + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:286) + + + + + Quotations cannot contain inline assembly code or pattern matching on arrays + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:289) + + + + + Quotations cannot contain function definitions that are inferred or declared to be generic. Consider adding some type constraints to make this a valid quoted expression. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:285) + + + + + Quotations cannot contain uses of generic expressions + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:284) + + + + + Quotations cannot contain descending for loops + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:290) + + + + + Quotations cannot contain array pattern matching + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:298) + + + + + Quotations cannot contain expressions that take the address of a field + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:287) + + + + + Quotations cannot contain expressions that make member constraint calls, or uses of operators that implicitly resolve to a member constraint call + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:295) + + + + + A quotation may not involve an assignment to or taking the address of a captured local variable + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1284) + + + + + Inner generic functions are not permitted in quoted expressions. Consider adding some type constraints until this function is no longer generic. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1093) + + + + + The variable '%s' is bound in a quotation but is used as part of a spliced expression. This is not permitted since it may escape its scope. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:283) + + + + + The conversion from %s to %s is a compile-time safe upcast, not a downcast. Consider using the :> (upcast) operator instead of the :?> (downcast) operator. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1337) + + + + + The conversion from %s to %s is a compile-time safe upcast, not a downcast. Consider using 'upcast' instead of 'downcast'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1336) + + + + + A ';' is used to separate field values in records. Consider replacing ',' with ';'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:27) + + + + + The variable '%s' is used in an invalid way + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:241) + + + + + The type of a field using the 'DefaultValue' attribute must admit default initialization, i.e. have 'null' as a proper value or be a struct type whose fields all admit default initialization. You can use 'DefaultValue(false)' to disable this check + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:281) + + + + + The value '%s' is unused + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1044) + + + + + The recursive object reference '%s' is unused. The presence of a recursive object reference adds runtime initialization checks to members in this and derived types. Consider removing this recursive object reference. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1045) + + + + + default augmentation of the union case + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:266) + + + + + compiled form of the union case + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:265) + + + + + The type '%s' is less accessible than the value, member or type '%s' it is used in. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:242) + + + + + A type variable has been constrained by multiple different class types. A type variable may only have one class constraint. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1295) + + + + + 'System.Void' can only be used as 'typeof<System.Void>' in F# + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:243) + + + + + Struct members cannot return the address of fields of the struct by reference + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1452) + + + + + Expression-splicing operators may only be used within quotations + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:246) + + + + + A method return type would contain byrefs which is not permitted + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:258) + + + + + [<ReflectedDefinition>] terms cannot contain uses of the prefix splice operator '%%' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:263) + + + + + A protected member is called or 'base' is being used. This is only allowed in the direct implementation of members since they could escape their object scope. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:238) + + + + + The property '%s' has the same name as a method in type '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:267) + + + + + The property '%s' has the same name as another property in type '%s', but one takes indexer arguments and the other does not. You may be missing an indexer argument to one of your properties. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:269) + + + + + Object constructors cannot directly use try/with and try/finally prior to the initialization of the object. This includes constructs such as 'for x in ...' that may elaborate to uses of these constructs. This is a limitation imposed by Common IL. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:252) + + + + + This value can't be assigned because the target '%s' may refer to non-stack-local memory, while the expression being assigned is assessed to potentially refer to stack-local memory. This is to help prevent pointers to stack-bound memory escaping their scope. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1449) + + + + + The Span or IsByRefLike variable '%s' cannot be used at this point. This is to ensure the address of the local value does not escape its scope. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1454) + + + + + A Span or IsByRefLike value returned from the expression cannot be used at ths point. This is to ensure the address of the local value does not escape its scope. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1455) + + + + + ReflectedDefinitionAttribute may not be applied to an instance member on a struct type, because the instance member takes an implicit 'this' byref parameter + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1086) + + + + + First-class uses of the expression-splicing operator are not permitted + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:247) + + + + + First-class uses of the 'reraise' function is not permitted + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:249) + + + + + First-class uses of the address-of operators are not permitted + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:248) + + + + + Type '%s' is illegal because in byref<T>, T cannot contain byref types. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1267) + + + + + The function or method call cannot be used at this point, because one argument that is a byref of a non-stack-local Span or IsByRefLike type is used with another argument that is a stack-local Span or IsByRefLike type. This is to ensure the address of the local value does not escape its scope. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1453) + + + + + The type abbreviation contains byrefs. This is not permitted by F#. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:282) + + + + + The byref typed value '%s' cannot be used at this point + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:250) + + + + + A byref typed value would be stored here. Top-level let-bound byref values are not permitted. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:262) + + + + + The address of a value returned from the expression cannot be used at this point. This is to ensure the address of the local value does not escape its scope. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1448) + + + + + The address of the variable '%s' or a related expression cannot be used at this point. This is to ensure the address of the local value does not escape its scope. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1347) + + + + + The address of the static field '%s' cannot be used at this point + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:254) + + + + + The address of the variable '%s' cannot be used at this point + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:253) + + + + + The address of an array element cannot be used at this point + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:256) + + + + + The address of the field '%s' cannot be used at this point + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:255) + + + + + This type implements the same interface at different generic instantiations '%s' and '%s'. This is not permitted in this version of F#. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:280) + + + + + The member '%s' is used in an invalid way. A use of '%s' has been inferred prior to its definition at or near '%s'. This is an invalid forward reference. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:261) + + + + + 'base' values may only be used to make direct calls to the base implementations of overridden members + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:251) + + + + + The function or method has an invalid return type '%s'. This is not permitted by the rules of Common IL. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1465) + + + + + The parameter '%s' has an invalid type '%s'. This is not permitted by the rules of Common IL. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1464) + + + + + Invalid custom attribute value (not a constant or literal) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:259) + + + + + The property '%s' of type '%s' has a getter and a setter that do not match. If one is abstract then the other must be as well. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:268) + + + + + A property's getter and setter must have the same type. Property '%s' has getter of type '%s' but setter of type '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1304) + + + + + The type of a first-class function cannot contain byrefs + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:257) + + + + + A type instantiation involves a byref type. This is not permitted by the rules of Common IL. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:244) + + + + + Calls to 'reraise' may only occur directly in a handler of a try-with + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:245) + + + + + A function labeled with the 'EntryPointAttribute' attribute must be the last declaration in the last file in the compilation sequence. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:264) + + + + + Duplicate property. The property '%s' has the same name and signature as another property in type '%s' once tuples, functions, units of measure and/or provided types are erased. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:277) + + + + + Duplicate property. The property '%s' has the same name and signature as another property in type '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:276) + + + + + Duplicate method. The method '%s' has the same name and signature as another method in type '%s' once tuples, functions, units of measure and/or provided types are erased. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:273) + + + + + Duplicate method. The abstract method '%s' has the same name and signature as an abstract method in an inherited type once tuples, functions, units of measure and/or provided types are erased. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:279) + + + + + Duplicate method. The abstract method '%s' has the same name and signature as an abstract method in an inherited type. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:278) + + + + + The method '%s' has curried arguments but has the same name as another method in type '%s'. Methods with curried arguments cannot be overloaded. Consider using a method taking tupled arguments. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:274) + + + + + Duplicate method. The method '%s' has the same name and signature as another method in type '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:272) + + + + + Methods with curried arguments cannot declare 'out', 'ParamArray', 'optional', 'ReflectedDefinition', 'byref', 'CallerLineNumber', 'CallerMemberName', or 'CallerFilePath' arguments + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:275) + + + + + A type would store a byref typed value. This is not permitted by Common IL. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:270) + + + + + The byref-typed variable '%s' is used in an invalid way. Byrefs cannot be captured by closures or passed to inner functions. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:239) + + + + + The 'base' keyword is used in an invalid way. Base calls cannot be used in closures. Consider using a private member to make base calls. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:240) + + + + + The attribute type '%s' has 'AllowMultiple=false'. Multiple instances of this attribute cannot be attached to a single language element. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:260) + + + + + Redundant arguments are being ignored in function '%s'. Expected %d but got %d arguments. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1326) + + + + + Type inference caused an inference type variable to escape its scope. Consider adding type annotations to make your code less generic. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1325) + + + + + Type inference caused the type variable %s to escape its scope. Consider adding an explicit type parameter declaration or adjusting your code to be less generic. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1324) + + + + + Lowercase literal '%s' is being shadowed by a new pattern with the same name. Only uppercase and module-prefixed literals can be used as named patterns. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1327) + + + + + The operator '%s' cannot be resolved. Consider opening the module 'Microsoft.FSharp.Linq.NullableOperators'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1298) + + + + + Unrecognized option: '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:71) + + + + + The non-generic type '%s' does not expect any type arguments, but here is given %d type argument(s) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:29) + + + + + Filename '%s' contains invalid character '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1091) + + + + + The signature file '%s' does not have a corresponding implementation file. If an implementation file exists then check the 'module' and 'namespace' declarations in the signature and implementation files match. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:68) + + + + + A signature for the file or module '%s' has already been specified + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:65) + + + + + The search directory '%s' could not be found + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:42) + + + + + F# Compiler for F# %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:37) + + + + + Microsoft (R) F# Compiler version %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:36) + + + + + Problem with filename '%s': %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:38) + + + + + Problem reading assembly '%s': %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1291) + + + + + The '--pdb' option requires the '--debug' option to be used + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:40) + + + + + Option requires parameter: %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:53) + + + + + No inputs specified + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:39) + + + + + This file contains multiple declarations of the form 'module SomeNamespace.SomeModule'. Only one declaration of this form is permitted in a file. Change your file to use an initial namespace declaration and/or use 'module ModuleName = ...' to define your modules. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:52) + + + + + Multiple references to '%s.dll' are not permitted + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:46) + + + + + Files in libraries or multiple-file applications must begin with a namespace or module declaration, e.g. 'namespace SomeNamespace.SubNamespace' or 'module SomeNamespace.SomeModule'. Only the last source file of an application may omit such a declaration. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:50) + + + + + Invalid warning number '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:33) + + + + + Invalid version string '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:34) + + + + + Invalid version file '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:35) + + + + + The file extension of '%s' is not recognized. Source files must have extension .fs, .fsi, .fsx, .fsscript, .ml or .mli. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:55) + + + + + The search directory '%s' is invalid + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:41) + + + + + Unrecognized privacy setting '%s' for managed resource, valid options are 'public' and 'private' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:45) + + + + + Invalid module or namespace name + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:72) + + + + + Invalid directive. Expected '#time', '#time \"on\"' or '#time \"off\"'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:63) + + + + + Invalid directive. Expected '#r \"<file-or-assembly>\"'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:61) + + + + + Invalid directive. Expected '#load \"<file>\" ... \"<file>\"'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:62) + + + + + Invalid directive. Expected '#I \"<path>\"'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:60) + + + + + '%s' is not a valid filename + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:43) + + + + + '%s' is not a valid assembly name + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:44) + + + + + The declarations in this file will be placed in an implicit module '%s' based on the file name '%s'. However this is not a valid F# identifier, so the contents will not be accessible from other files. Consider renaming the file or adding a 'module' or 'namespace' declaration at the top of the file. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:49) + + + + + An implementation of file or module '%s' has already been given. Compilation order is significant in F# because of type inference. You may need to adjust the order of your files to place the signature file before the implementation. In Visual Studio files are type-checked in the order they appear in the project file, which can be edited manually or adjusted using the solution explorer. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:66) + + + + + An implementation of the file or module '%s' has already been given + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:67) + + + + + When mscorlib.dll or FSharp.Core.dll is explicitly referenced the %s option must also be passed + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1088) + + + + + FSharp.Core.sigdata not found alongside FSharp.Core. File expected in %s. Consider upgrading to a more recent version of FSharp.Core, where this file is no longer be required. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1089) + + + + + File '%s' not found alongside FSharp.Core. File expected in %s. Consider upgrading to a more recent version of FSharp.Core, where this file is no longer be required. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1090) + + + + + Error opening binary file '%s': %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:58) + + + + + Directives inside modules are ignored + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:64) + + + + + The F#-compiled DLL '%s' needs to be recompiled to be used with this version of F# + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:59) + + + + + Could not resolve assembly '%s' required by '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:57) + + + + + Could not resolve assembly '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:56) + + + + + Source file '%s' could not be found + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:54) + + + + + The file extensions '.ml' and '.mli' are for ML compatibility + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1073) + + + + + Unable to read assembly '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:47) + + + + + Assembly resolution failure at or near this location + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:48) + + + + + '%s' is not a valid integer argument + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:69) + + + + + '%s' is not a valid floating point argument + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:70) + + + + + A type cannot have both the 'ReferenceEquality' and 'StructuralEquality' or 'StructuralComparison' attributes + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:213) + + + + + The 'StructuralEquality' attribute must be used in conjunction with the 'NoComparison' or 'StructuralComparison' attributes + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:212) + + + + + The 'StructuralComparison' attribute must be used in conjunction with the 'StructuralEquality' attribute + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:211) + + + + + A type with attribute 'ReferenceEquality' cannot have an explicit implementation of 'Object.Equals(obj)', 'System.IEquatable<_>' or 'System.Collections.IStructuralEquatable' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:215) + + + + + Only record, union, exception and struct types may be augmented with the 'ReferenceEquality', 'StructuralEquality' and 'StructuralComparison' attributes + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:214) + + + + + The 'ReferenceEquality' attribute cannot be used on structs. Consider using the 'StructuralEquality' attribute instead, or implement an override for 'System.Object.Equals(obj)'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:208) + + + + + The 'NoEquality' attribute must be used in conjunction with the 'NoComparison' attribute + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:210) + + + + + A type with attribute 'NoEquality' should not usually have an explicit implementation of 'Object.Equals(obj)'. Disable this warning if this is intentional for interoperability purposes + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:218) + + + + + A type with attribute 'NoComparison' should not usually have an explicit implementation of 'System.IComparable', 'System.IComparable<_>' or 'System.Collections.IStructuralComparable'. Disable this warning if this is intentional for interoperability purposes + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:219) + + + + + This type uses an invalid mix of the attributes 'NoEquality', 'ReferenceEquality', 'StructuralEquality', 'NoComparison' and 'StructuralComparison' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:209) + + + + + A type with attribute 'CustomEquality' must have an explicit implementation of at least one of 'Object.Equals(obj)', 'System.IEquatable<_>' or 'System.Collections.IStructuralEquatable' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:216) + + + + + The 'CustomEquality' attribute must be used in conjunction with the 'NoComparison' or 'CustomComparison' attributes + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:220) + + + + + A type with attribute 'CustomComparison' must have an explicit implementation of at least one of 'System.IComparable' or 'System.Collections.IStructuralComparable' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:217) + + + + + Error while parsing embedded IL type + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:205) + + + + + Error while parsing embedded IL + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:204) + + + + + Invalid expression on left of assignment + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:207) + + + + + This indexer notation has been removed from the F# language + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:206) + + + + + .NET Framework + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:943) + + + + + Global Assembly Cache + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:944) + + + + + Found by AssemblyFolders registry key + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:941) + + + + + Found by AssemblyFoldersEx registry key + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:942) + + + + + All elements of an array must be of the same type as the first element, which here is '%s'. This element has type '%s'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:21) + + + + + Add . for indexer access. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:19) + + + + + Active pattern '%s' is not a function + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1075) + + + + + Active pattern '%s' has a result type containing type variables that are not determined by the input. The common cause is a when a result case is not mentioned, e.g. 'let (|A|B|) (x:int) = A x'. This can be fixed with a type constraint, e.g. 'let (|A|B|) (x:int) : Choice<int,unit> = A x' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1076) + + + + + The mutable local '%s' is implicitly allocated as a reference cell because it has been captured by a closure. This warning is for informational purposes only to indicate where implicit allocations are performed. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1316) + + + + + Module '%s' contains\n %s \nbut its signature specifies\n %s \nOne is virtual and the other isn't + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:113) + + + + + Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe types differ + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:105) + + + + + Module '%s' contains\n %s \nbut its signature specifies\n %s \nOne is static and the other isn't + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:112) + + + + + Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe compiled representation of this method is as a static member but the signature indicates its compiled representation is as an instance member + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:118) + + + + + Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe respective type parameter counts differ + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:104) + + + + + Module '%s' contains\n %s \nbut its signature specifies\n %s \nOne is marked as an override and the other isn't + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:116) + + + + + Module '%s' contains\n %s \nbut its signature specifies\n %s \nOne is a type function and the other is not. The signature requires explicit type parameters if they are present in the implementation. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:103) + + + + + Module '%s' contains\n %s \nbut its signature specifies\n %s \nOne is a constructor/property and the other is not + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:117) + + + + + Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe names differ + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:97) + + + + + Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe literal constant values and/or attributes differ + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:102) + + + + + Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe compiled representation of this method is as an instance member, but the signature indicates its compiled representation is as a static member + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:119) + + + + + Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe inline flags differ + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:101) + + + + + Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe number of generic parameters in the signature and implementation differ (the signature declares %s but the implementation declares %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:108) + + + + + Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe generic parameters in the signature and implementation have different kinds. Perhaps there is a missing [<Measure>] attribute. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:109) + + + + + Module '%s' contains\n %s \nbut its signature specifies\n %s \nOne is final and the other isn't + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:115) + + + + + Module '%s' contains\n %s \nbut its signature specifies\n %s \nOne is an extension member and the other is not + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:106) + + + + + Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe CLI member names differ + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:111) + + + + + Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe display names differ + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:99) + + + + + Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe compiled names differ + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:98) + + + + + Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe mutability attributes differ + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:96) + + + + + Module '%s' contains\n %s \nbut its signature specifies\n %s \nAn arity was not inferred for this value + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:107) + + + + + Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe arities in the signature and implementation differ. The signature specifies that '%s' is function definition or lambda expression accepting at least %s argument(s), but the implementation is a computed function value. To declare that a computed function value is a permitted implementation simply parenthesize its type in the signature, e.g.\n\tval %s: int -> (int -> int)\ninstead of\n\tval %s: int -> int -> int. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:110) + + + + + Module '%s' contains\n %s \nbut its signature specifies\n %s \nThe accessibility specified in the signature is more than that specified in the implementation + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:100) + + + + + Module '%s' contains\n %s \nbut its signature specifies\n %s \nOne is abstract and the other isn't + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:114) + + + + + Call this method once to validate that all known resources are valid; throws if not + + + + + The module contains the constructor\n %s \nbut its signature specifies\n %s \nThe types of the fields differ + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:154) + + + + + The module contains the constructor\n %s \nbut its signature specifies\n %s \nThe names differ + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:152) + + + + + The module contains the constructor\n %s \nbut its signature specifies\n %s \nThe respective number of data fields differ + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:153) + + + + + The module contains the constructor\n %s \nbut its signature specifies\n %s \nthe accessibility specified in the signature is more than that specified in the implementation + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:155) + + + + + Invalid recursive reference to an abstract slot + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:946) + + + + + The module contains the field\n %s \nbut its signature specifies\n %s \nThe types differ + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:161) + + + + + The module contains the field\n %s \nbut its signature specifies\n %s \nThe 'static' modifiers differ + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:158) + + + + + The module contains the field\n %s \nbut its signature specifies\n %s \nThe names differ + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:156) + + + + + The module contains the field\n %s \nbut its signature specifies\n %s \nThe 'mutable' modifiers differ + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:159) + + + + + The module contains the field\n %s \nbut its signature specifies\n %s \nThe 'literal' modifiers differ + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:160) + + + + + The module contains the field\n %s \nbut its signature specifies\n %s \nthe accessibility specified in the signature is more than that specified in the implementation + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:157) + + + + + The exception definitions are not compatible because the exception abbreviations in the signature and implementation differ. The module contains the exception definition\n %s \nbut its signature specifies\n\t%s. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:179) + + + + + The exception definitions are not compatible because a CLI exception mapping is being hidden by a signature. The exception mapping must be visible to other modules. The module contains the exception definition\n %s \nbut its signature specifies\n\t%s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:176) + + + + + The exception definitions are not compatible because the order of the fields is different in the signature and implementation. The module contains the exception definition\n %s \nbut its signature specifies\n\t%s. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:183) + + + + + The exception definitions are not compatible because the field '%s' was required by the signature but was not specified by the implementation. The module contains the exception definition\n %s \nbut its signature specifies\n\t%s. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:181) + + + + + The exception definitions are not compatible because the field '%s' was present in the implementation but not in the signature. The module contains the exception definition\n %s \nbut its signature specifies\n\t%s. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:182) + + + + + The exception definitions are not compatible because the exception declarations differ. The module contains the exception definition\n %s \nbut its signature specifies\n\t%s. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:180) + + + + + The exception definitions are not compatible because the CLI representations differ. The module contains the exception definition\n %s \nbut its signature specifies\n\t%s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:177) + + + + + The exception definitions are not compatible because the exception abbreviation is being hidden by the signature. The abbreviation must be visible to other CLI languages. Consider making the abbreviation visible in the signature. The module contains the exception definition\n %s \nbut its signature specifies\n\t%s. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:178) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the types have different base types + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:132) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because a type representation is being hidden by a signature + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:138) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the types are of different kinds + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:139) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the signature says this type may use nulls as an extra value but the implementation does not + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:127) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the signature says this type may use nulls as a representation but the implementation does not + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:126) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the signature is an abstract class but the implementation is not. Consider adding the [<AbstractClass>] attribute to the implementation. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:131) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the signature defines the %s '%s' but the implementation does not (or does, but not in the same order) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:134) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the signature declares a %s while the implementation declares a %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:148) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the signature has an abbreviation while the implementation does not + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:151) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the representations differ + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:141) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the respective type parameter counts differ + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:121) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the number of %ss differ + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:133) + + + + + The %s definitions in the signature and implementation are not compatible because the names differ. The type is called '%s' in the signature file but '%s' in implementation. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:120) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the signature requires that the type supports the interface %s but the interface has not been implemented + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:123) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the implementation type is sealed but the signature implies it is not. Consider adding the [<Sealed>] attribute to the signature. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:128) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the implementation says this type may use nulls as an extra value but the signature does not + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:125) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the implementation says this type may use nulls as a representation but the signature does not + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:124) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the implementation type is not sealed but signature implies it is. Consider adding the [<Sealed>] attribute to the implementation. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:129) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the implementation is an abstract class but the signature is not. Consider adding the [<AbstractClass>] attribute to the signature. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:130) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the implementation defines a struct but the signature defines a type with a hidden representation + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:136) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the implementation defines the %s '%s' but the signature does not (or does, but not in the same order) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:135) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the IL representations differ + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:140) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the field %s was present in the implementation but not in the signature + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:142) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the field %s was required by the signature but was not specified by the implementation + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:144) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the order of the fields is different in the signature and implementation + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:143) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the field '%s' was present in the implementation but not in the signature. Struct types must now reveal their fields in the signature for the type, though the fields may still be labelled 'private' or 'internal'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:145) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because a CLI type representation is being hidden by a signature + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:137) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the accessibility specified in the signature is more than that specified in the implementation + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:122) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the abstract member '%s' was present in the implementation but not in the signature + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:147) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the abstract member '%s' was required by the signature but was not specified by the implementation + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:146) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because the abbreviations differ: %s versus %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:149) + + + + + The %s definitions for type '%s' in the signature and implementation are not compatible because an abbreviation is being hidden by a signature. The abbreviation must be visible to other CLI languages. Consider making the abbreviation visible in the signature. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:150) + + + + + The default value does not have the same type as the argument. The DefaultParameterValue attribute and any Optional attribute will be ignored. Note: 'null' needs to be annotated with the correct type, e.g. 'DefaultParameterValue(null:obj)'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1349) + + + + + The CallerMemberNameAttribute applied to parameter '%s' will have no effect. It is overridden by the CallerFilePathAttribute. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1344) + + + + + The argument names in the signature '%s' and implementation '%s' do not match. The argument name from the signature file will be used. This may cause problems when debugging or profiling. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/FSComp.txt:1438) + + + + + Stopped due to error\n + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:2) + + + + + Prevents references from being locked by the F# Interactive process + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:54) + + + + + If set to true, then all error messages will just return the filled 'holes' delimited by ',,,'s - this is for language-neutral testing (e.g. localization-invariant baselines). + + + + + If set to true, then all error messages will just return the filled 'holes' delimited by ',,,'s - this is for language-neutral testing (e.g. localization-invariant baselines). + + + + + Use the given file on startup as initial input + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:11) + + + + + Usage: %s <options> [script.fsx [<arguments>]] + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:3) + + + + + - Unexpected ThreadAbortException (Ctrl-C) during event handling: Trying to restart... + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:49) + + + + + --> Timing now on + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:47) + + + + + --> Timing now off + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:48) + + + + + Real: %s, CPU: %s, GC %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:26) + + + + + gen + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:27) + + + + + Treat remaining arguments as command line arguments, accessed using fsi.CommandLineArgs + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:13) + + + + + Support TAB completion in console (on by default) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:18) + + + + + Suppress fsi writing to stdout + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:17) + + + + + F# Interactive for F# %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:53) + + + + + Microsoft (R) F# Interactive version %s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:52) + + + + + - MISCELLANEOUS - + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:8) + + + + + Loading + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:38) + + + + + #load the given file on startup + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:12) + + + + + Warning: line too long, ignoring some characters\n + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:25) + + + + + - LANGUAGE - + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:7) + + + + + Invalid directive '#%s %s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:24) + + + + + '%s' is not a valid assembly name + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:22) + + + + + See '%s' for options + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:37) + + + + + F# Interactive command line options: + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:36) + + + + + F# Interactive directives: + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:29) + + + + + Toggle timing on/off + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:33) + + + + + Reference (dynamically load) the given DLL + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:30) + + + + + Exit + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:35) + + + + + Load the given file(s) as if compiled and referenced + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:32) + + + + + Display help + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:34) + + + + + Add the given search path for referenced DLLs + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:31) + + + + + \n- Interrupt\n + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:39) + + + + + - INPUT FILES - + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:4) + + + + + Display this usage message (Short form: -?) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:14) + + + + + Execute interactions on a Windows Forms event loop (on by default) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:16) + + + + + Failed to resolve assembly '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:50) + + + + + \n- Exit...\n + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:40) + + + + + Exit fsi after loading the files or running the .fsx script given on the command line + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:15) + + + + + Exception raised when starting remoting server.\n%s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:10) + + + + + \n\nException raised during pretty printing.\nPlease report this so it can be fixed.\nTrace: %s\n + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:28) + + + + + - ERRORS AND WARNINGS - + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:6) + + + + + Emit debug information in quotations + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:19) + + + + + Directory '%s' doesn't exist + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:23) + + + + + --> Referenced '%s' (an assembly with a different timestamp has already been referenced from this location, reset fsi to load the updated assembly) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:45) + + + + + --> Referenced '%s' (file may be locked by F# Interactive process) + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:44) + + + + + --> Referenced '%s' + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:43) + + + + + --> Added '%s' to library include path + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:46) + + + + + Failed to install ctrl-c handler - Ctrl-C handling will not be available. Error was:\n\t%s + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:42) + + + + + A problem occurred starting the F# Interactive process. This may be due to a known problem with background process console support for Unicode-enabled applications on some Windows systems. Try selecting Tools->Options->F# Interactive for Visual Studio and enter '--fsi-server-no-unicode'. + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:21) + + + + + - CODE GENERATION - + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:5) + + + + + Binding session to '%s'... + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:51) + + + + + For help type #help;; + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:20) + + + + + - ADVANCED - + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:9) + + + + + - Aborting main thread... + (Originally from /Users/chethusk/oss/FSharp.Compiler.Service/fcs/FSharp.Compiler.Service/../../src/fsharp/fsi/FSIstrings.txt:41) + + + + + Call this method once to validate that all known resources are valid; throws if not + + + + + This operation is O(n) anyway, so executing ToList() here is OK + + + + + This operation is O(1), unless a push happens, which is rare. + + + + + Iterable functional collection with O(1) append-1 time. Useful for data structures where elements get added at the + end but the collection must occasionally be iterated. Iteration is slower and may allocate because + a suffix of elements is stored in reverse order. + + The type doesn't support structural hashing or comparison. + + + + + A record of options to control structural formatting. + For F# Interactive properties matching those of this value can be accessed via the 'fsi' + value. + + Floating Point format given in the same format accepted by System.Double.ToString, + e.g. f6 or g15. + + If ShowProperties is set the printing process will evaluate properties of the values being + displayed. This may cause additional computation. + + The ShowIEnumerable is set the printing process will force the evaluation of IEnumerable objects + to a small, finite depth, as determined by the printing parameters. + This may lead to additional computation being performed during printing. + + <example> + From F# Interactive the default settings can be adjusted using, for example, + <pre> + open FSharp.Compiler.Interactive.Settings;; + setPrintWidth 120;; + </pre> + </example> + + + + + The maximum number of rows for which to generate layout for table-like + structures. -1 if no maximum. + + + + + The maximum number of elements for which to generate layout for + list-like structures, or columns in table-like + structures. -1 if no maximum. + + + + + Return to the layout-generation + environment to layout any otherwise uninterpreted object + + + + + Data representing structured layouts of terms. The representation + of this data type is only for the consumption of formatting engines. + + + + + Data representing joints in structured layouts of terms. The representation + of this data type is only for the consumption of formatting engines. + + + + + Convert any value to a layout using the given formatting options. The + layout can then be processed using formatting display engines such as + those in the LayoutOps module. any_to_string and output_any are + built using any_to_layout with default format options. + + + + + Output any value to a channel using the same set of formatting rules + as any_to_string + + + + + Convert any value to a string using a standard formatter + Data is typically formatted in a structured format, e.g. + lists are formatted using the "[1;2]" notation. + The details of the format are not specified and may change + from version to version and according to the flags given + to the F# compiler. The format is intended to be human-readable, + not machine readable. If alternative generic formats are required + you should develop your own formatter, using the code in the + implementation of this file as a starting point. + + Data from other .NET languages is formatted using a virtual + call to Object.ToString() on the boxed version of the input. + + + + + For limiting layout of list-like sequences (lists,arrays,etc). + unfold a list of items using (project and z) making layout list via itemL. + If reach maxLength (before exhausting) then truncate. + + + + + See tagL + + + + + Layout like an F# list. + + + + + Layout like an F# option. + + + + + Layout list vertically. + + + + + Layout two vertically. + + + + + Form tuple of layouts. + + + + + Wrap braces around layout. + + + + + Wrap square brackets around layout. + + + + + Wrap round brackets around Layout. + + + + + Join layouts into a list separated using the given Layout. + + + + + Join layouts into a semi-colon separated list. + + + + + Join layouts into a space separated list. + + + + + Join layouts into a comma separated list. + + + + + Join broken with ident=2 + + + + + Join broken with ident=1 + + + + + Join broken with ident=0 + + + + + Join, possible break with indent=2 + + + + + Join, possible break with indent=1 + + + + + Join, possible break with indent=0 + + + + + Join, unbreakable. + + + + + An string which is left parenthesis (no space on the right). + + + + + An string which is right parenthesis (no space on the left). + + + + + An string which requires no spaces either side. + + + + + An string leaf + + + + + An uninterpreted leaf, to be interpreted into a string + by the layout engine. This allows leaf layouts for numbers, strings and + other atoms to be customized according to culture. + + + + + Is it the empty layout? + + + + + The empty layout + + + + + A layout is a sequence of strings which have been joined together. + The strings are classified as words, separators and left and right parenthesis. + This classification determines where spaces are inserted. + A joint is either unbreakable, breakable or broken. + If a joint is broken the RHS layout occurs on the next line with optional indentation. + A layout can be squashed to for given width which forces breaks as required. + + + + + Interpret tables for a unicode lexer generated by <c>fslex.exe</c>. + + + + + Create the tables from raw data + + + + + The type of tables for an unicode lexer generated by <c>fslex.exe</c>. + + + + + The start position for the lexeme. + + + + + True if the refill of the buffer ever failed , or if explicitly set to True. + + + + + The end position for the lexeme. + + + + + The start position for the lexeme. + + + + + The matched string. + + + + + True if the refill of the buffer ever failed , or if explicitly set to True. + + + + + The end position for the lexeme. + + + + + Dynamically typed, non-lexically scoped parameter table. + + + + + Fast helper to turn the matched characters into a string, avoiding an intermediate array. + + + + + Create a lex buffer backed by source text. + + + + + Create a lex buffer that reads character or byte inputs by using the given function. + + + + + Create a lex buffer suitable for Unicode lexing that reads characters from the given array. + Important: does take ownership of the array. + + + + + Input buffers consumed by lexers generated by <c>fslex.exe</c>. + The type must be generic to match the code generated by FsLex and FsYacc (if you would like to + fix this, please submit a PR to the FsLexYacc repository allowing for optional emit of a non-generic type reference). + + + + + Return absolute offset of the start of the line marked by the position. + + + + + The character number in the input stream. + + + + + The line number for the position in the input stream, assuming fresh positions have been updated + using for the new line. + + + + + The line number in the input stream, assuming fresh positions have been updated + for the new line by modifying the EndPos property of the LexBuffer. + + + + + The file index for the file associated with the input stream, use <c>fileOfFileIndex</c> in range.fs to decode + + + + + Given a position just beyond the end of a line, return a position at the start of the next line. + + + + + Get an arbitrary position, with the empty string as filename. + + + + + Same line, column -1. + + + + + Return the column number marked by the position, + i.e. the difference between the <c>AbsoluteOffset</c> and the <c>StartOfLineAbsoluteOffset</c> + + + + + Gives a position shifted by specified number of characters. + + + + + Given a position at the start of a token of length n, return a position just beyond the end of the token. + + + + + Apply a #line directive. + + + + + Position information stored for lexing tokens + + + + + The tag of the error terminal. + + + + + The total number of terminals. + + + + + This function is used to hold the user specified "parse_error" or "parse_error_rich" functions. + + + + + This table is logically part of the Goto table. + + + + + The sparse table offsets for the productions active for each state. + + + + + The sparse table for the productions active for each state. + + + + + The sparse goto table row offsets. + + + + + The sparse goto table. + + + + + The immediate action table. + + + + + The number of symbols for each reduction. + + + + + The sparse action table row offsets. + + + + + The sparse action table elements. + + + + + A function to compute the data carried by a token. + + + + + A function to compute the tag of a token. + + + + + The token number indicating the end of input. + + + + + The reduction table. + + + + + Interpret the parser table taking input from the given lexer, using the given lex buffer, and the given start state. + Returns an object indicating the final synthesized value for the parse. + + + + + Tables generated by fsyacc + The type of the tables contained in a file produced by the <c>fsyacc.exe</c> parser generator. + + + + + The stack of state indexes active at the parse error . + + + + + The token that would cause a shift at the parse error. + + + + + The stack of productions that would be reduced at the parse error. + + + + + The tokens that would cause a reduction at the parse error. + + + + + The state active at the parse error. + + + + + The message associated with the parse error. + + + + + The token that caused the parse error. + + + + + The context provided when a parse error occurs. + + + + + Get the start of the range of positions matched by the production. + + + + + Get the full range of positions matched by the production. + + + + + Get the end of the range of positions matched by the production. + + + + + Return the LexBuffer for this parser instance. + + + + + Raise an error in this parse context. + + + + + Get the start position for the terminal or non-terminal at a given index matched by the production. + + + + + Get the start and end position for the terminal or non-terminal at a given index matched by the production. + + + + + Get the end position for the terminal or non-terminal at a given index matched by the production. + + + + + Get the value produced by the terminal or non-terminal at the given position. + + + + + Indicates a parse error has occurred and parse recovery is in progress. + + + + + Indicates an accept action has occurred. + + + + + The default implementation of the parse_error function. + + + + + The default implementation of the parse_error_rich function. + + + + + Helpers used by generated parsers. + + + + + Map a directory name with its replacement. + Prefixes are compared case sensitively. + + + + + Map a file path with its replacement. + Prefixes are compared case sensitively. + + + + + Add a path mapping to the map. + + + + + Split an array of pairs into two arrays. + + + + + Combine the two arrays into an array of pairs. The two arrays must have equal lengths, otherwise an <c>ArgumentException</c> is + raised.. + + + + + Return the index of the first element in the array + that satisfies the given predicate. + + + + + Return the index of the first element in the array + that satisfies the given predicate. + + + + + Return an array containing the given element. + + + + + Like <c>foldBack</c>, but return both the intermediary and final results. + + + + + Like <c>fold</c>, but return the intermediary and final results. + + + + + Build a new collection whose elements are the results of applying the given function + to the corresponding elements of the two collections pairwise. The two input + arrays must have the same lengths, otherwise an <c>ArgumentException</c> is + raised. + + + + + Apply the given function to pair of elements drawn from matching indices in two arrays, + also passing the index of the elements. The two arrays must have the same lengths, + otherwise an <c>ArgumentException</c> is raised. + + + + + Return True if the given array is empty, otherwise False. + + + + + Test elements of the two arrays pairwise to see if all pairs of elements satisfy the given predicate. + Raise <c>ArgumentException</c> if the arrays have different lengths. + + + + + Apply a function to pairs of elements drawn from the two collections, right-to-left, + threading an accumulator argument through the computation. The two input + arrays must have the same lengths, otherwise an <c>ArgumentException</c> is + raised. + + + + + Apply a function to pairs of elements drawn from the two collections, + left-to-right, threading an accumulator argument + through the computation. The two input + arrays must have the same lengths, otherwise an <c>ArgumentException</c> is + raised. + + + + + Apply a function to each element of the array, threading an accumulator argument + through the computation. If the input function is <c>f</c> and the elements are <c>i0...iN</c> then + computes <c>f i0 (...(f iN-1 iN))</c>. Raises ArgumentException if the array has size zero. + + + + + Apply a function to each element of the array, threading an accumulator argument + through the computation. If the input function is <c>f</c> and the elements are <c>i0...iN</c> + then computes <c>f (... (f i0 i1)...) iN</c>. Raises ArgumentException if the array has size zero. + + + + + Return the index of the first element in the array + that satisfies the given predicate. Raise <c>KeyNotFoundException</c> if + none of the elements satisfy the predicate. + + + + + Return the index of the first element in the array + that satisfies the given predicate. Raise <c>KeyNotFoundException</c> if + none of the elements satisfy the predicate. + + + + + Test elements of the two arrays pairwise to see if any pair of element satisfies the given predicate. + Raise ArgumentException if the arrays have different lengths. + + + + + Return a view of the array as an enumerable object. + + + + + Build a <c>ResizeArray</c> from the given elements. + + + + + Return a fixed-length array containing the elements of the input <c>ResizeArray</c>. + + + + + Sort the elements using the key extractor and generic comparison on the keys. + + + + + Sort the elements using the given comparison function. + + + + + Return a new array with the elements in reverse order. + + + + + Apply the given function to successive elements, returning the first + result where function returns Some(x) for some x. + + + + + Return the first element for which the given function returns True. + Return None if no such element exists. + + + + + Return the first element for which the given function returns True. + Raise <c>KeyNotFoundException</c> if no such element exists. + + + + + Apply the given function to each element of the array. Return + the array comprised of the results "x" for each element where + the function returns <c>Some(x)</c>. + + + + + Split the collection into two collections, containing the + elements for which the given predicate returns True and False + respectively. + + + + + Return a new collection containing only the elements of the collection + for which the given predicate returns True. + + + + + Test if all elements of the array satisfy the given predicate. + If the input function is <c>f</c> and the elements are <c>i0...iN</c> and "j0...jN" + then computes <c>p i0 && ... && p iN</c>. + + + + + Test if any element of the array satisfies the given predicate. + If the input function is <c>f</c> and the elements are <c>i0...iN</c> + then computes <c>p i0 or ... or p iN</c>. + + + + + Build a new array whose elements are the results of applying the given function + to each of the elements of the array. The integer index passed to the + function indicates the index of element being transformed. + + + + + Apply the given function to each element of the array. The integer passed to the + function indicates the index of element. + + + + + Build a new collection whose elements are the results of applying the given function + to the corresponding elements of the two collections pairwise. The two input + arrays must have the same lengths. + + + + + Apply the given function to two arrays simultaneously. The + two arrays must have the same lengths, otherwise an Invalid_argument exception is + raised. + + + + + Build a new array whose elements are the results of applying the given function + to each of the elements of the array. + + + + + Apply the given function to each element of the array. + + + + + Apply a function to each element of the array, threading an accumulator argument + through the computation. If the input function is <c>f</c> and the elements are <c>i0...iN</c> then + computes <c>f i0 (...(f iN s))</c>. + + + + + Apply a function to each element of the collection, threading an accumulator argument + through the computation. If the input function is <c>f</c> and the elements are <c>i0...iN</c> + then computes <c>f (... (f s i0)...) iN</c> + + + + + Build an array from the given list. + + + + + Build a list from the given array. + + + + + Read a range of elements from the first array and write them into the second. + + + + + Fill a range of the collection with the given element. + + + + + Build a new array that contains the elements of the given array. + + + + + Build a new array that contains the given subrange specified by + starting index and length. + + + + + Build a new array that contains the elements of each of the given list of arrays. + + + + + Build a new array that contains the elements of the first array followed by the elements of the second array. + + + + + Create an array by calling the given generator on each index. + + + + + Create an array whose elements are all initially the given value. + + + + + Set the value of an element in the collection. You can also use the syntax <c>arr.[idx] <- e</c>. + + + + + Fetch an element from the collection. You can also use the syntax <c>arr.[idx]</c>. + + + + + Return the length of the collection. You can also use property <c>arr.Length</c>. + + + + + Generic operations on the type System.Collections.Generic.List, which is called ResizeArray in the F# libraries. + + + + + Calculates the edit distance between two strings. + The edit distance is a metric that allows to measure the amount of difference between two strings + and shows how many edit operations (insert, delete, substitution) are needed to transform one string into the other. + + + + + Computes the restricted Damerau-Levenstein edit distance, + also known as the "optimal string alignment" distance. + - read more at https://en.wikipedia.org/wiki/Damerau%E2%80%93Levenshtein_distance + - Implementation taken from http://www.navision-blog.de/2008/11/01/damerau-levenshtein-distance-in-fsharp-part-ii/ + + + + + Calculates the Jaro-Winkler edit distance between two strings. + The edit distance is a metric that allows to measure the amount of similarity between two strings. + + + + + Given an offset and a radius from that offset, does mChar exist in that part of str? + + + + + Functions to compute the edit distance between two strings + + + + + Trim the quotes and spaces from either end of a string + + + + + Get the filename without extension of the given path. + + + + + Get the filename of the given path. + + + + + Return True if the filename has a "." extension. + + + + + "directoryName" " decomposes a filename into a directory name. + + + + chopExtension f removes the extension from the given + filename. Raises ArgumentException if no extension is present. + + + checkSuffix f s returns True if filename "f" ends in suffix "s", + e.g. checkSuffix "abc.fs" ".fs" returns true. + + + + Some filename operations. + + + + + Lookup or set the given element in the table. Set replaces all existing bindings for a value with a single + bindings. Raise <c>KeyNotFoundException</c> if the element is not found. + + + + + Lookup or set the given element in the table. Set replaces all existing bindings for a value with a single + bindings. Raise <c>KeyNotFoundException</c> if the element is not found. + + + + + The total number of keys in the hash table. + + + + + Lookup the given element in the table, returning the result as an Option. + + + + + Replace the latest binding if any for the given element. + + + + + Remove the latest binding if any for the given element from the table. + + + + + Apply the given function to each binding in the hash table. + + + + + Apply the given function to each element in the collection threading the accumulating parameter + through the sequence of function applications. + + + + + Find all bindings for the given element in the table, if any. + + + + + Make a shallow copy of the collection. + + + + + Test if the collection contains any bindings for the given element. + + + + + Clear all elements from the collection. + + + + + Add a binding for the element to the table. + + + + + Build a map that contains the bindings of the given IEnumerable. + + + + + Create a new empty mutable HashMultiMap with an internal bucket array of the given approximate size + and with the given key hash/equality functions. + + + + + Create a new empty mutable HashMultiMap with the given key hash/equality functions. + + + + + Hash tables, by default based on F# structural "hash" and (=) functions. + The table may map a single key to multiple bindings. + + + + + Get the value for the given key or <c>None</c> if not still valid. + + + + + Get the value for the given key or None, but only if entry is still valid + + + + + Set the given key. + + + + + Resize + + + + + Remove the given value from the mru cache. + + + + + Get the similar (subsumable) value for the given key or <c>None</c> if not already available. + + + + + Clear out the cache. + + + + + Simple priority caching for a small number of key/value associations. + This cache may age-out results that have been Set by the caller. + Because of this, the caller must be able to tolerate values + that aren't what was originally passed to the Set function. + + Concurrency: This collection is thread-safe, though concurrent use may result in different + threads seeing different live sets of cached items, and may result in the onDiscard action + being called multiple times. In practice this means the collection is only safe for concurrent + access if there is no discard action to execute. + + - areSimilar: Keep at most once association for two similar keys (as given by areSimilar) + + + + + Lookup the value without making it the most recent. + Returns the original key value because the areSame function + may have unified two different keys. + + + + + Lookup a value and make it the most recent. + Returns the original key value because the areSame function + may have unified two different keys. + + + + + Lookup a value and make it the most recent. Return <c>None</c> if it wasn't there. + + + + + Resize + + + + + Remove the given value from the collection. + + + + + Add an element to the collection. Make it the most recent. + + + + + Remove all elements. + + + + + Simple aging lookup table. When a member is accessed it's + moved to the top of the list and when there are too many elements + the least-recently-accessed element falls of the end. + + - areSimilar: Keep at most once association for two similar keys (as given by areSimilar) + + + + + Lookup an element in the map. Raise <c>KeyNotFoundException</c> if no binding + exists in the map. + + + + + Return True if there are no bindings in the map. + + + + + The number of bindings in the map. + + + + + Lookup an element in the map, returning a Some value if the element is in the domain + of the map and None if not. + + + + + The elements of the set as a list. + + + + + The elements of the set as an array. + + + + + Remove an element from the domain of the map. No exception is raised if the element is not present. + + + + + Build two new maps, one containing the bindings for which the given predicate returns True, + and another for the remaining bindings. + + + + + Build a new collection whose elements are the results of applying the given function + to each of the elements of the collection. + + + + + Build a new collection whose elements are the results of applying the given function + to each of the elements of the collection. The index passed to the + function indicates the index of element being transformed. + + + + + Apply the given function to each binding in the dictionary. + + + + + Return True if the given predicate returns true for all of the + bindings in the map. Always returns true if the map is empty. + + + + + Given the start and end points of a key range, + Fold over the bindings in the map that are in the range, + and the end points are included if present (the range is considered a closed interval). + + + + + Fold over the bindings in the map. + + + + + Fold over the bindings in the map. + + + + + Search the map looking for the first element where the given function returns a Some value. + + + + + Build a new map containing the bindings for which the given predicate returns True. + + + + + Return True if the given predicate returns true for one of the + bindings in the map. Always returns false if the map is empty. + + + + + The empty map, and use the given comparer comparison function for all operations associated + with any maps built from this map. + + + + + Build a map that contains the bindings of the given <c>IEnumerable</c> + and where comparison of elements is based on the given comparison function. + + + + + Test is an element is in the domain of the map. + + + + + Return a new map with the binding added to the given map. + + + + + Immutable maps. A constraint tag carries information about the class of key-comparers being used. + + + + + Return a new set with the elements of the second set removed from the first. + + + + + Compute the union of the two sets. + + + + + Returns the lowest element in the set according to the ordering being used for the set. + + + + + Returns the highest element in the set according to the ordering being used for the set. + + + + + A useful shortcut for <c>Set.isEmpty</c>. See the <c>Set</c> module for further operations on sets. + + + + + Return the number of elements in the set. + + + + + The number of elements in the set. + + + + + Compute the union of the two sets. + + + + + The elements of the set as a list. + + + + + The elements of the set as an array. + + + + + A singleton set based on the given comparison operator. + + + + + A useful shortcut for <c>Set.remove</c>. Note this operation produces a new set + and does not mutate the original set. The new set will share many storage + nodes with the original. See the <c>Set</c> module for further operations on sets. + + + + + Build two new sets, one containing the elements for which the given predicate returns True, + and another with the remaining elements. + + + + + Apply the given function to each binding in the collection. + + + + + Evaluates to True if all elements of the first set are in the second. + + + + + Evaluates to True if all elements of the second set are in the first. + + + + + Compute the intersection of the two sets. + + + + + Test if all elements of the collection satisfy the given predicate. + If the input function is f and the elements are i0...iN and j0...jN then + computes p i0 && ... && p iN. + + + + + Apply the given accumulating function to all the elements of the set. + + + + + Return a new collection containing only the elements of the collection + for which the given predicate returns True. + + + + + Test if any element of the collection satisfies the given predicate. + If the input function is f and the elements are i0...iN then computes + p i0 or ... or p iN. + + + + + Compares two sets and returns True if they are equal or False otherwise. + + + + + The empty set based on the given comparer. + + + + + Return a new set with the elements of the second set removed from the first. + + + + + A set based on the given comparer containing the given initial elements. + + + + + A useful shortcut for <c>Set.contains</c>. See the <c>Set</c> module for further operations on sets. + + + + + Compares a and b and returns 1 if a > b, -1 if b < a and 0 if a = b. + + + + + A useful shortcut for <c>Set.add</c>. Note this operation produces a new set + and does not mutate the original set. The new set will share many storage + nodes with the original. See the <c>Set</c> module for further operations on sets. + + + + + Immutable sets where a constraint tag carries information about the class of key-comparer being used. + + + + + The F# version reported in the banner + + + + + Convert string into Option string where null and String.Empty result in None + + + + + Test to report for the name of the type provider that produced the value + + + + + The ILScopeRef of the runtime assembly reference for type provider that produced the value + + + + + A type provider that produced the value + + + + + Apply an operation and 'untaint' the result. This can be used if the return type + is guaranteed not to be implemented by a type provider + + + + + Apply an operation and 'untaint' the result. The result must be marshallable. Any exception will be attributed to the type provider with an error located at the given range + + + + + Apply an operation. Any exception will be attributed to the type provider with an error located at the given range + + + + + Apply an operation that returns an option. Unwrap option. Any exception will be attributed to the type provider with an error located at the given range + + + + + Apply an operation. No exception may be raised by 'f' + + + + + Apply an operation that returns an array. Unwrap array. Any exception will be attributed to the type provider with an error located at the given range. String is method name of thing-returning-array, to diagnostically attribute if it is null + + + + + Apply an operation. Any exception will be attributed to the type provider with an error located at the given range + + + + + Apply an operation. Any exception will be attributed to the type provider with an error located at the given range + + + + + Apply an operation. Any exception will be attributed to the type provider with an error located at the given range + + + + + Apply an operation. Any exception will be attributed to the type provider with an error located at the given range + + + + + Conditionally coerce the value + + + + + Create an initial tainted value + + + + + Assert that the value is of 'U and coerce the value. + If coercion fails, the failure will be blamed on a type provider + + + + + This struct wraps a value produced by a type provider to properly attribute any failures. + + + + + creates new instance of TypeProviderError with specified type\method names + + + + + creates new instance of TypeProviderError based on current instance information(message) + + + + + provides uniform way to process aggregated errors + + + + + creates new instance of TypeProviderError that represents collection of errors + + + + + creates new instance of TypeProviderError that represents one error + + + + + Stores and transports aggregated list of errors reported by the type provider + + + + + A name generator used by IlxGen for static fields, some generated arguments and other things. + REVIEW: this will mean the hosted compiler service is not deterministic. We should at least create a new one + of these for each compilation. + + + + + A global generator of stable compiler generated names + + + + + A global generator of compiler generated names + + + + + Generates compiler-generated names marked up with a source code location, but if given the same unique value then + return precisely the same name. Each name generated also includes the StartLine number of the range passed in + at the point of first generation. + + This type may be accessed concurrently, though in practice it is only used from the compilation thread. + It is made concurrency-safe since a global instance of the type is allocated in tast.fs. + + + + + Generates compiler-generated names. Each name generated also includes the StartLine number of the range passed in + at the point of first generation. + + This type may be accessed concurrently, though in practice it is only used from the compilation thread. + It is made concurrency-safe since a global instance of the type is allocated in tast.fs, and it is good + policy to make all globally-allocated objects concurrency safe in case future versions of the compiler + are used to host multiple concurrent instances of compilation. + + + + + The TcConfig passed in to the builder creation. + + + + + The full set of source files including those from options + + + + + Raised just after the whole project has finished type checking. At this point, accessing the + overall analysis results for the project will be quick. + + + + + Raised when a type provider invalidates the build. + + + + + Raised just after a file is parsed + + + + + Raised just after a file is checked + + + + + Raised just before a file is type-checked, to invalidate the state of the file in VS and force VS to request a new direct typecheck of the file. + The incremental builder also typechecks the file (error and intellisense results from the background builder are not + used by VS). + + + + + The list of files the build depends on + + + + + Tries to get the current successful TcImports. This is only used in testing. Do not use it for other stuff. + + + + + Perform one step in the F# build. Return true if the background work is finished. + + + + + Await the untyped parse results for a particular slot in the vector of parse results. + + This may be a marginally long-running operation (parses are relatively quick, only one file needs to be parsed) + + + + + Get the logical time stamp that is associated with the output of the project if it were gully built immediately + + + + + Get the preceding typecheck state of a slot, without checking if it is up-to-date w.r.t. + the timestamps on files and referenced DLLs prior to this one. Return None if the result is not available. + This is a very quick operation. + + This is safe for use from non-compiler threads but the objects returned must in many cases be accessed only from the compiler thread. + + + + + Get the preceding typecheck state of a slot. Compute the entire type check of the project up + to the necessary point if the result is not available. This may be a long-running operation. + + + + + + Get the final typecheck result. If 'generateTypedImplFiles' was set on Create then the TypedAssemblyAfterOptimization will contain implementations. + This may be a long-running operation. + + + + + + Get the typecheck result after the end of the last file. The typecheck of the project is not 'completed'. + This may be a long-running operation. + + + + + + Get the typecheck state after checking a file. Compute the entire type check of the project up + to the necessary point if the result is not available. This may be a long-running operation. + + + + + + Get the preceding typecheck state of a slot, but only if it is up-to-date w.r.t. + the timestamps on files and referenced DLLs prior to this one. Return None if the result is not available. + This is a relatively quick operation. + + This is safe for use from non-compiler threads + + + + + Manages an incremental build graph for the build of an F# project + + + + + Represents latest inferred signature contents. + + + + + Represents latest complete typechecked implementation file, including its typechecked signature if any. + Empty for a signature file. + + + + + Represents the collected attributes to apply to the module of assuembly generates + + + + + Disambiguation table for module names + + + + + Represents open declarations + + + + + Represents the collected uses of symbols from type checking + + + + + Represents the collected name resolutions from type checking + + + + + Represents the collected errors from type checking + + + + + This field is None if a major unrecovered error occurred when preparing the initial state + + + + + This field is None if a major unrecovered error occurred when preparing the initial state + + + + + Represents the state in the incremental graph associated with checking a file + + + + + Lookup the global static cache for building the FrameworkTcImports + + + + + Position of the last dot. + + + + + The column number at the end of full partial name. + + + + + Last part of long ident. + + + + + Qualifying idents, prior to the last dot, not including the last part. + + + + + Empty patial long name. + + + + + Qualified long name. + + + + + is this the developer-debug build? + + + + + Get the result and Commit(...). + + + + + Get the reified result. + + + + + When using .NET 4.0 you can replace this type by <see cref="Task{T}"/> + + + + + Represents the reified result of an asynchronous computation. + + + + + Treat a list of key-value pairs as a lookup collection. + This function looks up a value based on a match from the supplied + predicate function and returns None if value does not exist. + + + + + Treat a list of key-value pairs as a lookup collection. + This function looks up a value based on a match from the supplied + predicate function. + + + + + Throw <c>System.ArgumentNullException()</c> if string argument is <c>null</c>. + Throw <c>System.ArgumentOutOfRangeException()</c> is string argument is empty. + + + + + Throw <c>System.ArgumentNullException()</c> if array argument is <c>null</c>. + Throw <c>System.ArgumentOutOfRangeException()</c> is array argument is empty. + + + + + Throw <c>System.ArgumentNullException()</c> if argument is <c>null</c>. + + + + + Throw <c>System.InvalidOperationException()</c> if argument is <c>None</c>. + If there is a value (e.g. <c>Some(value)</c>) then value is returned. + + + + + Rational arithmetic, used for exponents on units-of-measure + + + + + Represents a range using zero-based line counting (used by Visual Studio) + + + + + Represents a position using zero-based line counting (used by Visual Studio) + + + + + Represents a line number when using zero-based line counting (used by Visual Studio) + + + + + The range where all values are zero + + + + + The empty range that is located at the start position of the range + + + + + The start line of the range + + + + + The start column of the range + + + + + The start position of the range + + + + + Synthetic marks ranges which are produced by intermediate compilation phases. This + bit signifies that the range covers something that should not be visible to language + service operations like dot-completion. + + + + + The file name for the file of the range + + + + + The file index for the range + + + + + The empty range that is located at the end position of the range + + + + + The line number for the end position of the range + + + + + The column number for the end position of the range + + + + + The end position of the range + + + + + Convert a range to string + + + + + Convert a range to be synthetic + + + + + Represents a range within a known file + + + + + The line number for the position + + + + + The maximum number of bits needed to store an encoded position + + + + + The encoding of the position as a 64-bit integer + + + + + The column number for the position + + + + + Decode a position fro a 64-bit integer + + + + + Represents a position in a file + + + + + An index into a global tables of filenames + + + + + Convert a range to a string + + + + + Convert a position to a string + + + + + A range associated with a dummy file for the command line arguments + + + + + A range associated with a dummy file called "startup" + + + + + The zero range + + + + + The zero position + + + + + Make a dummy range for a file + + + + + Test to see if a range occurs fully before a position + + + + + Test to see if a range contains a position + + + + + Test to see if one range contains another range + + + + + Union two ranges, taking their first occurring start position and last occurring end position + + + + + Compare positions for greater-than-or-equal-to + + + + + Compare positions for equality + + + + + Compare positions for greater-than + + + + + Compare positions for less-than + + + + + Output a range + + + + + Output a position + + + + + not a total order, but enough to sort on ranges + + + + + Reduce a range so it only covers a line + + + + + This view hides the use of file indexes and just uses filenames + + + + + This view of range marks uses file indexes explicitly + + + + + Ordering on positions + + + + + Create a position for the given line and column + + + + + Convert an index into a file path + + + + + Convert a file path to an index + + + + + Convert a range from one-based line counting (used internally in the F# compiler and in F# error messages) to zero-based line counting (used by Visual Studio) + + + + + Convert a range from one-based line counting (used internally in the F# compiler and in F# error messages) to zero-based line counting (used by Visual Studio) + + + + + Convert a position from one-based line counting (used internally in the F# compiler and in F# error messages) to zero-based line counting (used by Visual Studio) + + + + + Convert a position from zero-based line counting (used by Visual Studio) to one-based line counting (used internally in the F# compiler and in F# error messages) + + + + + Convert a line number from one-based line counting (used internally in the F# compiler and in F# error messages) to zero-based line counting (used by Visual Studio) + + + + + Convert a line number from zero-based line counting (used by Visual Studio) to one-based line counting (used internally in the F# compiler and in F# error messages) + + + + + Type holds thread-static globals for use by the compile. + + + + + This is the textual subcategory to display in error and warning messages (shows only under --vserrors): + + file1.fs(72): subcategory warning FS0072: This is a warning message + + + + + + Return true if the textual phase given is from the compile part of the build process. + This set needs to be equal to the set of subcategories that the language service can produce. + + + + + the language service knows about. + + + + + Construct a phased error + + + + + Closed enumeration of build phases. + + + + + Represents the style being used to format errors + + + + + fixes given string by replacing all control chars with spaces. + NOTE: newlines are recognized and replaced with stringThatIsAProxyForANewlineInFlatErrors (ASCII 29, the 'group separator'), + which is decoded by the IDE with 'NewlineifyErrorString' back into newlines, so that multi-line errors can be displayed in QuickInfo + + + + + Keep the warnings, propagate the error to the exception continuation. + + + + + Stop on first error. Accumulate warnings and continue. + + + + + Stop on first error. Report index + + + + + Stop on first error. Accumulate warnings and continue. + + + + + Stop on first error. Accumulate warnings and continue. + + + + + The bind in the monad. Stop on first error. Accumulate warnings and continue. + + + + + Simulates an error. For test purposes only. + + + + + Raises a special exception and returns 'T - can be caught later at an errorRecovery point. + + + + + Raises a warning with error recovery and returns unit. + + + + + Raises an exception with error recovery and returns unit. + + + + + NOTE: The change will be undone when the returned "unwind" object disposes + + + + + NOTE: The change will be undone when the returned "unwind" object disposes + + + + + Thrown when we stop processing the F# Interactive entry or #load. + + + + + Thrown when immediate, local error recovery is not possible. This indicates + we've reported an error but need to make a non-local transfer of control. + Error recovery may catch this and continue (see 'errorRecovery') + + The exception that caused the report is carried as data because in some + situations (LazyWithContext) we may need to re-report the original error + when a lazy thunk is re-evaluated. + + + + + Thrown when we want to add some range information to a .NET exception + + + + + Reraise an exception if it is one we want to report to Watson. + + + + + Instruct the exception not to reset itself when thrown again. + + + + + Literal build phase subcategory strings. + + + + + Demangles a suggestion + + + + + We report a candidate if its edit distance is <= the threshold. + The threshold is set to about a quarter of the number of characters. + + + + + Functions to format error message details + + + + + Get the Reference Assemblies directory for the .NET Framework (on Windows) + This is added to the default resolution path for + design-time compilations. + + + + + Perform assembly resolution on the given references under the given conditions + + + + + Get the "v4.5.1"-style moniker for the highest installed .NET Framework version. + This is the value passed back to Resolve if no explicit "mscorlib" has been given. + + Note: If an explicit "mscorlib" is given, then --noframework is being used, and the whole ReferenceResolver logic is essentially + unused. However in the future an option may be added to allow an explicit specification of + a .NET Framework version to use for scripts. + + + + + Round-tripped baggage + + + + + Prepare textual information about where the assembly was resolved from, used for tooltip output + + + + + Item specification. + + + + + Indicates a script or source being dynamically compiled and executed. Uses implementation assemblies. + + + + + Indicates a script or source being edited or compiled. Uses reference assemblies (not implementation assemblies). + + + + + Mangle the static parameters for a provided type or method + + + + + Mangle the static parameters for a provided type or method + + + + + Demangle the static parameters + + + + + Determines if the specified name is a valid name for an active pattern. + + + + + Return a string array delimited by the given separator up to the maximum number. + Note that a quoted string is not going to be mangled into pieces. + + + + + Return a string array delimited by the given separator. + Note that a quoted string is not going to be mangled into pieces. + + + + + Try to chop "get_" or "set_" from a string. + If the string does not start with "get_" or "set_", this function raises an exception. + + + + + Try to chop "get_" or "set_" from a string + + + + + Is this character a part of a long identifier? + + + + + The characters that are allowed to be in an identifier. + + + + + The characters that are allowed to be the first character of an identifier. + + + + + Decompiles a mangled operator name back into an operator. + For example, "op_DereferencePercent" becomes "!%". + This function accepts mangled names for both built-in and custom operators. + + + + + Decompiles the mangled name of a custom operator back into an operator. + For example, "op_DereferencePercent" becomes "!%". + This function should only be used for mangled names of custom operators + if a mangled name potentially represents a built-in operator, + use the 'DecompileOpName' function instead. + + + + + Compiles an operator into a mangled operator name. + For example, "!%" becomes "op_DereferencePercent". + This function accepts both built-in and custom operators. + + + + + Compiles a custom operator into a mangled operator name. + For example, "!%" becomes "op_DereferencePercent". + This function should only be used for custom operators + if an operator is or potentially may be a built-in operator, + use the 'CompileOpName' function instead. + + + + + Returns `true` if given string is an operator display name, e.g. ( |>> ) + + + + + Returns `true` if given string is an operator or double backticked name, e.g. ( |>> ) or ( long identifier ). + (where ( long identifier ) is the display name for ``long identifier``). + + + + + The set of characters usable in custom operators. + + + + + Prefix for compiled (mangled) operator names. + + + + + Anything to do with special names of identifiers and other lexical rules + + + + + Diagnostics from the AbsIL toolkit. You can reset the diagnostics + stream to point elsewhere, or turn it + off altogether by setting it to 'None'. The logging channel initially + points to stderr. All functions call flush() automatically. + + REVIEW: review if we should just switch to System.Diagnostics + + + + + A utility type provided for completeness + + + + + A utility type provided for completeness + + + + + Decompose a type definition according to its kind. + + + + + Helpers for codegen: scopes for allocating new temporary variables. + + + + + A table of common references to items in primary assembly (System.Runtime or mscorlib). + If a particular version of System.Runtime.dll has been loaded then you should + reference items from it via an ILGlobals for that specific version built using mkILGlobals. + + + + + e.g. win86 resources, as the exact contents of a .res or .obj file. Must be unlinked manually. + + + + + One module in the "current" assembly, either a main-module or + an auxiliary module. The main module will have a manifest. + + An assembly is built by joining together a "main" module plus + several auxiliary modules. + + + + + Represents a native resource to be written in an output file + + + + + Represents a native resource to be read from the PE file + + + + + Records whether the entrypoint resides in another module. + + + + + Records the types implemented by this assembly in auxiliary + modules. + + + + + This is the public key used to sign this + assembly (the signature itself is stored elsewhere: see the + binary format, and may not have been written if delay signing + is used). (member Name, member PublicKey) forms the full + public name of the assembly. + + + + + This is the ID of the algorithm used for the hashes of auxiliary + files in the assembly. These hashes are stored in the + <c>ILModuleRef.Hash</c> fields of this assembly. These are not + cryptographic hashes: they are simple file hashes. The algorithm + is normally <c>0x00008004</c> indicating the SHA1 hash algorithm. + + + + + The main module of an assembly is a module plus some manifest information. + + + + + Table of resources in a module. + + + + + Read the bytes from a resource local to an assembly. Will fail for non-local resources. + + + + + "Manifest ILResources" are chunks of resource data, being one of: + - the data section of the current module (byte[] of resource given directly). + - in an external file in this assembly (offset given in the ILResourceLocation field). + - as a resources in another assembly of the same name. + + + + + Represents a manifest resource in a different assembly + + + + + Represents a manifest resource in an associated file + + + + + Represents a manifest resource that is due to be written to the output PE file + + + + + Represents a manifest resource that can be read from within the PE file + + + + + [Namespace.]Name + + + + + these are only found in the ILExportedTypesAndForwarders table in the manifest + + + + + these are only found in the "Nested" field of ILExportedTypeOrForwarder objects + + + + + Realise the actual full typedef + + + + + Represents a prefix of information for ILTypeDef. + + The information is enough to perform name resolution for the F# compiler, probe attributes + for ExtensionAttribute etc. This is key to the on-demand exploration of .NET metadata. + This information has to be "Goldilocks" - not too much, not too little, just right. + + + + + Class or interface generated for COM interop. + + + + + Some classes are marked "HasSecurity" even if there are no permissions attached, + e.g. if they use SuppressUnmanagedCodeSecurityAttribute + + + + + Functional update + + + + + Functional creation of a value, immediate + + + + + Functional creation of a value, using delayed reading via a metadata index, for ilread.fs + + + + + Represents IL Type Definitions. + + + + + Get some information about the type defs, but do not force the read of the type defs themselves. + + + + + Calls to <c>FindByName</c> will result in any laziness in the overall + set of ILTypeDefs being read in in addition + to the details for the type found, but the remaining individual + type definitions will not be read. + + + + + Tables of named type definitions. + + + + + A categorization of type definitions into "kinds" + + + + + Type Access. + + + + + Default Unicode encoding for P/Invoke within a type. + + + + + Indicate the initialization semantics of a type. + + + + + Type Layout information. + + + + + Method Impls + + + + + Table of properties in an IL type definition. + + + + + Functional update of the value + + + + + Functional creation of a value, immediate + + + + + Functional creation of a value, using delayed reading via a metadata index, for ilread.fs + + + + + Property definitions + + + + + Table of those events in a type definition. + + + + + Functional update of the value + + + + + Functional creation of a value, immediate + + + + + Functional creation of a value, using delayed reading via a metadata index, for ilread.fs + + + + + Event definitions. + + + + + Tables of fields. Logically equivalent to a list of fields but the table is kept in + a form to allow efficient looking up fields by name. + + + + + The explicit offset in bytes when explicit layout is used. + + + + + Functional update of the value + + + + + Functional creation of a value, immediate + + + + + Functional creation of a value using delayed reading via a metadata index + + + + + Field definitions. + + + + + Tables of methods. Logically equivalent to a list of methods but + the table is kept in a form optimized for looking up methods by + name and arity. + + + + + Indicates an instance methods that is virtual or abstract or implements an interface slot. + + + + + The method is exported to unmanaged code using COM interop. + + + + + Indicates a static method. + + + + + Indicates this is an instance methods that is not virtual. + + + + + SafeHandle finalizer must be run. + + + + + Indicates a .ctor method. + + + + + Indicates a .cctor method. + + + + + Some methods are marked "HasSecurity" even if there are no permissions attached, e.g. if they use SuppressUnmanagedCodeSecurityAttribute + + + + + Functional update of the value + + + + + Functional creation of a value, immediate + + + + + Functional creation of a value, with delayed reading of some elements via a metadata index + + + + + IL Method definitions. + + + + + Do not use this + + + + + Do not use this + + + + + Indicates the type argument must have a public nullary constructor. + + + + + Indicates the type argument must be a value type, but not Nullable. + + + + + Indicates the type argument must be a reference type. + + + + + Variance of type parameters, only applicable to generic parameters for generic interfaces and delegates. + + + + + At most one is the parent type, the others are interface types. + + + + + Generic parameters. Formal generic parameter declarations may include the bounds, if any, on the generic parameter. + + + + + [OverridesSpec] - refer to a method declaration in a superclass or interface. + + + + + PInvoke attributes. + + + + + Represents the efficiency-oriented storage of ILSecurityDecls in another item. + + + + + Abstract type equivalent to ILSecurityDecl list - use helpers + below to construct/destruct these. + + + + + Method return values. + + + + + Marshalling map for parameters. COM Interop only. + + + + + Method parameters and return values. + + + + + Represents the efficiency-oriented storage of ILAttributes in another item. + + + + + Attribute with args in decoded form. + + + + + Attribute with args encoded to a binary blob according to ECMA-335 II.21 and II.23.3. + 'decodeILAttribData' is used to parse the byte[] blob to ILAttribElem's as best as possible. + + + + + Attribute instance constructor. + + + + + Decoded arguments. May be empty in encoded attribute form. + + + + + Custom attribute. + + + + + Named args: values and flags indicating if they are fields or properties. + + + + + Represents a custom attribute parameter of type 'string'. These may be null, in which case they are encoded in a special + way as indicated by Ecma-335 Partition II. + + + + + Member Access + + + + + IL method bodies + + + + + Local variables + + + + + optional idx of parameter giving size plus optional additive i.e. num elems + + + + + Native Types, for marshalling to the native C interface. + These are taken directly from the ILASM syntax, see ECMA Spec (Partition II, 7.4). + + + + + Field Init + + + + + Indicates that a particular local variable has a particular source + language name within a given set of ranges. This does not effect local + variable numbering, which is global over the whole method. + + + + + The instruction set. + + + + + ILCode labels. In structured code each code label refers to a basic block somewhere in the code of the method. + + + + + Field specs. The data given for a ldfld, stfld etc. instruction. + + + + + Functional creation + + + + + The information at the callsite of a method + + + + + Formal identities of fields. + + + + + Functional creation + + + + + Formal identities of methods. + + + + + Actual generic parameters are always types. + + + + + Custom modifiers. + + + + + Reference a generic arg. + + + + + ILCode pointers. + + + + + Managed pointers. + + + + + Unmanaged pointers. Nb. the type is used by tools and for binding only, not by the verifier. + + + + + Reference types. Also may be used for parents of members even if for members in value types. + + + + + Unboxed types, including builtin types. + + + + + Array types + + + + + Used only in return and pointer types. + + + + + The type being modified. + + + + + Which type is being referred to? + + + + + Where is the type, i.e. is it in this module, in another module in this assembly or in another assembly? + + + + + The name of the type. This also contains the namespace if Enclosing is empty. + + + + + The type instantiation if the type is generic, otherwise empty + + + + + The name of the type in the assembly using the '.' notation for nested types. + + + + + The list of enclosing type names for a nested type. If non-nil then the first of these also contains the namespace. + + + + + Create an ILTypeSpec. + + + + + Type specs and types. + + + + + Where is the type, i.e. is it in this module, in another module in this assembly or in another assembly? + + + + + The name of the type. This also contains the namespace if Enclosing is empty. + + + + + The name of the type in the assembly using the '.' notation for nested types. + + + + + The list of enclosing type names for a nested type. If non-nil then the first of these also contains the namespace. + + + + + The name of the type in the assembly using the '+' notation for nested types. + + + + + Create a ILTypeRef. + + + + + Type refs, i.e. references to types in some .NET assembly + + + + + Bounds for a single dimensional, zero based array + + + + + Lower-bound/size pairs + + + + + Array shapes. For most purposes the rank is the only thing that matters. + + + + + no 'this' pointer is passed + + + + + accepts an explicit 'this' pointer + + + + + accepts an implicit 'this' pointer + + + + + A reference to a type in another assembly + + + + + A reference to a type in a module in the same assembly + + + + + A reference to the type in the current module + + + + + CLI says this indicates if the assembly can be retargeted (at runtime) to be from a different publisher. + + + + + The fully qualified name of the assembly reference, e.g. mscorlib, Version=1.0.3705 etc. + + + + + Debug info. Values of type "source" can be attached at sequence + points and some other locations. + + + + + Represents guids + + + + + Find the full set of assemblies referenced by a module. + + + + + Get a version number from a CLR version string, e.g. 1.0.3705.0 + + + + + Get a public key token from a public key. + + + + + Discriminating different important built-in types. + + + + + This is a 'vendor neutral' way of referencing mscorlib. + + + + + Instantiate type variables that occur within types and other items. + + + + + Instantiate type variables that occur within types and other items. + + + + + Unscoping. Clears every scope information, use for looking up IL method references only. + + + + + Rescoping. The first argument tells the function how to reference the original scope from + the new scope. + + + + + Rescoping. The first argument tells the function how to reference the original scope from + the new scope. + + + + + Rescoping. The first argument tells the function how to reference the original scope from + the new scope. + + + + + Rescoping. The first argument tells the function how to reference the original scope from + the new scope. + + + + + Rescoping. The first argument tells the function how to reference the original scope from + the new scope. + + + + + Generate references to existing type definitions, method definitions + etc. Useful for generating references, e.g. to a class we're processing + Also used to reference type definitions that we've generated. [ILScopeRef] + is normally ILScopeRef.Local, unless we've generated the ILTypeDef in + an auxiliary module or are generating multiple assemblies at + once. + + + + + Making modules. + + + + + Create table of types which is loaded/computed on-demand, and whose individual + elements are also loaded/computed on-demand. Any call to tdefs.AsList will + result in the laziness being forced. Operations can examine the + custom attributes and name of each type in order to decide whether + to proceed with examining the other details of the type. + + Note that individual type definitions may contain further delays + in their method, field and other tables. + + + + + Making tables of custom attributes, etc. + + + + + The toplevel "class" for a module or assembly. + + + + + Given a delegate type definition which lies in a particular scope, + make a reference to its constructor. + + + + + Derived functions for making some simple constructors + + + + + Injecting initialization code into a class. + Add some code to the end of the .cctor for a type. Create a .cctor + if one doesn't exist already. + + + + + Injecting code into existing code blocks. A branch will + be added from the given instructions to the (unique) entry of + the code, and the first instruction will be the new entry + of the method. The instructions should be non-branching. + + + + + Make a type definition for a value type used to point to raw data. + These are useful when generating array initialization code + according to the + ldtoken field valuetype '<PrivateImplementationDetails>'/'$$struct0x6000127-1' '<PrivateImplementationDetails>'::'$$method0x6000127-1' + call void System.Runtime.CompilerServices.RuntimeHelpers::InitializeArray(class System.Array,valuetype System.RuntimeFieldHandle) + idiom. + + + + + Make a type definition. + + + + + Make field definitions. + + + + + Make method definitions. + + + + + Make a formal generic parameters. + + + + + Derived functions for making return, parameter and local variable + objects for use in method definitions. + + + + + Derived functions for making some common patterns of instructions. + + + + + Make some code that is a straight line sequence of instructions. + The function will add a "return" if the last instruction is not an exiting instruction. + + + + + Making code. + + + + + Make custom attributes. + + + + + Make generalized versions of possibly-generic types, e.g. Given the ILTypeDef for List, return the type "List<T>". + + + + + Construct references to fields. + + + + + Construct references to constructors. + + + + + Construct references to static, non-generic methods. + + + + + Construct references to static methods. + + + + + Construct references to instance methods. + + + + + Construct references to instance methods. + + + + + Construct references to methods on a given type . + + + + + Make method references and specs. + + + + + Make types. + + + + + Make type specs. + + + + + Make type refs. + + + + + Generate simple references to assemblies and modules. + + + + + Not all custom attribute data can be decoded without binding types. In particular + enums must be bound in order to discover the size of the underlying integer. + The following assumes enums have size int32. + + + + + When writing a binary the fake "toplevel" type definition (called <Module>) + must come first. This function puts it first, and creates it in the returned + list as an empty typedef if it doesn't already exist. + + + + + Build the table of commonly used references given functions to find types in system assemblies + + + + splitTypeNameRight is like splitILTypeName except the + namespace is kept as a whole string, rather than split at dots. + + + + The <c>splitILTypeName</c> utility helps you split a string representing + a type name into the leading namespace elements (if any), the + names of any nested types and the type name itself. This function + memoizes and interns the splitting of the namespace portion of + the type name. + + + + + Find the method definition corresponding to the given property or + event operation. These are always in the same class as the property + or event. This is useful especially if your code is not using the Ilbind + API to bind references. + + + + + The "unlinked" view of .NET metadata and code. Central to the Abstract IL library + + + + + Printer for the abstract syntax. + + + + + Morph all type references throughout an entire module. + + + + + Morph each scope reference inside a type signature. + + + + + A set of "IL rewrites" ("morphs"). These map each sub-construct + of particular ILTypeDefs. The morphing functions are passed + some details about the context in which the item being + morphed occurs, e.g. the module being morphed itself, the + ILTypeDef (possibly nested) where the item occurs, + the ILMethodDef (if any) where the item occurs. etc. + + + + + Maps with a specific comparison function + + + + + Sets with a specific comparison function + + + + + Imperative buffers and streams of byte[] + + + + + Immutable map collection, with explicit flattening to a backing dictionary + + + + + Can the specified object be tested for equality? + + + + + Interface that defines methods for comparing objects using partial equality relation + + + + + A helper to ensure we rethrow the "original" exception + + + + + This field holds either the function to run or a LazyWithContextFailure object recording the exception raised + from running the function. It is null if the thunk has been evaluated successfully. + + + + + This field holds the result of a successful computation. It's initial value is Unchecked.defaultof + + + + + Just like "Lazy" but EVERY forcer must provide an instance of "ctxt", e.g. to help track errors + on forcing back to at least one sensible user location + + + + + memoize tables (all entries cached, never collected) + + + + + Generates unique stamps + + + + + Computations that can cooperatively yield by returning a continuation + + - Any yield of a NotYetDone should typically be "abandonable" without adverse consequences. No resource release + will be called when the computation is abandoned. + + - Computations suspend via a NotYetDone may use local state (mutables), where these are + captured by the NotYetDone closure. Computations do not need to be restartable. + + - The key thing is that you can take an Eventually value and run it with + Eventually.repeatedlyProgressUntilDoneOrTimeShareOverOrCanceled + + - Cancellation results in a suspended computation rather than complete abandonment + + + + + Represents a cancellable computation with explicit representation of a cancelled result. + + A cancellable computation is passed may be cancelled via a CancellationToken, which is propagated implicitly. + If cancellation occurs, it is propagated as data rather than by raising an OperationCanceledException. + + + + + Encapsulates a lock associated with a particular token-type representing the acquisition of that lock. + + + + + A base type for various types of tokens that must be passed when a lock is taken. + Each different static lock should declare a new subtype of this type. + + + + + Represents a token that indicates execution on a any of several potential user threads calling the F# compiler services. + + + + + Represents a token that indicates execution on the compilation thread, i.e. + - we have full access to the (partially mutable) TAST and TcImports data structures + - compiler execution may result in type provider invocations when resolving types and members + - we can access various caches in the SourceCodeServices + + Like other execution tokens this should be passed via argument passing and not captured/stored beyond + the lifetime of stack-based calls. This is not checked, it is a discipline within the compiler code. + + + + + Represents a permission active at this point in execution + + + + + An efficient lazy for inline storage in a class type. Results in fewer thunks. + + + + + Get an initialization hole + + + + + Represents a place in the compiler codebase where we assume we are executing on a compilation thread + + + + + Represents a place in the compiler codebase where we are passed a CompilationThreadToken unnecessarily. + This reprents code that may potentially not need to be executed on the compilation thread. + + + + + Represents a place where we are stating that execution on the compilation thread is required. The + reason why will be documented in a comment in the code at the callsite. + + + + + Per the docs the threshold for the Large Object Heap is 85000 bytes: https://docs.microsoft.com/en-us/dotnet/standard/garbage-collection/large-object-heap#how-an-object-ends-up-on-the-large-object-heap-and-how-gc-handles-them + We set the limit to slightly under that to allow for some 'slop' + + + + + Returns true if the list contains exactly 1 element. Otherwise false. + + + + + Returns true if the list has less than 2 elements. Otherwise false. + + + + + A shim over File.Exists + + + + + A shim over File.ReadAllBytes + + + + + Used to determine if a file will not be subject to deletion during the lifetime of a typical client process. + + + + + A shim over Path.IsPathRooted + + + + + A shim over Path.IsInvalidPath + + + + + A shim over Path.GetTempPath + + + + + Utc time of the last modification + + + + + Take in a filename with an absolute path, and return the same filename + but canonicalized with respect to extra path separators (e.g. C:\\\\foo.txt) + and '..' portions + + + + + A shim over FileStream with FileMode.Open, FileAccess.Write, FileShare.Read + + + + + A shim over FileStream with FileMode.Open, FileAccess.Read, FileShare.ReadWrite + + + + + A shim over FileStream with FileMode.Create, FileAccess.Write, FileShare.Read + + + + + A shim over File.Delete + + + + + Used to load type providers and located assemblies in F# Interactive + + + + + Used to load a dependency for F# Interactive and in an unused corner-case of type provider loading + + + + + For every entry in m2 find an entry in m1 and fold + + + + + Union entries by identical key, using the provided function to union sets of values + + + + + Not a very useful function - only called in one place - should be changed + + + + + Intern tables to save space. + + + + + Keep running the asynchronous computation bit by bit. The runner gets called each time the computation is restarted. + Can be cancelled as an Async in the normal way. + + + + + Keep running the computation bit by bit until a time limit is reached. + The runner gets called each time the computation is restarted + + If cancellation happens, the operation is left half-complete, ready to resume. + + + + + Implement try/with for a cancellable computation + + + + + Implement try/finally for a cancellable computation + + + + + Catch exceptions in a computation + + + + + Represents a canceled computation + + + + + Bind the cancellation token associated with the computation + + + + + Run the computation in a mode where it may not be cancelled. The computation never results in a + ValueOrCancelled.Cancelled. + + + + + Delay a cancellable computation + + + + + Iterate a cancellable computation over a collection + + + + + Fold a cancellable computation along a sequence of inputs + + + + + Return a simple value as the result of a cancellable computation + + + + + Map the result of a cancellable computation + + + + + Bind the result of a cancellable computation + + + + + Run a cancellable computation using the given cancellation token + + + + + Splits a string into substrings based on the strings in the array separators + + + + + Remove all trailing and leading whitespace from the string + return null if the string is null + + + + + chunk the provided input into arrays that are smaller than the LOH limit + in order to prevent long-term storage of those values + + + + + Split a large ResizeArray into a series of array chunks that are each under the Large Object Heap limit. + This is done to help prevent a stop-the-world collection of the single large array, instead allowing for a greater + probability of smaller collections. Stop-the-world is still possible, just less likely. + + + + + Split a ResizeArray into an array of smaller chunks. + This requires `items/chunkSize` Array copies of length `chunkSize` if `items/chunkSize % 0 = 0`, + otherwise `items/chunkSize + 1` Array copies. + + + + + Returns true if one array has trailing elements equal to another's. + + + + + Returns true if one array has another as its subset from index 0. + + + + + check if subArray is found in the wholeArray starting + at the provided index + + + + + Returns all heads of a given array. + For [|1;2;3|] it returns [|[|1; 2; 3|]; [|1; 2|]; [|1|]|] + + + + + Optimized arrays equality. ~100x faster than `array1 = array2` on strings. + ~2x faster for floats + ~0.8x slower for ints + + + + + Returns a new array with an element replaced with a given value. + + + + + Async implementation of Array.map. + + + + + pass an array byref to reverse it in place + + + + + each int will be 0 <= x <= 255 + + + + + each int must be 0 <= x <= 255 + + + + + returned int will be 0 <= x <= 255 + + + + + Various constants and utilities used when parsing the ILASM format for IL + + + + + PDB reader and associated types + + + + + Unmanaged resource file linker - for native resources (not managed ones). + The function may be called twice, once with a zero-RVA and + arbitrary buffer, and once with the real buffer. The size of the + required buffer is returned. + + + + + Functions associated with writing binaries which + vary between supported implementations of the CLI Common Language + Runtime, e.g. between the SSCLI, Mono and the Microsoft CLR. + + The implementation of the functions can be found in ilsupp-*.fs + + + + + vararg sentinels + + + + + This function maps production indexes returned in syntax errors to strings representing the non terminal that would be produced by that production + + + + + Compiler use only. Code and constants shared between binary reader/writer. + + + + + Represents a reader of the metadata of a .NET binary. May also give some values (e.g. IL code) from the PE file + if it was provided. + + + + + A function to call to try to get an object that acts as a snapshot of the metadata section of a .NET binary, + and from which we can read the metadata. Only used when metadataOnly=true. + + + + + Only open a metadata reader for the metadata portion of the .NET binary without keeping alive any data associated with the PE reader + - IL code will not be available (mdBody in ILMethodDef will return NotAvailable) + - Managed resources will be reported back as ILResourceLocation.LocalIn (as always) + - Native resources will not be available (none will be returned) + - Static data associated with fields will not be available + + + + + Used to implement a Binary file over native memory, used by Roslyn integration + + + + + Open a binary reader based on the given bytes. + + + + + Open a binary reader, except first copy the entire contents of the binary into + memory, close the file and ensure any subsequent reads happen from the in-memory store. + PDB files may not be read with this option. + + + + + Binary reader. Read a .NET binary and concert it to Abstract IL data + structures. + + NOTE: + - The metadata in the loaded modules will be relative to + those modules, e.g. ILScopeRef.Local will mean "local to + that module". You must use [rescopeILType] etc. if you want to include + (i.e. copy) the metadata into your own module. + + - PDB (debug info) reading/folding: + The PDB reader is invoked if you give a PDB path + This indicates if you want to search for PDB files and have the + reader fold them in. You cannot currently name the pdb file + directly - you can only name the path. Giving "None" says + "do not read the PDB file even if one exists". + + The debug info appears primarily as I_seqpoint annotations in + the instruction streams. Unfortunately the PDB information does + not, for example, tell you how to map back from a class definition + to a source code line number - you will need to explicitly search + for a sequence point in the code for one of the methods of the + class. That is not particularly satisfactory, and it may be + a good idea to build a small library which extracts the information + you need. + + + + + the local index the name corresponds to + + + + + 28 is the size of the IMAGE_DEBUG_DIRECTORY in ntimage.h + + + + + Takes the output file name and returns debug file name. + + + + + The ILPdbWriter + + + + + Write a binary to the file system. Extra configuration parameters can also be specified. + + + + + The IL Binary writer. + + + + + The (local) emitter env (state). Some of these fields are effectively global accumulators + and could be placed as hash tables in the global environment. + + + + + The global environment. + + + + + Emit the tail. prefix if necessary + + + + + Emit the align. prefix + + + + + Emit the volatile. prefix + + + + +Emit comparison instructions. + + + + + convConstructorSpec (like convMethodSpec) + + + + + Get a constructor on a non-TypeBuilder type + + + + + Uses the .CreateType() for emitted type if available. + + + + + Uses TypeBuilder/TypeBuilderInstantiation for emitted types. + + + + + Convert an Abstract IL type reference to Reflection.Emit System.Type value. + + + + + Debug info for generated code for classunions. + + + + + Generate the helpers? + + + + + Are the representation helpers public? + + + + + Is the representation public? + + + + + IlxClosureApps - i.e. types being applied at a callsite. + + + + + The name used for the field in parameter or IL field position. + + + + + ILX extensions to Abstract IL types and instructions F# + + + + + Scope references for FSharp.Core.dll + + + + + Compiler use only. Erase closures + + + + + Used to emit instructions (an interface to the IlxGen.fs code generator) + + + + + Emit the instruction sequence for a "switchdata" operation + + + + + Emit the instruction sequence for a "lddatatag" operation + + + + + Emit the instruction sequence for a "castdata" operation + + + + + Make the IL type for a union type alternative + + + + + Make the type definition for a union type + + + + + Make the instruction sequence for a "brisnotdata" operation + + + + + Make the instruction sequence for a "stdata" operation + + + + + Make the instruction sequence for a "lddataa" operation + + + + + Make the instruction sequence for a "lddata" operation + + + + + Make the instruction sequence for a "isdata" operation + + + + + Make the instruction sequence for a "newdata" operation + + + + + render a Layout yielding an 'a using a 'b (hidden state) type + + + + + Primitive renders + + + + + Run a render on a Layout + + + + + The parser defines a number of tokens for whitespace and + comments eliminated by the lexer. These carry a specification of + a continuation for the lexer for continued processing after we've dealt with + the whitespace. + + + + + Specifies how the 'endline' function in the lexer should continue after + it reaches end of line or eof. The options are to continue with 'token' function + or to continue with 'skip' function. + + + + + The syntactic elements associated with the "return" of a function or method. Some of this is + mostly dummy information to make the return element look like an argument, + the important thing is that (a) you can give a return type for the function or method, and + (b) you can associate .NET attributes to return of a function or method and these get stored in .NET metadata. + + + + + QualifiedNameOfFile acts to fully-qualify module specifications and implementations, + most importantly the ones that simply contribute fragments to a namespace (i.e. the ParsedSigFileFragment.NamespaceFragment case) + There may be multiple such fragments in a single assembly. There may thus also + be multiple matching pairs of these in an assembly, all contributing types to the same + namespace. + + + + + SynMemberDefn.AutoProperty (attribs, isStatic, id, tyOpt, propKind, memberFlags, xmlDoc, access, synExpr, mGetSet, mWholeAutoProp). + + F# syntax: 'member val X = expr' + + + + + A feature that is not implemented + + + + + LetBindings(bindingList, isStatic, isRecursive, wholeRange) + + localDefns + + + + + inherit <typ>(args...) as base + + + + + implicit ctor args as a defn line, 'as' specification + + + + + 'exception E = ... with ...' + + + + + 'exception E = ... ' + + + + + The names and other metadata for the type parameters for a member or function + + + + + The argument names and other metadata for a parameter for a member or function + + + + + SynValInfo(curriedArgInfos, returnInfo) + + + + + The argument names and other metadata for a member or function + + + + + The untyped, unchecked syntax tree associated with the name of a type definition or module + in signature or implementation. + + This includes the name, attributes, type parameters, constraints, documentation and accessibility + for a type definition or module. For modules, entries such as the type parameters are + always empty. + + + + + The untyped, unchecked syntax tree for a field declaration in a record or class + + + + + The information for a type definition in a signature + + + + + The untyped, unchecked syntax tree for a type definition in a signature + + + + + Indicates the right right-hand-side is a record, union or other simple type. + + + + + Indicates the right right-hand-side is a class, struct, interface or other object-model type + + + + + The untyped, unchecked syntax tree for the right-hand-side of a type definition in a signature. + Note: in practice, using a discriminated union to make a distinction between + "simple" types and "object oriented" types is not particularly useful. + + + + + Full type spec given by 'UnionCase: ty1 * tyN -> rty'. Only used in FSharp.Core, otherwise a warning. + + + + + Normal style declaration + + + + + The untyped, unchecked syntax tree for the right-hand-side of union definition, excluding members, + in either a signature or implementation. + + + + + The untyped, unchecked syntax tree for one case in a union definition. + + + + + The untyped, unchecked syntax tree for one case in an enum definition. + + + + + An exception definition, "exception E = ..." + + + + + An abstract definition, "type X" + + + + + A type abbreviation, "type X = A.B.C" + + + + + A type defined by using an IL assembly representation. Only used in FSharp.Core. + + F# syntax: "type X = (# "..."#) + + + + + An object oriented type definition. This is not a parse-tree form, but represents the core + type representation which the type checker splits out from the "ObjectModel" cases of type definitions. + + + + + A record type definition, type X = { A: int; B: int } + + + + + An enum type definition, type X = A = 1 | B = 2 + + + + + A union type definition, type X = A | B + + + + + The untyped, unchecked syntax tree for the core of a simple type definition, in either signature + or implementation. + + + + + The untyped, unchecked syntax tree for a member signature, used in signature files, abstract member declarations + and member constraints. + + + + + An artificial member kind used prior to the point where a get/set property is split into two distinct members. + + + + + Note the member kind is actually computed partially by a syntax tree transformation in tc.fs + + + + + Is this attribute being applied to a property getter or setter? + + + + + Target specifier, e.g. "assembly", "module", etc. + + + + + List of attributes enclosed in [< ... >]. + + + + + A pattern arising from a parse error + + + + + Used internally in the type checker + + + + + Deprecated character range: ranges + + + + + &lt;@ expr @&gt;, used for active pattern arguments + + + + + ':? type ' + + + + + '?id' -- for optional argument names + + + + + 'null' + + + + + Represents a simple set of variable bindings a, (a, b) or (a: Type, b: Type) at a lambda, + function definition or other binding point, after the elimination of pattern matching + from the construct, e.g. after changing a "function pat1 -> rule1 | ..." to a + "fun v -> match v with ..." + + + + + We have decided to use an alternative name in tha pattern and related expression + + + + + We have not decided to use an alternative name in tha pattern and related expression + + + + + Id (ident, altNameRefCell, isCompilerGenerated, isThisVar, isOptArg, range) + + Indicates a simple pattern variable. + + altNameRefCell + Normally 'None' except for some compiler-generated variables in desugaring pattern matching. + Pattern processing sets this reference for hidden variable introduced by desugaring pattern matching in arguments. + The info indicates an alternative (compiler generated) identifier to be used because the name of the identifier is already bound. + See Product Studio FSharp 1.0, bug 6389. + + isCompilerGenerated: true if a compiler generated name + isThisVar: true if 'this' variable in member + isOptArg: true if a '?' is in front of the name + + + + + 'use x = fixed expr' + + + + + Inserted for error recovery when there is "expr." and missing tokens or error recovery after the dot + + + + + Inserted for error recovery + + + + + Inserted for error recovery + + + + + Only used in FSharp.Core + + + + + Only used in FSharp.Core + + + + + Only used in FSharp.Core + + + + + Only used in FSharp.Core + + + + + F# syntax: do! expr + Computation expressions only + + + + + F# syntax: match! expr with pat1 -> expr | ... | patN -> exprN + + + + + SynExpr.LetOrUseBang (spBind, isUse, isFromSource, pat, rhsExpr, bodyExpr, mWholeExpr). + + F# syntax: let! pat = expr in expr + F# syntax: use! pat = expr in expr + Computation expressions only + + + + + F# syntax: yield! expr + F# syntax: return! expr + Computation expressions only + + + + + F# syntax: yield expr + F# syntax: return expr + Computation expressions only + + + + + F# syntax: <implicit> + Computation expressions only, implied by final "do" or "do!" + + + + + F# syntax: ... in ... + Computation expressions only, based on JOIN_IN token from lex filter + + + + + F# syntax: ((typar1 or ... or typarN): (member-dig) expr) + + + + + F# syntax: &expr, &&expr + + + + + F# syntax: null + + + + + F# syntax: downcast expr + + + + + F# syntax: upcast expr + + + + + F# syntax: expr :?> type + + + + + F# syntax: expr :> type + + + + + F# syntax: expr :? type + + + + + F# syntax: Expr.Items (e1) <- e2, rarely used named-property-setter notation, e.g. (stringExpr).Chars(3) <- 'a' + + + + + F# syntax: Type.Items(e1) <- e2, rarely used named-property-setter notation, e.g. Foo.Bar.Chars(3) <- 'a' + + + + + DotIndexedSet (objectExpr, indexExprs, valueExpr, rangeOfLeftOfSet, rangeOfDot, rangeOfWholeExpr) + + F# syntax: expr.[expr, ..., expr] <- expr + + + + + F# syntax: expr.[expr, ..., expr] + + + + + F# syntax: expr <- expr + + + + + F# syntax: expr.ident...ident <- expr + + + + + DotGet(expr, rangeOfDot, lid, wholeRange) + + F# syntax: expr.ident.ident + + + + + F# syntax: ident.ident...ident <- expr + + + + + F# syntax: ident.ident...ident + LongIdent(isOptional, longIdent, altNameRefCell, m) + isOptional: true if preceded by a '?' for an optional named parameter + altNameRefCell: Normally 'None' except for some compiler-generated variables in desugaring pattern matching. See SynSimplePat.Id + + + + + F# syntax: ident + Optimized representation, = SynExpr.LongIdent (false, [id], id.idRange) + + + + + IfThenElse(exprGuard, exprThen, optionalExprElse, spIfToThen, isFromErrorRecovery, mIfToThen, mIfToEndOfLastBranch) + + F# syntax: if expr then expr + F# syntax: if expr then expr else expr + + + + + Seq(seqPoint, isTrueSeq, e1, e2, m) + isTrueSeq: false indicates "let v = a in b; v" + + F# syntax: expr; expr + + + + + F# syntax: lazy expr + + + + + F# syntax: try expr finally expr + + + + + F# syntax: try expr with pat -> expr + + + + + LetOrUse(isRecursive, isUse, bindings, body, wholeRange) + + F# syntax: let pat = expr in expr + F# syntax: let f pat1 .. patN = expr in expr + F# syntax: let rec f pat1 .. patN = expr in expr + F# syntax: use pat = expr in expr + + + + + TypeApp(expr, mLessThan, types, mCommas, mGreaterThan, mTypeArgs, mWholeExpr) + "mCommas" are the ranges for interstitial commas, these only matter for parsing/design-time tooling, the typechecker may munge/discard them + + F# syntax: expr<type1, ..., typeN> + + + + + App(exprAtomicFlag, isInfix, funcExpr, argExpr, m) + - exprAtomicFlag: indicates if the application is syntactically atomic, e.g. f.[1] is atomic, but 'f x' is not + - isInfix is true for the first app of an infix operator, e.g. 1+2 becomes App(App(+, 1), 2), where the inner node is marked isInfix + (or more generally, for higher operator fixities, if App(x, y) is such that y comes before x in the source code, then the node is marked isInfix=true) + + F# syntax: f x + + + + + F# syntax: assert expr + + + + + F# syntax: do expr + + + + + F# syntax: match expr with pat1 -> expr | ... | patN -> exprN + + + + + F# syntax: function pat1 -> expr | ... | patN -> exprN + + + + + First bool indicates if lambda originates from a method. Patterns here are always "simple" + Second bool indicates if this is a "later" part of an iterated sequence of lambdas + + F# syntax: fun pat -> expr + + + + + CompExpr(isArrayOrList, isNotNakedRefCell, expr) + + F# syntax: { expr } + + + + + F# syntax: [ expr ], [| expr |] + + + + + SynExpr.ForEach (spBind, seqExprOnly, isFromSource, pat, enumExpr, bodyExpr, mWholeExpr). + + F# syntax: 'for ... in ... do ...' + + + + + F# syntax: 'for i = ... to ... do ...' + + + + + F# syntax: 'while ... do ...' + + + + + SynExpr.ObjExpr (objTy, argOpt, binds, extraImpls, mNewExpr, mWholeExpr) + + F# syntax: { new ... with ... } + + + + + F# syntax: new C(...) + The flag is true if known to be 'family' ('protected') scope + + + + + F# syntax: { f1=e1; ...; fn=en } + SynExpr.Record ((baseType, baseCtorArgs, mBaseCtor, sepAfterBase, mInherits), (copyExpr, sepAfterCopyExpr), (recordFieldName, fieldValue, sepAfterField), mWholeExpr) + inherit includes location of separator (for tooling) + copyOpt contains range of the following WITH part (for tooling) + every field includes range of separator after the field (for tooling) + + + + + F# syntax: [ e1; ...; en ], [| e1; ...; en |] + + + + + F# syntax: {| id1=e1; ...; idN=eN |} + F# syntax: struct {| id1=e1; ...; idN=eN |} + + + + + F# syntax: e1, ..., eN + + + + + F# syntax: expr: type + + + + + F# syntax: 1, 1.3, () etc. + + + + + F# syntax: <@ expr @>, <@@ expr @@> + + Quote(operator, isRaw, quotedSynExpr, isFromQueryExpression, m) + + + + + F# syntax: (expr) + + Paren(expr, leftParenRange, rightParenRange, wholeRangeIncludingParentheses) + + Parenthesized expressions. Kept in AST to distinguish A.M((x, y)) + from A.M(x, y), among other things. + + + + + range ignoring any (parse error) extra trailing dots + + + + + Attempt to get the range of the first token or initial portion only - this is extremely ad-hoc, just a cheap way to improve a certain 'query custom operation' error range + + + + + Get the syntactic range of source code covered by this construct. + + + + + F# syntax: ident=1 etc., used in static parameters to type providers + + + + + F# syntax: const expr, used in static parameters to type providers + + + + + F# syntax: 1, "abc" etc, used in parameters to type providers + For the dimensionless units i.e. 1, and static parameters to provided types + + + + + F# syntax: for units of measure e.g. m^3, kg^1/2 + + + + + F# syntax: for units of measure e.g. m / s + + + + + F# syntax: #type + + + + + F# syntax: typ with constraints + + + + + F# syntax: _ + + + + + F# syntax: 'Var + + + + + F# syntax: type -> type + + + + + F# syntax: type[] + + + + + F# syntax: {| id: type; ...; id: type |} + F# syntax: struct {| id: type; ...; id: type |} + + + + + F# syntax: type * ... * type + F# syntax: struct (type * ... * type) + + + + + LongIdentApp(typeName, longId, LESSm, tyArgs, commasm, GREATERm, wholem) + + F# syntax: type.A.B.C<type, ..., type> + commasm: ranges for interstitial commas, these only matter for parsing/design-time tooling, the typechecker may munge/discard them + + + + + App(typeName, LESSm, typeArgs, commasm, GREATERm, isPostfix, m) + + F# syntax: type<type, ..., type> or type type or (type, ..., type) type + isPostfix: indicates a postfix type application e.g. "int list" or "(int, string) dict" + commasm: ranges for interstitial commas, these only matter for parsing/design-time tooling, the typechecker may munge/discard them + + + + + F# syntax: A.B.C + + + + + Get the syntactic range of source code covered by this construct. + + + + + The unchecked abstract syntax tree of F# types + + + + + F# syntax is 'typar: delegate<'Args, unit> + + + + + F# syntax is 'typar: enum<'UnderlyingType> + + + + + F# syntax is ^T: (static member MemberName: ^T * int -> ^T) + + + + + F# syntax is 'typar :> type + + + + + F# syntax is default ^T: type + + + + + F# syntax is 'typar: equality + + + + + F# syntax is 'typar: comparison + + + + + F# syntax is 'typar: null + + + + + F# syntax is 'typar: unmanaged + + + + + F# syntax: is 'typar: not struct + + + + + F# syntax: is 'typar: struct + + + + + The unchecked abstract syntax tree of F# type constraints + + + + + Represents the explicit declaration of a type parameter + + + + + A 'do' binding in a module. Must have type 'unit' + + + + + A normal 'let' binding in a module + + + + + A standalone expression in a module + + + + + The kind associated with a binding - "let", "do" or a standalone expression + + + + + Says that the expression is an atomic expression, i.e. is of a form that has no whitespace unless + enclosed in parentheses, e.g. 1, "3", ident, ident.[expr] and (expr). If an atomic expression has + type T, then the largest expression ending at the same range as the atomic expression also has type T. + + + + + stores pair: record field name + (true if given record field name is syntactically correct and can be used in name resolution) + + + + + denotes location of the separator block + optional position of the semicolon (used for tooling support) + + + + + Indicates if a for loop is 'for x in e1 -> e2', only valid in sequence expressions + + + + + Indicates if a for loop is 'for x in e1 -> e2', only valid in sequence expressions + + + + + The unchecked abstract syntax tree of F# unit of measure exponents. + + + + + The unchecked abstract syntax tree of F# unit of measure annotations. + This should probably be merged with the representation of SynType. + + + + + Old comment: "we never iterate, so the const here is not another SynConst.Measure" + + + + + Used internally in the typechecker once an array of unit16 constants + is detected, to allow more efficient processing of large arrays of uint16 constants. + + + + + F# syntax: verbatim or regular byte string, e.g. "abc"B. + + Also used internally in the typechecker once an array of unit16 constants + is detected, to allow more efficient processing of large arrays of uint16 constants. + + + + + F# syntax: verbatim or regular string, e.g. "abc" + + + + + UserNum(value, suffix) + + F# syntax: 1Q, 1Z, 1R, 1N, 1G + + + + + F# syntax: 23.4M + + + + + F# syntax: 'a' + + + + + F# syntax: 1.30, 1.40e10 etc. + + + + + F# syntax: 1.30f, 1.40e10f etc. + + + + + F# syntax: 13un + + + + + F# syntax: 13n + + + + + F# syntax: 13UL + + + + + F# syntax: 13L + + + + + F# syntax: 13u, 0x4000u, 0o0777u + + + + + F# syntax: 13, 0x4000, 0o0777 + + + + + F# syntax: 13us, 0x4000us, 0o0777us, 0b0111101us + + + + + F# syntax: 13s, 0x4000s, 0o0777s, 0b0111101s + + + + + F# syntax: 13uy, 0x40uy, 0oFFuy, 0b0111101uy + + + + + F# syntax: 13y, 0xFFy, 0o077y, 0b0111101y + + + + + F# syntax: true, false + + + + + F# syntax: () + + + + + The unchecked abstract syntax tree of constants in F# types and expressions. + + + + + LongIdentWithDots(lid, dotms) + Typically dotms.Length = lid.Length-1, but they may be same if (incomplete) code ends in a dot, e.g. "Foo.Bar." + The dots mostly matter for parsing, and are typically ignored by the typechecker, but + if dotms.Length = lid.Length, then the parser must have reported an error, so the typechecker is allowed + more freedom about typechecking these expressions. + LongIdent can be empty list - it is used to denote that name of some AST element is absent (i.e. empty type name in inherit) + + + + + This code runs for .XML generation and thus influences cross-project xmldoc tooltips; for within-project tooltips, + see XmlDocumentation.fs in the language service + + + + + Used to collect XML documentation during lexing and parsing. + + + + + Reset the generator used for compiler-generated argument names. + + + + + Get the generator used for compiler-generated argument names. + + + + + Get the range corresponding to one of the r.h.s. symbols of a grammar rule while it is being reduced + + + + + Get the range covering two of the r.h.s. symbols of a grammar rule while it is being reduced + + + + + Get the range corresponding to the result of a grammar rule while it is being reduced + + + + + Get an F# compiler range from a lexer range + + + + + Get an F# compiler position from a lexer position + + + + + Helper for parsing the inline IL fragments. + + + + + Helper for parsing the inline IL fragments. + + + + + "fun (UnionCase x) (UnionCase y) -> body" + ==> + "fun tmp1 tmp2 -> + let (UnionCase x) = tmp1 in + let (UnionCase y) = tmp2 in + body" + + + + + Push non-simple parts of a patten match over onto the r.h.s. of a lambda. + Return a simple pattern and a function to build a match on the r.h.s. if the pattern is complex + + + + + Recognize the '()' in 'new()' + + + + + Extract the argument for patterns corresponding to the declaration of 'new ... = ...' + + + + + This affects placement of sequence points + + + + + Match a long identifier, including the case for single identifiers which gets a more optimized node in the syntax tree. + + + + + The prefix of the names used for the fake namespace path added to all dynamic code entries in FSI.EXE + + + + + The error raised by the parse_error_rich function, which is called by the parser engine + when a syntax error occurs. The first object is the ParseErrorContext which contains a dump of + information about the grammar at the point where the error occurred, e.g. what tokens + are valid to shift next at that point in the grammar. This information is processed in CompileOps.fs. + + + + + Called from the parser each time we parse a construct that marks the end of an XML doc comment range, + e.g. a 'type' declaration. The markerRange is the range of the keyword that delimits the construct. + + + + + Called from the lexer to save a single line of XML doc comment. + + + + + XmlDoc F# lexer/parser state, held in the BufferLocalStore for the lexer. + This is the only use of the lexer BufferLocalStore in the codebase. + + + + + Infer the syntactic information for a 'let' or 'member' definition, based on the argument pattern, + any declared return information (e.g. .NET attributes on the return element), and the r.h.s. expression + in the case of 'let' definitions. + + + + + For 'let' definitions, we infer syntactic argument information from the r.h.s. of a definition, if it + is an immediate 'fun ... -> ...' or 'function ...' expression. This is noted in the F# language specification. + This does not apply to member definitions. + + + + + Transform a property declared using '[static] member P = expr' to a method taking a "unit" argument. + This is similar to IncorporateEmptyTupledArgForPropertyGetter, but applies to member definitions + rather than member signatures. + + + + + Make sure only a solitary unit argument has unit elimination + + + + + Infer the syntactic argument info for one or more arguments a pattern. + + + + + Infer the syntactic argument info for one or more arguments one or more simple patterns. + + + + + Infer the syntactic argument info for a single argument from a simple pattern. + + + + + Get the argument attributes from the syntactic information for an argument. + + + + + Get the argument counts for each curried argument group. Used in some adhoc places in tc.fs. + + + + + Add a parameter entry to the syntactic value information to represent the value argument for a property setter. This is + used for the implicit value argument in property setter signature specifications. + + + + + Add a parameter entry to the syntactic value information to represent the 'this' argument. This is + used for the implicit 'this' argument in member signature specifications. + + + + + Add a parameter entry to the syntactic value information to represent the '()' argument to a property getter. This is + used for the implicit '()' argument in property getter signature specifications. + + + + + Check if there are any optional arguments in the syntactic argument information. Used when adjusting the + types of optional arguments for function and member signatures. + + + + + Check if one particular argument is an optional argument. Used when adjusting the + types of optional arguments for function and member signatures. + + + + + Determine if a syntactic information represents a member without arguments (which is implicitly a property getter) + + + + + The 'argument' information for the 'this'/'self' parameter in the cases where it is not given explicitly + + + + + The 'argument' information for a return value where no attributes are given for the return value (the normal case) + + + + + The argument information for a '()' argument + + + + + The argument information for a curried argument without a name + + + + + The argument information for an argument without a name + + + + + Operations related to the syntactic analysis of arguments of value, function and member definitions and signatures. + + Function and member definitions have strongly syntactically constrained arities. We infer + the arity from the syntax. + + For example, we record the arity for: + StaticProperty --> [1] -- for unit arg + this.InstanceProperty --> [1;1] -- for unit arg + StaticMethod(args) --> map InferSynArgInfoFromSimplePat args + this.InstanceMethod() --> 1 :: map InferSynArgInfoFromSimplePat args + this.InstanceProperty with get(argpat) --> 1 :: [InferSynArgInfoFromSimplePat argpat] + StaticProperty with get(argpat) --> [InferSynArgInfoFromSimplePat argpat] + this.InstanceProperty with get() --> 1 :: [InferSynArgInfoFromSimplePat argpat] + StaticProperty with get() --> [InferSynArgInfoFromSimplePat argpat] + + this.InstanceProperty with set(argpat)(v) --> 1 :: [InferSynArgInfoFromSimplePat argpat; 1] + StaticProperty with set(argpat)(v) --> [InferSynArgInfoFromSimplePat argpat; 1] + this.InstanceProperty with set(v) --> 1 :: [1] + StaticProperty with set(v) --> [1] + + + + + This function maps production indexes returned in syntax errors to strings representing the non terminal that would be produced by that production + + + + + This function maps production indexes returned in syntax errors to strings representing the non terminal that would be produced by that production + + + + + Keywords paired with their descriptions. Used in completion and quick info. + + + + + Returns starting position of the token + + + + + Returns end position of the token + + + + + Returns a token 'tok' with the same position as this token, except that + it is shifted by specified number of characters from the left and from the right + Note: positive value means shift to the right in both cases + + + + + Returns a token 'tok' with the same position as this token + + + + + Used to save the state related to a token + + + + + Used to save some aspects of the lexbuffer state + + + + + Determine the token that may align with the 'try' of a 'try/catch' or 'try/finally' without closing + the construct + + + + + Determine the tokens that may align with the 'if' of an 'if/then/elif/else' without closing + the construct + + + + + Used for warning strings, which should display columns as 1-based and display + the lines after taking '# line' directives into account (i.e. do not use + p.OriginalLine) + + + + + LexFilter - process the token stream prior to parsing. + Implements the offside rule and a copule of other lexical transformations. + + + + + Compute the hash value for the tainted value + + + + + Test whether the tainted value equals given value. Type providers are ignored (equal tainted values produced by different type providers are equal) + Failure in call to equality operation will be blamed on type provider of first operand + + + + + Test whether the tainted value equals given value. + Failure in call to equality operation will be blamed on type provider of first operand + + + + + Test whether the tainted value is null + + + + + The table of remappings from type names in the provided assembly to type + names in the statically linked, embedded assembly. + + + + + Create a new static linking map, ready to populate with data. + + + + + The table of information recording remappings from type names in the provided assembly to type + names in the statically linked, embedded assembly, plus what types are nested in side what types. + + + + + Represents the remapping information for a generated provided type and its nested types. + + There is one overall tree for each root 'type X = ... type generation expr...' specification. + + + + + Convert the expression to a string for diagnostics + + + + + Map the TyconRef objects, if any + + + + + The context used to interpret information in the closure of System.Type, System.MethodInfo and other + info objects coming from the type provider. + + At the moment this is the "Type --> ILTypeRef" and "Type --> Tycon" remapping + context for generated types (it is empty for erased types). This is computed from + while processing the [<Generate>] declaration related to the type. + + Immutable (after type generation for a [<Generate>] declaration populates the dictionaries). + + The 'obj' values are all TyconRef, but obj is used due to a forward reference being required. Not particularly + pleasant, but better than intertwining the whole "ProvidedType" with the TAST structure. + + + + + The folder for temporary files + + + + + All referenced assemblies, including the type provider itself, and possibly other type providers. + + + + + Whether or not the --showextensionresolution flag was supplied to the compiler. + + + + + Output file name + + + + + The folder from which an extension provider is resolving from. This is typically the project folder. + + + + + Carries information about the type provider resolution environment. + + + + + Check if this is a direct reference to a non-embedded generated type. This is not permitted at any name resolution. + We check by seeing if the type is absent from the remapping context. + + + + + Get the ILTypeRef for the provided type (including for nested types). Do not take into account + any type relocations or static linking for generated types. + + + + + Get the ILTypeRef for the provided type (including for nested types). Take into account + any type relocations or static linking for generated types. + + + + + Decompose the enclosing name of a type (including any class nestings) into a list of parts. + e.g. System.Object -> ["System"; "Object"] + + + + + Get the parts of a .NET namespace. Special rules: null means global, empty is not allowed. + + + + + Try to resolve a type in the given extension type resolver + + + + + Try to resolve a type in the given extension type resolver + + + + + Try to apply a provided method to the given static arguments. + + + + + Try to apply a provided type to the given static arguments. If successful also return a function + to check the type name is as expected (this function is called by the caller of TryApplyProvidedType + after other checks are made). + + + + + Validate that the given provided type meets some of the rules for F# provided types + + + + + Get the provided expression for a particular use of a method. + + + + + Detect a provided 'Var' expression + + + + + Detect a provided 'IfThenElse' expression + + + + + Detect a provided 'set variable' expression + + + + + Detect a provided 'let' expression + + + + + Detect a provided type-test expression + + + + + Detect a provided type-as expression + + + + + Detect a provided tuple-get expression + + + + + Detect a provided new-tuple expression + + + + + Detect a provided default-value expression + + + + + Detect a provided constant expression + + + + + Detect a provided call expression + + + + + Detect a provided lambda expression + + + + + Detect a provided try/finally expression + + + + + Detect a provided try/with expression + + + + + Detect a provided sequential expression + + + + + Detect a provided expression which is a for-loop over integers + + + + + Detect a provided new-delegate expression + + + + + Detect a provided while-loop expression + + + + + Detect a provided new-object expression + + + + + Detect a provided new-array expression + + + + + Given an extension type resolver, supply a human-readable name suitable for error messages. + + + + + Find and instantiate the set of ITypeProvider components for the given assembly reference + + + + + Get the list of relative paths searched for type provider design-time components + + + + + Raised when an type provider has thrown an exception. + + + + + Raised when a type provider has thrown an exception. + + + + + Indicates an F# 3.0+ reference to a named type in an assembly loaded by name + + + + + Indicates an F# 4.0+ reference into the supplied table of type definition references, ultimately resolved by TypeRef/TypeDef data + + + + + Code to pickle out quotations in the quotation binary format. + + + + + An AbstractIL type representation that may include type variables + + + + + An AbstractIL type representation that is just the name of a type. + + CompiledTypeRepr.ILAsmNamed (ilTypeRef, ilBoxity, ilTypeOpt) + + The ilTypeOpt is present for non-generic types. It is an ILType corresponding to the first two elements of the case. This + prevents reallocation of the ILType each time we need to generate it. For generic types, it is None. + + + + + Specifies the compiled representations of type and exception definitions. Basically + just an ILTypeRef. Computed and cached by later phases. Stored in + type and exception definitions. Not pickled. Store an optional ILType object for + non-generic types. + + + + + See FreeTyvars above. + + + + + The summary of union constructors used in the expression. These may be + marked 'internal' or 'private' and we have to check various conditions associated with that. + + + + + The summary of fields used in the expression. These may be made private by a signature + or marked 'internal' or 'private' and we have to check various conditions associated with that. + + + + + The summary of locally defined tycon representations used in the expression. These may be made private by a signature + or marked 'internal' or 'private' and we have to check various conditions associated with that. + + + + + Indicates if the expression contains a call to rethrow that is not bound under a (try-)with branch. + Rethrow may only occur in such locations. + + + + + Indicates if the expression contains a call to a protected member or a base call. + Calls to protected members and direct calls to super classes can't escape, also code can't be inlined + + + + + The summary of locally defined variables used in the expression. These may be hidden at let bindings etc. + or made private by a signature or marked 'internal' or 'private', and we have to check various conditions associated with that. + + + + + Represents the set of free variables in an expression + + + + + Represents an amortized computation of the free variables in an expression + + + + + The summary of type parameters used in the expression. These may not escape the enclosing generic construct + and we have to check various conditions associated with that. + + + + + The summary of values used as trait solutions + + + + + The summary of locally defined type definitions used in the expression. These may be made private by a signature + and we have to check various conditions associated with that. + + + + + Represents a set of 'free' type-related elements, including named types, trait solutions, union cases and + record fields. + + + + + Represents a set of 'free' union cases. Used to collect the union cases referred to from an expression. + + + + + Represents a set of 'free' record field definitions. Used to collect the record field definitions referred to + from an expression. + + + + + Represents a set of 'free' named type definitions. Used to collect the named type definitions referred to + from a type or expression. + + + + + Represents a set of free type parameters + + + + + Represents a set of free local values. + + + + + Represents a complete typechecked assembly, made up of multiple implementation files. + + + + + + Represents a complete typechecked implementation file, including its typechecked signature if any. + + TImplFile (qualifiedNameOfFile, pragmas, implementationExpressionWithSignature, hasExplicitEntryPoint, isScript) + + + + + This is the body of the module/namespace + + + + + A named module-or-namespace-fragment definition + + + + + Indicates the module fragment is a 'rec' or 'non-rec' definition of types and modules + + + + + Indicates the module fragment is an evaluation of expression for side-effects + + + + + Indicates the module fragment is a 'let' definition + + + + + Indicates the module fragment is made of several module fragments in succession + + + + + Indicates the module is a module with a signature + + + + + The contents of a module-or-namespace-fragment definition + + + + + A type for a module-or-namespace-fragment and the actual definition of the module-or-namespace-fragment + The first ModuleOrNamespaceType is the signature and is a binder. However the bindings are not used in the ModuleOrNamespaceExpr: it is only referenced from the 'outside' + is for use by FCS only to report the "hidden" contents of the assembly prior to applying the signature. + + + + + Represents a parameter to an abstract method slot. + + TSlotParam(nm, ty, inFlag, outFlag, optionalFlag, attribs) + + + + + Represents an abstract method slot, or delegate signature. + + TSlotSig(methodName, declaringType, declaringTypeParameters, methodTypeParameters, slotParameters, returnTy) + + + + + A representation of a method in an object expression. + + TObjExprMethod(slotsig, attribs, methTyparsOfOverridingMethod, methodParams, methodBodyExpr, m) + + + + + Indicates the kind of an F# core library static optimization construct + + + + + A call to a base method, e.g. 'base.OnPaint(args)' + + + + + A call to a constructor, e.g. 'new C() = new C(3)' + + + + + A call to a constructor, e.g. 'inherit C()' + + + + + A normal use of a value + + + + + Indicates a use of a value represents a call to a method that may require + a .NET 2.0 constrained call. A constrained call is only used for calls where + + + + + Indicates how a value, function or member is being used at a particular usage point. + + + + + let res = a in b;res + + + + + a ; b + + + + + Indicates the kind of sequential operation, i.e. "normal" or "to a before returning b" + + + + + In C syntax this is: *localv_ptr = e + + + + + In C syntax this is: localv = e, note == *(&localv) = e == LAddrOf; LByrefSet + + + + + In C syntax this is: *localv_ptr + + + + + In C syntax this is: &localv + + + + + Indicates what kind of pointer operation this is. + + + + + Evaluate start once and end multiple times, loop up + + + + + Evaluate start and end once, loop down + + + + + Evaluate start and end once, loop up + + + + + Indicates the kind of looping operation. + + + + + Marks the compiled form of a 'for ... in ... do ' expression + + + + + Indicates the kind of looping operation. + + + + + If this is Some ty then it indicates that a .NET 2.0 constrained call is required, with the given type as the + static type of the object argument. + + + + + Normal record construction + + + + + We're in an explicit constructor. The purpose of the record expression is to + fill in the fields of a pre-created but uninitialized object + + + + + Indicates the kind of record construction operation. + + + + + ILCall(useCallvirt, isProtected, valu, newobj, valUseFlags, isProp, noTailCall, mref, actualTypeInst, actualMethInst, retTy) + + IL method calls. + value -- is the object a value type? + isProp -- used for quotation reflection. + noTailCall - DllImport? if so don't tailcall + actualTypeInst -- instantiation of the enclosing type + actualMethInst -- instantiation of the method + retTy -- the types of pushed values, if any + + + + + Operation nodes representing C-style operations on byrefs and mutable vals (l-values) + + + + + Pseudo method calls. This is used for overloaded operations like op_Addition. + + + + + Used for state machine compilation + + + + + Used for state machine compilation + + + + + Used for state machine compilation + + + + + Represents a "rethrow" operation. May not be rebound, or used outside of try-finally, expecting a unit argument + + + + + Conversion node, compiled via type-directed translation or to box/unbox + + + + + Generate a ldflda on an 'a ref. + + + + + IL assembly code - type list are the types pushed on the stack + + + + + An operation representing a field-get from an F# tuple value. + + + + + An operation representing a field-set on an F# exception value. + + + + + An operation representing a field-get from an F# exception value. + + + + + An operation representing a field-get from a union value. The value is not assumed to have been proven to be of the corresponding union case. + + + + + An operation representing a field-get from a union value, where that value has been proven to be of the corresponding union case. + + + + + An operation representing a field-get from a union value, where that value has been proven to be of the corresponding union case. + + + + + An operation representing a coercion that proves a union value is of a particular union case. This is not a test, its + simply added proof to enable us to generate verifiable code for field access on union types + + + + + An operation representing getting an integer tag for a union value representing the union case number + + + + + An operation representing getting the address of a record field + + + + + An operation representing getting a record or class field + + + + + An operation representing setting a record or class field + + + + + Construct a record or object-model value. The ValRef is for self-referential class constructors, otherwise + it indicates that we're in a constructor and the purpose of the expression is to + fill in the fields of a pre-created but uninitialized object, and to assign the initialized + version of the object into the optional mutable cell pointed to be the given value. + + + + + An operation representing a lambda-encoded try/finally + + + + + An operation representing a lambda-encoded try/catch + + + + + An operation representing a lambda-encoded for loop + + + + + An operation representing a lambda-encoded while loop. The special while loop marker is used to mark compilations of 'foreach' expressions + + + + + Constant uint16 arrays (used for parser tables) + + + + + Constant byte arrays (used for parser tables and other embedded data) + + + + + An operation representing the creation of an array value + + + + + An operation representing the get of a property from an anonymous record + + + + + An operation representing the creation of an anonymous record + + + + + An operation representing the creation of a tuple value + + + + + An operation representing the creation of an exception value using an F# exception declaration + + + + + An operation representing the creation of a union value of the particular union case + + + + + Typechecking residue: A Expr.Link occurs for every use of a recursively bound variable. While type-checking + the recursive bindings a dummy expression is stored in the mutable reference cell. + After type checking the bindings this is replaced by a use of the variable, perhaps at an + appropriate type instantiation. These are immediately eliminated on subsequent rewrites. + + + + + Typechecking residue: Indicates a free choice of typars that arises due to + minimization of polymorphism at let-rec bindings. These are + resolved to a concrete instantiation on subsequent rewrites. + + + + + Expr.Quote (quotedExpr, (referencedTypes, spliceTypes, spliceExprs, data) option ref, isFromQueryExpression, fullRange, quotedType) + + Indicates the expression is a quoted expression tree. + + + + + + An intrinsic applied to some (strictly evaluated) arguments + A few of intrinsics (TOp_try, TOp.While, TOp.For) expect arguments kept in a normal form involving lambdas + + + + + If we statically know some information then in many cases we can use a more optimized expression + This is primarily used by terms in the standard library, particularly those implementing overloaded + operators. + + + + + Matches are a more complicated form of "let" with multiple possible destinations + and possibly multiple ways to get to each destination. + The first mark is that of the expression being matched, which is used + as the mark for all the decision making and binding that happens during the match. + + + + + Bind a value. + + + + + Bind a recursive set of values. + + + + + Applications. + Applications combine type and term applications, and are normalized so + that sequential applications are combined, so "(f x y)" becomes "f [[x];[y]]". + The type attached to the function is the formal function type, used to ensure we don't build application + nodes that over-apply when instantiating at function types. + + + + + Type lambdas. These are used for the r.h.s. of polymorphic 'let' bindings and + for expressions that implement first-class polymorphic values. + + + + + Why multiple vspecs? A Expr.Lambda taking multiple arguments really accepts a tuple. + But it is in a convenient form to be compile accepting multiple + arguments, e.g. if compiled as a toplevel static method. + + + + + Sequence expressions, used for "a;b", "let a = e in b;a" and "a then b" (the last an OO constructor). + + + + + Reference a value. The flag is only relevant if the value is an object model member + and indicates base calls and special uses of object constructors. + + + + + A constant expression. + + + + + The big type of expressions. + + + + + Records the extra metadata stored about typars for type parameters + compiled as "real" IL type parameters, specifically for values with + ValReprInfo. Any information here is propagated from signature through + to the compiled code. + + + + + Records the "extra information" for an argument compiled as a real + method argument, specifically the argument name and attributes. + + + + + ValReprInfo (numTypars, args, result) + + + + + Get the total number of arguments + + + + + Get the number of type parameters of the value + + + + + Get the number of curried arguments of the value + + + + + Get the kind of each type parameter + + + + + Indicates if the value has no arguments - neither type parameters nor value arguments + + + + + Get the number of tupled arguments in each curried argument position + + + + + Get the extra information about the arguments for the value + + + + + Records the "extra information" for a value compiled as a method (rather + than a closure or a local), including argument names, attributes etc. + + + + + Get the index of the active pattern element within the overall active pattern + + + + + Get a reference to the value for the active pattern being referred to + + + + + Get the full information about the active pattern being referred to + + + + + Represents a reference to an active pattern element. The + integer indicates which choice in the target set is being selected by this item. + + + + + The value being bound + + + + + The information about whether to emit a sequence point for the binding + + + + + The expression the value is being bound to + + + + + A binding of a variable to an expression, as in a `let` binding or similar + + + + + A collection of simultaneous bindings + + + + + A target of a decision tree. Can be thought of as a little function, though is compiled as a local block. + + + + + Test.ActivePatternCase(activePatExpr, activePatResTys, activePatIdentity, idx, activePatInfo) + + Run the active pattern and bind a successful result to a + variable in the remaining tree. + activePatExpr -- The active pattern function being called, perhaps applied to some active pattern parameters. + activePatResTys -- The result types (case types) of the active pattern. + activePatIdentity -- The value and the types it is applied to. If there are any active pattern parameters then this is empty. + idx -- The case number of the active pattern which the test relates to. + activePatternInfo -- The extracted info for the active pattern. + + + + + IsInst(source, target) + + Test if the input to a decision tree is an instance of the given type + + + + + Test if the input to a decision tree is null + + + + + Test if the input to a decision tree is the given constant value + + + + + Test if the input to a decision tree is an array of the given length + + + + + Test if the input to a decision tree matches the given union case + + + + + Get the discriminator associated with the case + + + + + Get the decision tree or a successful test + + + + + Represents a test and a subsequent decision tree + + + + + TDBind(binding, body) + + Bind the given value through the remaining cases of the dtree. + These arise from active patterns and some optimizations to prevent + repeated computations in decision trees. + binding -- the value and the expression it is bound to + body -- the rest of the decision tree + + + + + TDSuccess(results, targets) + + Indicates the decision tree has terminated with success, transferring control to the given target with the given parameters. + results -- the expressions to be bound to the variables at the target + target -- the target number for the continuation + + + + + TDSwitch(input, cases, default, range) + + Indicates a decision point in a decision tree. + input -- The expression being tested. If switching over a struct union this + must be the address of the expression being tested. + cases -- The list of tests and their subsequent decision trees + default -- The default decision tree, if any + range -- (precise documentation needed) + + + + + Decision trees. Pattern matching has been compiled down to + a decision tree by this point. The right-hand-sides (actions) of + a decision tree by this point. The right-hand-sides (actions) of + the decision tree are labelled by integers that are unique for that + particular tree. + + + + + Constants in expressions + + + + + AttribNamedArg(name, type, isField, value) + + + + + AttribExpr(source, evaluated) + + + + + We keep both source expression and evaluated expression around to help intellisense and signature printing + + + + + Attrib(kind, unnamedArgs, propVal, appliedToAGetterOrSetter, targetsOpt, range) + + + + + Indicates an attribute refers to a type defined in an imported F# assembly + + + + + Indicates an attribute refers to a type defined in an imported .NET assembly + + + + + Represents the information saved in the assembly signature data resource for an F# assembly + + + + + The result of attempting to resolve an assembly name to a full ccu. + UnresolvedCcu will contain the name of the assembly that could not be resolved. + + + + + ccu.orphanfixup is true when a reference is missing in the transitive closure of static references that + may potentially be required for the metadata of referenced DLLs. It is set to true if the "loader" + used in the F# metadata-deserializer or the .NET metadata reader returns a failing value (e.g. None). + Note: When used from Visual Studio, the loader will not automatically chase down transitively referenced DLLs - they + must be in the explicit references in the project. + + + + + Indicates that this DLL uses F# 2.0+ quotation literals somewhere. This is used to implement a restriction on static linking. + + + + + Indicates that this DLL uses F# 2.0+ quotation literals somewhere. This is used to implement a restriction on static linking. + + + + + The table of type forwarders for this assembly + + + + + A unique stamp for this DLL + + + + + A hint as to where does the code for the CCU live (e.g what was the tcConfig.implicitIncludeDir at compilation time for this DLL?) + + + + + The table of type definitions at the "root" of the assembly + + + + + The table of modules and namespaces at the "root" of the assembly + + + + + The fully qualified assembly reference string to refer to this assembly. This is persisted in quotations + + + + + Is the CCu an EST injected assembly + + + + + Indicates that this DLL was compiled using the F# compiler and has F# metadata + + + + + Holds the data indicating how this assembly/module is referenced from the code being compiled. + + + + + Holds the filename for the DLL, if any + + + + + A handle to the full specification of the contents of the module contained in this ccu + + + + + Try to get the .NET Assembly, if known. May not be present for `IsFSharp` for in-memory cross-project references + + + + + Try to resolve a path into the CCU by referencing the .NET/CLI type forwarder table of the CCU + + + + + Used to make forward calls into the type/assembly loader when comparing member signatures during linking + + + + + Used to make 'forward' calls into the loader during linking + + + + + Fixup a CCU to record it as "orphaned", i.e. not available + + + + + Fixup a CCU to have the given contents + + + + + Ensure the ccu is derefable in advance. Supply a path to attach to any resulting error message. + + + + + Create a CCU with the given name but where the contents have not yet been specified + + + + + Create a CCU with the given name and contents + + + + + A compilation unit is, more or less, the new material created in one + invocation of the compiler. Due to static linking assemblies may hold more + than one compilation unit (i.e. when two assemblies are merged into a compilation + the resulting assembly will contain 3 CUs). Compilation units are also created for referenced + .NET assemblies. + + References to items such as type constructors are via + cross-compilation-unit thunks, which directly reference the data structures that define + these modules. Thus, when saving out values to disk we only wish + to save out the "current" part of the term graph. When reading values + back in we "fixup" the links to previously referenced modules. + + All non-local accesses to the data structures are mediated + by ccu-thunks. Ultimately, a ccu-thunk is either a (named) element of + the data structure, or it is a delayed fixup, i.e. an invalid dangling + reference that has not had an appropriate fixup applied. + + + + + Represents a table of .NET CLI type forwarders for an assembly + + + + + The table of .NET CLI type forwarders for this assembly + + + + + A helper function used to link method signatures using type equality. This is effectively a forward call to the type equality + logic in tastops.fs + + + + + A helper function used to link method signatures using type equality. This is effectively a forward call to the type equality + logic in tastops.fs + + + + + A handle to the full specification of the contents of the module contained in this ccu + + + + + Indicates that this DLL uses pre-F#-4.0 quotation literals somewhere. This is used to implement a restriction on static linking + + + + + A helper function used to link method signatures using type equality. This is effectively a forward call to the type equality + logic in tastops.fs + + + + + Triggered when the contents of the CCU are invalidated + + + + + Is the CCu an assembly injected by a type provider + + + + + Indicates that this DLL was compiled using the F# compiler and has F# metadata + + + + + A hint as to where does the code for the CCU live (e.g what was the tcConfig.implicitIncludeDir at compilation time for this DLL?) + + + + + The fully qualified assembly reference string to refer to this assembly. This is persisted in quotations + + + + + A unique stamp for this DLL + + + + + Holds the data indicating how this assembly/module is referenced from the code being compiled. + + + + + Holds the filename for the DLL, if any + + + + + Raising a measure to a rational power + + + + + The unit of measure '1', e.g. float = float<1> + + + + + An inverse of a units of measure expression + + + + + A product of two units of measure + + + + + A constant, leaf unit-of-measure such as 'kg' or 'm' + + + + + A variable unit-of-measure + + + + + Some constant, e.g. true or false for tupInfo + + + + + Get the ILTypeRef for the generated type implied by the anonymous type + + + + + Create an AnonRecdTypeInfo from the basic data + + + + + Indicates the type is a unit-of-measure expression being used as an argument to a type or member + + + + + Indicates the type is a variable type, whether declared, generalized or an inference type parameter + + + + + TType_ucase(unionCaseRef, typeInstantiation) + + Indicates the type is a non-F#-visible type representing a "proof" that a union value belongs to a particular union case + These types are not user-visible and will never appear as an inferred type. They are the types given to + the temporaries arising out of pattern matching on union values. + + + + + TType_fun(domainType, rangeType). + + Indicates the type is a function type + + + + + TType_tuple(elementTypes). + + Indicates the type is a tuple type. elementTypes must be of length 2 or greater. + + + + + TType_anon + + Indicates the type is an anonymous record type whose compiled representation is located in the given assembly + + + + + TType_app(tyconRef, typeInstantiation). + + Indicates the type is built from a named type and a number of type arguments + + + + + TType_forall(typars, bodyTy). + + Indicates the type is a universal type, only used for types of values and members + + + + + For now, used only as a discriminant in error message. + See https://github.com/Microsoft/visualfsharp/issues/2561 + + + + + The algebra of types + + + + + Get a reference to the type containing this union case + + + + + Get the Entity for the type containing this union case + + + + + Try to dereference the reference + + + + + Get the signature range of the record field + + + + + Dereference the reference + + + + + Get the declaration range of the record field + + + + + Get the attributes associated with the compiled property of the record field + + + + + Get the name off the field + + + + + Get the definition range of the record field + + + + + Represents a reference to a field in a record, class or struct + + + + + Dereference the reference to the union case + + + + + Get a reference to the type containing this union case + + + + + Get the Entity for the type containing this union case + + + + + Try to dereference the reference + + + + + Get the signature range of the union case + + + + + Get the resulting type of the union case + + + + + Get the range of the union case + + + + + Get the index of the union case amongst the cases + + + + + Get the definition range of the union case + + + + + Get the name of this union case + + + + + Get the attributes associated with the union case + + + + + Get the fields of the union case + + + + + Get a field of the union case by index + + + + + Represents a reference to a case of a union type + + + + + Indicates a reference to something bound in another CCU + + + + + Indicates a reference to something bound in this CCU + + + + + Get or set the signature for the value's XML documentation + + + + + Get the declared documentation for the value + + + + + Records the "extra information" for a value compiled as a method. + + This indicates the number of arguments in each position for a curried function. + + + + + Get the type of the value including any generic type parameters + + + + + The type of the value. May be a TType_forall for a generic value. + May be a type variable or type containing type variables during type inference. + + + + + Dereference the ValRef to a Val option. + + + + + Get the actual parent entity for the value (a module or a type), i.e. the entity under which the + value will appear in compiled code. For extension members this is the module where the extension member + is declared. + + + + + Get the type of the value after removing any generic type parameters + + + + + A unique stamp within the context of this invocation of the compiler process + + + + + The quotation expression associated with a value given the [<ReflectedDefinition>] tag + + + + + Get the information about a recursive value used during type inference + + + + + Get the public path to the value, if any? Should be set if and only if + IsMemberOrModuleBinding is set. + + + + + Get the name of the value, assuming it is compiled as a property. + - If this is a property then this is 'Foo' + - If this is an implementation of an abstract slot then this is the name of the property implemented by the abstract slot + + + + + Indicates if this value allows the use of an explicit type instantiation (i.e. does it itself have explicit type arguments, + or does it have a signature?) + + + + + Get the number of 'this'/'self' object arguments for the member. Instance extension members return '1'. + + + + + Indicates whether the inline declaration for the value indicate that the value must be inlined? + + + + + Is this a member, if so some more data about the member. + + + + + Get the apparent parent entity for a member + + + + + Indicates if this is inferred to be a method or function that definitely makes no critical tailcalls? + + + + + The value of a value or member marked with [<LiteralAttribute>] + + + + + Indicates whether this value represents a property setter. + + + + + Indicates whether this value represents a property getter. + + + + + Indicates if this value was a member declared 'override' or an implementation of an interface slot + + + + + Indicates if this value is declared 'mutable' + + + + + Indicates if this is an F#-defined value in a module, or an extension member, but excluding compiler generated bindings from optimizations + + + + + Is this a member definition or module definition? + + + + + Indicates if this is a member + + + + + Indicates if this is an F#-defined instance member. + + Note, the value may still be (a) an extension member or (b) and abstract slot without + a true body. These cases are often causes of bugs in the compiler. + + + + + Indicates if this is a member generated from the de-sugaring of 'let' function bindings in the implicit class syntax? + + + + + Indicates if this is a constructor member generated from the de-sugaring of implicit constructor for a class type? + + + + + Indicates if this is an F#-defined extension member + + + + + Indicates if this member is an F#-defined dispatch slot. + + + + + Indicates if this is an F#-defined 'new' constructor member + + + + + Indicates whether this value was generated by the compiler. + + Note: this is true for the overrides generated by hash/compare augmentations + + + + + Is this represented as a "top level" static binding (i.e. a static field, static member, + instance member), rather than an "inner" binding that may result in a closure. + + + + + Get the inline declaration on the value + + + + + Dereference the ValRef to a Val. + + + + + The parent type or module, if any (None for expression bindings and parameters) + + + + + The name of the method in compiled code (with some exceptions where ilxgen.fs decides not to use a method impl) + + + + + Indicates if this is a 'base' or 'this' value? + + + + + Get the declared attributes for the value + + + + + Get the apparent parent entity for the value, i.e. the entity under with which the + value is associated. For extension members this is the nominal type the member extends. + For other values it is just the actual parent. + + + + + Get the value representing the accessibility of an F# type definition or module. + + + + + References are either local or nonlocal + + + + + note: ModuleOrNamespaceRef and TyconRef are type equivalent + + + + + Indicates a reference to something bound in another CCU + + + + + Indicates a reference to something bound in this CCU + + + + + The XML documentation sig-string of the entity, if any, to use to lookup an .xml doc file. This also acts + as a cache for this sig-string computation. + + + + + The XML documentation of the entity, if any. If the entity is backed by provided metadata + then this _does_ include this documentation. If the entity is backed by Abstract IL metadata + or comes from another F# assembly then it does not (because the documentation will get read from + an XML file). + + + + + Get the union cases and other union-type information for a type, if any + + + + + Get the union cases for a type, if any, as a list + + + + + Get the union cases for a type, if any + + + + + The information about the r.h.s. of a type definition, if any. For example, the r.h.s. of a union or record type. + + + + + Get the value representing the accessibility of the r.h.s. of an F# type definition. + + + + + The kind of the type definition - is it a measure definition or a type definition? + + + + + The logical contents of the entity when it is a type definition. + + + + + Indicates if this entity is an F# type abbreviation definition + + + + + Get the type parameters for an entity that is a type declaration, otherwise return the empty list. + + + + + The on-demand analysis about whether the entity has the IsByRefLike attribute + + + + + The on-demand analysis about whether the entity has the IsByRefLike attribute + + + + + Dereference the TyconRef to a Tycon option. + + + + + Get a list of all instance fields for F#-defined record, struct and class fields in this type definition, + excluding compiler-generate fields. + + + + + Get a list of all fields for F#-defined record, struct and class fields in this type definition, + including static fields, but excluding compiler-generate fields. + + + + + A unique stamp for this module, namespace or type definition within the context of this compilation. + Note that because of signatures, there are situations where in a single compilation the "same" + module, namespace or type may have two distinct Entity objects that have distinct stamps. + + + + + The signature definition location of the namespace, module or type + + + + + The code location where the module, namespace or type is defined. + + + + + Get a blob of data indicating how this type is nested in other namespaces, modules or types. + + + + + Indicates if we have pre-determined that a type definition has a default constructor. + + + + + The logical contents of the entity when it is a module or namespace fragment. + + + + + Gets the immediate members of an F# type definition, excluding compiler-generated ones. + Note: result is alphabetically sorted, then for each name the results are in declaration order + + + + + Gets all immediate members of an F# type definition keyed by name, including compiler-generated ones. + Note: result is a indexed table, and for each name the results are in reverse declaration order + + + + + The name of the namespace, module or type, possibly with mangling, e.g. List`1, List or FailureException + + + + + Indicate if this is a type whose r.h.s. is known to be a union type definition. + + + + + Indicates if this entity is an F# type abbreviation definition + + + + + Indicates if this is a struct or enum type definition, i.e. a value type definition + + + + + Indicates if the entity is an erased provided type definition that incorporates a static instantiation (and therefore in some sense compiler generated) + + + + + Indicates if this is an F# type definition whose r.h.s. is known to be a record type definition. + + + + + Indicates if the entity is a provided namespace fragment + + + + + Indicates if the entity is a generated provided type definition, i.e. not erased. + + + + + Indicates if the entity is an erased provided type definition + + + + + Indicates if the entity is a provided namespace fragment + + + + + Indicates the type prefers the "tycon<a, b>" syntax for display etc. + + + + + Indicates if the entity is a namespace + + + + + Indicates the "tycon blob" is actually a module + + + + + Indicates if the entity is an F# module definition + + + + + Indicates if this is an F# type definition which is one of the special types in FSharp.Core.dll like 'float<_>' which + defines a measure type with a relation to an existing non-measure type as a representation. + + + + + Indicate if this is a type definition backed by Abstract IL metadata. + + + + + Indicates if this is a .NET-defined struct or enum type definition, i.e. a value type definition + + + + + Indicates if this is a .NET-defined enum type definition + + + + + Indicates if this is an F# type definition whose r.h.s. definition is unknown (i.e. a traditional ML 'abstract' type in a signature, + which in F# is called a 'unknown representation' type). + + + + + Indicates if this is an F#-defined struct or enum type definition, i.e. a value type definition + + + + + Indicates if this is an F# type definition whose r.h.s. is known to be some kind of F# object model definition + + + + + Indicates if this is an F#-defined interface type definition + + + + + Indicates if this is an F#-defined enum type definition + + + + + Indicates if this is an F#-defined delegate type definition + + + + + Indicates if the entity represents an F# exception declaration. + + + + + Indicates if the entity is erased, either a measure definition, or an erased provided type definition + + + + + Indicates if this is an enum type definition + + + + + Indicates if this is an F# type definition which is one of the special types in FSharp.Core.dll which uses + an assembly-code representation for the type, e.g. the primitive array type constructor. + + + + + Gets the immediate interface definitions of an F# type definition. Further interfaces may be supported through class and interface inheritance. + + + + + Gets the immediate interface types of an F# type definition. Further interfaces may be supported through class and interface inheritance. + + + + + The identifier at the point of declaration of the type definition. + + + + + Get the Abstract IL metadata for this type definition, assuming it is backed by Abstract IL metadata. + + + + + Get the Abstract IL scope, nesting and metadata for this + type definition, assuming it is backed by Abstract IL metadata. + + + + + Indicates if we have pre-determined that a type definition has a self-referential constructor using 'as x' + + + + + Gets any implicit hash/equals (with comparer argument) methods added to an F# record, union or struct type definition. + + + + + Gets any implicit hash/equals methods added to an F# record, union or struct type definition. + + + + + Gets any implicit CompareTo (with comparer argument) methods added to an F# record, union or struct type definition. + + + + + Gets any implicit CompareTo methods added to an F# record, union or struct type definition. + + + + + Get the blob of information associated with an F# object-model type definition, i.e. class, interface, struct etc. + + + + + The information about the r.h.s. of an F# exception definition, if any. + + + + + The display name of the namespace, module or type with <_, _, _> added for generic types, including static parameters + + + + + The display name of the namespace, module or type, e.g. List instead of List`1, including static parameters + + + + + The display name of the namespace, module or type, e.g. List instead of List`1, not including static parameters + + + + + Dereference the TyconRef to a Tycon. Amortize the cost of doing this. + This path should not allocate in the amortized case + + + + + Demangle the module name, if FSharpModuleWithSuffix is used + + + + + The implementation definition location of the namespace, module or type + + + + + Gets the data indicating the compiled representation of a named type or module in terms of Abstract IL data structures. + + + + + Gets the data indicating the compiled representation of a type or module in terms of Abstract IL data structures. + + + + + Get the cache of the compiled ILTypeRef representation of this module or type. + + + + + The compiled name of the namespace, module or type, e.g. FSharpList`1, ListModule or FailureException + + + + + Get a blob of data indicating how this type is nested inside other namespaces, modules and types. + + + + + Get a blob of data indicating how this type is nested inside other namespaces, modules and types. + + + + + Is the destination assembly available? + + + + + The F#-defined custom attributes of the entity, if any. If the entity is backed by Abstract IL or provided metadata + then this does not include any attributes from those sources. + + + + + Get a list of all instance fields for F#-defined record, struct and class fields in this type definition. + including hidden fields from the compilation of implicit class constructions. + + + + + Get a list of fields for all the F#-defined record, struct and class fields in this type definition, including + static fields, 'val' declarations and hidden fields from the compilation of implicit class constructions. + + + + + Get an array of fields for all the F#-defined record, struct and class fields in this type definition, including + static fields, 'val' declarations and hidden fields from the compilation of implicit class constructions. + + + + + Get a table of fields for all the F#-defined record, struct and class fields in this type definition, including + static fields, 'val' declarations and hidden fields from the compilation of implicit class constructions. + + + + + Get the value representing the accessibility of an F# type definition or module. + + + + + Get the type parameters for an entity that is a type declaration, otherwise return the empty list. + + Lazy because it may read metadata, must provide a context "range" in case error occurs reading metadata. + + + + + Set the on-demand analysis about whether the entity has the IsReadOnly attribute or is otherwise determined to be a readonly struct + + + + + Set the on-demand analysis about whether the entity has the IsByRefLike attribute + + + + + Get a union case of a type by name + + + + + Get a field by name. + + + + + Get a field by index in definition order + + + + + Get the path into the CCU referenced by the nonlocal reference. + + + + + Get the details of the module or namespace fragment for the entity referred to by this non-local reference. + + + + + Get the mangled name of the last item in the path of the nonlocal reference. + + + + + Get the all-but-last names of the path of the nonlocal reference. + + + + + Dereference the nonlocal reference, and raise an error if this fails. + + + + + Get the CCU referenced by the nonlocal reference. + + + + + Get the name of the assembly referenced by the nonlocal reference. + + + + + Try to find the entity corresponding to the given path, using type-providers to link the data + + + + + Try to find the entity corresponding to the given path in the given CCU + + + + + Try to link a non-local entity reference to an actual entity + + + + + Index into the namespace/module structure of a particular CCU + + + + + The name of the value, or the full signature of the member + + + + + A reference to the entity containing the value or member. This will always be a non-local reference + + + + + For debugging + + + + + Get the thunk for the assembly referred to + + + + + Get the name of the assembly referred to + + + + + For debugging + + + + + Gets updated with 'true' if an abstract slot is implemented in the file being typechecked. Internal only. + + + + + Updated with the full implemented slotsig after interface implementation relation is checked + + + + + The parent type. For an extension member this is the type being extended + + + + + Represents the extra information stored for a member + + + + + See vflags section further below for encoding/decodings here + + + + + Mutable for unpickle linkage + + + + + Mutable for unpickle linkage + + + + + Mutable for unpickle linkage + + + + +Get the signature for the value's XML documentation + + + + +Get the signature for the value's XML documentation + + + + + Get the declared documentation for the value + + + + + Records the "extra information" for a value compiled as a method. + + This indicates the number of arguments in each position for a curried + functions, and relates to the F# spec for arity analysis. + For module-defined values, the currying is based + on the number of lambdas, and in each position the elements are + based on attempting to deconstruct the type of the argument as a + tuple-type. + + The field is mutable because arities for recursive + values are only inferred after the r.h.s. is analyzed, but the + value itself is created before the r.h.s. is analyzed. + + TLR also sets this for inner bindings that it wants to + represent as "top level" bindings. + + + + + Get the type of the value including any generic type parameters + + + + + The type of the value. + May be a TType_forall for a generic value. + May be a type variable or type containing type variables during type inference. + + + + + Get the generic type parameters for the value + + + + + Get the actual parent entity for the value (a module or a type), i.e. the entity under which the + value will appear in compiled code. For extension members this is the module where the extension member + is declared. + + + + + Get the type of the value after removing any generic type parameters + + + + + A unique stamp within the context of this invocation of the compiler process + + + + + Range of the definition (signature) of the value, used by Visual Studio + + + + + The quotation expression associated with a value given the [<ReflectedDefinition>] tag + + + + + Get the information about the value used during type inference + + + + + The place where the value was defined. + + + + + Get the public path to the value, if any? Should be set if and only if + IsMemberOrModuleBinding is set. + + + + + The name of the property. + - If this is a property then this is 'Foo' + - If this is an implementation of an abstract slot then this is the name of the property implemented by the abstract slot + + + + + Indicates if this value allows the use of an explicit type instantiation (i.e. does it itself have explicit type arguments, + or does it have a signature?) + + + + + Get the number of 'this'/'self' object arguments for the member. Instance extension members return '1'. + + + + + Indicates whether the inline declaration for the value indicate that the value must be inlined? + + + + + Is this a member, if so some more data about the member. + + Note, the value may still be (a) an extension member or (b) and abstract slot without + a true body. These cases are often causes of bugs in the compiler. + + + + + Get the apparent parent entity for a member + + + + + Indicates if this is inferred to be a method or function that definitely makes no critical tailcalls? + + + + + The name of the method. + - If this is a property then this is 'get_Foo' or 'set_Foo' + - If this is an implementation of an abstract slot then this is the name of the method implemented by the abstract slot + - If this is an extension member then this will be the simple name + + + + + The value of a value or member marked with [<LiteralAttribute>] + + + + + Indicates if this value was a member declared 'override' or an implementation of an interface slot + + + + + Indicates if this is declared 'mutable' + + + + + Indicates if this is an F#-defined value in a module, or an extension member, but excluding compiler generated bindings from optimizations + + + + + Is this a member definition or module definition? + + + + + Indicates if this is a member + + + + + Indicates if a value is linked to backing data yet. Only used during unpickling of F# metadata. + + + + + Indicates if this is a member, excluding extension members + + + + + Indicates if this is an F#-defined instance member. + + Note, the value may still be (a) an extension member or (b) and abstract slot without + a true body. These cases are often causes of bugs in the compiler. + + + + + Indicates if this is a member generated from the de-sugaring of 'let' function bindings in the implicit class syntax? + + + + + Indicates if this is a constructor member generated from the de-sugaring of implicit constructor for a class type? + + + + + Indicates if the value is pinned/fixed + + + + + Indicates if this is an F#-defined extension member + + + + + Indicates if this member is an F#-defined dispatch slot. + + + + + Indicates if this is an F#-defined 'new' constructor member + + + + + Indicates whether this value was generated by the compiler. + + Note: this is true for the overrides generated by hash/compare augmentations + + + + + Indicates if this is something compiled into a module, i.e. a user-defined value, an extension member or a compiler-generated value + + + + + Is this represented as a "top level" static binding (i.e. a static field, static member, + instance member), rather than an "inner" binding that may result in a closure. + + This is implied by IsMemberOrModuleBinding, however not vice versa, for two reasons. + Some optimizations mutate this value when they decide to change the representation of a + binding to be IsCompiledAsTopLevel. Second, even immediately after type checking we expect + some non-module, non-member bindings to be marked IsCompiledAsTopLevel, e.g. 'y' in + 'let x = let y = 1 in y + y' (NOTE: check this, don't take it as gospel) + + + + + Indicates if the backing field for a static value is suppressed. + + + + + Indicates if this is a compiler-generated class constructor member + + + + + Get the inline declaration on the value + + + + + Indicates if this is ever referenced? + + + + + - If this is a property then this is 'Foo' + - If this is an implementation of an abstract slot then this is the name of the method implemented by the abstract slot + - If this is an operator then this is '(+)' + + + + + Range of the definition (implementation) of the value, used by Visual Studio + + + + + The parent type or module, if any (None for expression bindings and parameters) + + + + + The name of the method. + - If this is a property then this is 'Foo' + - If this is an implementation of an abstract slot then this is the name of the method implemented by the abstract slot + - If this is an operator then this is 'op_Addition' + + + + + Indicates if this is a 'base' or 'this' value? + + + + + Get the declared attributes for the value + + + + + Get the apparent parent entity for the value, i.e. the entity under with which the + value is associated. For extension members this is the nominal type the member extends. + For other values it is just the actual parent. + + + + + How visible is this value, function or member? + + + + + Set all the data on a value + + + + + Create a new value with empty, unlinked data. Only used during unpickling of F# metadata. + + + + + Create a new value with the given backing data. Only used during unpickling of F# metadata. + + + + + Link a value based on empty, unlinked data to the given data. Only used during unpickling of F# metadata. + + + + + The partial information used to index the methods of all those in a ModuleOrNamespace. + + + + + The full information used to identify a specific overloaded method amongst all those in a ModuleOrNamespace. + + + + + The name of the method in compiled code (with some exceptions where ilxgen.fs decides not to use a method impl) + - If this is a property then this is 'get_Foo' or 'set_Foo' + - If this is an implementation of an abstract slot then this may be a mangled name + - If this is an extension member then this will be a mangled name + - If this is an operator then this is 'op_Addition' + + + + + Custom attributes attached to the value. These contain references to other values (i.e. constructors in types). Mutable to fixup + these value references after copying a collection of values. + + + + + XML documentation signature for the value + + + + + Is the value actually an instance method/property/event that augments + a type, and if so what name does it take in the IL? + MUTABILITY: for unpickle linkage + + + + + XML documentation attached to a value. + MUTABILITY: for unpickle linkage + + + + + How visible is this? + MUTABILITY: for unpickle linkage + + + + + What is the original, unoptimized, closed-term definition, if any? + Used to implement [<ReflectedDefinition>] + + + + + If this field is populated, this is the implementation range for an item in a signature, otherwise it is + the signature range for an item in an implementation + + + + + MUTABILITY: for unpickle linkage + + + + + The full type of the value for the purposes of linking. May be None for non-members, since they can't be overloaded. + + + + + The partial information used to index the value in a ModuleOrNamespace. + + + + + The full information used to identify a specific overloaded method + amongst all those in a ModuleOrNamespace. + + + + + Indicates the total argument count of the member. + + + + + Indicates the logical name of the member. + + + + + Indicates if the member is an override. + + + + + The name of the type with which the member is associated. None for non-member values. + + + + + The partial information used to index the methods of all those in a ModuleOrNamespace. + + + + + Indicates a trait is solved by a 'fake' instance of an operator, like '+' on integers + + + + + ClosedExprSln expr + + Indicates a trait is solved by an erased provided expression + + + + + ILMethSln(ty, extOpt, ilMethodRef, minst) + + Indicates a trait is solved by a .NET method. + ty -- the type and its instantiation + extOpt -- information about an extension member, if any + ilMethodRef -- the method that solves the trait constraint + minst -- the generic method instantiation + + + + + Indicates a trait is solved by an F# anonymous record field. + + + + + FSRecdFieldSln(tinst, rfref, isSetProp) + + Indicates a trait is solved by an F# record field. + tinst -- the instantiation of the declaring type + rfref -- the reference to the record field + isSetProp -- indicates if this is a set of a record field + + + + + FSMethSln(ty, vref, minst) + + Indicates a trait is solved by an F# method. + ty -- the type and its instantiation + vref -- the method that solves the trait constraint + minst -- the generic method instantiation + + + + + Indicates the solution of a member constraint during inference. + + + + + TTrait(tys, nm, memFlags, argtys, rty, colution) + + Indicates the signature of a member constraint. Contains a mutable solution cell + to store the inferred solution of the constraint. + + + + + Get or set the solution of the member constraint during inference + + + + + Get or set the solution of the member constraint during inference + + + + + Get the return type recorded in the member constraint. + + + + + Get the member name associated with the member constraint. + + + + + The specification of a member constraint that must be solved + + + + + Indicates a constraint that a type is .NET unmanaged type + + + + + Indicates a constraint that a type is a delegate from the given tuple of args to the given return type + + + + + Indicates a constraint that a type does not have the Equality(false) attribute, or is not a structural type with this attribute, with special rules for some known structural container types + + + + + Indicates a constraint that a type implements IComparable, with special rules for some known structural container types + + + + + Indicates a constraint that a type is an enum with the given underlying + + + + + Indicates a constraint that a type has a parameterless constructor + + + + + Indicates a constraint that a type is a simple choice between one of the given ground types. Only arises from 'printf' format strings. See format.fs + + + + + Indicates a constraint that a type is a reference type + + + + + Indicates a constraint that a type is a non-Nullable value type + These are part of .NET's model of generic constraints, and in order to + generate verifiable code we must attach them to F# generalized type variables as well. + + + + + Indicates a constraint that a type has a member with the given signature + + + + + Indicates a constraint that a type has a 'null' value + + + + + Indicates a default value for an inference type variable should it be neither generalized nor solved + + + + + Indicates a constraint that a type is a subtype of the given type + + + + + A cached TAST type used when this type variable is used as type. + + + + + An inferred equivalence for a type inference variable. + + + + + The unique stamp of the typar blob. + MUTABILITY: for linking when unpickling + + + + + MUTABILITY: we set the names of generalized inference type parameters to make the look nice for IL code generation + + + + + Indicates if the type variable has a static "head type" requirement, i.e. ^a variables used in FSharp.Core and member constraints. + + + + + The unique stamp of the type parameter + + + + + The inferred equivalence for the type inference variable, if any. + + + + + Indicates if the type variable can be solved or given new constraints. The status of a type variable + generally always evolves towards being either rigid or solved. + + + + + The range of the identifier for the type parameter definition + + + + + The name of the type parameter + + + + + Indicates whether a type variable can be instantiated by types or units-of-measure. + + + + + Indicates if a type variable has been solved. + + + + + Indicates if a type variable has been linked. Only used during unpickling of F# metadata. + + + + + Indicates if the type inference variable was generated after an error when type checking expressions or patterns + + + + + Indicates whether a type variable is erased in compiled .NET IL code, i.e. whether it is a unit-of-measure variable + + + + + Indicates if the type variable is compiler generated, i.e. is an implicit type inference variable + + + + + Indicates that whether this type parameter is a compat-flex type parameter (i.e. where "expr :> tp" only emits an optional warning) + + + + + The identifier for a type parameter definition + + + + + Indicates that whether or not a generic type definition satisfies the equality constraint is dependent on whether this type variable satisfies the equality constraint. + + + + + Indicates if a type parameter is needed at runtime and may not be eliminated + + + + + Indicates the display name of a type variable + + + + + The inferred constraints for the type inference variable, if any + + + + + Indicates that whether or not a generic type definition satisfies the comparison constraint is dependent on whether this type variable satisfies the comparison constraint. + + + + + The declared attributes of the type parameter. Empty for type inference variables and parameters from .NET + + + + + Links a previously unlinked type variable to the given data. Only used during unpickling of F# metadata. + + + + + Sets whether a type variable has a static requirement + + + + + Sets the rigidity of a type variable + + + + + Set whether this type parameter is a compat-flex type parameter (i.e. where "expr :> tp" only emits an optional warning) + + + + + Sets the identifier associated with a type variable + + + + + Sets whether the equality constraint of a type definition depends on this type variable + + + + + Sets whether a type variable is required at runtime + + + + + Adjusts the constraints associated with a type variable + + + + + Sets whether a type variable is compiler generated + + + + + Sets whether the comparison constraint of a type definition depends on this type variable + + + + + Creates a type variable that contains empty data, and is not yet linked. Only used during unpickling of F# metadata. + + + + + Creates a type variable based on the given data. Only used during unpickling of F# metadata. + + + + + Links a previously unlinked type variable to the given data. Only used during unpickling of F# metadata. + + + + + A declared generic type/measure parameter, or a type/measure inference variable. + + + + + The declared attributes of the type parameter. Empty for type inference variables. + + + + + The inferred constraints for the type inference variable + + + + + The documentation for the type parameter. Empty for type inference variables. + MUTABILITY: for linking when unpickling + + + + + MUTABILITY: we set the names of generalized inference type parameters to make the look nice for IL code generation + + + + + Indicates the construct can only be accessed from any code in the given type constructor, module or assembly. [] indicates global scope. + + + + + A set of static methods for constructing types. + + + + + Mutation used during compilation of FSharp.Core.dll + + + + + Get a table of types defined within this module, namespace or type. The + table is indexed by both name and, for generic types, also by mangled name. + + + + + Get a list of types defined within this module, namespace or type. + + + + + Get a list of type and exception definitions defined within this module, namespace or type. + + + + + Get a table of nested module and namespace fragments indexed by demangled name (so 'ListModule' becomes 'List') + + + + + Namespace or module-compiled-as-type? + + + + + Get a list of module and namespace definitions defined within this module, namespace or type. + + + + + Get a table of F# exception definitions indexed by demangled name, so 'FailureException' is indexed by 'Failure' + + + + + Get a list of F# exception definitions defined within this module, namespace or type. + + + + + Get a table of values indexed by logical name + + + + + Get a table of values and members indexed by partial linkage key, which includes name, the mangled name of the parent type (if any), + and the method argument count (if any). + + + + + Compute a table of values and members indexed by logical name. + + + + + Values, including members in F# types in this module-or-namespace-fragment. + + + + + Get a table of entities indexed by both logical name + + + + + Get a table of entities indexed by both logical and compiled names + + + + + Type, mapping mangled name to Tycon, e.g. + + + + + Get a table of the active patterns defined in this module. + + + + + Get a table of types defined within this module, namespace or type. The + table is indexed by both name and generic arity. This means that for generic + types "List`1", the entry (List, 1) will be present. + + + + + Try to find the member with the given linkage key in the given module. + + + + + Return a new module or namespace type with a value added. + + + + + Mutation used in hosting scenarios to hold the hosted types in this module or namespace + + + + + Mutation used during compilation of FSharp.Core.dll + + + + + Return a new module or namespace type with an entity added. + + + + + Indicates that an exception is abstract, i.e. is in a signature file, and we do not know the representation + + + + + Indicates that an exception carries the given record of values + + + + + Indicates that an exception is shorthand for the given .NET exception type + + + + + Indicates that an exception is an abbreviation for the given exception + + + + + If this field is populated, this is the implementation range for an item in a signature, otherwise it is + the signature range for an item in an implementation + + + + + Name/declaration-location of the field + + + + + Attributes attached to generated field + + + + + Attributes attached to generated property + + + + + Indicates the declared visibility of the field, not taking signatures into account + + + + + The default initialization info, for static literals + + + + + Indicates a compiler generated field, not visible to Intellisense or name resolution + + + + + Indicates a volatile field + + + + + Indicates a static field + + + + + The type of the field, w.r.t. the generic parameters of the enclosing type constructor + + + + + XML Documentation signature for the field + + + + + Documentation for the field + + + + + Is the field declared mutable in F#? + + + + + Get or set the XML documentation signature for the field + + + + + Get or set the XML documentation signature for the field + + + + + XML Documentation signature for the field + + + + + Declaration-location of the field + + + + + Attributes attached to generated property + + + + + Name of the field + + + + + The default initialization info, for static literals + + + + + Indicates if the field is zero-initialized + + + + + Indicates a volatile field + + + + + Indicates a static field + + + + + Is the field declared mutable in F#? + + + + + Indicates a compiler generated field, not visible to Intellisense or name resolution + + + + + Name/declaration-location of the field + + + + + The type of the field, w.r.t. the generic parameters of the enclosing type constructor + + + + + Attributes attached to generated field + + + + + Indicates the declared visibility of the field, not taking signatures into account + + + + + This may represent a "field" in either a struct, class, record or union + It is normally compiled to a property. + + + + + Attributes, attached to the generated static method to make instances of the case + + + + + Indicates the declared visibility of the union constructor, not taking signatures into account + + + + + If this field is populated, this is the implementation range for an item in a signature, otherwise it is + the signature range for an item in an implementation + + + + + Name/range of the case + + + + + XML documentation signature for the case + + + + + Documentation for the case + + + + + Return type constructed by the case. Normally exactly the type of the enclosing type, sometimes an abbreviation of it + + + + + Data carried by the case. + + + + + Name of the case in generated IL code. + + + + + The ILX data structure representing the discriminated union. + + + + + The cases contained in the discriminated union. + + + + + The cases of the discriminated union, indexed by name. + + + + + The cases of the discriminated union, in declaration order. + + + + + The fields of the record, indexed by name. + + + + + The fields of the record, in declaration order. + + + + + The fields of the class, struct or enum + + + + + The declared abstract slots of the class, interface or struct + + + + + Indicates whether the type declaration is a class, interface, enum, delegate or struct + + + + + Indicates the type is an enumeration + + + + + Indicates the type is a delegate with the given Invoke signature + + + + + Indicates the type is a struct + + + + + Indicates the type is an interface + + + + + Indicates the type is a class (also used for units-of-measure) + + + + + Indicates the type is generated, but type-relocation is suppressed + + + + + Indicates the type is erased + + + + + A flag read from the provided type and used to compute basic properties of the type definition. + Reading is delayed, since it looks at the .BaseType + + + + + A type read from the provided type and used to compute basic properties of the type definition. + Reading is delayed, since it does an import on the underlying type + + + + + A flag read eagerly from the provided type and used to compute basic properties of the type definition. + + + + + A flag read eagerly from the provided type and used to compute basic properties of the type definition. + + + + + A flag read eagerly from the provided type and used to compute basic properties of the type definition. + + + + + A flag read eagerly from the provided type and used to compute basic properties of the type definition. + + + + + A flag read eagerly from the provided type and used to compute basic properties of the type definition. + + + + + The base type of the type. We use it to compute the compiled representation of the type for erased types. + Reading is delayed, since it does an import on the underlying type + + + + + The underlying System.Type (wrapped as a ProvidedType to make sure we don't call random things on + System.Type, and wrapped as Tainted to make sure we track which provider this came from, for reporting + error messages) + + + + + The parameters given to the provider that provided to this type. + + + + + The information kept about a provided type + + + + + TILObjectReprData(scope, nesting, definition) + + + + + The 'NoRepr' value here has four meanings: + (1) it indicates 'not yet known' during the first 2 phases of establishing type definitions + (2) it indicates 'no representation', i.e. 'type X' in signatures + (3) it is the setting used for exception definitions (!) + (4) it is the setting used for modules and namespaces. + + It would be better to separate the "not yet known" and other cases out. + The information for exception definitions should be folded into here. + + + + + Indicates the representation information for a provided namespace. + + + + + TProvidedTypeExtensionPoint + + Indicates the representation information for a provided type. + + + + + Indicates the type is parameterized on a measure (e.g. float<_>) but erases to some other type (e.g. float) + + + + + Indicates the type is implemented as IL assembly code using the given closed Abstract IL type + + + + + Indicates the type is a type from a .NET assembly without F# metadata. + + + + + Indicates the type is a discriminated union + + + + + Indicates the type is a record + + + + + Indicates the type is a class, struct, enum, delegate or interface + + + + + The information for the contents of a type. Also used for a provided namespace. + + + + + Set to true if the type is determined to be abstract + + + + + Set to true at the end of the scope where proper augmentations are allowed + + + + + Super type, if any + + + + + Interface implementations - boolean indicates compiler-generated + + + + + Properties, methods etc. as lookup table + + + + + Properties, methods etc. in declaration order. The boolean flag for each indicates if the + member is known to be an explicit interface implementation. This must be computed and + saved prior to remapping assembly information. + + + + + True if the type defined an Object.GetHashCode method. In this + case we give a warning if we auto-generate a hash method since the semantics may not match up + + + + + This is the value implementing the auto-generated comparison + semantics if any. It is not present if the type defines its own implementation + of IStructuralEquatable or if the type doesn't implement IComparable implicitly. + + + + + This is the value implementing the auto-generated equality + semantics if any. It is not present if the type defines its own implementation + of Object.Equals or if the type doesn't override Object.Equals implicitly. + + + + + This is the value implementing the auto-generated comparison + semantics if any. It is not present if the type defines its own implementation + of IStructuralComparable or if the type doesn't implement IComparable implicitly. + + + + + This is the value implementing the auto-generated comparison + semantics if any. It is not present if the type defines its own implementation + of IComparable or if the type doesn't implement IComparable implicitly. + + + + + Used during codegen to hold the ILX representation indicating how to access the type + + + + + The stable path to the type, e.g. Microsoft.FSharp.Core.FSharpFunc`2 + + + + + The stable path to the type, e.g. Microsoft.FSharp.Core.FSharpFunc`2 + + + + + This field is used when the 'tycon' is really a module definition. It holds statically nested type definitions and nested modules + + + + + The methods and properties of the type + + + + + The declared representation of the type, i.e. record, union, class etc. + + + + + The declared attributes for the type + + + + + The declaration location for the type constructor + + + + + The name of the type, possibly with `n mangling + + + + + The unique stamp of the "tycon blob". Note the same tycon in signature and implementation get different stamps + + + + + The declared type parameters of the type + + + + + The XML documentation sig-string of the entity, if any, to use to lookup an .xml doc file. This also acts + as a cache for this sig-string computation. + + + + + The XML documentation sig-string of the entity, if any, to use to lookup an .xml doc file. This also acts + as a cache for this sig-string computation. + + + + + The XML documentation of the entity, if any. If the entity is backed by provided metadata + then this _does_ include this documentation. If the entity is backed by Abstract IL metadata + or comes from another F# assembly then it does not (because the documentation will get read from + an XML file). + + + + + Get the union cases and other union-type information for a type, if any + + + + + Get the union cases for a type, if any, as a list + + + + + Get the union cases for a type, if any + + + + + The information about the r.h.s. of a type definition, if any. For example, the r.h.s. of a union or record type. + + + + + Get the value representing the accessibility of the r.h.s. of an F# type definition. + + + + + The kind of the type definition - is it a measure definition or a type definition? + + + + + The logical contents of the entity when it is a type definition. + + + + + Get the type abbreviated by this type definition, if it is an F# type abbreviation definition + + + + + Get the type parameters for an entity that is a type declaration, otherwise return the empty list. + + + + + These two bits represents the on-demand analysis about whether the entity has the IsReadOnly attribute or is otherwise determined to be a readonly struct + + + + + The on-demand analysis about whether the entity has the IsByRefLike attribute + + + + + Get a list of all instance fields for F#-defined record, struct and class fields in this type definition, + excluding compiler-generate fields. + + + + + Get a list of all fields for F#-defined record, struct and class fields in this type definition, + including static fields, but excluding compiler-generate fields. + + + + + A unique stamp for this module, namespace or type definition within the context of this compilation. + Note that because of signatures, there are situations where in a single compilation the "same" + module, namespace or type may have two distinct Entity objects that have distinct stamps. + + + + + The code location where the module, namespace or type is defined. + + + + + Get a blob of data indicating how this type is nested in other namespaces, modules or types. + + + + + Indicates if we have pre-determined that a type definition has a default constructor. + + + + + The logical contents of the entity when it is a module or namespace fragment. + + + + + Gets the immediate members of an F# type definition, excluding compiler-generated ones. + Note: result is alphabetically sorted, then for each name the results are in declaration order + + + + + Gets all immediate members of an F# type definition keyed by name, including compiler-generated ones. + Note: result is a indexed table, and for each name the results are in reverse declaration order + + + + + The name of the namespace, module or type, possibly with mangling, e.g. List`1, List or FailureException + + + + + Indicate if this is a type whose r.h.s. is known to be a union type definition. + + + + + Indicates if this entity is an F# type abbreviation definition + + + + + Indicates if this is an F# type definition whose r.h.s. is known to be a record type definition that is a value type. + + + + + Indicates if this is a struct or enum type definition, i.e. a value type definition + + + + + Indicates if this is an F# type definition whose r.h.s. is known to be a record type definition. + + + + + Indicates if the entity is a provided namespace fragment + + + + + Indicates if the entity is a generated provided type definition, i.e. not erased. + + + + + Indicates if the entity is an erased provided type definition + + + + + Indicates if the entity is a provided type or namespace definition + + + + + Indicates the type prefers the "tycon<a, b>" syntax for display etc. + + + + + Indicates if the entity is a namespace + + + + + Indicates the Entity is actually a module or namespace, not a type definition + + + + + Indicates if the entity is an F# module definition + + + + + Indicates if this is an F# type definition which is one of the special types in FSharp.Core.dll like 'float<_>' which + defines a measure type with a relation to an existing non-measure type as a representation. + + + + + Indicates if the entity is linked to backing data. Only used during unpickling of F# metadata. + + + + + Indicate if this is a type definition backed by Abstract IL metadata. + + + + + Indicates if this is a .NET-defined struct or enum type definition, i.e. a value type definition + + + + + Indicates if this is a .NET-defined enum type definition + + + + + Indicates if this is an F# type definition whose r.h.s. definition is unknown (i.e. a traditional ML 'abstract' type in a signature, + which in F# is called a 'unknown representation' type). + + + + + Indicates if this is an F#-defined struct or enum type definition, i.e. a value type definition + + + + + Indicates if this is an F# type definition whose r.h.s. is known to be some kind of F# object model definition + + + + + Indicates if this is an F#-defined interface type definition + + + + + Indicates if this is an F#-defined enum type definition + + + + + Indicates if this is an F#-defined delegate type definition + + + + + Indicates if this is an F#-defined class type definition + + + + + Indicates if the entity represents an F# exception declaration. + + + + + Indicates if the entity is erased, either a measure definition, or an erased provided type definition + + + + + Indicates if this is an enum type definition + + + + + Indicates if this is an F# type definition which is one of the special types in FSharp.Core.dll which uses + an assembly-code representation for the type, e.g. the primitive array type constructor. + + + + + Gets the immediate interface definitions of an F# type definition. Further interfaces may be supported through class and interface inheritance. + + + + + Gets the immediate interface types of an F# type definition. Further interfaces may be supported through class and interface inheritance. + + + + + The identifier at the point of declaration of the type definition. + + + + + Get the Abstract IL metadata for this type definition, assuming it is backed by Abstract IL metadata. + + + + + Get the Abstract IL scope, nesting and metadata for this + type definition, assuming it is backed by Abstract IL metadata. + + + + + Indicates if we have pre-determined that a type definition has a self-referential constructor using 'as x' + + + + + Gets any implicit hash/equals (with comparer argument) methods added to an F# record, union or struct type definition. + + + + + Gets any implicit hash/equals methods added to an F# record, union or struct type definition. + + + + + Gets any implicit CompareTo (with comparer argument) methods added to an F# record, union or struct type definition. + + + + + Gets any implicit CompareTo methods added to an F# record, union or struct type definition. + + + + + Get the blob of information associated with an F# object-model type definition, i.e. class, interface, struct etc. + + + + + The information about the r.h.s. of an F# exception definition, if any. + + + + + The display name of the namespace, module or type with <_, _, _> added for generic types, plus static parameters if any + + + + + The display name of the namespace, module or type, e.g. List instead of List`1, including static parameters if any + + + + + The display name of the namespace, module or type, e.g. List instead of List`1, and no static parameters + + + + + Demangle the module name, if FSharpModuleWithSuffix is used + + + + + The range in the implementation, adjusted for an item in a signature + + + + + Gets the data indicating the compiled representation of a named type or module in terms of Abstract IL data structures. + + + + + Gets the data indicating the compiled representation of a type or module in terms of Abstract IL data structures. + + + + + Get the cache of the compiled ILTypeRef representation of this module or type. + + + + + The compiled name of the namespace, module or type, e.g. FSharpList`1, ListModule or FailureException + + + + + Get a blob of data indicating how this type is nested inside other namespaces, modules and types. + + + + + Get a blob of data indicating how this type is nested inside other namespaces, modules and types. + + + + + The F#-defined custom attributes of the entity, if any. If the entity is backed by Abstract IL or provided metadata + then this does not include any attributes from those sources. + + + + + Get a list of all instance fields for F#-defined record, struct and class fields in this type definition. + including hidden fields from the compilation of implicit class constructions. + + + + + Gets all implicit hash/equals/compare methods added to an F# record, union or struct type definition. + + + + + Get a list of fields for all the F#-defined record, struct and class fields in this type definition, including + static fields, 'val' declarations and hidden fields from the compilation of implicit class constructions. + + + + + Get an array of fields for all the F#-defined record, struct and class fields in this type definition, including + static fields, 'val' declarations and hidden fields from the compilation of implicit class constructions. + + + + + Get a table of fields for all the F#-defined record, struct and class fields in this type definition, including + static fields, 'val' declarations and hidden fields from the compilation of implicit class constructions. + + + + + Get the value representing the accessibility of an F# type definition or module. + + + + + Get the type parameters for an entity that is a type declaration, otherwise return the empty list. + + Lazy because it may read metadata, must provide a context "range" in case error occurs reading metadata. + + + + + Sets the structness of a record or union type definition + + + + + Set the on-demand analysis about whether the entity has the IsReadOnly attribute or is otherwise determined to be a readonly struct + + + + + Set the on-demand analysis about whether the entity has the IsByRefLike attribute + + + + + Set the custom attributes on an F# type definition. + + + + + Create a new entity with empty, unlinked data. Only used during unpickling of F# metadata. + + + + + Create a new entity with the given backing data. Only used during unpickling of F# metadata. + + + + + Link an entity based on empty, unlinked data to the given data. Only used during unpickling of F# metadata. + + + + + Get a union case of a type by name + + + + + Get a field by name. + + + + + Get a field by index in definition order + + + + + Represents a type definition, exception definition, module definition or namespace definition. + + + + + Field used when the 'tycon' is really an exception definition + + + + + Indicates how visible is the entity is. + + + + + The declared accessibility of the representation, not taking signatures into account + + + + + If non-None, indicates the type is an abbreviation for another type. + + + + + The XML document signature for this entity + + + + + The declared documentation for the type or module + + + + + If this field is populated, this is the implementation range for an item in a signature, otherwise it is + the signature range for an item in an implementation + + + + + The name of the type, possibly with `n mangling + + + + + String 'Module' off an F# module name, if FSharpModuleWithSuffix is used + + + + + The information ILXGEN needs about the location of an item + + + + + A public path records where a construct lives within the global namespace + of a CCU. + + + + + Indicates that a 'module' is really a namespace + + + + + Indicates that a module is compiled to a class with the same name as the original module + + + + + Indicates that a module is compiled to a class with the "Module" suffix added. + + + + + These two bits represents the on-demand analysis about whether the entity has the IsReadOnly attribute or is otherwise determined to be a readonly struct + + + + + These two bits represents the on-demand analysis about whether the entity has the IsByRefLike attribute + + + + + This bit is reserved for us in the pickle format, see pickle.fs, it's being listed here to stop it ever being used for anything else + + + + + Get the flags as included in the F# binary metadata + + + + + This bit represents a F# record that is a value type, or a struct record. + + + + + Indicates the type prefers the "tycon<a, b>" syntax for display etc. + + + + + Indicates the Entity is actually a module or namespace, not a type definition + + + + + Adjust the on-demand analysis about whether the entity has the IsReadOnly attribute or is otherwise determined to be a readonly struct + + + + + Adjust the on-demand analysis about whether the entity has the IsByRefLike attribute + + + + + Encode entity flags into a bit field. We leave lots of space to allow for future expansion. + + + + + Indicates if the type variable has a static "head type" requirement, i.e. ^a variables used in FSharp.Core and member constraints. + + + + + Indicates if the type variable can be solved or given new constraints. The status of a type variable + generally always evolves towards being either rigid or solved. + + + + + Get the flags as included in the F# binary metadata. We pickle this as int64 to allow for future expansion + + + + + Indicates whether a type variable can be instantiated by types or units-of-measure. + + + + + Indicates if the type inference variable was generated after an error when type checking expressions or patterns + + + + + Indicates if the type variable is compiler generated, i.e. is an implicit type inference variable + + + + + Indicates that whether this type parameter is a compat-flex type parameter (i.e. where "expr :> tp" only emits an optional warning) + + + + + Indicates that whether or not a generic type definition satisfies the equality constraint is dependent on whether this type variable satisfies the equality constraint. + + + + + Indicates if a type parameter is needed at runtime and may not be eliminated + + + + + Indicates that whether or not a generic type definition satisfies the comparison constraint is dependent on whether this type variable satisfies the comparison constraint. + + + + + Encode typar flags into a bit field + + + + + Indicates the type parameter derives from an '_' anonymous type + For units-of-measure, we give a warning if this gets solved to '1' + + + + + Indicates the type parameter is an inference variable may be solved + + + + + Indicates we give a warning if the type parameter is ever solved + + + + + Indicates the type parameter can't be solved, but the variable is not set to "rigid" until after inference is complete + + + + + Indicates the type parameter can't be solved + + + + + Indicates if the type variable can be solved or given new constraints. The status of a type variable + evolves towards being either rigid or solved. + + + + + Represents the kind of a type parameter + + + + + Get the flags as included in the F# binary metadata + + + + + Flags on values + + + + + Indicates the 'this' value specified in a memberm e.g. 'x' in 'member x.M() = 1' + + + + + Indicates a normal value + + + + + Indicates the value called 'base' available for calling base class members + + + + + Indicates a ref-cell holding 'this' or the implicit 'this' used throughout an + implicit constructor to access and set values + + + + + Indicates the type parameter is needed at runtime and may not be eliminated + + + + + Indicates the type parameter is not needed at runtime and may be eliminated + + + + + Indicates if a type parameter is needed at runtime and may not be eliminated + + + + + The normal value for this flag when the value is not within its recursive scope + + + + + Set while the value is within its recursive scope. The flag indicates if the value has been eagerly generalized and accepts generic-recursive calls + + + + + A flag associated with values that indicates whether the recursive scope of the value is currently being processed, and + if the value has been generalized or not as yet. + + + + + Indicates the value must never be inlined by the optimizer + + + + + Indicates the value may optionally be inlined by the optimizer + + + + + Indicates the value is inlined but the .NET IL code for the function still exists, e.g. to satisfy interfaces on objects, but that it is also always inlined + + + + + Indicates the value must always be inlined and no .NET IL code is generated for the value/function + + + + + Returns true if the implementation of a value must always be inlined + + + + + Unique name generator for stamps attached to lambdas and object expressions + + + + + Combine a list of ModuleOrNamespaceType's making up the description of a CCU. checking there are now + duplicate modules etc. + + + + + Create a Val based on an existing one using the function 'f'. + We require that we be given the parent for the new Val. + + + + + Create a module Tycon based on an existing one using the function 'f'. + We require that we be given the parent for the new module. + We pass the new module to 'f' in case it needs to reparent the + contents of the module. + + + + + Create a tycon based on an existing one using the function 'f'. + We require that we be given the new parent for the new tycon. + We pass the new tycon to 'f' in case it needs to reparent the + contents of the tycon. + + + + + Create the new contents of an overall assembly + + + + + Create a new Val object + + + + + Create a new TAST RecdField node for an F# class, struct or record field + + + + + Create a new TAST Entity node for an F# exception definition + + + + + Given (newPath, oldPath) replace oldPath by newPath in the TAccess. + + + + + Primitive routine to compare two ValRef's for equality. On the whole value identity is not particularly + significant in F#. However it is significant for + (a) Active Patterns + (b) detecting uses of "special known values" from FSharp.Core.dll, such as 'seq' + and quotation splicing + + Note this routine doesn't take type forwarding into account + + + + + Primitive routine to compare two UnionCaseRef's for equality + + + + + Primitive routine to compare two EntityRef's for equality + This takes into account the possibility that they may have type forwarders + + + + + This predicate tests if non-local resolution paths are definitely known to resolve + to different entities. All references with different named paths always resolve to + different entities. Two references with the same named paths may resolve to the same + entities even if they reference through different CCUs, because one reference + may be forwarded to another via a .NET TypeForwarder. + + + + + From Ref_private to Ref_nonlocal when exporting data. + + + + + From Ref_private to Ref_nonlocal when exporting data. + + + + + Make a reference to a union case for type in a module or namespace + + + + + For dereferencing in the middle of a pattern + + + + + Equality on CCU references, implemented as reference equality except when unresolved + + + + + Equality on value specs, implemented as reference equality + + + + + Equality on type variables, implemented as reference equality. This should be equivalent to using typarEq. + + + + + Generic types can be accessed either by 'List' or 'List`1'. This lists both keys. The second form should really be deprecated. + + + + + Unique name generator for stamps attached to to val_specs, tycon_specs etc. + + + + + Metadata on values (names of arguments etc. + + + + + Memoization table to help minimize the number of ILSourceDocument objects we create + + + + + Are we assuming all code gen is for F# interactive, with no static linking + + + + + For debugging + + + + + For debugging + + + + + For debugging + + + + + For debugging + + + + + Represents an intrinsic value from FSharp.Core known to the compiler + + + + + Defines the global environment for all type checking. + + The environment (TcGlobals) are well-known types and values are hard-wired + into the compiler. This lets the compiler perform particular optimizations + for these types and values, for example emitting optimized calls for + comparison and hashing functions. + + + + + Represents metadata extracted from a nominal type + + + + + A set of function parameters (visitor) for folding over expressions + + + + + The empty table representing no hiding + + + + + A set of tables summarizing the items hidden by a signature + + + + + The list of corresponding modules, namespacea and type definitions + + + + + The list of corresponding values + + + + + The empty table + + + + + The remapping that corresponds to a module meeting its signature + and also report the set of tycons, tycon representations and values hidden in the process. + + + + + OnlyCloneExprVals is a nasty setting to reuse the cloning logic in a mode where all + Tycon and "module/member" Val objects keep their identity, but the Val objects for all Expr bindings + are cloned. This is used to 'fixup' the TAST created by tlr.fs + + This is a fragile mode of use. It's not really clear why TLR needs to create a "bad" expression tree that + reuses Val objects as multiple value bindings, and its been the cause of several subtle bugs. + + + + + Indicate what should happen to value definitions when copying expressions + + + + + A flag to govern whether arity inference should be type-directed or syntax-directed when + inferring an arity from a lambda expression. + + + + + Represents a combination of substitutions/instantiations where things replace other things during remapping + + + + + Represents an instantiation where value references replace other value references + + + + + Represents an instantiation where type definition references replace other type definition references + + + + + Represents an instantiation where types replace type parameters + + + + + The empty map + + + + + Make a new map, containing a entries for the given type definitions + + + + + Fetch the entries for the given type definition + + + + + Make a new map, containing a new entry for the given type definition + + + + + Maps TyconRef to list of T based on stamp keys + + + + + Get the entry for the given type definition + + + + + Determine if the map is empty + + + + + The empty map + + + + + Try to find the entry for the given type definition + + + + + Remove the entry for the given type definition, if any + + + + + Make a new map, containing entries for the given type definitions + + + + + Determine is the map contains an entry for the given type definition + + + + + Make a new map, containing a new entry for the given type definition + + + + + Maps TyconRef to T based on stamp keys + + + + + Get the entry for the given type parameter + + + + + The empty map + + + + + Try to find the entry for the given type parameter + + + + + Determine is the map contains an entry for the given type parameter + + + + + Make a new map, containing a new entry for the given type parameter + + + + + Maps type parameters to entries based on stamp keys + + + + + Maps Val's to list of T based on stamp keys + + + + + Mutable data structure mapping Val's to T based on stamp keys + + + + + Maps Val to T, based on stamps + + + + + TypeScheme (generalizedTypars, tauTy) + + generalizedTypars -- the truly generalized type parameters + tauTy -- the body of the generalized type. A 'tau' type is one with its type parameters stripped off. + + + + + Finish the targets + + + + + Build the overall expression + + + + + Add a new destination target + + + + + Add a new destination target that is an expression result + + + + + Create a new builder + + + + + Build decision trees imperatively + + + + + Determines types that are potentially known to satisfy the 'comparable' constraint and returns + a set of residual types that must also satisfy the constraint + + + + + Build for loops + + + + + Check if the type is a byref-like but not a byref. + + + + + returns Some(assemblyName) for success + + + + + Try to find the AttributeUsage attribute, looking for the value of the AllowMultiple named parameter + + + + + Try to find a specific attribute on a type definition + + + + + Try to find a specific attribute on a type definition, where the attribute accepts a bool argument. + + + + + Try to find a specific attribute on a type definition, where the attribute accepts a string argument. + + This is used to detect the 'DefaultMemberAttribute' and 'ConditionalAttribute' attributes (on type definitions) + + + + + Matches any byref type, yielding the target type + + + + + An active pattern to transform System.Nullable types to their input, otherwise leave the input unchanged + + + + + An active pattern to match System.Nullable types + + + + + An active pattern to determine if a type is a nominal type, possibly instantiated + + + + + For "type Class as self", 'self' is fixed up after initialization. To support this, + it is converted behind the scenes to a ref. This function strips off the ref and + returns the underlying type. + + + + + Determine if a type is a struct, record or union type + + + + + Determine if a type is an enum type + + + + + Determine if a type is a class type + + + + + Determine if a type is an unmanaged type + + + + + Determine if a type is a struct type + + + + + If the input type is an enum type, then convert to its underlying type, otherwise return the input type + + + + + Determine the underlying type of an enum type (normally int32) + + + + + Determine if a type is a ComInterop type + + + + + Determine if a type is a sealed type + + + + + Determine if a type is a FSharpRef type + + + + + Determine if a type is an interface type + + + + + Determine if a type is a delegate type + + + + + Determine if a reference to a type definition is an interface type + + + + + Get the rank of an array type + + + + + Get the element type of an array type + + + + + Determine if a type is the System.Void type + + + + + Determine if a type is the System.Object type + + + + + Determine if a type is the F# unit type + + + + + Determine the rank of one of the artifical type definitions used for array types + + + + + Check if a type definition is one of the artifical type definitions used for array types of different ranks + + + + + Build an array type of the given rank + + + + + Get the element type of an F# list type + + + + + Get the element type of an array type + + + + + Determine if a type is a single-dimensional array type + + + + + Determine if a type is any kind of array type + + + + + Determine if a type is a nominal .NET type + + + + + Determine if a type is an F# list type + + + + + Determine if a type is the System.String type + + + + + Extract metadata from a type + + + + + Extract metadata from a type definition + + + + + Build an PrintFormat type + + + + + Build an Lazy type + + + + + Build an IObserver type + + + + + Build an IObservable type + + + + + Build an IEvent type + + + + + Take apart an IDelegateEvent type + + + + + Determine if a type is an IDelegateEvent type + + + + + Try to take apart a System.Linq.Expression type + + + + + Take apart a System.Linq.Expression type + + + + + Determine if a type is a System.Linq.Expression type + + + + + Take apart a System.Nullable type + + + + + Try to take apart a System.Nullable type + + + + + Determine is a type is a System.Nullable type + + + + + Try to take apart an option type + + + + + Take apart an option type + + + + + Determine if a type is an option type + + + + + Build a single-dimensional array type + + + + + Build a 'voidptr' type + + + + + Build a nativeptr type + + + + + Fold over all the expressions in an expression + + + + + Fold over all the expressions in an implementation file + + + + + The empty set of actions for folding over expressions + + + + + COmbine two static-resolution requirements on a type parameter + + + + + Make an application expression, doing beta reduction by introducing let-bindings + + + + + Given a lambda expression, adjust it to have be one or two lambda expressions (fun a -> (fun b -> ...)) + where the first has the given arity. + + + + + Given a lambda expression taking multiple variables, build a corresponding lambda taking a tuple + + + + + Work out what things on the right-han-side of a 'let rec' recursive binding need to be fixed up + + + + + Make a 'match' expression without applying any peep-hole optimizations. + + + + + Make a 'match' expression applying some peep-hole optimizations along the way, e.g to + pre-decide the branch taken at compile-time. + + + + + Accumulate the targets actually used in a decision graph (for reporting warnings) + + + + + Build an exression representing the read of an instance class or record field. + First take the address of the record expression if it is a struct. + + + + + Build an expression to take the address of a local + &localv + + + + + Build an expression to dereference a local pointer + *localv_ptr + + + + + Build an expression to mutate the contents of a local pointer + *localv_ptr = e + + + + + Build an expression to mutate a local + localv <- e + + + + + Build the application of a generic construct to a set of type arguments. + Reduce the application via substitution if the function value is a typed lambda expression. + + + + + Build the application of a (possibly generic, possibly curried) function value to a set of type and expression arguments. + Reduce the application via let-bindings if the function value is a lambda expression. + + + + + Build the application of a (possibly generic, possibly curried) function value to a set of type and expression arguments + + + + + Adjust marks in expressions, replacing all marks by thegiven mark. + Used when inlining. + + + + + Determine if a record field is hidden by a signature + + + + + Determine if a member, function or value is hidden by a signature + + + + + Determine if the representation of a type definition is hidden by a signature + + + + + Determine if a type definition is hidden by a signature + + + + + Make a remapping table for viewing a module or namespace 'from the outside' + + + + + Make the substitution (remapping) table for viewing a module or namespace 'from the outside' + + Given the top-most signatures constrains the public compilation units + of an assembly, compute a remapping that converts local references to non-local references. + This remapping must be applied to all pickled expressions and types + exported from the assembly. + + + + + Given a value definition, try to produce a reference to that value. Fails for local values. + + + + + Given a namespace, module or type definition, try to produce a reference to that entity. + + + + + Given an implementation, fetch its recorded signature + + + + + Wrap one module or namespace definition in a 'module M = ..' outer wrapper + + + + + Wrap one module or namespace definition in a 'namespace N' outer wrapper + + + + + Wrap one module or namespace implementation in a 'namespace N' outer wrapper + + + + + Compute the hiding information that corresponds to the hiding applied at an assembly boundary + + + + + Compute the remapping information implied by an explicit signature being given for an inferred signature + + + + + Compute the remapping information implied by a signature being inferred for a particular implementation + + + + + Instantiate the generic type parameters in an expression, building a new one + + + + + Instantiate the generic type parameters in a method slot signature, building a new one + + + + + Copy a method slot signature, including new generic type parameters if the slot signature represents a generic method + + + + + Copy an entire implementation file using the given copying flags + + + + + Copy an entire expression using the given copying flags + + + + + Copy an entire module or namespace type using the given copying flags + + + + + Remap a (possible generic) type using the given remapping substitution + + + + + Remap an attribute using the given remapping substitution + + + + + Remap an expression using the given remapping substitution + + + + + Remap a reference to a value using the given remapping substitution + + + + + Remap a reference to a record field using the given remapping substitution + + + + + Remap a reference to a union case using the given remapping substitution + + + + + Remap a reference to a type definition using the given remapping substitution + + + + + Mutate a value to indicate it should be considered a local rather than a module-bound definition + + + + + Given a lambda binding, extract the ValReprInfo for its arguments and other details + + + + + Given a lambda expression, extract the ValReprInfo for its arguments and other details + + + + + Given a (curried) lambda expression, pull off its arguments + + + + + Compute the type of an expression from the expression itself + + + + + Check if a set of free variables are all public + + + + + Check if a set of free type variables are all public + + + + + Get the free variables in the right hand side of a binding. + + + + + Get the free variables in an expression. + + + + + Get the free variables in a module definition. + + + + + A unique qualified name for each type definition, used to qualify the names of interface implementation methods + + + + + Return the full text for an item as we want it displayed to the user as a fully qualified entity + + + + + Returns (parentTypars,memberParentTypars,memberMethodTypars,memberToParentInst,tinst) + + + + + Returns (parentTypars,memberParentTypars,memberMethodTypars,memberToParentInst,tinst) + + + + + Returns (parentTypars,memberParentTypars,memberMethodTypars,memberToParentInst,tinst) + + + + + Try to get a TyconRef for a type without erasing type abbreviations + + + + + See through F# exception abbreviations + + + + + set bool to 'true' to allow shortcutting of type parameter equation chains during stripping + + + + + Equality for value references + + + + + Equality for type definition references + + + + + An ordering for type parameters, based on stamp + + + + + An ordering for record fields, based on stamp + + + + + An ordering for type definitions, based on stamp + + + + + An ordering for value definitions, based on stamp + + + + + Take the address of an expression, or force it into a mutable local. Any allocated + mutable local may need to be kept alive over a larger expression, hence we return + a wrapping function that wraps "let mutable loc = Expr in ..." around a larger + expression. + + + + + Helper to take the address of an expression + + + + + If it is a tuple type, ensure it's outermost type is a .NET tuple type, otherwise leave unchanged + + + + + Evaluate the AnonRecdTypeInfo to work out if it is a struct or a ref. + + + + + Evaluate the TupInfo to work out if it is a struct or a ref. Currently this is very simple + but TupInfo may later be used carry variables that infer structness. + + + + + Make a TAST expression representing getting an item fromm a tuple + + + + + Convert from F# tuple creation expression to .NET tuple creation expressions + + + + + Convert from F# tuple types to .NET tuple types. + + + + + Get a TyconRef for a .NET tuple type + + + + + Check if a TyconRef is for a .NET tuple type. Currently this includes Tuple`1 even though + that' not really part of the target set of TyconRef used to represent F# tuples. + + + + + The number of fields in the largest tuple before we start encoding, i.e. 7 + + + + + The largest tuple before we start encoding, i.e. 7 + + + + + Make an expression that gets the address of an element in an array + + + + + Make an expression that sets an instance field in an F# exception value + + + + + Make an expression that gets an instance field from an F# exception value + + + + + Like mkUnionCaseFieldGetUnprovenViaExprAddr, but for struct-unions, the input should be a copy of the expression. + + + + + Build a 'TOp.UnionCaseFieldSet' expression. For ref-unions, the input expression has 'TType_ucase', which is + an F# compiler internal "type" corresponding to the union case. For struct-unions, + the input should be the address of the expression. + + + + + Build a 'TOp.UnionCaseFieldGetAddr' expression for a field of a union when we've already determined the value to be a particular union case. For ref-unions, + the input expression has 'TType_ucase', which is an F# compiler internal "type" corresponding to the union case. For struct-unions, + the input should be the address of the expression. + + + + + Build a 'TOp.UnionCaseFieldGetAddr' expression for a field of a union when we've already determined the value to be a particular union case. For ref-unions, + the input expression has 'TType_ucase', which is an F# compiler internal "type" corresponding to the union case. For struct-unions, + the input should be the address of the expression. + + + + + Build a 'TOp.UnionCaseFieldGet' expression for something we've already determined to be a particular union case. For ref-unions, + the input expression has 'TType_ucase', which is an F# compiler internal "type" corresponding to the union case. For struct-unions, + the input should be the address of the expression. + + + + + Make a 'TOp.UnionCaseProof' expression, which proves a union value is over a particular case (used only for ref-unions, not struct-unions) + + + + + Make an expression that gets the tag of a union value (via the address of the value if it is a struct) + + + + + Make an expression that sets an instance the field of a record or class (via the address of the value if it is a struct) + + + + + Make an expression that gets the address of a static field in a record or class + + + + + Make an expression that sets a static field in a record or class + + + + + Make an expression that gets a static field from a record or class + + + + + Make an expression that gets the address of an instance field from a record or class (via the address of the value if it is a struct) + + + + + Make an expression that gets an instance field from a record or class (via the address of the value if it is a struct) + + + + + Make an expression that gets an item from an anonymous record (via the address of the value if it is a struct) + + + + + Make an expression that gets an item from an anonymous record + + + + + Make an expression that gets an item from a tuple + + + + + Make an expression that re-raises an exception via a library call + + + + + Make an expression that re-raises an exception + + + + + Make an expression that coerces one expression to another type + + + + + Make an expression that is IL assembly code + + + + + Make an expression that constructs an exception value + + + + + Make an expression that constructs a union case, e.g. 'Some(expr)' + + + + + Make an out-byref type with an out kind parameter + + + + + Make a in-byref type with a in kind parameter + + + + + Make a byref type with a in/out kind inference parameter + + + + + Make a byref type + + + + + Make the expression corresponding to 'expr1 || expr2' + + + + + Make the expression corresponding to 'expr1 && expr2' + + + + + Test if the type parameter is one of those being generalized by a type scheme. + + + + + Make the right-hand side of a generalized binding, incorporating the generalized generic parameters from the type + scheme into the right-hand side as type generalizations. + + + + + Make a let-rec expression that locally binds values to expressions where self-reference back to the values is possible. + + + + + Make a set of bindings that bind values to expressions in an "invisible" way. + Invisible bindings are not given a sequence point and should not have side effects. + + + + + Make a binding that binds a value to an expression in an "invisible" way. + Invisible bindings are not given a sequence point and should not have side effects. + + + + + Make a let-expression that locally binds a value to an expression in an "invisible" way. + Invisible bindings are not given a sequence point and should not have side effects. + + + + + Make a let-expression that locally binds a compiler-generated value to an expression, where the expression + is returned by the given continuation. Compiler-generated bindings do not give rise to a sequence point in debugging. + + + + + Make a let-expression that locally binds a compiler-generated value to an expression. + Compiler-generated bindings do not give rise to a sequence point in debugging. + + + + + Make a set of bindings that bind compiler generated values to corresponding expressions. + Compiler-generated bindings do not give rise to a sequence point in debugging. + + + + + Make a binding that binds a function value to a lambda taking multiple arguments + + + + + Build a user-level let expression + + + + + Build a user-level value sequence of let bindings + + + + + Build a user-level value sequence of let bindings + + + + + Build a user-level let-binding + + + + + Build a user-level value binding + + + + + Build a 'try/finally' expression + + + + + Build a 'try/with' expression + + + + + Build a 'for' loop expression + + + + + Build a 'while' loop expression + + + + + Build a lambda expression that corresponds to the implementation of a member + + + + + Build an iterated generic (type abstraction + tupled+curried) lambda expression + + + + + Build an iterated (tupled+curried) lambda expression + + + + + Build an iterated (curried) lambda expression + + + + + Build an type-chose expression, indicating that a local free choice of a type variable + + + + + Build an object expression + + + + + Build a generic lambda expression (type abstraction) + + + + + Build a lambda expression taking a single value + + + + + Rebuild a lambda during an expression tree traversal + + + + + Build a lambda expression taking multiple values + + + + + Make a new mutable compiler-generated local value, 'let' bind it to an expression + 'invisibly' (no sequence point etc.), and build an expression to reference it + + + + + Make a new mutable compiler-generated local value and build an expression to reference it + + + + + Make a new compiler-generated local value and build an expression to reference it + + + + + Make a new local value and build an expression to reference it + + + + + Build an expression corresponding to the use of a reference to a value + + + + + Build an expression corresponding to the use of a value + Note: try to use exprForValRef or the expression returned from mkLocal instead of this. + + + + + Build an if-then statement + + + + + Build a conditional expression that checks for non-nullness + + + + + Build a conditional expression + + + + + Build a conditional expression + + + + + Add an if-then-else boolean conditional node into a decision tree + + + + + Look for a use of an F# value, possibly including application of a generic thing to a set of type arguments + + + + + Get the values for a set of bindings + + + + + Ignore 'Expr.Link' in an expression + + + + + Module publication, used while compiling fslib. + + + + + Get the curried type corresponding to a lambda + + + + + Get the curried type corresponding to a lambda + + + + + Get the natural type of a single argument amongst a set of curried arguments + + + + + Build a curried function type + + + + + Build a type-forall anonymous generic type if necessary + + + + + Build a function type + + + + + Build a function type + + + + + Reduce a type to its more anonical form subject to an erasure flag, inference equations and abbreviations + + + + + Check the equivalence of two units-of-measure + + + + + Check the equivalence of two types + + + + + Check the equivalence of two types up to an erasure flag + + + + + An exception representing a warning for a defensive copy of an immutable struct + + + + + Debug layout for class and record fields + + + + + Debug layout for a list of implementation files + + + + + Debug layout for an implementation file + + + + + Debug layout for a decision tree + + + + + Debug layout for a type definition + + + + + Debug layout for an expression + + + + + Debug layout for a binding of an expression to a value + + + + + Debug layout for the type of a value + + + + + Debug layout for a module or namespace definition + + + + + Debug layout for the type signature of a module or namespace definition + + + + + Debug layout for a method slot signature + + + + + Debug layout for a type + + + + + Debug layout for a set of type parameters + + + + + Debug layout for a type parameter + + + + + Debug layout for a trait constraint + + + + + Debug layout for a type parameter definition + + + + + Debug layout for a value definition + + + + + Debug layout for an integer + + + + + Debug layout for an value definition at its binding site + + + + + Debug layout for a reference to a union case + + + + + Debug layout for a reference to a value + + + + + Convert an expression to a string for debugging purposes + + + + + Convert a type to a string for debugging purposes + + + + + A global flag indicating whether debug output should include ranges + + + + + Layout for internal compiler debugging purposes + + + + + Utilities used in simplifying types for visual presentation + + + + + Defines derived expression manipulation and construction functions. + + + + + A function to read a value from a given state + + + + + The type of state unpicklers read from + + + + + A function to pickle a value into a given stateful writer + + + + + The type of state written to by picklers + + + + + The assumptions that need to be fixed up + + + + + The data that uses a collection of CcuThunks internally + + + + + Like Fixup but loader may return None, in which case there is no fixup. + + + + + Represents deserialized data with a dangling set of CCU fixup thunks indexed by name + + + + + Deserialize an arbitrary object which may have holes referring to other compilation units + + + + + Deserialize a TAST description of a compilation unit + + + + + Deserialize a TAST type + + + + + Deserialize a TAST expression + + + + + Deserialize a TAST union case reference + + + + + Deserialize a TAST type reference + + + + + Deserialize a TAST value reference + + + + + Deserialize a TAST constant + + + + + Deserialize a namemap + + + + + Deserialize an array of values + + + + + Deserialize a tuple + + + + + Deserialize a tuple + + + + + Deserialize a tuple + + + + + Deserialize a lazy value (eagerly) + + + + + Deserialize a string + + + + + Deserialize an integer + + + + + Deserialize a bool + + + + + Deserialize a byte + + + + + Serialize an arbitrary object using the given pickler + + + + + Serialize a TAST description of a compilation unit + + + + + Serialize a TAST type + + + + + Serialize a TAST expression + + + + + Serialize a TAST union case reference + + + + + Serialize a TAST type or entity reference + + + + + Serialize a TAST value reference + + + + + Serialize a TAST constant + + + + + Serialize a namemap of data + + + + + Serialize an array of data + + + + + Serialize a tuple of data + + + + + Serialize a tuple of data + + + + + Serialize a tuple of data + + + + + Serialize a lazy value (eagerly) + + + + + Serialize a string + + + + + Serialize an integer + + + + + Serialize a boolean value + + + + + Serialize a byte + + + + + Defines the framework for serializing and de-serializing TAST data structures as binary blobs for the F# metadata format. + + + + + The TcGlobals for the import context + + + + + The AssemblyLoader for the import context + + + + + Represents a context used for converting AbstractIL .NET and provided types to F# internal compiler data structures. + Also cache the conversion of AbstractIL ILTypeRef nodes, based on hashes of these. + + There is normally only one ImportMap for any assembly compilation, though additional instances can be created + using tcImports.GetImportMap() if needed, and it is not harmful if multiple instances are used. The object + serves as an interface through to the tables stored in the primary TcImports structures defined in CompileOps.fs. + + + + + Record a root for a [<Generate>] type to help guide static linking & type relocation + + + + + Get a flag indicating if an assembly is a provided assembly, plus the + table of information recording remappings from type names in the provided assembly to type + names in the statically linked, embedded assembly. + + + + + Resolve an Abstract IL assembly reference to a Ccu + + + + + Represents an interface to some of the functionality of TcImports, for loading assemblies + and accessing information about generated provided assemblies. + + + + + Import the type forwarder table for an IL assembly + + + + + Import an IL assembly as a new TAST CCU + + + + + Import a set of Abstract IL generic parameter specifications as a list of new F# generic parameters. + + + + + Import a provided method reference as an Abstract IL method reference + + + + + Import a provided type as an AbstractIL type + + + + + Import a provided type reference as an F# type TyconRef + + + + + Import a provided type as an F# type. + + + + + Pre-check for ability to import an IL type as an F# type. + + + + + Import an IL type as an F# type. + + + + + Pre-check for ability to import a reference to a type definition, given an AbstractIL ILTypeRef, with caching + + + + + Import a reference to a type definition, given an AbstractIL ILTypeRef, with caching + + + + + Functions to import .NET binary metadata as TAST objects + + + + + Represents the information about the compiled form of a method signature. Used when analyzing implementation + relations between members and abstract slots. + + + + + An F# use of an event backed by provided metadata + + + + + An F# use of an event backed by .NET metadata + + + + + An F# use of an event backed by F#-declared metadata + + + + + Get the intra-assembly XML documentation for the property. + + + + + Get the TcGlobals associated with the object + + + + + Get the 'remove' method associated with an event + + + + + Indicates if the enclosing type for the event is a value type. + + For an extension event, this indicates if the event extends a struct type. + + + + + Indicates if this property is static. + + + + + Indicates if this is an extension member + + + + + Indicates if this event has an associated XML comment authored in this assembly. + + + + + Get the logical name of the event. + + + + + Get the declaring type or module holding the method. + Note that C#-style extension properties don't exist in the C# design as yet. + If this is an F#-style extension method it is the logical module + holding the value for the extension method. + + + + + Try to get an arbitrary F# ValRef associated with the member. This is to determine if the member is virtual, amongst other things. + + + + + Get the enclosing type of the event. + + If this is an extension member, then this is the apparent parent, i.e. the type the event appears to extend. + + + + + Get the enclosing type of the method info, using a nominal type for tuple types + + + + + Get the 'add' method associated with an event + + + + + Get the delegate type associated with the event. + + + + + Test whether two event infos have the same underlying definition. + Must be compatible with ItemsAreEffectivelyEqual relation. + + + + + Calculates a hash code of event info (similar as previous) + Must be compatible with ItemsAreEffectivelyEqual relation. + + + + + Describes an F# use of an event + + + + + Get the declaring type of the event as an ILTypeRef + + + + + Get the ILMethInfo describing the 'remove' method associated with the event + + + + + Get the raw Abstract IL metadata for the event + + + + + Get the name of the event + + + + + Indicates if the property is static + + + + + Get the declaring IL type of the event as an ILTypeInfo + + + + + Get the enclosing ("parent"/"declaring") type of the field. + + + + + Get the ILMethInfo describing the 'add' method associated with the event + + + + + Describes an F# use of an event backed by Abstract IL metadata + + + + + An F# use of a property backed by provided metadata + + + + + An F# use of a property backed by Abstract IL metadata + + + + + An F# use of a property backed by F#-declared metadata + + + + + Get the intra-assembly XML documentation for the property. + + + + + Get the TcGlobals associated with the object + + + + + Get a MethInfo for the 'setter' method associated with the property + + + + + Get the logical name of the property. + + + + + True if the getter (or, if absent, the setter) is a virtual method + + + + + Indicates if the enclosing type for the property is a value type. + + For an extension property, this indicates if the property extends a struct type. + + + + + Indicates if this property is static. + + + + + Indicates if the property is logically a 'newslot', i.e. hides any previous slots of the same name. + + + + + Indicates if this property is an indexer property, i.e. a property with arguments. + + + + + Indicates if this is an F# property compiled as a CLI event, e.g. a [<CLIEvent>] property. + + + + + Indicates if this is an extension member + + + + + Indicates if the getter (or, if absent, the setter) for the property is a dispatch slot. + + + + + Indicates if this property is marked 'override' and thus definitely overrides another property. + + + + + Indicates if this property has an associated setter method. + + + + + Indicates if this property has an associated getter method. + + + + + Indicates if this property has an associated XML comment authored in this assembly. + + + + + Get a MethInfo for the 'getter' method associated with the property + + + + + Return a new property info where there is no associated setter, only an associated getter. + + Property infos can combine getters and setters, assuming they are consistent w.r.t. 'virtual', indexer argument types etc. + When checking consistency we split these apart + + + + + Return a new property info where there is no associated getter, only an associated setter. + + + + + Get the declaring type or module holding the method. + Note that C#-style extension properties don't exist in the C# design as yet. + If this is an F#-style extension method it is the logical module + holding the value for the extension method. + + + + + Try to get an arbitrary F# ValRef associated with the member. This is to determine if the member is virtual, amongst other things. + + + + + Get the enclosing type of the property. + + If this is an extension member, then this is the apparent parent, i.e. the type the property appears to extend. + + + + + Get the enclosing type of the method info, using a nominal type for tuple types + + + + + Test whether two property infos have the same underlying definition. + Uses the same techniques as 'MethInfosUseIdenticalDefinitions'. + Must be compatible with ItemsAreEffectivelyEqual relation. + + + + + Get the result type of the property + + + + + Get the types of the indexer parameters associated with the property + + + + + Get the names and types of the indexer parameters associated with the property + + If the property is in a generic type, then the type parameters are instantiated in the types returned. + + + + + Get the details of the indexer parameters associated with the property + + + + + Calculates a hash code of property info. Must be compatible with ItemsAreEffectivelyEqual relation. + + + + + Describes an F# use of a property + + + + + Get the TcGlobals governing this value + + + + + Gets the ILMethInfo of the 'set' method for the IL property + + + + + Get the raw Abstract IL metadata for the IL property + + + + + Get the name of the IL property + + + + + Indicates if the IL property is virtual + + + + + Indicates if the IL property is static + + + + + Indicates if the IL property is logically a 'newslot', i.e. hides any previous slots of the same name. + + + + + Get the declaring IL type of the IL property, including any generic instantiation + + + + + Indicates if the IL property has a 'set' method + + + + + Indicates if the IL property has a 'get' method + + + + + Gets the ILMethInfo of the 'get' method for the IL property + + + + + Get the apparent declaring type of the method as an F# type. + If this is a C#-style extension method then this is the type which the method + appears to extend. This may be a variable type. + + + + + Like ApparentEnclosingType but use the compiled nominal type if this is a method on a tuple type + + + + + Get the return type of the IL property. + + Any type parameters of the enclosing type are instantiated in the type returned. + + + + + Get the types of the indexer arguments associated with the IL property. + + Any type parameters of the enclosing type are instantiated in the type returned. + + + + + Get the names and types of the indexer arguments associated with the IL property. + + Any type parameters of the enclosing type are instantiated in the type returned. + + + + + Describes an F# use of a property backed by Abstract IL metadata + + + + + Get a reference to the F# metadata for the uninstantiated union case + + + + + Get the F# metadata for the uninstantiated union case + + + + + Get the list of types for the instantiation of the type parameters of the declaring type of the union case + + + + + Get a reference to the F# metadata for the declaring union type + + + + + Get the F# metadata for the declaring union type + + + + + Get the name of the union case + + + + + Get the instantiation of the type parameters of the declaring type of the union case + + + + + Describes an F# use of a union case + + + + + Get the generic instantiation of the declaring type of the field + + + + + Get a reference to the F# metadata for the F#-declared record, class or struct type + + + + + Get the F# metadata for the F#-declared record, class or struct type + + + + + Get a reference to the F# metadata for the uninstantiated field + + + + + Get the F# metadata for the uninstantiated field + + + + + Get the name of the field in an F#-declared record, class or struct type + + + + + Indicate if the field is a literal field in an F#-declared record, class or struct type + + + + + Indicate if the field is a static field in an F#-declared record, class or struct type + + + + + Get the (instantiated) type of the field in an F#-declared record, class or struct type + + + + + Get the enclosing (declaring) type of the field in an F#-declared record, class or struct type + + + + + Describes an F# use of a field in an F#-declared record, class or struct type + + + + + Represents a single use of a field backed by provided metadata + + + + + Represents a single use of a field backed by Abstract IL metadata + + + + + Get the type instantiation of the declaring type of the field + + + + + Get the scope used to interpret IL metadata + + + + + Indicates if the field is a literal field with an associated literal value + + + + + Indicates if the field is a member of a struct or enum type + + + + + Indicates if the field is static + + + + + Indicates if the field has the 'specialname' property in the .NET IL + + + + + Indicates if the field is readonly (in the .NET/C# sense of readonly) + + + + + Get a reference to the declaring type of the field as an ILTypeRef + + + + + Get the type of the field as an IL type + + + + + Get an (uninstantiated) reference to the field as an Abstract IL ILFieldRef + + + + + Get the name of the field + + + + + Get the enclosing ("parent"/"declaring") type of the field. + + + + + Tests whether two infos have the same underlying definition. + Must be compatible with ItemsAreEffectivelyEqual relation. + + + + + Get the type of the field as an F# type + + + + + Calculates a hash code of field info. Must be compatible with ItemsAreEffectivelyEqual relation. + + + + + Represents a single use of a IL or provided field from one point in an F# program + + + + + Describes a use of a method backed by provided metadata + + + + + Describes a use of a pseudo-method corresponding to the default constructor for a .NET struct type + + + + + ILMeth(tcGlobals, ilMethInfo, extensionMethodPriority). + + Describes a use of a method backed by Abstract IL # metadata + + + + + FSMeth(tcGlobals, enclosingType, valRef, extensionMethodPriority). + + Describes a use of a method declared in F# code and backed by F# metadata. + + + + + Get the XML documentation associated with the method + + + + + Get the TcGlobals value that governs the method declaration + + + + + Get the information about provided static parameters, if any + + + + + Get a list of argument-number counts, one count for each set of curried arguments. + + For an extension member, drop the 'this' argument. + + + + + Get the method name in LogicalName form, i.e. the name as it would be stored in .NET metadata + + + + + Indicates if the enclosing type for the method is a value type. + + For an extension method, this indicates if the method extends a struct type. + + + + + Indicates if this method takes no arguments + + + + + Does the method appear to the user as an instance method? + + + + + Indicates if this is an F# extension member. + + + + + Check if this method is an explicit implementation of an interface member + + + + + Indicates if this method is a generated method associated with an F# CLIEvent property compiled as a .NET event + + + + + Indicates if this is an extension member. + + + + + Check if this method is marked 'override' and thus definitely overrides another method. + + + + + Indicates if this is an C#-style extension member. + + + + + Indicates if this is a method defined in this assembly with an internal XML comment + + + + + Get the number of generic method parameters for a method. + For an extension method this includes all type parameters, even if it is extending a generic type. + + + + + Get the formal generic method parameters for the method as a list of type variables. + + For an extension method this includes all type parameters, even if it is extending a generic type. + + + + + Get the formal generic method parameters for the method as a list of variable types. + + + + + Get the extension method priority of the method, if it has one. + + + + + Get the extension method priority of the method. If it is not an extension method + then use the highest possible value since non-extension methods always take priority + over extension members. + + + + + Get the method name in DisplayName form + + + + + Get the actual type instantiation of the declaring type associated with this use of the method. + + For extension members this is empty (the instantiation of the declaring type). + + + + + Get the declaring type or module holding the method. If this is an C#-style extension method then this is the type + holding the static member that is the extension method. If this is an F#-style extension method it is the logical module + holding the value for the extension method. + + + + + Try to get an arbitrary F# ValRef associated with the member. This is to determine if the member is virtual, amongst other things. + + + + + Get the enclosing type of the method info. + + If this is an extension member, then this is the apparent parent, i.e. the type the method appears to extend. + This may be a variable type. + + + + + Get the enclosing type of the method info, using a nominal type for tuple types + + + + + Tries to get the object arg type if it's a byref type. + + + + + Indicates if this is an extension member (e.g. on a struct) that takes a byref arg + + + + + Tests whether two method infos have the same underlying definition. + Used to merge operator overloads collected from left and right of an operator constraint. + Must be compatible with ItemsAreEffectivelyEqual relation. + + + + + Apply a type instantiation to a method info, i.e. apply the instantiation to the enclosing type. + + + + + Get the ParamData objects for the parameters of a MethInfo + + + + + Get the signature of an abstract method slot. + + + + + Get the parameter types of a method info + + + + + Get the ParamData objects for the parameters of a MethInfo + + + + + Get the parameter attributes of a method info, which get combined with the parameter names and types + + + + + Get the (zero or one) 'self'/'this'/'object' arguments associated with a method. + An instance method returns one object argument. + + + + + Select all the type parameters of the declaring type of a method. + + For extension methods, no type parameters are returned, because all the + type parameters are part of the apparent type, rather the + declaring type, even for extension methods extending generic types. + + + + + Get the return type of a method info, where 'void' is returned as 'unit' + + + + + Get the return type of a method info, where 'void' is returned as 'None' + + + + + Build IL method infos. + + + + + Build IL method infos for a C#-style extension method + + + + + Calculates a hash code of method info. Must be compatible with ItemsAreEffectivelyEqual relation. + + + + + Add the actual type instantiation of the apparent type of an F# extension method. + + + + + Describes an F# use of a method + + + + + ILMethInfo(g, ilApparentType, ilDeclaringTyconRefOpt, ilMethodDef, ilGenericMethodTyArgs) + + Describes an F# use of an IL method. + + If ilDeclaringTyconRefOpt is 'Some' then this is an F# use of an C#-style extension method. + If ilDeclaringTyconRefOpt is 'None' then ilApparentType is an IL type definition. + + + + + Get the Abstract IL metadata associated with the method. + + + + + Get the Abstract IL metadata corresponding to the parameters of the method. + If this is an C#-style extension method then drop the object argument. + + + + + Get the number of parameters of the method + + + + + Get the Abstract IL scope information associated with interpreting the Abstract IL metadata that backs this method. + + + + + Indicates if the IL method is marked virtual. + + + + + Does it appear to the user as a static method? + + + + + Indicates if the method has protected accessibility, + + + + + Does it have the .NET IL 'newslot' flag set, and is also a virtual? + + + + + Does it appear to the user as an instance method? + + + + + Indicates if the method is an extension method + + + + + Indicates if the IL method is marked final. + + + + + Indicates if the method is a constructor + + + + + Indicates if the method is a class initializer. + + + + + Indicates if the IL method is marked abstract. + + + + + Get the IL name of the method + + + + + Get a reference to the method (dropping all generic instantiations), as an Abstract IL ILMethodRef. + + + + + Get the declaring type associated with an extension member, if any. + + + + + Get the formal method type parameters associated with a method. + + + + + Get the instantiation of the declaring type of the method. + If this is an C#-style extension method then this is empty because extension members + are never in generic classes. + + + + + Get the declaring type of the method. If this is an C#-style extension method then this is the IL type + holding the static member that is the extension method. + + + + + Get the apparent declaring type of the method as an F# type. + If this is a C#-style extension method then this is the type which the method + appears to extend. This may be a variable type. + + + + + Like ApparentEnclosingType but use the compiled nominal type if this is a method on a tuple type + + + + + Indicates if the method is marked as a DllImport (a PInvoke). This is done by looking at the IL custom attributes on + the method. + + + + + Get all the argument types of the IL method. Include the object argument even if this is + an C#-style extension method. + + + + + Get the argument types of the the IL method. If this is an C#-style extension method + then drop the object argument. + + + + + Get info about the arguments of the IL method. If this is an C#-style extension method then + drop the object argument. + + Any type parameters of the enclosing type are instantiated in the type returned. + + + + + Get the (zero or one) 'self'/'this'/'object' arguments associated with an IL method. + An instance extension method returns one object argument. + + + + + Get the F# view of the return type of the method, where 'void' is 'unit'. + + + + + Get the compiled return type of the method, where 'void' is None. + + + + + Describes an F# use of an IL method. + + + + + ILTypeInfo (tyconRef, ilTypeRef, typeArgs, ilTypeDef). + + + + + Get the compiled nominal type. In the case of tuple types, this is a .NET tuple type + + + + + Describes an F# use of an IL type, including the type instantiation associated with the type at a particular usage point. + + This is really just 1:1 with the subset ot TType which result from building types using IL type definitions. + + + + + Full information about a parameter returned for use by the type checker and language service. + + + + + Partial information about a parameter returned for use by the Language Service + + + + + The argument is optional, and is a caller-side .NET optional or default arg. + Note this is correctly termed caller side, even though the default value is optically specified on the callee: + in fact the default value is read from the metadata and passed explicitly to the callee on the caller side. + + + + + The argument is optional, and is an F# callee-side optional arg + + + + + The argument is not optional + + + + + Compute the OptionalArgInfo for an IL parameter + + This includes the Visual Basic rules for IDispatchConstant and IUnknownConstant and optional arguments. + + + + + Represents information about a parameter indicating if it is optional. + + + + + The caller-side value for the optional arg, if any + + + + + Describes the sequence order of the introduction of an extension method. Extension methods that are introduced + later through 'open' get priority in overload resolution. + + + + + Indicates whether we should visit multiple instantiations of the same generic interface or not + + + + + Indicates whether we can skip interface types that lie outside the reference set + + + + + Used to hide/filter members from super classes based on signature + + + + + Used to hide/filter members from super classes based on signature + + + + + Used to hide/filter members from super classes based on signature + + + + + Used to hide/filter members from super classes based on signature + Inref and outref parameter types will be treated as a byref type for equivalency. + + + + + Get the information about the compiled form of a method signature. Used when analyzing implementation + relations between members and abstract slots. + + + + + Strips inref and outref to be a byref. + + + + + Find the delegate type that an F# event property implements by looking through the type hierarchy of the type of the property + for the first instantiation of IDelegateEvent. + + + + + Create an error object to raise should an event not have the shape expected by the .NET idiom described further below + + + + + Properties compatible with type IDelegateEvent and attributed with CLIEvent are special: + we generate metadata and add/remove methods + to make them into a .NET event, and mangle the name of a property. + We don't handle static, indexer or abstract properties correctly. + Note the name mangling doesn't affect the name of the get/set methods for the property + and so doesn't affect how we compile F# accesses to the property. + + + + + Try to get an arbitrary ProvidedMethodInfo associated with a property. + + + + + Compute the ILFieldInit for the given provided constant value for a provided enum type. + + + + + Compute the OptionalArgInfo for a provided parameter. + + This is the same logic as OptionalArgInfoOfILParameter except we do not apply the + Visual Basic rules for IDispatchConstant and IUnknownConstant to optional + provided parameters. + + + + + Compute the ILFieldInit for the given provided constant value for a provided enum type. + + + + + Work out the instantiation relevant to interpret the backing metadata for a property. + + + + + Work out the instantiation relevant to interpret the backing metadata for a member. + + The 'methTyArgs' is the instantiation of any generic method type parameters (this instantiation is + not included in the MethInfo objects, but carried separately). + + + + + Combine the type instantiation and generic method instantiation + + + + + Get the object type for a member value which is a C#-style extension method + + + + + Get the object type for a member value which is an extension method (C#-style or F#-style) + + + + + Split the type of an F# member value into + - the type parameters associated with method but matching those of the enclosing type + - the type parameters associated with a generic method + - the return type of the method + - the actual type arguments of the enclosing type. + + + + + Construct the data representing the signature of an abstract method slot + + + + + Construct the data representing a parameter in the signature of an abstract method slot + + + + + The slotsig returned by methInfo.GetSlotSig is in terms of the type parameters on the parent type of the overriding method. + Reverse-map the slotsig so it is in terms of the type parameters for the overriding method + + + + + Get the return type of a provided method, where 'void' is returned as 'None' + + + + + Check if an F#-declared member value is an explicit interface member implementation + + + + + Check if an F#-declared member value is an 'override' or explicit member implementation + + + + + Check if an F#-declared member value is a dispatch slot + + + + + Check if an F#-declared member value is a virtual method + + + + + Indicates if an F#-declared function or member value is a CLIEvent property compiled as a .NET event + + + + + The constraints for each typar copied from another typar can only be fixed up once + we have generated all the new constraints, e.g. f<A :> List<B>, B :> List<A>> ... + + + + + Copy constraints. If the constraint comes from a type parameter associated + with a type constructor then we are simply renaming type variables. If it comes + from a generic method in a generic class (e.g. ty.M<_>) then we may be both substituting the + instantiation associated with 'ty' as well as copying the type parameters associated with + M and instantiating their constraints + + Note: this now looks identical to constraint instantiation. + + + + + Get the return type of an IL method, taking into account instantiations for type, return attributes and method generic parameters, and + translating 'void' to 'None'. + + + + + Get the parameter type of an IL method. + + + + + Read an Abstract IL type from metadata, including any attributes that may affect the type itself, and convert to an F# type. + + + + + Read an Abstract IL type from metadata and convert to an F# type. + + + + + Check if a type exists somewhere in the hierarchy which has the given head type. + + + + + Check if a type exists somewhere in the hierarchy which has the same head type as the given type (note, the given type need not have a head type at all) + + + + + Check if a type has a particular head type + + + + + Check if two types have the same nominal head type + + + + + Get all interfaces of a type, including the type itself if it is an interface + + + + + Get all super types of the type, including the type itself + + + + + Search for one element where a function returns a 'Some' result, following interfaces + + + + + Search for one element satisfying a predicate, following interfaces + + + + + Iterate, following interfaces. Skipping interfaces that lie outside the referenced assembly set is allowed. + + + + + Fold, following interfaces. Skipping interfaces that lie outside the referenced assembly set is allowed. + + + + + Fold, do not follow interfaces (unless the type is itself an interface) + + + + + Traverse the type hierarchy, e.g. f D (f C (f System.Object acc)). + Visit base types and interfaces first. + + + + + Collect the set of immediate declared interface types for an F# type, but do not + traverse the type hierarchy to collect further interfaces. + + + + + Make a type for System.Collections.Generic.IList<ty> + + + + + Get the base type of a type, taking into account type instantiations. Return None if the + type has no base type. + + + + + Indicates if an F# type is the type associated with an F# exception declaration + + + + + Import an IL type as an F# type. importInst gives the context for interpreting type variables. + + + + + An exception type used to raise an error using the old error system. + + Error text: "A definition to be compiled as a .NET event does not have the expected form. Only property members can be compiled as .NET events." + + + + + An AccessorDomain which returns all items + + + + + An AccessorDomain which returns everything but .NET private/internal items. + This is used + - when solving member trait constraints, which are solved independently of accessibility + - for failure paths in error reporting, e.g. to produce an error that an F# item is not accessible + - an adhoc use in service.fs to look up a delegate signature + + + + + An AccessorDomain which returns public items + + + + + AccessibleFrom(cpaths, tyconRefOpt) + + cpaths: indicates we have the keys to access any members private to the given paths + tyconRefOpt: indicates we have the keys to access any protected members of the super types of 'TyconRef' + + + + + Represents the 'keys' a particular piece of code can use to access other constructs?. + + + + + Uses a separate accessibility domains for containing type and method itself + This makes sense cases like + type A() = + type protected B() = + member this.Public() = () + member protected this.Protected() = () + type C() = + inherit A() + let x = A.B() + do x.Public() + when calling x.SomeMethod() we need to use 'adTyp' do verify that type of x is accessible from C + and 'ad' to determine accessibility of SomeMethod. + I.e when calling x.Public() and x.Protected() -in both cases first check should succeed and second - should fail in the latter one. + + + + + IndiCompute the accessibility of a provided member + + + + + Compute the accessibility of a provided member + + + + + Indicate if a provided member is accessible + + + + + Indicates if a type is accessible (both definition and instantiation) + + + + + Check that a type definition and its representation contents are accessible + + + + + Indicates if a type definition and its representation contents are accessible + + + + + Check that an entity is accessible + + + + + Indicates if an entity is accessible + + + + + Indicates if an IL member associated with the given ILType is accessible + + + + + Indicates if given IL based TyconRef is accessible. If TyconRef is nested then we'll + walk though the list of enclosing types and test if all of them are accessible + + + + + Indicates if a TyconRef is visible through the AccessibleFrom(cpaths, _). + Note that InternalsVisibleTo extends those cpaths. + + + + + Indicates if tdef is accessible. If tdef.Access = ILTypeDefAccess.Nested then encTyconRefOpt s TyconRef of enclosing type + and visibility of tdef is obtained using member access rules + + + + + Indicates if an IL member is accessible (ignoring its enclosing type) + + + + + Indicates if an F# item is accessible + + + + + The basic logic of private/internal/protected/InternalsVisibleTo/public accessibility + + + + + Check the attributes on a record field, returning errors and warnings as data. + + + + + Check the attributes on an F# value, returning errors and warnings as data. + + + + + Check the attributes on a record field, returning errors and warnings as data. + + + + + Check the attributes on a union case, returning errors and warnings as data. + + + + + Check the attributes on an entity, returning errors and warnings as data. + + + + + Indicate if a property has 'Obsolete' or 'CompilerMessageAttribute'. + Used to suppress the item in intellisense. + + + + + Indicate if a method has 'Obsolete', 'CompilerMessageAttribute' or 'TypeProviderEditorHideMethodsAttribute'. + Used to suppress the item in intellisense. + + + + + Check the attributes associated with a method, returning warnings and errors as data. + + + + + Check the attributes associated with a IL field, returning warnings and errors as data. + + + + + Check the attributes associated with a property, returning warnings and errors as data. + + + + + Indicate if a list of provided attributes contains 'ObsoleteAttribute'. Used to suppress the item in intellisense. + + + + + Indicate if a list of F# attributes contains 'ObsoleteAttribute'. Used to suppress the item in intellisense. + Also check the attributes for CompilerMessageAttribute, which has an IsHidden argument that allows + items to be suppressed from intellisense. + + + + + Indicate if a list of F# attributes contains 'ObsoleteAttribute'. Used to suppress the item in intellisense. + + + + + Checks the attributes for CompilerMessageAttribute, which has an IsHidden argument that allows + items to be suppressed from intellisense. + + + + + Indicate if a list of IL attributes contains 'ObsoleteAttribute'. Used to suppress the item in intellisense. + + + + + Check a list of provided attributes for 'ObsoleteAttribute', returning errors and warnings as data + + + + + Check F# attributes for 'ObsoleteAttribute', 'CompilerMessageAttribute' and 'ExperimentalAttribute', + returning errors and warnings as data + + + + + Check IL attributes for 'ObsoleteAttribute', returning errors and warnings as data + + + + + Check if a method has a specific attribute. + + + + + Try to find a specific attribute on a method, where the attribute accepts a string argument. + + This is just used for the 'ConditionalAttribute' attribute + + + + + Analyze three cases for attributes declared on methods: IL-declared attributes, F#-declared attributes and + provided attributes. + + + + + Analyze three cases for attributes declared on methods: IL-declared attributes, F#-declared attributes and + provided attributes. + + + + + Analyze three cases for attributes declared on type definitions: IL-declared attributes, F#-declared attributes and + provided attributes. + + + + + Check custom attributes. This is particularly messy because custom attributes come in in three different + formats. + + + + + Logic associated with checking "ObsoleteAttribute" and other attributes + on items from name resolution + + + + + The Invoke MethInfo, the function argument types, the function return type + and the overall F# function type for the function type associated with a .NET delegate type + + + + + Get the item sets + + + + + Get an empty set of items + + + + + Get the items with a particular name + + + + + Filter a set of new items to add according to the content of the list. Only keep an item + if it passes 'keepTest' for all matching items already in the list. + + + + + Add new items, extracting the names using the given function. + + + + + The input list is sorted from most-derived to least-derived type, so any System.Object methods + are at the end of the list. Return a filtered list where prior/subsequent members matching by name and + that are in the same equivalence class have been removed. We keep a name-indexed table to + be more efficient when we check to see if we've already seen a particular named method. + + + + + Get overrides instead of abstract slots when measuring whether a class/interface implements all its required slots. + + + + + Prefer items toward the top of the hierarchy, which we do if the items are virtual + but not when resolving base calls. + + + + + Indicates if we prefer overrides or abstract slots. + + + + + Try and find a record or class field for a type. + + + + + Try and find an item with the given name in a type. + + + + + Read the record or class fields of a type, including inherited ones. Cache the result for monomorphic types. + + + + + Read the raw property sets of a type, including inherited ones. Cache the result for monomorphic types + + + + + Read the raw method sets of a type, including inherited ones. Cache the result for monomorphic types + + + + + Get the super-types of a type, excluding interface types. + + + + + Read the IL fields of a type, including inherited ones. Cache the result for monomorphic types. + + + + + Read the events of a type, including inherited ones. Cache the result for monomorphic types. + + + + + Get the super-types of a type, including interface types. + + + + + An InfoReader is an object to help us read and cache infos. + We create one of these for each file we typecheck. + + + + + Sets of methods up the hierarchy, ignoring duplicates by name and sig. + Used to collect sets of virtual methods, protected methods, protected + properties etc. + + + + + A helper type to help collect properties. + + Join up getters and setters which are not associated in the F# data structure + + + + + Get the type of the event when looked at as if it is a property + Used when displaying the property in Intellisense + + + + + Get the (perhaps tupled) argument type accepted by an event + + + + + The .NET Framework guidelines indicate that the delegate type used for + an event should take two parameters, an "object source" parameter + indicating the source of the event, and an "e" parameter that + encapsulates any additional information about the event. The type of + the "e" parameter should derive from the EventArgs class. For events + that do not use any additional information, the .NET Framework has + already defined an appropriate delegate type: EventHandler. + (from http://msdn.microsoft.com/library/default.asp?url=/library/en-us/csref/html/vcwlkEventsTutorial.asp) + + + + + Try and interpret a delegate type as a "standard" .NET delegate type associated with an event, with a "sender" parameter. + + + + + Given a delegate type work out the minfo, argument types, return type + and F# function type by looking at the Invoke signature of the delegate. + + + + + Try to find a particular named property on a type. Only used to ensure that local 'let' definitions and property names + are distinct, a somewhat adhoc check in tc.fs. + + + + + Try to detect the existence of a method on a type. + Used for + -- getting the GetEnumerator, get_Current, MoveNext methods for enumerable types + -- getting the Dispose method when resolving the 'use' construct + -- getting the various methods used to desugar the computation expression syntax + + + + + Perform type-directed name resolution of a particular named member in an F# type + + + + + Get the flattened list of intrinsic properties in the hierarchy + + + + + Get the flattened list of intrinsic methods in the hierarchy + + + + + Get the sets intrinsic properties in the hierarchy (not including extension properties) + + + + + Get the sets of intrinsic methods in the hierarchy (not including extension methods) + + + + + Exclude properties from super types which have the same name as a property in a more specific type. + + + + + Exclude methods from super types which have the same signature as a method in a more specific type. + + + + + Filter the overrides of properties, either keeping the overrides or keeping the dispatch slots. + + + + + Filter the overrides of methods, either keeping the overrides or keeping the dispatch slots. + + + + + Filter the overrides of methods or properties, either keeping the overrides or keeping the dispatch slots. + + + + + Add all the items to the IndexedList, preferring the ones in the sub-types. + + + + + Add all the items to the IndexedList, preferring the ones in the super-types. This is used to hide methods + in super classes and/or hide overrides of methods in subclasses. + + Assume no items in 'items' are equivalent according to 'equivTest'. This is valid because each step in a + .NET class hierarchy introduces a consistent set of methods, none of which hide each other within the + given set. This is an important optimization because it means we don't have filter for equivalence between the + large overload sets introduced by methods like System.WriteLine. + + Assume items can be given names by 'nmf', where two items with different names are + not equivalent. + + + + + Get the declared constructors of any F# type + + + + + Query the immediate properties of an F# type, not taking into account inherited properties. The optFilter + parameter is an optional name to restrict the set of properties returned. + + + + + Query the immediate methods of an F# type, not taking into account inherited methods. The optFilter + parameter is an optional name to restrict the set of properties returned. + + + + + Try to select an F# value when querying members, and if so return a MethInfo that wraps the F# value. + + + + + Check whether a name matches an optional filter + + + + + Use the given function to select some of the member values from the members of an F# type + + + + + Select members from a type by name, searching the type hierarchy if needed + + + + + Generate text for comparing two types. + + If the output text is different without showing constraints and/or imperative type variable + annotations and/or fully qualifying paths then don't show them! + + + + + Pass negative number as pos in case of single cased discriminated unions + + + + + Convert a ParamData to a string + + + + + Convert a MethInfo to a string + + + + + Convert a PropInfo to a string + + + + + Convert a MethInfo to a string + + + + + Print members with a qualification showing the type they are contained in + + + + + Nice printing of a subset of expressions, e.g. for refutations in pattern matching + + + + + Layout the inferred signature of a compilation unit + + + + + Another re-implementation of type printing, this time based off provided info objects. + + + + + When to force a break? "type tyname = <HERE> repn" + When repn is class or datatype constructors (not single one). + + + + + Printing TAST objects + + + + + Format a method to a layout (actually just containing a string) using "free style" (aka "standalone"). + + + + + Format a method to a buffer using "standalone" display style. + For example, these are the formats used when printing signatures of methods that have not been overridden, + and the format used when showing the individual member in QuickInfo and DeclarationInfo. + The formats differ between .NET/provided methods and F# methods. Surprisingly people don't really seem + to notice this, or they find it helpful. It feels that moving from this position should not be done lightly. + + + + + Format a method info using "half C# style". + + + + + Format a method info using "F# style". + + + + + Format the arguments of a method to a buffer. + + This uses somewhat "old fashioned" printf-style buffer printing. + + + + + Printing info objects + + + + + Printing TAST objects + + + + + Layout type parameters + + + + + Layout a single type used as the type of a member or value + + + + + Layout a single type, taking TypeSimplificationInfo into account + + + + + Layout a list of types, separated with the given separator, either '*' or ',' + + + + + Layout a type, taking precedence into account to insert brackets where needed + + + + + Layout type arguments, either NAME<ty, ..., ty> or (ty, ..., ty) NAME *) + + + + + Layout a unit expression + + + + + Layout constraints, taking TypeSimplificationInfo into account + + + + + Layout type parameter constraints, taking TypeSimplificationInfo into account + + + + + Layout a single type parameter declaration, taking TypeSimplificationInfo into account + There are several printing-cases for a typar: + + 'a - is multiple occurrence. + _ - singleton occurrence, an underscore preferred over 'b. (OCaml accepts but does not print) + #Type - inplace coercion constraint and singleton. + ('a :> Type) - inplace coercion constraint not singleton. + ('a.opM: S->T) - inplace operator constraint. + + + + + + Layout '[<attribs>]' above another block + + + + + Layout an attribute 'Type(arg1, ..., argN)' + + + + + Layout arguments of an attribute 'arg1, ..., argN' + + + + + Layout a single attribute arg, following the cases of 'gen_attr_arg' in ilxgen.fs + This is the subset of expressions we display in the NicePrint pretty printer + See also dataExprL - there is overlap between these that should be removed + + + + + Layout the flags of a member + + + + + Layout a reference to a type + + + + + Layout a method's signature using type-only-F#-style. No argument names are printed. + + In the case that we've a constructor, we + pull off the class name from the `path`; naturally, it's the + most-deeply-nested element. + + + + + Layout a function pointer signature using type-only-F#-style. No argument names are printed. + + + + + Layout a function pointer signature using type-only-F#-style. No argument names are printed. + + + + + Layout a function pointer signature using type-only-F#-style. No argument names are printed. + + + + + this fixes up a name just like adjustILName but also handles F# + operators + + + + + fix up a name coming from IL metadata by quoting "funny" names (keywords, otherwise invalid identifiers) + + + + + This predicate can be used once type inference is complete, before then it is an approximation + that doesn't assert any new constraints + + + + + Generate the hash/compare functions we add to user-defined types by default. + + + + + Notify the sink of the information needed to complete recording a use of a symbol + for the purposes of the language service. One of the callbacks should be called by + the checker. + + The first callback represents a case where we have learned the type + instantiation of a generic method or value. + + The second represents the case where we have resolved overloading and/or + a specific override. The 'Item option' contains the candidate overrides. + + + + + Notification is not needed + + + + + Specifies extra work to do after overload resolution + + + + + Indicates whether we permit a direct reference to a type generator. Only set when resolving the + right-hand-side of a [<Generate>] declaration. + + + + + Indicates if a warning should be given for the use of upper-case identifiers in patterns + + + + + Indicates the kind of lookup being performed. Note, this type should be made private to nameres.fs. + + + + + Indicates if we only need one result or all possible results from a resolution. + + + + + An abstract type for reporting the results of name resolution and type checking, and which allows + temporary suspension and/or redirection of reporting. + + + + + Get all the uses of all symbols reported to the sink + + + + + Get all the resolutions reported to the sink + + + + + Get all open declarations reported to the sink + + + + + Create a TcResultsSinkImpl + + + + + An implementation of ITypecheckResultsSink to collect information during type checking + + + + + Cached line-end normalized source text and an array of line end positions, used for format string parsing + + + + + Get the current source + + + + + Record that an open declaration occured in a given scope range + + + + + Record that a name resolution occurred at a specific location in the source + + + + + Record that a printf format specifier occurred at a specific location in the source + + + + + Record that an expression has a specific type at the given range. + + + + + Record that an environment is active over the given scope range + + + + + An abstract type for reporting the results of name resolution and type checking + + + + + Array of line start positions + + + + + Source text + + + + + Source text and an array of line end positions, used for format string parsing + + + + + If it's `namespace Xxx.Yyy` declaration. + + + + + Scope in which open declaration is visible. + + + + + Modules or namespaces which is opened with this declaration. + + + + + Full range of the open declaration. + + + + + Long identifier as it's presented in soruce code. + + + + + Create a new instance of OpenDeclaration. + + + + + Represents open declaration statement. + + + + + All the uses of all items within the file + + + + + Get all the uses of a particular item within the file + + + + + Get the locations of all the printf format specifiers in the file + + + + + Represents container for all name resolutions that were met so far when typechecking some particular file + + + + + Represents the empty set of resolutions + + + + + Exact name resolutions + + + + + Represents all the resolutions of names to groups of methods. + + + + + Information of exact types found for expressions, that can be to the left of a dot. + typ - the inferred type for an expression + + + + + Name resolution environments for every interesting region in the file. These regions may + overlap, in which case the smallest region applicable should be used. + + + + + The starting and ending position + + + + + line and column + + + + + Naming environment--for example, currently open namespaces. + + + + + The active instantiation for any generic type parameters + + + + + Information about the occurrence of the symbol + + + + + Named item + + + + + Information about printing. For example, should redundant keywords be hidden? + + + + + The access rights of code at the location + + + + + Represents the kind of the occurrence when reporting a name in name resolution + + + + + Represents information which guides name resolution of types. + + + + + Indicates definite knowledge of empty type arguments, i.e. the logical equivalent of name< > + + + + + Deduce definite knowledge of type arguments + + + + + Represents information about the generic argument count of a type name when resolving it. + + In some situations we resolve "List" to any type definition with that name regardless of the number + of generic arguments. In others, we know precisely how many generic arguments are needed. + + + + + Indicates we are resolving type names to type definitions + + + + + Indicates we are resolving type names to constructor methods. + + + + + Indicates whether we are resolving type names to type definitions or to constructor methods. + + + + + A flag which indicates if it is an error to have two declared type parameters with identical names + in the name resolution environment. + + + + + The environment of information used to resolve names + + + + + Information about an extension member held in the name resolution environment + + + + + Represents a record field resolution and the information if the usage is deprecated. + + + + + Pairs an Item with a TyparInst showing how generic type variables of the item are instantiated at + a particular usage point. + + + + + Represents the potential resolution of an unqualified name to a type. + + + + + Represents the resolution of a name to a named property setter + + + + + Represents the resolution of a name to a named argument + + + + + Represents the resolution of a name to an operator + + + + + Represents the resolution of a name to a module or namespace + + + + + Represents the resolution of a name to a type variable + + + + + Represents the resolution of a name to a custom builder in the F# computation expression syntax + + + + + CustomOperation(nm, helpText, methInfo) + + Used to indicate the availability or resolution of a custom query operation such as 'sortBy' or 'where' in computation expression syntax + + + + + Represents the resolution of a name to a group of types + + + + + Represents the resolution of a name to a delegate + + + + + Represents the resolution of a name to the fake constructor simulated for an interface type. + + + + + Represents the resolution of a name to a constructor + + + + + Represents the resolution of a name to a group of methods. + + + + + Represents the resolution of a name to a property + + + + + Represents the resolution of a name to an event + + + + + Represents the resolution of a name to a .NET field + + + + + Represents the resolution of a name at the point of its own definition. + + + + + Represents the resolution of a name to a field of an anonymous record type. + + + + + Represents the resolution of a name to an F# record field. + + + + + Represents the resolution of a name to an F# exception definition. + + + + + Represents the resolution of a name to an F# active pattern case within the body of an active pattern. + + + + + Represents the resolution of a name to an F# active pattern result. + + + + + Represents the resolution of a name to an F# union case. + + + + + Represents the resolution of a name to an F# value or function. + + + + + Represents an item that results from name resolution + + + + + The named argument is a static parameter to a union case constructor + + + + + The named argument is a static parameter to a provided type or a parameter to an F# exception constructor + + + + + The named argument is an argument of a method + + + + + Represents the item with which a named argument is associated. + + + + + A NameResolver is a context for name resolution. It primarily holds an InfoReader. + + + + + Resolve a (possibly incomplete) long identifier to a set of possible resolutions, qualified by type. + + + + + Resolve a (possibly incomplete) long identifier to a set of possible resolutions. + + + + + Try to resolve a long identifier as type. + + + + + A generator of type instantiations used when no more specific type instantiation is known. + + + + + Resolve a long identifier occurring in an expression position, qualified by a type. + + + + + Resolve a long identifier occurring in an expression position. + + + + + Return the fields for the given class or record + + + + + Resolve a (possibly incomplete) long identifier to a loist of possible class or record fields + + + + + Resolve a long identifier occurring in an expression position + + + + + Resolve a long identifier to a field + + + + + Resolve a long identifier to a type definition + + + + + Resolve a long identifier representing a type name + + + + + Resolve a long identifier when used in a pattern. + + + + + Resolve a long identifier using type-qualified name resolution. + + + + + Resolve a long identifier to an object constructor. + + + + + Resolve a long identifier to a namespace or module. + + + + + Generate a new reference to a record field with a fresh type instantiation + + + + + Get the available methods of a type (both declared and inherited) + + + + + Get all the available properties of a type (only extension) + + + + + Get all the available properties of a type (both intrinsic and extension) + + + + + Report an open declaration + + + + + Report a specific name resolution at a source range + + + + + Report a specific name resolution at a source range, replacing any previous resolutions + + + + + Report a specific name resolution at a source range + + + + + Report the active name resolution environment for a source range + + + + + Temporarily suspend reporting of name resolution and type checking results + + + + + Temporarily redirect reporting of name resolution and type checking results + + + + + Hash compatible with ItemsAreEffectivelyEqual + + + + + Check for equality, up to signature matching + + + + + Qualified lookup of type names in the environment + + + + + Add some declared type parameters to the name resolution environment + + + + + Add a list of modules or namespaces to the name resolution environment + + + + + Add a single modules or namespace to the name resolution environment + + + + + Add a list of module or namespace to the name resolution environment, including any sub-modules marked 'AutoOpen' + + + + + Add a module abbreviation to the name resolution environment + + + + + Add an F# exception definition to the name resolution environment + + + + + Add a list of type definitions to the name resolution environment + + + + + Add active pattern result tags to the environment. + + + + + Add a single F# value to the environment. + + + + + Add some extra items to the environment for Visual Studio, e.g. record members + + + + + Add extra items to the environment for Visual Studio, e.g. static members + + + + + Find a field in anonymous record type + + + + + Detect a use of a nominal type, including type abbreviations. + When reporting symbols, we care about abbreviations, e.g. 'int' and 'int32' count as two separate symbols. + + + + + Get the active pattern elements defined in a module, if any. Cache in the slot in the module type. + + + + + Used to report a warning condition for the use of upper-case identifiers in patterns + + + + + Used to report an error condition where name resolution failed due to an indeterminate type + + + + + "Single Feasible Type" inference + Look for the unique supertype of ty2 for which ty2 :> ty1 might feasibly hold + + + + + Do AdjustArityOfLambdaBody for a series of + iterated lambdas, producing one method. + The required iterated function arity (List.length topValInfo) must be identical + to the iterated function arity of the input lambda (List.length vsl) + + + + + Break apart lambdas. Needs ChooseTyparSolutionsForFreeChoiceTypars because it's used in + PostTypeCheckSemanticChecks before we've eliminated these nodes. + + + + + Choose solutions for Expr.TyChoose type "hidden" variables introduced + by letrec nodes. Also used by the pattern match compiler to choose type + variables when compiling patterns at generalized bindings. + e.g. let ([], x) = ([], []) + Here x gets a generalized type "list<'T>". + + + + + The feasible coercion relation. Part of the language spec. + + + + + The feasible equivalence relation. Part of the language spec. + + + + + Implements a :> b without coercion based on finalized (no type variable) types + + + + + Primary relations on types and signatures, with the exception of + constraint solving and method overload resolution. + + + + + Check the names add up between a signature and its implementation. We check this first. + + + + + Primary relations on types and signatures, with the exception of + constraint solving and method overload resolution. + + + + + The overall information about a method implementation in a class or object expression + + + + + Get the properties relevant to determining if a uniquely-identified-override exists based on the syntactic information + at the member signature prior to type inference. This is used to pre-assign type information if it does + + + + + Get the methods relevant to determining if a uniquely-identified-override exists based on the syntactic information + at the member signature prior to type inference. This is used to pre-assign type information if it does + + + + + "Type Completion" inference and a few other checks at the end of the inference scope + + + + + Check that a type definition implements all its required interfaces after processing all declarations + within a file. + + + + + Get the slots of a type that can or must be implemented. This depends + partly on the full set of interface types that are being implemented + simultaneously, e.g. + { new C with interface I2 = ... interface I3 = ... } + allReqdTys = {C;I2;I3} + + allReqdTys can include one class/record/union type. + + + + + Check all implementations implement some dispatch slot. + + + + + Check all dispatch slots are implemented by some override. + + + + + Check if a dispatch slot is already implemented + + + + + Check if an override implements a dispatch slot + + + + + Check if an override exactly matches the requirements for a dispatch slot + + + + + Compose two instantiations of type parameters. + + + + + Compute the reverse of a type parameter renaming. + + + + + Check if an override is a partial match for the requirements for a dispatch slot + + + + + Check if the kinds of type parameters match between a dispatch slot and an override. + + + + + Check if an override matches a dispatch slot by name + + + + + Check if an override matches a dispatch slot by name + + + + + Get the override information for an object expression method being used to implement dispatch slots + + + + + Get the override info for a value being used to implement a dispatch slot. + + + + + Get the override info for an existing (inherited) method being used to implement a dispatch slot. + + + + + Format the signature of a MethInfo as a string as part of an error message + + + + + Format the signature of an override as a string as part of an error message + + + + + Print the signature of a MethInfo to a buffer as part of an error message + + + + + Print the signature of an override to a buffer as part of an error message + + + + + Primary logic related to method overrides. + + + + + unnamed called out args: return these as part of the return tuple + + + + + unnamed called optional args: pass defaults for these + + + + + unassigned args + + + + + the method we're attempting to call + + + + + the formal instantiation of the method we're attempting to call + + + + + The types of the actual object arguments, if any + + + + + the instantiation of the method we're attempting to call + + + + + the instantiation of the method we're attempting to call + + + + + return type after tupling of out args is taken into account + + + + + return type after implicit deference of byref returns is taken into account + + + + + args assigned to specify values for attribute fields and properties (these are not necessarily "property sets") + + + + + the property related to the method we're attempting to call, if any + + + + + named setters + + + + + The argument analysis for each set of curried arguments + + + + + Represents the syntactic matching between a caller of a method and the called method. + + The constructor takes all the information about the caller and called side of a method, match up named arguments, property setters etc., + and returns a CalledMeth object for further analysis. + + + + + Named args + + + + + Any unnamed caller arguments assigned to a "param array" argument + + + + + The called "ParamArray" argument, if any + + + + + Any unnamed caller arguments not otherwise assigned + + + + + The called arguments corresponding to "unnamed" arguments + + + + + Represents the resolution of a caller argument as a named-setter argument + + + + + Represents the possibilities for a named-setter argument (a property, field, or a record field setter) + + + + + The argument on the caller side + + + + + The called argument in the method + + + + + The identifier for a named argument, if any + + + + + Represents a match between a caller argument and a called argument, arising from either + a named argument or an unnamed argument. + + + + + Represents the information about an argument in the method being called + + + + + CallerArg(ty, range, isOpt, exprInfo) + + + + + In the following, 'T gets instantiated to: + 1. the expression being supplied for an argument + 2. "unit", when simply checking for the existence of an overload that satisfies + a signature, or when finding the corresponding witness. + Note the parametricity helps ensure that overload resolution doesn't depend on the + expression on the callside (though it is in some circumstances allowed + to depend on some type information inferred syntactically from that + expression, e.g. a lambda expression may be converted to a delegate as + an adhoc conversion. + + The bool indicates if named using a '?' + + + + + Build an expression that calls a given method info. + This is called after overload resolution, and also to call other + methods such as 'setters' for properties. + + + + + Make a call to a method info. Used by the optimizer and code generator to build + calls to the type-directed solutions to member constraints. + + + + + Build a call to an F# method. + + + + + Build a call to an F# method. + + Consume the arguments in chunks and build applications. This copes with various F# calling signatures + all of which ultimately become 'methods'. + + QUERY: this looks overly complex considering that we are doing a fundamentally simple + thing here. + + + + + Build an expression node that is a call to a .NET method. + + + + + Adjust the 'this' pointer before making a call + Take the address of a struct, and coerce to an interface/base/constraint type if necessary + + + + + Compute whether we insert a 'coerce' on the 'this' pointer for an object model call + For example, when calling an interface method on a struct, or a method on a constrained + variable type. + + + + + Is this a 'base' call (in the sense of C#) + + + + + Build the argument list for a method call. Adjust for param array, optional arguments, byref arguments and coercions. + For example, if you pass an F# reference cell to a byref then we must get the address of the + contents of the ref. Likewise lots of adjustments are made for optional arguments etc. + + + + + Adjust any 'out' arguments, passing in the address of a mutable local + + + + + Implements the elaborated form of adhoc conversions from functions to delegates at member callsites + + + + + Build a call to the System.Object constructor taking no arguments, + + + + + Erasure over System.Type. + + This is a reimplementation of the logic of provided-type erasure, working entirely over (tainted, provided) System.Type + values. This is used when preparing ParameterInfo objects to give to the provider in GetInvokerExpression. + These ParameterInfo have erased ParameterType - giving the provider an erased type makes it considerably easier + to implement a correct GetInvokerExpression. + + Ideally we would implement this operation by converting to an F# TType using ImportSystemType, and then erasing, and then converting + back to System.Type. However, there is currently no way to get from an arbitrary F# TType (even the TType for + System.Object) to a System.Type to give to the type provider. + + + + + Logic associated with resolving method calls. + + + + + Represents the typechecked, elaborated form of a pattern, prior to pattern-match compilation. + + + + + What should the decision tree contain for any incomplete match? + + + + + Compile a pattern into a decision tree and a set of targets. + + + + + A function that denotes captured tcVal, Used in constraint solver and elsewhere to get appropriate expressions for a ValRef. + + + + + The type equation comes from a sequence expression. + + + + + The type equation comes from a pattern match guard. + + + + + The type equation comes from a return type of a pattern match clause (not the first clause). + + + + + The type equation comes from an downcast where a upcast could be used. + + + + + The type equation comes from a runtime type test. + + + + + The type equation comes from a yield in a computation expression. + + + + + The type equation comes from a return in a computation expression. + + + + + The type equation comes from a list or array constructor + + + + + The type equation comes from the verification of a tuple in record fields. + + + + + The type equation comes from the verification of record fields. + + + + + The type equation comes from a type check of the result of an else branch. + + + + + The type equation comes from an omitted else branch. + + + + + The type equation comes from an IF expression. + + + + + No context was given. + + + + + Information about the context of a type equation. + + + + + Given a set of formal type parameters and their constraints, make new inference type variables for + each and ensure that the constraints on the new type variables are adjusted to refer to these. + + + + + Create a list of inference type variables, one for each element in the input list + + + + + Create an inference type variable representing an error condition when checking a measure + + + + + Create an inference type variable representing an error condition when checking an expression + + + + + Create an inference type variable for the kind of a byref pointer + + + + + Create an inference type variable + + + + + Create a type variable representing the use of a "_" in F# code + + + + + Solves constraints using a mutable constraint-solver state + + + + + Parse "printf-style" format specifiers at compile time, producing + a list of items that specify the types of the things that follow. + + Must be updated if the Printf runtime component is updated. + + + + + Find all unsolved inference variables after type inference for an entire file + + + + + Indicates that type references are emitted as integer indexes into a supplied table + + + + + Perform the checks on the TAST for a file after type inference is complete. + + + + + Implements a set of checks on the TAST for a file that can only be performed after type inference + is complete. + + + + + Optimization information + + + + + Check if an expression has an effect + + + + + Combine optimization infos + + + + + Ensure that 'internal' items are not exported in the optimization info + + + + + Rewrite the module info using the export remapping + + + + + Saving and re-reading optimization information + + + + + Optimize one implementation file in the given environment + + + + + For building optimization environments incrementally + + + + + top of expr toplevel? (true) + + + + + val not defined under lambdas + + + + + v -> recursive? * v list -- the others in the mutual binding + + + + + bound in a decision tree? + + + + + v -> binding repr + + + + + v -> context / APP inst args + + + + + Results is "expr information". + This could extend to be a full graph view of the expr. + Later could support "safe" change operations, and optimisations could be in terms of those. + + + + + Analyze a TAST expression to detect the elaborated form of a sequence expression. + Then compile it to a state machine represented as a TAST containing goto, return and label nodes. + The returned state machine will also contain references to state variables (from internal 'let' bindings), + a program counter (pc) that records the current state, and a current generated value (current). + All these variables are then represented as fields in a hosting closure object along with any additional + free variables of the sequence expression. + + + + + An "expr -> expr" pass that eta-expands under-applied values of + known arity to lambda expressions and beta-var-reduces to bind + any known arguments. The results are later optimized by the peephole + optimizer in opt.fs + + + + + Rewrite mutable locals to reference cells across an entire implementation file + + + + + Invert the compilation of the given value and return its current dynamic value and its compiled System.Type + + + + + Generate ILX code for an assembly fragment + + + + + Invert the compilation of the given value and clear the storage of the value + + + + + Register a fragment of the current assembly with the ILX code generator. If 'isIncrementalFragment' is true then the input + is assumed to be a fragment 'typed' into FSI.EXE, otherwise the input is assumed to be the result of a '#load' + + + + + Register a set of referenced assemblies with the ILX code generator + + + + + Create an incremental ILX code generator for a single assembly + + + + + An incremental ILX code generator for a single assembly + + + + + Used to support the compilation-inversion operations "ClearGeneratedValue" and "LookupGeneratedValue" + + + + + The generated IL/ILX resources associated with F# quotations + + + + + The security attributes to attach to the assembly + + + + + The attributes for the assembly in F# form + + + + + The generated IL/ILX .NET module attributes + + + + + The generated IL/ILX assembly attributes + + + + + The generated IL/ILX type definitions + + + + + The results of the ILX compilation of one fragment of an assembly + + + + + Indicates that, whenever possible, use callvirt instead of call + + + + + Indicates the code generated is an interactive 'it' expression. We generate a setter to allow clearing of the underlying + storage, even though 'it' is not logically mutable + + + + + Indicates the code is being generated in FSI.EXE and is executed immediately after code generation + This includes all interactively compiled code, including #load, definitions, and expressions + + + + + Indicates which backend we are generating code for + + + + + A flag to help test emit of debug information + + + + + Indicates if we are generating debug symbols or not + + + + + Indicates if local optimizations are active + + + + + If this is set, then the last module becomes the "main" module + + + + + Indicates if static array data should be emitted using static blobs + + + + + Indicates if we should workaround old reflection emit bugs + + + + + Indicates if we are generating filter blocks + + + + + Indicates how the generated IL code is ultimately emitted + + + + + Determine if an F#-declared value, method or function is compiled as a method. + + + + + Diagnostics seen while processing the compiler options implied root of closure + + + + + Diagnostics to show for root of closure (used by fsc.fs) + + + + + Diagnostics seen while processing resolutions + + + + + The #nowarns + + + + + The original #load references, including those that didn't resolve + + + + + The list of all sources in the closure with inputs when available, with associated parse errors and warnings + + + + + The list of references that were not resolved during load closure. + + + + + The resolved references along with the ranges of the #r positions in each file. + + + + + The source files along with the ranges of the #load positions in each file. + + + + + A temporary TcConfig is created along the way, is why this routine takes so many arguments. We want to be sure to use exactly the + same arguments as the rest of the application. + + + + + Analyze a set of script files and find the closure of their references. The resulting references are then added to the given TcConfig. + Used from fsi.fs and fsc.fs, for #load and command line. + + + + + Get the typing environment implied by the set of signature files and/or inferred signatures of implementation files checked so far + + + + + Get the typing environment implied by the set of implementation files checked so far + + + + + The inferred contents of the assembly, containing the signatures of all files. + + + + + The CcuThunk for the current assembly being checked + + + + + Represents the incremental type checking state for a set of inputs + + + + + Try to resolve a referenced assembly based on TcConfig settings. + + + + + Try to find a provider-generated assembly + + + + + Try to find the given assembly reference by simple name. Used in magic assembly resolution. Effectively does implicit + unification of assemblies by simple assembly name. + + + + + Try to find the given assembly reference. + + + + + Resolve a referenced assembly and report an error if the resolution fails. + + + + + Report unresolved references that also weren't consumed by any type providers. + + + + + This excludes any framework imports (which may be shared between multiple builds) + + + + + Represents a table of imported assemblies with their resolutions. + Is a disposable object, but it is recommended not to explicitly call Dispose unless you absolutely know nothing will be using its contents after the disposal. + Otherwise, simply allow the GC to collect this and it will properly call Dispose from the finalizer. + + + + + Represents a resolved imported assembly + + + + + Represents a resolved imported binary + + + + + Get a TcConfigProvider which will return only the exact TcConfig. + + + + + Get a TcConfigProvider which will continue to respect changes in the underlying + TcConfigBuilder rather than delivering snapshots. + + + + + Represents a computation to return a TcConfig. Normally this is just a constant immutable TcConfig, + but for F# Interactive it may be based on an underlying mutable TcConfigBuilder. + + + + + Set if the user has explicitly turned indentation-aware syntax on/off + + + + + If true, indicates all type checking and code generation is in the context of fsi.exe + + + + + File system query based on TcConfig settings + + + + + File system query based on TcConfig settings + + + + + Get the loaded sources that exist and issue a warning for the ones that don't + + + + + Prevent erasure of conditional attributes and methods so tooling is able analyse them. + + + + + if true - 'let mutable x = Span.Empty', the value 'x' is a stack referring span. Used for internal testing purposes only until we get true stack spans. + + + + + A function to call to try to get an object that acts as a snapshot of the metadata section of a .NET binary, + and from which we can read the metadata. Only used when metadataOnly=true. + + + + + If true, indicates all type checking and code generation is in the context of fsi.exe + + + + + Sources added into the build with #load + + + + + Set if the user has explicitly turned indentation-aware syntax on/off + + + + + Represents the file or string used for the --version flag + + + + + Enqueue work to be done on a compilation thread. + + + + + The thread in which compilation calls will be enqueued and done work on. + Note: This is currently only used when disposing of type providers and will be extended to all the other type provider calls when compilations can be done in parallel. + Right now all calls in FCS to type providers are single-threaded through use of the reactor thread. + + + + + Whether or not this is an installed system assembly (for example, System.dll) + + + + + Create the tooltip text for the assembly reference + + + + + Path to the resolvedFile + + + + + The original reference to the assembly. + + + + + The name of the assembly file generated by the project + + + + + Get the logical timestamp that would be the timestamp of the assembly file generated by the project. + + For project references this is maximum of the timestamps of all dependent files. + The project is not actually built, nor are any assemblies read, but the timestamps for each dependent file + are read via the FileSystem. If the files don't exist, then a default timestamp is used. + + The operation returns None only if it is not possible to create an IncrementalBuilder for the project at all, e.g. if there + are fatal errors in the options for the project. + + + + + Evaluate raw contents of the assembly file generated by the project + + + + + The identity of the module + + + + + The raw IL module definition in the assembly, if any. This is not present for cross-project references + in the language service + + + + + The table of type forwarders in the assembly + + + + + The raw F# signature data in the assembly, if any + + + + + The raw F# optimization data in the assembly, if any + + + + + The raw list InternalsVisibleToAttribute attributes in the assembly + + + + + The raw list AutoOpenAttribute attributes in the assembly + + + + + Represents a reference to an F# assembly. May be backed by a real assembly on disk (read by Abstract IL), or a cross-project + reference in FSharp.Compiler.Service. + + + + + Part of LegacyHostedCompilerForTesting + + + + + Part of LegacyHostedCompilerForTesting + + + + + Part of LegacyHostedCompilerForTesting + + + + + Part of LegacyHostedCompilerForTesting + + + + + State used to de-deuplicate module names along a list of file names + + + + + Indicates if we should report a warning as an error + + + + + Indicates if we should report a warning + + + + + Check a single input and finish the checking + + + + + Check a closed set of inputs + + + + + Finish the checking of a closed set of inputs + + + + + Finish the checking of multiple inputs + + + + + Check one input, returned as an Eventually computation + + + + + Get the initial type checking state for a set of inputs + + + + + Get the initial type checking environment including the loading of mscorlib/System.Core, FSharp.Core + applying the InternalsVisibleTo in referenced assemblies and opening 'Checked' if requested. + + + + + Parse one input file + + + + + This list is the default set of references for "non-project" files. + + + + + Get an error logger that filters the reporting of warnings based on scoped pragma information + + + + + Find the scoped #nowarn pragmas with their range information + + + + + Process the #nowarn in an input + + + + + Process all the #r, #I etc. in an input + + + + + Processing # commands + + + + + Process #r in F# Interactive. + Adds the reference to the tcImports and add the ccu to the type checking environment. + + + + + Write F# optimization data as an IL resource + + + + + Write F# signature data as an IL resource + + + + + Determine if an IL resource attached to an F# assembly is an F# quotation data resource for reflected definitions + + + + + Determine if an IL resource attached to an F# assembly is an F# optimization data resource + + + + + Determine if an IL resource attached to an F# assembly is an F# signature data resource + + + + + Part of LegacyHostedCompilerForTesting + + + + + Output extra context information for an error or warning to a buffer + + + + + Output an error or warning to a buffer + + + + + Output an error to a buffer + + + + + Split errors into a "main" error and a set of associated errors + + + + + Get the number associated with an error + + + + + Get the location associated with an error + + + + + Parse a single input (A signature file or implementation file) + + + + + Checks if a ParsedInput is using a module name that was already given and deduplicates the name if needed. + + + + + Get the name used for FSharp.Core + + + + + File suffixes where #light is the default + + + + + Script file suffixes + + + + + Implementation file suffixes + + + + + Signature file suffixes + + + + + Coordinating compiler operations - configuration, loading initial context, reporting errors etc. + + + + + CompilerOption(name, argumentDescriptionString, actionSpec, exceptionOpt, helpTextOpt + + + + + The spec value describes the action of the argument, + and whether it expects a following parameter. + + + + + Apply args to TcConfigBuilder and return new list of source files + + + + + Parse and process a set of compiler options + + + + + The default ErrorLogger implementation, reporting messages to the Console up to the maxerrors maximum + + + + + Part of LegacyHostedCompilerForTesting + + + + + Process the given set of command line arguments + + + + + Set the concrete inputs for this build. + + + + + Declare a named vector output. + + + + + Declare a named scalar output. + + + + + Declare build outputs and bind them to real values. + Only required for unit testing. + + + + + Declare a named scalar output. + + + + + A set of build rules and the corresponding, possibly partial, results from building. + + + + + Get an element of vector result or None if there were no results. Only required for unit testing. + + + + + Get a result vector. All results must be available or thrown an exception. Only required for unit testing. + + + + + Get a scalar vector. Result must be available. Only required for unit testing. + + + + + Do one step in the build. Only required for unit testing. + + + + + Evaluate a build for a vector up to a limit. Only required for unit testing. + + + + + Evaluate a build. Only required for unit testing. + + + + + Used for unit testing. Causes all steps of underlying incremental graph evaluation to cancel + + + + + Declares a scalar build input. + Only required for unit testing. + + + + + Declares a vector build input. + Only required for unit testing. + + + + + Convert a Vector into a Scalar. + + + + + Apply a function to a vector to get a scalar value. + + + + + Apply a function to each element of the vector, threading an accumulator argument + through the computation. Returns intermediate results in a vector. + + + + + Updates the creates a new vector with the same items but with + timestamp specified by the passed-in function. + + + + + Maps one vector to another using the given function. + + + + + Methods for acting on build Vectors + Only required for unit testing. + + + + + Generalized Incremental Builder. This is exposed only for unittesting purposes. + + + + + Used for unit testing + + + + + Tests whether the user is typing something like "member x." or "override (*comment*) x." + + + + + Get the partial long name of the identifier to the left of index. + For example, for `System.DateTime.Now` it returns PartialLongName ([|"System"; "DateTime"|], "Now", Some 32), where "32" pos of the last dot. + + + + + Get the partial long name of the identifier to the left of index. + + + + + Given a string and a position in that string, find an identifier as + expected by `GotoDefinition`. This will work when the cursor is + immediately before the identifier, within the identifier, or immediately + after the identifier. + + 'tolerateJustAfter' indicates that we tolerate being one character after the identifier, used + for goto-definition + + In general, only identifiers composed from upper/lower letters and '.' are supported, but there + are a couple of explicitly handled exceptions to allow some common scenarios: + - When the name contains only letters and '|' symbol, it may be an active pattern, so we + treat it as a valid identifier - e.g. let ( |Identitiy| ) a = a + (but other identifiers that include '|' are not allowed - e.g. '||' operator) + - It searches for double tick (``) to see if the identifier could be something like ``a b`` + + REVIEW: Also support, e.g., operators, performing the necessary mangling. + (i.e., I would like that the name returned here can be passed as-is + (post `.`-chopping) to `GetDeclarationLocation.) + + In addition, return the position where a `.` would go if we were making + a call to `DeclItemsForNamesAtPosition` for intellisense. This will + allow us to use find the correct qualified items rather than resorting + to the more expensive and less accurate environment lookup. + + + + + Puts us after the last character. + + + + + Methods for cheaply and innacurately parsing F#. + + These methods are very old and are mostly to do with extracting "long identifier islands" + A.B.C + from F# source code, an approach taken from pre-F# VS samples for implementing intelliense. + + This code should really no longer be needed since the language service has access to + parsed F# source code ASTs. However, the long identifiers are still passed back to GetDeclarations and friends in the + F# Compiler Service and it's annoyingly hard to remove their use completely. + + In general it is unlikely much progress will be made by fixing this code - it will be better to + extract more information from the F# ASTs. + + It's also surprising how hard even the job of getting long identifier islands can be. For example the code + below is inaccurate for long identifier chains involving ``...`` identifiers. And there are special cases + for active pattern names and so on. + + + + + This represents the global state established as each task function runs as part of the build. + + Use to reset error and warning handlers. + + + + + Get the captured errors + + + + + Create the error logger + + + + + An error logger that capture errors, filtering them according to warning levels etc. + + + + + A list of data tip elements to display. + + + + + Information for building a tool tip box. + + + + + A single data tip display element with where text is expressed as <see cref="Layout"/> + + + + + A single data tip display element with where text is expressed as string + + + + + An error occurred formatting this element + + + + + A single type, method, etc with comment. May represent a method overload group. + + + + + A single tool tip display element + + + + + Parameter name + + + + + Extra text, goes at the end + + + + + typar insantiation text, to go after xml + + + + + A single data tip display element + + + + + Indicates that the text for the documentation can be found in a .xml documentation file, using the given signature key + + + + + The text for documentation + + + + + No documentation is available + + + + + Describe a comment as either a block of text or a file+signature reference into an intellidoc file. + + + + + The symbol referenced + + + + + The range of text representing the reference to the symbol + + + + + Indicates if the reference is in a syntactic type + + + + + Indicates if the reference is in a pattern + + + + + Indicates if the reference is in open statement + + + + + Indicates if the reference is via the member being implemented in a class or object expression + + + + + Indicates if the reference is a definition for the symbol, either in a signature or implementation + + + + + Indicates if the reference is either a builder or a custom operation in a computation expression + + + + + Indicates if the reference is in an attribute + + + + + The file name the reference occurs in + + + + + The display context active at the point where the symbol is used. Can be passed to FSharpType.Format + and other methods to format items in a way that is suitable for a specific source code location. + + + + + Represents the use of an F# symbol from F# source code + + + + + Range of the open declaration. + + + + + Modules or namespaces which is opened with this declaration. + + + + + Idents. + + + + + If it's `namespace Xxx.Yyy` declaration. + + + + + Scope in which open declaration is visible. + + + + + Represents open declaration in F# code. + + + + + The named arguments for the attribute + + + + + Indicates if the attribute type is in an unresolved assembly + + + + + The arguments to the constructor for the attribute + + + + + The type of the attribute + + + + + Format the attribute using the rules of the given display context + + + + + Represents a custom attribute attached to F# source code or a compiler .NET component + + + + + Get the type definition for a type + + + + + Indicates this is a named type in an unresolved assembly + + + + + Indicates if the type is a tuple type (reference or struct). The GenericArguments property returns the elements of the tuple type. + + + + + Indicates if the type is a struct tuple type. The GenericArguments property returns the elements of the tuple type. + + + + + Indicates if the type is a variable type, whether declared, generalized or an inference type parameter + + + + + Indicates if the type is a function type. The GenericArguments property returns the domain and range of the function type. + + + + + Indicates if the type is an anonymous record type. The GenericArguments property returns the type instantiation of the anonymous record type + + + + + Indicates this is an abbreviation for another type + + + + + Indicates if the type is constructed using a named entity, including array and byref types + + + + + Get the generic parameter data for a generic parameter type + + + + + Get the generic arguments for a tuple type, a function type or a type constructed using a named entity + + + + + Get the base type, if any, taking into account the instantiation of this type + if it is an instantiation of a generic type. + + + + + Get the details of the anonymous record type. + + + + + Get all the interface implementations, by walking the type hierarchy, taking into account the instantiation of this type + if it is an instantiation of a generic type. + + + + + Get the type for which this is an abbreviation + + + + + Adjust the types in a group of curried parameters and return type by removing any occurrences of type inference variables, replacing them + systematically with lower-case type inference variables such as <c>'a</c>. + + + + + Adjust the types in a group of curried parameters by removing any occurrences of type inference variables, replacing them + systematically with lower-case type inference variables such as <c>'a</c>. + + + + + Adjust the types in a group of parameters by removing any occurrences of type inference variables, replacing them + systematically with lower-case type inference variables such as <c>'a</c>. + + + + + Adjust the type in a single parameter by removing any occurrences of type inference variables, replacing them + systematically with lower-case type inference variables such as <c>'a</c>. + + + + + Adjust a group of types by removing any occurrences of type inference variables, replacing them + systematically with lower-case type inference variables such as <c>'a</c>. + + + + + Adjust the type by removing any occurrences of type inference variables, replacing them + systematically with lower-case type inference variables such as <c>'a</c>. + + + + + Instantiate generic type parameters in a type + + + + + Format the type using the rules of the given display context + + + + + Format the type using the rules of the given display context + + + + + Internal use only. Create a ground type. + + + + + Get the type indicating signature of the active pattern + + + + + The names of the active pattern cases + + + + + The whole group name + + + + + Indicate this is a total active pattern + + + + + Try to get the entity in which the active pattern is declared + + + + + Represents all cases within an active pattern + + + + + XML documentation signature for the active pattern case, used for .xml file lookup for compiled code + + + + + Get the in-memory XML documentation for the active pattern case, used when code is checked in-memory + + + + + The name of the active pattern case + + + + + Index of the case in the pattern group + + + + + The group of active pattern cases this belongs to + + + + + The location of declaration of the active pattern case + + + + + A subtype of FSharpSymbol that represents a single case within an active pattern + + + + + The declared or inferred type of the parameter + + + + + The optional name of the parameter + + + + + Indicate this is a param array argument + + + + + Indicate this is an out argument + + + + + Indicate this is an optional argument + + + + + Indicate this is an in argument + + + + + The declaration location of the parameter + + + + + The declared attributes of the parameter + + + + + A subtype of FSharpSymbol that represents a parameter + + + + + XML documentation signature for the value, used for .xml file lookup for compiled code + + + + + Get the in-memory XML documentation for the value, used when code is checked in-memory + + + + + Get an associated setter method of the property + + + + + Get the logical name of the member + + + + + Indicates if this is a [<Literal>] value, and if so what value? (may be null) + + + + + Indicated if this is a value + + + + + Indicated if this is a value compiled to a method + + + + + Indicates if the member, function or value is in an unresolved assembly + + + + + Indicates if this is an F# type function + + + + + Indicates if this is a setter method for a property, or a use of a property in setter mode + + + + + Indicates if this is a setter method for a property, or a use of a property in setter mode + + + + + Indicates if this is a getter method for a property, or a use of a property in getter mode + + + + + Indicates if this is a property member + + + + + Indicates if this is an 'override', 'default' or an explicit implementation of an interface member + + + + + Indicates if this is a mutable value + + + + + Indicates if this is a module or member value + + + + + Indicates if this is the "x" in "member x.M = ..." + + + + + Indicates if this is a member, including extension members? + + + + + Indicates if this is an instance member in compiled code. + + Explanatory note: some members such as IsNone and IsSome on types with UseNullAsTrueValue appear + as instance members in F# code but are compiled as static members. + + + + + Indicates if this is an instance member, when seen from F#? + + + + + Indicates if this is an implicit constructor? + + + + + Indicates if this is a getter method for a property, or a use of a property in getter mode + + + + + Indicates if this is an extension member? + + + + + Indicates if this is an explicit implementation of an interface member + + + + + Indicates if this is a remove method for an event + + + + + Indicates if this is an add method for an event + + + + + Indicates if this is an event member + + + + + Indicates if this is an abstract member? + + + + + Indicates if this is the "x" in "type C() as x = ..." + + + + + Indicates if this is a constructor. + + + + + Indicates if this is a compiler generated value + + + + + Indicates if this is "base" in "base.M(...)" + + + + + Indicates if this value or member is an F# active pattern + + + + + Get a result indicating if this is a must-inline value + + + + + Gets the list of the abstract slot signatures implemented by the member + + + + + Indicates if this is a property and there exists an associated setter method + + + + + Indicates if this is a property and there exists an associated getter method + + + + + Get an associated getter method of the property + + + + + Get the typars of the member, function or value + + + + + Get the full type of the member, function or value when used as a first class value + + + + + Get an associated remove method of an event + + + + + Indicate if an event can be considered to be a property for the F# type system of type IEvent or IDelegateEvent. + In this case ReturnParameter will have a type corresponding to the property type. For + non-standard events, ReturnParameter will have a type corresponding to the delegate type. + + + + + Gets the event symbol implied by the use of a property, + for the case where the property is actually an F#-declared CLIEvent. + + Uses of F#-declared events are considered to be properties as far as the language specification + and this API are concerned. + + + + + Get an associated delegate type of an event + + + + + Get an associated add method of an event + + + + + Get the name as presented in F# error messages and documentation + + + + + Get the enclosing entity for the definition + + + + + Get the declaration location of the member, function or value + + + + + Get the member name in compiled code + + + + + Custom attributes attached to the value. These contain references to other values (i.e. constructors in types). Mutable to fixup + these value references after copying a collection of values. + + + + + Get the logical enclosing entity, which for an extension member is type being extended + + + + + Get the accessibility information for the member, function or value + + + + + Gets the overloads for the current method + matchParameterNumber indicates whether to filter the overloads to match the number of parameters in the current symbol + + + + + Format the type using the rules of the given display context + + + + + A subtype of F# symbol that represents an F# method, property, event, function or value, including extension members. + + + + + Indicates the value is aggressively inlined by the .NET runtime + + + + + Indicates the value is never inlined + + + + + Indicates the value is optionally inlined + + + + + Indicates the value is inlined but compiled code for the function still exists, e.g. to satisfy interfaces on objects, but that it is also always inlined + + + + + Indicates the value is inlined and compiled code for the function does not exist + + + + + Gets further information about a choice constraint + + + + + Gets further information about a member constraint + + + + + Indicates a constraint that a type is an unmanaged type + + + + + Indicates a constraint that a type has a 'null' value + + + + + Indicates a constraint that is a type is a simple choice between one of the given ground types. Used by printf format strings. + + + + + Indicates a constraint that a type has a parameterless constructor + + + + + Indicates a constraint that a type is a reference type + + + + + Indicates a constraint that a type is a non-Nullable value type + + + + + Indicates a constraint that a type has a member with the given signature + + + + + Indicates a constraint that a type supports F# generic equality + + + + + Indicates a constraint that a type is an enum with the given underlying + + + + + Indicates a constraint that a type is a delegate from the given tuple of args to the given return type + + + + + Indicates a default value for an inference type variable should it be neither generalized nor solved + + + + + Indicates a constraint that a type supports F# generic comparison + + + + + Indicates a constraint that a type is a subtype of the given type + + + + + Gets further information about an enumeration constraint + + + + + Gets further information about a delegate constraint + + + + + Gets further information about a defaults-to constraint + + + + + Gets further information about a coerces-to constraint + + + + + Represents a constraint on a generic type parameter + + + + + Get the default type associated with the 'defaults to' constraint + + + + + Get the priority off the 'defaults to' constraint + + + + + Represents further information about a 'defaults to' constraint on a generic type parameter + + + + + Get the tupled argument type required by the constraint + + + + + Get the return type required by the constraint + + + + + Represents further information about a delegate constraint on a generic type parameter + + + + + Get the types that may be used to satisfy the constraint + + + + + Get the return type of the method required by the constraint + + + + + Get the name of the method required by the constraint + + + + + Indicates if the the method required by the constraint must be static + + + + + Get the argument types of the method required by the constraint + + + + + Represents further information about a member constraint on a generic type parameter + + + + + Get the name of the static parameter + + + + + Get the kind of the static parameter + + + + + Indicates if the static parameter is optional + + + + + Get the default value for the static parameter + + + + + Get the declaration location of the static parameter + + + + + A subtype of FSharpSymbol that represents a static parameter to an F# type provider + + + + + Get the in-memory XML documentation for the type parameter, used when code is checked in-memory + + + + + Get the name of the generic parameter + + + + + Indicates if this is a statically resolved type variable + + + + + Indicates if this is a measure variable + + + + + Indicates if this is a compiler generated type parameter + + + + + Get the range of the generic parameter + + + + + Get the declared or inferred constraints for the type parameter + + + + + Get the declared attributes of the type parameter. + + + + + A subtype of FSharpSymbol that represents a generic parameter for an FSharpSymbol + + + + + Represents the rights of a compilation to access symbols + + + + + Get the XML documentation signature for .xml file lookup for the field, used for .xml file lookup for compiled code + + + + + Get the in-memory XML documentation for the field, used when code is checked in-memory + + + + + Get the attributes attached to generated property + + + + + Get the name of the field + + + + + Get the default initialization info, for static literals + + + + + Indicates if the field is declared volatile + + + + + Indicates if the record field is for a type in an unresolved assembly + + + + + Indicates a static field + + + + + Indicates if the field name was generated by compiler (e.g. ItemN names in union cases and DataN in exceptions). + This API returns true for source defined symbols only. + + + + + Indicates if the field is declared 'static' + + + + + Indicates if the field has a literal value + + + + + Indicates if the field declared is declared 'DefaultValue' + + + + + Indicates a compiler generated field, not visible to Intellisense or name resolution + + + + + Is this a field from an anonymous record type? + + + + + Get the type of the field, w.r.t. the generic parameters of the enclosing type constructor + + + + + Get the attributes attached to generated field + + + + + Get the declaring entity of this field, if any. Fields from anonymous types do not have a declaring entity + + + + + Get the declaration location of the field + + + + + If the field is from an anonymous record type then get the details of the field including the index in the sorted array of fields + + + + + Indicates if the declared visibility of the field, not taking signatures into account + + + + + A subtype of FSharpSymbol that represents a record or union case field as seen by the F# language + + + + + The sorted labels of the anonymous type + + + + + Names of any enclosing types of the compiled form of the anonymous type (if the anonymous type was defined as a nested type) + + + + + The name of the compiled form of the anonymous type + + + + + The assembly where the compiled form of the anonymous type is defined + + + + + A subtype of FSharpSymbol that represents a record or union case field as seen by the F# language + + + + + Get the XML documentation signature for .xml file lookup for the union case, used for .xml file lookup for compiled code + + + + + Get the in-memory XML documentation for the union case, used when code is checked in-memory + + + + + Get the data carried by the case. + + + + + Get the type constructed by the case. Normally exactly the type of the enclosing type, sometimes an abbreviation of it + + + + + Get the name of the union case + + + + + Indicates if the union case is for a type in an unresolved assembly + + + + + Get the range of the name of the case + + + + + Get the name of the case in generated IL code + + + + + Get the attributes for the case, attached to the generated static method to make instances of the case + + + + + Indicates if the declared visibility of the union constructor, not taking signatures into account + + + + + A subtype of FSharpSymbol that represents a union case as seen by the F# language + + + + + Get the name of the abstract slot + + + + + Get the generic arguments of the abstract slot + + + + + Get the generic arguments of the type defining the abstract slot + + + + + Get the declaring type of the abstract slot + + + + + Get the return type of the abstract slot + + + + + Get the arguments of the abstract slot + + + + + Represents the signature of an abstract slot of a class or interface + + + + + The declared or inferred type of the parameter + + + + + The optional name of the parameter + + + + + Indicate this is an out argument + + + + + Indicate this is an optional argument + + + + + Indicate this is an in argument + + + + + The declared attributes of the parameter + + + + + Represents a parameter in an abstract method of a class or interface + + + + + Get the return type of the delegate signature + + + + + Get the argument types of the delegate signature + + + + + Represents a delegate signature in an F# symbol + + + + + Get the XML documentation signature for the entity, used for .xml file lookup for compiled code + + + + + Get the in-memory XML documentation for the entity, used when code is checked in-memory + + + + + Indicates if the type prefers the "tycon<a,b>" syntax for display etc. + + + + + Get the cases of a union type + + + + + Get the full name of the type or module if it is available + + + + + Get the static parameters for a provided type + + + + + Get the declared accessibility of the representation, not taking signatures into account + + + + + Get the fully qualified name of the type or module + + + + + Get the modules and types defined in a module, or the nested types of a type + + + + + Get the namespace containing the type or module, if any. Use 'None' for item not in a namespace. + + + + + Get the properties, events and methods of a type definitions, or the functions and values of a module + + + + + Get the name of the type or module, possibly with `n mangling + + + + + Indicates if the entity is a struct or enum + + + + + Indicates if the entity is in an unresolved assembly + + + + + Indicates if the entity is a 'fake' symbol related to a static instantiation of a type provider + + + + + Indicates if the entity is a generated provided type + + + + + Indicates if the entity is an erased provided type + + + + + Indicates if the entity is a provided type + + + + + Indicates if the entity is a type definition for a reference type where the implementation details are hidden by a signature + + + + + Indicates if the entity is a part of a namespace path + + + + + Indicates if the entity is a measure definition + + + + + Indicates if the entity is an interface type definition + + + + + Indicates if the entity is union type + + + + + Indicates if the entity is record type + + + + + Indicates if the entity is an F# module definition + + + + + Indicates an F# exception declaration + + + + + Indicates if the entity is a measure, type or exception abbreviation + + + + + Indicates if this is a reference to something in an F#-compiled assembly + + + + + Indicates if the entity is an enum type definition + + + + + Indicates if the entity is a delegate type definition + + + + + Indicates if the entity is a class type definition + + + + + Indicates if is the 'byref<_>' type definition used for byref types in F#-compiled assemblies + + + + + Check if the entity inherits from System.Attribute in its type hierarchy + + + + + Indicates if the entity is an array type + + + + + Indicates that a module is compiled to a class with the given mangled name. The mangling is reversed during lookup + + + + + Indicates if the type is implemented through a mapping to IL assembly code. This is only + true for types in FSharp.Core.dll + + + + + Get the generic parameters, possibly including unit-of-measure parameters + + + + + Get the full name of the type or module + + + + + Get the fields of a record, class, struct or enum from the perspective of the F# language. + This includes static fields, the 'val' bindings in classes and structs, and the value definitions in enums. + For classes, the list may include compiler generated fields implied by the use of primary constructors. + + + + + Indicates if the type is a delegate with the given Invoke signature + + + + + Get the name of the type or module as displayed in F# code + + + + + Get the enclosing entity for the definition + + + + + Get the declared interface implementations + + + + + Get the declaration location for the type constructor + + + + + Get the compiled name of the type or module, possibly with `n mangling. This is identical to LogicalName + unless the CompiledName attribute is used. + + + + + Get the base type, if any + + + + + Get the declared attributes for the type + + + + + Get the rank of an array type + + + + + Get all the interface implementations, by walking the type hierarchy + + + + + Get all compilation paths, taking `Module` suffixes into account. + + + + + Get all active pattern cases defined in all active patterns in the module. + + + + + Get the declared accessibility of the type + + + + + Get the path used to address the entity (e.g. "Namespace.Module1.NestedModule2"). Gives + "global" for items not in a namespace. + + + + + Get the type abbreviated by an F# type abbreviation + + + + + A subtype of FSharpSymbol that represents a type definition or module as seen by the F# language + + + + + The (non-nested) module and type definitions in this signature + + + + + Get the declared attributes for the assembly. + Only available when parsing an entire project. + + + + + Find entity using compiled names + + + + + Represents an inferred signature of part of an assembly as seen by the F# language + + + + + The simple name for the assembly + + + + + The qualified name of the assembly + + + + + Indicates if the assembly was generated by a type provider and is due for static linking + + + + + The file name for the assembly, if any + + + + + The contents of the this assembly + + + + + Represents an assembly as seen by the F# language + + + + + Get the signature location for the symbol if it was declared in an implementation + + + + + Get the implementation location for the symbol if it was declared in a signature that has an implementation + + + + + Get a textual representation of the full name of the symbol. The text returned for some symbols + may not be a valid identifier path in F# code, but rather a human-readable representation of the symbol. + + + + + Gets the short display name for the symbol + + + + + Get the declaration location for the symbol + + + + + Get the assembly declaring this symbol + + + + + Return true if two symbols are effectively the same when referred to in F# source code text. + This sees through signatures (a symbol in a signature will be considered effectively the same as + the matching symbol in an implementation). In addition, other equivalances are applied + when the same F# source text implies the same declaration name - for example, constructors + are considered to be effectively the same symbol as the corresponding type definition. + + This is the relation used by GetUsesOfSymbol and GetUsesOfSymbolInFile. + + + + + Computes if the symbol is accessible for the given accessibility rights + + + + + A hash compatible with the IsEffectivelySameAs relation + + + + + Represents a symbol in checked F# source code or a compiled .NET component. + + The subtype of the symbol may reveal further information and can be one of FSharpEntity, FSharpUnionCase + FSharpField, FSharpGenericParameter, FSharpStaticParameter, FSharpMemberOrFunctionOrValue, FSharpParameter, + or FSharpActivePatternCase. + + + + + Represents the information needed to format types and other information in a style + suitable for use in F# source text at a particular source location. + + Acquired via GetDisplayEnvAtLocationAlternate and similar methods. May be passed + to the Format method on FSharpType and other methods. + + + + + Indicates the symbol has public accessibility. + + + + + Indicates the symbol has protected accessibility. + + + + + Indicates the symbol has private accessibility. + + + + + Indicates the symbol has internal accessibility. + + + + + The underlying Accessibility + + + + + Indicates the accessibility of a symbol, as seen by the F# language + + + + + The signature of the implemented abstract slot + + + + + The generic parameters of the method + + + + + The parameters of the method + + + + + The expression that forms the body of the method + + + + + Represents a checked method in an object expression, as seen by the F# language. + + + + + The type of the expression + + + + + The range of the expression + + + + + The immediate sub-expressions of the expression. + + + + + Represents a checked and reduced expression, as seen by the F# language. The active patterns + in 'FSharp.Compiler.SourceCodeServices' can be used to analyze information about the expression. + + Pattern matching is reduced to decision trees and conditional tests. Some other + constructs may be represented in reduced form. + + + + + Represents the declaration of a static initialization action + + + + + Represents the declaration of a member, function or value, including the parameters and body of the member + + + + + Represents the declaration of a type + + + + + Represents a declaration in an implementation file, as seen by the F# language + + + + + The qualified name acts to fully-qualify module specifications and implementations + + + + + Indicates if the implementation file is a script + + + + + Indicates if the implementation file has an explicit entry point + + + + + Get the system path of the implementation file + + + + + Get the declarations that make up this implementation file + + + + + Represents the definitional contents of a single file or fragment in an assembly, as seen by the F# language + + + + + The contents of the implementation files in the assembly + + + + + Represents the definitional contents of an assembly, as seen by the F# language + + + + + The timespan in milliseconds before background work begins after the operations queue is empty + + + + + Get the reactor + + + + + The timespan in milliseconds before background work begins after the operations queue is empty + + + + + For debug purposes + + + + + Block until the current implicit background build is complete. Unit test only. + + + + + Allows to specify the language for error messages + + + + + Set the background building function, which is called repeatedly + until it returns 'false'. If None then no background operation is used. + + + + + Enqueue an uncancellable operation and return immediately. + + + + + Put the operation in the queue, and return an async handle to its result. + + + + + Block until all operations in the queue are complete + + + + + Cancel any work being don by the background building function. + + + + + Reactor is intended for long-running but interruptible operations, interleaved + with one-off asynchronous operations. + + It is used to guard the global compiler state while maintaining responsiveness on + the UI thread. + Reactor operations + + + + + Enqueue an operation and return immediately. + + + + + Put the operation in the queue, and return an async handle to its result. + + + + + Represents the capability to schedule work in the compiler service operations queue for the compilation thread + + + + + Tokenizer for a source file. Holds some expensive-to-compute resources at the scope of the file. + + + + + Scan one token from the line + + + + + Object to tokenize a line of F# source code, starting with the given lexState. The lexState should be FSharpTokenizerLexState.Initial for + the first line of text. Returns an array of ranges of the text and two enumerations categorizing the + tokens and characters covered by that range, i.e. FSharpTokenColorKind and FSharpTokenCharKind. The enumerations + are somewhat adhoc but useful enough to give good colorization options to the user in an IDE. + + A new lexState is also returned. An IDE-plugin should in general cache the lexState + values for each line of the edited code. + + + + + The full length consumed by this match, including delayed tokens (which can be ignored in naive lexers) + + + + + Provides additional information about the token + + + + + The tag is an integer identifier for the token + + + + + Actions taken when the token is typed + + + + + Gives an indication of the class to assign to the token an IDE + + + + + Right column of the token. + + + + + Left column of the token. + + + + + Information about a particular token from the tokenizer + + + + + Gives an indication of the class to assign to the characters of the token an IDE + + + + + Gives an indication of what should happen when the token is typed in an IDE + + + + + Gives an indicattion of the color class to assign to the token an IDE + + + + + Represents stable information for the state of the laxing engine at the end of a line + + + + + Represents encoded information for the end-of-line continuation of lexing + + + + + Represents result of 'GetNavigationItems' operation - this contains + all the members and currently selected indices. First level correspond to + types & modules and second level are methods etc. + + + + + Represents top-level declarations (that should be in the type drop-down) + with nested declarations (that can be shown in the member drop-down) + + + + + Represents an item to be displayed in the navigation bar + + + + + Indicates a kind of item to show in an F# navigation bar + + + + + The locations of commas and close parenthesis (or, last char of last arg, if no final close parenthesis) + + + + + The location of the open-parentheses + + + + + Either empty or a name if an actual named parameter; f(0,a=4,?b=None) would be [|None; Some "a"; Some "b"|] + + + + + The start location of long identifier prior to the open-parentheses + + + + + The end location of long identifier prior to the open-parentheses + + + + + The text of the long identifier prior to the open-parentheses + + + + + Is false if either this is a call without parens "f x" or the parser recovered as in "f(x,y" + + + + + Find the information about parameter info locations at a particular source location + + + + + Represents the locations relevant to activating parameter info in an IDE + + + + + completing pattern type (e.g. foo (x: |)) + + + + + completing named parameters\setters in parameter list of constructor\method calls + end of name ast node * list of properties\parameters that were already set + + + + + completing records field + + + + + completing something after the inherit keyword + + + + + completion context cannot be determined due to errors + + + + + The syntax tree resulting from the parse + + + + + Indicates if any errors occurred during the parse + + + + + Name of the file for which this information were created + + + + + Get the errors and warnings for the parse + + + + + When these files change then the build is invalid + + + + + Return the inner-most range associated with a possible breakpoint location + + + + + Get declared items and the selected item at the specified location + + + + + Notable parse info for ParameterInfo at a given location + + + + + Represents the results of parsing an F# file + + + + + The methods (or other items) in the group + + + + + The shared name of the methods (or other items) in the group + + + + + Represents a group of methods (or other items) returned by GetMethods. + + + + + The documentation for the item + + + + + The The structured description representation for the method (or other item) + + + + + The structured description representation for the method (or other item) + + + + + Does the type name or method support a static arguments list, like TP<42,"foo"> or conn.CreateCommand<42, "foo">(arg1, arg2)? + + + + + The formatted type text for the method (or other item) + + + + + The parameters of the method in the overload set + + + + + Does the method support an arguments list? This is always true except for static type instantiations like TP<42,"foo">. + + + + + Does the method support a params list arg? + + + + + The formatted description text for the method (or other item) + + + + + Represents one method (or other item) in a method group. The item may represent either a method or + a single, non-overloaded item such as union case or a named function value. + + + + + The structured representation for the parameter including its name, its type and visual indicators of other + information such as whether it is optional. + + + + + The name of the parameter. + + + + + Is the parameter optional + + + + + The text to display for the parameter including its name, its type and visual indicators of other + information such as whether it is optional. + + + + + A key that can be used for sorting the parameters, used to help sort overloads. + + + + + Represents one parameter for one method (or other item) in a group. + + + + + Represents a set of declarations in F# source code, with information attached ready for display by an editor. + Returned by GetDeclarations. + + + + + Get the description text, asynchronously. Never returns "Loading...". + + + + + Get the description text for the declaration. Computing this property may require using compiler + resources and may trigger execution of a type provider method to retrieve documentation. + + May return "Loading..." if timeout occurs + + + + + Get the name for the declaration as it's presented in source code. + + + + + Get the display name for the declaration. + + + + + Represents a declaration in F# source code, with information attached ready for display by an editor. + Returned by GetDeclarations. + + + + + Where open statements should be added. + + + + + Current position (F# compiler line number). + + + + + Current scope kind. + + + + + Insert open namespace context. + + + + + Kind of lexical scope. + + + + + Last part of the entity's full name. + + + + + Full display name (i.e. last ident plus modules with `RequireQualifiedAccess` attribute prefixed). + + + + + Namespace that is needed to open to make the entity resolvable in the current scope. + + + + + Ident parts needed to append to the current ident to make it resolvable in current scope. + + + + + Full name, relative to the current scope. + + + + + Helper data structure representing a symbol, sutable for implementing unresolved identifiers resolution code fixes. + + + + + Lond identifier (i.e. it may contain dots). + + + + + Performs an operation on the cache in thread safe manner. + + + + + Clears the cache. + + + + + Thread safe wrapper over `IAssemblyContentCache`. + + + + + Try get an assembly cached content. + + + + + Store an assembly content. + + + + + Assembly content cache. + + + + + Assembly content. + + + + + Content type used to get assembly content. + + + + + Assembly file last write time. + + + + + `RawEntity` list retrieved from an assembly. + + + + + Cache display name and namespace, used for completion. + + + + + Function that returns `EntityKind` based of given `LookupKind`. + + + + + Parent module that has `AutoOpen` attribute. + + + + + Parent module that has the largest scope and has `RequireQualifiedAccess` attribute. + + + + + The most narrative parent module that has `RequireQualifiedAccess` attribute. + + + + + `FSharpEntity.Namespace`. + + + + + Entity name parts with removed module suffixes (Ns.M1Module.M2Module.M3.entity -> Ns.M1.M2.M3.entity) + and replaced compiled names with display names (FSharpEntity.DisplayName, FSharpValueOrFucntion.DisplayName). + Note: *all* parts are cleaned, not the last one. + + + + + Full entity name as it's seen in compiled code (raw FSharpEntity.FullName, FSharpValueOrFunction.FullName). + + + + + Represents type, module, member, function or value in a compiled assembly. + + + + + Assembly path. + + + + + Entity lookup type. + + + + + Array of `MaybeUnresolvedIdent`. + + + + + `ShortIdent` with a flag indicating if it's resolved in some scope. + + + + + An array of `ShortIdent`. + + + + + Short identifier, i.e. an identifier that contains no dots. + + + + + All assembly content. + + + + + Public assembly content only. + + + + + Assembly content type. + + + + + Represent an Xml documentation block in source code + + + + + Represents a symbol in an external (non F#) assembly + + + + + Represents the type of a single method parameter + + + + + Type variable defined in non-F# assembly. + + + + + Pointer defined in non-F# assembly. + + + + + Array of type that is defined in non-F# assembly. + + + + + Type defined in non-F# assembly. + + + + + Represents a type in an external (non F#) assembly. + + + + + Get the resolution of the ProjectOptions + + + + + Indicates if critical errors existed in the project options + + + + + The errors returned by processing the project + + + + + Indicates the set of files which must be watched to accurately track changes that affect these results, + Clients interested in reacting to updates to these files should watch these files and take actions as described + in the documentation for compiler service. + + + + + Get a view of the overall signature of the assembly. Only valid to use if HasCriticalErrors is false. + + + + + Get a view of the overall contents of the assembly. Only valid to use if HasCriticalErrors is false. + + + + + Get the textual usages that resolved to the given symbol throughout the project + + + + + Get an optimized view of the overall contents of the assembly. Only valid to use if HasCriticalErrors is false. + + + + + Get all textual usages of all symbols throughout the project + + + + + A handle to the results of CheckFileInProject. + + + + + Success + + + + + Aborted because cancellation caused an abandonment of the operation + + + + + The result of calling TypeCheckResult including the possibility of abort and background compiler not caught up. + + + + + Get the resolution of the ProjectOptions + + + + + Get a view of the contents of the assembly up to and including the file just checked + + + + + Open declarations in the file, including auto open modules. + + + + + Represents complete typechecked implementation file, including its typechecked signatures if any. + + + + + Indicates whether type checking successfully occurred with some results returned. If false, indicates that + an unrecoverable error in earlier checking/parsing/resolution steps. + + + + + The errors returned by parsing a source file. + + + + + Indicates the set of files which must be watched to accurately track changes that affect these results, + Clients interested in reacting to updates to these files should watch these files and take actions as described + in the documentation for compiler service. + + + + + Tries to get the current successful TcImports. This is only used in testing. Do not use it for other stuff. + + + + + Internal constructor + + + + + Internal constructor + + + + + Determines if a long ident is resolvable at a specific point. + <param name="userOpName">An optional string used for tracing compiler operations associated with this request.</param> + + + + + Determines if a long ident is resolvable at a specific point. + <param name="userOpName">An optional string used for tracing compiler operations associated with this request.</param> + + + + + Get the textual usages that resolved to the given symbol throughout the file + + + + Compute a formatted tooltip for the given location + + The line number where the information is being requested. + The column number at the end of the identifiers where the information is being requested. + The text of the line where the information is being requested. + The identifiers at the location where the information is being requested. + Used to discriminate between 'identifiers', 'strings' and others. For strings, an attempt is made to give a tooltip for a #r "..." location. Use a value from FSharpTokenInfo.Tag, or FSharpTokenTag.Identifier, unless you have other information available. + An optional string used for tracing compiler operations associated with this request. + + + Resolve the names at the given location to a use of symbol. + + The line number where the information is being requested. + The column number at the end of the identifiers where the information is being requested. + The text of the line where the information is being requested. + The identifiers at the location where the information is being requested. + An optional string used for tracing compiler operations associated with this request. + + + Compute a formatted tooltip for the given location + + The line number where the information is being requested. + The column number at the end of the identifiers where the information is being requested. + The text of the line where the information is being requested. + The identifiers at the location where the information is being requested. + Used to discriminate between 'identifiers', 'strings' and others. For strings, an attempt is made to give a tooltip for a #r "..." location. Use a value from FSharpTokenInfo.Tag, or FSharpTokenTag.Identifier, unless you have other information available. + An optional string used for tracing compiler operations associated with this request. + + + Get any extra colorization info that is available after the typecheck + + + Compute a set of method overloads to show in a dialog relevant to the given code location. The resulting method overloads are returned as symbols. + The line number where the information is being requested. + The column number at the end of the identifiers where the information is being requested. + The text of the line where the information is being requested. + The identifiers at the location where the information is being requested. + An optional string used for tracing compiler operations associated with this request. + + + Compute a set of method overloads to show in a dialog relevant to the given code location. + + The line number where the information is being requested. + The column number at the end of the identifiers where the information is being requested. + The text of the line where the information is being requested. + The identifiers at the location where the information is being requested. + An optional string used for tracing compiler operations associated with this request. + + + Get the locations of and number of arguments associated with format specifiers + + + Get the locations of format specifiers + + + Compute the Visual Studio F1-help key identifier for the given location, based on name resolution results + + The line number where the information is being requested. + The column number at the end of the identifiers where the information is being requested. + The text of the line where the information is being requested. + The identifiers at the location where the information is being requested. + An optional string used for tracing compiler operations associated with this request. + + + + Find the most precise display environment for the given line and column. + + + + Resolve the names at the given location to the declaration location of the corresponding construct. + + The line number where the information is being requested. + The column number at the end of the identifiers where the information is being requested. + The text of the line where the information is being requested. + The identifiers at the location where the information is being requested. + If not given, then get the location of the symbol. If false, then prefer the location of the corresponding symbol in the implementation of the file (rather than the signature if present). If true, prefer the location of the corresponding symbol in the signature of the file (rather than the implementation). + An optional string used for tracing compiler operations associated with this request. + + + Get the items for a declaration list in FSharpSymbol format + + + If this is present, it is used to filter declarations based on location in the + parse tree, specifically at 'open' declarations, 'inherit' of class or interface + 'record field' locations and r.h.s. of 'range' operator a..b + + The line number where the completion is happening + + Partial long name. QuickParse.GetPartialLongNameEx can be used to get it. + + + The text of the line where the completion is happening. This is only used to make a couple + of adhoc corrections to completion accuracy (e.g. checking for "..") + + + Function that returns all entities from current and referenced assemblies. + + + If text has been used from a captured name resolution from the typecheck, then + callback to the client to check if the text has changed. If it has, then give up + and assume that we're going to repeat the operation later on. + + An optional string used for tracing compiler operations associated with this request. + + + Get the items for a declaration list + + + If this is present, it is used to filter declarations based on location in the + parse tree, specifically at 'open' declarations, 'inherit' of class or interface + 'record field' locations and r.h.s. of 'range' operator a..b + + The line number where the completion is happening + + Partial long name. QuickParse.GetPartialLongNameEx can be used to get it. + + + The text of the line where the completion is happening. This is only used to make a couple + of adhoc corrections to completion accuracy (e.g. checking for "..") + + + Function that returns all entities from current and referenced assemblies. + + + If text has been used from a captured name resolution from the typecheck, then + callback to the client to check if the text has changed. If it has, then give up + and assume that we're going to repeat the operation later on. + + An optional string used for tracing compiler operations associated with this request. + + + + Get all textual usages of all symbols throughout the file + + + + + Internal constructor - check a file and collect errors + + + + + A handle to the results of CheckFileInProject. + + + + + Options used to determine active --define conditionals and other options relevant to parsing files in a project + + + + + Get the accessibility rights for this project context w.r.t. InternalsVisibleTo attributes granting access to other assemblies + + + + + Get the resolution and full contents of the assemblies referenced by the project options + + + + + Represents the checking context implied by the ProjectOptions + + + + + Indicates an external declaration was found + + + + + Indicates a declaration location was found + + + + + Indicates a declaration location was not found, with an additional reason + + + + + Represents the result of the GetDeclarationLocation operation. + + + + + Trying to find declaration of ProvidedMember without TypeProviderDefinitionLocationAttribute + + + + + Trying to find declaration of ProvidedType without TypeProviderDefinitionLocationAttribute + + + + + Source code file is not available + + + + + Generic reason: no particular information about error apart from a message + + + + + Represents the reason why the GetDeclarationLocation operation failed. + + + + + The default location of FSharp.Core.dll and fsc.exe based on the version of fsc.exe that is running + + + + + Information about the compilation environment + + + + + Get or set the pause time in milliseconds before background work is started. + + + + + A maximum number of megabytes of allocated memory. If the figure reported by <c>System.GC.GetTotalMemory(false)</c> goes over this limit, the FSharpChecker object will attempt to free memory and reduce cache sizes to a minimum.</param> + + + + + Get or set a flag which controls if background work is started implicitly. + + If true, calls to CheckFileInProject implicitly start a background check of that project, replacing + any other background checks in progress. This is useful in IDE applications with spare CPU cycles as + it prepares the project analysis results for use. The default is 'true'. + + + + + Notify the host that a project has been fully checked in the background (using file contents provided by the file system API) + + The event may be raised on a background thread. + + + + + Get or set the pause time in milliseconds before background work is started. + + + + + Raised after the maxMB memory threshold limit is reached + + + + + A maximum number of megabytes of allocated memory. If the figure reported by <c>System.GC.GetTotalMemory(false)</c> goes over this limit, the FSharpChecker object will attempt to free memory and reduce cache sizes to a minimum.</param> + + + + + Get or set a flag which controls if background work is started implicitly. + + If true, calls to CheckFileInProject implicitly start a background check of that project, replacing + any other background checks in progress. This is useful in IDE applications with spare CPU cycles as + it prepares the project analysis results for use. The default is 'true'. + + + + + Report a statistic for testability + + + + + Report a statistic for testability + + + + + Raised after a parse of a file in the background analysis. + + The event will be raised on a background thread. + + + + + Raised after a check of a file in the background analysis. + + The event will be raised on a background thread. + + + + + Current queue length of the service, for debug purposes. + In addition, a single async operation or a step of a background build + may be in progress - such an operation is not counted in the queue length. + + + + + Notify the host that the logical type checking context for a file has now been updated internally + and that the file has become eligible to be re-typechecked for errors. + + The event will be raised on a background thread. + + + + + Block until the background compile finishes. + + + + + Try to get type check results for a file. This looks up the results of recent type checks of the + same file, regardless of contents. The version tag specified in the original check of the file is returned. + If the source of the file has changed the results returned by this function may be out of date, though may + still be usable for generating intellisense menus and information. + + The filename for the file. + The options for the project or script, used to determine active --define conditionals and other options relevant to parsing. + Optionally, specify source that must match the previous parse precisely. + An optional string used for tracing compiler operations associated with this request. + + + + Tokenize a single line, returning token information and a tokenization state represented by an integer + + + + + Tokenize an entire file, line by line + + + + + Stop the background compile. + + + + + Parses a source code for a file. Returns an AST that can be traversed for various features. + + + The path for the file. The file name is also as a module name for implicit top level modules (e.g. in scripts). + The source to be parsed. + Parsing options for the project or script. + An optional string used for tracing compiler operations associated with this request. + + + + Parses a source code for a file. Returns an AST that can be traversed for various features. + + + The path for the file. The file name is also as a module name for implicit top level modules (e.g. in scripts). + The source to be parsed. + Parsing options for the project or script. + An optional string used for tracing compiler operations associated with this request. + + + + Parses a source code for a file and caches the results. Returns an AST that can be traversed for various features. + + + The path for the file. The file name is used as a module name for implicit top level modules (e.g. in scripts). + The source to be parsed. + Parsing options for the project or script. + An optional string used for tracing compiler operations associated with this request. + + + + Parse and typecheck all files in a project. + All files are read from the FileSystem API + + + The options for the project or script. + An optional string used for tracing compiler operations associated with this request. + + + + + Parse and check a source code file, returning a handle to the results + + + Note: all files except the one being checked are read from the FileSystem API + + + Return FSharpCheckFileAnswer.Aborted if a parse tree was not available. + + + + The name of the file in the project whose source is being checked. + An integer that can be used to indicate the version of the file. This will be returned by TryGetRecentCheckResultsForFile when looking up the file. + The full source for the file. + The options for the project or script. + + An item passed back to 'hasTextChangedSinceLastTypecheck' (from some calls made on 'FSharpCheckFileResults') to help determine if + an approximate intellisense resolution is inaccurate because a range of text has changed. This + can be used to marginally increase accuracy of intellisense results in some situations. + + An optional string used for tracing compiler operations associated with this request. + + + + This function is called when a project has been cleaned/rebuilt, and thus any live type providers should be refreshed. + + An optional string used for tracing compiler operations associated with this request. + + + + Parse a source code file, returning information about brace matching in the file. + Return an enumeration of the matching parenthetical tokens in the file. + + + The filename for the file, used to help caching of results. + The full source for the file. + Parsing options for the project or script. + An optional string used for tracing compiler operations associated with this request. + + + + Parse a source code file, returning information about brace matching in the file. + Return an enumeration of the matching parenthetical tokens in the file. + + + The filename for the file, used to help caching of results. + The full source for the file. + Parsing options for the project or script. + An optional string used for tracing compiler operations associated with this request. + + + + This function is called when the configuration is known to have changed for reasons not encoded in the ProjectOptions. + For example, dependent references may have been deleted or created. + <param name="startBackgroundCompileIfAlreadySeen">Start a background compile of the project if a project with the same name has already been seen before.</param> + <param name="userOpName">An optional string used for tracing compiler operations associated with this request.</param> + + + + + This function is called when the entire environment is known to have changed for reasons not encoded in the ProjectOptions of any project/compilation. + + + + + For a given script file, get the FSharpProjectOptions implied by the #load closure. + All files are read from the FileSystem API, except the file being checked. + + + Used to differentiate between scripts, to consider each script a separate project. + Also used in formatted error messages. + + Indicates when the script was loaded into the editing environment, + so that an 'unload' and 'reload' action will cause the script to be considered as a new project, + so that references are re-resolved. + An optional string used for tracing compiler operations associated with this request. + + + + Get the FSharpProjectOptions implied by a set of command line arguments. + + + Used to differentiate between projects and for the base directory of the project. + The command line arguments for the project build. + Indicates when the script was loaded into the editing environment, + so that an 'unload' and 'reload' action will cause the script to be considered as a new project, + so that references are re-resolved. + + + + Get the FSharpParsingOptions implied by a FSharpProjectOptions. + + + The command line arguments for the project build. + + + + Get the FSharpParsingOptions implied by a set of command line arguments. + + + The command line arguments for the project build. + + + + Get the FSharpParsingOptions implied by a set of command line arguments and list of source files. + + + Initial source files list. Additional files may be added during argv evaluation. + The command line arguments for the project build. + + + + Like ParseFile, but uses results from the background builder. + All files are read from the FileSystem API, including the file being checked. + + + The filename for the file. + The options for the project or script, used to determine active --define conditionals and other options relevant to parsing. + An optional string used for tracing compiler operations associated with this request. + + + + Like CheckFileInProject, but uses the existing results from the background builder. + All files are read from the FileSystem API, including the file being checked. + + + The filename for the file. + The options for the project or script, used to determine active --define conditionals and other options relevant to parsing. + An optional string used for tracing compiler operations associated with this request. + + + + Create an instance of an FSharpChecker. + + + The optional size of the project checking cache. + Keep the checked contents of projects. + If false, do not keep full intermediate checking results from background checking suitable for returning from GetBackgroundCheckResultsForFileInProject. This reduces memory usage. + An optional resolver for non-file references, for legacy purposes + An optional resolver to access the contents of .NET binaries in a memory-efficient way + + + + TypeCheck and compile provided AST + + An optional string used for tracing compiler operations associated with this request. + + + + Compiles to a dynamic assembly using the given flags. + + The first argument is ignored and can just be "fsc.exe". + + Any source files names are resolved via the FileSystem API. An output file name must be given by a -o flag, but this will not + be written - instead a dynamic assembly will be created and loaded. + + If the 'execute' parameter is given the entry points for the code are executed and + the given TextWriters are used for the stdout and stderr streams respectively. In this + case, a global setting is modified during the execution. + + An optional string used for tracing compiler operations associated with this request. + + + + TypeCheck and compile provided AST + + An optional string used for tracing compiler operations associated with this request. + + + + Compile using the given flags. Source files names are resolved via the FileSystem API. + The output file must be given by a -o flag. + The first argument is ignored and can just be "fsc.exe". + + An optional string used for tracing compiler operations associated with this request. + + + + Flush all caches and garbage collect + + + + + Set the project to be checked in the background. Overrides any previous call to <c>CheckProjectInBackground</c> + + + + + Check a source code file, returning a handle to the results of the parse including + the reconstructed types in the file. + + All files except the one being checked are read from the FileSystem API + Note: returns NoAntecedent if the background builder is not yet done preparing the type check context for the + file (e.g. loading references and parsing/checking files in the project that this file depends upon). + In this case, the caller can either retry, or wait for FileTypeCheckStateIsDirty to be raised for this file. + + + + The results of ParseFile for this file. + The name of the file in the project whose source is being checked. + An integer that can be used to indicate the version of the file. This will be returned by TryGetRecentCheckResultsForFile when looking up the file. + The full source for the file. + The options for the project or script. + + An item passed back to 'hasTextChangedSinceLastTypecheck' (from some calls made on 'FSharpCheckFileResults') to help determine if + an approximate intellisense resolution is inaccurate because a range of text has changed. This + can be used to marginally increase accuracy of intellisense results in some situations. + + An optional string used for tracing compiler operations associated with this request. + + + + + Check a source code file, returning a handle to the results + + + Note: all files except the one being checked are read from the FileSystem API + + + Return FSharpCheckFileAnswer.Aborted if a parse tree was not available. + + + + The results of ParseFile for this file. + The name of the file in the project whose source is being checked. + An integer that can be used to indicate the version of the file. This will be returned by TryGetRecentCheckResultsForFile when looking up the file. + The full source for the file. + The options for the project or script. + + An item passed back to 'hasTextChangedSinceLastTypecheck' (from some calls made on 'FSharpCheckFileResults') to help determine if + an approximate intellisense resolution is inaccurate because a range of text has changed. This + can be used to marginally increase accuracy of intellisense results in some situations. + + An optional string used for tracing compiler operations associated with this request. + + + + Used to parse and check F# source code. + + + + + An optional stamp to uniquely identify this set of options + If two sets of options both have stamps, then they are considered equal + if and only if the stamps are equal + + + + + Extra information passed back on event trigger + + + + + Unused in this API and should be '[]' when used as user-specified input + + + + + Unused in this API and should be 'None' when used as user-specified input + + + + + Timestamp of project/script load, used to differentiate between different instances of a project load. + This ensures that a complete reload of the project or script type checking + context occurs on project or script unload/reload. + + + + + When true, use the reference resolution rules for scripts rather than the rules for compiler. + + + + + When true, the typechecking environment is known a priori to be incomplete, for + example when a .fs file is opened outside of a project. In this case, the number of error + messages reported is reduced. + + + + + The command line arguments for the other projects referenced by this project, indexed by the + exact text used in the "-r:" reference in FSharpProjectOptions. + + + + + Additional command line argument options for the project. These can include additional files and references. + + + + + The files in the project + + + + + This is the unique identifier for the project, it is case sensitive. If it's None, will key off of ProjectFileName in our caching. + + + + A set of information describing a project or script build configuration. + + + Unused in this API + + + + Capture information about an interface in ASTs + + + + + Matches expressions for an unresolved call to a trait + + + + + Matches object expressions, returning the base type, the base call, the overrides and the interface implementations + + + + + Matches expressions which set a field in a .NET type + + + + + Matches expressions which fetch a field from a .NET type + + + + + Matches expressions which are IL assembly code + + + + + Matches expressions which create an instance of a delegate type + + + + + Matches try/with expressions + + + + + Matches try/finally expressions + + + + + Matches while loops + + + + + Matches fast-integer loops (up or down) + + + + + Matches sequential expressions + + + + + Matches expressions which take the address of a location + + + + + Matches constant expressions, including signed and unsigned integers, strings, characters, booleans, arrays + of bytes and arrays of unit16. + + + + + Matches default-value expressions, including null expressions + + + + + Matches expressions which set the contents of a mutable variable + + + + + Matches expressions which set the contents of an address + + + + + Matches expressions which test the runtime type of a value + + + + + Matches array expressions + + + + + Matches expressions which coerce the type of a value + + + + + Matches expressions which get a value from a tuple + + + + + Matches tuple expressions + + + + + Matches expressions which test if an expression corresponds to a particular union case + + + + + Matches expressions which gets the tag for a union case + + + + + Matches expressions which set a field from a union case (only used in FSharp.Core itself) + + + + + Matches expressions which get a field from a union case + + + + + Matches expressions which create an object corresponding to a union case + + + + + Matches expressions which set a field in a record or class + + + + + Matches expressions which get a field from a record or class + + + + + Matches expressions getting a field from an anonymous record. The integer represents the + index into the sorted fields of the anonymous record. + + + + + Matches anonymous record expressions + + + + + Matches record expressions + + + + + Matches expressions which are let-rec definitions + + + + + Matches expressions which are quotation literals + + + + + Matches expressions which are uses of the 'base' value + + + + + Matches expressions which are uses of the 'this' value + + + + + Matches expressions which are calls to object constructors + + + + + Matches expressions which are calls to members or module-defined functions. When calling curried functions and members the + arguments are collapsed to a single collection of arguments, as done in the compiled version of these. + + + + + Matches expressions which are let definitions + + + + + Matches expressions which are conditionals + + + + + Matches expressions which are lambda abstractions + + + + + Special expressions at the end of a conditional decision structure in the decision expression node of a DecisionTree . + The given expressions are passed as values to the decision tree target. + + + + + Matches expressions with a decision expression, each branch of which ends in DecisionTreeSuccess pasing control and values to one of the targets. + + + + + Matches expressions which are type abstractions + + + + + Matches expressions which are the application of function values + + + + + Matches expressions which are uses of values + + + + + A collection of active patterns to analyze expressions + + + + + Patterns over FSharpSymbol and derivatives. + + + + + Keywords paired with their descriptions. Used in completion and quick info. + + + + + Remove backticks if present. + + + + + Add backticks if the identifier is a keyword. + + + + + Checks if adding backticks to identifier is needed. + + + + + Indicates the token is keyword `new` + + + + + Indicates the token is keyword `with` in #light + + + + + Indicates the token is keyword `with` + + + + + Indicates the token is keyword `try` + + + + + Indicates the token is keyword `class` + + + + + Indicates the token is keyword `struct` + + + + + Indicates the token is keyword `else` + + + + + Indicates the token is keyword `then` + + + + + Indicates the token is keyword `function` + + + + + Indicates the token is keyword `do` + + + + + Indicates the token is keyword `begin` + + + + + Indicates the token is a line comment + + + + + Indicates the token is a comment + + + + + Indicates the token is a whitespace + + + + + Indicates the token is a `"` + + + + + Indicates the token is a `<-` + + + + + Indicates the token is a `->` + + + + + Indicates the token is a `||` + + + + + Indicates the token is a `:=` + + + + + Indicates the token is a `~` + + + + + Indicates the token is a `@@` + + + + + Indicates the token is a `::` + + + + + Indicates the token is a `|` + + + + + Indicates the token is a `|` + + + + + Indicates the token is a `:?` + + + + + Indicates the token is a `:?>` + + + + + Indicates the token is a `:>` + + + + + Indicates the token is a `_` + + + + + Indicates the token is a `..` + + + + + Indicates the token is a `..` + + + + + Indicates the token is a `..` + + + + + Indicates the token is a `.` + + + + + Indicates the token is a `,` + + + + + Indicates the token is a `;` + + + + + Indicates the token is a `=` + + + + + Indicates the token is a `:` + + + + + Indicates the token is a `?` + + + + + Indicates the token is a `^` + + + + + Indicates the token is a `%` + + + + + Indicates the token is a `%` + + + + + Indicates the token is a `*` + + + + + Indicates the token is a `-` + + + + + Indicates the token is a `+` or `-` + + + + + Indicates the token is a `|]` + + + + + Indicates the token is a `[|` + + + + + Indicates the token is a `>` + + + + + Indicates the token is a `<` + + + + + Indicates the token is a `>]` + + + + + Indicates the token is a `[<` + + + + + Indicates the token is a `}` + + + + + Indicates the token is a `{` + + + + + Indicates the token is a `]` + + + + + Indicates the token is a `[` + + + + + Indicates the token is a `)` + + + + + Indicates the token is a `(` + + + + + Indicates the token is an string (synonym for FSharpTokenTag.String) + + + + + Indicates the token is an identifier (synonym for FSharpTokenTag.Identifier) + + + + + Indicates the token is a string + + + + + Indicates the token is an identifier + + + + + Some of the values in the field FSharpTokenInfo.Tag + + + + + VisitTypeAbbrev(ty,m), defaults to ignoring this leaf of the AST + + + + + VisitType allows overriding behavior when visiting type hints (x: ..., etc.) + + + + + VisitType allows overriding behavior when visiting simple pats + + + + + VisitRecordField allows overriding behavior when visiting l.h.s. of constructed record instances + + + + + VisitPat allows overriding behavior when visiting patterns + + + + + VisitModuleOrNamespace allows overriding behavior when visiting module or namespaces + + + + + VisitModuleDecl allows overriding module declaration behavior + + + + + VisitMatchClause allows overriding clause behavior (note: by default it would defaultTraverse expression) + + + + + VisitLetOrUse allows overriding behavior when visiting module or local let or use bindings + + + + + VisitInterfaceSynMemberDefnType allows overriding behavior for visiting interface member in types (by default - do nothing) + + + + + VisitInheritSynMemberDefn allows overriding inherit behavior (by default do nothing) + + + + + VisitImplicitInherit(defaultTraverse,ty,expr,m), defaults to just visiting expr + + + + + VisitHashDirective allows overriding behavior when visiting hash directives in FSX scripts, like #r, #load and #I. + + + + + VisitExpr(path, traverseSynExpr, defaultTraverse, expr) + controls the behavior when a SynExpr is reached; it can just do + defaultTraverse(expr) if you have no special logic for this node, and want the default processing to pick which sub-node to dive deeper into + or can inject non-default behavior, which might incorporate: + traverseSynExpr(subExpr) to recurse deeper on some particular sub-expression based on your own logic + path helps to track AST nodes that were passed during traversal + + + + + VisitComponentInfo allows overriding behavior when visiting type component infos + + + + + VisitBinding allows overriding binding behavior (note: by default it would defaultTraverse expression) + + + + + used to track route during traversal AST + + + + + traverse an implementation file walking all the way down to SynExpr or TypeAbbrev at a particular location + + + + + + A range of utility functions to assist with traversing an AST + + + + + Whether or not this file should be a single-file project + + + + + Whether or not this file is compilable + + + + + Information about F# source file names + + + + + Safe version of `Entities`. + + + + + Full operator compiled name. + + + + + Full name with last part replaced with display name. + + + + + Safe version of `FullType`. + + + + + Safe version of `GetMembersFunctionsAndValues`. + + + + + Public nested entities (methods, functions, values, nested modules). + + + + + Safe version of `CompiledName`. + + + + + Safe version of `DisplayName`. + + + + + Safe version of `FullName`. + + + + + Corrects insertion line number based on kind of scope and text surrounding the insertion point. + + + + + Returns lond identifier at position. + + + + + Returns `InsertContext` based on current position and symbol idents. + + + + + Returns `InsertContext` based on current position and symbol idents. + + + + + Parse AST helpers. + + + + + Returns (possibly cached) assembly content. + + + + + Given a `FSharpAssemblySignature`, returns assembly content. + + + + + Provides assembly content. + + + + + Get the list of Xml documentation from current source code + + + + + if it's a blank XML comment with trailing "<", returns Some (index of the "<"), otherwise returns None + + + + + A set of helpers for dealing with F# files. + + + + + All the keywords in the F# language + + + + + A utility to help determine if an identifier needs to be quoted + + + + + A set of helpers related to naming of identifiers + + + + + Return the language ID, which is the expression evaluator id that the + debugger will use. + + + + + Information about the debugging environment + + + + + Return true if this is a subcategory of error or warning message that the language service can emit + + + + + Return the compilation defines that should be used when editing the given file. + + + + + These are the names of assemblies that should be referenced for .fs or .fsi files that + are not associated with a project. + + + + + Information about the compilation environment + + + + + Find corresponding interface declaration at a given position + + + + + Generate stub implementation of an interface at a start column + + + + + Check whether an entity is an interface or type abbreviation of an interface + + + + + Get associated member names and ranges + In case of properties, intrinsic ranges might not be correct for the purpose of getting + positions of 'member', which indicate the indentation for generating new members + + + + + Check whether an interface is empty + + + + + Get members in the decreasing order of inheritance chain + + + + + TextSpan in BlockSpan + + + + + HintSpan in BlockSpan + + + + + Stores the range for a construct, the sub-range that should be collapsed for outlinging, + a tag for the construct type, and a tag for the collapse style + + + + + Tag to identify the constuct that can be stored alongside its associated ranges + + + + + Collapse indicates the way a range/snapshot should be collapsed. `Same` is for a scope inside + some kind of scope delimiter, e.g. `[| ... |]`, `[ ... ]`, `{ ... }`, etc. `Below` is for expressions + following a binding or the right hand side of a pattern, e.g. `let x = ...` + + + + + Returns outlining ranges for given parsed input. + + + + + Get all unused open declarations in a file + + + + + Defines a write-only stream used to capture output of the hosted F# Interactive dynamic compiler. + + + + + Feeds content into the stream. + + + + + Defines a read-only input stream used to feed content to the hosted F# Interactive dynamic compiler. + + + + + Raised when an interaction is successfully typechecked and executed, resulting in an update to the + type checking state. + + This event is triggered after parsing and checking, either via input from 'stdin', or via a call to EvalInteraction. + + + + + A host calls this to get the active language ID if provided by fsi-server-lcid + + + + + A host calls this to determine if the --gui parameter is active + + + + + The single, global interactive checker to use in conjunction with other operations + on the FsiEvaluationSession. + + If you are using an FsiEvaluationSession in this process, you should only use this InteractiveChecker + for additional checking operations. + + + + + Get a handle to the dynamicly generated assembly + + + + + Get a handle to the resolved view of the current signature of the incrementally generated assembly. + + + + + Load the dummy interaction, load the initial files, and, + if interacting, start the background thread to read the standard input. + + Performs these steps: + - Load the dummy interaction, if any + - Set up exception handling, if any + - Load the initial files, if any + - Start the background thread to read the standard input, if any + - Sit in the GUI event loop indefinitely, if needed + + + + + A host calls this to report an unhandled exception in a standard way, e.g. an exception on the GUI thread gets printed to stderr + + + + + Typecheck the given script fragment in the type checking context implied by the current state + of F# Interactive. The results can be used to access intellisense, perform resolutions, + check brace matching and other information. + + Operations may be run concurrently with other requests to the InteractiveChecker. + + Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered + by input from 'stdin'. + + + + + A host calls this to request an interrupt on the evaluation thread. + + + + + Get a configuration that uses a private inbuilt implementation of the 'fsi' object and does not + implicitly reference FSharp.Compiler.Interactive.Settings.dll. + + + + + Get a configuration that uses the 'fsi' object (normally from FSharp.Compiler.Interactive.Settings.dll, + an object from another DLL with identical characteristics) to provide an implementation of the configuration. + FSharp.Compiler.Interactive.Settings.dll is referenced by default. + + + + + Get a configuration that uses the 'fsi' object (normally from FSharp.Compiler.Interactive.Settings.dll, + an object from another DLL with identical characteristics) to provide an implementation of the configuration. + The flag indicates if FSharp.Compiler.Interactive.Settings.dll is referenced by default. + + + + + A host calls this to get the completions for a long identifier, e.g. in the console + + Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered + by input from 'stdin'. + + + + + Format a value to a string using the current PrintDepth, PrintLength etc settings provided by the active fsi configuration object + + + + + Execute the given script. Stop on first error, discarding the rest + of the script. Errors and warnings are collected apart from any exception arising from execution + which is returned via a Choice. Execution is performed on the 'Run()' thread. + + Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered + by input from 'stdin'. + + + + + Execute the given script. Stop on first error, discarding the rest + of the script. Errors are sent to the output writer, a 'true' return value indicates there + were no errors overall. Execution is performed on the 'Run()' thread. + + Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered + by input from 'stdin'. + + + + + Execute the code as if it had been entered as one or more interactions, with an + implicit termination at the end of the input. Stop on first error, discarding the rest + of the input. Errors and warnings are collected apart from any exception arising from execution + which is returned via a Choice. Execution is performed on the 'Run()' thread. + + Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered + by input from 'stdin'. + + + + + Execute the code as if it had been entered as one or more interactions, with an + implicit termination at the end of the input. Stop on first error, discarding the rest + of the input. Errors are sent to the output writer, a 'true' return value indicates there + were no errors overall. Execution is performed on the 'Run()' thread. + + Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered + by input from 'stdin'. + + + + + Execute the code as if it had been entered as one or more interactions, with an + implicit termination at the end of the input. Stop on first error, discarding the rest + of the input. Errors and warnings are collected apart from any exception arising from execution + which is returned via a Choice. Parsing is performed on the current thread, and execution is performed + sycnhronously on the 'main' thread. + + Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered + by input from 'stdin'. + + + + + Execute the code as if it had been entered as one or more interactions, with an + implicit termination at the end of the input. Stop on first error, discarding the rest + of the input. Errors are sent to the output writer. Parsing is performed on the current thread, and execution is performed + sycnhronously on the 'main' thread. + + Due to a current limitation, it is not fully thread-safe to run this operation concurrently with evaluation triggered + by input from 'stdin'. + + + + + Create an FsiEvaluationSession, reading from the given text input, writing to the given text output and error writers. + + <summary>Create an FsiEvaluationSession, reading from the given text input, writing to the given text output and error writers</summary> + + <param name="fsiConfig">The dynamic configuration of the evaluation session</param> + <param name="argv">The commmand line arguments for the evaluation session</param> + <param name="inReader">Read input from the given reader</param> + <param name="outWriter">Write output to the given writer</param> + <param name="collectible">Optionally make the dynamic assmbly for the session collectible</param> + + + + + Represents an F# Interactive evaluation session. + + + + + Implicitly reference FSharp.Compiler.Interactive.Settings.dll + + + + + Called by the evaluation session to ask the host for parameters to format text for output + + + + + Called by the evaluation session to ask the host for parameters to format text for output + + + + + Called by the evaluation session to ask the host for parameters to format text for output + + + + + Called by the evaluation session to ask the host for parameters to format text for output + + + + + Called by the evaluation session to ask the host for parameters to format text for output + + + + + Called by the evaluation session to ask the host for parameters to format text for output + + + + + Called by the evaluation session to ask the host for parameters to format text for output + + + + + Hook for listening for evaluation bindings + + + + + Called by the evaluation session to ask the host for parameters to format text for output + + + + + Called by the evaluation session to ask the host for parameters to format text for output + + + + + Called by the evaluation session to ask the host for parameters to format text for output + + + + + The evaluation session calls this at an appropriate point in the startup phase if the --fsi-server parameter was given + + + + + The evaluation session calls this to report the preferred view of the command line arguments after + stripping things like "/use:file.fsx", "-r:Foo.dll" etc. + + + + + Indicate a special console "readline" reader for the evaluation session, if any.  + + A "console" gets used if --readline is specified (the default on Windows + .NET); and --fsi-server is not + given (always combine with --readline-), and OptionalConsoleReadLine is given. + When a console is used, special rules apply to "peekahead", which allows early typing on the console. + Peekahead happens if --peekahead- is not specified (the default). + In this case, a prompt is printed early, a background thread is created and + the OptionalConsoleReadLine is used to read the first line. + If a console is not used, then inReader.Peek() is called early instead. +   + + Further lines are read using OptionalConsoleReadLine(). + If not provided, lines are read using inReader.ReadLine(). +   + + + + + Schedule a restart for the event loop. + + + + + Called by the evaluation session to ask the host to enter a dispatch loop like Application.Run(). + Only called if --gui option is used (which is the default). + Gets called towards the end of startup and every time a ThreadAbort escaped to the backup driver loop. + Return true if a 'restart' is required, which is a bit meaningless. + + + + + Request that the given operation be run synchronously on the event loop. + + + + + The FSharpSymbolUse for the symbol defined + + + + + The symbol defined + + + + + The display name of the symbol defined + + + + + The details of the expression defined + + + + + The value of the symbol defined, if any + + + + + The value, as an object + + + + + The type of the value, from the point of view of the .NET type system + + + + + Represents an evaluated F# value + + + + When set to 'false', disables the display of properties of evaluated objects in the output of the interactive session. + + + When set to 'false', disables the display of sequences in the output of the interactive session. + + + When set to 'false', disables the display of declaration values in the output of the interactive session. + + + Get or set the print width of the interactive session. + + + Get or set the total print size of the interactive session. + + + Get or set the total print length of the interactive session. + + + Get or set the print depth of the interactive session. + + + Get or set the format provider used in the output of the interactive session. + + + Get or set the floating point format used in the output of the interactive session. + + + Gets or sets a the current event loop being used to process interactions. + + + The command line arguments after ignoring the arguments relevant to the interactive + environment and replacing the first argument with the name of the last script file, + if any. Thus 'fsi.exe test1.fs test2.fs -- hello goodbye' will give arguments + 'test2.fs', 'hello', 'goodbye'. This value will normally be different to those + returned by System.Environment.GetCommandLineArgs. + + + When set to 'false', disables the display of properties of evaluated objects in the output of the interactive session. + + + When set to 'false', disables the display of sequences in the output of the interactive session. + + + When set to 'false', disables the display of declaration values in the output of the interactive session. + + + Get or set the print width of the interactive session. + + + Get or set the total print size of the interactive session. + + + Get or set the total print length of the interactive session. + + + Get or set the print depth of the interactive session. + + + Get or set the format provider used in the output of the interactive session. + + + Get or set the floating point format used in the output of the interactive session. + + + Gets or sets a the current event loop being used to process interactions. + + + The command line arguments after ignoring the arguments relevant to the interactive + environment and replacing the first argument with the name of the last script file, + if any. Thus 'fsi.exe test1.fs test2.fs -- hello goodbye' will give arguments + 'test2.fs', 'hello', 'goodbye'. This value will normally be different to those + returned by System.Environment.GetCommandLineArgs. + + + Register a printer that controls the output of the interactive session. + + + Register a print transformer that controls the output of the interactive session. + + + Operations supported by the currently executing F# Interactive session. + + + Schedule a restart for the event loop. + + + Run the event loop. + True if the event loop was restarted; false otherwise. + + + Request that the given operation be run synchronously on the event loop. + The result of the operation. + + + An event loop used by the currently executing F# Interactive session to execute code + in the context of a GUI or another event-based system. + + + + A default implementation of the 'fsi' object, used by GetDefaultConfiguration(). Note this + is a different object to FSharp.Compiler.Interactive.Settings.fsi in FSharp.Compiler.Interactive.Settings.dll, + which can be used as an alternative implementation of the interactiev settings if passed as a parameter + to GetDefaultConfiguration(fsiObj). + + + + + A default implementation of the 'fsi' object, used by GetDefaultConfiguration() + + + + diff --git a/packages/FAKE.5.16.0/tools/FSharp.Control.Reactive.dll b/packages/FAKE.5.16.0/tools/FSharp.Control.Reactive.dll new file mode 100644 index 0000000..6bbd727 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FSharp.Control.Reactive.dll differ diff --git a/packages/FAKE.5.16.0/tools/FSharp.Control.Reactive.xml b/packages/FAKE.5.16.0/tools/FSharp.Control.Reactive.xml new file mode 100644 index 0000000..eabfed5 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/FSharp.Control.Reactive.xml @@ -0,0 +1,2616 @@ + + +FSharp.Control.Reactive + + + + Initializes a new instance of the ManualResetEvent class with initial state set to 'false'. + + + + + Represents a disposable resource whose underlying disposable resource can be replaced by another disposable resource, + causing automatic disposal of the previous underlying disposable resource. + + + + + Creates a new composite disposable with no disposables contained initially. + + + + + Represents an object that is both an observable sequence as well as an observer. + Each notification is broadcasted to all subscribed and future observers, subject to buffer trimming policies. + + + + + Represents and object that is both an observable sequence as well as an observer. + Each notification is broadcasted to all subscribed observers. + + + + + Represents the result of an asynchronous operation. + The last value before the OnCompleted notification, or the error received through OnError, is sent to all subscribed observers. + + + + + Represents a value that changes over time. + Observers can subscribe to the subject to receive the last (or initial) value and all subsequent notifications. + + + + + Blocks the current thread until the WaitHandle receives a signal. + + + + + Sets the state of the event to signaled, allowing one or more waiting threads to proceed. + + + + + Uses the double-indirection pattern to assign the disposable returned by the specified disposableFactory + to the 'Disposable' property of the specified serial disposable. + + + + + Compose two disposables together so they are both disposed when disposed is called on the 'composite' disposable. + + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + Execute and action with the resource while the disposable is still 'active'. + The used resource will be disposed afterwards. + + + + + Execute and action without the resource while the disposable is still 'active'. + The used resource will be disposed afterwards. + + + + + Creates an disposable object that invokes the specified function when disposed. + + + + + Operators to work on disposable types + + + + + Returns an IDisposable that disposes all the underlying disposables + + + + + Schedules the work using an asynchonous function, allowing for cooperative scheduling in a imperative coding style. + + + + + Schedules the work using an asynchonous function, allowing for cooperative scheduling in a imperative coding style. + + + + + Schedules the work using an asynchonous function, allowing for cooperative scheduling in a imperative coding style. + + + + + Schedules the work using an asynchonous function, allowing for cooperative scheduling in a imperative coding style. + + + + + Schedules the work using an asynchonous function, allowing for cooperative scheduling in a imperative coding style. + + + + + Schedules the work using an asynchonous function, allowing for cooperative scheduling in a imperative coding style. + + + + + Schedules the work using an asynchonous function, allowing for cooperative scheduling in a imperative coding style. + + + + + Schedules the work using an asynchonous function, allowing for cooperative scheduling in a imperative coding style. + + + + + Schedules the work using an asynchonous function, allowing for cooperative scheduling in a imperative coding style. + + + + + Schedules the work using an asynchonous function, allowing for cooperative scheduling in a imperative coding style. + + + + + Schedules the work using an asynchonous function, allowing for cooperative scheduling in a imperative coding style. + + + + + Schedules the work using an asynchonous function, allowing for cooperative scheduling in a imperative coding style. + + + + + Suspends execution of the current work item on the scheduler for the specified duration. + The caller should await the result of calling 'sleep' to schedule the remainder of the current work item (known as the continuation) after the specified due time. + + + + + Suspends execution of the current work item on the scheduler for the specified duration. + The caller should await the result of calling 'sleep' to schedule the remainder of the current work item (known as the continuation) after the specified due time. + + + + + Suspends execution of the current work item on the scheduler for the specified duration. + The caller should await the result of calling 'sleep' to schedule the remainder of the current work item (known as the continuation) after the specified duration. + + + + + Suspends execution of the current work item on the scheduler for the specified duration. + The caller should await the result of calling 'sleep' to schedule the remainder of the current work item (known as the continuation) after the specified duration. + + + + + Yields execution of the current work item on the scheduler to another work item on the scheduler. + The caller should await the result of calling 'yield' to schedule the remainder of the current work item (known as the continuation). + + + + + Yields execution of the current work item on the scheduler to another work item on the scheduler. + The caller should await the result of calling 'yield' to schedule the remainder of the current work item (known as the continuation). + + + + + Returns a scheduler that wraps the original scheduler, adding exception handling for scheduled actions. + + + + + Returns a scheduler that represents the original scheduler, without any of its interface-based optimizations (e.g. long running scheduling). + + + + + Returns a scheduler that represents the original scheduler, without any of its interface-based optimizations (e.g. long running scheduling). + + + + + Schedules a periodic piece of work by dynamically discovering the scheduler's capabilities. + If the scheduler supports periodic scheduling, the request will be forwarded to the periodic scheduling implementation. + If the scheduler provides stopwatch functionality, the periodic task will be emulated using recursive scheduling with a stopwatch to correct for time slippage. + Otherwise, the periodic task will be emulated using recursive scheduling. + + + + + Schedules a periodic piece of work by dynamically discovering the scheduler's capabilities. + If the scheduler supports periodic scheduling, the request will be forwarded to the periodic scheduling implementation. + If the scheduler provides stopwatch functionality, the periodic task will be emulated using recursive scheduling with a stopwatch to correct for time slippage. + Otherwise, the periodic task will be emulated using recursive scheduling. + + + + + Schedules a periodic piece of work by dynamically discovering the scheduler's capabilities. + If the scheduler supports periodic scheduling, the request will be forwarded to the periodic scheduling implementation. + If the scheduler provides stopwatch functionality, the periodic task will be emulated using recursive scheduling with a stopwatch to correct for time slippage. + Otherwise, the periodic task will be emulated using recursive scheduling. + + + + + Schedules an function to be executed recursively at a specified absolute due time. + + + + + Schedules an function to be executed recursively at a specified absolute due time. + + + + + Schedules an function to be executed recursively after a specified relative due time. + + + + + Schedules an function to be executed recursively. + + + + + Schedules an function to be executed recursively. + + + + + Schedules an function to be executed recursively. + + + + + Schedules a function to be executed at dueTime. + + + + + Schedules a function to be executed after dueTime. + + + + + Schedules a function to be executed. + + + + + Schedules a long-running piece of work. + + + + + Schedules an function to be executed. + + + + + Schedules an function to be executed at a specified absolute time. + + + + + Schedules an function to be executed. + + + + + Schedule multiple 'schedule' operations together + + + + + The Reactive module provides operators for working with IScheduler<_> in F#. + + + + + Creates a historical scheduler with a minimum value of DateTimeOffset as initial clock. + + + + + Creates an object that schedules units of work on a designated thread. + + + + + Returns the 'ISchedulerLongRunning' implementation of the specified scheduler, or 'None' if no such implementation is available. + + + + + Notifies all subscribed observers about the end of the sequence. + + + + + Notifies all subscribed observers about the specified exception. + + + + + Notifies all subscribed observers about the arrival of the specified elements in the sequence. + + + + + Notifies all subscribed observers about the arrival of the specified element in the sequence. + + + + + The Reactive module provides operators working with Subjects in F#. + + + + + Generates a sequence using the producer/consumer pattern. + The purpose of the source sequence is simply to notify the consumer when out-of-band data becomes available. + The data in the source sequence provides additional information to the function, + but it does not have to be the actual data being produced. + + The function is not necessarily called for every value in the source sequence. + It is only called if the previous consumer's observable has completed; otherwise, the current notification is ignored. This ensures + that only one consumer is active at any given time, but it also means that the function is not guaranteed + to receive every value in the source sequence; therefore, the function must read + data from out-of-band storage instead; e.g., from a shared stream or queue. + + The function may also be called when data is not available. For example, if the current consuming + observable completes and additional notifications from the source were received, then the function + is called again to check whether new data was missed. This avoids a race condition between the source sequence + and the consuming observable's completion notification. If no data is available when function is called, then + an empty sequence should be returned and the function will not be called again until another notification is observed + from the source. + + Producers and the single active consumer are intended to access shared objects concurrently, yet it remains their responsibility + to ensure thread-safety. The consume operator cannot do so without breaking concurrency. For example, + a producer/consumer implementation that uses an in-memory queue must manually ensure that reads and writes to the queue are thread-safe. + + Multiple producers are supported. Simply create an observable sequence for each producer that notifies when data is generated, + merge them together using the merge operator, and use the merged observable as the source argument in the consume operator. + Multiple consumers are supported by calling consume once and then calling subscribe multiple times on the cold observable that is returned. + Just be sure that the source sequence is hot so that each subscription will consume based on the same producers' notifications. + + ## Parameters + - `f` - A function that is called iteratively to generate values from out-of-band data. + - `source` - Indicates when data becomes available from one or more producers. + + ## Returns + An observable sequence that is the concatenation of the values returned by the consumeNext function. + + + + + Generates a sequence using the producer/consumer pattern. + The purpose of the source sequence is simply to notify the consumer when out-of-band data becomes available. + The data in the source sequence provides additional information to the function, + but it does not have to be the actual data being produced. + + The function is not necessarily called for every value in the source sequence. + It is only called if the previous consumer's observable has completed; otherwise, the current notification is ignored. This ensures + that only one consumer is active at any given time, but it also means that the function is not guaranteed + to receive every value in the source sequence; therefore, the function must read + data from out-of-band storage instead; e.g., from a shared stream or queue. + + The function may also be called when data is not available. For example, if the current consuming + observable completes and additional notifications from the source were received, then the function + is called again to check whether new data was missed. This avoids a race condition between the source sequence + and the consuming observable's completion notification. If no data is available when function is called, then + an empty sequence should be returned and the function will not be called again until another notification is observed + from the source. + + Producers and the single active consumer are intended to access shared objects concurrently, yet it remains their responsibility + to ensure thread-safety. The consume operator cannot do so without breaking concurrency. For example, + a producer/consumer implementation that uses an in-memory queue must manually ensure that reads and writes to the queue are thread-safe. + + Multiple producers are supported. Simply create an observable sequence for each producer that notifies when data is generated, + merge them together using the merge operator, and use the merged observable as the source argument in the consume operator. + Multiple consumers are supported by calling consume once and then calling subscribe multiple times on the cold observable that is returned. + Just be sure that the source sequence is hot so that each subscription will consume based on the same producers' notifications. + + ## Parameters + - `f` - A function that is called iteratively to generate values from out-of-band data. + - `source` - Indicates when data becomes available from one or more producers. + + ## Returns + An observable sequence that is the concatenation of the values returned by the consumeNext function. + + + + + Generates a sequence using the producer/consumer pattern. + The purpose of the source sequence is simply to notify the consumer when out-of-band data becomes available. + The data in the source sequence provides additional information to the function, + but it does not have to be the actual data being produced. + + The function is not necessarily called for every value in the source sequence. + It is only called if the previous consumer's observable has completed; otherwise, the current notification is ignored. This ensures + that only one consumer is active at any given time, but it also means that the function is not guaranteed + to receive every value in the source sequence; therefore, the function must read + data from out-of-band storage instead; e.g., from a shared stream or queue. + + The function may also be called when data is not available. For example, if the current consuming + observable completes and additional notifications from the source were received, then the function + is called again to check whether new data was missed. This avoids a race condition between the source sequence + and the consuming observable's completion notification. If no data is available when function is called, then + an empty sequence should be returned and the function will not be called again until another notification is observed + from the source. + + Producers and the single active consumer are intended to access shared objects concurrently, yet it remains their responsibility + to ensure thread-safety. The consume operator cannot do so without breaking concurrency. For example, + a producer/consumer implementation that uses an in-memory queue must manually ensure that reads and writes to the queue are thread-safe. + + Multiple producers are supported. Simply create an observable sequence for each producer that notifies when data is generated, + merge them together using the merge operator, and use the merged observable as the source argument in the consume operator. + Multiple consumers are supported by calling consume once and then calling subscribe multiple times on the cold observable that is returned. + Just be sure that the source sequence is hot so that each subscription will consume based on the same producers' notifications. + + ## Parameters + - `f` - A function that generates an observable sequence from out-of-band data. + - `source` - Indicates when data becomes available from one or more producers. + + ## Returns + An observable sequence that is the concatenation of all subscriptions to the consumer observable. + + + + + Generates a sequence using the producer/consumer pattern. + The purpose of the source sequence is simply to notify the consumer when out-of-band data becomes available. + The data in the source sequence provides additional information to the function, + but it does not have to be the actual data being produced. + + The function is not necessarily called for every value in the source sequence. + It is only called if the previous consumer's observable has completed; otherwise, the current notification is ignored. This ensures + that only one consumer is active at any given time, but it also means that the function is not guaranteed + to receive every value in the source sequence; therefore, the function must read + data from out-of-band storage instead; e.g., from a shared stream or queue. + + The function may also be called when data is not available. For example, if the current consuming + observable completes and additional notifications from the source were received, then the function + is called again to check whether new data was missed. This avoids a race condition between the source sequence + and the consuming observable's completion notification. If no data is available when function is called, then + an empty sequence should be returned and the function will not be called again until another notification is observed + from the source. + + Producers and the single active consumer are intended to access shared objects concurrently, yet it remains their responsibility + to ensure thread-safety. The consume operator cannot do so without breaking concurrency. For example, + a producer/consumer implementation that uses an in-memory queue must manually ensure that reads and writes to the queue are thread-safe. + + Multiple producers are supported. Simply create an observable sequence for each producer that notifies when data is generated, + merge them together using the merge operator, and use the merged observable as the source argument in the consume operator. + Multiple consumers are supported by calling consume once and then calling subscribe multiple times on the cold observable that is returned. + Just be sure that the source sequence is hot so that each subscription will consume based on the same producers' notifications. + + ## Parameters + - `f` - A function that generates an observable sequence from out-of-band data. + - `source` - Indicates when data becomes available from one or more producers. + + ## Returns + An observable sequence that is the concatenation of all subscriptions to the consumer observable. + + + + + **Description** + Concurrently invokes the specified factory to create observables as fast and often as possible and subscribes to all of them + up to the default maximum concurrency. + + **Parameters** + - `max` - The maximum number of observables to be subscribed simultaneously. + - `sourceFactory` - Function that returns the observable to invoke concurrently. + + + + + **Description** + Concurrently invokes the specified factory to create observables as fast and often as possible and subscribes to all of them + up to the default maximum concurrency. + + **Parameters** + - `sch` - The scheduler on which the invocation should happen. + - `gate` - Common gate on which the synchronization should happen. + - `max` - The maximum number of observables to be subscribed simultaneously. + - `sourceFactory` - Function that returns the observable to invoke concurrently. + + + + + **Description** + Concurrently invokes the specified factory to create observables as fast and often as possible and subscribes to all of them + up to the default maximum concurrency. + + **Parameters** + - `sch` - The scheduler on which the invocation should happen. + - `max` - The maximum number of observables to be subscribed simultaneously. + - `callOnError` - Function to determine whether or not the given exception should call the `OnError`. + - `sourceFactory` - Function that returns the observable to invoke concurrently. + + + + + **Description** + Concurrently invokes the specified factory to create observables as fast and often as possible and subscribes to all of them + up to the default maximum concurrency. + + **Parameters** + - `sch` - The scheduler on which the invocation should happen. + - `gate` - Common gate on which the synchronization should happen. + - `max` - The maximum number of observables to be subscribed simultaneously. + - `callOnError` - Function to determine whether or not the given exception should call the `OnError`. + - `sourceFactory` - Function that returns the observable to invoke concurrently. + + + + + **Returns** + Returns an Observable that emits items based on applying a function that you + supply to each item emitted by the source Observable, where that function + returns an (so-called "inner") Observable. When it projects a source value to + an Observable, the output Observable begins emitting the items emitted by + that projected Observable. However, `exhaustMap` ignores every new projected + Observable if the previous projected Observable has not yet completed. Once + that one completes, it will accept and flatten the next projected Observable + and repeat this process. + + + + + **Description** + Projects each source value to an Observable which is merged in the output + Observable, emitting values only from the most recently projected Observable. + + **Returns** + Returns an Observable that emits items based on applying a function that you + supply to each item emitted by the source Observable, where that function + returns an (so-called "inner") Observable. Each time it observes one of these + inner Observables, the output Observable begins emitting the items emitted by + that inner Observable. When a new inner Observable is emitted, `switchMap` + stops emitting items from the earlier-emitted inner Observable and begins + emitting items from the new one. It continues to behave like this for + subsequent inner Observables. + + + + + **Description** + Applies the given function to each value of the given source Observable + comprimised of the results x for each element for which the function returns `Some(x)`. + + **Parameters** + - `f` - Accepts a chooser function to only pick a subset of emits. + - `source` - The source observable to take a subset from. + + + + + **Description** + Periodically repeats the observable sequence exposing a responses or failures. + Using the `Scheduler.Default` on which the polling period should run. + + **Parameters** + - `period` - Accepts the period in which the polling should happen. + - `source` - The source observable on which the polling happen. + + + + + **Description** + Periodically repeats the observable sequence exposing a responses or failures. + + **Parameters** + - `sch` - Accepts the scheduler on which the polling period should be run. + - `period` - Accepts the period in which the polling should happen. + - `source` - The source observable on which the polling happen. + + + + + Merges an observable sequence and an enumerable sequence into one + observable sequence by using the selector function. + + + + + Merges the specified observable sequences into one observable sequence by using + the selector function whenever all of the observable sequences have produced an + element at a corresponding index. + + + + + Merges the specified observable sequences into one observable sequence by emitting + a list with the elements of the observable sequences at corresponding indexe + + + + + Merges the specified observable sequences into one observable sequence by emitting a + list with the elements of the observable sequences at corresponding indexes. + + + + + Merges two observable sequences into one observable sequence by combining their elements through a projection function. + + + + + Merges three observable sequences into one observable sequence of triples. + + + + + Merges two observable sequences into one observable sequence of pairs. + + + + + Merges the specified observable sequences into one observable sequence by using the selector function + only when the first observable sequence produces an element and there was some element produced by the second + observable sequence + + + + + Projects each element of an observable sequence into a window that is completed when either it's full or + a given amount of time has elapsed, using the specified scheduler to run timers. + A useful real-world analogy of this overload is the behavior of a ferry leaving the dock when all seats are + taken, or at the scheduled time of departure, whichever event occurs first + + + + + Projects each element of an observable sequence into a window that is completed when either it's full or + a given amount of time has elapsed. + A useful real-world analogy of this overload is the behavior of a ferry leaving the dock when all seats are + taken, or at the scheduled time of departure, whichever event occurs first + + + + + Projects each element of an observable sequence into consecutive non-overlapping windows + which are produced based on element count information. + + + + + Projects each element of an observable sequence into zero or more windows which are produced based on element count information + + + + + Projects each element of an observable sequence into consecutive non-overlapping windows + windowBoundaries - Sequence of window boundary markers. The current window is closed + and a new window is opened upon receiving a boundary marker + + + + + Projects each element of an observable sequence into consecutive non-overlapping windows, using the specified scheduler to run timers. + windowBoundaries - Sequence of window boundary markers. The current window is closed and a new window is opened upon receiving a boundary marker. + + + + + Projects each element of an observable sequence into consecutive non-overlapping windows. + windowBoundaries - Sequence of window boundary markers. The current window is closed and a new window is opened upon receiving a boundary marker. + + + + + Projects each element of an observable sequence into zero or more windows. + windowOpenings - Observable sequence whose elements denote the creation of new windows. + windowClosingSelector - A function invoked to define the closing of each produced window. + + + + + Projects each element of an observable sequence into consecutive non-overlapping windows + which are produced based on timing information, using the specified scheduler to run timers. + + + + + Projects each element of an observable sequence into consecutive non-overlapping windows + which are produced based on timing information. + + + + + Projects each element of an observable sequence into consecutive non-overlapping windows. + windowClosingSelector - A function invoked to define the boundaries of the produced windows. + A new window is started when the previous one is closed + + + + + Repeats the given function as long as the specified condition holds + where the condition is evaluated before each repeated source is + subscribed to + + + + + waits for the observable sequence to complete and returns the last + element of the sequence. If the sequence terminates with OnError + notification, the exception is thrown + + + + + Constructs an observable sequence that depends on a resource object, whose + lifetime is tied to the resulting observable sequence's lifetime. + The resource is obtained and used through asynchronous functions. + The cancellation token passed to the asyncrhonous functions is tied to the returned disposable subscription, + allowing best-effor cancellation at any stage of the resource acquisition or usage. + + + + + Constructs an observable sequence that depends on a resource object, whose + lifetime is tied to the resulting observable sequence's lifetime. + + + + + Converts a seq into an observable + + + + + Creates a lookup from an observable sequence according to a specified key selector function, and an element selector function. + + + + + Creates a lookup from an observable sequence according to a specified key selector function, and an element selector function. + + + + + Creates a lookup from an observable sequence according to a specified key selector function, and a comparer. + + + + + Creates a lookup from an observable sequence according to a specified key selector function. + + + + + Creates a list from an observable sequence + + + + + Exposes an observable sequence as an object with an Action<'Source> based .NET event. + + + + + Exposes an observable sequence as an object with an Action based .NET event + + + + + Creates an observable sequence according to a specified key selector function + + + + + Creates an observable sequence according to a specified key selector function + + + + + Creates an observable sequence according to a specified key selector function + and an a comparer + + + + + Creates an observable sequence according to a specified key selector function + + + + + Creates an array from an observable sequence. + + + + + Converts an observable into a seq + + + + + Timestamps each element in an observable sequence using the supplied scheduler. + + + + + Timestamps each element in an observable sequence using the local system clock. + + + + + Returns an observable sequence that periodically produces a value after the specified + initial relative due time has elapsed, using the specified scheduler to run the timer. + + + + + Returns an observable sequence that periodically produces a value after the specified + initial relative due time has elapsed. + + + + + Returns an observable sequence that produces a single value after the specified relative due time has elapsed, + using the specified scheduler to run the timer. + + + + + Returns an observable sequence that produces a single value after the specified relative due time has elapsed. + + + + + Returns an observable sequence that periodically produces a value starting at the specified initial absolute due time. + + + + + Returns an observable sequence that produces a single value at the specified absolute due time, + using the specified scheduler to run the timer. + + + + + Returns an observable sequence that produces a single value at the specified absolute due time. + + + + + Applies a timeout policy to the observable sequence based on an initial timeout duration for the first + element, and a timeout duration computed for each subsequent element. + If the next element isn't received within the computed duration starting from its predecessor, + the other observable sequence is used to produce future messages from that point on. + + + + + Applies a timeout policy to the observable sequence based on an initial timeout duration + for the first element, and a timeout duration computed for each subsequent element. + If the next element isn't received within the computed duration starting from its predecessor, + a TimeoutException is propagated to the observer. + + + + + Applies a timeout policy to the observable sequence based on a timeout duration computed for each element. + If the next element isn't received within the computed duration starting from its predecessor, + a TimeoutException is propagated to the observer. + + + + + Applies a timeout policy for each element in the observable sequence, using the specified scheduler to run timeout timers. + If the next element isn't received within the specified timeout duration starting from + its predecessor, the other observable sequence is used to produce future messages from that point on. + + + + + Applies a timeout policy for each element in the observable sequence. + If the next element isn't received within the specified timeout duration starting from + its predecessor, the other observable sequence is used to produce future messages from that point on. + + + + + Applies a timeout policy for each element in the observable sequence, using the specified scheduler to run timeout timers. + If the next element isn't received within the specified timeout duration starting from its + predecessor, a TimeoutException is propagated to the observer. + + + + + Applies a timeout policy for each element in the observable sequence. + If the next element isn't received within the specified timeout duration starting from its + predecessor, a TimeoutException is propagated to the observer. + + + + + Applies a timeout policy to the observable sequence based on an absolute time, + using the specified scheduler to run timeout timers. + If the sequence doesn't terminate before the specified absolute due time, the other + observable sequence is used to produce future messages from that point on. + + + + + Applies a timeout policy to the observable sequence based on an absolute time. + If the sequence doesn't terminate before the specified absolute due time, the other + observable sequence is used to produce future messages from that point on. + + + + + Applies a timeout policy to the observable sequence based on an absolute time, using the specified scheduler to run timeout timers. + If the sequence doesn't terminate before the specified absolute due time, a TimeoutException is propagated to the observer. + + + + + Applies a timeout policy to the observable sequence based on an absolute time. + If the sequence doesn't terminate before the specified absolute due time, a TimeoutException is propagated to the observer. + + + + + Records the time interval between consecutive elements in an observable sequence, + using the specified scheduler to compute time intervals. + + + + + Records the time interval between consecutive elements in an observable sequence. + + + + + matches when the observable sequence has an available element and + applies the map + + + + + Returns an observable sequence that terminates with an exception, + using the specified scheduler to send out the single OnError message. + + + + + Returns an observable sequence that terminates with an exception, + using the specified scheduler to send out the single OnError message. + + + + + Returns an observable sequence that terminates with an exception. + + + + + Returns an observable sequence that terminates with an exception. + + + + + Ignores elements from an observable sequence which are followed by another value within a computed throttle duration + + + + + Ignores elements from an observable sequence which are followed by another element within a specified relative time duration. + + + + + Ignores elements from an observable sequence which are followed by another element within a specified relative time duration. + + + + + Returns elements from an observable sequence as long as a specified condition is true. + The element's index is used in the logic of the predicate functi + + + + + Returns elements from an observable sequence as long as a specified condition is true. + + + + + Returns the elements from the source observable until the specified time, + using the specified scheduler to run timers. + + + + + Returns the elements from the source observable until the specified time + + + + + Returns the elements from the source observable sequence until the other produces and element + + + + + Returns a list with the specified number of contiguous elements from the end of an observable sequence. + + + + + Returns a list with the elements within the specified duration from the end of the observable source sequence, + using the specified scheduler to run timers. + + + + + Returns a list with the elements within the specified duration from the end of the observable source sequence. + + + + + Returns elements within the specified duration from the end of the observable source sequence, + using the specified scheduler to run timers. + + + + + Returns elements within the specified duration from the end of the observable source sequence. + + + + + Returns a specified number of contiguous elements from the end of an obserable sequence, + using the specified scheduler to drain the queue. + + + + + Returns a specified number of contiguous elements from the end of an obserable sequence + + + + + Takes elements for a specified duration from the start of the observable source sequence, + using the specified scheduler to run timers. + + + + + Takes elements for a specified duration from the start of the observable source sequence. + + + + + Returns a specified number of contiguous elemenents from the start of an observable sequence, + using the specified scheduler for the edge case of take(0). + + + + + Takes n elements (from the beginning of an observable sequence? ) + + + + + Bypasses the first element in an observable sequence and then returns the remaining elements. + + + + + Synchronizes the observable sequence such that observer notifications + cannot be delivered concurrently, using the specified gate object.This + overload is useful when writing n-ary query operators, in order to prevent + concurrent callbacks from different sources by synchronizing on a common gate object. + + + + + Synchronizes the observable sequence so that notifications cannot be delivered concurrently + this overload is useful to "fix" an observable sequence that exhibits concurrent + callbacks on individual observers, which is invalid behavior for the query processor + + + + + Transforms an observable sequence of tasks into an observable sequence + producing values only from the most recent observable sequence. + Each time a new task is received, the previous task's result is ignored. + + + + + Transforms an observable sequence of tasks into an observable sequence + producing values only from the most recent observable sequence. + Each time a new task is received, the previous task's result is ignored. + + + + + Transforms an observable sequence of observable sequences into an + observable sequence producing values only from the most recent + observable sequence.Each time a new inner observable sequnce is recieved, + unsubscribe from the previous inner sequence + + + + + Subscribes to the specified source, re-routing synchronous exceptions during invocation of the + Subscribe function to the observer's 'OnError channel. This function is typically used to write query operators. + + + + + Subscribes to the specified source, re-routing synchronous exceptions during invocation of the + Subscribe function to the observer's 'OnError channel. This function is typically used to write query operators. + + + + + Subscribes to the specified source, re-routing synchronous exceptions during invocation of the + Subscribe function to the observer's 'OnError channel. This function is typically used to write query operators. + + + + + Subscribes to the specified source, re-routing synchronous exceptions during invocation of the + Subscribe function to the observer's 'OnError channel. This function is typically used to write query operators. + + + + + Subscribes to the specified source, re-routing synchronous exceptions during invocation of the + Subscribe function to the observer's 'OnError channel. This function is typically used to write query operators. + + + + + Wraps the source sequence in order to run its subscription and unsubscription logic + on the specified SynchronizationContext. This operation is not commonly used; This only performs + the side-effects of subscription and unsubscription on the specified scheduler. + In order to invoke observer callbacks on a scheduler, use 'observeOn' + + + + + Wraps the source sequence in order to run its subscription and unsubscription logic + on the specified scheduler. This operation is not commonly used; This only performs + the side-effects of subscription and unsubscription on the specified scheduler. + In order to invoke observer callbacks on a scheduler, use 'observeOn' + + + + + Subscribes to the observable with the given observer + + + + + Subscribes to the observable with all three callbacks + + + + + Subscribes to the Observable with a next and a completion callback. + + + + + Subscribes to the Observable with a next and an error-function. + + + + + Subscribes to the Observable with a next fuction. + + + + + Prepends a sequence of values to an observable sequence. + + + + + Prepends a sequence of values to an observable sequence. + + + + + Bypasses elements in an observable sequence as long as a specified condition is true and then returns the remaining elements. + The element's index is used in the logic of the predicate functio + + + + + Bypasses elements in an observable sequence as long as a specified condition is true and then returns the remaining elements. + + + + + Returns the elements from the source observable sequence only after the other observable sequence produces an element. + + + + + Skips elements from the observable source sequence until the specified start time, + using the specified scheduler to run timers. + + + + + Skips elements from the observable source sequence until the specified start time. + + + + + Skips elements for the specified duration from the end of the observable source sequence, + using the specified scheduler to run timers. + + + + + Skips elements for the specified duration from the end of the observable source sequence. + + + + + Bypasses a specified number of elements at the end of an observable sequence. + + + + + Skips elements for the specified duration from the start of the observable source sequence, + using a specified scheduler to run timers. + + + + + Skips elements for the specified duration from the start of the observable source sequence. + + + + + Bypasses a specified number of elements in an observable sequence and then returns the remaining elements. + + + + + Returns an observable sequence that contains a single element, + using a specified scheduler to send out observer messages. + + + + + Returns an observable sequence that contains a single element. + + + + + If the condition evaluates true, select the "thenSource" sequence. Otherwise, select the else source + + + + + If the condition evaluates true, select the "thenSource" sequence. + Otherwise, return an empty sequence generated on the specified scheduler. + + + + + If the condition evaluates true, select the "thenSource" sequence. Otherwise, return an empty sequence. + + + + + Applies an accumulator function over an observable sequence and returns each intermediate result. + The specified init value is used as the initial accumulator value. + + + + + Applies an accumulator function over an observable sequence and returns each intermediate result. + + + + + Samples the source observable sequence using a samper observable sequence producing sampling ticks. + Upon each sampling tick, the latest element (if any) in the source sequence during the + last sampling interval is sent to the resulting sequence. + + + + + Samples the observable sequence at each interval, using the specified scheduler to run sampling timers. + Upon each sampling tick, the latest element (if any) in the source sequence during the + last sampling interval is sent to the resulting sequence. + + + + + Samples the observable at the given interval + + + + + Repeats the source observable sequence the specified number of times or until it successfully terminates. + + + + + Repeats the source observable sequence until it successfully terminates. + + + + + Returns an observable sequence that is the result of apply a map to a connectable observable sequence that + shares a single subscription to the underlying sequence replaying notifications subject to + a maximum time length and element count for the replay buffer. + + + + + Returns an observable sequence that is the result of apply a map to a connectable observable sequence that + shares a single subscription to the underlying sequence replaying notifications subject to + a maximum time length and element count for the replay buffer. + + + + + Returns an observable sequence that is the result of apply a map to a connectable observable sequence that + shares a single subscription to the underlying sequence replaying notifications subject to + a maximum time length. + + + + + Returns an observable sequence that is the result of apply a map to a connectable observable sequence that + shares a single subscription to the underlying sequence replaying notifications subject to + a maximum time length. + + + + + Returns an observable sequence that is the result of apply a map to a connectable observable sequence that + shares a single subscription to the underlying sequence replaying notifications subject to + a maximum element count for the replay buffer. + + + + + Returns a connectable observable sequence that shares a single subscription to the underlying sequence + + + + + Returns a connectable observable sequence that shares a single subscription to the underlying sequence + + + + + Returns a connectable observable sequence that shares a single subscription to the underlying sequence + replaying notifications subject to a maximum time length for the replay buffer. + + + + + Returns a connectable observable sequence that shares a single subscription to the underlying sequence + replaying notifications subject to a maximum time length for the replay buffer. + + + + + Returns an observable sequence that is the result of invoking the selector on a connectable observable + sequence that shares a single subscription to the underlying sequence replaying all notifications. + + + + + Returns a connectable observable sequence that shares a single subscription to the underlying sequence + replaying notifications subject to a maximum element count for the replay buffer. + + + + + Returns a connectable observable sequence that shares a single subscription to the + underlying sequence replaying all notifications. + + + + + Returns a connectable observable sequence that shares a single subscription to the + underlying sequence replaying all notifications. + + + + + Repeats the given observable sequence as long as the specified condition holds, where the + condition is evaluated after each repeated source is completed. + + + + + Generates an observable sequence that repeats the given element infinitely. + + + + + Repeats the observable sequence a specified number of times. + + + + + Repeats the observable sequence indefinitely. + + + + + Returns an observable that remains connected to the source as long + as there is at least one subscription to the observable sequence + ( publish an Observable to get a ConnectableObservable ) + + + + + Reduces the observable + + + + + Creates a range as an observable, using the specified scheduler to send out observer messages. + + + + + Creates a range as an observable + + + + + Returns an observable sequence that is the result of invoking + the selector on a connectable observable sequence that shares a + a single subscription to the underlying sequence. This operator is a + specialization of Multicast using a regular Subject + + + + + Returns an observable sequence that is the result of invoking + the selector on a connectable observable sequence containing + only the last notification This operator is a + specialization of Multicast using a regular Subject + + + + + Returns an observable sequence that is the result of + the map on a connectable observable sequence that shares a + a single subscription to the underlying sequence. This operator is a + specialization of Multicast using a regular Subject + + + + + Returns an observable sequence that is the result of invoking + the selector on a connectable observable sequence that shares a + a single subscription to the underlying sequence. This operator is a + specialization of Multicast using a regular Subject + + + + + Returns a connectable observable sequence (IConnectableObsevable) that shares + a single subscription to the underlying sequence and starts with the value + initial. This operator is a specialization of Multicast using a regular Subject + + + + + Returns a connectable observable sequence (IConnectableObsevable) that shares + a single subscription to the underlying sequence. This operator is a + specialization of Multicast using a regular Subject + + + + + Invokes the finally action after source observable sequence terminates normally or by an exception. + + + + + Logs the incoming emits with a given prefix to the console. + + + + + Logs the incoming emits with a given prefix to a specified target. + + + + + Iterates through the observable and performs the given side-effect + + + + + Concatenates all observable sequences in the given enumerable sequence, even if the + previous observable sequence terminated exceptionally. + + + + + Concatenates all of the specified observable sequences, even if the previous observable sequence terminated exceptionally. + + + + + Concatenates the second observable sequence to the first observable sequence + upon successful or exceptional termination of the first. + + + + + Filters the elements of an observable sequence based on the specified type + + + + + Wraps the source sequence in order to run its observer callbacks + on the specified synchronization context. + + + + + Wraps the source sequence in order to run its observer callbacks on the specified scheduler. + + + + + Returns the sequence as an observable, using the specified scheduler to run the enumeration loop + + + + + Returns the sequence as an observable + + + + + Returns an observable sequence whose enumeration blocks until the next + element in the source observable sequence becomes available. + Enumerators on the resulting sequence will block until the next + element becomes available. + + + + + Returns a non-terminating observable sequence, which can be + used to denote an infinite duration (e.g. when using reactive joins). + + + + + Returns a non-terminating observable sequence, which can + be used to denote an infinite duration (e.g. when using reactive joins). + + + + + Multicasts the source sequence notifications through an instantiated subject into + all uses of the sequence within a selector function. Each subscription to the + resulting sequence causes a separate multicast invocation, exposing the sequence + resulting from the selector function's invocation. For specializations with fixed + subject types, see Publish, PublishLast, and Replay. + + + + + Multicasts the source sequence notifications through the specified subject to + the resulting connectable observable. Upon connection of the connectable + observable, the subject is subscribed to the source exactly one, and messages + are forwarded to the observers registered with the connectable observable. + For specializations with fixed subject types, see Publish, PublishLast, and Replay. + + + + + Returns an enumerable sequence whose sequence whose enumeration returns the + most recently observed element in the source observable sequence, using + the specified + + + + + Returns the maximum element in an observable sequence. + + + + + Merge results from all source tasks into a single observable sequence + + + + + Merges an enumerable sequence of observable sequences into an observable sequence, + limiting the number of concurrent subscriptions to inner sequences, + using a specified scheduler for enumeration of and subscription to the sources. + + + + + Merges an enumerable sequence of observable sequences into an observable sequence, + limiting the number of concurrent subscriptions to inner sequences. + + + + + Merges an enumerable sequence of observable sequences into a single observable sequence, + using a specified scheduler for enumeration of and subscription to the sources. + + + + + Merges an enumerable sequence of observable sequences into a single observable sequence. + + + + + Merges elements from all inner observable sequences + into a single observable sequence limiting the number of concurrent + subscriptions to inner sequences + + + + + Merges elements from all inner observable sequences + into a single observable sequence. + + + + + Merges all the observable sequences into a single observable sequence, + using a specified scheduler for enumeration of and subscription to the sources. + + + + + Merges all the observable sequences into a single observable sequence. + + + + + Merges the two observables, using a specified scheduler for enumeration of and subscription to the sources. + + + + + Merges the two observables + + + + + Materializes the implicit notifications of an observable sequence as + explicit notification values + + + + + Maps every emission to a constant lazy value. + + + + + Maps every emission to a constant value. + + + + + Combines 'map' and 'fold'. Builds an observable whose emits are the result of applying the given function to each of the emits of the source observable. + The function is also used to accumulate a final value. + + + + + Maps two observables to the specified function. + + + + + Maps the given observable with the given function and the + index of the element + + + + + Maps the given observable with the given function + + + + + Returns an observable sequence containing an int that represents how many elements + in the specified observable sequence satisfy a condition. + + + + + Returns an observable sequence containing a int64 that represents + the total number of elements in an observable sequence + + + + + Returns an enumerable sequence whose enumeration returns the latest observed element in the source observable sequence. + Enumerators on the resulting sequence will never produce the same element repeatedly, + and will block until the next element becomes available. + + + + + Returns the last element of an observable sequence that satisfies the condition in the predicate + + + + + Returns the last element of an observable sequence. + + + + + Joins together the results from several patterns + + + + + Correlates the elements of two sequences based on overlapping durations. + + + + + Correlates the elements of two sequences based on overlapping durations. + + + + + Invokes the observer's methods for each message in the source sequence. + This method can be used for debugging, logging, etc. of query behavior by intercepting + the message stream to run arbitrary actions for messages on the pipeline. + + + + + Invokes an action for each element in the observable sequence and invokes an action + upon graceful or exceptional termination of the observable sequence. + This method can be used for debugging, logging, etc. of query behavior by intercepting + the message stream to run arbitrary actions for messages on the pipeline. + + + + + Invokes an action for each element in the observable sequence and invokes an action upon + exceptional termination of the observable sequence. This method can be used for debugging, + logging, etc. of query behavior by intercepting the message stream to run arbitrary + actions for messages on the pipeline. + + + + + Invokes an action for each element in the observable sequence and invokes an action + upon graceful termination of the observable sequence. This method can be used for debugging, + logging, etc. of query behavior by intercepting the message stream to run arbitrary + actions for messages on the pipeline. + + + + + Invokes an action for each element in the observable sequence, and propagates all observer + messages through the result sequence. This method can be used for debugging, logging, etc. of query + behavior by intercepting the message stream to run arbitrary actions for messages on the pipeline. + + + + + IsEmpty returns an Observable that emits true if and only if the + source Observable completes without emitting any items. + + + + + Returns an observable sequence that produces a value on the specified scheduler after each period + + + + + Returns an observable sequence that produces a value after each period + + + + + Takes the first element of the observable sequence + + + + + Creates an observable that calls the specified function (each time) + after an observer is attached to the observable. This is useful to + make sure that events triggered by the function are handled. + + + + + Correlates the elements of two sequences based on overlapping + durations and groups the results + + + + + Groups the elements of an observable sequence according to a specified key selector function and + comparer and selects the resulting elements by using a specified function. + A duration selector function is used to control the lifetime of groups. When a group expires, + it receives an OnCompleted notification. When a new element with the same + key value as a reclaimed group occurs, the group will be reborn with a new lifetime request. + + + + + Groups the elements of an observable sequence according to a specified key selector function + and selects the resulting elements by using a specified function. + A duration selector function is used to control the lifetime of groups. When a group expires, + it receives an OnCompleted notification. When a new element with the same + key value as a reclaimed group occurs, the group will be reborn with a new lifetime request. + + + + + Groups the elements of an observable sequence according to a specified key selector function and comparer. + A duration selector function is used to control the lifetime of groups. When a group expires, + it receives an OnCompleted notification. When a new element with the same + key value as a reclaimed group occurs, the group will be reborn with a new lifetime request. + + + + + Groups the elements of an observable sequence according to a specified key selector function. + A duration selector function is used to control the lifetime of groups. When a group expires, + it receives an OnCompleted notification. When a new element with the same + key value as a reclaimed group occurs, the group will be reborn with a new lifetime request. + + + + + Groups the elements of an observable sequence according to a specified key selector function + and comparer and selects the resulting elements by using a specified function. + + + + + Groups the elements of an observable sequence with the specified initial capacity + and selects the resulting elements by using a specified function. + + + + + Groups the elements of an observable sequence and selects the resulting elements by using a specified function. + + + + + Groups the elements of an observable sequence according to a specified key selector function and comparer. + + + + + Groups the elements of an observable sequence according to a specified key selector function. + + + + + Returns an enumerator that enumerates all values of the observable sequence. + + + + + Generates an observable sequence by running a state-driven and temporal loop producing the sequence's elements, + using a specified scheduler to run timers and to send out observer messages. + + + + + Generates an observable sequence by running a state-driven and temporal loop producing the sequence's elements. + + + + + Generates an observable sequence by running a state-driven and temporal loop producing the sequence's elements, + using a specified scheduler to run timers and to send out observer messages. + + + + + Generates an observable sequence by running a state-driven and temporal loop producing the sequence's elements. + + + + + Generates an observable sequence by running a state-driven loop producing the sequence's elements. + + + + + Generates an observable sequence by running a state-driven loop producing the sequence's elements. + + + + + Generates an observable from an IEvent<_> as an EventPattern. + + + + + Converts a .NET event to an observable sequence, using a supplied event delegate type on a specified scheduler. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + + + + + Converts a .NET event to an observable sequence, using a supplied event delegate type. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + + + + + Converts a .NET event to an observable sequence, using a conversion function to obtain the event delegate, using a specified scheduler to run timers. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern functions instead. + + + + + Converts a .NET event to an observable sequence, using a conversion function to obtain the event delegate. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern functions instead. + + + + + Converts an generic Action-based .NET event to an observable sequence. Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead. + + + + + Converts an generic Action-based .NET event to an observable sequence. Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead. + + + + + Converts an Action-based .NET event to an observable sequence. Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead. + + + + + Converts an Action-based .NET event to an observable sequence. Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead. + + + + + Applies an accumulator function over an observable sequence, returning the + result of the fold as a single element in the result sequence + init is the initial accumulator value, map is performed after the fold + + + + + Applies an accumulator function over an observable sequence, returning the + result of the fold as a single element in the result sequence + init is the initial accumulator value + + + + + Projects each element of an observable sequence to a async workflow and merges all of the async worksflow results into one observable sequence. + + + + +Helper function for turning async workflows into observables + + + + +Turns an F# async workflow into an observable + + + + + Projects each element of an observable sequence to a task and merges all of the task results into one observable sequence. + + + + + Projects each element of an observable sequence to an enumerable sequence and concatenates + the resulting enumerable sequences into one observable sequence. + + + + + Projects each element of the source observable sequence to the other observable sequence + and merges the resulting observable sequences into one observable sequence. + + + + + Projects each element of an observable sequence to an observable sequence + and merges the resulting observable sequences into one observable sequenc + + + + + Returns the first element of an observable sequence + if it satisfies the predicate + + + + + Returns the first element of an observable sequence + + + + + Invokes a specified action after the source observable sequence + terminates gracefully of exceptionally + + + + + Filters the observable elements of a sequence based on a predicate by + incorporating the element's index + + + + + Filters the observable elements of a sequence based on a predicate + + + + + Determines whether an observable sequence contains a specified value + which satisfies the given predicate + + + + + Determines whether an observable and enumerable sequence are equal by comparing the elements pairwise using a specified equality comparer. + + + + + Determines whether an observable and enumerable sequence are equal by comparing the elements pairwise. + + + + + Determines whether two sequences are equal by comparing the elements pairwise using a specified equality comparer. + + + + + Determines whether two sequences are equal by comparing the elements pairwise. + + + + + Returns an empty sequence, using the specified scheduler to send out the single OnCompleted message. + + + + + Returns an empty sequence, using the specified scheduler to send out the single OnCompleted message. + + + + + Returns an empty Observable sequence + + + + + Returns an empty observable + + + + + Returns the element at a specified index in a sequence or a default value if the index is out of range + + + + + Returns the element at a specified index in a sequence. + + + + + Returns an observable sequence that contains only distinct contiguous elements according to the keySelector and the comparer. + + + + + Returns an observable sequence that contains only distinct contiguous elements according to the comparer. + + + + + Returns an observable sequence that contains only distinct contiguous elements according to the keySelector. + + + + + Returns an observable sequence that only contains distinct contiguous elements + + + + + Returns an observable sequence that contains only distinct elements according to the keySelector and the comparer. + + + + + Returns an observable sequence that contains only distinct elements according to the comparer. + + + + + Returns an observable sequence that contains only distinct elements according to the keySelector. + + + + + Returns an observable sequence that only contains distinct elements + + + + + Dematerializes the explicit notification values of an observable sequence as implicit notifications. + + + + + Time shifts the observable sequence by delaying the subscription to the specified absolute time, + using the specified scheduler to run timers. + + + + + Time shifts the observable sequence by delaying the subscription to the specified absolute time. + + + + + Time shifts the observable sequence by delaying the subscription with the specified relative time duration, + using the specified scheduler to run timers. + + + + + Time shifts the observable sequence by delaying the subscription with the specified relative time duration. + + + + + Time shifts the observable sequence based on a subscription delay and a delay selector function for each element. + + + + + Time shifts the observable sequence based on a delay selector function for each element. + + + + + Time shifts the observable sequence to start propagating notifications at the specified absolute time, + using the specified scheduler to run timers. + The relative time intervals between the values are preserved. + + + + + Time shifts the observable sequence to start propagating notifications at the specified absolute time. + The relative time intervals between the values are preserved. + + + + + Time shifts the observable sequence by the specified relative time duration, + using the specified scheduler to run timers. + The relative time intervals between the values are preserved. + + + + + Time shifts the observable sequence by the specified relative time duration. + The relative time intervals between the values are preserved. + + + + + Returns an observable sequence that invokes the specified factory function whenever a new observer subscribes. + + + + + Returns the elements of the specified sequence or the specified value in a singleton sequence if the sequence is empty. + + + + + Returns the elements of the specified sequence or the type parameter's default value + in a singleton sequence if the sequence is empty. + + + + + Returns an observable sequence containing an int that represents how many elements + in the specified observable sequence satisfy a condition. + + + + + Counts the elements + + + + + Determines whether an observable sequence contains a + specified element by using a specified EqualityComparer + + + + + Determines whether an observable sequence contains a specified + element by using the default equality comparer. + + + + + Connects the observable wrapper to its source. All subscribed + observers will recieve values from the underlying observable + sequence as long as the connection is established. + ( publish an Observable to get a ConnectableObservable ) + + + + + Concatenates all task results as long as + the previous taskterminated successfully + + + + + Concatenates all of the inner observable sequences as long as + the previous observable sequence terminated successfully + + + + + Concatenates all of the specified observable sequences as long as + the previous observable sequence terminated successfully + + + + + Concatenates all observable sequences within the sequence as long as + the previous observable sequence terminated successfully + + + + + Concatenates the second observable sequence to the first observable sequence + upn the successful termination of the first + + + + + Merges the specified observable sequences into one observable sequence by applying the map + whenever any of the observable sequences produces an element. + + + + + Merges the specified observable sequences into one observable sequence by applying the map + whenever any of the observable sequences produces an element. + + + + + Merges the specified observable sequences into one observable sequence by + emmiting a list with the latest source elements of whenever any of the + observable sequences produces an element. + + + + + Merges the specified observable sequences into one observable sequence + whenever either of the observable sequences produces an element. + + + + + Produces an enumerable sequence that returns elements collected/aggregated from the source sequence between consecutive iterations. + merge - Merges a sequence element with the current collector + getNewCollector - Factory to replace the current collector by a new collector + getInitialCollector - Factory to create the initial collector object. + + + + + Produces an enumerable sequence that returns elements collected/aggregated from the source sequence between consecutive iterations. + merge - Merges a sequence element with the current collector + newCollector - Factory to create a new collector object. + + + + + Concatenates the observable sequences obtained by applying the map for each element in the given enumerable + + + + + Produces an enumerable sequence of consequtive (possibly empty) chunks of the source observable + + + + + Continues an observable sequence that is terminated by an exception with the next observable sequence. + + + + + Continues an observable sequence that is terminated by an exception with the next observable sequence. + + + + + Continues an observable sequence that is terminated by an exception of + the specified type with the observable sequence produced by the handler. + + + + + Continues an observable sequence that is terminated by an exception of + the specified type with the observable sequence produced by the handler, + wrapped in a 'Result' type. + + + + + Continues an observable sequence that is terminated by an exception + with an optional as result type. + + + + + Continues an observable sequence that is terminated + by an exception with the next observable sequence. + + + + + Uses selector to determine which source in sources to return, + choosing an empty sequence on the specified scheduler if no match is found. + + + + + Uses selector to determine which source in sources to return, + choosing defaulSource if no match is found + + + + + Uses selector to determine which source in sources to return, + choosing an empty sequence if no match is found + + + + + Converts the elements of the sequence to the specified type + + + + + Projects each element of an observable sequence into + zero or more buffers which are produced based on timing information, + using the specified scheduler to run timers. + + + + + Projects each element of an observable sequence into + zero or more buffers produced based on timing information + + + + + Projects each element of an observable sequence into zero of more buffers. + bufferOpenings - observable sequence whose elements denote the opening of each produced buffer + bufferClosing - observable sequence whose elements denote the closing of each produced buffer + + + + + Projects each element of an observable sequence into a buffer that's sent out + when either it's full or a given amount of time has elapsed, using the specified scheduler to run timers. + Analogy - A ferry leaves the dock when all the seats are taken, or at the scheduled time or departure, + whichever event occurs first. + + + + + Projects each element of an observable sequence into a buffer that goes + sent out when either it's full or a specific amount of time has elapsed + Analogy - A boat that departs when it's full or at its scheduled time to leave + + + + + Projects each element of an observable sequence into consecutive non-overlapping buffers + which are produced based on timing information, using the specified scheduler to run timers. + + + + + Projects each element of an observable sequence into + consequtive non-overlapping buffers produced based on timing information + + + + + Projects each element of an observable sequence into zero or more buffers + which are produced based on element count information + + + + + Projects each element of an observable sequence into + consequtive non-overlapping buffers produced based on count information + + + + + Projects each element of an observable sequence into + consequtive non-overlapping buffers based on a sequence of boundary markers + + + + + Matches when both observable sequences have an available value + + + + + Lifts the values of f and m and applies f to m, returning an IObservable of the result. + + + + + Binds an observable to generate a subsequent observable. + + + + + Hides the identy of an observable sequence + + + + + Determines whether an observable sequence contains any elements + + + + + Propagates the observable sequence that reacts first + + + + + Propagates the observable sequence that reacts first + + + + + Returns the observable sequence that reacts first + + + + + Determines whether all elements of an observable satisfy a predicate + + + + + Applies an accumulator function over an observable sequence, returning the + result of the aggregation as a single element in the result sequence + + + + + Subscribes to the Observable with all 3 callbacks. + + + + + Subscribes to the Observable with a next and a completion callback. + + + + + Subscribes to the Observable with a next and an error-function. + + + + + Subscribes to the Observable with just a next-function. + + + + + Creates an observable sequence from the specified asynchronous Subscribe method implementation. + + + + + Creates an observable sequence from the specified Subscribe method implementation. + + + + + Creates an observable sequence from the specified Subscribe method implementation. + + + + + Creates an observer that ignores the incoming emits from 'OnNext', 'OnError', and 'OnCompleted'. + + + + + Creates an observer from the specified onNext, onError, and onCompleted functions. + + + + + Creates an observer from the specified onNext and onCompleted functions. + + + + + Creates an observer from the specified onNext and onError functions. + + + + + Creates an observer from the specified onNext function. + + + + + The Reactive module provides operators for working with IObservable<_> in F#. + + + + + A reactive query builder. + See http://mnajder.blogspot.com/2011/09/when-reactive-framework-meets-f-30.html + + + + + An Observable computation builder. + + + + diff --git a/packages/FAKE.5.16.0/tools/FSharp.Core.dll b/packages/FAKE.5.16.0/tools/FSharp.Core.dll new file mode 100644 index 0000000..ade04dd Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FSharp.Core.dll differ diff --git a/packages/FAKE.5.16.0/tools/FSharp.Core.optdata b/packages/FAKE.5.16.0/tools/FSharp.Core.optdata new file mode 100644 index 0000000..8e4dcdd Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FSharp.Core.optdata differ diff --git a/packages/FAKE.5.16.0/tools/FSharp.Core.resources.dll b/packages/FAKE.5.16.0/tools/FSharp.Core.resources.dll new file mode 100644 index 0000000..c621017 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FSharp.Core.resources.dll differ diff --git a/packages/FAKE.5.16.0/tools/FSharp.Core.sigdata b/packages/FAKE.5.16.0/tools/FSharp.Core.sigdata new file mode 100644 index 0000000..d0766f3 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FSharp.Core.sigdata differ diff --git a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+monoandroid10+monotouch10+xamarinios10/FSharp.Core.xml b/packages/FAKE.5.16.0/tools/FSharp.Core.xml similarity index 89% rename from packages/FSharp.Core.4.0.0.1/lib/portable-net45+monoandroid10+monotouch10+xamarinios10/FSharp.Core.xml rename to packages/FAKE.5.16.0/tools/FSharp.Core.xml index 1dc4579..d630d77 100644 --- a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+monoandroid10+monotouch10+xamarinios10/FSharp.Core.xml +++ b/packages/FAKE.5.16.0/tools/FSharp.Core.xml @@ -2,6 +2,19 @@ FSharp.Core + + An abbreviation for the CLI type System.Collections.Generic.IEnumerable<_> + + + An abbreviation for the CLI type System.Collections.Generic.List<_> + + + An abbreviation for the type of immutable singly-linked lists. + + Use the constructors [] and :: (infix) to create values of this type, or + the notation [1;2;3]. Use the values in the List module to manipulate + values of this type, or pattern match against the values directly. + Gets the tail of the list, which is a list containing all the elements of the list, excluding the first element @@ -55,6 +68,13 @@ The number of bindings in the map. + + Lookup an element in the map, assigning to value if the element is in the domain + of the map and returning false if not. + The input key. + A reference to the output value. + true if the value is present, false if not. + Lookup an element in the map, returning a Some value if the element is in the domain of the map and None if not. @@ -72,7 +92,8 @@ True if the map contains the given key. - Returns a new map with the binding added to the given map. + Returns a new map with the binding added to the given map. + If a binding with the given key already exists in the input map, the existing binding is replaced by the new binding in the result map. The input key. The resulting map. @@ -89,9 +110,6 @@ All members of this class are thread-safe and may be used concurrently from multiple threads. - - An abbreviation for the CLI type System.Collections.Generic.List<_> - Returns a new set with the elements of the second set removed from the first. The first input set. @@ -171,17 +189,7 @@ All members of this class are thread-safe and may be used concurrently from multiple threads. - - An abbreviation for the type of immutable singly-linked lists. - - Use the constructors [] and :: (infix) to create values of this type, or - the notation [1;2;3]. Use the values in the List module to manipulate - values of this type, or pattern match against the values directly. - - - An abbreviation for the CLI type System.Collections.Generic.IEnumerable<_> - - + Fetches an element from a 2D array. You can also use the syntax array.[index1,index2]. The input array. @@ -191,7 +199,7 @@ The value of the array at the given index. Thrown when the indices are negative or exceed the bounds of the array. - + Sets the value of an element in an array. You can also use the syntax array.[index1,index2] <- value. The input array. @@ -200,7 +208,7 @@ The value to set in the array. Thrown when the indices are negative or exceed the bounds of the array. - + Builds a new array whose elements are the same as the input array but where a non-zero-based input array generates a corresponding zero-based output array. @@ -209,7 +217,7 @@ The zero-based output array. - + Builds a new array whose elements are the results of applying the given function to each of the elements of the array. The integer indices passed to the function indicates the element being transformed. @@ -223,11 +231,11 @@ An array whose elements have been transformed by the given mapping. - + Builds a new array whose elements are the results of applying the given function to each of the elements of the array. - For non-zero-based arrays the basing on an input array will be propogated to the output + For non-zero-based arrays the basing on an input array will be propagated to the output array. A function that is applied to transform each item of the input array. @@ -235,28 +243,28 @@ An array whose elements have been transformed by the given mapping. - + Returns the length of an array in the second dimension. The input array. The length of the array in the second dimension. - + Returns the length of an array in the first dimension. The input array. The length of the array in the first dimension. - + Applies the given function to each element of the array. The integer indices passed to the function indicates the index of element. A function to apply to each element of the array with the indices available as an argument. The input array. - + Applies the given function to each element of the array. A function to apply to each element of the array. @@ -326,7 +334,7 @@ The generated array. Thrown when either of the lengths is negative. - + Reads a range of elements from the first array and write them into the second. The source array. @@ -340,24 +348,24 @@ Thrown when any of the indices are negative or if either of the counts are larger than the dimensions of the array allow. - + Builds a new array whose elements are the same as the input array. - For non-zero-based arrays the basing on an input array will be propogated to the output + For non-zero-based arrays the basing on an input array will be propagated to the output array. The input array. A copy of the input array. - + Fetches the base-index for the second dimension of the array. The input array. The base-index of the second dimension of the array. - + Fetches the base-index for the first dimension of the array. The input array. @@ -377,1308 +385,1311 @@ Non-zero-based arrays can also be created using Array2D.zeroCreateBased, Array2D.createBased and Array2D.initBased. - - Creates an array where the entries are initially the "default" value. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The created array. - - - Sets the value of an element in an array. You can also - use the syntax 'array.[index1,index2,index3] <- value'. - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The value to set at the given index. + + Hash using the given hashing and equality functions. + A function to generate a hash code from a value. + A function to test equality of two values. + An object implementing IEqualityComparer using the supplied functions. - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer indices passed to the - function indicates the element being transformed. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - The function to transform the elements at each index in the array. - The input array. - The array created from the transformed elements. + + Physical hashing (hash on reference identity of objects, and the contents of value types). + Hash using LanguagePrimitives.PhysicalEquality and LanguagePrimitives.PhysicalHash, + That is, for value types use GetHashCode and Object.Equals (if no other optimization available), + and for reference types use System.Runtime.CompilerServices.RuntimeHelpers.GetHashCode and + reference equality. - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - The function to transform each element of the array. - The input array. - The array created from the transformed elements. + + Non-structural hashing. Equality using NonStructuralComparison.(=) and NonStructuralComparison.hash. - - Returns the length of an array in the third dimension. - The input array. - The length of the array in the third dimension. + + Structural hashing. Hash using Operators.(=) and Operators.hash. - - Returns the length of an array in the second dimension. - The input array. - The length of the array in the second dimension. + + Common notions of value identity used with hash tables. - - Returns the length of an array in the first dimension - The input array. - The length of the array in the first dimension. + + Compare using the given comparer function. + A function to compare two values. + An object implementing IComparer using the supplied comparer. - - Applies the given function to each element of the array. The integer indicies passed to the - function indicates the index of element. - The function to apply to each element of the array. - The input array. + + Non-structural comparison. Compare using NonStructuralComparison.compare. - - Applies the given function to each element of the array. - The function to apply to each element of the array. - The input array. + + Structural comparison. Compare using Operators.compare. - - Fetches an element from a 3D array. You can also use the syntax 'array.[index1,index2,index3]' - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The value at the given index. + + Common notions of comparison identity used with sorted data structures. - - Creates an array given the dimensions and a generator function to compute the elements. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The function to create an initial value at each index into the array. - The created array. + + Combines the three sequences into a list of triples. The sequences need not have equal lengths: + when one sequence is exhausted any remaining elements in the other + sequences are ignored. + + The first input sequence. + The second input sequence. + The third input sequence. + + The result sequence. + + Thrown when any of the input sequences is null. - - Creates an array whose elements are all initially the given value. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The value of the array elements. - The created array. + + Combines the two sequences into a list of pairs. The two sequences need not have equal lengths: + when one sequence is exhausted any remaining elements in the other + sequence are ignored. + + The first input sequence. + The second input sequence. + + The result sequence. + + Thrown when either of the input sequences is null. - - Basic operations on rank 3 arrays. + + Returns a sequence that yields sliding windows containing elements drawn from the input + sequence. Each window is returned as a fresh array. + The number of elements in each window. + The input sequence. + The result sequence. + Thrown when the input sequence is null. + Thrown when windowSize is not positive. - - Sets the value of an element in an array. You can also - use the syntax 'array.[index1,index2,index3,index4] <- value'. - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The index along the fourth dimension. - The value to set. + + Returns a sequence that contains the elements generated by the given computation. + The given initial state argument is passed to the element generator. + For each IEnumerator elements in the stream are generated on-demand by applying the element + generator, until a None value is returned by the element generator. Each call to the element + generator returns a new residual state. + + The stream will be recomputed each time an IEnumerator is requested and iterated for the Seq. + + The returned sequence may be passed between threads safely. However, + individual IEnumerator values generated from the returned sequence should not be accessed concurrently. + + A function that takes in the current state and returns an option tuple of the next + element of the sequence and the next state value. + The initial state value. + + The result sequence. - - Fetches an element from a 4D array. You can also use the syntax 'array.[index1,index2,index3,index4]' - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The index along the fourth dimension. - The value at the given index. + + Returns a sequence that when enumerated returns at most N elements. + + The maximum number of items to enumerate. + The input sequence. + + The result sequence. + + Thrown when the input sequence is null. - - Creates an array where the entries are initially the "default" value. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The length of the fourth dimension. - The created array. + + Returns the transpose of the given sequence of sequences. + This function returns a sequence that digests the whole initial sequence as soon as + that sequence is iterated. As a result this function should not be used with + large or infinite sequences. + The input sequence. + The transposed sequence. + Thrown when the input sequence is null. - - Returns the length of an array in the fourth dimension. - The input array. - The length of the array in the fourth dimension. + + Applies the given function to successive elements, returning the first + result where the function returns "Some(x)". + + A function that transforms items from the input sequence into options. + The input sequence. + + The chosen element or None. + + Thrown when the input sequence is null. - - Returns the length of an array in the third dimension. - The input array. - The length of the array in the third dimension. + + Returns the index of the last element in the sequence + that satisfies the given predicate. Return None if no such element exists. + This function digests the whole initial sequence as soon as it is called. As a + result this function should not be used with large or infinite sequences. + A function that evaluates to a Boolean when given an item in the sequence. + The input sequence. + The found index or None. + Thrown when the input sequence is null. + This function consumes the whole input sequence before returning the result. - - Returns the length of an array in the second dimension. - The input array. - The length of the array in the second dimension. + + Tries to find the nth element in the sequence. + Returns None if index is negative or the input sequence does not contain enough elements. + The index of element to retrieve. + The input sequence. + The nth element of the sequence or None. + Thrown when the input sequence is null. - - Returns the length of an array in the first dimension - The input array. - The length of the array in the first dimension. + + Returns the index of the first element in the sequence + that satisfies the given predicate. Return None if no such element exists. + + A function that evaluates to a Boolean when given an item in the sequence. + The input sequence. + + The found index or None. + + Thrown when the input sequence is null. - - Creates an array given the dimensions and a generator function to compute the elements. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The length of the fourth dimension. - The function to create an initial value at each index in the array. - The created array. - - - Creates an array whose elements are all initially the given value - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The length of the fourth dimension. - The initial value for each element of the array. - The created array. - - - Basic operations on rank 4 arrays. - - - Combines three arrays into an array of pairs. The three arrays must have equal lengths, otherwise an ArgumentException is - raised. - The first input array. - The second input array. - The third input array. - Thrown when any of the input arrays are null. - Thrown when the input arrays differ in length. - The array of tupled elements. - - - Combines the two arrays into an array of pairs. The two arrays must have equal lengths, otherwise an ArgumentException is - raised. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The array of tupled elements. - - - Returns an array of sliding windows containing elements drawn from the input - array. Each window is returned as a fresh array. - The number of elements in each window. - The input array. - The result array. - Thrown when the input array is null. - Thrown when windowSize is not positive. + + Returns the last element for which the given function returns True. + Return None if no such element exists. + This function digests the whole initial sequence as soon as it is called. As a + result this function should not be used with large or infinite sequences. + A function that evaluates to a Boolean when given an item in the sequence. + The input sequence. + The found element or None. + Thrown when the input sequence is null. + This function consumes the whole input sequence before returning the result. - - Returns a new array containing only the elements of the array - for which the given predicate returns "true". - The function to test the input elements. - The input array. - An array containing the elements for which the given predicate returns true. + + Returns the first element for which the given function returns True. + Return None if no such element exists. - Thrown when the input array is null. - - - Splits an array of triples into three arrays. - The input array. - The tuple of three arrays. - Thrown when the input array is null. - - - Splits an array of pairs into two arrays. - The input array. - The two arrays. - Thrown when the input array is null. - - - Returns an array that contains the elements generated by the given computation. - The given initial state argument is passed to the element generator. - A function that takes in the current state and returns an option tuple of the next - element of the array and the next state value. - The initial state value. - The result array. - - - Returns the index of the last element in the array - that satisfies the given predicate. - The function to test the input elements. - The input array. - Thrown when the input array is null. - The index of the last element that satisfies the predicate, or None. - - - Tries to find the nth element in the array. - Returns None if index is negative or the input array does not contain enough elements. - The index of element to retrieve. - The input array. - The nth element of the array or None. - Thrown when the input array is null. - - - Returns the index of the first element in the array - that satisfies the given predicate. - The function to test the input elements. - The input array. - Thrown when the input array is null. - The index of the first element that satisfies the predicate, or None. - - - Returns the last element for which the given function returns true. - Return None if no such element exists. - The function to test the input elements. - The input array. - Thrown when the input array is null. - The last element that satisfies the predicate, or None. + A function that evaluates to a Boolean when given an item in the sequence. + The input sequence. + + The found element or None. + + Thrown when the input sequence is null. - - Returns the first element for which the given function returns true. - Return None if no such element exists. - The function to test the input elements. - The input array. - The first element that satisfies the predicate, or None. - Thrown when the input array is null. + + Builds a list from the given collection. + + The input sequence. + + The result list. + + Thrown when the input sequence is null. - - Returns at most N elements in a new array. - The maximum number of items to return. - The input array. + + Builds an array from the given collection. + + The input sequence. + The result array. - Thrown when the input array is null. - - - Views the given array as a sequence. - The input array. - The sequence of array elements. - Thrown when the input array is null. - - - Builds a list from the given array. - The input array. - The list of array elements. - Thrown when the input array is null. - - - Returns a new array containing the elements of the original except the first element. - The input array. - Thrown when the array is empty. - Thrown when the input array is null. - A new array containing the elements of the original except the first element. + Thrown when the input sequence is null. - - Returns an array that contains all elements of the original array while the - given predicate returns true, and then returns no further elements. + + Returns a sequence that, when iterated, yields elements of the underlying sequence while the + given predicate returns True, and then returns no further elements. A function that evaluates to false when no more items should be returned. - The input array. + The input sequence. - The result array. + The result sequence. - Thrown when the input array is null. + Thrown when the input sequence is null. - - Returns the first N elements of the array. + + Returns the first N elements of the sequence. Throws InvalidOperationException - if the count exceeds the number of elements in the array. Array.truncate - returns as many items as the array contains instead of throwing an exception. + if the count exceeds the number of elements in the sequence. Seq.truncate + returns as many items as the sequence contains instead of throwing an exception. The number of items to take. - The input array. + The input sequence. - The result array. + The result sequence. - Thrown when the input array is null. - Thrown when the input array is empty. + Thrown when the input sequence is null. + Thrown when the input sequence is empty. Thrown when count exceeds the number of elements - in the list. - - - Returns the sum of the results generated by applying the function to each element of the array. - The function to transform the array elements into the type to be summed. - The input array. - The resulting sum. - Thrown when the input array is null. - - - Returns the sum of the elements in the array. - The input array. - The resulting sum. - Thrown when the input array is null. + in the sequence. - - Sorts the elements of an array, in descending order, using the given projection for the keys and returning a new array. - Elements are compared using Operators.compare. + + Returns a sequence that skips 1 element of the underlying sequence and then yields the + remaining elements of the sequence. - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to transform array elements into the type that is compared. - The input array. - The sorted array. - - - Sorts the elements of an array, in descending order, returning a new array. Elements are compared using Operators.compare. + The input sequence. - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The input array. - The sorted array. - - - Splits an array into two arrays, at the given index. - The index at which the array is split. - The input array. - The two split arrays. + The result sequence. - Thrown when the input array is null. - Thrown when split index exceeds the number of elements - in the array. - - - Sorts the elements of an array by mutating the array in-place, using the given comparison function. - Elements are compared using Operators.compare. - The input array. - Thrown when the input array is null. + Thrown when the input sequence is null. + Thrown when the input sequence is empty. - - Sorts the elements of an array by mutating the array in-place, using the given comparison function as the order. - The function to compare pairs of array elements. - The input array. - Thrown when the input array is null. + + Returns the sum of the results generated by applying the function to each element of the sequence. + The generated elements are summed using the + operator and Zero property associated with the generated type. + + A function to transform items from the input sequence into the type that will be summed. + The input sequence. + + The computed sum. - - Sorts the elements of an array by mutating the array in-place, using the given projection for the keys. - Elements are compared using Operators.compare. + + Returns the sum of the elements in the sequence. - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to transform array elements into the type that is compared. - The input array. - Thrown when the input array is null. + The elements are summed using the + operator and Zero property associated with the generated type. + + The input sequence. + + The computed sum. - - Sorts the elements of an array, using the given comparison function as the order, returning a new array. + + Applies a key-generating function to each element of a sequence and yield a sequence ordered + descending by keys. The keys are compared using generic comparison as implemented by Operators.compare. + + This function returns a sequence that digests the whole initial sequence as soon as + that sequence is iterated. As a result this function should not be used with + large or infinite sequences. The function makes no assumption on the ordering of the original + sequence. - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to compare pairs of array elements. - The input array. - The sorted array. - Thrown when the input array is null. + This is a stable sort, that is the original order of equal elements is preserved. + + A function to transform items of the input sequence into comparable keys. + The input sequence. + + The result sequence. + + Thrown when the input sequence is null. - - Sorts the elements of an array, using the given projection for the keys and returning a new array. - Elements are compared using Operators.compare. + + Yields a sequence ordered descending by keys. + + This function returns a sequence that digests the whole initial sequence as soon as + that sequence is iterated. As a result this function should not be used with + large or infinite sequences. The function makes no assumption on the ordering of the original + sequence. - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to transform array elements into the type that is compared. - The input array. - The sorted array. - Thrown when the input array is null. + This is a stable sort, that is the original order of equal elements is preserved. + + The input sequence. + + The result sequence. + + Thrown when the input sequence is null. - - Sorts the elements of an array, returning a new array. Elements are compared using Operators.compare. + + Applies a key-generating function to each element of a sequence and yield a sequence ordered + by keys. The keys are compared using generic comparison as implemented by Operators.compare. + + This function returns a sequence that digests the whole initial sequence as soon as + that sequence is iterated. As a result this function should not be used with + large or infinite sequences. The function makes no assumption on the ordering of the original + sequence. - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The input array. - The sorted array. - Thrown when the input array is null. + This is a stable sort, that is the original order of equal elements is preserved. + + A function to transform items of the input sequence into comparable keys. + The input sequence. + + The result sequence. + + Thrown when the input sequence is null. - - Builds a new array that contains the given subrange specified by - starting index and length. - The input array. - The index of the first element of the sub array. - The length of the sub array. - The created sub array. - Thrown when the input array is null. - Thrown when either startIndex or count is negative, - or when there aren't enough elements in the input array. + + Yields a sequence ordered using the given comparison function. + This function returns a sequence that digests the whole initial sequence as soon as + that sequence is iterated. As a result this function should not be used with + large or infinite sequences. The function makes no assumption on the ordering of the original + sequence. + + This is a stable sort, that is the original order of equal elements is preserved. + The function to compare the collection elements. + The input sequence. + The result sequence. + This function consumes the whole input sequence before yielding the first element of the result sequence. - - Bypasses elements in an array while the given predicate returns true, and then returns - the remaining elements in a new array. - A function that evaluates an element of the array to a boolean value. - The input array. - The created sub array. - Thrown when the input array is null. + + Yields a sequence ordered by keys. + + This function returns a sequence that digests the whole initial sequence as soon as + that sequence is iterated. As a result this function should not be used with + large or infinite sequences. The function makes no assumption on the ordering of the original + sequence. + + This is a stable sort, that is the original order of equal elements is preserved. + + The input sequence. + + The result sequence. + + Thrown when the input sequence is null. + This function consumes the whole input sequence before yielding the first element of the result sequence. - - Builds a new array that contains the elements of the given array, excluding the first N elements. - The number of elements to skip. - The input array. - A copy of the input array, after removing the first N elements. - Thrown when the input array is null. - Thrown when count is negative or exceeds the number of - elements in the array. + + Returns a sequence that, when iterated, skips elements of the underlying sequence while the + given predicate returns True, and then yields the remaining elements of the sequence. + + A function that evaluates an element of the sequence to a boolean value. + The input sequence. + + The result sequence. + + Thrown when the input sequence is null. - - Sets an element of an array. - The input array. - The input index. - The input value. - Thrown when the input array is null. - Thrown when the index is negative or the input array does not contain enough elements. + + Returns a sequence that skips N elements of the underlying sequence and then yields the + remaining elements of the sequence. + + The number of items to skip. + The input sequence. + + The result sequence. + + Thrown when the input sequence is null. + Thrown when count exceeds the number of elements + in the sequence. - - Returns an array that contains one item only. + + Returns a sequence that yields one item only. The input item. - The result array of one item. + The result sequence of one item. - - Like foldBack, but return both the intermediary and final results. - The function to update the state given the input elements. - The input array. + + Like foldBack, but returns the sequence of intermediary and final results. + This function returns a sequence that digests the whole initial sequence as soon as that + sequence is iterated. As a result this function should not be used with large or infinite sequences. + + A function that updates the state with each element from the sequence. + The input sequence. The initial state. - The array of state values. - Thrown when the input array is null. + The resulting sequence of computed states. + Thrown when the input sequence is null. + This function consumes the whole input sequence before yielding the first element of the result sequence. - - Like fold, but return the intermediary and final results. - The function to update the state given the input elements. + + Like fold, but computes on-demand and returns the sequence of intermediary and final results. + + A function that updates the state with each element from the sequence. The initial state. - The input array. - The array of state values. - Thrown when the input array is null. - - - Returns a new array with the elements in reverse order. - The input array. - The reversed array. - Thrown when the input array is null. + The input sequence. + + The resulting sequence of computed states. + + Thrown when the input sequence is null. - - Creates an array by replicating the given initial value. - The number of elements to replicate. - The value to replicate - The generated array. - Thrown when count is negative. + + Returns a new sequence with the elements in reverse order. + The input sequence. + The reversed sequence. + Thrown when the input sequence is null. + This function consumes the whole input sequence before yielding the first element of the reversed sequence. - - Applies a function to each element of the array, starting from the end, threading an accumulator argument + + Applies a function to each element of the sequence, starting from the end, threading an accumulator argument through the computation. If the input function is f and the elements are i0...iN then computes f i0 (...(f iN-1 iN)). - A function that takes in the next-to-last element of the list and the + A function that takes in the next-to-last element of the sequence and the current accumulated result to produce the next accumulated result. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. + The input sequence. The final result of the reductions. + Thrown when the input sequence is null. + Thrown when the input sequence is empty. + This function consumes the whole input sequence before returning the result. - - Applies a function to each element of the array, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f (... (f i0 i1)...) iN. - Raises ArgumentException if the array has size zero. - The function to reduce a pair of elements to a single element. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The final result of the redcutions. - - - Returns an array with all elements permuted according to the - specified permutation. - The function that maps input indices to output indices. - The input array. - The output array. - Thrown when the input array is null. - Thrown when indexMap does not produce a valid permutation. - - - Splits the collection into two collections, containing the - elements for which the given predicate returns "true" and "false" - respectively. - The function to test the input elements. - The input array. - A pair of arrays. The first containing the elements the predicate evaluated to true, - and the second containing those evaluated to false. - Thrown when the input array is null. + + Creates a sequence by replicating the given initial value. + The number of elements to replicate. + The value to replicate + The generated sequence. - - Returns an array of each element in the input array and its predecessor, with the - exception of the first element which is only returned as the predecessor of the second element. + + Applies a function to each element of the sequence, threading an accumulator argument + through the computation. Begin by applying the function to the first two elements. + Then feed this result into the function along with the third element and so on. + Return the final result. - The input array. + A function that takes in the current accumulated result and the next + element of the sequence to produce the next accumulated result. + The input sequence. - The result array. + The final result of the reduction function. Thrown when the input sequence is null. + Thrown when the input sequence is empty. - - Builds a new array from the given enumerable object. + + Builds a new sequence object that delegates to the given sequence object. This ensures + the original sequence cannot be rediscovered and mutated by a type cast. For example, + if given an array the returned sequence will return the elements of the array, but + you cannot cast the returned sequence object to an array. + The input sequence. - The array of elements from the sequence. + + The result sequence. + Thrown when the input sequence is null. - - Builds an array from the given list. - The input list. - The array of elements from the list. + + Applies the given function to successive elements, returning the first + x where the function returns "Some(x)". + + A function to transform each item of the input sequence into an option of the output type. + The input sequence. + + The selected element. + + Thrown when the input sequence is null. + Thrown when every item of the sequence + evaluates to None when the given function is applied. - - Returns the lowest of all elements of the array, compared via Operators.min on the function result. + + Returns a sequence with all elements permuted according to the + specified permutation. - Throws ArgumentException for empty arrays. - The function to transform the elements into a type supporting comparison. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The minimum element. + Note that this function returns a sequence that digests the whole initial sequence as soon as + that sequence is iterated. As a result this function should not be used with + large or infinite sequences. + + The function that maps input indices to output indices. + The input sequence. + + The result sequence. + + Thrown when the input sequence is null. + Thrown when indexMap does not produce a valid permutation. + This function consumes the whole input sequence before yielding the first element of the result sequence. - - Returns the lowest of all elements of the array, compared via Operators.min. + + Returns a sequence of each element in the input sequence and its predecessor, with the + exception of the first element which is only returned as the predecessor of the second element. - Throws ArgumentException for empty arrays - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The minimum element. + The input sequence. + + The result sequence. + + Thrown when the input sequence is null. - - Returns the greatest of all elements of the array, compared via Operators.max on the function result. + + Views the given list as a sequence. - Throws ArgumentException for empty arrays. - The function to transform the elements into a type supporting comparison. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The maximum element. + The input list. + + The result sequence. - - Returns the greatest of all elements of the array, compared via Operators.max on the function result. + + Views the given array as a sequence. - Throws ArgumentException for empty arrays. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The maximum element. + The input array. + + The result sequence. + + Thrown when the input sequence is null. - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer index passed to the - function indicates the index of element being transformed. - The function to transform elements and their indices. - The input array. - The array of transformed elements. - Thrown when the input array is null. + + Computes the nth element in the collection. + + The index of element to retrieve. + The input sequence. + + The nth element of the sequence. + + Thrown when the input sequence is null. + Thrown when the index is negative or the input sequence does not contain enough elements. - + + Returns the lowest of all elements of the sequence, compared via Operators.min on the function result. + + A function to transform items from the input sequence into comparable keys. + The input sequence. + + The smallest element of the sequence. + + Thrown when the input sequence is null. + Thrown when the input sequence is empty. + + + Returns the lowest of all elements of the sequence, compared via Operators.min. + + The input sequence. + + The smallest element of the sequence. + + Thrown when the input sequence is null. + Thrown when the input sequence is empty. + + + Returns the greatest of all elements of the sequence, compared via Operators.max on the function result. + + A function to transform items from the input sequence into comparable keys. + The input sequence. + + The largest element of the sequence. + + Thrown when the input sequence is null. + Thrown when the input sequence is empty. + + + Returns the greatest of all elements of the sequence, compared via Operators.max + + The input sequence. + + Thrown when the input sequence is null. + Thrown when the input sequence is empty. + + The largest element of the sequence. + + Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the two collections pairwise, also passing the index of - the elements. The two input arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to transform pairs of input elements and their indices. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The array of transformed elements. + to the corresponding pairs of elements from the two sequences. If one input sequence is shorter than + the other then the remaining elements of the longer sequence are ignored. The integer index passed to the + function indicates the index (from 0) of element being transformed. + + A function to transform pairs of items from the input sequences that also supplies the current index. + The first input sequence. + The second input sequence. + + The result sequence. + + Thrown when either of the input sequences is null. - + Builds a new collection whose elements are the results of applying the given function - to the corresponding triples from the three collections. The three input - arrays must have the same length, otherwise an ArgumentException is - raised. - The function to transform the pairs of the input elements. - The first input array. - The second input array. - The third input array. - Thrown when the input arrays differ in length. - Thrown when any of the input arrays is null. - The array of transformed elements. + to each of the elements of the collection. The integer index passed to the + function indicates the index (from 0) of element being transformed. + + A function to transform items from the input sequence that also supplies the current index. + The input sequence. + + The result sequence. + + Thrown when the input sequence is null. - - Combines map and foldBack. Builds a new array whose elements are the results of applying the given function - to each of the elements of the input array. The function is also used to accumulate a final value. - The function to transform elements from the input array and accumulate the final value. - The input array. + + Builds a new collection whose elements are the results of applying the given function + to the corresponding triples of elements from the three sequences. If one input sequence if shorter than + the others then the remaining elements of the longer sequences are ignored. + + The function to transform triples of elements from the input sequences. + The first input sequence. + The second input sequence. + The third input sequence. + + The result sequence. + + Thrown when any of the input sequences is null. + + + Combines map and foldBack. Builds a new collection whose elements are the results of applying the given function + to each of the elements of the collection. The function is also used to accumulate a final value. + This function digests the whole initial sequence as soon as it is called. As a result this function should + not be used with large or infinite sequences. + The function to transform elements from the input collection and accumulate the final value. + The input collection. The initial state. - Thrown when the input array is null. - The array of transformed elements, and the final accumulated value. + Thrown when the input collection is null. + The collection of transformed elements, and the final accumulated value. + This function consumes the whole input sequence before yielding the first element of the result sequence. - - Combines map and fold. Builds a new array whose elements are the results of applying the given function - to each of the elements of the input array. The function is also used to accumulate a final value. - The function to transform elements from the input array and accumulate the final value. + + Combines map and fold. Builds a new collection whose elements are the results of applying the given function + to each of the elements of the collection. The function is also used to accumulate a final value. + This function digests the whole initial sequence as soon as it is called. As a result this function should + not be used with large or infinite sequences. + The function to transform elements from the input collection and accumulate the final value. The initial state. - The input array. - Thrown when the input array is null. - The array of transformed elements, and the final accumulated value. + The input collection. + Thrown when the input collection is null. + The collection of transformed elements, and the final accumulated value. + This function consumes the whole input sequence before yielding the first element of the result sequence. - + Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the two collections pairwise. The two input - arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to transform the pairs of the input elements. - The first input array. - The second input array. - Thrown when the input arrays differ in length. - Thrown when either of the input arrays is null. - The array of transformed elements. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. - The function to transform elements of the array. - The input array. - The array of transformed elements. - Thrown when the input array is null. - - - Returns the last element of the array. - Return None if no such element exists. - The input array. - The last element of the array or None. - Thrown when the input sequence is null. + to the corresponding pairs of elements from the two sequences. If one input sequence is shorter than + the other then the remaining elements of the longer sequence are ignored. + + A function to transform pairs of items from the input sequences. + The first input sequence. + The second input sequence. + + The result sequence. + + Thrown when either of the input sequences is null. - - Returns the length of an array. You can also use property arr.Length. - The input array. - The length of the array. - Thrown when the input array is null. + + Builds a new collection whose elements are the results of applying the given function + to each of the elements of the collection. The given function will be applied + as elements are demanded using the MoveNext method on enumerators retrieved from the + object. + + The returned sequence may be passed between threads safely. However, + individual IEnumerator values generated from the returned sequence should not be accessed concurrently. + + A function to transform items from the input sequence. + The input sequence. + + The result sequence. + + Thrown when the input sequence is null. - - Gets an element from an array. - The input index. - The input array. - The value of the array at the given index. - Thrown when the input array is null. - Thrown when the index is negative or the input array does not contain enough elements. + + Returns the length of the sequence + + The input sequence. + + The length of the sequence. + + Thrown when the input sequence is null. - - Returns the last element of the array. - The input array. - The last element of the array. - Thrown when the input array is null. - Thrown when the input does not have any elements. + + Applies the given function to two collections simultaneously. If one sequence is shorter than + the other then the remaining elements of the longer sequence are ignored. The integer passed to the + function indicates the index of element. + + A function to apply to each pair of elements from the input sequences along with their index. + The first input sequence. + The second input sequence. + + Thrown when either of the input sequences is null. - - Applies the given function to pair of elements drawn from matching indices in two arrays, - also passing the index of the elements. The two arrays must have the same lengths, - otherwise an ArgumentException is raised. - The function to apply to each index and pair of elements. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. + + Applies the given function to two collections simultaneously. If one sequence is shorter than + the other then the remaining elements of the longer sequence are ignored. + + A function to apply to each pair of elements from the input sequences. + The first input sequence. + The second input sequence. + + Thrown when either of the input sequences is null. - - Applies the given function to each element of the array. The integer passed to the + + Applies the given function to each element of the collection. The integer passed to the function indicates the index of element. - The function to apply to each index and element. - The input array. - Thrown when the input array is null. - - - Applies the given function to pair of elements drawn from matching indices in two arrays. The - two arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to apply. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. + + A function to apply to each element of the sequence that can also access the current index. + The input sequence. + + Thrown when the input sequence is null. - - Applies the given function to each element of the array. - The function to apply. - The input array. - Thrown when the input array is null. + + Applies the given function to each element of the collection. + + A function to apply to each element of the sequence. + The input sequence. + + Thrown when the input sequence is null. - - Returns true if the given array is empty, otherwise false. - The input array. - True if the array is empty. - Thrown when the input array is null. + + Computes the element at the specified index in the collection. + The index of the element to retrieve. + The input sequence. + The element at the specified index of the sequence. + Thrown when the input sequence is null. + Thrown when the index is negative or the input sequence does not contain enough elements. - - Creates an array where the entries are initially the default value Unchecked.defaultof<'T>. - The length of the array to create. - The created array. - Thrown when count is negative. + + Generates a new sequence which, when iterated, will return successive + elements by calling the given function. The results of calling the function + will not be saved, that is the function will be reapplied as necessary to + regenerate the elements. The function is passed the index of the item being + generated. + + The returned sequence may be passed between threads safely. However, + individual IEnumerator values generated from the returned sequence should not be accessed concurrently. + Iteration can continue up to Int32.MaxValue. + + A function that generates an item in the sequence from a given index. + + The result sequence. - - Creates an array given the dimension and a generator function to compute the elements. - The number of elements to initialize. - The function to generate the initial values for each index. - The created array. + + Generates a new sequence which, when iterated, will return successive + elements by calling the given function, up to the given count. Each element is saved after its + initialization. The function is passed the index of the item being + generated. + + The returned sequence may be passed between threads safely. However, + individual IEnumerator values generated from the returned sequence should not be accessed concurrently. + + The maximum number of items to generate for the sequence. + A function that generates an item in the sequence from a given index. + + The result sequence. + Thrown when count is negative. - - Builds a new array whose elements are the corresponding elements of the input array + + Builds a new collection whose elements are the corresponding elements of the input collection paired with the integer index (from 0) of each element. - The input array. - The array of indexed elements. - Thrown when the input array is null. + The input sequence. + The result sequence. + Thrown when the input sequence is null. - - Applies a key-generating function to each element of an array and yields an array of - unique keys. Each unique key contains an array of all elements that match - to this key. + + Returns true if the sequence contains no elements, false otherwise. - A function that transforms an element of the array into a comparable key. - The input array. + The input sequence. - The result array. + True if the sequence is empty; false otherwise. - Thrown when the input array is null. + Thrown when the input sequence is null. - - Returns the first element of the array. + + Returns the only element of the sequence or None if sequence is empty or contains more than one element. - The input array. + The input sequence. - The first element of the array. + The only element of the sequence or None. - Thrown when the input array is null. - Thrown when the input array is empty. - - - Gets an element from an array. - The input array. - The input index. - The value of the array at the given index. - Thrown when the input array is null. - Thrown when the index is negative or the input array does not contain enough elements. + Thrown when the input sequence is null. - - Apply a function to pairs of elements drawn from the two collections, right-to-left, - threading an accumulator argument through the computation. The two input - arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to update the state given the input elements. - The first input array. - The second input array. - The initial state. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The final state. + + Returns the only element of the sequence. + + The input sequence. + + The only element of the sequence. + + Thrown when the input sequence is null. + Thrown when the input does not have precisely one element. - - Applies a function to pairs of elements drawn from the two collections, - left-to-right, threading an accumulator argument - through the computation. The two input - arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to update the state given the input elements. - The initial state. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The final state. - - - Applies a function to each element of the array, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then computes - f i0 (...(f iN s)) - The function to update the state given the input elements. - The input array. - The initial state. - The state object after the folding function is applied to each element of the array. - Thrown when the input array is null. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then computes - f (... (f s i0)...) iN - The function to update the state given the input elements. - The initial state. - The input array. - The final state. - Thrown when the input array is null. - - - Tests if all corresponding elements of the array satisfy the given predicate pairwise. + + Returns the last element of the sequence. + Return None if no such element exists. - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns false then the overall result is - false and no further elements are tested. Otherwise, if one collection is longer - than the other then the ArgumentException exception is raised. - Otherwise, true is returned. - The function to test the input elements. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - True if all of the array elements satisfy the predicate. - - - Tests if all elements of the array satisfy the given predicate. + The input sequence. - The predicate is applied to the elements of the input collection. If any application - returns false then the overall result is false and no further elements are tested. - Otherwise, true is returned. - The function to test the input elements. - The input array. - True if all of the array elements satisfy the predicate. - Thrown when the input array is null. - - - Returns the index of the last element in the array - that satisfies the given predicate. Raise KeyNotFoundException if - none of the elements satisfy the predicate. - The function to test the input elements. - The input array. - Thrown if predicate - never returns true. - Thrown when the input array is null. - The index of the last element in the array that satisfies the given predicate. - - - Returns the index of the first element in the array - that satisfies the given predicate. Raise KeyNotFoundException if - none of the elements satisfy the predicate. - The function to test the input elements. - The input array. - Thrown if predicate - never returns true. - Thrown when the input array is null. - The index of the first element in the array that satisfies the given predicate. - - - Returns the last element for which the given function returns 'true'. - Raise KeyNotFoundException if no such element exists. - The function to test the input elements. - The input array. - Thrown if predicate - never returns true. - Thrown when the input array is null. - The last element for which predicate returns true. - - - Returns the first element for which the given function returns 'true'. - Raise KeyNotFoundException if no such element exists. - The function to test the input elements. - The input array. - Thrown when the input array is null. - Thrown if predicate - never returns true. - The first element for which predicate returns true. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true". - The function to test the input elements. - The input array. - An array containing the elements for which the given predicate returns true. - Thrown when the input array is null. - - - Tests if any pair of corresponding elements of the arrays satisfies the given predicate. + The last element of the sequence or None. - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns true then the overall result is - true and no further elements are tested. Otherwise, if one collections is longer - than the other then the ArgumentException exception is raised. - Otherwise, false is returned. - The function to test the input elements. - The first input array. - The second input array. - True if any result from predicate is true. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. + Thrown when the input sequence is null. - - Tests if any element of the array satisfies the given predicate. - - The predicate is applied to the elements of the input array. If any application - returns true then the overall result is true and no further elements are tested. - Otherwise, false is returned. - The function to test the input elements. - The input array. - True if any result from predicate is true. - Thrown when the input array is null. + + Returns the last element of the sequence. + The input sequence. + The last element of the sequence. + Thrown when the input sequence is null. + Thrown when the input does not have any elements. - - Returns a new list with the distinct elements of the input array which do not appear in the itemsToExclude sequence, - using generic hash and equality comparisons to compare values. + + Returns the first element of the sequence, or None if the sequence is empty. - A sequence whose elements that also occur in the input array will cause those elements to be - removed from the result. - An array whose elements that are not also in itemsToExclude will be returned. + The input sequence. - An array that contains the distinct elements of array that do not appear in itemsToExclude. + The first element of the sequence or None. - Thrown when either itemsToExclude or array is null. + Thrown when the input sequence is null. - - Returns the only element of the array. + + Returns the first element of the sequence. - The input array. + The input sequence. - The only element of the array. + The first element of the sequence. - Thrown when the input array is null. - Thrown when the input does not have precisely one element. - - - Returns an empty array of the given type. - The empty array. + Thrown when the input sequence is null. + Thrown when the input does not have any elements. - - Splits the input array into at most count chunks. - The maximum number of chunks. - The input array. - The array split into chunks. - Thrown when the input array is null. - Thrown when count is not positive. + + Applies a key-generating function to each element of a sequence and yields a sequence of + unique keys. Each unique key contains a sequence of all elements that match + to this key. + + This function returns a sequence that digests the whole initial sequence as soon as + that sequence is iterated. As a result this function should not be used with + large or infinite sequences. The function makes no assumption on the ordering of the original + sequence. + + A function that transforms an element of the sequence into a comparable key. + The input sequence. + + The result sequence. - - Returns an array that contains no duplicate entries according to the - generic hash and equality comparisons on the keys returned by the given key-generating function. - If an element occurs multiple times in the array then the later occurrences are discarded. + + Tests the all pairs of elements drawn from the two sequences satisfy the + given predicate. If one sequence is shorter than + the other then the remaining elements of the longer sequence are ignored. - A function transforming the array items into comparable keys. - The input array. + A function to test pairs of elements from the input sequences. + The first input sequence. + The second input sequence. - The result array. + True if all pairs satisfy the predicate; false otherwise. - Thrown when the input array is null. + Thrown when either of the input sequences is null. - - Returns an array that contains no duplicate entries according to generic hash and - equality comparisons on the entries. - If an element occurs multiple times in the array then the later occurrences are discarded. + + Tests if all elements of the sequence satisfy the given predicate. - The input array. + The predicate is applied to the elements of the input sequence. If any application + returns false then the overall result is false and no further elements are tested. + Otherwise, true is returned. - The result array. + A function to test an element of the input sequence. + The input sequence. - Thrown when the input array is null. + True if every element of the sequence satisfies the predicate; false otherwise. + + Thrown when the input sequence is null. - - Divides the input array into chunks of size at most chunkSize. - The maximum size of each chunk. - The input array. - The array divided into chunks. - Thrown when the input array is null. - Thrown when chunkSize is not positive. + + Applies a function to corresponding elements of two collections, starting from the end of the shorter collection, + threading an accumulator argument through the computation. The two sequences need not have equal lengths. + If the input function is f and the elements are i0...iN and j0...jM, N < M + then computes f i0 j0 (... (f iN jN s)...). + The function to update the state given the input elements. + The first input sequence. + The second input sequence. + The initial state. + The final state value. + Thrown when the either of the input sequences is null. - - Applies the given function to each element of the array. Returns - the array comprised of the results "x" for each element where - the function returns Some(x) - The function to generate options from the elements. - The input array. - The array of results. - Thrown when the input array is null. + + Applies a function to each element of the collection, starting from the end, threading an accumulator argument + through the computation. If the input function is f and the elements are i0...iN + then computes f i0 (... (f iN s)...) + The function to update the state given the input elements. + The input sequence. + The initial state. + The state object after the folding function is applied to each element of the sequence. + Thrown when the input sequence is null. + This function consumes the whole input sequence before returning the result. - - Applies the given function to successive elements, returning the first - result where function returns Some(x) for some x. If the function - never returns Some(x) then KeyNotFoundException is raised. - The function to generate options from the elements. - The input array. - Thrown when the input array is null. - Thrown if every result from - chooser is None. - The first result. - - - Fills a range of elements of the array with the given value. - The target array. - The index of the first element to set. - The number of elements to set. - The value to set. - Thrown when the input array is null. - Thrown when either targetIndex or count is negative. - - - Applies the given function to successive elements, returning the first - result where function returns Some(x) for some x. If the function - never returns Some(x) then None is returned. - The function to transform the array elements into options. - The input array. - The first transformed element that is Some(x). - Thrown when the input array is null. - - - Returns the first element of the array, or - None if the array is empty. - The input array. - Thrown when the input array is null. - The first element of the array or None. - - - Creates an array whose elements are all initially the given value. - The length of the array to create. - The value for the elements. - The created array. - Thrown when count is negative. + + Applies a function to corresponding elements of two collections, threading an accumulator argument + through the computation. The two sequences need not have equal lengths: + when one sequence is exhausted any remaining elements in the other sequence are ignored. + If the input function is f and the elements are i0...iN and j0...jN + then computes f (... (f s i0 j0)...) iN jN. + The function to update the state given the input elements. + The initial state. + The first input sequence. + The second input sequence. + The final state value. + Thrown when the either of the input sequences is null. - - Applies a key-generating function to each element of an array and returns an array yielding unique - keys and their number of occurrences in the original array. + + Applies a function to each element of the collection, threading an accumulator argument + through the computation. If the input function is f and the elements are i0...iN + then computes f (... (f s i0)...) iN - A function transforming each item of the input array into a key to be - compared against the others. - The input array. + A function that updates the state with each element from the sequence. + The initial state. + The input sequence. - The result array. + The state object after the folding function is applied to each element of the sequence. - Thrown when the input array is null. - - - Builds a new array that contains the elements of the given array. - The input array. - A copy of the input array. - Thrown when the input array is null. - - - Tests if the array contains the specified element. - The value to locate in the input array. - The input array. - True if the input array contains the specified element; false otherwise. - Thrown when the input array is null. - - - Builds a new array that contains the elements of each of the given sequence of arrays. - The input sequence of arrays. - The concatenation of the sequence of input arrays. Thrown when the input sequence is null. - - Compares two arrays using the given comparison function, element by element. - Returns the first non-zero result from the comparison function. If the end of an array - is reached it returns a -1 if the first array is shorter and a 1 if the second array - is shorter. + + Returns the index of the last element for which the given function returns True. + This function digests the whole initial sequence as soon as it is called. As a + result this function should not be used with large or infinite sequences. + A function to test whether the index of a particular element should be returned. + The input sequence. + The index of the last element for which the predicate returns True. + Thrown if no element returns true when + evaluated by the predicate + Thrown when the input sequence is null + This function consumes the whole input sequence before returning the result. + + + Returns the index of the first element for which the given function returns True. - A function that takes an element from each array and returns an int. - If it evaluates to a non-zero value iteration is stopped and that value is returned. - The first input array. - The second input array. + A function to test whether the index of a particular element should be returned. + The input sequence. - The first non-zero value from the comparison function. + The index of the first element for which the predicate returns True. - Thrown when either of the input arrays - is null. - - - For each element of the array, applies the given function. Concatenates all the results and return the combined array. - The function to create sub-arrays from the input array elements. - The input array. - The concatenation of the sub-arrays. - Thrown when the input array is null. - - - Reads a range of elements from the first array and write them into the second. - The source array. - The starting index of the source array. - The target array. - The starting index of the target array. - The number of elements to copy. - Thrown when either of the input arrays is null. - Thrown when any of sourceIndex, targetIndex or count are negative, - or when there aren't enough elements in source or target. - - - Returns the average of the elements generated by applying the function to each element of the array. - The function to transform the array elements before averaging. - The input array. - Thrown when array is empty. - The computed average. - Thrown when the input array is null. - - - Returns the average of the elements in the array. - The input array. - Thrown when array is empty. - The average of the elements in the array. - Thrown when the input array is null. + Thrown if no element returns true when + evaluated by the predicate + Thrown when the input sequence is null - - Builds a new array that contains the elements of the first array followed by the elements of the second array. - The first input array. - The second input array. - The resulting array. - Thrown when either of the input arrays is null. + + Returns the last element for which the given function returns True. + This function digests the whole initial sequence as soon as it is called. As a + result this function should not be used with large or infinite sequences. + A function to test whether an item in the sequence should be returned. + The input sequence. + The last element for which the predicate returns True. + Thrown if no element returns true when + evaluated by the predicate + Thrown when the input sequence is null + This function consumes the whole input sequence before returning the result. - - Split the collection into two collections, containing the - elements for which the given predicate returns "true" and "false" - respectively + + Returns the first element for which the given function returns True. - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to indicies is not specified. - The function to test the input elements. - The input array. - 'T[] * 'T[] - Thrown when the input array is null. - - - Create an array given the dimension and a generator function to compute the elements. + A function to test whether an item in the sequence should be returned. + The input sequence. - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to indicies is not specified. - - - 'T[] - - - Apply the given function to each element of the array. The integer passed to the - function indicates the index of element. + The first element for which the predicate returns True. - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to elements of the input array is not specified. - - The input array. - Thrown when the input array is null. + Thrown if no element returns true when + evaluated by the predicate + Thrown when the input sequence is null - - Apply the given function to each element of the array. + + Returns a new collection containing only the elements of the collection + for which the given predicate returns "true". - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to elements of the input array is not specified. - - The input array. - Thrown when the input array is null. - - - Build a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer index passed to the - function indicates the index of element being transformed. + The returned sequence may be passed between threads safely. However, + individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to elements of the input array is not specified. - - The input array. - 'U[] - Thrown when the input array is null. - - - Build a new array whose elements are the results of applying the given function - to each of the elements of the array. + Remember sequence is lazy, effects are delayed until it is enumerated. + + A synonym for Seq.filter. - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to elements of the input array is not specified. - - The input array. - 'U[] - Thrown when the input array is null. - - - For each element of the array, apply the given function. Concatenate all the results and return the combined array. + A function to test whether each item in the input sequence should be included in the output. + The input sequence. - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to elements of the input array is not specified. - - The input array. - 'U[] - Thrown when the input array is null. - - - Apply the given function to each element of the array. Return - the array comprised of the results "x" for each element where - the function returns Some(x). + The result sequence. - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to elements of the input array is not specified. - The function to generate options from the elements. - The input array. - 'U[] - Thrown when the input array is null. - - - Provides parallel operations on arrays - - - Basic operations on arrays. + Thrown when the input sequence is null. - - Compare using the given comparer function. - A function to compare two values. - An object implementing IComparer using the supplied comparer. - - - Non-structural comparison. Compare using NonStructuralComparison.compare. + + Returns a new collection containing only the elements of the collection + for which the given predicate returns "true". This is a synonym for Seq.where. + + The returned sequence may be passed between threads safely. However, + individual IEnumerator values generated from the returned sequence should not be accessed concurrently. + + Remember sequence is lazy, effects are delayed until it is enumerated. + + A function to test whether each item in the input sequence should be included in the output. + The input sequence. + + The result sequence. + + Thrown when the input sequence is null. - - Structural comparison. Compare using Operators.compare. + + Tests if any pair of corresponding elements of the input sequences satisfies the given predicate. + + The predicate is applied to matching elements in the two sequences up to the lesser of the + two lengths of the collections. If any application returns true then the overall result is + true and no further elements are tested. Otherwise, false is returned. If one sequence is shorter than + the other then the remaining elements of the longer sequence are ignored. + + A function to test each pair of items from the input sequences. + The first input sequence. + The second input sequence. + + True if any result from the predicate is true; false otherwise. + + Thrown when either of the two input sequences is null. - - Common notions of comparison identity used with sorted data structures. + + Tests if any element of the sequence satisfies the given predicate. + + The predicate is applied to the elements of the input sequence. If any application + returns true then the overall result is true and no further elements are tested. + Otherwise, false is returned. + + A function to test each item of the input sequence. + The input sequence. + + True if any result from the predicate is true; false otherwise. + + Thrown when the input sequence is null. - - Hash using the given hashing and equality functions. - A function to generate a hash code from a value. - A function to test equality of two values. - An object implementing IEqualityComparer using the supplied functions. + + Returns a new sequence with the distinct elements of the second sequence which do not appear in the first sequence, + using generic hash and equality comparisons to compare values. + + Note that this function returns a sequence that digests the whole of the first input sequence as soon as + the result sequence is iterated. As a result this function should not be used with + large or infinite sequences in the first parameter. The function makes no assumption on the ordering of the first input + sequence. + + A sequence whose elements that also occur in the second sequence will cause those elements to be + removed from the returned sequence. + A sequence whose elements that are not also in first will be returned. + + A sequence that contains the set difference of the elements of two sequences. + + Thrown when either of the two input sequences is null. - - Physical hashing (hash on reference identity of objects, and the contents of value types). - Hash using LanguagePrimitives.PhysicalEquality and LanguagePrimitives.PhysicalHash, - That is, for value types use GetHashCode and Object.Equals (if no other optimization available), - and for reference types use System.Runtime.CompilerServices.RuntimeHelpers.GetHashCode and - reference equality. + + Creates an empty sequence. + + An empty sequence. - - Non-structural hashing. Equality using NonStructuralComparison.(=) and NonStructuralComparison.hash. + + Splits the input sequence into at most count chunks. + This function returns a sequence that digests the whole initial sequence as soon as that + sequence is iterated. As a result this function should not be used with large or infinite sequences. + The maximum number of chunks. + The input sequence. + The sequence split into chunks. + Thrown when the input sequence is null. + Thrown when count is not positive. + This function consumes the whole input sequence before yielding the first element of the result sequence. - - Structural hashing. Hash using Operators.(=) and Operators.hash. + + Returns a sequence that contains no duplicate entries according to the + generic hash and equality comparisons on the keys returned by the given key-generating function. + If an element occurs multiple times in the sequence then the later occurrences are discarded. + + A function transforming the sequence items into comparable keys. + The input sequence. + + The result sequence. + + Thrown when the input sequence is null. - - Common notions of value identity used with hash tables. + + Returns a sequence that contains no duplicate entries according to generic hash and + equality comparisons on the entries. + If an element occurs multiple times in the sequence then the later occurrences are discarded. + + The input sequence. + + The result sequence. + + Thrown when the input sequence is null. - - Combines the three lists into a list of triples. The lists must have equal lengths. - The first input list. - The second input list. - The third input list. - A single list containing triples of matching elements from the input lists. + + Returns a sequence that is built from the given delayed specification of a + sequence. + + The input function is evaluated each time an IEnumerator for the sequence + is requested. + + The generating function for the sequence. - - Combines the two lists into a list of pairs. The two lists must have equal lengths. - The first input list. - The second input list. - A single list containing pairs of matching elements from the input lists. + + Applies a key-generating function to each element of a sequence and returns a sequence yielding unique + keys and their number of occurrences in the original sequence. + + Note that this function returns a sequence that digests the whole initial sequence as soon as + that sequence is iterated. As a result this function should not be used with + large or infinite sequences. The function makes no assumption on the ordering of the original + sequence. + + A function transforming each item of the input sequence into a key to be + compared against the others. + The input sequence. + + The result sequence. + + Thrown when the input sequence is null. - - Returns a list of sliding windows containing elements drawn from the input - list. Each window is returned as a fresh list. - The number of elements in each window. - The input list. - The result list. - Thrown when windowSize is not positive. + + Tests if the sequence contains the specified element. + The value to locate in the input sequence. + The input sequence. + True if the input sequence contains the specified element; false otherwise. + Thrown when the input sequence is null. - - Returns a new list containing only the elements of the list - for which the given predicate returns "true" - The function to test the input elements. - The input list. - A list containing only the elements that satisfy the predicate. + + Combines the given enumeration-of-enumerations as a single concatenated + enumeration. + + The returned sequence may be passed between threads safely. However, + individual IEnumerator values generated from the returned sequence should not be accessed concurrently. + + The input enumeration-of-enumerations. + + The result sequence. + + Thrown when the input sequence is null. - - Splits a list of triples into three lists. - The input list. - Three lists of split elements. + + Compares two sequences using the given comparison function, element by element. + + A function that takes an element from each sequence and returns an int. + If it evaluates to a non-zero value iteration is stopped and that value is returned. + The first input sequence. + The second input sequence. + + Returns the first non-zero result from the comparison function. If the end of a sequence + is reached it returns a -1 if the first sequence is shorter and a 1 if the second sequence + is shorter. + + Thrown when either of the input sequences + is null. - - Splits a list of pairs into two lists. - The input list. - Two lists of split elements. + + Applies the given function to each element of the sequence and concatenates all the + results. + + Remember sequence is lazy, effects are delayed until it is enumerated. + + A function to transform elements of the input sequence into the sequences + that will then be concatenated. + The input sequence. + + The result sequence. + + Thrown when the input sequence is null. - - Returns a list that contains the elements generated by the given computation. - The given initial state argument is passed to the element generator. - A function that takes in the current state and returns an option tuple of the next - element of the list and the next state value. - The initial state value. - The result list. + + Divides the input sequence into chunks of size at most chunkSize. + The maximum size of each chunk. + The input sequence. + The sequence divided into chunks. + Thrown when the input sequence is null. + Thrown when chunkSize is not positive. - - Returns the index of the last element in the list - that satisfies the given predicate. - Return None if no such element exists. - The function to test the input elements. - The input list. - The index of the last element for which the predicate returns true, or None if - every element evaluates to false. + + Applies the given function to each element of the list. Return + the list comprised of the results "x" for each element where + the function returns Some(x). + + The returned sequence may be passed between threads safely. However, + individual IEnumerator values generated from the returned sequence should not + be accessed concurrently. + + A function to transform items of type T into options of type U. + The input sequence of type T. + + The result sequence. + + Thrown when the input sequence is null. - - Tries to find the nth element in the list. - Returns None if index is negative or the list does not contain enough elements. - The index to retrieve. + + Wraps a loosely-typed System.Collections sequence as a typed sequence. + + The use of this function usually requires a type annotation. + An incorrect type annotation may result in runtime type + errors. + Individual IEnumerator values generated from the returned sequence should not be accessed concurrently. + + The input sequence. + + The result sequence. + + Thrown when the input sequence is null. + + + Returns a sequence that corresponds to a cached version of the input sequence. + This result sequence will have the same elements as the input sequence. The result + can be enumerated multiple times. The input sequence will be enumerated at most + once and only as far as is necessary. Caching a sequence is typically useful when repeatedly + evaluating items in the original sequence is computationally expensive or if + iterating the sequence causes side-effects that the user does not want to be + repeated multiple times. + + Enumeration of the result sequence is thread safe in the sense that multiple independent IEnumerator + values may be used simultaneously from different threads (accesses to + the internal lookaside table are thread safe). Each individual IEnumerator + is not typically thread safe and should not be accessed concurrently. + + Once enumeration of the input sequence has started, + it's enumerator will be kept live by this object until the enumeration has completed. + At that point, the enumerator will be disposed. + + The enumerator may be disposed and underlying cache storage released by + converting the returned sequence object to type IDisposable, and calling the Dispose method + on this object. The sequence object may then be re-enumerated and a fresh enumerator will + be used. + + The input sequence. + + The result sequence. + + Thrown when the input sequence is null. + + + Returns the average of the results generated by applying the function to each element + of the sequence. + + The elements are averaged using the + operator, DivideByInt method and Zero property + associated with the generated type. + + A function applied to transform each element of the sequence. + The input sequence. + + The average. + + Thrown when the input sequence is null. + Thrown when the input sequence has zero elements. + + + Returns the average of the elements in the sequence. + + The elements are averaged using the + operator, DivideByInt method and Zero property + associated with the element type. + + The input sequence. + + The average. + + Thrown when the input sequence is null. + Thrown when the input sequence has zero elements. + + + Wraps the two given enumerations as a single concatenated + enumeration. + + The returned sequence may be passed between threads safely. However, + individual IEnumerator values generated from the returned sequence should not be accessed + concurrently. + + The first sequence. + The second sequence. + + The result sequence. + + Thrown when either of the two provided sequences is + null. + + + Returns a new sequence that contains all pairings of elements from the first and second sequences. + The first sequence. + The second sequence. + The result sequence. + Thrown when either of the input sequences is null. + + + Basic operations on IEnumerables. + + + Combines the three lists into a list of triples. The lists must have equal lengths. + The first input list. + The second input list. + The third input list. + A single list containing triples of matching elements from the input lists. + + + Combines the two lists into a list of pairs. The two lists must have equal lengths. + The first input list. + The second input list. + A single list containing pairs of matching elements from the input lists. + + + Returns a list of sliding windows containing elements drawn from the input + list. Each window is returned as a fresh list. + The number of elements in each window. + The input list. + The result list. + Thrown when windowSize is not positive. + + + Returns a new list containing only the elements of the list + for which the given predicate returns "true" + The function to test the input elements. + The input list. + A list containing only the elements that satisfy the predicate. + + + Splits a list of triples into three lists. + The input list. + Three lists of split elements. + + + Splits a list of pairs into two lists. + The input list. + Two lists of split elements. + + + Returns a list that contains the elements generated by the given computation. + The given initial state argument is passed to the element generator. + A function that takes in the current state and returns an option tuple of the next + element of the list and the next state value. + The initial state value. + The result list. + + + Returns the index of the last element in the list + that satisfies the given predicate. + Return None if no such element exists. + The function to test the input elements. + The input list. + The index of the last element for which the predicate returns true, or None if + every element evaluates to false. + + + Tries to find the nth element in the list. + Returns None if index is negative or the list does not contain enough elements. + The index to retrieve. The input list. The value at the given index or None. @@ -1692,16 +1703,16 @@ every element evaluates to false. - Returns the last element for which the given function returns true.. - Return None if no such element exists. + Returns the last element for which the given function returns True. + Return None if no such element exists. The function to test the input elements. The input list. The last element for which the predicate returns true, or None if every element evaluates to false. - Returns the first element for which the given function returns true.. - Return None if no such element exists. + Returns the first element for which the given function returns True. + Return None if no such element exists. The function to test the input elements. The input list. The first element for which the predicate returns true, or None if @@ -1721,6 +1732,13 @@ The input list. The result list. + + Returns the transpose of the given sequence of lists. + The input sequence of list. + The transposed list. + Thrown when the input sequence is null. + Thrown when the input lists differ in length. + Returns the first element of the list, or None if the list is empty. @@ -1739,7 +1757,7 @@ Returns a list that contains all elements of the original list while the - given predicate returns true, and then returns no further elements. + given predicate returns True, and then returns no further elements. A function that evaluates to false when no more items should be returned. The input list. @@ -1827,7 +1845,7 @@ The sorted list. - Bypasses elements in a list while the given predicate returns true, and then returns + Bypasses elements in a list while the given predicate returns True, and then returns the remaining elements of the list. A function that evaluates an element of the list to a boolean value. The input list. @@ -1918,7 +1936,7 @@ Splits the collection into two collections, containing the - elements for which the given predicate returns true and false + elements for which the given predicate returns True and False respectively. Element order is preserved in both of the created lists. The function to test the input elements. The input list. @@ -2218,7 +2236,7 @@ The index of the first element that satisfies the predicate. - Returns the last element for which the given function returns true. + Returns the last element for which the given function returns True. Raises KeyNotFoundException if no such element exists. The function to test the input elements. The input list. @@ -2227,7 +2245,7 @@ The last element that satisfies the predicate. - Returns the first element for which the given function returns true. + Returns the first element for which the given function returns True. Raises KeyNotFoundException if no such element exists. The function to test the input elements. The input list. @@ -2259,6 +2277,13 @@ The input list. True if any element satisfies the predicate. + + Returns the only element of the list or None if it is empty or contains more than one element. + + The input list. + + The only element of the list or None. + Returns the only element of the list. @@ -2331,17 +2356,18 @@ The resulting concatenated list. - Compares two lists using the given comparison function, element by element. - Returns the first non-zero result from the comparison function. If the end of a list - is reached it returns a -1 if the first list is shorter and a 1 if the second list - is shorter. + Compares two lists using the given comparison function, element by element. A function that takes an element from each list and returns an int. If it evaluates to a non-zero value iteration is stopped and that value is returned. The first input list. The second input list. - The first non-zero value from the comparison function. + Returns the first non-zero result from the comparison function. If the first list has a + larger element, the return value is always positive. If the second list has a larger + element, the return value is always negative. When the elements are equal in the two + lists, 1 is returned if the first list is longer, 0 is returned if they are equal in + length, and -1 is returned when the second list is longer. For each element of the list, applies the given function. Concatenates all the results and return the combined list. @@ -2388,1340 +2414,1409 @@ The second input list. The resulting list. + + Returns a new list that contains all pairings of elements from the first and second lists. + The first input list. + The second input list. + The resulting list of pairs. + Basic operations on lists. - - Returns the key of the first mapping in the collection that satisfies the given predicate. - Returns 'None' if no such element exists. - The function to test the input elements. - The input map. - The first key for which the predicate returns true or None if the predicate evaluates to false for each key/value pair. - - - Evaluates the function on each mapping in the collection. Returns the key for the first mapping - where the function returns 'true'. Raise KeyNotFoundException if no such element exists. - The function to test the input elements. - The input map. - Thrown if the key does not exist in the map. - The first key for which the predicate evaluates true. + + Combines three arrays into an array of pairs. The three arrays must have equal lengths, otherwise an ArgumentException is + raised. + The first input array. + The second input array. + The third input array. + Thrown when any of the input arrays are null. + Thrown when the input arrays differ in length. + The array of tupled elements. - - Lookup an element in the map, returning a Some value if the element is in the domain - of the map and None if not. - The input key. - The input map. - The found Some value or None. + + Combines the two arrays into an array of pairs. The two arrays must have equal lengths, otherwise an ArgumentException is + raised. + The first input array. + The second input array. + Thrown when either of the input arrays is null. + Thrown when the input arrays differ in length. + The array of tupled elements. - - Removes an element from the domain of the map. No exception is raised if the element is not present. - The input key. - The input map. - The resulting map. + + Returns an array of sliding windows containing elements drawn from the input + array. Each window is returned as a fresh array. + The number of elements in each window. + The input array. + The result array. + Thrown when the input array is null. + Thrown when windowSize is not positive. - - Builds two new maps, one containing the bindings for which the given predicate returns 'true', - and the other the remaining bindings. + + Returns a new array containing only the elements of the array + for which the given predicate returns "true". The function to test the input elements. - The input map. - A pair of maps in which the first contains the elements for which the predicate returned true - and the second containing the elements for which the predicated returned false. + The input array. + An array containing the elements for which the given predicate returns true. + + Thrown when the input array is null. - - Tests if an element is in the domain of the map. - The input key. - The input map. - True if the map contains the key. + + Splits an array of triples into three arrays. + The input array. + The tuple of three arrays. + Thrown when the input array is null. - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The key passed to the - function indicates the key of element being transformed. - The function to transform the key/value pairs. - The input map. - The resulting map of keys and transformed values. + + Splits an array of pairs into two arrays. + The input array. + The two arrays. + Thrown when the input array is null. - - Returns true if the given predicate returns true for all of the - bindings in the map. - The function to test the input elements. - The input map. - True if the predicate evaluates to true for all of the bindings in the map. - - - Builds a new map containing only the bindings for which the given predicate returns 'true'. - The function to test the key/value pairs. - The input map. - The filtered map. + + Returns an array that contains the elements generated by the given computation. + The given initial state argument is passed to the element generator. + A function that takes in the current state and returns an option tuple of the next + element of the array and the next state value. + The initial state value. + The result array. - - Returns true if the given predicate returns true for one of the - bindings in the map. + + Returns the index of the last element in the array + that satisfies the given predicate. The function to test the input elements. - The input map. - True if the predicate returns true for one of the key/value pairs. - - - Applies the given function to each binding in the dictionary - The function to apply to each key/value pair. - The input map. - - - Folds over the bindings in the map - The function to update the state given the input key/value pairs. - The initial state. - The input map. - The final state value. - - - Folds over the bindings in the map. - The function to update the state given the input key/value pairs. - The input map. - The initial state. - The final state value. - - - Searches the map looking for the first element where the given function returns a Some value - The function to generate options from the key/value pairs. - The input map. - The first result. - - - Searches the map looking for the first element where the given function returns a Some value. - The function to generate options from the key/value pairs. - The input map. - The first result. - - - Lookup an element in the map, raising KeyNotFoundException if no binding - exists in the map. - The input key. - The input map. - Thrown when the key does not exist in the map. - The value mapped to the given key. - - - The empty map. + The input array. + Thrown when the input array is null. + The index of the last element that satisfies the predicate, or None. - - Is the map empty? - The input map. - True if the map is empty. + + Tries to find the nth element in the array. + Returns None if index is negative or the input array does not contain enough elements. + The index of element to retrieve. + The input array. + The nth element of the array or None. + Thrown when the input array is null. - - Returns an array of all key-value pairs in the mapping. - The array will be ordered by the keys of the map. - The input map. - The array of key/value pairs. + + Returns the index of the first element in the array + that satisfies the given predicate. + The function to test the input elements. + The input array. + Thrown when the input array is null. + The index of the first element that satisfies the predicate, or None. - - Returns a list of all key-value pairs in the mapping. - The list will be ordered by the keys of the map. - The input map. - The list of key/value pairs. + + Returns the last element for which the given function returns True. + Return None if no such element exists. + The function to test the input elements. + The input array. + Thrown when the input array is null. + The last element that satisfies the predicate, or None. - - Views the collection as an enumerable sequence of pairs. - The sequence will be ordered by the keys of the map. - The input map. - The sequence of key/value pairs. + + Returns the first element for which the given function returns True. + Return None if no such element exists. + The function to test the input elements. + The input array. + The first element that satisfies the predicate, or None. + Thrown when the input array is null. - - Returns a new map made from the given bindings. - The input sequence of key/value pairs. - The resulting map. + + Returns at most N elements in a new array. + The maximum number of items to return. + The input array. + The result array. + Thrown when the input array is null. - - Returns a new map made from the given bindings. - The input array of key/value pairs. - The resulting map. + + Returns the transpose of the given sequence of arrays. + The input sequence of arrays. + The transposed array. + Thrown when the input sequence is null. + Thrown when the input arrays differ in length. - - Returns a new map made from the given bindings. - The input list of key/value pairs. - The resulting map. + + Views the given array as a sequence. + The input array. + The sequence of array elements. + Thrown when the input array is null. - - Returns a new map with the binding added to the given map. - The input key. - The input value. - The input map. - The resulting map. + + Builds a list from the given array. + The input array. + The list of array elements. + Thrown when the input array is null. - - Functional programming operators related to the Map<_,_> type. + + Returns a new array containing the elements of the original except the first element. + + The input array. + Thrown when the array is empty. + Thrown when the input array is null. + A new array containing the elements of the original except the first element. - - Combines the three sequences into a list of triples. The sequences need not have equal lengths: - when one sequence is exhausted any remaining elements in the other - sequences are ignored. + + Returns an array that contains all elements of the original array while the + given predicate returns True, and then returns no further elements. - The first input sequence. - The second input sequence. - The third input sequence. + A function that evaluates to false when no more items should be returned. + The input array. - The result sequence. + The result array. - Thrown when any of the input sequences is null. + Thrown when the input array is null. - - Combines the two sequences into a list of pairs. The two sequences need not have equal lengths: - when one sequence is exhausted any remaining elements in the other - sequence are ignored. + + Returns the first N elements of the array. + Throws InvalidOperationException + if the count exceeds the number of elements in the array. Array.truncate + returns as many items as the array contains instead of throwing an exception. - The first input sequence. - The second input sequence. + The number of items to take. + The input array. - The result sequence. + The result array. - Thrown when either of the input sequences is null. + Thrown when the input array is null. + Thrown when the input array is empty. + Thrown when count exceeds the number of elements + in the list. - - Returns a sequence that yields sliding windows containing elements drawn from the input - sequence. Each window is returned as a fresh array. - The number of elements in each window. - The input sequence. - The result sequence. - Thrown when the input sequence is null. - Thrown when windowSize is not positive. + + Returns the sum of the results generated by applying the function to each element of the array. + The function to transform the array elements into the type to be summed. + The input array. + The resulting sum. + Thrown when the input array is null. - - Returns a sequence that contains the elements generated by the given computation. - The given initial state argument is passed to the element generator. - For each IEnumerator elements in the stream are generated on-demand by applying the element - generator, until a None value is returned by the element generator. Each call to the element - generator returns a new residual state. - - The stream will be recomputed each time an IEnumerator is requested and iterated for the Seq. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - A function that takes in the current state and returns an option tuple of the next - element of the sequence and the next state value. - The initial state value. - - The result sequence. + + Returns the sum of the elements in the array. + The input array. + The resulting sum. + Thrown when the input array is null. - - Returns a sequence that when enumerated returns at most N elements. - - The maximum number of items to enumerate. - The input sequence. + + Sorts the elements of an array, in descending order, using the given projection for the keys and returning a new array. + Elements are compared using Operators.compare. - The result sequence. + This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. + For a stable sort, consider using Seq.sort. + The function to transform array elements into the type that is compared. + The input array. + The sorted array. + + + Sorts the elements of an array, in descending order, returning a new array. Elements are compared using Operators.compare. - Thrown when the input sequence is null. + This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. + For a stable sort, consider using Seq.sort. + The input array. + The sorted array. - - Applies the given function to successive elements, returning the first - result where the function returns "Some(x)". + + Splits an array into two arrays, at the given index. + The index at which the array is split. + The input array. + The two split arrays. - A function that transforms items from the input sequence into options. - The input sequence. - - The chosen element or None. - - Thrown when the input sequence is null. + Thrown when the input array is null. + Thrown when split index exceeds the number of elements + in the array. - - Returns the index of the last element in the sequence - that satisfies the given predicate. Return None if no such element exists. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - The found index or None. - Thrown when the input sequence is null. + + Sorts the elements of an array by mutating the array in-place, using the given comparison function. + Elements are compared using Operators.compare. + The input array. + Thrown when the input array is null. - - Tries to find the nth element in the sequence. - Returns None if index is negative or the input sequence does not contain enough elements. - The index of element to retrieve. - The input sequence. - The nth element of the sequence or None. - Thrown when the input sequence is null. + + Sorts the elements of an array by mutating the array in-place, using the given comparison function as the order. + The function to compare pairs of array elements. + The input array. + Thrown when the input array is null. - - Returns the index of the first element in the sequence - that satisfies the given predicate. Return None if no such element exists. - - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - - The found index or None. + + Sorts the elements of an array by mutating the array in-place, using the given projection for the keys. + Elements are compared using Operators.compare. - Thrown when the input sequence is null. - - - Returns the last element for which the given function returns true. - Return None if no such element exists. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - The found element or None. - Thrown when the input sequence is null. + This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. + For a stable sort, consider using Seq.sort. + The function to transform array elements into the type that is compared. + The input array. + Thrown when the input array is null. - - Returns the first element for which the given function returns true. - Return None if no such element exists. - - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. + + Sorts the elements of an array, using the given comparison function as the order, returning a new array. - The found element or None. + This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. + For a stable sort, consider using Seq.sort. + The function to compare pairs of array elements. + The input array. + The sorted array. + Thrown when the input array is null. + + + Sorts the elements of an array, using the given projection for the keys and returning a new array. + Elements are compared using Operators.compare. - Thrown when the input sequence is null. + This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. + For a stable sort, consider using Seq.sort. + The function to transform array elements into the type that is compared. + The input array. + The sorted array. + Thrown when the input array is null. - - Builds a list from the given collection. + + Sorts the elements of an array, returning a new array. Elements are compared using Operators.compare. - The input sequence. + This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. + For a stable sort, consider using Seq.sort. + The input array. + The sorted array. + Thrown when the input array is null. + + + Builds a new array that contains the given subrange specified by + starting index and length. + The input array. + The index of the first element of the sub array. + The length of the sub array. + The created sub array. + Thrown when the input array is null. + Thrown when either startIndex or count is negative, + or when there aren't enough elements in the input array. + + + Bypasses elements in an array while the given predicate returns True, and then returns + the remaining elements in a new array. + A function that evaluates an element of the array to a boolean value. + The input array. + The created sub array. + Thrown when the input array is null. + + + Builds a new array that contains the elements of the given array, excluding the first N elements. + The number of elements to skip. + The input array. + A copy of the input array, after removing the first N elements. + Thrown when the input array is null. + Thrown when count is negative or exceeds the number of + elements in the array. + + + Sets an element of an array. + The input array. + The input index. + The input value. + Thrown when the input array is null. + Thrown when the index is negative or the input array does not contain enough elements. + + + Returns an array that contains one item only. - The result list. + The input item. - Thrown when the input sequence is null. + The result array of one item. - - Builds an array from the given collection. + + Like foldBack, but return both the intermediary and final results. + The function to update the state given the input elements. + The input array. + The initial state. + The array of state values. + Thrown when the input array is null. + + + Like fold, but return the intermediary and final results. + The function to update the state given the input elements. + The initial state. + The input array. + The array of state values. + Thrown when the input array is null. + + + Returns a new array with the elements in reverse order. + The input array. + The reversed array. + Thrown when the input array is null. + + + Creates an array by replicating the given initial value. + The number of elements to replicate. + The value to replicate + The generated array. + Thrown when count is negative. + + + Applies a function to each element of the array, starting from the end, threading an accumulator argument + through the computation. If the input function is f and the elements are i0...iN + then computes f i0 (...(f iN-1 iN)). + A function that takes in the next-to-last element of the list and the + current accumulated result to produce the next accumulated result. + The input array. + Thrown when the input array is null. + Thrown when the input array is empty. + The final result of the reductions. + + + Applies a function to each element of the array, threading an accumulator argument + through the computation. If the input function is f and the elements are i0...iN + then computes f (... (f i0 i1)...) iN. + Raises ArgumentException if the array has size zero. + The function to reduce a pair of elements to a single element. + The input array. + Thrown when the input array is null. + Thrown when the input array is empty. + The final result of the reductions. + + + Returns an array with all elements permuted according to the + specified permutation. + The function that maps input indices to output indices. + The input array. + The output array. + Thrown when the input array is null. + Thrown when indexMap does not produce a valid permutation. + + + Splits the collection into two collections, containing the + elements for which the given predicate returns "true" and "false" + respectively. + The function to test the input elements. + The input array. + A pair of arrays. The first containing the elements the predicate evaluated to true, + and the second containing those evaluated to false. + Thrown when the input array is null. + + + Returns an array of each element in the input array and its predecessor, with the + exception of the first element which is only returned as the predecessor of the second element. - The input sequence. + The input array. The result array. Thrown when the input sequence is null. - - Returns a sequence that, when iterated, yields elements of the underlying sequence while the - given predicate returns true, and then returns no further elements. - - A function that evaluates to false when no more items should be returned. + + Builds a new array from the given enumerable object. The input sequence. - - The result sequence. - + The array of elements from the sequence. Thrown when the input sequence is null. - - Returns the first N elements of the sequence. - Throws InvalidOperationException - if the count exceeds the number of elements in the sequence. Seq.truncate - returns as many items as the sequence contains instead of throwing an exception. - - The number of items to take. - The input sequence. - - The result sequence. + + Builds an array from the given list. + The input list. + The array of elements from the list. + + + Returns the lowest of all elements of the array, compared via Operators.min on the function result. - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - Thrown when count exceeds the number of elements - in the sequence. + Throws ArgumentException for empty arrays. + The function to transform the elements into a type supporting comparison. + The input array. + Thrown when the input array is null. + Thrown when the input array is empty. + The minimum element. - - Returns a sequence that skips 1 element of the underlying sequence and then yields the - remaining elements of the sequence. + + Returns the lowest of all elements of the array, compared via Operators.min. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. + Throws ArgumentException for empty arrays + The input array. + Thrown when the input array is null. + Thrown when the input array is empty. + The minimum element. - - Returns the sum of the results generated by applying the function to each element of the sequence. - The generated elements are summed using the + operator and Zero property associated with the generated type. - - A function to transform items from the input sequence into the type that will be summed. - The input sequence. + + Returns the greatest of all elements of the array, compared via Operators.max on the function result. - The computed sum. + Throws ArgumentException for empty arrays. + The function to transform the elements into a type supporting comparison. + The input array. + Thrown when the input array is null. + Thrown when the input array is empty. + The maximum element. - - Returns the sum of the elements in the sequence. - - The elements are summed using the + operator and Zero property associated with the generated type. - - The input sequence. + + Returns the greatest of all elements of the array, compared via Operators.max on the function result. - The computed sum. + Throws ArgumentException for empty arrays. + The input array. + Thrown when the input array is null. + Thrown when the input array is empty. + The maximum element. - - Applies a key-generating function to each element of a sequence and yield a sequence ordered - descending by keys. The keys are compared using generic comparison as implemented by Operators.compare. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - A function to transform items of the input sequence into comparable keys. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. + + Builds a new array whose elements are the results of applying the given function + to each of the elements of the array. The integer index passed to the + function indicates the index of element being transformed. + The function to transform elements and their indices. + The input array. + The array of transformed elements. + Thrown when the input array is null. - - Yields a sequence ordered descending by keys. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. + + Builds a new collection whose elements are the results of applying the given function + to the corresponding elements of the two collections pairwise, also passing the index of + the elements. The two input arrays must have the same lengths, otherwise an ArgumentException is + raised. + The function to transform pairs of input elements and their indices. + The first input array. + The second input array. + Thrown when either of the input arrays is null. + Thrown when the input arrays differ in length. + The array of transformed elements. - - Applies a key-generating function to each element of a sequence and yield a sequence ordered - by keys. The keys are compared using generic comparison as implemented by Operators.compare. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - A function to transform items of the input sequence into comparable keys. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. + + Builds a new collection whose elements are the results of applying the given function + to the corresponding triples from the three collections. The three input + arrays must have the same length, otherwise an ArgumentException is + raised. + The function to transform the pairs of the input elements. + The first input array. + The second input array. + The third input array. + Thrown when the input arrays differ in length. + Thrown when any of the input arrays is null. + The array of transformed elements. - - Yields a sequence ordered using the given comparison function. - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - The function to compare the collection elements. - The input sequence. - The result sequence. + + Combines map and foldBack. Builds a new array whose elements are the results of applying the given function + to each of the elements of the input array. The function is also used to accumulate a final value. + The function to transform elements from the input array and accumulate the final value. + The input array. + The initial state. + Thrown when the input array is null. + The array of transformed elements, and the final accumulated value. - - Yields a sequence ordered by keys. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. + + Combines map and fold. Builds a new array whose elements are the results of applying the given function + to each of the elements of the input array. The function is also used to accumulate a final value. + The function to transform elements from the input array and accumulate the final value. + The initial state. + The input array. + Thrown when the input array is null. + The array of transformed elements, and the final accumulated value. - - Returns a sequence that, when iterated, skips elements of the underlying sequence while the - given predicate returns true, and then yields the remaining elements of the sequence. - - A function that evaluates an element of the sequence to a boolean value. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. + + Builds a new collection whose elements are the results of applying the given function + to the corresponding elements of the two collections pairwise. The two input + arrays must have the same lengths, otherwise an ArgumentException is + raised. + The function to transform the pairs of the input elements. + The first input array. + The second input array. + Thrown when the input arrays differ in length. + Thrown when either of the input arrays is null. + The array of transformed elements. - - Returns a sequence that skips N elements of the underlying sequence and then yields the - remaining elements of the sequence. - - The number of items to skip. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when count exceeds the number of elements - in the sequence. + + Builds a new array whose elements are the results of applying the given function + to each of the elements of the array. + The function to transform elements of the array. + The input array. + The array of transformed elements. + Thrown when the input array is null. - - Returns a sequence that yields one item only. - - The input item. - - The result sequence of one item. + + Returns the last element of the array. + Return None if no such element exists. + The input array. + The last element of the array or None. + Thrown when the input sequence is null. - - Like foldBack, but returns the sequence of intermediary and final results. - This function returns a sequence that digests the whole initial sequence as soon as that - sequence is iterated. As a result this function should not be used with large or infinite sequences. - - A function that updates the state with each element from the sequence. - The input sequence. - The initial state. - The resulting sequence of computed states. - Thrown when the input sequence is null. + + Returns the length of an array. You can also use property arr.Length. + The input array. + The length of the array. + Thrown when the input array is null. - - Like fold, but computes on-demand and returns the sequence of intermediary and final results. - - A function that updates the state with each element from the sequence. - The initial state. - The input sequence. - - The resulting sequence of computed states. - - Thrown when the input sequence is null. + + Gets an element from an array. + The input index. + The input array. + The value of the array at the given index. + Thrown when the input array is null. + Thrown when the index is negative or the input array does not contain enough elements. - - Returns a new sequence with the elements in reverse order. - The input sequence. - The reversed sequence. - Thrown when the input sequence is null. + + Returns the last element of the array. + The input array. + The last element of the array. + Thrown when the input array is null. + Thrown when the input does not have any elements. - - Applies a function to each element of the sequence, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f i0 (...(f iN-1 iN)). - A function that takes in the next-to-last element of the sequence and the - current accumulated result to produce the next accumulated result. - The input sequence. - The final result of the reductions. - Thrown when the input sequence is null. - Thrown when the input sequence is empty. + + Applies the given function to pair of elements drawn from matching indices in two arrays, + also passing the index of the elements. The two arrays must have the same lengths, + otherwise an ArgumentException is raised. + The function to apply to each index and pair of elements. + The first input array. + The second input array. + Thrown when either of the input arrays is null. + Thrown when the input arrays differ in length. - - Creates a sequence by replicating the given initial value. - The number of elements to replicate. - The value to replicate - The generated sequence. + + Applies the given function to each element of the array. The integer passed to the + function indicates the index of element. + The function to apply to each index and element. + The input array. + Thrown when the input array is null. - - Applies a function to each element of the sequence, threading an accumulator argument - through the computation. Begin by applying the function to the first two elements. - Then feed this result into the function along with the third element and so on. - Return the final result. - - A function that takes in the current accumulated result and the next - element of the sequence to produce the next accumulated result. - The input sequence. - - The final result of the reduction function. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. + + Applies the given function to pair of elements drawn from matching indices in two arrays. The + two arrays must have the same lengths, otherwise an ArgumentException is + raised. + The function to apply. + The first input array. + The second input array. + Thrown when either of the input arrays is null. + Thrown when the input arrays differ in length. - - Builds a new sequence object that delegates to the given sequence object. This ensures - the original sequence cannot be rediscovered and mutated by a type cast. For example, - if given an array the returned sequence will return the elements of the array, but - you cannot cast the returned sequence object to an array. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. + + Applies the given function to each element of the array. + The function to apply. + The input array. + Thrown when the input array is null. - - Applies the given function to successive elements, returning the first - x where the function returns "Some(x)". - - A function to transform each item of the input sequence into an option of the output type. - The input sequence. - - The selected element. - - Thrown when the input sequence is null. - Thrown when every item of the sequence - evaluates to None when the given function is applied. + + Returns true if the given array is empty, otherwise false. + The input array. + True if the array is empty. + Thrown when the input array is null. - - Returns a sequence with all elements permuted according to the - specified permutation. - - Note that this function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. - - The function that maps input indices to output indices. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when indexMap does not produce a valid permutation. + + Creates an array where the entries are initially the default value Unchecked.defaultof<'T>. + The length of the array to create. + The created array. + Thrown when count is negative. - - Returns a sequence of each element in the input sequence and its predecessor, with the - exception of the first element which is only returned as the predecessor of the second element. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. + + Creates an array given the dimension and a generator function to compute the elements. + The number of elements to initialize. + The function to generate the initial values for each index. + The created array. + Thrown when count is negative. - - Views the given list as a sequence. - - The input list. - - The result sequence. + + Builds a new array whose elements are the corresponding elements of the input array + paired with the integer index (from 0) of each element. + The input array. + The array of indexed elements. + Thrown when the input array is null. - - Views the given array as a sequence. + + Applies a key-generating function to each element of an array and yields an array of + unique keys. Each unique key contains an array of all elements that match + to this key. - The input array. + A function that transforms an element of the array into a comparable key. + The input array. - The result sequence. + The result array. - Thrown when the input sequence is null. + Thrown when the input array is null. - - Computes the nth element in the collection. + + Returns the first element of the array. - The index of element to retrieve. - The input sequence. + The input array. - The nth element of the sequence. + The first element of the array. - Thrown when the input sequence is null. - Thrown when the index is negative or the input sequence does not contain enough elements. + Thrown when the input array is null. + Thrown when the input array is empty. - - Returns the lowest of all elements of the sequence, compared via Operators.min on the function result. - - A function to transform items from the input sequence into comparable keys. - The input sequence. - - The smallest element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. + + Gets an element from an array. + The input array. + The input index. + The value of the array at the given index. + Thrown when the input array is null. + Thrown when the index is negative or the input array does not contain enough elements. - - Returns the lowest of all elements of the sequence, compared via Operators.min. - - The input sequence. - - The smallest element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. + + Apply a function to pairs of elements drawn from the two collections, right-to-left, + threading an accumulator argument through the computation. The two input + arrays must have the same lengths, otherwise an ArgumentException is + raised. + The function to update the state given the input elements. + The first input array. + The second input array. + The initial state. + Thrown when either of the input arrays is null. + Thrown when the input arrays differ in length. + The final state. - - Returns the greatest of all elements of the sequence, compared via Operators.max on the function result. - - A function to transform items from the input sequence into comparable keys. - The input sequence. - - The largest element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. + + Applies a function to pairs of elements drawn from the two collections, + left-to-right, threading an accumulator argument + through the computation. The two input + arrays must have the same lengths, otherwise an ArgumentException is + raised. + The function to update the state given the input elements. + The initial state. + The first input array. + The second input array. + Thrown when either of the input arrays is null. + Thrown when the input arrays differ in length. + The final state. - - Returns the greatest of all elements of the sequence, compared via Operators.max - - The input sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - The largest element of the sequence. + + Applies a function to each element of the array, starting from the end, threading an accumulator argument + through the computation. If the input function is f and the elements are i0...iN then computes + f i0 (...(f iN s)) + The function to update the state given the input elements. + The input array. + The initial state. + The state object after the folding function is applied to each element of the array. + Thrown when the input array is null. - - Builds a new collection whose elements are the results of applying the given function - to the corresponding pairs of elements from the two sequences. If one input sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. The integer index passed to the - function indicates the index (from 0) of element being transformed. + + Applies a function to each element of the collection, threading an accumulator argument + through the computation. If the input function is f and the elements are i0...iN then computes + f (... (f s i0)...) iN + The function to update the state given the input elements. + The initial state. + The input array. + The final state. + Thrown when the input array is null. + + + Tests if all corresponding elements of the array satisfy the given predicate pairwise. - A function to transform pairs of items from the input sequences that also supplies the current index. - The first input sequence. - The second input sequence. - - The result sequence. - - Thrown when either of the input sequences is null. + The predicate is applied to matching elements in the two collections up to the lesser of the + two lengths of the collections. If any application returns false then the overall result is + false and no further elements are tested. Otherwise, if one collection is longer + than the other then the ArgumentException exception is raised. + Otherwise, true is returned. + The function to test the input elements. + The first input array. + The second input array. + Thrown when either of the input arrays is null. + Thrown when the input arrays differ in length. + True if all of the array elements satisfy the predicate. - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The integer index passed to the - function indicates the index (from 0) of element being transformed. - - A function to transform items from the input sequence that also supplies the current index. - The input sequence. - - The result sequence. + + Tests if all elements of the array satisfy the given predicate. - Thrown when the input sequence is null. + The predicate is applied to the elements of the input collection. If any application + returns false then the overall result is false and no further elements are tested. + Otherwise, true is returned. + The function to test the input elements. + The input array. + True if all of the array elements satisfy the predicate. + Thrown when the input array is null. - - Builds a new collection whose elements are the results of applying the given function - to the corresponding triples of elements from the three sequences. If one input sequence if shorter than - the others then the remaining elements of the longer sequences are ignored. - - The function to transform triples of elements from the input sequences. - The first input sequence. - The second input sequence. - The third input sequence. - - The result sequence. - - Thrown when any of the input sequences is null. + + Returns the index of the last element in the array + that satisfies the given predicate. Raise KeyNotFoundException if + none of the elements satisfy the predicate. + The function to test the input elements. + The input array. + Thrown if predicate + never returns true. + Thrown when the input array is null. + The index of the last element in the array that satisfies the given predicate. - - Combines map and foldBack. Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The function is also used to accumulate a final value. - This function digests the whole initial sequence as soon as it is called. As a result this function should - not be used with large or infinite sequences. - The function to transform elements from the input collection and accumulate the final value. - The input collection. - The initial state. - Thrown when the input collection is null. - The collection of transformed elements, and the final accumulated value. + + Returns the index of the first element in the array + that satisfies the given predicate. Raise KeyNotFoundException if + none of the elements satisfy the predicate. + The function to test the input elements. + The input array. + Thrown if predicate + never returns true. + Thrown when the input array is null. + The index of the first element in the array that satisfies the given predicate. - - Combines map and fold. Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The function is also used to accumulate a final value. - This function digests the whole initial sequence as soon as it is called. As a result this function should - not be used with large or infinite sequences. - The function to transform elements from the input collection and accumulate the final value. - The initial state. - The input collection. - Thrown when the input collection is null. - The collection of transformed elements, and the final accumulated value. + + Returns the last element for which the given function returns 'true'. + Raise KeyNotFoundException if no such element exists. + The function to test the input elements. + The input array. + Thrown if predicate + never returns true. + Thrown when the input array is null. + The last element for which predicate returns true. - - Builds a new collection whose elements are the results of applying the given function - to the corresponding pairs of elements from the two sequences. If one input sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to transform pairs of items from the input sequences. - The first input sequence. - The second input sequence. - - The result sequence. + + Returns the first element for which the given function returns 'true'. + Raise KeyNotFoundException if no such element exists. + The function to test the input elements. + The input array. + Thrown when the input array is null. + Thrown if predicate + never returns true. + The first element for which predicate returns true. + + + Returns a new collection containing only the elements of the collection + for which the given predicate returns "true". + The function to test the input elements. + The input array. + An array containing the elements for which the given predicate returns true. + Thrown when the input array is null. + + + Tests if any pair of corresponding elements of the arrays satisfies the given predicate. - Thrown when either of the input sequences is null. + The predicate is applied to matching elements in the two collections up to the lesser of the + two lengths of the collections. If any application returns true then the overall result is + true and no further elements are tested. Otherwise, if one collections is longer + than the other then the ArgumentException exception is raised. + Otherwise, false is returned. + The function to test the input elements. + The first input array. + The second input array. + True if any result from predicate is true. + Thrown when either of the input arrays is null. + Thrown when the input arrays differ in length. - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The given function will be applied - as elements are demanded using the MoveNext method on enumerators retrieved from the - object. + + Tests if any element of the array satisfies the given predicate. - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. + The predicate is applied to the elements of the input array. If any application + returns true then the overall result is true and no further elements are tested. + Otherwise, false is returned. + The function to test the input elements. + The input array. + True if any result from predicate is true. + Thrown when the input array is null. + + + Returns a new list with the distinct elements of the input array which do not appear in the itemsToExclude sequence, + using generic hash and equality comparisons to compare values. - A function to transform items from the input sequence. - The input sequence. + A sequence whose elements that also occur in the input array will cause those elements to be + removed from the result. + An array whose elements that are not also in itemsToExclude will be returned. - The result sequence. + An array that contains the distinct elements of array that do not appear in itemsToExclude. - Thrown when the input sequence is null. + Thrown when either itemsToExclude or array is null. - - Returns the length of the sequence + + Returns the only element of the array or None if array is empty or contains more than one element. - The input sequence. + The input array. - The length of the sequence. + The only element of the array or None. - Thrown when the input sequence is null. + Thrown when the input array is null. - - Applies the given function to two collections simultaneously. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. The integer passed to the - function indicates the index of element. - - A function to apply to each pair of elements from the input sequences along with their index. - The first input sequence. - The second input sequence. + + Returns the only element of the array. - Thrown when either of the input sequences is null. - - - Applies the given function to two collections simultaneously. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. + The input array. - A function to apply to each pair of elements from the input sequences. - The first input sequence. - The second input sequence. + The only element of the array. - Thrown when either of the input sequences is null. + Thrown when the input array is null. + Thrown when the input does not have precisely one element. - - Applies the given function to each element of the collection. The integer passed to the - function indicates the index of element. - - A function to apply to each element of the sequence that can also access the current index. - The input sequence. - - Thrown when the input sequence is null. + + Returns an empty array of the given type. + The empty array. - - Applies the given function to each element of the collection. + + Splits the input array into at most count chunks. + The maximum number of chunks. + The input array. + The array split into chunks. + Thrown when the input array is null. + Thrown when count is not positive. + + + Returns an array that contains no duplicate entries according to the + generic hash and equality comparisons on the keys returned by the given key-generating function. + If an element occurs multiple times in the array then the later occurrences are discarded. - A function to apply to each element of the sequence. - The input sequence. + A function transforming the array items into comparable keys. + The input array. - Thrown when the input sequence is null. - - - Computes the element at the specified index in the collection. - The index of the element to retrieve. - The input sequence. - The element at the specified index of the sequence. - Thrown when the input sequence is null. - Thrown when the index is negative or the input sequence does not contain enough elements. + The result array. + + Thrown when the input array is null. - - Generates a new sequence which, when iterated, will return successive - elements by calling the given function. The results of calling the function - will not be saved, that is the function will be reapplied as necessary to - regenerate the elements. The function is passed the index of the item being - generated. + + Returns an array that contains no duplicate entries according to generic hash and + equality comparisons on the entries. + If an element occurs multiple times in the array then the later occurrences are discarded. - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - Iteration can continue up to Int32.MaxValue. + The input array. - A function that generates an item in the sequence from a given index. + The result array. - The result sequence. + Thrown when the input array is null. - - Generates a new sequence which, when iterated, will return successive - elements by calling the given function, up to the given count. Each element is saved after its - initialization. The function is passed the index of the item being - generated. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - The maximum number of items to generate for the sequence. - A function that generates an item in the sequence from a given index. - - The result sequence. - - Thrown when count is negative. + + Divides the input array into chunks of size at most chunkSize. + The maximum size of each chunk. + The input array. + The array divided into chunks. + Thrown when the input array is null. + Thrown when chunkSize is not positive. - - Builds a new collection whose elements are the corresponding elements of the input collection - paired with the integer index (from 0) of each element. - The input sequence. - The result sequence. - Thrown when the input sequence is null. + + Applies the given function to each element of the array. Returns + the array comprised of the results "x" for each element where + the function returns Some(x) + The function to generate options from the elements. + The input array. + The array of results. + Thrown when the input array is null. - - Returns true if the sequence contains no elements, false otherwise. - - The input sequence. - - True if the sequence is empty; false otherwise. - - Thrown when the input sequence is null. + + Applies the given function to successive elements, returning the first + result where function returns Some(x) for some x. If the function + never returns Some(x) then KeyNotFoundException is raised. + The function to generate options from the elements. + The input array. + Thrown when the input array is null. + Thrown if every result from + chooser is None. + The first result. - - Returns the only element of the sequence. - - The input sequence. - - The only element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input does not have precisely one element. + + Fills a range of elements of the array with the given value. + The target array. + The index of the first element to set. + The number of elements to set. + The value to set. + Thrown when the input array is null. + Thrown when either targetIndex or count is negative. - - Returns the last element of the sequence. - Return None if no such element exists. - - The input sequence. - - The last element of the sequence or None. - - Thrown when the input sequence is null. + + Applies the given function to successive elements, returning the first + result where function returns Some(x) for some x. If the function + never returns Some(x) then None is returned. + The function to transform the array elements into options. + The input array. + The first transformed element that is Some(x). + Thrown when the input array is null. - - Returns the last element of the sequence. - The input sequence. - The last element of the sequence. - Thrown when the input sequence is null. - Thrown when the input does not have any elements. + + Returns the first element of the array, or + None if the array is empty. + The input array. + Thrown when the input array is null. + The first element of the array or None. - - Returns the first element of the sequence, or None if the sequence is empty. + + Creates an array whose elements are all initially the given value. + The length of the array to create. + The value for the elements. + The created array. + Thrown when count is negative. + + + Applies a key-generating function to each element of an array and returns an array yielding unique + keys and their number of occurrences in the original array. - The input sequence. + A function transforming each item of the input array into a key to be + compared against the others. + The input array. - The first element of the sequence or None. + The result array. + Thrown when the input array is null. + + + Builds a new array that contains the elements of the given array. + The input array. + A copy of the input array. + Thrown when the input array is null. + + + Tests if the array contains the specified element. + The value to locate in the input array. + The input array. + True if the input array contains the specified element; false otherwise. + Thrown when the input array is null. + + + Builds a new array that contains the elements of each of the given sequence of arrays. + The input sequence of arrays. + The concatenation of the sequence of input arrays. Thrown when the input sequence is null. - - Returns the first element of the sequence. + + Compares two arrays using the given comparison function, element by element. - The input sequence. + A function that takes an element from each array and returns an int. + If it evaluates to a non-zero value iteration is stopped and that value is returned. + The first input array. + The second input array. - The first element of the sequence. + Returns the first non-zero result from the comparison function. If the first array has + a larger element, the return value is always positive. If the second array has a larger + element, the return value is always negative. When the elements are equal in the two + arrays, 1 is returned if the first array is longer, 0 is returned if they are equal in + length, and -1 is returned when the second array is longer. - Thrown when the input sequence is null. - Thrown when the input does not have any elements. + Thrown when either of the input arrays + is null. - - Applies a key-generating function to each element of a sequence and yields a sequence of - unique keys. Each unique key contains a sequence of all elements that match - to this key. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - A function that transforms an element of the sequence into a comparable key. - The input sequence. + + For each element of the array, applies the given function. Concatenates all the results and return the combined array. + The function to create sub-arrays from the input array elements. + The input array. + The concatenation of the sub-arrays. + Thrown when the input array is null. + + + Reads a range of elements from the first array and write them into the second. + The source array. + The starting index of the source array. + The target array. + The starting index of the target array. + The number of elements to copy. + Thrown when either of the input arrays is null. + Thrown when any of sourceIndex, targetIndex or count are negative, + or when there aren't enough elements in source or target. + + + Returns the average of the elements generated by applying the function to each element of the array. + The function to transform the array elements before averaging. + The input array. + Thrown when array is empty. + The computed average. + Thrown when the input array is null. + + + Returns the average of the elements in the array. + The input array. + Thrown when array is empty. + The average of the elements in the array. + Thrown when the input array is null. + + + Builds a new array that contains the elements of the first array followed by the elements of the second array. + The first input array. + The second input array. + The resulting array. + Thrown when either of the input arrays is null. + + + Returns a new array that contains all pairings of elements from the first and second arrays. + The first input array. + The second input array. + Thrown when either of the input arrays is null. + The resulting array of pairs. + + + Split the collection into two collections, containing the + elements for which the given predicate returns "true" and "false" + respectively - The result sequence. + Performs the operation in parallel using System.Threading.Parallel.For. + The order in which the given function is applied to indices is not specified. + The function to test the input elements. + The input array. + 'T[] * 'T[] + Thrown when the input array is null. - - Tests the all pairs of elements drawn from the two sequences satisfy the - given predicate. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. + + Create an array given the dimension and a generator function to compute the elements. - A function to test pairs of elements from the input sequences. - The first input sequence. - The second input sequence. + Performs the operation in parallel using System.Threading.Parallel.For. + The order in which the given function is applied to indices is not specified. + + + 'T[] + + + Apply the given function to each element of the array. The integer passed to the + function indicates the index of element. - True if all pairs satisfy the predicate; false otherwise. + Performs the operation in parallel using System.Threading.Parallel.For. + The order in which the given function is applied to elements of the input array is not specified. + + The input array. + Thrown when the input array is null. + + + Apply the given function to each element of the array. - Thrown when either of the input sequences is null. + Performs the operation in parallel using System.Threading.Parallel.For. + The order in which the given function is applied to elements of the input array is not specified. + + The input array. + Thrown when the input array is null. - - Tests if all elements of the sequence satisfy the given predicate. + + Build a new array whose elements are the results of applying the given function + to each of the elements of the array. The integer index passed to the + function indicates the index of element being transformed. - The predicate is applied to the elements of the input sequence. If any application - returns false then the overall result is false and no further elements are tested. - Otherwise, true is returned. + Performs the operation in parallel using System.Threading.Parallel.For. + The order in which the given function is applied to elements of the input array is not specified. + + The input array. + 'U[] + Thrown when the input array is null. + + + Build a new array whose elements are the results of applying the given function + to each of the elements of the array. - A function to test an element of the input sequence. - The input sequence. + Performs the operation in parallel using System.Threading.Parallel.For. + The order in which the given function is applied to elements of the input array is not specified. + + The input array. + 'U[] + Thrown when the input array is null. + + + For each element of the array, apply the given function. Concatenate all the results and return the combined array. - True if every element of the sequence satisfies the predicate; false otherwise. + Performs the operation in parallel using System.Threading.Parallel.For. + The order in which the given function is applied to elements of the input array is not specified. + + The input array. + 'U[] + Thrown when the input array is null. + + + Apply the given function to each element of the array. Return + the array comprised of the results "x" for each element where + the function returns Some(x). - Thrown when the input sequence is null. + Performs the operation in parallel using System.Threading.Parallel.For. + The order in which the given function is applied to elements of the input array is not specified. + The function to generate options from the elements. + The input array. + 'U[] + Thrown when the input array is null. - - Applies a function to corresponding elements of two collections, starting from the end of the shorter collection, - threading an accumulator argument through the computation. The two sequences need not have equal lengths. - If the input function is f and the elements are i0...iN and j0...jM, N < M - then computes f i0 j0 (... (f iN jN s)...). - The function to update the state given the input elements. - The first input sequence. - The second input sequence. - The initial state. - The final state value. - Thrown when the either of the input sequences is null. + + Provides parallel operations on arrays - - Applies a function to each element of the collection, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f i0 (... (f iN s)...) - The function to update the state given the input elements. - The input sequence. - The initial state. - The state object after the folding function is applied to each element of the sequence. - Thrown when the input sequence is null. + + Basic operations on arrays. - - Applies a function to corresponding elements of two collections, threading an accumulator argument - through the computation. The two sequences need not have equal lengths: - when one sequence is exhausted any remaining elements in the other sequence are ignored. - If the input function is f and the elements are i0...iN and j0...jN - then computes f (... (f s i0 j0)...) iN jN. - The function to update the state given the input elements. - The initial state. - The first input sequence. - The second input sequence. - The final state value. - Thrown when the either of the input sequences is null. + + Sets the value of an element in an array. You can also + use the syntax 'array.[index1,index2,index3,index4] <- value'. + The input array. + The index along the first dimension. + The index along the second dimension. + The index along the third dimension. + The index along the fourth dimension. + The value to set. - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f (... (f s i0)...) iN - - A function that updates the state with each element from the sequence. - The initial state. - The input sequence. - - The state object after the folding function is applied to each element of the sequence. - - Thrown when the input sequence is null. + + Fetches an element from a 4D array. You can also use the syntax 'array.[index1,index2,index3,index4]' + The input array. + The index along the first dimension. + The index along the second dimension. + The index along the third dimension. + The index along the fourth dimension. + The value at the given index. - - Returns the index of the last element for which the given function returns true. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function to test whether the index of a particular element should be returned. - The input sequence. - The index of the last element for which the predicate returns true. - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null + + Creates an array where the entries are initially the "default" value. + The length of the first dimension. + The length of the second dimension. + The length of the third dimension. + The length of the fourth dimension. + The created array. - - Returns the index of the first element for which the given function returns true. - - A function to test whether the index of a particular element should be returned. - The input sequence. - - The index of the first element for which the predicate returns true. - - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null + + Returns the length of an array in the fourth dimension. + The input array. + The length of the array in the fourth dimension. - - Returns the last element for which the given function returns true. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function to test whether an item in the sequence should be returned. - The input sequence. - The last element for which the predicate returns true. - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null + + Returns the length of an array in the third dimension. + The input array. + The length of the array in the third dimension. - - Returns the first element for which the given function returns true. - - A function to test whether an item in the sequence should be returned. - The input sequence. - - The first element for which the predicate returns true. - - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null + + Returns the length of an array in the second dimension. + The input array. + The length of the array in the second dimension. - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true". - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - Remember sequence is lazy, effects are delayed until it is enumerated. - - A synonym for Seq.filter. - - A function to test whether each item in the input sequence should be included in the output. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. + + Returns the length of an array in the first dimension + The input array. + The length of the array in the first dimension. - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true". This is a synonym for Seq.where. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - Remember sequence is lazy, effects are delayed until it is enumerated. - - A function to test whether each item in the input sequence should be included in the output. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. + + Creates an array given the dimensions and a generator function to compute the elements. + The length of the first dimension. + The length of the second dimension. + The length of the third dimension. + The length of the fourth dimension. + The function to create an initial value at each index in the array. + The created array. - - Tests if any pair of corresponding elements of the input sequences satisfies the given predicate. - - The predicate is applied to matching elements in the two sequences up to the lesser of the - two lengths of the collections. If any application returns true then the overall result is - true and no further elements are tested. Otherwise, false is returned. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to test each pair of items from the input sequences. - The first input sequence. - The second input sequence. - - True if any result from the predicate is true; false otherwise. - - Thrown when either of the two input sequences is null. + + Creates an array whose elements are all initially the given value + The length of the first dimension. + The length of the second dimension. + The length of the third dimension. + The length of the fourth dimension. + The initial value for each element of the array. + The created array. - - Tests if any element of the sequence satisfies the given predicate. - - The predicate is applied to the elements of the input sequence. If any application - returns true then the overall result is true and no further elements are tested. - Otherwise, false is returned. - - A function to test each item of the input sequence. - The input sequence. - - True if any result from the predicate is true; false otherwise. - - Thrown when the input sequence is null. + + Basic operations on rank 4 arrays. - - Returns a new sequence with the distinct elements of the second sequence which do not apear in the first sequence, - using generic hash and equality comparisons to compare values. + + Creates an array where the entries are initially the "default" value. + The length of the first dimension. + The length of the second dimension. + The length of the third dimension. + The created array. + + + Sets the value of an element in an array. You can also + use the syntax 'array.[index1,index2,index3] <- value'. + The input array. + The index along the first dimension. + The index along the second dimension. + The index along the third dimension. + The value to set at the given index. + + + Builds a new array whose elements are the results of applying the given function + to each of the elements of the array. The integer indices passed to the + function indicates the element being transformed. - Note that this function returns a sequence that digests the whole of the first input sequence as soon as - the result sequence is iterated. As a result this function should not be used with - large or infinite sequences in the first parameter. The function makes no assumption on the ordering of the first input - sequence. - - A sequence whose elements that also occur in the second sequence will cause those elements to be - removed from the returned sequence. - A sequence whose elements that are not also in first will be returned. - - A sequence that contains the set difference of the elements of two sequences. - - Thrown when either of the two input sequences is null. + For non-zero-based arrays the basing on an input array will be propagated to the output + array. + The function to transform the elements at each index in the array. + The input array. + The array created from the transformed elements. - - Creates an empty sequence. + + Builds a new array whose elements are the results of applying the given function + to each of the elements of the array. - An empty sequence. + For non-zero-based arrays the basing on an input array will be propagated to the output + array. + The function to transform each element of the array. + The input array. + The array created from the transformed elements. - - Splits the input sequence into at most count chunks. - This function returns a sequence that digests the whole initial sequence as soon as that - sequence is iterated. As a result this function should not be used with large or infinite sequences. - The maximum number of chunks. - The input sequence. - The sequence split into chunks. - Thrown when the input sequence is null. - Thrown when count is not positive. + + Returns the length of an array in the third dimension. + The input array. + The length of the array in the third dimension. - - Returns a sequence that contains no duplicate entries according to the - generic hash and equality comparisons on the keys returned by the given key-generating function. - If an element occurs multiple times in the sequence then the later occurrences are discarded. - - A function transforming the sequence items into comparable keys. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. + + Returns the length of an array in the second dimension. + The input array. + The length of the array in the second dimension. - - Returns a sequence that contains no duplicate entries according to generic hash and - equality comparisons on the entries. - If an element occurs multiple times in the sequence then the later occurrences are discarded. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. + + Returns the length of an array in the first dimension + The input array. + The length of the array in the first dimension. - - Returns a sequence that is built from the given delayed specification of a - sequence. - - The input function is evaluated each time an IEnumerator for the sequence - is requested. - - The generating function for the sequence. + + Applies the given function to each element of the array. The integer indices passed to the + function indicates the index of element. + The function to apply to each element of the array. + The input array. - - Applies a key-generating function to each element of a sequence and returns a sequence yielding unique - keys and their number of occurrences in the original sequence. - - Note that this function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - A function transforming each item of the input sequence into a key to be - compared against the others. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. + + Applies the given function to each element of the array. + The function to apply to each element of the array. + The input array. - - Tests if the sequence contains the specified element. - The value to locate in the input sequence. - The input sequence. - True if the input sequence contains the specified element; false otherwise. - Thrown when the input sequence is null. + + Fetches an element from a 3D array. You can also use the syntax 'array.[index1,index2,index3]' + The input array. + The index along the first dimension. + The index along the second dimension. + The index along the third dimension. + The value at the given index. - - Combines the given enumeration-of-enumerations as a single concatenated - enumeration. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - The input enumeration-of-enumerations. - - The result sequence. - - Thrown when the input sequence is null. + + Creates an array given the dimensions and a generator function to compute the elements. + The length of the first dimension. + The length of the second dimension. + The length of the third dimension. + The function to create an initial value at each index into the array. + The created array. - - Compares two sequences using the given comparison function, element by element. - Returns the first non-zero result from the comparison function. If the end of a sequence - is reached it returns a -1 if the first sequence is shorter and a 1 if the second sequence - is shorter. - - A function that takes an element from each sequence and returns an int. - If it evaluates to a non-zero value iteration is stopped and that value is returned. - The first input sequence. - The second input sequence. - - The first non-zero value from the comparison function. - - Thrown when either of the input sequences - is null. + + Creates an array whose elements are all initially the given value. + The length of the first dimension. + The length of the second dimension. + The length of the third dimension. + The value of the array elements. + The created array. - - Applies the given function to each element of the sequence and concatenates all the - results. - - Remember sequence is lazy, effects are delayed until it is enumerated. - - A function to transform elements of the input sequence into the sequences - that will then be concatenated. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. + + Basic operations on rank 3 arrays. - - Divides the input sequence into chunks of size at most chunkSize. - The maximum size of each chunk. - The input sequence. - The sequence divided into chunks. - Thrown when the input sequence is null. - Thrown when chunkSize is not positive. + + The number of bindings in the map. - - Applies the given function to each element of the list. Return - the list comprised of the results "x" for each element where - the function returns Some(x). - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not - be accessed concurrently. - - A function to transform items of type T into options of type U. - The input sequence of type T. - - The result sequence. - - Thrown when the input sequence is null. + + Returns the key of the first mapping in the collection that satisfies the given predicate. + Returns 'None' if no such element exists. + The function to test the input elements. + The input map. + The first key for which the predicate returns true or None if the predicate evaluates to false for each key/value pair. - - Wraps a loosely-typed System.Collections sequence as a typed sequence. - - The use of this function usually requires a type annotation. - An incorrect type annotation may result in runtime type - errors. - Individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. + + Evaluates the function on each mapping in the collection. Returns the key for the first mapping + where the function returns 'true'. Raise KeyNotFoundException if no such element exists. + The function to test the input elements. + The input map. + Thrown if the key does not exist in the map. + The first key for which the predicate evaluates true. - - Returns a sequence that corresponds to a cached version of the input sequence. - This result sequence will have the same elements as the input sequence. The result - can be enumerated multiple times. The input sequence will be enumerated at most - once and only as far as is necessary. Caching a sequence is typically useful when repeatedly - evaluating items in the original sequence is computationally expensive or if - iterating the sequence causes side-effects that the user does not want to be - repeated multiple times. - - Enumeration of the result sequence is thread safe in the sense that multiple independent IEnumerator - values may be used simultaneously from different threads (accesses to - the internal lookaside table are thread safe). Each individual IEnumerator - is not typically thread safe and should not be accessed concurrently. - - Once enumeration of the input sequence has started, - it's enumerator will be kept live by this object until the enumeration has completed. - At that point, the enumerator will be disposed. - - The enumerator may be disposed and underlying cache storage released by - converting the returned sequence object to type IDisposable, and calling the Dispose method - on this object. The sequence object may then be re-enumerated and a fresh enumerator will - be used. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. + + Lookup an element in the map, returning a Some value if the element is in the domain + of the map and None if not. + The input key. + The input map. + The found Some value or None. - - Returns the average of the results generated by applying the function to each element - of the sequence. - - The elements are averaged using the + operator, DivideByInt method and Zero property - associated with the generated type. - - A function applied to transform each element of the sequence. - The input sequence. - - The average. - - Thrown when the input sequence is null. - Thrown when the input sequence has zero elements. + + Removes an element from the domain of the map. No exception is raised if the element is not present. + The input key. + The input map. + The resulting map. - - Returns the average of the elements in the sequence. - - The elements are averaged using the + operator, DivideByInt method and Zero property - associated with the element type. - - The input sequence. - - The average. - - Thrown when the input sequence is null. - Thrown when the input sequence has zero elements. + + Builds two new maps, one containing the bindings for which the given predicate returns 'true', + and the other the remaining bindings. + The function to test the input elements. + The input map. + A pair of maps in which the first contains the elements for which the predicate returned true + and the second containing the elements for which the predicated returned false. - - Wraps the two given enumerations as a single concatenated - enumeration. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed - concurrently. - - The first sequence. - The second sequence. - - The result sequence. - - Thrown when either of the two provided sequences is - null. + + Tests if an element is in the domain of the map. + The input key. + The input map. + True if the map contains the key. - - Basic operations on IEnumerables. + + Builds a new collection whose elements are the results of applying the given function + to each of the elements of the collection. The key passed to the + function indicates the key of element being transformed. + The function to transform the key/value pairs. + The input map. + The resulting map of keys and transformed values. + + + Returns true if the given predicate returns true for all of the + bindings in the map. + The function to test the input elements. + The input map. + True if the predicate evaluates to true for all of the bindings in the map. + + + Builds a new map containing only the bindings for which the given predicate returns 'true'. + The function to test the key/value pairs. + The input map. + The filtered map. + + + Returns true if the given predicate returns true for one of the + bindings in the map. + The function to test the input elements. + The input map. + True if the predicate returns true for one of the key/value pairs. + + + Applies the given function to each binding in the dictionary + The function to apply to each key/value pair. + The input map. + + + Folds over the bindings in the map + The function to update the state given the input key/value pairs. + The initial state. + The input map. + The final state value. + + + Folds over the bindings in the map. + The function to update the state given the input key/value pairs. + The input map. + The initial state. + The final state value. + + + Searches the map looking for the first element where the given function returns a Some value + The function to generate options from the key/value pairs. + The input map. + The first result. + + + Searches the map looking for the first element where the given function returns a Some value. + The function to generate options from the key/value pairs. + The input map. + The first result. + + + Lookup an element in the map, raising KeyNotFoundException if no binding + exists in the map. + The input key. + The input map. + Thrown when the key does not exist in the map. + The value mapped to the given key. + + + The empty map. + + + Is the map empty? + The input map. + True if the map is empty. + + + Returns an array of all key-value pairs in the mapping. + The array will be ordered by the keys of the map. + The input map. + The array of key/value pairs. + + + Returns a list of all key-value pairs in the mapping. + The list will be ordered by the keys of the map. + The input map. + The list of key/value pairs. + + + Views the collection as an enumerable sequence of pairs. + The sequence will be ordered by the keys of the map. + The input map. + The sequence of key/value pairs. + + + Returns a new map made from the given bindings. + The input sequence of key/value pairs. + The resulting map. + + + Returns a new map made from the given bindings. + The input array of key/value pairs. + The resulting map. + + + Returns a new map made from the given bindings. + The input list of key/value pairs. + The resulting map. + + + Returns a new map with the binding added to the given map. + If a binding with the given key already exists in the input map, the existing binding is replaced by the new binding in the result map. + The input key. + The input value. + The input map. + The resulting map. + + + Functional programming operators related to the Map<_,_> type. Returns a new set with the elements of the second set removed from the first. @@ -3797,7 +3892,7 @@ Computes the union of a sequence of sets. - The sequence of sets to untion. + The sequence of sets to union. The union of the input sets. @@ -3848,7 +3943,7 @@ Returns a new collection containing only the elements of the collection - for which the given predicate returns true. + for which the given predicate returns True. The function to test set elements. The input set. The set containing only the elements for which predicate returns true. @@ -3916,7371 +4011,8210 @@ Functional programming operators related to the Set<_> type. - - Gets the default cancellation token for executing asynchronous computations. - The default CancellationToken. + + Returns a System.Type representing an F# tuple type with the given element types + An array of types for the tuple elements. + The type representing the tuple containing the input elements. - - Creates an asynchronous computation that returns the CancellationToken governing the execution - of the computation. - In async { let! token = Async.CancellationToken ...} token can be used to initiate other - asynchronous operations that will cancel cooperatively with this workflow. - An asynchronous computation capable of retrieving the CancellationToken from a computation - expression. + + Returns a System.Type representing an F# tuple type with the given element types + An array of types for the tuple elements. + The type representing the tuple containing the input elements. - - Creates an asynchronous computation that executes computation. - If this computation is cancelled before it completes then the computation generated by - running compensation is executed. - The input asynchronous computation. - The function to be run if the computation is cancelled. - An asynchronous computation that runs the compensation if the input computation - is cancelled. + + Returns a System.Type representing an F# struct tuple type with the given element types + An array of types for the tuple elements. + The type representing the struct tuple containing the input elements. - - Creates an asynchronous computation that queues a work item that runs - its continuation. - A computation that generates a new work item in the thread pool. + + Returns a System.Type representing the F# function type with the given domain and range + The input type of the function. + The output type of the function. + The function type with the given domain and range. - - Creates an asynchronous computation that creates a new thread and runs - its continuation in that thread. - A computation that will execute on a new thread. + + Returns true if the typ is a representation of an F# union type or the runtime type of a value of that type + The type to check. + Optional binding flags. + True if the type check succeeds. - - Creates an asynchronous computation that runs - its continuation using syncContext.Post. If syncContext is null - then the asynchronous computation is equivalent to SwitchToThreadPool(). - The synchronization context to accept the posted computation. - An asynchronous computation that uses the syncContext context to execute. + + Return true if the typ is a representation of an F# tuple type + The type to check. + True if the type check succeeds. - - Runs an asynchronous computation, starting immediately on the current operating system - thread. Call one of the three continuations when the operation completes. - If no cancellation token is provided then the default cancellation token - is used. - The asynchronous computation to execute. - The function called on success. - The function called on exception. - The function called on cancellation. - The CancellationToken to associate with the computation. - The default is used if this parameter is not provided. + + Return true if the typ is a representation of an F# record type + The type to check. + Optional binding flags. + True if the type check succeeds. - - Runs an asynchronous computation, starting immediately on the current operating system - thread. - If no cancellation token is provided then the default cancellation token is used. - The asynchronous computation to execute. - The CancellationToken to associate with the computation. - The default is used if this parameter is not provided. + + Return true if the typ is a System.Type value corresponding to the compiled form of an F# module + The type to check. + True if the type check succeeds. - - Creates an asynchronous computation which starts the given computation as a System.Threading.Tasks.Task + + Return true if the typ is a representation of an F# function type or the runtime type of a closure implementing an F# function type + The type to check. + True if the type check succeeds. - - Starts a child computation within an asynchronous workflow. - This allows multiple asynchronous computations to be executed simultaneously. - - This method should normally be used as the immediate - right-hand-side of a let! binding in an F# asynchronous workflow, that is, - - async { ... - let! completor1 = childComputation1 |> Async.StartChild - let! completor2 = childComputation2 |> Async.StartChild - ... - let! result1 = completor1 - let! result2 = completor2 - ... } - - When used in this way, each use of StartChild starts an instance of childComputation - and returns a completor object representing a computation to wait for the completion of the operation. - When executed, the completor awaits the completion of childComputation. - The child computation. - The timeout value in milliseconds. If one is not provided - then the default value of -1 corresponding to System.Threading.Timeout.Infinite. - A new computation that waits for the input computation to finish. - - - Executes a computation in the thread pool. - If no cancellation token is provided then the default cancellation token is used. - A System.Threading.Tasks.Task that will be completed - in the corresponding state once the computation terminates (produces the result, throws exception or gets canceled) - + + Returns true if the typ is a representation of an F# exception declaration + The type to check. + Optional binding flags. + True if the type check is an F# exception. - - Starts the asynchronous computation in the thread pool. Do not await its result. + + Gets the cases of a union type. - If no cancellation token is provided then the default cancellation token is used. - The computation to run asynchronously. - The cancellation token to be associated with the computation. - If one is not supplied, the default cancellation token is used. + Assumes the given type is a union type. If not, ArgumentException is raised during pre-computation. + The input union type. + Optional binding flags. + Thrown when the input type is not a union type. + An array of descriptions of the cases of the given union type. - - Creates an asynchronous computation that will sleep for the given time. This is scheduled - using a System.Threading.Timer object. The operation will not block operating system threads - for the duration of the wait. - The number of milliseconds to sleep. - An asynchronous computation that will sleep for the given time. - Thrown when the due time is negative - and not infinite. + + Gets the tuple elements from the representation of an F# tuple type. + The input tuple type. + An array of the types contained in the given tuple type. - - Runs the asynchronous computation and await its result. - - If an exception occurs in the asynchronous computation then an exception is re-raised by this - function. - - If no cancellation token is provided then the default cancellation token is used. + + Reads all the fields from a record value, in declaration order - The timeout parameter is given in milliseconds. A value of -1 is equivalent to - System.Threading.Timeout.Infinite. - The computation to run. - The amount of time in milliseconds to wait for the result of the - computation before raising a System.TimeoutException. If no value is provided - for timeout then a default of -1 is used to correspond to System.Threading.Timeout.Infinite. - The cancellation token to be associated with the computation. - If one is not supplied, the default cancellation token is used. - The result of the computation. + Assumes the given input is a record value. If not, ArgumentException is raised. + The input record type. + Optional binding flags. + An array of descriptions of the properties of the record type. - - Creates an asynchronous computation that executes all the given asynchronous computations, - initially queueing each as work items and using a fork/join pattern. + + Gets the domain and range types from an F# function type or from the runtime type of a closure implementing an F# type + The input function type. + A tuple of the domain and range types of the input function. + + + Reads all the fields from an F# exception declaration, in declaration order - If all child computations succeed, an array of results is passed to the success continuation. - - If any child computation raises an exception, then the overall computation will trigger an - exception, and cancel the others. + Assumes exceptionType is an exception representation type. If not, ArgumentException is raised. + The exception type to read. + Optional binding flags. + Thrown if the given type is not an exception. + An array containing the PropertyInfo of each field in the exception. + + + Contains operations associated with constructing and analyzing F# types such as records, unions and tuples + + + Assumes the given type is a union type. + If not, ArgumentException is raised during pre-computation. - The overall computation will respond to cancellation while executing the child computations. - If cancelled, the computation will cancel any remaining child computations but will still wait - for the other child computations to complete. - A sequence of distinct computations to be parallelized. - A computation that returns an array of values from the sequence of input computations. + Using the computed function is more efficient than calling GetUnionCase + because the path executed by the computed function is optimized given the knowledge that it will be + used to read values of the given type. + The type of union to optimize reading. + Optional binding flags. + An optimized function to read the tags of the given union type. - - Generates a scoped, cooperative cancellation handler for use within an asynchronous workflow. + + Precompute a property or static method for reading an integer representing the case tag of a union type. + The type of union to read. + Optional binding flags. + The description of the union case reader. + + + Precompute a function for reading all the fields for a particular discriminator case of a union type - For example, - async { use! holder = Async.OnCancel interruption ... } - generates an asynchronous computation where, if a cancellation happens any time during - the execution of the asynchronous computation in the scope of holder, then action - interruption is executed on the thread that is performing the cancellation. This can - be used to arrange for a computation to be asynchronously notified that a cancellation - has occurred, e.g. by setting a flag, or deregistering a pending I/O action. - The function that is executed on the thread performing the - cancellation. - An asynchronous computation that triggers the interruption if it is cancelled - before being disposed. + Using the computed function will typically be faster than executing a corresponding call to GetFields + The description of the union case to read. + Optional binding flags. + A function to for reading the fields of the given union case. - - Creates an asynchronous computation that runs the given computation and ignores - its result. - The input computation. - A computation that is equivalent to the input computation, but disregards the result. + + A method that constructs objects of the given case + The description of the union case. + Optional binding flags. + The description of the constructor of the given union case. - - Creates an asynchronous computation that captures the current - success, exception and cancellation continuations. The callback must - eventually call exactly one of the given continuations. - The function that accepts the current success, exception, and cancellation - continuations. - An asynchronous computation that provides the callback with the current continuations. + + Precompute a function for constructing a discriminated union value for a particular union case. + The description of the union case. + Optional binding flags. + A function for constructing values of the given union case. - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. This overlaod should be used if the operation is - qualified by three arguments. For example, - Async.FromBeginEnd(arg1,arg2,arg3,ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. + + Precompute a function for reading the values of a particular tuple type - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The first argument for the operation. - The second argument for the operation. - The third argument for the operation. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. + Assumes the given type is a TupleType. + If not, ArgumentException is raised during pre-computation. + The tuple type to read. + Thrown when the given type is not a tuple type. + A function to read values of the given tuple type. - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. This overlaod should be used if the operation is - qualified by two arguments. For example, - Async.FromBeginEnd(arg1,arg2,ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. + + Gets information that indicates how to read a field of a tuple + The input tuple type. + The index of the tuple element to describe. + The description of the tuple element and an optional type and index if the tuple is big. + + + Gets a method that constructs objects of the given tuple type. + For small tuples, no additional type will be returned. - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The first argument for the operation. - The second argument for the operation. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. + For large tuples, an additional type is returned indicating that + a nested encoding has been used for the tuple type. In this case + the suffix portion of the tuple type has the given type and an + object of this type must be created and passed as the last argument + to the ConstructorInfo. A recursive call to PreComputeTupleConstructorInfo + can be used to determine the constructor for that the suffix type. + The input tuple type. + The description of the tuple type constructor and an optional extra type + for large tuples. - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. This overlaod should be used if the operation is - qualified by one argument. For example, - Async.FromBeginEnd(place,ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. + + Precompute a function for reading the values of a particular tuple type - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The argument for the operation. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. + Assumes the given type is a TupleType. + If not, ArgumentException is raised during pre-computation. + The type of tuple to read. + Thrown when the given type is not a tuple type. + A function to read a particular tuple type. - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. For example, - Async.FromBeginEnd(ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. + + Precompute a function for reading all the fields from a record. The fields are returned in the + same order as the fields reported by a call to Microsoft.FSharp.Reflection.Type.GetInfo for + this type. - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation that executes computation. - If this computation completes successfully then return Choice1Of2 with the returned - value. If this computation raises an exception before it completes then return Choice2Of2 - with the raised exception. - The input computation that returns the type T. - A computation that returns a choice of type T or exception. - - - Raises the cancellation condition for the most recent set of asynchronous computations started - without any specific CancellationToken. Replaces the global CancellationTokenSource with a new - global token source for any asynchronous computations created after this point without any - specific CancellationToken. - - - Creates an asynchronous computation that will wait on the given WaitHandle. + Assumes the given type is a RecordType. + If not, ArgumentException is raised during pre-computation. - The computation returns true if the handle indicated a result within the given timeout. - The WaitHandle that can be signalled. - The timeout value in milliseconds. If one is not provided - then the default value of -1 corresponding to System.Threading.Timeout.Infinite. - An asynchronous computation that waits on the given WaitHandle. + Using the computed function will typically be faster than executing a corresponding call to Value.GetInfo + because the path executed by the computed function is optimized given the knowledge that it will be + used to read values of the given type. + The type of record to read. + Optional binding flags. + Thrown when the input type is not a record type. + An optimized reader for the given record type. - - - Return an asynchronous computation that will wait for the given task to complete and return - its result. - + + Precompute a function for reading a particular field from a record. + Assumes the given type is a RecordType with a field of the given name. + If not, ArgumentException is raised during pre-computation. + + Using the computed function will typically be faster than executing a corresponding call to Value.GetInfo + because the path executed by the computed function is optimized given the knowledge that it will be + used to read values of the given type. + The PropertyInfo of the field to read. + Thrown when the input type is not a record type. + A function to read the specified field from the record. - - - Return an asynchronous computation that will wait for the given task to complete and return - its result. - + + Get a ConstructorInfo for a record type + The record type. + Optional binding flags. + A ConstructorInfo for the given record type. - - Creates an asynchronous computation that will wait on the IAsyncResult. + + Precompute a function for constructing a record value. - The computation returns true if the handle indicated a result within the given timeout. - The IAsyncResult to wait on. - The timeout value in milliseconds. If one is not provided - then the default value of -1 corresponding to System.Threading.Timeout.Infinite. - An asynchronous computation that waits on the given IAsyncResult. + Assumes the given type is a RecordType. + If not, ArgumentException is raised during pre-computation. + The type of record to construct. + Optional binding flags. + Thrown when the input type is not a record type. + A function to construct records of the given type. - - Creates an asynchronous computation that waits for a single invocation of a CLI - event by adding a handler to the event. Once the computation completes or is - cancelled, the handler is removed from the event. - - The computation will respond to cancellation while waiting for the event. If a - cancellation occurs, and cancelAction is specified, then it is executed, and - the computation continues to wait for the event. - - If cancelAction is not specified, then cancellation causes the computation - to cancel immediately. - The event to handle once. - An optional function to execute instead of cancelling when a - cancellation is issued. - An asynchronous computation that waits for the event to be invoked. + + Create a union case value. + The description of the union case to create. + The array of arguments to construct the given case. + Optional binding flags. + The constructed union case. - - Creates three functions that can be used to implement the .NET Asynchronous - Programming Model (APM) for a given asynchronous computation. - - The functions should normally be published as members with prefix Begin, - End and Cancel, and can be used within a type definition as follows: - - let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun arg -> computation) - member x.BeginSomeOperation(arg,callback,state:obj) = beginAction(arg,callback,state) - member x.EndSomeOperation(iar) = endAction(iar) - member x.CancelSomeOperation(iar) = cancelAction(iar) - - - If the asynchronous computation takes no arguments, then AsBeginEnd is used as follows: - - let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun () -> computation) - member x.BeginSomeOperation(callback,state:obj) = beginAction((),callback,state) - member x.EndSomeOperation(iar) = endAction(iar) - member x.CancelSomeOperation(iar) = cancelAction(iar) - - + + Creates an instance of a tuple type - If the asynchronous computation takes two arguments, then AsBeginEnd is used as follows: - - let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun arg1 arg2 -> computation) - member x.BeginSomeOperation(arg1,arg2,callback,state:obj) = beginAction((),callback,state) - member x.EndSomeOperation(iar) = endAction(iar) - member x.CancelSomeOperation(iar) = cancelAction(iar) - + Assumes at least one element is given. If not, ArgumentException is raised. + The array of tuple fields. + The tuple type to create. + Thrown if no elements are given. + An instance of the tuple type with the given elements. + + + Creates an instance of a record type. - In each case, the resulting API will be familiar to programmers in other CLI languages and - is a useful way to publish asynchronous computations in CLI components. - A function generating the asynchronous computation to split into the traditional - .NET Asynchronous Programming Model. - A tuple of the begin, end, and cancel members. + Assumes the given input is a record type. + The type of record to make. + The array of values to initialize the record. + Optional binding flags for the record. + Thrown when the input type is not a record type. + The created record. - - This static class holds members for creating and manipulating asynchronous computations. + + Builds a typed function from object from a dynamic function implementation + The function type of the implementation. + The untyped lambda of the function implementation. + A typed function from the given dynamic implementation. - - Creates an asynchronous computation that just returns (). + + Identify the union case and its fields for an object - A cancellation check is performed when the computation is executed. + Assumes the given input is a union case value. If not, ArgumentException is raised. - The existence of this method permits the use of empty else branches in the - async { ... } computation expression syntax. - An asynchronous computation that returns (). + If the type is not given, then the runtime type of the input object is used to identify the + relevant union type. The type should always be given if the input object may be null. For example, + option values may be represented using the 'null'. + The input union case. + The union type containing the value. + Optional binding flags. + Thrown when the input type is not a union case value. + The description of the union case and its fields. - - Creates an asynchronous computation that runs computation repeatedly - until guard() becomes false. - - A cancellation check is performed whenever the computation is executed. + + Reads all fields from a tuple. - The existence of this method permits the use of while in the - async { ... } computation expression syntax. - The function to determine when to stop executing computation. - The function to be executed. Equivalent to the body - of a while expression. - An asynchronous computation that behaves similarly to a while loop when run. + Assumes the given input is a tuple value. If not, ArgumentException is raised. + The input tuple. + Thrown when the input is not a tuple value. + An array of the fields from the given tuple. - - Creates an asynchronous computation that runs binder(resource). - The action resource.Dispose() is executed as this computation yields its result - or if the asynchronous computation exits by an exception or by cancellation. - - A cancellation check is performed when the computation is executed. + + Reads a field from a tuple value. - The existence of this method permits the use of use and use! in the - async { ... } computation expression syntax. - The resource to be used and disposed. - The function that takes the resource and returns an asynchronous - computation. - An asynchronous computation that binds and eventually disposes resource. + Assumes the given input is a tuple value. If not, ArgumentException is raised. + The input tuple. + The index of the field to read. + The value of the field. - - Creates an asynchronous computation that runs computation and returns its result. - If an exception happens then catchHandler(exn) is called and the resulting computation executed instead. - - A cancellation check is performed when the computation is executed. + + Reads all the fields from a record value. - The existence of this method permits the use of try/with in the - async { ... } computation expression syntax. - The input computation. - The function to run when computation throws an exception. - An asynchronous computation that executes computation and calls catchHandler if an - exception is thrown. + Assumes the given input is a record value. If not, ArgumentException is raised. + The record object. + Optional binding flags for the record. + Thrown when the input type is not a record type. + The array of fields from the record. - - Creates an asynchronous computation that runs computation. The action compensation is executed - after computation completes, whether computation exits normally or by an exception. If compensation raises an exception itself - the original exception is discarded and the new exception becomes the overall result of the computation. - - A cancellation check is performed when the computation is executed. + + Reads a field from a record value. - The existence of this method permits the use of try/finally in the - async { ... } computation expression syntax. - The input computation. - The action to be run after computation completes or raises an - exception (including cancellation). - An asynchronous computation that executes computation and compensation aftewards or - when an exception is raised. + Assumes the given input is a record value. If not, ArgumentException is raised. + The record object. + The PropertyInfo describing the field to read. + Thrown when the input type is not a record type. + The field from the record. - - Delegates to the input computation. + + Reads all the fields from a value built using an instance of an F# exception declaration - The existence of this method permits the use of return! in the - async { ... } computation expression syntax. - The input computation. - The input computation. - - - Creates an asynchronous computation that returns the result v. + Assumes the given input is an F# exception value. If not, ArgumentException is raised. + The exception instance. + Optional binding flags. + Thrown when the input type is not an F# exception. + The fields from the given exception. + + + Contains operations associated with constructing and analyzing values associated with F# types + such as records, unions and tuples. + + + The integer tag for the case. + + + The name of the case. + + + The type in which the case occurs. + + + The fields associated with the case, represented by a PropertyInfo. + The fields associated with the case. + + + Returns the custom attributes data associated with the case. + An list of custom attribute data items. + + + Returns the custom attributes associated with the case matching the given attribute type. + The type of attributes to return. + An array of custom attributes. + + + Returns the custom attributes associated with the case. + An array of custom attributes. + + + Represents a case of a discriminated union type + + + Returns true if the typ is a representation of an F# exception declaration + The type to check. + Optional flag that denotes accessibility of the private representation. + True if the type check is an F# exception. + + + Reads all the fields from an F# exception declaration, in declaration order - A cancellation check is performed when the computation is executed. + Assumes exceptionType is an exception representation type. If not, ArgumentException is raised. + The exception type to read. + Optional flag that denotes accessibility of the private representation. + Thrown if the given type is not an exception. + An array containing the PropertyInfo of each field in the exception. + + + Returns true if the typ is a representation of an F# union type or the runtime type of a value of that type + The type to check. + Optional flag that denotes accessibility of the private representation. + True if the type check succeeds. + + + Return true if the typ is a representation of an F# record type + The type to check. + Optional flag that denotes accessibility of the private representation. + True if the type check succeeds. + + + Gets the cases of a union type. - The existence of this method permits the use of return in the - async { ... } computation expression syntax. - The value to return from the computation. - An asynchronous computation that returns value when executed. + Assumes the given type is a union type. If not, ArgumentException is raised during pre-computation. + The input union type. + Optional flag that denotes accessibility of the private representation. + Thrown when the input type is not a union type. + An array of descriptions of the cases of the given union type. - - Creates an asynchronous computation that enumerates the sequence seq - on demand and runs body for each element. + + Reads all the fields from a record value, in declaration order - A cancellation check is performed on each iteration of the loop. + Assumes the given input is a record value. If not, ArgumentException is raised. + The input record type. + Optional flag that denotes accessibility of the private representation. + An array of descriptions of the properties of the record type. + + + Reads all the fields from a value built using an instance of an F# exception declaration - The existence of this method permits the use of for in the - async { ... } computation expression syntax. - The sequence to enumerate. - A function to take an item from the sequence and create - an asynchronous computation. Can be seen as the body of the for expression. - An asynchronous computation that will enumerate the sequence and run body - for each element. + Assumes the given input is an F# exception value. If not, ArgumentException is raised. + The exception instance. + Optional flag that denotes accessibility of the private representation. + Thrown when the input type is not an F# exception. + The fields from the given exception. - - Creates an asynchronous computation that runs generator. + + A method that constructs objects of the given case + The description of the union case. + Optional flag that denotes accessibility of the private representation. + The description of the constructor of the given union case. + + + Precompute a function for constructing a discriminated union value for a particular union case. + The description of the union case. + Optional flag that denotes accessibility of the private representation. + A function for constructing values of the given union case. + + + Precompute a function for reading all the fields for a particular discriminator case of a union type - A cancellation check is performed when the computation is executed. - The function to run. - An asynchronous computation that runs generator. + Using the computed function will typically be faster than executing a corresponding call to GetFields + The description of the union case to read. + Optional flag that denotes accessibility of the private representation. + A function to for reading the fields of the given union case. - - Creates an asynchronous computation that first runs computation1 - and then runs computation2, returning the result of computation2. + + Precompute a property or static method for reading an integer representing the case tag of a union type. + The type of union to read. + Optional flag that denotes accessibility of the private representation. + The description of the union case reader. + + + Assumes the given type is a union type. + If not, ArgumentException is raised during pre-computation. - A cancellation check is performed when the computation is executed. + Using the computed function is more efficient than calling GetUnionCase + because the path executed by the computed function is optimized given the knowledge that it will be + used to read values of the given type. + The type of union to optimize reading. + Optional flag that denotes accessibility of the private representation. + An optimized function to read the tags of the given union type. + + + Identify the union case and its fields for an object - The existence of this method permits the use of expression sequencing in the - async { ... } computation expression syntax. - The first part of the sequenced computation. - The second part of the sequenced computation. - An asynchronous computation that runs both of the computations sequentially. + Assumes the given input is a union case value. If not, ArgumentException is raised. + + If the type is not given, then the runtime type of the input object is used to identify the + relevant union type. The type should always be given if the input object may be null. For example, + option values may be represented using the 'null'. + The input union case. + The union type containing the value. + Optional flag that denotes accessibility of the private representation. + Thrown when the input type is not a union case value. + The description of the union case and its fields. - - Creates an asynchronous computation that runs computation, and when - computation generates a result T, runs binder res. + + Create a union case value. + The description of the union case to create. + The array of arguments to construct the given case. + Optional flag that denotes accessibility of the private representation. + The constructed union case. + + + Get a ConstructorInfo for a record type + The record type. + Optional flag that denotes accessibility of the private representation. + A ConstructorInfo for the given record type. + + + Precompute a function for constructing a record value. - A cancellation check is performed when the computation is executed. + Assumes the given type is a RecordType. + If not, ArgumentException is raised during pre-computation. + The type of record to construct. + Optional flag that denotes accessibility of the private representation. + Thrown when the input type is not a record type. + A function to construct records of the given type. + + + Precompute a function for reading all the fields from a record. The fields are returned in the + same order as the fields reported by a call to Microsoft.FSharp.Reflection.Type.GetInfo for + this type. - The existence of this method permits the use of let! in the - async { ... } computation expression syntax. - The computation to provide an unbound result. - The function to bind the result of computation. - An asynchronous computation that performs a monadic bind on the result - of computation. + Assumes the given type is a RecordType. + If not, ArgumentException is raised during pre-computation. + + Using the computed function will typically be faster than executing a corresponding call to Value.GetInfo + because the path executed by the computed function is optimized given the knowledge that it will be + used to read values of the given type. + The type of record to read. + Optional flag that denotes accessibility of the private representation. + Thrown when the input type is not a record type. + An optimized reader for the given record type. + + + Reads all the fields from a record value. + + Assumes the given input is a record value. If not, ArgumentException is raised. + The record object. + Optional flag that denotes accessibility of the private representation. + Thrown when the input type is not a record type. + The array of fields from the record. + + + Creates an instance of a record type. + + Assumes the given input is a record type. + The type of record to make. + The array of values to initialize the record. + Optional flags that denotes accessibility of the private representation. + Thrown when the input type is not a record type. + The created record. + + + + A record of options to control structural formatting. + For F# Interactive properties matching those of this value can be accessed via the 'fsi' + value. + + Floating Point format given in the same format accepted by System.Double.ToString, + e.g. f6 or g15. + + If ShowProperties is set the printing process will evaluate properties of the values being + displayed. This may cause additional computation. + + The ShowIEnumerable is set the printing process will force the evaluation of IEnumerable objects + to a small, finite depth, as determined by the printing parameters. + This may lead to additional computation being performed during printing. + + <example> + From F# Interactive the default settings can be adjusted using, for example, + <pre> + open FSharp.Compiler.Interactive.Settings;; + setPrintWidth 120;; + </pre> + </example> + + + + + Data representing structured layouts of terms. + + + + + Convert any value to a layout using the given formatting options. The + layout can then be processed using formatting display engines such as + those in the LayoutOps module. any_to_string and output_any are + built using any_to_layout with default format options. + + + + + Output any value to a channel using the same set of formatting rules + as any_to_string + + + + + Convert any value to a string using a standard formatter + Data is typically formatted in a structured format, e.g. + lists are formatted using the "[1;2]" notation. + The details of the format are not specified and may change + from version to version and according to the flags given + to the F# compiler. The format is intended to be human-readable, + not machine readable. If alternative generic formats are required + you should develop your own formatter, using the code in the + implementation of this file as a starting point. + + Data from other .NET languages is formatted using a virtual + call to Object.ToString() on the boxed version of the input. + + + + + For limiting layout of list-like sequences (lists,arrays,etc). + unfold a list of items using (project and z) making layout list via itemL. + If reach maxLength (before exhausting) then truncate. + + + + + See tagL + + + + + Layout like an F# list. + + + + + Layout like an F# option. + + + + + Layout list vertically. + + + + + Layout two vertically. + + + + + Form tuple of layouts. + + + + + Wrap braces around layout. + + + + + Wrap square brackets around layout. + + + + + Wrap round brackets around Layout. + + + + + Join layouts into a list separated using the given Layout. + + + + + Join layouts into a semi-colon separated list. + + + + + Join layouts into a space separated list. + + + + + Join layouts into a comma separated list. + + + + + Join broken with ident=2 + + + + + Join broken with ident=1 + + + + + Join broken with ident=0 + + + + + Join, possible break with indent=2 + + + + + Join, possible break with indent=1 + + + + + Join, possible break with indent=0 + + + + + Join, unbreakable. + + + + + An string which is left parenthesis (no space on the right). + + + + + An string which is right parenthesis (no space on the left). + + + + + An string which requires no spaces either side. + + + + + An string leaf + + + + + An uninterpreted leaf, to be interpreted into a string + by the layout engine. This allows leaf layouts for numbers, strings and + other atoms to be customized according to culture. + + + + + Is it the empty layout? + + + + + The empty layout + + + + + A layout is a sequence of strings which have been joined together. + The strings are classified as words, separators and left and right parenthesis. + This classification determines where spaces are inserted. + A joint is either unbreakable, breakable or broken. + If a joint is broken the RHS layout occurs on the next line with optional indentation. + A layout can be squashed to for given width which forces breaks as required. + + + + Gets the raw expression associated with this type-carrying expression + + + Type-carrying quoted expressions. Expressions are generated either + by quotations in source text or programatically + + + Returns type of an expression. + + + Returns the custom attributes of an expression. + + + Builds an expression that represents a value and its associated reflected definition as a quotation + The untyped object. + The type of the object. + The definition of the value being quoted. + The resulting expression. + + + Builds an expression that represents a value and its associated reflected definition as a quotation + The value being quoted. + The definition of the value being quoted. + The resulting expression. + + + Builds an expression that represents a while loop + The predicate to control the loop iteration. + The body of the while loop. + The resulting expression. + + + Builds an expression that represents setting a mutable variable + The input variable. + The value to set. + The resulting expression. + + + Builds an expression that represents a variable + The input variable. + The resulting expression. + + + Builds an expression that represents a constant value of a particular type, arising from a variable of the given name + The untyped object. + The type of the object. + The name of the variable. + The resulting expression. + + + Builds an expression that represents a constant value, arising from a variable of the given name + The typed value. + The name of the variable. + The resulting expression. + + + Builds an expression that represents a constant value + The typed value. + The resulting expression. + + + Builds an expression that represents a constant value of a particular type + The untyped object. + The type of the object. + The resulting expression. + + + Builds an expression that represents a test of a value is of a particular union case + The expression to test. + The description of the union case. + The resulting expression. + + + Builds an expression that represents a type test. + The expression to test. + The target type. + The resulting expression. + + + Builds an expression that represents getting a field of a tuple + The input tuple. + The index of the tuple element to get. + The resulting expression. + + + Builds an expression that represents a try/with construct for exception filtering and catching. + The body of the try expression. + + + The variable to bind to a caught exception. + The expression evaluated when an exception is caught. + The resulting expression. + + + Try and find a stored reflection definition for the given method. Stored reflection + definitions are added to an F# assembly through the use of the [<ReflectedDefinition>] attribute. + The description of the method to find. + The reflection definition or None if a match could not be found. + + + Builds an expression that represents a try/finally construct + The body of the try expression. + The final part of the expression to be evaluated. + The resulting expression. + + + Format the expression as a string + Indicates if method, property, constructor and type objects should be printed in detail. If false, these are abbreviated to their name. + The formatted string. + + + Substitutes through the given expression using the given functions + to map variables to new values. The functions must give consistent results + at each application. Variable renaming may occur on the target expression + if variable capture occurs. + The function to map variables into expressions. + The expression with the given substitutions. + + + Builds an expression that represents the sequential execution of one expression followed by another + The first expression. + The second expression. + The resulting expression. + + + Permits interactive environments such as F# Interactive + to explicitly register new pickled resources that represent persisted + top level definitions. + The assembly associated with the resource. + The unique name for the resources being added. + The type definitions referenced. + The serialized resource to register with the environment. + + + Permits interactive environments such as F# Interactive + to explicitly register new pickled resources that represent persisted + top level definitions. + The assembly associated with the resource. + The unique name for the resources being added. + The serialized resource to register with the environment. + + + Builds an expression that represents a nested typed quotation literal + The expression being quoted. + The resulting expression. + + + Builds an expression that represents a nested raw quotation literal + The expression being quoted. + The resulting expression. + + + Builds an expression that represents a nested typed or raw quotation literal + The expression being quoted. + The resulting expression. + + + Builds an expression that represents writing to a static property + The description of the property. + The value to set. + List of indices for the property if it is an indexed property. + The resulting expression. + + + Builds an expression that represents writing to a property of an object + The input object. + The description of the property. + The value to set. + List of indices for the property if it is an indexed property. + The resulting expression. + + + Builds an expression that represents reading a static property + The description of the property. + List of indices for the property if it is an indexed property. + The resulting expression. + + + Builds an expression that represents reading a property of an object + The input object. + The description of the property. + List of indices for the property if it is an indexed property. + The resulting expression. - - - Generate an object used to build asynchronous computations using F# computation expressions. The value - 'async' is a pre-defined instance of this type. - - A cancellation check is performed when the computation is executed. - + + Builds an expression that represents the creation of a union case value + The description of the union case. + The list of arguments for the case. + The resulting expression. - - The type of the async operator, used to build workflows for asynchronous computations. + + Builds an expression that represents the creation of an F# tuple value + The list of elements of the tuple. + The resulting expression. - - Sends a reply to a PostAndReply message. - The value to send. + + Builds record-construction expressions + The type of record. + The list of elements of the record. + The resulting expression. - - A handle to a capability to reply to a PostAndReply message. + + Builds an expression that represents the invocation of an object constructor + The description of the constructor. + The list of arguments to the constructor. + The resulting expression. - - A compositional asynchronous computation, which, when run, will eventually produce a value - of type T, or else raises an exception. - - Asynchronous computations are normally specified using an F# computation expression. - - When run, asynchronous computations have two modes: as a work item (executing synchronous - code), or as a wait item (waiting for an event or I/O completion). - - When run, asynchronous computations can be governed by CancellationToken. This can usually - be specified when the async computation is started. The associated CancellationTokenSource - may be used to cancel the asynchronous computation. Asynchronous computations built using - computation expressions can check the cancellation condition regularly. Synchronous - computations within an asynchronous computation do not automatically check this condition. + + Builds an expression that represents the creation of a delegate value for the given type + The type of delegate. + The parameters for the delegate. + The body of the function. + The resulting expression. - - Publishes the event as a first class event value. + + Builds an expression that represents the creation of an array value initialized with the given elements + The type for the elements of the array. + The list of elements of the array. + The resulting expression. - - Triggers the event using the given parameters. - The parameters for the event. + + Builds recursive expressions associated with 'let rec' constructs + The list of bindings for the let expression. + The sub-expression where the bindings are in scope. + The resulting expression. - - Creates an event object suitable for implementing an arbitrary type of delegate. - The event object. + + Builds expressions associated with 'let' constructs + The variable in the let expression. + The expression bound to the variable. + The sub-expression where the binding is in scope. + The resulting expression. - - Event implementations for an arbitrary type of delegate. + + Builds an expression that represents the construction of an F# function value + The parameter to the function. + The body of the function. + The resulting expression. - - Publishes an observation as a first class value. + + Builds 'if ... then ... else' expressions. + The condition expression. + The then sub-expression. + The else sub-expression. + The resulting expression. - - Triggers an observation using the given parameters. - The event parameters. + + Fetches or creates a new variable with the given name and type from a global pool of shared variables + indexed by name and type. The type is given by the explicit or inferred type parameter + The variable name. + The created of fetched typed global variable. - - Creates an observable object. - The created event. + + Gets the free expression variables of an expression as a list. + A sequence of the free variables in the expression. - - Event implementations for the IEvent<_> type. + + Builds a 'for i = ... to ... do ...' expression that represent loops over integer ranges + The sub-expression declaring the loop variable. + The sub-expression setting the initial value of the loop variable. + The sub-expression declaring the final value of the loop variable. + The sub-expression representing the body of the loop. + The resulting expression. - - Publishes the event as a first class event value. + + Builds an expression that represents writing to a field of an object + The input object. + The description of the field to write to. + The value to set to the field. + The resulting expression. - - Triggers the event using the given sender object and parameters. The sender object may be null. - The object triggering the event. - The parameters for the event. + + Builds an expression that represents writing to a static field + The description of the field to write to. + The value to the set to the field. + The resulting expression. - - Creates an event object suitable for delegate types following the standard .NET Framework convention of a first 'sender' argument. - The created event. + + Builds an expression that represents the access of a field of an object + The input object. + The description of the field to access. + The resulting expression. - - Event implementations for a delegate types following the standard .NET Framework convention of a first 'sender' argument. + + Builds an expression that represents the access of a static field + The description of the field to access. + The resulting expression. - - A delegate type associated with the F# event type IEvent<_> - The object that fired the event. - The event arguments. + + This function is called automatically when quotation syntax (<@ @>) and other sources of + quotations are used. + A type in the assembly where the quotation occurs. + The type definitions referenced. + The spliced types, to replace references to type variables. + The spliced expressions to replace references to spliced expressions. + The serialized form of the quoted expression. + The resulting expression. - - Remove a listener delegate from an event listener store. - The delegate to be removed from the event listener store. + + This function is called automatically when quotation syntax (<@ @>) and other sources of + quotations are used. + A type in the assembly where the quotation occurs. + The spliced types, to replace references to type variables. + The spliced expressions to replace references to spliced expressions. + The serialized form of the quoted expression. + The resulting expression. - - Connect a handler delegate object to the event. A handler can - be later removed using RemoveHandler. The listener will - be invoked when the event is fired. - A delegate to be invoked when the event is fired. + + Builds an expression that represents the invocation of a default object constructor + The type on which the constructor is invoked. + The resulting expression. - - First class event values for arbitrary delegate types. - - F# gives special status to member properties compatible with type IDelegateEvent and - tagged with the CLIEventAttribute. In this case the F# compiler generates approriate - CLI metadata to make the member appear to other CLI languages as a CLI event. + + Builds an expression that represents the coercion of an expression to a type + The expression to coerce. + The target type. + The resulting expression. - - First-class listening points (i.e. objects that permit you to register a callback - activated when the event is triggered). + + Returns a new typed expression given an underlying runtime-typed expression. + A type annotation is usually required to use this function, and + using an incorrect type annotation may result in a later runtime exception. + The expression to cast. + The resulting typed expression. - - First class event values for CLI events conforming to CLI Framework standards. + + Builds an expression that represents a call to an instance method associated with an object + The input object. + The description of the method to call. + The list of arguments to the method. + The resulting expression. - - The type of delayed computations. - - Use the values in the Lazy module to manipulate - values of this type, and the notation lazy expr to create values - of type . + + Builds an expression that represents a call to an static method or module-bound function + The MethodInfo describing the method to call. + The list of arguments to the method. + The resulting expression. - - Raises a timeout exception if a message not received in this amount of time. By default - no timeout is used. + + Builds an expression that represents the application of a first class function value to multiple arguments + The function to apply. + The list of lists of arguments to the function. + The resulting expression. - - Occurs when the execution of the agent results in an exception. + + Builds an expression that represents the application of a first class function value to a single argument. + The function to apply. + The argument to the function. + The resulting expression. - - Occurs when the execution of the agent results in an exception. + + Builds an expression that represents setting the value held at a particular address. + The target expression. + The value to set at the address. + The resulting expression. - - Raises a timeout exception if a message not received in this amount of time. By default - no timeout is used. + + Builds an expression that represents getting the address of a value. + The target expression. + The resulting expression. - - Returns the number of unprocessed messages in the message queue of the agent. + + Quoted expressions annotated with System.Type values. + + + The type associated with the variable + + + The declared name of the variable - - Occurs when the execution of the agent results in an exception. + + Indicates if the variable represents a mutable storage location - - Scans for a message by looking through messages in arrival order until scanner - returns a Some value. Other messages remain in the queue. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - The function to return None if the message is to be skipped - or Some if the message is to be processed and removed from the queue. - An optional timeout in milliseconds. Defaults to -1 which corresponds - to System.Threading.Timeout.Infinite. - An asynchronous computation that scanner built off the read message. + + Fetches or create a new variable with the given name and type from a global pool of shared variables + indexed by name and type + The name of the variable. + The type associated with the variable. + The retrieved or created variable. - - Waits for a message. This will consume the first message in arrival order. - - This method is for use within the body of the agent. - - Returns None if a timeout is given and the timeout is exceeded. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - An optional timeout in milliseconds. Defaults to -1 which - corresponds to System.Threading.Timeout.Infinite. - An asynchronous computation that returns the received message or - None if the timeout is exceeded. + + Creates a new variable with the given name, type and mutability + The declared name of the variable. + The type associated with the variable. + Indicates if the variable represents a mutable storage location. Default is false. + The created variable. - - Like PostAndReply, but returns None if no reply within the timeout period. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - The reply from the agent or None if the timeout expires. + + Information at the binding site of a variable - - Starts the agent. + + Re-build combination expressions. The first parameter should be an object + returned by the ShapeCombination case of the active pattern in this module. + The input shape. + The list of arguments. + The rebuilt expression. - - Creates and starts an agent. The body function is used to generate the asynchronous - computation executed by the agent. - The function to produce an asynchronous computation that will be executed - as the read loop for the MailboxProcessor when Start is called. - An optional cancellation token for the body. - Defaults to Async.DefaultCancellationToken. - The created MailboxProcessor. + + An active pattern that performs a complete decomposition viewing the expression tree as a binding structure + The input expression. + The decomposed Var, Lambda, or ConstApp. - - Scans for a message by looking through messages in arrival order until scanner - returns a Some value. Other messages remain in the queue. - - Returns None if a timeout is given and the timeout is exceeded. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - The function to return None if the message is to be skipped - or Some if the message is to be processed and removed from the queue. - An optional timeout in milliseconds. Defaults to -1 which corresponds - to System.Threading.Timeout.Infinite. - An asynchronous computation that scanner built off the read message. - Thrown when the timeout is exceeded. + + Active patterns for traversing, visiting, rebuilding and transforming expressions in a generic way - - Waits for a message. This will consume the first message in arrival order. - - This method is for use within the body of the agent. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - An optional timeout in milliseconds. Defaults to -1 which corresponds - to System.Threading.Timeout.Infinite. - An asynchronous computation that returns the received message. - Thrown when the timeout is exceeded. + + An active pattern to recognize property setters that have an associated ReflectedDefinition + The description of the property. + The expression of the method definition if found, or None. - - Like AsyncPostAndReply, but returns None if no reply within the timeout period. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - An asynchronous computation that will return the reply or None if the timeout expires. + + An active pattern to recognize property getters or values in modules that have an associated ReflectedDefinition + The description of the property. + The expression of the method definition if found, or None. - - Posts a message to an agent and await a reply on the channel, synchronously. - - The message is generated by applying buildMessage to a new reply channel - to be incorporated into the message. The receiving agent must process this - message and invoke the Reply method on this reply channel precisely once. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - The reply from the agent. + + An active pattern to recognize methods that have an associated ReflectedDefinition + The description of the method. + The expression of the method definition if found, or None. - - Posts a message to an agent and await a reply on the channel, asynchronously. - - The message is generated by applying buildMessage to a new reply channel - to be incorporated into the message. The receiving agent must process this - message and invoke the Reply method on this reply channel precisely once. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - An asychronous computation that will wait for the reply from the agent. + + A parameterized active pattern to recognize calls to a specified function or method. + The returned elements are the optional target object (present if the target is an + instance method), the generic type instantiation (non-empty if the target is a generic + instantiation), and the arguments to the function or method. + The input template expression to specify the method to call. + The optional target object (present if the target is an + instance method), the generic type instantiation (non-empty if the target is a generic + instantiation), and the arguments to the function or method. - - Posts a message to the message queue of the MailboxProcessor, asynchronously. - The message to post. + + An active pattern to recognize constant decimal expressions + The input expression to match against. + decimal option - - Creates an agent. The body function is used to generate the asynchronous - computation executed by the agent. This function is not executed until - Start is called. - The function to produce an asynchronous computation that will be executed - as the read loop for the MailboxProcessor when Start is called. - An optional cancellation token for the body. - Defaults to Async.DefaultCancellationToken. - The created MailboxProcessor. + + An active pattern to recognize constant unsigned int64 expressions + The input expression to match against. + uint64 option - - A message-processing agent which executes an asynchronous computation. - - The agent encapsulates a message queue that supports multiple-writers and - a single reader agent. Writers send messages to the agent by using the Post - method and its variations. - - The agent may wait for messages using the Receive or TryReceive methods or - scan through all available messages using the Scan or TryScan method. + + An active pattern to recognize constant int64 expressions + The input expression to match against. + int64 option - - Connects a listener function to the observable. The listener will - be invoked for each observation. The listener can be removed by - calling Dispose on the returned IDisposable object. - The function to be called for each observation. - An object that will remove the listener if disposed. + + An active pattern to recognize constant unsigned int32 expressions + The input expression to match against. + uint32 option - - Permanently connects a listener function to the observable. The listener will - be invoked for each observation. - The function to be called for each observation. + + An active pattern to recognize constant int32 expressions + The input expression to match against. + int32 option - - Returns an asynchronous computation that will write the given bytes to the stream. - The buffer to write from. - An optional offset as a number of bytes in the stream. - An optional number of bytes to write to the stream. - An asynchronous computation that will write the given bytes to the stream. - Thrown when the sum of offset and count is longer than - the buffer length. - Thrown when offset or count is negative. + + An active pattern to recognize constant unsigned int16 expressions + The input expression to match against. + uint16 option - - Returns an asynchronous computation that will read the given number of bytes from the stream. - The number of bytes to read. - An asynchronous computation that returns the read byte[] when run. + + An active pattern to recognize constant int16 expressions + The input expression to match against. + int16 option - - Returns an asynchronous computation that will read from the stream into the given buffer. - The buffer to read into. - An optional offset as a number of bytes in the stream. - An optional number of bytes to read from the stream. - An asynchronous computation that will read from the stream into the given buffer. - Thrown when the sum of offset and count is longer than - the buffer length. - Thrown when offset or count is negative. + + An active pattern to recognize constant byte expressions + The input expression to match against. + byte option - - A module of extension members providing asynchronous operations for some basic CLI types related to concurrency and I/O. + + An active pattern to recognize constant signed byte expressions + The input expression to match against. + sbyte option - - Returns a new event that triggers on the second and subsequent triggerings of the input event. - The Nth triggering of the input event passes the arguments from the N-1th and Nth triggering as - a pair. The argument passed to the N-1th triggering is held in hidden internal state until the - Nth triggering occurs. - The input event. - An event that triggers on pairs of consecutive values passed from the source event. + + An active pattern to recognize constant unicode character expressions + The input expression to match against. + char option - - Runs the given function each time the given event is triggered. - The function to call when the event is triggered. - The input event. + + An active pattern to recognize constant 64-bit floating point number expressions + The input expression to match against. + float option - - Returns a new event consisting of the results of applying the given accumulating function - to successive values triggered on the input event. An item of internal state - records the current value of the state parameter. The internal state is not locked during the - execution of the accumulation function, so care should be taken that the - input IEvent not triggered by multiple threads simultaneously. - The function to update the state with each event value. - The initial state. - The input event. - An event that fires on the updated state values. + + An active pattern to recognize constant 32-bit floating point number expressions + The input expression to match against. + float32 option - - Returns a new event which fires on a selection of messages from the original event. - The selection function takes an original message to an optional new message. - The function to select and transform event values to pass on. - The input event. - An event that fires only when the chooser returns Some. + + An active pattern to recognize constant string expressions + The input expression to match against. + string option - - Returns a new event that listens to the original event and triggers the - first resulting event if the application of the function to the event arguments - returned a Choice1Of2, and the second event if it returns a Choice2Of2. - The function to transform event values into one of two types. - The input event. - A tuple of events. The first fires whenever splitter evaluates to Choice1of1 and - the second fires whenever splitter evaluates to Choice2of2. + + An active pattern to recognize constant boolean expressions + The input expression to match against. + bool option - - Returns a new event that listens to the original event and triggers the - first resulting event if the application of the predicate to the event arguments - returned true, and the second event if it returned false. - The function to determine which output event to trigger. - The input event. - A tuple of events. The first is triggered when the predicate evaluates to true - and the second when the predicate evaluates to false. + + An active pattern to recognize () constant expressions + The input expression to match against. + unit option - - Returns a new event that listens to the original event and triggers the resulting - event only when the argument to the event passes the given function. - The function to determine which triggers from the event to propagate. - The input event. - An event that only passes values that pass the predicate. + + An active pattern to recognize expressions of the form a || b + The input expression to match against. + (Expr * Expr) option - - Returns a new event that passes values transformed by the given function. - The function to transform event values. - The input event. - An event that passes the transformed values. + + An active pattern to recognize expressions of the form a && b + The input expression to match against. + (Expr * Expr) option - - Fires the output event when either of the input events fire. - The first input event. - The second input event. - An event that fires when either of the input events fire. + + An active pattern to recognize expressions that represent the application of a (possibly curried or tupled) first class function value + The input expression to match against. + (Expr * Expr list list) option - - Forces the execution of this value and return its result. Same as Value. Mutual exclusion is used to - prevent other threads also computing the value. - The value of the Lazy object. + + An active pattern to recognize expressions that represent a (possibly curried or tupled) first class function value + The input expression to match against. + (Var list list * Expr) option - - Creates a lazy computation that evaluates to the given value when forced. - The input value. - The created Lazy object. + + Contains a set of derived F# active patterns to analyze F# expression objects - - Creates a lazy computation that evaluates to the result of the given function when forced. - The function to provide the value when needed. - The created Lazy object. + + An active pattern to recognize expressions that represent setting a mutable variable + The input expression to match against. + (Var * Expr) option - - Extensions related to Lazy values. + + An active pattern to recognize expressions that represent a variable + The input expression to match against. + Var option - - Returns a new observable that triggers on the second and subsequent triggerings of the input observable. - The Nth triggering of the input observable passes the arguments from the N-1th and Nth triggering as - a pair. The argument passed to the N-1th triggering is held in hidden internal state until the - Nth triggering occurs. - - For each observer, the registered intermediate observing object is not thread safe. - That is, observations arising from the source must not be triggered concurrently - on different threads. - The input Observable. - An Observable that triggers on successive pairs of observations from the input Observable. + + An active pattern to recognize expressions that are a value with an associated definition + The input expression to match against. + The boxed value, its static type and its definition - - Creates an observer which subscribes to the given observable and which calls - the given function for each observation. - The function to be called on each observation. - The input Observable. - An object that will remove the callback if disposed. + + An active pattern to recognize expressions that represent a constant value + The input expression to match against. + The boxed value, its static type and its name - - Creates an observer which permanently subscribes to the given observable and which calls - the given function for each observation. - The function to be called on each observation. - The input Observable. + + An active pattern to recognize expressions that represent a constant value. This also matches expressions matched by ValueWithName. + The input expression to match against. + The boxed value and its static type - - Returns an observable which, for each observer, allocates an item of state - and applies the given accumulating function to successive values arising from - the input. The returned object will trigger observations for each computed - state value, excluding the initial value. The returned object propagates - all errors arising from the source and completes when the source completes. - - For each observer, the registered intermediate observing object is not thread safe. - That is, observations arising from the source must not be triggered concurrently - on different threads. - The function to update the state with each observation. - The initial state. - The input Observable. - An Observable that triggers on the updated state values. + + An active pattern to recognize expressions that represent a test if a value is of a particular union case + The input expression to match against. + The expression and union case being tested - - Returns an observable which chooses a projection of observations from the source - using the given function. The returned object will trigger observations x - for which the splitter returns Some x. The returned object also propagates - all errors arising from the source and completes when the source completes. - The function that returns Some for observations to be propagated - and None for observations to ignore. - The input Observable. - An Observable that only propagates some of the observations from the source. + + An active pattern to recognize expressions that represent a dynamic type test + The input expression to match against. + The expression and type being tested - - Returns two observables which split the observations of the source by the - given function. The first will trigger observations x for which the - splitter returns Choice1Of2 x. The second will trigger observations - y for which the splitter returns Choice2Of2 y The splitter is - executed once for each subscribed observer. Both also propagate error - observations arising from the source and each completes when the source - completes. - The function that takes an observation an transforms - it into one of the two output Choice types. - The input Observable. - A tuple of Observables. The first triggers when splitter returns Choice1of2 - and the second triggers when splitter returns Choice2of2. + + An active pattern to recognize expressions that represent getting a tuple field + The input expression to match against. + The expression and tuple field being accessed - - Returns two observables which partition the observations of the source by - the given function. The first will trigger observations for those values - for which the predicate returns true. The second will trigger observations - for those values where the predicate returns false. The predicate is - executed once for each subscribed observer. Both also propagate all error - observations arising from the source and each completes when the source - completes. - The function to determine which output Observable will trigger - a particular observation. - The input Observable. - A tuple of Observables. The first triggers when the predicate returns true, and - the second triggers when the predicate returns false. + + An active pattern to recognize expressions that represent a try/finally construct + The input expression to match against. + The body and handler parts of the try/finally expression - - Returns an observable which filters the observations of the source - by the given function. The observable will see only those observations - for which the predicate returns true. The predicate is executed once for - each subscribed observer. The returned object also propagates error - observations arising from the source and completes when the source completes. - The function to apply to observations to determine if it should - be kept. - The input Observable. - An Observable that filters observations based on filter. + + An active pattern to recognize expressions that represent a try/with construct for exception filtering and catching + The input expression to match against. + (Expr * Var * Expr * Var * Expr) option - - Returns an observable which transforms the observations of the source by the - given function. The transformation function is executed once for each - subscribed observer. The returned object also propagates error observations - arising from the source and completes when the source completes. - The function applied to observations from the source. - The input Observable. - An Observable of the type specified by mapping. + + An active pattern to recognize expressions that represent sequential execution of one expression followed by another + The input expression to match against. + (Expr * Expr) option - - Returns an observable for the merged observations from the sources. - The returned object propagates success and error values arising - from either source and completes when both the sources have completed. - - For each observer, the registered intermediate observing object is not - thread safe. That is, observations arising from the sources must not - be triggered concurrently on different threads. - The first Observable. - The second Observable. - An Observable that propagates information from both sources. + + An active pattern to recognize expressions that represent a nested typed quotation literal + The input expression to match against. + Expr option - - Basic operations on first class event and other observable objects. + + An active pattern to recognize expressions that represent a nested raw quotation literal + The input expression to match against. + Expr option - - Returns an asynchronous computation that, when run, will wait for the download of the given URI to specified file. - The URI to retrieve. - The filename to save download to. - An asynchronous computation that will wait for the download of the URI to specified file. + + An active pattern to recognize expressions that represent a nested quotation literal + The input expression to match against. + Expr option - - Returns an asynchronous computation that, when run, will wait for the download of the given URI. - The URI to retrieve. - An asynchronous computation that will wait for the download of the URI. + + An active pattern to recognize expressions that represent setting a static or instance property, or a non-function value declared in a module + The input expression to match against. + (Expr option * PropertyInfo * Expr list * Expr) option - - Returns an asynchronous computation that, when run, will wait for the download of the given URI. - The URI to retrieve. - An asynchronous computation that will wait for the download of the URI. + + An active pattern to recognize expressions that represent the read of a static or instance property, or a non-function value declared in a module + The input expression to match against. + (Expr option * PropertyInfo * Expr list) option - - Returns an asynchronous computation that, when run, will wait for a response to the given WebRequest. - An asynchronous computation that waits for response to the WebRequest. + + An active pattern to recognize expressions that represent construction of tuple values + The input expression to match against. + (Expr list) option - - A module of extension members providing asynchronous operations for some basic Web operations. + + An active pattern to recognize expressions that represent construction of particular union case values + The input expression to match against. + (UnionCaseInfo * Expr list) option - - Creates an instance of the attribute - AbstractClassAttribute + + An active pattern to recognize expressions that represent construction of record values + The input expression to match against. + (Type * Expr list) option - - Adding this attribute to class definition makes it abstract, which means it need not - implement all its methods. Instances of abstract classes may not be constructed directly. + + An active pattern to recognize expressions that represent invocation of object constructors + The input expression to match against. + (ConstructorInfo * Expr list) option - - The value of the attribute, indicating whether the type allows the null literal or not + + An active pattern to recognize expressions that represent construction of delegate values + The input expression to match against. + (Type * Var list * Expr) option - - Creates an instance of the attribute with the specified value - AllowNullLiteralAttribute + + An active pattern to recognize expressions that represent invocations of a default constructor of a struct + The input expression to match against. + Type option - - Creates an instance of the attribute - AllowNullLiteralAttribute + + An active pattern to recognize expressions that represent the construction of arrays + The input expression to match against. + (Type * Expr list) option - - Adding this attribute to a type lets the 'null' literal be used for the type - within F# code. This attribute may only be added to F#-defined class or - interface types. + + An active pattern to recognize expressions that represent recursive let bindings of one or more variables + The input expression to match against. + ((Var * Expr) list * Expr) option - - Indicates the namespace or module to be automatically opened when an assembly is referenced - or an enclosing module opened. + + An active pattern to recognize expressions that represent let bindings + The input expression to match against. + (Var * Expr * Expr) option - - Creates an attribute used to mark a namespace or module path to be 'automatically opened' when an assembly is referenced - The namespace or module to be automatically opened when an assembly is referenced - or an enclosing module opened. - AutoOpenAttribute + + An active pattern to recognize expressions that represent first class function values + The input expression to match against. + (Var * Expr) option - - Creates an attribute used to mark a module as 'automatically opened' when the enclosing namespace is opened - AutoOpenAttribute + + An active pattern to recognize expressions that represent conditionals + The input expression to match against. + (Expr * Expr * Expr) option - - This attribute is used for two purposes. When applied to an assembly, it must be given a string - argument, and this argument must indicate a valid module or namespace in that assembly. Source - code files compiled with a reference to this assembly are processed in an environment - where the given path is automatically opened. - - When applied to a module within an assembly, then the attribute must not be given any arguments. - When the enclosing namespace is opened in user source code, the module is also implicitly opened. + + An active pattern to recognize expressions that represent while loops + The input expression to match against. + (Expr * Expr) option - - The value of the attribute, indicating whether the type is automatically marked serializable or not + + An active pattern to recognize expressions that represent loops over integer ranges + The input expression to match against. + (Var * Expr * Expr * Expr) option - - Creates an instance of the attribute - Indicates whether the type should be serializable by default. - AutoSerializableAttribute + + An active pattern to recognize expressions that represent setting a static or instance field + The input expression to match against. + (Expr option * FieldInfo * Expr) option - - Adding this attribute to a type with value 'false' disables the behaviour where F# makes the - type Serializable by default. + + An active pattern to recognize expressions that represent getting a static or instance field + The input expression to match against. + (Expr option * FieldInfo) option - - Creates an instance of the attribute - CLIEventAttribute + + An active pattern to recognize expressions that represent coercions from one type to another + The input expression to match against. + (Expr * Type) option - - Adding this attribute to a property with event type causes it to be compiled with as a CLI - metadata event, through a syntactic translation to a pair of 'add_EventName' and - 'remove_EventName' methods. + + An active pattern to recognize expressions that represent calls to static and instance methods, and functions defined in modules + The input expression to match against. + (Expr option * MethodInfo * Expr list) option - - Creates an instance of the attribute - CLIMutableAttribute + + An active pattern to recognize expressions that represent applications of first class function values + The input expression to match against. + (Expr * Expr) option - - Adding this attribute to a record type causes it to be compiled to a CLI representation - with a default constructor with property getters and setters. + + An active pattern to recognize expressions that represent setting the value held at an address + The input expression to match against. + (Expr * Expr) option - - Choice 2 of 2 choices + + An active pattern to recognize expressions that represent getting the address of a value + The input expression to match against. + Expr option - - Choice 1 of 2 choices + + Contains a set of primitive F# active patterns to analyze F# expression objects - - Helper types for active patterns with 2 choices. + + Converts a given typed native pointer to a managed pointer. + The input pointer. + The managed pointer. - - Choice 3 of 3 choices + + Allocates a region of memory on the stack. + The number of objects of type T to allocate. + A typed pointer to the allocated memory. - - Choice 2 of 3 choices + + Assigns the value into the memory location referenced by the typed native + pointer computed by adding index * sizeof<'T> to the given input pointer. + The input pointer. + The index by which to offset the pointer. + The value to assign. - - Choice 1 of 3 choices + + Assigns the value into the memory location referenced by the given typed native pointer. + The input pointer. + The value to assign. - - Helper types for active patterns with 3 choices. + + Dereferences the given typed native pointer. + The input pointer. + The value at the pointer address. - - Choice 4 of 4 choices + + Dereferences the typed native pointer computed by adding index * sizeof<'T> to the + given input pointer. + The input pointer. + The index by which to offset the pointer. + The value at the pointer address. - - Choice 3 of 4 choices + + Returns a typed native pointer by adding index * sizeof<'T> to the + given input pointer. + The input pointer. + The index by which to offset the pointer. + A typed pointer. - - Choice 2 of 4 choices + + Returns a machine address for a given typed native pointer. + The input pointer. + The machine address. - - Choice 1 of 4 choices + + Returns a typed native pointer for a untyped native pointer. + The untyped pointer. + A typed pointer. - - Helper types for active patterns with 4 choices. + + Returns an untyped native pointer for a given typed pointer. + The pointer address. + A typed pointer. - - Choice 5 of 5 choices + + Returns a typed native pointer for a given machine address. + The pointer address. + A typed pointer. - - Choice 4 of 5 choices + + Contains operations on native pointers. Use of these operators may + result in the generation of unverifiable code. - - Choice 3 of 5 choices + + First-class listening points (i.e. objects that permit you to register a callback + activated when the event is triggered). - - Choice 2 of 5 choices + + A delegate type associated with the F# event type IEvent<_> + The object that fired the event. + The event arguments. - - Choice 1 of 5 choices + + First class event values for CLI events conforming to CLI Framework standards. - - Helper types for active patterns with 5 choices. + + Remove a listener delegate from an event listener store. + The delegate to be removed from the event listener store. - - Choice 6 of 6 choices + + Connect a handler delegate object to the event. A handler can + be later removed using RemoveHandler. The listener will + be invoked when the event is fired. + A delegate to be invoked when the event is fired. - - Choice 5 of 6 choices + + First class event values for arbitrary delegate types. + + F# gives special status to member properties compatible with type IDelegateEvent and + tagged with the CLIEventAttribute. In this case the F# compiler generates appropriate + CLI metadata to make the member appear to other CLI languages as a CLI event. - - Choice 4 of 6 choices + + The type of delayed computations. + + Use the values in the Lazy module to manipulate + values of this type, and the notation lazy expr to create values + of type . - - Choice 3 of 6 choices + + Publishes an observation as a first class value. - - Choice 2 of 6 choices + + Triggers an observation using the given parameters. + The event parameters. - - Choice 1 of 6 choices + + Creates an observable object. + The created event. - - Helper types for active patterns with 6 choices. + + Event implementations for the IEvent<_> type. - - Choice 7 of 7 choices + + Publishes the event as a first class event value. - - Choice 6 of 7 choices + + Triggers the event using the given sender object and parameters. The sender object may be null. + The object triggering the event. + The parameters for the event. - - Choice 5 of 7 choices + + Creates an event object suitable for delegate types following the standard .NET Framework convention of a first 'sender' argument. + The created event. - - Choice 4 of 7 choices + + Event implementations for a delegate types following the standard .NET Framework convention of a first 'sender' argument. - - Choice 3 of 7 choices + + Publishes the event as a first class event value. - - Choice 2 of 7 choices + + Triggers the event using the given parameters. + The parameters for the event. - - Choice 1 of 7 choices + + Creates an event object suitable for implementing an arbitrary type of delegate. + The event object. - - Helper types for active patterns with 7 choices. + + Event implementations for an arbitrary type of delegate. - - Creates an instance of the attribute - ClassAttribute + + Creates an asynchronous computation that just returns (). + + A cancellation check is performed when the computation is executed. + + The existence of this method permits the use of empty else branches in the + async { ... } computation expression syntax. + An asynchronous computation that returns (). - - Adding this attribute to a type causes it to be represented using a CLI class. + + Creates an asynchronous computation that runs computation repeatedly + until guard() becomes false. + + A cancellation check is performed whenever the computation is executed. + + The existence of this method permits the use of while in the + async { ... } computation expression syntax. + The function to determine when to stop executing computation. + The function to be executed. Equivalent to the body + of a while expression. + An asynchronous computation that behaves similarly to a while loop when run. - - Creates an instance of the attribute - ComparisonConditionalOnAttribute + + Creates an asynchronous computation that runs binder(resource). + The action resource.Dispose() is executed as this computation yields its result + or if the asynchronous computation exits by an exception or by cancellation. + + A cancellation check is performed when the computation is executed. + + The existence of this method permits the use of use and use! in the + async { ... } computation expression syntax. + The resource to be used and disposed. + The function that takes the resource and returns an asynchronous + computation. + An asynchronous computation that binds and eventually disposes resource. - - This attribute is used to indicate a generic container type satisfies the F# 'comparison' - constraint only if a generic argument also satisfies this constraint. For example, adding - this attribute to parameter 'T on a type definition C<'T> means that a type C<X> only supports - comparison if the type X also supports comparison and all other conditions for C<X> to support - comparison are also met. The type C<'T> can still be used with other type arguments, but a type such - as C<(int -> int)> will not support comparison because the type (int -> int) is an F# function type - and does not support comparison. + + Creates an asynchronous computation that runs computation and returns its result. + If an exception happens then catchHandler(exn) is called and the resulting computation executed instead. - This attribute will be ignored if it is used on the generic parameters of functions or methods. + A cancellation check is performed when the computation is executed. + + The existence of this method permits the use of try/with in the + async { ... } computation expression syntax. + + The input computation. + The function to run when computation throws an exception. + An asynchronous computation that executes computation and calls catchHandler if an + exception is thrown. - - Indicates the number of arguments in each argument group + + Creates an asynchronous computation that runs computation. The action compensation is executed + after computation completes, whether computation exits normally or by an exception. If compensation raises an exception itself + the original exception is discarded and the new exception becomes the overall result of the computation. + + A cancellation check is performed when the computation is executed. + + The existence of this method permits the use of try/finally in the + async { ... } computation expression syntax. + The input computation. + The action to be run after computation completes or raises an + exception (including cancellation). + An asynchronous computation that executes computation and compensation afterwards or + when an exception is raised. - - Creates an instance of the attribute - Indicates the number of arguments in each argument group. - CompilationArgumentCountsAttribute + + Delegates to the input computation. + + The existence of this method permits the use of return! in the + async { ... } computation expression syntax. + The input computation. + The input computation. - - This attribute is generated automatically by the F# compiler to tag functions and members - that accept a partial application of some of their arguments and return a residual function + + Creates an asynchronous computation that returns the result v. + + A cancellation check is performed when the computation is executed. + + The existence of this method permits the use of return in the + async { ... } computation expression syntax. + The value to return from the computation. + An asynchronous computation that returns value when executed. - - Indicates the variant number of the entity, if any, in a linear sequence of elements with F# source code + + Creates an asynchronous computation that enumerates the sequence seq + on demand and runs body for each element. + + A cancellation check is performed on each iteration of the loop. + + The existence of this method permits the use of for in the + async { ... } computation expression syntax. + The sequence to enumerate. + A function to take an item from the sequence and create + an asynchronous computation. Can be seen as the body of the for expression. + An asynchronous computation that will enumerate the sequence and run body + for each element. - - Indicates the type definitions needed to resolve the source construct + + Creates an asynchronous computation that runs generator. + + A cancellation check is performed when the computation is executed. + The function to run. + An asynchronous computation that runs generator. - - Indicates the relationship between the compiled entity and F# source code + + Creates an asynchronous computation that first runs computation1 + and then runs computation2, returning the result of computation2. + + A cancellation check is performed when the computation is executed. + + The existence of this method permits the use of expression sequencing in the + async { ... } computation expression syntax. + The first part of the sequenced computation. + The second part of the sequenced computation. + An asynchronous computation that runs both of the computations sequentially. - - Indicates the sequence number of the entity, if any, in a linear sequence of elements with F# source code + + Creates an asynchronous computation that runs computation, and when + computation generates a result T, runs binder res. + + A cancellation check is performed when the computation is executed. + + The existence of this method permits the use of let! in the + async { ... } computation expression syntax. + The computation to provide an unbound result. + The function to bind the result of computation. + An asynchronous computation that performs a monadic bind on the result + of computation. - - Indicates the resource the source construct relates to + + + Generate an object used to build asynchronous computations using F# computation expressions. The value + 'async' is a pre-defined instance of this type. + + A cancellation check is performed when the computation is executed. + - - Creates an instance of the attribute - Indicates the type definitions needed to resolve the source construct. - CompilationMappingAttribute + + The type of the async operator, used to build workflows for asynchronous computations. - - Creates an instance of the attribute - Indicates the type of source construct. - CompilationMappingAttribute + + The F# compiler emits calls to this function to implement F# async expressions. + + A value indicating asynchronous execution. - - Creates an instance of the attribute - Indicates the type of source construct. - CompilationMappingAttribute + + + Used by MailboxProcessor + - - Creates an instance of the attribute - Indicates the type of source construct. - CompilationMappingAttribute + + The F# compiler emits calls to this function to implement F# async expressions. + + A value indicating asynchronous execution. - - This attribute is inserted automatically by the F# compiler to tag types - and methods in the generated CLI code with flags indicating the correspondence - with original source constructs. It is used by the functions in the - Microsoft.FSharp.Reflection namespace to reverse-map compiled constructs to - their original forms. It is not intended for use from user code. + + The F# compiler emits calls to this function to implement F# async expressions. - - Indicates one or more adjustments to the compiled representation of an F# type or member + + The F# compiler emits calls to this function to implement F# async expressions. + + A value indicating asynchronous execution. - - Creates an instance of the attribute - Indicates adjustments to the compiled representation of the type or member. - CompilationRepresentationAttribute + + + Used by MailboxProcessor + - - This attribute is used to adjust the runtime representation for a type. - For example, it may be used to note that the null representation - may be used for a type. This affects how some constructs are compiled. + + The F# compiler emits references to this type to implement F# async expressions. - - Compile a property as a CLI event. + + The F# compiler emits references to this type to implement F# async expressions. - - Permit the use of null as a representation for nullary discriminators in a discriminated union. + + Gets the default cancellation token for executing asynchronous computations. + The default CancellationToken. - - append 'Module' to the end of a module whose name clashes with a type name in the same namespace. + + Creates an asynchronous computation that returns the CancellationToken governing the execution + of the computation. + In async { let! token = Async.CancellationToken ...} token can be used to initiate other + asynchronous operations that will cancel cooperatively with this workflow. + An asynchronous computation capable of retrieving the CancellationToken from a computation + expression. - - Compile a member as 'instance' even if null is used as a representation for this type. + + Creates an asynchronous computation that executes computation. + If this computation is cancelled before it completes then the computation generated by + running compensation is executed. + The input asynchronous computation. + The function to be run if the computation is cancelled. + An asynchronous computation that runs the compensation if the input computation + is cancelled. - - Compile an instance member as 'static' . + + Creates an asynchronous computation that queues a work item that runs + its continuation. + A computation that generates a new work item in the thread pool. - - No special compilation representation. + + Creates an asynchronous computation that creates a new thread and runs + its continuation in that thread. + A computation that will execute on a new thread. - - Indicates one or more adjustments to the compiled representation of an F# type or member. + + Creates an asynchronous computation that runs + its continuation using syncContext.Post. If syncContext is null + then the asynchronous computation is equivalent to SwitchToThreadPool(). + The synchronization context to accept the posted computation. + An asynchronous computation that uses the syncContext context to execute. - - Indicates the name of the entity in F# source code + + Runs an asynchronous computation, starting immediately on the current operating system + thread. Call one of the three continuations when the operation completes. + If no cancellation token is provided then the default cancellation token + is used. + The asynchronous computation to execute. + The function called on success. + The function called on exception. + The function called on cancellation. + The CancellationToken to associate with the computation. + The default is used if this parameter is not provided. - - Creates an instance of the attribute - The name of the method in source. - CompilationSourceNameAttribute + + Runs an asynchronous computation, starting immediately on the current operating system, + but also returns the execution as System.Threading.Tasks.Task + + If no cancellation token is provided then the default cancellation token is used. + You may prefer using this method if you want to achive a similar behviour to async await in C# as + async computation starts on the current thread with an ability to return a result. + + The asynchronous computation to execute. + The CancellationToken to associate with the computation. + The default is used if this parameter is not provided. + A System.Threading.Tasks.Task that will be completed + in the corresponding state once the computation terminates (produces the result, throws exception or gets canceled) - - This attribute is inserted automatically by the F# compiler to tag - methods which are given the 'CompiledName' attribute. It is not intended - for use from user code. + + Runs an asynchronous computation, starting immediately on the current operating system + thread. + If no cancellation token is provided then the default cancellation token is used. + The asynchronous computation to execute. + The CancellationToken to associate with the computation. + The default is used if this parameter is not provided. - - The name of the value as it appears in compiled code + + Creates an asynchronous computation which starts the given computation as a System.Threading.Tasks.Task - - Creates an instance of the attribute - The name to use in compiled code. - CompiledNameAttribute + + Starts a child computation within an asynchronous workflow. + This allows multiple asynchronous computations to be executed simultaneously. + + This method should normally be used as the immediate + right-hand-side of a let! binding in an F# asynchronous workflow, that is, + + async { ... + let! completor1 = childComputation1 |> Async.StartChild + let! completor2 = childComputation2 |> Async.StartChild + ... + let! result1 = completor1 + let! result2 = completor2 + ... } + + When used in this way, each use of StartChild starts an instance of childComputation + and returns a completor object representing a computation to wait for the completion of the operation. + When executed, the completor awaits the completion of childComputation. + The child computation. + The timeout value in milliseconds. If one is not provided + then the default value of -1 corresponding to System.Threading.Timeout.Infinite. + A new computation that waits for the input computation to finish. - - Adding this attribute to a value or function definition in an F# module changes the name used - for the value in compiled CLI code. + + Executes a computation in the thread pool. + If no cancellation token is provided then the default cancellation token is used. + A System.Threading.Tasks.Task that will be completed + in the corresponding state once the computation terminates (produces the result, throws exception or gets canceled) + - - Indicates if the construct should always be hidden in an editing environment. + + Starts the asynchronous computation in the thread pool. Do not await its result. + + If no cancellation token is provided then the default cancellation token is used. + The computation to run asynchronously. + The cancellation token to be associated with the computation. + If one is not supplied, the default cancellation token is used. - - Indicates if the message should indicate a compiler error. Error numbers less than - 10000 are considered reserved for use by the F# compiler and libraries. + + Creates an asynchronous computation that will sleep for the given time. This is scheduled + using a System.Threading.Timer object. The operation will not block operating system threads + for the duration of the wait. + The number of milliseconds to sleep. + An asynchronous computation that will sleep for the given time. + Thrown when the due time is negative + and not infinite. - - Indicates the number associated with the message. + + Creates an asynchronous computation that executes all the given asynchronous computations sequentially. + + If all child computations succeed, an array of results is passed to the success continuation. + + If any child computation raises an exception, then the overall computation will trigger an + exception, and cancel the others. + + The overall computation will respond to cancellation while executing the child computations. + If cancelled, the computation will cancel any remaining child computations but will still wait + for the other child computations to complete. + A sequence of distinct computations to be run in sequence. + A computation that returns an array of values from the sequence of input computations. - - Indicates the warning message to be emitted when F# source code uses this construct + + Runs the asynchronous computation and await its result. + + If an exception occurs in the asynchronous computation then an exception is re-raised by this + function. + + If no cancellation token is provided then the default cancellation token is used. + + The timeout parameter is given in milliseconds. A value of -1 is equivalent to + System.Threading.Timeout.Infinite. + The computation to run. + The amount of time in milliseconds to wait for the result of the + computation before raising a System.TimeoutException. If no value is provided + for timeout then a default of -1 is used to correspond to System.Threading.Timeout.Infinite. + If a cancellable cancellationToken is provided, timeout parameter will be ignored + The cancellation token to be associated with the computation. + If one is not supplied, the default cancellation token is used. + The result of the computation. - - Indicates if the construct should always be hidden in an editing environment. + + Creates an asynchronous computation that executes all the given asynchronous computations, + initially queueing each as work items and using a fork/join pattern. + + If all child computations succeed, an array of results is passed to the success continuation. + + If any child computation raises an exception, then the overall computation will trigger an + exception, and cancel the others. + + The overall computation will respond to cancellation while executing the child computations. + If cancelled, the computation will cancel any remaining child computations but will still wait + for the other child computations to complete. + A sequence of distinct computations to be parallelized. + A computation that returns an array of values from the sequence of input computations. - - Indicates if the message should indicate a compiler error. Error numbers less than - 10000 are considered reserved for use by the F# compiler and libraries. + + Creates an asynchronous computation that executes all the given asynchronous computations, + initially queueing each as work items and using a fork/join pattern. + + If all child computations succeed, an array of results is passed to the success continuation. + + If any child computation raises an exception, then the overall computation will trigger an + exception, and cancel the others. + + The overall computation will respond to cancellation while executing the child computations. + If cancelled, the computation will cancel any remaining child computations but will still wait + for the other child computations to complete. + A sequence of distinct computations to be parallelized. + A computation that returns an array of values from the sequence of input computations. - - Creates an instance of the attribute. + + Generates a scoped, cooperative cancellation handler for use within an asynchronous workflow. + + For example, + async { use! holder = Async.OnCancel interruption ... } + generates an asynchronous computation where, if a cancellation happens any time during + the execution of the asynchronous computation in the scope of holder, then action + interruption is executed on the thread that is performing the cancellation. This can + be used to arrange for a computation to be asynchronously notified that a cancellation + has occurred, e.g. by setting a flag, or deregistering a pending I/O action. + The function that is executed on the thread performing the + cancellation. + An asynchronous computation that triggers the interruption if it is cancelled + before being disposed. - - Indicates that a message should be emitted when F# source code uses this construct. + + Creates an asynchronous computation that runs the given computation and ignores + its result. + The input computation. + A computation that is equivalent to the input computation, but disregards the result. + + + Creates an asynchronous computation that captures the current + success, exception and cancellation continuations. The callback must + eventually call exactly one of the given continuations. + The function that accepts the current success, exception, and cancellation + continuations. + An asynchronous computation that provides the callback with the current continuations. + + + Creates an asynchronous computation in terms of a Begin/End pair of actions in + the style used in CLI APIs. This overload should be used if the operation is + qualified by three arguments. For example, + Async.FromBeginEnd(arg1,arg2,arg3,ws.BeginGetWeather,ws.EndGetWeather) + When the computation is run, beginFunc is executed, with + a callback which represents the continuation of the computation. + When the callback is invoked, the overall result is fetched using endFunc. + + The computation will respond to cancellation while waiting for the completion + of the operation. If a cancellation occurs, and cancelAction is specified, then it is + executed, and the computation continues to wait for the completion of the operation. + + If cancelAction is not specified, then cancellation causes the computation + to stop immediately, and subsequent invocations of the callback are ignored. + The first argument for the operation. + The second argument for the operation. + The third argument for the operation. + The function initiating a traditional CLI asynchronous operation. + The function completing a traditional CLI asynchronous operation. + An optional function to be executed when a cancellation is requested. + An asynchronous computation wrapping the given Begin/End functions. - - Creates an instance of the attribute - CustomComparisonAttribute + + Creates an asynchronous computation in terms of a Begin/End pair of actions in + the style used in CLI APIs. This overload should be used if the operation is + qualified by two arguments. For example, + Async.FromBeginEnd(arg1,arg2,ws.BeginGetWeather,ws.EndGetWeather) + When the computation is run, beginFunc is executed, with + a callback which represents the continuation of the computation. + When the callback is invoked, the overall result is fetched using endFunc. + + The computation will respond to cancellation while waiting for the completion + of the operation. If a cancellation occurs, and cancelAction is specified, then it is + executed, and the computation continues to wait for the completion of the operation. + + If cancelAction is not specified, then cancellation causes the computation + to stop immediately, and subsequent invocations of the callback are ignored. + The first argument for the operation. + The second argument for the operation. + The function initiating a traditional CLI asynchronous operation. + The function completing a traditional CLI asynchronous operation. + An optional function to be executed when a cancellation is requested. + An asynchronous computation wrapping the given Begin/End functions. - - Adding this attribute to a type indicates it is a type with a user-defined implementation of comparison. + + Creates an asynchronous computation in terms of a Begin/End pair of actions in + the style used in CLI APIs. This overload should be used if the operation is + qualified by one argument. For example, + Async.FromBeginEnd(place,ws.BeginGetWeather,ws.EndGetWeather) + When the computation is run, beginFunc is executed, with + a callback which represents the continuation of the computation. + When the callback is invoked, the overall result is fetched using endFunc. + + The computation will respond to cancellation while waiting for the completion + of the operation. If a cancellation occurs, and cancelAction is specified, then it is + executed, and the computation continues to wait for the completion of the operation. + + If cancelAction is not specified, then cancellation causes the computation + to stop immediately, and subsequent invocations of the callback are ignored. + The argument for the operation. + The function initiating a traditional CLI asynchronous operation. + The function completing a traditional CLI asynchronous operation. + An optional function to be executed when a cancellation is requested. + An asynchronous computation wrapping the given Begin/End functions. - - Creates an instance of the attribute - CustomEqualityAttribute + + Creates an asynchronous computation in terms of a Begin/End pair of actions in + the style used in CLI APIs. For example, + Async.FromBeginEnd(ws.BeginGetWeather,ws.EndGetWeather) + When the computation is run, beginFunc is executed, with + a callback which represents the continuation of the computation. + When the callback is invoked, the overall result is fetched using endFunc. + + The computation will respond to cancellation while waiting for the completion + of the operation. If a cancellation occurs, and cancelAction is specified, then it is + executed, and the computation continues to wait for the completion of the operation. + + If cancelAction is not specified, then cancellation causes the computation + to stop immediately, and subsequent invocations of the callback are ignored. + The function initiating a traditional CLI asynchronous operation. + The function completing a traditional CLI asynchronous operation. + An optional function to be executed when a cancellation is requested. + An asynchronous computation wrapping the given Begin/End functions. - - Adding this attribute to a type indicates it is a type with a user-defined implementation of equality. + + Creates an asynchronous computation that executes all given asynchronous computations in parallel, + returning the result of the first succeeding computation (one whose result is 'Some x'). + If all child computations complete with None, the parent computation also returns None. + + + If any child computation raises an exception, then the overall computation will trigger an + exception, and cancel the others. + + The overall computation will respond to cancellation while executing the child computations. + If cancelled, the computation will cancel any remaining child computations but will still wait + for the other child computations to complete. + A sequence of computations to be parallelized. + A computation that returns the first succeeding computation. - - Indicates if the custom operation maintains the variable space of the query of computation expression through the use of a bind operation + + Creates an asynchronous computation that executes computation. + If this computation completes successfully then return Choice1Of2 with the returned + value. If this computation raises an exception before it completes then return Choice2Of2 + with the raised exception. + The input computation that returns the type T. + A computation that returns a choice of type T or exception. - - Indicates if the custom operation maintains the variable space of the query of computation expression + + Raises the cancellation condition for the most recent set of asynchronous computations started + without any specific CancellationToken. Replaces the global CancellationTokenSource with a new + global token source for any asynchronous computations created after this point without any + specific CancellationToken. - - Indicates the name used for the 'on' part of the custom query operator for join-like operators + + Creates an asynchronous computation that will wait on the given WaitHandle. + + The computation returns true if the handle indicated a result within the given timeout. + The WaitHandle that can be signalled. + The timeout value in milliseconds. If one is not provided + then the default value of -1 corresponding to System.Threading.Timeout.Infinite. + An asynchronous computation that waits on the given WaitHandle. - - Indicates if the custom operation is an operation similar to a zip in a sequence computation, supporting two inputs + + + Return an asynchronous computation that will wait for the given task to complete and return + its result. + - - Indicates if the custom operation is an operation similar to a join in a sequence computation, supporting two inputs and a correlation constraint + + + Return an asynchronous computation that will wait for the given task to complete and return + its result. + - - Indicates if the custom operation is an operation similar to a group join in a sequence computation, supporting two inputs and a correlation constraint, and generating a group + + Creates an asynchronous computation that will wait on the IAsyncResult. + + The computation returns true if the handle indicated a result within the given timeout. + The IAsyncResult to wait on. + The timeout value in milliseconds. If one is not provided + then the default value of -1 corresponding to System.Threading.Timeout.Infinite. + An asynchronous computation that waits on the given IAsyncResult. - - Indicates if the custom operation supports the use of 'into' immediately after the use of the operation in a query or other computation expression to consume the results of the operation + + Creates an asynchronous computation that waits for a single invocation of a CLI + event by adding a handler to the event. Once the computation completes or is + cancelled, the handler is removed from the event. + + The computation will respond to cancellation while waiting for the event. If a + cancellation occurs, and cancelAction is specified, then it is executed, and + the computation continues to wait for the event. + + If cancelAction is not specified, then cancellation causes the computation + to cancel immediately. + The event to handle once. + An optional function to execute instead of cancelling when a + cancellation is issued. + An asynchronous computation that waits for the event to be invoked. - - Get the name of the custom operation when used in a query or other computation expression + + Creates three functions that can be used to implement the .NET Asynchronous + Programming Model (APM) for a given asynchronous computation. + + The functions should normally be published as members with prefix Begin, + End and Cancel, and can be used within a type definition as follows: + + let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun arg -> computation) + member x.BeginSomeOperation(arg,callback,state:obj) = beginAction(arg,callback,state) + member x.EndSomeOperation(iar) = endAction(iar) + member x.CancelSomeOperation(iar) = cancelAction(iar) + + + If the asynchronous computation takes no arguments, then AsBeginEnd is used as follows: + + let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun () -> computation) + member x.BeginSomeOperation(callback,state:obj) = beginAction((),callback,state) + member x.EndSomeOperation(iar) = endAction(iar) + member x.CancelSomeOperation(iar) = cancelAction(iar) + + + + If the asynchronous computation takes two arguments, then AsBeginEnd is used as follows: + + let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun arg1 arg2 -> computation) + member x.BeginSomeOperation(arg1,arg2,callback,state:obj) = beginAction((),callback,state) + member x.EndSomeOperation(iar) = endAction(iar) + member x.CancelSomeOperation(iar) = cancelAction(iar) + + + In each case, the resulting API will be familiar to programmers in other CLI languages and + is a useful way to publish asynchronous computations in CLI components. + A function generating the asynchronous computation to split into the traditional + .NET Asynchronous Programming Model. + A tuple of the begin, end, and cancel members. - - Indicates if the custom operation maintains the variable space of the query of computation expression through the use of a bind operation + + This static class holds members for creating and manipulating asynchronous computations. - - Indicates if the custom operation maintains the variable space of the query of computation expression + + A compositional asynchronous computation, which, when run, will eventually produce a value + of type T, or else raises an exception. + + Asynchronous computations are normally specified using an F# computation expression. + + When run, asynchronous computations have two modes: as a work item (executing synchronous + code), or as a wait item (waiting for an event or I/O completion). + + When run, asynchronous computations can be governed by CancellationToken. This can usually + be specified when the async computation is started. The associated CancellationTokenSource + may be used to cancel the asynchronous computation. Asynchronous computations built using + computation expressions can check the cancellation condition regularly. Synchronous + computations within an asynchronous computation do not automatically check this condition. - - Indicates the name used for the 'on' part of the custom query operator for join-like operators + + Raises a timeout exception if a message not received in this amount of time. By default + no timeout is used. - - Indicates if the custom operation is an operation similar to a zip in a sequence computation, supporting two inputs + + Occurs when the execution of the agent results in an exception. - - Indicates if the custom operation is an operation similar to a join in a sequence computation, supporting two inputs and a correlation constraint + + Occurs when the execution of the agent results in an exception. - - Indicates if the custom operation is an operation similar to a group join in a sequence computation, supporting two inputs and a correlation constraint, and generating a group + + Raises a timeout exception if a message not received in this amount of time. By default + no timeout is used. - - Indicates if the custom operation supports the use of 'into' immediately after the use of the operation in a query or other computation expression to consume the results of the operation + + Returns the number of unprocessed messages in the message queue of the agent. - - Creates an instance of the attribute - CustomOperationAttribute + + Occurs when the execution of the agent results in an exception. - - - Indicates that a member on a computation builder type is a custom query operator, - and indicates the name of that operator. - + + Scans for a message by looking through messages in arrival order until scanner + returns a Some value. Other messages remain in the queue. + + This method is for use within the body of the agent. For each agent, at most + one concurrent reader may be active, so no more than one concurrent call to + Receive, TryReceive, Scan and/or TryScan may be active. + The function to return None if the message is to be skipped + or Some if the message is to be processed and removed from the queue. + An optional timeout in milliseconds. Defaults to -1 which corresponds + to System.Threading.Timeout.Infinite. + An asynchronous computation that scanner built off the read message. - - The value of the attribute, indicating whether the type has a default augmentation or not + + Waits for a message. This will consume the first message in arrival order. + + This method is for use within the body of the agent. + + Returns None if a timeout is given and the timeout is exceeded. + + This method is for use within the body of the agent. For each agent, at most + one concurrent reader may be active, so no more than one concurrent call to + Receive, TryReceive, Scan and/or TryScan may be active. + An optional timeout in milliseconds. Defaults to -1 which + corresponds to System.Threading.Timeout.Infinite. + An asynchronous computation that returns the received message or + None if the timeout is exceeded. - - Creates an instance of the attribute - Indicates whether to generate helper members on the CLI class representing a discriminated - union. - DefaultAugmentationAttribute + + Like PostAndReply, but returns None if no reply within the timeout period. + The function to incorporate the AsyncReplyChannel into + the message to be sent. + An optional timeout parameter (in milliseconds) to wait for a reply message. + Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. + The reply from the agent or None if the timeout expires. - - Adding this attribute to a discriminated union with value false - turns off the generation of standard helper member tester, constructor - and accessor members for the generated CLI class for that type. + + Starts the agent. - - Indicates if a constraint is asserted that the field type supports 'null' + + Creates and starts an agent. The body function is used to generate the asynchronous + computation executed by the agent. + The function to produce an asynchronous computation that will be executed + as the read loop for the MailboxProcessor when Start is called. + An optional cancellation token for the body. + Defaults to Async.DefaultCancellationToken. + The created MailboxProcessor. - - Creates an instance of the attribute - Indicates whether to assert that the field type supports null. - DefaultValueAttribute + + Scans for a message by looking through messages in arrival order until scanner + returns a Some value. Other messages remain in the queue. + + Returns None if a timeout is given and the timeout is exceeded. + + This method is for use within the body of the agent. For each agent, at most + one concurrent reader may be active, so no more than one concurrent call to + Receive, TryReceive, Scan and/or TryScan may be active. + The function to return None if the message is to be skipped + or Some if the message is to be processed and removed from the queue. + An optional timeout in milliseconds. Defaults to -1 which corresponds + to System.Threading.Timeout.Infinite. + An asynchronous computation that scanner built off the read message. + Thrown when the timeout is exceeded. - - Creates an instance of the attribute - DefaultValueAttribute + + Waits for a message. This will consume the first message in arrival order. + + This method is for use within the body of the agent. + + This method is for use within the body of the agent. For each agent, at most + one concurrent reader may be active, so no more than one concurrent call to + Receive, TryReceive, Scan and/or TryScan may be active. + An optional timeout in milliseconds. Defaults to -1 which corresponds + to System.Threading.Timeout.Infinite. + An asynchronous computation that returns the received message. + Thrown when the timeout is exceeded. - - Adding this attribute to a field declaration means that the field is - not initialized. During type checking a constraint is asserted that the field type supports 'null'. - If the 'check' value is false then the constraint is not asserted. + + Like AsyncPostAndReply, but returns None if no reply within the timeout period. + The function to incorporate the AsyncReplyChannel into + the message to be sent. + An optional timeout parameter (in milliseconds) to wait for a reply message. + Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. + An asynchronous computation that will return the reply or None if the timeout expires. - - Creates an instance of the attribute - EntryPointAttribute + + Posts a message to an agent and await a reply on the channel, synchronously. + + The message is generated by applying buildMessage to a new reply channel + to be incorporated into the message. The receiving agent must process this + message and invoke the Reply method on this reply channel precisely once. + The function to incorporate the AsyncReplyChannel into + the message to be sent. + An optional timeout parameter (in milliseconds) to wait for a reply message. + Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. + The reply from the agent. - - Adding this attribute to a function indicates it is the entrypoint for an application. - If this attribute is not specified for an EXE then the initialization implicit in the - module bindings in the last file in the compilation sequence are used as the entrypoint. + + Posts a message to an agent and await a reply on the channel, asynchronously. + + The message is generated by applying buildMessage to a new reply channel + to be incorporated into the message. The receiving agent must process this + message and invoke the Reply method on this reply channel precisely once. + The function to incorporate the AsyncReplyChannel into + the message to be sent. + An optional timeout parameter (in milliseconds) to wait for a reply message. + Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. + An asynchronous computation that will wait for the reply from the agent. - - Creates an instance of the attribute - EqualityConditionalOnAttribute + + Posts a message to the message queue of the MailboxProcessor, asynchronously. + The message to post. - - This attribute is used to indicate a generic container type satisfies the F# 'equality' - constraint only if a generic argument also satisfies this constraint. For example, adding - this attribute to parameter 'T on a type definition C<'T> means that a type C<X> only supports - equality if the type X also supports equality and all other conditions for C<X> to support - equality are also met. The type C<'T> can still be used with other type arguments, but a type such - as C<(int -> int)> will not support equality because the type (int -> int) is an F# function type - and does not support equality. - - This attribute will be ignored if it is used on the generic parameters of functions or methods. + + Creates an agent. The body function is used to generate the asynchronous + computation executed by the agent. This function is not executed until + Start is called. + The function to produce an asynchronous computation that will be executed + as the read loop for the MailboxProcessor when Start is called. + An optional cancellation token for the body. + Defaults to Async.DefaultCancellationToken. + The created MailboxProcessor. - - Indicates the warning message to be emitted when F# source code uses this construct + + A message-processing agent which executes an asynchronous computation. + + The agent encapsulates a message queue that supports multiple-writers and + a single reader agent. Writers send messages to the agent by using the Post + method and its variations. + + The agent may wait for messages using the Receive or TryReceive methods or + scan through all available messages using the Scan or TryScan method. - - Creates an instance of the attribute - The warning message to be emitted when code uses this construct. - ExperimentalAttribute + + Sends a reply to a PostAndReply message. + The value to send. - - This attribute is used to tag values that are part of an experimental library - feature. + + A handle to a capability to reply to a PostAndReply message. - - Convert an value of type System.Converter to a F# first class function value - The input System.Converter. - An F# function of the same type. + + Forces the execution of this value and return its result. Same as Value. Mutual exclusion is used to + prevent other threads also computing the value. + The value of the Lazy object. - - Convert an F# first class function value to a value of type System.Converter - The input function. - A System.Converter of the function type. + + Creates a lazy computation that evaluates to the given value when forced. + The input value. + The created Lazy object. - - Convert an F# first class function value to a value of type System.Converter - The input function. - System.Converter<'T,'U> + + Creates a lazy computation that evaluates to the result of the given function when forced. + The function to provide the value when needed. + The created Lazy object. - - Invoke an F# first class function value with two curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The function result. + + Extensions related to Lazy values. - - Invoke an F# first class function value with three curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The third arg. - The function result. + + Returns an asynchronous computation that, when run, will wait for the download of the given URI to specified file. + The URI to retrieve. + The filename to save download to. + An asynchronous computation that will wait for the download of the URI to specified file. - - Invoke an F# first class function value with four curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The third arg. - The fourth arg. - The function result. + + Returns an asynchronous computation that, when run, will wait for the download of the given URI. + The URI to retrieve. + An asynchronous computation that will wait for the download of the URI. - - Invoke an F# first class function value with five curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The third arg. - The fourth arg. - The fifth arg. - The function result. + + Returns an asynchronous computation that, when run, will wait for the download of the given URI. + The URI to retrieve. + An asynchronous computation that will wait for the download of the URI. - - Invoke an F# first class function value with one argument - - 'U + + Returns an asynchronous computation that, when run, will wait for a response to the given WebRequest. + An asynchronous computation that waits for response to the WebRequest. - - Convert an value of type System.Converter to a F# first class function value - The input System.Converter. - An F# function of the same type. + + A module of extension members providing asynchronous operations for some basic Web operations. - - Construct an instance of an F# first class function value - The created F# function. + + Connects a listener function to the observable. The listener will + be invoked for each observation. The listener can be removed by + calling Dispose on the returned IDisposable object. + The function to be called for each observation. + An object that will remove the listener if disposed. - - The CLI type used to represent F# function values. This type is not - typically used directly, though may be used from other CLI languages. + + Permanently connects a listener function to the observable. The listener will + be invoked for each observation. + The function to be called for each observation. - - The release number of the F# version associated with the attribute + + Returns an asynchronous computation that will write the given bytes to the stream. + The buffer to write from. + An optional offset as a number of bytes in the stream. + An optional number of bytes to write to the stream. + An asynchronous computation that will write the given bytes to the stream. + Thrown when the sum of offset and count is longer than + the buffer length. + Thrown when offset or count is negative. - - The minor version number of the F# version associated with the attribute + + Returns an asynchronous computation that will read the given number of bytes from the stream. + The number of bytes to read. + An asynchronous computation that returns the read byte[] when run. - - The major version number of the F# version associated with the attribute + + Returns an asynchronous computation that will read from the stream into the given buffer. + The buffer to read into. + An optional offset as a number of bytes in the stream. + An optional number of bytes to read from the stream. + An asynchronous computation that will read from the stream into the given buffer. + Thrown when the sum of offset and count is longer than + the buffer length. + Thrown when offset or count is negative. - - Creates an instance of the attribute - The major version number. - The minor version number. - The release number. - FSharpInterfaceDataVersionAttribute + + A module of extension members providing asynchronous operations for some basic CLI types related to concurrency and I/O. - - This attribute is added to generated assemblies to indicate the - version of the data schema used to encode additional F# - specific information in the resource attached to compiled F# libraries. + + The F# compiler emits calls to this function to implement the try/with construct for F# async expressions. + + The async activation. + The computation to protect. + The exception filter. + + A value indicating asynchronous execution. - - Specialize the type function at a given type - The specialized type. + + The F# compiler emits calls to this function to implement the try/finally construct for F# async expressions. + + The async activation. + The computation to protect. + The finally code. + + A value indicating asynchronous execution. - - Construct an instance of an F# first class type function value - FSharpTypeFunc + + The F# compiler emits calls to this function to implement the let! construct for F# async expressions. + + The async activation. + A function returning the second part of the computation. + + An async activation suitable for running part1 of the asynchronous execution. - - The CLI type used to represent F# first-class type function values. This type is for use - by compiled F# code. + + The F# compiler emits calls to this function to implement constructs for F# async expressions. + + The async activation. + The result of the first part of the computation. + A function returning the second part of the computation. + + A value indicating asynchronous execution. - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) + + The F# compiler emits calls to this function to implement constructs for F# async expressions. + + The async computation. + The async activation. + + A value indicating asynchronous execution. - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - Tuple of values generated by scan or match. + + The F# compiler emits calls to this function to implement F# async expressions. + + The body of the async computation. + + The async computation. - - Convert the given Converter delegate object to an F# function value - The input Converter. - The F# function. + + Entry points for generated code - - Convert the given Action delegate object to an F# function value - The input action. - The F# function. + + Returns a new event that triggers on the second and subsequent triggerings of the input event. + The Nth triggering of the input event passes the arguments from the N-1th and Nth triggering as + a pair. The argument passed to the N-1th triggering is held in hidden internal state until the + Nth triggering occurs. + The input event. + An event that triggers on pairs of consecutive values passed from the source event. - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. + + Runs the given function each time the given event is triggered. + The function to call when the event is triggered. + The input event. - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. + + Returns a new event consisting of the results of applying the given accumulating function + to successive values triggered on the input event. An item of internal state + records the current value of the state parameter. The internal state is not locked during the + execution of the accumulation function, so care should be taken that the + input IEvent not triggered by multiple threads simultaneously. + The function to update the state with each event value. + The initial state. + The input event. + An event that fires on the updated state values. - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. + + Returns a new event which fires on a selection of messages from the original event. + The selection function takes an original message to an optional new message. + The function to select and transform event values to pass on. + The input event. + An event that fires only when the chooser returns Some. - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. + + Returns a new event that listens to the original event and triggers the + first resulting event if the application of the function to the event arguments + returned a Choice1Of2, and the second event if it returns a Choice2Of2. + The function to transform event values into one of two types. + The input event. + A tuple of events. The first fires whenever splitter evaluates to Choice1of1 and + the second fires whenever splitter evaluates to Choice2of2. - - Helper functions for converting F# first class function values to and from CLI representaions - of functions using delegates. + + Returns a new event that listens to the original event and triggers the + first resulting event if the application of the predicate to the event arguments + returned true, and the second event if it returned false. + The function to determine which output event to trigger. + The input event. + A tuple of events. The first is triggered when the predicate evaluates to true + and the second when the predicate evaluates to false. - - Creates an instance of the attribute - GeneralizableValueAttribute + + Returns a new event that listens to the original event and triggers the resulting + event only when the argument to the event passes the given function. + The function to determine which triggers from the event to propagate. + The input event. + An event that only passes values that pass the predicate. - - Adding this attribute to a non-function value with generic parameters indicates that - uses of the construct can give rise to generic code through type inference. + + Returns a new event that passes values transformed by the given function. + The function to transform event values. + The input event. + An event that passes the transformed values. - - Creates an instance of the attribute - InterfaceAttribute + + Fires the output event when either of the input events fire. + The first input event. + The second input event. + An event that fires when either of the input events fire. - - Adding this attribute to a type causes it to be represented using a CLI interface. + + Returns a new observable that triggers on the second and subsequent triggerings of the input observable. + The Nth triggering of the input observable passes the arguments from the N-1th and Nth triggering as + a pair. The argument passed to the N-1th triggering is held in hidden internal state until the + Nth triggering occurs. + + For each observer, the registered intermediate observing object is not thread safe. + That is, observations arising from the source must not be triggered concurrently + on different threads. + The input Observable. + An Observable that triggers on successive pairs of observations from the input Observable. - - Creates an instance of the attribute - LiteralAttribute + + Creates an observer which subscribes to the given observable and which calls + the given function for each observation. + The function to be called on each observation. + The input Observable. + An object that will remove the callback if disposed. - - Adding this attribute to a value causes it to be compiled as a CLI constant literal. + + Creates an observer which permanently subscribes to the given observable and which calls + the given function for each observation. + The function to be called on each observation. + The input Observable. - - Creates an instance of the attribute - MeasureAnnotatedAbbreviationAttribute + + Returns an observable which, for each observer, allocates an item of state + and applies the given accumulating function to successive values arising from + the input. The returned object will trigger observations for each computed + state value, excluding the initial value. The returned object propagates + all errors arising from the source and completes when the source completes. + + For each observer, the registered intermediate observing object is not thread safe. + That is, observations arising from the source must not be triggered concurrently + on different threads. + The function to update the state with each observation. + The initial state. + The input Observable. + An Observable that triggers on the updated state values. - - Adding this attribute to a type causes it to be interpreted as a refined type, currently limited to measure-parameterized types. - This may only be used under very limited conditions. + + Returns an observable which chooses a projection of observations from the source + using the given function. The returned object will trigger observations x + for which the splitter returns Some x. The returned object also propagates + all errors arising from the source and completes when the source completes. + The function that returns Some for observations to be propagated + and None for observations to ignore. + The input Observable. + An Observable that only propagates some of the observations from the source. - - Creates an instance of the attribute - MeasureAttribute + + Returns two observables which split the observations of the source by the + given function. The first will trigger observations x for which the + splitter returns Choice1Of2 x. The second will trigger observations + y for which the splitter returns Choice2Of2 y The splitter is + executed once for each subscribed observer. Both also propagate error + observations arising from the source and each completes when the source + completes. + The function that takes an observation an transforms + it into one of the two output Choice types. + The input Observable. + A tuple of Observables. The first triggers when splitter returns Choice1of2 + and the second triggers when splitter returns Choice2of2. - - Adding this attribute to a type causes it to be interpreted as a unit of measure. - This may only be used under very limited conditions. + + Returns two observables which partition the observations of the source by + the given function. The first will trigger observations for those values + for which the predicate returns true. The second will trigger observations + for those values where the predicate returns false. The predicate is + executed once for each subscribed observer. Both also propagate all error + observations arising from the source and each completes when the source + completes. + The function to determine which output Observable will trigger + a particular observation. + The input Observable. + A tuple of Observables. The first triggers when the predicate returns true, and + the second triggers when the predicate returns false. - - Creates an instance of the attribute - NoComparisonAttribute + + Returns an observable which filters the observations of the source + by the given function. The observable will see only those observations + for which the predicate returns true. The predicate is executed once for + each subscribed observer. The returned object also propagates error + observations arising from the source and completes when the source completes. + The function to apply to observations to determine if it should + be kept. + The input Observable. + An Observable that filters observations based on filter. - - Adding this attribute to a type indicates it is a type where comparison is an abnormal operation. - This means that the type does not satisfy the F# 'comparison' constraint. Within the bounds of the - F# type system, this helps ensure that the F# generic comparison function is not instantiated directly - at this type. The attribute and checking does not constrain the use of comparison with base or child - types of this type. + + Returns an observable which transforms the observations of the source by the + given function. The transformation function is executed once for each + subscribed observer. The returned object also propagates error observations + arising from the source and completes when the source completes. + The function applied to observations from the source. + The input Observable. + An Observable of the type specified by mapping. - - Creates an instance of the attribute - NoDynamicInvocationAttribute + + Returns an observable for the merged observations from the sources. + The returned object propagates success and error values arising + from either source and completes when both the sources have completed. + + For each observer, the registered intermediate observing object is not + thread safe. That is, observations arising from the sources must not + be triggered concurrently on different threads. + The first Observable. + The second Observable. + An Observable that propagates information from both sources. - - This attribute is used to tag values that may not be dynamically invoked at runtime. This is - typically added to inlined functions whose implementations include unverifiable code. It - causes the method body emitted for the inlined function to raise an exception if - dynamically invoked, rather than including the unverifiable code in the generated - assembly. + + Basic operations on first class event and other observable objects. - - Creates an instance of the attribute - NoEqualityAttribute + + + A method used to support the F# query syntax. Returns an empty sequence that has the specified type argument. + - - Adding this attribute to a type indicates it is a type where equality is an abnormal operation. - This means that the type does not satisfy the F# 'equality' constraint. Within the bounds of the - F# type system, this helps ensure that the F# generic equality function is not instantiated directly - at this type. The attribute and checking does not constrain the use of comparison with base or child - types of this type. + + + A method used to support the F# query syntax. Returns a sequence that contains the specified values. + - - The representation of "Value of type 'T" - The input value. - An option representing the value. + + + A method used to support the F# query syntax. Returns a sequence of length one that contains the specified value. + - - The representation of "No value" + + A query operator that selects those elements based on a specified predicate. + - - Get the value of a 'Some' option. A NullReferenceException is raised if the option is 'None'. + + A query operator that performs a subsequent ordering of the elements selected so far in descending order by the given nullable sorting key. + This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. + - - Create an option value that is a 'None' value. + + A query operator that performs a subsequent ordering of the elements selected so far in ascending order by the given nullable sorting key. + This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. + - - Return 'true' if the option is a 'Some' value. + + A query operator that performs a subsequent ordering of the elements selected so far in descending order by the given sorting key. + This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. + - - Return 'true' if the option is a 'None' value. + + A query operator that performs a subsequent ordering of the elements selected so far in ascending order by the given sorting key. + This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. + - - Create an option value that is a 'Some' value. - The input value - An option representing the value. + + A query operator that selects elements from a sequence as long as a specified condition is true, and then skips the remaining elements. + - - The type of optional values. When used from other CLI languages the - empty option is the null value. - - Use the constructors Some and None to create values of this type. - Use the values in the Option module to manipulate values of this type, - or pattern match against the values directly. - - None values will appear as the value null to other CLI languages. - Instance methods on this type will appear as static methods to other CLI languages - due to the use of null as a value representation. + + A query operator that selects a specified number of contiguous elements from those selected so far. + - - Creates an instance of the attribute - OptionalArgumentAttribute + + A query operator that selects a nullable value for each element selected so far and returns the sum of these values. + If any nullable does not have a value, it is ignored. + - - This attribute is added automatically for all optional arguments. + + A query operator that selects a value for each element selected so far and returns the sum of these values. + - - The raw text of the format string. + + + A method used to support the F# query syntax. Inputs to queries are implicitly wrapped by a call to one of the overloads of this method. + - - Construct a format string - The input string. - The PrintfFormat containing the formatted result. + + + A method used to support the F# query syntax. Inputs to queries are implicitly wrapped by a call to one of the overloads of this method. + - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) + + A query operator that sorts the elements selected so far in descending order by the given nullable sorting key. + - - Construct a format string - The input string. - The created format string. + + A query operator that sorts the elements selected so far in ascending order by the given nullable sorting key. + - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - Tuple of values generated by scan or match. + + A query operator that sorts the elements selected so far in descending order by the given sorting key. + - - Creates an instance of the attribute - ProjectionParameterAttribute + + A query operator that sorts the elements selected so far in ascending order by the given sorting key. + - - Indicates that, when a custom operator is used in a computation expression, - a parameter is automatically parameterized by the variable space of the computation expression + + A query operator that bypasses elements in a sequence as long as a specified condition is true and then selects the remaining elements. + - - - The current value of the reference cell - + + A query operator that bypasses a specified number of the elements selected so far and selects the remaining elements. + - - The current value of the reference cell + + A query operator that projects each of the elements selected so far. + - - The current value of the reference cell + + + A method used to support the F# query syntax. Runs the given quotation as a query using LINQ IQueryable rules. + - - The type of mutable references. Use the functions [:=] and [!] to get and - set values of this type. + + + A method used to support the F# query syntax. Indicates that the query should be passed as a quotation to the Run method. + - - Creates an instance of the attribute - ReferenceEqualityAttribute + + A query operator that selects the element at a specified index amongst those selected so far. + - - Adding this attribute to a record or union type disables the automatic generation - of overrides for 'System.Object.Equals(obj)', 'System.Object.GetHashCode()' - and 'System.IComparable' for the type. The type will by default use reference equality. + + A query operator that selects a nullable value for each element selected so far and returns the minimum of these values. + If any nullable does not have a value, it is ignored. + - - The value of the attribute, indicating whether to include the evaluated value of the definition as the outer node of the quotation + + A query operator that selects a value for each element selected so far and returns the minimum resulting value. + - - Creates an instance of the attribute - Indicates whether to include the evaluated value of the definition as the outer node of the quotation - ReflectedDefinitionAttribute + + A query operator that selects a nullable value for each element selected so far and returns the maximum of these values. + If any nullable does not have a value, it is ignored. + - - Creates an instance of the attribute - ReflectedDefinitionAttribute + + A query operator that selects a value for each element selected so far and returns the maximum resulting value. + - - Adding this attribute to the let-binding for the definition of a top-level - value makes the quotation expression that implements the value available - for use at runtime. + + A query operator that correlates two sets of selected values based on matching keys and groups the results. + If any group is empty, a group with a single default value is used instead. + Normal usage is 'leftOuterJoin y in elements2 on (key1 = key2) into group'. + - - Creates an instance of the attribute - RequireQualifiedAccessAttribute + + A query operator that selects the last element of those selected so far, or a default value if no element is found. + - - This attribute is used to indicate that references to the elements of a module, record or union - type require explicit qualified access. + + A query operator that selects the last element of those selected so far. + - - Creates an instance of the attribute - RequiresExplicitTypeArgumentsAttribute + + A query operator that correlates two sets of selected values based on matching keys. + Normal usage is 'join y in elements2 on (key1 = key2)'. + - - Adding this attribute to a type, value or member requires that - uses of the construct must explicitly instantiate any generic type parameters. + + A query operator that selects the first element of those selected so far, or a default value if the sequence contains no elements. + - - The value of the attribute, indicating whether the type is sealed or not. + + A query operator that selects the first element from those selected so far. + - - Creates an instance of the attribute - Indicates whether the class is sealed. - SealedAttribute + + A query operator that selects a value for each element selected so far and groups the elements by the given key. + - - Creates an instance of the attribute. - The created attribute. + + A query operator that correlates two sets of selected values based on matching keys and groups the results. + Normal usage is 'groupJoin y in elements2 on (key1 = key2) into group'. + - - Adding this attribute to class definition makes it sealed, which means it may not - be extended or implemented. + + A query operator that groups the elements selected so far according to a specified key selector. + - - Indicates that the compiled entity had private or internal representation in F# source code. + + + A method used to support the F# query syntax. Projects each element of a sequence to another sequence and combines the resulting sequences into one sequence. + - - The mask of values related to the kind of the compiled entity. + + A query operator that selects the first element selected so far that satisfies a specified condition. + - - Indicates that the compiled entity is part of the representation of an F# value declaration. + + A query operator that determines whether any element selected so far satisfies a condition. + - - Indicates that the compiled entity is part of the representation of an F# union case declaration. + + A query operator that selects the single, specific element of those selected so far, or a default value if that element is not found. + - - Indicates that the compiled entity is part of the representation of an F# module declaration. + + A query operator that selects the single, specific element selected so far + - - Indicates that the compiled entity is part of the representation of an F# closure. + + A query operator that selects distinct elements from the elements selected so far. + - - Indicates that the compiled entity is part of the representation of an F# exception declaration. + + A query operator that returns the number of selected elements. + - - Indicates that the compiled entity is part of the representation of an F# record or union case field declaration. + + A query operator that determines whether the selected elements contains a specified element. + - - Indicates that the compiled entity is part of the representation of an F# class or other object type declaration. + + A query operator that selects a nullable value for each element selected so far and returns the average of these values. + If any nullable does not have a value, it is ignored. + - - Indicates that the compiled entity is part of the representation of an F# record type declaration. + + A query operator that selects a value for each element selected so far and returns the average of these values. + - - Indicates that the compiled entity is part of the representation of an F# union type declaration. + + A query operator that determines whether all elements selected so far satisfies a condition. + - - Indicates that the compiled entity has no relationship to an element in F# source code. + + Create an instance of this builder. Use 'query { ... }' to use the query syntax. - - Indicates the relationship between a compiled entity in a CLI binary and an element in F# source code. + + + The type used to support the F# query syntax. Use 'query { ... }' to use the query syntax. + - - Creates an instance of the attribute - StructAttribute + + + A property used to support the F# query syntax. + - - Adding this attribute to a type causes it to be represented using a CLI struct. + + + A method used to support the F# query syntax. + - - Creates an instance of the attribute - StructuralComparisonAttribute + + + A partial input or result in an F# query. This type is used to support the F# query syntax. + - - Adding this attribute to a record, union, exception, or struct type confirms the - automatic generation of implementations for 'System.IComparable' for the type. + + Converts the argument to character. Numeric inputs are converted according to the UTF-16 + encoding for characters. The operation requires an appropriate static conversion method on the input type. + The input value. + The converted char. - - Creates an instance of the attribute - StructuralEqualityAttribute + + Converts the argument to System.Decimal using a direct conversion for all + primitive numeric types. The operation requires an appropriate + static conversion method on the input type. + The input value. + The converted decimal. - - Adding this attribute to a record, union or struct type confirms the automatic - generation of overrides for 'System.Object.Equals(obj)' and - 'System.Object.GetHashCode()' for the type. + + Converts the argument to unsigned native integer using a direct conversion for all + primitive numeric types. Otherwise the operation requires an appropriate + static conversion method on the input type. + The input value. + The converted unativeint - - Indicates the text to display by default when objects of this type are displayed - using '%A' printf formatting patterns and other two-dimensional text-based display - layouts. + + Converts the argument to signed native integer. This is a direct conversion for all + primitive numeric types. Otherwise the operation requires an appropriate + static conversion method on the input type. + The input value. + The converted nativeint - - Creates an instance of the attribute - Indicates the text to display when using the '%A' printf formatting. - StructuredFormatDisplayAttribute + + Converts the argument to 64-bit float. This is a direct conversion for all + primitive numeric types. The operation requires an appropriate + static conversion method on the input type. + The input value. + The converted float - - This attribute is used to mark how a type is displayed by default when using - '%A' printf formatting patterns and other two-dimensional text-based display layouts. - In this version of F# valid values are of the form PreText {PropertyName1} PostText {PropertyName2} ... {PropertyNameX} PostText. - The property names indicate properties to evaluate and to display instead of the object itself. + + Converts the argument to 32-bit float. This is a direct conversion for all + primitive numeric types. The operation requires an appropriate + static conversion method on the input type. + The input value. + The converted float32 - - The type 'unit', which has only one value "()". This value is special and - always uses the representation 'null'. + + Converts the argument to 64-bit float. This is a direct conversion for all + primitive numeric types. The operation requires an appropriate + static conversion method on the input type. + The input value. + The converted float - - Creates an instance of the attribute - UnverifiableAttribute + + Converts the argument to 32-bit float. This is a direct conversion for all + primitive numeric types. The operation requires an appropriate + static conversion method on the input type. + The input value. + The converted float32 - - This attribute is used to tag values whose use will result in the generation - of unverifiable code. These values are inevitably marked 'inline' to ensure that - the unverifiable constructs are not present in the actual code for the F# library, - but are rather copied to the source code of the caller. + + Converts the argument to unsigned 64-bit integer. This is a direct conversion for all + primitive numeric types. The operation requires an appropriate + static conversion method on the input type. + The input value. + The converted uint64 - - Creates an instance of the attribute - VolatileFieldAttribute + + Converts the argument to signed 64-bit integer. This is a direct conversion for all + primitive numeric types. The operation requires an appropriate + static conversion method on the input type. + The input value. + The converted int64 - - Adding this attribute to an F# mutable binding causes the "volatile" - prefix to be used for all accesses to the field. + + Converts the argument to unsigned 32-bit integer. This is a direct conversion for all + primitive numeric types. The operation requires an appropriate + static conversion method on the input type. + The input value. + The converted uint32 - - Thirty-two dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + Converts the argument to signed 32-bit integer. This is a direct conversion for all + primitive numeric types. The operation requires an appropriate + static conversion method on the input type. + The input value. + The converted int32 - - Thirty-one dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + Converts the argument to a particular enum type. + The input value. + The converted enum type. - - Thirty dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + Converts the argument to signed 32-bit integer. This is a direct conversion for all + primitive numeric types. The operation requires an appropriate + static conversion method on the input type. + The input value. + The converted int - - Twenty-nine dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + Converts the argument to unsigned 16-bit integer. This is a direct conversion for all + primitive numeric types. The operation requires an appropriate + static conversion method on the input type. + The input value. + The converted uint16 - - Twenty-eight dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + Converts the argument to signed 16-bit integer. This is a direct conversion for all + primitive numeric types. The operation requires an appropriate + static conversion method on the input type. + The input value. + The converted int16 - - Twenty-seven dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + Converts the argument to signed byte. This is a direct conversion for all + primitive numeric types. The operation requires an appropriate + static conversion method on the input type. + The input value. + The converted sbyte - - Twenty-six dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + Converts the argument to signed byte. This is a direct conversion for all + primitive numeric types. The operation requires an appropriate + static conversion method on the input type. + The input value. + The converted sbyte - - Twenty-five dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + Converts the argument to byte. This is a direct conversion for all + primitive numeric types. The operation requires an appropriate + static conversion method on the input type. + The input value. + The converted byte - - Twenty-four dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + Converts the argument to byte. This is a direct conversion for all + primitive numeric types. The operation requires an appropriate + static conversion method on the input type. + The input value. + The converted byte - - Twenty-three dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + + Functions for converting nullable values + - - Twenty-two dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + + The division operator where a nullable value appears on both left and right sides + - - Twenty-one dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + + The division operator where a nullable value appears on the right + - - Twenty dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + + The division operator where a nullable value appears on the left + - - Nineteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + + The modulus operator where a nullable value appears on both left and right sides + - - Eighteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + + The modulus operator where a nullable value appears on the right + - - Seventeen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + + The modulus operator where a nullable value appears on the left + - - Sixteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + + The multiplication operator where a nullable value appears on both left and right sides + - - Fifteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + + The multiplication operator where a nullable value appears on the right + - - Fourteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + + The multiplication operator where a nullable value appears on the left + - - Thirteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + + The subtraction operator where a nullable value appears on both left and right sides + - - Twelve dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + + The subtraction operator where a nullable value appears on the right + - - Eleven dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + + The subtraction operator where a nullable value appears on the left + - - Ten dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + + The addition operator where a nullable value appears on both left and right sides + - - Nine dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + + The addition operator where a nullable value appears on the right + - - Eight dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + + The addition operator where a nullable value appears on the left + - - Seven dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + + The '<>' operator where a nullable value appears on both left and right sides + - - Six dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + + The '=' operator where a nullable value appears on both left and right sides + - - Five dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. + + + The '<' operator where a nullable value appears on both left and right sides + - - Four dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - Use the values in the Array4D module - to manipulate values of this type, or the notation arr.[x1,x2,x3,x4] to get and set array - values. + + + The '<=' operator where a nullable value appears on both left and right sides + - - Three dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - Use the values in the Array3D module - to manipulate values of this type, or the notation arr.[x1,x2,x3] to get and set array - values. + + + The '>' operator where a nullable value appears on both left and right sides + - - Two dimensional arrays, typically zero-based. - - Use the values in the Array2D module - to manipulate values of this type, or the notation arr.[x,y] to get/set array - values. - - Non-zero-based arrays can also be created using methods on the System.Array type. + + + The '>=' operator where a nullable value appears on both left and right sides + - - Single dimensional, zero-based arrays, written int[], string[] etc. - Use the values in the Array module to manipulate values - of this type, or the notation arr.[x] to get/set array - values. + + + The '<>' operator where a nullable value appears on the right + - - Single dimensional, zero-based arrays, written int[], string[] etc. - - Use the values in the Array module to manipulate values - of this type, or the notation arr.[x] to get/set array - values. + + + The '=' operator where a nullable value appears on the right + - - An abbreviation for the CLI type System.Boolean. + + + The '<' operator where a nullable value appears on the right + - - Represents a managed pointer in F# code. + + + The '<=' operator where a nullable value appears on the right + - - An abbreviation for the CLI type System.Byte. + + + The '>' operator where a nullable value appears on the right + - - An abbreviation for the CLI type System.Char. + + + The '>=' operator where a nullable value appears on the right + - - An abbreviation for the CLI type System.Decimal. + + + The '<>' operator where a nullable value appears on the left + - - The type of decimal numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Decimal. + + + The '=' operator where a nullable value appears on the left + - - An abbreviation for the CLI type System.Double. + + + The '<' operator where a nullable value appears on the left + - - An abbreviation for the CLI type System.Exception. + + + The '<=' operator where a nullable value appears on the left + - - An abbreviation for the CLI type System.Double. + + + The '>' operator where a nullable value appears on the left + - - An abbreviation for the CLI type System.Single. + + + The '>=' operator where a nullable value appears on the left + - - The type of floating point numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Single. + + + Operators for working with nullable values + - - The type of floating point numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Double. + + + This type shouldn't be used directly from user code. + - - This type is for internal use by the F# code generator. + + + This type shouldn't be used directly from user code. + - - An abbreviation for the CLI type System.Int32. + + + This type shouldn't be used directly from user code. + - - An abbreviation for the CLI type System.Int16. + + + This type shouldn't be used directly from user code. + - - The type of 16-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Int16. + + + This type shouldn't be used directly from user code. + - - An abbreviation for the CLI type System.Int32. + + + This type shouldn't be used directly from user code. + - - An abbreviation for the CLI type System.Int64. + + + This type shouldn't be used directly from user code. + - - The type of 64-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Int64. + + + This type shouldn't be used directly from user code. + - - An abbreviation for the CLI type System.SByte. + + + A type used to reconstruct a grouping after applying a mutable->immutable mapping transformation + on a result of a query. + - - The type of 32-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Int32. + + + A runtime helper used to evaluate nested quotation literals. + - - An abbreviation for the CLI type System.IntPtr. + + + A runtime helper used to evaluate nested quotation literals. + - - Represents an unmanaged pointer in F# code. - - This type should only be used when writing F# code that interoperates - with native code. Use of this type in F# code may result in - unverifiable code being generated. Conversions to and from the - nativeint type may be required. Values of this type can be generated - by the functions in the NativeInterop.NativePtr module. + + + Evaluates a subset of F# quotations by first converting to a LINQ expression, for the subset of LINQ expressions represented by the + expression syntax in the C# language. + - - An abbreviation for the CLI type System.Object. + + + Converts a subset of F# quotations to a LINQ expression, for the subset of LINQ expressions represented by the + expression syntax in the C# language. + - - The type of optional values. When used from other CLI languages the - empty option is the null value. + + + Converts a subset of F# quotations to a LINQ expression, for the subset of LINQ expressions represented by the + expression syntax in the C# language. + + + + + When used in a quotation, this function indicates a specific conversion + should be performed when converting the quotation to a LINQ expression. - Use the constructors Some and None to create values of this type. - Use the values in the Option module to manipulate values of this type, - or pattern match against the values directly. + This function should not be called directly. + + + + + When used in a quotation, this function indicates a specific conversion + should be performed when converting the quotation to a LINQ expression. - 'None' values will appear as the value null to other CLI languages. - Instance methods on this type will appear as static methods to other CLI languages - due to the use of null as a value representation. + This function should not be called directly. + - - The type of mutable references. Use the functions [:=] and [!] to get and - set values of this type. + + + When used in a quotation, this function indicates a specific conversion + should be performed when converting the quotation to a LINQ expression. + + This function should not be called directly. + - - An abbreviation for the CLI type System.SByte. + + + The generic MethodInfo for Select function + Describes how we got from productions of immutable objects to productions of anonymous objects, with enough information + that we can invert the process in final query results. + - - The type of 8-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.SByte. + + + Given the expression part of a "yield" or "select" which produces a result in terms of immutable tuples or immutable records, + generate an equivalent expression yielding anonymous objects. Also return the conversion for the immutable-to-mutable correspondence + so we can reverse this later. + - - An abbreviation for the CLI type System.Single. + + + Simplify gets of tuples and gets of record fields. + - - An abbreviation for the CLI type System.String. + + + Cleanup the use of property-set object constructions in leaf expressions that form parts of F# queries. + - - An abbreviation for the CLI type System.UInt16. + + + Given an type involving immutable tuples and records, logically corresponding to the type produced at a + "yield" or "select", convert it to a type involving anonymous objects according to the conversion data. + - - An abbreviation for the CLI type System.UInt32. + + + Recognize anonymous type construction written using 'new AnonymousObject(<e1>, <e2>, ...)' + - - An abbreviation for the CLI type System.UInt64. + + + Recognize object construction written using 'new O(Prop1 = <e>, Prop2 = <e>, ...)' + - - An abbreviation for the CLI type System.Byte. + + + Tests whether a list consists only of assignments of properties of the + given variable, null values (ignored) and ends by returning the given variable + (pattern returns only property assignments) + - - An abbreviation for the CLI type System.UIntPtr. + + + Recognize sequential series written as (... ((<e>; <e>); <e>); ...) + - - The type 'unit', which has only one value "()". This value is special and - always uses the representation 'null'. + + + A method used to support the F# query syntax. Runs the given quotation as a query using LINQ IEnumerable rules. + - - Non-exhaustive match failures will raise the MatchFailureException exception + + + A method used to support the F# query syntax. Runs the given quotation as a query using LINQ rules. + - - The F# compiler emits implementations of this type for compiled sequence expressions. + + + A synonym for henry, the SI unit of inductance + - - The F# compiler emits implementations of this type for compiled sequence expressions. + + + A synonym for katal, the SI unit of catalytic activity + - - The F# compiler emits implementations of this type for compiled sequence expressions. - - A new enumerator for the sequence. + + + A synonym for sievert, the SI unit of does equivalent + - - The F# compiler emits implementations of this type for compiled sequence expressions. - - A reference to the sequence. - - A 0, 1, and 2 respectively indicate Stop, Yield, and Goto conditions for the sequence generator. + + + A synonym for gray, the SI unit of absorbed dose + - - The F# compiler emits implementations of this type for compiled sequence expressions. + + + A synonym for becquerel, the SI unit of activity referred to a radionuclide + - - The F# compiler emits implementations of this type for compiled sequence expressions. - - A new sequence generator for the expression. + + + A synonym for lux, the SI unit of illuminance + - - The F# compiler emits implementations of this type for compiled sequence expressions. + + + A synonym for lumen, the SI unit of luminous flux + - + - Namespace name the provider injects types into. + A synonym for tesla, the SI unit of magnetic flux density - - - Compilers call this method to query a type provider for a type name. - - Resolver should return a type called name in namespace NamespaceName or null if the type is unknown. - - + + + A synonym for weber, the SI unit of magnetic flux + - - - The top-level types - - + + + A synonym for UnitNames.ohm, the SI unit of electric resistance. + - + - The sub-namespaces in this namespace. An optional member to prevent generation of namespaces until an outer namespace is explored. + A synonym for siemens, the SI unit of electric conductance - - - Represents a namespace provided by a type provider component. - + + + A synonym for farad, the SI unit of capacitance + - - - Triggered when an assumption changes that invalidates the resolutions so far reported by the provider - + + + A synonym for volt, the SI unit of electric potential difference, electromotive force + - - - Triggered when an assumption changes that invalidates the resolutions so far reported by the provider - + + + A synonym for coulomb, the SI unit of electric charge, amount of electricity + - - - Triggered when an assumption changes that invalidates the resolutions so far reported by the provider - + + + A synonym for watt, the SI unit of power, radiant flux + - - - Get the static parameters for a provided type. - - A type returned by GetTypes or ResolveTypeName - + + + A synonym for joule, the SI unit of energy, work, amount of heat + - - - Namespace name the this TypeProvider injects types into. - + + + A synonym for pascal, the SI unit of pressure, stress + - - - Called by the compiler to ask for an Expression tree to replace the given MethodBase with. - - MethodBase that was given to the compiler by a type returned by a GetType(s) call. - Expressions that represent the parameters to this call. - An expression that the compiler will use in place of the given method base. + + + A synonym for newton, the SI unit of force + - - - Get the physical contents of the given logical provided assembly. - + + + A synonym for hertz, the SI unit of frequency + - - - Apply static arguments to a provided type that accepts static arguments. - - The provider must return a type with the given mangled name. - the provided type definition which has static parameters - the full path of the type, including encoded representations of static parameters - the static parameters, indexed by name - + + + A synonym for candela, the SI unit of luminous intensity + - - - Represents an instantiation of a type provider component. - + + + A synonym for mole, the SI unit of amount of substance + - - - Get the static parameters for a provided method. - - A method returned by GetMethod on a provided type - The static parameters of the provided method, if any + + + A synonym for kelvin, the SI unit of thermodynamic temperature + - - - Apply static arguments to a provided method that accepts static arguments. - - The provider must return a provided method with the given mangled name. - the provided method definition which has static parameters - the full name of the method that must be returned, including encoded representations of static parameters - the values of the static parameters, indexed by name - The provided method definition corresponding to the given static parameter values + + + A synonym for ampere, the SI unit of electric current + - + - Represents additional, optional information for a type provider component + A synonym for second, the SI unit of time - - Represents the inverse of a measure expressions when returned as a generic argument of a provided type. + + + A synonym for kilogram, the SI unit of mass + - - Represents the '1' measure expression when returned as a generic argument of a provided type. + + + A synonym for Metre, the SI unit of length + - - Represents the product of two measure expressions when returned as a generic argument of a provided type. + + + The SI unit of catalytic activity + - - Creates an instance of the attribute - TypeProviderAssemblyAttribute - The name of the design-time assembly for this type provider. + + + The SI unit of does equivalent + - - Creates an instance of the attribute - TypeProviderAssemblyAttribute + + + The SI unit of absorbed dose + - - Place attribute on runtime assembly to indicate that there is a corresponding design-time - assembly that contains a type provider. Runtime and designer assembly may be the same. + + + The SI unit of activity referred to a radionuclide + - - Creates an instance of the attribute - TypeProviderAttribute + + + The SI unit of illuminance + - - Place on a class that implements ITypeProvider to extend the compiler + + + The SI unit of luminous flux + - + - Get the full path to use for temporary files for the type provider instance. + The SI unit of inductance - + - version of referenced system runtime assembly + The SI unit of magnetic flux density - + - Get the full path to referenced assembly that caused this type provider instance to be created. + The SI unit of magnetic flux - + - Get the full path to use to resolve relative paths in any file name arguments given to the type provider instance. + The SI unit of electric conductance - + - Get the referenced assemblies for the type provider instance. + The SI unit of electric resistance - + - Indicates if the type provider host responds to invalidation events for type provider instances. + The SI unit of capacitance - + - Indicates if the type provider instance is used in an environment which executes provided code such as F# Interactive. + The SI unit of electric potential difference, electromotive force - + - Get the full path to use for temporary files for the type provider instance. + The SI unit of electric charge, amount of electricity - + - version of referenced system runtime assembly + The SI unit of power, radiant flux - + - Get the full path to referenced assembly that caused this type provider instance to be created. + The SI unit of energy, work, amount of heat - + - Get the full path to use to resolve relative paths in any file name arguments given to the type provider instance. + The SI unit of pressure, stress - + - Get the referenced assemblies for the type provider instance. + The SI unit of force - + - Indicates if the type provider host responds to invalidation events for type provider instances. + The SI unit of frequency - + - Indicates if the type provider instance is used in an environment which executes provided code such as F# Interactive. + The SI unit of luminous intensity - + - Checks if given type exists in target system runtime library + The SI unit of amount of substance - + - If the class that implements ITypeProvider has a constructor that accepts TypeProviderConfig - then it will be constructed with an instance of TypeProviderConfig. + The SI unit of thermodynamic temperature - - Creates an instance of the attribute - TypeProviderEditorHideMethodsAttribute + + + The SI unit of electric current + - - Indicates that a code editor should hide all System.Object methods from the intellisense menus for instances of a provided type + + + The SI unit of time + - - Additional type attribute flags related to provided types + + + The SI unit of mass + - - Creates an instance of the attribute - TypeProviderXmlDocAttribute + + + The SI unit of length + - + - The TypeProviderXmlDocAttribute attribute can be added to types and members. - The language service will display the CommentText property from the attribute - in the appropriate place when the user hovers over a type or member. + The SI unit of length - - Creates an anonymous event with the given handlers. - - A function to handle adding a delegate for the event to trigger. - A function to handle removing a delegate that the event triggers. - A function to produce the delegate type the event can trigger. - - The initialized event. + + This type is for internal use by the F# code generator. - - The F# compiler emits calls to this function to implement the use operator for F# sequence - expressions. - - The resource to be used and disposed. - The input sequence. + + Represents an untyped unmanaged pointer in F# code. - The result sequence. + This type should only be used when writing F# code that interoperates + with native code. Use of this type in F# code may result in + unverifiable code being generated. Conversions to and from the + nativeint type may be required. Values of this type can be generated + by the functions in the NativeInterop.NativePtr module. - - The F# compiler emits calls to this function to implement the compiler-intrinsic - conversions from untyped System.Collections.IEnumerable sequences to typed sequences. - - An initializer function. - A function to iterate and test if end of sequence is reached. - A function to retrieve the current element. + + Represents an unmanaged pointer in F# code. - The resulting typed sequence. + This type should only be used when writing F# code that interoperates + with native code. Use of this type in F# code may result in + unverifiable code being generated. Conversions to and from the + nativeint type may be required. Values of this type can be generated + by the functions in the NativeInterop.NativePtr module. - - The F# compiler emits calls to this function to - implement the try/finally operator for F# sequence expressions. - - The input sequence. - A computation to be included in an enumerator's Dispose method. - - The result sequence. + + Single dimensional, zero-based arrays, written int[], string[] etc. + + Use the values in the Array module to manipulate values + of this type, or the notation arr.[x] to get/set array + values. - - The F# compiler emits calls to this function to - implement the while operator for F# sequence expressions. - - A function that indicates whether iteration should continue. - The input sequence. - - The result sequence. + + Thirty-two dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. - - A group of functions used as part of the compiled representation of F# sequence expressions. + + Thirty-one dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. - - Builds a query using query syntax and operators. + + Thirty dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. - - An active pattern to force the execution of values of type Lazy<_>. + + Twenty-nine dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. + + + Twenty-eight dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. + + + Twenty-seven dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. + + + Twenty-six dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. + + + Twenty-five dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. + + + Twenty-four dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. + + + Twenty-three dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. + + + Twenty-two dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. + + + Twenty-one dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. + + + Twenty dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. + + + Nineteen dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. + + + Eighteen dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. + + + Seventeen dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. + + + Sixteen dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. + + + Fifteen dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. + + + Fourteen dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. - - Special prefix operator for splicing untyped expressions into quotation holes. + + Thirteen dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. - - Special prefix operator for splicing typed expressions into quotation holes. + + Twelve dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. - - Builds a 2D array from a sequence of sequences of elements. + + Eleven dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. - - Builds a read-only lookup table from a sequence of key/value pairs. The key objects are indexed using generic hashing and equality. + + Ten dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. - - Converts the argument to signed byte. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using SByte.Parse() with InvariantCulture settings. - Otherwise the operation requires and invokes a ToSByte method on the input type. + + Nine dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. - - Converts the argument to byte. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Byte.Parse() on strings and otherwise requires a ToByte method on the input type. + + Eight dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. - - Converts the argument to 64-bit float. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Double.Parse() with InvariantCulture settings. Otherwise the operation requires and invokes a ToDouble method on the input type. + + Seven dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. - - Converts the argument to 32-bit float. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Single.Parse() with InvariantCulture settings. Otherwise the operation requires and invokes a ToSingle method on the input type. + + Six dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. - - Builds an aysnchronous workflow using computation expression syntax. + + Five dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. - - Builds a set from a sequence of objects. The objects are indexed using generic comparison. - The input sequence of elements. - The created set. + + Four dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. + + Use the values in the Array4D module + to manipulate values of this type, or the notation arr.[x1,x2,x3,x4] to get and set array + values. - - Print to a file using the given format, and add a newline. - The file TextWriter. - The formatter. - The formatted result. + + Three dimensional arrays, typically zero-based. Non-zero-based arrays + can be created using methods on the System.Array type. + + Use the values in the Array3D module + to manipulate values of this type, or the notation arr.[x1,x2,x3] to get and set array + values. - - Print to a file using the given format. - The file TextWriter. - The formatter. - The formatted result. + + Two dimensional arrays, typically zero-based. + + Use the values in the Array2D module + to manipulate values of this type, or the notation arr.[x,y] to get/set array + values. + + Non-zero-based arrays can also be created using methods on the System.Array type. - - Print to a string buffer and raise an exception with the given - result. Helper printers must return strings. - The formatter. - The formatted result. + + Single dimensional, zero-based arrays, written int[], string[] etc. + Use the values in the Array module to manipulate values + of this type, or the notation arr.[x] to get/set array + values. - - Print to a string using the given format. - The formatter. - The formatted result. + + An abbreviation for the CLI type System.Int32. - - Print to stderr using the given format, and add a newline. - The formatter. - The formatted result. + + An abbreviation for the CLI type System.Decimal. - - Print to stderr using the given format. - The formatter. - The formatted result. + + An abbreviation for the CLI type System.Boolean. - - Print to stdout using the given format, and add a newline. - The formatter. - The formatted result. + + An abbreviation for the CLI type System.Char. - - Print to stdout using the given format. - The formatter. - The formatted result. + + An abbreviation for the CLI type System.UInt64. - - Converts the argument to signed byte. - This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using SByte.Parse() with InvariantCulture settings. - Otherwise the operation requires and invokes a ToSByte method on the input type. + + An abbreviation for the CLI type System.Int64. - - Converts the argument to byte. - This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using Byte.Parse() on strings and otherwise requires a ToByte method on the input type. + + An abbreviation for the CLI type System.UInt32. - - Divides a value by an integer. - The input value. - The input int. - The division result. + + An abbreviation for the CLI type System.Int32. - - Resolves to the value 'one' for any primitive numeric type or any type with a static member called 'One' + + An abbreviation for the CLI type System.UInt16. - - Resolves to the zero value for any primitive numeric type or any type with a static member called 'Zero' + + An abbreviation for the CLI type System.Int16. - - A compiler intrinsic that implements dynamic invocations for the DivideByInt primitive. + + An abbreviation for the CLI type System.Byte. - - A compiler intrinsic that implements dynamic invocations to the checked '*' operator. + + An abbreviation for the CLI type System.SByte. - - A compiler intrinsic that implements dynamic invocations to the '*' operator. + + An abbreviation for the CLI type System.Byte. - - A compiler intrinsic that implements dynamic invocations to the checked '+' operator. + + An abbreviation for the CLI type System.SByte. - - A compiler intrinsic that implements dynamic invocations to the '+' operator. + + An abbreviation for the CLI type System.Double. - - Resolves to the value 'one' for any primitive numeric type or any type with a static member called 'One'. + + An abbreviation for the CLI type System.Single. - - Resolves to the zero value for any primitive numeric type or any type with a static member called 'Zero'. + + An abbreviation for the CLI type System.Double. - - Parse an uint64 according to the rules used by the overloaded 'uint64' conversion operator when applied to strings - The input string. - The parsed value. + + An abbreviation for the CLI type System.Single. - - Parse an int64 according to the rules used by the overloaded 'int64' conversion operator when applied to strings - The input string. - The parsed value. + + An abbreviation for the CLI type System.String. - - Parse an uint32 according to the rules used by the overloaded 'uint32' conversion operator when applied to strings - The input string. - The parsed value. + + An abbreviation for the CLI type System.UIntPtr. - - Parse an int32 according to the rules used by the overloaded 'int32' conversion operator when applied to strings - The input string. - The parsed value. + + An abbreviation for the CLI type System.IntPtr. - - Creates an sbyte value with units-of-measure - The input sbyte. - The sbyte with units-of-measure. + + An abbreviation for the CLI type System.Exception. - - Creates an int16 value with units-of-measure - The input int16. - The int16 with units-of-measure. + + An abbreviation for the CLI type System.Object. - - Creates an int64 value with units-of-measure - The input int64. - The int64 with units of measure. + + + Represents an Error or a Failure. The code failed with a value of 'TError representing what went wrong. + - - Creates an int32 value with units-of-measure - The input int. - The int with units of measure. + + + Represents an OK or a Successful result. The code succeeded with a value of 'T. + - - Creates a decimal value with units-of-measure - The input decimal. - The decimal with units of measure. + + Helper type for error handling without exceptions. - - Creates a float32 value with units-of-measure - The input float. - The float with units-of-measure. + + The type of optional values, represented as structs. + + Use the constructors ValueSome and ValueNone to create values of this type. + Use the values in the ValueOption module to manipulate values of this type, + or pattern match against the values directly. - - Creates a float value with units-of-measure - The input float. - The float with units-of-measure. + + The representation of "Value of type 'T" + The input value. + An option representing the value. - - Get the underlying value for an enum value - The input enum. - The enumeration as a value. + + The representation of "No value" - - Build an enum value from an underlying value - The input value. - The value as an enumeration. + + Get the value of a 'ValueSome' option. An InvalidOperationException is raised if the option is 'ValueNone'. - - Recursively hash a part of a value according to its structure. - The comparison function. - The input object. - The hashed value. + + Create a value option value that is a 'ValueNone' value. - - Hash a value according to its structure. Use the given limit to restrict the hash when hashing F# - records, lists and union types. - The limit on the number of nodes. - The input object. - The hashed value. + + Return 'true' if the value option is a 'ValueSome' value. - - Hash a value according to its structure. This hash is not limited by an overall node count when hashing F# - records, lists and union types. - The input object. - The hashed value. + + Return 'true' if the value option is a 'ValueNone' value. - - Make an F# comparer object for the given type + + Create a value option value that is a 'Some' value. + The input value + A value option representing the value. - - Make an F# hash/equality object for the given type + + The type of optional values, represented as structs. + + Use the constructors ValueSome and ValueNone to create values of this type. + Use the values in the ValueOption module to manipulate values of this type, + or pattern match against the values directly. - - Make an F# hash/equality object for the given type using node-limited hashing when hashing F# - records, lists and union types. - The input limit on the number of nodes. - System.Collections.Generic.IEqualityComparer<'T> + + The type of optional values. When used from other CLI languages the + empty option is the null value. + + Use the constructors Some and None to create values of this type. + Use the values in the Option module to manipulate values of this type, + or pattern match against the values directly. + + 'None' values will appear as the value null to other CLI languages. + Instance methods on this type will appear as static methods to other CLI languages + due to the use of null as a value representation. - - Make an F# hash/equality object for the given type + + The representation of "Value of type 'T" + The input value. + An option representing the value. - - Make an F# comparer object for the given type, where it can be null if System.Collections.Generic.Comparer<'T>.Default + + The representation of "No value" - - Make an F# comparer object for the given type + + Implicitly converts a value into an optional that is a 'Some' value. + The input value + An option representing the value. - - A static F# comparer object + + Get the value of a 'Some' option. A NullReferenceException is raised if the option is 'None'. - - Return an F# comparer object suitable for hashing and equality. This hashing behaviour - of the returned comparer is not limited by an overall node count when hashing F# - records, lists and union types. This equality comparer has equivalence - relation semantics ([nan] = [nan]). + + Create an option value that is a 'None' value. - - Return an F# comparer object suitable for hashing and equality. This hashing behaviour - of the returned comparer is not limited by an overall node count when hashing F# - records, lists and union types. + + Return 'true' if the option is a 'Some' value. - - The physical hash. Hashes on the object identity, except for value types, - where we hash on the contents. - The input object. - The hashed value. + + Return 'true' if the option is a 'None' value. - - Reference/physical equality. - True if the inputs are reference-equal, false otherwise. - The first value. - The second value. - The result of the comparison. + + Create an option value that is a 'Some' value. + The input value + An option representing the value. - - Take the maximum of two values structurally according to the order given by GenericComparison - The first value. - The second value. - The maximum value. + + The type of optional values. When used from other CLI languages the + empty option is the null value. + + Use the constructors Some and None to create values of this type. + Use the values in the Option module to manipulate values of this type, + or pattern match against the values directly. + + None values will appear as the value null to other CLI languages. + Instance methods on this type will appear as static methods to other CLI languages + due to the use of null as a value representation. - - Take the minimum of two values structurally according to the order given by GenericComparison - The first value. - The second value. - The minimum value. + + The type of mutable references. Use the functions [!] and [:=] to get and + set values of this type. - - Compare two values - The first value. - The second value. - The result of the comparison. + + + The current value of the reference cell + - - Compare two values - The first value. - The second value. - The result of the comparison. + + The current value of the reference cell - - Compare two values - The first value. - The second value. - The result of the comparison. + + The current value of the reference cell - - Compare two values - The first value. - The second value. - The result of the comparison. + + The type of mutable references. Use the functions [!] and [:=] to get and + set values of this type. - - Compare two values. May be called as a recursive case from an implementation of System.IComparable to - ensure consistent NaN comparison semantics. - The function to compare the values. - The first value. - The second value. - The result of the comparison. + + Convert the given Converter delegate object to an F# function value + The input Converter delegate. + The F# function. - - Compare two values - The first value. - The second value. - The result of the comparison. + + Convert the given Action delegate object to an F# function value + The input Action delegate. + The F# function. - - Compare two values for equality - - The first value. - The second value. - The result of the comparison. + + A utility function to convert function values from tupled to curried form + The input tupled function. + The output curried function. - - Compare two values for equality using equivalence relation semantics ([nan] = [nan]) - The first value. - The second value. - The result of the comparison. + + A utility function to convert function values from tupled to curried form + The input tupled function. + The output curried function. - - Compare two values for equality using partial equivalence relation semantics ([nan] <> [nan]) - The first value. - The second value. - The result of the comparison. + + A utility function to convert function values from tupled to curried form + The input tupled function. + The output curried function. - - A primitive entry point used by the F# compiler for optimization purposes. + + A utility function to convert function values from tupled to curried form + The input tupled function. + The output curried function. - - A primitive entry point used by the F# compiler for optimization purposes. + + Convert the given Func delegate object to an F# function value + The input Func delegate. + The F# function. - - A primitive entry point used by the F# compiler for optimization purposes. + + Convert the given Func delegate object to an F# function value + The input Func delegate. + The F# function. - - A primitive entry point used by the F# compiler for optimization purposes. + + Convert the given Func delegate object to an F# function value + The input Func delegate. + The F# function. - - A primitive entry point used by the F# compiler for optimization purposes. + + Convert the given Func delegate object to an F# function value + The input Func delegate. + The F#funcfunction. - - A primitive entry point used by the F# compiler for optimization purposes. + + Convert the given Func delegate object to an F# function value + The input Func delegate. + The F# function. - - A primitive entry point used by the F# compiler for optimization purposes. + + Convert the given Func delegate object to an F# function value + The input Func delegate. + The F# function. - - A primitive entry point used by the F# compiler for optimization purposes. + + Convert the given Action delegate object to an F# function value + The input Action delegate. + The F# function. - - A primitive entry point used by the F# compiler for optimization purposes. + + Convert the given Action delegate object to an F# function value + The input Action delegate. + The F# function. - - A primitive entry point used by the F# compiler for optimization purposes. + + Convert the given Action delegate object to an F# function value + The input Action delegate. + The F# function. - - A primitive entry point used by the F# compiler for optimization purposes. + + Convert the given Action delegate object to an F# function value + The input Action delegate. + The F#funcfunction. - - A primitive entry point used by the F# compiler for optimization purposes. + + Convert the given Action delegate object to an F# function value + The input Action delegate. + The F# function. - - A primitive entry point used by the F# compiler for optimization purposes. + + Convert the given Action delegate object to an F# function value + The input Action delegate. + The F# function. - - A primitive entry point used by the F# compiler for optimization purposes. + + Helper functions for converting F# first class function values to and from CLI representations + of functions using delegates. - - A primitive entry point used by the F# compiler for optimization purposes. + + Convert an value of type System.Converter to a F# first class function value + The input System.Converter. + An F# function of the same type. - - A primitive entry point used by the F# compiler for optimization purposes. + + Convert an F# first class function value to a value of type System.Converter + The input function. + A System.Converter of the function type. + + + Convert an F# first class function value to a value of type System.Converter + The input function. + System.Converter<'T,'U> - - A primitive entry point used by the F# compiler for optimization purposes. + + Invoke an F# first class function value with two curried arguments. In some cases this + will result in a more efficient application than applying the arguments successively. + The input function. + The first arg. + The second arg. + The function result. - - A primitive entry point used by the F# compiler for optimization purposes. + + Invoke an F# first class function value with three curried arguments. In some cases this + will result in a more efficient application than applying the arguments successively. + The input function. + The first arg. + The second arg. + The third arg. + The function result. - - A primitive entry point used by the F# compiler for optimization purposes. + + Invoke an F# first class function value with four curried arguments. In some cases this + will result in a more efficient application than applying the arguments successively. + The input function. + The first arg. + The second arg. + The third arg. + The fourth arg. + The function result. - - A primitive entry point used by the F# compiler for optimization purposes. + + Invoke an F# first class function value with five curried arguments. In some cases this + will result in a more efficient application than applying the arguments successively. + The input function. + The first arg. + The second arg. + The third arg. + The fourth arg. + The fifth arg. + The function result. - - A primitive entry point used by the F# compiler for optimization purposes. + + Invoke an F# first class function value with one argument + + 'U - - A primitive entry point used by the F# compiler for optimization purposes. + + Convert an value of type System.Converter to a F# first class function value + The input System.Converter. + An F# function of the same type. - - A primitive entry point used by the F# compiler for optimization purposes. + + Construct an instance of an F# first class function value + The created F# function. - - A primitive entry point used by the F# compiler for optimization purposes. + + The CLI type used to represent F# function values. This type is not + typically used directly, though may be used from other CLI languages. - - A primitive entry point used by the F# compiler for optimization purposes. + + Specialize the type function at a given type + The specialized type. - - A primitive entry point used by the F# compiler for optimization purposes. + + Construct an instance of an F# first class type function value + FSharpTypeFunc - - The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs + + The CLI type used to represent F# first-class type function values. This type is for use + by compiled F# code. - - - The standard overloaded associative (4-indexed) mutation operator - + + Choice 7 of 7 choices - - The standard overloaded associative (3-indexed) mutation operator + + Choice 6 of 7 choices - - The standard overloaded associative (2-indexed) mutation operator + + Choice 5 of 7 choices - - The standard overloaded associative (indexed) mutation operator + + Choice 4 of 7 choices - - The standard overloaded associative (4-indexed) lookup operator + + Choice 3 of 7 choices - - The standard overloaded associative (3-indexed) lookup operator + + Choice 2 of 7 choices - - The standard overloaded associative (2-indexed) lookup operator + + Choice 1 of 7 choices - - The standard overloaded associative (indexed) lookup operator + + Helper types for active patterns with 7 choices. - - A compiler intrinsic for checking initialization soundness of recursive bindings + + Choice 6 of 6 choices - - A compiler intrinsic for checking initialization soundness of recursive static bindings + + Choice 5 of 6 choices - - A compiler intrinsic for checking initialization soundness of recursive bindings + + Choice 4 of 6 choices - - A compiler intrinsic for the efficient compilation of sequence expressions + + Choice 3 of 6 choices - - This function implements parsing of decimal constants + + Choice 2 of 6 choices - - This function implements calls to default constructors - acccessed by 'new' constraints. + + Choice 1 of 6 choices - - Primitive used by pattern match compilation + + Helper types for active patterns with 6 choices. - - A compiler intrinsic that implements the ':?' operator + + Choice 5 of 5 choices - - A compiler intrinsic that implements the ':?' operator + + Choice 4 of 5 choices - - A compiler intrinsic that implements the ':?>' operator + + Choice 3 of 5 choices - - A compiler intrinsic that implements the ':?>' operator + + Choice 2 of 5 choices - - The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs + + Choice 1 of 5 choices - - Address-of. Uses of this value may result in the generation of unverifiable code. - The input object. - The unmanaged pointer. + + Helper types for active patterns with 5 choices. - - Address-of. Uses of this value may result in the generation of unverifiable code. - The input object. - The managed pointer. + + Choice 4 of 4 choices - - Binary 'or'. When used as a binary operator the right hand value is evaluated only on demand - The first value. - The second value. - The result of the operation. + + Choice 3 of 4 choices - - Binary 'or'. When used as a binary operator the right hand value is evaluated only on demand. + + Choice 2 of 4 choices - - Binary 'and'. When used as a binary operator the right hand value is evaluated only on demand - The first value. - The second value. - The result of the operation. + + Choice 1 of 4 choices - - Binary 'and'. When used as a binary operator the right hand value is evaluated only on demand. + + Helper types for active patterns with 4 choices. - - The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs + + Choice 3 of 3 choices - - For compiler use only + + Choice 2 of 3 choices - - Language primitives associated with the F# language + + Choice 1 of 3 choices - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - + + Helper types for active patterns with 3 choices. - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - + + Choice 2 of 2 choices - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - + + Choice 1 of 2 choices - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - + + Helper types for active patterns with 2 choices. - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - + + Represents a out-argument managed pointer in F# code. This type should only be used with F# 4.5+. - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - + + Represents a in-argument or readonly managed pointer in F# code. This type should only be used with F# 4.5+. - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - + + Represents a managed pointer in F# code. For F# 4.5+ this is considered equivalent to byref<'T, ByRefKinds.InOut> - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - + + Represents a managed pointer in F# code. - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - + + The type of 64-bit signed integer numbers, annotated with a unit of measure. The unit + of measure is erased in compiled code and when values of this type + are analyzed using reflection. The type is representationally equivalent to + System.Int64. - - An active pattern to match values of type System.Collections.Generic.KeyValuePair - The input key/value pair. - A tuple containing the key and value. + + The type of 16-bit signed integer numbers, annotated with a unit of measure. The unit + of measure is erased in compiled code and when values of this type + are analyzed using reflection. The type is representationally equivalent to + System.Int16. + + + The type of 8-bit signed integer numbers, annotated with a unit of measure. The unit + of measure is erased in compiled code and when values of this type + are analyzed using reflection. The type is representationally equivalent to + System.SByte. - - Converts the argument to character. Numeric inputs are converted according to the UTF-16 - encoding for characters. String inputs must be exactly one character long. For other - input types the operation requires an appropriate static conversion method on the input type. - The input value. - The converted char. + + The type of 32-bit signed integer numbers, annotated with a unit of measure. The unit + of measure is erased in compiled code and when values of this type + are analyzed using reflection. The type is representationally equivalent to + System.Int32. - - Converts the argument to System.Decimal using a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted decimal. + + The type of decimal numbers, annotated with a unit of measure. The unit + of measure is erased in compiled code and when values of this type + are analyzed using reflection. The type is representationally equivalent to + System.Decimal. - - Converts the argument to a string using ToString. - - For standard integer and floating point values the ToString conversion - uses CultureInfo.InvariantCulture. - The input value. - The converted string. + + The type of floating point numbers, annotated with a unit of measure. The unit + of measure is erased in compiled code and when values of this type + are analyzed using reflection. The type is representationally equivalent to + System.Single. - - Converts the argument to unsigned native integer using a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted unativeint + + The type of floating point numbers, annotated with a unit of measure. The unit + of measure is erased in compiled code and when values of this type + are analyzed using reflection. The type is representationally equivalent to + System.Double. - - Converts the argument to signed native integer. This is a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted nativeint + + Indicates the namespace or module to be automatically opened when an assembly is referenced + or an enclosing module opened. - - Converts the argument to 64-bit float. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Double.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float + + Creates an attribute used to mark a namespace or module path to be 'automatically opened' when an assembly is referenced + The namespace or module to be automatically opened when an assembly is referenced + or an enclosing module opened. + AutoOpenAttribute - - Converts the argument to 32-bit float. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Single.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float32 + + Creates an attribute used to mark a module as 'automatically opened' when the enclosing namespace is opened + AutoOpenAttribute - - Converts the argument to unsigned 64-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint64 + + This attribute is used for two purposes. When applied to an assembly, it must be given a string + argument, and this argument must indicate a valid module or namespace in that assembly. Source + code files compiled with a reference to this assembly are processed in an environment + where the given path is automatically opened. + + When applied to a module within an assembly, then the attribute must not be given any arguments. + When the enclosing namespace is opened in user source code, the module is also implicitly opened. - - Converts the argument to signed 64-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int64 + + Creates an instance of the attribute + RequireQualifiedAccessAttribute - - Converts the argument to unsigned 32-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint32 + + This attribute is used to indicate that references to the elements of a module, record or union + type require explicit qualified access. - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int32 + + Creates an instance of the attribute + NoDynamicInvocationAttribute - - Converts the argument to a particular enum type. - The input value. - The converted enum type. + + This attribute is used to tag values that may not be dynamically invoked at runtime. This is + typically added to inlined functions whose implementations include unverifiable code. It + causes the method body emitted for the inlined function to raise an exception if + dynamically invoked, rather than including the unverifiable code in the generated + assembly. - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int + + Creates an instance of the attribute + UnverifiableAttribute - - Converts the argument to unsigned 16-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint16 + + This attribute is used to tag values whose use will result in the generation + of unverifiable code. These values are inevitably marked 'inline' to ensure that + the unverifiable constructs are not present in the actual code for the F# library, + but are rather copied to the source code of the caller. - - Converts the argument to signed 16-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int16 + + Indicates if the construct should always be hidden in an editing environment. - - Converts the argument to signed byte. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using SByte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte + + Indicates if the message should indicate a compiler error. Error numbers less than + 10000 are considered reserved for use by the F# compiler and libraries. - - Converts the argument to byte. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Byte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte + + Indicates the number associated with the message. - - Overloaded power operator. If n > 0 then equivalent to x*...*x for n occurrences of x. - The input base. - The input exponent. - The base raised to the exponent. + + Indicates the warning message to be emitted when F# source code uses this construct - - Overloaded power operator. - The input base. - The input exponent. - The base raised to the exponent. + + Indicates if the construct should always be hidden in an editing environment. - - Overloaded truncate operator. - The input value. - The truncated value. + + Indicates if the message should indicate a compiler error. Error numbers less than + 10000 are considered reserved for use by the F# compiler and libraries. - - Hyperbolic tangent of the given number - The input value. - The hyperbolic tangent of the input. + + Creates an instance of the attribute. - - Tangent of the given number - The input value. - The tangent of the input. + + Indicates that a message should be emitted when F# source code uses this construct. - - Hyperbolic sine of the given number - The input value. - The hyperbolic sine of the input. + + Indicates the text to display by default when objects of this type are displayed + using '%A' printf formatting patterns and other two-dimensional text-based display + layouts. - - Sine of the given number - The input value. - The sine of the input. + + Creates an instance of the attribute + Indicates the text to display when using the '%A' printf formatting. + StructuredFormatDisplayAttribute - - Hyperbolic cosine of the given number - The input value. - The hyperbolic cosine of the input. + + This attribute is used to mark how a type is displayed by default when using + '%A' printf formatting patterns and other two-dimensional text-based display layouts. + In this version of F# valid values are of the form PreText {PropertyName1} PostText {PropertyName2} ... {PropertyNameX} PostText. + The property names indicate properties to evaluate and to display instead of the object itself. - - Cosine of the given number - The input value. - The cosine of the input. + + Indicates the number of arguments in each argument group - - Square root of the given number - The input value. - The square root of the input. + + Creates an instance of the attribute + Indicates the number of arguments in each argument group. + CompilationArgumentCountsAttribute + + + This attribute is generated automatically by the F# compiler to tag functions and members + that accept a partial application of some of their arguments and return a residual function - - Logarithm to base 10 of the given number - The input value. - The logarithm to base 10 of the input. + + Indicates the warning message to be emitted when F# source code uses this construct - - Natural logarithm of the given number - The input value. - The natural logarithm of the input. + + Creates an instance of the attribute + The warning message to be emitted when code uses this construct. + ExperimentalAttribute - - Round the given number - The input value. - The nearest integer to the input value. + + This attribute is used to tag values that are part of an experimental library + feature. - - Sign of the given number - The input value. - -1, 0, or 1 depending on the sign of the input. + + Indicates one or more adjustments to the compiled representation of an F# type or member - - Floor of the given number - The input value. - The floor of the input. + + Creates an instance of the attribute + Indicates adjustments to the compiled representation of the type or member. + CompilationRepresentationAttribute - - Exponential of the given number - The input value. - The exponential of the input. + + This attribute is used to adjust the runtime representation for a type. + For example, it may be used to note that the null representation + may be used for a type. This affects how some constructs are compiled. - - Ceiling of the given number - The input value. - The ceiling of the input. + + Indicates the name of the entity in F# source code - - Inverse tangent of x/y where x and y are specified separately - The y input value. - The x input value. - The inverse tangent of the input ratio. + + Creates an instance of the attribute + The name of the method in source. + CompilationSourceNameAttribute - - Inverse tangent of the given number - The input value. - The inverse tangent of the input. + + This attribute is inserted automatically by the F# compiler to tag + methods which are given the 'CompiledName' attribute. It is not intended + for use from user code. - - Inverse sine of the given number - The input value. - The inverse sine of the input. + + Indicates the variant number of the entity, if any, in a linear sequence of elements with F# source code - - Inverse cosine of the given number - The input value. - The inverse cosine of the input. + + Indicates the type definitions needed to resolve the source construct - - Absolute value of the given number. - The input value. - The absolute value of the input. + + Indicates the relationship between the compiled entity and F# source code - - A generic hash function. This function has the same behaviour as 'hash', - however the default structural hashing for F# union, record and tuple - types stops when the given limit of nodes is reached. The exact behaviour of - the function can be adjusted on a type-by-type basis by implementing - GetHashCode for each type. - The limit of nodes. - The input object. - The computed hash. + + Indicates the sequence number of the entity, if any, in a linear sequence of elements with F# source code - - A generic hash function, designed to return equal hash values for items that are - equal according to the "=" operator. By default it will use structural hashing - for F# union, record and tuple types, hashing the complete contents of the - type. The exact behaviour of the function can be adjusted on a - type-by-type basis by implementing GetHashCode for each type. - The input object. - The computed hash. + + Indicates the resource the source construct relates to - - Returns the internal size of a type in bytes. For example, sizeof<int> returns 4. + + Creates an instance of the attribute + Indicates the type definitions needed to resolve the source construct. + CompilationMappingAttribute - - Generate a System.Type representation for a type definition. If the - input type is a generic type instantiation then return the - generic type definition associated with all such instantiations. + + Creates an instance of the attribute + Indicates the type of source construct. + CompilationMappingAttribute - - An internal, library-only compiler intrinsic for compile-time - generation of a RuntimeMethodHandle. + + Creates an instance of the attribute + Indicates the type of source construct. + CompilationMappingAttribute - - Generate a System.Type runtime representation of a static type. + + Creates an instance of the attribute + Indicates the type of source construct. + CompilationMappingAttribute - - Clean up resources associated with the input object after the completion of the given function. - Cleanup occurs even when an exception is raised by the protected - code. - The resource to be disposed after action is called. - The action that accepts the resource. - The resulting value. + + This attribute is inserted automatically by the F# compiler to tag types + and methods in the generated CLI code with flags indicating the correspondence + with original source constructs. It is used by the functions in the + Microsoft.FSharp.Reflection namespace to reverse-map compiled constructs to + their original forms. It is not intended for use from user code. - - Execute the function as a mutual-exclusion region using the input value as a lock. - The object to be locked. - The action to perform during the lock. - The resulting value. + + The release number of the F# version associated with the attribute - - The standard overloaded skip range operator, e.g. [n..skip..m] for lists, seq {n..skip..m} for sequences - The start value of the range. - The step value of the range. - The end value of the range. - The sequence spanning the range using the specified step size. + + The minor version number of the F# version associated with the attribute - - The standard overloaded range operator, e.g. [n..m] for lists, seq {n..m} for sequences - The start value of the range. - The end value of the range. - The sequence spanning the range. + + The major version number of the F# version associated with the attribute - - Reads the value of the property System.Console.Out. + + Creates an instance of the attribute + The major version number. + The minor version number. + The release number. + FSharpInterfaceDataVersionAttribute - - Reads the value of the property System.Console.Error. + + This attribute is added to generated assemblies to indicate the + version of the data schema used to encode additional F# + specific information in the resource attached to compiled F# libraries. - - Reads the value of the property System.Console.In. + + The value of the attribute, indicating whether the type is automatically marked serializable or not - - Equivalent to System.Single.NaN + + Creates an instance of the attribute + Indicates whether the type should be serializable by default. + AutoSerializableAttribute - - Equivalent to System.Single.PositiveInfinity + + Adding this attribute to a type with value 'false' disables the behaviour where F# makes the + type Serializable by default. - - Equivalent to System.Double.NaN + + The name of the value as it appears in compiled code - - Equivalent to System.Double.PositiveInfinity + + Creates an instance of the attribute + The name to use in compiled code. + CompiledNameAttribute - - Exit the current hardware isolated process, if security settings permit, - otherwise raise an exception. Calls System.Environment.Exit. - The exit code to use. - The result value. + + Adding this attribute to a value or function definition in an F# module changes the name used + for the value in compiled CLI code. - - Builds a sequence using sequence expression syntax - The input sequence. - The result sequence. + + Creates an instance of the attribute + GeneralizableValueAttribute - - Negate a logical value. not true equals false and not false equals true - The value to negate. - The result of the negation. + + Adding this attribute to a non-function value with generic parameters indicates that + uses of the construct can give rise to generic code through type inference. - - Concatenate two lists. - The first list. - The second list. - The concatenation of the lists. + + Creates an instance of the attribute + RequiresExplicitTypeArgumentsAttribute - - Increment a mutable reference cell containing an integer - The reference cell. + + Adding this attribute to a type, value or member requires that + uses of the construct must explicitly instantiate any generic type parameters. - - Decrement a mutable reference cell containing an integer - The reference cell. + + Creates an instance of the attribute + OptionalArgumentAttribute - - Dereference a mutable reference cell - The cell to dereference. - The value contained in the cell. + + This attribute is added automatically for all optional arguments. + + + Indicates if a constraint is asserted that the field type supports 'null' - - Assign to a mutable reference cell - The cell to mutate. - The value to set inside the cell. + + Creates an instance of the attribute + Indicates whether to assert that the field type supports null. + DefaultValueAttribute - - Create a mutable reference cell - The value to contain in the cell. - The created reference cell. + + Creates an instance of the attribute + DefaultValueAttribute - - The identity function - The input value. - The same value. + + Adding this attribute to a field declaration means that the field is + not initialized. During type checking a constraint is asserted that the field type supports 'null'. + If the 'check' value is false then the constraint is not asserted. - - Throw a System.InvalidOperationException exception - The exception message. - The result value. + + Creates an instance of the attribute + NoComparisonAttribute - - Throw a System.ArgumentNullException exception - The argument name. - The result value. + + Adding this attribute to a type indicates it is a type where comparison is an abnormal operation. + This means that the type does not satisfy the F# 'comparison' constraint. Within the bounds of the + F# type system, this helps ensure that the F# generic comparison function is not instantiated directly + at this type. The attribute and checking does not constrain the use of comparison with base or child + types of this type. - - Throw a System.ArgumentException exception with - the given argument name and message. - The argument name. - The exception message. - The result value. + + Creates an instance of the attribute + CustomComparisonAttribute - - Throw a System.Exception exception. - The exception message. - The result value. + + Adding this attribute to a type indicates it is a type with a user-defined implementation of comparison. - - Determines whether the given value is null. - The value to check. - True when value is null, false otherwise. + + Creates an instance of the attribute + CustomEqualityAttribute - - Try to unbox a strongly typed value. - The boxed value. - The unboxed result as an option. + + Adding this attribute to a type indicates it is a type with a user-defined implementation of equality. - - Boxes a strongly typed value. - The value to box. - The boxed object. + + Creates an instance of the attribute + NoEqualityAttribute - - Unboxes a strongly typed value. - The boxed value. - The unboxed result. + + Adding this attribute to a type indicates it is a type where equality is an abnormal operation. + This means that the type does not satisfy the F# 'equality' constraint. Within the bounds of the + F# type system, this helps ensure that the F# generic equality function is not instantiated directly + at this type. The attribute and checking does not constrain the use of comparison with base or child + types of this type. - - Ignore the passed value. This is often used to throw away results of a computation. - The value to ignore. + + Creates an instance of the attribute + ProjectionParameterAttribute - - Minimum based on generic comparison - The first value. - The second value. - The minimum value. + + Indicates that, when a custom operator is used in a computation expression, + a parameter is automatically parameterized by the variable space of the computation expression - - Maximum based on generic comparison - The first value. - The second value. - The maximum value. + + Indicates if the custom operation maintains the variable space of the query of computation expression through the use of a bind operation - - Generic comparison. - The first value. - The second value. - The result of the comparison. + + Indicates if the custom operation maintains the variable space of the query of computation expression - - Return the second element of a tuple, snd (a,b) = b. - The input tuple. - The second value. + + Indicates the name used for the 'on' part of the custom query operator for join-like operators - - Return the first element of a tuple, fst (a,b) = a. - The input tuple. - The first value. + + Indicates if the custom operation is an operation similar to a zip in a sequence computation, supporting two inputs - - Matches System.Exception objects whose runtime type is precisely System.Exception - The input exception. - A string option. + + Indicates if the custom operation is an operation similar to a join in a sequence computation, supporting two inputs and a correlation constraint - - Builds a System.Exception object. - The message for the Exception. - A System.Exception. + + Indicates if the custom operation is an operation similar to a group join in a sequence computation, supporting two inputs and a correlation constraint, and generating a group - - Rethrows an exception. This should only be used when handling an exception - The result value. + + Indicates if the custom operation supports the use of 'into' immediately after the use of the operation in a query or other computation expression to consume the results of the operation - - Rethrows an exception. This should only be used when handling an exception - The result value. + + Get the name of the custom operation when used in a query or other computation expression - - Raises an exception - The exception to raise. - The result value. + + Indicates if the custom operation maintains the variable space of the query of computation expression through the use of a bind operation - - Concatenate two strings. The operator '+' may also be used. + + Indicates if the custom operation maintains the variable space of the query of computation expression - - Used to specify a default value for an optional argument in the implementation of a function - An option representing the argument. - The default value of the argument. - The argument value. If it is None, the defaultValue is returned. + + Indicates the name used for the 'on' part of the custom query operator for join-like operators - - Apply a function to three values, the values being a triple on the right, the function on the left - The function. - The first argument. - The second argument. - The third argument. - The function result. + + Indicates if the custom operation is an operation similar to a zip in a sequence computation, supporting two inputs - - Apply a function to two values, the values being a pair on the right, the function on the left - The function. - The first argument. - The second argument. - The function result. + + Indicates if the custom operation is an operation similar to a join in a sequence computation, supporting two inputs and a correlation constraint - - Apply a function to a value, the value being on the right, the function on the left - The function. - The argument. - The function result. + + Indicates if the custom operation is an operation similar to a group join in a sequence computation, supporting two inputs and a correlation constraint, and generating a group - - Apply a function to three values, the values being a triple on the left, the function on the right - The first argument. - The second argument. - The third argument. - The function. - The function result. + + Indicates if the custom operation supports the use of 'into' immediately after the use of the operation in a query or other computation expression to consume the results of the operation - - Apply a function to two values, the values being a pair on the left, the function on the right - The first argument. - The second argument. - The function. - The function result. + + Creates an instance of the attribute + CustomOperationAttribute - - Apply a function to a value, the value being on the left, the function on the right - The argument. - The function. - The function result. + + + Indicates that a member on a computation builder type is a custom query operator, + and indicates the name of that operator. + - - Compose two functions, the function on the right being applied first - The second function to apply. - The first function to apply. - The composition of the input functions. + + Creates an instance of the attribute + StructuralComparisonAttribute - - Compose two functions, the function on the left being applied first - The first function to apply. - The second function to apply. - The composition of the input functions. + + Adding this attribute to a record, union, exception, or struct type confirms the + automatic generation of implementations for 'System.IComparable' for the type. - - Structural inequality - The first parameter. - The second parameter. - The result of the comparison. + + Creates an instance of the attribute + StructuralEqualityAttribute - - Structural equality - The first parameter. - The second parameter. - The result of the comparison. + + Adding this attribute to a record, union or struct type confirms the automatic + generation of overrides for 'System.Object.Equals(obj)' and + 'System.Object.GetHashCode()' for the type. - - Structural less-than-or-equal comparison - The first parameter. - The second parameter. - The result of the comparison. + + Creates an instance of the attribute + ReferenceEqualityAttribute - - Structural greater-than-or-equal - The first parameter. - The second parameter. - The result of the comparison. + + Adding this attribute to a record or union type disables the automatic generation + of overrides for 'System.Object.Equals(obj)', 'System.Object.GetHashCode()' + and 'System.IComparable' for the type. The type will by default use reference equality. - - Structural greater-than - The first parameter. - The second parameter. - The result of the comparison. + + Creates an instance of the attribute + EntryPointAttribute - - Structural less-than comparison - The first parameter. - The second parameter. - The result of the comparison. + + Adding this attribute to a function indicates it is the entrypoint for an application. + If this attribute is not specified for an EXE then the initialization implicit in the + module bindings in the last file in the compilation sequence are used as the entrypoint. - - Overloaded prefix-plus operator - The input value. - The result of the operation. + + Creates an instance of the attribute + VolatileFieldAttribute - - Overloaded bitwise-NOT operator - The input value. - The result of the operation. + + Adding this attribute to an F# mutable binding causes the "volatile" + prefix to be used for all accesses to the field. - - Overloaded byte-shift right operator by a specified number of bits - The input value. - The amount to shift. - The result of the operation. + + The value of the attribute, indicating whether the type has a default augmentation or not - - Overloaded byte-shift left operator by a specified number of bits - The input value. - The amount to shift. - The result of the operation. + + Creates an instance of the attribute + Indicates whether to generate helper members on the CLI class representing a discriminated + union. + DefaultAugmentationAttribute - - Overloaded bitwise-XOR operator - The first parameter. - The second parameter. - The result of the operation. + + Adding this attribute to a discriminated union with value false + turns off the generation of standard helper member tester, constructor + and accessor members for the generated CLI class for that type. - - Overloaded bitwise-OR operator - The first parameter. - The second parameter. - The result of the operation. + + Creates an instance of the attribute + CLIMutableAttribute - - Overloaded bitwise-AND operator - The first parameter. - The second parameter. - The result of the operation. + + Adding this attribute to a record type causes it to be compiled to a CLI representation + with a default constructor with property getters and setters. - - Overloaded modulo operator - The first parameter. - The second parameter. - The result of the operation. + + Creates an instance of the attribute + CLIEventAttribute - - Overloaded division operator - The first parameter. - The second parameter. - The result of the operation. + + Adding this attribute to a property with event type causes it to be compiled with as a CLI + metadata event, through a syntactic translation to a pair of 'add_EventName' and + 'remove_EventName' methods. - - Overloaded multiplication operator - The first parameter. - The second parameter. - The result of the operation. + + Creates an instance of the attribute + LiteralAttribute - - Overloaded subtraction operator - The first parameter. - The second parameter. - The result of the operation. + + Adding this attribute to a value causes it to be compiled as a CLI constant literal. - - Overloaded addition operator - The first parameter. - The second parameter. - The result of the operation. + + The value of the attribute, indicating whether the type allows the null literal or not - - Overloaded unary negation. - The value to negate. - The result of the operation. + + Creates an instance of the attribute with the specified value + AllowNullLiteralAttribute - - Converts the argument to char. Numeric inputs are converted using a checked - conversion according to the UTF-16 encoding for characters. String inputs must - be exactly one character long. For other input types the operation requires an - appropriate static conversion method on the input type. - The input value. - The converted char + + Creates an instance of the attribute + AllowNullLiteralAttribute - - Converts the argument to unativeint. This is a direct, checked conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted unativeint + + Adding this attribute to a type lets the 'null' literal be used for the type + within F# code. This attribute may only be added to F#-defined class or + interface types. - - Converts the argument to nativeint. This is a direct, checked conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted nativeint + + Creates an instance of the attribute + ClassAttribute - - Converts the argument to uint64. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.UInt64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint64 + + Adding this attribute to a type causes it to be represented using a CLI class. - - Converts the argument to int64. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int64 + + Creates an instance of the attribute + InterfaceAttribute - - Converts the argument to uint32. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.UInt32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint32 + + Adding this attribute to a type causes it to be represented using a CLI interface. - - Converts the argument to int32. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int32 + + Creates an instance of the attribute + MeasureAnnotatedAbbreviationAttribute - - Converts the argument to int. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int + + Adding this attribute to a type causes it to be interpreted as a refined type, currently limited to measure-parameterized types. + This may only be used under very limited conditions. - - Converts the argument to uint16. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.UInt16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint16 + + Creates an instance of the attribute + MeasureAttribute - - Converts the argument to int16. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int16 + + Adding this attribute to a type causes it to be interpreted as a unit of measure. + This may only be used under very limited conditions. - - Converts the argument to sbyte. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.SByte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte + + Creates an instance of the attribute + StructAttribute - - Converts the argument to byte. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Byte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte + + Adding this attribute to a type causes it to be represented using a CLI struct. - - Overloaded multiplication operator (checks for overflow) - The first value. - The second value. - The product of the two input values. + + Creates an instance of the attribute + ComparisonConditionalOnAttribute + + + This attribute is used to indicate a generic container type satisfies the F# 'comparison' + constraint only if a generic argument also satisfies this constraint. For example, adding + this attribute to parameter 'T on a type definition C<'T> means that a type C<X> only supports + comparison if the type X also supports comparison and all other conditions for C<X> to support + comparison are also met. The type C<'T> can still be used with other type arguments, but a type such + as C<(int -> int)> will not support comparison because the type (int -> int) is an F# function type + and does not support comparison. + + This attribute will be ignored if it is used on the generic parameters of functions or methods. - - Overloaded addition operator (checks for overflow) - The first value. - The second value. - The sum of the two input values. + + Creates an instance of the attribute + EqualityConditionalOnAttribute - - Overloaded subtraction operator (checks for overflow) - The first value. - The second value. - The first value minus the second value. + + This attribute is used to indicate a generic container type satisfies the F# 'equality' + constraint only if a generic argument also satisfies this constraint. For example, adding + this attribute to parameter 'T on a type definition C<'T> means that a type C<X> only supports + equality if the type X also supports equality and all other conditions for C<X> to support + equality are also met. The type C<'T> can still be used with other type arguments, but a type such + as C<(int -> int)> will not support equality because the type (int -> int) is an F# function type + and does not support equality. + + This attribute will be ignored if it is used on the generic parameters of functions or methods. - - Overloaded unary negation (checks for overflow) - The input value. - The negated value. + + The value of the attribute, indicating whether to include the evaluated value of the definition as the outer node of the quotation - - This module contains the basic arithmetic operations with overflow checks. + + Creates an instance of the attribute + Indicates whether to include the evaluated value of the definition as the outer node of the quotation + ReflectedDefinitionAttribute - - Calls GetHashCode() on the value - The value. - The hash code. + + Creates an instance of the attribute + ReflectedDefinitionAttribute - - Minimum of the two values - The first value. - The second value. - The minimum value. + + Adding this attribute to the let-binding for the definition of a top-level + value makes the quotation expression that implements the value available + for use at runtime. - - Maximum of the two values - The first value. - The second value. - The maximum value. + + Creates an instance of the attribute + AbstractClassAttribute - - Compares the two values - The first value. - The second value. - The result of the comparison. + + Adding this attribute to class definition makes it abstract, which means it need not + implement all its methods. Instances of abstract classes may not be constructed directly. - - Compares the two values for inequality - The first parameter. - The second parameter. - The result of the comparison. + + The value of the attribute, indicating whether the type is sealed or not. - - Compares the two values for equality - The first parameter. - The second parameter. - The result of the comparison. + + Creates an instance of the attribute + Indicates whether the class is sealed. + SealedAttribute - - Compares the two values for less-than-or-equal - The first parameter. - The second parameter. - The result of the comparison. + + Creates an instance of the attribute. + The created attribute. - - Compares the two values for greater-than-or-equal - The first parameter. - The second parameter. - The result of the comparison. + + Adding this attribute to class definition makes it sealed, which means it may not + be extended or implemented. - - Compares the two values for greater-than - The first parameter. - The second parameter. - The result of the comparison. + + Compile a property as a CLI event. - - Compares the two values for less-than - The first parameter. - The second parameter. - The result of the comparison. + + Permit the use of null as a representation for nullary discriminators in a discriminated union. - - A module of comparison and equality operators that are statically resolved, but which are not fully generic and do not make structural comparison. Opening this - module may make code that relies on structural or generic comparison no longer compile. + + append 'Module' to the end of a module whose name clashes with a type name in the same namespace. - - Perform generic hashing on a value where the type of the value is not - statically required to satisfy the 'equality' constraint. - The computed hash value. + + Compile a member as 'instance' even if null is used as a representation for this type. - - Perform generic equality on two values where the type of the values is not - statically required to satisfy the 'equality' constraint. - The result of the comparison. + + Compile an instance member as 'static' . - - Perform generic comparison on two values where the type of the values is not - statically required to have the 'comparison' constraint. - The result of the comparison. + + No special compilation representation. - - Generate a default value for any type. This is null for reference types, - For structs, this is struct value where all fields have the default value. - This function is unsafe in the sense that some F# values do not have proper null values. + + Indicates one or more adjustments to the compiled representation of an F# type or member. - - Unboxes a strongly typed value. This is the inverse of box, unbox<t>(box<t> a) equals a. - The boxed value. - The unboxed result. + + Indicates that the compiled entity had private or internal representation in F# source code. - - This module contains basic operations which do not apply runtime and/or static checks + + The mask of values related to the kind of the compiled entity. - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator + + Indicates that the compiled entity is part of the representation of an F# value declaration. - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'decimal' + + Indicates that the compiled entity is part of the representation of an F# union case declaration. - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'float' + + Indicates that the compiled entity is part of the representation of an F# module declaration. - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'float32' + + Indicates that the compiled entity is part of the representation of an F# closure. - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'unativeint' + + Indicates that the compiled entity is part of the representation of an F# exception declaration. - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'nativeint' + + Indicates that the compiled entity is part of the representation of an F# record or union case field declaration. - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint64' + + Indicates that the compiled entity is part of the representation of an F# class or other object type declaration. - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int64' + + Indicates that the compiled entity is part of the representation of an F# record type declaration. - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint32' + + Indicates that the compiled entity is part of the representation of an F# union type declaration. - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int32' + + Indicates that the compiled entity has no relationship to an element in F# source code. - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint16' + + Indicates the relationship between a compiled entity in a CLI binary and an element in F# source code. - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int16' + + The type 'unit', which has only one value "()". This value is special and + always uses the representation 'null'. - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'sbyte' + + The type 'unit', which has only one value "()". This value is special and + always uses the representation 'null'. - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'byte' + + Type of a formatting expression. + Function type generated by printf. + Type argument passed to %a formatters + Value generated by the overall printf action (e.g. sprint generates a string) + Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) + Tuple of values generated by scan or match. - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. + + Type of a formatting expression. + Function type generated by printf. + Type argument passed to %a formatters + Value generated by the overall printf action (e.g. sprint generates a string) + Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. + + Construct a format string + The input string. + The created format string. - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. + + Type of a formatting expression. + Function type generated by printf. + Type argument passed to %a formatters + Value generated by the overall printf action (e.g. sprint generates a string) + Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) + Tuple of values generated by scan or match. - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. + + The raw text of the format string. - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. + + Construct a format string + The input string. + The PrintfFormat containing the formatted result. - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. + + Type of a formatting expression. + Function type generated by printf. + Type argument passed to %a formatters + Value generated by the overall printf action (e.g. sprint generates a string) + Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. + + Non-exhaustive match failures will raise the MatchFailureException exception - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. + + maxDegreeOfParallelism must be positive, was {0} - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. + + This is not a valid query expression. The construct '{0}' was used in a query but is not recognized by the F#-to-LINQ query translator. Check the specification of permitted queries and consider moving some of the operations out of the query expression. - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. + + This is not a valid query expression. The property '{0}' was used in a query but is not recognized by the F#-to-LINQ query translator. Check the specification of permitted queries and consider moving some of the operations out of the query expression. - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. + + This is not a valid query expression. The method '{0}' was used in a query but is not recognized by the F#-to-LINQ query translator. Check the specification of permitted queries and consider moving some of the operations out of the query expression - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. + + This is not a valid query expression. The following construct was used in a query but is not recognized by the F#-to-LINQ query translator:\n{0}\nCheck the specification of permitted queries and consider moving some of the operations out of the query expression. - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. + + An if/then/else conditional or pattern matching expression with multiple branches is not permitted in a query. An if/then/else conditional may be used. - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. + + Unrecognized use of a 'sumBy' or 'averageBy' operator in a query. In queries whose original data is of static type IQueryable, these operators may only be used with result type int32, int64, single, double or decimal - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. + + 'thenBy' and 'thenByDescending' may only be used with an ordered input - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. + + The input sequence contains more than one element. - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. + + The tuple type '{0}' is invalid. Required constructor is not defined. - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. + + The record type '{0}' is invalid. Required constructor is not defined. - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. + + A continuation provided by Async.FromContinuations was invoked multiple times - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. + + The option value was None - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. + + This value cannot be mutated - - Generate a range of values using the given zero, add, start, step and stop values + + type argument out of range - - Generate a range of values using the given zero, add, start, step and stop values + + ill formed expression: AppOp or LetOp - - Generate a range of char values + + Failed to bind assembly '{0}' while processing quotation data - - Generate a range of byte values + + Cannot take the address of this quotation - - Generate a range of sbyte values + + Could not bind to method - - Generate a range of uint16 values + + Could not bind property {0} in type {1} - - Generate a range of int16 values + + Could not bind function {0} in type {1} - - Generate a range of unativeint values + + Bad format specifier (width) - - Generate a range of nativeint values + + Bad format specifier (after {0}) - - Generate a range of uint32 values + + Bad format specifier (precision) - - Generate a range of uint64 values + + Not a function type - - Generate a range of int64 values + + Missing format specifier - - Generate a range of float32 values + + The # formatting modifier is invalid in F# - - Generate a range of float values + + Expected a width argument - - Generate a range of integers + + Expected a precision argument - - Gets a slice from a string - The source string. - The index of the first character of the slice. - The index of the last character of the slice. - The substring from the given indices. + + Bad integer supplied to dynamic formatter - - Sets a slice of an array - The target array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The start index of the fourth dimension. - The end index of the fourth dimension. - The source array. + + Bad format specifier:{0} - - Gets a slice of an array - The source array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The start index of the fourth dimension. - The end index of the fourth dimension. - The four dimensional sub array from the given indices. + + Bad float value - - Sets a slice of an array - The target array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The source array. + + Multiple CompilationMappingAttributes, expected at most one - - Gets a slice of an array - The source array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The three dimensional sub array from the given indices. + + MoveNext not called, or finished - - Sets a vector slice of a 2D array. The index of the second dimension is fixed. - The target array. - The start index of the first dimension. - The end index of the first dimension. - The index of the second dimension. - The source array. + + first class uses of '%' or '%%' are not permitted - - Sets a vector slice of a 2D array. The index of the first dimension is fixed. - The target array. - The index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The source array. + + The constructor method '{0}' for the union case could not be found - - Sets a region slice of an array - The target array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The source array. + + An index satisfying the predicate was not found in the collection. - - Gets a vector slice of a 2D array. The index of the second dimension is fixed. - The source array. - The start index of the first dimension. - The end index of the first dimension. - The fixed index of the second dimension. - The sub array from the input indices. + + The method '{0}' expects {1} type arguments but {2} were provided - - Gets a vector slice of a 2D array. The index of the first dimension is fixed. - The source array. - The index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The sub array from the input indices. + + Writing a get-only property - - Gets a region slice of an array - The source array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The two dimensional sub array from the input indices. + + F# union type requires different number of arguments - - Sets a slice of an array - The target array. - The start index. - The end index. - The source array. + + The tuple lengths are different - - Gets a slice of an array - The input array. - The start index. - The end index. - The sub array from the input indices. + + Tuple access out of range - - A module of compiler intrinsic functions for efficient implementations of F# integer ranges - and dynamic invocations of other F# operators + + Type mismatch when splicing expression into quotation literal. The type of the expression tree being inserted doesn't match the type expected by the splicing operation. Expected '{0}', but received type '{1}'. Consider type-annotating with the expected expression type, e.g., (%% x : {0}) or (%x : {0}). - - Basic F# Operators. This module is automatically opened in all F# code. + + Type mismatch when building '{0}': function type doesn't match delegate type. Expected '{1}', but received type '{2}'. - - Invoke an F# first class function value that accepts five curried arguments - without intervening execution - The first arg. - The second arg. - The third arg. - The fourth arg. - The fifth arg. - The function result. + + Type mismatch when building '{0}': the expression has the wrong type. Expected '{1}', but received type '{2}'. - - Adapt an F# first class function value to be an optimized function value that can - accept five curried arguments without intervening execution. - The input function. - The optimized function. + + Receiver object was unexpected, as member is static - - Construct an optimized function value that can accept five curried - arguments without intervening execution. - The optimized function. + + Reading a set-only property - - The CLI type used to represent F# function values that accept five curried arguments - without intervening execution. This type should not typically used directly from - either F# code or from other CLI languages. + + Parent type cannot be null - - Invoke an F# first class function value that accepts four curried arguments - without intervening execution - The first arg. - The second arg. - The third arg. - The fourth arg. - The function result. + + The member is non-static (instance), but no receiver object was supplied - - Adapt an F# first class function value to be an optimized function value that can - accept four curried arguments without intervening execution. - The input function. - The optimized function. + + Invalid function type - - Construct an optimized function value that can accept four curried - arguments without intervening execution. - The optimized function. + + Incorrect type - - The CLI type used to represent F# function values that accept four curried arguments - without intervening execution. This type should not typically used directly from - either F# code or from other CLI languages. + + Incorrect number of arguments - - Invoke an F# first class function value that accepts three curried arguments - without intervening execution - The first arg. - The second arg. - The third arg. - The function result. + + Incorrect instance type - - Adapt an F# first class function value to be an optimized function value that can - accept three curried arguments without intervening execution. - The input function. - The adapted function. + + Incompatible record length - - Construct an optimized function value that can accept three curried - arguments without intervening execution. - The optimized function. + + Failed to bind type '{0}' in assembly '{1}' - - The CLI type used to represent F# function values that accept - three iterated (curried) arguments without intervening execution. This type should not - typically used directly from either F# code or from other CLI languages. + + Failed to bind property '{0}' - - Invoke the optimized function value with two curried arguments - The first arg. - The second arg. - The function result. + + Failed to bind field '{0}' - - Adapt an F# first class function value to be an optimized function value that can - accept two curried arguments without intervening execution. - The input function. - The adapted function. + + Failed to bind constructor - - Construct an optimized function value that can accept two curried - arguments without intervening execution. - The optimized function. + + The tuple index '{1}' was out of range for tuple type '{0}'. - - The CLI type used to represent F# function values that accept - two iterated (curried) arguments without intervening execution. This type should not - typically used directly from either F# code or from other CLI languages. + + The System.Threading.SynchronizationContext.Current of the calling thread is null. - - An implementation module used to hold some private implementations of function - value invocation. + + The step of a range cannot be zero. - - Convert an option to a potentially null value. - The input value. - The result value, which is null if the input was None. + + The step of a range cannot be NaN. - - Convert a potentially null value to an option. - The input value. - The result option. + + The start of a range cannot be NaN. - - Convert a Nullable value to an option. - The input nullable value. - The result option. + + Reset is not supported on this enumerator. - - Convert the option to a Nullable value. - The input option. - The result value. + + The parameter is not a recognized method name. - - Convert the option to a list of length 0 or 1. - The input option. - The result list. + + Unexpected quotation hole in expression. - - Convert the option to an array of length 0 or 1. - The input option. - The result array. + + Type mismatch when building '{0}': the variable type doesn't match the type of the right-hand-side of a let binding. Expected '{1}', but received type '{2}'. - - filter f inp evaluates to match inp with None -> None | Some x -> if f x then Some x else None. - A function that evaluates whether the value contained in the option should remain, or be filtered out. - The input option. - The input if the predicate evaluates to true; otherwise, None. + + Type mismatch when building '{0}': mismatched type of argument and tuple element. Expected '{1}', but received type '{2}'. - - bind f inp evaluates to match inp with None -> None | Some x -> f x - A function that takes the value of type T from an option and transforms it into - an option containing a value of type U. - The input option. - An option of the output type of the binder. + + Type mismatch when building '{0}': types of true and false branches differ. Expected '{1}', but received type '{2}'. - - map f inp evaluates to match inp with None -> None | Some x -> Some (f x). - A function to apply to the option value. - The input option. - An option of the input value after applying the mapping function, or None if the input is None. + + Type mismatch when building '{0}': lower and upper bounds must be integers. Expected '{1}', but received type '{2}'. - - iter f inp executes match inp with None -> () | Some x -> f x. - A function to apply to the option value. - The input option. - Unit if the option is None, otherwise it returns the result of applying the predicate - to the option value. + + Type mismatch when building '{0}': body of the for loop must be lambda taking integer as an argument. Expected '{1}', but received type '{2}'. - - forall p inp evaluates to match inp with None -> true | Some x -> p x. - A function that evaluates to a boolean when given a value from the option type. - The input option. - True if the option is None, otherwise it returns the result of applying the predicate - to the option value. + + Type mismatch when building '{0}': invalid parameter for a method or indexer property. Expected '{1}', but received type '{2}'. - - exists p inp evaluates to match inp with None -> false | Some x -> p x. - A function that evaluates to a boolean when given a value from the option type. - The input option. - False if the option is None, otherwise it returns the result of applying the predicate - to the option value. + + Type mismatch when building '{0}': initializer doesn't match array type. Expected '{1}', but received type '{2}'. - - fold f inp s evaluates to match inp with None -> s | Some x -> f x s. - A function to update the state data when given a value from an option. - The input option. - The initial state. - The original state if the option is None, otherwise it returns the updated state with the folder - and the option value. + + Type mismatch when building '{0}': incorrect argument type for an F# union. Expected '{1}', but received type '{2}'. - - fold f s inp evaluates to match inp with None -> s | Some x -> f s x. - A function to update the state data when given a value from an option. - The initial state. - The input option. - The original state if the option is None, otherwise it returns the updated state with the folder - and the option value. + + Type mismatch when building '{0}': incorrect argument type for an F# record. Expected '{1}', but received type '{2}'. - - count inp evaluates to match inp with None -> 0 | Some _ -> 1. - The input option. - A zero if the option is None, a one otherwise. + + Type mismatch when building '{0}': guard must return boolean. Expected '{1}', but received type '{2}'. - - Gets the value associated with the option. - The input option. - The value within the option. - Thrown when the option is None. + + Type mismatch when building '{0}': function argument type doesn't match. Expected '{1}', but received type '{2}'. - - Returns true if the option is None. - The input option. - True if the option is None. + + Type mismatch when building '{0}': types of expression does not match. Expected '{1}', but received type '{2}'. - - Returns true if the option is not None. - The input option. - True if the option is not None. + + Type mismatch when building '{0}': expression doesn't match the tuple type. Expected '{1}', but received type '{2}'. - - Basic operations on options. + + Type mismatch when building '{0}': expected function type in function application or let binding. Expected '{1}', but received type '{2}'. - - Represents a statically-analyzed format associated with writing to a System.IO.TextWriter. The type parameter indicates the - arguments and return type of the format operation. + + Type mismatch when building '{0}': condition expression must be of type bool. Expected '{1}', but received type '{2}'. - - Represents a statically-analyzed format when formatting builds a string. The type parameter indicates the - arguments and return type of the format operation. + + Type mismatch when building '{0}': body must return unit. Expected '{1}', but received type '{2}'. - - Represents a statically-analyzed format associated with writing to a System.Text.StringBuilder. The type parameter indicates the - arguments and return type of the format operation. + + Type mismatch when building '{0}': the type of the field was incorrect. Expected '{1}', but received type '{2}'. - - Represents a statically-analyzed format associated with writing to a System.IO.TextWriter. The first type parameter indicates the - arguments of the format operation and the last the overall return type. + + Type '{0}' did not have an F# union case named '{1}'. - - Represents a statically-analyzed format when formatting builds a string. The first type parameter indicates the - arguments of the format operation and the last the overall return type. + + Type '{0}' did not have an F# record field named '{1}'. - - Represents a statically-analyzed format associated with writing to a System.Text.StringBuilder. The first type parameter indicates the - arguments of the format operation and the last the overall return type. + + Not a valid F# union case index. - - Print to a string buffer and raise an exception with the given - result. Helper printers must return strings. - The input formatter. - The arguments of the formatter. + + Expected exactly two type arguments. - - sprintf, but call the given 'final' function to generate the result. - See kprintf. - The function called to generate a result from the formatted string. - The input formatter. - The arguments of the formatter. + + Expected exactly one type argument. - - printf, but call the given 'final' function to generate the result. - For example, these let the printing force a flush after all output has - been entered onto the channel, but not before. - The function called after formatting to generate the format result. - The input formatter. - The arguments of the formatter. + + The type '{0}' is an F# union type but its representation is private. You must specify BindingFlags.NonPublic to access private type representations. - - fprintf, but call the given 'final' function to generate the result. - See kprintf. - The function called after formatting to generate the format result. - The input TextWriter. - The input formatter. - The arguments of the formatter. + + The type '{0}' is an F# record type but its representation is private. You must specify BindingFlags.NonPublic to access private type representations. - - bprintf, but call the given 'final' function to generate the result. - See kprintf. - The function called after formatting to generate the format result. - The input StringBuilder. - The input formatter. - The arguments of the formatter. + + The type '{0}' is the representation of an F# exception declaration but its representation is private. You must specify BindingFlags.NonPublic to access private type representations. - - Print to a string via an internal string buffer and return - the result as a string. Helper printers must return strings. - The input formatter. - The formatted string. + + The index is outside the legal range. - - Formatted printing to stdout, adding a newline. - The input formatter. - The return type and arguments of the formatter. + + The object is null and no type was given. Either pass a non-null object or a non-null type parameter. - - Formatted printing to stdout - The input formatter. - The return type and arguments of the formatter. + + The object is not an F# record value. - - Formatted printing to stderr, adding a newline - The input formatter. - The return type and arguments of the formatter. + + One of the elements in the array is null. - - Formatted printing to stderr - The input formatter. - The return type and arguments of the formatter. + + This object is for recursive equality calls and cannot be used for hashing. - - Print to a text writer, adding a newline - The TextWriter to print to. - The input formatter. - The return type and arguments of the formatter. + + The input sequence has an insufficient number of elements. - - Print to a text writer. - The TextWriter to print to. - The input formatter. - The return type and arguments of the formatter. + + The two objects have different types and are not comparable. - - Print to a System.Text.StringBuilder - The StringBuilder to print to. - The input formatter. - The return type and arguments of the formatter. + + Type '{0}' is not an F# union type. - - Extensible printf-style formatting for numbers and other datatypes - - Format specifications are strings with "%" markers indicating format - placeholders. Format placeholders consist of: - - %[flags][width][.precision][type] - - where the type is interpreted as follows: - - %b: bool, formatted as "true" or "false" - %s: string, formatted as its unescaped contents - %c: character literal - %d, %i: any basic integer type formatted as a decimal integer, signed if the basic integer type is signed. - %u: any basic integer type formatted as an unsigned decimal integer - %x, %X, %o: any basic integer type formatted as an unsigned hexadecimal - (a-f)/Hexadecimal (A-F)/Octal integer - - %e, %E, %f, %F, %g, %G: - any basic floating point type (float,float32) formatted - using a C-style floating point format specifications, i.e - - %e, %E: Signed value having the form [-]d.dddde[sign]ddd where - d is a single decimal digit, dddd is one or more decimal - digits, ddd is exactly three decimal digits, and sign - is + or - - - %f: Signed value having the form [-]dddd.dddd, where dddd is one - or more decimal digits. The number of digits before the - decimal point depends on the magnitude of the number, and - the number of digits after the decimal point depends on - the requested precision. - - %g, %G: Signed value printed in f or e format, whichever is - more compact for the given value and precision. - - - %M: System.Decimal value - - %O: Any value, printed by boxing the object and using it's ToString method(s) - - %A: Any value, printed with the default layout settings - - %a: A general format specifier, requires two arguments: - (1) a function which accepts two arguments: - (a) a context parameter of the appropriate type for the - given formatting function (e.g. an #System.IO.TextWriter) - (b) a value to print - and which either outputs or returns appropriate text. - - (2) the particular value to print - - - %t: A general format specifier, requires one argument: - (1) a function which accepts a context parameter of the - appropriate type for the given formatting function (e.g. - an System.IO.TextWriter)and which either outputs or returns - appropriate text. - - Basic integer types are: - byte,sbyte,int16,uint16,int32,uint32,int64,uint64,nativeint,unativeint - Basic floating point types are: - float, float32 - - The optional width is an integer indicating the minimal width of the - result. For instance, %6d prints an integer, prefixing it with spaces - to fill at least 6 characters. If width is '*', then an extra integer - argument is taken to specify the corresponding width. - - any number - '*': - - Valid flags are: - - 0: add zeros instead of spaces to make up the required width - '-': left justify the result within the width specified - '+': add a '+' character if the number is positive (to match a '-' sign - for negatives) - ' ': add an extra space if the number is positive (to match a '-' - sign for negatives) - - The printf '#' flag is invalid and a compile-time error will be reported if it is used. + + Type '{0}' is not a tuple type. + + + Type '{0}' is not an F# record type. - - Returns the length of the string. - The input string. - The number of characters in the string. + + The function did not compute a permutation. - - Returns a string by concatenating count instances of str. - The number of copies of the input string will be copied. - The input string. - The concatenated string. - Thrown when count is negative. + + Type '{0}' is not the representation of an F# exception declaration. - - Tests if any character of the string satisfies the given predicate. - The function to test each character of the string. - The input string. - True if any character returns true for the predicate and false otherwise. + + Type '{0}' is not a function type. - - Tests if all characters in the string satisfy the given predicate. - The function to test each character of the string. - The input string. - True if all characters return true for the predicate and false otherwise. + + Arrays with non-zero base cannot be created on this platform. - - Builds a new string whose characters are the results of applying the function mapping - to each index from 0 to count-1 and concatenating the resulting - strings. - The number of strings to initialize. - The function to take an index and produce a string to - be concatenated with the others. - The constructed string. - Thrown when count is negative. + + The static initialization of a file or type resulted in static data being accessed recursively before it was fully initialized. - - Builds a new string containing only the characters of the input string - for which the given predicate returns "true". - - Returns an empty string if the input string is null - - A function to test whether each character in the input sequence should be included in the output string. - The input string. - The resulting string. + + The initialization of an object or value resulted in an object or value being accessed recursively before it was fully initialized. - - Builds a new string whose characters are the results of applying the function mapping - to each of the characters of the input string and concatenating the resulting - strings. - The function to produce a string from each character of the input string. - The input string. - The concatenated string. + + Negating the minimum value of a twos complement number is invalid. - - Builds a new string whose characters are the results of applying the function mapping - to each character and index of the input string. - The function to apply to each character and index of the string. - The input string. - The resulting string. + + The IAsyncResult object provided does not match this 'End' operation. - - Builds a new string whose characters are the results of applying the function mapping - to each of the characters of the input string. - The function to apply to the characters of the string. - The input string. - The resulting string. + + The IAsyncResult object provided does not match this 'Cancel' operation. - - Applies the function action to the index of each character in the string and the - character itself. - The function to apply to each character and index of the string. - The input string. + + Map values cannot be mutated. - - Applies the function action to each character in the string. - The function to be applied to each character of the string. - The input string. + + Mailbox.Scan timed out. - - Returns a new string made by concatenating the given strings - with separator sep, that is a1 + sep + ... + sep + aN. - The separator string to be inserted between the strings - of the input sequence. - The sequence of strings to be concatenated. - A new string consisting of the concatenated strings separated by - the separation string. - Thrown when strings is null. + + Mailbox.Receive timed out. - - Functional programming operators for string processing. Further string operations - are available via the member functions on strings and other functionality in - System.String - and System.Text.RegularExpressions types. + + MailboxProcessor.PostAndReply timed out. - - - The SI unit of catalytic activity - + + MailboxProcessor.PostAndAsyncReply timed out. - - - The SI unit of does equivalent - + + The MailboxProcessor has already been started. - - - The SI unit of absorbed dose - + + The lists had different lengths. - - - The SI unit of activity referred to a radionuclide - + + The item, key, or index was not found in the collection. - - - The SI unit of illuminance - + + This is not a valid tuple type for the F# reflection library. - - - The SI unit of luminous flux - + + The input sequence was empty. - - - The SI unit of inductance - + + The input must be positive. + + + The input must be non-negative. + + + The input list was empty. + + + The index was outside the range of elements in the list. + + + Failure during generic comparison: the type '{0}' does not implement the System.IComparable interface. This error may be arise from the use of a function such as 'compare', 'max' or 'min' or a data structure such as 'Set' or 'Map' whose keys contain instances of this type. + + + Failed to read enough bytes from the stream. + + + Enumeration based on System.Int32 exceeded System.Int32.MaxValue. + + + Set contains no elements. + + + Enumeration has not started. Call MoveNext. + + + Enumeration already finished. + + + The end of a range cannot be NaN. + + + Dynamic invocation of op_Multiply involving overloading is not supported. + + + Dynamic invocation of op_Multiply involving coercions is not supported. + + + Dynamic invocation of op_Addition involving overloading is not supported. + + + Dynamic invocation of op_Addition involving coercions is not supported. + + + Dynamic invocation of DivideByInt involving coercions is not supported. + + + Expecting delegate type. + + + Input string was not in a correct format. + + + The input array was empty. + + + The arrays have different lengths. + + + First class uses of address-of operators are not permitted. + + + The match cases were incomplete + + + An active pattern to match values of type System.Collections.Generic.KeyValuePair + The input key/value pair. + A tuple containing the key and value. + + + Converts the argument to character. Numeric inputs are converted according to the UTF-16 + encoding for characters. String inputs must be exactly one character long. For other + input types the operation requires an appropriate static conversion method on the input type. + The input value. + The converted char. + + + Converts the argument to System.Decimal using a direct conversion for all + primitive numeric types. For strings, the input is converted using UInt64.Parse() + with InvariantCulture settings. Otherwise the operation requires an appropriate + static conversion method on the input type. + The input value. + The converted decimal. + + + Converts the argument to a string using ToString. + + For standard integer and floating point values the ToString conversion + uses CultureInfo.InvariantCulture. + The input value. + The converted string. + + + Converts the argument to unsigned native integer using a direct conversion for all + primitive numeric types. Otherwise the operation requires an appropriate + static conversion method on the input type. + The input value. + The converted unativeint + + + Converts the argument to signed native integer. This is a direct conversion for all + primitive numeric types. Otherwise the operation requires an appropriate + static conversion method on the input type. + The input value. + The converted nativeint + + + Converts the argument to 64-bit float. This is a direct conversion for all + primitive numeric types. For strings, the input is converted using Double.Parse() + with InvariantCulture settings. Otherwise the operation requires an appropriate + static conversion method on the input type. + The input value. + The converted float + + + Converts the argument to 32-bit float. This is a direct conversion for all + primitive numeric types. For strings, the input is converted using Single.Parse() + with InvariantCulture settings. Otherwise the operation requires an appropriate + static conversion method on the input type. + The input value. + The converted float32 + + + Converts the argument to unsigned 64-bit integer. This is a direct conversion for all + primitive numeric types. For strings, the input is converted using UInt64.Parse() + with InvariantCulture settings. Otherwise the operation requires an appropriate + static conversion method on the input type. + The input value. + The converted uint64 + + + Converts the argument to signed 64-bit integer. This is a direct conversion for all + primitive numeric types. For strings, the input is converted using Int64.Parse() + with InvariantCulture settings. Otherwise the operation requires an appropriate + static conversion method on the input type. + The input value. + The converted int64 + + + Converts the argument to unsigned 32-bit integer. This is a direct conversion for all + primitive numeric types. For strings, the input is converted using UInt32.Parse() + with InvariantCulture settings. Otherwise the operation requires an appropriate + static conversion method on the input type. + The input value. + The converted uint32 + + + Converts the argument to signed 32-bit integer. This is a direct conversion for all + primitive numeric types. For strings, the input is converted using Int32.Parse() + with InvariantCulture settings. Otherwise the operation requires an appropriate + static conversion method on the input type. + The input value. + The converted int32 + + + Converts the argument to a particular enum type. + The input value. + The converted enum type. + + + Converts the argument to signed 32-bit integer. This is a direct conversion for all + primitive numeric types. For strings, the input is converted using Int32.Parse() + with InvariantCulture settings. Otherwise the operation requires an appropriate + static conversion method on the input type. + The input value. + The converted int + + + Converts the argument to unsigned 16-bit integer. This is a direct conversion for all + primitive numeric types. For strings, the input is converted using UInt16.Parse() + with InvariantCulture settings. Otherwise the operation requires an appropriate + static conversion method on the input type. + The input value. + The converted uint16 + + + Converts the argument to signed 16-bit integer. This is a direct conversion for all + primitive numeric types. For strings, the input is converted using Int16.Parse() + with InvariantCulture settings. Otherwise the operation requires an appropriate + static conversion method on the input type. + The input value. + The converted int16 + + + Converts the argument to signed byte. This is a direct conversion for all + primitive numeric types. For strings, the input is converted using SByte.Parse() + with InvariantCulture settings. Otherwise the operation requires an appropriate + static conversion method on the input type. + The input value. + The converted sbyte - - - The SI unit of magnetic flux density - + + Converts the argument to byte. This is a direct conversion for all + primitive numeric types. For strings, the input is converted using Byte.Parse() + with InvariantCulture settings. Otherwise the operation requires an appropriate + static conversion method on the input type. + The input value. + The converted byte - - - The SI unit of magnetic flux - + + Overloaded power operator. If n > 0 then equivalent to x*...*x for n occurrences of x. + The input base. + The input exponent. + The base raised to the exponent. - - - The SI unit of electric conductance - + + Overloaded power operator. + The input base. + The input exponent. + The base raised to the exponent. - - - The SI unit of electric resistance - + + Overloaded truncate operator. + The input value. + The truncated value. - - - The SI unit of capacitance - + + Hyperbolic tangent of the given number + The input value. + The hyperbolic tangent of the input. - - - The SI unit of electric potential difference, electromotive force - + + Tangent of the given number + The input value. + The tangent of the input. - - - The SI unit of electric charge, amount of electricity - + + Hyperbolic sine of the given number + The input value. + The hyperbolic sine of the input. - - - The SI unit of power, radiant flux - + + Sine of the given number + The input value. + The sine of the input. - - - The SI unit of energy, work, amount of heat - + + Hyperbolic cosine of the given number + The input value. + The hyperbolic cosine of the input. - - - The SI unit of pressure, stress - + + Cosine of the given number + The input value. + The cosine of the input. - - - The SI unit of force - + + Square root of the given number + The input value. + The square root of the input. - - - The SI unit of frequency - + + Logarithm to base 10 of the given number + The input value. + The logarithm to base 10 of the input. - - - The SI unit of luminous intensity - + + Natural logarithm of the given number + The input value. + The natural logarithm of the input. - - - The SI unit of amount of substance - + + Round the given number + The input value. + The nearest integer to the input value. - - - The SI unit of thermodynamic temperature - + + Sign of the given number + The input value. + -1, 0, or 1 depending on the sign of the input. - - - The SI unit of electric current - + + Floor of the given number + The input value. + The floor of the input. - - - The SI unit of time - + + Exponential of the given number + The input value. + The exponential of the input. - - - The SI unit of mass - + + Ceiling of the given number + The input value. + The ceiling of the input. - - - The SI unit of length - + + Inverse tangent of x/y where x and y are specified separately + The y input value. + The x input value. + The inverse tangent of the input ratio. - - - The SI unit of length - + + Inverse tangent of the given number + The input value. + The inverse tangent of the input. - - - A synonym for henry, the SI unit of inductance - + + Inverse sine of the given number + The input value. + The inverse sine of the input. - - - A synonym for katal, the SI unit of catalytic activity - + + Inverse cosine of the given number + The input value. + The inverse cosine of the input. - - - A synonym for sievert, the SI unit of does equivalent - + + Absolute value of the given number. + The input value. + The absolute value of the input. - - - A synonym for gray, the SI unit of absorbed dose - + + A generic hash function. This function has the same behaviour as 'hash', + however the default structural hashing for F# union, record and tuple + types stops when the given limit of nodes is reached. The exact behaviour of + the function can be adjusted on a type-by-type basis by implementing + GetHashCode for each type. + The limit of nodes. + The input object. + The computed hash. - - - A synonym for becquerel, the SI unit of activity referred to a radionuclide - + + A generic hash function, designed to return equal hash values for items that are + equal according to the "=" operator. By default it will use structural hashing + for F# union, record and tuple types, hashing the complete contents of the + type. The exact behaviour of the function can be adjusted on a + type-by-type basis by implementing GetHashCode for each type. + The input object. + The computed hash. - - - A synonym for lux, the SI unit of illuminance - + + Returns the internal size of a type in bytes. For example, sizeof<int> returns 4. - - - A synonym for lumen, the SI unit of luminous flux - + + Generate a System.Type representation for a type definition. If the + input type is a generic type instantiation then return the + generic type definition associated with all such instantiations. - - - A synonym for tesla, the SI unit of magnetic flux density - + + An internal, library-only compiler intrinsic for compile-time + generation of a RuntimeMethodHandle. - - - A synonym for weber, the SI unit of magnetic flux - + + Returns the name of the given symbol. - - - A synonym for UnitNames.ohm, the SI unit of electric resistance. - + + Generate a System.Type runtime representation of a static type. - - - A synonym for siemens, the SI unit of electric conductance - + + Clean up resources associated with the input object after the completion of the given function. + Cleanup occurs even when an exception is raised by the protected + code. + The resource to be disposed after action is called. + The action that accepts the resource. + The resulting value. - - - A synonym for farad, the SI unit of capacitance - + + Execute the function as a mutual-exclusion region using the input value as a lock. + The object to be locked. + The action to perform during the lock. + The resulting value. - - - A synonym for volt, the SI unit of electric potential difference, electromotive force - + + The standard overloaded skip range operator, e.g. [n..skip..m] for lists, seq {n..skip..m} for sequences + The start value of the range. + The step value of the range. + The end value of the range. + The sequence spanning the range using the specified step size. - - - A synonym for coulomb, the SI unit of electric charge, amount of electricity - + + The standard overloaded range operator, e.g. [n..m] for lists, seq {n..m} for sequences + The start value of the range. + The end value of the range. + The sequence spanning the range. - - - A synonym for watt, the SI unit of power, radiant flux - + + Reads the value of the property System.Console.Out. - - - A synonym for joule, the SI unit of energy, work, amount of heat - + + Reads the value of the property System.Console.Error. - - - A synonym for pascal, the SI unit of pressure, stress - + + Reads the value of the property System.Console.In. - - - A synonym for newton, the SI unit of force - + + Equivalent to System.Single.NaN - - - A synonym for hertz, the SI unit of frequency - + + Equivalent to System.Single.PositiveInfinity - - - A synonym for candela, the SI unit of luminous intensity - + + Equivalent to System.Double.NaN - - - A synonym for mole, the SI unit of amount of substance - + + Equivalent to System.Double.PositiveInfinity - - - A synonym for kelvin, the SI unit of thermodynamic temperature - + + Exit the current hardware isolated process, if security settings permit, + otherwise raise an exception. Calls System.Environment.Exit. + The exit code to use. + The result value. - - - A synonym for ampere, the SI unit of electric current - + + Builds a sequence using sequence expression syntax + The input sequence. + The result sequence. - - - A synonym for second, the SI unit of time - + + Negate a logical value. Not True equals False and not False equals True + The value to negate. + The result of the negation. - - - A synonym for kilogram, the SI unit of mass - + + Concatenate two lists. + The first list. + The second list. + The concatenation of the lists. - - - A synonym for Metre, the SI unit of length - + + Increment a mutable reference cell containing an integer + The reference cell. - - - A method used to support the F# query syntax. Returns an empty sequence that has the specified type argument. - + + Decrement a mutable reference cell containing an integer + The reference cell. - - - A method used to support the F# query syntax. Returns a sequence that contains the specified values. - + + Dereference a mutable reference cell + The cell to dereference. + The value contained in the cell. - - - A method used to support the F# query syntax. Returns a sequence of length one that contains the specified value. - + + Assign to a mutable reference cell + The cell to mutate. + The value to set inside the cell. - - A query operator that selects those elements based on a specified predicate. - + + Create a mutable reference cell + The value to contain in the cell. + The created reference cell. - - A query operator that performs a subsequent ordering of the elements selected so far in descending order by the given nullable sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - + + The identity function + The input value. + The same value. - - A query operator that performs a subsequent ordering of the elements selected so far in ascending order by the given nullable sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - + + Throw a System.InvalidOperationException exception + The exception message. + The result value. - - A query operator that performs a subsequent ordering of the elements selected so far in descending order by the given sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - + + Throw a System.ArgumentNullException exception + The argument name. + The result value. - - A query operator that performs a subsequent ordering of the elements selected so far in ascending order by the given sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - + + Throw a System.ArgumentException exception with + the given argument name and message. + The argument name. + The exception message. + The result value. - - A query operator that selects elements from a sequence as long as a specified condition is true, and then skips the remaining elements. - + + Throw a System.Exception exception. + The exception message. + The result value. - - A query operator that selects a specified number of contiguous elements from those selected so far. - + + Determines whether the given value is not null. + The value to check. + True when value is not null, false otherwise. - - A query operator that selects a nullable value for each element selected so far and returns the sum of these values. - If any nullable does not have a value, it is ignored. - + + Determines whether the given value is null. + The value to check. + True when value is null, false otherwise. - - A query operator that selects a value for each element selected so far and returns the sum of these values. - + + Try to unbox a strongly typed value. + The boxed value. + The unboxed result as an option. - - - A method used to support the F# query syntax. Inputs to queries are implicitly wrapped by a call to one of the overloads of this method. - + + Boxes a strongly typed value. + The value to box. + The boxed object. - - - A method used to support the F# query syntax. Inputs to queries are implicitly wrapped by a call to one of the overloads of this method. - + + Unbox a strongly typed value. + The boxed value. + The unboxed result. - - A query operator that sorts the elements selected so far in descending order by the given nullable sorting key. - + + Ignore the passed value. This is often used to throw away results of a computation. + The value to ignore. - - A query operator that sorts the elements selected so far in ascending order by the given nullable sorting key. - + + Minimum based on generic comparison + The first value. + The second value. + The minimum value. - - A query operator that sorts the elements selected so far in descending order by the given sorting key. - + + Maximum based on generic comparison + The first value. + The second value. + The maximum value. - - A query operator that sorts the elements selected so far in ascending order by the given sorting key. - + + Generic comparison. + The first value. + The second value. + The result of the comparison. - - A query operator that bypasses elements in a sequence as long as a specified condition is true and then selects the remaining elements. - + + Return the second element of a tuple, snd (a,b) = b. + The input tuple. + The second value. + + + Return the first element of a tuple, fst (a,b) = a. + The input tuple. + The first value. - - A query operator that bypasses a specified number of the elements selected so far and selects the remaining elements. - + + Matches System.Exception objects whose runtime type is precisely System.Exception + The input exception. + A string option. - - A query operator that projects each of the elements selected so far. - + + Builds a System.Exception object. + The message for the Exception. + A System.Exception. - - - A method used to support the F# query syntax. Runs the given quotation as a query using LINQ IQueryable rules. - + + Rethrows an exception. This should only be used when handling an exception + The result value. - - - A method used to support the F# query syntax. Indicates that the query should be passed as a quotation to the Run method. - + + Rethrows an exception. This should only be used when handling an exception + The result value. - - A query operator that selects the element at a specified index amongst those selected so far. - + + Raises an exception + The exception to raise. + The result value. - - A query operator that selects a nullable value for each element selected so far and returns the minimum of these values. - If any nullable does not have a value, it is ignored. - + + Concatenate two strings. The operator '+' may also be used. - - A query operator that selects a value for each element selected so far and returns the minimum resulting value. - + + Used to specify a default value for an optional argument in the implementation of a function + A value option representing the argument. + The default value of the argument. + The argument value. If it is None, the defaultValue is returned. - - A query operator that selects a nullable value for each element selected so far and returns the maximum of these values. - If any nullable does not have a value, it is ignored. - + + Used to specify a default value for an optional argument in the implementation of a function + An option representing the argument. + The default value of the argument. + The argument value. If it is None, the defaultValue is returned. - - A query operator that selects a value for each element selected so far and returns the maximum resulting value. - + + Apply a function to three values, the values being a triple on the right, the function on the left + The function. + The first argument. + The second argument. + The third argument. + The function result. - - A query operator that correlates two sets of selected values based on matching keys and groups the results. - If any group is empty, a group with a single default value is used instead. - Normal usage is 'leftOuterJoin y in elements2 on (key1 = key2) into group'. - + + Apply a function to two values, the values being a pair on the right, the function on the left + The function. + The first argument. + The second argument. + The function result. - - A query operator that selects the last element of those selected so far, or a default value if no element is found. - + + Apply a function to a value, the value being on the right, the function on the left + The function. + The argument. + The function result. - - A query operator that selects the last element of those selected so far. - + + Apply a function to three values, the values being a triple on the left, the function on the right + The first argument. + The second argument. + The third argument. + The function. + The function result. - - A query operator that correlates two sets of selected values based on matching keys. - Normal usage is 'join y in elements2 on (key1 = key2)'. - + + Apply a function to two values, the values being a pair on the left, the function on the right + The first argument. + The second argument. + The function. + The function result. - - A query operator that selects the first element of those selected so far, or a default value if the sequence contains no elements. - + + Apply a function to a value, the value being on the left, the function on the right + The argument. + The function. + The function result. - - A query operator that selects the first element from those selected so far. - + + Compose two functions, the function on the right being applied first + The second function to apply. + The first function to apply. + The composition of the input functions. - - A query operator that selects a value for each element selected so far and groups the elements by the given key. - + + Compose two functions, the function on the left being applied first + The first function to apply. + The second function to apply. + The composition of the input functions. - - A query operator that correlates two sets of selected values based on matching keys and groups the results. - Normal usage is 'groupJoin y in elements2 on (key1 = key2) into group'. - + + Structural inequality + The first parameter. + The second parameter. + The result of the comparison. - - A query operator that groups the elements selected so far according to a specified key selector. - + + Structural equality + The first parameter. + The second parameter. + The result of the comparison. - - - A method used to support the F# query syntax. Projects each element of a sequence to another sequence and combines the resulting sequences into one sequence. - + + Structural less-than-or-equal comparison + The first parameter. + The second parameter. + The result of the comparison. - - A query operator that selects the first element selected so far that satisfies a specified condition. - + + Structural greater-than-or-equal + The first parameter. + The second parameter. + The result of the comparison. - - A query operator that determines whether any element selected so far satisfies a condition. - + + Structural greater-than + The first parameter. + The second parameter. + The result of the comparison. - - A query operator that selects the single, specific element of those selected so far, or a default value if that element is not found. - + + Structural less-than comparison + The first parameter. + The second parameter. + The result of the comparison. - - A query operator that selects the single, specific element selected so far - + + Overloaded prefix-plus operator + The input value. + The result of the operation. - - A query operator that selects distinct elements from the elements selected so far. - + + Overloaded bitwise-NOT operator + The input value. + The result of the operation. - - A query operator that returns the number of selected elements. - + + Overloaded byte-shift right operator by a specified number of bits + The input value. + The amount to shift. + The result of the operation. - - A query operator that determines whether the selected elements contains a specified element. - + + Overloaded byte-shift left operator by a specified number of bits + The input value. + The amount to shift. + The result of the operation. - - A query operator that selects a nullable value for each element selected so far and returns the average of these values. - If any nullable does not have a value, it is ignored. - + + Overloaded bitwise-XOR operator + The first parameter. + The second parameter. + The result of the operation. - - A query operator that selects a value for each element selected so far and returns the average of these values. - + + Overloaded bitwise-OR operator + The first parameter. + The second parameter. + The result of the operation. - - A query operator that determines whether all elements selected so far satisfies a condition. - + + Overloaded bitwise-AND operator + The first parameter. + The second parameter. + The result of the operation. - - Create an instance of this builder. Use 'query { ... }' to use the query syntax. + + Overloaded modulo operator + The first parameter. + The second parameter. + The result of the operation. - - - The type used to support the F# query syntax. Use 'query { ... }' to use the query syntax. - + + Overloaded division operator + The first parameter. + The second parameter. + The result of the operation. - - - A property used to support the F# query syntax. - + + Overloaded multiplication operator + The first parameter. + The second parameter. + The result of the operation. - - - A method used to support the F# query syntax. - + + Overloaded subtraction operator + The first parameter. + The second parameter. + The result of the operation. - - - A partial input or result in an F# query. This type is used to support the F# query syntax. - + + Overloaded addition operator + The first parameter. + The second parameter. + The result of the operation. - - Converts the argument to character. Numeric inputs are converted according to the UTF-16 - encoding for characters. The operation requires an appropriate static conversion method on the input type. - The input value. - The converted char. + + Overloaded unary negation. + The value to negate. + The result of the operation. - - Converts the argument to System.Decimal using a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. + + Converts the argument to char. Numeric inputs are converted using a checked + conversion according to the UTF-16 encoding for characters. String inputs must + be exactly one character long. For other input types the operation requires an + appropriate static conversion method on the input type. The input value. - The converted decimal. + The converted char - - Converts the argument to unsigned native integer using a direct conversion for all + + Converts the argument to unativeint. This is a direct, checked conversion for all primitive numeric types. Otherwise the operation requires an appropriate static conversion method on the input type. The input value. The converted unativeint - - Converts the argument to signed native integer. This is a direct conversion for all + + Converts the argument to nativeint. This is a direct, checked conversion for all primitive numeric types. Otherwise the operation requires an appropriate static conversion method on the input type. The input value. The converted nativeint - - Converts the argument to 64-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float - - - Converts the argument to 32-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float32 - - - Converts the argument to 64-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float - - - Converts the argument to 32-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float32 - - - Converts the argument to unsigned 64-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate + + Converts the argument to uint64. This is a direct, checked conversion for all + primitive numeric types. For strings, the input is converted using System.UInt64.Parse() + with InvariantCulture settings. Otherwise the operation requires an appropriate static conversion method on the input type. The input value. The converted uint64 - - Converts the argument to signed 64-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate + + Converts the argument to int64. This is a direct, checked conversion for all + primitive numeric types. For strings, the input is converted using System.Int64.Parse() + with InvariantCulture settings. Otherwise the operation requires an appropriate static conversion method on the input type. The input value. The converted int64 - - Converts the argument to unsigned 32-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate + + Converts the argument to uint32. This is a direct, checked conversion for all + primitive numeric types. For strings, the input is converted using System.UInt32.Parse() + with InvariantCulture settings. Otherwise the operation requires an appropriate static conversion method on the input type. The input value. The converted uint32 - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate + + Converts the argument to int32. This is a direct, checked conversion for all + primitive numeric types. For strings, the input is converted using System.Int32.Parse() + with InvariantCulture settings. Otherwise the operation requires an appropriate static conversion method on the input type. The input value. The converted int32 - - Converts the argument to a particular enum type. - The input value. - The converted enum type. - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate + + Converts the argument to int. This is a direct, checked conversion for all + primitive numeric types. For strings, the input is converted using System.Int32.Parse() + with InvariantCulture settings. Otherwise the operation requires an appropriate static conversion method on the input type. The input value. The converted int - - Converts the argument to unsigned 16-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate + + Converts the argument to uint16. This is a direct, checked conversion for all + primitive numeric types. For strings, the input is converted using System.UInt16.Parse() + with InvariantCulture settings. Otherwise the operation requires an appropriate static conversion method on the input type. The input value. The converted uint16 - - Converts the argument to signed 16-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate + + Converts the argument to int16. This is a direct, checked conversion for all + primitive numeric types. For strings, the input is converted using System.Int16.Parse() + with InvariantCulture settings. Otherwise the operation requires an appropriate static conversion method on the input type. The input value. The converted int16 - - Converts the argument to signed byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to signed byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate + + Converts the argument to sbyte. This is a direct, checked conversion for all + primitive numeric types. For strings, the input is converted using System.SByte.Parse() + with InvariantCulture settings. Otherwise the operation requires an appropriate static conversion method on the input type. The input value. The converted sbyte - - Converts the argument to byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - Converts the argument to byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate + + Converts the argument to byte. This is a direct, checked conversion for all + primitive numeric types. For strings, the input is converted using System.Byte.Parse() + with InvariantCulture settings. Otherwise the operation requires an appropriate static conversion method on the input type. The input value. The converted byte - - - Functions for converting nullable values - - - - - The division operator where a nullable value appears on both left and right sides - - - - - The division operator where a nullable value appears on the right - + + Overloaded multiplication operator (checks for overflow) + The first value. + The second value. + The product of the two input values. - - - The division operator where a nullable value appears on the left - + + Overloaded addition operator (checks for overflow) + The first value. + The second value. + The sum of the two input values. - - - The modulus operator where a nullable value appears on both left and right sides - + + Overloaded subtraction operator (checks for overflow) + The first value. + The second value. + The first value minus the second value. - - - The modulus operator where a nullable value appears on the right - + + Overloaded unary negation (checks for overflow) + The input value. + The negated value. - - - The modulus operator where a nullable value appears on the left - + + This module contains the basic arithmetic operations with overflow checks. - - - The multiplication operator where a nullable value appears on both left and right sides - + + Calls GetHashCode() on the value + The value. + The hash code. - - - The multiplication operator where a nullable value appears on the right - + + Minimum of the two values + The first value. + The second value. + The minimum value. - - - The multiplication operator where a nullable value appears on the left - + + Maximum of the two values + The first value. + The second value. + The maximum value. - - - The subtraction operator where a nullable value appears on both left and right sides - + + Compares the two values + The first value. + The second value. + The result of the comparison. - - - The subtraction operator where a nullable value appears on the right - + + Compares the two values for inequality + The first parameter. + The second parameter. + The result of the comparison. - - - The subtraction operator where a nullable value appears on the left - + + Compares the two values for equality + The first parameter. + The second parameter. + The result of the comparison. - - - The addition operator where a nullable value appears on both left and right sides - + + Compares the two values for less-than-or-equal + The first parameter. + The second parameter. + The result of the comparison. - - - The addition operator where a nullable value appears on the right - + + Compares the two values for greater-than-or-equal + The first parameter. + The second parameter. + The result of the comparison. - - - The addition operator where a nullable value appears on the left - + + Compares the two values for greater-than + The first parameter. + The second parameter. + The result of the comparison. - - - The '<>' operator where a nullable value appears on both left and right sides - + + Compares the two values for less-than + The first parameter. + The second parameter. + The result of the comparison. - - - The '=' operator where a nullable value appears on both left and right sides - + + A module of comparison and equality operators that are statically resolved, but which are not fully generic and do not make structural comparison. Opening this + module may make code that relies on structural or generic comparison no longer compile. - - - The '<' operator where a nullable value appears on both left and right sides - + + Perform generic hashing on a value where the type of the value is not + statically required to satisfy the 'equality' constraint. + The computed hash value. - - - The '<=' operator where a nullable value appears on both left and right sides - + + Perform generic equality on two values where the type of the values is not + statically required to satisfy the 'equality' constraint. + The result of the comparison. - - - The '>' operator where a nullable value appears on both left and right sides - + + Perform generic comparison on two values where the type of the values is not + statically required to have the 'comparison' constraint. + The result of the comparison. - - - The '>=' operator where a nullable value appears on both left and right sides - + + Generate a default value for any type. This is null for reference types, + For structs, this is struct value where all fields have the default value. + This function is unsafe in the sense that some F# values do not have proper null values. - - - The '<>' operator where a nullable value appears on the right - + + Unboxes a strongly typed value. This is the inverse of box, unbox<t>(box<t> a) equals a. + The boxed value. + The unboxed result. - - - The '=' operator where a nullable value appears on the right - + + This module contains basic operations which do not apply runtime and/or static checks - - - The '<' operator where a nullable value appears on the right - + + This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator - - - The '<=' operator where a nullable value appears on the right - + + This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'decimal' - - - The '>' operator where a nullable value appears on the right - + + This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'float' - - - The '>=' operator where a nullable value appears on the right - + + This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'float32' - - - The '<>' operator where a nullable value appears on the left - + + This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'unativeint' - - - The '=' operator where a nullable value appears on the left - + + This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'nativeint' - - - The '<' operator where a nullable value appears on the left - + + This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint64' - - - The '<=' operator where a nullable value appears on the left - + + This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int64' - - - The '>' operator where a nullable value appears on the left - + + This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint32' - - - The '>=' operator where a nullable value appears on the left - + + This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int32' - - - Operators for working with nullable values - + + This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint16' - - - A method used to support the F# query syntax. Runs the given quotation as a query using LINQ IEnumerable rules. - + + This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int16' - - - A method used to support the F# query syntax. Runs the given quotation as a query using LINQ rules. - + + This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'sbyte' - - - This type shouldn't be used directly from user code. - + + This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'byte' - - - This type shouldn't be used directly from user code. - + + This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This type shouldn't be used directly from user code. - + + This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This type shouldn't be used directly from user code. - + + This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This type shouldn't be used directly from user code. - + + This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This type shouldn't be used directly from user code. - + + This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This type shouldn't be used directly from user code. - + + This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This type shouldn't be used directly from user code. - + + This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - A type used to reconstruct a grouping after applying a mutable->immutable mapping transformation - on a result of a query. - + + This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - The generic MethodInfo for Select function - Describes how we got from productions of immutable objects to productions of anonymous objects, with enough information - that we can invert the process in final query results. - + + This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - Given the expression part of a "yield" or "select" which produces a result in terms of immutable tuples or immutable records, - generate an equivalent expression yielding anonymous objects. Also return the conversion for the immutable-to-mutable correspondence - so we can reverse this later. - + + This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - Simplify gets of tuples and gets of record fields. - + + This is a library intrinsic. Calls to this function may be generated by evaluating quotations. + + + This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - Cleanup the use of property-set object constructions in leaf expressions that form parts of F# queries. - + + This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - Given an type involving immutable tuples and records, logically corresponding to the type produced at a - "yield" or "select", convert it to a type involving anonymous objects according to the conversion data. - + + This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - Recognize anonymous type construction written using 'new AnonymousObject(<e1>, <e2>, ...)' - + + This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - Recognize object construction written using 'new O(Prop1 = <e>, Prop2 = <e>, ...)' - + + This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - Tests whether a list consists only of assignments of properties of the - given variable, null values (ignored) and ends by returning the given variable - (pattern returns only property assignments) - + + This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - Recognize sequential series written as (... ((<e>; <e>); <e>); ...) - + + This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - A runtime helper used to evaluate nested quotation literals. - + + This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - A runtime helper used to evaluate nested quotation literals. - + + This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - Evaluates a subset of F# quotations by first converting to a LINQ expression, for the subset of LINQ expressions represented by the - expression syntax in the C# language. - + + This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - Converts a subset of F# quotations to a LINQ expression, for the subset of LINQ expressions represented by the - expression syntax in the C# language. - + + Generate a range of values using the given zero, add, start, step and stop values - - - Converts a subset of F# quotations to a LINQ expression, for the subset of LINQ expressions represented by the - expression syntax in the C# language. - + + Generate a range of values using the given zero, add, start, step and stop values - - - When used in a quotation, this function indicates a specific conversion - should be performed when converting the quotation to a LINQ expression. - - This function should not be called directly. - + + Generate a range of char values - - - When used in a quotation, this function indicates a specific conversion - should be performed when converting the quotation to a LINQ expression. - - This function should not be called directly. - + + Generate a range of byte values - - - When used in a quotation, this function indicates a specific conversion - should be performed when converting the quotation to a LINQ expression. - - This function should not be called directly. - + + Generate a range of sbyte values - - - Abstract internal type - + + Generate a range of uint16 values - - Allocates a region of memory on the stack. - The number of objects of type T to allocate. - A typed pointer to the allocated memory. + + Generate a range of int16 values - - Assigns the value into the memory location referenced by the typed native - pointer computed by adding index * sizeof<'T> to the given input pointer. - The input pointer. - The index by which to offset the pointer. - The value to assign. + + Generate a range of unativeint values - - Assigns the value into the memory location referenced by the given typed native pointer. - The input pointer. - The value to assign. + + Generate a range of nativeint values - - Dereferences the given typed native pointer. - The input pointer. - The value at the pointer address. + + Generate a range of uint32 values - - Dereferences the typed native pointer computed by adding index * sizeof<'T> to the - given input pointer. - The input pointer. - The index by which to offset the pointer. - The value at the pointer address. + + Generate a range of uint64 values - - Returns a typed native pointer by adding index * sizeof<'T> to the - given input pointer. - The input pointer. - The index by which to offset the pointer. - A typed pointer. + + Generate a range of int64 values - - Returns a machine address for a given typed native pointer. - The input pointer. - The machine address. + + Generate a range of float32 values - - Returns a typed native pointer for a given machine address. - The pointer address. - A typed pointer. + + Generate a range of float values - - Contains operations on native pointers. Use of these operators may - result in the generation of unverifiable code. + + Generate a range of integers - - Gets the raw expression associated with this type-carrying expression + + Gets a slice from a string + The source string. + The index of the first character of the slice. + The index of the last character of the slice. + The substring from the given indices. - - Type-carrying quoted expressions. Expressions are generated either - by quotations in source text or programatically + + Sets a slice of an array + The target array. + The start index of the first dimension. + The end index of the first dimension. + The start index of the second dimension. + The end index of the second dimension. + The start index of the third dimension. + The end index of the third dimension. + The start index of the fourth dimension. + The end index of the fourth dimension. + The source array. - - Returns type of an expression. + + Gets a slice of an array + The source array. + The start index of the first dimension. + The end index of the first dimension. + The start index of the second dimension. + The end index of the second dimension. + The start index of the third dimension. + The end index of the third dimension. + The start index of the fourth dimension. + The end index of the fourth dimension. + The four dimensional sub array from the given indices. - - Returns the custom attributes of an expression. + + Sets a slice of an array + The target array. + The start index of the first dimension. + The end index of the first dimension. + The start index of the second dimension. + The end index of the second dimension. + The start index of the third dimension. + The end index of the third dimension. + The source array. - - Builds an expression that represents a value and its associated reflected definition as a quotation - The untyped object. - The type of the object. - The definition of the value being quoted. - The resulting expression. + + Gets a slice of an array + The source array. + The start index of the first dimension. + The end index of the first dimension. + The start index of the second dimension. + The end index of the second dimension. + The start index of the third dimension. + The end index of the third dimension. + The three dimensional sub array from the given indices. - - Builds an expression that represents a value and its associated reflected definition as a quotation - The value being quoted. - The definition of the value being quoted. - The resulting expression. + + Sets a vector slice of a 2D array. The index of the second dimension is fixed. + The target array. + The start index of the first dimension. + The end index of the first dimension. + The index of the second dimension. + The source array. - - Builds an expression that represents a while loop - The predicate to control the loop iteration. - The body of the while loop. - The resulting expression. + + Sets a vector slice of a 2D array. The index of the first dimension is fixed. + The target array. + The index of the first dimension. + The start index of the second dimension. + The end index of the second dimension. + The source array. - - Builds an expression that represents setting a mutable variable - The input variable. - The value to set. - The resulting expression. + + Sets a region slice of an array + The target array. + The start index of the first dimension. + The end index of the first dimension. + The start index of the second dimension. + The end index of the second dimension. + The source array. - - Builds an expression that represents a variable - The input variable. - The resulting expression. + + Gets a vector slice of a 2D array. The index of the second dimension is fixed. + The source array. + The start index of the first dimension. + The end index of the first dimension. + The fixed index of the second dimension. + The sub array from the input indices. - - Builds an expression that represents a constant value of a particular type, arising from a variable of the given name - The untyped object. - The type of the object. - The name of the variable. - The resulting expression. + + Gets a vector slice of a 2D array. The index of the first dimension is fixed. + The source array. + The index of the first dimension. + The start index of the second dimension. + The end index of the second dimension. + The sub array from the input indices. - - Builds an expression that represents a constant value, arising from a variable of the given name - The typed value. - The name of the variable. - The resulting expression. + + Gets a region slice of an array + The source array. + The start index of the first dimension. + The end index of the first dimension. + The start index of the second dimension. + The end index of the second dimension. + The two dimensional sub array from the input indices. - - Builds an expression that represents a constant value - The typed value. - The resulting expression. + + Sets a slice of an array + The target array. + The start index. + The end index. + The source array. - - Builds an expression that represents a constant value of a particular type - The untyped object. - The type of the object. - The resulting expression. + + Gets a slice of an array + The input array. + The start index. + The end index. + The sub array from the input indices. - - Builds an expression that represents a test of a value is of a particular union case - The expression to test. - The description of the union case. - The resulting expression. + + A module of compiler intrinsic functions for efficient implementations of F# integer ranges + and dynamic invocations of other F# operators - - Builds an expression that represents a type test. - The expression to test. - The target type. - The resulting expression. + + Basic F# Operators. This module is automatically opened in all F# code. - - Builds an expression that represents getting a field of a tuple - The input tuple. - The index of the tuple element to get. - The resulting expression. + + Invoke an F# first class function value that accepts five curried arguments + without intervening execution + The first arg. + The second arg. + The third arg. + The fourth arg. + The fifth arg. + The function result. - - Builds an expression that represents a try/with construct for exception filtering and catching. - The body of the try expression. - - - The variable to bind to a caught exception. - The expression evaluated when an exception is caught. - The resulting expression. + + Adapt an F# first class function value to be an optimized function value that can + accept five curried arguments without intervening execution. + The input function. + The optimized function. - - Try and find a stored reflection definition for the given method. Stored reflection - definitions are added to an F# assembly through the use of the [<ReflectedDefinition>] attribute. - The description of the method to find. - The reflection definition or None if a match could not be found. + + Construct an optimized function value that can accept five curried + arguments without intervening execution. + The optimized function. - - Builds an expression that represents a try/finally construct - The body of the try expression. - The final part of the expression to be evaluated. - The resulting expression. + + The CLI type used to represent F# function values that accept five curried arguments + without intervening execution. This type should not typically used directly from + either F# code or from other CLI languages. - - Format the expression as a string - Indicates if method, property, constructor and type objects should be printed in detail. If false, these are abbreviated to their name. - The formatted string. + + Invoke an F# first class function value that accepts four curried arguments + without intervening execution + The first arg. + The second arg. + The third arg. + The fourth arg. + The function result. - - Substitutes through the given expression using the given functions - to map variables to new values. The functions must give consistent results - at each application. Variable renaming may occur on the target expression - if variable capture occurs. - The function to map variables into expressions. - The expression with the given substitutions. + + Adapt an F# first class function value to be an optimized function value that can + accept four curried arguments without intervening execution. + The input function. + The optimized function. - - Builds an expression that represents the sequential execution of one expression followed by another - The first expression. - The second expression. - The resulting expression. + + Construct an optimized function value that can accept four curried + arguments without intervening execution. + The optimized function. - - Permits interactive environments such as F# Interactive - to explicitly register new pickled resources that represent persisted - top level definitions. - The assembly associated with the resource. - The unique name for the resources being added. - The type definitions referenced. - The serialized resource to register with the environment. + + The CLI type used to represent F# function values that accept four curried arguments + without intervening execution. This type should not typically used directly from + either F# code or from other CLI languages. - - Permits interactive environments such as F# Interactive - to explicitly register new pickled resources that represent persisted - top level definitions. - The assembly associated with the resource. - The unique name for the resources being added. - The serialized resource to register with the environment. + + Invoke an F# first class function value that accepts three curried arguments + without intervening execution + The first arg. + The second arg. + The third arg. + The function result. - - Builds an expression that represents a nested typed quotation literal - The expression being quoted. - The resulting expression. + + Adapt an F# first class function value to be an optimized function value that can + accept three curried arguments without intervening execution. + The input function. + The adapted function. - - Builds an expression that represents a nested raw quotation literal - The expression being quoted. - The resulting expression. + + Construct an optimized function value that can accept three curried + arguments without intervening execution. + The optimized function. - - Builds an expression that represents a nested typed or raw quotation literal - The expression being quoted. - The resulting expression. + + The CLI type used to represent F# function values that accept + three iterated (curried) arguments without intervening execution. This type should not + typically used directly from either F# code or from other CLI languages. - - Builds an expression that represents writing to a static property - The description of the property. - The value to set. - List of indices for the property if it is an indexed property. - The resulting expression. + + Invoke the optimized function value with two curried arguments + The first arg. + The second arg. + The function result. - - Builds an expression that represents writing to a property of an object - The input object. - The description of the property. - The value to set. - List of indices for the property if it is an indexed property. - The resulting expression. + + Adapt an F# first class function value to be an optimized function value that can + accept two curried arguments without intervening execution. + The input function. + The adapted function. - - Builds an expression that represents reading a static property - The description of the property. - List of indices for the property if it is an indexed property. - The resulting expression. + + Construct an optimized function value that can accept two curried + arguments without intervening execution. + The optimized function. - - Builds an expression that represents reading a property of an object - The input object. - The description of the property. - List of indices for the property if it is an indexed property. - The resulting expression. + + The CLI type used to represent F# function values that accept + two iterated (curried) arguments without intervening execution. This type should not + typically used directly from either F# code or from other CLI languages. - - Builds an expression that represents the creation of a union case value - The description of the union case. - The list of arguments for the case. - The resulting expression. + + An implementation module used to hold some private implementations of function + value invocation. + + + Divides a value by an integer. + The input value. + The input int. + The division result. - - Builds an expression that represents the creation of an F# tuple value - The list of elements of the tuple. - The resulting expression. + + Resolves to the value 'one' for any primitive numeric type or any type with a static member called 'One' - - Builds record-construction expressions - The type of record. - The list of elements of the record. - The resulting expression. + + Resolves to the zero value for any primitive numeric type or any type with a static member called 'Zero' - - Builds an expression that represents the invocation of an object constructor - The description of the constructor. - The list of arguments to the constructor. - The resulting expression. + + A compiler intrinsic that implements dynamic invocations for the DivideByInt primitive. - - Builds an expression that represents the creation of a delegate value for the given type - The type of delegate. - The parameters for the delegate. - The body of the function. - The resulting expression. + + A compiler intrinsic that implements dynamic invocations to the checked '*' operator. - - Builds an expression that represents the creation of an array value initialized with the given elements - The type for the elements of the array. - The list of elements of the array. - The resulting expression. + + A compiler intrinsic that implements dynamic invocations to the '*' operator. - - Builds recursives expressions associated with 'let rec' constructs - The list of bindings for the let expression. - The sub-expression where the bindings are in scope. - The resulting expression. + + A compiler intrinsic that implements dynamic invocations to the checked '+' operator. - - Builds expressions associated with 'let' constructs - The variable in the let expression. - The expression bound to the variable. - The sub-expression where the binding is in scope. - The resulting expression. + + A compiler intrinsic that implements dynamic invocations to the '+' operator. - - Builds an expression that represents the constrution of an F# function value - The parameter to the function. - The body of the function. - The resulting expression. + + Resolves to the value 'one' for any primitive numeric type or any type with a static member called 'One'. - - Builds 'if ... then ... else' expressions. - The condition expression. - The then sub-expression. - The else sub-expression. - The resulting expression. + + Resolves to the zero value for any primitive numeric type or any type with a static member called 'Zero'. - - Fetches or creates a new variable with the given name and type from a global pool of shared variables - indexed by name and type. The type is given by the expicit or inferred type parameter - The variable name. - The created of fetched typed global variable. + + Parse an uint64 according to the rules used by the overloaded 'uint64' conversion operator when applied to strings + The input string. + The parsed value. - - Gets the free expression variables of an expression as a list. - A sequence of the free variables in the expression. + + Parse an int64 according to the rules used by the overloaded 'int64' conversion operator when applied to strings + The input string. + The parsed value. - - Builds a 'for i = ... to ... do ...' expression that represent loops over integer ranges - The sub-expression declaring the loop variable. - The sub-expression setting the initial value of the loop variable. - The sub-expression declaring the final value of the loop variable. - The sub-expression representing the body of the loop. - The resulting expression. + + Parse an uint32 according to the rules used by the overloaded 'uint32' conversion operator when applied to strings + The input string. + The parsed value. - - Builds an expression that represents writing to a field of an object - The input object. - The description of the field to write to. - The value to set to the field. - The resulting expression. + + Parse an int32 according to the rules used by the overloaded 'int32' conversion operator when applied to strings + The input string. + The parsed value. - - Builds an expression that represents writing to a static field - The description of the field to write to. - The value to the set to the field. - The resulting expression. + + Creates an sbyte value with units-of-measure + The input sbyte. + The sbyte with units-of-measure. - - Builds an expression that represents the access of a field of an object - The input object. - The description of the field to access. - The resulting expression. + + Creates an int16 value with units-of-measure + The input int16. + The int16 with units-of-measure. - - Builds an expression that represents the access of a static field - The description of the field to access. - The resulting expression. + + Creates an int64 value with units-of-measure + The input int64. + The int64 with units of measure. - - This function is called automatically when quotation syntax (<@ @>) and other sources of - quotations are used. - A type in the assembly where the quotation occurs. - The type definitions referenced. - The spliced types, to replace references to type variables. - The spliced expressions to replace references to spliced expressions. - The serialized form of the quoted expression. - The resulting expression. + + Creates an int32 value with units-of-measure + The input int. + The int with units of measure. - - This function is called automatically when quotation syntax (<@ @>) and other sources of - quotations are used. - A type in the assembly where the quotation occurs. - The spliced types, to replace references to type variables. - The spliced expressions to replace references to spliced expressions. - The serialized form of the quoted expression. - The resulting expression. + + Creates a decimal value with units-of-measure + The input decimal. + The decimal with units of measure. - - Builds an expression that represents the invocation of a default object constructor - The type on which the constructor is invoked. - The resulting expression. + + Creates a float32 value with units-of-measure + The input float. + The float with units-of-measure. - - Builds an expression that represents the coercion of an expression to a type - The expression to coerce. - The target type. - The resulting expression. + + Creates a float value with units-of-measure + The input float. + The float with units-of-measure. - - Returns a new typed expression given an underlying runtime-typed expression. - A type annotation is usually required to use this function, and - using an incorrect type annotation may result in a later runtime exception. - The expression to cast. - The resulting typed expression. + + Get the underlying value for an enum value + The input enum. + The enumeration as a value. - - Builds an expression that represents a call to an instance method associated with an object - The input object. - The description of the method to call. - The list of arguments to the method. - The resulting expression. + + Build an enum value from an underlying value + The input value. + The value as an enumeration. - - Builds an expression that represents a call to an static method or module-bound function - The MethodInfo describing the method to call. - The list of arguments to the method. - The resulting expression. + + Recursively hash a part of a value according to its structure. + The comparison function. + The input object. + The hashed value. - - Builds an expression that represents the application of a first class function value to multiple arguments - The function to apply. - The list of lists of arguments to the function. - The resulting expression. + + Hash a value according to its structure. Use the given limit to restrict the hash when hashing F# + records, lists and union types. + The limit on the number of nodes. + The input object. + The hashed value. - - Builds an expression that represents the application of a first class function value to a single argument. - The function to apply. - The argument to the function. - The resulting expression. + + Hash a value according to its structure. This hash is not limited by an overall node count when hashing F# + records, lists and union types. + The input object. + The hashed value. - - Builds an expression that represents setting the value held at a particular address. - The target expression. - The value to set at the address. - The resulting expression. + + Make an F# comparer object for the given type - - Builds an expression that represents getting the address of a value. - The target expression. - The resulting expression. + + Make an F# hash/equality object for the given type - - Quoted expressions annotated with System.Type values. + + Make an F# hash/equality object for the given type using node-limited hashing when hashing F# + records, lists and union types. + The input limit on the number of nodes. + System.Collections.Generic.IEqualityComparer<'T> - - The type associated with the variable + + Make an F# hash/equality object for the given type - - The declared name of the variable + + Make an F# comparer object for the given type, where it can be null if System.Collections.Generic.Comparer<'T>.Default - - Indicates if the variable represents a mutable storage location + + Make an F# comparer object for the given type - - Fetches or create a new variable with the given name and type from a global pool of shared variables - indexed by name and type - The name of the variable. - The type associated with the variable. - The retrieved or created variable. + + A static F# comparer object - - Creates a new variable with the given name, type and mutability - The declared name of the variable. - The type associated with the variable. - Indicates if the variable represents a mutable storage location. Default is false. - The created variable. + + Return an F# comparer object suitable for hashing and equality. This hashing behaviour + of the returned comparer is not limited by an overall node count when hashing F# + records, lists and union types. This equality comparer has equivalence + relation semantics ([nan] = [nan]). - - Information at the binding site of a variable + + Return an F# comparer object suitable for hashing and equality. This hashing behaviour + of the returned comparer is not limited by an overall node count when hashing F# + records, lists and union types. - - Re-build combination expressions. The first parameter should be an object - returned by the ShapeCombination case of the active pattern in this module. - The input shape. - The list of arguments. - The rebuilt expression. + + The physical hash. Hashes on the object identity, except for value types, + where we hash on the contents. + The input object. + The hashed value. - - An active pattern that performs a complete decomposition viewing the expression tree as a binding structure - The input expression. - The decomposed Var, Lambda, or ConstApp. + + Reference/physical equality. + True if the inputs are reference-equal, false otherwise. + The first value. + The second value. + The result of the comparison. - - Active patterns for traversing, visiting, rebuilding and tranforming expressions in a generic way + + Take the maximum of two values structurally according to the order given by GenericComparison + The first value. + The second value. + The maximum value. - - An active pattern to recognize property setters that have an associated ReflectedDefinition - The description of the property. - The expression of the method definition if found, or None. + + Take the minimum of two values structurally according to the order given by GenericComparison + The first value. + The second value. + The minimum value. - - An active pattern to recognize property getters or values in modules that have an associated ReflectedDefinition - The description of the property. - The expression of the method definition if found, or None. + + Compare two values + The first value. + The second value. + The result of the comparison. - - An active pattern to recognize methods that have an associated ReflectedDefinition - The description of the method. - The expression of the method definition if found, or None. + + Compare two values + The first value. + The second value. + The result of the comparison. - - A parameterized active pattern to recognize calls to a specified function or method. - The returned elements are the optional target object (present if the target is an - instance method), the generic type instantation (non-empty if the target is a generic - instantiation), and the arguments to the function or method. - The input template expression to specify the method to call. - The optional target object (present if the target is an - instance method), the generic type instantation (non-empty if the target is a generic - instantiation), and the arguments to the function or method. + + Compare two values + The first value. + The second value. + The result of the comparison. - - An active pattern to recognize constant decimal expressions - The input expression to match against. - decimal option + + Compare two values + The first value. + The second value. + The result of the comparison. - - An active pattern to recognize constant unsigned int64 expressions - The input expression to match against. - uint64 option + + Compare two values. May be called as a recursive case from an implementation of System.IComparable to + ensure consistent NaN comparison semantics. + The function to compare the values. + The first value. + The second value. + The result of the comparison. - - An active pattern to recognize constant int64 expressions - The input expression to match against. - int64 option + + Compare two values + The first value. + The second value. + The result of the comparison. - - An active pattern to recognize constant unsigned int32 expressions - The input expression to match against. - uint32 option + + Compare two values for equality + + The first value. + The second value. + The result of the comparison. - - An active pattern to recognize constant int32 expressions - The input expression to match against. - int32 option + + Compare two values for equality using equivalence relation semantics ([nan] = [nan]) + The first value. + The second value. + The result of the comparison. - - An active pattern to recognize constant unsigned int16 expressions - The input expression to match against. - uint16 option + + Compare two values for equality using partial equivalence relation semantics ([nan] <> [nan]) + The first value. + The second value. + The result of the comparison. - - An active pattern to recognize constant int16 expressions - The input expression to match against. - int16 option + + A primitive entry point used by the F# compiler for optimization purposes. - - An active pattern to recognize constant byte expressions - The input expression to match against. - byte option + + A primitive entry point used by the F# compiler for optimization purposes. - - An active pattern to recognize constant signed byte expressions - The input expression to match against. - sbyte option + + A primitive entry point used by the F# compiler for optimization purposes. - - An active pattern to recognize constant unicode character expressions - The input expression to match against. - char option + + A primitive entry point used by the F# compiler for optimization purposes. - - An active pattern to recognize constant 64-bit floating point number expressions - The input expression to match against. - float option + + A primitive entry point used by the F# compiler for optimization purposes. - - An active pattern to recognize constant 32-bit floating point number expressions - The input expression to match against. - float32 option + + A primitive entry point used by the F# compiler for optimization purposes. - - An active pattern to recognize constant string expressions - The input expression to match against. - string option + + A primitive entry point used by the F# compiler for optimization purposes. - - An active pattern to recognize constant boolean expressions - The input expression to match against. - bool option + + A primitive entry point used by the F# compiler for optimization purposes. - - An active pattern to recognize () constant expressions - The input expression to match against. - unit option + + A primitive entry point used by the F# compiler for optimization purposes. - - An active pattern to recognize expressions of the form a || b - The input expression to match against. - (Expr * Expr) option + + A primitive entry point used by the F# compiler for optimization purposes. - - An active pattern to recognize expressions of the form a && b - The input expression to match against. - (Expr * Expr) option + + A primitive entry point used by the F# compiler for optimization purposes. - - An active pattern to recognize expressions that represent the application of a (possibly curried or tupled) first class function value - The input expression to match against. - (Expr * Expr list list) option + + A primitive entry point used by the F# compiler for optimization purposes. - - An active pattern to recognize expressions that represent a (possibly curried or tupled) first class function value - The input expression to match against. - (Var list list * Expr) option + + A primitive entry point used by the F# compiler for optimization purposes. - - Contains a set of derived F# active patterns to analyze F# expression objects + + A primitive entry point used by the F# compiler for optimization purposes. - - An active pattern to recognize expressions that represent setting a mutable variable - The input expression to match against. - (Var * Expr) option + + A primitive entry point used by the F# compiler for optimization purposes. - - An active pattern to recognize expressions that represent a variable - The input expression to match against. - Var option + + A primitive entry point used by the F# compiler for optimization purposes. - - An active pattern to recognize expressions that are a value with an associated definition - The input expression to match against. - The boxed value, its static type and its definition + + A primitive entry point used by the F# compiler for optimization purposes. - - An active pattern to recognize expressions that represent a constant value - The input expression to match against. - The boxed value, its static type and its name + + A primitive entry point used by the F# compiler for optimization purposes. - - An active pattern to recognize expressions that represent a constant value. This also matches expressions matched by ValueWithName. - The input expression to match against. - The boxed value and its static type + + A primitive entry point used by the F# compiler for optimization purposes. + + + A primitive entry point used by the F# compiler for optimization purposes. - - An active pattern to recognize expressions that represent a test if a value is of a particular union case - The input expression to match against. - The expression and union case being tested + + A primitive entry point used by the F# compiler for optimization purposes. - - An active pattern to recognize expressions that represent a dynamic type test - The input expression to match against. - The expression and type being tested + + A primitive entry point used by the F# compiler for optimization purposes. - - An active pattern to recognize expressions that represent getting a tuple field - The input expression to match against. - The expression and tuple field being accessed + + A primitive entry point used by the F# compiler for optimization purposes. - - An active pattern to recognize expressions that represent a try/finally construct - The input expression to match against. - The body and handler parts of the try/finally expression + + A primitive entry point used by the F# compiler for optimization purposes. - - An active pattern to recognize expressions that represent a try/with construct for exception filtering and catching - The input expression to match against. - (Expr * Var * Expr * Var * Expr) option + + A primitive entry point used by the F# compiler for optimization purposes. - - An active pattern to recognize expressions that represent sequential exeuction of one expression followed by another - The input expression to match against. - (Expr * Expr) option + + A primitive entry point used by the F# compiler for optimization purposes. - - An active pattern to recognize expressions that represent a nested typed quotation literal - The input expression to match against. - Expr option + + The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs - - An active pattern to recognize expressions that represent a nested raw quotation literal - The input expression to match against. - Expr option + + + The standard overloaded associative (4-indexed) mutation operator + - - An active pattern to recognize expressions that represent a nested quotation literal - The input expression to match against. - Expr option + + The standard overloaded associative (3-indexed) mutation operator - - An active pattern to recognize expressions that represent setting a static or instance property, or a non-function value declared in a module - The input expression to match against. - (Expr option * PropertyInfo * Expr list * Expr) option + + The standard overloaded associative (2-indexed) mutation operator - - An active pattern to recognize expressions that represent the read of a static or instance property, or a non-function value declared in a module - The input expression to match against. - (Expr option * PropertyInfo * Expr list) option + + The standard overloaded associative (indexed) mutation operator - - An active pattern to recognize expressions that represent construction of tuple values - The input expression to match against. - (Expr list) option + + The standard overloaded associative (4-indexed) lookup operator - - An active pattern to recognize expressions that represent construction of particular union case values - The input expression to match against. - (UnionCaseInfo * Expr list) option + + The standard overloaded associative (3-indexed) lookup operator - - An active pattern to recognize expressions that represent construction of record values - The input expression to match against. - (Type * Expr list) option + + The standard overloaded associative (2-indexed) lookup operator - - An active pattern to recognize expressions that represent invocation of object constructors - The input expression to match against. - (ConstructorInfo * Expr list) option + + The standard overloaded associative (indexed) lookup operator - - An active pattern to recognize expressions that represent construction of delegate values - The input expression to match against. - (Type * Var list * Expr) option + + A compiler intrinsic for checking initialization soundness of recursive bindings - - An active pattern to recognize expressions that represent invocations of a default constructor of a struct - The input expression to match against. - Type option + + A compiler intrinsic for checking initialization soundness of recursive static bindings - - An active pattern to recognize expressions that represent the construction of arrays - The input expression to match against. - (Type * Expr list) option + + A compiler intrinsic for checking initialization soundness of recursive bindings - - An active pattern to recognize expressions that represent recursive let bindings of one or more variables - The input expression to match against. - ((Var * Expr) list * Expr) option + + A compiler intrinsic for the efficient compilation of sequence expressions - - An active pattern to recognize expressions that represent let bindings - The input expression to match against. - (Var * Expr * Expr) option + + This function implements parsing of decimal constants - - An active pattern to recognize expressions that represent first class function values - The input expression to match against. - (Var * Expr) option + + This function implements calls to default constructors + accessed by 'new' constraints. - - An active pattern to recognize expressions that represent conditionals - The input expression to match against. - (Expr * Expr * Expr) option + + Primitive used by pattern match compilation - - An active pattern to recognize expressions that represent while loops - The input expression to match against. - (Expr * Expr) option + + A compiler intrinsic that implements the ':?' operator - - An active pattern to recognize expressions that represent loops over integer ranges - The input expression to match against. - (Var * Expr * Expr * Expr) option + + A compiler intrinsic that implements the ':?' operator - - An active pattern to recognize expressions that represent setting a static or instance field - The input expression to match against. - (Expr option * FieldInfo * Expr) option + + A compiler intrinsic that implements the ':?>' operator - - An active pattern to recognize expressions that represent getting a static or instance field - The input expression to match against. - (Expr option * FieldInfo) option + + A compiler intrinsic that implements the ':?>' operator - - An active pattern to recognize expressions that represent coercions from one type to another - The input expression to match against. - (Expr * Type) option + + The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs - - An active pattern to recognize expressions that represent calls to static and instance methods, and functions defined in modules - The input expression to match against. - (Expr option * MethodInfo * Expr list) option + + Address-of. Uses of this value may result in the generation of unverifiable code. + The input object. + The unmanaged pointer. - - An active pattern to recognize expressions that represent applications of first class function values - The input expression to match against. - (Expr * Expr) option + + Address-of. Uses of this value may result in the generation of unverifiable code. + The input object. + The managed pointer. - - An active pattern to recognize expressions that represent setting the value held at an address - The input expression to match against. - (Expr * Expr) option + + Binary 'or'. When used as a binary operator the right hand value is evaluated only on demand + The first value. + The second value. + The result of the operation. - - An active pattern to recognize expressions that represent getting the address of a value - The input expression to match against. - Expr option + + Binary 'or'. When used as a binary operator the right hand value is evaluated only on demand. - - Contains a set of primitive F# active patterns to analyze F# expression objects + + Binary 'and'. When used as a binary operator the right hand value is evaluated only on demand + The first value. + The second value. + The result of the operation. - - Returns a System.Type representing an F# tuple type with the given element types - An array of types for the tuple elements. - The type representing the tuple containing the input elements. + + Binary 'and'. When used as a binary operator the right hand value is evaluated only on demand. - - Returns a System.Type representing the F# function type with the given domain and range - The input type of the function. - The output type of the function. - The function type with the given domain and range. + + The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs - - Returns true if the typ is a representation of an F# union type or the runtime type of a value of that type - The type to check. - Optional binding flags. - True if the type check succeeds. + + For compiler use only - - Return true if the typ is a representation of an F# tuple type - The type to check. - True if the type check succeeds. + + Language primitives associated with the F# language - - Return true if the typ is a representation of an F# record type - The type to check. - Optional binding flags. - True if the type check succeeds. + + + Represents a byref that can be both read and written + - - Return true if the typ is a System.Type value corresponding to the compiled form of an F# module - The type to check. - True if the type check succeeds. + + + Represents a byref that can be read + - - Return true if the typ is a representation of an F# function type or the runtime type of a closure implementing an F# function type - The type to check. - True if the type check succeeds. + + + Represents a byref that can be written + - - Returns true if the typ is a representation of an F# exception declaration - The type to check. - Optional binding flags. - True if the type check is an F# exception. + + + Represents the types of byrefs in F# 4.5+ + - - Gets the cases of a union type. - - Assumes the given type is a union type. If not, ArgumentException is raised during pre-computation. - The input union type. - Optional binding flags. - Thrown when the input type is not a union type. - An array of descriptions of the cases of the given union type. + + Convert an option to a potentially null value. + The input value. + The result value, which is null if the input was ValueNone. - - Gets the tuple elements from the representation of an F# tuple type. - The input tuple type. - An array of the types contained in the given tuple type. + + Convert a potentially null value to a value option. + The input value. + The result value option. - - Reads all the fields from a record value, in declaration order - - Assumes the given input is a record value. If not, ArgumentException is raised. - The input record type. - Optional binding flags. - An array of descriptions of the properties of the record type. + + Convert a Nullable value to a value option. + The input nullable value. + The result value option. - - Gets the domain and range types from an F# function type or from the runtime type of a closure implementing an F# type - The input function type. - A tuple of the domain and range types of the input function. + + Convert the value option to a Nullable value. + The input value option. + The result value. - - Reads all the fields from an F# exception declaration, in declaration order - - Assumes exceptionType is an exception representation type. If not, ArgumentException is raised. - The exception type to read. - Optional binding flags. - Thrown if the given type is not an exception. - An array containing the PropertyInfo of each field in the exception. + + Convert the value option to a list of length 0 or 1. + The input value option. + The result list. - - Contains operations associated with constructing and analyzing F# types such as records, unions and tuples + + Convert the value option to an array of length 0 or 1. + The input value option. + The result array. - - Assumes the given type is a union type. - If not, ArgumentException is raised during pre-computation. - - Using the computed function is more efficient than calling GetUnionCase - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The type of union to optimize reading. - Optional binding flags. - An optimized function to read the tags of the given union type. + + filter f inp evaluates to match inp with ValueNone -> ValueNone | ValueSome x -> if f x then ValueSome x else ValueNone. + A function that evaluates whether the value contained in the value option should remain, or be filtered out. + The input value option. + The input if the predicate evaluates to true; otherwise, ValueNone. + + + flatten inp evaluates to match inp with ValueNone -> ValueNone | ValueSome x -> x + The input value option. + A value option of the output type of the binder. + flatten is equivalent to bind id. + + + bind f inp evaluates to match inp with ValueNone -> ValueNone | ValueSome x -> f x + A function that takes the value of type T from a value option and transforms it into + a value option containing a value of type U. + The input value option. + An option of the output type of the binder. - - Precompute a property or static method for reading an integer representing the case tag of a union type. - The type of union to read. - Optional binding flags. - The description of the union case reader. + + map f voption1 voption2 voption3 evaluates to match voption1, voption2, voption3 with ValueSome x, ValueSome y, ValueSome z -> ValueSome (f x y z) | _ -> ValueNone. + A function to apply to the value option values. + The first value option. + The second value option. + The third value option. + A value option of the input values after applying the mapping function, or ValueNone if any input is ValueNone. + + + map f voption1 voption2 evaluates to match voption1, voption2 with ValueSome x, ValueSome y -> ValueSome (f x y) | _ -> ValueNone. + A function to apply to the voption values. + The first value option. + The second value option. + A value option of the input values after applying the mapping function, or ValueNone if either input is ValueNone. + + + map f inp evaluates to match inp with ValueNone -> ValueNone | ValueSome x -> ValueSome (f x). + A function to apply to the voption value. + The input value option. + A value option of the input value after applying the mapping function, or ValueNone if the input is ValueNone. + + + iter f inp executes match inp with ValueNone -> () | ValueSome x -> f x. + A function to apply to the voption value. + The input value option. + Unit if the option is ValueNone, otherwise it returns the result of applying the predicate + to the voption value. + + + Evaluates to true if is ValueSome and its value is equal to . + The value to test for equality. + The input value option. + True if the option is ValueSome and contains a value equal to , otherwise false. + + + forall p inp evaluates to match inp with ValueNone -> true | ValueSome x -> p x. + A function that evaluates to a boolean when given a value from the value option type. + The input value option. + True if the option is None, otherwise it returns the result of applying the predicate + to the option value. - - Precomputes a function for reading all the fields for a particular discriminator case of a union type - - Using the computed function will typically be faster than executing a corresponding call to GetFields - The description of the union case to read. - Optional binding flags. - A function to for reading the fields of the given union case. + + exists p inp evaluates to match inp with ValueNone -> false | ValueSome x -> p x. + A function that evaluates to a boolean when given a value from the option type. + The input value option. + False if the option is ValueNone, otherwise it returns the result of applying the predicate + to the option value. - - A method that constructs objects of the given case - The description of the union case. - Optional binding flags. - The description of the constructor of the given union case. + + fold f inp s evaluates to match inp with ValueNone -> s | ValueSome x -> f x s. + A function to update the state data when given a value from a value option. + The input value option. + The initial state. + The original state if the option is ValueNone, otherwise it returns the updated state with the folder + and the voption value. - - Precomputes a function for constructing a discriminated union value for a particular union case. - The description of the union case. - Optional binding flags. - A function for constructing values of the given union case. + + fold f s inp evaluates to match inp with ValueNone -> s | ValueSome x -> f s x. + A function to update the state data when given a value from a value option. + The initial state. + The input value option. + The original state if the option is ValueNone, otherwise it returns the updated state with the folder + and the voption value. - - Precomputes a function for reading the values of a particular tuple type - - Assumes the given type is a TupleType. - If not, ArgumentException is raised during pre-computation. - The tuple type to read. - Thrown when the given type is not a tuple type. - A function to read values of the given tuple type. + + count inp evaluates to match inp with ValueNone -> 0 | ValueSome _ -> 1. + The input value option. + A zero if the option is ValueNone, a one otherwise. - - Gets information that indicates how to read a field of a tuple - The input tuple type. - The index of the tuple element to describe. - The description of the tuple element and an optional type and index if the tuple is big. + + Gets the value associated with the option. + The input value option. + The value within the option. + Thrown when the option is ValueNone. + + + Returns if it is Some, otherwise evaluates and returns the result. + A thunk that provides an alternate value option when evaluated. + The input value option. + The voption if the voption is ValueSome, else the result of evaluating . + is not evaluated unless is ValueNone. + + + Returns if it is Some, otherwise returns . + The value to use if is None. + The input option. + The option if the option is Some, else the alternate option. + + + Gets the value of the voption if the voption is ValueSome, otherwise evaluates and returns the result. + A thunk that provides a default value when evaluated. + The input voption. + The voption if the voption is ValueSome, else the result of evaluating . + is not evaluated unless is ValueNone. + + + Gets the value of the value option if the option is ValueSome, otherwise returns the specified default value. + The specified default value. + The input voption. + The voption if the voption is ValueSome, else the default value. + Identical to the built-in operator, except with the arguments swapped. + + + Returns true if the value option is ValueNone. + The input value option. + True if the voption is ValueNone. + + + Returns true if the value option is not ValueNone. + The input value option. + True if the value option is not ValueNone. + + + Basic operations on value options. - - Gets a method that constructs objects of the given tuple type. - For small tuples, no additional type will be returned. - - For large tuples, an additional type is returned indicating that - a nested encoding has been used for the tuple type. In this case - the suffix portion of the tuple type has the given type and an - object of this type must be created and passed as the last argument - to the ConstructorInfo. A recursive call to PreComputeTupleConstructorInfo - can be used to determine the constructor for that the suffix type. - The input tuple type. - The description of the tuple type constructor and an optional extra type - for large tuples. + + Convert an option to a potentially null value. + The input value. + The result value, which is null if the input was None. - - Precomputes a function for reading the values of a particular tuple type - - Assumes the given type is a TupleType. - If not, ArgumentException is raised during pre-computation. - The type of tuple to read. - Thrown when the given type is not a tuple type. - A function to read a particular tuple type. + + Convert a potentially null value to an option. + The input value. + The result option. - - Precompute a function for reading all the fields from a record. The fields are returned in the - same order as the fields reported by a call to Microsoft.FSharp.Reflection.Type.GetInfo for - this type. - - Assumes the given type is a RecordType. - If not, ArgumentException is raised during pre-computation. - - Using the computed function will typically be faster than executing a corresponding call to Value.GetInfo - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The type of record to read. - Optional binding flags. - Thrown when the input type is not a record type. - An optimized reader for the given record type. + + Convert a Nullable value to an option. + The input nullable value. + The result option. - - Precompute a function for reading a particular field from a record. - Assumes the given type is a RecordType with a field of the given name. - If not, ArgumentException is raised during pre-computation. - - Using the computed function will typically be faster than executing a corresponding call to Value.GetInfo - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The PropertyInfo of the field to read. - Thrown when the input type is not a record type. - A function to read the specified field from the record. + + Convert the option to a Nullable value. + The input option. + The result value. - - Get a ConstructorInfo for a record type - The record type. - Optional binding flags. - A ConstructorInfo for the given record type. + + Convert the option to a list of length 0 or 1. + The input option. + The result list. - - Precompute a function for constructing a record value. - - Assumes the given type is a RecordType. - If not, ArgumentException is raised during pre-computation. - The type of record to construct. - Optional binding flags. - Thrown when the input type is not a record type. - A function to construct records of the given type. + + Convert the option to an array of length 0 or 1. + The input option. + The result array. - - Create a union case value. - The description of the union case to create. - The array of arguments to construct the given case. - Optional binding flags. - The constructed union case. + + filter f inp evaluates to match inp with None -> None | Some x -> if f x then Some x else None. + A function that evaluates whether the value contained in the option should remain, or be filtered out. + The input option. + The input if the predicate evaluates to true; otherwise, None. - - Creates an instance of a tuple type - - Assumes at least one element is given. If not, ArgumentException is raised. - The array of tuple fields. - The tuple type to create. - Thrown if no elements are given. - An instance of the tuple type with the given elements. + + flatten inp evaluates to match inp with None -> None | Some x -> x + The input option. + An option of the output type of the binder. + flatten is equivalent to bind id. - - Creates an instance of a record type. - - Assumes the given input is a record type. - The type of record to make. - The array of values to initialize the record. - Optional binding flags for the record. - Thrown when the input type is not a record type. - The created record. + + bind f inp evaluates to match inp with None -> None | Some x -> f x + A function that takes the value of type T from an option and transforms it into + an option containing a value of type U. + The input option. + An option of the output type of the binder. - - Builds a typed function from object from a dynamic function implementation - The function type of the implementation. - The untyped lambda of the function implementation. - A typed function from the given dynamic implementation. + + map f option1 option2 option3 evaluates to match option1, option2, option3 with Some x, Some y, Some z -> Some (f x y z) | _ -> None. + A function to apply to the option values. + The first option. + The second option. + The third option. + An option of the input values after applying the mapping function, or None if any input is None. + + + map f option1 option2 evaluates to match option1, option2 with Some x, Some y -> Some (f x y) | _ -> None. + A function to apply to the option values. + The first option. + The second option. + An option of the input values after applying the mapping function, or None if either input is None. - - Identify the union case and its fields for an object - - Assumes the given input is a union case value. If not, ArgumentException is raised. - - If the type is not given, then the runtime type of the input object is used to identify the - relevant union type. The type should always be given if the input object may be null. For example, - option values may be represented using the 'null'. - The input union case. - The union type containing the value. - Optional binding flags. - Thrown when the input type is not a union case value. - The description of the union case and its fields. + + map f inp evaluates to match inp with None -> None | Some x -> Some (f x). + A function to apply to the option value. + The input option. + An option of the input value after applying the mapping function, or None if the input is None. - - Reads all fields from a tuple. - - Assumes the given input is a tuple value. If not, ArgumentException is raised. - The input tuple. - Thrown when the input is not a tuple value. - An array of the fields from the given tuple. + + iter f inp executes match inp with None -> () | Some x -> f x. + A function to apply to the option value. + The input option. + Unit if the option is None, otherwise it returns the result of applying the predicate + to the option value. - - Reads a field from a tuple value. - - Assumes the given input is a tuple value. If not, ArgumentException is raised. - The input tuple. - The index of the field to read. - The value of the field. + + Evaluates to true if is Some and its value is equal to . + The value to test for equality. + The input option. + True if the option is Some and contains a value equal to , otherwise false. + + + forall p inp evaluates to match inp with None -> true | Some x -> p x. + A function that evaluates to a boolean when given a value from the option type. + The input option. + True if the option is None, otherwise it returns the result of applying the predicate + to the option value. + + + exists p inp evaluates to match inp with None -> false | Some x -> p x. + A function that evaluates to a boolean when given a value from the option type. + The input option. + False if the option is None, otherwise it returns the result of applying the predicate + to the option value. - - Reads all the fields from a record value. - - Assumes the given input is a record value. If not, ArgumentException is raised. - The record object. - Optional binding flags for the record. - Thrown when the input type is not a record type. - The array of fields from the record. + + fold f inp s evaluates to match inp with None -> s | Some x -> f x s. + A function to update the state data when given a value from an option. + The input option. + The initial state. + The original state if the option is None, otherwise it returns the updated state with the folder + and the option value. - - Reads a field from a record value. - - Assumes the given input is a record value. If not, ArgumentException is raised. - The record object. - The PropertyInfo describing the field to read. - Thrown when the input type is not a record type. - The field from the record. + + fold f s inp evaluates to match inp with None -> s | Some x -> f s x. + A function to update the state data when given a value from an option. + The initial state. + The input option. + The original state if the option is None, otherwise it returns the updated state with the folder + and the option value. - - Reads all the fields from a value built using an instance of an F# exception declaration - - Assumes the given input is an F# exception value. If not, ArgumentException is raised. - The exception instance. - Optional binding flags. - Thrown when the input type is not an F# exception. - The fields from the given exception. + + count inp evaluates to match inp with None -> 0 | Some _ -> 1. + The input option. + A zero if the option is None, a one otherwise. - - Contains operations associated with constructing and analyzing values associated with F# types - such as records, unions and tuples. + + Gets the value associated with the option. + The input option. + The value within the option. + Thrown when the option is None. - - The integer tag for the case. + + Returns if it is Some, otherwise evaluates and returns the result. + A thunk that provides an alternate option when evaluated. + The input option. + The option if the option is Some, else the result of evaluating . + is not evaluated unless is None. - - The name of the case. + + Returns if it is Some, otherwise returns . + The value to use if is None. + The input option. + The option if the option is Some, else the alternate option. - - The type in which the case occurs. + + Gets the value of the option if the option is Some, otherwise evaluates and returns the result. + A thunk that provides a default value when evaluated. + The input option. + The option if the option is Some, else the result of evaluating . + is not evaluated unless is None. - - The fields associated with the case, represented by a PropertyInfo. - The fields associated with the case. + + Gets the value of the option if the option is Some, otherwise returns the specified default value. + The specified default value. + The input option. + The option if the option is Some, else the default value. + Identical to the built-in operator, except with the arguments swapped. - - Returns the custom attributes data associated with the case. - An list of custom attribute data items. + + Returns true if the option is None. + The input option. + True if the option is None. - - Returns the custom attributes associated with the case matching the given attribute type. - The type of attributes to return. - An array of custom attributes. + + Returns true if the option is not None. + The input option. + True if the option is not None. - - Returns the custom attributes associated with the case. - An array of custom attributes. + + Basic operations on options. - - Represents a case of a discriminated union type + + bind f inp evaluates to match inp with Error e -> Error e | Ok x -> f x + A function that takes the value of type T from a result and transforms it into + a result containing a value of type U. + The input result. + A result of the output type of the binder. + + + map f inp evaluates to match inp with Error x -> Error (f x) | Ok v -> Ok v. + A function to apply to the Error result value. + The input result. + A result of the error value after applying the mapping function, or Ok if the input is Ok. + + + map f inp evaluates to match inp with Error e -> Error e | Ok x -> Ok (f x). + A function to apply to the OK result value. + The input result. + A result of the input value after applying the mapping function, or Error if the input is Error. - - Returns true if the typ is a representation of an F# exception declaration - The type to check. - Optional flag that denotes accessibility of the private representation. - True if the type check is an F# exception. + + Returns the length of the string. + The input string. + The number of characters in the string. - - Reads all the fields from an F# exception declaration, in declaration order - - Assumes exceptionType is an exception representation type. If not, ArgumentException is raised. - The exception type to read. - Optional flag that denotes accessibility of the private representation. - Thrown if the given type is not an exception. - An array containing the PropertyInfo of each field in the exception. + + Returns a string by concatenating count instances of str. + The number of copies of the input string will be copied. + The input string. + The concatenated string. + Thrown when count is negative. - - Returns true if the typ is a representation of an F# union type or the runtime type of a value of that type - The type to check. - Optional flag that denotes accessibility of the private representation. - True if the type check succeeds. + + Tests if any character of the string satisfies the given predicate. + The function to test each character of the string. + The input string. + True if any character returns true for the predicate and false otherwise. - - Return true if the typ is a representation of an F# record type - The type to check. - Optional flag that denotes accessibility of the private representation. - True if the type check succeeds. + + Tests if all characters in the string satisfy the given predicate. + The function to test each character of the string. + The input string. + True if all characters return true for the predicate and false otherwise. - - Gets the cases of a union type. - - Assumes the given type is a union type. If not, ArgumentException is raised during pre-computation. - The input union type. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a union type. - An array of descriptions of the cases of the given union type. + + Builds a new string whose characters are the results of applying the function mapping + to each index from 0 to count-1 and concatenating the resulting + strings. + The number of strings to initialize. + The function to take an index and produce a string to + be concatenated with the others. + The constructed string. + Thrown when count is negative. - - Reads all the fields from a record value, in declaration order + + Builds a new string containing only the characters of the input string + for which the given predicate returns "true". - Assumes the given input is a record value. If not, ArgumentException is raised. - The input record type. - Optional flag that denotes accessibility of the private representation. - An array of descriptions of the properties of the record type. - - - Reads all the fields from a value built using an instance of an F# exception declaration + Returns an empty string if the input string is null - Assumes the given input is an F# exception value. If not, ArgumentException is raised. - The exception instance. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not an F# exception. - The fields from the given exception. - - - A method that constructs objects of the given case - The description of the union case. - Optional flag that denotes accessibility of the private representation. - The description of the constructor of the given union case. + A function to test whether each character in the input sequence should be included in the output string. + The input string. + The resulting string. - - Precomputes a function for constructing a discriminated union value for a particular union case. - The description of the union case. - Optional flag that denotes accessibility of the private representation. - A function for constructing values of the given union case. + + Builds a new string whose characters are the results of applying the function mapping + to each of the characters of the input string and concatenating the resulting + strings. + The function to produce a string from each character of the input string. + The input string. + The concatenated string. - - Precomputes a function for reading all the fields for a particular discriminator case of a union type - - Using the computed function will typically be faster than executing a corresponding call to GetFields - The description of the union case to read. - Optional flag that denotes accessibility of the private representation. - A function to for reading the fields of the given union case. + + Builds a new string whose characters are the results of applying the function mapping + to each character and index of the input string. + The function to apply to each character and index of the string. + The input string. + The resulting string. - - Precompute a property or static method for reading an integer representing the case tag of a union type. - The type of union to read. - Optional flag that denotes accessibility of the private representation. - The description of the union case reader. + + Builds a new string whose characters are the results of applying the function mapping + to each of the characters of the input string. + The function to apply to the characters of the string. + The input string. + The resulting string. - - Assumes the given type is a union type. - If not, ArgumentException is raised during pre-computation. - - Using the computed function is more efficient than calling GetUnionCase - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The type of union to optimize reading. - Optional flag that denotes accessibility of the private representation. - An optimized function to read the tags of the given union type. + + Applies the function action to the index of each character in the string and the + character itself. + The function to apply to each character and index of the string. + The input string. - - Identify the union case and its fields for an object - - Assumes the given input is a union case value. If not, ArgumentException is raised. - - If the type is not given, then the runtime type of the input object is used to identify the - relevant union type. The type should always be given if the input object may be null. For example, - option values may be represented using the 'null'. - The input union case. - The union type containing the value. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a union case value. - The description of the union case and its fields. + + Applies the function action to each character in the string. + The function to be applied to each character of the string. + The input string. - - Create a union case value. - The description of the union case to create. - The array of arguments to construct the given case. - Optional flag that denotes accessibility of the private representation. - The constructed union case. + + Returns a new string made by concatenating the given strings + with separator sep, that is a1 + sep + ... + sep + aN. + The separator string to be inserted between the strings + of the input sequence. + The sequence of strings to be concatenated. + A new string consisting of the concatenated strings separated by + the separation string. + Thrown when strings is null. - - Get a ConstructorInfo for a record type - The record type. - Optional flag that denotes accessibility of the private representation. - A ConstructorInfo for the given record type. + + Functional programming operators for string processing. Further string operations + are available via the member functions on strings and other functionality in + System.String + and System.Text.RegularExpressions types. - - Precompute a function for constructing a record value. - - Assumes the given type is a RecordType. - If not, ArgumentException is raised during pre-computation. - The type of record to construct. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - A function to construct records of the given type. + + + Provides a default implementations of F# numeric literal syntax for literals of the form 'dddI' + - - Precompute a function for reading all the fields from a record. The fields are returned in the - same order as the fields reported by a call to Microsoft.FSharp.Reflection.Type.GetInfo for - this type. - - Assumes the given type is a RecordType. - If not, ArgumentException is raised during pre-computation. - - Using the computed function will typically be faster than executing a corresponding call to Value.GetInfo - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The type of record to read. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - An optimized reader for the given record type. + + + Provides a default implementations of F# numeric literal syntax for literals of the form 'dddI' + - - Reads all the fields from a record value. - - Assumes the given input is a record value. If not, ArgumentException is raised. - The record object. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - The array of fields from the record. + + + Provides a default implementations of F# numeric literal syntax for literals of the form 'dddI' + - - Creates an instance of a record type. - - Assumes the given input is a record type. - The type of record to make. - The array of values to initialize the record. - Optional flags that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - The created record. + + + Provides a default implementations of F# numeric literal syntax for literals of the form 'dddI' + - + - A record of options to control structural formatting. - For F# Interactive properties matching those of this value can be accessed via the 'fsi' - value. - - Floating Point format given in the same format accepted by System.Double.ToString, - e.g. f6 or g15. - - If ShowProperties is set the printing process will evaluate properties of the values being - displayed. This may cause additional computation. - - The ShowIEnumerable is set the printing process will force the evalution of IEnumerable objects - to a small, finite depth, as determined by the printing parameters. - This may lead to additional computation being performed during printing. - - <example> - From F# Interactive the default settings can be adjusted using, for example, - <pre> - open Microsoft.FSharp.Compiler.Interactive.Settings;; - setPrintWidth 120;; - </pre> - </example> + Provides a default implementations of F# numeric literal syntax for literals of the form 'dddI' - + - Data representing structured layouts of terms. + Provides a default implementations of F# numeric literal syntax for literals of the form 'dddI' - + - Convert any value to a layout using the given formatting options. The - layout can then be processed using formatting display engines such as - those in the LayoutOps module. any_to_string and output_any are - built using any_to_layout with default format options. + Provides a default implementations of F# numeric literal syntax for literals of the form 'dddI' - + - Ouput any value to a channel using the same set of formatting rules - as any_to_string + Provides a default implementations of F# numeric literal syntax for literals of the form 'dddI' - + - Convert any value to a string using a standard formatter - Data is typically formatted in a structured format, e.g. - lists are formatted using the "[1;2]" notation. - The details of the format are not specified and may change - from version to version and according to the flags given - to the F# compiler. The format is intended to be human-readable, - not machine readable. If alternative generic formats are required - you should develop your own formatter, using the code in the - implementation of this file as a starting point. + Provides a default implementations of F# numeric literal syntax for literals of the form 'dddI' + + + + Represents a statically-analyzed format associated with writing to a System.IO.TextWriter. The type parameter indicates the + arguments and return type of the format operation. + + + Represents a statically-analyzed format when formatting builds a string. The type parameter indicates the + arguments and return type of the format operation. + + + Represents a statically-analyzed format associated with writing to a System.Text.StringBuilder. The type parameter indicates the + arguments and return type of the format operation. + + + Represents a statically-analyzed format associated with writing to a System.IO.TextWriter. The first type parameter indicates the + arguments of the format operation and the last the overall return type. + + + Represents a statically-analyzed format when formatting builds a string. The first type parameter indicates the + arguments of the format operation and the last the overall return type. + + + Represents a statically-analyzed format associated with writing to a System.Text.StringBuilder. The first type parameter indicates the + arguments of the format operation and the last the overall return type. + + + Print to a string buffer and raise an exception with the given + result. Helper printers must return strings. + The input formatter. + The arguments of the formatter. + + + sprintf, but call the given 'final' function to generate the result. + See kprintf. + The function called to generate a result from the formatted string. + The input formatter. + The arguments of the formatter. + + + printf, but call the given 'final' function to generate the result. + For example, these let the printing force a flush after all output has + been entered onto the channel, but not before. + The function called after formatting to generate the format result. + The input formatter. + The arguments of the formatter. + + + fprintf, but call the given 'final' function to generate the result. + See kprintf. + The function called after formatting to generate the format result. + The input TextWriter. + The input formatter. + The arguments of the formatter. + + + bprintf, but call the given 'final' function to generate the result. + See kprintf. + The function called after formatting to generate the format result. + The input StringBuilder. + The input formatter. + The arguments of the formatter. + + + Print to a string via an internal string buffer and return + the result as a string. Helper printers must return strings. + The input formatter. + The formatted string. + + + Formatted printing to stdout, adding a newline. + The input formatter. + The return type and arguments of the formatter. + + + Formatted printing to stdout + The input formatter. + The return type and arguments of the formatter. + + + Formatted printing to stderr, adding a newline + The input formatter. + The return type and arguments of the formatter. + + + Formatted printing to stderr + The input formatter. + The return type and arguments of the formatter. + + + Print to a text writer, adding a newline + The TextWriter to print to. + The input formatter. + The return type and arguments of the formatter. + + + Print to a text writer. + The TextWriter to print to. + The input formatter. + The return type and arguments of the formatter. + + + Print to a System.Text.StringBuilder + The StringBuilder to print to. + The input formatter. + The return type and arguments of the formatter. + + + Extensible printf-style formatting for numbers and other datatypes + + Format specifications are strings with "%" markers indicating format + placeholders. Format placeholders consist of: + + %[flags][width][.precision][type] + + where the type is interpreted as follows: + + %b: bool, formatted as "true" or "false" + %s: string, formatted as its unescaped contents + %c: character literal + %d, %i: any basic integer type formatted as a decimal integer, signed if the basic integer type is signed. + %u: any basic integer type formatted as an unsigned decimal integer + %x, %X, %o: any basic integer type formatted as an unsigned hexadecimal + (a-f)/Hexadecimal (A-F)/Octal integer + + %e, %E, %f, %F, %g, %G: + any basic floating point type (float,float32) formatted + using a C-style floating point format specifications, i.e + + %e, %E: Signed value having the form [-]d.dddde[sign]ddd where + d is a single decimal digit, dddd is one or more decimal + digits, ddd is exactly three decimal digits, and sign + is + or - + + %f: Signed value having the form [-]dddd.dddd, where dddd is one + or more decimal digits. The number of digits before the + decimal point depends on the magnitude of the number, and + the number of digits after the decimal point depends on + the requested precision. + + %g, %G: Signed value printed in f or e format, whichever is + more compact for the given value and precision. + + + %M: System.Decimal value + + %O: Any value, printed by boxing the object and using it's ToString method(s) + + %A: Any value, printed with the default layout settings + + %a: A general format specifier, requires two arguments: + (1) a function which accepts two arguments: + (a) a context parameter of the appropriate type for the + given formatting function (e.g. an #System.IO.TextWriter) + (b) a value to print + and which either outputs or returns appropriate text. + + (2) the particular value to print + + + %t: A general format specifier, requires one argument: + (1) a function which accepts a context parameter of the + appropriate type for the given formatting function (e.g. + an System.IO.TextWriter)and which either outputs or returns + appropriate text. - Data from other .NET languages is formatted using a virtual - call to Object.ToString() on the boxed version of the input. - - - - - For limitting layout of list-like sequences (lists,arrays,etc). - unfold a list of items using (project and z) making layout list via itemL. - If reach maxLength (before exhausting) then truncate. - - - - - See tagL - - - - - Layout like an F# list. - - - - - Layout like an F# option. - - - - - Layout list vertically. - - - - - Layout two vertically. - - - - - Form tuple of layouts. - - - - - Wrap braces around layout. - - - - - Wrap square brackets around layout. - + Basic integer types are: + byte,sbyte,int16,uint16,int32,uint32,int64,uint64,nativeint,unativeint + Basic floating point types are: + float, float32 + + The optional width is an integer indicating the minimal width of the + result. For instance, %6d prints an integer, prefixing it with spaces + to fill at least 6 characters. If width is '*', then an extra integer + argument is taken to specify the corresponding width. + + any number + '*': + + Valid flags are: + + 0: add zeros instead of spaces to make up the required width + '-': left justify the result within the width specified + '+': add a '+' character if the number is positive (to match a '-' sign + for negatives) + ' ': add an extra space if the number is positive (to match a '-' + sign for negatives) + + The printf '#' flag is invalid and a compile-time error will be reported if it is used. - - - Wrap round brackets around Layout. - + + The F# compiler emits implementations of this type for compiled sequence expressions. - - - Join layouts into a list separated using the given Layout. - + + The F# compiler emits implementations of this type for compiled sequence expressions. - - - Join layouts into a semi-colon separated list. - + + The F# compiler emits implementations of this type for compiled sequence expressions. + + A new enumerator for the sequence. - - - Join layouts into a space separated list. - + + The F# compiler emits implementations of this type for compiled sequence expressions. + + A reference to the sequence. + + A 0, 1, and 2 respectively indicate Stop, Yield, and Goto conditions for the sequence generator. - - - Join layouts into a comma separated list. - + + The F# compiler emits implementations of this type for compiled sequence expressions. - - - Join broken with ident=2 - + + The F# compiler emits implementations of this type for compiled sequence expressions. + + A new sequence generator for the expression. - - - Join broken with ident=1 - + + The F# compiler emits implementations of this type for compiled sequence expressions. - - - Join broken with ident=0 - + + + Get the static parameters for a provided method. + + A method returned by GetMethod on a provided type + The static parameters of the provided method, if any - - - Join, possible break with indent=2 - + + + Apply static arguments to a provided method that accepts static arguments. + + The provider must return a provided method with the given mangled name. + the provided method definition which has static parameters + the full name of the method that must be returned, including encoded representations of static parameters + the values of the static parameters, indexed by name + The provided method definition corresponding to the given static parameter values - + - Join, possible break with indent=1 + Represents additional, optional information for a type provider component - - - Join, possible break with indent=0 - + + + Triggered when an assumption changes that invalidates the resolutions so far reported by the provider + - - - Join, unbreakable. - + + + Triggered when an assumption changes that invalidates the resolutions so far reported by the provider + - - - An string which is left parenthesis (no space on the right). - + + + Triggered when an assumption changes that invalidates the resolutions so far reported by the provider + - - - An string which is right parenthesis (no space on the left). - + + + Get the static parameters for a provided type. + + A type returned by GetTypes or ResolveTypeName + - - - An string which requires no spaces either side. - + + + Namespace name the this TypeProvider injects types into. + - - - An string leaf - + + + Called by the compiler to ask for an Expression tree to replace the given MethodBase with. + + MethodBase that was given to the compiler by a type returned by a GetType(s) call. + Expressions that represent the parameters to this call. + An expression that the compiler will use in place of the given method base. - - - An uninterpreted leaf, to be interpreted into a string - by the layout engine. This allows leaf layouts for numbers, strings and - other atoms to be customized according to culture. - + + + Get the physical contents of the given logical provided assembly. + - - - Is it the empty layout? - + + + Apply static arguments to a provided type that accepts static arguments. + + The provider must return a type with the given mangled name. + the provided type definition which has static parameters + the full path of the type, including encoded representations of static parameters + the static parameters, indexed by name + - - - The empty layout - + + + Represents an instantiation of a type provider component. + - + - A layout is a sequence of strings which have been joined together. - The strings are classified as words, separators and left and right parenthesis. - This classification determines where spaces are inserted. - A joint is either unbreakable, breakable or broken. - If a joint is broken the RHS layout occurs on the next line with optional indentation. - A layout can be squashed to for given width which forces breaks as required. + Namespace name the provider injects types into. - - Determines whether the current object precedes, occurs in the same position as, - or follows another object in the sort order. - The object to compare with the current instance. - An object that performs comparisons. - An integer that indicates the relationship of the current object to the target object. - - - Returns a hash code for the current instance. - An object that computes the hash code of the current object. - The hash code for the current instance. + + + Compilers call this method to query a type provider for a type name. + + Resolver should return a type called name in namespace NamespaceName or null if the type is unknown. + + - - Equality comparison against a target object with a given comparer. - The target for comparison. - Compares the two objects. - The result of the comparer. + + + The top-level types + + - + - Return the given big integer + The sub-namespaces in this namespace. An optional member to prevent generation of namespaces until an outer namespace is explored. - - - Return the negation of a big integer - + + + Represents a namespace provided by a type provider component. + - + - Return the difference of two big integers + Get the full path to use for temporary files for the type provider instance. - + - Return the product of big integers + version of referenced system runtime assembly - + - Return the modulus of big integers + Get the full path to referenced assembly that caused this type provider instance to be created. - + - This operator is for consistency when this type be used from other CLI languages + Get the full path to use to resolve relative paths in any file name arguments given to the type provider instance. - + - This operator is for consistency when this type be used from other CLI languages + Get the referenced assemblies for the type provider instance. - + - This operator is for consistency when this type be used from other CLI languages + Indicates if the type provider host responds to invalidation events for type provider instances. - + - This operator is for consistency when this type be used from other CLI languages + Indicates if the type provider instance is used in an environment which executes provided code such as F# Interactive. - + - This operator is for consistency when this type be used from other CLI languages + Get the full path to use for temporary files for the type provider instance. - + - Convert a big integer to a 32-bit signed integer + version of referenced system runtime assembly - + - Convert a big integer to a 64-bit signed integer + Get the full path to referenced assembly that caused this type provider instance to be created. - + - Convert a big integer to a floating point number + Get the full path to use to resolve relative paths in any file name arguments given to the type provider instance. - + - This operator is for consistency when this type be used from other CLI languages + Get the referenced assemblies for the type provider instance. - + - Return the ratio of two big integers + Indicates if the type provider host responds to invalidation events for type provider instances. - + - Return the sum of two big integers + Indicates if the type provider instance is used in an environment which executes provided code such as F# Interactive. - + - Get the big integer for zero + Checks if given type exists in target system runtime library - + - Return the sign of a big integer: 0, +1 or -1 + If the class that implements ITypeProvider has a constructor that accepts TypeProviderConfig + then it will be constructed with an instance of TypeProviderConfig. - - - Get the big integer for one - + + Creates an instance of the attribute + TypeProviderEditorHideMethodsAttribute - - - Return true if a big integer is 'zero' - + + Indicates that a code editor should hide all System.Object methods from the intellisense menus for instances of a provided type - - - Return true if a big integer is 'one' - + + Creates an instance of the attribute + TypeProviderXmlDocAttribute - + - Return n^m for two big integers + The TypeProviderXmlDocAttribute attribute can be added to types and members. + The language service will display the CommentText property from the attribute + in the appropriate place when the user hovers over a type or member. - - - Parse a big integer from a string format - + + Creates an instance of the attribute + TypeProviderAssemblyAttribute + The name of the design-time assembly for this type provider. - - - Return the greatest common divisor of two big integers - + + Creates an instance of the attribute + TypeProviderAssemblyAttribute - - - Compute the ratio and remainder of two big integers - + + Place attribute on runtime assembly to indicate that there is a corresponding design-time + assembly that contains a type provider. Runtime and designer assembly may be the same. - - - Compute the absolute value of a big integer - + + Additional type attribute flags related to provided types - - - Construct a BigInteger value for the given 64-bit integer - + + Creates an instance of the attribute + TypeProviderAttribute - - - Construct a BigInteger value for the given integer - + + Place on a class that implements ITypeProvider to extend the compiler - - - The type of arbitrary-sized integers - + + Represents the '1' measure expression when returned as a generic argument of a provided type. + + + Represents the inverse of a measure expressions when returned as a generic argument of a provided type. + + + Represents the product of two measure expressions when returned as a generic argument of a provided type. + + + Creates an anonymous event with the given handlers. + + A function to handle adding a delegate for the event to trigger. + A function to handle removing a delegate that the event triggers. + A function to produce the delegate type the event can trigger. + + The initialized event. + + + The F# compiler emits calls to this function to implement the use operator for F# sequence + expressions. + + The resource to be used and disposed. + The input sequence. + + The result sequence. + + + The F# compiler emits calls to this function to implement the compiler-intrinsic + conversions from untyped System.Collections.IEnumerable sequences to typed sequences. + + An initializer function. + A function to iterate and test if end of sequence is reached. + A function to retrieve the current element. + + The resulting typed sequence. + + + The F# compiler emits calls to this function to + implement the try/finally operator for F# sequence expressions. + + The input sequence. + A computation to be included in an enumerator's Dispose method. + + The result sequence. + + + The F# compiler emits calls to this function to + implement the while operator for F# sequence expressions. + + A function that indicates whether iteration should continue. + The input sequence. + + The result sequence. + + + A group of functions used as part of the compiled representation of F# sequence expressions. + + + Builds a query using query syntax and operators. + + + An active pattern to force the execution of values of type Lazy<_>. + + + Special prefix operator for splicing untyped expressions into quotation holes. + + + Special prefix operator for splicing typed expressions into quotation holes. + + + Builds a 2D array from a sequence of sequences of elements. + + + Builds a read-only lookup table from a sequence of key/value pairs. The key objects are indexed using generic hashing and equality. + + + Builds a read-only lookup table from a sequence of key/value pairs. The key objects are indexed using generic hashing and equality. + + + Converts the argument to signed byte. + This is a direct conversion for all + primitive numeric types. For strings, the input is converted using SByte.Parse() with InvariantCulture settings. + Otherwise the operation requires and invokes a ToSByte method on the input type. + + + Converts the argument to byte. + This is a direct conversion for all + primitive numeric types. For strings, the input is converted using Byte.Parse() on strings and otherwise requires a ToByte method on the input type. + + + Converts the argument to 64-bit float. + This is a direct conversion for all + primitive numeric types. For strings, the input is converted using Double.Parse() with InvariantCulture settings. Otherwise the operation requires and invokes a ToDouble method on the input type. + + + Converts the argument to 32-bit float. + This is a direct conversion for all + primitive numeric types. For strings, the input is converted using Single.Parse() with InvariantCulture settings. Otherwise the operation requires and invokes a ToSingle method on the input type. + + + Builds an asynchronous workflow using computation expression syntax. + + + Builds a set from a sequence of objects. The objects are indexed using generic comparison. + The input sequence of elements. + The created set. + + + Print to a file using the given format, and add a newline. + The file TextWriter. + The formatter. + The formatted result. + + + Print to a file using the given format. + The file TextWriter. + The formatter. + The formatted result. + + + Print to a string buffer and raise an exception with the given + result. Helper printers must return strings. + The formatter. + The formatted result. + + + Print to a string using the given format. + The formatter. + The formatted result. + + + Print to stderr using the given format, and add a newline. + The formatter. + The formatted result. + + + Print to stderr using the given format. + The formatter. + The formatted result. + + + Print to stdout using the given format, and add a newline. + The formatter. + The formatted result. + + + Print to stdout using the given format. + The formatter. + The formatted result. + + + Converts the argument to signed byte. + This is a direct, checked conversion for all + primitive numeric types. For strings, the input is converted using SByte.Parse() with InvariantCulture settings. + Otherwise the operation requires and invokes a ToSByte method on the input type. + + + Converts the argument to byte. + This is a direct, checked conversion for all + primitive numeric types. For strings, the input is converted using Byte.Parse() on strings and otherwise requires a ToByte method on the input type. diff --git a/packages/FAKE.4.11.3/tools/Fake.Experimental.XML b/packages/FAKE.5.16.0/tools/Fake.Experimental.XML similarity index 100% rename from packages/FAKE.4.11.3/tools/Fake.Experimental.XML rename to packages/FAKE.5.16.0/tools/Fake.Experimental.XML diff --git a/packages/FAKE.5.16.0/tools/Fake.Experimental.dll b/packages/FAKE.5.16.0/tools/Fake.Experimental.dll new file mode 100644 index 0000000..11735e9 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/Fake.Experimental.dll differ diff --git a/packages/FAKE.4.11.3/tools/Fake.Experimental.dll.config b/packages/FAKE.5.16.0/tools/Fake.Experimental.dll.config similarity index 93% rename from packages/FAKE.4.11.3/tools/Fake.Experimental.dll.config rename to packages/FAKE.5.16.0/tools/Fake.Experimental.dll.config index 60ee56a..dfcc841 100644 --- a/packages/FAKE.4.11.3/tools/Fake.Experimental.dll.config +++ b/packages/FAKE.5.16.0/tools/Fake.Experimental.dll.config @@ -3,10 +3,6 @@ - - - - @@ -47,10 +43,6 @@ - - - - @@ -105,11 +97,11 @@ - + - + @@ -127,5 +119,18 @@ + + True + + + + + True + + + + + + \ No newline at end of file diff --git a/packages/FAKE.4.11.3/tools/Fake.FluentMigrator.XML b/packages/FAKE.5.16.0/tools/Fake.FluentMigrator.XML similarity index 100% rename from packages/FAKE.4.11.3/tools/Fake.FluentMigrator.XML rename to packages/FAKE.5.16.0/tools/Fake.FluentMigrator.XML diff --git a/packages/FAKE.5.16.0/tools/Fake.FluentMigrator.dll b/packages/FAKE.5.16.0/tools/Fake.FluentMigrator.dll new file mode 100644 index 0000000..09e9d43 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/Fake.FluentMigrator.dll differ diff --git a/packages/FAKE.4.11.3/tools/Fake.Gallio.XML b/packages/FAKE.5.16.0/tools/Fake.Gallio.XML similarity index 100% rename from packages/FAKE.4.11.3/tools/Fake.Gallio.XML rename to packages/FAKE.5.16.0/tools/Fake.Gallio.XML diff --git a/packages/FAKE.5.16.0/tools/Fake.Gallio.dll b/packages/FAKE.5.16.0/tools/Fake.Gallio.dll new file mode 100644 index 0000000..f82fb6c Binary files /dev/null and b/packages/FAKE.5.16.0/tools/Fake.Gallio.dll differ diff --git a/packages/FAKE.4.11.3/tools/Fake.Gallio.dll.config b/packages/FAKE.5.16.0/tools/Fake.Gallio.dll.config similarity index 93% rename from packages/FAKE.4.11.3/tools/Fake.Gallio.dll.config rename to packages/FAKE.5.16.0/tools/Fake.Gallio.dll.config index 97a1858..f0a438d 100644 --- a/packages/FAKE.4.11.3/tools/Fake.Gallio.dll.config +++ b/packages/FAKE.5.16.0/tools/Fake.Gallio.dll.config @@ -7,10 +7,6 @@ - - - - @@ -47,10 +43,6 @@ - - - - @@ -105,11 +97,11 @@ - + - + @@ -127,5 +119,18 @@ + + True + + + + + True + + + + + + \ No newline at end of file diff --git a/packages/FAKE.4.11.3/tools/Fake.IIS.XML b/packages/FAKE.5.16.0/tools/Fake.IIS.XML similarity index 100% rename from packages/FAKE.4.11.3/tools/Fake.IIS.XML rename to packages/FAKE.5.16.0/tools/Fake.IIS.XML diff --git a/packages/FAKE.5.16.0/tools/Fake.IIS.dll b/packages/FAKE.5.16.0/tools/Fake.IIS.dll new file mode 100644 index 0000000..683f78e Binary files /dev/null and b/packages/FAKE.5.16.0/tools/Fake.IIS.dll differ diff --git a/packages/FAKE.4.11.3/tools/Fake.IIS.dll.config b/packages/FAKE.5.16.0/tools/Fake.IIS.dll.config similarity index 93% rename from packages/FAKE.4.11.3/tools/Fake.IIS.dll.config rename to packages/FAKE.5.16.0/tools/Fake.IIS.dll.config index 97a1858..f0a438d 100644 --- a/packages/FAKE.4.11.3/tools/Fake.IIS.dll.config +++ b/packages/FAKE.5.16.0/tools/Fake.IIS.dll.config @@ -7,10 +7,6 @@ - - - - @@ -47,10 +43,6 @@ - - - - @@ -105,11 +97,11 @@ - + - + @@ -127,5 +119,18 @@ + + True + + + + + True + + + + + + \ No newline at end of file diff --git a/packages/FAKE.4.11.3/tools/Fake.SQL.XML b/packages/FAKE.5.16.0/tools/Fake.SQL.XML similarity index 100% rename from packages/FAKE.4.11.3/tools/Fake.SQL.XML rename to packages/FAKE.5.16.0/tools/Fake.SQL.XML diff --git a/packages/FAKE.5.16.0/tools/Fake.SQL.dll b/packages/FAKE.5.16.0/tools/Fake.SQL.dll new file mode 100644 index 0000000..2291b5f Binary files /dev/null and b/packages/FAKE.5.16.0/tools/Fake.SQL.dll differ diff --git a/packages/FAKE.4.11.3/tools/Fake.SQL.dll.config b/packages/FAKE.5.16.0/tools/Fake.SQL.dll.config similarity index 93% rename from packages/FAKE.4.11.3/tools/Fake.SQL.dll.config rename to packages/FAKE.5.16.0/tools/Fake.SQL.dll.config index 97a1858..f0a438d 100644 --- a/packages/FAKE.4.11.3/tools/Fake.SQL.dll.config +++ b/packages/FAKE.5.16.0/tools/Fake.SQL.dll.config @@ -7,10 +7,6 @@ - - - - @@ -47,10 +43,6 @@ - - - - @@ -105,11 +97,11 @@ - + - + @@ -127,5 +119,18 @@ + + True + + + + + True + + + + + + \ No newline at end of file diff --git a/packages/FAKE.5.16.0/tools/FakeLib.XML b/packages/FAKE.5.16.0/tools/FakeLib.XML new file mode 100644 index 0000000..d23d97d --- /dev/null +++ b/packages/FAKE.5.16.0/tools/FakeLib.XML @@ -0,0 +1,33251 @@ + + +FakeLib + + + + Quickly create a new IFsiSession with some sane defaults + + + + + Creates a forwarder Textwriter, which forwards all output to the given function. + Set revertRedirect only to "false" if you know that f doesn't print anything to the stdout. + When revertRedirect is true we capture the Console.Out property and set it before calling f. + removeNewLines handles the newline characters properly and calls f for every new line instead of every call to + to the underlaying writers. + The difference is that with removeNewLines you should use printfn and get lines without newline characters. + On the other hand without removeNewLines you are called on every TextWriter.Write call, + so you might be called multiple times for a single lines or a single time for multiple lines. + + + + + Create a new IFsiSession by specifying all fsi arguments manually. + + + + + Sets a warning level (0 to 5). The default level is 3. Each warning is given a level based on its severity. Level 5 gives more, but less severe, warnings than level 1. + Level 5 warnings are: 21 (recursive use checked at runtime), 22 (let rec evaluated out of order), 45 (full abstraction), and 52 (defensive copy). All other warnings are level 2. + + + + + Sets a warning level (0 to 5). The default level is 3. Each warning is given a level based on its severity. Level 5 gives more, but less severe, warnings than level 1. + Level 5 warnings are: 21 (recursive use checked at runtime), 22 (let rec evaluated out of order), 45 (full abstraction), and 52 (defensive copy). All other warnings are level 2. + + + + + See https://msdn.microsoft.com/en-us/library/dd233172.aspx + + + + + Gets the currently build dynamic assembly. + + + + + Try to evaluate the given expression and return its result. + + + + + Evaluate the given script. + + + + + Evaluate the given interaction. + + + + + Represents a simple F# interactive session. + + + + + Exception for invalid expression types + + + + + This exception indicates that an exception happened while compiling or executing given F# code. + + + + + Implements a simple 'fsi' object to be passed to the FSI evaluator + + + + + Represents a simple (fake) event loop for the 'fsi' object + + + + + Handle the given evaluation function + + + + + Same as ChangeCurrentDirectory but takes a function for the scope. + + + + + Change the current directory (so that relative paths within scripts work properly). + Returns a handle to change the current directory back to it's initial state + (Because this will change the current directory of the currently running code as well!). + + + + + Same as Cd but takes a function for the scope. + + + + + Change the current directory (so that relative paths within scripts work properly). + Returns a handle to change the current directory back to it's initial state + (Because this will change the current directory of the currently running code as well!). + + + + + Assigns the given object to the given name (ie "let varName = obj") + + + + + Evaluate the given expression and return its result. + + + + + See https://github.com/Microsoft/visualfsharp/issues/1392 + + + + + See https://github.com/Microsoft/visualfsharp/issues/1392 + + + + + Reproduces the original substrings from a string created with concatEscape. + + + + + Returns a new string by connecting the given strings with the given separator. + + + + + Returns a function who can convert a given source string to a token stream. + + + + + Gets a string that can be used in F# source code to reference the current type instance. + + + + + The parameter list of the current type, sets "_" if the current instance is a generic definition. + + + + + Gets the FullName of the current type in F# source code. + + + + + The name of the current type instance in F# source code. + + + + + The FullName but without any generic parameter types. + + + + + Check if the hash in parameter is the valid hash of the file + + + + + Calculate the hash of a file. Default hash algorithm used: SHA256 + + + + + Allow to calculate checksum + + + + + Returns if the build parameter with the given name was set + + + + + Retrieves the environment variable or None + + + + + Retrieves the environment variable with the given name or returns the false if no value was set + + + + + Retrieves the environment variable with the given name or returns the default bool if no value was set + + + + + Retrieves the environment variable with the given name or fails if not found + + + + + Retrieves the environment variable with the given name or returns the default if no value was set + + + + + Sets the environment variable with the given name + + + + + Retrieves all environment variables from the given target + + + + + Retrieves the environment variable with the given name + + + + + Gets the FAKE Version string + + + + + Gets the FAKE version no. + + + + + This module contains functions which allow to read and write environment variables and build parameters + + + + + Contains basic functions for string manipulation. + + + + + Returns if the string is not null or empty + + + + + Returns if the string is null or empty + + + + + Contains basic functions for string manipulation. + + + + + Writes the given message to the Console. + + + + + Implements a TraceListener for System.Console. + ## Parameters + - `importantMessagesToStdErr` - Defines whether to trace important messages to StdErr. + - `colorMap` - A function which maps TracePriorities to ConsoleColors. + + + + + Defines a TraceListener interface + + + + + Defines Tracing information for TraceListeners + + + + + Traces an error (in red) + + + + + Writes a trace to the command line (in yellow) + + + + + Writes a message to the command line (in green) and without a line break + + + + + Writes a message to the command line (in green) + + + + + Writes a trace to the command line (in green) + + + + + Logs the specified string + + + + + Gets the path of the current FAKE instance + + + + + Allows to post messages to all trace listeners + + + + + A List with all registered listeners + + + + + The default TraceListener for Console. + + + + + A default color map which maps TracePriorities to ConsoleColors + + + + + This module contains function which allow to trace build output + + + + + Parse #r references for `paket:` lines + + + + + Contains helper functions which allow to interact with the F# Interactive. + + + + + public, because it is used by test code + + + + + Handles a cache store operation, this should not throw as it is executed in a finally block and + therefore might eat other exceptions. And a caching error is not critical. + + + + + Contains helper functions which allow to interact with the F# Interactive. + + + + + public, because it is used by test code + + + + + Handles a cache store operation, this should not throw as it is executed in a finally block and + therefore might eat other exceptions. And a caching error is not critical. + + + + + Contains helper functions which allow to interact with the F# Interactive. + + + + + Contains helper functions which allow to interact with the F# Interactive. + + + + + Contains helper functions which allow to interact with the F# Interactive. + + + + + Doesn't create the .fake folder for this file if we don't detect a fake script + + + + + Get base include directories. Used to get a smaller set of directories from a globbing pattern. + + + + + Sets a directory as baseDirectory for fileIncludes. + + + + + Start an empty globbing pattern from the specified directory + + + + + Include files + + + + + Checks if a particular file is matched + + + + + Sets a directory as BaseDirectory. + + + + + Ignores files with the given pattern + + + + + Adds the given pattern to the file includes + + + + + This module contains a file pattern globbing implementation. + This module is part of the `Fake.IO.FileSystem` package + + + + + Looks for a tool in all subfolders - returns the folder where the tool was found. + + + + + Looks for a tool in all subfolders - returns the folder where the tool was found + or None if not found. + + + + + Looks for a tool first in its default path, if not found the in ./packages/ and then + in all subfolders of the root folder - returns the tool file name. + + + + + Includes a single pattern and scans the files - !! x = AllFilesMatching x + + + + + Exclude operator + + + + + Add Include operator + + + + + Contains operators to find and process files. + This module is part of the `Fake.IO.FileSystem` package + + ### Simple glob using as list + + #r "paket: nuget Fake.IO.FileSystem //" + open Fake.IO.Globbing.Operators + let csProjectFiles = !! "src/*.csproj" + + for projectFile in csProjectFiles do + printf "F# ProjectFile: %s" projectFile + + ### Combine globs + + #r "paket: nuget Fake.IO.FileSystem //" + open Fake.IO.Globbing.Operators + let projectFiles = + !! "src/*/*.*proj" + ++ "src/*/*.target" + -- "src/*/*.vbproj" + + for projectFile in projectFiles do + printf "ProjectFile: %s" projectFile + + ### Forward globs to tasks + + #r "paket: + nuget Fake.Core.Target + nuget Fake.IO.FileSystem //" + open Fake.Core + open Fake.IO + open Fake.IO.Globbing.Operators + Target.create "Clean" (fun _ -> + !! "src/*/*/obj/**/*.nuspec" + |> File.deleteAll + ) + + + + + + Sets a directory as baseDirectory for fileIncludes. + + + + + Include files + + + + + Convert the given windows path to a path in the current system + + + + Produces relative path when possible to go from baseLocation to targetLocation. + The root folder + The target folder + The relative path relative to baseLocation + base or target locations are null or empty + + + + Replaces any occurence of the currentDirectory with . + + + + + The directory separator string. On most systems / or \ + + + + + Get the directory of the specified path + ## Parameters + + - 'path' - The path from which the directory is retrieved. + + + + + Tests whether the file has specified extensions (containing the leading '.') + ## Parameters + + - 'extension' - The extension to fine containing the leading '.'. + - 'fileName' - Name of the file from which the extension is retrieved. + + + + + Change the extension of the file. + ## Parameters + + - 'extension' - The new extension containing the leading '.'. + - 'fileName' - Name of the file from which the extension is retrieved. + + + + + Detects whether the given path does not contains invalid characters. + + + + + Normalizes a filename. + + + + + Detects whether the given path is a file. + + + + + Detects whether the given path is a directory. + + + + + Combines two path strings using Path.Combine + + + + + Combines two path strings using Path.Combine. Trims leading slashes of path2. This makes `combineTrimEnd "/test" "/sub"` return `/test/sub` + + + + + Contains helper function which allow to deal with files and directories. + + + + + Checks if the two files are byte-to-byte equal. + + + + + Active Pattern for determining FileInfoNameSections. + + + + + Active Pattern for determining file name. + + + + + Creates a FileInfo for the given path. + + + + + Combines two path strings using Path.Combine + + + + + Combines two path strings using Path.Combine. Trims leading slashes of the right operand. This makes `"/test" @@ "/sub"` return `/test/sub` + + + + + Copies the file structure recursively. + + + + + Copies the file structure recursively, filtering files. + + + + + Sets all files in the directory readonly recursively. + + + + + Sets the directory readonly + + + + + Performs the given actions on all files and subdirectories + + + + + Ensure that directory chain exists. Create necessary directories if necessary. + + + + + Checks if the directory exists on disk. + + + + + Checks if the file is in a subfolder of the dir. + + + + + Checks if dir1 is a subfolder of dir2. If dir1 equals dir2 the function returns also true. + + + + + Finds all the files in the directory and in all subdirectories matching the search pattern. + + + + + Finds all the files in the directory matching the search pattern. + + + + + Gets all files in the directory. + + + + + Gets all subdirectories of a given directory. + + + + + Creates a DirectoryInfo for the given path. + + + + + Replaces the text in the given file + + + + + Reads a file as one array of bytes + + + + + Reads a file as one text + + + + + Appends all lines to a file line by line + + + + + Writes a file line by line + + + + + Replaces the file with the given string + + + + + Writes a string to a file + + + + + Writes a byte array to a file + + + + + Writes a file line by line + + + + + Reads the first line of a file. This can be helpful to read a password from file. + + + + + Reads the first line of a file. This can be helpful to read a password from file. + + + + + Reads a file line by line + + + + + Active Pattern for determining file extension. + + + + + Deletes the given files. + + + + + Deletes a file if it exists. + + + + + Creates a file if it does not exist. + + + + + Get the version a file. + ## Parameters + + - 'fileName' - Name of file from which the version is retrieved. The path can be relative. + + + + + Checks if all given files exist. + + + + + Raises an exception if the file doesn't exist on disk. + + + + + Get the encoding from the file or utf8 without BOM if unknown or the file doesn't exist + + + + + Gets the encoding from the file or the default of the file doesn't exist + + + + + Checks if the file exists on disk. + + + + + see https://stackoverflow.com/questions/2502990/create-text-file-without-bom + + + + + Deletes a directory if it exists (including all contained elements). + + + + + Gets the first file in the directory matching the search pattern or throws an error if nothing was found. + + + + + Gets the first file in the directory matching the search pattern as an option value. + + + + + Creates a directory if it does not exist. + + + + + Checks if the given directory exists. If not then this functions creates the directory. + + + + + Active pattern which discriminates between files and directories. + + + + + Sets all given files or directories readonly. + + + + + Creates a FileInfo or a DirectoryInfo for the given path + + + + + Replaces the templates with the given replacements + + + + + Saves all files (lazy - file by file!) + + + + + Replaces a bunch of the keywords in all files (lazy - line by line!) + + + + + Loads all templates (lazy - line by line!) + + + + + NOTE: Maybe this should be an extra module? + Contains basic templating functions. Used in other helpers. + + + + + Like "mv" in a shell. Moves/renames a file + <param name="src">The source</param> + <param name="dest">The destination</param> + + + + + Restore the previous directory stored in the stack + + + + + Store the current directory in the directory stack before changing to a new one + + + + + The stack of directories operated on by pushd and popd + + + + + Gets working directory + + + + + Changes working directory + + + + + Changes working directory + + + + + Like "cp" in a shell. Copies a single file. + <param name="src">The source</param> + <param name="dest">The destination</param> + + + + + Like "cp -r" in a shell. Copies a file or directory recursively. + + The source + The destination + + + + Creates a directory if it doesn't exist. + + + + + Like "rm -rf" in a shell. Removes files recursively, ignoring nonexisting files + + + + + Deletes a file if it exists + + + + + Replace all occurences of the regex pattern with the given replacement in the specified files + ## Parameters + + - `pattern` - The string to search for a match + - `replacement` - The replacement string + - `encoding` - The encoding to use when reading and writing the files + - `files` - The paths of the files to process + + + + + Replace all occurences of the regex pattern with the given replacement in the specified file + ## Parameters + + - `pattern` - The string to search for a match + - `replacement` - The replacement string + - `encoding` - The encoding to use when reading and writing the file + - `file` - The path of the file to process + + + + + Replaces all occurences of the patterns in the given files with the given replacements. + ## Parameters + + - `replacements` - A sequence of tuples with the patterns and the replacements. + - `files` - The files to process. + + + + + Creates a config file with the parameters as "key;value" lines + + + + + Moves a single file to the target and overwrites the existing file. + ## Parameters + + - `target` - The target directory. + - `fileName` - The FileName. + + + + + Copies the file structure recursively. + ## Parameters + + - `method` - the method to decide which files get copied + - `dir` - The source directory. + - `outputDir` - The target directory. + + + + + Copies the file structure recursively. + + + + + Checks if the file exists + + + + + Checks if the directory exists + + + + + Checks the srcFiles for changes to the last release. + ## Parameters + + - `lastReleaseDir` - The directory of the last release. + - `patchDir` - The target directory. + - `srcFiles` - The source files. + + + + + Checks the srcFiles for changes to the last release. + ## Parameters + + - `lastReleaseDir` - The directory of the last release + - `patchDir` - The target directory + - `srcFiles` - The source files + - `findOldFileF` - A function which finds the old file + + + + + Compares the given files for changes. + If delete is set to true then equal files will be removed. + + + + + Appends all given files to one file. + ## Parameters + + - `newFileName` - The target FileName. + - `files` - The original FileNames as a sequence. + + + + + Appends all given files to one file. + ## Parameters + + - `newFileName` - The target FileName. + - `files` - The original FileNames as a sequence. + + + + + Deletes multiple directories + + + + + Compat + + + + + Cleans multiple directories + + + + + Cleans a directory by removing all files and sub-directories. + + + + + Copies a directory recursivly. If the target directory does not exist, it will be created. + ## Parameters + + - `target` - The target directory. + - `source` - The source directory. + - `filterFile` - A file filter predicate. + + + + + Copies the files to the target - Alias for Copy + ## Parameters + + - `target` - The target directory. + - `files` - The orginal file names. + + + + + Copies a list of files to the specified directory without any output. + ## Parameters + + - `target` - The target directory. + - `files` - List of files to copy. + + + + + Renames the file or directory to the target name. + ## Parameters + + - `target` - The target file or directory name. + - `fileName` - The orginal file or directory name. + + + + + Copies the files from a cache folder. + If the files are not cached or the original files have a different write time the cache will be refreshed. + ## Parameters + + - `target` - The target FileName. + - `cacheDir` - The cache directory. + - `files` - The orginal files. + + + + + Copies the given files to the target. + ## Parameters + + - `target` - The target directory. + - `files` - The original file names as a sequence. + + + + + Copies the files to the target. + ## Parameters + + - `target` - The target directory. + - `files` - The original file names as a sequence. + + + + + Copies a single file to the target folder preserving the folder structure + starting from the specified base folder. + ## Parameters + + - `baseDir` - The base directory. + - `target` - The target directory. + - `fileName` - The file name. + + + + + Copies a single file to a relative subfolder of the target. + ## Parameters + + - `target` - The target directory + - `fileName` - The fileName + + + + + Copies a single file to the target and overwrites the existing file. + ## Parameters + + - `target` - The target directory or file. + - `fileName` - The FileName. + + + + + Replace all occurences of the regex pattern with the given replacement in the specified files + ## Parameters + + - `pattern` - The string to search for a match + - `replacement` - The replacement string + - `encoding` - The encoding to use when reading and writing the files + - `files` - The paths of the files to process + + + + + Replace all occurences of the regex pattern with the given replacement in the specified file + ## Parameters + + - `pattern` - The string to search for a match + - `replacement` - The replacement string + - `encoding` - The encoding to use when reading and writing the file + - `file` - The path of the file to process + + + + + Replaces all occurences of the patterns in the given files with the given replacements. + ## Parameters + + - `replacements` - A sequence of tuples with the patterns and the replacements. + - `files` - The files to process. + + + + + Creates a config file with the parameters as "key;value" lines + + + + + Moves a single file to the target and overwrites the existing file. + If `fileName` is a directory the functions does nothing. + ## Parameters + + - `target` - The target directory. + - `fileName` - The FileName. + + + + + Copies the file structure recursively. + ## Parameters + + - `method` - the method to decide which files get copied + - `dir` - The source directory. + - `outputDir` - The target directory. + + + + + Copies the file structure recursively. + + + + + Checks if the file exists + + + + + Checks if the directory exists + + + + + Checks the srcFiles for changes to the last release. + ## Parameters + + - `lastReleaseDir` - The directory of the last release. + - `patchDir` - The target directory. + - `srcFiles` - The source files. + + + + + Checks the srcFiles for changes to the last release. + ## Parameters + + - `lastReleaseDir` - The directory of the last release + - `patchDir` - The target directory + - `srcFiles` - The source files + - `findOldFileF` - A function which finds the old file + + + + + Compares the given files for changes. + If delete is set to true then equal files will be removed. + + + + + Appends all given files to one file. + ## Parameters + + - `newFileName` - The target FileName. + - `files` - The original FileNames as a sequence. + + + + + Appends all given files to one file. + ## Parameters + + - `newFileName` - The target FileName. + - `files` - The original FileNames as a sequence. + + + + + Deletes multiple directories + + + + + Compat + + + + + Cleans multiple directories + + + + + Cleans a directory by removing all files and sub-directories. + + + + + Copies a directory recursivly. If the target directory does not exist, it will be created. + ## Parameters + + - `target` - The target directory. + - `source` - The source directory. + - `filterFile` - A file filter predicate. + + + + + Copies the given glob-matches into another directory by leaving relative paths in place based on the globbing base-directory + + ## Sample + + !! "**/My*Glob*.exe" + |> GlobbingPattern.setBaseDir "baseDir" + |> Shell.copyFilesWithSubFolder "targetDir" + + + + + + Copies the files to the target - Alias for Copy + ## Parameters + + - `target` - The target directory. + - `files` - The orginal file names. + + + + + Copies a list of files to the specified directory without any output. + ## Parameters + + - `target` - The target directory. + - `files` - List of files to copy. + + + + + Renames the file or directory to the target name. + ## Parameters + + - `target` - The target file or directory name. + - `fileName` - The orginal file or directory name. + + + + + Copies the files from a cache folder. + If the files are not cached or the original files have a different write time the cache will be refreshed. + ## Parameters + + - `target` - The target FileName. + - `cacheDir` - The cache directory. + - `files` - The orginal files. + + + + + Copies the given files to the target. + ## Parameters + + - `target` - The target directory. + - `files` - The original file names as a sequence. + + + + + Copies the files to the target. + ## Parameters + + - `target` - The target directory. + - `files` - The original file names as a sequence. + + + + + Copies a single file to the target folder preserving the folder structure + starting from the specified base folder. + ## Parameters + + - `baseDir` - The base directory. + - `target` - The target directory. + - `fileName` - The file name. + + + + + Copies a single file to a relative subfolder of the target. + ## Parameters + + - `target` - The target directory + - `fileName` - The fileName + + + + + Copies a single file to the target and overwrites the existing file. + ## Parameters + + - `target` - The target directory or file. + - `fileName` - The FileName. + + + + + Watches for changes in the matching files. + Returns an IDisposable which allows to dispose all internally used FileSystemWatchers. + + ## Parameters + - `onChange` - function to call when a change is detected. + - `fileIncludes` - The glob pattern for files to watch for changes. + + + + + This module is part of the `Fake.IO.FileSystem` package + + ## Sample + + Target.create "Watch" (fun _ -> + use watcher = !! "c:/projects/watchDir/*.txt" |> ChangeWatcher.run (fun changes -> + // do something + ) + + System.Console.ReadLine() |> ignore + + watcher.Dispose() // if you need to cleanup the watcher. + ) + + + + + + Creates a zip file with the given files. + ## Parameters + - `fileName` - The file name of the resulting zip file. + - `files` - A sequence of target folders and files to include relative to their base directory. + + ## Sample + + The following sample creates a zip file containing the files from the two target folders and FileIncludes. + + - The files from the first FileInclude will be placed in the root of the zip file. + - The files from the second FileInclude will be placed under the directory `app_data\jobs\continuous\MyWebJob` in the zip file. + + + Target "Zip" (fun _ -> + [ "", !! "MyWebApp/*.html" + ++ "MyWebApp/bin/**/*.dll" + ++ "MyWebApp/bin/**/*.pdb" + ++ "MyWebApp/fonts/**" + ++ "MyWebApp/img/**" + ++ "MyWebApp/js/**" + -- "MyWebApp/js/_references.js" + ++ "MyWebApp/web.config" + @"app_data\jobs\continuous\MyWebJob", !! "MyWebJob/bin/Release/*.*" + ] + |> Zip.zipOfIncludes (sprintf @"bin\MyWebApp.%s.zip" buildVersion) + ) + + + + + + Creates a zip file with the given files. + ## Parameters + - `fileName` - The file name of the resulting zip file. + - `comment` - A comment for the resulting zip file (currently ignored in fake 5). + - `level` - The compression level. + - `files` - A sequence of target folders and files to include relative to their base directory. + + + + + This helper helps with creating complex zip file with multiple include patterns. + This function will move a given list of zip specifications to the given folder (while keeping original folder structure intact). + ## Parameters + - `workingDir` - The relative dir of the zip files. Use this parameter to influence directory structure within zip file. + - `files` - A sequence of target folders and files to include relative to their base directory. + + ## Sample + + The following sample creates a zip file containing the files from multiple patterns and moves them to different folders within the zip file. + + + Target "Zip" (fun _ -> + [ !! "ci/build/project1/**/*" + |> Zip.filesAsSpecsFlatten + |> Zip.moveToFolder "project1" + !! "ci/build/project2/**/*" + |> Zip.filesAsSpecsFlatten + |> Zip.moveToFolder "project2" + !! "ci/build/project3/sub/dir/**/*" + |> Zip.filesAsSpecs "ci/build/project3" + |> Zip.moveToFolder "project3" + ] + |> Seq.concat + |> Zip.zipSpec (sprintf @"ci/deploy/project.%s.zip" buildVersion) + ) + + + + + + This helper helps with creating complex zip file with multiple include patterns. + ## Parameters + - `workingDir` - The relative dir of the zip files. Use this parameter to influence directory structure within zip file. + - `files` - A sequence of target folders and files to include relative to their base directory. + + ## Sample + + The following sample creates a zip file containing the files from multiple patterns and moves them to different folders within the zip file. + + + Target "Zip" (fun _ -> + [ !! "ci/build/project1/**/*" + |> Zip.filesAsSpecsFlatten + |> Zip.moveToFolder "project1" + !! "ci/build/project2/**/*" + |> Zip.filesAsSpecsFlatten + |> Zip.moveToFolder "project2" + !! "ci/build/project3/sub/dir/**/*" + |> Zip.filesAsSpecs "ci/build/project3" + |> Zip.moveToFolder "project3" + ] + |> Seq.concat + |> Zip.zipSpec (sprintf @"ci/deploy/project.%s.zip" buildVersion) + ) + + + + + + This helper helps with creating complex zip file with multiple include patterns. + This method will convert a given glob pattern with the given workingDir to a sequence of zip specifications. + ## Parameters + - `workingDir` - The relative dir of the zip files. Use this parameter to influence directory structure within zip file. + - `files` - A sequence of target folders and files to include relative to their base directory. + + ## Sample + + The following sample creates a zip file containing the files from multiple patterns and moves them to different folders within the zip file. + + + Target "Zip" (fun _ -> + [ !! "ci/build/project1/**/*" + |> Zip.filesAsSpecs "ci/build/project1" + |> Zip.moveToFolder "project1" + !! "ci/build/project2/**/*" + |> Zip.filesAsSpecs "ci/build/project2" + |> Zip.moveToFolder "project2" + !! "ci/build/project3/sub/dir/**/*" + |> Zip.filesAsSpecs "ci/build/project3" + |> Zip.moveToFolder "project3" + ] + |> Seq.concat + |> Zip.zipSpec (sprintf @"ci/deploy/project.%s.zip" buildVersion) + ) + + + + + + Unzips a single file from the archive with the given file name. + ## Parameters + - `predicate` - The predicate for the searched file in the archive. + - `zipFileName` - The file name of the zip file. + + + + + Unzips a single file from the archive with the given file name. + ## Parameters + - `fileToUnzip` - The file inside the archive. + - `zipFileName` - The file name of the zip file. + + + + + Unzips a file with the given file name. + ## Parameters + - `target` - The target directory. + - `fileName` - The file name of the zip file. + + + + + Creates a zip file with the given file. + ## Parameters + - `fileName` - The file name of the resulting zip file. + - `targetFileName` - The file to zip. + + + + + Creates a zip file with the given files and specs. + ## Parameters + - `fileName` - The fileName of the resulting zip file. + - `items` - A sequence with files and their target location in the zip. + + + + + Creates a zip file with the given files and specs. + ## Parameters + - `fileName` - The fileName of the resulting zip file. + - `comment` - A comment for the resulting zip file (currently ignored in fake 5). + - `level` - The compression level. + - `items` - A sequence with files and their target location in the zip. + + + + + Creates a zip file with the given files. + ## Parameters + - `workingDir` - The relative dir of the zip files. Use this parameter to influence directory structure within zip file. + - `fileName` - The file name of the resulting zip file. + - `files` - A sequence with files to zip. + + + + + Creates a zip file with the given files + ## Parameters + - `workingDir` - The relative dir of the zip files. Use this parameter to influence directory structure within zip file. + - `fileName` - The fileName of the resulting zip file. + - `comment` - A comment for the resulting zip file (currently ignored in fake 5). + - `level` - The compression level. + - `flatten` - If set to true then all subfolders are merged into the root folder. + - `files` - A sequence with files to zip. + + + + + The default zip level + + + + + This module contains helper function to create and extract zip archives. + + + + + Writes the given message to the xml file. + + + + + Implements a TraceListener which writes NAnt like XML files. + ## Parameters + - `xmlOutputFile` - Defines the xml output file. + + + + + Allows to register a new Xml listeners + + + + + Specifies if the XmlWriter should close tags automatically + + + + + This module contains function which allow to trace build output + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + Transform a "list<Result>" into a "Result<list>" + and collect the results using apply. + + + + + [omit] + Map a Result producing function over a list to get a new Result + using applicative style + ('a -> Result<'b>) -> 'a list -> Result<'b list> + + + + + [omit] + Transform a "list<Async>" into a "Async<list>" + and collect the results using apply. + + + + + [omit] + Map a Async producing function over a list to get a new Async + using applicative style + ('a -> Async<'b>) -> 'a list -> Async<'b list> + + + + + [omit] + + + + + Option type for the HTTP verb + + + + + Contains validated Uri and FilePath info for further download + + + + + Type aliases for local file path and error messages + + + + + The name of the local file that is to receive the data + + + + + The URI from which to download data + + + + + Input parameter type + + + + + Like 'get' but allow to set headers and returns the response headers. + + + + + Upload the given file to the given endpoint + + + + + Executes an HTTP POST command and retrives the information. + It returns the response of the request, or null if we got 404 or nothing. + ## Parameters + + - `url` - The URL to perform the POST operation. + - `userName` - The username to use with the request. + - `password` - The password to use with the request. + - `data` - The data to post. + + + + + Executes an HTTP POST command and retrives the information. + This function will automatically include a "source" parameter if the "Source" property is set. + It returns the response of the request, or null if we got 404 or nothing. + ## Parameters + + - `headerF` - A function which allows to manipulate the HTTP headers. + - `url` - The URL to perform the POST operation. + - `userName` - The username to use with the request. + - `password` - The password to use with the request. + - `data` - The data to post. + + + + + Executes an HTTP POST command and retrives the information. + This function will automatically include a "source" parameter if the "Source" property is set. + It returns the response of the request, or null if we got 404 or nothing. + ## Parameters + + - `headerF` - A function which allows to manipulate the HTTP headers. + - `url` - The URL to perform the POST operation. + - `userName` - The username to use with the request. + - `password` - The password to use with the request. + - `data` - The data to post. + + + + + Executes an HTTP GET command and retrives the information. + It returns the response of the request, or null if we got 404 or nothing. + ## Parameters + + - `userName` - The username to use with the request. + - `password` - The password to use with the request. + - `url` - The URL to perform the GET operation. + + + + + Executes an HTTP GET command and retrives the information. + It returns the response of the request, or null if we got 404 or nothing. + ## Parameters + + - `userName` - The username to use with the request. + - `password` - The password to use with the request. + - `url` - The URL to perform the GET operation. + + + + + Download list of Uri's in parallel + DownloadParameters -> string list + ## Parameters + - `input` - List of Http.DownloadParameters. Each Http.DownloadParameters record type contains Uri and file path + + ## Returns + - `string list` type. Contains a list of downloaded file paths + + + + + Download file by the given file path and Uri + string -> string -> string + ## Parameters + - `localFilePath` - A local file path to download file + - `uri` - A Uri to download from + + ## Returns + - `string` type. Contains a downloaded file path + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + Unwraps the Result type and throws an exception if download process failed + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + HTTP Client for downloading files + + + + + The Npm parameter type + + + + + The list of supported Npm commands. + + + + + Arguments for the Npm install command + + + + + Run `npm <command>`. Used to run any command. + ## Parameters + + - 'command' - command to run + - 'setParams' - set command parameters + ## Sample + + Npm.exec "--v" (fun o -> + { o with + WorkingDirectory = "./src/FAKESimple.Web/" + }) + + + + + Run `npm test --silent`. Suppresses npm error output and will raise an FailedTestsException exception after the script execution instead of failing, useful for CI. See [npm:8821](https://github.com/npm/npm/issues/8821). + ## Parameters + + - 'setParams' - set command parameters + ## Sample + + Npm.test (fun o -> + { o with + WorkingDirectory = "./src/FAKESimple.Web/" + }) + + + + + Run `npm run --silent <command>`. Suppresses npm error output and will raise an FailedTestsException exception after the script execution instead of failing, useful for CI. See [npm:8821](https://github.com/npm/npm/issues/8821). + ## Parameters + + - 'command' - command to run + - 'setParams' - set command parameters + ## Sample + + Npm.runTest "test" (fun o -> + { o with + WorkingDirectory = "./src/FAKESimple.Web/" + }) + + + + + Run `npm run --silent <command>`. Suppresses npm error output. See [npm:8821](https://github.com/npm/npm/issues/8821). + ## Parameters + + - 'command' - command to run + - 'setParams' - set command parameters + ## Sample + + Npm.runSilent "someCommand" (fun o -> + { o with + WorkingDirectory = "./src/FAKESimple.Web/" + }) + + + + + Run `npm run <command>` + ## Parameters + + - 'command' - command to run + - 'setParams' - set command parameters + ## Sample + + Npm.run "someCommand" (fun o -> + { o with + WorkingDirectory = "./src/FAKESimple.Web/" + }) + + + + + Run `npm install` + ## Parameters + + - 'setParams' - set command parameters + ## Sample + + Npm.install (fun o -> + { o with + WorkingDirectory = "./src/FAKESimple.Web/" + }) + + + + + Run `npm install --force` + ## Parameters + + - 'setParams' - set command parameters + ## Sample + + Npm.installForced (fun o -> + { o with + WorkingDirectory = "./src/FAKESimple.Web/" + }) + + + + + Runs the given process and returns the process result. + + + + + Npm default parameters + + + + + Default paths to Npm + + + + + Helpers to run the npm tool. + + ## Sample + + Npm.install (fun o -> + { o with + WorkingDirectory = "./src/FAKESimple.Web/" + }) + + + + + The Yarn parameter type + + + + + The list of supported Yarn commands. The `Custom` alternative + can be used for other commands not in the list until they are + implemented + + + + + Arguments for the Yarn install command + + + + + Run `yarn <command>` + ## Parameters + - 'setParams' - set command parameters + ## Sample + + Yarn.exec "someCommand" (fun o -> + { o with + WorkingDirectory = "./src/FAKESimple.Web/" + }) + + + + + Run `yarn install --pure-lockfile` + ## Parameters + - 'setParams' - set command parameters + ## Sample + + Yarn.installPureLock (fun o -> + { o with + WorkingDirectory = "./src/FAKESimple.Web/" + }) + + + + + Run `yarn install --no-lockfile` + ## Parameters + - 'setParams' - set command parameters + ## Sample + + Yarn.installNoLock (fun o -> + { o with + WorkingDirectory = "./src/FAKESimple.Web/" + }) + + + + + Run `yarn install --har` + ## Parameters + - 'setParams' - set command parameters + ## Sample + + Yarn.installHar (fun o -> + { o with + WorkingDirectory = "./src/FAKESimple.Web/" + }) + + + + + Run `yarn install --flat` + ## Parameters + - 'setParams' - set command parameters + ## Sample + + Yarn.installFlat (fun o -> + { o with + WorkingDirectory = "./src/FAKESimple.Web/" + }) + + + + + Run `yarn install --force` + ## Parameters + - 'setParams' - set command parameters + ## Sample + + Yarn.installForced (fun o -> + { o with + WorkingDirectory = "./src/FAKESimple.Web/" + }) + + + + + Run `yarn install --production` + ## Parameters + - 'setParams' - set command parameters + ## Sample + + Yarn.installProduction (fun o -> + { o with + WorkingDirectory = "./src/FAKESimple.Web/" + }) + + + + + Run `yarn install` + ## Parameters + - 'setParams' - set command parameters + ## Sample + + Yarn.install (fun o -> + { o with + WorkingDirectory = "./src/FAKESimple.Web/" + }) + + + + + Yarn default parameters + + + + + Default paths to Yarn + + + + + Helpers for running the yarn tool + + ## Sample + + Yarn.install (fun o -> + { o with + WorkingDirectory = "./src/FAKESimple.Web/" + }) + + + + + Searches for a .git directory in the specified directory or any parent directory. + <exception href="System.InvalidOperationException">Thrown when no .git directory is found.</exception> + + + + + [omit] + + + + + Runs the git command and returns the first line of the result. + + + + + Runs the given git command, waits for its completion. + This version doesn't throw an exception if an error occurs. It just traces the error. + + + + + [omit] + + + + + Runs the given git command, waits for its completion. + + + + + Runs the given git command, waits for its completion and fails when it didn't succeeded. + + + + + Runs the given git command, waits for its completion and returns whether it succeeded. + + + + + Fires the given git command ind the given repository directory and returns immediatly. + + + + + [omit] + + + + + [omit] + + + + + Runs git.exe with the given command in the given repository directory. + + + + + Tries to locate the git.exe via the eviroment variable "GIT". + + + + + Specifies a global timeout for git.exe - default is *no timeout* + + + + + Contains helpers which allow to interact with [git](http://git-scm.com/) via the command line. + + + + + Shows the SHA1 calculated by git. + Assumes that the CommandHelper module can find git.exe. + + + + + Calculates the SHA1 for a given string like git. + + + + + Calculates the SHA1 for a given string. + + + + + Contains functions which allow the SHA1 of a file with git and without it. + + + + + Cleans a directory by removing all files and sub-directories. + ## Parameters + + - `repositoryDir` - The path of the directory to clean. + + + + + Inits a git repository. + ## Parameters + + - `repositoryDir` - The path of the target directory. + - `bare` - If the new directory is a bare directory. + - `shared` - Specifies that the git repository is to be shared amongst several users. This allows users belonging to the same group to push into that repository. + + + + + Clones a single branch of a git repository. + ## Parameters + + - `workingDir` - The working directory. + - `repoUrl` - The URL to the origin. + - `branchname` - Specifes the target branch. + - `toPath` - Specifes the new target subfolder. + + + + + Clones a git repository. + ## Parameters + + - `workingDir` - The working directory. + - `repoUrl` - The URL to the origin. + - `toPath` - Specifes the new target subfolder. + + + + + Contains functions which allow basic operations on git repositories. + All operations assume that the CommandHelper can find git.exe. + + + + + Gets the current status. + + + + + Gets the remote path from the config. + + + + + Gets the local path from the config. + + + + + This record represents a git submodule binding. + + + + + Adds a submodule to the given super repository. + ## Parameters + + - `superRepositoryDir` - The super repository. + - `remotePath` - The path to the remote repository of the submodule. + - `localPath` - The local path to the submodule. + - `branch` - The branch to clone. (can be null) + + + + + Inits a submodule with the given name in a subfolder of the given super repository. + ## Parameters + + - `superRepositoryDir` - The super repository. + - `name` - The name of the new repository. + + + + + Gets all submodules from the given repository directory. + + + + + Contains helper functions which allow to deal with git submodules. + + + + + Pulls a given branch from the given remote. + ## Parameters + + - `repositoryDir` - The git repository. + - `remote` - The name of the remote. + - `branch` - The name of the branch to pull. + + + + + Pushes the given branch to the given remote. + ## Parameters + + - `repositoryDir` - The git repository. + - `remote` - The remote. + - `branch` - The branch. + + + + + Pushes the given tag to the given remote. + ## Parameters + + - `repositoryDir` - The git repository. + - `remote` - The remote. + - `tag` - The tag. + + + + + Pushes all branches to the default remote. + ## Parameters + + - `repositoryDir` - The git repository. + + + + + Deletes the given tag. + ## Parameters + + - `repositoryDir` - The git repository. + - `tag` - The tag which should be deleted. + + + + + Tags the current branch. + ## Parameters + + - `repositoryDir` - The git repository. + - `tag` - The new tag. + + + + + Deletes the given branch. + ## Parameters + + - `repositoryDir` - The git repository. + - `force` - Determines if git should be run with the *force* flag. + - `branch` - The branch which should be deleted. + + + + + Creates a new branch from the given commit. + ## Parameters + + - `repositoryDir` - The git repository. + - `newBranchName` - The new branch. + - `commit` - The commit which git should take as the new HEAD. - can be HEAD, HEAD~1, ... , a branch name or a prefix of a SHA1. + + + + + Performs a checkout of the given branch to the working copy. + ## Parameters + + - `repositoryDir` - The git repository. + - `create` - Set this to true if the branch is new. + - `branch` - The new branch. + + + + + Creates a new branch based on the given baseBranch and checks it out to the working copy. + ## Parameters + + - `repositoryDir` - The git repository. + - `baseBranch` - The base branch. + - `branch` - The new branch. + + + + + Performs a checkout of the given branch with an additional tracking branch. + ## Parameters + + - `repositoryDir` - The git repository. + - `trackBranch` - The tracking branch. + - `branch` - The branch for the checkout. + + + + + Performs a checkout of the given branch to the working copy. + ## Parameters + + - `repositoryDir` - The git repository. + - `branch` - The branch for the checkout. + + + + + Returns the number of revisions between the two given commits. + ## Parameters + + - `repositoryDir` - The git repository. + - `commit1` - The first commit for which git should find the merge base. + - `commit2` - The second commit for which git should find the merge base. + + + + + Returns the SHA1 of the merge base of the two given commits from the given repository. + ## Parameters + + - `repositoryDir` - The git repository. + - `commit1` - The first commit for which git should find the merge base. + - `commit2` - The second commit for which git should find the merge base. + + + + + Returns the SHA1 of the given commit from the given repository. + ## Parameters + + - `repositoryDir` - The git repository. + - `commit` - The commit for which git should return the SHA1 - can be HEAD, HEAD~1, ... , a branch name or a prefix of a SHA1. + + + + + Gets all local and remote branches from the given repository. + + + + + Gets all remote branches from the given repository. + + + + + Gets all local branches from the given repository. + + + + + Contains helper functions which allow to deal with git branches. + + + + + Performs a git reset "hard" to the current HEAD. + Resets the index and working tree. Any changes to tracked files in the working tree since <commit> are discarded. + ## Parameters + + - `repositoryDir` - The git repository. + + + + + Performs a git reset "mixed" to the current HEAD. + Resets the index but not the working tree and reports what has not been updated. + ## Parameters + + - `repositoryDir` - The git repository. + + + + + Performs a git reset "soft" to the current HEAD. + Does not touch the index file nor the working tree at all. + ## Parameters + + - `repositoryDir` - The git repository. + + + + + Performs a git reset "hard". + Resets the index and working tree. Any changes to tracked files in the working tree since <commit> are discarded. + ## Parameters + + - `repositoryDir` - The git repository. + - `commit` - The commit to which git should perform the reset. + - `file` - The file to reset - null means all files. + + + + + Performs a git reset "mixed". + Resets the index but not the working tree and reports what has not been updated. + ## Parameters + + - `repositoryDir` - The git repository. + - `commit` - The commit to which git should perform the reset. + - `file` - The file to reset - null means all files. + + + + + Performs a git reset "soft". + Does not touch the index file nor the working tree at all. + ## Parameters + + - `repositoryDir` - The git repository. + - `commit` - The commit to which git should perform the reset. + - `file` - The file to reset - null means all files. + + + + + the intent of the 'reset' helper is to either set a repo to a certain point, or set a file to a certain point. Git reset doesn't take file paths in the hard/mixed/soft modes, and so you have to use checkout instead for that. + This function encapsulates caring about that so you don't have to. + + + + + Contains helper functions which allow to deal with git reset. + + + + + Git merge option. + + + + + Performs a merge of the given branch with the current branch + ## Parameters + + - `repositoryDir` - The git repository. + - `flags` - Additional flags. + - `branch` - The branch we want to merge in. + ## Sample + + merge @"C:\code\Fake" NoFastForwardFlag "master" + + + + + Tests whether branches and their "origin" counterparts have diverged and need merging first. + ## Parameters + + - `repositoryDir` - The git repository. + - `local` - The local branch name. + - `remote` - The remote branch name. + + + + + Forbids git to use fast-forward merges + + + + + Allows git to use fast-forward merges + + + + + Gets the current merge message. + + + + + Contains helper functions which allow to deal with git merge. + + + + + Remove a single stashed state from the stash list and + apply it on top of the current working tree state, + i.e., do the inverse operation of git stash save. + The working directory must match the index. + + + + + Stash the changes in a dirty working directory away. + + + + + Contains helper functions which allow to deal with git stash. + + + + + Checks if the given branch is a remote branch. + + + + + Checks if the given branch is a local branch. + + + + + Checks if the given branch is absent. + + + + + Checks if the given branch exists. + + + + + Checks if the given branch exists. + + + + + Contains helper function which can be used for sanity checks. + + + + + Gets the current hash of the current repository + + + + + Gets the last git tag of the current repository by calling git describe + + + + + Gets the git log in one line + + + + + Gets the last git tag by calling git describe + + + + + Returns true if rev1 is ahead of rev2 + + + + + Returns a friendly name from a SHA1 + + + + + Checks if the working copy is clean + + + + + Shows the git status + + + + + Returns the SHA1 of the current HEAD + + + + + Gets the git branch name + + + + + [omit] + + + + + Gets the git version + + + + + Contains helper functions which can be used to retrieve status information from git. + + + + + A type which represents a file status in git. + + + + + Cleans the working copy by doing a git reset --hard and a clean -f. + + + + + Returns true if the given repository is in the middle of a patch process. + + + + + Returns true if the given repository is in the middle of a rebase process. + + + + + Returns the current rebase directory for the given repository. + + + + + Returns true if the working copy is in a conflicted merge otherwise false + + + + + Gets all conflicted files + + + + + Gets the changed files since the given revision incl. changes in the working copy + + + + + Gets all changed files in the current revision + + + + + Gets the changed files between the given revisions + + + + + Contains helper functions which can be used to retrieve file status information from git. + + + + + Tries to rebase on top of the given branch. + If the rebasing process fails a normal merge will be started. + Returns if the process used merge instead of rebase. + + + + + rebase failed ==> fallback on merge + [omit] + + + + + Restart the rebasing process by skipping the current patch. + + + + + Restart the rebasing process after having resolved a merge conflict. + + + + + Restore the original branch and abort the rebase operation. + + + + + Performs a rebase on top of the given branch with the current branch + + + + + Contains helper functions which allow to deal with git rebase. + + + + + Sets the commit message + + + + + Gets the commit message + + + + + Returns the commit message file. + + + + + Contains helper functions which allow to get and set the git commit message. + + + + + Adds all files to the staging area + + + + + Adds a file to the staging area + + + + + Contains helper functions which allow to deal with git's staging area. + + + + + Commits all files in the given repository with the given short message along with an extended message + + + + + Commits all files in the given repository with the given message + + + + + Contains helper functions which allow to commit to git repositories. + + + + + Runs [GitVersion](https://gitversion.readthedocs.io/en/latest/) on a .NET project file. + ## Parameters + + - `setParams` - Function used to manipulate the gitversionDefaults value. + + ## Sample + + generateProperties id // Use Defaults + generateProperties (fun p -> { p with ToolPath = "/path/to/directory" } + + + + + Option type for selecting one command + + + + + Common parameters + + + + + if the package already exists, should this package overwrite it? + + + + + Common parameters + + + + + If specified, only releases + associated with the channel will be deleted; + specify this argument multiple times to target + multiple channels + + + + + Maximum (inclusive) version number for the range of versions to delete + + + + + Minimum (inclusive) version number for the range of versions to delete + + + + + Name of the project + + + + + Options for deleting a range of releases in a project + + + + + Common parameters + + + + + Channel to use for the new release + + + + + A comma-separated list of machine names to target in the + deployed environment. If not specified, all machines in + the environment will be considered. + + + + + Specifies how much time should elapse between deployment status + checks (default: 10 seconds) + + + + + Specifies maximum time that deployment can take + (default: 10 minutes) + + + + + Show progress of the deployment. + (Sets --waitfordeployment and --norawlog to true.) + + + + + Don't print the raw log of failed tasks + + + + + Whether to wait synchronously for deployment to finish + + + + + If a project is configured to skip packages with already-installed + versions, override this setting to force re-deployment + + + + + Version number of the release to deploy; Specify "latest" for + the latest release + + + + + Environment to deploy to + + + + + Name of the project + + + + + Options for deploying a release to an environment + + + + +common parameters + + + + + Ignore package version matching rules + + + + + Channel to use for the new release + + + + + If a release with the version number already exists, ignore it + + + + + Path to a file that contains Release Notes for the new release + + + + + Release Notes for the new release + + + + + A folder containing NuGet packages from which we should get versions + + + + + Version number to use for a package in the release + + + + + Default version of all packages to use for this release + + + + + Release number to use for the new release + + + + + Name of the project + + + + + Options for creating a new release + + + + + Common Octo.exe CLI params + + + + + Your API key; retrieved from the user profile page. + + + + + The base URL for your Octopus server + + + + + Octo.exe server options + + + + + Pushes one or more packages to the Octopus built-in repository. + + + + + Lists all environments. + + + + + Deletes a range of releases. + + + + + Deploys releases that have already been created. + + + + + Creates a release, and optionally deploys it to one or more environments. + + + + + Creates a release. + + + + + Maps a command to string input for the octopus tools cli. + + + + + Default options for 'Push' + + + + + Default options for 'DeleteReleases' + + + + + Default options for 'DeployRelease' + + + + + Default options for 'CreateRelease' + + + + + Default parameters to call octo.exe. + + + + + Default server options. + + + + + The output path for the .cspkg. + + + + + The SDK version to use e.g. 2.2. If None, the latest available version is used. + + + + + The name of the role in the service. + + + + + The name of the Cloud Service. + + + + + Configuration details for packaging cloud services. + + + + + Packages a cloud service role into a .cspkg, ready for deployment. + + + + + Modifies the size of the Worker Role in the csdef. + + + + + Contains tasks to package Azure Cloud Services. + + **Note: This documentation is for FAKE version 5.0 or later. The old documentation can be found [here](/legacy-azurecloudservices.html)** + + + + + A type for the controlling parameter + + + + + Resets the devstore (BLOB, Queues and Tables) + + + + + Starts the compute emulator + + + + + Stops the compute emulator + + + + + Starts the storage emulator + + + + + Stops the storage emulator + + + + + The default parameters for Azure emulators + + + + + Base path for getting tools from Microsoft SDKs + + + + + Contains tasks to control the local Azure Emulator + + + + + The path to the zip archive to upload + + + + + The WebDeploy or Git Password + + + + + The WebDeploy or Git username, usually the $username from the site's publish profile + + + + + The url of the website, usually in the format of https://<yourwebsite>.scm.azurewebsites.net + + + + + Kudu ZipDeploy parameters + + + + + The different types of web jobs. + + + + + Synchronizes contents of the zip package with the target web app using Kudu ZipDeploy. + See https://blogs.msdn.microsoft.com/appserviceteam/2017/10/16/zip-push-deployment-for-web-apps-functions-and-webjobs/ + + + + + Synchronises all staged files from the temporary deployment to the actual deployment, removing + any obsolete files, updating changed files and adding new files. + + + + + Stages a set of files into a WebJob folder in the temp deployment area, ready for deployment into the website as a webjob. + + + + + Gets the path for deploying a web job to. + + + + + Stages a folder and all subdirectories into the temp deployment area, ready for deployment into the website. + + The source folder to copy. + A predicate which includes files from the folder. If the entire directory should be copied, this predicate should always return true. + + + + The path to the KuduSync application. + + + + + Used by KuduSync for tracking and diffing deployments. + + + + + Used by KuduSync for tracking and diffing deployments. + + + + + Location where synced outputs should be deployed to. + + + + + Location where staged outputs should go before synced up to the site. + + + + + Contains tasks to stage and deploy Azure website and webjobs using source code deployment with Kudu Sync. + + + + + The webjobs to deploy to this web site + + + + + The FTP Password + + + + + The FTP username, usually the $username from the site's publish profile + + + + + The url of the website, usually in the format of https://<yourwebsite>.scm.azurewebsites.net + + + + + The website that webjobs are deployed to + + + + + The package path to once zipped + + + + + The directory path of the webjob to zip + + + + + The project to be zipped and deployed as a webjob + + + + + Specifies what type of webjob this is. Note that this also determines it's deployment location on Azure + + + + + The name of the web job, this will also be the name out of zip file. + + + + + WebJob type + + + + + The running modes of webjobs + + + + + This task to can be used deploy a prebuilt webjob zip to a website + ## Parameters + + - `webSites` - The websites and webjobs to deploy. + + + + + This task to can be used create a zip for each webjob to deploy to a website + The output structure is: `outputpath/{websitename}/webjobs/{continuous/triggered}/{webjobname}.zip` + ## Parameters + + - `webSites` - The websites and webjobs to build zips from. + + + + + Contains tasks to package and deploy [Azure Web Jobs](http://azure.microsoft.com/en-gb/documentation/articles/web-sites-create-web-jobs/) via the [Kudu](https://github.com/projectkudu/kudu) Zip controller + + **Note: This documentation is for FAKE version 5.0 or later. The old documentation can be found [here](/legacy-azurewebjobs.html)** + + + + + The trace mode option. + + + + + The server type option. + + + + + Writes the given message to the Console. + + + + + Implements a TraceListener for System.Console. + ## Parameters + - `importantMessagesToStdErr` - Defines whether to trace important messages to StdErr. + - `colorMap` - A function which maps TracePriorities to ConsoleColors. + + + + + Defines a TraceListener interface + Note: Please contribute implementations to the fake repository, as external implementations are not supported. + + + + + Happens when a tag (Task, Target, Test, ...) has started. + + + + + Defines Tracing information for TraceListeners + Note: Adding new cases to this type is not considered a breaking change! + Please consider not using a match on this type in code external to the fake repository. + + + + + Note: Adding new cases to this type is not considered a breaking change! + Please consider not using a match on this type in code external to the fake repository. + + + + + Note: Adding new cases to this type is not considered a breaking change! + Please consider not using a match on this type in code external to the fake repository. + + + + + Note: Adding new cases to this type is not considered a breaking change! + Please consider not using a match on this type in code external to the fake repository. + + + + + Note: Adding new cases to this type is not considered a breaking change! + Please consider not using a match on this type in code external to the fake repository. + + + + + Note: Adding new cases to this type is not considered a breaking change! + Please consider not using a match on this type in code external to the fake repository. + + + + + Note: Adding new cases to this type is not considered a breaking change! + Please consider not using a match on this type in code external to the fake repository. + + + + + The optional build no. + + + + + The optional PreRelease version + + + + + PATCH version when you make backwards-compatible bug fixes. + + + + + MINOR version when you add functionality in a backwards-compatible manner. + + + + + MAJOR version when you make incompatible API changes. + + + + + Contains the version information. For parsing use [SemVer.parse](fake-core-semver.html) + + > Note: If you use `{ version with Patch = myPath; Original = None }` to overwrite some parts of this string make sure to overwrite `Original` to `None` in order to recalculate the version string. + + > Note: For overwriting the `PreRelease` part use: `{ Version with Original = None; PreRelease = PreRelease.TryParse "alpha.1" }` + + + + + Information about PreRelease packages. + + + + + This is the reverse of https://msdn.microsoft.com/en-us/library/17w5ykft.aspx + + + + + Create a new command line string which can be used in a ProcessStartInfo object. + If given, returns the exact input of `OfWindowsCommandLine` otherwise `ToWindowsCommandLine` (with some special code for `mono`) is used. + + + + + Escape the given argument list according to a unix shell (bash) + + + + + See https://msdn.microsoft.com/en-us/library/17w5ykft.aspx + + + + + Create a new arguments object from a given startinfo-conforming-escaped command line string. + Same as `OfWindowsCommandLine`. + + + + + Create a new arguments object from the given list of arguments + + + + + Represents a list of arguments + + + + + A raw (untyped) way to start a process + + + + + Retrieve the raw pipe from the process (the StreamRef is set with a stream you can write into for 'stdin' and read from for 'stdout' and 'stderr') + + + + + Redirect to the given stream (the stream must be provided by the user and be writeable for 'stdout' & 'stderr' and readable for 'stdin') + + + + + Do not redirect, or use normal process inheritance + + + + + Various options to redirect streams. + + + + + Represents basically an "out" parameter, allows to retrieve a value after a certain point in time. + Used to retrieve "pipes" + + + + + Windows: https://msdn.microsoft.com/en-us/library/windows/desktop/bb776391(v=vs.85).aspx + Linux(mono): https://github.com/mono/mono/blob/0bcbe39b148bb498742fc68416f8293ccd350fb6/eglib/src/gshell.c#L32-L104 (because we need to create a commandline string internally which need to go through that code) + Linux(netcore): See https://github.com/fsharp/FAKE/pull/1281/commits/285e585ec459ac7b89ca4897d1323c5a5b7e4558 and https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.Process/src/System/Diagnostics/Process.Unix.cs#L443-L522 + + + + + The type of command to execute + + + + + Handle for creating a process and returning potential results. + + + + + The output of the process. If ordering between stdout and stderr is important you need to use streams. + + + + + Hook for events when an CreateProcess is executed. + + + + + Runs the given process, waits for it's completion and returns the exit code. + ## Parameters + + - `cmd` - The command which should be run in elavated context. + - `args` - The process arguments (optional). + - `directory` - The working directory (optional). + + + + + Runs the given process asynchronously. + ## Parameters + + - `cmd` - The command which should be run in elavated context. + - `args` - The process arguments (optional). + - `directory` - The working directory (optional). + + + + + Allows to exec shell operations synchronously and asynchronously. + + + + + Command-line argument pairs. The value will be quoted if it contains + a string, and the result will be appended to the CommandLine property. + If the key ends in a letter or number, a space will be inserted between + the key and the value. + + + + + Command-line parameters in a string. + + + + + The working directory for the program. Defaults to "". + + + + + The path to the executable, without arguments. + + + + + Default parameters for process execution. + + + + + Parameter type for process execution. + + + + + When UseShellExecute is true, the fully qualified name of the directory that contains the process to be started. When the UseShellExecute property is false, the working directory for the process to be started. The default is an empty string (""). + + + + + The action to take with the file that the process opens. The default is an empty string (""), which signifies no action. + + + + + true if the shell should be used when starting the process; false if the process should be created directly from the executable file. The default is true. + + + + + The user name to use when starting the process. If you use the UPN format, user@DNS_domain_name, the Domain property must be null. + + + + + An object that represents the preferred encoding for standard output. The default is null. + + + + + An object that represents the preferred encoding for error output. The default is null. + + + + + true if output should be written to Process.StandardOutput; otherwise, false. The default is false. + + + + + true if input should be read from Process.StandardInput; otherwise, false. The default is false. + + + + + true if error output should be written to Process.StandardError; otherwise, false. The default is false. + + + + + One of the enumeration values that indicates whether the process is started in a window that is maximized, minimized, normal (neither maximized nor minimized), or not visible. The default is Normal. + + + + + Gets or sets the user password in clear text to use when starting the process. + + + + + true if the Windows user profile should be loaded; otherwise, false. The default is false. + + + + + Gets or sets the application or document to start. + + + + + Gets or sets the window handle to use when an error dialog box is shown for a process that cannot be started. + + + + + Gets or sets a value indicating whether an error dialog box is displayed to the user if the process cannot be started. + + + + + Gets the environment variables that apply to this process and its child processes. + NOTE: Recommendation is to not use this Field, but instead use the helper function in the Proc module (for example Process.setEnvironmentVariable) + NOTE: This field is ignored when UseShellExecute is true. + + + + + Gets or sets a value that identifies the domain to use when starting the process. If this value is null, the UserName property must be specified in UPN format. + + + + + Gets or sets a value indicating whether to start the process in a new window. + + + + + Gets or sets the set of command-line arguments to use when starting the application. + + + + + Sets the current environment variables. + + + + + A process result including error code, message log and errors. + + + + + A record type which captures console messages + + + + + Exception for request errors + + + + + [omit] + + + + + [omit] + + + + + This module tracks the context of the build. + This allows us to run some modules without any context and change behavior depending on the context + (For example `Fake.Process` kills all processes when the Fake Context exists, but it should not when used as library) + + + + + Define a named FakeVar providing the get, remove and set + Will always return 'None' when no context is set and 'throw' on set + + + + + Define a named FakeVar providing the get, remove and set + Will use a local variable if there is no context + + + + + Define a named FakeVar providing the get, remove and set + And of the functions will fail if there is no context + + + + + Sets value of a FakeVar + + + + + Sets value of a FakeVar + + + + + Removes a FakeVar by name + + + + + Removes a FakeVar by name + + + + + Gets a strongly typed FakeVar by name will return default value if variable is not found + + + + + Gets a strongly typed FakeVar by name will fail if variable is not found + + + + + Gets a strongly typed FakeVar by name returning an option type + + + + + This module contains helpers for managing build time variables + + + + + matches the stdin [-] + + + + + Marks that the given item can be given multiple times + + + + + Fixed command, like "push" in "git push" + + + + + Sequence of items, if the items are only options then order is ignored. + + + + + Either the one or the other + + + + + Named/Positional argument + + + + + Requires the given item + + + + + Marks the given item as optional + + + + + long option + + + + + Short options + + + + + Matches an option annotation [options] + + + + + matches nothing? + + + + + The lines in reversed order + + + + + A record which allows to display lots of machine specific information like machine name, processor count etc. + + + + + Type alias for System.EnvironmentVariableTarget + + + + + Retrieves lots of machine specific information like machine name, processor count etc. + + + + + Retrieves information about the hard drives + + + + + Returns a sequence with all installed .NET framework versions + + + + + Contains the IO encoding which is given via build parameter "encoding" or the default encoding if no encoding was specified. + + + + + Gets the local directory for the given target platform + + + + + Helper function to help find framework or sdk tools from the + newest toolkit available + + + + + Base path for getting tools from windows SDKs + + + + + The path of the current target platform + + + + + Gets the list of valid directories included in the PATH environment variable. + + + + + required sometimes to workaround mono crashes + http://stackoverflow.com/a/8414517/1269722 + Note: Only given when we are running on mono, + represents the version of the mono runtime we + are currently running on. + In netcore world you can retrieve the mono version in the + environment (PATH) via Fake.Core.Process.Mono.monoVersion + + + + + Determines if the current FAKE runner is being run via mono. With the FAKE 5 runner, this will always be false + Todo: Detect mono on windows + + + + + Determines if the current system is a Windows system + + + + + Determines if the current system is a Linux system + + + + + Determines if the current system is a MacOs system + + + + + Determines if the current system is an Unix system. + See http://www.mono-project.com/docs/faq/technical/#how-to-detect-the-execution-platform + + + + + The system root environment variable. Typically "C:\Windows" + + + + + The path of Program Files (x86) + It seems this covers all cases where PROCESSOR\_ARCHITECTURE may misreport and the case where the other variable + PROCESSOR\_ARCHITEW6432 can be null + + + + + The path of the "Program Files" folder - might be x64 on x64 machine + + + + + Returns the value of the build parameter with the given name if it was set and otherwise an empty string + + + + + Returns the value of the build parameter with the given name if it was set and otherwise the given default value + + + + + Returns if the build parameter with the given name was set + + + + + Returns if the build parameter with the given name was set + + + + + Splits the entries of an environment variable and removes the empty ones. + + + + + Retrieves the environment variable or None + + + + + Retrieves the environment variable with the given name or returns the false if no value was set + + + + + Retrieves the environment variable with the given name or returns the default bool if no value was set + + + + + Retrieves the environment variable with the given name or fails if not found + + + + + Retrieves the environment variable with the given name or returns the default if no value was set + + + + + Sets the build parameter with the given name for the current process. + + + + + Clears the environment variable with the given name for the current process. + + + + + Sets the environment variable with the given name + + + + + Retrieves all environment variables from the given target + + + + + Retrieves the environment variable with the given name + + + + + Internal, do not use. + We use this internally for parsing the output of mono --version + + + + + Is true when the current build is a local build. + + + + + The current build version as detected from the current build server. + + + + + The current build server + + + + + AppVeyor build number + [omit] + + + + + CruiseControl.NET Build label + [omit] + + + + + Build number retrieved from Jenkins + [omit] + + + + + Build number retrieved from GitLab CI + [omit] + + + + + Checks if we are on GitLab CI + [omit] + + + + + Build number retrieved from Travis + [omit] + + + + + Build number retrieved from TeamCity + [omit] + + + + + Build number retrieved from Team Foundation + [omit] + + + + + Checks if we are on Team Foundation + [omit] + + + + + Checks if we are on Bamboo + [omit] + + + + + Build number retrieved from Bamboo + [omit] + + + + + Defines the XML output file - used for build servers like CruiseControl.NET. + This output file can be specified by using the *logfile* build parameter. + + + + + A constant label for local builds + [omit] + + + + + Defines if FAKE will use verbose tracing. + This flag can be specified by setting the *verbose* build parameter. + + + + + Decodes a Base64-encoded UTF-8-encoded string + + + + + Encapsulates the Apostrophe + + + + + Removes linebreaks from the given string + + + + + Reads a file line by line and replaces all line breaks to windows line breaks + - uses a temp file to store the contents in order to prevent OutOfMemory exceptions + + + + + Converts all line breaks in a text to windows line breaks + + + + + Represents Mac line breaks + + + + + Represents Windows line breaks + + + + + Represents Linux line breaks + + + + + Removes all trailing .0 from a version string + + + + + Lifts a string to an option + + + + + Trims the end of the given string + + + + + Trims the start of the given string + + + + + Trims the given string + + + + + Trims the given string + + + + + Trims all special characters from a string. + + + + + Trims the given string with the DirectorySeparatorChar + + + + + Checks whether the given char is a standard char or digit. + + + + + Returns all standard chars and digits. + + + + + Converts all characters in a string to lower case. + + + + + Checks whether the given char is a german umlaut. + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + Replaces the first occurrence of the pattern with the given replacement. + + + + + Determines whether the last character of the given <see cref="string" /> + matches Path.DirectorySeparatorChar. + + + + + Checks whether the given text ends with the given suffix + + + + + Checks whether the given text starts with the given prefix + + + + + Converts a sequence of strings into a string separated with line ends + + + + + Splits the given string at the given string delimiter + + + + + Splits the given string at the given char delimiter + + + + + Removes the slashes from the end of the given string + + + + + Converts a sequence of strings to a string with delimiters + + + + + Replaces the given pattern in the given text with the replacement + + + + + Returns if the string is null or empty or completely whitespace + + + + + Returns if the string is not null or empty + + + + + Returns if the string is null or empty + + + + + [omit] + + + + + Determines if a text matches a given regex pattern. + + + + + Find a regex pattern in a text and replaces it with the given replacement. + + + + + Checks whether the given text starts with the given prefix + + + + + Contains basic functions for string manipulation. + + + + + Returns the text from the StringBuilder + + + + + Applies action on builder for each element of list. + + + + + Appends all notnull fileNames. + + + + + Appends a text if the value is not null or empty. + + + + + Appends a text if the value is not null or empty. + + + + + Appends a text if the value is not null. + + + + + Appends a quoted text if the value is not null. + + + + + Appends a text if the value is not null. + + + + + Appends a text without quoting if the value is not null. + + + + + Appends a text if the predicate is false. + + + + + Appends a text if the predicate is true. + + + + + Appends string of function value if option has some value + + + + + Appends a text to a StringBuilder without surrounding quotes. + + + + + Appends a text to a StringBuilder. + + + + + Allows to post messages to all trace listeners + + + + + A List with all registered listeners + + + + + The default TraceListener for Console. + + + + + A default color map which maps TracePriorities to ConsoleColors + + + + + Logs the given files with the message. + + + + + Traces the message to the console + + + + + Allows automatic or manual tracing around a function being run + If in automatic success mode and no exception is thrown then trace is marked as success + Any exception thrown will result in a mark failed and exception re-thrown + + + + + Wrap functions in a 'use' of this function + + + + + Traces the end of a task + + + + + Traces the end of a task + + + + + Traces the end of a task + + + + + Traces the begin of a task + + + + + Traces the begin of a task + + + + + Traces the end of a target + + + + + Traces the end of a target + + + + + Traces the end of a failure target + + + + + Traces the end of a final target + + + + + Traces the end of a target + + + + + Traces the begin of a target + + + + + Traces the begin of a failure target + + + + + Traces the begin of a final target + + + + + Traces the begin of a target + + + + + Removes an opening tag from the internal tag stack + + + + + Removes an opening tag from the internal tag stack + + + + + Puts an opening tag on the internal tag stack + + + + + Puts an opening tag on the internal tag stack + + + + + Traces a header + + + + + Traces a line + + + + + Traces the EnvironmentVariables + + + + + Traces an exception details (in red) + + + + + Converts an exception and its inner exceptions to a nice string. + + + + + Writes an error message to stderr (in red) + + + + + Traces an error (in red) + + + + + Writes a trace to the command line (in yellow) + + + + + Writes a message to stderr (in yellow) + + + + + Writes a trace to stderr (in yellow) + + + + + Writes a trace to the command line (in green) if the verbose mode is activated. + + + + + Writes a message to the command line (in green) and without a line break + + + + + Writes a message to the command line (in green) + + + + + Writes a trace to the command line (in green) + + + + + Logs the specified string if the verbose mode is activated. + + + + + Logs the specified message (without line break) + + + + + Logs the specified message + + + + + Logs the specified string + + + + + This module contains function which allow to trace build output + + + + + Parses the given version string into a SemVerInfo which can be printed using ToString() or compared + according to the rules described in the [SemVer docs](http://semver.org/). + ## Sample + + parse "1.0.0-rc.1" < parse "1.0.0" // true + parse "1.2.3-alpha" > parse "1.2.2" // true + parse "1.2.3-alpha2" > parse "1.2.3-alpha" // true + parse "1.2.3-alpha002" > parse "1.2.3-alpha1" // false + parse "1.5.0-beta.2" > parse "1.5.0-rc.1" // false + + + + + Splits the given version string by possible delimiters but keeps them as parts of resulting list. + + + + + Matches if str is convertible to big int and not less than zero, and returns the bigint value. + + + + + Matches if str is convertible to Int and not less than zero, and returns the value as UInt. + + + + + Returns true if input appears to be a parsable semver string + + + + + Parser which allows to deal with [Semantic Versioning](http://semver.org/) (SemVer). + Make sure to read the documentation in the [SemVerInfo](fake-core-semverinfo.html) record as well if you manually create versions. + + + + + Contains active patterns which allow to deal with [Semantic Versioning](http://semver.org/) (SemVer). + + + + + Release date + + + + + Semantic version + + + + + The nuget package version. + + + + + The parsed version. + + + + + Contains the parsed information of the release notes text file. + + + + + Parses a Release Notes text file and returns the lastest release notes. + + ## Parameters + - `fileName` - Release notes text file name + + + + + Parses a Release Notes text and returns the lastest release notes. + + ## Parameters + - `data` - Release notes text + + + + + Parses a Release Notes text and returns all release notes. + + ## Parameters + - `data` - Release notes text + + + + + Parse "complex" release notes text sequence + + + + + Parse simple release notes sequence + + + + + Contains helpers which allow to parse Release Notes text files. Either "simple" or "complex" format is accepted. + + ## Formats + + ### Simple format + + * 1.1.10 - Support for heterogeneous XML attributes. Make CsvFile re-entrant. + * 1.1.9 - Infer booleans for ints that only manifest 0 and 1. + + ### Complex format + + ### New in 1.1.10 (Released 2013/09/12) + * Support for heterogeneous XML attributes. + * Make CsvFile re-entrant. + * Support for compressed HTTP responses. + * Fix JSON conversion of 0 and 1 to booleans. + + ### New in 1.1.9 (Released 2013/07/21) + * Infer booleans for ints that only manifest 0 and 1. + * Support for partially overriding the Schema in CsvProvider. + * PreferOptionals and SafeMode parameters for CsvProvider. + + ## Sample + + let release = + ReadFile "RELEASE_NOTES.md" + |> ReleaseNotesHelper.parseReleaseNotes + + + Target "AssemblyInfo" (fun _ -> + CreateFSharpAssemblyInfo "src/Common/AssemblyInfo.fs" + [ Attribute.Title project + Attribute.Product project + Attribute.Description summary + Attribute.Version release.AssemblyVersion + Attribute.FileVersion release.AssemblyVersion] + ) + + + + + The change log entries + + + + + The Unreleased section + + + + + The description + + + + + the header line + + + + + the latest change log entry + + + + + True, if the entry was yanked + + + + + The parsed list of changes + + + + + a descriptive text (after the header) + + + + + Release DateTime + + + + + Semantic version + + + + + the NuGet package version + + + + + the parsed Version + + + + + Custom entry (Header, Description) + + + + + to invite users to upgrade in case of vulnerabilities + + + + + for any bug fixes + + + + + for deprecated features removed in this release + + + + + for once-stable features removed in upcoming releases + + + + + for changes in existing functionality + + + + + for new features + + + + + Promotes the `Unreleased` section of a changelog + to a new changelog entry with the given version + + ## Parameters + - `version` - The version (in NuGet-Version format, e.g. `3.13.4-alpha1.212` + - `changelog` - The changelog to promote + + ## Returns + The promoted changelog + + + + + Saves a Changelog to a text file. + + ## Parameters + - `filename` - Changelog text file name + - `changelog` - the changelog data + + + + + Parses a Changelog text file and returns the lastest changelog. + + ## Parameters + - `filename` - Changelog text file name + + ## Returns + The loaded changelog (or throws an exception, if the changelog could not be parsed) + + + + + Parses a change log text and returns the change log. + + ## Parameters + - `data` - change log text + + + + + Contains helpers which allow to parse Change log text files. + These files have to be in a format as described on http://keepachangelog.com/en/0.1.0/ + + ## Sample + + let changelogFile = "CHANGELOG.md" + let newVersion = "1.0.0" + + Target.create "AssemblyInfo" (fun _ -> + let changelog = changeLogFile |> Changelog.load + CreateFSharpAssemblyInfo "src/Common/AssemblyInfo.fs" + [ Attribute.Title project + Attribute.Product project + Attribute.Description summary + Attribute.Version changelog.LatestEntry.AssemblyVersion + Attribute.FileVersion changelog.LatestEntry.AssemblyVersion] + ) + + Target.create "Promote Unreleased to new version" (fun _ -> + let newChangelog = + changelogFile + |> ChangeLog.load + |> ChangeLog.promoteUnreleased newVersion + |> ChangeLog.save changelogFile + ) + + + + + Behaves like AwaitObservable, but calls the specified guarding function + after a subscriber is registered with the observable. + + + + + Helper that can be used for writing CPS-style code that resumes + on the same thread where the operation was started. + + + + + Executes f just after adding the event-handler + + + + + An extension method that overloads the standard 'Bind' of the 'async' builder. The new overload awaits on + a standard .NET task which does not commpute a value + + + + + An extension method that overloads the standard 'Bind' of the 'async' builder. The new overload awaits on + a standard .NET task + + + + + Like StartAsTask but gives the computation time to so some regular cancellation work + + + + + Create a arguments instance from a list. + + + + + Convert the arguments instance to a string array + + + + + Convert the arguments instance to a string list + + + + + Append an argument prefixed by another if the value is not null or empty + + + + + Append an argument to a command line if a condition is true. + + + + + Append an argument prefixed by another if the value is Some. + + + + + Append all arguments after the current arguments + + + + + Append the given arguments before all current arguments + + + + + Create a new command line string which can be used in a ProcessStartInfo object. + If given, returns the exact input of `OfWindowsCommandLine` otherwise `ToWindowsCommandLine` (with some special code for `mono`) is used. + + + + + Escape the given argument list according to a unix shell (bash) + + + + + This is the reverse of https://msdn.microsoft.com/en-us/library/17w5ykft.aspx + + + + + Module for working with an `Arguments` instance + + + + + Read a windows command line string into its arguments + + + + + Escape the given argument list according to a unix shell (bash) + + + + + Convert the given argument list to a conforming windows command line string, escapes parameter in quotes if needed (currently always but this might change). + + + + + Helper functions for proper command line parsing + + + + + Tries to find the tool via AppSettings. If no path has the right tool we are trying the PATH system variable. + [omit] + + + + + Tries to find the tool via AppSettings. If no path has the right tool we are trying the PATH system variable. + [omit] + + + + + Tries to find the tool via Env-Var. If no path has the right tool we are trying the PATH system variable. + + + + + Searches the current directory and the directories within the PATH + environment variable for the given file. If successful returns the full + path to the file. + ## Parameters + - `file` - The file to locate + + + + + Searches in PATH for the given file and returnes the result ordered by precendence + + + + + Searches the given directories for the given file, failing if not found. + [omit] + + + + + Searches the given directories for all occurrences of the given file name + [omit] + + + + + Searches the given directories for all occurrences of the given file name, on windows PATHEXT is considered (and preferred when searching) + + + + + Searches the given directories for all occurrences of the given file name + [omit] + + + + + Duplicates the given stream, which means returning two stream instances + which will read the same data. + At the same time buffers all data (ie read from s as fast as possible). + Any data written to the returned instances will be written to the given instance. + + + + + Set the given timeout + + + + + Like`ensureExitCode` but only triggers a warning instead of failing. + + + + + Makes sure the exit code is `0`, otherwise a detailed exception is thrown (showing the command line). + + + + + throws an exception with the given message if `exitCode <> 0` + + + + + Execute the given function after the process has been exited and the previous result has been calculated. + + + + + Like `withOutputEvents` but skips `null` objects. + + + + + Calls the given functions whenever a new output-line is received. + + + + + Starts redirecting the output streams and collects all data at the end. + + + + + Map only the result object and leave the exit code in the result type. + + + + + Map the current result to a new type. + + + + + Set the standard input stream. + + + + + Set the standard error stream. + + + + + Set the standard output stream. + + + + + Set the given environment variable. + + + + + Retrieve the current environment map. + + + + + Sets the given environment map. + + + + + Sets the given environment variables + + + + + Execute the given function right after the process is started. + + + + + Execute the given function when the process is cleaned up. + + + + + Execute the given function before the process is started + + + + + Attaches the given functions to the current CreateProcess instance. + + + + + Map the file-path according to the given function. + + + + + Replace the file-path + + + + + Set the command to the given one. + + + + + Disable the default trace of started processes. + + + + + Set the working directory of the new process. + + + + + Copies std-out and std-err into the corresponding `System.Console` streams (by using interceptStream). + + + + + intercept the given StreamSpecification and writes the intercepted data into target. + Throws if the stream is not redirected (ie is Inherit). + + + + + Create a CreateProcess from the given `ProcessStartInfo` + + + + + Create a CreateProcess from the given file and arguments + + ### Example + + CreateProcess.fromRawCommand "cmd" [ "/C"; "echo test" ] + |> Proc.run + |> ignore + + + + + Create a CreateProcess from the given file and arguments + + + + + Create a CreateProcess from the given file and arguments + + ### Example + + CreateProcess.fromRawCommandLine "cmd" "/C \"echo test\"" + |> Proc.run + |> ignore + + ### Using BlackFox.CommandLine + + See [`BlackFox.CommandLine`](https://github.com/vbfox/FoxSharp/tree/master/src/BlackFox.CommandLine) for details + + open BlackFox.CommandLine + + CmdLine.empty + |> CmdLine.append "build" + |> CmdLine.appendIf noRestore "--no-restore" + |> CmdLine.appendPrefixIfSome "--framework" framework + |> CmdLine.appendPrefixf "--configuration" "%A" configuration + |> CmdLine.toString + |> CreateProcess.fromRawCommandLine "dotnet.exe" + |> Proc.run + |> ignore + + + + + + Create a simple `CreateProcess<_>` instance from the given command. + + ### Example + + Command.RawCommand("file", Arguments.OfArgs ["arg1"; "arg2"]) + |> CreateProcess.fromCommand + |> Proc.run + |> ignore + + + + + Module for creating and modifying CreateProcess<'TRes> instances. + You can manage: + + - The command (ie file to execute and arguments) + - The working directory + - The process environment + - Stream redirection and pipes + - Timeout for the process to exit + - The result and the result transformations (`map`, `mapResult`) + + More extensions can be found in the [CreateProcess Extensions](apidocs/v5/fake-core-createprocessext-createprocess.html) + + ### Example + + Command.RawCommand("file", Arguments.OfArgs ["arg1"; "arg2"]) + |> CreateProcess.fromCommand + |> Proc.run + |> ignore + + + + + + Like `start` but waits for the result synchronously. + + + + + Convenience method when you immediatly want to await the result of 'start', just note that + when used incorrectly this might lead to race conditions + (ie if you use StartAsTask and access reference cells in CreateProcess after that returns) + + + + + Starts the given process and waits for the `Result` task. (see `startRaw` documentation). + In most common scenarios the `Result` includes the `Raw` task or the exit-code one way or another. + + + + + Similar to `startRaw` but waits until the process has been started. + + + + + Starts a process. The process has been started successfully after the returned task has been completed. + After the task has been completed you retrieve two other tasks: + - One `Raw`-Task to indicate when the process exited (and return the exit-code for example) + - One `Result`-Task for the final result object. + + Note: The `Result` task might finish while the `Raw` task is still running, + this enables you to work with the result object before the process has exited. + For example consider a long running process where you are only interested in the first couple of output lines + + + + + Module to start or run processes, used in combination with the `CreateProcess` API. + + ### Example + + #r "paket: + nuget Fake.Core.Process //" + open Fake.Core + CreateProcess.fromRawCommand "./folder/mytool.exe" ["arg1"; "arg2"] + |> Proc.run + |> ignore + + + + + + When UseShellExecute is true, the fully qualified name of the directory that contains the process to be started. When the UseShellExecute property is false, the working directory for the process to be started. The default is an empty string (""). + + + + + The action to take with the file that the process opens. The default is an empty string (""), which signifies no action. + + + + + true if the shell should be used when starting the process; false if the process should be created directly from the executable file. The default is true. + + + + + The user name to use when starting the process. If you use the UPN format, user@DNS_domain_name, the Domain property must be null. + + + + + An object that represents the preferred encoding for standard output. The default is null. + + + + + An object that represents the preferred encoding for error output. The default is null. + + + + + true if output should be written to Process.StandardOutput; otherwise, false. The default is false. + + + + + true if input should be read from Process.StandardInput; otherwise, false. The default is false. + + + + + true if error output should be written to Process.StandardError; otherwise, false. The default is false. + + + + + One of the enumeration values that indicates whether the process is started in a window that is maximized, minimized, normal (neither maximized nor minimized), or not visible. The default is Normal. + + + + + Gets or sets the user password in clear text to use when starting the process. + + + + + true if the Windows user profile should be loaded; otherwise, false. The default is false. + + + + + Gets or sets the application or document to start. + + + + + Gets or sets the window handle to use when an error dialog box is shown for a process that cannot be started. + + + + + Gets or sets a value indicating whether an error dialog box is displayed to the user if the process cannot be started. + + + + + Sets the current environment variables. + + + + + Gets or sets a value that identifies the domain to use when starting the process. + + + + + Unsets the given environment variable for the given startInfo. + + + + + Sets the given environment variable for the given startInfo. + + + + + Remove the current Environment Variables and use the default + + + + + Gets or sets a value that identifies the domain to use when starting the process. + + + + + Gets or sets a value indicating whether to start the process in a new window. + + + + + Gets or sets the set of command-line arguments to use when starting the application. + + + + + Ensures the executable is run with the full framework. On non-windows platforms that means running the tool by invoking 'mono'. + + + + + Execute an external program and return the exit code. + [omit] + + + + + Waits until the processes with the given name have stopped or fails after given timeout. + ## Parameters + - `name` - The name of the processes in question. + - `timeout` - The timespan to time out after. + + + + + Kills all processes that are created by the FAKE build script unless "donotkill" flag was set. + + + + + Kills the MSBuild process. + + + + + Kills the F# Interactive (FSI) process. + + + + + Kills all processes with the given name + + + + + Returns all processes with the given name + + + + + Retrieve the file-path of the running executable of the given process. + + + + + Kills all processes with the given id + + + + + Execute an external program asynchronously and return the exit code, + logging output and error messages to FAKE output. You can compose the result + with Async.Parallel to run multiple external programs at once, but be + sure that none of them depend on the output of another. + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + Use default Parameters + [omit] + + + + + Adds quotes and a blank around the string´. + [omit] + + + + + Adds quotes around the string if needed + [omit] + + + + + Adds quotes around the string + [omit] + + + + + Starts the given process and forgets about it. + + + + + Runs the given process, waits for its completion and returns if it succeeded. + + + + + Starts the given process and returns immediatly. + + + + + Runs the given process in an elevated context and returns the exit code. + ## Parameters + + - `cmd` - The command which should be run in elavated context. + - `args` - The process arguments. + - `timeOut` - The timeout for the process. + + + + + Runs the given process and returns the exit code. + ## Parameters + + - `configProcessStartInfoF` - A function which overwrites the default ProcessStartInfo. + - `timeOut` - The timeout for the process. + ## Sample + + let result = Process.execSimple (fun info -> + info.FileName <- "c:/MyProc.exe" + info.WorkingDirectory <- "c:/workingDirectory" + info.Arguments <- "-v") (TimeSpan.FromMinutes 5.0) + + if result <> 0 then failwithf "MyProc.exe returned with a non-zero exit code" + + + + + Runs the given process and returns the process result. + ## Parameters + + - `configProcessStartInfoF` - A function which overwrites the default ProcessStartInfo. + - `timeOut` - The timeout for the process. + + + + + Runs the given process and returns the exit code. + ## Parameters + + - `configProcessStartInfoF` - A function which overwrites the default ProcessStartInfo. + - `timeOut` - The timeout for the process. + - `silent` - If this flag is set then the process output is redirected to the given output functions `errorF` and `messageF`. + - `errorF` - A function which will be called with the error log. + - `messageF` - A function which will be called with the message log. + + + + + Sets all current environment variables to their current values + + + + + Sets the given environment variables. + + + + + Unsets the given environment variable for the started process + + + + + Sets the given environment variable for the given startInfo. + Existing values will be overriden. + + + + + [omit] + + + + + If AlwaysSetProcessEncoding is set to false (default) only mono processes will be changed. + + + + + If set to true the ProcessHelper will start all processes with a custom ProcessEncoding. + If set to false (default) only mono processes will be changed. + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + Kills the given process + + + + + Ensures the executable is run with the full framework. On non-windows platforms that means running the tool by invoking 'mono'. + + ### Example + + Command.RawCommand("file.exe", Arguments.OfArgs ["arg1"; "arg2"]) + |> CreateProcess.fromCommand + |> CreateProcess.withFramework // start with mono if needed. + |> Proc.run + |> ignore + + + + + Extensions to [`CreateProcess`](apidocs/v5/fake-core-createprocess.html). + + + + + Some extensions for the `CreateProcess` module, opened automatically (use add `open Fake.Core`) + + + + + Optional `TargetContext` + + + + + Runs the target given by the target parameter or lists the available targets + + + + + Runs the command given on the command line or the given target when no target is given + + + + + Runs the command given on the command line or the given target when no target is given + + + + + Runs a target and its dependencies + + + + + allows to retrieve the arguments passed into the current execution, + when `Target.run*withArguments` overloads are used, see https://fake.build/core-targets.html#Targets-with-arguments + This function should be used at the start of your fake script + Alternatively, you can use Target.initEnvironment() instead, + Note: This function usually returns `Some [||]`, it will return `None` when + No actual execution was requested (for example because of `--list`), + you shouldn't execute any side effects when `None` is returned + (you should never execute side effects but you can use this flag to check if needed) + + + + + allows to initialize the environment before defining targets + This function should be used at the start of your fake script + see https://github.com/fsharp/FAKE/issues/2283 + Alternatively, you can use Target.getArguments() instead + + + + + allows to initialize FAKE, see initEnvironment and getArguments + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + Runs a target and its dependencies and returns a `TargetContext` + + + + + If `TargetContext option` is Some and has error, raise it as a BuildFailedException + + + + + Updates build status based on `OptionalTargetContext` + Will not update status if `OptionalTargetContext` is `MaybeSet` with value `None` + + + + + deactivates the final target. + + + + + Activates the final target. + + + + + Creates a final target (not activated). + + + + + Deactivates the build failure target. + + + + + Activates the build failure target. + + + + + Creates a target in case of build failure (not activated). + + + + + Runs a target and its dependencies. + + + + + Runs a single target without its dependencies... only when no error has been detected yet. + + + + + Determines a parallel build order for the given set of targets + + + + Writes a build time report. + The total runtime. + + + Writes a dependency graph. + Whether to print verbose output or not. + The target for which the dependencies should be printed. + + + + List all targets available. + + + + + List all targets available. + + + + + Runs all build failure targets. + [omit] + + + + + Runs all activated final targets (in alphabetically order). + [omit] + + + + + Creates a Target. + + + + + add a target with dependencies + [omit] + + + + + Creates a target from template. + [omit] + + + + + Backwards dependencies operator - x is dependent on ys. + + + + + Adds the dependencies to the list of soft dependencies. + [omit] + + + + + Adds the dependencies to the list of dependencies. + [omit] + + + + + Adds the dependency to the list of soft dependencies. + [omit] + + + + + Adds the dependency to the list of dependencies. + [omit] + + + + + Appends the dependency to the list of soft dependencies. + [omit] + + + + + Adds the dependency to the front of the list of dependencies. + [omit] + + + + + Checks whether the soft dependency can be added. + [omit] + + + + + Checks whether the dependency can be added. + [omit] + + + + + Checks whether the dependency (soft or normal) can be added. + [omit] + + + + + Do nothing - Can be used to define empty targets. + + + + + Returns the soft DependencyString for the given target. + + + + + This simply runs the function of a target without doing anything (like tracing, stopwatching or adding it to the results at the end) + + + + + This simply runs the function of a target without doing anything (like tracing, stopwatching or adding it to the results at the end) + + + + + Returns the DependencyString for the given target. + + + + + Gets a target with the given name from the target dictionary. + + + + + Returns a list with all target names. + + + + + Resets the state so that a deployment can be invoked multiple times + [omit] + + + + + BuildFailureTargets - stores build failure targets and if they are activated. + + + + + Final Targets - stores final targets and if they are activated. + + + + + TargetDictionary + [omit] + + + + + Sets the Description for the next target. + [omit] + + + + + Sets the Description for the next target. + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + Runs the target given by the target parameter or lists the available targets & get context + + + + + Runs the command given on the command line or the given target when no target is given & get context + + + + + Runs the command given on the command line or the given target when no target is given & get context + + + + + Runs a target and its dependencies and returns an `OptionalTargetContext` + + + + + Run functions which don't throw and return the context after all targets have been executed. + + + + + Defines a conditional dependency - y is dependent on x if the condition is true + + + + + Defines that x and y are not dependent on each other but y is dependent on all dependencies of x. + + + + + Defines a soft dependency. x must run before y, if it is present, but y does not require x to be run. + + + + + Defines a soft dependency. x must run before y, if it is present, but y does not require x to be run. + + + + + Defines a dependency - y is dependent on x + + + + + Specifies that two targets have the same dependencies + + + + + Specifies that two targets have the same dependencies + + + + + Specifies that two targets are on the same level of execution + + + + + Stores which targets are on the same level + + + + + Allows to use Tokens instead of strings for TargetNames + + + + + Allows to use Tokens instead of strings + + + + + Provides functions and operators to deal with FAKE targets and target dependencies. + + + + + Helpers for capturing user input + + ## Sample + + UserInput.getUserInput prompt + + + + + Transforms a XML file using a XSL stylesheet file. + ## Parameters + + - `stylesheetUri` - The Uri for the XSL stylesheet file. + - `fileName` - The XML file to transform. + + + + + Transforms a XmlDocument using a XslCompiledTransform. + ## Parameters + + - `xsl` - The XslCompiledTransform which should be applied. + - `doc` - The XmlDocument to transform. + + + + + Loads the given text into a XslCompiledTransform. + + + + + Replaces inner text of an xml node in a XML file at the location specified by a XPath expression, with support for namespaces. + + + + + Replaces text in a XML file at the location specified by a XPath expression, with support for namespaces. + + + + + Replaces inner text in a XML document specified by a XPath expression, with support for namespaces. + + + + + Replaces text in a XML document specified by a XPath expression, with support for namespaces. + + + + + Replaces the inner text of an xml node in a XML file at the location specified by a XPath expression. + + + + + Replaces text in a XML file at the location specified by a XPath expression. + + + + + Loads the given file path into a XmlDocument + + + + + Selects a xml node via XPath from the given document + + + + + Selects a xml node attribute value via XPath from the given document + + + + + Selects a xml node value via XPath from the given document + + + + + Replaces the value of attribute in an xml node in the XML document specified by a XPath expression. + + + + + Replaces the inner text of an xml node in the XML document specified by a XPath expression. + + + + + Replaces text in the XML document specified by a XPath expression. + + + + + Gets the DocumentElement of the XmlDocument + + + + + Loads the given text into a XmlDocument + + + + + Parses a XML subnode + + + + + Parses a XmlNode + + + + + Gets the first sub node with the given name from the given XmlNode + + + + + Gets a sequence of all child nodes for the given XmlNode + + + + + Gets the attribute with the given name from the given XmlNode + + + + + Writes an CData element to the given XmlTextWriter + + + + + Writes an XML attribute to current element of the given XmlTextWriter + + + + + Writes an XML end element to the given XmlTextWriter + + + + + Writes an XML start element to the given XmlTextWriter + + + + + Writes an XML comment to the given XmlTextWriter + + + + + Creates a XmlWriter which writes to the given file name + + + + + Reads a value from a XML document using a XPath + Returns if the value is an int and the value + + + + + Reads a value from a XML document using a XPath + + + + + Contains functions to read and write XML files. + + + + + Retries the given function until a retry limit is reached or the function succeeds without exception. + ## Parameters + + - `f` - This function will be started. + - `retries` - A retry limit. + + + + + Waits until the given function returns true or the timeout is reached. + ## Parameters + + - `f` - This function will be started. + - `timeout` - A System.TimeSpan representing the timeout. + - `testMS` - An interval at which FAKE checks if the function has succeeded. + - `timeoutF` - This function will be run if the timeout has been reached. + + + + + Contains a helper which can be used to implement timeouts and retries. + + + + + similar to tryGet but throws an exception if the variable with the given name is not available in the vault + + + + + try to retrieve the variable with the given name from the vault (decrypts the variable if needed) + + + + + The vault which stores the encryptes values + + + + + The IV-Bytes (16 byte as base64 encoded string) + + + + + The file with the key (32 byte as base64 encoded string saved in utf-8) + + + + + The key used to decrypt/encrypt variables + + + + + similar to tryGet but throws an exception if the variable with the given name is not available in the vault + + + + + try to retrieve the variable with the given name from the vault (decrypts the variable if needed) + + + + + Retrieve the value from a given variable + + + + + Read a vault from `FAKE_VAULT_VARIABLES` + + + + + Read a vault from `FAKE_VAULT_VARIABLES` + + + + + Read a vault from an environment variable or return None + + + + + Read a vault from an environment variable. + + + + + Read in a vault from a given json string, make sure to delete the source of the json after using this API + + + + + An empty vault without any variables + + + + + Create a new key with the given path to the secret file (or Path.GetTempFileName() otherwise) + + + + + Read a vault from the given encrypted variables + + + + + encrypt the given utf-8 string and return the base64 encoded result + + + + + decrypt a given base64 encoded string and return the utf-8 string of the result + + + + + Provices a encrypted store of variables to prevent accidential leakage + Please read the [documentation](/core-vault.html) + + + + + Type of the artifact + + + + + Deployment name + + + + + File name to display in the artifact tab + + + + + The full local path to the artifact + + + + + AppVeyor parameters for artifact push as [described](https://www.appveyor.com/docs/build-worker-api/#push-artifact) + + + + + Type of artifact that is pushed + + + + + Union type representing the available test result formats accepted by AppVeyor. + + + + + Push multiple artifacts + + + + + Push an artifact + + + + + AppVeyor artifact push default parameters + + + + + Set environment variable + + + + + Uploads all the test results ".xml" files in a directory to make them visible in Test tab of the build console. + + + + + Uploads a test result file to make them visible in Test tab of the build console. + + + + + Finishes the test case. + + + + + Reports a succeeded test. + + + + + Ignores the test case. + + + + + Reports a failed test. + + + + + Updates test info + + + + + Updates test info + + + + + Starts the test case. + + + + + Writes the given message to the Console. + + + + + Implements a TraceListener for TeamCity build servers. + ## Parameters + - `importantMessagesToStdErr` - Defines whether to trace important messages to StdErr. + - `colorMap` - A function which maps TracePriorities to ConsoleColors. + + + + + Timeout in seconds to download repository (GitHub, Bitbucket or VSTS) as zip file (shallow clone). Default is 1800 (30 minutes) + + + + + contains tag name for builds started by tag + + + + + true if build has started by pushed tag; otherwise false + + + + + git or mercurial + + + + + GitHub, BitBucket or Kiln + + + + + Repository name in format owner-name/repo-name + + + + + Commit date/time + + + + + The rest of the commit message after line break (if exists) + + + + + Commit message + + + + + Commit author's email address + + + + + Commit author's name + + + + + Commit ID (SHA) + + + + + Build branch + + + + + GitHub Pull Request title + + + + + GitHub Pull Request Repo name + + + + + GitHub Pull Request branch + + + + + GitHub Pull Request number + + + + + Project slug (as seen in project details URL) + + + + + Project name + + + + + AppVeyor unique project ID + + + + + Platform name set on Build tab of project settings (or through platform parameter in appveyor.yml). + + + + + The Job Number + + + + + The job name + + + + + AppVeyor unique job ID + + + + + If the build runs by scheduler; + + + + + If the build has been started by the "Re-Build commit/PR" button or from the same API + + + + + If the build has been started by the "New Build" button or from the same API + + + + + Timeout in seconds to download arbirtary files using appveyor DownloadFile command. Default is 300 (5 minutes) + + + + + Configuration name set on Build tab of project settings (or through configuration parameter in appveyor.yml). + + + + + set to true to disable cache update + + + + + set to true to disable cache restore + + + + + Timeout in seconds to download or upload each cache entry. Default is 300 (5 minutes) + + + + + Current build worker image the build is running on, e.g. Visual Studio 2015 + + + + + Build version + + + + + Build number + + + + + AppVeyor unique build ID + + + + + Path to clone directory + + + + + Artifact upload timeout in seconds. Default is 600 (10 minutes) + + + + + AppVeyor Build Agent API URL + + + + + AppVeyor Account Name + + + + + AppVeyor environment variables as [described](http://www.appveyor.com/docs/environment-variables) + + + + + Committer email address + + + + + Committer name + + + + + Commit author email address + + + + + Commit author name + + + + + Commit date + + + + + Commit hash + + + + + Commit message + + + + + Build version; must be unique for the current project + + + + + AppVeyor parameters for update build as [described](https://www.appveyor.com/docs/build-worker-api/#update-build-details) + + + + + Update build version. This must be unique for the current project. + + + + + Update build details + + + + + native support for AppVeyor specific APIs. + The general documentation on how to use CI server integration can be found [here](/buildserver.html). + This module does not provide any special APIs please use FAKE APIs and they should integrate into this CI server. + If some integration is not working as expected or you have features you would like to use directly please open an issue. + + + + + Record type which stores TeamCity project properties + + + + + Record type which stores Build configuration properties + + + + + Record type which stores Build properties + + + + + Record type which stores VCSRoot properties + + + + + Gets all projects on the TeamCity server. + + + + + Gets informnation about a project from the TeamCity server. + + + + + Gets information about a build configuration from the TeamCity server. + + + + + [omit] + + + + + Returns the REST version of the TeamCity server + + + + + [omit] + + + + + Message + + + + + Comparison Failed + + + + + Test Failure + + + + + Set Parameter + + + + + Build Statistic + + + + + Build Number + + + + + Publish Named Artifact + + + + + Publish Artifact + + + + + Progress Finish + + + + + Progress Start + + + + + Progress Message + + + + + Test Suite Started + + + + + Test Suite Finished + + + + + Test Std Error + + + + + Test Std Out + + + + + Test Ignored + + + + + Test Finshed + + + + + Test Started + + + + + Build Problem + + + + + Build status + + + + + Close Named Block + + + + + Open Named Block + + + + + Send message to TeamCity with single param + + + + + Encapsulates special chars + + + + + Writes the given message to the Console. + + + + + Implements a TraceListener for TeamCity build servers. + + See [the documentation](https://confluence.jetbrains.com/display/TCD18/Build+Script+Interaction+with+TeamCity) for more information + + + + + The Version of the TeamCity server. This property can be used to determine the build is run within TeamCity. + + + + + Name of recently failing tests + + See [the documentation](https://confluence.jetbrains.com/display/TCD18/Risk+Tests+Reordering+in+Custom+Test+Runner) for more information + + + + + The Name of the project the current build belongs to or None if it's not on TeamCity. + + + + + Get if the current branch of the main VCS root is the one configured as default + + + + + Get the path to the build checkout directory + + + + + Changed files (since previous build) that are included in this build + + See [the documentation](https://confluence.jetbrains.com/display/TCD18/Risk+Tests+Reordering+in+Custom+Test+Runner) for more information + + + + + The Build number assigned to the build by TeamCity using the build number format or None if it's not on TeamCity. + + + + + Is set to true if the build is a personal one. + + + + + The Name of the Build Configuration the current build belongs to or None if it's not on TeamCity. + + + + + Get the display name of the branch of the main VCS root as shown in TeamCity + + See [the documentation](https://confluence.jetbrains.com/display/TCD18/Working+with+Feature+Branches#WorkingwithFeatureBranches-branchSpec) for more information + + + + + Get the branch of the main VCS root + + + + + File revision in the repository. If the file is a part of change list started via the remote run, then the value will be None + + + + + Type of modification for the file + + + + + Path of the file that changed, relative to the current checkout directory (TemaCity.Environment.CheckoutDirectory) + + + + + Describe a change between builds + + + + + The type of change that occured + + + + + Get all system build parameters (Without the 'system.' prefix) + + + + + Get all runner build parameters + + + + + Get all configuration build parameters + + + + + Get all build parameters + + System ones are prefixed with 'system.', runner ones with 'runner.' and environment variables with 'env.' + + + + + TeamCity build parameters + + See [Predefined Build Parameters documentation](https://confluence.jetbrains.com/display/TCD18/Predefined+Build+Parameters) for more information + + + + + Sends an error message. + + + + + Sends a warning message. + + + + + Reports a failed comparison + + + + + Reports a failed test + + + + + Reports a parameter value + + + + + Reports a build statistic. + + + + + Sets the TeamCity build number. + + + + + Publishes an artifact on the TeamcCity build server with a name. + + + + + Publishes an artifact on the TeamcCity build server. + + + + + Reports the build status. + + + + + Reports the progress end. + + + + + Reports the progress start. + + + + + Reports the progress. + + + + + Starts the test suite. + + + + + Finishes the test suite. + + + + + Ignores the test case. + + + + + Report Standard-Error for a given test-case + + + + + Report Standard-Output for a given test-case + + + + + Ignores the test case. + + + + + Finishes the test case. + + + + + Starts the test case. + + + + + Send the PartCover xslt transformation rules (Input xlst and output files) to TeamCity + + + + + Sends the value for NCover /sort: argument to TeamCity + + + + + Sends the value for NCover /report: argument to TeamCity + + + + + Sends additional arguments for NCover 1.x to TeamCity + + + + + Sends the path to NCoverExplorer to TeamCity + + + + + Sends arguments for the NCover report generator to TeamCity + + + + + Sends the full path to NCover installation folder to TeamCity + + + + + Sends the full path to the dotCover home folder to override the bundled dotCover to TeamCity + + + + + Reports build problem + + + + + Sends an error to TeamCity + + + + + Open Named Block that will be closed when the block is disposed + Usage: `use __ = TeamCity.block "My Block"` + + + + + Sends an dotcover, partcover, ncover or ncover3 results filename to TeamCity + + + + + Sends an ReSharper dupfinder.exe results filename to TeamCity + + + + + Sends an PMD Copy/Paste Detector results filename to TeamCity + + + + + Sends an PMD inspections results filename to TeamCity + + + + + Sends an ReSharper inspectCode.exe results filename to TeamCity + + + + + Sends an JSLint results filename to TeamCity + + + + + Sends an FindBugs results filename to TeamCity + + + + + Sends an Checkstyle results filename to TeamCity + + + + + Sends an Google Test results filename to TeamCity + + + + + Sends an MSTest results filename to TeamCity + + + + + Sends an Maven Surefire results filename to TeamCity + + + + + Sends an JUnit Ant task results filename to TeamCity + + + + + Sends an FXCop results filename to TeamCity + + + + + Sends an NUnit results filename to TeamCity + + + + + native support for TeamCity specific APIs. + The general documentation on how to use CI server integration can be found [here](/buildserver.html). + This module does not provide any special APIs please use FAKE APIs and they should integrate into this CI server. + If some integration is not working as expected or you have features you would like to use directly please open an issue. + + For more information on TeamCity interaction from build scripts [see here](https://confluence.jetbrains.com/display/TCD18/Build+Script+Interaction+with+TeamCity) + + + + + Writes the given message to the Console. + + + + + Implements a TraceListener for TeamCity build servers. + ## Parameters + - `importantMessagesToStdErr` - Defines whether to trace important messages to StdErr. + - `colorMap` - A function which maps TracePriorities to ConsoleColors. + + + + + native support for Travis specific APIs. + The general documentation on how to use CI server integration can be found [here](/buildserver.html). + This module does not provide any special APIs please use FAKE APIs and they should integrate into this CI server. + If some integration is not working as expected or you have features you would like to use directly please open an issue. + + + + + Writes the given message to the Console. + + + + + Implements a TraceListener for TeamCity build servers. + ## Parameters + - `importantMessagesToStdErr` - Defines whether to trace important messages to StdErr. + - `colorMap` - A function which maps TracePriorities to ConsoleColors. + + + + + Access (secret) build variables + + + + + native support for Azure DevOps (previously VSTS) / Team Foundation Server specific APIs. + The general documentation on how to use CI server integration can be found [here](/buildserver.html) + + ### Secret Variables + + This CI server supports the concept of secret variables and uses the [Vault](/core-vault.html) to store them. + In order to access secret variables you need to use one of the fake 5 tasks from [vsts-fsharp](https://github.com/isaacabraham/vsts-fsharp). + + #### Example implementation (supports runner and vault tasks) + + // Either use a local vault filled by the 'FAKE_VAULT_VARIABLES' environment variable + // or fall back to the build process if none is given + let vault = + match Vault.fromFakeEnvironmentOrNone() with + | Some v -> v // fake 5 vault task, uses 'FAKE_VAULT_VARIABLES' by default + | None -> TeamFoundation.variables // fake 5 runner task + + // Only needed if you want to fallback to 'normal' environment variables (locally for example) + let getVarOrDefault name = + match vault.TryGet name with + | Some v -> v + | None -> Environment.environVarOrFail name + Target.create "Deploy" (fun _ -> + let token = getVarOrDefault "github_token" + // Use token to deploy to github + + let apiKey = getVarOrDefault "nugetkey" + // Use apiKey to deploy to nuget + () + ) + + + + + + Commit hash or branch name that will be used to create the release tag. + Is not used if the tag already exists. + If left unspecified, and the tag does not already exist, the default branch is used instead. + + + + + Indicates whether the release will be created as a prerelease + + + + + Indicates whether the release will be created as a draft + + + + + The text describing the contents of the release + + + + + The name of the release + + + + + Downloads all assets for the specified release to the specified destination + + + + + Downloads the asset with the specified id to the specified destination + + + + + Gets release with the specified tag for the specified repository + + + + + Gets the latest release for the specified repository + + + + + Publishes the specified release by removing its draft status + + + + + Uploads and attaches the specified files to the specified release + + + + + Uploads and attaches the specified file to the specified release + + + + + Creates a draft GitHub Release for the specified repository and tag name + ## Parameters + - `owner` - the repository's owner + - `repoName` - the repository's name + - `tagName` - the name of the tag to use for this release + - `prerelease` - indicates whether the release will be created as a prerelease + - `notes` - collection of release notes that will be inserted into the body of the release + - `client` - GitHub API v3 client + + + + + Creates a GitHub Release for the specified repository and tag name + ## Parameters + - `owner` - the repository's owner + - `repoName` - the repository's name + - `tagName` - the name of the tag to use for this release + - `setParams` - function used to override the default release parameters + - `client` - GitHub API v3 client + + + + + Creates a GitHub API v3 client to GitHub Enterprise server at the specified url using the specified token + + + + + Creates a GitHub API v3 client to GitHub Enterprise server at the specified url using the specified credentials + + + + + Creates a GitHub API v3 client using the specified token + + + + + Creates a GitHub API v3 client using the specified credentials + + + + + Retry the Octokit action count times after input succeed + + + + + Retry the Octokit action count times + + + + + A version of 'reraise' that can work inside computation expressions + + + + + Contains tasks to interact with [GitHub](https://github.com/) releases + + ### Sample + + Target.create "GitHubRelease" (fun _ -> + let token = + match Environment.environVarOrDefault "github_token" "" with + | s when not (System.String.IsNullOrWhiteSpace s) -> s + | _ -> failwith "please set the github_token environment variable to a github personal access token with repro access." + + let files = + runtimes @ [ "portable"; "packages" ] + |> List.map (fun n -> sprintf "release/dotnetcore/Fake.netcore/fake-dotnetcore-%s.zip" n) + + GitHub.createClientWithToken token + |> GitHub.draftNewRelease gitOwner gitName release.NugetVersion (release.SemVer.PreRelease <> None) release.Notes + |> GitHub.uploadFiles files + |> GitHub.publishDraft + |> Async.RunSynchronously) + + + + + + Whether to force inline unfurling of attached links. Default value: false. + + + + + The emoji to be displayed with the message. Default value: Specified in your slack Webhook configuration. + + + + + The icon to be displayed with the message. Default value: Specified in your slack Webhook configuration. + + + + + Channel to which the message will be posted. Default value: Specified in your Slack Webhook configuration. + + + + + Name the message will appear to be sent from. Default value: Specified in your Slack Webhook configuration. + + + + + (Required) The message body + + + + + The Slack notification parameter type + + + + + Text to be displayed as a table below the message + + + + + Color of the attachment text. Can be hex-value(e.g. "#AABBCC") or one of "'good', 'warning', 'danger'. + + + + + Text that should appear above the formatted data + + + + + Text that should appear within the attachment + + + + + Content to which the title should link + + + + + The title of the attachment + + + + + (Required) Text summary of the attachment that is shown by clients that understand attachments but choose not to show them + + + + + The Slack notification attachment parameter type + + + + + Whether the value is short enough to be displayed side-by-side with other values + + + + + (Required) Text value of the field + + + + + (Required) The field title + + + + + The Slack notification attachment field parameter type + + + + + Sends a notification to a Slack Channel + ## Parameters + - `webhookURL` - The Slack webhook URL + - `setParams` - Function used to override the default notification parameters + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + The default parameters for Slack notification attachment fields + + + + + The default parameters for Slack notification attachments + + + + + The default Slack notification parameters + + + + + Contains a task to send notification messages to a [Slack](https://slack.com/) webhook + + + + + When uploading a build, specify to which version (hockeyapp version id) + + + + + Set to your App Id (required for UWP apps targeting windows phone) + + + + + Set maximum upload delay + + + + + Restrict download to specific teams + + + + + Release download status (can only be set with full-access tokens) + + + + + Set to your source repository + + + + + Set to the URL of the build job on your build server + + + + + Set to the git commit sha for this build + + + + + Set to true to enable the private download page (default is false) + + + + + Set version as mandatory + + + + + Set the notify option + + + + + Set the owner of the app + + + + + Set the release type of the app + + + + + Release notes type for the build + + + + + Release notes for the build + + + + + file data for dsym (IOS: *.dysm.zip or Android: mapping.txt) + + + + + (Required) file data for the build (.ipa or .apk) + + + + + (Required) API token + + + + + The HockeyApp parameter type + Based on http://support.hockeyapp.net/kb/api/api-apps#upload-app + + + + + Set maximum upload delay + + + + + Human readable version + + + + + Set to your App Id (required for UWP apps targeting windows phone) + + + + + (Required) API token + + + + + The HockeyAppVersion parameter type + Based on https://support.hockeyapp.net/kb/api/api-versions#create-version + + + + + Set maximum upload delay + + + + + Set to your App Id (required for UWP apps targeting windows phone) + + + + + (Required) API token + + + + + HockeyAppVersion's success response + https://support.hockeyapp.net/kb/api/api-versions#create-version + + + + + HockeyApp's success response + + + + + The release download status + + + + + The mandatory options + + + + + The note types + + + + + The notification options + + + + + The release type of the app + + + + + Create a new version of an app on HockeyApp + ## Parameters + - `setParams` - Function used to override the default parameters + + ## Sample + + HockeyApp.createAppVersion (fun defaults -> + {defaults with + AppId = ... + ApiToken = ... + Version = ... + ... + }) + + + + + Uploads an app to HockeyApp + ## Parameters + - `setParams` - Function used to override the default parameters + + ## Sample + + HockeyApp.uploadApp (fun defaults -> + {defaults with + AppId = ... + ApiToken = ... + ... + }) + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + The default HockeyAppVersion parameters to create a version + + + + + The default HockeyApp parameters to upload a build + + + + + Contains tasks to interact with [HockeyApp](http://hockeyapp.com) + + + + + Specify Logging parameter + + + + + Disable fetching Git related information for articles. By default it is enabled and may have side effect on performance when the repo is large. + + + + + --property <n1>=<v1>;<n2>=<v2> An optional set of MSBuild properties used when interpreting project files. These are the same properties that are passed to msbuild via the /property:<n1>=<v1>;<n2>=<v2> command line argument. + + + + + Specify the name to use for the global namespace. + + + + + Specify the filter config file. + + + + + Specify the config file path. + + + + + Specify project files. + + + + + Preserve the existing xml comment tags inside 'summary' triple slash comments. + + + + + Specify the output base directory. + + + + + Skip to markup the triple slash comments. + + + + + Force re-generate all the metadata. + + + + + Specify common docFx options + + + + + Changes the "LogParams" according to the given function + + + + + Changes the "Common" parameters according to the given function + + + + + Metadata default parameters + + + + + Metadata-Command parameters + + + + + Specify the port of the hosted website [8080] + + + + + Specify the hostname of the hosted website [localhost]. + + + + + folder path + + + + + Specify common docFx options + + + + + Changes the "Common" parameters according to the given function + + + + + Serve default parameters + + + + + Serve-Command parameters + + + + + Specify the url of xrefmap. + + + + + Specify the output xref archive. + + + + + Specify common docFx options + + + + + Changes the "Common" parameters according to the given function + + + + + Download default parameters + + + + + Download-Command parameters + + + + + Specify the output folder path for the exported templates. + + + + + If specified, all the available templates will be exported. + + + + + Specify templates to export. + + + + + Specify common docFx options + + + + + Changes the "Common" parameters according to the given function + + + + + ExportTemplate default parameters + + + + + ExportTemplate-Command parameters + + + + + Specify the base path to generate external link, {host}/{locale}/{basePath}. + + + + + Specify the toc files to be excluded. + + + + + Specify the locale of the pdf file. + + + + + Specify the hostname to link not-in-TOC articles. + + + + + Specify the output folder for the raw files, if not specified, raw files will by default be saved to _raw subfolder under output folder if keepRawFiles is set to true. + + + + + Specify how to handle pdf pages that fail to load: abort, ignore or skip(default abort), it is the same input as wkhtmltopdf --load-error-handling options. + + + + + Specify whether or not to keep the intermediate html files that used to generate the PDF file. It it usually used in debug purpose. By default the value is false. + + + + + generatesExternalLink", HelpText = "Specify whether or not to generate external links for PDF. + + + + + Specify whether or not to generate appendices for not-in-TOC articles. + + + + + Specify the path for the css to generate pdf, default value is styles/default.css. + + + + + Specify the name of the generated pdf. + + + + + Specify build parameters. + + + + + Changes the "LogParams" according to the given function + + + + + Changes the "Common" parameters according to the given function + + + + + Changes the "BuildParams" according to the given function + + + + + Pdf default parameters + + + + + Pdf-Command parameters + + + + + Specify Logging parameter + + + + + Please provide the license key for validating schema using NewtonsoftJson.Schema here. + + + + + Disable fetching Git related information for articles. By default it is enabled and may have side effect on performance when the repo is large. + + + + + Set the name of input file abstract layer builder. + + + + + If set to true, docfx create a new intermediate folder for cache files, historical cache data will be cleaned up. + + + + + If set to true, docfx does not dereference (aka. copy) file to the output folder, instead, it saves a link_to_path property inside mainfiest.json to indicate the physical location of that file. + + + + + Set the LRU cached model count (approximately the same as the count of input files). By default, it is 8192 for 64bit and 3072 for 32bit process. With LRU cache enabled, memory usage decreases and time consumed increases. If set to 0, Lru cache is disabled. + + + + + Set the order of post processors in plugins. + + + + + Set changes file. + + + + + Set folder for intermediate build results. + + + + + Disable default lang keyword. + + + + + Set the parameters for markdown engine, value should be a JSON string. + + + + + Set the name of markdown engine, default is 'dfm'. + + + + + Set the max parallelism, 0 is auto. + + + + + If set to true, template will not be actually applied to the documents. This option is always used with --exportRawModel or --exportViewModel is set so that only raw model files or view model files are generated. + + + + + If set to true, data model to apply template will be extracted in .view.model.json extension. + + + + + Specify the output folder for the view model. If not set, the view model will be generated to the same folder as the output documentation. + + + + + Specify the output folder for the raw model. If not set, the raw model will be generated to the same folder as the output documentation. + + + + + If set to true, data model to run template script will be extracted in .raw.model.json extension. + + + + + Specify a list of JSON file path containing fileMetadata settings, as similar to {\"key\":\"value\"}. It overrides the fileMetadata settings from the config file. + + + + + Specify a list of JSON file path containing globalMetadata settings, as similar to {\"key\":\"value\"}. It overrides the globalMetadata settings from the config file. + + + + + Specify global metadata key-value pair in json format. It overrides the globalMetadata settings from the config file. + + + + + Force to re-process the documentation in post processors. It will be cascaded from force option. + + + + + The output folder for files generated for debugging purpose when in debug mode. If not specified, it is ${TempPath}/docfx. + + + + + Run in debug mode. With debug mode, raw model and view model will be exported automatically when it encounters error when applying templates. If not specified, it is false. + + + + + Force re-build all the documentation. + + + + + Specify the port of the hosted website. + + + + + Specify the hostname of the hosted website (e.g., 'localhost' or '*'). + + + + + Host the generated documentation to a website. + + + + + Specify which theme to use. By default 'default' theme is offered. + + + + + Specify the template name to apply to. If not specified, output YAML file will not be transformed. + + + + + Specify the urls of xrefmap used by content files. + + + + + Specify overwrite files used by content files. + + + + + Specify resources used by content files. + + + + + Specify content files for generating documentation. + + + + + Specify the config file path. + + + + + Specify the output base directory. + + + + + Specify common docFx options + + + + + Changes the "LogParams" according to the given function + + + + + Changes the "Common" parameters according to the given function + + + + + Build default parameters + + + + + Build-Command parameters + + + + + Specify the correlation id used for logging. + + + + + Specify the GIT repository root folder. + + + + + Specify to which log level will be logged. By default log level >= Info will be logged. The acceptable value could be Verbose, Info, Warning, Error. + + + + + Specify the file name to save processing log. + + + + + Log default parameters + + + + + Parameters for logging + + + + + Specify the source working folder for source project files to start glob search. + + + + + Specify the source project files' glob pattern to generate metadata. + + + + + Generate config file docfx.json only, no project folder will be generated. + + + + + Specify the output folder of the config file. Defaults to docfx_project. + + + + + Specify if the current file will be overwritten if it exists. + + + + + Specify common docFx options + + + + + Changes the "Common" parameters according to the given function + + + + + Init default parameters + + + + + Init-Command parameters + + + + + Specify the process working directory + + + + + Specify a timeout for DocFx. Default: 5 min. + + + + + The tool path - FAKE tries to find docfx.exe automatically in any sub folder. + + + + + Common default parameters + + + + + Serves a DocFx documentation. + ## Parameters + - `setParams` - Function used to manipulate the default serve parameters. See `MetadataParams.Create()` + ## Sample + + DocFx.metadata (fun p -> + { p with + ConfigFile = "docs" @@ "docfx.json" + DisableGitFeatures = true + }) + + + + + Serves a DocFx documentation. + ## Parameters + - `setParams` - Function used to manipulate the default serve parameters. See `ServeParams.Create()` + ## Sample + + DocFx.serve (fun p -> + { p with + Host = "localhost" + Port = Some 80 + Folder = "docs" + }) + + + + + Download xref archive. + ## Parameters + - `setParams` - Function used to manipulate the default download parameters. See `DownloadParams.Create()` + ## Sample + + DocFx.download (fun p -> + { p with + ArchiveFile = "archive" + Uri = "uri" + }) + + + + + Exports template files. + ## Parameters + - `setParams` - Function used to manipulate the default exportTemplate parameters. See `ExportTemplateParams.Create()` + ## Sample + + DocFx.exportTemplate (fun p -> + { p with + All = true + OutputFolder = "templates" + }) + + + + + Builds a Pdf-File from a DocFx documentation. + ## Parameters + - `setParams` - Function used to manipulate the default pdf parameters. See `PdfParams.Create()` + ## Sample + + DocFx.pdf (fun p -> + { p with + Name = "Docs.pdf" } + .WithBuildParams (fun b -> + { b with + OutputFolder = "build" @@ "docs" + ConfigFile = "docs" @@ "docfx.json"}) + ) + + + + + Builds a DocFx documentation. + ## Parameters + - `setParams` - Function used to manipulate the default build parameters. See `BuildParams.Create()` + ## Sample + + DocFx.build (fun p -> + { p with + OutputFolder = "build" @@ "docs" + ConfigFile = "docs" @@ "docfx.json" + }) + + + + + Initialize a DocFx documentation. + ## Parameters + - `setParams` - Function used to manipulate the default Init parameters. See `InitParams.Create()` + ## Sample + + DocFx.init (fun p -> + { p with + Overwrite = true + Timeout = TimeSpan.FromMinutes 10. + }) + + + + + Contains helper functions to use DocFx https://dotnet.github.io/docfx/. + + + + + SQLCMD variables + + + + + Additional configuration parameters required by sqlpackage.exe + + + + + Recreates the database from scratch on publish (rather than an in-place update). Defaults to false. + + + + + Drops objects in the destination that do not exist in the source. Defaults to false. + + + + + Block deployment if data loss can occur. Defaults to true. + + + + + Timeout for deploy (defaults to 120 seconds). + + + + + Path to destination (path to DACPAC or Connection String). + + + + + Path to source (path to DACPAC or Connection String). + + + + + Type of action to execute. Defaults to Deploy. + + + + + The path to SqlPackage.exe. + + + + + Configuration arguments for DacPac deploy + + + + + Generate an XML report for the differences between two databases. + + + + + Generate a SQL script to sync two databases. + + + + + Generate and apply a synchronisation script between two databases. + + + + + The type of action to execute. + + + + + Deploys a SQL DacPac or database to another database or DacPac. + + + + + The default DacPac deployment arguments. + + + + + When creating a new SQL Azure database, specifies the database service tier to use e.g. S2, P1 + + + + + Contains helpers around deploying databases. + + + + + Starts a remote windows service. Waits up to two minutes for a response. + + + + + Starts a local windows service. Waits up to two minutes for a response. + + + + + Stops a remote windows service. Waits up to two minutes for a response. + + + + + Stops a local windows service. Waits up to two minutes for a response. + + + + + Sends a command to a local windows service. + + + + + Sends a command to a remote windows service. + + + + + Waits until the local service with the given name has been stopped or fails after given timeout + ## Parameters + - `name` - The name of the service in question. + - `timeout` - The timespan to time out after. + + + + + Waits until the remote service with the given name has been stopped or fails after given timeout + ## Parameters + - `host` - The hostname of the remote machine. + - `name` - The name of the service in question. + - `timeout` - The timespan to time out after. + + + + + Waits until the local service with the given name has been started or fails after given timeout + ## Parameters + - `name` - The name of the service in question. + - `timeout` - The timespan to time out after. + + + + + Waits until the remote service with the given name has been started or fails after given timeout + ## Parameters + - `host` - The hostname of the remote machine. + - `name` - The name of the service in question. + - `timeout` - The timespan to time out after. + + + + + Stops all local services with given name. + ## Parameters + - `name` - The name of the services in question. + + + + + Stops all services with given name. + ## Parameters + - `host` - The hostname of the remote machine. + - `name` - The name of the services in question. + + + + + Starts all local services with given name. + ## Parameters + - `name` - The name of the services in question. + + + + + Starts all remote services with given name. + ## Parameters + - `host` - The hostname of the remote machine. + - `name` - The name of the services in question. + + + + + Returns status of the local service with given name or fails when service is not found. + ## Parameters + - `name` - The name of the service in question. + + + + + Returns status of the remote service with given name or fails when service is not found. + ## Parameters + - `host` - The hostname of the remote machine. + - `name` - The name of the service in question. + + + + + Returns whether a local service with the given name exists. + ## Parameters + - `name` - The name of the service in question. + + + + + Returns whether a remote service with the given name exists. + ## Parameters + - `host` - The hostname of the remote machine. + - `name` - The name of the service in question. + + + + + Returns the first local service with given name or None. + ## Parameters + - `name` - The name of the service in question. + + + + + Returns the first remote service with given name or None. + ## Parameters + - `host` - The hostname of the remote machine. + - `name` - The name of the service in question. + + + + + Returns sequence of local services with given name. + ## Parameters + - `name` - The name of the services in question. + + + + + Returns sequence of remote services with given name. + ## Parameters + - `host` - The hostname of the remote machine. + - `name` - The name of the services in question. + + + + + Returns whether the given service has the given name as display or service name. + ## Parameters + - `name` - The name to check for. + - `service` - The service in question. + + + + + Get friendly service name for displaying in logs + + + + + Host value used for querying local services. + + + + + Contains functions which can be used to start other tools. + + + + + Force - force the behavior. Do not use force during normal operation - + it subverts some of the smart behavior for commands. Maybe used for pushing + packages ot insecure private feeds. Default `false`. + Equivalent to the `--force` option. + + + + + Do not prompt for user input or confirmations. Default `true`. + Equivalent to the `-y` option. + + + + + A character string containing additional arguments to give to choco. + + + + + The location of the choco executable. Automatically found if null or empty. + + + + + The choco execution timeout. + + + + + The api key for the source. If not specified (and not local file source), does a lookup. + If not specified and one is not found for an https source, push will fail. + Equivalent to the `--apikey <apikey>` option. + + + + + The source we are pushing the package to. Default: "https://chocolatey.org/" + Equivalent to the `--source <source>` option. + + + + + The choco push parameter type. + + + + + The type of checksum that the file is validated with. Default: Sha256 + Used to create chocolateyInstall.ps1 if it doesn't exists. + + + + + The type of checksum that the file is validated with. Default: Sha256 + Used to create chocolateyInstall.ps1 if it doesn't exists. + + + + + The checksum hash value of the PackageDownload64Url resource + This allows a checksum to be validated for files that are not local. The checksum type is covered by ChecksumType64. + Equivalent to the `--checksum <string>` option of Install-Chocolatey[Zip]Package functions. + Used to create chocolateyInstall.ps1 if it doesn't exists. + + + + + The checksum hash value of the PackageDownloadUrl resource + This allows a checksum to be validated for files that are not local. The checksum type is covered by ChecksumType. + Equivalent to the `--checksum <string>` option of Install-Chocolatey[Zip]Package functions. + Used to create chocolateyInstall.ps1 if it doesn't exists. + + + + + Either: + + - For zip: the zip filename originally installed + - For exe or msi: the full path to the native uninstaller to run + + + + + Installer type. Default: Zip. + Used to create chocolateyInstall.ps1 and/or chocolateyUninstall.ps1 if it doesn't exists. + + + + + Unzip location for zip package. Default: Chocolatey install folder. + Used to create chocolateyInstall.ps1 if it doesn't exists. + + + + + Silent args for the installer. + Used to create chocolateyInstall.ps1 and/or chocolateyUninstall.ps1 if it doesn't exists. + + + + + Url pointing to the installer (exe, msi, zip) of the 64 bits version of the package. + Used to create chocolateyInstall.ps1 if it doesn't exists. + + + + + Url pointing to the installer (exe, msi, zip) of the package. + Used to create chocolateyInstall.ps1 if it doesn't exists. + + + + + Boolean specifying whether the package will be marked as a [development-only dependency](https://docs.nuget.org/Release-Notes/NuGet-2.7#development-only-dependencies). Default: false. + Used for the nuspec creation. + + + + + Url pointing to the location of the underlying software source. + Used for the nuspec creation. + + + + + Url pointing to the location where issues and tickets can be accessed. + Used for the nuspec creation. + + + + + Url pointing to the forum or email list group for the software. + Used for the nuspec creation. + + + + + Url pointing to the location of the wiki or docs of the software. + Used for the nuspec creation. + + + + + Url to the chocolatey package repository, not the software (unless they are the same). + Used for the nuspec creation. + + + + + True if the software needs license acceptance. Default: false. + Used for the nuspec creation. + + + + + Url to the license of the software. + Used for the nuspec creation. + + + + + Url to the icon of the package. + Used for the nuspec creation. + + + + + Url to the software. + Used for the nuspec creation. + + + + + Files of the package. + Used for the nuspec creation. + + + + + Framework assemblies of the package. + Used for the nuspec creation. + + + + + References by framework of the package. + Used for the nuspec creation. + + + + + References of the package. + Used for the nuspec creation. + + + + + Dependencies by framework of the package. + Used for the nuspec creation. + + + + + Dependencies of the package. + Used for the nuspec creation. + + + + + Output directory for the files (nuspec, chocolateyInstall.ps1 and chocolateyUninstall.ps1) creation. + + + + + Copyright of the package. + Used for the nuspec creation. + + + + + Release notes of the package. + Used for the nuspec creation. + + + + + Tags of the package. + Used for the nuspec creation. + + + + + Description of the package. + Used for the nuspec creation. + + + + + Summary of the package. + Used for the nuspec, chocolateyInstall.ps1 and chocolateyUninstall.ps1 creation. + + + + + Title of the package. + Used for the nuspec creation. + + + + + Id of the package. Should be lowercase, not contains weird chars and use dash (-) instead of spaces. + Used for the nuspec creation. + + + + + Owners of the package. + Used for the nuspec creation. + + + + + Authors of the package. + Used for the nuspec creation. + + + + + Do not prompt for user input or confirmations. Default `true`. + Equivalent to the `-y` option. + + + + + A character string containing additional arguments to give to choco. + + + + + The location of the choco executable. Automatically found if null or empty. + + + + + The choco execution timeout. + + + + + The version you would like to insert into the package. + Equivalent to the `--version <version>` option. + + + + + The choco pack parameter type. + + + + + Do not prompt for user input or confirmations. Default `true`. + Equivalent to the `-y` option. + + + + + A character string containing additional arguments to give to choco. + + + + + The location of the choco executable. Automatically found if null or empty. + + + + + The choco execution timeout. + + + + + Password - the user's password to the source. + Equivalent to the `--password <password>` option. + + + + + User - used with authenticated feeds. + Equivalent to the `--user <user>` option. + + + + + Skip Powershell - Do not run chocolateyInstall.ps1. Default `false`. + Equivalent to the `--skippowershell` option. + + + + + Should install arguments be used exclusively without appending to current package passed arguments? Default `false`. + Equivalent to the `--overrideargs` option. + + + + + Install Arguments to pass to the native installer in the package. + Equivalent to the `--installargs <args>` option. + + + + + Force x86 (32bit) installation on 64 bit systems. Default `false`. + Equivalent to the `--forcex86` option. + + + + + Equivalent to the `--source <source>` option. + + + + + Parameters to pass to the package. + Equivalent to the `--params <params>` option. + + + + + Include prerelease. Default `false`. + Equivalent to the `--pre` option. + + + + + Version of the package + Equivalent to the `--version <version>` option. + + + + + The choco install parameter type. + + + + + Call custom choco command + ## Parameters + - `args` - string that will be appendedn to choco.exe call + - `timeout` - parrent process maximum completion time + ## Sample usage + + Target "ChocoPush" (fun _ -> + + let newSpecFile = ... + let args = + new StringBuilder() + |> append "pack" + |> append newSpecFile + |> append "-y" + |> toText + + args |> Choco.CallChoco TimeSpan.FromMinutes 1. + ) + + + + + Call choco to [push](https://github.com/chocolatey/choco/wiki/CommandsPush) a package + ## Parameters + - `setParams` - Function used to manipulate the default choco parameters. See `ChocoPushParams` + - `nupkgPath` - path to the .nupkg to push + ## Sample usage + + Target "ChocoPush" (fun _ -> + "pretzel.0.5.0.nupkg" |> Choco.Push (fun p -> { p with ApiKey = "123-123123-123" }) + ) + + + + + Call choco to [pack](https://github.com/chocolatey/choco/wiki/CommandsPack) a package + ## Parameters + - `setParams` - Function used to manipulate the default choco parameters. See `ChocoPackParams` + - `nuspecPath` - path to the .nuspec to pack + ## Sample usage + + Target "ChocoPack" (fun _ -> + "pretzel.nuspec" |> Choco.Pack (fun p -> { p with Version = "0.5.0" }) + ) + + + + + Call choco to [pack](https://github.com/chocolatey/choco/wiki/CommandsPack) a package and create .nuspec, chocolateyInstall.ps1 and chocolateyUninstall.ps1 if informations are specified + ## Parameters + - `setParams` - Function used to manipulate the default choco parameters. See `ChocoPackParams` + ## Sample usage + + Target "ChocoPack" (fun _ -> + Choco.Pack (fun p -> { p with Version = "0.5.0"; ... }) + ) + + + + + Call choco to [install](https://github.com/chocolatey/choco/wiki/CommandsInstall) a package + ## Parameters + - `setParams` - Function used to manipulate the default choco parameters. See `ChocoInstallParams` + - `packages` - Names of packages, path to packages.config, .nuspec or .nupkg to install + ## Sample usage + + Target "ChocoInstall" (fun _ -> + "pretzel" |> Choco.Install (fun p -> { p with Version = "0.4.0" }) + ) + + + + + True if choco is available (only on windows) + ## Sample usage + "Build" =?> ("ChocoInstall", Choco.IsAvailable) + + + + + [omit] + Create nuspec from data + + + + + [omit] + Create nuspec from template + + + + + [omit] + Invokes chocolatey with the specified arguments + ## Parameters + - `exePath` - The location of choco executable. Automatically found if null or empty. + - `args` - The arguments given to the executable. + - `timeout` - The choco execution timeout + + + + + [omit] + Tries to find the specified choco executable: + + 1. In the `<ProgramData>\chocolatey\bin` directory + 2. In the `PATH` environment variable. + + + + + The default option set given to choco push. + + + + + The default option set given to choco pack. + + + + + The default option set given to choco install. + + + + + Contains tasks which allow to call [Chocolatey](https://chocolatey.org) + + + + + Registry base keys. + + + + + Returns all the subKey names of a registry key + + + + + Deletes a registry subKey + + + + + Create a registry subKey + + + + + Returns whether or not a registry value name exists for a key + + + + + Returns all the value names of a registry key + + + + + Deletes the registry value from its key + + + + + Sets a registry value + + + + + Gets a registry value as string + + + + + Gets a registry value as string + + + + + Gets a registry key and falls back to 32 bit if the 64bit key is not there + + + + + Gets a 64-bit registry key + + + + + Maps the RegistryBaseKey to a RegistryKey for a 32bit System + [omit] + + + + + Maps the RegistryBaseKey to a RegistryKey for a 64bit System + [omit] + + + + + Maps the RegistryBaseKey to a RegistryKey + [omit] + + + + + Contains functions which allow to read and write information from/to the registry. + + ## Sample + + #### Create a subkey + + let subkey = "Company/MyApp" + Registry.createRegistrySubKey Registry.HKEYCurrentUser subkey + + #### Write a key-value pair to a subkey + + Registry.setRegistryValue Registry.HKEYCurrentUser subkey "AppType" "Premium" + Registry.setRegistryValue Registry.HKEYCurrentUser subkey "Version" "1.0.4" + + #### Get a list of key-value names in a subkey + + let values = Registry.getRegistryValueNames Registry.HKEYCurrentUser subkey + values |> Array.iter (Trace.trace << (sprintf "Found value name: %s!")) + + #### Read the value of a key-value pair + + let AppType = Registry.getRegistryValue Registry.HKEYCurrentUser subkey values.[0] + Trace.trace (sprintf "You are running the %s version" AppType) + + #### Check if a value exists within a subkey + + let exists b = if b then Trace.trace "It exists!" else Trace.trace "It doesn't exist!" + exists <| Registry.valueExistsForKey Registry.HKEYCurrentUser subkey "DateCreated" + exists <| Registry.valueExistsForKey Registry.HKEYCurrentUser subkey "Version" + + #### Delete a key-value pair from a subkey + + Registry.deleteRegistryValue Registry.HKEYCurrentUser subkey "AppType" + + #### Delete a subkey + + Registry.deleteRegistrySubKey Registry.HKEYCurrentUser subkey + + + + + Substitute File/@Source="SourceDir" with a preprocessor or a wix variable (Parameter: -var) + + + + + Component group name, cannot contain spaces. (Parameter: -cg) + + + + + Directory reference to root directories, cannot contains spaces. (Parameter: -dr) + + + + + Suppress unique identifiers for files, components, & directories.(Parameter: -suid) + + + + + Suppress registry harvesting. (Parameter: -sreg) + + + + + Suppress harvesting the root directory as an element. (Parameter: -srd) + + + + + Suppress generation of fragments for directories and components. (Parameter: -sfrag) + + + + + Suppress COM elements. (Parameter: -scom) + + + + + Generate guids now. All components are given a guid when heat is run. (Parameter: -gg) + + + + + Auto generate component guids at compile time, e.g. set Guid="*". (Parameter: -ag) + + + + + Timeout for the call to Heat + + + + + Directory that contains the Heat tool + + + + + Specify architecture of package. For 64Bit Setups set ProgramFilesFolder to ProgramFiles64, package platform to X64, all components to Win64 = yes and all files' processorArchitecture to X64. + + + + + You can add custom replacements for the wix xml here. + + + + + You can nest InstallExecuteSequence actions in here + + + + + You can nest custom actions in here + + + + + You can nest feature elements in here + + + + + Build Number of product + + + + + Nest Components in here + + + + + You can nest DirectoryRefs in here + + + + + Nest directories in here + + + + + Nest WiXVariables in here + + + + + Nest UIRefs in here + + + + + Nest major upgrade elements in here + + + + + You can nest upgrade elements in here + + + + + The upgrade code GUID for the product. + + + + + The manufacturer of the product. + + + + + The product's version string. + + + + + The decimal language ID (LCID) for the product. + + + + + Product description + + + + + The program files folder + + + + + The descriptive name of the product. + + + + + The product code GUID for the product. + + + + + Parameters for WiX Script properties, use ToString for creating the string xml nodes + + + + + The value of the variable. The value cannot be an empty string because that would make it possible to accidentally set a column to null. + + + + + Set this value to 'yes' in order to make the variable's value overridable either by another WixVariable entry or via the command-line option -d<name>=<value> for light.exe. + If the same variable is declared overridable in multiple places it will cause an error (since WiX won't know which value is correct). The default value is 'no'. + + + + + The name of the variable. + + + + + Parameters for WiX Variable, use ToString for creating the string xml nodes + + + + + The message displayed if users try to install a product with a lower version number when a product with a higher version is installed. Used only when AllowDowngrades is no (the default). + + + + + When set to no (the default), products with lower version numbers are blocked from installing when a product with a higher version is installed; the DowngradeErrorMessage + attribute must also be specified. When set to yes, any version can be installed over any other version. + + + + + Determines the scheduling of the RemoveExistingProducts standard action, which is when the installed product is removed. The default is "afterInstallValidate" which removes the + installed product entirely before installing the upgrade product. It's slowest but gives the most flexibility in changing components and features in the upgrade product. + + + + + Parameters for WiX Major Upgrade + + + + + Schedules RemoveExistingProducts after the InstallFinalize standard action. This is similar to the afterInstallExecute and afterInstallExecuteAgain schedulings but takes place outside + the installation transaction so if installation of the upgrade product fails, Windows Installer does not roll back the removal of the installed product, + so the machine will have both versions installed. + + + + + Schedules RemoveExistingProducts between the InstallExecuteAgain and InstallFinalize standard actions. + This is identical to the afterInstallExecute scheduling but after the InstallExecuteAgain standard action instead of InstallExecute. + + + + + Schedules RemoveExistingProducts between the InstallExecute and InstallFinalize standard actions. This scheduling installs the upgrade product "on top of" the installed product then lets + RemoveExistingProducts uninstall any components that don't also exist in the upgrade product. Note that this scheduling requires strict adherence to the component rules because it relies + on component reference counts to be accurate during installation of the upgrade product and removal of the installed product. For more information, see Bob Arnson's blog post + "Paying for Upgrades" for details. If installation of the upgrade product fails, Windows Installer also rolls back the removal of the installed product -- in other words, reinstalls it. + + + + + Schedules RemoveExistingProducts after the InstallInitialize standard action. This is similar to the afterInstallValidate scheduling, but if the installation of the upgrade product fails, + Windows Installer also rolls back the removal of the installed product -- in other words, reinstalls it. + + + + + (Default) Schedules RemoveExistingProducts after the InstallValidate standard action. This scheduling removes the installed product entirely before installing the upgrade product. + It's slowest but gives the most flexibility in changing components and features in the upgrade product. Note that if the installation of the upgrade product fails, + the machine will have neither version installed. + + + + + Used for determing when to run RemoveExistingProducts on major upgrade + + + + + Set to "yes" to make the range of versions detected include the value specified in Maximum. + + + + + Set to "no" to make the range of versions detected exclude the value specified in Minimum. This attribute is "yes" by default. + + + + + When the FindRelatedProducts action detects a related product installed on the system, it appends the product code to the property specified in this field. + Windows Installer documentation for the Upgrade table states that the property specified in this field must be a public property and must be added to the + SecureCustomProperties property. WiX automatically appends the property specified in this field to the SecureCustomProperties property when creating an MSI. + Each UpgradeVersion must have a unique Property value. After the FindRelatedProducts action is run, the value of this property is a list of product codes, + separated by semicolons (;), detected on the system. + + + + + Specifies the upper boundary of the range of product versions detected by FindRelatedProducts. + + + + + Specifies the lower bound on the range of product versions to be detected by FindRelatedProducts. + + + + + Set to "yes" to detect products and applications but do not uninstall. + + + + + Parameters for WiX Upgrade Version + + + + + You can nest UpgradeVersion sequences in here + + + + + This value specifies the upgrade code for the products that are to be detected by the FindRelatedProducts action. + + + + + Parameters for WiX Upgrade + + + + + Name of referenced UI + + + + + Parameters for WiX UI Reference, use ToString for creating the string xml nodes + + + + + Conditions that have to be fulfilled for running execution + + + + + Name of the standard or custom action that the verb points to + + + + + Specify if action should be executed before or after target action + + + + + The action to which the Custom element applies. + + + + + Parameters for WiX Custom Action executions (In InstallExecuteSequence), use ToString for creating the string xml nodes + + + + + Specifies that action should be executed before some standard or custom action + + + + + Specifies that action should be executed after some standard or custom action + + + + + Used for specifying the point of time for action execution in CustomActionExecution + + + + + Set this attribute to set the return behavior of the custom action. + + + + + This attribute specifies the command line parameters to supply to an externally run executable. + This attribute is typically used with the BinaryKey attribute for a type 2 custom action, the FileKey attribute for a type 18 + custom action, the Property attribute for a type 50 custom action, or the Directory attribute for a type 34 custom action that + specify the executable to run. + + + + + This attribute specifies whether the Windows Installer, which executes as LocalSystem, should impersonate the user context of + the installing user when executing this custom action. Typically the value should be 'yes', except when the custom action needs + elevated privileges to apply changes to the machine. + + + + + This attribute indicates the scheduling of the custom action. + + + + + This attribute specifies a reference to a File element with matching Id attribute that will execute the custom action code + in the file after the file is installed. This attribute is typically used with the ExeCommand attribute to specify + a type 18 custom action that runs an installed executable, with the DllEntry attribute to specify an installed custom action + DLL to use for a type 17 custom action, or with the VBScriptCall or JScriptCall attributes to specify a type 21 or 22 custom action. + + + + + The identifier of the custom action. + + + + + Parameters for WiX custom action, use ToString for creating the string xml nodes + + + + + Indicates that the custom action will run synchronously and the return code will not be checked. + + + + + Indicates that the custom action will run synchronously and the return code will be checked for success. This is the default. + + + + + Indicates that the custom action will run asynchronously but the installer will wait for the return code at sequence end. + + + + + Indicates that the custom action will run asyncronously and execution may continue after the installer terminates. + + + + + Used in CustomAction for determing the return type + + + + + Indicates that a custom action should be run a second time if it was previously run in an earlier sequence. + + + + + Indicates that a custom action will run in the rollback sequence when a failure occurs during installation, usually to undo changes made by a deferred custom action. + + + + + Indicates that the custom action will only run in the first sequence that runs it in the same process. + + + + + Indicates that the custom action will run during normal processing time with user privileges. This is the default. + + + + + Indicates that the custom action will only run in the first sequence that runs it. + + + + + Indicates that the custom action runs in-script (possibly with elevated privileges). + + + + + Indicates that the custom action will run after successful completion of the installation script (at the end of the installation). + + + + + Used in CustomAction for determing when to run the custom action + + + + + Type for defining, which program directory should be used for installation. ProgramFiles32 refers to 'Program Files (x86)', ProgramFiles64 refers to 'Program Files' + + + + + Components included in this feature + + + + + Nest sub features + + + + +Determines the initial display of this feature in the feature tree. This attribute's value should be one of the following: +collapse + Initially shows the feature collapsed. This is the default value. +expand + Initially shows the feature expanded. +hidden + Prevents the feature from displaying in the user interface. +<an explicit integer value> + For advanced users only, it is possible to directly set the integer value of the display value that will appear in the Feature row. + + + + + Longer string of text describing the feature. This localizable string is displayed by the Text Control of the Selection Dialog. + + + + + Sets the install level of this feature. A value of 0 will disable the feature. + Processing the Condition Table can modify the level value (this is set via the Condition child element). + The default value is "1". + + + + + Short string of text identifying the feature. + This string is listed as an item by the SelectionTree control of the Selection Dialog. + + + + + Unique identifier of the feature. + + + + + Parameters for creating WiX Feature, use ToString for creating the string xml nodes + + + + + Prevents the feature from displaying in the user interface. + + + + + Initially shows the feature expanded. + + + + + Initially shows the feature collapsed. This is the default value. + + + + + Used for determing whether the feature should be visible in the select features installer pane or not + + + + + WiX parameter type + + + + + Reference to a component for including it in a feature + + + + + WiX Directories define a logical directory which can include components and files + + + + + Component which wraps files into logical components and which allows to + + + + + Reference to a component for including it in a feature + + + + + You can nest child registry values here + + + + + You can nest child registry keys here + + + + + Set this attribute to 'yes' to remove the key with all its values and subkeys when the parent component is uninstalled + Note that this value is useful only if your program creates additional values or subkeys under this key and you want an uninstall to remove them + MSI already removes all values and subkeys that it creates, so this option just adds additional overhead to uninstall. The default is "no" + + + + + Set this attribute to 'yes' to create an empty key, if absent, when the parent component is installed + This value is needed only to create an empty key with no subkeys or values. + Windows Installer creates keys as needed to store subkeys and values. The default is "no" + + + + + The localizable key for the registry value + If the parent element is a RegistryKey, this value may be omitted to use the path of the parent, or if its specified it will be appended to the path of the parent + + + + + The predefined root key for the registry value + + + + + Primary key used to identify this particular entry + + + + + Parameters for WiX RegistryKey + + + + + The predefined root key for the registry value. + + + + + Set this attribute to 'yes' to make this registry key the KeyPath of the parent component + + + + + The localizable key for the registry value + If the parent element is a RegistryKey, this value may be omitted to use the path of the parent, or if its specified it will be appended to the path of the parent + + + + + The type of the desired registry key + + + + + The action that will be taken for this registry value + + + + + The localizable registry value. + + + + + The localizable registry value name. If this attribute is not provided the default value for the registry key will be set instead + + + + + The Id of this value + + + + + Parameters for WiX RegistryValue + + + + + The value is interpreted and stored as a multiple strings (REG_MULTI_SZ) + + + + + The value is interpreted and stored as an expandable string (REG_EXPAND_SZ) + + + + + The value is interpreted and stored as a hexadecimal value (REG_BINARY) + + + + + The value is interpreted and stored as an integer (REG_DWORD) + + + + + The value is interpreted and stored as a string (REG_SZ) + + + + + The desired type of a registry key. + + + + + Writes a registry value + + + + + Prepends the specified value(s) to a multiString registry value + + + + + Appends the specified value(s) to a multiString registry value + + + + + The action that will be taken for a registry value + + + + + Writes this registry key inside either the HKEY_USers registry root + + + + + Writes this registry key inside either the HKEY_LOCAL_MACHINE registry root + + + + + Writes this registry key inside either the HKEY_CURRENT_USER registry root + + + + + Writes this registry key inside either the HKEY_CLASSES_ROOT registry root + + + + + Writes this registry key inside either HKEY_LOCAL_MACHINE or HKEY_CURRENT_USER. Wix decides at install time based on wether or not this is an "all users" install + + + + + Represents the registry root under which this key should be written + + + + + Service configuration information for failure actions. + + + + + Services or groups of services that must start before the parent service. + + + + + The overall install should fail if this service fails to install. (Default: Yes) + + + + + [Required] The Windows Installer does not currently support kernelDriver or systemDriver. (Default: OwnProcess) + + + + + [Required] Determines when the service should be started. The Windows Installer does not support boot or system. (Default: Demand) + + + + + The password for the account. Valid only when the account has a password. + + + + + [Required] This column is the string that gives the service name to install. + + + + + The load ordering group that this service should be a part of. + + + + + Whether or not the service interacts with the desktop. + + + + + Unique identifier for this service configuration. This value will default to the Name attribute if not specified. + + + + + [Required] Determines what action should be taken on an error. (Default: Normal) + + + + + Determines whether the existing service description will be ignored. If 'yes', the service description will be null, even if the Description attribute is set. + + + + + This column is the localizable string that user interface programs use to identify the service. + + + + + Sets the description of the service. + + + + + Contains any command line arguments or properties required to run the service. + + + + + Fully qualified names must be used even for local accounts, e.g.: ".\LOCAL_ACCOUNT". Valid only when ServiceType is ownProcess. + + + + + Adds services for parent Component. Use the ServiceControl element to remove services. + + + + + Set to 'yes' to indicate that the value in the Id attribute is the name of a group of services. + + + + + [Required] The value of this attribute should be one of the following: + 1. The name (not the display name) of a previously installed service. + 2. The name of a service group (in which case the Group attribute must be set to 'yes'). + + + + + Service or group of services that must start before the parent service. + + + + + [Required] Action to take on the third failure of the service. + + + + + Required if not under a ServiceInstall element. + + + + + [Required] Action to take on the second failure of the service. + + + + + If any of the three *ActionType attributes is "restart", this specifies the number of seconds to wait before doing so. + + + + + Number of days after which to reset the failure count to zero if there are no failures. + + + + + If any of the three *ActionType attributes is "reboot", this specifies the message to broadcast to server users before doing so. + + + + + If any of the three *ActionType attributes is "runCommand", this specifies the command to run when doing so. This value is formatted. + + + + + [Required] Determines the type of the service failure action. + + + + + Service configuration information for failure actions. + + + + + Determines the type of the service failure action. + + + + + A file system driver service. This value is not currently supported by the Windows Installer. + + + + + A kernel driver service. This value is not currently supported by the Windows Installer. + + + + + A Win32 service that shares a process. + + + + + A Win32 service that runs its own process. + + + + + Determines the type of the service. The Windows Installer does not currently support kernelDriver or systemDriver. + + + + + The service is a device driver that will be started by the IoInitSystem function. This value is not currently supported by the Windows Installer. + + + + + The service is a device driver that will be started by the operating system boot loader. This value is not currently supported by the Windows Installer. + + + + + The service can no longer be started. + + + + + The service will start when the service control manager calls the StartService function. + + + + + The service will start during startup of the system. + + + + + Determines when the service should be started. The Windows Installer does not support boot or system. + + + + + Logs the error if it is possible and the system is restarted with the last configuration known to be good. If the last-known-good configuration is being started, the startup operation fails. + + + + + Logs the error, displays a message box and continues the startup operation. + + + + + Logs the error and continues with the startup operation. + + + + + Determines what action should be taken on an error. + + + + + Service Control Element. Can Start, Stop and Remove services + + + + + These are used in many methods for generating WiX nodes, regard them as booleans + + + + + Specifies whether an action occur on install, uninstall or both. + + + + + File Architecture, either X64 or X86, defaults to X64 + + + + + File Path in WiX definition + + + + + File Name in WiX definition + + + + + File Id in WiX definition + + + + + WiX File Element + + + + + Harvests the contents of a Directory for use with Wix using the [Heat](http://wixtoolset.org/documentation/manual/v3/overview/heat.html) tool. + ## Parameters + - `setParams` - Function used to manipulate the Heat default parameters. + - `directory` - The path to the directory that will be harvested by Heat. + - `outputFile` - The output file path given to Heat. + + + + + + Default values for the Heat harvesting + + + + + Uses the WiX tools [Candle](http://wixtoolset.org/documentation/manual/v3/overview/candle.html) and [Light](http://wixtoolset.org/documentation/manual/v3/overview/light.html) to create an msi. + ## Parameters + - `setParams` - Function used to manipulate the WiX default parameters. + - `outputFile` - The msi output file path (given to Light). + - `wixScript` - The path to a WiX script that will be used with Candle. + + ## Sample + Target "BuildSetup" (fun _ -> + // Copy all important files to the deploy directory + !! (buildDir + "/**/*.dll") + ++ (buildDir + "/**/*.exe") + ++ (buildDir + "/**/*.config") + |> Copy deployPrepDir + + // replace tags in a template file in order to generate a WiX script + let ALLFILES = fun _ -> true + + let replacements = [ + "@build.number@",if not isLocalBuild then buildVersion else "0.1.0.0" + "@product.productcode@",System.Guid.NewGuid().ToString() + "@HelpFiles@",getFilesAsWiXString helpFiles + "@ScriptFiles@",getFilesAsWiXString scriptFiles + "@icons@",getWixDirTag ALLFILES true (directoryInfo(bundledDir @@ "icons"))] + + processTemplates replacements setupFiles + + // run the WiX tools + WiX (fun p -> {p with ToolDirectory = WiXPath}) + setupFileName + (setupBuildDir + "Setup.wxs.template") + ) + + + + + Runs the [Light tool](http://wixtoolset.org/documentation/manual/v3/overview/light.html) on the given WiX script with the given parameters + + + + + Runs the [Candle tool](http://wixtoolset.org/documentation/manual/v3/overview/candle.html) on the given WiX script with the given parameters + + + + + Generates a major upgrade based on the given parameters, use toString on it when embedding it + ## Parameters + - `setParams` - Function used to manipulate the WiX default parameters. + + ## Sample + let majorUpgradeVersion = generateMajorUpgradeVersion(fun f -> + {f with + DowngradeErrorMessage = "A later version is already installed, exiting." + }) + + + + + Generates an upgrade version based on the given parameters, use toString on it when embedding it + ## Parameters + - `setParams` - Function used to manipulate the WiX default parameters. + + ## Sample + let upgradeVersion = generateUpgradeVersion (fun f -> + {f with + Minimum = productVersion + OnlyDetect = "yes" + }) + + + + + Generates an upgrade based on the given parameters, use toString on it when embedding it + ## Parameters + - `setParams` - Function used to manipulate the WiX default parameters. + + ## Sample + let upgrade = generateUpgrade (fun f -> + {f with + Id = productUpgradeCode + }) + + + + + Generates a ui ref based on the given parameters, use toString on it when embedding it + ## Parameters + - `setParams` - Function used to manipulate the WiX default parameters. + + ## Sample + let UIRef = generateUIRef (fun f -> + {f with + Id = "WixUI_Mondo" + }) + + + + + Generates a custom action execution based on the given parameters, use toString on it when embedding it + Condition in sample makes execute only on install + ## Parameters + - `setParams` - Function used to manipulate the WiX default parameters. + + ## Sample + let actionExecution = generateCustomActionExecution (fun f -> + {f with + ActionId = action.Id + Verb = "After" + Target = "InstallFiles" + Condition = "<![CDATA[(&" + feature.Id + " = 3) AND NOT (!" + feature.Id + " = 3)]]>" + }) + + + + + Generates a customAction based on the given parameters, use toString on it when embedding it + Be careful to make Id unique. FileKey is a reference to a file Id which you added by using getWixDirTag or getWixFileTag + Set impersonate to no if your action needs elevated privileges, you should then also set execute as "deferred" + ExeCommand are the parameters passed to your executable + ## Parameters + - `setParams` - Function used to manipulate the WiX default parameters. + + ## Sample + let action = generateCustomAction (fun f -> + {f with + Id = "UniqueActionId" + FileKey = "fi_5" + Execute = "deferred" + Impersonate = "no" + ExeCommand = "install" + Return = "check" + }) + + + + + Generates a feature based on the given parameters, use toString on it when embedding it + You can pass other features into InnerContent for making a hierarchy + ## Parameters + - `setParams` - Function used to manipulate the WiX default parameters. + + ## Sample + let feature = generateFeatureElement (fun f -> + {f with + Id = "UniqueName" + Title = "Title which is shown" + Level = 1 + Description = "Somewhat longer description" + Display = "expand" + InnerContent = [otherFeature1; otherFeature2] + }) + + + + + Takes path where script files reside and sets all parameters as defined + ## Parameters + - `wiXPath` - Pass path where your script is located at. Function will search for all Scripts in that location and fill in parameters + - `setParams` - Function used to manipulate the WiX default parameters. + + ## Sample + fillInWiXTemplate "" (fun f -> + {f with + ProductCode = WiXProductCode + ProductName = WiXProductName + Description = projectDescription + ProductLanguage = WiXProductLanguage + ProductVersion = WiXProductVersion + ProductPublisher = WixProductPublisher + UpgradeGuid = WixProductUpgradeGuid + UIRefs = uiRef1.ToString() + uiRef2.ToString() + WiXVariables = wiXLicense.ToString() + Directories = directories + DirectoryRefs = directoryrefs + BuildNumber = "1.0.0" + Features = rootFeature.ToString() + CustomActions = action1.ToString() + action2.ToString() + ActionSequences = actionExecution1.ToString() + actionExecution2.ToString() + }) + + + + + Generates WiX Template with specified file name (you can prepend location too) + You need to run this once every build an then use fillInWiXScript to replace placeholders + ## Parameters + - `fileName` - Pass desired fileName for your wiXScript file + + ## Sample + generateWiXScript "Setup.wxs" + + + + + Default values for WiX Script properties + + + + + Default value for WiX Variable + + + + + Default value for WiX Major Upgrade + + + + + Default value for WiX Upgrade + + + + + Default value for WiX Upgrade + + + + + Default value for WiX UI Reference (WixUI_Minimal) + + + + + Default values for WiX custom action executions + + + + + Default values for WiX custom actions + + + + + Default values for creating WiX Feature + + + + + Contains the WiX default parameters + + + + + Take a component string and set "neverOverwrite" Tag + This is useful for config files, since they are not replaced on upgrade like that + + + + + Creates WiX ComponentRef tags from the given DirectoryInfo + + + + + Retrieves all component ids from given WiX directory string + ## Parameters + - `wiXString` - The directory string which was generated by getWixDirTag + + ## Sample + let directoryString = getWixDirTag (fun file -> true) true (DirectoryInfo directoryWithFilesForSetup) + let componentIds = getComponentIdsFromWiXString directoryString + + + + + Retrieves the file id of the first file in WiXString, which name matches fileRegex + ## Parameters + - `wiXString` - The directory string which was generated by getWixDirTag + - `fileRegex` - Regex which matches the file name + + ## Sample + let directoryString = getWixDirTag (fun file -> true) true (DirectoryInfo directoryWithFilesForSetup) + let executableFileId = getFileIdFromWiXString directoryString "\S*.exe" + + + + + Creates recursive WiX directory and file tags from the given DirectoryInfo + The function will create one component for each file [best practice](https://support.microsoft.com/de-de/kb/290997/en-us) + and set the GUID to "*", which will make WiX produce consistent Component Guids if the Component's target path doesn't change. + This is vital for major upgrades, since windows installer needs a consistent component guid for tracking each of them. + You can use the getComponentIdsFromWiXString function for getting all created component refs and adding them to features. + + + + + Use this to attach service installs to your components. + + + + + Creates WiX component with directories and files from the given DirectoryInfo + The function will create one component for each file [best practice](https://support.microsoft.com/de-de/kb/290997/en-us) + and set the GUID to "*", which will make WiX produce consistent Component Guids if the Component's target path doesn't change. + This is vital for major upgrades, since windows installer needs a consistent component guid for tracking each of them. + The components are embedded into the passed in root directory. + + + + + Creates WiX component with directories and files from the given DirectoryInfo + The function will create one component for each file [best practice](https://support.microsoft.com/de-de/kb/290997/en-us) + and set the GUID to "*", which will make WiX produce consistent Component Guids if the Component's target path doesn't change. + This is vital for major upgrades, since windows installer needs a consistent component guid for tracking each of them. + You can use the getComponentIdsFromWiXString function for getting all created component refs and adding them to features. + + + + + Creates a WiX directory and component hierarchy from the given DirectoryInfo + The function will create one component for each file [best practice](https://support.microsoft.com/de-de/kb/290997/en-us) + and set the GUID to "*", which will make WiX produce consistent Component Guids if the Component's target path doesn't change. + This is vital for major upgrades, since windows installer needs a consistent component guid for tracking each of them. + You can use the getComponentRefs function for getting all created component refs and adding them to features. + You can use attachServiceControlToComponents or attachServiceInstallToComponents to attach ServiceControl or ServiceInstall to the directory component hierarchy + + + + + Calculates the SHA1 for a given string. + + + + + Use this for generating directories + + + + + Defaults for directories + + + + + Use this for generating single components + + + + + Defaults for component + + + + +get component refs from a directory component hierarchy + + + + + Use this for generating component refs + + + + + Defaults for component ref + + + + + Use this for generating component refs + + + + + Defaults for component ref + + + + + Generates a registry key based on the given parameters, use toString on it when embedding it + You can pass other registry keys and values into RegistryKeys or RegistryValues for making a hierarchy + ## Parameters + - `setParams` - Function used to manipulate the WiX default parameters. + + ## Sample + let key = generateRegistryKey(fun k -> + {k with + Id = "KeyId" + Key = "SomeKey" + Root = Some RegistryRootType.HKCR + ForceCreateOnInstall = YesOrNo.Yes + ForceDeleteOnUninstall = YesOrNo.No + Keys = someChildKeys + Values = someChildValues + }) + + + + + Generates a registry value based on the given parameters, use toString on it when embedding it + ## Parameters + - `setParams` - Function used to manipulate the WiX default parameters. + + ## Sample + let registryValue = generateRegistryValue(fun v -> + {v with + Id = "asdasd" + Name = "Something" + Key = "Somewhere" + Root = Some RegistryRootType.HKU + Type = RegistryValueType.Integer + KeyPath = YesOrNo.No + Value = "2" + }) + + + + + Use this for generating service installs + + + + + Defaults for service install element + + + + + Use this for generating service dependencies + + + + + Use this for generating service configs + + + + + Use this for generating service controls + + + + + Defaults for service control element + + + + + Defaults for WiX file + + + + + Creates WiX File tags from the given files + + + + + Creates a WiX File tag from the given FileInfo + + + + + Contains tasks to create msi installers using the [WiX toolset](http://wixtoolset.org/) + + + + + Represents options for configuring the emission of AssemblyInfo + + + + + corresponds to the msbuild option '/dl' + + + + + corresponds to the msbuild option '/l' + + + + + corresponds to the msbuild option '/bl' + + + + + corresponds to the msbuild option '/fl' + + + + + Fake attaches a binlog-logger in order to report errors and warnings. You can disable this behavior with this flag + + + + + corresponds to the msbuild option '/consoleloggerparameters' + + + + + Execute a restore before executing the targets (/restore flag) + + + + + corresponds to the msbuild option '/m': + - 'None' will omit the option. + - 'Some None' will emit '/m'. + - 'Some 2' will emit '/m:2'. + + + + + Set the MSBuild executable to use. Defaults to the latest installed MSBuild. + + + + + Sets the current environment variables. + + + + + Defines a default for MSBuild task parameters + + + + + A type for MSBuild task parameters + + + + + A type for MSBuild configuration + + + + + Other currently not supported parameter. + + + + + Enable the multiprocessor logging style even when running in non-multiprocessor mode. This logging style is on by default. + + + + + Disable the multiprocessor logging style of output when running in non-multiprocessor mode. + + + + + Undocumented switch to force ansi colors. + + + + + Use the default console colors for all logging messages. + + + + + Don't align the text to the size of the console buffer. + + + + + Show the event ID for each started event, finished event, and message. + + + + + Show the timestamp as a prefix to any message. + + + + + Show `TaskCommandLineEvent` messages. + + + + + Don't show the list of items and properties that would appear at the start of each project build if the verbosity level is set to `diagnostic`. + + + + + Show only warnings. + + + + + Show only errors. + + + + + Don't show the error and warning summary at the end. + + + + + Show the error and warning summary at the end. + + + + + Show the time that’s spent in tasks, targets, and projects. + + + + + Determines whether the build log is appended to the log file or overwrites it. When you set the switch, the build log is appended to the log file. When the switch is not present, the contents of an existing log file are overwritten. + If you include the append switch, no matter whether it is set to true or false, the log is appended. If you do not include the append switch, the log is overwritten. + + + + + MSBuild log option + See https://docs.microsoft.com/de-de/visualstudio/msbuild/msbuild-command-line-reference?view=vs-2015 + + + + + MSBuild verbosity option + + + + + A type to represent MSBuild project files. + + + + + An exception type to signal build errors. + + + + + Update a set of attributes in an AssemblyInfo file. Fails if any attribute is not found. + ## Parameters + - `assemblyInfoFile` - The file to update. Language C#, F#, VB or C++ is determined from the extension. + - `attributes` - The Attributes that should be updated matched on Name (Namespace is not used). + + + + + Read the value of a single attribute from an AssemblyInfo file. Note that string values are returned with surrounding "". + ## Parameters + - `attrName` - Name of the attribute without "Attribute" at the end. + - `assemblyInfoFile` - The file to read from. Language C#, F#, VB or C++ is determined from the extension. + + + + + Read a single attribute from an AssemblyInfo file. + ## Parameters + - `attrName` - Name of the attribute without "Attribute" at the end. + - `assemblyInfoFile` - The file to read from. Language C#, F#, VB or C++ is determined from the extension. + + + + + Read attributes from an AssemblyInfo file and return as a sequence of Attribute. + ## Parameters + - `assemblyInfoFile` - The file to read attributes from. Language C#, F#, VB or C++ is determined from the extension. + + + + + Creates an AssemblyInfo file based in the correct langugage based on the file name with the given attributes and configuration. + The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly. + + + + + Creates a C++/CLI AssemblyInfo file with the given attributes. + + + + + Creates a VB AssemblyInfo file with the given attributes. + The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly. + + + + + Creates a F# AssemblyInfo file with the given attributes. + The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly. + + + + + Creates a C# AssemblyInfo file with the given attributes. + The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly. + + + + + Creates a C++/CLI AssemblyInfo file with the given attributes and configuration. + Does not generate an AssemblyVersionInformation class. + + + + + Creates a VB AssemblyInfo file with the given attributes and configuration. + The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly. + + + + + Creates a F# AssemblyInfo file with the given attributes and configuration. + The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly. + + + + + Creates a C# AssemblyInfo file with the given attributes and configuration. + The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly. + + + + + Represents AssemblyInfo attributes + + + + + Create an attribute which specifies metadata about the assembly + + + + + Creates an attribute which specifies if the assembly uses delayed signing + + + + + Creates an attribute which specifies if the assembly is CLS compliant + + + + + Creates an attribute which specifies if the assembly is visible via COM + + + + + Creates an attribute which holds the Guid + + + + + Creates an attribute which holds an assembly information version + + + + + Creates an attribute which holds the assembly file version + + + + + Creates an attribute which holds the "InternalVisibleTo" data + + + + + Creates an attribute which holds the assembly key name + + + + + Creates an attribute which holds the assembly key file + + + + + Creates an attribute which holds the assembly version + + + + + Creates an attribute which holds the trademark + + + + + Creates an attribute which holds the assembly configuration + + + + + Creates an attribute which holds the assembly culture information + + + + + Creates an attribute which holds the product description + + + + + Creates an attribute which holds the product title + + + + + Creates an attribute which holds the copyright information + + + + + Creates an attribute which holds the product name + + + + + Creates an attribute which holds the company information + + + + + Creates a simple attribute with boolean values. Used as base for other attributes + + + + + Creates a simple attribute with string values. Used as base for other attributes + + + + + corresponds to the msbuild option '/dl' + + + + + corresponds to the msbuild option '/l' + + + + + corresponds to the msbuild option '/consoleloggerparameters' + + + + + corresponds to the msbuild option '/bl' + + + + + corresponds to the msbuild option '/fl' + + + + + Fake attaches a binlog-logger in order to report errors and warnings. You can disable this behavior with this flag + + + + + Execute a restore before executing the targets (/restore flag) + + + + + corresponds to the msbuild option '/m': + - 'None' will omit the option. + - 'Some None' will emit '/m'. + - 'Some 2' will emit '/m:2'. + + + + + A type for MSBuild task parameters + + + + + Builds the given web project files with debug configuration and copies them to the given websiteDir. + ## Parameters + - `outputPath` - The output path. + - `projectFiles` - The project file paths. + + + + + Builds the given web project files in specified configuration and copies them to the given outputPath. + ## Parameters + - `setParams` - A function that overwrites the default MSBuildParams + - `outputPath` - The output path. + - `configuration` - MSBuild configuration. + - `projectFiles` - The project file paths. + + + + + Builds the given web project file with debug configuration and copies it to the given outputPath. + ## Parameters + - `outputPath` - The output path. + - `projectFile` - The project file path. + + + + + Builds the given web project file in the specified configuration and copies it to the given outputPath. + ## Parameters + - `setParams` - A function that overwrites the default MSBuildParams + - `outputPath` - The output path. + - `configuration` - MSBuild configuration. + - `projectFile` - The project file path. + + + + + Builds the given project files or solution files in release mode and collects the output files. + ## Parameters + - `setParams` - A function that overwrites the default MSBuildParams + - `outputPath` - If it is null or empty then the project settings are used. + - `properties` - A list with tuples of property name and property values. + - `targets` - A string with the target names which should be run by MSBuild. + - `projects` - A list of project or solution files. + + + + + Builds the given project files or solution files in release mode to the default outputs. + ## Parameters + - `targets` - A string with the target names which should be run by MSBuild. + - `projects` - A list of project or solution files. + + + + + Builds the given project files or solution files and collects the output files. + ## Parameters + - `setParams` - A function that overwrites the default MSBuildParams + - `outputPath` - If it is null or empty then the project settings are used. + - `targets` - A string with the target names which should be run by MSBuild. + - `projects` - A list of project or solution files. + + + + + Builds the given project files or solution files and collects the output files. + ## Parameters + - `setParams` - A function that overwrites the default MSBuildParams + - `outputPath` - If it is null or empty then the project settings are used. + - `targets` - A string with the target names which should be run by MSBuild. + - `projects` - A list of project or solution files. + + + + + Builds the given project files or solution files and collects the output files. + ## Parameters + - `setParams` - A function that overwrites the default MSBuildParams + - `outputPath` - If it is null or empty then the project settings are used. + - `targets` - A string with the target names which should be run by MSBuild. + - `properties` - A list with tuples of property name and property values. + - `projects` - A list of project or solution files. + + + + + Builds the given project files and collects the output files. + ## Parameters + - `setParams` - A function that overwrites the default MSBuildParams + - `outputPath` - If it is null or empty then the project settings are used. + - `targets` - A string with the target names which should be run by MSBuild. + - `properties` - A list with tuples of property name and property values. + - `projects` - A list of project or solution files. + + + + + Runs a MSBuild project + ## Parameters + - `setParams` - A function that overwrites the default MSBuildParams + - `project` - A string with the path to the project file to build. + + ## Sample + + open Fake.DotNet + let buildMode = Environment.environVarOrDefault "buildMode" "Release" + let setParams (defaults:MSBuildParams) = + { defaults with + Verbosity = Some(Quiet) + Targets = ["Build"] + Properties = + [ + "Optimize", "True" + "DebugSymbols", "True" + "Configuration", buildMode + ] + } + MSBuild.build setParams "./MySolution.sln" + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + Tries to detect the right version of MSBuild. + + - On all OS's, we check a `MSBuild` environment variable which is either + * a direct path to a file to use, or + * a directory that contains a file called + * `msbuild` on non-Windows systems with mono >= 5.0.0.0, or + * `xbuild` on non-Windows systems with mono < 5.0.0.0, + * `MSBuild.exe` on Windows systems, or + * a tool that exists on the current PATH + - In addition, on non-Windows systems we check the current PATH for the following binaries, in this order: + * Mono >= 5.0.0.0: `msbuild`, `xbuild` + * Mono < 5.0.0.0: `xbuild`, `msbuild` + * This is due to several known issues in the Mono < 5.0 implementation of MSBuild. + - In addition, on Windows systems we + * try to read the MSBuild tool location from the AppSettings file using a parameter named `MSBuild`, and finally + * if a `VisualStudioVersion` environment variable is specified, we try to use the specific MSBuild version, matching that Visual Studio version. + + + + + Versions of Mono prior to this one have faulty implementations of MSBuild + NOTE: in System.Version 5.0 >= 5.0.0.0 is false while 5.0.0.0 >= 5.0 is true... + + + + + Specifies how often nuget should try to restore the packages - default is 5 + + + + + RestorePackages parameter path for single packages + + + + + Specifies how often nuget should try to restore the packages - default is 5 + + + + + RestorePackages parameter path + + + + + RestorePackages Verbosity settings + + + + + Restores the packages in the given solution file file from NuGet. + ## Parameters + + - `setParams` - Function used to manipulate the default NuGet parameters. + - `solutionFile` - The microsoft sln file name. + + ## Sample + + Target "RestorePackages" (fun _ -> + "./src/Everything.sln" + |> RestoreMSSolutionPackages (fun p -> + { p with + Sources = "http://myNugetSources.com" :: p.Sources + OutputPath = outputDir + Retries = 4 }) + ) + + + + + Restores all packages from NuGet to the default directories by scanning for packages.config files in any subdirectory. + + + + + Restores the packages in the given packages.config file from NuGet. + ## Parameters + + - `setParams` - Function used to manipulate the default NuGet parameters. + - `packageFile` - The packages.config file name. + + ## Sample + + Target "RestorePackages" (fun _ -> + "./src/ProjectA/packages.config" + |> RestorePackage (fun p -> + { p with + Sources = "http://myNugetSources.com" :: p.Sources + OutputPath = outputDir + Retries = 4 }) + ) + + + + + Restores the given package from NuGet + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + RestoreSinglePackageParams defaults parameters + + + + + RestorePackage defaults parameters + + + + + Looks for NuGet.exe in [1] the specified defaultPath, [2] a list of standard tool folders, [3] any subfolder in the current directory, [4] the PATH - returns the first path where NuGet.exe was found. + + + + + Contains tasks which allow to restore NuGet packages from a NuGet package feed like [nuget.org](http://www.nuget.org). + There is also a tutorial about [nuget package restore](../nuget.html) available. + + + + + NuSpec metadata type + + + + + Number of times to retry pushing the package + + + + + Specifies the timeout for pushing to a server. + + + + + Specifies the symbol server URL. + + + + + The API key for the symbol server. + + + + + Specifies the server URL. This option is required unless DefaultPushSource config value is set in the NuGet config file. + + + + + Doesn't append "api/v2/package" to the source URL. + + + + + Doesn't push symbols (even if present). + + + + + The API key for the server + + + + + Disables buffering when pushing to an HTTP(S) server to reduce memory usage. + + + + + dotnet nuget push command options + + + + + Nuget parameter type + + + + + Build a symbol package using the nuspec file + + + + + Build a symbol package using a project file, if provided + + + + + Do not build symbol packages + + + + + Returns the dependencies from specified packages.config file + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + Default NuGet feed + + + + + Parses nuspec metadata from a nuspec file. + ## Parameters + + - `nuspec` - The .nuspec file content. + + + + + Creates a new NuGet package, and optionally publishes it. + Template parameter substitution is performed when passing a .nuspec + ## Parameters + + - `setParams` - Function used to manipulate the default NuGet parameters. + - `nuspecOrProjectFile` - The .nuspec file name. + + + + + Publishes a NuGet package to the nuget server. + ## Parameters + + - `setParams` - Function used to manipulate the default NuGet parameters. + + + + + Creates a new NuGet package based on the given .nuspec or project file. + Template parameter substitution is performed when passing a .nuspec + ## Parameters + + - `setParams` - Function used to manipulate the default NuGet parameters. + - `nuspecOrProjectFile` - The .nuspec or project file name. + + + + + Creates a new NuGet package based on the given .nuspec or project file. + The .nuspec / projectfile is passed as-is (no templating is performed) + ## Parameters + + - `setParams` - Function used to manipulate the default NuGet parameters. + - `nuspecOrProjectFile` - The .nuspec or project file name. + + + + + push package to symbol server (and try again if something fails) + + + + + Creates a NuGet package without templating (including symbols package if enabled) + + + + + Gets the version no. for a given package in the deployments folder + + + + + Creates a string which tells NuGet that you require exactly this package version. + + + + + NuGet default parameters + + + + + Contains helper functions and task which allow to inspect, create and publish [NuGet](https://www.nuget.org/) packages. + There is also a tutorial about [nuget package creating](../create-nuget-package.html) available. + + + + + NuGet configuration file. Default `None`. + + + + + Do not prompt for user input or confirmations. Default `true`. + + + + + Allows updating to prerelease versions. Default `false`. + + + + + Show verbose output while updating. Default `false`. + + + + + Looks for updates with the highest version available within the same major and minor version as the installed package. Default `false`. + + + + + Folder to store packages in. Default `./packages`. + + + + + Version to update to. Default `None`. Used to upgrade/downgrade to a explicit version of a package. + + + + + Packages to update. Update all if empty. + + + + + Nuget feeds to search updates in. Use default if empty. + + + + + Number of retries if update fails. + + + + + Timeout for the update. + + + + + Path to the nuget.exe. + + + + + Nuget update parameters. + + + + + Update packages specified in the package file. + + Fails if packages are not installed; see [nuget bug](https://nuget.codeplex.com/workitem/3874). + Fails if packages file has no corresponding VS project; see [nuget bug](https://nuget.codeplex.com/workitem/3875). + ## Parameters + + - `setParams` - Function used to manipulate the default parameters. + - `packagesFile` - Path to the `*.sln`, `*.*proj` or `packages.config` file. + + + + + [omit] + + + + + Parameter default values. + + + + + Contains tasks for updating NuGet packages including assembly hint paths in the project files using the [nuget.exe update command](http://docs.nuget.org/docs/reference/command-line-reference#Update_Command). + + + + + NuGet configuration file. Default `None`. + + + + + Disable looking up packages from local machine cache. Default `false`. + + + + + Do not prompt for user input or confirmations. Default `true`. + + + + + Display this amount of details in the output: normal, quiet, detailed. Default `normal`. + + + + + Specifies the directory in which packages will be installed. Default `./packages/`. + + + + + Allows updating to prerelease versions. Default `false`. + + + + + If set, the destination directory will contain only the package name, not the version number. Default `false`. + + + + + The version of the package to install. + + + + + Nuget feeds to search updates in. Use default if empty. + + + + + Number of retries if update fails. + + + + + Timeout for the update. + + + + + Path to the nuget.exe. + + + + + Nuget install parameters. + + + + + Nuget install verbosity mode. + + + + + Installs the given package. + + ## Parameters + + - `setParams` - Function used to manipulate the default parameters. + - `packagesFile` - Path to the `*.sln`, `*.*proj` or `packages.config` file, or simply a NuGet package name + + + + + [omit] + + + + + [omit] + + + + + Parameter default values. + + + + + Contains tasks for installing NuGet packages using the [nuget.exe install command](http://docs.nuget.org/docs/reference/command-line-reference#Install_Command). + + + + + Default arguments to compute next NuGet version number + + + + + Arguments for the next NuGet version number computing + + + + + Compute next NuGet version number + + + + + Retrieve current NuGet version number + + + + + Increment major version + + + + + Increment minor version + + + + + Increment patch version + + + + + nuget push paramters for `dotnet nuget push` + + + + + Other msbuild specific parameters + + + + + Runs the tests in blame mode. This option is helpful in isolating the problematic tests causing test host to crash. It creates an output file in the current directory as Sequence.xml that captures the order of tests execution before the crash. (--blame) + + + + + Arguments to pass runsettings configurations through commandline. Arguments may be specified as name-value pair of the form [name]=[value] after "-- ". Note the space after --. + + + + + Does not do an implicit restore when executing the command. (--no-restore) + + + + + Enables data collector for the test run. More info here : https://aka.ms/vstest-collect (--collect) + + + + + The directory where the test results are going to be placed. The specified directory will be created if it does not exist. (--results-directory) + + + + + Do not build project before testing. (--no-build) + + + + + Enable verbose logs for test platform. Logs are written to the provided file. (--diag) + + + + + Directory in which to find the binaries to be run (--output) + + + + + Target framework to publish for. The target framework has to be specified in the project file. (--framework) + + + + +Configuration to use for building the project. Default for most projects is "Debug". (--configuration) + + + + + Specify a logger for test results. (--logger) + + + + + Use custom adapters from the given path in the test run. (--test-adapter-path) + + + + + Run tests that match the given expression. (--filter) + Examples: + Run tests with priority set to 1: --filter "Priority = 1" + Run a test with the specified full name: --filter "FullyQualifiedName=Namespace.ClassName.MethodName" + Run tests that contain the specified name: --filter "FullyQualifiedName~Namespace.Class" + More info on filtering support: https://aka.ms/vstest-filtering + + + + + Lists discovered tests (--list-tests) + + + + + Settings to use when running tests (--settings) + + + + + Common tool options + + + + + Gets the current environment + + + + + Sets a value indicating whether the output for the given process is redirected. + + + + + Sets the current environment variables. + + + + + Changes the "Common" properties according to the given function + + + + + Parameter default values. + + + + + dotnet test command options + + + + + Other msbuild specific parameters + + + + + Doesn't execute an implicit restore during build. (--no-restore) + + + + + Native flag (--native) + + + + + Output path (--output) + + + + + Build base path (--build-base-path) + + + + + Target runtime to publish for (--runtime) + + + + + Target framework to compile for (--framework) + + + + + Pack configuration (--configuration) + + + + + Common tool options + + + + + Gets the current environment + + + + + Sets a value indicating whether the output for the given process is redirected. + + + + + Sets the current environment variables. + + + + + Changes the "Common" properties according to the given function + + + + + Parameter default values. + + + + + dotnet build command options + + + + + Other msbuild specific parameters + + + + + Force all dependencies to be resolved even if the last restore was successful. + This is equivalent to deleting project.assets.json. (--force) + + + + + Doesn't execute an implicit restore when running the command. (--no-restore) + + + + + No build flag (--no-build) + + + + + Publish the .NET Core runtime with your application so the runtime doesn't need to be installed on the target machine. + The default is 'true' if a runtime identifier is specified. (--self-contained) + + + + + Specifies one or several target manifests to use to trim the set of packages published with the app. + The manifest file is part of the output of the dotnet store command. + This option is available starting with .NET Core 2.0 SDK. (--manifest) + + + + + Defines what `*` should be replaced with in version field in project.json (--version-suffix) + + + + + Output path (--output) + + + + + Build base path (--build-base-path) + + + + + Target runtime to publish for (--runtime) + + + + + Target framework to compile for (--framework) + + + + + Pack configuration (--configuration) + + + + + Common tool options + + + + + Gets the current environment + + + + + Sets a value indicating whether the output for the given process is redirected. + + + + + Sets the current environment variables. + + + + + Changes the "Common" properties according to the given function + + + + + Parameter default values. + + + + + dotnet publish command options + + + + + Other msbuild specific parameters + + + + + Doesn't execute an implicit restore when running the command. (--no-restore) + + + + + No build flag (--no-build) + + + + + Output path (--output) + + + + + Build base path (--build-base-path) + + + + + Version suffix to use + + + + + Pack configuration (--configuration) + + + + + Common tool options + + + + + Gets the current environment + + + + + Sets a value indicating whether the output for the given process is redirected. + + + + + Sets the current environment variables. + + + + + Changes the "Common" properties according to the given function + + + + + Parameter default values. + + + + + dotnet pack command options + + + + + Convert the build configuration to a string that can be passed to the .NET CLI + + + + + build configuration + + + + + Other msbuild specific parameters + + + + + Disables restoring multiple projects in parallel (--disable-parallel) + + + + + Only warning failed sources if there are packages meeting version requirement (--ignore-failed-sources) + + + + + No cache flag (--no-cache) + + + + + Path to the nuget configuration file (nuget.config). + + + + + Directory to install packages in (--packages). + + + + + Nuget feeds to search updates in. Use default if empty. + + + + + The runtime to restore for (seems added in RC4). Maybe a bug, but works. + + + + + Common tool options + + + + + Gets the current environment + + + + + Sets a value indicating whether the output for the given process is redirected. + + + + + Sets the current environment variables. + + + + + Changes the "Common" properties according to the given function + + + + + Parameter default values. + + + + + dotnet restore command options + + + + + Common tool options + + + + + Gets the current environment + + + + + Sets a value indicating whether the output for the given process is redirected. + + + + + Changes the "MSBuildParams" properties according to the given function + + + + + Sets the current environment variables. + + + + + Changes the "Common" properties according to the given function + + + + + Parameter default values. + + + + + dotnet restore command options + + + + + dotnet info result + + + + + Common tool options + + + + + Gets the current environment + + + + + Sets a value indicating whether the output for the given process is redirected. + + + + + Sets the current environment variables. + + + + + Changes the "Common" properties according to the given function + + + + + Parameter default values. + + + + + dotnet --version command options + + + + + Common tool options + + + + + dotnet info result + + + + + Common tool options + + + + + Gets the current environment + + + + + Sets a value indicating whether the output for the given process is redirected. + + + + + Sets the current environment variables. + + + + + Changes the "Common" properties according to the given function + + + + + Parameter default values. + + + + + dotnet --info command options + + + + + Gets the environment variables that apply to this process and its child processes. + NOTE: Recommendation is to not use this Field, but instead use the helper function in the Proc module (for example Process.setEnvironmentVariable) + NOTE: This field is ignored when UseShellExecute is true. + + + + + If RedirectOutput is true this flag decides if FAKE emits the output into the standard output/error otherwise the flag is ignored. + True by default. + + + + + If true the function will redirect the output of the called process (but will disable colors, false by default) + + + + + Restore logging verbosity (--diagnostics) + + + + + Logging verbosity (--verbosity) + + + + + Custom parameters + + + + + Command working directory + + + + + Write a global.json with the given version (required to make SDK choose the correct version) + + + + + DotNet cli executable path + + + + + Sets a value indicating whether the output for the given process is redirected. + + + + + Sets a value indicating whether the redirected output should be printed to standard-output/error stream. + + + + + Sets the current environment variables. + + + + + Changes the "Common" properties according to the given function + + + + + Create a default setup for executing the `dotnet` command line. + This function tries to take current `global.json` into account and tries to find the correct installation. + To overwrite this behavior set `DotNetCliPath` manually (for example to the first result of `ProcessUtils.findFilesOnPath "dotnet"`) + + + + + dotnet cli command execution options + + + + + dotnet restore verbosity + + + + + Do not update path variable + + + + + If set it will not perform installation but instead display what command line to use + + + + + Include symbols in the installation (Switch does not work yet. Symbols zip is not being uploaded yet) + + + + + Architecture + + + + + Always download and run the installer, ignore potentiall existing installations. + + + + + Custom installation directory (for local build installation) + + + + + .NET Core SDK version + + + + + Specifies the source channel for the installation. The possible values are: + - `Current` - Most current release. + - `LTS` - Long-Term Support channel (most current supported release). + - Two-part version in `X.Y` format representing a specific release (for example, `2.0` or `1.0`). + - Branch name. For example, release/2.0.0, release/2.0.0-preview2, or master (for nightly releases). + + The default value is `LTS`. For more information on .NET support channels, see the .NET Support Policy page. + + Use the `CliChannel` module, for example `CliChannel.Current` + + + + + Custom installer obtain (download) options + + + + + Parameter default values. + + + + + .NET Core SDK install options + + + + + Take version from global.json and fail if it is not found. + + + + + Three-part version in X.Y.Z format representing a specific build version; supersedes the -Channel option. For example: 2.0.0-preview2-006120. + + + + + Latest coherent build on the channel; uses the latest stable package combination (used with Branch name -Channel options). + + + + + Latest build on the channel (used with the -Channel option). + + + + + .NET Core SDK version (used to specify version when installing .NET Core SDK) + + + + + this value represents currently running OS architecture + + + + + .NET Core SDK architecture + + + + + Download installer from this github branch + + + + + Always download install script (otherwise install script is cached in temporary folder) + + + + + Parameter default values. + + + + + .NET Core SDK installer download options + + + + + Execute dotnet nuget push command + ## Parameters + + - 'setParams' - set nuget push command parameters + - 'nupkg' - nupkg to publish + + ## Sample + + open Fake.DotNet + let setNugetPushParams (defaults:NuGet.NuGetPushParams) = + { defaults with + DisableBuffering = true + ApiKey = Some "abc123" + } + let setParams (defaults:DotNet.NuGetPushOptions) = + { defaults with + PushParams = setNugetPushParams defaults.PushParams + } + + DotNet.nugetPush setParams "./My.Package.nupkg" + + + + + Execute dotnet test command + ## Parameters + + - 'setParams' - set test command parameters + - 'project' - project to test + + + + + [omit] + + + + + Execute dotnet build command + ## Parameters + + - 'setParams' - set compile command parameters + - 'project' - project to compile + + + + + [omit] + + + + + Execute dotnet publish command + ## Parameters + + - 'setParams' - set publish command parameters + - 'project' - project to publish + + + + + [omit] + + + + + Execute dotnet pack command + ## Parameters + + - 'setParams' - set pack command parameters + - 'project' - project to pack + + + + + [omit] + + + + + [omit] + + + + + Execute dotnet restore command + ## Parameters + + - 'setParams' - set restore command parameters + - 'project' - project to restore packages + + + + + [omit] + + + + + Runs a MSBuild project + ## Parameters + - `setParams` - A function that overwrites the default MSBuildOptions + - `project` - A string with the path to the project file to build. + + ## Sample + + open Fake.DotNet + let setMsBuildParams (defaults:MSBuild.CliArguments) = + { defaults with + Verbosity = Some(Quiet) + Targets = ["Build"] + Properties = + [ + "Optimize", "True" + "DebugSymbols", "True" + "Configuration", "Release" + ] + } + let setParams (defaults:DotNet.MSBuildOptions) = + { defaults with + MSBuildParams = setMsBuildParams defaults.MSBuildParams + } + + DotNet.msbuild setParams "./MySolution.sln" + + + + + Install .NET Core SDK if required + ## Parameters + + - 'setParams' - set installation options + + + + + Execute dotnet --version command + ## Parameters + + - 'setParams' - set version command parameters + + + + + Execute dotnet --info command + ## Parameters + + - 'setParams' - set info command parameters + + + + + Execute raw dotnet cli command + ## Parameters + + - 'options' - common execution options + - 'command' - the sdk command to execute 'test', 'new', 'build', ... + - 'args' - command arguments + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + .NET Core SDK install options preconfigured for preview4 tooling, this is marketized as v1.0.1 release of the .NET Core tools + + + + + .NET Core SDK install options preconfigured for preview4 tooling + + + + + .NET Core SDK install options preconfigured for preview4 tooling + + + + + .NET Core SDK install options preconfigured for preview2 tooling + + + + + Download .NET Core SDK installer + ## Parameters + + - 'setParams' - set download installer options + + + + + [omit] + + + + + Download .NET Core SDK installer + + + + + Get .NET Core SDK download uri + + + + + Get dotnet cli executable path. Probes the provided path first, then as a fallback tries the system PATH + ## Parameters + + - 'dotnetCliDir' - the path to check else will probe system PATH + + + + + Gets the DotNet SDK from the global.json + This file can exist in the working directory or any of the parent directories + + + + + Tries the DotNet SDK from the global.json + This file can exist in the working directory or any of the parent directories + Returns None if global.json is not found + + + + + Gets the DotNet SDK from the global.json, starts searching in the given directory. + + + + + Tries to get the DotNet SDK from the global.json, starts searching in the given directory. Returns None if global.json is not found + + + + + .NET Core SDK default install directory (set to default SDK installer paths (/usr/local/share/dotnet or C:\Program Files\dotnet)) + + + + + .NET Core SDK default install directory (set to default SDK installer paths (%HOME/.dotnet or %LOCALAPPDATA%/Microsoft/dotnet). + + + + + Get the build configuration from an environment variable with the given name or returns + the default if not value was set + + + + + Parse a build configuration string + + + + + Sets custom command-line arguments expressed as a sequence of strings. + This function overwrites and gets overwritten by `withCustomParams`. + + + + + .NET Core SDK install options preconfigured for preview4 tooling, this is marketized as v1.0.1 release of the .NET Core tools + + + + + .NET Core SDK install options preconfigured for preview4 tooling + + + + + .NET Core SDK install options preconfigured for preview4 tooling + + + + + .NET Core SDK install options preconfigured for preview4 tooling + + + + + .NET Core SDK install options preconfigured for preview2 tooling + + + + + The a list of well-known versions to install + + + + + Branch name. For example, release/2.0.0, release/2.0.0-preview2, or master (for nightly releases). + + + + + Two-part version in X.Y format representing a specific release (for example, 2.0 or 1.0). + + + + + Most current release. + + + + + Long-Term Support channel (most current supported release). + + + + + Specifies the source channel for the installation. + + + + + Runs fsformatting.exe with the given command in the given repository directory. + + + + + Specifies the fsformatting executable + + + + + Contains tasks which allow to run FSharp.Formatting for generating documentation. + + + + + Paket restore packages type + + + + + Paket push parameter type + + + + + Paket pack parameter type + + + + + Restores all packages referenced in either a paket.dependencies or a paket.references file using Paket + ## Parameters + + - `setParams` - Function used to manipulate the default parameters. + + + + + Returns the dependencies from specified paket.references file + + + + + Pushes all NuGet packages in the working dir to the server by using Paket push. + ## Parameters + + - `setParams` - Function used to manipulate the default parameters. + + + + + Pushes the given NuGet packages to the server by using Paket push. + ## Parameters + + - `setParams` - Function used to manipulate the default parameters. + - `files` - The files to be pushed to the server. + + + + + Creates a new NuGet package by using Paket pack on all paket.template files in the working directory. + ## Parameters + + - `setParams` - Function used to manipulate the default parameters. + + + + + Paket restore default parameters + + + + + Paket push default parameters + + + + + Paket pack default parameters + + + + + Contains helper functions and task which allow to inspect, create and publish [NuGet](https://www.nuget.org/) packages with [Paket](http://fsprojects.github.io/Paket/index.html). + + + + + With the `IncludePDBs` switch you can tell `paket` to pack pdbs into the package. + this only works for paket.template files of type 'Project'. + + + + + If set to `true` this will tell `nuget`/`paket` that this is a development dependency + + + + + If set to `true` this will tell `nuget`/`paket` to prompt the user for + the acceptance of the provided license + + + + + A list of excluded dependencies + + + + + A list of dependencies to other packages + + + + + A list of referenced framework assemblies + if omitted all used Framework assemblies will be used by `paket` + + + + + A list of references + + + + + The included or excluded files (use this if the `TemplateType` is `File`) + + + + + a list of tags + + + + + the copyright information + + + + + URL to an icon + + + + + URL to the where the project of the package is hosted + + + + + URL to the license of the package + + + + + The package language + + + + + a short summary (line by line) + + + + + the release notes (line by line) + + + + + A list of package owners + + + + + a list of authors for the nuget package. + If omitted, `paket`will use reflection to obtain the value of the `AssemblyCompanyAttribute`. + + + + + The title of the package + If omitted, `paket` will use reflection to obtain the value of the `AssemblyTitleAttribute`. + + + + + The package description + If omitted, `paket` will use reflection to obtain the value of the `AssemblyDescriptionAttribute`. + + + + + The package version. + If omitted, `paket` will use reflection to obtain the value of the `AssemblyInformationalVersionAttribute` or if that is missing the `AssemblyVersionAttribute`. + + + + + The NuGet Package ID + If omitted, `paket` will use reflection to determine the assembly name. + + + + + The type of the template (`File` or `Project`) + + + + + The file path to the `paket.template` file + if omitted, a `paket.template` file will be created in the current directory + + + + + Contains the different parameters to create a paket.template file + + + + + no explicit version + + + + + For example >= 2.0 + + + + + For example ~> 2.0 + + + + + Use the currently locked version as dependency + + + + + Use the currently loaded version as dependency + + + + + A specific version string + + + + + Explicitely exclude a file + + + + + Include a file and store it into a targed + + + + + Creates a paket.template file with the given filename + Will fail if the file could not be written + + ## Parameters + - `setParams` - Function used to manipulate the default `PaketTemplateParams` value + + ## Sample usage + + Target "Create Paket Template" (fun _ -> + PaketTemplate (fun p -> + { p with + TemplateFilePath = Some "./deploytemp/paket.template" + Id = Some "My.New.Package" + Version = Some "0.0.1-alpha" + Authors = ["Me"; "You"; "Someone Other"] + Files = [ Include ("./**/*.dll", "/lib/dlls") + Exclude "./Foo/bar.dll" + Include ("./*.jpg", "/images") ] + Dependencies = [ "Paket1.FOO", AnyVersion + "Paket2.BAR", GreaterOrEqual CURRENTVERSION + "Paket3.BAZ", GreaterOrEqualSafe LOCKEDVERSION + "Paket4.BOO", GreaterOrEqual (Version "1.2.3") ] + } + ) + ) + + + + + The default parameters for the generation of the `paket.template` + + ## Defaults + + - TemplateFilePath - `None` + - TemplateType - `Project` + - Id - `None` + - Version - `None` + - Description - `None` + - Title - `None` + - Authors - `Empty list` + - Owners - `Empty list` + - ReleaseNotes - `Empty list` + - Summary - `Empty list` + - Language - `None` + - LicenseUrl - `None` + - ProjectUrl - `None` + - IconUrl - `None` + - Copyright - `None` + - Tags - `Empty list` + - Files - `Empty list` + - References - `Empty list` + - FrameworkAssemblies - `Empty list` + - Dependencies - `Empty list` + - ExcludedDependencies - `Empty list` + - RequireLicenseAcceptance - `None` + - DevelopmentDependency - `None` + - IncludePDBs - `None` + + + + + Contains helper functions and task which allow it to generate a paket.template + file for [Paket](http://fsprojects.github.io/Paket/index.html) + + + + + Path to mdtool, defaults to Xamarin Studio's usual path + + + + + Build configuration, defaults to 'Debug|iPhoneSimulator' + + + + + Project name within a solution file + + + + + Path to desired solution file. If not provided, mdtool finds the first solution in the current directory. + Although mdtool can take a project file, the archiving seems to fail to work without a solution. + + + + + The iOS archive paramater type + + + + + Path to zipalign tool, defaults to assuming it is in your path + + + + + Path to jarsigner tool, defaults to assuming it is in your path + + + + + Specifies the name of the message digest algorithm to use when digesting the entries of a JAR file. + + + + + Specifies the name of the signature algorithm to use to sign the JAR file. + + + + + (Required) Alias for keystore + + + + + (Required) Password for keystore + + + + + (Required) Path to keystore used to sign the app + + + + + Used for multiple APK packaging to set different version code par ABI + + + + + Build an APK Targetting One ABI (used to reduce the size of the APK and support different CPU architectures) + + + + + Additional MSBuild properties, defaults to empty list + + + + + Output path for build, defaults to 'bin/Release' + + + + + Build configuration, defaults to 'Release' + + + + + (Required) Path to the Android project file (not the solution file!) + + + + + The Android packaging parameter type + + + + + Additional MSBuild properties, defaults to empty list + + + + + Indicates if an IPA file should be generated + + + + + Output path for build, defaults to project settings + + + + + Build platform, defaults to 'iPhoneSimulator' + + + + + Build configuration, defaults to 'Debug' + + + + + Build target, defaults to Build + + + + + (Required) Path to solution or project file + + + + + The iOS build paramater type + + + + + Path to xamarin-component.exe, defaults to checking tools/xpkg + + + + + The package restore paramater type + + + + + Archive a project using Xamarin's iOS archive tools + ## Parameters + - `setParams` - Function used to override the default archive parameters + + + + + The default iOS archive parameters + + + + + Signs and aligns multiple Xamarin.Android packages, returning multiple FileInfo objects for the signed APK file + ## Parameters + - `setParams` - Function used to override the default build parameters + - `apkFiles` - FileInfo object for an unsigned APK file to sign and align + + + + + Signs and aligns a Xamarin.Android package, returning a FileInfo object for the signed APK file + ## Parameters + - `setParams` - Function used to override the default build parameters + - `apkFile` - FileInfo object for an unsigned APK file to sign and align + + + + + The default Android signing and aligning parameters + + + + + Packages a Xamarin.Android app, returning a FileInfo object for the unsigned APK file + ## Parameters + - `setParams` - Function used to override the default build parameters + + + + + Packages a Xamarin.Android app, returning a multiple FileInfo objects for the unsigned APK files + ## Parameters + - `setParams` - Function used to override the default build parameters + + + + + The default Android packaging parameters + + + + + Builds a project or solution using Xamarin's iOS build tools + ## Parameters + - `setParams` - Function used to override the default build parameters + + + + + The default iOS build parameters + + + + + Restores NuGet packages and Xamarin Components for a project or solution + ## Parameters + - `setParams` - Function used to override the default package restore parameters + + + + + The default package restore parameters + + + + + Contains tasks for building Xamarin.iOS and Xamarin.Android apps + + + + + Type signature for a Compiler Function + + + + +Common Error Result type for tracing errors + + + + + Emit debug information in quotations + + + + + Specify target framework profile of this assembly. + + + + + Specifies the version of the OS subsystem to be used by the generated executable. + Use 6.02 for Windows 8, 6.01 for Windows 7, 6.00 for Windows Vista. + This option only applies to executables, not DLL and need only be used if your application + depends on specific security features available only on certain versions of the OS + + + + + Enable high-entropy ASLR + + + + + Resolve assembly references using directory-based rules rather than MSBuild resolution + + + + + Name the output debug file + + + + + Statically link the given assembly and all referenced DLLs that depend on this assembly. + Use an assembly name e.g. mylib, not a DLL name. + + + + + Statically link the F# library and all referenced DLLs + that depend on it into the assembly being generated + + + + + Do not reference the default CLI assemblies by default + + + + + Base address for the library to be built + + + + + Specify a directory for the include path which is used to resolve source files and assemblies + + + + + Output messages with fully qualified paths + + + + + Output messages in UTF-8 encoding + + + + + Displays timing information for compilation. + + + + + Specify the codepage used to read source files + + + + + Display the commandline flags and their usage + + + + + Suppress compiler copyright message + + + + + Ignore ML compatibility warnings + + + + + Define a list of conditional compilation symbols + + + + + Define a conditional compilation symbols + + + + + Generate overflow checks + + + + + Output warning and error messages in color + + + + + Enable specific warnings that may be off by default + + + + + Disable specific warning messages + + + + + Set a warning level (0-5) + + + + + Report specific warnings as errors + + + + + Report all warnings as errors + + + + + Enable or disable cross-module optimizations + + + + + Enable or disable tailcalls + + + + + Enable optimizations + + + + + Specify debugging type: full, pdbonly. + ('full' is the default and enables attaching a debugger to a running program). + + + + + Emit debug information + + + + + Link the specified resource to this assembly + + + + + Embed the specified managed resource + + + + + Do not include the default Win32 manifest + + + + + Specify a Win32 manifest file + + + + + Specify a Win32 resource file (.res) + + + + + Reference assemblies in the order listed + + + + + Reference an assembly + + + + + Print the inferred interface of the assembly to a file + + + + + Don't add a resource to the generated assembly containing F#-specific metadata + + + + + Only include optimization information essential for implementing inlined constructs. + Inhibits cross-module inlining but improves binary compatibility. + + + + + Limit which platforms the compiled code can run on: + + + + + Specify a strong name key container + + + + + Specify a strong name key file + + + + + Write the xmldoc of the assembly to the given file + + + + + Delay-sign the assembly using only the public portion of the strong name key + + + + + The 'fsc.exe' output target types : exe, winexe, library, module + + + + + Name of the output file + + + + + Specified path of a managed resource with an optional name alias and accessiblity flag + resinfo format is <file>[,<stringname>[,public|private]] + e.g. `resource.dat,rezName,public` + + + + + Optimization options that can be disabled or enabled selectively by listing them + with the optimize compiler flag + + + + + Used to set the Accessiblity of an embeded or linked resource + + + + + Specify target framework profile of this assembly. + Valid values are mscorlib or netcore. Default - mscorlib + + + + + Specify debugging type: full, pdbonly. + ('full' is the default and enables attaching a debugger to a running program). + + + + + Limit which platforms the compiled code can run on: + x86, Itanium, x64, anycpu32bitpreferred, or anycpu. + The default is anycpu. + + + + + Build a module that can be added to another assembly (.netmodule) + + + + + Build a library + + + + + Build a Windows executable + + + + + Build a console executable + + + + + Compiles one or more F# source files with the specified parameters + using an existing fsc.exe installed on the system + ## Parameters + + - `fscTool` - Path to an existing fsc.exe executable + - `setParams` - Function used to overwrite the default Fsc parameters. + - `inputFiles` - The F# input files. + + ## Sample + + ["file1.fs"; "file2.fs"] + |> compileExternal "path/to/fsc.exe" + [Out "" + Target Exe + Platform AnyCpu + References [] + Debug false + ] + + + + + Compiles the given F# source files with the specified parameters. + + ## Parameters + + - `fscTool` - Path to an existing fsc.exe executable + - `setParams` - Function used to overwrite the default Fsc parameters. + - `inputFiles` - The F# input files. + + ## Returns + + The exit status code of the compile process. + + ## Sample + + ["file1.fs"; "file2.fs"] + |> compileExternalWithResult "path/to/fsc.exe" + [Out "" + Target Exe + Platform AnyCpu + References [] + Debug false + ] + + + + + An external fsc.exe compiler + + + + + Compiles one or more F# source files with the specified parameters. + ## Parameters + + - `setParams` - Function used to overwrite the default Fsc parameters. + - `inputFiles` - The F# input files. + + ## Sample + + ["file1.fs"; "file2.fs"] + |> compile [Out "" + Target Exe + Platform AnyCpu + References [] + Debug false + ] + + + + + Compiles the given F# source files with the specified parameters. + + ## Parameters + + - `setParams` - Function used to overwrite the default Fsc parameters. + - `inputFiles` - The F# input files. + + ## Returns + + The exit status code of the compile process. + + ## Sample + + ["file1.fs"; "file2.fs"] + |> compileWithResult [Out "" + Target Exe + Platform AnyCpu + References [] + Debug false + ] + + + + + The internal FCS Compiler + + + + + Common compiler arg prep code + + + + + Compiles the given source files with the given options using either + the internal FCS or an external fsc.exe. If no options + given (i.e. the second argument is an empty list), by default tries + to behave the same way as would the command-line 'fsc.exe' tool. + + + + + Reports Fsc compile errors to the console using Fake.Core.Trace + + + + + Computes output type and appends source files to argument list + + + + + An exception type to signal build errors. + + + + + Contains tasks to compiles F# source file with the [FSharp.Compiler.Service](https://github.com/fsharp/FSharp.Compiler.Service). + + **Note: This documentation is for FAKE version 5.0 or later. The old documentation can be found [here](/legacy-fsc.html)** + + + + + When UseShellExecute is true, the fully qualified name of the directory that contains the process to be started. When the UseShellExecute property is false, the working directory for the process to be started. The default is an empty string (""). + + + + + Environment variables + + + + + Sets the path to the fsharpi / fsi.exe to use + + + + + Prevents references from being locked by the F# Interactive process + + + + + Emit debug information in quotations + + + + + Support TAB completion in console (on by default) + + + + + Suppress fsi writing to stdout + + + + + Execute interactions on a Windows Forms event loop (on by default) + + + + + Exit fsi after loading the files or running the .fsx script given on the command line + + + + + Do not reference the default CLI assemblies by default + + + + + Specify target framework profile of this assembly. Valid values are mscorlib, netcore or netstandard. Default - mscorlib + + + + + Resolve assembly references using directory-based rules rather than MSBuild resolution + + + + + Specify a directory for the include path which is used to resolve source files and assemblies (Short form: -I) + + + + + Output messages with fully qualified paths + + + + + Specify the preferred output language culture name (e.g. es-ES, ja-JP) + + + + + Output messages in UTF-8 encoding + + + + + Specify the codepage used to read source files + + + + + Display the commandline flags and their usage + + + + + Suppress compiler copyright message + + + + + Ignore ML compatibility warnings + + + + + Define a list of conditional compilation symbols + + + + + (Obsolete) Define a conditional compilation symbol (use FsiParams.Definitions instead) + + + + + Generate overflow checks + + + + + Output warning and error messages in color + + + + + Enable specific warnings that may be off by default + + + + + Disable specific warning messages + + + + + Set a warning level (0-5) + + + + + Report specific warnings as errors + + + + + Report all warnings as errors + + + + + Enable or disable cross-module optimizations + + + + + Produce a deterministic assembly (including module version GUID and timestamp) + + + + + Enable or disable tailcalls + + + + + Enable optimizations (Short form: -O) + + + + + Specify debugging type: full, portable, embedded, pdbonly. PdbOnly is the default + + + + + Emit debug information (Short form: -g) + + + + + Reference an assembly (Short form: -r) + + + + + Load the given file on startup + + + + + Use the given file on startup as initial input + + + + + Sets the current environment variables. + + + + + Specify target framework profile of this assembly. + Valid values are mscorlib, netcore or netstandard. Default - mscorlib + + + + + Specify debugging type: full, portable, embedded, pdbonly. ('pdbonly' is the default if no debuggging type specified and enables attaching a debugger to a running program, 'portable' is a cross-platform format, 'embedded' is a cross-platform format embedded into the output file). + + + + + Executes the internal fsi within FSC on the given script + Returns error code and an exception message if any exceptions were thrown + + ## Sample + + e.g: Passing some arguments to fsi, along with the script and some args to be passed to the script + + let fsiExe = "path/to/fsi.exe" + let script = "MyScript.fsx" + let (exitcode,msgs) = + Fsi.exec (fun p -> + { p with + TargetProfile = Fsi.Profile.NetStandard + WorkingDirectory = "path/to/WorkingDir" + ToolPath = FsiTool.External fsiExe + } + |> Process.setEnvironmentVariable "SOME_VAR" "55" + |> Process.setEnvironmentVariable "GIT" "path/to/git") script ["stuff";"10"] + ``` + + + + + Locates Fsi.exe and executes + + + + + Executes a user supplied Fsi.exe with the option to set args and environment variables + + + + + Gets the default environment variables and additionally appends user defined vars to it + + + + + The path to the F# Interactive tool. + + + + + An error level setting to specify whether a failed test should break the build + + + + + A timeout for the test runner + + + + + Tests with theses tags are included by MSpec + + + + + Tests with theses tags are ignored by MSpec + + + + + Can be used to run MSpec in silent mode. + + + + + Working directory (optional) + + + + + Output file path for xml reports (optional). + + + + + Output directory for html reports (optional). + + + + + The path to the mspec console runner. Use `mspec-clr4.exe` if you are on .NET 4.0 or above. + + + + + Parameter type to configure the MSpec runner. + + + + + This task to can be used to run [machine.specifications](https://github.com/machine/machine.specifications) on test libraries. + ## Parameters + + - `setParams` - Function used to overwrite the MSpec default parameters. + - `assemblies` - The file names of the test assemblies. + + ## Sample + + !! (testDir @@ "Test.*.dll") + |> MSpec (fun p -> {p with ExcludeTags = ["HTTP"]; HtmlOutputDir = reportDir}) + + ## Hint + + XmlOutputPath expects a full file path whereas the HtmlOutputDir expects a directory name + + + + + Builds the command line arguments from the given parameter record and the given assemblies. + + + + + MSpec default parameters - tries to locate mspec-clr4.exe in any subfolder. + + + + + Contains a task to run [machine.specifications](https://github.com/machine/machine.specifications) tests. + + + + + Run xUnit against a specific method + + + + + Run xUnit against a specific class + + + + + Run xUnit against a specific namespace + + + + + Waits for input after completion. + + + + + Forces AppVeyor CI mode (normally auto-detected). + + + + + Forces TeamCity mode (normally auto-detected). + + + + + List of traits to exclude. + + + + + List of traits to include. + + + + + Test runner error level. + + + + + Maximum time to allow xUnit to run before being killed. + + + + + Run xUnit without reporting test progress. + + + + + Run xUnit with shadow copy enabled. + + + + + The working directory for running the xunit console runner. + + + + + The output path of the NUnit XML report. + + + + + The output path of the xUnit XML report (in the xUnit v1 style). + + + + + The output path of the xUnit XML report. + + + + + The output path of the xUnit HTML report. + + + + + The xUnit thread limiting strategy. + + + + + The xUnit parallelization mode. + + + + + Do not use app domains to run test code. + + + + + The path to the xUnit console runner: `xunit.console.exe` + + + + + The xUnit2 parameter type. + + + + + Limits the number of concurrently executing collections to `count`. + + + + + Does not limit the number of concurrently executing collections. + + + + + Uses the default concurrency mode for collections. + + + + + The collection concurrency mode used by the xUnit2 runner. + + + + + Parallelize assemblies and collections. + + + + + Only parallelize assemblies. + + + + + Only parallelize collections. + + + + + Turn off all parallelization. + + + + + The parallelization mode of the xUnit2 runner. + + + + + Runs xUnit v2 unit tests in the given assemblies via the given xUnit2 runner. + Will fail if the runner terminates with non-zero exit code. + + The xUnit2 runner terminates with a non-zero exit code if any of the tests + in the given assembly fail. + + ## Parameters + + - `setParams` - Function used to manipulate the default `XUnit2Params` value. + - `assemblies` - Sequence of one or more assemblies containing xUnit unit tests. + + ## Sample usage + + Target "Test" (fun _ -> + !! (testDir @@ "xUnit.Test.*.dll") + |> xUnit2 (fun p -> { p with HtmlOutputPath = Some (testDir @@ "xunit.html") }) + ) + + + + + Helper method to detect if the xunit console runner supports the -noappdomain flag. + If the xunit console runner does not support this flag, it will change the value to false + so it does not interfere with older versions. + + + + + Builds the command line arguments from the given parameter record and the given assemblies. + + + + + The xUnit2 default parameters. + + ## Defaults + + - `NoAppDomain` - `false` + - `Parallel` - `NoParallelization` + - `MaxThreads` - `Default` + - `HtmlOutputPath` - `None` + - `XmlOutputPath` - `None` + - `XmlV1OutputPath` - `None` + - `IncludeTraits` - `[]` + - `ExcludeTraits` - `[]` + - `ShadowCopy` - `true` + - `ErrorLevel` - `Error` + - `ToolPath` - The `xunit.console.exe` path if it exists in a subdirectory of the current directory. + - `WorkingDir` - `None` + - `TimeOut` - 5 minutes + - `ForceTeamCity` - `false` + - `ForceAppVeyor` - `false` + - `Silent` - `false` + - `Wait` - `false` + - `Namespace` - `None` + - `Class` - `None` + - `Method` - `None` + + + + + Contains tasks to run [xUnit](https://github.com/xunit/xunit) v2 unit tests. + + + + + Returns whether all tests in the given test result have succeeded + + + + + [omit] + + + + + Merges non-empty list of test result XDocuments into a single XElement + + + + + Used by the NUnitParallel helper, can also be used to merge test results + from multiple calls to the normal NUnit helper. + + + + + Contains types and functions for working with [NUnit](http://www.nunit.org/) unit tests result xml. + + + + + Default: "" + + + + + Default: [TestRunnerErrorLevel](fake-unittestcommon-testrunnererrorlevel.html).Error + + + + + See [NUnitDomainModel](fake-nunitcommon-nunitdomainmodel.html). + + + + + Disables shadow copying of the assembly in order to provide improved performance. + + + + + The default timeout to be used for test cases. If any test exceeds the timeout value, it is cancelled and reported as an error. + + + + + The path to a custom XSLT transform file to be used to process the XML report. + + + + + The working directory. + + + + + Causes an identifying label to be displayed at the start of each test case. + + + + + Controls how NUnit loads tests in processes. See: [NUnitProcessModel](fake-nunitcommon-nunitprocessmodel.html). + + + + + Allows you to specify the version of the runtime to be used in executing tests. + + + + + Redirects error output created by the tests from standard error output (console) to the file specified as value. + + + + + Redirects output created by the tests from standard output (console) to the file specified as value. + + + + + The output path of the nUnit XML report. + + + + + Gives ability to not error if an assembly with no tests is passed into nunit + + + + + Causes execution of the test run to terminate immediately on the first test failure or error. + + + + + Suppresses use of a separate thread for running the tests and uses the main thread instead. + + + + + NUnit console runner name. ( `nunit-console.exe`) + + + + + The path to the NUnit console runner: `nunit-console.exe` + + + + + The [Categories](http://www.nunit.org/index.php?p=category&r=2.6.4) to be excluded in a test run. Multiple categories may be specified on either option, by using commas to separate them. + + + + + The [Categories](http://www.nunit.org/index.php?p=category&r=2.6.4) to be included in a test run. Multiple categories may be specified on either option, by using commas to separate them. + + + + + The [NUnit](http://www.nunit.org/) Console Parameters type. + FAKE will use [NUnitDefaults](fake-nunitcommon.html) for values not provided. + + For reference, see: [NUnit-Console Command Line Options](http://www.nunit.org/index.php?p=consoleCommandLine&r=2.6.4) + + + + + A separate test domain is created for each assembly + + + + + A test domain is created - this is how NUnit worked prior to version 2.4 + + + + + No domain is created - the tests are run in the primary domain. This normally requires copying the NUnit assemblies into the same directory as your tests. + + + + + The default is to use multiple domains if multiple assemblies are listed on the command line. Otherwise a single domain is used. + + + + + The /domain option controls of the creation of AppDomains for running tests. See [NUnit-Console Command Line Options](http://www.nunit.org/index.php?p=consoleCommandLine&r=2.6.4) + + + + + Process model for nunit to use, see [Project Editor](http://www.nunit.org/index.php?p=projectEditor&r=2.6.4) + + + + + Option which allows to specify if a NUnit error should break the build. + + + + + NUnit console returns negative error codes for errors and sum of failed, ignored and exceptional tests otherwise. + Zero means that all tests passed. + + + + + Tries to detect the working directory as specified in the parameters or via TeamCity settings + [omit] + + + + + Builds the command line arguments from the given parameter record and the given assemblies. + + + + + The [NUnitParams](fake-nunitcommon-nunitparams.html) default parameters. + + ## Defaults + - `IncludeCategory` - `""` + - `ExcludeCategory` - `""` + - `ToolPath` - The `nunit-console.exe` path if it exists in a subdirectory of the current directory. + - `ToolName` - `"nunit-console.exe"` + - `DontTestInNewThread`- `false` + - `StopOnError` - `false` + - `SkipNonTestAssemblies` - `false` + - `OutputFile` - `"TestResult.xml"` + - `Out` - `""` + - `ErrorOutputFile` - `""` + - `WorkingDir` - `""` + - `Framework` - `""` + - `ProcessModel` - `DefaultProcessModel` + - `ShowLabels` - `true` + - `XsltTransformFile` - `""` + - `TimeOut` - 5 minutes + - `DisableShadowCopy` - `false` + - `Domain` - `DefaultDomainModel` + - `ErrorLevel` - `Error` + - `Fixture` - `""` + + + + + Contains types and utility functions relaited to running [NUnit](http://www.nunit.org/) unit tests. + + + + + Runs NUnit on a group of assemblies. + ## Parameters + + - `setParams` - Function used to manipulate the default [NUnitParams](fake-nunitcommon-nunitparams.html) value. + - `assemblies` - Sequence of one or more assemblies containing NUnit unit tests. + + ## Sample usage + + Target "Test" (fun _ -> + !! (testDir + @"\Test.*.dll") + |> NUnit (fun p -> { p with ErrorLevel = DontFailBuild }) + ) + + + + + Contains tasks to run [NUnit](http://www.nunit.org/) unit tests. + + + + + Runs NUnit in parallel on a group of assemblies. + ## Parameters + + - `setParams` - Function used to manipulate the default [NUnitParams](fake-nunitcommon-nunitparams.html) value. + - `assemblies` - Sequence of one or more assemblies containing NUnit unit tests. + + ## Sample usage + + Target "Test" (fun _ -> + !! (testDir + @"\Test.*.dll") + |> NUnitParallel (fun p -> { p with ErrorLevel = DontFailBuild }) + ) + + + + + Contains tasks to run [NUnit](http://www.nunit.org/) unit tests in parallel. + + + + + A test parameter specified in the form name=value. Multiple parameters may be specified, separated by semicolons + + + + + Skips assemblies that do not contain tests or assemblies that contain the NUnit.Framework.NonTestAssemblyAttribute without raising an error + + + + + Controls the trace logs NUnit3 will output, defaults to Off + + + + + Default: [TestRunnerErrorLevel](fake-unittestcommon-testrunnererrorlevel.html).Error + + + + + Specify whether to write test case names to the output. + + + + + Turns on use of TeamCity service messages. + + + + + Tells .NET to copy loaded assemblies to the shadowcopy directory. + + + + + Output specs for saving the test results. Default value is TestResult.xml + Passing empty list does not save any result (--noresult option in NUnit) + For more information, see: [NUnit3 command line options](https://github.com/nunit/docs/wiki/Console-Command-Line) + + + + + File path to contain error output from the tests. + + + + + File path to contain text output from the tests. + + + + + Path of the directory to use for output files. + + + + + Causes execution of the test run to terminate immediately on the first test failure or error. + + + + + Specify the NUMBER of worker threads to be used in running tests. + This setting is used to control running your tests in parallel and is used in conjunction with the Parallelizable Attribute. + If not specified, workers defaults to the number of processors on the machine, or 2, whichever is greater. + + + + + Set the random seed used to generate test cases + + + + + The default timeout to be used for test cases. If any test exceeds the timeout value, it is cancelled and reported as an error. + + + + + Dispose each test runner after it has finished running its tests + + + + + Run tests in a 32-bit process on 64-bit systems. + + + + + Allows you to specify the version of the runtime to be used in executing tests. + Default value is runtime under which the assembly was built. See: [NUnit3Runtime](fake-testing-nunit3-nunit3runtime.html). + + + + + Controls how NUnit loads tests in processes. See: [NUnit3ProcessModel](fake-testing-nunit3-nunit3domainmodel.html). + + + + + Number of agents that may be allowed to run simultaneously assuming you are not running inprocess. + If not specified, all agent processes run tests at the same time, whatever the number of assemblies. + This setting is used to control running your assemblies in parallel. + + + + + Controls how NUnit loads tests in processes. See [NUnit3ProcessModel](fake-testing-nunit3-nunit3processmodel.html) + + + + + Name of a project configuration to load (e.g.: Debug) + + + + + An expression indicating which tests to run. It may specify test names, classes, methods, + catgories or properties comparing them to actual values with the operators ==, !=, =~ and !~. + See [NUnit documentation](https://github.com/nunit/docs/wiki/Test-Selection-Language) for a full description of the syntax. + + + + + The name (or path) of a file containing a list of tests to run or explore, one per line. + + + + + The path to the NUnit3 console runner: `nunit3-console.exe` + + + + + The NUnit 3 Console Parameters type. FAKE will use [NUnit3Defaults](fake-testing-nunit3.html) for values not provided. + + For reference, see: [NUnit3 command line options](https://github.com/nunit/docs/wiki/Console-Command-Line) + + + + + The --labels option in NUnit3 console runner. Specify whether to write test case names to the output. + + + + + The --trace option in NUnit3 console runner. Specifies the internal nunit runner log level. + + + + + Option which allows to specify if a NUnit error should break the build. + + + + + NUnit should use runtime specified by this value + + + + + NUnit should use Mono framework but can select its version + + + + + NUnit should use .NET framework but can select its version + + + + + Uses the runtime under which the assembly was built. + + + + + The --framework option in running NUnit 3. There are three kinds - VXY, which means either .NET framework or Mono, NetXY (use .NET framework with given version) + and MonoXY (Mono framework with given version). You can use Net or Mono to let NUnit select the version. + You can pass any value using Other. + + + + + A separate test domain is created for each assembly + + + + + A test domain is created - this is how NUnit worked prior to version 2.4 + + + + + No domain is created - the tests are run in the primary domain. This normally requires copying the NUnit assemblies into the same directory as your tests. + + + + + The default is to use multiple domains if multiple assemblies are listed on the command line. Otherwise a single domain is used. + + + + + The --domain option controls of the creation of AppDomains for running tests. See [NUnit-Console Command Line Options](http://www.nunit.org/index.php?p=consoleCommandLine&r=2.6.4) + + + + + Process model for NUnit 3 to use. + + + + + Builds the command line arguments from the given parameter record and the given assemblies. + + + + + Tries to detect the working directory as specified in the parameters or via TeamCity settings + [omit] + + + + + The [NUnit3Params](fake-testing-nunit3-nunit3params.html) default parameters. + + - `ToolPath` - The `nunit-console.exe` path if it exists in `tools/Nunit/`. + - `Testlist` - `""` + - `Where` - `""` + - `Config` - `""` + - `ProcessModel` - `DefaultProcessModel` + - `Agents` - `None` + - `Domain` - `DefaultDomainModel` + - `Framework` - `""` + - `Force32bit` - `false` + - `DisposeRunners` - `false` + - `Timeout` - `2147483647 milliseconds` + - `Seed` - `-1` (negative seed is ignored by NUnit and is not sent to it) + - `Workers` - `None` + - `StopOnError` - `false` + - `WorkingDir` - `""` + - `OutputDir` - `""` + - `ErrorDir` - `""` + - `ResultSpecs` - `"TestResult.xml"` + - `ShadowCopy` - `false` + - `TeamCity` - `false` + - `ErrorLevel` - `Error` + - `TraceLevel` - `Default` (By default NUnit3 sets this to off internally) + - `SkipNonTestAssemblies` - `false` + - `Params` - `""` + ## Defaults + + + + + Contains tasks to run [NUnit](http://www.nunit.org/) unit tests. + + ### Sample + + Target.create "Test" (fun _ -> + !! (testDir + "/NUnit.Test.*.dll") + |> NUnit3.run (fun p -> + {p with + ShadowCopy = false }) + ) + + + + + + Run tests in isolation (optional). + + + + + Option which allow to specify if a MSTest error should break the build. + + + + + List of additional test case properties to display, if they exist (optional) + + + + + Path to MSTest.exe + + + + + A timeout for the test runner (optional) + + + + + List of tests be run (optional) + + + + + Working directory (optional) + + + + + Path to the Test Settings file (.testsettings) (optional) + + + + + Path to the Test Metadata file (.vsmdi) (optional) + + + + + Test results directory (optional) + + + + + Test category filter (optional). The test category filter consists of one or more test category names separated by the logical operators '&', '|', '!', '&!'. The logical operators '&' and '|' cannot be used together to create a test category filter. + + + + + Parameter type to configure the MSTest.exe. + + + + + Option which allow to specify if a MSTest error should break the build. + + + + + Runs MSTest command line tool on a group of assemblies. + ## Parameters + + - `setParams` - Function used to manipulate the default MSTestParams value. + - `assemblies` - Sequence of one or more assemblies containing Microsoft Visual Studio Unit Test Framework unit tests. + + ## Sample usage + + Target "Test" (fun _ -> + !! (testDir + @"\*.Tests.dll") + |> MSTest (fun p -> { p with Category = "group1" }) + ) + + + + + Builds the command line arguments from the given parameter record and the given assemblies. + + + + + MSTest default parameters. + + + + + [omit] + + + + + [omit] + + + + + Contains tasks to run [MSTest](http://en.wikipedia.org/wiki/Visual_Studio_Unit_Testing_Framework/) unit tests. + + + + + Working directory + + + + + Prints the version on startup. Default is true + + + + + Custom arguments to use in the case the helper not yet supports them + + + + + Doesn't run tests, print out list of tests instead. + + + + + Run only provided tests. + + + + + Filter a specific test list to run. + + + + + Filter a specific test case to run. + + + + + Filter a specific hierarchy to run. + + + + + Fails the build if focused tests exist. Default is true + + + + + Prints out summary after all tests are finished including their source code location. + + + + + Prints out summary after all tests are finished. + + + + + Number of parallel workers (defaults to the number of logical processors). + + + + + Run all tests in parallel. Default is true. + + + + + Extra verbose output for your tests. + + + + + CLI parameters available if you use Tests.runTestsInAssembly defaultConfig argv in your code: + + + + + Contains tasks to run [Expecto](https://github.com/haf/expecto) unit tests. + + + + + This options is used to add additional optional arguments, could be somthing like "-returntargetcode " + + + + + Neither track nor record auto-implemented properties. + That is, skip getters and setters like these: public bool Service { get; set; } + + + + + Alternative locations to look for PDBs. + + + + + Return the target process return code instead of the OpenCover console return code. Use the offset to return the OpenCover console at a value outside the range returned by the target process. + + + + + Allow to merge the results with an existing file (specified by Output parameter). So the coverage from the output file will be loaded first (if exists). + + + + + Remove information from output file that relates to classes/modules that have been skipped (filtered) due to the use of the parameters ExcludeBy*, Filter or where the PDB is missing. + + + + + Assemblies being loaded from these locations will be ignored. + + + + + Exclude a class (or methods) by filter(s) that match the filenames. An * can be used as a wildcard. + + + + + Exclude a class or method by filter(s) that match attributes that have been applied. An * can be used as a wildcard. + + + + + This option is used to merge the coverage results for an assembly regardless of where it was loaded + assuming the assembly has the same file-hash in each location. + + + + + The directory where the OpenCover process will be started. + + + + + The timeout for the OpenCover process. + + + + + A list of filters to apply to selectively include or exclude assemblies and classes from coverage results. + + + + + Use this to register and de-register the code coverage profiler. + + + + + The location and name of the output xml file. + If no value is supplied then the current directory + will be used and the output filename will be results.xml. + + + + + (Required) Path to the NUnit/XUnit console runner + + + + + (Required) Path to the OpenCover console application + + + + + OpenCover parameters, for more details see: https://github.com/OpenCover/opencover/wiki/Usage#console-application-usage. + + + + + Show version OpenCover + ## Parameters + + - `setParams` - Function used to overwrite the default OpenCover parameters. + + ## Sample + + OpenCover.Version None + OpenCover.Version (fun p -> { p with TestRunnerExePath = "./Tools/NUnit/nunit-console.exe" }) + + + + + Runs OpenCover on a group of assemblies. + ## Parameters + + - `setParams` - Function used to overwrite the default OpenCover parameters. + - `targetArgs` - Test runner arguments. + + ## Sample + + OpenCover.Run (fun p -> { p with TestRunnerExePath = "./Tools/NUnit/nunit-console.exe" }) + "project-file.nunit /config:Release /noshadow /xml:artifacts/nunit.xml /framework:net-4.0" + + + + + Builds the command line arguments from the given parameter record + [omit] + + + + + OpenCover default parameters + + + + + Contains a task which can be used to run [OpenCover](https://github.com/sawilde/opencover) on .NET assemblies. + + + + + The dotCover parameter type for running coverage + + + + + Runs the dotCover "cover" command against the MSpec test runner. + ## Parameters + + - `setDotCoverParams` - Function used to overwrite the dotCover report default parameters. + - `setMSpecParams` - Function used to overwrite the MSpec default parameters. + + ## Sample + + !! (buildDir @@ buildMode @@ "/*.Unit.Tests.dll") + |> runMSpec + (fun dotCoverOptions -> { dotCoverOptions with + Output = artifactsDir @@ "MSpecDotCoverSnapshot.dcvr" }) + (fun mSpecOptions -> { mSpecOptions with + Silent = true }) + + + + + Runs the dotCover "cover" command against the MSTest test runner. + ## Parameters + + - `setDotCoverParams` - Function used to overwrite the dotCover report default parameters. + - `setMSTestParams` - Function used to overwrite the MSTest default parameters. + + ## Sample + + !! (buildDir @@ buildMode @@ "/*.Unit.Tests.dll") + |> runMSTest + (fun -> dotCoverOptions ) + (fun MSTestOptions -> MSTestOptions) + + + + + Builds the command line arguments from the given parameter record and the given assemblies. + Runs all test assemblies in the same run for easier coverage management. + [omit] + + + + + Runs the dotCover "cover" command against the XUnit2 test runner. + ## Parameters + + - `setDotCoverParams` - Function used to overwrite the dotCover report default parameters. + - `setXUnit2Params` - Function used to overwrite the XUnit2 default parameters. + + ## Sample + + !! (buildDir @@ buildMode @@ "/*.Unit.Tests.dll") + |> runXUnit2 + (fun -> dotCoverOptions ) + (fun nUnitOptions -> nUnitOptions) + + + + + Runs the dotCover "cover" command against the NUnit test runner. + ## Parameters + + - `setDotCoverParams` - Function used to overwrite the dotCover report default parameters. + - `setNUnitParams` - Function used to overwrite the NUnit default parameters. + + ## Sample + + !! (buildDir @@ buildMode @@ "/*.Unit.Tests.dll") + |> runNUnit3 + (fun dotCoverOptions -> { dotCoverOptions with + Output = artifactsDir @@ "NUnit3DotCoverSnapshot.dcvr" }) + (fun nUnit3Options -> { nUnit3Options with + DisableShadowCopy = true }) + + + + + Runs the dotCover "cover" command against the NUnit test runner. + ## Parameters + + - `setDotCoverParams` - Function used to overwrite the dotCover report default parameters. + - `setNUnitParams` - Function used to overwrite the NUnit default parameters. + + ## Sample + + !! (buildDir @@ buildMode @@ "/*.Unit.Tests.dll") + |> runNUnit + (fun dotCoverOptions -> { dotCoverOptions with + Output = artifactsDir @@ "NUnitDotCoverSnapshot.dcvr" }) + (fun nUnitOptions -> { nUnitOptions with + DisableShadowCopy = true }) + + + + + Runs the dotCover "report" command. This generates a report from a dotCover snapshot + ## Parameters + + - `setParams` - Function used to overwrite the dotCover report default parameters. + + ## Sample + + report (fun p -> { p with + Source = artifactsDir @@ "dotCoverSnapshot.dcvr" + Output = artifactsDir @@ "dotCoverReport.xml" + ReportType = ReportType.Xml }) + + + + + Runs the dotCover "merge" command. This combines dotCover snaphots into a single + snapshot, enabling you to merge test coverage from multiple test running frameworks + ## Parameters + + - `setParams` - Function used to overwrite the dotCover merge default parameters. + + ## Sample + + merge (fun p -> { p with + Source = [artifactsDir @@ "NUnitDotCoverSnapshot.dcvr" + artifactsDir @@ "MSpecDotCoverSnapshot.dcvr"] + Output = artifactsDir @@ "dotCoverSnapshot.dcvr" }) + + + + + Runs the dotCover "cover" command, using a target executable (such as NUnit or MSpec) and generates a snapshot file. + + ## Parameters + + - `setParams` - Function used to overwrite the dotCover default parameters. + + + + + The dotCover default parameters + + + + + Contains a task which can be used to run [DotCover](http://www.jetbrains.com/dotcover/) on .NET assemblies. + + + + + Return a string entered by the user followed by enter. The input is replaced by '*' on the screen. + + + + + Return a string entered by the user followed by enter. The input is echoed to the screen. + + + + + This module contains functions which allow to interactively input values + + + + + A record which allows to display lots of machine specific information like machine name, processor count etc. + + + + + Type alias for System.EnvironmentVariableTarget + + + + + Retrieves lots of machine specific information like machine name, processor count etc. + + + + + Retrieves information about the hard drives + + + + + Returns a sequence with all installed .NET framework versions + + + + + Contains the IO encoding which is given via build parameter "encoding" or the default encoding if no encoding was specified. + + + + + Convert the given windows path to a path in the current system + + + + + The directory separator string. On most systems / or \ + + + + + The path to the personal documents + + + + + Gets the local directory for the given target platform + + + + + Helper function to help find framework or sdk tools from the + newest toolkit available + + + + + Base path for getting tools from Windows SDKs + + + + + Base path for getting tools from Microsoft SDKs + + + + + The path of the current target platform + + + + + Modifies the ProcessStartInfo according to the platform semantics + + + + + Arguments on the Mono executable + + + + + required sometimes to workaround mono crashes + http://stackoverflow.com/a/8414517/1269722 + + + + + Determines if the current system is a mono system + Todo: Detect mono on windows + + + + + Determines if the current system is a Linux system + + + + + Determines if the current system is a MacOs system + + + + + Determines if the current system is an Unix system + + + + + Determines if the current system is a Windows system + + + + + The system root environment variable. Typically "C:\Windows" + + + + + The path of Program Files (x86) + + + + + The path of the "Program Files" folder - might be x64 on x64 machine + It seems this covers all cases where PROCESSOR\_ARCHITECTURE may misreport and the case where the other variable + PROCESSOR\_ARCHITEW6432 can be null + + + + + Returns the value of the build parameter with the given name if it was set and otherwise an empty string + + + + + Returns the value of the build parameter with the given name if it was set and otherwise the given default value + + + + + Returns if the build parameter with the given name was set + + + + + Retrieves the application settings variable with the given name + + + + + Splits the entries of an environment variable and removes the empty ones. + + + + + Retrieves the environment variable or None if no value was set + + + + + Retrieves the environment variable with the given name or returns false if no value was set + + + + + Retrieves the environment variable with the given name or returns the default value if no value was set + + + + + Retrieves the environment variable with the given name or fails if not found + + + + + Retrieves the environment variable with the given name or returns the default if no value was set + + + + + Sets the build parameter with the given name for the current process. + + + + + Clears the environment variable with the given name for the current process. + + + + + Sets the environment variable with the given name for the current process. + + + + + Sets the environment variable with the given name for the current machine. + + + + + Sets the environment variable with the given name for the current user. + + + + + Sets the environment variable with the given name + + + + + Retrieves all environment variables from the given target + + + + + Combines two path strings using Path.Combine + + + + + Combines two path strings using Path.Combine after removing leading slashes from the second path + + + + + Combines two path strings using Path.Combine + + + + + Combines two path strings using Path.Combine after removing leading slashes from the second path + + + + + Retrieves the environment variable with the given name + + + + + This module contains functions which allow to read and write environment variables and build parameters + + + + + Registry base keys. + + + + + Returns all the subKey names of a registry key + + + + + Deletes a registry subKey + + + + + Create a registry subKey + + + + + Returns whether or not a registry value name exists for a key + + + + + Returns all the value names of a registry key + + + + + Deletes the registry value from its key + + + + + Sets a registry value + + + + + Gets a registry value as string + + + + + Gets a registry value as string + + + + + Gets a registry key and falls back to 32 bit if the 64bit key is not there + + + + + Gets a 64-bit registry key + + + + + Maps the RegistryBaseKey to a RegistryKey for a 32bit System + [omit] + + + + + Maps the RegistryBaseKey to a RegistryKey for a 64bit System + [omit] + + + + + Maps the RegistryBaseKey to a RegistryKey + [omit] + + + + + Contains functions which allow to read and write information from/to the registry. + + + + + Detects whether the given path does not contains invalid characters. + + + + + Detects whether the given path is a file. + + + + + Detects whether the given path is a directory. + + + + + Checks if the given directory exists. If not then this functions creates the directory. + + + + + Ensure that directory chain exists. Create necessary directories if necessary. + + + + + Checks if the directory exists on disk. + + + + + Checks if the file is in a subfolder of the dir. + + + + + Checks if dir1 is a subfolder of dir2. If dir1 equals dir2 the function returns also true. + + + + + Normalizes a filename. + + + + + Checks if all given files exist. + + + + + Raises an exception if the file doesn't exist on disk. + + + + + Checks if the file exists on disk. + + + + + Get the full location of the current assembly. + + + + + Gets the current directory. + + + + + Gets the first file in the directory matching the search pattern or throws an error if nothing was found. + + + + + Gets the first file in the directory matching the search pattern as an option value. + + + + + Finds all the files in the directory and in all subdirectories matching the search pattern. + + + + + Finds all the files in the directory matching the search pattern. + + + + + Gets all files in the directory. + + + + + Gets all subdirectories of a given directory. + + + + + Gets the directory part of a filename. + + + + + Converts a filename to it's full file system name. + + + + + Creates a FileInfo or a DirectoryInfo for the given path + + + + + Creates a FileInfo for the given path. + + + + + Creates a DirectoryInfo for the given path. + + + + + Contains helpers which allow to interact with the file system. + + + + + Decodes a Base64-encoded UTF-8-encoded string + + + + + Determines if a text matches a given regex pattern. + + + + + Find a regex pattern in a text and replaces it with the given replacement. + + + + + Replaces the absolute path to a relative path. + + + + Produces relative path when possible to go from baseLocation to targetLocation. + The root folder + The target folder + The relative path relative to baseLocation + base or target locations are null or empty + + + + A cache of relative path names. + [omit] + + + + + Encapsulates the Apostrophe + + + + + Removes linebreaks from the given string + + + + + Reads a file line by line and replaces all line breaks to windows line breaks + - uses a temp file to store the contents in order to prevent OutOfMemory exceptions + + + + + Converts all line breaks in a text to windows line breaks + + + + + Represents Mac line breaks + + + + + Represents Windows line breaks + + + + + Represents Linux line breaks + + + + + Replaces the text in the given file + + + + + Checks whether the given text starts with the given prefix + + + + + Replaces any occurence of the currentDirectory with . + + + + + Reads a file as one array of bytes + + + + + Reads a file as one text + + + + + Appends all lines to a file line by line + + + + + Writes a file line by line + + + + + Replaces the file with the given string + + + + + Writes a string to a file + + + + + Writes a byte array to a file + + + + + Removes all trailing .0 from a version string + + + + + Writes a file line by line + + + + + Reads the first line of a file. This can be helpful to read a password from file. + + + + + Reads a file line by line + + + + + Lifts a string to an option + + + + + Trims the end of the given string + + + + + Trims the start of the given string + + + + + Trims the given string + + + + + Trims the given string + + + + + Trims all special characters from a string. + + + + + Trims the given string with the DirectorySeparatorChar + + + + + Checks whether the given char is a standard char or digit. + + + + + Returns all standard chars and digits. + + + + + Converts all characters in a string to lower case. + + + + + Checks whether the given char is a german umlaut. + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + Returns the text from the StringBuilder + + + + + Applies action on builder for each element of list. + + + + + Appends all notnull fileNames. + + + + + Appends a text if the value is not null or empty. + + + + + Appends a text if the value is not null or empty. + + + + + Appends a text if the value is not null. + + + + + Appends a quoted text if the value is not null. + + + + + Appends a text if the value is not null. + + + + + Appends a text without quoting if the value is not null. + + + + + Appends a text if the predicate is false. + + + + + Appends a text if the predicate is true. + + + + + Appends string of function value if option has some value + + + + + Appends a text to a StringBuilder without surrounding quotes. + + + + + Appends a text to a StringBuilder. + + + + + Replaces the first occurrence of the pattern with the given replacement. + + + + + Determines whether the last character of the given <see cref="string" /> + matches Path.DirectorySeparatorChar. + + + + + Checks whether the given text ends with the given suffix + + + + + Checks whether the given text starts with the given prefix + + + + + Converts a sequence of strings into a string separated with line ends + + + + + Splits the given string at the given string delimiter + + + + + Splits the given string at the given char delimiter + + + + + Removes the slashes from the end of the given string + + + + + Converts a sequence of strings to a string with delimiters + + + + + Replaces the given pattern in the given text with the replacement + + + + + Returns if the string is null or empty or completely whitespace + + + + + Returns if the string is not null or empty + + + + + Returns if the string is null or empty + + + + + [omit] + + + + + Contains basic functions for string manipulation. + + + + + Replaces the templates with the given replacements + + + + + Saves all files (lazy - file by file!) + + + + + Replaces a bunch of the keywords in all files (lazy - line by line!) + + + + + Loads all templates (lazy - line by line!) + + + + + Contains basic templating functions. Used in other helpers. + + + + + Looks for a key in the cache. + If it is not found the newValueF function is executed and the result is stored in the cache. + + + + + Contains functions which allows to deal with a cache. + + + + + Transforms a XML file using a XSL stylesheet file. + ## Parameters + + - `stylesheetUri` - The Uri for the XSL stylesheet file. + - `fileName` - The XML file to transform. + + + + + Transforms a XmlDocument using a XslCompiledTransform. + ## Parameters + + - `xsl` - The XslCompiledTransform which should be applied. + - `doc` - The XmlDocument to transform. + + + + + Loads the given text into a XslCompiledTransform. + + + + + Replaces inner text of an xml node in a XML file at the location specified by a XPath expression, with support for namespaces. + + + + + Replaces text in a XML file at the location specified by a XPath expression, with support for namespaces. + + + + + Replaces inner text in a XML document specified by a XPath expression, with support for namespaces. + + + + + Replaces text in a XML document specified by a XPath expression, with support for namespaces. + + + + + Replaces the inner text of an xml node in a XML file at the location specified by a XPath expression. + + + + + Replaces text in a XML file at the location specified by a XPath expression. + + + + + Selects a xml node value via XPath from the given document + + + + + Replaces the inner text of an xml node in the XML document specified by a XPath expression. + + + + + Replaces text in the XML document specified by a XPath expression. + + + + + Gets the DocumentElement of the XmlDocument + + + + + Loads the given text into a XmlDocument + + + + + Parses a XML subnode + + + + + Parses a XmlNode + + + + + Gets the first sub node with the given name from the given XmlNode + + + + + Gets a sequence of all child nodes for the given XmlNode + + + + + Gets the attribute with the given name from the given XmlNode + + + + + Writes an CData element to the given XmlTextWriter + + + + + Writes an XML attribute to current element of the given XmlTextWriter + + + + + Writes an XML end element to the given XmlTextWriter + + + + + Writes an XML start element to the given XmlTextWriter + + + + + Writes an XML comment to the given XmlTextWriter + + + + + Creates a XmlWriter which writes to the given file name + + + + + Reads a value from a XML document using a XPath + Returns if the value is an int and the value + + + + + Reads a value from a XML document using a XPath + + + + + Contains functions to read and write XML files. + + + + + Option type for the HTTP verb + + + + + Executes an HTTP POST command and retrives the information. + It returns the response of the request, or null if we got 404 or nothing. + ## Parameters + + - `url` - The URL to perform the POST operation. + - `userName` - The username to use with the request. + - `password` - The password to use with the request. + - `data` - The data to post. + + + + + Executes an HTTP POST command and retrives the information. + This function will automatically include a "source" parameter if the "Source" property is set. + It returns the response of the request, or null if we got 404 or nothing. + ## Parameters + + - `headerF` - A function which allows to manipulate the HTTP headers. + - `url` - The URL to perform the POST operation. + - `userName` - The username to use with the request. + - `password` - The password to use with the request. + - `data` - The data to post. + + + + + Executes an HTTP GET command and retrives the information. + It returns the response of the request, or null if we got 404 or nothing. + ## Parameters + + - `userName` - The username to use with the request. + - `password` - The password to use with the request. + - `url` - The URL to perform the GET operation. + + + + + Contains functions to execute typical HTTP/REST calls. + + + + + The trace mode option. + + + + + The server type option. + + + + + Is true when the current build is a local build. + + + + + The current build version as detected from the current build server. + + + + + The current build server + + + + + AppVeyor build number + [omit] + + + + + CruiseControl.NET Build label + [omit] + + + + + Build number retrieved from Jenkins + [omit] + + + + + Build number retrieved from GitLab CI + [omit] + + + + + Checks if we are on GitLab CI + [omit] + + + + + Build number retrieved from Travis + [omit] + + + + + Build number retrieved from TeamCity + [omit] + + + + + Build number retrieved from Team Foundation + [omit] + + + + + Checks if we are on Team Foundation + [omit] + + + + + Checks if we are on Bamboo + [omit] + + + + + Build number retrieved from Bamboo + [omit] + + + + + Defines the XML output file - used for build servers like CruiseControl.NET. + This output file can be specified by using the *logfile* build parameter. + + + + + A constant label for local builds + [omit] + + + + + Defines if FAKE will use verbose tracing. + This flag can be specified by setting the *verbose* build parameter. + + + + + Contains functions which allow build scripts to interact with a build server. + + + + + Writes the given message to the xml file. + + + + + Implements a TraceListener which writes NAnt like XML files. + ## Parameters + - `xmlOutputFile` - Defines the xml output file. + + + + + Writes the given message to the Console. + + + + + Implements a TraceListener for System.Console. + ## Parameters + - `importantMessagesToStdErr` - Defines whether to trace important messages to StdErr. + - `colorMap` - A function which maps TracePriorities to ConsoleColors. + + + + + Defines a TraceListener interface + + + + + Defines Tracing information for TraceListeners + + + + + Allows to post messages to all trace listeners + + + + + Allows to register a new Xml listeners + + + + + A List with all registered listeners + + + + + Specifies if the XmlWriter should close tags automatically + + + + + The default TraceListener for Console. + + + + + A default color map which maps TracePriorities to ConsoleColors + + + + + Defines default listeners for build output traces + + + + + Get if the current branch is the one configured as default + + + + + Get the display name of the branch as shown in TeamCity + See [the documentation](https://confluence.jetbrains.com/display/TCD18/Working+with+Feature+Branches#WorkingwithFeatureBranches-branchSpec) for more information + + + + + Get the branch of the main VCS root + + + + + Name of recently failing tests + See [the documentation](https://confluence.jetbrains.com/display/TCD18/Risk+Tests+Reordering+in+Custom+Test+Runner) for more information + + + + + The Build number assigned to the build by TeamCity using the build number format or None if it's not on TeamCity. + + + + + Is set to true if the build is a personal one. + + + + + The Name of the Build Configuration the current build belongs to or None if it's not on TeamCity. + + + + + The Name of the project the current build belongs to or None if it's not on TeamCity. + + + + + The Version of the TeamCity server. This property can be used to determine the build is run within TeamCity. + + + + + Reports a failed comparison. + + + + + Reports a failed test. + + + + + Reports a parameter value + + + + + Reports a build statistic. + + + + + Sets the TeamCity build number. + + + + + Publishes an artifact on the TeamcCity build server. + + + + + Reports the build status. + + + + + Create the build status. + [omit] + + + + + Reports the progress end. + + + + + Reports the progress start. + + + + + Reports the progress. + + + + + Starts the test suite. + + + + + Finishes the test suite. + + + + + Ignores the test case. + + + + + Ignores the test case. + + + + + Finishes the test case. + + + + + Starts the test case. + + + + + Send the PartCover xslt transformation rules (Input xlst and output files) to TeamCity + + + + + Sends the value for NCover /sort: argument to TeamCity + + + + + Sends the value for NCover /report: argument to TeamCity + + + + + Sends additional arguments for NCover 1.x to TeamCity + + + + + Sends the path to NCoverExplorer to TeamCity + + + + + Sends arguments for the NCover report generator to TeamCity + + + + + Sends the full path to NCover installation folder to TeamCity + + + + + Sends the full path to the dotCover home folder to override the bundled dotCover to TeamCity + + + + + Sends an dotcover, partcover, ncover or ncover3 results filename to TeamCity + + + + + Sends an dotcover, partcover, ncover or ncover3 results filename to TeamCity + + + + + Sends an ReSharper dupfinder.exe results filename to TeamCity + + + + + Sends an PMD Copy/Paste Detector results filename to TeamCity + + + + + Sends an PMD inspections results filename to TeamCity + + + + + Sends an FxCop inspection results filename to TeamCity + + + + + Sends an ReSharper inspectCode.exe results filename to TeamCity + + + + + Sends an JSLint results filename to TeamCity + + + + + Sends an FindBugs results filename to TeamCity + + + + + Sends an Checkstyle results filename to TeamCity + + + + + Sends an Google Test results filename to TeamCity + + + + + Sends an MSTest results filename to TeamCity + + + + + Sends an Maven Surefire results filename to TeamCity + + + + + Sends an JUnit Ant task results filename to TeamCity + + + + + Sends an FXCop results filename to TeamCity + + + + + Sends an NUnit results filename to TeamCity + + + + + Sends an error to TeamCity + + + + + Open Named Block that will be closed when the block is disposed + Usage: `use __ = teamCityBlock "My Block"` + + + + + Close Named Block + + + + + Open Named Block + + + + + Send message to TeamCity + + + + + Send message to TeamCity + + + + + Encapsulates special chars + + + + + + + + Type of modification for the file + + + + + Path of the file that changed, relative to the current checkout directory ('system.teamcity.build.checkoutDir') + + + + + Describe a change between builds + + + + + The type of change that occured + + + + + Changed files (since previous build) that are included in this build + See [the documentation](https://confluence.jetbrains.com/display/TCD18/Risk+Tests+Reordering+in+Custom+Test+Runner) for more information + + + + + Get files changed between builds in TeamCity + + + + + Get the value of a parameter by name + System ones are prefixed with 'system.', runner ones with 'runner.' and environment variables with 'env.' + + + + + Get all parameters + System ones are prefixed with 'system.', runner ones with 'runner.' and environment variables with 'env.' + + + + + Get the value of a runner parameter by name + + + + + Get all runner parameters + + + + + Get the value of a configuration parameter by name + + + + + Get all configuration parameters + + + + + Get the value of a system parameter by name + + + + + Get all system parameters + + + + + TeamCity build parameters + See [Predefined Build Parameters documentation](https://confluence.jetbrains.com/display/TCD18/Predefined+Build+Parameters) for more information + + + + + Contains helper functions which allow FAKE to communicate with a TeamCity agent + + + + + Record type which stores TeamCity project properties + + + + + Record type which stores Build configuration properties + + + + + Record type which stores Build properties + + + + + Record type which stores VCSRoot properties + + + + + Gets all projects on the TeamCity server. + + + + + Gets informnation about a project from the TeamCity server. + + + + + Gets information about a build configuration from the TeamCity server. + + + + + [omit] + + + + + Returns the REST version of the TeamCity server + + + + + [omit] + + + + + Contains functions which allow FAKE to interact with the [TeamCity REST API](http://confluence.jetbrains.com/display/TCD8/REST+API). + + + + + Logs the given files with the message. + + + + + Traces the message to the console + + + + + Traces the begin of a task and closes it again after disposing of the return value + (call it with 'use') + + + + + Traces the end of a task + + + + + Traces the begin of a task + + + + + Traces the end of a target + + + + + Traces the begin of a target + + + + + Removes an opening tag from the internal tag stack + + + + + Puts an opening tag on the internal tag stack + + + + + Traces the end of the build + + + + + Traces the begin of the build + + + + + Traces a header + + + + + Traces a line + + + + + Gets the FAKE Version string + + + + + Traces the EnvironmentVariables + + + + + Traces an exception details (in red) + + + + + Converts an exception and its inner exceptions to a nice string. + + + + + Traces an error (in red) + + + + + Writes a trace to the command line (in yellow) + + + + + Writes a trace to stderr (in yellow) + + + + + Writes a trace to the command line (in green) if the verbose mode is activated. + + + + + Writes a message to the command line (in green) and without a line break + + + + + Writes a message to the command line (in green) + + + + + Writes a trace to the command line (in green) + + + + + Logs the specified string if the verbose mode is activated. + + + + + Logs the specified message (without line break) + + + + + Logs the specified message + + + + + Logs the specified string + + + + + Gets the FAKE version no. + + + + + Gets the path of the current FAKE instance + + + + + This module contains function which allow to trace build output + + + + + Waits until the local service with the given name has been stopped or fails after given timeout + ## Parameters + - `name` - The name of the service in question. + - `timeout` - The timespan to time out after. + + + + + Waits until the remote service with the given name has been stopped or fails after given timeout + ## Parameters + - `host` - The hostname of the remote machine. + - `name` - The name of the service in question. + - `timeout` - The timespan to time out after. + + + + + Waits until the local service with the given name has been started or fails after given timeout + ## Parameters + - `name` - The name of the service in question. + - `timeout` - The timespan to time out after. + + + + + Waits until the remote service with the given name has been started or fails after given timeout + ## Parameters + - `host` - The hostname of the remote machine. + - `name` - The name of the service in question. + - `timeout` - The timespan to time out after. + + + + + Stops all local services with given name. + ## Parameters + - `name` - The name of the services in question. + + + + + Stops all services with given name. + ## Parameters + - `host` - The hostname of the remote machine. + - `name` - The name of the services in question. + + + + + Starts all local services with given name. + ## Parameters + - `name` - The name of the services in question. + + + + + Starts all remote services with given name. + ## Parameters + - `host` - The hostname of the remote machine. + - `name` - The name of the services in question. + + + + + Returns status of the local service with given name or fails when service is not found. + ## Parameters + - `name` - The name of the service in question. + + + + + Returns status of the remote service with given name or fails when service is not found. + ## Parameters + - `host` - The hostname of the remote machine. + - `name` - The name of the service in question. + + + + + Returns whether a local service with the given name exists. + ## Parameters + - `name` - The name of the service in question. + + + + + Returns whether a remote service with the given name exists. + ## Parameters + - `host` - The hostname of the remote machine. + - `name` - The name of the service in question. + + + + + Returns the first local service with given name or None. + ## Parameters + - `name` - The name of the service in question. + + + + + Returns the first remote service with given name or None. + ## Parameters + - `host` - The hostname of the remote machine. + - `name` - The name of the service in question. + + + + + Returns sequence of local services with given name. + ## Parameters + - `name` - The name of the services in question. + + + + + Returns sequence of remote services with given name. + ## Parameters + - `host` - The hostname of the remote machine. + - `name` - The name of the services in question. + + + + + Returns whether the given service has the given name as display or service name. + ## Parameters + - `name` - The name to check for. + - `service` - The service in question. + + + + + Get friendly service name for displaying in logs + + + + + Host value used for querying local services. + + + + + Contains tasks which allow to control NT services. + + + + + Runs the given process, waits for it's completion and returns the exit code. + ## Parameters + + - `cmd` - The command which should be run in elavated context. + - `args` - The process arguments (optional). + - `directory` - The working directory (optional). + + + + + Runs the given process asynchronously. + ## Parameters + + - `cmd` - The command which should be run in elavated context. + - `args` - The process arguments (optional). + - `directory` - The working directory (optional). + + + + + Allows to exec shell operations synchronously and asynchronously. + + + + + Command-line argument pairs. The value will be quoted if it contains + a string, and the result will be appended to the CommandLine property. + If the key ends in a letter or number, a space will be inserted between + the key and the value. + + + + + Command-line parameters in a string. + + + + + The working directory for the program. Defaults to "". + + + + + The path to the executable, without arguments. + + + + + Parameter type for process execution. + + + + + A process result including error code, message log and errors. + + + + + A record type which captures console messages + + + + + Execute an external program and return the exit code. + [omit] + + + + + Waits until the processes with the given name have stopped or fails after given timeout. + ## Parameters + - `name` - The name of the processes in question. + - `timeout` - The timespan to time out after. + + + + + Kills all processes that are created by the FAKE build script unless "donotkill" flag was set. + + + + + [omit] + + + + + Kills the MSBuild process. + + + + + Kills the F# Interactive (FSI) process. + + + + + Kills all processes with the given name + + + + + Returns all processes with the given name + + + + + Kills all processes with the given id + + + + + Kills the given process + + + + + Execute an external program asynchronously and return the exit code, + logging output and error messages to FAKE output. You can compose the result + with Async.Parallel to run multiple external programs at once, but be + sure that none of them depend on the output of another. + + + + + Default parameters for process execution. + + + + + Tries to find the tool via AppSettings. If no path has the right tool we are trying the PATH system variable. + [omit] + + + + + Tries to find the tool via AppSettings. If no path has the right tool we are trying the PATH system variable. + [omit] + + + + + tries to find the tool on the paths given. If not found then try on the system PATH. + [omit] + + + + + Returns the AppSettings for the key - Splitted on ; + [omit] + + + + + Searches the current directory and the directories within the PATH + environment variable for the given file. If successful returns the full + path to the file. + ## Parameters + - `file` - The file to locate + + + + + Searches the given directories for the given file, failing if not found. + [omit] + + + + + Searches the given directories for all occurrences of the given file name + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + Use default Parameters + [omit] + + + + + Adds quotes and a blank around the string´. + [omit] + + + + + Adds quotes around the string if needed + [omit] + + + + + Adds quotes around the string + [omit] + + + + + Starts a remote windows service. Waits up to two minutes for a response. + + + + + Starts a local windows service. Waits up to two minutes for a response. + + + + + Stops a remote windows service. Waits up to two minutes for a response. + + + + + Stops a local windows service. Waits up to two minutes for a response. + + + + + Sends a command to a local windows service. + + + + + Sends a command to a remote windows service. + + + + + Starts the given process and forgets about it. + + + + + Runs the given process, waits for its completion and returns if it succeeded. + + + + + Starts the given process and returns immediatly. + + + + + Runs the given process and returns true if the exit code was 0. + [omit] + + + + + Sets the environment Settings for the given startInfo. + Existing values will be overriden. + [omit] + + + + + Gets the list of valid directories included in the PATH environment variable. + + + + + Runs the given process in an elevated context and returns the exit code. + ## Parameters + + - `cmd` - The command which should be run in elavated context. + - `args` - The process arguments. + - `timeOut` - The timeout for the process. + + + + + Runs the given process and returns the exit code. + ## Parameters + + - `configProcessStartInfoF` - A function which overwrites the default ProcessStartInfo. + - `timeOut` - The timeout for the process. + ## Sample + + let result = ExecProcess (fun info -> + info.FileName <- "c:/MyProc.exe" + info.WorkingDirectory <- "c:/workingDirectory" + info.Arguments <- "-v") (TimeSpan.FromMinutes 5.0) + + if result <> 0 then failwithf "MyProc.exe returned with a non-zero exit code" + + + + + Runs the given process and returns if the exit code was 0. + ## Parameters + + - `configProcessStartInfoF` - A function which overwrites the default ProcessStartInfo. + - `timeOut` - The timeout for the process. + [omit] + + + + + Runs the given process and returns the exit code. + ## Parameters + + - `configProcessStartInfoF` - A function which overwrites the default ProcessStartInfo. + - `timeOut` - The timeout for the process. + [omit] + + + + + Runs the given process and returns the exit code. + ## Parameters + + - `configProcessStartInfoF` - A function which overwrites the default ProcessStartInfo. + - `timeOut` - The timeout for the process. + - `silent` - If this flag is set then the process output is redicted to the trace. + [omit] + + + + + Runs the given process and returns the process result. + ## Parameters + + - `configProcessStartInfoF` - A function which overwrites the default ProcessStartInfo. + - `timeOut` - The timeout for the process. + + + + + Runs the given process and returns the process result. + ## Parameters + + - `configProcessStartInfoF` - A function which overwrites the default ProcessStartInfo. + - `timeOut` - The timeout for the process. + + + + + Runs the given process and returns the exit code. + ## Parameters + + - `configProcessStartInfoF` - A function which overwrites the default ProcessStartInfo. + - `timeOut` - The timeout for the process. + - `silent` - If this flag is set then the process output is redirected to the given output functions `errorF` and `messageF`. + - `errorF` - A function which will be called with the error log. + - `messageF` - A function which will be called with the message log. + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + The ProcessHelper will start all processes with this encoding if AlwaysSetProcessEncoding is set to true. + If AlwaysSetProcessEncoding is set to false (default) only mono processes will be changed. + + + + + If set to true the ProcessHelper will start all processes with a custom ProcessEncoding. + If set to false (default) only mono processes will be changed. + + + + + Contains functions which can be used to start other tools. + + + + + Use Sysinternals PsExec to execute a process on a remote machine. + ## Parameters + + - `host` - The hostname of the machine to connect to. + - `username` - A username valid for connecting to the remote machine. + - `password` - The cleartext password of the given user. + - `exe` - The path to the file that is to be executed. + - `inputs` - The command-line arguments to pass to the remote process. + - `timeOut` - The timeout for PsExec. + + + + + Contains functions for working with Sysinternals PsExec + + + + + The Bower parameter type + + + + + The list of support Bower commands. The `Custom` alternative + can be used for other commands not in the list until they are + implemented + + + + + Arguments for the Bower install command + + + + + Runs bower with the given modification function. Make sure to have bower installed, + you can install bower with nuget or a regular install. To change which `Bower` executable + to use you can set the `BowerFilePath` parameter with the `setParams` function. + + ## Parameters + + - `setParams` - Function used to overwrite the Bower default parameters. + + ## Sample + + Target "Web" (fun _ -> + Bower (fun p -> + { p with + Command = Install Standard + WorkingDirectory = "./src/FakeSimple.Web/" + }) + + Bower (fun p -> + { p with + Command = (Run "build") + WorkingDirectory = "./src/FAKESimple.Web/" + }) + ) + + + + + Bower default parameters + + + + + Default paths to Bower + + + + + Contains function to run bower tasks + + + + + The Yarn parameter type + + + + + The list of supported Yarn commands. The `Custom` alternative + can be used for other commands not in the list until they are + implemented + + + + + Arguments for the Yarn install command + + + + + Runs yarn with the given modification function. Make sure to have yarn installed, + you can install yarn with nuget or a regular install. To change which `Yarn` executable + to use you can set the `YarnFilePath` parameter with the `setParams` function. + + ## Parameters + + - `setParams` - Function used to overwrite the Yarn default parameters. + + ## Sample + + Target "Web" (fun _ -> + Yarn (fun p -> + { p with + Command = Install Standard + WorkingDirectory = "./src/FAKESimple.Web/" + }) + + Yarn (fun p -> + { p with + Command = (Run "build") + WorkingDirectory = "./src/FAKESimple.Web/" + }) + ) + + + + + Yarn default parameters + + + + + Default paths to Yarn + + + + + Contains function to run yarn tasks + + + + + Committer email address + + + + + Committer name + + + + + Commit author email address + + + + + Commit author name + + + + + Commit date + + + + + Commit hash + + + + + Commit message + + + + + Build version; must be unique for the current project + + + + + AppVeyor parameters for update build as [described](https://www.appveyor.com/docs/build-worker-api/#update-build-details) + + + + + Type of the artifact + + + + + Deployment name + + + + + File name to display in the artifact tab + + + + + The full local path to the artifact + + + + + AppVeyor parameters for artifact push as [described](https://www.appveyor.com/docs/build-worker-api/#push-artifact) + + + + + Type of artifact that is pushed + + + + + Union type representing the available test result formats accepted by AppVeyor. + + + + + Timeout in seconds to download repository (GitHub, Bitbucket or VSTS) as zip file (shallow clone). Default is 1800 (30 minutes) + + + + + contains tag name for builds started by tag + + + + + true if build has started by pushed tag; otherwise false + + + + + git or mercurial + + + + + GitHub, BitBucket or Kiln + + + + + Repository name in format owner-name/repo-name + + + + + Commit date/time + + + + + The rest of the commit message after line break (if exists) + + + + + Commit message + + + + + Commit author's email address + + + + + Commit author's name + + + + + Commit ID (SHA) + + + + + Build branch + + + + + GitHub Pull Request title + + + + + GitHub Pull Request Repo name + + + + + GitHub Pull Request branch + + + + + GitHub Pull Request number + + + + + Project slug (as seen in project details URL) + + + + + Project name + + + + + AppVeyor unique project ID + + + + + Platform name set on Build tab of project settings (or through platform parameter in appveyor.yml). + + + + + The Job Number + + + + + The job name + + + + + AppVeyor unique job ID + + + + + If the build runs by scheduler; + + + + + If the build has been started by the "Re-Build commit/PR" button or from the same API + + + + + If the build has been started by the "New Build" button or from the same API + + + + + Timeout in seconds to download arbirtary files using appveyor DownloadFile command. Default is 300 (5 minutes) + + + + + Configuration name set on Build tab of project settings (or through configuration parameter in appveyor.yml). + + + + + set to true to disable cache update + + + + + set to true to disable cache restore + + + + + Timeout in seconds to download or upload each cache entry. Default is 300 (5 minutes) + + + + + Current build worker image the build is running on, e.g. Visual Studio 2015 + + + + + Build version + + + + + Build number + + + + + AppVeyor unique build ID + + + + + Path to clone directory + + + + + Artifact upload timeout in seconds. Default is 600 (10 minutes) + + + + + AppVeyor Build Agent API URL + + + + + AppVeyor Account Name + + + + + AppVeyor environment variables as [described](http://www.appveyor.com/docs/environment-variables) + + + + + Update build version. This must be unique for the current project. + + + + + Update build details + + + + + Push multiple artifacts + + + + + Push an artifact + + + + + AppVeyor artifact push default parameters + + + + + Set environment variable + + + + + Uploads all the test results ".xml" files in a directory to make them visible in Test tab of the build console. + + + + + Uploads a test result file to make them visible in Test tab of the build console. + + + + + Finishes the test case. + + + + + Reports a succeeded test. + + + + + Ignores the test case. + + + + + Reports a failed test. + + + + + Starts the test case. + + + + + Starts the test suite. + + + + + Finishes the test suite. + + + + + Contains code to configure FAKE for AppVeyor integration + + + + + The tag of a commit that kicked off the build. This value is only available on tags. + + + + + The URL-friendly version of a repository name. + + + + + The name of the account in which the repository lives + + + + + The commit hash of a commit that kicked off the build + + + + + The absolute path of the directory that the repository is cloned into within the Docker container. + + + + + Default value is true. Gets set whenever a pipeline runs. + + + + + The branch on which the build was kicked off. This value is only available on branches. + + + + + Bitbucket Pipelines environment variables as [described](https://confluence.atlassian.com/bitbucket/environment-variables-in-bitbucket-pipelines-794502608.html) + + + + + Contains code to configure FAKE for Bitbucket Pipelines integration + + + + + Retries the given function until a retry limit is reached or the function succeeds without exception. + ## Parameters + + - `f` - This function will be started. + - `retries` - A retry limit. + + + + + Waits until the given function returns true or the timeout is reached. + ## Parameters + + - `f` - This function will be started. + - `timeout` - A System.TimeSpan representing the timeout. + - `testMS` - An interval at which FAKE checks if the function has succeeded. + - `timeoutF` - This function will be run if the timeout has been reached. + + + + + Contains a helper which can be used to implement timeouts and retries. + + + + + This module contains a file pattern globbing implementation. + + + + + Sets a directory as BaseDirectory. + + + + + Checks if a particular file is matched + + + + + Ignores files with the given pattern + + + + + Adds the given pattern to the file includes + + + + + Internal representation of a file set. + + + + + Looks for a tool in all subfolders - returns the folder where the tool was found. + + + + + Looks for a tool first in its default path, if not found the in ./packages/ and then + in all subfolders of the root folder - returns the tool file name. + + + + + Includes a single pattern and scans the files - !! x = AllFilesMatching x + + + + + Exclude operator + + + + + Add Include operator + + + + + Sets a directory as baseDirectory for fileIncludes. + + + + + Include files + + + + + This module contains a file pattern globbing implementation. + + + + + Get the directory of the specified path + ## Parameters + + - 'path' - The path from which the directory is retrieved. + + + + + Get the filename for the specified path without it's extension + ## Parameters + + - 'path' - The path from which the filename is retrieved. + + + + + Get the filename for the specified path + ## Parameters + + - 'path' - The path from which the filename is retrieved. + + + + + Tests whether the file has specified extensions (containing the leading '.') + ## Parameters + + - 'extension' - The extension to fine containing the leading '.'. + - 'fileName' - Name of the file from which the extension is retrieved. + + + + + Change the extension of the file. + ## Parameters + + - 'extension' - The new extension containing the leading '.'. + - 'fileName' - Name of the file from which the extension is retrieved. + + + + + Get the filename extension including the leading '.', or an empty string if the file has no extension. + ## Parameters + + - 'fileName' - Name of the file from which the extension is retrieved. + + + + + Get the version a file. + ## Parameters + + - 'fileName' - Name of file from which the version is retrieved. The path can be relative. + + + + + Replace all occurences of the regex pattern with the given replacement in the specified files + ## Parameters + + - `pattern` - The string to search for a match + - `replacement` - The replacement string + - `encoding` - The encoding to use when reading and writing the files + - `files` - The paths of the files to process + + + + + Replace all occurences of the regex pattern with the given replacement in the specified file + ## Parameters + + - `pattern` - The string to search for a match + - `replacement` - The replacement string + - `encoding` - The encoding to use when reading and writing the file + - `file` - The path of the file to process + + + + + Replaces all occurences of the patterns in the given files with the given replacements. + ## Parameters + + - `replacements` - A sequence of tuples with the patterns and the replacements. + - `files` - The files to process. + + + + + Creates a config file with the parameters as "key;value" lines + + + + + Moves a single file to the target and overwrites the existing file. + ## Parameters + + - `target` - The target directory. + - `fileName` - The FileName. + + + + + Copies the file structure recursively. + + + + + Copies the file structure recursively. + + + + + Checks the srcFiles for changes to the last release. + ## Parameters + + - `lastReleaseDir` - The directory of the last release. + - `patchDir` - The target directory. + - `srcFiles` - The source files. + + + + + Checks the srcFiles for changes to the last release. + ## Parameters + + - `lastReleaseDir` - The directory of the last release + - `patchDir` - The target directory + - `srcFiles` - The source files + - `findOldFileF` - A function which finds the old file + + + + + Checks if the file exists + + + + + Checks if the directory exists + + + + + Compares the given files for changes. + If delete is set to true then equal files will be removed. + + + + + Checks if the two files are byte-to-byte equal. + + + + + Appends all given files to one file. + ## Parameters + + - `newFileName` - The target FileName. + - `files` - The original FileNames as a sequence. + + + + + Reads a csv file line by line + delimiter is a , + + + + + Deletes multiple directories + + + + + Cleans multiple directories + + + + + Cleans a directory by removing all files and sub-directories. + + + + + Copies a directory recursivly. If the target directory does not exist, it will be created. + ## Parameters + + - `target` - The target directory. + - `source` - The source directory. + - `filterFile` - A file filter predicate. + + + + + Includes all files + + + + + Exclude SVN files (path with .svn) + + + + + Copies the files to the target - Alias for Copy + ## Parameters + + - `target` - The target directory. + - `files` - The orginal file names. + + + + + Copies a list of files to the specified directory without any output. + ## Parameters + + - `target` - The target directory. + - `files` - List of files to copy. + + + + + Renames the file or directory to the target name. + ## Parameters + + - `target` - The target file or directory name. + - `fileName` - The orginal file or directory name. + + + + + Copies the files from a cache folder. + If the files are not cached or the original files have a different write time the cache will be refreshed. + ## Parameters + + - `target` - The target FileName. + - `cacheDir` - The cache directory. + - `files` - The orginal files. + + + + + Copies the given files to the target. + ## Parameters + + - `target` - The target directory. + - `files` - The original file names as a sequence. + + + + + Copies the files to the target. + ## Parameters + + - `target` - The target directory. + - `files` - The original file names as a sequence. + + + + + Copies several file groups, each represented by a FileIncludes object, + to the target folder preserving the folder structure + starting from the BaseDirectory of each FileIncludes. + ## Parameters + + - `target` - The target directory. + - `files` - A sequence of file groups. + + + + + Copies a single file to the target folder preserving the folder structure + starting from the specified base folder. + ## Parameters + + - `baseDir` - The base directory. + - `target` - The target directory. + - `fileName` - The file name. + + + + + Copies a single file to a relative subfolder of the target. + ## Parameters + + - `target` - The target directory + - `fileName` - The fileName + + + + + Copies a single file to the target and overwrites the existing file. + ## Parameters + + - `target` - The target directory or file. + - `fileName` - The FileName. + + + + + Active Pattern for determining FileInfoNameSections. + + + + + Active Pattern for determining file name. + + + + + Active Pattern for determining file extension. + + + + + Active pattern which discriminates between files and directories. + + + + + Deletes the given files. + + + + + Deletes a file if it exists. + + + + + Creates a file if it does not exist. + + + + + Creates a directory if it does not exist. + + + + + Deletes a directory if it exists. + + + + + Sets all given files readonly. + + + + + Sets all files in the directory readonly. + + + + + Sets the directory readonly + + + + + Performs the given actions on all files and subdirectories + + + + + Contains helper function which allow to deal with files and directories. + + + + + Like "mv" in a shell. Moves/renames a file + <param name="src">The source</param> + <param name="dest">The destination</param> + + + + + Restore the previous directory stored in the stack + + + + + Store the current directory in the directory stack before changing to a new one + + + + + The stack of directories operated on by pushd and popd + + + + + Gets working directory + + + + + Changes working directory + + + + + Changes working directory + + + + + Like "cp" in a shell. Copies a single file. + <param name="src">The source</param> + <param name="dest">The destination</param> + + + + + Like "cp -r" in a shell. Copies a file or directory recursively. + + The source + The destination + + + + Creates a directory if it doesn't exist. + + + + + Like "rm -rf" in a shell. Removes files recursively, ignoring nonexisting files + + + + + Deletes a file if it exists + + + + + Shell-like functions. Similar to [Ruby's FileUtils](http://www.ruby-doc.org/stdlib-2.0.0/libdoc/rake/rdoc/FileUtils.html). + + + + + Execute Fuchu tests from one or more assemblies. + Multiple assemblies are run concurrently. + ## Parameters + + - `testExes` - The paths of the executables containing Fuchu tests to run. + + + + + With this option set, no exception is thrown if a test is broken. + + + + + This option instructs FAKE to break the build if a test runner finds the first error. + + + + + This option instructs FAKE to break the build if a test runner reports an error. + + + + + Option which allows to specify if a test runner error should break the build. + + + + + This module contains types and functions that are common for unit test helpers. + + + + + Basic data type to represent test results + + + + + Basic data type to represent tests + + + + + Basic data type to represent test status + + + + + Reports the given test results to the detected build server + + + + + Reports the given test results to [AppVeyor](http://www.appveyor.com/). + + + + + Reports the given test results to [TeamCity](http://www.jetbrains.com/teamcity/). + + + + + This module contains functions which allow to report unit test results to build servers. + + + + + Returns whether all tests in the given test result have succeeded + + + + + [omit] + + + + + Merges non-empty list of test result XDocuments into a single XElement + + + + + Used by the NUnitParallel helper, can also be used to merge test results + from multiple calls to the normal NUnit helper. + + + + + Contains types and functions for working with [NUnit](http://www.nunit.org/) unit tests result xml. + + + + + Default: "" + + + + + Default: [TestRunnerErrorLevel](fake-unittestcommon-testrunnererrorlevel.html).Error + + + + + See [NUnitDomainModel](fake-nunitcommon-nunitdomainmodel.html). + + + + + Disables shadow copying of the assembly in order to provide improved performance. + + + + + The default timeout to be used for test cases. If any test exceeds the timeout value, it is cancelled and reported as an error. + + + + + The path to a custom XSLT transform file to be used to process the XML report. + + + + + The working directory. + + + + + Causes an identifying label to be displayed at the start of each test case. + + + + + Controls how NUnit loads tests in processes. See: [NUnitProcessModel](fake-nunitcommon-nunitprocessmodel.html). + + + + + Allows you to specify the version of the runtime to be used in executing tests. + + + + + Redirects error output created by the tests from standard error output (console) to the file specified as value. + + + + + Redirects output created by the tests from standard output (console) to the file specified as value. + + + + + The output path of the nUnit XML report. + + + + + Gives ability to not error if an assembly with no tests is passed into nunit + + + + + Causes execution of the test run to terminate immediately on the first test failure or error. + + + + + Suppresses use of a separate thread for running the tests and uses the main thread instead. + + + + + NUnit console runner name. ( `nunit-console.exe`) + + + + + The path to the NUnit console runner: `nunit-console.exe` + + + + + The [Categories](http://www.nunit.org/index.php?p=category&r=2.6.4) to be excluded in a test run. Multiple categories may be specified on either option, by using commas to separate them. + + + + + The [Categories](http://www.nunit.org/index.php?p=category&r=2.6.4) to be included in a test run. Multiple categories may be specified on either option, by using commas to separate them. + + + + + The [NUnit](http://www.nunit.org/) Console Parameters type. + FAKE will use [NUnitDefaults](fake-nunitcommon.html) for values not provided. + + For reference, see: [NUnit-Console Command Line Options](http://www.nunit.org/index.php?p=consoleCommandLine&r=2.6.4) + + + + + A separate test domain is created for each assembly + + + + + A test domain is created - this is how NUnit worked prior to version 2.4 + + + + + No domain is created - the tests are run in the primary domain. This normally requires copying the NUnit assemblies into the same directory as your tests. + + + + + The default is to use multiple domains if multiple assemblies are listed on the command line. Otherwise a single domain is used. + + + + + The /domain option controls of the creation of AppDomains for running tests. See [NUnit-Console Command Line Options](http://www.nunit.org/index.php?p=consoleCommandLine&r=2.6.4) + + + + + Process model for nunit to use, see [Project Editor](http://www.nunit.org/index.php?p=projectEditor&r=2.6.4) + + + + + Option which allows to specify if a NUnit error should break the build. + + + + + NUnit console returns negative error codes for errors and sum of failed, ignored and exceptional tests otherwise. + Zero means that all tests passed. + + + + + Tries to detect the working directory as specified in the parameters or via TeamCity settings + [omit] + + + + + Builds the command line arguments from the given parameter record and the given assemblies. + [omit] + + + + + The [NUnitParams](fake-nunitcommon-nunitparams.html) default parameters. + + ## Defaults + - `IncludeCategory` - `""` + - `ExcludeCategory` - `""` + - `ToolPath` - The `nunit-console.exe` path if it exists in a subdirectory of the current directory. + - `ToolName` - `"nunit-console.exe"` + - `DontTestInNewThread`- `false` + - `StopOnError` - `false` + - `SkipNonTestAssemblies` - `false` + - `OutputFile` - `"TestResult.xml"` + - `Out` - `""` + - `ErrorOutputFile` - `""` + - `WorkingDir` - `""` + - `Framework` - `""` + - `ProcessModel` - `DefaultProcessModel` + - `ShowLabels` - `true` + - `XsltTransformFile` - `""` + - `TimeOut` - 5 minutes + - `DisableShadowCopy` - `false` + - `Domain` - `DefaultDomainModel` + - `ErrorLevel` - `Error` + - `Fixture` - `""` + + + + + Contains types and utility functions relaited to running [NUnit](http://www.nunit.org/) unit tests. + + + + + Runs NUnit on a group of assemblies. + ## Parameters + + - `setParams` - Function used to manipulate the default [NUnitParams](fake-nunitcommon-nunitparams.html) value. + - `assemblies` - Sequence of one or more assemblies containing NUnit unit tests. + + ## Sample usage + + Target "Test" (fun _ -> + !! (testDir + @"\Test.*.dll") + |> NUnit (fun p -> { p with ErrorLevel = DontFailBuild }) + ) + + + + + Contains tasks to run [NUnit](http://www.nunit.org/) unit tests. + + + + + Runs NUnit in parallel on a group of assemblies. + ## Parameters + + - `setParams` - Function used to manipulate the default [NUnitParams](fake-nunitcommon-nunitparams.html) value. + - `assemblies` - Sequence of one or more assemblies containing NUnit unit tests. + + ## Sample usage + + Target "Test" (fun _ -> + !! (testDir + @"\Test.*.dll") + |> NUnitParallel (fun p -> { p with ErrorLevel = DontFailBuild }) + ) + + + + + Contains tasks to run [NUnit](http://www.nunit.org/) unit tests in parallel. + + + + + Exclude named traits with comma separated values + + + + + Include named traits with comma separated values + + + + + Test runner error level. Option which allows to specify if an xUnit error should break the build. + + + + + The output directory. It's the current directoy if nothing else is specified. + + + + + If the timeout is reached the xUnit task will be killed. Default is 5 minutes. + + + + + If set to true xUnit will generate verbose output. + + + + + If set to true xUnit will run in ShadowCopy mode. + + + + + The working directory (optional). + + + + + If set to true XML output will be generated. + + + + + If set to true a HTML output file will be generated in NUnit format. + + + + + If set to true a HTML output file will be generated. + + + + + The file name of the config file (optional). + + + + + The path to the xunit.console.clr4.exe - FAKE will scan all subfolders to find it automatically. + + + + + DEPRECATED. + The xUnit parameter type + + + + + DEPRECATED. + Option which allows to specify if an xUnit error should break the build. + + + + + DEPRECATED. See [`Fake.Testing.XUnit.xUnit`](fake-testing-xunit.html). + + Runs xUnit unit tests in the given assemblies via the given xUnit runner. + Will fail if the runner terminates with non-zero exit code for any of the assemblies. + Offending assemblies will be listed in the error message. + + The xUnit runner terminates with a non-zero exit code if any of the tests + in the given assembly fail. + ## Parameters + + - `setParams` - Function used to manipulate the default XUnitParams value. + - `assemblies` - Sequence of one or more assemblies containing xUnit unit tests. + + ## Sample usage + + Target "Test" (fun _ -> + !! (testDir + @"\xUnit.Test.*.dll") + |> xUnit (fun p -> {p with OutputDir = testDir }) + ) + + + + + DEPRECATED. + Builds the command line arguments from the given parameter record and the given assemblies. + [omit] + + + + + DEPRECATED. + + + + + DEPRECATED. + The xUnit default parameters + + + + + DEPRECATED. See [`Fake.Testing.XUnit`](fake-testing-xunit.html). + + Contains tasks to run [xUnit](https://github.com/xunit/xunit) unit tests. + + + + + With this option set, no exception is thrown if a test is broken. + + + + + This option instructs FAKE to break the build if a test runner finds the first error. + + + + + This option instructs FAKE to break the build if a test runner reports an error. + + + + + Option which allows to specify if a test runner error should break the build. + + + + + Read settings from configuration file + + + + + Individual global settings for SonarQube + + + + + Version number of the project + + + + + Name of the project + + + + + Key to identify the SonarQube project + + + + + FileName of the SonarQube runner exe. + + + + + Parameter type to configure the SonarQube runner. + + + + + [omit] + The supported commands of SonarQube. It is called with Begin before compilation, and End after compilation. + + + + + open Fake.Testing + + SonarQube.finish None + + SonarQube.finish (Some (fun p -> + {p with + Settings = ["sonar.login=login"; "sonar.password=password"] })) + + + + + + open Fake.Testing + + SonarQube.start (fun p -> + {p with + Key = "MyProject" + Name = "MainTool" + Version = "1.0 }) + + + + + + [omit] + Execute the external msbuild runner of SonarQube. Parameters are given to the command line tool as required. + + + + + SonarQube default parameters - tries to locate MSBuild.SonarQube.exe in any subfolder. + + + + + Contains a task to run the msbuild runner of [SonarQube analyzer](http://sonarqube.org). + + + + + Working directory + + + + + Prints the version on startup. Default is true + + + + + Custom arguments to use in the case the helper not yet supports them + + + + + Doesn't run tests, print out list of tests instead. + + + + + Run only provided tests. + + + + + Filter a specific test list to run. + + + + + Filter a specific test case to run. + + + + + Filter a specific hierarchy to run. + + + + + Fails the build if focused tests exist. Default is true + + + + + Prints out summary after all tests are finished including their source code location. + + + + + Prints out summary after all tests are finished. + + + + + Number of parallel workers (defaults to the number of logical processors). + + + + + Run all tests in parallel. Default is true. + + + + + Extra verbose output for your tests. + + + + + CLI parameters available if you use Tests.runTestsInAssembly defaultConfig argv in your code: + + + + + Contains tasks to run [expecto](https://github.com/haf/expecto) v2 unit tests. + + + + + A test parameter specified in the form name=value. Multiple parameters may be specified, separated by semicolons + + + + + Skips assemblies that do not contain tests or assemblies that contain the NUnit.Framework.NonTestAssemblyAttribute without raising an error + + + + + Controls the trace logs NUnit3 will output, defaults to Off + + + + + Default: [TestRunnerErrorLevel](fake-unittestcommon-testrunnererrorlevel.html).Error + + + + + Specify whether to write test case names to the output. + + + + + Turns on use of TeamCity service messages. + + + + + Tells .NET to copy loaded assemblies to the shadowcopy directory. + + + + + Output specs for saving the test results. Default value is TestResult.xml + Passing empty list does not save any result (--noresult option in NUnit) + For more information, see: [NUnit3 command line options](https://github.com/nunit/docs/wiki/Console-Command-Line) + + + + + File path to contain error output from the tests. + + + + + File path to contain text output from the tests. + + + + + Path of the directory to use for output files. + + + + + Causes execution of the test run to terminate immediately on the first test failure or error. + + + + + Specify the NUMBER of worker threads to be used in running tests. + This setting is used to control running your tests in parallel and is used in conjunction with the Parallelizable Attribute. + If not specified, workers defaults to the number of processors on the machine, or 2, whichever is greater. + + + + + Set the random seed used to generate test cases + + + + + The default timeout to be used for test cases. If any test exceeds the timeout value, it is cancelled and reported as an error. + + + + + Dispose each test runner after it has finished running its tests + + + + + Run tests in a 32-bit process on 64-bit systems. + + + + + Allows you to specify the version of the runtime to be used in executing tests. + Default value is runtime under which the assembly was built. See: [NUnit3Runtime](fake-testing-nunit3-nunit3runtime.html). + + + + + Controls how NUnit loads tests in processes. See: [NUnit3ProcessModel](fake-testing-nunit3-nunit3domainmodel.html). + + + + + Number of agents that may be allowed to run simultaneously assuming you are not running inprocess. + If not specified, all agent processes run tests at the same time, whatever the number of assemblies. + This setting is used to control running your assemblies in parallel. + + + + + Controls how NUnit loads tests in processes. See [NUnit3ProcessModel](fake-testing-nunit3-nunit3processmodel.html) + + + + + Name of a project configuration to load (e.g.: Debug) + + + + + An expression indicating which tests to run. It may specify test names, classes, methods, + catgories or properties comparing them to actual values with the operators ==, !=, =~ and !~. + See [NUnit documentation](https://github.com/nunit/docs/wiki/Test-Selection-Language) for a full description of the syntax. + + + + + The name (or path) of a file containing a list of tests to run or explore, one per line. + + + + + The path to the NUnit3 console runner: `nunit3-console.exe` + + + + + The NUnit 3 Console Parameters type. FAKE will use [NUnit3Defaults](fake-testing-nunit3.html) for values not provided. + + For reference, see: [NUnit3 command line options](https://github.com/nunit/docs/wiki/Console-Command-Line) + + + + + The --labels option in NUnit3 console runner. Specify whether to write test case names to the output. + + + + + The --trace option in NUnit3 console runner. Specifies the internal nunit runner log level. + + + + + Option which allows to specify if a NUnit error should break the build. + + + + + NUnit should use runtime specified by this value + + + + + NUnit should use Mono framework but can select its version + + + + + NUnit should use .NET framework but can select its version + + + + + Uses the runtime under which the assembly was built. + + + + + The --framework option in running NUnit 3. There are three kinds - VXY, which means either .NET framework or Mono, NetXY (use .NET framework with given version) + and MonoXY (Mono framework with given version). You can use Net or Mono to let NUnit select the version. + You can pass any value using Other. + + + + + A separate test domain is created for each assembly + + + + + A test domain is created - this is how NUnit worked prior to version 2.4 + + + + + No domain is created - the tests are run in the primary domain. This normally requires copying the NUnit assemblies into the same directory as your tests. + + + + + The default is to use multiple domains if multiple assemblies are listed on the command line. Otherwise a single domain is used. + + + + + The --domain option controls of the creation of AppDomains for running tests. See [NUnit-Console Command Line Options](http://www.nunit.org/index.php?p=consoleCommandLine&r=2.6.4) + + + + + Process model for NUnit 3 to use. + + + + + Tries to detect the working directory as specified in the parameters or via TeamCity settings + [omit] + + + + + The [NUnit3Params](fake-testing-nunit3-nunit3params.html) default parameters. + + - `ToolPath` - The `nunit-console.exe` path if it exists in `tools/Nunit/`. + - `Testlist` - `""` + - `Where` - `""` + - `Config` - `""` + - `ProcessModel` - `DefaultProcessModel` + - `Agents` - `None` + - `Domain` - `DefaultDomainModel` + - `Framework` - `""` + - `Force32bit` - `false` + - `DisposeRunners` - `false` + - `Timeout` - `2147483647 milliseconds` + - `Seed` - `-1` (negative seed is ignored by NUnit and is not sent to it) + - `Workers` - `None` + - `StopOnError` - `false` + - `WorkingDir` - `""` + - `OutputDir` - `""` + - `ErrorDir` - `""` + - `ResultSpecs` - `"TestResult.xml"` + - `ShadowCopy` - `false` + - `TeamCity` - `false` + - `ErrorLevel` - `Error` + - `TraceLevel` - `Default` (By default NUnit3 sets this to off internally) + - `SkipNonTestAssemblies` - `false` + - `Params` - `""` + ## Defaults + + + + + Forces TeamCity mode (normally auto-detected) + + + + + List of traits to exclude. + + + + + List of traits to include. + + + + + Test runner error level. + + + + + Maximum time to allow xUnit to run before being killed. + + + + + Run xUnit without reporting test progress. + + + + + Run xUnit with shadow copy enabled. + + + + + The working directory for running the xunit console rnner. + + + + + The output path of the xUnit XML report. + + + + + The output path of the xUnit XML report (in the NUnit style). + + + + + The output path of the xUnit HTML report. + + + + + The path to the xUnit console runner: `xunit.console.clr4.exe` + + + + + The xUnit parameter type. + + + + + Runs xUnit unit tests in the given assemblies via the given xUnit runner. + Will fail if the runner terminates with non-zero exit code for any of the assemblies. + + The xUnit runner terminates with a non-zero exit code if any of the tests + in the given assembly fail. + + This task runs xUnit once per assembly specified, prepending the assembly file name to + the output report filenames to ensure that there is a unique report file for each + assembly tested. + + ## Parameters + + - `setParams` - Function used to manipulate the default XUnitParams value. + - `assemblies` - Sequence of one or more assemblies containing xUnit unit tests. + + ## Sample usage + The sample below will generate HTML reports in `testDir` with names following the + pattern `xUnit.Test.Example.dll.html`. + + Target "Test" (fun _ -> + !! (testDir @@ "xUnit.Test.*.dll") + |> xUnit (fun p -> {p with HtmlOutputPath = testDir @@ "html"}) + ) + + + + + Runs xUnit unit tests in the given assemblies via the given xUnit runner. + Will fail if the runner terminates with non-zero exit code for any of the assemblies. + + The xUnit runner terminates with a non-zero exit code if any of the tests + in the given assembly fail. + + ## Parameters + + - `setParams` - Function used to manipulate the default `XUnitParams` value. + - `assemblies` - Sequence of one or more assemblies containing xUnit unit tests. + + ## Sample usage + + Target "Test" (fun _ -> + xUnit (fun p -> {p with HtmlOutputPath = testDir @@ "xunit.html"}) "xUnit.Test.dll" + ) + + + + + The xUnit default parameters. + + ## Defaults + + - `HtmlOutputPath` - `None` + - `XmlOutputPath` - `None` + - `NUnitXmlOutputPath` - `None` + - `IncludeTraits` - `[]` + - `ExcludeTraits` - `[]` + - `ShadowCopy` - `true` + - `ErrorLevel` - `Error` + - `ToolPath` - The `xunit.console.clr4.exe` path if it exists in a subdirectory of the current directory. + - `WorkingDir` - `None` + - `TimeOut` - 5 minutes + - `ForceTeamCity` - `false` + - `Silent` - `false` + + + + + Contains tasks to run [xUnit](https://github.com/xunit/xunit) v1 unit tests. + + + + + Run xUnit against a specific method + + + + + Run xUnit against a specific class + + + + + Run xUnit against a specific namespace + + + + + Waits for input after completion. + + + + + Forces AppVeyor CI mode (normally auto-detected). + + + + + Forces TeamCity mode (normally auto-detected). + + + + + List of traits to exclude. + + + + + List of traits to include. + + + + + Test runner error level. + + + + + Maximum time to allow xUnit to run before being killed. + + + + + Run xUnit without reporting test progress. + + + + + Run xUnit with shadow copy enabled. + + + + + The working directory for running the xunit console runner. + + + + + The output path of the NUnit XML report. + + + + + The output path of the xUnit XML report (in the xUnit v1 style). + + + + + The output path of the xUnit XML report. + + + + + The output path of the xUnit HTML report. + + + + + The xUnit thread limiting strategy. + + + + + The xUnit parallelization mode. + + + + + Do not use app domains to run test code. + + + + + The path to the xUnit console runner: `xunit.console.exe` + + + + + The xUnit2 parameter type. + + + + + Limits the number of concurrently executing collections to `count`. + + + + + Does not limit the number of concurrently executing collections. + + + + + Uses the default concurrency mode for collections. + + + + + The collection concurrency mode used by the xUnit2 runner. + + + + + Parallelize assemblies and collections. + + + + + Only parallelize assemblies. + + + + + Only parallelize collections. + + + + + Turn off all parallelization. + + + + + The parallelization mode of the xUnit2 runner. + + + + + Runs xUnit v2 unit tests in the given assemblies via the given xUnit2 runner. + Will fail if the runner terminates with non-zero exit code. + + The xUnit2 runner terminates with a non-zero exit code if any of the tests + in the given assembly fail. + + ## Parameters + + - `setParams` - Function used to manipulate the default `XUnit2Params` value. + - `assemblies` - Sequence of one or more assemblies containing xUnit unit tests. + + ## Sample usage + + Target "Test" (fun _ -> + !! (testDir @@ "xUnit.Test.*.dll") + |> xUnit2 (fun p -> { p with HtmlOutputPath = Some (testDir @@ "xunit.html") }) + ) + + + + + Helper method to detect if the xunit console runner supports the -noappdomain flag. + If the xunit console runner does not support this flag, it will change the value to false + so it does not interfere with older versions. + + + + + The xUnit2 default parameters. + + ## Defaults + + - `NoAppDomain` - `false` + - `Parallel` - `NoParallelization` + - `MaxThreads` - `Default` + - `HtmlOutputPath` - `None` + - `XmlOutputPath` - `None` + - `XmlV1OutputPath` - `None` + - `IncludeTraits` - `[]` + - `ExcludeTraits` - `[]` + - `ShadowCopy` - `true` + - `ErrorLevel` - `Error` + - `ToolPath` - The `xunit.console.exe` path if it exists in a subdirectory of the current directory. + - `WorkingDir` - `None` + - `TimeOut` - 5 minutes + - `ForceTeamCity` - `false` + - `ForceAppVeyor` - `false` + - `Silent` - `false` + - `Wait` - `false` + - `Namespace` - `None` + - `Class` - `None` + - `Method` - `None` + + + + + Contains tasks to run [xUnit](https://github.com/xunit/xunit) v2 unit tests. + + + + + output directory + + + + + output results to HTML file + + + + + output results to xUnit.net v1 style XML file + + + + + output results to xUnit.net v2 style XML file + + + + + Exclude named traits with comma separated values + + + + + Include named traits with comma separated values + + + + + Test runner error level. Option which allows to specify if an xUnit error should break the build. + + + + + If the timeout is reached the xUnit task will be killed. Default is 5 minutes. + + + + + The working directory (optional). + + + + + forces AppVeyor CI mode (normally auto-detected) + + + + + forces TeamCity mode (normally auto-detected) + + + + + Shadow copy + + + + + Output running test count + + + + + maximum thread count for collection parallelization + 0 - run with unbounded thread count + >0 - limit task thread pool size to 'count' + + + + + set parallelization based on option + none - turn off all parallelization + collections - only parallelize collections + assemblies - only parallelize assemblies + all - parallelize assemblies & collections + + + + + The file name of the config file (optional). + + + + + The path to the xunit.console.exe - FAKE will scan all subfolders to find it automatically. + + + + + DEPRECATED. + The xUnit parameter type + + + + + DEPRECATED. + Option which allows to specify if an xUnit error should break the build. + + + + + DEPRECATED. + + + + + DEPRECATED. See [`Fake.Testing.XUnit2.xUnit2`](fake-testing-xunit2.html). + + Runs xUnit unit tests in the given assemblies via the given xUnit runner. + Will fail if the runner terminates with non-zero exit code for any of the assemblies. + Offending assemblies will be listed in the error message. + + The xUnit runner terminates with a non-zero exit code if any of the tests + in the given assembly fail. + ## Parameters + + - `setParams` - Function used to manipulate the default XUnitParams value. + - `assemblies` - Sequence of one or more assemblies containing xUnit unit tests. + + ## Sample usage + + Target "Test" (fun _ -> + !! (testDir + @"\xUnit.Test.*.dll") + |> xUnit2 (fun p -> {p with OutputDir = testDir }) + ) + + + + + DEPRECATED. + Builds the command line arguments from the given parameter record and the given assemblies. + [omit] + + + + + DEPRECATED. + + + + + DEPRECATED. + The xUnit default parameters + + + + + DEPRECATED. See [`Fake.Testing.XUnit2`](fake-testing-xunit2.html). + + Contains tasks to run [xUnit](https://github.com/xunit/xunit) unit tests. + + + + + An error level setting to specify whether a failed test should break the build + + + + + A timeout for the test runner + + + + + Tests with theses tags are included by MSpec + + + + + Tests with theses tags are ignored by MSpec + + + + + Can be used to run MSpec in silent mode. + + + + + Working directory (optional) + + + + + Output file path for xml reports (optional). + + + + + Output directory for html reports (optional). + + + + + The path to the mspec console runner. Use `mspec-clr4.exe` if you are on .NET 4.0 or above. + + + + + Parameter type to configure the MSpec runner. + + + + + This task to can be used to run [machine.specifications](https://github.com/machine/machine.specifications) on test libraries. + ## Parameters + + - `setParams` - Function used to overwrite the MSpec default parameters. + - `assemblies` - The file names of the test assemblies. + + ## Sample + + !! (testDir @@ "Test.*.dll") + |> MSpec (fun p -> {p with ExcludeTags = ["HTTP"]; HtmlOutputDir = reportDir}) + + ## Hint + + XmlOutputPath expects a full file path whereas the HtmlOutputDir expects a directory name + + + + + Builds the command line arguments from the given parameter record and the given assemblies. + [omit] + + + + + MSpec default parameters - tries to locate mspec-clr4.exe in any subfolder. + + + + + Contains a task to run [machine.specifications](https://github.com/machine/machine.specifications) tests. + + + + + Run tests in isolation (optional). + + + + + Option which allow to specify if a MSTest error should break the build. + + + + + List of additional test case properties to display, if they exist (optional) + + + + + Path to MSTest.exe + + + + + A timeout for the test runner (optional) + + + + + List of tests be run (optional) + + + + + Working directory (optional) + + + + + Path to the Test Settings file (.testsettings) (optional) + + + + + Path to the Test Metadata file (.vsmdi) (optional) + + + + + Test results directory (optional) + + + + + Test category filter (optional). The test category filter consists of one or more test category names separated by the logical operators '&', '|', '!', '&!'. The logical operators '&' and '|' cannot be used together to create a test category filter. + + + + + Parameter type to configure the MSTest.exe. + + + + + Option which allow to specify if a MSTest error should break the build. + + + + + Runs MSTest command line tool on a group of assemblies. + ## Parameters + + - `setParams` - Function used to manipulate the default MSTestParams value. + - `assemblies` - Sequence of one or more assemblies containing Microsoft Visual Studio Unit Test Framework unit tests. + + ## Sample usage + + Target "Test" (fun _ -> + !! (testDir + @"\*.Tests.dll") + |> MSTest (fun p -> { p with Category = "group1" }) + ) + + + + + Builds the command line arguments from the given parameter record and the given assemblies. + [omit] + + + + + MSTest default parameters. + + + + + [omit] + + + + + [omit] + + + + + Contains tasks to run [MSTest](http://en.wikipedia.org/wiki/Visual_Studio_Unit_Testing_Framework/) unit tests. + + + + + Option which allows to specify if a test runner error should break the build. + + + + + If the timeout is reached the xUnit task will be killed. Default is 5 minutes. + + + + + The working directory (optional). + + + + + The ProcessTestRunner parameter type. + + + + + Runs the given processes and returns the process results. + ## Parameters + + - `setParams` - Function used to manipulate the default parameter value. + - `processes` - Sequence of one or more filenames and arguments to run. + + ## Sample usage + + Target "Test" (fun _ -> + ["process1.exe","argument1" + "process2.exe","argument2"] + |> RunConsoleTests (fun p -> {p with TimeOut = TimeSpan.FromMinutes 1. }) + ) + + + + + Runs the given processes and returns the process result messages. + + + + + Runs the given process and returns the process result. + + + + + The ProcessTestRunner defaults. + + + + + Allows to execute processes as unit tests. + + + + + Path to test adapter e.g. xUnit (optional) + + + + + Error level for controlling how VSTest failures should break the build (optional). + + + + + A timeout for the test runner (optional). + + + + + Working directory (optional). + + + + + Path to VSTest.Console.exe (optional). By default the default install location is searched. + + + + + List installed settings providers (optional). + + + + + List installed loggers (optional). + + + + + List installed test executors (optional). + + + + + List installed test discoverers (optional). + + + + + List discovered tests from the given container path (optional). + + + + + The logger to use for test results (optional). + + + + + Run tests that match the given expression (optional). Cannot be used with the Tests argument + + + + + Target .NET framework version to use for test execution (optional). + + + + + Target platform architecture for test execution (optional). Valid options include "x86", "x64" and "ARM". + + + + + Use installed VSIX extensions in VSTest (optional). + + + + + Run the tests in an isolated process (optional). + + + + + Enables code coverage collection (optional). + + + + + Names of the tests that should be run (optional). + + + + + Path to the run settings file to run tests with additional settings such as data collectors (optional). + + + + + Parameter type to configure [VSTest.Console.exe](https://msdn.microsoft.com/en-us/library/jj155800.aspx) + + + + + Option which allow to specify if a VSTest error should break the build. + + + + + Runs VSTest command line tool (VSTest.Console.exe) on a group of assemblies. + ## Parameters + + - `setParams` - Function used to manipulate the default VSTestParams values. + - `assemblies` - Sequence of one or more assemblies containing Microsoft Visual Studio Unit Test Framework unit tests. + + ## Sample usage + + Target "Test" (fun _ -> + !! (testDir + @"\*.Tests.dll") + |> VSTest (fun p -> { p with SettingsPath = "Local.RunSettings" }) + ) + + + + + Builds the command line arguments from the given parameter record and the given assemblies. + [omit] + + + + + VSTest default parameters. + + + + + [omit] + + + + + [omit] + + + + + Contains tasks to run [VSTest](https://msdn.microsoft.com/en-us/library/ms182486.aspx) unit tests. + + + + + Creates an attribute which holds the assembly version + + + + + Creates an attribute which holds the trademark + + + + + Creates an attribute which holds the product title + + + + + Creates a simple attribute with string values. Used as base for other attributes + + + + + Creates an attribute which holds the product name + + + + + Create an attribute which specifies metadata about the assembly + + + + + Creates an attribute which holds the assembly key name + + + + + Creates an attribute which holds the assembly key file + + + + + Creates an attribute which holds the "InternalVisibleTo" data + + + + + Creates an attribute which holds an assembly information version + + + + + Creates an attribute which holds the Guid + + + + + Creates an attribute which holds the assembly file version + + + + + Creates an attribute which holds the product description + + + + + Creates an attribute which specifies if the assembly uses delayed signing + + + + + Creates an attribute which holds the assembly culture information + + + + + Creates an attribute which holds the copyright information + + + + + Creates an attribute which holds the assembly configuration + + + + + Creates an attribute which holds the company information + + + + + Creates an attribute which specifies if the assembly is visible via COM + + + + + Creates an attribute which specifies if the assembly is CLS compliant + + + + + Creates a simple attribute with boolean values. Used as base for other attributes + + + + + Represents AssemblyInfo attributes + + + + + Represents options for configuring the emission of AssemblyInfo + + + + + Update a set of attributes in an AssemblyInfo file. Fails if any attribute is not found. + ## Parameters + - `assemblyInfoFile` - The file to update. Language C#, F#, VB or C++ is determined from the extension. + - `attributes` - The Attributes that should be updated matched on Name (Namespace is not used). + + + + + Read the value of a single attribute from an AssemblyInfo file. Note that string values are returned with surrounding "". + ## Parameters + - `attrName` - Name of the attribute without "Attribute" at the end. + - `assemblyInfoFile` - The file to read from. Language C#, F#, VB or C++ is determined from the extension. + + + + + Read a single attribute from an AssemblyInfo file. + ## Parameters + - `attrName` - Name of the attribute without "Attribute" at the end. + - `assemblyInfoFile` - The file to read from. Language C#, F#, VB or C++ is determined from the extension. + + + + + Read attributes from an AssemblyInfo file and return as a sequence of Attribute. + ## Parameters + - `assemblyInfoFile` - The file to read attributes from. Language C#, F#, VB or C++ is determined from the extension. + + + + + Creates a C++/CLI AssemblyInfo file with the given attributes. + + + + + Creates a VB AssemblyInfo file with the given attributes. + The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly. + + + + + Creates a F# AssemblyInfo file with the given attributes. + The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly. + + + + + Creates a C# AssemblyInfo file with the given attributes. + The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly. + + + + + Creates a C++/CLI AssemblyInfo file with the given attributes and configuration. + Does not generate an AssemblyVersionInformation class. + + + + + Creates a VB AssemblyInfo file with the given attributes and configuration. + The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly. + + + + + Creates a F# AssemblyInfo file with the given attributes and configuration. + The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly. + + + + + Creates a C# AssemblyInfo file with the given attributes and configuration. + The generated AssemblyInfo file contains an AssemblyVersionInformation class which can be used to retrieve the current version no. from inside of an assembly. + + + + + Contains tasks to generate AssemblyInfo files for C# and F#. + There is also a tutorial about the [AssemblyInfo tasks](../assemblyinfo.html) available. + + + + + Update all AssemblyInfos that were passed with given FileInclude + ## Parameters + + - 'dir' - The directory (subdirectories will be included), which inhabits the AssemblyInfo files. + - 'replacementParameters' - The replacement parameters for the AssemblyInfo files. + + ## Sample + + let assemblyInfos = !!(@".\src\**\AssemblyInfo.cs") + --(@"**\*Scripts*\**") + + ReplaceAssemblyInfoVersionsBulk assemblyInfos (fun f -> + { f with + AssemblyVersion = asmVersion + AssemblyInformationalVersion = asmInfoVersion + }) + + + + + Update all AssemblyInfo.[fs|cs|vb] files in the specified directory and its subdirectories + ## Parameters + + - 'dir' - The directory (subdirectories will be included), which inhabits the AssemblyInfo files. + - 'replacementParameters' - The replacement parameters for the AssemblyInfo files. + + ## Sample + + BulkReplaceAssemblyInfoVersions "test/" (fun f -> + {f with + AssemblyVersion = "1.1.1.1" + AssemblyInformationalVersion = "1.1.1.1"}) + + + + + AssemblyInfoReplacement default params + + + + + Generates an AssemblyInfo file for projects + **Obsolete - Please use the new AssemblyInfoFile tasks** + + + + + generates the assembly info file + + + + + AssemblyInfo default params + + + + + Generates an AssemblyInfo file + + + + + Parameter type for the FxCop tool + + + + + The FxCop error reporting level + + + + + Run FxCop on a group of assemblies. + + + + + FxCop Default parameters + + + + + This checks the result file with some XML queries for errors + [omit] + + + + + Contains a task which can be used to run [FxCop](http://msdn.microsoft.com/en-us/library/bb429476(v=vs.80).aspx) on .NET assemblies. There is also a [tutorial](../fxcop.html) for this task available. + + + + + Runs fsformatting.exe with the given command in the given repository directory. + + + + + Specifies the fsformatting executable + + + + + Contains tasks which allow to run FSharp.Formatting for generating documentation. + + + + + The NCover parameter type. + + + + + Runs NCover on a group of assemblies. + ## Parameters + + - `setParams` - Function used to overwrite the NCover default parameters. + - `assemblies` - The test assemblies, which should be inspected. + - `excludeAssemblies` - These assemblies are excluded. + + + + + NCover default parameters. + + + + + Contains a task which can be used to run [NCover](http://www.ncover.com/) on .NET assemblies. + + + + + Runs [NDepend](http://www.ndepend.com/) on a .NET project file. + ## Parameters + + - `setParams` - Function used to manipulate the default NDependDefaults value. + + ## Sample + + NDepend (fun p -> { p with + ProjectFile = currentDirectory @@ "NDependProjectFile.ndproj" + CoverageFiles = [artifactsDir @@ "DotCover.xml" ] + }) + + + + + Contains a task which allows to run [NDepend](http://www.ndepend.com/) on .NET project files. + + + + + TeamCity Logger for MSBuild + + + + + TeamCity Logger for MSBuild + + + + + Abstract function which registers an event listener. + + + + + Abstract MSBuild Logger class. + + + + + The ErrorLogFile + + + + + [omit] + + + + + Contains Logger implementations for MsBuild. + + + + + corresponds to the msbuild option '/dl' + + + + + corresponds to the msbuild option '/bl' + + + + + corresponds to the msbuild option '/fl' + + + + + corresponds to the msbuild option '/m': + - 'None' will omit the option. + - 'Some None' will emit '/m'. + - 'Some 2' will emit '/m:2'. + + + + + Set the MSBuild executable to use. Defaults to the latest installed MSBuild. + + + + + A type for MSBuild task parameters + + + + + A type for MSBuild configuration + + + + + MSBuild log option + + + + + MSBuild verbosity option + + + + + A type to represent MSBuild project files. + + + + + Builds the given web project files with debug configuration and copies them to the given websiteDir. + ## Parameters + - `outputPath` - The output path. + - `projectFiles` - The project file paths. + + + + + Builds the given web project files in specified configuration and copies them to the given outputPath. + ## Parameters + - `outputPath` - The output path. + - `configuration` - MSBuild configuration. + - `projectFiles` - The project file paths. + + + + + Builds the given web project file with debug configuration and copies it to the given outputPath. + ## Parameters + - `outputPath` - The output path. + - `projectFile` - The project file path. + + + + + Builds the given web project file in the specified configuration and copies it to the given outputPath. + ## Parameters + - `outputPath` - The output path. + - `configuration` - MSBuild configuration. + - `projectFile` - The project file path. + + + + + Builds the given project files or solution files in release mode and collects the output files. + ## Parameters + - `outputPath` - If it is null or empty then the project settings are used. + - `properties` - A list with tuples of property name and property values. + - `targets` - A string with the target names which should be run by MSBuild. + - `projects` - A list of project or solution files. + + + + + Builds the given project files or solution files in release mode to the default outputs. + ## Parameters + - `targets` - A string with the target names which should be run by MSBuild. + - `projects` - A list of project or solution files. + + + + + Builds the given project files or solution files and collects the output files. + ## Parameters + - `outputPath` - If it is null or empty then the project settings are used. + - `targets` - A string with the target names which should be run by MSBuild. + - `projects` - A list of project or solution files. + + + + + Builds the given project files or solution files and collects the output files. + ## Parameters + - `outputPath` - If it is null or empty then the project settings are used. + - `targets` - A string with the target names which should be run by MSBuild. + - `projects` - A list of project or solution files. + + + + + Builds the given project files or solution files and collects the output files. + ## Parameters + - `outputPath` - If it is null or empty then the project settings are used. + - `targets` - A string with the target names which should be run by MSBuild. + - `properties` - A list with tuples of property name and property values. + - `projects` - A list of project or solution files. + + + + + Builds the given project files and collects the output files. + ## Parameters + - `outputPath` - If it is null or empty then the project settings are used. + - `targets` - A string with the target names which should be run by MSBuild. + - `properties` - A list with tuples of property name and property values. + - `projects` - A list of project or solution files. + + + + + Runs a MSBuild project + ## Parameters + - `setParams` - A function that overwrites the default MsBuildParams + - `project` - A string with the path to the project file to build. + + ## Sample + + let buildMode = getBuildParamOrDefault "buildMode" "Release" + let setParams defaults = + { defaults with + Verbosity = Some(Quiet) + Targets = ["Build"] + Properties = + [ + "Optimize", "True" + "DebugSymbols", "True" + "Configuration", buildMode + ] + } + build setParams "./MySolution.sln" + |> DoNothing + + + + + Defines the loggers to use for MSBuild task + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + Defines a default for MSBuild task parameters + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + Tries to detect the right version of MSBuild. + - On all OS's, we check a `MSBuild` environment variable which is either + * a direct path to a file to use, or + * a directory that contains a file called + * `msbuild` on non-Windows systems with mono >= 5.0.0.0, or + * `xbuild` on non-Windows systems with mono < 5.0.0.0, + * `MSBuild.exe` on Windows systems, or + * a tool that exists on the current PATH + - In addition, on non-Windows systems we check the current PATH for the following binaries, in this order: + * Mono >= 5.0.0.0: `msbuild`, `xbuild` + * Mono < 5.0.0.0: `xbuild`, `msbuild` + * This is due to several known issues in the Mono < 5.0 implementation of MSBuild. + - In addition, on Windows systems we + * try to read the MSBuild tool location from the AppSettings file using a parameter named `MSBuild`, and finally + * if a `VisualStudioVersion` environment variable is specified, we try to use the specific MSBuild version, matching that Visual Studio version. + + + + + Versions of Mono prior to this one have faulty implementations of MSBuild + NOTE: in System.Version 5.0 >= 5.0.0.0 is false while 5.0.0.0 >= 5.0 is true... + + + + + An exception type to signal build errors. + + + + + Contains tasks which allow to use MSBuild (or xBuild on Linux/Unix) to build .NET project files or solution files. + + + + + The Npm parameter type + + + + + Run `npm <string>`. Can be used for running not implemented commands. + + + + + Run `npm test --silent`. Suppresses npm error output and will raise an FailedTestsException exception after the script execution instead of failing, useful for CI. See [npm:8821](https://github.com/npm/npm/issues/8821). + + + + + Run `npm run --silent <string>`. Suppresses npm error output and will raise an FailedTestsException exception after the script execution instead of failing, useful for CI. See [npm:8821](https://github.com/npm/npm/issues/8821). + + + + + Run `npm run --silent <string>`. Suppresses npm error output. See [npm:8821](https://github.com/npm/npm/issues/8821). + + + + + Run `npm run <string>` + + + + + Run `npm install` + + + + + The list of supported Npm commands. + + + + + Arguments for the Npm install command + + + + + Runs npm with the given modification function. Make sure to have npm installed, + you can install npm with nuget or a regular install. To change which `Npm` executable + to use you can set the `NpmFilePath` parameter with the `setParams` function. + + ## Parameters + + - `setParams` - Function used to overwrite the Npm default parameters. + + ## Sample + + Target "Web" (fun _ -> + Npm (fun p -> + { p with + Command = Install Standard + WorkingDirectory = "./src/FAKESimple.Web/" + }) + + Npm (fun p -> + { p with + Command = (Run "build") + WorkingDirectory = "./src/FAKESimple.Web/" + }) + ) + + + + + Runs the given process and returns the process result. + + + + + Npm default parameters + + + + + Default paths to Npm + + + + + Contains function to run npm tasks + + + + + A description of a file to be added to an archive. + + + + + Constructs a file specification which will archive the file with a path relative to the `baseDir`. + + + + + Constructs a file specification which will archive the file at the root. + + + + + Creates a tar.gz archive containing all the files in a directory. + ## Parameters + - `baseDir` - The base directory to be archived. This directory will be the root of the resulting archive. + - `archiveFile` - The output archive file. If existing, will be overwritten. + + + + + Creates a tar archive containing all the files in a directory. + ## Parameters + - `flatten` - If set to true then all subfolders are merged into the root folder of the archive. + - `baseDir` - The base directory to be archived. This directory will be the root of the resulting archive. + - `archiveFile` - The output archive file. If existing, will be overwritten. + + + + + Creates a tar archive with the given files with default parameters. + ## Parameters + - `baseDir` - The relative directory of the files to be archived. Use this parameter to influence directory structure within the archive. + - `archiveFile` - The output archive file. If existing, will be overwritten. + - `files` - A sequence of files to store. + + + + + Creates a tar archive with the given archive file specifications. + ## Parameters + - `archiveFile` - The output archive file. If existing, will be overwritten. + - `fileSpecs` - A sequence of archive file specifications. + + + + + Creates a tar archive with the given files. + ## Parameters + - `flatten` - If set to true then all subfolders are merged into the root folder of the archive. + - `baseDir` - The relative directory of the files to be archived. Use this parameter to influence directory structure within the archive. + - `archiveFile` - The output archive file. If existing, will be overwritten. + - `files` - A sequence of files to store. + + + + + Extracts a tar archive to a given directory. + ## Parameters + - `targetDir` - The directory into which the archived files will be extracted. + - `archiveFile` - The archive to be extracted. + + + + + Constructs a function that will create a tar archive from a set of files. + + + + + Creates a `TarOutputStream` wrapping a file using the given parameters. + ## Parameters + - `file` - The `FileInfo` describing the location to which the archive should be written. Will be overwritten if it exists. + + + + + Wraps an input stream with a tar container extractor. + + + + + Wraps an output stream with a tar container store. + + + + + Adds a file, specified by an `ArchiveFileSpec`, to a `TarOutputStream`. + + + + + Creates a tar.bz2 archive containing all the files in a directory. + ## Parameters + - `baseDir` - The base directory to be compressed. This directory will be the root of the resulting archive. + - `archiveFile` - The output archive file. If existing, will be overwritten. + + + + + Creates a tar.bz2 archive containing all the files in a directory. + ## Parameters + - `flatten` - If set to true then all subfolders are merged into the root folder of the archive. + - `baseDir` - The base directory to be compressed. This directory will be the root of the resulting archive. + - `archiveFile` - The output archive file. If existing, will be overwritten. + + + + + Creates a tar.bz2 archive with the given files with default parameters. + ## Parameters + - `baseDir` - The relative directory of the files to be compressed. Use this parameter to influence directory structure within the archive. + - `archiveFile` - The output archive file. If existing, will be overwritten. + - `files` - A sequence of files to compress. + + + + + Creates a tar.bz2 archive with the given archive file specifications. + ## Parameters + - `archiveFile` - The output archive file. If existing, will be overwritten. + - `fileSpecs` - A sequence of archive file specifications. + + + + + Creates a tar.bz2 archive with the given files. + ## Parameters + - `flatten` - If set to true then all subfolders are merged into the root folder of the archive. + - `baseDir` - The relative directory of the files to be compressed. Use this parameter to influence directory structure within the archive. + - `archiveFile` - The output archive file. If existing, will be overwritten. + - `files` - A sequence of files to compress. + + + + + Extracts a tar.bz2 archive to a given directory. + ## Parameters + - `extractDir` - The directory into which the archived files will be extracted. + - `archiveFile` - The archive to be extracted. + + + + + Constructs a function that will create a tar.bz2 archive from a set of files. + + + + + Creates a `TarOutputStream` wrapping a file. + ## Parameters + - `file` - The `FileInfo` describing the location to which the archive should be written. Will be overwritten if it exists. + + + + + Wraps an input stream with a tar.gz decompressor. + + + + + Wraps an output stream with a tar.bz2 compressor. + + + + + Operations and tasks for working with tar archives compressed with BZip2. + + + + + Creates a tar.gz archive containing all the files in a directory. + ## Parameters + - `baseDir` - The base directory to be compressed. This directory will be the root of the resulting archive. + - `archiveFile` - The output archive file. If existing, will be overwritten. + + + + + Creates a tar.gz archive containing all the files in a directory. + ## Parameters + - `setParams` - A function which modifies the default compression parameters. + - `flatten` - If set to true then all subfolders are merged into the root folder of the archive. + - `baseDir` - The base directory to be compressed. This directory will be the root of the resulting archive. + - `archiveFile` - The output archive file. If existing, will be overwritten. + + + + + Creates a tar.gz archive with the given files with default parameters. + ## Parameters + - `baseDir` - The relative directory of the files to be compressed. Use this parameter to influence directory structure within the archive. + - `archiveFile` - The output archive file. If existing, will be overwritten. + - `files` - A sequence of files to compress. + + + + + Creates a tar.gz archive with the given archive file specifications. + ## Parameters + - `setParams` - A function which modifies the default compression parameters. + - `archiveFile` - The output archive file. If existing, will be overwritten. + - `fileSpecs` - A sequence of archive file specifications. + + + + + Creates a tar.gz archive with the given files. + ## Parameters + - `setParams` - A function which modifies the default compression parameters. + - `flatten` - If set to true then all subfolders are merged into the root folder of the archive. + - `baseDir` - The relative directory of the files to be compressed. Use this parameter to influence directory structure within the archive. + - `archiveFile` - The output archive file. If existing, will be overwritten. + - `files` - A sequence of files to compress. + + + + + Extracts a tar.gz archive to a given directory. + ## Parameters + - `extractDir` - The directory into which the archived files will be extracted. + - `archiveFile` - The archive to be extracted. + + + + + Constructs a function that will create a tar.gz archive from a set of files. + + + + + Creates a `TarOutputStream` wrapping a file using the given parameters. + ## Parameters + - `gzipParams` - The gzip compression parameters. + - `file` - The `FileInfo` describing the location to which the archive should be written. Will be overwritten if it exists. + + + + + Wraps an input stream with a tar.gz decompressor. + + + + + Wraps an output stream with a tar.gz compressor. + + + + + Operations and tasks for working with tar archives compressed with GZip. + + + + + Operations and tasks for working with tar archives. + + + + + Compresses a file using bzip2. + ## Parameters + - `outFile` - The compressed output file. If existing, will be overwritten. + - `file` - The file to be compressed. + + + + + Extracts a file compressed with bzip2. + ## Parameters + - `outFile` - The extracted output file. If existing, will be overwritten. + - `file` - The compressed file. + + + + + Creates a `BZip2OutputStream` wrapping a file. + ## Parameters + - `file` - The `FileInfo` describing the location to which the compressed file should be written. Will be overwritten if it exists. + + + + + Wraps an input stream with a bzip2 decompressor. + + + + + Wraps an output stream with a bzip2 compressor. + + + + + Operations and tasks for working with gzip compressed files. + + + + + The gzip archive compression parameters. + + + + + Compresses a file using gzip. + ## Parameters + - `outFile` - The compressed output file. If existing, will be overwritten. + - `file` - The file to be compressed. + + + + + Compresses a file using gzip. + ## Parameters + - `setParams` - A function which modifies the default compression parameters. + - `outFile` - The compressed output file. If existing, will be overwritten. + - `file` - The file to be compressed. + + + + + Extracts a file compressed with gzip. + ## Parameters + - `outFile` - The extracted output file. If existing, will be overwritten. + - `file` - The compressed file. + + + + + Creates a `GZipOutputStream` wrapping a file using the given parameters. + ## Parameters + - `gzipParams` - The gzip compression parameters. + - `file` - The `FileInfo` describing the location to which the compressed file should be written. Will be overwritten if it exists. + + + + + Wraps an input stream with a zip decompressor. + + + + + Wraps an output stream with a gzip compressor. + + + + + The default gzip archive compression parameters + ## Defaults + - `Level` - `CompressionLevel.Default` + + + + + Operations and tasks for working with gzip compressed files. + + + + + The zip archive compression parameters. + + + + + Creates a zip archive containing all the files in a directory. + ## Parameters + - `baseDir` - The base directory to be compressed. This directory will be the root of the resulting archive. + - `archiveFile` - The output archive file. If existing, will be overwritten. + + + + + Creates a zip archive containing all the files in a directory. + ## Parameters + - `setParams` - A function which modifies the default compression parameters. + - `flatten` - If set to true then all subfolders are merged into the root folder of the archive. + - `baseDir` - The base directory to be compressed. This directory will be the root of the resulting archive. + - `archiveFile` - The output archive file. If existing, will be overwritten. + + + + + Creates a zip archive with the given files with default parameters. + ## Parameters + - `baseDir` - The relative directory of the files to be compressed. Use this parameter to influence directory structure within the archive. + - `archiveFile` - The output archive file. If existing, will be overwritten. + - `files` - A sequence of files to compress. + + + + + Creates a zip archive with the given archive file specifications. + ## Parameters + - `setParams` - A function which modifies the default compression parameters. + - `archiveFile` - The output archive file. If existing, will be overwritten. + - `fileSpecs` - A sequence of archive file specifications. + + + + + Creates a zip archive with the given files. + ## Parameters + - `setParams` - A function which modifies the default compression parameters. + - `flatten` - If set to true then all subfolders are merged into the root folder of the archive. + - `baseDir` - The relative directory of the files to be compressed. Use this parameter to influence directory structure within the archive. + - `archiveFile` - The output archive file. If existing, will be overwritten. + - `files` - A sequence of files to compress. + + + + + Extracts a zip archive to a given directory. + ## Parameters + - `extractDir` - The directory into which the archived files will be extracted. + - `archiveFile` - The archive to be extracted. + + + + + Constructs a function that will create a zip archive from a set of files. + + + + + Creates a `ZipOutputStream` wrapping a file using the given parameters. + ## Parameters + - `zipParams` - The zip compression parameters. + - `file` - The `FileInfo` describing the location to which the archive should be written. Will be overwritten if it exists. + + + + + Wraps an input stream with a zip decompressor. + + + + + Wraps an output stream with a zip compressor. + + + + + Adds a file, specified by an `ArchiveFileSpec`, to a `ZipOutputStream`. + + + + + The default zip archive compression parameters + ## Defaults + - `Level` - `CompressionLevel.Default` + - `Comment` - `None` + + + + + Operations and tasks for working with zip archives. + + + + + Defines the compression level type. + + + + + Retrieves the numeric compression level. + + + + + Constructs a `CompressionLevel`. Level is clipped to a value between 0 and 9. + + + + + The default compression level. + + + + + Provides validation of comression levels used for the zip and gzip compression algorithms. + + + + + Provides utility tasks for storing and compressing files in archives. + + + + + Creates a zip file with the given files. + ## Parameters + - `fileName` - The file name of the resulting zip file. + - `files` - A sequence of target folders and files to include relative to their base directory. + + ## Sample + + The following sample creates a zip file containing the files from the two target folders and FileIncludes. + + - The files from the first FileInclude will be placed in the root of the zip file. + - The files from the second FileInclude will be placed under the directory `app_data\jobs\continuous\MyWebJob` in the zip file. + + + Target "Zip" (fun _ -> + [ "", !! "MyWebApp/*.html" + ++ "MyWebApp/bin/**/*.dll" + ++ "MyWebApp/bin/**/*.pdb" + ++ "MyWebApp/fonts/**" + ++ "MyWebApp/img/**" + ++ "MyWebApp/js/**" + -- "MyWebApp/js/_references.js" + ++ "MyWebApp/web.config" + @"app_data\jobs\continuous\MyWebJob", !! "MyWebJob/bin/Release/*.*" + ] + |> ZipOfIncludes (sprintf @"bin\MyWebApp.%s.zip" buildVersion) + ) + + + + + + Creates a zip file with the given files. + ## Parameters + - `fileName` - The file name of the resulting zip file. + - `comment` - A comment for the resulting zip file. + - `level` - The compression level. + - `files` - A sequence of target folders and files to include relative to their base directory. + + + + + Unzips a single file from the archive with the given file name. + ## Parameters + - `predicate` - The predictae for the searched file in the archive. + - `zipFileName` - The file name of the zip file. + + + + + Unzips a single file from the archive with the given file name. + ## Parameters + - `fileToUnzip` - The file inside the archive. + - `zipFileName` - The file name of the zip file. + + + + + Unzips a file with the given file name. + ## Parameters + - `target` - The target directory. + - `fileName` - The file name of the zip file. + + + + + Creates a zip file with the given file. + ## Parameters + - `fileName` - The file name of the resulting zip file. + - `targetFileName` - The file to zip. + + + + + Creates a zip file with the given files. + ## Parameters + - `workingDir` - The relative dir of the zip files. Use this parameter to influence directory structure within zip file. + - `fileName` - The file name of the resulting zip file. + - `files` - A sequence with files to zip. + + + + + Creates a zip file with the given files + ## Parameters + - `workingDir` - The relative dir of the zip files. Use this parameter to influence directory structure within zip file. + - `fileName` - The fileName of the resulting zip file. + - `comment` - A comment for the resulting zip file. + - `level` - The compression level. + - `flatten` - If set to true then all subfolders are merged into the root folder. + - `files` - A sequence with files to zip. + + + + + The default zip level + + + + + This module contains helper function to create and extract zip archives. + + + + + The directory where the Strong naming process will be started. + + + + + The timeout for the Strong naming process. + + + + + (Required) Path to the sn.exe + + + + + Strong naming parameters + + + + + Registers the given assembly for verification skipping. + + + + + Runs sn.exe with the given command. + + + + + Strong naming default parameters + + + + + This module contains helper function for Microsoft's sn.exe + + + + + The directory where the process will be started. + + + + + The timeout for the process. + + + + + (Required) Path to the gacutil + + + + + GAC parameters + + + + + Runs gacutil with the given command. + + + + + GACutil default parameters + + + + + Path to newest `gacutil.exe` + + + + + This module contains helper function for the GAC + + + + + The directory where the process will be started. + + + + + The timeout for the process. + + + + + (Required) Path to the NGenutil + + + + + NGen parameters + + + + + Runs ngen.exe install on given assemblies. + + + + + Runs ngen.exe with the given command. + + + + + NGen default parameters + + + + + This module contains helper function for the ngen.exe + + + + + The output path of the generated docs. The default is "./output/". + + + + + Allows to specify a timeout for docu. The default is 5 minutes. + + + + + The HTML templates for the generated docs. + + + + + The tool path - FAKE tries to find docu.exe automatically in any sub folder. + + + + + The parameter type for docu. + + + + + Generates a HTML documentation from XML docs via the docu.exe. + ## Parameters + + - `setParams` - Function used to manipulate the default docu parameters. + - `assemblies` - Sequence of one or more assemblies containing the XML docs. + + + + + The Docu default params + + + + + Contains helper functions to run the XML documentation tool "docu". + + + + + True -> XML documentation files are merged to produce an XML documentation file for the target assembly. + + + + + True -> types with the same name are all merged into a single type in the target assembly. + + + + + v1 or v1.1 or v2 or v4 or version,platform + + + + + Directories to be used to search for input assemblies + + + + + True (default) -> creates a .pdb file for the output assembly and merges into it any .pdb files found for input assemblies. + + + + + True -> transitive closure of the input assemblies is computed and added to the list of input assemblies. + + + + + Path to an assembly that will be used to get all of the assembly-level attributes + + + + + Wild cards in file names are expanded and all matching files will be used as input. + + + + + Assembly-level attributes names that have the same type are copied over into the target directory + + + + + Duplicate types policy + + + + + Assemblies to merge with the primary assembly + + + + + Version to use for the merged assembly + + + + + Path to ILMerge.exe + + + + + Parameter type for ILMerge + + + + + Option type to configure ILMerge's target output. + + + + + Option type to configure ILMerge's processing of internal types. + + + + + List of types to allow to be duplicated + + + + + All public types are allowed to be duplicated and renamed + + + + + No duplicates of public types allowed + + + + + Option type to configure ILMerge's processing of duplicate types. + + + + + Uses ILMerge to merge .NET assemblies. + ## Parameters + + - `setParams` - Function used to create an ILMergeParams value with your required settings. Called with an ILMergeParams value configured with the defaults. + - `outputFile` - Output file path for the merged assembly. + - `primaryAssembly` - The assembly you want ILMerge to consider as the primary. + + + + + Builds the arguments for the ILMerge task + [omit] + + + + + ILMerge default parameters. Tries to automatically locate ilmerge.exe in a subfolder. + + + + + Contains task a task which allows to merge .NET assemblies with [ILMerge](http://research.microsoft.com/en-us/people/mbarnett/ilmerge.aspx). + + + + + Substitute File/@Source="SourceDir" with a preprocessor or a wix variable (Parameter: -var) + + + + + Component group name, cannot contain spaces. (Parameter: -cg) + + + + + Directory reference to root directories, cannot contains spaces. (Parameter: -dr) + + + + + Suppress unique identifiers for files, components, & directories.(Parameter: -suid) + + + + + Suppress registry harvesting. (Parameter: -sreg) + + + + + Suppress harvesting the root directory as an element. (Parameter: -srd) + + + + + Suppress generation of fragments for directories and components. (Parameter: -sfrag) + + + + + Suppress COM elements. (Parameter: -scom) + + + + + Generate guids now. All components are given a guid when heat is run. (Parameter: -gg) + + + + + Auto generate component guids at compile time, e.g. set Guid="*". (Parameter: -ag) + + + + + Timeout for the call to Heat + + + + + Directory that contains the Heat tool + + + + + Specify architecture of package. For 64Bit Setups set ProgramFilesFolder to ProgramFiles64, package platform to X64, all components to Win64 = yes and all files' processorArchitecture to X64. + + + + + You can add custom replacements for the wix xml here. + + + + + You can nest InstallExecuteSequence actions in here + + + + + You can nest custom actions in here + + + + + You can nest feature elements in here + + + + + Build Number of product + + + + + Nest Components in here + + + + + You can nest DirectoryRefs in here + + + + + Nest directories in here + + + + + Nest WiXVariables in here + + + + + Nest UIRefs in here + + + + + Nest major upgrade elements in here + + + + + You can nest upgrade elements in here + + + + + The upgrade code GUID for the product. + + + + + The manufacturer of the product. + + + + + The product's version string. + + + + + The decimal language ID (LCID) for the product. + + + + + Product description + + + + + The program files folder + + + + + The descriptive name of the product. + + + + + The product code GUID for the product. + + + + + Parameters for WiX Script properties, use ToString for creating the string xml nodes + + + + + The value of the variable. The value cannot be an empty string because that would make it possible to accidentally set a column to null. + + + + + Set this value to 'yes' in order to make the variable's value overridable either by another WixVariable entry or via the command-line option -d<name>=<value> for light.exe. + If the same variable is declared overridable in multiple places it will cause an error (since WiX won't know which value is correct). The default value is 'no'. + + + + + The name of the variable. + + + + + Parameters for WiX Variable, use ToString for creating the string xml nodes + + + + + The message displayed if users try to install a product with a lower version number when a product with a higher version is installed. Used only when AllowDowngrades is no (the default). + + + + + When set to no (the default), products with lower version numbers are blocked from installing when a product with a higher version is installed; the DowngradeErrorMessage + attribute must also be specified. When set to yes, any version can be installed over any other version. + + + + + Determines the scheduling of the RemoveExistingProducts standard action, which is when the installed product is removed. The default is "afterInstallValidate" which removes the + installed product entirely before installing the upgrade product. It's slowest but gives the most flexibility in changing components and features in the upgrade product. + + + + + Parameters for WiX Major Upgrade + + + + + Schedules RemoveExistingProducts after the InstallFinalize standard action. This is similar to the afterInstallExecute and afterInstallExecuteAgain schedulings but takes place outside + the installation transaction so if installation of the upgrade product fails, Windows Installer does not roll back the removal of the installed product, + so the machine will have both versions installed. + + + + + Schedules RemoveExistingProducts between the InstallExecuteAgain and InstallFinalize standard actions. + This is identical to the afterInstallExecute scheduling but after the InstallExecuteAgain standard action instead of InstallExecute. + + + + + Schedules RemoveExistingProducts between the InstallExecute and InstallFinalize standard actions. This scheduling installs the upgrade product "on top of" the installed product then lets + RemoveExistingProducts uninstall any components that don't also exist in the upgrade product. Note that this scheduling requires strict adherence to the component rules because it relies + on component reference counts to be accurate during installation of the upgrade product and removal of the installed product. For more information, see Bob Arnson's blog post + "Paying for Upgrades" for details. If installation of the upgrade product fails, Windows Installer also rolls back the removal of the installed product -- in other words, reinstalls it. + + + + + Schedules RemoveExistingProducts after the InstallInitialize standard action. This is similar to the afterInstallValidate scheduling, but if the installation of the upgrade product fails, + Windows Installer also rolls back the removal of the installed product -- in other words, reinstalls it. + + + + + (Default) Schedules RemoveExistingProducts after the InstallValidate standard action. This scheduling removes the installed product entirely before installing the upgrade product. + It's slowest but gives the most flexibility in changing components and features in the upgrade product. Note that if the installation of the upgrade product fails, + the machine will have neither version installed. + + + + + Used for determing when to run RemoveExistingProducts on major upgrade + + + + + Set to "yes" to make the range of versions detected include the value specified in Maximum. + + + + + Set to "no" to make the range of versions detected exclude the value specified in Minimum. This attribute is "yes" by default. + + + + + When the FindRelatedProducts action detects a related product installed on the system, it appends the product code to the property specified in this field. + Windows Installer documentation for the Upgrade table states that the property specified in this field must be a public property and must be added to the + SecureCustomProperties property. WiX automatically appends the property specified in this field to the SecureCustomProperties property when creating an MSI. + Each UpgradeVersion must have a unique Property value. After the FindRelatedProducts action is run, the value of this property is a list of product codes, + separated by semicolons (;), detected on the system. + + + + + Specifies the upper boundary of the range of product versions detected by FindRelatedProducts. + + + + + Specifies the lower bound on the range of product versions to be detected by FindRelatedProducts. + + + + + Set to "yes" to detect products and applications but do not uninstall. + + + + + Parameters for WiX Upgrade Version + + + + + You can nest WiXUpgradeVersion sequences in here + + + + + This value specifies the upgrade code for the products that are to be detected by the FindRelatedProducts action. + + + + + Parameters for WiX Upgrade + + + + + Name of referenced UI + + + + + Parameters for WiX UI Reference, use ToString for creating the string xml nodes + + + + + Conditions that have to be fulfilled for running execution + + + + + Name of the standard or custom action that the verb points to + + + + + Specify if action should be executed before or after target action + + + + + The action to which the Custom element applies. + + + + + Parameters for WiX Custom Action executions (In InstallExecuteSequence), use ToString for creating the string xml nodes + + + + + Specifies that action should be executed before some standard or custom action + + + + + Specifies that action should be executed after some standard or custom action + + + + + Used for specifying the point of time for action execution in WiXCustomActionExecution + + + + + Set this attribute to set the return behavior of the custom action. + + + + + This attribute specifies the command line parameters to supply to an externally run executable. + This attribute is typically used with the BinaryKey attribute for a type 2 custom action, the FileKey attribute for a type 18 + custom action, the Property attribute for a type 50 custom action, or the Directory attribute for a type 34 custom action that + specify the executable to run. + + + + + This attribute specifies whether the Windows Installer, which executes as LocalSystem, should impersonate the user context of + the installing user when executing this custom action. Typically the value should be 'yes', except when the custom action needs + elevated privileges to apply changes to the machine. + + + + + This attribute indicates the scheduling of the custom action. + + + + + This attribute specifies a reference to a File element with matching Id attribute that will execute the custom action code + in the file after the file is installed. This attribute is typically used with the ExeCommand attribute to specify + a type 18 custom action that runs an installed executable, with the DllEntry attribute to specify an installed custom action + DLL to use for a type 17 custom action, or with the VBScriptCall or JScriptCall attributes to specify a type 21 or 22 custom action. + + + + + The identifier of the custom action. + + + + + Parameters for WiX custom action, use ToString for creating the string xml nodes + + + + + Indicates that the custom action will run synchronously and the return code will not be checked. + + + + + Indicates that the custom action will run synchronously and the return code will be checked for success. This is the default. + + + + + Indicates that the custom action will run asynchronously but the installer will wait for the return code at sequence end. + + + + + Indicates that the custom action will run asyncronously and execution may continue after the installer terminates. + + + + + Used in WiXCustomAction for determing the return type + + + + + Indicates that a custom action should be run a second time if it was previously run in an earlier sequence. + + + + + Indicates that a custom action will run in the rollback sequence when a failure occurs during installation, usually to undo changes made by a deferred custom action. + + + + + Indicates that the custom action will only run in the first sequence that runs it in the same process. + + + + + Indicates that the custom action will run during normal processing time with user privileges. This is the default. + + + + + Indicates that the custom action will only run in the first sequence that runs it. + + + + + Indicates that the custom action runs in-script (possibly with elevated privileges). + + + + + Indicates that the custom action will run after successful completion of the installation script (at the end of the installation). + + + + + Used in WiXCustomAction for determing when to run the custom action + + + + + Specify architecture of package. For 64Bit Setups set ProgramFilesFolder to ProgramFiles64, package platform to X64, all components to Win64 = yes and all files' processorArchitecture to X64. + + + + + You can nest InstallExecuteSequence actions in here + + + + + You can nest custom actions in here + + + + + You can nest feature elements in here + + + + + Build Number of product + + + + + Nest directories in here + + + + + Nest WiXVariables in here + + + + + Nest UIRefs in here + + + + + Nest major upgrade elements in here + + + + + You can nest upgrade elements in here + + + + + The upgrade code GUID for the product. + + + + + The manufacturer of the product. + + + + + The product's version string. + + + + + The decimal language ID (LCID) for the product. + + + + + Product description + + + + + The program files folder + + + + + The descriptive name of the product. + + + + + The product code GUID for the product. + + + + + Parameters for WiX Script properties, use ToString for creating the string xml nodes + + + + + Type for defining, which program directory should be used for installation. ProgramFiles32 refers to 'Program Files (x86)', ProgramFiles64 refers to 'Program Files' + + + + + Components included in this feature + + + + + Nest sub features + + + + +Determines the initial display of this feature in the feature tree. This attribute's value should be one of the following: +collapse + Initially shows the feature collapsed. This is the default value. +expand + Initially shows the feature expanded. +hidden + Prevents the feature from displaying in the user interface. +<an explicit integer value> + For advanced users only, it is possible to directly set the integer value of the display value that will appear in the Feature row. + + + + + Longer string of text describing the feature. This localizable string is displayed by the Text Control of the Selection Dialog. + + + + + Sets the install level of this feature. A value of 0 will disable the feature. + Processing the Condition Table can modify the level value (this is set via the Condition child element). + The default value is "1". + + + + + Short string of text identifying the feature. + This string is listed as an item by the SelectionTree control of the Selection Dialog. + + + + + Unique identifier of the feature. + + + + + Parameters for creating WiX Feature, use ToString for creating the string xml nodes + + + + + Nest sub features or components in here + + + + +Determines the initial display of this feature in the feature tree. This attribute's value should be one of the following: +collapse + Initially shows the feature collapsed. This is the default value. +expand + Initially shows the feature expanded. +hidden + Prevents the feature from displaying in the user interface. +<an explicit integer value> + For advanced users only, it is possible to directly set the integer value of the display value that will appear in the Feature row. + + + + + Longer string of text describing the feature. This localizable string is displayed by the Text Control of the Selection Dialog. + + + + + Sets the install level of this feature. A value of 0 will disable the feature. + Processing the Condition Table can modify the level value (this is set via the Condition child element). + The default value is "1". + + + + + Short string of text identifying the feature. + This string is listed as an item by the SelectionTree control of the Selection Dialog. + + + + + Unique identifier of the feature. + + + + + Parameters for creating WiX Feature, use ToString for creating the string xml nodes + + + + + Prevents the feature from displaying in the user interface. + + + + + Initially shows the feature expanded. + + + + + Initially shows the feature collapsed. This is the default value. + + + + + Used for determing whether the feature should be visible in the select features installer pane or not + + + + + WiX parameter type + + + + + Reference to a component for including it in a feature + + + + + WiX Directories define a logical directory which can include components and files + + + + + Component which wraps files into logical components and which allows to + + + + + Reference to a component for including it in a feature + + + + + You can nest child registry values here + + + + + You can nest child registry keys here + + + + + Set this attribute to 'yes' to remove the key with all its values and subkeys when the parent component is uninstalled + Note that this value is useful only if your program creates additional values or subkeys under this key and you want an uninstall to remove them + MSI already removes all values and subkeys that it creates, so this option just adds additional overhead to uninstall. The default is "no" + + + + + Set this attribute to 'yes' to create an empty key, if absent, when the parent component is installed + This value is needed only to create an empty key with no subkeys or values. + Windows Installer creates keys as needed to store subkeys and values. The default is "no" + + + + + The localizable key for the registry value + If the parent element is a RegistryKey, this value may be omitted to use the path of the parent, or if its specified it will be appended to the path of the parent + + + + + The predefined root key for the registry value + + + + + Primary key used to identify this particular entry + + + + + Parameters for WiX RegistryKey + + + + + The predefined root key for the registry value. + + + + + Set this attribute to 'yes' to make this registry key the KeyPath of the parent component + + + + + The localizable key for the registry value + If the parent element is a RegistryKey, this value may be omitted to use the path of the parent, or if its specified it will be appended to the path of the parent + + + + + The type of the desired registry key + + + + + The action that will be taken for this registry value + + + + + The localizable registry value. + + + + + The localizable registry value name. If this attribute is not provided the default value for the registry key will be set instead + + + + + The Id of this value + + + + + Parameters for WiX RegistryValue + + + + + The value is interpreted and stored as a multiple strings (REG_MULTI_SZ) + + + + + The value is interpreted and stored as an expandable string (REG_EXPAND_SZ) + + + + + The value is interpreted and stored as a hexadecimal value (REG_BINARY) + + + + + The value is interpreted and stored as an integer (REG_DWORD) + + + + + The value is interpreted and stored as a string (REG_SZ) + + + + + The desired type of a registry key. + + + + + Writes a registry value + + + + + Prepends the specified value(s) to a multiString registry value + + + + + Appends the specified value(s) to a multiString registry value + + + + + The action that will be taken for a registry value + + + + + Writes this registry key inside either the HKEY_USers registry root + + + + + Writes this registry key inside either the HKEY_LOCAL_MACHINE registry root + + + + + Writes this registry key inside either the HKEY_CURRENT_USER registry root + + + + + Writes this registry key inside either the HKEY_CLASSES_ROOT registry root + + + + + Writes this registry key inside either HKEY_LOCAL_MACHINE or HKEY_CURRENT_USER. Wix decides at install time based on wether or not this is an "all users" install + + + + + Represents the registry root under which this key should be written + + + + + Service configuration information for failure actions. + + + + + Services or groups of services that must start before the parent service. + + + + + The overall install should fail if this service fails to install. (Default: Yes) + + + + + [Required] The Windows Installer does not currently support kernelDriver or systemDriver. (Default: OwnProcess) + + + + + [Required] Determines when the service should be started. The Windows Installer does not support boot or system. (Default: Demand) + + + + + The password for the account. Valid only when the account has a password. + + + + + [Required] This column is the string that gives the service name to install. + + + + + The load ordering group that this service should be a part of. + + + + + Whether or not the service interacts with the desktop. + + + + + Unique identifier for this service configuration. This value will default to the Name attribute if not specified. + + + + + [Required] Determines what action should be taken on an error. (Default: Normal) + + + + + Determines whether the existing service description will be ignored. If 'yes', the service description will be null, even if the Description attribute is set. + + + + + This column is the localizable string that user interface programs use to identify the service. + + + + + Sets the description of the service. + + + + + Contains any command line arguments or properties required to run the service. + + + + + Fully qualified names must be used even for local accounts, e.g.: ".\LOCAL_ACCOUNT". Valid only when ServiceType is ownProcess. + + + + + Adds services for parent Component. Use the ServiceControl element to remove services. + + + + + Set to 'yes' to indicate that the value in the Id attribute is the name of a group of services. + + + + + [Required] The value of this attribute should be one of the following: + 1. The name (not the display name) of a previously installed service. + 2. The name of a service group (in which case the Group attribute must be set to 'yes'). + + + + + Service or group of services that must start before the parent service. + + + + + [Required] Action to take on the third failure of the service. + + + + + Required if not under a ServiceInstall element. + + + + + [Required] Action to take on the second failure of the service. + + + + + If any of the three *ActionType attributes is "restart", this specifies the number of seconds to wait before doing so. + + + + + Number of days after which to reset the failure count to zero if there are no failures. + + + + + If any of the three *ActionType attributes is "reboot", this specifies the message to broadcast to server users before doing so. + + + + + If any of the three *ActionType attributes is "runCommand", this specifies the command to run when doing so. This value is formatted. + + + + + [Required] Determines the type of the service failure action. + + + + + Service configuration information for failure actions. + + + + + Determines the type of the service failure action. + + + + + A file system driver service. This value is not currently supported by the Windows Installer. + + + + + A kernel driver service. This value is not currently supported by the Windows Installer. + + + + + A Win32 service that shares a process. + + + + + A Win32 service that runs its own process. + + + + + Determines the type of the service. The Windows Installer does not currently support kernelDriver or systemDriver. + + + + + The service is a device driver that will be started by the IoInitSystem function. This value is not currently supported by the Windows Installer. + + + + + The service is a device driver that will be started by the operating system boot loader. This value is not currently supported by the Windows Installer. + + + + + The service can no longer be started. + + + + + The service will start when the service control manager calls the StartService function. + + + + + The service will start during startup of the system. + + + + + Determines when the service should be started. The Windows Installer does not support boot or system. + + + + + Logs the error if it is possible and the system is restarted with the last configuration known to be good. If the last-known-good configuration is being started, the startup operation fails. + + + + + Logs the error, displays a message box and continues the startup operation. + + + + + Logs the error and continues with the startup operation. + + + + + Determines what action should be taken on an error. + + + + + Service Control Element. Can Start, Stop and Remove services + + + + + These are used in many methods for generating WiX nodes, regard them as booleans + + + + + Specifies whether an action occur on install, uninstall or both. + + + + + File Architecture, either X64 or X86, defaults to X64 + + + + + File Path in WiX definition + + + + + File Name in WiX definition + + + + + File Id in WiX definition + + + + + WiX File Element + + + + + Harvests the contents of a Directory for use with Wix using the [Heat](http://wixtoolset.org/documentation/manual/v3/overview/heat.html) tool. + ## Parameters + - `setParams` - Function used to manipulate the Heat default parameters. + - `directory` - The path to the directory that will be harvested by Heat. + - `outputFile` - The output file path given to Heat. + + + + + + Default values for the Heat harvesting + + + + + Uses the WiX tools [Candle](http://wixtoolset.org/documentation/manual/v3/overview/candle.html) and [Light](http://wixtoolset.org/documentation/manual/v3/overview/light.html) to create an msi. + ## Parameters + - `setParams` - Function used to manipulate the WiX default parameters. + - `outputFile` - The msi output file path (given to Light). + - `wixScript` - The path to a WiX script that will be used with Candle. + + ## Sample + Target "BuildSetup" (fun _ -> + // Copy all important files to the deploy directory + !! (buildDir + "/**/*.dll") + ++ (buildDir + "/**/*.exe") + ++ (buildDir + "/**/*.config") + |> Copy deployPrepDir + + // replace tags in a template file in order to generate a WiX script + let ALLFILES = fun _ -> true + + let replacements = [ + "@build.number@",if not isLocalBuild then buildVersion else "0.1.0.0" + "@product.productcode@",System.Guid.NewGuid().ToString() + "@HelpFiles@",getFilesAsWiXString helpFiles + "@ScriptFiles@",getFilesAsWiXString scriptFiles + "@icons@",wixDir ALLFILES true (directoryInfo(bundledDir @@ "icons"))] + + processTemplates replacements setupFiles + + // run the WiX tools + WiX (fun p -> {p with ToolDirectory = WiXPath}) + setupFileName + (setupBuildDir + "Setup.wxs.template") + ) + + + + + Runs the [Light tool](http://wixtoolset.org/documentation/manual/v3/overview/light.html) on the given WiX script with the given parameters + + + + + Runs the [Candle tool](http://wixtoolset.org/documentation/manual/v3/overview/candle.html) on the given WiX script with the given parameters + + + + + Generates a major upgrade based on the given parameters, use toString on it when embedding it + ## Parameters + - `setParams` - Function used to manipulate the WiX default parameters. + + ## Sample + let majorUpgradeVersion = generateMajorUpgradeVersion(fun f -> + {f with + DowngradeErrorMessage = "A later version is already installed, exiting." + }) + + + + + Generates an upgrade version based on the given parameters, use toString on it when embedding it + ## Parameters + - `setParams` - Function used to manipulate the WiX default parameters. + + ## Sample + let upgradeVersion = generateUpgradeVersion (fun f -> + {f with + Minimum = productVersion + OnlyDetect = "yes" + }) + + + + + Generates an upgrade based on the given parameters, use toString on it when embedding it + ## Parameters + - `setParams` - Function used to manipulate the WiX default parameters. + + ## Sample + let upgrade = generateUpgrade (fun f -> + {f with + Id = productUpgradeCode + }) + + + + + Generates a ui ref based on the given parameters, use toString on it when embedding it + ## Parameters + - `setParams` - Function used to manipulate the WiX default parameters. + + ## Sample + let UIRef = generateUIRef (fun f -> + {f with + Id = "WixUI_Mondo" + }) + + + + + Generates a custom action execution based on the given parameters, use toString on it when embedding it + Condition in sample makes execute only on install + ## Parameters + - `setParams` - Function used to manipulate the WiX default parameters. + + ## Sample + let actionExecution = generateCustomActionExecution (fun f -> + {f with + ActionId = action.Id + Verb = "After" + Target = "InstallFiles" + Condition = "<![CDATA[(&" + feature.Id + " = 3) AND NOT (!" + feature.Id + " = 3)]]>" + }) + + + + + Generates a customAction based on the given parameters, use toString on it when embedding it + Be careful to make Id unique. FileKey is a reference to a file Id which you added by using wixDir or wixFile + Set impersonate to no if your action needs elevated privileges, you should then also set execute as "deferred" + ExeCommand are the parameters passed to your executable + ## Parameters + - `setParams` - Function used to manipulate the WiX default parameters. + + ## Sample + let action = generateCustomAction (fun f -> + {f with + Id = "UniqueActionId" + FileKey = "fi_5" + Execute = "deferred" + Impersonate = "no" + ExeCommand = "install" + Return = "check" + }) + + + + + Generates a feature based on the given parameters, use toString on it when embedding it + You can pass other features into InnerContent for making a hierarchy + ## Parameters + - `setParams` - Function used to manipulate the WiX default parameters. + + ## Sample + let feature = generateFeature (fun f -> + {f with + Id = "UniqueName" + Title = "Title which is shown" + Level = 1 + Description = "Somewhat longer description" + Display = "expand" + InnerContent = [otherFeature1; otherFeature2] + }) + + + + + Generates a feature based on the given parameters, use toString on it when embedding it + You can pass other features into InnerContent for making a hierarchy + ## Parameters + - `setParams` - Function used to manipulate the WiX default parameters. + + ## Sample + let feature = generateFeature (fun f -> + {f with + Id = "UniqueName" + Title = "Title which is shown" + Level = 1 + Description = "Somewhat longer description" + Display = "expand" + InnerContent = otherFeature.ToString() + }) + + + + + Takes path where script files reside and sets all parameters as defined + ## Parameters + - `wiXPath` - Pass path where your script is located at. Function will search for all Scripts in that location and fill in parameters + - `setParams` - Function used to manipulate the WiX default parameters. + + ## Sample + FillInWixScript "" (fun f -> + {f with + ProductCode = WiXProductCode + ProductName = WiXProductName + Description = projectDescription + ProductLanguage = WiXProductLanguage + ProductVersion = WiXProductVersion + ProductPublisher = WixProductPublisher + UpgradeGuid = WixProductUpgradeGuid + UIRefs = uiRef1.ToString() + uiRef2.ToString() + WiXVariables = wiXLicense.ToString() + Directories = directories + DirectoryRefs = directoryrefs + BuildNumber = "1.0.0" + Features = rootFeature.ToString() + CustomActions = action1.ToString() + action2.ToString() + ActionSequences = actionExecution1.ToString() + actionExecution2.ToString() + }) + + + + + Takes path where script files reside and sets all parameters as defined + ## Parameters + - `wiXPath` - Pass path where your script is located at. Function will search for all Scripts in that location and fill in parameters + - `setParams` - Function used to manipulate the WiX default parameters. + + ## Sample + FillInWixScript "" (fun f -> + {f with + ProductCode = WiXProductCode + ProductName = WiXProductName + Description = projectDescription + ProductLanguage = WiXProductLanguage + ProductVersion = WiXProductVersion + ProductPublisher = WixProductPublisher + UpgradeGuid = WixProductUpgradeGuid + UIRefs = uiRef1.ToString() + uiRef2.ToString() + WiXVariables = wiXLicense.ToString() + Directories = directories + BuildNumber = "1.0.0" + Features = rootFeature.ToString() + CustomActions = action1.ToString() + action2.ToString() + ActionSequences = actionExecution1.ToString() + actionExecution2.ToString() + }) + + + + + Generates WiX Template with specified file name (you can prepend location too) + You need to run this once every build an then use FillInWiXScript to replace placeholders + ## Parameters + - `fileName` - Pass desired fileName for your wiXScript file + + ## Sample + generateWiXScript "Setup.wxs" + + + + + Default values for WiX Script properties + + + + + Default value for WiX Variable + + + + + Default value for WiX Major Upgrade + + + + + Default value for WiX Upgrade + + + + + Default value for WiX Upgrade + + + + + Default value for WiX UI Reference (WixUI_Minimal) + + + + + Default values for WiX custom action executions + + + + + Default values for WiX custom actions + + + + + Default values for WiX Script properties + + + + + Default values for creating WiX Feature + + + + + Default values for creating WiX Feature + + + + + Contains the WiX default parameters + + + + + Take a component string and set "neverOverwrite" Tag + This is useful for config files, since they are not replaced on upgrade like that + + + + + Creates WiX ComponentRef tags from the given DirectoryInfo + + + + + Retrieves all component ids from given WiX directory string + ## Parameters + - `wiXString` - The directory string which was generated by wixDir + + ## Sample + let directoryString = wixDir (fun file -> true) true (DirectoryInfo directoryWithFilesForSetup) + let componentIds = getComponentIdsFromWiXString directoryString + + + + + Retrieves the file id of the first file in WiXString, which name matches fileRegex + ## Parameters + - `wiXString` - The directory string which was generated by wixDir + - `fileRegex` - Regex which matches the file name + + ## Sample + let directoryString = wixDir (fun file -> true) true (DirectoryInfo directoryWithFilesForSetup) + let executableFileId = getFileIdFromWiXString directoryString "\S*.exe" + + + + + Creates recursive WiX directory and file tags from the given DirectoryInfo + The function will create one component for each file [best practice](https://support.microsoft.com/de-de/kb/290997/en-us) + and set the GUID to "*", which will make WiX produce consistent Component Guids if the Component's target path doesn't change. + This is vital for major upgrades, since windows installer needs a consistent component guid for tracking each of them. + You can use the getComponentIdsFromWiXString function for getting all created component refs and adding them to features. + + + + + Use this to attach service installs to your components. + + + + + Creates WiX component with directories and files from the given DirectoryInfo + The function will create one component for each file [best practice](https://support.microsoft.com/de-de/kb/290997/en-us) + and set the GUID to "*", which will make WiX produce consistent Component Guids if the Component's target path doesn't change. + This is vital for major upgrades, since windows installer needs a consistent component guid for tracking each of them. + The components are embedded into the passed in root directory. + + + + + Creates WiX component with directories and files from the given DirectoryInfo + The function will create one component for each file [best practice](https://support.microsoft.com/de-de/kb/290997/en-us) + and set the GUID to "*", which will make WiX produce consistent Component Guids if the Component's target path doesn't change. + This is vital for major upgrades, since windows installer needs a consistent component guid for tracking each of them. + You can use the getComponentIdsFromWiXString function for getting all created component refs and adding them to features. + + + + + Creates a WiX directory and component hierarchy from the given DirectoryInfo + The function will create one component for each file [best practice](https://support.microsoft.com/de-de/kb/290997/en-us) + and set the GUID to "*", which will make WiX produce consistent Component Guids if the Component's target path doesn't change. + This is vital for major upgrades, since windows installer needs a consistent component guid for tracking each of them. + You can use the getComponentRefs function for getting all created component refs and adding them to features. + You can use attachServiceControlToComponents or attachServiceInstallToComponents to attach ServiceControl or ServiceInstall to the directory component hierarchy + + + + + Calculates the SHA1 for a given string. + + + + + Use this for generating directories + + + + + Defaults for directories + + + + + Use this for generating single components + + + + + Defaults for component + + + + + Use this for generating component refs + + + + + Defaults for component ref + + + + + Use this for generating component refs + + + + + Defaults for component ref + + + + + Generates a registry key based on the given parameters, use toString on it when embedding it + You can pass other registry keys and values into RegistryKeys or RegistryValues for making a hierarchy + ## Parameters + - `setParams` - Function used to manipulate the WiX default parameters. + + ## Sample + let key = generateRegistryKey(fun k -> + {k with + Id = "KeyId" + Key = "SomeKey" + Root = Some WiXRegistryRootType.HKCR + ForceCreateOnInstall = YesOrNo.Yes + ForceDeleteOnUninstall = YesOrNo.No + Keys = someChildKeys + Values = someChildValues + }) + + + + + Generates a registry value based on the given parameters, use toString on it when embedding it + ## Parameters + - `setParams` - Function used to manipulate the WiX default parameters. + + ## Sample + let registryValue = generateRegistryValue(fun v -> + {v with + Id = "asdasd" + Name = "Something" + Key = "Somewhere" + Root = Some WiXRegistryRootType.HKU + Type = WiXRegistryValueType.Integer + KeyPath = YesOrNo.No + Value = "2" + }) + + + + + Use this for generating service installs + + + + + Defaults for service install element + + + + + Use this for generating service dependencies + + + + + Use this for generating service configs + + + + + Use this for generating service controls + + + + + Defaults for service control element + + + + + Defaults for WiX file + + + + + Creates WiX File tags from the given files + + + + + Creates a WiX File tag from the given FileInfo + + + + + Contains tasks to create msi installers using the [WiX toolset](http://wixtoolset.org/) + + + + + MSI parameter type + + + + + Uninstalls a msi. + ## Parameters + + - `setParams` - Function used to manipulate the default MSI parameters. + - `setup` - The setup file name. + + + + + Installs a msi. + ## Parameters + + - `setParams` - Function used to manipulate the default MSI parameters. + - `setup` - The setup file name. + + + + + MSI default parameters + + + + + Contains tasks which allow to run msiexec in order to install or uninstall msi files. + + + + + RegAsm parameter type + + + + + Executes `Regasm.exe` with the `/codebase /tlb /unregister` options + + Used to unregegister any temporarily registerd .net dependencies + _after_ running a VB6 build + + + + + Executes `RegAsm.exe` with the `/codebase` `/tlb` option + + Used to temporarily register any .net dependencies before running + a VB6 build + + + + + Runs regasm on the given lib + ## Parameters + + - `setParams` - Function used to manipulate the default RegAsm parameters. + - `lib` - The assembly file name. + + + + + RegAsm default params + + + + + Path to newest `regasm.exe` + + + + + Contains a task which can be used to run regasm .NET assembly + + + + + Specifies how often nuget should try to restore the packages - default is 5 + + + + + RestorePackages parameter path for single packages + + + + + Specifies how often nuget should try to restore the packages - default is 5 + + + + + RestorePackages parameter path + + + + + Restores the packages in the given solution file file from NuGet. + ## Parameters + + - `setParams` - Function used to manipulate the default NuGet parameters. + - `solutionFile` - The microsoft sln file name. + + ## Sample + + Target "RestorePackages" (fun _ -> + "./src/Everything.sln" + |> RestoreMSSolutionPackages (fun p -> + { p with + Sources = "http://myNugetSources.com" :: p.Sources + OutputPath = outputDir + Retries = 4 }) + ) + + + + + Restores all packages from NuGet to the default directories by scanning for packages.config files in any subdirectory. + + + + + Restores the packages in the given packages.config file from NuGet. + ## Parameters + + - `setParams` - Function used to manipulate the default NuGet parameters. + - `packageFile` - The packages.config file name. + + ## Sample + + Target "RestorePackages" (fun _ -> + "./src/ProjectA/packages.config" + |> RestorePackage (fun p -> + { p with + Sources = "http://myNugetSources.com" :: p.Sources + OutputPath = outputDir + Retries = 4 }) + ) + + + + + Restores the given package from NuGet + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + RestoreSinglePackageParams defaults parameters + + + + + RestorePackage defaults parameters + + + + + Looks for NuGet.exe in [1] the specified defaultPath, [2] a list of standard tool folders, [3] any subfolder in the current directory, [4] the PATH - returns the first path where NuGet.exe was found. + + + + + Contains tasks which allow to restore NuGet packages from a NuGet package feed like [nuget.org](http://www.nuget.org). + There is also a tutorial about [nuget package restore](../nuget.html) available. + + + + + Retrieves the given project from Microsoft Visual SourceSafe + + + + + Retrieves the given label of the given project from Microsoft Visual SourceSafe + + + + + Contains helper functions for [Microsoft Visual SourceSafe](http://en.wikipedia.org/wiki/Microsoft_Visual_SourceSafe) + + + + + The parameter type allows to interact with Dynamics NAV RTC. + + + + + A parameter type to interact with Dynamics NAV + + + + + A Dynamics NAV server type + + + + + Analyzes the XML-based Dynamics NAV test results from XMLPort 130021 + + + + + Analyzes the Dynamics NAV test results + + + + + Waits until all NAV processes have stopped or fails after given timeout. + ## Parameters + - `name` - The name of the processes in question. + - `timeout` - The timespan to time out after. + + + + + Closes all running Dynamics NAV instances + + + + + Returns all running NAV processes. + + + + + Opens a page with the given ID on the RTC client + + + + + Runs a codeunit with the given ID on the RTC client and the settings file (full path required) + + + + + Runs a codeunit with the given ID on the RTC client + + + + + Creates the connection information to a Dynamics NAV RTC instance + + + + + Compiles all objects in the Dynamics NAV client including already compiled ones. + + + + + Compiles all uncompiled objects in the Dynamics NAV client. + + + + + Compiles all filtered uncompiled objects in the Dynamics NAV client. + + + + + Creates an import file from the given .txt files and imports it into the Dynamics NAV client. + If the import fails, then every file will be tried alone. + + + + + Creates an import file from the given .txt files. + + + + + Imports the given .txt or .fob file into the Dynamics NAV client + + + + + Exports all objects from the Dynamics NAV client to the given .txt or .fob file + + + + + Exports objects from the Dynamics NAV client based on the given filter to the given .txt or .fob file + + + + + Creates the connection information to a Dynamics NAV instance. + + + + + Gets the directory of the Dynamics NAV ClassicClient for the given version from the registry. + + + + + Retrieves the the file name of the Dynamics NAV ClassicClient for the given version from the registry. + + + + + Contains helper function which allow to interact with Microsoft Dynamics NAV. + + + + + A type definition of a Dynamics NAV object. + + + + + Gets the highest version number for a specified version tag in a number of Dynamics NAV objects in a set of object files + + + + + Gets the highest version number for a specified version tag in a number of Dynamics NAV objects + + + + + Gets the version number for the specified version tag in a Dynamics NAV object + + + + + Gets the version number for the specified version tag in a Dynamics NAV version tag list + + + + + Splits the given files into individual object files in the specified destination directory. + + + + + Returns a standardized filename based on the given NavObject. + + + + + Splits an object string into multiple Dynamics NAV objects of type NavObject. + + + + + Checks a Dynamics NAV object for missing required and invalid tags and raises this as errors. + It also changes the given tag, resets the modified flag and time stamp. + + + + + Checks a Dynamics NAV object for missing required and invalid tags and raises this as errors. + It also changes the given tag, resets the modified flag and time stamp. + + + + + Checks a Dynamics NAV file for missing required and invalid tags and raises this as errors + + + + + Checks a Dynamics NAV object for missing required and invalid tags and raises this as errors + + + + + Get all invalid tags from a Dynamics NAV version tag list + + + + + Get all missing required tags from a Dynamics NAV version tag list + + + + + Replaces a version tag in a Dynamics NAV + + + + + Replaces a version tag list from a complete Dynamics NAV object with a new version tag list + + + + + Replaces a version tag in a version tag list from Dynamics NAV object + + + + + Splits a version tag list from Dynamics NAV object into single tags + + + + + Returns the version tag list from Dynamics NAV object. + + + + + Removes the modified flag from a Dynamics NAV object. + + + + + Replaces the timestamp in a Dynamics NAV object. + + + + + A NAV culture-specific date format. + + + + + A Regex which allows to find objects in a Dynamics NAV file. + + + + + A Regex which allows to parse objects in a Dynamics NAV file. + + + + + A Regex which allows to retrieve the modified time. + + + + + A Regex which allows to retrieve modified date. + + + + + A Regex which allows to retrieve the version list. + + + + + A Regex which allows to retrieve the modified flag. + + + + + Provides an abstraction over Dynamics NAV object files. + + + + + remote User + + + + + Path of the private key file (optional) + + + + + Path of the scp.exe + + + + + The SSH parameter type. + + + + + Performs a command via SSH. + ## Parameters + + - `setParams` - Function used to manipulate the default SSHParams value. + - `command` - The target path. Can be something like user@host:directory/TargetFile or a local path. + + ## Sample + + SSH (fun p -> { p with ToolPath = "tools/ssh.exe" }) command + + + + + The SSH default parameters + + + + + Conatins a task which allows to perform SSH operations + + + + + Path of the private key file (optional) + + + + + Path of the scp.exe + + + + + The SCP parameter type. + + + + + Performs a SCP copy from the given source directory to the target path. + ## Parameters + + - `setParams` - Function used to manipulate the default SCPParams value. + - `source` - The source path. Can be something like user@host:directory/SourceFile or a local path. + - `target` - The target path. Can be something like user@host:directory/TargetFile or a local path. + + ## Sample + + SCP (fun p -> { p with ToolPath = "tools/scp.exe" }) source target + + + + + The SCP default parameters + + + + + Conatins a task which allows to perform file copies using [SCP](http://en.wikipedia.org/wiki/Secure_copy), which is based on the Secure Shell (SSH) protocol. + + + + + Executes a RoboCopy mirror command (potentially destructive) + ## Parameters + - `source` - The source directory + - `destination` - The target directory + + + + + Executes a RoboCopy command + ## Parameters + - `source` - The source directory + - `destination` - The target directory + + + + + Executes a RoboCopy command with options + ## Parameters + - `source` - The source directory + - `destination` - The target directory + - `options` - The options to pass to robocopy + + + + + Contains a task to use [robocopy](https://en.wikipedia.org/wiki/Robocopy) on Windows. + + + + + Parameter type for xpkg tasks + + + + + Validates a xpkg package based on the package file name + + + + + Creates a new xpkg package based on the package file name + + ## Sample + + Target "PackageXamarinDistribution" (fun _ -> + xpkgPack (fun p -> + {p with + ToolPath = xpkgExecutable; + Package = "Portable.Licensing"; + Version = assemblyFileVersion; + OutputPath = publishDir + Project = "Portable.Licensing" + Summary = "Portable.Licensing is a cross platform licensing tool" + Publisher = "Nauck IT KG" + Website = "http://dev.nauck-it.de" + Details = "./Xamarin/Details.md" + License = "License.md" + GettingStarted = "./Xamarin/GettingStarted.md" + Icons = ["./Xamarin/Portable.Licensing_512x512.png" + "./Xamarin/Portable.Licensing_128x128.png"] + Libraries = ["mobile", "./Distribution/lib/Portable.Licensing.dll"] + Samples = ["Android Sample.", "./Samples/Android/Android.Sample.sln" + "iOS Sample.", "./Samples/iOS/iOS.Sample.sln"] + } + ) + ) + + + + + Creates xpkg default parameters + + + + + Contains tasks to create packages in [Xamarin's xpkg format](http://components.xamarin.com/) + + + + + PATCH version when you make backwards-compatible bug fixes. + + + + + MINOR version when you add functionality in a backwards-compatible manner. + + + + + MAJOR version when you make incompatible API changes. + + + + + Contains the version information. + + + + + Gets file assembly version in form of major.minor.build.revision. + ## Parameters + - `assemblyFile` - The assembly file path. + + + + + Gets file assembly version. + ## Parameters + - `assemblyFile` - The assembly file path. + + + + + Result type for project comparisons. + + + + + The project file name + + + + + All files which are in "Compile" sections + + + + + All files which are in "Content" sections + + + + + Saves the project file + + + + + Removes a file from the Compile nodes + + + + + Removes a file from the Content nodes + + + + + Read a Project from a FileName + + + + + Finds duplicate files which are in "Compile" sections + + + + + Finds duplicate files which are in "Content" sections + + + + + Add a file to the Compile nodes + + + + + Add a file to the Content nodes + + + + + A small abstraction over MSBuild project files. + + + + + Removes projects Content nodes that have Include attributes pointing to files missing from the file system. Saves updated projects. + + + + + Removes projects Compile nodes that have Include attributes pointing to files missing from the file system. Saves updated projects. + + + + + Compares the given project files against the template project and fails if any files are missing. + For F# projects it is also reporting unordered files. + + + + + Compares the given projects to the template project and adds all missing content files to the projects if needed. + It also removes duplicate files from the project files. + + + + + Compares the given projects to the template project and adds all missing files to the projects if needed. + It also removes duplicate files from the project files. + + + + + It removes duplicate content files from the project files. + + + + + It removes duplicate files from the project files. + + + + + Compares the given projects to the template project and adds all missing files to the projects if needed. + + + + + Compares the given projects to the template project and adds all missing files to the projects if needed. + + + + + Compares the given project files against the template project and returns which files are missing. + For F# projects it is also reporting unordered files. + + + + + Compares the given project files against the template project and returns which files are missing. + For F# projects it is also reporting unordered files. + + + + + Contains project file comparison tools for MSBuild project files. + + + + + Removes all spec and test data references from a project. + + + + + Removes all NUnit references from a project. + + + + + A Convention which matches nothing + + + + + All Spec.cs or Spec.fs files and all files containing TestData + + + + + All Spec.cs or Spec.fs files + + + + + All references to nunit.*.dlls + + + + + Removes test data and test files from a given MSBuild project and recursivly from all MSBuild project dependencies. + ## Parameters + + - `assemblyFilterF` - A filter function for assembly references. + - `fileFilterF` - A filter function for files in a project. + - `projectFileName` - The MSBuild project to start. + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + Converts a MSBuildProject to XML + [omit] + + + + + Contains functions which allow to remove side-by-side specs during the build. + + + + + Searches the .git directory recursivly up to the root. + + + + + [omit] + + + + + Runs the git command and returns the first line of the result. + + + + + Runs the given git command, waits for its completion. + This version doesn't throw an exception if an error occurs. It just traces the error. + + + + + [omit] + + + + + Runs the given git command, waits for its completion. + + + + + Runs the given git command, waits for its completion and fails when it didn't succeeded. + + + + + Runs the given git command, waits for its completion and returns whether it succeeded. + + + + + Fires the given git command ind the given repository directory and returns immediatly. + + + + + [omit] + + + + + [omit] + + + + + Runs git.exe with the given command in the given repository directory. + + + + + Tries to locate the git.exe via the eviroment variable "GIT". + + + + + Specifies a global timeout for git.exe - default is *no timeout* + + + + + Contains helpers which allow to interact with [git](http://git-scm.com/) via the command line. + + + + + Shows the SHA1 calculated by git. + Assumes that the CommandHelper module can find git.exe. + + + + + Calculates the SHA1 for a given string like git. + + + + + Calculates the SHA1 for a given string. + + + + + Contains functions which allow the SHA1 of a file with git and without it. + + + + + Cleans a directory by removing all files and sub-directories. + ## Parameters + + - `repositoryDir` - The path of the directory to clean. + + + + + Inits a git repository. + ## Parameters + + - `repositoryDir` - The path of the target directory. + - `bare` - If the new directory is a bare directory. + - `shared` - Specifies that the git repository is to be shared amongst several users. This allows users belonging to the same group to push into that repository. + + + + + Clones a single branch of a git repository. + ## Parameters + + - `workingDir` - The working directory. + - `repoUrl` - The URL to the origin. + - `branchname` - Specifes the target branch. + - `toPath` - Specifes the new target subfolder. + + + + + Clones a git repository. + ## Parameters + + - `workingDir` - The working directory. + - `repoUrl` - The URL to the origin. + - `toPath` - Specifes the new target subfolder. + + + + + Contains functions which allow basic operations on git repositories. + All operations assume that the CommandHelper can find git.exe. + + + + + Gets the current status. + + + + + Gets the remote path from the config. + + + + + Gets the local path from the config. + + + + + This record represents a git submodule binding. + + + + + Adds a submodule to the given super repository. + ## Parameters + + - `superRepositoryDir` - The super repository. + - `remotePath` - The path to the remote repository of the submodule. + - `localPath` - The local path to the submodule. + - `branch` - The branch to clone. (can be null) + + + + + Inits a submodule with the given name in a subfolder of the given super repository. + ## Parameters + + - `superRepositoryDir` - The super repository. + - `name` - The name of the new repository. + + + + + Gets all submodules from the given repository directory. + + + + + Contains helper functions which allow to deal with git submodules. + + + + + Pulls a given branch from the given remote. + ## Parameters + + - `repositoryDir` - The git repository. + - `remote` - The name of the remote. + - `branch` - The name of the branch to pull + + + + + Pushes the given branch to the given remote. + ## Parameters + + - `repositoryDir` - The git repository. + - `remote` - The remote. + - `branch` - The branch. + + + + + Pushes the given tag to the given remote. + ## Parameters + + - `repositoryDir` - The git repository. + - `remote` - The remote. + - `tag` - The tag. + + + + + Pushes all branches to the default remote. + ## Parameters + + - `repositoryDir` - The git repository. + + + + + Deletes the given tag. + ## Parameters + + - `repositoryDir` - The git repository. + - `tag` - The tag which should be deleted. + + + + + Tags the current branch. + ## Parameters + + - `repositoryDir` - The git repository. + - `tag` - The new tag. + + + + + Deletes the given branch. + ## Parameters + + - `repositoryDir` - The git repository. + - `force` - Determines if git should be run with the *force* flag. + - `branch` - The branch which should be deleted. + + + + + Creates a new branch from the given commit. + ## Parameters + + - `repositoryDir` - The git repository. + - `newBranchName` - The new branch. + - `commit` - The commit which git should take as the new HEAD. - can be HEAD, HEAD~1, ... , a branch name or a prefix of a SHA1. + + + + + Performs a checkout of the given branch to the working copy. + ## Parameters + + - `repositoryDir` - The git repository. + - `create` - Set this to true if the branch is new. + - `branch` - The new branch. + + + + + Creates a new branch based on the given baseBranch and checks it out to the working copy. + ## Parameters + + - `repositoryDir` - The git repository. + - `baseBranch` - The base branch. + - `branch` - The new branch. + + + + + Performs a checkout of the given branch with an additional tracking branch. + ## Parameters + + - `repositoryDir` - The git repository. + - `trackBranch` - The tracking branch. + - `branch` - The branch for the checkout. + + + + + Performs a checkout of the given branch to the working copy. + ## Parameters + + - `repositoryDir` - The git repository. + - `branch` - The branch for the checkout. + + + + + Returns the number of revisions between the two given commits. + ## Parameters + + - `repositoryDir` - The git repository. + - `commit1` - The first commit for which git should find the merge base. + - `commit2` - The second commit for which git should find the merge base. + + + + + Returns the SHA1 of the merge base of the two given commits from the given repository. + ## Parameters + + - `repositoryDir` - The git repository. + - `commit1` - The first commit for which git should find the merge base. + - `commit2` - The second commit for which git should find the merge base. + + + + + Returns the SHA1 of the given commit from the given repository. + ## Parameters + + - `repositoryDir` - The git repository. + - `commit` - The commit for which git should return the SHA1 - can be HEAD, HEAD~1, ... , a branch name or a prefix of a SHA1. + + + + + Gets all local and remote branches from the given repository. + + + + + Gets all remote branches from the given repository. + + + + + Gets all local branches from the given repository. + + + + + Contains helper functions which allow to deal with git branches. + + + + + Performs a git reset "hard" to the current HEAD. + Resets the index and working tree. Any changes to tracked files in the working tree since <commit> are discarded. + ## Parameters + + - `repositoryDir` - The git repository. + + + + + Performs a git reset "mixed" to the current HEAD. + Resets the index but not the working tree and reports what has not been updated. + ## Parameters + + - `repositoryDir` - The git repository. + + + + + Performs a git reset "soft" to the current HEAD. + Does not touch the index file nor the working tree at all. + ## Parameters + + - `repositoryDir` - The git repository. + + + + + Performs a git reset "hard". + Resets the index and working tree. Any changes to tracked files in the working tree since <commit> are discarded. + ## Parameters + + - `repositoryDir` - The git repository. + - `commit` - The commit to which git should perform the reset. + - `file` - The file to reset - null means all files. + + + + + Performs a git reset "mixed". + Resets the index but not the working tree and reports what has not been updated. + ## Parameters + + - `repositoryDir` - The git repository. + - `commit` - The commit to which git should perform the reset. + - `file` - The file to reset - null means all files. + + + + + Performs a git reset "soft". + Does not touch the index file nor the working tree at all. + ## Parameters + + - `repositoryDir` - The git repository. + - `commit` - The commit to which git should perform the reset. + - `file` - The file to reset - null means all files. + + + + + the intent of the 'reset' helper is to either set a repo to a certain point, or set a file to a certain point. Git reset doesn't take file paths in the hard/mixed/soft modes, and so you have to use checkout instead for that. + This function encapsulates caring about that so you don't have to. + + + + + Contains helper functions which allow to deal with git reset. + + + + + Git merge option. + + + + + Performs a merge of the given branch with the current branch + ## Parameters + + - `repositoryDir` - The git repository. + - `flags` - Additional flags. + - `branch` - The branch we want to merge in. + ## Sample + + merge @"C:\code\Fake" NoFastForwardFlag "master" + + + + + Tests whether branches and their "origin" counterparts have diverged and need merging first. + ## Parameters + + - `repositoryDir` - The git repository. + - `local` - The local branch name. + - `remote` - The remote branch name. + + + + + Forbids git to use fast-forward merges + + + + + Allows git to use fast-forward merges + + + + + Gets the current merge message. + + + + + Contains helper functions which allow to deal with git merge. + + + + + Remove a single stashed state from the stash list and + apply it on top of the current working tree state, + i.e., do the inverse operation of git stash save. + The working directory must match the index. + + + + + Stash the changes in a dirty working directory away. + + + + + Contains helper functions which allow to deal with git stash. + + + + + Checks if the given branch is a remote branch. + + + + + Checks if the given branch is a local branch. + + + + + Checks if the given branch is absent. + + + + + Checks if the given branch exists. + + + + + Checks if the given branch exists. + + + + + Contains helper function which can be used for sanity checks. + + + + + Gets the current hash of the current repository + + + + + Gets the last git tag of the current repository by calling git describe + + + + + Gets the git log in one line + + + + + Gets the last git tag by calling git describe + + + + + Returns true if rev1 is ahead of rev2 + + + + + Returns a friendly name from a SHA1 + + + + + Checks if the working copy is clean + + + + + Shows the git status + + + + + Returns the SHA1 of the current HEAD + + + + + Gets the git branch name + + + + + [omit] + + + + + Gets the git version + + + + + Contains helper functions which can be used to retrieve status information from git. + + + + + A type which represents a file status in git. + + + + + Cleans the working copy by doing a git reset --hard and a clean -f. + + + + + Returns true if the given repository is in the middle of a patch process. + + + + + Returns true if the given repository is in the middle of a rebase process. + + + + + Returns the current rebase directory for the given repository. + + + + + Returns true if the working copy is in a conflicted merge otherwise false + + + + + Gets all conflicted files + + + + + Gets the changed files since the given revision incl. changes in the working copy + + + + + Gets all changed files in the current revision + + + + + Gets the changed files between the given revisions + + + + + Contains helper functions which can be used to retrieve file status information from git. + + + + + Tries to rebase on top of the given branch. + If the rebasing process fails a normal merge will be started. + Returns if the process used merge instead of rebase. + + + + + rebase failed ==> fallback on merge + [omit] + + + + + Restart the rebasing process by skipping the current patch. + + + + + Restart the rebasing process after having resolved a merge conflict. + + + + + Restore the original branch and abort the rebase operation. + + + + + Performs a rebase on top of the given branch with the current branch + + + + + Contains helper functions which allow to deal with git rebase. + + + + + Sets the commit message + + + + + Gets the commit message + + + + + Returns the commit message file. + + + + + Contains helper functions which allow to get and set the git commit message. + + + + + Adds all files to the staging area + + + + + Adds a file to the staging area + + + + + Contains helper functions which allow to deal with git's staging area. + + + + + Commits all files in the given repository with the given message + + + + + Contains helper functions which allow to commit to git repositories. + + + + + Run the given buildscript with fsi.exe + + + + + Run the given buildscript with fsi.exe at the given working directory. + + + + + Run the given buildscript with fsi.exe at the given working directory. Provides full access to Fsi options and args. + + + + + Run the given buildscript with fsi.exe and allows for extra arguments to the script. Returns output. + + + + + Run the given buildscript with fsi.exe and allows for extra arguments to the script. Returns output. + + + + + Run the given FAKE script with fsi.exe at the given working directory. Provides full access to Fsi options and args. Redirect output and error messages. + + + + + Run a given script unchacked, saves the cache if useCache is set to true. + deletes any existing caching for the given script. + + + + + Handles a cache store operation, this should not throw as it is executed in a finally block and + therefore might eat other exceptions. And a caching error is not critical. + + + + + Run a script from the cache + + + + + because it is used by test code + + + + + gets a cache entry for the given script. + We need to consider fsiOptions as they might contain --defines. + + + + + Run the given build script with fsi.exe and allows for extra arguments to the script. Returns output. + + + + + Run the given build script with fsi.exe and allows for extra arguments to FSI. Returns output. + + + + + Run the given build script with fsi.exe and allows for extra arguments to FSI. + + + + + Run the given buildscript with fsi.exe + + + + + Creates a ProcessStartInfo which is configured to the F# Interactive. + + + + + The path to the F# Interactive tool. + + + + + Contains helper functions which allow to interact with the F# Interactive. + + + + + Runs the handler with the default environment. + + + + + Represents a command line handler. + + + + + The default environment. + + + + + Abstracts over command-line environment features. + + + + + Stage of execution for a boot system. + + + + + The full path to the root folder. + + + + + The URL of the NuGet source to use. + + + + + Full path to the `packages` directory for storing NuGet packages. + + + + + List of automatically installed and NuGet dependencies. + + + + + The credentials to use when authenticating to NuGet, if any. + + + + + Full path to the auto-generated fsx file with include statements. + + + + + Framework name for assembly resolution. + + + + + The default configuration for a given source directory. + + + + + Configures the boostrapping process. + + + + + The version specification. + + + + + The identifer of the package, such as "FAKE". + + + + + The default pacakage dependency - take latest including pre-release. + + + + + Specifies NuGet package dependencies. + + + + + Pick the given semantic version, such as "2.1.170-alpha". + + + + + Pick the latest available version, including pre-release versions. + + + + + Pick the latest available version. + + + + + Specifies which version of the NuGet package to install. + + + + + The main function intended to be executed in the BOOT phase of + boostrapping scripts. + + + + + Detects boot-specific commands. + + + + + Creates the CommandHandler from the + + + + + Checks if the F# script file is a bootstrapping script. + + + + + Computes extra command-line arguments to enable bootstrapping FAKE scripts. + + + + + Implements support for boostrapping FAKE scripts. A bootstrapping + `build.fsx` script executes twice (in two stages), allowing to + download dependencies with NuGet and do other preparatory work in + the first stage, and have these dependencies available in the + second stage. + + + + + Waits for another application to create a output file. + If the timeout is reached an exception will be raised. + + + + + Waits for other applications to create a output files. + If the timeout is reached an exception will be raised. + + + + + Contains helper function which allow FAKE to interact with other applications via message files. + + + + + Uses the HTML Help Workshop to compile a help project and returns the generated file names of the generated files. + ## Parameters + + - `helpCompiler` - The filename of the HTML Help WorkShop tool. + - `projectFile` - The fileName of the help project. + + + + + Contains a task which allows to use [HTML Help Workshop](http://msdn.microsoft.com/en-us/library/windows/desktop/ms670169(v=vs.85).aspx) in order to compile a help project. + + + + + Applies a Xsl Stylesheet to a config file and writes it back. + ## Parameters + - `xsl` - The Xsl stylesheet to apply. + - `fileName` - The file name of the config file. + + ## Sample + + applyXslOnConfig (navServicePath @@ DEV.xsl) (navServicePath @@ "CustomSettings.config") + + + + + Reads a config file from the given file name, replaces the connection string value and writes it back. + ## Parameters + - `connectionStringKey` - The connection string key name for which the value should be replaced. + - `value` - The new connection string value. + - `fileName` - The file name of the config file. + + + + + Reads a config file from the given file name, replaces the Application Setting (as opposed to AppSetting) value and writes it back. + ## Parameters + - `settingName` - The ApplicationSetting name for which the value should be replaced. + - `value` - The new ApplicationSetting value. + - `fileName` - The file name of the config file. + + ## Sample + + updateApplicationSetting "DatabaseName" targetDatabase (navServicePath @@ "CustomSettings.config") + + + + + Reads a config file from the given file name, replaces the app setting value and writes it back. + ## Parameters + - `key` - The AppSettings attribute key name for which the value should be replaced. + - `value` - The new AppSettings attribute value. + - `fileName` - The file name of the config file. + + ## Sample + + updateAppSetting "DatabaseName" targetDatabase (navServicePath @@ "CustomSettings.config") + + + + + Reads a config file from the given file name, replaces an attribute using the given xPath and writes it back. + ## Parameters + - `fileName` - The file name of the config file. + - `xpath` - An XPath term which can be used to replace the attribute. + - `attribute` - The attribute name for which the value should be replaced. + - `value` - The new attribute value. + + + + + Reads a config file from the given file name, replaces an attribute using the given xPath and writes it back. + ## Parameters + - `xpath` - An XPath term which can be used to replace the attribute. + - `attribute` - The attribute name for which the value should be replaced. + - `value` - The new attribute value. + - `config` - The XElement representing the config. + + + + + Writes an XmlDocument to a config file. + ## Parameters + - `fileName` - The file name of the config file. + - `config` - The XmlDocument representing the config. + + + + + Reads a config file into an XmlDocument. + ## Parameters + - `fileName` - The file name of the config file. + + + + + Contains functions which allow to read and write config files. + + + + + Represents build errors + + + + + A Target can be run during the build + + + + + [omit] + + + + + [omit] + + + + + Activates the FinalTarget. + + + + + Registers a final target (not activated). + + + + + Activates the BuildFailureTarget. + + + + + Registers a BuildFailureTarget (not activated). + + + + + Runs a target and its dependencies. + + + + + Runs the given array of targets in parallel using count tasks + + + + + Runs a single target without its dependencies + + + + + Determines a parallel build order for the given set of targets + + + + + Gets a flag indicating that the user requested to output a DOT-graph + of target dependencies instead of building a target. + + + + + List all available targets. + + + + + [omit] + + + + Writes a build time report. + The total runtime. + + + + Writes a summary of errors reported during build. + + + + Writes a dependency graph of all targets in the DOT format. + + + Writes a dependency graph. + Whether to print verbose output or not. + The target for which the dependencies should be printed. + + + + Prints all targets. + + + + + Runs all build failure targets. + [omit] + + + + + Runs all activated final targets (in alphabetically order). + [omit] + + + + + [omit] + + + + + Get Errors - Returns the errors that occured during execution + + + + + Creates a Target. + + + + + Creates a TargetTemplate. + + + + + Creates a TargetTemplate with dependencies. + + ## Sample + + The following sample creates 4 targets using TargetTemplateWithDependencies and hooks them into the build pipeline. + + // Create target creation functions + let createCompileTarget name strategy = + TargetTemplateWithDependencies + ["Clean"; "ResolveDependencies"] // dependencies to other targets + (fun targetParameter -> + tracefn "--- start compile product..." + if targetParameter = "a" then + tracefn " ---- Strategy A" + else + tracefn " ---- Strategy B" + tracefn "--- finish compile product ..." + ) name strategy + + let createTestTarget name dependencies filePattern = + TargetTemplateWithDependencies + dependencies + (fun filePattern -> + tracefn "--- start compile tests ..." + !! filePattern + |> RunTests + tracefn "--- finish compile tests ...") + name filePattern + + // create some targets + createCompileTarget "C1" "a" + createCompileTarget "C2" "b" + + createTestTarget "T1" ["C1"] "**/C1/*.*" + createTestTarget "T2" ["C1"; "C2"] "**/C?/*.*" + + // hook targets to normal build pipeline + "T1" ==> "T2" ==> "Test" + + + + + + Creates a target from template. + [omit] + + + + + Set a dependency for all registered targets. + [omit] + + + + + Set a dependency for all given targets. + [omit] + + + + + Backwards dependencies operator - x is dependent on ys. + + + + + Adds the dependencies to the list of soft dependencies. + [omit] + + + + + Adds the dependencies to the list of dependencies. + [omit] + + + + + Adds the dependency to the list of soft dependencies. + [omit] + + + + + Adds the dependency to the list of dependencies. + [omit] + + + + + Appends the dependency to the list of soft dependencies. + [omit] + + + + + Appends the dependency to the list of dependencies. + [omit] + + + + + Adds the dependency to the front of the list of dependencies. + [omit] + + + + + Checks whether the soft dependency can be added. + [omit] + + + + + Checks whether the dependency can be added. + [omit] + + + + + Checks whether the dependency (soft or normal) can be added. + [omit] + + + + + Do nothing - fun () -> () - Can be used to define empty targets. + + + + + Returns the soft DependencyString for the given target. + + + + + Returns the DependencyString for the given target. + + + + + Gets a target with the given name from the target dictionary. + + + + + Returns a list with all target names. + + + + + Resets the state so that a deployment can be invoked multiple times + [omit] + + + + + The executed target time. + [omit] + + + + + The executed targets. + + + + + BuildFailureTargets - stores build failure targets and if they are activated. + + + + + Final Targets - stores final targets and if they are activated. + + + + + TargetDictionary + [omit] + + + + + Sets the Description for the next target. + [omit] + + + + + [omit] + + + + + [omit] + + + + + Contains infrastructure code and helper functions for FAKE's target feature. + + + + + Defines a conditional dependency - y is dependent on x if the condition is true + + + + + Defines that x and y are not dependent on each other but y is dependent on all dependencies of x. + + + + + Defines a soft dependency. x must run before y, if it is present, but y does not require x to be run. + + + + + Defines a soft dependency. x must run before y, if it is present, but y does not require x to be run. + + + + + Defines a dependency - y is dependent on x + + + + + Specifies that two targets have the same dependencies + + + + + Specifies that two targets have the same dependencies + + + + + Specifies that two targets are on the same level of execution + + + + + Stores which targets are on the same level + + + + + Runs the target given by the target parameter + + + + + Runs the target given by the target parameter or lists the available targets + + + + + Runs the target given by the target parameter or the given default target + + + + + Runs the target given by the build script parameter or the given default target + + + + + Runs a Target and its dependencies + + + + + Appends the dependency to the list of dependencies + + + + + Converts a dependency into a list + + + + + Allows to use For? syntax for Dependencies + + + + + Allows to use Tokens instead of strings for TargetNames + + + + + Allows to use Tokens instead of strings + + + + + Provides functions and operators to deal with FAKE targets and target dependencies. + + + + + Checks that the current user has administrator permissions - otherwise it throws an exception. + ## Parameters + - `f` - This Function will be excuted if the use has the right permissions. + + ## Sample + + Target "Install" (fun _ -> + requiresAdmin (fun _ -> installMSI()) + ) + + + + + Returns whether the given user has administrator permissions. + ## Parameters + - `identity` - The windows identity of the user in question. + + + + + Contains functions which allow to deal with permissions. + + + + + SpecFlow execution parameter type. + + + + + ## Parameters + + - `setParams` - Function used to manipulate the default SpecFlow parameter value. + + + + + SpecFlow default execution parameters. + + + + + Contains a task which allows to run [SpecFlow](http://www.specflow.org/) tests. + + + + + Complete Octo.exe CLI params + + + + + Option type for selecting one command + + + + + if the package already exists, should this package overwrite it? + + + + + Maximum (inclusive) version number for the range of versions to delete + + + + + Minimum (inclusive) version number for the range of versions to delete + + + + + Name of the project + + + + + Options for deleting a range of releases in a project + + + + + A comma-separated list of machine names to target in the + deployed environment. If not specified, all machines in + the environment will be considered. + + + + + Specifies how much time should elapse between deployment status + checks (default: 10 seconds) + + + + + Specifies maximum time that deployment can take + (default: 10 minutes) + + + + + Show progress of the deployment. + (Sets --waitfordeployment and --norawlog to true.) + + + + + Don't print the raw log of failed tasks + + + + + Whether to wait synchronously for deployment to finish + + + + + If a project is configured to skip packages with already-installed + versions, override this setting to force re-deployment + + + + + Version number of the release to deploy; Specify "latest" for + the latest release + + + + + Environment to deploy to + + + + + Name of the project + + + + + Options for deploying a release to an environment + + + + + Ignore package version matching rules + + + + + Channel to use for the new release + + + + + If a release with the version number already exists, ignore it + + + + + Path to a file that contains Release Notes for the new release + + + + + Release Notes for the new release + + + + + A folder containing NuGet packages from which we should get versions + + + + + Version number to use for a package in the release + + + + + Default version of all packages to use for this release + + + + + Release number to use for the new release + + + + + Name of the project + + + + + Options for creating a new release + + + + + Your API key; retrieved from the user profile page. + + + + + The base URL for your Octopus server + + + + + Octo.exe server options + + + + + This task calls the Octo.exe CLI. + See [Octopus-Tools](https://github.com/OctopusDeploy/Octopus-Tools) for more details. + ## Parameters + + - `setParams` - Function used to overwrite the OctoTools default parameters. + + + + + Maps a command to string input for the octopus tools cli. + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + Default parameters to call octo.exe. + + + + + Default options for 'DeleteReleases' + + + + + Default options for 'DeployRelease' + + + + + Default options for 'CreateRelease' + + + + + Default server options. + + + + + Contains tasks which can be used for automated deployment via [Octopus Deploy](http://octopusdeploy.com/). + There is also a tutorial about the [Octopus deployment helper](../octopusdeploy.html) available. + + + + + The optional url of the timestamp server to use + + + + + The optional real certificate that will be used when it is found + + + + + The dev certificate that will be used when the real certificate can not be found + + + + + Parameters used for signing. + + + + + The file containing the password + + + + + The certificate files + + + + + Represents a certificate file and an optional password + + + + + Signs all files in filesToSign with the certification file certFile, + protected with the password in the file passFile. + The signtool will be search in the toolPath. + + + + + Appends a SHA 256 signature to assemblies according to the settings specified in the parameters using signtool.exe. + This will be looked up using the toolsPath parameter. + + + + + Signs assemblies according to the settings specified in the parameters using signtool.exe. + This will be looked up using the toolsPath parameter. + + + + + Contains a task to sign assemblies using the [SignTool](http://msdn.microsoft.com/en-us/library/windows/desktop/aa387764(v=vs.85).aspx). + + ## Certificates + The SignTool needs a certificate to sign assemblies. It is not a good idea to include a certficate in your + source control system, but the sign step should be usable on developer machines. Because of this, you can + specify a dev certificate that can safely included in your source control system. Whenever the real certificate + can not be found, the dev certificate will be used. + + + + + Needed information to call MAGE + + + + + The level of trust to grant the application on client computers. + + + + + The supported commands of the MAGE tool + + + + + These are the supported processor types of the MAGE tool + + + + + Executes a full run of MAGE commands: first, it creates a new manifest file. Then it signs the manifest, deploys the application and finally signs the deployment. + + + + + Encapsulates the MAGE call to sign the deployment of an application + + + + + Encapsulates the MAGE call to deploy an application + + + + + Encapsulates the MAGE call to sign an application's manifest + + + + + Encapsulates the MAGE call to update an existing application's manifest + + + + + Encapsulates the MAGE call to create a new application's manifest + + + + + Execute the MAGE tool. Adds some parameters, dependent on the MAGE command. + + + + + Convert the parameter structure into command line arguments of MAGE + + + + + Contains helper functions which allow FAKE to call the [Manifest Generation and Editing Tool](http://msdn.microsoft.com/en-us/library/acz3y3te.aspx), in short 'MAGE'. + The intentional use is the creation of a clickonce application. + + ## Certificates + The MAGE tool wants to sign the manifest using a certificate. It should be clear, that this file is not under source control. + On the other hand - you want to be able to run the compile batch on each developer machine. How can we achieve that? + In the parameter structure, we use a CertFile property and a TmpCertFile property. Whenever the CertFile was not found, the manifest is signed with + a temporary certificate. And the latter one can be shared in the source control. + + + + + The optional build no. + + + + + The optional PreRelease version + + + + + PATCH version when you make backwards-compatible bug fixes. + + + + + MINOR version when you add functionality in a backwards-compatible manner. + + + + + MAJOR version when you make incompatible API changes. + + + + + Contains the version information. + + + + + Parses the given version string into a SemVerInfo which can be printed using ToString() or compared + according to the rules described in the [SemVer docs](http://semver.org/). + ## Sample + + parse "1.0.0-rc.1" < parse "1.0.0" // true + parse "1.2.3-alpha" > parse "1.2.2" // true + parse "1.2.3-alpha2" > parse "1.2.3-alpha" // true, but only because of lexical compare + parse "1.2.3-alpha002" > parse "1.2.3-alpha1" // false, due to lexical compare + parse "1.5.0-beta.2" > parse "1.5.0-rc.1" // false, due to lexical compare of first prerelease identitifer + parse "1.5.0-beta.2" > parse "1.5.0-beta.3" // true, due to numeric compare of second prerelease identitifer + parse "1.5.0-0123.001" < parse "1.5.0-0123.002" // true, due to numeric compare of second prerelease identifier + parse "1.0.0+lol" = parse "1.0.0" // true, because build identifiers do not influence comparison + + + + + Returns true if input appears to be a parsable semver string + + + + + Contains helpers which allow to deal with [Semantic Versioning](http://semver.org/) (SemVer). + + + + + Release date + + + + + Semantic version + + + + + The nuget package version. + + + + + The parsed version. + + + + + Contains the parsed information of the release notes text file. + + + + + Parses a Release Notes text file and returns the lastest release notes. + + ## Parameters + - `fileName` - Release notes text file name + + + + + Parses a Release Notes text and returns the lastest release notes. + + ## Parameters + - `data` - Release notes text + + + + + Parses a Release Notes text and returns all release notes. + + ## Parameters + - `data` - Release notes text + + + + + Parse "complex" release notes text sequence + + + + + Parse simple release notes sequence + + + + + Contains helpers which allow to parse Release Notes text files. Either "simple" or "complex" format is accepted. + + ## Formats + + ### Simple format + + * 1.1.10 - Support for heterogeneous XML attributes. Make CsvFile re-entrant. + * 1.1.9 - Infer booleans for ints that only manifest 0 and 1. + + ### Complex format + + ### New in 1.1.10 (Released 2013/09/12) + * Support for heterogeneous XML attributes. + * Make CsvFile re-entrant. + * Support for compressed HTTP responses. + * Fix JSON conversion of 0 and 1 to booleans. + + ### New in 1.1.9 (Released 2013/07/21) + * Infer booleans for ints that only manifest 0 and 1. + * Support for partially overriding the Schema in CsvProvider. + * PreferOptionals and SafeMode parameters for CsvProvider. + + ## Sample + + let release = + ReadFile "RELEASE_NOTES.md" + |> ReleaseNotesHelper.parseReleaseNotes + + + Target "AssemblyInfo" (fun _ -> + CreateFSharpAssemblyInfo "src/Common/AssemblyInfo.fs" + [ Attribute.Title project + Attribute.Product project + Attribute.Description summary + Attribute.Version release.AssemblyVersion + Attribute.FileVersion release.AssemblyVersion] + ) + + + + + A timeout for the test runner + + + + + Custom options to pass to Fixie runner + + + + + Working directory (optional) + + + + + FileName of the Fixie runner + + + + + Parameter type to configure the Fixie runner + + + + + This task to can be used to run [Fixie](http://patrick.lioi.net/fixie/) on test libraries. + ## Parameters + + - `setParams` - Function used to overwrite the Fixie default parameters. + - `assemblies` - The file names of the test assemblies. + + ## Sample + + !! (testDir @@ "Test.*.dll") + |> Fixie (fun p -> { p with CustomOptions = ["custom","1"; "test",2] }) + + + + + Fixie default parameters - tries to locate Fixie.Console.exe in any subfolder. + + + + + Contains tasks to run [Fixie](http://fixie.github.io/) unit tests. + + + + + NuSpec metadata type + + + + + Nuget parameter type + + + + + Build a symbol package using the nuspec file + + + + + Build a symbol package using a project file, if provided + + + + + Do not build symbol packages + + + + + Returns the dependencies from specified packages.config file + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + Default NuGet feed + + + + + Returns the NuGet meta data from the given package file name. + ## Parameters + + - `packageFileName` - The .nuspec package file name. + + + + + Parses nuspec metadata from a nuspec file. + ## Parameters + + - `nuspec` - The .nuspec file content. + + + + + Creates a new NuGet package, and optionally publishes it. + Template parameter substitution is performed when passing a .nuspec + ## Parameters + + - `setParams` - Function used to manipulate the default NuGet parameters. + - `nuspecOrProjectFile` - The .nuspec file name. + + + + + Publishes a NuGet package to the nuget server. + ## Parameters + + - `setParams` - Function used to manipulate the default NuGet parameters. + + + + + Creates a new NuGet package based on the given .nuspec or project file. + Template parameter substitution is performed when passing a .nuspec + ## Parameters + + - `setParams` - Function used to manipulate the default NuGet parameters. + - `nuspecOrProjectFile` - The .nuspec or project file name. + + + + + Creates a new NuGet package based on the given .nuspec or project file. + The .nuspec / projectfile is passed as-is (no templating is performed) + ## Parameters + + - `setParams` - Function used to manipulate the default NuGet parameters. + - `nuspecOrProjectFile` - The .nuspec or project file name. + + + + + push package to symbol server (and try again if something fails) + + + + + push package (and try again if something fails) + + + + + Creates a NuGet package without templating (including symbols package if enabled) + + + + + Gets the version no. for a given package in the deployments folder + + + + + Creates a string which tells NuGet that you require exactly this package version. + + + + + NuGet default parameters + + + + + Contains helper functions and task which allow to inspect, create and publish [NuGet](https://www.nuget.org/) packages. + There is also a tutorial about [nuget package creating](../create-nuget-package.html) available. + + + + + NuGet configuration file. Default `None`. + + + + + Do not prompt for user input or confirmations. Default `true`. + + + + + Allows updating to prerelease versions. Default `false`. + + + + + Show verbose output while updating. Default `false`. + + + + + Looks for updates with the highest version available within the same major and minor version as the installed package. Default `false`. + + + + + Folder to store packages in. Default `./packages`. + + + + + Version to update to. Default `None`. Used to upgrade/downgrade to a explicit version of a package. + + + + + Packages to update. Update all if empty. + + + + + Nuget feeds to search updates in. Use default if empty. + + + + + Number of retries if update fails. + + + + + Timeout for the update. + + + + + Path to the nuget.exe. + + + + + Nuget update parameters. + + + + + Update packages specified in the package file. + + Fails if packages are not installed; see [nuget bug](https://nuget.codeplex.com/workitem/3874). + Fails if packages file has no corresponding VS project; see [nuget bug](https://nuget.codeplex.com/workitem/3875). + ## Parameters + + - `setParams` - Function used to manipulate the default parameters. + - `packagesFile` - Path to the `*.sln`, `*.*proj` or `packages.config` file. + + + + + [omit] + + + + + Parameter default values. + + + + + Contains tasks for updating NuGet packages including assembly hint paths in the project files using the [nuget.exe update command](http://docs.nuget.org/docs/reference/command-line-reference#Update_Command). + + + + + NuGet configuration file. Default `None`. + + + + + Disable looking up packages from local machine cache. Default `false`. + + + + + Do not prompt for user input or confirmations. Default `true`. + + + + + Display this amount of details in the output: normal, quiet, detailed. Default `normal`. + + + + + Specifies the directory in which packages will be installed. Default `./packages/`. + + + + + Allows updating to prerelease versions. Default `false`. + + + + + If set, the destination directory will contain only the package name, not the version number. Default `false`. + + + + + The version of the package to install. + + + + + Nuget feeds to search updates in. Use default if empty. + + + + + Number of retries if update fails. + + + + + Timeout for the update. + + + + + Path to the nuget.exe. + + + + + Nuget install parameters. + + + + + Nuget install verbosity mode. + + + + + Installs the given package. + + ## Parameters + + - `setParams` - Function used to manipulate the default parameters. + - `packagesFile` - Path to the `*.sln`, `*.*proj` or `packages.config` file, or simply a NuGet package name + + + + + [omit] + + + + + [omit] + + + + + Parameter default values. + + + + + Contains tasks for installing NuGet packages using the [nuget.exe install command](http://docs.nuget.org/docs/reference/command-line-reference#Install_Command). + + + + + Default arguments to compute next NuGet version number + + + + + Arguments for the next NuGet version number computing + + + + + Compute next NuGet version number + + + + + Retrieve current NuGet version number + + + + + Increment major version + + + + + Increment minor version + + + + + Increment patch version + + + + + Replace binary for an existing build if one is found with the same name/bundle version + + + + + Notify permitted teammates to install the build + + + + + Distribution list names which will receive access to the build + + + + + iOS ONLY - the .dSYM corresponding to the build + + + + + Release notes for the build + + + + + (Required) file data for the build (.ipa or .apk) + + + + + (Required) Team token from testflightapp.com/dashboard/team/edit + + + + + (Required) API token from testflightapp.com/account/#api + + + + + The TestFlight parameter type. + + + + + Uploads the app build to TestFlight. + ## Parameters + - `setParams` - Function used to manipulate the default TestFlightParams value. + + + + + [omit] + + + + + [omit] + + + + + The default TestFlight upload parameters. + + + + + Contains tasks to upload apps to [TestFlight](http://testflightapp.com) + + + + + Additional Args + + + + + Optional outputh path + + + + + Optional version suffix. + + + + + Allows to test a specific runtime + + + + + Allows to publish to a specific framework + + + + + The build configuration. + + + + + Project (optional). + + + + + A timeout for the command. + + + + + Working directory (optional). + + + + + ToolPath - usually just "dotnet" + + + + + DotNet publish parameters + + + + + Additional Args + + + + + The build configuration. + + + + + A timeout for the command. + + + + + Working directory (optional). + + + + + Project (optional). + + + + + Optional version suffix. + + + + + Optional output path. + + + + + ToolPath - usually just "dotnet" + + + + + DotNet pack parameters + + + + + Additional Args + + + + + Allows to test a specific runtime + + + + + Allows to test a specific framework + + + + + The build configuration. + + + + + Project (optional). + + + + + A timeout for the command. + + + + + Working directory (optional). + + + + + ToolPath - usually just "dotnet" + + + + + DotNet test parameters + + + + + Optional outputh path + + + + + Additional Args + + + + + Allows to build for a specific runtime + + + + + Allows to build for a specific framework + + + + + The build configuration. + + + + + Project (optional). + + + + + A timeout for the command. + + + + + Working directory (optional). + + + + + ToolPath - usually just "dotnet" + + + + + DotNet build parameters + + + + + Additional Args + + + + + Whether to use the NuGet cache. + + + + + A timeout for the command. + + + + + Project (optional). + + + + + Working directory (optional). + + + + + ToolPath - usually just "dotnet" + + + + + DotNet restore parameters + + + + + A timeout for the command. + + + + + Working directory (optional). + + + + + ToolPath - usually just "dotnet" + + + + + DotNet parameters + + + + + Installs the DotNet SDK locally to the given path + + + + + Gets the DotNet SDK from the global.json + + + + + Sets version in project.json + + + + + Runs the dotnet "publish" command. + ## Parameters + + - `setPublishParams` - Function used to overwrite the publish default parameters. + + ## Sample + + DotNetCli.Publish + (fun p -> + { p with + Configuration = "Release" }) + + + + + Runs the dotnet "pack" command. + ## Parameters + + - `setPackParams` - Function used to overwrite the pack default parameters. + + ## Sample + + DotNetCli.Pack + (fun p -> + { p with + Configuration = "Release" }) + + + + + Runs the dotnet "test" command. + ## Parameters + + - `setTestParams` - Function used to overwrite the test default parameters. + + ## Sample + + DotNetCli.Test + (fun p -> + { p with + Configuration = "Release" }) + + + + + Runs the dotnet "build" command. + ## Parameters + + - `setBuildParams` - Function used to overwrite the build default parameters. + + ## Sample + + DotNetCli.Build + (fun p -> + { p with + Configuration = "Release" }) + + + + + Runs the dotnet "restore" command. + ## Parameters + + - `setRestoreParams` - Function used to overwrite the restore default parameters. + + ## Sample + + DotNetCli.Restore + (fun p -> + { p with + NoCache = true }) + + + + + Runs a dotnet command. + ## Parameters + + - `setCommandParams` - Function used to overwrite the default parameters. + - `args` - command and additional arguments. + + ## Sample + + DotNetCli.RunCommand + (fun p -> + { p with + TimeOut = TimeSpan.FromMinutes 10. }) + "restore" + + + + + Checks wether the dotnet CLI is installed + + + + + Gets the installed dotnet version + + + + + The dotnet command name + + + + + Contains a task which can be used to run dotnet CLI commands. + + + + + The dotCover parameter type for running coverage + + + + + Runs the dotCover "cover" command against the MSpec test runner. + ## Parameters + + - `setDotCoverParams` - Function used to overwrite the dotCover report default parameters. + - `setMSpecParams` - Function used to overwrite the MSpec default parameters. + + ## Sample + + !! (buildDir @@ buildMode @@ "/*.Unit.Tests.dll") + |> DotCoverMSpec + (fun dotCoverOptions -> { dotCoverOptions with + Output = artifactsDir @@ "MSpecDotCoverSnapshot.dcvr" }) + (fun mSpecOptions -> { mSpecOptions with + Silent = true }) + + + + + Runs the dotCover "cover" command against the MSTest test runner. + ## Parameters + + - `setDotCoverParams` - Function used to overwrite the dotCover report default parameters. + - `setMSTestParams` - Function used to overwrite the MSTest default parameters. + + ## Sample + + !! (buildDir @@ buildMode @@ "/*.Unit.Tests.dll") + |> MSTest + (fun -> dotCoverOptions ) + (fun MSTestOptions -> MSTestOptions) + + + + + Builds the command line arguments from the given parameter record and the given assemblies. + Runs all test assemblies in the same run for easier coverage management. + [omit] + + + + + Runs the dotCover "cover" command against the XUnit2 test runner. + ## Parameters + + - `setDotCoverParams` - Function used to overwrite the dotCover report default parameters. + - `setXUnit2Params` - Function used to overwrite the XUnit2 default parameters. + + ## Sample + + !! (buildDir @@ buildMode @@ "/*.Unit.Tests.dll") + |> DotCoverXUnit2 + (fun -> dotCoverOptions ) + (fun nUnitOptions -> nUnitOptions) + + + + + Runs the dotCover "cover" command against the NUnit test runner. + ## Parameters + + - `setDotCoverParams` - Function used to overwrite the dotCover report default parameters. + - `setNUnitParams` - Function used to overwrite the NUnit default parameters. + + ## Sample + + !! (buildDir @@ buildMode @@ "/*.Unit.Tests.dll") + |> DotCoverNUnit + (fun dotCoverOptions -> { dotCoverOptions with + Output = artifactsDir @@ "NUnitDotCoverSnapshot.dcvr" }) + (fun nUnitOptions -> { nUnitOptions with + DisableShadowCopy = true }) + + + + + Runs the dotCover "cover" command against the NUnit test runner. + ## Parameters + + - `setDotCoverParams` - Function used to overwrite the dotCover report default parameters. + - `setNUnitParams` - Function used to overwrite the NUnit default parameters. + + ## Sample + + !! (buildDir @@ buildMode @@ "/*.Unit.Tests.dll") + |> DotCoverNUnit + (fun dotCoverOptions -> { dotCoverOptions with + Output = artifactsDir @@ "NUnitDotCoverSnapshot.dcvr" }) + (fun nUnitOptions -> { nUnitOptions with + DisableShadowCopy = true }) + + + + + Runs the dotCover "report" command. This generates a report from a dotCover snapshot + ## Parameters + + - `setParams` - Function used to overwrite the dotCover report default parameters. + + ## Sample + + DotCoverReport (fun p -> { p with + Source = artifactsDir @@ "dotCoverSnapshot.dcvr" + Output = artifactsDir @@ "dotCoverReport.xml" + ReportType = DotCoverReportType.Xml }) + + + + + Runs the dotCover "merge" command. This combines dotCover snaphots into a single + snapshot, enabling you to merge test coverage from multiple test running frameworks + ## Parameters + + - `setParams` - Function used to overwrite the dotCover merge default parameters. + + ## Sample + + DotCoverMerge (fun p -> { p with + Source = [artifactsDir @@ "NUnitDotCoverSnapshot.dcvr" + artifactsDir @@ "MSpecDotCoverSnapshot.dcvr"] + Output = artifactsDir @@ "dotCoverSnapshot.dcvr" }) + + + + + Runs the dotCover "cover" command, using a target executable (such as NUnit or MSpec) and generates a snapshot file. + + ## Parameters + + - `setParams` - Function used to overwrite the dotCover default parameters. + + + + + The dotCover default parameters + + + + + Contains a task which can be used to run [DotCover](http://www.jetbrains.com/dotcover/) on .NET assemblies. + + + + + Paket restore packages type + + + + + Paket push parameter type + + + + + Paket pack parameter type + + + + + Restores all packages referenced in either a paket.dependencies or a paket.references file using Paket + ## Parameters + + - `setParams` - Function used to manipulate the default parameters. + + + + + Returns the dependencies from specified paket.references file + + + + + Pushes all NuGet packages in the working dir to the server by using Paket push. + ## Parameters + + - `setParams` - Function used to manipulate the default parameters. + + + + + Pushes the given NuGet packages to the server by using Paket push. + ## Parameters + + - `setParams` - Function used to manipulate the default parameters. + - `files` - The files to be pushed to the server. + + + + + Creates a new NuGet package by using Paket pack on all paket.template files in the working directory. + ## Parameters + + - `setParams` - Function used to manipulate the default parameters. + + + + + Paket restore default parameters + + + + + Paket push default parameters + + + + + Paket pack default parameters + + + + + Contains helper functions and task which allow to inspect, create and publish [NuGet](https://www.nuget.org/) packages with [Paket](http://fsprojects.github.io/Paket/index.html). + + + + + With the `IncludePDBs` switch you can tell `paket` to pack pdbs into the package. + this only works for paket.template files of type 'Project'. + + + + + If set to `true` this will tell `nuget`/`paket` that this is a development dependency + + + + + If set to `true` this will tell `nuget`/`paket` to prompt the user for + the acceptance of the provided license + + + + + A list of excluded dependencies + + + + + A list of dependencies to other packages + + + + + A list of referenced framework assemblies + if omitted all used Framework assemblies will be used by `paket` + + + + + A list of references + + + + + The included or excluded files (use this if the `TemplateType` is `File`) + + + + + a list of tags + + + + + the copyright information + + + + + URL to an icon + + + + + URL to the where the project of the package is hosted + + + + + URL to the license of the package + + + + + The package language + + + + + a short summary (line by line) + + + + + the release notes (line by line) + + + + + A list of package owners + + + + + a list of authors for the nuget package. + If omitted, `paket`will use reflection to obtain the value of the `AssemblyCompanyAttribute`. + + + + + The title of the package + If omitted, `paket` will use reflection to obtain the value of the `AssemblyTitleAttribute`. + + + + + The package description + If omitted, `paket` will use reflection to obtain the value of the `AssemblyDescriptionAttribute`. + + + + + The package version. + If omitted, `paket` will use reflection to obtain the value of the `AssemblyInformationalVersionAttribute` or if that is missing the `AssemblyVersionAttribute`. + + + + + The NuGet Package ID + If omitted, `paket` will use reflection to determine the assembly name. + + + + + The type of the template (`File` or `Project`) + + + + + The file path to the `paket.template` file + if omitted, a `paket.template` file will be created in the current directory + + + + + Contains the different parameters to create a paket.template file + + + + + no explicit version + + + + + For example >= 2.0 + + + + + For example ~> 2.0 + + + + + Use the currently locked version as dependency + + + + + Use the currently loaded version as dependency + + + + + A specific version string + + + + + Explicitely exclude a file + + + + + Include a file and store it into a targed + + + + + Creates a paket.template file with the given filename + Will fail if the file could not be written + + ## Parameters + - `setParams` - Function used to manipulate the default `PaketTemplateParams` value + + ## Sample usage + + Target "Create Paket Template" (fun _ -> + PaketTemplate (fun p -> + { p with + TemplateFilePath = Some "./deploytemp/paket.template" + Id = Some "My.New.Package" + Version = Some "0.0.1-alpha" + Authors = ["Me"; "You"; "Someone Other"] + Files = [ Include ("./**/*.dll", "/lib/dlls") + Exclude "./Foo/bar.dll" + Include ("./*.jpg", "/images") ] + Dependencies = [ "Paket1.FOO", AnyVersion + "Paket2.BAR", GreaterOrEqual CURRENTVERSION + "Paket3.BAZ", GreaterOrEqualSafe LOCKEDVERSION + "Paket4.BOO", GreaterOrEqual (Version "1.2.3") ] + } + ) + ) + + + + + The default parameters for the generation of the `paket.template` + + ## Defaults + + - TemplateFilePath - `None` + - TemplateType - `Project` + - Id - `None` + - Version - `None` + - Description - `None` + - Title - `None` + - Authors - `Empty list` + - Owners - `Empty list` + - ReleaseNotes - `Empty list` + - Summary - `Empty list` + - Language - `None` + - LicenseUrl - `None` + - ProjectUrl - `None` + - IconUrl - `None` + - Copyright - `None` + - Tags - `Empty list` + - Files - `Empty list` + - References - `Empty list` + - FrameworkAssemblies - `Empty list` + - Dependencies - `Empty list` + - ExcludedDependencies - `Empty list` + - RequireLicenseAcceptance - `None` + - DevelopmentDependency - `None` + - IncludePDBs - `None` + + + + + Contains helper functions and task which allow it to generate a paket.template + file for [Paket](http://fsprojects.github.io/Paket/index.html) + + + + + A type for the controlling parameter + + + + + Resets the devstore (BLOB, Queues and Tables) + + + + + Starts the compute emulator + + + + + Stops the compute emulator + + + + + Starts the storage emulator + + + + + Stops the storage emulator + + + + + The default parameters for Azure emulators + + + + + Contains tasks to control the local Azure Emulator + + + + + Deletes a single folder from remote FTP folder. + ## Parameters + - `destPath` - The full path to the folder which needs to be deleted, including all its parent folders + - `server` - FTP Server name (ex: "ftp://10.100.200.300:21/") + - `user` - FTP Server login name (ex: "joebloggs") + - `pwd` - FTP Server login password (ex: "J0Eblogg5") + + + + + Deletes a single file from remote FTP folder. + ## Parameters + - `destPath` - The full path to the file which needs to be deleted, including all its parent folders + - `server` - FTP Server name (ex: "ftp://10.100.200.300:21/") + - `user` - FTP Server login name (ex: "joebloggs") + - `pwd` - FTP Server login password (ex: "J0Eblogg5") + + + + + Uploads a given local folder to a given root dir on a FTP server. + ## Parameters + - `srcPath` - The local server path from which files need to be uploaded + - `rootDir` - The remote root dir where files need to be uploaded, leave this as empty, if files need to be uploaded to root dir of FTP server + - `server` - FTP Server name (ex: "ftp://10.100.200.300:21/") + - `user` - FTP Server login name (ex: "joebloggs") + - `pwd` - FTP Server login password (ex: "J0Eblogg5") + + + + + Creates a matching folder in FTP folder, if not already present. + ## Parameters + - `destPath` - The full name of folder which needs to be created, including all its parent folders + - `server` - FTP Server name (ex: "ftp://10.100.200.300:21/") + - `user` - FTP Server login name (ex: "joebloggs") + - `pwd` - FTP Server login password (ex: "J0Eblogg5") + + + + + Given a folder path, will check if that folder is present at a given root directory of a FTP server. + ## Parameters + - `destPath` - The full name of folder which needs to be checked for existance, including all its parent folders + - `server` - FTP Server name (ex: "ftp://10.100.200.300:21/") + - `user` - FTP Server login name (ex: "joebloggs") + - `pwd` - FTP Server login password (ex: "J0Eblogg5") + + + + + Given a folder name, will check if that folder is present at a given root directory of a FTP server. + ## Parameters + - `server` - FTP Server name (ex: "ftp://10.100.200.300:21/") + - `user` - FTP Server login name (ex: "joebloggs") + - `pwd` - FTP Server login password (ex: "J0Eblogg5") + + + + + Uploads a single file from local directory into remote FTP folder. + ## Parameters + - `destPath` - The full local file path that needs to be uploaded + - `srcPath` - The full path to file which needs to be created, including all its parent folders + - `server` - FTP Server name (ex: "ftp://10.100.200.300:21/") + - `user` - FTP Server login name (ex: "joebloggs") + - `pwd` - FTP Server login password (ex: "J0Eblogg5") + + + + + Gets the contents/listing of files and folders in a given FTP server folder + ## Parameters + - `dirPath` - The full name of folder whose content need to be listed + - `server` - FTP Server name (ex: "ftp://10.100.200.300:21/") + - `user` - FTP Server login name (ex: "joebloggs") + - `pwd` - FTP Server login password (ex: "J0Eblogg5") + + + + + Checks to see if the `ftp content` string containts the string `Given_Folder_Name` + + + + +Partial validation for folder name, based on http://msdn.microsoft.com/en-us/library/aa365247.aspx + + + + + Writes given byte array into the given stream + + + + + Gets a connection to the FTP server + + + + + Contains helpers which allow to upload a whole folder/specific file into a FTP Server. + Uses `Passive Mode` FTP and handles all files as binary (and not ASCII). + Assumes direct network connectivity to destination FTP server (not via a proxy). + Does not support FTPS and SFTP. + + + + + Specifies the timeout for the TypeScript compiler. + + + + + Specifies the TypeScript compiler output path. + + + + + Specifies the TypeScript compiler path. + + + + + Specifies if the TypeScript compiler should remove comments. Default is false. + + + + + Specifies if the TypeScript compiler should not use libs. Default is false. + + + + + Specifies if the TypeScript compiler should emit source maps. Default is false. + + + + + Specifies which JavaScript module type the TypeScript compiler should generate. Default is CommonJs. + + + + + Specifies if the TypeScript compiler should generate declarations. Default is false. + + + + + Specifies if the TypeScript compiler should generate a single output file and its filename. + + + + + Specifies if the TypeScript compiler should generate comments. Default is false. + + + + + Specifies which ECMAScript version the TypeScript compiler should generate. Default is ES3. + + + + + TypeScript task parameter type + + + + + Generated JavaScript module type + + + + + Generated ECMAScript version + + + + + This task to can be used to call the [TypeScript](http://www.typescriptlang.org/) compiler. + There is also a [tutorial](../typescript.html) for this task available. + ## Parameters + + - `setParams` - Function used to overwrite the TypeScript compiler flags. + - `files` - The type script files to compile. + + ## Sample + + !! "src/**/*.ts" + |> TypeScriptCompiler (fun p -> { p with TimeOut = TimeSpan.MaxValue }) + + + + + Default parameters for the TypeScript task + + + + + Contains code to call the typescript compiler. There is also a [tutorial](../typescript.html) for this task available. + + + + + This options is used to add additional optional arguments, could be somthing like "-returntargetcode " + + + + + This option is used to merge the coverage results for an assembly regardless of where it was loaded + assuming the assembly has the same file-hash in each location. + + + + + The directory where the OpenCover process will be started. + + + + + The timeout for the OpenCover process. + + + + + A list of filters to apply to selectively include or exclude assemblies and classes from coverage results. + + + + + Use this to register and de-register the code coverage profiler. + + + + + The location and name of the output xml file. + If no value is supplied then the current directory + will be used and the output filename will be results.xml. + + + + + (Required) Path to the NUnit/XUnit console runner + + + + + (Required) Path to the OpenCover console application + + + + + OpenCover parameters, for more details see: https://github.com/OpenCover/opencover/wiki/Usage#console-application-usage. + + + + + Runs OpenCover on a group of assemblies. + ## Parameters + + - `setParams` - Function used to overwrite the default OpenCover parameters. + - `targetArgs` - Test runner arguments. + + ## Sample + + OpenCover (fun p -> { p with TestRunnerExePath = "./Tools/NUnit/nunit-console.exe" }) + "project-file.nunit /config:Release /noshadow /xml:artifacts/nunit.xml /framework:net-4.0" + + + + + Builds the command line arguments from the given parameter record + [omit] + + + + + OpenCover default parameters + + + + + Contains a task which can be used to run [OpenCover](https://github.com/sawilde/opencover) on .NET assemblies. + + + + + The timeout for the ReportGenerator process. + + + + + The directory where the ReportGenerator process will be started. + + + + + The verbosity level of the log messages. + + + + + Optional list of assemblies that should be included or excluded + in the report. Exclusion filters take precedence over inclusion + filters. Wildcards are allowed. + + + + + Optional directory for storing persistent coverage information. + Can be used in future reports to show coverage evolution. + + + + + Optional directories which contain the corresponding source code. + + + + + The output formats and scope. + + + + + (Required) The directory where the generated report should be saved. + + + + + (Required) Path to the ReportGenerator exe file. + + + + + ReportGenerator parameters, for more details see: https://github.com/danielpalme/ReportGenerator. + + + + + Runs ReportGenerator on one or more coverage reports. + ## Parameters + + - `setParams` - Function used to overwrite the default ReportGenerator parameters. + - `reports` - Coverage reports. + + ## Sample + + ReportGenerator (fun p -> { p with TargetDir = "c:/reports/" }) [ "c:/opencover.xml" ] + + + + + Builds the report generator command line arguments from the given parameters and reports + [omit] + + + + + ReportGenerator default parameters + + + + + Contains a task which can be used to run [ReportGenerator](https://github.com/danielpalme/ReportGenerator), + which converts XML reports generated by PartCover, OpenCover or NCover into a readable report in various formats. + + + + + The schema where RH stores it's tables + + + + + A timeout for the runner. + + + + + Working directory (optional). + + + + + FileName of the Roundhouse runner. + + + + + Instructs RH to execute changed one time scripts (DDL/DML in Up folder) that have previously been run against the database instead of failing. A warning is logged for each one time scripts that is rerun. + + + + + The name of the folder where you keep your permissions scripts. + + + + + The name of the folder where you keep scripts that will be run after all of the other any time scripts complete. + + + + + The name of the folder where you keep your indexes. + + + + + The name of the folder where you keep your stored procedures. + + + + + The name of the folder where you keep your views. + + + + + The name of the folder where you keep your functions. + + + + + The name of the folder where you keep any functions, views, or sprocs that are order dependent. If you have a function that depends on a view, you definitely need the view in this folder. + + + + + The name of the folder where you keep your update scripts. + + + + + The name of the folder where you keep scripts that you want to run before your update scripts. + + + + + The name of the folder where you will keep scripts that ONLY run after a database is created. + + + + + The name of the folder where you keep your alter database scripts. Read up on token replacement. You will want to use {{DatabaseName}} here instead of specifying a database name. + + + + + Tells RH not to ask for any input when it runs. + + + + + This instructs RH to do a restore (with the restorefrompath parameter) of a database before running migration scripts. + + + + + This instructs RH to run inside of a transaction. + + + + + This instructs RH to set the database recovery mode to simple recovery. Only works with SqlServer. + + + + + This instructs RH to remove a database and not run migration scripts. + + + + + File path of back when Restore is set to true + + + + + This instructs RH to use this script for creating a database instead of the default based on the SQLType. + + + + + This allows RH to be environment aware and only run scripts that are in a particular environment based on the namingof the script. LOCAL.something**.ENV.**sql would only be run in the LOCAL environment. + + + + + Path to code repository to be able to correlate versions + + + + + Works in conjunction with an XML version file. + + + + + Path to the file to use for versioning. Either a .XML file, a .DLL or a .TXT file that a version can be resolved from. + + + + + Output path. Path to where migration artifacts are stored. + + + + + Database Type (fully qualified class name implementing [roundhouse.sql.Database, roundhouse]) + + + + + This is the timeout when administration commands are run (except for restore, which has its own). + + + + + This is the timeout when commands are run. This is not for admin commands or restore. + + + + + This is used for connecting to master when you may have a different uid and password than normal. + + + + + As an alternative to ServerName and Database - You can provide an entire connection string instead. + + + + + The server and instance you would like to run on. (local) and (local)\SQL2008 are both valid values. + + + + + The directory where your SQL scripts are. + + + + + The database you want to create/migrate. + + + + + Parameter type to configure the RoundhousE runner + + + + + This task to can be used to run [RoundhousE](http://projectroundhouse.org/) for database migrations. + ## Parameters + + - `setParams` - Function used to overwrite the Roundhouse default parameters. + + ## Sample + + Roundhouse (fun p -> { p with + SqlFilesDirectory = ".\database" + ServerDatabase = "(local)" + DatabaseName = "atxc" + WarnOnOneTimeScriptChanges = true }) + + + + + + Roundhouse default parameters - tries to locate rh.exe in any subfolder. + + + + + Contains tasks to run [RoundhousE](http://projectroundhouse.org/) database migrations. + + + + + Emit debug information in quotations + + + + + Specify target framework profile of this assembly. + + + + + Specifies the version of the OS subsystem to be used by the generated executable. + Use 6.02 for Windows 8, 6.01 for Windows 7, 6.00 for Windows Vista. + This option only applies to executables, not DLL and need only be used if your application + depends on specific security features available only on certain versions of the OS + + + + + Enable high-entropy ASLR + + + + + Resolve assembly references using directory-based rules rather than MSBuild resolution + + + + + Name the output debug file + + + + + Statically link the given assembly and all referenced DLLs that depend on this assembly. + Use an assembly name e.g. mylib, not a DLL name. + + + + + Statically link the F# library and all referenced DLLs + that depend on it into the assembly being generated + + + + + Do not reference the default CLI assemblies by default + + + + + Base address for the library to be built + + + + + Specify a directory for the include path which is used to resolve source files and assemblies + + + + + Output messages with fully qualified paths + + + + + Output messages in UTF-8 encoding + + + + + Displays timing information for compilation. + + + + + Specify the codepage used to read source files + + + + + Display the commandline flags and their usage + + + + + Suppress compiler copyright message + + + + + Ignore ML compatibility warnings + + + + + Define a list of conditional compilation symbols + + + + + Define a conditional compilation symbols + + + + + Generate overflow checks + + + + + Output warning and error messages in color + + + + + Enable specific warnings that may be off by default + + + + + Disable specific warning messages + + + + + Set a warning level (0-5) + + + + + Report specific warnings as errors + + + + + Report all warnings as errors + + + + + Enable or disable cross-module optimizations + + + + + Enable or disable tailcalls + + + + + Enable optimizations + + + + + Specify debugging type: full, pdbonly. + ('full' is the default and enables attaching a debugger to a running program). + + + + + Emit debug information + + + + + Link the specified resource to this assembly + + + + + Embed the specified managed resource + + + + + Do not include the default Win32 manifest + + + + + Specify a Win32 manifest file + + + + + Specify a Win32 resource file (.res) + + + + + Reference assemblies in the order listed + + + + + Reference an assembly + + + + + Print the inferred interface of the assembly to a file + + + + + Don't add a resource to the generated assembly containing F#-specific metadata + + + + + Only include optimization information essential for implementing inlined constructs. + Inhibits cross-module inlining but improves binary compatibility. + + + + + Limit which platforms the compiled code can run on: + + + + + Specify a strong name key container + + + + + Specify a strong name key file + + + + + Write the xmldoc of the assembly to the given file + + + + + Delay-sign the assembly using only the public portion of the strong name key + + + + + The 'fsc.exe' output target types : exe, winexe, library, module + + + + + Name of the output file + + + + + Specified path of a managed resource with an optional name alias and accessiblity flag + resinfo format is <file>[,<stringname>[,public|private]] + e.g. `resource.dat,rezName,public` + + + + + Optimization options that can be disabled or enabled selectively by listing them + with the optimize compiler flag + + + + + Used to set the Accessiblity of an embeded or linked resource + + + + + Specify target framework profile of this assembly. + Valid values are mscorlib or netcore. Default - mscorlib + + + + + Specify debugging type: full, pdbonly. + ('full' is the default and enables attaching a debugger to a running program). + + + + + Limit which platforms the compiled code can run on: + x86, Itanium, x64, anycpu32bitpreferred, or anycpu. + The default is anycpu. + + + + + Build a module that can be added to another assembly (.netmodule) + + + + + Build a library + + + + + Build a Windows executable + + + + + Build a console executable + + + + + Specifies other params for the compilation. Freeform strings. + + + + + Specifies whether to emit debug information (default is false). + + + + + Specifies files to reference for the compilation. + + + + + Specifies the compiled artifact target platform. + + + + + Specifies the compiled artifact target type. + + + + + Specifies the output file name and path. + + + + + The default parameters to the compiler service. + + + + + 'fsc.exe' command line parameters + + + + + The 'fsc.exe' output platforms + + + + + The 'fsc.exe' output target types + + + + + Compiles one or more F# source files with the specified parameters. + ## Parameters + + - `setParams` - Function used to overwrite the default Fsc parameters. + - `inputFiles` - The F# input files. + + ## Sample + + ["file1.fs"; "file2.fs"] + |> Compile [Out "" + Target Exe + Platform AnyCpu + References [] + Debug false + ] + + + + + Compiles the given F# source files with the specified parameters. + + ## Parameters + + - `setParams` - Function used to overwrite the default Fsc parameters. + - `inputFiles` - The F# input files. + + ## Returns + + The exit status code of the compile process. + + ## Sample + + ["file1.fs"; "file2.fs"] + |> compile [Out "" + Target Exe + Platform AnyCpu + References [] + Debug false + ] + + + + + Compiles the given source file with the given options. If no options + given (i.e. the second argument is an empty list), by default tries + to behave the same way as would the command-line 'fsc.exe' tool. + + + + + Compiles one or more F# source files with the specified parameters. + ## Parameters + + - `setParams` - Function used to overwrite the default Fsc parameters. + - `inputFiles` - The F# input files. + + ## Sample + + ["file1.fs"; "file2.fs"] + |> Fsc (fun parameters -> + { parameters with Output = ... + FscTarget = ... + ... }) + + + + + Compiles the given F# source files with the specified parameters. + + ## Parameters + + - `setParams` - Function used to overwrite the default Fsc parameters. + - `inputFiles` - The F# input files. + + ## Returns + + The exit status code of the compile process. + + ## Sample + + ["file1.fs"; "file2.fs"] + |> fsc (fun parameters -> + { parameters with Output = ... + FscTarget = ... + ... }) + + + + + Compiles the given source file with the given options. If no options + given (i.e. the second argument is an empty list), by default tries + to behave the same way as would the command-line 'fsc.exe' tool. + + + + + Contains tasks to compiles F# source file with the [FSharp.Compiler.Service](https://github.com/fsharp/FSharp.Compiler.Service). + There is also a tutorial about the [F# compiler tasks](../fsc.html) available. + + + + + Specifies other params for the compilation. Freeform strings. + + + + + Specifies whether to emit debug information (default is false). + + + + + Specifies assemblies to reference for the compilation. + + + + + Specifies the compiled artifact target platform. + + + + + Specifies the compiled artifact target type. + + + + + Specifies the tool path to csc.exe. + + + + + Specifies the output file name and path. + + + + + The default parameters to the compiler. + + + + + Compiler parameters + + + + + Supported platforms + + + + + Supported output types + + + + + Compiles one or more C# source files with the specified parameters. + ## Parameters + + - `setParams` - Function used to overwrite the default CSC parameters. + - `inputFiles` - The C# input files. + + ## Sample + + ["file1.cs"; "file2.cs"] + |> Csc (fun parameters -> + { parameters with Output = ... + Target = ... + ... }) + + + + + Compiles the given C# source files with the specified parameters. + + ## Parameters + + - `setParams` - Function used to overwrite the default CSC parameters. + - `inputFiles` - The C# input files. + + ## Returns + + The exit status code of the compile process. + + ## Sample + + ["file1.cs"; "file2.cs"] + |> csc (fun parameters -> + { parameters with Output = ... + Target = ... + ... }) + + + + + Contains tasks to compile C# source files with CSC.EXE (C# Compiler). + + + + + The background color for the message, which can be yellow, red, green, purple, gray, or random. Default value: yellow + + + + + Whether or not this message should trigger a notification for people in the room. Default value: false + + + + + The message format, which can either be text or html. Default value: text + + + + + (Required) The message body + + + + + (Required) Name the message will appear to be sent from + + + + + (Required) ID or name of the room to send the notification to + + + + + (Required) Auth token from HipChat + + + + + The HipChat notification paramater type + + + + + Sends a notification to a HipChat room + ## Parameters + - `setParams` - Function used to override the default notification parameters + + + + + [omit] + + + + + The default HipChat notification parameters + + + + + Contains a task to send notification messages to a [HipChat](https://www.hipchat.com/) room + + + + + Integrates XDT logging into FAKE logging. + + + + + Modifies XML files in place using an XDT file named by inserting a .configName in between each filename and .extension. + + + + + Modifies an XML file in place using an XDT file named by inserting a .configName in between the filename and .extension. + + + + + Reads XML file (typically a config file), makes changes according to XDT transform syntax, saves result. + + + + + Contains functions used to transform config (or any XML) files using Microsoft's XML Document Transformations. + + + + + When uploading a build, specify to which version (hockeyapp version id) + + + + + Set to your App Id (required for UWP apps targeting windows phone) + + + + + Set maximum upload delay + + + + + Restrict download to specific teams + + + + + Release download status (can only be set with full-access tokens) + + + + + Set to your source repository + + + + + Set to the URL of the build job on your build server + + + + + Set to the git commit sha for this build + + + + + Set to true to enable the private download page (default is false) + + + + + Set version as mandatory + + + + + Set the notify option + + + + + Set the owner of the app + + + + + Set the release type of the app + + + + + Release notes type for the build + + + + + Release notes for the build + + + + + file data for dsym (IOS: *.dysm.zip or Android: mapping.txt) + + + + + (Required) file data for the build (.ipa or .apk) + + + + + (Required) API token + + + + + The HockeyApp parameter type + Based on http://support.hockeyapp.net/kb/api/api-apps#upload-app + + + + + Set maximum upload delay + + + + + Human readable version + + + + + Set to your App Id (required for UWP apps targeting windows phone) + + + + + (Required) API token + + + + + The HockeyAppVersion parameter type + Based on https://support.hockeyapp.net/kb/api/api-versions#create-version + + + + + Set maximum upload delay + + + + + Set to your App Id (required for UWP apps targeting windows phone) + + + + + (Required) API token + + + + + HockeyAppVersion's success response + https://support.hockeyapp.net/kb/api/api-versions#create-version + + + + + HockeyApp's success response + + + + + The release download status + + + + + The mandatory options + + + + + The note types + + + + + The notification options + + + + + The release type of the app + + + + + Create a new version of an app on HockeyApp + ## Parameters + - `setParams` - Function used to override the default parameters + + ## Sample + + HockeyAppVersions (fun defaults -> + {defaults with + AppId = ... + ApiToken = ... + Version = ... + ... + }) + + + + + Uploads an app to HockeyApp + ## Parameters + - `setParams` - Function used to override the default parameters + + ## Sample + + HockeyApp (fun defaults -> + {defaults with + AppId = ... + ApiToken = ... + ... + }) + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + The default HockeyAppVersion parameters to create a version + + + + + The default HockeyApp parameters to upload a build + + + + + Contains tasks to interact with [HockeyApp](http://hockeyapp.com) + + + + + Failed to find all reguired data + Includes an error message + + + + + Found all required data + Includes structured assembly data + + + + + Represents status of attempted parsing + of IL file created from executing `ildasm.exe` + on a binary + + + + + Dependent `.NET` assemblies of the executable + + + + + Version of the executable + + + + + Path of the executable binary file + + + + + Represents an executable to create an _application manifest_ for + + + + + Guid from the `System.Runtime.Interopservice.GuidAttribute` of the assembly + + + + + Assembly version + + + + + Path to the assembly file + + + + + Assembly name + + + + + Represents a `.NET` assembly that may be used in COM interop projects + + + + + Creates and adds _application interop side-by-side manifests_ to provided executables + + ## Parameters + - `workingdir` - somewhere to put any temporary files + - `applications` - Metadata about executables to create manifests for. + + + + + Gets `name`, `path', `version` and interop `Guid` for those of the provided assemblies that have + all of the required information. + + ## Parameters + - `workingDir` - Somewhere to put temporary files + - `assemblies` - assemblies to get data from + + ## Purpose + + In order to create _application_ interop side-by-side manifests we need to know some metadata + about the assemblies that may be referenced from COM executables. + For the manifest we need the _assembly version_ and _ assembly name_. And in addition to that + the interop _guid_ is collected so we can determine if the assembly is referenced by _vb6 projects_ + + ## Process + + This function is a _hack_. To avoid using reflection and loading all potential assemblies into the + appdomain (with all the possible problems that may cause). I wanted to get this metadata by other means. + I ended up using the windows sdk dissasembler `ildasm.exe` (ref: https://msdn.microsoft.com/en-us/library/f7dy01k1(v=vs.110).aspx) + to create the smallest dissasembly I could (Really only need the manifest part), and the parse the IL file to get the metadata + (If anyone knows a cleaner / better way, pls improve on the code) + + + + + Created and embeds assembly Side-by-side interop manifests for provided assemblies + + ## Parameters + - `workingDir` - somewhere to put any temp files created + - `assemblies` - .net assemblies to create manifests for + + ## Process + + This function will use `mt.exe` (ref: https://msdn.microsoft.com/en-us/library/aa375649(v=vs.85).aspx) + to create a manifest for each assembly. This created manifest is unfortunately _not_ a valid + interop Side-by-Side manifest, but it has the important `clrClass` elements, + `version` and `name`info that would be the most + difficult to create through other means. + The important info is then put into a valid base manifest and embedded into the assembly as a resource. + + + + + Embeds a manifest file in a binary using `mt.exe` + + + + + create XName from string __without__ manifest namespace + + + + + create XName from string with manifest namepace + + + + + XLM namespace of manifest files + + + + + Path to `ildasm.exe + .net fx dissasembly tool + ref: https://msdn.microsoft.com/en-us/library/f7dy01k1(v=vs.110).aspx + + + + + Path to `mt.exe` + ref: https://msdn.microsoft.com/en-us/library/aa375649(v=vs.85).aspx + + + + + Module that enables creating and embedding Side-by-Side interop + manifests for registration free deployment of Com-.net interop projects + + + + + All references and components used + in this VBV6 project + + + + + Version of the project + in Major.Minor.Revision.Patch format + + + + + Name of binary that will + be generated from this project + + + + + Path to the Propject file representing + Representing this project + + + + + Represents a VB6 project + + + + + Represents a VB6 Reference + + + + + Represents the version of a VB6 reference + References from VB6 projects only care about Major.Minor versions + + + + + Represents the version of a VB6 project + `ToString ()` will return a Maj.Min.Rev.Patch version string + + + + + Maximum amount of time the entire build is allowed to take + + + + + Directory to put logs and other temporary files + created during the build process + + + + + Directory to put generated binaries + + + + + Path to the VB6 executable + + + + + Parameters for running a VB6 build + + + + + Fixes dependency versions in VB6 project files + + ## Paramteters + - `getConfig`- function to alter default VB6 build parameters + - `vb6Projects` - Paths to all `.vbp` to update references in + - `possibleAssemblies` - Paths to assemblies that may be referenced by the VB6 projects + + Running this task will: + + 1. In all VB6 projects provided: Get all references that intersects with the provided assemblies arg + 2. Check if there is a version difference + 3. Update the VB6 project file to reflect the actual version used. + + Note: Vb6 Reference versions are __hex numbers__ not decimals like .net verions. This task handles + this difference automatically. + + + + + All-In-one build and manifest function for VB6 __applications__ referencing .net __libraries__ + + ## Paramteters + - `getConfig`- function to alter default VB6 build parameters + - `vb6Projects` - Paths to all `.vbp` files to build + - `possibleAssemblies` - Paths to assemblies that may be referenced by the VB6 projects + + ## Process + + This function will: + + 1. Determine which of the `possibleAssemnblies` are referenced by any of the provided `.vbp` files + 2. Temporarily register any referenced assemblies using `RegAsm /codebase /tlb` + 3. Run VB6 command line make on all provided `.vbp` projects + 4. Unregister all registered assemblies + 5. Generate and embed Side-By-Side interop appplication manifests in all generated VB6 executables + 6. Generate and embed Side-By-Side interop assembly manifest in all referenced assemblies + + + + + Determins which of the provided assemblies are referenced by the + provided VB6 projects, and __un-registers__ them + + ## Paramteters + - `getConfig`- function to alter default VB6 build parameters + - `vb6Projects` - Paths to all `.vbp` files to build + - `possibleAssemblies` - Paths to assemblies that may be referenced by the VB6 projects + + + + + Determines which of the provided assemblies are referenced by the + provided VB6 projects, and registers them so the VB6 ide can + find them. + + ## Paramteters + - `getConfig`- function to alter default VB6 build parameters + - `vb6Projects` - Paths to all `.vbp` files to build + - `possibleAssemblies` - Paths to assemblies that may be referenced by the VB6 projects + + + + + Returns application details for provided `.vbp` files. + + ## Information returned + - Name of created binary file + - Version as saved in `.vbp`file + - GUIDs of all referenced libraries and components + + ## Usage + + This is used for creating Side-By-Side interop manifests. + + + + + Executes a VB6 command line make on all provided VB6 projects + + Builds will be executed in paralell + + ## Parameters + - `getConfig` - function to modify the build params record from default values + - `vb6Projects`- `Seq` of paths to `.vbp` files to build + + + + + Helper methods for working with Vb6 project files + + + + + Enables building of Visual Basic 6 projects + Also includes a do-it-all function that will embed interop + side-by-side manifest to executables from Vb6 using + functions from the Side-by-side helper module + + + + + Watches the for changes in the matching files. + Returns an IDisposable which allows to dispose all FileSystemWatchers. + + ## Parameters + - `onChange` - function to call when a change is detected. + - `fileIncludes` - The glob pattern for files to watch for changes. + + ## Sample + + Target "Watch" (fun _ -> + use watcher = !! "c:/projects/watchDir/*.txt" |> WatchChanges (fun changes -> + // do something + ) + + System.Console.ReadLine() |> ignore + + watcher.Dispose() // if you need to cleanup the watches. + ) + + + + + + This module contains helpers to react to file system events. + + + + + A character string containing additional arguments to give to CMake. + + + + + The CMake execution timeout. + + + + + The build configuration to use (e.g. `Release`). + Equivalent to the `--config <cfg>` option. + Not supported by every generator. + + + + + The CMake target to build instead of the default one. + Equivalent to the `--target <target>` option. + + + + + The binary build directory where CMake will generate the files. + + + + + The location of the CMake executable. Automatically found if null or empty. + + + + + The CMakeBuild parameter type. + + + + + A character string containing additional arguments to give to CMake. + + + + + The CMake execution timeout. + + + + + Remove matching entries from CMake cache. + Equivalent to the `-U <globbing_expr>` options. + + + + + A list of every variable to pass as a CMake argument. + Equivalent to the `-D <var>:<type>=<value>` options. + + + + + The directory where CMake will install the generated files. + Equivalent to the `-D CMAKE_INSTALL_PREFIX:DIRPATH="<install-directory>"` CMake option. + + + + + A list of the optional CMake cache files to load. + Equivalent to the `-C <initial-cache>` options. + + + + + An optional CMake platform. + Equivalent to the `-A <platform-name>` option. + Not supported by every generator. + + + + + An optional toolset (!= toolchain) to use. + Equivalent to the `-T <toolset-name>` option. + Not supported by every generator. + + + + + The native build system generator to use for writing the files. + See `cmake --help` for a list of the available entries. + *To avoid unpredictable generator usage, it is recommended to define it.* + Equivalent to the `-G <generator-name>` option. + + + + + An optional toolchain file to load. + Equivalent to the `-D CMAKE_TOOLCHAIN_FILE:FILEPATH="<toolchain-file>"` CMake option. + + + + + The binary build directory where CMake will generate the files. + + + + + The source directory which should include a `CMakeLists.txt` file. + + + + + The location of the CMake executable. Automatically found if null or empty. + + + + + The CMakeGenerate parameter type. + + + + + The value of the variable. + Will be automatically converted to the CMake format when required. + + + + + The name of the variable. + It cannot contains spaces and special characters. + + + + + A CMake variable. + + + + + The possible variable value types for CMake variables. + + + + + Calls `cmake --build` to build a project. + ## Parameters + - `setParams` - Function used to manipulate the default CMake parameters. See `CMakeBuildParams`. + + + + + Calls `cmake` to generate a project. + ## Parameters + - `setParams` - Function used to manipulate the default CMake parameters. See `CMakeGenerateParams`. + + + + + [omit] + Invokes the CMake executable with the specified arguments. + ## Parameters + - `toolPath` - The location of the executable. Automatically found if null or empty. + - `binaryDir` - The location of the binary directory. + - `args` - The arguments given to the executable. + - `timeout` - The CMake execution timeout + + + + + [omit] + Converts a file path to a valid CMake format. + ## Parameters + - `path` - The path to reformat. + + + + + [omit] + Tries to find the specified CMake executable: + + 1. Locally in `./<tools|packages>/<cmake.portable>|<cmake>/bin` + 3. In the `PATH` environment variable. + 4. In the `<ProgramFilesx86>\CMake\bin` directory. + ## Parameters + - `exeName` - The name of the CMake executable (e.g. `cmake`, `ctest`, etc.) to find. + The `.exe` suffix will be automatically appended on Windows. + + + + + The default option set given to CMakeBuild. + + + + + The default option set given to CMakeGenerate. + + + + + Contains tasks which allow to use CMake to build CMakeLists files. + See `Samples/CMakeSupport` for usage examples. + + + + + Raygun user access token for allowing API + access. (Creatd under User -> My settings in the web application) + Required, no sensible default + + + + + Endpoint to connect to + Required, Defaults to: https://app.raygun.io/deployments + + + + + Connection configuration + + + + + Datetime of the deployment + Optional, Defaults to System.DateTime.UtcNow + + + + + Hash code (or other commit identifier) from + source control system + Optional, Defaults to current git hash if executed from a git repository + else defaults to empty string + + + + + Release notes + Optional, defaults to empty string + + + + + Email address of person responsible for deployment + Optional, defaults to empty string + + + + + Name of person responsible for deployment + Optional, defaults to empty string + + + + + Version string describing deployed version + Should be the same as reported by the application + to raygun when posting an error + Required, no sensible default + + + + + Application API key + Required, no sensible default + + + + + Data describing a deployment to Raygun + + + + + ### Report a deployment to raygun + + Reports a deployment to raygun so reported errors can be + correlated with deployments + + ### Paramteres + + * settings : Function that sets the raygun connection settings. + * data : Function that sets the deployment data + + + + + Enables deployment tracking using Raygun.io + + Thin wrapper around [the Raygun HTTP deployment API](https://raygun.io/docs/deployments/api) + + + + + The secret key for the code signing certificate + + + + + The code signing certificate to be used for signing + + + + + Sign the installer with signtool.exe + + + + + Maximum time to allow Squirrel to run before being killed. + + + + + The path to Squirrel: `squirrel.exe` + + + + + Do not create an MSI file + + + + + The full path to an optional icon, which will be used for the generated installer. + + + + + The full path to an optional animated gif to be displayed during installation + + + + + The full path to an optional setup.exe template + + + + + The working directory. + + + + + The output directory for the generated installer + + + + + The [Squirrel](https://github.com/Squirrel/Squirrel.Windows) Console Parameters type. + FAKE will use [SquirrelDefaults](fake-squirrel.html) for values not provided. + + For reference, see: [Squirrel Command Line Options](https://github.com/Squirrel/Squirrel.Windows/blob/master/docs/advanced-releasify.md) + + + + + Creates a Squirrel installer for given NuGet package + Will fail if Squirrel terminates with non-zero exit code. + + ## Parameters + + - `setParams` - Function used to manipulate the default `SquirrelParams` value. + - `nugetPackage` - The package to create an installer for + + ## Sample usage + + Target "CreatePackage" (fun _ -> + SquirrelPack (fun p -> { p with WorkingDir = Some "./tmp" }) "./my.nupkg" + ) + + + + + The Squirrel default parameters. + + ## Defaults + + - `ReleaseDir` - `""` + - `WorkingDir` - `None` + - `BootstrapperExe` - `None` + - `LoadingGif` - `None` + - `SetupIcon` - `None` + - `NoMsi` - `false` + - `ToolPath` - The `squirrel.exe` path if it exists in a subdirectory of the current directory. + - `TimeOut` - 10 minutes + - `SignExecutable` - `None` + - `SigningKeyFile` - `None` + - `SigningSecret` - `None` + + + + + Contains types and utility functions related to creating [Squirrel](https://github.com/Squirrel/Squirrel.Windows) installer. + + + + + Executes a XCopy command + ## Parameters + - `source` - The source directory + - `destination` - The target directory + + + + + Contains a task to use [XCOPY](http://en.wikipedia.org/wiki/XCOPY) on Windows. + + + + + Folder for output of calls + + + + + Timeout for calls + + + + + Working Directory for calls + + + + + Directory where SolutionPackager can be found + + + + + PackageType for packing solution, either managed, unmanaged or both + + + + + Path to solution that should be packed or extracted + + + + + Action to start, either pack or extract + + + + + Parameters for invoking Solution Packager + + + + + Export all solutions for all organizations that the current user has access to. Be sure to pass discovery service url for URL parameter + + + + + Export all solutions for given organization + + + + + Specify, whether solution should be exported as managed or unmanaged + + + + + Set for specifying unique name of solution when exporting single solution + + + + + Set for specifying output file name when exporting solution or input solution name when importing + + + + + Working Directory for actions, can be used to influence storage locations of files + + + + + Tool Directory where Solution Exchanger is stored + + + + + TimeOut for each function. Set to a higher value, i.e. 60 minutes if using AllOrganizations + + + + + Password of user that should be used to connect to the CRM Organization. Leave blank to use default credentials + + + + + Username of user that should be used to connect to the CRM Organization. Leave blank to use default credentials + + + + + Url of CRM Organization / Discovery Service URL if using AllOrganizations + + + + + Parameters for executing Dynamics CRM Helper functions + + + + + Specify Package Type for usage with Solution Packager + + + + + Specify which action Solution Packager should be invoked with + + + + + Runs the solution packager tool on the given file for extracting the zip file or packing the extracted XML representation of a solution to a zip file again + ## Parameters + + - `setParams` - Parameters for invoking solution packager + + + + + Imports zipped solution file to Dynamics CRM + ## Parameters + + - `setParams` - Parameters for invoking solution exchanger + + + + + Exports solution from Dynamics CRM and save it to file + ## Parameters + + - `setParams` - Parameters for invoking solution exchanger + ## Sample + // This Target will get all solutions of all organizations that the executing user has access to, export them as unmanaged and extract them using Solution Packager. + // Extracted solutions are stored in a folder named according to the name of the organization they were exported from. + Target "SaveAndUnzipAllSolutions" (fun _ -> + CreateDir solutions + + ExportSolution(fun f -> + {f with + Url = "http://YourOrganizationDiscoveryService" + Managed = false + AllOrganizations = true + WorkingDirectory = solutions + TimeOut = TimeSpan.FromMinutes 60.0 + }) + + !!(solutions @@ @"\**\*.zip") + |> Seq.iter(fun solution -> + let dir = DirectoryInfo(solution) + + SolutionPackager (fun f -> + {f with + Action = Extract + ZipFile = solution + PackageType = Unmanaged + Folder = extractedDir @@ dir.Parent.Name @@ (Path.GetFileName solution).Replace(".zip", "") + ToolDirectory = @".\tools\SolutionPackager\" + })) + ) + + + + + Publishes all solution component changes. + ## Parameters + + - `setParams` - Parameters for invoking solution exchanger + + + + + Default values for invoking Solution Packager + + + + + Default values for Dynamics CRM Helper + You can obtain the solution exchanger as NuGet Package "Dynamics.CRM.SolutionExchanger" + + + + + Contains various functions for interacting with Dynamics CRM. So far there is support for exporting and importing solutions, zipping and unzipping using the Solution Packager, as well as publishing customizations. + + + + + Updates published to client, can habe multiple updates e.g. for different OS versions + + + + + Language of your app + + + + + Short description + + + + + A titel, usually the app name + + + + + Configuration data for the appcast + + + + + Length of the file in bytes + + + + + Optional miminal system version for the update + + + + + Optional DSA signature for the archive. It is recommended to use this if the app itself is not signed + + + + + Mime type of the update file, usualy octetstream + + + + + Optional human readable version number. This will be shown to the user if present otherwise + the technical version number will be used + + + + + Machine readable version number used to determine if an update is available by the client (should follow semver) + + + + + URI where the update files are found + + + + + Date when update is published + + + + + The name of the update + + + + + Download details for the appcast + + + + + Custom mimetype + + + + + Octetstream use for exe or zip files + + + + + Mime type of the download file + + + + + writes an appcast to a file + ##Parameters + + - `path` - The file where the appcast should be written + - `cast` - The appcast to write + ##Sample + // This target creates the app cast for our app. I contains two version 1.X and 2.X while 2.X requires at least OS X 10.10 Yosemite. + Target "CreateAppcast" (fun _ -> + let server = "https://example.com/files/" + let fileLength file = + let info = new System.IO.FileInfo(file) + info.Length + + let latestSize = fileLength "build/download-2.0.1.zip" + let legacySize = fileLength "build/download-1.1.4.zip" + + { + title = "My Awesome App" + description = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec a diam lectus." + language = "en" + items = [ + { + title = "Hawk Nickel Greyhound" + pubdate = System.DateTime.Now + url = new System.Uri(server + "download-2.0.1.zip") + version = "2014" // This our internal build number + shortVersion = Some("2.0.1") //This is what we show to the user + mimetype = OctetStream + minimumSystemVersion = Some("10.10") + length = latestSize + dsaSignature = None + }; + { + title = "Sparrow Platinum Beagle" + pubdate = System.DateTime.Now + url = new System.Uri(server + "download-1.1.4.zip") + version = "1142" // This our internal build number + shortVersion = Some("1.1.4") //This is what we show to the user + mimetype = OctetStream + length = legacySize + minimumSystemVersion = None + dsaSignature = None + } + ] + } |> writeAppcast "build/updates.xml" + ) + + + + + Sparkel namespace used for RSS extension + + + + + Contains code to configure FAKE for Appcast handling + + + + + Option which allows to enable some experimental features + + + + + Option which allows to specify if failure of pickles should break the build. + + + + + Maximum time to allow xUnit to run before being killed. + + + + + The version of the system under test + + + + + The name of the system under test + + + + + the paths to the linked test results files + + + + + the format of the linked test results + + + + + The format of the output documentation + + + + + The directory where output files will be placed + + + + + The language of the feature files + + + + + The directory to start scanning recursively for features + + + + + The path to the Pickles console tool: 'pickles.exe' + + + + + The Pickles parameter type + + + + + The format of the test results + + + + + With this option set, no exception is thrown if pickles fails to execute + + + + + This option instructs FAKE to break the build if pickles fails to execute + + + + + Option which allows to specify if failure of pickles should break the build. + + + + + Runs pickles living documentation generator via the given tool + Will fail if the pickles command line tool terminates with a non zero exit code. + + The pickles command line tool terminates with a non-zero exit code if there + is any error. + + ## Parameters + - `setParams` - Function used to manipulate the default `PicklesParams` value + + + + + The Pickles default parameters + + ## Defaults + + - `ToolPath` - The `pickles.exe` if it exists in a subdirectory of the current directory + - `FeatureDirectory` - 'currentDirectory' + - `FeatureFileLanguage` - 'None' (defaults to `en`) + - `OutputDirectory` - `currentDirectory @@ "Documentation"` + - `OutputFileFormat` - `DHTML` + - `TestResultsFormat` - `Nunit` + - `LinkedTestResultFiles` - [] + - `SystemUnderTestName` - `None` + - `SystemUnderTestVersion` - `None` + - `TimeOut` - 5 minutes + - `ErrorLevel` - `Error` + - `IncludeExperimentalFeatures` - `None` + + + + + Contains tasks to run the [Pickles](http://www.picklesdoc.com/) living documentation generator + + + + + Do not prompt for user input or confirmations. Default `true`. + Equivalent to the `-y` option. + + + + + A character string containing additional arguments to give to choco. + + + + + The location of the choco executable. Automatically found if null or empty. + + + + + The choco execution timeout. + + + + + The api key for the source. If not specified (and not local file source), does a lookup. + If not specified and one is not found for an https source, push will fail. + Equivalent to the `--apikey <apikey>` option. + + + + + The source we are pushing the package to. Default: "https://chocolatey.org/" + Equivalent to the `--source <source>` option. + + + + + The choco push parameter type. + + + + + The type of checksum that the file is validated with. Default: Sha256 + Used to create chocolateyInstall.ps1 if it doesn't exists. + + + + + The type of checksum that the file is validated with. Default: Sha256 + Used to create chocolateyInstall.ps1 if it doesn't exists. + + + + + The checksum hash value of the PackageDownload64Url resource + This allows a checksum to be validated for files that are not local. The checksum type is covered by ChecksumType64. + Equivalent to the `--checksum <string>` option of Install-Chocolatey[Zip]Package functions. + Used to create chocolateyInstall.ps1 if it doesn't exists. + + + + + The checksum hash value of the PackageDownloadUrl resource + This allows a checksum to be validated for files that are not local. The checksum type is covered by ChecksumType. + Equivalent to the `--checksum <string>` option of Install-Chocolatey[Zip]Package functions. + Used to create chocolateyInstall.ps1 if it doesn't exists. + + + + + Either: + + - For zip: the zip filename originally installed + - For exe or msi: the full path to the native uninstaller to run + + + + + Installer type. Default: Zip. + Used to create chocolateyInstall.ps1 and/or chocolateyUninstall.ps1 if it doesn't exists. + + + + + Unzip location for zip package. Default: Chocolatey install folder. + Used to create chocolateyInstall.ps1 if it doesn't exists. + + + + + Silent args for the installer. + Used to create chocolateyInstall.ps1 and/or chocolateyUninstall.ps1 if it doesn't exists. + + + + + Url pointing to the installer (exe, msi, zip) of the 64 bits version of the package. + Used to create chocolateyInstall.ps1 if it doesn't exists. + + + + + Url pointing to the installer (exe, msi, zip) of the package. + Used to create chocolateyInstall.ps1 if it doesn't exists. + + + + + Boolean specifying whether the package will be marked as a [development-only dependency](https://docs.nuget.org/Release-Notes/NuGet-2.7#development-only-dependencies). Default: false. + Used for the nuspec creation. + + + + + Url pointing to the location of the underlying software source. + Used for the nuspec creation. + + + + + Url pointing to the location where issues and tickets can be accessed. + Used for the nuspec creation. + + + + + Url pointing to the forum or email list group for the software. + Used for the nuspec creation. + + + + + Url pointing to the location of the wiki or docs of the software. + Used for the nuspec creation. + + + + + Url to the chocolatey package repository, not the software (unless they are the same). + Used for the nuspec creation. + + + + + True if the software needs license acceptance. Default: false. + Used for the nuspec creation. + + + + + Url to the license of the software. + Used for the nuspec creation. + + + + + Url to the icon of the package. + Used for the nuspec creation. + + + + + Url to the software. + Used for the nuspec creation. + + + + + Files of the package. + Used for the nuspec creation. + + + + + Framework assemblies of the package. + Used for the nuspec creation. + + + + + References by framework of the package. + Used for the nuspec creation. + + + + + References of the package. + Used for the nuspec creation. + + + + + Dependencies by framework of the package. + Used for the nuspec creation. + + + + + Dependencies of the package. + Used for the nuspec creation. + + + + + Output directory for the files (nuspec, chocolateyInstall.ps1 and chocolateyUninstall.ps1) creation. + + + + + Copyright of the package. + Used for the nuspec creation. + + + + + Release notes of the package. + Used for the nuspec creation. + + + + + Tags of the package. + Used for the nuspec creation. + + + + + Description of the package. + Used for the nuspec creation. + + + + + Summary of the package. + Used for the nuspec, chocolateyInstall.ps1 and chocolateyUninstall.ps1 creation. + + + + + Title of the package. + Used for the nuspec creation. + + + + + Id of the package. Should be lowercase, not contains weird chars and use dash (-) instead of spaces. + Used for the nuspec creation. + + + + + Owners of the package. + Used for the nuspec creation. + + + + + Authors of the package. + Used for the nuspec creation. + + + + + Do not prompt for user input or confirmations. Default `true`. + Equivalent to the `-y` option. + + + + + A character string containing additional arguments to give to choco. + + + + + The location of the choco executable. Automatically found if null or empty. + + + + + The choco execution timeout. + + + + + The version you would like to insert into the package. + Equivalent to the `--version <version>` option. + + + + + The choco pack parameter type. + + + + + Do not prompt for user input or confirmations. Default `true`. + Equivalent to the `-y` option. + + + + + A character string containing additional arguments to give to choco. + + + + + The location of the choco executable. Automatically found if null or empty. + + + + + The choco execution timeout. + + + + + Password - the user's password to the source. + Equivalent to the `--password <password>` option. + + + + + User - used with authenticated feeds. + Equivalent to the `--user <user>` option. + + + + + Skip Powershell - Do not run chocolateyInstall.ps1. Default `false`. + Equivalent to the `--skippowershell` option. + + + + + Should install arguments be used exclusively without appending to current package passed arguments? Default `false`. + Equivalent to the `--overrideargs` option. + + + + + Install Arguments to pass to the native installer in the package. + Equivalent to the `--installargs <args>` option. + + + + + Force x86 (32bit) installation on 64 bit systems. Default `false`. + Equivalent to the `--forcex86` option. + + + + + Equivalent to the `--source <source>` option. + + + + + Parameters to pass to the package. + Equivalent to the `--params <params>` option. + + + + + Include prerelease. Default `false`. + Equivalent to the `--pre` option. + + + + + Version of the package + Equivalent to the `--version <version>` option. + + + + + The choco install parameter type. + + + + + Call choco to [push](https://github.com/chocolatey/choco/wiki/CommandsPush) a package + ## Parameters + - `setParams` - Function used to manipulate the default choco parameters. See `ChocoPushParams` + - `nupkgPath` - path to the .nupkg to push + ## Sample usage + + Target "ChocoPush" (fun _ -> + "pretzel.0.5.0.nupkg" |> Choco.Push (fun p -> { p with ApiKey = "123-123123-123" }) + ) + + + + + Call choco to [pack](https://github.com/chocolatey/choco/wiki/CommandsPack) a package + ## Parameters + - `setParams` - Function used to manipulate the default choco parameters. See `ChocoPackParams` + - `nuspecPath` - path to the .nuspec to pack + ## Sample usage + + Target "ChocoPack" (fun _ -> + "pretzel.nuspec" |> Choco.Pack (fun p -> { p with Version = "0.5.0" }) + ) + + + + + Call choco to [pack](https://github.com/chocolatey/choco/wiki/CommandsPack) a package and create .nuspec, chocolateyInstall.ps1 and chocolateyUninstall.ps1 if informations are specified + ## Parameters + - `setParams` - Function used to manipulate the default choco parameters. See `ChocoPackParams` + ## Sample usage + + Target "ChocoPack" (fun _ -> + Choco.Pack (fun p -> { p with Version = "0.5.0"; ... }) + ) + + + + + Call choco to [install](https://github.com/chocolatey/choco/wiki/CommandsInstall) a package + ## Parameters + - `setParams` - Function used to manipulate the default choco parameters. See `ChocoInstallParams` + - `packages` - Names of packages, path to packages.config, .nuspec or .nupkg to install + ## Sample usage + + Target "ChocoInstall" (fun _ -> + "pretzel" |> Choco.Install (fun p -> { p with Version = "0.4.0" }) + ) + + + + + True if choco is available (only on windows) + ## Sample usage + "Build" =?> ("ChocoInstall", Choco.IsAvailable) + + + + + [omit] + Create nuspec from data + + + + + [omit] + Create nuspec from template + + + + + [omit] + Invokes chocolatey with the specified arguments + ## Parameters + - `exePath` - The location of choco executable. Automatically found if null or empty. + - `args` - The arguments given to the executable. + - `timeout` - The choco execution timeout + + + + + [omit] + Tries to find the specified choco executable: + + 1. In the `<ProgramData>\chocolatey\bin` directory + 2. In the `PATH` environment variable. + + + + + The default option set given to choco push. + + + + + The default option set given to choco pack. + + + + + The default option set given to choco install. + + + + + Contains tasks which allow to call [Chocolatey](https://chocolatey.org) + + + + + Whether to force inline unfurling of attached links. Default value: false. + + + + + The emoji to be displayed with the message. Default value: Specified in your slack Webhook configuration. + + + + + The icon to be displayed with the message. Default value: Specified in your slack Webhook configuration. + + + + + Channel to which the message will be posted. Default value: Specified in your Slack Webhook configuration. + + + + + Name the message will appear to be sent from. Default value: Specified in your Slack Webhook configuration. + + + + + (Required) The message body + + + + + The Slack notification parameter type + + + + + Text to be displayed as a table below the message + + + + + Color of the attachment text. Can be hex-value(e.g. "#AABBCC") or one of "'good', 'warning', 'danger'. + + + + + Text that should appear above the formatted data + + + + + Text that should appear within the attachment + + + + + Content to which the title should link + + + + + The title of the attachment + + + + + (Required) Text summary of the attachment that is shown by clients that understand attachments but choose not to show them + + + + + The Slack notification attachment parameter type + + + + + Whether the value is short enough to be displayed side-by-side with other values + + + + + (Required) Text value of the field + + + + + (Required) The field title + + + + + The Slack notification attachment field parameter type + + + + + Sends a notification to a Slack Channel + ## Parameters + - `webhookURL` - The Slack webhook URL + - `setParams` - Function used to override the default notification parameters + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + The default parameters for Slack notification attachment fields + + + + + The default parameters for Slack notification attachments + + + + + The default Slack notification parameters + + + + + Contains a task to send notification messages to a [Slack](https://slack.com/) webhook + + + + + Read settings from configuration file + + + + + Individual global settings for SonarQube + + + + + Version number of the project + + + + + Name of the project + + + + + Key to identify the sonar qube project + + + + + FileName of the sonar qube runner exe. + + + + + Parameter type to configure the sonar qube runner. + + + + + The supported commands of Sonar Qube. It is called with Begin before compilation, and End after compilation. + + + + + SonarQubeEnd + + + + + + SonarQube Begin (fun p -> + {p with + Key = "MyProject" + Name = "MainTool" + Version = "1.0 }) + + + + + + Execute the external msbuild runner of Sonar Qube. Parameters are fiven to the command line tool as required. + + + + + SonarQube default parameters - tries to locate MSBuild.SonarQube.exe in any subfolder. + + + + + Contains a task to run the msbuild runner of [Sonar Qube analyzer](http://sonarqube.org). + + + + + Serves the generated documentation on localhost. Default: false + + + + + Allows to specify a timeout for DocFx. Default: 5 min + + + + + DocFx WorkingDirectory. Default: docs + + + + + the DocFxJson Config-File. Default: docs/docfx.json + + + + + The tool path - FAKE tries to find docfx.exe automatically in any sub folder. + + + + + The parameter type for DocFx. + + + + + Generates a DocFx documentation. + ## Parameters + - `setParams` - Function used to manipulate the default DocFx parameters. See `DocFxDefaults` + ## Sample + + DocFx (fun p -> + { p with + DocFxJson = "foo" @@ "bar" @@ "docfx.json" + Timeout = TimeSpan.FromMinutes 10. + }) + + + + + The default parameters + + + + + Contains helper functions to run the documentation tool "docfx". + + + + + Runs [GitVersion](https://gitversion.readthedocs.io/en/latest/) on a .NET project file. + ## Parameters + + - `setParams` - Function used to manipulate the GitversionDefaults value. + + ## Sample + + GitVersion id // Use Defaults + GitVersion (fun p -> { p with ToolPath = currentDirectory @@ "tools" } + + + + + Containts helper function for GitVersion - a tool to help you achieve Semantic Versioning on your project. + + To install GitVersion.exe on Windows, start PowerShell as Administrator and run choco install gitversion.portable -s https://chocolatey.org/api/v2" + For Mac and Unix, install the NuGet version. + + + + + The change log entries + + + + + The Unreleased section + + + + + The description + + + + + the header line + + + + + the latest change log entry + + + + + True, if the entry was yanked + + + + + The parsed list of changes + + + + + a descriptive text (after the header) + + + + + Release DateTime + + + + + Semantic version + + + + + the NuGet package version + + + + + the parsed Version + + + + + Custom entry (Header, Description) + + + + + to invite users to upgrade in case of vulnerabilities + + + + + for any bug fixes + + + + + for deprecated features removed in this release + + + + + for once-stable features removed in upcoming releases + + + + + for changes in existing functionality + + + + + for new features + + + + + Promotes the `Unreleased` section of a changelog + to a new change log entry with the given version + + ## Parameters + - `version` - The version (in NuGet-Version format, e.g. `3.13.4-alpha1.212` + - `changeLog` - The change log to promote + + ## Returns + The promoted change log + + + + + Saves a Change log to a text file. + + ## Parameters + - `fileName` - ChangeLog text file name + - `changeLog` - the change log data + + + + + Parses a Change log text file and returns the lastest change log. + + ## Parameters + - `fileName` - ChangeLog text file name + + ## Returns + The loaded change log (or throws an exception, if the change log could not be parsed) + + + + + Parses a change log text and returns the change log. + + ## Parameters + - `data` - change log text + + + + + Contains helpers which allow to parse Change log text files. + These files have to be in a format as described on http://keepachangelog.com/en/0.3.0/ + + ## Sample + + let changeLogFile = "CHANGELOG.md" + let newVersion = "1.0.0" + + Target "AssemblyInfo" (fun _ -> + let changeLog = changeLogFile |> ChangeLogHelper.LoadChangeLog + CreateFSharpAssemblyInfo "src/Common/AssemblyInfo.fs" + [ Attribute.Title project + Attribute.Product project + Attribute.Description summary + Attribute.Version changeLog.LatestEntry.AssemblyVersion + Attribute.FileVersion changeLog.LatestEntry.AssemblyVersion] + ) + + Target "Promote Unreleased to new version" (fun _ -> + let newChangeLog = + changeLogFile + |> ChangeLogHelper.LoadChangeLog + |> ChangeLogHelper.PromoteUnreleased newVersion + |> ChangeLogHelper.SavceChangeLog changeLogFile + ) + + + + + This array of ViewAction objects will power the action links found at the bottom of the card + + + + + Contains a list of sections to display in the card + + + + + (Optional) Accent color used for branding or indicating status in the card + + + + + The main text of the card. This will be rendered below the sender information and optional title, and above any sections or actions present. + + + + + (Optional) A title for the Connector message. Shown at the top of the message. + + + + + (Required, if the text property is not populated) A string used for summarizing card content. This will be shown as the message subject. + + + + + Converts the connector card to a JSON string + + + + + This is the base data, which will be sent to the Office 365 webhook connector + + + + + This list of ViewAction objects will power the action links found at the bottom of the section + + + + + (Optional) Set this to false to disable markdown parsing on this section's content. Markdown parsing is enabled by default. + + + + + (Optional) A text that will appear before the activity. + + + + + A list of images that will be displayed at the bottom of the section. + + + + + A list of facts, displayed as key-value pairs. + + + + + (Optional) A full description of the action. + + + + + (Optional) An image representing the action. Often this is an avatar of the "actor" of the activity. + + + + + (Optional) A subtitle describing the event or action. Often this will be a summary of the action. + + + + + (Optional) Title of the event or action. Often this will be the name of the "actor". + + + + + (Optional) The title of the section + + + + + Writes the Section to a JSON writer + + + + + A section in a ConnectorCard + + + + + (Required) A URL to the image file or a data URI with the base64-encoded image inline + + + + + (Optional) Alt-text for the image + + + + + Writes the Image to a JSON writer + + + + + Represents a described image object + + + + + (Required) Value of the fact + + + + + (Required) Name of the fact + + + + + Writes the fact to a JSON writer + + + + + A simple key/value pair + + + + + A Data uri of the image encoded as Base64 data + + + + + A simple URI of the image + + + + + Writes the image uri to a JSON writer + + + + + Creates a new ImageUrl from a given url string + + + + + Creates a new DataUri from a given file + png, gif, jpg and bmp files are supported + + + + + Represents the URI to an image (either a normal URI or a DataUri) + + + + + (Required) The Url of the link for the button + + + + + (Required) The name of the Action (appears on the button). + + + + + Writes the action to a JSON writer + + + + + Represents an action button + + + + + This type alias gives you a hint where you have to use a Hex color value (e.g. #AAFF77) + + + + + This type alias for string gives you a hint where you **can't** use markdown + + + + + This type alias for string gives you a hint where you can use markdown + + + + + Sends a notification to an Office 365 Connector + ## Parameters + - `webhookURL` - The Office 365 webhook connector URL + - `setParams` - Function used to override the default notification parameters + + + + + [omit] + + + + + Default values for a ConnectorCard (everything is empty here) + + + + + Default values for a Section in a ConnectorCard (everything is empty here) + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + Contains a task to send notification messages to a [Office 356 Connector](https://dev.outlook.com/connectors/reference) webhook + + ## Sample + + let imageUrl = sprintf "https://connectorsdemo.azurewebsites.net/images/%s" + + let notification p = + { p with + Summary = Some "Max Muster ran a build" + Title = Some "Sample Project" + Sections = + [ { SectionDefaults with + ActivityTitle = Some "Max Muster" + ActivitySubtitle = Some "on Sample Project" + ActivityImage = + imageUrl "MSC12_Oscar_002.jpg" + |> ImageUri.FromUrl + |> Some + } + { SectionDefaults with + Title = Some "Details" + Facts = [ { Name = "Labels"; Value = "FOO, BAR" } + { Name = "Version"; Value = "1.0.0" } + { Name = "Trello Id"; Value = "1101" } ] + } + ] + PotentialActions = + [ + { + Name = "View in Trello" + Target = System.Uri("https://trello.com/c/1101/") + } + ] + } + + let webhookURL = "<YOUR WEBHOOK URL>" + + Office365Notification webhookURL notification |> ignore + + + + + + Parameter type for the StyleCop tool + + + + + Type to define the behavior of how StyleCop must react on violations + + + + + Runs the StyleCop tool, using the listed source, project and solution files. + + ## Parameters + + - `setParams` - Function used to overwrite the StyleCop default parameters. + + ## Sample + + StyleCop (fun p -> { p with + SolutionFiles = [ artifactsDir @@ "MySolution.sln" ] }) + + + + + StyleCop default parameters + + + + + Path to mdtool, defaults to Xamarin Studio's usual path + + + + + Build configuration, defaults to 'Debug|iPhoneSimulator' + + + + + Project name within a solution file + + + + + Path to desired solution file. If not provided, mdtool finds the first solution in the current directory. + Although mdtool can take a project file, the archiving seems to fail to work without a solution. + + + + + The iOS archive paramater type + + + + + Path to zipalign tool, defaults to assuming it is in your path + + + + + Path to jarsigner tool, defaults to assuming it is in your path + + + + + Specifies the name of the message digest algorithm to use when digesting the entries of a JAR file. + + + + + Specifies the name of the signature algorithm to use to sign the JAR file. + + + + + (Required) Alias for keystore + + + + + (Required) Password for keystore + + + + + (Required) Path to keystore used to sign the app + + + + + Used for multiple APK packaging to set different version code par ABI + + + + + Build an APK Targetting One ABI (used to reduce the size of the APK and support different CPU architectures) + + + + + Additional MSBuild properties, defaults to empty list + + + + + Output path for build, defaults to 'bin/Release' + + + + + Build configuration, defaults to 'Release' + + + + + (Required) Path to the Android project file (not the solution file!) + + + + + The Android packaging parameter type + + + + + Additional MSBuild properties, defaults to empty list + + + + + Indicates if an IPA file should be generated + + + + + Output path for build, defaults to project settings + + + + + Build platform, defaults to 'iPhoneSimulator' + + + + + Build configuration, defaults to 'Debug' + + + + + Build target, defaults to Build + + + + + (Required) Path to solution or project file + + + + + The iOS build paramater type + + + + + Path to xamarin-component.exe, defaults to checking tools/xpkg + + + + + The package restore paramater type + + + + + Archive a project using Xamarin's iOS archive tools + ## Parameters + - `setParams` - Function used to override the default archive parameters + + + + + The default iOS archive parameters + + + + + Signs and aligns multiple Xamarin.Android packages, returning multiple FileInfo objects for the signed APK file + ## Parameters + - `setParams` - Function used to override the default build parameters + - `apkFiles` - FileInfo object for an unsigned APK file to sign and align + + + + + Signs and aligns a Xamarin.Android package, returning a FileInfo object for the signed APK file + ## Parameters + - `setParams` - Function used to override the default build parameters + - `apkFile` - FileInfo object for an unsigned APK file to sign and align + + + + + The default Android signing and aligning parameters + + + + + Packages a Xamarin.Android app, returning a FileInfo object for the unsigned APK file + ## Parameters + - `setParams` - Function used to override the default build parameters + + + + + Packages a Xamarin.Android app, returning a multiple FileInfo objects for the unsigned APK files + ## Parameters + - `setParams` - Function used to override the default build parameters + + + + + The default Android packaging parameters + + + + + Builds a project or solution using Xamarin's iOS build tools + ## Parameters + - `setParams` - Function used to override the default build parameters + + + + + The default iOS build parameters + + + + + Restores NuGet packages and Xamarin Components for a project or solution + ## Parameters + - `setParams` - Function used to override the default package restore parameters + + + + + The default package restore parameters + + + + + Contains tasks for building Xamarin.iOS and Xamarin.Android apps + + + + diff --git a/packages/FAKE.5.16.0/tools/FakeLib.dll b/packages/FAKE.5.16.0/tools/FakeLib.dll new file mode 100644 index 0000000..115ef64 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FakeLib.dll differ diff --git a/packages/FAKE.4.11.3/tools/FakeLib.dll.config b/packages/FAKE.5.16.0/tools/FakeLib.dll.config similarity index 93% rename from packages/FAKE.4.11.3/tools/FakeLib.dll.config rename to packages/FAKE.5.16.0/tools/FakeLib.dll.config index 97a1858..f0a438d 100644 --- a/packages/FAKE.4.11.3/tools/FakeLib.dll.config +++ b/packages/FAKE.5.16.0/tools/FakeLib.dll.config @@ -7,10 +7,6 @@ - - - - @@ -47,10 +43,6 @@ - - - - @@ -105,11 +97,11 @@ - + - + @@ -127,5 +119,18 @@ + + True + + + + + True + + + + + + \ No newline at end of file diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Abstractions.dll b/packages/FAKE.5.16.0/tools/FluentMigrator.Abstractions.dll new file mode 100644 index 0000000..0e21cfe Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FluentMigrator.Abstractions.dll differ diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Abstractions.resources.dll b/packages/FAKE.5.16.0/tools/FluentMigrator.Abstractions.resources.dll new file mode 100644 index 0000000..fa9610e Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FluentMigrator.Abstractions.resources.dll differ diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Abstractions.xml b/packages/FAKE.5.16.0/tools/FluentMigrator.Abstractions.xml new file mode 100644 index 0000000..d3f2cc1 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/FluentMigrator.Abstractions.xml @@ -0,0 +1,666 @@ + + + + FluentMigrator.Abstractions + + + + + Sets the context for the automatic name generation + + + + + The automatic name generation is for an embedded resource + + + + + The value to set against existing rows for the new column. Only used for creating columns, not altering them. + + + + + The value to set against existing rows for the new column. + + + + + Deletes an index + + the name of the index + + + + + Deletes an index, based on the naming convention in effect + + + + + + Deletes a named Primary Key from a table + + + + + + + Deletes a named Unique Constraint From a table + + + + + + + Deletes a named Unique Constraint from a table based on the naming convention in effect + + + + + + Deletes a default constraint from a column + + + + + + Describes common attributes for expression builders which have a current table/column. + + + + + Defines fluent expressions that can be conditionally executed + + + + + Insert text with unicode data. Primarily for Sql Server, it prefixes the string with 'N + + + + + Gets the text of the unicode string literal + + + + + Insert text with unicode data. Primarily for Sql Server, it prefixes the string with 'N + + Unicode string + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + + + Gets or sets parameters to be replaced before script execution + + + + + Gets or sets parameters to be replaced before script execution + + + + + The expression requires an automatically generated name + + + + + Gets or sets the automatically generated names + + + + + Gets or sets the context in which the automatically generated name gets used + + + + + Gets the type of the migration object + + + + + Gets the database names + + + + + Gets the direction of the migration + + + + + Opt-in into columns conventions + + + + + Gets the table name + + + + + Gets the list of columns + + + + + Opt-in into constraint expression conventions + + + + + Gets the constraint definition + + + + + Opt-in into the file system convention + + + + + Gets or sets the root path (working directory) + + + + + Opt-in into the foreign key expressions conventions + + + + + Gets the foreign key defintion + + + + + Opt-in into the index expression conventions + + + + + Gets the index definition + + + + + Opt-in into the schema expression convention + + + + + Gets or sets the schema name + + + + + Opt-in into the sequence expression conventions + + + + + Gets the sequence definition + + + + The arbitrary application context passed to the task runner. + + + + Eine stark typisierte Ressourcenklasse zum Suchen von lokalisierten Zeichenfolgen usw. + + + + + Gibt die zwischengespeicherte ResourceManager-Instanz zurück, die von dieser Klasse verwendet wird. + + + + + Überschreibt die CurrentUICulture-Eigenschaft des aktuellen Threads für alle + Ressourcenzuordnungen, die diese stark typisierte Ressourcenklasse verwenden. + + + + + Sucht eine lokalisierte Zeichenfolge, die The column's name cannot be null or an empty string. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die Column names must be unique. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die The column does not have a type defined. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die The constraint must have at least one column specified. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die The default value cannot be null. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die The destination schema's name cannot be null or an empty string. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die The foreign key must have one or more foreign columns. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die The foreign key must have one or more primary columns. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die The foreign key's name cannot be null or an empty string. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die The foreign table name cannot be null or empty. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die The index must have one or more columns. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die The index's name cannot be null or an empty string. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die The {0} method must be called on an object that implements {1}. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die The new column name cannot be null or empty. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die The new table name cannot be null or empty. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die The old column name cannot be null or empty. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die The old table name cannot be null or empty. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die The operation to be performed using the database connection cannot be null. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die The primary table name cannot be null or empty. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die The schema's name cannot be null or an empty string. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die The sequence's name cannot be null or an empty string. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die The sql script cannot be null or an empty string. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die The sql statement cannot be null or an empty string. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die The table's name cannot be null or an empty string. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die Update statement specifies both a .Where() condition and that .AllRows() should be targeted. Specify one or the other, but not both. ähnelt. + + + + + Sucht eine lokalisierte Zeichenfolge, die Update statement is missing a condition. Specify one by calling .Where() or target all rows by calling .AllRows(). ähnelt. + + + + + A bundle of one or more Assembly instances + + + + + The Assemblies contained in this collection + + + + + The result of this method is equivalent to calling GetExportedTypes + on each Assembly in Assemblies. + + + + + + Gets a array of resources defined in each of the assemblies that are + contained in this collection, plus which assembly it is defined in. + + An array of value pairs of resource name plus assembly. + + + + Combines a ManifestResourceName with the assembly it belongs to + + + + + A simple wrapper which is equivalent to a collection with a single Assembly + + + + The arbitrary application context passed to the task runner. + + + + Annotates migrations that should always be executed at a specified stage. + + + Migration annotated with will be always executed + when migrating the database to the latest version. The execution stage in which it would + be executed is defined by . The transaction behavior can also be defined + with the , which if not specified defaults to the default + transaction behavior. + + + + + The direction of the migration + + + + + Applies the migration + + + + + Reverts the migration + + + + + Represents a stage in the migration run. + + + + + Migration will be run before all standard migrations. + + + + + Migration will be run before each standard migration. + + + + + Migration will be run after each standard migration. + + + + + Migration will be run after all standard migrations, but before profiles. + + + + + Migration will be run after all standard migrations and profiles. + + + + + Gets or sets the foreign key definition + + + A column might be marked as , but + might still be null. This + happens when ForeignKey() without arguments gets + called on a column. + + + + + Initializes a new instance of the class. + + + + + An explicitly non-Unicode string literal ('some string' in T-SQL) + + + + + Gets the value of the non-Unicode string literal + + + + + Used for explicitly creating a non-Unicode string literal in Transact SQL + + The value of the non-Unicode string literal + + + + Overrides ToString() to return the value. + + + The value of the non-Unicode string literal. + + + + + Used to filter which migrations are run. + + + + + Gets the behavior of the runner when evaluating . + + + + + Gets the names of the tags that are evaluated by the runner. + + + + + Initializes a new instance of the class. + + The behavior of the runner when evaluating . + The names of the tags that are evaluated by the runner. + + + + Initializes a new instance of the class. + + The names of the tags that are evaluated by the runner. + + + + Initializes a new instance of the class. + + The tag that is evaluated by the runner. + + + + Initializes a new instance of the class. + + The first tag that is evaluated by the runner. + The second tag that is evaluated by the runner. + + + + Initializes a new instance of the class. + + The first tag that is evaluated by the runner. + The second tag that is evaluated by the runner. + The third tag that is evaluated by the runner. + + + + Initializes a new instance of the class. + + The first tag that is evaluated by the runner. + The second tag that is evaluated by the runner. + The third tag that is evaluated by the runner. + The fourth tag that is evaluated by the runner. + + + + Creates a MigrationAttribute which executes in order based on the given date and time. + + + + + Initializes a new instance of the class whose version is based on date and time information. + + The year the migration was created. + The month the migration was created. + The day the migration was created. + The hour the migration was created. + The minute the migration was created. + The second the migration was created. + + + + Initializes a new instance of the class whose version is based on date and time information. + + The year the migration was created. + The month the migration was created. + The day the migration was created. + The hour the migration was created. + The minute the migration was created. + + + + Initializes a new instance of the class whose version is based on date and time information. + + The year the migration was created. + The month the migration was created. + The day the migration was created. + The hour the migration was created. + The minute the migration was created. + A description for the migration. + + + + Initializes a new instance of the class whose version is based on date and time information. + + The year the migration was created. + The month the migration was created. + The day the migration was created. + The hour the migration was created. + The minute the migration was created. + The second the migration was created. + A description for the migration. + + + + Initializes a new instance of the class whose version is based on date and time information. + + The year the migration was created. + The month the migration was created. + The day the migration was created. + The hour the migration was created. + The minute the migration was created. + The the migration will use. + + + + Initializes a new instance of the class whose version is based on date and time information. + + The year the migration was created. + The month the migration was created. + The day the migration was created. + The hour the migration was created. + The minute the migration was created. + The second the migration was created. + The the migration will use. + + + + Initializes a new instance of the class whose version is based on date and time information. + + The year the migration was created. + The month the migration was created. + The day the migration was created. + The hour the migration was created. + The minute the migration was created. + The the migration will use. + A description for the migration. + + + + Initializes a new instance of the class whose version is based on date and time information. + + The year the migration was created. + The month the migration was created. + The day the migration was created. + The hour the migration was created. + The minute the migration was created. + The second the migration was created. + The the migration will use. + A description for the migration. + + + + The default transaction behavior, meaning 1 transaction per migration if the Processor allows it. + + + + + A migration will not use a transaction. + + + + diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Extensions.SqlAnywhere.dll b/packages/FAKE.5.16.0/tools/FluentMigrator.Extensions.SqlAnywhere.dll new file mode 100644 index 0000000..998d8e6 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FluentMigrator.Extensions.SqlAnywhere.dll differ diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Extensions.SqlAnywhere.xml b/packages/FAKE.5.16.0/tools/FluentMigrator.Extensions.SqlAnywhere.xml new file mode 100644 index 0000000..1e9a867 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/FluentMigrator.Extensions.SqlAnywhere.xml @@ -0,0 +1,23 @@ + + + + FluentMigrator.Extensions.SqlAnywhere + + + + + Index should have unique values, but multiple rows with null values should be accepted. + + The expression to set this option for + The + + + + Index should have unique values. Only one row with null value should be accepted (default for most known database engines). + + The expression to set this option for + true when nulls should be distinct + The + + + diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Extensions.SqlServer.dll b/packages/FAKE.5.16.0/tools/FluentMigrator.Extensions.SqlServer.dll new file mode 100644 index 0000000..fb1cc17 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FluentMigrator.Extensions.SqlServer.dll differ diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Extensions.SqlServer.xml b/packages/FAKE.5.16.0/tools/FluentMigrator.Extensions.SqlServer.xml new file mode 100644 index 0000000..21f43c6 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/FluentMigrator.Extensions.SqlServer.xml @@ -0,0 +1,130 @@ + + + + FluentMigrator.Extensions.SqlServer + + + + + Inserts data using Sql Server's IDENTITY INSERT feature. + + + + + + + Makes a column an Identity column using the specified seed and increment values. + + Column on which to apply the identity. + Starting value of the identity. + Increment value of the identity. + + + + + Makes a column an Identity column using the specified seed and increment values with bigint support. + + Column on which to apply the identity. + Starting value of the identity. + Increment value of the identity. + + + + + Column should have unique values, but multiple rows with null values should be accepted. + + The expression to set this option for + The + + + + Column should have unique values. Only one row with null value should be accepted (default for most known database engines). + + The expression to set this option for + true when nulls should be distinct + The + + + + Column should have unique values, but multiple rows with null values should be accepted. + + The expression to set this option for + The + + + + Column should have unique values. Only one row with null value should be accepted (default for most known database engines). + + The expression to set this option for + true when nulls should be distinct + The + + + + Index should have unique values, but multiple rows with null values should be accepted. + + The expression to set this option for + The + + + + Index should have unique values. Only one row with null value should be accepted (default for most known database engines). + + The expression to set this option for + true when nulls should be distinct + The + + + + Specifies whether underlying tables and associated indexes are available for queries and data modification during the index operation. + The ONLINE option can only be specified in certain situations, please refer to documentation for SQL Server 2005 and newer. + + The expression to use to set the WITH(ONLINE=) option + + true + Long-term table locks are not held. This allows queries or updates to the underlying table to continue. + false + Table locks are applied and the table is unavailable for the duration of the index operation. + + + + + Specifies whether underlying tables and associated indexes are available for queries and data modification during the index operation. + The ONLINE option can only be specified in certain situations, please refer to documentation for SQL Server 2005 and newer. + + The expression to use to set the WITH(ONLINE=) option + + true + Long-term table locks are not held. This allows queries or updates to the underlying table to continue. + false + Table locks are applied and the table is unavailable for the duration of the index operation. + + + + + Specifies whether underlying tables and associated indexes are available for queries and data modification during the index operation. + The ONLINE option can only be specified in certain situations, please refer to documentation for SQL Server 2005 and newer. + + The expression to use to set the WITH(ONLINE=) option + + true + Long-term table locks are not held. This allows queries or updates to the underlying table to continue. + false + Table locks are applied and the table is unavailable for the duration of the index operation. + + + + + Specifies whether underlying tables and associated indexes are available for queries and data modification during the index operation. + The ONLINE option can only be specified in certain situations, please refer to documentation for SQL Server 2005 and newer. + + The expression to use to set the WITH(ONLINE=) option + + true + Long-term table locks are not held. This allows queries or updates to the underlying table to continue. + false + Table locks are applied and the table is unavailable for the duration of the index operation. + + + + diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Core.dll b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Core.dll new file mode 100644 index 0000000..084addf Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Core.dll differ diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Core.xml b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Core.xml new file mode 100644 index 0000000..4b38d82 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Core.xml @@ -0,0 +1,1132 @@ + + + + FluentMigrator.Runner.Core + + + + + The result of a operation + + + + + Initializes a new instance of the class. + + The index into the where the end code was found + + + + Initializes a new instance of the class. + + The index into the where the nested start code was found + The searcher to be used to find the end of the nested range + + + + Gets a value indicating whether this is a nested range + + + + + Gets the index into the previously tested of the end code or nested start code + + + + + Gets the searcher to be used to find the end of the nested range + + + + + Operator to convert an index of the end code into a + + The index into the of the end code + + + + Read content from a line and advance the internal index + + + + + Gets the current line + + + + + Gets the current index into the line + + + + + Gets the remaining length + + + + + Reads a string with the given from the + + The length of the string to read from the + The read string + + + + Creates a new while moving the internal by the given + + The number of characters to move the internal + A new line reader with the new index + + + + Interface to search for content with a given start- and end code + + + + + Gets the length of the start code + + + + + Gets the length of the end code + + + + + Is this range a comment? + + + + + Gets the index into the where the start code was found + + The reader where the start code is searched + -1 when the start code couldn't be found + + + + Search for an end code + + The reader where the end code is searched + null when the end code couldn't be found (or a nested start code) + + + + Searches for special tokens (e.g. GO) + + + + + Search for the special token in the given + + The reader used to search the token + null when the token couldn't be found + + + + An interface to create a reader that is used to read the SQL script lines + + + + + Creates a reader + + null when no content was available + + + + A range searcher for ANSI-style SQL identifiers + + + + + Initializes a new instance of the class. + + + + + Utility class that handles single-character ranges (e.g. 'text') where the + end characters might be duplicated to escape it. + + + + + Initializes a new instance of the class. + + The character used for start and end + Is this a comment + + + + Initializes a new instance of the class. + + The start character + The end character + Is this a comment + + + + + + + + + + + + + + + + + + + A single line comment starting with two dashes (-- comment) + + + + + Initializes a new instance of the class. + + + + + The default multi-line comment (/* comment */) + + + + + Initializes a new instance of the class. + + + + + The MySQL identifier quotes using backticks + + + + + Initializes a new instance of the class. + + + + + An example implementation of a nested multi-line comment (e.g. /* comment /* nested */ */) + + + + + Initializes a new instance of the class. + + + + + + + + + + + + + + + + + + + + A single line comment starting with a pound sign (# comment) + + + + + Initializes a new instance of the class. + + + + + A single line comment starting with the specified start code + + + + + Initializes a new instance of the class. + + The start code for the single line comment + + + + Initializes a new instance of the class. + + The start code for the single line comment + Find the start code only at the beginning of the line + + + + + + + + + + + + + + + + + + + An SQL server style quoted identifer ([identifier]) + + + + + Initializes a new instance of the class. + + + + + A ANSI SQL string ('string') + + + + + Initializes a new instance of the class. + + + + + Ranges with multi-character start and end tokens (e.g. /* */) + + + Escaping is not supported. + + + + + Initializes a new instance of the class. + + The start- and end code string + Is this range a comment? + + + + Initializes a new instance of the class. + + The start code + The end code + Is this range a comment? + + + + + + + + + + + + + + + + + + + Represents the context for the operation + + + + + Initializes a new instance of the class. + + The range searchers + The special token searchers + Should the comments be stripped + + + + Gets the special token searchers + + + + + Gets the range searchers + + + + + Gets a value indicating whether the comments should be stripped + + + + + Event handler that is called when SQL statements should be collected + + + + + Event handler that is called when a special token was found + + + + + The main class to perform SQL batch collection + + + + + Initializes a new instance of the class. + + The search context + The reader to be read from + + + + Initializes a new instance of the class + + The search context + The reader to be read from + The stack of active ranges + The found special token + + + + Tries to find the next token or range + + null when no token or range could be found + + + + Search a special token + + The reader where the token should be searched in + The collection of searchers to test + null when no token could be found + + + + Search for the start of a range + + The reader where the range start token should be searched in + The collection of searchers to test + null when no range could be found + + + + Search for the end of a range + + null when no range end token could be found + + + + Search for a token or range start token + + + In other words: Search for everything that is allowed outside of a range. + + null if neither a token nor a range start sequence could be found + + + + Handle the case where a new range start sequence was found + + The reader where the sequence was found + Information about the start sequence + A new search status + + + + A implementation that uses lines as input + + + + + Initializes a new instance of the class. + + The collection of lines to be used as source + + + + + + + A implementation that uses a as source. + + + + + Initializes a new instance of the class. + + The text reader to use + + This function doesn't take ownership of the . + + + + + Initializes a new instance of the class. + + The text reader to use + true when the should become the owner of the + + + + + + + + + + Event arguments for a special token + + + + + Initializes a new instance of the class. + + The found token + An opaque (token specific) value + + + + Gets the found token + + + + + Gets an opaque (token specific) value + + + + + Provides special information about the found token + + + + + Initializes a new instance of the class. + + The index to the first character that is assigned to the + The content length that is assigned to the + The found token + An opaque (token specific) value + + The may not point to the real token text and the might be longer + than the itself. This is usually the case when the token should be the only text on the line, + but is instead surrounded by whitespace. + + + + + Gets the index to the first character that is assigned to the + + + + + Gets the content length that is assigned to the + + + + + Gets the found token + + + + + Gets an opaque (token specific) value + + + + + Searches for a "GO n" or "GO" token + + + + + + + + Additional values for the GO token + + + + + Initializes a new instance of the class. + + the number of times the batch should be executed + + + + Gets the number of times the batch should be executed + + + + + Searches for a semicolon + + + This special token searcher might be used to separate SQL statements in a batch. + + + + + + + + Event arguments for SQL text to be collected + + + + + Initializes a new instance of the class. + + The SQL text to be collected + true when a new line character should be appended + + + + Gets the SQL text to be collected + + + + + Gets a value indicating whether a new line character should be appended + + + + + This is the base implementation of the SQL batch parser + + + + + Initializes a new instance of the class. + + The range searchers to be used + The special token searchers to be used + The new line sequence to be used for the output + + + + An event handler that is called when a special token was found + + + + + An event handler that is called when an SQL text was collected and is considered complete + + + + + Process the + + The source to process/parse for SQL statement batches + true when the comments should be stripped + + + + Invokes the event + + The event arguments + + + + Invokes the event + + The event arguments + + + + Event arguments for the SQL text collected by the + + + + + Initializes a new instance of the class. + + The collected SQL text + + + + Gets the collected SQL text + + + + + Extension methods that work in and are using implementations. + + + + + Applies all conventions in a to the given . + + The expression to apply the convention set to + The convention set to apply to the expressions + A sequence of expressions where the conventions have been applied to + + + + Apply all conventions in a to the given . + + The expression type, derived from + The expression to apply the to + The convention set to apply to the + The same or a new instance of the expression. The underlying type of the expression must + not be changed. + + + + A convenience (empty) implementation of + + + + + Gets or sets the root path convention to be applied to implementations + + + + + Gets or sets the default schema name convention to be applied to implementations + + + This class cannot be overridden. The + must be implemented/provided instead. + + + + + + + + + + + + + + + + + + + + + + + The default implementation of a + + + It sets the default name of a constraint. + + + + + + + + The default implementation of a + + + It sets the default name of a foreign key. + + + + + + + + The default implementation of a + + + It sets the default name of an index. + + + + + + + + The default implementation of a + + + It sets the default constraint name of a primary key column. + + + + + + + + The default implementation of a + + + It sets the working directory, which is either the + path given in the constructor or - when the given path is + null - the current directory. + + + + + Initializes a new instance of the class. + + The root path for expressions requiring file system access. + When is null, then the current directory is + returned + + + + + + + The class handling the default schema name + + + This class handles all and additionally + implements other conventions that give access to schema names (e.g. + ). + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The default schema name + + + + Initializes a new instance of the class. + + The convention used to + return the default schema name for a given original schema name. + + + + Returns the default schema name depending on the original schema name + + The original schema name + Returns the when the + default schema name is null or empty and returns the new default + schema name when the is null + or empty + + + + Applies a convention to a + + The expression this convention should be applied to + The same or a new expression. The underlying type must stay the same. + + + + + + + + + + + + + + + + The default implementation of the + + + + + Initializes a new instance of the class. + + The default schema name (can be null or empty) + + + + + + + A convention working on implementations + + + + + Applies a convention to a + + The expression this convention should be applied to + The same or a new expression. The underlying type must stay the same. + + + + A convention working on implementations + + + + + Applies a convention to a + + The expression this convention should be applied to + The same or a new expression. The underlying type must stay the same. + + + + A convention working on implementations + + + + + Applies a convention to a + + The expression this convention should be applied to + The same or a new expression. The underlying type must stay the same. + + + + A set of conventions to be applied to expressions + + + + + Gets the root path convention to be applied to implementations + + + + + Gets the default schema name convention to be applied to implementations + + + This class cannot be overridden. The + must be implemented/provided instead. + + + + + Gets the conventions to be applied to implementations + + + + + Gets the conventions to be applied to implementations + + + + + Gets the conventions to be applied to implementations + + + + + Gets the conventions to be applied to implementations + + + + + Gets the conventions to be applied to implementations + + + + + Gets the conventions to be applied to implementations + + + + + A convention that returns the default schema name depending on the original schema name + + + + + Returns the default schema name depending on the original schema name + + The original schema name + Returns the when the + default schema name is null or empty and returns the new default + schema name when the is null + or empty + + + + A convention working on implementations + + + + + Applies a convention to a + + The expression this convention should be applied to + The same or a new expression. The underlying type must stay the same. + + + + A convention working on implementations + + + + + Applies a convention to a + + The expression this convention should be applied to + The same or a new expression. The underlying type must stay the same. + + + + A convention working on implementations + + + + + Applies a convention to a + + The expression this convention should be applied to + The same or a new expression. The underlying type must stay the same. + + + + A convention working on implementations + + + + + Applies a convention to a + + The expression this convention should be applied to + The same or a new expression. The underlying type must stay the same. + + + + Gets the name of the primary key constraint. Some Generators may need to override if the constraint name is limited + + + + + + Base class to generate descriptions for tables/classes + + + + + Outputs a create table string + + + + + + + + + + Gets the separator between identifiers (e.g. the dot between SCHEMA.TABLENAME) + + + + + Returns the opening quote identifier - " is the standard according to the specification + + + + + Returns the closing quote identifier - " is the standard according to the specification + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Generate SQL statements to set descriptions for tables and columns + + + + + The interface to be implemented for handling quotes + + + + + Returns a quoted string that has been correctly escaped + + + + + Provides an unquoted, unescaped string + + + + + Quotes a value to be embedded into an SQL script/statement + + The value to be quoted + The quoted value + + + + Returns true is the value starts and ends with a close quote + + + + + Quotes a column name + + + + + Quotes a Table name + + + + + Quote an index name + + + + + Quotes a constraint name + + + + + Quotes a Sequence name + + + + + Quotes a schema name + + The schema name to quote + The quoted schema name + + + diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Db2.dll b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Db2.dll new file mode 100644 index 0000000..40852cf Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Db2.dll differ diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Db2.xml b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Db2.xml new file mode 100644 index 0000000..458c3a5 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Db2.xml @@ -0,0 +1,13 @@ + + + + FluentMigrator.Runner.Db2 + + + + + The setup type maps. + + + + diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Firebird.dll b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Firebird.dll new file mode 100644 index 0000000..bf5b6f9 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Firebird.dll differ diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Firebird.xml b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Firebird.xml new file mode 100644 index 0000000..135cb37 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Firebird.xml @@ -0,0 +1,53 @@ + + + + FluentMigrator.Runner.Firebird + + + + + ALTER TABLE table_name ALTER column_name { DROP | SET } [NOT] NULL + + + + + Automatically starts a new transaction when a virtual lock check fails + + + + + Automaticaly commits every processed statement + + + + + Don't manage transactions + + + + + Maximum internal length of names in firebird is 31 characters + + + + + Firebird only supports constraint, table, column, etc. names up to 31 characters + + + + + Virtually lock tables and columns touched by DDL statements in a transaction + + + + + Gets or sets a value indicating whether all names should be quoted unconditionally. + + + + + Which transaction model to use if any to work around firebird's DDL restrictions + + + + diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Hana.dll b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Hana.dll new file mode 100644 index 0000000..0ceccc6 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Hana.dll differ diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Hana.xml b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Hana.xml new file mode 100644 index 0000000..a745b7b --- /dev/null +++ b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Hana.xml @@ -0,0 +1,8 @@ + + + + FluentMigrator.Runner.Hana + + + + diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Jet.dll b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Jet.dll new file mode 100644 index 0000000..f8c402c Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Jet.dll differ diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Jet.xml b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Jet.xml new file mode 100644 index 0000000..6b38cb2 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Jet.xml @@ -0,0 +1,8 @@ + + + + FluentMigrator.Runner.Jet + + + + diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.MySql.dll b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.MySql.dll new file mode 100644 index 0000000..6d7b59d Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.MySql.dll differ diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.MySql.xml b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.MySql.xml new file mode 100644 index 0000000..f247b11 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.MySql.xml @@ -0,0 +1,8 @@ + + + + FluentMigrator.Runner.MySql + + + + diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Oracle.dll b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Oracle.dll new file mode 100644 index 0000000..abf0356 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Oracle.dll differ diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Oracle.xml b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Oracle.xml new file mode 100644 index 0000000..972c25d --- /dev/null +++ b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Oracle.xml @@ -0,0 +1,8 @@ + + + + FluentMigrator.Runner.Oracle + + + + diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Postgres.dll b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Postgres.dll new file mode 100644 index 0000000..f0d27d3 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Postgres.dll differ diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Postgres.xml b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Postgres.xml new file mode 100644 index 0000000..57a7aee --- /dev/null +++ b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Postgres.xml @@ -0,0 +1,14 @@ + + + + FluentMigrator.Runner.Postgres + + + + + almost copied from OracleDescriptionGenerator, + modified for escaping table description + + + + diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Redshift.dll b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Redshift.dll new file mode 100644 index 0000000..ee182c2 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Redshift.dll differ diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Redshift.xml b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Redshift.xml new file mode 100644 index 0000000..45f64ed --- /dev/null +++ b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.Redshift.xml @@ -0,0 +1,14 @@ + + + + FluentMigrator.Runner.Redshift + + + + + almost copied from OracleDescriptionGenerator, + modified for escaping table description + + + + diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.SQLite.dll b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.SQLite.dll new file mode 100644 index 0000000..c6b904b Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.SQLite.dll differ diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.SQLite.xml b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.SQLite.xml new file mode 100644 index 0000000..27c8d57 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.SQLite.xml @@ -0,0 +1,24 @@ + + + + FluentMigrator.Runner.SQLite + + + + + A specialization of the for the Microsoft SQL Server + + + It uses the following range searchers: , , + , , + and the following token searchers: . + + + + + Initializes a new instance of the class. + + The string used to write a new line sequence + + + diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.SqlAnywhere.dll b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.SqlAnywhere.dll new file mode 100644 index 0000000..8e911e8 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.SqlAnywhere.dll differ diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.SqlAnywhere.xml b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.SqlAnywhere.xml new file mode 100644 index 0000000..d034a58 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.SqlAnywhere.xml @@ -0,0 +1,24 @@ + + + + FluentMigrator.Runner.SqlAnywhere + + + + + A specialization of the for the Microsoft SQL Server + + + It uses the following range searchers: , , + , , + and the following token searchers: . + + + + + Initializes a new instance of the class. + + The string used to write a new line sequence + + + diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.SqlServer.dll b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.SqlServer.dll new file mode 100644 index 0000000..5e22f77 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.SqlServer.dll differ diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.SqlServer.xml b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.SqlServer.xml new file mode 100644 index 0000000..7468ed0 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.SqlServer.xml @@ -0,0 +1,24 @@ + + + + FluentMigrator.Runner.SqlServer + + + + + A specialization of the for the Microsoft SQL Server + + + It uses the following range searchers: , , + , , + and the following token searchers: . + + + + + Initializes a new instance of the class. + + The string used to write a new line sequence + + + diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.SqlServerCe.dll b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.SqlServerCe.dll new file mode 100644 index 0000000..2e85e15 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.SqlServerCe.dll differ diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.SqlServerCe.xml b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.SqlServerCe.xml new file mode 100644 index 0000000..854ebe7 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.SqlServerCe.xml @@ -0,0 +1,8 @@ + + + + FluentMigrator.Runner.SqlServerCe + + + + diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.dll b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.dll new file mode 100644 index 0000000..b76adcc Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.dll differ diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.xml b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.xml new file mode 100644 index 0000000..529dcc0 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/FluentMigrator.Runner.xml @@ -0,0 +1,123 @@ + + + + FluentMigrator.Runner + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets or sets a value indicating whether the migration runner is allowed to apply breaking changes + + + + + Gets or sets the arbitrary application context passed to the task runner + + + + + Gets or sets the default schema name + + + + + Locates connection strings by name in assembly's config file or machine.config + If no connection matches it uses the specified connection string as valid connection + + + + + Understand .NET config mechanism and provides access to Configuration sections + + + + + + + + + + + + + + Checks whether the current task will actually run any migrations. + Can be used to decide whether it's necessary perform a backup before the migrations are executed. + + + + + execute each migration expression in the expression collection + + + + + + Validates each migration expression that has implemented the ICanBeValidated interface. + It throws an InvalidMigrationException exception if validation fails. + + The current migration being run + All the expressions contained in the up or down action + + + + Advanced searching and filtration of types collections. + + + + + Searches for types located in the specifying namespace and optionally in its nested namespaces. + + Source types collection to search in. + Namespace to search types in. Set to null or empty string to search in all namespaces. + Set to true to search for types located in nested namespaces of . + This parameter is ignored if is null or empty string. + + Collection of types matching specified criteria. + + + + Provides access to ApplicationContext object. + + + ApplicationContext value is set by FluentMigrator immediately after instantiation of a class + implementing IVersionTableMetaData and before any of properties of IVersionTableMetaData + is called. Properties can use ApplicationContext value to implement context-depending logic. + + + + + Provides access to ApplicationContext object. + + + ApplicationContext value is set by FluentMigrator immediately after instantiation of a class + implementing IVersionTableMetaData and before any of properties of IVersionTableMetaData + is called. Properties can use ApplicationContext value to implement context-depending logic. + + + + diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.dll b/packages/FAKE.5.16.0/tools/FluentMigrator.dll new file mode 100644 index 0000000..cd0ded1 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/FluentMigrator.dll differ diff --git a/packages/FAKE.5.16.0/tools/FluentMigrator.xml b/packages/FAKE.5.16.0/tools/FluentMigrator.xml new file mode 100644 index 0000000..b208c9a --- /dev/null +++ b/packages/FAKE.5.16.0/tools/FluentMigrator.xml @@ -0,0 +1,155 @@ + + + + FluentMigrator + + + + + This class provides a common location for logic pertaining to setting and maintaining + expressions for expression builders which manipulate the the ColumnDefinition. + + + This is a support class for the migrator framework and is not intended for external use. + TODO: make this internal, and the change assmebly info so InternalsVisibleTo is set for the test assemblies. + + + + + For each distinct column which has an existing row default, an instance of this + will be stored in the _expressionsByColumn. + + + + + For easy mockability only. + + + + + Either updates the IsNullable flag on the column, or creates/removes the SetNotNull expression, depending + on whether the column has a 'Set existing rows' expression. + + + + + Adds the existing row default value. If the column has a value for IsNullable, this will also + call SetNullable to create the expression, and will then set the column IsNullable to false. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + + + Allows for conditional inclusion of expresions based on the migration context + + + + + The context to add expressions into + + If the database type doe snot apply then this will be a new context that is not used by the caller + + + + Initializes a new instance of a the class that will only add expressions to the provided if matches the migration processor + + If the database type does not apply then a will be used as a container to void any fluent expressions that would have been executed + The context to add expressions to if the database type applies + The database type that the expressions relate to + + + + Initializes a new instance of a the class that will only add expressions to the provided if is true for the migration processor + + If the database type does not apply then a will be used as a container to void any fluent expressions that would have been executed + The context to add expressions to if the database type applies + The predicate that must be true for the expression to run + + + + Alter the schema of an existing object + + + + + Create a new database object + + + + + Delete a database object, table, or row + + + + + Rename tables / columns + + + + + Insert data into a table + + + + + Execute SQL statements + + + + + Update an existing row + + + + + Checks if the database type matches the name of the context migration processor + + The context to evaluate + The type to be checked + True if the database type applies, False if not + + + + Checks if the database type matches the name of the context migration processor + + The context to evaluate + The predicate to be evaluated + True if the database type applies, False if not + + + + Provides a null implmentation of a procesor that does not do any work + + + + The arbitrary application context passed to the task runner. + + + + Connection String from the runner. + + + + + This adapter wraps a migration into a MigrationInfo instance, used to keep IMigration backwards compatible with new IMigrationInfo. + + + + The arbitrary application context passed to the task runner. + + + + Connection String that is used to execute migrations. + + + + diff --git a/packages/FAKE.4.11.3/tools/HashLib.dll b/packages/FAKE.5.16.0/tools/HashLib.dll similarity index 100% rename from packages/FAKE.4.11.3/tools/HashLib.dll rename to packages/FAKE.5.16.0/tools/HashLib.dll diff --git a/packages/FAKE.4.11.3/tools/ICSharpCode.SharpZipLib.dll b/packages/FAKE.5.16.0/tools/ICSharpCode.SharpZipLib.dll similarity index 100% rename from packages/FAKE.4.11.3/tools/ICSharpCode.SharpZipLib.dll rename to packages/FAKE.5.16.0/tools/ICSharpCode.SharpZipLib.dll diff --git a/packages/FAKE.5.16.0/tools/Microsoft.Build.Utilities.v3.5.dll b/packages/FAKE.5.16.0/tools/Microsoft.Build.Utilities.v3.5.dll new file mode 100644 index 0000000..dcc5f0b Binary files /dev/null and b/packages/FAKE.5.16.0/tools/Microsoft.Build.Utilities.v3.5.dll differ diff --git a/packages/FAKE.5.16.0/tools/Microsoft.Build.Utilities.v3.5.xml b/packages/FAKE.5.16.0/tools/Microsoft.Build.Utilities.v3.5.xml new file mode 100644 index 0000000..a83b32c --- /dev/null +++ b/packages/FAKE.5.16.0/tools/Microsoft.Build.Utilities.v3.5.xml @@ -0,0 +1,504 @@ + + + + Microsoft.Build.Utilities.v3.5 + + + + Comprises utility methods for constructing a command line. + + + Initializes a new instance of the class. + + + Appends the command line with the file name of the specified object. + The task item specification to append to the command line. If it is null, then this method has no effect. + + + Appends the command line with file name represented by the parameter, inserting quotation marks if necessary. + The file name to append. If it is null, then this method has no effect. + + + Appends the command line with the list of file names in the specified array, separated by the specified delimiter. + The task item specifications to append. If the array is null, then this method has no effect. + The delimiter to put between task item specifications in the command line. + + + Appends the command line with the list of file names in the specified string array, separated by the specified delimiter. + The file names to append. If the array is null, then this method has no effect. + The delimiter to put between file names in the command line. + + + Appends the command line with a file name, and surrounds the file name with quotation marks as necessary. + The file name to append. + + + Adds a space to the specified string, given the string is not empty. + + + Appends the command line with the specified switch. + The name of the switch to append to the command line. This value cannot be null. + + + Appends the command line with a switch that takes a task item specification that acts a single string parameter. + The name of the switch to append to the command line. This value cannot be null. + The switch parameter to append to the command line. Quotation marks will be added as necessary. If this value is null, then this method has no effect. + + + Appends the command line with a switch that takes an array of task item specifications that act as string parameters. + The name of the switch to append to the command line. This value cannot be null. + An array of switch parameters to append to the command line. Quotation marks will be added as necessary. If the array is null, then this method has no effect. + The delimiter that separates individual parameters. This value can be empty, but it cannot be null. + + + Appends the command line with a switch that takes a single string parameter. + The name of the switch to append to the command line. This value cannot be null. + The switch parameter to append to the command line. Quotation marks will be added as necessary. If this value is null, then this method has no effect. + + + Appends the command line with a switch that takes an array of string parameters. + The name of the switch to append to the command line. This value cannot be null. + An array of switch parameters to append to the command line. Quotation marks will be added as necessary. If the array is null, then this method has no effect. + The delimiter that separates individual parameters. This value can be empty, but it cannot be null. + + + Appends the command line with a switch that takes a task item specification as a single string parameter, without attempting to encapsulate the switch parameter with quotation marks. + The name of the switch to append to the command line. This value cannot be null. + The switch parameter to append to the command line. Quotation marks will not be added. If this value is null, then this method has no effect. + + + Appends the command line with a switch that takes an array of task item specifications that act as string parameters, without attempting to encapsulate them with quotation marks. + The name of the switch to append to the command line. This value cannot be null. + An array of switch parameters to append to the command line. Quotation marks will not be added. If the array is null, then this method has no effect. + The delimiter that separates individual parameters. This value can be empty, but it cannot be null. + + + Appends the command line with a switch that takes a single string parameter, without attempting to encapsulate the switch parameter with quotation marks. + The name of the switch to append to the command line. This value cannot be null. + The switch parameter to append to the command line. Quotation marks will not be added. If this value is null, then this method has no effect. + + + Appends the command line with a switch that takes an array of string parameters, without attempting to encapsulate switch parameters with quotation marks. + The name of the switch to append to the command line. This value cannot be null. + An array of switch parameters to append to the command line. Quotation marks will not be added. If the array is null, then this method has no effect. + The delimiter that separates individual parameters. This value can be empty, but it cannot be null. + + + Appends the command line with string, without attempting to encapsulate the string with quotation marks. + The string to append to the command line. + + + Appends the command line with string, and surrounds the string with quotations marks as necessary. + The string to append to the command line. + + + Gets the instance representing the command line for inheriting classes. + A for inheriting classes. + + + Determines whether the specified string parameter should be surrounded with quotation marks because it contains white space. + true, if the switch parameter should be surrounded with quotation marks; otherwise, false. + The string to examine for characters that require quotation marks. + + + Returns the command line as a string. + A that represents the command line. + + + Returns an error if the command line parameter contains a double-quote (") character. Because double quotes are illegal in command line parameters, this method helps prevent parameter injection attacks. + A string representing the switch name for the error message. + A string representing the switch parameter to scan for double-quotes. + + + + + When overridden in a derived form, provides functionality for loggers that handle events raised by the MSBuild engine. + + + Initializes a new instance of the class. + + + Generates an error message that is in the default format, from a object. + A that represents an error message in canonical format. + The arguments of the error event. + + + Generates a warning message that is in the default format, from a object. + A that represents a warning message in canonical format. + The arguments of the warning event. + + + When overridden in a derived class, subscribes the logger to specific events. + The available events that a logger can subscribe to. + + + Determines whether the current setting is at least the value that is passed in. + true if the current logger verbosity setting is at least the value that is passed in; otherwise, false. + The logger verbosity setting passed in. + + + Gets or sets the user-defined parameters of the logger. + The logger parameters. This value can be null. + + + When overridden in a derived class, releases the resources allocated to the logger at the time of initialization or during the build. + + + Gets or sets the level of detail to show in the event log. + One of the enumeration values. The default is . + + + Determines the correct tool in the Toolset that MSBuild should use, based on the current system's processor architecture. + + + Represents the AMD64 processor. + + + Gets the current processor architecture of the system. + A string containing the processor architecture value. + + + Represents the IA64 processor. + + + Represents MSIL. + + + Represents an x86 processor. + + + Gets the instance of the object used by the task. + The available to tasks. + + + Provides helper logging methods used by tasks. + + + Initializes a new instance of the class and associates it with the specified task instance. + The task containing an instance of this task. + + + Gets the build engine that is associated with the task. + An that represents the instance of the build engine that is associated with the task. + + + Extracts the message code prefix from the given full message string. + The message code prefix that is extracted from the full message string, or null if there is no message code. + The full message to parse that includes code prefix. + The message with the code prefix removed. + + is null. + + + Loads the specified resource string and optionally formats it using the given arguments. + The formatted string. + The name of the string resource to load. + Optional arguments for formatting the loaded string. + + is null. + The string resource indicated by does not exist. + The property of the owner task is not set. + + + Formats the given string using the given arguments. + The formatted string. + The string to format. + Arguments for formatting. + + is null. + + + Gets a value that indicates whether the task has logged any errors through this logging helper object. + true if the task has logged any errors through this logging helper object; otherwise, false. + + + Gets or sets the prefix used to compose Help keywords from resource names. + The prefix used to compose Help keywords from resource names. + + + Logs the command line for an underlying tool, executable file, or shell command of a task using the specified importance level. + One of the values of that indicates the importance level of the command line. + The command line string. + + + Logs the command line for an underlying tool, executable file, or shell command of a task. + The command line string. + + + Logs an error with the specified message. + The message. + Optional arguments for formatting the message string. + + is null. + + + Logs an error using the specified message and other error details. + The description of the error type. + The error code. + The Help keyword to associate with the error. + The path to the file containing the error. + The line in the file where the error occurs. + The column in the file where the error occurs. + The end line in the file where the error occurs. + The end column in the file where the error occurs. + The message. + Optional arguments for formatting the message string. + + is null. + + + Logs an error using the message from the given exception. + The exception to log. + + is null. + 2 + + + Logs an error using the message, and optionally the stack trace, from the given exception. + The exception to log + true to include the stack trace in the log; otherwise, false. + + is null. + 2 + + + Logs an error using the specified resource string. + The name of the string resource to load. + The arguments for formatting the loaded string. + + is null. + 2 + + + Logs an error using the specified resource string and other error details. + The name of the string resource that describes the error type. + The error code. + The Help keyword to associate with the error. + The path to the file containing the error. + The line in the file where the error occurs. + The column in the file where the error occurs. + The end line in the file where the error occurs. + The end column in the file where the error occurs. + The name of the string resource to load. + The arguments for formatting the loaded string. + + is null. + 2 + + + Logs an error with an error code using the specified resource string. + The name of the string resource to load. + The arguments for formatting the loaded string. + + is null. + 2 + + + Logs an error using the specified resource string and other error details. + The name of the string resource that describes the error type. + The path to the file containing the error. + The line in the file where the error occurs. + The column in the file where the error occurs. + The end line in the file where the error occurs. + The end column in the file where the error occurs. + The name of the string resource to load. + The arguments for formatting the loaded string. + + is null. + 2 + + + Helps log the custom build event. + The text message. + The help keyword. + The name of the project. + true to indicate that project was built successfully; otherwise, false. + 2 + + + Helps log the custom build event. + The text message. + The help keyword. + The name of the project. + The targets to build. An empty string indicates default targets. + 2 + + + Logs a message with the specified string and importance. + One of the enumeration values that specifies the importance of the message. + The message. + The arguments for formatting the message. + + is null. + + + Logs a message with the specified string. + The message. + The arguments for formatting the message. + + is null. + + + Logs a message with the specified resource string and importance. + One of the enumeration values that specifies the importance of the message. + The name of the string resource to load. + The arguments for formatting the loaded string. + + is null. + 2 + + + Logs a message with the specified resource string. + The name of the string resource to load. + The arguments for formatting the loaded string. + + is null. + 2 + + + Logs an error message or warning from the given line of text. + true if an error was logged; otherwise, false. + The line of text to log from. + One of the values of that indicates the importance level of the command line. + + is null. + 2 + + + Logs errors, warnings, and messages for each line of text in the given file. + true to indicate at least one error was logged; otherwise, false. + The name of the file to log messages from. + + is null. + 2 + + + Logs errors, warnings, and messages for each line of text in the given file. Also logs the importance of messages. + true to indicate at least one error was logged; otherwise, false. + The name of the file to log messages from. + One of the enumeration values that specifies the importance of logged messages. + 2 + + + Logs an error message or warning from the given stream. + true if an error was logged; otherwise, false. + A that reads the stream to log from. + One of the values of that indicates the importance level of the command line. + + is null. + 2 + + + Logs a warning with the specified message. + The message. + Optional arguments for formatting the message string. + + is null. + + + Logs a warning using the specified message and other warning details. + The description of the warning type. + The warning code. + The Help keyword to associate with the warning. + The path to the file containing the warning. + The line in the file where the warning occurs. + The column in the file where the warning occurs. + The end line in the file where the warning occurs. + The end column in the file where the warning occurs. + The message. + Optional arguments for formatting the message string. + + is null. + + + Logs a warning using the message from the specified exception. + The exception to log. + + is null. + 2 + + + Logs a warning using the message, and optionally the stack trace, from the given exception. + The exception to log + true to include the stack trace in the log; otherwise, false. + + is null. + 2 + + + Logs a warning using the specified resource string. + The name of the string resource to load. + The arguments for formatting the loaded string. + + is null. + 2 + + + Logs a warning using the specified resource string and other warning details. + The name of the string resource that describes the warning type. + The warning code. + The Help keyword to associate with the warning. + The path to the file containing the warning. + The line in the file where the warning occurs. + The column in the file where the warning occurs. + The end line in the file where the warning occurs. + The end column in the file where the warning occurs. + The name of the string resource to load. + The arguments for formatting the loaded string. + + is null. + 2 + + + Logs a warning with a warning code using the specified resource string. + The name of the string resource to load. + The arguments for formatting the loaded string. + + is null. + 2 + + + Logs a warning with a warning code using the specified resource string and other warning details. + The name of the string resource that describes the warning type. + The path to the file containing the warning. + The line in the file where the warning occurs. + The column in the file where the warning occurs. + The end line in the file where the warning occurs. + The end column in the file where the warning occurs. + The name of the string resource to load. + The arguments for formatting the loaded string. + + is null. + 2 + + + Gets the name of the parent task. + The name of the parent task. + + + Gets or sets the culture-specific resources used by the logging methods. + A that represents the culture-specific resources used by the logging methods. This value can be null. + 2 + + + Logs an error using the message, and optionally the stack-trace from the given exception and any inner exceptions. + The exception to log. + true to include the stack trace in the log; otherwise, false. + true to log exception types and any inner exceptions; otherwise, false. + The name of the file related to the exception, or null if the project file should be logged. + + is null. + 2 + + + + + Deletes the specified temporary file. + The name of the temporary file to delete. + + + + + + + \ No newline at end of file diff --git a/packages/FAKE.4.11.3/tools/Microsoft.SqlServer.ConnectionInfo.dll b/packages/FAKE.5.16.0/tools/Microsoft.SqlServer.ConnectionInfo.dll similarity index 100% rename from packages/FAKE.4.11.3/tools/Microsoft.SqlServer.ConnectionInfo.dll rename to packages/FAKE.5.16.0/tools/Microsoft.SqlServer.ConnectionInfo.dll diff --git a/packages/FAKE.4.11.3/tools/Microsoft.SqlServer.Management.Sdk.Sfc.dll b/packages/FAKE.5.16.0/tools/Microsoft.SqlServer.Management.Sdk.Sfc.dll similarity index 100% rename from packages/FAKE.4.11.3/tools/Microsoft.SqlServer.Management.Sdk.Sfc.dll rename to packages/FAKE.5.16.0/tools/Microsoft.SqlServer.Management.Sdk.Sfc.dll diff --git a/packages/FAKE.4.11.3/tools/Microsoft.SqlServer.Smo.dll b/packages/FAKE.5.16.0/tools/Microsoft.SqlServer.Smo.dll similarity index 100% rename from packages/FAKE.4.11.3/tools/Microsoft.SqlServer.Smo.dll rename to packages/FAKE.5.16.0/tools/Microsoft.SqlServer.Smo.dll diff --git a/packages/FAKE.4.11.3/tools/Microsoft.Web.Administration.dll b/packages/FAKE.5.16.0/tools/Microsoft.Web.Administration.dll similarity index 100% rename from packages/FAKE.4.11.3/tools/Microsoft.Web.Administration.dll rename to packages/FAKE.5.16.0/tools/Microsoft.Web.Administration.dll diff --git a/packages/FAKE.5.16.0/tools/Microsoft.Web.XmlTransform.dll b/packages/FAKE.5.16.0/tools/Microsoft.Web.XmlTransform.dll new file mode 100644 index 0000000..753c1b4 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/Microsoft.Web.XmlTransform.dll differ diff --git a/packages/FAKE.5.16.0/tools/Microsoft.Win32.Primitives.dll b/packages/FAKE.5.16.0/tools/Microsoft.Win32.Primitives.dll new file mode 100644 index 0000000..8b69a69 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/Microsoft.Win32.Primitives.dll differ diff --git a/packages/FAKE.5.16.0/tools/Mono.Cecil.Mdb.dll b/packages/FAKE.5.16.0/tools/Mono.Cecil.Mdb.dll new file mode 100644 index 0000000..89fcbca Binary files /dev/null and b/packages/FAKE.5.16.0/tools/Mono.Cecil.Mdb.dll differ diff --git a/packages/FAKE.5.16.0/tools/Mono.Cecil.Pdb.dll b/packages/FAKE.5.16.0/tools/Mono.Cecil.Pdb.dll new file mode 100644 index 0000000..06199b4 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/Mono.Cecil.Pdb.dll differ diff --git a/packages/FAKE.5.16.0/tools/Mono.Cecil.Rocks.dll b/packages/FAKE.5.16.0/tools/Mono.Cecil.Rocks.dll new file mode 100644 index 0000000..f68136f Binary files /dev/null and b/packages/FAKE.5.16.0/tools/Mono.Cecil.Rocks.dll differ diff --git a/packages/FAKE.5.16.0/tools/Mono.Cecil.dll b/packages/FAKE.5.16.0/tools/Mono.Cecil.dll new file mode 100644 index 0000000..3e46a18 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/Mono.Cecil.dll differ diff --git a/packages/FAKE.5.16.0/tools/Newtonsoft.Json.dll b/packages/FAKE.5.16.0/tools/Newtonsoft.Json.dll new file mode 100644 index 0000000..4395f61 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/Newtonsoft.Json.dll differ diff --git a/packages/FAKE.4.11.3/tools/Newtonsoft.Json.xml b/packages/FAKE.5.16.0/tools/Newtonsoft.Json.xml similarity index 62% rename from packages/FAKE.4.11.3/tools/Newtonsoft.Json.xml rename to packages/FAKE.5.16.0/tools/Newtonsoft.Json.xml index 679c7c6..c1c32cd 100644 --- a/packages/FAKE.4.11.3/tools/Newtonsoft.Json.xml +++ b/packages/FAKE.5.16.0/tools/Newtonsoft.Json.xml @@ -4,7238 +4,9238 @@ Newtonsoft.Json - + - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + Represents a BSON Oid (object id). - + - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + Gets or sets the value of the Oid. + The value of the Oid. - + - Initializes a new instance of the class with the specified . + Initializes a new instance of the class. + The Oid value. - + - Reads the next JSON token from the stream. + Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. - true if the next token was read successfully; false if there are no more tokens to read. - + - Reads the next JSON token from the stream as a . + Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. - A . This method will return null at the end of an array. + + true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. + - + - Reads the next JSON token from the stream as a . + Gets or sets a value indicating whether the root object will be read as a JSON array. - A . This method will return null at the end of an array. + + true if the root object will be read as a JSON array; otherwise, false. + - + - Reads the next JSON token from the stream as a []. + Gets or sets the used when reading values from BSON. - A [] or a null reference if the next JSON token is null. This method will return null at the end of an array. + The used when reading values from BSON. - + - Reads the next JSON token from the stream as a . + Initializes a new instance of the class. - A . This method will return null at the end of an array. + The containing the BSON data to read. - + - Reads the next JSON token from the stream as a . + Initializes a new instance of the class. - A . This method will return null at the end of an array. + The containing the BSON data to read. - + - Reads the next JSON token from the stream as a . + Initializes a new instance of the class. - A . This method will return null at the end of an array. + The containing the BSON data to read. + if set to true the root object will be read as a JSON array. + The used when reading values from BSON. - + - Skips the children of the current token. + Initializes a new instance of the class. + The containing the BSON data to read. + if set to true the root object will be read as a JSON array. + The used when reading values from BSON. - + - Sets the current token. + Reads the next JSON token from the underlying . - The new token. + + true if the next token was read successfully; false if there are no more tokens to read. + - + - Sets the current token and value. + Changes the reader's state to . + If is set to true, the underlying is also closed. - The new token. - The value. - + - Sets the state based on current token type. + Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. - + - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + Gets or sets the used when writing values to BSON. + When set to no conversion will occur. + The used when writing values to BSON. - + - Releases unmanaged and - optionally - managed resources + Initializes a new instance of the class. - true to release both managed and unmanaged resources; false to release only unmanaged resources. + The to write to. - + - Changes the to Closed. + Initializes a new instance of the class. + The to write to. - + - Gets the current reader state. + Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. - The current reader state. - + - Gets or sets a value indicating whether the underlying stream or - should be closed when the reader is closed. + Writes the end. - - true to close the underlying stream or when - the reader is closed; otherwise false. The default is true. - + The token. - + - Gets or sets a value indicating whether multiple pieces of JSON content can - be read from a continuous stream without erroring. + Writes a comment /*...*/ containing the specified text. - - true to support reading multiple pieces of JSON content; otherwise false. The default is false. - + Text to place inside the comment. - + - Gets the quotation mark character used to enclose the value of a string. + Writes the start of a constructor with the given name. + The name of the constructor. - + - Get or set how time zones are handling when reading JSON. + Writes raw JSON. + The raw JSON to write. - + - Get or set how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + Writes raw JSON where a value is expected and updates the writer's state. + The raw JSON to write. - + - Get or set how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + Writes the beginning of a JSON array. - + - Get or set how custom date formatted strings are parsed when reading JSON. + Writes the beginning of a JSON object. - + - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + Writes the property name of a name/value pair on a JSON object. + The name of the property. - + - Gets the type of the current JSON token. + Closes this writer. + If is set to true, the underlying is also closed. + If is set to true, the JSON is auto-completed. - + - Gets the text value of the current JSON token. + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + The value to write. - + - Gets The Common Language Runtime (CLR) type for the current JSON token. + Writes a null value. - + - Gets the depth of the current token in the JSON document. + Writes an undefined value. - The depth of the current token in the JSON document. - + - Gets the path of the current JSON token. + Writes a value. + The value to write. - + - Gets or sets the culture used when reading JSON. Defaults to . + Writes a value. + The value to write. - + - Specifies the state of the reader. + Writes a value. + The value to write. - + - The Read method has not been called. + Writes a value. + The value to write. - + - The end of the file has been reached successfully. + Writes a value. + The value to write. - + - Reader is at a property. + Writes a value. + The value to write. - + - Reader is at the start of an object. + Writes a value. + The value to write. - + - Reader is in an object. + Writes a value. + The value to write. - + - Reader is at the start of an array. + Writes a value. + The value to write. - + - Reader is in an array. + Writes a value. + The value to write. - + - The Close method has been called. + Writes a value. + The value to write. - + - Reader has just read a value. + Writes a value. + The value to write. - + - Reader is at the start of a constructor. + Writes a value. + The value to write. - + - Reader in a constructor. + Writes a value. + The value to write. - + - An error occurred that prevents the read operation from continuing. + Writes a value. + The value to write. - + - The end of the file has been reached successfully. + Writes a value. + The value to write. - + - Initializes a new instance of the class. + Writes a [] value. - The stream. + The [] value to write. - + - Initializes a new instance of the class. + Writes a value. - The reader. + The value to write. - + - Initializes a new instance of the class. + Writes a value. - The stream. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. + The value to write. - + - Initializes a new instance of the class. + Writes a value. - The reader. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. + The value to write. - + - Reads the next JSON token from the stream as a []. + Writes a [] value that represents a BSON object id. - - A [] or a null reference if the next JSON token is null. This method will return null at the end of an array. - + The Object ID value to write. - + - Reads the next JSON token from the stream as a . + Writes a BSON regex. - A . This method will return null at the end of an array. + The regex pattern. + The regex options. - + - Reads the next JSON token from the stream as a . + Specifies how constructors are used when initializing objects during deserialization by the . - A . This method will return null at the end of an array. - + - Reads the next JSON token from the stream as a . + First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. - A . This method will return null at the end of an array. - + - Reads the next JSON token from the stream as a . + Json.NET will use a non-public default constructor before falling back to a parameterized constructor. - A . This method will return null at the end of an array. - + - Reads the next JSON token from the stream as a . + Converts a binary value to and from a base 64 string value. - - A . This method will return null at the end of an array. - - + - Reads the next JSON token from the stream. + Writes the JSON representation of the object. - - true if the next token was read successfully; false if there are no more tokens to read. - + The to write to. + The value. + The calling serializer. - + - Changes the to Closed. + Reads the JSON representation of the object. + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. - + - Gets or sets a value indicating whether binary data reading should compatible with incorrect Json.NET 3.5 written binary. + Determines whether this instance can convert the specified object type. - - true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. - + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + - + - Gets or sets a value indicating whether the root object will be read as a JSON array. + Converts a to and from JSON and BSON. - - true if the root object will be read as a JSON array; otherwise, false. - - + - Gets or sets the used when reading values from BSON. + Writes the JSON representation of the object. - The used when reading values from BSON. + The to write to. + The value. + The calling serializer. - + - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + Reads the JSON representation of the object. + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. - + - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + Determines whether this instance can convert the specified object type. + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + - + - Creates an instance of the JsonWriter class. + Creates a custom object. + The object type to convert. - + - Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream. + Writes the JSON representation of the object. + The to write to. + The value. + The calling serializer. - + - Closes this stream and the underlying stream. + Reads the JSON representation of the object. + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. - + - Writes the beginning of a JSON object. + Creates an object which will then be populated by the serializer. + Type of the object. + The created object. - + - Writes the end of a JSON object. + Determines whether this instance can convert the specified object type. + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + - + - Writes the beginning of a JSON array. + Gets a value indicating whether this can write JSON. + + true if this can write JSON; otherwise, false. + - + - Writes the end of an array. + Converts a to and from JSON. - + - Writes the start of a constructor with the given name. + Writes the JSON representation of the object. - The name of the constructor. + The to write to. + The value. + The calling serializer. - + - Writes the end constructor. + Reads the JSON representation of the object. + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. - + - Writes the property name of a name/value pair on a JSON object. + Determines whether this instance can convert the specified value type. - The name of the property. + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + - + - Writes the property name of a name/value pair on a JSON object. + Converts a to and from JSON. - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - + - Writes the end of the current JSON object or array. + Writes the JSON representation of the object. + The to write to. + The value. + The calling serializer. - + - Writes the current token and its children. + Reads the JSON representation of the object. - The to read the token from. + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. - + - Writes the current token. + Determines whether this instance can convert the specified value type. - The to read the token from. - A flag indicating whether the current token's children should be written. + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + - + - Writes the token and its value. + Provides a base class for converting a to and from JSON. - The to write. - - The value to write. - A value is only required for tokens that have an associated value, e.g. the property name for . - A null value can be passed to the method for token's that don't have a value, e.g. . - + - Writes the token. + Determines whether this instance can convert the specified object type. - The to write. + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + - + - Writes the specified end token. + Converts a F# discriminated union type to and from JSON. - The end token to write. - + - Writes indent characters. + Writes the JSON representation of the object. + The to write to. + The value. + The calling serializer. - + - Writes the JSON value delimiter. + Reads the JSON representation of the object. + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. - + - Writes an indent space. + Determines whether this instance can convert the specified object type. + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + - + - Writes a null value. + Converts an Entity Framework to and from JSON. - + - Writes an undefined value. + Writes the JSON representation of the object. + The to write to. + The value. + The calling serializer. - + - Writes raw JSON without changing the writer's state. + Reads the JSON representation of the object. - The raw JSON to write. + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. - + - Writes raw JSON where a value is expected and updates the writer's state. + Determines whether this instance can convert the specified object type. - The raw JSON to write. + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + - + - Writes a value. + Converts an to and from JSON. - The value to write. - + - Writes a value. + Writes the JSON representation of the object. - The value to write. + The to write to. + The value. + The calling serializer. - + - Writes a value. + Reads the JSON representation of the object. - The value to write. + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. - + - Writes a value. + Determines whether this instance can convert the specified object type. - The value to write. + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + - + - Writes a value. + Gets a value indicating whether this can write JSON. - The value to write. + + true if this can write JSON; otherwise, false. + - + - Writes a value. + Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). - The value to write. - + - Writes a value. + Gets or sets the date time styles used when converting a date to and from JSON. - The value to write. + The date time styles used when converting a date to and from JSON. - + - Writes a value. + Gets or sets the date time format used when converting a date to and from JSON. - The value to write. + The date time format used when converting a date to and from JSON. - + - Writes a value. + Gets or sets the culture used when converting a date to and from JSON. - The value to write. + The culture used when converting a date to and from JSON. - + - Writes a value. + Writes the JSON representation of the object. - The value to write. + The to write to. + The value. + The calling serializer. - + - Writes a value. + Reads the JSON representation of the object. - The value to write. + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. - + - Writes a value. + Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). - The value to write. - + - Writes a value. + Writes the JSON representation of the object. - The value to write. + The to write to. + The value. + The calling serializer. - + - Writes a value. + Reads the JSON representation of the object. - The value to write. + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. - + - Writes a value. + Converts a to and from JSON. - The value to write. - + - Writes a value. + Writes the JSON representation of the object. - The value to write. + The to write to. + The value. + The calling serializer. - + - Writes a value. + Reads the JSON representation of the object. - The value to write. + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. - + - Writes a value. + Determines whether this instance can convert the specified object type. - The value to write. + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + - + - Writes a value. + Converts a to and from JSON and BSON. - The value to write. - + - Writes a value. + Writes the JSON representation of the object. - The value to write. + The to write to. + The value. + The calling serializer. - + - Writes a value. + Reads the JSON representation of the object. - The value to write. + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. - + - Writes a value. + Determines whether this instance can convert the specified object type. - The value to write. + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + - + - Writes a value. + Converts an to and from its name string value. - The value to write. - + - Writes a value. + Gets or sets a value indicating whether the written enum text should be camel case. + The default value is false. - The value to write. + true if the written enum text will be camel case; otherwise, false. - + - Writes a value. + Gets or sets the naming strategy used to resolve how enum text is written. - The value to write. + The naming strategy used to resolve how enum text is written. - + - Writes a value. + Gets or sets a value indicating whether integer values are allowed when serializing and deserializing. + The default value is true. - The value to write. + true if integers are allowed when serializing and deserializing; otherwise, false. - + - Writes a value. + Initializes a new instance of the class. - The value to write. - + - Writes a value. + Initializes a new instance of the class. - The value to write. + true if the written enum text will be camel case; otherwise, false. - + - Writes a value. + Initializes a new instance of the class. - The value to write. + The naming strategy used to resolve how enum text is written. + true if integers are allowed when serializing and deserializing; otherwise, false. - + - Writes a value. + Initializes a new instance of the class. - The value to write. + The of the used to write enum text. - + - Writes a value. + Initializes a new instance of the class. - The value to write. + The of the used to write enum text. + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + - + - Writes a value. + Initializes a new instance of the class. - The value to write. + The of the used to write enum text. + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + true if integers are allowed when serializing and deserializing; otherwise, false. - + - Writes a value. + Writes the JSON representation of the object. - The value to write. + The to write to. + The value. + The calling serializer. - + - Writes a value. + Reads the JSON representation of the object. - The value to write. + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. - + - Writes a value. + Determines whether this instance can convert the specified object type. - The value to write. + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + - + - Writes a [] value. + Converts a to and from Unix epoch time - The [] value to write. - + - Writes a value. + Writes the JSON representation of the object. - The value to write. + The to write to. + The value. + The calling serializer. - + - Writes a value. - An error will raised if the value cannot be written as a single JSON token. + Reads the JSON representation of the object. - The value to write. + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. - + - Writes out a comment /*...*/ containing the specified text. + Converts a to and from a string (e.g. "1.2.3.4"). - Text to place inside the comment. - + - Writes out the given white space. + Writes the JSON representation of the object. - The string of white space characters. + The to write to. + The value. + The calling serializer. - + - Sets the state of the JsonWriter, + Reads the JSON representation of the object. - The JsonToken being written. - The value being written. + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. - + - Gets or sets a value indicating whether the underlying stream or - should be closed when the writer is closed. + Determines whether this instance can convert the specified object type. - - true to close the underlying stream or when - the writer is closed; otherwise false. The default is true. - + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + - + - Gets the top. + Converts XML to and from JSON. - The top. - + - Gets the state of the writer. + Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. + The name of the deserialized root element. - + - Gets the path of the writer. + Gets or sets a value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + true if the array attribute is written to the XML; otherwise, false. - + - Indicates how JSON text output is formatted. + Gets or sets a value indicating whether to write the root JSON object. + true if the JSON root object is omitted; otherwise, false. - + - Get or set how dates are written to JSON text. + Gets or sets a value indicating whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + true if special characters are encoded; otherwise, false. - + - Get or set how time zones are handling when writing JSON text. + Writes the JSON representation of the object. + The to write to. + The calling serializer. + The value. - + - Get or set how strings are escaped when writing JSON text. + Reads the JSON representation of the object. + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. - + - Get or set how special floating point numbers, e.g. , - and , - are written to JSON text. + Checks if the is a namespace attribute. + Attribute name to test. + The attribute name prefix if it has one, otherwise an empty string. + true if attribute name is for a namespace attribute, otherwise false. - + - Get or set how and values are formatting when writing JSON text. + Determines whether this instance can convert the specified value type. + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + - + - Gets or sets the culture used when writing JSON. Defaults to . + Specifies how dates are formatted when writing JSON text. - + - Initializes a new instance of the class. + Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". - The stream. - + - Initializes a new instance of the class. + Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". - The writer. - + - Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream. + Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. - + - Writes the end. + Date formatted strings are not parsed to a date type and are read as strings. - The token. - + - Writes out a comment /*...*/ containing the specified text. + Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - Text to place inside the comment. - + - Writes the start of a constructor with the given name. + Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - The name of the constructor. - + - Writes raw JSON. + Specifies how to treat the time value when converting between string and . - The raw JSON to write. - + - Writes raw JSON where a value is expected and updates the writer's state. + Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. - The raw JSON to write. - + - Writes the beginning of a JSON array. + Treat as a UTC. If the object represents a local time, it is converted to a UTC. - + - Writes the beginning of a JSON object. + Treat as a local time if a is being converted to a string. + If a string is being converted to , convert to a local time if a time zone is specified. - + - Writes the property name of a name/value pair on a JSON object. + Time zone information should be preserved when converting. - The name of the property. - + - Closes this stream and the underlying stream. + The default JSON name table implementation. - + - Writes a value. - An error will raised if the value cannot be written as a single JSON token. + Initializes a new instance of the class. - The value to write. - + - Writes a null value. + Gets a string containing the same characters as the specified range of characters in the given array. + The character array containing the name to find. + The zero-based index into the array specifying the first character of the name. + The number of characters in the name. + A string containing the same characters as the specified range of characters in the given array. - + - Writes an undefined value. + Adds the specified string into name table. + The string to add. + This method is not thread-safe. + The resolved string. - + - Writes a value. + Specifies default value handling options for the . - The value to write. + + + + - + - Writes a value. + Include members where the member value is the same as the member's default value when serializing objects. + Included members are written to JSON. Has no effect when deserializing. - The value to write. - + - Writes a value. + Ignore members where the member value is the same as the member's default value when serializing objects + so that it is not written to JSON. + This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, + decimals and floating point numbers; and false for booleans). The default value ignored can be changed by + placing the on the property. - The value to write. - + - Writes a value. + Members with a default value but no JSON will be set to their default value when deserializing. - The value to write. - + - Writes a value. + Ignore members where the member value is the same as the member's default value when serializing objects + and set members to their default value when deserializing. - The value to write. - + - Writes a value. + Specifies float format handling options when writing special floating point numbers, e.g. , + and with . - The value to write. - + - Writes a value. + Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". - The value to write. - + - Writes a value. + Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. + Note that this will produce non-valid JSON. - The value to write. - + - Writes a value. + Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. - The value to write. - + - Writes a value. + Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The value to write. - + - Writes a value. + Floating point numbers are parsed to . - The value to write. - + - Writes a value. + Floating point numbers are parsed to . - The value to write. - + - Writes a value. + Specifies formatting options for the . - The value to write. - + - Writes a value. + No special formatting is applied. This is the default. - The value to write. - + - Writes a value. + Causes child objects to be indented according to the and settings. - The value to write. - + - Writes a value. + Provides an interface for using pooled arrays. - The value to write. + The array type content. - + - Writes a [] value. + Rent an array from the pool. This array must be returned when it is no longer needed. - The [] value to write. + The minimum required length of the array. The returned array may be longer. + The rented array from the pool. This array must be returned when it is no longer needed. - + - Writes a value. + Return an array to the pool. - The value to write. + The array that is being returned. - + - Writes a value. + Provides an interface to enable a class to return line and position information. - The value to write. - + - Writes a value. + Gets a value indicating whether the class can return line information. - The value to write. + + true if and can be provided; otherwise, false. + - + - Writes a [] value that represents a BSON object id. + Gets the current line number. - The Object ID value to write. + The current line number or 0 if no line information is available (for example, when returns false). - + - Writes a BSON regex. + Gets the current line position. - The regex pattern. - The regex options. + The current line position or 0 if no line information is available (for example, when returns false). - + - Gets or sets the used when writing values to BSON. - When set to no conversion will occur. + Instructs the how to serialize the collection. - The used when writing values to BSON. - + - Represents a BSON Oid (object id). + Gets or sets a value indicating whether null items are allowed in the collection. + true if null items are allowed in the collection; otherwise, false. - + - Initializes a new instance of the class. + Initializes a new instance of the class. - The Oid value. - + - Gets or sets the value of the Oid. + Initializes a new instance of the class with a flag indicating whether the array can contain null items. - The value of the Oid. + A flag indicating whether the array can contain null items. - + - Converts a binary value to and from a base 64 string value. + Initializes a new instance of the class with the specified container Id. + The container Id. - + - Converts an object to and from JSON. + Instructs the to use the specified constructor when deserializing that object. - + - Writes the JSON representation of the object. + Instructs the how to serialize the object. - The to write to. - The value. - The calling serializer. - + - Reads the JSON representation of the object. + Gets or sets the id. - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. + The id. - + - Determines whether this instance can convert the specified object type. + Gets or sets the title. - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - + The title. - + - - Gets the of the JSON produced by the JsonConverter. - - - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. - + Gets or sets the description. - The of the JSON produced by the JsonConverter. + The description. - + - Gets a value indicating whether this can read JSON. + Gets or sets the collection's items converter. - true if this can read JSON; otherwise, false. + The collection's items converter. - + - Gets a value indicating whether this can write JSON. + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. - true if this can write JSON; otherwise, false. + + + [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + + - + - Writes the JSON representation of the object. + Gets or sets the of the . - The to write to. - The value. - The calling serializer. + The of the . - + - Reads the JSON representation of the object. + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. + + + [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + + - + - Determines whether this instance can convert the specified object type. + Gets or sets a value that indicates whether to preserve object references. - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - + + true to keep object reference; otherwise, false. The default is false. + - + - Converts a to and from JSON. + Gets or sets a value that indicates whether to preserve collection's items references. + + true to keep collection's items object references; otherwise, false. The default is false. + - + - Writes the JSON representation of the object. + Gets or sets the reference loop handling used when serializing the collection's items. - The to write to. - The value. - The calling serializer. + The reference loop handling. - + - Reads the JSON representation of the object. + Gets or sets the type name handling used when serializing the collection's items. - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. + The type name handling. - + - Determines whether this instance can convert the specified value type. + Initializes a new instance of the class. - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - + - Converts a to and from JSON. + Initializes a new instance of the class with the specified container Id. + The container Id. - + - Writes the JSON representation of the object. + Provides methods for converting between .NET types and JSON types. - The to write to. - The value. - The calling serializer. + + + - + - Reads the JSON representation of the object. + Gets or sets a function that creates default . + Default settings are automatically used by serialization methods on , + and and on . + To serialize without using any default settings create a with + . - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - + - Determines whether this instance can convert the specified value type. + Represents JavaScript's boolean value true as a string. This field is read-only. - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - + - Create a custom object + Represents JavaScript's boolean value false as a string. This field is read-only. - The object type to convert. - + - Writes the JSON representation of the object. + Represents JavaScript's null as a string. This field is read-only. - The to write to. - The value. - The calling serializer. - + - Reads the JSON representation of the object. + Represents JavaScript's undefined as a string. This field is read-only. - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - + - Creates an object which will then be populated by the serializer. + Represents JavaScript's positive infinity as a string. This field is read-only. - Type of the object. - The created object. - + - Determines whether this instance can convert the specified object type. + Represents JavaScript's negative infinity as a string. This field is read-only. - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - + - Gets a value indicating whether this can write JSON. + Represents JavaScript's NaN as a string. This field is read-only. - - true if this can write JSON; otherwise, false. - - + - Provides a base class for converting a to and from JSON. + Converts the to its JSON string representation. + The value to convert. + A JSON string representation of the . - + - Determines whether this instance can convert the specified object type. + Converts the to its JSON string representation using the specified. - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - + The value to convert. + The format the date will be converted to. + The time zone handling when the date is converted to a string. + A JSON string representation of the . - + - Converts a F# discriminated union type to and from JSON. + Converts the to its JSON string representation. + The value to convert. + A JSON string representation of the . - + - Writes the JSON representation of the object. + Converts the to its JSON string representation using the specified. - The to write to. - The value. - The calling serializer. + The value to convert. + The format the date will be converted to. + A JSON string representation of the . - + - Reads the JSON representation of the object. + Converts the to its JSON string representation. - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. + The value to convert. + A JSON string representation of the . - + - Determines whether this instance can convert the specified object type. + Converts the to its JSON string representation. - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - + The value to convert. + A JSON string representation of the . - + - Converts an Entity Framework EntityKey to and from JSON. + Converts the to its JSON string representation. + The value to convert. + A JSON string representation of the . - + - Writes the JSON representation of the object. + Converts the to its JSON string representation. - The to write to. - The value. - The calling serializer. + The value to convert. + A JSON string representation of the . - + - Reads the JSON representation of the object. + Converts the to its JSON string representation. - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. + The value to convert. + A JSON string representation of the . - + - Determines whether this instance can convert the specified object type. + Converts the to its JSON string representation. - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - + The value to convert. + A JSON string representation of the . - + - Converts an ExpandoObject to and from JSON. + Converts the to its JSON string representation. + The value to convert. + A JSON string representation of the . - + - Writes the JSON representation of the object. + Converts the to its JSON string representation. - The to write to. - The value. - The calling serializer. + The value to convert. + A JSON string representation of the . - + - Reads the JSON representation of the object. + Converts the to its JSON string representation. - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. + The value to convert. + A JSON string representation of the . - + - Determines whether this instance can convert the specified object type. + Converts the to its JSON string representation. - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - + The value to convert. + A JSON string representation of the . - + - Gets a value indicating whether this can write JSON. + Converts the to its JSON string representation. - - true if this can write JSON; otherwise, false. - - - + The value to convert. + A JSON string representation of the . + + - Converts a to and from JSON. + Converts the to its JSON string representation. + The value to convert. + A JSON string representation of the . - + - Writes the JSON representation of the object. + Converts the to its JSON string representation. - The to write to. - The value. - The calling serializer. + The value to convert. + A JSON string representation of the . - + - Reads the JSON representation of the object. + Converts the to its JSON string representation. - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. + The value to convert. + A JSON string representation of the . - + - Determines whether this instance can convert the specified object type. + Converts the to its JSON string representation. - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - + The value to convert. + A JSON string representation of the . - + - Converts a to and from JSON and BSON. + Converts the to its JSON string representation. + The value to convert. + A JSON string representation of the . - + - Writes the JSON representation of the object. + Converts the to its JSON string representation. - The to write to. - The value. - The calling serializer. + The value to convert. + A JSON string representation of the . - + - Reads the JSON representation of the object. + Converts the to its JSON string representation. - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. + The value to convert. + A JSON string representation of the . - + - Determines whether this instance can convert the specified object type. + Converts the to its JSON string representation. - Type of the object. + The value to convert. + The string delimiter character. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + The string delimiter character. + The string escape handling. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Serializes the specified object to a JSON string. + + The object to serialize. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using formatting. + + The object to serialize. + Indicates how the output should be formatted. - true if this instance can convert the specified object type; otherwise, false. + A JSON string representation of the object. - + - Converts a to and from JSON and BSON. + Serializes the specified object to a JSON string using a collection of . + The object to serialize. + A collection of converters used while serializing. + A JSON string representation of the object. - + - Writes the JSON representation of the object. + Serializes the specified object to a JSON string using formatting and a collection of . - The to write to. - The value. - The calling serializer. + The object to serialize. + Indicates how the output should be formatted. + A collection of converters used while serializing. + A JSON string representation of the object. - + - Reads the JSON representation of the object. + Serializes the specified object to a JSON string using . - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. + The object to serialize. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A JSON string representation of the object. + - + - Determines whether this instance can convert the specified object type. + Serializes the specified object to a JSON string using a type, formatting and . - Type of the object. + The object to serialize. + The used to serialize the object. + If this is null, default serialization settings will be used. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + - true if this instance can convert the specified object type; otherwise, false. + A JSON string representation of the object. - + - Converts an to and from its name string value. + Serializes the specified object to a JSON string using formatting and . + The object to serialize. + Indicates how the output should be formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A JSON string representation of the object. + - + - Initializes a new instance of the class. + Serializes the specified object to a JSON string using a type, formatting and . + + The object to serialize. + Indicates how the output should be formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + A JSON string representation of the object. + + + + + Deserializes the JSON to a .NET object. + + The JSON to deserialize. + The deserialized object from the JSON string. + + + + Deserializes the JSON to a .NET object using . + + The JSON to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type. + + The JSON to deserialize. + The of object being deserialized. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type. + + The type of the object to deserialize to. + The JSON to deserialize. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the given anonymous type. + + + The anonymous type to deserialize to. This can't be specified + traditionally and must be inferred from the anonymous type passed + as a parameter. + + The JSON to deserialize. + The anonymous type object. + The deserialized anonymous type from the JSON string. + + + + Deserializes the JSON to the given anonymous type using . + + + The anonymous type to deserialize to. This can't be specified + traditionally and must be inferred from the anonymous type passed + as a parameter. + + The JSON to deserialize. + The anonymous type object. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized anonymous type from the JSON string. + + + + Deserializes the JSON to the specified .NET type using a collection of . + + The type of the object to deserialize to. + The JSON to deserialize. + Converters to use while deserializing. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using . + + The type of the object to deserialize to. + The object to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using a collection of . + The JSON to deserialize. + The type of the object to deserialize. + Converters to use while deserializing. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using . + + The JSON to deserialize. + The type of the object to deserialize to. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Populates the object with values from the JSON string. + + The JSON to populate values from. + The target object to populate values onto. + + + + Populates the object with values from the JSON string using . + + The JSON to populate values from. + The target object to populate values onto. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + + + + Serializes the to a JSON string. + + The node to serialize. + A JSON string of the . + + + + Serializes the to a JSON string using formatting. + + The node to serialize. + Indicates how the output should be formatted. + A JSON string of the . + + + + Serializes the to a JSON string using formatting and omits the root object if is true. + + The node to serialize. + Indicates how the output should be formatted. + Omits writing the root object. + A JSON string of the . + + + + Deserializes the from a JSON string. + + The JSON string. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by . + + The JSON string. + The name of the root element to append when deserializing. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by + and writes a Json.NET array attribute for collections. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by , + writes a Json.NET array attribute for collections, and encodes special characters. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + + A value to indicate whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + The deserialized . + + + + Serializes the to a JSON string. + + The node to convert to JSON. + A JSON string of the . + + + + Serializes the to a JSON string using formatting. + + The node to convert to JSON. + Indicates how the output should be formatted. + A JSON string of the . + + + + Serializes the to a JSON string using formatting and omits the root object if is true. + + The node to serialize. + Indicates how the output should be formatted. + Omits writing the root object. + A JSON string of the . + + + + Deserializes the from a JSON string. + + The JSON string. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by . + + The JSON string. + The name of the root element to append when deserializing. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by + and writes a Json.NET array attribute for collections. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by , + writes a Json.NET array attribute for collections, and encodes special characters. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + + A value to indicate whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + The deserialized . + + + + Converts an object to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can read JSON. + + true if this can read JSON; otherwise, false. + + + + Gets a value indicating whether this can write JSON. + + true if this can write JSON; otherwise, false. + + + + Converts an object to and from JSON. + + The object type to convert. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. If there is no existing value then null will be used. + The existing value has a value. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Instructs the to use the specified when serializing the member or class. + + + + + Gets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + + + + + Initializes a new instance of the class. + + Type of the . + + + + Initializes a new instance of the class. + + Type of the . + Parameter list to use when constructing the . Can be null. + + + + Represents a collection of . + + + + + Instructs the how to serialize the collection. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + The exception thrown when an error occurs during JSON serialization or deserialization. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Instructs the to deserialize properties with no matching class member into the specified collection + and write values during serialization. + + + + + Gets or sets a value that indicates whether to write extension data when serializing the object. + + + true to write extension data when serializing the object; otherwise, false. The default is true. + + + + + Gets or sets a value that indicates whether to read extension data when deserializing the object. + + + true to read extension data when deserializing the object; otherwise, false. The default is true. + + + + + Initializes a new instance of the class. + + + + + Instructs the not to serialize the public field or public read/write property value. + + + + + Base class for a table of atomized string objects. + + + + + Gets a string containing the same characters as the specified range of characters in the given array. + + The character array containing the name to find. + The zero-based index into the array specifying the first character of the name. + The number of characters in the name. + A string containing the same characters as the specified range of characters in the given array. + + + + Instructs the how to serialize the object. + + + + + Gets or sets the member serialization. + + The member serialization. + + + + Gets or sets the missing member handling used when deserializing this object. + + The missing member handling. + + + + Gets or sets how the object's properties with null values are handled during serialization and deserialization. + + How the object's properties with null values are handled during serialization and deserialization. + + + + Gets or sets a value that indicates whether the object's properties are required. + + + A value indicating whether the object's properties are required. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified member serialization. + + The member serialization. + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Instructs the to always serialize the member with the specified name. + + + + + Gets or sets the type used when serializing the property's collection items. + + The collection's items type. + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the null value handling used when serializing this property. + + The null value handling. + + + + Gets or sets the default value handling used when serializing this property. + + The default value handling. + + + + Gets or sets the reference loop handling used when serializing this property. + + The reference loop handling. + + + + Gets or sets the object creation handling used when deserializing this property. + + The object creation handling. + + + + Gets or sets the type name handling used when serializing this property. + + The type name handling. + + + + Gets or sets whether this property's value is serialized as a reference. + + Whether this property's value is serialized as a reference. + + + + Gets or sets the order of serialization of a member. + + The numeric order of serialization. + + + + Gets or sets a value indicating whether this property is required. + + + A value indicating whether this property is required. + + + + + Gets or sets the name of the property. + + The name of the property. + + + + Gets or sets the reference loop handling used when serializing the property's collection items. + + The collection's items reference loop handling. + + + + Gets or sets the type name handling used when serializing the property's collection items. + + The collection's items type name handling. + + + + Gets or sets whether this property's collection items are serialized as a reference. + + Whether this property's collection items are serialized as a reference. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified name. + + Name of the property. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + + + + + Asynchronously reads the next JSON token from the source. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns true if the next token was read successfully; false if there are no more tokens to read. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously skips the children of the current token. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a []. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the []. This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Specifies the state of the reader. + + + + + A read method has not been called. + + + + + The end of the file has been reached successfully. + + + + + Reader is at a property. + + + + + Reader is at the start of an object. + + + + + Reader is in an object. + + + + + Reader is at the start of an array. + + + + + Reader is in an array. + + + + + The method has been called. + + + + + Reader has just read a value. + + + + + Reader is at the start of a constructor. + + + + + Reader is in a constructor. + + + + + An error occurred that prevents the read operation from continuing. + + + + + The end of the file has been reached successfully. + + + + + Gets the current reader state. + + The current reader state. + + + + Gets or sets a value indicating whether the source should be closed when this reader is closed. + + + true to close the source when this reader is closed; otherwise false. The default is true. + + + + + Gets or sets a value indicating whether multiple pieces of JSON content can + be read from a continuous stream without erroring. + + + true to support reading multiple pieces of JSON content; otherwise false. + The default is false. + + + + + Gets the quotation mark character used to enclose the value of a string. + + + + + Gets or sets how time zones are handled when reading JSON. + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Gets or sets how custom date formatted strings are parsed when reading JSON. + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + + + + + Gets the type of the current JSON token. + + + + + Gets the text value of the current JSON token. + + + + + Gets the .NET type for the current JSON token. + + + + + Gets the depth of the current token in the JSON document. + + The depth of the current token in the JSON document. + + + + Gets the path of the current JSON token. + + + + + Gets or sets the culture used when reading JSON. Defaults to . + + + + + Initializes a new instance of the class. + + + + + Reads the next JSON token from the source. + + true if the next token was read successfully; false if there are no more tokens to read. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a []. + + A [] or null if the next JSON token is null. This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Skips the children of the current token. + + + + + Sets the current token. + + The new token. + + + + Sets the current token and value. + + The new token. + The value. + + + + Sets the current token and value. + + The new token. + The value. + A flag indicating whether the position index inside an array should be updated. + + + + Sets the state based on current token type. + + + + + Releases unmanaged and - optionally - managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Changes the reader's state to . + If is set to true, the source is also closed. + + + + + The exception thrown when an error occurs while reading JSON text. + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The line number indicating where the error occurred. + The line position indicating where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Instructs the to always serialize the member, and to require that the member has a value. + + + + + The exception thrown when an error occurs during JSON serialization or deserialization. + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The line number indicating where the error occurred. + The line position indicating where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Serializes and deserializes objects into and from the JSON format. + The enables you to control how objects are encoded into JSON. + + + + + Occurs when the errors during serialization and deserialization. + + + + + Gets or sets the used by the serializer when resolving references. + + + + + Gets or sets the used by the serializer when resolving type names. + + + + + Gets or sets the used by the serializer when resolving type names. + + + + + Gets or sets the used by the serializer when writing trace messages. + + The trace writer. + + + + Gets or sets the equality comparer used by the serializer when comparing references. + + The equality comparer. + + + + Gets or sets how type name writing and reading is handled by the serializer. + The default value is . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how object references are preserved by the serializer. + The default value is . + + + + + Gets or sets how reference loops (e.g. a class referencing itself) is handled. + The default value is . + + + + + Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + The default value is . + + + + + Gets or sets how null values are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how default values are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how objects are created during deserialization. + The default value is . + + The object creation handling. + + + + Gets or sets how constructors are used during deserialization. + The default value is . + + The constructor handling. + + + + Gets or sets how metadata properties are used during deserialization. + The default value is . + + The metadata properties handling. + + + + Gets a collection that will be used during serialization. + + Collection that will be used during serialization. + + + + Gets or sets the contract resolver used by the serializer when + serializing .NET objects to JSON and vice versa. + + + + + Gets or sets the used by the serializer when invoking serialization callback methods. + + The context. + + + + Indicates how JSON text output is formatted. + The default value is . + + + + + Gets or sets how dates are written to JSON text. + The default value is . + + + + + Gets or sets how time zones are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + The default value is . + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + The default value is . + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written as JSON text. + The default value is . + + + + + Gets or sets how strings are escaped when writing JSON text. + The default value is . + + + + + Gets or sets how and values are formatted when writing JSON text, + and the expected date format when reading JSON text. + The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". + + + + + Gets or sets the culture used when reading JSON. + The default value is . + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is null. + + + + + Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. + The default value is false. + + + true if there will be a check for additional JSON content after deserializing an object; otherwise, false. + + + + + Initializes a new instance of the class. + + + + + Creates a new instance. + The will not use default settings + from . + + + A new instance. + The will not use default settings + from . + + + + + Creates a new instance using the specified . + The will not use default settings + from . + + The settings to be applied to the . + + A new instance using the specified . + The will not use default settings + from . + + + + + Creates a new instance. + The will use default settings + from . + + + A new instance. + The will use default settings + from . + + + + + Creates a new instance using the specified . + The will use default settings + from as well as the specified . + + The settings to be applied to the . + + A new instance using the specified . + The will use default settings + from as well as the specified . + + + + + Populates the JSON values onto the target object. + + The that contains the JSON structure to read values from. + The target object to populate values onto. + + + + Populates the JSON values onto the target object. + + The that contains the JSON structure to read values from. + The target object to populate values onto. + + + + Deserializes the JSON structure contained by the specified . + + The that contains the JSON structure to deserialize. + The being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The of object being deserialized. + The instance of being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The type of the object to deserialize. + The instance of being deserialized. - + - Writes the JSON representation of the object. + Deserializes the JSON structure contained by the specified + into an instance of the specified type. - The to write to. - The value. - The calling serializer. + The containing the object. + The of object being deserialized. + The instance of being deserialized. - + - Reads the JSON representation of the object. + Serializes the specified and writes the JSON structure + using the specified . - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. + The used to write the JSON structure. + The to serialize. - + - Determines whether this instance can convert the specified object type. + Serializes the specified and writes the JSON structure + using the specified . - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - + The used to write the JSON structure. + The to serialize. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + - + - Gets or sets a value indicating whether the written enum text should be camel case. + Serializes the specified and writes the JSON structure + using the specified . - true if the written enum text will be camel case; otherwise, false. + The used to write the JSON structure. + The to serialize. + + The type of the value being serialized. + This parameter is used when is Auto to write out the type name if the type of the value does not match. + Specifying the type is optional. + - + - Gets or sets a value indicating whether integer values are allowed. + Serializes the specified and writes the JSON structure + using the specified . - true if integers are allowed; otherwise, false. + The used to write the JSON structure. + The to serialize. - + - Specifies how constructors are used when initializing objects during deserialization by the . + Specifies the settings on a object. - + - First attempt to use the public default constructor, then fall back to single paramatized constructor, then the non-public default constructor. + Gets or sets how reference loops (e.g. a class referencing itself) are handled. + The default value is . + Reference loop handling. - + - Json.NET will use a non-public default constructor before falling back to a paramatized constructor. + Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + The default value is . + Missing member handling. - + - Converts a to and from a string (e.g. "1.2.3.4"). + Gets or sets how objects are created during deserialization. + The default value is . + The object creation handling. - + - Writes the JSON representation of the object. + Gets or sets how null values are handled during serialization and deserialization. + The default value is . - The to write to. - The value. - The calling serializer. + Null value handling. - + - Reads the JSON representation of the object. + Gets or sets how default values are handled during serialization and deserialization. + The default value is . - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. + The default value handling. - + - Determines whether this instance can convert the specified object type. + Gets or sets a collection that will be used during serialization. - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - + The converters. - + - Specifies float format handling options when writing special floating point numbers, e.g. , - and with . + Gets or sets how object references are preserved by the serializer. + The default value is . + The preserve references handling. - + - Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". + Gets or sets how type name writing and reading is handled by the serializer. + The default value is . + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + The type name handling. - + - Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. - Note that this will produce non-valid JSON. + Gets or sets how metadata properties are used during deserialization. + The default value is . + The metadata properties handling. - + - Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a property. + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + The type name assembly format. - + - Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + The type name assembly format. - + - Floating point numbers are parsed to . + Gets or sets how constructors are used during deserialization. + The default value is . + The constructor handling. - + - Floating point numbers are parsed to . + Gets or sets the contract resolver used by the serializer when + serializing .NET objects to JSON and vice versa. + The contract resolver. - + - Instructs the how to serialize the collection. + Gets or sets the equality comparer used by the serializer when comparing references. + The equality comparer. - + - Instructs the how to serialize the object. + Gets or sets the used by the serializer when resolving references. + The reference resolver. - + - Initializes a new instance of the class. + Gets or sets a function that creates the used by the serializer when resolving references. + A function that creates the used by the serializer when resolving references. - + - Initializes a new instance of the class with the specified container Id. + Gets or sets the used by the serializer when writing trace messages. - The container Id. + The trace writer. - + - Gets or sets the id. + Gets or sets the used by the serializer when resolving type names. - The id. + The binder. - + - Gets or sets the title. + Gets or sets the used by the serializer when resolving type names. - The title. + The binder. - + - Gets or sets the description. + Gets or sets the error handler called during serialization and deserialization. - The description. + The error handler called during serialization and deserialization. - + - Gets the collection's items converter. + Gets or sets the used by the serializer when invoking serialization callback methods. - The collection's items converter. + The context. - + - The parameter list to use when constructing the JsonConverter described by ItemConverterType. - If null, the default constructor is used. - When non-null, there must be a constructor defined in the JsonConverter that exactly matches the number, - order, and type of these parameters. + Gets or sets how and values are formatted when writing JSON text, + and the expected date format when reading JSON text. + The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - + - Gets or sets a value that indicates whether to preserve object references. + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is null. - - true to keep object reference; otherwise, false. The default is false. - - + - Gets or sets a value that indicates whether to preserve collection's items references. + Indicates how JSON text output is formatted. + The default value is . - - true to keep collection's items object references; otherwise, false. The default is false. - - + - Gets or sets the reference loop handling used when serializing the collection's items. + Gets or sets how dates are written to JSON text. + The default value is . - The reference loop handling. - + - Gets or sets the type name handling used when serializing the collection's items. + Gets or sets how time zones are handled during serialization and deserialization. + The default value is . - The type name handling. - + - Initializes a new instance of the class. + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + The default value is . - + - Initializes a new instance of the class with the specified container Id. + Gets or sets how special floating point numbers, e.g. , + and , + are written as JSON. + The default value is . - The container Id. - + - The exception thrown when an error occurs during JSON serialization or deserialization. + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + The default value is . - + - Initializes a new instance of the class. + Gets or sets how strings are escaped when writing JSON text. + The default value is . - + - Initializes a new instance of the class - with a specified error message. + Gets or sets the culture used when reading JSON. + The default value is . - The error message that explains the reason for the exception. - + - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. + Gets a value indicating whether there will be a check for additional content after deserializing an object. + The default value is false. - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. + + true if there will be a check for additional content after deserializing an object; otherwise, false. + - + - Initializes a new instance of the class. + Initializes a new instance of the class. - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - + - Specifies how dates are formatted when writing JSON text. + Represents a reader that provides fast, non-cached, forward-only access to JSON text data. - + - Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". + Asynchronously reads the next JSON token from the source. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns true if the next token was read successfully; false if there are no more tokens to read. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". + Asynchronously reads the next JSON token from the source as a of . + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. + Asynchronously reads the next JSON token from the source as a []. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the []. This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Date formatted strings are not parsed to a date type and are read as strings. + Asynchronously reads the next JSON token from the source as a of . + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + Asynchronously reads the next JSON token from the source as a of . + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + Asynchronously reads the next JSON token from the source as a of . + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Specifies how to treat the time value when converting between string and . + Asynchronously reads the next JSON token from the source as a of . + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. + Asynchronously reads the next JSON token from the source as a of . + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Treat as a UTC. If the object represents a local time, it is converted to a UTC. + Asynchronously reads the next JSON token from the source as a . + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Treat as a local time if a is being converted to a string. - If a string is being converted to , convert to a local time if a time zone is specified. + Initializes a new instance of the class with the specified . + The containing the JSON data to read. - + - Time zone information should be preserved when converting. + Gets or sets the reader's property name table. - + - Specifies formatting options for the . + Gets or sets the reader's character buffer pool. - + - No special formatting is applied. This is the default. + Reads the next JSON token from the underlying . + + true if the next token was read successfully; false if there are no more tokens to read. + - + - Causes child objects to be indented according to the and settings. + Reads the next JSON token from the underlying as a of . + A of . This method will return null at the end of an array. - + - Instructs the to use the specified constructor when deserializing that object. + Reads the next JSON token from the underlying as a of . + A of . This method will return null at the end of an array. - + - Instructs the to deserialize properties with no matching class member into the specified collection - and write values during serialization. + Reads the next JSON token from the underlying as a . + A . This method will return null at the end of an array. - + - Initializes a new instance of the class. + Reads the next JSON token from the underlying as a []. + A [] or null if the next JSON token is null. This method will return null at the end of an array. - + - Gets or sets a value that indicates whether to write extension data when serializing the object. + Reads the next JSON token from the underlying as a of . - - true to write extension data when serializing the object; otherwise, false. The default is true. - + A of . This method will return null at the end of an array. - + - Gets or sets a value that indicates whether to read extension data when deserializing the object. + Reads the next JSON token from the underlying as a of . - - true to read extension data when deserializing the object; otherwise, false. The default is true. - + A of . This method will return null at the end of an array. - + - Instructs the to always serialize the member, and require the member has a value. + Reads the next JSON token from the underlying as a of . + A of . This method will return null at the end of an array. - + - Specifies the settings used when merging JSON. + Reads the next JSON token from the underlying as a of . + A of . This method will return null at the end of an array. - + - Gets or sets the method used when merging JSON arrays. + Changes the reader's state to . + If is set to true, the underlying is also closed. - The method used when merging JSON arrays. - + - Specifies how JSON arrays are merged together. + Gets a value indicating whether the class can return line information. + + true if and can be provided; otherwise, false. + - - Concatenate arrays. - - - Union arrays, skipping items that already exist. - - - Replace all array items. - - - Merge array items together, matched by index. - - + - Specifies metadata property handling options for the . + Gets the current line number. + + The current line number or 0 if no line information is available (for example, returns false). + - + - Read metadata properties located at the start of a JSON object. + Gets the current line position. + + The current line position or 0 if no line information is available (for example, returns false). + - + - Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - + - Do not try to read metadata properties. + Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Represents a trace writer that writes to the application's instances. + Asynchronously writes the JSON value delimiter. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Represents a trace writer. + Asynchronously writes the specified end token. + The end token to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Writes the specified trace level, message and optional exception. + Asynchronously closes this writer. + If is set to true, the destination is also closed. - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of Info will exclude Verbose messages and include Info, - Warning and Error messages. + Asynchronously writes the end of the current JSON object or array. - The that will be used to filter the trace messages passed to the writer. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Writes the specified trace level, message and optional exception. + Asynchronously writes indent characters. - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of Info will exclude Verbose messages and include Info, - Warning and Error messages. + Asynchronously writes an indent space. - - The that will be used to filter the trace messages passed to the writer. - + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Get and set values for a using dynamic methods. + Asynchronously writes raw JSON without changing the writer's state. + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Provides methods to get and set values. + Asynchronously writes a null value. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Sets the value. + Asynchronously writes the property name of a name/value pair of a JSON object. - The target to set the value on. - The value to set on the target. + The name of the property. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets the value. + Asynchronously writes the property name of a name/value pair of a JSON object. - The target to get the value from. - The value. + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Initializes a new instance of the class. + Asynchronously writes the beginning of a JSON array. - The member info. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Sets the value. + Asynchronously writes the beginning of a JSON object. - The target to set the value on. - The value to set on the target. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets the value. + Asynchronously writes the start of a constructor with the given name. - The target to get the value from. - The value. + The name of the constructor. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Provides methods to get attributes. + Asynchronously writes an undefined value. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Returns a collection of all of the attributes, or an empty collection if there are no attributes. + Asynchronously writes the given white space. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. + The string of white space characters. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + Asynchronously writes a of value. - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Contract details for a used by the . + Asynchronously writes a value. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Contract details for a used by the . + Asynchronously writes a value. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets the underlying type for the contract. + Asynchronously writes a of value. - The underlying type for the contract. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets or sets the type created during deserialization. + Asynchronously writes a [] value. - The type created during deserialization. + The [] value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets or sets whether this type contract is serialized as a reference. + Asynchronously writes a value. - Whether this type contract is serialized as a reference. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets or sets the default for this contract. + Asynchronously writes a of value. - The converter. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets or sets all methods called immediately after deserialization of the object. + Asynchronously writes a value. - The methods called immediately after deserialization of the object. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets or sets all methods called during deserialization of the object. + Asynchronously writes a of value. - The methods called during deserialization of the object. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets or sets all methods called after serialization of the object graph. + Asynchronously writes a value. - The methods called after serialization of the object graph. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets or sets all methods called before serialization of the object. + Asynchronously writes a of value. - The methods called before serialization of the object. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets or sets all method called when an error is thrown during the serialization of the object. + Asynchronously writes a value. - The methods called when an error is thrown during the serialization of the object. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets or sets the method called immediately after deserialization of the object. + Asynchronously writes a of value. - The method called immediately after deserialization of the object. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets or sets the method called during deserialization of the object. + Asynchronously writes a value. - The method called during deserialization of the object. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets or sets the method called after serialization of the object graph. + Asynchronously writes a of value. - The method called after serialization of the object graph. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets or sets the method called before serialization of the object. + Asynchronously writes a value. - The method called before serialization of the object. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets or sets the method called when an error is thrown during the serialization of the object. + Asynchronously writes a of value. - The method called when an error is thrown during the serialization of the object. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets or sets the default creator method used to create the object. + Asynchronously writes a value. - The default creator method used to create the object. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets or sets a value indicating whether the default creator is non public. + Asynchronously writes a of value. - true if the default object creator is non-public; otherwise, false. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Initializes a new instance of the class. + Asynchronously writes a value. - The underlying type for the contract. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets or sets the default collection items . + Asynchronously writes a of value. - The converter. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets or sets a value indicating whether the collection items preserve object references. + Asynchronously writes a value. - true if collection items preserve object references; otherwise, false. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets or sets the collection item reference loop handling. + Asynchronously writes a of value. - The reference loop handling. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets or sets the collection item type name handling. + Asynchronously writes a value. - The type name handling. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Represents a trace writer that writes to memory. When the trace message limit is - reached then old trace messages will be removed as new messages are added. + Asynchronously writes a value. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Initializes a new instance of the class. + Asynchronously writes a of value. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Writes the specified trace level, message and optional exception. + Asynchronously writes a value. - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Returns an enumeration of the most recent trace messages. + Asynchronously writes a of value. - An enumeration of the most recent trace messages. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Returns a of the most recent trace messages. + Asynchronously writes a value. - - A of the most recent trace messages. - + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of Info will exclude Verbose messages and include Info, - Warning and Error messages. + Asynchronously writes a value. - - The that will be used to filter the trace messages passed to the writer. - + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Provides methods to get attributes from a , , or . + Asynchronously writes a of value. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Initializes a new instance of the class. + Asynchronously writes a value. - The instance to get attributes for. This parameter should be a , , or . + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Returns a collection of all of the attributes, or an empty collection if there are no attributes. + Asynchronously writes a of value. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + Asynchronously writes a value. - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Provides an interface to enable a class to return line and position information. + Asynchronously writes a of value. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets a value indicating whether the class can return line information. + Asynchronously writes a value. - - true if LineNumber and LinePosition can be provided; otherwise, false. - + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets the current line number. + Asynchronously writes a value. - The current line number or 0 if no line information is available (for example, HasLineInfo returns false). + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Gets the current line position. + Asynchronously writes a of value. - The current line position or 0 if no line information is available (for example, HasLineInfo returns false). + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Specifies how strings are escaped when writing JSON text. + Asynchronously writes a comment /*...*/ containing the specified text. + Text to place inside the comment. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Only control characters (e.g. newline) are escaped. + Asynchronously writes the end of an array. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - All non-ASCII and control characters (e.g. newline) are escaped. + Asynchronously writes the end of a constructor. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. + Asynchronously writes the end of a JSON object. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Represents a raw JSON string. + Asynchronously writes raw JSON where a value is expected and updates the writer's state. + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. - + - Represents a value in JSON (string, integer, date, etc). + Gets or sets the writer's character array pool. - + - Represents an abstract JSON token. + Gets or sets how many s to write for each level in the hierarchy when is set to . - + - Represents a collection of objects. + Gets or sets which character to use to quote attribute values. - The type of token - + - Gets the with the specified key. + Gets or sets which character to use for indenting when is set to . - - + - Compares the values of two tokens, including the values of all descendant tokens. + Gets or sets a value indicating whether object names will be surrounded with quotes. - The first to compare. - The second to compare. - true if the tokens are equal; otherwise false. - + - Adds the specified content immediately after this token. + Initializes a new instance of the class using the specified . - A content object that contains simple content or a collection of content objects to be added after this token. + The to write to. - + - Adds the specified content immediately before this token. + Flushes whatever is in the buffer to the underlying and also flushes the underlying . - A content object that contains simple content or a collection of content objects to be added before this token. - + - Returns a collection of the ancestor tokens of this token. + Closes this writer. + If is set to true, the underlying is also closed. + If is set to true, the JSON is auto-completed. - A collection of the ancestor tokens of this token. - + - Returns a collection of tokens that contain this token, and the ancestors of this token. + Writes the beginning of a JSON object. - A collection of tokens that contain this token, and the ancestors of this token. - + - Returns a collection of the sibling tokens after this token, in document order. + Writes the beginning of a JSON array. - A collection of the sibling tokens after this tokens, in document order. - + - Returns a collection of the sibling tokens before this token, in document order. + Writes the start of a constructor with the given name. - A collection of the sibling tokens before this token, in document order. + The name of the constructor. - + - Gets the with the specified key converted to the specified type. + Writes the specified end token. - The type to convert the token to. - The token key. - The converted token value. + The end token to write. - + - Returns a collection of the child tokens of this token, in document order. + Writes the property name of a name/value pair on a JSON object. - An of containing the child tokens of this , in document order. + The name of the property. - + - Returns a collection of the child tokens of this token, in document order, filtered by the specified type. + Writes the property name of a name/value pair on a JSON object. - The type to filter the child tokens on. - A containing the child tokens of this , in document order. + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. - + - Returns a collection of the child values of this token, in document order. + Writes indent characters. - The type to convert the values to. - A containing the child values of this , in document order. - + - Removes this token from its parent. + Writes the JSON value delimiter. - + - Replaces this token with the specified token. + Writes an indent space. - The value. - + - Writes this token to a . + Writes a value. + An error will raised if the value cannot be written as a single JSON token. - A into which this method will write. - A collection of which will be used when writing the token. + The value to write. - + - Returns the indented JSON for this token. + Writes a null value. - - The indented JSON for this token. - - + - Returns the JSON for this token using the given formatting and converters. + Writes an undefined value. - Indicates how the output is formatted. - A collection of which will be used when writing the token. - The JSON for this token using the given formatting and converters. - + - Performs an explicit conversion from to . + Writes raw JSON. - The value. - The result of the conversion. + The raw JSON to write. - + - Performs an explicit conversion from to . + Writes a value. - The value. - The result of the conversion. + The value to write. - + - Performs an explicit conversion from to . + Writes a value. - The value. - The result of the conversion. + The value to write. - + - Performs an explicit conversion from to . + Writes a value. - The value. - The result of the conversion. + The value to write. - + - Performs an explicit conversion from to . + Writes a value. - The value. - The result of the conversion. + The value to write. - + - Performs an explicit conversion from to . + Writes a value. - The value. - The result of the conversion. + The value to write. - + - Performs an explicit conversion from to . + Writes a value. - The value. - The result of the conversion. + The value to write. - + - Performs an explicit conversion from to . + Writes a of value. - The value. - The result of the conversion. + The of value to write. - + - Performs an explicit conversion from to . + Writes a value. - The value. - The result of the conversion. + The value to write. - + - Performs an explicit conversion from to . + Writes a of value. - The value. - The result of the conversion. + The of value to write. - + - Performs an explicit conversion from to . + Writes a value. - The value. - The result of the conversion. + The value to write. - + - Performs an explicit conversion from to . + Writes a value. - The value. - The result of the conversion. + The value to write. - + - Performs an explicit conversion from to . + Writes a value. - The value. - The result of the conversion. + The value to write. - + - Performs an explicit conversion from to . + Writes a value. - The value. - The result of the conversion. + The value to write. - + - Performs an explicit conversion from to . + Writes a value. - The value. - The result of the conversion. + The value to write. - + - Performs an explicit conversion from to . + Writes a value. - The value. - The result of the conversion. + The value to write. - + - Performs an explicit conversion from to . + Writes a value. - The value. - The result of the conversion. + The value to write. - + - Performs an explicit conversion from to . + Writes a value. - The value. - The result of the conversion. + The value to write. - + - Performs an explicit conversion from to . + Writes a [] value. - The value. - The result of the conversion. + The [] value to write. - + - Performs an explicit conversion from to . + Writes a value. - The value. - The result of the conversion. + The value to write. - + - Performs an explicit conversion from to . + Writes a value. - The value. - The result of the conversion. + The value to write. - + - Performs an explicit conversion from to . + Writes a value. - The value. - The result of the conversion. + The value to write. - + - Performs an explicit conversion from to . + Writes a value. - The value. - The result of the conversion. + The value to write. - + - Performs an explicit conversion from to . + Writes a comment /*...*/ containing the specified text. - The value. - The result of the conversion. + Text to place inside the comment. - + - Performs an explicit conversion from to . + Writes the given white space. - The value. - The result of the conversion. + The string of white space characters. - + - Performs an explicit conversion from to . + Specifies the type of JSON token. - The value. - The result of the conversion. - + - Performs an explicit conversion from to . + This is returned by the if a read method has not been called. - The value. - The result of the conversion. - + - Performs an explicit conversion from to . + An object start token. - The value. - The result of the conversion. - + - Performs an explicit conversion from to . + An array start token. - The value. - The result of the conversion. - + - Performs an explicit conversion from to . + A constructor start token. - The value. - The result of the conversion. - + - Performs an explicit conversion from to . + An object property name. - The value. - The result of the conversion. - + - Performs an explicit conversion from to []. + A comment. - The value. - The result of the conversion. - + - Performs an explicit conversion from to . + Raw JSON. - The value. - The result of the conversion. - + - Performs an explicit conversion from to . + An integer. - The value. - The result of the conversion. - + - Performs an explicit conversion from to . + A float. - The value. - The result of the conversion. - + - Performs an explicit conversion from to . + A string. - The value. - The result of the conversion. - + - Performs an explicit conversion from to . + A boolean. - The value. - The result of the conversion. - + - Performs an implicit conversion from to . + A null token. - The value to create a from. - The initialized with the specified value. - + - Performs an implicit conversion from to . + An undefined token. - The value to create a from. - The initialized with the specified value. - + - Performs an implicit conversion from to . + An object end token. - The value to create a from. - The initialized with the specified value. - + - Performs an implicit conversion from to . + An array end token. - The value to create a from. - The initialized with the specified value. - + - Performs an implicit conversion from to . + A constructor end token. - The value to create a from. - The initialized with the specified value. - + - Performs an implicit conversion from to . + A Date. - The value to create a from. - The initialized with the specified value. - + - Performs an implicit conversion from to . + Byte data. - The value to create a from. - The initialized with the specified value. - + - Performs an implicit conversion from to . + + Represents a reader that provides validation. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + - The value to create a from. - The initialized with the specified value. - + - Performs an implicit conversion from to . + Sets an event handler for receiving schema validation errors. - The value to create a from. - The initialized with the specified value. - + - Performs an implicit conversion from to . + Gets the text value of the current JSON token. - The value to create a from. - The initialized with the specified value. + - + - Performs an implicit conversion from to . + Gets the depth of the current token in the JSON document. - The value to create a from. - The initialized with the specified value. + The depth of the current token in the JSON document. - + - Performs an implicit conversion from to . + Gets the path of the current JSON token. - The value to create a from. - The initialized with the specified value. - + - Performs an implicit conversion from to . + Gets the quotation mark character used to enclose the value of a string. - The value to create a from. - The initialized with the specified value. + - + - Performs an implicit conversion from to . + Gets the type of the current JSON token. - The value to create a from. - The initialized with the specified value. + - + - Performs an implicit conversion from to . + Gets the .NET type for the current JSON token. - The value to create a from. - The initialized with the specified value. + - + - Performs an implicit conversion from to . + Initializes a new instance of the class that + validates the content returned from the given . - The value to create a from. - The initialized with the specified value. + The to read from while validating. - + - Performs an implicit conversion from to . + Gets or sets the schema. - The value to create a from. - The initialized with the specified value. + The schema. - + - Performs an implicit conversion from to . + Gets the used to construct this . - The value to create a from. - The initialized with the specified value. + The specified in the constructor. - + - Performs an implicit conversion from to . + Changes the reader's state to . + If is set to true, the underlying is also closed. - The value to create a from. - The initialized with the specified value. - + - Performs an implicit conversion from to . + Reads the next JSON token from the underlying as a of . - The value to create a from. - The initialized with the specified value. + A of . - + - Performs an implicit conversion from to . + Reads the next JSON token from the underlying as a []. - The value to create a from. - The initialized with the specified value. + + A [] or null if the next JSON token is null. + - + - Performs an implicit conversion from to . + Reads the next JSON token from the underlying as a of . - The value to create a from. - The initialized with the specified value. + A of . - + - Performs an implicit conversion from to . + Reads the next JSON token from the underlying as a of . - The value to create a from. - The initialized with the specified value. + A of . - + - Performs an implicit conversion from to . + Reads the next JSON token from the underlying as a of . - The value to create a from. - The initialized with the specified value. + A of . - + - Performs an implicit conversion from to . + Reads the next JSON token from the underlying as a . - The value to create a from. - The initialized with the specified value. + A . This method will return null at the end of an array. - + - Performs an implicit conversion from to . + Reads the next JSON token from the underlying as a of . - The value to create a from. - The initialized with the specified value. + A of . This method will return null at the end of an array. - + - Performs an implicit conversion from to . + Reads the next JSON token from the underlying as a of . - The value to create a from. - The initialized with the specified value. + A of . - + - Performs an implicit conversion from to . + Reads the next JSON token from the underlying . - The value to create a from. - The initialized with the specified value. + + true if the next token was read successfully; false if there are no more tokens to read. + - + - Performs an implicit conversion from to . + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - The value to create a from. - The initialized with the specified value. - + - Performs an implicit conversion from [] to . + Asynchronously closes this writer. + If is set to true, the destination is also closed. - The value to create a from. - The initialized with the specified value. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Performs an implicit conversion from to . + Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. - The value to create a from. - The initialized with the specified value. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Performs an implicit conversion from to . + Asynchronously writes the specified end token. - The value to create a from. - The initialized with the specified value. + The end token to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Performs an implicit conversion from to . + Asynchronously writes indent characters. - The value to create a from. - The initialized with the specified value. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the JSON value delimiter. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Performs an implicit conversion from to . + Asynchronously writes an indent space. - The value to create a from. - The initialized with the specified value. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Performs an implicit conversion from to . + Asynchronously writes raw JSON without changing the writer's state. - The value to create a from. - The initialized with the specified value. + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Creates an for this token. + Asynchronously writes the end of the current JSON object or array. - An that can be used to read this token and its descendants. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Creates a from an object. + Asynchronously writes the end of an array. - The object that will be used to create . - A with the value of the specified object + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Creates a from an object using the specified . + Asynchronously writes the end of a constructor. - The object that will be used to create . - The that will be used when reading the object. - A with the value of the specified object + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Creates the specified .NET type from the . + Asynchronously writes the end of a JSON object. - The object type that the token will be deserialized to. - The new object created from the JSON value. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Creates the specified .NET type from the . + Asynchronously writes a null value. - The object type that the token will be deserialized to. - The new object created from the JSON value. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Creates the specified .NET type from the using the specified . + Asynchronously writes the property name of a name/value pair of a JSON object. - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. + The name of the property. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Creates the specified .NET type from the using the specified . + Asynchronously writes the property name of a name/value pair of a JSON object. - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Creates a from a . + Asynchronously writes the beginning of a JSON array. - An positioned at the token to read into this . - - An that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Load a from a string that contains JSON. + Asynchronously writes a comment /*...*/ containing the specified text. - A that contains JSON. - A populated from the string that contains JSON. + Text to place inside the comment. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Creates a from a . + Asynchronously writes raw JSON where a value is expected and updates the writer's state. - An positioned at the token to read into this . - - An that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Selects a using a JPath expression. Selects the token that matches the object path. + Asynchronously writes the start of a constructor with the given name. - - A that contains a JPath expression. - - A , or null. + The name of the constructor. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Selects a using a JPath expression. Selects the token that matches the object path. + Asynchronously writes the beginning of a JSON object. - - A that contains a JPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - A . + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Selects a collection of elements using a JPath expression. + Asynchronously writes the current token. - - A that contains a JPath expression. - - An that contains the selected elements. + The to read the token from. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Selects a collection of elements using a JPath expression. + Asynchronously writes the current token. - - A that contains a JPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - An that contains the selected elements. + The to read the token from. + A flag indicating whether the current token's children should be written. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Returns the responsible for binding operations performed on this object. + Asynchronously writes the token and its value. - The expression tree representation of the runtime value. - - The to bind this object. - + The to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Returns the responsible for binding operations performed on this object. + Asynchronously writes the token and its value. - The expression tree representation of the runtime value. - - The to bind this object. - + The to write. + + The value to write. + A value is only required for tokens that have an associated value, e.g. the property name for . + null can be passed to the method for tokens that don't have a value, e.g. . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Creates a new instance of the . All child tokens are recursively cloned. + Asynchronously writes a of value. - A new instance of the . + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Adds an object to the annotation list of this . + Asynchronously writes a value. - The annotation to add. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Get the first annotation object of the specified type from this . + Asynchronously writes a value. - The type of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Gets the first annotation object of the specified type from this . + Asynchronously writes a of value. - The of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Gets a collection of annotations of the specified type for this . + Asynchronously writes a [] value. - The type of the annotations to retrieve. - An that contains the annotations for this . + The [] value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Gets a collection of annotations of the specified type for this . + Asynchronously writes a value. - The of the annotations to retrieve. - An of that contains the annotations that match the specified type for this . + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Removes the annotations of the specified type from this . + Asynchronously writes a of value. - The type of annotations to remove. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Removes the annotations of the specified type from this . + Asynchronously writes a value. - The of annotations to remove. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Gets a comparer that can compare two tokens for value equality. + Asynchronously writes a of value. - A that can compare two nodes for value equality. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Gets or sets the parent. + Asynchronously writes a value. - The parent. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Gets the root of this . + Asynchronously writes a of value. - The root of this . + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Gets the node type for this . + Asynchronously writes a value. - The type. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Gets a value indicating whether this token has child tokens. + Asynchronously writes a of value. - - true if this token has child values; otherwise, false. - + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Gets the next sibling token of this node. + Asynchronously writes a value. - The that contains the next sibling token. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Gets the previous sibling token of this node. + Asynchronously writes a of value. - The that contains the previous sibling token. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Gets the path of the JSON token. + Asynchronously writes a value. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Gets the with the specified key. + Asynchronously writes a of value. - The with the specified key. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Get the first child token of this token. + Asynchronously writes a value. - A containing the first child token of the . + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Get the last child token of this token. + Asynchronously writes a of value. - A containing the last child token of the . + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Initializes a new instance of the class from another object. + Asynchronously writes a value. - A object to copy from. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Initializes a new instance of the class with the given value. + Asynchronously writes a of value. - The value. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Initializes a new instance of the class with the given value. + Asynchronously writes a value. - The value. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Initializes a new instance of the class with the given value. + Asynchronously writes a of value. - The value. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Initializes a new instance of the class with the given value. + Asynchronously writes a value. - The value. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Initializes a new instance of the class with the given value. + Asynchronously writes a value. - The value. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Initializes a new instance of the class with the given value. + Asynchronously writes a of value. - The value. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Initializes a new instance of the class with the given value. + Asynchronously writes a value. - The value. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Initializes a new instance of the class with the given value. + Asynchronously writes a of value. - The value. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Initializes a new instance of the class with the given value. + Asynchronously writes a value. - The value. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Initializes a new instance of the class with the given value. + Asynchronously writes a value. - The value. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Initializes a new instance of the class with the given value. + Asynchronously writes a of value. - The value. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Initializes a new instance of the class with the given value. + Asynchronously writes a value. - The value. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Initializes a new instance of the class with the given value. + Asynchronously writes a of value. - The value. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Initializes a new instance of the class with the given value. + Asynchronously writes a value. - The value. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Creates a comment with the given value. + Asynchronously writes a of value. - The value. - A comment with the given value. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Creates a string with the given value. + Asynchronously writes a value. - The value. - A string with the given value. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Creates a null value. + Asynchronously writes a value. - A null value. + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Creates a null value. + Asynchronously writes a of value. - A null value. + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Writes this token to a . + Asynchronously writes an undefined value. - A into which this method will write. - A collection of which will be used when writing the token. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Indicates whether the current object is equal to another object of the same type. + Asynchronously writes the given white space. - - true if the current object is equal to the parameter; otherwise, false. - - An object to compare with this object. + The string of white space characters. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Determines whether the specified is equal to the current . + Asynchronously ets the state of the . - The to compare with the current . - - true if the specified is equal to the current ; otherwise, false. - - - The parameter is null. - + The being written. + The value being written. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. - + - Serves as a hash function for a particular type. + Gets or sets a value indicating whether the destination should be closed when this writer is closed. - - A hash code for the current . - + + true to close the destination when this writer is closed; otherwise false. The default is true. + - + - Returns a that represents this instance. + Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. - - A that represents this instance. - + + true to auto-complete the JSON when this writer is closed; otherwise false. The default is true. + - + - Returns a that represents this instance. + Gets the top. - The format. - - A that represents this instance. - + The top. - + - Returns a that represents this instance. + Gets the state of the writer. - The format provider. - - A that represents this instance. - - + - Returns a that represents this instance. + Gets the path of the writer. - The format. - The format provider. - - A that represents this instance. - - + - Returns the responsible for binding operations performed on this object. + Gets or sets a value indicating how JSON text output should be formatted. - The expression tree representation of the runtime value. - - The to bind this object. - - + - Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. + Gets or sets how dates are written to JSON text. - An object to compare with this instance. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: - Value - Meaning - Less than zero - This instance is less than . - Zero - This instance is equal to . - Greater than zero - This instance is greater than . - - - is not the same type as this instance. - - + - Gets a value indicating whether this token has child tokens. + Gets or sets how time zones are handled when writing JSON text. - - true if this token has child values; otherwise, false. - - + - Gets the node type for this . + Gets or sets how strings are escaped when writing JSON text. - The type. - + - Gets or sets the underlying token value. + Gets or sets how special floating point numbers, e.g. , + and , + are written to JSON text. - The underlying token value. - + - Initializes a new instance of the class from another object. + Gets or sets how and values are formatted when writing JSON text. - A object to copy from. - + - Initializes a new instance of the class. + Gets or sets the culture used when writing JSON. Defaults to . - The raw json. - + - Creates an instance of with the content of the reader's current token. + Initializes a new instance of the class. - The reader. - An instance of with the content of the reader's current token. - + - Indicating whether a property is required. + Flushes whatever is in the buffer to the destination and also flushes the destination. - + - The property is not required. The default state. + Closes this writer. + If is set to true, the destination is also closed. + If is set to true, the JSON is auto-completed. - + - The property must be defined in JSON but can be a null value. + Writes the beginning of a JSON object. - + - The property must be defined in JSON and cannot be a null value. + Writes the end of a JSON object. - + - Contract details for a used by the . + Writes the beginning of a JSON array. - + - Initializes a new instance of the class. + Writes the end of an array. - The underlying type for the contract. - + - Gets the object's properties. + Writes the start of a constructor with the given name. - The object's properties. + The name of the constructor. - + - Gets or sets the property name resolver. + Writes the end constructor. - The property name resolver. - + - Contract details for a used by the . + Writes the property name of a name/value pair of a JSON object. + The name of the property. - + - Initializes a new instance of the class. + Writes the property name of a name/value pair of a JSON object. - The underlying type for the contract. + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. - + - Gets or sets the ISerializable object constructor. + Writes the end of the current JSON object or array. - The ISerializable object constructor. - + - Contract details for a used by the . + Writes the current token and its children. + The to read the token from. - + - Initializes a new instance of the class. + Writes the current token. - The underlying type for the contract. + The to read the token from. + A flag indicating whether the current token's children should be written. - + - Contract details for a used by the . + Writes the token and its value. + The to write. + + The value to write. + A value is only required for tokens that have an associated value, e.g. the property name for . + null can be passed to the method for tokens that don't have a value, e.g. . + - + - Initializes a new instance of the class. + Writes the token. - The underlying type for the contract. + The to write. - + - Get and set values for a using dynamic methods. + Writes the specified end token. + The end token to write. - + - Initializes a new instance of the class. + Writes indent characters. - The member info. - + - Sets the value. + Writes the JSON value delimiter. - The target to set the value on. - The value to set on the target. - + - Gets the value. + Writes an indent space. - The target to get the value from. - The value. - + - Provides data for the Error event. + Writes a null value. - + - Initializes a new instance of the class. + Writes an undefined value. - The current object. - The error context. - + - Gets the current object the error event is being raised against. + Writes raw JSON without changing the writer's state. - The current object the error event is being raised against. + The raw JSON to write. - + - Gets the error context. + Writes raw JSON where a value is expected and updates the writer's state. - The error context. + The raw JSON to write. - + - Represents a view of a . + Writes a value. + The value to write. - + - Initializes a new instance of the class. + Writes a value. - The name. + The value to write. - + - When overridden in a derived class, returns whether resetting an object changes its value. + Writes a value. - - true if resetting the component changes its value; otherwise, false. - - The component to test for reset capability. - + The value to write. - + - When overridden in a derived class, gets the current value of the property on a component. + Writes a value. - - The value of a property for a given component. - - The component with the property for which to retrieve the value. - + The value to write. - + - When overridden in a derived class, resets the value for this property of the component to the default value. + Writes a value. - The component with the property value that is to be reset to the default value. - + The value to write. - + - When overridden in a derived class, sets the value of the component to a different value. + Writes a value. - The component with the property value that is to be set. - The new value. - + The value to write. - + - When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. + Writes a value. - - true if the property should be persisted; otherwise, false. - - The component with the property to be examined for persistence. - + The value to write. - + - When overridden in a derived class, gets the type of the component this property is bound to. + Writes a value. - - A that represents the type of component this property is bound to. When the or methods are invoked, the object specified might be an instance of this type. - + The value to write. - + - When overridden in a derived class, gets a value indicating whether this property is read-only. + Writes a value. - - true if the property is read-only; otherwise, false. - + The value to write. - + - When overridden in a derived class, gets the type of the property. + Writes a value. - - A that represents the type of the property. - + The value to write. - + - Gets the hash code for the name of the member. + Writes a value. - - - The hash code for the name of the member. - + The value to write. - + - Used to resolve references when serializing and deserializing JSON by the . + Writes a value. + The value to write. - + - Resolves a reference to its object. + Writes a value. - The serialization context. - The reference to resolve. - The object that + The value to write. - + - Gets the reference for the sepecified object. + Writes a value. - The serialization context. - The object to get a reference for. - The reference to the object. + The value to write. - + - Determines whether the specified object is referenced. + Writes a value. - The serialization context. - The object to test for a reference. - - true if the specified object is referenced; otherwise, false. - + The value to write. - + - Adds a reference to the specified object. + Writes a value. - The serialization context. - The reference. - The object to reference. + The value to write. - + - Specifies reference handling options for the . - Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement ISerializable. + Writes a value. - - - + The value to write. - + - Do not preserve references when serializing types. + Writes a value. + The value to write. - + - Preserve references when serializing into a JSON object structure. + Writes a of value. + The of value to write. - + - Preserve references when serializing into a JSON array structure. + Writes a of value. + The of value to write. - + - Preserve references when serializing. + Writes a of value. + The of value to write. - + - Instructs the how to serialize the collection. + Writes a of value. + The of value to write. - + - Initializes a new instance of the class. + Writes a of value. + The of value to write. - + - Initializes a new instance of the class with a flag indicating whether the array can contain null items + Writes a of value. - A flag indicating whether the array can contain null items. + The of value to write. - + - Initializes a new instance of the class with the specified container Id. + Writes a of value. - The container Id. + The of value to write. - + - Gets or sets a value indicating whether null items are allowed in the collection. + Writes a of value. - true if null items are allowed in the collection; otherwise, false. + The of value to write. - + - Specifies default value handling options for the . + Writes a of value. - - - - + The of value to write. - + - Include members where the member value is the same as the member's default value when serializing objects. - Included members are written to JSON. Has no effect when deserializing. + Writes a of value. + The of value to write. - + - Ignore members where the member value is the same as the member's default value when serializing objects - so that is is not written to JSON. - This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, - decimals and floating point numbers; and false for booleans). The default value ignored can be changed by - placing the on the property. + Writes a of value. + The of value to write. - + - Members with a default value but no JSON will be set to their default value when deserializing. + Writes a of value. + The of value to write. - + - Ignore members where the member value is the same as the member's default value when serializing objects - and sets members to their default value when deserializing. + Writes a of value. + The of value to write. - + - Instructs the to use the specified when serializing the member or class. + Writes a of value. + The of value to write. - + - Initializes a new instance of the class. + Writes a of value. - Type of the converter. + The of value to write. - + - Initializes a new instance of the class. + Writes a of value. - Type of the converter. - Parameter list to use when constructing the JsonConverter. Can be null. + The of value to write. - + - Gets the of the converter. + Writes a of value. - The of the converter. + The of value to write. - + - The parameter list to use when constructing the JsonConverter described by ConverterType. - If null, the default constructor is used. + Writes a [] value. + The [] value to write. - + - Instructs the how to serialize the object. + Writes a value. + The value to write. - + - Initializes a new instance of the class. + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + The value to write. - + - Initializes a new instance of the class with the specified member serialization. + Writes a comment /*...*/ containing the specified text. - The member serialization. + Text to place inside the comment. - + - Initializes a new instance of the class with the specified container Id. + Writes the given white space. - The container Id. + The string of white space characters. - + - Gets or sets the member serialization. + Releases unmanaged and - optionally - managed resources. - The member serialization. + true to release both managed and unmanaged resources; false to release only unmanaged resources. - + - Gets or sets a value that indicates whether the object's properties are required. + Sets the state of the . - - A value indicating whether the object's properties are required. - + The being written. + The value being written. - + - Specifies the settings on a object. + The exception thrown when an error occurs while writing JSON text. - + - Initializes a new instance of the class. + Gets the path to the JSON where the error occurred. + The path to the JSON where the error occurred. - + - Gets or sets how reference loops (e.g. a class referencing itself) is handled. + Initializes a new instance of the class. - Reference loop handling. - + - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + Initializes a new instance of the class + with a specified error message. - Missing member handling. + The error message that explains the reason for the exception. - + - Gets or sets how objects are created during deserialization. + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. - The object creation handling. + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. - + - Gets or sets how null values are handled during serialization and deserialization. + Initializes a new instance of the class. - Null value handling. + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). - + - Gets or sets how null default are handled during serialization and deserialization. + Initializes a new instance of the class + with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. - The default value handling. + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. - + - Gets or sets a collection that will be used during serialization. + Specifies how JSON comments are handled when loading JSON. - The converters. - + - Gets or sets how object references are preserved by the serializer. + Ignore comments. - The preserve references handling. - + - Gets or sets how type name writing and reading is handled by the serializer. + Load comments as a with type . - The type name handling. - + - Gets or sets how metadata properties are used during deserialization. + Specifies how duplicate property names are handled when loading JSON. - The metadata properties handling. - + - Gets or sets how a type name assembly is written and resolved by the serializer. + Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used. - The type name assembly format. - + - Gets or sets how constructors are used during deserialization. + Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used. - The constructor handling. - + - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. + Throw a when a duplicate property is encountered. - The contract resolver. - + - Gets or sets the equality comparer used by the serializer when comparing references. + Contains the LINQ to JSON extension methods. - The equality comparer. - + - Gets or sets the used by the serializer when resolving references. + Returns a collection of tokens that contains the ancestors of every token in the source collection. - The reference resolver. + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains the ancestors of every token in the source collection. - + - Gets or sets a function that creates the used by the serializer when resolving references. + Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. - A function that creates the used by the serializer when resolving references. + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains every token in the source collection, the ancestors of every token in the source collection. - + - Gets or sets the used by the serializer when writing trace messages. + Returns a collection of tokens that contains the descendants of every token in the source collection. - The trace writer. + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains the descendants of every token in the source collection. - + - Gets or sets the used by the serializer when resolving type names. + Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. - The binder. + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains every token in the source collection, and the descendants of every token in the source collection. - + - Gets or sets the error handler called during serialization and deserialization. + Returns a collection of child properties of every object in the source collection. - The error handler called during serialization and deserialization. + An of that contains the source collection. + An of that contains the properties of every object in the source collection. - + - Gets or sets the used by the serializer when invoking serialization callback methods. + Returns a collection of child values of every object in the source collection with the given key. - The context. + An of that contains the source collection. + The token key. + An of that contains the values of every token in the source collection with the given key. - + - Get or set how and values are formatted when writing JSON text, and the expected date format when reading JSON text. + Returns a collection of child values of every object in the source collection. + An of that contains the source collection. + An of that contains the values of every token in the source collection. - + - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + Returns a collection of converted child values of every object in the source collection with the given key. + The type to convert the values to. + An of that contains the source collection. + The token key. + An that contains the converted values of every token in the source collection with the given key. - + - Indicates how JSON text output is formatted. + Returns a collection of converted child values of every object in the source collection. + The type to convert the values to. + An of that contains the source collection. + An that contains the converted values of every token in the source collection. - + - Get or set how dates are written to JSON text. + Converts the value. + The type to convert the value to. + A cast as a of . + A converted value. - + - Get or set how time zones are handling during serialization and deserialization. + Converts the value. + The source collection type. + The type to convert the value to. + A cast as a of . + A converted value. - + - Get or set how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + Returns a collection of child tokens of every array in the source collection. + The source collection type. + An of that contains the source collection. + An of that contains the values of every token in the source collection. - + - Get or set how special floating point numbers, e.g. , - and , - are written as JSON. + Returns a collection of converted child tokens of every array in the source collection. + An of that contains the source collection. + The type to convert the values to. + The source collection type. + An that contains the converted values of every token in the source collection. - + - Get or set how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + Returns the input typed as . + An of that contains the source collection. + The input typed as . - + - Get or set how strings are escaped when writing JSON text. + Returns the input typed as . + The source collection type. + An of that contains the source collection. + The input typed as . - + - Gets or sets the culture used when reading JSON. Defaults to . + Represents a collection of objects. + The type of token. - + - Gets a value indicating whether there will be a check for additional content after deserializing an object. + Gets the of with the specified key. - - true if there will be a check for additional content after deserializing an object; otherwise, false. - + - + - - Represents a reader that provides validation. - - - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. - + Represents a JSON array. + + + - + - Initializes a new instance of the class that - validates the content returned from the given . + Writes this token to a asynchronously. - The to read from while validating. + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. - + - Reads the next JSON token from the stream as a . + Asynchronously loads a from a . - A . + A that will be read for the content of the . + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous load. The property contains the JSON that was read from the specified . - + - Reads the next JSON token from the stream as a []. + Asynchronously loads a from a . - - A [] or a null reference if the next JSON token is null. - + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous load. The property contains the JSON that was read from the specified . - + - Reads the next JSON token from the stream as a . + Gets the container's children tokens. - A . + The container's children tokens. - + - Reads the next JSON token from the stream as a . + Gets the node type for this . - A . This method will return null at the end of an array. + The type. - + - Reads the next JSON token from the stream as a . + Initializes a new instance of the class. - A . This method will return null at the end of an array. - + - Reads the next JSON token from the stream as a . + Initializes a new instance of the class from another object. - A . + A object to copy from. - + - Reads the next JSON token from the stream. + Initializes a new instance of the class with the specified content. - - true if the next token was read successfully; false if there are no more tokens to read. - + The contents of the array. - + - Sets an event handler for receiving schema validation errors. + Initializes a new instance of the class with the specified content. + The contents of the array. - + - Gets the text value of the current JSON token. + Loads an from a . - + A that will be read for the content of the . + A that contains the JSON that was read from the specified . - + - Gets the depth of the current token in the JSON document. + Loads an from a . - The depth of the current token in the JSON document. + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . - + - Gets the path of the current JSON token. + Load a from a string that contains JSON. + A that contains JSON. + A populated from the string that contains JSON. + + + - + - Gets the quotation mark character used to enclose the value of a string. + Load a from a string that contains JSON. - + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + + - + - Gets the type of the current JSON token. + Creates a from an object. - + The object that will be used to create . + A with the values of the specified object. - + - Gets the Common Language Runtime (CLR) type for the current JSON token. + Creates a from an object. - + The object that will be used to create . + The that will be used to read the object. + A with the values of the specified object. - + - Gets or sets the schema. + Writes this token to a . - The schema. + A into which this method will write. + A collection of which will be used when writing the token. - + - Gets the used to construct this . + Gets the with the specified key. - The specified in the constructor. + The with the specified key. - + - Compares tokens to determine whether they are equal. + Gets or sets the at the specified index. + - + - Determines whether the specified objects are equal. + Determines the index of a specific item in the . - The first object of type to compare. - The second object of type to compare. + The object to locate in the . - true if the specified objects are equal; otherwise, false. + The index of if found in the list; otherwise, -1. - + - Returns a hash code for the specified object. + Inserts an item to the at the specified index. - The for which a hash code is to be returned. - A hash code for the specified object. - The type of is a reference type and is null. + The zero-based index at which should be inserted. + The object to insert into the . + + is not a valid index in the . + - + - Specifies the member serialization options for the . + Removes the item at the specified index. + The zero-based index of the item to remove. + + is not a valid index in the . + - + - All public members are serialized by default. Members can be excluded using or . - This is the default member serialization mode. + Returns an enumerator that iterates through the collection. + + A of that can be used to iterate through the collection. + - + - Only members must be marked with or are serialized. - This member serialization mode can also be set by marking the class with . + Adds an item to the . + The object to add to the . - + - All public and private fields are serialized. Members can be excluded using or . - This member serialization mode can also be set by marking the class with - and setting IgnoreSerializableAttribute on to false. + Removes all items from the . - + - Specifies how object creation is handled by the . + Determines whether the contains a specific value. + + The object to locate in the . + + true if is found in the ; otherwise, false. + + + + + Copies the elements of the to an array, starting at a particular array index. + The array. + Index of the array. - + - Reuse existing objects, create new objects when needed. + Gets a value indicating whether the is read-only. + true if the is read-only; otherwise, false. - + - Only reuse existing objects. + Removes the first occurrence of a specific object from the . + The object to remove from the . + + true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . + - + - Always create new objects. + Represents a JSON constructor. - + - Converts a to and from the ISO 8601 date format (e.g. 2008-04-12T12:53Z). + Writes this token to a asynchronously. + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. - + - Writes the JSON representation of the object. + Asynchronously loads a from a . - The to write to. - The value. - The calling serializer. + A that will be read for the content of the . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . - + - Reads the JSON representation of the object. + Asynchronously loads a from a . - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . - + - Gets or sets the date time styles used when converting a date to and from JSON. + Gets the container's children tokens. - The date time styles used when converting a date to and from JSON. + The container's children tokens. - + - Gets or sets the date time format used when converting a date to and from JSON. + Gets or sets the name of this constructor. - The date time format used when converting a date to and from JSON. + The constructor name. - + - Gets or sets the culture used when converting a date to and from JSON. + Gets the node type for this . - The culture used when converting a date to and from JSON. + The type. - + - Converts a to and from a JavaScript date constructor (e.g. new Date(52231943)). + Initializes a new instance of the class. - + - Writes the JSON representation of the object. + Initializes a new instance of the class from another object. - The to write to. - The value. - The calling serializer. + A object to copy from. - + - Reads the JSON representation of the object. + Initializes a new instance of the class with the specified name and content. - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. + The constructor name. + The contents of the constructor. - + - Converts XML to and from JSON. + Initializes a new instance of the class with the specified name and content. + The constructor name. + The contents of the constructor. - + - Writes the JSON representation of the object. + Initializes a new instance of the class with the specified name. - The to write to. - The calling serializer. - The value. + The constructor name. - + - Reads the JSON representation of the object. + Writes this token to a . - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. + A into which this method will write. + A collection of which will be used when writing the token. - + - Checks if the attributeName is a namespace attribute. + Gets the with the specified key. - Attribute name to test. - The attribute name prefix if it has one, otherwise an empty string. - True if attribute name is for a namespace attribute, otherwise false. + The with the specified key. - + - Determines whether this instance can convert the specified value type. + Loads a from a . - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - + A that will be read for the content of the . + A that contains the JSON that was read from the specified . - + - Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produces multiple root elements. + Loads a from a . - The name of the deserialize root element. + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . - + - Gets or sets a flag to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. + Represents a token that can contain other tokens. - true if the array attibute is written to the XML; otherwise, false. - + - Gets or sets a value indicating whether to write the root JSON object. + Occurs when the list changes or an item in the list changes. - true if the JSON root object is omitted; otherwise, false. - + - Represents a reader that provides fast, non-cached, forward-only access to JSON text data. + Occurs before an item is added to the collection. - + - Initializes a new instance of the class with the specified . + Occurs when the items list of the collection has changed, or the collection is reset. - The TextReader containing the XML data to read. - + - Reads the next JSON token from the stream. + Gets the container's children tokens. - - true if the next token was read successfully; false if there are no more tokens to read. - + The container's children tokens. - + - Reads the next JSON token from the stream as a []. + Raises the event. - - A [] or a null reference if the next JSON token is null. This method will return null at the end of an array. - + The instance containing the event data. - + - Reads the next JSON token from the stream as a . + Raises the event. - A . This method will return null at the end of an array. + The instance containing the event data. - + - Reads the next JSON token from the stream as a . + Raises the event. - A . This method will return null at the end of an array. + The instance containing the event data. - + - Reads the next JSON token from the stream as a . + Gets a value indicating whether this token has child tokens. - A . This method will return null at the end of an array. + + true if this token has child values; otherwise, false. + - + - Reads the next JSON token from the stream as a . + Get the first child token of this token. - A . This method will return null at the end of an array. + + A containing the first child token of the . + - + - Reads the next JSON token from the stream as a . + Get the last child token of this token. - A . This method will return null at the end of an array. + + A containing the last child token of the . + - + - Changes the state to closed. + Returns a collection of the child tokens of this token, in document order. + + An of containing the child tokens of this , in document order. + - + - Gets a value indicating whether the class can return line information. + Returns a collection of the child values of this token, in document order. + The type to convert the values to. - true if LineNumber and LinePosition can be provided; otherwise, false. + A containing the child values of this , in document order. - + - Gets the current line number. + Returns a collection of the descendant tokens for this token in document order. - - The current line number or 0 if no line information is available (for example, HasLineInfo returns false). - + An of containing the descendant tokens of the . - + - Gets the current line position. + Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. - - The current line position or 0 if no line information is available (for example, HasLineInfo returns false). - + An of containing this token, and all the descendant tokens of the . - + - Instructs the to always serialize the member with the specified name. + Adds the specified content as children of this . + The content to be added. - + - Initializes a new instance of the class. + Adds the specified content as the first children of this . + The content to be added. - + - Initializes a new instance of the class with the specified name. + Creates a that can be used to add tokens to the . - Name of the property. + A that is ready to have content written to it. - + - Gets or sets the converter used when serializing the property's collection items. + Replaces the child nodes of this token with the specified content. - The collection's items converter. + The content. - + - The parameter list to use when constructing the JsonConverter described by ItemConverterType. - If null, the default constructor is used. - When non-null, there must be a constructor defined in the JsonConverter that exactly matches the number, - order, and type of these parameters. + Removes the child nodes from this token. - - [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - + - Gets or sets the null value handling used when serializing this property. + Merge the specified content into this . - The null value handling. + The content to be merged. - + - Gets or sets the default value handling used when serializing this property. + Merge the specified content into this using . - The default value handling. + The content to be merged. + The used to merge the content. - + - Gets or sets the reference loop handling used when serializing this property. + Gets the count of child JSON tokens. - The reference loop handling. + The count of child JSON tokens. - + - Gets or sets the object creation handling used when deserializing this property. + Represents a collection of objects. - The object creation handling. + The type of token. - + - Gets or sets the type name handling used when serializing this property. + An empty collection of objects. - The type name handling. - + - Gets or sets whether this property's value is serialized as a reference. + Initializes a new instance of the struct. + + The enumerable. + + + + Returns an enumerator that can be used to iterate through the collection. - Whether this property's value is serialized as a reference. + + A that can be used to iterate through the collection. + - + - Gets or sets the order of serialization and deserialization of a member. + Gets the of with the specified key. - The numeric order of serialization or deserialization. + - + - Gets or sets a value indicating whether this property is required. + Determines whether the specified is equal to this instance. - - A value indicating whether this property is required. - + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + - + - Gets or sets the name of the property. + Determines whether the specified is equal to this instance. - The name of the property. + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + - + - Gets or sets the the reference loop handling used when serializing the property's collection items. + Returns a hash code for this instance. - The collection's items reference loop handling. + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + - + - Gets or sets the the type name handling used when serializing the property's collection items. + Represents a JSON object. - The collection's items type name handling. + + + - + - Gets or sets whether this property's collection items are serialized as a reference. + Writes this token to a asynchronously. - Whether this property's collection items are serialized as a reference. + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. - + - Instructs the not to serialize the public field or public read/write property value. + Asynchronously loads a from a . + A that will be read for the content of the . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . - + - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + Asynchronously loads a from a . + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . - + - Creates an instance of the JsonWriter class using the specified . + Gets the container's children tokens. - The TextWriter to write to. + The container's children tokens. - + - Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream. + Occurs when a property value changes. - + - Closes this stream and the underlying stream. + Occurs when a property value is changing. - + - Writes the beginning of a JSON object. + Initializes a new instance of the class. - + - Writes the beginning of a JSON array. + Initializes a new instance of the class from another object. + A object to copy from. - + - Writes the start of a constructor with the given name. + Initializes a new instance of the class with the specified content. - The name of the constructor. + The contents of the object. - + - Writes the specified end token. + Initializes a new instance of the class with the specified content. - The end token to write. + The contents of the object. - + - Writes the property name of a name/value pair on a JSON object. + Gets the node type for this . - The name of the property. + The type. - + - Writes the property name of a name/value pair on a JSON object. + Gets an of of this object's properties. - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. + An of of this object's properties. - + - Writes indent characters. + Gets a with the specified name. + The property name. + A with the specified name or null. - + - Writes the JSON value delimiter. + Gets the with the specified name. + The exact name will be searched for first and if no matching property is found then + the will be used to match a property. + The property name. + One of the enumeration values that specifies how the strings will be compared. + A matched with the specified name or null. - + - Writes an indent space. + Gets a of of this object's property values. + A of of this object's property values. - + - Writes a value. - An error will raised if the value cannot be written as a single JSON token. + Gets the with the specified key. - The value to write. + The with the specified key. - + - Writes a null value. + Gets or sets the with the specified property name. + - + - Writes an undefined value. + Loads a from a . + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + is not valid JSON. + - + - Writes raw JSON. + Loads a from a . - The raw JSON to write. + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + is not valid JSON. + - + - Writes a value. + Load a from a string that contains JSON. - The value to write. + A that contains JSON. + A populated from the string that contains JSON. + + is not valid JSON. + + + + - + - Writes a value. + Load a from a string that contains JSON. - The value to write. + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + is not valid JSON. + + + + - + - Writes a value. + Creates a from an object. - The value to write. + The object that will be used to create . + A with the values of the specified object. - + - Writes a value. + Creates a from an object. - The value to write. + The object that will be used to create . + The that will be used to read the object. + A with the values of the specified object. - + - Writes a value. + Writes this token to a . - The value to write. + A into which this method will write. + A collection of which will be used when writing the token. - + - Writes a value. + Gets the with the specified property name. - The value to write. + Name of the property. + The with the specified property name. - + - Writes a value. + Gets the with the specified property name. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. - The value to write. + Name of the property. + One of the enumeration values that specifies how the strings will be compared. + The with the specified property name. - + - Writes a value. + Tries to get the with the specified property name. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. - The value to write. + Name of the property. + The value. + One of the enumeration values that specifies how the strings will be compared. + true if a value was successfully retrieved; otherwise, false. - + - Writes a value. + Adds the specified property name. - The value to write. + Name of the property. + The value. - + - Writes a value. + Determines whether the JSON object has the specified property name. - The value to write. + Name of the property. + true if the JSON object has the specified property name; otherwise, false. - + - Writes a value. + Removes the property with the specified name. - The value to write. + Name of the property. + true if item was successfully removed; otherwise, false. - + - Writes a value. + Tries to get the with the specified property name. - The value to write. + Name of the property. + The value. + true if a value was successfully retrieved; otherwise, false. - + - Writes a value. + Returns an enumerator that can be used to iterate through the collection. - The value to write. + + A that can be used to iterate through the collection. + - + - Writes a value. + Raises the event with the provided arguments. - The value to write. + Name of the property. - + - Writes a value. + Raises the event with the provided arguments. - The value to write. + Name of the property. - + - Writes a value. + Returns the responsible for binding operations performed on this object. - The value to write. + The expression tree representation of the runtime value. + + The to bind this object. + - + - Writes a value. + Represents a JSON property. - The value to write. - + - Writes a [] value. + Writes this token to a asynchronously. - The [] value to write. + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. - + - Writes a value. + Asynchronously loads a from a . - The value to write. + A that will be read for the content of the . + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous creation. The + property returns a that contains the JSON that was read from the specified . - + - Writes a value. + Asynchronously loads a from a . - The value to write. + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous creation. The + property returns a that contains the JSON that was read from the specified . - + - Writes a value. + Gets the container's children tokens. - The value to write. + The container's children tokens. - + - Writes a value. + Gets the property name. - The value to write. + The property name. - + - Writes out a comment /*...*/ containing the specified text. + Gets or sets the property value. - Text to place inside the comment. + The property value. - + - Writes out the given white space. + Initializes a new instance of the class from another object. - The string of white space characters. + A object to copy from. - + - Gets or sets how many IndentChars to write for each level in the hierarchy when is set to Formatting.Indented. + Gets the node type for this . + The type. - + - Gets or sets which character to use to quote attribute values. + Initializes a new instance of the class. + The property name. + The property content. - + - Gets or sets which character to use for indenting when is set to Formatting.Indented. + Initializes a new instance of the class. + The property name. + The property content. - + - Gets or sets a value indicating whether object names will be surrounded with quotes. + Writes this token to a . + A into which this method will write. + A collection of which will be used when writing the token. - + - The exception thrown when an error occurs while reading JSON text. + Loads a from a . + A that will be read for the content of the . + A that contains the JSON that was read from the specified . - + - Initializes a new instance of the class. + Loads a from a . + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . - + - Initializes a new instance of the class - with a specified error message. + Represents a view of a . - The error message that explains the reason for the exception. - + - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. + Initializes a new instance of the class. - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. + The name. - + - Initializes a new instance of the class. + When overridden in a derived class, returns whether resetting an object changes its value. - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). + + true if resetting the component changes its value; otherwise, false. + + The component to test for reset capability. - + - Gets the path to the JSON where the error occurred. + When overridden in a derived class, gets the current value of the property on a component. - The path to the JSON where the error occurred. + + The value of a property for a given component. + + The component with the property for which to retrieve the value. - + - The exception thrown when an error occurs while reading JSON text. + When overridden in a derived class, resets the value for this property of the component to the default value. + The component with the property value that is to be reset to the default value. - + - Initializes a new instance of the class. + When overridden in a derived class, sets the value of the component to a different value. + The component with the property value that is to be set. + The new value. - + - Initializes a new instance of the class - with a specified error message. + When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. - The error message that explains the reason for the exception. + + true if the property should be persisted; otherwise, false. + + The component with the property to be examined for persistence. - + - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. + When overridden in a derived class, gets the type of the component this property is bound to. - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. + + A that represents the type of component this property is bound to. + When the or + + methods are invoked, the object specified might be an instance of this type. + - + - Initializes a new instance of the class. + When overridden in a derived class, gets a value indicating whether this property is read-only. - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). + + true if the property is read-only; otherwise, false. + - + - Gets the line number indicating where the error occurred. + When overridden in a derived class, gets the type of the property. - The line number indicating where the error occurred. + + A that represents the type of the property. + - + - Gets the line position indicating where the error occurred. + Gets the hash code for the name of the member. - The line position indicating where the error occurred. + + + The hash code for the name of the member. + - + - Gets the path to the JSON where the error occurred. + Represents a raw JSON string. - The path to the JSON where the error occurred. - + - Represents a collection of . + Asynchronously creates an instance of with the content of the reader's current token. + The reader. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous creation. The + property returns an instance of with the content of the reader's current token. - + - Provides methods for converting between common language runtime types and JSON types. + Initializes a new instance of the class from another object. - - - + A object to copy from. - + - Represents JavaScript's boolean value true as a string. This field is read-only. + Initializes a new instance of the class. + The raw json. - + - Represents JavaScript's boolean value false as a string. This field is read-only. + Creates an instance of with the content of the reader's current token. + The reader. + An instance of with the content of the reader's current token. - + - Represents JavaScript's null as a string. This field is read-only. + Specifies the settings used when loading JSON. - + - Represents JavaScript's undefined as a string. This field is read-only. + Initializes a new instance of the class. - + - Represents JavaScript's positive infinity as a string. This field is read-only. + Gets or sets how JSON comments are handled when loading JSON. + The default value is . + The JSON comment handling. - + - Represents JavaScript's negative infinity as a string. This field is read-only. + Gets or sets how JSON line info is handled when loading JSON. + The default value is . + The JSON line info handling. - + - Represents JavaScript's NaN as a string. This field is read-only. + Gets or sets how duplicate property names in JSON objects are handled when loading JSON. + The default value is . + The JSON duplicate property name handling. - + - Converts the to its JSON string representation. + Specifies the settings used when merging JSON. - The value to convert. - A JSON string representation of the . - + - Converts the to its JSON string representation using the specified. + Initializes a new instance of the class. - The value to convert. - The format the date will be converted to. - The time zone handling when the date is converted to a string. - A JSON string representation of the . - + - Converts the to its JSON string representation. + Gets or sets the method used when merging JSON arrays. - The value to convert. - A JSON string representation of the . + The method used when merging JSON arrays. - + - Converts the to its JSON string representation using the specified. + Gets or sets how null value properties are merged. - The value to convert. - The format the date will be converted to. - A JSON string representation of the . + How null value properties are merged. - + - Converts the to its JSON string representation. + Gets or sets the comparison used to match property names while merging. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. - The value to convert. - A JSON string representation of the . + The comparison used to match property names while merging. - + - Converts the to its JSON string representation. + Represents an abstract JSON token. - The value to convert. - A JSON string representation of the . - + - Converts the to its JSON string representation. + Writes this token to a asynchronously. - The value to convert. - A JSON string representation of the . + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. - + - Converts the to its JSON string representation. + Writes this token to a asynchronously. - The value to convert. - A JSON string representation of the . + A into which this method will write. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. - + - Converts the to its JSON string representation. + Asynchronously creates a from a . - The value to convert. - A JSON string representation of the . + An positioned at the token to read into this . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains + the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + - + - Converts the to its JSON string representation. + Asynchronously creates a from a . - The value to convert. - A JSON string representation of the . + An positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains + the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + - + - Converts the to its JSON string representation. + Asynchronously creates a from a . - The value to convert. - A JSON string representation of the . + A positioned at the token to read into this . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + - + - Converts the to its JSON string representation. + Asynchronously creates a from a . - The value to convert. - A JSON string representation of the . + A positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + - + - Converts the to its JSON string representation. + Gets a comparer that can compare two tokens for value equality. - The value to convert. - A JSON string representation of the . + A that can compare two nodes for value equality. - + - Converts the to its JSON string representation. + Gets or sets the parent. - The value to convert. - A JSON string representation of the . + The parent. - + - Converts the to its JSON string representation. + Gets the root of this . - The value to convert. - A JSON string representation of the . + The root of this . - + - Converts the to its JSON string representation. + Gets the node type for this . - The value to convert. - A JSON string representation of the . + The type. - + - Converts the to its JSON string representation. + Gets a value indicating whether this token has child tokens. - The value to convert. - A JSON string representation of the . + + true if this token has child values; otherwise, false. + - + - Converts the to its JSON string representation. + Compares the values of two tokens, including the values of all descendant tokens. - The value to convert. - A JSON string representation of the . + The first to compare. + The second to compare. + true if the tokens are equal; otherwise false. - + - Converts the to its JSON string representation. + Gets the next sibling token of this node. - The value to convert. - A JSON string representation of the . + The that contains the next sibling token. - + - Converts the to its JSON string representation. + Gets the previous sibling token of this node. - The value to convert. - A JSON string representation of the . + The that contains the previous sibling token. - + - Converts the to its JSON string representation. + Gets the path of the JSON token. - The value to convert. - A JSON string representation of the . - + - Converts the to its JSON string representation. + Adds the specified content immediately after this token. - The value to convert. - A JSON string representation of the . + A content object that contains simple content or a collection of content objects to be added after this token. - + - Converts the to its JSON string representation. + Adds the specified content immediately before this token. - The value to convert. - The string delimiter character. - A JSON string representation of the . + A content object that contains simple content or a collection of content objects to be added before this token. - + - Converts the to its JSON string representation. + Returns a collection of the ancestor tokens of this token. - The value to convert. - The string delimiter character. - The string escape handling. - A JSON string representation of the . + A collection of the ancestor tokens of this token. - + - Converts the to its JSON string representation. + Returns a collection of tokens that contain this token, and the ancestors of this token. - The value to convert. - A JSON string representation of the . + A collection of tokens that contain this token, and the ancestors of this token. - + - Serializes the specified object to a JSON string. + Returns a collection of the sibling tokens after this token, in document order. - The object to serialize. - A JSON string representation of the object. + A collection of the sibling tokens after this tokens, in document order. - + - Serializes the specified object to a JSON string using formatting. + Returns a collection of the sibling tokens before this token, in document order. - The object to serialize. - Indicates how the output is formatted. - - A JSON string representation of the object. - + A collection of the sibling tokens before this token, in document order. - + - Serializes the specified object to a JSON string using a collection of . + Gets the with the specified key. - The object to serialize. - A collection converters used while serializing. - A JSON string representation of the object. + The with the specified key. - + - Serializes the specified object to a JSON string using formatting and a collection of . + Gets the with the specified key converted to the specified type. - The object to serialize. - Indicates how the output is formatted. - A collection converters used while serializing. - A JSON string representation of the object. + The type to convert the token to. + The token key. + The converted token value. - + - Serializes the specified object to a JSON string using . + Get the first child token of this token. - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - + A containing the first child token of the . - + - Serializes the specified object to a JSON string using a type, formatting and . + Get the last child token of this token. - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is Auto to write out the type name if the type of the value does not match. - Specifing the type is optional. - - - A JSON string representation of the object. - + A containing the last child token of the . - + - Serializes the specified object to a JSON string using formatting and . + Returns a collection of the child tokens of this token, in document order. - The object to serialize. - Indicates how the output is formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - + An of containing the child tokens of this , in document order. - + - Serializes the specified object to a JSON string using a type, formatting and . + Returns a collection of the child tokens of this token, in document order, filtered by the specified type. - The object to serialize. - Indicates how the output is formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is Auto to write out the type name if the type of the value does not match. - Specifing the type is optional. - - - A JSON string representation of the object. - + The type to filter the child tokens on. + A containing the child tokens of this , in document order. - + - Asynchronously serializes the specified object to a JSON string. - Serialization will happen on a new thread. + Returns a collection of the child values of this token, in document order. - The object to serialize. - - A task that represents the asynchronous serialize operation. The value of the TResult parameter contains a JSON string representation of the object. - + The type to convert the values to. + A containing the child values of this , in document order. - + - Asynchronously serializes the specified object to a JSON string using formatting. - Serialization will happen on a new thread. + Removes this token from its parent. - The object to serialize. - Indicates how the output is formatted. - - A task that represents the asynchronous serialize operation. The value of the TResult parameter contains a JSON string representation of the object. - - + - Asynchronously serializes the specified object to a JSON string using formatting and a collection of . - Serialization will happen on a new thread. + Replaces this token with the specified token. - The object to serialize. - Indicates how the output is formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A task that represents the asynchronous serialize operation. The value of the TResult parameter contains a JSON string representation of the object. - + The value. - + - Deserializes the JSON to a .NET object. + Writes this token to a . - The JSON to deserialize. - The deserialized object from the JSON string. + A into which this method will write. + A collection of which will be used when writing the token. - + - Deserializes the JSON to a .NET object using . + Returns the indented JSON for this token. - The JSON to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. + + The indented JSON for this token. + - + - Deserializes the JSON to the specified .NET type. + Returns the JSON for this token using the given formatting and converters. - The JSON to deserialize. - The of object being deserialized. - The deserialized object from the JSON string. + Indicates how the output should be formatted. + A collection of s which will be used when writing the token. + The JSON for this token using the given formatting and converters. - + - Deserializes the JSON to the specified .NET type. + Performs an explicit conversion from to . - The type of the object to deserialize to. - The JSON to deserialize. - The deserialized object from the JSON string. + The value. + The result of the conversion. - + - Deserializes the JSON to the given anonymous type. + Performs an explicit conversion from to . - - The anonymous type to deserialize to. This can't be specified - traditionally and must be infered from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - The deserialized anonymous type from the JSON string. + The value. + The result of the conversion. - + - Deserializes the JSON to the given anonymous type using . + Performs an explicit conversion from to of . - - The anonymous type to deserialize to. This can't be specified - traditionally and must be infered from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized anonymous type from the JSON string. + The value. + The result of the conversion. - + - Deserializes the JSON to the specified .NET type using a collection of . + Performs an explicit conversion from to of . - The type of the object to deserialize to. - The JSON to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. + The value. + The result of the conversion. - + - Deserializes the JSON to the specified .NET type using . + Performs an explicit conversion from to of . - The type of the object to deserialize to. - The object to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. + The value. + The result of the conversion. - + - Deserializes the JSON to the specified .NET type using a collection of . + Performs an explicit conversion from to of . - The JSON to deserialize. - The type of the object to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. + The value. + The result of the conversion. - + - Deserializes the JSON to the specified .NET type using . + Performs an explicit conversion from to of . - The JSON to deserialize. - The type of the object to deserialize to. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. + The value. + The result of the conversion. - + - Asynchronously deserializes the JSON to the specified .NET type. - Deserialization will happen on a new thread. + Performs an explicit conversion from to of . - The type of the object to deserialize to. - The JSON to deserialize. - - A task that represents the asynchronous deserialize operation. The value of the TResult parameter contains the deserialized object from the JSON string. - + The value. + The result of the conversion. - + - Asynchronously deserializes the JSON to the specified .NET type using . - Deserialization will happen on a new thread. + Performs an explicit conversion from to of . - The type of the object to deserialize to. - The JSON to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - - A task that represents the asynchronous deserialize operation. The value of the TResult parameter contains the deserialized object from the JSON string. - + The value. + The result of the conversion. - + - Asynchronously deserializes the JSON to the specified .NET type. - Deserialization will happen on a new thread. + Performs an explicit conversion from to . - The JSON to deserialize. - - A task that represents the asynchronous deserialize operation. The value of the TResult parameter contains the deserialized object from the JSON string. - + The value. + The result of the conversion. - + - Asynchronously deserializes the JSON to the specified .NET type using . - Deserialization will happen on a new thread. + Performs an explicit conversion from to . - The JSON to deserialize. - The type of the object to deserialize to. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - - A task that represents the asynchronous deserialize operation. The value of the TResult parameter contains the deserialized object from the JSON string. - + The value. + The result of the conversion. - + - Populates the object with values from the JSON string. + Performs an explicit conversion from to . - The JSON to populate values from. - The target object to populate values onto. + The value. + The result of the conversion. - + - Populates the object with values from the JSON string using . + Performs an explicit conversion from to . - The JSON to populate values from. - The target object to populate values onto. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - + The value. + The result of the conversion. - + - Asynchronously populates the object with values from the JSON string using . + Performs an explicit conversion from to . - The JSON to populate values from. - The target object to populate values onto. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - - A task that represents the asynchronous populate operation. - + The value. + The result of the conversion. - + - Serializes the XML node to a JSON string. + Performs an explicit conversion from to . - The node to serialize. - A JSON string of the XmlNode. + The value. + The result of the conversion. - + - Serializes the XML node to a JSON string using formatting. + Performs an explicit conversion from to of . - The node to serialize. - Indicates how the output is formatted. - A JSON string of the XmlNode. + The value. + The result of the conversion. - + - Serializes the XML node to a JSON string using formatting and omits the root object if is true. + Performs an explicit conversion from to of . - The node to serialize. - Indicates how the output is formatted. - Omits writing the root object. - A JSON string of the XmlNode. + The value. + The result of the conversion. - + - Deserializes the XmlNode from a JSON string. + Performs an explicit conversion from to of . - The JSON string. - The deserialized XmlNode + The value. + The result of the conversion. - + - Deserializes the XmlNode from a JSON string nested in a root elment specified by . + Performs an explicit conversion from to of . - The JSON string. - The name of the root element to append when deserializing. - The deserialized XmlNode + The value. + The result of the conversion. - + - Deserializes the XmlNode from a JSON string nested in a root elment specified by - and writes a .NET array attribute for collections. + Performs an explicit conversion from to of . - The JSON string. - The name of the root element to append when deserializing. - - A flag to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - The deserialized XmlNode + The value. + The result of the conversion. - + - Serializes the to a JSON string. + Performs an explicit conversion from to of . - The node to convert to JSON. - A JSON string of the XNode. + The value. + The result of the conversion. - + - Serializes the to a JSON string using formatting. + Performs an explicit conversion from to of . - The node to convert to JSON. - Indicates how the output is formatted. - A JSON string of the XNode. + The value. + The result of the conversion. - + - Serializes the to a JSON string using formatting and omits the root object if is true. + Performs an explicit conversion from to of . - The node to serialize. - Indicates how the output is formatted. - Omits writing the root object. - A JSON string of the XNode. + The value. + The result of the conversion. - + - Deserializes the from a JSON string. + Performs an explicit conversion from to . - The JSON string. - The deserialized XNode + The value. + The result of the conversion. - + - Deserializes the from a JSON string nested in a root elment specified by . + Performs an explicit conversion from to of . - The JSON string. - The name of the root element to append when deserializing. - The deserialized XNode + The value. + The result of the conversion. - + - Deserializes the from a JSON string nested in a root elment specified by - and writes a .NET array attribute for collections. + Performs an explicit conversion from to of . - The JSON string. - The name of the root element to append when deserializing. - - A flag to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - The deserialized XNode + The value. + The result of the conversion. - + - Gets or sets a function that creates default . - Default settings are automatically used by serialization methods on , - and and on . - To serialize without using any default settings create a with - . + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + The value. + The result of the conversion. - + - The exception thrown when an error occurs during JSON serialization or deserialization. + Performs an explicit conversion from to . + The value. + The result of the conversion. - + - Initializes a new instance of the class. + Performs an explicit conversion from to . + The value. + The result of the conversion. - + - Initializes a new instance of the class - with a specified error message. + Performs an explicit conversion from to . - The error message that explains the reason for the exception. + The value. + The result of the conversion. - + - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. + Performs an explicit conversion from to []. - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. + The value. + The result of the conversion. - + - Initializes a new instance of the class. + Performs an explicit conversion from to . - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). + The value. + The result of the conversion. - + - Serializes and deserializes objects into and from the JSON format. - The enables you to control how objects are encoded into JSON. + Performs an explicit conversion from to of . + The value. + The result of the conversion. - + - Initializes a new instance of the class. + Performs an explicit conversion from to . + The value. + The result of the conversion. - + - Creates a new instance. - The will not use default settings. + Performs an explicit conversion from to of . - - A new instance. - The will not use default settings. - + The value. + The result of the conversion. - + - Creates a new instance using the specified . - The will not use default settings. + Performs an explicit conversion from to . - The settings to be applied to the . - - A new instance using the specified . - The will not use default settings. - + The value. + The result of the conversion. - + - Creates a new instance. - The will use default settings. + Performs an implicit conversion from to . - - A new instance. - The will use default settings. - + The value to create a from. + The initialized with the specified value. - + - Creates a new instance using the specified . - The will use default settings. + Performs an implicit conversion from to . - The settings to be applied to the . - - A new instance using the specified . - The will use default settings. - + The value to create a from. + The initialized with the specified value. - + - Populates the JSON values onto the target object. + Performs an implicit conversion from to . - The that contains the JSON structure to reader values from. - The target object to populate values onto. + The value to create a from. + The initialized with the specified value. - + - Populates the JSON values onto the target object. + Performs an implicit conversion from of to . - The that contains the JSON structure to reader values from. - The target object to populate values onto. + The value to create a from. + The initialized with the specified value. - + - Deserializes the JSON structure contained by the specified . + Performs an implicit conversion from to . - The that contains the JSON structure to deserialize. - The being deserialized. + The value to create a from. + The initialized with the specified value. - + - Deserializes the JSON structure contained by the specified - into an instance of the specified type. + Performs an implicit conversion from of to . - The containing the object. - The of object being deserialized. - The instance of being deserialized. + The value to create a from. + The initialized with the specified value. - + - Deserializes the JSON structure contained by the specified - into an instance of the specified type. + Performs an implicit conversion from of to . - The containing the object. - The type of the object to deserialize. - The instance of being deserialized. + The value to create a from. + The initialized with the specified value. - + - Deserializes the JSON structure contained by the specified - into an instance of the specified type. + Performs an implicit conversion from of to . - The containing the object. - The of object being deserialized. - The instance of being deserialized. + The value to create a from. + The initialized with the specified value. - + - Serializes the specified and writes the JSON structure - to a Stream using the specified . + Performs an implicit conversion from of to . - The used to write the JSON structure. - The to serialize. + The value to create a from. + The initialized with the specified value. - + - Serializes the specified and writes the JSON structure - to a Stream using the specified . + Performs an implicit conversion from of to . - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is Auto to write out the type name if the type of the value does not match. - Specifing the type is optional. - + The value to create a from. + The initialized with the specified value. - + - Serializes the specified and writes the JSON structure - to a Stream using the specified . + Performs an implicit conversion from of to . - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is Auto to write out the type name if the type of the value does not match. - Specifing the type is optional. - + The value to create a from. + The initialized with the specified value. - + - Serializes the specified and writes the JSON structure - to a Stream using the specified . + Performs an implicit conversion from of to . - The used to write the JSON structure. - The to serialize. + The value to create a from. + The initialized with the specified value. - + - Occurs when the errors during serialization and deserialization. + Performs an implicit conversion from to . + The value to create a from. + The initialized with the specified value. - + - Gets or sets the used by the serializer when resolving references. + Performs an implicit conversion from to . + The value to create a from. + The initialized with the specified value. - + - Gets or sets the used by the serializer when resolving type names. + Performs an implicit conversion from to . + The value to create a from. + The initialized with the specified value. - + - Gets or sets the used by the serializer when writing trace messages. + Performs an implicit conversion from of to . - The trace writer. + The value to create a from. + The initialized with the specified value. - + - Gets or sets the equality comparer used by the serializer when comparing references. + Performs an implicit conversion from to . - The equality comparer. + The value to create a from. + The initialized with the specified value. - + - Gets or sets how type name writing and reading is handled by the serializer. + Performs an implicit conversion from of to . + The value to create a from. + The initialized with the specified value. - + - Gets or sets how a type name assembly is written and resolved by the serializer. + Performs an implicit conversion from of to . - The type name assembly format. + The value to create a from. + The initialized with the specified value. - + - Gets or sets how object references are preserved by the serializer. + Performs an implicit conversion from to . + The value to create a from. + The initialized with the specified value. - + - Get or set how reference loops (e.g. a class referencing itself) is handled. + Performs an implicit conversion from of to . + The value to create a from. + The initialized with the specified value. - + - Get or set how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + Performs an implicit conversion from of to . + The value to create a from. + The initialized with the specified value. - + - Get or set how null values are handled during serialization and deserialization. + Performs an implicit conversion from of to . + The value to create a from. + The initialized with the specified value. - + - Get or set how null default are handled during serialization and deserialization. + Performs an implicit conversion from of to . + The value to create a from. + The initialized with the specified value. - + - Gets or sets how objects are created during deserialization. + Performs an implicit conversion from to . - The object creation handling. + The value to create a from. + The initialized with the specified value. - + - Gets or sets how constructors are used during deserialization. + Performs an implicit conversion from to . - The constructor handling. + The value to create a from. + The initialized with the specified value. - + - Gets or sets how metadata properties are used during deserialization. + Performs an implicit conversion from to . - The metadata properties handling. + The value to create a from. + The initialized with the specified value. - + - Gets a collection that will be used during serialization. + Performs an implicit conversion from to . - Collection that will be used during serialization. + The value to create a from. + The initialized with the specified value. - + - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. + Performs an implicit conversion from to . + The value to create a from. + The initialized with the specified value. - + - Gets or sets the used by the serializer when invoking serialization callback methods. + Performs an implicit conversion from [] to . - The context. + The value to create a from. + The initialized with the specified value. - + - Indicates how JSON text output is formatted. + Performs an implicit conversion from to . + The value to create a from. + The initialized with the specified value. - + - Get or set how dates are written to JSON text. + Performs an implicit conversion from to . + The value to create a from. + The initialized with the specified value. - + - Get or set how time zones are handling during serialization and deserialization. + Performs an implicit conversion from of to . + The value to create a from. + The initialized with the specified value. - + - Get or set how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + Performs an implicit conversion from to . + The value to create a from. + The initialized with the specified value. - + - Get or set how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + Performs an implicit conversion from of to . + The value to create a from. + The initialized with the specified value. - + - Get or set how special floating point numbers, e.g. , - and , - are written as JSON text. + Creates a for this token. + A that can be used to read this token and its descendants. - + - Get or set how strings are escaped when writing JSON text. + Creates a from an object. + The object that will be used to create . + A with the value of the specified object. - + - Get or set how and values are formatted when writing JSON text, and the expected date format when reading JSON text. + Creates a from an object using the specified . + The object that will be used to create . + The that will be used when reading the object. + A with the value of the specified object. - + - Gets or sets the culture used when reading JSON. Defaults to . + Creates an instance of the specified .NET type from the . + The object type that the token will be deserialized to. + The new object created from the JSON value. - + - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + Creates an instance of the specified .NET type from the . + The object type that the token will be deserialized to. + The new object created from the JSON value. - + - Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. + Creates an instance of the specified .NET type from the using the specified . - - true if there will be a check for additional JSON content after deserializing an object; otherwise, false. - + The object type that the token will be deserialized to. + The that will be used when creating the object. + The new object created from the JSON value. - + - Contains the LINQ to JSON extension methods. + Creates an instance of the specified .NET type from the using the specified . + The object type that the token will be deserialized to. + The that will be used when creating the object. + The new object created from the JSON value. - + - Returns a collection of tokens that contains the ancestors of every token in the source collection. + Creates a from a . - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the ancestors of every token in the source collection. + A positioned at the token to read into this . + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + - + - Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. + Creates a from a . - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, the ancestors of every token in the source collection. + An positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + - + - Returns a collection of tokens that contains the descendants of every token in the source collection. + Load a from a string that contains JSON. - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the descendants of every token in the source collection. + A that contains JSON. + A populated from the string that contains JSON. - + - Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. + Load a from a string that contains JSON. - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, and the descendants of every token in the source collection. + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. - + - Returns a collection of child properties of every object in the source collection. + Creates a from a . - An of that contains the source collection. - An of that contains the properties of every object in the source collection. + A positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + - + - Returns a collection of child values of every object in the source collection with the given key. + Creates a from a . - An of that contains the source collection. - The token key. - An of that contains the values of every token in the source collection with the given key. + A positioned at the token to read into this . + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + - + - Returns a collection of child values of every object in the source collection. + Selects a using a JPath expression. Selects the token that matches the object path. - An of that contains the source collection. - An of that contains the values of every token in the source collection. + + A that contains a JPath expression. + + A , or null. - + - Returns a collection of converted child values of every object in the source collection with the given key. + Selects a using a JPath expression. Selects the token that matches the object path. - The type to convert the values to. - An of that contains the source collection. - The token key. - An that contains the converted values of every token in the source collection with the given key. + + A that contains a JPath expression. + + A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. + A . - + - Returns a collection of converted child values of every object in the source collection. + Selects a collection of elements using a JPath expression. - The type to convert the values to. - An of that contains the source collection. - An that contains the converted values of every token in the source collection. + + A that contains a JPath expression. + + An of that contains the selected elements. - + - Converts the value. + Selects a collection of elements using a JPath expression. - The type to convert the value to. - A cast as a of . - A converted value. + + A that contains a JPath expression. + + A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. + An of that contains the selected elements. - + - Converts the value. + Returns the responsible for binding operations performed on this object. - The source collection type. - The type to convert the value to. - A cast as a of . - A converted value. + The expression tree representation of the runtime value. + + The to bind this object. + - + - Returns a collection of child tokens of every array in the source collection. + Returns the responsible for binding operations performed on this object. - The source collection type. - An of that contains the source collection. - An of that contains the values of every token in the source collection. + The expression tree representation of the runtime value. + + The to bind this object. + - + - Returns a collection of converted child tokens of every array in the source collection. + Creates a new instance of the . All child tokens are recursively cloned. - An of that contains the source collection. - The type to convert the values to. - The source collection type. - An that contains the converted values of every token in the source collection. + A new instance of the . - + - Returns the input typed as . + Adds an object to the annotation list of this . - An of that contains the source collection. - The input typed as . + The annotation to add. - + - Returns the input typed as . + Get the first annotation object of the specified type from this . - The source collection type. - An of that contains the source collection. - The input typed as . + The type of the annotation to retrieve. + The first annotation object that matches the specified type, or null if no annotation is of the specified type. - + - Represents a JSON constructor. + Gets the first annotation object of the specified type from this . + The of the annotation to retrieve. + The first annotation object that matches the specified type, or null if no annotation is of the specified type. - + - Represents a token that can contain other tokens. + Gets a collection of annotations of the specified type for this . + The type of the annotations to retrieve. + An that contains the annotations for this . - + - Raises the event. + Gets a collection of annotations of the specified type for this . - The instance containing the event data. + The of the annotations to retrieve. + An of that contains the annotations that match the specified type for this . - + - Raises the event. + Removes the annotations of the specified type from this . - The instance containing the event data. + The type of annotations to remove. - + - Raises the event. + Removes the annotations of the specified type from this . - The instance containing the event data. + The of annotations to remove. - + - Returns a collection of the child tokens of this token, in document order. + Compares tokens to determine whether they are equal. - - An of containing the child tokens of this , in document order. - - + - Returns a collection of the child values of this token, in document order. + Determines whether the specified objects are equal. - The type to convert the values to. + The first object of type to compare. + The second object of type to compare. - A containing the child values of this , in document order. + true if the specified objects are equal; otherwise, false. - + - Returns a collection of the descendant tokens for this token in document order. + Returns a hash code for the specified object. - An containing the descendant tokens of the . + The for which a hash code is to be returned. + A hash code for the specified object. + The type of is a reference type and is null. - + - Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - An containing this token, and all the descendant tokens of the . - + - Adds the specified content as children of this . + Gets the at the reader's current position. - The content to be added. - + - Adds the specified content as the first children of this . + Initializes a new instance of the class. - The content to be added. + The token to read from. - + - Creates an that can be used to add tokens to the . + Initializes a new instance of the class. - An that is ready to have content written to it. + The token to read from. + The initial path of the token. It is prepended to the returned . - + - Replaces the children nodes of this token with the specified content. + Reads the next JSON token from the underlying . - The content. + + true if the next token was read successfully; false if there are no more tokens to read. + - + - Removes the child nodes from this token. + Gets the path of the current JSON token. - + - Merge the specified content into this . + Specifies the type of token. - The content to be merged. - + - Merge the specified content into this using . + No token type has been set. - The content to be merged. - The used to merge the content. - + - Occurs when the list changes or an item in the list changes. + A JSON object. - + - Occurs before an item is added to the collection. + A JSON array. - + - Occurs when the items list of the collection has changed, or the collection is reset. + A JSON constructor. - + - Gets the container's children tokens. + A JSON object property. - The container's children tokens. - + - Gets a value indicating whether this token has child tokens. + A comment. - - true if this token has child values; otherwise, false. - - + - Get the first child token of this token. + An integer value. - - A containing the first child token of the . - - + - Get the last child token of this token. + A float value. - - A containing the last child token of the . - - + - Gets the count of child JSON tokens. + A string value. - The count of child JSON tokens - + - Initializes a new instance of the class. + A boolean value. - + - Initializes a new instance of the class from another object. + A null value. - A object to copy from. - + - Initializes a new instance of the class with the specified name and content. + An undefined value. - The constructor name. - The contents of the constructor. - + - Initializes a new instance of the class with the specified name and content. + A date value. - The constructor name. - The contents of the constructor. - + - Initializes a new instance of the class with the specified name. + A raw JSON value. - The constructor name. - + - Writes this token to a . + A collection of bytes value. - A into which this method will write. - A collection of which will be used when writing the token. - + - Loads an from a . + A Guid value. - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - + - Gets the container's children tokens. + A Uri value. - The container's children tokens. - + - Gets or sets the name of this constructor. + A TimeSpan value. - The constructor name. - + - Gets the node type for this . + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - The type. - + - Gets the with the specified key. + Gets the at the writer's current position. - The with the specified key. - + - Represents a collection of objects. + Gets the token being written. - The type of token + The token being written. - + - An empty collection of objects. + Initializes a new instance of the class writing to the given . + The container being written to. - + - Initializes a new instance of the struct. + Initializes a new instance of the class. - The enumerable. - + - Returns an enumerator that iterates through the collection. + Flushes whatever is in the buffer to the underlying . - - A that can be used to iterate through the collection. - - + - Returns an enumerator that iterates through a collection. + Closes this writer. + If is set to true, the JSON is auto-completed. - - An object that can be used to iterate through the collection. - + + Setting to true has no additional effect, since the underlying is a type that cannot be closed. + - + - Determines whether the specified is equal to this instance. + Writes the beginning of a JSON object. - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - + - Determines whether the specified is equal to this instance. + Writes the beginning of a JSON array. - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - + - Returns a hash code for this instance. + Writes the start of a constructor with the given name. - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - + The name of the constructor. - + - Gets the with the specified key. + Writes the end. - + The token. - + - Represents a JSON object. + Writes the property name of a name/value pair on a JSON object. - - - + The name of the property. - + - Initializes a new instance of the class. + Writes a value. + An error will be raised if the value cannot be written as a single JSON token. + The value to write. - + - Initializes a new instance of the class from another object. + Writes a null value. - A object to copy from. - + - Initializes a new instance of the class with the specified content. + Writes an undefined value. - The contents of the object. - + - Initializes a new instance of the class with the specified content. + Writes raw JSON. - The contents of the object. + The raw JSON to write. - + - Gets an of this object's properties. + Writes a comment /*...*/ containing the specified text. - An of this object's properties. + Text to place inside the comment. - + - Gets a the specified name. + Writes a value. - The property name. - A with the specified name or null. + The value to write. - + - Gets an of this object's property values. + Writes a value. - An of this object's property values. + The value to write. - + - Loads an from a . + Writes a value. - A that will be read for the content of the . - A that contains the JSON that was read from the specified . + The value to write. - + - Load a from a string that contains JSON. + Writes a value. - A that contains JSON. - A populated from the string that contains JSON. - - - + The value to write. - + - Creates a from an object. + Writes a value. - The object that will be used to create . - A with the values of the specified object + The value to write. - + - Creates a from an object. + Writes a value. - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object + The value to write. - + - Writes this token to a . + Writes a value. - A into which this method will write. - A collection of which will be used when writing the token. + The value to write. - + - Gets the with the specified property name. + Writes a value. - Name of the property. - The with the specified property name. + The value to write. - + - Gets the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. + Writes a value. - Name of the property. - One of the enumeration values that specifies how the strings will be compared. - The with the specified property name. + The value to write. - - - Tries to get the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. + + + Writes a value. - Name of the property. - The value. - One of the enumeration values that specifies how the strings will be compared. - true if a value was successfully retrieved; otherwise, false. + The value to write. - + - Adds the specified property name. + Writes a value. - Name of the property. - The value. + The value to write. - + - Removes the property with the specified name. + Writes a value. - Name of the property. - true if item was successfully removed; otherwise, false. + The value to write. - + - Tries the get value. + Writes a value. - Name of the property. - The value. - true if a value was successfully retrieved; otherwise, false. + The value to write. - + - Returns an enumerator that iterates through the collection. + Writes a value. - - A that can be used to iterate through the collection. - + The value to write. - + - Raises the event with the provided arguments. + Writes a value. - Name of the property. + The value to write. - + - Raises the event with the provided arguments. + Writes a value. - Name of the property. + The value to write. - + - Returns the properties for this instance of a component. + Writes a [] value. - - A that represents the properties for this component instance. - + The [] value to write. - + - Returns the properties for this instance of a component using the attribute array as a filter. + Writes a value. - An array of type that is used as a filter. - - A that represents the filtered properties for this component instance. - + The value to write. - + - Returns a collection of custom attributes for this instance of a component. + Writes a value. - - An containing the attributes for this object. - + The value to write. - + - Returns the class name of this instance of a component. + Writes a value. - - The class name of the object, or null if the class does not have a name. - + The value to write. - + - Returns the name of this instance of a component. + Represents a value in JSON (string, integer, date, etc). - - The name of the object, or null if the object does not have a name. - - + - Returns a type converter for this instance of a component. + Writes this token to a asynchronously. - - A that is the converter for this object, or null if there is no for this object. - + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. - + - Returns the default event for this instance of a component. + Initializes a new instance of the class from another object. - - An that represents the default event for this object, or null if this object does not have events. - + A object to copy from. - + - Returns the default property for this instance of a component. + Initializes a new instance of the class with the given value. - - A that represents the default property for this object, or null if this object does not have properties. - + The value. - + - Returns an editor of the specified type for this instance of a component. + Initializes a new instance of the class with the given value. - A that represents the editor for this object. - - An of the specified type that is the editor for this object, or null if the editor cannot be found. - + The value. - + - Returns the events for this instance of a component using the specified attribute array as a filter. + Initializes a new instance of the class with the given value. - An array of type that is used as a filter. - - An that represents the filtered events for this component instance. - + The value. - + - Returns the events for this instance of a component. + Initializes a new instance of the class with the given value. - - An that represents the events for this component instance. - + The value. - + - Returns an object that contains the property described by the specified property descriptor. + Initializes a new instance of the class with the given value. - A that represents the property whose owner is to be found. - - An that represents the owner of the specified property. - + The value. - + - Returns the responsible for binding operations performed on this object. + Initializes a new instance of the class with the given value. - The expression tree representation of the runtime value. - - The to bind this object. - + The value. - + - Gets the container's children tokens. + Initializes a new instance of the class with the given value. - The container's children tokens. + The value. - + - Occurs when a property value changes. + Initializes a new instance of the class with the given value. + The value. - + - Occurs when a property value is changing. + Initializes a new instance of the class with the given value. + The value. - + - Gets the node type for this . + Initializes a new instance of the class with the given value. - The type. + The value. - + - Gets the with the specified key. + Initializes a new instance of the class with the given value. - The with the specified key. + The value. - + - Gets or sets the with the specified property name. + Initializes a new instance of the class with the given value. - + The value. - + - Represents a JSON array. + Initializes a new instance of the class with the given value. - - - + The value. - + - Initializes a new instance of the class. + Initializes a new instance of the class with the given value. + The value. - + - Initializes a new instance of the class from another object. + Gets a value indicating whether this token has child tokens. - A object to copy from. + + true if this token has child values; otherwise, false. + - + - Initializes a new instance of the class with the specified content. + Creates a comment with the given value. - The contents of the array. + The value. + A comment with the given value. - + - Initializes a new instance of the class with the specified content. + Creates a string with the given value. - The contents of the array. + The value. + A string with the given value. - + - Loads an from a . + Creates a null value. - A that will be read for the content of the . - A that contains the JSON that was read from the specified . + A null value. - + - Load a from a string that contains JSON. + Creates a undefined value. - A that contains JSON. - A populated from the string that contains JSON. - - - + A undefined value. - + - Creates a from an object. + Gets the node type for this . - The object that will be used to create . - A with the values of the specified object + The type. - + - Creates a from an object. + Gets or sets the underlying token value. - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object + The underlying token value. - + Writes this token to a . A into which this method will write. - A collection of which will be used when writing the token. + A collection of s which will be used when writing the token. - + - Determines the index of a specific item in the . + Indicates whether the current object is equal to another object of the same type. - The object to locate in the . - The index of if found in the list; otherwise, -1. + true if the current object is equal to the parameter; otherwise, false. + An object to compare with this object. - + - Inserts an item to the at the specified index. + Determines whether the specified is equal to the current . - The zero-based index at which should be inserted. - The object to insert into the . - - is not a valid index in the . - The is read-only. + The to compare with the current . + + true if the specified is equal to the current ; otherwise, false. + - + - Removes the item at the specified index. + Serves as a hash function for a particular type. - The zero-based index of the item to remove. - - is not a valid index in the . - The is read-only. + + A hash code for the current . + - + - Returns an enumerator that iterates through the collection. + Returns a that represents this instance. - A that can be used to iterate through the collection. + A that represents this instance. - + - Adds an item to the . + Returns a that represents this instance. - The object to add to the . - The is read-only. + The format. + + A that represents this instance. + - + - Removes all items from the . + Returns a that represents this instance. - The is read-only. + The format provider. + + A that represents this instance. + - + - Determines whether the contains a specific value. + Returns a that represents this instance. - The object to locate in the . + The format. + The format provider. - true if is found in the ; otherwise, false. + A that represents this instance. - + - Copies to. + Returns the responsible for binding operations performed on this object. - The array. - Index of the array. + The expression tree representation of the runtime value. + + The to bind this object. + - + - Removes the first occurrence of a specific object from the . + Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. - The object to remove from the . + An object to compare with this instance. - true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . + A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: + Value + Meaning + Less than zero + This instance is less than . + Zero + This instance is equal to . + Greater than zero + This instance is greater than . - The is read-only. + + is not of the same type as this instance. + - + - Gets the container's children tokens. + Specifies how line information is handled when loading JSON. - The container's children tokens. - + - Gets the node type for this . + Ignore line information. - The type. - + - Gets the with the specified key. + Load line information. - The with the specified key. - + - Gets or sets the at the specified index. + Specifies how JSON arrays are merged together. - - - - Gets a value indicating whether the is read-only. - - true if the is read-only; otherwise, false. + + Concatenate arrays. - + + Union arrays, skipping items that already exist. + + + Replace all array items. + + + Merge array items together, matched by index. + + - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + Specifies how null value properties are merged. - + - Initializes a new instance of the class. + The content's null value properties will be ignored during merging. - The token to read from. - + - Reads the next JSON token from the stream as a []. + The content's null value properties will be merged. - - A [] or a null reference if the next JSON token is null. This method will return null at the end of an array. - - + - Reads the next JSON token from the stream as a . + Specifies the member serialization options for the . - A . This method will return null at the end of an array. - + - Reads the next JSON token from the stream as a . + All public members are serialized by default. Members can be excluded using or . + This is the default member serialization mode. - A . This method will return null at the end of an array. - + - Reads the next JSON token from the stream as a . + Only members marked with or are serialized. + This member serialization mode can also be set by marking the class with . - A . This method will return null at the end of an array. - + - Reads the next JSON token from the stream as a . + All public and private fields are serialized. Members can be excluded using or . + This member serialization mode can also be set by marking the class with + and setting IgnoreSerializableAttribute on to false. - A . This method will return null at the end of an array. - + - Reads the next JSON token from the stream as a . + Specifies metadata property handling options for the . - A . This method will return null at the end of an array. - + - Reads the next JSON token from the stream. + Read metadata properties located at the start of a JSON object. - - true if the next token was read successfully; false if there are no more tokens to read. - - + - Gets the at the reader's current position. + Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. - + - Gets the path of the current JSON token. + Do not try to read metadata properties. - + - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + Specifies missing member handling options for the . - + - Initializes a new instance of the class writing to the given . + Ignore a missing member and do not attempt to deserialize it. - The container being written to. - + - Initializes a new instance of the class. + Throw a when a missing member is encountered during deserialization. - + - Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream. + Specifies null value handling options for the . + + + + - + - Closes this stream and the underlying stream. + Include null values when serializing and deserializing objects. - + - Writes the beginning of a JSON object. + Ignore null values when serializing and deserializing objects. - + - Writes the beginning of a JSON array. + Specifies how object creation is handled by the . - + - Writes the start of a constructor with the given name. + Reuse existing objects, create new objects when needed. - The name of the constructor. - + - Writes the end. + Only reuse existing objects. - The token. - + - Writes the property name of a name/value pair on a JSON object. + Always create new objects. - The name of the property. - + - Writes a value. - An error will raised if the value cannot be written as a single JSON token. + Specifies reference handling options for the . + Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement . - The value to write. + + + - + - Writes a null value. + Do not preserve references when serializing types. - + - Writes an undefined value. + Preserve references when serializing into a JSON object structure. - + - Writes raw JSON. + Preserve references when serializing into a JSON array structure. - The raw JSON to write. - + - Writes out a comment /*...*/ containing the specified text. + Preserve references when serializing. - Text to place inside the comment. - + - Writes a value. + Specifies reference loop handling options for the . - The value to write. - + - Writes a value. + Throw a when a loop is encountered. - The value to write. - + - Writes a value. + Ignore loop references and do not serialize. - The value to write. - + - Writes a value. + Serialize loop references. - The value to write. - + - Writes a value. + Indicating whether a property is required. - The value to write. - + - Writes a value. + The property is not required. The default state. - The value to write. - + - Writes a value. + The property must be defined in JSON but can be a null value. - The value to write. - + - Writes a value. + The property must be defined in JSON and cannot be a null value. - The value to write. - + - Writes a value. + The property is not required but it cannot be a null value. - The value to write. - + - Writes a value. + + Contains the JSON schema extension methods. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + - The value to write. - + - Writes a value. + + Determines whether the is valid. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + - The value to write. + The source to test. + The schema to test with. + + true if the specified is valid; otherwise, false. + - + - Writes a value. + + Determines whether the is valid. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + - The value to write. + The source to test. + The schema to test with. + When this method returns, contains any error messages generated while validating. + + true if the specified is valid; otherwise, false. + - + - Writes a value. + + Validates the specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + - The value to write. + The source to test. + The schema to test with. - + - Writes a value. + + Validates the specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + - The value to write. + The source to test. + The schema to test with. + The validation event handler. - + - Writes a value. + + An in-memory representation of a JSON Schema. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + - The value to write. - + - Writes a value. + Gets or sets the id. - The value to write. - + - Writes a [] value. + Gets or sets the title. - The [] value to write. - + - Writes a value. + Gets or sets whether the object is required. - The value to write. - + - Writes a value. + Gets or sets whether the object is read-only. - The value to write. - + - Writes a value. + Gets or sets whether the object is visible to users. - The value to write. - + - Gets the at the writer's current position. + Gets or sets whether the object is transient. - + - Gets the token being writen. + Gets or sets the description of the object. - The token being writen. - + - Represents a JSON property. + Gets or sets the types of values allowed by the object. + The type. - + - Initializes a new instance of the class from another object. + Gets or sets the pattern. - A object to copy from. + The pattern. - + - Initializes a new instance of the class. + Gets or sets the minimum length. - The property name. - The property content. + The minimum length. - + - Initializes a new instance of the class. + Gets or sets the maximum length. - The property name. - The property content. + The maximum length. - + - Writes this token to a . + Gets or sets a number that the value should be divisible by. - A into which this method will write. - A collection of which will be used when writing the token. + A number that the value should be divisible by. - + - Loads an from a . + Gets or sets the minimum. - A that will be read for the content of the . - A that contains the JSON that was read from the specified . + The minimum. - + - Gets the container's children tokens. + Gets or sets the maximum. - The container's children tokens. + The maximum. - + - Gets the property name. + Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). - The property name. + A flag indicating whether the value can not equal the number defined by the minimum attribute (). - + - Gets or sets the property value. + Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). - The property value. + A flag indicating whether the value can not equal the number defined by the maximum attribute (). - + - Gets the node type for this . + Gets or sets the minimum number of items. - The type. + The minimum number of items. - + - Specifies the type of token. + Gets or sets the maximum number of items. + The maximum number of items. - + - No token type has been set. + Gets or sets the of items. + The of items. - + - A JSON object. + Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . + + true if items are validated using their array position; otherwise, false. + - + - A JSON array. + Gets or sets the of additional items. + The of additional items. - + - A JSON constructor. + Gets or sets a value indicating whether additional items are allowed. + + true if additional items are allowed; otherwise, false. + - + - A JSON object property. + Gets or sets whether the array items must be unique. - + - A comment. + Gets or sets the of properties. + The of properties. - + - An integer value. + Gets or sets the of additional properties. + The of additional properties. - + - A float value. + Gets or sets the pattern properties. + The pattern properties. - + - A string value. + Gets or sets a value indicating whether additional properties are allowed. + + true if additional properties are allowed; otherwise, false. + - + - A boolean value. + Gets or sets the required property if this property is present. + The required property if this property is present. - + - A null value. + Gets or sets the a collection of valid enum values allowed. + A collection of valid enum values allowed. - + - An undefined value. + Gets or sets disallowed types. + The disallowed types. - + - A date value. + Gets or sets the default value. + The default value. - + - A raw JSON value. + Gets or sets the collection of that this schema extends. + The collection of that this schema extends. - + - A collection of bytes value. + Gets or sets the format. + The format. - + - A Guid value. + Initializes a new instance of the class. - + - A Uri value. + Reads a from the specified . + The containing the JSON Schema to read. + The object representing the JSON Schema. - + - A TimeSpan value. + Reads a from the specified . + The containing the JSON Schema to read. + The to use when resolving schema references. + The object representing the JSON Schema. - + - - Contains the JSON schema extension methods. - - - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. - + Load a from a string that contains JSON Schema. + A that contains JSON Schema. + A populated from the string that contains JSON Schema. - + - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. - + Load a from a string that contains JSON Schema using the specified . - The source to test. - The schema to test with. - - true if the specified is valid; otherwise, false. - + A that contains JSON Schema. + The resolver. + A populated from the string that contains JSON Schema. - + - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. - + Writes this schema to a . - The source to test. - The schema to test with. - When this method returns, contains any error messages generated while validating. - - true if the specified is valid; otherwise, false. - + A into which this method will write. - + - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. - + Writes this schema to a using the specified . - The source to test. - The schema to test with. + A into which this method will write. + The resolver used. - + - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. - + Returns a that represents the current . - The source to test. - The schema to test with. - The validation event handler. + + A that represents the current . + @@ -7243,10 +9243,28 @@ Returns detailed information about the schema exception. - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + Initializes a new instance of the class. @@ -7265,7 +9283,7 @@ with a specified error message and a reference to the inner exception that is the cause of this exception. The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. + The exception that is the cause of the current exception, or null if no inner exception is specified. @@ -7273,26 +9291,61 @@ The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). + The parameter is null. + The class name is null or is zero (0). - + - Gets the line number indicating where the error occurred. + + Generates a from a specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + - The line number indicating where the error occurred. - + - Gets the line position indicating where the error occurred. + Gets or sets how undefined schemas are handled by the serializer. - The line position indicating where the error occurred. - + - Gets the path to the JSON where the error occurred. + Gets or sets the contract resolver. - The path to the JSON where the error occurred. + The contract resolver. + + + + Generate a from the specified type. + + The type to generate a from. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + The used to resolve schema references. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + Specify whether the generated root will be nullable. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + The used to resolve schema references. + Specify whether the generated root will be nullable. + A generated from the specified type. @@ -7300,10 +9353,16 @@ Resolves from an id. - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + Gets or sets the loaded schemas. + + The loaded schemas. + Initializes a new instance of the class. @@ -7316,11 +9375,60 @@ The id. A for the specified reference. - + - Gets or sets the loaded schemas. + + The value types allowed by the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + No type specified. + + + + + String type. + + + + + Float type. + + + + + Integer type. + + + + + Boolean type. + + + + + Object type. + + + + + Array type. + + + + + Null type. + + + + + Any type. - The loaded schemas. @@ -7328,7 +9436,7 @@ Specifies undefined schema Id handling options for the . - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. @@ -7353,7 +9461,7 @@ Returns detailed information related to the . - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. @@ -7381,51 +9489,141 @@ Represents the callback method that will handle JSON schema validation events and the . - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - + - Resolves member mappings for a type, camel casing property names. + A camel case naming strategy. - + - Used by to resolves a for a given . + Initializes a new instance of the class. + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + - + - Used by to resolves a for a given . + Initializes a new instance of the class. - - - - + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + - + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Resolves member mappings for a type, camel casing property names. + + + + + Initializes a new instance of the class. + + + Resolves the contract for a given type. The type to resolve a contract for. The contract for a given type. - + - Initializes a new instance of the class. + Used by to resolve a for a given . + + + + + Gets a value indicating whether members are being get and set using dynamic code generation. + This value is determined by the runtime permissions available. + + + true if using dynamic code generation; otherwise, false. + + + + + Gets or sets the default members search flags. + + The default members search flags. + + + + Gets or sets a value indicating whether compiler generated members should be serialized. + + + true if serialized compiler generated members; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore the interface when serializing and deserializing types. + + + true if the interface will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore the attribute when serializing and deserializing types. + + + true if the attribute will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types. + + + true if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types. + + + true if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. + The naming strategy used to resolve how property names and dictionary keys are serialized. - + Initializes a new instance of the class. - - If set to true the will use a cached shared with other resolvers of the same type. - Sharing the cache will significantly improve performance with multiple resolver instances because expensive reflection will only - happen once. This setting can cause unexpected behavior if different instances of the resolver are suppose to produce different - results. When set to false it is highly recommended to reuse instances with the . - @@ -7466,10 +9664,10 @@ - Resolves the default for the contract. + Resolves the default for the contract. Type of the object. - The contract's default . + The contract's default . @@ -7557,76 +9755,49 @@ Name of the property. Resolved name of the property. - - - Resolves the key of the dictionary. By default is used to resolve dictionary keys. - - Key of the dictionary. - Resolved key of the dictionary. - - - - Gets the resolved name of the property. - - Name of the property. - Name of the property. - - - - Gets a value indicating whether members are being get and set using dynamic code generation. - This value is determined by the runtime permissions available. - - - true if using dynamic code generation; otherwise, false. - - - - - Gets or sets the default members search flags. - - The default members search flags. - - + - Gets or sets a value indicating whether compiler generated members should be serialized. + Resolves the name of the extension data. By default no changes are made to extension data names. - - true if serialized compiler generated members; otherwise, false. - + Name of the extension data. + Resolved name of the extension data. - + - Gets or sets a value indicating whether to ignore the interface when serializing and deserializing types. + Resolves the key of the dictionary. By default is used to resolve dictionary keys. - - true if the interface will be ignored when serializing and deserializing types; otherwise, false. - + Key of the dictionary. + Resolved key of the dictionary. - + - Gets or sets a value indicating whether to ignore the attribute when serializing and deserializing types. + Gets the resolved name of the property. - - true if the attribute will be ignored when serializing and deserializing types; otherwise, false. - + Name of the property. + Name of the property. - + - Initializes a new instance of the class. + The default naming strategy. Property names and dictionary keys are unchanged. - + - Resolves the name of the property. + Resolves the specified property name. - Name of the property. - The property name camel cased. + The property name to resolve. + The resolved property name. The default serialization binder used when resolving and loading classes from type names. + + + Initializes a new instance of the class. + + When overridden in a derived class, controls the binding of a serialized object to a type. @@ -7642,8 +9813,56 @@ When overridden in a derived class, controls the binding of a serialized object to a type. The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + + + Represents a trace writer that writes to the application's instances. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + + The that will be used to filter the trace messages passed to the writer. + + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Get and set values for a using dynamic methods. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. @@ -7680,895 +9899,917 @@ true if handled; otherwise, false. - + - Contract details for a used by the . + Provides data for the Error event. - + - Initializes a new instance of the class. + Gets the current object the error event is being raised against. - The underlying type for the contract. + The current object the error event is being raised against. - + - Gets the of the collection items. + Gets the error context. - The of the collection items. + The error context. - + - Gets a value indicating whether the collection type is a multidimensional array. + Initializes a new instance of the class. - true if the collection type is a multidimensional array; otherwise, false. + The current object. + The error context. - + - Handles serialization callback events. + Get and set values for a using dynamic methods. - The object that raised the callback event. - The streaming context. - + - Handles serialization error callback events. + Initializes a new instance of the class. - The object that raised the callback event. - The streaming context. - The error context. + The member info. - + - Sets extension data for an object during deserialization. + Sets the value. - The object to set extension data on. - The extension data key. - The extension data value. + The target to set the value on. + The value to set on the target. - + - Gets extension data for an object during serialization. + Gets the value. - The object to set extension data on. + The target to get the value from. + The value. - + - Contract details for a used by the . + Provides methods to get attributes. - + - Initializes a new instance of the class. + Returns a collection of all of the attributes, or an empty collection if there are no attributes. - The underlying type for the contract. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. - + - Gets or sets the property name resolver. + Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - The property name resolver. + The type of the attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. - + - Gets or sets the dictionary key resolver. + Used by to resolve a for a given . - The dictionary key resolver. + + + + - + - Gets the of the dictionary keys. + Resolves the contract for a given type. - The of the dictionary keys. + The type to resolve a contract for. + The contract for a given type. - + - Gets the of the dictionary values. + Used to resolve references when serializing and deserializing JSON by the . - The of the dictionary values. - + - Maps a JSON property to a .NET member or constructor parameter. + Resolves a reference to its object. + The serialization context. + The reference to resolve. + The object that was resolved from the reference. - + - Returns a that represents this instance. + Gets the reference for the specified object. + + The serialization context. + The object to get a reference for. + The reference to the object. + + + + Determines whether the specified object is referenced. + The serialization context. + The object to test for a reference. - A that represents this instance. + true if the specified object is referenced; otherwise, false. - + - Gets or sets the name of the property. + Adds a reference to the specified object. - The name of the property. + The serialization context. + The reference. + The object to reference. - + - Gets or sets the type that declared this property. + Allows users to control class loading and mandate what class to load. - The type that declared this property. - + - Gets or sets the order of serialization and deserialization of a member. + When implemented, controls the binding of a serialized object to a type. - The numeric order of serialization or deserialization. + Specifies the name of the serialized object. + Specifies the name of the serialized object + The type of the object the formatter creates a new instance of. - + - Gets or sets the name of the underlying member or parameter. + When implemented, controls the binding of a serialized object to a type. - The name of the underlying member or parameter. + The type of the object the formatter creates a new instance of. + Specifies the name of the serialized object. + Specifies the name of the serialized object. - + - Gets the that will get and set the during serialization. + Represents a trace writer. - The that will get and set the during serialization. - + - Gets or sets the for this property. + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. - The for this property. + The that will be used to filter the trace messages passed to the writer. - + - Gets or sets the type of the property. + Writes the specified trace level, message and optional exception. - The type of the property. + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. - + - Gets or sets the for the property. - If set this converter takes presidence over the contract converter for the property type. + Provides methods to get and set values. - The converter. - + - Gets or sets the member converter. + Sets the value. - The member converter. + The target to set the value on. + The value to set on the target. - + - Gets or sets a value indicating whether this is ignored. + Gets the value. - true if ignored; otherwise, false. + The target to get the value from. + The value. - + - Gets or sets a value indicating whether this is readable. + Contract details for a used by the . - true if readable; otherwise, false. - + - Gets or sets a value indicating whether this is writable. + Gets the of the collection items. - true if writable; otherwise, false. + The of the collection items. - + - Gets or sets a value indicating whether this has a member attribute. + Gets a value indicating whether the collection type is a multidimensional array. - true if has a member attribute; otherwise, false. + true if the collection type is a multidimensional array; otherwise, false. - + - Gets the default value. + Gets or sets the function used to create the object. When set this function will override . - The default value. + The function used to create the object. - + - Gets or sets a value indicating whether this is required. + Gets a value indicating whether the creator has a parameter with the collection values. - A value indicating whether this is required. + true if the creator has a parameter with the collection values; otherwise, false. - + - Gets or sets a value indicating whether this property preserves object references. + Initializes a new instance of the class. - - true if this instance is reference; otherwise, false. - + The underlying type for the contract. - + - Gets or sets the property null value handling. + Contract details for a used by the . - The null value handling. - + - Gets or sets the property default value handling. + Gets or sets the default collection items . - The default value handling. + The converter. - + - Gets or sets the property reference loop handling. + Gets or sets a value indicating whether the collection items preserve object references. - The reference loop handling. + true if collection items preserve object references; otherwise, false. - + - Gets or sets the property object creation handling. + Gets or sets the collection item reference loop handling. - The object creation handling. + The reference loop handling. - + - Gets or sets or sets the type name handling. + Gets or sets the collection item type name handling. The type name handling. - + - Gets or sets a predicate used to determine whether the property should be serialize. + Initializes a new instance of the class. - A predicate used to determine whether the property should be serialize. + The underlying type for the contract. - + - Gets or sets a predicate used to determine whether the property should be serialized. + Handles serialization callback events. - A predicate used to determine whether the property should be serialized. + The object that raised the callback event. + The streaming context. - + - Gets or sets an action used to set whether the property has been deserialized. + Handles serialization error callback events. - An action used to set whether the property has been deserialized. + The object that raised the callback event. + The streaming context. + The error context. - + - Gets or sets the converter used when serializing the property's collection items. + Sets extension data for an object during deserialization. - The collection's items converter. + The object to set extension data on. + The extension data key. + The extension data value. - + - Gets or sets whether this property's collection items are serialized as a reference. + Gets extension data for an object during serialization. - Whether this property's collection items are serialized as a reference. + The object to set extension data on. - + - Gets or sets the the type name handling used when serializing the property's collection items. + Contract details for a used by the . - The collection's items type name handling. - + - Gets or sets the the reference loop handling used when serializing the property's collection items. + Gets the underlying type for the contract. - The collection's items reference loop handling. + The underlying type for the contract. - + - A collection of objects. + Gets or sets the type created during deserialization. + The type created during deserialization. - + - Initializes a new instance of the class. + Gets or sets whether this type contract is serialized as a reference. - The type. + Whether this type contract is serialized as a reference. - + - When implemented in a derived class, extracts the key from the specified element. + Gets or sets the default for this contract. - The element from which to extract the key. - The key for the specified element. + The converter. - + - Adds a object. + Gets the internally resolved for the contract's type. + This converter is used as a fallback converter when no other converter is resolved. + Setting will always override this converter. - The property to add to the collection. - + - Gets the closest matching object. - First attempts to get an exact case match of propertyName and then - a case insensitive match. + Gets or sets all methods called immediately after deserialization of the object. - Name of the property. - A matching property if found. + The methods called immediately after deserialization of the object. - + - Gets a property by property name. + Gets or sets all methods called during deserialization of the object. - The name of the property to get. - Type property name string comparison. - A matching property if found. + The methods called during deserialization of the object. - + - Specifies missing member handling options for the . + Gets or sets all methods called after serialization of the object graph. + The methods called after serialization of the object graph. - + - Ignore a missing member and do not attempt to deserialize it. + Gets or sets all methods called before serialization of the object. + The methods called before serialization of the object. - + - Throw a when a missing member is encountered during deserialization. + Gets or sets all method called when an error is thrown during the serialization of the object. + The methods called when an error is thrown during the serialization of the object. - + - Specifies null value handling options for the . + Gets or sets the default creator method used to create the object. - - - - + The default creator method used to create the object. - + - Include null values when serializing and deserializing objects. + Gets or sets a value indicating whether the default creator is non-public. + true if the default object creator is non-public; otherwise, false. - + - Ignore null values when serializing and deserializing objects. + Contract details for a used by the . - + - Specifies reference loop handling options for the . + Gets or sets the dictionary key resolver. + The dictionary key resolver. - + - Throw a when a loop is encountered. + Gets the of the dictionary keys. + The of the dictionary keys. - + - Ignore loop references and do not serialize. + Gets the of the dictionary values. + The of the dictionary values. - + - Serialize loop references. + Gets or sets the function used to create the object. When set this function will override . + The function used to create the object. - + - - An in-memory representation of a JSON Schema. - - - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. - + Gets a value indicating whether the creator has a parameter with the dictionary values. + true if the creator has a parameter with the dictionary values; otherwise, false. - + - Initializes a new instance of the class. + Initializes a new instance of the class. + The underlying type for the contract. - + - Reads a from the specified . + Contract details for a used by the . - The containing the JSON Schema to read. - The object representing the JSON Schema. - + - Reads a from the specified . + Gets the object's properties. - The containing the JSON Schema to read. - The to use when resolving schema references. - The object representing the JSON Schema. + The object's properties. - + - Load a from a string that contains schema JSON. + Gets or sets the property name resolver. - A that contains JSON. - A populated from the string that contains JSON. + The property name resolver. - + - Parses the specified json. + Initializes a new instance of the class. - The json. - The resolver. - A populated from the string that contains JSON. + The underlying type for the contract. - + - Writes this schema to a . + Contract details for a used by the . - A into which this method will write. - + - Writes this schema to a using the specified . + Gets or sets the object constructor. - A into which this method will write. - The resolver used. + The object constructor. - + - Returns a that represents the current . + Initializes a new instance of the class. - - A that represents the current . - + The underlying type for the contract. - + - Gets or sets the id. + Contract details for a used by the . - + - Gets or sets the title. + Initializes a new instance of the class. + The underlying type for the contract. - + - Gets or sets whether the object is required. + Contract details for a used by the . - + - Gets or sets whether the object is read only. + Gets or sets the object member serialization. + The member object serialization. - + - Gets or sets whether the object is visible to users. + Gets or sets the missing member handling used when deserializing this object. + The missing member handling. - + - Gets or sets whether the object is transient. + Gets or sets a value that indicates whether the object's properties are required. + + A value indicating whether the object's properties are required. + - + - Gets or sets the description of the object. + Gets or sets how the object's properties with null values are handled during serialization and deserialization. + How the object's properties with null values are handled during serialization and deserialization. - + - Gets or sets the types of values allowed by the object. + Gets the object's properties. - The type. + The object's properties. - + - Gets or sets the pattern. + Gets a collection of instances that define the parameters used with . - The pattern. - + - Gets or sets the minimum length. + Gets or sets the function used to create the object. When set this function will override . + This function is called with a collection of arguments which are defined by the collection. - The minimum length. + The function used to create the object. - + - Gets or sets the maximum length. + Gets or sets the extension data setter. - The maximum length. - + - Gets or sets a number that the value should be divisble by. + Gets or sets the extension data getter. - A number that the value should be divisble by. - + - Gets or sets the minimum. + Gets or sets the extension data value type. - The minimum. - + - Gets or sets the maximum. + Gets or sets the extension data name resolver. - The maximum. + The extension data name resolver. - + - Gets or sets a flag indicating whether the value can not equal the number defined by the "minimum" attribute. + Initializes a new instance of the class. - A flag indicating whether the value can not equal the number defined by the "minimum" attribute. + The underlying type for the contract. - + - Gets or sets a flag indicating whether the value can not equal the number defined by the "maximum" attribute. + Contract details for a used by the . - A flag indicating whether the value can not equal the number defined by the "maximum" attribute. - + - Gets or sets the minimum number of items. + Initializes a new instance of the class. - The minimum number of items. + The underlying type for the contract. - + - Gets or sets the maximum number of items. + Maps a JSON property to a .NET member or constructor parameter. - The maximum number of items. - + - Gets or sets the of items. + Gets or sets the name of the property. - The of items. + The name of the property. - + - Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . + Gets or sets the type that declared this property. - - true if items are validated using their array position; otherwise, false. - + The type that declared this property. - + - Gets or sets the of additional items. + Gets or sets the order of serialization of a member. - The of additional items. + The numeric order of serialization. - + - Gets or sets a value indicating whether additional items are allowed. + Gets or sets the name of the underlying member or parameter. - - true if additional items are allowed; otherwise, false. - + The name of the underlying member or parameter. - + - Gets or sets whether the array items must be unique. + Gets the that will get and set the during serialization. + The that will get and set the during serialization. - + - Gets or sets the of properties. + Gets or sets the for this property. - The of properties. + The for this property. - + - Gets or sets the of additional properties. + Gets or sets the type of the property. - The of additional properties. + The type of the property. - + - Gets or sets the pattern properties. + Gets or sets the for the property. + If set this converter takes precedence over the contract converter for the property type. - The pattern properties. + The converter. - + - Gets or sets a value indicating whether additional properties are allowed. + Gets or sets the member converter. - - true if additional properties are allowed; otherwise, false. - + The member converter. - + - Gets or sets the required property if this property is present. + Gets or sets a value indicating whether this is ignored. - The required property if this property is present. + true if ignored; otherwise, false. - + - Gets or sets the a collection of valid enum values allowed. + Gets or sets a value indicating whether this is readable. - A collection of valid enum values allowed. + true if readable; otherwise, false. - + - Gets or sets disallowed types. + Gets or sets a value indicating whether this is writable. - The disallow types. + true if writable; otherwise, false. - + - Gets or sets the default value. + Gets or sets a value indicating whether this has a member attribute. - The default value. + true if has a member attribute; otherwise, false. - + - Gets or sets the collection of that this schema extends. + Gets the default value. - The collection of that this schema extends. + The default value. - + - Gets or sets the format. + Gets or sets a value indicating whether this is required. - The format. + A value indicating whether this is required. - + - - Generates a from a specified . - - - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. - + Gets a value indicating whether has a value specified. - + - Generate a from the specified type. + Gets or sets a value indicating whether this property preserves object references. - The type to generate a from. - A generated from the specified type. + + true if this instance is reference; otherwise, false. + - + - Generate a from the specified type. + Gets or sets the property null value handling. - The type to generate a from. - The used to resolve schema references. - A generated from the specified type. + The null value handling. - + - Generate a from the specified type. + Gets or sets the property default value handling. - The type to generate a from. - Specify whether the generated root will be nullable. - A generated from the specified type. + The default value handling. - + - Generate a from the specified type. + Gets or sets the property reference loop handling. - The type to generate a from. - The used to resolve schema references. - Specify whether the generated root will be nullable. - A generated from the specified type. + The reference loop handling. - + - Gets or sets how undefined schemas are handled by the serializer. + Gets or sets the property object creation handling. + The object creation handling. - + - Gets or sets the contract resolver. + Gets or sets or sets the type name handling. - The contract resolver. + The type name handling. - + - - The value types allowed by the . - - - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. - + Gets or sets a predicate used to determine whether the property should be serialized. + A predicate used to determine whether the property should be serialized. - + - No type specified. + Gets or sets a predicate used to determine whether the property should be deserialized. + A predicate used to determine whether the property should be deserialized. - + - String type. + Gets or sets a predicate used to determine whether the property should be serialized. + A predicate used to determine whether the property should be serialized. - + - Float type. + Gets or sets an action used to set whether the property has been deserialized. + An action used to set whether the property has been deserialized. - + - Integer type. + Returns a that represents this instance. + + A that represents this instance. + - + - Boolean type. + Gets or sets the converter used when serializing the property's collection items. + The collection's items converter. - + - Object type. + Gets or sets whether this property's collection items are serialized as a reference. + Whether this property's collection items are serialized as a reference. - + - Array type. + Gets or sets the type name handling used when serializing the property's collection items. + The collection's items type name handling. - + - Null type. + Gets or sets the reference loop handling used when serializing the property's collection items. + The collection's items reference loop handling. - + - Any type. + A collection of objects. - + - Contract details for a used by the . + Initializes a new instance of the class. + The type. - + - Initializes a new instance of the class. + When implemented in a derived class, extracts the key from the specified element. - The underlying type for the contract. + The element from which to extract the key. + The key for the specified element. - + - Gets or sets the object member serialization. + Adds a object. - The member object serialization. + The property to add to the collection. - + - Gets or sets a value that indicates whether the object's properties are required. + Gets the closest matching object. + First attempts to get an exact case match of and then + a case insensitive match. - - A value indicating whether the object's properties are required. - + Name of the property. + A matching property if found. - + - Gets the object's properties. + Gets a property by property name. - The object's properties. + The name of the property to get. + Type property name string comparison. + A matching property if found. - + - Gets the constructor parameters required for any non-default constructor + Contract details for a used by the . - + - Gets a collection of instances that define the parameters used with . + Initializes a new instance of the class. + The underlying type for the contract. - + - Gets or sets the override constructor used to create the object. - This is set when a constructor is marked up using the - JsonConstructor attribute. + Lookup and create an instance of the type described by the argument. - The override constructor. + The type to create. + Optional arguments to pass to an initializing constructor of the JsonConverter. + If null, the default constructor is used. - + - Gets or sets the parametrized constructor used to create the object. + Represents a trace writer that writes to memory. When the trace message limit is + reached then old trace messages will be removed as new messages are added. - The parametrized constructor. - + - Gets or sets the function used to create the object. When set this function will override . - This function is called with a collection of arguments which are defined by the collection. + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. - The function used to create the object. + + The that will be used to filter the trace messages passed to the writer. + - + - Gets or sets the extension data setter. + Initializes a new instance of the class. - + - Gets or sets the extension data getter. + Writes the specified trace level, message and optional exception. + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. - + - Contract details for a used by the . + Returns an enumeration of the most recent trace messages. + An enumeration of the most recent trace messages. - + - Initializes a new instance of the class. + Returns a of the most recent trace messages. - The underlying type for the contract. + + A of the most recent trace messages. + - + - Lookup and create an instance of the JsonConverter type described by the argument. + A base class for resolving how property names and dictionary keys are serialized. - The JsonConverter type to create. - Optional arguments to pass to an initializing constructor of the JsonConverter. - If null, the default constructor is used. - + - Create a factory function that can be used to create instances of a JsonConverter described by the - argument type. The returned function can then be used to either invoke the converter's default ctor, or any - parameterized constructors by way of an object array. + A flag indicating whether dictionary keys should be processed. + Defaults to false. - + - Get and set values for a using reflection. + A flag indicating whether extension data names should be processed. + Defaults to false. - + - Initializes a new instance of the class. + A flag indicating whether explicitly specified property names, + e.g. a property name customized with a , should be processed. + Defaults to false. - The member info. - + - Sets the value. + Gets the serialized name for a given property name. - The target to set the value on. - The value to set on the target. + The initial property name. + A flag indicating whether the property has had a name explicitly specified. + The serialized property name. - + - Gets the value. + Gets the serialized name for a given extension data name. - The target to get the value from. - The value. + The initial extension data name. + The serialized extension data name. - + - When applied to a method, specifies that the method is called when an error occurs serializing an object. + Gets the serialized key for a given dictionary key. + The initial dictionary key. + The serialized dictionary key. - + - Helper method for generating a MetaObject which calls a - specific method on Dynamic that returns a result + Resolves the specified property name. + The property name to resolve. + The resolved property name. - + - Helper method for generating a MetaObject which calls a - specific method on Dynamic, but uses one of the arguments for - the result. + Hash code calculation + - + - Helper method for generating a MetaObject which calls a - specific method on Dynamic, but uses one of the arguments for - the result. + Object equality implementation + + - + - Returns a Restrictions object which includes our current restrictions merged - with a restriction limiting our type + Compare to another NamingStrategy + + @@ -8576,187 +10817,240 @@ The object type to create. - + - Specifies type name handling options for the . + When applied to a method, specifies that the method is called when an error occurs serializing an object. - + - Do not include the .NET type name when serializing types. + Provides methods to get attributes from a , , or . - + - Include the .NET type name when serializing into a JSON object structure. + Initializes a new instance of the class. + The instance to get attributes for. This parameter should be a , , or . - + - Include the .NET type name when serializing into a JSON array structure. + Returns a collection of all of the attributes, or an empty collection if there are no attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. - + - Always include the .NET type name when serializing. + Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + The type of the attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. - + - Include the .NET type name when the type of the object being serialized is not the same as its declared type. + Get and set values for a using reflection. - + - Converts the value to the specified type. If the value is unable to be converted, the - value is checked whether it assignable to the specified type. + Initializes a new instance of the class. - The value to convert. - The culture to use when converting. - The type to convert or cast the value to. - - The converted type. If conversion was unsuccessful, the initial value - is returned if assignable to the target type. - + The member info. - + - Gets a dictionary of the names and values of an Enum type. + Sets the value. - + The target to set the value on. + The value to set on the target. - + - Gets a dictionary of the names and values of an Enum type. + Gets the value. - The enum type to get names and values for. - + The target to get the value from. + The value. - + - Specifies the type of JSON token. + A snake case naming strategy. - + - This is returned by the if a method has not been called. + Initializes a new instance of the class. + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + - + - An object start token. + Initializes a new instance of the class. + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + - + - An array start token. + Initializes a new instance of the class. - + - A constructor start token. + Resolves the specified property name. + The property name to resolve. + The resolved property name. - + - An object property name. + Specifies how strings are escaped when writing JSON text. - + - A comment. + Only control characters (e.g. newline) are escaped. - + - Raw JSON. + All non-ASCII and control characters (e.g. newline) are escaped. - + - An integer. + HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. - + - A float. + Indicates the method that will be used during deserialization for locating and loading assemblies. - + - A string. + In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method of the class is used to load the assembly. - + - A boolean. + In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. - + - A null token. + Specifies type name handling options for the . + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + - + - An undefined token. + Do not include the .NET type name when serializing types. - + - An object end token. + Include the .NET type name when serializing into a JSON object structure. - + - An array end token. + Include the .NET type name when serializing into a JSON array structure. - + - A constructor end token. + Always include the .NET type name when serializing. - + - A Date. + Include the .NET type name when the type of the object being serialized is not the same as its declared type. + Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON + you must specify a root type object with + or . - + - Byte data. + Determines whether the collection is null or empty. + The collection. + + true if the collection is null or empty; otherwise, false. + - + - Builds a string. Unlike StringBuilder this class lets you reuse it's internal buffer. + Adds the elements of the specified collection to the specified generic . + The list to add to. + The collection of elements to add. - + - Determines whether the collection is null or empty. + Converts the value to the specified type. If the value is unable to be converted, the + value is checked whether it assignable to the specified type. - The collection. + The value to convert. + The culture to use when converting. + The type to convert or cast the value to. - true if the collection is null or empty; otherwise, false. + The converted type. If conversion was unsuccessful, the initial value + is returned if assignable to the target type. - + - Adds the elements of the specified collection to the specified generic IList. + Helper method for generating a MetaObject which calls a + specific method on Dynamic that returns a result - The list to add to. - The collection of elements to add. - + - Returns the index of the first occurrence in a sequence by using a specified IEqualityComparer{TSource}. + Helper method for generating a MetaObject which calls a + specific method on Dynamic, but uses one of the arguments for + the result. + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic, but uses one of the arguments for + the result. + + + + + Returns a Restrictions object which includes our current restrictions merged + with a restriction limiting our type + + + + + Helper class for serializing immutable collections. + Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed + https://github.com/JamesNK/Newtonsoft.Json/issues/652 - The type of the elements of source. - A sequence in which to locate a value. - The object to locate in the sequence - An equality comparer to compare values. - The zero-based index of the first occurrence of value within the entire sequence, if found; otherwise, –1. @@ -8772,15 +11066,6 @@ The member. The underlying type of the member. - - - Determines whether the member is an indexed property. - - The member. - - true if the member is an indexed property; otherwise, false. - - Determines whether the property is an indexed property. @@ -8827,22 +11112,20 @@ true if the specified MemberInfo can be set; otherwise, false. + + + Builds a string. Unlike this class lets you reuse its internal buffer. + + - Determines whether the string is all white space. Empty string will return false. + Determines whether the string is all white space. Empty string will return false. The string to test whether it is all white space. true if the string is all white space; otherwise, false. - - - Nulls an empty string. - - The string. - Null if the string was null, otherwise the string unchanged. - Specifies the state of the . @@ -8852,12 +11135,12 @@ An exception has been thrown, which has left the in an invalid state. You may call the method to put the in the Closed state. - Any other method calls results in an being thrown. + Any other method calls result in an being thrown. - The method has been called. + The method has been called. @@ -8867,7 +11150,7 @@ - A array is being written. + An array is being written. @@ -8882,7 +11165,7 @@ - A write method has not been called. + A write method has not been called. diff --git a/packages/FAKE.5.16.0/tools/NuGet.Common.dll b/packages/FAKE.5.16.0/tools/NuGet.Common.dll new file mode 100644 index 0000000..65b5d18 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/NuGet.Common.dll differ diff --git a/packages/FAKE.5.16.0/tools/NuGet.Common.xml b/packages/FAKE.5.16.0/tools/NuGet.Common.xml new file mode 100644 index 0000000..e4d4444 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/NuGet.Common.xml @@ -0,0 +1,1797 @@ + + + + NuGet.Common + + + + + Ambient correlation ID used to associate information pertaining to a current activity. A single activity + engages multiple method calls at different layers. Sometimes it's necessary to identify separate calls + belonging to the same activity if shared state is needed. + + + + + Returns current activity correlation ID or a default if not set previously. + + + + + Starts a new activity activity correlation ID by updating ambient context value. + + + + + Aggregates from a list of already ordered enumerables + The ordered result will contain only unique values + If comparer/EqualityComparer are not provided the default ones for that type will be used. + If the provided enumerables are not sorted already, the behavior is undefined + + + + + Aggregates from a list of already ordered enumerables + The ordered result will contain only unique values + If comparer/EqualityComparer are not provided the default ones for that type will be used. + If the provided enumerables are not sorted already, the behavior is undefined + + + + + Supports async iteration over a generic collection. + Prior to calling Current, MoveNextAsync needs to be called otherwise the behavior is undefined + + The type of objects to enumerate.This type parameter is covariant. That is, you can use either the type you specified or any type that is more derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics.1 + + + + Gets the element in the collection at the current position of the enumerator. + If MoveNextAsync has not been called prior to calling current the behavior is undefined + If the last MoveNextAsync call returned false then the next call to Current should throw an InvalidOperationException + + + + The element in the collection at the current position of the enumerator. + + + + + Moves the pointer to the next element in the collection. + + + + Success status of the pointer move + + + + + Wrapper class representing shorter syntax of Lazy<Task<T>>"/>. + Useful when declaring a lazy async factory of value T. + + Value type + + + + Shortcuts to common Lazy<Task<T>> constructor calls + + + + + Find the current NuGet client version from the assembly info as a string. + If no value can be found an InvalidOperationException will be thrown. + + This can contain prerelease labels if AssemblyInformationalVersionAttribute exists. + + + + CryptoHashProvider helps calculate or verify hash based on SHA256 or SHA512 algorithms + + + + + Server token used to represent that the hash being used is SHA 512 + + + + + Server token used to represent that the hash being used is SHA 256 + + + + + Creates an instance of CryptoHashProvider. Since the algorithm is not specified, SHA512 is assumed + + + + + Creates an instance of CryptoHashProvider using the hashAlgorithm + + + + + Calculates the hash for a given stream + + + + + Calculates the hash for a byte array + + + + + Verifies the hash for the given data and hash + + + + + Compute the hash as a base64 encoded string. + + Closes the stream by default. + Algorithm to use for hashing. + Stream to hash. + + + + Compute the hash as a base64 encoded string. + + Algorithm to use for hashing. + Stream to hash. + If false the stream will be closed. + A base64 encoded hash string. + + + + Compute the hash as a byte[]. + + + + + Compute the hash as a byte[]. + + Closes the stream by default. + Algorithm to use for hashing. + Stream to hash. + A hash byte[]. + + + + Compute the hash as a byte[]. + + Algorithm to use for hashing. + Stream to hash. + If false the stream will be closed. + A hash byte[]. + + + + Determines if we are to only allow Fips compliant algorithms. + + + CryptoConfig.AllowOnlyFipsAlgorithm does not exist in Mono. + + + + + Extension method to convert NuGet.Common.HashAlgorithmName to System.Security.Cryptography.HashAlgorithmName + + System.Security.Cryptography.HashAlgorithmName equivalent of the NuGet.Common.HashAlgorithmName + + + + Extension method to convert NuGet.Common.HashAlgorithmName to an Oid string + + Oid string equivalent of the NuGet.Common.HashAlgorithmName + + + + Extension method to convert NuGet.Common.HashAlgorithmName to an OID + + OID equivalent of the NuGet.Common.HashAlgorithmName + + + + Helper method to convert an Oid string to NuGet.Common.HashAlgorithmName + + An oid string. + NuGet.Common.HashAlgorithmName equivalent of the oid string + + + + Extension method to convert NuGet.Common.SignatureAlgorithmName to an Oid string + + Oid string equivalent of the NuGet.Common.SignatureAlgorithmName + + + + static class to provide datetime common utility apis + + + + + take timespan n return in appropriate unit like ms, or seconds, or minutes, or hours + + timespan + + + + + Indicates the file for which the error was thrown. + + + + + Indicates the starting line for which the error was thrown. + + + + + Indicates the starting column for which the error was thrown. + + + + + Indicates the ending line for which the error was thrown. + + + + + Indicates the ending column for which the error was thrown. + + + + + Level to indicate if this is an error or warning. + + + + + Level to indicate the warning level for the message. + This is relevant only if the Level == LogLevel.Warning. + + + + + Indicates the NuGet error code. + + + + + Indicates the staring generated by the code to go with the error code. + + + + + Indicates the project for which the error was thrown. + + + + + Indicates the date time at which the error occurred. + + + + + Allows converting an Exception to an ILogMessage. + + + + + Retrieve the exception as a log message. + + + + + Project or Package Id. + + + + + List of TargetGraphs. + + + + + Bool indicating if this message needs to be logged to the inner logger. + + + + + Basic log message. + + + + + This enum is used to quantify NuGet error and warning codes. + Format - NUxyzw where NU is the profix indicating NuGet and xyzw is a 4 digit code + + Numbers - xyzw + x - 'x' is the largest digit and should be used to quantify a set of errors. + For example 1yzw are set of restore related errors and no other code path should use the range 1000 to 1999 for errors or warnings. + + y - 'y' is the second largest digit and should be used for sub sections withing a broad category. + + For example 12zw cvould be http related errors. + Further 'y' = 0-4 should be used for errors and 'y' = 5-9 should be warnings. + + zw - 'zw' are the least two digit. + These could be used for different errors or warnings within the broad categories set by digits 'xy'. + + Groups: + 1000-1999 - Restore + 3000-3999 - Signing + 5000-5999 - Packaging + + Sub groups for Restore: + error/warning - Reason + 1000/1500 - Input + 1100/1600 - Resolver + 1200/1700 - Compat + 1300/1800 - Feed + 1400/1900 - Package + + + + + Do not display the code. + + + + + Undefined error + + + + + Project has zero target frameworks. + + + + + Invalid combination with CLEAR + + + + + Invalid combination of PTF and ATF + + + + + Locked mode, but restore needs to update the lock file. + + + + + Invalid combination of RestorePackagesWithLockFile and packages.lock.json file. + + + + + Unable to resolve package, generic message for unknown type constraints. + + + + + No versions of the package exist on any of the sources. + + + + + Versions of the package exist, but none are in the range. + + + + + Range does not allow prerelease packages and only prerelease versions were found + within the range. + + + + + Project path does not exist on disk. + + + + + Project reference was not in the dg spec. + + + + + Resolver conflict + + + + + Version conflict. + + + + + Circular dependency. + + + + + Dependency project has an incompatible framework. + + + + + Dependency package does not contain assets for the current framework. + + + + + un-matched reference assemblies + + + + + Invalid package types + + + + + project has an invalid dependency count + + + + + Incompatible tools package/project combination + + + + + Package MinClientVersion did not match. + + + + + Package contains unsafe zip entry. + + + + + Package sha512 validation failed. + + + + + Package Signature is invalid + + + + + Undefined warning + + + + + Missing restore target. + + + + + Unknown compatibility profile + + + + + Skipping project that does not support restore. + + + + + Dependency bumped up + + + + + Non-exact match on dependency range due to non inclusive minimum bound. + + + + + Non-exact match on dependency range due to missing package version. + + + + + Project dependency does not include a lower bound. + + + + + Package dependency downgraded. + + + + + Version is higher than upper bound. + + + + + Fallback framework used. + + + + + Feed error converted to a warning when ignoreFailedSources is true. + + + + + Undefined signature error + + + + + Invalid input error + + + + + The '-Timestamper' option was not provided. The signed package will not be timestamped. + + + + + The package signature is invalid. + + + + + The package is not signed. + + + + + The package signature file entry is invalid. + + + Examples which would trigger this include: + * the entry has incorrect external file attributes + * the entry is compressed not stored + * the entry's compressed and uncompressed sizes differ + + + + + Signed Zip64 packages are not supported. + + + + + The package signature format version is not supported. + + + + + The package integrity check failed. + + + + + The package signature file does not contain exactly one primary signature. + + + + + The primary signature does not have a signing certificate. + + + + + The primary signature is invalid. + + + + + Primary signature validation failed. + + + + + The signing certificate has an unsupported signature algorithm. + + + + + The signing certificate does not meet a minimum public key length requirement. + + + + + Certificates with lifetime signer EKU are not supported. + + + + + The package hash uses an unsupported hash algorithm. + + + + + The signing certificate is not yet valid. + + + + + Chain building failed for primary signature + + + + + The timestamp integrity check failed. + + + + + The timestamp signature does not have a signing certificate. + + + + + Timestamp signature validation failed. + + + + + The timestamp certificate has an unsupported signature algorithm. + + + + + The timestamp's certificate does not meet a minimum public key length requirement. + + + + + The timestamp signing certificate has an unsupported signature algorithm. + + + + + The timestamp signing certificate is not yet valid. + + + + + The timestamp response is invalid. Nonces did not match. + + + + + The primary signature should be timestamped to enable long-term signature validity after the certificate has expired. + + + + + Chain building failed for timestamp + + + + + The timestamp signature is invalid. + + + + + The timestamp's message imprint uses an unsupported hash algorithm. + + + + + The repository countersignature is invalid. + + + + + The package signature contains multiple repository countersignatures. + + + + + A repository primary signature must not have a repository countersignature. + + + + + The package signature certificate does not match the trusted certificate list. + + + + + Chain building failed for the repository countersignature. + + + + + Timestamp Generalized time is outside certificate's valdity period + + + + + The signature has expired. + + + + + Verification settings require a repository countersignature, but the package does not have a repository countersignature. + + + + + The package cannot be signed as it would require the Zip64 format. + + + + + There where two equal certificate entries with conflicting attributes in the nuget.config + + + + + Downloading a package from a plugin is not supported since unsigned packages are not allowed and package download plugins do not support signed package verification. + + + + + Undefined Package Error. + + + + + Error_WriteResolvedNuSpecOverwriteOriginal + + + + + Error_InputFileNotSpecified + + + + + Error_InvalidTargetFramework + + + + + Error_PackageCommandNoFilesForLibPackage + + + + + Error_PackageCommandNoFilesForSymbolsPackage + + + + + Error_PackFailed + + + + + Error_UnableToLocateBuildOutput + + + + + ErrorManifestFileNotFound + + + + + Error_CannotFindMsbuild + + + + + Error_InvalidVersionInPackage + + + + + Error_UnableToExtractAssemblyMetadata + + + + + Error_UnableToFindBuildOutput + + + + + Error_FailedToBuildProject + + + + + Error_ProcessingNuspecFile + + + + + Error_MultipleTargetFrameworks + + + + + Error_InvalidDependencyVersionConstraints + + + + + Error_CannotCreateEmptyPackage + + + + + Error_Manifest_InvalidReference + + + + + Error_PackageAuthoring_FileNotFound + + + + + Error_EmptySourceFilePath + + + + + Error_EmptySourceFileProjectDirectory + + + + + Error_InvalidMinClientVersion + + + + + Error_AssetsFileNotFound + + + + + Error_InvalidPackageVersion + + + + + Error_AssetsFileDoesNotHaveValidPackageSpec + + + + + Error_FileNotFound + + + + + Error_InvalidTargetFramework + + + + + Error_NoPackItemProvided + + + + + Error_InvalidNuspecProperties + + + + + Error_Manifest_LicenseFileNotInNupkg + + + + + Error_Manifest_LicenseFileExtensionIsInvalid + + + + + Error_Manifest_LicenseExpressionIsUnparseable + + + + + Error_Manifest_InvalidLicenseMetadata + + + + + Error_Manifest_InvalidLicenseExpressionVersion + + + + + Error_Manifest_LicenseUrlCannotBeUsedWithLicenses + + + + + AssemblyOutsideLibWarning + + + + + AssemblyDirectlyUnderLibWarning + + + + + DefaultSpecValueWarning + + + + + InvalidFrameworkWarning + + + + + InvalidPrereleaseDependencyWarning + + + + + LegacyVersionWarning + + + + + WinRTObsoleteWarning + + + + + MisplacedInitScriptWarning + + + + + MisplacedTransformFileWarning + + + + + PlaceholderFileInPackageWarning + + + + + ScriptOutsideToolsWarning + + + + + UnrecognizedScriptWarning + + + + + UnspecifiedDependencyVersionWarning + + + + + Warning_SemanticVersion + + + + + Warning_DuplicatePropertyKey + + + + + Warning_UnspecifiedField + + + + + Warning_FileDoesNotExist + + + + + Warning_UnresolvedFilePath + + + + + Warning_FileNotAddedToPackage + + + + + Warning_FileExcludedByDefault + + + + + Migrator_PackageHasInstallScript + + + + + Migrator_PackageHasContentFolder + + + + + Migrator_XdtTransformInPackage + + + + + Warning_FilePathTooLong + + + + + Warning_UnrecognizedLicenseIdentifier + + + + + LicenseUrlDeprecated + + + + + Undefined package warning + + + + + Initializes a new instance of the PackLogMessage class + + The log level + The NuGet log code + The log message + + + + Create an error log message. + + The logging code + The log message + + + + Get default LogCode based on the log level + + The log level + + + + Create a log message for a target graph library. + + + + + Create a warning log message. + + + + + Create an error log message. + + + + + Create an error log message for a target graph. + + + + + Get default LogCode based on the log level + + + + + These are Warning Levels used by NuGet while throwing warnings. + These logically correspond to .NET spec at https://msdn.microsoft.com/en-us/library/13b90fz7(v=vs.140).aspx + + We do not have a level 0 as that has no logical meaning of having a warning with level 0. + + Severe - This should be used to throw warnings that are just short of being an error. + + Important - Lower level than severe. + + Minimal - Lower level than important. + + Default - Lowest level of warnings. + Default NuGet logging will ignore these warnings. + + + + + For internal use only + + + + + Log an exception to an ILogger. + This will log using NU1000 if the exception does not contain a code. + + + + + Log an exception to an ILogger. + This will log using NU1000 if the exception does not contain a code. + + + + + Determines whether the full exception (including stack trace) should be displayed to + the user. In prerelease or dogfooding scenarios, it is useful to have a non-verbose + logging level but, in the case of an unhandled exception, print the full exception for + bug reporting. + + + True if the exception stack should be displayed to the user. False, otherwise. + + + + + Fetch all of the errors logged so far. This method is useful when error log messages + should be redisplayed after the initial log message is emitted. + + + + + A generic interface for logging. + + + + + Call legacy Log* methods from LogAsync/Log. + This is for legacy ILogger implementations, + new loggers should use LoggerBase. + + + + + True if the message meets the verbosity level. + + + + + True if the message is an error or warning. + + + + + Formats a ILogMessage into a string representation containg the log code and message. + The log code is added only if it is a valid NuGetLogCode and is greater than NuGetLogCode.Undefined. + + ILogMessage to be formatted. + string representation of the ILogMessage. + + + + Formats a NuGetLogCode into a string representation. + + NuGetLogCode to be formatted into string. + strings representation of the NuGetLogCode. + + + + Tries to get the string from the NuGetLogCode enum. + + NuGetLogCode to be formatted into string. + strings representation of the NuGetLogCode if the result is true else null. + bool indcating if the GetName operation was successfull or not. + + + + Split on ; and trim. Null or empty inputs will return an + empty array. + + + + + Split on ; and trim. Null or empty inputs will return an + empty array. + + + + + Trims the provided string and converts empty strings to null. + + + + + Trims the provided strings and excludes empty or null strings. + + + + + True if the property is set to true + + + + + True if the property is set to true or empty. + + + + + Splits and parses a ; or , delimited list of log codes. + Ignores codes that are unknown. + + + + + Convert the provided string to MSBuild style. + + + + + Return empty list of NuGetLogCode if all lists of NuGetLogCode are not the same. + + + + + This only has effect on .NET Framework (desktop). On .NET Core, + is not available. Additionally, + no API is available to configure the supported SSL protocols. + + + + + Set ServicePointManager.DefaultConnectionLimit + + + + + Directory operation helpers. + + + + + Creates all directories and subdirectories in the specified path unless they already exist. + New directories can be read and written by all users. + + + + + File operation helpers. + + + + + Get the full path to a new temp file + + + + + Lock around the output path. + Delete the existing file with retries. + + + + + Lock around the output path. + Delete the existing file with retries. + Move a file with retries. + + + + + Delete the existing file with retries. + Move a file with retries. + + + + + Delete the existing file with retries. + Move a file with retries. + + + + + Move a file with retries. + This will not overwrite + + + + + Delete a file with retries. + + + + + Common NuGet paths. These values may be overridden in NuGet.Config or by + environment variables, resolving the paths here requires NuGet.Configuration. + + + + + User package folder directory. + + + + + Fallback package folder locations. + + + + + Http file cache. + + + + + Throw a helpful message if the required env vars are not set. + + + + + Throw a helpful message if a required env var is not set. + + + + + Since is not available on .NET Core, we have to + make our own and re-implement the functionality. On .NET Framework, we can use the + built-in functionality. + + + + + Returns a collection of files from the source that matches the wildcard. + + The collection of files to match. + Function that returns the path to filter a package file + The wildcards to apply to match the path with. + + + + + Removes files from the source that match any wildcard. + + + + + Returns true if the path contains any wildcard characters. + + + + + Returns OrdinalIgnoreCase windows and mac. Ordinal for linux. + + + + + + Returns OrdinalIgnoreCase windows and mac. Ordinal for linux. + + + + + + Returns distinct orderd paths based on the file system case sensitivity. + + + + + Replace all back slashes with forward slashes. + If the path does not contain a back slash + the original string is returned. + + + + + Returns path2 relative to path1, with Path.DirectorySeparatorChar as separator + + + + + Returns path2 relative to path1, with given path separator + + + + + Validates that a source is a valid path or url. + + The path to validate. + True if valid, False if invalid. + + + + Validates that path is properly formatted as a local path. + + + On Windows, a valid local path must starts with the drive letter. + Example: C:\, C:\path, C:\path\to\ + Bad: C:\invalid\*\"\chars + + The path to validate. + True if valid, False if invalid. + + + + Validates that path is properly formatted as an UNC path. + + + Example: \\server\share, \\server\share\path, \\server\share\path\to\ + Bad: \\server\invalid\*\"\chars + + The path to validate. + True if valid, False if invalid. + + + + Validates that url is properly formatted as an URL based on .NET Uri class. + + The url to validate. + True if valid, False if invalid. + + + + project.json + + + + + .project.json + + + + + Lock file name + + + + + Finds the projectName.project.json in a directory. If no projectName.project.json exists + the default project.json path will be returned regardless of existance. + + Returns the full path to the project.json file. + + + + Creates a projectName.project.json file name. + + + + + Creates a projectName.project.lock.json file name. + + + + + Create the lock file path from the config file path. + If the config file includes a project name the + lock file will include the name also. + + + + + Parses a projectName.project.json file name into a project name. + If there is no project name null will be returned. + + + + + True if the file is a project.json or projectname.project.json file. + + + + + Simple token replacement system for content files. + + + + + Asynchronously performs token replacement on a file stream. + + A stream task factory. + A token replacement function. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a . + Thrown if + is either null or empty. + Thrown if + is null. + Thrown if + is cancelled. + + + + Performs token replacement on a stream and returns the result. + + A stream. + A token replacement funciton. + The token-replaced stream content. + Thrown if + is null. + Thrown if + is null. + + + + If needed go online to check for revocation. + This translates to X509RevocationMode.Online + + + + + Only use the machine cache to check for revocation. + This translates to X509RevocationMode.Offline + + + + + Relaxed signature verification mode. + Allows unsigned packages, and issues are treated as warnings. + + + + + Strict signature verification mode. + All packages most be signed. Any issue is an error and + allow list of trusted signers must be provided. + + + + + A strongly-typed resource class, for looking up localized strings, etc. + + + + + Returns the cached ResourceManager instance used by this class. + + + + + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + + + + + Looks up a localized string similar to An absolute path is required: '{0}'.. + + + + + Looks up a localized string similar to Value must be greater than or equal to {0}. + + + + + Looks up a localized string similar to Argument cannot be null or empty. + + + + + Looks up a localized string similar to Failed to create random file for dotnet add pkg command.. + + + + + Looks up a localized string similar to Required environment variable '{0}' is not set. Try setting '{0}' and running the operation again.. + + + + + Looks up a localized string similar to Required environment variable '{0}' is not set. Try setting '{1}' or '{0}' and running the operation. + + + + + Looks up a localized string similar to At least one package folder path must be provided.. + + + + + Looks up a localized string similar to Package folder not found: '{0}'.. + + + + + Looks up a localized string similar to Unable to determine the current NuGet client version.. + + + + + Looks up a localized string similar to Unable to obtain lock file access on '{0}' for operations on '{1}'. This may mean that a different user or administator is holding this lock and that this process does not have permission to access it. If no other process is currently performing an operation on this file it may mean that an earlier NuGet process crashed and left an inaccessible lock file, in this case removing the file '{0}' will allow NuGet to continue.. + + + + + Looks up a localized string similar to Hash algorithm '{0}' is unsupported. Supported algorithms include: SHA512 and SHA256.. + + + + + Looks up a localized string similar to Hash algorithm '{0}' is unsupported.. + + + + + Looks up a localized string similar to Signature algorithm '{0}' is unsupported.. + + + + + Interface to post telemetry events. + + + + + Define different states for nuget operation status. + + + + + no operation performed. + + + + + operation was successful. + + + + + operation failed. + + + + + operation was cancelled + + + + + Creates a TelemetryActivity. + + OperationId of the parent event. + Name of the event. + TelemetryActivity with a given parentId and new operationId and a TelemetryEvent with eventName + + + + This will be used to pass different nuget telemetry events data to vs telemetry service. + + + + + Property count in TelemetryEvent + + + + + This class is used to parse string into tokens. + There are two types of tokens: variables, e.g. "$variable$", or text. + The dollar sign can be escaped using $$. + A variable contains only word characters. + + Examples: + - "a $b$ c" is parsed into + {text, "a "}, {variable, "b"}, {text, " c"}. + - "a $$b$$ c" is parsed into + {text, "a $b$ c"}. + - "a $b$ $c" is parsed into + {text, "a "}, {variable, "b"}, {text, " $c"}. + - "a $b$$c$" is parsed into + {text, "a "}, {variable, "b"}, {variable, "c"}. + - "a $b c$d$" is parsed into + {text, "a $b c"}, {variable, "d"} (because space is not a word character). + + + + + Gets the next token. + + The parsed token. Or null if no more tokens are available. + + + + Same as "new Uri" except that it can handle UNIX style paths that start with '/' + + + + + Same as "Uri.TryCreate" except that it can handle UNIX style paths that start with '/' + + + + + Provides Uri encoding for V2 servers in the same way that NuGet.Core.dll encoded urls. + + + + + Convert a file:// URI to a local path. + + If the input can be parsed this will return Uri.LocalPath, if the input + is not a URI or fails to parse the original string will be returned. + Possible file:// URI path or local path. + + + + Calls GetAbsolutePath with the directory of . + + + + + Convert a relative local folder path to an absolute path. + For http sources and UNC shares this will return + the same path. + + Directory to make the source relative to. + Source path. + The absolute source path or the original source. Noops for non-file paths. + + + + Compares two enumberables for equality, ordered according to the specified key and optional comparer. Handles null values gracefully. + + The type of the list + The type of the sorting key + This list + The other list + The function to extract the key from each item in the list + An optional comparer for comparing keys + An optional comparer for sequences + + + + Compares two sequence for equality, allowing either sequence to be null. If one is null, both have to be + null for equality. + + + + + Compares two sets for equality, allowing either sequence to be null. + If one is null, both have to be null for equality. + + + + + Hash code creator, based on the original NuGet hash code combiner/ASP hash code combiner implementations + + + + + Create a unique hash code for the given set of items + + + + + Create a unique hash code for the given set of items + + + + + Return the enumerable as a List of T, copying if required. Optimized for common case where it is an List of T. + Avoid mutating the return value. + + https://aspnetwebstack.codeplex.com/SourceControl/latest#src/Common/CollectionExtensions.cs + + + + Return the ISet as a HashSet of T, copying if required. Optimized for common case where it is a HashSet of T. + Avoid mutating the return value. + + + +s+PhGa0DbF75tXn/2XR51EhD3ns=Ay1SCkkNgZz8pR0YVv8lRokM4s5XrUK6wa25FKpB9tlpCm1ggQ+9yUv0MfNKyeWN9Iwcuz89iayMTfO9lEiEkc1pNbAlkYC/fMxLihYQsqFBh42piRkAyWZMX3jgoMD+ksDkesUKx8rdqvpKjACyJyGkwd3zt6kX1FVgH+C9S9QVazSQi/QyqV4tTyQUN5Q9aLk5y96NuH3zFdSLhLsFhS3VPuo1fqr+Wi4R/Ce+/EEAjAEvwykJyj6FVwRCmu95fKrDXsyUoNrTjpanUG1nSXqHl7WBWx4lYwhZwq4dfz2w8NDOQ86dIVnckGsKJriSaaOJz5W8cRaUCwjVMVraZA==m1K+Tyy0HVPLPV0jHraDo5/A5UrgV7PC+C3WipFfzBLODN0Ct0Z49Gub3ufLICGP1D4OJZRyOnhjZi61X+Hbl/2IjqiIl1VMHR4+qWlJLRNj+X7DparTv3/CBzkhMGY2lZdvp96rpRL2heloKGkmmxqet6/sU3hvw8wxMIf29zYrMEBZSEaAUajNDIDd40qeLXRV7OanRHrVE770wiR9DP0zzeYjX5rN1CltAtUyWmonz7DJAYuUr+UMi3offSITg4byWkvThGNXGmtJeDpU6Y/hhcblP5Yl5175yMvHofLyGw0iW7kv/Izp2yjEVRe26PTXes/9nNOP7ul2KoKMoQ==AQABMIIE2zCCA8OgAwIBAgITMwAAAbHd7bpU6WW4XwABAAABsTANBgkqhkiG9w0BAQUFADB5MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSMwIQYDVQQDExpNaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQTAeFw0xODA3MTIyMDExMTlaFw0xOTA3MjYyMDExMTlaMHQxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xHjAcBgNVBAMTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJtSvk8stB1Tyz1dIx62g6OfwOVK4Fezwvgt1oqRX8wSzgzdArdGePRrm97nyyAhj9Q+DiWUcjp4Y2YutV/h25f9iI6oiJdVTB0ePqlpSS0TY/l+w6Wq079/wgc5ITBmNpWXb6feq6US9oXpaChpJpsanrev7FN4b8PMMTCH9vc2KzBAWUhGgFGozQyA3eNKni10Vezmp0R61RO+9MIkfQz9M83mI1+azdQpbQLVMlpqJ8+wyQGLlK/lDIt6H30iE4OG8lpL04RjVxprSXg6VOmP4YXG5T+WJede+cjLx6Hy8hsNIlu5L/yM6dsoxFUXtuj013rP/ZzTj+7pdiqCjKECAwEAAaOCAV8wggFbMBMGA1UdJQQMMAoGCCsGAQUFBwMDMB0GA1UdDgQWBBREE7QCnXc+kFVx9eQcf6wXFM8+czBQBgNVHREESTBHpEUwQzEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xFjAUBgNVBAUTDTIyOTgwMys0Mzc5NTAwHwYDVR0jBBgwFoAUyxHoytK0FlgByTcuMxYWuUyaCh8wVgYDVR0fBE8wTTBLoEmgR4ZFaHR0cDovL2NybC5taWNyb3NvZnQuY29tL3BraS9jcmwvcHJvZHVjdHMvTWljQ29kU2lnUENBXzA4LTMxLTIwMTAuY3JsMFoGCCsGAQUFBwEBBE4wTDBKBggrBgEFBQcwAoY+aHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraS9jZXJ0cy9NaWNDb2RTaWdQQ0FfMDgtMzEtMjAxMC5jcnQwDQYJKoZIhvcNAQEFBQADggEBAIOp8qYzxaF7HNJegK7spKbD6ShdVyUjjd0lCWlw6E1pFi+UuwXZm4DsWdBoZBuDNKjcz2ONnWt2APV7r0J0B8X8kcDirEUzll2x/fqORrJJ4kMGGZiFcXjTnunblRZBMTRwLEOWogJ3qS89YUpjWfGXfdFSlWCFqLwbRQc/2cGP91D1uX4IieRCxFiOQcCVOEkf1x34ME8pLztHWZI37pch7RdmkBwvLW1r/wt15aoS3fqvxBG04CEyWr8FzkX5P41Wrs5R1syufQQZMBLyv59IJpwOAA0oraXeRC3M1If/lEmVVwxNNJwjCt3DjTIJ9L01KMXe0Ig/qRIToTBwoBE=MIIFvDCCA6SgAwIBAgIKYTMmGgAAAAAAMTANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMTAwODMxMjIxOTMyWhcNMjAwODMxMjIyOTMyWjB5MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSMwIQYDVQQDExpNaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALJyWVwZMGS/HZpgICBCmXZTbD4b1m/My/Hqa/6XFhDg3zp0gxq3L6Ay7P/ewkJOI9VyANs1VwqJyq4gSfTwaKxNS42lvXlLcZtHB9r9Jd+ddYjPqnNEf9eB2/O98jakyVxF3K+tPeAoaJcap6Vyc1bxF5Tk/TWUcqDWdl8ed0WDhTgW0HNbBbpnUo2lsmkv2hkL/pJ0KeJ2L1TdFDBZ+NKNYv3LyV9GMVC5JxPkQDDPcikQKCLHN049oDI9kM2hOAaFXE5WgigqBTK3S9dPY+fSLWLxRT3nrAgA9kahntFbjCZT6HqqSvJGzzc8OJ60d1ylF56NyxGPVjzBrAlfA9MCAwEAAaOCAV4wggFaMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFMsR6MrStBZYAck3LjMWFrlMmgofMAsGA1UdDwQEAwIBhjASBgkrBgEEAYI3FQEEBQIDAQABMCMGCSsGAQQBgjcVAgQWBBT90TFO0yaKleGYYDuoMW+mPLzYLTAZBgkrBgEEAYI3FAIEDB4KAFMAdQBiAEMAQTAfBgNVHSMEGDAWgBQOrIJgQFYnl+UlE/wq4QpTlVnkpDBQBgNVHR8ESTBHMEWgQ6BBhj9odHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9taWNyb3NvZnRyb290Y2VydC5jcmwwVAYIKwYBBQUHAQEESDBGMEQGCCsGAQUFBzAChjhodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFJvb3RDZXJ0LmNydDANBgkqhkiG9w0BAQUFAAOCAgEAWTk+fyZGr+tvQLEytWrrDi9uqEn361917Uw7LddDrQv+y+ktMaMjzHxQmIAhXaw9L0y6oqhWnONwu7i0+Hm1SXL3PupBf8rhDBdpy6WcIC36C1DEVs0t40rSvHDnqA2iA6VW4LiKS1fylUKc8fPv7uOGHzQ8uFaa8FMjhSqkghyT4pQHHfLiTviMocroE6WRTsgb0o9ylSpxbZsa+BzwU9ZnzCL/XB3Nooy9J7J5Y1ZEolHN+emjWFbdmwJFRC9f9Nqu1IIybvyklRPk62nnqaIsvsgrEA5ljpnb9aL6EiYJZTiU8XofSrvR4Vbo0HiWGFzJNRZf3ZMdSY4tvq00RBzuEBUaAF3dNVshzpjHCe6FDoxPbQ4TTj18KUicctHzbMrB7HCjV5JXfZSNoBtIA1r3z6NnCnSlNu0tLxfI5nI3EvRvsTxngvlSso0zFmUeDordEN5k9G/ORtTTF+l5xAS00/ss3x+KnqwK+xMnQK3k+eGpf0a7B2BHZWBATrBC7E7ts3Z52Ao0CW0cgDEf4g5U3eWh++VHEK1kmP9QFi58vwUheuKVQSdpw5OPlcmN2Jshrg1cnPCiroZogwxqLbt2awAdlq3yFnv2FoMkuYjPaqhHMS+a3ONxPdcAfmJH0c6IybgY+g5yjcGjPa8CQGr/aZuW4hCoELQ3UAjWwz0=MIIFmTCCA4GgAwIBAgIQea0WoUqgpa1Mc1j0BxMuZTANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMDEwNTA5MjMxOTIyWhcNMjEwNTA5MjMyODEzWjBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDzXfqAZ9Rap6kMLJAg0DUIPHWEzbcHiZyJ2t7Ow2D6kWhanpRxKRh2fMLgyCV2lA5Y+gQ0Nubfr/eAuulYCyuT5Z0F43cikfc0ZDwikR1e4QmQvBT+/HVYGeF5tweSo66IWQjYnwfKA1j8aCltMtfSqMtL/OELSDJP5uu4rU/kXG8TlJnbldV126gat5SRtHdb9UgMj2p5fRRwBH1tr5D12nDYR7e/my9s5wW34RFgrHmRFHzF1qbk4X7Vw37lktI8ALU2gt554W3ztW74nzPJy1J9c5g224uha6KVl5uj3sJNJv8GlmclBsjnrOTuEjOVMZnINQhONMp5U9W1vmMyWUA2wKVOBE0921sHM+RYv+8/U2TYQlk1V/0PRXwkBE2e1jh0EZcikM5oRHSSb9VLb7CG48c2QqDQ/MHAWvmjYbkwR3GWChawkcBCle8Qfyhq4yofseTNAz93cQTHIPxJDx1FiKTXy36IrY4t7EXbxFEEySr87IaemhGXW97OU4jm4rf9rJXCKEDb7wSQ34EzOdmyRaUjhwalVYkxuwYtYA5BGH0fLrWXyxHrFdUkpZTvFRSJ/Utz+jJb/NEzAPlZYnAHMuouq0Ate8rdIWcbMJmPFqojqEHRsG4RmzbE3kB0nOFYZcFgHnpbOMiPuwQmfNQWQOW2a2yqhv0Av87BNQIDAQABo1EwTzALBgNVHQ8EBAMCAcYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUDqyCYEBWJ5flJRP8KuEKU5VZ5KQwEAYJKwYBBAGCNxUBBAMCAQAwDQYJKoZIhvcNAQEFBQADggIBAMURTQM6YN1dUhF3j7K7NsiyBb+0t6jYIJ1cEwO2HCL6BhM1tshj1JpHbyZX0lXxBLEmX9apUGigvNK4bszD6azfGc14rFl0rGY0NsQbPmw4TDMOMBINoyb+UVMA/69aToQNDx/kbQUuToVLjWwzb1TSZKu/UK99ejmgN+1jAw/8EwbOFjbUVDuVG1FiOuVNF9QFOZKaJ6hbqr3su77jIIlgcWxWs6UT0G0OI36VA+1oPfLYY7hrTbboMLXhypRL96KqXZkwsj2nwlFsKCABJCcrSwC3nRFrcL6yEIK8DJto0I07JIeqmShynTNfWZC99d6TnjpiWjQ54ohVHbkGsMGJay3XacMZEjaE0Mmg2v8vaXiy5Xra69cMwPe9Yxe4ORM4ojZbe/KFVmodZGLBOOKqv1FmopT1EpxmIhBr8rcwki3yKfA9OxRDaKLxnCk3y844ICVtfGfzfiQSJAMIgUfspZ6X9RjXz7vV73aW7/3O21adlaBC+ZdY4dcxItNfWeY+biIA6kOEtiXb2fMIVmjAZGsdfOy2k6JiV24u2OdYj8QxSSbd3ik1h/UwcXBbFDxpvYkSfesuo/7Yf56CWlIKK8FDK9kwiJ/IEPuJjeahhXUzfmye23MTZGJppS99ypZtn/gETTCSPW4hFCHJPeDD/YprnUr90aGdmUN3P7DaMIIE3jCCA8agAwIBAgITMwAAAP3H8MlqaaHITAAAAAAA/TANBgkqhkiG9w0BAQUFADB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EwHhcNMTgwODIzMjAyMDExWhcNMTkxMTIzMjAyMDExWjCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOjU4NDctRjc2MS00RjcwMSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAugmBPajBpzY0ZHXjUDiC9AfAkIV0Ha8AtmxzF9JlV8sCiW6p+ICqQqBMZrPJP+ZpkhPZhYh5Ht7GgatuRrQCri7ofVWq7zTrUAuw2KMxPAMM3WCRR/EzDiJbM3szZuINNP7x1iRViw3a/k4hhsmrg8fxA99YfH/jJZTG2dyhVKQpKCniPj0UJBfn7NHr3pGsz9baz1/GLfcauWULHRrF5oX6KuLRRaTW0a2XncHeDWhb51jOGf0FPKJy9C3BZOnI1sBSt+F/3ktGWxB1X1VMOdlGUnTp7MPla3lX8EyjTEHFfDHopomafcuVGywZrO2D3bYASSmgWdm4zPDJ3/OR8wIDAQABo4IBCTCCAQUwHQYDVR0OBBYEFCz7qm2AX+EztWS4EhA0Q9v96Q7YMB8GA1UdIwQYMBaAFCM0+NlSRnAK7UD7dvuzK7DDNbMPMFQGA1UdHwRNMEswSaBHoEWGQ2h0dHA6Ly9jcmwubWljcm9zb2Z0LmNvbS9wa2kvY3JsL3Byb2R1Y3RzL01pY3Jvc29mdFRpbWVTdGFtcFBDQS5jcmwwWAYIKwYBBQUHAQEETDBKMEgGCCsGAQUFBzAChjxodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFRpbWVTdGFtcFBDQS5jcnQwEwYDVR0lBAwwCgYIKwYBBQUHAwgwDQYJKoZIhvcNAQEFBQADggEBAE9ar13BCEvNIdYrQaKP/I2CllhWlBlgHzchX7N8UPIEQA1LwYo6SQNL7RY8oTmSaRqd7/EEUeUvubwpmq3b065FKeikFnD3B1ynMJkQR7exsn6nJN+CGeBwff7T0GPTjqtrzYuZO1ZM5/MjJVRNdg9l2lM0X3XtYXXyIC04fCprvomiAoAMPgK3q5khoQNldzjj+u61cEo+04bcXaIRs9qw15f42XWsMcN6EWtJImEYAbTV0iYt+KC1ZG5aSls6ytrEML56uN9KiqeXz7hUSzw/YlPyhjTOCZX+/JMhwMmkBC/ZPbCqJ9ZGK4ZGzWsM99+tUK2ZuOl85tTL0CTU1Y8=MIIGBzCCA++gAwIBAgIKYRZoNAAAAAAAHDANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMDcwNDAzMTI1MzA5WhcNMjEwNDAzMTMwMzA5WjB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCfoWyx39tIkip8ay4Z4b3i48WZUSNQrc7dGE4kD+7Rp9FMrXQwIBHrB9VUlRVJlBtCkq6YXDAm2gBr6Hu97IkHD/cOBJjwicwfyzMkh53y9GccLPx754gd6udOo6HBI1PKjfpFzwnQXq/QsEIEovmmbJNn1yjcRlOwhtDlKEYuJ6yGT1VSDOQDLPtqkJAwbofzWTCd+n7Wl7PoIZd++NIT8wi3U21StEWQn0gASkdmEScpZqiX5NMGgUqi+YSnEUcUCYKfhO1VeP4Bmh1QCIUAEDBG7bfeI0a7xC1Un68eeEExd8yb3zuDk6FhArUdDbH895uyAc4iS1T/+QXDwiALAgMBAAGjggGrMIIBpzAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBQjNPjZUkZwCu1A+3b7syuwwzWzDzALBgNVHQ8EBAMCAYYwEAYJKwYBBAGCNxUBBAMCAQAwgZgGA1UdIwSBkDCBjYAUDqyCYEBWJ5flJRP8KuEKU5VZ5KShY6RhMF8xEzARBgoJkiaJk/IsZAEZFgNjb20xGTAXBgoJkiaJk/IsZAEZFgltaWNyb3NvZnQxLTArBgNVBAMTJE1pY3Jvc29mdCBSb290IENlcnRpZmljYXRlIEF1dGhvcml0eYIQea0WoUqgpa1Mc1j0BxMuZTBQBgNVHR8ESTBHMEWgQ6BBhj9odHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9taWNyb3NvZnRyb290Y2VydC5jcmwwVAYIKwYBBQUHAQEESDBGMEQGCCsGAQUFBzAChjhodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFJvb3RDZXJ0LmNydDATBgNVHSUEDDAKBggrBgEFBQcDCDANBgkqhkiG9w0BAQUFAAOCAgEAEJeKw1wDRDbd6bStd9vOeVFNAbEudHFbbQwTq86+e4+4LtQSooxtYrhXAstOIBNQmd16QOJXu69YmhzhHQGGrLt48ovQ7DsB7uK+jwoFyI1I4vBTFd1Pq5Lk541q1YDB5pTyBi+FA+mRKiQicPv2/OR4mS4N9wficLwYTp2OawpylbihOZxnLcVRDupiXD8WmIsgP+IHGjL5zDFKdjE9K3ILyOpwPf+FChPfwgphjvDXuBfrTot/xTUrXqO/67x9C0J71FNyIe4wyrt4ZVxbARcKFA7S2hSY9Ty5ZlizLS/n+YWGzFFW6J1wlGysOUzU9nm/qhh6YinvopspNAZ3GmLJPR5tH4LwC8csu89Ds+X57H2146SodDW4TsVxIxImdgs8UoxxWkZDFLyzs7BNZ8ifQv+AeSGAnhUwZuhCEl4ayJ4iIdBD6Svpu/RIzCzU2DKATCYqSCRfWupW76bemZ3KOm+9gSd0BhHudiG/m4LBJ1S2sWo9iaF2YbRuoROmv6pH8BJv/YoybLL+31HIjCPJZr2dHYcSZAI9La9Zj7jkIeW1sMpjtHhUBdRBLlCslLCleKuzoJZ1GtmShxN1Ii8yqAhuoFuMJb+g74TKIdbrHk/Jmu5J4PcBZW+JC33Iacjmbuqnl84xKf8OxVtc2E0bodj6L54/LlUWa8kTo/0=MIIR+AYJKoZIhvcNAQcCoIIR6TCCEeUCAQMxCzAJBgUrDgMCGgUAMIIBEwYJKoZIhvcNAQcBoIIBBASCAQADLVIKSQ2BnPylHRhW/yVGiQzizletQrrBrbkUqkH22WkKbWCBD73JS/Qx80rJ5Y30jBy7Pz2JrIxN872USISRzWk1sCWRgL98zEuKFhCyoUGHjamJGQDJZkxfeOCgwP6SwOR6xQrHyt2q+kqMALInIaTB3fO3qRfUVWAf4L1L1BVrNJCL9DKpXi1PJBQ3lD1ouTnL3o24ffMV1IuEuwWFLdU+6jV+qv5aLhH8J778QQCMAS/DKQnKPoVXBEKa73l8qsNezJSg2tOOlqdQbWdJeoeXtYFbHiVjCFnCrh1/PbDw0M5Dzp0hWdyQawomuJJpo4nPlbxxFpQLCNUxWtpkoIIOoTCCBN4wggPGoAMCAQICEzMAAAD9x/DJammhyEwAAAAAAP0wDQYJKoZIhvcNAQEFBQAwdzELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEhMB8GA1UEAxMYTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBMB4XDTE4MDgyMzIwMjAxMVoXDTE5MTEyMzIwMjAxMVowgc4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xKTAnBgNVBAsTIE1pY3Jvc29mdCBPcGVyYXRpb25zIFB1ZXJ0byBSaWNvMSYwJAYDVQQLEx1UaGFsZXMgVFNTIEVTTjo1ODQ3LUY3NjEtNEY3MDElMCMGA1UEAxMcTWljcm9zb2Z0IFRpbWUtU3RhbXAgU2VydmljZTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALoJgT2owac2NGR141A4gvQHwJCFdB2vALZscxfSZVfLAoluqfiAqkKgTGazyT/maZIT2YWIeR7exoGrbka0Aq4u6H1Vqu8061ALsNijMTwDDN1gkUfxMw4iWzN7M2biDTT+8dYkVYsN2v5OIYbJq4PH8QPfWHx/4yWUxtncoVSkKSgp4j49FCQX5+zR696RrM/W2s9fxi33GrllCx0axeaF+iri0UWk1tGtl53B3g1oW+dYzhn9BTyicvQtwWTpyNbAUrfhf95LRlsQdV9VTDnZRlJ06ezD5Wt5V/BMo0xBxXwx6KaJmn3LlRssGaztg922AEkpoFnZuMzwyd/zkfMCAwEAAaOCAQkwggEFMB0GA1UdDgQWBBQs+6ptgF/hM7VkuBIQNEPb/ekO2DAfBgNVHSMEGDAWgBQjNPjZUkZwCu1A+3b7syuwwzWzDzBUBgNVHR8ETTBLMEmgR6BFhkNodHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9NaWNyb3NvZnRUaW1lU3RhbXBQQ0EuY3JsMFgGCCsGAQUFBwEBBEwwSjBIBggrBgEFBQcwAoY8aHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraS9jZXJ0cy9NaWNyb3NvZnRUaW1lU3RhbXBQQ0EuY3J0MBMGA1UdJQQMMAoGCCsGAQUFBwMIMA0GCSqGSIb3DQEBBQUAA4IBAQBPWq9dwQhLzSHWK0Gij/yNgpZYVpQZYB83IV+zfFDyBEANS8GKOkkDS+0WPKE5kmkane/xBFHlL7m8KZqt29OuRSnopBZw9wdcpzCZEEe3sbJ+pyTfghngcH3+09Bj046ra82LmTtWTOfzIyVUTXYPZdpTNF917WF18iAtOHwqa76JogKADD4Ct6uZIaEDZXc44/rutXBKPtOG3F2iEbPasNeX+Nl1rDHDehFrSSJhGAG01dImLfigtWRuWkpbOsraxDC+erjfSoqnl8+4VEs8P2JT8oY0zgmV/vyTIcDJpAQv2T2wqifWRiuGRs1rDPffrVCtmbjpfObUy9Ak1NWPMIIGBzCCA++gAwIBAgIKYRZoNAAAAAAAHDANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMDcwNDAzMTI1MzA5WhcNMjEwNDAzMTMwMzA5WjB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCfoWyx39tIkip8ay4Z4b3i48WZUSNQrc7dGE4kD+7Rp9FMrXQwIBHrB9VUlRVJlBtCkq6YXDAm2gBr6Hu97IkHD/cOBJjwicwfyzMkh53y9GccLPx754gd6udOo6HBI1PKjfpFzwnQXq/QsEIEovmmbJNn1yjcRlOwhtDlKEYuJ6yGT1VSDOQDLPtqkJAwbofzWTCd+n7Wl7PoIZd++NIT8wi3U21StEWQn0gASkdmEScpZqiX5NMGgUqi+YSnEUcUCYKfhO1VeP4Bmh1QCIUAEDBG7bfeI0a7xC1Un68eeEExd8yb3zuDk6FhArUdDbH895uyAc4iS1T/+QXDwiALAgMBAAGjggGrMIIBpzAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBQjNPjZUkZwCu1A+3b7syuwwzWzDzALBgNVHQ8EBAMCAYYwEAYJKwYBBAGCNxUBBAMCAQAwgZgGA1UdIwSBkDCBjYAUDqyCYEBWJ5flJRP8KuEKU5VZ5KShY6RhMF8xEzARBgoJkiaJk/IsZAEZFgNjb20xGTAXBgoJkiaJk/IsZAEZFgltaWNyb3NvZnQxLTArBgNVBAMTJE1pY3Jvc29mdCBSb290IENlcnRpZmljYXRlIEF1dGhvcml0eYIQea0WoUqgpa1Mc1j0BxMuZTBQBgNVHR8ESTBHMEWgQ6BBhj9odHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9taWNyb3NvZnRyb290Y2VydC5jcmwwVAYIKwYBBQUHAQEESDBGMEQGCCsGAQUFBzAChjhodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFJvb3RDZXJ0LmNydDATBgNVHSUEDDAKBggrBgEFBQcDCDANBgkqhkiG9w0BAQUFAAOCAgEAEJeKw1wDRDbd6bStd9vOeVFNAbEudHFbbQwTq86+e4+4LtQSooxtYrhXAstOIBNQmd16QOJXu69YmhzhHQGGrLt48ovQ7DsB7uK+jwoFyI1I4vBTFd1Pq5Lk541q1YDB5pTyBi+FA+mRKiQicPv2/OR4mS4N9wficLwYTp2OawpylbihOZxnLcVRDupiXD8WmIsgP+IHGjL5zDFKdjE9K3ILyOpwPf+FChPfwgphjvDXuBfrTot/xTUrXqO/67x9C0J71FNyIe4wyrt4ZVxbARcKFA7S2hSY9Ty5ZlizLS/n+YWGzFFW6J1wlGysOUzU9nm/qhh6YinvopspNAZ3GmLJPR5tH4LwC8csu89Ds+X57H2146SodDW4TsVxIxImdgs8UoxxWkZDFLyzs7BNZ8ifQv+AeSGAnhUwZuhCEl4ayJ4iIdBD6Svpu/RIzCzU2DKATCYqSCRfWupW76bemZ3KOm+9gSd0BhHudiG/m4LBJ1S2sWo9iaF2YbRuoROmv6pH8BJv/YoybLL+31HIjCPJZr2dHYcSZAI9La9Zj7jkIeW1sMpjtHhUBdRBLlCslLCleKuzoJZ1GtmShxN1Ii8yqAhuoFuMJb+g74TKIdbrHk/Jmu5J4PcBZW+JC33Iacjmbuqnl84xKf8OxVtc2E0bodj6L54/LlUWa8kTo/2hggOwMIICmAIBATCB/qGB1KSB0TCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOjU4NDctRjc2MS00RjcwMSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNloiUKAQEwCQYFKw4DAhoFAAMVALhIPNjusdolDwa6Rxcjsc+h+RUYoIHeMIHbpIHYMIHVMQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSkwJwYDVQQLEyBNaWNyb3NvZnQgT3BlcmF0aW9ucyBQdWVydG8gUmljbzEnMCUGA1UECxMebkNpcGhlciBOVFMgRVNOOjRERTktMEM1RS0zRTA5MSswKQYDVQQDEyJNaWNyb3NvZnQgVGltZSBTb3VyY2UgTWFzdGVyIENsb2NrMA0GCSqGSIb3DQEBBQUAAgUA4A9zgzAiGA8yMDE5MDIxNDEyNTYzNVoYDzIwMTkwMjE1MTI1NjM1WjB3MD0GCisGAQQBhFkKBAExLzAtMAoCBQDgD3ODAgEAMAoCAQACAgRrAgH/MAcCAQACAheLMAoCBQDgEMUDAgEAMDYGCisGAQQBhFkKBAIxKDAmMAwGCisGAQQBhFkKAwGgCjAIAgEAAgMW42ChCjAIAgEAAgMHoSAwDQYJKoZIhvcNAQEFBQADggEBAGJyxo+TNZxVwehECx3VgWDnV5jYwp8he4IUx0+85psQXe4Qtc/HuGMNK7o0rZSDrxpL1th2SU1Tk1zoOYZV4Nyq6XW4VZ3m8q279S8Sq/4zgBLeTRt8Kzk5Dyh5GdVMtw3Yd/L+PuHCfNql8qbzlVjjbcbOx7GRed4LE1eOW3x9Z2NEPTInsEE3hbxhqeOjeeOFM8keAc3+S1UzGkONjVctld7iGzyP3K+R6ycqnsaC9m+PUPN/tZRPWm9hI/mm3aEXrZTLbzBgmm5DMymOfLqBMJKJ7w++puWneWkIH3vob2L5sJbq3XJGsLugej7WyoWJIF123T+RYE3eMcLpnr4xggIVMIICEQIBATCBjjB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0ECEzMAAAD9x/DJammhyEwAAAAAAP0wCQYFKw4DAhoFAKBdMBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE5MDIxNDIxMDkyOFowIwYJKoZIhvcNAQkEMRYEFIR3OAgImspa4XBBybdzc1YwpmNHMA0GCSqGSIb3DQEBBQUABIIBAARrMEPAz1Dse//dBJF/Pb5vm/uGdhAWivoGWjngZNQ4KVYX6KTAsjeeVUJmb0kHhH7YZelgFiq18G/NBAgPA17irafs1pfqTvGTgmctqZS5GGA4gSCiXWiC2wtB0dJYYfRgSmfUTARJ2t4C09heg/x1VCdyRKy+fmQskJkENffg1e6qt1vDf0BHZCsTmNneJmQEE+gAaTX0hr44tazXAOJxX2LtmWaES491HIKPn6ATe5NxOy0q5veqRaidEnqdfDCQnKwkd5E1hJ9vxu5Nq3VsWthsmcw9SuSVa4gnaOBOhxM//9oHDaf787xq0F1cDuq9YNIIGLLCamuZmgoYMlE= diff --git a/packages/FAKE.5.16.0/tools/NuGet.Configuration.dll b/packages/FAKE.5.16.0/tools/NuGet.Configuration.dll new file mode 100644 index 0000000..d6f1a25 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/NuGet.Configuration.dll differ diff --git a/packages/FAKE.5.16.0/tools/NuGet.Configuration.xml b/packages/FAKE.5.16.0/tools/NuGet.Configuration.xml new file mode 100644 index 0000000..e773e74 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/NuGet.Configuration.xml @@ -0,0 +1,1283 @@ + + + + NuGet.Configuration + + + + + Indicates that the request credentials are to be used to access a proxy. + + + + + Indicates that the remote server rejected the previous request as unauthorized. This + suggests that the server does not know who the caller is (i.e. the caller is not + authenticated). + + + + + Indicates that the remote server rejected the previous request as forbidden. This + suggests that the server knows who the caller is (i.e. the caller is authorized) but + is not allowed to access the request resource. A different set of credentials could + solve this failure. + + + + + A credentials service. + + + + + Asynchronously gets credentials. + + The URI for which credentials should be retrieved. + A web proxy. + The credential request type. + A message to display when prompting for credentials. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a . + Thrown if is null. + Thrown if + is cancelled. + + + + Attempts to retrieve last known good credentials for a URI from a credentials cache. + + + When the return value is true, will have last known + good credentials from the credentials cache. These credentials may have become invalid + since their last use, so there is no guarantee that the credentials are currently valid. + + The URI for which cached credentials should be retrieved. + true for proxy credentials; otherwise, false. + Cached credentials or null. + true if a result is returned from the cache; otherwise, false. + Thrown if is null. + + + + Gets a value indicating whether this credential service wants to handle "default credentials" specially, + instead of relying on DefaultNetworkCredentials + + + + + Gets an enumerable of all of the package sources + + Enumerable of all of the package sources + + + + Gets the source that matches a given name. + + Name of source to be searched for + PackageSource that matches the given name. Null if none was found + ArgumentException when is null or empty. + + + + Gets the source that matches a given source url. + + Url of source to be searched for + PackageSource that matches the given source. Null if none was found + ArgumentException when is null or empty. + + + + Event raised when the package sources have been changed. + + + + + Removes the package source that matches the given name + + Name of source to remove + + + + Enables the package source that matches the given name + + Name of source to enable + + + + Disables the package source that matches the given name + + Name of source to disable + + + + Updates the values of the given package source. + + The package source is matched by name. + Source with updated values + Describes if credentials values from should be updated or ignored + Describes if enabled value from should be updated or ignored + + + + Adds a package source to the current configuration + + PackageSource to add + + + + Compares the given list of PackageSources with the current PackageSources in the configuration + and adds, removes or updates each source as needed. + + PackageSources to be saved + + + + Checks if a package source with a given name is part of the disabled sources configuration + + Name of the source to be queried + true if the source with the given name is not part of the disabled sources + + + + Disables the given package source + + PackageSource to disable + + + + Checks if a package source is part of the disabled sources configuration. + + + true if the source is not part of the disabled sources + + + + Gets the name of the active PackageSource + + + + + Gets the Default push source + + + + + Updates the active package source with the given source. + + Source to be set as the active package source + + + + NuGet.org gallery Url used as a source display name and as a default "id" when storing nuget.org API key. + + + Albeit this url is not actual feed we should keep it unchanged for back-compat with earlier NuGet versions. + Typical scenario leading to adding this url to config file is to run setApiKey command without a source: + nuget.exe setApiKey XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX + + + + + The feed version for NuGet prior to v3. + + + + + Returns null if Source is an invalid URI + + + + + Throws if Source is an invalid URI + + + + + This does not represent just the NuGet Official Feed alone + It may also represent a Default Package Source set by Configuration Defaults + + + + + Gets or sets the protocol version of the source. Defaults to 2. + + + + + True if the source path is file based. Unc shares are not included. + + + + + Represents credentials required to authenticate user within package source web requests. + + + + + User name + + + + + Password text as stored in config file. May be encrypted. + + + + + Indicates if password is stored in clear text. + + + + + Retrieves password in clear text. Decrypts on-demand. + + + + + Associated source ID + + + + + Verifies if object contains valid data, e.g. not empty user name and password. + + True if credentials object is valid + + + + Instantiates the credential instance out of raw values read from a config file. + + Associated source ID (needed for reporting errors) + User name + Password as stored in config file + Hints if password provided in clear text + + + + Creates new instance of credential object out values provided by user. + + Source ID needed for reporting errors if any + User name + Password text in clear + Hints if the password should be stored in clear text on disk. + New instance of + + + + Returns PackageSources if specified in the config file. Else returns the default sources specified in the + constructor. + If no default values were specified, returns an empty sequence. + + + + + Fires event PackageSourcesChanged + + + + + Gets the name of the ActivePackageSource from NuGet.Config + + + + + Saves the as the active source. + + + + + + -like interface with Update credential semantics rather than Add/Remove + + + + + Tracks the cache version. Changes every time proxy credential is updated. + + + + + Add or update proxy credential + + Proxy network address + New credential object + + + + Capture the default System Proxy so that it can be re-used by the IProxyFinder + because we can't rely on WebRequest.DefaultWebProxy since someone can modify the DefaultWebProxy + property and we can't tell if it was modified and if we are still using System Proxy Settings or not. + One limitation of this method is that it does not look at the config file to get the defined proxy + settings. + + + + + Return true or false if connecting through a proxy server + + + + + + + Internal implementation of mirroring default desktop one. + Introduced for XPlat coreFx support. + + + + + A strongly-typed resource class, for looking up localized strings, etc. + + + + + Returns the cached ResourceManager instance used by this class. + + + + + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + + + + + Looks up a localized string similar to Value cannot be null or empty string.. + + + + + Looks up a localized string similar to Attribute '{0}' is not allowed in element '{1}'.. + + + + + Looks up a localized string similar to The attribute '{0}' has an unallowed value '{1}' in element '{2}'.. + + + + + Looks up a localized string similar to The item passed to the Update method cannot refer to a different item than the one being updated.. + + + + + Looks up a localized string similar to Unable to update setting since it is in a machine-wide NuGet.Config.. + + + + + Looks up a localized string similar to Cannot update the node of a setting.. + + + + + Looks up a localized string similar to Cannot update the origin of a setting.. + + + + + Looks up a localized string similar to Credentials item must have username and password.. + + + + + Looks up a localized string similar to Encryption is not supported on non-Windows platforms.. + + + + + Looks up a localized string similar to The attribute {0}-{1} is not valid.. + + + + + Looks up a localized string similar to Cannot merge two different sections.. + + + + + Looks up a localized string similar to There are no writable config files.. + + + + + Looks up a localized string similar to File '{0}' does not exist.. + + + + + Looks up a localized string similar to "{0}" cannot be called on a NullSettings. This may be caused on account of insufficient permissions to read or write to "%AppData%\NuGet\NuGet.config".. + + + + + Looks up a localized string similar to The item does not exist in the {0} section.. + + + + + Looks up a localized string similar to Missing required attribute '{0}' in element '{1}'.. + + + + + Looks up a localized string similar to '{0}' must contain an absolute path '{1}'.. + + + + + Looks up a localized string similar to The {0} item should not have any attributes and it was found with {1}.. + + + + + Looks up a localized string similar to There is no NuGet.Config that could be used for writing settings. Please create one at the desired location and restart the client.. + + + + + Looks up a localized string similar to Owners item must have at least one owner.. + + + + + Looks up a localized string similar to Owners item must only have text content and cannot be empty.. + + + + + Looks up a localized string similar to The package source does not belong to the collection of available sources.. + + + + + Looks up a localized string similar to {0} cannot be null or empty.. + + + + + Looks up a localized string similar to Environment variable '{0}' must contain an absolute path, the full path of '{1}' cannot be determined.. + + + + + Looks up a localized string similar to The repository item with name '{0}' and service index '{1}' has more than one owners item in it.. + + + + + Looks up a localized string similar to The section '{0}' does not exist in the settings.. + + + + + Looks up a localized string similar to Parameter 'fileName' to Settings must be just a file name and not a path.. + + + + + Looks up a localized string similar to Error parsing NuGet.Config. Element '{0}' cannot have descendant elements. Path: '{1}'.. + + + + + Looks up a localized string similar to NuGet.Config is malformed. Path: '{0}'.. + + + + + Looks up a localized string similar to NuGet.Config is not valid XML. Path: '{0}'.. + + + + + Looks up a localized string similar to NuGet.Config does not contain the expected root element: 'configuration'. Path: '{0}'.. + + + + + Looks up a localized string similar to Failed to read NuGet.Config due to unauthorized access. Path: '{0}'.. + + + + + Looks up a localized string similar to Text elements should not be empty.. + + + + + Looks up a localized string similar to A trusted signer entry must have at least one certificate entry.. + + + + + Looks up a localized string similar to Unexpected failure reading NuGet.Config. Path: '{0}'.. + + + + + Looks up a localized string similar to Unknown hash algorithm is not supported.. + + + + + Looks up a localized string similar to Password decryption is not supported on .NET Core for this platform. The following feed uses an encrypted password: '{0}'. You can use a clear text password as a workaround.. + + + + + Looks up a localized string similar to Password encryption is not supported on .NET Core for this platform. The following feed try to use an encrypted password: '{0}'. You can use a clear text password as a workaround.. + + + + + Looks up a localized string similar to Certificate entry has an unsupported hash algorithm: '{0}'.. + + + + + Looks up a localized string similar to Unable to parse config file because: {0} Path: '{1}'.. + + + + + An internal constructor MAINLY INTENDED FOR TESTING THE CLASS. But, the product code is only expected to + use the static Instance property + Only catches FileNotFoundException. Will throw all exceptions including other IOExceptions and + XmlExceptions for invalid xml and so on + + The directory that has the NuGetDefaults.Config + Name of the NuGetDefaults.Config + + + + Interface to expose NuGet Settings + + + + + Gets a value for the given key from the given section + If isPath is true, then the value represents a path. If the path value is already rooted, it is simply + returned + Otherwise, path relative to ISettings.Root is returned + + + + + Gets all subsection element names under section as a List of string. + + Name of the section. + List of string containing subsection element names. + + + + Gets all the values under section + + + + + Gets all the values under section as List of KeyValuePair + + + + + Gets all the values under section as List of SettingValue + + + + + Sets the value under the specified . + + The name of the section. + The key to set set. + The value to set. + + + + Sets the values under the specified . + + The name of the section. + The values to set. + + + + Updates the across multiple instances in the hierarchy. + Values are updated in the with the nearest priority. + + The name of the section. + The values to set. + + + + Updates nested across multiple instances in the hierarchy. + Values are updated in the with the nearest priority. + + The name of the section. + The name of the subsection. + The values to set. + + + + Sets the values under the specified and . + + The name of the section. + The name of the subsection. + The values to set. + + + + Sets the setting values under the specified and . + + The name of the section. + The name of the subsection. + The setting values to set. + + + + Deletes a key from the specified . + + The name of the section. + The key to be delted. + bool indicating success. + + + + Deletes the specified . + + The name of the section. + bool indicating success. + + + + Gets the section with a given name. + + name to match sections + null if no section with the given name was found + + + + Adds or updates the given to the settings. + If the has to be added this method will add it + in the user wide settings file, or walk down the hierarchy (starting from the user wide config) + until it finds a config where the given section is not cleared. + + section where the has to be added. If this section does not exist, one will be created. + item to be added to the settings. + true if the item was successfully updated or added in the settings + + + + Removes the given from the settings. + If the is the last item in the section, the section will also be removed. + If the item is overriding any items from other configs it will delete all the merged items that are + not in a machine wide config. + + Section where the is stored. If this section does not exist, the method will throw + item to be removed from the settings + If the is in a machine wide config this method will throw + + + + Flushes any update that has been done in memory through the ISettings API to the settings file in disk. + + + + + Event raised when the setting have been changed. + + + + + Get a list of all the paths of the settings files used as part of this settings object + + + + + Get a list of all the roots of the settings files used as part of this settings object + + + + + A CredentialsItem has a name and it can have between 2 or 3 children: + - [Required] Username (AddItem) + - [Required] Either Password or ClearTextPassword (AddItem) + - [Optional] ValidAuthenticationTypes (AddItem) + + + + + This method is internal because it updates directly the xElement behind this abstraction. + It should only be called whenever the underlaying config file is intended to be changed. + To persist changes to disk one must save the corresponding setting files + + + + + There should not be a NuGetConfiguration without an Origin. + This constructor should only be used for tests. + + + + + There should not be a NuGetConfiguration without an Origin. + This constructor should only be used for tests. + + + + + Fallback package folders. There many be zero or more of these. + + + + + User global packages folder. + + + + + User level http cache. + + + + + Load paths from already loaded settings. + + NuGet.Config settings. + + + + Load settings based on the solution or project root directory. NuGet.Config files will + be discovered based on this path. The machine wide config will also be loaded. + + Root directory of the solution or project. + + + + Default constructor + + + + + Specifies if the setting is an in-memory-only setting. + + + + + Specifies if the setting is a copy of a concrete setting in a file. + + + + + Specifies if the setting has attributes or values. + + + + + Gives the representation of this setting as an XNode object + + + + + Creates a shallow copy of the setting. + Does not copy any pointer to the original data structure. + Just copies the abstraction. + + + + + Convenience method to add an element to an origin. + Since an origin should not be updated, any update will be ignored. + + Each setting can override this method to include any descendants to the origin + + + + Convenience method to remove an element from it's origin and convert to abstract + + Each setting can override this method to remove any descendants from their origin + + + + Text that differentiates element tag + + + + + Specifies the keys for the attributes that the element can have + + If null then all attributes are allowed + + + + Specifies the keys for the attributes that the element should have + + If null or empty then no attributes are required + + + + Specifies which values are allowed for a specific attribute. + If an attribute is not defined every value is allowed. + Having allowed values does not imply that the attribute is required. + + + + + Specifies values that are explicitely disallowed for a specific attribute. + If an attribute is not defined no value is disallowed. + Having disallowed values does not imply that the attribute is required. + + + + + Key-value pairs that give more information about the element + + + + + Read only key-value pairs that give more information about the element + + + + + Specifies if the element is empty. + Each element defines its own definition of empty. + The default definition of empty is an element without attributes. + + + + + Default constructor + + + + + Constructor used when element is read from a file + + Xelement read from XML file document tree + Settings file that this element was read from + + + ---- Known sections --- * + + + ---- Known items --- * + + + + This method is internal because it updates directly the xElement behind this abstraction. + It should only be called whenever the underlying config file is intended to be changed. + To persist changes to disk one must save the corresponding setting files + + + + + Concrete implementation of ISettings to support NuGet Settings + Wrapper for computed settings from given settings files + + + + + Default file name for a settings file is 'NuGet.config' + Also, the user level setting file at '%APPDATA%\NuGet' always uses this name + + + + + NuGet config names with casing ordered by precedence. + + + + + Enumerates the sequence of instances + ordered from closer to user to further + + + + + Load default settings based on a directory. + This includes machine wide settings. + + + + + Loads user settings from the NuGet configuration files. The method walks the directory + tree in up to its root, and reads each NuGet.config file + it finds in the directories. It then reads the user specific settings, + which is file + in if is not null, + If is null, the user specific settings file is + %AppData%\NuGet\NuGet.config. + After that, the machine wide settings files are added. + + + For example, if is c:\dir1\dir2, + is "userConfig.file", the files loaded are (in the order that they are loaded): + c:\dir1\dir2\nuget.config + c:\dir1\nuget.config + c:\nuget.config + c:\dir1\dir2\userConfig.file + machine wide settings (e.g. c:\programdata\NuGet\Config\*.config) + + + The file system to walk to find configuration files. + Can be null. + + The user specified configuration file. + + The machine wide settings. If it's not null, the + settings files in the machine wide settings are added after the user sepcific + config file. + + The settings object loaded. + + + + Loads Specific NuGet.Config file. The method only loads specific config file + which is file from . + + + + + For internal use only + + + + + Loads the machine wide settings. + + + For example, if is {"IDE", "Version", "SKU" }, then + the files loaded are (in the order that they are loaded): + %programdata%\NuGet\Config\IDE\Version\SKU\*.config + %programdata%\NuGet\Config\IDE\Version\*.config + %programdata%\NuGet\Config\IDE\*.config + %programdata%\NuGet\Config\*.config + + The file system in which the settings files are read. + The additional paths under which to look for settings files. + The list of settings read. + + + + Get a list of all the paths of the settings files used as part of this settings object + + + + + Get a list of all the roots of the settings files used as part of this settings object + + + + + Order is most significant (e.g. applied last) to least significant (applied first) + ex: + c:\someLocation\nuget.config + c:\nuget.config + + + + + Checks for each possible casing of nuget.config in the directory. The first match is + returned. If there are no nuget.config files null is returned. + + For windows contains a single casing since + the file system is case insensitive. + + + + Full path to the settings file + + + + + Folder under which the settings file is present + + + + + Filename of the settings file + + + + + Next config file to read in the hierarchy + + + + + Defines if the configuration settings have been changed but have not been saved to disk + + + + + Defines if the settings file is considered a machine wide settings file + + Machine wide settings files cannot be eddited. + + + + Order in which the files will be read. + A larger number means closer to the user. + + + + + XML element for settings file + + + + + Root element of configuration file. + By definition of a nuget.config, the root element has to be a 'configuration' element + + + + + Creates an instance of a non machine wide SettingsFile with the default filename. + + path to the directory where the file is + + + + Creates an instance of a non machine wide SettingsFile. + + path to the directory where the file is + name of config file + + + + Creates an instance of a SettingsFile + + It will parse the specified document, + if it doesn't exist it will create one with the default configuration. + path to the directory where the file is + name of config file + specifies if the SettingsFile is machine wide + + + + Gets the section with a given name. + + name to match sections + null if no section with the given name was found + + + + Adds or updates the given to the settings. + + section where the has to be added. If this section does not exist, one will be created. + item to be added to the settings. + true if the item was successfully updated or added in the settings + + + + Removes the given from the settings. + If the is the last item in the section, the section will also be removed. + + Section where the is stored. If this section does not exist, the method will throw + item to be removed from the settings + If the SettingsFile is a machine wide config this method will throw + + + + Flushes any in-memory updates in the SettingsFile to disk. + + + + + This method gives you a reference to the actual abstraction instead of a clone of it. + It should be used only when intended. For most purposes you should be able to use + GetSection(...) instead. + + + + + Represents a single setting value in a settings file + + + + + Represents the key of the setting + + + + + Represents the value of the setting + + + + + Original value of the source as in NuGet.Config. + Should be used only if the SettingValue is read from a config file. + + + + + IsMachineWide tells if the setting is machine-wide or not. + Should be used only if the SettingValue is read from a config file. + + + + + The priority of this setting in the nuget.config hierarchy. Bigger number means higher priority. + Should be used only if the SettingValue is read from a config file. + + + + + Gets the that provided this value. + Should be used only if the SettingValue is read from a config file. + + + + + Gets additional values with the specified setting. + + + When reading from an XML based settings file, this includes all attributes on the element + other than the Key and Value. + + + + + Machine wide settings based on the default machine wide config directory. + + + + + Provides a common facility for locating extensions + + + + + Find paths to all extensions + + + + + Find paths to all credential providers + + + + + Retrieves a config value for the specified key + + The settings instance to retrieve + The key to look up + Determines if the retrieved value needs to be decrypted. + Determines if the retrieved value is returned as a path. + Null if the key was not found, value from config otherwise. + + + + Sets a config value in the setting. + + The settings instance to store the key-value in. + The key to store. + The value to store. + Determines if the value needs to be encrypted prior to storing. + + + + Deletes a config value from settings + + The settings instance to delete the key from. + The key to delete. + True if the value was deleted, false otherwise. + + + + Read fallback folders from the environment variable or from nuget.config. + + + + + Read fallback folders only from nuget.config. + + + + + Get the HTTP cache folder from either an environment variable or a default. + + + + + Get plugins cache folder + + + + + The DefaultPushSource can be: + - An absolute URL + - An absolute file path + - A relative file path + - The name of a registered source from a config file + + + + + Get a list of all the paths of the settings files used as part of this settings object + + + + + Throw if a path is relative. + + + + + Compares two enumberables for equality, ordered according to the specified key and optional comparer. Handles null values gracefully. + + The type of the list + The type of the sorting key + This list + The other list + The function to extract the key from each item in the list + An optional comparer for comparing keys + An optional comparer for sequences + + + + Compares two sequence for equality, allowing either sequence to be null. If one is null, both have to be + null for equality. + + + + + Compares two sets for equality, allowing either sequence to be null. + If one is null, both have to be null for equality. + + + + + Hash code creator, based on the original NuGet hash code combiner/ASP hash code combiner implementations + + + + + Create a unique hash code for the given set of items + + + + + Create a unique hash code for the given set of items + + + + + Return the enumerable as a List of T, copying if required. Optimized for common case where it is an List of T. + Avoid mutating the return value. + + https://aspnetwebstack.codeplex.com/SourceControl/latest#src/Common/CollectionExtensions.cs + + + + Return the ISet as a HashSet of T, copying if required. Optimized for common case where it is a HashSet of T. + Avoid mutating the return value. + + + +/sSsLNdt07uc+77QJxEibRJpunM=Pl+H4kOFJStLR3RQtj2O3jhH5A5Zb39O3R0t+pDhGuina6lZPBBr3dOBNUUL2rZ3qT6k4VVb2ZfDKV6NaicNGtuwhpS+Ohi0U7q6RAVpo+GRvNObg4ftQpadA0ruleiUtvhXHNMkJ4pbvUjViVxIrmfQxnSFjRUaz54xxEAokfWUOY5Z489SLXQdz0RF4A10ql0J7llT0o1RtoDYJSLfPOzc5XM6FJJNoMv9NzQXZGZ0iYXCGAxVSqiKGN6a0BuRU/wp1lBcsiK+fQxZ+/vGOnq7EZbCVG9pv5OSCT1pv+ACpX9RWuiRXfIygKcWk0jsDfE1YDEpbisks/xNxktUHQ==m1K+Tyy0HVPLPV0jHraDo5/A5UrgV7PC+C3WipFfzBLODN0Ct0Z49Gub3ufLICGP1D4OJZRyOnhjZi61X+Hbl/2IjqiIl1VMHR4+qWlJLRNj+X7DparTv3/CBzkhMGY2lZdvp96rpRL2heloKGkmmxqet6/sU3hvw8wxMIf29zYrMEBZSEaAUajNDIDd40qeLXRV7OanRHrVE770wiR9DP0zzeYjX5rN1CltAtUyWmonz7DJAYuUr+UMi3offSITg4byWkvThGNXGmtJeDpU6Y/hhcblP5Yl5175yMvHofLyGw0iW7kv/Izp2yjEVRe26PTXes/9nNOP7ul2KoKMoQ==AQABMIIE2zCCA8OgAwIBAgITMwAAAbHd7bpU6WW4XwABAAABsTANBgkqhkiG9w0BAQUFADB5MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSMwIQYDVQQDExpNaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQTAeFw0xODA3MTIyMDExMTlaFw0xOTA3MjYyMDExMTlaMHQxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xHjAcBgNVBAMTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJtSvk8stB1Tyz1dIx62g6OfwOVK4Fezwvgt1oqRX8wSzgzdArdGePRrm97nyyAhj9Q+DiWUcjp4Y2YutV/h25f9iI6oiJdVTB0ePqlpSS0TY/l+w6Wq079/wgc5ITBmNpWXb6feq6US9oXpaChpJpsanrev7FN4b8PMMTCH9vc2KzBAWUhGgFGozQyA3eNKni10Vezmp0R61RO+9MIkfQz9M83mI1+azdQpbQLVMlpqJ8+wyQGLlK/lDIt6H30iE4OG8lpL04RjVxprSXg6VOmP4YXG5T+WJede+cjLx6Hy8hsNIlu5L/yM6dsoxFUXtuj013rP/ZzTj+7pdiqCjKECAwEAAaOCAV8wggFbMBMGA1UdJQQMMAoGCCsGAQUFBwMDMB0GA1UdDgQWBBREE7QCnXc+kFVx9eQcf6wXFM8+czBQBgNVHREESTBHpEUwQzEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xFjAUBgNVBAUTDTIyOTgwMys0Mzc5NTAwHwYDVR0jBBgwFoAUyxHoytK0FlgByTcuMxYWuUyaCh8wVgYDVR0fBE8wTTBLoEmgR4ZFaHR0cDovL2NybC5taWNyb3NvZnQuY29tL3BraS9jcmwvcHJvZHVjdHMvTWljQ29kU2lnUENBXzA4LTMxLTIwMTAuY3JsMFoGCCsGAQUFBwEBBE4wTDBKBggrBgEFBQcwAoY+aHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraS9jZXJ0cy9NaWNDb2RTaWdQQ0FfMDgtMzEtMjAxMC5jcnQwDQYJKoZIhvcNAQEFBQADggEBAIOp8qYzxaF7HNJegK7spKbD6ShdVyUjjd0lCWlw6E1pFi+UuwXZm4DsWdBoZBuDNKjcz2ONnWt2APV7r0J0B8X8kcDirEUzll2x/fqORrJJ4kMGGZiFcXjTnunblRZBMTRwLEOWogJ3qS89YUpjWfGXfdFSlWCFqLwbRQc/2cGP91D1uX4IieRCxFiOQcCVOEkf1x34ME8pLztHWZI37pch7RdmkBwvLW1r/wt15aoS3fqvxBG04CEyWr8FzkX5P41Wrs5R1syufQQZMBLyv59IJpwOAA0oraXeRC3M1If/lEmVVwxNNJwjCt3DjTIJ9L01KMXe0Ig/qRIToTBwoBE=MIIFvDCCA6SgAwIBAgIKYTMmGgAAAAAAMTANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMTAwODMxMjIxOTMyWhcNMjAwODMxMjIyOTMyWjB5MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSMwIQYDVQQDExpNaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALJyWVwZMGS/HZpgICBCmXZTbD4b1m/My/Hqa/6XFhDg3zp0gxq3L6Ay7P/ewkJOI9VyANs1VwqJyq4gSfTwaKxNS42lvXlLcZtHB9r9Jd+ddYjPqnNEf9eB2/O98jakyVxF3K+tPeAoaJcap6Vyc1bxF5Tk/TWUcqDWdl8ed0WDhTgW0HNbBbpnUo2lsmkv2hkL/pJ0KeJ2L1TdFDBZ+NKNYv3LyV9GMVC5JxPkQDDPcikQKCLHN049oDI9kM2hOAaFXE5WgigqBTK3S9dPY+fSLWLxRT3nrAgA9kahntFbjCZT6HqqSvJGzzc8OJ60d1ylF56NyxGPVjzBrAlfA9MCAwEAAaOCAV4wggFaMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFMsR6MrStBZYAck3LjMWFrlMmgofMAsGA1UdDwQEAwIBhjASBgkrBgEEAYI3FQEEBQIDAQABMCMGCSsGAQQBgjcVAgQWBBT90TFO0yaKleGYYDuoMW+mPLzYLTAZBgkrBgEEAYI3FAIEDB4KAFMAdQBiAEMAQTAfBgNVHSMEGDAWgBQOrIJgQFYnl+UlE/wq4QpTlVnkpDBQBgNVHR8ESTBHMEWgQ6BBhj9odHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9taWNyb3NvZnRyb290Y2VydC5jcmwwVAYIKwYBBQUHAQEESDBGMEQGCCsGAQUFBzAChjhodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFJvb3RDZXJ0LmNydDANBgkqhkiG9w0BAQUFAAOCAgEAWTk+fyZGr+tvQLEytWrrDi9uqEn361917Uw7LddDrQv+y+ktMaMjzHxQmIAhXaw9L0y6oqhWnONwu7i0+Hm1SXL3PupBf8rhDBdpy6WcIC36C1DEVs0t40rSvHDnqA2iA6VW4LiKS1fylUKc8fPv7uOGHzQ8uFaa8FMjhSqkghyT4pQHHfLiTviMocroE6WRTsgb0o9ylSpxbZsa+BzwU9ZnzCL/XB3Nooy9J7J5Y1ZEolHN+emjWFbdmwJFRC9f9Nqu1IIybvyklRPk62nnqaIsvsgrEA5ljpnb9aL6EiYJZTiU8XofSrvR4Vbo0HiWGFzJNRZf3ZMdSY4tvq00RBzuEBUaAF3dNVshzpjHCe6FDoxPbQ4TTj18KUicctHzbMrB7HCjV5JXfZSNoBtIA1r3z6NnCnSlNu0tLxfI5nI3EvRvsTxngvlSso0zFmUeDordEN5k9G/ORtTTF+l5xAS00/ss3x+KnqwK+xMnQK3k+eGpf0a7B2BHZWBATrBC7E7ts3Z52Ao0CW0cgDEf4g5U3eWh++VHEK1kmP9QFi58vwUheuKVQSdpw5OPlcmN2Jshrg1cnPCiroZogwxqLbt2awAdlq3yFnv2FoMkuYjPaqhHMS+a3ONxPdcAfmJH0c6IybgY+g5yjcGjPa8CQGr/aZuW4hCoELQ3UAjWwz0=MIIFmTCCA4GgAwIBAgIQea0WoUqgpa1Mc1j0BxMuZTANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMDEwNTA5MjMxOTIyWhcNMjEwNTA5MjMyODEzWjBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDzXfqAZ9Rap6kMLJAg0DUIPHWEzbcHiZyJ2t7Ow2D6kWhanpRxKRh2fMLgyCV2lA5Y+gQ0Nubfr/eAuulYCyuT5Z0F43cikfc0ZDwikR1e4QmQvBT+/HVYGeF5tweSo66IWQjYnwfKA1j8aCltMtfSqMtL/OELSDJP5uu4rU/kXG8TlJnbldV126gat5SRtHdb9UgMj2p5fRRwBH1tr5D12nDYR7e/my9s5wW34RFgrHmRFHzF1qbk4X7Vw37lktI8ALU2gt554W3ztW74nzPJy1J9c5g224uha6KVl5uj3sJNJv8GlmclBsjnrOTuEjOVMZnINQhONMp5U9W1vmMyWUA2wKVOBE0921sHM+RYv+8/U2TYQlk1V/0PRXwkBE2e1jh0EZcikM5oRHSSb9VLb7CG48c2QqDQ/MHAWvmjYbkwR3GWChawkcBCle8Qfyhq4yofseTNAz93cQTHIPxJDx1FiKTXy36IrY4t7EXbxFEEySr87IaemhGXW97OU4jm4rf9rJXCKEDb7wSQ34EzOdmyRaUjhwalVYkxuwYtYA5BGH0fLrWXyxHrFdUkpZTvFRSJ/Utz+jJb/NEzAPlZYnAHMuouq0Ate8rdIWcbMJmPFqojqEHRsG4RmzbE3kB0nOFYZcFgHnpbOMiPuwQmfNQWQOW2a2yqhv0Av87BNQIDAQABo1EwTzALBgNVHQ8EBAMCAcYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUDqyCYEBWJ5flJRP8KuEKU5VZ5KQwEAYJKwYBBAGCNxUBBAMCAQAwDQYJKoZIhvcNAQEFBQADggIBAMURTQM6YN1dUhF3j7K7NsiyBb+0t6jYIJ1cEwO2HCL6BhM1tshj1JpHbyZX0lXxBLEmX9apUGigvNK4bszD6azfGc14rFl0rGY0NsQbPmw4TDMOMBINoyb+UVMA/69aToQNDx/kbQUuToVLjWwzb1TSZKu/UK99ejmgN+1jAw/8EwbOFjbUVDuVG1FiOuVNF9QFOZKaJ6hbqr3su77jIIlgcWxWs6UT0G0OI36VA+1oPfLYY7hrTbboMLXhypRL96KqXZkwsj2nwlFsKCABJCcrSwC3nRFrcL6yEIK8DJto0I07JIeqmShynTNfWZC99d6TnjpiWjQ54ohVHbkGsMGJay3XacMZEjaE0Mmg2v8vaXiy5Xra69cMwPe9Yxe4ORM4ojZbe/KFVmodZGLBOOKqv1FmopT1EpxmIhBr8rcwki3yKfA9OxRDaKLxnCk3y844ICVtfGfzfiQSJAMIgUfspZ6X9RjXz7vV73aW7/3O21adlaBC+ZdY4dcxItNfWeY+biIA6kOEtiXb2fMIVmjAZGsdfOy2k6JiV24u2OdYj8QxSSbd3ik1h/UwcXBbFDxpvYkSfesuo/7Yf56CWlIKK8FDK9kwiJ/IEPuJjeahhXUzfmye23MTZGJppS99ypZtn/gETTCSPW4hFCHJPeDD/YprnUr90aGdmUN3P7DaMIIE3jCCA8agAwIBAgITMwAAAP3H8MlqaaHITAAAAAAA/TANBgkqhkiG9w0BAQUFADB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EwHhcNMTgwODIzMjAyMDExWhcNMTkxMTIzMjAyMDExWjCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOjU4NDctRjc2MS00RjcwMSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAugmBPajBpzY0ZHXjUDiC9AfAkIV0Ha8AtmxzF9JlV8sCiW6p+ICqQqBMZrPJP+ZpkhPZhYh5Ht7GgatuRrQCri7ofVWq7zTrUAuw2KMxPAMM3WCRR/EzDiJbM3szZuINNP7x1iRViw3a/k4hhsmrg8fxA99YfH/jJZTG2dyhVKQpKCniPj0UJBfn7NHr3pGsz9baz1/GLfcauWULHRrF5oX6KuLRRaTW0a2XncHeDWhb51jOGf0FPKJy9C3BZOnI1sBSt+F/3ktGWxB1X1VMOdlGUnTp7MPla3lX8EyjTEHFfDHopomafcuVGywZrO2D3bYASSmgWdm4zPDJ3/OR8wIDAQABo4IBCTCCAQUwHQYDVR0OBBYEFCz7qm2AX+EztWS4EhA0Q9v96Q7YMB8GA1UdIwQYMBaAFCM0+NlSRnAK7UD7dvuzK7DDNbMPMFQGA1UdHwRNMEswSaBHoEWGQ2h0dHA6Ly9jcmwubWljcm9zb2Z0LmNvbS9wa2kvY3JsL3Byb2R1Y3RzL01pY3Jvc29mdFRpbWVTdGFtcFBDQS5jcmwwWAYIKwYBBQUHAQEETDBKMEgGCCsGAQUFBzAChjxodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFRpbWVTdGFtcFBDQS5jcnQwEwYDVR0lBAwwCgYIKwYBBQUHAwgwDQYJKoZIhvcNAQEFBQADggEBAE9ar13BCEvNIdYrQaKP/I2CllhWlBlgHzchX7N8UPIEQA1LwYo6SQNL7RY8oTmSaRqd7/EEUeUvubwpmq3b065FKeikFnD3B1ynMJkQR7exsn6nJN+CGeBwff7T0GPTjqtrzYuZO1ZM5/MjJVRNdg9l2lM0X3XtYXXyIC04fCprvomiAoAMPgK3q5khoQNldzjj+u61cEo+04bcXaIRs9qw15f42XWsMcN6EWtJImEYAbTV0iYt+KC1ZG5aSls6ytrEML56uN9KiqeXz7hUSzw/YlPyhjTOCZX+/JMhwMmkBC/ZPbCqJ9ZGK4ZGzWsM99+tUK2ZuOl85tTL0CTU1Y8=MIIGBzCCA++gAwIBAgIKYRZoNAAAAAAAHDANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMDcwNDAzMTI1MzA5WhcNMjEwNDAzMTMwMzA5WjB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCfoWyx39tIkip8ay4Z4b3i48WZUSNQrc7dGE4kD+7Rp9FMrXQwIBHrB9VUlRVJlBtCkq6YXDAm2gBr6Hu97IkHD/cOBJjwicwfyzMkh53y9GccLPx754gd6udOo6HBI1PKjfpFzwnQXq/QsEIEovmmbJNn1yjcRlOwhtDlKEYuJ6yGT1VSDOQDLPtqkJAwbofzWTCd+n7Wl7PoIZd++NIT8wi3U21StEWQn0gASkdmEScpZqiX5NMGgUqi+YSnEUcUCYKfhO1VeP4Bmh1QCIUAEDBG7bfeI0a7xC1Un68eeEExd8yb3zuDk6FhArUdDbH895uyAc4iS1T/+QXDwiALAgMBAAGjggGrMIIBpzAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBQjNPjZUkZwCu1A+3b7syuwwzWzDzALBgNVHQ8EBAMCAYYwEAYJKwYBBAGCNxUBBAMCAQAwgZgGA1UdIwSBkDCBjYAUDqyCYEBWJ5flJRP8KuEKU5VZ5KShY6RhMF8xEzARBgoJkiaJk/IsZAEZFgNjb20xGTAXBgoJkiaJk/IsZAEZFgltaWNyb3NvZnQxLTArBgNVBAMTJE1pY3Jvc29mdCBSb290IENlcnRpZmljYXRlIEF1dGhvcml0eYIQea0WoUqgpa1Mc1j0BxMuZTBQBgNVHR8ESTBHMEWgQ6BBhj9odHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9taWNyb3NvZnRyb290Y2VydC5jcmwwVAYIKwYBBQUHAQEESDBGMEQGCCsGAQUFBzAChjhodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFJvb3RDZXJ0LmNydDATBgNVHSUEDDAKBggrBgEFBQcDCDANBgkqhkiG9w0BAQUFAAOCAgEAEJeKw1wDRDbd6bStd9vOeVFNAbEudHFbbQwTq86+e4+4LtQSooxtYrhXAstOIBNQmd16QOJXu69YmhzhHQGGrLt48ovQ7DsB7uK+jwoFyI1I4vBTFd1Pq5Lk541q1YDB5pTyBi+FA+mRKiQicPv2/OR4mS4N9wficLwYTp2OawpylbihOZxnLcVRDupiXD8WmIsgP+IHGjL5zDFKdjE9K3ILyOpwPf+FChPfwgphjvDXuBfrTot/xTUrXqO/67x9C0J71FNyIe4wyrt4ZVxbARcKFA7S2hSY9Ty5ZlizLS/n+YWGzFFW6J1wlGysOUzU9nm/qhh6YinvopspNAZ3GmLJPR5tH4LwC8csu89Ds+X57H2146SodDW4TsVxIxImdgs8UoxxWkZDFLyzs7BNZ8ifQv+AeSGAnhUwZuhCEl4ayJ4iIdBD6Svpu/RIzCzU2DKATCYqSCRfWupW76bemZ3KOm+9gSd0BhHudiG/m4LBJ1S2sWo9iaF2YbRuoROmv6pH8BJv/YoybLL+31HIjCPJZr2dHYcSZAI9La9Zj7jkIeW1sMpjtHhUBdRBLlCslLCleKuzoJZ1GtmShxN1Ii8yqAhuoFuMJb+g74TKIdbrHk/Jmu5J4PcBZW+JC33Iacjmbuqnl84xKf8OxVtc2E0bodj6L54/LlUWa8kTo/0=MIIR+AYJKoZIhvcNAQcCoIIR6TCCEeUCAQMxCzAJBgUrDgMCGgUAMIIBEwYJKoZIhvcNAQcBoIIBBASCAQA+X4fiQ4UlK0tHdFC2PY7eOEfkDllvf07dHS36kOEa6KdrqVk8EGvd04E1RQvatnepPqThVVvZl8MpXo1qJw0a27CGlL46GLRTurpEBWmj4ZG805uDh+1Clp0DSu6V6JS2+Fcc0yQnilu9SNWJXEiuZ9DGdIWNFRrPnjHEQCiR9ZQ5jlnjz1ItdB3PREXgDXSqXQnuWVPSjVG2gNglIt887NzlczoUkk2gy/03NBdkZnSJhcIYDFVKqIoY3prQG5FT/CnWUFyyIr59DFn7+8Y6ersRlsJUb2m/k5IJPWm/4AKlf1Fa6JFd8jKApxaTSOwN8TVgMSluKySz/E3GS1QdoIIOoTCCBN4wggPGoAMCAQICEzMAAAD9x/DJammhyEwAAAAAAP0wDQYJKoZIhvcNAQEFBQAwdzELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEhMB8GA1UEAxMYTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBMB4XDTE4MDgyMzIwMjAxMVoXDTE5MTEyMzIwMjAxMVowgc4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xKTAnBgNVBAsTIE1pY3Jvc29mdCBPcGVyYXRpb25zIFB1ZXJ0byBSaWNvMSYwJAYDVQQLEx1UaGFsZXMgVFNTIEVTTjo1ODQ3LUY3NjEtNEY3MDElMCMGA1UEAxMcTWljcm9zb2Z0IFRpbWUtU3RhbXAgU2VydmljZTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALoJgT2owac2NGR141A4gvQHwJCFdB2vALZscxfSZVfLAoluqfiAqkKgTGazyT/maZIT2YWIeR7exoGrbka0Aq4u6H1Vqu8061ALsNijMTwDDN1gkUfxMw4iWzN7M2biDTT+8dYkVYsN2v5OIYbJq4PH8QPfWHx/4yWUxtncoVSkKSgp4j49FCQX5+zR696RrM/W2s9fxi33GrllCx0axeaF+iri0UWk1tGtl53B3g1oW+dYzhn9BTyicvQtwWTpyNbAUrfhf95LRlsQdV9VTDnZRlJ06ezD5Wt5V/BMo0xBxXwx6KaJmn3LlRssGaztg922AEkpoFnZuMzwyd/zkfMCAwEAAaOCAQkwggEFMB0GA1UdDgQWBBQs+6ptgF/hM7VkuBIQNEPb/ekO2DAfBgNVHSMEGDAWgBQjNPjZUkZwCu1A+3b7syuwwzWzDzBUBgNVHR8ETTBLMEmgR6BFhkNodHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9NaWNyb3NvZnRUaW1lU3RhbXBQQ0EuY3JsMFgGCCsGAQUFBwEBBEwwSjBIBggrBgEFBQcwAoY8aHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraS9jZXJ0cy9NaWNyb3NvZnRUaW1lU3RhbXBQQ0EuY3J0MBMGA1UdJQQMMAoGCCsGAQUFBwMIMA0GCSqGSIb3DQEBBQUAA4IBAQBPWq9dwQhLzSHWK0Gij/yNgpZYVpQZYB83IV+zfFDyBEANS8GKOkkDS+0WPKE5kmkane/xBFHlL7m8KZqt29OuRSnopBZw9wdcpzCZEEe3sbJ+pyTfghngcH3+09Bj046ra82LmTtWTOfzIyVUTXYPZdpTNF917WF18iAtOHwqa76JogKADD4Ct6uZIaEDZXc44/rutXBKPtOG3F2iEbPasNeX+Nl1rDHDehFrSSJhGAG01dImLfigtWRuWkpbOsraxDC+erjfSoqnl8+4VEs8P2JT8oY0zgmV/vyTIcDJpAQv2T2wqifWRiuGRs1rDPffrVCtmbjpfObUy9Ak1NWPMIIGBzCCA++gAwIBAgIKYRZoNAAAAAAAHDANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMDcwNDAzMTI1MzA5WhcNMjEwNDAzMTMwMzA5WjB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCfoWyx39tIkip8ay4Z4b3i48WZUSNQrc7dGE4kD+7Rp9FMrXQwIBHrB9VUlRVJlBtCkq6YXDAm2gBr6Hu97IkHD/cOBJjwicwfyzMkh53y9GccLPx754gd6udOo6HBI1PKjfpFzwnQXq/QsEIEovmmbJNn1yjcRlOwhtDlKEYuJ6yGT1VSDOQDLPtqkJAwbofzWTCd+n7Wl7PoIZd++NIT8wi3U21StEWQn0gASkdmEScpZqiX5NMGgUqi+YSnEUcUCYKfhO1VeP4Bmh1QCIUAEDBG7bfeI0a7xC1Un68eeEExd8yb3zuDk6FhArUdDbH895uyAc4iS1T/+QXDwiALAgMBAAGjggGrMIIBpzAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBQjNPjZUkZwCu1A+3b7syuwwzWzDzALBgNVHQ8EBAMCAYYwEAYJKwYBBAGCNxUBBAMCAQAwgZgGA1UdIwSBkDCBjYAUDqyCYEBWJ5flJRP8KuEKU5VZ5KShY6RhMF8xEzARBgoJkiaJk/IsZAEZFgNjb20xGTAXBgoJkiaJk/IsZAEZFgltaWNyb3NvZnQxLTArBgNVBAMTJE1pY3Jvc29mdCBSb290IENlcnRpZmljYXRlIEF1dGhvcml0eYIQea0WoUqgpa1Mc1j0BxMuZTBQBgNVHR8ESTBHMEWgQ6BBhj9odHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9taWNyb3NvZnRyb290Y2VydC5jcmwwVAYIKwYBBQUHAQEESDBGMEQGCCsGAQUFBzAChjhodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFJvb3RDZXJ0LmNydDATBgNVHSUEDDAKBggrBgEFBQcDCDANBgkqhkiG9w0BAQUFAAOCAgEAEJeKw1wDRDbd6bStd9vOeVFNAbEudHFbbQwTq86+e4+4LtQSooxtYrhXAstOIBNQmd16QOJXu69YmhzhHQGGrLt48ovQ7DsB7uK+jwoFyI1I4vBTFd1Pq5Lk541q1YDB5pTyBi+FA+mRKiQicPv2/OR4mS4N9wficLwYTp2OawpylbihOZxnLcVRDupiXD8WmIsgP+IHGjL5zDFKdjE9K3ILyOpwPf+FChPfwgphjvDXuBfrTot/xTUrXqO/67x9C0J71FNyIe4wyrt4ZVxbARcKFA7S2hSY9Ty5ZlizLS/n+YWGzFFW6J1wlGysOUzU9nm/qhh6YinvopspNAZ3GmLJPR5tH4LwC8csu89Ds+X57H2146SodDW4TsVxIxImdgs8UoxxWkZDFLyzs7BNZ8ifQv+AeSGAnhUwZuhCEl4ayJ4iIdBD6Svpu/RIzCzU2DKATCYqSCRfWupW76bemZ3KOm+9gSd0BhHudiG/m4LBJ1S2sWo9iaF2YbRuoROmv6pH8BJv/YoybLL+31HIjCPJZr2dHYcSZAI9La9Zj7jkIeW1sMpjtHhUBdRBLlCslLCleKuzoJZ1GtmShxN1Ii8yqAhuoFuMJb+g74TKIdbrHk/Jmu5J4PcBZW+JC33Iacjmbuqnl84xKf8OxVtc2E0bodj6L54/LlUWa8kTo/2hggOwMIICmAIBATCB/qGB1KSB0TCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOjU4NDctRjc2MS00RjcwMSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNloiUKAQEwCQYFKw4DAhoFAAMVALhIPNjusdolDwa6Rxcjsc+h+RUYoIHeMIHbpIHYMIHVMQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSkwJwYDVQQLEyBNaWNyb3NvZnQgT3BlcmF0aW9ucyBQdWVydG8gUmljbzEnMCUGA1UECxMebkNpcGhlciBOVFMgRVNOOjRERTktMEM1RS0zRTA5MSswKQYDVQQDEyJNaWNyb3NvZnQgVGltZSBTb3VyY2UgTWFzdGVyIENsb2NrMA0GCSqGSIb3DQEBBQUAAgUA4A9zgzAiGA8yMDE5MDIxNDEyNTYzNVoYDzIwMTkwMjE1MTI1NjM1WjB3MD0GCisGAQQBhFkKBAExLzAtMAoCBQDgD3ODAgEAMAoCAQACAgRrAgH/MAcCAQACAheLMAoCBQDgEMUDAgEAMDYGCisGAQQBhFkKBAIxKDAmMAwGCisGAQQBhFkKAwGgCjAIAgEAAgMW42ChCjAIAgEAAgMHoSAwDQYJKoZIhvcNAQEFBQADggEBAGJyxo+TNZxVwehECx3VgWDnV5jYwp8he4IUx0+85psQXe4Qtc/HuGMNK7o0rZSDrxpL1th2SU1Tk1zoOYZV4Nyq6XW4VZ3m8q279S8Sq/4zgBLeTRt8Kzk5Dyh5GdVMtw3Yd/L+PuHCfNql8qbzlVjjbcbOx7GRed4LE1eOW3x9Z2NEPTInsEE3hbxhqeOjeeOFM8keAc3+S1UzGkONjVctld7iGzyP3K+R6ycqnsaC9m+PUPN/tZRPWm9hI/mm3aEXrZTLbzBgmm5DMymOfLqBMJKJ7w++puWneWkIH3vob2L5sJbq3XJGsLugej7WyoWJIF123T+RYE3eMcLpnr4xggIVMIICEQIBATCBjjB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0ECEzMAAAD9x/DJammhyEwAAAAAAP0wCQYFKw4DAhoFAKBdMBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE5MDIxNDIxMDkyOVowIwYJKoZIhvcNAQkEMRYEFLb0ZoH0TZTPGGvozBrXGRnFK3eVMA0GCSqGSIb3DQEBBQUABIIBAD8Nuxb+XG4MLKwxtOkTgklqc4g1NtaHU9wUH8xNadia/jD2RGZjjU4UItVISMfBQgX0HW2nmiRtiWOSKPd8izEHd/ZMpV6RYvqkFX/fkZvmXU90rMrlRz9t/Wq85krw9yYvlQMZBMbC4d7+kHG7W6KusPa1eLTY66WnMb00E2NDHsvIJmztbchcLdfvDAs2JBehDG0/gW20klJ+iCgxNeHUZ9wBW0N/yhFrINwWyNrKMQhBcctEM4KOp85E82701XSWynH774LKv8PbFrVgybJOjsOwqGa1lJiLIVu7ePQr5uAroLT18dN+2ZT970ccrI2J/ntdlwFkz+EVR9SyN5s= diff --git a/packages/FAKE.5.16.0/tools/NuGet.Core.dll b/packages/FAKE.5.16.0/tools/NuGet.Core.dll new file mode 100644 index 0000000..01ac733 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/NuGet.Core.dll differ diff --git a/packages/FAKE.5.16.0/tools/NuGet.Frameworks.dll b/packages/FAKE.5.16.0/tools/NuGet.Frameworks.dll new file mode 100644 index 0000000..4447923 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/NuGet.Frameworks.dll differ diff --git a/packages/FAKE.5.16.0/tools/NuGet.Frameworks.xml b/packages/FAKE.5.16.0/tools/NuGet.Frameworks.xml new file mode 100644 index 0000000..4d6cdb1 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/NuGet.Frameworks.xml @@ -0,0 +1,861 @@ + + + + NuGet.Frameworks + + + + + AssetTargetFallbackFramework only fallback when zero assets are selected. These do not + auto fallback during GetNearest as FallbackFramework would. + + + + + List framework to fall back to. + + + + + Root project framework. + + + + + Create a FallbackFramework from the current AssetTargetFallbackFramework. + + + + + Sorts frameworks according to the framework mappings + + + + + A case insensitive compare of the framework, version, and profile + + + + + A case insensitive compare of the framework name only + + + + + Sorts NuGet Frameworks in a consistent way for package readers. + The order is not particularly useful here beyond making things deterministic + since it compares completely different frameworks. + + + + + Internal cache key used to store framework compatibility. + + + + + Check if the frameworks are compatible. + + Project framework + Other framework to check against the project framework + True if framework supports other + + + + Actual compatibility check without caching + + + + + Find all equivalent frameworks, and their equivalent frameworks. + Example: + Mappings: + A <‒> B + B <‒> C + C <‒> D + For A we need to find B, C, and D so we must retrieve equivalent frameworks for A, B, and C + also as we discover them. + + + + + Creates a table of compatible frameworks. + + + + + True if the framework is in the table. + + + + + Gives the smallest set of frameworks from the table that cover everything the given framework would cover. + + + + + Returns the list of all frameworks compatible with the given framework + + + + + Singleton instance of the default framework mappings. + + + + + Contains the standard portable framework mappings + + + + + Static instance of the portable framework mappings + + + + + Get a list of frameworks supporting the provided framework. This list + is not meant to be exhaustive but is instead meant to be human-readable. + Ex: netstandard1.5 -> netstandardapp1.5, net462, dnxcore50, ... + + + + + Ex: IsCompatible(net45, net40) -> true + Ex: IsCompatible(net40, net45) -> false + + Project target framework + Library framework that is going to be installed + True if framework supports other + + + + A raw list of framework mappings. These are indexed by the framework name provider and in most cases all + mappings are + mirrored so that the IFrameworkMappings implementation only needs to provide the minimum amount of + mappings. + + + + + Synonym ‒> Identifier + Ex: NET Framework ‒> .NET Framework + + + + + Ex: .NET Framework ‒> net + + + + + Ex: WindowsPhone ‒> wp + + + + + Equal frameworks. Used for legacy conversions. + ex: Framework: Win8 <‒> Framework: NetCore45 Platform: Win8 + + + + + Framework, EquivalentProfile1, EquivalentProfile2 + Ex: Silverlight, WindowsPhone71, WindowsPhone + + + + + Frameworks which are subsets of others. + Ex: .NETCore ‒> .NET + Everything in .NETCore maps to .NET and is one way compatible. Version numbers follow the same format. + + + + + Additional framework compatibility rules beyond name and version matching. + Ex: .NETFramework supports ‒> Native + + + + + Ordered list of framework identifiers. The first framework in the list will be preferred over other + framework identifiers. This is enable better tie breaking in scenarios where legacy frameworks are + equivalently compatible to a new framework. + Example: UAP10.0 ‒> win81, wpa81 + + + + + Same as but is only referred to if all of the packages + in consideration are package based (determined by ). + + + + + Only used to choose between frameworks that are equivalent. This favors more human-readable target + frameworks identifiers. + + + + + Rewrite folder short names to the given value. + Ex: dotnet50 ‒> dotnet + + + + + Rewrite full framework names to the given value. + Ex: .NETPlatform,Version=v0.0 ‒> .NETPlatform,Version=v5.0 + + + + + Returns the official framework identifier for an alias or short name. + + + + + Gives the short name used for folders in NuGet + + + + + Get the official profile name from the short name. + + + + + Returns the shortened version of the profile name. + + + + + Parses a version string using single digit rules if no dots exist + + + + + Returns a shortened version. If all digits are single digits no dots will be used. + + + + + Tries to parse the portable profile number out of a profile. + + + + + Looks up the portable profile number based on the framework list. + + + + + Returns the frameworks based on a portable profile number. + + + + + Returns the frameworks based on a portable profile number. + + + + + Returns the frameworks based on a profile string. + Profile can be either the number in format: Profile=7, or the shortened NuGet version: net45+win8 + + + + + Parses a shortened portable framework profile list. + Ex: net45+win8 + + + + + Returns ranges of frameworks that are known to be supported by the given portable profile number. + Ex: Profile7 -> netstandard1.1 + + + + + Returns a list of all possible substitutions where the framework name + have equivalents. + Ex: sl3 -> wp8 + + + + + Gives all substitutions for a framework range. + + + + + Returns ranges of frameworks that are known to be supported by the given framework. + Ex: net45 -> native + + + + + Returns all sub sets of the given framework. + Ex: .NETFramework -> .NETCore + These will have the same version, but a different framework + + + + + The ascending order of frameworks should be based on the following ordered groups: + + 1. Non-package-based frameworks in . + 2. Other non-package-based frameworks. + 3. Package-based frameworks in . + 4. Other package-based frameworks. + + For group #1 and #3, the order within the group is based on the order of the respective precedence list. + For group #2 and #4, the order is the original order in the incoming list. This should later be made + consistent between different input orderings by using the . + + netcore50 is a special case since netcore451 is not packages based, but netcore50 is. + This sort will treat all versions of netcore as non-packages based. + + + + Used to pick between two equivalent frameworks. This is meant to favor the more human-readable + framework. Note that this comparison does not validate that the provided frameworks are indeed + equivalent (e.g. with + ). + + + + + Returns folder short names rewrites. + Ex: dotnet50 -> dotnet + + + + + Returns full name rewrites. + Ex: .NETPlatform,Version=v0.0 -> .NETPlatform,Version=v5.0 + + + + + Returns all versions of .NETStandard in ascending order. + + + + + Returns a list of frameworks that could be compatible with .NETStandard. + + + + + A group or object that is specific to a single target framework + + + + + Target framework + + + + + Use this to expose the list of target frameworks an object can be used for. + + + + + All frameworks supported by the parent + + + + + Ex: 5 -> net4, win8 + + + + + Additional optional frameworks supported in a portable profile. + Ex: 5 -> MonoAndroid1+MonoTouch1 + + + + + Compatibility mapping for portable profiles. This is a separate compatibility from that in + . + + + + + List framework to fall back to. + + + + + Interned frameworks that are commonly used in NuGet + + + + + FrameworkExpander finds all equivalent and compatible frameworks for a NuGetFramework + + + + + Return all possible equivalent, subset, and known compatible frameworks. + + + + + Finds all expansions using the mapping provider + + + + + True if the Framework is .NETFramework + + + + + Return the item with the target framework nearest the project framework + + + + + Contains identifier -> identifier + Ex: .NET Framework -> .NET Framework + Ex: NET Framework -> .NET Framework + This includes self mappings. + + + + + Converts a key using the mappings, or if the key is already converted, finds the normalized form. + + + + + Get all equivalent frameworks including the given framework + + + + + 2 way per framework profile equivalence + + + + + + 2 way framework equivalence + + + + + + An inclusive range of frameworks + + + + + Minimum Framework + + + + + Maximum Framework + + + + + Minimum version inclusiveness. + + + + + Maximum version inclusiveness. + + + + + Framework Identifier of both the Min and Max + + + + + True if the framework version falls between the min and max + + + + + Reduces a list of frameworks into the smallest set of frameworks required. + + + + + Creates a FrameworkReducer using the default framework mappings. + + + + + Creates a FrameworkReducer using custom framework mappings. + + + + + Returns the nearest matching framework that is compatible. + + Project target framework + Possible frameworks to narrow down + Nearest compatible framework. If no frameworks are compatible null is returned. + + + + Remove duplicates found in the equivalence mappings. + + + + + Reduce to the highest framework + Ex: net45, net403, net40 -> net45 + + + + + Reduce to the lowest framework + Ex: net45, net403, net40 -> net40 + + + + + Create lookup of the given PCLs to their actual frameworks + + + + + portable-net45+win8 -> net45, win8 + + + + + Order PCLs when there is no other way to decide. + + + + + Sort PCLs using these criteria + 1. Lowest number of frameworks (highest surface area) wins first + 2. Profile with the highest version numbers wins next + 3. String compare is used as a last resort + + + + + A keyvalue pair specific to a framework identifier + + + + + A portable implementation of the .NET FrameworkName type with added support for NuGet folder names. + + + + + Target framework + + + + + Target framework version + + + + + True if the profile is non-empty + + + + + Target framework profile + + + + + Formatted to a System.Versioning.FrameworkName + + + + + Formatted to a System.Versioning.FrameworkName + + + + + Creates the shortened version of the framework using the default mappings. + Ex: net45 + + + + + Creates the shortened version of the framework using the given mappings. + + + + + Portable class library check + + + + + True if the framework is packages based. + Ex: dotnet, dnxcore, netcoreapp, netstandard, uap, netcore50 + + + + + True if this framework matches for all versions. + Ex: net + + + + + True if this framework was invalid or unknown. This framework is only compatible with Any and Agnostic. + + + + + True if this framework is non-specific. Always compatible. + + + + + True if this is the any framework. Always compatible. + + + + + True if this framework is real and not one of the special identifiers. + + + + + Full framework comparison of the identifier, version, profile, platform, and platform version + + + + + Framework name only comparison. + + + + + Frameworks that are packages based across all versions. + + + + + An unknown or invalid framework + + + + + A framework with no specific target framework. This can be used for content only packages. + + + + + A wildcard matching all frameworks + + + + + Creates a NuGetFramework from a folder name using the default mappings. + + + + + Creates a NuGetFramework from a folder name using the given mappings. + + + + + Creates a NuGetFramework from a .NET FrameworkName + + + + + Creates a NuGetFramework from a folder name using the default mappings. + + + + + Creates a NuGetFramework from a folder name using the given mappings. + + + + + Attempt to parse a common but deprecated framework using an exact string match + Support for these should be dropped as soon as possible. + + + + + A set of special and common frameworks that can be returned from the list of constants without parsing + Using the interned frameworks here optimizes comparisons since they can be checked by reference. + This is designed to optimize + + + + + Find the most compatible group based on target framework + + framework specific groups or items + project target framework + retrieves the framework from the group + + + + Find the most compatible group based on target framework + + framework specific groups or items + project target framework + retrieves the framework from the group + framework mappings + + + + Find the most compatible group based on target framework + + framework specific groups or items + project target framework + + + + Find the most compatible group based on target framework + + framework specific groups or items + project target framework + + + + Check compatibility with additional checks for the fallback framework. + + + + + True if the framework is netcore50 or higher. This is where the framework + becomes packages based. + + + + + Creates a one way compatibility mapping. + Ex: net -supports-> native + + Project framework + Framework that is supported by the project framework + + + + Primary framework range or project target framework that supports the SuppportedFrameworkRange + + + + + Framework range that is supported by the TargetFrameworkRange + + + + + A strongly-typed resource class, for looking up localized strings, etc. + + + + + Returns the cached ResourceManager instance used by this class. + + + + + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + + + + + Looks up a localized string similar to Frameworks must have the same identifier, profile, and platform.. + + + + + Looks up a localized string similar to Invalid framework identifier '{0}'.. + + + + + Looks up a localized string similar to Invalid framework version '{0}'.. + + + + + Looks up a localized string similar to Invalid portable frameworks '{0}'. A hyphen may not be in any of the portable framework names.. + + + + + Looks up a localized string similar to Invalid portable frameworks for '{0}'. A portable framework must have at least one framework in the profile.. + + + + + Compares two enumberables for equality, ordered according to the specified key and optional comparer. Handles null values gracefully. + + The type of the list + The type of the sorting key + This list + The other list + The function to extract the key from each item in the list + An optional comparer for comparing keys + An optional comparer for sequences + + + + Compares two sequence for equality, allowing either sequence to be null. If one is null, both have to be + null for equality. + + + + + Compares two sets for equality, allowing either sequence to be null. + If one is null, both have to be null for equality. + + + + + Hash code creator, based on the original NuGet hash code combiner/ASP hash code combiner implementations + + + + + Create a unique hash code for the given set of items + + + + + Create a unique hash code for the given set of items + + + + + Return the enumerable as a List of T, copying if required. Optimized for common case where it is an List of T. + Avoid mutating the return value. + + https://aspnetwebstack.codeplex.com/SourceControl/latest#src/Common/CollectionExtensions.cs + + + + Return the ISet as a HashSet of T, copying if required. Optimized for common case where it is a HashSet of T. + Avoid mutating the return value. + + + +qtFEUxvZmWq11uq05zTh5snHnU8=OZD6hJfgSBZk+CDUj3CNlqWDY34d97I8+CwM9hxE/wK5Lq7YqH6fp0/l4xROBtiQDpQX52XikMqxxzilRISZginPD4e5RA8wsGxGkpMnIq8OKOaQR240HCakTp5ryrVv/xd9Dpb9vSGphQ5oRBBvnxCFu2MAC/0L0Ix8bk9ILPfdv9y6nV7S2ZnKO6Yhmiqxin/SWyi5mc+c7Es9zCcrw+YIysHNCqj8QAVk6KLFTcDOruqpP0gDgthSfTWbSq16s3Ox87m4X/7bia6bmfOpgzuHGrRJYCyOMlufs9/BLV9qJQ/jIp3CvM/CrAJfZvHl6aY+lvCgxrI8xbrG6pKGrw==m1K+Tyy0HVPLPV0jHraDo5/A5UrgV7PC+C3WipFfzBLODN0Ct0Z49Gub3ufLICGP1D4OJZRyOnhjZi61X+Hbl/2IjqiIl1VMHR4+qWlJLRNj+X7DparTv3/CBzkhMGY2lZdvp96rpRL2heloKGkmmxqet6/sU3hvw8wxMIf29zYrMEBZSEaAUajNDIDd40qeLXRV7OanRHrVE770wiR9DP0zzeYjX5rN1CltAtUyWmonz7DJAYuUr+UMi3offSITg4byWkvThGNXGmtJeDpU6Y/hhcblP5Yl5175yMvHofLyGw0iW7kv/Izp2yjEVRe26PTXes/9nNOP7ul2KoKMoQ==AQABMIIE2zCCA8OgAwIBAgITMwAAAbHd7bpU6WW4XwABAAABsTANBgkqhkiG9w0BAQUFADB5MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSMwIQYDVQQDExpNaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQTAeFw0xODA3MTIyMDExMTlaFw0xOTA3MjYyMDExMTlaMHQxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xHjAcBgNVBAMTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJtSvk8stB1Tyz1dIx62g6OfwOVK4Fezwvgt1oqRX8wSzgzdArdGePRrm97nyyAhj9Q+DiWUcjp4Y2YutV/h25f9iI6oiJdVTB0ePqlpSS0TY/l+w6Wq079/wgc5ITBmNpWXb6feq6US9oXpaChpJpsanrev7FN4b8PMMTCH9vc2KzBAWUhGgFGozQyA3eNKni10Vezmp0R61RO+9MIkfQz9M83mI1+azdQpbQLVMlpqJ8+wyQGLlK/lDIt6H30iE4OG8lpL04RjVxprSXg6VOmP4YXG5T+WJede+cjLx6Hy8hsNIlu5L/yM6dsoxFUXtuj013rP/ZzTj+7pdiqCjKECAwEAAaOCAV8wggFbMBMGA1UdJQQMMAoGCCsGAQUFBwMDMB0GA1UdDgQWBBREE7QCnXc+kFVx9eQcf6wXFM8+czBQBgNVHREESTBHpEUwQzEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xFjAUBgNVBAUTDTIyOTgwMys0Mzc5NTAwHwYDVR0jBBgwFoAUyxHoytK0FlgByTcuMxYWuUyaCh8wVgYDVR0fBE8wTTBLoEmgR4ZFaHR0cDovL2NybC5taWNyb3NvZnQuY29tL3BraS9jcmwvcHJvZHVjdHMvTWljQ29kU2lnUENBXzA4LTMxLTIwMTAuY3JsMFoGCCsGAQUFBwEBBE4wTDBKBggrBgEFBQcwAoY+aHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraS9jZXJ0cy9NaWNDb2RTaWdQQ0FfMDgtMzEtMjAxMC5jcnQwDQYJKoZIhvcNAQEFBQADggEBAIOp8qYzxaF7HNJegK7spKbD6ShdVyUjjd0lCWlw6E1pFi+UuwXZm4DsWdBoZBuDNKjcz2ONnWt2APV7r0J0B8X8kcDirEUzll2x/fqORrJJ4kMGGZiFcXjTnunblRZBMTRwLEOWogJ3qS89YUpjWfGXfdFSlWCFqLwbRQc/2cGP91D1uX4IieRCxFiOQcCVOEkf1x34ME8pLztHWZI37pch7RdmkBwvLW1r/wt15aoS3fqvxBG04CEyWr8FzkX5P41Wrs5R1syufQQZMBLyv59IJpwOAA0oraXeRC3M1If/lEmVVwxNNJwjCt3DjTIJ9L01KMXe0Ig/qRIToTBwoBE=MIIFvDCCA6SgAwIBAgIKYTMmGgAAAAAAMTANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMTAwODMxMjIxOTMyWhcNMjAwODMxMjIyOTMyWjB5MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSMwIQYDVQQDExpNaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALJyWVwZMGS/HZpgICBCmXZTbD4b1m/My/Hqa/6XFhDg3zp0gxq3L6Ay7P/ewkJOI9VyANs1VwqJyq4gSfTwaKxNS42lvXlLcZtHB9r9Jd+ddYjPqnNEf9eB2/O98jakyVxF3K+tPeAoaJcap6Vyc1bxF5Tk/TWUcqDWdl8ed0WDhTgW0HNbBbpnUo2lsmkv2hkL/pJ0KeJ2L1TdFDBZ+NKNYv3LyV9GMVC5JxPkQDDPcikQKCLHN049oDI9kM2hOAaFXE5WgigqBTK3S9dPY+fSLWLxRT3nrAgA9kahntFbjCZT6HqqSvJGzzc8OJ60d1ylF56NyxGPVjzBrAlfA9MCAwEAAaOCAV4wggFaMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFMsR6MrStBZYAck3LjMWFrlMmgofMAsGA1UdDwQEAwIBhjASBgkrBgEEAYI3FQEEBQIDAQABMCMGCSsGAQQBgjcVAgQWBBT90TFO0yaKleGYYDuoMW+mPLzYLTAZBgkrBgEEAYI3FAIEDB4KAFMAdQBiAEMAQTAfBgNVHSMEGDAWgBQOrIJgQFYnl+UlE/wq4QpTlVnkpDBQBgNVHR8ESTBHMEWgQ6BBhj9odHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9taWNyb3NvZnRyb290Y2VydC5jcmwwVAYIKwYBBQUHAQEESDBGMEQGCCsGAQUFBzAChjhodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFJvb3RDZXJ0LmNydDANBgkqhkiG9w0BAQUFAAOCAgEAWTk+fyZGr+tvQLEytWrrDi9uqEn361917Uw7LddDrQv+y+ktMaMjzHxQmIAhXaw9L0y6oqhWnONwu7i0+Hm1SXL3PupBf8rhDBdpy6WcIC36C1DEVs0t40rSvHDnqA2iA6VW4LiKS1fylUKc8fPv7uOGHzQ8uFaa8FMjhSqkghyT4pQHHfLiTviMocroE6WRTsgb0o9ylSpxbZsa+BzwU9ZnzCL/XB3Nooy9J7J5Y1ZEolHN+emjWFbdmwJFRC9f9Nqu1IIybvyklRPk62nnqaIsvsgrEA5ljpnb9aL6EiYJZTiU8XofSrvR4Vbo0HiWGFzJNRZf3ZMdSY4tvq00RBzuEBUaAF3dNVshzpjHCe6FDoxPbQ4TTj18KUicctHzbMrB7HCjV5JXfZSNoBtIA1r3z6NnCnSlNu0tLxfI5nI3EvRvsTxngvlSso0zFmUeDordEN5k9G/ORtTTF+l5xAS00/ss3x+KnqwK+xMnQK3k+eGpf0a7B2BHZWBATrBC7E7ts3Z52Ao0CW0cgDEf4g5U3eWh++VHEK1kmP9QFi58vwUheuKVQSdpw5OPlcmN2Jshrg1cnPCiroZogwxqLbt2awAdlq3yFnv2FoMkuYjPaqhHMS+a3ONxPdcAfmJH0c6IybgY+g5yjcGjPa8CQGr/aZuW4hCoELQ3UAjWwz0=MIIFmTCCA4GgAwIBAgIQea0WoUqgpa1Mc1j0BxMuZTANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMDEwNTA5MjMxOTIyWhcNMjEwNTA5MjMyODEzWjBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDzXfqAZ9Rap6kMLJAg0DUIPHWEzbcHiZyJ2t7Ow2D6kWhanpRxKRh2fMLgyCV2lA5Y+gQ0Nubfr/eAuulYCyuT5Z0F43cikfc0ZDwikR1e4QmQvBT+/HVYGeF5tweSo66IWQjYnwfKA1j8aCltMtfSqMtL/OELSDJP5uu4rU/kXG8TlJnbldV126gat5SRtHdb9UgMj2p5fRRwBH1tr5D12nDYR7e/my9s5wW34RFgrHmRFHzF1qbk4X7Vw37lktI8ALU2gt554W3ztW74nzPJy1J9c5g224uha6KVl5uj3sJNJv8GlmclBsjnrOTuEjOVMZnINQhONMp5U9W1vmMyWUA2wKVOBE0921sHM+RYv+8/U2TYQlk1V/0PRXwkBE2e1jh0EZcikM5oRHSSb9VLb7CG48c2QqDQ/MHAWvmjYbkwR3GWChawkcBCle8Qfyhq4yofseTNAz93cQTHIPxJDx1FiKTXy36IrY4t7EXbxFEEySr87IaemhGXW97OU4jm4rf9rJXCKEDb7wSQ34EzOdmyRaUjhwalVYkxuwYtYA5BGH0fLrWXyxHrFdUkpZTvFRSJ/Utz+jJb/NEzAPlZYnAHMuouq0Ate8rdIWcbMJmPFqojqEHRsG4RmzbE3kB0nOFYZcFgHnpbOMiPuwQmfNQWQOW2a2yqhv0Av87BNQIDAQABo1EwTzALBgNVHQ8EBAMCAcYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUDqyCYEBWJ5flJRP8KuEKU5VZ5KQwEAYJKwYBBAGCNxUBBAMCAQAwDQYJKoZIhvcNAQEFBQADggIBAMURTQM6YN1dUhF3j7K7NsiyBb+0t6jYIJ1cEwO2HCL6BhM1tshj1JpHbyZX0lXxBLEmX9apUGigvNK4bszD6azfGc14rFl0rGY0NsQbPmw4TDMOMBINoyb+UVMA/69aToQNDx/kbQUuToVLjWwzb1TSZKu/UK99ejmgN+1jAw/8EwbOFjbUVDuVG1FiOuVNF9QFOZKaJ6hbqr3su77jIIlgcWxWs6UT0G0OI36VA+1oPfLYY7hrTbboMLXhypRL96KqXZkwsj2nwlFsKCABJCcrSwC3nRFrcL6yEIK8DJto0I07JIeqmShynTNfWZC99d6TnjpiWjQ54ohVHbkGsMGJay3XacMZEjaE0Mmg2v8vaXiy5Xra69cMwPe9Yxe4ORM4ojZbe/KFVmodZGLBOOKqv1FmopT1EpxmIhBr8rcwki3yKfA9OxRDaKLxnCk3y844ICVtfGfzfiQSJAMIgUfspZ6X9RjXz7vV73aW7/3O21adlaBC+ZdY4dcxItNfWeY+biIA6kOEtiXb2fMIVmjAZGsdfOy2k6JiV24u2OdYj8QxSSbd3ik1h/UwcXBbFDxpvYkSfesuo/7Yf56CWlIKK8FDK9kwiJ/IEPuJjeahhXUzfmye23MTZGJppS99ypZtn/gETTCSPW4hFCHJPeDD/YprnUr90aGdmUN3P7DaMIIE3jCCA8agAwIBAgITMwAAAPr+Xnt2AOhChgAAAAAA+jANBgkqhkiG9w0BAQUFADB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EwHhcNMTgwODIzMjAyMDA4WhcNMTkxMTIzMjAyMDA4WjCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOjk4RkQtQzYxRS1FNjQxMSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzwcAGQJX1ai/xcQS8o1UJGIXvx/LmhIK4BHeev3tvaQXCkGhvB3/lZjUpzsT8ROFSbPqDJXGBORDiD3sD2B7rveRS+VjZ1zdfwI/KcNPmzAYjq9qxaroRe8xJo3iHzY33dgCvRTrIiUVRAO4ewUEdXKhemEM9Y0/+Auy5J5xn/LySSjLpm39Mqm54oWr8di8cNxc2ctoWpDXFhs09PHghvYvDUTCsANn8b+9M4C8PzUPzqBev1FWwiJcWFZN5/r8V5f67Gw3N4cTqzy/yIKXB6W9xpJ4OpO0IXBSlNTUyElqXEiYrwu/uMZSzGLpyTAwT4coVXr48oDM3VlaF4loGwIDAQABo4IBCTCCAQUwHQYDVR0OBBYEFGffDVHzuflzYlNd4GaI1GFWR1dKMB8GA1UdIwQYMBaAFCM0+NlSRnAK7UD7dvuzK7DDNbMPMFQGA1UdHwRNMEswSaBHoEWGQ2h0dHA6Ly9jcmwubWljcm9zb2Z0LmNvbS9wa2kvY3JsL3Byb2R1Y3RzL01pY3Jvc29mdFRpbWVTdGFtcFBDQS5jcmwwWAYIKwYBBQUHAQEETDBKMEgGCCsGAQUFBzAChjxodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFRpbWVTdGFtcFBDQS5jcnQwEwYDVR0lBAwwCgYIKwYBBQUHAwgwDQYJKoZIhvcNAQEFBQADggEBACbUXkej3SanMKMw+xl2/cC8upmwcv1e9VUP/po7Xo0l0Zbx6q4SRbxjPKK/YF8GmeUD3dsrGw5tcH+BgXQ/2x7LVo0aioR1gtA1rfl7OjfXw1mqYHTvIidpKnFyc3gWVG8zIL+XNqSLUWP3G07xNqtuNGBYLjoy1ozdx2ZaBx5IFNEaDxdvkf6/esikvhSgLe8cK9Ko+T6XPGuK/qEvldA/gB28MU7sFMHGFxkq5ZsiYd6lReJfsj8r9ZCJnNjcNxs0VNO8+RD5X1bQEAC2fH+ZjcuDUead080pI0Gh7P4RHKT//MhhbXf6evSyUeg4VacwIB+9L0E6k55CXiHgb9w=MIIGBzCCA++gAwIBAgIKYRZoNAAAAAAAHDANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMDcwNDAzMTI1MzA5WhcNMjEwNDAzMTMwMzA5WjB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCfoWyx39tIkip8ay4Z4b3i48WZUSNQrc7dGE4kD+7Rp9FMrXQwIBHrB9VUlRVJlBtCkq6YXDAm2gBr6Hu97IkHD/cOBJjwicwfyzMkh53y9GccLPx754gd6udOo6HBI1PKjfpFzwnQXq/QsEIEovmmbJNn1yjcRlOwhtDlKEYuJ6yGT1VSDOQDLPtqkJAwbofzWTCd+n7Wl7PoIZd++NIT8wi3U21StEWQn0gASkdmEScpZqiX5NMGgUqi+YSnEUcUCYKfhO1VeP4Bmh1QCIUAEDBG7bfeI0a7xC1Un68eeEExd8yb3zuDk6FhArUdDbH895uyAc4iS1T/+QXDwiALAgMBAAGjggGrMIIBpzAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBQjNPjZUkZwCu1A+3b7syuwwzWzDzALBgNVHQ8EBAMCAYYwEAYJKwYBBAGCNxUBBAMCAQAwgZgGA1UdIwSBkDCBjYAUDqyCYEBWJ5flJRP8KuEKU5VZ5KShY6RhMF8xEzARBgoJkiaJk/IsZAEZFgNjb20xGTAXBgoJkiaJk/IsZAEZFgltaWNyb3NvZnQxLTArBgNVBAMTJE1pY3Jvc29mdCBSb290IENlcnRpZmljYXRlIEF1dGhvcml0eYIQea0WoUqgpa1Mc1j0BxMuZTBQBgNVHR8ESTBHMEWgQ6BBhj9odHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9taWNyb3NvZnRyb290Y2VydC5jcmwwVAYIKwYBBQUHAQEESDBGMEQGCCsGAQUFBzAChjhodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFJvb3RDZXJ0LmNydDATBgNVHSUEDDAKBggrBgEFBQcDCDANBgkqhkiG9w0BAQUFAAOCAgEAEJeKw1wDRDbd6bStd9vOeVFNAbEudHFbbQwTq86+e4+4LtQSooxtYrhXAstOIBNQmd16QOJXu69YmhzhHQGGrLt48ovQ7DsB7uK+jwoFyI1I4vBTFd1Pq5Lk541q1YDB5pTyBi+FA+mRKiQicPv2/OR4mS4N9wficLwYTp2OawpylbihOZxnLcVRDupiXD8WmIsgP+IHGjL5zDFKdjE9K3ILyOpwPf+FChPfwgphjvDXuBfrTot/xTUrXqO/67x9C0J71FNyIe4wyrt4ZVxbARcKFA7S2hSY9Ty5ZlizLS/n+YWGzFFW6J1wlGysOUzU9nm/qhh6YinvopspNAZ3GmLJPR5tH4LwC8csu89Ds+X57H2146SodDW4TsVxIxImdgs8UoxxWkZDFLyzs7BNZ8ifQv+AeSGAnhUwZuhCEl4ayJ4iIdBD6Svpu/RIzCzU2DKATCYqSCRfWupW76bemZ3KOm+9gSd0BhHudiG/m4LBJ1S2sWo9iaF2YbRuoROmv6pH8BJv/YoybLL+31HIjCPJZr2dHYcSZAI9La9Zj7jkIeW1sMpjtHhUBdRBLlCslLCleKuzoJZ1GtmShxN1Ii8yqAhuoFuMJb+g74TKIdbrHk/Jmu5J4PcBZW+JC33Iacjmbuqnl84xKf8OxVtc2E0bodj6L54/LlUWa8kTo/0=MIIR+AYJKoZIhvcNAQcCoIIR6TCCEeUCAQMxCzAJBgUrDgMCGgUAMIIBEwYJKoZIhvcNAQcBoIIBBASCAQA5kPqEl+BIFmT4INSPcI2WpYNjfh33sjz4LAz2HET/Arkurtiofp+nT+XjFE4G2JAOlBfnZeKQyrHHOKVEhJmCKc8Ph7lEDzCwbEaSkycirw4o5pBHbjQcJqROnmvKtW//F30Olv29IamFDmhEEG+fEIW7YwAL/QvQjHxuT0gs992/3LqdXtLZmco7piGaKrGKf9JbKLmZz5zsSz3MJyvD5gjKwc0KqPxABWToosVNwM6u6qk/SAOC2FJ9NZtKrXqzc7Hzubhf/tuJrpuZ86mDO4catElgLI4yW5+z38EtX2olD+MincK8z8KsAl9m8eXppj6W8KDGsjzFusbqkoavoIIOoTCCBN4wggPGoAMCAQICEzMAAAD6/l57dgDoQoYAAAAAAPowDQYJKoZIhvcNAQEFBQAwdzELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEhMB8GA1UEAxMYTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBMB4XDTE4MDgyMzIwMjAwOFoXDTE5MTEyMzIwMjAwOFowgc4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xKTAnBgNVBAsTIE1pY3Jvc29mdCBPcGVyYXRpb25zIFB1ZXJ0byBSaWNvMSYwJAYDVQQLEx1UaGFsZXMgVFNTIEVTTjo5OEZELUM2MUUtRTY0MTElMCMGA1UEAxMcTWljcm9zb2Z0IFRpbWUtU3RhbXAgU2VydmljZTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAM8HABkCV9Wov8XEEvKNVCRiF78fy5oSCuAR3nr97b2kFwpBobwd/5WY1Kc7E/EThUmz6gyVxgTkQ4g97A9ge673kUvlY2dc3X8CPynDT5swGI6vasWq6EXvMSaN4h82N93YAr0U6yIlFUQDuHsFBHVyoXphDPWNP/gLsuSecZ/y8kkoy6Zt/TKpueKFq/HYvHDcXNnLaFqQ1xYbNPTx4Ib2Lw1EwrADZ/G/vTOAvD81D86gXr9RVsIiXFhWTef6/FeX+uxsNzeHE6s8v8iClwelvcaSeDqTtCFwUpTU1MhJalxImK8Lv7jGUsxi6ckwME+HKFV6+PKAzN1ZWheJaBsCAwEAAaOCAQkwggEFMB0GA1UdDgQWBBRn3w1R87n5c2JTXeBmiNRhVkdXSjAfBgNVHSMEGDAWgBQjNPjZUkZwCu1A+3b7syuwwzWzDzBUBgNVHR8ETTBLMEmgR6BFhkNodHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9NaWNyb3NvZnRUaW1lU3RhbXBQQ0EuY3JsMFgGCCsGAQUFBwEBBEwwSjBIBggrBgEFBQcwAoY8aHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraS9jZXJ0cy9NaWNyb3NvZnRUaW1lU3RhbXBQQ0EuY3J0MBMGA1UdJQQMMAoGCCsGAQUFBwMIMA0GCSqGSIb3DQEBBQUAA4IBAQAm1F5Ho90mpzCjMPsZdv3AvLqZsHL9XvVVD/6aO16NJdGW8equEkW8Yzyiv2BfBpnlA93bKxsObXB/gYF0P9sey1aNGoqEdYLQNa35ezo318NZqmB07yInaSpxcnN4FlRvMyC/lzaki1Fj9xtO8TarbjRgWC46MtaM3cdmWgceSBTRGg8Xb5H+v3rIpL4UoC3vHCvSqPk+lzxriv6hL5XQP4AdvDFO7BTBxhcZKuWbImHepUXiX7I/K/WQiZzY3DcbNFTTvPkQ+V9W0BAAtnx/mY3Lg1HmndPNKSNBoez+ERyk//zIYW13+nr0slHoOFWnMCAfvS9BOpOeQl4h4G/cMIIGBzCCA++gAwIBAgIKYRZoNAAAAAAAHDANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMDcwNDAzMTI1MzA5WhcNMjEwNDAzMTMwMzA5WjB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCfoWyx39tIkip8ay4Z4b3i48WZUSNQrc7dGE4kD+7Rp9FMrXQwIBHrB9VUlRVJlBtCkq6YXDAm2gBr6Hu97IkHD/cOBJjwicwfyzMkh53y9GccLPx754gd6udOo6HBI1PKjfpFzwnQXq/QsEIEovmmbJNn1yjcRlOwhtDlKEYuJ6yGT1VSDOQDLPtqkJAwbofzWTCd+n7Wl7PoIZd++NIT8wi3U21StEWQn0gASkdmEScpZqiX5NMGgUqi+YSnEUcUCYKfhO1VeP4Bmh1QCIUAEDBG7bfeI0a7xC1Un68eeEExd8yb3zuDk6FhArUdDbH895uyAc4iS1T/+QXDwiALAgMBAAGjggGrMIIBpzAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBQjNPjZUkZwCu1A+3b7syuwwzWzDzALBgNVHQ8EBAMCAYYwEAYJKwYBBAGCNxUBBAMCAQAwgZgGA1UdIwSBkDCBjYAUDqyCYEBWJ5flJRP8KuEKU5VZ5KShY6RhMF8xEzARBgoJkiaJk/IsZAEZFgNjb20xGTAXBgoJkiaJk/IsZAEZFgltaWNyb3NvZnQxLTArBgNVBAMTJE1pY3Jvc29mdCBSb290IENlcnRpZmljYXRlIEF1dGhvcml0eYIQea0WoUqgpa1Mc1j0BxMuZTBQBgNVHR8ESTBHMEWgQ6BBhj9odHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9taWNyb3NvZnRyb290Y2VydC5jcmwwVAYIKwYBBQUHAQEESDBGMEQGCCsGAQUFBzAChjhodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFJvb3RDZXJ0LmNydDATBgNVHSUEDDAKBggrBgEFBQcDCDANBgkqhkiG9w0BAQUFAAOCAgEAEJeKw1wDRDbd6bStd9vOeVFNAbEudHFbbQwTq86+e4+4LtQSooxtYrhXAstOIBNQmd16QOJXu69YmhzhHQGGrLt48ovQ7DsB7uK+jwoFyI1I4vBTFd1Pq5Lk541q1YDB5pTyBi+FA+mRKiQicPv2/OR4mS4N9wficLwYTp2OawpylbihOZxnLcVRDupiXD8WmIsgP+IHGjL5zDFKdjE9K3ILyOpwPf+FChPfwgphjvDXuBfrTot/xTUrXqO/67x9C0J71FNyIe4wyrt4ZVxbARcKFA7S2hSY9Ty5ZlizLS/n+YWGzFFW6J1wlGysOUzU9nm/qhh6YinvopspNAZ3GmLJPR5tH4LwC8csu89Ds+X57H2146SodDW4TsVxIxImdgs8UoxxWkZDFLyzs7BNZ8ifQv+AeSGAnhUwZuhCEl4ayJ4iIdBD6Svpu/RIzCzU2DKATCYqSCRfWupW76bemZ3KOm+9gSd0BhHudiG/m4LBJ1S2sWo9iaF2YbRuoROmv6pH8BJv/YoybLL+31HIjCPJZr2dHYcSZAI9La9Zj7jkIeW1sMpjtHhUBdRBLlCslLCleKuzoJZ1GtmShxN1Ii8yqAhuoFuMJb+g74TKIdbrHk/Jmu5J4PcBZW+JC33Iacjmbuqnl84xKf8OxVtc2E0bodj6L54/LlUWa8kTo/2hggOwMIICmAIBATCB/qGB1KSB0TCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOjk4RkQtQzYxRS1FNjQxMSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNloiUKAQEwCQYFKw4DAhoFAAMVAAzqjdgApH6kf6eXPwihNVRvwjGwoIHeMIHbpIHYMIHVMQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSkwJwYDVQQLEyBNaWNyb3NvZnQgT3BlcmF0aW9ucyBQdWVydG8gUmljbzEnMCUGA1UECxMebkNpcGhlciBOVFMgRVNOOjRERTktMEM1RS0zRTA5MSswKQYDVQQDEyJNaWNyb3NvZnQgVGltZSBTb3VyY2UgTWFzdGVyIENsb2NrMA0GCSqGSIb3DQEBBQUAAgUA4BAcVjAiGA8yMDE5MDIxNTAwNTY1NFoYDzIwMTkwMjE2MDA1NjU0WjB3MD0GCisGAQQBhFkKBAExLzAtMAoCBQDgEBxWAgEAMAoCAQACAgC7AgH/MAcCAQACAhdKMAoCBQDgEW3WAgEAMDYGCisGAQQBhFkKBAIxKDAmMAwGCisGAQQBhFkKAwGgCjAIAgEAAgMW42ChCjAIAgEAAgMHoSAwDQYJKoZIhvcNAQEFBQADggEBAIA/9W4gRZDzBgwMjvHcy6Rm4MWfJQZzRV/XoZC9aGa/EhP/KWG6EwjetEIec1Qn6eRckgNJqvf40NLnzJKUD3ft6X3G01V7uEIVPBTHwkKQM52+NUJSQT+5+nAea1nJWUq79yxjDmwt5TSFEhxdwiUfY5dSwheBLiy6EQohWw895vIBMzfSNyBiSk6aftIc7C0zVKReX0Ee75NNu7EPh3/aLHX1c0hGyU9Nm23uftZMXt89X8VI40IL42/TPQoIv1RTPHptXCzWwZAotBH48xTYYiCR3duR8cTraR6d661gDs/cVt7lPUqSAQ9xVuJttzFg1T6jAHTdPe14BV93sa0xggIVMIICEQIBATCBjjB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0ECEzMAAAD6/l57dgDoQoYAAAAAAPowCQYFKw4DAhoFAKBdMBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE5MDIxNDIxMDkyOFowIwYJKoZIhvcNAQkEMRYEFNiuxpvJe1rNbB380a/P2E3FQKm3MA0GCSqGSIb3DQEBBQUABIIBAD2kXCFy+GU6B1v9upD8uI9u8Gs+qObNvVgYd8lY0vgZdOzrjj/TZ9komQ4BEXRAfYOraGCHcGJ3QDs8HesZKQii+DzoN4dd7YEOBl7+8V1ejsv5BenGLi92Mx19CzbZekviBA6cYyW/SlTNWyfjp6RDmFNZ8tPvt7zqLmsbgoTyW1s2n7lEDBW5S0nxaodGXwyc34Ktu/XLVleLURqIrpU83voNRQkWdirFuGLfdjFfFZe8pArnk7lBImkdRRsdghB1Ku8Gg5k8iObLwV5Pp61THcpkxo5k0H391Ca2l0rcwQ5ZpxkZXhmBq2Q5JunJyJvxOzfjphFXln3cdOJrppI= diff --git a/packages/FAKE.5.16.0/tools/NuGet.Packaging.Core.dll b/packages/FAKE.5.16.0/tools/NuGet.Packaging.Core.dll new file mode 100644 index 0000000..2d69645 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/NuGet.Packaging.Core.dll differ diff --git a/packages/FAKE.5.16.0/tools/NuGet.Packaging.Core.xml b/packages/FAKE.5.16.0/tools/NuGet.Packaging.Core.xml new file mode 100644 index 0000000..b406199 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/NuGet.Packaging.Core.xml @@ -0,0 +1,738 @@ + + + + NuGet.Packaging.Core + + + + + Compares the id and version of a package + + + + + Default comparer + Null ranges and the All range are treated as equal. + + + + + Default comparer + + + + + Compares the Id, Version, and Version release label. Version build metadata is ignored. + + + + + Default version range comparer. + + + + + Compare versions with a specific VersionComparison + + + + + Compare versions with a specific IVersionComparer + + + + + Default comparer that compares on the id, version, and version release labels. + + + + + True if the package identities are the same when ignoring build metadata. + + + + + Hash code of the id and version + + + + + Compares on the Id first, then version + + + + + metadata/contentFiles/files entry from a nuspec + + + + + Included files + + Required + + + + Excluded files + + + + + Build action + + + + + If true the item will be copied to the output folder. + + + + + If true the content items will keep the same folder structure in the output + folder. + + + + + Callback invoked to extract a package file. + + The path of the file in the package. + The path to write to. + The file . + The file name if the file was written; otherwise null. + + + + A basic asynchronous package reader that provides the identity, min client version, and file access. + + Higher level concepts used for normal development nupkgs should go at a higher level + + + + Asynchronously gets the identity of the package. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a . + Thrown if + is cancelled. + + + + Asynchronously gets the minimum client version needed to consume the package. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a . + Thrown if + is cancelled. + + + + Asynchronously gets zero or more package types from the .nuspec. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is cancelled. + + + + Asynchronously returns a file stream from the package. + + The file path in the package. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a . + Thrown if + is cancelled. + + + + Asynchronously gets all files in the package. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is cancelled. + + + + Asynchronously gets files in a folder in the package. + + A folder path in the package. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + for files under the specified folder. + Thrown if + is cancelled. + + + + Asynchronously gets a nuspec stream. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a . + Thrown if + is cancelled. + + + + Asynchronously gets a nuspec file path. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a + representing the nuspec file path. + Thrown if + is cancelled. + + + + Asynchronously copies files from a package to a new location. + + The destination path to copy to. + The package files to copy. + A package file extraction delegate. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns am + for the copied file paths. + Thrown if + is cancelled. + + + + A basic nuspec reader that understands ONLY the id, version, and min client version of a package. + + Higher level concepts used for normal development nupkgs should go at a higher level + + + + Package Id + + + + + + Package Version + + + + + Minimum client version needed to consume the package. + + + + + Gets zero or more package types from the .nuspec. + + + + + Id and Version of a package. + + + + + Package metadata in the nuspec + + + + + Basic package reader that provides the identity, min client version, and file access. + + Higher level concepts used for normal development nupkgs should go at a higher level + + + + Gets the package identity. + + A package identity. + + + + Gets the minimum client version needed to consume the package. + + A NuGet version. + + + + Gets zero or more package types from the .nuspec. + + A readonly list of package types. + + + + Gets a file stream from the package. + + A stream for a file in the package. + + + + Gets all files in the package. + + An enumerable of files in the package. + + + + Gets files in a folder in the package. + + Folder path + An enumerable of files under specified folder. + + + + Gets a nuspec stream. + + A stream for the nuspec. + + + + Gets a nuspec file path. + + The nuspec file path. + + + + Copies files from a package to a new location. + + The destination folder path. + The package files to copy. + A package file extraction delegate. + A logger. + A cancellation token. + An enumerable of paths of files copied to the destination. + + + + A basic nuspec reader that understand id, version, and a flat list of dependencies. + + + + + Read a nuspec from a stream. + + + + + Reads a nuspec from XML + + + + + Returns a flat list of dependencies from a nuspec + + + + + A very basic Nuspec reader that understands the Id, Version, PackageType, and MinClientVersion of a package. + + + + + Read a nuspec from a path. + + + + + Read a nuspec from a stream. + + + + + Read a nuspec from a stream. + + + + + Reads a nuspec from XML + + + + + Id of the package + + + + + Version of the package + + + + + The minimum client version this package supports. + + + + + Gets zero or more package types from the .nuspec. + + + + + Returns if the package is serviceable. + + + + + The developmentDependency attribute + + + + + Nuspec Metadata + + + + + Returns a nuspec metadata value or string.Empty. + + + + + Indexed metadata values of the XML elements in the nuspec. + If duplicate keys exist only the first is used. + + + + + Raw XML doc + + + + + Until NuspecReader and Manifest are unified, this is a place to share implementations of + reading and parsing specific elements out of the .nuspec XML. + + + + + Gets the package types from a .nuspec metadata XML element. + + The metadata XML element. + + Whether or not to use the metadata element's namespace when finding the package type + nodes. If false is specified, only the local names of the package type nodes are used + for comparison. If true is specified, the package type nodes must have the same + namespace as the metadata node. + + + A list of package types. If no package types are found in the metadata node, an empty + list is returned. + + + + + Gets the value of serviceable element from a .nuspec metadata XML element. + + The metadata XML element. + + true if the serviceable element is set in the .nuspec file as true, else false. + + + + + Represents a package dependency Id and allowed version range. + + + + + Dependency package Id + + + + + Types to include from the dependency package. + + + + + Types to exclude from the dependency package. + + + + + Range of versions allowed for the depenency + + + + + Hash code from the default PackageDependencyComparer + + + + + Id and Version range string + + + + + Represents a package identity and the dependencies of a package. + + + This class does not support groups of dependencies, the group will need to be selected before + populating this. + + + + + Represents a package identity and the dependencies of a package. + + package name + package version + package dependencies + + + + Package dependencies + + + + + Hash code from the default PackageDependencyInfoComparer + + + + + + Example: Id : Dependency1, Dependency2 + + + + + + Represents the core identity of a nupkg. + + + + + Creates a new package identity. + + name + version + + + + Package name + + + + + Package Version + + can be null + + + + True if the version is non-null + + + + + True if the package identities are the same. + + + + + + + True if the identity objects are equal based on the given comparison mode. + + + + + Sorts based on the id, then version + + + + + Compare using the default comparer. + + + + + Creates a hash code using the default comparer. + + + + + An equality comparer that checks the id, version, and version release label. + + + + + PackageIdentity.ToString returns packageId.packageVersion" + + + + It is important that this type remains immutable due to the cloning of package specs + + + + + _._ denotes an empty folder since OPC does not allow an + actual empty folder. + + + + + /_._ can be used to check empty folders from package readers where the / is normalized. + + + + + A strongly-typed resource class, for looking up localized strings, etc. + + + + + Returns the cached ResourceManager instance used by this class. + + + + + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + + + + + Looks up a localized string similar to Nuspec file contains a package type with an invalid package version '{0}'.. + + + + + Looks up a localized string similar to Nuspec file does not contain the '{0}' node.. + + + + + Looks up a localized string similar to Nuspec file does not exist in package.. + + + + + Looks up a localized string similar to Nuspec file contains a package type that is missing the name attribute.. + + + + + Looks up a localized string similar to Package contains multiple nuspec files.. + + + + + Looks up a localized string similar to Nuspec file contains multiple package types. Zero or one package type nodes are allowed.. + + + + + Looks up a localized string similar to String argument '{0}' cannot be null or empty. + + + + + A group of items/files from a nupkg with the same target framework. + + + + + Framework specific group + + group target framework + group items + + + + Group target framework + + + + + Item relative paths + + + + + Package dependencies grouped to a target framework. + + + + + Dependency group + + target framework + dependant packages + + + + Dependency group target framework + + + + + Package dependencies + + + + + Compares two enumberables for equality, ordered according to the specified key and optional comparer. Handles null values gracefully. + + The type of the list + The type of the sorting key + This list + The other list + The function to extract the key from each item in the list + An optional comparer for comparing keys + An optional comparer for sequences + + + + Compares two sequence for equality, allowing either sequence to be null. If one is null, both have to be + null for equality. + + + + + Compares two sets for equality, allowing either sequence to be null. + If one is null, both have to be null for equality. + + + + + Hash code creator, based on the original NuGet hash code combiner/ASP hash code combiner implementations + + + + + Create a unique hash code for the given set of items + + + + + Create a unique hash code for the given set of items + + + + + Return the enumerable as a List of T, copying if required. Optimized for common case where it is an List of T. + Avoid mutating the return value. + + https://aspnetwebstack.codeplex.com/SourceControl/latest#src/Common/CollectionExtensions.cs + + + + Return the ISet as a HashSet of T, copying if required. Optimized for common case where it is a HashSet of T. + Avoid mutating the return value. + + + +njA/SF3LvL094pT7JVtQmTmGwrA=iMjlbTRO+mFDLnmc6XkTBcYNavjWTHYm0RaIF9hjIqy4q1juhrEDmRXs58Ks7QdYgCNgEF7DZdjSVhXyymmW+jClNOw9ACsaUMlvyaGQ+NDPMeedPfc7CrsMZsDajbzt0EgoFVksl5PqW3IAPKe2WuIei6DjoiwH0f7ANbU5M70+r2I5yQOKhliYCFI71TOV0wIXeykxssBhoh+jUqq2p3xz4vn2JloIwBqIo1odBCyS05K7KjoqxFUuqppL4pWOJQgX2cnu6MrDmd3enuGvGO299pVlj8Ja7efktyf3+2DGAIhBcEVIDe8XeMJDMJG2bUOkP9xTVYhwqedXcW5TQA==m1K+Tyy0HVPLPV0jHraDo5/A5UrgV7PC+C3WipFfzBLODN0Ct0Z49Gub3ufLICGP1D4OJZRyOnhjZi61X+Hbl/2IjqiIl1VMHR4+qWlJLRNj+X7DparTv3/CBzkhMGY2lZdvp96rpRL2heloKGkmmxqet6/sU3hvw8wxMIf29zYrMEBZSEaAUajNDIDd40qeLXRV7OanRHrVE770wiR9DP0zzeYjX5rN1CltAtUyWmonz7DJAYuUr+UMi3offSITg4byWkvThGNXGmtJeDpU6Y/hhcblP5Yl5175yMvHofLyGw0iW7kv/Izp2yjEVRe26PTXes/9nNOP7ul2KoKMoQ==AQABMIIE2zCCA8OgAwIBAgITMwAAAbHd7bpU6WW4XwABAAABsTANBgkqhkiG9w0BAQUFADB5MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSMwIQYDVQQDExpNaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQTAeFw0xODA3MTIyMDExMTlaFw0xOTA3MjYyMDExMTlaMHQxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xHjAcBgNVBAMTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJtSvk8stB1Tyz1dIx62g6OfwOVK4Fezwvgt1oqRX8wSzgzdArdGePRrm97nyyAhj9Q+DiWUcjp4Y2YutV/h25f9iI6oiJdVTB0ePqlpSS0TY/l+w6Wq079/wgc5ITBmNpWXb6feq6US9oXpaChpJpsanrev7FN4b8PMMTCH9vc2KzBAWUhGgFGozQyA3eNKni10Vezmp0R61RO+9MIkfQz9M83mI1+azdQpbQLVMlpqJ8+wyQGLlK/lDIt6H30iE4OG8lpL04RjVxprSXg6VOmP4YXG5T+WJede+cjLx6Hy8hsNIlu5L/yM6dsoxFUXtuj013rP/ZzTj+7pdiqCjKECAwEAAaOCAV8wggFbMBMGA1UdJQQMMAoGCCsGAQUFBwMDMB0GA1UdDgQWBBREE7QCnXc+kFVx9eQcf6wXFM8+czBQBgNVHREESTBHpEUwQzEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xFjAUBgNVBAUTDTIyOTgwMys0Mzc5NTAwHwYDVR0jBBgwFoAUyxHoytK0FlgByTcuMxYWuUyaCh8wVgYDVR0fBE8wTTBLoEmgR4ZFaHR0cDovL2NybC5taWNyb3NvZnQuY29tL3BraS9jcmwvcHJvZHVjdHMvTWljQ29kU2lnUENBXzA4LTMxLTIwMTAuY3JsMFoGCCsGAQUFBwEBBE4wTDBKBggrBgEFBQcwAoY+aHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraS9jZXJ0cy9NaWNDb2RTaWdQQ0FfMDgtMzEtMjAxMC5jcnQwDQYJKoZIhvcNAQEFBQADggEBAIOp8qYzxaF7HNJegK7spKbD6ShdVyUjjd0lCWlw6E1pFi+UuwXZm4DsWdBoZBuDNKjcz2ONnWt2APV7r0J0B8X8kcDirEUzll2x/fqORrJJ4kMGGZiFcXjTnunblRZBMTRwLEOWogJ3qS89YUpjWfGXfdFSlWCFqLwbRQc/2cGP91D1uX4IieRCxFiOQcCVOEkf1x34ME8pLztHWZI37pch7RdmkBwvLW1r/wt15aoS3fqvxBG04CEyWr8FzkX5P41Wrs5R1syufQQZMBLyv59IJpwOAA0oraXeRC3M1If/lEmVVwxNNJwjCt3DjTIJ9L01KMXe0Ig/qRIToTBwoBE=MIIFvDCCA6SgAwIBAgIKYTMmGgAAAAAAMTANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMTAwODMxMjIxOTMyWhcNMjAwODMxMjIyOTMyWjB5MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSMwIQYDVQQDExpNaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALJyWVwZMGS/HZpgICBCmXZTbD4b1m/My/Hqa/6XFhDg3zp0gxq3L6Ay7P/ewkJOI9VyANs1VwqJyq4gSfTwaKxNS42lvXlLcZtHB9r9Jd+ddYjPqnNEf9eB2/O98jakyVxF3K+tPeAoaJcap6Vyc1bxF5Tk/TWUcqDWdl8ed0WDhTgW0HNbBbpnUo2lsmkv2hkL/pJ0KeJ2L1TdFDBZ+NKNYv3LyV9GMVC5JxPkQDDPcikQKCLHN049oDI9kM2hOAaFXE5WgigqBTK3S9dPY+fSLWLxRT3nrAgA9kahntFbjCZT6HqqSvJGzzc8OJ60d1ylF56NyxGPVjzBrAlfA9MCAwEAAaOCAV4wggFaMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFMsR6MrStBZYAck3LjMWFrlMmgofMAsGA1UdDwQEAwIBhjASBgkrBgEEAYI3FQEEBQIDAQABMCMGCSsGAQQBgjcVAgQWBBT90TFO0yaKleGYYDuoMW+mPLzYLTAZBgkrBgEEAYI3FAIEDB4KAFMAdQBiAEMAQTAfBgNVHSMEGDAWgBQOrIJgQFYnl+UlE/wq4QpTlVnkpDBQBgNVHR8ESTBHMEWgQ6BBhj9odHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9taWNyb3NvZnRyb290Y2VydC5jcmwwVAYIKwYBBQUHAQEESDBGMEQGCCsGAQUFBzAChjhodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFJvb3RDZXJ0LmNydDANBgkqhkiG9w0BAQUFAAOCAgEAWTk+fyZGr+tvQLEytWrrDi9uqEn361917Uw7LddDrQv+y+ktMaMjzHxQmIAhXaw9L0y6oqhWnONwu7i0+Hm1SXL3PupBf8rhDBdpy6WcIC36C1DEVs0t40rSvHDnqA2iA6VW4LiKS1fylUKc8fPv7uOGHzQ8uFaa8FMjhSqkghyT4pQHHfLiTviMocroE6WRTsgb0o9ylSpxbZsa+BzwU9ZnzCL/XB3Nooy9J7J5Y1ZEolHN+emjWFbdmwJFRC9f9Nqu1IIybvyklRPk62nnqaIsvsgrEA5ljpnb9aL6EiYJZTiU8XofSrvR4Vbo0HiWGFzJNRZf3ZMdSY4tvq00RBzuEBUaAF3dNVshzpjHCe6FDoxPbQ4TTj18KUicctHzbMrB7HCjV5JXfZSNoBtIA1r3z6NnCnSlNu0tLxfI5nI3EvRvsTxngvlSso0zFmUeDordEN5k9G/ORtTTF+l5xAS00/ss3x+KnqwK+xMnQK3k+eGpf0a7B2BHZWBATrBC7E7ts3Z52Ao0CW0cgDEf4g5U3eWh++VHEK1kmP9QFi58vwUheuKVQSdpw5OPlcmN2Jshrg1cnPCiroZogwxqLbt2awAdlq3yFnv2FoMkuYjPaqhHMS+a3ONxPdcAfmJH0c6IybgY+g5yjcGjPa8CQGr/aZuW4hCoELQ3UAjWwz0=MIIFmTCCA4GgAwIBAgIQea0WoUqgpa1Mc1j0BxMuZTANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMDEwNTA5MjMxOTIyWhcNMjEwNTA5MjMyODEzWjBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDzXfqAZ9Rap6kMLJAg0DUIPHWEzbcHiZyJ2t7Ow2D6kWhanpRxKRh2fMLgyCV2lA5Y+gQ0Nubfr/eAuulYCyuT5Z0F43cikfc0ZDwikR1e4QmQvBT+/HVYGeF5tweSo66IWQjYnwfKA1j8aCltMtfSqMtL/OELSDJP5uu4rU/kXG8TlJnbldV126gat5SRtHdb9UgMj2p5fRRwBH1tr5D12nDYR7e/my9s5wW34RFgrHmRFHzF1qbk4X7Vw37lktI8ALU2gt554W3ztW74nzPJy1J9c5g224uha6KVl5uj3sJNJv8GlmclBsjnrOTuEjOVMZnINQhONMp5U9W1vmMyWUA2wKVOBE0921sHM+RYv+8/U2TYQlk1V/0PRXwkBE2e1jh0EZcikM5oRHSSb9VLb7CG48c2QqDQ/MHAWvmjYbkwR3GWChawkcBCle8Qfyhq4yofseTNAz93cQTHIPxJDx1FiKTXy36IrY4t7EXbxFEEySr87IaemhGXW97OU4jm4rf9rJXCKEDb7wSQ34EzOdmyRaUjhwalVYkxuwYtYA5BGH0fLrWXyxHrFdUkpZTvFRSJ/Utz+jJb/NEzAPlZYnAHMuouq0Ate8rdIWcbMJmPFqojqEHRsG4RmzbE3kB0nOFYZcFgHnpbOMiPuwQmfNQWQOW2a2yqhv0Av87BNQIDAQABo1EwTzALBgNVHQ8EBAMCAcYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUDqyCYEBWJ5flJRP8KuEKU5VZ5KQwEAYJKwYBBAGCNxUBBAMCAQAwDQYJKoZIhvcNAQEFBQADggIBAMURTQM6YN1dUhF3j7K7NsiyBb+0t6jYIJ1cEwO2HCL6BhM1tshj1JpHbyZX0lXxBLEmX9apUGigvNK4bszD6azfGc14rFl0rGY0NsQbPmw4TDMOMBINoyb+UVMA/69aToQNDx/kbQUuToVLjWwzb1TSZKu/UK99ejmgN+1jAw/8EwbOFjbUVDuVG1FiOuVNF9QFOZKaJ6hbqr3su77jIIlgcWxWs6UT0G0OI36VA+1oPfLYY7hrTbboMLXhypRL96KqXZkwsj2nwlFsKCABJCcrSwC3nRFrcL6yEIK8DJto0I07JIeqmShynTNfWZC99d6TnjpiWjQ54ohVHbkGsMGJay3XacMZEjaE0Mmg2v8vaXiy5Xra69cMwPe9Yxe4ORM4ojZbe/KFVmodZGLBOOKqv1FmopT1EpxmIhBr8rcwki3yKfA9OxRDaKLxnCk3y844ICVtfGfzfiQSJAMIgUfspZ6X9RjXz7vV73aW7/3O21adlaBC+ZdY4dcxItNfWeY+biIA6kOEtiXb2fMIVmjAZGsdfOy2k6JiV24u2OdYj8QxSSbd3ik1h/UwcXBbFDxpvYkSfesuo/7Yf56CWlIKK8FDK9kwiJ/IEPuJjeahhXUzfmye23MTZGJppS99ypZtn/gETTCSPW4hFCHJPeDD/YprnUr90aGdmUN3P7DaMIIE3jCCA8agAwIBAgITMwAAAPr+Xnt2AOhChgAAAAAA+jANBgkqhkiG9w0BAQUFADB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EwHhcNMTgwODIzMjAyMDA4WhcNMTkxMTIzMjAyMDA4WjCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOjk4RkQtQzYxRS1FNjQxMSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzwcAGQJX1ai/xcQS8o1UJGIXvx/LmhIK4BHeev3tvaQXCkGhvB3/lZjUpzsT8ROFSbPqDJXGBORDiD3sD2B7rveRS+VjZ1zdfwI/KcNPmzAYjq9qxaroRe8xJo3iHzY33dgCvRTrIiUVRAO4ewUEdXKhemEM9Y0/+Auy5J5xn/LySSjLpm39Mqm54oWr8di8cNxc2ctoWpDXFhs09PHghvYvDUTCsANn8b+9M4C8PzUPzqBev1FWwiJcWFZN5/r8V5f67Gw3N4cTqzy/yIKXB6W9xpJ4OpO0IXBSlNTUyElqXEiYrwu/uMZSzGLpyTAwT4coVXr48oDM3VlaF4loGwIDAQABo4IBCTCCAQUwHQYDVR0OBBYEFGffDVHzuflzYlNd4GaI1GFWR1dKMB8GA1UdIwQYMBaAFCM0+NlSRnAK7UD7dvuzK7DDNbMPMFQGA1UdHwRNMEswSaBHoEWGQ2h0dHA6Ly9jcmwubWljcm9zb2Z0LmNvbS9wa2kvY3JsL3Byb2R1Y3RzL01pY3Jvc29mdFRpbWVTdGFtcFBDQS5jcmwwWAYIKwYBBQUHAQEETDBKMEgGCCsGAQUFBzAChjxodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFRpbWVTdGFtcFBDQS5jcnQwEwYDVR0lBAwwCgYIKwYBBQUHAwgwDQYJKoZIhvcNAQEFBQADggEBACbUXkej3SanMKMw+xl2/cC8upmwcv1e9VUP/po7Xo0l0Zbx6q4SRbxjPKK/YF8GmeUD3dsrGw5tcH+BgXQ/2x7LVo0aioR1gtA1rfl7OjfXw1mqYHTvIidpKnFyc3gWVG8zIL+XNqSLUWP3G07xNqtuNGBYLjoy1ozdx2ZaBx5IFNEaDxdvkf6/esikvhSgLe8cK9Ko+T6XPGuK/qEvldA/gB28MU7sFMHGFxkq5ZsiYd6lReJfsj8r9ZCJnNjcNxs0VNO8+RD5X1bQEAC2fH+ZjcuDUead080pI0Gh7P4RHKT//MhhbXf6evSyUeg4VacwIB+9L0E6k55CXiHgb9w=MIIGBzCCA++gAwIBAgIKYRZoNAAAAAAAHDANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMDcwNDAzMTI1MzA5WhcNMjEwNDAzMTMwMzA5WjB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCfoWyx39tIkip8ay4Z4b3i48WZUSNQrc7dGE4kD+7Rp9FMrXQwIBHrB9VUlRVJlBtCkq6YXDAm2gBr6Hu97IkHD/cOBJjwicwfyzMkh53y9GccLPx754gd6udOo6HBI1PKjfpFzwnQXq/QsEIEovmmbJNn1yjcRlOwhtDlKEYuJ6yGT1VSDOQDLPtqkJAwbofzWTCd+n7Wl7PoIZd++NIT8wi3U21StEWQn0gASkdmEScpZqiX5NMGgUqi+YSnEUcUCYKfhO1VeP4Bmh1QCIUAEDBG7bfeI0a7xC1Un68eeEExd8yb3zuDk6FhArUdDbH895uyAc4iS1T/+QXDwiALAgMBAAGjggGrMIIBpzAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBQjNPjZUkZwCu1A+3b7syuwwzWzDzALBgNVHQ8EBAMCAYYwEAYJKwYBBAGCNxUBBAMCAQAwgZgGA1UdIwSBkDCBjYAUDqyCYEBWJ5flJRP8KuEKU5VZ5KShY6RhMF8xEzARBgoJkiaJk/IsZAEZFgNjb20xGTAXBgoJkiaJk/IsZAEZFgltaWNyb3NvZnQxLTArBgNVBAMTJE1pY3Jvc29mdCBSb290IENlcnRpZmljYXRlIEF1dGhvcml0eYIQea0WoUqgpa1Mc1j0BxMuZTBQBgNVHR8ESTBHMEWgQ6BBhj9odHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9taWNyb3NvZnRyb290Y2VydC5jcmwwVAYIKwYBBQUHAQEESDBGMEQGCCsGAQUFBzAChjhodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFJvb3RDZXJ0LmNydDATBgNVHSUEDDAKBggrBgEFBQcDCDANBgkqhkiG9w0BAQUFAAOCAgEAEJeKw1wDRDbd6bStd9vOeVFNAbEudHFbbQwTq86+e4+4LtQSooxtYrhXAstOIBNQmd16QOJXu69YmhzhHQGGrLt48ovQ7DsB7uK+jwoFyI1I4vBTFd1Pq5Lk541q1YDB5pTyBi+FA+mRKiQicPv2/OR4mS4N9wficLwYTp2OawpylbihOZxnLcVRDupiXD8WmIsgP+IHGjL5zDFKdjE9K3ILyOpwPf+FChPfwgphjvDXuBfrTot/xTUrXqO/67x9C0J71FNyIe4wyrt4ZVxbARcKFA7S2hSY9Ty5ZlizLS/n+YWGzFFW6J1wlGysOUzU9nm/qhh6YinvopspNAZ3GmLJPR5tH4LwC8csu89Ds+X57H2146SodDW4TsVxIxImdgs8UoxxWkZDFLyzs7BNZ8ifQv+AeSGAnhUwZuhCEl4ayJ4iIdBD6Svpu/RIzCzU2DKATCYqSCRfWupW76bemZ3KOm+9gSd0BhHudiG/m4LBJ1S2sWo9iaF2YbRuoROmv6pH8BJv/YoybLL+31HIjCPJZr2dHYcSZAI9La9Zj7jkIeW1sMpjtHhUBdRBLlCslLCleKuzoJZ1GtmShxN1Ii8yqAhuoFuMJb+g74TKIdbrHk/Jmu5J4PcBZW+JC33Iacjmbuqnl84xKf8OxVtc2E0bodj6L54/LlUWa8kTo/0=MIIR+AYJKoZIhvcNAQcCoIIR6TCCEeUCAQMxCzAJBgUrDgMCGgUAMIIBEwYJKoZIhvcNAQcBoIIBBASCAQCIyOVtNE76YUMueZzpeRMFxg1q+NZMdibRFogX2GMirLirWO6GsQOZFeznwqztB1iAI2AQXsNl2NJWFfLKaZb6MKU07D0AKxpQyW/JoZD40M8x55099zsKuwxmwNqNvO3QSCgVWSyXk+pbcgA8p7Za4h6LoOOiLAfR/sA1tTkzvT6vYjnJA4qGWJgIUjvVM5XTAhd7KTGywGGiH6NSqranfHPi+fYmWgjAGoijWh0ELJLTkrsqOirEVS6qmkvilY4lCBfZye7oysOZ3d6e4a8Y7b32lWWPwlrt5+S3J/f7YMYAiEFwRUgN7xd4wkMwkbZtQ6Q/3FNViHCp51dxblNAoIIOoTCCBN4wggPGoAMCAQICEzMAAAD6/l57dgDoQoYAAAAAAPowDQYJKoZIhvcNAQEFBQAwdzELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEhMB8GA1UEAxMYTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBMB4XDTE4MDgyMzIwMjAwOFoXDTE5MTEyMzIwMjAwOFowgc4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xKTAnBgNVBAsTIE1pY3Jvc29mdCBPcGVyYXRpb25zIFB1ZXJ0byBSaWNvMSYwJAYDVQQLEx1UaGFsZXMgVFNTIEVTTjo5OEZELUM2MUUtRTY0MTElMCMGA1UEAxMcTWljcm9zb2Z0IFRpbWUtU3RhbXAgU2VydmljZTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAM8HABkCV9Wov8XEEvKNVCRiF78fy5oSCuAR3nr97b2kFwpBobwd/5WY1Kc7E/EThUmz6gyVxgTkQ4g97A9ge673kUvlY2dc3X8CPynDT5swGI6vasWq6EXvMSaN4h82N93YAr0U6yIlFUQDuHsFBHVyoXphDPWNP/gLsuSecZ/y8kkoy6Zt/TKpueKFq/HYvHDcXNnLaFqQ1xYbNPTx4Ib2Lw1EwrADZ/G/vTOAvD81D86gXr9RVsIiXFhWTef6/FeX+uxsNzeHE6s8v8iClwelvcaSeDqTtCFwUpTU1MhJalxImK8Lv7jGUsxi6ckwME+HKFV6+PKAzN1ZWheJaBsCAwEAAaOCAQkwggEFMB0GA1UdDgQWBBRn3w1R87n5c2JTXeBmiNRhVkdXSjAfBgNVHSMEGDAWgBQjNPjZUkZwCu1A+3b7syuwwzWzDzBUBgNVHR8ETTBLMEmgR6BFhkNodHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9NaWNyb3NvZnRUaW1lU3RhbXBQQ0EuY3JsMFgGCCsGAQUFBwEBBEwwSjBIBggrBgEFBQcwAoY8aHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraS9jZXJ0cy9NaWNyb3NvZnRUaW1lU3RhbXBQQ0EuY3J0MBMGA1UdJQQMMAoGCCsGAQUFBwMIMA0GCSqGSIb3DQEBBQUAA4IBAQAm1F5Ho90mpzCjMPsZdv3AvLqZsHL9XvVVD/6aO16NJdGW8equEkW8Yzyiv2BfBpnlA93bKxsObXB/gYF0P9sey1aNGoqEdYLQNa35ezo318NZqmB07yInaSpxcnN4FlRvMyC/lzaki1Fj9xtO8TarbjRgWC46MtaM3cdmWgceSBTRGg8Xb5H+v3rIpL4UoC3vHCvSqPk+lzxriv6hL5XQP4AdvDFO7BTBxhcZKuWbImHepUXiX7I/K/WQiZzY3DcbNFTTvPkQ+V9W0BAAtnx/mY3Lg1HmndPNKSNBoez+ERyk//zIYW13+nr0slHoOFWnMCAfvS9BOpOeQl4h4G/cMIIGBzCCA++gAwIBAgIKYRZoNAAAAAAAHDANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMDcwNDAzMTI1MzA5WhcNMjEwNDAzMTMwMzA5WjB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCfoWyx39tIkip8ay4Z4b3i48WZUSNQrc7dGE4kD+7Rp9FMrXQwIBHrB9VUlRVJlBtCkq6YXDAm2gBr6Hu97IkHD/cOBJjwicwfyzMkh53y9GccLPx754gd6udOo6HBI1PKjfpFzwnQXq/QsEIEovmmbJNn1yjcRlOwhtDlKEYuJ6yGT1VSDOQDLPtqkJAwbofzWTCd+n7Wl7PoIZd++NIT8wi3U21StEWQn0gASkdmEScpZqiX5NMGgUqi+YSnEUcUCYKfhO1VeP4Bmh1QCIUAEDBG7bfeI0a7xC1Un68eeEExd8yb3zuDk6FhArUdDbH895uyAc4iS1T/+QXDwiALAgMBAAGjggGrMIIBpzAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBQjNPjZUkZwCu1A+3b7syuwwzWzDzALBgNVHQ8EBAMCAYYwEAYJKwYBBAGCNxUBBAMCAQAwgZgGA1UdIwSBkDCBjYAUDqyCYEBWJ5flJRP8KuEKU5VZ5KShY6RhMF8xEzARBgoJkiaJk/IsZAEZFgNjb20xGTAXBgoJkiaJk/IsZAEZFgltaWNyb3NvZnQxLTArBgNVBAMTJE1pY3Jvc29mdCBSb290IENlcnRpZmljYXRlIEF1dGhvcml0eYIQea0WoUqgpa1Mc1j0BxMuZTBQBgNVHR8ESTBHMEWgQ6BBhj9odHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9taWNyb3NvZnRyb290Y2VydC5jcmwwVAYIKwYBBQUHAQEESDBGMEQGCCsGAQUFBzAChjhodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFJvb3RDZXJ0LmNydDATBgNVHSUEDDAKBggrBgEFBQcDCDANBgkqhkiG9w0BAQUFAAOCAgEAEJeKw1wDRDbd6bStd9vOeVFNAbEudHFbbQwTq86+e4+4LtQSooxtYrhXAstOIBNQmd16QOJXu69YmhzhHQGGrLt48ovQ7DsB7uK+jwoFyI1I4vBTFd1Pq5Lk541q1YDB5pTyBi+FA+mRKiQicPv2/OR4mS4N9wficLwYTp2OawpylbihOZxnLcVRDupiXD8WmIsgP+IHGjL5zDFKdjE9K3ILyOpwPf+FChPfwgphjvDXuBfrTot/xTUrXqO/67x9C0J71FNyIe4wyrt4ZVxbARcKFA7S2hSY9Ty5ZlizLS/n+YWGzFFW6J1wlGysOUzU9nm/qhh6YinvopspNAZ3GmLJPR5tH4LwC8csu89Ds+X57H2146SodDW4TsVxIxImdgs8UoxxWkZDFLyzs7BNZ8ifQv+AeSGAnhUwZuhCEl4ayJ4iIdBD6Svpu/RIzCzU2DKATCYqSCRfWupW76bemZ3KOm+9gSd0BhHudiG/m4LBJ1S2sWo9iaF2YbRuoROmv6pH8BJv/YoybLL+31HIjCPJZr2dHYcSZAI9La9Zj7jkIeW1sMpjtHhUBdRBLlCslLCleKuzoJZ1GtmShxN1Ii8yqAhuoFuMJb+g74TKIdbrHk/Jmu5J4PcBZW+JC33Iacjmbuqnl84xKf8OxVtc2E0bodj6L54/LlUWa8kTo/2hggOwMIICmAIBATCB/qGB1KSB0TCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOjk4RkQtQzYxRS1FNjQxMSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNloiUKAQEwCQYFKw4DAhoFAAMVAAzqjdgApH6kf6eXPwihNVRvwjGwoIHeMIHbpIHYMIHVMQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSkwJwYDVQQLEyBNaWNyb3NvZnQgT3BlcmF0aW9ucyBQdWVydG8gUmljbzEnMCUGA1UECxMebkNpcGhlciBOVFMgRVNOOjRERTktMEM1RS0zRTA5MSswKQYDVQQDEyJNaWNyb3NvZnQgVGltZSBTb3VyY2UgTWFzdGVyIENsb2NrMA0GCSqGSIb3DQEBBQUAAgUA4BAcVjAiGA8yMDE5MDIxNTAwNTY1NFoYDzIwMTkwMjE2MDA1NjU0WjB3MD0GCisGAQQBhFkKBAExLzAtMAoCBQDgEBxWAgEAMAoCAQACAgC7AgH/MAcCAQACAhdKMAoCBQDgEW3WAgEAMDYGCisGAQQBhFkKBAIxKDAmMAwGCisGAQQBhFkKAwGgCjAIAgEAAgMW42ChCjAIAgEAAgMHoSAwDQYJKoZIhvcNAQEFBQADggEBAIA/9W4gRZDzBgwMjvHcy6Rm4MWfJQZzRV/XoZC9aGa/EhP/KWG6EwjetEIec1Qn6eRckgNJqvf40NLnzJKUD3ft6X3G01V7uEIVPBTHwkKQM52+NUJSQT+5+nAea1nJWUq79yxjDmwt5TSFEhxdwiUfY5dSwheBLiy6EQohWw895vIBMzfSNyBiSk6aftIc7C0zVKReX0Ee75NNu7EPh3/aLHX1c0hGyU9Nm23uftZMXt89X8VI40IL42/TPQoIv1RTPHptXCzWwZAotBH48xTYYiCR3duR8cTraR6d661gDs/cVt7lPUqSAQ9xVuJttzFg1T6jAHTdPe14BV93sa0xggIVMIICEQIBATCBjjB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0ECEzMAAAD6/l57dgDoQoYAAAAAAPowCQYFKw4DAhoFAKBdMBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE5MDIxNDIxMDkyNlowIwYJKoZIhvcNAQkEMRYEFD+Lm6+gG72Jvsu1jyVfdCZYRkgoMA0GCSqGSIb3DQEBBQUABIIBAGAjL6u4FXyvW5aF7DqMt+rltxVaHfd8Etvn3yQHSQtg8mbEcQCYtSycF1cAssz5WHwxGZm6jkRJWLZyy6JNvKtw4NgOUXBrvEsPce9iYrHAxvtzsPcJyqQUAm7F+ImDHgDN6Rj7TZ8sa/RtMxenBEp/XB3MIQYQRfEuurUyKbWlce8Wtw1b/XowWerteRHslglOillLWfZhGdYAr5EgnlEUH3gray/1j6sCGaEHRZZ5FBnAiQnlapFTcRZWJKB06fi8Rca6JnYeD01F0YY0oAUBnKosMtO9lllxG1axhOCKnNoZQTrkZ7JS4ha7oEHI6F3VG0fWgIe9q9Kltt5fNOY= diff --git a/packages/FAKE.5.16.0/tools/NuGet.Packaging.dll b/packages/FAKE.5.16.0/tools/NuGet.Packaging.dll new file mode 100644 index 0000000..96df47e Binary files /dev/null and b/packages/FAKE.5.16.0/tools/NuGet.Packaging.dll differ diff --git a/packages/FAKE.5.16.0/tools/NuGet.Packaging.xml b/packages/FAKE.5.16.0/tools/NuGet.Packaging.xml new file mode 100644 index 0000000..8bba07d --- /dev/null +++ b/packages/FAKE.5.16.0/tools/NuGet.Packaging.xml @@ -0,0 +1,5462 @@ + + + + NuGet.Packaging + + + + + An internal NuGetFramework marker for ManagedCodeConventions. + Most conventions disallow the string 'any' as a txm, so to allow + it for conventions with no txm in the path we use this special type. + + + + + Defines all the package conventions used by Managed Code packages + + + + + Pattern used to locate all files targetted at a specific runtime and/or framework + + + + + Pattern used to locate all files designed for loading as managed code assemblies at run-time + + + + + Pattern used to locate ref assemblies for compile. + + + + + Pattern used to locate lib assemblies for compile. + + + + + Pattern used to locate all files designed for loading as native code libraries at run-time + + + + + Pattern used to locate all files designed for loading as managed code resource assemblies at run-time + + + + + Pattern used to identify MSBuild targets and props files + + + + + Pattern used to identify MSBuild global targets and props files + + + + + Pattern used to identify content files + + + + + Pattern used to identify Tools assets for global tools + + + + + True if lib/contract exists + + + + + False if the path would not match any patterns. + + + + + Defines a property that can be used in Content Model query patterns + + + + + + Find the nearest compatible candidate. + + + + + A set of patterns that can be used to query a set of file paths for items matching a provided criteria. + + + + + Patterns used to select a group of items that matches the criteria + + + + + Pattern expressions. + + + + + Patterns used to select individual items that match the criteria + + + + + Path expressions. + + + + + Property definitions used for matching patterns + + + + + A pattern that can be used to match file paths given a provided criteria. + + + The pattern is defined as a sequence of literal path strings that must match exactly and property + references, + wrapped in {} characters, which are tested for compatibility with the consumer-provided criteria. + + + + + + Replacement token table. + + + + + Replacement token table organized by property. + + + + + Lookup a token and get the replacement if it exists. + + Property moniker + Token name + Replacement value + + + + PropertyName moniker + + + + + Item name + + + + + Item replacement value + + + + + An asynchronous package content reader. + + + + + Asynchronously returns all framework references found in the nuspec. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is cancelled. + + + + Asynchronously returns all items under the build folder. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is cancelled. + + + + Asynchronously returns all items under the tools folder. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is cancelled. + + + + Asynchronously returns all items found in the content folder. + + + Some legacy behavior has been dropped here due to the mix of content folders and target framework + folders here. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is cancelled. + + + + Asynchronously returns all lib items without any filtering. + + Use GetReferenceItemsAsync(...) for the filtered list. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is cancelled. + + + + Asynchronously returns lib items + filtering based on the nuspec and other NuGet rules. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is cancelled. + + + + Asynchronously returns package dependencies. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is cancelled. + + + + A development package nuspec reader + + + + + The locale ID for the package, such as en-us. + + + + + Returns all framework references found in the nuspec. + + + + + Returns all items under the build folder. + + + + + Returns all items under the tools folder. + + + + + Returns all items found in the content folder. + + + Some legacy behavior has been dropped here due to the mix of content folders and target framework + folders here. + + + + + Returns all lib items without any filtering. Use GetReferenceItems for the filtered list. + + + + + Returns lib items + filtering based on the nuspec and other NuGet rules. + + + + + Returns package dependencies. + + + + + A package downloader. + + + + + Gets an asynchronous package content reader. + + Thrown if this object is disposed. + + + + Gets an asynchronous package core reader. + + Thrown if this object is disposed. + + + + Asynchronously copies a .nupkg to a target file path. + + The destination file path. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a + indicating whether or not the copy was successful. + Thrown if this object is disposed. + Thrown if + is either null or empty. + Thrown if + is cancelled. + + + + Asynchronously gets a package hash. + + The hash algorithm. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a + representing the package hash. + Thrown if this object is disposed. + Thrown if + is either null or empty. + Thrown if + is cancelled. + + + + Sets an exception handler for package downloads. + + The exception handler returns a task that represents the asynchronous operation. + The task result () returns a + indicating whether or not the exception was handled. To handle an exception and stop its + propagation, the task should return true. Otherwise, the exception will be rethrown. + An exception handler. + Thrown if + is null. + + + + Sets a throttle for package downloads. + + A throttle. Can be null. + + + + Core package resolver + + + + + Resolve a set of packages + + Package or packages to install + All relevant packages. This list must include the target packages. + A set of packages meeting the package dependency requirements + + + + Resolve a set of packages + + Package or packages to install + + All relevant packages. This list must include the target packages and + installed packages. + + + Packages already installed into the project. These will be favored as + dependency options. + + A set of packages meeting the package dependency requirements + + + + Resolve a set of packages + + Package or packages to install + All relevant packages. This list must include the target packages. + A set of packages meeting the package dependency requirements + + + + Resolve a set of packages + + Package or packages to install + + All relevant packages. This list must include the target packages and + installed packages. + + + Packages already installed into the project. These will be favored as + dependency options. + + A set of packages meeting the package dependency requirements + + + + Custom exception type for a package that has a higher minClientVersion than the current client. + + + + + Path resolver for the root package folder containing this package. + + + + + Package id. + + + + + Package version. + + + + + Creates a package folder path resolver that scans multiple folders to find a package. + + NuGet paths loaded from NuGet.Config settings. + + + + Returns the root directory of an installed package. + + Package id. + Package version. + Returns the path if the package exists in any of the folders. Null if the package does not exist. + + + + Returns the root directory of an installed package. + + Package id. + Package version. + Returns the path if the package exists in any of the folders. Null if the package does not exist. + + + + Returns the package info along with a path resolver specific to the folder where the package exists. + + Package id. + Package version. + Returns the package info if the package exists in any of the folders. Null if the package does not exist. + + + + Provides incremental hashing. + + This is non-private only to facilitate unit testing. + + + + + Gets the hash. + + Once GetHash is called, no further hash updates are allowed. + + A base64-encoded hash. + + + + Incrementally updates the hash. + + The data to be included in the hash. + The offset from which data should be read. + The count of bytes to read. + + + + Represents a token of a parsed license expression. The tokens are either operators, parentheses or values. + + + + + The token type + + + + + The value of this token. + + + + + A tokenizer for a license expression. + This implementation assumes that the input has been sanitized and that there are no invalid characters. + + value to be tokenized + If the string is null or whitespace. + + + + The valid characters for a license identifier are a-zA-Z0-9.-+ + The valid characters for a license expression are the above whitespace and (). + + Whether the value has valid characters. + + + + Given a string, tokenizes by space into operators and values. The considered operators are, AND, OR, WITH, (, and ). + + tokens, /> + + + + Parses a token type given a string. + This method assumes that the brackets have been parsed out. + + The token + A parsed token, operator or value. + This method assumes the brackets have already been parsed. + + + + Represents the expression type of a . + License type means that it's a . Operator means that it's a + + + + + A NuGetLicenseOperator. The operator options are: WITH or Logical operator, AND and OR. + This is an abstract class so based on the NuGetLicenseOperatorType, it can be either a or a . + + + + + The operator type. + LogicalOperator means it's AND or OR and + NuGetLicenseWithOperator means it's the WITH operator and + + + + + Represents the type of . + + + + + The valid token types in a license expression. These are ordered by priority, be aware when changing them. See + + + + + A Logical Operator NuGetLicenseExpression. + It is either an OR or an AND operator, represented by . + This operator will always have a left and a right side, both of which are and never null. + + + + + Represents the logical operator type of NuGetLicenseExpression. + + + + + Represents the logical operator type of a . + + + + + NuGet's internal representation of a license identifier. + + + + + Identifier + + + + + Signifies whether the plus operator has been specified on this license + + + + + Signifies whether this is a standard license known by the NuGet APIs. + Pack for example should warn for these. + + + + + Parse a licenseIdentifier. If a licenseIdentifier is deprecated, this will throw. Non-standard licenses get parsed into a object model as well. + + license identifier to be parsed + Whether the parser allows the UNLICENSED identifier + Prased NuGetLicense object + If the identifier is deprecated, contains invalid characters or is an exception identifier. + If it's null or empty. + The purpose of the switch is to allow the expression parser communicate at which operand location the unlicensed identifier is legal. + + + + The valid characters for a license identifier are a-zA-Z0-9.- + This method assumes that the trailing + operator has been stripped out. + + The value to be validated. + whether the value has valid characters + + + + NuGet's internal representation of a license exception identifier. + + + + + The Exception's identifier + + + + + Parse an exceptionIdentifier. If the exceptionIdentifier is deprecated, this will throw. Non-standard exception do not get parsed into an object model. + + Exception identifier to be parsed. + Parsed License Exception + If the identifier is deprecated, is a license or simply does not exist. + If it's null or empty. + + + + Represents a parsed NuGetLicenseExpression. + This is an abstract class so based on the Type, it can be either a or a . + + + + + + The type of the NuGetLicenseExpression. + License type means that it's a . + Operator means that it's a + + + + + Parses a License Expression if valid. + The expression would be parsed correct, even if non-standard exceptions are encountered. + The non-standard Licenses/Exceptions have metadata on them with which the caller can make decisions. + + The expression to be parsed. + Parsed NuGet License Expression model. + If the expression is empty or null. + If the expression has invalid characters + If the expression itself is invalid. Example: MIT OR OR Apache-2.0, or the MIT or Apache-2.0, because the expressions are case sensitive. + If the expression's brackets are mismatched. + If the licenseIdentifier is deprecated. + If the exception identifier is deprecated. + + + + Determines whether all the licenses and exceptions are not deprecated. + + expression to be validated + Whether this expression consists of licenses with standard identifiers + + + + A leaf node in an expression can only be a License or an Exception. Run a func on each one. + + The expression to be walked. + A processor for the licenses. + A processor for the exceptions. + + + + Parses a License Expression if valid. + The expression would be parsed correct, even if non-standard exceptions are encountered. The non-standard Licenses/Exceptions have metadata on them with which the caller can make decisions. + Based on the Shunting Yard algorithm. + This method first creates an postfix expression by separating the operators and operands. + Later the postfix expression is evaluated into an object model that represents the expression. Note that brackets are dropped in this conversion and this is not round-trippable. + The token precedence helps make sure that the expression is a valid infix one. + + The expression to be parsed. + Parsed NuGet License Expression model. + If the expression is empty or null. + If the expression has invalid characters + If the expression itself is invalid. Example: MIT OR OR Apache-2.0, or the MIT or Apache-2.0, because the expressions are case sensitive. + If the expression's brackets are mismatched. + If the licenseIdentifier is deprecated. + If the exception identifier is deprecated. + + + + Tokenizes the expression as per the license expression rules. Throws if the string contains invalid characters. + + + + + Represents a that's a WITH operator. + It has a License and Exception. + + + + + The license. + + + + + The exception. + + + + + A package downloader for local archive packages. + + + + + Gets an asynchronous package content reader. + + Thrown if this object is disposed. + + + + Gets an asynchronous package core reader. + + Thrown if this object is disposed. + + + + Initializes a new class. + + A package source. + A source package archive file path. + A package identity. + A logger. + Thrown if + is either null or an empty string. + Thrown if + is either null or an empty string. + Thrown if + is either null or an empty string. + + + + Disposes of this instance. + + + + + Asynchronously copies a .nupkg to a target file path. + + The destination file path. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a + indicating whether or not the copy was successful. + Thrown if this object is disposed. + Thrown if + is either null or empty. + Thrown if + is cancelled. + + + + Asynchronously gets a package hash. + + The hash algorithm. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a + representing the package hash. + Thrown if this object is disposed. + Thrown if + is either null or empty. + Thrown if + is cancelled. + + + + Sets an exception handler for package downloads. + + The exception handler returns a task that represents the asynchronous operation. + The task result () returns a + indicating whether or not the exception was handled. To handle an exception and stop its + propagation, the task should return true. Otherwise, the exception will be rethrown. + An exception handler. + Thrown if + is null. + + + + Sets a throttle for package downloads. + + A throttle. Can be null. + + + + Helpers for dealing with the NuGet client version and package minClientVersions. + + + + + Check the package minClientVersion and throw if it is greater than the current client version. + + + + + Verify minClientVersion. + + + + + Verify minClientVersion. + + + + + Read the NuGet client version from the assembly info as a NuGetVersion. + + + + + Reads .nuspec files + + + + + Nuspec file reader. + + + + + Nuspec file reader. + + + + + Nuspec file reader + + Nuspec file stream. + + + + Nuspec file reader + + Nuspec file xml data. + + + + Nuspec file reader + + Nuspec file stream. + Framework mapping provider for NuGetFramework parsing. + + + + Nuspec file reader + + Nuspec file xml data. + Framework mapping provider for NuGetFramework parsing. + + + + Read package dependencies for all frameworks + + + + + Read package dependencies for all frameworks + + + + + Reference item groups + + + + + Framework reference groups + + + + + Package language + + + + + Package License Url + + + + + Build action groups + + + + + Package title. + + + + + Package authors. + + + + + Package tags. + + + + + Package owners. + + + + + Package description. + + + + + Package release notes. + + + + + Package summary. + + + + + Package project url. + + + + + Package icon url. + + + + + Copyright information. + + + + + Source control repository information. + + + + + Parses the license object if specified. + The metadata can be of 2 types, Expression and File. + The method will not fail if it sees values that invalid (empty/unparseable license etc), but it will rather add validation errors/warnings. + + This method never throws. Bad data is still parsed. + The licensemetadata if specified + + + + Require license acceptance when installing the package. + + + + + Reads a development nupkg + + + + + Signature specifications. + + + + + Stream underlying the ZipArchive. Used to do signature verification on a SignedPackageArchive. + If this is null then we cannot perform signature verification. + + + + + Nupkg package reader + + Nupkg data stream. + + + + Nupkg package reader + + Nupkg data stream. + Framework mapping provider for NuGetFramework parsing. + Framework compatibility provider. + + + + Nupkg package reader + + Nupkg data stream. + If true the nupkg stream will not be closed by the zip reader. + + + + Nupkg package reader + + Nupkg data stream. + leave nupkg stream open + Framework mapping provider for NuGetFramework parsing. + Framework compatibility provider. + + + + Nupkg package reader + + ZipArchive containing the nupkg data. + + + + Nupkg package reader + + ZipArchive containing the nupkg data. + Framework mapping provider for NuGetFramework parsing. + Framework compatibility provider. + + + + Validate all files in package are not traversed outside of the expected extraction path. + Eg: file entry like ../../foo.dll can get outside of the expected extraction path. + + + + + Represents an empty framework folder in NuGet 2.0+ packages. + An empty framework folder is represented by a file named "_._". + + + + + Gets the full path of the file inside the package. + + + + + Gets the path that excludes the root folder (content/lib/tools) and framework folder (if present). + + + If a package has the Path as 'content\[net40]\scripts\jQuery.js', the EffectivePath + will be 'scripts\jQuery.js'. + + If it is 'tools\init.ps1', the EffectivePath will be 'init.ps1'. + + + + + Specifies assemblies from GAC that the package depends on. + + + + + Returns sets of References specified in the manifest. + + + + + Specifies sets other packages that the package depends on. + + + + + Returns sets of Content Files specified in the manifest. + + + + + Represents the Package LicenseMetadata details. + All the relevant warnings and errors should parsed into this model and ideally the readers of this metadata never throw. + + + + + The LicenseType, never null + + + + + The license, never null, could be empty. + + + + + The license expression, could be null if the version is higher than the current supported or if the expression is not parseable. + + + + + Non-null when the expression parsing yielded some issues. This will be used to display the errors/warnings in the UI. Only populated when the metadata element is returned by the nuspec reader; + + + + + LicenseMetadata (expression) version. Never null. + + + + + Saves the current manifest to the specified stream. + + The target stream. + + + + Saves the current manifest to the specified stream. + + The target stream. + The minimum manifest version that this class must use when saving. + + + + Constructs a ManifestMetadata instance from an IPackageMetadata instance + + + + + Baseline schema + + + + + Added copyrights, references and release notes + + + + + Used if the version is a semantic version. + + + + + Added 'targetFramework' attribute for 'dependency' elements. + Allow framework folders under 'content' and 'tools' folders. + + + + + Added 'targetFramework' attribute for 'references' elements. + Added 'minClientVersion' attribute + + + + + Allows XDT transformation + + + + + Exposes the additional properties extracted by the metadata + extractor or received from the command line. + + + + + ContentFiles section from the manifest for content v2 + + + + + Determins the path of the file inside a package. + For recursive wildcard paths, we preserve the path portion beginning with the wildcard. + For non-recursive wildcard paths, we use the file name from the actual file path on disk. + + + + + Returns true if the path uses a known folder root. + + + + + Tags come in this format. tag1 tag2 tag3 etc.. + + + + + Creates a new Package Reference Set + + IEnumerable set of string references + + + + Creates a new Package Reference Set + + The target framework to use, pass Any for AnyFramework. Does not allow null. + IEnumerable set of string references + + + + Creates a new Package Reference Set + + The target framework to use. + IEnumerable set of string references + + + + Path on disk + + + + + Path in package + + + + + A strongly-typed resource class, for looking up localized strings, etc. + + + + + Returns the cached ResourceManager instance used by this class. + + + + + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + + + + + Looks up a localized string similar to Cannot create a package that has no dependencies nor content.. + + + + + Looks up a localized string similar to Dependency '{0}' has an invalid version.. + + + + + Looks up a localized string similar to '{0}' already has a dependency defined for '{1}'.. + + + + + Looks up a localized string similar to The schema version of '{0}' is incompatible with version {1} of NuGet. Please upgrade NuGet to the latest version from http://go.microsoft.com/fwlink/?LinkId=213942.. + + + + + Looks up a localized string similar to The package ID '{0}' contains invalid characters. Examples of valid package IDs include 'MyPackage' and 'MyPackage.Sample'.. + + + + + Looks up a localized string similar to <dependencies> element must not contain both <group> and <dependency> child elements.. + + + + + Looks up a localized string similar to Exclude path '{0}' contains invalid characters.. + + + + + Looks up a localized string similar to Id must not exceed 100 characters.. + + + + + Looks up a localized string similar to The 'minClientVersion' attribute in the package manifest has invalid value. It must be a valid version string.. + + + + + Looks up a localized string similar to Invalid assembly reference '{0}'. Ensure that a file named '{0}' exists in the lib directory.. + + + + + Looks up a localized string similar to Assembly reference '{0}' contains invalid characters.. + + + + + Looks up a localized string similar to An error occured while trying to parse the value '{0}' of property '{1}' in the manifest file.. + + + + + Looks up a localized string similar to <references> element must not contain both <group> and <reference> child elements.. + + + + + Looks up a localized string similar to The license file '{0}' does not exist in the package.. + + + + + Looks up a localized string similar to The licenseUrl and license elements cannot be used together.. + + + + + Looks up a localized string similar to <references> element must not contain both <group> and <reference> child elements.. + + + + + Looks up a localized string similar to The element package\metadata\references\group must contain at least one <reference> child element.. + + + + + Looks up a localized string similar to The required element '{0}' is missing from the manifest.. + + + + + Looks up a localized string similar to {0} is required.. + + + + + Looks up a localized string similar to Enabling license acceptance requires a license or a licenseUrl to be specified. The licenseUrl will be deprecated, consider using the license metadata.. + + + + + Looks up a localized string similar to Source path '{0}' contains invalid characters.. + + + + + Looks up a localized string similar to Target path '{0}' contains invalid characters.. + + + + + Looks up a localized string similar to {0} cannot be empty.. + + + + + Looks up a localized string similar to File not found: '{0}'.. + + + + + Looks up a localized string similar to Unknown schema version '{0}'.. + + + + + Parses the specified string into FrameworkName object. + + The string to be parse. + if set to true, parse the first folder of path even if it is unrecognized framework. + returns the path after the parsed target framework + + + + + Gets or sets the . + + + + + This property should only be used to override the default verifier on tests. + It is public only so that NuGet.Commands.RestoreRequest can pass this property through + + + + + A package is deemed to be a satellite package if it has a language property set, the id of the package is + of the format [.*].[Language] + and it has at least one dependency with an id that maps to the runtime package . + + + + + This returns all the installed package files (does not include satellite files) + + + + + Default package save mode for v2 (packages.config)-style restore. + This includes and . + + + + + Default package save mode for v3 (project.json)-style restore. + This includes , , and . + + + + + Treat XML doc files as regular files (legacy behavior). + + + + + Do not extract XML documentation files + + + + + Compress XML doc files in a zip archive. + + + + + Nupkg reading helper methods + + + + + Uses a copy function to install a package to a global packages directory. + + + A function which should copy the package to the provided destination stream. + + + The version folder path context, which encapsulates all of the parameters to observe + while installing the package. + + The cancellation token. + + True if the package was installed. False if the package already exists and therefore + resulted in no copy operation. + + + + + Delete the target directory path and the temp nupkg path in case of a failed extraction. + + + + + Reads an unzipped nupkg folder. + + + + + Package folder reader + + + + + Package folder reader + + root directory of an extracted nupkg + + + + Package folder reader + + root directory of an extracted nupkg + framework mappings + framework compatibility provider + + + + Package folder reader + + root directory of an extracted nupkg + framework mappings + framework compatibility provider + + + + Opens a local file in read only mode. + + + + + True if the path does not contain / + + + + + True if the path ends with .nupkg + + + + + Build the relative path in the same format that ZipArchive uses + + + + + A V2 path resolver. + + + + + Abstract class that both the zip and folder package readers extend + This class contains the path conventions for both zip and folder readers + + + + + Instantiates a new class. + + A framework mapping provider. + Thrown if is null. + + + + Instantiates a new class. + + A framework mapping provider. + A framework compatibility provider. + Thrown if is null. + Thrown if is null. + + + + Nuspec reader + + + + + Frameworks mentioned in the package. + + + + + only packageId.targets and packageId.props should be used from the build folder + + + + + True only for assemblies that should be added as references to msbuild projects + + + + + Validate file entry in package is not traversed outside of the expected extraction path. + Eg: file entry like ../../foo.dll can get outside of the expected extraction path. + + + + + Get contenthash for a package. + + + + + Represents a package element in the packages.config file + + + + + Creates a new packages config entry + + + + + Creates a new packages config entry + + + + + Creates a new packages config entry + + + + + Creates a new packages config entry + + Package id and version + Package target framework installed to the project + True if the user installed this package directly + True if the package is a development dependency + True if this package needs to be reinstalled + Restrict package versions to the allowedVersions range + + + + Id and Version of the package + + + + + The allowed range of versions that this package can be upgraded/downgraded to. + + This is null if unbounded + + + + True if allowedVersions exists. + + + + + Installed target framework version of the package. + + + + + Development dependency + + + + + True if the user installed or updated this package directly. + False if this package was installed as a dependency by another package. + + + + + Require reinstallation + + + + + Displays the identity and target framework of the reference. + + + + + + Determine if the package node has the attribute value as the targetValue. + + + + + Get a boolean attribute value, or false if it does not exist + + + + + Reads packages.config + + + + + Packages.config reader + + Packages.config XML + + + + Packages.config reader + + Additional target framework mappings for parsing target frameworks + Packages.config XML + + + + Packages.config reader + + Stream containing packages.config + + + + Packages.config reader + + Stream containing packages.config + True will leave the stream open + + + + Packages.config reader + + Stream containing packages.config + True will leave the stream open + Additional target framework mappings for parsing target frameworks + + + + Reads the minimum client version from packages.config + + Minimum client version or the default of 2.5.0 + + + + Reads all package node entries in the config. + If duplicate package ids exist an exception will be thrown. + + + + + Reads all package node entries in the config. + + If True validation will be performed to ensure that + only one entry exists for each unique package id. + + + + Writes the packages.config XML file to a stream + + + + + Create a packages.config writer using file path + + The full path to write the XML packages.config file into, or load existing packages.config from + Whether to create a new packages.config file, or load an existing one + + + + Create a packages.config writer using file path + + The full path to write the XML packages.config file into, or load existing packages.config from + Whether to create a new packages.config file, or load an existing one + Framework mappings + + + + Create a packages.config writer using stream + + Stream to write the XML packages.config file into, or load existing packages.config from + Whether to create a new packages.config file, or load an existing one + + + + Create a packages.config writer using stream + + Stream to write the XML packages.config file into, or load existing packages.config from + Whether to create a new packages.config file, or load an existing one + Framework mappings + + + + Write a minimum client version to packages.config + + Minumum version of the client required to parse and use this file. + + + + Add a package entry + + Package Id + Package Version + Package targetFramework that's compatible with current project + + + + Adds a basic package entry to the file + + + + + Adds a package entry to the file + + Package reference entry + + + + Update a package entry to the file + + + + + Update a package entry using the original entry as a base if it exists. + + + + + Remove a package entry + + Package Id + Package version + Package targetFramework + + + + Remove a package identity from the file + + Package identity + Package targetFramework + + + + Removes a package entry from the file + + Package reference entry + + + + Write the XDocument to the packages.config and disallow further changes. + + the full path to packages.config file + + + + Write the XDocument to the stream and close it to disallow further changes. + + + + + Represents the ".nuspec" extension. + + + + + A strongly-typed resource class, for looking up localized strings, etc. + + + + + Returns the cached ResourceManager instance used by this class. + + + + + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + + + + + Looks up a localized string similar to The assembly '{0}' is placed directly under 'lib' folder. It is recommended that assemblies be placed inside a framework-specific folder. Move it into a framework-specific folder.. + + + + + Looks up a localized string similar to The assembly '{0}' is not inside the 'lib' folder and hence it won't be added as a reference when the package is installed into a project. Move it into the 'lib' folder if it needs to be referenced.. + + + + + Looks up a localized string similar to The value "{0}" for {1} is a sample value and should be removed. Replace it with an appropriate value or remove it and rebuild your package.. + + + + + Looks up a localized string similar to The file '{0}' path, name, or both are too long. Your package might not work without long file path support. Please shorten the file path or file name.. + + + + + Looks up a localized string similar to The folder '{0}' under 'lib' is not recognized as a valid framework name or a supported culture identifier. Rename it to a valid framework name or culture identifier.. + + + + + Looks up a localized string similar to A stable release of a package should not have a prerelease dependency. Either modify the version spec of dependency "{0}" or update the version field in the nuspec.. + + + + + Looks up a localized string similar to The package version '{0}' uses SemVer 2.0.0 or components of SemVer 1.0.0 that are not supported on legacy clients. Change the package version to a SemVer 1.0.0 string. If the version contains a release label it must start with a letter. This message can be ignored if the package is not intended for older clients.. + + + + + Looks up a localized string similar to The 'licenseUrl' element will be deprecated. Consider using the 'license' element instead.. + + + + + Looks up a localized string similar to The assembly 'lib\{0}' will be ignored when the package is installed after the migration.. + + + + + Looks up a localized string similar to 'content' assets will not be available when the package is installed after the migration.. + + + + + Looks up a localized string similar to install.ps1 script will be ignored when the package is installed after the migration.. + + + + + Looks up a localized string similar to XDT transform file '{0}' will not be applied when the package is installed after the migration.. + + + + + Looks up a localized string similar to The file '{0}' will be ignored by NuGet because it is not directly under 'tools' folder. Place the file directly under 'tools' folder.. + + + + + Looks up a localized string similar to The transform file '{0}' is outside the 'content' folder and hence will not be transformed during installation of this package. Move it into the 'content' folder.. + + + + + Looks up a localized string similar to An empty folder placeholder file '{0}' is in a non-empty folder and should be removed.. + + + + + Looks up a localized string similar to The script file '{0}' is outside the 'tools' folder and hence will not be executed during installation of this package. Move it into the 'tools' folder.. + + + + + Looks up a localized string similar to The license identifier '{0}' is not recognized by the current toolset.. + + + + + Looks up a localized string similar to The script file '{0}' is not recognized by NuGet and hence will not be executed during installation of this package. Rename it to install.ps1, uninstall.ps1 or init.ps1 and place it directly under 'tools'.. + + + + + Looks up a localized string similar to The version of dependency '{0}' is not specified. Specify the version of dependency and rebuild your package.. + + + + + Looks up a localized string similar to The file at '{0}' uses the obsolete 'WinRT' as the framework folder. Replace 'WinRT' or 'WinRT45' with 'NetCore45'.. + + + + + Warn if the version is not parsable by older nuget clients. + + This rule should be removed once more users move to SemVer 2.0.0 capable clients. + + + + Folders that are expected to have .dll and .winmd files + + + + + Folders that are expected to have .dll and .winmd files + + + + + A SHA-512 hash function that supports incremental hashing. + + This is non-private only to facilitate unit testing. + + + + + This class is used to hold metadata about the central directory archive structure + + + + + Position in bytes of the corresponding central directory header relative to the start of the archive + + + + + Offset in bytes to the corresponding file header relative to the start of the archive + + + + + Total size of corresponding file entry in bytes + This should include size of local file header + encryption header + file data + data descriptor + + + + + Flag indicating if the entry is the package signature file + + + + + Size of central directory header, in bytes. + + + + + Value used to identify how much the position of the OffsetToFileHeader property will change by + the presence of a signature file in bytes + + + + + Index in which the central directory record was read from the archive. + This index represents the order of the central directory record as it is in the file. + + + + + Helper to calculate CRC-32 for data. + Derivative of a .NET core implementation - https://source.dot.net/#System.IO.Compression.Tests/Common/System/IO/Compression/CRC.cs + This is public to allow testing. + + + + + Calculates a 32 bit cyclic redundancy code for the input data. + + Byte[] of the data. + 32 bit cyclic redundancy code for the input data in uint. + + + + Read bytes from a BinaryReader and write them to the BinaryWriter and stop when the provided position + is the current position of the BinaryReader's base stream. It does not read the byte in the provided position. + + Read bytes from this stream. + Write bytes to this stream. + Position to stop copying data. + + + + Read bytes from a BinaryReader and hash them with a given HashAlgorithm and stop when the provided position + is the current position of the BinaryReader's base stream. It does not hash the byte in the provided position. + + TODO: Once we start supporting signing in Net core, then we should move to another ReadAndHashUntilPosition api which takes Sha512HashFunction which is wrapper + over HashAlgorithm and works for desktop as well as net core. + + Read bytes from this stream + HashAlgorithm used to hash contents + Position to stop copying data + + + + Hashes given byte array with a specified HashAlgorithm + + TODO: Once we start supporting signing in Net core, then we should move to another HashBytes api which takes Sha512HashFunction which is wrapper + over HashAlgorithm and works for desktop as well as net core. + + HashAlgorithm used to hash contents + Content to hash + + + + Read bytes from a BinaryReader and hash them with a given HashAlgorithm wrapper and stop when the provided position + is the current position of the BinaryReader's base stream. It does not hash the byte in the provided position. + + Read bytes from this stream + HashAlgorithm wrapper used to hash contents cross platform + Position to stop copying data + + + + Hashes given byte array with a specified HashAlgorithm wrapper which works cross platform. + + HashAlgorithm wrapper used to hash contents cross platform + Content to hash + + + + Read ZIP's offsets and positions of offsets. + + binary reader to zip archive + boolean to skip validate signature entry + metadata with offsets and positions for entries + + + + Asserts the validity of central directory header and local file header for the package signature file entry. + + BinaryReader on the package. + Metadata for the package signature file's central directory header. + Thrown if either header is invalid. + + + + Writes the signature data into the zip using the writer. + The reader is used to read the exisiting zip. + + MemoryStream of the signature to be inserted into the zip. + BinaryReader to be used to read the existing zip data. + BinaryWriter to be used to write the signature into the zip. + + + + Writes a local file header into a zip using the writer starting at the writer.BaseStream.Position. + + BinaryWriter to be used to write file. + Byte[] of the corresponding file to be written into the zip. + CRC-32 for the file. + Last modified DateTime for the file data. + Number of total bytes written into the zip. + + + + Writes a file into a zip using the writer starting at the writer.BaseStream.Position. + + BinaryWriter to be used to write file. + Byte[] of the file to be written into the zip. + Number of total bytes written into the zip. + + + + Writes a central directory header into a zip using the writer starting at the writer.BaseStream.Position. + + BinaryWriter to be used to write file. + Byte[] of the file to be written into the zip. + CRC-32 checksum for the file. + Last modified DateTime for the file data. + Offset, in bytes, for the local file header of the corresponding file from the start of the archive. + Number of total bytes written into the zip. + + + + Writes the end of central directory header into a zip using the writer starting at the writer.BaseStream.Position. + The new end of central directory record will be based on the one at reader.BaseStream.Position. + + BinaryReader to be used to read the existing end of central directory record. + BinaryWriter to be used to write the updated end of central directory record. + The change to central directory header counts. + Size of the central directory header for the signature file. + Size of the signature file and the corresponding local file header. + + + + Converts a DateTime value into a unit in the MS-DOS date time format. + Reference - https://docs.microsoft.com/en-us/cpp/c-runtime-library/32-bit-windows-time-date-formats + Reference - https://source.dot.net/#System.IO.Compression/System/IO/Compression/ZipHelper.cs,91 + + DateTime value to be converted. + uint representing the MS-DOS equivalent date time. + + + + This class is used to hold metadata about the signed package archive being verified. + + + + + List of central directory metadata ordered by the same order the central directory headers are in the archive + + + + + Offset, in bytes, to the first file header relative to the start of the archive. Should typically be 0. + + + + + Offset, in bytes, to the end of central directory headers relative to the start of the archive. + + + + + Index of the signature central directory header in CentralDirectoryHeaders. + If the CentralDirectoryHeaders list is ordered by IndexInHeaders this index indicates the position on the list for the signature. + + + + + Utility method to know if a zip archive is signed. + + Binary reader pointing to a zip archive. + true if the given archive is signed + + + + Opens a read-only stream for the package signature file. + + Callers should first verify that a package is signed before calling this method. + A binary reader for a signed package. + A readable stream. + Thrown if is null. + Thrown if a package signature file is invalid or missing. + + + + Removes repository primary signature (if it exists) or any repository countersignature (if it exists). + + A readable stream for a signed package. + A read/write stream for receiving an updated package. + A cancellation token. + A flag indicating whether or not a signature was removed. + + + + Signs a Zip with the contents in the SignatureStream using the writer. + The reader is used to read the exisiting contents for the Zip. + + MemoryStream of the signature to be inserted into the zip. + BinaryReader to be used to read the existing zip data. + BinaryWriter to be used to write the signature into the zip. + + + + Verifies that a signed package archive's signature is valid and it has not been tampered with. + + TODO: When we work to support signing for netcore then we should use GetPackageContentHash api to calculate package hash + which works for desktop as well as netcore. + + Signed package to verify + Hash algorithm to be used to hash data. + Hash value of the original data. + True if package archive's hash matches the expected hash + + + + Gets the signature type. + + + + + Instantiates a new instance of the class. + + The signing certificate. + The signature and timestamp hash algorithm. + Thrown if + is null. + Thrown if + is invalid. + + + + Instantiates a new instance of the class. + + The signing certificate. + The signature hash algorithm. + The timestamp hash algorithm. + Thrown if + is null. + Thrown if + is invalid. + Thrown if + is invalid. + + + + Creates Signatures that can be added to packages. + + + + + Create a signature. + + Signing request with all the information needed to create signature. + SignatureContent containing the Hash of the package and the signature version. + Logger + Cancellation token. + A signature for the package. + + + + Create a repository countersignature. + + Signing request with all the information needed to create signature. + Primary signature to be countersigned. + Logger + Cancellation token. + A signature for the package. + + + + Gets the repository V3 service index URL. + + + + + Gets a read-only list of package owners. + + + + + Gets the signature type. + + + + + Instantiates a new instance of the class. + + The signing certificate. + The signature hash algorithm. + The timestamp hash algorithm. + The V3 service index URL. + A read-only list of package owners. + Thrown if + is null. + Thrown if + is invalid. + Thrown if + is invalid. + Thrown if + is null. + Thrown if + is neither absolute nor HTTPS. + Thrown if + is either empty or contains an invalid value. + + + + Readable stream for the package that will be used as an input for any signing operation. + + + + + Readable and writeable stream for the output package for any signing operation. + + + + + Switch used to indicate if an existing signature should be overwritten. + + + + + Provider to create a Signature that can be added to the package. + + + + + Logger to be used to display the logs during the execution of signing actions. + + + + Instantiates a new object. + A readable stream for the package that will be used as input for any + signing operation. + A readable and writeable stream for the output package for any signing + operation. + A flag indicating if an existing signature should be overwritten. + A provider to create a Signature that can be added to the package. + A logger. + Signing operations cannot be done in place; therefore, + and should be different streams. + Thrown if is null. + Thrown if is null. + Thrown if is null. + Thrown if is null. + Thrown if and + are the same object. + + + Creates a new object from file paths. + The file path of the package that will be used as input for any + signing operation. + The file path of the package that will be the output for any signing + operation. + A flag indicating if an existing signature should be overwritten. + A provider to create a Signature that can be added to the package. + A logger. + Signing operations cannot be done in place; therefore, + and should be different file paths. + Thrown if is null, + an empty string, or equivalent to . + Thrown if is null, + an empty string, or equivalent to . + Thrown if is null. + Thrown if is null. + + + + Contains a request for generating package signature. + + + + + Hash algorithm used to create the package signature. + + + + + Hash algorithm used to timestamp the signed package. + + + + + Certificate used to sign the package. + + + + + Gets a collection of additional certificates for building a chain for the signing certificate. + + + + + Gets the signature type. + + + + + PrivateKey is only used in mssign command. + + + + + Disposes of this instance. + + + + + Sign a manifest hash with an X509Certificate2. + + + + + Sign the package stream hash with an X509Certificate2. + + + + + Countersign the primary signature with a X509Certificate2. + + + + + Read a section of key value pairs from the file. + Throw for invalid formats. + + Returns an empty set if the file has reached the end. + + + + Throw if the expected value does not exist. + + + + + Write key:value with EOL to the manifest stream. + + + + + Write an empty line. + + + + + Write an end of line to the manifest writer. + + + + + key:value + + + + + SignedCms.ContentInfo.Content for the primary signature. + + + + + Hashing algorithm used. + + + + + Base64 package stream hash. + + + + + Write the content to a stream. + + + + + Write the content to byte array. + + + + + Load from a byte array. + + + + + Load content from a stream. + + + + + Writes data encoded via the Distinguished Encoding Rules for Abstract + Syntax Notation 1 (ASN.1) data. + + + + + Encode the segments { tag, length, value } of a boolean. + + The boolean to encode + The encoded segments { tag, length, value } + + + + Encode the segments { tag, length, value } of an unsigned integer. + + The value to encode. + The encoded segments { tag, length, value } + + + + Encode the segments { tag, length, value } of an unsigned integer. + + The value to encode, in big integer representation. + The encoded segments { tag, length, value } + + + + Encode the segments { tag, length, value } of an unsigned integer represented within a bounded array. + + The value to encode, in big integer representation. + The offset into bigEndianBytes to read + The count of bytes to read, must be greater than 0 + The encoded segments { tag, length, value } + + + + Encode the segments { tag, length, value } of a BIT STRING which is wrapped over + other DER-encoded data. + + + + Despite containing other DER-encoded data this does not get the constructed bit, + because it doesn't when encoding public keys in SubjectPublicKeyInfo + + + + + Encode the segments { tag, length, value } of a bit string where all bits are significant. + + The data to encode + The encoded segments { tag, length, value } + + + + Encode the segments { tag, length, value } of a bit string where the least significant + of the last byte are padding. + + The number of padding bits (0-7) in the last byte + The data to encode + The encoded segments { tag, length, value } + + + + Encode the segments { tag, length, value } of a bit string value based upon a NamedBitList. + (([0] >> 7) & 1) is considered the "leading" bit, proceeding + through the array for up to . + + + The data in big endian order, the most significant bit of byte 0 is the leading bit + (corresponds to the named value for "bit 0"). Any bits beyond + are ignored, and any missing bits are assumed to be unset. + + + The total number of named bits. Since the bits are numbered with a zero index, this should be + one higher than the largest defined bit. (namedBitsCount=10 covers bits 0-9) + + + A triplet of { tag }, { length }, { data }. All trailing unset named bits are removed. + + + + + Encode the segments { tag, length, value } of an octet string (byte array). + + The data to encode + The encoded segments { tag, length, value } + + + + Encode an object identifier (Oid). + + The encoded OID + + + + Encode the segments { tag, length, value } of an object identifier (Oid). + + The encoded segments { tag, length, value } + + + + Encode the segments { tag, length, value } of an object identifier (Oid). + + The encoded segments { tag, length, value } + + + + Encode a character string as a UTF8String value. + + The characters to be encoded. + The encoded segments { tag, length, value } + + + + Encode a substring as a UTF8String value. + + The characters whose substring is to be encoded. + The character offset into at which to start. + The total number of characters from to read. + The encoded segments { tag, length, value } + + + + Make a constructed SEQUENCE of the byte-triplets of the contents, but leave + the value in a segmented form (to be included in a larger SEQUENCE). + + Series of Tag-Length-Value triplets to build into one sequence. + The encoded segments { tag, length, value } + + + + Make a context-specific tagged value which is constructed of other DER encoded values. + Logically the same as a SEQUENCE, but providing context as to data interpretation (and usually + indicates an optional element adjacent to another SEQUENCE). + + The value's context ID + Series of Tag-Length-Value triplets to build into one sequence. + The encoded segments { tag, length, value } + + + + Make a constructed SET of the byte-triplets of the contents, but leave + the value in a segmented form (to be included in a larger SEQUENCE). + + Series of Tag-Length-Value triplets to build into one set. + The encoded segments { tag, length, value } + + + + Make a constructed SET of the byte-triplets of the contents, but leave + the value in a segmented form (to be included in a larger SEQUENCE). + + This method assumes that the data is presorted, and writes it as-is. + + Series of Tag-Length-Value triplets to build into one set. + The encoded segments { tag, length, value } + + + + Test to see if the input characters contains only characters permitted by the ASN.1 + PrintableString restricted character set. + + The characters to test. + + true if all of the characters in are valid PrintableString characters, + false otherwise. + + + + + Test to see if the input substring contains only characters permitted by the ASN.1 + PrintableString restricted character set. + + The character string to test. + The starting character position within . + The number of characters from to read. + + true if all of the indexed characters in are valid PrintableString + characters, false otherwise. + + + + + Encode a character string as a PrintableString value. + + The characters to be encoded. + The encoded segments { tag, length, value } + + + + Encode a substring as a PrintableString value. + + The character string whose substring is to be encoded. + The character offset into at which to start. + The total number of characters from to read. + The encoded segments { tag, length, value } + + + + Encode a string of characters as a IA5String value. + + The characters to be encoded. + The encoded segments { tag, length, value } + + + + Encode a substring as a IA5String value. + + The characters whose substring is to be encoded. + The character offset into at which to start. + The total number of characters from to read. + The encoded segments { tag, length, value } + + + + Make a constructed SEQUENCE of the byte-triplets of the contents. + Each byte[][] should be a byte[][3] of {tag (1 byte), length (1-5 bytes), payload (variable)}. + + + + + Make a constructed SEQUENCE of the byte-triplets of the contents. + Each byte[][] should be a byte[][3] of {tag (1 byte), length (1-5 bytes), payload (variable)}. + + + + This is public only to facilitate testing. + + + + Reads data encoded via the Distinguished Encoding Rules for Abstract + Syntax Notation 1 (ASN.1) data. + + + + + Returns the next value encoded (this includes tag and length) + + + + + A strongly-typed resource class, for looking up localized strings, etc. + + + + + Returns the cached ResourceManager instance used by this class. + + + + + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + + + + + Looks up a localized string similar to The OID value was invalid.. + + + + + Looks up a localized string similar to ASN1 corrupted data.. + + + + + Looks up a localized string similar to The string contains a character not in the 7 bit ASCII character set.. + + + + + A package that can read and write signatures. + + + + + A readonly package that can provide signatures and a sign manifest from a package. + + + + + Get package signature. + + Returns a null if the package is unsigned. + + + + Check if a package contains signing information. + + True if the package is signed. + + + + Gets the hash of an archive to be embedded in the package signature. + + + + + Checks for the integrity of a package + + SignatureContent with expected hash value and hash algorithm used + + + + + Get the hash of the package content excluding signature context for signed package. + If the package is not signed it calculates it from the whole package. + + Cancellation token. + Function to return the hash in case the package is not signed. + The method takes an optional function to get the hash of an unsigned package instead of calculating it. + hash of the unsigned content of the package. + + + + Indicates if the the ISignedPackageReader instance can verify signed packages. + + Package verification settings. Include information about what is allowed. + if the ISignedPackageReader does not support signed packages + + + + A writer that only allows editing for the package signature. + + + + + Removes a signature if it exists. + + CancellationToken + + + + Adds a signature in the package. + Throws exception if the package is already signed. + + A stream of the signature to be added to the package. + Cancellation token. + + + + Check if a package is Zip64. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a + indicating whether the package is signed. + Thrown if + is cancelled. + + + + A nupkg that supports both reading and writing signatures. + + + + + Stream underlying the ZipArchive. Used to do signature verification on a SignedPackageArchive. + If this is null then we cannot perform signature verification. + + + + + Adds a signature to a package if it is not already signed. + + Stream of the signature SignedCms object to be added to the package. + Cancellation Token. + + + + + Remove a signature from the package, if it exists. + + Cancellation token. + + + + Individual trust results. + + + + + Log message for signature verification. + + + + + Converts an SignatureLog into a Restore + This is needed when an SignatureLog needs to be logged and loggers do not have visibility to SignatureLog. + + RestoreLogMessage equivalent to the SignatureLog. + + + This is public only to facilitate testing. + + + This is public only to facilitate testing. + + + This is public only to facilitate testing. + + + This is public only to facilitate testing. + + + This is public only to facilitate testing. + + + This is public only to facilitate testing. + + + This is public only to facilitate testing. + + + This is public only to facilitate testing. + + + This is public only to facilitate testing. + + + This is public only to facilitate testing. + + + This is public only to facilitate testing. + + + + A SignedCms object holding the signature and SignerInfo. + + + + + Signature content. + + + + + Save the signed cms signature to a stream. + + + + + + Retrieve the bytes of the signed cms signature. + + + + + Create a signature based on a valid signed cms + + signature data + + + + Create a signature based on a valid byte array to be decoded as a signed cms + + signature data + + + + Create a signature based on a valid byte stream to be decoded as a signed cms + + signature data + + + + Package signature information. + + + + + Indicates if this is an author or repository signature. + + + + + Signature timestamps. + + + + + SignerInfo for this signature. + + + + + Get a valid timestamp from the unsigned attributes if present + + Specify what is allowed in the validation for timestamp + fingerprint algorithm for displaying timestamp's certificate information + List of log messages. + Flags that specify the status of the verification + TTimestamp found in the signature that passes validation with the given + If is set to true this method return true with a set to null. + true if a valid timestamp was found + + + + Verify if the signature object meets the specification trust and validity requirements. + + Timestamp for this signature, if signature is not timestamped it can be null. + Setting that tells if a signature that does not meet any soft failure requirements can still be allowed. Used to know if warnings or errors should be logged for an issue. + Setting that tells if unkown revocation is valid when building the chain. + Setting that tells if an untrusted self-signed certificate should be allowed as the signing certificate. + Algorithm used to calculate and display the certificate's fingerprint. + Collection of certificates to help the chain building engine as an extra store. + List of log messages. + This is only public for ease of testing + Status of trust for signature. + + + + Get timestamps from the signer info + + + + + + + Indicates signature placement. + + + + + The primary signature. + + + + + A countersignature on the primary signature. + + + + + A primary signature or a countersignature. + + + + + Indicates author or repository signing. + + + + + Default unknown value. + + + + + Signed by the author. + + + + + Signed by the repository. + + + + + Settings to customize Signature.Verify behavior. + + + + + Allow packages with signatures that do not conform to the specification. + + + + + Specifies that a signing certificate's chain that chains to an untrusted root is allowed + + + + + Specifies that a signing certificate's chain with unknown revocation is allowed. + If set to true, offline revocation is allowed. + + + + + Indicates if unknown revocation status should be reported. + + + + + Indicates if a signing certificate that chains to an untrusted root should be reported. + + + + + Gets how the revocation verification should be performed. + + + + + Get default settings values for relaxed verification on a signature + + + + This is public only to facilitate testing. + + + This is public only to facilitate testing. + + + + Abstract class representing which paths may be used for signing in a package. + + + + + v1.0.0 signing settings. + + + + + Gets the signature format version. + + + + + Returns the path for the signature file. + + + + + Returns the set of allowed hash algorithms. + + + + + Returns the set of allowed hash algorithm Oids. + + + + + Returns the set of allowed signature algorithms. + + + + + Returns the set of allowed signature algorithm Oids. + + + + + Returns minumum length required for RSA public keys. + + + + + Encoding used to generate the signature. + + + + + Initialize a signing specification with a root folder. + + + + + Allowed digest algorithms for signature and timestamp hashing. + + + + + Allowed digest algorithm Oids for signature and timestamp hashing. + + + + + Allowed signature algorithms. + + + + + Allowed signature algorithm Oids. + + + + + Gets the signature format version. + + + + This is public only to facilitate testing. + + + This is public only to facilitate testing. + + + This is public only to facilitate testing. + + + This is public only to facilitate testing. + + + + A provider for RFC 3161 timestamps + https://tools.ietf.org/html/rfc3161 + + + + + Timestamps data present in the TimestampRequest. + + + + + Timestamps data present in the TimestampRequest. + + + + + Returns the FriendlyName of an Oid. If FriendlyName is null, then the Oid string is returned. + + + + + Class representing a Rfc3161TimestampRequest. + This class should be removed once we can reference it throught the .NET Core framework. + + + + + Class representing a Rfc3161TimestampToken. + This class should be removed once we can reference it throught the .NET Core framework. + + + + + Represents an RFC3161 TSTInfo. + This class should be removed once we can reference it throught the .NET Core framework. + + + + + Gets the serial number for the request in the big-endian byte order. + + + + + Internally used by Rfc3161TimestampProvider. + This class should be removed once we can reference it throught the .NET Core framework. + + + + + Provides convinience method for verification of a RFC 3161 Timestamp. + + + + + Internally used by Rfc3161TimestampProvider. + This class should be removed once we can reference it throught the .NET Core framework. + + + + + Upper limit of Timestamp. + + + + + Lower limit of Timestamp. + + + + + Time timestamp was created by the Time Stamp Authority. + + + + + A SignedCms object holding the timestamp and SignerInfo. + + + + + SignerInfo for this timestamp. + + + + + Timestamp token info for this timestamp. + + + + + Default constructor. Limits are set to current time. + + + + + SignedCms containing a time stamp authority token reponse + + SignedCms from Time Stamp Authority + + + + Verify if the timestamp object meets the specification requirements. + + Signature which this timestamp is for. + Setting that tells if a timestamp can be ignored if it doesn't meet the requirements. Used to know if warnings or errors should be logged for an issue. + Setting that tells if unkown revocation is valid when building the chain. + List of log messages. + true if the timestamp meets the requierements, false otherwise. + + + + Exceptions that are generated while creating a package timestamp. + + + + + Request for timestamping a signature + + + + + Signing Specification for this timestamp request. + + + + + Gets the hashed message to be timestamped. + + + + + Gets the hash algorithm used to generate . + + + + + Gets the target signature for the timestamp + + + + This is public only to facilitate testing. + + + + Get a list of all the trusted signer entries under the computer trusted signers section. + + + + + Adds a new trusted signer or updates an existing one in the settings. + + Trusted signers to be added or updated + + + + Removes trusted signers from the settings. + + Trusted signers to be removed + + + + Create a CommitmentTypeIndication attribute. + https://tools.ietf.org/html/rfc5126.html#section-5.11.1 + + The signature type. + + + + Gets the signature type from one or more commitment-type-indication attributes. + + A signed attributes collection. + Unknown OIDs are ignored. + Thrown if is null. + Thrown if one or more attributes are invalid. + + + + Creates a nuget-v3-service-index-url attribute. + + The V3 service index HTTPS URL. + An attribute object. + Thrown if is null. + Thrown if is neither absolute + nor HTTPS. + + + + Gets the V3 service index HTTPS URL from the nuget-v3-service-index-url attribute. + + A signed attributes collection. + The V3 service index HTTPS URL. + Thrown if + is null. + Thrown if either exactly one attribute is not present or if + the attribute does not contain exactly one attribute value. + + + + Creates a nuget-package-owners attribute. + + A read-only list of package owners. + An attribute object. + Thrown if is either null + or empty or if any package owner name is invalid. + + + + Gets a read-only list of package owners from an optional nuget-package-owners attribute. + + A signed attributes collection. + A read-only list of package owners or null. + Thrown if is null. + Thrown if the attribute does not contain exactly one + attribute value. + + + + Oid -> SignatureType + + The commitment-type-indication value. + + + + SignatureType -> Oid + + The signature type. + + + + Create a signing-certificate-v2 from a certificate. + + The signing certificate. + The hash algorithm for the signing-certificate-v2 attribute. + + + + Returns the first attribute if the Oid is found. + Returns null if the attribute is not found. + + + + + Throw a signature exception due to an invalid attribute. This is used for unusual situations + where the format is corrupt. + + + + + Enumerate AsnEncodedDataCollection + + + + + Attribute -> SignatureType values with no validation. + + + + + Gets 0 or 1 attribute with the specified OID. If more than one attribute is found, an exception is thrown. + + A collection of attributes. + The attribute OID to search for. + Either a or null, if no attribute was found. + Thrown if is null. + Thrown if is either null or an empty string. + Thrown if multiple attribute instances with the specified OID were found. + + + + Gets 0 or 1 or many attributes with the specified OID. + + A collection of attributes. + The attribute OID to search for. + Either a or null, if no attribute was found. + Thrown if is null. + Thrown if is either null or an empty string. + + + + Create a list of certificates in chain order with the leaf first and root last. + + The certificate for which a chain should be built. + A certificate store containing additional certificates necessary + for chain building. + A logger. + The certificate type. + A certificate chain. + This is intended to be used only during signing and timestamping operations, + not verification. + Thrown if is null. + Thrown if is null. + Thrown if is null. + Thrown if is undefined. + + + + Create an ordered list of certificates. The leaf node is returned first. + + Certificate chain to be converted to list. + This does not check validity or trust. It returns the chain as-is. + + + + Converts a X509Certificate2 to a human friendly string of the following format - + Subject Name: CN=name + SHA1 hash: hash + Issued by: CN=issuer + Valid from: issue date time to expiry date time in local time + + X509Certificate2 to be converted to string. + Algorithm used to calculate certificate fingerprint + string representation of the X509Certificate2. + + + + Converts a X509Certificate2Collection to a human friendly string of the following format - + Subject Name: CN=name + SHA1 hash: hash + Issued by: CN=issuer + Valid from: issue date time to expiry date time in local time + + Subject Name: CN=name + SHA1 hash: hash + Issued by: CN=issuer + Valid from: issue date time to expiry date time in local time + + ... N more. + + X509Certificate2Collection to be converted to string. + Algorithm used to calculate certificate fingerprint + string representation of the X509Certificate2Collection. + + + + Determines if a certificate's signature algorithm is supported. + + Certificate to validate + True if the certificate's signature algorithm is supported. + + + + Validates the public key requirements for a certificate + + Certificate to validate + True if the certificate's public key is valid within NuGet signature requirements + + + + Validates if the certificate contains the lifetime signing EKU + + Certificate to validate + True if the certificate has the lifetime signing EKU + + + + Checks if an X509Certificate2 contains a particular Extended Key Usage (EKU). + + X509Certificate2 to be checked. + String OID of the Extended Key Usage + A bool indicating if the X509Certificate2 contains specified OID in its Extended Key Usage. + + + + Checks if an X509Certificate2 is valid for a particular purpose. + + + This must not be used in evaluation of a signed package. + A more accurate test is building a chain with the specified EKU asserted in the application policy. + + X509Certificate2 to be checked. + String OID of the Extended Key Usage + A bool indicating if the X509Certificate2 contains specified OID string in its Extended Key Usage. + + + + Gets the certificate fingerprint with the given hashing algorithm + + X509Certificate2 to be compute fingerprint + Hash algorithm for fingerprint + A byte array representing the certificate hash. + + + + Gets the certificate fingerprint string with the given hashing algorithm + + X509Certificate2 to be compute fingerprint + Hash algorithm for fingerprint + A string representing the certificate hash. + + + + Determines if a certificate is self-issued. + + Warning: this method does not evaluate certificate trust, revocation status, or validity! + This method attempts to build a chain for the provided certificate, and although revocation status + checking is explicitly skipped, the underlying chain building engine may go online to fetch + additional information (e.g.: the issuer's certificate). This method is not a guaranteed offline + check. + The certificate to check. + true if the certificate is self-issued; otherwise, false. + Thrown if is null. + + + + Gets SignedPackageVerifierSettings from a given RepositorySignatureInfo. + + RepositorySignatureInfo to be used. + SignedPackageVerifierSettings to be used if RepositorySignatureInfo is unavailable. + SignedPackageVerifierSettings based on the RepositorySignatureInfo and SignedPackageVerifierSettings. + + + + Gets certificates in the certificate chain for the primary signature. + + The primary signature. + A non-empty, read-only list of X.509 certificates ordered from signing certificate to root. + Thrown if is null. + + WARNING: This method does not perform revocation, trust, or certificate validity checking. + + + + + Gets certificates in the certificate chain for the repository countersignature. + + The primary signature. + The repository countersignature. + A non-empty, read-only list of X.509 certificates ordered from signing certificate to root. + Thrown if is null. + Thrown if is null. + Thrown if is + unrelated to . + + WARNING: This method does not perform revocation, trust, or certificate validity checking. + + + + + Gets certificates in the certificate chain for a timestamp on the primary signature. + + The primary signature. + A non-empty, read-only list of X.509 certificates ordered from signing certificate to root. + Thrown if is null. + Thrown if does not have a valid + timestamp. + + WARNING: This method does not perform revocation, trust, or certificate validity checking. + + + + + Gets certificates in the certificate chain for a timestamp on the repository countersignature. + + The primary signature. + The repository countersignature. + A non-empty, read-only list of X.509 certificates ordered from signing certificate to root. + Thrown if is null. + Thrown if is null. + Thrown if does not have a valid + timestamp. + + WARNING: This method does not perform revocation, trust, or certificate validity checking. + + + + + Utility methods for signing. + + + + + Add a signature to a package. + + + + + Creates and performs cleanup on an instance. + + + Certificates held by individual X509ChainElement objects should be disposed immediately after use to minimize + finalizer impact. + + + + + Current policy the client is on. + + + + + Verification settings corresponding the current client policy. + + + + + List of signatures allowed in verification. + + + + + Loads trust providers and verifies package signatures. + + + + + Verifies package signature. + + Package to be verified. + SignedPackageVerifierSettings to be used when verifying the package. + Cancellation Token. + Guid of the parent event. + VerifySignaturesResult containing the result of the verify operation. + + + + Providers signature trust information. + + + + + Check if is trusted by the provider. + + + + + True if a provider trusts the package signature. + + + + + Represents a signature check result and any additional information + needed to display to the user. + + + + + Trust result + + + + + List of issues found in the verification process + + + + + PackageVerificationResult + + + + + Do not verify a signature. + + + + + Verify a signature if and only if it exists. + + + + + Verify a signature if and only if it exists and is necessary + (e.g.: trust evaluation of another signature depends on it). + + + + + Verify a signature always. If the signature is not present, it is an error. + + + + + Represents the trust result of a signature. + + The order of the elements on this enum is important. + It should be ordered from most severe to valid. + When a verification with multiple steps wants to be strict it should take the min + out of each step as the status for the whole verification. + + + + Default unknown value. + + + + + Invalid package signature. + + This could happen because the package integrity check fails or the certificate is revoked. + + + + The signature is disallowed based on verification settings. + + + + + Signature is valid for the verification step. + + + + + There was no error found + + + + + A signature was not found + + + + + Signer certificate was not found + + + + + Multiple signatures were found + + + + + A call to SignedCms.CheckSignature failed + + + + + Signature algorithm is not supported + + + + + Public key does not conform with the requirements of the spec + + + + + Signing certificate has lifetimeSigningEku + + + + + Signer certificate's validity is in the future + + + + + Signing certificate has expired + + + + + Hashing algorithm is not supported + + + + + Message imprint uses a hash algorithm that is not supported + + + + + Integrity check of the signature failed + + + + + Chain building failures. + Some specific chain building failures (like revocation, revocation status unavailable, certificate expired, etc.) + are not covered by this flag because they are covered specially by another status flag. + + + + + Revocation information was unavailable or was offline for the signer certificate + + + + + Signing certificate was revoked + + + + + Signing certificate chains to a certificate untrusted by the computer performing the verification + + + + + The Timestamp's generalized time was outside certificate's validity period + + + + + A valid timestamp was not found. + + + + + Multiple timestamps were found. + + + + + Flags which indicate that the signed package is suspect. + + + + + Flags which indicate that the signed package is illegal. + + + + + Flags which indicate that the signed package is untrusted. + + + + + Type of the signature that was verified + + + + + Status of the verification + + + + + Reasons for the status. + + + + + Timestamp used to validate certificate. + + + + + Expiration Date and Time for signature + + This field will only be set if the certificate is expired. + + + + Signature + + + + + Feed settings used to verify packages. + + + + + Allow packages that do not contain signatures. + + + + + Allow packages with signatures that do not conform to the specification. + + + + + Allow packages that have not been explicitly trusted by the consumer. + + + + + Allow ignoring timestamp. + + + + + Allow more than one timestamp. + + + + + Allow no timestamp. + + + + + Treat unknown revocation status as a warning instead of an error during verification. + + + + + Report unknown revocation status. + + + + + Gets the verification target(s). + + + + + Gets the placement of verification target(s). + + + + + Gets the repository countersignature verification behavior. + + + + + Gets how the revocation verification should be performed. + + + + + Default settings. + + + + + The accept mode policy. + + + + + The require mode policy. + + + + + Default policy for nuget.exe verify --signatures command. + + + + + List of allowed owners for a repository signature + + + + + Describe if the certificate should be allowed to chain to an untrusted certificate + + + + + Target type of signature to verify. + + + + + Signature placement to verify. + + + + + Indicates the type of signature a verification is targeting + + This target makes no assumption about the placement of the signature. + It only refers to author or repository type of signature. + If a specific placement is needed use the enum. + + + + Don't target any signatures. + + + + + Target unknown primary signatures. + + + + + Target author signatures + + + + + Target repository signatures + + + + + Target all available signatures. + + + + + Collection of signature verification results. + + + + + True if signature is valid. + + + + + True if the package is signed. + + + + + Individual trust results. + + + + + RepositorySignatureInfoProvdier is a static cache for repository signature information for package source. + + + + + Try to get repository signature information for the source. + + Package source URL. + Contains the RepositorySignatureInfo when the method returns. It is null if repository signature information is unavailable. + True if the repository signature information was found. Otherwise, False. + + + + Add or update the repository signature information for the source. + + Package source URL. + RepositorySignatureInfo for the source url. + + + + A strongly-typed resource class, for looking up localized strings, etc. + + + + + Returns the cached ResourceManager instance used by this class. + + + + + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + + + + + Looks up a localized string similar to The argument cannot be null or empty.. + + + + + Looks up a localized string similar to author primary signature. + + + + + Looks up a localized string similar to A complete certificate chain could not be built for the signing certificate.. + + + + + Looks up a localized string similar to Certificate chain validation failed.. + + + + + Looks up a localized string similar to {0} hash: {1}. + + + + + Looks up a localized string similar to SHA1 hash: {0}. + + + + + Looks up a localized string similar to Issued by: {0}. + + + + + Looks up a localized string similar to Subject Name: {0}. + + + + + Looks up a localized string similar to Valid from: {0} to {1}. + + + + + Looks up a localized string similar to ... {0} more.. + + + + + Looks up a localized string similar to The following certificates meet all given criteria:. + + + + + Looks up a localized string similar to The commitment-type-indication attribute is invalid.. + + + + + Looks up a localized string similar to The commitment-type-indication attribute contains an invalid combination of values.. + + + + + Looks up a localized string similar to There are two certificates with conflicting allowUntrustedRoot attributes in the computed settings. The allowUntrustedRoot attribute is going to be set to false. Certificate: {0}-{1}. + + + + + Looks up a localized string similar to A list of trusted signers is required but none was found.. + + + + + Looks up a localized string similar to The package signature certificate fingerprint does not match any certificate fingerprint in the allow list.. + + + + + Looks up a localized string similar to Unsupported targetFramework value '{0}'.. + + + + + Looks up a localized string similar to Error parsing nupkg metadata file {0} : {1}. + + + + + Looks up a localized string similar to signatureValidationMode is set to require, so packages are allowed only if signed by trusted signers; however, no trusted signers were specified.. + + + + + Looks up a localized string similar to This package is signed but not by a trusted signer.. + + + + + Looks up a localized string similar to This package was not repository signed with a certificate listed by this repository.. + + + + + Looks up a localized string similar to This repository indicated that all its packages are repository signed; however, it listed no signing certificates.. + + + + + Looks up a localized string similar to The package signature file does not contain exactly one primary signature.. + + + + + Looks up a localized string similar to The package signature contains multiple repository countersignatures.. + + + + + Looks up a localized string similar to This repository indicated that all its packages are repository signed; however, this package is unsigned.. + + + + + Looks up a localized string similar to A repository primary signature must not have a repository countersignature.. + + + + + Looks up a localized string similar to signatureValidationMode is set to require, so packages are allowed only if signed by trusted signers; however, this package is unsigned.. + + + + + Looks up a localized string similar to Cannot target author signatures that are countersignatures.. + + + + + Looks up a localized string similar to Byte signature not found in package archive: 0x{0}. + + + + + Looks up a localized string similar to Byte signature too big to seek in current stream position.. + + + + + Looks up a localized string similar to There are duplicate packages: {0}. + + + + + Looks up a localized string similar to Invalid allowedVersions for package id '{0}': '{1}'. + + + + + Looks up a localized string similar to Certificate chain validation failed for an unspecified reason.. + + + + + Looks up a localized string similar to Invalid minClientVersion: '{0}'. + + + + + Looks up a localized string similar to Invalid package archive.. + + + + + Looks up a localized string similar to Invalid package version for package id '{0}': '{1}'. + + + + + Looks up a localized string similar to Invalid package version for a dependency with id '{0}' in package '{1}': '{2}'. + + + + + Looks up a localized string similar to Manifest file not found at '{0}'. + + + + + Looks up a localized string similar to Multiple timestamps are not accepted.. + + + + + Looks up a localized string similar to The signature should be timestamped to enable long-term signature validity after the certificate has expired.. + + + + + Looks up a localized string similar to Null or empty package id. + + + + + Looks up a localized string similar to The package is not signed.. + + + + + Looks up a localized string similar to The package signature is invalid or cannot be verified on this platform.. + + + + + Looks up a localized string similar to An unexpected error occurred while checking package entries.. + + + + + Looks up a localized string similar to Unable to delete temporary file '{0}'. Error: '{1}'.. + + + + + Looks up a localized string similar to The package '{0}' contains an entry which is unsafe for extraction.. + + + + + Looks up a localized string similar to Signed Zip64 packages are not supported.. + + + + + Looks up a localized string similar to Exactly one {0} attribute is required.. + + + + + Looks up a localized string similar to The {0} attribute must have exactly one attribute value.. + + + + + Looks up a localized string similar to Package '{0} {1}' from source '{2}': {3}. + + + + + Looks up a localized string similar to Failed to update file time for {0}: {1}. + + + + + Looks up a localized string similar to Fail to load packages.config as XML file. Please check it. . + + + + + Looks up a localized string similar to Failed to write packages.config as XML file '{0}'. Error: '{1}'.. + + + + + Looks up a localized string similar to Unable to find fallback package folder '{0}'.. + + + + + Looks up a localized string similar to The argument is invalid.. + + + + + Looks up a localized string similar to Invalid combination of arguments {0} and {1}.. + + + + + Looks up a localized string similar to The ASN.1 data is invalid.. + + + + + Looks up a localized string similar to The version string '{0}' is not supported by this toolset. The highest supported version is '{1}'. Either use a lower version or upgrade your toolset.. + + + + + Looks up a localized string similar to {0} This validation error occurred in a '{1}' element.. + + + + + Looks up a localized string similar to The nuspec contains an invalid entry '{0}' in package '{1}' .. + + + + + Looks up a localized string similar to The framework in the folder name of '{0}' in package '{1}' could not be parsed.. + + + + + Looks up a localized string similar to The file is not a valid nupkg. File path: {0}. + + + + + Looks up a localized string similar to Package {0} signature is invalid.. + + + + + Looks up a localized string similar to The package contains an invalid package signature file.. + + + + + Looks up a localized string similar to The package signature file entry is invalid. {0}. + + + + + Looks up a localized string similar to The central directory header field '{0}' has an invalid value ({1}).. + + + + + Looks up a localized string similar to The local file header field '{0}' has an invalid value ({1}).. + + + + + Looks up a localized string similar to The primary signature is invalid.. + + + + + Looks up a localized string similar to The repository countersignature is invalid.. + + + + + Looks up a localized string similar to The package signature content is invalid.. + + + + + Looks up a localized string similar to The timestamp signature is invalid.. + + + + + Looks up a localized string similar to The URL value is invalid.. + + + + + Looks up a localized string similar to Installing {0} {1}.. + + + + + Looks up a localized string similar to MinClientVersion already exists in packages.config. + + + + + Looks up a localized string similar to Nuspec file does not exist in package.. + + + + + Looks up a localized string similar to Multiple {0} attributes are not allowed.. + + + + + Looks up a localized string similar to Package contains multiple nuspec files.. + + + + + Looks up a localized string similar to The package contains multiple package signature files.. + + + + + Looks up a localized string similar to '{0}' must contain an absolute path '{1}'.. + + + + + Looks up a localized string similar to The package does not contain a valid package signature file.. + + + + + Looks up a localized string similar to Verification settings require a repository countersignature, but the package does not have a repository countersignature.. + + + + + Looks up a localized string similar to The license expression '{0}' cannot be parsed succesfully.. + + + + + Looks up a localized string similar to The license version string '{0}' is invalid.. + + + + + Looks up a localized string similar to Unrecognized license type '{0}'. + + + + + Looks up a localized string similar to The license element value is empty. This is likely due to an authoring error. . + + + + + Looks up a localized string similar to The license version string '{0}' is higher than the one supported by this toolset '{1}'.. + + + + + Looks up a localized string similar to The element 'license' cannot be empty. . + + + + + Looks up a localized string similar to The identifier '{0}' is deprecated.. + + + + + Looks up a localized string similar to The identifier '{0}' is a license. It cannot be used as an exception.. + + + + + Looks up a localized string similar to The 'UNLICENSED' license identifier cannot be combined with the '+' operator.. + + + + + Looks up a localized string similar to The license expression '{0}' contains invalid characters.. + + + + + Looks up a localized string similar to The identifier '{0}' is not a standard exception.. + + + + + Looks up a localized string similar to The license expression is invalid.. + + + + + Looks up a localized string similar to Invalid element '{0}'.. + + + + + Looks up a localized string similar to The identifier '{0}' is an exception. It cannot be used as a license.. + + + + + Looks up a localized string similar to The license identifier '{0}' contains invalid characters.. + + + + + Looks up a localized string similar to Mismatched parentheses in the expression.. + + + + + Looks up a localized string similar to The license identifier(s) '{0}' is(are) not recognized by the current toolset.. + + + + + Looks up a localized string similar to Unexpected license identifier '{0}'. The identifier is not allowed in this context.. + + + + + Looks up a localized string similar to The owner has marked this package as 'UNLICENSED'. This means that there is no license that allows this package to be used outside of the copyright owner.. + + + + + Looks up a localized string similar to nuget-package-owners: {0}. + + + + + Looks up a localized string similar to The nuget-package-owners attribute is invalid.. + + + + + Looks up a localized string similar to One or more package owner values are invalid.. + + + + + Looks up a localized string similar to nuget-v3-service-index-url: {0}. + + + + + Looks up a localized string similar to The nuget-v3-service-index-url attribute is invalid.. + + + + + Looks up a localized string similar to The nuget-v3-service-index-url attribute value is invalid.. + + + + + Looks up a localized string similar to Package entry already exists in packages.config. Id: {0}. + + + + + Looks up a localized string similar to Package entry does not exists in packages.config. Id: {0}, Version: {1}. + + + + + Looks up a localized string similar to The '{0}' package requires NuGet client version '{1}' or above, but the current NuGet version is '{2}'. To upgrade NuGet, please go to http://docs.nuget.org/consume/installing-nuget. + + + + + Looks up a localized string similar to PackageSignatureVerificationLog: PackageIdentity: {0} Source: {1} PackageSignatureValidity: {2}. + + + + + Looks up a localized string similar to Packages node does not exists in packages.config at {0}.. + + + + + Looks up a localized string similar to Package stream should be seekable. + + + + + Looks up a localized string similar to primary signature. + + + + + Looks up a localized string similar to The primary signature does not have a timestamp.. + + + + + Looks up a localized string similar to Arguments {0} and {1} were out of bounds for the array.. + + + + + Looks up a localized string similar to repository countersignature. + + + + + Looks up a localized string similar to The repository countersignature does not have a signing certificate.. + + + + + Looks up a localized string similar to The repository countersignature does not have a timestamp.. + + + + + Looks up a localized string similar to repository primary signature. + + + + + Looks up a localized string similar to Package signature contains an invalid attribute: {0}. + + + + + Looks up a localized string similar to Signature hash OID found: {0}. + + + + + Looks up a localized string similar to The package hash uses an unsupported hash algorithm.. + + + + + Looks up a localized string similar to signature. + + + + + Looks up a localized string similar to Signature Hash Algorithm: {0}. + + + + + Looks up a localized string similar to Invalid general purpose bit flags. Expected '{0}', actual '{1}'.. + + + + + Looks up a localized string similar to The package integrity check failed.. + + + + + Looks up a localized string similar to Signature type: {0}. + + + + + Looks up a localized string similar to The package already contains a signature. Please remove the existing signature before adding a new signature.. + + + + + Looks up a localized string similar to Package stream read position cannot be longer than the length of the stream.. + + + + + Looks up a localized string similar to Package stream read position cannot be before the current position in the stream.. + + + + + Looks up a localized string similar to The package is not signed. Unable to remove signature from an unsigned package.. + + + + + Looks up a localized string similar to The package is not signed. Unable to verify signature from an unsigned package.. + + + + + Looks up a localized string similar to The package already contains a repository countersignature. Please remove the existing signature before adding a new repository countersignature.. + + + + + Looks up a localized string similar to The package was not opened correctly to perform signature operations. Please use a Stream-based constructor to have access to signature attributes of the package.. + + + + + Looks up a localized string similar to The timestamp certificate does not meet a minimum public key length requirement.. + + + + + Looks up a localized string similar to The timestamp's generalized time is outside the timestamping certificate's validity period.. + + + + + Looks up a localized string similar to The timestamp integrity check failed.. + + + + + Looks up a localized string similar to The timestamp does not have a signing certificate.. + + + + + Looks up a localized string similar to The timestamp signing certificate is not yet valid.. + + + + + Looks up a localized string similar to The timestamp signature validation failed.. + + + + + Looks up a localized string similar to The following certificate cannot be used for package signing as the private key provider is unsupported:. + + + + + Looks up a localized string similar to {0} and {1} should be different. Package signing cannot be done in place.. + + + + + Looks up a localized string similar to The signing-certificate attribute is not allowed.. + + + + + Looks up a localized string similar to A certificate referenced by the signing-certificate attribute could not be found.. + + + + + Looks up a localized string similar to The signing-certificate attribute is invalid.. + + + + + Looks up a localized string similar to Either the signing-certificate or signing-certificate-v2 attribute must be present.. + + + + + Looks up a localized string similar to A certificate referenced by the signing-certificate-v2 attribute could not be found.. + + + + + Looks up a localized string similar to The signing-certificate-v2 attribute is invalid.. + + + + + Looks up a localized string similar to The signing-certificate-v2 attribute does not have exactly one attribute value.. + + + + + Looks up a localized string similar to The signing-certificate-v2 attribute uses an unsupported hash algorithm.. + + + + + Looks up a localized string similar to The signing certificate does not meet a minimum public key length requirement.. + + + + + Looks up a localized string similar to The lifetime signing EKU in the signing certificate is not supported.. + + + + + Looks up a localized string similar to The signing certificate has an unsupported signature algorithm.. + + + + + Looks up a localized string similar to The signing certificate is not yet valid.. + + + + + Looks up a localized string similar to The package cannot be signed as it would require the Zip64 format.. + + + + + Looks up a localized string similar to The stream must be readable.. + + + + + Looks up a localized string similar to The stream must be seekable.. + + + + + Looks up a localized string similar to String argument '{0}' cannot be null or empty. + + + + + Looks up a localized string similar to The timestamp service's certificate has a valid time in the future: {0}. + + + + + Looks up a localized string similar to The timestamp certificate has an unsupported signature algorithm ({0}). The following algorithms are supported: {1}.. + + + + + Looks up a localized string similar to The timestamper URL '{0}' has an invalid URI scheme. The supported schemes are '{1}' and '{2}'.. + + + + + Looks up a localized string similar to The timestamp response is invalid. Nonces did not match.. + + + + + Looks up a localized string similar to Timestamp service's response does not meet the NuGet package signature specification: '{0}'.. + + + + + Looks up a localized string similar to The timestamp response has an unsupported digest algorithm ({0}). The following algorithms are supported: {1}.. + + + + + Looks up a localized string similar to Timestamp: {0}. + + + + + Looks up a localized string similar to An error occurred while updating packages.config. The file was closed before the entry could be added.. + + + + + Looks up a localized string similar to Unable to parse the current NuGet client version.. + + + + + Looks up a localized string similar to Package hash information could not be read from the package signature.. + + + + + Looks up a localized string similar to An unexpected error occurred while verifying a package signature.. + + + + + Looks up a localized string similar to The enum value '{0}' is unrecognized.. + + + + + Looks up a localized string similar to The primary signature and repository countersignature are unrelated.. + + + + + Looks up a localized string similar to The ASN.1 data is unsupported.. + + + + + Looks up a localized string similar to The package signature format version is not supported. Updating your client may solve this problem.. + + + + + Looks up a localized string similar to Verifying the {0} with certificate: {1}. + + + + + Looks up a localized string similar to Verifying {0}'s timestamp with timestamping service certificate: {1}. + + + + + Looks up a localized string similar to The {0} does not have a signing certificate.. + + + + + Looks up a localized string similar to The revocation function was unable to check revocation because the certificate is not available in the cached certificate revocation list and NUGET_CERT_REVOCATION_MODE environment variable has been set to offline. For more information, visit https://aka.ms/certificateRevocationMode.. + + + + + Looks up a localized string similar to The revocation function was unable to check revocation because the revocation server could not be reached. For more information, visit https://aka.ms/certificateRevocationMode.. + + + + + Looks up a localized string similar to The {0} found a chain building issue: {1}. + + + + + Looks up a localized string similar to The {0}'s certificate does not meet a minimum public key length requirement.. + + + + + Looks up a localized string similar to The lifetime signing EKU in the {0}'s certificate is not supported.. + + + + + Looks up a localized string similar to The {0}'s certificate has an unsupported signature algorithm.. + + + + + Looks up a localized string similar to The {0}'s certificate is not yet valid.. + + + + + Looks up a localized string similar to The {0}'s certificate chain validation failed with error(s): {1}. + + + + + Looks up a localized string similar to The {0} validity period has expired.. + + + + + Looks up a localized string similar to The {0} validation failed.. + + + + + Looks up a localized string similar to The {0}'s timestamp certificate does not meet a minimum public key length requirement.. + + + + + Looks up a localized string similar to The {0}'s timestamp's generalized time is outside the timestamping certificate's validity period.. + + + + + Looks up a localized string similar to The {0}'s timestamp integrity check failed.. + + + + + Looks up a localized string similar to The {0} contains an invalid timestamp.. + + + + + Looks up a localized string similar to The {0} timestamp's message imprint uses an unsupported hash algorithm.. + + + + + Looks up a localized string similar to The {0}'s timestamp does not have a signing certificate.. + + + + + Looks up a localized string similar to The {0}'s timestamp signing certificate is not yet valid.. + + + + + Looks up a localized string similar to The {0}'s timestamp signature validation failed.. + + + + + Looks up a localized string similar to The {0}'s timestamp certificate has an unsupported signature algorithm.. + + + + + Looks up a localized string similar to The {0}'s timestamp found a chain building issue: {1}. + + + + + Order dependencies by children first. + + Items to sort. + Comparer for Ids. + Retrieve the id of the item. + Retrieve dependency ids. + + + + + Order dependencies by children first. + + + + + Order dependencies by children first. + + + + + A V3 path resolver. + + + + + Gets the packages directory root folder. + + + + + Gets a flag indicating whether or not package ID's and versions are made lowercase. + + + + + Initializes a new class. + + The packages directory root folder. + + + + Initializes a new class. + + The packages directory root folder. + true if package ID's and versions are made lowercase; + otherwise false. + + + + Gets the package install path. + + The package ID. + The package version. + The package install path. + + + + Gets the package version list path. + + The package ID. + The package version list path. + + + + Gets the package file path. + + The package ID. + The package version. + The package file path. + + + + Gets the manifest file path. + + The package ID. + The package version. + The manifest file path. + + + + Gets the hash file path. + + The package ID. + The package version. + The hash file path. + + + + Gets the hash file name. + + The package ID. + The package version. + The hash file name. + + + + Gets the new hash file path which represents the original hash of the package. + + The package ID. + The package version. + The hash file path. + + + + Gets the version list directory. + + The package ID. + The version list directory. + + + + Gets the package directory. + + The package ID. + The package version. + The package directory. + + + + Gets the package file name. + + The package ID. + The package version. + The package file name. + + + + Gets the package download marker file name. + + The package ID. + The package download marker file name. + + + + Gets the manifest file name. + + The package ID. + The package version. + The manifest file name. + + + + Provides functionality for writing an object graph. + The output format is defined by implementors. + + + + + Writes the start of a nested object. + + This new object becomes the scope for all other method calls until either WriteObjectStart + is called again to start a new nested object or WriteObjectEnd is called. + + Every call to WriteObjectStart must be balanced by a corresponding call to WriteObjectEnd. + + The name of the object. Throws if null. + + + + Writes the end of a nested object. + + The parent object for this object becomes the scope for subsequent method calls. + If this object is the root object, no further writing is allowed. + + Every call to WriteObjectStart must be balanced by a corresponding call to WriteObjectEnd. + + + + + Writes a name-value pair. + + The name of the datum. Throws if null. + The datum. + + + + Writes a name-value pair. + + The name of the datum. Throws if null. + The datum. + + + + Writes a name-value pair. + + The name of the datum. Throws if null. + The datum. + + + + Writes a name-collection pair. + + The name of the data. Throws if null. + The data. + + + + Generates JSON from an object graph. + + This is non-private only to facilitate unit testing. + + + + + Gets the JSON for the object. + + Once is called, no further writing is allowed. + + + + + Gets the JObject (in-memory JSON model) for the object. + + Once is called, no further writing is allowed. + + + + + + Writes the result to a JsonTextWriter. + + Once WriteTo is called, no further writing is allowed. + + + + + Package Id + + + + + Package dependencies + + + + + RID specific package dependencies. + + + + + Merges the content of the other runtime description in to this runtime description + + The other description to merge in to this description + + + + Merges the content of the other runtime graph in to this runtime graph + + The other graph to merge in to this graph + + + + Find all compatible RIDs including the current RID. + + + + + Expand runtimes in a BFS walk. This ensures that nearest RIDs are returned first. + Ordering is important for finding the nearest runtime dependency. + + + + + Determines if two runtime identifiers are compatible, based on the import graph + + The criteria being tested + The value the criteria is being tested against + + true if an asset for the runtime in can be installed in a project + targetting , false otherwise + + + + + Find all possible dependencies for package id. + + + + + Helper for renting hashsets and lists. + + + + + RID + package id + + + + + RID -> RID compatibility key + + + + + A package dependency for a specific RID. + + + + + Dependency package id. + + + + + Dependency version constraint. + + + + + Compares two enumberables for equality, ordered according to the specified key and optional comparer. Handles null values gracefully. + + The type of the list + The type of the sorting key + This list + The other list + The function to extract the key from each item in the list + An optional comparer for comparing keys + An optional comparer for sequences + + + + Compares two sequence for equality, allowing either sequence to be null. If one is null, both have to be + null for equality. + + + + + Compares two sets for equality, allowing either sequence to be null. + If one is null, both have to be null for equality. + + + + + Hash code creator, based on the original NuGet hash code combiner/ASP hash code combiner implementations + + + + + Create a unique hash code for the given set of items + + + + + Create a unique hash code for the given set of items + + + + + Return the enumerable as a List of T, copying if required. Optimized for common case where it is an List of T. + Avoid mutating the return value. + + https://aspnetwebstack.codeplex.com/SourceControl/latest#src/Common/CollectionExtensions.cs + + + + Return the ISet as a HashSet of T, copying if required. Optimized for common case where it is a HashSet of T. + Avoid mutating the return value. + + + +hsYYWopkzHHrntvGYBeJKsfGmEk=BZN1OYa+ujPNb3fRvtrQD0JtMs2wYWE5NyH+g+G5mfXFEBSenPvK4mhGPFwsfy/Bdz14qbP9svtAle1G6HpGXOwT7ra0n5iAPFYF/cXXqs/SmjQFLF5f/lgN+rBmzjzt6j0WnOsL7HIXEjI2I/qX60z/beg0gozYx2PDrVRY8OETE0Xiymi0DYg9XqbuwbtWKk9MmQ/G6xkaQ+oZyF9GDyhNw1T7yURAf8c1a8rvgZTo+GZTEMSt8Sgu6zuyGAv5zqvfWUstUW6moJkAwTXbGzmGUkAc5rZdUK148Jn02lRMMVlQpY4APXFv056hUoBgV0YgW3w62YJEw1r9E/DFtQ==m1K+Tyy0HVPLPV0jHraDo5/A5UrgV7PC+C3WipFfzBLODN0Ct0Z49Gub3ufLICGP1D4OJZRyOnhjZi61X+Hbl/2IjqiIl1VMHR4+qWlJLRNj+X7DparTv3/CBzkhMGY2lZdvp96rpRL2heloKGkmmxqet6/sU3hvw8wxMIf29zYrMEBZSEaAUajNDIDd40qeLXRV7OanRHrVE770wiR9DP0zzeYjX5rN1CltAtUyWmonz7DJAYuUr+UMi3offSITg4byWkvThGNXGmtJeDpU6Y/hhcblP5Yl5175yMvHofLyGw0iW7kv/Izp2yjEVRe26PTXes/9nNOP7ul2KoKMoQ==AQABMIIE2zCCA8OgAwIBAgITMwAAAbHd7bpU6WW4XwABAAABsTANBgkqhkiG9w0BAQUFADB5MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSMwIQYDVQQDExpNaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQTAeFw0xODA3MTIyMDExMTlaFw0xOTA3MjYyMDExMTlaMHQxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xHjAcBgNVBAMTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJtSvk8stB1Tyz1dIx62g6OfwOVK4Fezwvgt1oqRX8wSzgzdArdGePRrm97nyyAhj9Q+DiWUcjp4Y2YutV/h25f9iI6oiJdVTB0ePqlpSS0TY/l+w6Wq079/wgc5ITBmNpWXb6feq6US9oXpaChpJpsanrev7FN4b8PMMTCH9vc2KzBAWUhGgFGozQyA3eNKni10Vezmp0R61RO+9MIkfQz9M83mI1+azdQpbQLVMlpqJ8+wyQGLlK/lDIt6H30iE4OG8lpL04RjVxprSXg6VOmP4YXG5T+WJede+cjLx6Hy8hsNIlu5L/yM6dsoxFUXtuj013rP/ZzTj+7pdiqCjKECAwEAAaOCAV8wggFbMBMGA1UdJQQMMAoGCCsGAQUFBwMDMB0GA1UdDgQWBBREE7QCnXc+kFVx9eQcf6wXFM8+czBQBgNVHREESTBHpEUwQzEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xFjAUBgNVBAUTDTIyOTgwMys0Mzc5NTAwHwYDVR0jBBgwFoAUyxHoytK0FlgByTcuMxYWuUyaCh8wVgYDVR0fBE8wTTBLoEmgR4ZFaHR0cDovL2NybC5taWNyb3NvZnQuY29tL3BraS9jcmwvcHJvZHVjdHMvTWljQ29kU2lnUENBXzA4LTMxLTIwMTAuY3JsMFoGCCsGAQUFBwEBBE4wTDBKBggrBgEFBQcwAoY+aHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraS9jZXJ0cy9NaWNDb2RTaWdQQ0FfMDgtMzEtMjAxMC5jcnQwDQYJKoZIhvcNAQEFBQADggEBAIOp8qYzxaF7HNJegK7spKbD6ShdVyUjjd0lCWlw6E1pFi+UuwXZm4DsWdBoZBuDNKjcz2ONnWt2APV7r0J0B8X8kcDirEUzll2x/fqORrJJ4kMGGZiFcXjTnunblRZBMTRwLEOWogJ3qS89YUpjWfGXfdFSlWCFqLwbRQc/2cGP91D1uX4IieRCxFiOQcCVOEkf1x34ME8pLztHWZI37pch7RdmkBwvLW1r/wt15aoS3fqvxBG04CEyWr8FzkX5P41Wrs5R1syufQQZMBLyv59IJpwOAA0oraXeRC3M1If/lEmVVwxNNJwjCt3DjTIJ9L01KMXe0Ig/qRIToTBwoBE=MIIFvDCCA6SgAwIBAgIKYTMmGgAAAAAAMTANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMTAwODMxMjIxOTMyWhcNMjAwODMxMjIyOTMyWjB5MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSMwIQYDVQQDExpNaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALJyWVwZMGS/HZpgICBCmXZTbD4b1m/My/Hqa/6XFhDg3zp0gxq3L6Ay7P/ewkJOI9VyANs1VwqJyq4gSfTwaKxNS42lvXlLcZtHB9r9Jd+ddYjPqnNEf9eB2/O98jakyVxF3K+tPeAoaJcap6Vyc1bxF5Tk/TWUcqDWdl8ed0WDhTgW0HNbBbpnUo2lsmkv2hkL/pJ0KeJ2L1TdFDBZ+NKNYv3LyV9GMVC5JxPkQDDPcikQKCLHN049oDI9kM2hOAaFXE5WgigqBTK3S9dPY+fSLWLxRT3nrAgA9kahntFbjCZT6HqqSvJGzzc8OJ60d1ylF56NyxGPVjzBrAlfA9MCAwEAAaOCAV4wggFaMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFMsR6MrStBZYAck3LjMWFrlMmgofMAsGA1UdDwQEAwIBhjASBgkrBgEEAYI3FQEEBQIDAQABMCMGCSsGAQQBgjcVAgQWBBT90TFO0yaKleGYYDuoMW+mPLzYLTAZBgkrBgEEAYI3FAIEDB4KAFMAdQBiAEMAQTAfBgNVHSMEGDAWgBQOrIJgQFYnl+UlE/wq4QpTlVnkpDBQBgNVHR8ESTBHMEWgQ6BBhj9odHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9taWNyb3NvZnRyb290Y2VydC5jcmwwVAYIKwYBBQUHAQEESDBGMEQGCCsGAQUFBzAChjhodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFJvb3RDZXJ0LmNydDANBgkqhkiG9w0BAQUFAAOCAgEAWTk+fyZGr+tvQLEytWrrDi9uqEn361917Uw7LddDrQv+y+ktMaMjzHxQmIAhXaw9L0y6oqhWnONwu7i0+Hm1SXL3PupBf8rhDBdpy6WcIC36C1DEVs0t40rSvHDnqA2iA6VW4LiKS1fylUKc8fPv7uOGHzQ8uFaa8FMjhSqkghyT4pQHHfLiTviMocroE6WRTsgb0o9ylSpxbZsa+BzwU9ZnzCL/XB3Nooy9J7J5Y1ZEolHN+emjWFbdmwJFRC9f9Nqu1IIybvyklRPk62nnqaIsvsgrEA5ljpnb9aL6EiYJZTiU8XofSrvR4Vbo0HiWGFzJNRZf3ZMdSY4tvq00RBzuEBUaAF3dNVshzpjHCe6FDoxPbQ4TTj18KUicctHzbMrB7HCjV5JXfZSNoBtIA1r3z6NnCnSlNu0tLxfI5nI3EvRvsTxngvlSso0zFmUeDordEN5k9G/ORtTTF+l5xAS00/ss3x+KnqwK+xMnQK3k+eGpf0a7B2BHZWBATrBC7E7ts3Z52Ao0CW0cgDEf4g5U3eWh++VHEK1kmP9QFi58vwUheuKVQSdpw5OPlcmN2Jshrg1cnPCiroZogwxqLbt2awAdlq3yFnv2FoMkuYjPaqhHMS+a3ONxPdcAfmJH0c6IybgY+g5yjcGjPa8CQGr/aZuW4hCoELQ3UAjWwz0=MIIFmTCCA4GgAwIBAgIQea0WoUqgpa1Mc1j0BxMuZTANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMDEwNTA5MjMxOTIyWhcNMjEwNTA5MjMyODEzWjBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDzXfqAZ9Rap6kMLJAg0DUIPHWEzbcHiZyJ2t7Ow2D6kWhanpRxKRh2fMLgyCV2lA5Y+gQ0Nubfr/eAuulYCyuT5Z0F43cikfc0ZDwikR1e4QmQvBT+/HVYGeF5tweSo66IWQjYnwfKA1j8aCltMtfSqMtL/OELSDJP5uu4rU/kXG8TlJnbldV126gat5SRtHdb9UgMj2p5fRRwBH1tr5D12nDYR7e/my9s5wW34RFgrHmRFHzF1qbk4X7Vw37lktI8ALU2gt554W3ztW74nzPJy1J9c5g224uha6KVl5uj3sJNJv8GlmclBsjnrOTuEjOVMZnINQhONMp5U9W1vmMyWUA2wKVOBE0921sHM+RYv+8/U2TYQlk1V/0PRXwkBE2e1jh0EZcikM5oRHSSb9VLb7CG48c2QqDQ/MHAWvmjYbkwR3GWChawkcBCle8Qfyhq4yofseTNAz93cQTHIPxJDx1FiKTXy36IrY4t7EXbxFEEySr87IaemhGXW97OU4jm4rf9rJXCKEDb7wSQ34EzOdmyRaUjhwalVYkxuwYtYA5BGH0fLrWXyxHrFdUkpZTvFRSJ/Utz+jJb/NEzAPlZYnAHMuouq0Ate8rdIWcbMJmPFqojqEHRsG4RmzbE3kB0nOFYZcFgHnpbOMiPuwQmfNQWQOW2a2yqhv0Av87BNQIDAQABo1EwTzALBgNVHQ8EBAMCAcYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUDqyCYEBWJ5flJRP8KuEKU5VZ5KQwEAYJKwYBBAGCNxUBBAMCAQAwDQYJKoZIhvcNAQEFBQADggIBAMURTQM6YN1dUhF3j7K7NsiyBb+0t6jYIJ1cEwO2HCL6BhM1tshj1JpHbyZX0lXxBLEmX9apUGigvNK4bszD6azfGc14rFl0rGY0NsQbPmw4TDMOMBINoyb+UVMA/69aToQNDx/kbQUuToVLjWwzb1TSZKu/UK99ejmgN+1jAw/8EwbOFjbUVDuVG1FiOuVNF9QFOZKaJ6hbqr3su77jIIlgcWxWs6UT0G0OI36VA+1oPfLYY7hrTbboMLXhypRL96KqXZkwsj2nwlFsKCABJCcrSwC3nRFrcL6yEIK8DJto0I07JIeqmShynTNfWZC99d6TnjpiWjQ54ohVHbkGsMGJay3XacMZEjaE0Mmg2v8vaXiy5Xra69cMwPe9Yxe4ORM4ojZbe/KFVmodZGLBOOKqv1FmopT1EpxmIhBr8rcwki3yKfA9OxRDaKLxnCk3y844ICVtfGfzfiQSJAMIgUfspZ6X9RjXz7vV73aW7/3O21adlaBC+ZdY4dcxItNfWeY+biIA6kOEtiXb2fMIVmjAZGsdfOy2k6JiV24u2OdYj8QxSSbd3ik1h/UwcXBbFDxpvYkSfesuo/7Yf56CWlIKK8FDK9kwiJ/IEPuJjeahhXUzfmye23MTZGJppS99ypZtn/gETTCSPW4hFCHJPeDD/YprnUr90aGdmUN3P7DaMIIGBzCCA++gAwIBAgIKYRZoNAAAAAAAHDANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMDcwNDAzMTI1MzA5WhcNMjEwNDAzMTMwMzA5WjB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCfoWyx39tIkip8ay4Z4b3i48WZUSNQrc7dGE4kD+7Rp9FMrXQwIBHrB9VUlRVJlBtCkq6YXDAm2gBr6Hu97IkHD/cOBJjwicwfyzMkh53y9GccLPx754gd6udOo6HBI1PKjfpFzwnQXq/QsEIEovmmbJNn1yjcRlOwhtDlKEYuJ6yGT1VSDOQDLPtqkJAwbofzWTCd+n7Wl7PoIZd++NIT8wi3U21StEWQn0gASkdmEScpZqiX5NMGgUqi+YSnEUcUCYKfhO1VeP4Bmh1QCIUAEDBG7bfeI0a7xC1Un68eeEExd8yb3zuDk6FhArUdDbH895uyAc4iS1T/+QXDwiALAgMBAAGjggGrMIIBpzAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBQjNPjZUkZwCu1A+3b7syuwwzWzDzALBgNVHQ8EBAMCAYYwEAYJKwYBBAGCNxUBBAMCAQAwgZgGA1UdIwSBkDCBjYAUDqyCYEBWJ5flJRP8KuEKU5VZ5KShY6RhMF8xEzARBgoJkiaJk/IsZAEZFgNjb20xGTAXBgoJkiaJk/IsZAEZFgltaWNyb3NvZnQxLTArBgNVBAMTJE1pY3Jvc29mdCBSb290IENlcnRpZmljYXRlIEF1dGhvcml0eYIQea0WoUqgpa1Mc1j0BxMuZTBQBgNVHR8ESTBHMEWgQ6BBhj9odHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9taWNyb3NvZnRyb290Y2VydC5jcmwwVAYIKwYBBQUHAQEESDBGMEQGCCsGAQUFBzAChjhodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFJvb3RDZXJ0LmNydDATBgNVHSUEDDAKBggrBgEFBQcDCDANBgkqhkiG9w0BAQUFAAOCAgEAEJeKw1wDRDbd6bStd9vOeVFNAbEudHFbbQwTq86+e4+4LtQSooxtYrhXAstOIBNQmd16QOJXu69YmhzhHQGGrLt48ovQ7DsB7uK+jwoFyI1I4vBTFd1Pq5Lk541q1YDB5pTyBi+FA+mRKiQicPv2/OR4mS4N9wficLwYTp2OawpylbihOZxnLcVRDupiXD8WmIsgP+IHGjL5zDFKdjE9K3ILyOpwPf+FChPfwgphjvDXuBfrTot/xTUrXqO/67x9C0J71FNyIe4wyrt4ZVxbARcKFA7S2hSY9Ty5ZlizLS/n+YWGzFFW6J1wlGysOUzU9nm/qhh6YinvopspNAZ3GmLJPR5tH4LwC8csu89Ds+X57H2146SodDW4TsVxIxImdgs8UoxxWkZDFLyzs7BNZ8ifQv+AeSGAnhUwZuhCEl4ayJ4iIdBD6Svpu/RIzCzU2DKATCYqSCRfWupW76bemZ3KOm+9gSd0BhHudiG/m4LBJ1S2sWo9iaF2YbRuoROmv6pH8BJv/YoybLL+31HIjCPJZr2dHYcSZAI9La9Zj7jkIeW1sMpjtHhUBdRBLlCslLCleKuzoJZ1GtmShxN1Ii8yqAhuoFuMJb+g74TKIdbrHk/Jmu5J4PcBZW+JC33Iacjmbuqnl84xKf8OxVtc2E0bodj6L54/LlUWa8kTo/0=MIIE3jCCA8agAwIBAgITMwAAAPfdvzTg5NWCYAAAAAAA9zANBgkqhkiG9w0BAQUFADB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EwHhcNMTgwODIzMjAyMDAyWhcNMTkxMTIzMjAyMDAyWjCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOjdEMkUtMzc4Mi1CMEY3MSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3nEYJOthhViLNfJ3TBvlYEfBf7ap9sFWO/VXhvxgoNT6yJT2ZJjY/WbvzyYr4eaV6xqRUr0WM+sYmOaHioAKaoVRm3rTboJa+ggffCouAAX2MwVp41p3ojfe2HTnAUSiw+G28J6eyggABXmPSbAl0Y7kjibEEnVjNIK5ycYz4B0CefTmxi7LKfTL4JYpyP9IXH1BjUDZ4VszdvN+57LDPc2Wsf5kGGTVizX7znqv99TSoldE0kilSZyfwotZcFRfObsImAYH5r6eMMuC2kJR5kYUCWkt7W5gSZ/wqAL3tEEbkkRR561DjwjfgAY/8CILNRr5NoPCyj2fgr2wlxZeGwIDAQABo4IBCTCCAQUwHQYDVR0OBBYEFFkoL/rgdU0f1ZHJFNOCZplml0/bMB8GA1UdIwQYMBaAFCM0+NlSRnAK7UD7dvuzK7DDNbMPMFQGA1UdHwRNMEswSaBHoEWGQ2h0dHA6Ly9jcmwubWljcm9zb2Z0LmNvbS9wa2kvY3JsL3Byb2R1Y3RzL01pY3Jvc29mdFRpbWVTdGFtcFBDQS5jcmwwWAYIKwYBBQUHAQEETDBKMEgGCCsGAQUFBzAChjxodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFRpbWVTdGFtcFBDQS5jcnQwEwYDVR0lBAwwCgYIKwYBBQUHAwgwDQYJKoZIhvcNAQEFBQADggEBAGLhSXaU0PCtJC8w07NjC/pFMxBbsAr9v0Vx5PFm+R9sglray9H7RCDOc+snob0MdTpqPwHavJqWPrnI/zwWX7C5gb4GtarS08hcTDPEeqCxCQWCdmI1WB5ReZRjcEu4/3Yt0kldEdorv94tu4VNPdHEK54CJ+Zaz7KPEBJNDKW5gUh21Po1nx4f1oIATChhmTGoRJdGi5pOVM+P+LTpAEAD1RwWTNHB1q7ofM3Mwb7q0v81TsDOtXqtu6a7LtyU6fMefeDsKKMHgmZaw1tay+wDyeMslBUhK6D52ZtL57be6yBRjD76LCPVGLDwsaBwbHrvi4NIpjoCBu+giiy3iEU=MIIR+AYJKoZIhvcNAQcCoIIR6TCCEeUCAQMxCzAJBgUrDgMCGgUAMIIBEwYJKoZIhvcNAQcBoIIBBASCAQAFk3U5hr66M81vd9G+2tAPQm0yzbBhYTk3If6D4bmZ9cUQFJ6c+8riaEY8XCx/L8F3PXips/2y+0CV7UboekZc7BPutrSfmIA8VgX9xdeqz9KaNAUsXl/+WA36sGbOPO3qPRac6wvschcSMjYj+pfrTP9t6DSCjNjHY8OtVFjw4RMTReLKaLQNiD1epu7Bu1YqT0yZD8brGRpD6hnIX0YPKE3DVPvJREB/xzVryu+BlOj4ZlMQxK3xKC7rO7IYC/nOq99ZSy1RbqagmQDBNdsbOYZSQBzmtl1QrXjwmfTaVEwxWVCljgA9cW/TnqFSgGBXRiBbfDrZgkTDWv0T8MW1oIIOoTCCBgcwggPvoAMCAQICCmEWaDQAAAAAABwwDQYJKoZIhvcNAQEFBQAwXzETMBEGCgmSJomT8ixkARkWA2NvbTEZMBcGCgmSJomT8ixkARkWCW1pY3Jvc29mdDEtMCsGA1UEAxMkTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5MB4XDTA3MDQwMzEyNTMwOVoXDTIxMDQwMzEzMDMwOVowdzELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEhMB8GA1UEAxMYTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAn6Fssd/bSJIqfGsuGeG94uPFmVEjUK3O3RhOJA/u0afRTK10MCAR6wfVVJUVSZQbQpKumFwwJtoAa+h7veyJBw/3DgSY8InMH8szJIed8vRnHCz8e+eIHernTqOhwSNTyo36Rc8J0F6v0LBCBKL5pmyTZ9co3EZTsIbQ5ShGLieshk9VUgzkAyz7apCQMG6H81kwnfp+1pez6CGXfvjSE/MIt1NtUrRFkJ9IAEpHZhEnKWaol+TTBoFKovmEpxFHFAmCn4TtVXj+AZodUAiFABAwRu233iNGu8QtVJ+vHnhBMXfMm987g5OhYQK1HQ2x/PebsgHOIktU//kFw8IgCwIDAQABo4IBqzCCAacwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUIzT42VJGcArtQPt2+7MrsMM1sw8wCwYDVR0PBAQDAgGGMBAGCSsGAQQBgjcVAQQDAgEAMIGYBgNVHSMEgZAwgY2AFA6sgmBAVieX5SUT/CrhClOVWeSkoWOkYTBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHmCEHmtFqFKoKWtTHNY9AcTLmUwUAYDVR0fBEkwRzBFoEOgQYY/aHR0cDovL2NybC5taWNyb3NvZnQuY29tL3BraS9jcmwvcHJvZHVjdHMvbWljcm9zb2Z0cm9vdGNlcnQuY3JsMFQGCCsGAQUFBwEBBEgwRjBEBggrBgEFBQcwAoY4aHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraS9jZXJ0cy9NaWNyb3NvZnRSb290Q2VydC5jcnQwEwYDVR0lBAwwCgYIKwYBBQUHAwgwDQYJKoZIhvcNAQEFBQADggIBABCXisNcA0Q23em0rXfbznlRTQGxLnRxW20ME6vOvnuPuC7UEqKMbWK4VwLLTiATUJndekDiV7uvWJoc4R0Bhqy7ePKL0Ow7Ae7ivo8KBciNSOLwUxXdT6uS5OeNatWAweaU8gYvhQPpkSokInD79vzkeJkuDfcH4nC8GE6djmsKcpW4oTmcZy3FUQ7qYlw/FpiLID/iBxoy+cwxSnYxPStyC8jqcD3/hQoT38IKYY7w17gX606Lf8U1K16jv+u8fQtCe9RTciHuMMq7eGVcWwEXChQO0toUmPU8uWZYsy0v5/mFhsxRVuidcJRsrDlM1PZ5v6oYemIp76KbKTQGdxpiyT0ebR+C8AvHLLvPQ7Pl+ex9teOkqHQ1uE7FcSMSJnYLPFKMcVpGQxS8s7OwTWfIn0L/gHkhgJ4VMGboQhJeGsieIiHQQ+kr6bv0SMws1NgygEwmKkgkX1rqVu+m3pmdyjpvvYEndAYR7nYhv5uCwSdUtrFqPYmhdmG0bqETpr+qR/ASb/2KMmyy/t9RyIwjyWa9nR2HEmQCPS2vWY+45CHltbDKY7R4VAXUQS5QrJSwpXirs6CWdRrZkocTdSIvMqgIbqBbjCW/oO+EyiHW6x5PyZruSeD3AWVviQt9yGnI5m7qp5fOMSn/DsVbXNhNG6HY+i+ePy5VFmvJE6P9MIIE3jCCA8agAwIBAgITMwAAAPfdvzTg5NWCYAAAAAAA9zANBgkqhkiG9w0BAQUFADB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EwHhcNMTgwODIzMjAyMDAyWhcNMTkxMTIzMjAyMDAyWjCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOjdEMkUtMzc4Mi1CMEY3MSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3nEYJOthhViLNfJ3TBvlYEfBf7ap9sFWO/VXhvxgoNT6yJT2ZJjY/WbvzyYr4eaV6xqRUr0WM+sYmOaHioAKaoVRm3rTboJa+ggffCouAAX2MwVp41p3ojfe2HTnAUSiw+G28J6eyggABXmPSbAl0Y7kjibEEnVjNIK5ycYz4B0CefTmxi7LKfTL4JYpyP9IXH1BjUDZ4VszdvN+57LDPc2Wsf5kGGTVizX7znqv99TSoldE0kilSZyfwotZcFRfObsImAYH5r6eMMuC2kJR5kYUCWkt7W5gSZ/wqAL3tEEbkkRR561DjwjfgAY/8CILNRr5NoPCyj2fgr2wlxZeGwIDAQABo4IBCTCCAQUwHQYDVR0OBBYEFFkoL/rgdU0f1ZHJFNOCZplml0/bMB8GA1UdIwQYMBaAFCM0+NlSRnAK7UD7dvuzK7DDNbMPMFQGA1UdHwRNMEswSaBHoEWGQ2h0dHA6Ly9jcmwubWljcm9zb2Z0LmNvbS9wa2kvY3JsL3Byb2R1Y3RzL01pY3Jvc29mdFRpbWVTdGFtcFBDQS5jcmwwWAYIKwYBBQUHAQEETDBKMEgGCCsGAQUFBzAChjxodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFRpbWVTdGFtcFBDQS5jcnQwEwYDVR0lBAwwCgYIKwYBBQUHAwgwDQYJKoZIhvcNAQEFBQADggEBAGLhSXaU0PCtJC8w07NjC/pFMxBbsAr9v0Vx5PFm+R9sglray9H7RCDOc+snob0MdTpqPwHavJqWPrnI/zwWX7C5gb4GtarS08hcTDPEeqCxCQWCdmI1WB5ReZRjcEu4/3Yt0kldEdorv94tu4VNPdHEK54CJ+Zaz7KPEBJNDKW5gUh21Po1nx4f1oIATChhmTGoRJdGi5pOVM+P+LTpAEAD1RwWTNHB1q7ofM3Mwb7q0v81TsDOtXqtu6a7LtyU6fMefeDsKKMHgmZaw1tay+wDyeMslBUhK6D52ZtL57be6yBRjD76LCPVGLDwsaBwbHrvi4NIpjoCBu+giiy3iEWhggOwMIICmAIBATCB/qGB1KSB0TCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOjdEMkUtMzc4Mi1CMEY3MSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNloiUKAQEwCQYFKw4DAhoFAAMVAJEGz5BbN1f+Y/ytUdiXOrYmBeo3oIHeMIHbpIHYMIHVMQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSkwJwYDVQQLEyBNaWNyb3NvZnQgT3BlcmF0aW9ucyBQdWVydG8gUmljbzEnMCUGA1UECxMebkNpcGhlciBOVFMgRVNOOjRERTktMEM1RS0zRTA5MSswKQYDVQQDEyJNaWNyb3NvZnQgVGltZSBTb3VyY2UgTWFzdGVyIENsb2NrMA0GCSqGSIb3DQEBBQUAAgUA4A/8GjAiGA8yMDE5MDIxNDE0MzkyMloYDzIwMTkwMjE1MTQzOTIyWjB3MD0GCisGAQQBhFkKBAExLzAtMAoCBQDgD/waAgEAMAoCAQACAiU0AgH/MAcCAQACAhpPMAoCBQDgEU2aAgEAMDYGCisGAQQBhFkKBAIxKDAmMAwGCisGAQQBhFkKAwGgCjAIAgEAAgMW42ChCjAIAgEAAgMHoSAwDQYJKoZIhvcNAQEFBQADggEBAAgIxfkoFyG4ibYxZA+gOzeNF89JyXGAzczsRSjwfhQwjNU7ylb1m2eWcVlenFsi7i63JGmyiwwuhhzy20aVwthuLf3LQ28pGPB8pgnugVeZBH/BGUqGyl5fxmlJ0fwC9Ya69oIPht5+acsAmN60jxV9igSXU0lEy4+RkPecHsb0ezkpCR3V2bP8ErwKjcEutbL3+yF/3XkRjqlENG0cBasJjgOxJorYYEW/1/ykIhjdAR2C7VlWEOEDvJp5t8W8NTTb5HXaMsJ2dgbb7r9MCYrf8aBjP/H50l6qtbF7j13dw7XZ6TQZKeWWkRPyu4NJvA/EfC7E1+NXFIlKc6cjguYxggIVMIICEQIBATCBjjB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0ECEzMAAAD33b804OTVgmAAAAAAAPcwCQYFKw4DAhoFAKBdMBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE5MDIxNDIxMDkyN1owIwYJKoZIhvcNAQkEMRYEFDttgKWuezftaAEoAxQftFQCq04VMA0GCSqGSIb3DQEBBQUABIIBAHEF+6g8siGruxmtnOIvVc7sLVuMPkAZ9J2WzAWcsdEkZIFjEt5lGQ0fEYof37CBTZoAC9wvDPnK3MggQazPmTUY8BCa6eYn6HgdRGIdcxt3qUSXnspih6AzSZRZXwuUSeKb9ocE6lyPlviz+OoLX2PBy51XbGOdtKaa5RtN7f1gldTYown5OuJoMCnKTnUDDwAx7SsjeK1DoOXqm49r1mCQCptI+IiOubU6fR+qTAgEgj/dyCj6yXtkHrMgRSYmatKpp5qAEjnmPZpUUHt+OfCXyeAJzcWUyjux/Lm5sylbRD8GZf2inGf2NMYh0DxyZsjlWTqbrN2vVXYOvCfLWhw= diff --git a/packages/FAKE.5.16.0/tools/NuGet.Protocol.dll b/packages/FAKE.5.16.0/tools/NuGet.Protocol.dll new file mode 100644 index 0000000..176092d Binary files /dev/null and b/packages/FAKE.5.16.0/tools/NuGet.Protocol.dll differ diff --git a/packages/FAKE.5.16.0/tools/NuGet.Protocol.xml b/packages/FAKE.5.16.0/tools/NuGet.Protocol.xml new file mode 100644 index 0000000..db8d576 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/NuGet.Protocol.xml @@ -0,0 +1,7697 @@ + + + + NuGet.Protocol + + + + + A caching source repository provider intended to be used as a singleton. + + + + + Retrieve repositories that have been cached. + + + + + Create a repository and add it to the cache. + + + + + Create a repository and add it to the cache. + + + + + Serialize object to the JSON. + + The object. + + + + Deserialize object from the JSON. + + Type of object + JSON representation of object + + + + Deserialize object from the JSON. + + Type of object + JSON representation of object + The settings. + + + + Deserialize object from the JSON. + + JSON representation of object + The object type. + + + + Serialize object to JToken. + + The object. + + + + Deserialize object directly from JToken. + + Type of object. + The JToken to be deserialized. + + + + Deserialize object directly from JToken. + + The JToken to be deserialized. + The object type. + + + + Extract the property directly from JObject. + + Type of property to return. + The JObject to be deserialized. + The property name. + + + + A SemanticVersion JSON converter. + + + + + Gets a flag indicating whether or not a type is convertible. + + An object type to check. + true if is convertible; otherwise false. + + + + Reads the JSON representation of the object. + + A JSON reader. + The type of the object. + The existing value of the object. + A serializer. + A object. + + + + Writes the JSON representation of the object. + + A JSON writer. + A value to serialize. + A serializer. + + + + Retrieve the for a registration. + + Returns an empty sequence if the package does not exist. + + + + Process an individual package version entry + + + + Returns the RemoteSourceDependencyInfo object corresponding to this package version + + + + Retrieve a registration blob + + Returns Null if the package does not exist + + + + Retrieve the target framework from a dependency group obj + + + + + The result of . + + + + + Initializes a new class. + + A download resource result status. + Thrown if + is either or + . + + + + Initializes a new class. + + A package stream. + A package source. + Thrown if is null. + + + + Initializes a new class. + + A package stream. + A package reader. + A package source. + Thrown if is null. + + + + Initializes a new class. + + A package reader. + A package source. + Thrown if is null. + + + + Gets the package . + + The value may be null. + + + + Gets the source containing this package, if not from cache + + The value may be null. + + + + Gets the for the package. + + The value may be null. + + + + Disposes of this instance. + + + + + Base protocol exception type containing a message and optional inner exception. + + + + + Original package identity from the package. + This contains the exact casing for the id and version. + + + + + Gets the package dependecy groups. + + + + + Gets the framework reference groups. + + + + + DependencyInfo + + original package identity + package dependency groups + Sequence of s. + + + + A suggested root folder to drop temporary files under, it will get cleared by the + disposal of the that was used to create this instance. + + + + + Inner cache context. + + + + + Represents a resource provided by a server endpoint (V2 or V3). + + + + + INuGetResourceProviders are imported by SourceRepository. They exist as singletons which span all sources, + and are responsible + for determining if they should be used for the given source when TryCreate is called. + The provider determines the caching. Resources may be cached per source, but they are normally created new + each time + to allow for caching within the context they were created in. + Providers may retrieve other resources from the source repository and pass them to the resources they + create in order + to build on them. + + + + + Attempts to create a resource for this source. + + + The provider may return true but null for the resource if the + provider determines that it should not exist. + + Source repository + True if this provider handles the input source. + + + + Resource type provided + + + + + Name of the provider. This is used for ordering. + + + + + Names of providers this should be ordered BEFORE + Gives this instance a higher priority. + + If provider: default is named here, this provider will be called BEFORE default + + + + Names of providers this should be ordered AFTER. + Gives this instance a lower priority. + + If provider: default is named here, this provider will be called AFTER default + + + + SourceRepositoryProvider composes resource providers into source repositories. + + + + + Retrieve repositories + + + + + Create a repository for one time use. + + + + + Create a repository for one time use. + + + + + Gets the package source provider + + + + + Package metadata only containing select fields relevant to search results processing and presenting. + Immutable. + + + + + Helper class allowing creation/alteration of immutable package metadata objects. + + + + + Shortcut methods to create altered metadata objects with new versions. + + + + + In V2, when finding the list of versions that a package ID has, we also get all of the metadata + associated with each version. It would be wasteful to throw this away, so we store what we have + here. For V3, the metadata property is null. Callers that receive this type need to be able to + fetch this package metadata some other way if this property is null. + + + + + Positions to base providers on + + + + + The first provider called + + + + + The last provider called + + + + + Intended for internal use only: utility method for testing purposes. + + + + + The status of a package action. + + package identity + repository source or null + 0.0 - 1.0 + + + + Completion - 0.0 - 1.0 + + + + + True at 100% completion + + + + + A plugin manager. This manages all the live plugins and their operation claims. + Invoked in by both the credential provider and the PluginResourceProvider + + + + + Gets an environment variable reader. + + This is non-private only to facilitate testing. + + + + Creates a new plugin manager + + This is public to facilitate unit testing. This should not be called from product code + An environment variable reader. + A lazy plugin discoverer. + A plugin factory creator. + Thrown if is null. + Thrown if + is null. + Thrown if + is null. + + + + Disposes of this instance. + This should not be called in production code as this is a singleton instance. + The pattern is implemented because the plugin manager transitively owns objects + that need to implement IDisposable because they potentially have managed and unmanaged resources. + + + + + Find all available plugins on the machine + + + PluginDiscoveryResults + + + + Create plugins appropriate for the given source + + + + Throw if is null + PluginCreationResults + + + + Creates a plugin from the given pluginDiscoveryResult. + This plugin's operations will be source agnostic ones (Authentication) + + plugin discovery result + The requested operation claim + cancellation token + A plugin creation result, null if the requested plugin cannot handle the given operation claim + + + + Creates a plugin from the discovered plugin. + We firstly check the cache for the operation claims for the given request key. + If there is a valid cache entry, and it does contain the requested operation claim, then we start the plugin, and if need be update the cache value itself. + If there is a valid cache entry, and it does NOT contain the requested operation claim, then we return a null. + If there is no valid cache entry or an invalid one, we start the plugin as normally, return an active plugin even if the requested claim is not available, and write a cache entry. + + plugin discovery result + The requested operation claim + plugin request key + package source repository + service index + cancellation token + A plugin creation result, null if the requested plugin cannot handle the given operation claim + + + + Gets the current culture. + An invariant culture's name will be "". Since InitializeRequest has a null or empty check, this can be a problem. + Because the InitializeRequest message is part of a protocol, and the reason why we set the culture is allow the plugins to localize their messages, + we can safely default to en. + + CurrentCulture or an en default if the current culture is invariant + + + + An imperfect sort for provider before/after + + + + + A plugin resource provider. + + This is unsealed only to facilitate testing. + + + + Asynchronously attempts to create a resource for the specified source repository. + + A source repository. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a Tuple<bool, INuGetResource> + Thrown if is null. + Thrown if + is cancelled. + + + + A for plugins. + + + + + Instantiates a new class. + + A plugin. + A plugin multiclient utilities. + A package source. + Thrown if + is null. + Thrown if + is null. + Thrown if + is null. + + + + Asynchronously copies a .nupkg to a stream. + + A package ID. + A package version. + A destination stream. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + indicating whether or not the .nupkg file was copied. + Thrown always. + + + + Asynchronously gets a package downloader for a package identity. + + A package identity. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an . + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + Asynchronously gets all package versions for a package ID. + + A package ID. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is either null or an empty string. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + Asynchronously gets dependency information for a specific package. + + A package id. + A package version. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is either null or an empty string. + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + A collection of package dependency groups with the content (nupkg url). + + + + + DependencyInfo + + package identity + package dependency groups + The content uri for the dependency. + + + + Package identity + + + + + IsListed + + + + + Package dependency groups + + + + + The content url of this resource. + + + + + Create the default source repository provider + + + + + Find sources from nuget.config based on the root path + + lowest folder path + + + + Create a SourceRepository + + + + + Create a SourceRepository + + + + + Create a SourceRepository + + + + + Create a SourceRepository + + + + + + Type this resource provider creates + name used for ordering + providers that this provider should have precendence over + providers that this provider should be called after + + + + Provides methods for resolving a package and its dependencies. This might change based on the new + dependency resolver. + + + + + Retrieve dependency info for a single package. + + package id and version + project target framework. This is used for finding the dependency group + cancellation token + + Returns dependency info for the given package if it exists. If the package is not found null is + returned. + + + + + Retrieve the available packages and their dependencies. + + Includes prerelease packages + package Id to search + project target framework. This is used for finding the dependency group + cancellation token + available packages and their dependencies + + + + Retrieve the available packages and their dependencies. + + Includes prerelease packages + package Id to search + cancellation token + available packages and their dependencies + + + + Finds the download url of a nupkg + + + + + Downloads a package .nupkg with the provided identity. If the package is not available + on the source but the source itself is not down or unavailable, the + will be . + If the operation was cancelled, the will be + . + + + + + A resource capable of fetching packages, package versions and package dependency information. + + + + + Asynchronously gets all package versions for a package ID. + + A package ID. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is either null or an empty string. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + Asynchronously gets dependency information for a specific package. + + A package id. + A package version. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is either null or an empty string. + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + Asynchronously copies a .nupkg to a stream. + + A package ID. + A package version. + A destination stream. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + indicating whether or not the .nupkg file was copied. + Thrown if + is either null or an empty string. + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + Asynchronously gets a package downloader for a package identity. + + A package identity. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an . + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + Read dependency info from a nuspec. + + This also verifies minClientVersion. + + + + An HttpClient configured for the package source + + + + + HttpClientHandler used for credential support. + + + + + Message handler containing the ClientHandler. + + + + + A resource for detecting the capabilities of a V2 feed. + + + + + Basic metadata + + + + + Get all versions of a package + + + + + Get all versions of a package + + + + + True if the package exists in the source + Includes unlisted. + + + + + True if the package exists in the source + + + + + Returns all versions of a package + + + + + Return package metadata for the input PackageIdentity + + + + + Retrieves search results + + + + + Contains logics to push or delete packages in Http server or file system + + + + + Create temporary verification api key endpoint: "create-verification-key/[package id]/[package version]" + + + + + Get the symbols package from the original package. Removes the .nupkg and adds .symbols.nupkg + + + + + Represents a plugin resource. + + + + + Instantiates a new class. + + Plugin creation results. + Thrown if + is null. + Thrown if + is null. + + + + Gets the first plugin satisfying the required operation claims for the current package source. + + The required operation claim. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a . + Thrown if + is cancelled. + + + + Contains logics to push symbol packages in Http server or file system + + + + + A search filter context that represents the UI settings + + + + + Initializes an instance of a and validates required parameters. + + Whether or not to allow prerelease results. + + + + Initializes an instance of a and validates required parameters. + + Whether or not to allow prerelease results. + The filter to apply to the results. + + + + Filter to only the list of packages compatible with these frameworks. + + + + + Include prerelease packages in search + + + + + Include unlisted packages in search + + + + + Restrict the search to certain package types. + + + + + The optional filter type. Absense of this value indicates that all versions should be returned. + + + + + The optional order by. Absense of this value indicates that search results should be ordered by relevance. + + + + + The type of filter to apply to the search. + + + Here are some examples to clarify what these filters mean. Suppose the very latest version is prerelease. + + Version | Prerelease | IsLatestVersion | IsAbsoluteLatestVersion + ------------|------------|-----------------|------------------------ + 8.0.1-beta1 | true | false | false + 8.0.3 | false | false | false + 9.0.1 | false | true | false + 9.0.2-beta1 | true | false | true + + Suppose the very latest version is not prerelease. Notice the latest version is also the absolute latest + version. In other words, a prerelease package cannot be a latest version but a non-prerelease package can be + both the latest version and the absolute latest version. + + Version | Prerelease | IsLatestVersion | IsAbsoluteLatestVersion + ------------|------------|-----------------|------------------------ + 8.0.1-beta1 | true | false | false + 8.0.3 | false | false | false + 9.0.1 | false | true | true + + Suppose there are only prerelease versions. Notice there are no package that has IsLatestVersion as true. + + Version | Prerelease | IsLatestVersion | IsAbsoluteLatestVersion + 8 + ------------|------------|-----------------|------------------------.0.1-beta1 | true | false | false + 9.0.2-beta1 | true | false | true + + + + + + Only select the latest stable version of a package per package ID. Given the server supports + , a package that is should never be + prerelease. Also, it does not make sense to look for a package when also + including prerelease. + + + + + Only select the absolute latest version of a package per package ID. It does not make sense to look for a + when excluding prerelease. + + + + + Order the resulting packages by package ID. + + + + + Cache control settings for the V3 disk cache. + + + + + Path of temp folder if requested by GeneratedTempFolder + + + + + Default amount of time to cache version lists. + + + + + If set, the global disk cache will not be written to or read from. Instead, a temporary directory will be + used. + + + + + If set, the global disk cache will not be written to. + + + + + Package version lists or packages from the server older than this date will be fetched from the server. + + This will be ignored if is true. + If the value is null the default expiration will be used. + + + + Force the in-memory cache to reload. This avoids allowing other calls to populate + the memory cache again from cached files on disk using a different source context. + This should only be used for retries. + + + + + X-NUGET-SESSION + This should be unique for each package operation. + + + + + Package version lists from the server older than this time span + will be fetched from the server. + + + + + Clones the current SourceCacheContext. + + + + + Clones the current cache context and does the following: + 1. Sets MaxAge to Now + 2. RefreshMemoryCache to true + + + + + True if the package is listed and shown in search. + + This property only applies to online sources. + + + + Source repository the dependency information was retrieved from. + + + + + The HTTP, UNC, or local file URI to the package nupkg. + + Optional + + + + Package hash + + Optional + + + + Represents a Server endpoint. Exposes methods to get a specific resource such as Search, Metrics service + and so on for the given server endpoint. + + + + + Pre-determined feed type. + + + + + Source Repository + + source url + Resource providers + + + + Source Repository + + source url + Resource providers + + + + Source Repository + + source url + Resource providers + Restrict the source to this feed type. + + + + Internal default constructor + + + + + Package source + + + + + Find the FeedType of the source. If overridden FeedTypeOverride is returned. + + + + + Returns a resource from the SourceRepository if it exists. + + Expected resource type + Null if the resource does not exist + + + + Returns a resource from the SourceRepository if it exists. + + Expected resource type + Null if the resource does not exist + + + + Returns a resource from the SourceRepository if it exists. + + Expected resource type + Null if the resource does not exist + + + + Returns a resource from the SourceRepository if it exists. + + Expected resource type + Null if the resource does not exist + + + + Initialize provider cache + + + + + + + Get the feed type from the package source. + + + + + SourceRepositoryProvider is the high level source for repository objects representing package sources. + + + + + Non-MEF constructor + + + + + Retrieve repositories + + + + + + Create a repository for one time use. + + + + + Create a repository for one time use. + + + + + Set user agent string on HttpClient to the static string. + + Http client + + + + Failure due to an invalid cache. + + + + + Thrown when a package cannot be found on a feed. + + + + + Package that was not found. + + + + + Core V2 + Core V3 + VS + + + + + Undetermined type + + + + + V2 OData protocol, ex: https://www.nuget.org/api/v2/ + + + + + V3 Json protocol, ex: https://api.nuget.org/v3/index.json + + + + + Flat folder of nupkgs + + + + + Version folder structure used for project.json + + + + + Unzipped folder of nupkgs used by project templates + + + + + Packages.config packages folder format + + + + + Undetermined folder type. Occurs when the folder is empty + or does not exist yet. + + + + + PackageSource that can carry a feed type used to override the source repository and provide a + hint for the expected type. + + + + + Feed type, ex: HttpV2, FileSystemV3 + + + + + Resource wrapper for FeedType. + + + + + Represents source authentication status per active operation + + + + + A wrapper around that applies a + to the contained stream. When the is disposed, this + content is disposed which in turn disposes the , which + disposes the actual network stream. + + + + + Resource wrapper for an HttpClient + + + + + Gets or sets a delegate that is to be invoked when authenticated feed credentials are successfully + used. + + + + + Clones an request. + + + + + Retrieves the HTTP request configuration instance attached to the given message as custom property. + + The HTTP request message. + Configuration instance if exists, or a default instance otherwise. + + + + Attaches an HTTP request configuration instance to the given message as custom property. + If the configuration has already been set on the request message, the old configuration + is replaced. + + The HTTP request message. + An HTTP request message configuration instance. + + + + Factory class containing methods facilitating creation of + with additional custom parameters. + + + + + Creates an instance of . + + Desired HTTP verb + Request URI + Logger instance to be attached + Instance of + + + + Creates an instance of . + + Desired HTTP verb + Request URI + Logger instance to be attached + Instance of + + + + Creates an instance of . + + Desired HTTP verb + Request URI + The request configuration + Instance of + + + + Creates an instance of . + + Desired HTTP verb + Request URI + The request configuration + Instance of + + + + The is for retrying and HTTP request if it times out, has any exception, + or returns a status code of 500 or greater. + + + + + Make an HTTP request while retrying after failed attempts or timeouts. + + + This method accepts a factory to create instances of the because + requests cannot always be used. For example, suppose the request is a POST and contains content + of a stream that can only be consumed once. + + + + + A request to be handled by . This type should contain all + of the knowledge necessary to make a request, while handling transient transport errors. + + + + The HTTP client to use for each request attempt. + + + + The factory that generates each request message. This factory is invoked for each attempt. + + + + The HTTP completion option to use for the next attempt. + + + The maximum number of times to try the request. This value includes the initial attempt. + + + How long to wait on the request to come back with a response. + + + How long to wait before trying again after a failed request. + This API is intended only for testing purposes and should not be used in product code. + + + The timeout to apply to instances. + + + + Additional headers to add to the request. + + + + The retry handler to use for all HTTP requests. + This API is intended only for testing purposes and should not be used in product code. + + + + Caching Get request. + + + + + A cached HTTP request handled by . + + + + + The URI to request with GET. + + + + + The cache key to use when fetching and storing the response from the HTTP cache. This + cache key is scoped to the NuGet source. That is to say that each NuGet source has its + own independent HTTP cache. + + + + + The cache context. + + + + + The header values to apply when building the . + + + + + When processing the , this flag allows + 404 Not Found to be interpreted as a null response. This value defaults + to false. + + + + The maximum number of times to try the request. This value includes the initial attempt. + + + + A method used to validate the response stream. This method should not + dispose the stream and should throw an exception when the content is invalid. + + + + + The timeout to use when fetching the . Since + only uses , + this means that we wait this amount of time for only the HTTP headers to be returned. + Downloading the response body is not included in this timeout. + + + + The timeout to apply to instances. + + + + A mutable CredentialCache wrapper. This allows the underlying ICredentials to + be changed to work around HttpClientHandler not allowing Credentials to change. + This class intentionally inherits from CredentialCache to support authentication on redirects. + According to System.Net implementation any other ICredentials implementation is dropped for security reasons. + + + + + Credentials can be changed by other threads, for this reason volatile + is added below so that the value is not cached anywhere. + + + + + The latest credentials to be used. + + + + + The latest version ID of the . + + + + + Initializes a new instance of the class + + + Optional initial credentials. May be null. + + + + + Used by the HttpClientHandler to retrieve the current credentials. + + + + + A non-cached HTTP request handled by . + + + + + A factory that can be called repeatedly to build the HTTP request message. + + + + + When processing the , this flag allows + 404 Not Found to be interpreted as a null response. This value defaults + to false. + + + + + The timeout to use when fetching the . Since + only uses , + this means that we wait this amount of time for only the HTTP headers to be returned. + Downloading the response body is not included in this timeout. + + + + The maximum number of times to try the request. This value includes the initial attempt. + + + The timeout to apply to instances. + + + + Holds a shared . + This is expected to be shared across the app and should not be disposed of. + + + + + The throttle to apply to all HTTP requests. + + + + + An interface used for throttling operations. For example, suppose the application needs to + limit the concurrency of HTTP operations. Before executing each HTTP operation, the + would be executed. After the HTTP operation has been completed, the + application should call . The implementation of + should only allow the application to continue if there is an appropriate number of concurrent + callers. The primary implementation of this interface simply wraps a . + + + + + Waits until an appropriate level of concurrency has been reached before allowing the + caller to continue. + + + + + Signals that the throttled operation has been completed and other threads can being + their own throttled operation. + + + + + An throttle implementation that allows any level of concurrency. That is, the + and methods do nothing. + + + + + A message handler responsible for retrying request for authenticated proxies + with missing credentials. + + + + + The number of remaining threads that can enter the semaphore. + + + + + Response header that specifies the WSTrust13 Windows Transport endpoint. + + + + + Response header that specifies the realm to authenticate for. In most cases this would be the gallery we are going up against. + + + + + Request header that contains the SAML token. + + + + + Adds the SAML token as a header to the request if it is already cached for this source. + + + + + Attempts to retrieve a SAML token if the response indicates that server requires STS-based auth. + + + + + Convert a V2 feed package into a V3 PackageDependencyInfo + + + + + A resource for detecting a V2 feed's capabilities based on the metadata document. + + + + + This implementation is copied from NuGet 2.x. + + + + + Maximum amount of time to store index.json + + + + + Represents a V2 package entry from the OData feed. This object primarily just holds the strings parsed from XML, all parsing + and converting should be done after based on the scenario. + + + + + Parse DownloadCount into an integer + + + + + Checks the published date + + + + + Parses Dependencies into actual groups + + + + + A page of items from a V2 feed as well as a link to get the next page. + + + + + A light weight XML parser for NuGet V2 Feeds + + + + + Creates a V2 parser + + HttpSource and message handler containing auth/proxy support + base address for all services from this OData service + + + + Creates a V2 parser + + HttpSource and message handler containing auth/proxy support + base address for all services from this OData service + PackageSource useful for reporting meaningful errors that relate back to the configuration + + + + Get an exact package + + + + + Retrieves all packages with the given Id from a V2 feed. + + + + + Retrieves all packages with the given Id from a V2 feed. + + + + + Finds all entries on the page and parses them + + + + + Parse an entry into a V2FeedPackageInfo + + + + + Retrieve an XML value safely + + + + + Retrieve an XML value safely + + + + + Build the path part of a V2 feed URL. These values are appended to the V2 base URL. + + + + + Packages.config packages folder reader + + + + + Reads packages.config packages folders. The expected format is root/id.version/id.version.nupkg + This resource cannot handle packages folders in the format root/id (exclude version) + + + + + Unzipped package repository reader used for project templates. + + + + + Id + Version -> Package + + + + + Uri -> Package + + + + + Retrieve packages from a local folder or UNC share that uses the V3 folder structure. + + + + + Retrieve dependency info for a single package. + + package id and version + project target framework. This is used for finding the dependency group + cancellation token + + + + Retrieve dependency info for a single package. + + package id + project target framework. This is used for finding the dependency group + cancellation token + + + + Convert a package into a PackageDependencyInfo + + + + + Local nuget package. + + Package id and version. + Path to the nupkg. + Last nupkg write time for publish date. + Nuspec XML. + Method to retrieve the package as a reader. + + + + Package id and version. + + + + + Nupkg or folder path. + + + + + Last file write time. This is used for the publish date. + + + + + Package reader. + + This creates a new instance each time. Callers need to dispose of it. + + + + Nuspec reader. + + + + + Search Id, Tags, and Description to match the legacy local search behavior. + + + + + Returns a distinct set of elements using the comparer specified. This implementation will pick the last occurrence + of each element instead of picking the first. This method assumes that similar items occur in order. + + + + + A resource capable of fetching packages, package versions and package dependency information. + + + + + Initializes a new class. + + A package source. + Thrown if + is null. + + + + Asynchronously gets all package versions for a package ID. + + A package ID. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is either null or an empty string. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + Asynchronously copies a .nupkg to a stream. + + A package ID. + A package version. + A destination stream. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + indicating whether or not the .nupkg file was copied. + Thrown if + is either null or an empty string. + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + Asynchronously gets dependency information for a specific package. + + A package id. + A package version. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is either null or an empty string. + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + Asynchronously gets a package downloader for a package identity. + + A package identity. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an . + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + A v2-style package repository that has nupkgs at the root. + + + + + A resource capable of fetching packages, package versions and package dependency information. + + + + + Nuspec files read from disk. + This is exposed to allow sharing the cache with other components + that are reading the same files. + + + + + Initializes a new class. + + A package source. + Thrown if + is null. + + + + Asynchronously gets all package versions for a package ID. + + A package ID. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is either null or an empty string. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + Asynchronously copies a .nupkg to a stream. + + A package ID. + A package version. + A destination stream. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + indicating whether or not the .nupkg file was copied. + Thrown if + is either null or an empty string. + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + Asynchronously gets dependency information for a specific package. + + A package id. + A package version. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is either null or an empty string. + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + Asynchronously gets a package downloader for a package identity. + + A package identity. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an . + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + A v3-style package repository that has expanded packages. + + + + + Convert a string to a URI safely. This will return null if there are errors. + + + + + Subclass of containing the information in the registration blobs that are not present in the V2 feed or search. + Returned by . + + + + + The of this package in the catalog. + + + + + index.json entry for v3 + + + + + Service Uri + + + + + Service Type + + + + + Client version + + + + + Allow .nuspec files on disk to be cached across v3 folder readers. + Allow the list of files in a package to be cached across all projects. + + It is expected that the caller has already verified the that folder and paths are valid. + + + + Read a nuspec file from disk. The nuspec is expected to exist. + + + + + Read a the package files from disk. + + + + + Read the .metadata.json file from disk. + + Throws if the file is not found or corrupted. + + + + True if the path exists on disk. This also uses + the SHA512 cache for already read files. + + + + + Read runtime.json from a package. + Returns null if runtime.json does not exist. + + + + + Read files from a package folder. + + + + + True if the file should be added to the lock file library + Fale if it is an OPC file or empty directory + + + + + Search for a nuspec using the given path, or by the expanded folder path. + The manifest path here is a shortcut to use the already constructed well + known location, if this doesn't exist the folder reader will find the nuspec + if it exists. + + + + + Return runtime.json from a package. + + + + + An automatic progress reporter. + + + + + Disposes of this instance. + + + + + Creates a new class. + + This class does not take ownership of and dispose of . + A connection. + A request. + A progress interval. + A cancellation token. + Thrown if + is null. + Thrown if + is null. + Thrown if + is either less than or greater than + . + Thrown if + is cancelled. + + + + Represents a bidirectional channel between a NuGet client and a plugin. + + + + + The connection state. + + + + + Occurs when an unrecoverable fault has been caught. + + + + + Occurs when a message has been received. + + + + + Gets the message dispatcher. + + + + + Gets the connection options + + + + + Gets the negotiated protocol version, or null if not yet connected. + + + + + Instantiates a new instance of the class. + + A message dispatcher. + A sender. + A receiver. + Connection options. + Thrown if is null. + Thrown if is null. + Thrown if is null. + Thrown if is null. + + + + Disposes of this instance. + + + + + Closes the connection. + + This does not call . + + + + Asynchronously connects and handshakes with a remote target. + + A cancellation token. + A task that represents the asynchronous operation. + Thrown if + is cancelled. + Thrown if the method has been called already. + + + + Asynchronously sends a message to the remote target. + + The message to be sent. + A cancellation token. + A task that represents the asynchronous operation. + Thrown if is null. + Thrown if + is cancelled. + Thrown if not connected. + + + + Asynchronously sends a message to the remote target and receives the target's response. + + The outbound payload type. + The inbound payload type. + The outbound message method. + The outbound message payload. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a + from the target. + Thrown if + is cancelled. + Thrown if not connected. + + + + Plugin connection options. + + + + + Gets the plugin handshake timeout. + + + + + Gets the minimum plugin protocol version. + + + + + Gets the plugin protocol version. + + + + + Gets the plugin request timeout. + + + + + Instantiates a new class. + + The plugin protocol version. + The minimum plugin protocol version. + The plugin handshake timeout. + The plugin request timeout. + Thrown if + is null. + Thrown if + is null. + Thrown if + is null. + Thrown if + is less than . + Thrown if + is either less than or greater than + . + Thrown if + is either less than or greater than + . + + + + Sets a new request timeout. + + The new request timeout. + Thrown if + is either less than or greater than + . + + + + Instantiates a class with default values. + + An environment variable reader. + A . + + + + Connection states. + + Member order is significant. + For example, any connection state before + implies no connection. + + + + Base class for embedded signature verifiers. + + + + + Checks if a file has a valid embedded signature. + + The path of a file to be checked. + true if the file has a valid signature; otherwise, false. + Thrown if + is either null or an empty string. + Thrown if the current platform is unsupported. + + + + Creates an embedded signature verifier for the current platform. + + An embedded signature verifier. + + + + A fallback embedded signature verifier for unsupported platforms. + + + + + Checks if a file has a valid embedded signature. + + The path of a file to be checked. + true if the file has a valid signature; otherwise, false. + Thrown always. + + + + Faulted plugin event arguments. + + + + + Gets the exception. + + + + + Gets the plugin. + + + + + Instantiates a new class. + + A plugin. + An exception. + Thrown if is null. + Thrown if is null. + + + + Represents a bidirectional channel between a NuGet client and a plugin. + + + + + Occurs when an unrecoverable fault has been caught. + + + + + Occurs when a message has been received. + + + + + Gets the message dispatcher. + + + + + Gets the connection options + + + + + Gets the negotiated protocol version, or null if not yet connected. + + + + + Closes the connection. + + This does not call . + + + + Asynchronously sends a message to the remote target. + + The message to be sent. + A cancellation token. + A task that represents the asynchronous operation. + Thrown if is null. + Thrown if + is cancelled. + Thrown if not connected. + + + + Asynchronously sends a message to the remote target and receives the target's response. + + The outbound payload type. + The inbound payload type. + The outbound message method. + The outbound message payload. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a + from the target. + Thrown if + is cancelled. + Thrown if not connected. + + + + A unique identifier generator. + + + + + Generates a new unique identifier. + + A unique identifier. + + + + A message dispatcher that maintains state for outstanding requests + and routes messages to configured request handlers. + + + + + Gets the request handlers for use by the dispatcher. + + + + + Closes the dispatcher. + + This does not call . + + + + Creates a message. + + The message type. + The message method. + A message. + + + + Creates a message. + + The message payload. + The message type. + The message method. + The message payload. + A message. + + + + Asynchronously dispatches a cancellation request for the specified request. + + The request. + A cancellation token. + A task that represents the asynchronous operation. + + + + Asynchronously dispatches a fault notification for the specified request. + + The cancel request. + The fault payload. + A cancellation token. + A task that represents the asynchronous operation. + + + + Asynchronously dispatches a progress notification for the specified request. + + The request. + The progress payload. + A cancellation token. + A task that represents the asynchronous operation. + + + + Asynchronously dispatches a request. + + The request payload type. + The expected response payload type. + The request method. + The request payload. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a + from the target. + + + + Asynchronously dispatches a response. + + The request payload type. + The associated request. + The response payload. + A cancellation token. + A task that represents the asynchronous operation. + + + + Sets the connection to be used for dispatching messages. + + A connection instance. Can be null. + + + + Context for an inbound request. + + + + + Gets the request ID. + + + + + Initializes a new class. + + A connection. + A request ID. + A cancellation token. + Thrown if + is null. + Thrown if + is either null or an empty string. + + + + Disposes of this instance. + + + + + Asynchronously starts processing a fault response for the inbound request. + + The request. + An exception. + Thrown if + is either null. + Thrown if + is null. + + + + Asynchronously starts processing a response for the inbound request. + + The request. + A request handler. + A response handler. + Thrown if + is null. + Thrown if + is null. + Thrown if + is null. + + + + Cancels an inbound request. + + + + + Represents a plugin. + + + + + Occurs before the plugin closes. + + + + + Occurs when the plugin has closed. + + + + + Gets the connection for the plugin. + + + + + Gets the file path for the plugin. + + + + + Gets the unique identifier for the plugin. + + + + + Gets the name of the plugin. + + + + + Closes the plugin. + + This does not call . + + + + A plugin discoverer. + + + + + Asynchronously discovers plugins. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is cancelled. + + + + A plugin factory. + + + + + Asynchronously gets an existing plugin instance or creates a new instance and connects to it. + + The file path of the plugin. + Command-line arguments to be supplied to the plugin. + Request handlers. + Connection options. + A cancellation token for the plugin's lifetime. + A task that represents the asynchronous operation. + The task result () returns a + instance. + Thrown if + is either null or empty. + Thrown if + is null. + Thrown if + is null. + Thrown if + is null. + Thrown if + is cancelled. + Thrown if this object is disposed. + This is intended to be called by NuGet client tools. + + + + Create plugins appropriate for the given source + + + + Throw if is null + PluginCreationResults + + + + Find all available plugins on the machine + + + PluginDiscoveryResults + + + + Creates a plugin from the given pluginDiscoveryResult. + This plugin's operations will be source agnostic ones + + + + A PluginCreationResult + + + + Plugin multiclient utilities. + + + + + Asynchronously executes a task once per plugin lifetime per key. + + A key that identifies the task. + A function that returns a task. + A cancellation token. + A task that represents the asynchronous operation. + Thrown if + is either null or an empty string. + Thrown if + is either null. + Thrown if + is cancelled. + + + + Represents a plugin process. + + + + + Occurs when a line of output has been received. + + + + + Occurs when a process exits. + + + + + Gets a value indicating whether the associated process has been terminated. + + + + + Asynchronously starts reading the standard output stream. + + + + + Cancels asynchronous reading of the standard output stream. + + + + + Immediately stops the associated process. + + + + + Represents a unidirectional communications channel from a target. + + + + + Occurs when an unrecoverable fault has been caught. + + + + + Occurs when a message has been received. + + + + + Closes the connection. + + This does not call . + + + + Connects. + + Thrown if this object is disposed. + Thrown if this object is closed. + Thrown if this method has already been called. + + + + Represents a request handler. + + + + + Gets the for a request. + + + + + Asynchronously handles responding to a request. + + The connection. + A request message. + A response handler. + A cancellation token. + A task that represents the asynchronous operation. + Thrown if + is null. + Thrown if is null. + Thrown if + is null. + Thrown if + is cancelled. + + + + A set of . + + + + + Atomically add or update a request handler for the specified message method. + + A message method. + An add request handler function. + An update request handler function. + Thrown if + is null. + Thrown if + is null. + + + + Attempts to add a request handler for the specified message method. + + A message method. + A request handler. + true if added; otherwise, false. + Thrown if is null. + + + + Attempts to get a request handler for the specified message method. + + A message method. + A request handler. + true if the request handler exists; otherwise, false. + + + + Attempts to remove a request handler for the specified message method. + + A message method. + true if a request handler was removed; otherwise, false. + + + + A response handler. + + + + + Asynchronously handles responding to a request. + + The response payload type. + The request message. + The response payload. + A cancellation token. + A task that represents the asynchronous operation. + Thrown if is null. + Thrown if is null. + Thrown if + is cancelled. + + + + Represents a unidirectional communications to a target. + + + + + Closes the connection. + + This does not call . + + + + Connects. + + Thrown if this object is disposed. + Thrown if this object is closed. + Thrown if this method has already been called. + + + + Asynchronously sends a message to the target. + + The message to send. + A cancellation token. + A task that represents the asynchronous operation. + Thrown if this object is disposed. + Thrown if has not been called. + Thrown if is null. + Thrown if + is cancelled. + + + + JSON serialization/deserialization utilities. + + + + + Gets the JSON serializer. + + + + + Deserializes an object from the provided JSON. + + The deserialization type. + JSON to deserialize. + An instance of . + Thrown if + is either null or an empty string. + + + + Serializes an object. + + An object to serialize. + A . + Thrown if is null. + + + + Serializes an object to the provided writer. + + A JSON writer. + The value to serialize. + Thrown if is null. + + + + Deserializes an object. + + The deserialization type. + A JSON object. + An instance of . + Thrown if is null. + + + + Line read event arguments. + + + + + The output line read. + + + + + Instantiates a new class. + + The output line read. + + + + A message dispatcher that maintains state for outstanding requests + and routes messages to configured request handlers. + + + + + Gets the request handlers for use by the dispatcher. + + + + + Instantiates a new class. + + Request handlers. + A unique identifier generator. + Thrown if + is null. + Thrown if + is null. + + + + Disposes of this instance. + + + + + Closes the dispatcher. + + This does not call . + + + + Creates a message. + + The message type. + The message method. + A message. + + + + Creates a message. + + The message payload. + The message type. + The message method. + The message payload. + A message. + Throws if is null. + + + + Asynchronously dispatches a cancellation request for the specified request. + + The request. + A cancellation token. + A task that represents the asynchronous operation. + Thrown if is null. + Thrown if + is cancelled. + + + + Asynchronously dispatches a fault notification for the specified request. + + The cancel request. + The fault payload. + A cancellation token. + A task that represents the asynchronous operation. + Thrown if is null. + Thrown if + is cancelled. + + + + Asynchronously dispatches a progress notification for the specified request. + + The request. + The progress payload. + A cancellation token. + A task that represents the asynchronous operation. + Thrown if is null. + Thrown if is null. + Thrown if + is cancelled. + + + + Asynchronously dispatches a request. + + The request payload type. + The expected response payload type. + The request method. + The request payload. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a + from the target. + Thrown if + is cancelled. + + + + Asynchronously dispatches a response. + + The request payload type. + The associated request. + The response payload. + A cancellation token. + A task that represents the asynchronous operation. + Thrown if is null. + Thrown if is null. + Thrown if + is cancelled. + + + + Sets the connection to be used for dispatching messages. + + A connection instance. Can be null. + + + + Message event arguments. + + + + + Gets the message. + + + + + Instantiates a new class. + + A message. + Thrown if is null. + + + + Message methods. + + + + + None + + + + + Close + + + + + Copy files in a package + + + + + Copy a .nupkg file + + + + + Get credentials + + + + + Get files in a package + + + + + Get operation claims + + + + + Get package hash + + + + + Get package versions + + + + + Get service index + + + + + Handshake + + + + + Initialize + + + + + Log + + + + + Monitor NuGet process exit + + + + + Prefetch a package + + + + + Set credentials + + + + + Set log level + + + + + Get authentication credentials, for authentication operation + + + + + Message response codes. + + + + + The response is success. + + + + + The response is error. + + + + + The response is not found. + + + + + A request to copy files in a package to a specified destination. + + + + + Gets the destination folder path. + + + + + Gets the files in the package to be copied. + + + + + Gets the package ID. + + + + + Gets the package source repository location. + + + + + Gets the package version. + + + + + Initializes a new class. + + The package source repository location. + The package ID. + The package version. + The files in the package to be copied. + The destination folder path. + Thrown if + is either null or an empty string. + Thrown if + is either null or an empty string. + Thrown if + is either null or an empty string. + Thrown if + is either null or empty. + Thrown if + is either null or an empty string. + + + + A response to a copy package files request. + + + + + Gets the paths of files copies. + + + + + Gets the response code. + + + + + Initializes a new class. + + The response code. + The paths of files copies. + Thrown if + is an undefined value. + Thrown if + is and + is either null or empty. + + + + A request to copy a .nupkg file. + + + + + Gets the destination file path for the .nupkg file. + + + + + Gets the package ID. + + + + + Gets the package source repository location. + + + + + Gets the package version. + + + + + Initializes a new class. + + The package source repository location. + The package ID. + The package version. + The destination file path for the .nupkg file. + Thrown if + is either null or an empty string. + Thrown if + is either null or an empty string. + Thrown if + is either null or an empty string. + Thrown if + is either null or an empty string. + + + + A response to a copy .nupkg file request. + + + + + Gets the response code. + + + + + Initializes a new class. + + The response code. + Thrown if + is an undefined value. + + + + A notification indicating the sender has experienced an unrecoverable fault. + + + + + Gets the fault message. + + + + + Initializes a new instance of the class. + + The fault message. + Thrown if + is either null or an empty string. + + + + A get authentication credentials request + + + + + Uri + + + + + isRetry + + + + + IsNonInteractive - tells the plugin whether it can block the operation to ask for user input. Be it a device flow request or a pop-up. + + + + + CanShowDialog - tells the plugin whether it can show a dialog if the plugin is run in interactive mode. This being false normally means that the auth method should be device flow. + + + + + Create a GetAuthenticationCredentialsRequest + + + + + if is null + + + + A get authentication credentials response + + + + + Username + + + + + password token + + + + + message - optional, can be used as a way to communicate to NuGet why the authentication failed. + + + + + Gets or sets the list of authentication types this credential is applicable to. Useful values include + basic, digest, negotiate, and ntlm + + + + + ResponseCode - status of the credentials + + + + + Create a response object + + + + + + + If MessageResponseCode is not defined on this runtime + + + + Gets a value indicating whether the provider returnd a valid response. + + + Either Username or Password (or both) must be set, and AuthTypes must either be null or contain at least + one element + + + + + A request to get credentials. + + + + + Gets the package source repository location. + + + + + Gets the HTTP status code that necessitates credentials. + + + + + Initializes a new class. + + The package source repository location. + The HTTP status code. + + + + A response to a get credentials request. + + + + + Gets the password. + + + + + Gets the response code. + + + + + Gets the username. + + + + + Initializes a new instance of the class. + + The plugin's response code. + Thrown if + is an undefined value. + + + + A get files in package request. + + + + + Gets the package ID. + + + + + Gets the package source repository location. + + + + + Gets the package version. + + + + + Initializes a new class. + + The package source repository location. + The package ID. + The package version. + Thrown if + is either null or an empty string. + Thrown if + is either null or an empty string. + Thrown if + is either null or an empty string. + + + + A response to a get files in package request. + + + + + Gets the paths of files in the package. + + + + + Gets the response code. + + + + + Initializes a new class. + + The response code. + The paths of files in the package. + Thrown if + is an undefined value. + Thrown if + is and + is either null or empty. + + + + A query to a plugin about which operations it supports for a specific package source. + In version 1.0.0, the fields are required. That's not the case for version 2.0.0 + + + + + Gets the package source repository location for the . + + + + + Gets the service index (index.json) for the . + + + + + Initializes a new instance of the class. + + The package source location. + The service index (index.json). + Both packageSourceRepository and service index can be null. If they are, the operation claims request is considered as source agnostic + + + + A plugin's response as to which operations it supports for a specific package source. + + + + + Gets the plugin's operation claims. + + + + + Initializes a new instance of the class. + + The operation claims. + Thrown if is null. + Thrown if contains + undefined values. + + + + A request to get a package hash. + + + + + Gets the hash algorithm. + + + + + Gets the package ID. + + + + + Gets the package source repository location. + + + + + Gets the package version. + + + + + Initializes a new class. + + The package source repository location. + The package ID. + The package version. + The hash algorithm. + Thrown if + is either null or an empty string. + Thrown if + is either null or an empty string. + Thrown if + is either null or an empty string. + Thrown if + is either null or an empty string. + + + + A response to a get package hash request. + + + + + Gets the package hash. + + + + + Gets the response code. + + + + + Initializes a new class. + + The response code. + Thrown if + is an undefined value. + Thrown if + is and + is either null or empty. + + + + A request for package versions. + + + + + Gets the package ID. + + + + + Gets the package source repository location. + + + + + Initializes a new class. + + The package source repository location. + The package ID. + Thrown if + is either null or an empty string. + Thrown if + is either null or an empty string. + + + + A response to a get package versions request. + + + + + Gets the response code. + + + + + Gets the package versions. + + + + + Initializes a new class. + + The response code. + The package versions. + Thrown if + is an undefined value. + Thrown if + is and + is either null or empty. + + + + A request to get the service index for a package source repository. + + + + + Gets the package source repository location. + + + + + Initializes a new class. + + The package source repository location. + + + + A response to a get service index request. + + + + + Gets the response code. + + + + + Gets the service index (index.json) for the package source repository. + + + + + Initializes a new instance of the class. + + The response code. + The service index (index.json) for the package source repository. + Thrown if + is an undefined value. + Thrown if + is and + is null. + + + + A handshake request. + + + + + Gets the requestor's plugin protocol version. + + + + + Gets the requestor's minimum plugin protocol version. + + + + + Initializes a new instance of the class. + + The requestor's plugin protocol version. + The requestor's minimum plugin protocol version. + Thrown if + is null. + Thrown if + is null. + Thrown if + is less than . + + + + A handshake response. + + + + + Gets the handshake responder's handshake response code. + + + + + Gets the handshake responder's plugin protocol version if the handshake was successful; + otherwise, null. + + + + + Initializes a new instance of the class. + + The handshake responder's handshake response code. + The handshake responder's plugin protocol version + if the handshake was successful; otherwise, null. + Thrown if + is an undefined value. + Thrown if + is and + is null. + Thrown if + is not and + is not null. + + + + An initialization request to a plugin. + + + + + Gets the requestor's NuGet client version. + + + + + Gets the requestor's current culture. + + + + + Gets the default request timeout for all subsequent requests. + + + + + Initializes a new instance of the class. + + The requestor's NuGet client version. + The requestor's current culture. + The default request timeout. + Thrown if is either null + or an empty string. + Thrown if is either null + or an empty string. + Thrown if + is either less than or greater than + . + + + + An initialization response from a plugin. + + + + + Gets the plugin's initialization response code. + + + + + Initializes a new instance of the class. + + The plugin's initialization response code. + Thrown if + is an undefined value. + + + + A logging request. + + + + + Gets the logging level for the message. + + + + + Gets the message. + + + + + Initializes a new instance of the class. + + The logging level for the message. + The message to be logged. + Thrown if is an undefined + value. + Thrown if is either null + or an empty string. + + + + A logging response. + + + + + Gets the logging response code. + + + + + Initializes a new instance of the class. + + The logging response code. + Thrown if + is an undefined value. + + + + Represents a message between a NuGet client and a plugin. + + + + + Gets the request ID. + + + + + Gets the message type. + + + + + Gets the message method. + + + + + Gets the optional message payload. + + + + + Initializes a new instance of the class. + + The request ID. + The message type. + The message method. + An optional message payload. + Thrown if + is either null or an empty string. + Thrown if + is an undefined value. + Thrown if + is an undefined value. + + + + A request to monitor a NuGet process exit. + + + + + Gets the process ID. + + + + + Initializes a new class. + + The process ID. + + + + A response to a monitor NuGet process exit request. + + + + + Gets the response code. + + + + + Initializes a new instance of the class. + + The plugin's response code. + Thrown if + is an undefined value. + + + + A request to a plugin to prefetch a package. + + + + + Gets the package ID. + + + + + Gets the package source repository location. + + + + + Gets the package version. + + + + + Initializes a new class. + + The package source repository location. + The package ID. + The package version. + Thrown if + is either null or an empty string. + Thrown if + is either null or an empty string. + Thrown if + is either null or an empty string. + + + + A plugin's response to a package prefetch request. + + + + + Gets the plugin's response code. + + + + + Initializes a new instance of the class. + + The plugin's response code. + Thrown if + is an undefined value. + + + + A progress notification. + + + + + Gets the progress percentage. + + + + + Initializes a new instance of the class. + + The progress percentage. + + + + A request to set credentials for a package source with any last known good credentials. + + + + + Gets the package source repository location. + + + + + Gets the package source repository password. + + + + + Gets the proxy password. + + + + + Gets the proxy username. + + + + + Gets the package source repository username. + + + + + Initializes a new class. + + The package source repository location. + The proxy username. + The proxy password. + The package source repository username. + The package source repository password. + + + + A plugin's response to a set credentials request. + + + + + Gets the plugin's response code. + + + + + Initializes a new instance of the class. + + The plugin's response code. + Thrown if + is an undefined value. + + + + A request to set the log level. + + + + + Gets the log level. + + + + + Initializes a new class. + + The log level. + Thrown if is an undefined + value. + + + + A response to a log level set request. + + + + + Gets the response code. + + + + + Initializes a new class. + + The response code. + Thrown if + is an undefined value. + + + + Message types. + + + + + A cancellation request for an existing request. + + + + + A fault notification, either standalone or for an existing request. + + + + + A progress notification for an existing request. + + + + + A request. + + + + + A response for an existing request. + + + + + Helper methods for messages. + + + + + Instantiates a new class. + + The message request ID. + The message type. + The message method. + a instance. + Thrown if + is either null or an empty string. + + + + Instantiates a new class. + + The message payload type. + The message request ID. + The message type. + The message method. + The message payload. + a instance. + Thrown if + is either null or an empty string. + Thrown if is null. + + + + Deserializes a message payload. + + The message payload type. + The message. + The deserialized message payload of type + or null if no payload exists. + Thrown if is null. + + + + A plugin wrapper that no-ops IDisposable. + + + + + Occurs before the plugin closes. + + + + + Occurs when the plugin has closed. + + + + + Gets the connection for the plugin. + + + + + Gets the file path for the plugin. + + + + + Gets the unique identifier for the plugin. + + + + + Gets the name of the plugin. + + + + + Instantiates a new class. + + A plugin + Thrown if is null. + + + + Does nothing. + + Plugin disposal is implemented elsewhere. + + + + Closes the plugin. + + This does not call . + + + + Plugin operation claims. + + + + + The download package operation claim. + + + + + The authentication operation claim + + + + + Context for an outbound request. + + + + + Gets the . + + + + + Gets the request ID. + + + + + Disposes of this instance. + + + + + Handles a cancellation response for the outbound request. + + + + + Handles progress notifications for the outbound request. + + A progress notification. + Thrown if is null. + + + + Handles a response for the outbound request. + + A response. + Thrown if is null. + + + + Handles a fault response for the outbound request. + + A fault response. + Thrown if is null. + + + + Context for an outbound request. + + The response payload type. + + + + Gets the completion task. + + + + + Initializes a new class. + + A connection. + A request. + An optional request timeout. + A flag indicating whether or not the request supports progress notifications + to reset the request timeout. + A cancellation token. + Thrown if + is null. + Thrown if + is null. + Thrown if + is cancelled. + + + + Handles a cancellation response for the outbound request. + + + + + Handles progress notifications for the outbound request. + + A progress notification. + Thrown if is null. + + + + Handles a response for the outbound request. + + A response. + Thrown if is null. + + + + Handles a fault response for the outbound request. + + A fault response. + Thrown if is null. + + + + Represents a plugin. + + + + + Occurs before the plugin closes. + + + + + Occurs when the plugin has closed. + + + + + Occurs when a plugin process has exited. + + + + + Occurs when a plugin or plugin connection has faulted. + + + + + Occurs when a plugin has been idle for the configured idle timeout period. + + + + + Gets the connection for the plugin + + + + + Gets the file path for the plugin. + + + + + Gets the unique identifier for the plugin. + + + + + Gets the name of the plugin. + + + + + Instantiates a new class. + + The plugin file path. + The plugin connection. + The plugin process. + true if is the current process; + otherwise, false. + The plugin idle timeout. Can be . + Thrown if is either null + or an empty string. + Thrown if is null. + Thrown if is null. + Thrown if is smaller than + . + + + + Disposes of this instance. + + + + + Closes the plugin. + + This does not call . + + + + This class represents a plugin operations cache entry. + It contains expiry logic, read/write/update logic. + + + + + Create a plugin cache entry. + + The root cache folder, normally /localappdata/nuget/plugins-cache + The full plugin file path, which will be used to create a key for the folder created in the root folder itself + A unique request key for the operation claims. Ideally the packageSourceRepository value of the PluginRequestKey. Example https://protected.package.feed/index.json, or Source-Agnostic + + + + Loads and processes the contet from the generated file if it exists. + Even after this method is invoked, the operation claims might be null. + + + + + Updates the cache file with the current value in the operation claims if the operationn claims is not null. + + Task + + + + Plugin constants. + + + + + Default close timeout for plugins. + + + + + Default idle timeout for plugins. + + + + + Default command-line arguments for plugins. + + + + + The progress notification interval. + + This value must be less than half of . + + + + The default request timeout set by an initialize request after handshaking. + + + + + A plugin's creation result. + + + + + Gets the plugin's operation claims. + + + + + Gets a message if is null; otherwise, null. + + + + + Gets a plugin. + + + + + Gets a plugin multiclient utilities. + + + + + Instantiates a new class. + + A plugin. + A plugin multiclient utilities. + The plugin's operation claims. + Thrown if is null. + Thrown if is null. + Thrown if is null. + + + + Instantiates a new class. + + A message why a plugin could not be created. + Thrown if + is either null or an empty string. + + + + Discovers plugins and their operation claims. + + + + + Instantiates a new class. + + The raw semicolon-delimited list of supposed plugin file paths. + An embedded signature verifier. + Thrown if is null. + + + + Disposes of this instance. + + + + + Asynchronously discovers plugins. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a + from the target. + Thrown if + is cancelled. + + + + A plugin discovery result. + + + + + Gets the plugin file. + + + + + Gets a message if is not ; + otherwise, null. + + + + + Instantiates a new class. + + A plugin file. + ; otherwise, null + Thrown if + is null. + + + + The internal plugins located next to the NuGet assemblies. + + Internal plugins + + + + Given Visual Studio 2017 MSBuild.exe path, return the NuGet plugins directory which is in CommonExtensions\NuGet\Plugins + + The MsBuildExe path. Needs to be a valid path. file:// not supported. + The NuGet plugins directory, null if is null + The MSBuild.exe is in MSBuild\15.0\Bin\MsBuild.exe, the Plugins directory is in Common7\IDE\CommonExtensions\Microsoft\NuGet\Plugins + + + + Given a NuGet assembly path, returns the NuGet plugins directory + + The path to a NuGet assembly in CommonExtensions\NuGet, needs to be a valid path. file:// not supported + The NuGet plugins directory in CommonExtensions\NuGet\Plugins, null if the is null + + + + Plugin event arguments. + + + + + Gets the plugin. + + + + + Instantiates a new class. + + A plugin. + Thrown if is null. + + + + A plugin exception. + + + + + Instantiates a new class. + + The exception message. + + + + Instantiates a new class. + + The exception message. + The inner exception. + + + + A plugin factory. + + + + + Instantiates a new class. + + The plugin idle timeout. + Thrown if + is less than . + + + + Disposes of this instance. + + + + + Asynchronously gets an existing plugin instance or creates a new instance and connects to it. + + The file path of the plugin. + Command-line arguments to be supplied to the plugin. + Request handlers. + Connection options. + A cancellation token for the plugin's lifetime. + A task that represents the asynchronous operation. + The task result () returns a + instance. + Thrown if + is either null or empty. + Thrown if + is null. + Thrown if + is null. + Thrown if + is null. + Thrown if + is cancelled. + Thrown if this object is disposed. + This is intended to be called by NuGet client tools. + + + + Asynchronously creates a plugin instance and connects to it. + + Request handlers. + Connection options. + A cancellation token for the plugin's lifetime. + A task that represents the asynchronous operation. + The task result () returns a + instance. + Thrown if + is either null or empty. + Thrown if + is either null or empty. + Thrown if + is cancelled. + This is intended to be called by a plugin. + + + + Represents a plugin file. + + + + + Gets the plugin's file path. + + + + + Gets the plugin file state. + + + + + Instantiates a new class. + + The plugin's file path. + A lazy that evaluates the plugin file state. + + + + State of a plugin file path. + + + + + The file exists and has a valid embedded signature. + + + + + The file was not found. + + + + + The file path was invalid (e.g.: not rooted). + + + + + The file exists but it has either no embedded signature or an invalid embedded signature. + + + + + Plugin multiclient utilities. + + + + + Initializes a new class. + + + + + Asynchronously executes a task once per plugin lifetime per key. + + A key that identifies the task. + A function that returns a task. + A cancellation token. + A task that represents the asynchronous operation. + Thrown if + is either null or an empty string. + Thrown if + is either null. + Thrown if + is cancelled. + + + + A package downloader that delegates to a plugin. + + + + + Gets an asynchronous package content reader. + + Thrown if this object is disposed. + + + + Gets an asynchronous package core reader. + + Thrown if this object is disposed. + + + + Initializes a new class. + + A plugin. + A package identity. + A plugin package reader. + A package source repository location. + Thrown if + is null. + Thrown if + is null. + Thrown if + is null. + Thrown if + is either null or an empty string. + + + + Disposes of this instance. + + + + + Asynchronously copies a .nupkg to a target file path. + + The destination file path. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a + indicating whether or not the copy was successful. + Thrown if this object is disposed. + Thrown if + is either null or empty. + Thrown if + is cancelled. + + + + Asynchronously gets a package hash. + + The hash algorithm. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a + representing the package hash. + Thrown if this object is disposed. + Thrown if + is either null or empty. + Thrown if + is cancelled. + + + + Sets an exception handler for package downloads. + + The exception handler returns a task that represents the asynchronous operation. + The task result () returns a + indicating whether or not the exception was handled. To handle an exception and stop its + propagation, the task should return true. Otherwise, the exception will be rethrown. + An exception handler. + Thrown if + is null. + + + + Sets a throttle for package downloads. + + A throttle. Can be null. + + + + A package reader that delegates package read operations to a plugin. + + + + + Initializes a new class. + + A plugin. + A package identity. + A package source repository location. + Thrown if is null. + Thrown if + is null. + Thrown if + is either null or an empty string. + + + + Gets a stream for a file in the package. + + The file path in the package. + A stream. + Thrown always. + + + + Asynchronously gets a stream for a file in the package. + + The file path in the package. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a . + Thrown if + is either null or an empty string. + Thrown if + is cancelled. + + + + Gets files in the package. + + An enumerable of files in the package. + Thrown always. + + + + Asynchronously gets files in the package. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is cancelled. + + + + Gets files in the package. + + A folder in the package. + An enumerable of files in the package. + Thrown always. + + + + Asynchronously gets files in the package under the specified folder. + + A folder in the package. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if is null. + Thrown if + is cancelled. + + + + Copies specified files in the package to the destination location. + + A directory path to copy files to. + An enumerable of files in the package to copy. + A package file extraction delegate. + A logger. + A cancellation token. + An enumerable of file paths in the destination location. + Thrown always. + + + + Asynchronously copies specified files in the package to the destination location. + + A directory path to copy files to. + An enumerable of files in the package to copy. + A package file extraction delegate. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is either null or an empty string. + Thrown if + is null. + Thrown if is null. + Thrown if + is cancelled. + + + + Gets the package identity. + + A package identity. + Thrown always. + + + + Asynchronously gets the package identity. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is cancelled. + + + + Gets the minimum client version in the .nuspec. + + A NuGet version. + Thrown always. + + + + Asynchronously gets the minimum client version in the .nuspec. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is cancelled. + + + + Gets the package types. + + A read-only list of package types. + Thrown always. + + + + Asynchronously gets the package types. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is cancelled. + + + + Gets a stream for the .nuspec file. + + A stream. + Thrown always. + + + + Asynchronously gets a stream for the .nuspec file. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a . + Thrown if + is cancelled. + + + + Gets the .nuspec file path in the package. + + The .nuspec file path in the package. + Thrown always. + + + + Asynchronously gets the .nuspec file path in the package. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a . + Thrown if + is cancelled. + + + + Gets the .nuspec reader. + + + + + Asynchronously gets the .nuspec reader. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a . + Thrown if + is cancelled. + + + + Gets supported frameworks. + + An enumerable of NuGet frameworks. + Thrown always. + + + + Asynchronously gets supported frameworks. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is cancelled. + + + + Gets framework items. + + An enumerable of framework specific groups. + Thrown always. + + + + Asynchronously gets framework items. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is cancelled. + + + + Gets a flag indicating whether or not the package is serviceable. + + A flag indicating whether or not the package is serviceable. + Thrown always. + + + + Asynchronously gets a flag indicating whether or not the package is serviceable. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a . + Thrown if + is cancelled. + + + + Gets build items. + + An enumerable of framework specific groups. + Thrown always. + + + + Asynchronously gets build items. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is cancelled. + + + + Gets tool items. + + An enumerable of framework specific groups. + Thrown always. + + + + Asynchronously gets tool items. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is cancelled. + + + + Gets content items. + + An enumerable of framework specific groups. + Thrown always. + + + + Asynchronously gets content items. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is cancelled. + + + + Gets items in the specified folder in the package. + + A folder in the package. + An enumerable of framework specific groups. + Thrown always. + + + + Asynchronously gets items in the specified folder in the package. + + A folder in the package. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if is null. + Thrown if + is cancelled. + + + + Gets package dependencies. + + An enumerable of package dependency groups. + Thrown always. + + + + Asynchronously gets package dependencies. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is cancelled. + + + + Gets lib items. + + An enumerable of framework specific groups. + Thrown always. + + + + Asynchronously gets lib items. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is cancelled. + + + + Gets reference items. + + An enumerable of framework specific groups. + Thrown always. + + + + Asynchronously gets reference items. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is cancelled. + + + + Gets a flag indicating whether or not the package is a development dependency. + + A flag indicating whether or not the package is a development dependency + Thrown always. + + + + Asynchronously gets a flag indicating whether or not the package is a development dependency. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a . + Thrown if + is cancelled. + + + + Asynchronously copies a package to the specified destination file path. + + The destination file path. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a . + Thrown if + is either null or an empty string. + Thrown if + is cancelled. + + + + Represents a plugin process. + + + + + Occurs when a process exits. + + + + + Occurs when a line of output has been received. + + + + + Gets a value indicating whether the associated process has been terminated. + + + + + Instantiates a new class. + + A plugin process. + Thrown if is null. + + + + Disposes of this instance. + + + + + Asynchronously starts reading the standard output stream. + + + + + Cancels asynchronous reading of the standard output stream. + + + + + Immediately stops the associated process. + + + + + Plugin protocol constants. + + + + + The current protocol version. + + + + + The minimum supported protocol version. + + + + + The default handshake timeout. + + + + + The maximum timeout value. + + This is set by CancellationTokenSource's constructor. + + + + The minimum timeout value. + + + + + The default request timeout. + + + + + Protocol error event arguments. + + + + + Gets the exception. + + + + + Gets the message. + + + + + Instantiates a new class. + + An exception. + Thrown if is null. + + + + Instantiates a new class. + + An exception. + A message. + Thrown if is null. + Thrown if is null. + + + + A plugin protocol exception. + + + + + Instantiates a new class. + + The exception message. + + + + Instantiates a new class. + + The exception message. + The inner exception. + + + + Represents a unidirectional communications channel from a target. + + + + + Gets a flag indicating whether or not this instance is closed. + + + + + Gets or sets a flag indicating whether or not this instance is disposed. + + + + + Occurs when an unrecoverable fault has been caught. + + + + + Occurs when a message has been received. + + + + + Closes the connection. + + This does not call . + + + + Connects. + + Thrown if this object is disposed. + Thrown if this object is closed. + Thrown if this method has already been called. + + + + Disposes of this instance. + + + + + A set of . + + + + + Instantiates a new class. + + + + + Atomically add or update a request handler for the specified message method. + + A message method. + An add request handler function. + An update request handler function. + Thrown if + is null. + Thrown if + is null. + + + + Attempts to add a request handler for the specified message method. + + A message method. + A request handler. + true if added; otherwise, false. + Thrown if is null. + + + + Attempts to get a request handler for the specified message method. + + A message method. + An existing request handler. + true if the request handler exists; otherwise, false. + + + + Attempts to remove a request handler for the specified message method. + + A message method. + true if a request handler was removed; otherwise, false. + + + + A request handler for closing a plugin. + + + + + Initializes a new class. + + A plugin. + Thrown if is null. + + + + Asynchronously handles responding to a request. + + The connection. + A request message. + A response handler. + A cancellation token. + A task that represents the asynchronous operation. + Thrown if + is null. + Thrown if is null. + Thrown if + is null. + + + + A request handler for get credentials requests. + + + + + Gets the for a request. + + + + + Initializes a new class. + + A plugin. + A web proxy. + An optional credential service. + Thrown if + is null. + + + + Disposes of this instance. + + + + + Adds or updates a source repository in a source repository cache. + + A source repository. + Thrown if + is null. + + + + Asynchronously handles responding to a request. + + The connection. + A request message. + A response handler. + A cancellation token. + A task that represents the asynchronous operation. + Thrown if + is null. + Thrown if is null. + Thrown if + is null. + Thrown if + is cancelled. + + + + A request handler for get service index requests. + + + + + Gets the for a request. + + + + + Initializes a new class. + + A plugin. + Thrown if is null. + + + + Disposes of this instance. + + + + + Adds or updates a source repository in a source repository cache. + + A source repository. + Thrown if + is null. + + + + Asynchronously handles responding to a request. + + The connection. + A request message. + A response handler. + A cancellation token. + A task that represents the asynchronous operation. + Thrown if + is null. + Thrown if is null. + Thrown if + is null. + Thrown if + is cancelled. + + + + A request handler for logging. + + + + + Gets the for a request. + + + + + Instantiates a new instance of the class. + + A logger. + Thrown if is null. + + + + Asynchronously handles responding to a request. + + The connection. + A request message. + A response handler. + A cancellation token. + A task that represents the asynchronous operation. + Thrown if + is null. + Thrown if is null. + Thrown if + is null. + Thrown if + is cancelled. + + + + Sets the logger. + + A logger. + Thrown if is null. + + + + Gets the log level of a logger. + + A logger. + A log level. + Thrown if is null. + + + + A request handler for monitoring the exit of a NuGet process. + + + + + Initializes a new class. + + A plugin. + Thrown if is null. + + + + Asynchronously handles responding to a request. + + The connection. + A request message. + A response handler. + A cancellation token. + A task that represents the asynchronous operation. + Thrown if + is null. + Thrown if is null. + Thrown if + is null. + + + + A helper class that performs a symmetric handshake. + + + + + Gets the for a request. + + + + + Initializes a new instance of the class. + + A connection. + The handshake timeout. + The handshaker's protocol version. + The handshaker's minimum protocol version. + + + + Disposes of this instance. + + + + + Asynchronously handles handshaking. + + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a + if the handshake was successful; otherwise, null. + Thrown if + is cancelled. + + + + Asynchronously handles responding to a request. + + The connection. + A request message. + A response handler. + A cancellation token. + A task that represents the asynchronous operation. + Thrown if + is null. + Thrown if is null. + Thrown if + is null. + Thrown if + is cancelled. + + + + A unique identifier generator. + + + + + Generates a new unique identifier. + + A unique identifier. + + + + Represents a unidirectional communications channel to a target. + + + Any public static members of this type are thread safe. + Any instance members are not guaranteed to be thread safe. + + + + + Instantiates a new class. + + A text writer. + Thrown if is null. + + + + Disposes of this instance. + + + + + Closes the connection. + + This does not call . + + + + Connects. + + Thrown if this object is disposed. + Thrown if this object is closed. + Thrown if this method has already been called. + + + + Asynchronously sends a message to the target. + + The message to send. + A cancellation token. + A task that represents the asynchronous operation. + Thrown if this object is disposed. + Thrown if has not been called. + Thrown if is null. + Thrown if + is cancelled. + + + + Represents a unidirectional communications channel from a target. + + + Any public static members of this type are thread safe. + Any instance members are not guaranteed to be thread safe. + + + + + Instantiates a new class. + + A text reader. + Thrown if is null. + + + + Disposes of this instance. + + + + + Connects. + + Thrown if this object is disposed. + Thrown if this object is closed. + Thrown if this method has already been called. + + + + Represents a unidirectional communications channel from a target. + + + Any public static members of this type are thread safe. + Any instance members are not guaranteed to be thread safe. + + + + + Instantiates a new class. + + A plugin process. + Thrown if is null. + + + + Disposes of this instance. + + + + + Closes the connection. + + This does not call . + + + + Connects. + + Thrown if this object is disposed. + Thrown if this object is closed. + Thrown if this method has already been called. + + + + Timeout utilities. + + + + + Attempts to parse a legal timeout and returns a default timeout as a fallback. + + The requested timeout in seconds. + A fallback timeout. + A object that represents a timeout interval. + Thrown if is an invalid + timeout. + + + + Determines if a timeout is valid. + + A timeout. + true if the timeout is valid; otherwise, false. + + + + Embedded Signature Verifier for the MacOS, Linux and Mono platforms. + + + + + Checks if a file has a valid embedded signature. + + The path of a file to be checked. + true if the file has a valid signature; otherwise, false. + Thrown if + is either null or an empty string. + Thrown if the current platform is unsupported. + + + + Windows Authenticode signature verifier. + + + + + Checks if a file has a valid Authenticode signature. + + The path of a file to be checked. + true if the file has a valid signature; otherwise, false. + Thrown if + is either null or an empty string. + + + + Retrieves all dependency info for the package resolver. + + + + + A download resource provider for plugins. + + + + + Instanatiates a new class. + + + + + Attempts to create a resource for the specified source repository. + + A source repository. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a Tuple<bool, INuGetResource> + Thrown if is null. + Thrown if + is cancelled. + + + + Retrieves and caches service index.json files + ServiceIndexResourceV3 stores the json, all work is done in the provider + + + + + Maximum amount of time to store index.json + + + + + A remote package downloader. + + + + + Gets an asynchronous package content reader. + + Thrown if this object is disposed. + + + + Gets an asynchronous package core reader. + + Thrown if this object is disposed. + + + + Initializes a new class. + + A package source. + A resource. + A package identity. + A source cache context. + A logger. + Thrown if is null. + Thrown if + is null. + Thrown if + is null. + Thrown if is null. + + + + Disposes this instance. + + + + + Asynchronously copies a .nupkg to a target file path. + + The destination file path. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a + indicating whether or not the copy was successful. + Thrown if this object is disposed. + Thrown if + is either null or empty. + Thrown if + is cancelled. + + + + Asynchronously gets a package hash. + + The hash algorithm. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a + representing the package hash. + Thrown if this object is disposed. + Thrown if + is either null or empty. + Thrown if + is cancelled. + + + + Sets an exception handler for package downloads. + + The exception handler returns a task that represents the asynchronous operation. + The task result () returns a + indicating whether or not the exception was handled. To handle an exception and stop its + propagation, the task should return true. Otherwise, the exception will be rethrown. + An exception handler. + Thrown if + is null. + + + + Sets a throttle for package downloads. + + A throttle. Can be null. + + + + A for a Http-based file system where files are laid out in the + format + /root/ + PackageA/ + Version0/ + PackageA.nuspec + PackageA.Version0.nupkg + and are accessible via HTTP Gets. + + + + + Initializes a new class. + + Base URI's. + An HTTP source. + Thrown if is null. + Thrown if is empty. + Thrown if is null. + + + + Asynchronously gets all package versions for a package ID. + + A package ID. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is either null or an empty string. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + Asynchronously gets dependency information for a specific package. + + A package id. + A package version. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is either null or an empty string. + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + Asynchronously copies a .nupkg to a stream. + + A package ID. + A package version. + A destination stream. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + indicating whether or not the .nupkg file was copied. + Thrown if + is either null or an empty string. + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + Asynchronously gets a package downloader for a package identity. + + A package identity. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an . + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + Create a from a nupkg stream. + + + + + A FindPackageByIdResource provider for plugins. + + + + + Instantiates a new class. + + + + + Asynchronously attempts to create a resource for the specified source repository. + + A source repository. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns a Tuple<bool, INuGetResource> + Thrown if is null. + Thrown if + is cancelled. + + + + A resource capable of fetching packages, package versions and package dependency information. + + + + + Initializes a new class. + + A package source. + An HTTP source. + Thrown if + is null. + Thrown if + is null. + + + + Gets the package source. + + + + + Asynchronously gets all package versions for a package ID. + + A package ID. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is either null or an empty string. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + Asynchronously gets dependency information for a specific package. + + A package id. + A package version. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is either null or an empty string. + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + Asynchronously copies a .nupkg to a stream. + + A package ID. + A package version. + A destination stream. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + indicating whether or not the .nupkg file was copied. + Thrown if + is either null or an empty string. + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + Asynchronously gets a package downloader for a package identity. + + A package identity. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an . + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + A for over v2 NuGet feeds. + + + + + A resource capable of fetching packages, package versions and package dependency information. + + + + + Initializes a new class. + + A source repository. + An HTTP source. + Thrown if + is null. + Thrown if + is null. + + + + Gets the source repository. + + + + + Asynchronously gets all package versions for a package ID. + + A package ID. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is either null or an empty string. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + Asynchronously gets dependency information for a specific package. + + A package id. + A package version. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + . + Thrown if + is either null or an empty string. + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + Asynchronously copies a .nupkg to a stream. + + A package ID. + A package version. + A destination stream. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an + indicating whether or not the .nupkg file was copied. + Thrown if + is either null or an empty string. + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + Asynchronously gets a package downloader for a package identity. + + A package identity. + A source cache context. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns an . + Thrown if null. + Thrown if null. + Thrown if null. + Thrown if + is cancelled. + + + + Retrieves all packages and dependencies from a V3 source. + + + + + Dependency info resource + + Http client + Registration blob resource + + + + Retrieve dependency info for a single package. + + package id and version + project target framework. This is used for finding the dependency group + cancellation token + + Returns dependency info for the given package if it exists. If the package is not found null is + returned. + + + + + Retrieve the available packages and their dependencies. + + Includes prerelease packages + package Id to search + project target framework. This is used for finding the dependency group + cancellation token + available packages and their dependencies + + + + Retrieve the available packages and their dependencies. + + Includes prerelease packages + package Id to search + cancellation token + available packages and their dependencies + + + + Retrieve dependency info from a registration blob + + + + + A download resource for plugins. + + + + + Instantiates a new class. + + A plugin. + A plugin multiclient utilities. + A package source. + Thrown if + is null. + Thrown if + is null. + Thrown if + is null. + + + + Asynchronously downloads a package. + + The package identity. + A package download context. + The path to the global packages folder. + A logger. + A cancellation token. + A task that represents the asynchronous operation. + The task result () returns + a . + Thrown if is null. + Thrown if + is null. + Thrown if is null. + Thrown if + is cancelled. + + + + Provides the download metatdata for a given package from a V3 server endpoint. + + + + + Download packages using the download url found in the registration resource. + + + + + Download packages using the package base address container resource. + + + + + Get the download url of the package. + 1. If the identity is a SourcePackageDependencyInfo the SourcePackageDependencyInfo.DownloadUri is used. + 2. A url will be constructed for the flat container location if the source has that resource. + 3. The download url will be found in the registration blob as a fallback. + + + + + Returns the full package metadata + + + + + Find the latest version of the package + + include versions with prerelease labels + not implemented yet + + + + Registration blob reader + + + + + Gets the for the source backing this resource. + + + + + Constructs the URI of a registration index blob + + + + + Constructs the URI of a registration blob with a specific version + + + + + Constructs the URI of a registration blob with a specific version + + + + + Returns the registration blob for the id and version + + The inlined entries are potentially going away soon + + + + Returns inlined catalog entry items for each registration blob + + The inlined entries are potentially going away soon + + + + Returns inlined catalog entry items for each registration blob + + The inlined entries are potentially going away soon + + + + Returns all index entries of type Package within the given range and filters + + + + + Gets a URL for reporting package abuse. The URL will not be verified to exist. + + The package id (natural casing) + The package version + The first URL from the resource, with the URI template applied. + + + + Stores/caches a service index json file. + + + + + Time the index was requested + + + + + All service index entries. + + + + + Get the list of service entries that best match the current clientVersion and type. + + + + + Get the list of service entries that best match the clientVersion and type. + + + + + Get the best match service URI. + + + + + Get the list of service URIs that best match the current clientVersion and type. + + + + + Get the list of service URIs that best match the clientVersion and type. + + + + + Read string values from an array or string. + Returns an empty enumerable if the value is null. + + + + + A strongly-typed resource class, for looking up localized strings, etc. + + + + + Returns the cached ResourceManager instance used by this class. + + + + + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + + + + + Looks up a localized string similar to Install failed. Rolling back.... + + + + + Looks up a localized string similar to Unrecognized Package Action '{0}'.. + + + + + Looks up a localized string similar to Unsupported Dependency Behavior '{0}'.. + + + + + Looks up a localized string similar to Package '{0}' already exists at feed '{1}' and is invalid.. + + + + + Looks up a localized string similar to Package '{0}' already exists at feed '{1}'.. + + + + + Looks up a localized string similar to Successfully added package '{0}' to feed '{1}'.. + + + + + Looks up a localized string similar to Argument can not be null or empty.. + + + + + Looks up a localized string similar to Argument cannot be null or empty.. + + + + + Looks up a localized string similar to the symbol server. + + + + + Looks up a localized string similar to Delete canceled. + + + + + Looks up a localized string similar to {0} {1} will be deleted from the {2}. Would you like to continue?. + + + + + Looks up a localized string similar to {0} {1} was deleted successfully.. + + + + + Looks up a localized string similar to Deleting {0} {1} from the {2}.. + + + + + Looks up a localized string similar to Not Found.. + + + + + Looks up a localized string similar to The download URL for {0} '{1}' is invalid.. + + + + + Looks up a localized string similar to No download URL could be found for {0}.. + + + + + Looks up a localized string similar to The download of '{0}' timed out because no data was received for {1}ms.. + + + + + Looks up a localized string similar to The server responded with HTTP '403 Forbidden' when accessing the source '{0}'. This suggests that the server has authenticated your identity but has not permitted you to access the requested resource. Provide credentials that have permissions to view this resource.. + + + + + Looks up a localized string similar to The server responded with HTTP '407 Proxy Authentication Required' when accessing the proxy '{0}'. This suggests that the server needs credentials to authenticate your identity to use a proxy. Provide credentials to access this resource.. + + + + + Looks up a localized string similar to The server responded with HTTP '401 Unauthorized' when accessing the source '{0}'. This suggests that the server needs credentials to authenticate your identity. Provide credentials to access this resource.. + + + + + Looks up a localized string similar to {0} {1}. + + + + + Looks up a localized string similar to {0} {1} {2}ms. + + + + + Looks up a localized string similar to The HTTP request to '{0} {1}' has timed out after {2}ms.. + + + + + Looks up a localized string similar to The folder '{0}' contains an invalid version.. + + + + + Looks up a localized string similar to the NuGet gallery. + + + + + Looks up a localized string similar to The file '{0}' does not exist in the package.. + + + + + Looks up a localized string similar to Cannot load the file '{0}' because it is larger than {1} MB.. + + + + + Looks up a localized string similar to Unknown problem loading the file '{0}'.. + + + + + Looks up a localized string similar to Downloading a package from '{0}' was canceled.. + + + + + Looks up a localized string similar to Error downloading '{0}' from '{1}'.. + + + + + Looks up a localized string similar to Failed to download package '{0}' from '{1}'.. + + + + + Looks up a localized string similar to The V2 feed at '{0}' returned an unexpected status code '{1} {2}'.. + + + + + Looks up a localized string similar to Failed to fetch results from V2 feed at '{0}' with following message : {1}. + + + + + Looks up a localized string similar to Unable to load nuspec from package '{0}'.. + + + + + Looks up a localized string similar to Unable to parse {0} information from {1}. . + + + + + Looks up a localized string similar to Unable to get repository signature information for source {0}.. + + + + + Looks up a localized string similar to Unable to load the service index for source {0}.. + + + + + Looks up a localized string similar to Failed to retrieve information about '{0}' from remote source '{1}'.. + + + + + Looks up a localized string similar to Failed to verify the root directory of local source '{0}'.. + + + + + Looks up a localized string similar to Failed to validate the file '{0}'.. + + + + + Looks up a localized string similar to The file '{0}' is corrupt.. + + + + + Looks up a localized string similar to An invalid cache entry was found for URL '{0}' and will be replaced.. + + + + + Looks up a localized string similar to The nupkg at '{0}' is not valid.. + + + + + Looks up a localized string similar to The local source '{0}' doesn't exist.. + + + + + Looks up a localized string similar to Retrying '{0}' for source '{1}'.. + + + + + Looks up a localized string similar to An error was encountered when fetching '{0} {1}'. The request will now be retried.. + + + + + Looks up a localized string similar to Retrying repository signature request for source '{0}'.. + + + + + Looks up a localized string similar to Retrying service index request for source '{0}'.. + + + + + Looks up a localized string similar to No API Key was provided and no API Key could be found for {0}. To save an API Key for a source use the 'setApiKey' command.. + + + + + Looks up a localized string similar to The license version string '{0}' is higher than the one supported by this toolset '{1}'.. + + + + + Looks up a localized string similar to The license identifier(s) {0} is(are) not recognized by the current toolset.. + + + + + Looks up a localized string similar to Cannot create a NuGet Repository from the Aggregate Source. + + + + + Looks up a localized string similar to The {0} service is not supported by this object.. + + + + + Looks up a localized string similar to '{0}' is not a valid nupkg file.. + + + + + Looks up a localized string similar to '{0}' is not a valid nupkg file. Error: '{1}'.. + + + + + Looks up a localized string similar to One or more URIs must be specified.. + + + + + Looks up a localized string similar to Unrecognized Package Action '{0}'.. + + + + + Looks up a localized string similar to Unable to find package '{0}'.. + + + + + Looks up a localized string similar to ERROR: This version of nuget.exe does not support updating packages to package source '{0}'.. + + + + + Looks up a localized string similar to '{0}' is not a valid path.. + + + + + Looks up a localized string similar to '{0}' should be a local path or a UNC share path.. + + + + + Looks up a localized string similar to A connection has already been started.. + + + + + Looks up a localized string similar to The plugin connection is closed.. + + + + + Looks up a localized string similar to Downloading a package from a plugin is not supported since unsigned packages are not allowed and package download plugins do not support signed package verification.. + + + + + Looks up a localized string similar to Plugin '{0}' failed with the exception: {1}. + + + + + Looks up a localized string similar to Plugin '{0}' failed a {1} operation for package {2}.{3}.. + + + + + Looks up a localized string similar to A failure occurred while attempting to query plugin operation claims for the plugin at '{0}'. Exception: {1}. + + + + + Looks up a localized string similar to A failure occurred while attempting to query package versions for package '{0}' using the plugin at '{1}'.. + + + + + Looks up a localized string similar to Terminating plugin '{0}' due to an unrecoverable fault: {1}. + + + + + Looks up a localized string similar to A plugin was not found at path '{0}'.. + + + + + Looks up a localized string similar to The plugin handshake failed.. + + + + + Looks up a localized string similar to A handshake request handler already exists.. + + + + + Looks up a localized string similar to The idle timeout must be greater than or equal to System.Threading.Timeout.InfiniteTimeSpan.. + + + + + Looks up a localized string similar to An illegal message type was received during handshake.. + + + + + Looks up a localized string similar to Plugin initialization failed.. + + + + + Looks up a localized string similar to The plugin at '{0}' did not have a valid embedded signature.. + + + + + Looks up a localized string similar to The message type '{0}' is invalid at this time.. + + + + + Looks up a localized string similar to The plugin file path '{0}' is invalid.. + + + + + Looks up a localized string similar to A plugin is not connected.. + + + + + Looks up a localized string similar to Plugin '{0}' failed to download package '{1}'.. + + + + + Looks up a localized string similar to A plugin protocol exception occurred.. + + + + + Looks up a localized string similar to A protocol version is not supported on error.. + + + + + Looks up a localized string similar to '{0}' must be greater than or equal to '{1}'.. + + + + + Looks up a localized string similar to Request context does not exist for request ID '{0}'.. + + + + + Looks up a localized string similar to A request handler does not exist for the message method '{0}'.. + + + + + Looks up a localized string similar to Timeout must be greater than TimeSpan.Zero and less than or equal to TimeSpan.FromMilliseconds(int.MaxValue).. + + + + + Looks up a localized string similar to The enum value '{0}' is unrecognized.. + + + + + Looks up a localized string similar to The operation claims are unrecognized: {0}.. + + + + + Looks up a localized string similar to The project '{0}' is not one of the projects targetted by this object.. + + + + + Looks up a localized string similar to Failed to retrieve metadata from source '{0}'.. + + + + + Looks up a localized string similar to '{0}' is a duplicate url which has already been downloaded and will lead to a cyclic dependency. Please correct from server.. + + + + + Looks up a localized string similar to The 'versions' property at '{0}' must be an array.. + + + + + Looks up a localized string similar to Service index document is missing the 'resources' property.. + + + + + Looks up a localized string similar to The content at '{0}' is not a valid JSON object.. + + + + + Looks up a localized string similar to The source does not have the 'version' property at '{0}'.. + + + + + Looks up a localized string similar to The content at '{0}' is not valid XML.. + + + + + Looks up a localized string similar to Metadata could not be loaded from the source '{0}'.. + + + + + Looks up a localized string similar to The source does not have a Registration Base Url defined!. + + + + + Looks up a localized string similar to The source does not have a Search service!. + + + + + Looks up a localized string similar to The source does not have the 'version' property.. + + + + + Looks up a localized string similar to An error occurred while retrieving package metadata for '{0}' from source '{1}'.. + + + + + Looks up a localized string similar to The path '{0}' for the selected source could not be resolved.. + + + + + Looks up a localized string similar to The source version is not supported: '{0}'.. + + + + + Looks up a localized string similar to Your package was pushed.. + + + + + Looks up a localized string similar to Pushing {0} to {1}.... + + + + + Looks up a localized string similar to Repository content URL for repository signatures must be HTTPS.. + + + + + Looks up a localized string similar to Repository Signatures resouce must be served over HTTPS. Source: {0}. + + + + + Looks up a localized string similar to The '{0}' installation feature was required by a package but is not supported on the current host.. + + + + + Looks up a localized string similar to The installation host does not support a feature required by this package.. + + + + + Looks up a localized string similar to File does not exist ({0}).. + + + + + Looks up a localized string similar to Unable to parse a valid version from a v3 folder: '{0}'.. + + + + + Looks up a localized string similar to API v2 (legacy). + + + + + Looks up a localized string similar to API v3. + + + + + Looks up a localized string similar to Found symbols package '{0}', but no API key was specified for the symbol server. To save an API Key, run 'NuGet.exe setApiKey [your API key from http://www.NuGet.org]'.. + + + + + Given a string, it hashes said string and appends identifiable characters to make the root of the cache more human readable + + + hash + + + + Determine the type of a nuget source. This works for both offline and online sources. + + + + + Gets a from a .nupkg. If the URL cannot be fetched or there is a problem + processing the .nuspec, an exception is throw. This method uses HTTP caching to avoid downloading the + package over and over (unless is specified). + + The package identity. + The URL of the .nupkg. + The cache context. + The cancellation token. + The .nuspec reader. + + + + Copies a .nupkg stream to the stream. If the .nupkg cannot be found or if + there is a network problem, no stream copy occurs. + + The package identity. + The URL of the .nupkg. + The destination stream. The .nupkg will be copied to this stream. + The cache context. + The cancellation token. + Returns true if the stream was copied, false otherwise. + + + + Manages the different ways of getting a .nupkg stream when using the global HTTP cache. When a stream is + found, the method is invoked on said stream. This deals with the + complexity of . + + The package identity. + The URL of the .nupkg to fetch. + The method to process the stream. + The cache context. + The cancellation token. + + Returns true if the stream was processed, false if the stream could not fetched (either from the HTTP cache + or from the network). + + + + + Allow explicit clean-up of direct download files. This is important because although direct downloads are + opened with the option, some systems (e.g. Linux) do not perform + the delete if the process dies. Additionally, if the system dies before the process dies (e.g. loss of + power), the direct download files will be left over. + + The download context. + + + + JsonLoadSettings with line info and comments ignored. + + + + + Load json from a file to a JObject using the default load settings. + + + + + Load json from a file to a JObject using the default load settings. + + + + + Retrieve a nupkg using the path. + + Nupkg path in uri form. + + + + Retrieve all packages from a folder and one level deep. + + Nupkg folder directory path. + + + + Retrieve all packages of an id from a v2 folder. + + Nupkg folder directory path. + Package id. + + + + Retrieve all packages of an id from a v2 folder. + + Nupkg folder directory path. + Package id. + Package version. + + + + Retrieve all packages of an id from a v2 folder. + + Nupkg folder directory path. + Package id and version. + + + + Retrieve a package with an id and version from a packages.config packages folder. + + Nupkg folder directory path. + + + + Retrieve a package with an id and version from a packages.config packages folder. + + Nupkg folder directory path. + + + + Retrieve a package with an id and version from a packages.config packages folder. + + Nupkg folder directory path. + Package id and version. + + + + Returns either id.* or * depending on the OS. + + + + + + + Retrieve a package with an id and version from a packages.config packages folder. + + Nupkg folder directory path. + + + + Return the package nupkg from a packages.config folder sub directory. + + Package directory in the format id.version + + + + True if the file name matches the identity. This is could be incorrect if + the package name ends with numbers. The result should be checked against the nuspec. + + + + + True if the file name matches the id and is followed by a version. This is could be incorrect if + the package name ends with numbers. The result should be checked against the nuspec. + + + + + An imperfect attempt at finding the identity of a package from the file name. + This can fail if the package name ends with something such as .1 + + + + + An imperfect attempt at finding the version of a package from the file name. + This can fail if the package name ends with something such as .1 + + + + + Parse a possible version from a string in the format Id.Version + Returns null if the version is invalid or the id did not match. + + Id.Version + Expected id + + + + Retrieve a single package from a v3 version folder. + + + + + Retrieve a package from a v3 feed. + + + + + Discover all nupkgs from a v2 local folder. + + Folder root. + + + + Verify that a path could be a valid directory. Throw a FatalProtocolException otherwise. + + + + + Verify that a path could be a valid file. Throw a FatalProtocolException otherwise. + + + + + Retrieve files in chunks, this helps maintain the legacy behavior of searching for + certain non-normalized file names. + + + + + Discover nupkgs from a v2 local folder. + + Folder root. + Package id file name prefix. + + + + Discover all nupkgs from a v3 folder. + + Folder root. + + + + Discover nupkgs from a v3 local folder. + + Folder root. + Package id or package id prefix. + + + + Resolves a package path into a list of paths. + If the path contains wildcards then the path is expanded to all matching entries. + + Package path + A list of package paths that match the input path. + + + + This method checks of a given list of package paths exist on disk. + + A package path to be used while creating logs. + A list of matching package paths that need to be checked. + + + + Remove duplicate packages which can occur in directories. + In V2 packages may exist under multiple sub folders. + Non-normalized versions also lead to duplicates: ex: 1.0, 1.0.0.0 + + + + + Retrieve directories and log exceptions that occur. + + + + + Retrieve files and log exceptions that occur. + + + + + Path -> LocalPackageInfo + + + + + Path -> LocalPackageInfo + + + + + Find all nupkgs in the top level of a directory. + + + + + Cache strings, dates, and versions to reduce memory. + + + + + Checks if already exists in the cache. + If so, returns the cached instance. + If not, caches and returns it. + + + + + Parses into a . + + + + + Mapping of input parameter type to caching method. + + + + + containing all types that can be cached. + + + + + Iterates through the properties of that are either s, s, or s and checks them against the cache. + + + + + Read a stream into a memory stream if CanSeek is false. + This method is used to ensure that network streams + can be read by non-async reads without hanging. + + Closes the original stream by default. + + + + + Read a stream into a memory stream if CanSeek is false. + This method is used to ensure that network streams + can be read by non-async reads without hanging. + + + + + Starts a task with a timeout. If the timeout occurs, a + with no message will be thrown. + + + + + Starts a task with a timeout. If the timeout occurs, a + with no message will be thrown. + + + + + Represents a package installed to the user global folder, or a fallback folder. + Components of the package are cached and across all restores. + + + + + Caches the nuspec reader. + If the nuspec does not exist this will throw a friendly exception. + + + + + Package files with OPC files filtered out. + Cached to avoid reading the same files multiple times. + + + + + SHA512 of the package. + + + + + runtime.json + + Returns null if runtime.json does not exist in the package. + + + + Caches package info from the global packages folder in memory. + Packages not yet in the cache will be retrieved from disk. + + + + + True if the package exists. + + + + + Remove cached results for the given ids. This is needed + after installing a new package. + + + + + Take the first match on id and version. + + + + + Compares two enumberables for equality, ordered according to the specified key and optional comparer. Handles null values gracefully. + + The type of the list + The type of the sorting key + This list + The other list + The function to extract the key from each item in the list + An optional comparer for comparing keys + An optional comparer for sequences + + + + Compares two sequence for equality, allowing either sequence to be null. If one is null, both have to be + null for equality. + + + + + Compares two sets for equality, allowing either sequence to be null. + If one is null, both have to be null for equality. + + + + + Hash code creator, based on the original NuGet hash code combiner/ASP hash code combiner implementations + + + + + Create a unique hash code for the given set of items + + + + + Create a unique hash code for the given set of items + + + + + Return the enumerable as a List of T, copying if required. Optimized for common case where it is an List of T. + Avoid mutating the return value. + + https://aspnetwebstack.codeplex.com/SourceControl/latest#src/Common/CollectionExtensions.cs + + + + Return the ISet as a HashSet of T, copying if required. Optimized for common case where it is a HashSet of T. + Avoid mutating the return value. + + + +XRVQ10QN1ob+bfB3XPmjZdgz9NA=Mqij26IK8lnaXSr0SkJlMYQoZgScqR6SrQdXah80ouc9II8YfuE5TaGCmlrHfO99/0bYemctLr5Pa0ElkptAdc7SqatX60Ut3FD7q+Rnl0QHSbn21WKxEVshAojKzaMJbwPPpErXEz2yDU7PhUOdYFcoaVFLcGEnoVI7v+cqOseceZuv8eNS/I/G63lfonRY5FddoCG1gCAHkBv0G3kd42de3A0i2tO9jse8hcOlVKkwYfW2eL8fAUnWLt6UtquLbEfNgzj5zEpcOXtqjTuEUUARus2a24MyC0R1LMYX9CBxS72VmGzM95IT7cPt1Bx0Gfp/oHHxrGn8wo7coT5dOQ==m1K+Tyy0HVPLPV0jHraDo5/A5UrgV7PC+C3WipFfzBLODN0Ct0Z49Gub3ufLICGP1D4OJZRyOnhjZi61X+Hbl/2IjqiIl1VMHR4+qWlJLRNj+X7DparTv3/CBzkhMGY2lZdvp96rpRL2heloKGkmmxqet6/sU3hvw8wxMIf29zYrMEBZSEaAUajNDIDd40qeLXRV7OanRHrVE770wiR9DP0zzeYjX5rN1CltAtUyWmonz7DJAYuUr+UMi3offSITg4byWkvThGNXGmtJeDpU6Y/hhcblP5Yl5175yMvHofLyGw0iW7kv/Izp2yjEVRe26PTXes/9nNOP7ul2KoKMoQ==AQABMIIE2zCCA8OgAwIBAgITMwAAAbHd7bpU6WW4XwABAAABsTANBgkqhkiG9w0BAQUFADB5MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSMwIQYDVQQDExpNaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQTAeFw0xODA3MTIyMDExMTlaFw0xOTA3MjYyMDExMTlaMHQxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xHjAcBgNVBAMTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJtSvk8stB1Tyz1dIx62g6OfwOVK4Fezwvgt1oqRX8wSzgzdArdGePRrm97nyyAhj9Q+DiWUcjp4Y2YutV/h25f9iI6oiJdVTB0ePqlpSS0TY/l+w6Wq079/wgc5ITBmNpWXb6feq6US9oXpaChpJpsanrev7FN4b8PMMTCH9vc2KzBAWUhGgFGozQyA3eNKni10Vezmp0R61RO+9MIkfQz9M83mI1+azdQpbQLVMlpqJ8+wyQGLlK/lDIt6H30iE4OG8lpL04RjVxprSXg6VOmP4YXG5T+WJede+cjLx6Hy8hsNIlu5L/yM6dsoxFUXtuj013rP/ZzTj+7pdiqCjKECAwEAAaOCAV8wggFbMBMGA1UdJQQMMAoGCCsGAQUFBwMDMB0GA1UdDgQWBBREE7QCnXc+kFVx9eQcf6wXFM8+czBQBgNVHREESTBHpEUwQzEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xFjAUBgNVBAUTDTIyOTgwMys0Mzc5NTAwHwYDVR0jBBgwFoAUyxHoytK0FlgByTcuMxYWuUyaCh8wVgYDVR0fBE8wTTBLoEmgR4ZFaHR0cDovL2NybC5taWNyb3NvZnQuY29tL3BraS9jcmwvcHJvZHVjdHMvTWljQ29kU2lnUENBXzA4LTMxLTIwMTAuY3JsMFoGCCsGAQUFBwEBBE4wTDBKBggrBgEFBQcwAoY+aHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraS9jZXJ0cy9NaWNDb2RTaWdQQ0FfMDgtMzEtMjAxMC5jcnQwDQYJKoZIhvcNAQEFBQADggEBAIOp8qYzxaF7HNJegK7spKbD6ShdVyUjjd0lCWlw6E1pFi+UuwXZm4DsWdBoZBuDNKjcz2ONnWt2APV7r0J0B8X8kcDirEUzll2x/fqORrJJ4kMGGZiFcXjTnunblRZBMTRwLEOWogJ3qS89YUpjWfGXfdFSlWCFqLwbRQc/2cGP91D1uX4IieRCxFiOQcCVOEkf1x34ME8pLztHWZI37pch7RdmkBwvLW1r/wt15aoS3fqvxBG04CEyWr8FzkX5P41Wrs5R1syufQQZMBLyv59IJpwOAA0oraXeRC3M1If/lEmVVwxNNJwjCt3DjTIJ9L01KMXe0Ig/qRIToTBwoBE=MIIFvDCCA6SgAwIBAgIKYTMmGgAAAAAAMTANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMTAwODMxMjIxOTMyWhcNMjAwODMxMjIyOTMyWjB5MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSMwIQYDVQQDExpNaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALJyWVwZMGS/HZpgICBCmXZTbD4b1m/My/Hqa/6XFhDg3zp0gxq3L6Ay7P/ewkJOI9VyANs1VwqJyq4gSfTwaKxNS42lvXlLcZtHB9r9Jd+ddYjPqnNEf9eB2/O98jakyVxF3K+tPeAoaJcap6Vyc1bxF5Tk/TWUcqDWdl8ed0WDhTgW0HNbBbpnUo2lsmkv2hkL/pJ0KeJ2L1TdFDBZ+NKNYv3LyV9GMVC5JxPkQDDPcikQKCLHN049oDI9kM2hOAaFXE5WgigqBTK3S9dPY+fSLWLxRT3nrAgA9kahntFbjCZT6HqqSvJGzzc8OJ60d1ylF56NyxGPVjzBrAlfA9MCAwEAAaOCAV4wggFaMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFMsR6MrStBZYAck3LjMWFrlMmgofMAsGA1UdDwQEAwIBhjASBgkrBgEEAYI3FQEEBQIDAQABMCMGCSsGAQQBgjcVAgQWBBT90TFO0yaKleGYYDuoMW+mPLzYLTAZBgkrBgEEAYI3FAIEDB4KAFMAdQBiAEMAQTAfBgNVHSMEGDAWgBQOrIJgQFYnl+UlE/wq4QpTlVnkpDBQBgNVHR8ESTBHMEWgQ6BBhj9odHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9taWNyb3NvZnRyb290Y2VydC5jcmwwVAYIKwYBBQUHAQEESDBGMEQGCCsGAQUFBzAChjhodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFJvb3RDZXJ0LmNydDANBgkqhkiG9w0BAQUFAAOCAgEAWTk+fyZGr+tvQLEytWrrDi9uqEn361917Uw7LddDrQv+y+ktMaMjzHxQmIAhXaw9L0y6oqhWnONwu7i0+Hm1SXL3PupBf8rhDBdpy6WcIC36C1DEVs0t40rSvHDnqA2iA6VW4LiKS1fylUKc8fPv7uOGHzQ8uFaa8FMjhSqkghyT4pQHHfLiTviMocroE6WRTsgb0o9ylSpxbZsa+BzwU9ZnzCL/XB3Nooy9J7J5Y1ZEolHN+emjWFbdmwJFRC9f9Nqu1IIybvyklRPk62nnqaIsvsgrEA5ljpnb9aL6EiYJZTiU8XofSrvR4Vbo0HiWGFzJNRZf3ZMdSY4tvq00RBzuEBUaAF3dNVshzpjHCe6FDoxPbQ4TTj18KUicctHzbMrB7HCjV5JXfZSNoBtIA1r3z6NnCnSlNu0tLxfI5nI3EvRvsTxngvlSso0zFmUeDordEN5k9G/ORtTTF+l5xAS00/ss3x+KnqwK+xMnQK3k+eGpf0a7B2BHZWBATrBC7E7ts3Z52Ao0CW0cgDEf4g5U3eWh++VHEK1kmP9QFi58vwUheuKVQSdpw5OPlcmN2Jshrg1cnPCiroZogwxqLbt2awAdlq3yFnv2FoMkuYjPaqhHMS+a3ONxPdcAfmJH0c6IybgY+g5yjcGjPa8CQGr/aZuW4hCoELQ3UAjWwz0=MIIFmTCCA4GgAwIBAgIQea0WoUqgpa1Mc1j0BxMuZTANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMDEwNTA5MjMxOTIyWhcNMjEwNTA5MjMyODEzWjBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDzXfqAZ9Rap6kMLJAg0DUIPHWEzbcHiZyJ2t7Ow2D6kWhanpRxKRh2fMLgyCV2lA5Y+gQ0Nubfr/eAuulYCyuT5Z0F43cikfc0ZDwikR1e4QmQvBT+/HVYGeF5tweSo66IWQjYnwfKA1j8aCltMtfSqMtL/OELSDJP5uu4rU/kXG8TlJnbldV126gat5SRtHdb9UgMj2p5fRRwBH1tr5D12nDYR7e/my9s5wW34RFgrHmRFHzF1qbk4X7Vw37lktI8ALU2gt554W3ztW74nzPJy1J9c5g224uha6KVl5uj3sJNJv8GlmclBsjnrOTuEjOVMZnINQhONMp5U9W1vmMyWUA2wKVOBE0921sHM+RYv+8/U2TYQlk1V/0PRXwkBE2e1jh0EZcikM5oRHSSb9VLb7CG48c2QqDQ/MHAWvmjYbkwR3GWChawkcBCle8Qfyhq4yofseTNAz93cQTHIPxJDx1FiKTXy36IrY4t7EXbxFEEySr87IaemhGXW97OU4jm4rf9rJXCKEDb7wSQ34EzOdmyRaUjhwalVYkxuwYtYA5BGH0fLrWXyxHrFdUkpZTvFRSJ/Utz+jJb/NEzAPlZYnAHMuouq0Ate8rdIWcbMJmPFqojqEHRsG4RmzbE3kB0nOFYZcFgHnpbOMiPuwQmfNQWQOW2a2yqhv0Av87BNQIDAQABo1EwTzALBgNVHQ8EBAMCAcYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUDqyCYEBWJ5flJRP8KuEKU5VZ5KQwEAYJKwYBBAGCNxUBBAMCAQAwDQYJKoZIhvcNAQEFBQADggIBAMURTQM6YN1dUhF3j7K7NsiyBb+0t6jYIJ1cEwO2HCL6BhM1tshj1JpHbyZX0lXxBLEmX9apUGigvNK4bszD6azfGc14rFl0rGY0NsQbPmw4TDMOMBINoyb+UVMA/69aToQNDx/kbQUuToVLjWwzb1TSZKu/UK99ejmgN+1jAw/8EwbOFjbUVDuVG1FiOuVNF9QFOZKaJ6hbqr3su77jIIlgcWxWs6UT0G0OI36VA+1oPfLYY7hrTbboMLXhypRL96KqXZkwsj2nwlFsKCABJCcrSwC3nRFrcL6yEIK8DJto0I07JIeqmShynTNfWZC99d6TnjpiWjQ54ohVHbkGsMGJay3XacMZEjaE0Mmg2v8vaXiy5Xra69cMwPe9Yxe4ORM4ojZbe/KFVmodZGLBOOKqv1FmopT1EpxmIhBr8rcwki3yKfA9OxRDaKLxnCk3y844ICVtfGfzfiQSJAMIgUfspZ6X9RjXz7vV73aW7/3O21adlaBC+ZdY4dcxItNfWeY+biIA6kOEtiXb2fMIVmjAZGsdfOy2k6JiV24u2OdYj8QxSSbd3ik1h/UwcXBbFDxpvYkSfesuo/7Yf56CWlIKK8FDK9kwiJ/IEPuJjeahhXUzfmye23MTZGJppS99ypZtn/gETTCSPW4hFCHJPeDD/YprnUr90aGdmUN3P7DaMIIE3jCCA8agAwIBAgITMwAAAPY4DZqG0FykOwAAAAAA9jANBgkqhkiG9w0BAQUFADB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EwHhcNMTgwODIzMjAyMDAyWhcNMTkxMTIzMjAyMDAyWjCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOkJCRUMtMzBDQS0yREJFMSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0Giw6GfheCWtNC7tfKP+uA/fAd/t2GAzfSxnZtbKjZlLfEirdj2fJjXZqfaklmMzqwzbOgT63aAizd54b/AHQiOxVD2OSzk0mBW0llgV5LlzxIpf+6RQW2PsAJpLR/Rh0dGW8KY1G7lNzLtYPQ8kTpOp28s2ggf/0ua11lYqOBCUy1Tn8l/9nmFEKADOYvcenz9mnEoLEjmLnlYy0rhzoarShF+bwhEjATx8fOT33old4rl1QgSzCNKrqdg6a/oZbD/fCXHKw+xl+7zLokPNAN/4L9b5PjYPdTcNXdHFUsg/5in9dX9SLRiGQCPddr/Xs1Io7TXZh64AergQLW2dtQIDAQABo4IBCTCCAQUwHQYDVR0OBBYEFKkpT6AZxNOTNl2kSsN+VDjJX5x8MB8GA1UdIwQYMBaAFCM0+NlSRnAK7UD7dvuzK7DDNbMPMFQGA1UdHwRNMEswSaBHoEWGQ2h0dHA6Ly9jcmwubWljcm9zb2Z0LmNvbS9wa2kvY3JsL3Byb2R1Y3RzL01pY3Jvc29mdFRpbWVTdGFtcFBDQS5jcmwwWAYIKwYBBQUHAQEETDBKMEgGCCsGAQUFBzAChjxodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFRpbWVTdGFtcFBDQS5jcnQwEwYDVR0lBAwwCgYIKwYBBQUHAwgwDQYJKoZIhvcNAQEFBQADggEBABgpbYMcaVAfzA+6Vq9i/qYS0+HfjogCavAVLAA0UUecwe0VdKANoQZgJy3F3URqGMZHsQCke0xl0KtABBMa67PJiLaTchTuncfC44GYi4/gWCxH+pfCHJsPEeGYuESQFbFx8Ay0hyQbDjOZAq39VfCtvDizdOd/bapuWGi2GXuiEi+SfeBy3iqkZ/MXX5SNPCnaysjGl/JuCNhAh2xskZvFIrWc8fte4bI72QR7ArOp7dWxrUs747997FoJPlcy91xTiesoxvlfG9HIE4HpZyXq9N9kHDKu0ed6j9zao2DEs5xiV8XBTFfcGjgOFlzC87//ycnOnTaQfix0yv3V9yI=MIIGBzCCA++gAwIBAgIKYRZoNAAAAAAAHDANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMDcwNDAzMTI1MzA5WhcNMjEwNDAzMTMwMzA5WjB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCfoWyx39tIkip8ay4Z4b3i48WZUSNQrc7dGE4kD+7Rp9FMrXQwIBHrB9VUlRVJlBtCkq6YXDAm2gBr6Hu97IkHD/cOBJjwicwfyzMkh53y9GccLPx754gd6udOo6HBI1PKjfpFzwnQXq/QsEIEovmmbJNn1yjcRlOwhtDlKEYuJ6yGT1VSDOQDLPtqkJAwbofzWTCd+n7Wl7PoIZd++NIT8wi3U21StEWQn0gASkdmEScpZqiX5NMGgUqi+YSnEUcUCYKfhO1VeP4Bmh1QCIUAEDBG7bfeI0a7xC1Un68eeEExd8yb3zuDk6FhArUdDbH895uyAc4iS1T/+QXDwiALAgMBAAGjggGrMIIBpzAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBQjNPjZUkZwCu1A+3b7syuwwzWzDzALBgNVHQ8EBAMCAYYwEAYJKwYBBAGCNxUBBAMCAQAwgZgGA1UdIwSBkDCBjYAUDqyCYEBWJ5flJRP8KuEKU5VZ5KShY6RhMF8xEzARBgoJkiaJk/IsZAEZFgNjb20xGTAXBgoJkiaJk/IsZAEZFgltaWNyb3NvZnQxLTArBgNVBAMTJE1pY3Jvc29mdCBSb290IENlcnRpZmljYXRlIEF1dGhvcml0eYIQea0WoUqgpa1Mc1j0BxMuZTBQBgNVHR8ESTBHMEWgQ6BBhj9odHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9taWNyb3NvZnRyb290Y2VydC5jcmwwVAYIKwYBBQUHAQEESDBGMEQGCCsGAQUFBzAChjhodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFJvb3RDZXJ0LmNydDATBgNVHSUEDDAKBggrBgEFBQcDCDANBgkqhkiG9w0BAQUFAAOCAgEAEJeKw1wDRDbd6bStd9vOeVFNAbEudHFbbQwTq86+e4+4LtQSooxtYrhXAstOIBNQmd16QOJXu69YmhzhHQGGrLt48ovQ7DsB7uK+jwoFyI1I4vBTFd1Pq5Lk541q1YDB5pTyBi+FA+mRKiQicPv2/OR4mS4N9wficLwYTp2OawpylbihOZxnLcVRDupiXD8WmIsgP+IHGjL5zDFKdjE9K3ILyOpwPf+FChPfwgphjvDXuBfrTot/xTUrXqO/67x9C0J71FNyIe4wyrt4ZVxbARcKFA7S2hSY9Ty5ZlizLS/n+YWGzFFW6J1wlGysOUzU9nm/qhh6YinvopspNAZ3GmLJPR5tH4LwC8csu89Ds+X57H2146SodDW4TsVxIxImdgs8UoxxWkZDFLyzs7BNZ8ifQv+AeSGAnhUwZuhCEl4ayJ4iIdBD6Svpu/RIzCzU2DKATCYqSCRfWupW76bemZ3KOm+9gSd0BhHudiG/m4LBJ1S2sWo9iaF2YbRuoROmv6pH8BJv/YoybLL+31HIjCPJZr2dHYcSZAI9La9Zj7jkIeW1sMpjtHhUBdRBLlCslLCleKuzoJZ1GtmShxN1Ii8yqAhuoFuMJb+g74TKIdbrHk/Jmu5J4PcBZW+JC33Iacjmbuqnl84xKf8OxVtc2E0bodj6L54/LlUWa8kTo/0=MIIR+AYJKoZIhvcNAQcCoIIR6TCCEeUCAQMxCzAJBgUrDgMCGgUAMIIBEwYJKoZIhvcNAQcBoIIBBASCAQAyqKPbogryWdpdKvRKQmUxhChmBJypHpKtB1dqHzSi5z0gjxh+4TlNoYKaWsd8733/Rth6Zy0uvk9rQSWSm0B1ztKpq1frRS3cUPur5GeXRAdJufbVYrERWyECiMrNowlvA8+kStcTPbINTs+FQ51gVyhpUUtwYSehUju/5yo6x5x5m6/x41L8j8breV+idFjkV12gIbWAIAeQG/QbeR3jZ17cDSLa072Ox7yFw6VUqTBh9bZ4vx8BSdYu3pS2q4tsR82DOPnMSlw5e2qNO4RRQBG6zZrbgzILRHUsxhf0IHFLvZWYbMz3khPtw+3UHHQZ+n+gcfGsafzCjtyhPl05oIIOoTCCBN4wggPGoAMCAQICEzMAAAD2OA2ahtBcpDsAAAAAAPYwDQYJKoZIhvcNAQEFBQAwdzELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEhMB8GA1UEAxMYTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBMB4XDTE4MDgyMzIwMjAwMloXDTE5MTEyMzIwMjAwMlowgc4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xKTAnBgNVBAsTIE1pY3Jvc29mdCBPcGVyYXRpb25zIFB1ZXJ0byBSaWNvMSYwJAYDVQQLEx1UaGFsZXMgVFNTIEVTTjpCQkVDLTMwQ0EtMkRCRTElMCMGA1UEAxMcTWljcm9zb2Z0IFRpbWUtU3RhbXAgU2VydmljZTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANBosOhn4XglrTQu7Xyj/rgP3wHf7dhgM30sZ2bWyo2ZS3xIq3Y9nyY12an2pJZjM6sM2zoE+t2gIs3eeG/wB0IjsVQ9jks5NJgVtJZYFeS5c8SKX/ukUFtj7ACaS0f0YdHRlvCmNRu5Tcy7WD0PJE6TqdvLNoIH/9LmtdZWKjgQlMtU5/Jf/Z5hRCgAzmL3Hp8/ZpxKCxI5i55WMtK4c6Gq0oRfm8IRIwE8fHzk996JXeK5dUIEswjSq6nYOmv6GWw/3wlxysPsZfu8y6JDzQDf+C/W+T42D3U3DV3RxVLIP+Yp/XV/Ui0YhkAj3Xa/17NSKO012YeuAHq4EC1tnbUCAwEAAaOCAQkwggEFMB0GA1UdDgQWBBSpKU+gGcTTkzZdpErDflQ4yV+cfDAfBgNVHSMEGDAWgBQjNPjZUkZwCu1A+3b7syuwwzWzDzBUBgNVHR8ETTBLMEmgR6BFhkNodHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9NaWNyb3NvZnRUaW1lU3RhbXBQQ0EuY3JsMFgGCCsGAQUFBwEBBEwwSjBIBggrBgEFBQcwAoY8aHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraS9jZXJ0cy9NaWNyb3NvZnRUaW1lU3RhbXBQQ0EuY3J0MBMGA1UdJQQMMAoGCCsGAQUFBwMIMA0GCSqGSIb3DQEBBQUAA4IBAQAYKW2DHGlQH8wPulavYv6mEtPh346IAmrwFSwANFFHnMHtFXSgDaEGYCctxd1EahjGR7EApHtMZdCrQAQTGuuzyYi2k3IU7p3HwuOBmIuP4FgsR/qXwhybDxHhmLhEkBWxcfAMtIckGw4zmQKt/VXwrbw4s3Tnf22qblhothl7ohIvkn3gct4qpGfzF1+UjTwp2srIxpfybgjYQIdsbJGbxSK1nPH7XuGyO9kEewKzqe3Vsa1LO+O/fexaCT5XMvdcU4nrKMb5XxvRyBOB6Wcl6vTfZBwyrtHneo/c2qNgxLOcYlfFwUxX3Bo4DhZcwvO//8nJzp02kH4sdMr91fciMIIGBzCCA++gAwIBAgIKYRZoNAAAAAAAHDANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMDcwNDAzMTI1MzA5WhcNMjEwNDAzMTMwMzA5WjB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCfoWyx39tIkip8ay4Z4b3i48WZUSNQrc7dGE4kD+7Rp9FMrXQwIBHrB9VUlRVJlBtCkq6YXDAm2gBr6Hu97IkHD/cOBJjwicwfyzMkh53y9GccLPx754gd6udOo6HBI1PKjfpFzwnQXq/QsEIEovmmbJNn1yjcRlOwhtDlKEYuJ6yGT1VSDOQDLPtqkJAwbofzWTCd+n7Wl7PoIZd++NIT8wi3U21StEWQn0gASkdmEScpZqiX5NMGgUqi+YSnEUcUCYKfhO1VeP4Bmh1QCIUAEDBG7bfeI0a7xC1Un68eeEExd8yb3zuDk6FhArUdDbH895uyAc4iS1T/+QXDwiALAgMBAAGjggGrMIIBpzAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBQjNPjZUkZwCu1A+3b7syuwwzWzDzALBgNVHQ8EBAMCAYYwEAYJKwYBBAGCNxUBBAMCAQAwgZgGA1UdIwSBkDCBjYAUDqyCYEBWJ5flJRP8KuEKU5VZ5KShY6RhMF8xEzARBgoJkiaJk/IsZAEZFgNjb20xGTAXBgoJkiaJk/IsZAEZFgltaWNyb3NvZnQxLTArBgNVBAMTJE1pY3Jvc29mdCBSb290IENlcnRpZmljYXRlIEF1dGhvcml0eYIQea0WoUqgpa1Mc1j0BxMuZTBQBgNVHR8ESTBHMEWgQ6BBhj9odHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9taWNyb3NvZnRyb290Y2VydC5jcmwwVAYIKwYBBQUHAQEESDBGMEQGCCsGAQUFBzAChjhodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFJvb3RDZXJ0LmNydDATBgNVHSUEDDAKBggrBgEFBQcDCDANBgkqhkiG9w0BAQUFAAOCAgEAEJeKw1wDRDbd6bStd9vOeVFNAbEudHFbbQwTq86+e4+4LtQSooxtYrhXAstOIBNQmd16QOJXu69YmhzhHQGGrLt48ovQ7DsB7uK+jwoFyI1I4vBTFd1Pq5Lk541q1YDB5pTyBi+FA+mRKiQicPv2/OR4mS4N9wficLwYTp2OawpylbihOZxnLcVRDupiXD8WmIsgP+IHGjL5zDFKdjE9K3ILyOpwPf+FChPfwgphjvDXuBfrTot/xTUrXqO/67x9C0J71FNyIe4wyrt4ZVxbARcKFA7S2hSY9Ty5ZlizLS/n+YWGzFFW6J1wlGysOUzU9nm/qhh6YinvopspNAZ3GmLJPR5tH4LwC8csu89Ds+X57H2146SodDW4TsVxIxImdgs8UoxxWkZDFLyzs7BNZ8ifQv+AeSGAnhUwZuhCEl4ayJ4iIdBD6Svpu/RIzCzU2DKATCYqSCRfWupW76bemZ3KOm+9gSd0BhHudiG/m4LBJ1S2sWo9iaF2YbRuoROmv6pH8BJv/YoybLL+31HIjCPJZr2dHYcSZAI9La9Zj7jkIeW1sMpjtHhUBdRBLlCslLCleKuzoJZ1GtmShxN1Ii8yqAhuoFuMJb+g74TKIdbrHk/Jmu5J4PcBZW+JC33Iacjmbuqnl84xKf8OxVtc2E0bodj6L54/LlUWa8kTo/2hggOwMIICmAIBATCB/qGB1KSB0TCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOkJCRUMtMzBDQS0yREJFMSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNloiUKAQEwCQYFKw4DAhoFAAMVAPziPVpBfTTz5rTgc/hZ6Dgxd/mhoIHeMIHbpIHYMIHVMQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSkwJwYDVQQLEyBNaWNyb3NvZnQgT3BlcmF0aW9ucyBQdWVydG8gUmljbzEnMCUGA1UECxMebkNpcGhlciBOVFMgRVNOOjRERTktMEM1RS0zRTA5MSswKQYDVQQDEyJNaWNyb3NvZnQgVGltZSBTb3VyY2UgTWFzdGVyIENsb2NrMA0GCSqGSIb3DQEBBQUAAgUA4A/3sTAiGA8yMDE5MDIxNDIyMjAzM1oYDzIwMTkwMjE1MjIyMDMzWjB3MD0GCisGAQQBhFkKBAExLzAtMAoCBQDgD/exAgEAMAoCAQACAiM1AgH/MAcCAQACAhu3MAoCBQDgEUkxAgEAMDYGCisGAQQBhFkKBAIxKDAmMAwGCisGAQQBhFkKAwGgCjAIAgEAAgMW42ChCjAIAgEAAgMHoSAwDQYJKoZIhvcNAQEFBQADggEBAAbK79fNzkeCEwy/S9ou3XNEinLozdEbH1W9V8Hpuvsfy2BCVXUGIkGDRSGzFh1x6txFTOyfXK14KQqRmt1DIQmJRjW0+h+BPih6+cZlTlWA3y26k1PCWWO2QSnS7ruhcVRl+C6MhGbDz8HSoRXEUI5pm0JT8PgZ/Ou9G5ywIdnz+GS0W4vkHc+T5JISSKsmw8KbntuaV+yxjlwYIHpM7hAfAsAb6FDgbXW0+JSzkacSjFOimS+TXgomsMycmfqMtFyxYgJ0wrZG5CMvqHG12V8APF6Xr1KuS6/ii7qy1GG4ZRZ8DY1rMz/Nd6OFFveeNPEjI8hBsnSomaiqKxYqUeAxggIVMIICEQIBATCBjjB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0ECEzMAAAD2OA2ahtBcpDsAAAAAAPYwCQYFKw4DAhoFAKBdMBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE5MDIxNDIxMDkyN1owIwYJKoZIhvcNAQkEMRYEFGEZnN+teN5ezHVr23UaN6flmQe7MA0GCSqGSIb3DQEBBQUABIIBAGzXBsbpiAqCms3HWjopcCAY/LiU9Oc99+SP65JCaKWuYMoXlN33ADU9q2x5vID2KWxyfCTEiB/0AUZLIi1eRNBf/AQW8nKJvbA9E0nUxBXFBPoM+N5wJ+QOLC7WKWrBcATG5Y+UVvxOvXuyHhdlZcMsoSnr+NKD/rvBFoKzcq/zTX1k+t8zMPSstB+6h3di7z3ZdJe2iFYwhbYJxRwfiWzG+451yl4ZJO2cy9+gcy3+YpXA88ArOwT94fOihf+KXo4OvdRK7nAdsKALba0kY+jb8NzGTW5lGGdeDW0YXkX92z795nl5BVxFWgEdI7Mp97YW0h9MyxWuFSVagQfmwx4= diff --git a/packages/FAKE.5.16.0/tools/NuGet.Versioning.dll b/packages/FAKE.5.16.0/tools/NuGet.Versioning.dll new file mode 100644 index 0000000..a3cc5ca Binary files /dev/null and b/packages/FAKE.5.16.0/tools/NuGet.Versioning.dll differ diff --git a/packages/FAKE.5.16.0/tools/NuGet.Versioning.xml b/packages/FAKE.5.16.0/tools/NuGet.Versioning.xml new file mode 100644 index 0000000..725f326 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/NuGet.Versioning.xml @@ -0,0 +1,1209 @@ + + + + NuGet.Versioning + + + + + The floating subset of a version range. + + + + + Create a floating range. + + Section to float. + + + + Create a floating range. + + Section to float. + Min version of the range. + + + + FloatRange + + Section to float. + Min version of the range. + The original release label. Invalid labels are allowed here. + + + + True if a min range exists. + + + + + The minimum version of the float range. This is null for cases such as * + + + + + Defined float behavior + + + + + The original release label. Invalid labels are allowed here. + + + + + True if the given version falls into the floating range. + + + + + Parse a floating version into a FloatRange + + + + + Parse a floating version into a FloatRange + + + + + Create a floating version string in the format: 1.0.0-alpha-* + + + + + Equals + + + + + Override Object.Equals + + + + + + + Hash code + + + + + An item that exposes a NuGetVersion + + + + + NuGet semantic version + + + + + IVersionComparer represents a version comparer capable of sorting and determining the equality of + SemanticVersion objects. + + + + + Version range comparer + + + + + A hybrid implementation of SemVer that supports semantic versioning as described at http://semver.org while + not strictly enforcing it to + allow older 4-digit versioning schemes to continue working. + + + + + Creates a NuGetVersion using NuGetVersion.Parse(string) + + Version string + + + + Creates a NuGetVersion from an existing NuGetVersion + + + + + Creates a NuGetVersion from a .NET Version + + Version numbers + Prerelease label + Build metadata + + + + Creates a NuGetVersion X.Y.Z + + X.y.z + x.Y.z + x.y.Z + + + + Creates a NuGetVersion X.Y.Z-alpha + + X.y.z + x.Y.z + x.y.Z + Prerelease label + + + + Creates a NuGetVersion X.Y.Z-alpha#build01 + + X.y.z + x.Y.z + x.y.Z + Prerelease label + Build metadata + + + + Creates a NuGetVersion X.Y.Z-alpha.1.2#build01 + + X.y.z + x.Y.z + x.y.Z + Prerelease labels + Build metadata + + + + Creates a NuGetVersion W.X.Y.Z + + W.x.y.z + w.X.y.z + w.x.Y.z + w.x.y.Z + + + + Creates a NuGetVersion W.X.Y.Z-alpha#build01 + + W.x.y.z + w.X.y.z + w.x.Y.z + w.x.y.Z + Prerelease label + Build metadata + + + + Creates a NuGetVersion W.X.Y.Z-alpha.1#build01 + + W.x.y.z + w.X.y.z + w.x.Y.z + w.x.y.Z + Prerelease labels + Build metadata + + + + Creates a NuGetVersion from a .NET Version with additional release labels, build metadata, and a + non-normalized version string. + + Version numbers + prerelease labels + Build metadata + Non-normalized original version string + + + + Returns the version string. + + This method includes legacy behavior. Use ToNormalizedString() instead. + Versions with SemVer 2.0.0 components are automatically normalized. + + + + A System.Version representation of the version without metadata or release labels. + + + + + True if the NuGetVersion is using legacy behavior. + + + + + Revision version R (x.y.z.R) + + + + + Returns true if version is a SemVer 2.0.0 version + + + + + Returns the original, non-normalized version string. + + + + + Creates a NuGetVersion from a string representing the semantic version. + + + + + Parses a version string using loose semantic versioning rules that allows 2-4 version components followed + by an optional special version. + + + + + Parses a version string using strict SemVer rules. + + + + + Creates a legacy version string using System.Version + + + + + Specifies the floating behavior type. + + + + + Lowest version, no float + + + + + Highest matching pre-release label + + + + + x.y.z.* + + + + + x.y.* + + + + + x.* + + + + + * + + + + + Float major and pre-release + + + + + A strongly-typed resource class, for looking up localized strings, etc. + + + + + Returns the cached ResourceManager instance used by this class. + + + + + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + + + + + Looks up a localized string similar to Value cannot be null or an empty string.. + + + + + Looks up a localized string similar to '{0}' is not a valid version string.. + + + + + A strict SemVer implementation + + + A base version operations + + + + + Creates a SemanticVersion from an existing SemanticVersion + + Version to clone. + + + + Creates a SemanticVersion X.Y.Z + + X.y.z + x.Y.z + x.y.Z + + + + Creates a NuGetVersion X.Y.Z-alpha + + X.y.z + x.Y.z + x.y.Z + Prerelease label + + + + Creates a NuGetVersion X.Y.Z-alpha#build01 + + X.y.z + x.Y.z + x.y.Z + Prerelease label + Build metadata + + + + Creates a NuGetVersion X.Y.Z-alpha.1.2#build01 + + X.y.z + x.Y.z + x.y.Z + Release labels that have been split by the dot separator + Build metadata + + + + Internal constructor. + + Version + Full release label + Build metadata + + + + Internal constructor. + + X.y.z + x.Y.z + x.y.Z + x.y.z.R + Prerelease label + Build metadata + + + + Internal constructor. + + + + + + + + + + + Internal constructor. + + Version + Release labels + Build metadata + + + + Major version X (X.y.z) + + + + + Minor version Y (x.Y.z) + + + + + Patch version Z (x.y.Z) + + + + + A collection of pre-release labels attached to the version. + + + + + The full pre-release label for the version. + + + + + True if pre-release labels exist for the version. + + + + + True if metadata exists for the version. + + + + + Build metadata attached to the version. + + + + + Gives a normalized representation of the version. + This string is unique to the identity of the version and does not contain metadata. + + + + + Gives a full representation of the version include metadata. + This string is not unique to the identity of the version. Other versions + that differ on metadata will have a different full string representation. + + + + + Get the normalized string. + + + + + Custom string format. + + + + + Internal string formatter. + + + + + Hash code + + + + + Object compare. + + + + + Compare to another SemanticVersion. + + + + + Equals + + + + + Equals + + + + + True if the VersionBase objects are equal based on the given comparison mode. + + + + + Compares NuGetVersion objects using the given comparison mode. + + + + + Equals + + + + + Not equal + + + + + Less than + + + + + Less than or equal + + + + + Greater than + + + + + Greater than or equal + + + + + Parses a SemVer string using strict SemVer rules. + + + + + Parse a version string + + false if the version is not a strict semver + + + + Parse the version string into version/release/build + The goal of this code is to take the most direct and optimized path + to parsing and validating a semver. Regex would be much cleaner, but + due to the number of versions created in NuGet Regex is too slow. + + + + + An IVersionComparer for NuGetVersion and NuGetVersion types. + + + + + Creates a VersionComparer using the default mode. + + + + + Creates a VersionComparer that respects the given comparison mode. + + comparison mode + + + + Determines if both versions are equal. + + + + + Compares the given versions using the VersionComparison mode. + + + + + Gives a hash code based on the normalized version string. + + + + + Compare versions. + + + + + Compares the 4th digit of the version number. + + + + + A default comparer that compares metadata as strings. + + + + + A comparer that uses only the version numbers. + + + + + Compares versions without comparing the metadata. + + + + + A version comparer that follows SemVer 2.0.0 rules. + + + + + Compares sets of release labels. + + + + + Release labels are compared as numbers if they are numeric, otherwise they will be compared + as strings. + + + + + Returns an array of release labels from the version, or null. + + + + + Compare release labels + + + + + Returns the fourth version number or zero. + + + + + Version comparison modes. + + + + + Semantic version 2.0.1-rc comparison with additional compares for extra NuGetVersion fields. + + + + + Compares only the version numbers. + + + + + Include Version number and Release labels in the compare. + + + + + Include all metadata during the compare. + + + + + Version extension methods. + + + + + Find the version that best matches the VersionRange and the floating behavior. + + + + + Find the version that best matches the VersionRange and the floating behavior. + + + + + Custom formatter for NuGet versions. + + + + + A static instance of the VersionFormatter class. + + + + + Format a version string. + + + + + Get version format type. + + + + + Create a normalized version string. This string is unique for each version 'identity' + and does not include leading zeros or metadata. + + + + + Create the full version string including metadata. This is primarily for display purposes. + + + + + Represents a range of versions and a preferred order. + + + Static factory methods for creating version range objects. + + + + + Creates a range that is greater than or equal to the minVersion. + + Lower bound of the version range. + + + + Creates a range that is greater than or equal to the minVersion with the given float behavior. + + Lower bound of the version range. + Floating behavior. + + + + Clones a version range and applies a new float range. + + + + + Creates a VersionRange with the given min and max. + + Lower bound of the version range. + True if minVersion satisfies the condition. + Upper bound of the version range. + True if maxVersion satisfies the condition. + The floating range subset used to find the best version match. + The original string being parsed to this object. + + + + True if the range has a floating version above the min version. + + + + + Optional floating range used to determine the best version match. + + + + + Original string being parsed to this object. + + + + + Normalized range string. + + + + + Normalized range string. + + + + + A legacy version range compatible with NuGet 2.8.3 + + + + + A short legacy version range compatible with NuGet 2.8.3. + Ex: 1.0.0 + + + + + Format the version range with an IFormatProvider + + + + + Format the range + + + + + Format the version range in Pretty Print format. + + + + + Return the version that best matches the range. + + + + + Determines if a given version is better suited to the range than a current version. + + + + + Removes the floating snapshot part of the minimum version if it exists. + Ex: 1.0.0-* -> 1.0.0 + + + + + Remove the snapshot version section of a version + + + + + ToLegacyShortString that also includes floating ranges + + + + + Equals implementation for VersionRange. + + + + + Compare the obj as VersionRange. + + + + + Returns the VersionRangeBase hashcode + + + + + A range that accepts all versions, prerelease and stable. + + + + + A range that accepts all versions, prerelease and stable, and floats to the highest. + + + + + A range that accepts all stable versions + + + + + A range that accepts all versions, prerelease and stable, and floats to the highest. + + + + + A range that rejects all versions + + + + + The version string is either a simple version or an arithmetic range + e.g. + 1.0 --> 1.0 ≤ x + (,1.0] --> x ≤ 1.0 + (,1.0) --> x < 1.0 + [1.0] --> x == 1.0 + (1.0,) --> 1.0 < x + (1.0, 2.0) --> 1.0 < x < 2.0 + [1.0, 2.0] --> 1.0 ≤ x ≤ 2.0 + + + + + Direct parse + + + + + Parses a VersionRange from its string representation. + + + + + Parses a VersionRange from its string representation. + + + + + Returns the smallest range that includes all given versions. + + + + + Returns the smallest range that includes all given versions. + + + + + Returns the smallest range that includes all given ranges. + + + + + Returns the smallest range that includes all given ranges. + + + + + Returns the greatest common range that satisfies all given ranges. + + + + + Returns the greatest common range that satisfies all given ranges. + + + + + Verify the range has an actual width. + Ex: no version can satisfy (3.0.0, 3.0.0) + + + + + A base version range that handles ranges only and not any of the preferred version logic. + + + + + Creates a VersionRange with the given min and max. + + Lower bound of the version range. + True if minVersion satisfies the condition. + Upper bound of the version range. + True if maxVersion satisfies the condition. + + + + True if MinVersion exists; + + + + + True if MaxVersion exists. + + + + + True if both MinVersion and MaxVersion exist. + + + + + True if MinVersion exists and is included in the range. + + + + + True if MaxVersion exists and is included in the range. + + + + + Maximum version allowed by this range. + + + + + Minimum version allowed by this range. + + + + + Determines if an NuGetVersion meets the requirements. + + SemVer to compare + True if the given version meets the version requirements. + + + + Determines if an NuGetVersion meets the requirements using the given mode. + + SemVer to compare + VersionComparison mode used to determine the version range. + True if the given version meets the version requirements. + + + + Determines if an NuGetVersion meets the requirements using the version comparer. + + SemVer to compare. + Version comparer used to determine if the version criteria is met. + True if the given version meets the version requirements. + + + + Compares the object as a VersionRange with the default comparer + + + + + Returns the hash code using the default comparer. + + + + + Default compare + + + + + Use the VersionRangeComparer for equality checks + + + + + Use a specific VersionComparison for comparison + + + + + Use a specific IVersionComparer for comparison + + + + + SubSet check + + + + + SubSet check + + + + + Infer if the range should allow prerelease versions based on if the lower or upper bounds + contain prerelease labels. + + + + + A version range comparer capable of using different VersionComparers to check if ranges are equivalent. + + + + + Default version range comparer. + + + + + Compare versions with a specific VersionComparison + + + + + Compare versions with a specific IVersionComparer + + + + + Default Version comparer + + + + + Compare versions using the Version and Release + + + + + Checks if two version ranges are equivalent. This follows the rules of the version comparer + when checking the bounds. + + + + + Creates a hash code based on all properties of the range. This follows the rules of the + version comparer when comparing the version bounds. + + + + + VersionRange formatter + + + + + Custom version range format provider. + + + + + Format a version range string. + + + + + Format type. + + + + + Builds a normalized string with no short hand + + + + + Builds a string to represent the VersionRange. This string can include short hand notations. + + + + + Creates a legacy short string that is compatible with NuGet 2.8.3 + + + + + Creates a legacy string that is compatible with NuGet 2.8.3 + + + + + A pretty print representation of the VersionRange. + + + + + Compares two enumberables for equality, ordered according to the specified key and optional comparer. Handles null values gracefully. + + The type of the list + The type of the sorting key + This list + The other list + The function to extract the key from each item in the list + An optional comparer for comparing keys + An optional comparer for sequences + + + + Compares two sequence for equality, allowing either sequence to be null. If one is null, both have to be + null for equality. + + + + + Compares two sets for equality, allowing either sequence to be null. + If one is null, both have to be null for equality. + + + + + Hash code creator, based on the original NuGet hash code combiner/ASP hash code combiner implementations + + + + + Create a unique hash code for the given set of items + + + + + Create a unique hash code for the given set of items + + + + + Return the enumerable as a List of T, copying if required. Optimized for common case where it is an List of T. + Avoid mutating the return value. + + https://aspnetwebstack.codeplex.com/SourceControl/latest#src/Common/CollectionExtensions.cs + + + + Return the ISet as a HashSet of T, copying if required. Optimized for common case where it is a HashSet of T. + Avoid mutating the return value. + + + +Vs4+uOqyFrJQLrQc7whCeoIzgBQ=j5tCjPIanquTMyguqTV9kAVKV3GXJ3tDwHswjFlnB/jn4ppHk8qwjCsYq+uGBoeiQoxIEoSQIJqXfVkTOje7qDEHc9bmoyzCmzSGtzGoujRl5P9Z4nSNBcV8qbpYcRVJuRYVULbQLyZ3l4klhz51q4BybgRHacuCQH1kKegCjBcIxQ5cp8wrL9hyJIOK91Y75papdD7ktR1TEgdDxtOBD2vs3yHJMMVf1aGE4pfsz2aB+RDZPq5vs848UntnCq8jc0FAfRKpdYW0iDNNQ+YcxoMDEMFCnxxgmSnVJYTvYm+0E8LniAscRAOQHfb+Mi2nAoBIQ5Uqpc8Osn3iBuL9qA==m1K+Tyy0HVPLPV0jHraDo5/A5UrgV7PC+C3WipFfzBLODN0Ct0Z49Gub3ufLICGP1D4OJZRyOnhjZi61X+Hbl/2IjqiIl1VMHR4+qWlJLRNj+X7DparTv3/CBzkhMGY2lZdvp96rpRL2heloKGkmmxqet6/sU3hvw8wxMIf29zYrMEBZSEaAUajNDIDd40qeLXRV7OanRHrVE770wiR9DP0zzeYjX5rN1CltAtUyWmonz7DJAYuUr+UMi3offSITg4byWkvThGNXGmtJeDpU6Y/hhcblP5Yl5175yMvHofLyGw0iW7kv/Izp2yjEVRe26PTXes/9nNOP7ul2KoKMoQ==AQABMIIE2zCCA8OgAwIBAgITMwAAAbHd7bpU6WW4XwABAAABsTANBgkqhkiG9w0BAQUFADB5MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSMwIQYDVQQDExpNaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQTAeFw0xODA3MTIyMDExMTlaFw0xOTA3MjYyMDExMTlaMHQxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xHjAcBgNVBAMTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJtSvk8stB1Tyz1dIx62g6OfwOVK4Fezwvgt1oqRX8wSzgzdArdGePRrm97nyyAhj9Q+DiWUcjp4Y2YutV/h25f9iI6oiJdVTB0ePqlpSS0TY/l+w6Wq079/wgc5ITBmNpWXb6feq6US9oXpaChpJpsanrev7FN4b8PMMTCH9vc2KzBAWUhGgFGozQyA3eNKni10Vezmp0R61RO+9MIkfQz9M83mI1+azdQpbQLVMlpqJ8+wyQGLlK/lDIt6H30iE4OG8lpL04RjVxprSXg6VOmP4YXG5T+WJede+cjLx6Hy8hsNIlu5L/yM6dsoxFUXtuj013rP/ZzTj+7pdiqCjKECAwEAAaOCAV8wggFbMBMGA1UdJQQMMAoGCCsGAQUFBwMDMB0GA1UdDgQWBBREE7QCnXc+kFVx9eQcf6wXFM8+czBQBgNVHREESTBHpEUwQzEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xFjAUBgNVBAUTDTIyOTgwMys0Mzc5NTAwHwYDVR0jBBgwFoAUyxHoytK0FlgByTcuMxYWuUyaCh8wVgYDVR0fBE8wTTBLoEmgR4ZFaHR0cDovL2NybC5taWNyb3NvZnQuY29tL3BraS9jcmwvcHJvZHVjdHMvTWljQ29kU2lnUENBXzA4LTMxLTIwMTAuY3JsMFoGCCsGAQUFBwEBBE4wTDBKBggrBgEFBQcwAoY+aHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraS9jZXJ0cy9NaWNDb2RTaWdQQ0FfMDgtMzEtMjAxMC5jcnQwDQYJKoZIhvcNAQEFBQADggEBAIOp8qYzxaF7HNJegK7spKbD6ShdVyUjjd0lCWlw6E1pFi+UuwXZm4DsWdBoZBuDNKjcz2ONnWt2APV7r0J0B8X8kcDirEUzll2x/fqORrJJ4kMGGZiFcXjTnunblRZBMTRwLEOWogJ3qS89YUpjWfGXfdFSlWCFqLwbRQc/2cGP91D1uX4IieRCxFiOQcCVOEkf1x34ME8pLztHWZI37pch7RdmkBwvLW1r/wt15aoS3fqvxBG04CEyWr8FzkX5P41Wrs5R1syufQQZMBLyv59IJpwOAA0oraXeRC3M1If/lEmVVwxNNJwjCt3DjTIJ9L01KMXe0Ig/qRIToTBwoBE=MIIFvDCCA6SgAwIBAgIKYTMmGgAAAAAAMTANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMTAwODMxMjIxOTMyWhcNMjAwODMxMjIyOTMyWjB5MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSMwIQYDVQQDExpNaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALJyWVwZMGS/HZpgICBCmXZTbD4b1m/My/Hqa/6XFhDg3zp0gxq3L6Ay7P/ewkJOI9VyANs1VwqJyq4gSfTwaKxNS42lvXlLcZtHB9r9Jd+ddYjPqnNEf9eB2/O98jakyVxF3K+tPeAoaJcap6Vyc1bxF5Tk/TWUcqDWdl8ed0WDhTgW0HNbBbpnUo2lsmkv2hkL/pJ0KeJ2L1TdFDBZ+NKNYv3LyV9GMVC5JxPkQDDPcikQKCLHN049oDI9kM2hOAaFXE5WgigqBTK3S9dPY+fSLWLxRT3nrAgA9kahntFbjCZT6HqqSvJGzzc8OJ60d1ylF56NyxGPVjzBrAlfA9MCAwEAAaOCAV4wggFaMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFMsR6MrStBZYAck3LjMWFrlMmgofMAsGA1UdDwQEAwIBhjASBgkrBgEEAYI3FQEEBQIDAQABMCMGCSsGAQQBgjcVAgQWBBT90TFO0yaKleGYYDuoMW+mPLzYLTAZBgkrBgEEAYI3FAIEDB4KAFMAdQBiAEMAQTAfBgNVHSMEGDAWgBQOrIJgQFYnl+UlE/wq4QpTlVnkpDBQBgNVHR8ESTBHMEWgQ6BBhj9odHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9taWNyb3NvZnRyb290Y2VydC5jcmwwVAYIKwYBBQUHAQEESDBGMEQGCCsGAQUFBzAChjhodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFJvb3RDZXJ0LmNydDANBgkqhkiG9w0BAQUFAAOCAgEAWTk+fyZGr+tvQLEytWrrDi9uqEn361917Uw7LddDrQv+y+ktMaMjzHxQmIAhXaw9L0y6oqhWnONwu7i0+Hm1SXL3PupBf8rhDBdpy6WcIC36C1DEVs0t40rSvHDnqA2iA6VW4LiKS1fylUKc8fPv7uOGHzQ8uFaa8FMjhSqkghyT4pQHHfLiTviMocroE6WRTsgb0o9ylSpxbZsa+BzwU9ZnzCL/XB3Nooy9J7J5Y1ZEolHN+emjWFbdmwJFRC9f9Nqu1IIybvyklRPk62nnqaIsvsgrEA5ljpnb9aL6EiYJZTiU8XofSrvR4Vbo0HiWGFzJNRZf3ZMdSY4tvq00RBzuEBUaAF3dNVshzpjHCe6FDoxPbQ4TTj18KUicctHzbMrB7HCjV5JXfZSNoBtIA1r3z6NnCnSlNu0tLxfI5nI3EvRvsTxngvlSso0zFmUeDordEN5k9G/ORtTTF+l5xAS00/ss3x+KnqwK+xMnQK3k+eGpf0a7B2BHZWBATrBC7E7ts3Z52Ao0CW0cgDEf4g5U3eWh++VHEK1kmP9QFi58vwUheuKVQSdpw5OPlcmN2Jshrg1cnPCiroZogwxqLbt2awAdlq3yFnv2FoMkuYjPaqhHMS+a3ONxPdcAfmJH0c6IybgY+g5yjcGjPa8CQGr/aZuW4hCoELQ3UAjWwz0=MIIFmTCCA4GgAwIBAgIQea0WoUqgpa1Mc1j0BxMuZTANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMDEwNTA5MjMxOTIyWhcNMjEwNTA5MjMyODEzWjBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDzXfqAZ9Rap6kMLJAg0DUIPHWEzbcHiZyJ2t7Ow2D6kWhanpRxKRh2fMLgyCV2lA5Y+gQ0Nubfr/eAuulYCyuT5Z0F43cikfc0ZDwikR1e4QmQvBT+/HVYGeF5tweSo66IWQjYnwfKA1j8aCltMtfSqMtL/OELSDJP5uu4rU/kXG8TlJnbldV126gat5SRtHdb9UgMj2p5fRRwBH1tr5D12nDYR7e/my9s5wW34RFgrHmRFHzF1qbk4X7Vw37lktI8ALU2gt554W3ztW74nzPJy1J9c5g224uha6KVl5uj3sJNJv8GlmclBsjnrOTuEjOVMZnINQhONMp5U9W1vmMyWUA2wKVOBE0921sHM+RYv+8/U2TYQlk1V/0PRXwkBE2e1jh0EZcikM5oRHSSb9VLb7CG48c2QqDQ/MHAWvmjYbkwR3GWChawkcBCle8Qfyhq4yofseTNAz93cQTHIPxJDx1FiKTXy36IrY4t7EXbxFEEySr87IaemhGXW97OU4jm4rf9rJXCKEDb7wSQ34EzOdmyRaUjhwalVYkxuwYtYA5BGH0fLrWXyxHrFdUkpZTvFRSJ/Utz+jJb/NEzAPlZYnAHMuouq0Ate8rdIWcbMJmPFqojqEHRsG4RmzbE3kB0nOFYZcFgHnpbOMiPuwQmfNQWQOW2a2yqhv0Av87BNQIDAQABo1EwTzALBgNVHQ8EBAMCAcYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUDqyCYEBWJ5flJRP8KuEKU5VZ5KQwEAYJKwYBBAGCNxUBBAMCAQAwDQYJKoZIhvcNAQEFBQADggIBAMURTQM6YN1dUhF3j7K7NsiyBb+0t6jYIJ1cEwO2HCL6BhM1tshj1JpHbyZX0lXxBLEmX9apUGigvNK4bszD6azfGc14rFl0rGY0NsQbPmw4TDMOMBINoyb+UVMA/69aToQNDx/kbQUuToVLjWwzb1TSZKu/UK99ejmgN+1jAw/8EwbOFjbUVDuVG1FiOuVNF9QFOZKaJ6hbqr3su77jIIlgcWxWs6UT0G0OI36VA+1oPfLYY7hrTbboMLXhypRL96KqXZkwsj2nwlFsKCABJCcrSwC3nRFrcL6yEIK8DJto0I07JIeqmShynTNfWZC99d6TnjpiWjQ54ohVHbkGsMGJay3XacMZEjaE0Mmg2v8vaXiy5Xra69cMwPe9Yxe4ORM4ojZbe/KFVmodZGLBOOKqv1FmopT1EpxmIhBr8rcwki3yKfA9OxRDaKLxnCk3y844ICVtfGfzfiQSJAMIgUfspZ6X9RjXz7vV73aW7/3O21adlaBC+ZdY4dcxItNfWeY+biIA6kOEtiXb2fMIVmjAZGsdfOy2k6JiV24u2OdYj8QxSSbd3ik1h/UwcXBbFDxpvYkSfesuo/7Yf56CWlIKK8FDK9kwiJ/IEPuJjeahhXUzfmye23MTZGJppS99ypZtn/gETTCSPW4hFCHJPeDD/YprnUr90aGdmUN3P7DaMIIGBzCCA++gAwIBAgIKYRZoNAAAAAAAHDANBgkqhkiG9w0BAQUFADBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMDcwNDAzMTI1MzA5WhcNMjEwNDAzMTMwMzA5WjB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCfoWyx39tIkip8ay4Z4b3i48WZUSNQrc7dGE4kD+7Rp9FMrXQwIBHrB9VUlRVJlBtCkq6YXDAm2gBr6Hu97IkHD/cOBJjwicwfyzMkh53y9GccLPx754gd6udOo6HBI1PKjfpFzwnQXq/QsEIEovmmbJNn1yjcRlOwhtDlKEYuJ6yGT1VSDOQDLPtqkJAwbofzWTCd+n7Wl7PoIZd++NIT8wi3U21StEWQn0gASkdmEScpZqiX5NMGgUqi+YSnEUcUCYKfhO1VeP4Bmh1QCIUAEDBG7bfeI0a7xC1Un68eeEExd8yb3zuDk6FhArUdDbH895uyAc4iS1T/+QXDwiALAgMBAAGjggGrMIIBpzAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBQjNPjZUkZwCu1A+3b7syuwwzWzDzALBgNVHQ8EBAMCAYYwEAYJKwYBBAGCNxUBBAMCAQAwgZgGA1UdIwSBkDCBjYAUDqyCYEBWJ5flJRP8KuEKU5VZ5KShY6RhMF8xEzARBgoJkiaJk/IsZAEZFgNjb20xGTAXBgoJkiaJk/IsZAEZFgltaWNyb3NvZnQxLTArBgNVBAMTJE1pY3Jvc29mdCBSb290IENlcnRpZmljYXRlIEF1dGhvcml0eYIQea0WoUqgpa1Mc1j0BxMuZTBQBgNVHR8ESTBHMEWgQ6BBhj9odHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9taWNyb3NvZnRyb290Y2VydC5jcmwwVAYIKwYBBQUHAQEESDBGMEQGCCsGAQUFBzAChjhodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFJvb3RDZXJ0LmNydDATBgNVHSUEDDAKBggrBgEFBQcDCDANBgkqhkiG9w0BAQUFAAOCAgEAEJeKw1wDRDbd6bStd9vOeVFNAbEudHFbbQwTq86+e4+4LtQSooxtYrhXAstOIBNQmd16QOJXu69YmhzhHQGGrLt48ovQ7DsB7uK+jwoFyI1I4vBTFd1Pq5Lk541q1YDB5pTyBi+FA+mRKiQicPv2/OR4mS4N9wficLwYTp2OawpylbihOZxnLcVRDupiXD8WmIsgP+IHGjL5zDFKdjE9K3ILyOpwPf+FChPfwgphjvDXuBfrTot/xTUrXqO/67x9C0J71FNyIe4wyrt4ZVxbARcKFA7S2hSY9Ty5ZlizLS/n+YWGzFFW6J1wlGysOUzU9nm/qhh6YinvopspNAZ3GmLJPR5tH4LwC8csu89Ds+X57H2146SodDW4TsVxIxImdgs8UoxxWkZDFLyzs7BNZ8ifQv+AeSGAnhUwZuhCEl4ayJ4iIdBD6Svpu/RIzCzU2DKATCYqSCRfWupW76bemZ3KOm+9gSd0BhHudiG/m4LBJ1S2sWo9iaF2YbRuoROmv6pH8BJv/YoybLL+31HIjCPJZr2dHYcSZAI9La9Zj7jkIeW1sMpjtHhUBdRBLlCslLCleKuzoJZ1GtmShxN1Ii8yqAhuoFuMJb+g74TKIdbrHk/Jmu5J4PcBZW+JC33Iacjmbuqnl84xKf8OxVtc2E0bodj6L54/LlUWa8kTo/0=MIIE3jCCA8agAwIBAgITMwAAAOtpqsw+KZ8tOQAAAAAA6zANBgkqhkiG9w0BAQUFADB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EwHhcNMTgwODIzMjAxOTMwWhcNMTkxMTIzMjAxOTMwWjCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOkI4RUMtMzBBNC03MTQ0MSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtUgVMTCRT4OJO0Mpuwvx+XO5QmP3h0rKAKfeLGh8EaWmLrpncRID7XmyosZLraSDHoz/hauMvlnCJFE+iMTvTDkSiioNZcAKBK7JDIq0vPzA559v2UunwBHaU+NueS6nYTBx54n6I4QpiE8/wr3dMz4e10eBAXd8h4OZ4ZK/YmJfSxJUGMSn70yzmSuKhQ7tIqUmmUSIt2Z3vu/zRhbKi8Aind4+ASRFpYMuE+1hD4jIpwJ1CUjZZhI0UsDRa7mz6CO2RwCUXPRjgXXvTfrv2zv+F8jDbTfEXs8RZPLw3eIFo06gqUfYhp1Ufw+/7Oesc5rM4OkRY1TG2jD/ne5PqQIDAQABo4IBCTCCAQUwHQYDVR0OBBYEFAW30KaPfAOZ1HwiXZI8utZ3J6amMB8GA1UdIwQYMBaAFCM0+NlSRnAK7UD7dvuzK7DDNbMPMFQGA1UdHwRNMEswSaBHoEWGQ2h0dHA6Ly9jcmwubWljcm9zb2Z0LmNvbS9wa2kvY3JsL3Byb2R1Y3RzL01pY3Jvc29mdFRpbWVTdGFtcFBDQS5jcmwwWAYIKwYBBQUHAQEETDBKMEgGCCsGAQUFBzAChjxodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFRpbWVTdGFtcFBDQS5jcnQwEwYDVR0lBAwwCgYIKwYBBQUHAwgwDQYJKoZIhvcNAQEFBQADggEBAHvg1mBCSvjqwnWpRZF0s84/duMABrGAur2JSbcCMVeY1Gz9xftubwtIkxaUSqtyUkGOJVdgwlUMZAT4/up2bRT896uVKcEHNweSFLqPxfeJFgsUzQ+z9ftH4S9+IX+V7o0HB4VoB92Q9Qdd56HqRJFaLzbsppXJpSXbbdtrBjjfohYSrkzlcedWQ6sANjswlYbZ4cWxGDEB3ad8YTzLnPZtcwY4R4n49UOnUavG/NB0tJRUbMOO4fyUAMBr4R20tYudgvoXRK8BVVEfYP6mQa1QG6Mh3oluJb3jJ7pYpDfMMRXh3S9Y6pofu67todxbL7afn1Vi11d6/bjN6QMHSnY=MIIR+AYJKoZIhvcNAQcCoIIR6TCCEeUCAQMxCzAJBgUrDgMCGgUAMIIBEwYJKoZIhvcNAQcBoIIBBASCAQCPm0KM8hqeq5MzKC6pNX2QBUpXcZcne0PAezCMWWcH+OfimkeTyrCMKxir64YGh6JCjEgShJAgmpd9WRM6N7uoMQdz1uajLMKbNIa3Mai6NGXk/1nidI0FxXypulhxFUm5FhVQttAvJneXiSWHPnWrgHJuBEdpy4JAfWQp6AKMFwjFDlynzCsv2HIkg4r3Vjvmlql0PuS1HVMSB0PG04EPa+zfIckwxV/VoYTil+zPZoH5ENk+rm+zzjxSe2cKryNzQUB9Eql1hbSIM01D5hzGgwMQwUKfHGCZKdUlhO9ib7QTwueICxxEA5Ad9v4yLacCgEhDlSqlzw6yfeIG4v2ooIIOoTCCBgcwggPvoAMCAQICCmEWaDQAAAAAABwwDQYJKoZIhvcNAQEFBQAwXzETMBEGCgmSJomT8ixkARkWA2NvbTEZMBcGCgmSJomT8ixkARkWCW1pY3Jvc29mdDEtMCsGA1UEAxMkTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5MB4XDTA3MDQwMzEyNTMwOVoXDTIxMDQwMzEzMDMwOVowdzELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEhMB8GA1UEAxMYTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAn6Fssd/bSJIqfGsuGeG94uPFmVEjUK3O3RhOJA/u0afRTK10MCAR6wfVVJUVSZQbQpKumFwwJtoAa+h7veyJBw/3DgSY8InMH8szJIed8vRnHCz8e+eIHernTqOhwSNTyo36Rc8J0F6v0LBCBKL5pmyTZ9co3EZTsIbQ5ShGLieshk9VUgzkAyz7apCQMG6H81kwnfp+1pez6CGXfvjSE/MIt1NtUrRFkJ9IAEpHZhEnKWaol+TTBoFKovmEpxFHFAmCn4TtVXj+AZodUAiFABAwRu233iNGu8QtVJ+vHnhBMXfMm987g5OhYQK1HQ2x/PebsgHOIktU//kFw8IgCwIDAQABo4IBqzCCAacwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUIzT42VJGcArtQPt2+7MrsMM1sw8wCwYDVR0PBAQDAgGGMBAGCSsGAQQBgjcVAQQDAgEAMIGYBgNVHSMEgZAwgY2AFA6sgmBAVieX5SUT/CrhClOVWeSkoWOkYTBfMRMwEQYKCZImiZPyLGQBGRYDY29tMRkwFwYKCZImiZPyLGQBGRYJbWljcm9zb2Z0MS0wKwYDVQQDEyRNaWNyb3NvZnQgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHmCEHmtFqFKoKWtTHNY9AcTLmUwUAYDVR0fBEkwRzBFoEOgQYY/aHR0cDovL2NybC5taWNyb3NvZnQuY29tL3BraS9jcmwvcHJvZHVjdHMvbWljcm9zb2Z0cm9vdGNlcnQuY3JsMFQGCCsGAQUFBwEBBEgwRjBEBggrBgEFBQcwAoY4aHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraS9jZXJ0cy9NaWNyb3NvZnRSb290Q2VydC5jcnQwEwYDVR0lBAwwCgYIKwYBBQUHAwgwDQYJKoZIhvcNAQEFBQADggIBABCXisNcA0Q23em0rXfbznlRTQGxLnRxW20ME6vOvnuPuC7UEqKMbWK4VwLLTiATUJndekDiV7uvWJoc4R0Bhqy7ePKL0Ow7Ae7ivo8KBciNSOLwUxXdT6uS5OeNatWAweaU8gYvhQPpkSokInD79vzkeJkuDfcH4nC8GE6djmsKcpW4oTmcZy3FUQ7qYlw/FpiLID/iBxoy+cwxSnYxPStyC8jqcD3/hQoT38IKYY7w17gX606Lf8U1K16jv+u8fQtCe9RTciHuMMq7eGVcWwEXChQO0toUmPU8uWZYsy0v5/mFhsxRVuidcJRsrDlM1PZ5v6oYemIp76KbKTQGdxpiyT0ebR+C8AvHLLvPQ7Pl+ex9teOkqHQ1uE7FcSMSJnYLPFKMcVpGQxS8s7OwTWfIn0L/gHkhgJ4VMGboQhJeGsieIiHQQ+kr6bv0SMws1NgygEwmKkgkX1rqVu+m3pmdyjpvvYEndAYR7nYhv5uCwSdUtrFqPYmhdmG0bqETpr+qR/ASb/2KMmyy/t9RyIwjyWa9nR2HEmQCPS2vWY+45CHltbDKY7R4VAXUQS5QrJSwpXirs6CWdRrZkocTdSIvMqgIbqBbjCW/oO+EyiHW6x5PyZruSeD3AWVviQt9yGnI5m7qp5fOMSn/DsVbXNhNG6HY+i+ePy5VFmvJE6P9MIIE3jCCA8agAwIBAgITMwAAAOtpqsw+KZ8tOQAAAAAA6zANBgkqhkiG9w0BAQUFADB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EwHhcNMTgwODIzMjAxOTMwWhcNMTkxMTIzMjAxOTMwWjCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOkI4RUMtMzBBNC03MTQ0MSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtUgVMTCRT4OJO0Mpuwvx+XO5QmP3h0rKAKfeLGh8EaWmLrpncRID7XmyosZLraSDHoz/hauMvlnCJFE+iMTvTDkSiioNZcAKBK7JDIq0vPzA559v2UunwBHaU+NueS6nYTBx54n6I4QpiE8/wr3dMz4e10eBAXd8h4OZ4ZK/YmJfSxJUGMSn70yzmSuKhQ7tIqUmmUSIt2Z3vu/zRhbKi8Aind4+ASRFpYMuE+1hD4jIpwJ1CUjZZhI0UsDRa7mz6CO2RwCUXPRjgXXvTfrv2zv+F8jDbTfEXs8RZPLw3eIFo06gqUfYhp1Ufw+/7Oesc5rM4OkRY1TG2jD/ne5PqQIDAQABo4IBCTCCAQUwHQYDVR0OBBYEFAW30KaPfAOZ1HwiXZI8utZ3J6amMB8GA1UdIwQYMBaAFCM0+NlSRnAK7UD7dvuzK7DDNbMPMFQGA1UdHwRNMEswSaBHoEWGQ2h0dHA6Ly9jcmwubWljcm9zb2Z0LmNvbS9wa2kvY3JsL3Byb2R1Y3RzL01pY3Jvc29mdFRpbWVTdGFtcFBDQS5jcmwwWAYIKwYBBQUHAQEETDBKMEgGCCsGAQUFBzAChjxodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY3Jvc29mdFRpbWVTdGFtcFBDQS5jcnQwEwYDVR0lBAwwCgYIKwYBBQUHAwgwDQYJKoZIhvcNAQEFBQADggEBAHvg1mBCSvjqwnWpRZF0s84/duMABrGAur2JSbcCMVeY1Gz9xftubwtIkxaUSqtyUkGOJVdgwlUMZAT4/up2bRT896uVKcEHNweSFLqPxfeJFgsUzQ+z9ftH4S9+IX+V7o0HB4VoB92Q9Qdd56HqRJFaLzbsppXJpSXbbdtrBjjfohYSrkzlcedWQ6sANjswlYbZ4cWxGDEB3ad8YTzLnPZtcwY4R4n49UOnUavG/NB0tJRUbMOO4fyUAMBr4R20tYudgvoXRK8BVVEfYP6mQa1QG6Mh3oluJb3jJ7pYpDfMMRXh3S9Y6pofu67todxbL7afn1Vi11d6/bjN6QMHSnahggOwMIICmAIBATCB/qGB1KSB0TCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOkI4RUMtMzBBNC03MTQ0MSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNloiUKAQEwCQYFKw4DAhoFAAMVAIg1IsAXX4r7CGNp+MQQcwqOZS1OoIHeMIHbpIHYMIHVMQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSkwJwYDVQQLEyBNaWNyb3NvZnQgT3BlcmF0aW9ucyBQdWVydG8gUmljbzEnMCUGA1UECxMebkNpcGhlciBOVFMgRVNOOjRERTktMEM1RS0zRTA5MSswKQYDVQQDEyJNaWNyb3NvZnQgVGltZSBTb3VyY2UgTWFzdGVyIENsb2NrMA0GCSqGSIb3DQEBBQUAAgUA4A/2SDAiGA8yMDE5MDIxNDE0MTQzMloYDzIwMTkwMjE1MTQxNDMyWjB3MD0GCisGAQQBhFkKBAExLzAtMAoCBQDgD/ZIAgEAMAoCAQACAg9LAgH/MAcCAQACAhu/MAoCBQDgEUfIAgEAMDYGCisGAQQBhFkKBAIxKDAmMAwGCisGAQQBhFkKAwGgCjAIAgEAAgMW42ChCjAIAgEAAgMHoSAwDQYJKoZIhvcNAQEFBQADggEBABDh5BEsIvg7bHL13dAkI4wr3onAtodZsdPwFzX8PcZ5i9pm+tku6tCE4R1WdfDanQFs/jwo9pMbK8Kg7gGx6xmpvIgnsmGuSgUoTdQybZ4s2kTlUOB/sFn5hTsWBRyPEP4cJTR3gqOnnWTYJ2Hg1TVaFl7faP9ccZZvAbOJI/+MtQokcqP8dNNdv0lZBmYGx3IJ1GxVrmtqUOOO/sZWPovBJhRCt57gxkBuHQMebjlOwKWu3b7ui9fnTtyIK7CKTt6OUuymmD+U+1w/ECdzom6oTVBBs1Mg3Xf0ibEzPJNwEhURruMsi8bBmBos8AmBVxJ5cSdEVmolSqkqGgsk5QYxggIVMIICEQIBATCBjjB3MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSEwHwYDVQQDExhNaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0ECEzMAAADraarMPimfLTkAAAAAAOswCQYFKw4DAhoFAKBdMBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE5MDIxNDIxMDkyNlowIwYJKoZIhvcNAQkEMRYEFJnnW0m7yZwU5JAgb0iW4hQ2iA7zMA0GCSqGSIb3DQEBBQUABIIBAHHVTo8e3wH3VnxwBTqFOQxno9EKH47ZVypZ9kh/znh7gY656lmU6ma4TWhdetDw+awzrknN/VdCx6KgYivpGO406C0mONX1zvA6g4zB265chKzS0qby5oaGlGE6cdVjopxifknKUVNVubnOt004uF0MGAWtyxRoExfBhok62TOFe58pSzo2OiwVOw+5v+qjiTDzx5Ct6cnT+HPJ2iPefseDPfupDxqkAg2Or4QoA7Vhg2/bsEU2X0TYLZBn2vcUM21y7M2YLtQZyrRH+aYPIZovKR50Q6nggk8vDXefoQS9TjrVxldJatPhUCc1yPQMChoJovjGChBlQqfvMEPw1x4= diff --git a/packages/FAKE.5.16.0/tools/Octokit.dll b/packages/FAKE.5.16.0/tools/Octokit.dll new file mode 100644 index 0000000..4a6e095 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/Octokit.dll differ diff --git a/packages/FAKE.5.16.0/tools/Octokit.xml b/packages/FAKE.5.16.0/tools/Octokit.xml new file mode 100644 index 0000000..e147ce0 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/Octokit.xml @@ -0,0 +1,36125 @@ + + + + Octokit + + + + + Authenticate a request using the basic access authentication scheme + + The request to authenticate + The credentials to attach to the request + + See the Basic Authentication documentation for more information. + + + + + Authenticate a request using the OAuth2 Token (sent in a header) authentication scheme + + The request to authenticate + The credentials to attach to the request + + See the OAuth2 Token (sent in a header) documentation for more information. + + + + + Indicate to the serializer that this property or value + has a different representation when being serialized to JSON + + + + + The key to use in place of the property's name + + + + + The name to use in place of the enum's value + + + + + Indicate to the serializer that this property or field + should be included, even when currently set to `null` + + + + + Wrapper for a response from the API + + Payload contained in the response + + + + Create a ApiResponse from an existing request + + An existing request to wrap + + + + Create a ApiResponse from an existing request and object + + An existing request to wrap + The payload from an existing request + + + + The payload of the response + + + + + The context of the response + + + + + Generic Http client. Useful for those who want to swap out System.Net.HttpClient with something else. + + + Most folks won't ever need to swap this out. But if you're trying to run this on Windows Phone, you might. + + + + + Sends the specified request and returns a response. + + A that represents the HTTP request + Used to cancel the request + A of + + + + Set the GitHub Api request timeout. + + The Timeout value + + + + Generic Http client. Useful for those who want to swap out System.Net.HttpClient with something else. + + + Most folks won't ever need to swap this out. But if you're trying to run this on Windows Phone, you might. + + + + + Sends the specified request and returns a response. + + A that represents the HTTP request + Used to cancel the request + A of + + + + Set the GitHub Api request timeout. + + The Timeout value + + + + Abstraction for interacting with credentials + + + + + Create an instance of the InMemoryCredentialStore + + + + + + Retrieve the credentials from the underlying store + + A continuation containing credentials + + + + Responsible for serializing the request and response as JSON and + adding the proper JSON response header. + + + + + Represents a generic HTTP response + + + + + Raw response body. Typically a string, but when requesting images, it will be a byte array. + + + + + Information about the API. + + + + + Information about the API response parsed from the response headers. + + + + + The response status code. + + + + + The content type of the response. + + + + + Total number of matching items. + + + + + True if the query timed out and it's possible that the results are incomplete. + + + + + The found items. Up to 100 per page. + + + + + Authentication protocols supported by the GitHub API + + + + + No credentials provided + + + + + Username & password + + + + + Delegated access to a third party + + + + + Credential for GitHub App using signed JWT + + + + + A client for GitHub's Activity API. + + + See the Activity API documentation for more information. + + + + + Instantiate a new GitHub Activities API client. + + An API connection + + + + Client for the Events API + + + + + Client for the Starring API + + + + + Client for the Watching API + + + + + Client for the Feeds API + + + + + Client for the Notifications API + + + + + Base class for an API client. + + + + + Initializes a new API client. + + The client's connection + + + + Gets the API client's connection. + + + The API client's connection + + + + + Returns the underlying used by the . This is useful + for requests that need to access the HTTP response and not just the response model. + + + + + Used to paginate through API response results. + + + This is meant to be internal, but I factored it out so we can change our mind more easily later. + + + + + A client for GitHub's Issue Assignees API. + + + See the Issue Assignees API documentation for more information. + + + + + Instantiates a new GitHub Issue Assignees API client. + + An API connection + + + + Gets all the available assignees (owner + collaborators) to which issues may be assigned. + + The owner of the repository + The name of the repository + + + + Gets all the available assignees (owner + collaborators) to which issues may be assigned. + + The Id of the repository + + + + Gets all the available assignees (owner + collaborators) to which issues may be assigned. + + The owner of the repository + The name of the repository + The options to change API's response. + + + + Gets all the available assignees (owner + collaborators) to which issues may be assigned. + + The Id of the repository + The options to change API's response. + + + + Checks to see if a user is an assignee for a repository. + + The owner of the repository + The name of the repository + Username of the prospective assignee + + + + Add assignees to a specified Issue. + + The owner of the repository + The name of the repository + The issue number + List of names of assignees to add + + + + + Remove assignees from a specified Issue. + + The owner of the repository + The name of the repository + The issue number + List of assignees to remove + + + + + Checks to see if a user is an assignee for a repository. + + The Id of the repository + Username of the prospective assignee + + + + A client for GitHub's OAuth API. + + + See the OAuth API documentation for more details. + + + + + Initializes a new GitHub OAuth API client. + + An API connection + + + + Gets all s for the authenticated user. + + + This method requires authentication. + See the API documentation for more information. + + + Thrown when the current user does not have permission to make the request. + + Thrown when a general API error occurs. + A list of s for the authenticated user. + + + + Gets all s for the authenticated user. + + + This method requires authentication. + See the API documentation for more information. + + Options for changing the API response + + Thrown when the current user does not have permission to make the request. + + Thrown when a general API error occurs. + A list of s for the authenticated user. + + + + Gets a specific for the authenticated user. + + + This method requires authentication. + See the API documentation for more information. + + The Id of the to get + + Thrown when the current user does not have permission to make this request. + + Thrown when a general API error occurs. + The specified . + + + + Creates a new personal token for the authenticated user. + + + This method requires authentication. + See the API documentation for more information. + + Describes the new authorization to create + + Thrown when the current user does not have permission to make this request. + + + Thrown when the current account has two-factor authentication enabled and an authentication code is required. + + Thrown when a general API error occurs. + The created . + + + + Creates a new personal token for the authenticated user. + + + This method requires authentication. + See the API documentation for more information. + + The two-factor authentication code in response to the current user's previous challenge + Describes the new authorization to create + + Thrown when the current user does not have permission to make this request. + + + Thrown when the current account has two-factor authentication enabled and an authentication code is required. + + Thrown when a general API error occurs. + The created . + + + + Creates a new authorization for the specified OAuth application if an authorization for that application + doesn’t already exist for the user; otherwise, it fails. + + + This method requires authentication. + See the API documentation for more information. + + Client Id of the OAuth application for the token + The client secret + Describes the new authorization to create + + Thrown when the current user does not have permission to make this request. + + + Thrown when the current account has two-factor authentication enabled and an authentication code is required. + + Thrown when a general API error occurs. + The created . + + + + Creates a new authorization for the specified OAuth application if an authorization for that application + doesn’t already exist for the user; otherwise, it fails. + + + This method requires authentication. + See the API documentation for more information. + + Client Id of the OAuth application for the token + The client secret + The two-factor authentication code in response to the current user's previous challenge + Describes the new authorization to create + + Thrown when the current user does not have permission to make this request. + + + Thrown when the current account has two-factor authentication enabled and an authentication code is required. + + Thrown when a general API error occurs. + The created . + + + + Creates a new authorization for the specified OAuth application if an authorization for that application doesn’t already + exist for the user; otherwise, returns the user’s existing authorization for that application. + + + This method requires authentication. + See the API documentation for more information. + + Client Id of the OAuth application for the token + The client secret + Describes the new authorization to create + + Thrown when the current user does not have permission to make this request. + + + Thrown when the current account has two-factor authentication enabled and an authentication code is required. + + Thrown when a general API error occurs. + The created . + + + + Creates a new authorization for the specified OAuth application if an authorization for that application doesn’t already + exist for the user; otherwise, returns the user’s existing authorization for that application. + + + This method requires authentication. + See the API documentation for more information. + + Client Id of the OAuth application for the token + The client secret + Describes the new authorization to create + The two-factor authentication code in response to the current user's previous challenge + + Thrown when the current user does not have permission to make this request. + + + Thrown when the current account has two-factor authentication enabled and an authentication code is required. + + Thrown when a general API error occurs. + The created . + + + + Checks the validity of an OAuth token without running afoul of normal rate limits for failed login attempts. + + + This method requires authentication. + See the API documentation for more information. + + Client Id of the OAuth application for the token + The OAuth token to check + The valid . + + + + Resets a valid OAuth token for an OAuth application without end user involvement. + + + This method requires authentication. + See the API documentation for more information. + + ClientID of the OAuth application for the token + The OAuth token to reset + The valid with a new OAuth token + + + + Revokes a single OAuth token for an OAuth application. + + + This method requires authentication. + See the API documentation for more information. + + ClientID of the OAuth application for the token + The OAuth token to revoke + A for the request's execution. + + + + Updates the specified . + + + This method requires authentication. + See the API + documentation for more details. + + Id of the to update + Describes the changes to make to the authorization + + Thrown when the current user does not have permission to make the request. + + Thrown when a general API error occurs. + The updated . + + + + Deletes the specified . + + + This method requires authentication. + See the API + documentation for more details. + + The system-wide Id of the authorization to delete + + Thrown when the current user does not have permission to make the request. + + Thrown when a general API error occurs. + A for the request's execution. + + + + Deletes the specified . + + + This method requires authentication. + See the API + documentation for more details. + + The system-wide Id of the authorization to delete + Two factor authorization code + + Thrown when the current user does not have permission to make the request. + + Thrown when a general API error occurs. + A for the request's execution. + + + + A client for GitHub's Git Blobs API. + + + See the Git Blobs API documentation for more information. + + + + + Instantiates a new GitHub Git Blobs API client. + + An API connection + + + + Gets a single Blob by SHA. + + + http://developer.github.com/v3/git/blobs/#get-a-blob + + The owner of the repository + The name of the repository + The SHA of the blob + + + + Gets a single Blob by SHA. + + + http://developer.github.com/v3/git/blobs/#get-a-blob + + The Id of the repository + The SHA of the blob + + + + Creates a new Blob + + + http://developer.github.com/v3/git/blobs/#create-a-blob + + The owner of the repository + The name of the repository + The new Blob + + + + Creates a new Blob + + + http://developer.github.com/v3/git/blobs/#create-a-blob + + The Id of the repository + The new Blob + + + + A client for GitHub's Check Runs API + + + See the Check Runs API documentation for more information. + + + + + Initializes a new GitHub Check Runs API client + + An API connection + + + + Creates a new check run for a specific commit in a repository + + + See the Check Runs API documentation for more information. + + The owner of the repository + The name of the repository + Details of the Check Run to create + + + + Creates a new check run for a specific commit in a repository + + + See the Check Runs API documentation for more information. + + The Id of the repository + Details of the Check Run to create + + + + Updates a check run for a specific commit in a repository + + + See the Check Runs API documentation for more information. + + The owner of the repository + The name of the repository + The Id of the check run + The updates to the check run + + + + Updates a check run for a specific commit in a repository + + + See the Check Runs API documentation for more information. + + The Id of the repository + The Id of the check run + The updates to the check run + + + + Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name + + + See the Check Runs API documentation for more information. + + The owner of the repository + The name of the repository + The commit reference (can be a SHA, branch name, or a tag name) + + + + Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name + + + See the Check Runs API documentation for more information. + + The Id of the repository + The commit reference (can be a SHA, branch name, or a tag name) + + + + Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name + + + See the Check Runs API documentation for more information. + + The owner of the repository + The name of the repository + The commit reference (can be a SHA, branch name, or a tag name) + Details to filter the request, such as by check name + + + + Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name + + + See the Check Runs API documentation for more information. + + The Id of the repository + The commit reference (can be a SHA, branch name, or a tag name) + Details to filter the request, such as by check name + + + + Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name + + + See the Check Runs API documentation for more information. + + The owner of the repository + The name of the repository + The commit reference (can be a SHA, branch name, or a tag name) + Details to filter the request, such as by check name + Options to change the API response + + + + Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name + + + See the Check Runs API documentation for more information. + + The Id of the repository + The commit reference (can be a SHA, branch name, or a tag name) + Details to filter the request, such as by check name + Options to change the API response + + + + Lists check runs for a check suite using its Id + + + See the Check Runs API documentation for more information. + + The owner of the repository + The name of the repository + The Id of the check suite + + + + Lists check runs for a check suite using its Id + + + See the Check Runs API documentation for more information. + + The Id of the repository + The Id of the check suite + + + + Lists check runs for a check suite using its Id + + + See the Check Runs API documentation for more information. + + The owner of the repository + The name of the repository + The Id of the check suite + Details to filter the request, such as by check name + + + + Lists check runs for a check suite using its Id + + + See the Check Runs API documentation for more information. + + The Id of the repository + The Id of the check suite + Details to filter the request, such as by check name + + + + Lists check runs for a check suite using its Id + + + See the Check Runs API documentation for more information. + + The owner of the repository + The name of the repository + The Id of the check suite + Details to filter the request, such as by check name + Options to change the API response + + + + Lists check runs for a check suite using its Id + + + See the Check Runs API documentation for more information. + + The Id of the repository + The Id of the check suite + Details to filter the request, such as by check name + Options to change the API response + + + + Gets a single check run using its Id + + + See the Check Runs API documentation for more information. + + The owner of the repository + The name of the repository + The Id of the check run + + + + Gets a single check run using its Id + + + See the Check Runs API documentation for more information. + + The Id of the repository + The Id of the check run + + + + Lists annotations for a check run using the check run Id + + + See the Check Runs API documentation for more information. + + The owner of the repository + The name of the repository + The Id of the check run + + + + Lists annotations for a check run using the check run Id + + + See the Check Runs API documentation for more information. + + The Id of the repository + The Id of the check run + + + + + Lists annotations for a check run using the check run Id + + + See the Check Runs API documentation for more information. + + The owner of the repository + The name of the repository + The Id of the check run + Options to change the API response + + + + Lists annotations for a check run using the check run Id + + + See the Check Runs API documentation for more information. + + The Id of the repository + The Id of the check run + Options to change the API response + + + + A client for GitHub's Checks API. + + + See the Checks API documentation for more information. + + + + + Initializes a new GitHub Checks API client. + + An API connection + + + + A client for GitHub's Check Runs API. + + + See the Check Runs API documentation for more information. + + + + + A client for GitHub's Check Suites API. + + + See the Check Suites API documentation for more information. + + + + + A client for GitHub's Check Suites API. + + + See the Check Suites API documentation for more information. + + + + + Initializes a new GitHub Check Suites API client. + + An API connection + + + + Gets a single Check Suite by Id + + + See the Check Suites API documentation for more information. + + The owner of the repository + The name of the repository + The Id of the check suite + + + + Gets a single Check Suite by Id + + + See the Check Suites API documentation for more information. + + The Id of the repository + The Id of the check suite + + + + Lists Check Suites for a commit reference (SHA, branch name or tag name) + + + See the Check Suites API documentation for more information. + + The owner of the repository + The name of the repository + The reference (SHA, branch name or tag name) to list check suites for + + + + Lists Check Suites for a commit reference (SHA, branch name or tag name) + + + See the Check Suites API documentation for more information. + + The Id of the repository + The reference (SHA, branch name or tag name) to list check suites for + + + + Lists Check Suites for a commit reference (SHA, branch name or tag name) + + + See the Check Suites API documentation for more information. + + The owner of the repository + The name of the repository + The reference (SHA, branch name or tag name) to list check suites for + Details to filter the request, such as by App Id or Check Name + + + + Lists Check Suites for a commit reference (SHA, branch name or tag name) + + + See the Check Suites API documentation for more information. + + The Id of the repository + The reference (SHA, branch name or tag name) to list check suites for + Details to filter the request, such as by App Id or Check Name + + + + Lists Check Suites for a commit reference (SHA, branch name or tag name) + + + See the Check Suites API documentation for more information. + + The owner of the repository + The name of the repository + The reference (SHA, branch name or tag name) to list check suites for + Details to filter the request, such as by App Id or Check Name + Options to change the API response + + + + Lists Check Suites for a commit reference (SHA, branch name or tag name) + + + See the Check Suites API documentation for more information. + + The Id of the repository + The reference (SHA, branch name or tag name) to list check suites for + Details to filter the request, such as by App Id or Check Name + Options to change the API response + + + + Updates Check Suites prefrences on a repository, such as disabling automatic creation when code is pushed + + + See the Check Suites API documentation for more information. + + The owner of the repository + The name of the repository + The check suite preferences + + + + Updates Check Suites prefrences on a repository, such as disabling automatic creation when code is pushed + + + See the Check Suites API documentation for more information. + + The Id of the repository + The check suite preferences + + + + Creates a new Check Suite + + + See the Check Suites API documentation for more information. + + The owner of the repository + The name of the repository + Details of the Check Suite to create + + + + Creates a new Check Suite + + + See the Check Suites API documentation for more information. + + The Id of the repository + Details of the Check Suite to create + + + + Triggers GitHub to create a new check suite, without pushing new code to a repository + + + See the Check Suites API documentation for more information. + + The owner of the repository + The name of the repository + Details of the Check Suite request + + + + Triggers GitHub to create a new check suite, without pushing new code to a repository + + + See the Check Suites API documentation for more information. + + The Id of the repository + Details of the Check Suite request + + + + Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository + + + See the Check Suites API documentation for more information. + + The owner of the repository + The name of the repository + The Id of the check suite + + + + Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository + + + See the Check Suites API documentation for more information. + + The Id of the repository + The Id of the check suite + + + + A client for GitHub's Reactions API. + + + See the Reactions API documentation for more information. + + + + + Creates a reaction for a specified Commit Comment + + https://developer.github.com/v3/reactions/#create-reaction-for-a-commit-comment + The owner of the repository + The name of the repository + The comment id + The reaction to create + + + + + Creates a reaction for a specified Commit Comment + + https://developer.github.com/v3/reactions/#create-reaction-for-a-commit-comment + The owner of the repository + The comment id + The reaction to create + + + + + Get all reactions for a specified Commit Comment + + https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment + The owner of the repository + The name of the repository + The comment id + + + + + Get all reactions for a specified Commit Comment + + https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment + The owner of the repository + The comment id + + + + + A client for GitHub's Git Commits API. + + + See the Git Commits API documentation for more information. + + + + + Instantiates a new GitHub Git Commits API client. + + An API connection + + + + Gets a commit for a given repository by sha reference + + + http://developer.github.com/v3/git/commits/#get-a-commit + + The owner of the repository + The name of the repository + Tha sha reference of the commit + + + + Gets a commit for a given repository by sha reference + + + http://developer.github.com/v3/git/commits/#get-a-commit + + The Id of the repository + Tha sha reference of the commit + + + + Create a commit for a given repository + + + http://developer.github.com/v3/git/commits/#create-a-commit + + The owner of the repository + The name of the repository + The commit to create + + + + Create a commit for a given repository + + + http://developer.github.com/v3/git/commits/#create-a-commit + + The Id of the repository + The commit to create + + + + A client for GitHub's Git Repository Status API. + + + See the Repository Statuses API documentation for more information. + + + + + Initializes a new Commit Status API client. + + An API connection + + + + Retrieves commit statuses for the specified reference. A reference can be a commit SHA, a branch name, or + a tag name. + + + https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref + + The owner of the repository + The name of the repository + The reference (SHA, branch name, or tag name) to list commits for + + + + Retrieves commit statuses for the specified reference. A reference can be a commit SHA, a branch name, or + a tag name. + + + https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref + + The Id of the repository + The reference (SHA, branch name, or tag name) to list commits for + + + + Retrieves commit statuses for the specified reference. A reference can be a commit SHA, a branch name, or + a tag name. + + + https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref + + The owner of the repository + The name of the repository + The reference (SHA, branch name, or tag name) to list commits for + Options for changing the API response + + + + Retrieves commit statuses for the specified reference. A reference can be a commit SHA, a branch name, or + a tag name. + + + https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref + + The Id of the repository + The reference (SHA, branch name, or tag name) to list commits for + Options for changing the API response + + + + Retrieves a combined view of statuses for the specified reference. A reference can be a commit SHA, a branch name, or + a tag name. + + + https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref + + The owner of the repository + The name of the repository + The reference (SHA, branch name, or tag name) to list commits for + + + + Retrieves a combined view of statuses for the specified reference. A reference can be a commit SHA, a branch name, or + a tag name. + + + https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref + + The Id of the repository + The reference (SHA, branch name, or tag name) to list commits for + + + + Creates a commit status for the specified ref. + + + https://developer.github.com/v3/repos/statuses/#create-a-status + + The owner of the repository + The name of the repository + The reference (SHA, branch name, or tag name) to list commits for + The commit status to create + + + + Creates a commit status for the specified ref. + + + https://developer.github.com/v3/repos/statuses/#create-a-status + + The Id of the repository + The reference (SHA, branch name, or tag name) to list commits for + The commit status to create + + + + A client for GitHub's Repository Deployments API. + Gets and creates Deployments. + + + See the Repository Deployments API documentation for more information. + + + + + Instantiates a new GitHub Repository Deployments API client. + + An API connection + + + + Gets all the deployments for the specified repository. Any user with pull access + to a repository can view deployments. + + + http://developer.github.com/v3/repos/deployments/#list-deployments + + The owner of the repository + The name of the repository + + + + Gets all the deployments for the specified repository. Any user with pull access + to a repository can view deployments. + + + http://developer.github.com/v3/repos/deployments/#list-deployments + + The Id of the repository + + + + Gets all the deployments for the specified repository. Any user with pull access + to a repository can view deployments. + + + http://developer.github.com/v3/repos/deployments/#list-deployments + + The owner of the repository + The name of the repository + Options for changing the API response + + + + Gets all the deployments for the specified repository. Any user with pull access + to a repository can view deployments. + + + http://developer.github.com/v3/repos/deployments/#list-deployments + + The Id of the repository + Options for changing the API response + + + + Creates a new deployment for the specified repository. + Users with push access can create a deployment for a given ref. + + + http://developer.github.com/v3/repos/deployments/#create-a-deployment + + The owner of the repository + The name of the repository + A instance describing the new deployment to create + + + + Creates a new deployment for the specified repository. + Users with push access can create a deployment for a given ref. + + + http://developer.github.com/v3/repos/deployments/#create-a-deployment + + The Id of the repository + A instance describing the new deployment to create + + + + Client for managing deployment status. + + + + + A client for GitHub's Repository Deployment Statuses API. + Gets and creates Deployment Statuses. + + + See the Repository Deployment Statuses API documentation for more information. + + + + + Gets all the statuses for the given deployment. Any user with pull access to a repository can + view deployments. + + + http://developer.github.com/v3/repos/deployments/#list-deployment-statuses + + The owner of the repository. + The name of the repository. + The id of the deployment. + + + + Gets all the statuses for the given deployment. Any user with pull access to a repository can + view deployments. + + + http://developer.github.com/v3/repos/deployments/#list-deployment-statuses + + The Id of the repository. + The id of the deployment. + + + + Gets all the statuses for the given deployment. Any user with pull access to a repository can + view deployments. + + + http://developer.github.com/v3/repos/deployments/#list-deployment-statuses + + The owner of the repository. + The name of the repository. + The id of the deployment. + Options for changing the API response + + + + Gets all the statuses for the given deployment. Any user with pull access to a repository can + view deployments. + + + http://developer.github.com/v3/repos/deployments/#list-deployment-statuses + + The Id of the repository. + The id of the deployment. + Options for changing the API response + + + + Creates a new status for the given deployment. Users with push access can create deployment + statuses for a given deployment. + + + http://developer.github.com/v3/repos/deployments/#create-a-deployment-status + + The owner of the repository. + The name of the repository. + The id of the deployment. + The new deployment status to create. + + + + Creates a new status for the given deployment. Users with push access can create deployment + statuses for a given deployment. + + + http://developer.github.com/v3/repos/deployments/#create-a-deployment-status + + The Id of the repository. + The id of the deployment. + The new deployment status to create. + + + + A client for GitHub's Enterprise Admin Stats API + + + See the Enterprise Admin Stats API documentation for more information. + + + + + Gets GitHub Enterprise Issue statistics (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/admin_stats/#get-statistics + + The statistics. + + + + Gets GitHub Enterprise Hook statistics (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/admin_stats/#get-statistics + + The statistics. + + + + Gets GitHub Enterprise Milestone statistics (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/admin_stats/#get-statistics + + The statistics. + + + + Gets GitHub Enterprise Organization statistics (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/admin_stats/#get-statistics + + The statistics. + + + + Gets GitHub Enterprise Comment statistics (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/admin_stats/#get-statistics + + The statistics. + + + + Gets GitHub Enterprise Pages statistics (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/admin_stats/#get-statistics + + The statistics. + + + + Gets GitHub Enterprise User statistics (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/admin_stats/#get-statistics + + The statistics. + + + + Gets GitHub Enterprise Gist statistics (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/admin_stats/#get-statistics + + The statistics. + + + + Gets GitHub Enterprise PullRequest statistics (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/admin_stats/#get-statistics + + The statistics. + + + + Gets GitHub Enterprise Repository statistics (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/admin_stats/#get-statistics + + The statistics. + + + + Gets GitHub Enterprise statistics (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/admin_stats/#get-statistics + + The collection of statistics. + + + + A client for GitHub's Enterprise API. + + + See the Enterprise API documentation for more information. + + + + + Instantiates a new GitHub Enterprise API client. + + An API connection + + + + A client for GitHub's Enterprise Admin Stats API + + + See the Enterprise Admin Stats API documentation for more information. + + + + + A client for GitHub's Enterprise LDAP API + + + See the Enterprise LDAP API documentation for more information. + + + + + A client for GitHub's Enterprise License API + + + See the Enterprise License API documentation for more information. + + + + + A client for GitHub's Enterprise Organization API + + + See the Enterprise Organization API documentation for more information. + + + + + A client for GitHub's Enterprise Search Indexing API + + + See the Enterprise Search Indexing API documentation for more information. + + + + + A client for GitHub's Enterprise Pre-receive Environments API + + + See the Enterprise Pre-receive Environments API documentation for more information. + + + + + A client for GitHub's Enterprise LDAP API + + + See the Enterprise LDAP API documentation for more information. + + + + + Update the LDAP mapping for a user on a GitHub Enterprise appliance (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/ldap/#update-ldap-mapping-for-a-user + + The username to update LDAP mapping + The + The object. + + + + Queue an LDAP Sync job for a user on a GitHub Enterprise appliance (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/ldap/#sync-ldap-mapping-for-a-user + + The userName to sync LDAP mapping + The of the queue request. + + + + Update the LDAP mapping for a team on a GitHub Enterprise appliance (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/ldap/#update-ldap-mapping-for-a-team + + The teamId to update LDAP mapping + The + The object. + + + + Queue an LDAP Sync job for a team on a GitHub Enterprise appliance (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/ldap/#sync-ldap-mapping-for-a-team + + The teamId to update LDAP mapping + The of the queue request. + + + + A client for GitHub's Enterprise License API + + + See the Enterprise License API documentation for more information. + + + + + Gets GitHub Enterprise License Information (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/license/#get-license-information + + The statistics. + + + + A client for GitHub's Enterprise Organization API + + + See the Enterprise Organization API documentation for more information. + + + + + Creates an Organization on a GitHub Enterprise appliance (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/orgs/#create-an-organization + + A instance describing the organization to be created + The created. + + + + A client for GitHub's Enterprise Pre-receive Environments API + + + See the Enterprise Pre-receive Environments API documentation for more information. + + + + + Initializes a new instance of . + + An API connection + + + + Gets all s. + + + See the API documentation for more information. + + Thrown when a general API error occurs. + + + + Gets all s. + + + See the API documentation for more information. + + Options for changing the API response + Thrown when a general API error occurs. + + + + Gets a single . + + + See the API documentation for more information. + + The id of the pre-receive environment + Thrown when the specified does not exist. + Thrown when a general API error occurs. + + + + Creates a new . + + + See the API documentation for more information. + + A description of the pre-receive environment to create + Thrown when a general API error occurs. + + + + Edits an existing . + + + See the API documentation for more information. + + The id of the pre-receive environment + A description of the pre-receive environment to edit + Thrown when the specified does not exist. + Thrown when a general API error occurs. + + + + Deletes an existing . + + + See the API documentation for more information. + + The id of the pre-receive environment + Thrown when the specified does not exist. + Thrown when a general API error occurs. + + + + Gets the download status for an existing . + + + See the API documentation for more information. + + The id of the pre-receive environment + Thrown when the specified does not exist. + Thrown when a general API error occurs. + + + + Triggers a new download of the 's tarball from the environment's . + When the download is finished, the newly downloaded tarball will overwrite the existing environment. + + + See the API documentation for more information. + + The id of the pre-receive environment + Thrown when the specified does not exist. + Thrown when a general API error occurs. + + + + Service used to check if a GitHub Enterprise instance lives at a given URL. + + + + + Creates a new EnterpriseProbe, used to check for the existence of GitHub Enterprise Instances + + + See more information regarding User-Agent requirements here: https://developer.github.com/v3/#user-agent-required + + + The name (and optionally version) of the product using this library, the name of your GitHub organization, or your GitHub username (in that order of preference). This is sent to the server as part of + the user agent for analytics purposes, and used by GitHub to contact you if there are problems. + + + + + Creates a new EnterpriseProbe, used to check for the existence of GitHub Enterprise Instances + + + See more information regarding User-Agent requirements here: https://developer.github.com/v3/#user-agent-required + + + The name (and optionally version) of the product using this library, the name of your GitHub organization, or your GitHub username (in that order of preference). This is sent to the server as part of + the user agent for analytics purposes, and used by GitHub to contact you if there are problems. + + + The client to use for executing requests + + + + + Makes a request to the specified URL and returns whether or not the probe could definitively determine that a GitHub + Enterprise Instance exists at the specified URL. + + + The probe checks the absolute path /site/sha at the specified . + + The URL to test + An with either , + , or in the case the request failed + + + + Yep! It's an Enterprise server + + + + + Got a response from a server, but it wasn't an Enterprise server + + + + + Request timed out or DNS failed. So it's probably the case it's not an enterprise server but + we can't know for sure. + + + + + A client for GitHub's Enterprise Search Indexing API + + + See the Enterprise Search Indexing API documentation for more information. + + + + + Queue an indexing job for a user or organization account (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/search_indexing/#queue-an-indexing-job + + A user or organization account + The message. + + + + Queue an indexing job for a repository (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/search_indexing/#queue-an-indexing-job + + A user or organization account + A repository + The message. + + + + Queue an indexing job for all of a user or organization's repositories (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/search_indexing/#queue-an-indexing-job + + A user or organization account + The message. + + + + Queue an indexing job for all the issues in a repository (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/search_indexing/#queue-an-indexing-job + + A user or organization account + A repository + The message. + + + + Queue an indexing job for all the issues in all of a user or organization's repositories (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/search_indexing/#queue-an-indexing-job + + A user or organization account + The message. + + + + Queue an indexing job for all the source code in a repository (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/search_indexing/#queue-an-indexing-job + + A user or organization account + A repository + The message. + + + + Queue an indexing job for all the source code in all of a user or organization's repositories (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/search_indexing/#queue-an-indexing-job + + A user or organization account + The message. + + + + A client for GitHub's Enterprise Admin Stats API + + + See the Enterprise Admin Stats API documentation for more information. + + + + + Gets GitHub Enterprise Issue statistics (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/admin_stats/#get-statistics + + The statistics. + + + + Gets GitHub Enterprise Hook statistics (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/admin_stats/#get-statistics + + The statistics. + + + + Gets GitHub Enterprise Milestone statistics (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/admin_stats/#get-statistics + + The statistics. + + + + Gets GitHub Enterprise Organization statistics (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/admin_stats/#get-statistics + + The statistics. + + + + Gets GitHub Enterprise Comment statistics (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/admin_stats/#get-statistics + + The statistics. + + + + Gets GitHub Enterprise Pages statistics (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/admin_stats/#get-statistics + + The statistics. + + + + Gets GitHub Enterprise User statistics (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/admin_stats/#get-statistics + + The statistics. + + + + Gets GitHub Enterprise Gist statistics (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/admin_stats/#get-statistics + + The statistics. + + + + Gets GitHub Enterprise PullRequest statistics (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/admin_stats/#get-statistics + + The statistics. + + + + Gets GitHub Enterprise Repository statistics (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/admin_stats/#get-statistics + + The statistics. + + + + Gets GitHub Enterprise statistics (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/admin_stats/#get-statistics + + The collection of statistics. + + + + A client for GitHub's Enterprise API. + + + See the Enterprise API documentation for more information. + + + + + A client for GitHub's Enterprise Admin Stats API + + + See the Enterprise Admin Stats API documentation for more information. + + + + + A client for GitHub's Enterprise LDAP API + + + See the Enterprise LDAP API documentation for more information. + + + + + A client for GitHub's Enterprise License API + + + See the Enterprise License API documentation for more information. + + + + + A client for GitHub's Enterprise Organization API + + + See the Enterprise Organization API documentation for more information. + + + + + A client for GitHub's Enterprise Search Indexing API + + + See the Enterprise Search Indexing API documentation for more information. + + + + + A client for GitHub's Enterprise Pre-receive Environments API + + + See the Enterprise Pre-receive Environments API documentation for more information. + + + + + A client for GitHub's Enterprise LDAP API + + + See the Enterprise LDAP API documentation for more information. + + + + + Update the LDAP mapping for a user on a GitHub Enterprise appliance (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/ldap/#update-ldap-mapping-for-a-user + + The username to update LDAP mapping + The + The object. + + + + Queue an LDAP Sync job for a user on a GitHub Enterprise appliance (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/ldap/#sync-ldap-mapping-for-a-user + + The username to sync LDAP mapping + The of the queue request. + + + + Update the LDAP mapping for a team on a GitHub Enterprise appliance (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/ldap/#update-ldap-mapping-for-a-team + + The teamId to update LDAP mapping + The + The object. + + + + Queue an LDAP Sync job for a team on a GitHub Enterprise appliance (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/ldap/#sync-ldap-mapping-for-a-team + + The teamId to update LDAP mapping + The of the queue request. + + + + A client for GitHub's Enterprise License API + + + See the Enterprise License API documentation for more information. + + + + + Gets GitHub Enterprise License Information (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/license/#get-license-information + + The statistics. + + + + A client for GitHub's Enterprise Organization API + + + See the Enterprise Organization API documentation for more information. + + + + + Creates an Organization on a GitHub Enterprise appliance (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/orgs/#create-an-organization + + A instance describing the organization to be created + The created. + + + + A client for GitHub's Enterprise Pre-receive Environments API + + + See the Enterprise Pre-receive Environments API documentation for more information. + + + + + Gets all s. + + + See the API documentation for more information. + + Thrown when a general API error occurs. + + + + Gets all s. + + + See the API documentation for more information. + + Options for changing the API response + Thrown when a general API error occurs. + + + + Gets a single . + + + See the API documentation for more information. + + The id of the pre-receive environment + Thrown when the specified does not exist. + Thrown when a general API error occurs. + + + + Creates a new . + + + See the API documentation for more information. + + A description of the pre-receive environment to create + Thrown when a general API error occurs. + + + + Edits an existing . + + + See the API documentation for more information. + + The id of the pre-receive environment + A description of the pre-receive environment to edit + Thrown when the specified does not exist. + Thrown when a general API error occurs. + + + + Deletes an existing . + + + See the API documentation for more information. + + The id of the pre-receive environment + Thrown when the specified does not exist. + Thrown when a general API error occurs. + + + + Gets the download status for an existing . + + + See the API documentation for more information. + + The id of the pre-receive environment + Thrown when the specified does not exist. + Thrown when a general API error occurs. + + + + Triggers a new download of the 's tarball from the environment's . + When the download is finished, the newly downloaded tarball will overwrite the existing environment. + + + See the API documentation for more information. + + The id of the pre-receive environment + Thrown when the specified does not exist. + Thrown when a general API error occurs. + + + + Service used to check if a GitHub Enterprise instance lives at a given URL. + + + + + Makes a request to the specified URL and returns whether or not the probe could definitively determine that a GitHub + Enterprise Instance exists at the specified URL. + + + The probe checks the absolute path /site/sha at the specified . + + The URL to test + An with either , + , or in the case the request failed + + + + A client for GitHub's Enterprise Search Indexing API + + + See the Enterprise Search Indexing API documentation for more information. + + + + + Queue an indexing job for a user or organization account (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/search_indexing/#queue-an-indexing-job + + A user or organization account + The message. + + + + Queue an indexing job for a repository (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/search_indexing/#queue-an-indexing-job + + A user or organization account + A repository + The message. + + + + Queue an indexing job for all of a user or organization's repositories (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/search_indexing/#queue-an-indexing-job + + A user or organization account + The message. + + + + Queue an indexing job for all the issues in a repository (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/search_indexing/#queue-an-indexing-job + + A user or organization account + A repository + The message. + + + + Queue an indexing job for all the issues in all of a user or organization's repositories (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/search_indexing/#queue-an-indexing-job + + A user or organization account + The message. + + + + Queue an indexing job for all the source code in a repository (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/search_indexing/#queue-an-indexing-job + + A user or organization account + A repository + The message. + + + + Queue an indexing job for all the source code in all of a user or organization's repositories (must be Site Admin user). + + + https://developer.github.com/v3/enterprise/search_indexing/#queue-an-indexing-job + + A user or organization account + The message. + + + + A client for GitHub's Activity Events API. + + + See the Activity Events API documentation for more information + + + + + Instantiates a new GitHub Issue Events API client. + + An API connection + + + + Gets all the public events + + + http://developer.github.com/v3/activity/events/#list-public-events + + + + + Gets all the public events + + + http://developer.github.com/v3/activity/events/#list-public-events + + Options for changing the API response + All the public s for the particular user. + + + + Gets all the events for a given repository + + + https://developer.github.com/v3/activity/events/#list-repository-events + + The owner of the repository + The name of the repository + + + + Gets all the events for a given repository + + + http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository + + The Id of the repository + + + + Gets all the events for a given repository + + + https://developer.github.com/v3/activity/events/#list-repository-events + + The owner of the repository + The name of the repository + Options for changing the API response + + + + Gets all the events for a given repository + + + http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository + + The Id of the repository + Options for changing the API response + + + + Gets all the event issues for a given repository + + + http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository + + The owner of the repository + The name of the repository + + + + Gets all the issue events for a given repository + + + http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository + + The Id of the repository + + + + Gets all the event issues for a given repository + + + http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository + + The owner of the repository + The name of the repository + Options for changing the API response + + + + Gets all the issue events for a given repository + + + http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository + + The Id of the repository + Options for changing the API response + + + + Gets all the events for a given repository network + + + http://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories + + The owner of the repository + The name of the repository + + + + Gets all the events for a given repository network + + + http://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories + + The owner of the repository + The name of the repository + Options for changing the API response + + + + Gets all the events for a given organization + + + http://developer.github.com/v3/activity/events/#list-public-events-for-an-organization + + The name of the organization + + + + Gets all the events for a given organization + + + http://developer.github.com/v3/activity/events/#list-public-events-for-an-organization + + The name of the organization + Options for changing the API response + + + + Gets all the events that have been received by a given user. + + + http://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received + + The login of the user + + + + Gets all the events that have been received by a given user. + + + http://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received + + The login of the user + Options for changing the API response + + + + Gets all the events that have been received by a given user. + + + http://developer.github.com/v3/activity/events/#list-public-events-that-a-user-has-received + + The login of the user + + + + Gets all the events that have been received by a given user. + + + http://developer.github.com/v3/activity/events/#list-public-events-that-a-user-has-received + + The login of the user + Options for changing the API response + + + + Gets all the events that have been performed by a given user. + + + http://developer.github.com/v3/activity/events/#list-events-performed-by-a-user + + The login of the user + + + + Gets all the events that have been performed by a given user. + + + http://developer.github.com/v3/activity/events/#list-events-performed-by-a-user + + The login of the user + Options for changing the API response + + + + Gets all the public events that have been performed by a given user. + + + http://developer.github.com/v3/activity/events/#list-public-events-performed-by-a-user + + The login of the user + + + + Gets all the public events that have been performed by a given user. + + + http://developer.github.com/v3/activity/events/#list-public-events-performed-by-a-user + + The login of the user + Options for changing the API response + + + + Gets all the events that are associated with an organization. + + + http://developer.github.com/v3/activity/events/#list-events-for-an-organization + + The login of the user + The name of the organization + + + + Gets all the events that are associated with an organization. + + + http://developer.github.com/v3/activity/events/#list-events-for-an-organization + + The login of the user + The name of the organization + Options for changing the API response + + + + A client for GitHub's Feeds API. + + + See the Feeds API documentation for more information + + + + + Instantiates a new GitHub Feeds API client. + + An API connection + + + + Gets all the feeds available to the authenticating user + + + http://developer.github.com/v3/activity/feeds/#list-feeds + + All the public s for the particular user. + + + + A client for GitHub's User Followers API + + + See the Followers API documentation for more information. + + + + + Initializes a new GitHub User Followers API client. + + An API connection + + + + List the authenticated user’s followers + + + See the API documentation for more information. + + A of s that follow the authenticated user. + + + + List the authenticated user’s followers + + Options for changing the API response + + See the API documentation for more information. + + A of s that follow the authenticated user. + + + + List a user’s followers + + The login name for the user + + See the API documentation for more information. + + A of s that follow the passed user. + + + + List a user’s followers + + The login name for the user + Options for changing the API response + + See the API documentation for more information. + + A of s that follow the passed user. + + + + List who the authenticated user is following + + + See the API documentation for more information. + + A of s that the authenticated user follows. + + + + List who the authenticated user is following + + Options for changing the API response + + See the API documentation for more information. + + A of s that the authenticated user follows. + + + + List who a user is following + + The login name of the user + + See the API documentation for more information. + + A of s that the passed user follows. + + + + List who a user is following + + The login name of the user + Options for changing the API response + + See the API documentation for more information. + + A of s that the passed user follows. + + + + Check if the authenticated user follows another user + + The login name of the other user + + See the API documentation for more information. + + A bool representing the success of the operation. + + + + Check if one user follows another user + + The login name of the user + The login name of the other user + + See the API documentation for more information. + + A bool representing the success of the operation. + + + + Follow a user + + The login name of the user to follow + + See the API documentation for more information. + + A bool representing the success of the operation. + + + + Unfollow a user + + The login name of the user to unfollow + + See the API documentation for more information. + + + + + + A client for GitHub's Gist Comments API. + + + See the Gist Comments API documentation for more information. + + + + + Instantiates a new GitHub Gist Comments API client. + + An API connection + + + + Gets a single comment by gist- and comment id. + + http://developer.github.com/v3/gists/comments/#get-a-single-comment + The id of the gist + The id of the comment + Task{GistComment}. + + + + Gets all comments for the gist with the specified id. + + http://developer.github.com/v3/gists/comments/#list-comments-on-a-gist + The id of the gist + Task{IReadOnlyList{GistComment}}. + + + + Gets all comments for the gist with the specified id. + + http://developer.github.com/v3/gists/comments/#list-comments-on-a-gist + The id of the gist + Options for changing the API response + Task{IReadOnlyList{GistComment}}. + + + + Creates a comment for the gist with the specified id. + + http://developer.github.com/v3/gists/comments/#create-a-comment + The id of the gist + The body of the comment + Task{GistComment}. + + + + Updates the comment with the specified gist- and comment id. + + http://developer.github.com/v3/gists/comments/#edit-a-comment + The id of the gist + The id of the comment + The updated body of the comment + Task{GistComment}. + + + + Deletes the comment with the specified gist- and comment id. + + http://developer.github.com/v3/gists/comments/#delete-a-comment + The id of the gist + The id of the comment + Task. + + + + A client for GitHub's Gists API. + + + See the Gists API documentation for more information. + + + + + Instantiates a new GitHub Gists API client. + + An API connection + + + + Gets a gist + + + http://developer.github.com/v3/gists/#get-a-single-gist + + The id of the gist + + + + Creates a new gist + + + http://developer.github.com/v3/gists/#create-a-gist + + The new gist to create + + + + Creates a fork of a gist + + + http://developer.github.com/v3/gists/#fork-a-gist + + The id of the gist to fork + + + + Deletes a gist + + + http://developer.github.com/v3/gists/#delete-a-gist + + The id of the gist + + + + List the authenticated user’s gists or if called anonymously, + this will return all public gists + + + http://developer.github.com/v3/gists/#list-gists + + + + + List the authenticated user’s gists or if called anonymously, + this will return all public gists + + + http://developer.github.com/v3/gists/#list-gists + + Options for changing the API response + + + + List the authenticated user’s gists or if called anonymously, + this will return all public gists + + + http://developer.github.com/v3/gists/#list-gists + + Only gists updated at or after this time are returned + + + + List the authenticated user’s gists or if called anonymously, + this will return all public gists + + + http://developer.github.com/v3/gists/#list-gists + + Only gists updated at or after this time are returned + Options for changing the API response + + + + Lists all public gists + + + http://developer.github.com/v3/gists/#list-gists + + + + + Lists all public gists + + + http://developer.github.com/v3/gists/#list-gists + + Options for changing the API response + + + + Lists all public gists + + + http://developer.github.com/v3/gists/#list-gists + + Only gists updated at or after this time are returned + + + + Lists all public gists + + + http://developer.github.com/v3/gists/#list-gists + + Only gists updated at or after this time are returned + Options for changing the API response + + + + List the authenticated user’s starred gists + + + http://developer.github.com/v3/gists/#list-gists + + + + + List the authenticated user’s starred gists + + + http://developer.github.com/v3/gists/#list-gists + + Options for changing the API response + + + + List the authenticated user’s starred gists + + + http://developer.github.com/v3/gists/#list-gists + + Only gists updated at or after this time are returned + + + + List the authenticated user’s starred gists + + + http://developer.github.com/v3/gists/#list-gists + + Only gists updated at or after this time are returned + Options for changing the API response + + + + List a user's gists + + + http://developer.github.com/v3/gists/#list-gists + + The user + + + + List a user's gists + + + http://developer.github.com/v3/gists/#list-gists + + The user + Options for changing the API response + + + + List a user's gists + + + http://developer.github.com/v3/gists/#list-gists + + The user + Only gists updated at or after this time are returned + + + + List a user's gists + + + http://developer.github.com/v3/gists/#list-gists + + The user + Only gists updated at or after this time are returned + Options for changing the API response + + + + List gist commits + + + http://developer.github.com/v3/gists/#list-gists-commits + + The id of the gist + + + + List gist commits + + + http://developer.github.com/v3/gists/#list-gists-commits + + The id of the gist + Options for changing the API response + + + + List gist forks + + + http://developer.github.com/v3/gists/#list-gists-forks + + The id of the gist + + + + List gist forks + + + http://developer.github.com/v3/gists/#list-gists-forks + + The id of the gist + Options for changing the API response + + + + Edits a gist + + + http://developer.github.com/v3/gists/#delete-a-gist + + The id of the gist + The update to the gist + + + + Stars a gist + + + http://developer.github.com/v3/gists/#star-a-gist + + The id of the gist + + + + Unstars a gist + + + http://developer.github.com/v3/gists/#unstar-a-gist + + The id of the gist + + + + Checks if the gist is starred + + + http://developer.github.com/v3/gists/#check-if-a-gist-is-starred + + The id of the gist + + + + A client for GitHub's Git Database API. Gives you access to read and write raw Git objects and to list and update your references. + + + See the Git API documentation for more information. + + + + + Instantiates a new GitHub Git API client. + + An API connection + + + + A client for GitHub Applications Installations API. + + + See the GitHub Apps Installations API documentation for more information. + + + + + List repositories of the authenticated GitHub App Installation (requires GitHubApp Installation-Token auth). + + https://developer.github.com/v3/apps/installations/#list-repositories + + + + List repositories of the authenticated GitHub App Installation (requires GitHubApp Installation-Token auth). + + Options for changing the API response + https://developer.github.com/v3/apps/installations/#list-repositories + + + + List repositories accessible to the user for an installation (requires GitHubApp User-To-Server Auth). + + The Id of the installation + https://developer.github.com/v3/apps/installations/#list-repositories-accessible-to-the-user-for-an-installation + + + + List repositories accessible to the user for an installation (requires GitHubApp User-To-Server Auth). + + The Id of the installation + Options for changing the API response + https://developer.github.com/v3/apps/installations/#list-repositories-accessible-to-the-user-for-an-installation + + + + A client for GitHub Applications API. + + + See the GitHub Apps API documentation for more information. + + + + + Access GitHub's Apps Installations API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/apps/installations/ + + + + + Get a single GitHub App (if private, requires Personal Access Token or GitHubApp auth) + + https://developer.github.com/v3/apps/#get-a-single-github-app + The URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App. + + + + Returns the GitHub App associated with the authentication credentials used (requires GitHubApp auth). + + https://developer.github.com/v3/apps/#get-the-authenticated-github-app + + + + List installations of the authenticated GitHub App (requires GitHubApp auth). + + https://developer.github.com/v3/apps/#find-installations + + + + List installations of the authenticated GitHub App (requires GitHubApp auth). + + Options for changing the API response + https://developer.github.com/v3/apps/#find-installations + + + + Get a single GitHub App Installation (requires GitHubApp auth). + + https://developer.github.com/v3/apps/#get-a-single-installation + The Id of the GitHub App Installation + + + + Get a single GitHub App Installation (requires GitHubApp auth). + + https://developer.github.com/v3/apps/#get-a-single-installation + The Id of the GitHub App Installation + + + + List installations for the currently authenticated user (requires GitHubApp User-To-Server Auth). + + https://developer.github.com/v3/apps/#list-installations-for-user + + + + List installations for the currently authenticated user (requires GitHubApp User-To-Server Auth). + + https://developer.github.com/v3/apps/#list-installations-for-user + + + + Create a time bound access token for a GitHubApp Installation that can be used to access other API endpoints (requires GitHubApp auth). + + + https://developer.github.com/v3/apps/#create-a-new-installation-token + https://developer.github.com/apps/building-github-apps/authentication-options-for-github-apps/#authenticating-as-an-installation + https://developer.github.com/v3/apps/available-endpoints/ + + The Id of the GitHub App Installation + + + + Enables an authenticated GitHub App to find the organization's installation information (requires GitHubApp auth). + + https://developer.github.com/v3/apps/#find-organization-installation + The name of the organization + + + + Enables an authenticated GitHub App to find the repository's installation information (requires GitHubApp auth). + + https://developer.github.com/v3/apps/#find-repository-installation + The owner of the repo + The name of the repo + + + + Enables an authenticated GitHub App to find the repository's installation information (requires GitHubApp auth). + + https://developer.github.com/v3/apps/#find-repository-installation + The Id of the repository + + + + Enables an authenticated GitHub App to find the users's installation information (requires GitHubApp auth). + + https://developer.github.com/v3/apps/#find-user-installation + The name of the user + + + + A client for GitHub's Activity API. + + + See the Activity API documentation for more information. + + + + + Client for the Events API + + + + + Client for the Starring API + + + + + Client for the Watching API + + + + + Client for the Feeds API + + + + + Client for the Notifications API + + + + + A client for GitHub's Issue Assignees API. + + + See the Issue Assignees API documentation for more information. + + + + + Gets all the available assignees (owner + collaborators) to which issues may be assigned. + + The owner of the repository + The name of the repository + + + + Gets all the available assignees (owner + collaborators) to which issues may be assigned. + + The Id of the repository + + + + Gets all the available assignees (owner + collaborators) to which issues may be assigned. + + The owner of the repository + The name of the repository + The options to change API's response. + + + + Gets all the available assignees (owner + collaborators) to which issues may be assigned. + + The Id of the repository + The options to change API's response. + + + + Checks to see if a user is an assignee for a repository. + + The owner of the repository + The name of the repository + Username of the prospective assignee + + + + Add assignees to a specified Issue. + + The owner of the repository + The name of the repository + The issue number + List of names of assignees to add + + + + + Remove assignees from a specified Issue. + + The owner of the repository + The name of the repository + The issue number + List of assignees to remove + + + + + Checks to see if a user is an assignee for a repository. + + The Id of the repository + Username of the prospective assignee + + + + A client for GitHub's OAuth API. + + + See the OAuth API documentation for more details. + + + + + Gets all s for the authenticated user. + + + This method requires authentication. + See the API documentation for more information. + + + Thrown when the current user does not have permission to make the request. + + Thrown when a general API error occurs. + A list of s for the authenticated user. + + + + Gets all s for the authenticated user. + + + This method requires authentication. + See the API documentation for more information. + + Options for changing the API response + + Thrown when the current user does not have permission to make the request. + + Thrown when a general API error occurs. + A list of s for the authenticated user. + + + + Gets a specific for the authenticated user. + + + This method requires authentication. + See the API documentation for more information. + + The Id of the to get + + Thrown when the current user does not have permission to make this request. + + Thrown when a general API error occurs. + The specified . + + + + Creates a new personal token for the authenticated user. + + + This method requires authentication. + See the API documentation for more information. + + Describes the new authorization to create + + Thrown when the current user does not have permission to make this request. + + + Thrown when the current account has two-factor authentication enabled and an authentication code is required. + + Thrown when a general API error occurs. + The created . + + + + Creates a new personal token for the authenticated user. + + + This method requires authentication. + See the API documentation for more information. + + The two-factor authentication code in response to the current user's previous challenge + Describes the new authorization to create + + Thrown when the current user does not have permission to make this request. + + + Thrown when the current account has two-factor authentication enabled and an authentication code is required. + + Thrown when a general API error occurs. + The created . + + + + Creates a new authorization for the specified OAuth application if an authorization for that application + doesn’t already exist for the user; otherwise, it fails. + + + This method requires authentication. + See the API documentation for more information. + + Client Id of the OAuth application for the token + The client secret + Describes the new authorization to create + + Thrown when the current user does not have permission to make this request. + + + Thrown when the current account has two-factor authentication enabled and an authentication code is required. + + Thrown when a general API error occurs. + The created . + + + + Creates a new authorization for the specified OAuth application if an authorization for that application + doesn’t already exist for the user; otherwise, it fails. + + + This method requires authentication. + See the API documentation for more information. + + Client Id of the OAuth application for the token + The client secret + The two-factor authentication code in response to the current user's previous challenge + Describes the new authorization to create + + Thrown when the current user does not have permission to make this request. + + + Thrown when the current account has two-factor authentication enabled and an authentication code is required. + + Thrown when a general API error occurs. + The created . + + + + Creates a new authorization for the specified OAuth application if an authorization for that application doesn’t already + exist for the user; otherwise, returns the user’s existing authorization for that application. + + + This method requires authentication. + See the API documentation for more information. + + Client Id of the OAuth application for the token + The client secret + Describes the new authorization to create + + Thrown when the current user does not have permission to make this request. + + + Thrown when the current account has two-factor authentication enabled and an authentication code is required. + + Thrown when a general API error occurs. + The created . + + + + Creates a new authorization for the specified OAuth application if an authorization for that application doesn’t already + exist for the user; otherwise, returns the user’s existing authorization for that application. + + + This method requires authentication. + See the API documentation for more information. + + Client Id of the OAuth application for the token + The client secret + Describes the new authorization to create + The two-factor authentication code in response to the current user's previous challenge + + Thrown when the current user does not have permission to make this request. + + + Thrown when the current account has two-factor authentication enabled and an authentication code is required. + + Thrown when a general API error occurs. + The created . + + + + Checks the validity of an OAuth token without running afoul of normal rate limits for failed login attempts. + + + This method requires authentication. + See the API documentation for more information. + + Client Id of the OAuth application for the token + The OAuth token to check + The valid . + + + + Resets a valid OAuth token for an OAuth application without end user involvement. + + + This method requires authentication. + See the API documentation for more information. + + ClientID of the OAuth application for the token + The OAuth token to reset + The valid with a new OAuth token + + + + Revokes a single OAuth token for an OAuth application. + + + This method requires authentication. + See the API documentation for more information. + + ClientID of the OAuth application for the token + The OAuth token to revoke + A for the request's execution. + + + + Updates the specified . + + + This method requires authentication. + See the API + documentation for more details. + + Id of the to update + Describes the changes to make to the authorization + + Thrown when the current user does not have permission to make the request. + + Thrown when a general API error occurs. + The updated . + + + + Deletes the specified . + + + This method requires authentication. + See the API + documentation for more details. + + The system-wide Id of the authorization to delete + + Thrown when the current user does not have permission to make the request. + + Thrown when a general API error occurs. + A for the request's execution. + + + + Deletes the specified . + + + This method requires authentication. + See the API + documentation for more details. + + The system-wide Id of the authorization to delete + Two factor authorization code + + Thrown when the current user does not have permission to make the request. + + Thrown when a general API error occurs. + A for the request's execution. + + + + A client for GitHub's Git Blobs API. + + + See the Git Blobs API documentation for more information. + + + + + Gets a single Blob by SHA. + + + http://developer.github.com/v3/git/blobs/#get-a-blob + + The owner of the repository + The name of the repository + The SHA of the blob + + + + Gets a single Blob by SHA. + + + http://developer.github.com/v3/git/blobs/#get-a-blob + + The Id of the repository + The SHA of the blob + + + + Creates a new Blob + + + http://developer.github.com/v3/git/blobs/#create-a-blob + + The owner of the repository + The name of the repository + The new Blob + + + + Creates a new Blob + + + http://developer.github.com/v3/git/blobs/#create-a-blob + + The Id of the repository + The new Blob + + + + A client for GitHub's Check Runs API + + + See the Check Runs API documentation for more information. + + + + + Creates a new check run for a specific commit in a repository + + + See the Check Runs API documentation for more information. + + The owner of the repository + The name of the repository + Details of the Check Run to create + + + + Creates a new check run for a specific commit in a repository + + + See the Check Runs API documentation for more information. + + The Id of the repository + Details of the Check Run to create + + + + Updates a check run for a specific commit in a repository + + + See the Check Runs API documentation for more information. + + The owner of the repository + The name of the repository + The Id of the check run + The updates to the check run + + + + Updates a check run for a specific commit in a repository + + + See the Check Runs API documentation for more information. + + The Id of the repository + The Id of the check run + The updates to the check run + + + + Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name + + + See the Check Runs API documentation for more information. + + The owner of the repository + The name of the repository + The commit reference (can be a SHA, branch name, or a tag name) + + + + Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name + + + See the Check Runs API documentation for more information. + + The Id of the repository + The commit reference (can be a SHA, branch name, or a tag name) + + + + Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name + + + See the Check Runs API documentation for more information. + + The owner of the repository + The name of the repository + The commit reference (can be a SHA, branch name, or a tag name) + Details to filter the request, such as by check name + + + + Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name + + + See the Check Runs API documentation for more information. + + The Id of the repository + The commit reference (can be a SHA, branch name, or a tag name) + Details to filter the request, such as by check name + + + + Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name + + + See the Check Runs API documentation for more information. + + The owner of the repository + The name of the repository + The commit reference (can be a SHA, branch name, or a tag name) + Details to filter the request, such as by check name + Options to change the API response + + + + Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name + + + See the Check Runs API documentation for more information. + + The Id of the repository + The commit reference (can be a SHA, branch name, or a tag name) + Details to filter the request, such as by check name + Options to change the API response + + + + Lists check runs for a check suite using its Id + + + See the Check Runs API documentation for more information. + + The owner of the repository + The name of the repository + The Id of the check suite + + + + Lists check runs for a check suite using its Id + + + See the Check Runs API documentation for more information. + + The Id of the repository + The Id of the check suite + + + + Lists check runs for a check suite using its Id + + + See the Check Runs API documentation for more information. + + The owner of the repository + The name of the repository + The Id of the check suite + Details to filter the request, such as by check name + + + + Lists check runs for a check suite using its Id + + + See the Check Runs API documentation for more information. + + The Id of the repository + The Id of the check suite + Details to filter the request, such as by check name + + + + Lists check runs for a check suite using its Id + + + See the Check Runs API documentation for more information. + + The owner of the repository + The name of the repository + The Id of the check suite + Details to filter the request, such as by check name + Options to change the API response + + + + Lists check runs for a check suite using its Id + + + See the Check Runs API documentation for more information. + + The Id of the repository + The Id of the check suite + Details to filter the request, such as by check name + Options to change the API response + + + + Gets a single check run using its Id + + + See the Check Runs API documentation for more information. + + The owner of the repository + The name of the repository + The Id of the check run + + + + Gets a single check run using its Id + + + See the Check Runs API documentation for more information. + + The Id of the repository + The Id of the check run + + + + Lists annotations for a check run using the check run Id + + + See the Check Runs API documentation for more information. + + The owner of the repository + The name of the repository + The Id of the check run + + + + Lists annotations for a check run using the check run Id + + + See the Check Runs API documentation for more information. + + The Id of the repository + The Id of the check run + + + + + Lists annotations for a check run using the check run Id + + + See the Check Runs API documentation for more information. + + The owner of the repository + The name of the repository + The Id of the check run + Options to change the API response + + + + Lists annotations for a check run using the check run Id + + + See the Check Runs API documentation for more information. + + The Id of the repository + The Id of the check run + Options to change the API response + + + + A client for GitHub's Checks API + + + See the Checks API documentation for more information. + + + + + A client for GitHub's Check Runs API + + + See the Check Runs API documentation for more information. + + + + + A client for GitHub's Check Suites API + + + See the Check Suites API documentation for more information. + + + + + A client for GitHub's Check Suites API + + + See the Check Suites API documentation for more information. + + + + + Gets a single Check Suite by Id + + + See the Check Suites API documentation for more information. + + The owner of the repository + The name of the repository + The Id of the check suite + + + + Gets a single Check Suite by Id + + + See the Check Suites API documentation for more information. + + The Id of the repository + The Id of the check suite + + + + Lists Check Suites for a commit reference (SHA, branch name or tag name) + + + See the Check Suites API documentation for more information. + + The owner of the repository + The name of the repository + The reference (SHA, branch name or tag name) to list check suites for + + + + Lists Check Suites for a commit reference (SHA, branch name or tag name) + + + See the Check Suites API documentation for more information. + + The Id of the repository + The reference (SHA, branch name or tag name) to list check suites for + + + + Lists Check Suites for a commit reference (SHA, branch name or tag name) + + + See the Check Suites API documentation for more information. + + The owner of the repository + The name of the repository + The reference (SHA, branch name or tag name) to list check suites for + Details to filter the request, such as by App Id or Check Name + + + + Lists Check Suites for a commit reference (SHA, branch name or tag name) + + + See the Check Suites API documentation for more information. + + The Id of the repository + The reference (SHA, branch name or tag name) to list check suites for + Details to filter the request, such as by App Id or Check Name + + + + Lists Check Suites for a commit reference (SHA, branch name or tag name) + + + See the Check Suites API documentation for more information. + + The owner of the repository + The name of the repository + The reference (SHA, branch name or tag name) to list check suites for + Details to filter the request, such as by App Id or Check Name + Options to change the API response + + + + Lists Check Suites for a commit reference (SHA, branch name or tag name) + + + See the Check Suites API documentation for more information. + + The Id of the repository + The reference (SHA, branch name or tag name) to list check suites for + Details to filter the request, such as by App Id or Check Name + Options to change the API response + + + + Updates Check Suites prefrences on a repository, such as disabling automatic creation when code is pushed + + + See the Check Suites API documentation for more information. + + The owner of the repository + The name of the repository + The check suite preferences + + + + Updates Check Suites prefrences on a repository, such as disabling automatic creation when code is pushed + + + See the Check Suites API documentation for more information. + + The Id of the repository + The check suite preferences + + + + Creates a new Check Suite + + + See the Check Suites API documentation for more information. + + The owner of the repository + The name of the repository + Details of the Check Suite to create + + + + Creates a new Check Suite + + + See the Check Suites API documentation for more information. + + The Id of the repository + Details of the Check Suite to create + + + + Triggers GitHub to create a new check suite, without pushing new code to a repository + + + See the Check Suites API documentation for more information. + + The owner of the repository + The name of the repository + Details of the Check Suite request + + + + Triggers GitHub to create a new check suite, without pushing new code to a repository + + + See the Check Suites API documentation for more information. + + The Id of the repository + Details of the Check Suite request + + + + Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository + + + See the Check Suites API documentation for more information. + + The owner of the repository + The name of the repository + The Id of the check suite + + + + Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository + + + See the Check Suites API documentation for more information. + + The Id of the repository + The Id of the check suite + + + + A client for GitHub's Reactions API. + + + See the Reactions API documentation for more information. + + + + + Creates a reaction for a specified Commit Comment + + https://developer.github.com/v3/reactions/#create-reaction-for-a-commit-comment + The owner of the repository + The name of the repository + The comment id + The reaction to create + + + + + Creates a reaction for a specified Commit Comment + + https://developer.github.com/v3/reactions/#create-reaction-for-a-commit-comment + The owner of the repository + The comment id + The reaction to create + + + + + Get all reactions for a specified Commit Comment + + https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment + The owner of the repository + The name of the repository + The comment id + + + + + Get all reactions for a specified Commit Comment + + https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment + The owner of the repository + The comment id + + + + + A client for GitHub's Git Commits API. + + + See the Git Commits API documentation for more information. + + + + + Gets a commit for a given repository by sha reference + + + http://developer.github.com/v3/git/commits/#get-a-commit + + The owner of the repository + The name of the repository + Tha sha reference of the commit + + + + Gets a commit for a given repository by sha reference + + + http://developer.github.com/v3/git/commits/#get-a-commit + + The Id of the repository + Tha sha reference of the commit + + + + Create a commit for a given repository + + + http://developer.github.com/v3/git/commits/#create-a-commit + + The owner of the repository + The name of the repository + The commit to create + + + + Create a commit for a given repository + + + http://developer.github.com/v3/git/commits/#create-a-commit + + The Id of the repository + The commit to create + + + + A client for GitHub's Git Repository Status API. + + + See the Repository Statuses API documentation for more information. + + + + + Retrieves commit statuses for the specified reference. A reference can be a commit SHA, a branch name, or + a tag name. + + + https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref + + The owner of the repository + The name of the repository + The reference (SHA, branch name, or tag name) to list commits for + + + + Retrieves commit statuses for the specified reference. A reference can be a commit SHA, a branch name, or + a tag name. + + + https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref + + The Id of the repository + The reference (SHA, branch name, or tag name) to list commits for + + + + Retrieves commit statuses for the specified reference. A reference can be a commit SHA, a branch name, or + a tag name. + + + https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref + + The owner of the repository + The name of the repository + The reference (SHA, branch name, or tag name) to list commits for + Options for changing the API response + + + + Retrieves commit statuses for the specified reference. A reference can be a commit SHA, a branch name, or + a tag name. + + + https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref + + The Id of the repository + The reference (SHA, branch name, or tag name) to list commits for + Options for changing the API response + + + + Retrieves a combined view of statuses for the specified reference. A reference can be a commit SHA, a branch name, or + a tag name. + + + https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref + + The owner of the repository + The name of the repository + The reference (SHA, branch name, or tag name) to list commits for + + + + Retrieves a combined view of statuses for the specified reference. A reference can be a commit SHA, a branch name, or + a tag name. + + + https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref + + The Id of the repository + The reference (SHA, branch name, or tag name) to list commits for + + + + Creates a commit status for the specified ref. + + + https://developer.github.com/v3/repos/statuses/#create-a-status + + The owner of the repository + The name of the repository + The reference (SHA, branch name, or tag name) to list commits for + The commit status to create + + + + Creates a commit status for the specified ref. + + + https://developer.github.com/v3/repos/statuses/#create-a-status + + The Id of the repository + The reference (SHA, branch name, or tag name) to list commits for + The commit status to create + + + + A client for GitHub's Repository Deployments API. + Gets and creates Deployments. + + + See the Repository Deployments API documentation for more information. + + + + + Gets all the deployments for the specified repository. Any user with pull access + to a repository can view deployments. + + + http://developer.github.com/v3/repos/deployments/#list-deployments + + The owner of the repository + The name of the repository + + + + Gets all the deployments for the specified repository. Any user with pull access + to a repository can view deployments. + + + http://developer.github.com/v3/repos/deployments/#list-deployments + + The Id of the repository + + + + Gets all the deployments for the specified repository. Any user with pull access + to a repository can view deployments. + + + http://developer.github.com/v3/repos/deployments/#list-deployments + + The owner of the repository + The name of the repository + Options for changing the API response + + + + Gets all the deployments for the specified repository. Any user with pull access + to a repository can view deployments. + + + http://developer.github.com/v3/repos/deployments/#list-deployments + + The Id of the repository + Options for changing the API response + + + + Creates a new deployment for the specified repository. + Users with push access can create a deployment for a given ref. + + + http://developer.github.com/v3/repos/deployments/#create-a-deployment + + The owner of the repository + The name of the repository + A instance describing the new deployment to create + + + + Creates a new deployment for the specified repository. + Users with push access can create a deployment for a given ref. + + + http://developer.github.com/v3/repos/deployments/#create-a-deployment + + The Id of the repository + A instance describing the new deployment to create + + + + Client for managing deployment status. + + + + + A client for GitHub's Repository Deployment Statuses API. + Gets and creates Deployment Statuses. + + + See the Repository Deployment Statuses API documentation for more information. + + + + + Gets all the statuses for the given deployment. Any user with pull access to a repository can + view deployments. + + + http://developer.github.com/v3/repos/deployments/#list-deployment-statuses + + The owner of the repository. + The name of the repository. + The id of the deployment. + + + + Gets all the statuses for the given deployment. Any user with pull access to a repository can + view deployments. + + + http://developer.github.com/v3/repos/deployments/#list-deployment-statuses + + The Id of the repository. + The id of the deployment. + + + + Gets all the statuses for the given deployment. Any user with pull access to a repository can + view deployments. + + + http://developer.github.com/v3/repos/deployments/#list-deployment-statuses + + The owner of the repository. + The name of the repository. + The id of the deployment. + Options for changing the API response + + + + Gets all the statuses for the given deployment. Any user with pull access to a repository can + view deployments. + + + http://developer.github.com/v3/repos/deployments/#list-deployment-statuses + + The Id of the repository. + The id of the deployment. + Options for changing the API response + + + + Creates a new status for the given deployment. Users with push access can create deployment + statuses for a given deployment. + + + http://developer.github.com/v3/repos/deployments/#create-a-deployment-status + + The owner of the repository. + The name of the repository. + The id of the deployment. + The new deployment status to create. + + + + Creates a new status for the given deployment. Users with push access can create deployment + statuses for a given deployment. + + + http://developer.github.com/v3/repos/deployments/#create-a-deployment-status + + The Id of the repository. + The id of the deployment. + The new deployment status to create. + + + + A client for GitHub's Activity Events API. + + + See the Activity Events API documentation for more information + + + + + Gets all the public events + + + http://developer.github.com/v3/activity/events/#list-public-events + + + + + Gets all the public events + + + http://developer.github.com/v3/activity/events/#list-public-events + + Options for changing the API response + All the public s for the particular user. + + + + Gets all the events for a given repository + + + http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository + + The owner of the repository + The name of the repository + + + + Gets all the events for a given repository + + + http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository + + The Id of the repository + + + + Gets all the events for a given repository + + + http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository + + The owner of the repository + The name of the repository + Options for changing the API response + + + + Gets all the events for a given repository + + + http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository + + The Id of the repository + Options for changing the API response + + + + Gets all the issue events for a given repository + + + http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository + + The owner of the repository + The name of the repository + + + + Gets all the issue events for a given repository + + + http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository + + The Id of the repository + + + + Gets all the issue events for a given repository + + + http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository + + The owner of the repository + The name of the repository + Options for changing the API response + + + + Gets all the issue events for a given repository + + + http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository + + The Id of the repository + Options for changing the API response + + + + Gets all the events for a given repository network + + + http://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories + + The owner of the repository + The name of the repository + + + + Gets all the events for a given repository network + + + http://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories + + The owner of the repository + The name of the repository + Options for changing the API response + + + + Gets all the events for a given organization + + + http://developer.github.com/v3/activity/events/#list-public-events-for-an-organization + + The name of the organization + + + + Gets all the events for a given organization + + + http://developer.github.com/v3/activity/events/#list-public-events-for-an-organization + + The name of the organization + Options for changing the API response + + + + Gets all the events that have been received by a given user. + + + http://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received + + The login of the user + + + + Gets all the events that have been received by a given user. + + + http://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received + + The login of the user + Options for changing the API response + + + + Gets all the events that have been received by a given user. + + + http://developer.github.com/v3/activity/events/#list-public-events-that-a-user-has-received + + The login of the user + + + + Gets all the events that have been received by a given user. + + + http://developer.github.com/v3/activity/events/#list-public-events-that-a-user-has-received + + The login of the user + Options for changing the API response + + + + Gets all the events that have been performed by a given user. + + + http://developer.github.com/v3/activity/events/#list-events-performed-by-a-user + + The login of the user + + + + Gets all the events that have been performed by a given user. + + + http://developer.github.com/v3/activity/events/#list-events-performed-by-a-user + + The login of the user + Options for changing the API response + + + + Gets all the public events that have been performed by a given user. + + + http://developer.github.com/v3/activity/events/#list-public-events-performed-by-a-user + + The login of the user + + + + Gets all the public events that have been performed by a given user. + + + http://developer.github.com/v3/activity/events/#list-public-events-performed-by-a-user + + The login of the user + Options for changing the API response + + + + Gets all the events that are associated with an organization. + + + http://developer.github.com/v3/activity/events/#list-events-for-an-organization + + The login of the user + The name of the organization + + + + Gets all the events that are associated with an organization. + + + http://developer.github.com/v3/activity/events/#list-events-for-an-organization + + The login of the user + The name of the organization + Options for changing the API response + + + + A client for GitHub's Feeds API. + + + See the Feeds API documentation for more information + + + + + Gets all the feeds available to the authenticating user + + + http://developer.github.com/v3/activity/feeds/#list-feeds + + All the public s for the particular user. + + + + A client for GitHub's User Followers API + + + See the Followers API documentation for more information. + + + + + List the authenticated user’s followers + + + See the API documentation for more information. + + A of s that follow the authenticated user. + + + + List the authenticated user’s followers + + Options for changing the API response + + See the API documentation for more information. + + A of s that follow the authenticated user. + + + + List a user’s followers + + The login name for the user + + See the API documentation for more information. + + A of s that follow the passed user. + + + + List a user’s followers + + The login name for the user + Options for changing the API response + + See the API documentation for more information. + + A of s that follow the passed user. + + + + List who the authenticated user is following + + + See the API documentation for more information. + + A of s that the authenticated user follows. + + + + List who the authenticated user is following + + Options for changing the API response + + See the API documentation for more information. + + A of s that the authenticated user follows. + + + + List who a user is following + + The login name of the user + + See the API documentation for more information. + + A of s that the passed user follows. + + + + List who a user is following + + The login name of the user + Options for changing the API response + + See the API documentation for more information. + + A of s that the passed user follows. + + + + Check if the authenticated user follows another user + + The login name of the other user + + See the API documentation for more information. + + A bool representing the success of the operation. + + + + Check if one user follows another user + + The login name of the user + The login name of the other user + + See the API documentation for more information. + + A bool representing the success of the operation. + + + + Follow a user + + The login name of the user to follow + + See the API documentation for more information. + + A bool representing the success of the operation. + + + + Unfollow a user + + The login name of the user to unfollow + + See the API documentation for more information. + + + + + + A client for GitHub's Gist Comments API. + + + See the Gist Comments API documentation for more information. + + + + + Gets a single comment by gist- and comment id. + + http://developer.github.com/v3/gists/comments/#get-a-single-comment + The id of the gist + The id of the comment + Task{GistComment}. + + + + Gets all comments for the gist with the specified id. + + http://developer.github.com/v3/gists/comments/#list-comments-on-a-gist + The id of the gist + Task{IReadOnlyList{GistComment}}. + + + + Gets all comments for the gist with the specified id. + + http://developer.github.com/v3/gists/comments/#list-comments-on-a-gist + The id of the gist + Options for changing the API response + Task{IReadOnlyList{GistComment}}. + + + + Creates a comment for the gist with the specified id. + + http://developer.github.com/v3/gists/comments/#create-a-comment + The id of the gist + The body of the comment + Task{GistComment}. + + + + Updates the comment with the specified gist- and comment id. + + http://developer.github.com/v3/gists/comments/#edit-a-comment + The id of the gist + The id of the comment + The updated body of the comment + Task{GistComment}. + + + + Deletes the comment with the specified gist- and comment id. + + http://developer.github.com/v3/gists/comments/#delete-a-comment + The id of the gist + The id of the comment + Task. + + + + A client for GitHub's Gists API. + + + See the Gists API documentation for more information. + + + + + Gets a gist + + + http://developer.github.com/v3/gists/#get-a-single-gist + + The id of the gist + + + + List the authenticated user’s gists or if called anonymously, + this will return all public gists + + + http://developer.github.com/v3/gists/#list-gists + + + + + List the authenticated user’s gists or if called anonymously, + this will return all public gists + + + http://developer.github.com/v3/gists/#list-gists + + Options for changing the API response + + + + List the authenticated user’s gists or if called anonymously, + this will return all public gists + + + http://developer.github.com/v3/gists/#list-gists + + Only gists updated at or after this time are returned + + + + List the authenticated user’s gists or if called anonymously, + this will return all public gists + + + http://developer.github.com/v3/gists/#list-gists + + Only gists updated at or after this time are returned + Options for changing the API response + + + + Lists all public gists + + + http://developer.github.com/v3/gists/#list-gists + + + + + Lists all public gists + + + http://developer.github.com/v3/gists/#list-gists + + Options for changing the API response + + + + Lists all public gists + + + http://developer.github.com/v3/gists/#list-gists + + Only gists updated at or after this time are returned + + + + Lists all public gists + + + http://developer.github.com/v3/gists/#list-gists + + Only gists updated at or after this time are returned + Options for changing the API response + + + + List the authenticated user’s starred gists + + + http://developer.github.com/v3/gists/#list-gists + + + + + List the authenticated user’s starred gists + + + http://developer.github.com/v3/gists/#list-gists + + Options for changing the API response + + + + List the authenticated user’s starred gists + + + http://developer.github.com/v3/gists/#list-gists + + Only gists updated at or after this time are returned + + + + List the authenticated user’s starred gists + + + http://developer.github.com/v3/gists/#list-gists + + Only gists updated at or after this time are returned + Options for changing the API response + + + + List a user's gists + + + http://developer.github.com/v3/gists/#list-gists + + The user + + + + List a user's gists + + + http://developer.github.com/v3/gists/#list-gists + + The user + Options for changing the API response + + + + List a user's gists + + + http://developer.github.com/v3/gists/#list-gists + + The user + Only gists updated at or after this time are returned + + + + List a user's gists + + + http://developer.github.com/v3/gists/#list-gists + + The user + Only gists updated at or after this time are returned + Options for changing the API response + + + + List gist commits + + + http://developer.github.com/v3/gists/#list-gists-commits + + The id of the gist + + + + List gist commits + + + http://developer.github.com/v3/gists/#list-gists-commits + + The id of the gist + Options for changing the API response + + + + List gist forks + + + http://developer.github.com/v3/gists/#list-gists-forks + + The id of the gist + + + + List gist forks + + + http://developer.github.com/v3/gists/#list-gists-forks + + The id of the gist + Options for changing the API response + + + + Creates a new gist + + + http://developer.github.com/v3/gists/#create-a-gist + + The new gist to create + + + + Creates a fork of a gist + + + http://developer.github.com/v3/gists/#fork-a-gist + + The id of the gist to fork + + + + Edits a gist + + + http://developer.github.com/v3/gists/#delete-a-gist + + The id of the gist + The update to the gist + + + + Deletes a gist + + + http://developer.github.com/v3/gists/#delete-a-gist + + The id of the gist + + + + Stars a gist + + + http://developer.github.com/v3/gists/#star-a-gist + + The id of the gist + + + + Unstars a gist + + + http://developer.github.com/v3/gists/#unstar-a-gist + + The id of the gist + + + + Checks if the gist is starred + + + http://developer.github.com/v3/gists/#check-if-a-gist-is-starred + + The id of the gist + + + + A client for GitHub's Git Database API. Gives you access to read and write raw Git objects and to list and update your references. + + + See the Git API documentation for more information. + + + + + A client for GitHub Applications Installations API. + + + See the GitHub Apps Installations API documentation for more information. + + + + + List repositories of the authenticated GitHub App Installation (requires GitHubApp Installation-Token auth). + + https://developer.github.com/v3/apps/installations/#list-repositories + + + + List repositories of the authenticated GitHub App Installation (requires GitHubApp Installation-Token auth). + + Options for changing the API response + https://developer.github.com/v3/apps/installations/#list-repositories + + + + List repositories accessible to the user for an installation (requires GitHubApp User-To-Server Auth). + + The Id of the installation + https://developer.github.com/v3/apps/installations/#list-repositories-accessible-to-the-user-for-an-installation + + + + List repositories accessible to the user for an installation (requires GitHubApp User-To-Server Auth). + + The Id of the installation + Options for changing the API response + https://developer.github.com/v3/apps/installations/#list-repositories-accessible-to-the-user-for-an-installation + + + + A client for GitHub Applications API. + + + See the GitHub Apps API documentation for more information. + + + + + Access GitHub's Apps Installations API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/apps/installations/ + + + + + Get a single GitHub App (if private, requires Personal Access Token or GitHubApp auth) + + https://developer.github.com/v3/apps/#get-a-single-github-app + The URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App. + + + + Returns the GitHub App associated with the authentication credentials used (requires GitHubApp auth). + + https://developer.github.com/v3/apps/#get-the-authenticated-github-app + + + + List installations of the authenticated GitHub App (requires GitHubApp auth). + + https://developer.github.com/v3/apps/#find-installations + + + + List installations of the authenticated GitHub App (requires GitHubApp auth). + + Options for changing the API response + https://developer.github.com/v3/apps/#find-installations + + + + Get a single GitHub App Installation (requires GitHubApp auth). + + https://developer.github.com/v3/apps/#get-a-single-installation + The Id of the GitHub App Installation + + + + Get a single GitHub App Installation (requires GitHubApp auth). + + https://developer.github.com/v3/apps/#get-a-single-installation + The Id of the GitHub App Installation + + + + List installations for the currently authenticated user (requires GitHubApp User-To-Server Auth). + + https://developer.github.com/v3/apps/#list-installations-for-user + + + + List installations for the currently authenticated user (requires GitHubApp User-To-Server Auth). + + https://developer.github.com/v3/apps/#list-installations-for-user + + + + Create a time bound access token for a GitHubApp Installation that can be used to access other API endpoints (requires GitHubApp auth). + + + https://developer.github.com/v3/apps/#create-a-new-installation-token + https://developer.github.com/apps/building-github-apps/authentication-options-for-github-apps/#authenticating-as-an-installation + https://developer.github.com/v3/apps/available-endpoints/ + + The Id of the GitHub App Installation + + + + Enables an authenticated GitHub App to find the organization's installation information (requires GitHubApp auth). + + https://developer.github.com/v3/apps/#find-organization-installation + The name of the organization + + + + Enables an authenticated GitHub App to find the repository's installation information (requires GitHubApp auth). + + https://developer.github.com/v3/apps/#find-repository-installation + The owner of the repo + The name of the repo + + + + Enables an authenticated GitHub App to find the repository's installation information (requires GitHubApp auth). + + https://developer.github.com/v3/apps/#find-repository-installation + The Id of the repository + + + + Enables an authenticated GitHub App to find the users's installation information (requires GitHubApp auth). + + https://developer.github.com/v3/apps/#find-user-installation + The name of the user + + + + A client for GitHub's Reactions API. + + + See the Reactions API documentation for more information. + + + + + Creates a reaction for a specified Issue Comment + + https://developer.github.com/v3/reactions/#create-reaction-for-an-issue-comment + The owner of the repository + The name of the repository + The comment id + The reaction to create + + + + Creates a reaction for a specified Issue Comment + + https://developer.github.com/v3/reactions/#create-reaction-for-an-issue-comment + The Id of the repository + The comment id + The reaction to create + + + + Get all reactions for a specified Issue Comment + + https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment + The owner of the repository + The name of the repository + The comment id + + + + Get all reactions for a specified Issue Comment + + https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment + The Id of the repository + The comment id + + + + A client for GitHub's Issue Comments API. + + + See the Issue Comments API documentation for more information. + + + + + Gets a single Issue Comment by id. + + http://developer.github.com/v3/issues/comments/#get-a-single-comment + The owner of the repository + The name of the repository + The issue comment id + + + + Gets a single Issue Comment by id. + + http://developer.github.com/v3/issues/comments/#get-a-single-comment + The Id of the repository + The issue comment id + + + + Gets Issue Comments for a repository. + + http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository + The owner of the repository + The name of the repository + + + + Gets Issue Comments for a repository. + + http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository + The Id of the repository + + + + Gets Issue Comments for a repository. + + http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository + The owner of the repository + The name of the repository + Options for changing the API response + + + + Gets Issue Comments for a repository. + + http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository + The Id of the repository + Options for changing the API response + + + + Gets Issue Comments for a repository. + + http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository + The owner of the repository + The name of the repository + The sorting parameters + + + + Gets Issue Comments for a repository. + + http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository + The Id of the repository + The sorting parameters + + + + Gets Issue Comments for a repository. + + http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository + The owner of the repository + The name of the repository + The sorting parameters + Options for changing the API response + + + + Gets Issue Comments for a repository. + + http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository + The Id of the repository + The sorting parameters + Options for changing the API response + + + + Gets Issue Comments for a specified Issue. + + http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue + The owner of the repository + The name of the repository + The issue number + + + + Gets Issue Comments for a specified Issue. + + http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue + The Id of the repository + The issue number + + + + Gets Issue Comments for a specified Issue. + + http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue + The owner of the repository + The name of the repository + The issue number + Options for changing the API response + + + + Gets Issue Comments for a specified Issue. + + http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue + The Id of the repository + The issue number + Options for changing the API response + + + + Creates a new Issue Comment for a specified Issue. + + http://developer.github.com/v3/issues/comments/#create-a-comment + The owner of the repository + The name of the repository + The number of the issue + The new comment to add to the issue + + + + Creates a new Issue Comment for a specified Issue. + + http://developer.github.com/v3/issues/comments/#create-a-comment + The Id of the repository + The number of the issue + The new comment to add to the issue + + + + Updates a specified Issue Comment. + + http://developer.github.com/v3/issues/comments/#edit-a-comment + The owner of the repository + The name of the repository + The comment id + The modified comment + + + + Updates a specified Issue Comment. + + http://developer.github.com/v3/issues/comments/#edit-a-comment + The Id of the repository + The comment id + The modified comment + + + + Deletes the specified Issue Comment + + http://developer.github.com/v3/issues/comments/#delete-a-comment + The owner of the repository + The name of the repository + The comment id + + + + Deletes the specified Issue Comment + + http://developer.github.com/v3/issues/comments/#delete-a-comment + The Id of the repository + The comment id + + + + A client for GitHub's Reactions API. + + + See the Reactions API documentation for more information. + + + + + Get all reactions for a specified Issue + + https://developer.github.com/v3/reactions/#list-reactions-for-an-issue + The owner of the repository + The name of the repository + The issue id + + + + Get all reactions for a specified Issue + + https://developer.github.com/v3/reactions/#list-reactions-for-an-issue + The Id of the repository + The issue id + + + + Creates a reaction for a specified Issue + + https://developer.github.com/v3/reactions/#create-reaction-for-an-issue + The owner of the repository + The name of the repository + The issue id + The reaction to create + + + + Creates a reaction for a specified Issue + + https://developer.github.com/v3/reactions/#create-reaction-for-an-issue + The Id of the repository + The issue id + The reaction to create + + + + A client for GitHub's Issues API. + + + See the Issues API documentation for more information. + + + + + Client for managing assignees. + + + + + Client for reading various event information associated with issues/pull requests. + This is useful both for display on issue/pull request information pages and also to + determine who should be notified of comments. + + + + + Client for managing milestones. + + + + + Client for managing labels. + + + + + Client for managing comments. + + + + + Gets a single Issue by number. + + + http://developer.github.com/v3/issues/#get-a-single-issue + + The owner of the repository + The name of the repository + The issue number + + + + Gets a single Issue by number. + + + http://developer.github.com/v3/issues/#get-a-single-issue + + The Id of the repository + The issue number + + + + Gets all open issues assigned to the authenticated user across all the authenticated user’s visible + repositories including owned repositories, member repositories, and organization repositories. + + + Issues are sorted by the create date descending. + http://developer.github.com/v3/issues/#list-issues + + + + + Gets all open issues assigned to the authenticated user across all the authenticated user’s visible + repositories including owned repositories, member repositories, and organization repositories. + + Options for changing the API response + + Issues are sorted by the create date descending. + http://developer.github.com/v3/issues/#list-issues + + + + + Gets all issues across all the authenticated user’s visible repositories including owned repositories, + member repositories, and organization repositories. + + + http://developer.github.com/v3/issues/#list-issues + + Used to filter and sort the list of issues returned + + + + Gets all issues across all the authenticated user’s visible repositories including owned repositories, + member repositories, and organization repositories. + + Options for changing the API response + + http://developer.github.com/v3/issues/#list-issues + + Used to filter and sort the list of issues returned + + + + Gets all open issues assigned to the authenticated user across owned and member repositories for the + authenticated user. + + + Issues are sorted by the create date descending. + http://developer.github.com/v3/issues/#list-issues + + + + + Gets all open issues assigned to the authenticated user across owned and member repositories for the + authenticated user. + + Options for changing the API response + + Issues are sorted by the create date descending. + http://developer.github.com/v3/issues/#list-issues + + + + + Gets all issues across owned and member repositories for the authenticated user. + + + http://developer.github.com/v3/issues/#list-issues + + Used to filter and sort the list of issues returned + + + + Gets all issues across owned and member repositories for the authenticated user. + + + http://developer.github.com/v3/issues/#list-issues + + Used to filter and sort the list of issues returned + Options for changing the API response + + + + Gets all open issues assigned to the authenticated user for a given organization for the authenticated user. + + + http://developer.github.com/v3/issues/#list-issues + + The name of the organization + + + + Gets all open issues assigned to the authenticated user for a given organization for the authenticated user. + + + http://developer.github.com/v3/issues/#list-issues + + The name of the organization + Options for changing the API response + + + + Gets all issues for a given organization for the authenticated user. + + + http://developer.github.com/v3/issues/#list-issues + + The name of the organization + Used to filter and sort the list of issues returned + + + + Gets all issues for a given organization for the authenticated user. + + + http://developer.github.com/v3/issues/#list-issues + + The name of the organization + Used to filter and sort the list of issues returned + Options for changing the API response + + + + Gets all open issues assigned to the authenticated user for the repository. + + + http://developer.github.com/v3/issues/#list-issues-for-a-repository + + The owner of the repository + The name of the repository + + + + Gets all open issues assigned to the authenticated user for the repository. + + + http://developer.github.com/v3/issues/#list-issues-for-a-repository + + The Id of the repository + + + + Gets all open issues assigned to the authenticated user for the repository. + + + http://developer.github.com/v3/issues/#list-issues-for-a-repository + + The owner of the repository + The name of the repository + Options for changing the API response + + + + Gets all open issues assigned to the authenticated user for the repository. + + + http://developer.github.com/v3/issues/#list-issues-for-a-repository + + The Id of the repository + Options for changing the API response + + + + Gets issues for a repository. + + + http://developer.github.com/v3/issues/#list-issues-for-a-repository + + The owner of the repository + The name of the repository + Used to filter and sort the list of issues returned + + + + Gets issues for a repository. + + + http://developer.github.com/v3/issues/#list-issues-for-a-repository + + The Id of the repository + Used to filter and sort the list of issues returned + + + + Gets issues for a repository. + + + http://developer.github.com/v3/issues/#list-issues-for-a-repository + + The owner of the repository + The name of the repository + Used to filter and sort the list of issues returned + Options for changing the API response + + + + Gets issues for a repository. + + + http://developer.github.com/v3/issues/#list-issues-for-a-repository + + The Id of the repository + Used to filter and sort the list of issues returned + Options for changing the API response + + + + Creates an issue for the specified repository. Any user with pull access to a repository can create an + issue. + + http://developer.github.com/v3/issues/#create-an-issue + The owner of the repository + The name of the repository + A instance describing the new issue to create + + + + Creates an issue for the specified repository. Any user with pull access to a repository can create an + issue. + + http://developer.github.com/v3/issues/#create-an-issue + The Id of the repository + A instance describing the new issue to create + + + + Updates an issue for the specified repository. Any user with pull access to a repository can update an + issue. + + http://developer.github.com/v3/issues/#edit-an-issue + The owner of the repository + The name of the repository + The issue number + An instance describing the changes to make to the issue + + + + + Updates an issue for the specified repository. Any user with pull access to a repository can update an + issue. + + http://developer.github.com/v3/issues/#edit-an-issue + The Id of the repository + The issue number + An instance describing the changes to make to the issue + + + + + Locks an issue for the specified repository. Issue owners and users with push access can lock an issue. + + https://developer.github.com/v3/issues/#lock-an-issue + The owner of the repository + The name of the repository + The issue number + + + + Locks an issue for the specified repository. Issue owners and users with push access can lock an issue. + + https://developer.github.com/v3/issues/#lock-an-issue + The Id of the repository + The issue number + + + + Unlocks an issue for the specified repository. Issue owners and users with push access can unlock an issue. + + https://developer.github.com/v3/issues/#unlock-an-issue + The owner of the repository + The name of the repository + The issue number + + + + Unlocks an issue for the specified repository. Issue owners and users with push access can unlock an issue. + + https://developer.github.com/v3/issues/#unlock-an-issue + The Id of the repository + The issue number + + + + A client for GitHub's Issue Events API. + + + See the Issue Events API documentation for more information. + + + + + Gets all events for the issue. + + + http://developer.github.com/v3/issues/events/#list-events-for-an-issue + + The owner of the repository + The name of the repository + The issue number + + + + Gets all events for the issue. + + + http://developer.github.com/v3/issues/events/#list-events-for-an-issue + + The Id of the repository + The issue number + + + + Gets all events for the issue. + + + http://developer.github.com/v3/issues/events/#list-events-for-an-issue + + The owner of the repository + The name of the repository + The issue number + Options for changing the API response + + + + Gets all events for the issue. + + + http://developer.github.com/v3/issues/events/#list-events-for-an-issue + + The Id of the repository + The issue number + Options for changing the API response + + + + Gets all events for the repository. + + + http://developer.github.com/v3/issues/events/#list-events-for-a-repository + + The owner of the repository + The name of the repository + + + + Gets all events for the repository. + + + http://developer.github.com/v3/issues/events/#list-events-for-a-repository + + The Id of the repository + + + + Gets all events for the repository. + + + http://developer.github.com/v3/issues/events/#list-events-for-a-repository + + The owner of the repository + The name of the repository + Options for changing the API response + + + + Gets all events for the repository. + + + http://developer.github.com/v3/issues/events/#list-events-for-a-repository + + The Id of the repository + Options for changing the API response + + + + Gets a single event + + + http://developer.github.com/v3/issues/events/#get-a-single-event + + The owner of the repository + The name of the repository + The event id + + + + Gets a single event + + + http://developer.github.com/v3/issues/events/#get-a-single-event + + The Id of the repository + The event id + + + + A client for GitHub's Issue Labels API. + + + See the Issue Labels API documentation for more information. + + + + + Gets all labels for the issue. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The number of the issue + + + + Gets all labels for the issue. + + + See the API documentation for more information. + + The Id of the repository + The number of the issue + + + + Gets all labels for the issue. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The number of the issue + Options for changing the API response + + + + Gets all labels for the issue. + + + See the API documentation for more information. + + The Id of the repository + The number of the issue + Options for changing the API response + + + + Gets all labels for the repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + + + + Gets all labels for the repository. + + + See the API documentation for more information. + + The Id of the repository + + + + Gets all labels for the repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Options for changing the API response + + + + Gets all labels for the repository. + + + See the API documentation for more information. + + The Id of the repository + Options for changing the API response + + + + Gets labels for every issue in a milestone + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The number of the milestone + + + + Gets labels for every issue in a milestone + + + See the API documentation for more information. + + The Id of the repository + The number of the milestone + + + + Gets labels for every issue in a milestone + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The number of the milestone + Options for changing the API response + + + + Gets labels for every issue in a milestone + + + See the API documentation for more information. + + The Id of the repository + The number of the milestone + Options for changing the API response + + + + Gets a single Label by name. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The name of the label + + + + Gets a single Label by name. + + + See the API documentation for more information. + + The Id of the repository + The name of the label + + + + Deletes a label. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The name of the label + + + + Deletes a label. + + + See the API documentation for more information. + + The Id of the repository + The name of the label + + + + Creates a label. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The data for the label to be created + + + + Creates a label. + + + See the API documentation for more information. + + The Id of the repository + The data for the label to be created + + + + Updates a label. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The name of the label + The data for the label to be updated + + + + Updates a label. + + + See the API documentation for more information. + + The Id of the repository + The name of the label + The data for the label to be updated + + + + Adds a label to an issue + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The number of the issue + The names of the labels to add + + + + Adds a label to an issue + + + See the API documentation for more information. + + The Id of the repository + The number of the issue + The names of the labels to add + + + + Removes a label from an issue + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The number of the issue + The name of the label to remove + + + + Removes a label from an issue + + + See the API documentation for more information. + + The Id of the repository + The number of the issue + The name of the label to remove + + + + Replaces all labels on the specified issues with the provided labels + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The number of the issue + The names of the labels to set + + + + Replaces all labels on the specified issues with the provided labels + + + See the API documentation for more information. + + The Id of the repository + The number of the issue + The names of the labels to set + + + + Removes all labels from an issue + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The number of the issue + + + + Removes all labels from an issue + + + See the API documentation for more information. + + The Id of the repository + The number of the issue + + + + A client for GitHub's Issue Timeline API. + + + See the Issue Timeline API documentation for more information. + + + + + Gets all the various events that have occurred around an issue or pull request. + + + https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue + + The owner of the repository + The name of the repository + The issue number + + + + Gets all the various events that have occurred around an issue or pull request. + + + https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue + + The owner of the repository + The name of the repository + The issue number + Options for changing the API repsonse + + + + Gets all the various events that have occurred around an issue or pull request. + + + https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue + + The Id of the repository + The issue number + + + + Gets all the various events that have occurred around an issue or pull request. + + + https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue + + The Id of the repository + The issue number + Options for changing the API response + + + + A client for GitHub's Git Merging API. + + + See the Git Merging API documentation for more information. + + + + + Create a merge for a given repository + + + http://developer.github.com/v3/repos/merging/#perform-a-merge + + The owner of the repository + The name of the repository + The merge to create + + + + + Create a merge for a given repository + + + http://developer.github.com/v3/repos/merging/#perform-a-merge + + The Id of the repository + The merge to create + + + + + A client for GitHub's Migration API. These APIs help you move projects to or from GitHub. + + + Docs: https://developer.github.com/v3/migration/ + + + + + The Enterprise Migrations API lets you move a repository from GitHub to GitHub Enterprise. + + + https://developer.github.com/v3/migration/#enterprise-migrations + + + + + An interface for GitHub's Migrations API client. + + + See the docs + for more information. + + + + + Starts a new migration specified for the given organization. + + + https://developer.github.com/v3/migration/migrations/#start-a-migration + + The organization for which to start a migration. + Sprcifies parameters for the migration in a + object. + The started migration. + + + + Gets the list of the most recent migrations of the the organization. + + + https://developer.github.com/v3/migration/migrations/#get-a-list-of-migrations + + The organization of which to list migrations. + List of most recent s. + + + + Get the status of a migration + + + https://developer.github.com/v3/migration/migrations/#get-the-status-of-a-migration + + The organization which is migrating. + Migration Id of the organization. + A object representing the state of migration. + + + + Get the migration archive. + + + https://developer.github.com/v3/migration/migrations/#download-a-migration-archive + + The organization of which the migration was. + The Id of the migration. + The binary contents of the archive as a byte array. + + + + Deletes a previous migration archive. + + + https://developer.github.com/v3/migration/migrations/#delete-a-migration-archive + + The organization of which the migration was. + The Id of the migration. + + + + + Unlocks a repository that was locked for migration. + + + https://developer.github.com/v3/migration/migrations/#unlock-a-repository + + The organization of which the migration was. + The Id of the migration. + The repo to unlock. + + + + + A client for GitHub's Issue Milestones API. + + + See the Issue Milestones API documentation for more information. + + + + + Gets a single Milestone by number. + + + http://developer.github.com/v3/issues/milestones/#get-a-single-milestone + + + + + + Gets a single Milestone by number. + + + http://developer.github.com/v3/issues/milestones/#get-a-single-milestone + + + + + + Gets all open milestones for the repository. + + + http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository + + The owner of the repository + The name of the repository + + + + + Gets all open milestones for the repository. + + + http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository + + The Id of the repository + + + + + Gets all open milestones for the repository. + + + http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository + + The owner of the repository + The name of the repository + Options for changing the API response + + + + + Gets all open milestones for the repository. + + + http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository + + The Id of the repository + Options for changing the API response + + + + + Gets all open milestones for the repository. + + + http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository + + The owner of the repository + The name of the repository + Used to filter and sort the list of Milestones returned + + + + + Gets all open milestones for the repository. + + + http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository + + The Id of the repository + Used to filter and sort the list of Milestones returned + + + + + Gets all open milestones for the repository. + + + http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository + + The owner of the repository + The name of the repository + Used to filter and sort the list of Milestones returned + Options for changing the API response + + + + + Gets all open milestones for the repository. + + + http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository + + The Id of the repository + Used to filter and sort the list of Milestones returned + Options for changing the API response + + + + + Creates a milestone for the specified repository. Any user with pull access to a repository can create an + Milestone. + + http://developer.github.com/v3/issues/milestones/#create-a-milestone + The owner of the repository + The name of the repository + A instance describing the new Milestone to create + + + + + Creates a milestone for the specified repository. Any user with pull access to a repository can create an + Milestone. + + http://developer.github.com/v3/issues/milestones/#create-a-milestone + The Id of the repository + A instance describing the new Milestone to create + + + + + Creates a milestone for the specified repository. Any user with pull access to a repository can create an + Milestone. + + http://developer.github.com/v3/issues/milestones/#update-a-milestone + The owner of the repository + The name of the repository + The Milestone number + An instance describing the changes to make to the Milestone + + + + + + Creates a milestone for the specified repository. Any user with pull access to a repository can create an + Milestone. + + http://developer.github.com/v3/issues/milestones/#update-a-milestone + The Id of the repository + The Milestone number + An instance describing the changes to make to the Milestone + + + + + + Deletes a milestone for the specified repository. Any user with pull access to a repository can create an + Milestone. + + http://developer.github.com/v3/issues/milestones/#delete-a-milestone + The owner of the repository + The name of the repository + The milestone number + + + + + Deletes a milestone for the specified repository. Any user with pull access to a repository can create an + Milestone. + + http://developer.github.com/v3/issues/milestones/#delete-a-milestone + The Id of the repository + The milestone number + + + + + A client for GitHub's miscellaneous APIs. + + + See the Miscellaneous API documentation for more details. + + + + + Gets all the emojis available to use on GitHub. + + Thrown when a general API error occurs. + An of emoji and their URI. + + + + Gets the rendered Markdown for the specified plain-text Markdown document. + + A plain-text Markdown document + Thrown when a general API error occurs. + The rendered Markdown. + + + + Gets the rendered Markdown for an arbitrary markdown document. + + An arbitrary Markdown document + Thrown when a general API error occurs. + The rendered Markdown. + + + + List all templates available to pass as an option when creating a repository. + + A list of template names + + + + Retrieves the source for a single GitIgnore template + + + A template and its source + + + + Returns a list of the licenses shown in the license picker on GitHub.com. This is not a comprehensive + list of all possible OSS licenses. + + This is a PREVIEW API! Use it at your own risk. + A list of licenses available on the site + + + + Retrieves a license based on the license key such as "mit" + + + A that includes the license key, text, and attributes of the license. + + + + Gets API Rate Limits (API service rather than header info). + + Thrown when a general API error occurs. + An of Rate Limits. + + + + Retrieves information about GitHub.com, the service or a GitHub Enterprise installation. + + Thrown when a general API error occurs. + An containing metadata about the GitHub instance. + + + + A client for GitHub's Activity Notifications API. + + + See the Activity Notifications API documentation for more information. + + + + + Retrieves all of the s for the current user. + + Thrown if the client is not authenticated. + + + + Retrieves all of the s for the current user. + + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the s for the current user. + + Specifies the parameters to filter notifications by + Thrown if the client is not authenticated. + + + + Retrieves all of the s for the current user. + + Specifies the parameters to filter notifications by + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the s for the current user specific to the specified repository. + + The owner of the repository. + The name of the repository. + Thrown if the client is not authenticated. + + + + Retrieves all of the s for the current user specific to the specified repository. + + The Id of the repository. + Thrown if the client is not authenticated. + + + + Retrieves all of the s for the current user specific to the specified repository. + + The owner of the repository. + The name of the repository. + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the s for the current user specific to the specified repository. + + The Id of the repository. + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the s for the current user specific to the specified repository. + + The owner of the repository. + The name of the repository. + Specifies the parameters to filter notifications by + Thrown if the client is not authenticated. + + + + Retrieves all of the s for the current user specific to the specified repository. + + The Id of the repository. + Specifies the parameters to filter notifications by + Thrown if the client is not authenticated. + + + + Retrieves all of the s for the current user specific to the specified repository. + + The owner of the repository. + The name of the repository. + Specifies the parameters to filter notifications by + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the s for the current user specific to the specified repository. + + The Id of the repository. + Specifies the parameters to filter notifications by + Options for changing the API response + Thrown if the client is not authenticated. + + + + Marks all notifications as read. + + http://developer.github.com/v3/activity/notifications/#mark-as-read + + + + Marks all notifications as read. + + The parameter which specifies which notifications to mark. + http://developer.github.com/v3/activity/notifications/#mark-as-read + + + + Marks the notifications for a given repository as read. + + The owner of the repository + The name of the repository + http://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository + + + + Marks the notifications for a given repository as read. + + The Id of the repository + http://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository + + + + Marks the notifications for a given repository as read. + + The owner of the repository + The name of the repository + The parameter which specifies which notifications to mark. + http://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository + + + + Marks the notifications for a given repository as read. + + The Id of the repository + The parameter which specifies which notifications to mark. + http://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository + + + + Retrives a single by Id. + + The Id of the notification to retrieve. + http://developer.github.com/v3/activity/notifications/#view-a-single-thread + + + + Marks a single notification as read. + + The id of the notification. + http://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read + + + + Retrives a for the provided thread id. + + The Id of the thread to retrieve subscription status. + http://developer.github.com/v3/activity/notifications/#get-a-thread-subscription + + + + Sets the authenticated user's subscription settings for a given thread. + + The Id of the thread to update. + The subscription parameters to set. + http://developer.github.com/v3/activity/notifications/#set-a-thread-subscription + + + + Deletes the authenticated user's subscription to a given thread. + + The Id of the thread to delete subscription from. + http://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription + + + + Provides methods used in the OAuth web flow. + + + + + Gets the URL used in the first step of the web flow. The Web application should redirect to this URL. + + Parameters to the Oauth web flow login url + + + + + Makes a request to get an access token using the code returned when GitHub.com redirects back from the URL + GitHub login url to the application. + + + If the user accepts your request, GitHub redirects back to your site with a temporary code in a code + parameter as well as the state you provided in the previous step in a state parameter. If the states don’t + match, the request has been created by a third party and the process should be aborted. Exchange this for + an access token using this method. + + + + + + + A client for GitHub's Organization Members API. + + + See the Orgs API documentation for more information. + + + + + + List all users who are members of an organization. A member is a user that + belongs to at least 1 team in the organization. + + + If the authenticated user is also an owner of this organization then both + concealed and public member will be returned. + + + If the requester is not an owner of the organization the query will be redirected + to the public members list. + + + + See the API documentation + for more information. + + The login for the organization + The users + + + + + List all users who are members of an organization. A member is a user that + belongs to at least 1 team in the organization. + + + If the authenticated user is also an owner of this organization then both + concealed and public member will be returned. + + + If the requester is not an owner of the organization the query will be redirected + to the public members list. + + + + See the API documentation + for more information. + + The login for the organization + Options for changing the API response + The users + + + + + List all users who are members of an organization. A member is a user that + belongs to at least 1 team in the organization. + + + If the authenticated user is also an owner of this organization then both + concealed and public member will be returned. + + + If the requester is not an owner of the organization the query will be redirected + to the public members list. + + + + See the API documentation + for more information. + + The login for the organization + The filter to use when getting the users, + The users + + + + + List all users who are members of an organization. A member is a user that + belongs to at least 1 team in the organization. + + + If the authenticated user is also an owner of this organization then both + concealed and public member will be returned. + + + If the requester is not an owner of the organization the query will be redirected + to the public members list. + + + + See the API documentation + for more information. + + The login for the organization + The filter to use when getting the users, + Options for changing the API response + The users + + + + + List all users who are members of an organization. A member is a user that + belongs to at least 1 team in the organization. + + + If the authenticated user is also an owner of this organization then both + concealed and public member will be returned. + + + If the requester is not an owner of the organization the query will be redirected + to the public members list. + + + + See the API documentation + for more information. + + The login for the organization + The role filter to use when getting the users, + The users + + + + + List all users who are members of an organization. A member is a user that + belongs to at least 1 team in the organization. + + + If the authenticated user is also an owner of this organization then both + concealed and public member will be returned. + + + If the requester is not an owner of the organization the query will be redirected + to the public members list. + + + + See the API documentation + for more information. + + The login for the organization + The role filter to use when getting the users, + Options for changing the API response + The users + + + + + List all users who are members of an organization. A member is a user that + belongs to at least 1 team in the organization. + + + If the authenticated user is also an owner of this organization then both + concealed and public member will be returned. + + + If the requester is not an owner of the organization the query will be redirected + to the public members list. + + + + See the API documentation + for more information. + + The login for the organization + The filter to use when getting the users, + The role filter to use when getting the users, + The users + + + + + List all users who are members of an organization. A member is a user that + belongs to at least 1 team in the organization. + + + If the authenticated user is also an owner of this organization then both + concealed and public member will be returned. + + + If the requester is not an owner of the organization the query will be redirected + to the public members list. + + + + See the API documentation + for more information. + + The login for the organization + The filter to use when getting the users, + The role filter to use when getting the users, + Options for changing the API response + The users + + + + List all users who have publicized their membership of the organization. + + http://developer.github.com/v3/orgs/members/#public-members-list + The login for the organization + + + + + List all users who have publicized their membership of the organization. + + http://developer.github.com/v3/orgs/members/#public-members-list + The login for the organization + Options for changing the API response + + + + + Check if a user is, publicly or privately, a member of the organization. + + + See the API documentation + for more information. + + The login for the organization + The login for the user + + + + + Check is a user is publicly a member of the organization. + + + See the API documentation + for more information. + + The login for the organization + The login for the user + + + + + Removes a user from the organization, this will also remove them from all teams + within the organization and they will no longer have any access to the organization's + repositories. + + + See the API documentation + for more information. + + The login for the organization + The login for the user + + + + + Make the authenticated user's organization membership public. + + + This method requires authentication. + See the API documentation + for more information. + + The login for the organization + The login for the user + + + + + Make the authenticated user's organization membership private. + + + This method requries authentication. + See the API documentation + for more information. + + The login for the organization + The login for the user + + + + + List all pending invitations for the organization. + + + See the API Documentation + for more information. + + The login for the organization + + + + + List all pending invitations for the organization. + + + See the API Documentation + for more information. + + The login for the organization + Options to change API behaviour + + + + + List all users who are outside collaborators of an organization. An outside collaborator is a user that + is not a member of the organization. + + + See the API documentation + for more information. + + The login for the organization + The users + + + + List all users who are outside collaborators of an organization. An outside collaborator is a user that + is not a member of the organization. + + + See the API documentation + for more information. + + The login for the organization + Options for changing the API response + The users + + + + List all users who are outside collaborators of an organization. An outside collaborator is a user that + is not a member of the organization. + + + See the API documentation + for more information. + + The login for the organization + The filter to use when getting the users, + The users + + + + List all users who are outside collaborators of an organization. An outside collaborator is a user that + is not a member of the organization. + + + See the API documentation + for more information. + + The login for the organization + The filter to use when getting the users, + Options for changing the API response + The users + + + + Removes a user as an outside collaborator from the organization, this will remove them from all repositories + within the organization. + + + See the API documentation + for more information. + + The login for the organization + The login of the user + + + + + Converts an organization member to an outside collaborator, + when an organization member is converted to an outside collaborator, + they'll only have access to the repositories that their current team membership allows. + The user will no longer be a member of the organization. + + + See the API documentation + for more information. + + The login for the organization + The login for the user + + + + + A client for GitHub's Orgs API. + + + See the Orgs API documentation for more information. + + + + + Returns a client to manage members of an organization. + + + + + Returns a client to manage teams of an organization. + + + + + Returns a client to manage outside collaborators of an organization. + + + + + Returns the specified . + + login of the organization to get + Thrown when a general API error occurs. + The specified . + + + + Returns all s for the current user. + + Thrown when a general API error occurs. + A list of the current user's s. + + + + Returns all s for the current user. + + Options for changing the API response + Thrown when a general API error occurs. + A list of the current user's s. + + + + Returns all s for the specified user. + + Thrown when a general API error occurs. + A list of the specified user's s. + + + + Returns all s for the specified user. + + The login of the user + Options for changing the API response + Thrown when a general API error occurs. + A list of the specified user's s. + + + + Returns all s. + + Thrown when a general API error occurs. + A list of s. + + + + Returns all s. + + Search parameters of the last organization seen + Thrown when a general API error occurs. + A list of s. + + + + Update the specified organization with data from . + + The name of the organization to update. + + Thrown if the client is not authenticated. + A + + + + A client for GitHub's Project Cards API. + + + See the Repository Projects API documentation for more information. + + + + + Gets all cards. + + + See the API documentation for more information. + + The id of the column + + + + Gets all cards. + + + See the API documentation for more information. + + The id of the column + Options for changing the API response + + + + Gets all cards. + + + See the API documentation for more information. + + The id of the column + Used to filter the list of project cards returned + + + + Gets all cards. + + + See the API documentation for more information. + + The id of the column + Used to filter the list of project cards returned + Options for changing the API response + + + + Gets a single card. + + + See the API documentation for more information. + + The id of the card + + + + Creates a card. + + + See the API documentation for more information. + + The id of the column + The card to create + + + + Updates a card. + + + See the API documentation for more information. + + The id of the card + New values to update the card with + + + + Deletes a card. + + + See the API documentation for more information. + + The id of the card + + + + Moves a card. + + + See the API documentation for more information. + + The id of the card + The position to move the card + + + + A client for GitHub's Project Columns API. + + + See the Repository Projects API documentation for more information. + + + + + Gets all columns. + + + See the API documentation for more information. + + The Id of the project + + + + Gets all columns. + + + See the API documentation for more information. + + The Id of the project + Options for changing the API response + + + + Gets a single column. + + + See the API documentation for more information. + + The id of the column + + + + Creates a column. + + + See the API documentation for more information. + + The Id of the project + The column to create + + + + Updates a column. + + + See the API documentation for more information. + + The id of the column + New values to update the column with + + + + Deletes a column. + + + See the API documentation for more information. + + The id of the column + + + + Moves a column. + + + See the API documentation for more information. + + The id of the column + The position to move the column + + + + A client for GitHub's Repository Projects API. + + + See the Repository Projects API documentation for more information. + + + + + Get all projects for this repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + + + + Get all projects for this repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Used to filter the list of projects returned + + + + Get all projects for this repository. + + + See the API documentation for more information. + + The Id of the repository + + + + Get all projects for this repository. + + + See the API documentation for more information. + + The Id of the repository + Used to filter the list of projects returned + + + + Get all projects for this repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Options for changing the API response + + + + Get all projects for this repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Used to filter the list of projects returned + Options for changing the API response + + + + Get all projects for this repository. + + + See the API documentation for more information. + + The Id of the repository + Options for changing the API response + + + + Get all projects for this repository. + + + See the API documentation for more information. + + The Id of the repository + Used to filter the list of projects returned + Options for changing the API response + + + + Get all projects for the specified organization. + + + See the API documentation for more information. + + The name of the organziation + + + + Get all projects for the specified organization. + + + See the API documentation for more information. + + The name of the organziation + Used to filter the list of projects returned + + + + Get all projects for the specified organization. + + + See the API documentation for more information. + + The name of the organziation + Options for changing the API response + + + + Get all projects for the specified organization. + + + See the API documentation for more information. + + The name of the organziation + Used to filter the list of projects returned + Options for changing the API response + + + + Gets a single project for this repository. + + + See the API documentation for more information. + + The Id of the project + + + + Creates a project for this repository. + + + See the API documentation for more information. + + The id of the repository + The new project to create for this repository + + + + Creates a project for the specified organization. + + + See the API documentation for more information. + + The name of the organization + The new project to create for this repository + + + + Updates a project for this repository. + + + See the API documentation for more information. + + The Id of the project + The modified project + + + + Deletes a project. + + + See the API documentation for more information. + + The Id of the project + + + + A client for GitHub's Project Cards API. + + + See the Repository Projects API documentation for more information. + + + + + A client for GitHub's Project Columns API. + + + See the Repository Projects API documentation for more information. + + + + + A client for GitHub's Reactions API. + + + See the Reactions API documentation for more information. + + + + + Get all reactions for a specified Pull Request Review Comment. + + https://developer.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment + The owner of the repository + The name of the repository + The comment id + + + + Get all reactions for a specified Pull Request Review Comment. + + https://developer.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment + The Id of the repository + The comment id + + + + Creates a reaction for a specified Pull Request Review Comment. + + https://developer.github.com/v3/reactions/#create-reaction-for-a-pull-request-review-comment + The owner of the repository + The name of the repository + The comment id + The reaction to create + + + + Creates a reaction for a specified Pull Request Review Comment. + + https://developer.github.com/v3/reactions/#create-reaction-for-a-pull-request-review-comment + The Id of the repository + The comment id + The reaction to create + + + + A client for GitHub's Pull Request Review Comments API. + + + See the Review Comments API documentation for more information. + + + + + Gets review comments for a specified pull request. + + http://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request + The owner of the repository + The name of the repository + The pull request number + + + + Gets review comments for a specified pull request. + + http://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request + The Id of the repository + The pull request number + + + + Gets review comments for a specified pull request. + + http://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request + The owner of the repository + The name of the repository + The pull request number + Options for changing the API response + + + + Gets review comments for a specified pull request. + + http://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request + The Id of the repository + The pull request number + Options for changing the API response + + + + Gets a list of the pull request review comments in a specified repository. + + http://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository + The owner of the repository + The name of the repository + + + + Gets a list of the pull request review comments in a specified repository. + + http://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository + The Id of the repository + + + + Gets a list of the pull request review comments in a specified repository. + + http://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository + The owner of the repository + The name of the repository + Options for changing the API response + + + + Gets a list of the pull request review comments in a specified repository. + + http://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository + The Id of the repository + Options for changing the API response + + + + Gets a list of the pull request review comments in a specified repository. + + http://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository + The owner of the repository + The name of the repository + The sorting parameters + + + + Gets a list of the pull request review comments in a specified repository. + + http://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository + The Id of the repository + The sorting parameters + + + + Gets a list of the pull request review comments in a specified repository. + + http://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository + The owner of the repository + The name of the repository + The sorting parameters + Options for changing the API response + + + + Gets a list of the pull request review comments in a specified repository. + + http://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository + The Id of the repository + The sorting parameters + Options for changing the API response + + + + Gets a single pull request review comment by number. + + http://developer.github.com/v3/pulls/comments/#get-a-single-comment + The owner of the repository + The name of the repository + The pull request review comment number + + + + Gets a single pull request review comment by number. + + http://developer.github.com/v3/pulls/comments/#get-a-single-comment + The Id of the repository + The pull request review comment number + + + + Creates a comment on a pull request review. + + http://developer.github.com/v3/pulls/comments/#create-a-comment + The owner of the repository + The name of the repository + The Pull Request number + The comment + + + + Creates a comment on a pull request review. + + http://developer.github.com/v3/pulls/comments/#create-a-comment + The Id of the repository + The Pull Request number + The comment + + + + Creates a comment on a pull request review as a reply to another comment. + + http://developer.github.com/v3/pulls/comments/#create-a-comment + The owner of the repository + The name of the repository + The pull request number + The comment + + + + Creates a comment on a pull request review as a reply to another comment. + + http://developer.github.com/v3/pulls/comments/#create-a-comment + The Id of the repository + The pull request number + The comment + + + + Edits a comment on a pull request review. + + http://developer.github.com/v3/pulls/comments/#edit-a-comment + The owner of the repository + The name of the repository + The pull request review comment number + The edited comment + + + + Edits a comment on a pull request review. + + http://developer.github.com/v3/pulls/comments/#edit-a-comment + The Id of the repository + The pull request review comment number + The edited comment + + + + Deletes a comment on a pull request review. + + http://developer.github.com/v3/pulls/comments/#delete-a-comment + The owner of the repository + The name of the repository + The pull request review comment number + + + + Deletes a comment on a pull request review. + + http://developer.github.com/v3/pulls/comments/#delete-a-comment + The Id of the repository + The pull request review comment number + + + + A client for GitHub's Pull Request Review Requests API. + + + See the Review Requests API documentation for more information. + + + + + Gets review requests for a specified pull request. + + https://developer.github.com/v3/pulls/review_requests/#list-review-requests + The owner of the repository + The name of the repository + The pull request number + + + + Gets review requests for a specified pull request. + + https://developer.github.com/v3/pulls/review_requests/#list-review-requests + The owner of the repository + The name of the repository + The pull request number + Options for changing the API response + + + + Gets review requests for a specified pull request. + + https://developer.github.com/v3/pulls/review_requests/#list-review-requests + The Id of the repository + The pull request number + + + + Gets review requests for a specified pull request. + + https://developer.github.com/v3/pulls/review_requests/#list-review-requests + The Id of the repository + The pull request number + Options for changing the API response + + + + Creates review requests on a pull request for specified users. + + https://developer.github.com/v3/pulls/review_requests/#create-a-review-request + The owner of the repository + The name of the repository + The Pull Request number + List of logins of user will be requested for review + + + + Creates review requests on a pull request for specified users. + + https://developer.github.com/v3/pulls/review_requests/#create-a-review-request + The Id of the repository + The Pull Request number + List of logins of user will be requested for review + + + + Deletes review request for given users on a pull request. + + https://developer.github.com/v3/pulls/review_requests/#delete-a-review-request + The owner of the repository + The name of the repository + The pull request review comment number + List of logins of users that will be not longer requested for review + + + + Deletes review request for given users on a pull request. + + https://developer.github.com/v3/pulls/review_requests/#delete-a-review-request + The Id of the repository + The pull request review comment number + List of logins of users that will be not longer requested for review + + + + A client for GitHub's Pull Request Review API. + + + See the Review API documentation for more information. + + + + + Gets reviews for a specified pull request. + + https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request + The owner of the repository + The name of the repository + The pull request number + + + + Gets reviews for a specified pull request. + + https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request + The Id of the repository + The pull request number + + + + Gets reviews for a specified pull request. + + https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request + The owner of the repository + The name of the repository + The pull request number + Options for changing the API response + + + + Gets reviews for a specified pull request. + + https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request + The Id of the repository + The pull request number + Options for changing the API response + + + + Gets a single pull request review by ID. + + https://developer.github.com/v3/pulls/reviews/#get-a-single-review + The owner of the repository + The name of the repository + The pull request number + The pull request review number + + + + Gets a single pull request review by ID. + + https://developer.github.com/v3/pulls/reviews/#get-a-single-review + The Id of the repository + The pull request number + The pull request review number + + + + Creates a pull request review. + + https://developer.github.com/v3/pulls/reviews/#create-a-pull-request-review + The owner of the repository + The name of the repository + The Pull Request number + The review + + + + Creates a pull request review. + + https://developer.github.com/v3/pulls/reviews/#create-a-pull-request-review + The Id of the repository + The Pull Request number + The review + + + + Deletes a pull request review. + + https://developer.github.com/v3/pulls/reviews/#delete-a-pending-review + The owner of the repository + The name of the repository + The pull request number + The pull request review number + + + + Deletes a pull request review. + + https://developer.github.com/v3/pulls/reviews/#delete-a-pending-review + The Id of the repository + The pull request number + The pull request review number + + + + Submits a pull request review. + + https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review + The owner of the repository + The name of the repository + The pull request number + The pull request review number + The message and event being submitted for the review + + + + Submits a pull request review. + + https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review + The Id of the repository + The pull request number + The pull request review number + The message and event being submitted for the review + + + + Dismisses a pull request review. + + https://developer.github.com/v3/pulls/reviews/#dismiss-a-pull-request-review + The owner of the repository + The name of the repository + The pull request number + The pull request review number + The message indicating why the review was dismissed + + + + Dismisses a pull request review. + + https://developer.github.com/v3/pulls/reviews/#dismiss-a-pull-request-review + The Id of the repository + The pull request number + The pull request review number + The message indicating why the review was dismissed + + + + Lists comments for a single review + + https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review + The owner of the repository + The name of the repository + The pull request number + The pull request review number + + + + Lists comments for a single review + + https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review + The Id of the repository + The pull request number + The pull request review number + + + + Lists comments for a single review + + https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review + The owner of the repository + The name of the repository + The pull request number + The pull request review number + Options for changing the API response + + + + Lists comments for a single review + + https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review + The Id of the repository + The pull request number + The pull request review number + Options for changing the API response + + + + A client for GitHub's Pull Requests API. + + + See the Pull Requests API documentation for more information. + + + + + Client for managing reviews. + + + + + Client for managing review comments. + + + + + Client for managing review requests. + + + + + Get a pull request by number. + + + http://developer.github.com/v3/pulls/#get-a-single-pull-request + + + + + Get a pull request by number. + + + http://developer.github.com/v3/pulls/#get-a-single-pull-request + + + + + Get all open pull requests for the repository. + + + http://developer.github.com/v3/pulls/#list-pull-requests + + The owner of the repository + The name of the repository + + + + Get all open pull requests for the repository. + + + http://developer.github.com/v3/pulls/#list-pull-requests + + The Id of the repository + + + + Get all open pull requests for the repository. + + + http://developer.github.com/v3/pulls/#list-pull-requests + + The owner of the repository + The name of the repository + Options for changing the API response + + + + Get all open pull requests for the repository. + + + http://developer.github.com/v3/pulls/#list-pull-requests + + The Id of the repository + Options for changing the API response + + + + Query pull requests for the repository based on criteria + + + http://developer.github.com/v3/pulls/#list-pull-requests + + The owner of the repository + The name of the repository + Used to filter and sort the list of pull requests returned + + + + Query pull requests for the repository based on criteria + + + http://developer.github.com/v3/pulls/#list-pull-requests + + The Id of the repository + Used to filter and sort the list of pull requests returned + + + + Query pull requests for the repository based on criteria + + + http://developer.github.com/v3/pulls/#list-pull-requests + + The owner of the repository + The name of the repository + Used to filter and sort the list of pull requests returned + Options for changing the API response + + + + Query pull requests for the repository based on criteria + + + http://developer.github.com/v3/pulls/#list-pull-requests + + The Id of the repository + Used to filter and sort the list of pull requests returned + Options for changing the API response + + + + Create a pull request for the specified repository. + + http://developer.github.com/v3/pulls/#create-a-pull-request + The owner of the repository + The name of the repository + A instance describing the new PullRequest to create + + + + Create a pull request for the specified repository. + + http://developer.github.com/v3/pulls/#create-a-pull-request + The Id of the repository + A instance describing the new PullRequest to create + + + + Create a pull request for the specified repository. + + http://developer.github.com/v3/pulls/#update-a-pull-request + The owner of the repository + The name of the repository + The PullRequest number + An instance describing the changes to make to the PullRequest + + + + + Create a pull request for the specified repository. + + http://developer.github.com/v3/pulls/#update-a-pull-request + The Id of the repository + The PullRequest number + An instance describing the changes to make to the PullRequest + + + + + Merge a pull request. + + http://developer.github.com/v3/pulls/#merge-a-pull-request-merge-buttontrade + The owner of the repository + The name of the repository + The pull request number + A instance describing a pull request merge + + + + Merge a pull request. + + http://developer.github.com/v3/pulls/#merge-a-pull-request-merge-buttontrade + The Id of the repository + The pull request number + A instance describing a pull request merge + + + + Get the pull request merge status. + + http://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged + The owner of the repository + The name of the repository + The pull request number + + + + Get the pull request merge status. + + http://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged + The Id of the repository + The pull request number + + + + Get the list of commits on a pull request. + + http://developer.github.com/v3/pulls/#list-commits-on-a-pull-request + The owner of the repository + The name of the repository + The pull request number + + + + Get the list of commits on a pull request. + + http://developer.github.com/v3/pulls/#list-commits-on-a-pull-request + The Id of the repository + The pull request number + + + + Get the list of files on a pull request. + + https://developer.github.com/v3/pulls/#list-pull-requests-files + The owner of the repository + The name of the repository + The pull request number + + + + Get the list of files on a pull request. + + https://developer.github.com/v3/pulls/#list-pull-requests-files + The Id of the repository + The pull request number + + + + A client for GitHub's Reactions Events API. + + + See the Reactions API documentation for more information + + + + + Access GitHub's Reactions API for Commit Comments. + + + Refer to the API documentation for more information: https://developer.github.com/v3/reactions/ + + + + + Access GitHub's Reactions API for Issues. + + + Refer to the API documentation for more information: https://developer.github.com/v3/reactions/ + + + + + Access GitHub's Reactions API for Issue Comments. + + + Refer to the API documentation for more information: https://developer.github.com/v3/reactions/ + + + + + Access GitHub's Reactions API for Issue Comments. + + + Refer to the API documentation for more information: https://developer.github.com/v3/reactions/ + + + + + Delete a reaction. + + https://developer.github.com/v3/reactions/#delete-a-reaction + The reaction id + + + + + A client for GitHub's References API. + + + See the References API documentation for more information. + + + + + Gets a reference for a given repository by reference name + + + http://developer.github.com/v3/git/refs/#get-a-reference + + The owner of the repository + The name of the repository + The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" + + + + + Gets a reference for a given repository by reference name + + + http://developer.github.com/v3/git/refs/#get-a-reference + + The Id of the repository + The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" + + + + + Gets all references for a given repository + + + http://developer.github.com/v3/git/refs/#get-all-references + + The owner of the repository + The name of the repository + + + + + Gets all references for a given repository + + + http://developer.github.com/v3/git/refs/#get-all-references + + The owner of the repository + The name of the repository + Options for changing the API response + + + + + Gets all references for a given repository + + + http://developer.github.com/v3/git/refs/#get-all-references + + The Id of the repository + + + + + Gets all references for a given repository + + + http://developer.github.com/v3/git/refs/#get-all-references + + The Id of the repository + Options for changing the API response + + + + + Gets references for a given repository by sub-namespace, i.e. "tags" or "heads" + + + http://developer.github.com/v3/git/refs/#get-all-references + + The owner of the repository + The name of the repository + The sub-namespace to get references for + + + + + Gets references for a given repository by sub-namespace, i.e. "tags" or "heads" + + + http://developer.github.com/v3/git/refs/#get-all-references + + The owner of the repository + The name of the repository + The sub-namespace to get references for + Options for changing the API response + + + + + Gets references for a given repository by sub-namespace, i.e. "tags" or "heads" + + + http://developer.github.com/v3/git/refs/#get-all-references + + The Id of the repository + The sub-namespace to get references for + + + + + Gets references for a given repository by sub-namespace, i.e. "tags" or "heads" + + + http://developer.github.com/v3/git/refs/#get-all-references + + The Id of the repository + The sub-namespace to get references for + Options for changing the API response + + + + + Creates a reference for a given repository + + + http://developer.github.com/v3/git/refs/#create-a-reference + + The owner of the repository + The name of the repository + The reference to create + + + + + Creates a reference for a given repository + + + http://developer.github.com/v3/git/refs/#create-a-reference + + The Id of the repository + The reference to create + + + + + Updates a reference for a given repository by reference name + + + http://developer.github.com/v3/git/refs/#update-a-reference + + The owner of the repository + The name of the repository + The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" + The updated reference data + + + + + Updates a reference for a given repository by reference name + + + http://developer.github.com/v3/git/refs/#update-a-reference + + The Id of the repository + The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" + The updated reference data + + + + + Deletes a reference for a given repository by reference name + + + http://developer.github.com/v3/git/refs/#delete-a-reference + + The owner of the repository + The name of the repository + The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" + + + + + Deletes a reference for a given repository by reference name + + + http://developer.github.com/v3/git/refs/#delete-a-reference + + The Id of the repository + The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" + + + + + A client for GitHub's Releases API. + + + See the Releases API documentation for more information. + + + + + Gets all s for the specified repository. + + + See the API documentation for more information. + + The repository's owner + The repository's name + Thrown when a general API error occurs. + + + + Gets all s for the specified repository. + + + See the API documentation for more information. + + The Id of the repository + Thrown when a general API error occurs. + + + + Gets all s for the specified repository. + + + See the API documentation for more information. + + The repository's owner + The repository's name + Options for changing the API response + Thrown when a general API error occurs. + + + + Gets all s for the specified repository. + + + See the API documentation for more information. + + The Id of the repository + Options for changing the API response + Thrown when a general API error occurs. + + + + Gets a single for the specified repository. + + + See the API documentation for more information. + + The repository's owner + The repository's name + The id of the release + Thrown when a general API error occurs. + + + + Gets a single for the specified repository. + + + See the API documentation for more information. + + The repository's owner + The repository's name + The tag of the release + Thrown when a general API error occurs. + + + + Gets a single for the specified repository. + + + See the API documentation for more information. + + The Id of the repository + The id of the release + Thrown when a general API error occurs. + + + + Gets a single for the specified repository. + + + See the API documentation for more information. + + The Id of the repository + The tag of the release + Thrown when a general API error occurs. + + + + Gets the latest for the specified repository. + + + See the API documentation for more information. + + The repository's owner + The repository's name + Thrown when a general API error occurs. + + + + Gets the latest for the specified repository. + + + See the API documentation for more information. + + The Id of the repository + Thrown when a general API error occurs. + + + + Creates a new for the specified repository. + + + See the API documentation for more information. + + The repository's owner + The repository's name + A description of the release to create + Thrown when a general API error occurs. + + + + Creates a new for the specified repository. + + + See the API documentation for more information. + + The Id of the repository + A description of the release to create + Thrown when a general API error occurs. + + + + Edits an existing for the specified repository. + + + See the API documentation for more information. + + The repository's owner + The repository's name + The id of the release + A description of the release to edit + Thrown when a general API error occurs. + + + + Edits an existing for the specified repository. + + + See the API documentation for more information. + + The Id of the repository + The id of the release + A description of the release to edit + Thrown when a general API error occurs. + + + + Deletes an existing for the specified repository. + + + See the API documentation for more information. + + The repository's owner + The repository's name + The id of the release to delete + Thrown when a general API error occurs. + + + + Deletes an existing for the specified repository. + + + See the API documentation for more information. + + The Id of the repository + The id of the release to delete + Thrown when a general API error occurs. + + + + Gets all for the specified release of the specified repository. + + + See the API documentation for more information. + + The repository's owner + The repository's name + The id of the . + Thrown when a general API error occurs. + + + + Gets all for the specified release of the specified repository. + + + See the API documentation for more information. + + The Id of the repository + The id of the . + Thrown when a general API error occurs. + + + + Gets all for the specified release of the specified repository. + + + See the API documentation for more information. + + The repository's owner + The repository's name + The id of the . + Options for changing the API response + Thrown when a general API error occurs. + + + + Gets all for the specified release of the specified repository. + + + See the API documentation for more information. + + The Id of the repository + The id of the . + Options for changing the API response + Thrown when a general API error occurs. + + + + Uploads a for the specified release. + + + See the API documentation for more information. + + The to attach the uploaded asset to + Description of the asset with its data + Thrown when a general API error occurs. + + + + Gets the specified for the specified release of the specified repository. + + + See the API documentation for more information. + + The repository's owner + The repository's name + The id of the + + + + Gets the specified for the specified release of the specified repository. + + + See the API documentation for more information. + + The Id of the repository + The id of the + + + + Edits the for the specified release of the specified repository. + + + See the API documentation for more information. + + The repository's owner + The repository's name + The id of the + Description of the asset with its amended data + + + + Edits the for the specified release of the specified repository. + + + See the API documentation for more information. + + The Id of the repository + The id of the + Description of the asset with its amended data + + + + Deletes the specified from the specified repository + + + See the API documentation for more information. + + The repository's owner + The repository's name + The id of the . + + + + Deletes the specified from the specified repository + + + See the API documentation for more information. + + The Id of the repository + The id of the . + + + + A client for GitHub's Collaborators on a Repository. + + + See the Collaborators API documentation for more details. + + + + + Gets all the collaborators on a repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Thrown when a general API error occurs. + + + + Gets all the collaborators on a repository. + + + See the API documentation for more information. + + The id of the repository + Thrown when a general API error occurs. + + + + Gets all the collaborators on a repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Options for changing the API response + Thrown when a general API error occurs. + + + + Gets all the collaborators on a repository. + + + See the API documentation for more information. + + The id of the repository + Options for changing the API response + Thrown when a general API error occurs. + + + + Checks if a user is a collaborator on a repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Username of the prospective collaborator + Thrown when a general API error occurs. + + + + Checks if a user is a collaborator on a repository. + + + See the API documentation for more information. + + The id of the repository + Username of the prospective collaborator + Thrown when a general API error occurs. + + + + Review a user's permission level in a repository + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Username of the collaborator to check permission for + Thrown when a general API error occurs. + + + + Review a user's permission level in a repository + + + See the API documentation for more information. + + The id of the repository + Username of the collaborator to check permission for + Thrown when a general API error occurs. + + + + Adds a new collaborator to the repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Username of the new collaborator + Thrown when a general API error occurs. + + + + Adds a new collaborator to the repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Username of the new collaborator + The permission to set. Only valid on organization-owned repositories. + Thrown when a general API error occurs. + + + + Adds a new collaborator to the repository. + + + See the API documentation for more information. + + The id of the repository + Username of the new collaborator + Thrown when a general API error occurs. + + + + Adds a new collaborator to the repository. + + + See the API documentation for more information. + + The id of the repository + Username of the new collaborator + The permission to set. Only valid on organization-owned repositories. + Thrown when a general API error occurs. + + + + Invites a new collaborator to the repo + + + See the API documentation for more information. + + The owner of the repository. + The name of the repository. + The name of the user to invite. + Thrown when a general API error occurs. + + + + Invites a new collaborator to the repo + + + See the API documentation for more information. + + The owner of the repository. + The name of the repository. + The name of the user to invite. + The permission to set. Only valid on organization-owned repositories. + Thrown when a general API error occurs. + + + + Invites a new collaborator to the repo + + + See the API documentation for more information. + + The id of the repository. + The name of the user to invite. + Thrown when a general API error occurs. + + + + Invites a new collaborator to the repo + + + See the API documentation for more information. + + The id of the repository. + The name of the user to invite. + The permission to set. Only valid on organization-owned repositories. + Thrown when a general API error occurs. + + + + Deletes a collaborator from the repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Username of the removed collaborator + Thrown when a general API error occurs. + + + + Deletes a collaborator from the repository. + + + See the API documentation for more information. + + The id of the repository + Username of the removed collaborator + Thrown when a general API error occurs. + + + + A client for GitHub's Repositories API. + + + See the Repositories API documentation for more details. + + + + + Client for managing pull requests. + + + See the Pull Requests API documentation for more details + + + + + Client for managing branches in a repository. + + + See the Branches API documentation for more details + + + + + Client for managing commit comments in a repository. + + + See the Repository Comments API documentation for more information. + + + + + Client for managing deploy keys in a repository. + + + See the Repository Deploy Keys API documentation for more information. + + + + + Client for managing the contents of a repository. + + + See the Repository Contents API documentation for more information. + + + + + Creates a new repository for the current user. + + + See the API documentation for more information. + + A instance describing the new repository to create + Thrown when a general API error occurs. + A instance for the created repository. + + + + Creates a new repository in the specified organization. + + + See the API documentation for more information. + + Login of the organization in which to create the repository + A instance describing the new repository to create + Thrown when a general API error occurs. + A instance for the created repository + + + + Deletes the specified repository. + + + See the API documentation for more information. + Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. + + The owner of the repository + The name of the repository + Thrown when a general API error occurs. + + + + Deletes the specified repository. + + + See the API documentation for more information. + Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. + + The Id of the repository + Thrown when a general API error occurs. + + + + Transfers the ownership of the specified repository. + + + See the API documentation for more information. + + The current owner of the repository + The name of the repository + Repository transfer information + A + + + + Transfers the ownership of the specified repository. + + + See the API documentation for more information. + + The id of the repository + Repository transfer information + A + + + + Gets the specified repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Thrown when a general API error occurs. + A + + + + Gets the specified repository. + + + See the API documentation for more information. + + The Id of the repository + Thrown when a general API error occurs. + A + + + + Gets all public repositories. + + + See the API documentation for more information. + The default page size on GitHub.com is 30. + + Thrown if the client is not authenticated. + Thrown when a general API error occurs. + A of . + + + + Gets all public repositories since the integer Id of the last Repository that you've seen. + + + See the API documentation for more information. + The default page size on GitHub.com is 30. + + Search parameters of the last repository seen + Thrown if the client is not authenticated. + Thrown when a general API error occurs. + A of . + + + + Gets all repositories owned by the current user. + + + See the API documentation for more information. + The default page size on GitHub.com is 30. + + Thrown if the client is not authenticated. + Thrown when a general API error occurs. + A of . + + + + Gets all repositories owned by the current user. + + + See the API documentation for more information. + + Options for changing the API response + Thrown if the client is not authenticated. + Thrown when a general API error occurs. + A of . + + + + Gets all repositories owned by the current user. + + + See the API documentation for more information. + The default page size on GitHub.com is 30. + + Search parameters to filter results on + Thrown if the client is not authenticated. + Thrown when a general API error occurs. + A of . + + + + Gets all repositories owned by the current user. + + + See the API documentation for more information. + + Search parameters to filter results on + Options for changing the API response + Thrown if the client is not authenticated. + Thrown when a general API error occurs. + A of . + + + + Gets all repositories owned by the specified user. + + + See the API documentation for more information. + The default page size on GitHub.com is 30. + + The account name to search for + Thrown when a general API error occurs. + A of . + + + + Gets all repositories owned by the specified user. + + + See the API documentation for more information. + + The account name to search for + Options for changing the API response + Thrown when a general API error occurs. + A of . + + + + Gets all repositories owned by the specified organization. + + + See the API documentation for more information. + The default page size on GitHub.com is 30. + + The organization name to search for + Thrown when a general API error occurs. + A of . + + + + Gets all repositories owned by the specified organization. + + + See the API documentation for more information. + + The organization name to search for + Options for changing the API response + Thrown when a general API error occurs. + A of . + + + + A client for GitHub's Commit Status API. + + + See the Commit Status API documentation for more + details. Also check out the blog post + that announced this feature. + + + + + A client for GitHub's Repository Hooks API. + + See Hooks API documentation for more information. + + + + A client for GitHub's Repository Forks API. + + See Forks API documentation for more information. + + + + A client for GitHub's Repo Collaborators. + + + See the Collaborators API documentation for more details + + + + + Client for GitHub's Repository Deployments API + + + See the Deployments API documentation for more details + + + + + Client for GitHub's Repository Statistics API + + + See the Statistics API documentation for more details + + + + + Client for GitHub's Repository Commits API + + + See the Commits API documentation for more details + + + + + Access GitHub's Releases API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/repos/releases/ + + + + + Client for GitHub's Repository Merging API + + + See the Merging API documentation for more details + + + + + Gets all contributors for the specified repository. Does not include anonymous contributors. + + + See the API documentation for more details + + The owner of the repository + The name of the repository + All contributors of the repository. + + + + Gets all contributors for the specified repository. Does not include anonymous contributors. + + + See the API documentation for more details + + The Id of the repository + All contributors of the repository. + + + + Gets all contributors for the specified repository. Does not include anonymous contributors. + + + See the API documentation for more details + + The owner of the repository + The name of the repository + Options for changing the API response + All contributors of the repository. + + + + Gets all contributors for the specified repository. Does not include anonymous contributors. + + + See the API documentation for more details + + The Id of the repository + Options for changing the API response + All contributors of the repository. + + + + Gets all contributors for the specified repository. With the option to include anonymous contributors. + + + See the API documentation for more details + + The owner of the repository + The name of the repository + True if anonymous contributors should be included in result; Otherwise false + All contributors of the repository. + + + + Gets all contributors for the specified repository. With the option to include anonymous contributors. + + + See the API documentation for more details + + The Id of the repository + True if anonymous contributors should be included in result; Otherwise false + All contributors of the repository. + + + + Gets all contributors for the specified repository. With the option to include anonymous contributors. + + + See the API documentation for more details + + The owner of the repository + The name of the repository + True if anonymous contributors should be included in result; Otherwise false + Options for changing the API response + All contributors of the repository. + + + + Gets all contributors for the specified repository. With the option to include anonymous contributors. + + + See the API documentation for more details + + The Id of the repository + True if anonymous contributors should be included in result; Otherwise false + Options for changing the API response + All contributors of the repository. + + + + Gets all languages for the specified repository. + + + See the API documentation for more details + + The owner of the repository + The name of the repository + All languages used in the repository and the number of bytes of each language. + + + + Gets all languages for the specified repository. + + + See the API documentation for more details + + The Id of the repository + All languages used in the repository and the number of bytes of each language. + + + + Gets all teams for the specified repository. + + + See the API documentation for more details + + The owner of the repository + The name of the repository + All s associated with the repository + + + + Gets all teams for the specified repository. + + + See the API documentation for more details + + The Id of the repository + All s associated with the repository + + + + Gets all teams for the specified repository. + + + See the API documentation for more details + + The owner of the repository + The name of the repository + Options for changing the API response + All s associated with the repository + + + + Gets all teams for the specified repository. + + + See the API documentation for more details + + The Id of the repository + Options for changing the API response + All s associated with the repository + + + + Gets all tags for the specified repository. + + + See the API documentation for more details + + The owner of the repository + The name of the repository + All of the repositories tags. + + + + Gets all tags for the specified repository. + + + See the API documentation for more details + + The Id of the repository + All of the repositories tags. + + + + Gets all tags for the specified repository. + + + See the API documentation for more details + + The owner of the repository + The name of the repository + Options for changing the API response + All of the repositories tags. + + + + Gets all tags for the specified repository. + + + See the API documentation for more details + + The Id of the repository + Options for changing the API response + All of the repositories tags. + + + + Get the contents of a repository's license + + + See the API documentation for more details + + The owner of the repository + The name of the repository + Returns the contents of the repository's license file, if one is detected. + + + + Get the contents of a repository's license + + + See the API documentation for more details + + The Id of the repository + Returns the contents of the repository's license file, if one is detected. + + + + Updates the specified repository with the values given in + + The owner of the repository + The name of the repository + New values to update the repository with + The updated + + + + Updates the specified repository with the values given in + + The Id of the repository + New values to update the repository with + The updated + + + + A client for GitHub's Repository Pages API. + + + See the Repository Pages API documentation for more information. + + + + + A client for GitHub's Repository Invitations API. + + + See the Repository Invitations API documentation for more information. + + + + + Access GitHub's Repository Traffic API + + + Refer to the API documentation for more information: https://developer.github.com/v3/repos/traffic/ + + + + + Access GitHub's Repository Projects API + + + Refer to the API documentation for more information: https://developer.github.com/v3/repos/projects/ + + + + + A client for GitHub's Repository Branches API. + + + See the Repository Branches API documentation for more details. + + + + + Gets all the branches for the specified repository. + + + See the API documentation for more details + + The owner of the repository + The name of the repository + + + + Gets all the branches for the specified repository. + + + See the API documentation for more details + + The ID of the repository + + + + Gets all the branches for the specified repository. + + + See the API documentation for more details + + The owner of the repository + The name of the repository + Options for changing the API response + + + + Gets all the branches for the specified repository. + + + See the API documentation for more details + + The ID of the repository + Options for changing the API response + + + + Gets the specified branch. + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Gets the specified branch. + + + See the API documentation for more details + + The ID of the repository + The name of the branch + + + + Get the branch protection settings for the specified branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Get the branch protection settings for the specified branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Update the branch protection settings for the specified branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + Branch protection settings + + + + Update the branch protection settings for the specified branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + Branch protection settings + + + + Remove the branch protection settings for the specified branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Remove the branch protection settings for the specified branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Get the required status checks for the specified branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Get the required status checks for the specified branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Replace required status checks for the specified branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + Required status checks + + + + Replace required status checks for the specified branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + Required status checks + + + + Remove required status checks for the specified branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Remove required status checks for the specified branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Get the required status checks contexts for the specified branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Get the required status checks contexts for the specified branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Replace the required status checks contexts for the specified branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + The contexts to replace + + + + Replace the required status checks contexts for the specified branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + The contexts to replace + + + + Add the required status checks context for the specified branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + The contexts to add + + + + Add the required status checks contexts for the specified branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + The contexts to add + + + + Remove the required status checks contexts for the specified branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + The contexts to remove + + + + Remove the required status checks contexts for the specified branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + The contexts to remove + + + + Get required pull request review enforcement of protected branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Get required pull request review enforcement of protected branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Update required pull request review enforcement of protected branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + The required pull request review settings + + + + Update required pull request review enforcement of protected branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + The required pull request review settings + + + + Remove required pull request review enforcement of protected branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Remove required pull request review enforcement of protected branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Get admin enforcement of protected branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Get admin enforcement of protected branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Add admin enforcement to protected branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Add admin enforcement to protected branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Remove admin enforcement on protected branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Remove admin enforcement on protected branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Get restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Get restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Remove restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Remove restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Get team restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Get team restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Replace team restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + List of teams with push access + + + + Replace team restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The Id of the repository + The name of the branch + List of teams with push access to add + + + + Add team restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + List of teams with push access to add + + + + Add team restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The Id of the repository + The name of the branch + List of teams with push access + + + + Remove team restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + List of teams to remove + + + + Remove team restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The Id of the repository + The name of the branch + List of teams to remove + + + + Get user restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Get user restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Replace user restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + List of users with push access + + + + Replace user restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The Id of the repository + The name of the branch + List of users with push access + + + + Add user restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + List of users with push access to add + + + + Add user restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The Id of the repository + The name of the branch + List of users with push access to add + + + + Remove user restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + List of users with push access to remove + + + + Remove user restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The Id of the repository + The name of the branch + List of users with push access to remove + + + + A client for GitHub's Repository Comments API. + + + See the Repository Comments API documentation for more information. + + + + + Gets a single Repository Comment by number. + + http://developer.github.com/v3/repos/comments/#get-a-single-commit-comment + The owner of the repository + The name of the repository + The comment id + + + + Gets a single Repository Comment by number. + + http://developer.github.com/v3/repos/comments/#get-a-single-commit-comment + The Id of the repository + The comment id + + + + Gets Commit Comments for a repository. + + http://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository + The owner of the repository + The name of the repository + + + + Gets Commit Comments for a repository. + + http://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository + The Id of the repository + + + + Gets Commit Comments for a repository. + + http://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository + The owner of the repository + The name of the repository + Options to change the API response + + + + Gets Commit Comments for a repository. + + http://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository + The Id of the repository + Options to change the API response + + + + Gets Commit Comments for a specified Commit. + + http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit + The owner of the repository + The name of the repository + The sha of the commit + + + + Gets Commit Comments for a specified Commit. + + http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit + The Id of the repository + The sha of the commit + + + + Gets Commit Comments for a specified Commit. + + http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit + The owner of the repository + The name of the repository + The sha of the commit + Options to change the API response + + + + Gets Commit Comments for a specified Commit. + + http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit + The Id of the repository + The sha of the commit + Options to change the API response + + + + Creates a new Commit Comment for a specified Commit. + + http://developer.github.com/v3/repos/comments/#create-a-commit-comment + The owner of the repository + The name of the repository + The sha reference of commit + The new comment to add to the commit + + + + Creates a new Commit Comment for a specified Commit. + + http://developer.github.com/v3/repos/comments/#create-a-commit-comment + The Id of the repository + The sha reference of commit + The new comment to add to the commit + + + + Updates a specified Commit Comment. + + http://developer.github.com/v3/repos/comments/#update-a-commit-comment + The owner of the repository + The name of the repository + The comment number + The modified comment + + + + Updates a specified Commit Comment. + + http://developer.github.com/v3/repos/comments/#update-a-commit-comment + The Id of the repository + The comment number + The modified comment + + + + Deletes the specified Commit Comment + + http://developer.github.com/v3/repos/comments/#delete-a-commit-comment + The owner of the repository + The name of the repository + The comment id + + + + Deletes the specified Commit Comment + + http://developer.github.com/v3/repos/comments/#delete-a-commit-comment + The Id of the repository + The comment id + + + + A client for GitHub's Repository Commits API. + + + See the Repository Commits API documentation for more information. + + + + + Compare two references in a repository + + The owner of the repository + The name of the repository + The reference to use as the base commit + The reference to use as the head commit + + + + Compare two references in a repository + + The Id of the repository + The reference to use as the base commit + The reference to use as the head commit + + + + Gets a single commit for a given repository + + The owner of the repository + The name of the repository + The reference for the commit (SHA) + + + + Gets a single commit for a given repository + + The Id of the repository + The reference for the commit (SHA) + + + + Gets all commits for a given repository + + The owner of the repository + The name of the repository + + + + Gets all commits for a given repository + + The Id of the repository + + + + Gets all commits for a given repository + + The owner of the repository + The name of the repository + Options for changing the API response + + + + Gets all commits for a given repository + + The Id of the repository + Options for changing the API response + + + + Gets all commits for a given repository + + The owner of the repository + The name of the repository + Used to filter list of commits returned + + + + Gets all commits for a given repository + + The Id of the repository + Used to filter list of commits returned + + + + Gets all commits for a given repository + + The owner of the repository + The name of the repository + Used to filter list of commits returned + Options for changing the API response + + + + Gets all commits for a given repository + + The Id of the repository + Used to filter list of commits returned + Options for changing the API response + + + + Get the SHA-1 of a commit reference + + The owner of the repository + The name of the repository + The repository reference + + + + Get the SHA-1 of a commit reference + + The Id of the repository + The repository reference + + + + Client for accessing contents of files within a repository as base64 encoded content. + + + See the Repository Contents API documentation for more information. + + + + + Returns the contents of a file or directory in a repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The content path + + + + Returns the contents of a file or directory in a repository. + + + See the API documentation for more information. + + The Id of the repository + The content path + + + + Returns the contents of the root directory in a repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + + + + Returns the contents of the root directory in a repository. + + + See the API documentation for more information. + + The Id of the repository + + + + Returns the contents of a file or directory in a repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The content path + The name of the commit/branch/tag. Default: the repository’s default branch (usually master) + + + + Returns the contents of a file or directory in a repository. + + + See the API documentation for more information. + + The Id of the repository + The content path + The name of the commit/branch/tag. Default: the repository’s default branch (usually master) + + + + Returns the contents of the root directory in a repository. + + + If given a path to a single file, this method returns a collection containing only that file. + See the API documentation for more information. + + The owner of the repository + The name of the repository + The name of the commit/branch/tag. Default: the repository’s default branch (usually master) + + + + Returns the contents of the root directory in a repository. + + + If given a path to a single file, this method returns a collection containing only that file. + See the API documentation for more information. + + The Id of the repository + The name of the commit/branch/tag. Default: the repository’s default branch (usually master) + + + + Gets the preferred README for the specified repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Thrown when a general API error occurs. + + + + Gets the preferred README for the specified repository. + + + See the API documentation for more information. + + The Id of the repository + Thrown when a general API error occurs. + + + + Gets the preferred README's HTML for the specified repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Thrown when a general API error occurs. + + + + Gets the preferred README's HTML for the specified repository. + + + See the API documentation for more information. + + The Id of the repository + Thrown when a general API error occurs. + + + + Get an archive of a given repository's contents + + https://developer.github.com/v3/repos/contents/#get-archive-link + The owner of the repository + The name of the repository + + + + Get an archive of a given repository's contents + + https://developer.github.com/v3/repos/contents/#get-archive-link + The Id of the repository + + + + Get an archive of a given repository's contents, in a specific format + + https://developer.github.com/v3/repos/contents/#get-archive-link + The owner of the repository + The name of the repository + The format of the archive. Can be either tarball or zipball + + + + Get an archive of a given repository's contents, in a specific format + + https://developer.github.com/v3/repos/contents/#get-archive-link + The Id of the repository + The format of the archive. Can be either tarball or zipball + + + + Get an archive of a given repository's contents, using a specific format and reference + + https://developer.github.com/v3/repos/contents/#get-archive-link + The owner of the repository + The name of the repository + The format of the archive. Can be either tarball or zipball + A valid Git reference. + + + + Get an archive of a given repository's contents, using a specific format and reference + + https://developer.github.com/v3/repos/contents/#get-archive-link + The Id of the repository + The format of the archive. Can be either tarball or zipball + A valid Git reference. + + + + Get an archive of a given repository's contents, in a specific format + + https://developer.github.com/v3/repos/contents/#get-archive-link + The owner of the repository + The name of the repository + The format of the archive. Can be either tarball or zipball + A valid Git reference. + Time span until timeout + + + + Get an archive of a given repository's contents, in a specific format + + https://developer.github.com/v3/repos/contents/#get-archive-link + The Id of the repository + The format of the archive. Can be either tarball or zipball + A valid Git reference. + Time span until timeout + + + + Creates a commit that creates a new file in a repository. + + The owner of the repository + The name of the repository + The path to the file + Information about the file to create + + + + Creates a commit that creates a new file in a repository. + + The Id of the repository + The path to the file + Information about the file to create + + + + Creates a commit that updates the contents of a file in a repository. + + The owner of the repository + The name of the repository + The path to the file + Information about the file to update + + + + Creates a commit that updates the contents of a file in a repository. + + The Id of the repository + The path to the file + Information about the file to update + + + + Creates a commit that deletes a file in a repository. + + The owner of the repository + The name of the repository + The path to the file + Information about the file to delete + + + + Creates a commit that deletes a file in a repository. + + The Id of the repository + The path to the file + Information about the file to delete + + + + The archive format to return from the server + + + + + The TAR archive format + + + + + The ZIP archive format + + + + + A client for GitHub's Repository Deploy Keys API. + + + See the Deploy Keys API documentation for more information. + + + + + Get a single deploy key by number for a repository. + + + See the API documentation for more information. + + The owner of the repository. + The name of the repository. + The id of the deploy key. + + + + Get a single deploy key by number for a repository. + + + See the API documentation for more information. + + The Id of the repository. + The id of the deploy key. + + + + Get all deploy keys for a repository. + + + See the API documentation for more information. + + The owner of the repository. + The name of the repository. + + + + Get all deploy keys for a repository. + + + See the API documentation for more information. + + The Id of the repository. + + + + Get all deploy keys for a repository. + + + See the API documentation for more information. + + The owner of the repository. + The name of the repository. + Options for changing the API response + + + + Get all deploy keys for a repository. + + + See the API documentation for more information. + + The Id of the repository. + Options for changing the API response + + + + Creates a new deploy key for a repository. + + + See the API documentation for more information. + + The owner of the repository. + The name of the repository. + The deploy key to create for the repository. + + + + Creates a new deploy key for a repository. + + + See the API documentation for more information. + + The Id of the repository. + The deploy key to create for the repository. + + + + Deletes a deploy key from a repository. + + + See the API documentation for more information. + + The owner of the repository. + The name of the repository. + The id of the deploy key to delete. + + + + Deletes a deploy key from a repository. + + + See the API documentation for more information. + + The Id of the repository. + The id of the deploy key to delete. + + + + A client for GitHub's Repository Forks API. + + + See the Forks API documentation for more information. + + + + + Gets the list of forks defined for a repository + + + See API documentation for more information. + + The owner of the repository + The name of the repository + + + + Gets the list of forks defined for a repository + + + See API documentation for more information. + + The Id of the repository + + + + Gets the list of forks defined for a repository + + + See API documentation for more information. + + The owner of the repository + The name of the repository + Options for changing the API response + + + + Gets the list of forks defined for a repository + + + See API documentation for more information. + + The Id of the repository + Options for changing the API response + + + + Gets the list of forks defined for a repository + + + See API documentation for more information. + + The owner of the repository + The name of the repository + Used to request and filter a list of repository forks + + + + Gets the list of forks defined for a repository + + + See API documentation for more information. + + The Id of the repository + Used to request and filter a list of repository forks + + + + Gets the list of forks defined for a repository + + + See API documentation for more information. + + The owner of the repository + The name of the repository + Used to request and filter a list of repository forks + Options for changing the API response + + + + Gets the list of forks defined for a repository + + + See API documentation for more information. + + The Id of the repository + Used to request and filter a list of repository forks + Options for changing the API response + + + + Creates a fork for a repository. Specify organization in the fork parameter to create for an organization. + + + See API documentation for more information. + + The owner of the repository + The name of the repository + Used to fork a repository + + + + Creates a fork for a repository. Specify organization in the fork parameter to create for an organization. + + + See API documentation for more information. + + The Id of the repository + Used to fork a repository + + + + A client for GitHub's Repository Webhooks API. + + + See the Webhooks API documentation for more information. + + + + + Gets the list of hooks defined for a repository + + The repository's owner + The repository's name + See API documentation for more information. + + + + Gets the list of hooks defined for a repository + + The Id of the repository + See API documentation for more information. + + + + Gets the list of hooks defined for a repository + + The repository's owner + The repository's name + Options for changing the API response + See API documentation for more information. + + + + Gets the list of hooks defined for a repository + + The Id of the repository + Options for changing the API response + See API documentation for more information. + + + + Gets a single hook by Id + + The repository's owner + The repository's name + The repository's hook id + See API documentation for more information. + + + + Gets a single hook by Id + + The Id of the repository + The repository's hook id + See API documentation for more information. + + + + Creates a hook for a repository + + The repository's owner + The repository's name + The hook's parameters + See API documentation for more information. + + + + Creates a hook for a repository + + The Id of the repository + The hook's parameters + See API documentation for more information. + + + + Edits a hook for a repository + + The repository's owner + The repository's name + The repository's hook id + The requested changes to an edit repository hook + See API documentation for more information. + + + + Edits a hook for a repository + + The Id of the repository + The repository's hook id + The requested changes to an edit repository hook + See API documentation for more information. + + + + Tests a hook for a repository + + The repository's owner + The repository's name + The repository's hook id + See API documentation for more information. + This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook + is not subscribed to push events, the server will respond with 204 but no test POST will be generated. + + + + Tests a hook for a repository + + The Id of the repository + The repository's hook id + See API documentation for more information. + This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook + is not subscribed to push events, the server will respond with 204 but no test POST will be generated. + + + + This will trigger a ping event to be sent to the hook. + + The repository's owner + The repository's name + The repository's hook id + See API documentation for more information. + + + + This will trigger a ping event to be sent to the hook. + + The Id of the repository + The repository's hook id + See API documentation for more information. + + + + Deletes a hook for a repository + + The repository's owner + The repository's name + The repository's hook id + See API documentation for more information. + + + + Deletes a hook for a repository + + The Id of the repository + The repository's hook id + See API documentation for more information. + + + + A client for GitHub's Invitations on a Repository. + + + See the Invitations API documentation for more details. + + + + + Accept a repository invitation. + + + See the API documentation for more information. + + The id of the invitation + Thrown when a general API error occurs. + + + + Decline a repository invitation. + + + See the API documentation for more information. + + The id of the invitation + Thrown when a general API error occurs. + + + + Deletes a repository invitation. + + + See the API documentation for more information. + + The id of the repository + The id of the invitation + Thrown when a general API error occurs. + + + + Gets all invitations for the current user. + + + See the API documentation for more information. + + Thrown when a general API error occurs. + + + + Gets all invitations for the current user. + + + See the API documentation for more information. + + Options for changing the API response + Thrown when a general API error occurs. + + + + Gets all the invitations on a repository. + + + See the API documentation for more information. + + The id of the repository + Thrown when a general API error occurs. + + + + Gets all the invitations on a repository. + + + See the API documentation for more information. + + The id of the repository + Options for changing the API response + Thrown when a general API error occurs. + + + + Updates a repository invitation. + + + See the API documentation for more information. + + The id of the repository + The id of the invitation + The permission for the collsborator + Thrown when a general API error occurs. + + + + A client for GitHub's Repository Pages API. + + + See the Repository Pages API documentation for more information. + + + + + Gets the page metadata for a given repository + + The owner of the repository + The name of the repository + + See the API documentation for more information. + + + + + Gets the page metadata for a given repository + + The Id of the repository + + See the API documentation for more information. + + + + + Gets all build metadata for a given repository + + The owner of the repository + The name of the repository + + See the API documentation for more information. + + + + + Gets all build metadata for a given repository + + The Id of the repository + + See the API documentation for more information. + + + + + Gets all build metadata for a given repository + + The owner of the repository + The name of the repository + Options to change the API response + + See the API documentation for more information. + + + + + Gets all build metadata for a given repository + + The Id of the repository + Options to change the API response + + See the API documentation for more information. + + + + + Gets the build metadata for the last build for a given repository + + The owner of the repository + The name of the repository + + See the API documentation for more information. + + + + + Gets the build metadata for the last build for a given repository + + The Id of the repository + + See the API documentation for more information. + + + + + Requests your site be built from the latest revision on the default branch for a given repository + + The owner of the repository + The name of the repository + + See the API documentation for more information. + + + + + Requests your site be built from the latest revision on the default branch for a given repository + + The Id of the repository + + See the API documentation for more information. + + + + + A client for GitHub's Repository Traffic API. + + + See the Repository Traffic API documentation for more information. + + + + + List the top 10 referrers over the last 14 days + + https://developer.github.com/v3/repos/traffic/#list-referrers + The owner of the repository + + + + List the top 10 popular contents over the last 14 days + + https://developer.github.com/v3/repos/traffic/#list-paths + The owner of the repository + The name of the repository + + + + List the top 10 popular contents over the last 14 days + + https://developer.github.com/v3/repos/traffic/#list-paths + The owner of the repository + + + + Get the total number of views and breakdown per day or week for the last 14 days + + https://developer.github.com/v3/repos/traffic/#views + The owner of the repository + The name of the repository + Breakdown per day or week + + + + Get the total number of views and breakdown per day or week for the last 14 days + + https://developer.github.com/v3/repos/traffic/#views + The owner of the repository + Breakdown per day or week + + + + Get the total number of clones and breakdown per day or week for the last 14 days + + https://developer.github.com/v3/repos/traffic/#clones + The owner of the repository + The name of the repository + Breakdown per day or week + + + + Get the total number of clones and breakdown per day or week for the last 14 days + + https://developer.github.com/v3/repos/traffic/#clones + The owner of the repository + Breakdown per day or week + + + + A client for GitHub's Search API. + + + See the Search API documentation for more information. + + + + + search repos + http://developer.github.com/v3/search/#search-repositories + + + List of repos + + + + search users + http://developer.github.com/v3/search/#search-users + + + List of users + + + + search issues + http://developer.github.com/v3/search/#search-issues + + + List of issues + + + + search code + http://developer.github.com/v3/search/#search-code + + + List of files + + + + search labels + https://developer.github.com/v3/search/#search-labels + + + List of labels + + + + A client for GitHub's Reactions API. + + + See the Reactions API documentation for more information. + + + + + Creates a reaction for a specified Issue Comment + + https://developer.github.com/v3/reactions/#create-reactions-for-an-issue-comment + The owner of the repository + The name of the repository + The comment id + The reaction to create + + + + Creates a reaction for a specified Issue Comment + + https://developer.github.com/v3/reactions/#create-reaction-for-an-issue-comment + The Id of the repository + The comment id + The reaction to create + + + + Get all reactions for a specified Issue Comment + + https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment + The owner of the repository + The name of the repository + The comment id + + + + Get all reactions for a specified Issue Comment + + https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment + The Id of the repository + The comment id + + + + A client for GitHub's Issue Comments API. + + + See the Issue Comments API documentation for more information. + + + + + Instantiates a new GitHub Issue Comments API client. + + An API connection + + + + Gets a single Issue Comment by id. + + http://developer.github.com/v3/issues/comments/#get-a-single-comment + The owner of the repository + The name of the repository + The issue comment id + + + + Gets a single Issue Comment by id. + + http://developer.github.com/v3/issues/comments/#get-a-single-comment + The Id of the repository + The issue comment id + + + + Gets Issue Comments for a repository. + + http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository + The owner of the repository + The name of the repository + + + + Gets Issue Comments for a repository. + + http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository + The Id of the repository + + + + Gets Issue Comments for a repository. + + http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository + The owner of the repository + The name of the repository + Options for changing the API response + + + + Gets Issue Comments for a repository. + + http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository + The Id of the repository + Options for changing the API response + + + + Gets Issue Comments for a repository. + + http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository + The owner of the repository + The name of the repository + The sorting parameters + + + + Gets Issue Comments for a repository. + + http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository + The Id of the repository + The sorting parameters + + + + Gets Issue Comments for a repository. + + http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository + The owner of the repository + The name of the repository + The sorting parameters + Options for changing the API response + + + + Gets Issue Comments for a repository. + + http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository + The Id of the repository + The sorting parameters + Options for changing the API response + + + + Gets Issue Comments for a specified Issue. + + http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue + The owner of the repository + The name of the repository + The issue number + + + + Gets Issue Comments for a specified Issue. + + http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue + The Id of the repository + The issue number + + + + Gets Issue Comments for a specified Issue. + + http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue + The owner of the repository + The name of the repository + The issue number + Options for changing the API response + + + + Gets Issue Comments for a specified Issue. + + http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue + The Id of the repository + The issue number + Options for changing the API response + + + + Creates a new Issue Comment for a specified Issue. + + http://developer.github.com/v3/issues/comments/#create-a-comment + The owner of the repository + The name of the repository + The number of the issue + The new comment to add to the issue + + + + Creates a new Issue Comment for a specified Issue. + + http://developer.github.com/v3/issues/comments/#create-a-comment + The Id of the repository + The number of the issue + The new comment to add to the issue + + + + Updates a specified Issue Comment. + + http://developer.github.com/v3/issues/comments/#edit-a-comment + The owner of the repository + The name of the repository + The comment id + The modified comment + + + + Updates a specified Issue Comment. + + http://developer.github.com/v3/issues/comments/#edit-a-comment + The Id of the repository + The comment id + The modified comment + + + + Deletes the specified Issue Comment + + http://developer.github.com/v3/issues/comments/#delete-a-comment + The owner of the repository + The name of the repository + The comment id + + + + Deletes the specified Issue Comment + + http://developer.github.com/v3/issues/comments/#delete-a-comment + The Id of the repository + The comment id + + + + A client for GitHub's Reactions API. + + + See the Reactions API documentation for more information. + + + + + Get all reactions for a specified Issue + + https://developer.github.com/v3/reactions/#list-reactions-for-an-issue + The owner of the repository + The name of the repository + The issue id + + + + Get all reactions for a specified Issue + + https://developer.github.com/v3/reactions/#list-reactions-for-an-issue + The Id of the repository + The issue id + + + + Creates a reaction for a specified Issue + + https://developer.github.com/v3/reactions/#create-reaction-for-an-issue + The owner of the repository + The name of the repository + The issue id + The reaction to create + + + + Creates a reaction for a specified Issue + + https://developer.github.com/v3/reactions/#create-reaction-for-an-issue + The Id of the repository + The issue id + The reaction to create + + + + A client for GitHub's Issues API. + + + See the Issues API documentation for more information. + + + + + Instantiates a new GitHub Issues API client. + + An API connection + + + + Client for managing assignees. + + + + + Client for reading various event information associated with issues/pull requests. + This is useful both for display on issue/pull request information pages and also to + determine who should be notified of comments. + + + + + Client for managing labels. + + + + + Client for managing milestones. + + + + + Client for managing comments. + + + + + Client for reading the timeline of events for an issue + + + + + Gets a single Issue by number. + + + http://developer.github.com/v3/issues/#get-a-single-issue + + The owner of the repository + The name of the repository + The issue number + + + + Gets a single Issue by number. + + + http://developer.github.com/v3/issues/#get-a-single-issue + + The Id of the repository + The issue number + + + + Gets all open issues assigned to the authenticated user across all the authenticated user’s visible + repositories including owned repositories, member repositories, and organization repositories. + + + Issues are sorted by the create date descending. + http://developer.github.com/v3/issues/#list-issues + + + + + Gets all open issues assigned to the authenticated user across all the authenticated user’s visible + repositories including owned repositories, member repositories, and organization repositories. + + Options for changing the API response + + Issues are sorted by the create date descending. + http://developer.github.com/v3/issues/#list-issues + + + + + Gets all issues across all the authenticated user’s visible repositories including owned repositories, + member repositories, and organization repositories. + + + http://developer.github.com/v3/issues/#list-issues + + Used to filter and sort the list of issues returned + + + + Gets all issues across all the authenticated user’s visible repositories including owned repositories, + member repositories, and organization repositories. + + + http://developer.github.com/v3/issues/#list-issues + + Used to filter and sort the list of issues returned + Options for changing the API response + + + + Gets all open issues assigned to the authenticated user across owned and member repositories for the + authenticated user. + + + Issues are sorted by the create date descending. + http://developer.github.com/v3/issues/#list-issues + + + + + Gets all open issues assigned to the authenticated user across owned and member repositories for the + authenticated user. + + Options for changing the API response + + Issues are sorted by the create date descending. + http://developer.github.com/v3/issues/#list-issues + + + + + Gets all issues across owned and member repositories for the authenticated user. + + + http://developer.github.com/v3/issues/#list-issues + + Used to filter and sort the list of issues returned + + + + Gets all issues across owned and member repositories for the authenticated user. + + + http://developer.github.com/v3/issues/#list-issues + + Used to filter and sort the list of issues returned + Options for changing the API response + + + + Gets all open issues assigned to the authenticated user for a given organization for the authenticated user. + + + http://developer.github.com/v3/issues/#list-issues + + The name of the organization + + + + Gets all open issues assigned to the authenticated user for a given organization for the authenticated user. + + + http://developer.github.com/v3/issues/#list-issues + + The name of the organization + Options for changing the API response + + + + Gets all issues for a given organization for the authenticated user. + + + http://developer.github.com/v3/issues/#list-issues + + The name of the organization + Used to filter and sort the list of issues returned + + + + Gets all issues for a given organization for the authenticated user. + + + http://developer.github.com/v3/issues/#list-issues + + The name of the organization + Used to filter and sort the list of issues returned + Options for changing the API response + + + + Gets all open issues assigned to the authenticated user for the repository. + + + http://developer.github.com/v3/issues/#list-issues-for-a-repository + + The owner of the repository + The name of the repository + + + + Gets all open issues assigned to the authenticated user for the repository. + + + http://developer.github.com/v3/issues/#list-issues-for-a-repository + + The Id of the repository + + + + Gets all open issues assigned to the authenticated user for the repository. + + + http://developer.github.com/v3/issues/#list-issues-for-a-repository + + The owner of the repository + The name of the repository + Options for changing the API response + + + + Gets all open issues assigned to the authenticated user for the repository. + + + http://developer.github.com/v3/issues/#list-issues-for-a-repository + + The Id of the repository + Options for changing the API response + + + + Gets issues for a repository. + + + http://developer.github.com/v3/issues/#list-issues-for-a-repository + + The owner of the repository + The name of the repository + Used to filter and sort the list of issues returned + + + + Gets issues for a repository. + + + http://developer.github.com/v3/issues/#list-issues-for-a-repository + + The Id of the repository + Used to filter and sort the list of issues returned + + + + Gets issues for a repository. + + + http://developer.github.com/v3/issues/#list-issues-for-a-repository + + The owner of the repository + The name of the repository + Used to filter and sort the list of issues returned + Options for changing the API response + + + + Gets issues for a repository. + + + http://developer.github.com/v3/issues/#list-issues-for-a-repository + + The Id of the repository + Used to filter and sort the list of issues returned + Options for changing the API response + + + + Creates an issue for the specified repository. Any user with pull access to a repository can create an + issue. + + http://developer.github.com/v3/issues/#create-an-issue + The owner of the repository + The name of the repository + A instance describing the new issue to create + + + + Creates an issue for the specified repository. Any user with pull access to a repository can create an + issue. + + http://developer.github.com/v3/issues/#create-an-issue + The Id of the repository + A instance describing the new issue to create + + + + Updates an issue for the specified repository. Issue owners and users with push access can edit an issue. + + https://developer.github.com/v3/issues/#edit-an-issue + The owner of the repository + The name of the repository + The issue number + An instance describing the changes to make to the issue + + + + + Updates an issue for the specified repository. Any user with pull access to a repository can update an + issue. + + http://developer.github.com/v3/issues/#edit-an-issue + The Id of the repository + The issue number + An instance describing the changes to make to the issue + + + + + Locks an issue for the specified repository. Issue owners and users with push access can lock an issue. + + https://developer.github.com/v3/issues/#lock-an-issue + The owner of the repository + The name of the repository + The issue number + + + + Locks an issue for the specified repository. Issue owners and users with push access can lock an issue. + + https://developer.github.com/v3/issues/#lock-an-issue + The Id of the repository + The issue number + + + + Unlocks an issue for the specified repository. Issue owners and users with push access can unlock an issue. + + https://developer.github.com/v3/issues/#unlock-an-issue + The owner of the repository + The name of the repository + The issue number + + + + Unlocks an issue for the specified repository. Issue owners and users with push access can unlock an issue. + + https://developer.github.com/v3/issues/#unlock-an-issue + The Id of the repository + The issue number + + + + A client for GitHub's Issue Events API. + + + See the Issue Events API documentation for more information. + + + + + Gets all events for the issue. + + + http://developer.github.com/v3/issues/events/#list-events-for-an-issue + + The owner of the repository + The name of the repository + The issue number + + + + Gets all events for the issue. + + + http://developer.github.com/v3/issues/events/#list-events-for-an-issue + + The Id of the repository + The issue number + + + + Gets all events for the issue. + + + http://developer.github.com/v3/issues/events/#list-events-for-an-issue + + The owner of the repository + The name of the repository + The issue number + Options for changing the API response + + + + Gets all events for the issue. + + + http://developer.github.com/v3/issues/events/#list-events-for-an-issue + + The Id of the repository + The issue number + Options for changing the API response + + + + Gets all events for the repository. + + + http://developer.github.com/v3/issues/events/#list-events-for-a-repository + + The owner of the repository + The name of the repository + + + + Gets all events for the repository. + + + http://developer.github.com/v3/issues/events/#list-events-for-a-repository + + The Id of the repository + + + + Gets all events for the repository. + + + http://developer.github.com/v3/issues/events/#list-events-for-a-repository + + The owner of the repository + The name of the repository + Options for changing the API response + + + + Gets all events for the repository. + + + http://developer.github.com/v3/issues/events/#list-events-for-a-repository + + The Id of the repository + Options for changing the API response + + + + Gets a single event + + + http://developer.github.com/v3/issues/events/#get-a-single-event + + The owner of the repository + The name of the repository + The event id + + + + Gets a single event + + + http://developer.github.com/v3/issues/events/#get-a-single-event + + The Id of the repository + The event id + + + + A client for GitHub's Issue Labels API. + + + See the Issue Labels API documentation for more information. + + + + + Gets all labels for the issue. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The number of the issue + + + + Gets all labels for the issue. + + + See the API documentation for more information. + + The Id of the repository + The number of the issue + + + + Gets all labels for the issue. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The number of the issue + Options for changing the API response + + + + Gets all labels for the issue. + + + See the API documentation for more information. + + The Id of the repository + The number of the issue + Options for changing the API response + + + + Gets all labels for the repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + + + + Gets all labels for the repository. + + + See the API documentation for more information. + + The Id of the repository + + + + Gets all labels for the repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Options for changing the API response + + + + Gets all labels for the repository. + + + See the API documentation for more information. + + The Id of the repository + Options for changing the API response + + + + Gets labels for every issue in a milestone + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The number of the milestone + + + + Gets labels for every issue in a milestone + + + See the API documentation for more information. + + The Id of the repository + The number of the milestone + + + + Gets labels for every issue in a milestone + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The number of the milestone + Options for changing the API response + + + + Gets labels for every issue in a milestone + + + See the API documentation for more information. + + The Id of the repository + The number of the milestone + Options for changing the API response + + + + Gets a single Label by name. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The name of the label + + + + Gets a single Label by name. + + + See the API documentation for more information. + + The Id of the repository + The name of the label + + + + Deletes a label. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The name of the label + + + + Deletes a label. + + + See the API documentation for more information. + + The Id of the repository + The name of the label + + + + Creates a label. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The data for the label to be created + + + + Creates a label. + + + See the API documentation for more information. + + The Id of the repository + The data for the label to be created + + + + Updates a label. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The name of the label + The data for the label to be updated + + + + Updates a label. + + + See the API documentation for more information. + + The Id of the repository + The name of the label + The data for the label to be updated + + + + Adds a label to an issue + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The number of the issue + The names of the labels to add + + + + Adds a label to an issue + + + See the API documentation for more information. + + The Id of the repository + The number of the issue + The names of the labels to add + + + + Removes a label from an issue + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The number of the issue + The name of the label to remove + + + + Removes a label from an issue + + + See the API documentation for more information. + + The Id of the repository + The number of the issue + The name of the label to remove + + + + Replaces all labels on the specified issues with the provided labels + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The number of the issue + The names of the labels to set + + + + Replaces all labels on the specified issues with the provided labels + + + See the API documentation for more information. + + The Id of the repository + The number of the issue + The names of the labels to set + + + + Removes all labels from an issue + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The number of the issue + + + + Removes all labels from an issue + + + See the API documentation for more information. + + The Id of the repository + The number of the issue + + + + A client for GitHub's Issue Timeline API. + + + See the Issue Timeline API documentation for more information. + + + + + Gets all the various events that have occurred around an issue or pull request. + + + https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue + + The owner of the repository + The name of the repository + The issue number + + + + Gets all the various events that have occurred around an issue or pull request. + + + https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue + + The owner of the repository + The name of the repository + The issue number + Options for changing the API repsonse + + + + Gets all the various events that have occurred around an issue or pull request. + + + https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue + + The Id of the repository + The issue number + + + + Gets all the various events that have occurred around an issue or pull request. + + + https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue + + The Id of the repository + The issue number + Options for changing the API response + + + + A client for GitHub's Activity Starring API. + + + See the Activity Starring API documentation for more information. + + + + + Retrieves all of the stargazers for the passed repository. + + The owner of the repository + The name of the repository + Thrown if the client is not authenticated. + + + + Retrieves all of the stargazers for the passed repository. + + The Id of the repository + Thrown if the client is not authenticated. + + + + Retrieves all of the stargazers for the passed repository. + + The owner of the repository + The name of the repository + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the stargazers for the passed repository. + + The Id of the repository + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the stargazers for the passed repository with star creation timestamps. + + The owner of the repository + The name of the repository + Thrown if the client is not authenticated. + + + + Retrieves all of the stargazers for the passed repository with star creation timestamps. + + The Id of the repository + Thrown if the client is not authenticated. + + + + Retrieves all of the stargazers for the passed repository with star creation timestamps. + + The owner of the repository + The name of the repository + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the stargazers for the passed repository with star creation timestamps. + + The Id of the repository + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the starred (ies) for the current user. + + Thrown if the client is not authenticated. + + + + Retrieves all of the starred (ies) for the current user. + + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the starred (ies) for the current user with star creation timestamps. + + Thrown if the client is not authenticated. + + + + Retrieves all of the starred (ies) for the current user with star creation timestamps. + + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the starred (ies) for the current user. + + Star-specific request parameters that sort the results + Thrown if the client is not authenticated. + + + + Retrieves all of the starred (ies) for the current user. + + Star-specific request parameters that sort the results + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the starred (ies) for the current user with star creation timestamps. + + Star-specific request parameters that sort the results + Thrown if the client is not authenticated. + + + + Retrieves all of the starred (ies) for the current user with star creation timestamps. + + Star-specific request parameters that sort the results + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the (ies) starred by the specified user. + + The login of the user + Thrown if the client is not authenticated. + + + + Retrieves all of the (ies) starred by the specified user. + + The login of the user + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the (ies) starred by the specified user with star creation timestamps. + + The login of the user + Thrown if the client is not authenticated. + + + + Retrieves all of the (ies) starred by the specified user with star creation timestamps. + + The login of the user + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the (ies) starred by the specified user. + + The login of the user + Star-specific request parameters that sort the results + Thrown if the client is not authenticated. + + + + Retrieves all of the (ies) starred by the specified user. + + The login of the user + Star-specific request parameters that sort the results + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the (ies) starred by the specified user with star creation timestamps. + + The login of the user + Star-specific request parameters that sort the results + Thrown if the client is not authenticated. + + + + Retrieves all of the (ies) starred by the specified user with star creation timestamps. + + The login of the user + Star-specific request parameters that sort the results + Options for changing the API response + Thrown if the client is not authenticated. + + + + Check if a repository is starred by the current authenticated user. + + The owner of the repository + The name of the repository + Thrown if the client is not authenticated. + + + + Stars a repository for the authenticated user. + + The owner of the repository to star + The name of the repository to star + + + + Unstars a repository for the authenticated user. + + The owner of the repository to unstar + The name of the repository to unstar + + + + A client for GitHub's Repository Statistics API. + + + See the Repository Statistics API documentation for more information. + + + + + Returns a list of for the given repository + + The owner of the repository + The name of the repository + + + + Returns a list of for the given repository + + The Id of the repository + + + + Returns a list of for the given repository + + The owner of the repository + The name of the repository + A token used to cancel this potentially long running request + + + + Returns a list of for the given repository + + The Id of the repository + A token used to cancel this potentially long running request + + + + Returns the last year of commit activity grouped by week. + + The owner of the repository + The name of the repository + + + + Returns the last year of commit activity grouped by week. + + The Id of the repository + + + + Returns the last year of commit activity grouped by week. + + The owner of the repository + The name of the repository + A token used to cancel this potentially long running request + + + + Returns the last year of commit activity grouped by week. + + The Id of the repository + A token used to cancel this potentially long running request + + + + Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + + The owner of the repository + The name of the repository + + + + Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + + The Id of the repository + + + + Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + + The owner of the repository + The name of the repository + A token used to cancel this potentially long running request + + + + Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + + The Id of the repository + A token used to cancel this potentially long running request + + + + Returns the total commit counts for the owner and total commit counts in total. + + The owner of the repository + The name of the repository + + + + Returns the total commit counts for the owner and total commit counts in total. + + The Id of the repository + + + + Returns the total commit counts for the owner and total commit counts in total. + + The owner of the repository + The name of the repository + A token used to cancel this potentially long running request + + + + Returns the total commit counts for the owner and total commit counts in total. + + The Id of the repository + A token used to cancel this potentially long running request + + + + Returns a list of the number of commits per hour in each day + + The owner of the repository + The name of the repository + + + + Returns a list of the number of commits per hour in each day + + The Id of the repository + + + + Returns a list of the number of commits per hour in each day + + The owner of the repository + The name of the repository + A token used to cancel this potentially long running request + + + + Returns a list of the number of commits per hour in each day + + The Id of the repository + A token used to cancel this potentially long running request + + + + A client for GitHub's Git Tags API. + + + See the Git Tags API documentation for more information. + + + + + Gets a tag for a given repository by sha reference + + + http://developer.github.com/v3/git/tags/#get-a-tag + + The owner of the repository + The name of the repository + Tha sha reference of the tag + + + + Gets a tag for a given repository by sha reference + + + http://developer.github.com/v3/git/tags/#get-a-tag + + The Id of the repository + Tha sha reference of the tag + + + + Create a tag for a given repository + + + http://developer.github.com/v3/git/tags/#create-a-tag-object + + The owner of the repository + The name of the repository + The tag to create + + + + Create a tag for a given repository + + + http://developer.github.com/v3/git/tags/#create-a-tag-object + + The Id of the repository + The tag to create + + + + A client for GitHub's Organization Teams API. + + + See the Organization Teams API documentation for more information. + + + + + Gets a single by identifier. + + + https://developer.github.com/v3/orgs/teams/#get-team + + The team identifier. + The with the given identifier. + + + + Returns all s for the current org. + + Organization for which to list all teams. + Thrown when a general API error occurs. + A list of the orgs's teams s. + + + + Returns all s for the current org. + + Organization for which to list all teams. + Options to change API behaviour. + Thrown when a general API error occurs. + A list of the orgs's teams s. + + + + Returns all s for the current user. + + Thrown when a general API error occurs. + A list of the user's s. + + + + Returns all s for the current user. + + Options to change API behaviour. + Thrown when a general API error occurs. + A list of the user's s. + + + + Returns all child teams of the given team. + + + https://developer.github.com/v3/orgs/teams/#list-child-teams + + The team identifier + + + + Returns all child teams of the given team. + + + https://developer.github.com/v3/orgs/teams/#list-child-teams + + The team identifier + Options to change API behaviour. + + + + Returns all members of the given team. + + + https://developer.github.com/v3/orgs/teams/#list-team-members + + The team identifier + + + + Returns all members of the given team. + + + https://developer.github.com/v3/orgs/teams/#list-team-members + + The team identifier + Options to change API behaviour. + + + + Returns all members with the specified role in the given team of the given role. + + + https://developer.github.com/v3/orgs/teams/#list-team-members + + The team identifier + The request filter + + + + Returns all members with the specified role in the given team of the given role. + + + https://developer.github.com/v3/orgs/teams/#list-team-members + + The team identifier + The request filter + Options to change API behaviour. + + + + Returns newly created for the current org. + + Thrown when a general API error occurs. + Newly created + + + + Returns updated for the current org. + + Thrown when a general API error occurs. + Updated + + + + Delte a team - must have owner permissions to this + + Thrown when a general API error occurs. + + + + + Adds a to a . + + + See the API documentation for more information. + + The team identifier. + The user to add to the team. + Additional parameters for the request + + + + Removes a from a . + + + See the API documentation for more information. + + The team identifier. + The user to remove from the team. + if the user was removed from the team; otherwise. + + + + Gets whether the user with the given + is a member of the team with the given . + A is thrown if the user is not a member. + + + See the API documentation for more information. + + The team to check. + The user to check. + + + + Returns all team's repositories. + + Team Id to list repos. + Thrown when a general API error occurs. + The team's repositories + + + + Returns all team's repositories. + + Team Id to list repos. + Options to change API behaviour. + Thrown when a general API error occurs. + The team's repositories + + + + Add a repository to the team + + Thrown when a general API error occurs. + + + + + Add a repository to the team + + The team identifier. + Org to associate the repo with. + Name of the repo. + The permission to grant the team on this repository. + Thrown when a general API error occurs. + + + + + Remove a repository from the team + + Thrown when a general API error occurs. + + + + + Gets whether or not the given repository is managed by the given team. + + The team identifier + Owner of the org the team is associated with. + Name of the repo. + + See the API documentation for more information. + + if the repository is managed by the given team; otherwise. + + + + List all pending invitations for the given team. + + + See the API Documentation + for more information. + + The team identifier + + + + + List all pending invitations for the given team. + + + See the API Documentation + for more information. + + The team identifier + Options to change API behaviour. + + + + + A client for GitHub's Git Trees API. + + + See the Git Trees API documentation for more information. + + + + + Gets a Tree Response for a given SHA. + + + http://developer.github.com/v3/git/trees/#get-a-tree + + The owner of the repository + The name of the repository + The SHA that references the tree + + + + Gets a Tree Response for a given SHA. + + + http://developer.github.com/v3/git/trees/#get-a-tree + + The Id of the repository + The SHA that references the tree + + + + Gets a Tree Response for a given SHA. + + + https://developer.github.com/v3/git/trees/#get-a-tree-recursively + + The owner of the repository + The name of the repository + The SHA that references the tree + + + + Gets a Tree Response for a given SHA. + + + https://developer.github.com/v3/git/trees/#get-a-tree-recursively + + The Id of the repository + The SHA that references the tree + + + + Creates a new Tree in the specified repo + + + http://developer.github.com/v3/git/trees/#create-a-tree + + The owner of the repository + The name of the repository + The value of the new tree + + + + Creates a new Tree in the specified repo + + + http://developer.github.com/v3/git/trees/#create-a-tree + + The Id of the repository + The value of the new tree + + + + A client for GitHub's User Administration API (GitHub Enterprise) + + + See the Administration API documentation for more details. + + + + + Create a new user (must be Site Admin user). + + + See the API documentation + for more information. + + The object describing the user to create + The created object + + + + Rename an existing user (must be Site Admin user). + + + See the API documentation + for more information. + Note that this queues a request to rename a user, rather than execute it straight away + + The username to rename + The request, specifying the new login + A object indicating the queued task message and Url to the user + + + + Create an impersonation OAuth token (must be Site Admin user). + + + See the API documentation + for more information. + + The user to impersonate + The request specifying the required scopes + An object containing the impersonation token + + + + Deletes an impersonation OAuth token (must be Site Admin user). + + + See the API documentation + for more information. + + The user to remove impersonation token from + + + + + Promotes ordinary user to a site administrator (must be Site Admin user). + + + See the API documentation + for more information. + + The user to promote to administrator. + + + + + Demotes a site administrator to an ordinary user (must be Site Admin user). + + + See the API documentation + for more information. + + The user to demote from administrator. + + + + + Suspends a user (must be Site Admin user). + + + See the API documentation + for more information. + + The user to suspend. + + + + + Unsuspends a user (must be Site Admin user). + + + See the API documentation + for more information. + + The user to unsuspend. + + + + + List all public keys (must be Site Admin user). + + + See the API documentation + for more information. + + + + + + Delete a user (must be Site Admin user). + + + See the API documentation + for more information. + + The user to delete + + + + + Delete a public key (must be Site Admin user). + + + See the API documentation + for more information. + + The key to delete + + + + + A client for GitHub's User Emails API. + + + See the User Emails API documentation for more information. + + + + + Gets all email addresses for the authenticated user. + + + http://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user + + The es for the authenticated user. + + + + Gets all email addresses for the authenticated user. + + + http://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user + + Options for changing the API response + The es for the authenticated user. + + + + Adds email addresses for the authenticated user. + + + http://developer.github.com/v3/users/emails/#add-email-addresses + + The email addresses to add. + Returns the added es. + + + + Deletes email addresses for the authenticated user. + + + http://developer.github.com/v3/users/emails/#delete-email-addresses + + The email addresses to delete. + Returns the added es. + + + + A client for GitHub's UserUser GPG Keys API. + + + See the User GPG Keys documentation for more information. + + + + + Gets all GPG keys for the authenticated user. + + + See the API documentation for more information. + + A of s for the current user. + + + + Gets all GPG keys for the authenticated user. + + Options for changing the API response + + See the API documentation for more information. + + A of s for the current user. + + + + View extended details of the for the specified id. + + The Id of the GPG key + + See the API documentation for more information. + + The for the specified Id. + + + + Creates a new for the authenticated user. + + The new GPG key to add. + + See the API documentation for more information. + + The newly created . + + + + Deletes the GPG key for the specified Id. + + The Id of the GPG key to delete. + + See the API documentation for more information. + + + + + + A client for GitHub's User Keys API. + + + See the User Keys API documentation for more information. + + + + + Gets all verified public keys for a user. + + + https://developer.github.com/v3/users/keys/#list-public-keys-for-a-user + + The @ handle of the user. + Lists the verified public keys for a user. + + + + Gets all verified public keys for a user. + + + https://developer.github.com/v3/users/keys/#list-public-keys-for-a-user + + The @ handle of the user. + Options to change API's behavior. + Lists the verified public keys for a user. + + + + Gets all public keys for the authenticated user. + + + https://developer.github.com/v3/users/keys/#list-your-public-keys + + Lists the current user's keys. + + + + Gets all public keys for the authenticated user. + + + https://developer.github.com/v3/users/keys/#list-your-public-keys + + Options to change API's behavior. + Lists the current user's keys. + + + + Retrieves the for the specified id. + + + https://developer.github.com/v3/users/keys/#get-a-single-public-key + + The Id of the SSH key + View extended details for a single public key. + + + + Create a public key . + + + https://developer.github.com/v3/users/keys/#create-a-public-key + + The SSH Key contents + Creates a public key. + + + + Delete a public key. + + + https://developer.github.com/v3/users/keys/#delete-a-public-key + + The id of the key to delete + Removes a public key. + + + + A client for GitHub's Users API. + + + See the Users API documentation for more information. + + + + + A client for GitHub's User Emails API + + + See the Emails API documentation for more information. + + + + + A client for GitHub's User Keys API + + + See the Keys API documentation for more information. + + + + + Returns the user specified by the login. + + The login name for the user + + + + Returns a for the current authenticated user. + + Thrown if the client is not authenticated. + A + + + + Update the specified . + + The login for the user + Thrown if the client is not authenticated. + A + + + + A client for GitHub's User Followers API + + + See the Followers API documentation for more information. + + + + + A client for GitHub's User Administration API + + + See the User Administrator API documentation for more information. + + + + + A client for GitHub's Watching API. + + + See the Watching API documentation for more information. + + + + + Retrieves all of the watchers for the passed repository. + + The owner of the repository + The name of the repository + Thrown if the client is not authenticated. + + + + Retrieves all of the watchers for the passed repository. + + The Id of the repository + Thrown if the client is not authenticated. + + + + Retrieves all of the watchers for the passed repository. + + The owner of the repository + The name of the repository + Options for changing API's response. + Thrown if the client is not authenticated. + + + + Retrieves all of the watchers for the passed repository. + + The Id of the repository + Options for changing API's response. + Thrown if the client is not authenticated. + + + + Retrieves all of the watched (ies) for the current user. + + Thrown if the client is not authenticated. + + A of (ies) watched by the current authenticated user. + + + + + Retrieves all of the watched (ies) for the current user. + + Options for changing API's response. + Thrown if the client is not authenticated. + + A of (ies) watched by the current authenticated user. + + + + + Retrieves all of the (ies) watched by the specified user. + + The login of the user + Thrown if the client is not authenticated. + + A (ies) watched by the specified user. + + + + + Retrieves all of the (ies) watched by the specified user. + + The login of the user + Options for changing API's response. + Thrown if the client is not authenticated. + + A (ies) watched by the specified user. + + + + + Check if a repository is watched by the current authenticated user. + + The owner of the repository + The name of the repository + Thrown if the client is not authenticated. + + + + Check if a repository is watched by the current authenticated user. + + The Id of the repository + Thrown if the client is not authenticated. + + + + Watches a repository for the authenticated user. + + The owner of the repository to star + The name of the repository to star + A instance describing the new subscription to create + + + + Watches a repository for the authenticated user. + + The Id of the repository + A instance describing the new subscription to create + + + + Unwatches a repository for the authenticated user. + + The owner of the repository to unstar + The name of the repository to unstar + + + + Unwatches a repository for the authenticated user. + + The Id of the repository + + + + A client for GitHub's Git Merging API. + + + See the Git Merging API documentation for more information. + + + + + Initializes a new instance of the class. + + The client's connection + + + + Create a merge for a given repository + + + http://developer.github.com/v3/repos/merging/#perform-a-merge + + The owner of the repository + The name of the repository + The merge to create + + + + + Create a merge for a given repository + + + http://developer.github.com/v3/repos/merging/#perform-a-merge + + The Id of the repository + The merge to create + + + + + A client for GitHub's Migration API. These APIs help you move projects to or from GitHub. + + + Docs: https://developer.github.com/v3/migration/ + + + + + Instantiate a new GitHub Migration API client and its sub-APIs. + + An API connection. + + + + The Enterprise Migrations API lets you move a repository from GitHub to GitHub Enterprise. + + + https://developer.github.com/v3/migration/#enterprise-migrations + + + + + A client for GitHub's Migrations API. + + + See docs + for more information. + + + + + Instantiates a GitHub Migrations API client. + + An API connection. + + + + Starts a new migration specified for the given organization. + + + https://developer.github.com/v3/migration/migrations/#start-a-migration + + The organization for which to start a migration. + Sprcifies parameters for the migration in a + object. + The started migration. + + + + Gets the list of the most recent migrations of the the organization. + + + https://developer.github.com/v3/migration/migrations/#get-a-list-of-migrations + + The organization of which to list migrations. + List of most recent s. + + + + Get the status of a migration + + + https://developer.github.com/v3/migration/migrations/#get-the-status-of-a-migration + + The organization which is migrating. + Migration Id of the organization. + A object representing the state of migration. + + + + Get the migration archive. + + + https://developer.github.com/v3/migration/migrations/#download-a-migration-archive + + The organization of which the migration was. + The Id of the migration. + The binary contents of the archive as a byte array. + + + + Deletes a previous migration archive. + + + https://developer.github.com/v3/migration/migrations/#delete-a-migration-archive + + The organization of which the migration was. + The Id of the migration. + + + + + Unlocks a repository that was locked for migration. + + + https://developer.github.com/v3/migration/migrations/#unlock-a-repository + + The organization of which the migration was. + The Id of the migration. + The repo to unlock. + + + + + A client for GitHub's Issue Milestones API. + + + See the Issue Milestones API documentation for more information. + + + + + Instantiates a new GitHub Issue Milestones API client. + + An API connection + + + + Gets a single Milestone by number. + + + http://developer.github.com/v3/issues/milestones/#get-a-single-milestone + + + + + + Gets a single Milestone by number. + + + http://developer.github.com/v3/issues/milestones/#get-a-single-milestone + + + + + + Gets all open milestones for the repository. + + + http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository + + The owner of the repository + The name of the repository + + + + + Gets all open milestones for the repository. + + + http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository + + The Id of the repository + + + + + Gets all open milestones for the repository. + + + http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository + + The owner of the repository + The name of the repository + Options for changing the API response + + + + + Gets all open milestones for the repository. + + + http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository + + The Id of the repository + Options for changing the API response + + + + + Gets all open milestones for the repository. + + + http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository + + The owner of the repository + The name of the repository + Used to filter and sort the list of Milestones returned + + + + + Gets all open milestones for the repository. + + + http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository + + The Id of the repository + Used to filter and sort the list of Milestones returned + + + + + Gets all open milestones for the repository. + + + http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository + + The owner of the repository + The name of the repository + Used to filter and sort the list of Milestones returned + Options for changing the API response + + + + + Gets all open milestones for the repository. + + + http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository + + The Id of the repository + Used to filter and sort the list of Milestones returned + Options for changing the API response + + + + + Creates a milestone for the specified repository. Any user with pull access to a repository can create an + Milestone. + + http://developer.github.com/v3/issues/milestones/#create-a-milestone + The owner of the repository + The name of the repository + A instance describing the new Milestone to create + + + + + Creates a milestone for the specified repository. Any user with pull access to a repository can create an + Milestone. + + http://developer.github.com/v3/issues/milestones/#create-a-milestone + The Id of the repository + A instance describing the new Milestone to create + + + + + Creates a milestone for the specified repository. Any user with pull access to a repository can create an + Milestone. + + http://developer.github.com/v3/issues/milestones/#update-a-milestone + The owner of the repository + The name of the repository + The Milestone number + An instance describing the changes to make to the Milestone + + + + + + Creates a milestone for the specified repository. Any user with pull access to a repository can create an + Milestone. + + http://developer.github.com/v3/issues/milestones/#update-a-milestone + The Id of the repository + The Milestone number + An instance describing the changes to make to the Milestone + + + + + + Deletes a milestone for the specified repository. Any user with pull access to a repository can create an + Milestone. + + http://developer.github.com/v3/issues/milestones/#delete-a-milestone + The owner of the repository + The name of the repository + The milestone number + + + + + Deletes a milestone for the specified repository. Any user with pull access to a repository can create an + Milestone. + + http://developer.github.com/v3/issues/milestones/#delete-a-milestone + The Id of the repository + The milestone number + + + + + A client for GitHub's miscellaneous APIs. + + + See the Miscellaneous API documentation for more details. + + + + + Initializes a new GitHub miscellaneous API client. + + An API connection + + + + Gets all the emojis available to use on GitHub. + + Thrown when a general API error occurs. + An of emoji and their URI. + + + + Gets the rendered Markdown for the specified plain-text Markdown document. + + A plain-text Markdown document + Thrown when a general API error occurs. + The rendered Markdown. + + + + Gets the rendered Markdown for an arbitrary markdown document. + + An arbitrary Markdown document + Thrown when a general API error occurs. + The rendered Markdown. + + + + List all templates available to pass as an option when creating a repository. + + A list of template names + + + + Retrieves the source for a single GitIgnore template + + + A template and its source + + + + Returns a list of the licenses shown in the license picker on GitHub.com. This is not a comprehensive + list of all possible OSS licenses. + + This is a PREVIEW API! Use it at your own risk. + A list of licenses available on the site + + + + Retrieves a license based on the license key such as "mit" + + + A that includes the license key, text, and attributes of the license. + + + + Gets API Rate Limits (API service rather than header info). + + Thrown when a general API error occurs. + An of Rate Limits. + + + + Retrieves information about GitHub.com, the service or a GitHub Enterprise installation. + + Thrown when a general API error occurs. + An containing metadata about the GitHub instance. + + + + A client for GitHub's Activity Notifications API. + + + See the Activity Notifications API documentation for more information. + + + + + Instantiates a new GitHub Activity Notifications API client. + + An API connection + + + + Retrieves all of the s for the current user. + + Thrown if the client is not authenticated. + + + + Retrieves all of the s for the current user. + + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the s for the current user. + + Specifies the parameters to filter notifications by + Thrown if the client is not authenticated. + + + + Retrieves all of the s for the current user. + + Specifies the parameters to filter notifications by + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the s for the current user specific to the specified repository. + + The owner of the repository. + The name of the repository. + Thrown if the client is not authenticated. + + + + Retrieves all of the s for the current user specific to the specified repository. + + The Id of the repository. + Thrown if the client is not authenticated. + + + + Retrieves all of the s for the current user specific to the specified repository. + + The owner of the repository. + The name of the repository. + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the s for the current user specific to the specified repository. + + The Id of the repository. + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the s for the current user specific to the specified repository. + + The owner of the repository. + The name of the repository. + Specifies the parameters to filter notifications by + Thrown if the client is not authenticated. + + + + Retrieves all of the s for the current user specific to the specified repository. + + The Id of the repository. + Specifies the parameters to filter notifications by + Thrown if the client is not authenticated. + + + + Retrieves all of the s for the current user specific to the specified repository. + + The owner of the repository. + The name of the repository. + Specifies the parameters to filter notifications by + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the s for the current user specific to the specified repository. + + The Id of the repository. + Specifies the parameters to filter notifications by + Options for changing the API response + Thrown if the client is not authenticated. + + + + Marks all notifications as read. + + http://developer.github.com/v3/activity/notifications/#mark-as-read + + + + Marks all notifications as read. + + The parameter which specifies which notifications to mark. + http://developer.github.com/v3/activity/notifications/#mark-as-read + + + + Marks the notifications for a given repository as read. + + The owner of the repository + The name of the repository + http://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository + + + + Marks the notifications for a given repository as read. + + The Id of the repository + http://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository + + + + Marks the notifications for a given repository as read. + + The owner of the repository + The name of the repository + The parameter which specifies which notifications to mark. + http://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository + + + + Marks the notifications for a given repository as read. + + The Id of the repository + The parameter which specifies which notifications to mark. + http://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository + + + + Retrives a single by Id. + + The Id of the notification to retrieve. + http://developer.github.com/v3/activity/notifications/#view-a-single-thread + + + + Marks a single notification as read. + + The id of the notification. + http://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read + + + + Retrives a for the provided thread id. + + The Id of the thread to retrieve subscription status. + http://developer.github.com/v3/activity/notifications/#get-a-thread-subscription + + + + Sets the authenticated user's subscription settings for a given thread. + + The Id of the thread to update. + The subscription parameters to set. + http://developer.github.com/v3/activity/notifications/#set-a-thread-subscription + + + + Deletes the authenticated user's subscription to a given thread. + + The Id of the thread to delete subscription from. + http://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription + + + + Provides methods used in the OAuth web flow. + + + + + Create an instance of the OauthClient + + The underlying connection to use + + + + Gets the URL used in the first step of the web flow. The Web application should redirect to this URL. + + Parameters to the Oauth web flow login url + + + + + Makes a request to get an access token using the code returned when GitHub.com redirects back from the URL + GitHub login url to the application. + + + If the user accepts your request, GitHub redirects back to your site with a temporary code in a code + parameter as well as the state you provided in the previous step in a state parameter. If the states don’t + match, the request has been created by a third party and the process should be aborted. Exchange this for + an access token using this method. + + + + + + + Filter members in the list + + + see https://developer.github.com/v3/orgs/members/#members-list for details + + + + + All members the authenticated user can see. + + + + + Members without two-factor authentication enabled + + + + + A client for GitHub's Organization Members API. + + + See the Orgs API documentation for more information. + + + + + Initializes a new Organization Members API client. + + An API connection + + + + + List all users who are members of an organization. A member is a user that + belongs to at least 1 team in the organization. + + + If the authenticated user is also an owner of this organization then both + concealed and public member will be returned. + + + If the requester is not an owner of the organization the query will be redirected + to the public members list. + + + + See the API documentation + for more information. + + The login for the organization + The users + + + + + List all users who are members of an organization. A member is a user that + belongs to at least 1 team in the organization. + + + If the authenticated user is also an owner of this organization then both + concealed and public member will be returned. + + + If the requester is not an owner of the organization the query will be redirected + to the public members list. + + + + See the API documentation + for more information. + + The login for the organization + Options for changing the API response + The users + + + + + List all users who are members of an organization. A member is a user that + belongs to at least 1 team in the organization. + + + If the authenticated user is also an owner of this organization then both + concealed and public member will be returned. + + + If the requester is not an owner of the organization the query will be redirected + to the public members list. + + + + See the API documentation + for more information. + + The login for the organization + The filter to use when getting the users, + The users + + + + + List all users who are members of an organization. A member is a user that + belongs to at least 1 team in the organization. + + + If the authenticated user is also an owner of this organization then both + concealed and public member will be returned. + + + If the requester is not an owner of the organization the query will be redirected + to the public members list. + + + + See the API documentation + for more information. + + The login for the organization + The filter to use when getting the users, + Options for changing the API response + The users + + + + + List all users who are members of an organization. A member is a user that + belongs to at least 1 team in the organization. + + + If the authenticated user is also an owner of this organization then both + concealed and public member will be returned. + + + If the requester is not an owner of the organization the query will be redirected + to the public members list. + + + + See the API documentation + for more information. + + The login for the organization + The role filter to use when getting the users, + The users + + + + + List all users who are members of an organization. A member is a user that + belongs to at least 1 team in the organization. + + + If the authenticated user is also an owner of this organization then both + concealed and public member will be returned. + + + If the requester is not an owner of the organization the query will be redirected + to the public members list. + + + + See the API documentation + for more information. + + The login for the organization + The role filter to use when getting the users, + Options for changing the API response + The users + + + + + List all users who are members of an organization. A member is a user that + belongs to at least 1 team in the organization. + + + If the authenticated user is also an owner of this organization then both + concealed and public member will be returned. + + + If the requester is not an owner of the organization the query will be redirected + to the public members list. + + + + See the API documentation + for more information. + + The login for the organization + The filter to use when getting the users, + The role filter to use when getting the users, + The users + + + + + List all users who are members of an organization. A member is a user that + belongs to at least 1 team in the organization. + + + If the authenticated user is also an owner of this organization then both + concealed and public member will be returned. + + + If the requester is not an owner of the organization the query will be redirected + to the public members list. + + + + See the API documentation + for more information. + + The login for the organization + The filter to use when getting the users, + The role filter to use when getting the users, + Options for changing the API response + The users + + + + List all users who have publicized their membership of the organization. + + http://developer.github.com/v3/orgs/members/#public-members-list + The login for the organization + + + + + List all users who have publicized their membership of the organization. + + http://developer.github.com/v3/orgs/members/#public-members-list + The login for the organization + Options for changing the API response + + + + + Check if a user is, publicly or privately, a member of the organization. + + + See the API documentation + for more information. + + The login for the organization + The login for the user + + + + + Check is a user is publicly a member of the organization. + + + See the API documentation + for more information. + + The login for the organization + The login for the user + + + + + Removes a user from the organization, this will also remove them from all teams + within the organization and they will no longer have any access to the organization's + repositories. + + + See the API documentation + for more information. + + The login for the organization + The login for the user + + + + + Make the authenticated user's organization membership public. + + + This method requires authentication. + See the API documentation + for more information. + + The login for the organization + The login for the user + + + + + Make the authenticated user's organization membership private. + + + This method requries authentication. + See the API documentation + for more information. + + The login for the organization + The login for the user + + + + + List all pending invitations for the organization. + + + See the API Documentation + for more information. + + The login for the organization + + + + + List all pending invitations for the organization. + + + See the API Documentation + for more information. + + The login for the organization + Options to change API behaviour + + + + + A client for GitHub's Organization Outside Collaborators API. + + + See the Orgs API documentation for more information. + + + + + Initializes a new Organization Outside Collaborators API client. + + An API connection + + + + List all users who are outside collaborators of an organization. An outside collaborator is a user that + is not a member of the organization. + + + See the API documentation + for more information. + + The login for the organization + The users + + + + List all users who are outside collaborators of an organization. An outside collaborator is a user that + is not a member of the organization. + + + See the API documentation + for more information. + + The login for the organization + Options for changing the API response + The users + + + + List all users who are outside collaborators of an organization. An outside collaborator is a user that + is not a member of the organization. + + + See the API documentation + for more information. + + The login for the organization + The filter to use when getting the users, + The users + + + + List all users who are outside collaborators of an organization. An outside collaborator is a user that + is not a member of the organization. + + + See the API documentation + for more information. + + The login for the organization + The filter to use when getting the users, + Options for changing the API response + The users + + + + Removes a user as an outside collaborator from the organization, this will remove them from all repositories + within the organization. + + + See the API documentation + for more information. + + The login for the organization + The login of the user + + + + + Converts an organization member to an outside collaborator, + when an organization member is converted to an outside collaborator, + they'll only have access to the repositories that their current team membership allows. + The user will no longer be a member of the organization. + + + See the API documentation + for more information. + + The login for the organization + The login for the user + + + + + A client for GitHub's Orgs API. + + + See the Orgs API documentation for more information. + + + + + Initializes a new GitHub Orgs API client. + + An API connection + + + + Returns a client to manage members of an organization. + + + + + Returns a client to manage teams of an organization. + + + + + Returns a client to manage outside collaborators of an organization. + + + + + Returns the specified . + + login of the organization to get + Thrown when a general API error occurs. + The specified . + + + + Returns all s for the current user. + + Thrown when a general API error occurs. + A list of the current user's s. + + + + Returns all s for the current user. + + Options for changing the API response + Thrown when a general API error occurs. + A list of the current user's s. + + + + Returns all s for the specified user. + + The login of the user + Thrown when a general API error occurs. + A list of the specified user's s. + + + + Returns all s for the specified user. + + The login of the user + Options for changing the API response + Thrown when a general API error occurs. + A list of the specified user's s. + + + + Returns all s. + + Thrown when a general API error occurs. + A list of s. + + + + Returns all s. + + Search parameters of the last organization seen + Thrown when a general API error occurs. + A list of s. + + + + Update the specified organization with data from . + + The name of the organization to update. + + Thrown if the client is not authenticated. + A + + + + A client for GitHub's Project Cards API. + + + See the Repository Projects API documentation for more information. + + + + + Gets all cards. + + + See the API documentation for more information. + + The id of the column + + + + Gets all cards. + + + See the API documentation for more information. + + The id of the column + Options for changing the API response + + + + Gets all cards. + + + See the API documentation for more information. + + The id of the column + Used to filter the list of project cards returned + + + + Gets all cards. + + + See the API documentation for more information. + + The id of the column + Used to filter the list of project cards returned + Options for changing the API response + + + + Gets a single card. + + + See the API documentation for more information. + + The id of the card + + + + Creates a card. + + + See the API documentation for more information. + + The id of the column + The card to create + + + + Updates a card. + + + See the API documentation for more information. + + The id of the card + New values to update the card with + + + + Deletes a card. + + + See the API documentation for more information. + + The id of the card + + + + Moves a card. + + + See the API documentation for more information. + + The id of the card + The position to move the card + + + + A client for GitHub's Project Columns API. + + + See the Repository Projects API documentation for more information. + + + + + Gets all columns for this project. + + + See the API documentation for more information. + + The Id of the project + + + + Gets all columns for this project. + + + See the API documentation for more information. + + The Id of the project + Options for changing the API response + + + + Gets a single column for this project. + + + See the API documentation for more information. + + The id of the column + + + + Creates a column for this project. + + + See the API documentation for more information. + + The Id of the project + The column to create + + + + Updates a column for this project. + + + See the API documentation for more information. + + The id of the column + New values to update the column with + + + + Deletes a column. + + + See the API documentation for more information. + + The id of the column + + + + Moves a column. + + + See the API documentation for more information. + + The id of the column + The position to move the column + + + + A client for GitHub's Repository Projects API. + + + See the Repository Projects API documentation for more information. + + + + + Get all projects for this repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + + + + Get all projects for this repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Options for changing the API response + + + + Get all projects for this repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Used to filter the list of projects returned + + + + Get all projects for this repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Used to filter the list of projects returned + Options for changing the API response + + + + Get all projects for this repository. + + + See the API documentation for more information. + + The Id of the repository + + + + Get all projects for this repository. + + + See the API documentation for more information. + + The Id of the repository + Options for changing the API response + + + + Get all projects for this repository. + + + See the API documentation for more information. + + The Id of the repository + Used to filter the list of projects returned + + + + Get all projects for this repository. + + + See the API documentation for more information. + + The Id of the repository + Used to filter the list of projects returned + Options for changing the API response + + + + Get all projects for the specified organization. + + + See the API documentation for more information. + + The name of the organziation + + + + Get all projects for the specified organization. + + + See the API documentation for more information. + + The name of the organziation + Options for changing the API response + + + + Get all projects for the specified organization. + + + See the API documentation for more information. + + The name of the organziation + Used to filter the list of projects returned + + + + Get all projects for the specified organization. + + + See the API documentation for more information. + + The name of the organziation + Used to filter the list of projects returned + Options for changing the API response + + + + Gets a single project for this repository. + + + See the API documentation for more information. + + The Id of the project + + + + Creates a project for this repository. + + + See the API documentation for more information. + + The Id of the repository + The new project to create for this repository + + + + Creates a project for the specified organization. + + + See the API documentation for more information. + + The name of the organization + The new project to create for this repository + + + + Updates a project for this repository. + + + See the API documentation for more information. + + The Id of the project + The modified project + + + + Deletes a project. + + + See the API documentation for more information. + + The Id of the project + + + + A client for GitHub's Project Cards API. + + + See the Repository Projects API documentation for more information. + + + + + A client for GitHub's Project Columns API. + + + See the Repository Projects API documentation for more information. + + + + + A client for GitHub's Reactions API. + + + See the Reactions API documentation for more information. + + + + + Get all reactions for a specified Pull Request Review Comment. + + https://developer.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment + The owner of the repository + The name of the repository + The comment id + + + + Get all reactions for a specified Pull Request Review Comment. + + https://developer.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment + The Id of the repository + The comment id + + + + Creates a reaction for a specified Pull Request Review Comment. + + https://developer.github.com/v3/reactions/#create-reaction-for-a-pull-request-review-comment + The owner of the repository + The name of the repository + The comment id + The reaction to create + + + + Creates a reaction for a specified Pull Request Review Comment. + + https://developer.github.com/v3/reactions/#create-reaction-for-a-pull-request-review-comment + The Id of the repository + The comment id + The reaction to create + + + + A client for GitHub's Pull Request Review Comments API. + + + See the Review Comments API documentation for more information. + + + + + Gets review comments for a specified pull request. + + http://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request + The owner of the repository + The name of the repository + The pull request number + + + + Gets review comments for a specified pull request. + + http://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request + The Id of the repository + The pull request number + + + + Gets review comments for a specified pull request. + + http://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request + The owner of the repository + The name of the repository + The pull request number + Options for changing the API response + + + + Gets review comments for a specified pull request. + + http://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request + The Id of the repository + The pull request number + Options for changing the API response + + + + Gets a list of the pull request review comments in a specified repository. + + http://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository + The owner of the repository + The name of the repository + + + + Gets a list of the pull request review comments in a specified repository. + + http://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository + The Id of the repository + + + + Gets a list of the pull request review comments in a specified repository. + + http://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository + The owner of the repository + The name of the repository + Options for changing the API response + + + + Gets a list of the pull request review comments in a specified repository. + + http://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository + The Id of the repository + Options for changing the API response + + + + Gets a list of the pull request review comments in a specified repository. + + http://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository + The owner of the repository + The name of the repository + The sorting parameters + + + + Gets a list of the pull request review comments in a specified repository. + + http://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository + The Id of the repository + The sorting parameters + + + + Gets a list of the pull request review comments in a specified repository. + + http://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository + The owner of the repository + The name of the repository + The sorting parameters + Options for changing the API response + + + + Gets a list of the pull request review comments in a specified repository. + + http://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository + The Id of the repository + The sorting parameters + Options for changing the API response + + + + Gets a single pull request review comment by number. + + http://developer.github.com/v3/pulls/comments/#get-a-single-comment + The owner of the repository + The name of the repository + The pull request review comment number + + + + Gets a single pull request review comment by number. + + http://developer.github.com/v3/pulls/comments/#get-a-single-comment + The Id of the repository + The pull request review comment number + + + + Creates a comment on a pull request review. + + http://developer.github.com/v3/pulls/comments/#create-a-comment + The owner of the repository + The name of the repository + The Pull Request number + The comment + + + + Creates a comment on a pull request review. + + http://developer.github.com/v3/pulls/comments/#create-a-comment + The Id of the repository + The Pull Request number + The comment + + + + Creates a comment on a pull request review as a reply to another comment. + + http://developer.github.com/v3/pulls/comments/#create-a-comment + The owner of the repository + The name of the repository + The pull request number + The comment + + + + Creates a comment on a pull request review as a reply to another comment. + + http://developer.github.com/v3/pulls/comments/#create-a-comment + The Id of the repository + The pull request number + The comment + + + + Edits a comment on a pull request review. + + http://developer.github.com/v3/pulls/comments/#edit-a-comment + The owner of the repository + The name of the repository + The pull request review comment number + The edited comment + + + + Edits a comment on a pull request review. + + http://developer.github.com/v3/pulls/comments/#edit-a-comment + The Id of the repository + The pull request review comment number + The edited comment + + + + Deletes a comment on a pull request review. + + http://developer.github.com/v3/pulls/comments/#delete-a-comment + The owner of the repository + The name of the repository + The pull request review comment number + + + + Deletes a comment on a pull request review. + + http://developer.github.com/v3/pulls/comments/#delete-a-comment + The Id of the repository + The pull request review comment number + + + + A client for GitHub's Pull Request Review Requests API. + + + See the Review Requests API documentation for more information. + + + + + Gets review requests for a specified pull request. + + https://developer.github.com/v3/pulls/review_requests/#list-review-requests + The owner of the repository + The name of the repository + The pull request number + + + + Gets review requests for a specified pull request. + + https://developer.github.com/v3/pulls/review_requests/#list-review-requests + The owner of the repository + The name of the repository + The pull request number + Options for changing the API response + + + + Gets review requests for a specified pull request. + + https://developer.github.com/v3/pulls/review_requests/#list-review-requests + The Id of the repository + The pull request number + + + + Gets review requests for a specified pull request. + + https://developer.github.com/v3/pulls/review_requests/#list-review-requests + The Id of the repository + The pull request number + Options for changing the API response + + + + Creates review requests on a pull request for specified users. + + https://developer.github.com/v3/pulls/review_requests/#create-a-review-request + The owner of the repository + The name of the repository + The Pull Request number + List of logins of user will be requested for review + + + + Creates review requests on a pull request for specified users. + + https://developer.github.com/v3/pulls/review_requests/#create-a-review-request + The Id of the repository + The Pull Request number + List of logins of user will be requested for review + + + + Deletes review request for given users on a pull request. + + https://developer.github.com/v3/pulls/review_requests/#delete-a-review-request + The owner of the repository + The name of the repository + The pull request review comment number + List of logins of users that will be not longer requested for review + + + + Deletes review request for given users on a pull request. + + https://developer.github.com/v3/pulls/review_requests/#delete-a-review-request + The Id of the repository + The pull request review comment number + List of logins of users that will be not longer requested for review + + + + A client for GitHub's Pull Request Review API. + + + See the Review API documentation for more information. + + + + + Gets reviews for a specified pull request. + + https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request + The owner of the repository + The name of the repository + The pull request number + + + + Gets reviews for a specified pull request. + + https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request + The Id of the repository + The pull request number + + + + Gets reviews for a specified pull request. + + https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request + The owner of the repository + The name of the repository + The pull request number + Options for changing the API response + + + + Gets reviews for a specified pull request. + + https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request + The Id of the repository + The pull request number + Options for changing the API response + + + + Gets a single pull request review by ID. + + https://developer.github.com/v3/pulls/reviews/#get-a-single-review + The owner of the repository + The name of the repository + The pull request number + The pull request review number + + + + Gets a single pull request review by ID. + + https://developer.github.com/v3/pulls/reviews/#get-a-single-review + The Id of the repository + The pull request number + The pull request review number + + + + Creates a review. + + https://developer.github.com/v3/pulls/reviews/#create-a-pull-request-review + The owner of the repository + The name of the repository + The Pull Request number + The review + + + + Creates a review. + + https://developer.github.com/v3/pulls/reviews/#create-a-pull-request-review + The Id of the repository + The Pull Request number + The review + + + + Deletes a pull request review. + + https://developer.github.com/v3/pulls/reviews/#delete-a-pending-review + The owner of the repository + The name of the repository + The pull request number + The pull request review number + + + + Deletes a pull request review. + + https://developer.github.com/v3/pulls/reviews/#delete-a-pending-review + The Id of the repository + The pull request number + The pull request review number + + + + Dismisses a pull request review. + + https://developer.github.com/v3/pulls/reviews/#dismiss-a-pull-request-review + The owner of the repository + The name of the repository + The pull request number + The pull request review number + The message indicating why the review was dismissed + + + + Dismisses a pull request review. + + https://developer.github.com/v3/pulls/reviews/#dismiss-a-pull-request-review + The Id of the repository + The pull request number + The pull request review number + The message indicating why the review was dismissed + + + + Submits a pull request review. + + https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review + The owner of the repository + The name of the repository + The pull request number + The pull request review number + The message and event being submitted for the review + + + + Submits a pull request review. + + https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review + The Id of the repository + The pull request number + The pull request review number + The message and event being submitted for the review + + + + Lists comments for a single review + + https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review + The owner of the repository + The name of the repository + The pull request number + The pull request review number + + + + Dismisses a pull request review. + + https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review + The Id of the repository + The pull request number + The pull request review number + + + + Lists comments for a single review + + https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review + The owner of the repository + The name of the repository + The pull request number + The pull request review number + Options for changing the API response + + + + Dismisses a pull request review. + + https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review + The Id of the repository + The pull request number + The pull request review number + Options for changing the API response + + + + A client for GitHub's Pull Requests API. + + + See the Pull Requests API documentation for more information. + + + + + Client for managing reviews. + + + + + Client for managing review comments. + + + + + Client for managing review requests. + + + + + Get a pull request by number. + + + http://developer.github.com/v3/pulls/#get-a-single-pull-request + + + + + Get a pull request by number. + + + http://developer.github.com/v3/pulls/#get-a-single-pull-request + + + + + Get all open pull requests for the repository. + + + http://developer.github.com/v3/pulls/#list-pull-requests + + The owner of the repository + The name of the repository + + + + Get all open pull requests for the repository. + + + http://developer.github.com/v3/pulls/#list-pull-requests + + The Id of the repository + + + + Get all open pull requests for the repository. + + + http://developer.github.com/v3/pulls/#list-pull-requests + + The owner of the repository + The name of the repository + Options for changing the API response + + + + Get all open pull requests for the repository. + + + http://developer.github.com/v3/pulls/#list-pull-requests + + The Id of the repository + Options for changing the API response + + + + Query pull requests for the repository based on criteria + + + http://developer.github.com/v3/pulls/#list-pull-requests + + The owner of the repository + The name of the repository + Used to filter and sort the list of pull requests returned + + + + Query pull requests for the repository based on criteria + + + http://developer.github.com/v3/pulls/#list-pull-requests + + The Id of the repository + Used to filter and sort the list of pull requests returned + + + + Query pull requests for the repository based on criteria + + + http://developer.github.com/v3/pulls/#list-pull-requests + + The owner of the repository + The name of the repository + Used to filter and sort the list of pull requests returned + Options for changing the API response + + + + Query pull requests for the repository based on criteria + + + http://developer.github.com/v3/pulls/#list-pull-requests + + The Id of the repository + Used to filter and sort the list of pull requests returned + Options for changing the API response + + + + Create a pull request for the specified repository. + + http://developer.github.com/v3/pulls/#create-a-pull-request + The owner of the repository + The name of the repository + A instance describing the new PullRequest to create + + + + Create a pull request for the specified repository. + + http://developer.github.com/v3/pulls/#create-a-pull-request + The Id of the repository + A instance describing the new PullRequest to create + + + + Create a pull request for the specified repository. + + http://developer.github.com/v3/pulls/#update-a-pull-request + The owner of the repository + The name of the repository + The PullRequest number + An instance describing the changes to make to the PullRequest + + + + + Create a pull request for the specified repository. + + http://developer.github.com/v3/pulls/#update-a-pull-request + The Id of the repository + The PullRequest number + An instance describing the changes to make to the PullRequest + + + + + Merge a pull request. + + http://developer.github.com/v3/pulls/#merge-a-pull-request-merge-buttontrade + The owner of the repository + The name of the repository + The pull request number + A instance describing a pull request merge + + + + Merge a pull request. + + http://developer.github.com/v3/pulls/#merge-a-pull-request-merge-buttontrade + The Id of the repository + The pull request number + A instance describing a pull request merge + + + + Get the pull request merge status. + + http://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged + The owner of the repository + The name of the repository + The pull request number + + + + Get the pull request merge status. + + http://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged + The Id of the repository + The pull request number + + + + Get the list of commits on a pull request. + + http://developer.github.com/v3/pulls/#list-commits-on-a-pull-request + The owner of the repository + The name of the repository + The pull request number + + + + Get the list of commits on a pull request. + + http://developer.github.com/v3/pulls/#list-commits-on-a-pull-request + The Id of the repository + The pull request number + + + + Get the list of files on a pull request. + + https://developer.github.com/v3/pulls/#list-pull-requests-files + The owner of the repository + The name of the repository + The pull request number + + + + Get the list of files on a pull request. + + https://developer.github.com/v3/pulls/#list-pull-requests-files + The Id of the repository + The pull request number + + + + Instantiates a new GitHub Reactions API client + + An API connection + + + + Access GitHub's Reactions API for Commit Comments. + + + Refer to the API documentation for more information: https://developer.github.com/v3/reactions/ + + + + + Access GitHub's Reactions API for Issues. + + + Refer to the API documentation for more information: https://developer.github.com/v3/reactions/ + + + + + Access GitHub's Reactions API for Issue Comments. + + + Refer to the API documentation for more information: https://developer.github.com/v3/reactions/ + + + + + Access GitHub's Reactions API for Pull Request Review Comments. + + + Refer to the API documentation for more information: https://developer.github.com/v3/reactions/ + + + + + Delete a reaction. + + https://developer.github.com/v3/reactions/#delete-a-reaction + The reaction id + + + + + A client for GitHub's References API. + + + See the References API documentation for more information. + + + + + Instantiates a new GitHub References API client + + An API connection + + + + Gets a reference for a given repository by reference name + + + http://developer.github.com/v3/git/refs/#get-a-reference + + The owner of the repository + The name of the repository + The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" + + + + + Gets a reference for a given repository by reference name + + + http://developer.github.com/v3/git/refs/#get-a-reference + + The Id of the repository + The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" + + + + + Gets all references for a given repository + + + http://developer.github.com/v3/git/refs/#get-all-references + + The owner of the repository + The name of the repository + + + + + Gets all references for a given repository + + + http://developer.github.com/v3/git/refs/#get-all-references + + The owner of the repository + The name of the repository + Options for changing the API response + + + + + Gets all references for a given repository + + + http://developer.github.com/v3/git/refs/#get-all-references + + The Id of the repository + + + + + Gets all references for a given repository + + + http://developer.github.com/v3/git/refs/#get-all-references + + The Id of the repository + Options for changing the API response + + + + + Gets references for a given repository by sub-namespace, i.e. "tags" or "heads" + + + http://developer.github.com/v3/git/refs/#get-all-references + + The owner of the repository + The name of the repository + The sub-namespace to get references for + + + + + Gets references for a given repository by sub-namespace, i.e. "tags" or "heads" + + + http://developer.github.com/v3/git/refs/#get-all-references + + The owner of the repository + The name of the repository + The sub-namespace to get references for + Options for changing the API response + + + + + Gets references for a given repository by sub-namespace, i.e. "tags" or "heads" + + + http://developer.github.com/v3/git/refs/#get-all-references + + The Id of the repository + The sub-namespace to get references for + + + + + Gets references for a given repository by sub-namespace, i.e. "tags" or "heads" + + + http://developer.github.com/v3/git/refs/#get-all-references + + The Id of the repository + The sub-namespace to get references for + Options for changing the API response + + + + + Creates a reference for a given repository + + + http://developer.github.com/v3/git/refs/#create-a-reference + + The owner of the repository + The name of the repository + The reference to create + + + + + Creates a reference for a given repository + + + http://developer.github.com/v3/git/refs/#create-a-reference + + The Id of the repository + The reference to create + + + + + Updates a reference for a given repository by reference name + + + http://developer.github.com/v3/git/refs/#update-a-reference + + The owner of the repository + The name of the repository + The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" + The updated reference data + + + + + Updates a reference for a given repository by reference name + + + http://developer.github.com/v3/git/refs/#update-a-reference + + The Id of the repository + The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" + The updated reference data + + + + + Deletes a reference for a given repository by reference name + + + http://developer.github.com/v3/git/refs/#delete-a-reference + + The owner of the repository + The name of the repository + The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" + + + + + Deletes a reference for a given repository by reference name + + + http://developer.github.com/v3/git/refs/#delete-a-reference + + The Id of the repository + The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" + + + + + A client for GitHub's Releases API. + + + See the Releases API documentation for more information. + + + + + Initializes a new GitHub Releases API client. + + An API connection + + + + Gets all s for the specified repository. + + + See the API documentation for more information. + + The repository's owner + The repository's name + Thrown when a general API error occurs. + + + + Gets all s for the specified repository. + + + See the API documentation for more information. + + The Id of the repository + Thrown when a general API error occurs. + + + + Gets all s for the specified repository. + + + See the API documentation for more information. + + The repository's owner + The repository's name + Options for changing the API response + Thrown when a general API error occurs. + + + + Gets all s for the specified repository. + + + See the API documentation for more information. + + The Id of the repository + Options for changing the API response + Thrown when a general API error occurs. + + + + Gets a single for the specified repository. + + + See the API documentation for more information. + + The repository's owner + The repository's name + The id of the release + Thrown when a general API error occurs. + + + + Gets a single for the specified repository. + + + See the API documentation for more information. + + The repository's owner + The repository's name + The tag of the release + Thrown when a general API error occurs. + + + + Gets a single for the specified repository. + + + See the API documentation for more information. + + The Id of the repository + The id of the release + Thrown when a general API error occurs. + + + + Gets a single for the specified repository. + + + See the API documentation for more information. + + The Id of the repository + The tag of the release + Thrown when a general API error occurs. + + + + Gets the latest for the specified repository. + + + See the API documentation for more information. + + The repository's owner + The repository's name + Thrown when a general API error occurs. + + + + Gets the latest for the specified repository. + + + See the API documentation for more information. + + The Id of the repository + Thrown when a general API error occurs. + + + + Creates a new for the specified repository. + + + See the API documentation for more information. + + The repository's owner + The repository's name + A description of the release to create + Thrown when a general API error occurs. + + + + Creates a new for the specified repository. + + + See the API documentation for more information. + + The Id of the repository + A description of the release to create + Thrown when a general API error occurs. + + + + Edits an existing for the specified repository. + + + See the API documentation for more information. + + The repository's owner + The repository's name + The id of the release + A description of the release to edit + Thrown when a general API error occurs. + + + + Edits an existing for the specified repository. + + + See the API documentation for more information. + + The Id of the repository + The id of the release + A description of the release to edit + Thrown when a general API error occurs. + + + + Deletes an existing for the specified repository. + + + See the API documentation for more information. + + The repository's owner + The repository's name + The id of the release to delete + Thrown when a general API error occurs. + + + + Deletes an existing for the specified repository. + + + See the API documentation for more information. + + The Id of the repository + The id of the release to delete + Thrown when a general API error occurs. + + + + Gets all for the specified release of the specified repository. + + + See the API documentation for more information. + + The repository's owner + The repository's name + The id of the . + Thrown when a general API error occurs. + + + + Gets all for the specified release of the specified repository. + + + See the API documentation for more information. + + The Id of the repository + The id of the . + Thrown when a general API error occurs. + + + + Gets all for the specified release of the specified repository. + + + See the API documentation for more information. + + The repository's owner + The repository's name + The id of the . + Options for changing the API response + Thrown when a general API error occurs. + + + + Gets all for the specified release of the specified repository. + + + See the API documentation for more information. + + The Id of the repository + The id of the . + Options for changing the API response + Thrown when a general API error occurs. + + + + Uploads a for the specified release. + + + See the API documentation for more information. + + The to attach the uploaded asset to + Description of the asset with its data + Thrown when a general API error occurs. + + + + Gets the specified for the specified release of the specified repository. + + + See the API documentation for more information. + + The repository's owner + The repository's name + The id of the + + + + Gets the specified for the specified release of the specified repository. + + + See the API documentation for more information. + + The Id of the repository + The id of the + + + + Edits the for the specified release of the specified repository. + + + See the API documentation for more information. + + The repository's owner + The repository's name + The id of the + Description of the asset with its amended data + + + + Edits the for the specified release of the specified repository. + + + See the API documentation for more information. + + The Id of the repository + The id of the + Description of the asset with its amended data + + + + Deletes the specified from the specified repository + + + See the API documentation for more information. + + The repository's owner + The repository's name + The id of the . + + + + Deletes the specified from the specified repository + + + See the API documentation for more information. + + The Id of the repository + The id of the . + + + + A client for GitHub's Collaborators on a Repository. + + + See the Collaborators API documentation for more details. + + + + + Initializes a new GitHub Repo Collaborators API client. + + An API connection. + + + + Gets all the collaborators on a repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Thrown when a general API error occurs. + + + + Gets all the collaborators on a repository. + + + See the API documentation for more information. + + The id of the repository + Thrown when a general API error occurs. + + + + Gets all the collaborators on a repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Options for changing the API response + Thrown when a general API error occurs. + + + + Gets all the collaborators on a repository. + + + See the API documentation for more information. + + The id of the repository + Options for changing the API response + Thrown when a general API error occurs. + + + + Checks if a user is a collaborator on a repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Username of the prospective collaborator + Thrown when a general API error occurs. + + + + Checks if a user is a collaborator on a repository. + + + See the API documentation for more information. + + The id of the repository + Username of the prospective collaborator + Thrown when a general API error occurs. + + + + Review a user's permission level in a repository + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Username of the collaborator to check permission for + Thrown when a general API error occurs. + + + + Review a user's permission level in a repository + + + See the API documentation for more information. + + The id of the repository + Username of the collaborator to check permission for + Thrown when a general API error occurs. + + + + Adds a new collaborator to the repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Username of the new collaborator + Thrown when a general API error occurs. + + + + Adds a new collaborator to the repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Username of the new collaborator + The permission to set. Only valid on organization-owned repositories. + Thrown when a general API error occurs. + + + + Adds a new collaborator to the repository. + + + See the API documentation for more information. + + The id of the repository + Username of the new collaborator + Thrown when a general API error occurs. + + + + Adds a new collaborator to the repository. + + + See the API documentation for more information. + + The id of the repository + Username of the new collaborator + The permission to set. Only valid on organization-owned repositories. + Thrown when a general API error occurs. + + + + Invites a new collaborator to the repo + + + See the API documentation for more information. + + The owner of the repository. + The name of the repository. + The name of the user to invite. + Thrown when a general API error occurs. + + + + Invites a new collaborator to the repo + + + See the API documentation for more information. + + The owner of the repository. + The name of the repository. + The name of the user to invite. + The permission to set. Only valid on organization-owned repositories. + Thrown when a general API error occurs. + + + + Invites a new collaborator to the repo + + + See the API documentation for more information. + + The id of the repository. + The name of the user to invite. + Thrown when a general API error occurs. + + + + Invites a new collaborator to the repo + + + See the API documentation for more information. + + The id of the repository. + The name of the user to invite. + The permission to set. Only valid on organization-owned repositories. + Thrown when a general API error occurs. + + + + Deletes a collaborator from the repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Username of the deleted collaborator + Thrown when a general API error occurs. + + + + Deletes a collaborator from the repository. + + + See the API documentation for more information. + + The id of the repository + Username of the deleted collaborator + Thrown when a general API error occurs. + + + + A client for GitHub's Repositories API. + + + See the Repositories API documentation for more details. + + + + + Initializes a new GitHub Repos API client. + + An API connection + + + + Creates a new repository for the current user. + + + See the API documentation for more information. + + A instance describing the new repository to create + Thrown when a general API error occurs. + A instance for the created repository. + + + + Creates a new repository in the specified organization. + + + See the API documentation for more information. + + Login of the organization in which to create the repository + A instance describing the new repository to create + Thrown when a general API error occurs. + A instance for the created repository + + + + Deletes the specified repository. + + + See the API documentation for more information. + Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. + + The owner of the repository + The name of the repository + Thrown when a general API error occurs. + + + + Deletes the specified repository. + + + See the API documentation for more information. + Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. + + The Id of the repository + Thrown when a general API error occurs. + + + + Transfers the ownership of the specified repository. + + + See the API documentation for more information. + + The current owner of the repository + The name of the repository + Repository transfer information + A + + + + Transfers the ownership of the specified repository. + + + See the API documentation for more information. + + The id of the repository + Repository transfer information + A + + + + Updates the specified repository with the values given in + + The owner of the repository + The name of the repository + New values to update the repository with + The updated + + + + Updates the specified repository with the values given in + + The Id of the repository + New values to update the repository with + The updated + + + + Gets the specified repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Thrown when a general API error occurs. + A + + + + Gets the specified repository. + + + See the API documentation for more information. + + The Id of the repository + Thrown when a general API error occurs. + A + + + + Gets all public repositories. + + + See the API documentation for more information. + The default page size on GitHub.com is 30. + + Thrown if the client is not authenticated. + Thrown when a general API error occurs. + A of . + + + + Gets all public repositories since the integer Id of the last Repository that you've seen. + + + See the API documentation for more information. + The default page size on GitHub.com is 30. + + Search parameters of the last repository seen + Thrown if the client is not authenticated. + Thrown when a general API error occurs. + A of . + + + + Gets all repositories owned by the current user. + + + See the API documentation for more information. + The default page size on GitHub.com is 30. + + Thrown if the client is not authenticated. + Thrown when a general API error occurs. + A of . + + + + Gets all repositories owned by the current user. + + + See the API documentation for more information. + + Options for changing the API response + Thrown if the client is not authenticated. + Thrown when a general API error occurs. + A of . + + + + Gets all repositories owned by the current user. + + + See the API documentation for more information. + The default page size on GitHub.com is 30. + + Search parameters to filter results on + Thrown if the client is not authenticated. + Thrown when a general API error occurs. + A of . + + + + Gets all repositories owned by the specified user. + + + See the API documentation for more information. + The default page size on GitHub.com is 30. + + The account name to search for + Thrown when a general API error occurs. + A of . + + + + Gets all repositories owned by the specified user. + + + See the API documentation for more information. + + The account name to search for + Options for changing the API response + Thrown when a general API error occurs. + A of . + + + + Gets all repositories owned by the specified organization. + + + See the API documentation for more information. + The default page size on GitHub.com is 30. + + Thrown when a general API error occurs. + A of . + + + + Gets all repositories owned by the specified organization. + + + See the API documentation for more information. + + The organization name to search for + Options for changing the API response + Thrown when a general API error occurs. + A of . + + + + A client for GitHub's Repository Branches API. + + + See the Branches API documentation for more details + + + + + A client for GitHub's Commit Status API. + + + See the Commit Status API documentation for more + details. Also check out the blog post + that announced this feature. + + + + + A client for GitHub's Repository Hooks API. + + See Hooks API documentation for more information. + + + + A client for GitHub's Repository Forks API. + + See Forks API documentation for more information. + + + + A client for GitHub's Repo Collaborators. + + + See the Collaborators API documentation for more details + + + + + Client for GitHub's Repository Deployments API + + + See the Deployments API documentation for more details + + + + + Client for GitHub's Repository Statistics API + + + See the Statistics API documentation for more details + + + + + Client for GitHub's Repository Commits API + + + See the Commits API documentation for more details + + + + + Access GitHub's Releases API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/repos/releases/ + + + + + Client for GitHub's Repository Merging API + + + See the Merging API documentation for more details + + + + + Client for managing pull requests. + + + See the Pull Requests API documentation for more details + + + + + Client for managing commit comments in a repository. + + + See the Repository Comments API documentation for more information. + + + + + Client for managing deploy keys in a repository. + + + See the Repository Deploy Keys API documentation for more information. + + + + + Client for managing the contents of a repository. + + + See the Repository Contents API documentation for more information. + + + + + Gets all contributors for the specified repository. Does not include anonymous contributors. + + + See the API documentation for more details + + The owner of the repository + The name of the repository + All contributors of the repository. + + + + Gets all contributors for the specified repository. Does not include anonymous contributors. + + + See the API documentation for more details + + The Id of the repository + All contributors of the repository. + + + + Gets all contributors for the specified repository. Does not include anonymous contributors. + + + See the API documentation for more details + + The owner of the repository + The name of the repository + Options for changing the API response + All contributors of the repository. + + + + Gets all contributors for the specified repository. Does not include anonymous contributors. + + + See the API documentation for more details + + The Id of the repository + Options for changing the API response + All contributors of the repository. + + + + Gets all contributors for the specified repository. With the option to include anonymous contributors. + + + See the API documentation for more details + + The owner of the repository + The name of the repository + True if anonymous contributors should be included in result; Otherwise false + All contributors of the repository. + + + + Gets all contributors for the specified repository. With the option to include anonymous contributors. + + + See the API documentation for more details + + The Id of the repository + True if anonymous contributors should be included in result; Otherwise false + All contributors of the repository. + + + + Gets all contributors for the specified repository. With the option to include anonymous contributors. + + + See the API documentation for more details + + The owner of the repository + The name of the repository + True if anonymous contributors should be included in result; Otherwise false + Options for changing the API response + All contributors of the repository. + + + + Gets all contributors for the specified repository. With the option to include anonymous contributors. + + + See the API documentation for more details + + The Id of the repository + True if anonymous contributors should be included in result; Otherwise false + Options for changing the API response + All contributors of the repository. + + + + Gets all languages for the specified repository. + + + See the API documentation for more details + + The owner of the repository + The name of the repository + All languages used in the repository and the number of bytes of each language. + + + + Gets all languages for the specified repository. + + + See the API documentation for more details + + The Id of the repository + All languages used in the repository and the number of bytes of each language. + + + + Gets all teams for the specified repository. + + + See the API documentation for more details + + The owner of the repository + The name of the repository + All s associated with the repository + + + + Gets all teams for the specified repository. + + + See the API documentation for more details + + The Id of the repository + All s associated with the repository + + + + Gets all teams for the specified repository. + + + See the API documentation for more details + + The owner of the repository + The name of the repository + Options for changing the API response + All s associated with the repository + + + + Gets all teams for the specified repository. + + + See the API documentation for more details + + The Id of the repository + Options for changing the API response + All s associated with the repository + + + + Gets all tags for the specified repository. + + + See the API documentation for more details + + The owner of the repository + The name of the repository + All of the repositories tags. + + + + Gets all tags for the specified repository. + + + See the API documentation for more details + + The Id of the repository + All of the repositories tags. + + + + Gets all tags for the specified repository. + + + See the API documentation for more details + + The owner of the repository + The name of the repository + Options for changing the API response + All of the repositories tags. + + + + Gets all tags for the specified repository. + + + See the API documentation for more details + + The Id of the repository + Options for changing the API response + All of the repositories tags. + + + + Get the contents of a repository's license + + + See the API documentation for more details + + The owner of the repository + The name of the repository + Returns the contents of the repository's license file, if one is detected. + + + + Get the contents of a repository's license + + + See the API documentation for more details + + The Id of the repository + Returns the contents of the repository's license file, if one is detected. + + + + A client for GitHub's Repository Pages API. + + + See the Repository Pages API documentation for more information. + + + + + A client for GitHub's Repository Invitations API. + + + See the Repository Invitations API documentation for more information. + + + + + Access GitHub's Repository Traffic API + + + Refer to the API documentation for more information: https://developer.github.com/v3/repos/traffic/ + + + + + Access GitHub's Repository Projects API + + + Refer to the API documentation for more information: https://developer.github.com/v3/repos/projects/ + + + + + A client for GitHub's Repository Branches API. + + + See the Repository Branches API documentation for more details. + + + + + Initializes a new GitHub Repository Branches API client. + + An API connection + + + + Gets all the branches for the specified repository. + + + See the API documentation for more details + + The owner of the repository + The name of the repository + + + + Gets all the branches for the specified repository. + + + See the API documentation for more details + + The Id of the repository + + + + Gets all the branches for the specified repository. + + + See the API documentation for more details + + The owner of the repository + The name of the repository + Options for changing the API response + Thrown when a general API error occurs. + + + + Gets all the branches for the specified repository. + + + See the API documentation for more details + + The Id of the repository + Options for changing the API response + + + + Gets the specified branch. + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Gets the specified branch. + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Get the branch protection settings for the specified branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Get the branch protection settings for the specified branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Update the branch protection settings for the specified branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + Branch protection settings + + + + Update the branch protection settings for the specified branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + Branch protection settings + + + + Remove the branch protection settings for the specified branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Remove the branch protection settings for the specified branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Get the required status checks for the specified branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Get the required status checks for the specified branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Replace required status checks for the specified branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + Required status checks + + + + Replace required status checks for the specified branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + Required status checks + + + + Remove required status checks for the specified branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Remove required status checks for the specified branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Get the required status checks contexts for the specified branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Get the required status checks contexts for the specified branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Replace the required status checks contexts for the specified branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + The contexts to replace + + + + Replace the required status checks contexts for the specified branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + The contexts to replace + + + + Add the required status checks context for the specified branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + The contexts to add + + + + Add the required status checks contexts for the specified branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + The contexts to add + + + + Remove the required status checks context for the specified branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + The contexts to remove + + + + Remove the required status checks contexts for the specified branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + The contexts to remove + + + + Get required pull request review enforcement of protected branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Get required pull request review enforcement of protected branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Update required pull request review enforcement of protected branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + The required pull request review settings + + + + Update required pull request review enforcement of protected branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + The required pull request review settings + + + + Remove required pull request review enforcement of protected branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Remove required pull request review enforcement of protected branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Get admin enforcement of protected branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Get admin enforcement of protected branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Add admin enforcement to protected branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Add admin enforcement to protected branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Remove admin enforcement on protected branch + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Remove admin enforcement on protected branch + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Get restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Get restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Remove restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Remove restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Get team restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Get team restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Replace team restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + List of teams with push access + + + + Replace team restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The Id of the repository + The name of the branch + List of teams with push access + + + + Add team restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + List of teams with push access to add + + + + Add team restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The Id of the repository + The name of the branch + List of teams with push access to add + + + + Remove team restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + List of teams to remove + + + + Remove team restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The Id of the repository + The name of the branch + List of teams to remove + + + + Get user restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + + + + Get user restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The Id of the repository + The name of the branch + + + + Replace user restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + List of users with push access + + + + Replace user restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The Id of the repository + The name of the branch + List of users with push access + + + + Add user restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + List of users with push access to add + + + + Add user restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The Id of the repository + The name of the branch + List of users with push access to add + + + + Remove user restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The owner of the repository + The name of the repository + The name of the branch + List of users with push access to remove + + + + Remove user restrictions for the specified branch (applies only to Organization owned repositories) + + + See the API documentation for more details + + The Id of the repository + The name of the branch + List of users with push access to remove + + + + A client for GitHub's Repository Comments API. + + + See the Repository Comments API documentation for more information. + + + + + Instantiates a new GitHub Repository Comments API client. + + An API connection + + + + Gets a single Repository Comment by number. + + The owner of the repository + The name of the repository + The comment id + http://developer.github.com/v3/repos/comments/#get-a-single-commit-comment + + + + Gets a single Repository Comment by number. + + The Id of the repository + The comment id + http://developer.github.com/v3/repos/comments/#get-a-single-commit-comment + + + + Gets Commit Comments for a repository. + + The owner of the repository + The name of the repository + http://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository + + + + Gets Commit Comments for a repository. + + The Id of the repository + http://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository + + + + Gets Commit Comments for a repository. + + The owner of the repository + The name of the repository + Options to change the API response + http://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository + + + + Gets Commit Comments for a repository. + + The Id of the repository + Options to change the API response + http://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository + + + + Gets Commit Comments for a specified Commit. + + The owner of the repository + The name of the repository + The sha of the commit + http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit + + + + Gets Commit Comments for a specified Commit. + + The Id of the repository + The sha of the commit + http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit + + + + Gets Commit Comments for a specified Commit. + + The owner of the repository + The name of the repository + The sha of the commit + Options to change the API response + http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit + + + + Gets Commit Comments for a specified Commit. + + The Id of the repository + The sha of the commit + Options to change the API response + http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit + + + + Creates a new Commit Comment for a specified Commit. + + The owner of the repository + The name of the repository + The sha reference of commit + The new comment to add to the commit + http://developer.github.com/v3/repos/comments/#create-a-commit-comment + + + + Creates a new Commit Comment for a specified Commit. + + The Id of the repository + The sha reference of commit + The new comment to add to the commit + http://developer.github.com/v3/repos/comments/#create-a-commit-comment + + + + Updates a specified Commit Comment. + + The owner of the repository + The name of the repository + The comment number + The modified comment + http://developer.github.com/v3/repos/comments/#update-a-commit-comment + + + + Updates a specified Commit Comment. + + The Id of the repository + The comment number + The modified comment + http://developer.github.com/v3/repos/comments/#update-a-commit-comment + + + + Deletes the specified Commit Comment + + The owner of the repository + The name of the repository + The comment id + http://developer.github.com/v3/repos/comments/#delete-a-commit-comment + + + + Deletes the specified Commit Comment + + The Id of the repository + The comment id + http://developer.github.com/v3/repos/comments/#delete-a-commit-comment + + + + A client for GitHub's Repository Commits API. + + + See the Repository Commits API documentation for more information. + + + + + Compare two references in a repository + + The owner of the repository + The name of the repository + The reference to use as the base commit + The reference to use as the head commit + + + + Compare two references in a repository + + The Id of the repository + The reference to use as the base commit + The reference to use as the head commit + + + + Gets a single commit for a given repository + + The owner of the repository + The name of the repository + The reference for the commit (SHA) + + + + Gets a single commit for a given repository + + The Id of the repository + The reference for the commit (SHA) + + + + Gets all commits for a given repository + + The owner of the repository + The name of the repository + + + + Gets all commits for a given repository + + The Id of the repository + + + + Gets all commits for a given repository + + The owner of the repository + The name of the repository + Options for changing the API response + + + + Gets all commits for a given repository + + The Id of the repository + Options for changing the API response + + + + Gets all commits for a given repository + + The owner of the repository + The name of the repository + Used to filter list of commits returned + + + + Gets all commits for a given repository + + The Id of the repository + Used to filter list of commits returned + + + + Gets all commits for a given repository + + The owner of the repository + The name of the repository + Used to filter list of commits returned + Options for changing the API response + + + + Gets all commits for a given repository + + The Id of the repository + Used to filter list of commits returned + Options for changing the API response + + + + Get the SHA-1 of a commit reference + + The owner of the repository + The name of the repository + The repository reference + + + + Get the SHA-1 of a commit reference + + The Id of the repository + The repository reference + + + + Client for accessing contents of files within a repository as base64 encoded content. + + + See the Repository Contents API documentation for more information. + + + + + Create an instance of the RepositoryContentsClient + + The underlying connection to use + + + + Returns the contents of a file or directory in a repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The content path + + + + Returns the contents of a file or directory in a repository. + + + See the API documentation for more information. + + The Id of the repository + The content path + + + + Returns the contents of the root directory in a repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + + + + Returns the contents of the root directory in a repository. + + + See the API documentation for more information. + + The Id of the repository + + + + Returns the contents of a file or directory in a repository. + + + If given a path to a single file, this method returns a collection containing only that file. + See the API documentation for more information. + + The owner of the repository + The name of the repository + The content path + The name of the commit/branch/tag. Default: the repository�s default branch (usually master) + + + + Returns the contents of a file or directory in a repository. + + + See the API documentation for more information. + + The Id of the repository + The content path + The name of the commit/branch/tag. Default: the repository’s default branch (usually master) + + + + Returns the contents of the root directory in a repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + The name of the commit/branch/tag. Default: the repository�s default branch (usually master) + + + + Returns the contents of the root directory in a repository. + + + If given a path to a single file, this method returns a collection containing only that file. + See the API documentation for more information. + + The Id of the repository + The name of the commit/branch/tag. Default: the repository’s default branch (usually master) + + + + Gets the preferred README for the specified repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Thrown when a general API error occurs. + + + + Gets the preferred README for the specified repository. + + + See the API documentation for more information. + + The Id of the repository + Thrown when a general API error occurs. + + + + Gets the preferred README's HTML for the specified repository. + + + See the API documentation for more information. + + The owner of the repository + The name of the repository + Thrown when a general API error occurs. + + + + Gets the preferred README's HTML for the specified repository. + + + See the API documentation for more information. + + The Id of the repository + Thrown when a general API error occurs. + + + + Get an archive of a given repository's contents + + https://developer.github.com/v3/repos/contents/#get-archive-link + The owner of the repository + The name of the repository + + + + Get an archive of a given repository's contents + + https://developer.github.com/v3/repos/contents/#get-archive-link + The Id of the repository + + + + Get an archive of a given repository's contents, in a specific format + + https://developer.github.com/v3/repos/contents/#get-archive-link + The owner of the repository + The name of the repository + The format of the archive. Can be either tarball or zipball + + + + Get an archive of a given repository's contents, in a specific format + + https://developer.github.com/v3/repos/contents/#get-archive-link + The Id of the repository + The format of the archive. Can be either tarball or zipball + + + + Get an archive of a given repository's contents, using a specific format and reference + + https://developer.github.com/v3/repos/contents/#get-archive-link + The owner of the repository + The name of the repository + The format of the archive. Can be either tarball or zipball + A valid Git reference. + + + + Get an archive of a given repository's contents, using a specific format and reference + + https://developer.github.com/v3/repos/contents/#get-archive-link + The Id of the repository + The format of the archive. Can be either tarball or zipball + A valid Git reference. + + + + Get an archive of a given repository's contents, in a specific format + + https://developer.github.com/v3/repos/contents/#get-archive-link + The owner of the repository + The name of the repository + The format of the archive. Can be either tarball or zipball + A valid Git reference. + Time span until timeout + + + + Get an archive of a given repository's contents, in a specific format + + https://developer.github.com/v3/repos/contents/#get-archive-link + The Id of the repository + The format of the archive. Can be either tarball or zipball + A valid Git reference. + Time span until timeout + + + + Creates a commit that creates a new file in a repository. + + The owner of the repository + The name of the repository + The path to the file + Information about the file to create + + + + Creates a commit that creates a new file in a repository. + + The Id of the repository + The path to the file + Information about the file to create + + + + Creates a commit that updates the contents of a file in a repository. + + The owner of the repository + The name of the repository + The path to the file + Information about the file to update + + + + Creates a commit that updates the contents of a file in a repository. + + The Id of the repository + The path to the file + Information about the file to update + + + + Creates a commit that deletes a file in a repository. + + The owner of the repository + The name of the repository + The path to the file + Information about the file to delete + + + + Creates a commit that deletes a file in a repository. + + The Id of the repository + The path to the file + Information about the file to delete + + + + A client for GitHub's Repository Deploy Keys API. + + + See the Deploy Keys API documentation for more information. + + + + + Instantiates a new GitHub repository deploy keys API client. + + The API connection. + + + + Get a single deploy key by number for a repository. + + + See the API documentation for more information. + + The owner of the repository. + The name of the repository. + The id of the deploy key. + + + + Get a single deploy key by number for a repository. + + + See the API documentation for more information. + + The Id of the repository. + The id of the deploy key. + + + + Get all deploy keys for a repository. + + + See the API documentation for more information. + + The owner of the repository. + The name of the repository. + + + + Get all deploy keys for a repository. + + + See the API documentation for more information. + + The Id of the repository. + + + + Get all deploy keys for a repository. + + + See the API documentation for more information. + + The owner of the repository. + The name of the repository. + Options for changing the API response + + + + Get all deploy keys for a repository. + + + See the API documentation for more information. + + The Id of the repository. + Options for changing the API response + + + + Creates a new deploy key for a repository. + + + See the API documentation for more information. + + The owner of the repository. + The name of the repository. + The deploy key to create for the repository. + + + + Creates a new deploy key for a repository. + + + See the API documentation for more information. + + The Id of the repository. + The deploy key to create for the repository. + + + + Deletes a deploy key from a repository. + + + See the API documentation for more information. + + The owner of the repository. + The name of the repository. + The id of the deploy key to delete. + + + + Deletes a deploy key from a repository. + + + See the API documentation for more information. + + The Id of the repository. + The id of the deploy key to delete. + + + + A client for GitHub's Repository Forks API. + + + See the Forks API documentation for more information. + + + + + Initializes a new GitHub Repos Fork API client. + + An API connection. + + + + Gets the list of forks defined for a repository + + + See API documentation for more information. + + The owner of the repository + The name of the repository + + + + Gets the list of forks defined for a repository + + + See API documentation for more information. + + The Id of the repository + + + + Gets the list of forks defined for a repository + + + See API documentation for more information. + + The owner of the repository + The name of the repository + Options for changing the API response + + + + Gets the list of forks defined for a repository + + + See API documentation for more information. + + The Id of the repository + Options for changing the API response + + + + Gets the list of forks defined for a repository + + + See API documentation for more information. + + The owner of the repository + The name of the repository + Used to request and filter a list of repository forks + + + + Gets the list of forks defined for a repository + + + See API documentation for more information. + + The Id of the repository + Used to request and filter a list of repository forks + + + + Gets the list of forks defined for a repository + + + See API documentation for more information. + + The owner of the repository + The name of the repository + Used to request and filter a list of repository forks + Options for changing the API response + + + + Gets the list of forks defined for a repository + + + See API documentation for more information. + + The Id of the repository + Used to request and filter a list of repository forks + Options for changing the API response + + + + Creates a fork for a repository. Specify organization in the fork parameter to create for an organization. + + + See API documentation for more information. + + The owner of the repository + The name of the repository + Used to fork a repository + + + + Creates a fork for a repository. Specify organization in the fork parameter to create for an organization. + + + See API documentation for more information. + + The Id of the repository + Used to fork a repository + + + + A client for GitHub's Repository Webhooks API. + + + See the Webhooks API documentation for more information. + + + + + Initializes a new GitHub Webhooks API client. + + An API connection. + + + + Gets the list of hooks defined for a repository + + The repository's owner + The repository's name + See API documentation for more information. + + + + Gets the list of hooks defined for a repository + + The Id of the repository + See API documentation for more information. + + + + Gets the list of hooks defined for a repository + + The repository's owner + The repository's name + Options for changing the API response + See API documentation for more information. + + + + Gets the list of hooks defined for a repository + + The Id of the repository + Options for changing the API response + See API documentation for more information. + + + + Gets a single hook by Id + + The repository's owner + The repository's name + The repository's hook id + See API documentation for more information. + + + + Gets a single hook by Id + + The Id of the repository + The repository's hook id + See API documentation for more information. + + + + Creates a hook for a repository + + The repository's owner + The repository's name + The hook's parameters + See API documentation for more information. + + + + Creates a hook for a repository + + The Id of the repository + The hook's parameters + See API documentation for more information. + + + + Edits a hook for a repository + + The repository's owner + The repository's name + The repository's hook id + The requested changes to an edit repository hook + See API documentation for more information. + + + + Edits a hook for a repository + + The Id of the repository + The repository's hook id + The requested changes to an edit repository hook + See API documentation for more information. + + + + Tests a hook for a repository + + The repository's owner + The repository's name + The repository's hook id + See API documentation for more information. + This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook + is not subscribed to push events, the server will respond with 204 but no test POST will be generated. + + + + Tests a hook for a repository + + The Id of the repository + The repository's hook id + See API documentation for more information. + This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook + is not subscribed to push events, the server will respond with 204 but no test POST will be generated. + + + + This will trigger a ping event to be sent to the hook. + + The repository's owner + The repository's name + The repository's hook id + See API documentation for more information. + + + + This will trigger a ping event to be sent to the hook. + + The Id of the repository + The repository's hook id + See API documentation for more information. + + + + Deletes a hook for a repository + + The repository's owner + The repository's name + The repository's hook id + See API documentation for more information. + + + + Deletes a hook for a repository + + The Id of the repository + The repository's hook id + See API documentation for more information. + + + + Accept a repository invitation. + + + See the API documentation for more information. + + The id of the invitation + Thrown when a general API error occurs. + + + + Decline a repository invitation. + + + See the API documentation for more information. + + The id of the invitation + Thrown when a general API error occurs. + + + + Deletes a repository invitation. + + + See the API documentation for more information. + + The id of the repository + The id of the invitation + Thrown when a general API error occurs. + + + + Gets all invitations for the current user. + + + See the API documentation for more information. + + Thrown when a general API error occurs. + + + + Gets all invitations for the current user. + + + See the API documentation for more information. + + Options for changing the API response + Thrown when a general API error occurs. + + + + Gets all the invitations on a repository. + + + See the API documentation for more information. + + The id of the repository + Thrown when a general API error occurs. + + + + Gets all the invitations on a repository. + + + See the API documentation for more information. + + The id of the repository + Options for changing the API response + Thrown when a general API error occurs. + + + + Updates a repository invitation. + + + See the API documentation for more information. + + The id of the repository + The id of the invitation + The permission for the collsborator + Thrown when a general API error occurs. + + + + A client for GitHub's Repository Pages API. + + + See the Repository Pages API documentation for more information. + + + + + Initializes a new GitHub Repository Pages API client. + + An API connection. + + + + Gets the page metadata for a given repository + + The owner of the repository + The name of the repository + + See the API documentation for more information. + + + + + Gets the page metadata for a given repository + + The Id of the repository + + See the API documentation for more information. + + + + + Gets all build metadata for a given repository + + The owner of the repository + The name of the repository + + See the API documentation for more information. + + + + + Gets all build metadata for a given repository + + The Id of the repository + + See the API documentation for more information. + + + + + Gets all build metadata for a given repository + + The owner of the repository + The name of the repository + Options to change the API response + + See the API documentation for more information. + + + + + Gets all build metadata for a given repository + + The Id of the repository + Options to change the API response + + See the API documentation for more information. + + + + + Gets the build metadata for the last build for a given repository + + The owner of the repository + The name of the repository + + See the API documentation for more information. + + + + + Gets the build metadata for the last build for a given repository + + The Id of the repository + + See the API documentation for more information. + + + + + Requests your site be built from the latest revision on the default branch for a given repository + + The owner of the repository + The name of the repository + + See the API documentation for more information. + + + + + Requests your site be built from the latest revision on the default branch for a given repository + + The Id of the repository + + See the API documentation for more information. + + + + + List the top 10 popular contents over the last 14 days + + https://developer.github.com/v3/repos/traffic/#list-paths + The owner of the repository + + + + List the top 10 popular contents over the last 14 days + + https://developer.github.com/v3/repos/traffic/#list-paths + The owner of the repository + The name of the repository + + + + List the top 10 referrers over the last 14 days + + https://developer.github.com/v3/repos/traffic/#list-referrers + The owner of the repository + + + + List the top 10 referrers over the last 14 days + + https://developer.github.com/v3/repos/traffic/#list-referrers + The owner of the repository + The name of the repository + + + + Get the total number of clones and breakdown per day or week for the last 14 days + + https://developer.github.com/v3/repos/traffic/#clones + The owner of the repository + Breakdown per day or week + + + + Get the total number of clones and breakdown per day or week for the last 14 days + + https://developer.github.com/v3/repos/traffic/#clones + The owner of the repository + The name of the repository + Breakdown per day or week + + + + Get the total number of views and breakdown per day or week for the last 14 days + + https://developer.github.com/v3/repos/traffic/#views + The owner of the repository + Breakdown per day or week + + + + Get the total number of views and breakdown per day or week for the last 14 days + + https://developer.github.com/v3/repos/traffic/#views + The owner of the repository + The name of the repository + Breakdown per day or week + + + + A client for GitHub's Search API. + + + See the Search API documentation for more information. + + + + + Initializes a new GitHub Search API client. + + An API connection. + + + + search repos + http://developer.github.com/v3/search/#search-repositories + + + List of repos + + + + search users + http://developer.github.com/v3/search/#search-users + + + List of users + + + + search issues + http://developer.github.com/v3/search/#search-issues + + + List of issues + + + + search code + http://developer.github.com/v3/search/#search-code + + + List of files + + + + search labels + https://developer.github.com/v3/search/#search-labels + + + List of labels + + + + A client for GitHub's Activity Starring API. + + + See the Activity Starring API documentation for more information. + + + + + Instantiates a new GitHub Activity Starring API client. + + An API connection + + + + Retrieves all of the stargazers for the passed repository. + + The owner of the repository + The name of the repository + Thrown if the client is not authenticated. + + + + Retrieves all of the stargazers for the passed repository. + + The Id of the repository + Thrown if the client is not authenticated. + + + + Retrieves all of the stargazers for the passed repository. + + The owner of the repository + The name of the repository + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the stargazers for the passed repository. + + The Id of the repository + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the stargazers for the passed repository with star creation timestamps. + + The owner of the repository + The name of the repository + Thrown if the client is not authenticated. + + + + Retrieves all of the stargazers for the passed repository with star creation timestamps. + + The Id of the repository + Thrown if the client is not authenticated. + + + + Retrieves all of the stargazers for the passed repository with star creation timestamps. + + The owner of the repository + The name of the repository + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the stargazers for the passed repository with star creation timestamps. + + The Id of the repository + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the starred (ies) for the current user. + + Thrown if the client is not authenticated. + + + + Retrieves all of the starred (ies) for the current user. + + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the starred (ies) for the current user with star creation timestamps. + + Thrown if the client is not authenticated. + + + + Retrieves all of the starred (ies) for the current user with star creation timestamps. + + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the starred (ies) for the current user. + + Star-specific request parameters that sort the results + Thrown if the client is not authenticated. + + + + Retrieves all of the starred (ies) for the current user. + + Star-specific request parameters that sort the results + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the starred (ies) for the current user with star creation timestamps. + + Star-specific request parameters that sort the results + Thrown if the client is not authenticated. + + + + Retrieves all of the starred (ies) for the current user with star creation timestamps. + + Star-specific request parameters that sort the results + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the (ies) starred by the specified user. + + The login of the user + Thrown if the client is not authenticated. + + + + Retrieves all of the (ies) starred by the specified user. + + The login of the user + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the (ies) starred by the specified user with star creation timestamps. + + The login of the user + Thrown if the client is not authenticated. + + + + Retrieves all of the (ies) starred by the specified user with star creation timestamps. + + The login of the user + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the (ies) starred by the specified user. + + The login of the user + Star-specific request parameters that sort the results + Thrown if the client is not authenticated. + + + + Retrieves all of the (ies) starred by the specified user. + + The login of the user + Star-specific request parameters that sort the results + Options for changing the API response + Thrown if the client is not authenticated. + + + + Retrieves all of the (ies) starred by the specified user with star creation timestamps. + + The login of the user + Star-specific request parameters that sort the results + Thrown if the client is not authenticated. + + + + Retrieves all of the (ies) starred by the specified user with star creation timestamps. + + The login of the user + Star-specific request parameters that sort the results + Options for changing the API response + Thrown if the client is not authenticated. + + + + Check if a repository is starred by the current authenticated user. + + The owner of the repository + The name of the repository + Thrown if the client is not authenticated. + + + + Stars a repository for the authenticated user. + + The owner of the repository to star + The name of the repository to star + + + + Unstars a repository for the authenticated user. + + The owner of the repository to unstar + The name of the repository to unstar + + + + A client for GitHub's Repository Statistics API. + + + See the Repository Statistics API documentation for more information. + + + + + Instantiates a new GitHub Statistics API client. + + An API connection + + + + Returns a list of for the given repository + + The owner of the repository + The name of the repository + + + + Returns a list of for the given repository + + The Id of the repository + + + + Returns a list of for the given repository + + The owner of the repository + The name of the repository + A token used to cancel this potentially long running request + + + + Returns a list of for the given repository + + The Id of the repository + A token used to cancel this potentially long running request + + + + Returns the last year of commit activity grouped by week. + + The owner of the repository + The name of the repository + + + + Returns the last year of commit activity grouped by week. + + The Id of the repository + + + + Returns the last year of commit activity grouped by week. + + The owner of the repository + The name of the repository + A token used to cancel this potentially long running request + + + + Returns the last year of commit activity grouped by week. + + The Id of the repository + A token used to cancel this potentially long running request + + + + Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + + The owner of the repository + The name of the repository + + + + Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + + The Id of the repository + + + + Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + + The owner of the repository + The name of the repository + A token used to cancel this potentially long running request + + + + Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + + The Id of the repository + A token used to cancel this potentially long running request + + + + Returns the total commit counts for the owner and total commit counts in total. + + The owner of the repository + The name of the repository + + + + Returns the total commit counts for the owner and total commit counts in total. + + The Id of the repository + + + + Returns the total commit counts for the owner and total commit counts in total. + + The owner of the repository + The name of the repository + A token used to cancel this potentially long running request + + + + Returns the total commit counts for the owner and total commit counts in total. + + The Id of the repository + A token used to cancel this potentially long running request + + + + Returns a list of the number of commits per hour in each day + + The owner of the repository + The name of the repository + + + + Returns a list of the number of commits per hour in each day + + The Id of the repository + + + + Returns a list of the number of commits per hour in each day + + The owner of the repository + The name of the repository + A token used to cancel this potentially long running request + + + + Returns a list of the number of commits per hour in each day + + The Id of the repository + A token used to cancel this potentially long running request + + + + A client for GitHub's Git Tags API. + + + See the Git Tags API documentation for more information. + + + + + Instantiates a new GitHub Git Tags API client. + + An API connection + + + + Gets a tag for a given repository by sha reference + + + http://developer.github.com/v3/git/tags/#get-a-tag + + The owner of the repository + The name of the repository + Tha sha reference of the tag + + + + Gets a tag for a given repository by sha reference + + + http://developer.github.com/v3/git/tags/#get-a-tag + + The Id of the repository + Tha sha reference of the tag + + + + Create a tag for a given repository + + + http://developer.github.com/v3/git/tags/#create-a-tag-object + + The owner of the repository + The name of the repository + The tag to create + + + + Create a tag for a given repository + + + http://developer.github.com/v3/git/tags/#create-a-tag-object + + The Id of the repository + The tag to create + + + + A client for GitHub's Organization Teams API. + + + See the Organization Teams API documentation for more information. + + + + + Initializes a new GitHub Orgs Team API client. + + An API connection. + + + + Gets a single by identifier. + + + https://developer.github.com/v3/orgs/teams/#get-team + + The team identifier. + The with the given identifier. + + + + Returns all s for the current org. + + Organization to list teams of. + Thrown when a general API error occurs. + A list of the orgs's teams s. + + + + Returns all s for the current org. + + Organization to list teams of. + Options to change API behaviour. + Thrown when a general API error occurs. + A list of the orgs's teams s. + + + + Returns all s for the current user. + + Thrown when a general API error occurs. + A list of the user's s. + + + + Returns all s for the current user. + + Options to change API behaviour. + Thrown when a general API error occurs. + A list of the user's s. + + + + Returns all child teams of the given team. + + The team identifier + + https://developer.github.com/v3/orgs/teams/#list-child-teams + + + + + Returns all child teams of the given team. + + + https://developer.github.com/v3/orgs/teams/#list-child-teams + + The team identifier + Options to change API behaviour. + + + + Returns all members of the given team. + + + https://developer.github.com/v3/orgs/teams/#list-team-members + + The team identifier + + + + Returns all members of the given team. + + + https://developer.github.com/v3/orgs/teams/#list-team-members + + The team identifier + Options to change API behaviour. + + + + Returns all members with the specified role in the given team of the given role. + + + https://developer.github.com/v3/orgs/teams/#list-team-members + + The team identifier + The request filter + + + + Returns all members with the specified role in the given team of the given role. + + + https://developer.github.com/v3/orgs/teams/#list-team-members + + The team identifier + The request filter + Options to change API behaviour. + + + + Gets whether the user with the given + is a member of the team with the given . + A is thrown if the user is not a member. + + + See the API documentation for more information. + + The team to check. + The user to check. + + + + Returns newly created for the current org. + + Thrown when a general API error occurs. + Newly created + + + + Returns updated for the current org. + + Thrown when a general API error occurs. + Updated + + + + Delte a team - must have owner permissions to this + + Thrown when a general API error occurs. + + + + + Adds a to a . + + + See the API documentation for more information. + + The team identifier. + The user to add to the team. + Additional parameters for the request + + + + Removes a from a . + + + See the API documentation for more information. + + The team identifier. + The user to remove from the team. + if the user was removed from the team; otherwise. + + + + Returns all team's repositories. + + Team Id. + Thrown when a general API error occurs. + The team's repositories + + + + Returns all team's repositories. + + Team Id. + Options to change API behaviour. + Thrown when a general API error occurs. + The team's repositories + + + + Add a repository to the team + + Thrown when a general API error occurs. + + + + + Add a repository to the team + + The team identifier. + Org to associate the repo with. + Name of the repo. + The permission to grant the team on this repository. + Thrown when a general API error occurs. + + + + + Remove a repository from the team + + Thrown when a general API error occurs. + + + + + Gets whether or not the given repository is managed by the given team. + + The team identifier + Owner of the org the team is associated with. + Name of the repo. + + See the API documentation for more information. + + if the repository is managed by the given team; otherwise. + + + + List all pending invitations for the given team. + + + See the API Documentation + for more information. + + The team identifier + + + + + List all pending invitations for the given team. + + + See the API Documentation + for more information. + + The team identifier + Options to change API behaviour + + + + + A client for GitHub's Git Trees API. + + + See the Git Trees API documentation for more information. + + + + + Instantiates a new GitHub Git Trees API client. + + An API connection + + + + Gets a Tree Response for a given SHA. + + + http://developer.github.com/v3/git/trees/#get-a-tree + + The owner of the repository + The name of the repository + The SHA that references the tree + + + + Gets a Tree Response for a given SHA. + + + http://developer.github.com/v3/git/trees/#get-a-tree + + The Id of the repository + The SHA that references the tree + + + + Gets a Tree Response for a given SHA. + + + https://developer.github.com/v3/git/trees/#get-a-tree-recursively + + The owner of the repository + The name of the repository + The SHA that references the tree + + + + Gets a Tree Response for a given SHA. + + + https://developer.github.com/v3/git/trees/#get-a-tree-recursively + + The Id of the repository + The SHA that references the tree + + + + Creates a new Tree in the specified repo + + + http://developer.github.com/v3/git/trees/#create-a-tree + + The owner of the repository + The name of the repository + The value of the new tree + + + + Creates a new Tree in the specified repo + + + http://developer.github.com/v3/git/trees/#create-a-tree + + The Id of the repository + The value of the new tree + + + + A client for GitHub's User Administration API (GitHub Enterprise) + + + See the Administration API documentation for more details. + + + + + Initializes a new instance of the class. + + The client's connection + + + + Create a new user (must be Site Admin user). + + + See the API documentation + for more information. + + The object describing the user to create + The created object + + + + Rename an existing user (must be Site Admin user). + + + See the API documentation + for more information. + Note that this queues a request to rename a user, rather than execute it straight away + + The username to rename + The request, specifying the new login + A object indicating the queued task message and Url to the user + + + + Create an impersonation OAuth token (must be Site Admin user). + + + See the API documentation + for more information. + + The user to impersonate + The request specifying the required scopes + An object containing the impersonation token + + + + Deletes an impersonation OAuth token (must be Site Admin user). + + + See the API documentation + for more information. + + The user to remove impersonation token from + + + + + Promotes ordinary user to a site administrator (must be Site Admin user). + + + See the API documentation + for more information. + + The user to promote to administrator. + + + + + Demotes a site administrator to an ordinary user (must be Site Admin user). + + + See the API documentation + for more information. + + The user to demote from administrator. + + + + + Suspends a user (must be Site Admin user). + + + See the API documentation + for more information. + + The user to suspend. + + + + + Unsuspends a user (must be Site Admin user). + + + See the API documentation + for more information. + + The user to unsuspend. + + + + + List all public keys (must be Site Admin user). + + + See the API documentation + for more information. + + + + + + Delete a user (must be Site Admin user). + + + See the API documentation + for more information. + + The user to delete + + + + + Delete a public key (must be Site Admin user). + + + See the API documentation + for more information. + + The key to delete + + + + + A client for GitHub's User Emails API. + + + See the User Emails API documentation for more information. + + + + + Instantiates a new GitHub User Emails API client. + + An API connection + + + + Gets all email addresses for the authenticated user. + + + http://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user + + The es for the authenticated user. + + + + Gets all email addresses for the authenticated user. + + + http://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user + + The es for the authenticated user. + + + + Adds email addresses for the authenticated user. + + + http://developer.github.com/v3/users/emails/#add-email-addresses + + The email addresses to add. + Returns the added es. + + + + Deletes email addresses for the authenticated user. + + + http://developer.github.com/v3/users/emails/#delete-email-addresses + + The email addresses to delete. + Returns the added es. + + + + A client for GitHub's UserUser GPG Keys API. + + + See the User GPG Keys documentation for more information. + + + + + Instatiates a new GitHub User GPG Keys API client. + + The API connection. + + + + Gets all GPG keys for the authenticated user. + + + See the API documentation for more information. + + A of s for the current user. + + + + Gets all GPG keys for the authenticated user. + + Options for changing the API response + + See the API documentation for more information. + + A of s for the current user. + + + + View extended details of the for the specified id. + + The Id of the GPG key + + See the API documentation for more information. + + The for the specified Id. + + + + Creates a new for the authenticated user. + + The new GPG key to add. + + See the API documentation for more information. + + The newly created . + + + + Deletes the GPG key for the specified Id. + + The Id of the GPG key to delete. + + See the API documentation for more information. + + + + + + A client for GitHub's User Keys API. + + + See the User Keys API documentation for more information. + + + + + Gets all verified public keys for a user. + + + https://developer.github.com/v3/users/keys/#list-public-keys-for-a-user + + The @ handle of the user. + Lists the verified public keys for a user. + + + + Gets all verified public keys for a user. + + + https://developer.github.com/v3/users/keys/#list-public-keys-for-a-user + + The @ handle of the user. + Options to change API's behavior. + Lists the verified public keys for a user. + + + + Gets all public keys for the authenticated user. + + + https://developer.github.com/v3/users/keys/#list-your-public-keys + + Lists the current user's keys. + + + + Gets all public keys for the authenticated user. + + + https://developer.github.com/v3/users/keys/#list-your-public-keys + + Options to chagne API's behavior. + Lists the current user's keys. + + + + Retrieves the for the specified id. + + + https://developer.github.com/v3/users/keys/#get-a-single-public-key + + The Id of the SSH key + + + + + Create a public key . + + + https://developer.github.com/v3/users/keys/#create-a-public-key + + The SSH Key contents + + + + + Delete a public key. + + + https://developer.github.com/v3/users/keys/#delete-a-public-key + + The id of the key to delete + + + + + A client for GitHub's Users API. + + + See the Users API documentation for more information. + + + + + Instantiates a new GitHub Users API client. + + An API connection + + + + A client for GitHub's User Emails API + + + See the Emails API documentation for more information. + + + + + A client for GitHub's User Keys API + + + See the Keys API documentation for more information. + + + + + A client for GitHub's UserUser GPG Keys API. + + + See the User GPG Keys documentation for more information. + + + + + Returns the user specified by the login. + + The login name for the user + + + + Returns a for the current authenticated user. + + Thrown if the client is not authenticated. + A + + + + Update the specified . + + The login for the user + Thrown if the client is not authenticated. + A + + + + A client for GitHub's User Followers API + + + See the Followers API documentation for more information. + + + + + A client for GitHub's User Administration API + + + See the User Administration API documentation for more information. + + + + + A client for GitHub's Watching API. + + + See the Watching API documentation for more information. + + + + + Instantiates a new GitHub Activity Watching API client. + + An API connection + + + + Retrieves all of the watchers for the passed repository. + + The owner of the repository + The name of the repository + Thrown if the client is not authenticated. + + + + Retrieves all of the watchers for the passed repository. + + The Id of the repository + Thrown if the client is not authenticated. + + + + Retrieves all of the watchers for the passed repository. + + The owner of the repository + The name of the repository + Options for changing API's response. + Thrown if the client is not authenticated. + + + + Retrieves all of the watchers for the passed repository. + + The Id of the repository + Options for changing API's response. + Thrown if the client is not authenticated. + + + + Retrieves all of the watched (ies) for the current user. + + Thrown if the client is not authenticated. + + A of (ies) watched by the current authenticated user. + + + + + Retrieves all of the watched (ies) for the current user. + + Options for changing API's response. + Thrown if the client is not authenticated. + + A of (ies) watched by the current authenticated user. + + + + + Retrieves all of the (ies) watched by the specified user. + + The login of the user + Thrown if the client is not authenticated. + + A (ies) watched by the specified user. + + + + + Retrieves all of the (ies) watched by the specified user. + + The login of the user + Options for changing API's response. + Thrown if the client is not authenticated. + + A (ies) watched by the specified user. + + + + + Check if a repository is watched by the current authenticated user. + + The owner of the repository + The name of the repository + Thrown if the client is not authenticated. + + + + Check if a repository is watched by the current authenticated user. + + The Id of the repository + Thrown if the client is not authenticated. + + + + Watches a repository for the authenticated user. + + The owner of the repository to star + The name of the repository to star + A instance describing the new subscription to create + + + + Watches a repository for the authenticated user. + + The Id of the repository + A instance describing the new subscription to create + + + + Unwatches a repository for the authenticated user. + + The owner of the repository to unstar + The name of the repository to unstar + + + + Unwatches a repository for the authenticated user. + + The Id of the repository + + + + Represents a subset of the HTTP 403 - Forbidden response returned from the API when the forbidden response is related to an abuse detection mechanism. + Containts the amount of seconds after which it's safe to retry the request. + + + + + Constructs an instance of AbuseException + + The HTTP payload from the server + + + + Constructs an instance of AbuseException + + The HTTP payload from the server + The inner exception + + + + Constructs an instance of AbuseException + + + The that holds the + serialized object data about the exception being thrown. + + + The that contains + contextual information about the source or destination. + + + + + Represents errors that occur from the GitHub API. + + + + + Constructs an instance of ApiException + + + + + Constructs an instance of ApiException + + The error message + The HTTP status code from the response + + + + Constructs an instance of ApiException + + The error message + The inner exception + + + + Constructs an instance of ApiException + + The HTTP payload from the server + + + + Constructs an instance of ApiException + + The HTTP payload from the server + The inner exception + + + + Constructs an instance of ApiException + + The inner exception + + + + The HTTP status code associated with the repsonse + + + + + The raw exception payload from the response + + + + + Constructs an instance of ApiException. + + + The that holds the + serialized object data about the exception being thrown. + + + The that contains + contextual information about the source or destination. + + + + + Get the inner error message from the API response + + + Returns null if ApiError is not populated + + + + + Get the inner http response body from the API response + + + Returns empty string if HttpResponse is not populated or if + response body is not a string + + + + + Represents a HTTP 422 - Unprocessable Entity response returned from the API. + + + + + Constructs an instance of ApiValidationException + + + + + Constructs an instance of ApiValidationException + + The HTTP payload from the server + + + + Constructs an instance of ApiValidationException + + The HTTP payload from the server + The inner exception + + + + Constructs an instance of ApiValidationException + + The inner exception + + + + Constructs an instance of ApiValidationException + + + The that holds the + serialized object data about the exception being thrown. + + + The that contains + contextual information about the source or destination. + + + + + Represents a HTTP 401 - Unauthorized response returned from the API. + + + + + Constructs an instance of AuthorizationException + + + + + Constructs an instance of AuthorizationException + + The HTTP payload from the server + + + + Constructs an instance of AuthorizationException + + The HTTP payload from the server + The inner exception + + + + Constructs an instance of AuthorizationException. + + + The that holds the + serialized object data about the exception being thrown. + + + The that contains + contextual information about the source or destination. + + + + + Represents a HTTP 403 - Forbidden response returned from the API. + + + + + Constructs an instance of ForbiddenException + + The HTTP payload from the server + + + + Constructs an instance of ForbiddenException + + The HTTP payload from the server + The inner exception + + + + Constructs an instance of ForbiddenException + + + The that holds the + serialized object data about the exception being thrown. + + + The that contains + contextual information about the source or destination. + + + + + Represents a HTTP 403 - Forbidden response returned from the API. + + + + + Constructs an instance of ApiValidationException + + + + + Constructs an instance of ApiValidationException + + The inner validation exception. + + + + Constructs an instance of InvalidGitignoreTemplateException + + + The that holds the + serialized object data about the exception being thrown. + + + The that contains + contextual information about the source or destination. + + + + + Represents a HTTP 451 - Unavailable For Legal Reasons response returned from the API. + This will returned if GitHub has been asked to takedown the requested resource due to + a DMCA takedown. + + + + + Constructs an instance of LegalRestrictionException + + The HTTP payload from the server + + + + Constructs an instance of LegalRestrictionException + + The exception message + The http status code returned by the response + + + + Constructs an instance of LegalRestrictionException + + The HTTP payload from the server + The inner exception + + + + Constructs an instance of LegalRestrictionException + + + The that holds the + serialized object data about the exception being thrown. + + + The that contains + contextual information about the source or destination. + + + + + Represents a "Login Attempts Exceeded" response returned from the API. + + + + + Constructs an instance of LoginAttemptsExceededException + + The HTTP payload from the server + + + + Constructs an instance of LoginAttemptsExceededException + + The HTTP payload from the server + The inner exception + + + + Constructs an instance of LoginAttemptsExceededException + + + The that holds the + serialized object data about the exception being thrown. + + + The that contains + contextual information about the source or destination. + + + + + Represents a HTTP 404 - Not Found response returned from the API. + + + + + Constructs an instance of NotFoundException + + The HTTP payload from the server + + + + Constructs an instance of NotFoundException + + The exception message + The http status code returned by the response + + + + Constructs an instance of NotFoundException + + The HTTP payload from the server + The inner exception + + + + Constructs an instance of NotFoundException + + + The that holds the + serialized object data about the exception being thrown. + + + The that contains + contextual information about the source or destination. + + + + + Exception thrown when creating a private repository, but the user's private quota is or would be exceeded + by creating it. + + + + + Constructs an instance of PrivateRepositoryQuotaExceededException. + + The inner validation exception. + + + + Constructs an instance of PrivateRepositoryQuotaExceededException + + + The that holds the + serialized object data about the exception being thrown. + + + The that contains + contextual information about the source or destination. + + + + + Represents an error that occurs when the specified SHA + doesn't match the current pull request's HEAD + + + + + Constructs an instace of . + + + + + + Constructs an instance of . + + The HTTP payload from the server + The inner exception + + + + Constructs an instance of . + + + The that holds the + serialized object data about the exception being thrown. + + + The that contains + contextual information about the source or destination. + + + + + Represents an error that occurs when the pull request is in an + unmergeable state + + + + + Constructs an instance of the class. + + The HTTP payload from the server + + + + Constructs an instance of the class. + + The HTTP payload from the server + The inner exception + + + + Constructs an instance of . + + + The that holds the + serialized object data about the exception being thrown. + + + The that contains + contextual information about the source or destination. + + + + + Exception thrown when GitHub API Rate limits are exceeded. + + + + For requests using Basic Authentication or OAuth, you can make up to 5,000 requests per hour. For + unauthenticated requests, the rate limit allows you to make up to 60 requests per hour. + + See http://developer.github.com/v3/#rate-limiting for more details. + + + + + Constructs an instance of RateLimitExceededException + + The HTTP payload from the server + + + + Constructs an instance of RateLimitExceededException + + The HTTP payload from the server + The inner exception + + + + The maximum number of requests that the consumer is permitted to make per hour. + + + + + The number of requests remaining in the current rate limit window. + + + + + The date and time at which the current rate limit window resets + + + + + Constructs an instance of RateLimitExceededException + + + The that holds the + serialized object data about the exception being thrown. + + + The that contains + contextual information about the source or destination. + + + + + Exception thrown when creating a repository, but it already exists on the server. + + + + + Constructs an instance of RepositoryExistsException for an organization. + + The name of the organization of the existing repository + The name of the existing repository + The base address of the repository. + The inner validation exception. + + + + Constructs an instance of RepositoryExistsException for an account. + + The name of the existing repository + The inner validation exception + + + + The Name of the repository that already exists. + + + + + The URL to the existing repository's web page on github.com (or enterprise instance). + + + + + A useful default error message. + + + + + The login of the organization of the repository. + + + + + True if the owner is an organization and not the user. + + + + + Constructs an instance of RepositoryExistsException. + + + The that holds the + serialized object data about the exception being thrown. + + + The that contains + contextual information about the source or destination. + + + + + Constructs an instance of LoginAttemptsExceededException + + + The that holds the + serialized object data about the exception being thrown. + + + The that contains + contextual information about the source or destination. + + + + + Represents a failed 2FA challenge from the API + + + + + Constructs an instance of TwoFactorRequiredException. + + Expected 2FA response type + The inner exception + + + + Constructs an instance of TwoFactorRequiredException. + + The HTTP payload from the server + Expected 2FA response type + + + + Constructs an instance of TwoFactorRequiredException. + + The HTTP payload from the server + Expected 2FA response type + The inner exception + + + + Expected 2FA response type + + + + + Constructs an instance of TwoFactorRequiredException. + + + The that holds the + serialized object data about the exception being thrown. + + + The that contains + contextual information about the source or destination. + + + + + Methods for receiving 2FA authentication codes + + + + + No method configured + + + + + Unknown method + + + + + Receive via SMS + + + + + Receive via application + + + + + Represents a failed 2FA challenge from the API + + + + + Constructs an instance of TwoFactorChallengeFailedException + + + + + Constructs an instance of TwoFactorChallengeFailedException + + The authorization code that was incorrect + The inner exception + + + + Constructs an instance of TwoFactorChallengeFailedException. + + + The that holds the + serialized object data about the exception being thrown. + + + The that contains + contextual information about the source or destination. + + + + + + + + + + Constructs an instance of TwoFactorRequiredException. + + + + + Constructs an instance of TwoFactorRequiredException. + + Expected 2FA response type + + + + Constructs an instance of TwoFactorRequiredException. + + The HTTP payload from the server + Expected 2FA response type + + + + Constructs an instance of TwoFactorRequiredException. + + + The that holds the + serialized object data about the exception being thrown. + + + The that contains + contextual information about the source or destination. + + + + + Represents an error that occurs when trying to convert the + last owner of the organization to an outside collaborator + + + + + Constructs an instance of the class. + + The HTTP payload from the server + + + + Constructs an instance of the class. + + The HTTP payload from the server + The inner exception + + + + Constructs an instance of . + + + The that holds the + serialized object data about the exception being thrown. + + + The that contains + contextual information about the source or destination. + + + + + Represents an error that occurs when trying to convert a user + that is not a member of the organization to an outside collaborator + + + + + Constructs an instance of the class. + + The HTTP payload from the server + + + + Constructs an instance of the class. + + The HTTP payload from the server + The inner exception + + + + Constructs an instance of ForbiddenException + + + The that holds the + serialized object data about the exception being thrown. + + + The that contains + contextual information about the source or destination. + + + + + Represents an error that occurs when trying to remove an + outside collaborator that is a member of the organization + + + + + Constructs an instance of the class. + + The HTTP payload from the server + + + + Constructs an instance of the class. + + The HTTP payload from the server + The inner exception + + + + Constructs an instance of . + + + The that holds the + serialized object data about the exception being thrown. + + + The that contains + contextual information about the source or destination. + + + + + A Client for the GitHub API v3. You can read more about the api here: http://developer.github.com. + + + + + The base address for the GitHub API + + + + + Create a new instance of the GitHub API v3 client pointing to + https://api.github.com/ + + + See more information regarding User-Agent requirements here: https://developer.github.com/v3/#user-agent-required + + + The name (and optionally version) of the product using this library, the name of your GitHub organization, or your GitHub username (in that order of preference). This is sent to the server as part of + the user agent for analytics purposes, and used by GitHub to contact you if there are problems. + + + + + Create a new instance of the GitHub API v3 client pointing to + https://api.github.com/ + + + See more information regarding User-Agent requirements here: https://developer.github.com/v3/#user-agent-required + + + The name (and optionally version) of the product using this library, the name of your GitHub organization, or your GitHub username (in that order of preference). This is sent to the server as part of + the user agent for analytics purposes, and used by GitHub to contact you if there are problems. + + Provides credentials to the client when making requests + + + + Create a new instance of the GitHub API v3 client pointing to the specified baseAddress. + + + See more information regarding User-Agent requirements here: https://developer.github.com/v3/#user-agent-required + + + The name (and optionally version) of the product using this library, the name of your GitHub organization, or your GitHub username (in that order of preference). This is sent to the server as part of + the user agent for analytics purposes, and used by GitHub to contact you if there are problems. + + + The address to point this client to. Typically used for GitHub Enterprise + instances + + + + Create a new instance of the GitHub API v3 client pointing to the specified baseAddress. + + + See more information regarding User-Agent requirements here: https://developer.github.com/v3/#user-agent-required + + + The name (and optionally version) of the product using this library, the name of your GitHub organization, or your GitHub username (in that order of preference). This is sent to the server as part of + the user agent for analytics purposes, and used by GitHub to contact you if there are problems. + + Provides credentials to the client when making requests + + The address to point this client to. Typically used for GitHub Enterprise + instances + + + + Create a new instance of the GitHub API v3 client using the specified connection. + + The underlying used to make requests + + + + Set the GitHub Api request timeout. + Useful to set a specific timeout for lengthy operations, such as uploading release assets + + + See more information here: https://technet.microsoft.com/library/system.net.http.httpclient.timeout(v=vs.110).aspx + + The Timeout value + + + + Gets the latest API Info - this will be null if no API calls have been made + + representing the information returned as part of an Api call + + + + Convenience property for getting and setting credentials. + + + You can use this property if you only have a single hard-coded credential. Otherwise, pass in an + to the constructor. + Setting this property will change the to use + the default with just these credentials. + + + + + The base address of the GitHub API. This defaults to https://api.github.com, + but you can change it if needed (to talk to a GitHub:Enterprise server for instance). + + + + + Provides a client connection to make rest requests to HTTP endpoints. + + + + + Access GitHub's Authorization API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/oauth_authorizations/ + + + + + Access GitHub's Activity API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/activity/ + + + + + Access GitHub's Issue API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/issues/ + + + + + Access GitHub's Migration API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/migration/ + + + + + Access GitHub's Miscellaneous API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/misc/ + + + + + Access GitHub's OAuth API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/oauth/ + + + + + Access GitHub's Organizations API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/orgs/ + + + + + Access GitHub's Pull Requests API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/pulls/ + + + + + Access GitHub's Repositories API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/repos/ + + + + + Access GitHub's Gists API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/gists/ + + + + + Access GitHub's Users API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/users/ + + + + + Access GitHub's Git Data API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/git/ + + + + + Access GitHub's Apps API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/apps/ + + + + + Access GitHub's Search API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/search/ + + + + + Access GitHub's Enterprise API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/enterprise/ + + + + + Access GitHub's Reactions API + + + Refer to the API documentation for more information: https://developer.github.com/v3/reactions/ + + + + + Access GitHub's Checks API + + + Refer to the API documentation for more information: https://developer.github.com/v3/checks/ + + + + + Support for retrieving information about open source license usage on GitHub.com. + Custom media type: drax-preview Announced: 2015-03-09 Update 1: 2015-06-24 Update 2: 2015-08-04 + + + + + Combines multiple preview headers. GitHub API supports Accept header with multiple + values separated by comma. + + Accept header values that will be combine to single Accept header. + + This Accept header application/vnd.github.loki-preview+json,application/vnd.github.drax-preview+json + indicated we want both Protected Branches and Licenses preview APIs. + + Accept header value. + + + + Extensions for working with the + + + + + Gets all API resources in the list at the specified URI. + + Type of the API resource in the list. + The connection to use + URI of the API resource to get + of the The API resources in the list. + Thrown when an API error occurs. + + + + Gets the HTML content of the API resource at the specified URI. + + The connection to use + URI of the API resource to get + The API resource's HTML content. + Thrown when an API error occurs. + + + + Performs an asynchronous HTTP GET request that expects a containing HTML. + + The connection to use + URI endpoint to send request to + representing the received HTTP response + + + + Gets the API resource at the specified URI. + + Type of the API resource to get. + The connection to use + URI of the API resource to get + The API resource. + Thrown when an API error occurs. + + + + Gets the API resource at the specified URI. + + Type of the API resource to get. + The connection to use + URI of the API resource to get + A token used to cancel the GetResponse request + The API resource. + Thrown when an API error occurs. + + + + Returns true if the API call represents a true response, or false if it represents a false response. + Throws an exception if the HTTP status does not match either a true or false response. + + + Some API endpoints return a 204 for "true" and 404 for false. See https://developer.github.com/v3/activity/starring/#check-if-you-are-starring-a-repository + for one example. This encapsulates that logic. + + Thrown if the status is neither 204 nor 404 + True for a 204 response, False for a 404 + + + + + Class for retrieving GitHub API URLs + + + + + Returns the that returns all of the authorizations for the currently logged in user. + + + + + Returns the that returns all authorizations for a given user + + The user Id to search for + + + + Returns the that returns all authorizations for a given client + + + The 20 character OAuth app client key for which to create the token. + + + + + Returns the that returns all public repositories in + response to a GET request. + + + + + Returns the that returns all public repositories in + response to a GET request. + + The integer Id of the last Repository that you’ve seen. + + + + Returns the that returns all of the repositories for the currently logged in user in + response to a GET request. A POST to this URL creates a new repository. + + + + + + Returns the that returns all of the repositories for the specified login. + + The login for the user + + + + + Returns the that returns all of the repositories for the specified organization in + response to a GET request. A POST to this URL creates a new repository for the organization. + + The name of the organization + + + + + Returns the that returns all of the organizations for the currently logged in user. + + + + + + Returns the that returns all of the organizations for the specified login. + + The login for the user + + + + + Returns the that returns all of the organizations. + + + + + + Returns the that returns all of the organizations. + + /// The integer Id of the last Organization that you’ve seen. + + + + + Returns the that returns the organization for the specified organization name + + The name of the organization + The that returns the organization for the specified organization name + + + + Returns the that returns all of the SSH keys for the currently logged in user. + + + + + + Returns the that returns all of the SSH keys for the specified user. + + The login for the user + + + + + Returns the to retrieve keys for the current user. + + + + + Returns the to retrieve keys for a given user. + + The user to search on + + + + Returns the to retrieve a given key. + + The Key Id to retrieve + + + + Returns the that returns all of the email addresses for the currently logged in user. + + + + + + Returns the that returns all of the releases for the specified repository. + + The owner of the repository + The name of the repository + + + + + Returns the that returns a single release for the specified repository + + The owner of the repository + The name of the repository + The id of the release + + + + + Returns the that returns a single release for the specified repository + + The owner of the repository + The name of the repository + The tag of the release + + + + + Returns the that returns the latest release for the specified repository + + The owner of the repository + The name of the repository + + + + + Returns the that returns all the assets for the specified release for the specified repository. + + The owner of the repository + The name of the repository + The id of the release + + + + + Returns the that returns the assets specified by the asset id. + + The owner of the repository + The name of the repository + The id of the release asset + + + + + Returns the that returns all of the notifications for the currently logged in user. + + + + + + Returns the that returns all of the notifications for the currently logged in user + specific to the repository. + + The owner of the repository + The name of the repository + + + + + Returns the for the specified notification. + + The Id of the notification. + + + + + Returns the for the specified notification's subscription status. + + The Id of the notification. + + + + Returns the for creating a new installation token. + + The Id of the GitHub App installation. + + + + Returns the that creates a github app. + + + + + Returns the that creates a github app. + + + + + Returns the that returns all the installations of the authenticated application. + + + + + Returns the that lists repositories accessible to the user for an installation.. + + The id of the installation + + + + Returns the that returns the repository's installation information. + + + + + + Returns the that returns the repository's installation information. + + + + + + Returns the that returns the organization's installation information. + + + + + Returns the that returns the user's installation information. + + + + + Returns the that returns a single installation of the authenticated application. + + + + + Returns the that returns all the installations in repositories the user has explicit permission to access + + + + + Returns the that returns all the repositores + + + + + + Returns the that returns all of the issues across all the authenticated user’s visible + repositories including owned repositories, member repositories, and organization repositories: + + + + + Returns the that returns all of the issues across owned and member repositories for the + authenticated user: + + + + + Returns the that returns all of the issues for the currently logged in user + specific to the repository. + + The owner of the repository + The name of the repository + + + + + Returns the that returns all of the issues for the specified organization for the + currently logged in user. + + The name of the organization + + + + + Returns the for the specified issue. + + The owner of the repository + The name of the repository + The issue number + + + + + Returns the for the specified issue to be locked/unlocked. + + The owner of the repository + The name of the repository + The issue number + + + + + Returns the for the reaction of a specified issue. + + The owner of the repository + The name of the repository + The issue number + + + + + Returns the for the reaction of a specified issue. + + The Id of the repository + The issue number + + + + + Returns the for the timeline of a specified issue. + + The owner of the repository + The name of the repository + The issue number + + + + + Returns the for the timeline of a specified issue. + + The Id of the repository + The issue number + + + + + Returns the for the comments for all issues in a specific repo. + + The owner of the repository + The name of the repository + + + + + Returns the for the comments of a specified issue. + + The owner of the repository + The name of the repository + The issue number + + + + + Returns the for the specified comment. + + The owner of the repository + The name of the repository + The comment id + + + + + Returns the for the reaction of a specified issue comment. + + The owner of the repository + The name of the repository + The comment number + + + + + Returns the for the reaction of a specified issue comment. + + The owner of the repository + The comment number + + + + + Returns the for the specified comment. + + The owner of the repository + The name of the repository + The comment number + + + + + Returns the for the comments of a specified commit. + + The owner of the repository + The name of the repository + The sha of the commit + + + + + Returns the for the comments of a specified commit. + + The owner of the repository + The name of the repository + + + + + Returns the for the reaction of a specified commit comment. + + The owner of the repository + The name of the repository + The comment number + + + + + Returns the for the reaction of a specified commit comment. + + The Id of the repository + The comment number + + + + + Returns the that returns all of the assignees to which issues may be assigned. + + The owner of the repository + The name of the repository + + + + + Returns the that returns a 204 if the login belongs to an assignee of the repository. + Otherwire returns a 404. + + The owner of the repository + The name of the repository + The login for the user + + + + + Returns the to add and remove assignees for an issue. + + The owner of the repository + The name of the repository + The issue number + + + + + Returns the that returns all of the members of the organization + + The organization + + + + + Returns the that returns all of the members of the organization + + The organization + The member filter, + The correct uri + + + + Returns the that returns all of the members of the organization + + The organization + The role filter, + The correct uri + + + + Returns the that returns all of the members of the organization + + The organization + The member filter, + The role filter, + The correct uri + + + + Returns the that returns all of the public members of the organization + + Organization + + + + + Returns the that returns a 204 if requester is an organization member and + the user is, publicly or privately a member of the organization. + Returns a 404 if the requester is an organization member and the user is not a member or + the requester is not an organization member and is inquiring about themselves. + Returns a 302 if the requester is not an organization member. + + The organization being inquired about + The user being inquired about + + + + + Returns the that returns member of organization + + The organization being inquired about + The user being inquired about + The that returns member of organization + + + + Returns the that returns a 204 if the user is a public member of the + organization. + Otherwise returns a 404. + + The organization being inquired about + The user being inquired about + + + + + Returns the that returns a 204 if the user is publicizing, or concealing + their membership in an organization. + + The organization to publicize, or conceal their membership of + The user publicizing, or concealing their membership of the organization + + + + + Returns the for the organizations pending invitations + + The name of the organization + + + + + Returns the that returns all of the outside collaborators of the organization + + The organization + + + + + Returns the that returns all of the outside collaborators of the organization + + The organization + The collaborator filter, + The correct uri + + + + Returns the that returns the issue/pull request event and issue info for the specified repository. + + The owner of the repository + The name of the repository + + + + + Returns the that returns the issue/pull request event info for the specified issue. + + The owner of the repository + The name of the repository + The issue number + + + + + Returns the that returns the issue/pull request event and issue info for the specified repository. + + The owner of the repository + The name of the repository + + + + + Returns the that returns the issue/pull request event and issue info for the specified event. + + The owner of the repository + The name of the repository + The event id + + + + + Returns the that returns the specified milestone. + + The owner of the repository + The name of the repository + The milestone number + + + + + Returns the that returns all of the milestones for the specified repository. + + The owner of the repository + The name of the repository + + + + + Returns the that returns the specified label. + + The owner of the repository + The name of the repository + The name of label + + + + + Returns the that returns all of the labels for the specified repository. + + The owner of the repository + The name of the repository + + + + + Returns the that returns the named label for the specified issue. + + The owner of the repository + The name of the repository + The issue number + The name of the label + + + + + Returns the that returns all of the labels for the specified issue. + + The owner of the repository + The name of the repository + The issue number + + + + + Returns the that returns all of the labels for all issues in the specified milestone. + + The owner of the repository + The name of the repository + The milestone number + + + + + Returns the to use when creating a commit status for the specified reference. + + The owner of the repository + The name of the repository + The reference (SHA, branch name, or tag name) to list commits for + + + + + Returns the that lists the repository hooks for the specified reference. + + The owner of the repository + The name of the repository + + + + + Returns the that gets the repository hook for the specified reference. + + The owner of the repository + The name of the repository + The identifier of the repository hook + + + + + Returns the that can tests a specified repository hook + + The owner of the repository + The name of the repository + The identifier of the repository hook + + + + + Returns the that can ping a specified repository hook + + The owner of the repository + The name of the repository + The identifier of the repository hook + + + + + Returns the that lists the commit statuses for the specified reference. + + The owner of the repository + The name of the repository + The reference (SHA, branch name, or tag name) to list commits for + + + + + Returns the that returns a combined view of commit statuses for the specified reference. + + The owner of the repository + The name of the repository + The reference (SHA, branch name, or tag name) to list commits for + + + + + Returns the that lists the repository forks for the specified reference. + + The owner of the repository + The name of the repository + + + + + Returns the that lists the watched repositories for the authenticated user. + + The owner of the repository + The name of the repository + The that lists the watched repositories for the authenticated user. + + + + Returns the that lists the watched repositories for the authenticated user. + + + + + Returns the that lists the watched repositories for the specified user. + + The user that has the watches + + + + Returns the that shows whether the repo is starred by the current user. + + The owner of the repository + The name of the repository + + + + + Returns the that lists the starred repositories for the authenticated user. + + The owner of the repository + The name of the repository + The that lists the starred repositories for the authenticated user. + + + + Returns the that lists the starred repositories for the authenticated user. + + + + + Returns the that lists the starred repositories for the specified user. + + The user that has the stars + + + + Returns the that shows whether the repo is starred by the current user. + + The owner of the repository + The name of the repository + + + + + Returns the for the specified tag. + + The owner of the repository + The name of the repository + The tag reference (SHA) + + + + + Returns the for creating a tag object. + + The owner of the repository + The name of the repository + + + + + Returns the that returns the list of public events. + + + + + + Returns the that returns the feeds available to the authenticating user. + + + + + + Returns the that returns the list of public gists. + + + + + Returns the for the specified gist. + + The id of the gist + + + + Returns the for the forks for the specified gist. + + The id of the gist + + + + Returns the for all public gists. + + + + + Returns the for all started public gists. + + + + + Returns the for all gists for a given user. + + The user to search for + + + + Returns the to star a given gist. + + The id of the gist + + + + Returns the for the comments for the specified gist. + + The id of the gist + + + + Returns the for the commits for the specified gist. + + The id of the gist + + + + Returns the that returns the specified pull request. + + The owner of the repository + The name of the repository + The pull request number + + + + + Returns the that lists the pull requests for a repository. + + The owner of the repository + The name of the repository + + + + + Returns the that returns the pull request merge state. + + The owner of the repository + The name of the repository + The pull request number + The that returns the pull request merge state. + + + + Returns the that returns the commits on a pull request. + + The owner of the repository + The name of the repository + The pull request number + The that returns the commits on a pull request. + + + + Returns the that returns the files on a pull request. + + The owner of the repository + The name of the repository + The pull request number + The that returns the files on a pull request. + + + + Returns the for a spesific comment for the specified commit. + + The id of the gist + The id of the comment + + + + Returns the for the specified commit. + + The owner of the repository + The name of the repository + The commit reference (SHA) + + + + + Returns the for the specified reference. + + The owner of the repository + The name of the repository + + + + + Returns the for the specified reference. + + The owner of the repository + The name of the repository + The reference name + + + + + Returns the for creating a commit object. + + The owner of the repository + The name of the repository + + + + + Returns the for creating a merge object. + + The owner of the repository + The name of the repository + + + + + Returns the for the network of repositories. + + The owner of the repository + The name of the repository + The for the network of repositories. + + + + Returns the for the organization. + + The name of the organization + + + + + Returns the for the received events for a user. + + The login of the user + + + + + Returns the for the received events for a user. + + The login of the user + Whether to return public events or not + + + + + Returns the for events performed by a user. + + The login of the user + + + + + Returns the for events performed by a user. + + The login of the user + Whether to return public events or not + + + + + Returns the for events associated with an organization. + + The login of the user + The name of the organization + + + + + Returns the for the comments of a specified pull request review. + + The owner of the repository + The name of the repository + The pull request number + The + + + + Returns the for the reviews opf a specified pull request + + The owner of the repository + The name of the repository + The pull request number + The + + + + Returns the for the specified pull request review comment. + + The owner of the repository + The name of the repository + The comment number + The + + + + Returns the for the specified pull request review. + + The owner of the repository + The name of the repository + The pull request number + The pull request review number + The + + + + Returns the for dismissing a specified pull request review + + The Id of the repository + The pull request number + The pull request review number + The + + + + Returns the for dismissing a specified pull request review + + The owner of the repository + The name of the repository + The pull request number + The pull request review number + The + + + + Returns the for submitting a pull request review + + The Id of the repository + The pull request number + The pull request review number + The that + + + + Returns the for submitting a pull request review + + The owner of the repository + The name of the repository + The pull request number + The pull request review number + The + + + + Returns the for submitting a pull request review + + The Id of the repository + The pull request number + The pull request review number + The that + + + + Returns the for submitting a pull request review + + The owner of the repository + The name of the repository + The pull request number + The pull request review number + The + + + + Returns the for a specified pull request review. + + The Id of the repository + The pull request number + The pull request review number + The + + + + Returns the for the reaction of a specified pull request review comment. + + The owner of the repository + The name of the repository + The comment number + + + + + Returns the for the reaction of a specified pull request review comment. + + The Id of the repository + The comment number + + + + + Returns the for the pull request review comments on a specified repository. + + The owner of the repository + The name of the repository + The + + + + Returns the for a specific blob. + + The owner of the blob + The name of the organization + + + + + Returns the for a specific blob. + + The owner of the blob + The name of the organization + The SHA of the blob + + + + + Returns the for the specified tree. + + The owner of the repository + The name of the repository + + + + + Returns the for the specified tree. + + The owner of the repository + The name of the repository + The tree reference (SHA) + + + + + Returns the for the specified tree. + + The owner of the repository + The name of the repository + The tree reference (SHA) + + + + + returns the for org teams + use for both Get and Create methods + + + + + + + Returns the to discover teams + for the current user + + + + + + Returns the for child teams + + + + + + + Returns the for teams + use for getting, updating, or deleting a . + + The id of the . + + + + + returns the for team member + + The team id + The user login. + + + + returns the for team members list + + The team id + + + + returns the for the repositories + + The team id + + + + returns the for a team repository + + The team id + The organization id + The repository name + + + + returns the for the teams pending invitations + + The team id + + + + + returns the for teams + use for update or deleting a team + + owner of repo + name of repo + + + + + Returns the to check user is collaborator + + The owner of repo + The name of repo + The name of user + The to check user is collaborator + + + + Returns the to check user is collaborator + + The id of the repository + The name of the user + The to check user is collaborator + + + + Returns the to review the collaborators permission + + The owner of the repo + The name of the repo + The name of the user + The to review the collaborators permission + + + + returns the for branches + + owner of repo + name of repo + + + + + Creates the relative for searching repositories + + + + + + Creates the relative for searching users + + + + + + Creates the relative for searching issues + + + + + + Creates the relative for searching code + + + + + + Creates the relative for searching labels + + + + + + Returns the for repository contributors. + + The owner of the repository + The name of the repository + + + + + Returns the for repository languages. + + The owner of the repository + The name of the repository + + + + + Returns the for repository teams. + + The owner of the repository + The name of the repository + + + + + Returns the for repository tags. + + The owner of the repository + The name of the repository + + + + + Returns the for a repository transfer. + + The current owner of the repository + The name of the repository + + + + + Returns the for a repository transfer. + + The id of the repository + + + + + Returns the for repository commits. + + The owner of the repository + The name of the repository + The commit reference (SHA) + + + + + Returns the for repository commits. + + The owner of the repository + The name of the repository + + + + + Returns the for comparing two commits. + + The owner of the repository + The name of the repository + The base commit + The head commit + + + + + Returns the for a repository branch. + + The owner of the repository + The name of the repository + The name of the branch + + + + + Returns the for a repository branches protection. + + The owner of the repository + The name of the repository + The name of the branch + + + + + Returns the for a repository branches protection. + + The Id of the repository + The name of the branch + + + + + Returns the for required status checks for a protected branch. + + The owner of the repository + The name of the repository + The name of the branch + + + + + Returns the for required status checks for a protected branch. + + The Id of the repository + The name of the branch + + + + + Returns the for required status checks for a protected branch. + + The owner of the repository + The name of the repository + The name of the branch + + + + + Returns the for required status checks for a protected branch. + + The Id of the repository + The name of the branch + + + + + Returns the for required_pull_request_reviews for a protected branch + + The owner of the repository + The name of the repository + The name of the branch + + + + Returns the for required_pull_request_reviews for a protected branch + + The Id of the repository + The name of the branch + + + + Returns the for admin enforcement for a protected branch + + The owner of the repository + The name of the repository + The name of the branch + + + + Returns the for admin enforcement for a protected branch + + The Id of the repository + The name of the branch + + + + Returns the for restrictions for a protected branch. + + The owner of the repository + The name of the repository + The name of the branch + + + + + Returns the for restrictions for a protected branch. + + The Id of the repository + The name of the branch + + + + + Returns the for team restrictions for a protected branch. + + The owner of the repository + The name of the repository + The name of the branch + + + + + Returns the for team restrictions for a protected branch. + + The Id of the repository + The name of the branch + + + + + Returns the for user restrictions for a protected branch. + + The owner of the repository + The name of the repository + The name of the branch + + + + + Returns the for user restrictions for a protected branch. + + The Id of the repository + The name of the branch + + + + + Returns the for a repository. + + The owner of the repository + The name of the repository + + + + + Returns the for a deploy key for a repository + + The owner of the repository + The name of the repository + The id of the deploy key of the repository + + + + + Returns the for deploy keys for a repository. + + The owner of the repository + The name of the repository + + + + + Returns the for the Deployments API for the given repository. + + Owner of the repository + Name of the repository + The for the Deployments API for the given repository. + + + + Returns the for the Deployment Statuses API for the given deployment. + + Owner of the repository + Name of the repository + Id of the deployment + + + + + Creates the relative for retrieving the + current users followers + + The for retrieving the current users followers + + + + Creates the relative for retrieving + the followers for the specified user + + name of the user + The for retrieving the specified users followers + + + + Creates the relative for retrieving the users the current user follows + + The for retrieving the users the current user follows + + + + Creates the relative for retrieving the users the specified user follows + + name of the user + The for retrieving the users the specified user follows + + + + Creates the relative for checking is the current user is following + another user + + name of the user followed + The for checking if the current user follows the specified user. + + + + Creates the relative for checking if a user is following another user + + name of the user following + name of the user followed + The for checking if the specified user follows another user + + + + Returns the for the user for the given login + + Name of the user + The for the user for the given login + + + + Creates the relative for initiating the OAuth Web login Flow + + + + + + Creates the relative to request an OAuth access token. + + + + + + Creates the relative for getting the README of the specified repository + + The owner of the repository + The name of the repository + The for getting the README of the specified repository + + + + Creates the relative for getting the contents of the specified repository's root + + The owner of the repository + The name of the repository + The for getting the contents of the specified repository's root + + + + Creates the relative for getting the contents of the specified repository and path + + The owner of the repository + The name of the repository + The path of the contents to get + The for getting the contents of the specified repository and path + + + + Creates the relative for getting an archive of a given repository's contents, in a specific format + + The owner of the repository + The name of the repository + The format of the archive. Can be either tarball or zipball + A valid Git reference. + The for getting an archive of a given repository's contents, in a specific format + + + + Creates the relative for getting the contents of the specified repository and path + + The owner of the repository + The name of the repository + The path of the contents to get + The name of the commit/branch/tag. Default: the repository’s default branch (usually master) + The for getting the contents of the specified repository and path + + + + Creates the relative for getting the page metadata for a given repository + + The owner of the repository + The name of the repository + The for getting the page metadata for a given repository + + + + Creates the relative for getting all build metadata for a given repository + + The owner of the repository + The name of the repository + The for getting all build metadata for a given repository + + + + Creates the relative for getting the build metadata for the last build for a given repository + + The owner of the repository + The name of the repository + The for getting the build metadata for the last build for a given repository + + + + Returns the for the contributors for the given repository + + Owner of the repository + Name of the repository + The for the contributors for the given repository + + + + Returns the for the commit activity for the given repository + + Owner of the repository + Name of the repository + The for the commit activity for the given repository + + + + Returns the for the code frequency for the given repository + + Owner of the repository + Name of the repository + The for the code frequency for the given repository + + + + Returns the for the participation for the given repository + + Owner of the repository + Name of the repository + The for the participation for the given repository + + + + Returns the for the punch card for the given repository + + Owner of the repository + Name of the repository + The for the punch card for the given repository + + + + Creates the for pre-receive environments. + + + + + + Creates the for pre-receive environments. + + + + + + Creates the for pre-receive environment download status. + + + + + + Creates the for pre-receive environment download status. + + + + + + Creates the relative for altering administration status of a user. + + The login for the intended user. + + + + + Creates the relative for altering suspension status of a user. + + The login for the intended user. + + + + + Returns the that returns the assets specified by the asset id. + + The Id of the repository + The id of the release asset + The that returns the assets specified by the asset id. + + + + Returns the that returns all of the assignees to which issues may be assigned. + + The Id of the repository + The that returns all of the assignees to which issues may be assigned. + + + + Returns the for a specific blob. + + The Id of the repository + The for a specific blob. + + + + Returns the for a specific blob. + + The Id of the repository + The SHA of the blob + The for a specific blob. + + + + Returns the that returns a 204 if the login belongs to an assignee of the repository. Otherwire returns a 404. + + The Id of the repository + The login for the user + The that returns a 204 if the login belongs to an assignee of the repository. Otherwire returns a 404. + + + + Returns the that returns a combined view of commit statuses for the specified reference. + + The Id of the repository + The reference (SHA, branch name, or tag name) to list commits for + The that returns a combined view of commit statuses for the specified reference. + + + + Returns the for the specified commit. + + The Id of the repository + The commit reference (SHA) + The for the specified commit. + + + + Returns the for the specified comment. + + The Id of the repository + The comment number + The for the specified comment. + + + + Returns the for the comments of a specified commit. + + The Id of the repository + The sha of the commit + The for the comments of a specified commit. + + + + Returns the for the comments of a specified commit. + + The Id of the repository + The for the comments of a specified commit. + + + + Returns the that lists the commit statuses for the specified reference. + + The Id of the repository + The reference (SHA, branch name, or tag name) to list commits for + The that lists the commit statuses for the specified reference. + + + + Returns the for creating a commit object. + + The Id of the repository + The for creating a commit object. + + + + Returns the to use when creating a commit status for the specified reference. + + The Id of the repository + The reference (SHA, branch name, or tag name) to list commits for + The to use when creating a commit status for the specified reference. + + + + Returns the for creating a merge object. + + The Id of the repository + The for creating a merge object. + + + + Returns the for creating a tag object. + + The Id of the repository + The for creating a tag object. + + + + Returns the for the Deployments API for the given repository. + + The Id of the repository + The for the Deployments API for the given repository. + + + + Returns the for the Deployment Statuses API for the given deployment. + + The Id of the repository + Id of the deployment + The for the Deployment Statuses API for the given deployment. + + + + Returns the that returns the issue/pull request event and issue info for the specified repository. + + The Id of the repository + The that returns the issue/pull request event and issue info for the specified repository. + + + + Returns the that returns all the GPG Keys for the authenticated user. + + The that returns all the GPG Keys for the authenticated user. + + + + Returns the that returns the GPG Key for the authenticated user for the specified Id. + + The that returns the GPG Key for the authenticated user for the specified Id. + + + + + Returns the for the specified issue. + + The Id of the repository + The issue number + The for the specified issue. + + + + Returns the for the specified comment. + + The Id of the repository + The comment id + The for the specified comment. + + + + Returns the for the comments for all issues in a specific repo. + + The Id of the repository + The for the comments for all issues in a specific repo. + + + + Returns the for the comments of a specified issue. + + The Id of the repository + The issue number + The for the comments of a specified issue. + + + + Returns the that returns the named label for the specified issue. + + The Id of the repository + The issue number + The name of the label + The that returns the named label for the specified issue. + + + + Returns the that returns all of the labels for the specified issue. + + The Id of the repository + The issue number + The that returns all of the labels for the specified issue. + + + + Returns the for the specified issue to be locked/unlocked. + + The Id of the repository + The issue number + The for the specified issue to be locked/unlocked. + + + + Returns the that returns all of the issues for the currently logged in user specific to the repository. + + The Id of the repository + The that returns all of the issues for the currently logged in user specific to the repository. + + + + Returns the that returns the issue/pull request event and issue info for the specified event. + + The Id of the repository + The event id + The that returns the issue/pull request event and issue info for the specified event. + + + + Returns the that returns the issue/pull request event info for the specified issue. + + The Id of the repository + The issue number + The that returns the issue/pull request event info for the specified issue. + + + + Returns the that returns the issue/pull request event and issue info for the specified repository. + + The Id of the repository + The that returns the issue/pull request event and issue info for the specified repository. + + + + Returns the that returns the specified label. + + The Id of the repository + The name of label + The that returns the specified label. + + + + Returns the that returns all of the labels for the specified repository. + + The Id of the repository + The that returns all of the labels for the specified repository. + + + + Returns the that returns the latest release for the specified repository + + The Id of the repository + The that returns the latest release for the specified repository + + + + Returns the that returns the pull request merge state. + + The Id of the repository + The pull request number + The that returns the pull request merge state. + + + + Returns the that returns the specified milestone. + + The Id of the repository + The milestone number + The that returns the specified milestone. + + + + Returns the that returns all of the labels for all issues in the specified milestone. + + The Id of the repository + The milestone number + The that returns all of the labels for all issues in the specified milestone. + + + + Returns the that returns all of the milestones for the specified repository. + + The Id of the repository + The that returns all of the milestones for the specified repository. + + + + Returns the that returns all of the notifications for the currently logged in user specific to the repository. + + The Id of the repository + The that returns all of the notifications for the currently logged in user specific to the repository. + + + + Returns the that returns the specified pull request. + + The Id of the repository + The pull request number + The that returns the specified pull request. + + + + Returns the that returns the commits on a pull request. + + The Id of the repository + The pull request number + The that returns the commits on a pull request. + + + + Returns the that returns the files on a pull request. + + The Id of the repository + The pull request number + The that returns the files on a pull request. + + + + Returns the for the specified pull request review comment. + + The Id of the repository + The comment number + The that + + + + Returns the for the comments of a specified pull request review. + + The Id of the repository + The pull request number + The that + + + + Returns the for the reviews of a specified pull request + + The Id of the repository + The pull request number + The that + + + + Returns the for the pull request review comments on a specified repository. + + The Id of the repository + The that + + + + Returns the that lists the pull requests for a repository. + + The Id of the repository + The that lists the pull requests for a repository. + + + + Returns the for the specified reference. + + The Id of the repository + The for the specified reference. + + + + Returns the for the specified reference. + + The Id of the repository + The reference name + The for the specified reference. + + + + Returns the that returns all the assets for the specified release for the specified repository. + + The Id of the repository + The id of the release + The that returns all the assets for the specified release for the specified repository. + + + + Returns the that returns all of the releases for the specified repository. + + The Id of the repository + The that returns all of the releases for the specified repository. + + + + Returns the that returns a single release for the specified repository + + The Id of the repository + The id of the release + The that returns a single release for the specified repository + + + + Returns the that returns a single release for the specified repository + + The Id of the repository + The tag of the release + The that returns a single release for the specified repository + + + + Returns the for a repository branch. + + The Id of the repository + The name of the branch + The for a repository branch. + + + + Returns the that returns all of the branches for the specified repository. + + The Id of the repository + The that returns all of the branches for the specified repository. + + + + Returns the that returns all of the collaborators for the specified repository. + + The Id of the repository + The that returns all of the collaborators for the specified repository. + + + + Returns the for comparing two commits. + + The Id of the repository + The base commit + The head commit + The for comparing two commits. + + + + Returns the for a repository. + + The Id of the repository + The for a repository. + + + + Returns the for getting an archive of a given repository's contents, in a specific format + + The Id of the repository + The format of the archive. Can be either tarball or zipball + A valid Git reference. + The for getting an archive of a given repository's contents, in a specific format + + + + Returns the for repository commits. + + The Id of the repository + The commit reference (SHA) + The for repository commits. + + + + Returns the for repository commits. + + The Id of the repository + The for repository commits. + + + + Returns the for getting the contents of the specified repository's root + + The Id of the repository + The for getting the contents of the specified repository's root + + + + Returns the for getting the contents of the specified repository and path + + The Id of the repository + The path of the contents to get + The for getting the contents of the specified repository and path + + + + Returns the for getting the contents of the specified repository and path + + The Id of the repository + The path of the contents to get + The name of the commit/branch/tag. Default: the repository’s default branch (usually master) + The for getting the contents of the specified repository and path + + + + Returns the for repository contributors. + + The Id of the repository + The for repository contributors. + + + + Returns the for a deploy key for a repository + + The Id of the repository + The id of the deploy key of the repository + The for a deploy key for a repository + + + + Returns the for deploy keys for a repository. + + The Id of the repository + The for deploy keys for a repository. + + + + Returns the that lists the repository forks for the specified reference. + + The Id of the repository + The that lists the repository forks for the specified reference. + + + + Returns the that gets the repository hook for the specified reference. + + The Id of the repository + The identifier of the repository hook + The that gets the repository hook for the specified reference. + + + + Returns the that can ping a specified repository hook + + The Id of the repository + The identifier of the repository hook + The that can ping a specified repository hook + + + + Returns the that lists the repository hooks for the specified reference. + + The Id of the repository + The that lists the repository hooks for the specified reference. + + + + Returns the that can tests a specified repository hook + + The Id of the repository + The identifier of the repository hook + The that can tests a specified repository hook + + + + Returns the for repository languages. + + The Id of the repository + The for repository languages. + + + + Returns the for getting the page metadata for a given repository + + The Id of the repository + The for getting the page metadata for a given repository + + + + Returns the for getting all build metadata for a given repository + + The Id of the repository + The for getting all build metadata for a given repository + + + + Returns the for getting the build metadata for the last build for a given repository + + The Id of the repository + The for getting the build metadata for the last build for a given repository + + + + Returns the for getting the README of the specified repository + + The Id of the repository + The for getting the README of the specified repository + + + + Returns the for repository tags. + + The Id of the repository + The for repository tags. + + + + Returns the for repository teams. + + The Id of the repository + The for repository teams. + + + + Returns the that lists the starred repositories for the authenticated user. + + The Id of the repository + The that lists the starred repositories for the authenticated user. + + + + Returns the for the code frequency for the given repository + + The Id of the repository + The for the code frequency for the given repository + + + + Returns the for the commit activity for the given repository + + The Id of the repository + The for the commit activity for the given repository + + + + Returns the for the contributors for the given repository + + The Id of the repository + The for the contributors for the given repository + + + + Returns the for the participation for the given repository + + The Id of the repository + The for the participation for the given repository + + + + Returns the for the punch card for the given repository + + The Id of the repository + The for the punch card for the given repository + + + + Returns the for the specified tag. + + The Id of the repository + The tag reference (SHA) + The for the specified tag. + + + + Returns the for the specified tree. + + The Id of the repository + The for the specified tree. + + + + Returns the for the specified tree. + + The Id of the repository + The tree reference (SHA) + The for the specified tree. + + + + Returns the for the specified tree. + + The Id of the repository + The tree reference (SHA) + The for the specified tree. + + + + Returns the that shows whether the repo is starred by the current user. + + The Id of the repository + The that shows whether the repo is starred by the current user. + + + + Returns the that lists the watched repositories for the authenticated user. + + The Id of the repository + The that lists the watched repositories for the authenticated user. + + + + Returns the for deleting a reaction. + + The reaction number + The that lists the watched repositories for the authenticated user. + + + + Returns the for repository invitations. + + The id of the repository + The for repository invitations. + + + + Returns the for a single repository invitation. + + The id of the repository + The id of the invitation + The for repository invitations. + + + + Returns the for invitations for the current user. + + The for invitations for the current user. + + + + Returns the for a single invitation of the current user. + + The id of the invitation + The for invitations for the current user. + + + + Returns the for repository traffice referrers. + + The owner of repo + The name of repo + The for repository traffic referrers. + + + + Returns the for repository traffice referrers. + + The id of the repository + The for repository traffic referrers. + + + + Returns the for repository traffice paths. + + The owner of repo + The name of repo + The for repository traffic paths. + + + + Returns the for repository traffice paths. + + The id of the repository + The for repository traffic paths. + + + + Returns the for repository traffice views. + + The owner of repo + The name of repo + The for repository traffic views. + + + + Returns the for repository traffice views. + + The id of the repository + The for repository traffic views. + + + + Returns the for repository traffice clones. + + The owner of repo + The name of repo + The for repository traffic clones. + + + + Returns the for repository traffice clones. + + The id of the repository + The for repository traffic clones. + + + + Returns the for pull request review requests. + + The owner of repo + The name of repo + The pull request number + The for pull request review requests. + + + + Returns the for pull request review requests. + + The id of the repository + The pull request number + The for pull request review requests. + + + + Returns the for the specified project projects. + + The owner of the repository + The name of the repository + The for projects. + + + + Returns the for the specified project projects. + + The id of the repository + The for projects. + + + + Returns the for the specified organization projects. + + The name of the organization + The for projects. + + + + Returns the for a project. + + The id of the project + The for repository projects. + + + + Returns the for project columns. + + The id of the columns + The for project columns. + + + + Returns the for a specific project column. + + The id of the project + The for a specific project column. + + + + Returns the to move a project column. + + The id of the column to move + The to move a project column. + + + + Returns the for project cards. + + The id of the card + The for project cards. + + + + Returns the for project cards. + + The id of the column + The for project cards. + + + + Returns the to move a project card. + + The id of the card to move + The to move a project card. + + + + Returns the for repository's license requests. + + The owner of repo + The name of repo + The for repository's license requests. + + + + Returns the for repository's license requests. + + The id of the repository + The for repository's license requests. + + + + Returns the that returns the specified check run. + + The Id of the repository + The check run Id + The that returns the specified check run. + + + + Returns the that returns the specified check run. + + The owner of repo + The name of repo + The check run Id + The that returns the specified check run. + + + + Returns the that handles the check runs for the repository. + + The Id of the repository + The that handles the check runs for the repository. + + + + Returns the that handles the check runs for the repository. + + The owner of repo + The name of repo + The that handles the check runs for the repository. + + + + Returns the that lists the check runs for the specified reference. + + The Id of the repository + The git reference + The that returns the check runs for the specified reference. + + + + Returns the that lists the check runs for the specified reference. + + The owner of repo + The name of repo + The git reference + The that returns the check runs for the specified reference. + + + + Returns the that lists the check runs for the specified reference. + + The Id of the repository + The Id of the check suite + The that returns the check runs for the specified reference. + + + + Returns the that lists the check runs for the specified reference. + + The owner of repo + The name of repo + The Id of the check suite + The that returns the check runs for the specified reference. + + + + Returns the that lists the annotations for the specified check run. + + The Id of the repository + The Id of the check run + The that returns the annotations for the specified check run. + + + + Returns the that lists the annotations for the specified check run. + + The owner of repo + The name of repo + The Id of the check run + The that returns the annotations for the specified check run. + + + + Returns the that returns the specified check suite. + + The Id of the repository + The check run Id + The that returns the specified check suite. + + + + Returns the that returns the specified check suite. + + The owner of repo + The name of repo + The check run Id + The that returns the specified check suite. + + + + Returns the that lists the check suites for the specified reference. + + The Id of the repository + The git reference + The that returns the check suites for the specified reference. + + + + Returns the that lists the check suites for the specified reference. + + The owner of repo + The name of repo + The git reference + The that returns the check suites for the specified reference. + + + + Returns the that handles the check suites for the repository. + + The Id of the repository + The that handles the check suites for the repository. + + + + Returns the that handles the check suites for the repository. + + The owner of repo + The name of repo + The that handles the check suites for the repository. + + + + Returns the that handles the check suite requests for the repository. + + The Id of the repository + The that handles the check suite requests for the repository. + + + + Returns the that handles the check suite requests for the repository. + + The owner of repo + The name of repo + The that handles the check suite requests for the repository. + + + + Returns the that handles the check suite requests for the repository. + + The Id of the repository + The Id of the check suite + The that handles the check suite requests for the repository. + + + + Returns the that handles the check suite requests for the repository. + + The owner of repo + The name of repo + The Id of the check suite + The that handles the check suite requests for the repository. + + + + Returns the that handles the check suite preferences for the repository. + + The Id of the repository + The that handles the check suite preferences for the repository. + + + + Returns the that handles the check suite preferences for the repository. + + The owner of repo + The name of repo + The that handles the check suite preferences for the repository. + + + + Represents operations to simplify triggering the authorization flow + + + + + This method will create a new authorization for the specified OAuth application, only if an authorization + for that application doesn’t already exist for the user. It returns the user’s token for the application + if one exists. Otherwise, it creates a new one. + + + + This method allows the caller to provide a callback which is used to retrieve the two-factor code from + the user. Typically the callback is used to show some user interface to the user. + + + See API documentation + for more details. + + + The this method extends + Client Id for the OAuth application that is requesting the token + The client secret + Defines the scopes and metadata for the token + Callback used to retrieve the two-factor authentication code + from the user + + + + + Ensure input parameters + + + + + Checks an argument to ensure it isn't null. + + The argument value to check + The name of the argument + + + + Checks a string argument to ensure it isn't null or empty. + + The argument value to check + The name of the argument + + + + Checks a timespan argument to ensure it is a positive value. + + The argument value to check + The name of the argument + + + + Checks an enumerable argument to ensure it isn't null or empty. + + The argument value to check + The name of the argument + + + + Used to paginate through API response results. + + + This is meant to be internal, but I factored it out so we can change our mind more easily later. + + + + + Paginate a request to asynchronous fetch the results until no more are returned + + Type of the API resource to get. + A function which generates the first request + The original URI (used only for raising an exception) + + + + Reflects a collection of data returned from an API that can be paged. + + + + + + Returns the next page of items. + + + + + + Represents operations to simplify working with references + + + + + Creates a branch, based off the branch specified. + + The this method extends + The owner of the repository. + The name of the repository. + The new branch name + The to base the branch from + + + + Creates a branch, based off the master branch. + + The this method extends + The owner of the repository. + The name of the repository. + The new branch name + + + + Attribute used to denote that a string property should be serialized as a base64 encoded string. + + + + + Extensions for converting between different time representations + + + + + Convert a Unix tick to a with UTC offset + + UTC tick + + + + Convert with UTC offset to a Unix tick + + Date Time with UTC offset + + + + Represents the response to a 2FA challenge from the API + + + + + Helper action for resending the 2FA code + + + + + Construct an instance of TwoFactorChallengeResult + + + + + + True if this request should resent an authentication code + + + + + The user-specified authentication code + + + + + Extensions for working with Uris + + + + + Returns a Uri where any existing relative Uri component is stripped + eg https://example.com/some/path becomes https://example.com + + Base Uri + + + + + Returns a Uri where any existing relative Uri component is replaced with the respective value + eg https://example.com/some/path becomes https://example.com/replacement/path + + Base Uri + Relative Uri to add to the base Uri, replacing any existing relative Uri component + + + + + Merge a dictionary of values with an existing + + Original request Uri + Collection of key-value pairs + Updated request Uri + + + + A connection for making API requests against URI endpoints. + Provides type-friendly convenience methods that wrap methods. + + + + + Initializes a new instance of the class. + + A connection for making HTTP requests + + + + Initializes a new instance of the class. + + A connection for making HTTP requests + A paginator for paging API responses + + + + The underlying connection. + + + + + Gets the API resource at the specified URI. + + Type of the API resource to get. + URI of the API resource to get + The API resource. + Thrown when an API error occurs. + + + + Gets the API resource at the specified URI. + + Type of the API resource to get. + URI of the API resource to get + Parameters to add to the API request + The API resource. + Thrown when an API error occurs. + + + + Gets the API resource at the specified URI. + + Type of the API resource to get. + URI of the API resource to get + Parameters to add to the API request + Accept header to use for the API request + The API resource. + Thrown when an API error occurs. + + + + Gets the HTML content of the API resource at the specified URI. + + URI of the API resource to get + Parameters to add to the API request + The API resource's HTML content. + Thrown when an API error occurs. + + + + Gets all API resources in the list at the specified URI. + + Type of the API resource in the list. + URI of the API resource to get + of the The API resources in the list. + Thrown when an API error occurs. + + + + Gets all API resources in the list at the specified URI. + + Type of the API resource in the list. + URI of the API resource to get + Options for changing the API response + of the The API resources in the list. + Thrown when an API error occurs. + + + + Gets all API resources in the list at the specified URI. + + Type of the API resource in the list. + URI of the API resource to get + Parameters to add to the API request + of the The API resources in the list. + Thrown when an API error occurs. + + + + Gets all API resources in the list at the specified URI. + + Type of the API resource in the list. + URI of the API resource to get + Accept header to use for the API request + of the The API resources in the list. + Thrown when an API error occurs. + + + + Gets all API resources in the list at the specified URI. + + Type of the API resource in the list. + URI of the API resource to get + Parameters to add to the API request + Options for changing the API response + of the The API resources in the list. + Thrown when an API error occurs. + + + + Gets all API resources in the list at the specified URI. + + Type of the API resource in the list. + URI of the API resource to get + Parameters to add to the API request + Accept header to use for the API request + of the The API resources in the list. + Thrown when an API error occurs. + + + + Creates a new API resource in the list at the specified URI. + + URI endpoint to send request to + Representing the received HTTP response + Thrown when an API error occurs. + + + + Creates a new API resource in the list at the specified URI. + + The API resource's type. + URI of the API resource to get + The created API resource. + Thrown when an API error occurs. + + + + Creates a new API resource in the list at the specified URI. + + The API resource's type. + URI of the API resource to get + Object that describes the new API resource; this will be serialized and used as the request's body + The created API resource. + Thrown when an API error occurs. + + + + Creates a new API resource in the list at the specified URI. + + The API resource's type. + URI of the API resource to get + Object that describes the new API resource; this will be serialized and used as the request's body + Accept header to use for the API request + The created API resource. + Thrown when an API error occurs. + + + + Creates a new API resource in the list at the specified URI. + + The API resource's type. + URI of the API resource to get + Object that describes the new API resource; this will be serialized and used as the request's body + Accept header to use for the API request + Content type of the API request + The created API resource. + Thrown when an API error occurs. + + + + Creates a new API resource in the list at the specified URI. + + The API resource's type. + URI of the API resource to get + Object that describes the new API resource; this will be serialized and used as the request's body + Accept header to use for the API request + Content type of the API request + Two Factor Authentication Code + The created API resource. + Thrown when an API error occurs. + + + + Creates or replaces the API resource at the specified URI + + URI of the API resource to put + A for the request's execution. + + + + Creates or replaces the API resource at the specified URI. + + The API resource's type. + URI of the API resource to create or replace + Object that describes the API resource; this will be serialized and used as the request's body + The created API resource. + Thrown when an API error occurs. + + + + Creates or replaces the API resource at the specified URI. + + The API resource's type. + URI of the API resource to create or replace + Object that describes the API resource; this will be serialized and used as the request's body + The two-factor authentication code in response to the current user's previous challenge + The created API resource. + Thrown when an API error occurs. + + + + Creates or replaces the API resource at the specified URI. + + The API resource's type. + URI of the API resource to create or replace + Object that describes the API resource; this will be serialized and used as the request's body + The two-factor authentication code in response to the current user's previous challenge + Accept header to use for the API request + The created API resource. + Thrown when an API error occurs. + + + + Updates the API resource at the specified URI. + + URI of the API resource to patch + A for the request's execution. + + + + Updates the API resource at the specified URI. + + URI of the API resource to patch + Accept header to use for the API request + A for the request's execution. + + + + Updates the API resource at the specified URI. + + The API resource's type. + URI of the API resource to update + Object that describes the API resource; this will be serialized and used as the request's body + The updated API resource. + Thrown when an API error occurs. + + + + Updates the API resource at the specified URI. + + The API resource's type. + URI of the API resource to update + Object that describes the API resource; this will be serialized and used as the request's body + Accept header to use for the API request + The updated API resource. + Thrown when an API error occurs. + + + + Deletes the API object at the specified URI. + + URI of the API resource to delete + A for the request's execution. + + + + Deletes the API object at the specified URI. + + URI of the API resource to delete + Two Factor Code + A for the request's execution. + + + + Deletes the API object at the specified URI. + + URI of the API resource to delete + Object that describes the API resource; this will be serialized and used as the request's body + A for the request's execution. + + + + Performs an asynchronous HTTP DELETE request that expects an empty response. + + URI endpoint to send request to + The object to serialize as the body of the request + Specifies accept response media type + The returned + + + + Performs an asynchronous HTTP DELETE request. + + The API resource's type. + URI endpoint to send request to + The object to serialize as the body of the request + + + + Performs an asynchronous HTTP DELETE request. + Attempts to map the response body to an object of type + + The API resource's type. + URI endpoint to send request to + Specifies accept response media type + The returned + + + + Performs an asynchronous HTTP DELETE request. + Attempts to map the response body to an object of type + + The type to map the response to + URI endpoint to send request to + The object to serialize as the body of the request + Specifies accept response media type + + + + Executes a GET to the API object at the specified URI. This operation is appropriate for API calls which + queue long running calculations and return a collection of a resource. + It expects the API to respond with an initial 202 Accepted, and queries again until a 200 OK is received. + It returns an empty collection if it receives a 204 No Content response. + + The API resource's type. + URI of the API resource to update + A token used to cancel this potentially long running request + The updated API resource. + Thrown when an API error occurs. + + + + Extra information returned as part of each api response. + + + + + Oauth scopes that were included in the token used to make the request. + + + + + Oauth scopes accepted for this particular call. + + + + + Etag + + + + + Links to things like next/previous pages + + + + + Information about the API rate limit + + + + + Allows you to clone ApiInfo + + A clone of + + + + A connection for making HTTP requests against URI endpoints. + + + + + Creates a new connection instance used to make requests of the GitHub API. + + + See more information regarding User-Agent requirements here: https://developer.github.com/v3/#user-agent-required + + + The name (and optionally version) of the product using this library, the name of your GitHub organization, or your GitHub username (in that order of preference). This is sent to the server as part of + the user agent for analytics purposes, and used by GitHub to contact you if there are problems. + + + + + Creates a new connection instance used to make requests of the GitHub API. + + + See more information regarding User-Agent requirements here: https://developer.github.com/v3/#user-agent-required + + + The name (and optionally version) of the product using this library, the name of your GitHub organization, or your GitHub username (in that order of preference). This is sent to the server as part of + the user agent for analytics purposes, and used by GitHub to contact you if there are problems. + + + The client to use for executing requests + + + + + Creates a new connection instance used to make requests of the GitHub API. + + + See more information regarding User-Agent requirements here: https://developer.github.com/v3/#user-agent-required + + + The name (and optionally version) of the product using this library, the name of your GitHub organization, or your GitHub username (in that order of preference). This is sent to the server as part of + the user agent for analytics purposes, and used by GitHub to contact you if there are problems. + + + The address to point this client to such as https://api.github.com or the URL to a GitHub Enterprise + instance + + + + Creates a new connection instance used to make requests of the GitHub API. + + + See more information regarding User-Agent requirements here: https://developer.github.com/v3/#user-agent-required + + + The name (and optionally version) of the product using this library, the name of your GitHub organization, or your GitHub username (in that order of preference). This is sent to the server as part of + the user agent for analytics purposes, and used by GitHub to contact you if there are problems. + + Provides credentials to the client when making requests + + + + Creates a new connection instance used to make requests of the GitHub API. + + + See more information regarding User-Agent requirements here: https://developer.github.com/v3/#user-agent-required + + + The name (and optionally version) of the product using this library, the name of your GitHub organization, or your GitHub username (in that order of preference). This is sent to the server as part of + the user agent for analytics purposes, and used by GitHub to contact you if there are problems. + + + The address to point this client to such as https://api.github.com or the URL to a GitHub Enterprise + instance + Provides credentials to the client when making requests + + + + Creates a new connection instance used to make requests of the GitHub API. + + + See more information regarding User-Agent requirements here: https://developer.github.com/v3/#user-agent-required + + + The name (and optionally version) of the product using this library, the name of your GitHub organization, or your GitHub username (in that order of preference). This is sent to the server as part of + the user agent for analytics purposes, and used by GitHub to contact you if there are problems. + + + The address to point this client to such as https://api.github.com or the URL to a GitHub Enterprise + instance + Provides credentials to the client when making requests + A raw used to make requests + Class used to serialize and deserialize JSON requests + + + + Gets the latest API Info - this will be null if no API calls have been made + + representing the information returned as part of an Api call + + + + Performs an asynchronous HTTP GET request that expects a containing HTML. + + URI endpoint to send request to + Querystring parameters for the request + representing the received HTTP response + + + + Performs an asynchronous HTTP POST request. + + URI endpoint to send request to + representing the received HTTP response + + + + Performs an asynchronous HTTP POST request. + Attempts to map the response body to an object of type + + The type to map the response to + URI endpoint to send request to + The object to serialize as the body of the request + Specifies accepted response media types. + Specifies the media type of the request body + Two Factor Authentication Code + representing the received HTTP response + + + + Performs an asynchronous HTTP PATCH request. + + URI endpoint to send request to + representing the received HTTP response + + + + Performs an asynchronous HTTP PATCH request. + + URI endpoint to send request to + Specifies accept response media type + representing the received HTTP response + + + + Performs an asynchronous HTTP PUT request that expects an empty response. + + URI endpoint to send request to + The returned + + + + Performs an asynchronous HTTP PUT request that expects an empty response. + + URI endpoint to send request to + Specifies accepted response media types. + The returned + + + + Performs an asynchronous HTTP DELETE request that expects an empty response. + + URI endpoint to send request to + The returned + + + + Performs an asynchronous HTTP DELETE request that expects an empty response. + + URI endpoint to send request to + Two Factor Code + The returned + + + + Performs an asynchronous HTTP DELETE request that expects an empty response. + + URI endpoint to send request to + The object to serialize as the body of the request + The returned + + + + Performs an asynchronous HTTP DELETE request that expects an empty response. + + URI endpoint to send request to + The object to serialize as the body of the request + Specifies accept response media type + The returned + + + + Performs an asynchronous HTTP DELETE request. + + The API resource's type. + URI endpoint to send request to + The object to serialize as the body of the request + + + + Performs an asynchronous HTTP DELETE request. + Attempts to map the response body to an object of type + + The type to map the response to + URI endpoint to send request to + The object to serialize as the body of the request + Specifies accept response media type + + + + Base address for the connection. + + + + + Gets the used to provide credentials for the connection. + + + + + Gets or sets the credentials used by the connection. + + + You can use this property if you only have a single hard-coded credential. Otherwise, pass in an + to the constructor. + Setting this property will change the to use + the default with just these credentials. + + + + + Set the GitHub Api request timeout. + + The Timeout value + + + + A connection for making API requests against URI endpoints. + Provides type-friendly convenience methods that wrap methods. + + + + + The underlying connection. + + + + + Gets the API resource at the specified URI. + + Type of the API resource to get. + URI of the API resource to get + The API resource. + Thrown when an API error occurs. + + + + Gets the API resource at the specified URI. + + Type of the API resource to get. + URI of the API resource to get + Parameters to add to the API request + The API resource. + Thrown when an API error occurs. + + + + Gets the API resource at the specified URI. + + Type of the API resource to get. + URI of the API resource to get + Parameters to add to the API request + Accept header to use for the API request + The API resource. + Thrown when an API error occurs. + + + + Gets the HTML content of the API resource at the specified URI. + + URI of the API resource to get + Parameters to add to the API request + The API resource's HTML content. + Thrown when an API error occurs. + + + + Gets all API resources in the list at the specified URI. + + Type of the API resource in the list. + URI of the API resource to get + of the The API resources in the list. + Thrown when an API error occurs. + + + + Gets all API resources in the list at the specified URI. + + Type of the API resource in the list. + URI of the API resource to get + Options for changing the API response + of the The API resources in the list. + Thrown when an API error occurs. + + + + Gets all API resources in the list at the specified URI. + + Type of the API resource in the list. + URI of the API resource to get + Parameters to add to the API request + of the The API resources in the list. + Thrown when an API error occurs. + + + + Gets all API resources in the list at the specified URI. + + Type of the API resource in the list. + URI of the API resource to get + Accept header to use for the API request + of the The API resources in the list. + Thrown when an API error occurs. + + + + Gets all API resources in the list at the specified URI. + + Type of the API resource in the list. + URI of the API resource to get + Parameters to add to the API request + Options for changing the API response + of the The API resources in the list. + Thrown when an API error occurs. + + + + Gets all API resources in the list at the specified URI. + + Type of the API resource in the list. + URI of the API resource to get + Parameters to add to the API request + Accept header to use for the API request + of the The API resources in the list. + Thrown when an API error occurs. + + + + Gets all API resources in the list at the specified URI. + + Type of the API resource in the list. + URI of the API resource to get + Parameters to add to the API request + Accept header to use for the API request + Options for changing the API response + of the The API resources in the list. + Thrown when an API error occurs. + + + + Creates a new API resource in the list at the specified URI. + + URI endpoint to send request to + Representing the received HTTP response + Thrown when an API error occurs. + + + + Creates a new API resource in the list at the specified URI. + + The API resource's type. + URI endpoint to send request to + The created API resource. + Thrown when an API error occurs. + + + + Creates a new API resource in the list at the specified URI. + + The API resource's type. + URI of the API resource to get + Object that describes the new API resource; this will be serialized and used as the request's body + The created API resource. + Thrown when an API error occurs. + + + + Creates a new API resource in the list at the specified URI. + + The API resource's type. + URI of the API resource to get + Object that describes the new API resource; this will be serialized and used as the request's body + Accept header to use for the API request + The created API resource. + Thrown when an API error occurs. + + + + Creates a new API resource in the list at the specified URI. + + The API resource's type. + URI of the API resource to get + Object that describes the new API resource; this will be serialized and used as the request's body + Accept header to use for the API request + Content type of the API request + The created API resource. + Thrown when an API error occurs. + + + + Creates a new API resource in the list at the specified URI. + + The API resource's type. + URI of the API resource to get + Object that describes the new API resource; this will be serialized and used as the request's body + Accept header to use for the API request + Content type of the API request + Two Factor Authentication Code + The created API resource. + Thrown when an API error occurs. + + + + Creates a new API resource in the list at the specified URI. + + The API resource's type. + URI of the API resource to get + Object that describes the new API resource; this will be serialized and used as the request's body + Accept header to use for the API request + Content type of the API request + Timeout for the request + The created API resource. + Thrown when an API error occurs. + + + + Creates or replaces the API resource at the specified URI + + URI of the API resource to put + A for the request's execution. + + + + Creates or replaces the API resource at the specified URI. + + The API resource's type. + URI of the API resource to create or replace + Object that describes the API resource; this will be serialized and used as the request's body + The created API resource. + Thrown when an API error occurs. + + + + Creates or replaces the API resource at the specified URI. + + The API resource's type. + URI of the API resource to create or replace + Object that describes the API resource; this will be serialized and used as the request's body + The two-factor authentication code in response to the current user's previous challenge + The created API resource. + Thrown when an API error occurs. + + + + Creates or replaces the API resource at the specified URI. + + The API resource's type. + URI of the API resource to create or replace + Object that describes the API resource; this will be serialized and used as the request's body + The two-factor authentication code in response to the current user's previous challenge + Accept header to use for the API request + The created API resource. + Thrown when an API error occurs. + + + + Updates the API resource at the specified URI. + + URI of the API resource to patch + A for the request's execution. + + + + Updates the API resource at the specified URI. + + URI of the API resource to patch + Accept header to use for the API request + A for the request's execution. + + + + Updates the API resource at the specified URI. + + The API resource's type. + URI of the API resource to update + Object that describes the API resource; this will be serialized and used as the request's body + The updated API resource. + Thrown when an API error occurs. + + + + Updates the API resource at the specified URI. + + The API resource's type. + URI of the API resource to update + Object that describes the API resource; this will be serialized and used as the request's body + Accept header to use for the API request + The updated API resource. + Thrown when an API error occurs. + + + + Deletes the API object at the specified URI. + + URI of the API resource to delete + A for the request's execution. + + + + Deletes the API object at the specified URI. + + URI of the API resource to delete + Two Factor Code + A for the request's execution. + + + + Deletes the API object at the specified URI. + + URI of the API resource to delete + Object that describes the API resource; this will be serialized and used as the request's body + A for the request's execution. + + + + Performs an asynchronous HTTP DELETE request that expects an empty response. + + URI endpoint to send request to + The object to serialize as the body of the request + Specifies accept response media type + The returned + + + + Performs an asynchronous HTTP DELETE request. + + The API resource's type. + URI endpoint to send request to + The object to serialize as the body of the request + + + + Performs an asynchronous HTTP DELETE request. + Attempts to map the response body to an object of type + + The API resource's type. + URI endpoint to send request to + Specifies accept response media type + The returned + + + + Performs an asynchronous HTTP DELETE request. + Attempts to map the response body to an object of type + + The API resource's type. + URI endpoint to send request to + The object to serialize as the body of the request + Specifies accept response media type + The returned + + + + Executes a GET to the API object at the specified URI. This operation is appropriate for API calls which + queue long running calculations and return a collection of a resource. + It expects the API to respond with an initial 202 Accepted, and queries again until a 200 OK is received. + It returns an empty collection if it receives a 204 No Content response. + + The API resource's type. + URI of the API resource to update + A token used to cancel this potentially long running request + The updated API resource. + Thrown when an API error occurs. + + + + Provides a property for the Last recorded API information + + + + + Gets the latest API Info - this will be null if no API calls have been made + + representing the information returned as part of an Api call + + + + A connection for making HTTP requests against URI endpoints. + + + + + Performs an asynchronous HTTP GET request that expects a containing HTML. + + URI endpoint to send request to + Querystring parameters for the request + representing the received HTTP response + + + + Performs an asynchronous HTTP GET request. + Attempts to map the response to an object of type + + The type to map the response to + URI endpoint to send request to + Querystring parameters for the request + Specifies accepted response media types. + representing the received HTTP response + + + + Performs an asynchronous HTTP GET request. + Attempts to map the response to an object of type + + The type to map the response to + URI endpoint to send request to + Querystring parameters for the request + Specifies accepted response media types. + A token used to cancel the Get request + representing the received HTTP response + + + + Performs an asynchronous HTTP GET request. + Attempts to map the response to an object of type + + The type to map the response to + URI endpoint to send request to + Expiration time of the request + representing the received HTTP response + + + + Performs an asynchronous HTTP PATCH request. + + URI endpoint to send request to + representing the received HTTP response + + + + Performs an asynchronous HTTP PATCH request. + + URI endpoint to send request to + Specifies accepted response media types. + representing the received HTTP response + + + + Performs an asynchronous HTTP PATCH request. + Attempts to map the response body to an object of type + + The type to map the response to + URI endpoint to send request to + The object to serialize as the body of the request + representing the received HTTP response + + + + Performs an asynchronous HTTP PATCH request. + Attempts to map the response body to an object of type + + The type to map the response to + URI endpoint to send request to + The object to serialize as the body of the request + Specifies accepted response media types. + representing the received HTTP response + + + + Performs an asynchronous HTTP POST request. + + URI endpoint to send request to + The returned + + + + Performs an asynchronous HTTP POST request. + + URI endpoint to send request to + The object to serialize as the body of the request + Specifies accepted response media types. + The returned + + + + Performs an asynchronous HTTP POST request. + Attempts to map the response body to an object of type + + The type to map the response to + URI endpoint to send request to + representing the received HTTP response + + + + Performs an asynchronous HTTP POST request. + Attempts to map the response body to an object of type + + The type to map the response to + URI endpoint to send request to + The object to serialize as the body of the request + Specifies accepted response media types. + Specifies the media type of the request body + Extra parameters for authentication. + representing the received HTTP response + + + + Performs an asynchronous HTTP POST request. + Attempts to map the response body to an object of type + + The type to map the response to + URI endpoint to send request to + The object to serialize as the body of the request + Specifies accepted response media types. + Specifies the media type of the request body + Two Factor Authentication Code + representing the received HTTP response + + + + Performs an asynchronous HTTP POST request. + Attempts to map the response body to an object of type + + The type to map the response to + URI endpoint to send request to + The object to serialize as the body of the request + Specifies accepted response media types. + Specifies the media type of the request body + + representing the received HTTP response + + + + Performs an asynchronous HTTP POST request. + Attempts to map the response body to an object of type + + + We have one case where we need to override the BaseAddress. This overload is for that case. + https://developer.github.com/v3/oauth/#web-application-flow + + The type to map the response to + URI endpoint to send request to + The object to serialize as the body of the request + Specifies accepted response media types. + Specifies the media type of the request body + Allows overriding the base address for a post. + representing the received HTTP response + + + + Performs an asynchronous HTTP PUT request. + Attempts to map the response body to an object of type + + The type to map the response to + URI endpoint to send request to + The body of the request + representing the received HTTP response + + + + Performs an asynchronous HTTP PUT request using the provided two factor authentication code. + Attempts to map the response body to an object of type + + The type to map the response to + URI endpoint to send request to + The object to serialize as the body of the request + Two factory authentication code to use + representing the received HTTP response + + + + Performs an asynchronous HTTP PUT request using the provided two factor authentication code. + Attempts to map the response body to an object of type + + The type to map the response to + URI endpoint to send request to + The object to serialize as the body of the request + Two factory authentication code to use + Specifies accepted response media types. + representing the received HTTP response + + + + Performs an asynchronous HTTP PUT request that expects an empty response. + + URI endpoint to send request to + The returned + + + + Performs an asynchronous HTTP PUT request that expects an empty response. + + URI endpoint to send request to + Specifies accepted response media types. + The returned + + + + Performs an asynchronous HTTP DELETE request that expects an empty response. + + URI endpoint to send request to + The returned + + + + Performs an asynchronous HTTP DELETE request that expects an empty response. + + URI endpoint to send request to + Two Factor Code + The returned + + + + Performs an asynchronous HTTP DELETE request that expects an empty response. + + URI endpoint to send request to + The object to serialize as the body of the request + The returned + + + + Performs an asynchronous HTTP DELETE request that expects an empty response. + + URI endpoint to send request to + The object to serialize as the body of the request + Specifies accept response media type + The returned + + + + Performs an asynchronous HTTP DELETE request. + + The API resource's type. + URI endpoint to send request to + The object to serialize as the body of the request + + + + Performs an asynchronous HTTP DELETE request. + Attempts to map the response body to an object of type + + The type to map the response to + URI endpoint to send request to + The object to serialize as the body of the request + Specifies accept response media type + + + + Base address for the connection. + + + + + Gets the used to provide credentials for the connection. + + + + + Gets or sets the credentials used by the connection. + + + You can use this property if you only have a single hard-coded credential. Otherwise, pass in an + to the constructor. + Setting this property will change the to use + the default with just these credentials. + + + + + Set the GitHub Api request timeout. + + The Timeout value + + + + Abstraction for interacting with credentials + + + + + Retrieve the credentials from the underlying store + + A continuation containing credentials + + + + A response from an API call that includes the deserialized object instance. + + + + + Object deserialized from the JSON response body. + + + + + The original non-deserialized http response. + + + + + Represents a generic HTTP response + + + + + Raw response body. Typically a string, but when requesting images, it will be a byte array. + + + + + Information about the API. + + + + + Information about the API response parsed from the response headers. + + + + + The response status code. + + + + + The content type of the response. + + + + + Represents a product header value. This is used to generate the User Agent string sent with each request. The + name used should represent the product, the GitHub Organization, or the GitHub username that's using Octokit.net (in that order of preference). + + + This class is a wrapper around + so that consumers of Octokit.net would not have to add a reference to the System.Net.Http.Headers namespace. + See more information regarding User-Agent requirements here: https://developer.github.com/v3/#user-agent-required + + + + + Initializes a new instance of the class. + + + See more information regarding User-Agent requirements here: https://developer.github.com/v3/#user-agent-required + + The name of the product, the GitHub Organization, or the GitHub Username (in that order of preference) that's using Octokit + + + + Initializes a new instance of the class. + + + See more information regarding User-Agent requirements here: https://developer.github.com/v3/#user-agent-required + + The name of the product, the GitHub Organization, or the GitHub Username (in that order of preference) that's using Octokit + The version of the product that's using Octokit + + + + The name of the product, the GitHub Organization, or the GitHub Username that's using Octokit (in that order of preference) + + + See more information regarding User-Agent requirements here: https://developer.github.com/v3/#user-agent-required + + + + + The version of the product. + + + + + Parses a string in the format "foo" or "foo/1.0" and returns the corresponding + instance. + + The input. + + + + Parses a string in the format "foo" or "foo/1.0" and returns the corresponding + instance via an out parameter. + + The input. + The parsed value. + + + + The maximum number of requests that the consumer is permitted to make per hour. + + + + + The number of requests remaining in the current rate limit window. + + + + + The date and time at which the current rate limit window resets + + + + + The date and time at which the current rate limit window resets - in UTC epoch seconds + + + + + Allows you to clone RateLimit + + A clone of + + + + Container for the static method that represents an + intentional empty request body to avoid overloading null. + + + + + A Client for the GitHub API v3. You can read more about the api here: http://developer.github.com. + + + + + Set the GitHub Api request timeout. + Useful to set a specific timeout for lengthy operations, such as uploading release assets + + + See more information here: https://technet.microsoft.com/library/system.net.http.httpclient.timeout(v=vs.110).aspx + + The Timeout value + + + + Provides a client connection to make rest requests to HTTP endpoints. + + + + + Access GitHub's Authorization API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/oauth_authorizations/ + + + + + Access GitHub's Activity API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/activity/ + + + + + Access GitHub's Application API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/apps/ + + + + + Access GitHub's Issue API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/issues/ + + + + + Access GitHub's Migration API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/migration/ + + + + + Access GitHub's Miscellaneous API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/misc/ + + + + + Access GitHub's OAuth API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/oauth/ + + + + + Access GitHub's Organizations API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/orgs/ + + + + + Access GitHub's Pull Requests API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/pulls/ + + + + + Access GitHub's Repositories API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/repos/ + + + + + Access GitHub's Gists API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/gists/ + + + + + Access GitHub's Users API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/users/ + + + + + Access GitHub's Git Data API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/git/ + + + + + Access GitHub's Search API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/search/ + + + + + Access GitHub's Enterprise API + + + Refer to the API documentation for more information: https://developer.github.com/v3/enterprise/ + + + + + Access GitHub's Reactions API + + + Refer to the API documentation for more information: https://developer.github.com/v3/reactions/ + + + + + Access GitHub's Checks API. + + + Refer to the API documentation for more information: https://developer.github.com/v3/checks/ + + + + + Enables or disables automatic creation of CheckSuite events upon pushes to the repository + + + + + Enables or disables automatic creation of CheckSuite events upon pushes to the repository + + The Id of the GitHub App (required) + Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them (required) + + + + The Id of the GitHub App + + + + + Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them + + + + + Check Suite preferences + + + + + Check Suite preferences + + Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default + + + + Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default + + + + + Represents the author or committer to a Git commit. This is the information stored in Git and should not be + confused with GitHub account information. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The full name of the author or committer. + The email. + The date. + + + + Initializes a new instance of the class. + + The GraphQL Node Id + The full name of the author or committer. + The email. + The date. + + + + GraphQL Node Id + + + + + Gets the name of the author or committer. + + + The name. + + + + + Gets the email of the author or committer. + + + The email. + + + + + Gets the date of the author or contributor's contributions. + + + The date. + + + + + Specify the start page for pagination actions + + + Page numbering is 1-based on the server + + + + + Specify the number of pages to return + + + + + Specify the number of results to return for each page + + + Results returned may be less than this total if you reach the final page of results + + + + + Used to add assignees to an issue. + + + API: https://developer.github.com/v3/git/commits/#create-a-commit + + + + + Used to create a new authorization. + + + + + Replaces the authorization scopes with this list. + + + + + A list of scopes to add to this authorization. + + + + + A list of scopes to remove from this authorization. + + + + + An optional note to remind you what the OAuth token is for. + + + + + An optional URL to remind you what app the OAuth token is for. + + + + + Optional parameter that allows an OAuth application to create multiple authorizations for a single user + + + + + Base class for searching issues/code/users/repos + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The term. + + + + The search term + + + + + The sort field + + + + + Gets the sort order as a properly formatted lowercased query string parameter. + + + The sort order. + + + + + Optional Sort order if sort parameter is provided. One of asc or desc; the default is desc. + + + + + Page of paginated results + + + + + Number of items per page + + + + + All qualifiers that are used for this search + + + + + Add qualifiers onto the search term + + + + + Any additional parameters required by the derived class + + + + + Get the query parameters that will be appending onto the search + + + + + Wraps a string for the body of a request. + + + + + Initializes a new instance of the class. + + The body. + + + + Gets the body. + + + The body. + + + + + Specifies the requested settings for branch protection + + + Note: this is a PREVIEW api: https://developer.github.com/changes/2016-06-27-protected-branches-api-update/ + + + + + Create a BranchProtection update request + + Specifies the requested status check settings. Pass null to disable status checks + + + + Create a BranchProtection update request + + Specifies if reviews are required to merge the pull request. Pass null to disable restrictions + + + + Create a BranchProtection update request + + Specifies the requested push access restrictions (applies only to Organization owned repositories). Pass null to disable push access restrictions + + + + Create a BranchProtection update request + + Specifies whether the protections applied to this branch also apply to repository admins + + + + Create a BranchProtection update request + + Specifies the requested status check settings. Pass null to disable status checks + Specifies if reviews are required to merge the pull request. Pass null to disable required reviews + Specifies whether the protections applied to this branch also apply to repository admins + + + + Create a BranchProtection update request + + Specifies the requested status check settings. Pass null to disable status checks + Specifies if reviews are required to merge the pull request. Pass null to disable required reviews + Specifies the requested push access restrictions (applies only to Organization owned repositories). Pass null to disable push access restrictions + Specifies whether the protections applied to this branch also apply to repository admins + + + + Status check settings for the protected branch + + + + + Required Pull Request review settings for the protected branch + + + + + Push access restrictions for the protected branch + + + + + Specifies whether the protections applied to this branch also apply to repository admins + + + + + Specifies settings for status checks which must pass before branches can be merged into the protected branch + + + + + Status check settings for branch protection + + Require branches to be up to date before merging + Require status checks to pass before merging + + + + Require branches to be up to date before merging + + + + + Require status checks to pass before merging + + + + + Specifies teams and/or people allowed to push to the protected branch. Required status checks will still prevent these people from merging if the checks fail + + + + + Specify only administrators are allowed to push to this branch. Required status checks will still prevent these people from merging if the checks fail + + + + + Specify teams (in addition to Administrators) allowed to push to this branch. Required status checks will still prevent these people from merging if the checks fail + + Teams allowed to push to this branch + + + + Specify people (in addition to Administrators) allowed to push to this branch. Required status checks will still prevent these people from merging if the checks fail + + Users allowed to push to this branch + + + + Specify teams and/or people (in addition to Administrators) allowed to push to this branch. Required status checks will still prevent these people from merging if the checks fail + + Teams allowed to push to this branch + Users allowed to push to this branch + + + + Teams allowed to push to this branch + + + + + Users allowed to push to this branch + + + + + Specifies settings for requiring pull request reviews before merging a pull request. + + + + + Settings for requiring reviews before a pull request can be merged. + + Dismiss approved reviews automatically when a new commit is pushed. + Blocks merge until code owners have reviewed. + + + + Settings for requiring reviews before a pull request can be merged. + + Specify which users and teams can dismiss pull request reviews (applies only to Organization owned repositories). + Dismiss approved reviews automatically when a new commit is pushed. + Blocks merge until code owners have reviewed. + + + + Specify which users and teams can dismiss pull request reviews. + + + + + Dismiss approved reviews automatically when a new commit is pushed. + + + + + Blocks merge until code owners have reviewed. + + + + + Specifies whether review dismissal for the protected branch will be restricted to Admins, specified Teams/Users or unrestricted + + + + + Specify whether dismissing reviews is restricted or not + + True to restrict review dismissal to Administrators, false to disable restrictions + + + + Restrict dismissing reviews to the specified teams (in addition to Administrators). + + Teams allowed to dismiss reviews + + + + Restrict dismissing reviews to the specified people (in addition to Administrators). + + Users allowed to dismiss reviews + + + + Restrict dismissing reviews to the specified teams and people (in addition to Administrators). + + Teams allowed to dismiss reviews + Users allowed to dismiss reviews + + + + Teams allowed to dismiss reviews + + + + + Users allowed to dismiss reviews + + + + + Details to filter a check suite request, such as by App Id or check run name + + + + + Returns check runs with the specified name. + + + + + Returns check runs with the specified status. Can be one of queued, in_progress, or completed. + + + + + Filters check runs by their completed_at timestamp. Can be one of latest (returning the most recent check runs) or all. Default: latest + + + + + Creates a new Check Run + + + + + The name of the check. For example, "code-coverage" + + + + + The URL of the integrator's site that has the full details of the check + + + + + A reference for the run on the integrator's system + + + + + The current status. Can be one of queued, in_progress, or completed. Default: queued + + + + + The time that the check run began + + + + + Required if you provide completed_at or a status of completed. The final conclusion of the check. Can be one of success, failure, neutral, cancelled, timed_out, or action_required. When the conclusion is action_required, additional details should be provided on the site specified by details_url. + Note: Providing conclusion will automatically set the status parameter to completed + + + + + Required if you provide conclusion. The time the check completed + + + + + Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run + + + + + Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted + + + + + Details to filter a check suite request, such as by App Id or check run name + + + + + Filters check suites by GitHub App Id + + + + + Filters check suites by the name of the check run + + + + + Request to trigger the creation of a check suite + + + + + Request to trigger the creation of a check suite + + The sha of the head commit (required) + + + + The sha of the head commit + + + + + Used to set the permission for a collaborator. + + + + + The permission to grant the collaborator on this repository. + + + + + Encapsulates the parameters for a request to retrieve commits. + + + + + SHA or branch to start listing commits from. + + + + + Only commits containing this file path will be returned. + + + + + GitHub login or email address by which to filter by commit author. + + + + + Only commits after this date will be returned. + + + + + Only commits before this date will be returned. + + + + + Base class with common properties for all the Repository Content Request APIs. + + + + + Initializes a new instance of the class. + + The message. + + + + Initializes a new instance of the class. + + The message. + The branch the request is for. + + + + The commit message. This is required. + + + + + The branch name. If null, this defaults to the default branch which is usually "master". + + + + + Specifies the committer to use for the commit. This is optional. + + + + + Specifies the author to use for the commit. This is optional. + + + + + Represents the request to delete a file in a repository. + + + + + Initializes a new instance of the class. + + The message. + The sha. + + + + Initializes a new instance of the class. + + The message. + The sha. + The branch the request is for. + + + + Represents the parameters to create a file in a repository. + + https://developer.github.com/v3/repos/contents/#create-a-file + + + + Creates an instance of a . + + The message. + The content. + + + + Initializes a new instance of the class. + + The message. + The content. + The branch the request is for. + + + + Creates an instance of a . + + The message. + The content. + True to convert content to base64. + + + + Initializes a new instance of the class. + + The message. + The content. + The branch the request is for. + True to convert content to base64. + + + + The contents of the file to create, Base64 encoded. This is required. + + + + + Represents the parameters to update a file in a repository. + + + + + Creates an instance of a . + + The message. + The content. + The sha. + + + + Creates an instance of a . + + The message. + The content. + The sha. + The branch the request is for. + + + + Creates an instance of a . + + The message. + The content. + The sha. + True to convert content to base64. + + + + Creates an instance of a . + + The message. + The content. + The sha. + The branch the request is for. + True to convert content to base64. + + + + The blob SHA of the file being replaced. + + + + + A draft comment that is part of a Pull Request Review + + + + + Creates a draft comment + + The text of the comment + The relative path of the file to comment on + The line index in the diff to comment on + + + + The text of the comment. + + + + + The relative path of the file to comment on. + + + + + The line index in the diff to comment on. + + + + + Represents the requested changes to an edit repository hook. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The configuration. + + + + Gets or sets the events. + + + The events. + + + + + Gets or sets the remove events. + + + The remove events. + + + + + Gets or sets the active. + + + The active. + + + + + Describes a new organization to create via the method. + + + + + Initializes a new instance of the class. + + The LDAP Distinguished Name + + + + The LDAP Distinguished Name (required) + + + + + Describes a new organization to create via the method. + + + + + Initializes a new instance of the class. + + The organization's username + The login of the user who will manage this organization + + + + Initializes a new instance of the class. + + The organization's username + The login of the user who will manage this organization + The organization's display name + + + + The organization's username (required) + + + + + The login of the user who will manage this organization (required) + + + + + The organization's display name + + + + + Describes a new pre-receive environment. + + + + + Initializes a new instance of the class. + + The name of the environment as displayed in the UI. + URL to the tarball that will be downloaded and extracted. + + + + The name of the environment as displayed in the UI. + + + + + URL to the tarball that will be downloaded and extracted. + + + + + Describes an update to an existing pre-receive environment. + + + + + The name of the environment as displayed in the UI. + + + + + URL to the tarball that will be downloaded and extracted. + + + + + Used as part of a to update the name or contents of an existing gist file + + + API docs: https://developer.github.com/v3/gists/ + + + + + Gets or sets the new name of the file. + + + The new name of the file. + + + + + Gets or sets the content. + + + The content. + + + + + Used to request Gists since a certain date. + + + API docs: https://developer.github.com/v3/gists/ + + + + + Initializes a new instance of the class. + + The date for which only gists updated at or after this time are returned. + + + + Gets or sets the date for which only gists updated at or after this time are returned. + + + This is sent as a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ + + + The since. + + + + + Used to update a gist and its contents. + + + Note: All files from the previous version of the gist are carried over by default if not included in the + object. Deletes can be performed by including the filename with a null object. + API docs: https://developer.github.com/v3/gists/ + + + + + Gets a dictionary of gist files to update. + + + Note: All files from the previous version of the gist are carried over by default if not included in the + hash. Deletes can be performed by including the filename with a `null` hash. + + + + + Used to update a invitation. + + + + + + + Used to filter issue comments. + + + + + Initializes a new instance of the class. + + + + + Can be either created or updated. Default: created. + + + + + Can be either asc or desc. Default: asc. + + + + + Only comments updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. + + + + + Used to filter a request to list issues. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the which indicates which sorts of issues to return. + + + The filter. + + + + + Gets or sets the for the issues to return. + + + The state. + + + + + Gets the labels to filter by. Add labels to the collection to only request issues with those labels. + + Sent as a comma separated list + + The labels. + + + + + Gets or sets the property to sort the returned issues by. + Combine this with to specify sort direction. + + + The sort property. + + + + + Gets or sets the sort direction. + + + The sort direction. + + + + + Gets or sets the date for which only issues updated at or after this time are returned. + + + This is sent as a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. + + + The since. + + + + + The range of filters available for issues. + + http://developer.github.com/v3/issues/#list-issues + + + + Issues assigned to the authenticated user. (Default) + + + + + Issues created by the authenticated user. + + + + + Issues mentioning the authenticated user. + + + + + Issues the authenticated user is subscribed to for updates. + + + + + All issues the authenticated user can see, regardless of participation or creation. + + + + + Range of states for Issues, Milestones and PullRequest API. + + + + + Items that are open. + + + + + Items that are closed. + + + + + All the items. + + + + + Items that are open OR closed + + + + + Items that are open + + + + + Items that are closed + + + + + The available properties to sort issues by. + + + + + Sort by create date (default) + + + + + Sort by the date of the last update + + + + + Sort by the number of comments + + + + + The two possible sort directions. + + + + + Sort ascending + + + + + Sort descending + + + + + Specifies the values used to update an issue. + + + + + Title of the issue (required) + + + + + Details about the issue. + + + + + List of logins for the multiple users that this issue should be assigned to + + + Only users with push access can set the multiple assignees for new issues. The assignees are silently dropped otherwise. + + + + + Milestone to associate this issue with. + + + Only users with push access can set the milestone for new issues. The milestone is silently dropped + otherwise + + + + + Labels to associate with this issue. + + + Only users with push access can set labels for new issues. Labels are silently dropped otherwise. + + + + + Whether the issue is open or closed. + + + + + Adds the specified assigness to the issue. + + The login of the assignee. + + + + Clears all the assignees. + + + + + Removes the specified assignee from the issue + + The login of the assignee to remove + + + + Adds the specified label to the issue. + + The name of the label. + + + + Clears all the labels. + + + + + Removes the specified label from the issue + + The name of the label to remove + + + + Used to update an existing label. + + + + + Initializes a new instance of the class. + + The name of the label. + The color of the label. + + + + Name of the label (required). + + + + + Color of the label (required). + + + + + A short description of the label (optional). + + + + + Used to mark a notification as "read" which removes it from the default view on GitHub.com. + + + https://developer.github.com/v3/activity/notifications/#mark-as-read + + + + + Initializes a new instance of the class. + + + + + Describes the last point that notifications were checked. Anything updated since this time will not be + updated. + + + This is sent as a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: the current time. + + + + + Used to merge a pull request (Merge Button). + + + https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button + + + + + The message that will be used for the merge commit (optional) + + + + + The SHA that pull request head must match to allow merge (optional) + + + + + The Title for the automatic commit message (optional) + + + + + Specify the Merge method to use (optional - default is Merge) + + + + + Method to use when merging a PR + + + + + Create a merge commit + + + + + Squash and merge + + + + + Rebase and merge + + + + + Used to filter requests for lists of milestones + + + + + Which Milestones to get. The default is . + + + + + Used to update a milestone + + + + + Title of the milestone (required) + + + + + Whether the milestone is open or closed. The default is . + + + + + Optional description for the milestone. + + + + + An optional date when the milestone is due. + + + + + Used to create anarbitrary markdown + + + API: https://developer.github.com/v3/markdown/#render-an-arbitrary-markdown-document + + + + + Create an arbitrary markdown + + The Markdown text to render + The rendering mode. Can be either markdown by default or gfm + + The repository context. Only taken into account when rendering as gfm + + + + + Create an arbitrary markdown + + The Markdown text to render + + + + + Create an arbitrary markdown + + The Markdown text to render + The rendering mode. Can be either markdown by default or gfm + + + + Gets the markdown text + + + The text. + + + + + Gets the mode of the text + + + The mode. + + + + + Gets the context of the markdown + + + The context. + + + + + Used to create a new authorization. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The note. + The scopes. + + + + Initializes a new instance of the class. + + The note. + The scopes. + The fingerprint. + + + + Replaces the authorization scopes with this list. + + + + + Optional parameter that allows an OAuth application to create multiple authorizations for a single user + + + + + An optional note to remind you what the OAuth token is for. + + + + + An optional URL to remind you what app the OAuth token is for. + + + + + Used to create a Blob. + + + + + The content of the blob. + + + + + The encoding of the blob. + + + + + Creates a new Check Run + + Required. The name of the check. For example, "code-coverage" + Required. The SHA of the commit + + + + Required. The name of the check. For example, "code-coverage" + + + + + Required. The SHA of the commit + + + + + The URL of the integrator's site that has the full details of the check + + + + + A reference for the run on the integrator's system + + + + + The current status. Can be one of queued, in_progress, or completed. Default: queued + + + + + The time that the check run began + + + + + Required if you provide completed_at or a status of completed. The final conclusion of the check. Can be one of success, failure, neutral, cancelled, timed_out, or action_required. When the conclusion is action_required, additional details should be provided on the site specified by details_url. + Note: Providing conclusion will automatically set the status parameter to completed + + + + + Required if you provide conclusion. The time the check completed + + + + + Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run + + + + + Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted + + + + + Constructs a CheckRunAction request object + + Required. The text to be displayed on a button in the web UI. The maximum size is 20 characters + Required. A short explanation of what this action would do. The maximum size is 40 characters + Required. A reference for the action on the integrator's system. The maximum size is 20 characters + + + + Required. The text to be displayed on a button in the web UI. The maximum size is 20 characters + + + + + Required. A short explanation of what this action would do. The maximum size is 40 characters + + + + + Required. A reference for the action on the integrator's system. The maximum size is 20 characters + + + + + Constructs a CheckRunCreateAnnotation request object + + Required. The path of the file to add an annotation to. For example, assets/css/main.css + Required. The start line of the annotation + Required. The end line of the annotation + Required. The level of the annotation. Can be one of notice, warning, or failure + Required. A short description of the feedback for these lines of code. The maximum size is 64 KB + + + + Constructs a CheckRunCreateAnnotation request object (using Filename, BlobHref and WarningLevel) + + Required. The path of the file to add an annotation to. For example, assets/css/main.css + Required. The file's full blob URL. You can find the blob_href in the response of the Get a single commit endpoint, by reading the blob_url from an element of the files array. You can also construct the blob URL from the head_sha, the repository, and the filename: https://github.com/:owner/:repo/blob/:head_sha/:filename + Required. The start line of the annotation + Required. The end line of the annotation + Required. The warning level of the annotation. Can be one of notice, warning, or failure + Required. A short description of the feedback for these lines of code. The maximum size is 64 KB + + + + Required. The path of the file to add an annotation to. For example, assets/css/main.css + + + + + Required. The path of the file to add an annotation to. For example, assets/css/main.css + + + + + Required. The file's full blob URL. You can find the blob_href in the response of the Get a single commit endpoint, by reading the blob_url from an element of the files array. You can also construct the blob URL from the head_sha, the repository, and the filename: https://github.com/:owner/:repo/blob/:head_sha/:filename + + + + + Required. The start line of the annotation + + + + + Required. The end line of the annotation + + + + + Required. The start line of the annotation + + + + + Required. The end line of the annotation + + + + + Required. The warning level of the annotation. Can be one of notice, warning, or failure + + + + + Required. The level of the annotation. Can be one of notice, warning, or failure + + + + + Required. A short description of the feedback for these lines of code. The maximum size is 64 KB + + + + + The title that represents the annotation. The maximum size is 255 characters + + + + + Details about this annotation. The maximum size is 64 KB + + + + + Constructs a CheckRunImage request object + + Required. The alternative text for the image + Required. The full URL of the image + + + + Required. The alternative text for the image + + + + + Required. The full URL of the image + + + + + A short image description + + + + + Constructs a CheckRunOutput request object + + Required. The title of the check run + Required. The summary of the check run. This parameter supports Markdown + + + + Required. The title of the check run + + + + + Required. The summary of the check run. This parameter supports Markdown + + + + + The details of the check run. This parameter supports Markdown + + + + + Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. For details about annotations in the UI, see "About status checks" + + + + + Adds images to the output displayed in the GitHub pull request UI + + + + + Creates a new Check Suite + + Required. The sha of the head commit + + + + Required. The sha of the head commit + + + + + Used to create a commit. + + + API: https://developer.github.com/v3/git/commits/#create-a-commit + + + + + Create a new commit which has multiple parents (i.e. a merge commit) + + The message to associate with the commit + The tree associated with the commit + + The SHAs of the commits that were the parents of this commit. If empty, the commit will be written as a + root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of + more than one should be provided. + + + + + Create a new commit which does not have any parents + + The message to associate with the commit + The tree associated with the commit + + + + Create a new commit which has one parent + + The message to associate with the commit + The tree associated with the commit + The commit to use as a parent + + + + Gets the commit message. + + + The message. + + + + + Gets the tree associated with the commit. + + + The tree. + + + + + Gets the SHAs of the commits that were the parents of this commit. If empty, the commit will be written as + a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of + more than one should be provided. + + + The parents. + + + + + Gets or sets the author of the commit. If omitted, it will be filled in with the authenticated user’s + information and the current date. + + + The author. + + + + + Gets or sets the person who applied the commit. If omitted, this will be filled in with the + . + + + The committer. + + + + + Describes a new commit comment to create via the method. + + + + + Initializes a new instance of the class. + + The body of the comment. + + + + The contents of the comment (required) + + + + + Relative path of the file to comment on + + + + + Line index in the diff to comment on + + + + + Used to create a new commit status. + + + + + The state of the commit. + + + + + URL associated with this status. GitHub.com displays this URL as a link to allow users to easily see the + ‘source’ of the Status. For example, if your Continuous Integration system is posting build status, + you would want to provide the deep link for the build output for this specific sha. + + + + + Short description of the status. + + + + + A string label to differentiate this status from the status of other systems. + + + + + Describes a new deployment key to create. + + + API: https://developer.github.com/v3/repos/keys/ + + + + + Gets or sets a name for the deployment key. + + + The title. + + + + + Gets or sets the contents of the deployment key. + + + The key. + + + + + Gets or sets a value indicating whether the key will only be able to read repository contents. Otherwise, + the key will be able to read and write. + + + true if [read only]; otherwise, false. + + + + + Describes a new deployment status to create. Deployments are a request for a specific ref(branch,sha,tag) to + be deployed. + + + API: https://developer.github.com/v3/repos/deployments/ + + + + + Initializes a new instance of the class. + + The ref to deploy. + + + + The ref to deploy. This can be a branch, tag, or sha. (REQUIRED) + + + + + Gets or sets the optional task used to specify a task to execute, e.g. deploy or deploy:migrations. + Default: deploy + + + The task. + + + + + Merges the default branch into the requested deployment branch if true; + Does nothing if false. (DEFAULT if not specified: True) + + + + + Optional array of status contexts verified against commit status checks. If this property is null then + all unique contexts will be verified before a deployment is created. To bypass checking entirely, set this + to an empty collection. Defaults to all unique contexts (aka null). + + + The required contexts. + + + + + JSON payload with extra information about the deployment. + + + + + Optional name for the target deployment environment (e.g., production, staging, qa). Default: "production" + + + The environment. + + + + + A short description of the deployment. + + + + + Indicates if the environment is specific to a deployment and will no longer exist at some point in the future. + (DEFAULT if not specified: False) + + + + + Indicates if the environment is one with which end users directly interact. + (DEFAULT if not specified: True when environment is "production" and False otherwise) + + + + + The types of deployments tasks that are availabel. + + + + + Deploy everything (default) + + + + + Deploy migrations only. + + + + + Describes a new deployment status to create. + + + + + Initializes a new instance of the class. + + State of the deployment (Required). + + + + The state of the status. + + + + + The target URL to associate with this status. This URL should contain + output to keep the user updated while the task is running or serve as + historical information for what happened in the deployment + + + + + A short description of the status. + + + + + The URL for accessing your environment. + + + + + Indicates if a new inactive status should be added to all non-transient, + non-production environment deployments with the same repository and environment + name as the created status's deployment. + (DEFAULT if not specified: True) + + + + + Used to create a new Gist. + + + + + The description of the gist. + + + + + Indicates whether the gist is public + + + + + Files that make up this gist using the key as Filename + and value as Content + + + + + Describes a new Impersonation Token to create via the method. + + + + + Initializes a new instance of the class. + + The scopes for the token. + + + + The scopes for the token + + + + + Describes a new issue to create via the method. + + + + + Initializes a new instance of the class. + + The title of the issue. + + + + Title of the milestone (required) + + + + + Details about the issue. + + + + + List of logins for the multiple users that this issue should be assigned to + + + Only users with push access can set the multiple assignees for new issues. The assignees are silently dropped otherwise. + + + + + Milestone to associate this issue with. + + + Only users with push access can set the milestone for new issues. The milestone is silently dropped + otherwise + + + + + Labels to associate with this issue. + + + Only users with push access can set labels for new issues. Labels are silently dropped otherwise. + + + + + Describes a new label to create via the method. + + + + + Initializes a new instance of the class. + + The name of the label. + The color of the label. + + + + Name of the label (required). + + + Emoji can be added to label names, using either native emoji or colon-style markup. For example, + typing :strawberry: will render the emoji for strawberry. For a full list of available emoji and codes, see http://emoji-cheat-sheet.com/. + + + + + Color of the label (required). + + + The hexadecimal color code for the label, without the leading #. + + + + + A short description of the label (optional). + + + + + Used to merge branches in a repository. + + + + The Repo Merging API supports merging branches in a repository. This accomplishes essentially the same thing + as merging one branch into another in a local repository and then pushing to GitHub. The benefit is that the + merge is done on the server side and a local repository is not needed. This makes it more appropriate for + automation and other tools where maintaining local repositories would be cumbersome and inefficient. + + API: https://developer.github.com/v3/repos/merging/ + + + + + Create a new commit which has multiple parents (i.e. a merge commit) + + The name of the base branch that the head will be merged into + The head to merge. This can be a branch name or a commit SHA1. + + + + Gets or sets the commit message. + + + The commit message. + + + + + The name of the base branch that the head will be merged into (REQUIRED). + + + The base. + + + + + The head to merge. This can be a branch name or a commit SHA1 (REQUIRED). + + + The head. + + + + + Describes a new milestone to create via the method. + + + + + Initializes a new instance of the class. + + The title. + + + + Title of the milestone (required) + + + + + Whether the milestone is open or closed. The default is . + + + + + Optional description for the milestone. + + + + + An optional date when the milestone is due. + + + + + Initializes a new instance of the class. + + The name of the project. + + + + Required. Gets or sets the name of the project. + + + + + Optional. Gets or sets the body of the project. + + + + + The note of the card. + + + + + The id of the Issue or Pull Request to associate with this card. + + + + + The type of content to associate with this card. + + + + + Required. Gets or sets the name of the column. + + + + + Used to create a public SSH key + + + + + The title of the key + + + + + The Key data + + + + + Describes a new pull request to create via the method. + + + + + Initializes a new instance of the class. + + The title of the pull request. + The branch (or git ref where your changes are implemented. In other words, the source branch/ref + The base (or git ref) reference you want your changes pulled into. In other words, the target branch/ref + + + + Title of the pull request (required) + + + + + The branch (or git ref) you want your changes pulled into (required). + + + + + The branch (or git ref) where your changes are implemented (required). + + + + + Whether maintainers of the base repository can push to the HEAD branch (optional). + + + + + Body of the pull request (optional) + + + + + Initializes a new instance of the class. + + The reaction type. + + + + The reaction type (required) + + + + + Used to create a new Git reference. + + API: https://developer.github.com/v3/git/refs/#create-a-reference + + + + Initializes a new instance of the class. + + + The name of the fully qualified reference (ie: refs/heads/master). If it doesn’t start with ‘refs’ and + have at least two slashes, it will be rejected. + + The SHA1 value to set this reference to + + + + The name of the fully qualified reference (ie: refs/heads/master). If it doesn’t start with ‘refs’ and + have at least two slashes, it will be rejected. + + + The reference. + + + + + The SHA1 value to set this reference to + + + The sha. + + + + + Used to create a new release. + + + API: https://developer.github.com/v3/repos/releases/#create-a-release + + + + + Initializes a new instance of the class. + + Name of the tag to create in the repository for this release. + + + + Gets the name of the tag. + + + The name of the tag. + + + + + Specifies the commitish value that determines where the Git tag is created from. Can be any branch or + commit SHA. Unused if the Git tag already exists. Default: the repository’s default branch + (usually master). + + + The target commitish. + + + + + Gets or sets the name of the release. + + + The name. + + + + + Gets or sets the text describing the contents of the tag. + + + The body. + + + + + Gets or sets a value indicating whether this is a draft (unpublished). + Default: false + + + true if draft; otherwise, false. + + + + + Gets or sets a value indicating whether this is prerelease. + + + true if prerelease; otherwise, false. + + + + + Describes a new repository to create via the method. + + + + + Creates an object that describes the repository to create on GitHub. + + The name of the repository. This is the only required parameter. + + + + Optional. Gets or sets whether to create an initial commit with empty README. The default is false. + + + + + Required. Gets or sets the new repository's description + + + + + Optional. Gets or sets whether to enable downloads for the new repository. The default is true. + + + + + Optional. Gets or sets whether to enable issues for the new repository. The default is true. + + + + + Optional. Gets or sets whether to enable the wiki for the new repository. The default is true. + + + + + Optional. Gets or sets the new repository's optional website. + + + + + Optional. Gets or sets the desired language's or platform's .gitignore template to apply. Use the name of the template without the extension; "Haskell", for example. Ignored if is null or false. + + + + + Optional. Gets or sets the desired Desired LICENSE template to apply. Use the name of the template without + the extension. For example, “mit” or “mozilla”. + + + The list of license templates are here: https://github.com/github/choosealicense.com/tree/gh-pages/_licenses + Just omit the ".txt" file extension for the template name. + + + + + Required. Gets or sets the new repository's name. + + + + + Optional. Gets or sets whether the new repository is private; the default is false. + + + + + Optional. Gets or sets the Id of the team to grant access to this repository. This is only valid when creating a repository for an organization. + + + + + Used to fork a repository. + + + API: https://developer.github.com/v3/repos/forks/#create-a-fork + + + + + Gets or sets the organization name to fork into (Optional). If not specified, creates a fork for the + authenticated user. + + + The organization. + + + + + Creates a Webhook for the repository. + + + To create a webhook, the following fields are required by the config: + + + url + A required string defining the URL to which the payloads will be delivered. + + + content_type + + An optional string defining the media type used to serialize the payloads. Supported values include json and + form. The default is form. + + + + secret + + An optional string that’s passed with the HTTP requests as an X-Hub-Signature header. The value of this + header is computed as the HMAC hex digest of the body, using the secret as the key. + + + + insecure_ssl: + + An optional string that determines whether the SSL certificate of the host for url will be verified when + delivering payloads. Supported values include "0" (verification is performed) and "1" (verification is not + performed). The default is "0". + + + + + API: https://developer.github.com/v3/repos/hooks/#create-a-hook + + + + + + Initializes a new instance of the class. + + + Use "web" for a webhook or use the name of a valid service. (See + https://api.github.com/hooks for the list of valid service + names.) + + + Key/value pairs to provide settings for this hook. These settings vary between the services and are + defined in the github-services repository. Booleans are stored internally as “1” for true, and “0” for + false. Any JSON true/false values will be converted automatically. + + + + + Gets the name of the hook to create. Use "web" for a webhook or use the name of a valid service. (See + https://api.github.com/hooks for the list of valid service + names.) + + + The name. + + + + + Key/value pairs to provide settings for this hook. These settings vary between the services and are + defined in the github-services repository. Booleans are stored internally as “1” for true, and “0” for + false. Any JSON true/false values will be converted automatically. + + + The configuration. + + + + + Determines what events the hook is triggered for. Default: ["push"] + + + The events. + + + + + Determines whether the hook is actually triggered on pushes. + + + true if active; otherwise, false. + + + + + Creates a Webhook for the repository. + + + To create a webhook, the following fields are required by the config: + + + url + A required string defining the URL to which the payloads will be delivered. + + + content_type + + An optional string defining the media type used to serialize the payloads. Supported values include json and + form. The default is form. + + + + secret + + An optional string that’s passed with the HTTP requests as an X-Hub-Signature header. The value of this + header is computed as the HMAC hex digest of the body, using the secret as the key. + + + + insecure_ssl: + + An optional string that determines whether the SSL certificate of the host for url will be verified when + delivering payloads. Supported values include "0" (verification is performed) and "1" (verification is not + performed). The default is "0". + + + + + API: https://developer.github.com/v3/repos/hooks/#create-a-hook + + + + + + Initializes a new instance of the class. + Using default values for ContentType, Secret and InsecureSsl. + + + Use "web" for a webhook or use the name of a valid service. (See + https://api.github.com/hooks for the list of valid service + names.) + + + Key/value pairs to provide settings for this hook. These settings vary between the services and are + defined in the github-services repository. Booleans are stored internally as “1” for true, and “0” for + false. Any true/false values will be converted automatically. + + + A required string defining the URL to which the payloads will be delivered. + + + + + Gets the URL of the hook to create. + + + The URL. + + + + + Gets the content type used to serialize the payload. The default is `form`. + + + The content type. + + + + + Gets the secret used as the key for the HMAC hex digest + of the body passed with the HTTP requests as an X-Hub-Signature header. + + + The secret. + + + + + Gets whether the SSL certificate of the host will be verified when + delivering payloads. The default is `false`. + + + true if SSL certificate verification is not performed; + otherwise, false. + + + + + The supported content types for payload serialization. + + + + + Used to watch a repository (subscribe to repository's notifications). Called by the + method. + + + API: https://developer.github.com/v3/activity/watching/#set-a-repository-subscription + + + + + Determines if notifications should be received from this repository. + + + If you would like to watch a repository, set subscribed to true. If you would like to ignore notifications + made within a repository, set ignored to true. If you would like to stop watching a repository, delete the + repository’s subscription completely using the method. + + + + + Determines if all notifications should be blocked from this repository. + + + + + Used to create a new tag + + + Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create + an annotated tag in Git, you have to do this call to create the tag object, and then create the + refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference + - this call would be unnecessary. + + + + + Gets or sets the tag. + + + The tag. + + + + + Gets or sets the tag message. + + + The message. + + + + + The SHA of the git object this is tagging + + + The object. + + + + + The type of the object we’re tagging. Normally this is a commit but it can also be a tree or a blob. + + + The type. + + + + + An object with information about the individual creating the tag. + + + The tagger. + + + + + Used to create a team. + + + + In order to create a team, the authenticated user must be a member of :org. + + API: https://developer.github.com/v3/orgs/teams/#create-team + + + + + Initializes a new instance of the class. + + The name. + + + + The name of the team (required). + + + + + The description of the team. + + + + + The logins of organization members to add as maintainers of the team + + + + + The full name (e.g., "organization-name/repository-name") of repositories to add the team to + + + + + The level of privacy this team should have (default: Secret) + + + + + The permission that new repositories will be added to the team with when none is specified (default: Pull) + + + + + Id of a team to set as the parent team + + + + + Represents updatable fields for a users subscription to a given thread + + + + + Determines if notifications should be received from this thread + + + + + Determines if all notifications should be blocked from this thread + + + + + Used to create a new Tree. + + + The tree creation API will take nested entries as well. If both a tree and a nested path modifying that tree + are specified, it will overwrite the contents of that tree with the new path contents and write a new tree out. + + + + + The SHA1 of the tree you want to update with new data. + + + + + The list of Tree Items for this new Tree item. + + + + + A tree item that would be included as part of a when creating a tree. + + + + + The file referenced in the tree. + + + + + String of the file mode - one of 100644 for file (blob), + 100755 for executable (blob), 040000 for subdirectory (tree), + 160000 for submodule (commit) or + 120000 for a blob that specifies the path of a symlink + + + + + The type of tree item this is. + + + + + The SHA for this Tree item. + + + + + Gets or sets the The content you want this file to have. GitHub will write this blob out and use that SHA + for this entry. Use either this, or tree.sha. + + + The content. + + + + + Describes a new user to create via the method. + + + + + Initializes a new instance of the class. + + The login for the user. + The email address of the user + + + + Login of the user + + + + + Email address of the user + + + + + Specifies the parameters to filter notifications by + + + + + If true, show notifications marked as read. Default: false + + + + + If true, only shows notifications in which the user is directly participating or mentioned. Default: false + + + + + Only show notifications updated after the given time. Defaults to the everything if unspecified. + + + + + Only show notifications updated before the given time. + + + This is sent as a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. + + + The before. + + + + + Used to initiate an OAuth2 authentication flow from 3rd party web sites. + + + + + Creates an instance of the OAuth login request with the required parameter. + + The client Id you received from GitHub when you registered the application. + + + + The client Id you received from GitHub when you registered the application. + + + + + The URL in your app where users will be sent after authorization. + + + See the documentation about redirect urls + for more information. + + + + + A set of scopes to request. If not provided, scope defaults to an empty list of scopes for users that don’t + have a valid token for the app. For users who do already have a valid token for the app, the user won’t be + shown the OAuth authorization page with the list of scopes. Instead, this step of the flow will + automatically complete with the same scopes that were used last time the user completed the flow. + + + See the scopes documentation for more + information about scopes. + + + + + An unguessable random string. It is used to protect against cross-site request forgery attacks. In ASP.NET + MVC this would correspond to an anti-forgery token. + + + + + Used to create an Oauth login request. + + + + + Creates an instance of the OAuth login request with the required parameter. + + The client Id you received from GitHub when you registered the application. + The client secret you received from GitHub when you registered. + The code you received as a response to making the OAuth login request + + + + The client Id you received from GitHub when you registered the application. + + + + + The client secret you received from GitHub when you registered. + + + + + The code you received as a response to making the OAuth login + request. + + + + + The URL in your app where users will be sent after authorization. + + + See the documentation about redirect urls + for more information. + + + + + Used as part of the request to retrieve all organizations. + + + + + Intializes a new instance of the class. + + The integer Id of the last Organization that you've seen. + + + + Gets or sets the integer Id of the last Organization that you've seen. + + + + + Represents updateable fields on an organization. Values that are null will not be sent in the request. + Use string.empty to clear a value. + + + + + Billing email address. This address is not publicized. + + + + + The company name. + + + + + The publicly visible email address. + + + + + The location. + + + + + The shorthand name of the company. + + + + + Gets or sets the description of the organization. + + + The description. + + + + + Used to describe a permission level. + + + + + team members can pull, push and administer these repositories. + + + + + team members can pull and push, but not administer these repositories + + + + + team members can pull, but not push to or administer these repositories + + + + + Used to filter requests for lists of projects + + + + + Used to filter requests for lists of projects + + + + + Used to filter requests for lists of projects + + Which project cards to include. + + + + Which project cards to include./>. + + + + + Items that are open. + + + + + Items that are closed. + + + + + All the items. + + + + + The new note of the card. + + + + + Archive/Unarchive the card. + + + + + Required. Gets or sets the name of the column. + + + + + Used to filter requests for lists of projects + + + + + Which projects to get. The default is . + + + + + The new name of the project. + + + + + The new body of the project. + + + + + The new state of the project. + + + + + Used as part of the request to retrieve all public repositories. + + + + + Initializes a new instance of the class. + + The Id of the last Repository that you’ve seen. + + + + Gets or sets the integer Id of the last Repository that you’ve seen. + + + The since. + + + + + Used to filter requests for lists of pull requests. + + + + + Which PullRequests to get. The default is + + + + + Filter pulls by head user and branch name in the format of "user:ref-name". + + + + + Filter pulls by base branch name. + + + + + What property to sort pull requests by. + + + + + What direction to sort the pull requests. + + + + + Sort by created date (default) + + + + + Sort by last updated date + + + + + Sort by popularity (comment count) + + + + + Sort by age (filtering by pulls updated in the last month) + + + + + Used to create a pull request review comment. + + + + + Creates a comment + + The text of the comment + The SHA of the commit to comment on + The relative path of the file to comment on + The line index in the diff to comment on + + + + The text of the comment. + + + + + The SHA of the commit to comment on. + + + + + The relative path of the file to comment on. + + + + + The line index in the diff to comment on. + + + + + Used to edit a pull request review comment + + + + + Creates an edit to a comment + + The new text of the comment + + + + The new text of the comment. + + + + + Used to create a reply to a pull request review comment. + + + + + Creates a comment that is replying to another comment. + + The text of the comment + The comment Id to reply to + + + + The text of the comment. + + + + + The comment Id to reply to. + + + + + Used to filter pull request review comments. + + + + + Initializes a new instance of the class. + + + + + Can be either created or updated. Default: created. + + + + + Can be either asc or desc. Default: asc. + + + + + Only comments updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. + + + + + Used to create a pull request review + + + + + The Commit ID which the review is being created for. Default is the latest. + + + + + The body of the review message + + + + + The review event - Approve, Request Changes, Comment or leave blank (null) for Pending. + + + + + List of comments to include with this review + + + + + Used to dismiss a pull request review + + + + + The message explaining why this review is being dismissed + + + + + Used to add and delete pull request review requests. + + + API: https://developer.github.com/v3/pulls/review_requests/#create-a-review-request + API: https://developer.github.com/v3/pulls/review_requests/#delete-a-review-request + + + + + Used to submit a pending pull request review + + + + + The body of the review message + + + + + The review event - Approve, Request Changes, Comment + + + + + The review is approved + + + + + The review requests changes that must be addressed before merging + + + + + The review provides comment without explicit approval + + + + + Used to update an existing pull request. + + + + + Title of the pull request (required) + + + + + Whether the pull request is open or closed. The default is . + + + + + The body for the pull request. Supports GFM. + + + + + The base branch of the pull request. + + + + + Whether maintainers of the base repository can push to the HEAD branch. + + + + + Upsed to update a Git reference. + + + + + Initializes a new instance of the class. + + The sha. + + + + Initializes a new instance of the class. + + The SHA1 value to set this reference to. + + Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this + out or setting it to false will make sure you’re not overwriting work. + + + + + The SHA1 value to set this reference to. + + + The sha. + + + + + Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this + out or setting it to false will make sure you’re not overwriting work. + + + true if force; otherwise, false. + + + + + Used to update a release asset. + + + + + Initializes a new instance of the class. + + The name. + + + + The file name of the asset. + This field is required. + + + + + An alternate description of the asset. + Used in place of the filename. + + + + + Used to upload a release asset. + + + This endpoint makes use of a Hypermedia relation to determine which URL to access. This endpoint is provided + by a URI template in the release’s API response. You need to use an HTTP client which supports SNI to make + calls to this endpoint. The asset data is expected in its raw binary form, rather than JSON. Everything else + about the endpoint is the same as the rest of the API. For example, you’ll still need to pass your + authentication to be able to upload an asset. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Name of the file. + + The content type of the asset. Example: "application/zip". For a list of acceptable types, refer this list + of common media types. + + The raw data. + The timeout. + + + + Gets or sets the name of the file. + + + The name of the file. + + + + + Gets or sets the type of the content. + + + The type of the content. + + + + + Gets or sets the raw data. + + + The raw data. + + + + + Gets or sets the timeout. + + + The timeout. + + + + + Used to update a release. + + + API: https://developer.github.com/v3/repos/releases/#create-a-release + + + + + Gets the name of the tag. + + + The name of the tag. + + + + + Specifies the commitish value that determines where the Git tag is created from. Can be any branch or + commit SHA. Unused if the Git tag already exists. Default: the repository’s default branch + (usually master). + + + The target commitish. + + + + + Gets or sets the name of the release. + + + The name. + + + + + Gets or sets the text describing the contents of the tag. + + + The body. + + + + + Gets or sets a value indicating whether this is a draft (unpublished). + Default: false + + + true if draft; otherwise, false. + + + + + Gets or sets a value indicating whether this is prerelease. + + + true if prerelease; otherwise, false. + + + + + Used to request and filter a list of repository forks. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the sort property. + + + The sort. + + + + + The sort order. + + + + + Sort by date and show the newest first. + + + + + Sort by date and show the oldest first. + + + + + Sort by the number of stargazers. + + + + + Used to request and filter a list of repository issues. + + + + + Identifies a filter for the milestone. Use "*" for issues with any milestone. + Use the milestone number for a specific milestone. Use the value "none" for issues with any milestones. + + + + + Filter on the user assigned for the request + + + Specify "none" for issues with no assigned user + + + + + The user that created the issue + + + + + A user that’s mentioned in the issue + + + + + Used to add or update a team repository. + + + + + The permission to grant the team on this repository. + + + + + Used to request and filter a list of repositories. + + + + + Gets or sets the repository type. + + + The type. + + + + + Gets or sets the sort property. + + + The sort. + + + + + Gets or sets the sort direction. + + + The direction. + + + + + Gets or sets the visibility property. + + + The visibility. + + + + + Gets or sets the affiliation property. + + + The affiliation. + + + + + The properties that repositories can be filtered by. + + + + + Return all repositories. + + + + + Return repositories that the current authenticated user owns. + + + + + Returns public repositories. + + + + + The privateReturn private repositories. + + + + + Return repositories for which the current authenticated user is a member of the org or team. + + + + + The properties that repositories can be sorted by. + + + + + Sort by the date the repository was created. + + + + + Sort by the date the repository was last updated. + + + + + Sort by the date the repository was last pushed. + + + + + Sort by the repository name. + + + + + The properties that repositories can be visible by. + + + + + Returns only public repositories + + + + + Returns only private repositories + + + + + Return both public and private repositories + + + + + The properties that repositories can be affiliated by. + + + + + Repositories that are owned by the authenticated user + + + + + Repositories that the user has been added to as a collaborator. + + + + + Repositories that the user has access to through being a member of an organization. + This includes every repository on every team that the user is on. + + + + + Return repositories that are owned by authenticated user and added to as a collaborator. + + + + + Return repositories that are owned by authenticated user or user is a organization member. + + + + + Return repositories that user has been added as collaborator or user is a organization member. + + + + + Returns all repositories where user is owner,collaborator or organization member. + + + + + Describes the transfer of a repository to a new owner. + + + + + Creates a new repository transfer description with no team Ids. + + The new owner of the repository after the transfer. + + + + Creates a new repository transfer description. + + The new owner of the repository after the transfer. + A list of team Ids to add to the repository after the transfer (only applies to transferring to an Organization). + + + + The new owner of the repository after the transfer. + + + + + A list of team Ids to add to the repository after the transfer (only applies to transferring to an Organization). + + + + + Represents updatable fields on a repository. Values that are null will not be sent in the request. + Use string.empty if you want to clear a value. + + + + + Creates an object that describes an update to a repository on GitHub. + + The name of the repository. This is the only required parameter. + + + + Required. Gets or sets the repository name. + + + + + Optional. Gets or sets the repository description. The default is null (do not update) + + + + + Optional. Gets or sets the repository homepage url. The default is null (do not update). + + + + + Gets or sets whether to make the repository private. The default is null (do not update). + + + + + Gets or sets whether to enable issues for the repository. The default is null (do not update). + + + + + Optional. Gets or sets whether to enable the wiki for the repository. The default is null (do not update). + + + + + Optional. Gets or sets whether to enable downloads for the repository. The default is null (do not update). + + + + + Optional. Gets or sets the default branch. The default is null (do not update). + + + + + Optional. Allows the "Rebase and Merge" method to be used. + + + + + Optional. Allows the "Squash Merge" merge method to be used. + + + + + Optional. Allows the "Create a merge commit" merge method to be used. + + + + + Optional. True to archive this repository. Note: you cannot unarchive repositories through the API. + + + + + Base class for classes which represent query string parameters to certain API endpoints. + + + + + Converts the derived object into a dictionary that can be used to supply query string parameters. + + + + + + Searching Code/Files + http://developer.github.com/v3/search/#search-code + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The search term. + + + + Initializes a new instance of the class. + + The term. + The owner. + The name. + + + + Optional Sort field. Can only be indexed, which indicates how recently + a file has been indexed by the GitHub search infrastructure. + If not provided, results are sorted by best match. + + + http://developer.github.com/v3/search/#search-code + + + + + Qualifies which fields are searched. With this qualifier you can restrict + the search to just the file contents, the file path, or both. + + + https://help.github.com/articles/searching-code#search-in + + + + + Searches code based on the language it’s written in. + + + https://help.github.com/articles/searching-code#language + + + + + Specifies that code from forked repositories should be searched. + Repository forks will not be searchable unless the fork has more + stars than the parent repository. + + + https://help.github.com/articles/searching-code#forks + + + + + Finds files that match a certain size (in bytes). + + + https://help.github.com/articles/searching-code#size + + + + + Specifies the path that the resulting file must be at. + + + https://help.github.com/articles/searching-code#path + + + + + Matches files with a certain extension. + + + https://help.github.com/articles/searching-code#extension + + + + + Matches specific file names + + + https://help.github.com/articles/searching-code/#search-by-filename + + + + + Limits searches to a specific user. + + + https://help.github.com/articles/searching-code#users-organizations-and-repositories + + + + + Limits searches to a specific organization. + + + https://help.github.com/articles/searching-code/#search-within-a-users-or-organizations-repositories + + + + + Limits searches to a specific repository. + + + https://help.github.com/articles/searching-code#users-organizations-and-repositories + + + + + Searching Issues + + + + + Search without specifying a keyword + + + + + Search using a specify keyword + + The term to filter on + + + + Optional Sort field. One of comments, created, updated or merged + If not provided, results are sorted by best match. + + + https://help.github.com/articles/searching-issues/#sort-the-results + + + + + With this qualifier you can restrict the search to issues or pull request only. + + + https://help.github.com/articles/searching-issues/#search-issues-or-pull-requests + + + + + Qualifies which fields are searched. With this qualifier you can restrict + the search to just the title, body, comments, or any combination of these. + + + https://help.github.com/articles/searching-issues/#scope-the-search-fields + + + + + Finds issues created by a certain user. + + + https://help.github.com/articles/searching-issues/#search-by-the-author-of-an-issue-or-pull-request + + + + + Finds issues that are assigned to a certain user. + + + https://help.github.com/articles/searching-issues/#search-by-the-assignee-of-an-issue-or-pull-request + + + + + Finds issues that mention a certain user. + + + https://help.github.com/articles/searching-issues/#search-by-a-mentioned-user-within-an-issue-or-pull-request + + + + + Finds issues that a certain user commented on. + + + https://help.github.com/articles/searching-issues/#search-by-a-commenter-within-an-issue-or-pull-request + + + + + Finds issues that were either created by a certain user, assigned to that user, + mention that user, or were commented on by that user. + + + https://help.github.com/articles/searching-issues/#search-by-a-user-thats-involved-within-an-issue-or-pull-request + + + + + Finds issues that @mention a team within the organization + + + https://help.github.com/articles/searching-issues/#search-by-a-team-thats-mentioned-within-an-issue-or-pull-request + + + + + Filter issues based on whether they’re open or closed. + + + https://help.github.com/articles/searching-issues/#search-based-on-whether-an-issue-or-pull-request-is-open + + + + + Filters issues based on the labels assigned. + + + https://help.github.com/articles/searching-issues/#search-by-the-labels-on-an-issue + + + + + Searches for issues based on missing metadata. + + + https://help.github.com/articles/searching-issues/#search-by-missing-metadata-on-an-issue-or-pull-request + + + + + Searches for issues in repositories that match a certain language. + + + https://help.github.com/articles/searching-issues/#search-by-the-main-language-of-a-repository + + + + + Searches for issues using a more human syntax covering options like state, type, merged status, private/public repository + + + https://help.github.com/articles/searching-issues/#search-based-on-the-state-of-an-issue-or-pull-request + + + + + Filters issues based on times of creation. + + + https://help.github.com/articles/searching-issues/#search-based-on-when-an-issue-or-pull-request-was-created-or-last-updated + + + + + Filters issues based on times when they were last updated. + + + https://help.github.com/articles/searching-issues/#search-based-on-when-an-issue-or-pull-request-was-created-or-last-updated + + + + + Filters pull requests based on times when they were last merged. + + + https://help.github.com/articles/searching-issues/#search-based-on-when-a-pull-request-was-merged + + + + + Filters pull requests based on the status of the commits. + + + https://help.github.com/articles/searching-issues/#search-based-on-commit-status + + + + + Filters pull requests based on the branch they came from. + + + https://help.github.com/articles/searching-issues/#search-based-on-branch-names + + + + + Filters pull requests based on the branch they are merging into. + + + https://help.github.com/articles/searching-issues/#search-based-on-branch-names + + + + + Filters issues based on times when they were last closed. + + + https://help.github.com/articles/searching-issues/#search-based-on-when-an-issue-or-pull-request-was-closed + + + + + Filters issues based on the quantity of comments. + + + https://help.github.com/articles/searching-issues#comments + + + + + Limits searches to repositories owned by a certain user or organization. + + + https://help.github.com/articles/searching-issues/#search-within-a-users-or-organizations-repositories + + + + + Gets or sets the milestone to filter issues based on + + + + + Filters issues or pull requests based on whether they are in an archived repository. + + + + + search by number of comments + + + + + search by created + + + + + search by last updated + + + + + search by last merged + + + + + Searching Issues + + + + + Exclusions for Issue Search + + + + + Excludes issues created by a certain user. + + + https://help.github.com/articles/searching-issues/#search-by-the-author-of-an-issue-or-pull-request + + + + + Excludes issues that are assigned to a certain user. + + + https://help.github.com/articles/searching-issues/#search-by-the-assignee-of-an-issue-or-pull-request + + + + + Excludes issues that mention a certain user. + + + https://help.github.com/articles/searching-issues/#search-by-a-mentioned-user-within-an-issue-or-pull-request + + + + + Excludes issues that a certain user commented on. + + + https://help.github.com/articles/searching-issues/#search-by-a-commenter-within-an-issue-or-pull-request + + + + + Excludes issues that were either created by a certain user, assigned to that user, + mention that user, or were commented on by that user. + + + https://help.github.com/articles/searching-issues/#search-by-a-user-thats-involved-within-an-issue-or-pull-request + + + + + Excludes issues based on open/closed state. + + + https://help.github.com/articles/searching-issues/#search-based-on-whether-an-issue-or-pull-request-is-open + + + + + Excludes issues based on the labels assigned. + + + https://help.github.com/articles/searching-issues/#search-by-the-labels-on-an-issue + + + + + Excludes issues in repositories that match a certain language. + + + https://help.github.com/articles/searching-issues/#search-by-the-main-language-of-a-repository + + + + + Excludes pull requests based on the status of the commits. + + + https://help.github.com/articles/searching-issues/#search-based-on-commit-status + + + + + Excludes pull requests based on the branch they came from. + + + https://help.github.com/articles/searching-issues/#search-based-on-branch-names + + + + + Excludes pull requests based on the branch they are merging into. + + + https://help.github.com/articles/searching-issues/#search-based-on-branch-names + + + + + Excludes issues which target the specified milestone. + + + https://help.github.com/articles/searching-issues-and-pull-requests/#search-by-milestone-on-an-issue-or-pull-request + + + + + Search labels + https://developer.github.com/v3/search/#search-labels + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The search term. + The repository to search in + + + + Optional Sort field. One of created or updated. + If not provided, results are sorted by best match. + + + + + The repository to search in + + + + + search by created + + + + + search by last updated + + + + + Used to qualify a search term. + + + + + Greater than ">" + + + + + Less than "<" + + + + + Less than or equal to. "<=" + + + + + Greater than or equal to. ">=" + + + + + Searching Repositories + http://developer.github.com/v3/search/#search-repositories + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The search term. + + + + For https://help.github.com/articles/searching-repositories#sorting + Optional Sort field. One of stars, forks, or updated. If not provided, results are sorted by best match. + + + + + The in qualifier limits what fields are searched. With this qualifier you can restrict the search to just the repository name, description, README, or any combination of these. + Without the qualifier, only the name and description are searched. + https://help.github.com/articles/searching-repositories#search-in + + + + + Filters repositories based on the number of forks, and/or whether forked repositories should be included in the results at all. + https://help.github.com/articles/searching-repositories#forks + + + + + Filters repositories based whether forked repositories should be included in the results at all. + Defaults to ExcludeForks + https://help.github.com/articles/searching-repositories#forks + + + + + The size qualifier finds repository's that match a certain size (in kilobytes). + https://help.github.com/articles/searching-repositories#size + + + + + Searches repositories based on the language they’re written in. + https://help.github.com/articles/searching-repositories#languages + + + + + Searches repositories based on the number of stars. + https://help.github.com/articles/searching-repositories#stars + + + + + Limits searches to a specific user or repository. + https://help.github.com/articles/searching-repositories#users-organizations-and-repositories + + + + + Filters repositories based on times of creation. + https://help.github.com/articles/searching-repositories#created-and-last-updated + + + + + Filters repositories based on when they were last updated. + https://help.github.com/articles/searching-repositories#created-and-last-updated + + + + + Filters whether archived repositories should be included (true) or not (false). + + + + + https://help.github.com/articles/searching-repositories#search-in + The in qualifier limits what fields are searched. With this qualifier you can restrict the search to just the + repository name, description, README, or any combination of these. + + + + + Helper class in generating the range values for a qualifer e.g. In or Size qualifiers + + + + + Matches repositories that are size MB exactly + + + + + Matches repositories that are between and KB + + + + + Matches repositories with regards to the size + We will use the to see what operator will be applied to the size qualifier + + + + + Helper class that build a with a LessThan comparator used for filtering results + + + + + Helper class that build a with a LessThanOrEqual comparator used for filtering results + + + + + Helper class that build a with a GreaterThan comparator used for filtering results + + + + + Helper class that build a with a GreaterThanOrEqualTo comparator used for filtering results + + + + + helper class in generating the date range values for the date qualifier e.g. + https://help.github.com/articles/searching-repositories#created-and-last-updated + + + + + Matches repositories with regards to the . + We will use the to see what operator will be applied to the date qualifier + + + + + Matches repositories with regards to both the and dates. + + + + + helper method to create a LessThan Date Comparison + e.g. < 2011 + + date to be used for comparison (times are ignored) + + + + + helper method to create a LessThanOrEqualTo Date Comparison + e.g. <= 2011 + + date to be used for comparison (times are ignored) + + + + + helper method to create a GreaterThan Date Comparison + e.g. > 2011 + + date to be used for comparison (times are ignored) + + + + + helper method to create a GreaterThanOrEqualTo Date Comparison + e.g. >= 2011 + + date to be used for comparison (times are ignored) + + + + + helper method to create a bounded Date Comparison + e.g. 2015-08-01..2015-10-31 + + earlier date of the two + latter date of the two + + + + + lanuages that can be searched on in github + https://help.github.com/articles/searching-repositories#languages + + + + + sorting repositories by any of below + https://help.github.com/articles/searching-repositories#sorting + + + + + search by number of stars + + + + + search by number of forks + + + + + search by last updated + + + + + https://help.github.com/articles/searching-repositories#forks + Specifying whether forked repositories should be included in results or not. + + + + + only search for forked repos + + + + + include forked repos into the search + + + + + Searching Users + + + + + Initializes a new instance of the class. + + The search term. + + + + Optional Sort field. One of followers, repositories, or joined. If not provided (null), results are sorted by best match. + https://help.github.com/articles/searching-users#sorting + + + + + The sort field as a string. + + + + + Filter users based on the number of followers they have. + https://help.github.com/articles/searching-users#followers + + + + + Filter users based on when they joined. + https://help.github.com/articles/searching-users#created + + + + + Filter users by the location indicated in their profile. + https://help.github.com/articles/searching-users#location + + + + + Filters users based on the number of repositories they have. + https://help.github.com/articles/searching-users#repository-count + + + + + Search for users that have repositories that match a certain language. + https://help.github.com/articles/searching-users#language + + + + + With this qualifier you can restrict the search to just personal accounts or just organization accounts. + https://help.github.com/articles/searching-users#type + + + + + Qualifies which fields are searched. With this qualifier you can restrict the search to just the username, public email, full name, or any combination of these. + https://help.github.com/articles/searching-users#search-in + + + + + Account Type used to filter search result + + + + + User account + + + + + Organization account + + + + + User type to filter search results + + + + + Search by the username + + + + + Search by the user's email address + + + + + Search by the user's full name + + + + + + + + + + Information about an author or committer. + + + + + Creates an instance of Signature with the required values. + + + + + + + The full name of the author/committer. + + + + + The email address of the author/committer. + + + + + Used to retrieve and filter lists of stars. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the sort property. + + + The sort property. + + + + + Gets or sets the sort direction. + + + The sort direction. + + + + + Property to sort stars by. + + + + + Sort y the date the star was created. + + + + + Sort by the date the star was last updated. + + + + + Request body for starting a migration. + + + See docs + for more information. + + + + + Parameter-less constructor needed for SimpleJsonSerializer. + + + + + Instantiate a new Migration Request object. + + List of repositories in {owner}/{repo} format. + To lock the repos or not. + To exclude the attachments or not. + + + + Required. A list of arrays indicating which repositories should be migrated. + + + + + Indicates whether repositories should be locked (to prevent manipulation) + while migrating data. Default: false. + + + + + Indicates whether attachments should be excluded from the migration + (to reduce migration archive file size). Default: false. + + + + + Used to filter requests for team members + + + + + Which membership roles to get + + + + + Filtering by Roles within a Team + + + + + Regular Team Member + + + + + Team Maintainer + + + + + All Roles + + + + + Used to update a teamm. + + + + + Initializes a new instance of the class. + + The updated team name. + + + + The name of the team (required). + + + + + The description of the team. + + + + + The level of privacy this team should have (default: Secret) + + + + + The permission that new repositories will be added to the team with when none is specified (default: Pull) + + + + + Id of a team to set as the parent team + + + + + Used to filter requests for team members + + + + + Which membership roles to get + + + + + Describes the new login when renaming a user via the method. + + + + + Initializes a new instance of the class. + + The new login for the user. + + + + The new username for the user + + + + + Represents updatable fields on a user. Values that are null will not be sent in the request. + Use string.empty if you want to clear a value. + + + + + This user's bio. + + + + + URL for this user's blog. + + + + + The company this user's works for. + + + + + This user's email. + + + + + The geographic location of this user. + + + + + This user's full name. + + + + + Tells if this user is currently hireable. + + + + + The access token + + + + + The expiration date + + + + + Base class for a GitHub account, most often either a or . + + + + + URL of the account's avatar. + + + + + The account's bio. + + + + + URL of the account's blog. + + + + + Number of collaborators the account has. + + + + + Company the account works for. + + + + + Date the account was created. + + + + + Amount of disk space the account is using. + + + + + The account's email. + + + + + Number of follwers the account has. + + + + + Number of other users the account is following. + + + + + Indicates whether the account is currently hireable. + + True if the account is hirable; otherwise, false. + + + + The HTML URL for the account on github.com (or GitHub Enterprise). + + + + + The account's system-wide unique Id. + + + + + GraphQL Node Id + + + + + The account's geographic location. + + + + + The account's login. + + + + + The account's full name. + + + + + The type of account associated with this entity + + + + + Number of private repos owned by the account. + + + + + Plan the account pays for. + + + + + Number of private gists the account has created. + + + + + Number of public gists the account has created. + + + + + Number of public repos the account owns. + + + + + Total number of private repos the account owns. + + + + + The account's API URL. + + + + + User account + + + + + Organization account + + + + + Bot account + + + + + An entry in the activity event stream + + + + + The type of the activity. + + + + + Whether the activity event is public or not. + + + + + The repository associated with the activity event. + + + + + The user associated with the activity event. + + + + + The organization associated with the activity event. + + + + + The date the activity event was created. + + + + + The activity event Id. + + + + + The payload associated with the activity event. + + + + + The name of the repository. + + + + + The SHA of the reference. + + + + + The date the commit status was created. + + + + + The date the commit status was updated. + + + + + The state of the commit + + + + + URL associated with this status. GitHub.com displays this URL as a link to allow users to easily see the + ‘source’ of the Status. + + + + + Short description of the status. + + + + + A string label to differentiate this status from the status of other systems. + + + + + The unique identifier of the status. + + + + + The relevant commit. + + + + + The organization associated with the event. + + + + + The branches involved. + + + + + Represents lines added and deleted at a given point in time + + + + + Construct an instance of AdditionsAndDeletions + + + If the list of data points is not 3 elements + + + + Date of the recorded activity + + + + + Lines added for the given day + + + + + Lines deleted for the given day + + + + + Error payload from the API reposnse + + + + + The error message + + + + + URL to the documentation for this error. + + + + + Additional details about the error + + + + + Represents an oauth application. + + + + + Name. + + + + + The Url of this . + + + + + Represents an oauth access given to a particular application. + + + + + The oauth token (be careful with these, they are like passwords!). + + + This will return only return a value the first time + the authorization is created. All subsequent API calls + (for example, 'get' for an authorization) will return `null` + + + + + GraphQL Node Id + + + + + Represents an oauth access given to a particular application. + + + + + The Id of this . + + + + + The API URL for this . + + + + + The that created this . + + + + + The last eight characters of the user's token + + + + + Base-64 encoded representation of the SHA-256 digest of the token + + + + + Optional parameter that allows an OAuth application to create + multiple authorizations for a single user + + + + + Notes about this particular . + + + + + A url for more information about notes. + + + + + When this was created. + + + + + When this was last updated. + + + + + The scopes that this has. This is the kind of access that the token allows. + + + + + GraphQL Node Id + + + + + The content of the blob. + + + + + The encoding of the blob. + + + + + The SHA of the blob. + + + + + The size of the blob. + + + + + The SHA of the blob. + + + + + Name of this . + + + + + Whether this is protected. + + + + + The history for this . + + + + + Protection details for a . + + + Note: this is a PREVIEW api: https://developer.github.com/changes/2016-06-27-protected-branches-api-update/ + + + + + Status check settings for the protected branch + + + + + Required review settings for the protected branch + + + + + Push access restrictions for the protected branch + + + + + Specifies whether the protections applied to this branch also apply to repository admins + + + + + Specifies whether the protections applied to this branch also apply to repository admins + + + + + Specifies settings for status checks which must pass before branches can be merged into the protected branch + + + + + Require branches to be up to date before merging + + + + + Require status checks to pass before merging + + + + + Specifies people or teams allowed to push to the protected branch. Required status checks will still prevent these people from merging if the checks fail + + + + + Push access is restricted to the specified Teams + + + + + Push access is restricted to the specified Users + + + + + Specifies if pull request reviews are required before merging a pull request. Can optionally enforce the policy on repository administrators also. + + + + + Specify which users and teams can dismiss pull request reviews. + + + + + Dismiss approved reviews automatically when a new commit is pushed. + + + + + Blocks merge until code owners have reviewed. + + + + + Specifies people or teams allowed to push to the protected branch. Required status checks will still prevent these people from merging if the checks fail + + + + + The specified Teams that can dismiss reviews + + + + + The specified Users who can dismiss reviews + + + + + The Id of the check run + + + + + The SHA of the commit the check run is associated with + + + + + A reference for the run on the integrator's system + + + + + The GitHub Api URL of the check run + + + + + The GitHub.com URL of the check run + + + + + The check run status + + + + + The final conclusion of the check + + + + + The time that the check run began + + + + + The time the check run completed + + + + + Descriptive details about the run + + + + + The name of the check + + + + + The check suite that is associated with this check run + + + + + The GitHub App that is associated with this check run + + + + + The pull requests that are associated with this check run + + + + + The path of the file the annotation refers to + + + + + The path of the file the annotation refers to + + + + + The file's full blob URL + + + + + The start line of the annotation + + + + + The end line of the annotation + + + + + The start line of the annotation + + + + + The end line of the annotation + + + + + The warning level of the annotation. Can be one of notice, warning, or failure + + + + + The level of the annotation. Can be one of notice, warning, or failure + + + + + A short description of the feedback for these lines of code + + + + + The title that represents the annotation + + + + + Details about this annotation + + + + + The title of the check run + + + + + The summary of the check run + + + + + The details of the check run + + + + + The number of annotation entries for the check run (use to get annotation details) + + + + + The total number of check runs that match the request filter + + + + + The retrieved check runs + + + + + The Id of the check suite + + + + + The branch the check suite is associated with + + + + + The SHA of the head commit in the push that created the check suite + + + + + The summarized status of the check runs included in the check suite + + + + + The summarized conclusion of the check runs included in the check suite + + + + + The GitHub Api URL of the check suite + + + + + The hash of the commit prior to the push that created the check suite + + + + + The hash of the commit after the push that created the check suite (or HeadSha if no later commits exist) + + + + + The pull requests that are associated with the check suite + + + + + The GitHub App for the check suite + + + + + The repository for the check suite + + + + + The check suite preferences + + + + + The repository the check suite preferences are related to + + + + + The total number of check suites that match the request filter + + + + + The retrieved check suites + + + + + Represents the summary of lines added and deleted + + + + + Construct an instance of CodeFrequency + + Raw data + + + + A weekly aggregate of the number of additions and deletions pushed to a repository. + + + + + The combined state of the commits. + + + + + The SHA of the reference. + + + + + The total number of statuses. + + + + + The statuses. + + + + + The repository of the reference. + + + + + Returns the last year of commit activity grouped by week. + + + + + The issue comment Id. + + + + + GraphQL Node Id + + + + + The URL for this repository comment. + + + + + The html URL for this repository comment. + + + + + Details about the repository comment. + + + + + Relative path of the file that was commented on. + + + + + Line index in the diff that was commented on. + + + + + The line number in the file that was commented on. + + + + + The commit + + + + + The user that created the repository comment. + + + + + The date the repository comment was created. + + + + + The date the repository comment was last updated. + + + + + The reaction summary for this comment. + + + + + Information about a file in a repository. It does not include the contents of the file. + + + + + Name of the content. + + + + + Path to this content. + + + + + SHA of this content. + + + + + Size of the content. + + + + + The type of this content. It might be a File, Directory, Submodule, or Symlink + + + + + URL to the raw content + + + + + URL to this content + + + + + The GIT URL to this content. + + + + + The URL to view this content on GitHub. + + + + + The date the commit status was created. + + + + + The date the commit status was updated. + + + + + The state of the commit + + + + + URL associated with this status. GitHub.com displays this URL as a link to allow users to easily see the + ‘source’ of the Status. + + + + + Short description of the status. + + + + + A string label to differentiate this status from the status of other systems. + + + + + The unique identifier of the status. + + + + + GraphQL Node Id + + + + + The URL of the status. + + + + + The user that created the status. + + + + + Represents the state of a commit. + + + + + The commit state is still being determined. A build server might set this when it starts a build. + + + + + The build was successful for the commit. + + + + + There was some error with the build. + + + + + The build completed and reports a failure. + + + + + The possible repository content types. + + + + + Represents a contributor on GitHub. + + + + + Id of this deployment. + + + + + GraphQL Node Id + + + + + + + + + + The API URL for this deployment. + + + + + The that created the deployment. + + + + + JSON payload with extra information about the deployment. + + + + + Date and time that the deployment was created. + + + + + Date and time that the deployment was updated. + + + + + A short description of the deployment. + + + + + The API URL for the es of this deployment. + + + + + Indicates if the environment is specific to a deployment and will no longer exist at some point in the future. + + + + + Indicates if the environment is one with which end users directly interact. + + + + + Id of this deployment status. + + + + + GraphQL Node Id + + + + + The API URL for this deployment status. + + + + + The state of this deployment status. + + + + + The that created this deployment status. + + + + + JSON payload with extra information about the deployment. + + + + + The target URL of this deployment status. This URL should contain + output to keep the user updated while the task is running or serve + as historical information for what happened in the deployment + + + + + The target URL of this deployment status. This URL should contain + output to keep the user updated while the task is running or serve as + historical information for what happened in the deployment + + + + + The URL for accessing your environment. + + + + + The date and time that the status was created. + + + + + The date and time that the status was updated. + + + + + A short description of the status. + + + + + A users email + + + + + The email address + + + + + True if the email is verified; otherwise false + + + + + True if this is the users primary email; otherwise false + + + + + "private" or "public" if the email address is the primary; + otherwise null + + + + + Represents the visibility of an email address. + + + + + Primary email address and is public + + + + + Primary email address and is private + + + + + Describes a pre-receive environment. + + + + + Identifier for the pre-receive environment. + + + + + The name of the environment as displayed in the UI. + + + + + URL to the pre-receive environment. + + + + + URL to the tarball that will be downloaded and extracted. + + + + + UI URL to the pre-receive environment. + + + + + Whether this is the default environment that ships with GitHub Enterprise. + + + + + The time when the pre-receive environment was created. + + + + + The number of pre-receive hooks that use this environment. + + + + + This environment's download status. + + + + + Prepares an for use when updating a pre-receive environment. + + + + + + Describes the current download state of a pre-receive environment image. + + + + + URL to the download status for a pre-receive environment. + + + + + The state of the most recent download. + + + + + On failure, this will have any error messages produced. + + + + + The time when the most recent download started. + + + + + The state of the most recent download. + + + + + The id of the issue/pull request event. + + + + + GraphQL Node Id + + + + + The URL for this event. + + + + + Always the User that generated the event. + + + + + The user that was assigned, if the event was 'Assigned'. + + + + + The label that was assigned, if the event was 'Labeled' + + + + + Identifies the actual type of Event that occurred. + + + + + The String SHA of a commit that referenced this Issue. + + + + + Date the event occurred for the issue/pull request. + + + + + The issue was closed by the actor. When the commit_id is present, it identifies the commit that + closed the issue using “closes / fixes #NN” syntax. + + + + + The issue was reopened by the actor. + + + + + The actor subscribed to receive notifications for an issue. + + + + + The issue was merged by the actor. The commit_id attribute is the SHA1 of the HEAD commit that was merged. + + + + + The issue was referenced from a commit message. The commit_id attribute is the commit SHA1 of where + that happened. + + + + + The actor was @mentioned in an issue body. + + + + + The issue was assigned to the actor. + + + + + The issue was unassigned to the actor. + + + + + A label was added to the issue. + + + + + A label was removed from the issue. + + + + + The issue was added to a milestone. + + + + + The issue was removed from a milestone. + + + + + The issue title was changed. + + + + + The issue was locked by the actor. + + + + + The issue was unlocked by the actor. + + + + + The pull request’s branch was deleted. + + + + + The pull request’s branch was restored. + + + + + The actor dismissed a review from the pull request. + + + + + The actor requested review from the subject on this pull request. + + + + + The actor removed the review request for the subject on this pull request. + + + + + The issue was added to a project board. + + + + + The issue was moved between columns in a project board. + + + + + The issue was removed from a project board. + + + + + The issue was created by converting a note in a project board to an issue. + + + + + The actor unsubscribed from notifications for an issue. + + + + + A comment was added to the issue. + + + + + A commit was added to the pull request's HEAD branch. + Only provided for pull requests. + + + + + Base branch of the pull request was changed. + + + + + The issue was referenced from another issue. + The source attribute contains the id, actor, and + url of the reference's source. + + + + + The issue was reveiewed. + + + + + A line comment was made. + + + + + A commit comment was made. + + + + + A user with write permissions marked an issue as a duplicate of another issue or a pull request as a duplicate of another pull request. + + + + + An issue that a user had previously marked as a duplicate of another issue is no longer considered a duplicate. + + + + + An issue comment was deleted. + + + + + Lists all the feeds available to the authenticating user: + + + + + The GitHub global public timeline + + + + + The public timeline for any user, using URI template + + + + + The public timeline for the authenticated user + + + + + The private timeline for the authenticated user + + + + + The private timeline for activity created by the authenticated user + + + + + The private timeline for the authenticated user for a given organization, using URI template + + + + + List of feed urls including feed url and feed type, e.g. application/atom+xml + + + + + Collection of feeds including both url and type + + + + + The GitHub global public timeline + + + + + The public timeline for any user, using URI template + + + + + The public timeline for the authenticated user + + + + + The private timeline for the authenticated user + + + + + The private timeline for activity created by the authenticated user + + + + + The private timeline for the authenticated user for a given organization, using URI template + + + + + Feed information including feed url and feed type + + + + + Link to feed + + + + + Feed type, e.g. application/atom+xml + + + + + The API URL for this . + + + + + The Id of this . + + + Given a gist url of https://gist.github.com/UserName/1234 the Id would be '1234'. + + + + + GraphQL Node Id + + + + + A description of the . + + + + + Indicates if the is private or public. + + + + + The who owns this . + + + Given a gist url of https://gist.github.com/UserName/1234 the Owner would be 'UserName'. + + + + + A containing all s in this . + + + + + The number of comments on this . + + + + + A url to retrieve the comments for this . + + + + + URL to view the gist on gist.github.com. + + + + + The git url to pull from to retrieve the contents for this . + + + + + The git url to push to when changing this . + + + + + The for when this was created. + + + + + The for when this was last updated. + + + + + A of all that exist for this . + + + + + A of all containing the full history for this . + + + + + Used by to indicate the level of change. + + + + + The number of deletions that occurred as part of this change. + + + + + The number of additions that occurred as part of this change. + + + + + The total number of changes. + + + + + The gist comment id. + + + + + GraphQL Node Id + + + + + The URL for this gist comment. + + + + + The body of this gist comment. + t + + + + The user that created this gist comment. + + + + + The date this comment was created. + + + + + The date this comment was last updated. + + + + + The size in bytes of the file. + + + + + The name of the file + + + + + The mime type of the file + + + + + The programming language of the file, if any. + + + + + The text content of the file. + + + + + The url to download the file. + + + + + GraphQL Node Id + + + + + The that created this + + + + + The API URL for this . + + + + + The for when this was created. + + + + + A historical version of a + + + + + The url that can be used by the API to retrieve this version of the . + + + + + A git sha representing the version. + + + + + The who create this version. + + + + + A that represents the level of change for this . + + + + + The the version was created. + + + + + Represents a GitHub application. + + + + + The Id of the GitHub App. + + + + + The Name of the GitHub App. + + + + + The Owner of the GitHub App. + + + + + The Description of the GitHub App. + + + + + The URL to the GitHub App's external website. + + + + + The URL to view the GitHub App on GitHub + + + + + Date the GitHub App was created. + + + + + Date the GitHub App was last updated. + + + + + An enhanced git commit containing links to additional resources + + + + + Gets the GitHub account information for the commit author. It attempts to match the email + address used in the commit with the email addresses registered with the GitHub account. + If no account corresponds to the commit email, then this property is null. + + + + + Gets the GitHub account information for the commit committer. It attempts to match the email + address used in the commit with the email addresses registered with the GitHub account. + If no account corresponds to the commit email, then this property is null. + + + + + The affected files in a . + + + + + The name of the file + + + + + Number of additions performed on the file. + + + + + Number of deletions performed on the file. + + + + + Number of changes performed on the file. + + + + + File status, like modified, added, deleted. + + + + + The url to the file blob. + + + + + The url to file contents API. + + + + + The raw url to download the file. + + + + + The SHA of the file. + + + + + The patch associated with the commit + + + + + The previous filename for a renamed file. + + + + + An enhanced git commit containing links to additional resources + + + + + The number of additions made within the commit + + + + + The number of deletions made within the commit + + + + + The total number of modifications within the commit + + + + + GraphQL Node Id + + + + + The URL associated with this reference. + + + + + The reference label. + + + + + The reference identifier. + + + + + The sha value of the reference. + + + + + The user associated with this reference. + + + + + The repository associated with this reference. + + + + + Represents an application installation. + + + For more information see https://developer.github.com/v3/apps/#find-installations + + + + + The user who owns the Installation. + + + + + The URL to view the Installation on GitHub. + + + + + The Id of the associated GitHub App. + + + + + The Id of the User/Organization the Installation is installed in + + + + + The type of the target (User or Organization) + + + + + The Permissions granted to the Installation + + + + + The Events subscribed to by the Installation + + + + + The single file the GitHub App can managem (when Permissions.SingleFile is set to read or write) + + + + + The choice of repositories the installation is on. Can be either "selected" or "all". + + + + + The Installation Id. + + + + + Repository metadata + Search repositories, list collaborators, and access repository metadata. + + + + + Repository administration + Repository creation, deletion, settings, teams, and collaborators. + + + + + Commit statuses + Commit statuses. + + + + + Deployments + Deployments and deployment statuses. + + + + + Issues + Issues and related comments, assignees, labels, and milestones. + + + + + Pages + Retrieve Pages statuses, configuration, and builds, as well as create new builds. + + + + + Pull requests + Pull requests and related comments, assignees, labels, milestones, and merges. + + + + + Repository contents + Repository contents, commits, branches, downloads, releases, and merges. + + + + + Single file + Manage just a single file. + + + + + Repository projects + Manage repository projects, columns, and cards. + + + + + Checks + Detailed information about CI checks + + + + + Organization members (only applicable when installed for an Organization ) + Organization members and teams. + + + + + Organization projects (only applicable when installed for an Organization ) + Manage organization projects, columns, and cards. + + + + + Team discussions (only applicable when installed for an Organization ) + Team discussions. + + + + + The total number of check suites that match the request filter + + + + + The retrieved check suites + + + + + The internal Id for this issue (not the issue number) + + + + + GraphQL Node Id + + + + + The URL for this issue. + + + + + The URL for the HTML view of this issue. + + + + + The Comments URL of this issue. + + + + + The Events URL of this issue. + + + + + The issue number. + + + + + Whether the issue is open or closed. + + + + + Title of the issue + + + + + Details about the issue. + + + + + Details about the user who has closed this issue. + + + + + The user that created the issue. + + + + + The set of labels applied to the issue + + + + + The user this issue is assigned to. + + + + + The multiple users this issue is assigned to. + + + + + The milestone, if any, that this issue is assigned to. + + + + + The number of comments on the issue. + + + + + The date the issue was closed if closed. + + + + + The date the issue was created. + + + + + The date the issue was last updated. + + + + + If the issue is locked or not. + + + + + The repository the issue comes from. + + + + + The reaction summary for this issue. + + + + + The issue comment Id. + + + + + GraphQL Node Id + + + + + The URL for this issue comment. + + + + + The html URL for this issue comment. + + + + + Details about the issue comment. + + + + + The date the issue comment was created. + + + + + The date the issue comment was last updated. + + + + + The user that created the issue comment. + + + + + The reaction summary for this comment. + + + + + Sort by create date (default) + + + + + Sort by the date of the last update + + + + + The id of the issue/pull request event. + + + + + GraphQL Node Id + + + + + The URL for this issue/pull request event. + + + + + Always the User that generated the event. + + + + + The user that was assigned, if the event was 'Assigned'. + + + + + The label that was assigned, if the event was 'Labeled' + + + + + Identifies the actual type of Event that occurred. + + + + + The String SHA of a commit that referenced this Issue. + + + + + The commit URL of a commit that referenced this issue. + + + + + Date the event occurred for the issue/pull request. + + + + + The issue associated to this event. + + + + + Url of the label + + + + + Name of the label + + + + + GraphQL Node Id + + + + + Color of the label + + + + + Description of the label + + + + + Is default label + + + + + Url to the license on https://choosealicense.com + + + + + A description of the license. + + + + + A group or family that the license belongs to such as the GPL family of licenses. + + + + + Notes on how to properly apply the license. + + + + + Set of codes for what is required under the terms of the license. For example, "include-copyright" + + + + + Set of codes for what is permitted under the terms of the license. For example, "commercial-use" + + + + + Set of codes for what is forbidden under the terms of the license. For example, "no-liability" + + + + + The text of the license + + + + + The + + + + + GraphQL Node Id + + + + + Friendly name of the license. + + + + + SPDX license identifier. + + + + + URL to retrieve details about a license. + + + + + Whether the license is one of the licenses featured on https://choosealicense.com + + + + + States of a Team/Organization Membership + + + + + The membership is pending + + + + + The membership is active + + + + + Response from the /meta endpoint that provides information about GitHub.com or a GitHub Enterprise instance. + + + + + Create an instance of the Meta + + + + + Create an instance of the Meta + + Whether authentication with username and password is supported. + The currently-deployed SHA of github-services. + An array of IP addresses in CIDR format specifying the addresses that incoming service hooks will originate from on GitHub.com. + An array of IP addresses in CIDR format specifying the Git servers for the GitHub server + An array of IP addresses in CIDR format specifying the A records for GitHub Pages. + An Array of IP addresses specifying the addresses that source imports will originate from on GitHub.com. + + + + Whether authentication with username and password is supported. (GitHub Enterprise instances using CAS or + OAuth for authentication will return false. Features like Basic Authentication with a username and + password, sudo mode, and two-factor authentication are not supported on these servers.) + + + + + The currently-deployed SHA of github-services. + + + + + An Array of IP addresses in CIDR format specifying the addresses that incoming service hooks will + originate from on GitHub.com. Subscribe to the API Changes blog or follow @GitHubAPI on Twitter to get + updated when this list changes. + + + + + An Array of IP addresses in CIDR format specifying the Git servers for GitHub.com. + + + + + An Array of IP addresses in CIDR format specifying the A records for GitHub Pages. + + + + + An Array of IP addresses specifying the addresses that source imports will originate from on GitHub.com. + + + + + Represents a migration. + + + See docs + for more information. + + + + + Parameter-less constructore needed for SimpleJsonSerializer. + + + + + Id of migration. + + + + + GraphQL Node Id + + + + + Guid of migration. + + + + + The state of migration. Can be one of pending, exporting, exported and failed. + + + + + Whether to lock repositories. + + + + + Whether attachments are excluded or not. + + + + + URL of migration. + + + + + Time of migration creation. + + + + + Time of migration updation. + + + + + List of locked repositories. + + + + + State of a migration. + + + See: https://developer.github.com/v3/migration/migrations/#get-the-status-of-a-migration + + + + + The migration hasn't started yet. + + + + + The migration is in progress. + + + + + The migration finished successfully. + + + + + The migration failed. + + + + + The URL for this milestone. + + + + + The Html page for this milestone. + + + + + The milestone number. + + + + + GraphQL Node Id + + + + + Whether the milestone is open or closed. + + + + + Title of the milestone. + + + + + Optional description for the milestone. + + + + + The user that created this milestone. + + + + + The number of open issues in this milestone. + + + + + The number of closed issues in this milestone. + + + + + The date this milestone was created. + + + + + The date, if any, when this milestone is due. + + + + + The date, if any, when this milestone was closed. + + + + + The date, if any, when this milestone was updated. + + + + + Object of resources rate limits + + + + + Legacy rate limit - to be depreciated - https://developer.github.com/v3/rate_limit/#deprecation-notice + + + + + The type of OAuth token + + + + + The secret OAuth access token. Use this to authenticate Octokit.net's client. + + + + + The list of scopes the token includes. + + + + + The billing address for an organization. This is only returned when updating + an organization. + + + + + GraphQL Node Id + + + + + The site has yet to be built + + + + + The build has been requested but not yet begun + + + + + The build is in progress + + + + + The site has been built + + + + + An error occurred during the build + + + + + Information about your GitHub Pages configuration + + + + + The pages's API URL. + + + + + Absolute URL to the rendered site. + + + + + Build status of the pages site. + + + + + CName of the pages site. Will be null if no CName was provided by the user. + + + + + Is a custom 404 page provided. + + + + + Metadata of a Github Pages build. + + + + + The pages's API URL. + + + + + The status of the build. + + + + + Error details - if there was one. + + + + + The user whose commit intiated the build. + + + + + Commit SHA. + + + + + Duration of the build + + + + + Returns the total commit counts for the owner and total commit counts in total in the last 52 weeks + + + + + Returns the commit counts made each week, for the last 52 weeks + + + + + Returns the commit counts made by the owner each week, for the last 52 weeks + + + + + The total number of commits made by the owner in the last 52 weeks. + + + + + + The total number of commits made by contributors in the last 52 weeks. + + + + + + The total number of commits made in the last 52 weeks. + + + + + + A plan (either paid or free) for a particular user + + + + + The number of collaborators allowed with this plan. + + This returns because GitHub Enterprise uses a sentinel value of 999999999999 to denote an "unlimited" number of collaborators. + + + + The name of the plan. + + + + + The number of private repositories allowed with this plan. + + This returns because GitHub Enterprise uses a sentinel value of 999999999999 to denote an "unlimited" number of plans. + + + + The amount of disk space allowed with this plan. + + This returns because GitHub Enterprise uses a sentinel value of 999999999999 to denote an "unlimited" amount of disk space. + + + + The billing email for the organization. Only has a value in response to editing an organization. + + + + + The URL for this projects repository. + + + + + The URL for this project. + + + + + The Id for this project. + + + + + GraphQL Node Id + + + + + The name for this project. + + + + + The body for this project. + + + + + The number for this project. + + + + + The current state of this project. + + + + + The user associated with this project. + + + + + When this project was created. + + + + + When this project was last updated. + + + + + The URL for this cards column. + + + + + The URL for this cards content. + + + + + The Id for this card. + + + + + GraphQL Node Id + + + + + The note for this card. + + + + + The user associated with this card. + + + + + When this card was created. + + + + + When this card was last updated. + + + + + Whether this card is archived. + + + + + The Id for this column. + + + + + GraphQL Node Id + + + + + The name for this column. + + + + + The URL for this columns project. + + + + + When this column was created. + + + + + When this column was last updated. + + + + + Only visible for the current user, or with the correct OAuth scope + + + + + Only visible for the current user, or with the correct OAuth scope + + + + + The internal Id for this pull request (not the pull request number) + + + + + GraphQL Node Id + + + + + The URL for this pull request. + + + + + The URL for the pull request page. + + + + + The URL for the pull request's diff (.diff) file. + + + + + The URL for the pull request's patch (.patch) file. + + + + + The URL for the specific pull request issue. + + + + + The URL for the pull request statuses. + + + + + The pull request number. + + + + + Whether the pull request is open or closed. The default is . + + + + + Title of the pull request. + + + + + The body (content) contained within the pull request. + + + + + When the pull request was created. + + + + + When the pull request was last updated. + + + + + When the pull request was closed. + + + + + When the pull request was merged. + + + + + The HEAD reference for the pull request. + + + + + The BASE reference for the pull request. + + + + + The user who created the pull request. + + + + + The user who is assigned the pull request. + + + + + The multiple users this pull request is assigned to. + + + + + The milestone, if any, that this pull request is assigned to. + + + + + Whether or not the pull request has been merged. + + + + + Whether or not the pull request can be merged. + + + + + Provides extra information regarding the mergeability of the pull request. + + + + + The user who merged the pull request. + + + + + The value of this field changes depending on the state of the pull request. + Not Merged - the hash of the test commit used to determine mergability. + Merged with merge commit - the hash of said merge commit. + Merged via squashing - the hash of the squashed commit added to the base branch. + Merged via rebase - the hash of the commit that the base branch was updated to. + + + + + Total number of comments contained in the pull request. + + + + + Total number of commits contained in the pull request. + + + + + Total number of additions contained in the pull request. + + + + + Total number of deletions contained in the pull request. + + + + + Total number of files changed in the pull request. + + + + + If the issue is locked or not + + + + + Whether maintainers of the base repository can push to the HEAD branch + + + + + Users requested for review + + + + + Provides extra information regarding the mergeability of a pull request + + + + + Merge conflict. Merging is blocked. + + + + + Mergeability was not checked yet. Merging is blocked. + + + + + Failing/missing required status check. Merging is blocked. + + + + + Head branch is behind the base branch. Only if required status checks is enabled but loose policy is not. Merging is blocked. + + + + + Failing/pending commit status that is not part of the required status checks. Merging is still allowed. + + + + + GitHub Enterprise only, if a repo has custom pre-receive hooks. Merging is allowed. + + + + + No conflicts, everything good. Merging is allowed. + + + + + GraphQL Node Id + + + + + Represents the response from an attempt to merge a pull request. + + + Note the request to merge is represented by + API: https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button + + + + + Initializes a new instance of the class. + + + + + The sha reference of the commit. + + + + + True if merged successfully, otherwise false. + + + + + The message that will be used for the merge commit. + + + + + The review Id. + + + + + GraphQL Node Id + + + + + The state of the review + + + + + The commit Id the review is associated with. + + + + + The user that created the review. + + + + + The text of the review. + + + + + The URL for this review on Github.com + + + + + The URL for the pull request via the API. + + + + + URL of the comment via the API. + + + + + The comment Id. + + + + + GraphQL Node Id + + + + + The diff hunk the comment is about. + + + + + The relative path of the file the comment is about. + + + + + The line index in the diff. + + + + + The comment original position. + + + + + The commit Id the comment is associated with. + + + + + The original commit Id the comment is associated with. + + + + + The user that created the comment. + + + + + The text of the comment. + + + + + The date the comment was created. + + + + + The date the comment was last updated. + + + + + The URL for this comment on Github.com + + + + + The URL for the pull request via the API. + + + + + The reaction summary for this comment. + + + + + The Id of the comment this comment replys to. + + + + + The Id of the pull request this comment belongs to. + + + + + Sort by create date (default) + + + + + Sort by the date of the last update + + + + + The raw punch card points + + + + + Gets the number of commits made on the specified day of the week + at the hour of the day, over the lifetime of this repository + + The day of the week to query + The hour in 24 hour time. 0-23. + The total number of commits made. + + + + The Id for this reaction. + + + + + GraphQL Node Id + + + + + Information about the user. + + + + + The reaction type for this commit comment. + + + + + GraphQL Node Id + + + + + GraphQL Node Id + + + + + GraphQL Node Id + + + + + The total number of check suites that match the request filter + + + + + The retrieved check suites + + + + + GraphQL Node Id + + + + + Represents a piece of content in the repository. This could be a submodule, a symlink, a directory, or a file. + Look at the Type property to figure out which one it is. + + + + + The encoding of the content if this is a file. Typically "base64". Otherwise it's null. + + + + + The Base64 encoded content if this is a file. Otherwise it's null. + + + + + The unencoded content. Only access this if the content is expected to be text and not binary content. + + + + + Path to the target file in the repository if this is a symlink. Otherwise it's null. + + + + + The location of the submodule repository if this is a submodule. Otherwise it's null. + + + + + The response from the Repository Contents API. The API assumes a dynamic client type so we need + to model that. + + https://developer.github.com/v3/repos/contents/ + + + + The content of the response. + + + + + The commit information for the content change. + + + + + License information + + + + + Represents a users contributions on a GitHub repository. + + + + + GraphQL Node Id + + + + + Whether the current user has administrative permissions + + + + + Whether the current user has push permissions + + + + + Whether the current user has pull permissions + + + + + Represents additional information about a star (such as creation time) + + + + + The date the star was created. + + + + + The repository associated with the star. + + + + + GraphQL Node Id + + + + + Rate limits for core API (rate limit for everything except Search API) + + + + + Rate Limits for Search API + + + + + file name + + + + + path to file + + + + + Sha for file + + + + + api-url to file + + + + + git-url to file + + + + + html-url to file + + + + + Repo where this file belongs to + + + + + Determines if notifications should be received from this repository. + + + + + Determines if all notifications should be blocked from this repository. + + + + + Url of the label + + + + + The for when this was created. + + + + + The API URL for this . + + + + + The API URL for this . + + + + + Represents the type of object being tagged + + + + + organization teams + + + + + url for this team + + + + + team id + + + + + GraphQL Node Id + + + + + team name + + + + + team description + + + + + team privacy + + + + + permission attached to this team + + + + + how many members in this team + + + + + how many repo this team has access to + + + + + who this team belongs to + + + + + The parent team + + + + + LDAP Binding (GitHub Enterprise only) + + + + + Used to describe a team's privacy level. + + + + + Only visible to organization owners and members of the team. + + + + + Visible to all members of the organization. + + + + + Roles within a Team + + + + + Regular Team Member + + + + + Team Maintainer + + + + + Determines if notifications should be received from this repository. + + + + + Determines if all notifications should be blocked from this repository. + + + + + Url of the label + + + + + The for when this was created. + + + + + The API URL for this . + + + + + The API URL for this thread. + + + + + GraphQL Node Id + + + + + The path for this Tree Item. + + + + + The mode of this Tree Item. + + + + + The type of this Tree Item. + + + + + The size of this Tree Item. + + + + + The SHA of this Tree Item. + + + + + The URL of this Tree Item. + + + + + The file mode to associate with a tree item + + + + + Mark the tree item as a file (applicable to blobs only) + + + + + Mark the tree item as an executable (applicable to blobs only) + + + + + Mark the tree item as a subdirectory (applicable to trees only) + + + + + Mark the tree item as a submodule (applicable to commits only) + + + + + Mark the tree item as a symlink (applicable to blobs only) + + + + + The SHA for this Tree response. + + + + + The URL for this Tree response. + + + + + The list of Tree Items for this Tree response. + + + + + Whether the response was truncated due to GitHub API limits. + + + + + Represents a user on GitHub. + + + + + Whether or not the user is an administrator of the site + + + + + When the user was suspended, if at all (GitHub Enterprise) + + + + + Whether or not the user is currently suspended + + + + + LDAP Binding (GitHub Enterprise only) + + + + + Date the user account was updated. + + + + + Represents the response information from a operation + + + + + Message indiating if the Rename request was queued + + + + + Url to the user that will be renamed + + + + + Represents additional information about a star (such as creation time) + + + + + The date the star was created. + + + + + The user associated with the star. + + + + + Represents a Signature Verification Object in Git Data Commit Payload. + + + + + Does GitHub consider the signature in this commit to be verified? + + + + + The reason for verified value. + + + + + The signature that was extracted from the commit. + + + + + The value that was signed. + + + + + The days array is a group of commits per day, starting on Sunday. + + + + + Totally number of commits made this week. + + + + + The week of commits + + + + + Get the number of commits made on any + + The day of the week + The number of commits made + + + + Represents the json array. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The capacity of the json array. + + + + The json representation of the array. + + The json representation of the array. + + + + Represents the json object. + + + + + The internal member dictionary. + + + + + Initializes a new instance of . + + + + + Initializes a new instance of . + + The implementation to use when comparing keys, or null to use the default for the type of the key. + + + + Gets the at the specified index. + + + + + + Adds the specified key. + + The key. + The value. + + + + Determines whether the specified key contains key. + + The key. + + true if the specified key contains key; otherwise, false. + + + + + Gets the keys. + + The keys. + + + + Removes the specified key. + + The key. + + + + + Tries the get value. + + The key. + The value. + + + + + Gets the values. + + The values. + + + + Gets or sets the with the specified key. + + + + + + Adds the specified item. + + The item. + + + + Clears this instance. + + + + + Determines whether [contains] [the specified item]. + + The item. + + true if [contains] [the specified item]; otherwise, false. + + + + + Copies to. + + The array. + Index of the array. + + + + Gets the count. + + The count. + + + + Gets a value indicating whether this instance is read only. + + + true if this instance is read only; otherwise, false. + + + + + Removes the specified item. + + The item. + + + + + Gets the enumerator. + + + + + + Returns an enumerator that iterates through a collection. + + + An object that can be used to iterate through the collection. + + + + + Returns a json that represents the current . + + + A json that represents the current . + + + + + This class encodes and decodes JSON strings. + Spec. details, see http://www.json.org/ + + JSON uses Arrays and Objects. These correspond here to the datatypes JsonArray(IList<object>) and JsonObject(IDictionary<string,object>). + All numbers are parsed to doubles. + + + + + Parses the string json into a value + + A JSON string. + An IList<object>, a IDictionary<string,object>, a double, a string, null, true, or false + + + + Try parsing the json string into a value. + + + A JSON string. + + + The object. + + + Returns true if successfull otherwise false. + + + + + Converts a IDictionary<string,object> / IList<object> object into a JSON string + + A IDictionary<string,object> / IList<object> + Serializer strategy to use + A JSON encoded string, or null if object 'json' is not serializable + + + + Determines if a given object is numeric in any way + (can be integer, double, null, etc). + + + + diff --git a/packages/FAKE.5.16.0/tools/Paket.Core.dll b/packages/FAKE.5.16.0/tools/Paket.Core.dll new file mode 100644 index 0000000..38bd0bf Binary files /dev/null and b/packages/FAKE.5.16.0/tools/Paket.Core.dll differ diff --git a/packages/FAKE.5.16.0/tools/Paket.Core.xml b/packages/FAKE.5.16.0/tools/Paket.Core.xml new file mode 100644 index 0000000..339165c --- /dev/null +++ b/packages/FAKE.5.16.0/tools/Paket.Core.xml @@ -0,0 +1,2233 @@ + + +Paket.Core + + + + Static storage to amortize the allocation of ILCallingConv.Instance and ILCallingConv.Static + + + + + Calling conventions. These are used in method pointer types. + + + + + This module contains a file pattern globbing implementation. + + + + + Like StartAsTask but gives the computation time to so some regular cancellation work + + + + + Runs both computations in parallel and returns the result as a tuple. + + + + + Extensions for async workflows. + + + + + delete the symlink only (do not remove files before) + + + + + The optional build no. + + + + + The optional PreRelease version + + + + + PATCH version when you make backwards-compatible bug fixes. + + + + + MINOR version when you add functionality in a backwards-compatible manner. + + + + + MAJOR version when you make incompatible API changes. + + + + + Contains the version information. + + + + + Information about PreRelease packages. + + + + + Represents a resolver strategy. + + + + + Parses NuGet V2 version range + + + + + Checks wether the given version is in the version range + + + + + Formats a VersionRequirement in NuGet syntax + + + + + Represents version information. + + + + + Defines if the range accepts prereleases + + + + + Defines if the range bound is including or excluding. + + + + + Get all platforms y for which x >= y holds + + + + + true when x is supported by y, for example netstandard15 is supported by netcore10 + + + + + x < y, see y >= x && x <> y + + + + + Note that this returns true only when a >= x and x < b holds. + + + + + true when x is at least (>=) y ie when y is supported by x, for example netcore10 >= netstandard15 as netstandard15 is supported by netcore10. + Note that this relation is not complete, for example for WindowsPhoneSilverlightv7.0 and Windowsv4.5 both <= and >= are false from this definition as + no platform supports the other. + + + + + portable-net45+sl5+win8+wp8+wpa81 + + + + + portable-net403+sl5+win8+wp8+wpa81 + + + + + portable-net40+sl5+win8+wp8+wpa81 + + + + + portable-net45+win8+wp8+wpa81 + + + + + portable-net45+sl5+win8+wpa81 + + + + + portable-net403+sl5+win8+wpa81 + + + + + portable-net40+sl5+win8+wpa81 + + + + + portable-net45+sl5+win8+wp8 + + + + + portable-win81+wp81+wpa81 + + + + + portable-net45+sl4+win8+wp8 + + + + + portable-net451+win81+wpa81 + + + + + portable-net403+sl5+win8+wp8 + + + + + portable-net403+sl4+win8+wp8 + + + + + portable-net40+sl5+win8+wp8 + + + + + portable-net45+win8+wpa81 + + + + + portable-net45+sl4+win8+wp75 + + + + + portable-net403+win8+wpa81 + + + + + portable-net403+sl4+win8+wp75 + + + + + portable-net403+sl4+win8+wp7 + + + + + portable-net40+win8+wpa81 + + + + + portable-net40+sl4+win8+wp75 + + + + + portable-wp81+wpa81 + + + + + portable-net45+win8+wp8 + + + + + portable-net45+wp8 + + + + + portable-net45+sl5+win8 + + + + + portable-net45+sl4+win8 + + + + + portable-net451+win81 + + + + + portable-net403+sl5+win8 + + + + + portable-net403+sl4+win8 + + + + + portable-net40+sl5+win8 + + + + + portable-net40+sl4+win8+wp8 + + + + + portable-win81+wpa81 + + + + + portable-win81+wp81 + + + + + portable-net45+sl5 + + + + + portable-net45+sl4 + + + + + portable-net403+sl5 + + + + + portable-net403+sl4 + + + + + portable-net40+sl5 + + + + + portable-net45+win8 + + + + + portable-net403+win8 + + + + + portable-net40+win8 + + + + + portable-net45+sl4+win8+wp7 + + + + + portable-net40+sl4 + + + + + portable-net40+sl4+win8+wp7 + + + + + Framework Identifier type. + + + + + The Framework version. + + + + + The .NET Standard version. + + + + + The UAP version. + + + + + The Framework version. + + + + + The .NET Standard version. + + + + + Exception for request errors + + + + + [omit] + + + + + load the file from a given file. + + + + + load the file from an xml text. The fileName is only used for error reporting. + + + + + load the file from an nuspec text stream. The fileName is only used for error reporting. + + + + + load the file from an XmlDocument. The fileName is only used for error reporting. + + + + + Framework assembly reference inside of nuspec files. + + + + + Nuspec reference type inside of nuspec files. + + + + + The runtime graph consolidating compatibility informations across the different RIDs + + + + + The description for a particular RID, indicates inherited (compatible) RIDs and runtime dependencies for this RID. + + + + + A compatibility profile identifies which RIDs are compatible with what FrameworkIdentifier (TargetFrameworkMoniker/tfm in NuGet world) + + + + + The runtime identifiert for a specific runtime. Should be treated as a black box in combination with the operations defined on the RuntimeGraph + + + + + Represents the contents of a particular package at a particular version. Any install-specific actions like Content files, References, Roslyn Analyzers, MsBuild targets are represented here. + + + + + Path of the load script + + + + + Target language for the analyzer + + + + + Path of the analyzer dll + + + + + Represents a subfolder of a nuget package that provides files (content, references, etc) for one or more Target Profiles. This is a logical representation of the 'net45' folder in a NuGet package, for example. + + + + + Usually the file name without extension, use for sorting and stuff. + + + + + Contains methods to read and manipulate solution files. + + + + + Returns a list of packages inside the lockfile with their group and version number + + + + + Updates the paket.lock file with the analyzed dependencies from the paket.dependencies file. + + + + + Parses a paket.lock file from lines + + + + + Parses a paket.lock file from file + + + + + Gets only direct dependencies of the given package in the given group. + + + + + Gets all dependencies of the given package + + + + + Gets all dependencies of the given package in the given group. + + + + + Gets all dependencies of the given package + + + + + Allows to parse and analyze paket.lock files. + + + + + (src * target) list + + + + + Finds all project files + + + + + Finds all project files + + + + + Contains methods to read and manipulate project files. + + + + + Project output type. + + + + + Compile items inside of project files. + + + + + Project references inside of project files. + + + + + File item inside of project files. + + + + + Directory info for the parent of this paket.dependencies file + + + + + The full path of the directory that containes this paket.dependencies file + + + + + Returns all direct NuGet dependencies in the given group. + + + + + Find the matching lock file to a dependencies file + + + + + Find the matching lock file to a dependencies file + + + + + Allows to parse and analyze paket.dependencies files. + + + + + Relative path based on base-directory + + + + + Force - Force the download and reinstallation of all packages + Redirects - Create binding redirects for the NuGet packages + OnlyReferenced - Only install packages that are referenced in paket.references files. + TouchAffectedRefs - Touch projects referencing installed packages even if the project file does not change. + + + + + Get the root path + + + + + Get the root directory + + + + + Get path to dependencies file + + + + + Updates the given package. + + + + + Updates the given package. + + + + + Updates dependencies in single group. + + + + + Update a filtered set of packages + + + + + Updates all dependencies. + + + + + Updates all dependencies. + + + + + Updates all dependencies. + + + + + Pulls new paket.targets and bootstrapper and puts them into .paket folder. + + + + + Removes paket.targets file and Import section from project files. + + + + + Tries to locate the paket.dependencies file in the given folder or a parent folder. + + + + + Tries to locate the paket.dependencies file in the current folder or a parent folder. + + + + + Converts the current package dependency graph to the simplest dependency graph. + + + + + Simple packages restore: + - Doesn't restore projects + - Doesn't write targets file + + + + + Shows all references files where the given package is referenced. + + + + + Lists outdated packages. + + + + + Restores packages for all available paket.references files + (or all packages if onlyReferenced is false) + + + + + Restores the given paket.references files. + + + + + Restores the given paket.references files. + + + + + Restores the given paket.references files. + + + + + Restores the given paket.references files. + + + + + Restores all dependencies. + + + + + Restores all dependencies. + + + + + Removes the given package from the specified project + + + + + Removes the given package from dependencies file. + + + + + Removes the given package from dependencies file. + + + + + Removes the given package from the main dependency group of the dependencies file. + + + + + Pushes a nupkg file. + + + + + Binds the given processing ROP function to current environment and executes it. + Throws on failure. + + + + + Tries to locate the paket.dependencies file in the given folder or a parent folder, throws an exception if unsuccessful. + + + + + Tries to locate the paket.dependencies file in the current folder or a parent folder, throws an exception if unsuccessful. + + + + + Lists all paket.template files in the current solution. + + + + + Creates a paket.dependencies file with the given text in the current directory and installs it. + + + + + Installs all dependencies. + + + + + Installs all dependencies. + + + + + Installs all dependencies. + + + + + Initialize paket.dependencies file in the given directory + + + + + Initialize paket.dependencies file in the given directory + + + + + Initialize paket.dependencies file in current directory + + + + + Returns all sources from the dependencies file. + + + + + Returns an instance of the paket.lock file. + + + + + Returns all libraries for the given package and framework. + + + + + Returns the installed version of the given package. + + + + + Returns the installed version of the given package. + + + + + Returns the installed versions of all installed packages which are referenced in the references file. + + + + + Returns the installed versions of all installed packages. + + + + + Returns an InstallModel for the given package. + + + + + Returns all groups. + + + + + Returns the direct dependencies for the given package. + + + + + Returns the installed versions of all direct dependencies. + + + + + Returns the installed versions of all direct dependencies which are referenced in the references file. + + + + + Returns an instance of the paket.dependencies file. + + + + + Returns all system-wide defined NuGet feeds. (Can be used for Autocompletion) + + + + + Fix the transitive references in a list of generated .nuspec files + + + + + Finds all references files where the given package is referenced. + + + + + Finds all references files where the given main group package is referenced. + + + + + Finds all projects where the given package is referenced. + + + + + Finds all outdated packages. + + + + + Downloads the latest paket.bootstrapper into the .paket folder and try to rename it to paket.exe in order to activate magic mode. + + + + + Converts the solution from NuGet to Paket. + + + + + Clears the NuGet cache + + + + + Adds a token for a source + + + + + Adds the given package with the given version to the dependencies file. + + + + + Adds the given package with the given version to the dependencies file. + + + + + Adds the given package with the given version to the dependencies file. + + + + + Adds the given github repository to the dependencies file. + + + + + Adds the given github repository to the dependencies file. + + + + + Adds the given github repository to the dependencies file. + + + + + Adds the given git repository to the dependencies file + + + + + Adds the given git repository to the dependencies file + + + + + Adds the given git repository to the dependencies file + + + + + Adds credentials for a Nuget feed + + + + + Adds credentials for a Nuget feed + + + + + Adds the given package with the given version to the dependencies file. + + + + + Adds the given package with the given version to the dependencies file. + + + + + Adds the given package with the given version to the dependencies file. + + + + + Adds the given package with the given version to the dependencies file. + + + + + Adds the given package without version requirements to main dependency group of the dependencies file. + + + + + Adds the given package without version requirements to the dependencies file. + + + + + Paket API which is optimized for F# Interactive use. + + + + + Represents a normalized group name + + + + + Represents a NuGet package name + + + + + Function to convert a string into a group name + + + + + Function to convert a string into a NuGet package name + + + + + The NuGet cache folder. + + + + + The magic unpublished date is 1900-01-01T00:00:00 + + + + + '.paket' + + + + + 'paket.dependencies' + + + + + 'paket.restore.sha512' + + + + + 'paket.local' + + + + + 'paket.lock' + + + + + the /packages/group/ExtractedPackage.X.Y.Z folder + + + + + No "packages" folder for the current package + + + + + Gets all files with the given pattern + + + + + If the guard is true then a [Y]es / [N]o question will be ask. + Until the user pressed y or n. + + + + + [omit] + + + + + Determines if the current system is a mono system + Todo: Detect mono on windows + + + + + Determines if the current system is a Windows system + + + + + Determines if the current system is a Linux system + + + + + Determines if the current system is a MacOs system + + + + + Determines if the current system is an Unix system + + + + + The system root environment variable. Typically "C:\Windows" + + + + + The path of Program Files (x86) + It seems this covers all cases where PROCESSOR\_ARCHITECTURE may misreport and the case where the other variable + PROCESSOR\_ARCHITEW6432 can be null + + + + + The path of the "Program Files" folder - might be x64 on x64 machine + + + + + [omit] + + + + + Cleans a directory by deleting it and recreating it. + + + + + Creates a directory if it does not exist. + + + + + Adds quotes around the string + [omit] + + + + + Unzip a seq by mapping the elements that satisfy the predicate + into the first seq and mapping the elements that fail to satisfy the predicate + into the second seq + + + + + Creates an observable that calls the specified function after someone + subscribes to it (useful for waiting using 'let!' when we need to start + operation after 'let!' attaches handler) + + + + + Match if 'text' ends with the 'suffix' string case insensitive + + + + + Check if 'text' ends with the 'suffix' string case insensitive + + + + + Match if 'text' starts with the 'prefix' string case insensitive + + + + + Check if 'text' starts with the 'prefix' string case insensitive + + + + + Match if 'text' includes the 'target' string case insensitive + + + + + Check if 'text' includes the 'target' string case insensitive + + + + + Match if the strings are equal ignoring case + + + + + Check if the two strings are equal ignoring case + + + + + Match if 'text' starts with the 'prefix' and return the text with the prefix removed + + + + + Match if 'text' starts with the 'prefix' string case + + + + + Contains methods for IO. + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + A process result including error code, message log and errors. + + + + + Runs the given process, waits for its completion and returns if it succeeded. + + + + + Starts the given process and returns immediatly. + + + + + Converts a sequence of strings into a string separated with line ends + + + + + Converts a sequence of strings to a string with delimiters + + + + + Runs the given process and returns the process result. + ## Parameters + + - `configProcessStartInfoF` - A function which overwrites the default ProcessStartInfo. + - `timeOut` - The timeout for the process. + + + + + Runs the given process and returns the exit code. + ## Parameters + + - `configProcessStartInfoF` - A function which overwrites the default ProcessStartInfo. + - `timeOut` - The timeout for the process. + - `silent` - If this flag is set then the process output is redirected to the given output functions `errorF` and `messageF`. + - `errorF` - A function which will be called with the error log. + - `messageF` - A function which will be called with the message log. + + + + + [omit] + + + + + [omit] + + + + + Tries to find the tool via AppSettings. If no path has the right tool we are trying the PATH system variable. + [omit] + + + + + Tries to find the tool via AppSettings. If no path has the right tool we are trying the PATH system variable. + [omit] + + + + + Returns the AppSettings for the key - Splitted on ; + [omit] + + + + + Modifies the ProcessStartInfo according to the platform semantics + + + + + Searches the current directory and the directories within the PATH + environment variable for the given file. If successful returns the full + path to the file. + ## Parameters + - `file` - The file to locate + + + + + Gets the list of valid directories included in the PATH environment variable. + + + + + Detects whether the given path does not contains invalid characters. + + + + + Splits the entries of an environment variable and removes the empty ones. + + + + + Retrieves the environment variable or None + + + + + Searches the given directories for the given file, failing if not found. + [omit] + + + + + Searches the given directories for all occurrences of the given file name + [omit] + + + + + Arguments on the Mono executable + + + + + Exception for request errors + + + + + Credentials Provider, the paramter indicates whether we need to retry, because some previous request failed + + + + +SecurityProtocolType.Tls ||| SecurityProtocolType.Tls11 ||| SecurityProtocolType.Tls12 ||| SecurityProtocolType.Ssl3 + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + Contains methods for Network IO. + + + + + Parses the given version string into a SemVerInfo which can be printed using ToString() or compared + according to the rules described in the [SemVer docs](http://semver.org/). + ## Sample + + parse "1.0.0-rc.1" < parse "1.0.0" // true + parse "1.2.3-alpha" > parse "1.2.2" // true + parse "1.2.3-alpha2" > parse "1.2.3-alpha" // true + parse "1.2.3-alpha002" > parse "1.2.3-alpha1" // true + parse "1.5.0-beta.2" > parse "1.5.0-rc.1" // false + + + + + Splits the given version string by possible delimiters but keeps them as parts of resulting list. + + + + + Matches if str is convertible to big int and not less than zero, and returns the bigint value. + + + + + Matches if str is convertible to Int and not less than zero, and returns the value as UInt. + + + + + Parser which allows to deal with [Semantic Versioning](http://semver.org/) (SemVer). + + + + + true when x is supported by y, for example netstandard15 is supported by netcore10 + + + + + parse a string to construct a Netframework, NetCore, NetStandard, or other dotnet identifier + + + + + Used for script generation + + + + + Get the authentication from the authentication store for a specific source + + + + + Get the authentication from the authentication store for a specific source and validates against the url + + + + + Check if the provided credentials for a specific source are correct + + + + + Decrypt a encrypted string with a user specific keys + + + + + Encrypts a string with a user specific keys + + + + + Represents the package source type. + + + + + Represents an unresolved package. + + + + + The list represented by this restriction (ie the included set of frameworks) + + + + + Returns true if the restriction x is a subset of the restriction y (a restriction basically represents a list, see RepresentedFrameworks) + For example =net46 is a subset of >=netstandard13 + + + + + Get all targets that should be considered with the specified restrictions + + + + + Get if a target should be considered with the specified restrictions + + + + + Constraints template for interproject references + + + + + Runs the git command and returns the first line of the result. + + + + + Runs the git command and returns the results. + + + + + [omit] + + + + + Runs the given git command, waits for its completion. + + + + + Runs the given git command, waits for its completion and returns whether it succeeded. + + + + + Fires the given git command ind the given repository directory and returns immediatly. + + + + + [omit] + + + + + [omit] + + + + + Runs git.exe with the given command in the given repository directory. + + + + + Tries to locate the git.exe via the eviroment variable "GIT". + + + + + Specifies a global timeout for git.exe - default is *no timeout* + + + + + Contains helpers which allow to interact with [git](http://git-scm.com/) via the command line. + + + + + Contains logic which helps to resolve the dependency graph for modules + + + + + Retrieves RemoteFiles + + + + + Gets a dependencies file from the remote source and tries to parse it. + + + + + Caches information retrieved by GetVersions until it is required by GetDetails + + + + + Represents data about resolved packages + + + + + Represents package details + + + + + Resolves all direct and transitive dependencies + + + + + Contains logic which helps to resolve the dependency graph. + + + + + Puts the package into the cache + + + + + Extracts the given package to the ./packages folder + + + + + Extracts the given package to the ./packages folder + + + + + Extracts the given package to the user folder + + + + + Contains NuGet cache support. + + + + + large unused fields are commented-out + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + Uses the NuGet v3 registration endpoint to retrieve package details . + + + + + Uses the NuGet v3 autocomplete service to retrieve all packages with the given prefix. + + + + + [omit] + + + + + Uses the NuGet v3 service to retrieve all package versions for the given package. + + + + + Uses the NuGet v3 autocomplete service to retrieve all package versions for the given package. + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + [omit] + + + + + Calculates the NuGet v3 URL from a NuGet v2 URL. + + + + + Calculates the NuGet v3 URL from a NuGet v2 URL. + + + + + [omit] + + + + + [omit] + + + + + Contains NuGet support. + + + + + Uses the NuGet v2 API to retrieve all packages with the given prefix. + + + + + Gets package details from NuGet via OData + + + + + Contains NuGet support. + + + + + Reads direct dependencies from a nupkg file + + + + + Reads package name from a nupkg file + + + + + Reads nuspec from nupkg + + + + + Reads packageName and version from .nupkg file name + + + + + Gets versions of the given package from local NuGet feed. + + + + + Downloads the given package to the NuGet Cache folder + + + + + Allows to retrieve all version no. for a package from the given sources. + + + + + Finds all analyzer files in a nuget package. + + + + + Finds all targets files in a nuget package. + + + + + Finds all libraries in a nuget package. + + + + + Downloads the given package into the nuget cache and read its runtime.json. + + + + + return runtime depenendencies for the given package and runtime + + + + + calculates whether the given assetRid is compatible with the given projectRid. + consider a project targeting projectRid, this returns true if an asset with assetRid is comaptible. + + + + + get a list of RIDs in no particular order which are part of this runtime graph + + + + + get the list of compatible RIDs for the given RID. Most compatible are near the head. The list contains the given RID in the HEAD + + + + + merge a sequence of runtime graphs + + + + + merge two runtime graphs + + + + + A module for parsing runtime.json files contained in various packages. + + + + + This is for library references, which at the same time can be used for references (old world - pre dotnetcore) + + + + + This is for reference assemblies (new dotnetcore world) + + + + + This is for library references, which at the same time can be used for references (old world - pre dotnetcore) + + + + + [omit] + + + + + [omit] + + + + + Append two maps with the properties of the second replacing properties of the first + + + + + Get the programming language for a project file using the "ProjectTypeGuids" + + + + + [omit] + + + + + Represents a binding redirection + + + + + Calculates the short form of the public key token for use with binding redirects, if it exists. + + + + + Applies a set of binding redirects to all .config files in a specific folder. + + + + + Applies a set of binding redirects to a single configuration file. + + + + + Updates the supplied MSBuild document with the supplied binding redirect. + + + + + Package from lock file was not found in dependencies file + + + + + Group from dependencies file was not found in lockfile + + + + + Package from dependencies file was not found in lockfile + + + + + The Version in the LockFile doesn't match the spec in the dependencies file. + + + + + The settings of the package changed + + + + + The restrictions changed + + + + + Save the script in '<rootPath>/.paket/load/<script>' + + + + + use the provided directory to compute the relative paths for the script's contents + and construct the + + + + + Generate a include scripts for all packages defined in paket.dependencies, + if a package is ordered before its dependencies this function will throw. + + + + + default implementation of F# include script generator + + + + + Remove all packages from the packages folder which are not part of the lock file. + + + + + Removes older packages from the cache + + + + + Remove all packages from the packages folder which are not part of the lock file. + + + + + Discover all packages currently available in the packages folder + + + + + Contains methods for the garbage collection of no longer needed files. + + + + + Restores the given dependencies from the lock file. + + + + + Downloads and extracts a package. + returns - package, libs files, props files, targets files, analyzers files + + + + + returns - package, libs files, props files, targets files, analyzers files + + + + + Finds packages which would be affected by a restore, i.e. not extracted yet or with the wrong version + + + + + Combines the copy_local settings from the lock file and a project's references file + + + + + Contains methods for the restore process. + + + + + Installs all packages from the lock file. + + + + + Installs all packages from the lock file. + + + + + Applies binding redirects for all strong-named references to all app. and web.config files. + + + + + Restores the given packages from the lock file. + + + + + Contains methods for the install process. + + + + + Update command + + + + + Update a single group command + + + + + Update a filtered list of packages + + + + + Update a single package command + + + + + Smart install command + + + + + Contains methods for the update process. + + + + + Prints all outdated packages. + + + + + Finds all outdated packages. + + + + + Contains methods to find outdated packages. + + + + + Calculates the used dependencies for a project. + + + + + Calculates the used dependencies for given references file. + + + + + Calculates the used dependencies for the given direct references. + + + + + Downloads the latest version of the paket.bootstrapper and paket.targets to the .paket dir + + + + + Downloads the latest version of the paket.bootstrapper and paket.targets to the .paket dir + + + + + Downloads the latest version of the given files to the destination dir + + + + + Activates the Visual Studio NuGet autorestore feature in all projects + + + + + Deactivates the Visual Studio NuGet autorestore feature in all projects + + + + + Contains methods for addition of new packages + + + + + Represents NuGet packages.config file + + + + + Represents type of NuGet packages.config file + + + + + Contains methods for NuGet conversion + + + + + Remove a package with the option to interactively remove it from multiple projects. + + + + + Removes a package with the option to remove it from a specified project. + + + + + Contains methods to remove installed packages + + + + + Takes a version string formatted for Semantic Versioning and parses it + into the internal representation used by Paket. + + + + diff --git a/packages/FAKE.5.16.0/tools/StyleCop.CSharp.Rules.dll b/packages/FAKE.5.16.0/tools/StyleCop.CSharp.Rules.dll new file mode 100644 index 0000000..360fa13 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/StyleCop.CSharp.Rules.dll differ diff --git a/packages/FAKE.5.16.0/tools/StyleCop.CSharp.dll b/packages/FAKE.5.16.0/tools/StyleCop.CSharp.dll new file mode 100644 index 0000000..72ddb5a Binary files /dev/null and b/packages/FAKE.5.16.0/tools/StyleCop.CSharp.dll differ diff --git a/packages/FAKE.5.16.0/tools/StyleCop.dll b/packages/FAKE.5.16.0/tools/StyleCop.dll new file mode 100644 index 0000000..c42c157 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/StyleCop.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.AppContext.dll b/packages/FAKE.5.16.0/tools/System.AppContext.dll new file mode 100644 index 0000000..4ccc058 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.AppContext.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Collections.Concurrent.dll b/packages/FAKE.5.16.0/tools/System.Collections.Concurrent.dll new file mode 100644 index 0000000..26f10d1 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Collections.Concurrent.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Collections.Immutable.dll b/packages/FAKE.5.16.0/tools/System.Collections.Immutable.dll new file mode 100644 index 0000000..7e8bbed Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Collections.Immutable.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Collections.Immutable.xml b/packages/FAKE.5.16.0/tools/System.Collections.Immutable.xml new file mode 100644 index 0000000..9e58173 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/System.Collections.Immutable.xml @@ -0,0 +1,4908 @@ + + + System.Collections.Immutable + + + + Represents an immutable collection of key/value pairs. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + The type of keys in the dictionary. + The type of values in the dictionary. + + + Adds an element with the specified key and value to the dictionary. + The key of the element to add. + The value of the element to add. + A new immutable dictionary that contains the additional key/value pair. + The given key already exists in the dictionary but has a different value. + + + Adds the specified key/value pairs to the dictionary. + The key/value pairs to add. + A new immutable dictionary that contains the additional key/value pairs. + One of the given keys already exists in the dictionary but has a different value. + + + Retrieves an empty dictionary that has the same ordering and key/value comparison rules as this dictionary instance. + An empty dictionary with equivalent ordering and key/value comparison rules. + + + Determines whether the immutable dictionary contains the specified key/value pair. + The key/value pair to locate. + true if the specified key/value pair is found in the dictionary; otherwise, false. + + + Removes the element with the specified key from the immutable dictionary. + The key of the element to remove. + A new immutable dictionary with the specified element removed; or this instance if the specified key cannot be found in the dictionary. + + + Removes the elements with the specified keys from the immutable dictionary. + The keys of the elements to remove. + A new immutable dictionary with the specified keys removed; or this instance if the specified keys cannot be found in the dictionary. + + + Sets the specified key and value in the immutable dictionary, possibly overwriting an existing value for the key. + The key of the entry to add. + The key value to set. + A new immutable dictionary that contains the specified key/value pair. + + + Sets the specified key/value pairs in the immutable dictionary, possibly overwriting existing values for the keys. + The key/value pairs to set in the dictionary. If any of the keys already exist in the dictionary, this method will overwrite their previous values. + A new immutable dictionary that contains the specified key/value pairs. + + + Determines whether this dictionary contains a specified key. + The key to search for. + The matching key located in the dictionary if found, or equalkey if no match is found. + true if a match for equalKey is found; otherwise, false. + + + Represents a list of elements that cannot be modified. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + The type of elements in the list. + + + Makes a copy of the list, and adds the specified object to the end of the copied list. + The object to add to the list. + A new list with the object added, or this list if the object is already in the list. + + + Makes a copy of the list and adds the specified objects to the end of the copied list. + The objects to add to the list. + A new list with the elements added, or this list if the elements already exist in the list. + + + Creates a list with all the items removed, but with the same sorting and ordering semantics as this list. + An empty list that has the same sorting and ordering semantics as this instance. + + + Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the that starts at the specified index and contains the specified number of elements. + The object to locate in the . This value can be null for reference types. + The zero-based starting indes of the search. 0 (zero) is valid in an empty list. + The number of elements in the section to search. + The equality comparer to use to locate item. + The zero-based index of the first occurrence of item within the range of elements in the that starts at index and contains count number of elements if found; otherwise -1. + + + Inserts the specified element at the specified index in the immutable list. + The zero-based index at which to insert the value. + The object to insert. + A new immutable list that includes the specified element. + + + Inserts the specified elements at the specified index in the immutable list. + The zero-based index at which the new elements should be inserted. + The elements to insert. + A new immutable list that includes the specified elements. + + + Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the that contains the specified number of elements and ends at the specified index. + The object to locate in the list. The value can be null for reference types. + The zero-based starting index of the search. 0 (zero) is valid in an empty list. + The number of elements in the section to search. + The equality comparer to match item. + Returns . + + + Removes the first occurrence of a specified object from this immutable list. + The object to remove from the list. + The equality comparer to use to locate value. + Returns a new list with the specified object removed. + + + Removes all the elements that match the conditions defined by the specified predicate. + The delegate that defines the conditions of the elements to remove. + A new immutable list with the elements removed. + + + Removes the element at the specified index of the immutable list. + The index of the element to remove. + A new list with the element removed. + + + Removes the specified object from the list. + The objects to remove from the list. + The equality comparer to use to determine if items match any objects in the list. + A new immutable list with the specified objects removed, if items matched objects in the list. + + + Removes a range of elements from the . + The zero-based starting index of the range of elements to remove. + The number of elements to remove. + A new immutable list with the elements removed. + + + Returns a new list with the first matching element in the list replaced with the specified element. + The element to be replaced. + The element to replace the the first occurrence of oldValue with + The equality comparer to use for matching oldValue. + A new list that contains newValue, even if oldvalue is the same as newValue. + oldValue does not exist in the list. + + + Replaces an element in the list at a given position with the specified element. + The position in the list of the element to replace. + The element to replace the old element with. + A new list that contains the new element, even if the element at the specified location is the same as the new element. + + + Represents an immutable first-in, first-out collection of objects. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + The type of elements in the queue. + + + Returns a new queue with all the elements removed. + An empty immutable queue. + + + Removes the first element in the immutable queue, and returns the new queue. + The new immutable queue with the first element removed. This value is never null. + + + Adds an element to the end of the immutable queue, and returns the new queue. + The element to add. + The new immutable queue with the specified element added. + + + Gets a value that indicates whether this immutable queue is empty. + true if this queue is empty; otherwise, false. + + + Returns the element at the beginning of the immutable queue without removing it. + The element at the beginning of the queue. + + + Represents a set of elements that can only be modified by creating a new instance of the set. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + The type of element stored in the set. + + + Adds the specified element to this immutable set. + The element to add. + A new set with the element added, or this set if the element is already in the set. + + + Retrieves an empty immutable set that has the same sorting and ordering semantics as this instance. + An empty set that has the same sorting and ordering semantics as this instance. + + + Determines whether this immutable set contains a specified element. + The element to locate in the set. + true if the set contains the specified value; otherwise, false. + + + Removes the elements in the specified collection from the current immutable set. + The collection of items to remove from this set. + A new set with the items removed; or the original set if none of the items were in the set. + + + Creates an immutable set that contains only elements that exist in this set and the specified set. + The collection to compare to the current . + A new immutable set that contains elements that exist in both sets. + + + Determines whether the current immutable set is a proper (strict) subset of the specified collection. + The collection to compare to the current set. + true if the current set is a proper subset of the specified collection; otherwise, false. + + + Determines whether the current immutable set is a proper (strict) superset of the specified collection. + The collection to compare to the current set. + true if the current set is a proper superset of the specified collection; otherwise, false. + + + Determines whether the current immutable set is a subset of a specified collection. + The collection to compare to the current set. + true if the current set is a subset of the specified collection; otherwise, false. + + + Determines whether the current immutable set is a superset of a specified collection. + The collection to compare to the current set. + true if the current set is a superset of the specified collection; otherwise, false. + + + Determines whether the current immutable set overlaps with the specified collection. + The collection to compare to the current set. + true if the current set and the specified collection share at least one common element; otherwise, false. + + + Removes the specified element from this immutable set. + The element to remove. + A new set with the specified element removed, or the current set if the element cannot be found in the set. + + + Determines whether the current immutable set and the specified collection contain the same elements. + The collection to compare to the current set. + true if the sets are equal; otherwise, false. + + + Creates an immutable set that contains only elements that are present either in the current set or in the specified collection, but not both. + The collection to compare to the current set. + A new set that contains the elements that are present only in the current set or in the specified collection, but not both. + + + Determines whether the set contains a specified value. + The value to search for. + The matching value from the set, if found, or equalvalue if there are no matches. + true if a matching value was found; otherwise, false. + + + Creates a new immutable set that contains all elements that are present in either the current set or in the specified collection. + The collection to add elements from. + A new immutable set with the items added; or the original set if all the items were already in the set. + + + Represents an immutable last-in-first-out (LIFO) collection. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + The type of elements in the stack. + + + Removes all objects from the immutable stack. + An empty immutable stack. + + + Gets a value that indicates whether this immutable stack is empty. + true if this stack is empty; otherwise,false. + + + Returns the element at the top of the immutable stack without removing it. + The element at the top of the stack. + + + Removes the element at the top of the immutable stack and returns the new stack. + The new stack; never null + + + Inserts an element at the top of the immutable stack and returns the new stack. + The element to push onto the stack. + The new stack. + + + A writable array accessor that can be converted into an instance without allocating extra memory. +NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + + Adds the specified item to the array. + The object to add to the array. + + + Adds the specified items to the end of the array. + The items to add to the array. + + + Adds the specified items to the end of the array. + The items to add to the array. + + + Adds the specified items to the end of the array. + The items to add to the array. + + + Adds the specified items to the end of the array. + The items to add to the array. + + + Adds the specified items to the end of the array. + The items to add to the array. + The number of elements from the source array to add. + + + Adds the specified items to the end of the array. + The items to add to the array. + The number of elements from the source array to add. + + + Adds the specified items that derive from the type currently in the array, to the end of the array. + The items to add to end of the array. + The type that derives from the type of item already in the array. + + + Adds the specified items that derive from the type currently in the array, to the end of the array. + The items to add to the end of the array. + The type that derives from the type of item already in the array. + + + Adds the specified items that derive from the type currently in the array, to the end of the array + The items to add to the end of the array. + The type that derives from the type of item already in the array. + + + Get and sets the length of the internal array. When set the internal array is reallocated to the given capacity if it is not already the specified length. + + + + Removes all items from the array. + + + Determines whether the array contains a specific value. + The object to locate in the array. + true if the object is found; otherwise, false. + + + Copies the current contents to the specified array. + The array to copy to. + The index to start the copy operation. + + + Gets or sets the number of items in the array. + The number of items in the array. + + + Gets an object that can be used to iterate through the collection. + An object that can be used to iterate through the collection. + + + Determines the index of the specified item. + The item to locate in the array. + The starting position of the search. + The number of elements to search. + The index of item if it’s found in the list; otherwise, -1. + + + Determines the index for the specified item. + The item to locate in the array. + The index at which to begin the search. + The starting position of the search. + The equality comparer to use in the search + The index of item if it’s found in the list; otherwise, -1. + + + Determines the index of a specific item in the array. + The item to locate in the array. + The index of item if it’s found in the list; otherwise, -1. + + + Determines the index of the specified item. + The item to locate in the array. + The starting position of the search. + The index of item if it’s found in the list; otherwise, -1. + + + Inserts an item in the array at the specified index. + The zero-based index at which to insert the item. + The object to insert into the array. + + + Gets or sets the item at the specified index. + The index of the item to get or set. + The item at the specified index. + The specified index is not in the array. + + + Determines the 0-based index of the last occurrence of the specified item in this array. + The item to search for. + The 0-based index where the item was found; or -1 if it could not be found. + + + Determines the 0-based index of the last occurrence of the specified item in this array. + The item to search for. + The starting position of the search. + The 0-based index into the array where the item was found; or -1 if it could not be found. + + + Determines the 0-based index of the last occurrence of the specified item in this array. + The item to search for. + The starting position of the search. + The number of elements to search. + The 0-based index into the array where the item was found; or -1 if it could not be found. + + + Determines the 0-based index of the last occurrence of the specified item in this array. + The item to search for. + The starting position of the search. + The number of elements to search. + The equality comparer to use in the search. + The 0-based index into the array where the item was found; or -1 if it could not be found. + + + Extracts the internal array as an and replaces it with a zero length array. + + When doesn&#39;t equal . + + + Removes the specified element. + The item to remove. + true if element was found and removed; otherwise, false. + + + Removes the item at the specified index from the array. + The zero-based index of the item to remove. + + + Reverses the order of elements in the collection. + + + Sorts the contents of the array. + + + Sorts the contents of the array. + The comparer to use for sorting. If comparer is null, the default comparer for the elements type in the array is used. + + + Sorts the elements in the entire array using the specified . + The to use when comparing elements. + comparison is null. + + + Sorts the contents of the array. + The starting index for the sort. + The number of elements to include in the sort. + The comparer to use for sorting. If comparer is null, the default comparer for the elements type in the array is used. + + + Creates a new array with the current contents of this . + A new array with the contents of this . + + + Returns an immutable array that contains the current contents of this . + An immutable array that contains the current contents of this . + + + Gets a value indicating whether the is read-only. + true if the is read-only; otherwise, false. + + + Returns an enumerator that iterates through the array. + An enumerator that iterates through the array. + + + Returns an enumerator that iterates through the array. + An enumerator that iterates through the array. + + + An array enumerator. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + + Gets the currently item. + The current item. + + + Advances to the next value in the array. + true if another item exists in the array; otherwise, false. + + + Represents an array that is immutable; meaning it cannot be changed once it is created. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + The type of element stored by the array. + + + Returns a copy of the original array with the specified item added to the end. + The item to be added to the end of the array. + A new array with the specified item added to the end. + + + Returns a copy of the original array with the specified elements added to the end of the array. + The elements to add to the array. + A new array with the elements added. + + + Returns a copy of the original array with the specified elements added to the end of the array. + The elements to add to the array. + A new array with the elements added. + + + Returns a new immutable array that contains the elements of this array cast to a different type. + The type of array element to return. + An immutable array that contains the elements of this array, cast to a different type. If the cast fails, returns an array whose property returns true. + + + Initializes a new instance of the struct by casting the underlying array to an array of type TOther. + + + Thrown if the cast is illegal. + + + Initializes a new instance of the struct based on the contents of an existing instance, allowing a covariant static cast to efficiently reuse the existing array. + The array to initialize the array with. No copy is made. + + + + + Returns an array with all the elements removed. + An array with all of the elements removed. + + + Determines whether the specified item exists in the array. + The item to search for. + true if the specified item was found in the array; otherwise false. + + + Copies the contents of this array to the specified array starting at the specified destination index. + The array to copy to. + The index in array where copying begins. + + + Copies the specified items in this array to the specified array at the specified starting index. + The index of this array where copying begins. + The array to copy to. + The index in array where copying begins. + The number of elements to copy from this array. + + + Copies the contents of this array to the specified array. + The array to copy to. + + + Gets an empty immutable array. + + + + Indicates whether specified array is equal to this array. + An object to compare with this object. + true if other is equal to this array; otherwise, false. + + + Determines if this array is equal to the specified object. + The to compare with this array. + true if this array is equal to obj; otherwise, false. + + + Returns an enumerator that iterates through the contents of the array. + An enumerator. + + + Returns a hash code for this instance. + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + Searches the array for the specified item. + The item to search for. + The index at which to begin the search. + The number of elements to search. + The equality comparer to use in the search. + The zero-based index position of the item if it is found, or -1 if it is not. + + + Searches the array for the specified item. + The item to search for. + The zero-based index position of the item if it is found, or -1 if it is not. + + + Searches the array for the specified item. + The item to search for. + The index at which to begin the search. + The zero-based index position of the item if it is found, or -1 if it is not. + + + Searches the array for the specified item. + The item to search for. + The index at which to begin the search. + The equality comparer to use in the search. + The zero-based index position of the item if it is found, or -1 if it is not. + + + Searches the array for the specified item. + The item to search for. + The index at which to begin the search. + The number of elements to search. + The zero-based index position of the item if it is found, or -1 if it is not. + + + Returns a new array with the specified value inserted at the specified position. + The 0-based index into the array at which the new item should be added. + The item to insert at the start of the array. + A new array with the item inserted at the specified index. + + + Inserts the specified values at the specified index. + The index at which to insert the value. + The elements to insert. + A new immutable array with the items inserted at the specified index. + + + Inserts the specified values at the specified index. + The index at which to insert the value. + The elements to insert. + A new immutable array with the items inserted at the specified index. + + + Gets a value indicating whether this array was declared but not initialized. + true to indicate the is null; otherwise, false. + + + Gets a value indicating whether this is empty or is not initialized. + true to indicate the is null or ; otherwise, false. + + + Gets a value indicating whether this is empty. + true to indicate the is empty; otherwise, false. + + + Gets the element at the specified index in the immutable array. + The zero-based index of the element to get. + The element at the specified index in the immutable array. + + + Searches the array for the specified item; starting at the end of the array. + The item to search for. + The 0-based index into the array where the item was found; or -1 if it could not be found. + + + Searches the array for the specified item; starting at the end of the array. + The item to search for. + The index at which to begin the search. + The 0-based index into the array where the item was found; or -1 if it could not be found. + + + Searches the array for the specified item; starting at the end of the array. + The item to search for. + The index at which to begin the search. + The number of elements to search. + The 0-based index into the array where the item was found; or -1 if it could not be found. + + + Searches the array for the specified item; starting at the end of the array. + The item to search for. + The index at which to begin the search. + The number of elements to search. + The equality comparer to use in the search. + The 0-based index into the array where the item was found; or -1 if it could not be found. + + + Gets the number of elements in the array. + The number of elements in the array + + + Filters the elements of this array to those assignable to the specified type. + The type to filter the elements of the sequence on. + An that contains elements from the input sequence of type of TResult. + + + Returns a value that indicates if two arrays are equal. + The array to the left of the operator. + The array to the right of the operator. + true if the arrays are equal; otherwise, false. + + + Returns a value that indicates if two arrays are equal. + The array to the left of the operator. + The array to the right of the operator. + true if the arrays are equal; otherwise, false. + + + Returns a value that indicates whether two arrays are not equal. + The array to the left of the operator. + The array to the right of the operator. + true if the arrays are not equal; otherwise, false. + + + Checks for inequality between two array. + The object to the left of the operator. + The object to the right of the operator. + true if the two arrays are not equal; otherwise, false. + + + Returns an array with the first occurrence of the specified element removed from the array. If no match is found, the current array is returned. + The item to remove. + A new array with the item removed. + + + Returns an array with the first occurrence of the specified element removed from the array. + If no match is found, the current array is returned. + The item to remove. + The equality comparer to use in the search. + A new array with the specified item removed. + + + Removes all the items from the array that meet the specified condition. + The delegate that defines the conditions of the elements to remove. + A new array with items that meet the specified condition removed. + + + Returns an array with the element at the specified position removed. + The 0-based index of the element to remove from the returned array. + A new array with the item at the specified index removed. + + + Removes the specified items from this list. + The items to remove if matches are found in this list. + The equality comparer to use in the search. + A new array with the elements removed. + + + Removes the specified items from this array. + The items to remove if matches are found in this list. + The equality comparer to use in the search. + A new array with the elements removed. + + + Returns an array with the elements at the specified position removed. + The 0-based index of the starting element to remove from the array. + The number of elements to remove from the array. + The new array with the specified elements removed. + + + Removes the specified items from this array. + The items to remove if matches are found in this list. + A new array with the elements removed. + + + Removes the specified values from this list. + The items to remove if matches are found in this list. + A new list with the elements removed. + + + Finds the first element in the array equal to the specified value and replaces the value with the specified new value. + The value to find and replace in the array. + The value to replace the oldvalue with. + The equality comparer to use to compare values. + A new array that contains newValue even if the new and old values are the same. + oldValue is not found in the array. + + + Finds the first element in the array equal to the specified value and replaces the value with the specified new value. + The value to find and replace in the array. + The value to replace the oldvalue with. + A new array that contains newValue even if the new and old values are the same. + oldValue is not found in the array. + + + Replaces the item at the specified index with the specified item. + The index of the item to replace. + The item to add to the list. + The new array that contains item at the specified index. + + + Sorts the elements in the immutable array using the default comparer. + A new immutable array that contains the items in this array, in sorted order. + + + Sorts the elements in the immutable array using the specified comparer. + The implementation to use when comparing elements, or null to use the default comparer + A new immutable array that contains the items in this array, in sorted order. + + + Sorts the elements in the entire using the specified . + The to use when comparing elements. + The sorted list. + comparison is null. + + + Sorts the specified elements in the immutable array using the specified comparer. + The index of the first element to sort. + The number of elements to include in the sort. + The implementation to use when comparing elements, or null to use the default comparer + A new immutable array that contains the items in this array, in sorted order. + + + Creates a mutable array that has the same contents as this array and can be efficiently mutated across multiple operations using standard mutable interfaces. + The new builder with the same contents as this array. + + + Throws in all cases. + The item to add to the end of the array. + + + Throws in all cases. + + + Gets the number of array in the collection. + + Thrown if the property returns true. + + + Gets a value indicating whether this instance is read only. + true if this instance is read only; otherwise, false. + + + Throws in all cases. + The object to remove from the array. + Throws in all cases. + + + Returns an enumerator that iterates through the array. + An enumerator that can be used to iterate through the array. + + + Throws in all cases. + The index of the location to insert the item. + The item to insert. + + + Gets or sets the element at the specified index in the read-only list. + The zero-based index of the element to get. + The element at the specified index in the read-only list. + Always thrown from the setter. + Thrown if the property returns true. + + + Throws in all cases. + The index. + + + Gets the number of array in the collection. + + Thrown if the property returns true. + + + Gets the element at the specified index. + The index. + The element. + Thrown if the property returns true. + + + Copies this array to another array starting at the specified index. + The array to copy this array to. + The index in the destination array to start the copy operation. + + + Gets the size of the array. + + Thrown if the property returns true. + + + See the interface. + + + + Gets the sync root. + + + + Returns an enumerator that iterates through the immutable array. + An enumerator that iterates through the immutable array. + + + Throws in all cases. + The value to add to the array. + Throws in all cases. + + + Throws in all cases. + + + Throws in all cases. + The value to check for. + Throws in all cases. + + + Gets the value at the specified index. + The value to return the index of. + The value of the element at the specified index. + + + Throws in all cases. + Index that indicates where to insert the item. + The value to insert. + + + Gets a value indicating whether this instance is fixed size. + true if this instance is fixed size; otherwise, false. + + + Gets a value indicating whether this instance is read only. + true if this instance is read only; otherwise, false. + + + Gets or sets the at the specified index. + The index. + + Always thrown from the setter. + Thrown if the property returns true. + + + Throws in all cases. + The value to remove from the array. + + + Throws in all cases. + The index of the item to remove. + + + Returns a copy of the original array with the specified item added to the end. + The value to add to the end of the array. + A new array with the specified item added to the end. + + + Returns a copy of the original array with the specified elements added to the end of the array. + The elements to add to the end of the array. + A new array with the elements added to the end. + + + Returns an array with all the elements removed. + Returns an array with all the elements removed. + + + Returns a new array with the specified value inserted at the specified position. + The 0-based index into the array at which the new item should be added. + The item to insert at the start of the array. + A new array with the specified value inserted. + + + Inserts the specified values at the specified index + The index at which to insert the value. + The elements to insert. + A new array with the specified values inserted. + + + Returns an array with the first occurrence of the specified element removed from the array; if no match is found, the current array is returned. + The value to remove from the array. + The equality comparer to use in the search. + A new array with the value removed. + + + Removes all the items from the array that meet the specified condition. + The delegate that defines the conditions of the elements to remove. + A new array with items that meet the specified condition removed. + + + Returns an array with the element at the specified position removed. + The 0-based index of the element to remove from the returned array. + A new array with the specified item removed. + + + Removes the specified items from this array. + The items to remove if matches are found in this list. + The equality comparer to use in the search. + A new array with the elements removed. + + + Returns an array with the elements at the specified position removed. + The 0-based index of the starting element to remove from the array. + The number of elements to remove from the array. + The new array with the specified elements removed. + + + Finds the first element in the array equal to the specified value and replaces the value with the specified new value. + The value to find and replace in the array. + The value to replace the oldvalue with. + The equality comparer to use to compare values. + A new array that contains newValue even if the new and old values are the same. + oldValue is not found in the array. + + + Replaces the item at the specified index with the specified item. + The index of the item to replace. + The value to add to the list. + The new array that contains item at the specified index. + + + Determines whether the current collection element precedes, occurs in the same position as, or follows another element in the sort order. + The element to compare with the current instance. + The object used to compare members of the current array with the corresponding members of other array. + An integer that indicates whether the current element precedes, is in the same position or follows the other element. + The arrays are not the same length. + + + Determines whether this array is structurally equal to the specified array. + The array to compare with the current instance. + An object that determines whether the current instance and other are structurally equal. + true if the two arrays are structurally equal; otherwise, false. + + + Returns a hash code for the current instance. + An object that computes the hash code of the current object. + The hash code for the current instance. + + + Provides methods for creating an array that is immutable; meaning it cannot be changed once it is created. +NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + Searches the sorted immutable array for a specified element using the default comparer and returns the zero-based index of the element, if it’s found. + The sorted array to search. + The object to search for. + The type of element stored in the array. + The zero-based index of the item in the array, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than value or, if there is no larger element, the bitwise complement of . + value does not implement or the search encounters an element that does not implement . + + + Searches a sorted immutable array for a specified element and returns the zero-based index of the element, if it’s found. + The sorted array to search. + The object to search for. + The comparer implementation to use when comparing elements, or null to use the default comparer. + The type of element stored in the array. + The zero-based index of the item in the array, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than value or, if there is no larger element, the bitwise complement of . + comparer is null and value does not implement or the search encounters an element that does not implement . + + + Searches a sorted immutable array for a specified element and returns the zero-based index of the element, if it’s found. + The sorted array to search. + The starting index of the range to search. + The length of the range to search. + The object to search for. + The type of element stored in the array. + The zero-based index of the item in the array, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than value or, if there is no larger element, the bitwise complement of . + value does not implement or the search encounters an element that does not implement . + + + Searches a sorted immutable array for a specified element and returns the zero-based index of the element. + The sorted array to search. + The starting index of the range to search. + The length of the range to search. + The object to search for. + The comparer to use when comparing elements for equality or null to use the default comparer. + The type of element stored in the array. + The zero-based index of the item in the array, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than value or, if there is no larger element, the bitwise complement of . + comparer is null and value does not implement or the search encounters an element that does not implement . + + + Creates an immutable array that contains the specified objects. + The first object to store in the array. + The second object to store in the array. + The third object to store in the array. + The fourth object to store in the array. + The type of elements stored in the array. + An immutable array that contains the specified objects. + + + Creates an immutable array with specified objects from another array. + The source array of objects. + The index of the first element to copy from items. + The number of elements from items to include in this immutable array. + The type of elements stored in the array. + An immutable array that contains the specified objects from the source array. + + + Creates an immutable array with the specified objects from another immutable array. + The source array of objects. + The index of the first element to copy from items. + The number of elements from items to include in this immutable array. + The type of elements stored in the array. + An immutable array that contains the specified objects from the source array. + + + Creates an immutable array that contains the specified objects. + The first object to store in the array. + The second object to store in the array. + The third object to store in the array. + The type of elements stored in the array. + An immutable array that contains the specified objects. + + + Creates an immutable array from the specified array of objects. + The array of objects to populate the array with. + The type of elements stored in the array. + An immutable array that contains the array of items. + + + Creates an immutable array that contains the specified object. + The object to store in the array. + The type of elements stored in the array. + Returns an immutable array that contains the specified object. + + + Creates an empty immutable array. + The type of elements stored in the array. + An empty immutable array. + + + Creates an immutable array that contains the specified objects. + The first object to store in the array. + The second object to store in the array. + The type of elements stored in the array. + Returns an immutable array that contains the specified objects. + + + Creates a mutable array that can be converted to an without allocating new memory. + The type of elements stored in the builder. + A mutable array of the specified type that can be efficiently converted to an immutable array. + + + Creates a mutable array that can be converted to an without allocating new memory. + The initial capacity of the builder. + The type of elements stored in the builder. + A mutable array of the specified type that can be efficiently converted to an immutable array. + + + Creates a new populated with the specified items. + The elements to add to the array. + The type of element stored in the array. + An immutable array that contains the specified items. + + + Initializes a new instance of the struct. + The source array to initialize the resulting array with. + The index of the first element in the source array to include in the resulting array. + The number of elements from the source array to include in the resulting array. + The function to apply to each element from the source array included in the resulting array. + An argument to be passed to the selector mapping function. + + + + + + + Initializes a new instance of the struct. + The source array to initialize the resulting array with. + The function to apply to each element from the source array. + An argument to be passed to the selector mapping function. + + + + + + + Initializes a new instance of the struct. + The source array to initialize the resulting array with. + The function to apply to each element from the source array. + + + + + + Initializes a new instance of the struct. + The source array to initialize the resulting array with. + The index of the first element in the source array to include in the resulting array. + The number of elements from the source array to include in the resulting array. + The function to apply to each element from the source array included in the resulting array. + + + + + + Creates an immutable array from the specified collection. + The collection of objects to copy to the immutable array. + The type of elements contained in items. + An immutable array that contains the specified collection of objects. + + + Represents a hash map that mutates with little or no memory allocations and that can produce or build on immutable hash map instances very efficiently. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + + + Adds the specified item to the immutable dictionary. + The object to add to the dictionary. + The dictionary is read-only. + + + Adds an element that has the specified key and value to the immutable dictionary. + The key of the element to add. + The value of the element to add. + key is null. + An element with the same key already exists in the dictionary. + The dictionary is read-only. + + + Adds a sequence of values to this collection. + The items to add to this collection. + + + Removes all items from the immutable dictionary. + The dictionary is read-only. + + + Determines whether the immutable dictionary contains a specific value. + The object to locate in the dictionary. + true if item is found in the dictionary; otherwise, false. + + + Determines whether the immutable dictionary contains an element that has the specified key. + The key to locate in the dictionary. + true if the dictionary contains an element with the key; otherwise, false. + key is null. + + + Determines whether the immutable dictionary contains an element that has the specified value. + The value to locate in the immutable dictionary. The value can be null for reference types. + true if the dictionary contains an element with the specified value; otherwise, false. + + + Gets the number of elements contained in the immutable dictionary. + The number of elements contained in the immutable dictionary. + + + Returns an enumerator that iterates through the immutable dictionary. + An enumerator that can be used to iterate through the collection. + + + Gets the value for a given key if a matching key exists in the dictionary. + The key to search for. + The default value to return if no matching key is found in the dictionary. + The value for the key, or defaultValue if no matching key was found. + + + Gets the value for a given key if a matching key exists in the dictionary. + The key to search for. + The value for the key, or default(TValue) if no matching key was found. + + + Gets or sets the element with the specified key. + The element to get or set. + The element that has the specified key. + + + Gets or sets the key comparer. + The key comparer. + + + Gets a collection that contains the keys of the immutable dictionary. + A collection that contains the keys of the object that implements the immutable dictionary. + + + Removes the first occurrence of a specific object from the immutable dictionary. + The object to remove from the dictionary. + true if item was successfully removed from the dictionary; otherwise, false. This method also returns false if item is not found in the dictionary. + The dictionary is read-only. + + + Removes the element with the specified key from the immutable dictionary. + The key of the element to remove. + true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the dictionary. + key is null. + The dictionary is read-only. + + + Removes any entries with keys that match those found in the specified sequence from the immutable dictionary. + The keys for entries to remove from the dictionary. + + + Creates an immutable dictionary based on the contents of this instance. + An immutable dictionary. + + + Determines whether this dictionary contains a specified key. + The key to search for. + The matching key located in the dictionary if found, or equalkey if no match is found. + true if a match for equalKey is found; otherwise, false. + + + Returns the value associated with the specified key. + The key whose value will be retrieved. + When this method returns, contains the value associated with the specified key, if the key is found; otherwise, returns the default value for the type of the value parameter. This parameter is passed uninitialized. + true if the object that implements the immutable dictionary contains an element with the specified key; otherwise, false. + key is null. + + + Gets or sets the value comparer. + The value comparer. + + + Gets a collection that contains the values of the immutable dictionary. + A collection that contains the values of the object that implements the dictionary. + + + + + + + + + + + + + + + + + + + Copies the elements of the dictionary to an array of type , starting at the specified array index. + The one-dimensional array of type that is the destination of the elements copied from the dictionary. The array must have zero-based indexing. + The zero-based index in array at which copying begins. + + + Gets a value indicating whether access to the is synchronized (thread safe). + true if access to the is synchronized (thread safe); otherwise, false. + + + Gets an object that can be used to synchronize access to the . + An object that can be used to synchronize access to the . + + + Adds an element with the provided key and value to the dictionary object. + The key of the element to add. + The value of the element to add. + + + Determines whether the dictionary object contains an element with the specified key. + The key to locate. + true if the dictionary contains an element with the key; otherwise, false. + + + Returns an object for the dictionary. + An object for the dictionary. + + + + Gets a value indicating whether the object has a fixed size. + true if the object has a fixed size; otherwise, false. + + + Gets a value indicating whether the is read-only. + true if the is read-only; otherwise, false. + + + Gets or sets the element with the specified key. + The key. + + + + Gets an containing the keys of the . + An containing the keys of the object that implements . + + + Removes the element with the specified key from the dictionary. + The key of the element to remove. + + + Gets an containing the values in the . + An containing the values in the object that implements . + + + Returns an enumerator that iterates through a collection. + An enumerator object that can be used to iterate through the collection. + + + Enumerates the contents of the immutable dictionary without allocating any memory. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + + + Gets the element at the current position of the enumerator. + The element in the dictionary at the current position of the enumerator. + + + Releases the resources used by the current instance of the class. + + + Advances the enumerator to the next element of the immutable dictionary. + true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the dictionary. + The dictionary was modified after the enumerator was created. + + + Sets the enumerator to its initial position, which is before the first element in the dictionary. + The dictionary was modified after the enumerator was created. + + + Gets the current element. + + + + Represents an immutable, unordered collection of keys and values. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + The type of the keys in the dictionary. + The type of the values in the dictionary. + + + Adds an element with the specified key and value to the immutable dictionary. + The key of the element to add. + The value of the element to add. + A new immutable dictionary that contains the additional key/value pair. + The given key already exists in the dictionary but has a different value. + + + Adds the specified key/value pairs to the immutable dictionary. + The key/value pairs to add. + A new immutable dictionary that contains the additional key/value pairs. + One of the given keys already exists in the dictionary but has a different value. + + + Retrieves an empty immutable dictionary that has the same ordering and key/value comparison rules as this dictionary instance. + An empty dictionary with equivalent ordering and key/value comparison rules. + + + Determines whether this immutable dictionary contains the specified key/value pair. + The key/value pair to locate. + true if the specified key/value pair is found in the dictionary; otherwise, false. + + + Determines whether the immutable dictionary contains an element with the specified key. + The key to locate. + true if the immutable dictionary contains an element with the specified key; otherwise, false. + + + Determines whether the immutable dictionary contains an element with the specified value. + The value to locate. The value can be null for reference types. + true if the dictionary contains an element with the specified value; otherwise, false. + + + Gets the number of key/value pairs in the immutable dictionary. + The number of key/value pairs in the dictionary. + + + Gets an empty immutable dictionary + + + + Returns an enumerator that iterates through the immutable dictionary. + An enumerator that can be used to iterate through the dictionary. + + + Gets a value that indicates whether this instance of the immutable dictionary is empty. + true if this instance is empty; otherwise, false. + + + Gets the TValue associated with the specified key. + The type of the key. + The value associated with the specified key. If no results are found, the operation throws an exception. + + + Gets the key comparer for the immutable dictionary. + The key comparer. + + + Gets the keys in the immutable dictionary. + The keys in the immutable dictionary. + + + Removes the element with the specified key from the immutable dictionary. + The key of the element to remove. + A new immutable dictionary with the specified element removed; or this instance if the specified key cannot be found in the dictionary. + + + Removes the elements with the specified keys from the immutable dictionary. + The keys of the elements to remove. + A new immutable dictionary with the specified keys removed; or this instance if the specified keys cannot be found in the dictionary. + + + Sets the specified key and value in the immutable dictionary, possibly overwriting an existing value for the key. + The key of the entry to add. + The key value to set. + A new immutable dictionary that contains the specified key/value pair. + + + Sets the specified key/value pairs in the immutable dictionary, possibly overwriting existing values for the keys. + The key/value pairs to set in the dictionary. If any of the keys already exist in the dictionary, this method will overwrite their previous values. + A new immutable dictionary that contains the specified key/value pairs. + + + Creates an immutable dictionary with the same contents as this dictionary that can be efficiently mutated across multiple operations by using standard mutable interfaces. + A collection with the same contents as this dictionary that can be efficiently mutated across multiple operations by using standard mutable interfaces. + + + Determines whether this dictionary contains a specified key. + The key to search for. + The matching key located in the dictionary if found, or equalkey if no match is found. + true if a match for equalKey is found; otherwise, false. + + + Gets the value associated with the specified key. + The key whose value will be retrieved. + When this method returns, contains the value associated with the specified key, if the key is found; otherwise, contains the default value for the type of the value parameter. This parameter is passed uninitialized. + true if the object that implements the dictionary contains an element with the specified key; otherwise, false. + key is null. + + + Gets the value comparer used to determine whether values are equal. + The value comparer used to determine whether values are equal. + + + Gets the values in the immutable dictionary. + The values in the immutable dictionary. + + + Gets an instance of the immutable dictionary that uses the specified key comparer. + The key comparer to use. + An instance of the immutable dictionary that uses the given comparer. + + + Gets an instance of the immutable dictionary that uses the specified key and value comparers. + The key comparer to use. + The value comparer to use. + An instance of the immutable dictionary that uses the given comparers. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Copies the elements of the dictionary to an array, starting at a particular array index. + The one-dimensional array that is the destination of the elements copied from the dictionary. The array must have zero-based indexing. + The zero-based index in array at which copying begins. + + + Gets a value indicating whether access to the is synchronized (thread safe). + true if access to the is synchronized (thread safe); otherwise, false. + + + Gets an object that can be used to synchronize access to the . + An object that can be used to synchronize access to the . + + + Adds an element with the provided key and value to the immutable dictionary object. + The object to use as the key of the element to add. + The object to use as the value of the element to add. + + + Clears this instance. + The dictionary object is read-only. + + + Determines whether the immutable dictionary object contains an element with the specified key. + The key to locate in the dictionary object. + true if the dictionary contains an element with the key; otherwise, false. + + + Returns an object for the immutable dictionary object. + An enumerator object for the dictionary object. + + + Gets a value indicating whether the object has a fixed size. + true if the object has a fixed size; otherwise, false. + + + Gets a value indicating whether the is read-only. + true if the is read-only; otherwise, false. + + + Gets or sets the element with the specified key. + The key. + + + + Gets an containing the keys of the . + An containing the keys of the object that implements . + + + Removes the element with the specified key from the immutable dictionary object. + The key of the element to remove. + + + Gets an containing the values in the . + An containing the values in the object that implements . + + + Returns an enumerator that iterates through a collection. + An enumerator object that can be used to iterate through the collection. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Provides a set of initialization methods for instances of the class. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + Determines whether the specified immutable dictionary contains the specified key/value pair. + The immutable dictionary to search. + The key to locate in the immutable dictionary. + The value to locate on the specified key, if the key is found. + The type of the keys in the immutable dictionary. + The type of the values in the immutable dictionary. + true if this map contains the specified key/value pair; otherwise, false. + + + Creates an empty immutable dictionary. + The type of keys stored by the dictionary. + The type of values stored by the dictionary. + An empty immutable dictionary. + + + Creates an empty immutable dictionary that uses the specified key comparer. + The implementation to use to determine the equality of keys in the dictionary. + The type of keys stored by the dictionary. + The type of values stored by the dictionary. + An empty immutable dictionary. + + + Creates an empty immutable dictionary that uses the specified key and value comparers. + The implementation to use to determine the equality of keys in the dictionary. + The implementation to use to determine the equality of values in the dictionary. + The type of keys stored by the dictionary. + The type of values stored by the dictionary. + An empty immutable dictionary. + + + Creates a new immutable dictionary builder. + The type of keys stored by the dictionary. + The type of values stored by the dictionary. + The new builder. + + + Creates a new immutable dictionary builder. + The key comparer. + The type of keys stored by the dictionary. + The type of values stored by the dictionary. + The new builder. + + + Creates a new immutable dictionary builder. + The key comparer. + The value comparer. + The type of keys stored by the dictionary. + The type of values stored by the dictionary. + The new builder. + + + Creates a new immutable dictionary that contains the specified items and uses the specified key comparer. + The comparer implementation to use to compare keys for equality. + The items to add to the dictionary before it’s immutable. + The type of keys in the dictionary. + The type of values in the dictionary. + A new immutable dictionary that contains the specified items and uses the specified comparer. + + + Creates a new immutable dictionary that contains the specified items and uses the specified key comparer. + The comparer implementation to use to compare keys for equality. + The comparer implementation to use to compare values for equality. + The items to add to the dictionary before it’s immutable. + The type of keys in the dictionary. + The type of values in the dictionary. + A new immutable dictionary that contains the specified items and uses the specified comparer. + + + Creates a new immutable dictionary that contains the specified items. + The items used to populate the dictionary before it’s immutable. + The type of keys in the dictionary. + The type of values in the dictionary. + A new immutable dictionary that contains the specified items. + + + Gets the value for a given key if a matching key exists in the dictionary. + The dictionary to retrieve the value from. + The key to search for. + The type of the key. + The type of the value. + The value for the key, or default(TValue) if no matching key was found. + + + Gets the value for a given key if a matching key exists in the dictionary. + The dictionary to retrieve the value from. + The key to search for. + The default value to return if no matching key is found in the dictionary. + The type of the key. + The type of the value. + The value for the key, or defaultValue if no matching key was found. + + + Enumerates a sequence of key/value pairs and produces an immutable dictionary of its contents. + The sequence of key/value pairs to enumerate. + The type of the keys in the dictionary. + The type of the values in the dictionary. + An immutable dictionary that contains the key/value pairs in the specified sequence. + + + Enumerates a sequence of key/value pairs and produces an immutable dictionary of its contents by using the specified key comparer. + The sequence of key/value pairs to enumerate. + The key comparer to use when building the immutable dictionary. + The type of the keys in the dictionary. + The type of the values in the dictionary. + An immutable dictionary that contains the key/value pairs in the specified sequence. + + + Enumerates a sequence of key/value pairs and produces an immutable dictionary of its contents by using the specified key and value comparers. + The sequence of key/value pairs to enumerate. + The key comparer to use when building the immutable dictionary. + The value comparer to use for the immutable dictionary. + The type of the keys in the dictionary. + The type of the values in the dictionary. + An immutable dictionary that contains the key/value pairs in the specified sequence. + + + Enumerates and transforms a sequence, and produces an immutable dictionary of its contents by using the specified key comparer. + The sequence to enumerate to generate the dictionary. + The function that will produce the key for the dictionary from each sequence element. + The function that will produce the value for the dictionary from each sequence element. + The key comparer to use for the dictionary. + The type of the elements in the sequence. + The type of the keys in the resulting dictionary. + The type of the values in the resulting dictionary. + An immutable dictionary that contains the items in the specified sequence. + + + Enumerates and transforms a sequence, and produces an immutable dictionary of its contents. + The sequence to enumerate to generate the dictionary. + The function that will produce the key for the dictionary from each sequence element. + The function that will produce the value for the dictionary from each sequence element. + The type of the elements in the sequence. + The type of the keys in the resulting dictionary. + The type of the values in the resulting dictionary. + An immutable dictionary that contains the items in the specified sequence. + + + Enumerates and transforms a sequence, and produces an immutable dictionary of its contents by using the specified key and value comparers. + The sequence to enumerate to generate the dictionary. + The function that will produce the key for the dictionary from each sequence element. + The function that will produce the value for the dictionary from each sequence element. + The key comparer to use for the dictionary. + The value comparer to use for the dictionary. + The type of the elements in the sequence. + The type of the keys in the resulting dictionary. + The type of the values in the resulting dictionary. + An immutable dictionary that contains the items in the specified sequence. + + + Constructs an immutable dictionary from an existing collection of elements, applying a transformation function to the source keys. + The source collection used to generate the immutable dictionary. + The function used to transform keys for the immutable dictionary. + The type of element in the source collection. + The type of key in the resulting immutable dictionary. + The immutable dictionary that contains elements from source, with keys transformed by applying keySelector. + + + Constructs an immutable dictionary based on some transformation of a sequence. + The source collection used to generate the immutable dictionary. + The function used to transform keys for the immutable dictionary. + The key comparer to use for the dictionary. + The type of element in the source collection. + The type of key in the resulting immutable dictionary. + The immutable dictionary that contains elements from source, with keys transformed by applying keySelector. + + + Represents a hash set that mutates with little or no memory allocations and that can produce or build on immutable hash set instances very efficiently. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + + Adds the specified item to the immutable hash set. + The item to add. + true if the item did not already belong to the collection; otherwise, false. + + + Removes all items from the immutable hash set. + The hash set is read-only. + + + Determines whether the immutable hash set contains a specific value. + The object to locate in the hash set. + true if item is found in the hash set ; otherwise, false. + + + Gets the number of elements contained in the immutable hash set. + The number of elements contained in the immutable hash set. + + + Removes all elements in the specified collection from the current hash set. + The collection of items to remove from the set. + + + Returns an enumerator that iterates through the immutable hash set. + An enumerator that can be used to iterate through the set. + + + Modifies the current set so that it contains only elements that are also in a specified collection. + The collection to compare to the current set. + + + Determines whether the current set is a proper (strict) subset of a specified collection. + The collection to compare to the current set. + true if the current set is a proper subset of other; otherwise, false. + + + Determines whether the current set is a proper (strict) superset of a specified collection. + The collection to compare to the current set. + true if the current set is a proper superset of other; otherwise, false. + + + Determines whether the current set is a subset of a specified collection. + The collection to compare to the current set. + true if the current set is a subset of other; otherwise, false. + + + Determines whether the current set is a superset of a specified collection. + The collection to compare to the current set. + true if the current set is a superset of other; otherwise, false. + + + Gets or sets the key comparer. + The key comparer. + + + Determines whether the current set overlaps with the specified collection. + The collection to compare to the current set. + true if the current set and other share at least one common element; otherwise, false. + + + Removes the first occurrence of a specific object from the immutable hash set. + The object to remove from the set. + true if item was successfully removed from the set ; otherwise, false. This method also returns false if item is not found in the original set. + The set is read-only. + + + Determines whether the current set and the specified collection contain the same elements. + The collection to compare to the current set. + true if the current set is equal to other; otherwise, false. + + + Modifies the current set so that it contains only elements that are present either in the current set or in the specified collection, but not both. + The collection to compare to the current set. + + + Creates an immutable hash set based on the contents of this instance. + An immutable set. + + + Modifies the current set so that it contains all elements that are present in both the current set and in the specified collection. + The collection to compare to the current set. + + + Adds an item to the hash set. + The object to add to the set. + The set is read-only. + + + Copies the elements of the hash set to an array, starting at a particular array index. + The one-dimensional array that is the destination of the elements copied from the hash set. The array must have zero-based indexing. + The zero-based index in array at which copying begins. + + + Gets a value indicating whether the is read-only. + true if the is read-only; otherwise, false. + + + Returns an enumerator that iterates through the collection. + An enumerator that can be used to iterate through the collection. + + + Returns an enumerator that iterates through a collection. + An enumerator that can be used to iterate through the collection. + + + Enumerates the contents of the immutable hash set without allocating any memory. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + + Gets the element at the current position of the enumerator. + The element at the current position of the enumerator. + + + Releases the resources used by the current instance of the class. + + + Advances the enumerator to the next element of the immutable hash set. + true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the hash set. + The hash set was modified after the enumerator was created. + + + Sets the enumerator to its initial position, which is before the first element in the hash set. + The hash set was modified after the enumerator was created. + + + Gets the current element. + + + + Represents an immutable, unordered hash set. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + The type of elements in the hash set. + + + Adds the specified element to the hash set. + The element to add to the set. + A hash set that contains the added value and any values previously held by the object. + + + Retrieves an empty immutable hash set that has the same sorting and ordering semantics as this instance. + An empty hash set that has the same sorting and ordering semantics as this instance. + + + Determines whether this immutable hash set contains the specified element. + The object to locate in the immutable hash set. + true if item is found in the ; otherwise, false. + + + Gets the number of elements in the immutable hash set. + The number of elements in the hash set. + + + Gets an immutable hash set for this type that uses the default . + + + + Removes the elements in the specified collection from the current immutable hash set. + The collection of items to remove from this set. + A new set with the items removed; or the original set if none of the items were in the set. + + + Returns an enumerator that iterates through the collection. + An enumerator that can be used to iterate through the collection. + + + Creates an immutable hash set that contains elements that exist in both this set and the specified set. + The collection to compare to the current set. + A new immutable set that contains any elements that exist in both sets. + + + Gets a value that indicates whether the current immutable hash set is empty. + true if this instance is empty; otherwise, false. + + + Determines whether the current immutable hash set is a proper (strict) subset of a specified collection. + The collection to compare to the current set. + true if the current set is a proper subset of the specified collection; otherwise, false. + + + Determines whether the current immutable hash set is a proper (strict) superset of a specified collection. + The collection to compare to the current set. + true if the current set is a proper superset of the specified collection; otherwise, false. + + + Determines whether the current immutable hash set is a subset of a specified collection. + The collection to compare to the current set. + true if the current set is a subset of the specified collection; otherwise, false. + + + Determines whether the current immutable hash set is a superset of a specified collection. + The collection to compare to the current set. + true if the current set is a superset of the specified collection; otherwise, false. + + + Gets the object that is used to obtain hash codes for the keys and to check the equality of values in the immutable hash set. + The comparer used to obtain hash codes for the keys and check equality. + + + Determines whether the current immutable hash set overlaps with the specified collection. + The collection to compare to the current set. + true if the current set and the specified collection share at least one common element; otherwise, false. + + + Removes the specified element from this immutable hash set. + The element to remove. + A new set with the specified element removed, or the current set if the element cannot be found in the set. + + + Determines whether the current immutable hash set and the specified collection contain the same elements. + The collection to compare to the current set. + true if the sets are equal; otherwise, false. + + + Creates an immutable hash set that contains only elements that are present either in the current set or in the specified collection, but not both. + The collection to compare to the current set. + A new set that contains the elements that are present only in the current set or in the specified collection, but not both. + + + Creates an immutable hash set that has the same contents as this set and can be efficiently mutated across multiple operations by using standard mutable interfaces. + A set with the same contents as this set that can be efficiently mutated across multiple operations by using standard mutable interfaces. + + + Searches the set for a given value and returns the equal value it finds, if any. + The value to search for. + The value from the set that the search found, or the original value if the search yielded no match. + A value indicating whether the search was successful. + + + Creates a new immutable hash set that contains all elements that are present in either the current set or in the specified collection. + The collection to add elements from. + A new immutable hash set with the items added; or the original set if all the items were already in the set. + + + Gets an instance of the immutable hash set that uses the specified equality comparer for its search methods. + The equality comparer to use. + An instance of this immutable hash set that uses the given comparer. + + + Adds an item to the set. + The object to add to the set. + The set is read-only. + + + Removes all items from this set. + The set is read-only. + + + Copies the elements of the set to an array, starting at a particular index. + The one-dimensional array that is the destination of the elements copied from the set. The array must have zero-based indexing. + The zero-based index in array at which copying begins. + + + See the interface. + + + + Removes the first occurrence of a specific object from the set. + The object to remove from the set. + true if the element is successfully removed; otherwise, false. + + + Returns an enumerator that iterates through the collection. + An enumerator that iterates through the collection. + + + Adds an element to the current set and returns a value that indicates whether the element was successfully added. + The element to add to the collection. + true if the element is added to the set; false if the element is already in the set. + + + Removes all elements in the specified collection from the current set. + The collection of items to remove. + + + Modifies the current set so that it contains only elements that are also in a specified collection. + The collection to compare to the current collection. + + + Modifies the current set so that it contains only elements that are present either in the current set or in the specified collection, but not both. + The collection to compare to the current set. + + + Modifies the current set so that it contains all elements that are present in either the current set or in the specified collection. + The collection to compare to the current set. + + + Copies the elements of the set to an array, starting at a particular index. + The one-dimensional array that is the destination of the elements copied from the set. The array must have zero-based indexing. + The zero-based index in array at which copying begins. + + + See the interface. + + + + See . + + + + Returns an enumerator that iterates through a set. + An enumerator that can be used to iterate through the set. + + + Adds the specified element to this immutable set. + The element to add. + A new set with the element added, or this set if the element is already in the set. + + + Retrieves an empty set that has the same sorting and ordering semantics as this instance. + An empty set that has the same sorting or ordering semantics as this instance. + + + Removes the elements in the specified collection from the current set. + The collection of items to remove from this set. + A new set with the items removed; or the original set if none of the items were in the set. + + + Creates an immutable set that contains elements that exist in both this set and the specified set. + The collection to compare to the current set. + A new immutable set that contains any elements that exist in both sets. + + + Removes the specified element from this immutable set. + The element to remove. + A new set with the specified element removed, or the current set if the element cannot be found in the set. + + + Creates an immutable set that contains only elements that are present either in the current set or in the specified collection, but not both. + The collection to compare to the current set. + A new set that contains the elements that are present only in the current set or in the specified collection, but not both. + + + Creates a new immutable set that contains all elements that are present in either the current set or in the specified collection. + The collection to add elements from. + A new immutable set with the items added; or the original set if all the items were already in the set. + + + Provides a set of initialization methods for instances of the class. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + Creates an empty immutable hash set. + The type of items to be stored in the immutable hash set. + An empty immutable hash set. + + + Creates an empty immutable hash set that uses the specified equality comparer. + The object to use for comparing objects in the set for equality. + The type of items in the immutable hash set. + An empty immutable hash set. + + + Creates a new immutable hash set that contains the specified item. + The item to prepopulate the hash set with. + The type of items in the immutable hash set. + A new immutable hash set that contains the specified item. + + + Creates a new immutable hash set that contains the specified array of items. + An array that contains the items to prepopulate the hash set with. + The type of items in the immutable hash set. + A new immutable hash set that contains the specified items. + + + Creates a new immutable hash set that contains the specified item and uses the specified equality comparer for the set type. + The object to use for comparing objects in the set for equality. + The item to prepopulate the hash set with. + The type of items in the immutable hash set. + A new immutable hash set that contains the specified item. + + + Creates a new immutable hash set that contains the items in the specified collection and uses the specified equality comparer for the set type. + The object to use for comparing objects in the set for equality. + An array that contains the items to prepopulate the hash set with. + The type of items stored in the immutable hash set. + A new immutable hash set that contains the specified items. + + + Creates a new immutable hash set builder. + The type of items stored by the collection. + The immutable hash set builder. + + + Creates a new immutable hash set builder. + The object to use for comparing objects in the set for equality. + The type of items stored by the collection. + The new immutable hash set builder. + + + Creates a new immutable hash set prefilled with the specified items. + The items to add to the hash set. + The type of items stored by the collection. + The new immutable hash set that contains the specified items. + + + Creates a new immutable hash set that contains the specified items and uses the specified equality comparer for the set type. + The object to use for comparing objects in the set for equality. + The items add to the collection before immutability is applied. + The type of items stored in the collection. + The new immutable hash set. + + + Enumerates a sequence and produces an immutable hash set of its contents. + The sequence to enumerate. + The type of the elements in the sequence. + An immutable hash set that contains the items in the specified sequence. + + + Enumerates a sequence, produces an immutable hash set of its contents, and uses the specified equality comparer for the set type. + The sequence to enumerate. + The object to use for comparing objects in the set for equality. + The type of the elements in the sequence. + An immutable hash set that contains the items in the specified sequence and uses the specified equality comparer. + + + Contains interlocked exchange mechanisms for immutable collections. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + Obtains the value from a dictionary after having added it or updated an existing entry. + The variable or field to atomically update if the specified is not in the dictionary. + The key for the value to add or update. + The function that receives the key and returns a new value to add to the dictionary when no value previously exists. + The function that receives the key and prior value and returns the new value with which to update the dictionary. + + + The added or updated value. + + + Obtains the value from a dictionary after having added it or updated an existing entry. + The variable or field to atomically update if the specified is not in the dictionary. + The key for the value to add or update. + The value to use if no previous value exists. + The function that receives the key and prior value and returns the new value with which to update the dictionary. + + + The added or updated value. + + + Atomically enqueues an element to the end of a queue. + The variable or field to atomically update. + The value to enqueue. + The type of items contained in the collection + + + Gets the value for the specified key from the dictionary, or if the key was not found, adds a new value to the dictionary. + The variable or field to update if the specified is not in the dictionary. + The key for the value to retrieve or add. + The function to execute to obtain the value to insert into the dictionary if the key is not found. + The argument to pass to the value factory. + The type of the keys contained in the collection. + The type of the values contained in the collection. + + The value at the specified key or valueFactory if the key was not present. + + + Gets the value for the specified key from the dictionary, or if the key was not found, adds a new value to the dictionary. + The variable or field to atomically update if the specified is not in the dictionary. + The key for the value to retrieve or add. + The function to execute to obtain the value to insert into the dictionary if the key is not found. This delegate will not be invoked more than once. + The type of the keys contained in the collection. + The type of the values contained in the collection. + The value at the specified key or valueFactory if the key was not present. + + + Gets the value for the specified key from the dictionary, or if the key was not found, adds a new value to the dictionary. + The variable or field to atomically update if the specified key is not in the dictionary. + The key for the value to get or add. + The value to add to the dictionary the key is not found. + The type of the keys contained in the collection. + The type of the values contained in the collection. + The value at the specified key or valueFactory if the key was not present. + + + Compares two immutable arrays for equality and, if they are equal, replaces one of the arrays. + The destination, whose value is compared with comparand and possibly replaced. + The value that replaces the destination value if the comparison results in equality. + The value that is compared to the value at location. + The type of element stored by the array. + The original value in location. + + + Sets an array to the specified array and returns a reference to the original array, as an atomic operation. + The array to set to the specified value. + The value to which the location parameter is set. + The type of element stored by the array. + The original value of location. + + + Sets an array to the specified array if the array has not been initialized. + The array to set to the specified value. + The value to which the location parameter is set, if it’s not initialized. + The type of element stored by the array. + true if the array was assigned the specified value; otherwise, false. + + + Pushes a new element onto the stack. + The stack to update. + The value to push on the stack. + The type of items in the stack. + + + Adds the specified key and value to the dictionary if the key is not in the dictionary. + The dictionary to update with the specified key and value. + The key to add, if is not already defined in the dictionary. + The value to add. + The type of the keys contained in the collection. + The type of the values contained in the collection. + true if the key is not in the dictionary; otherwise, false. + + + Atomically removes and returns the specified element at the head of the queue, if the queue is not empty. + The variable or field to atomically update. + Set to the value from the head of the queue, if the queue not empty. + The type of items in the queue. + true if the queue is not empty and the head element is removed; otherwise, false. + + + Removes an element from the top of the stack, if there is an element to remove. + The stack to update. + Receives the value removed from the stack, if the stack is not empty. + The type of items in the stack. + true if an element is removed from the stack; otherwise, false. + + + Removes the element with the specified key, if the key exists. + The dictionary to update. + The key to remove. + Receives the value of the removed item, if the dictionary is not empty. + The type of the keys contained in the collection. + The type of the values contained in the collection. + true if the key was found and removed; otherwise, false. + + + Sets the specified key to the specified value if the specified key already is set to a specific value. + The dictionary to update. + The key to update. + The new value to set. + The current value for key in order for the update to succeed. + The type of the keys contained in the collection. + The type of the values contained in the collection. + true if key and comparisonValue are present in the dictionary and comparison was updated to newValue; otherwise, false. + + + Mutates a value in-place with optimistic locking transaction semantics via a specified transformation function. The transformation is retried as many times as necessary to win the optimistic locking race. + The variable or field to be changed, which may be accessed by multiple threads. + A function that mutates the value. This function should be side-effect free, as it may run multiple times when races occur with other threads. + The argument to pass to transformer. + The type of data. + The type of argument passed to the transformer. + true if the location&#39;s value is changed by applying the result of the transformer function; false if the location&#39;s value remained the same because the last invocation of transformer returned the existing value. + + + Mutates a value in-place with optimistic locking transaction semantics via a specified transformation function. The transformation is retried as many times as necessary to win the optimistic locking race. + The variable or field to be changed, which may be accessed by multiple threads. + A function that mutates the value. This function should be side-effect free, as it may run multiple times when races occur with other threads. + The type of data. + true if the location&#39;s value is changed by applying the result of the transformer function; false if the location&#39;s value remained the same because the last invocation of transformer returned the existing value. + + + Represents a list that mutates with little or no memory allocations and that can produce or build on immutable list instances very efficiently. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + + Adds an item to the immutable list. + The item to add to the list. + + + Adds a series of elements to the end of this list. + The elements to add to the end of the list. + + + Searches the entire for an element using the default comparer and returns the zero-based index of the element. + The object to locate. The value can be null for reference types. + The zero-based index of item in the , if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item. + + + Searches the entire for an element using the specified comparer and returns the zero-based index of the element. + The object to locate. This value can be null for reference types. + The implementation to use when comparing elements, or null for the default comparer. + The zero-based index of item in the , if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item. + + + Searches the specified range of the for an element using the specified comparer and returns the zero-based index of the element. + The zero-based starting index of the range to search. + The length of the range to search. + The object to locate. This value can be null for reference types. + The implementation to use when comparing elements, or null for the default comparer. + The zero-based index of item in the , if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item. + + + Removes all items from the immutable list. + + + Determines whether the immutable list contains a specific value. + The object to locate in the list. + true if item is found in the list; otherwise, false. + + + Creates a new immutable list from the list represented by this builder by using the converter function. + The converter function. + The type of the output of the delegate converter function. + A new immutable list from the list represented by this builder. + + + Copies the entire immutable list to a compatible one-dimensional array, starting at the beginning of the target array. + The one-dimensional array that is the destination of the elements copied from the immutable list. The array must have zero-based indexing. + + + Copies the entire immutable list to a compatible one-dimensional array, starting at the specified index of the target array. + The one-dimensional array that is the destination of the elements copied from the immutable list. The array must have zero-based indexing. + The zero-based index in array at which copying begins. + + + Copies the entire immutable list to a compatible one-dimensional array, starting at the specified index of the target array. + The zero-based index in the source immutable list at which copying begins. + The one-dimensional array that is the destination of the elements copied from the immutable list. The array must have zero-based indexing. + The zero-based index in array at which copying begins. + The number of elements to copy. + + + Gets the number of elements in this immutable list. + The number of elements in this list. + + + Determines whether the immutable list contains elements that match the conditions defined by the specified predicate. + The delegate that defines the conditions of the elements to search for. + true if the immutable list contains one or more elements that match the conditions defined by the specified predicate; otherwise, false. + + + Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the entire immutable list. + The delegate that defines the conditions of the element to search for. + The first element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type T. + + + Retrieves all the elements that match the conditions defined by the specified predicate. + The delegate that defines the conditions of the elements to search for. + An immutable list containing all the elements that match the conditions defined by the specified predicate, if found; otherwise, an empty immutable list. + + + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire immutable list. + The delegate that defines the conditions of the element to search for. + The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. + + + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the immutable list that extends from the specified index to the last element. + The zero-based starting index of the search. + The delegate that defines the conditions of the element to search for. + The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. + + + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the immutable list that starts at the specified index and contains the specified number of elements. + The zero-based starting index of the search. + The number of elements in the section to search. + The delegate that defines the conditions of the element to search for. + The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. + + + Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire immutable list. + The delegate that defines the conditions of the element to search for. + The last element that matches the conditions defined by the specified predicate, found; otherwise, the default value for type T. + + + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire immutable list. + The delegate that defines the conditions of the element to search for. + The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. + + + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the immutable list that extends from the first element to the specified index. + The zero-based starting index of the backward search. + The delegate that defines the conditions of the element to search for. + The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. + + + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the immutable list that contains the specified number of elements and ends at the specified index. + The zero-based starting index of the backward search. + The number of elements in the section to search. + The delegate that defines the conditions of the element to search for. + The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. + + + Performs the specified action on each element of the list. + The delegate to perform on each element of the list. + + + Returns an enumerator that iterates through the collection. + An enumerator that can be used to iterate through the list. + + + Creates a shallow copy of a range of elements in the source immutable list. + The zero-based index at which the range starts. + The number of elements in the range. + A shallow copy of a range of elements in the source immutable list. + + + Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the immutable list. + The object to locate in the immutable list. The value can be null for reference types. + The zero-based index of the first occurrence of item within the range of elements in the immutable list, if found; otherwise, –1. + + + Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the immutable list that extends from the specified index to the last element. + The object to locate in the immutable list. The value can be null for reference types. + The zero-based starting index of the search. 0 (zero) is valid in an empty list. + The zero-based index of the first occurrence of item within the range of elements in the immutable list that extends from index to the last element, if found; otherwise, –1. + + + Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the immutable list that starts at the specified index and contains the specified number of elements. + The object to locate in the immutable list. The value can be null for reference types. + The zero-based starting index of the search. 0 (zero) is valid in an empty list. + The number of elements in the section to search. + The zero-based index of the first occurrence of item within the range of elements in the immutable list that starts at index and contains count number of elements, if found; otherwise, –1. + + + Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the that starts at the specified index and contains the specified number of elements. + The object to locate in the immutable list. The value can be null for reference types. + The zero-based starting index of the search. 0 (zero) is valid in an empty list. + The number of elements to search. + The value comparer to use for comparing elements for equality. + The zero-based index of the first occurrence of item within the range of elements in the immutable list that starts at index and contains count number of elements, if found; otherwise, –1 + + + Inserts an item to the immutable list at the specified index. + The zero-based index at which item should be inserted. + The object to insert into the immutable list. + + + Inserts the elements of a collection into the immutable list at the specified index. + The zero-based index at which the new elements should be inserted. + The collection whose elements should be inserted into the immutable list. The collection itself cannot be null, but it can contain elements that are null, if type T is a reference type. + + + Gets or sets the value for a given index in the list. + The index of the item to get or set. + The value at the specified index. + + + Searches for the specified object and returns the zero-based index of the last occurrence within the entire immutable list. + The object to locate in the immutable list. The value can be null for reference types. + The zero-based index of the last occurrence of item within the entire immutable list, if found; otherwise, –1. + + + Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the immutable list that extends from the first element to the specified index. + The object to locate in the immutable list. The value can be null for reference types. + The zero-based starting index of the backward search. + The zero-based index of the last occurrence of item within the range of elements in the immutable list that extends from the first element to index, if found; otherwise, –1. + + + Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the immutable list that contains the specified number of elements and ends at the specified index. + The object to locate in the immutable list. The value can be null for reference types. + The zero-based starting index of the backward search. + The number of elements in the section to search. + The zero-based index of the last occurrence of item within the range of elements in the immutable list that contains count number of elements and ends at index, if found; otherwise, –1. + + + Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the immutable list that contains the specified number of elements and ends at the specified index. + The object to locate in the immutable list. The value can be null for reference types. + The zero-based starting index of the search. 0 (zero) is valid in an empty list. + The number of elements to search. + The value comparer to use for comparing elements for equality. + The zero-based index of the first occurrence of item within the range of elements in the immutable list that starts at index and contains count number of elements, if found; otherwise, –1 + + + Removes the first occurrence of a specific object from the immutable list. + The object to remove from the list. + true if item was successfully removed from the list; otherwise, false. This method also returns false if item is not found in the list. + + + Removes all the elements that match the conditions defined by the specified predicate. + The delegate that defines the conditions of the elements to remove. + The number of elements removed from the immutable list. + + + Removes the item at the specified index of the immutable list. + The zero-based index of the item to remove from the list. + + + Reverses the order of the elements in the entire immutable list. + + + Reverses the order of the elements in the specified range of the immutable list. + The zero-based starting index of the range to reverse. + The number of elements in the range to reverse. + + + Sorts the elements in the entire immutable list by using the default comparer. + + + Sorts the elements in the entire immutable list by using the specified comparer. + The implementation to use when comparing elements, or null to use the default comparer (). + + + Sorts the elements in the entire immutable list by using the specified comparison object. + The object to use when comparing elements. + + + Sorts the elements in a range of elements in the immutable list by using the specified comparer. + The zero-based starting index of the range to sort. + The length of the range to sort. + The implementation to use when comparing elements, or null to use the default comparer (). + + + Creates an immutable list based on the contents of this instance. + An immutable list. + + + Determines whether every element in the immutable list matches the conditions defined by the specified predicate. + The delegate that defines the conditions to check against the elements. + true if every element in the immutable list matches the conditions defined by the specified predicate; otherwise, false. If the list has no elements, the return value is true. + + + Gets a value indicating whether this instance is read-only. + Always false. + + + Returns an enumerator that iterates through the collection. + An enumerator that can be used to iterate through the collection. + + + Copies the elements of the list to an array, starting at a particular array index. + The one-dimensional array that is the destination of the elements copied from the list. The array must have zero-based indexing. + The zero-based index in array at which copying begins. + + + + Gets a value indicating whether access to the is synchronized (thread safe). + true if access to the is synchronized (thread safe); otherwise, false. + + + Gets an object that can be used to synchronize access to the . + An object that can be used to synchronize access to the . + + + Returns an enumerator that iterates through the collection. + An enumerator that can be used to iterate through the collection. + + + Adds an item to the list. + The object to add to the list. + The position into which the new element was inserted, or -1 to indicate that the item was not inserted into the collection. + + + + Removes all items from the list. + + + + Determines whether the list contains a specific value. + The object to locate in the list. + true if the is found in the list; otherwise, false. + + + + Determines the index of a specific item in the list. + The object to locate in the list. + The index of value if found in the list; otherwise, -1. + + + + Inserts an item to the list at the specified index. + The zero-based index at which value should be inserted. + The object to insert into the list. + + + + Gets a value indicating whether the has a fixed size. + true if the has a fixed size; otherwise, false. + + + Gets a value indicating whether the is read-only. + true if the is read-only; otherwise, false. + + + Gets or sets the at the specified index. + The index. + + + + Removes the first occurrence of a specific object from the list. + The object to remove from the list. + + + + Enumerates the contents of a binary tree. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + + Gets the element at the current position of the enumerator. + The element at the current position of the enumerator. + + + Releases the resources used by the current instance of the class. + + + Advances enumeration to the next element of the immutable list. + true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the list. + + + Sets the enumerator to its initial position, which is before the first element in the immutable list. + + + The current element. + + + + Represents an immutable list, which is a strongly typed list of objects that can be accessed by index. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + The type of elements in the list. + + + Adds the specified object to the end of the immutable list. + The object to add. + A new immutable list with the object added, or the current list if it already contains the specified object. + + + Adds the elements of the specified collection to the end of the immutable list. + The collection whose elements will be added to the end of the list. + A new immutable list with the elements added, or the current list if it already contains the specified elements. + + + Searches the entire sorted list for an element using the default comparer and returns the zero-based index of the element. + The object to locate. The value can be null for reference types. + The zero-based index of item in the sorted List, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of . + The default comparer cannot find a comparer implementation of the for type T. + + + Searches the entire sorted list for an element using the specified comparer and returns the zero-based index of the element. + The object to locate. The value can be null for reference types. + The comparer implementation to use when comparing elements or null to use the default comparer. + The zero-based index of item in the sorted List, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of . + comparer is null, and the default comparer cannot find an comparer implementation for type T. + + + Searches a range of elements in the sorted list for an element using the specified comparer and returns the zero-based index of the element. + The zero-based starting index of the range to search. + The length of the range to search. + The object to locate. The value can be null for reference types. + The comparer implementation to use when comparing elements, or null to use the default comparer. + The zero-based index of item in the sorted list, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of count. + index is less than 0 or count is less than 0. + index and count do not denote a valid range in the list. + comparer is null, and the default comparer cannot find an comparer implementation for type T. + + + Removes all elements from the immutable list. + An empty list that retains the same sort or unordered semantics that this instance has. + + + Determines whether this immutable list contains the specified value. + The value to locate. + true if the list contains the specified value; otherwise, false. + + + Converts the elements in the current immutable list to another type, and returns a list containing the converted elements. + A delegate that converts each element from one type to another type. + The type of the elements of the target array. + + + + Copies the entire immutable list to a compatible one-dimensional array, starting at the specified index of the target array. + The one-dimensional array that is the destination of the elements copied from the immutable list. The array must have zero-based indexing. + The zero-based index in array at which copying begins. + + + Copies a range of elements from the immutable list to a compatible one-dimensional array, starting at the specified index of the target array. + The zero-based index in the source immutable list at which copying begins. + The one-dimensional array that is the destination of the elements copied from the immutable list. The array must have zero-based indexing. + The zero-based index in array at which copying begins. + The number of elements to copy. + + + Copies the entire immutable list to a compatible one-dimensional array, starting at the beginning of the target array. + The one-dimensional array that is the destination of the elements copied from the immutable list. The array must have zero-based indexing. + + + Gets the number of elements contained in the list. + The number of elements in the list. + + + Gets an empty set with the default sort comparer. + + + + Determines whether the immutable list contains elements that match the conditions defined by the specified predicate. + The delegate that defines the conditions of the elements to search for. + true if the immutable list contains one or more elements that match the conditions defined by the specified predicate; otherwise, false. + + + Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the entire immutable list. + The delegate that defines the conditions of the element to search for. + The first element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type T. + + + Retrieves all the elements that match the conditions defined by the specified predicate. + The delegate that defines the conditions of the elements to search for. + An immutable list that contains all the elements that match the conditions defined by the specified predicate, if found; otherwise, an empty immutable list. + + + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire immutable list. + The delegate that defines the conditions of the element to search for. + The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, ?1. + + + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the immutable list that extends from the specified index to the last element. + The zero-based starting index of the search. + The delegate that defines the conditions of the element to search for. + The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, ?1. + + + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the immutable list that starts at the specified index and contains the specified number of elements. + The zero-based starting index of the search. + The number of elements in the section to search. + The delegate that defines the conditions of the element to search for. + The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, ?1. + + + Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire immutable list. + The delegate that defines the conditions of the element to search for. + The last element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type T. + + + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the immutable list that contains the specified number of elements and ends at the specified index. + The zero-based starting index of the backward search. + The number of elements in the section to search. + The delegate that defines the conditions of the element to search for. + The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, ?1. + + + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the immutable list that extends from the first element to the specified index. + The zero-based starting index of the backward search. + The delegate that defines the conditions of the element to search for. + The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, ?1. + + + Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire immutable list. + The delegate that defines the conditions of the element to search for. + The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, ?1. + + + Performs the specified action on each element of the immutable list. + The delegate to perform on each element of the immutable list. + + + Returns an enumerator that iterates through the immutable list. + An enumerator that can be used to iterate through the immutable list. + + + Creates a shallow copy of a range of elements in the source immutable list. + The zero-based index at which the range starts. + The number of elements in the range. + A shallow copy of a range of elements in the source immutable list. + + + Searches for the specified object and returns the zero-based index of the first occurrence within the entire immutable list. + The object to locate in the immutable list. The value can be null for reference types. + The zero-based index of the first occurrence of value within the entire immutable list, if found; otherwise, ?1. + + + Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the list that starts at the specified index and contains the specified number of elements. + The object to locate in the list The value can be null for reference types. + The zero-based starting index of the search. 0 (zero) is valid in an empty list. + The number of elements in the section to search. + The equality comparer to use in the search. + The zero-based index of the first occurrence of item within the range of elements in the list that starts at index and contains count number of elements, if found; otherwise, –1. + + + Inserts the specified object into the immutable list at the specified index. + The zero-based index at which to insert the object. + The object to insert. + The new immutable list after the object is inserted. + + + Inserts the elements of a collection into the immutable list at the specified index. + The zero-based index at which to insert the elements. + The collection whose elements should be inserted. + The new immutable list after the elements are inserted. + + + Gets a value that indicates whether this list is empty. + true if the list is empty; otherwise, false. + + + Gets the element at the specified index of the list. + The index of the element to retrieve. + The element at the specified index. + + + Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the list that contains the specified number of elements and ends at the specified index. + The object to locate in the list. The value can be null for reference types. + The zero-based starting index of the backward search. + The number of elements in the section to search. + The equality comparer to use in the search. + The zero-based index of the last occurrence of item within the range of elements in the list that contains count number of elements and ends at index, if found; otherwise, –1. + + + Removes the first occurrence of the specified object from this immutable list. + The object to remove. + A new list with the object removed, or this list if the specified object is not in this list. + + + Removes the first occurrence of the object that matches the specified value from this immutable list. + The value of the element to remove from the list. + The equality comparer to use in the search. + A new list with the object removed, or this list if the specified object is not in this list. + + + Removes all the elements that match the conditions defined by the specified predicate. + The delegate that defines the conditions of the elements to remove. + The new list with the elements removed. + + + Removes the element at the specified index. + The zero-based index of the element to remove. + A new list with the element removed. + + + Removes a range of elements from this immutable list. + The collection whose elements should be removed if matches are found in this list. + A new list with the elements removed. + + + Removes the specified values from this list. + The items to remove if matches are found in this list. + The equality comparer to use in the search. + A new list with the elements removed. + + + Removes a range of elements, starting from the specified index and containing the specified number of elements, from this immutable list. + The starting index to begin removal. + The number of elements to remove. + A new list with the elements removed. + + + Replaces the specified element in the immutable list with a new element. + The element to replace. + The element to replace oldValue with. + The new list with the replaced element, even if it is equal to the old element. + oldValue does not exist in the immutable list. + + + Replaces the specified element in the immutable list with a new element. + The element to replace in the list. + The element to replace oldValue with. + The comparer to use to check for equality. + A new list with the object replaced, or this list if the specified object is not in this list. + + + Reverses the order of the elements in the specified range of the immutable list. + The zero-based starting index of the range to reverse. + The number of elements in the range to reverse. + The reversed list. + + + Reverses the order of the elements in the entire immutable list. + The reversed list. + + + Replaces an element at a given position in the immutable list with the specified element. + The position in the list of the element to replace. + The element to replace the old element with. + The new list with the replaced element, even if it is equal to the old element at that position. + + + Sorts the elements in the entire immutable list using the default comparer. + The sorted list. + + + Sorts the elements in the entire immutable list using the specified comparer. + The implementation to use when comparing elements, or null to use the default comparer (). + The sorted list. + + + Sorts the elements in the entire immutable list using the specified comparer. + The delegate to use when comparing elements. + The sorted list. + + + Sorts a range of elements in the immutable list using the specified comparer. + The zero-based starting index of the range to sort. + The length of the range to sort. + The implementation to use when comparing elements, or null to use the default comparer (). + The sorted list. + + + Creates a list that has the same contents as this list and can be efficiently mutated across multiple operations using standard mutable interfaces. + The created list with the same contents as this list. + + + Determines whether every element in the immutable list matches the conditions defined by the specified predicate. + The delegate that defines the conditions to check against the elements. + true if every element in the immutable list matches the conditions defined by the specified predicate; otherwise, false. If the list has no elements, the return value is true. + + + Adds the specified item to the immutable list. + The item to add. + + + + Removes all items from the immutable list. + + + + Gets a value indicating whether the is read-only. + true if the is read-only; otherwise, false. + + + Removes the first occurrence of a specific object from the immutable list. + The object to remove. + true if item was successfully removed from the list; otherwise, false. This method also returns false if item is not found in the original list. + + + Returns an enumerator that iterates through the immutable list. + An enumerator that can be used to iterate through the list. + + + Inserts an object in the immutable list at the specified index. + The zero-based index at which item should be inserted. + The object to insert. + + + + Gets or sets the value at the specified index. + + + Thrown from getter when index is negative or not less than . + Always thrown from the setter. + + + Removes the value at the specified index. + The zero-based index of the item to remove. + + + + Copies the entire immutable list to a compatible one-dimensional array, starting at the specified array index. + The one-dimensional array that is the destination of the elements copied from immutable list. + The zero-based index in array at which copying begins. + + + See the interface. + + + + See . + + + + Returns an enumerator that iterates through the immutable list. + An enumerator that can be used to iterate through the list. + + + Adds an item to the immutable list. + The object to add to the list. + The position into which the new element was inserted, or -1 to indicate that the item was not inserted into the list. + + + + Removes all items from the immutable list. + + + + Determines whether the immutable list contains a specific value. + The object to locate in the list. + true if the object is found in the list; otherwise, false. + + + + Determines the index of a specific item in the immutable list. + The object to locate in the list. + The index of value if found in the list; otherwise, -1. + + + + Inserts an item into the immutable list at the specified index. + The zero-based index at which value should be inserted. + The object to insert into the list. + + + + Gets a value indicating whether the has a fixed size. + true if the has a fixed size; otherwise, false. + + + Gets a value indicating whether the is read-only. + true if the is read-only; otherwise, false. + + + Gets or sets the at the specified index. + The index. + The value at the specified index. + Thrown from getter when index is negative or not less than . + Always thrown from the setter. + + + Removes the first occurrence of a specific object from the immutable list. + The object to remove from the list. + + + + Removes the item at the specified index of the immutable list. + The zero-based index of the item to remove. + + + + Adds the specified value to this immutable list. + The value to add. + A new list with the element added, or this list if the element is already in the list. + + + Adds the specified values to this immutable list. + The values to add. + A new list with the elements added, or this list if the elements are already in the list. + + + Retrieves an empty list that has the same sorting and ordering semantics as this instance. + An empty list that has the same sorting and ordering semantics as this instance. + + + Inserts the specified element at the specified index in the immutable list. + The index at which to insert the value. + The element to insert. + A new immutable list that includes the specified element. + + + Inserts the specified elements at the specified index in the immutable list. + The index at which to insert the elements. + The elements to insert. + A new immutable list that includes the specified elements. + + + Removes the element with the specified value from the list. + The value of the element to remove from the list. + The comparer to use to compare elements for equality. + Returns a new with the specified element removed. + + + Removes all the elements that match the conditions defined by the specified predicate. + The delegate that defines the conditions of the elements to remove. + A new immutable list with the elements removed. + + + Removes the element at the specified index of the immutable list. + The index of the element to remove. + A new list with the element removed. + + + Removes a range of elements from this immutable list that match the items specified. + The range of items to remove from the list, if found. + The equality comparer to use to compare elements. + An immutable list with the items removed. + items or equalityComparer is null. + + + Removes the specified number of elements at the specified location from this list. + The starting index of the range of elements to remove. + The number of elements to remove. + A new list with the elements removed. + + + Replaces an element in the list with the specified element. + The element to replace. + The element to replace the old element with. + The equality comparer to use in the search. + The new list. + Thrown when the old value does not exist in the list. + + + Replaces an element in the list at a given position with the specified element. + The position in the list of the element to replace. + The element to replace the old element with. + The new list. + + + Provides a set of initialization methods for instances of the class. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + Creates an empty immutable list. + The type of items to be stored in the . + An empty . + + + Creates a new immutable list that contains the specified item. + The item to prepopulate the list with. + The type of items in the . + A new that contains the specified item. + + + Creates a new immutable list that contains the specified array of items. + An array that contains the items to prepopulate the list with. + The type of items in the . + A new immutable list that contains the specified items. + + + Creates a new immutable list builder. + The type of items stored by the collection. + The immutable collection builder. + + + Creates a new immutable list that contains the specified items. + The items to add to the list. + The type of items in the . + Returns an immutable list that contains the specified items. + + + Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the immutable list that extends from the specified index to the last element. + The list to search. + The object to locate in the Immutable list. The value can be null for reference types. + The zero-based starting index of the search. 0 (zero) is valid in an empty list. + The type of items in the list. + The zero-based index of the first occurrence of item within the range of elements in the Immutable list that extends from index to the last element, if found; otherwise, –1. + + + Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the immutable list that extends from the specified index to the last element. + The list to search. + The object to locate in the Immutable list. The value can be null for reference types. + The zero-based starting index of the search. 0 (zero) is valid in an empty list. + The number of elements in the section to search. + The type of items in the list. + The zero-based index of the first occurrence of item within the range of elements in the Immutable list that extends from index to the last element, if found; otherwise, –1. + + + Searches for the specified object and returns the zero-based index of the first occurrence within the list. + The list to search. + The object to locate in the list. The value can be null for reference types. + The type of items in the list. + The zero-based index of the first occurrence of item within the range of elements in the list that extends from index to the last element, if found; otherwise, –1. + + + Searches for the specified object and returns the zero-based index of the first occurrence within the list. + The list to search. + The object to locate in the Immutable list. The value can be null for reference types. + The equality comparer to use in the search. + The type of items in the list. + The zero-based index of the first occurrence of item within the range of elements in the immutable list that extends from index to the last element, if found; otherwise, –1. + + + Searches for the specified object and returns the zero-based index of the last occurrence within the entire immutable list. + The list to search. + The object to locate in the Immutable list. The value can be null for reference types. + The type of items in the list. + The zero-based index of the last occurrence of item within the entire the Immutable list, if found; otherwise, –1. + + + Searches for the specified object and returns the zero-based index of the last occurrence within the entire immutable list. + The list to search. + The object to locate in the Immutable list. The value can be null for reference types. + The equality comparer to use in the search. + The type of items in the list. + The zero-based index of the last occurrence of item within the entire the Immutable list, if found; otherwise, –1. + + + Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the immutable list that extends from the first element to the specified index. + The list to search. + The object to locate in the Immutable list. The value can be null for reference types. + The zero-based starting index of the backward search. + The type of items in the list. + The zero-based index of the last occurrence of item within the range of elements in the Immutable list that extends from the first element to index, if found; otherwise, –1. + + + Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the immutable list that extends from the first element to the specified index. + The list to search. + The object to locate in the Immutable list. The value can be null for reference types. + The zero-based starting index of the backward search. + The number of elements in the section to search. + The type of items in the list. + The zero-based index of the last occurrence of item within the range of elements in the Immutable list that extends from the first element to index, if found; otherwise, –1. + + + Removes the specified value from this list. + The list to search. + The value to remove. + The type of items in the list. + A new immutable list with the element removed, or this list if the element is not in this list. + + + Removes the specified values from this list. + The list to search. + The items to remove if matches are found in this list. + The type of items in the list. + A new immutable list with the elements removed. + + + Replaces the first equal element in the list with the specified element. + The list to search. + The element to replace. + The element to replace the old element with. + The type of items in the list. + The new list -- even if the value being replaced is equal to the new value for that position. + Thrown when the old value does not exist in the list. + + + Enumerates a sequence and produces an immutable list of its contents. + The sequence to enumerate. + The type of the elements in the sequence. + An immutable list that contains the items in the specified sequence. + + + Enumerates the contents of an immutable queue without allocating any memory. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + + Gets the element at the current position of the enumerator. + The element at the current position of the enumerator. + + + Advances the enumerator to the next element of the immutable queue. + true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the queue. + + + Represents an immutable queue. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + The type of elements in the queue. + + + Removes all objects from the immutable queue. + The empty immutable queue. + + + Removes the element at the beginning of the immutable queue, and returns the new queue. + The new immutable queue; never null. + + + Removes the item at the beginning of the immutable queue, and returns the new queue. + When this method returns, contains the element from the beginning of the queue. + The new immutable queue with the beginning element removed. + + + Gets an empty immutable queue. + An empty immutable queue. + + + Adds an element to the end of the immutable queue, and returns the new queue. + The element to add. + The new immutable queue. + + + Returns an enumerator that iterates through the immutable queue. + An enumerator that can be used to iterate through the queue. + + + Gets a value that indicates whether this immutable queue is empty. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + true if this queue is empty; otherwise, false. + + + Returns the element at the beginning of the immutable queue without removing it. + The element at the beginning of the queue. + + + Returns an enumerator that iterates through the collection. + An enumerator that can be used to iterate through the collection. + + + Returns an enumerator that iterates through a collection. + An object that can be used to iterate through the collection. + + + Removes all elements from the immutable queue. + The empty immutable queue. + + + Removes the element at the beginning of the immutable queue, and returns the new queue. + The new immutable queue; never null. + + + Adds an element to the end of the immutable queue, and returns the new queue. + The element to add. + The new immutable queue. + + + Provides a set of initialization methods for instances of the class. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + Creates an empty immutable queue. + The type of items to be stored in the immutable queue. + An empty immutable queue. + + + Creates a new immutable queue that contains the specified item. + The item to prepopulate the queue with. + The type of items in the immutable queue. + A new immutable queue that contains the specified item. + + + Creates a new immutable queue that contains the specified array of items. + An array that contains the items to prepopulate the queue with. + The type of items in the immutable queue. + A new immutable queue that contains the specified items. + + + Creates a new immutable queue that contains the specified items. + The items to add to the queue before immutability is applied. + The type of elements in the queue. + An immutable queue that contains the specified items. + + + Removes the item at the beginning of the immutable queue, and returns the new queue. + The queue to remove the item from. + When this method returns, contains the item from the beginning of the queue. + The type of elements in the immutable queue. + The new queue with the item removed. + + + Represents a sorted dictionary that mutates with little or no memory allocations and that can produce or build on immutable sorted dictionary instances very efficiently. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + + + Adds the specified item to the immutable sorted dictionary. + The object to add to the dictionary. + + + Adds an element that has the specified key and value to the immutable sorted dictionary. + The key of the element to add. + The value of the element to add. + + + Adds a sequence of values to the immutable sorted dictionary. + The items to add to the dictionary. + + + Removes all items from the immutable sorted dictionary. + + + Determines whether the immutable sorted dictionary contains a specific value. + The object to locate in the dictionary. + true if item is found in the dictionary; otherwise, false. + + + Determines whether the immutable sorted dictionary contains an element with the specified key. + The key to locate in the dictionary. + true if the dictionary contains an element with the key; otherwise, false. + + + Determines whether the immutable sorted dictionary contains an element with the specified value. + The value to locate in the dictionary. The value can be null for reference types. + true if the immutable sorted dictionary contains an element with the specified value; otherwise, false. + + + Gets the number of elements in this immutable sorted dictionary. + The number of elements in this dictionary. + + + Returns an enumerator that iterates through the immutable sorted dictionary. + An enumerator that can be used to iterate through the dictionary. + + + Gets the value for a given key if a matching key exists in the dictionary; otherwise the default value. + The key to search for. + The default value to return if no matching key is found in the dictionary. + The value for the key, or defaultValue if no matching key was found. + + + Gets the value for a given key if a matching key exists in the dictionary; otherwise the default value. + The key to search for. + The value for the key, or default(TValue) if no matching key was found. + + + Gets or sets the value for a specified key in the immutable sorted dictionary. + The key to retrieve the value for. + The value associated with the given key. + + + Gets or sets the key comparer. + The key comparer. + + + Gets a strongly typed, read-only collection of elements. + A strongly typed, read-only collection of elements. + + + Removes the first occurrence of a specific object from the immutable sorted dictionary. + The object to remove from the dictionary. + true if item was successfully removed from the dictionary; otherwise, false. This method also returns false if item is not found in the dictionary. + + + Removes the element with the specified key from the immutable sorted dictionary. + The key of the element to remove. + true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original dictionary. + + + Removes any entries with keys that match those found in the specified sequence from the immutable sorted dictionary. + The keys for entries to remove from the dictionary. + + + Creates an immutable sorted dictionary based on the contents of this instance. + An immutable sorted dictionary. + + + Determines whether this dictionary contains a specified key. + The key to search for. + The matching key located in the dictionary if found, or equalkey if no match is found. + true if a match for equalKey is found; otherwise, false. + + + Gets the value associated with the specified key. + The key whose value will be retrieved. + When this method returns, contains the value associated with the specified key, if the key is found; otherwise, contains the default value for the type of the value parameter. This parameter is passed uninitialized. + true if the object that implements the dictionary contains an element with the specified key; otherwise, false. + + + Gets or sets the value comparer. + The value comparer. + + + Gets a collection that contains the values of the immutable sorted dictionary. + A collection that contains the values of the object that implements the dictionary. + + + + + + + + + + + + + + + + + + + Copies the elements of the dictionary to an array, starting at a particular array index. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + The one-dimensional array that is the destination of the elements copied from the dictionary. The array must have zero-based indexing. + The zero-based index in array at which copying begins. + + + Gets a value indicating whether access to the is synchronized (thread safe). + true if access to the is synchronized (thread safe); otherwise, false. + + + Gets an object that can be used to synchronize access to the . + An object that can be used to synchronize access to the . + + + Adds an element with the provided key and value to the dictionary object. + The key of the element to add. + The value of the element to add. + + + Determines whether the dictionary object contains an element with the specified key. + The key to locate. + true if the dictionary contains an element with the key; otherwise, false. + + + Returns an object for the dictionary. + An object for the dictionary. + + + Gets a value indicating whether the object has a fixed size. + true if the object has a fixed size; otherwise, false. + + + Gets a value indicating whether the is read-only. + true if the is read-only; otherwise, false. + + + Gets or sets the element with the specified key. + The key. + + + + Gets an containing the keys of the . + An containing the keys of the object that implements . + + + Removes the element with the specified key from the dictionary. + The key of the element to remove. + + + Gets an containing the values in the . + An containing the values in the object that implements . + + + Returns an enumerator that iterates through a collection. + An enumerator object that can be used to iterate through the collection. + + + Enumerates the contents of a binary tree. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + + + Gets the element at the current position of the enumerator. + The element at the current position of the enumerator. + + + Releases the resources used by the current instance of the class. + + + Advances the enumerator to the next element of the immutable sorted dictionary. + true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the sorted dictionary. + + + Sets the enumerator to its initial position, which is before the first element in the immutable sorted dictionary. + + + The current element. + + + + Represents an immutable sorted dictionary. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + The type of the key contained in the dictionary. + The type of the value contained in the dictionary. + + + Adds an element with the specified key and value to the immutable sorted dictionary. + The key of the entry to add. + The value of entry to add. + A new immutable sorted dictionary that contains the additional key/value pair. + The given key already exists in the dictionary but has a different value. + + + Adds the specific key/value pairs to the immutable sorted dictionary. + The key/value pairs to add. + A new immutable dictionary that contains the additional key/value pairs. + One of the given keys already exists in the dictionary but has a different value. + + + Retrieves an empty immutable sorted dictionary that has the same ordering and key/value comparison rules as this dictionary instance. + An empty dictionary with equivalent ordering and key/value comparison rules. + + + Determines whether this immutable sorted dictionary contains the specified key/value pair. + The key/value pair to locate. + true if the specified key/value pair is found in the dictionary; otherwise, false. + + + Determines whether this immutable sorted map contains the specified key. + The key to locate. + true if the immutable dictionary contains the specified key; otherwise, false. + + + Determines whether the immutable sorted dictionary contains an element with the specified value. + The value to locate. The value can be null for reference types. + true if the dictionary contains an element with the specified value; otherwise, false. + + + Gets the number of key/value pairs in the immutable sorted dictionary. + The number of key/value pairs in the dictionary. + + + Gets an empty immutable sorted dictionary. + + + + Returns an enumerator that iterates through the immutable sorted dictionary. + An enumerator that can be used to iterate through the dictionary. + + + Gets a value that indicates whether this instance of the immutable sorted dictionary is empty. + true if this instance is empty; otherwise, false. + + + Gets the TValue associated with the specified key. + The key to retrieve the value for. + The value associated with the specified key. If no results are found, the operation throws an exception. + + + Gets the key comparer for the immutable sorted dictionary. + The key comparer for the dictionary. + + + Gets the keys in the immutable sorted dictionary. + The keys in the immutable dictionary. + + + Removes the element with the specified value from the immutable sorted dictionary. + The value of the element to remove. + A new immutable dictionary with the specified element removed; or this instance if the specified value cannot be found in the dictionary. + + + Removes the elements with the specified keys from the immutable sorted dictionary. + The keys of the elements to remove. + A new immutable dictionary with the specified keys removed; or this instance if the specified keys cannot be found in the dictionary. + + + Sets the specified key and value in the immutable sorted dictionary, possibly overwriting an existing value for the given key. + The key of the entry to add. + The key value to set. + A new immutable sorted dictionary that contains the specified key/value pair. + + + Sets the specified key/value pairs in the immutable sorted dictionary, possibly overwriting existing values for the keys. + The key/value pairs to set in the dictionary. If any of the keys already exist in the dictionary, this method will overwrite their previous values. + An immutable dictionary that contains the specified key/value pairs. + + + Creates an immutable sorted dictionary with the same contents as this dictionary that can be efficiently mutated across multiple operations by using standard mutable interfaces. + A collection with the same contents as this dictionary. + + + Determines whether this dictionary contains a specified key. + The key to search for. + The matching key located in the dictionary if found, or equalkey if no match is found. + true if a match for equalKey is found; otherwise, false. + + + Gets the value associated with the specified key. + The key whose value will be retrieved. + When this method returns, contains the value associated with the specified key, if the key is found; otherwise, contains the default value for the type of the value parameter. + true if the dictionary contains an element with the specified key; otherwise, false. + + + Gets the value comparer used to determine whether values are equal. + The value comparer used to determine whether values are equal. + + + Gets the values in the immutable sorted dictionary. + The values in the dictionary. + + + Gets an instance of the immutable sorted dictionary that uses the specified key comparer. + The key comparer to use. + An instance of the immutable dictionary that uses the given comparer. + + + Gets an instance of the immutable sorted dictionary that uses the specified key and value comparers. + The key comparer to use. + The value comparer to use. + An instance of the immutable dictionary that uses the given comparers. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Copies the elements of the dictionary to an array, starting at a particular array index. + The one-dimensional array that is the destination of the elements copied from the dictionary. The array must have zero-based indexing. + The zero-based index in array at which copying begins. + + + Gets a value indicating whether access to the is synchronized (thread safe). + true if access to the is synchronized (thread safe); otherwise, false. + + + Gets an object that can be used to synchronize access to the . + An object that can be used to synchronize access to the . + + + Adds an element with the provided key and value to the dictionary object. + The object to use as the key of the element to add. + The object to use as the value of the element to add. + + + Clears this instance. + The dictionary object is read-only. + + + Determines whether the immutable dictionary object contains an element with the specified key. + The key to locate in the dictionary object. + true if the dictionary contains an element with the key; otherwise, false. + + + Returns an object for the immutable dictionary object. + An enumerator object for the dictionary object. + + + Gets a value indicating whether the object has a fixed size. + true if the object has a fixed size; otherwise, false. + + + Gets a value indicating whether the is read-only. + true if the is read-only; otherwise, false. + + + Gets or sets the element with the specified key. + The key. + + + + Gets an containing the keys of the . + An containing the keys of the object that implements . + + + Removes the element with the specified key from the immutable dictionary object. + The key of the element to remove. + + + Gets an containing the values in the . + An containing the values in the object that implements . + + + Returns an enumerator that iterates through a collection. + An enumerator object that can be used to iterate through the collection. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Provides a set of initialization methods for instances of the class. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + Creates an empty immutable sorted dictionary. + The type of keys stored by the dictionary. + The type of values stored by the dictionary. + An empty immutable sorted dictionary. + + + Creates an empty immutable sorted dictionary that uses the specified key comparer. + The implementation to use to determine the equality of keys in the dictionary. + The type of keys stored by the dictionary. + The type of values stored by the dictionary. + An empty immutable sorted dictionary. + + + Creates an empty immutable sorted dictionary that uses the specified key and value comparers. + The implementation to use to determine the equality of keys in the dictionary. + The implementation to use to determine the equality of values in the dictonary. + The type of keys stored by the dictionary. + The type of values stored by the dictionary. + An empty immutable sorted dictionary. + + + Creates a new immutable sorted dictionary builder. + The type of keys stored by the dictionary. + The type of values stored by the dictionary. + The immutable collection builder. + + + Creates a new immutable sorted dictionary builder. + The key comparer. + The type of keys stored by the dictionary. + The type of values stored by the dictionary. + The immutable collection builder. + + + Creates a new immutable sorted dictionary builder. + The key comparer. + The value comparer. + The type of keys stored by the dictionary. + The type of values stored by the dictionary. + The immutable collection builder. + + + Creates an immutable sorted dictionary that contains the specified items and uses the default comparer. + The items to add to the sorted dictionary before it’s immutable. + The type of keys stored in the dictionary. + The type of values stored in the dictionary. + An immutable sorted dictionary that contains the specified items. + + + Creates a new immutable sorted dictionary from the specified range of items with the specified key comparer. + The comparer implementation to use to evaluate keys for equality and sorting. + The items to add to the sorted dictionary. + The type of keys stored in the dictionary. + The type of values stored in the dictionary. + The new immutable sorted dictionary that contains the specified items and uses the specified key comparer. + + + Creates a new immutable sorted dictionary from the specified range of items with the specified key and value comparers. + The comparer implementation to use to compare keys for equality and sorting. + The comparer implementation to use to compare values for equality and sorting. + The items to add to the sorted dictionary before it’s immutable. + The type of keys stored in the dictionary. + The type of values stored in the dictionary. + An immutable sorted dictionary that contains the specified items and uses the specified comparers. + + + Enumerates a sequence of key/value pairs and produces an immutable sorted dictionary of its contents. + The sequence of key/value pairs to enumerate. + The type of the keys in the dictionary. + The type of the values in the dictionary. + An immutable sorted dictionary that contains the key/value pairs in the specified sequence. + + + Enumerates a sequence of key/value pairs and produces an immutable dictionary of its contents by using the specified key comparer. + The sequence of key/value pairs to enumerate. + The key comparer to use when building the immutable dictionary. + The type of the keys in the dictionary. + The type of the values in the dictionary. + An immutable sorted dictionary that contains the key/value pairs in the specified sequence. + + + Enumerates a sequence of key/value pairs and produces an immutable sorted dictionary of its contents by using the specified key and value comparers. + The sequence of key/value pairs to enumerate. + The key comparer to use when building the immutable dictionary. + The value comparer to use for the immutable dictionary. + The type of the keys in the dictionary. + The type of the values in the dictionary. + An immutable sorted dictionary that contains the key/value pairs in the specified sequence. + + + Enumerates and transforms a sequence, and produces an immutable sorted dictionary of its contents. + The sequence to enumerate to generate the dictionary. + The function that will produce the key for the dictionary from each sequence element. + The function that will produce the value for the dictionary from each sequence element. + The type of the elements in the sequence. + The type of the keys in the resulting dictionary. + The type of the values in the resulting dictionary. + An immutable sorted dictionary that contains the items in the specified sequence. + + + Enumerates and transforms a sequence, and produces an immutable sorted dictionary of its contents by using the specified key comparer. + The sequence to enumerate to generate the dictionary. + The function that will produce the key for the dictionary from each sequence element. + The function that will produce the value for the dictionary from each sequence element. + The key comparer to use for the dictionary. + The type of the elements in the sequence. + The type of the keys in the resulting dictionary. + The type of the values in the resulting dictionary. + An immutable dictionary that contains the items in the specified sequence. + + + Enumerates and transforms a sequence, and produces an immutable sorted dictionary of its contents by using the specified key and value comparers. + The sequence to enumerate to generate the dictionary. + The function that will produce the key for the dictionary from each sequence element. + The function that will produce the value for the dictionary from each sequence element. + The key comparer to use for the dictionary. + The value comparer to use for the dictionary. + The type of the elements in the sequence. + The type of the keys in the resulting dictionary. + The type of the values in the resulting dictionary. + An immutable sorted dictionary that contains the items in the specified sequence. + + + Represents a sorted set that enables changes with little or no memory allocations, and efficiently manipulates or builds immutable sorted sets. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + + Adds an element to the current set and returns a value to indicate whether the element was successfully added. + The element to add to the set. + true if the element is added to the set; false if the element is already in the set + + + Removes all elements from this set. + + + Determines whether the set contains the specified object. + The object to locate in the set. + true if item is found in the set; otherwise, false. + + + Gets the number of elements in the immutable sorted set. + The number of elements in this set. + + + Removes the specified set of items from the current set. + The collection of items to remove from the set. + + + Returns an enumerator that iterates through the set. + A enumerator that can be used to iterate through the set. + + + Modifies the current set so that it contains only elements that are also in a specified collection. + The collection to compare to the current set. + + + Determines whether the current set is a proper (strict) subset of a specified collection. + The collection to compare to the current set. + true if the current set is a proper subset of other; otherwise, false. + + + Determines whether the current set is a proper (strict) superset of a specified collection. + The collection to compare to the current set. + true if the current set is a proper superset of other; otherwise, false. + + + Determines whether the current set is a subset of a specified collection. + The collection is compare to the current set. + true if the current set is a subset of other; otherwise, false. + + + Determines whether the current set is a superset of a specified collection. + The collection to compare to the current set. + true if the current set is a superset of other; otherwise, false. + + + Gets the element of the set at the given index. + The 0-based index of the element in the set to return. + The element at the given position. + + + Gets or sets the object that is used to determine equality for the values in the immutable sorted set. + The comparer that is used to determine equality for the values in the set. + + + Gets the maximum value in the immutable sorted set, as defined by the comparer. + The maximum value in the set. + + + Gets the minimum value in the immutable sorted set, as defined by the comparer. + The minimum value in the set. + + + Determines whether the current set overlaps with the specified collection. + The collection to compare to the current set. + true if the current set and other share at least one common element; otherwise, false. + + + Removes the first occurrence of the specified object from the set. + The object to remove from the set. + true if item was removed from the set; false if item was not found in the set. + + + Returns an enumerator that iterates over the immutable sorted set in reverse order. + An enumerator that iterates over the set in reverse order. + + + Determines whether the current set and the specified collection contain the same elements. + The collection to compare to the current set. + true if the current set is equal to other; otherwise, false. + + + Modifies the current set so that it contains only elements that are present either in the current set or in the specified collection, but not both. + The collection to compare to the current set. + + + Creates an immutable sorted set based on the contents of this instance. + An immutable set. + + + Modifies the current set so that it contains all elements that are present in both the current set and in the specified collection. + The collection to compare to the current state. + + + Adds an element to the current set and returns a value to indicate whether the element was successfully added. + The element to add to the set. + + + Copies the elements of the collection to an array, starting at a particular array index. + The one-dimensional array that is the destination of the elements copied from collection. The array must have zero-based indexing. + The zero-based index in array at which copying begins. + + + Gets a value indicating whether this instance is read-only. + Always false. + + + Returns an enumerator that iterates through the collection. + A enumerator that can be used to iterate through the collection. + + + Copies the elements of the set to an array, starting at a particular array index. + The one-dimensional array that is the destination of the elements copied from the set. The array must have zero-based indexing. + The zero-based index in array at which copying begins. + + + Gets a value indicating whether access to the is synchronized (thread safe). + true if access to the is synchronized (thread safe); otherwise, false. + + + Gets an object that can be used to synchronize access to the . + An object that can be used to synchronize access to the . + + + Returns an enumerator that iterates through the collection. + A enumerator that can be used to iterate through the collection. + + + Enumerates the contents of a binary tree. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + + Gets the element at the current position of the enumerator. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + The element at the current position of the enumerator. + + + Releases the resources used by the current instance of the class. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + Advances the enumerator to the next element of the immutable sorted set. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the sorted set. + + + Sets the enumerator to its initial position, which is before the first element in the immutable sorted set. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + The current element. + + + + Represents an immutable sorted set implementation. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + The type of elements in the set. + + + Adds the specified value to this immutable sorted set. + The value to add. + A new set with the element added, or this set if the element is already in this set. + + + Removes all elements from the immutable sorted set. + An empty set with the elements removed. + + + Determines whether this immutable sorted set contains the specified value. + The value to check for. + true if the set contains the specified value; otherwise, false. + + + Gets the number of elements in the immutable sorted set. + The number of elements in the immutable sorted set. + + + Gets an empty immutable sorted set. + + + + Removes a specified set of items from this immutable sorted set. + The items to remove from this set. + A new set with the items removed; or the original set if none of the items were in the set. + + + Returns an enumerator that iterates through the immutable sorted set. + An enumerator that can be used to iterate through the set. + + + Gets the position within this immutable sorted set that the specified value appears in. + The value whose position is being sought. + The index of the specified item in the sorted set, if item is found. If item is not found and is less than one or more elements in this set, this method returns a negative number that is the bitwise complement of the index of the first element that is larger than value. If item is not found and is greater than any of the elements in the set, this method returns a negative number that is the bitwise complement of the index of the last element plus 1. + + + Creates an immutable sorted set that contains elements that exist both in this set and in the specified set. + The set to intersect with this one. + A new immutable sorted set that contains any elements that exist in both sets. + + + Gets a value that indicates whether this immutable sorted set is empty. + true if this set is empty; otherwise, false. + + + Determines whether the current immutable sorted set is a proper (strict) subset of the specified collection. + The collection to compare to the current set. + true if the current set is a proper subset of other; otherwise, false. + + + Determines whether the current immutable sorted set is a proper superset of a specified collection. + The collection to compare to the current set. + true if the current set is a proper superset of other; otherwise, false. + + + Determines whether the current immutable sorted set is a subset of a specified collection. + The collection to compare to the current set. + true if the current set is a subset of other; otherwise, false. + + + Determines whether the current immutable sorted set is a superset of a specified collection. + The collection to compare to the current set. + true if the current set is a superset of other; otherwise, false. + + + Gets the element of the immutable sorted set at the given index. + The index of the element to retrieve from the sorted set. + The element at the given index. + + + Gets the comparer used to sort keys in the immutable sorted set. + The comparer used to sort keys. + + + Gets the maximum value in the immutable sorted set, as defined by the comparer. + The maximum value in the set. + + + Gets the minimum value in the immutable sorted set, as defined by the comparer. + The minimum value in the set. + + + Determines whether the current immutable sorted set and a specified collection share common elements. + The collection to compare to the current set. + true if the current set and other share at least one common element; otherwise, false. + + + Removes the specified value from this immutable sorted set. + The element to remove. + A new immutable sorted set with the element removed, or this set if the element was not found in the set. + + + Returns an that iterates over this immutable sorted set in reverse order. + An enumerator that iterates over the immutable sorted set in reverse order. + + + Determines whether the current immutable sorted set and the specified collection contain the same elements. + The collection to compare to the current set. + true if the sets are equal; otherwise, false. + + + Creates an immutable sorted set that contains elements that exist either in this set or in a given sequence, but not both. + The other sequence of items. + The new immutable sorted set. + + + Creates a collection that has the same contents as this immutable sorted set that can be efficiently manipulated by using standard mutable interfaces. + The sorted set builder. + + + Searches the set for a given value and returns the equal value it finds, if any. + The value to search for. + The value from the set that the search found, or the original value if the search yielded no match. + A value indicating whether the search was successful. + + + Adds a given set of items to this immutable sorted set. + The items to add. + The new set with the items added; or the original set if all the items were already in the set. + + + Returns the immutable sorted set that has the specified key comparer. + The comparer to check for. + The immutable sorted set that has the specified key comparer. + + + Adds the specified value to the collection. + The value to add. + + + Removes all the items from the collection. + + + Copies the elements of the collection to an array, starting at a particular array index. + The one-dimensional array that is the destination of the elements copied from collection. The array must have zero-based indexing. + The zero-based index in array at which copying begins. + + + See the interface. + + + + Removes the first occurrence of a specific object from the collection. + The object to remove from the collection. + true if item was successfully removed from the collection; otherwise, false. + + + Returns an enumerator that iterates through the collection. + An enumerator that can be used to iterate through the collection. + + + Inserts an item in the set at the specified index.. + The zero-based index at which item should be inserted. + The object to insert into the set. + + + See the interface. + + + + + Removes the item at the specified index. + The zero-based index of the item to remove. + + + Adds an element to the current set and returns a value to indicate if the element was successfully added. + The element to add to the set. + true if the element is added to the set; false if the element is already in the set. + + + Removes all elements in the specified collection from the current set. + The collection of items to remove from the set. + + + Modifies the current set so that it contains only elements that are also in a specified collection + The collection to compare to the current set. + + + Modifies the current set so that it contains only elements that are present either in the current set or in the specified collection, but not both. + The collection to compare to the current set. + + + Modifies the current set so that it contains all elements that are present in either the current set or the specified collection. + The collection to compare to the current set. + + + Copies the elements of the set to an array, starting at a particular array index. + The one-dimensional array that is the destination of the elements copied from the set. The array must have zero-based indexing. + The zero-based index in array at which copying begins. + + + See the interface. + + + + See . + + + + Returns an enumerator that iterates through a collection. + An enumerator object that can be used to iterate through the collection. + + + Adds an item to the set. + The object to add to the set. + The position into which the new element was inserted, or -1 to indicate that the item was not inserted into the collection. + The set is read-only or has a fixed size. + + + Removes all items from the set. + + + Determines whether the set contains a specific value. + The object to locate in the set. + true if the object is found in the set; otherwise, false. + + + Determines the index of a specific item in the set. + The object to locate in the set. + The index of value if found in the list; otherwise, -1. + + + Inserts an item into the set at the specified index. + The zero-based index at which value should be inserted. + The object to insert into the set. + The set is read-only or has a fixed size. + + + Gets a value indicating whether the has a fixed size. + true if the has a fixed size; otherwise, false. + + + Gets a value indicating whether the is read-only. + true if the is read-only; otherwise, false. + + + Gets or sets the at the specified index. + The index. + The . + + + + Removes the first occurrence of a specific object from the set. + The object to remove from the set. + The set is read-only or has a fixed size. + + + Removes the item at the specified index of the set. + The zero-based index of the item to remove. + The set is read-only or has a fixed size. + + + Adds the specified element to this immutable set. + The element to add. + A new set with the element added, or this set if the element is already in the set. + + + Retrieves an empty immutable set that has the same sorting and ordering semantics as this instance. + An empty set that has the same sorting and ordering semantics as this instance. + + + Removes the elements in the specified collection from the current immutable set. + The items to remove from this set. + The new set with the items removed; or the original set if none of the items were in the set. + + + Creates an immutable set that contains elements that exist in both this set and the specified set. + The collection to compare to the current set. + A new immutable set that contains any elements that exist in both sets. + + + Removes the specified element from this immutable set. + The element to remove. + A new set with the specified element removed, or the current set if the element cannot be found in the set. + + + Creates an immutable set that contains only elements that are present either in the current set or in the specified collection, but not both. + The collection to compare to the current set. + A new set that contains the elements that are present only in the current set or in the specified collection, but not both. + + + Creates a new immutable set that contains all elements that are present in either the current set or in the specified collection. + The collection to add elements from. + A new immutable set with the items added; or the original set if all the items were already in the set. + + + Provides a set of initialization methods for instances of the class. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + Creates an empty immutable sorted set. + The type of items to be stored in the immutable set. + An empty immutable sorted set. + + + Creates an empty immutable sorted set that uses the specified comparer. + The implementation to use when comparing items in the set. + The type of items in the immutable set. + An empty immutable set. + + + Creates a new immutable sorted set that contains the specified item. + The item to prepopulate the set with. + The type of items in the immutable set. + A new immutable set that contains the specified item. + + + Creates a new immutable sorted set that contains the specified array of items. + An array that contains the items to prepopulate the set with. + The type of items in the immutable set. + A new immutable set that contains the specified items. + + + Creates a new immutable sorted set that contains the specified item and uses the specified comparer. + The implementation to use when comparing items in the set. + The item to prepopulate the set with. + The type of items stored in the immutable set. + A new immutable set that contains the specified item. + + + Creates a new immutable sorted set that contains the specified array of items and uses the specified comparer. + The implementation to use when comparing items in the set. + An array that contains the items to prepopulate the set with. + The type of items in the immutable set. + A new immutable set that contains the specified items. + + + Returns a collection that can be used to build an immutable sorted set. + The type of items stored by the collection. + The immutable collection builder. + + + Returns a collection that can be used to build an immutable sorted set. + The comparer used to compare items in the set for equality. + The type of items stored by the collection. + The immutable collection. + + + Creates a new immutable collection that contains the specified items. + The items to add to the set with before it’s immutable. + The type of items stored by the collection. + The new immutable set that contains the specified items. + + + Creates a new immutable collection that contains the specified items. + The comparer to use to compare elements in this set. + The items to add to the set before it’s immutable. + The type of items stored by the collection. + The new immutable set that contains the specified items. + + + Enumerates a sequence and produces an immutable sorted set of its contents. + The sequence to enumerate. + The type of the elements in the sequence. + An immutable sorted set that contains the items in the specified sequence. + + + Enumerates a sequence, produces an immutable sorted set of its contents, and uses the specified comparer. + The sequence to enumerate. + The comparer to use for initializing and adding members to the sorted set. + The type of the elements in the sequence. + An immutable sorted set that contains the items in the specified sequence. + + + Enumerates the contents of an immutable stack without allocating any memory. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + + Gets the element at the current position of the enumerator. + The element at the current position of the enumerator. + + + Advances the enumerator to the next element of the immutable stack. + true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the stack. + + + Represents an immutable stack. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + The type of element on the stack. + + + Removes all objects from the immutable stack. + An empty immutable stack. + + + Gets an empty immutable stack. + An empty immutable stack. + + + Returns an enumerator that iterates through the immutable stack. + An enumerator that can be used to iterate through the stack. + + + Gets a value that indicates whether this instance of the immutable stack is empty. + true if this instance is empty; otherwise, false. + + + Returns the object at the top of the stack without removing it. + The object at the top of the stack. + + + Removes the element at the top of the immutable stack and returns the stack after the removal. + A stack; never null. + + + Removes the specified element from the immutable stack and returns the stack after the removal. + The value to remove from the stack. + A stack; never null. + + + Inserts an object at the top of the immutable stack and returns the new stack. + The object to push onto the stack. + The new stack. + + + Returns an enumerator that iterates through the collection. + An enumerator that can be used to iterate through the collection. + + + Returns an enumerator that iterates through a collection. + An object that can be used to iterate through the collection. + + + Removes all elements from the immutable stack. + The empty immutable stack. + + + Removes the element at the top of the immutable stack and returns the new stack. + The new stack; never null. + + + Inserts an element at the top of the immutable stack and returns the new stack. + The element to push onto the stack. + The new stack. + + + Provides a set of initialization methods for instances of the class. + NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + Creates an empty immutable stack. + The type of items to be stored in the immutable stack. + An empty immutable stack. + + + Creates a new immutable stack that contains the specified item. + The item to prepopulate the stack with. + The type of items in the immutable stack. + A new immutable collection that contains the specified item. + + + Creates a new immutable stack that contains the specified array of items. + An array that contains the items to prepopulate the stack with. + The type of items in the immutable stack. + A new immutable stack that contains the specified items. + + + Creates a new immutable stack that contains the specified items. + The items to add to the stack before it’s immutable. + The type of items in the stack. + An immutable stack that contains the specified items. + + + Removes the specified item from an immutable stack. + The stack to modify. + The item to remove from the stack. + The type of items contained in the stack. + A stack; never null. + + + LINQ extension method overrides that offer greater efficiency for than the standard LINQ methods +NuGet package: System.Collections.Immutable (about immutable collections and how to install) + + + Applies a function to a sequence of elements in a cumulative way. + The collection to apply the function to. + A function to be invoked on each element, in a cumulative way. + The type of element contained by the collection. + The final value after the cumulative function has been applied to all elements. + + + Applies a function to a sequence of elements in a cumulative way. + The collection to apply the function to. + The initial accumulator value. + A function to be invoked on each element, in a cumulative way. + The type of the accumulated value. + The type of element contained by the collection. + The final accumulator value. + + + Applies a function to a sequence of elements in a cumulative way. + The collection to apply the function to. + The initial accumulator value. + A function to be invoked on each element, in a cumulative way. + + The type of the accumulated value. + The type of result returned by the result selector. + The type of element contained by the collection. + The final accumulator value. + + + Gets a value indicating whether all elements in this array match a given condition. + The array to check for matches. + The predicate. + The type of element contained by the collection. + true if every element of the source sequence passes the test in the specified predicate; otherwise, false. + + + Gets a value indicating whether the array contains any elements. + The array to check for elements. + The type of element contained by the collection. + true if the array contains an elements; otherwise, false. + + + Returns a value indicating whether this collection contains any elements. + The builder to check for matches. + The type of elements in the array. + true if the array builder contains any elements; otherwise, false. + + + Gets a value indicating whether the array contains any elements that match a specified condition. + The array to check for elements. + The delegate that defines the condition to match to an element. + The type of element contained by the collection. + true if an element matches the specified condition; otherwise, false. + + + Returns the element at a specified index in the array. + The array to find an element in. + The index for the element to retrieve. + The type of element contained by the collection. + The item at the specified index. + + + Returns the element at a specified index in a sequence or a default value if the index is out of range. + The array to find an element in. + The index for the element to retrieve. + The type of element contained by the collection. + The item at the specified index, or the default value if the index is not found. + + + Returns the first element in an array. + The array to get an item from. + The type of element contained by the collection. + The first item in the array. + If the array is empty. + + + Returns the first element in the collection. + The builder to retrieve an item from. + The type of items in the array. + The first item in the list. + If the array is empty. + + + Returns the first element in a sequence that satisfies a specified condition. + The array to get an item from. + The delegate that defines the conditions of the element to search for. + The type of element contained by the collection. + The first item in the list if it meets the condition specified by predicate. + If the array is empty. + + + Returns the first element of a sequence, or a default value if the sequence contains no elements. + The array to retrieve items from. + The type of element contained by the collection. + The first item in the list, if found; otherwise the default value for the item type. + + + Returns the first element in the collection, or the default value if the collection is empty. + The builder to retrieve an element from. + The type of item in the builder. + The first item in the list, if found; otherwise the default value for the item type. + + + Returns the first element of the sequence that satisfies a condition or a default value if no such element is found. + The array to retrieve elments from. + The delegate that defines the conditions of the element to search for. + The type of element contained by the collection. + The first item in the list, if found; otherwise the default value for the item type. + + + Returns the last element in the collection. + The builder to retrieve elements from. + The type of item in the builder. + The last element in the builder. + Thrown if the collection is empty. + + + Returns the last element of a sequence that satisfies a specified condition. + The array to retrieve elements from. + The delegate that defines the conditions of the element to retrieve. + The type of element contained by the collection. + The last element of the array that satisfies the predicate condition. + Thrown if the collection is empty. + + + Returns the last element of the array. + The array to retrieve items from. + The type of element contained by the array. + The last element in the array. + Thrown if the collection is empty. + + + Returns the last element of a sequence, or a default value if the sequence contains no elements. + The array to retrieve items from. + The type of element contained by the collection. + The last element of a sequence, or a default value if the sequence contains no elements. + + + Returns the last element in the collection, or the default value if the collection is empty. + The builder to retrieve an element from. + The type of item in the builder. + The last element of a sequence, or a default value if the sequence contains no elements. + + + Returns the last element of a sequence that satisfies a condition or a default value if no such element is found. + The array to retrieve an element from. + The delegate that defines the conditions of the element to search for. + The type of element contained by the collection. + The last element of a sequence, or a default value if the sequence contains no elements. + + + Projects each element of a sequence into a new form. + The immutable array to select items from. + A transform function to apply to each element. + The type of element contained by the collection. + The type of the result element. + An whose elements are the result of invoking the transform function on each element of source. + + + Projects each element of a sequence to an , flattens the resulting sequences into one sequence, and invokes a result selector function on each element therein. + The immutable array. + A transform function to apply to each element of the input sequence. + A transform function to apply to each element of the intermediate sequence. + The type of the elements of immutableArray. + The type of the intermediate elements collected by collectionSelector. + The type of the elements of the resulting sequence. + An whose elements are the result of invoking the one-to-many transform function collectionSelector on each element of immutableArray and then mapping each of those sequence elements and their corresponding source element to a result element. + + + Determines whether two sequences are equal according to an equality comparer. + The array to use for comparison. + The items to use for comparison. + The comparer to use to check for equality. + The type of element in the compared array. + The type of element contained by the collection. + true to indicate the sequences are equal; otherwise, false. + + + Determines whether two sequences are equal according to an equality comparer. + The array to use for comparison. + The items to use for comparison. + The comparer to use to check for equality. + The type of element in the compared array. + The type of element contained by the collection. + true to indicate the sequences are equal; otherwise, false. + + + Determines whether two sequences are equal according to an equality comparer. + The array to use for comparison. + The items to use for comparison. + The comparer to use to check for equality. + The type of element in the compared array. + The type of element contained by the collection. + true to indicate the sequences are equal; otherwise, false. + + + Returns the only element of a sequence, and throws an exception if there is not exactly one element in the sequence. + The array to retrieve the element from. + The type of element contained by the collection. + The element in the sequence. + + + Returns the only element of a sequence that satisfies a specified condition, and throws an exception if more than one such element exists. + + + The type of element contained by the collection. + Returns . + + + Returns the only element of the array, or a default value if the sequence is empty; this method throws an exception if there is more than one element in the sequence. + + The type of element contained by the collection. + The element in the array, or the default value if the array is empty. + + + Returns the only element of a sequence that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition. + The array to get the element from. + The condition the element must satisfy. + The type of element contained by the collection. + The element if it satisfies the specified condition; otherwise the default element. + + + Copies the contents of this array to a mutable array. + + The type of element contained by the collection. + The newly instantiated array. + + + Creates a dictionary based on the contents of this array. + The array to create a dictionary from. + The key selector. + The type of the key. + The type of element contained by the collection. + The newly initialized dictionary. + + + Creates a dictionary based on the contents of this array. + The array to create a dictionary from. + The key selector. + The comparer to initialize the dictionary with. + The type of the key. + The type of element contained by the collection. + The newly initialized dictionary. + + + Creates a dictionary based on the contents of this array. + The array to create a dictionary from. + The key selector. + The element selector. + The comparer to initialize the dictionary with. + The type of the key. + The type of the element. + The type of element contained by the collection. + The newly initialized dictionary. + + + Creates a dictionary based on the contents of this array. + The array to create a dictionary from. + The key selector. + The element selector. + The type of the key. + The type of the element. + The type of element contained by the collection. + The newly initialized dictionary. + + + Filters a sequence of values based on a predicate. + The array to filter. + The condition to use for filtering the array content. + The type of element contained by the collection. + Returns that contains elements that meet the condition. + + + \ No newline at end of file diff --git a/packages/FAKE.5.16.0/tools/System.Collections.NonGeneric.dll b/packages/FAKE.5.16.0/tools/System.Collections.NonGeneric.dll new file mode 100644 index 0000000..9da235a Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Collections.NonGeneric.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Collections.Specialized.dll b/packages/FAKE.5.16.0/tools/System.Collections.Specialized.dll new file mode 100644 index 0000000..fbd4fc7 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Collections.Specialized.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Collections.dll b/packages/FAKE.5.16.0/tools/System.Collections.dll new file mode 100644 index 0000000..72ac205 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Collections.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.ComponentModel.EventBasedAsync.dll b/packages/FAKE.5.16.0/tools/System.ComponentModel.EventBasedAsync.dll new file mode 100644 index 0000000..37742d4 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.ComponentModel.EventBasedAsync.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.ComponentModel.Primitives.dll b/packages/FAKE.5.16.0/tools/System.ComponentModel.Primitives.dll new file mode 100644 index 0000000..b0c4b68 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.ComponentModel.Primitives.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.ComponentModel.TypeConverter.dll b/packages/FAKE.5.16.0/tools/System.ComponentModel.TypeConverter.dll new file mode 100644 index 0000000..fb42b44 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.ComponentModel.TypeConverter.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.ComponentModel.dll b/packages/FAKE.5.16.0/tools/System.ComponentModel.dll new file mode 100644 index 0000000..8e2d829 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.ComponentModel.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Console.dll b/packages/FAKE.5.16.0/tools/System.Console.dll new file mode 100644 index 0000000..fe61bcc Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Console.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Data.Common.dll b/packages/FAKE.5.16.0/tools/System.Data.Common.dll new file mode 100644 index 0000000..05e3481 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Data.Common.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Data.SqlServerCe.dll b/packages/FAKE.5.16.0/tools/System.Data.SqlServerCe.dll new file mode 100644 index 0000000..8d16c2a Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Data.SqlServerCe.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Diagnostics.Contracts.dll b/packages/FAKE.5.16.0/tools/System.Diagnostics.Contracts.dll new file mode 100644 index 0000000..98f40eb Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Diagnostics.Contracts.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Diagnostics.Debug.dll b/packages/FAKE.5.16.0/tools/System.Diagnostics.Debug.dll new file mode 100644 index 0000000..a51c0cf Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Diagnostics.Debug.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Diagnostics.FileVersionInfo.dll b/packages/FAKE.5.16.0/tools/System.Diagnostics.FileVersionInfo.dll new file mode 100644 index 0000000..3c203b0 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Diagnostics.FileVersionInfo.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Diagnostics.Process.dll b/packages/FAKE.5.16.0/tools/System.Diagnostics.Process.dll new file mode 100644 index 0000000..b537e62 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Diagnostics.Process.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Diagnostics.StackTrace.dll b/packages/FAKE.5.16.0/tools/System.Diagnostics.StackTrace.dll new file mode 100644 index 0000000..5dfaad6 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Diagnostics.StackTrace.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Diagnostics.TextWriterTraceListener.dll b/packages/FAKE.5.16.0/tools/System.Diagnostics.TextWriterTraceListener.dll new file mode 100644 index 0000000..a5720da Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Diagnostics.TextWriterTraceListener.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Diagnostics.Tools.dll b/packages/FAKE.5.16.0/tools/System.Diagnostics.Tools.dll new file mode 100644 index 0000000..bd9deae Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Diagnostics.Tools.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Diagnostics.TraceSource.dll b/packages/FAKE.5.16.0/tools/System.Diagnostics.TraceSource.dll new file mode 100644 index 0000000..5474eb2 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Diagnostics.TraceSource.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Diagnostics.Tracing.dll b/packages/FAKE.5.16.0/tools/System.Diagnostics.Tracing.dll new file mode 100644 index 0000000..5b8b2b4 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Diagnostics.Tracing.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Drawing.Primitives.dll b/packages/FAKE.5.16.0/tools/System.Drawing.Primitives.dll new file mode 100644 index 0000000..1eeacc4 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Drawing.Primitives.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Dynamic.Runtime.dll b/packages/FAKE.5.16.0/tools/System.Dynamic.Runtime.dll new file mode 100644 index 0000000..d34b388 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Dynamic.Runtime.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Globalization.Calendars.dll b/packages/FAKE.5.16.0/tools/System.Globalization.Calendars.dll new file mode 100644 index 0000000..4a198bc Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Globalization.Calendars.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Globalization.Extensions.dll b/packages/FAKE.5.16.0/tools/System.Globalization.Extensions.dll new file mode 100644 index 0000000..99f9e4a Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Globalization.Extensions.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Globalization.dll b/packages/FAKE.5.16.0/tools/System.Globalization.dll new file mode 100644 index 0000000..dd3d2e3 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Globalization.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.IO.Compression.ZipFile.dll b/packages/FAKE.5.16.0/tools/System.IO.Compression.ZipFile.dll new file mode 100644 index 0000000..345acbd Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.IO.Compression.ZipFile.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.IO.Compression.dll b/packages/FAKE.5.16.0/tools/System.IO.Compression.dll new file mode 100644 index 0000000..ebbb503 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.IO.Compression.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.IO.FileSystem.DriveInfo.dll b/packages/FAKE.5.16.0/tools/System.IO.FileSystem.DriveInfo.dll new file mode 100644 index 0000000..5c59398 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.IO.FileSystem.DriveInfo.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.IO.FileSystem.Primitives.dll b/packages/FAKE.5.16.0/tools/System.IO.FileSystem.Primitives.dll new file mode 100644 index 0000000..de4c49f Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.IO.FileSystem.Primitives.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.IO.FileSystem.Watcher.dll b/packages/FAKE.5.16.0/tools/System.IO.FileSystem.Watcher.dll new file mode 100644 index 0000000..228d60b Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.IO.FileSystem.Watcher.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.IO.FileSystem.dll b/packages/FAKE.5.16.0/tools/System.IO.FileSystem.dll new file mode 100644 index 0000000..6934080 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.IO.FileSystem.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.IO.IsolatedStorage.dll b/packages/FAKE.5.16.0/tools/System.IO.IsolatedStorage.dll new file mode 100644 index 0000000..356e123 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.IO.IsolatedStorage.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.IO.MemoryMappedFiles.dll b/packages/FAKE.5.16.0/tools/System.IO.MemoryMappedFiles.dll new file mode 100644 index 0000000..add3b29 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.IO.MemoryMappedFiles.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.IO.Pipes.dll b/packages/FAKE.5.16.0/tools/System.IO.Pipes.dll new file mode 100644 index 0000000..e5690c4 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.IO.Pipes.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.IO.UnmanagedMemoryStream.dll b/packages/FAKE.5.16.0/tools/System.IO.UnmanagedMemoryStream.dll new file mode 100644 index 0000000..cdd7427 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.IO.UnmanagedMemoryStream.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.IO.dll b/packages/FAKE.5.16.0/tools/System.IO.dll new file mode 100644 index 0000000..e9eb534 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.IO.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Linq.Expressions.dll b/packages/FAKE.5.16.0/tools/System.Linq.Expressions.dll new file mode 100644 index 0000000..63b570c Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Linq.Expressions.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Linq.Parallel.dll b/packages/FAKE.5.16.0/tools/System.Linq.Parallel.dll new file mode 100644 index 0000000..d8d097e Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Linq.Parallel.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Linq.Queryable.dll b/packages/FAKE.5.16.0/tools/System.Linq.Queryable.dll new file mode 100644 index 0000000..404bbe2 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Linq.Queryable.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Linq.dll b/packages/FAKE.5.16.0/tools/System.Linq.dll new file mode 100644 index 0000000..42cd93b Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Linq.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Net.Http.dll b/packages/FAKE.5.16.0/tools/System.Net.Http.dll new file mode 100644 index 0000000..1c5c6fd Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Net.Http.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Net.NameResolution.dll b/packages/FAKE.5.16.0/tools/System.Net.NameResolution.dll new file mode 100644 index 0000000..e8a65c0 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Net.NameResolution.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Net.NetworkInformation.dll b/packages/FAKE.5.16.0/tools/System.Net.NetworkInformation.dll new file mode 100644 index 0000000..543a6cf Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Net.NetworkInformation.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Net.Ping.dll b/packages/FAKE.5.16.0/tools/System.Net.Ping.dll new file mode 100644 index 0000000..eeb4666 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Net.Ping.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Net.Primitives.dll b/packages/FAKE.5.16.0/tools/System.Net.Primitives.dll new file mode 100644 index 0000000..8a929ae Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Net.Primitives.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Net.Requests.dll b/packages/FAKE.5.16.0/tools/System.Net.Requests.dll new file mode 100644 index 0000000..5cf38f8 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Net.Requests.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Net.Security.dll b/packages/FAKE.5.16.0/tools/System.Net.Security.dll new file mode 100644 index 0000000..eacb8a1 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Net.Security.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Net.Sockets.dll b/packages/FAKE.5.16.0/tools/System.Net.Sockets.dll new file mode 100644 index 0000000..9716795 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Net.Sockets.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Net.WebHeaderCollection.dll b/packages/FAKE.5.16.0/tools/System.Net.WebHeaderCollection.dll new file mode 100644 index 0000000..0238e69 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Net.WebHeaderCollection.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Net.WebSockets.Client.dll b/packages/FAKE.5.16.0/tools/System.Net.WebSockets.Client.dll new file mode 100644 index 0000000..3275912 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Net.WebSockets.Client.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Net.WebSockets.dll b/packages/FAKE.5.16.0/tools/System.Net.WebSockets.dll new file mode 100644 index 0000000..7a74189 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Net.WebSockets.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.ObjectModel.dll b/packages/FAKE.5.16.0/tools/System.ObjectModel.dll new file mode 100644 index 0000000..37e1189 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.ObjectModel.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Reactive.Core.dll b/packages/FAKE.5.16.0/tools/System.Reactive.Core.dll new file mode 100644 index 0000000..c19acf2 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Reactive.Core.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Reactive.Core.xml b/packages/FAKE.5.16.0/tools/System.Reactive.Core.xml new file mode 100644 index 0000000..746f753 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/System.Reactive.Core.xml @@ -0,0 +1,8 @@ + + + + System.Reactive.Core + + + + diff --git a/packages/FAKE.5.16.0/tools/System.Reactive.Experimental.dll b/packages/FAKE.5.16.0/tools/System.Reactive.Experimental.dll new file mode 100644 index 0000000..84a2d0e Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Reactive.Experimental.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Reactive.Experimental.xml b/packages/FAKE.5.16.0/tools/System.Reactive.Experimental.xml new file mode 100644 index 0000000..4f9f699 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/System.Reactive.Experimental.xml @@ -0,0 +1,8 @@ + + + + System.Reactive.Experimental + + + + diff --git a/packages/FAKE.5.16.0/tools/System.Reactive.Interfaces.dll b/packages/FAKE.5.16.0/tools/System.Reactive.Interfaces.dll new file mode 100644 index 0000000..7080e34 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Reactive.Interfaces.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Reactive.Interfaces.xml b/packages/FAKE.5.16.0/tools/System.Reactive.Interfaces.xml new file mode 100644 index 0000000..cc153f8 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/System.Reactive.Interfaces.xml @@ -0,0 +1,8 @@ + + + + System.Reactive.Interfaces + + + + diff --git a/packages/FAKE.5.16.0/tools/System.Reactive.Linq.dll b/packages/FAKE.5.16.0/tools/System.Reactive.Linq.dll new file mode 100644 index 0000000..978ced8 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Reactive.Linq.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Reactive.Linq.xml b/packages/FAKE.5.16.0/tools/System.Reactive.Linq.xml new file mode 100644 index 0000000..04d52dd --- /dev/null +++ b/packages/FAKE.5.16.0/tools/System.Reactive.Linq.xml @@ -0,0 +1,8 @@ + + + + System.Reactive.Linq + + + + diff --git a/packages/FAKE.5.16.0/tools/System.Reactive.PlatformServices.dll b/packages/FAKE.5.16.0/tools/System.Reactive.PlatformServices.dll new file mode 100644 index 0000000..5d16443 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Reactive.PlatformServices.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Reactive.PlatformServices.xml b/packages/FAKE.5.16.0/tools/System.Reactive.PlatformServices.xml new file mode 100644 index 0000000..6e6a07b --- /dev/null +++ b/packages/FAKE.5.16.0/tools/System.Reactive.PlatformServices.xml @@ -0,0 +1,8 @@ + + + + System.Reactive.PlatformServices + + + + diff --git a/packages/FAKE.5.16.0/tools/System.Reactive.Providers.dll b/packages/FAKE.5.16.0/tools/System.Reactive.Providers.dll new file mode 100644 index 0000000..f8d29dc Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Reactive.Providers.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Reactive.Providers.xml b/packages/FAKE.5.16.0/tools/System.Reactive.Providers.xml new file mode 100644 index 0000000..466dd0e --- /dev/null +++ b/packages/FAKE.5.16.0/tools/System.Reactive.Providers.xml @@ -0,0 +1,8 @@ + + + + System.Reactive.Providers + + + + diff --git a/packages/FAKE.5.16.0/tools/System.Reactive.Runtime.Remoting.dll b/packages/FAKE.5.16.0/tools/System.Reactive.Runtime.Remoting.dll new file mode 100644 index 0000000..a9fb659 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Reactive.Runtime.Remoting.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Reactive.Runtime.Remoting.xml b/packages/FAKE.5.16.0/tools/System.Reactive.Runtime.Remoting.xml new file mode 100644 index 0000000..307ed93 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/System.Reactive.Runtime.Remoting.xml @@ -0,0 +1,8 @@ + + + + System.Reactive.Runtime.Remoting + + + + diff --git a/packages/FAKE.5.16.0/tools/System.Reactive.Windows.Forms.dll b/packages/FAKE.5.16.0/tools/System.Reactive.Windows.Forms.dll new file mode 100644 index 0000000..d3e125b Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Reactive.Windows.Forms.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Reactive.Windows.Forms.xml b/packages/FAKE.5.16.0/tools/System.Reactive.Windows.Forms.xml new file mode 100644 index 0000000..4d5d7f6 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/System.Reactive.Windows.Forms.xml @@ -0,0 +1,8 @@ + + + + System.Reactive.Windows.Forms + + + + diff --git a/packages/FAKE.5.16.0/tools/System.Reactive.Windows.Threading.dll b/packages/FAKE.5.16.0/tools/System.Reactive.Windows.Threading.dll new file mode 100644 index 0000000..d864441 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Reactive.Windows.Threading.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Reactive.Windows.Threading.xml b/packages/FAKE.5.16.0/tools/System.Reactive.Windows.Threading.xml new file mode 100644 index 0000000..8cd0352 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/System.Reactive.Windows.Threading.xml @@ -0,0 +1,8 @@ + + + + System.Reactive.Windows.Threading + + + + diff --git a/packages/FAKE.5.16.0/tools/System.Reactive.dll b/packages/FAKE.5.16.0/tools/System.Reactive.dll new file mode 100644 index 0000000..b05f908 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Reactive.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Reactive.xml b/packages/FAKE.5.16.0/tools/System.Reactive.xml new file mode 100644 index 0000000..f57334c --- /dev/null +++ b/packages/FAKE.5.16.0/tools/System.Reactive.xml @@ -0,0 +1,26897 @@ + + + + System.Reactive + + + + + Class to create an instance from a delegate-based implementation of the method. + + The type of the elements in the sequence. + + + + Creates an observable sequence object from the specified subscription function. + + method implementation. + is null. + + + + Calls the subscription function that was supplied to the constructor. + + Observer to send notifications to. + Disposable object representing an observer's subscription to the observable sequence. + + + + Class to create an instance from delegate-based implementations of the On* methods. + + The type of the elements in the sequence. + + + + Creates an observer from the specified , , and actions. + + Observer's action implementation. + Observer's action implementation. + Observer's action implementation. + or or is null. + + + + Creates an observer from the specified action. + + Observer's action implementation. + is null. + + + + Creates an observer from the specified and actions. + + Observer's action implementation. + Observer's action implementation. + or is null. + + + + Creates an observer from the specified and actions. + + Observer's action implementation. + Observer's action implementation. + or is null. + + + + Calls the action implementing . + + Next element in the sequence. + + + + Calls the action implementing . + + The error that has occurred. + + + + Calls the action implementing . + + + + + This class fuses logic from ObserverBase, AnonymousObserver, and SafeObserver into one class. When an observer + needs to be safeguarded, an instance of this type can be created by SafeObserver.Create when it detects its + input is an AnonymousObserver, which is commonly used by end users when using the Subscribe extension methods + that accept delegates for the On* handlers. By doing the fusion, we make the call stack depth shorter which + helps debugging and some performance. + + + + + Asynchronous lock. + + + + + Queues the action for execution. If the caller acquires the lock and becomes the owner, + the queue is processed. If the lock is already owned, the action is queued and will get + processed by the owner. + + Action to queue for execution. + is null. + + + + Queues the action for execution. If the caller acquires the lock and becomes the owner, + the queue is processed. If the lock is already owned, the action is queued and will get + processed by the owner. + + Action to queue for execution. + The state to pass to the action when it gets invoked under the lock. + is null. + In case TState is a value type, this operation will involve boxing of . + However, this is often an improvement over the allocation of a closure object and a delegate. + + + + Clears the work items in the queue and drops further work being queued. + + + + + (Infrastructure) Concurrency abstraction layer. + + + + + Gets the current CAL. If no CAL has been set yet, it will be initialized to the default. + + + + + (Infrastructure) Concurrency abstraction layer interface. + + + This type is used by the Rx infrastructure and not meant for public consumption or implementation. + No guarantees are made about forward compatibility of the type's functionality and its usage. + + + + + Queues a method for execution at the specified relative time. + + Method to execute. + State to pass to the method. + Time to execute the method on. + Disposable object that can be used to stop the timer. + + + + Queues a method for periodic execution based on the specified period. + + Method to execute; should be safe for reentrancy. + Period for running the method periodically. + Disposable object that can be used to stop the timer. + + + + Queues a method for execution. + + Method to execute. + State to pass to the method. + Disposable object that can be used to cancel the queued method. + + + + Blocking sleep operation. + + Time to sleep. + + + + Starts a new stopwatch object. + + New stopwatch object; started at the time of the request. + + + + Gets whether long-running scheduling is supported. + + + + + Starts a new long-running thread. + + Method to execute. + State to pass to the method. + + + + Represents an object that schedules units of work on the current thread. + + Singleton instance of this type exposed through this static property. + + + + Gets the singleton instance of the current thread scheduler. + + + + + Gets a value that indicates whether the caller must call a Schedule method. + + + + + Gets a value that indicates whether the caller must call a Schedule method. + + + + + Schedules an action to be executed after dueTime. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + Relative time after which to execute the action. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Represents an object that schedules units of work on the platform's default scheduler. + + Singleton instance of this type exposed through this static property. + + + + Gets the singleton instance of the default scheduler. + + + + + Schedules an action to be executed. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Schedules an action to be executed after dueTime, using a System.Threading.Timer object. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + Relative time after which to execute the action. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Schedules a periodic piece of work, using a System.Threading.Timer object. + + The type of the state passed to the scheduled action. + Initial state passed to the action upon the first iteration. + Period for running the work periodically. + Action to be executed, potentially updating the state. + The disposable object used to cancel the scheduled recurring action (best effort). + is less than . + is null. + + + + Discovers scheduler services by interface type. + + Scheduler service interface type to discover. + Object implementing the requested service, if available; null otherwise. + + + + Represents an object that schedules units of work on a designated thread. + + + + + Counter for diagnostic purposes, to name the threads. + + + + + Thread factory function. + + + + + Stopwatch for timing free of absolute time dependencies. + + + + + Thread used by the event loop to run work items on. No work should be run on any other thread. + If ExitIfEmpty is set, the thread can quit and a new thread will be created when new work is scheduled. + + + + + Gate to protect data structures, including the work queue and the ready list. + + + + + Semaphore to count requests to re-evaluate the queue, from either Schedule requests or when a timer + expires and moves on to the next item in the queue. + + + + + Queue holding work items. Protected by the gate. + + + + + Queue holding items that are ready to be run as soon as possible. Protected by the gate. + + + + + Work item that will be scheduled next. Used upon reevaluation of the queue to check whether the next + item is still the same. If not, a new timer needs to be started (see below). + + + + + Disposable that always holds the timer to dispatch the first element in the queue. + + + + + Flag indicating whether the event loop should quit. When set, the event should be signaled as well to + wake up the event loop thread, which will subsequently abandon all work. + + + + + Creates an object that schedules units of work on a designated thread. + + + + + Creates an object that schedules units of work on a designated thread, using the specified factory to control thread creation options. + + Factory function for thread creation. + is null. + + + + Indicates whether the event loop thread is allowed to quit when no work is left. If new work + is scheduled afterwards, a new event loop thread is created. This property is used by the + NewThreadScheduler which uses an event loop for its recursive invocations. + + + + + Schedules an action to be executed after dueTime. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + Relative time after which to execute the action. + The disposable object used to cancel the scheduled action (best effort). + is null. + The scheduler has been disposed and doesn't accept new work. + + + + Schedules a periodic piece of work on the designated thread. + + The type of the state passed to the scheduled action. + Initial state passed to the action upon the first iteration. + Period for running the work periodically. + Action to be executed, potentially updating the state. + The disposable object used to cancel the scheduled recurring action (best effort). + is null. + is less than . + The scheduler has been disposed and doesn't accept new work. + + + + Starts a new stopwatch object. + + New stopwatch object; started at the time of the request. + + + + Ends the thread associated with this scheduler. All remaining work in the scheduler queue is abandoned. + + + + + Ensures there is an event loop thread running. Should be called under the gate. + + + + + Event loop scheduled on the designated event loop thread. The loop is suspended/resumed using the event + which gets set by calls to Schedule, the next item timer, or calls to Dispose. + + + + + Base class for historical schedulers, which are virtual time schedulers that use for absolute time and for relative time. + + + + + Creates a new historical scheduler with the minimum value of as the initial clock value. + + + + + Creates a new historical scheduler with the specified initial clock value. + + Initial clock value. + + + + Creates a new historical scheduler with the specified initial clock value and absolute time comparer. + + Initial value for the clock. + Comparer to determine causality of events based on absolute time. + + + + Adds a relative time value to an absolute time value. + + Absolute time value. + Relative time value to add. + The resulting absolute time sum value. + + + + Converts the absolute time value to a value. + + Absolute time value to convert. + The corresponding value. + + + + Converts the value to a relative time value. + + value to convert. + The corresponding relative time value. + + + + Provides a virtual time scheduler that uses for absolute time and for relative time. + + + + + Creates a new historical scheduler with the minimum value of as the initial clock value. + + + + + Creates a new historical scheduler with the specified initial clock value. + + Initial value for the clock. + + + + Creates a new historical scheduler with the specified initial clock value. + + Initial value for the clock. + Comparer to determine causality of events based on absolute time. + is null. + + + + Gets the next scheduled item to be executed. + + The next scheduled item. + + + + Schedules an action to be executed at . + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + Absolute time at which to execute the action. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Represents an object that schedules units of work to run immediately on the current thread. + + Singleton instance of this type exposed through this static property. + + + + Gets the singleton instance of the immediate scheduler. + + + + + Schedules an action to be executed. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Schedules an action to be executed after dueTime. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + Relative time after which to execute the action. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Represents a work item that has been scheduled. + + Absolute time representation type. + + + + Gets the absolute time at which the item is due for invocation. + + + + + Invokes the work item. + + + + + Represents an object that schedules units of work. + + + + + Gets the scheduler's notion of current time. + + + + + Schedules an action to be executed. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + The disposable object used to cancel the scheduled action (best effort). + + + + Schedules an action to be executed after dueTime. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + Relative time after which to execute the action. + The disposable object used to cancel the scheduled action (best effort). + + + + Schedules an action to be executed at dueTime. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + Absolute time at which to execute the action. + The disposable object used to cancel the scheduled action (best effort). + + + + Scheduler with support for starting long-running tasks. + This type of scheduler can be used to run loops more efficiently instead of using recursive scheduling. + + + + + Schedules a long-running piece of work. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + The disposable object used to cancel the scheduled action (best effort). + + Notes to implementers + The returned disposable object should not prevent the work from starting, but only set the cancellation flag passed to the specified action. + + + + + Scheduler with support for running periodic tasks. + This type of scheduler can be used to run timers more efficiently instead of using recursive scheduling. + + + + + Schedules a periodic piece of work. + + The type of the state passed to the scheduled action. + Initial state passed to the action upon the first iteration. + Period for running the work periodically. + Action to be executed, potentially updating the state. + The disposable object used to cancel the scheduled recurring action (best effort). + + + + Abstraction for a stopwatch to compute time relative to a starting point. + + + + + Gets the time elapsed since the stopwatch object was obtained. + + + + + Provider for objects. + + + + + Starts a new stopwatch object. + + New stopwatch object; started at the time of the request. + + + + Abstract base class for machine-local schedulers, using the local system clock for time-based operations. + + + + + Gets the scheduler's notion of current time. + + + + + Schedules an action to be executed. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Schedules an action to be executed after dueTime. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + Relative time after which to execute the action. + The disposable object used to cancel the scheduled action (best effort). + + + + Schedules an action to be executed at dueTime. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + Absolute time at which to execute the action. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Starts a new stopwatch object. + + New stopwatch object; started at the time of the request. + + Platform-specific scheduler implementations should reimplement + to provide a more efficient implementation (if available). + + + + + Discovers scheduler services by interface type. The base class implementation returns + requested services for each scheduler interface implemented by the derived class. For + more control over service discovery, derived types can override this method. + + Scheduler service interface type to discover. + Object implementing the requested service, if available; null otherwise. + + + + Gate to protect local scheduler queues. + + + + + Gate to protect queues and to synchronize scheduling decisions and system clock + change management. + + + + + Long term work queue. Contains work that's due beyond SHORTTERM, computed at the + time of enqueueing. + + + + + Disposable resource for the long term timer that will reevaluate and dispatch the + first item in the long term queue. A serial disposable is used to make "dispose + current and assign new" logic easier. The disposable itself is never disposed. + + + + + Item at the head of the long term queue for which the current long term timer is + running. Used to detect changes in the queue and decide whether we should replace + or can continue using the current timer (because no earlier long term work was + added to the queue). + + + + + Short term work queue. Contains work that's due soon, computed at the time of + enqueueing or upon reevaluation of the long term queue causing migration of work + items. This queue is kept in order to be able to relocate short term items back + to the long term queue in case a system clock change occurs. + + + + + Set of disposable handles to all of the current short term work Schedule calls, + allowing those to be cancelled upon a system clock change. + + + + + Threshold where an item is considered to be short term work or gets moved from + long term to short term. + + + + + Maximum error ratio for timer drift. We've seen machines with 10s drift on a + daily basis, which is in the order 10E-4, so we allow for extra margin here. + This value is used to calculate early arrival for the long term queue timer + that will reevaluate work for the short term queue. + + Example: -------------------------------...---------------------*-----$ + ^ ^ + | | + early due + 0.999 1.0 + + We also make the gap between early and due at least LONGTOSHORT so we have + enough time to transition work to short term and as a courtesy to the + destination scheduler to manage its queues etc. + + + + + Minimum threshold for the long term timer to fire before the queue is reevaluated + for short term work. This value is chosen to be less than SHORTTERM in order to + ensure the timer fires and has work to transition to the short term queue. + + + + + Threshold used to determine when a short term timer has fired too early compared + to the absolute due time. This provides a last chance protection against early + completion of scheduled work, which can happen in case of time adjustment in the + operating system (cf. GetSystemTimeAdjustment). + + + + + Longest interval supported by timers in the BCL. + + + + + Creates a new local scheduler. + + + + + Enqueues absolute time scheduled work in the timer queue or the short term work list. + + State to pass to the action. + Absolute time to run the work on. The timer queue is responsible to execute the work close to the specified time, also accounting for system clock changes. + Action to run, potentially recursing into the scheduler. + Disposable object to prevent the work from running. + + + + Schedule work that's due in the short term. This leads to relative scheduling calls to the + underlying scheduler for short TimeSpan values. If the system clock changes in the meantime, + the short term work is attempted to be cancelled and reevaluated. + + Work item to schedule in the short term. The caller is responsible to determine the work is indeed short term. + + + + Callback to process the next short term work item. + + Recursive scheduler supplied by the underlying scheduler. + Disposable used to identify the work the timer was triggered for (see code for usage). + Empty disposable. Recursive work cancellation is wired through the original WorkItem. + + + + Schedule work that's due on the long term. This leads to the work being queued up for + eventual transitioning to the short term work list. + + Work item to schedule on the long term. The caller is responsible to determine the work is indeed long term. + + + + Updates the long term timer which is responsible to transition work from the head of the + long term queue to the short term work list. + + Should be called under the scheduler lock. + + + + Evaluates the long term queue, transitioning short term work to the short term list, + and adjusting the new long term processing timer accordingly. + + + + + Callback invoked when a system clock change is observed in order to adjust and reevaluate + the internal scheduling queues. + + Currently not used. + Currently not used. + + + + Represents a work item in the absolute time scheduler. + + + This type is very similar to ScheduledItem, but we need a different Invoke signature to allow customization + of the target scheduler (e.g. when called in a recursive scheduling context, see ExecuteNextShortTermWorkItem). + + + + + Represents a work item that closes over scheduler invocation state. Subtyping is + used to have a common type for the scheduler queues. + + + + + Represents an object that schedules each unit of work on a separate thread. + + + + + Creates an object that schedules each unit of work on a separate thread. + + + + + Gets an instance of this scheduler that uses the default Thread constructor. + + + + + Creates an object that schedules each unit of work on a separate thread. + + Factory function for thread creation. + is null. + + + + Schedules an action to be executed after dueTime. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + Relative time after which to execute the action. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Schedules a long-running task by creating a new thread. Cancellation happens through polling. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Schedules a periodic piece of work by creating a new thread that goes to sleep when work has been dispatched and wakes up again at the next periodic due time. + + The type of the state passed to the scheduled action. + Initial state passed to the action upon the first iteration. + Period for running the work periodically. + Action to be executed, potentially updating the state. + The disposable object used to cancel the scheduled recurring action (best effort). + is null. + is less than . + + + + Starts a new stopwatch object. + + New stopwatch object; started at the time of the request. + + + + Abstract base class for scheduled work items. + + Absolute time representation type. + + + + Creates a new scheduled work item to run at the specified time. + + Absolute time at which the work item has to be executed. + Comparer used to compare work items based on their scheduled time. + is null. + + + + Gets the absolute time at which the item is due for invocation. + + + + + Invokes the work item. + + + + + Implement this method to perform the work item invocation, returning a disposable object for deep cancellation. + + Disposable object used to cancel the work item and/or derived work items. + + + + Compares the work item with another work item based on absolute time values. + + Work item to compare the current work item to. + Relative ordering between this and the specified work item. + The inequality operators are overloaded to provide results consistent with the implementation. Equality operators implement traditional reference equality semantics. + + + + Determines whether one specified object is due before a second specified object. + + The first object to compare. + The second object to compare. + true if the value of left is earlier than the value of right; otherwise, false. + This operator provides results consistent with the implementation. + + + + Determines whether one specified object is due before or at the same of a second specified object. + + The first object to compare. + The second object to compare. + true if the value of left is earlier than or simultaneous with the value of right; otherwise, false. + This operator provides results consistent with the implementation. + + + + Determines whether one specified object is due after a second specified object. + + The first object to compare. + The second object to compare. + true if the value of left is later than the value of right; otherwise, false. + This operator provides results consistent with the implementation. + + + + Determines whether one specified object is due after or at the same time of a second specified object. + + The first object to compare. + The second object to compare. + true if the value of left is later than or simultaneous with the value of right; otherwise, false. + This operator provides results consistent with the implementation. + + + + Determines whether two specified objects are equal. + + The first object to compare. + The second object to compare. + true if both are equal; otherwise, false. + This operator does not provide results consistent with the IComparable implementation. Instead, it implements reference equality. + + + + Determines whether two specified objects are inequal. + + The first object to compare. + The second object to compare. + true if both are inequal; otherwise, false. + This operator does not provide results consistent with the IComparable implementation. Instead, it implements reference equality. + + + + Determines whether a object is equal to the specified object. + + The object to compare to the current object. + true if the obj parameter is a object and is equal to the current object; otherwise, false. + + + + Returns the hash code for the current object. + + A 32-bit signed integer hash code. + + + + Cancels the work item by disposing the resource returned by as soon as possible. + + + + + Gets whether the work item has received a cancellation request. + + + + + Represents a scheduled work item based on the materialization of an IScheduler.Schedule method call. + + Absolute time representation type. + Type of the state passed to the scheduled action. + + + + Creates a materialized work item. + + Recursive scheduler to invoke the scheduled action with. + State to pass to the scheduled action. + Scheduled action. + Time at which to run the scheduled action. + Comparer used to compare work items based on their scheduled time. + or or is null. + + + + Creates a materialized work item. + + Recursive scheduler to invoke the scheduled action with. + State to pass to the scheduled action. + Scheduled action. + Time at which to run the scheduled action. + or is null. + + + + Invokes the scheduled action with the supplied recursive scheduler and state. + + Cancellation resource returned by the scheduled action. + + + + Provides a set of static properties to access commonly used schedulers. + + + + + Yields execution of the current work item on the scheduler to another work item on the scheduler. + The caller should await the result of calling Yield to schedule the remainder of the current work item (known as the continuation). + + Scheduler to yield work on. + Scheduler operation object to await in order to schedule the continuation. + is null. + + + + Yields execution of the current work item on the scheduler to another work item on the scheduler. + The caller should await the result of calling Yield to schedule the remainder of the current work item (known as the continuation). + + Scheduler to yield work on. + Cancellation token to cancel the continuation to run. + Scheduler operation object to await in order to schedule the continuation. + is null. + + + + Suspends execution of the current work item on the scheduler for the specified duration. + The caller should await the result of calling Sleep to schedule the remainder of the current work item (known as the continuation) after the specified duration. + + Scheduler to yield work on. + Time when the continuation should run. + Scheduler operation object to await in order to schedule the continuation. + is null. + + + + Suspends execution of the current work item on the scheduler for the specified duration. + The caller should await the result of calling Sleep to schedule the remainder of the current work item (known as the continuation) after the specified duration. + + Scheduler to yield work on. + Time when the continuation should run. + Cancellation token to cancel the continuation to run. + Scheduler operation object to await in order to schedule the continuation. + is null. + + + + Suspends execution of the current work item on the scheduler until the specified due time. + The caller should await the result of calling Sleep to schedule the remainder of the current work item (known as the continuation) at the specified due time. + + Scheduler to yield work on. + Time when the continuation should run. + Scheduler operation object to await in order to schedule the continuation. + is null. + + + + Suspends execution of the current work item on the scheduler until the specified due time. + The caller should await the result of calling Sleep to schedule the remainder of the current work item (known as the continuation) at the specified due time. + + Scheduler to yield work on. + Time when the continuation should run. + Cancellation token to cancel the continuation to run. + Scheduler operation object to await in order to schedule the continuation. + is null. + + + + Schedules work using an asynchronous method, allowing for cooperative scheduling in an imperative coding style. + + The type of the state passed to the scheduled action. + Scheduler to schedule work on. + State to pass to the asynchronous method. + Asynchronous method to run the work, using Yield and Sleep operations for cooperative scheduling and injection of cancellation points. + Disposable object that allows to cancel outstanding work on cooperative cancellation points or through the cancellation token passed to the asynchronous method. + or is null. + + + + Schedules work using an asynchronous method, allowing for cooperative scheduling in an imperative coding style. + + The type of the state passed to the scheduled action. + Scheduler to schedule work on. + State to pass to the asynchronous method. + Asynchronous method to run the work, using Yield and Sleep operations for cooperative scheduling and injection of cancellation points. + Disposable object that allows to cancel outstanding work on cooperative cancellation points or through the cancellation token passed to the asynchronous method. + or is null. + + + + Schedules work using an asynchronous method, allowing for cooperative scheduling in an imperative coding style. + + Scheduler to schedule work on. + Asynchronous method to run the work, using Yield and Sleep operations for cooperative scheduling and injection of cancellation points. + Disposable object that allows to cancel outstanding work on cooperative cancellation points or through the cancellation token passed to the asynchronous method. + or is null. + + + + Schedules work using an asynchronous method, allowing for cooperative scheduling in an imperative coding style. + + Scheduler to schedule work on. + Asynchronous method to run the work, using Yield and Sleep operations for cooperative scheduling and injection of cancellation points. + Disposable object that allows to cancel outstanding work on cooperative cancellation points or through the cancellation token passed to the asynchronous method. + or is null. + + + + Schedules work using an asynchronous method, allowing for cooperative scheduling in an imperative coding style. + + The type of the state passed to the scheduled action. + Scheduler to schedule work on. + State to pass to the asynchronous method. + Relative time after which to execute the action. + Asynchronous method to run the work, using Yield and Sleep operations for cooperative scheduling and injection of cancellation points. + Disposable object that allows to cancel outstanding work on cooperative cancellation points or through the cancellation token passed to the asynchronous method. + or is null. + + + + Schedules work using an asynchronous method, allowing for cooperative scheduling in an imperative coding style. + + The type of the state passed to the scheduled action. + Scheduler to schedule work on. + State to pass to the asynchronous method. + Relative time after which to execute the action. + Asynchronous method to run the work, using Yield and Sleep operations for cooperative scheduling and injection of cancellation points. + Disposable object that allows to cancel outstanding work on cooperative cancellation points or through the cancellation token passed to the asynchronous method. + or is null. + + + + Schedules work using an asynchronous method, allowing for cooperative scheduling in an imperative coding style. + + Scheduler to schedule work on. + Relative time after which to execute the action. + Asynchronous method to run the work, using Yield and Sleep operations for cooperative scheduling and injection of cancellation points. + Disposable object that allows to cancel outstanding work on cooperative cancellation points or through the cancellation token passed to the asynchronous method. + or is null. + + + + Schedules work using an asynchronous method, allowing for cooperative scheduling in an imperative coding style. + + Scheduler to schedule work on. + Relative time after which to execute the action. + Asynchronous method to run the work, using Yield and Sleep operations for cooperative scheduling and injection of cancellation points. + Disposable object that allows to cancel outstanding work on cooperative cancellation points or through the cancellation token passed to the asynchronous method. + or is null. + + + + Schedules work using an asynchronous method, allowing for cooperative scheduling in an imperative coding style. + + The type of the state passed to the scheduled action. + Scheduler to schedule work on. + State to pass to the asynchronous method. + Absolute time at which to execute the action. + Asynchronous method to run the work, using Yield and Sleep operations for cooperative scheduling and injection of cancellation points. + Disposable object that allows to cancel outstanding work on cooperative cancellation points or through the cancellation token passed to the asynchronous method. + or is null. + + + + Schedules work using an asynchronous method, allowing for cooperative scheduling in an imperative coding style. + + The type of the state passed to the scheduled action. + Scheduler to schedule work on. + State to pass to the asynchronous method. + Absolute time at which to execute the action. + Asynchronous method to run the work, using Yield and Sleep operations for cooperative scheduling and injection of cancellation points. + Disposable object that allows to cancel outstanding work on cooperative cancellation points or through the cancellation token passed to the asynchronous method. + or is null. + + + + Schedules work using an asynchronous method, allowing for cooperative scheduling in an imperative coding style. + + Scheduler to schedule work on. + Absolute time at which to execute the action. + Asynchronous method to run the work, using Yield and Sleep operations for cooperative scheduling and injection of cancellation points. + Disposable object that allows to cancel outstanding work on cooperative cancellation points or through the cancellation token passed to the asynchronous method. + or is null. + + + + Schedules work using an asynchronous method, allowing for cooperative scheduling in an imperative coding style. + + Scheduler to schedule work on. + Absolute time at which to execute the action. + Asynchronous method to run the work, using Yield and Sleep operations for cooperative scheduling and injection of cancellation points. + Disposable object that allows to cancel outstanding work on cooperative cancellation points or through the cancellation token passed to the asynchronous method. + or is null. + + + + Gets the current time according to the local machine's system clock. + + + + + Normalizes the specified value to a positive value. + + The value to normalize. + The specified TimeSpan value if it is zero or positive; otherwise, . + + + + Gets a scheduler that schedules work immediately on the current thread. + + + + + Gets a scheduler that schedules work as soon as possible on the current thread. + + + + + Gets a scheduler that schedules work on the platform's default scheduler. + + + + + Gets a scheduler that schedules work on the thread pool. + + + + + Gets a scheduler that schedules work on a new thread using default thread creation options. + + + + + Gets a scheduler that schedules work on Task Parallel Library (TPL) task pool using the default TaskScheduler. + + + + + Schedules an action to be executed recursively. + + Scheduler to execute the recursive action on. + Action to execute recursively. The parameter passed to the action is used to trigger recursive scheduling of the action. + The disposable object used to cancel the scheduled action (best effort). + or is null. + + + + Schedules an action to be executed recursively. + + The type of the state passed to the scheduled action. + Scheduler to execute the recursive action on. + State passed to the action to be executed. + Action to execute recursively. The last parameter passed to the action is used to trigger recursive scheduling of the action, passing in recursive invocation state. + The disposable object used to cancel the scheduled action (best effort). + or is null. + + + + Schedules an action to be executed recursively after a specified relative due time. + + Scheduler to execute the recursive action on. + Action to execute recursively. The parameter passed to the action is used to trigger recursive scheduling of the action at the specified relative time. + Relative time after which to execute the action for the first time. + The disposable object used to cancel the scheduled action (best effort). + or is null. + + + + Schedules an action to be executed recursively after a specified relative due time. + + The type of the state passed to the scheduled action. + Scheduler to execute the recursive action on. + State passed to the action to be executed. + Action to execute recursively. The last parameter passed to the action is used to trigger recursive scheduling of the action, passing in the recursive due time and invocation state. + Relative time after which to execute the action for the first time. + The disposable object used to cancel the scheduled action (best effort). + or is null. + + + + Schedules an action to be executed recursively at a specified absolute due time. + + Scheduler to execute the recursive action on. + Action to execute recursively. The parameter passed to the action is used to trigger recursive scheduling of the action at the specified absolute time. + Absolute time at which to execute the action for the first time. + The disposable object used to cancel the scheduled action (best effort). + or is null. + + + + Schedules an action to be executed recursively at a specified absolute due time. + + The type of the state passed to the scheduled action. + Scheduler to execute the recursive action on. + State passed to the action to be executed. + Action to execute recursively. The last parameter passed to the action is used to trigger recursive scheduling of the action, passing in the recursive due time and invocation state. + Absolute time at which to execute the action for the first time. + The disposable object used to cancel the scheduled action (best effort). + or is null. + + + + Returns the implementation of the specified scheduler, or null if no such implementation is available. + + Scheduler to get the implementation for. + The scheduler's implementation if available; null otherwise. + + This helper method is made available for query operator authors in order to discover scheduler services by using the required + IServiceProvider pattern, which allows for interception or redefinition of scheduler services. + + + + + Returns the implementation of the specified scheduler, or null if no such implementation is available. + + Scheduler to get the implementation for. + The scheduler's implementation if available; null otherwise. + + + This helper method is made available for query operator authors in order to discover scheduler services by using the required + IServiceProvider pattern, which allows for interception or redefinition of scheduler services. + + + Consider using in case a stopwatch is required, but use of emulation stopwatch based + on the scheduler's clock is acceptable. Use of this method is recommended for best-effort use of the stopwatch provider + scheduler service, where the caller falls back to not using stopwatches if this facility wasn't found. + + + + + + Returns the implementation of the specified scheduler, or null if no such implementation is available. + + Scheduler to get the implementation for. + The scheduler's implementation if available; null otherwise. + + + This helper method is made available for query operator authors in order to discover scheduler services by using the required + IServiceProvider pattern, which allows for interception or redefinition of scheduler services. + + + Consider using the extension methods for in case periodic scheduling + is required and emulation of periodic behavior using other scheduler services is desirable. Use of this method is recommended + for best-effort use of the periodic scheduling service, where the caller falls back to not using periodic scheduling if this + facility wasn't found. + + + + + + Schedules a periodic piece of work by dynamically discovering the scheduler's capabilities. + If the scheduler supports periodic scheduling, the request will be forwarded to the periodic scheduling implementation. + If the scheduler provides stopwatch functionality, the periodic task will be emulated using recursive scheduling with a stopwatch to correct for time slippage. + Otherwise, the periodic task will be emulated using recursive scheduling. + + The type of the state passed to the scheduled action. + The scheduler to run periodic work on. + Initial state passed to the action upon the first iteration. + Period for running the work periodically. + Action to be executed, potentially updating the state. + The disposable object used to cancel the scheduled recurring action (best effort). + or is null. + is less than . + + + + Schedules a periodic piece of work by dynamically discovering the scheduler's capabilities. + If the scheduler supports periodic scheduling, the request will be forwarded to the periodic scheduling implementation. + If the scheduler provides stopwatch functionality, the periodic task will be emulated using recursive scheduling with a stopwatch to correct for time slippage. + Otherwise, the periodic task will be emulated using recursive scheduling. + + The type of the state passed to the scheduled action. + Scheduler to execute the action on. + State passed to the action to be executed. + Period for running the work periodically. + Action to be executed. + The disposable object used to cancel the scheduled recurring action (best effort). + or is null. + is less than . + + + + Schedules a periodic piece of work by dynamically discovering the scheduler's capabilities. + If the scheduler supports periodic scheduling, the request will be forwarded to the periodic scheduling implementation. + If the scheduler provides stopwatch functionality, the periodic task will be emulated using recursive scheduling with a stopwatch to correct for time slippage. + Otherwise, the periodic task will be emulated using recursive scheduling. + + Scheduler to execute the action on. + Period for running the work periodically. + Action to be executed. + The disposable object used to cancel the scheduled recurring action (best effort). + or is null. + is less than . + + + + Starts a new stopwatch object by dynamically discovering the scheduler's capabilities. + If the scheduler provides stopwatch functionality, the request will be forwarded to the stopwatch provider implementation. + Otherwise, the stopwatch will be emulated using the scheduler's notion of absolute time. + + Scheduler to obtain a stopwatch for. + New stopwatch object; started at the time of the request. + is null. + The resulting stopwatch object can have non-monotonic behavior. + + + + Schedules an action to be executed. + + Scheduler to execute the action on. + Action to execute. + The disposable object used to cancel the scheduled action (best effort). + or is null. + + + + Schedules an action to be executed. + + Scheduler to execute the action on. + A state object to be passed to . + Action to execute. + The disposable object used to cancel the scheduled action (best effort). + or is null. + + + + Schedules an action to be executed. + + Scheduler to execute the action on. + A state object to be passed to . + Action to execute. + The disposable object used to cancel the scheduled action (best effort). + or is null. + + + + Schedules an action to be executed after the specified relative due time. + + Scheduler to execute the action on. + Action to execute. + Relative time after which to execute the action. + The disposable object used to cancel the scheduled action (best effort). + or is null. + + + + Schedules an action to be executed after the specified relative due time. + + Scheduler to execute the action on. + Action to execute. + A state object to be passed to . + Relative time after which to execute the action. + The disposable object used to cancel the scheduled action (best effort). + or is null. + + + + Schedules an action to be executed after the specified relative due time. + + Scheduler to execute the action on. + Action to execute. + A state object to be passed to . + Relative time after which to execute the action. + The disposable object used to cancel the scheduled action (best effort). + or is null. + + + + Schedules an action to be executed at the specified absolute due time. + + Scheduler to execute the action on. + Action to execute. + Absolute time at which to execute the action. + The disposable object used to cancel the scheduled action (best effort). + or is null. + + + + Schedules an action to be executed after the specified relative due time. + + Scheduler to execute the action on. + Action to execute. + A state object to be passed to . + Relative time after which to execute the action. + The disposable object used to cancel the scheduled action (best effort). + or is null. + + + + Schedules an action to be executed after the specified relative due time. + + Scheduler to execute the action on. + Action to execute. + A state object to be passed to . + Relative time after which to execute the action. + The disposable object used to cancel the scheduled action (best effort). + or is null. + + + + Schedules an action to be executed. + + Scheduler to execute the action on. + Action to execute. + The disposable object used to cancel the scheduled action (best effort). + or is null. + + + + Returns a scheduler that represents the original scheduler, without any of its interface-based optimizations (e.g. long running scheduling). + + Scheduler to disable all optimizations for. + Proxy to the original scheduler but without any optimizations enabled. + is null. + + + + Returns a scheduler that represents the original scheduler, without the specified set of interface-based optimizations (e.g. long running scheduling). + + Scheduler to disable the specified optimizations for. + Types of the optimization interfaces that have to be disabled. + Proxy to the original scheduler but without the specified optimizations enabled. + or is null. + + + + Returns a scheduler that wraps the original scheduler, adding exception handling for scheduled actions. + + Type of the exception to check for. + Scheduler to apply an exception filter for. + Handler that's run if an exception is caught. The exception will be rethrown if the handler returns false. + Wrapper around the original scheduler, enforcing exception handling. + or is null. + + + + Represents an awaitable scheduler operation. Awaiting the object causes the continuation to be posted back to the originating scheduler's work queue. + + + + + Controls whether the continuation is run on the originating synchronization context (false by default). + + true to run the continuation on the captured synchronization context; false otherwise (default). + Scheduler operation object with configured await behavior. + + + + Gets an awaiter for the scheduler operation, used to post back the continuation. + + Awaiter for the scheduler operation. + + + + (Infrastructure) Scheduler operation awaiter type used by the code generated for C# await and Visual Basic Await expressions. + + + + + Indicates whether the scheduler operation has completed. Returns false unless cancellation was already requested. + + + + + Completes the scheduler operation, throwing an OperationCanceledException in case cancellation was requested. + + + + + Registers the continuation with the scheduler operation. + + Continuation to be run on the originating scheduler. + + + + Efficient scheduler queue that maintains scheduled items sorted by absolute time. + + Absolute time representation type. + This type is not thread safe; users should ensure proper synchronization. + + + + Creates a new scheduler queue with a default initial capacity. + + + + + Creates a new scheduler queue with the specified initial capacity. + + Initial capacity of the scheduler queue. + is less than zero. + + + + Gets the number of scheduled items in the scheduler queue. + + + + + Enqueues the specified work item to be scheduled. + + Work item to be scheduled. + + + + Removes the specified work item from the scheduler queue. + + Work item to be removed from the scheduler queue. + true if the item was found; false otherwise. + + + + Dequeues the next work item from the scheduler queue. + + Next work item in the scheduler queue (removed). + + + + Peeks the next work item in the scheduler queue. + + Next work item in the scheduler queue (not removed). + + + + Provides basic synchronization and scheduling services for observable sequences. + + + + + Wraps the source sequence in order to run its subscription and unsubscription logic on the specified scheduler. + + The type of the elements in the source sequence. + Source sequence. + Scheduler to perform subscription and unsubscription actions on. + The source sequence whose subscriptions and unsubscriptions happen on the specified scheduler. + or is null. + + Only the side-effects of subscribing to the source sequence and disposing subscriptions to the source sequence are run on the specified scheduler. + In order to invoke observer callbacks on the specified scheduler, e.g. to offload callback processing to a dedicated thread, use . + + + + + Wraps the source sequence in order to run its subscription and unsubscription logic on the specified synchronization context. + + The type of the elements in the source sequence. + Source sequence. + Synchronization context to perform subscription and unsubscription actions on. + The source sequence whose subscriptions and unsubscriptions happen on the specified synchronization context. + or is null. + + Only the side-effects of subscribing to the source sequence and disposing subscriptions to the source sequence are run on the specified synchronization context. + In order to invoke observer callbacks on the specified synchronization context, e.g. to post callbacks to a UI thread represented by the synchronization context, use . + + + + + Wraps the source sequence in order to run its observer callbacks on the specified scheduler. + + The type of the elements in the source sequence. + Source sequence. + Scheduler to notify observers on. + The source sequence whose observations happen on the specified scheduler. + or is null. + + + + Wraps the source sequence in order to run its observer callbacks on the specified synchronization context. + + The type of the elements in the source sequence. + Source sequence. + Synchronization context to notify observers on. + The source sequence whose observations happen on the specified synchronization context. + or is null. + + + + Wraps the source sequence in order to ensure observer callbacks are properly serialized. + + The type of the elements in the source sequence. + Source sequence. + The source sequence whose outgoing calls to observers are synchronized. + is null. + + + + Wraps the source sequence in order to ensure observer callbacks are synchronized using the specified gate object. + + The type of the elements in the source sequence. + Source sequence. + Gate object to synchronize each observer call on. + The source sequence whose outgoing calls to observers are synchronized on the given gate object. + or is null. + + + + The new ObserveOn operator run with an IScheduler in a lock-free manner. + + + + + The new ObserveOn operator run with an ISchedulerLongRunning in a mostly lock-free manner. + + + + + Represents an object that schedules units of work on a provided . + + + + + Creates an object that schedules units of work on the provided . + + Synchronization context to schedule units of work on. + is null. + + + + Creates an object that schedules units of work on the provided . + + Synchronization context to schedule units of work on. + Configures whether scheduling always posts to the synchronization context, regardless whether the caller is on the same synchronization context. + is null. + + + + Schedules an action to be executed. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Schedules an action to be executed after dueTime. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + Relative time after which to execute the action. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Represents an object that schedules units of work on the Task Parallel Library (TPL) task pool. + + Instance of this type using the default TaskScheduler to schedule work on the TPL task pool. + + + + Creates an object that schedules units of work using the provided . + + Task factory used to create tasks to run units of work. + is null. + + + + Gets an instance of this scheduler that uses the default . + + + + + Schedules an action to be executed. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Schedules an action to be executed after dueTime. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + Relative time after which to execute the action. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Schedules a long-running task by creating a new task using TaskCreationOptions.LongRunning. Cancellation happens through polling. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Gets a new stopwatch object. + + New stopwatch object; started at the time of the request. + + + + Schedules a periodic piece of work by running a platform-specific timer to create tasks periodically. + + The type of the state passed to the scheduled action. + Initial state passed to the action upon the first iteration. + Period for running the work periodically. + Action to be executed, potentially updating the state. + The disposable object used to cancel the scheduled recurring action (best effort). + is null. + is less than . + + + + Represents an object that schedules units of work on the CLR thread pool. + + Singleton instance of this type exposed through this static property. + + + + Gets the singleton instance of the CLR thread pool scheduler. + + + + + Schedules an action to be executed. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Schedules an action to be executed after dueTime, using a System.Threading.Timer object. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + Relative time after which to execute the action. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Schedules a long-running task by creating a new thread. Cancellation happens through polling. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Starts a new stopwatch object. + + New stopwatch object; started at the time of the request. + + + + Schedules a periodic piece of work, using a System.Threading.Timer object. + + The type of the state passed to the scheduled action. + Initial state passed to the action upon the first iteration. + Period for running the work periodically. + Action to be executed, potentially updating the state. + The disposable object used to cancel the scheduled recurring action (best effort). + is null. + is less than zero. + + + + Base class for virtual time schedulers. + + Absolute time representation type. + Relative time representation type. + + + + Creates a new virtual time scheduler with the default value of TAbsolute as the initial clock value. + + + + + Creates a new virtual time scheduler with the specified initial clock value and absolute time comparer. + + Initial value for the clock. + Comparer to determine causality of events based on absolute time. + is null. + + + + Adds a relative time value to an absolute time value. + + Absolute time value. + Relative time value to add. + The resulting absolute time sum value. + + + + Converts the absolute time value to a DateTimeOffset value. + + Absolute time value to convert. + The corresponding DateTimeOffset value. + + + + Converts the TimeSpan value to a relative time value. + + TimeSpan value to convert. + The corresponding relative time value. + + + + Gets whether the scheduler is enabled to run work. + + + + + Gets the comparer used to compare absolute time values. + + + + + Schedules an action to be executed at dueTime. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Absolute time at which to execute the action. + Action to be executed. + The disposable object used to cancel the scheduled action (best effort). + + + + Schedules an action to be executed at dueTime. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Relative time after which to execute the action. + Action to be executed. + The disposable object used to cancel the scheduled action (best effort). + + + + Schedules an action to be executed. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Schedules an action to be executed after dueTime. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Relative time after which to execute the action. + Action to be executed. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Schedules an action to be executed at dueTime. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Absolute time at which to execute the action. + Action to be executed. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Starts the virtual time scheduler. + + + + + Stops the virtual time scheduler. + + + + + Advances the scheduler's clock to the specified time, running all work till that point. + + Absolute time to advance the scheduler's clock to. + is in the past. + The scheduler is already running. VirtualTimeScheduler doesn't support running nested work dispatch loops. To simulate time slippage while running work on the scheduler, use . + + + + Advances the scheduler's clock by the specified relative time, running all work scheduled for that timespan. + + Relative time to advance the scheduler's clock by. + is negative. + The scheduler is already running. VirtualTimeScheduler doesn't support running nested work dispatch loops. To simulate time slippage while running work on the scheduler, use . + + + + Advances the scheduler's clock by the specified relative time. + + Relative time to advance the scheduler's clock by. + is negative. + + + + Gets the scheduler's absolute time clock value. + + + + + Gets the scheduler's notion of current time. + + + + + Gets the next scheduled item to be executed. + + The next scheduled item. + + + + Discovers scheduler services by interface type. The base class implementation supports + only the IStopwatchProvider service. To influence service discovery - such as adding + support for other scheduler services - derived types can override this method. + + Scheduler service interface type to discover. + Object implementing the requested service, if available; null otherwise. + + + + Starts a new stopwatch object. + + New stopwatch object; started at the time of the request. + + + + Base class for virtual time schedulers using a priority queue for scheduled items. + + Absolute time representation type. + Relative time representation type. + + + + Creates a new virtual time scheduler with the default value of TAbsolute as the initial clock value. + + + + + Creates a new virtual time scheduler. + + Initial value for the clock. + Comparer to determine causality of events based on absolute time. + is null. + + + + Gets the next scheduled item to be executed. + + The next scheduled item. + + + + Schedules an action to be executed at dueTime. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + Absolute time at which to execute the action. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Provides a set of extension methods for virtual time scheduling. + + + + + Schedules an action to be executed at . + + Absolute time representation type. + Relative time representation type. + Scheduler to execute the action on. + Relative time after which to execute the action. + Action to be executed. + The disposable object used to cancel the scheduled action (best effort). + or is null. + + + + Schedules an action to be executed at . + + Absolute time representation type. + Relative time representation type. + Scheduler to execute the action on. + Absolute time at which to execute the action. + Action to be executed. + The disposable object used to cancel the scheduled action (best effort). + or is null. + + + + The System.Reactive.Concurrency namespace contains interfaces and classes that provide the scheduler infrastructure used by Reactive Extensions to construct and + process event streams. Schedulers are used to parameterize the concurrency introduced by query operators, provide means to virtualize time, to process historical data, + and to write unit tests for functionality built using Reactive Extensions constructs. + + + + + Represents an object that schedules units of work on the message loop associated with a Windows Forms control. + + + + + Constructs a ControlScheduler that schedules units of work on the message loop associated with the specified Windows Forms control. + + Windows Forms control to get the message loop from. + is null. + + This scheduler type is typically used indirectly through the and method overloads that take a Windows Forms control. + + + + + Gets the control associated with the ControlScheduler. + + + + + Schedules an action to be executed on the message loop associated with the control. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Schedules an action to be executed after dueTime on the message loop associated with the control, using a Windows Forms Timer object. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + Relative time after which to execute the action. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Schedules a periodic piece of work on the message loop associated with the control, using a Windows Forms Timer object. + + The type of the state passed to the scheduled action. + Initial state passed to the action upon the first iteration. + Period for running the work periodically. + Action to be executed, potentially updating the state. + The disposable object used to cancel the scheduled recurring action (best effort). + is null. + is less than one millisecond. + + + + Represents an object that schedules units of work on a . + + + This scheduler type is typically used indirectly through the and methods that use the Dispatcher on the calling thread. + + + + + Gets the scheduler that schedules work on the current . + + + + + Gets the scheduler that schedules work on the for the current thread. + + + + + Constructs a that schedules units of work on the given . + + to schedule work on. + is null. + + + + Constructs a that schedules units of work on the given at the given priority. + + to schedule work on. + Priority at which units of work are scheduled. + is null. + + + + Gets the associated with the . + + + + + Gets the priority at which work items will be dispatched. + + + + + Schedules an action to be executed on the dispatcher. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Schedules an action to be executed after on the dispatcher, using a object. + + The type of the state passed to the scheduled action. + State passed to the action to be executed. + Action to be executed. + Relative time after which to execute the action. + The disposable object used to cancel the scheduled action (best effort). + is null. + + + + Schedules a periodic piece of work on the dispatcher, using a object. + + The type of the state passed to the scheduled action. + Initial state passed to the action upon the first iteration. + Period for running the work periodically. + Action to be executed, potentially updating the state. + The disposable object used to cancel the scheduled recurring action (best effort). + is null. + is less than . + + + + Represents an Action-based disposable. + + + + + Constructs a new disposable with the given action used for disposal. + + Disposal action which will be run upon calling Dispose. + + + + Gets a value that indicates whether the object is disposed. + + + + + Calls the disposal action if and only if the current instance hasn't been disposed yet. + + + + + Represents a Action-based disposable that can hold onto some state. + + + + + Constructs a new disposable with the given action used for disposal. + + The state to be passed to the disposal action. + Disposal action which will be run upon calling Dispose. + + + + Gets a value that indicates whether the object is disposed. + + + + + Calls the disposal action if and only if the current instance hasn't been disposed yet. + + + + + Represents a disposable resource that can be checked for disposal status. + + + + + Initializes a new instance of the class. + + + + + Gets a value that indicates whether the object is disposed. + + + + + Sets the status to disposed, which can be observer through the property. + + + + + Represents a disposable resource that has an associated that will be set to the cancellation requested state upon disposal. + + + + + Initializes a new instance of the class that uses an existing . + + used for cancellation. + is null. + + + + Initializes a new instance of the class that uses a new . + + + + + Gets the used by this . + + + + + Cancels the underlying . + + + + + Gets a value that indicates whether the object is disposed. + + + + + Represents a group of disposable resources that are disposed together. + + + + + Initializes a new instance of the class with no disposables contained by it initially. + + + + + Initializes a new instance of the class with the specified number of disposables. + + The number of disposables that the new CompositeDisposable can initially store. + is less than zero. + + + + Initializes a new instance of the class from a group of disposables. + + Disposables that will be disposed together. + is null. + Any of the disposables in the collection is null. + + + + Initializes a new instance of the class from a group of disposables. + + Disposables that will be disposed together. + is null. + Any of the disposables in the collection is null. + + + + Initialize the inner disposable list and count fields. + + The enumerable sequence of disposables. + The number of items expected from + + + + Gets the number of disposables contained in the . + + + + + Adds a disposable to the or disposes the disposable if the is disposed. + + Disposable to add. + is null. + + + + Removes and disposes the first occurrence of a disposable from the . + + Disposable to remove. + true if found; false otherwise. + is null. + + + + Disposes all disposables in the group and removes them from the group. + + + + + Removes and disposes all disposables from the , but does not dispose the . + + + + + Determines whether the contains a specific disposable. + + Disposable to search for. + true if the disposable was found; otherwise, false. + is null. + + + + Copies the disposables contained in the to an array, starting at a particular array index. + + Array to copy the contained disposables to. + Target index at which to copy the first disposable of the group. + is null. + is less than zero. -or - is larger than or equal to the array length. + + + + Always returns false. + + + + + Returns an enumerator that iterates through the . + + An enumerator to iterate over the disposables. + + + + Returns an enumerator that iterates through the . + + An enumerator to iterate over the disposables. + + + + Gets a value that indicates whether the object is disposed. + + + + + An empty enumerator for the + method to avoid allocation on disposed or empty composites. + + + + + An enumerator for an array of disposables. + + + + + Represents a disposable resource whose disposal invocation will be posted to the specified . + + + + + Initializes a new instance of the class that uses the specified on which to dispose the specified disposable resource. + + Context to perform disposal on. + Disposable whose Dispose operation to run on the given synchronization context. + or is null. + + + + Gets the provided . + + + + + Gets a value that indicates whether the object is disposed. + + + + + Disposes the underlying disposable on the provided . + + + + + Provides a set of static methods for creating objects. + + + + + Represents a disposable that does nothing on disposal. + + + + + Singleton default disposable. + + + + + Does nothing. + + + + + Gets the disposable that does nothing when disposed. + + + + + Creates a disposable object that invokes the specified action when disposed. + + Action to run during the first call to . The action is guaranteed to be run at most once. + The disposable object that runs the given action upon disposal. + is null. + + + + Creates a disposable object that invokes the specified action when disposed. + + The state to be passed to the action. + Action to run during the first call to . The action is guaranteed to be run at most once. + The disposable object that runs the given action upon disposal. + is null. + + + + Gets the value stored in or a null if + was already disposed. + + + + + Gets the value stored in or a no-op-Disposable if + was already disposed. + + + + + Assigns to . + + true if was assigned to and has not + been assigned before. + false if has been already disposed. + has already been assigned a value. + + + + Tries to assign to . + + A value indicating the outcome of the operation. + + + + Tries to assign to . If + is not disposed and is assigned a different value, it will not be disposed. + + true if was successfully assigned to . + false has been disposed. + + + + Tries to assign to . If + is not disposed and is assigned a different value, it will be disposed. + + true if was successfully assigned to . + false has been disposed. + + + + Gets a value indicating whether has been disposed. + + true if has been disposed. + false if has not been disposed. + + + + Tries to dispose . + + true if was not disposed previously and was successfully disposed. + false if was disposed previously. + + + + Disposable resource with disposal state tracking. + + + + + Gets a value that indicates whether the object is disposed. + + + + + Represents a disposable resource whose underlying disposable resource can be swapped for another disposable resource. + + + + + Initializes a new instance of the class with no current underlying disposable. + + + + + Gets a value that indicates whether the object is disposed. + + + + + Gets or sets the underlying disposable. After disposal, the result of getting this property is undefined. + + If the has already been disposed, assignment to this property causes immediate disposal of the given disposable object. + + + + Disposes the underlying disposable as well as all future replacements. + + + + + Represents a disposable resource that only disposes its underlying disposable resource when all dependent disposable objects have been disposed. + + + + + Holds the number of active child disposables and the + indicator bit (31) if the main _disposable has been marked + for disposition. + + + + + Initializes a new instance of the class with the specified disposable. + + Underlying disposable. + is null. + + + + Initializes a new instance of the class with the specified disposable. + + Underlying disposable. + Indicates whether subsequent calls to should throw when this instance is disposed. + is null. + + + + Gets a value that indicates whether the object is disposed. + + + + + Returns a dependent disposable that when disposed decreases the refcount on the underlying disposable. + + A dependent disposable contributing to the reference count that manages the underlying disposable's lifetime. + This instance has been disposed and is configured to throw in this case by . + + + + Disposes the underlying disposable only when all dependent disposables have been disposed. + + + + + Represents a disposable resource whose disposal invocation will be scheduled on the specified . + + + + + Initializes a new instance of the class that uses an on which to dispose the disposable. + + Scheduler where the disposable resource will be disposed on. + Disposable resource to dispose on the given scheduler. + or is null. + + + + Gets the scheduler where the disposable resource will be disposed on. + + + + + Gets the underlying disposable. After disposal, the result is undefined. + + + + + Gets a value that indicates whether the object is disposed. + + + + + Disposes the wrapped disposable on the provided scheduler. + + + + + Represents a disposable resource whose underlying disposable resource can be replaced by another disposable resource, causing automatic disposal of the previous underlying disposable resource. + + + + + Initializes a new instance of the class. + + + + + Gets a value that indicates whether the object is disposed. + + + + + Gets or sets the underlying disposable. + + If the SerialDisposable has already been disposed, assignment to this property causes immediate disposal of the given disposable object. Assigning this property disposes the previous disposable object. + + + + Disposes the underlying disposable as well as all future replacements. + + + + + Represents a disposable resource which only allows a single assignment of its underlying disposable resource. + If an underlying disposable resource has already been set, future attempts to set the underlying disposable resource will throw an . + + + + + Initializes a new instance of the class. + + + + + Gets a value that indicates whether the object is disposed. + + + + + Gets or sets the underlying disposable. After disposal, the result of getting this property is undefined. + + Thrown if the has already been assigned to. + + + + Disposes the underlying disposable. + + + + + Represents a group of disposable resources that are disposed together. + + + + + Creates a new group containing two disposable resources that are disposed together. + + The first disposable resource to add to the group. + The second disposable resource to add to the group. + Group of disposable resources that are disposed together. + + + + Creates a new group of disposable resources that are disposed together. + + Disposable resources to add to the group. + Group of disposable resources that are disposed together. + + + + Creates a group of disposable resources that are disposed together + and without copying or checking for nulls inside the group. + + The array of disposables that is trusted + to not contain nulls and gives no need to defensively copy it. + Group of disposable resources that are disposed together. + + + + Creates a new group of disposable resources that are disposed together. + + Disposable resources to add to the group. + Group of disposable resources that are disposed together. + + + + Disposes all disposables in the group. + + + + + Gets a value that indicates whether the object is disposed. + + + + + A stable composite that doesn't do defensive copy of + the input disposable array nor checks it for null. + + + + + The System.Reactive.Disposables namespace contains interfaces and classes that provide a compositional set of constructs used to deal with resource and subscription + management in Reactive Extensions. Those types are used extensively within the implementation of Reactive Extensions and are useful when writing custom query operators or + schedulers. + + + + + Provides access to the platform enlightenments used by other Rx libraries to improve system performance and + runtime efficiency. While Rx can run without platform enlightenments loaded, it's recommended to deploy the + System.Reactive.PlatformServices assembly with your application and call during + application startup to ensure enlightenments are properly loaded. + + + + + Ensures that the calling assembly has a reference to the System.Reactive.PlatformServices assembly with + platform enlightenments. If no reference is made from the user code, it's possible for the build process + to drop the deployment of System.Reactive.PlatformServices, preventing its runtime discovery. + + + true if the loaded enlightenment provider matches the provided defined in the current assembly; false + otherwise. When a custom enlightenment provider is installed by the host, false will be returned. + + + + + (Infrastructure) Provider for platform-specific framework enlightenments. + + + + + (Infrastructure) Tries to gets the specified service. + + Service type. + Optional set of arguments. + Service instance or null if not found. + + + + (Infrastructure) Services to rethrow exceptions. + + + This type is used by the Rx infrastructure and not meant for public consumption or implementation. + No guarantees are made about forward compatibility of the type's functionality and its usage. + + + + + Rethrows the specified exception. + + Exception to rethrow. + + + + (Infrastructure) Provides access to the host's lifecycle management services. + + + + + Event that gets raised when the host suspends the application. + + + + + Event that gets raised when the host resumes the application. + + + + + Adds a reference to the host lifecycle manager, causing it to be sending notifications. + + + + + Removes a reference to the host lifecycle manager, causing it to stop sending notifications + if the removed reference was the last one. + + + + + (Infrastructure) Provides notifications about the host's lifecycle events. + + + + + Event that gets raised when the host suspends. + + + + + Event that gets raised when the host resumes. + + + + + (Infrastructure) Event arguments for host suspension events. + + + + + (Infrastructure) Event arguments for host resumption events. + + + + + (Infrastructure) Interface for enlightenment providers. + + + This type is used by the Rx infrastructure and not meant for public consumption or implementation. + No guarantees are made about forward compatibility of the type's functionality and its usage. + + + + + (Infrastructure) Tries to gets the specified service. + + Service type. + Optional set of arguments. + Service instance or null if not found. + + + + (Infrastructure) Provider for platform-specific framework enlightenments. + + + This type is used by the Rx infrastructure and not meant for public consumption or implementation. + + + + + (Infrastructure) Gets the current enlightenment provider. If none is loaded yet, accessing this property triggers provider resolution. + + + This member is used by the Rx infrastructure and not meant for public consumption or implementation. + + + + + (Infrastructure) Provides access to local system clock services. + + + This type is used by the Rx infrastructure and not meant for public consumption or implementation. + No guarantees are made about forward compatibility of the type's functionality and its usage. + + + + + Gets the local system clock time. + + + + + Adds a reference to the system clock monitor, causing it to be sending notifications. + + Thrown when the system doesn't support sending clock change notifications. + + + + Removes a reference to the system clock monitor, causing it to stop sending notifications + if the removed reference was the last one. + + + + + (Infrastructure) Provides access to the local system clock. + + + This type is used by the Rx infrastructure and not meant for public consumption or implementation. + No guarantees are made about forward compatibility of the type's functionality and its usage. + + + + + Gets the current time. + + + + + (Infrastructure) Provides a mechanism to notify local schedulers about system clock changes. + + + This type is used by the Rx infrastructure and not meant for public consumption or implementation. + No guarantees are made about forward compatibility of the type's functionality and its usage. + + + + + Event that gets raised when a system clock change is detected. + + + + + (Infrastructure) Event arguments for system clock change notifications. + + + This type is used by the Rx infrastructure and not meant for public consumption or implementation. + No guarantees are made about forward compatibility of the type's functionality and its usage. + + + + + Creates a new system clock notification object with unknown old and new times. + + + + + Creates a new system clock notification object with the specified old and new times. + + Time before the system clock changed, or DateTimeOffset.MinValue if not known. + Time after the system clock changed, or DateTimeOffset.MaxValue if not known. + + + + Gets the time before the system clock changed, or DateTimeOffset.MinValue if not known. + + + + + Gets the time after the system clock changed, or DateTimeOffset.MaxValue if not known. + + + + + (Infrastructure) Provides access to the local system clock. + + + + + Gets the current time. + + + + + (Infrastructure) Monitors for system clock changes based on a periodic timer. + + + + + Use the Unix milliseconds for the current time + so it can be atomically read/written without locking. + + + + + Creates a new monitor for system clock changes with the specified polling frequency. + + Polling frequency for system clock changes. + + + + Event that gets raised when a system clock change is detected. + + + + + The System.Reactive.PlatformServices namespace contains interfaces and classes used by the runtime infrastructure of Reactive Extensions. + Those are not intended to be used directly from user code and are subject to change in future releases of the product. + + + + + Represents a .NET event invocation consisting of the weakly typed object that raised the event and the data that was generated by the event. + + The type of the event data generated by the event. + + + + Creates a new data representation instance of a .NET event invocation with the given sender and event data. + + The sender object that raised the event. + The event data that was generated by the event. + + + + Represents a .NET event invocation consisting of the strongly typed object that raised the event and the data that was generated by the event. + + The type of the sender that raised the event. + The type of the event data generated by the event. + + + + Creates a new data representation instance of a .NET event invocation with the given sender and event data. + + The sender object that raised the event. + The event data that was generated by the event. + + + + Gets the sender object that raised the event. + + + + + Gets the event data that was generated by the event. + + + + + Determines whether the current object represents the same event as a specified object. + + An object to compare to the current object. + true if both objects represent the same event; otherwise, false. + + + + Determines whether the specified System.Object is equal to the current . + + The System.Object to compare with the current . + true if the specified System.Object is equal to the current ; otherwise, false. + + + + Returns the hash code for the current instance. + + A hash code for the current instance. + + + + Determines whether two specified objects represent the same event. + + The first to compare, or null. + The second to compare, or null. + true if both objects represent the same event; otherwise, false. + + + + Determines whether two specified objects represent a different event. + + The first to compare, or null. + The second to compare, or null. + true if both objects don't represent the same event; otherwise, false. + + + + Base class for classes that expose an observable sequence as a well-known event pattern (sender, event arguments). + Contains functionality to maintain a map of event handler delegates to observable sequence subscriptions. Subclasses + should only add an event with custom add and remove methods calling into the base class's operations. + + The type of the sender that raises the event. + The type of the event data generated by the event. + + + + Creates a new event pattern source. + + Source sequence to expose as an event. + Delegate used to invoke the event for each element of the sequence. + or is null. + + + + Adds the specified event handler, causing a subscription to the underlying source. + + Event handler to add. The same delegate should be passed to the operation in order to remove the event handler. + Invocation delegate to raise the event in the derived class. + or is null. + + + + Removes the specified event handler, causing a disposal of the corresponding subscription to the underlying source that was created during the operation. + + Event handler to remove. This should be the same delegate as one that was passed to the operation. + is null. + + + + Marks the program elements that are experimental. This class cannot be inherited. + + + + + Represents a .NET event invocation consisting of the strongly typed object that raised the event and the data that was generated by the event. + + + The type of the sender that raised the event. + This type parameter is covariant. That is, you can use either the type you specified or any type that is more derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics. + + + The type of the event data generated by the event. + This type parameter is covariant. That is, you can use either the type you specified or any type that is more derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics. + + + + + Gets the sender object that raised the event. + + + + + Gets the event data that was generated by the event. + + + + + Represents a data stream signaling its elements by means of an event. + + The type of the event data generated by the event. + + + + Event signaling the next element in the data stream. + + + + + Represents a data stream signaling its elements by means of an event. + + + The type of the event data generated by the event. + This type parameter is covariant. That is, you can use either the type you specified or any type that is more derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics. + + + + + Event signaling the next element in the data stream. + + + + + Utility methods to handle lock-free combining of Exceptions + as well as hosting a terminal-exception indicator for + lock-free termination support. + + + + + The singleton instance of the exception indicating a terminal state, + DO NOT LEAK or signal this via OnError! + + + + + Tries to atomically set the Exception on the given field if it is + still null. + + The target field to try to set atomically. + The exception to set, not null (not verified). + True if the operation succeeded, false if the target was not null. + + + + Atomically swaps in the Terminated exception into the field and + returns the previous exception in that field (which could be the + Terminated instance too). + + The target field to terminate. + The previous exception in that field before the termination. + + + + Atomically sets the field to the given new exception or combines + it with any pre-existing exception as a new AggregateException + unless the field contains the Terminated instance. + + The field to set or combine with. + The exception to combine with. + True if successful, false if the field contains the Terminated instance. + This type of atomic aggregation helps with operators that + want to delay all errors until all of their sources terminate in some way. + + + + The class indicating a terminal state as an Exception type. + + + + + Utility methods for dealing with serializing OnXXX signals + for an IObserver where concurrent OnNext is still not allowed + but concurrent OnError/OnCompleted may happen. + This serialization case is generally lower overhead than + a full SerializedObserver wrapper and doesn't need + allocation. + + + + + Signals the given item to the observer in a serialized fashion + allowing a concurrent OnError or OnCompleted emission to be delayed until + the observer.OnNext returns. + Do not call OnNext from multiple threads as it may lead to ignored items. + Use a full SerializedObserver wrapper for merging multiple sequences. + + The element type of the observer. + The observer to signal events in a serialized fashion. + The item to signal. + Indicates there is an emission going on currently. + The field containing an error or terminal indicator. + + + + Signals the given exception to the observer. If there is a concurrent + OnNext emission is happening, saves the exception into the given field + otherwise to be picked up by . + This method can be called concurrently with itself and the other methods of this + helper class but only one terminal signal may actually win. + + The element type of the observer. + The observer to signal events in a serialized fashion. + The exception to signal sooner or later. + Indicates there is an emission going on currently. + The field containing an error or terminal indicator. + + + + Signals OnCompleted on the observer. If there is a concurrent + OnNext emission happening, the error field will host a special + terminal exception signal to be picked up by once it finishes with OnNext and signal the + OnCompleted as well. + This method can be called concurrently with itself and the other methods of this + helper class but only one terminal signal may actually win. + + The element type of the observer. + The observer to signal events in a serialized fashion. + Indicates there is an emission going on currently. + The field containing an error or terminal indicator. + + + + Base interface for observers that can dispose of a resource on a terminal notification + or when disposed itself. + + + + + + Interface with variance annotation; allows for better type checking when detecting capabilities in SubscribeSafe. + + Type of the resulting sequence's elements. + + + + Base class for implementation of query operators, providing performance benefits over the use of Observable.Create. + + Type of the resulting sequence's elements. + + + + Publicly visible Subscribe method. + + Observer to send notifications on. The implementation of a producer must ensure the correct message grammar on the observer. + IDisposable to cancel the subscription. This causes the underlying sink to be notified of unsubscription, causing it to prevent further messages from being sent to the observer. + + + + Core implementation of the query operator, called upon a new subscription to the producer object. + + Observer to send notifications on. The implementation of a producer must ensure the correct message grammar on the observer. + Disposable representing all the resources and/or subscriptions the operator uses to process events. + The observer passed in to this method is not protected using auto-detach behavior upon an OnError or OnCompleted call. The implementation must ensure proper resource disposal and enforce the message grammar. + + + + Publicly visible Subscribe method. + + Observer to send notifications on. The implementation of a producer must ensure the correct message grammar on the observer. + IDisposable to cancel the subscription. This causes the underlying sink to be notified of unsubscription, causing it to prevent further messages from being sent to the observer. + + + + Core implementation of the query operator, called upon a new subscription to the producer object. + + The sink object. + + + + Represents an observable sequence of elements that have a common key. + + + The type of the key shared by all elements in the group. + This type parameter is covariant. That is, you can use either the type you specified or any type that is more derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics. + + + The type of the elements in the group. + This type parameter is covariant. That is, you can use either the type you specified or any type that is more derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics. + + + + + Gets the common key. + + + + + Provides functionality to evaluate queries against a specific data source wherein the type of the data is known. + + + The type of the data in the data source. + This type parameter is covariant. That is, you can use either the type you specified or any type that is more derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics. + + + + + Provides functionality to evaluate queries against a specific data source wherein the type of the data is not specified. + + + + + Gets the type of the element(s) that are returned when the expression tree associated with this instance of IQbservable is executed. + + + + + Gets the expression tree that is associated with the instance of IQbservable. + + + + + Gets the query provider that is associated with this data source. + + + + + Defines methods to create and execute queries that are described by an IQbservable object. + + + + + Constructs an object that can evaluate the query represented by a specified expression tree. + + The type of the elements of the that is returned. + Expression tree representing the query. + IQbservable object that can evaluate the given query expression. + + + + Internal interface describing the LINQ to Events query language. + + + + + Internal interface describing the LINQ to Events query language. + + + + + Attribute applied to static classes providing expression tree forms of query methods, + mapping those to the corresponding methods for local query execution on the specified + target class type. + + + + + Creates a new mapping to the specified local execution query method implementation type. + + Type with query methods for local execution. + + + + Gets the type with the implementation of local query methods. + + + + + Provides a set of static methods for writing in-memory queries over observable sequences. + + + + + Applies an accumulator function over an observable sequence, returning the result of the aggregation as a single element in the result sequence. The specified seed value is used as the initial accumulator value. + For aggregation behavior with incremental intermediate results, see . + + The type of the elements in the source sequence. + The type of the result of the aggregation. + An observable sequence to aggregate over. + The initial accumulator value. + An accumulator function to be invoked on each element. + An observable sequence containing a single element with the final accumulator value. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Applies an accumulator function over an observable sequence, returning the result of the aggregation as a single element in the result sequence. The specified seed value is used as the initial accumulator value, + and the specified result selector function is used to select the result value. + + The type of the elements in the source sequence. + The type of the accumulator value. + The type of the resulting value. + An observable sequence to aggregate over. + The initial accumulator value. + An accumulator function to be invoked on each element. + A function to transform the final accumulator value into the result value. + An observable sequence containing a single element with the final accumulator value. + or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Applies an accumulator function over an observable sequence, returning the result of the aggregation as a single element in the result sequence. + For aggregation behavior with incremental intermediate results, see . + + The type of the elements in the source sequence and the result of the aggregation. + An observable sequence to aggregate over. + An accumulator function to be invoked on each element. + An observable sequence containing a single element with the final accumulator value. + or is null. + (Asynchronous) The source sequence is empty. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Determines whether all elements of an observable sequence satisfy a condition. + + The type of the elements in the source sequence. + An observable sequence whose elements to apply the predicate to. + A function to test each element for a condition. + An observable sequence containing a single element determining whether all elements in the source sequence pass the test in the specified predicate. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Determines whether an observable sequence contains any elements. + + The type of the elements in the source sequence. + An observable sequence to check for non-emptiness. + An observable sequence containing a single element determining whether the source sequence contains any elements. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Determines whether any element of an observable sequence satisfies a condition. + + The type of the elements in the source sequence. + An observable sequence whose elements to apply the predicate to. + A function to test each element for a condition. + An observable sequence containing a single element determining whether any elements in the source sequence pass the test in the specified predicate. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of values. + + A sequence of values to calculate the average of. + An observable sequence containing a single element with the average of the sequence of values. + is null. + (Asynchronous) The source sequence is empty. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of values. + + A sequence of values to calculate the average of. + An observable sequence containing a single element with the average of the sequence of values. + is null. + (Asynchronous) The source sequence is empty. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of values. + + A sequence of values to calculate the average of. + An observable sequence containing a single element with the average of the sequence of values. + is null. + (Asynchronous) The source sequence is empty. + (Asynchronous) The sum of the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of values. + + A sequence of values to calculate the average of. + An observable sequence containing a single element with the average of the sequence of values. + is null. + (Asynchronous) The source sequence is empty. + (Asynchronous) The sum of the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of values. + + A sequence of values to calculate the average of. + An observable sequence containing a single element with the average of the sequence of values. + is null. + (Asynchronous) The source sequence is empty. + (Asynchronous) The sum of the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of nullable values. + + A sequence of nullable values to calculate the average of. + An observable sequence containing a single element with the average of the sequence of values, or null if the source sequence is empty or contains only values that are null. + is null. + (Asynchronous) The source sequence is empty. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of nullable values. + + A sequence of nullable values to calculate the average of. + An observable sequence containing a single element with the average of the sequence of values, or null if the source sequence is empty or contains only values that are null. + is null. + (Asynchronous) The source sequence is empty. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of nullable values. + + A sequence of nullable values to calculate the average of. + An observable sequence containing a single element with the average of the sequence of values, or null if the source sequence is empty or contains only values that are null. + is null. + (Asynchronous) The source sequence is empty. + (Asynchronous) The sum of the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of nullable values. + + A sequence of nullable values to calculate the average of. + An observable sequence containing a single element with the average of the sequence of values, or null if the source sequence is empty or contains only values that are null. + is null. + (Asynchronous) The source sequence is empty. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + (Asynchronous) The sum of the elements in the source sequence is larger than . + + + + Computes the average of an observable sequence of nullable values. + + A sequence of nullable values to calculate the average of. + An observable sequence containing a single element with the average of the sequence of values, or null if the source sequence is empty or contains only values that are null. + is null. + (Asynchronous) The source sequence is empty. + (Asynchronous) The sum of the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values to calculate the average of. + A transform function to apply to each element. + An observable sequence containing a single element with the average of the sequence of values. + or is null. + (Asynchronous) The source sequence is empty. + (Asynchronous) The sum of the projected values for the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values to calculate the average of. + A transform function to apply to each element. + An observable sequence containing a single element with the average of the sequence of values. + or is null. + (Asynchronous) The source sequence is empty. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values to calculate the average of. + A transform function to apply to each element. + An observable sequence containing a single element with the average of the sequence of values. + or is null. + (Asynchronous) The source sequence is empty. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values to calculate the average of. + A transform function to apply to each element. + An observable sequence containing a single element with the average of the sequence of values. + or is null. + (Asynchronous) The source sequence is empty. + (Asynchronous) The sum of the projected values for the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values to calculate the average of. + A transform function to apply to each element. + An observable sequence containing a single element with the average of the sequence of values. + or is null. + (Asynchronous) The source sequence is empty. + (Asynchronous) The sum of the projected values for the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of nullable values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values to calculate the average of. + A transform function to apply to each element. + An observable sequence containing a single element with the average of the sequence of values, or null if the source sequence is empty or contains only values that are null. + or is null. + (Asynchronous) The source sequence is empty. + (Asynchronous) The sum of the projected values for the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of nullable values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values to calculate the average of. + A transform function to apply to each element. + An observable sequence containing a single element with the average of the sequence of values, or null if the source sequence is empty or contains only values that are null. + or is null. + (Asynchronous) The source sequence is empty. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of nullable values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values to calculate the average of. + A transform function to apply to each element. + An observable sequence containing a single element with the average of the sequence of values, or null if the source sequence is empty or contains only values that are null. + or is null. + (Asynchronous) The source sequence is empty. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of nullable values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values to calculate the average of. + A transform function to apply to each element. + An observable sequence containing a single element with the average of the sequence of values, or null if the source sequence is empty or contains only values that are null. + or is null. + (Asynchronous) The source sequence is empty. + (Asynchronous) The sum of the projected values for the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of nullable values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values to calculate the average of. + A transform function to apply to each element. + An observable sequence containing a single element with the average of the sequence of values, or null if the source sequence is empty or contains only values that are null. + or is null. + (Asynchronous) The source sequence is empty. + (Asynchronous) The sum of the projected values for the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Determines whether an observable sequence contains a specified element by using the default equality comparer. + + The type of the elements in the source sequence. + An observable sequence in which to locate a value. + The value to locate in the source sequence. + An observable sequence containing a single element determining whether the source sequence contains an element that has the specified value. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Determines whether an observable sequence contains a specified element by using a specified System.Collections.Generic.IEqualityComparer{T}. + + The type of the elements in the source sequence. + An observable sequence in which to locate a value. + The value to locate in the source sequence. + An equality comparer to compare elements. + An observable sequence containing a single element determining whether the source sequence contains an element that has the specified value. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns an observable sequence containing an that represents the total number of elements in an observable sequence. + + The type of the elements in the source sequence. + An observable sequence that contains elements to be counted. + An observable sequence containing a single element with the number of elements in the input sequence. + is null. + (Asynchronous) The number of elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns an observable sequence containing an that represents how many elements in the specified observable sequence satisfy a condition. + + The type of the elements in the source sequence. + An observable sequence that contains elements to be counted. + A function to test each element for a condition. + An observable sequence containing a single element with a number that represents how many elements in the input sequence satisfy the condition in the predicate function. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the element at a specified index in a sequence. + + The type of the elements in the source sequence. + Observable sequence to return the element from. + The zero-based index of the element to retrieve. + An observable sequence that produces the element at the specified position in the source sequence. + is null. + is less than zero. + (Asynchronous) is greater than or equal to the number of elements in the source sequence. + + + + Returns the element at a specified index in a sequence or a default value if the index is out of range. + + The type of the elements in the source sequence. + Observable sequence to return the element from. + The zero-based index of the element to retrieve. + An observable sequence that produces the element at the specified position in the source sequence, or a default value if the index is outside the bounds of the source sequence. + is null. + is less than zero. + + + + Returns the first element of an observable sequence. + + The type of the elements in the source sequence. + Source observable sequence. + Sequence containing the first element in the observable sequence. + is null. + (Asynchronous) The source sequence is empty. + + + + Returns the first element of an observable sequence that satisfies the condition in the predicate. + + The type of the elements in the source sequence. + Source observable sequence. + A predicate function to evaluate for elements in the source sequence. + Sequence containing the first element in the observable sequence that satisfies the condition in the predicate. + or is null. + (Asynchronous) No element satisfies the condition in the predicate. -or- The source sequence is empty. + + + + Returns the first element of an observable sequence, or a default value if no such element exists. + + The type of the elements in the source sequence. + Source observable sequence. + Sequence containing the first element in the observable sequence, or a default value if no such element exists. + is null. + + + + Returns the first element of an observable sequence that satisfies the condition in the predicate, or a default value if no such element exists. + + The type of the elements in the source sequence. + Source observable sequence. + A predicate function to evaluate for elements in the source sequence. + Sequence containing the first element in the observable sequence that satisfies the condition in the predicate, or a default value if no such element exists. + or is null. + + + + Determines whether an observable sequence is empty. + + The type of the elements in the source sequence. + An observable sequence to check for emptiness. + An observable sequence containing a single element determining whether the source sequence is empty. + is null. + + + + Returns the last element of an observable sequence. + + The type of the elements in the source sequence. + Source observable sequence. + Sequence containing the last element in the observable sequence. + is null. + (Asynchronous) The source sequence is empty. + + + + Returns the last element of an observable sequence that satisfies the condition in the predicate. + + The type of the elements in the source sequence. + Source observable sequence. + A predicate function to evaluate for elements in the source sequence. + Sequence containing the last element in the observable sequence that satisfies the condition in the predicate. + or is null. + (Asynchronous) No element satisfies the condition in the predicate. -or- The source sequence is empty. + + + + Returns the last element of an observable sequence, or a default value if no such element exists. + + The type of the elements in the source sequence. + Source observable sequence. + Sequence containing the last element in the observable sequence, or a default value if no such element exists. + is null. + + + + Returns the last element of an observable sequence that satisfies the condition in the predicate, or a default value if no such element exists. + + The type of the elements in the source sequence. + Source observable sequence. + A predicate function to evaluate for elements in the source sequence. + Sequence containing the last element in the observable sequence that satisfies the condition in the predicate, or a default value if no such element exists. + or is null. + + + + Returns an observable sequence containing an that represents the total number of elements in an observable sequence. + + The type of the elements in the source sequence. + An observable sequence that contains elements to be counted. + An observable sequence containing a single element with the number of elements in the input sequence. + is null. + (Asynchronous) The number of elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns an observable sequence containing an that represents how many elements in the specified observable sequence satisfy a condition. + + The type of the elements in the source sequence. + An observable sequence that contains elements to be counted. + A function to test each element for a condition. + An observable sequence containing a single element with a number that represents how many elements in the input sequence satisfy the condition in the predicate function. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the maximum element in an observable sequence. + + The type of the elements in the source sequence. + An observable sequence to determine the maximum element of. + An observable sequence containing a single element with the maximum element in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the maximum value in an observable sequence according to the specified comparer. + + The type of the elements in the source sequence. + An observable sequence to determine the maximum element of. + Comparer used to compare elements. + An observable sequence containing a single element with the maximum element in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the maximum value in an observable sequence of values. + + A sequence of values to determine the maximum value of. + An observable sequence containing a single element with the maximum value in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the maximum value in an observable sequence of values. + + A sequence of values to determine the maximum value of. + An observable sequence containing a single element with the maximum value in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the maximum value in an observable sequence of values. + + A sequence of values to determine the maximum value of. + An observable sequence containing a single element with the maximum value in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the maximum value in an observable sequence of values. + + A sequence of values to determine the maximum value of. + An observable sequence containing a single element with the maximum value in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the maximum value in an observable sequence of values. + + A sequence of values to determine the maximum value of. + An observable sequence containing a single element with the maximum value in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the maximum value in an observable sequence of nullable values. + + A sequence of nullable values to determine the maximum value of. + An observable sequence containing a single element with the maximum value in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the maximum value in an observable sequence of nullable values. + + A sequence of nullable values to determine the maximum value of. + An observable sequence containing a single element with the maximum value in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the maximum value in an observable sequence of nullable values. + + A sequence of nullable values to determine the maximum value of. + An observable sequence containing a single element with the maximum value in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the maximum value in an observable sequence of nullable values. + + A sequence of nullable values to determine the maximum value of. + An observable sequence containing a single element with the maximum value in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the maximum value in an observable sequence of nullable values. + + A sequence of nullable values to determine the maximum value of. + An observable sequence containing a single element with the maximum value in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the maximum value. + + The type of the elements in the source sequence. + The type of the objects derived from the elements in the source sequence to determine the maximum of. + An observable sequence to determine the minimum element of. + A transform function to apply to each element. + An observable sequence containing a single element with the value that corresponds to the maximum element in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the maximum value according to the specified comparer. + + The type of the elements in the source sequence. + The type of the objects derived from the elements in the source sequence to determine the maximum of. + An observable sequence to determine the minimum element of. + A transform function to apply to each element. + Comparer used to compare elements. + An observable sequence containing a single element with the value that corresponds to the maximum element in the source sequence. + or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the maximum value. + + The type of the elements in the source sequence. + A sequence of values to determine the maximum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the maximum value in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the maximum value. + + The type of the elements in the source sequence. + A sequence of values to determine the maximum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the maximum value in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the maximum value. + + The type of the elements in the source sequence. + A sequence of values to determine the maximum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the maximum value in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the maximum value. + + The type of the elements in the source sequence. + A sequence of values to determine the maximum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the maximum value in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the maximum value. + + The type of the elements in the source sequence. + A sequence of values to determine the maximum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the maximum value in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the maximum nullable value. + + The type of the elements in the source sequence. + A sequence of values to determine the maximum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the maximum value in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the maximum nullable value. + + The type of the elements in the source sequence. + A sequence of values to determine the maximum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the maximum value in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the maximum nullable value. + + The type of the elements in the source sequence. + A sequence of values to determine the maximum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the maximum value in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the maximum nullable value. + + The type of the elements in the source sequence. + A sequence of values to determine the maximum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the maximum value in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the maximum nullable value. + + The type of the elements in the source sequence. + A sequence of values to determine the maximum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the maximum value in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the elements in an observable sequence with the maximum key value. + + The type of the elements in the source sequence. + The type of the key computed for each element in the source sequence. + An observable sequence to get the maximum elements for. + Key selector function. + An observable sequence containing a list of zero or more elements that have a maximum key value. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the elements in an observable sequence with the maximum key value according to the specified comparer. + + The type of the elements in the source sequence. + The type of the key computed for each element in the source sequence. + An observable sequence to get the maximum elements for. + Key selector function. + Comparer used to compare key values. + An observable sequence containing a list of zero or more elements that have a maximum key value. + or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the minimum element in an observable sequence. + + The type of the elements in the source sequence. + An observable sequence to determine the minimum element of. + An observable sequence containing a single element with the minimum element in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the minimum element in an observable sequence according to the specified comparer. + + The type of the elements in the source sequence. + An observable sequence to determine the minimum element of. + Comparer used to compare elements. + An observable sequence containing a single element with the minimum element in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the minimum value in an observable sequence of values. + + A sequence of values to determine the minimum value of. + An observable sequence containing a single element with the minimum value in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the minimum value in an observable sequence of values. + + A sequence of values to determine the minimum value of. + An observable sequence containing a single element with the minimum value in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the minimum value in an observable sequence of values. + + A sequence of values to determine the minimum value of. + An observable sequence containing a single element with the minimum value in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the minimum value in an observable sequence of values. + + A sequence of values to determine the minimum value of. + An observable sequence containing a single element with the minimum value in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the minimum value in an observable sequence of values. + + A sequence of values to determine the minimum value of. + An observable sequence containing a single element with the minimum value in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the minimum value in an observable sequence of nullable values. + + A sequence of nullable values to determine the minimum value of. + An observable sequence containing a single element with the minimum value in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the minimum value in an observable sequence of nullable values. + + A sequence of nullable values to determine the minimum value of. + An observable sequence containing a single element with the minimum value in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the minimum value in an observable sequence of nullable values. + + A sequence of nullable values to determine the minimum value of. + An observable sequence containing a single element with the minimum value in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the minimum value in an observable sequence of nullable values. + + A sequence of nullable values to determine the minimum value of. + An observable sequence containing a single element with the minimum value in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the minimum value in an observable sequence of nullable values. + + A sequence of nullable values to determine the minimum value of. + An observable sequence containing a single element with the minimum value in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the minimum value. + + The type of the elements in the source sequence. + The type of the objects derived from the elements in the source sequence to determine the minimum of. + An observable sequence to determine the minimum element of. + A transform function to apply to each element. + An observable sequence containing a single element with the value that corresponds to the minimum element in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the minimum value according to the specified comparer. + + The type of the elements in the source sequence. + The type of the objects derived from the elements in the source sequence to determine the minimum of. + An observable sequence to determine the minimum element of. + A transform function to apply to each element. + Comparer used to compare elements. + An observable sequence containing a single element with the value that corresponds to the minimum element in the source sequence. + or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the minimum value. + + The type of the elements in the source sequence. + A sequence of values to determine the minimum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the minimum value in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the minimum value. + + The type of the elements in the source sequence. + A sequence of values to determine the minimum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the minimum value in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the minimum value. + + The type of the elements in the source sequence. + A sequence of values to determine the minimum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the minimum value in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the minimum value. + + The type of the elements in the source sequence. + A sequence of values to determine the minimum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the minimum value in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the minimum value. + + The type of the elements in the source sequence. + A sequence of values to determine the minimum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the minimum value in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the minimum nullable value. + + The type of the elements in the source sequence. + A sequence of values to determine the minimum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the minimum value in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the minimum nullable value. + + The type of the elements in the source sequence. + A sequence of values to determine the minimum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the minimum value in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the minimum nullable value. + + The type of the elements in the source sequence. + A sequence of values to determine the minimum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the minimum value in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the minimum nullable value. + + The type of the elements in the source sequence. + A sequence of values to determine the minimum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the minimum value in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the minimum nullable value. + + The type of the elements in the source sequence. + A sequence of values to determine the minimum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the minimum value in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the elements in an observable sequence with the minimum key value. + + The type of the elements in the source sequence. + The type of the key computed for each element in the source sequence. + An observable sequence to get the minimum elements for. + Key selector function. + An observable sequence containing a list of zero or more elements that have a minimum key value. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the elements in an observable sequence with the minimum key value according to the specified comparer. + + The type of the elements in the source sequence. + The type of the key computed for each element in the source sequence. + An observable sequence to get the minimum elements for. + Key selector function. + Comparer used to compare key values. + An observable sequence containing a list of zero or more elements that have a minimum key value. + or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Determines whether two sequences are equal by comparing the elements pairwise. + + The type of the elements in the source sequence. + First observable sequence to compare. + Second observable sequence to compare. + An observable sequence that contains a single element which indicates whether both sequences are of equal length and their corresponding elements are equal according to the default equality comparer for their type. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Determines whether two sequences are equal by comparing the elements pairwise using a specified equality comparer. + + The type of the elements in the source sequence. + First observable sequence to compare. + Second observable sequence to compare. + Comparer used to compare elements of both sequences. + An observable sequence that contains a single element which indicates whether both sequences are of equal length and their corresponding elements are equal according to the specified equality comparer. + or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Determines whether an observable and enumerable sequence are equal by comparing the elements pairwise. + + The type of the elements in the source sequence. + First observable sequence to compare. + Second observable sequence to compare. + An observable sequence that contains a single element which indicates whether both sequences are of equal length and their corresponding elements are equal according to the default equality comparer for their type. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Determines whether an observable and enumerable sequence are equal by comparing the elements pairwise using a specified equality comparer. + + The type of the elements in the source sequence. + First observable sequence to compare. + Second observable sequence to compare. + Comparer used to compare elements of both sequences. + An observable sequence that contains a single element which indicates whether both sequences are of equal length and their corresponding elements are equal according to the specified equality comparer. + or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the only element of an observable sequence, and reports an exception if there is not exactly one element in the observable sequence. + + The type of the elements in the source sequence. + Source observable sequence. + Sequence containing the single element in the observable sequence. + is null. + (Asynchronous) The source sequence contains more than one element. -or- The source sequence is empty. + + + + Returns the only element of an observable sequence that satisfies the condition in the predicate, and reports an exception if there is not exactly one element in the observable sequence. + + The type of the elements in the source sequence. + Source observable sequence. + A predicate function to evaluate for elements in the source sequence. + Sequence containing the single element in the observable sequence that satisfies the condition in the predicate. + or is null. + (Asynchronous) No element satisfies the condition in the predicate. -or- More than one element satisfies the condition in the predicate. -or- The source sequence is empty. + + + + Returns the only element of an observable sequence, or a default value if the observable sequence is empty; this method reports an exception if there is more than one element in the observable sequence. + + The type of the elements in the source sequence. + Source observable sequence. + Sequence containing the single element in the observable sequence, or a default value if no such element exists. + is null. + (Asynchronous) The source sequence contains more than one element. + + + + Returns the only element of an observable sequence that matches the predicate, or a default value if no such element exists; this method reports an exception if there is more than one element in the observable sequence. + + The type of the elements in the source sequence. + Source observable sequence. + A predicate function to evaluate for elements in the source sequence. + Sequence containing the single element in the observable sequence that satisfies the condition in the predicate, or a default value if no such element exists. + or is null. + (Asynchronous) The sequence contains more than one element that satisfies the condition in the predicate. + + + + Computes the sum of a sequence of values. + + A sequence of values to calculate the sum of. + An observable sequence containing a single element with the sum of the values in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of values. + + A sequence of values to calculate the sum of. + An observable sequence containing a single element with the sum of the values in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of values. + + A sequence of values to calculate the sum of. + An observable sequence containing a single element with the sum of the values in the source sequence. + is null. + (Asynchronous) The sum of the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of values. + + A sequence of values to calculate the sum of. + An observable sequence containing a single element with the sum of the values in the source sequence. + is null. + (Asynchronous) The sum of the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of values. + + A sequence of values to calculate the sum of. + An observable sequence containing a single element with the sum of the values in the source sequence. + is null. + (Asynchronous) The sum of the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of nullable values. + + A sequence of nullable values to calculate the sum of. + An observable sequence containing a single element with the sum of the values in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of nullable values. + + A sequence of nullable values to calculate the sum of. + An observable sequence containing a single element with the sum of the values in the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of nullable values. + + A sequence of nullable values to calculate the sum of. + An observable sequence containing a single element with the sum of the values in the source sequence. + is null. + (Asynchronous) The sum of the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of nullable values. + + A sequence of nullable values to calculate the sum of. + An observable sequence containing a single element with the sum of the values in the source sequence. + is null. + (Asynchronous) The sum of the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of nullable values. + + A sequence of nullable values to calculate the sum of. + An observable sequence containing a single element with the sum of the values in the source sequence. + is null. + (Asynchronous) The sum of the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values that are used to calculate a sum. + A transform function to apply to each element. + An observable sequence containing a single element with the sum of the values in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values that are used to calculate a sum. + A transform function to apply to each element. + An observable sequence containing a single element with the sum of the values in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values that are used to calculate a sum. + A transform function to apply to each element. + An observable sequence containing a single element with the sum of the values in the source sequence. + or is null. + (Asynchronous) The sum of the projected values for the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values that are used to calculate a sum. + A transform function to apply to each element. + An observable sequence containing a single element with the sum of the values in the source sequence. + or is null. + (Asynchronous) The sum of the projected values for the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values that are used to calculate a sum. + A transform function to apply to each element. + An observable sequence containing a single element with the sum of the values in the source sequence. + or is null. + (Asynchronous) The sum of the projected values for the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of nullable values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values that are used to calculate a sum. + A transform function to apply to each element. + An observable sequence containing a single element with the sum of the values in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of nullable values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values that are used to calculate a sum. + A transform function to apply to each element. + An observable sequence containing a single element with the sum of the values in the source sequence. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of nullable values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values that are used to calculate a sum. + A transform function to apply to each element. + An observable sequence containing a single element with the sum of the values in the source sequence. + or is null. + (Asynchronous) The sum of the projected values for the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of nullable values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values that are used to calculate a sum. + A transform function to apply to each element. + An observable sequence containing a single element with the sum of the values in the source sequence. + or is null. + (Asynchronous) The sum of the projected values for the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of nullable values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values that are used to calculate a sum. + A transform function to apply to each element. + An observable sequence containing a single element with the sum of the values in the source sequence. + or is null. + (Asynchronous) The sum of the projected values for the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Creates an array from an observable sequence. + + The type of the elements in the source sequence. + The source observable sequence to get an array of elements for. + An observable sequence containing a single element with an array containing all the elements of the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Creates a dictionary from an observable sequence according to a specified key selector function. + + The type of the elements in the source sequence. + The type of the dictionary key computed for each element in the source sequence. + An observable sequence to create a dictionary for. + A function to extract a key from each element. + An observable sequence containing a single element with a dictionary mapping unique key values onto the corresponding source sequence's element. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Creates a dictionary from an observable sequence according to a specified key selector function, and a comparer. + + The type of the elements in the source sequence. + The type of the dictionary key computed for each element in the source sequence. + An observable sequence to create a dictionary for. + A function to extract a key from each element. + An equality comparer to compare keys. + An observable sequence containing a single element with a dictionary mapping unique key values onto the corresponding source sequence's element. + or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Creates a dictionary from an observable sequence according to a specified key selector function, and an element selector function. + + The type of the elements in the source sequence. + The type of the dictionary key computed for each element in the source sequence. + The type of the dictionary value computed for each element in the source sequence. + An observable sequence to create a dictionary for. + A function to extract a key from each element. + A transform function to produce a result element value from each element. + An observable sequence containing a single element with a dictionary mapping unique key values onto the corresponding source sequence's element. + or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Creates a dictionary from an observable sequence according to a specified key selector function, a comparer, and an element selector function. + + The type of the elements in the source sequence. + The type of the dictionary key computed for each element in the source sequence. + The type of the dictionary value computed for each element in the source sequence. + An observable sequence to create a dictionary for. + A function to extract a key from each element. + A transform function to produce a result element value from each element. + An equality comparer to compare keys. + An observable sequence containing a single element with a dictionary mapping unique key values onto the corresponding source sequence's element. + or or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Creates a list from an observable sequence. + + The type of the elements in the source sequence. + The source observable sequence to get a list of elements for. + An observable sequence containing a single element with a list containing all the elements of the source sequence. + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Creates a lookup from an observable sequence according to a specified key selector function. + + The type of the elements in the source sequence. + The type of the lookup key computed for each element in the source sequence. + An observable sequence to create a lookup for. + A function to extract a key from each element. + An observable sequence containing a single element with a lookup mapping unique key values onto the corresponding source sequence's elements. + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Creates a lookup from an observable sequence according to a specified key selector function, and a comparer. + + The type of the elements in the source sequence. + The type of the lookup key computed for each element in the source sequence. + An observable sequence to create a lookup for. + A function to extract a key from each element. + An equality comparer to compare keys. + An observable sequence containing a single element with a lookup mapping unique key values onto the corresponding source sequence's elements. + or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Creates a lookup from an observable sequence according to a specified key selector function, and an element selector function. + + The type of the elements in the source sequence. + The type of the lookup key computed for each element in the source sequence. + The type of the lookup value computed for each element in the source sequence. + An observable sequence to create a lookup for. + A function to extract a key from each element. + A transform function to produce a result element value from each element. + An observable sequence containing a single element with a lookup mapping unique key values onto the corresponding source sequence's elements. + or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Creates a lookup from an observable sequence according to a specified key selector function, a comparer, and an element selector function. + + The type of the elements in the source sequence. + The type of the lookup key computed for each element in the source sequence. + The type of the lookup value computed for each element in the source sequence. + An observable sequence to create a lookup for. + A function to extract a key from each element. + A transform function to produce a result element value from each element. + An equality comparer to compare keys. + An observable sequence containing a single element with a lookup mapping unique key values onto the corresponding source sequence's elements. + or or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the ninth argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the ninth argument passed to the begin delegate. + The type of the tenth argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the ninth argument passed to the begin delegate. + The type of the tenth argument passed to the begin delegate. + The type of the eleventh argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the ninth argument passed to the begin delegate. + The type of the tenth argument passed to the begin delegate. + The type of the eleventh argument passed to the begin delegate. + The type of the twelfth argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the ninth argument passed to the begin delegate. + The type of the tenth argument passed to the begin delegate. + The type of the eleventh argument passed to the begin delegate. + The type of the twelfth argument passed to the begin delegate. + The type of the thirteenth argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the ninth argument passed to the begin delegate. + The type of the tenth argument passed to the begin delegate. + The type of the eleventh argument passed to the begin delegate. + The type of the twelfth argument passed to the begin delegate. + The type of the thirteenth argument passed to the begin delegate. + The type of the fourteenth argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the ninth argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the ninth argument passed to the begin delegate. + The type of the tenth argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the ninth argument passed to the begin delegate. + The type of the tenth argument passed to the begin delegate. + The type of the eleventh argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the ninth argument passed to the begin delegate. + The type of the tenth argument passed to the begin delegate. + The type of the eleventh argument passed to the begin delegate. + The type of the twelfth argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the ninth argument passed to the begin delegate. + The type of the tenth argument passed to the begin delegate. + The type of the eleventh argument passed to the begin delegate. + The type of the twelfth argument passed to the begin delegate. + The type of the thirteenth argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the ninth argument passed to the begin delegate. + The type of the tenth argument passed to the begin delegate. + The type of the eleventh argument passed to the begin delegate. + The type of the twelfth argument passed to the begin delegate. + The type of the thirteenth argument passed to the begin delegate. + The type of the fourteenth argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Invokes the specified function asynchronously, surfacing the result through an observable sequence. + + The type of the result returned by the function. + Function to run asynchronously. + An observable sequence exposing the function's result value, or an exception. + is null. + + + The function is called immediately, not during the subscription of the resulting sequence. + Multiple subscriptions to the resulting sequence can observe the function's result. + + + + + + Invokes the specified function asynchronously on the specified scheduler, surfacing the result through an observable sequence + + The type of the result returned by the function. + Function to run asynchronously. + Scheduler to run the function on. + An observable sequence exposing the function's result value, or an exception. + or is null. + + + The function is called immediately, not during the subscription of the resulting sequence. + Multiple subscriptions to the resulting sequence can observe the function's result. + + + + + + Invokes the asynchronous function, surfacing the result through an observable sequence. + + The type of the result returned by the asynchronous function. + Asynchronous function to run. + An observable sequence exposing the function's result value, or an exception. + is null. + + + The function is started immediately, not during the subscription of the resulting sequence. + Multiple subscriptions to the resulting sequence can observe the function's result. + + + + + + Invokes the asynchronous function, surfacing the result through an observable sequence. + + The type of the result returned by the asynchronous function. + Asynchronous function to run. + Scheduler on which to notify observers. + An observable sequence exposing the function's result value, or an exception. + is null or is null. + + + The function is started immediately, not during the subscription of the resulting sequence. + Multiple subscriptions to the resulting sequence can observe the function's result. + + + + + + Invokes the asynchronous function, surfacing the result through an observable sequence. + The CancellationToken is shared by all subscriptions on the resulting observable sequence. See the remarks section for more information. + + The type of the result returned by the asynchronous function. + Asynchronous function to run. + An observable sequence exposing the function's result value, or an exception. + is null. + + + The function is started immediately, not during the subscription of the resulting sequence. + Multiple subscriptions to the resulting sequence can observe the function's result. + + If any subscription to the resulting sequence is disposed, the CancellationToken is set. The observer associated to the disposed + subscription won't see the TaskCanceledException, but other observers will. You can protect against this using the Catch operator. + Be careful when handing out the resulting sequence because of this behavior. The most common use is to have a single subscription + to the resulting sequence, which controls the CancellationToken state. Alternatively, you can control subscription behavior using + multicast operators. + + + + + + + Invokes the asynchronous function, surfacing the result through an observable sequence. + The CancellationToken is shared by all subscriptions on the resulting observable sequence. See the remarks section for more information. + + The type of the result returned by the asynchronous function. + Asynchronous function to run. + Scheduler on which to notify observers. + An observable sequence exposing the function's result value, or an exception. + is null or is null. + + + The function is started immediately, not during the subscription of the resulting sequence. + Multiple subscriptions to the resulting sequence can observe the function's result. + + If any subscription to the resulting sequence is disposed, the CancellationToken is set. The observer associated to the disposed + subscription won't see the TaskCanceledException, but other observers will. You can protect against this using the Catch operator. + Be careful when handing out the resulting sequence because of this behavior. The most common use is to have a single subscription + to the resulting sequence, which controls the CancellationToken state. Alternatively, you can control subscription behavior using + multicast operators. + + + + + + + Invokes the action asynchronously, surfacing the result through an observable sequence. + + Action to run asynchronously. + An observable sequence exposing a Unit value upon completion of the action, or an exception. + is null. + + + The action is called immediately, not during the subscription of the resulting sequence. + Multiple subscriptions to the resulting sequence can observe the action's outcome. + + + + + + Invokes the action asynchronously on the specified scheduler, surfacing the result through an observable sequence. + + Action to run asynchronously. + Scheduler to run the action on. + An observable sequence exposing a Unit value upon completion of the action, or an exception. + or is null. + + + The action is called immediately, not during the subscription of the resulting sequence. + Multiple subscriptions to the resulting sequence can observe the action's outcome. + + + + + + Invokes the asynchronous action, surfacing the result through an observable sequence. + + Asynchronous action to run. + An observable sequence exposing a Unit value upon completion of the action, or an exception. + is null. + + + The action is started immediately, not during the subscription of the resulting sequence. + Multiple subscriptions to the resulting sequence can observe the action's outcome. + + + + + + Invokes the asynchronous action, surfacing the result through an observable sequence. + + Asynchronous action to run. + Scheduler on which to notify observers. + An observable sequence exposing a Unit value upon completion of the action, or an exception. + is null or is null. + + + The action is started immediately, not during the subscription of the resulting sequence. + Multiple subscriptions to the resulting sequence can observe the action's outcome. + + + + + + Invokes the asynchronous action, surfacing the result through an observable sequence. + The CancellationToken is shared by all subscriptions on the resulting observable sequence. See the remarks section for more information. + + Asynchronous action to run. + An observable sequence exposing a Unit value upon completion of the action, or an exception. + is null. + + + The action is started immediately, not during the subscription of the resulting sequence. + Multiple subscriptions to the resulting sequence can observe the action's outcome. + + If any subscription to the resulting sequence is disposed, the CancellationToken is set. The observer associated to the disposed + subscription won't see the TaskCanceledException, but other observers will. You can protect against this using the Catch operator. + Be careful when handing out the resulting sequence because of this behavior. The most common use is to have a single subscription + to the resulting sequence, which controls the CancellationToken state. Alternatively, you can control subscription behavior using + multicast operators. + + + + + + + Invokes the asynchronous action, surfacing the result through an observable sequence. + The CancellationToken is shared by all subscriptions on the resulting observable sequence. See the remarks section for more information. + + Asynchronous action to run. + Scheduler on which to notify observers. + An observable sequence exposing a Unit value upon completion of the action, or an exception. + is null or is null. + + + The action is started immediately, not during the subscription of the resulting sequence. + Multiple subscriptions to the resulting sequence can observe the action's outcome. + + If any subscription to the resulting sequence is disposed, the CancellationToken is set. The observer associated to the disposed + subscription won't see the TaskCanceledException, but other observers will. You can protect against this using the Catch operator. + Be careful when handing out the resulting sequence because of this behavior. The most common use is to have a single subscription + to the resulting sequence, which controls the CancellationToken state. Alternatively, you can control subscription behavior using + multicast operators. + + + + + + + Converts to asynchronous function into an observable sequence. Each subscription to the resulting sequence causes the function to be started. + + The type of the result returned by the asynchronous function. + Asynchronous function to convert. + An observable sequence exposing the result of invoking the function, or an exception. + is null. + + + + Converts to asynchronous function into an observable sequence. Each subscription to the resulting sequence causes the function to be started. + + The type of the result returned by the asynchronous function. + Asynchronous function to convert. + Scheduler on which to notify observers. + An observable sequence exposing the result of invoking the function, or an exception. + is null or is null. + + + + Converts to asynchronous function into an observable sequence. Each subscription to the resulting sequence causes the function to be started. + The CancellationToken passed to the asynchronous function is tied to the observable sequence's subscription that triggered the function's invocation and can be used for best-effort cancellation. + + The type of the result returned by the asynchronous function. + Asynchronous function to convert. + An observable sequence exposing the result of invoking the function, or an exception. + is null. + When a subscription to the resulting sequence is disposed, the CancellationToken that was fed to the asynchronous function will be signaled. + + + + Converts to asynchronous function into an observable sequence. Each subscription to the resulting sequence causes the function to be started. + The CancellationToken passed to the asynchronous function is tied to the observable sequence's subscription that triggered the function's invocation and can be used for best-effort cancellation. + + The type of the result returned by the asynchronous function. + Asynchronous function to convert. + Scheduler on which to notify observers. + An observable sequence exposing the result of invoking the function, or an exception. + is null or is null. + When a subscription to the resulting sequence is disposed, the CancellationToken that was fed to the asynchronous function will be signaled. + + + + Converts to asynchronous action into an observable sequence. Each subscription to the resulting sequence causes the action to be started. + + Asynchronous action to convert. + An observable sequence exposing a Unit value upon completion of the action, or an exception. + is null. + + + + Converts to asynchronous action into an observable sequence. Each subscription to the resulting sequence causes the action to be started. + + Asynchronous action to convert. + Scheduler on which to notify observers. + An observable sequence exposing a Unit value upon completion of the action, or an exception. + is null or is null. + + + + Converts to asynchronous action into an observable sequence. Each subscription to the resulting sequence causes the action to be started. + The CancellationToken passed to the asynchronous action is tied to the observable sequence's subscription that triggered the action's invocation and can be used for best-effort cancellation. + + Asynchronous action to convert. + An observable sequence exposing a Unit value upon completion of the action, or an exception. + When a subscription to the resulting sequence is disposed, the CancellationToken that was fed to the asynchronous function will be signaled. + is null. + + + + Converts to asynchronous action into an observable sequence. Each subscription to the resulting sequence causes the action to be started. + The CancellationToken passed to the asynchronous action is tied to the observable sequence's subscription that triggered the action's invocation and can be used for best-effort cancellation. + + Asynchronous action to convert. + Scheduler on which to notify observers. + An observable sequence exposing a Unit value upon completion of the action, or an exception. + When a subscription to the resulting sequence is disposed, the CancellationToken that was fed to the asynchronous function will be signaled. + is null or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + The type of the first argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + The type of the first argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the eleventh argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the eleventh argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the eleventh argument passed to the function. + The type of the twelfth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the eleventh argument passed to the function. + The type of the twelfth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the eleventh argument passed to the function. + The type of the twelfth argument passed to the function. + The type of the thirteenth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the eleventh argument passed to the function. + The type of the twelfth argument passed to the function. + The type of the thirteenth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the eleventh argument passed to the function. + The type of the twelfth argument passed to the function. + The type of the thirteenth argument passed to the function. + The type of the fourteenth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the eleventh argument passed to the function. + The type of the twelfth argument passed to the function. + The type of the thirteenth argument passed to the function. + The type of the fourteenth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the eleventh argument passed to the function. + The type of the twelfth argument passed to the function. + The type of the thirteenth argument passed to the function. + The type of the fourteenth argument passed to the function. + The type of the fifteenth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the eleventh argument passed to the function. + The type of the twelfth argument passed to the function. + The type of the thirteenth argument passed to the function. + The type of the fourteenth argument passed to the function. + The type of the fifteenth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the eleventh argument passed to the function. + The type of the twelfth argument passed to the function. + The type of the thirteenth argument passed to the function. + The type of the fourteenth argument passed to the function. + The type of the fifteenth argument passed to the function. + The type of the sixteenth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the eleventh argument passed to the function. + The type of the twelfth argument passed to the function. + The type of the thirteenth argument passed to the function. + The type of the fourteenth argument passed to the function. + The type of the fifteenth argument passed to the function. + The type of the sixteenth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + Action to convert to an asynchronous action. + Asynchronous action. + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + The type of the first argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + The type of the first argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + The type of the eleventh argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + The type of the eleventh argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + The type of the eleventh argument passed to the action. + The type of the twelfth argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + The type of the eleventh argument passed to the action. + The type of the twelfth argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + The type of the eleventh argument passed to the action. + The type of the twelfth argument passed to the action. + The type of the thirteenth argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + The type of the eleventh argument passed to the action. + The type of the twelfth argument passed to the action. + The type of the thirteenth argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + The type of the eleventh argument passed to the action. + The type of the twelfth argument passed to the action. + The type of the thirteenth argument passed to the action. + The type of the fourteenth argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + The type of the eleventh argument passed to the action. + The type of the twelfth argument passed to the action. + The type of the thirteenth argument passed to the action. + The type of the fourteenth argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + The type of the eleventh argument passed to the action. + The type of the twelfth argument passed to the action. + The type of the thirteenth argument passed to the action. + The type of the fourteenth argument passed to the action. + The type of the fifteenth argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + The type of the eleventh argument passed to the action. + The type of the twelfth argument passed to the action. + The type of the thirteenth argument passed to the action. + The type of the fourteenth argument passed to the action. + The type of the fifteenth argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + The type of the eleventh argument passed to the action. + The type of the twelfth argument passed to the action. + The type of the thirteenth argument passed to the action. + The type of the fourteenth argument passed to the action. + The type of the fifteenth argument passed to the action. + The type of the sixteenth argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + The type of the eleventh argument passed to the action. + The type of the twelfth argument passed to the action. + The type of the thirteenth argument passed to the action. + The type of the fourteenth argument passed to the action. + The type of the fifteenth argument passed to the action. + The type of the sixteenth argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + or is null. + + + + Gets an awaiter that returns the last value of the observable sequence or throws an exception if the sequence is empty. + This operation subscribes to the observable sequence, making it hot. + + The type of the elements in the source sequence. + Source sequence to await. + Object that can be awaited. + is null. + + + + Gets an awaiter that returns the last value of the observable sequence or throws an exception if the sequence is empty. + This operation subscribes and connects to the observable sequence, making it hot. + + The type of the elements in the source sequence. + Source sequence to await. + Object that can be awaited. + is null. + + + + Gets an awaiter that returns the last value of the observable sequence or throws an exception if the sequence is empty. + This operation subscribes to the observable sequence, making it hot. The supplied CancellationToken can be used to cancel the subscription. + + The type of the elements in the source sequence. + Source sequence to await. + Cancellation token. + Object that can be awaited. + is null. + + + + Gets an awaiter that returns the last value of the observable sequence or throws an exception if the sequence is empty. + This operation subscribes and connects to the observable sequence, making it hot. The supplied CancellationToken can be used to cancel the subscription and connection. + + The type of the elements in the source sequence. + Source sequence to await. + Cancellation token. + Object that can be awaited. + is null. + + + + Multicasts the source sequence notifications through the specified subject to the resulting connectable observable. Upon connection of the + connectable observable, the subject is subscribed to the source exactly one, and messages are forwarded to the observers registered with + the connectable observable. For specializations with fixed subject types, see Publish, PublishLast, and Replay. + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence whose elements will be pushed into the specified subject. + Subject to push source elements into. + A connectable observable sequence that upon connection causes the source sequence to push results into the specified subject. + or is null. + + + + Multicasts the source sequence notifications through an instantiated subject into all uses of the sequence within a selector function. Each + subscription to the resulting sequence causes a separate multicast invocation, exposing the sequence resulting from the selector function's + invocation. For specializations with fixed subject types, see Publish, PublishLast, and Replay. + + The type of the elements in the source sequence. + The type of the elements produced by the intermediate subject. + The type of the elements in the result sequence. + Source sequence which will be multicasted in the specified selector function. + Factory function to create an intermediate subject through which the source sequence's elements will be multicast to the selector function. + Selector function which can use the multicasted source sequence subject to the policies enforced by the created subject. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + or or is null. + + + + Returns a connectable observable sequence that shares a single subscription to the underlying sequence. + This operator is a specialization of Multicast using a regular . + + The type of the elements in the source sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + A connectable observable sequence that shares a single subscription to the underlying sequence. + is null. + Subscribers will receive all notifications of the source from the time of the subscription on. + + + + + Returns an observable sequence that is the result of invoking the selector on a connectable observable sequence that shares a single subscription to the underlying sequence. + This operator is a specialization of Multicast using a regular . + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will receive all notifications of the source from the time of the subscription on. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + or is null. + + + + + Returns a connectable observable sequence that shares a single subscription to the underlying sequence and starts with initialValue. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Initial value received by observers upon subscription. + A connectable observable sequence that shares a single subscription to the underlying sequence. + is null. + Subscribers will receive immediately receive the initial value, followed by all notifications of the source from the time of the subscription on. + + + + + Returns an observable sequence that is the result of invoking the selector on a connectable observable sequence that shares a single subscription to the underlying sequence and starts with initialValue. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will receive immediately receive the initial value, followed by all notifications of the source from the time of the subscription on. + Initial value received by observers upon subscription. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + or is null. + + + + + Returns a connectable observable sequence that shares a single subscription to the underlying sequence containing only the last notification. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + A connectable observable sequence that shares a single subscription to the underlying sequence. + is null. + Subscribers will only receive the last notification of the source. + + + + + Returns an observable sequence that is the result of invoking the selector on a connectable observable sequence that shares a single subscription to the underlying sequence containing only the last notification. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will only receive the last notification of the source. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + or is null. + + + + + Returns an observable sequence that stays connected to the source as long as there is at least one subscription to the observable sequence. + + The type of the elements in the source sequence. + Connectable observable sequence. + An observable sequence that stays connected to the source as long as there is at least one subscription to the observable sequence. + is null. + + + + Returns an observable sequence that stays connected to the source as long as there is at least one subscription to the observable sequence. + + The type of the elements in the source sequence. + Connectable observable sequence. + The time span that should be waited before possibly unsubscribing from the connectable observable. + An observable sequence that stays connected to the source as long as there is at least one subscription to the observable sequence. + is null. + + + + Returns an observable sequence that stays connected to the source as long as there is at least one subscription to the observable sequence. + + The type of the elements in the source sequence. + Connectable observable sequence. + The time span that should be waited before possibly unsubscribing from the connectable observable. + The scheduler to use for delayed unsubscription. + An observable sequence that stays connected to the source as long as there is at least one subscription to the observable sequence. + is null. + + + + Automatically connect the upstream IConnectableObservable at most once when the + specified number of IObservers have subscribed to this IObservable. + + The type of the elements in the source sequence. + Connectable observable sequence. + The number of observers required to subscribe before the connection to source happens, non-positive value will trigger an immediate subscription. + If not null, the connection's IDisposable is provided to it. + An observable sequence that connects to the source at most once when the given number of observers have subscribed to it. + is null. + + + + Returns a connectable observable sequence that shares a single subscription to the underlying sequence replaying all notifications. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + A connectable observable sequence that shares a single subscription to the underlying sequence. + is null. + Subscribers will receive all the notifications of the source. + + + + + Returns a connectable observable sequence that shares a single subscription to the underlying sequence replaying all notifications. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Scheduler where connected observers will be invoked on. + A connectable observable sequence that shares a single subscription to the underlying sequence. + or is null. + Subscribers will receive all the notifications of the source. + + + + + Returns an observable sequence that is the result of invoking the selector on a connectable observable sequence that shares a single subscription to the underlying sequence replaying all notifications. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will receive all the notifications of the source. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + or is null. + + + + + Returns an observable sequence that is the result of invoking the selector on a connectable observable sequence that shares a single subscription to the underlying sequence replaying all notifications. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will receive all the notifications of the source. + Scheduler where connected observers within the selector function will be invoked on. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + or or is null. + + + + + Returns a connectable observable sequence that shares a single subscription to the underlying sequence replaying notifications subject to a maximum time length for the replay buffer. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Maximum time length of the replay buffer. + A connectable observable sequence that shares a single subscription to the underlying sequence. + is null. + is less than TimeSpan.Zero. + Subscribers will receive all the notifications of the source subject to the specified replay buffer trimming policy. + + + + + Returns an observable sequence that is the result of invoking the selector on a connectable observable sequence that shares a single subscription to the underlying sequence replaying notifications subject to a maximum time length for the replay buffer. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will receive all the notifications of the source subject to the specified replay buffer trimming policy. + Maximum time length of the replay buffer. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + or is null. + is less than TimeSpan.Zero. + + + + + Returns a connectable observable sequence that shares a single subscription to the underlying sequence replaying notifications subject to a maximum time length for the replay buffer. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Maximum time length of the replay buffer. + Scheduler where connected observers will be invoked on. + A connectable observable sequence that shares a single subscription to the underlying sequence. + or is null. + is less than TimeSpan.Zero. + Subscribers will receive all the notifications of the source subject to the specified replay buffer trimming policy. + + + + + Returns an observable sequence that is the result of invoking the selector on a connectable observable sequence that shares a single subscription to the underlying sequence replaying notifications subject to a maximum time length for the replay buffer. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will receive all the notifications of the source subject to the specified replay buffer trimming policy. + Maximum time length of the replay buffer. + Scheduler where connected observers within the selector function will be invoked on. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + or or is null. + is less than TimeSpan.Zero. + + + + + Returns a connectable observable sequence that shares a single subscription to the underlying sequence replaying bufferSize notifications. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Maximum element count of the replay buffer. + Scheduler where connected observers will be invoked on. + A connectable observable sequence that shares a single subscription to the underlying sequence. + or is null. + is less than zero. + Subscribers will receive all the notifications of the source subject to the specified replay buffer trimming policy. + + + + + Returns an observable sequence that is the result of invoking the selector on a connectable observable sequence that shares a single subscription to the underlying sequence replaying notifications subject to a maximum element count for the replay buffer. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will receive all the notifications of the source subject to the specified replay buffer trimming policy. + Maximum element count of the replay buffer. + Scheduler where connected observers within the selector function will be invoked on. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + or or is null. + is less than zero. + + + + + Returns a connectable observable sequence that shares a single subscription to the underlying sequence replaying notifications subject to a maximum element count for the replay buffer. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Maximum element count of the replay buffer. + A connectable observable sequence that shares a single subscription to the underlying sequence. + is null. + is less than zero. + Subscribers will receive all the notifications of the source subject to the specified replay buffer trimming policy. + + + + + Returns an observable sequence that is the result of invoking the selector on a connectable observable sequence that shares a single subscription to the underlying sequence replaying notifications subject to a maximum element count for the replay buffer. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will receive all the notifications of the source subject to the specified replay buffer trimming policy. + Maximum element count of the replay buffer. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + or is null. + is less than zero. + + + + + Returns a connectable observable sequence that shares a single subscription to the underlying sequence replaying notifications subject to a maximum time length and element count for the replay buffer. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Maximum element count of the replay buffer. + Maximum time length of the replay buffer. + A connectable observable sequence that shares a single subscription to the underlying sequence. + is null. + is less than zero. + is less than TimeSpan.Zero. + Subscribers will receive all the notifications of the source subject to the specified replay buffer trimming policy. + + + + + Returns an observable sequence that is the result of invoking the selector on a connectable observable sequence that shares a single subscription to the underlying sequence replaying notifications subject to a maximum time length and element count for the replay buffer. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will receive all the notifications of the source subject to the specified replay buffer trimming policy. + Maximum element count of the replay buffer. + Maximum time length of the replay buffer. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + or is null. + is less than zero. + is less than TimeSpan.Zero. + + + + + Returns a connectable observable sequence that shares a single subscription to the underlying sequence replaying notifications subject to a maximum time length and element count for the replay buffer. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Maximum element count of the replay buffer. + Maximum time length of the replay buffer. + Scheduler where connected observers will be invoked on. + A connectable observable sequence that shares a single subscription to the underlying sequence. + or is null. + is less than zero. + is less than TimeSpan.Zero. + Subscribers will receive all the notifications of the source subject to the specified replay buffer trimming policy. + + + + + Returns an observable sequence that is the result of invoking the selector on a connectable observable sequence that shares a single subscription to the underlying sequence replaying notifications subject to a maximum time length and element count for the replay buffer. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will receive all the notifications of the source subject to the specified replay buffer trimming policy. + Maximum element count of the replay buffer. + Maximum time length of the replay buffer. + Scheduler where connected observers within the selector function will be invoked on. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + or or is null. + is less than zero. + is less than TimeSpan.Zero. + + + + + Produces an enumerable sequence of consecutive (possibly empty) chunks of the source sequence. + + The type of the elements in the source sequence. + Source observable sequence. + The enumerable sequence that returns consecutive (possibly empty) chunks upon each iteration. + is null. + + + + Produces an enumerable sequence that returns elements collected/aggregated from the source sequence between consecutive iterations. + + The type of the elements in the source sequence. + The type of the elements produced by the merge operation during collection. + Source observable sequence. + Factory to create a new collector object. + Merges a sequence element with the current collector. + The enumerable sequence that returns collected/aggregated elements from the source sequence upon each iteration. + or or is null. + + + + Produces an enumerable sequence that returns elements collected/aggregated from the source sequence between consecutive iterations. + + The type of the elements in the source sequence. + The type of the elements produced by the merge operation during collection. + Source observable sequence. + Factory to create the initial collector object. + Merges a sequence element with the current collector. + Factory to replace the current collector by a new collector. + The enumerable sequence that returns collected/aggregated elements from the source sequence upon each iteration. + or or or is null. + + + + Returns the first element of an observable sequence. + + The type of the elements in the source sequence. + Source observable sequence. + The first element in the observable sequence. + is null. + The source sequence is empty. + + + + + Returns the first element of an observable sequence that satisfies the condition in the predicate. + + The type of the elements in the source sequence. + Source observable sequence. + A predicate function to evaluate for elements in the source sequence. + The first element in the observable sequence that satisfies the condition in the predicate. + or is null. + No element satisfies the condition in the predicate. -or- The source sequence is empty. + + + + + Returns the first element of an observable sequence, or a default value if no such element exists. + + The type of the elements in the source sequence. + Source observable sequence. + The first element in the observable sequence, or a default value if no such element exists. + is null. + + + + + Returns the first element of an observable sequence that satisfies the condition in the predicate, or a default value if no such element exists. + + The type of the elements in the source sequence. + Source observable sequence. + A predicate function to evaluate for elements in the source sequence. + The first element in the observable sequence that satisfies the condition in the predicate, or a default value if no such element exists. + or is null. + + + + + Invokes an action for each element in the observable sequence, and blocks until the sequence is terminated. + + The type of the elements in the source sequence. + Source sequence. + Action to invoke for each element in the observable sequence. + or is null. + Because of its blocking nature, this operator is mainly used for testing. + + + + Invokes an action for each element in the observable sequence, incorporating the element's index, and blocks until the sequence is terminated. + + The type of the elements in the source sequence. + Source sequence. + Action to invoke for each element in the observable sequence. + or is null. + Because of its blocking nature, this operator is mainly used for testing. + + + + Returns an enumerator that enumerates all values of the observable sequence. + + The type of the elements in the source sequence. + An observable sequence to get an enumerator for. + The enumerator that can be used to enumerate over the elements in the observable sequence. + is null. + + + + Returns the last element of an observable sequence. + + The type of the elements in the source sequence. + Source observable sequence. + The last element in the observable sequence. + is null. + The source sequence is empty. + + + + + Returns the last element of an observable sequence that satisfies the condition in the predicate. + + The type of the elements in the source sequence. + Source observable sequence. + A predicate function to evaluate for elements in the source sequence. + The last element in the observable sequence that satisfies the condition in the predicate. + or is null. + No element satisfies the condition in the predicate. -or- The source sequence is empty. + + + + + Returns the last element of an observable sequence, or a default value if no such element exists. + + The type of the elements in the source sequence. + Source observable sequence. + The last element in the observable sequence, or a default value if no such element exists. + is null. + + + + + Returns the last element of an observable sequence that satisfies the condition in the predicate, or a default value if no such element exists. + + The type of the elements in the source sequence. + Source observable sequence. + A predicate function to evaluate for elements in the source sequence. + The last element in the observable sequence that satisfies the condition in the predicate, or a default value if no such element exists. + or is null. + + + + + Returns an enumerable sequence whose enumeration returns the latest observed element in the source observable sequence. + Enumerators on the resulting sequence will never produce the same element repeatedly, and will block until the next element becomes available. + + The type of the elements in the source sequence. + Source observable sequence. + The enumerable sequence that returns the last sampled element upon each iteration and subsequently blocks until the next element in the observable source sequence becomes available. + + + + Returns an enumerable sequence whose enumeration returns the most recently observed element in the source observable sequence, using the specified initial value in case no element has been sampled yet. + Enumerators on the resulting sequence never block and can produce the same element repeatedly. + + The type of the elements in the source sequence. + Source observable sequence. + Initial value that will be yielded by the enumerable sequence if no element has been sampled yet. + The enumerable sequence that returns the last sampled element upon each iteration. + is null. + + + + Returns an enumerable sequence whose enumeration blocks until the next element in the source observable sequence becomes available. + Enumerators on the resulting sequence will block until the next element becomes available. + + The type of the elements in the source sequence. + Source observable sequence. + The enumerable sequence that blocks upon each iteration until the next element in the observable source sequence becomes available. + is null. + + + + Returns the only element of an observable sequence, and throws an exception if there is not exactly one element in the observable sequence. + + The type of the elements in the source sequence. + Source observable sequence. + The single element in the observable sequence. + is null. + The source sequence contains more than one element. -or- The source sequence is empty. + + + + + Returns the only element of an observable sequence that satisfies the condition in the predicate, and throws an exception if there is not exactly one element matching the predicate in the observable sequence. + + The type of the elements in the source sequence. + Source observable sequence. + A predicate function to evaluate for elements in the source sequence. + The single element in the observable sequence that satisfies the condition in the predicate. + or is null. + No element satisfies the condition in the predicate. -or- More than one element satisfies the condition in the predicate. -or- The source sequence is empty. + + + + + Returns the only element of an observable sequence, or a default value if the observable sequence is empty; this method throws an exception if there is more than one element in the observable sequence. + + The type of the elements in the source sequence. + Source observable sequence. + The single element in the observable sequence, or a default value if no such element exists. + is null. + The source sequence contains more than one element. + + + + + Returns the only element of an observable sequence that satisfies the condition in the predicate, or a default value if no such element exists; this method throws an exception if there is more than one element matching the predicate in the observable sequence. + + The type of the elements in the source sequence. + Source observable sequence. + A predicate function to evaluate for elements in the source sequence. + The single element in the observable sequence that satisfies the condition in the predicate, or a default value if no such element exists. + or is null. + The sequence contains more than one element that satisfies the condition in the predicate. + + + + + Waits for the observable sequence to complete and returns the last element of the sequence. + If the sequence terminates with an OnError notification, the exception is thrown. + + The type of the elements in the source sequence. + Source observable sequence. + The last element in the observable sequence. + is null. + The source sequence is empty. + + + + Wraps the source sequence in order to run its observer callbacks on the specified scheduler. + + The type of the elements in the source sequence. + Source sequence. + Scheduler to notify observers on. + The source sequence whose observations happen on the specified scheduler. + or is null. + + This only invokes observer callbacks on a scheduler. In case the subscription and/or unsubscription actions have side-effects + that require to be run on a scheduler, use . + + + + + Wraps the source sequence in order to run its observer callbacks on the specified synchronization context. + + The type of the elements in the source sequence. + Source sequence. + Synchronization context to notify observers on. + The source sequence whose observations happen on the specified synchronization context. + or is null. + + This only invokes observer callbacks on a synchronization context. In case the subscription and/or unsubscription actions have side-effects + that require to be run on a synchronization context, use . + + + + + Wraps the source sequence in order to run its subscription and unsubscription logic on the specified scheduler. This operation is not commonly used; + see the remarks section for more information on the distinction between SubscribeOn and ObserveOn. + + The type of the elements in the source sequence. + Source sequence. + Scheduler to perform subscription and unsubscription actions on. + The source sequence whose subscriptions and unsubscriptions happen on the specified scheduler. + or is null. + + This only performs the side-effects of subscription and unsubscription on the specified scheduler. In order to invoke observer + callbacks on a scheduler, use . + + + + + Wraps the source sequence in order to run its subscription and unsubscription logic on the specified synchronization context. This operation is not commonly used; + see the remarks section for more information on the distinction between SubscribeOn and ObserveOn. + + The type of the elements in the source sequence. + Source sequence. + Synchronization context to perform subscription and unsubscription actions on. + The source sequence whose subscriptions and unsubscriptions happen on the specified synchronization context. + or is null. + + This only performs the side-effects of subscription and unsubscription on the specified synchronization context. In order to invoke observer + callbacks on a synchronization context, use . + + + + + Synchronizes the observable sequence such that observer notifications cannot be delivered concurrently. + This overload is useful to "fix" an observable sequence that exhibits concurrent callbacks on individual observers, which is invalid behavior for the query processor. + + The type of the elements in the source sequence. + Source sequence. + The source sequence whose outgoing calls to observers are synchronized. + is null. + + It's invalid behavior - according to the observer grammar - for a sequence to exhibit concurrent callbacks on a given observer. + This operator can be used to "fix" a source that doesn't conform to this rule. + + + + + Synchronizes the observable sequence such that observer notifications cannot be delivered concurrently, using the specified gate object. + This overload is useful when writing n-ary query operators, in order to prevent concurrent callbacks from different sources by synchronizing on a common gate object. + + The type of the elements in the source sequence. + Source sequence. + Gate object to synchronize each observer call on. + The source sequence whose outgoing calls to observers are synchronized on the given gate object. + or is null. + + + + Subscribes an observer to an enumerable sequence. + + The type of the elements in the source sequence. + Enumerable sequence to subscribe to. + Observer that will receive notifications from the enumerable sequence. + Disposable object that can be used to unsubscribe the observer from the enumerable + or is null. + + + + Subscribes an observer to an enumerable sequence, using the specified scheduler to run the enumeration loop. + + The type of the elements in the source sequence. + Enumerable sequence to subscribe to. + Observer that will receive notifications from the enumerable sequence. + Scheduler to perform the enumeration on. + Disposable object that can be used to unsubscribe the observer from the enumerable + or or is null. + + + + Converts an observable sequence to an enumerable sequence. + + The type of the elements in the source sequence. + An observable sequence to convert to an enumerable sequence. + The enumerable sequence containing the elements in the observable sequence. + is null. + + + + Exposes an observable sequence as an object with an -based .NET event. + + Observable source sequence. + The event source object. + is null. + + + + Exposes an observable sequence as an object with an -based .NET event. + + The type of the elements in the source sequence. + Observable source sequence. + The event source object. + is null. + + + + Exposes an observable sequence as an object with a .NET event, conforming to the standard .NET event pattern. + + The type of the event data generated by the event. + Observable source sequence. + The event source object. + is null. + + + + Converts an enumerable sequence to an observable sequence. + + The type of the elements in the source sequence. + Enumerable sequence to convert to an observable sequence. + The observable sequence whose elements are pulled from the given enumerable sequence. + is null. + + + + Converts an enumerable sequence to an observable sequence, using the specified scheduler to run the enumeration loop. + + The type of the elements in the source sequence. + Enumerable sequence to convert to an observable sequence. + Scheduler to run the enumeration of the input sequence on. + The observable sequence whose elements are pulled from the given enumerable sequence. + or is null. + + + + Creates an observable sequence from a specified Subscribe method implementation. + + The type of the elements in the produced sequence. + Implementation of the resulting observable sequence's Subscribe method. + The observable sequence with the specified implementation for the Subscribe method. + is null. + + Use of this operator is preferred over manual implementation of the interface. In case + you need a type implementing rather than an anonymous implementation, consider using + the abstract base class. + + + + + Creates an observable sequence from a specified Subscribe method implementation. + + The type of the elements in the produced sequence. + Implementation of the resulting observable sequence's Subscribe method, returning an Action delegate that will be wrapped in an IDisposable. + The observable sequence with the specified implementation for the Subscribe method. + is null. + + Use of this operator is preferred over manual implementation of the interface. In case + you need a type implementing rather than an anonymous implementation, consider using + the abstract base class. + + + + + Creates an observable sequence from a specified cancellable asynchronous Subscribe method. + The CancellationToken passed to the asynchronous Subscribe method is tied to the returned disposable subscription, allowing best-effort cancellation. + + The type of the elements in the produced sequence. + Asynchronous method used to produce elements. + The observable sequence surfacing the elements produced by the asynchronous method. + is null. + This operator is especially useful in conjunction with the asynchronous programming features introduced in C# 5.0 and Visual Basic 11. + When a subscription to the resulting sequence is disposed, the CancellationToken that was fed to the asynchronous subscribe function will be signaled. + + + + Creates an observable sequence from a specified asynchronous Subscribe method. + + The type of the elements in the produced sequence. + Asynchronous method used to produce elements. + The observable sequence surfacing the elements produced by the asynchronous method. + is null. + This operator is especially useful in conjunction with the asynchronous programming features introduced in C# 5.0 and Visual Basic 11. + + + + Creates an observable sequence from a specified cancellable asynchronous Subscribe method. + The CancellationToken passed to the asynchronous Subscribe method is tied to the returned disposable subscription, allowing best-effort cancellation. + + The type of the elements in the produced sequence. + Asynchronous method used to implement the resulting sequence's Subscribe method. + The observable sequence with the specified implementation for the Subscribe method. + is null. + This operator is especially useful in conjunction with the asynchronous programming features introduced in C# 5.0 and Visual Basic 11. + When a subscription to the resulting sequence is disposed, the CancellationToken that was fed to the asynchronous subscribe function will be signaled. + + + + Creates an observable sequence from a specified asynchronous Subscribe method. + + The type of the elements in the produced sequence. + Asynchronous method used to implement the resulting sequence's Subscribe method. + The observable sequence with the specified implementation for the Subscribe method. + is null. + This operator is especially useful in conjunction with the asynchronous programming features introduced in C# 5.0 and Visual Basic 11. + + + + Creates an observable sequence from a specified cancellable asynchronous Subscribe method. + The CancellationToken passed to the asynchronous Subscribe method is tied to the returned disposable subscription, allowing best-effort cancellation. + + The type of the elements in the produced sequence. + Asynchronous method used to implement the resulting sequence's Subscribe method, returning an Action delegate that will be wrapped in an IDisposable. + The observable sequence with the specified implementation for the Subscribe method. + is null. + This operator is especially useful in conjunction with the asynchronous programming features introduced in C# 5.0 and Visual Basic 11. + When a subscription to the resulting sequence is disposed, the CancellationToken that was fed to the asynchronous subscribe function will be signaled. + + + + Creates an observable sequence from a specified asynchronous Subscribe method. + + The type of the elements in the produced sequence. + Asynchronous method used to implement the resulting sequence's Subscribe method, returning an Action delegate that will be wrapped in an IDisposable. + The observable sequence with the specified implementation for the Subscribe method. + is null. + This operator is especially useful in conjunction with the asynchronous programming features introduced in C# 5.0 and Visual Basic 11. + + + + Returns an observable sequence that invokes the specified factory function whenever a new observer subscribes. + + The type of the elements in the sequence returned by the factory function, and in the resulting sequence. + Observable factory function to invoke for each observer that subscribes to the resulting sequence. + An observable sequence whose observers trigger an invocation of the given observable factory function. + is null. + + + + Returns an observable sequence that starts the specified asynchronous factory function whenever a new observer subscribes. + + The type of the elements in the sequence returned by the factory function, and in the resulting sequence. + Asynchronous factory function to start for each observer that subscribes to the resulting sequence. + An observable sequence whose observers trigger the given asynchronous observable factory function to be started. + is null. + This operator is especially useful in conjunction with the asynchronous programming features introduced in C# 5.0 and Visual Basic 11. + + + + Returns an observable sequence that starts the specified cancellable asynchronous factory function whenever a new observer subscribes. + The CancellationToken passed to the asynchronous factory function is tied to the returned disposable subscription, allowing best-effort cancellation. + + The type of the elements in the sequence returned by the factory function, and in the resulting sequence. + Asynchronous factory function to start for each observer that subscribes to the resulting sequence. + An observable sequence whose observers trigger the given asynchronous observable factory function to be started. + is null. + This operator is especially useful in conjunction with the asynchronous programming features introduced in C# 5.0 and Visual Basic 11. + When a subscription to the resulting sequence is disposed, the CancellationToken that was fed to the asynchronous observable factory function will be signaled. + + + + Returns an empty observable sequence. + + The type used for the type parameter of the resulting sequence. + An observable sequence with no elements. + + + + Returns an empty observable sequence. + + The type used for the type parameter of the resulting sequence. + Object solely used to infer the type of the type parameter. This parameter is typically used when creating a sequence of anonymously typed elements. + An observable sequence with no elements. + + + + Returns an empty observable sequence, using the specified scheduler to send out the single OnCompleted message. + + The type used for the type parameter of the resulting sequence. + Scheduler to send the termination call on. + An observable sequence with no elements. + is null. + + + + Returns an empty observable sequence, using the specified scheduler to send out the single OnCompleted message. + + The type used for the type parameter of the resulting sequence. + Scheduler to send the termination call on. + Object solely used to infer the type of the type parameter. This parameter is typically used when creating a sequence of anonymously typed elements. + An observable sequence with no elements. + is null. + + + + Generates an observable sequence by running a state-driven loop producing the sequence's elements. + + The type of the state used in the generator loop. + The type of the elements in the produced sequence. + Initial state. + Condition to terminate generation (upon returning false). + Iteration step function. + Selector function for results produced in the sequence. + The generated sequence. + or or is null. + + + + Generates an observable sequence by running a state-driven loop producing the sequence's elements, using the specified scheduler to send out observer messages. + + The type of the state used in the generator loop. + The type of the elements in the produced sequence. + Initial state. + Condition to terminate generation (upon returning false). + Iteration step function. + Selector function for results produced in the sequence. + Scheduler on which to run the generator loop. + The generated sequence. + or or or is null. + + + + Returns a non-terminating observable sequence, which can be used to denote an infinite duration (e.g. when using reactive joins). + + The type used for the type parameter of the resulting sequence. + An observable sequence whose observers will never get called. + + + + Returns a non-terminating observable sequence, which can be used to denote an infinite duration (e.g. when using reactive joins). + + The type used for the type parameter of the resulting sequence. + Object solely used to infer the type of the type parameter. This parameter is typically used when creating a sequence of anonymously typed elements. + An observable sequence whose observers will never get called. + + + + Generates an observable sequence of integral numbers within a specified range. + + The value of the first integer in the sequence. + The number of sequential integers to generate. + An observable sequence that contains a range of sequential integral numbers. + is less than zero. -or- + - 1 is larger than . + + + + Generates an observable sequence of integral numbers within a specified range, using the specified scheduler to send out observer messages. + + The value of the first integer in the sequence. + The number of sequential integers to generate. + Scheduler to run the generator loop on. + An observable sequence that contains a range of sequential integral numbers. + is less than zero. -or- + - 1 is larger than . + is null. + + + + Generates an observable sequence that repeats the given element infinitely. + + The type of the element that will be repeated in the produced sequence. + Element to repeat. + An observable sequence that repeats the given element infinitely. + + + + Generates an observable sequence that repeats the given element infinitely, using the specified scheduler to send out observer messages. + + The type of the element that will be repeated in the produced sequence. + Element to repeat. + Scheduler to run the producer loop on. + An observable sequence that repeats the given element infinitely. + is null. + + + + Generates an observable sequence that repeats the given element the specified number of times. + + The type of the element that will be repeated in the produced sequence. + Element to repeat. + Number of times to repeat the element. + An observable sequence that repeats the given element the specified number of times. + is less than zero. + + + + Generates an observable sequence that repeats the given element the specified number of times, using the specified scheduler to send out observer messages. + + The type of the element that will be repeated in the produced sequence. + Element to repeat. + Number of times to repeat the element. + Scheduler to run the producer loop on. + An observable sequence that repeats the given element the specified number of times. + is less than zero. + is null. + + + + Returns an observable sequence that contains a single element. + + The type of the element that will be returned in the produced sequence. + Single element in the resulting observable sequence. + An observable sequence containing the single specified element. + + + + Returns an observable sequence that contains a single element, using the specified scheduler to send out observer messages. + + The type of the element that will be returned in the produced sequence. + Single element in the resulting observable sequence. + Scheduler to send the single element on. + An observable sequence containing the single specified element. + is null. + + + + Returns an observable sequence that terminates with an exception. + + The type used for the type parameter of the resulting sequence. + Exception object used for the sequence's termination. + The observable sequence that terminates exceptionally with the specified exception object. + is null. + + + + Returns an observable sequence that terminates with an exception. + + The type used for the type parameter of the resulting sequence. + Exception object used for the sequence's termination. + Object solely used to infer the type of the type parameter. This parameter is typically used when creating a sequence of anonymously typed elements. + The observable sequence that terminates exceptionally with the specified exception object. + is null. + + + + Returns an observable sequence that terminates with an exception, using the specified scheduler to send out the single OnError message. + + The type used for the type parameter of the resulting sequence. + Exception object used for the sequence's termination. + Scheduler to send the exceptional termination call on. + The observable sequence that terminates exceptionally with the specified exception object. + or is null. + + + + Returns an observable sequence that terminates with an exception, using the specified scheduler to send out the single OnError message. + + The type used for the type parameter of the resulting sequence. + Exception object used for the sequence's termination. + Scheduler to send the exceptional termination call on. + Object solely used to infer the type of the type parameter. This parameter is typically used when creating a sequence of anonymously typed elements. + The observable sequence that terminates exceptionally with the specified exception object. + or is null. + + + + Constructs an observable sequence that depends on a resource object, whose lifetime is tied to the resulting observable sequence's lifetime. + + The type of the elements in the produced sequence. + The type of the resource used during the generation of the resulting sequence. Needs to implement . + Factory function to obtain a resource object. + Factory function to obtain an observable sequence that depends on the obtained resource. + An observable sequence whose lifetime controls the lifetime of the dependent resource object. + or is null. + + + + Constructs an observable sequence that depends on a resource object, whose lifetime is tied to the resulting observable sequence's lifetime. The resource is obtained and used through asynchronous methods. + The CancellationToken passed to the asynchronous methods is tied to the returned disposable subscription, allowing best-effort cancellation at any stage of the resource acquisition or usage. + + The type of the elements in the produced sequence. + The type of the resource used during the generation of the resulting sequence. Needs to implement . + Asynchronous factory function to obtain a resource object. + Asynchronous factory function to obtain an observable sequence that depends on the obtained resource. + An observable sequence whose lifetime controls the lifetime of the dependent resource object. + or is null. + This operator is especially useful in conjunction with the asynchronous programming features introduced in C# 5.0 and Visual Basic 11. + When a subscription to the resulting sequence is disposed, the CancellationToken that was fed to the asynchronous resource factory and observable factory functions will be signaled. + + + + Converts a .NET event, conforming to the standard .NET event pattern based on , to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The observable sequence that contains data representations of invocations of the underlying .NET event. + or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEventPattern, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts a .NET event, conforming to the standard .NET event pattern based on , to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains data representations of invocations of the underlying .NET event. + or or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts a .NET event, conforming to the standard .NET event pattern based on a supplied event delegate type, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + The delegate type of the event to be converted. + The type of the event data generated by the event. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The observable sequence that contains data representations of invocations of the underlying .NET event. + or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEventPattern, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts a .NET event, conforming to the standard .NET event pattern based on a supplied event delegate type, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + The delegate type of the event to be converted. + The type of the event data generated by the event. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains data representations of invocations of the underlying .NET event. + or or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts a .NET event, conforming to the standard .NET event pattern based on , to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + The delegate type of the event to be converted. + The type of the event data generated by the event. + A function used to convert the given event handler to a delegate compatible with the underlying .NET event. The resulting delegate is used in calls to the addHandler and removeHandler action parameters. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The observable sequence that contains data representations of invocations of the underlying .NET event. + or or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEventPattern, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts a .NET event, conforming to the standard .NET event pattern based on , to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + The delegate type of the event to be converted. + The type of the event data generated by the event. + A function used to convert the given event handler to a delegate compatible with the underlying .NET event. The resulting delegate is used in calls to the addHandler and removeHandler action parameters. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains data representations of invocations of the underlying .NET event. + or or or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts a .NET event, conforming to the standard .NET event pattern based on a supplied event delegate type with a strongly typed sender parameter, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + The delegate type of the event to be converted. + The type of the sender that raises the event. + The type of the event data generated by the event. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The observable sequence that contains data representations of invocations of the underlying .NET event. + or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEventPattern, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts a .NET event, conforming to the standard .NET event pattern based on a supplied event delegate type with a strongly typed sender parameter, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + The delegate type of the event to be converted. + The type of the sender that raises the event. + The type of the event data generated by the event. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains data representations of invocations of the underlying .NET event. + or or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts a .NET event, conforming to the standard .NET event pattern based on , to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + The type of the event data generated by the event. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The observable sequence that contains data representations of invocations of the underlying .NET event. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEventPattern, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts a .NET event, conforming to the standard .NET event pattern based on , to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + The type of the event data generated by the event. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains data representations of invocations of the underlying .NET event. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts an instance .NET event, conforming to the standard .NET event pattern with an parameter, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + Reflection is used to discover the event based on the target object type and the specified event name. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Object instance that exposes the event to convert. + Name of the event to convert. + The observable sequence that contains data representations of invocations of the underlying .NET event. + or is null. + The event could not be found. -or- The event does not conform to the standard .NET event pattern. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEventPattern, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts an instance .NET event, conforming to the standard .NET event pattern with an parameter, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + Reflection is used to discover the event based on the target object type and the specified event name. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Object instance that exposes the event to convert. + Name of the event to convert. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains data representations of invocations of the underlying .NET event. + or or is null. + The event could not be found. -or- The event does not conform to the standard .NET event pattern. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts an instance .NET event, conforming to the standard .NET event pattern with strongly typed event arguments, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + Reflection is used to discover the event based on the target object type and the specified event name. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + The type of the event data generated by the event. + Object instance that exposes the event to convert. + Name of the event to convert. + The observable sequence that contains data representations of invocations of the underlying .NET event. + or is null. + The event could not be found. -or- The event does not conform to the standard .NET event pattern. -or- The event's second argument type is not assignable to TEventArgs. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEventPattern, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts an instance .NET event, conforming to the standard .NET event pattern with strongly typed event arguments, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + Reflection is used to discover the event based on the target object type and the specified event name. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + The type of the event data generated by the event. + Object instance that exposes the event to convert. + Name of the event to convert. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains data representations of invocations of the underlying .NET event. + or or is null. + The event could not be found. -or- The event does not conform to the standard .NET event pattern. -or- The event's second argument type is not assignable to TEventArgs. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts an instance .NET event, conforming to the standard .NET event pattern with a strongly typed sender and strongly typed event arguments, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + Reflection is used to discover the event based on the target object type and the specified event name. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + The type of the sender that raises the event. + The type of the event data generated by the event. + Object instance that exposes the event to convert. + Name of the event to convert. + The observable sequence that contains data representations of invocations of the underlying .NET event. + or is null. + The event could not be found. -or- The event does not conform to the standard .NET event pattern. -or- The event's first argument type is not assignable to TSender. -or- The event's second argument type is not assignable to TEventArgs. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEventPattern, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts an instance .NET event, conforming to the standard .NET event pattern with a strongly typed sender and strongly typed event arguments, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + Reflection is used to discover the event based on the target object type and the specified event name. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + The type of the sender that raises the event. + The type of the event data generated by the event. + Object instance that exposes the event to convert. + Name of the event to convert. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains data representations of invocations of the underlying .NET event. + or or is null. + The event could not be found. -or- The event does not conform to the standard .NET event pattern. -or- The event's first argument type is not assignable to TSender. -or- The event's second argument type is not assignable to TEventArgs. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts a static .NET event, conforming to the standard .NET event pattern with an parameter, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + Reflection is used to discover the event based on the specified type and the specified event name. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Type that exposes the static event to convert. + Name of the event to convert. + The observable sequence that contains data representations of invocations of the underlying .NET event. + or is null. + The event could not be found. -or- The event does not conform to the standard .NET event pattern. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEventPattern, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts a static .NET event, conforming to the standard .NET event pattern with an parameter, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + Reflection is used to discover the event based on the specified type and the specified event name. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Type that exposes the static event to convert. + Name of the event to convert. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains data representations of invocations of the underlying .NET event. + or or is null. + The event could not be found. -or- The event does not conform to the standard .NET event pattern. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts a static .NET event, conforming to the standard .NET event pattern with strongly typed event arguments, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + Reflection is used to discover the event based on the specified type and the specified event name. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + The type of the event data generated by the event. + Type that exposes the static event to convert. + Name of the event to convert. + The observable sequence that contains data representations of invocations of the underlying .NET event. + or is null. + The event could not be found. -or- The event does not conform to the standard .NET event pattern. -or- The event's second argument type is not assignable to TEventArgs. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEventPattern, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts a static .NET event, conforming to the standard .NET event pattern with strongly typed event arguments, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + Reflection is used to discover the event based on the specified type and the specified event name. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + The type of the event data generated by the event. + Type that exposes the static event to convert. + Name of the event to convert. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains data representations of invocations of the underlying .NET event. + or or is null. + The event could not be found. -or- The event does not conform to the standard .NET event pattern. -or- The event's second argument type is not assignable to TEventArgs. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts a static .NET event, conforming to the standard .NET event pattern with a strongly typed sender and strongly typed event arguments, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + Reflection is used to discover the event based on the specified type and the specified event name. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + The type of the sender that raises the event. + The type of the event data generated by the event. + Type that exposes the static event to convert. + Name of the event to convert. + The observable sequence that contains data representations of invocations of the underlying .NET event. + or is null. + The event could not be found. -or- The event does not conform to the standard .NET event pattern. -or- The event's first argument type is not assignable to TSender. -or- The event's second argument type is not assignable to TEventArgs. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEventPattern, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts a static .NET event, conforming to the standard .NET event pattern with a strongly typed sender and strongly typed event arguments, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + Reflection is used to discover the event based on the specified type and the specified event name. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + The type of the sender that raises the event. + The type of the event data generated by the event. + Type that exposes the static event to convert. + Name of the event to convert. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains data representations of invocations of the underlying .NET event. + or or is null. + The event could not be found. -or- The event does not conform to the standard .NET event pattern. -or- The event's first argument type is not assignable to TSender. -or- The event's second argument type is not assignable to TEventArgs. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts a .NET event to an observable sequence, using a conversion function to obtain the event delegate. Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead. + + The delegate type of the event to be converted. + The type of the event data generated by the event. + A function used to convert the given event handler to a delegate compatible with the underlying .NET event. The resulting delegate is used in calls to the addHandler and removeHandler action parameters. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The observable sequence that contains the event argument objects passed to the invocations of the underlying .NET event. + or or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEvent, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEvent, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEvent calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts a .NET event to an observable sequence, using a conversion function to obtain the event delegate. Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead. + + The delegate type of the event to be converted. + The type of the event data generated by the event. + A function used to convert the given event handler to a delegate compatible with the underlying .NET event. The resulting delegate is used in calls to the addHandler and removeHandler action parameters. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains the event argument objects passed to the invocations of the underlying .NET event. + or or or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEvent calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEvent that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts a .NET event to an observable sequence, using a supplied event delegate type. Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead. + + The delegate type of the event to be converted. + The type of the event data generated by the event. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The observable sequence that contains the event argument objects passed to the invocations of the underlying .NET event. + or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEvent, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEvent, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEvent calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts a .NET event to an observable sequence, using a supplied event delegate type. Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead. + + The delegate type of the event to be converted. + The type of the event data generated by the event. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains the event argument objects passed to the invocations of the underlying .NET event. + or or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEvent calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEvent that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts a generic Action-based .NET event to an observable sequence. Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead. + + The type of the event data generated by the event. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The observable sequence that contains the event argument objects passed to the invocations of the underlying .NET event. + or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEvent, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEvent, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEvent calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts a generic Action-based .NET event to an observable sequence. Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead. + + The type of the event data generated by the event. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains the event argument objects passed to the invocations of the underlying .NET event. + or or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEvent calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEvent that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts an Action-based .NET event to an observable sequence. Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead. + + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The observable sequence that contains the event argument objects passed to the invocations of the underlying .NET event. + or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEvent, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEvent, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEvent calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts an Action-based .NET event to an observable sequence. Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead. + + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains the event argument objects passed to the invocations of the underlying .NET event. + or or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEvent calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEvent that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Invokes an action for each element in the observable sequence, and returns a Task object that will get signaled when the sequence terminates. + + The type of the elements in the source sequence. + Source sequence. + Action to invoke for each element in the observable sequence. + Task that signals the termination of the sequence. + or is null. + This operator is especially useful in conjunction with the asynchronous programming features introduced in C# 5.0 and Visual Basic 11. + + + + Invokes an action for each element in the observable sequence, and returns a Task object that will get signaled when the sequence terminates. + The loop can be quit prematurely by setting the specified cancellation token. + + The type of the elements in the source sequence. + Source sequence. + Action to invoke for each element in the observable sequence. + Cancellation token used to stop the loop. + Task that signals the termination of the sequence. + or is null. + This operator is especially useful in conjunction with the asynchronous programming features introduced in C# 5.0 and Visual Basic 11. + + + + Invokes an action for each element in the observable sequence, incorporating the element's index, and returns a Task object that will get signaled when the sequence terminates. + + The type of the elements in the source sequence. + Source sequence. + Action to invoke for each element in the observable sequence. + Task that signals the termination of the sequence. + or is null. + This operator is especially useful in conjunction with the asynchronous programming features introduced in C# 5.0 and Visual Basic 11. + + + + Invokes an action for each element in the observable sequence, incorporating the element's index, and returns a Task object that will get signaled when the sequence terminates. + The loop can be quit prematurely by setting the specified cancellation token. + + The type of the elements in the source sequence. + Source sequence. + Action to invoke for each element in the observable sequence. + Cancellation token used to stop the loop. + Task that signals the termination of the sequence. + or is null. + This operator is especially useful in conjunction with the asynchronous programming features introduced in C# 5.0 and Visual Basic 11. + + + + Uses to determine which source in to return, choosing if no match is found. + + The type of the value returned by the selector function, used to look up the resulting source. + The type of the elements in the result sequence. + Selector function invoked to determine the source to lookup in the dictionary. + Dictionary of sources to select from based on the invocation result. + Default source to select in case no matching source in is found. + The observable sequence retrieved from the dictionary based on the invocation result, or if no match is found. + or or is null. + + + + Uses to determine which source in to return, choosing an empty sequence on the specified scheduler if no match is found. + + The type of the value returned by the selector function, used to look up the resulting source. + The type of the elements in the result sequence. + Selector function invoked to determine the source to lookup in the dictionary. + Dictionary of sources to select from based on the invocation result. + Scheduler to generate an empty sequence on in case no matching source in is found. + The observable sequence retrieved from the dictionary based on the invocation result, or an empty sequence if no match is found. + or or is null. + + + + Uses to determine which source in to return, choosing an empty sequence if no match is found. + + The type of the value returned by the selector function, used to look up the resulting source. + The type of the elements in the result sequence. + Selector function invoked to determine the source to lookup in the dictionary. + Dictionary of sources to select from based on the invocation result. + The observable sequence retrieved from the dictionary based on the invocation result, or an empty sequence if no match is found. + or is null. + + + + Repeats the given as long as the specified holds, where the is evaluated after each repeated completed. + + The type of the elements in the source sequence. + Source to repeat as long as the function evaluates to true. + Condition that will be evaluated upon the completion of an iteration through the , to determine whether repetition of the source is required. + The observable sequence obtained by concatenating the sequence as long as the holds. + or is null. + + + + Concatenates the observable sequences obtained by running the for each element in the given enumerable . + + The type of the elements in the enumerable source sequence. + The type of the elements in the observable result sequence. + Enumerable source for which each element will be mapped onto an observable source that will be concatenated in the result sequence. + Function to select an observable source for each element in the . + The observable sequence obtained by concatenating the sources returned by for each element in the . + or is null. + + + + If the specified evaluates true, select the sequence. Otherwise, select the sequence. + + The type of the elements in the result sequence. + Condition evaluated to decide which sequence to return. + Sequence returned in case evaluates true. + Sequence returned in case evaluates false. + if evaluates true; otherwise. + or or is null. + + + + If the specified evaluates true, select the sequence. Otherwise, return an empty sequence. + + The type of the elements in the result sequence. + Condition evaluated to decide which sequence to return. + Sequence returned in case evaluates true. + if evaluates true; an empty sequence otherwise. + or is null. + + + + If the specified evaluates true, select the sequence. Otherwise, return an empty sequence generated on the specified scheduler. + + The type of the elements in the result sequence. + Condition evaluated to decide which sequence to return. + Sequence returned in case evaluates true. + Scheduler to generate an empty sequence on in case evaluates false. + if evaluates true; an empty sequence otherwise. + or or is null. + + + + Repeats the given as long as the specified holds, where the is evaluated before each repeated is subscribed to. + + The type of the elements in the source sequence. + Source to repeat as long as the function evaluates to true. + Condition that will be evaluated before subscription to the , to determine whether repetition of the source is required. + The observable sequence obtained by concatenating the sequence as long as the holds. + or is null. + + + + Creates a pattern that matches when both observable sequences have an available element. + + The type of the elements in the left sequence. + The type of the elements in the right sequence. + Observable sequence to match with the right sequence. + Observable sequence to match with the left sequence. + Pattern object that matches when both observable sequences have an available element. + or is null. + + + + Matches when the observable sequence has an available element and projects the element by invoking the selector function. + + The type of the elements in the source sequence. + The type of the elements in the result sequence, returned by the selector function. + Observable sequence to apply the selector on. + Selector that will be invoked for elements in the source sequence. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + or is null. + + + + Joins together the results from several patterns. + + The type of the elements in the result sequence, obtained from the specified patterns. + A series of plans created by use of the Then operator on patterns. + An observable sequence with the results from matching several patterns. + is null. + + + + Joins together the results from several patterns. + + The type of the elements in the result sequence, obtained from the specified patterns. + A series of plans created by use of the Then operator on patterns. + An observable sequence with the results form matching several patterns. + is null. + + + + Propagates the observable sequence that reacts first. + + The type of the elements in the source sequences. + First observable sequence. + Second observable sequence. + An observable sequence that surfaces either of the given sequences, whichever reacted first. + or is null. + + + + Propagates the observable sequence that reacts first. + + The type of the elements in the source sequences. + Observable sources competing to react first. + An observable sequence that surfaces any of the given sequences, whichever reacted first. + is null. + + + + Propagates the observable sequence that reacts first. + + The type of the elements in the source sequences. + Observable sources competing to react first. + An observable sequence that surfaces any of the given sequences, whichever reacted first. + is null. + + + + Projects each element of an observable sequence into consecutive non-overlapping buffers. + + The type of the elements in the source sequence, and in the lists in the result sequence. + The type of the elements in the sequences indicating buffer closing events. + Source sequence to produce buffers over. + A function invoked to define the boundaries of the produced buffers. A new buffer is started when the previous one is closed. + An observable sequence of buffers. + or is null. + + + + Projects each element of an observable sequence into zero or more buffers. + + The type of the elements in the source sequence, and in the lists in the result sequence. + The type of the elements in the sequence indicating buffer opening events, also passed to the closing selector to obtain a sequence of buffer closing events. + The type of the elements in the sequences indicating buffer closing events. + Source sequence to produce buffers over. + Observable sequence whose elements denote the creation of new buffers. + A function invoked to define the closing of each produced buffer. + An observable sequence of buffers. + or or is null. + + + + Projects each element of an observable sequence into consecutive non-overlapping buffers. + + The type of the elements in the source sequence, and in the lists in the result sequence. + The type of the elements in the sequences indicating buffer boundary events. + Source sequence to produce buffers over. + Sequence of buffer boundary markers. The current buffer is closed and a new buffer is opened upon receiving a boundary marker. + An observable sequence of buffers. + or is null. + + + + Continues an observable sequence that is terminated by an exception of the specified type with the observable sequence produced by the handler. + + The type of the elements in the source sequence and sequences returned by the exception handler function. + The type of the exception to catch and handle. Needs to derive from . + Source sequence. + Exception handler function, producing another observable sequence. + An observable sequence containing the source sequence's elements, followed by the elements produced by the handler's resulting observable sequence in case an exception occurred. + or is null. + + + + Continues an observable sequence that is terminated by an exception with the next observable sequence. + + The type of the elements in the source sequence and handler sequence. + First observable sequence whose exception (if any) is caught. + Second observable sequence used to produce results when an error occurred in the first sequence. + An observable sequence containing the first sequence's elements, followed by the elements of the second sequence in case an exception occurred. + or is null. + + + + Continues an observable sequence that is terminated by an exception with the next observable sequence. + + The type of the elements in the source and handler sequences. + Observable sequences to catch exceptions for. + An observable sequence containing elements from consecutive source sequences until a source sequence terminates successfully. + is null. + + + + Continues an observable sequence that is terminated by an exception with the next observable sequence. + + The type of the elements in the source and handler sequences. + Observable sequences to catch exceptions for. + An observable sequence containing elements from consecutive source sequences until a source sequence terminates successfully. + is null. + + + + Merges two observable sequences into one observable sequence by using the selector function whenever one of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Function to invoke whenever either of the sources produces an element. + An observable sequence containing the result of combining elements of both sources using the specified result selector function. + or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Eleventh observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Eleventh observable source. + Twelfth observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the thirteenth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Eleventh observable source. + Twelfth observable source. + Thirteenth observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the thirteenth source sequence. + The type of the elements in the fourteenth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Eleventh observable source. + Twelfth observable source. + Thirteenth observable source. + Fourteenth observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the thirteenth source sequence. + The type of the elements in the fourteenth source sequence. + The type of the elements in the fifteenth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Eleventh observable source. + Twelfth observable source. + Thirteenth observable source. + Fourteenth observable source. + Fifteenth observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or or or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the thirteenth source sequence. + The type of the elements in the fourteenth source sequence. + The type of the elements in the fifteenth source sequence. + The type of the elements in the sixteenth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Eleventh observable source. + Twelfth observable source. + Thirteenth observable source. + Fourteenth observable source. + Fifteenth observable source. + Sixteenth observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or or or or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the source sequences. + The type of the elements in the result sequence, returned by the selector function. + Observable sources. + Function to invoke whenever any of the sources produces an element. For efficiency, the input list is reused after the selector returns. Either aggregate or copy the values during the function call. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or is null. + + + + Merges the specified observable sequences into one observable sequence by emitting a list with the latest source elements whenever any of the observable sequences produces an element. + + The type of the elements in the source sequences, and in the lists in the result sequence. + Observable sources. + An observable sequence containing lists of the latest elements of the sources. + is null. + + + + Merges the specified observable sequences into one observable sequence by emitting a list with the latest source elements whenever any of the observable sequences produces an element. + + The type of the elements in the source sequences, and in the lists in the result sequence. + Observable sources. + An observable sequence containing lists of the latest elements of the sources. + is null. + + + + Concatenates the second observable sequence to the first observable sequence upon successful termination of the first. + + The type of the elements in the source sequences. + First observable sequence. + Second observable sequence. + An observable sequence that contains the elements of the first sequence, followed by those of the second the sequence. + or is null. + + + + Concatenates all of the specified observable sequences, as long as the previous observable sequence terminated successfully. + + The type of the elements in the source sequences. + Observable sequences to concatenate. + An observable sequence that contains the elements of each given sequence, in sequential order. + is null. + + + + Concatenates all observable sequences in the given enumerable sequence, as long as the previous observable sequence terminated successfully. + + The type of the elements in the source sequences. + Observable sequences to concatenate. + An observable sequence that contains the elements of each given sequence, in sequential order. + is null. + + + + Concatenates all inner observable sequences, as long as the previous observable sequence terminated successfully. + + The type of the elements in the source sequences. + Observable sequence of inner observable sequences. + An observable sequence that contains the elements of each observed inner sequence, in sequential order. + is null. + + + + Concatenates all task results, as long as the previous task terminated successfully. + + The type of the results produced by the tasks. + Observable sequence of tasks. + An observable sequence that contains the results of each task, in sequential order. + is null. + If the tasks support cancellation, consider manual conversion of the tasks using , followed by a concatenation operation using . + + + + Merges elements from all inner observable sequences into a single observable sequence. + + The type of the elements in the source sequences. + Observable sequence of inner observable sequences. + The observable sequence that merges the elements of the inner sequences. + is null. + + + + Merges results from all source tasks into a single observable sequence. + + The type of the results produced by the source tasks. + Observable sequence of tasks. + The observable sequence that merges the results of the source tasks. + is null. + If the tasks support cancellation, consider manual conversion of the tasks using , followed by a merge operation using . + + + + Merges elements from all inner observable sequences into a single observable sequence, limiting the number of concurrent subscriptions to inner sequences. + + The type of the elements in the source sequences. + Observable sequence of inner observable sequences. + Maximum number of inner observable sequences being subscribed to concurrently. + The observable sequence that merges the elements of the inner sequences. + is null. + is less than or equal to zero. + + + + Merges elements from all observable sequences in the given enumerable sequence into a single observable sequence, limiting the number of concurrent subscriptions to inner sequences. + + The type of the elements in the source sequences. + Enumerable sequence of observable sequences. + Maximum number of observable sequences being subscribed to concurrently. + The observable sequence that merges the elements of the observable sequences. + is null. + is less than or equal to zero. + + + + Merges elements from all observable sequences in the given enumerable sequence into a single observable sequence, limiting the number of concurrent subscriptions to inner sequences, and using the specified scheduler for enumeration of and subscription to the sources. + + The type of the elements in the source sequences. + Enumerable sequence of observable sequences. + Maximum number of observable sequences being subscribed to concurrently. + Scheduler to run the enumeration of the sequence of sources on. + The observable sequence that merges the elements of the observable sequences. + or is null. + is less than or equal to zero. + + + + Merges elements from two observable sequences into a single observable sequence. + + The type of the elements in the source sequences. + First observable sequence. + Second observable sequence. + The observable sequence that merges the elements of the given sequences. + or is null. + + + + Merges elements from two observable sequences into a single observable sequence, using the specified scheduler for enumeration of and subscription to the sources. + + The type of the elements in the source sequences. + First observable sequence. + Second observable sequence. + Scheduler used to introduce concurrency for making subscriptions to the given sequences. + The observable sequence that merges the elements of the given sequences. + or or is null. + + + + Merges elements from all of the specified observable sequences into a single observable sequence. + + The type of the elements in the source sequences. + Observable sequences. + The observable sequence that merges the elements of the observable sequences. + is null. + + + + Merges elements from all of the specified observable sequences into a single observable sequence, using the specified scheduler for enumeration of and subscription to the sources. + + The type of the elements in the source sequences. + Observable sequences. + Scheduler to run the enumeration of the sequence of sources on. + The observable sequence that merges the elements of the observable sequences. + or is null. + + + + Merges elements from all observable sequences in the given enumerable sequence into a single observable sequence. + + The type of the elements in the source sequences. + Enumerable sequence of observable sequences. + The observable sequence that merges the elements of the observable sequences. + is null. + + + + Merges elements from all observable sequences in the given enumerable sequence into a single observable sequence, using the specified scheduler for enumeration of and subscription to the sources. + + The type of the elements in the source sequences. + Enumerable sequence of observable sequences. + Scheduler to run the enumeration of the sequence of sources on. + The observable sequence that merges the elements of the observable sequences. + or is null. + + + + Concatenates the second observable sequence to the first observable sequence upon successful or exceptional termination of the first. + + The type of the elements in the source sequences. + First observable sequence whose exception (if any) is caught. + Second observable sequence used to produce results after the first sequence terminates. + An observable sequence that concatenates the first and second sequence, even if the first sequence terminates exceptionally. + or is null. + + + + Concatenates all of the specified observable sequences, even if the previous observable sequence terminated exceptionally. + + The type of the elements in the source sequences. + Observable sequences to concatenate. + An observable sequence that concatenates the source sequences, even if a sequence terminates exceptionally. + is null. + + + + Concatenates all observable sequences in the given enumerable sequence, even if the previous observable sequence terminated exceptionally. + + The type of the elements in the source sequences. + Observable sequences to concatenate. + An observable sequence that concatenates the source sequences, even if a sequence terminates exceptionally. + is null. + + + + Returns the elements from the source observable sequence only after the other observable sequence produces an element. + Starting from Rx.NET 4.0, this will subscribe to before subscribing to + so in case emits an element right away, elements from are not missed. + + The type of the elements in the source sequence. + The type of the elements in the other sequence that indicates the end of skip behavior. + Source sequence to propagate elements for. + Observable sequence that triggers propagation of elements of the source sequence. + An observable sequence containing the elements of the source sequence starting from the point the other sequence triggered propagation. + or is null. + + + + Transforms an observable sequence of observable sequences into an observable sequence + producing values only from the most recent observable sequence. + Each time a new inner observable sequence is received, unsubscribe from the + previous inner observable sequence. + + The type of the elements in the source sequences. + Observable sequence of inner observable sequences. + The observable sequence that at any point in time produces the elements of the most recent inner observable sequence that has been received. + is null. + + + + Transforms an observable sequence of tasks into an observable sequence + producing values only from the most recent observable sequence. + Each time a new task is received, the previous task's result is ignored. + + The type of the results produced by the source tasks. + Observable sequence of tasks. + The observable sequence that at any point in time produces the result of the most recent task that has been received. + is null. + If the tasks support cancellation, consider manual conversion of the tasks using , followed by a switch operation using . + + + + Returns the elements from the source observable sequence until the other observable sequence produces an element. + + The type of the elements in the source sequence. + The type of the elements in the other sequence that indicates the end of take behavior. + Source sequence to propagate elements for. + Observable sequence that terminates propagation of elements of the source sequence. + An observable sequence containing the elements of the source sequence up to the point the other sequence interrupted further propagation. + or is null. + + + + Relays elements from the source observable sequence and calls the predicate after an + emission to check if the sequence should stop after that specific item. + + The type of the elements in the source and result sequences. + The source sequence to relay elements of. + Called after each upstream item has been emitted with + that upstream item and should return true to indicate the sequence should + complete. + The observable sequence with the source elements until the stop predicate returns true. + + The following sequence will stop after the value 5 has been encountered: + + Observable.Range(1, 10) + .TakeUntil(item => item == 5) + .Subscribe(Console.WriteLine); + + + If or is null. + + + + Projects each element of an observable sequence into consecutive non-overlapping windows. + + The type of the elements in the source sequence, and in the windows in the result sequence. + The type of the elements in the sequences indicating window closing events. + Source sequence to produce windows over. + A function invoked to define the boundaries of the produced windows. A new window is started when the previous one is closed. + An observable sequence of windows. + or is null. + + + + Projects each element of an observable sequence into zero or more windows. + + The type of the elements in the source sequence, and in the windows in the result sequence. + The type of the elements in the sequence indicating window opening events, also passed to the closing selector to obtain a sequence of window closing events. + The type of the elements in the sequences indicating window closing events. + Source sequence to produce windows over. + Observable sequence whose elements denote the creation of new windows. + A function invoked to define the closing of each produced window. + An observable sequence of windows. + or or is null. + + + + Projects each element of an observable sequence into consecutive non-overlapping windows. + + The type of the elements in the source sequence, and in the windows in the result sequence. + The type of the elements in the sequences indicating window boundary events. + Source sequence to produce windows over. + Sequence of window boundary markers. The current window is closed and a new window is opened upon receiving a boundary marker. + An observable sequence of windows. + or is null. + + + + Merges two observable sequences into one observable sequence by combining each element from the first source with the latest element from the second source, if any. + Starting from Rx.NET 4.0, this will subscribe to before subscribing to to have a latest element readily available + in case emits an element right away. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Function to invoke for each element from the first source combined with the latest element from the second source, if any. + An observable sequence containing the result of combining each element of the first source with the latest element from the second source, if any, using the specified result selector function. + or or is null. + + + + Merges two observable sequences into one observable sequence by combining their elements in a pairwise fashion. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Function to invoke for each consecutive pair of elements from the first and second source. + An observable sequence containing the result of pairwise combining the elements of the first and second source using the specified result selector function. + or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Eleventh observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Eleventh observable source. + Twelfth observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the thirteenth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Eleventh observable source. + Twelfth observable source. + Thirteenth observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the thirteenth source sequence. + The type of the elements in the fourteenth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Eleventh observable source. + Twelfth observable source. + Thirteenth observable source. + Fourteenth observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the thirteenth source sequence. + The type of the elements in the fourteenth source sequence. + The type of the elements in the fifteenth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Eleventh observable source. + Twelfth observable source. + Thirteenth observable source. + Fourteenth observable source. + Fifteenth observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or or or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the thirteenth source sequence. + The type of the elements in the fourteenth source sequence. + The type of the elements in the fifteenth source sequence. + The type of the elements in the sixteenth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Eleventh observable source. + Twelfth observable source. + Thirteenth observable source. + Fourteenth observable source. + Fifteenth observable source. + Sixteenth observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or or or or or or or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the source sequences. + The type of the elements in the result sequence, returned by the selector function. + Observable sources. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + or is null. + + + + Merges the specified observable sequences into one observable sequence by emitting a list with the elements of the observable sequences at corresponding indexes. + + The type of the elements in the source sequences, and in the lists in the result sequence. + Observable sources. + An observable sequence containing lists of elements at corresponding indexes. + is null. + + + + Merges the specified observable sequences into one observable sequence by emitting a list with the elements of the observable sequences at corresponding indexes. + + The type of the elements in the source sequences, and in the lists in the result sequence. + Observable sources. + An observable sequence containing lists of elements at corresponding indexes. + is null. + + + + Merges an observable sequence and an enumerable sequence into one observable sequence by using the selector function. + + The type of the elements in the first observable source sequence. + The type of the elements in the second enumerable source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second enumerable source. + Function to invoke for each consecutive pair of elements from the first and second source. + An observable sequence containing the result of pairwise combining the elements of the first and second source using the specified result selector function. + or or is null. + + + + Append a value to an observable sequence. + + The type of the elements in the source sequence. + Source sequence to append the value to. + Value to append to the specified sequence. + The source sequence appended with the specified value. + is null. + + + + Append a value to an observable sequence. + + The type of the elements in the source sequence. + Source sequence to append the value to. + Value to append to the specified sequence. + Scheduler to emit the append values on. + The source sequence appended with the specified value. + is null. + + + + Hides the identity of an observable sequence. + + The type of the elements in the source sequence. + An observable sequence whose identity to hide. + An observable sequence that hides the identity of the source sequence. + is null. + + + + Projects each element of an observable sequence into consecutive non-overlapping buffers which are produced based on element count information. + + The type of the elements in the source sequence, and in the lists in the result sequence. + Source sequence to produce buffers over. + Length of each buffer. + An observable sequence of buffers. + is null. + is less than or equal to zero. + + + + Projects each element of an observable sequence into zero or more buffers which are produced based on element count information. + + The type of the elements in the source sequence, and in the lists in the result sequence. + Source sequence to produce buffers over. + Length of each buffer. + Number of elements to skip between creation of consecutive buffers. + An observable sequence of buffers. + is null. + or is less than or equal to zero. + + + + Dematerializes the explicit notification values of an observable sequence as implicit notifications. + + The type of the elements materialized in the source sequence notification objects. + An observable sequence containing explicit notification values which have to be turned into implicit notifications. + An observable sequence exhibiting the behavior corresponding to the source sequence's notification values. + is null. + + + + Returns an observable sequence that contains only distinct contiguous elements. + + The type of the elements in the source sequence. + An observable sequence to retain distinct contiguous elements for. + An observable sequence only containing the distinct contiguous elements from the source sequence. + is null. + + + + Returns an observable sequence that contains only distinct contiguous elements according to the comparer. + + The type of the elements in the source sequence. + An observable sequence to retain distinct contiguous elements for. + Equality comparer for source elements. + An observable sequence only containing the distinct contiguous elements from the source sequence. + or is null. + + + + Returns an observable sequence that contains only distinct contiguous elements according to the keySelector. + + The type of the elements in the source sequence. + The type of the discriminator key computed for each element in the source sequence. + An observable sequence to retain distinct contiguous elements for, based on a computed key value. + A function to compute the comparison key for each element. + An observable sequence only containing the distinct contiguous elements, based on a computed key value, from the source sequence. + or is null. + + + + Returns an observable sequence that contains only distinct contiguous elements according to the keySelector and the comparer. + + The type of the elements in the source sequence. + The type of the discriminator key computed for each element in the source sequence. + An observable sequence to retain distinct contiguous elements for, based on a computed key value. + A function to compute the comparison key for each element. + Equality comparer for computed key values. + An observable sequence only containing the distinct contiguous elements, based on a computed key value, from the source sequence. + or or is null. + + + + Invokes an action for each element in the observable sequence, and propagates all observer messages through the result sequence. + This method can be used for debugging, logging, etc. of query behavior by intercepting the message stream to run arbitrary actions for messages on the pipeline. + + The type of the elements in the source sequence. + Source sequence. + Action to invoke for each element in the observable sequence. + The source sequence with the side-effecting behavior applied. + or is null. + + + + Invokes an action for each element in the observable sequence and invokes an action upon graceful termination of the observable sequence. + This method can be used for debugging, logging, etc. of query behavior by intercepting the message stream to run arbitrary actions for messages on the pipeline. + + The type of the elements in the source sequence. + Source sequence. + Action to invoke for each element in the observable sequence. + Action to invoke upon graceful termination of the observable sequence. + The source sequence with the side-effecting behavior applied. + or or is null. + + + + Invokes an action for each element in the observable sequence and invokes an action upon exceptional termination of the observable sequence. + This method can be used for debugging, logging, etc. of query behavior by intercepting the message stream to run arbitrary actions for messages on the pipeline. + + The type of the elements in the source sequence. + Source sequence. + Action to invoke for each element in the observable sequence. + Action to invoke upon exceptional termination of the observable sequence. + The source sequence with the side-effecting behavior applied. + or or is null. + + + + Invokes an action for each element in the observable sequence and invokes an action upon graceful or exceptional termination of the observable sequence. + This method can be used for debugging, logging, etc. of query behavior by intercepting the message stream to run arbitrary actions for messages on the pipeline. + + The type of the elements in the source sequence. + Source sequence. + Action to invoke for each element in the observable sequence. + Action to invoke upon exceptional termination of the observable sequence. + Action to invoke upon graceful termination of the observable sequence. + The source sequence with the side-effecting behavior applied. + or or or is null. + + + + Invokes the observer's methods for each message in the source sequence. + This method can be used for debugging, logging, etc. of query behavior by intercepting the message stream to run arbitrary actions for messages on the pipeline. + + The type of the elements in the source sequence. + Source sequence. + Observer whose methods to invoke as part of the source sequence's observation. + The source sequence with the side-effecting behavior applied. + or is null. + + + + Invokes a specified action after the source observable sequence terminates gracefully or exceptionally. + + The type of the elements in the source sequence. + Source sequence. + Action to invoke after the source observable sequence terminates. + Source sequence with the action-invoking termination behavior applied. + or is null. + + + + Ignores all elements in an observable sequence leaving only the termination messages. + + The type of the elements in the source sequence. + Source sequence. + An empty observable sequence that signals termination, successful or exceptional, of the source sequence. + is null. + + + + Materializes the implicit notifications of an observable sequence as explicit notification values. + + The type of the elements in the source sequence. + An observable sequence to get notification values for. + An observable sequence containing the materialized notification values from the source sequence. + is null. + + + + Prepend a value to an observable sequence. + + The type of the elements in the source sequence. + Source sequence to prepend the value to. + Value to prepend to the specified sequence. + The source sequence prepended with the specified value. + is null. + + + + Prepend a value to an observable sequence. + + The type of the elements in the source sequence. + Source sequence to prepend the value to. + Value to prepend to the specified sequence. + Scheduler to emit the prepend values on. + The source sequence prepended with the specified value. + is null. + + + + Repeats the observable sequence indefinitely. + + The type of the elements in the source sequence. + Observable sequence to repeat. + The observable sequence producing the elements of the given sequence repeatedly and sequentially. + is null. + + + + Repeats the observable sequence a specified number of times. + + The type of the elements in the source sequence. + Observable sequence to repeat. + Number of times to repeat the sequence. + The observable sequence producing the elements of the given sequence repeatedly. + is null. + is less than zero. + + + + Repeatedly resubscribes to the source observable after a normal completion and when the observable + returned by a handler produces an arbitrary item. + + The type of the elements in the source sequence. + The arbitrary element type signaled by the handler observable. + Observable sequence to keep repeating when it successfully terminates. + The function that is called for each observer and takes an observable sequence objects. + It should return an observable of arbitrary items that should signal that arbitrary item in + response to receiving the completion signal from the source observable. If this observable signals + a terminal event, the sequence is terminated with that signal instead. + An observable sequence producing the elements of the given sequence repeatedly while each repetition terminates successfully. + is null. + is null. + + + + Repeats the source observable sequence until it successfully terminates. + + The type of the elements in the source sequence. + Observable sequence to repeat until it successfully terminates. + An observable sequence producing the elements of the given sequence repeatedly until it terminates successfully. + is null. + + + + Repeats the source observable sequence the specified number of times or until it successfully terminates. + + The type of the elements in the source sequence. + Observable sequence to repeat until it successfully terminates. + Number of times to repeat the sequence. + An observable sequence producing the elements of the given sequence repeatedly until it terminates successfully. + is null. + is less than zero. + + + + Retries (resubscribes to) the source observable after a failure and when the observable + returned by a handler produces an arbitrary item. + + The type of the elements in the source sequence. + The arbitrary element type signaled by the handler observable. + Observable sequence to repeat until it successfully terminates. + The function that is called for each observer and takes an observable sequence of + errors. It should return an observable of arbitrary items that should signal that arbitrary item in + response to receiving the failure Exception from the source observable. If this observable signals + a terminal event, the sequence is terminated with that signal instead. + An observable sequence producing the elements of the given sequence repeatedly until it terminates successfully. + is null. + is null. + + + + Applies an accumulator function over an observable sequence and returns each intermediate result. The specified seed value is used as the initial accumulator value. + For aggregation behavior with no intermediate results, see . + + The type of the elements in the source sequence. + The type of the result of the aggregation. + An observable sequence to accumulate over. + The initial accumulator value. + An accumulator function to be invoked on each element. + An observable sequence containing the accumulated values. + or is null. + + + + Applies an accumulator function over an observable sequence and returns each intermediate result. + For aggregation behavior with no intermediate results, see . + + The type of the elements in the source sequence and the result of the aggregation. + An observable sequence to accumulate over. + An accumulator function to be invoked on each element. + An observable sequence containing the accumulated values. + or is null. + + + + Bypasses a specified number of elements at the end of an observable sequence. + + The type of the elements in the source sequence. + Source sequence. + Number of elements to bypass at the end of the source sequence. + An observable sequence containing the source sequence elements except for the bypassed ones at the end. + is null. + is less than zero. + + This operator accumulates a queue with a length enough to store the first elements. As more elements are + received, elements are taken from the front of the queue and produced on the result sequence. This causes elements to be delayed. + + + + + Prepends a sequence of values to an observable sequence. + + The type of the elements in the source sequence. + Source sequence to prepend values to. + Values to prepend to the specified sequence. + The source sequence prepended with the specified values. + or is null. + + + + Prepends a sequence of values to an observable sequence. + + The type of the elements in the source sequence. + Source sequence to prepend values to. + Values to prepend to the specified sequence. + The source sequence prepended with the specified values. + or is null. + + + + Prepends a sequence of values to an observable sequence. + + The type of the elements in the source sequence. + Source sequence to prepend values to. + Scheduler to emit the prepended values on. + Values to prepend to the specified sequence. + The source sequence prepended with the specified values. + or or is null. + + + + Prepends a sequence of values to an observable sequence. + + The type of the elements in the source sequence. + Source sequence to prepend values to. + Scheduler to emit the prepended values on. + Values to prepend to the specified sequence. + The source sequence prepended with the specified values. + or or is null. + + + + Returns a specified number of contiguous elements from the end of an observable sequence. + + The type of the elements in the source sequence. + Source sequence. + Number of elements to take from the end of the source sequence. + An observable sequence containing the specified number of elements from the end of the source sequence. + is null. + is less than zero. + + This operator accumulates a buffer with a length enough to store elements elements. Upon completion of + the source sequence, this buffer is drained on the result sequence. This causes the elements to be delayed. + + + + + Returns a specified number of contiguous elements from the end of an observable sequence, using the specified scheduler to drain the queue. + + The type of the elements in the source sequence. + Source sequence. + Number of elements to take from the end of the source sequence. + Scheduler used to drain the queue upon completion of the source sequence. + An observable sequence containing the specified number of elements from the end of the source sequence. + or is null. + is less than zero. + + This operator accumulates a buffer with a length enough to store elements elements. Upon completion of + the source sequence, this buffer is drained on the result sequence. This causes the elements to be delayed. + + + + + Returns a list with the specified number of contiguous elements from the end of an observable sequence. + + The type of the elements in the source sequence. + Source sequence. + Number of elements to take from the end of the source sequence. + An observable sequence containing a single list with the specified number of elements from the end of the source sequence. + is null. + is less than zero. + + This operator accumulates a buffer with a length enough to store elements. Upon completion of the + source sequence, this buffer is produced on the result sequence. + + + + + Projects each element of an observable sequence into consecutive non-overlapping windows which are produced based on element count information. + + The type of the elements in the source sequence, and in the windows in the result sequence. + Source sequence to produce windows over. + Length of each window. + An observable sequence of windows. + is null. + is less than or equal to zero. + + + + Projects each element of an observable sequence into zero or more windows which are produced based on element count information. + + The type of the elements in the source sequence, and in the windows in the result sequence. + Source sequence to produce windows over. + Length of each window. + Number of elements to skip between creation of consecutive windows. + An observable sequence of windows. + is null. + or is less than or equal to zero. + + + + Converts the elements of an observable sequence to the specified type. + + The type to convert the elements in the source sequence to. + The observable sequence that contains the elements to be converted. + An observable sequence that contains each element of the source sequence converted to the specified type. + is null. + + + + Returns the elements of the specified sequence or the type parameter's default value in a singleton sequence if the sequence is empty. + + The type of the elements in the source sequence (if any), whose default value will be taken if the sequence is empty. + The sequence to return a default value for if it is empty. + An observable sequence that contains the default value for the TSource type if the source is empty; otherwise, the elements of the source itself. + is null. + + + + Returns the elements of the specified sequence or the specified value in a singleton sequence if the sequence is empty. + + The type of the elements in the source sequence (if any), and the specified default value which will be taken if the sequence is empty. + The sequence to return the specified value for if it is empty. + The value to return if the sequence is empty. + An observable sequence that contains the specified default value if the source is empty; otherwise, the elements of the source itself. + is null. + + + + Returns an observable sequence that contains only distinct elements. + + The type of the elements in the source sequence. + An observable sequence to retain distinct elements for. + An observable sequence only containing the distinct elements from the source sequence. + is null. + Usage of this operator should be considered carefully due to the maintenance of an internal lookup structure which can grow large. + + + + Returns an observable sequence that contains only distinct elements according to the comparer. + + The type of the elements in the source sequence. + An observable sequence to retain distinct elements for. + Equality comparer for source elements. + An observable sequence only containing the distinct elements from the source sequence. + or is null. + Usage of this operator should be considered carefully due to the maintenance of an internal lookup structure which can grow large. + + + + Returns an observable sequence that contains only distinct elements according to the keySelector. + + The type of the elements in the source sequence. + The type of the discriminator key computed for each element in the source sequence. + An observable sequence to retain distinct elements for. + A function to compute the comparison key for each element. + An observable sequence only containing the distinct elements, based on a computed key value, from the source sequence. + or is null. + Usage of this operator should be considered carefully due to the maintenance of an internal lookup structure which can grow large. + + + + Returns an observable sequence that contains only distinct elements according to the keySelector and the comparer. + + The type of the elements in the source sequence. + The type of the discriminator key computed for each element in the source sequence. + An observable sequence to retain distinct elements for. + A function to compute the comparison key for each element. + Equality comparer for source elements. + An observable sequence only containing the distinct elements, based on a computed key value, from the source sequence. + or or is null. + Usage of this operator should be considered carefully due to the maintenance of an internal lookup structure which can grow large. + + + + Groups the elements of an observable sequence according to a specified key selector function. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + An observable sequence whose elements to group. + A function to extract the key for each element. + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + or is null. + + + + Groups the elements of an observable sequence according to a specified key selector function and comparer. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + An observable sequence whose elements to group. + A function to extract the key for each element. + An equality comparer to compare keys with. + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + or or is null. + + + + Groups the elements of an observable sequence and selects the resulting elements by using a specified function. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + The type of the elements within the groups computed for each element in the source sequence. + An observable sequence whose elements to group. + A function to extract the key for each element. + A function to map each source element to an element in an observable group. + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + or or is null. + + + + Groups the elements of an observable sequence according to a specified key selector function and comparer and selects the resulting elements by using a specified function. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + The type of the elements within the groups computed for each element in the source sequence. + An observable sequence whose elements to group. + A function to extract the key for each element. + A function to map each source element to an element in an observable group. + An equality comparer to compare keys with. + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + or or or is null. + + + + Groups the elements of an observable sequence with the specified initial capacity according to a specified key selector function. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + An observable sequence whose elements to group. + A function to extract the key for each element. + The initial number of elements that the underlying dictionary can contain. + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + or is null. + is less than 0. + + + + Groups the elements of an observable sequence with the specified initial capacity according to a specified key selector function and comparer. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + An observable sequence whose elements to group. + A function to extract the key for each element. + The initial number of elements that the underlying dictionary can contain. + An equality comparer to compare keys with. + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + or or is null. + is less than 0. + + + + Groups the elements of an observable sequence with the specified initial capacity and selects the resulting elements by using a specified function. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + The type of the elements within the groups computed for each element in the source sequence. + An observable sequence whose elements to group. + A function to extract the key for each element. + A function to map each source element to an element in an observable group. + The initial number of elements that the underlying dictionary can contain. + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + or or is null. + is less than 0. + + + + Groups the elements of an observable sequence with the specified initial capacity according to a specified key selector function and comparer and selects the resulting elements by using a specified function. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + The type of the elements within the groups computed for each element in the source sequence. + An observable sequence whose elements to group. + A function to extract the key for each element. + A function to map each source element to an element in an observable group. + The initial number of elements that the underlying dictionary can contain. + An equality comparer to compare keys with. + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + or or or is null. + is less than 0. + + + + Groups the elements of an observable sequence according to a specified key selector function and comparer and selects the resulting elements by using a specified function. + A duration selector function is used to control the lifetime of groups. When a group expires, it receives an OnCompleted notification. When a new element with the same + key value as a reclaimed group occurs, the group will be reborn with a new lifetime request. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + The type of the elements within the groups computed for each element in the source sequence. + The type of the elements in the duration sequences obtained for each group to denote its lifetime. + An observable sequence whose elements to group. + A function to extract the key for each element. + A function to map each source element to an element in an observable group. + A function to signal the expiration of a group. + An equality comparer to compare keys with. + + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + If a group's lifetime expires, a new group with the same key value can be created once an element with such a key value is encountered. + + or or or or is null. + + + + Groups the elements of an observable sequence according to a specified key selector function and selects the resulting elements by using a specified function. + A duration selector function is used to control the lifetime of groups. When a group expires, it receives an OnCompleted notification. When a new element with the same + key value as a reclaimed group occurs, the group will be reborn with a new lifetime request. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + The type of the elements within the groups computed for each element in the source sequence. + The type of the elements in the duration sequences obtained for each group to denote its lifetime. + An observable sequence whose elements to group. + A function to extract the key for each element. + A function to map each source element to an element in an observable group. + A function to signal the expiration of a group. + + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + If a group's lifetime expires, a new group with the same key value can be created once an element with such a key value is encountered. + + or or or is null. + + + + Groups the elements of an observable sequence according to a specified key selector function and comparer. + A duration selector function is used to control the lifetime of groups. When a group expires, it receives an OnCompleted notification. When a new element with the same + key value as a reclaimed group occurs, the group will be reborn with a new lifetime request. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + The type of the elements in the duration sequences obtained for each group to denote its lifetime. + An observable sequence whose elements to group. + A function to extract the key for each element. + A function to signal the expiration of a group. + An equality comparer to compare keys with. + + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + If a group's lifetime expires, a new group with the same key value can be created once an element with such a key value is encountered. + + or or or is null. + + + + Groups the elements of an observable sequence according to a specified key selector function. + A duration selector function is used to control the lifetime of groups. When a group expires, it receives an OnCompleted notification. When a new element with the same + key value as a reclaimed group occurs, the group will be reborn with a new lifetime request. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + The type of the elements in the duration sequences obtained for each group to denote its lifetime. + An observable sequence whose elements to group. + A function to extract the key for each element. + A function to signal the expiration of a group. + + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + If a group's lifetime expires, a new group with the same key value can be created once an element with such a key value is encountered. + + or or is null. + + + + Groups the elements of an observable sequence with the specified initial capacity according to a specified key selector function and comparer and selects the resulting elements by using a specified function. + A duration selector function is used to control the lifetime of groups. When a group expires, it receives an OnCompleted notification. When a new element with the same + key value as a reclaimed group occurs, the group will be reborn with a new lifetime request. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + The type of the elements within the groups computed for each element in the source sequence. + The type of the elements in the duration sequences obtained for each group to denote its lifetime. + An observable sequence whose elements to group. + A function to extract the key for each element. + A function to map each source element to an element in an observable group. + A function to signal the expiration of a group. + The initial number of elements that the underlying dictionary can contain. + An equality comparer to compare keys with. + + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + If a group's lifetime expires, a new group with the same key value can be created once an element with such a key value is encountered. + + or or or or is null. + is less than 0. + + + + Groups the elements of an observable sequence with the specified initial capacity according to a specified key selector function and selects the resulting elements by using a specified function. + A duration selector function is used to control the lifetime of groups. When a group expires, it receives an OnCompleted notification. When a new element with the same + key value as a reclaimed group occurs, the group will be reborn with a new lifetime request. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + The type of the elements within the groups computed for each element in the source sequence. + The type of the elements in the duration sequences obtained for each group to denote its lifetime. + An observable sequence whose elements to group. + A function to extract the key for each element. + A function to map each source element to an element in an observable group. + A function to signal the expiration of a group. + The initial number of elements that the underlying dictionary can contain. + + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + If a group's lifetime expires, a new group with the same key value can be created once an element with such a key value is encountered. + + or or or is null. + is less than 0. + + + + Groups the elements of an observable sequence with the specified initial capacity according to a specified key selector function and comparer. + A duration selector function is used to control the lifetime of groups. When a group expires, it receives an OnCompleted notification. When a new element with the same + key value as a reclaimed group occurs, the group will be reborn with a new lifetime request. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + The type of the elements in the duration sequences obtained for each group to denote its lifetime. + An observable sequence whose elements to group. + A function to extract the key for each element. + A function to signal the expiration of a group. + The initial number of elements that the underlying dictionary can contain. + An equality comparer to compare keys with. + + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + If a group's lifetime expires, a new group with the same key value can be created once an element with such a key value is encountered. + + or or or is null. + is less than 0. + + + + Groups the elements of an observable sequence with the specified initial capacity according to a specified key selector function. + A duration selector function is used to control the lifetime of groups. When a group expires, it receives an OnCompleted notification. When a new element with the same + key value as a reclaimed group occurs, the group will be reborn with a new lifetime request. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + The type of the elements in the duration sequences obtained for each group to denote its lifetime. + An observable sequence whose elements to group. + A function to extract the key for each element. + A function to signal the expiration of a group. + The initial number of elements that the underlying dictionary can contain. + + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + If a group's lifetime expires, a new group with the same key value can be created once an element with such a key value is encountered. + + or or is null. + is less than 0. + + + + Correlates the elements of two sequences based on overlapping durations, and groups the results. + + The type of the elements in the left source sequence. + The type of the elements in the right source sequence. + The type of the elements in the duration sequence denoting the computed duration of each element in the left source sequence. + The type of the elements in the duration sequence denoting the computed duration of each element in the right source sequence. + The type of the elements in the result sequence, obtained by invoking the result selector function for source elements with overlapping duration. + The left observable sequence to join elements for. + The right observable sequence to join elements for. + A function to select the duration of each element of the left observable sequence, used to determine overlap. + A function to select the duration of each element of the right observable sequence, used to determine overlap. + A function invoked to compute a result element for any element of the left sequence with overlapping elements from the right observable sequence. + An observable sequence that contains result elements computed from source elements that have an overlapping duration. + or or or or is null. + + + + Correlates the elements of two sequences based on overlapping durations. + + The type of the elements in the left source sequence. + The type of the elements in the right source sequence. + The type of the elements in the duration sequence denoting the computed duration of each element in the left source sequence. + The type of the elements in the duration sequence denoting the computed duration of each element in the right source sequence. + The type of the elements in the result sequence, obtained by invoking the result selector function for source elements with overlapping duration. + The left observable sequence to join elements for. + The right observable sequence to join elements for. + A function to select the duration of each element of the left observable sequence, used to determine overlap. + A function to select the duration of each element of the right observable sequence, used to determine overlap. + A function invoked to compute a result element for any two overlapping elements of the left and right observable sequences. + An observable sequence that contains result elements computed from source elements that have an overlapping duration. + or or or or is null. + + + + Filters the elements of an observable sequence based on the specified type. + + The type to filter the elements in the source sequence on. + The observable sequence that contains the elements to be filtered. + An observable sequence that contains elements from the input sequence of type TResult. + is null. + + + + Projects each element of an observable sequence into a new form. + + The type of the elements in the source sequence. + The type of the elements in the result sequence, obtained by running the selector function for each element in the source sequence. + A sequence of elements to invoke a transform function on. + A transform function to apply to each source element. + An observable sequence whose elements are the result of invoking the transform function on each element of source. + or is null. + + + + Projects each element of an observable sequence into a new form by incorporating the element's index. + + The type of the elements in the source sequence. + The type of the elements in the result sequence, obtained by running the selector function for each element in the source sequence. + A sequence of elements to invoke a transform function on. + A transform function to apply to each source element; the second parameter of the function represents the index of the source element. + An observable sequence whose elements are the result of invoking the transform function on each element of source. + or is null. + + + + Projects each element of the source observable sequence to the other observable sequence and merges the resulting observable sequences into one observable sequence. + + The type of the elements in the source sequence. + The type of the elements in the other sequence and the elements in the result sequence. + An observable sequence of elements to project. + An observable sequence to project each element from the source sequence onto. + An observable sequence whose elements are the result of projecting each source element onto the other sequence and merging all the resulting sequences together. + or is null. + + + + Projects each element of an observable sequence to an observable sequence and merges the resulting observable sequences into one observable sequence. + + The type of the elements in the source sequence. + The type of the elements in the projected inner sequences and the elements in the merged result sequence. + An observable sequence of elements to project. + A transform function to apply to each element. + An observable sequence whose elements are the result of invoking the one-to-many transform function on each element of the input sequence. + or is null. + + + + Projects each element of an observable sequence to an observable sequence by incorporating the element's index and merges the resulting observable sequences into one observable sequence. + + The type of the elements in the source sequence. + The type of the elements in the projected inner sequences and the elements in the merged result sequence. + An observable sequence of elements to project. + A transform function to apply to each element; the second parameter of the function represents the index of the source element. + An observable sequence whose elements are the result of invoking the one-to-many transform function on each element of the input sequence. + or is null. + + + + Projects each element of an observable sequence to a task and merges all of the task results into one observable sequence. + + The type of the elements in the source sequence. + The type of the result produced by the projected tasks and the elements in the merged result sequence. + An observable sequence of elements to project. + A transform function to apply to each element. + An observable sequence whose elements are the result of the tasks executed for each element of the input sequence. + This overload supports composition of observable sequences and tasks, without requiring manual conversion of the tasks to observable sequences using . + or is null. + + + + Projects each element of an observable sequence to a task by incorporating the element's index and merges all of the task results into one observable sequence. + + The type of the elements in the source sequence. + The type of the result produced by the projected tasks and the elements in the merged result sequence. + An observable sequence of elements to project. + A transform function to apply to each element; the second parameter of the function represents the index of the source element. + An observable sequence whose elements are the result of the tasks executed for each element of the input sequence. + This overload supports composition of observable sequences and tasks, without requiring manual conversion of the tasks to observable sequences using . + or is null. + + + + Projects each element of an observable sequence to a task with cancellation support and merges all of the task results into one observable sequence. + + The type of the elements in the source sequence. + The type of the result produced by the projected tasks and the elements in the merged result sequence. + An observable sequence of elements to project. + A transform function to apply to each element. + An observable sequence whose elements are the result of the tasks executed for each element of the input sequence. + This overload supports composition of observable sequences and tasks, without requiring manual conversion of the tasks to observable sequences using . + or is null. + + + + Projects each element of an observable sequence to a task by incorporating the element's index with cancellation support and merges all of the task results into one observable sequence. + + The type of the elements in the source sequence. + The type of the result produced by the projected tasks and the elements in the merged result sequence. + An observable sequence of elements to project. + A transform function to apply to each element; the second parameter of the function represents the index of the source element. + An observable sequence whose elements are the result of the tasks executed for each element of the input sequence. + This overload supports composition of observable sequences and tasks, without requiring manual conversion of the tasks to observable sequences using . + or is null. + + + + Projects each element of an observable sequence to an observable sequence, invokes the result selector for the source element and each of the corresponding inner sequence's elements, and merges the results into one observable sequence. + + The type of the elements in the source sequence. + The type of the elements in the projected intermediate sequences. + The type of the elements in the result sequence, obtained by using the selector to combine source sequence elements with their corresponding intermediate sequence elements. + An observable sequence of elements to project. + A transform function to apply to each element. + A transform function to apply to each element of the intermediate sequence. + An observable sequence whose elements are the result of invoking the one-to-many transform function collectionSelector on each element of the input sequence and then mapping each of those sequence elements and their corresponding source element to a result element. + or or is null. + + + + Projects each element of an observable sequence to an observable sequence by incorporating the element's index, invokes the result selector for the source element and each of the corresponding inner sequence's elements, and merges the results into one observable sequence. + + The type of the elements in the source sequence. + The type of the elements in the projected intermediate sequences. + The type of the elements in the result sequence, obtained by using the selector to combine source sequence elements with their corresponding intermediate sequence elements. + An observable sequence of elements to project. + A transform function to apply to each element; the second parameter of the function represents the index of the source element. + A transform function to apply to each element of the intermediate sequence; the second parameter of the function represents the index of the source element and the fourth parameter represents the index of the intermediate element. + An observable sequence whose elements are the result of invoking the one-to-many transform function collectionSelector on each element of the input sequence and then mapping each of those sequence elements and their corresponding source element to a result element. + or or is null. + + + + Projects each element of an observable sequence to a task, invokes the result selector for the source element and the task result, and merges the results into one observable sequence. + + The type of the elements in the source sequence. + The type of the results produced by the projected intermediate tasks. + The type of the elements in the result sequence, obtained by using the selector to combine source sequence elements with their corresponding intermediate task results. + An observable sequence of elements to project. + A transform function to apply to each element. + A transform function to apply to each element of the intermediate sequence. + An observable sequence whose elements are the result of obtaining a task for each element of the input sequence and then mapping the task's result and its corresponding source element to a result element. + or or is null. + This overload supports using LINQ query comprehension syntax in C# and Visual Basic to compose observable sequences and tasks, without requiring manual conversion of the tasks to observable sequences using . + + + + Projects each element of an observable sequence to a task by incorporating the element's index, invokes the result selector for the source element and the task result, and merges the results into one observable sequence. + + The type of the elements in the source sequence. + The type of the results produced by the projected intermediate tasks. + The type of the elements in the result sequence, obtained by using the selector to combine source sequence elements with their corresponding intermediate task results. + An observable sequence of elements to project. + A transform function to apply to each element; the second parameter of the function represents the index of the source element. + A transform function to apply to each element of the intermediate sequence; the second parameter of the function represents the index of the source element. + An observable sequence whose elements are the result of obtaining a task for each element of the input sequence and then mapping the task's result and its corresponding source element to a result element. + or or is null. + This overload supports using LINQ query comprehension syntax in C# and Visual Basic to compose observable sequences and tasks, without requiring manual conversion of the tasks to observable sequences using . + + + + Projects each element of an observable sequence to a task with cancellation support, invokes the result selector for the source element and the task result, and merges the results into one observable sequence. + + The type of the elements in the source sequence. + The type of the results produced by the projected intermediate tasks. + The type of the elements in the result sequence, obtained by using the selector to combine source sequence elements with their corresponding intermediate task results. + An observable sequence of elements to project. + A transform function to apply to each element. + A transform function to apply to each element of the intermediate sequence. + An observable sequence whose elements are the result of obtaining a task for each element of the input sequence and then mapping the task's result and its corresponding source element to a result element. + or or is null. + This overload supports using LINQ query comprehension syntax in C# and Visual Basic to compose observable sequences and tasks, without requiring manual conversion of the tasks to observable sequences using . + + + + Projects each element of an observable sequence to a task by incorporating the element's index with cancellation support, invokes the result selector for the source element and the task result, and merges the results into one observable sequence. + + The type of the elements in the source sequence. + The type of the results produced by the projected intermediate tasks. + The type of the elements in the result sequence, obtained by using the selector to combine source sequence elements with their corresponding intermediate task results. + An observable sequence of elements to project. + A transform function to apply to each element; the second parameter of the function represents the index of the source element. + A transform function to apply to each element of the intermediate sequence; the second parameter of the function represents the index of the source element. + An observable sequence whose elements are the result of obtaining a task for each element of the input sequence and then mapping the task's result and its corresponding source element to a result element. + or or is null. + This overload supports using LINQ query comprehension syntax in C# and Visual Basic to compose observable sequences and tasks, without requiring manual conversion of the tasks to observable sequences using . + + + + Projects each notification of an observable sequence to an observable sequence and merges the resulting observable sequences into one observable sequence. + + The type of the elements in the source sequence. + The type of the elements in the projected inner sequences and the elements in the merged result sequence. + An observable sequence of notifications to project. + A transform function to apply to each element. + A transform function to apply when an error occurs in the source sequence. + A transform function to apply when the end of the source sequence is reached. + An observable sequence whose elements are the result of invoking the one-to-many transform function corresponding to each notification in the input sequence. + or or or is null. + + + + Projects each notification of an observable sequence to an observable sequence by incorporating the element's index and merges the resulting observable sequences into one observable sequence. + + The type of the elements in the source sequence. + The type of the elements in the projected inner sequences and the elements in the merged result sequence. + An observable sequence of notifications to project. + A transform function to apply to each element; the second parameter of the function represents the index of the source element. + A transform function to apply when an error occurs in the source sequence. + A transform function to apply when the end of the source sequence is reached. + An observable sequence whose elements are the result of invoking the one-to-many transform function corresponding to each notification in the input sequence. + or or or is null. + + + + Projects each element of an observable sequence to an enumerable sequence and concatenates the resulting enumerable sequences into one observable sequence. + + The type of the elements in the source sequence. + The type of the elements in the projected inner enumerable sequences and the elements in the merged result sequence. + An observable sequence of elements to project. + A transform function to apply to each element. + An observable sequence whose elements are the result of invoking the one-to-many transform function on each element of the input sequence. + or is null. + The projected sequences are enumerated synchronously within the OnNext call of the source sequence. In order to do a concurrent, non-blocking merge, change the selector to return an observable sequence obtained using the conversion. + + + + Projects each element of an observable sequence to an enumerable sequence by incorporating the element's index and concatenates the resulting enumerable sequences into one observable sequence. + + The type of the elements in the source sequence. + The type of the elements in the projected inner enumerable sequences and the elements in the merged result sequence. + An observable sequence of elements to project. + A transform function to apply to each element; the second parameter of the function represents the index of the source element. + An observable sequence whose elements are the result of invoking the one-to-many transform function on each element of the input sequence. + or is null. + The projected sequences are enumerated synchronously within the OnNext call of the source sequence. In order to do a concurrent, non-blocking merge, change the selector to return an observable sequence obtained using the conversion. + + + + Projects each element of an observable sequence to an enumerable sequence, invokes the result selector for the source element and each of the corresponding inner sequence's elements, and merges the results into one observable sequence. + + The type of the elements in the source sequence. + The type of the elements in the projected intermediate enumerable sequences. + The type of the elements in the result sequence, obtained by using the selector to combine source sequence elements with their corresponding intermediate sequence elements. + An observable sequence of elements to project. + A transform function to apply to each element. + A transform function to apply to each element of the intermediate sequence. + An observable sequence whose elements are the result of invoking the one-to-many transform function collectionSelector on each element of the input sequence and then mapping each of those sequence elements and their corresponding source element to a result element. + or or is null. + The projected sequences are enumerated synchronously within the OnNext call of the source sequence. In order to do a concurrent, non-blocking merge, change the selector to return an observable sequence obtained using the conversion. + + + + Projects each element of an observable sequence to an enumerable sequence by incorporating the element's index, invokes the result selector for the source element and each of the corresponding inner sequence's elements, and merges the results into one observable sequence. + + The type of the elements in the source sequence. + The type of the elements in the projected intermediate enumerable sequences. + The type of the elements in the result sequence, obtained by using the selector to combine source sequence elements with their corresponding intermediate sequence elements. + An observable sequence of elements to project. + A transform function to apply to each element; the second parameter of the function represents the index of the source element. + A transform function to apply to each element of the intermediate sequence; the second parameter of the function represents the index of the source element and the fourth parameter represents the index of the intermediate element. + An observable sequence whose elements are the result of invoking the one-to-many transform function collectionSelector on each element of the input sequence and then mapping each of those sequence elements and their corresponding source element to a result element. + or or is null. + The projected sequences are enumerated synchronously within the OnNext call of the source sequence. In order to do a concurrent, non-blocking merge, change the selector to return an observable sequence obtained using the conversion. + + + + Bypasses a specified number of elements in an observable sequence and then returns the remaining elements. + + The type of the elements in the source sequence. + The sequence to take elements from. + The number of elements to skip before returning the remaining elements. + An observable sequence that contains the elements that occur after the specified index in the input sequence. + is null. + is less than zero. + + + + Bypasses elements in an observable sequence as long as a specified condition is true and then returns the remaining elements. + + The type of the elements in the source sequence. + An observable sequence to return elements from. + A function to test each element for a condition. + An observable sequence that contains the elements from the input sequence starting at the first element in the linear series that does not pass the test specified by predicate. + or is null. + + + + Bypasses elements in an observable sequence as long as a specified condition is true and then returns the remaining elements. + The element's index is used in the logic of the predicate function. + + The type of the elements in the source sequence. + An observable sequence to return elements from. + A function to test each element for a condition; the second parameter of the function represents the index of the source element. + An observable sequence that contains the elements from the input sequence starting at the first element in the linear series that does not pass the test specified by predicate. + or is null. + + + + Returns a specified number of contiguous elements from the start of an observable sequence. + + The type of the elements in the source sequence. + The sequence to take elements from. + The number of elements to return. + An observable sequence that contains the specified number of elements from the start of the input sequence. + is null. + is less than zero. + + + + Returns a specified number of contiguous elements from the start of an observable sequence, using the specified scheduler for the edge case of Take(0). + + The type of the elements in the source sequence. + The sequence to take elements from. + The number of elements to return. + Scheduler used to produce an OnCompleted message in case count is set to 0. + An observable sequence that contains the specified number of elements from the start of the input sequence. + or is null. + is less than zero. + + + + Returns elements from an observable sequence as long as a specified condition is true. + + The type of the elements in the source sequence. + A sequence to return elements from. + A function to test each element for a condition. + An observable sequence that contains the elements from the input sequence that occur before the element at which the test no longer passes. + or is null. + + + + Returns elements from an observable sequence as long as a specified condition is true. + The element's index is used in the logic of the predicate function. + + The type of the elements in the source sequence. + A sequence to return elements from. + A function to test each element for a condition; the second parameter of the function represents the index of the source element. + An observable sequence that contains the elements from the input sequence that occur before the element at which the test no longer passes. + or is null. + + + + Filters the elements of an observable sequence based on a predicate. + + The type of the elements in the source sequence. + An observable sequence whose elements to filter. + A function to test each source element for a condition. + An observable sequence that contains elements from the input sequence that satisfy the condition. + or is null. + + + + Filters the elements of an observable sequence based on a predicate by incorporating the element's index. + + The type of the elements in the source sequence. + An observable sequence whose elements to filter. + A function to test each source element for a condition; the second parameter of the function represents the index of the source element. + An observable sequence that contains elements from the input sequence that satisfy the condition. + or is null. + + + + Projects each element of an observable sequence into consecutive non-overlapping buffers which are produced based on timing information. + + The type of the elements in the source sequence, and in the lists in the result sequence. + Source sequence to produce buffers over. + Length of each buffer. + An observable sequence of buffers. + is null. + is less than TimeSpan.Zero. + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create buffers as fast as it can. + Because all source sequence elements end up in one of the buffers, some buffers won't have a zero time span. This is a side-effect of the asynchrony introduced + by the scheduler, where the action to close the current buffer and to create a new buffer may not execute immediately, despite the TimeSpan.Zero due time. + + + + + Projects each element of an observable sequence into consecutive non-overlapping buffers which are produced based on timing information, using the specified scheduler to run timers. + + The type of the elements in the source sequence, and in the lists in the result sequence. + Source sequence to produce buffers over. + Length of each buffer. + Scheduler to run buffering timers on. + An observable sequence of buffers. + or is null. + is less than TimeSpan.Zero. + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create buffers as fast as it can. + Because all source sequence elements end up in one of the buffers, some buffers won't have a zero time span. This is a side-effect of the asynchrony introduced + by the scheduler, where the action to close the current buffer and to create a new buffer may not execute immediately, despite the TimeSpan.Zero due time. + + + + + Projects each element of an observable sequence into zero or more buffers which are produced based on timing information. + + The type of the elements in the source sequence, and in the lists in the result sequence. + Source sequence to produce buffers over. + Length of each buffer. + Interval between creation of consecutive buffers. + An observable sequence of buffers. + is null. + or is less than TimeSpan.Zero. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create buffers with minimum duration + length. However, some buffers won't have a zero time span. This is a side-effect of the asynchrony introduced by the scheduler, where the action to close the + current buffer may not execute immediately, despite the TimeSpan.Zero due time. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create buffers as fast as it can. + However, this doesn't mean all buffers will start at the beginning of the source sequence. This is a side-effect of the asynchrony introduced by the scheduler, + where the action to create a new buffer may not execute immediately, despite the TimeSpan.Zero due time. + + + + + + Projects each element of an observable sequence into zero or more buffers which are produced based on timing information, using the specified scheduler to run timers. + + The type of the elements in the source sequence, and in the lists in the result sequence. + Source sequence to produce buffers over. + Length of each buffer. + Interval between creation of consecutive buffers. + Scheduler to run buffering timers on. + An observable sequence of buffers. + or is null. + or is less than TimeSpan.Zero. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create buffers with minimum duration + length. However, some buffers won't have a zero time span. This is a side-effect of the asynchrony introduced by the scheduler, where the action to close the + current buffer may not execute immediately, despite the TimeSpan.Zero due time. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create buffers as fast as it can. + However, this doesn't mean all buffers will start at the beginning of the source sequence. This is a side-effect of the asynchrony introduced by the scheduler, + where the action to create a new buffer may not execute immediately, despite the TimeSpan.Zero due time. + + + + + + Projects each element of an observable sequence into a buffer that's sent out when either it's full or a given amount of time has elapsed. + A useful real-world analogy of this overload is the behavior of a ferry leaving the dock when all seats are taken, or at the scheduled time of departure, whichever event occurs first. + + The type of the elements in the source sequence, and in the lists in the result sequence. + Source sequence to produce buffers over. + Maximum time length of a window. + Maximum element count of a window. + An observable sequence of buffers. + is null. + is less than TimeSpan.Zero. -or- is less than or equal to zero. + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create buffers as fast as it can. + Because all source sequence elements end up in one of the buffers, some buffers won't have a zero time span. This is a side-effect of the asynchrony introduced + by the scheduler, where the action to close the current buffer and to create a new buffer may not execute immediately, despite the TimeSpan.Zero due time. + + + + + Projects each element of an observable sequence into a buffer that's sent out when either it's full or a given amount of time has elapsed, using the specified scheduler to run timers. + A useful real-world analogy of this overload is the behavior of a ferry leaving the dock when all seats are taken, or at the scheduled time of departure, whichever event occurs first. + + The type of the elements in the source sequence, and in the lists in the result sequence. + Source sequence to produce buffers over. + Maximum time length of a buffer. + Maximum element count of a buffer. + Scheduler to run buffering timers on. + An observable sequence of buffers. + or is null. + is less than TimeSpan.Zero. -or- is less than or equal to zero. + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create buffers as fast as it can. + Because all source sequence elements end up in one of the buffers, some buffers won't have a zero time span. This is a side-effect of the asynchrony introduced + by the scheduler, where the action to close the current buffer and to create a new buffer may not execute immediately, despite the TimeSpan.Zero due time. + + + + + Time shifts the observable sequence by the specified relative time duration. + The relative time intervals between the values are preserved. + + The type of the elements in the source sequence. + Source sequence to delay values for. + Relative time by which to shift the observable sequence. If this value is equal to TimeSpan.Zero, the scheduler will dispatch observer callbacks as soon as possible. + Time-shifted sequence. + is null. + is less than TimeSpan.Zero. + + + This operator is less efficient than DelaySubscription because it records all notifications and time-delays those. This allows for immediate propagation of errors. + + + Observer callbacks for the resulting sequence will be run on the default scheduler. This effect is similar to using ObserveOn. + + + Exceptions signaled by the source sequence through an OnError callback are forwarded immediately to the result sequence. Any OnNext notifications that were in the queue at the point of the OnError callback will be dropped. + In order to delay error propagation, consider using the Observable.Materialize and Observable.Dematerialize operators, or use DelaySubscription. + + + + + + Time shifts the observable sequence by the specified relative time duration, using the specified scheduler to run timers. + The relative time intervals between the values are preserved. + + The type of the elements in the source sequence. + Source sequence to delay values for. + Relative time by which to shift the observable sequence. If this value is equal to TimeSpan.Zero, the scheduler will dispatch observer callbacks as soon as possible. + Scheduler to run the delay timers on. + Time-shifted sequence. + or is null. + is less than TimeSpan.Zero. + + + This operator is less efficient than DelaySubscription because it records all notifications and time-delays those. This allows for immediate propagation of errors. + + + Observer callbacks for the resulting sequence will be run on the specified scheduler. This effect is similar to using ObserveOn. + + + Exceptions signaled by the source sequence through an OnError callback are forwarded immediately to the result sequence. Any OnNext notifications that were in the queue at the point of the OnError callback will be dropped. + + + Exceptions signaled by the source sequence through an OnError callback are forwarded immediately to the result sequence. Any OnNext notifications that were in the queue at the point of the OnError callback will be dropped. + In order to delay error propagation, consider using the Observable.Materialize and Observable.Dematerialize operators, or use DelaySubscription. + + + + + + Time shifts the observable sequence to start propagating notifications at the specified absolute time. + The relative time intervals between the values are preserved. + + The type of the elements in the source sequence. + Source sequence to delay values for. + Absolute time used to shift the observable sequence; the relative time shift gets computed upon subscription. If this value is less than or equal to DateTimeOffset.UtcNow, the scheduler will dispatch observer callbacks as soon as possible. + Time-shifted sequence. + is null. + + + This operator is less efficient than DelaySubscription because it records all notifications and time-delays those. This allows for immediate propagation of errors. + + + Observer callbacks for the resulting sequence will be run on the default scheduler. This effect is similar to using ObserveOn. + + + Exceptions signaled by the source sequence through an OnError callback are forwarded immediately to the result sequence. Any OnNext notifications that were in the queue at the point of the OnError callback will be dropped. + In order to delay error propagation, consider using the Observable.Materialize and Observable.Dematerialize operators, or use DelaySubscription. + + + + + + Time shifts the observable sequence to start propagating notifications at the specified absolute time, using the specified scheduler to run timers. + The relative time intervals between the values are preserved. + + The type of the elements in the source sequence. + Source sequence to delay values for. + Absolute time used to shift the observable sequence; the relative time shift gets computed upon subscription. If this value is less than or equal to DateTimeOffset.UtcNow, the scheduler will dispatch observer callbacks as soon as possible. + Scheduler to run the delay timers on. + Time-shifted sequence. + or is null. + + + This operator is less efficient than DelaySubscription because it records all notifications and time-delays those. This allows for immediate propagation of errors. + + + Observer callbacks for the resulting sequence will be run on the specified scheduler. This effect is similar to using ObserveOn. + + + Exceptions signaled by the source sequence through an OnError callback are forwarded immediately to the result sequence. Any OnNext notifications that were in the queue at the point of the OnError callback will be dropped. + In order to delay error propagation, consider using the Observable.Materialize and Observable.Dematerialize operators, or use DelaySubscription. + + + + + + Time shifts the observable sequence based on a delay selector function for each element. + + The type of the elements in the source sequence. + The type of the elements in the delay sequences used to denote the delay duration of each element in the source sequence. + Source sequence to delay values for. + Selector function to retrieve a sequence indicating the delay for each given element. + Time-shifted sequence. + or is null. + + + + Time shifts the observable sequence based on a subscription delay and a delay selector function for each element. + + The type of the elements in the source sequence. + The type of the elements in the delay sequences used to denote the delay duration of each element in the source sequence. + Source sequence to delay values for. + Sequence indicating the delay for the subscription to the source. + Selector function to retrieve a sequence indicating the delay for each given element. + Time-shifted sequence. + or or is null. + + + + Time shifts the observable sequence by delaying the subscription with the specified relative time duration. + + The type of the elements in the source sequence. + Source sequence to delay subscription for. + Relative time shift of the subscription. + Time-shifted sequence. + is null. + is less than TimeSpan.Zero. + + + This operator is more efficient than Delay but postpones all side-effects of subscription and affects error propagation timing. + + + The side-effects of subscribing to the source sequence will be run on the default scheduler. Observer callbacks will not be affected. + + + + + + Time shifts the observable sequence by delaying the subscription with the specified relative time duration, using the specified scheduler to run timers. + + The type of the elements in the source sequence. + Source sequence to delay subscription for. + Relative time shift of the subscription. + Scheduler to run the subscription delay timer on. + Time-shifted sequence. + or is null. + is less than TimeSpan.Zero. + + + This operator is more efficient than Delay but postpones all side-effects of subscription and affects error propagation timing. + + + The side-effects of subscribing to the source sequence will be run on the specified scheduler. Observer callbacks will not be affected. + + + + + + Time shifts the observable sequence by delaying the subscription to the specified absolute time. + + The type of the elements in the source sequence. + Source sequence to delay subscription for. + Absolute time to perform the subscription at. + Time-shifted sequence. + is null. + + + This operator is more efficient than Delay but postpones all side-effects of subscription and affects error propagation timing. + + + The side-effects of subscribing to the source sequence will be run on the default scheduler. Observer callbacks will not be affected. + + + + + + Time shifts the observable sequence by delaying the subscription to the specified absolute time, using the specified scheduler to run timers. + + The type of the elements in the source sequence. + Source sequence to delay subscription for. + Absolute time to perform the subscription at. + Scheduler to run the subscription delay timer on. + Time-shifted sequence. + or is null. + + + This operator is more efficient than Delay but postpones all side-effects of subscription and affects error propagation timing. + + + The side-effects of subscribing to the source sequence will be run on the specified scheduler. Observer callbacks will not be affected. + + + + + + Generates an observable sequence by running a state-driven and temporal loop producing the sequence's elements. + + The type of the state used in the generator loop. + The type of the elements in the produced sequence. + Initial state. + Condition to terminate generation (upon returning false). + Iteration step function. + Selector function for results produced in the sequence. + Time selector function to control the speed of values being produced each iteration. + The generated sequence. + or or or is null. + + + + Generates an observable sequence by running a state-driven and temporal loop producing the sequence's elements, using the specified scheduler to run timers and to send out observer messages. + + The type of the state used in the generator loop. + The type of the elements in the produced sequence. + Initial state. + Condition to terminate generation (upon returning false). + Iteration step function. + Selector function for results produced in the sequence. + Time selector function to control the speed of values being produced each iteration. + Scheduler on which to run the generator loop. + The generated sequence. + or or or or is null. + + + + Generates an observable sequence by running a state-driven and temporal loop producing the sequence's elements. + + The type of the state used in the generator loop. + The type of the elements in the produced sequence. + Initial state. + Condition to terminate generation (upon returning false). + Iteration step function. + Selector function for results produced in the sequence. + Time selector function to control the speed of values being produced each iteration. + The generated sequence. + or or or is null. + + + + Generates an observable sequence by running a state-driven and temporal loop producing the sequence's elements, using the specified scheduler to run timers and to send out observer messages. + + The type of the state used in the generator loop. + The type of the elements in the produced sequence. + Initial state. + Condition to terminate generation (upon returning false). + Iteration step function. + Selector function for results produced in the sequence. + Time selector function to control the speed of values being produced each iteration. + Scheduler on which to run the generator loop. + The generated sequence. + or or or or is null. + + + + Returns an observable sequence that produces a value after each period. + + Period for producing the values in the resulting sequence. If this value is equal to TimeSpan.Zero, the timer will recur as fast as possible. + An observable sequence that produces a value after each period. + is less than TimeSpan.Zero. + + Intervals are measured between the start of subsequent notifications, not between the end of the previous and the start of the next notification. + If the observer takes longer than the interval period to handle the message, the subsequent notification will be delivered immediately after the + current one has been handled. In case you need to control the time between the end and the start of consecutive notifications, consider using the + + operator instead. + + + + + Returns an observable sequence that produces a value after each period, using the specified scheduler to run timers and to send out observer messages. + + Period for producing the values in the resulting sequence. If this value is equal to TimeSpan.Zero, the timer will recur as fast as possible. + Scheduler to run the timer on. + An observable sequence that produces a value after each period. + is less than TimeSpan.Zero. + is null. + + Intervals are measured between the start of subsequent notifications, not between the end of the previous and the start of the next notification. + If the observer takes longer than the interval period to handle the message, the subsequent notification will be delivered immediately after the + current one has been handled. In case you need to control the time between the end and the start of consecutive notifications, consider using the + + operator instead. + + + + + Samples the observable sequence at each interval. + Upon each sampling tick, the latest element (if any) in the source sequence during the last sampling interval is sent to the resulting sequence. + + The type of the elements in the source sequence. + Source sequence to sample. + Interval at which to sample. If this value is equal to TimeSpan.Zero, the scheduler will continuously sample the stream. + Sampled observable sequence. + is null. + is less than TimeSpan.Zero. + + Specifying a TimeSpan.Zero value for doesn't guarantee all source sequence elements will be preserved. This is a side-effect + of the asynchrony introduced by the scheduler, where the sampling action may not execute immediately, despite the TimeSpan.Zero due time. + + + + + Samples the observable sequence at each interval, using the specified scheduler to run sampling timers. + Upon each sampling tick, the latest element (if any) in the source sequence during the last sampling interval is sent to the resulting sequence. + + The type of the elements in the source sequence. + Source sequence to sample. + Interval at which to sample. If this value is equal to TimeSpan.Zero, the scheduler will continuously sample the stream. + Scheduler to run the sampling timer on. + Sampled observable sequence. + or is null. + is less than TimeSpan.Zero. + + Specifying a TimeSpan.Zero value for doesn't guarantee all source sequence elements will be preserved. This is a side-effect + of the asynchrony introduced by the scheduler, where the sampling action may not execute immediately, despite the TimeSpan.Zero due time. + + + + + Samples the source observable sequence using a sampler observable sequence producing sampling ticks. + Upon each sampling tick, the latest element (if any) in the source sequence during the last sampling interval is sent to the resulting sequence. + + The type of the elements in the source sequence. + The type of the elements in the sampling sequence. + Source sequence to sample. + Sampling tick sequence. + Sampled observable sequence. + or is null. + + + + Skips elements for the specified duration from the start of the observable source sequence. + + The type of the elements in the source sequence. + Source sequence to skip elements for. + Duration for skipping elements from the start of the sequence. + An observable sequence with the elements skipped during the specified duration from the start of the source sequence. + is null. + is less than TimeSpan.Zero. + + + Specifying a TimeSpan.Zero value for doesn't guarantee no elements will be dropped from the start of the source sequence. + This is a side-effect of the asynchrony introduced by the scheduler, where the action that causes callbacks from the source sequence to be forwarded + may not execute immediately, despite the TimeSpan.Zero due time. + + + Errors produced by the source sequence are always forwarded to the result sequence, even if the error occurs before the . + + + + + + Skips elements for the specified duration from the start of the observable source sequence, using the specified scheduler to run timers. + + The type of the elements in the source sequence. + Source sequence to skip elements for. + Duration for skipping elements from the start of the sequence. + Scheduler to run the timer on. + An observable sequence with the elements skipped during the specified duration from the start of the source sequence. + or is null. + is less than TimeSpan.Zero. + + + Specifying a TimeSpan.Zero value for doesn't guarantee no elements will be dropped from the start of the source sequence. + This is a side-effect of the asynchrony introduced by the scheduler, where the action that causes callbacks from the source sequence to be forwarded + may not execute immediately, despite the TimeSpan.Zero due time. + + + Errors produced by the source sequence are always forwarded to the result sequence, even if the error occurs before the . + + + + + + Skips elements for the specified duration from the end of the observable source sequence. + + The type of the elements in the source sequence. + Source sequence to skip elements for. + Duration for skipping elements from the end of the sequence. + An observable sequence with the elements skipped during the specified duration from the end of the source sequence. + is null. + is less than TimeSpan.Zero. + + This operator accumulates a queue with a length enough to store elements received during the initial window. + As more elements are received, elements older than the specified are taken from the queue and produced on the + result sequence. This causes elements to be delayed with . + + + + + Skips elements for the specified duration from the end of the observable source sequence, using the specified scheduler to run timers. + + The type of the elements in the source sequence. + Source sequence to skip elements for. + Duration for skipping elements from the end of the sequence. + Scheduler to run the timer on. + An observable sequence with the elements skipped during the specified duration from the end of the source sequence. + or is null. + is less than TimeSpan.Zero. + + This operator accumulates a queue with a length enough to store elements received during the initial window. + As more elements are received, elements older than the specified are taken from the queue and produced on the + result sequence. This causes elements to be delayed with . + + + + + Skips elements from the observable source sequence until the specified start time. + + The type of the elements in the source sequence. + Source sequence to skip elements for. + Time to start taking elements from the source sequence. If this value is less than or equal to DateTimeOffset.UtcNow, no elements will be skipped. + An observable sequence with the elements skipped until the specified start time. + is null. + + Errors produced by the source sequence are always forwarded to the result sequence, even if the error occurs before the . + + + + + Skips elements from the observable source sequence until the specified start time, using the specified scheduler to run timers. + + The type of the elements in the source sequence. + Source sequence to skip elements for. + Time to start taking elements from the source sequence. If this value is less than or equal to DateTimeOffset.UtcNow, no elements will be skipped. + Scheduler to run the timer on. + An observable sequence with the elements skipped until the specified start time. + or is null. + + Errors produced by the source sequence are always forwarded to the result sequence, even if the error occurs before the . + + + + + Takes elements for the specified duration from the start of the observable source sequence. + + The type of the elements in the source sequence. + Source sequence to take elements from. + Duration for taking elements from the start of the sequence. + An observable sequence with the elements taken during the specified duration from the start of the source sequence. + is null. + is less than TimeSpan.Zero. + + Specifying a TimeSpan.Zero value for doesn't guarantee an empty sequence will be returned. This is a side-effect + of the asynchrony introduced by the scheduler, where the action that stops forwarding callbacks from the source sequence may not execute + immediately, despite the TimeSpan.Zero due time. + + + + + Takes elements for the specified duration from the start of the observable source sequence, using the specified scheduler to run timers. + + The type of the elements in the source sequence. + Source sequence to take elements from. + Duration for taking elements from the start of the sequence. + Scheduler to run the timer on. + An observable sequence with the elements taken during the specified duration from the start of the source sequence. + or is null. + is less than TimeSpan.Zero. + + Specifying a TimeSpan.Zero value for doesn't guarantee an empty sequence will be returned. This is a side-effect + of the asynchrony introduced by the scheduler, where the action that stops forwarding callbacks from the source sequence may not execute + immediately, despite the TimeSpan.Zero due time. + + + + + Returns elements within the specified duration from the end of the observable source sequence. + + The type of the elements in the source sequence. + Source sequence to take elements from. + Duration for taking elements from the end of the sequence. + An observable sequence with the elements taken during the specified duration from the end of the source sequence. + is null. + is less than TimeSpan.Zero. + + This operator accumulates a buffer with a length enough to store elements for any window during the lifetime of + the source sequence. Upon completion of the source sequence, this buffer is drained on the result sequence. This causes the result elements + to be delayed with . + + + + + Returns elements within the specified duration from the end of the observable source sequence, using the specified scheduler to run timers. + + The type of the elements in the source sequence. + Source sequence to take elements from. + Duration for taking elements from the end of the sequence. + Scheduler to run the timer on. + An observable sequence with the elements taken during the specified duration from the end of the source sequence. + or is null. + is less than TimeSpan.Zero. + + This operator accumulates a buffer with a length enough to store elements for any window during the lifetime of + the source sequence. Upon completion of the source sequence, this buffer is drained on the result sequence. This causes the result elements + to be delayed with . + + + + + Returns elements within the specified duration from the end of the observable source sequence, using the specified schedulers to run timers and to drain the collected elements. + + The type of the elements in the source sequence. + Source sequence to take elements from. + Duration for taking elements from the end of the sequence. + Scheduler to run the timer on. + Scheduler to drain the collected elements. + An observable sequence with the elements taken during the specified duration from the end of the source sequence. + or or is null. + is less than TimeSpan.Zero. + + This operator accumulates a buffer with a length enough to store elements for any window during the lifetime of + the source sequence. Upon completion of the source sequence, this buffer is drained on the result sequence. This causes the result elements + to be delayed with . + + + + + Returns a list with the elements within the specified duration from the end of the observable source sequence. + + The type of the elements in the source sequence. + Source sequence to take elements from. + Duration for taking elements from the end of the sequence. + An observable sequence containing a single list with the elements taken during the specified duration from the end of the source sequence. + is null. + is less than TimeSpan.Zero. + + This operator accumulates a buffer with a length enough to store elements for any window during the lifetime of + the source sequence. Upon completion of the source sequence, this buffer is produced on the result sequence. + + + + + Returns a list with the elements within the specified duration from the end of the observable source sequence, using the specified scheduler to run timers. + + The type of the elements in the source sequence. + Source sequence to take elements from. + Duration for taking elements from the end of the sequence. + Scheduler to run the timer on. + An observable sequence containing a single list with the elements taken during the specified duration from the end of the source sequence. + or is null. + is less than TimeSpan.Zero. + + This operator accumulates a buffer with a length enough to store elements for any window during the lifetime of + the source sequence. Upon completion of the source sequence, this buffer is produced on the result sequence. + + + + + Takes elements for the specified duration until the specified end time. + + The type of the elements in the source sequence. + Source sequence to take elements from. + Time to stop taking elements from the source sequence. If this value is less than or equal to DateTimeOffset.UtcNow, the result stream will complete immediately. + An observable sequence with the elements taken until the specified end time. + is null. + + + + Takes elements for the specified duration until the specified end time, using the specified scheduler to run timers. + + The type of the elements in the source sequence. + Source sequence to take elements from. + Time to stop taking elements from the source sequence. If this value is less than or equal to DateTimeOffset.UtcNow, the result stream will complete immediately. + Scheduler to run the timer on. + An observable sequence with the elements taken until the specified end time. + or is null. + + + + Ignores elements from an observable sequence which are followed by another element within a specified relative time duration. + + The type of the elements in the source sequence. + Source sequence to throttle. + Throttling duration for each element. + The throttled sequence. + is null. + is less than TimeSpan.Zero. + + + This operator throttles the source sequence by holding on to each element for the duration specified in . If another + element is produced within this time window, the element is dropped and a new timer is started for the current element, repeating this whole + process. For streams that never have gaps larger than or equal to between elements, the resulting stream won't + produce any elements. In order to reduce the volume of a stream whilst guaranteeing the periodic production of elements, consider using the + Observable.Sample set of operators. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing throttling timers to be scheduled + that are due immediately. However, this doesn't guarantee all elements will be retained in the result sequence. This is a side-effect of the + asynchrony introduced by the scheduler, where the action to forward the current element may not execute immediately, despite the TimeSpan.Zero + due time. In such cases, the next element may arrive before the scheduler gets a chance to run the throttling action. + + + + + + Ignores elements from an observable sequence which are followed by another element within a specified relative time duration, using the specified scheduler to run throttling timers. + + The type of the elements in the source sequence. + Source sequence to throttle. + Throttling duration for each element. + Scheduler to run the throttle timers on. + The throttled sequence. + or is null. + is less than TimeSpan.Zero. + + + This operator throttles the source sequence by holding on to each element for the duration specified in . If another + element is produced within this time window, the element is dropped and a new timer is started for the current element, repeating this whole + process. For streams that never have gaps larger than or equal to between elements, the resulting stream won't + produce any elements. In order to reduce the volume of a stream whilst guaranteeing the periodic production of elements, consider using the + Observable.Sample set of operators. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing throttling timers to be scheduled + that are due immediately. However, this doesn't guarantee all elements will be retained in the result sequence. This is a side-effect of the + asynchrony introduced by the scheduler, where the action to forward the current element may not execute immediately, despite the TimeSpan.Zero + due time. In such cases, the next element may arrive before the scheduler gets a chance to run the throttling action. + + + + + + Ignores elements from an observable sequence which are followed by another value within a computed throttle duration. + + The type of the elements in the source sequence. + The type of the elements in the throttle sequences selected for each element in the source sequence. + Source sequence to throttle. + Selector function to retrieve a sequence indicating the throttle duration for each given element. + The throttled sequence. + or is null. + + This operator throttles the source sequence by holding on to each element for the duration denoted by . + If another element is produced within this time window, the element is dropped and a new timer is started for the current element, repeating this + whole process. For streams where the duration computed by applying the to each element overlaps with + the occurrence of the successor element, the resulting stream won't produce any elements. In order to reduce the volume of a stream whilst + guaranteeing the periodic production of elements, consider using the Observable.Sample set of operators. + + + + + Records the time interval between consecutive elements in an observable sequence. + + The type of the elements in the source sequence. + Source sequence to record time intervals for. + An observable sequence with time interval information on elements. + is null. + + + + Records the time interval between consecutive elements in an observable sequence, using the specified scheduler to compute time intervals. + + The type of the elements in the source sequence. + Source sequence to record time intervals for. + Scheduler used to compute time intervals. + An observable sequence with time interval information on elements. + or is null. + + + + Applies a timeout policy for each element in the observable sequence. + If the next element isn't received within the specified timeout duration starting from its predecessor, a TimeoutException is propagated to the observer. + + The type of the elements in the source sequence. + Source sequence to perform a timeout for. + Maximum duration between values before a timeout occurs. + The source sequence with a TimeoutException in case of a timeout. + is null. + is less than TimeSpan.Zero. + (Asynchronous) If no element is produced within from the previous element. + + + In case you only want to timeout on the first element, consider using the + operator applied to the source sequence and a delayed sequence. Alternatively, the general-purpose overload + of Timeout, can be used. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing timeout timers to be scheduled that are due + immediately. However, this doesn't guarantee a timeout will occur, even for the first element. This is a side-effect of the asynchrony introduced by the + scheduler, where the action to propagate a timeout may not execute immediately, despite the TimeSpan.Zero due time. In such cases, the next element may + arrive before the scheduler gets a chance to run the timeout action. + + + + + + Applies a timeout policy for each element in the observable sequence, using the specified scheduler to run timeout timers. + If the next element isn't received within the specified timeout duration starting from its predecessor, a TimeoutException is propagated to the observer. + + The type of the elements in the source sequence. + Source sequence to perform a timeout for. + Maximum duration between values before a timeout occurs. + Scheduler to run the timeout timers on. + The source sequence with a TimeoutException in case of a timeout. + or is null. + is less than TimeSpan.Zero. + (Asynchronous) If no element is produced within from the previous element. + + + In case you only want to timeout on the first element, consider using the + operator applied to the source sequence and a delayed sequence. Alternatively, the general-purpose overload + of Timeout, can be used. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing timeout timers to be scheduled that are due + immediately. However, this doesn't guarantee a timeout will occur, even for the first element. This is a side-effect of the asynchrony introduced by the + scheduler, where the action to propagate a timeout may not execute immediately, despite the TimeSpan.Zero due time. In such cases, the next element may + arrive before the scheduler gets a chance to run the timeout action. + + + + + + Applies a timeout policy for each element in the observable sequence. + If the next element isn't received within the specified timeout duration starting from its predecessor, the other observable sequence is used to produce future messages from that point on. + + The type of the elements in the source sequence and the other sequence used upon a timeout. + Source sequence to perform a timeout for. + Maximum duration between values before a timeout occurs. + Sequence to return in case of a timeout. + The source sequence switching to the other sequence in case of a timeout. + or is null. + is less than TimeSpan.Zero. + + + In case you only want to timeout on the first element, consider using the + operator applied to the source sequence and a delayed sequence. Alternatively, the general-purpose overload + of Timeout, can be used. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing timeout timers to be scheduled that are due + immediately. However, this doesn't guarantee a timeout will occur, even for the first element. This is a side-effect of the asynchrony introduced by the + scheduler, where the action to propagate a timeout may not execute immediately, despite the TimeSpan.Zero due time. In such cases, the next element may + arrive before the scheduler gets a chance to run the timeout action. + + + + + + Applies a timeout policy for each element in the observable sequence, using the specified scheduler to run timeout timers. + If the next element isn't received within the specified timeout duration starting from its predecessor, the other observable sequence is used to produce future messages from that point on. + + The type of the elements in the source sequence and the other sequence used upon a timeout. + Source sequence to perform a timeout for. + Maximum duration between values before a timeout occurs. + Sequence to return in case of a timeout. + Scheduler to run the timeout timers on. + The source sequence switching to the other sequence in case of a timeout. + or or is null. + is less than TimeSpan.Zero. + + + In case you only want to timeout on the first element, consider using the + operator applied to the source sequence and a delayed sequence. Alternatively, the general-purpose overload + of Timeout, can be used. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing timeout timers to be scheduled that are due + immediately. However, this doesn't guarantee a timeout will occur, even for the first element. This is a side-effect of the asynchrony introduced by the + scheduler, where the action to propagate a timeout may not execute immediately, despite the TimeSpan.Zero due time. In such cases, the next element may + arrive before the scheduler gets a chance to run the timeout action. + + + + + + Applies a timeout policy to the observable sequence based on an absolute time. + If the sequence doesn't terminate before the specified absolute due time, a TimeoutException is propagated to the observer. + + The type of the elements in the source sequence. + Source sequence to perform a timeout for. + Time when a timeout occurs. If this value is less than or equal to DateTimeOffset.UtcNow, the timeout occurs immediately. + The source sequence with a TimeoutException in case of a timeout. + is null. + (Asynchronous) If the sequence hasn't terminated before . + + In case you only want to timeout on the first element, consider using the + operator applied to the source sequence and a delayed sequence. Alternatively, the general-purpose overload + of Timeout, can be used. + + + + + Applies a timeout policy to the observable sequence based on an absolute time, using the specified scheduler to run timeout timers. + If the sequence doesn't terminate before the specified absolute due time, a TimeoutException is propagated to the observer. + + The type of the elements in the source sequence. + Source sequence to perform a timeout for. + Time when a timeout occurs. If this value is less than or equal to DateTimeOffset.UtcNow, the timeout occurs immediately. + Scheduler to run the timeout timers on. + The source sequence with a TimeoutException in case of a timeout. + or is null. + (Asynchronous) If the sequence hasn't terminated before . + + In case you only want to timeout on the first element, consider using the + operator applied to the source sequence and a delayed sequence. Alternatively, the general-purpose overload + of Timeout, can be used. + + + + + Applies a timeout policy to the observable sequence based on an absolute time. + If the sequence doesn't terminate before the specified absolute due time, the other observable sequence is used to produce future messages from that point on. + + The type of the elements in the source sequence and the other sequence used upon a timeout. + Source sequence to perform a timeout for. + Time when a timeout occurs. If this value is less than or equal to DateTimeOffset.UtcNow, the timeout occurs immediately. + Sequence to return in case of a timeout. + The source sequence switching to the other sequence in case of a timeout. + or is null. + + In case you only want to timeout on the first element, consider using the + operator applied to the source sequence and a delayed sequence. Alternatively, the general-purpose overload + of Timeout, can be used. + + + + + Applies a timeout policy to the observable sequence based on an absolute time, using the specified scheduler to run timeout timers. + If the sequence doesn't terminate before the specified absolute due time, the other observable sequence is used to produce future messages from that point on. + + The type of the elements in the source sequence and the other sequence used upon a timeout. + Source sequence to perform a timeout for. + Time when a timeout occurs. If this value is less than or equal to DateTimeOffset.UtcNow, the timeout occurs immediately. + Sequence to return in case of a timeout. + Scheduler to run the timeout timers on. + The source sequence switching to the other sequence in case of a timeout. + or or is null. + + In case you only want to timeout on the first element, consider using the + operator applied to the source sequence and a delayed sequence. Alternatively, the general-purpose overload + of Timeout, can be used. + + + + + Applies a timeout policy to the observable sequence based on a timeout duration computed for each element. + If the next element isn't received within the computed duration starting from its predecessor, a TimeoutException is propagated to the observer. + + The type of the elements in the source sequence. + The type of the elements in the timeout sequences used to indicate the timeout duration for each element in the source sequence. + Source sequence to perform a timeout for. + Selector to retrieve an observable sequence that represents the timeout between the current element and the next element. + The source sequence with a TimeoutException in case of a timeout. + or is null. + + + + Applies a timeout policy to the observable sequence based on a timeout duration computed for each element. + If the next element isn't received within the computed duration starting from its predecessor, the other observable sequence is used to produce future messages from that point on. + + The type of the elements in the source sequence and the other sequence used upon a timeout. + The type of the elements in the timeout sequences used to indicate the timeout duration for each element in the source sequence. + Source sequence to perform a timeout for. + Selector to retrieve an observable sequence that represents the timeout between the current element and the next element. + Sequence to return in case of a timeout. + The source sequence switching to the other sequence in case of a timeout. + or or is null. + + + + Applies a timeout policy to the observable sequence based on an initial timeout duration for the first element, and a timeout duration computed for each subsequent element. + If the next element isn't received within the computed duration starting from its predecessor, a TimeoutException is propagated to the observer. + + The type of the elements in the source sequence. + The type of the elements in the timeout sequences used to indicate the timeout duration for each element in the source sequence. + Source sequence to perform a timeout for. + Observable sequence that represents the timeout for the first element. + Selector to retrieve an observable sequence that represents the timeout between the current element and the next element. + The source sequence with a TimeoutException in case of a timeout. + or or is null. + + + + Applies a timeout policy to the observable sequence based on an initial timeout duration for the first element, and a timeout duration computed for each subsequent element. + If the next element isn't received within the computed duration starting from its predecessor, the other observable sequence is used to produce future messages from that point on. + + The type of the elements in the source sequence and the other sequence used upon a timeout. + The type of the elements in the timeout sequences used to indicate the timeout duration for each element in the source sequence. + Source sequence to perform a timeout for. + Observable sequence that represents the timeout for the first element. + Selector to retrieve an observable sequence that represents the timeout between the current element and the next element. + Sequence to return in case of a timeout. + The source sequence switching to the other sequence in case of a timeout. + or or or is null. + + + + Returns an observable sequence that produces a single value after the specified relative due time has elapsed. + + Relative time at which to produce the value. If this value is less than or equal to TimeSpan.Zero, the timer will fire as soon as possible. + An observable sequence that produces a value after the due time has elapsed. + + + + Returns an observable sequence that produces a single value at the specified absolute due time. + + Absolute time at which to produce the value. If this value is less than or equal to DateTimeOffset.UtcNow, the timer will fire as soon as possible. + An observable sequence that produces a value at due time. + + + + Returns an observable sequence that periodically produces a value after the specified initial relative due time has elapsed. + + Relative time at which to produce the first value. If this value is less than or equal to TimeSpan.Zero, the timer will fire as soon as possible. + Period to produce subsequent values. If this value is equal to TimeSpan.Zero, the timer will recur as fast as possible. + An observable sequence that produces a value after due time has elapsed and then after each period. + is less than TimeSpan.Zero. + + + + Returns an observable sequence that periodically produces a value starting at the specified initial absolute due time. + + Absolute time at which to produce the first value. If this value is less than or equal to DateTimeOffset.UtcNow, the timer will fire as soon as possible. + Period to produce subsequent values. If this value is equal to TimeSpan.Zero, the timer will recur as fast as possible. + An observable sequence that produces a value at due time and then after each period. + is less than TimeSpan.Zero. + + + + Returns an observable sequence that produces a single value after the specified relative due time has elapsed, using the specified scheduler to run the timer. + + Relative time at which to produce the value. If this value is less than or equal to TimeSpan.Zero, the timer will fire as soon as possible. + Scheduler to run the timer on. + An observable sequence that produces a value after the due time has elapsed. + is null. + + + + Returns an observable sequence that produces a single value at the specified absolute due time, using the specified scheduler to run the timer. + + Absolute time at which to produce the value. If this value is less than or equal to DateTimeOffset.UtcNow, the timer will fire as soon as possible. + Scheduler to run the timer on. + An observable sequence that produces a value at due time. + is null. + + + + Returns an observable sequence that periodically produces a value after the specified initial relative due time has elapsed, using the specified scheduler to run timers. + + Relative time at which to produce the first value. If this value is less than or equal to TimeSpan.Zero, the timer will fire as soon as possible. + Period to produce subsequent values. If this value is equal to TimeSpan.Zero, the timer will recur as fast as possible. + Scheduler to run timers on. + An observable sequence that produces a value after due time has elapsed and then each period. + is less than TimeSpan.Zero. + is null. + + + + Returns an observable sequence that periodically produces a value starting at the specified initial absolute due time, using the specified scheduler to run timers. + + Absolute time at which to produce the first value. If this value is less than or equal to DateTimeOffset.UtcNow, the timer will fire as soon as possible. + Period to produce subsequent values. If this value is equal to TimeSpan.Zero, the timer will recur as fast as possible. + Scheduler to run timers on. + An observable sequence that produces a value at due time and then after each period. + is less than TimeSpan.Zero. + is null. + + + + Timestamps each element in an observable sequence using the local system clock. + + The type of the elements in the source sequence. + Source sequence to timestamp elements for. + An observable sequence with timestamp information on elements. + is null. + + + + Timestamp each element in an observable sequence using the clock of the specified scheduler. + + The type of the elements in the source sequence. + Source sequence to timestamp elements for. + Scheduler used to compute timestamps. + An observable sequence with timestamp information on elements. + or is null. + + + + Projects each element of an observable sequence into consecutive non-overlapping windows which are produced based on timing information. + + The type of the elements in the source sequence, and in the windows in the result sequence. + Source sequence to produce windows over. + Length of each window. + The sequence of windows. + is null. + is less than TimeSpan.Zero. + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create windows as fast as it can. + Because all source sequence elements end up in one of the windows, some windows won't have a zero time span. This is a side-effect of the asynchrony introduced + by the scheduler, where the action to close the current window and to create a new window may not execute immediately, despite the TimeSpan.Zero due time. + + + + + Projects each element of an observable sequence into consecutive non-overlapping windows which are produced based on timing information, using the specified scheduler to run timers. + + The type of the elements in the source sequence, and in the windows in the result sequence. + Source sequence to produce windows over. + Length of each window. + Scheduler to run windowing timers on. + An observable sequence of windows. + or is null. + is less than TimeSpan.Zero. + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create windows as fast as it can. + Because all source sequence elements end up in one of the windows, some windows won't have a zero time span. This is a side-effect of the asynchrony introduced + by the scheduler, where the action to close the current window and to create a new window may not execute immediately, despite the TimeSpan.Zero due time. + + + + + Projects each element of an observable sequence into zero or more windows which are produced based on timing information. + + The type of the elements in the source sequence, and in the windows in the result sequence. + Source sequence to produce windows over. + Length of each window. + Interval between creation of consecutive windows. + An observable sequence of windows. + is null. + or is less than TimeSpan.Zero. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create windows with minimum duration + length. However, some windows won't have a zero time span. This is a side-effect of the asynchrony introduced by the scheduler, where the action to close the + current window may not execute immediately, despite the TimeSpan.Zero due time. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create windows as fast as it can. + However, this doesn't mean all windows will start at the beginning of the source sequence. This is a side-effect of the asynchrony introduced by the scheduler, + where the action to create a new window may not execute immediately, despite the TimeSpan.Zero due time. + + + + + + Projects each element of an observable sequence into zero or more windows which are produced based on timing information, using the specified scheduler to run timers. + + The type of the elements in the source sequence, and in the windows in the result sequence. + Source sequence to produce windows over. + Length of each window. + Interval between creation of consecutive windows. + Scheduler to run windowing timers on. + An observable sequence of windows. + or is null. + or is less than TimeSpan.Zero. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create windows with minimum duration + length. However, some windows won't have a zero time span. This is a side-effect of the asynchrony introduced by the scheduler, where the action to close the + current window may not execute immediately, despite the TimeSpan.Zero due time. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create windows as fast as it can. + However, this doesn't mean all windows will start at the beginning of the source sequence. This is a side-effect of the asynchrony introduced by the scheduler, + where the action to create a new window may not execute immediately, despite the TimeSpan.Zero due time. + + + + + + Projects each element of an observable sequence into a window that is completed when either it's full or a given amount of time has elapsed. + A useful real-world analogy of this overload is the behavior of a ferry leaving the dock when all seats are taken, or at the scheduled time of departure, whichever event occurs first. + + The type of the elements in the source sequence, and in the windows in the result sequence. + Source sequence to produce windows over. + Maximum time length of a window. + Maximum element count of a window. + An observable sequence of windows. + is null. + is less than TimeSpan.Zero. -or- is less than or equal to zero. + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create windows as fast as it can. + Because all source sequence elements end up in one of the windows, some windows won't have a zero time span. This is a side-effect of the asynchrony introduced + by the scheduler, where the action to close the current window and to create a new window may not execute immediately, despite the TimeSpan.Zero due time. + + + + + Projects each element of an observable sequence into a window that is completed when either it's full or a given amount of time has elapsed, using the specified scheduler to run timers. + A useful real-world analogy of this overload is the behavior of a ferry leaving the dock when all seats are taken, or at the scheduled time of departure, whichever event occurs first. + + The type of the elements in the source sequence, and in the windows in the result sequence. + Source sequence to produce windows over. + Maximum time length of a window. + Maximum element count of a window. + Scheduler to run windowing timers on. + An observable sequence of windows. + or is null. + is less than TimeSpan.Zero. -or- is less than or equal to zero. + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create windows as fast as it can. + Because all source sequence elements end up in one of the windows, some windows won't have a zero time span. This is a side-effect of the asynchrony introduced + by the scheduler, where the action to close the current window and to create a new window may not execute immediately, despite the TimeSpan.Zero due time. + + + + + Provides a set of static methods for writing queries over observable sequences, allowing translation to a target query language. + + + + + Gets the local query provider which will retarget Qbservable-based queries to the corresponding Observable-based query for in-memory execution upon subscription. + + + + + Converts an in-memory observable sequence into an sequence with an expression tree representing the source sequence. + + The type of the elements in the source sequence. + Source sequence. + sequence representing the given observable source sequence. + is null. + + + + Returns the input typed as an . + This operator is used to separate the part of the query that's captured as an expression tree from the part that's executed locally. + + The type of the elements in the source sequence. + An sequence to convert to an sequence. + The original source object, but typed as an . + is null. + + + + Converts an enumerable sequence to an observable sequence. + + The type of the elements in the source sequence. + Enumerable sequence to convert to an observable sequence. + The observable sequence whose elements are pulled from the given enumerable sequence. + is null. + This operator requires the source's object (see ) to implement . + + + + Converts an enumerable sequence to an observable sequence, using the specified scheduler to run the enumeration loop. + + The type of the elements in the source sequence. + Enumerable sequence to convert to an observable sequence. + Scheduler to run the enumeration of the input sequence on. + The observable sequence whose elements are pulled from the given enumerable sequence. + or is null. + This operator requires the source's object (see ) to implement . + + + + Applies an accumulator function over an observable sequence, returning the result of the aggregation as a single element in the result sequence. + For aggregation behavior with incremental intermediate results, see . + + The type of the elements in the source sequence and the result of the aggregation. + An observable sequence to aggregate over. + An accumulator function to be invoked on each element. + An observable sequence containing a single element with the final accumulator value. + + or is null. + (Asynchronous) The source sequence is empty. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Applies an accumulator function over an observable sequence, returning the result of the aggregation as a single element in the result sequence. The specified seed value is used as the initial accumulator value. + For aggregation behavior with incremental intermediate results, see . + + The type of the elements in the source sequence. + The type of the result of the aggregation. + An observable sequence to aggregate over. + The initial accumulator value. + An accumulator function to be invoked on each element. + An observable sequence containing a single element with the final accumulator value. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Applies an accumulator function over an observable sequence, returning the result of the aggregation as a single element in the result sequence. The specified seed value is used as the initial accumulator value, + and the specified result selector function is used to select the result value. + + The type of the elements in the source sequence. + The type of the accumulator value. + The type of the resulting value. + An observable sequence to aggregate over. + The initial accumulator value. + An accumulator function to be invoked on each element. + A function to transform the final accumulator value into the result value. + An observable sequence containing a single element with the final accumulator value. + + or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Determines whether all elements of an observable sequence satisfy a condition. + + The type of the elements in the source sequence. + An observable sequence whose elements to apply the predicate to. + A function to test each element for a condition. + An observable sequence containing a single element determining whether all elements in the source sequence pass the test in the specified predicate. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Propagates the observable sequence that reacts first. + + The type of the elements in the source sequences. + First observable sequence. + Second observable sequence. + An observable sequence that surfaces either of the given sequences, whichever reacted first. + + or is null. + + + + Propagates the observable sequence that reacts first. + + Query provider used to construct the data source. + The type of the elements in the source sequences. + Observable sources competing to react first. + An observable sequence that surfaces any of the given sequences, whichever reacted first. + + is null. + + + + Propagates the observable sequence that reacts first. + + Query provider used to construct the data source. + The type of the elements in the source sequences. + Observable sources competing to react first. + An observable sequence that surfaces any of the given sequences, whichever reacted first. + + is null. + + + + Determines whether an observable sequence contains any elements. + + The type of the elements in the source sequence. + An observable sequence to check for non-emptiness. + An observable sequence containing a single element determining whether the source sequence contains any elements. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Determines whether any element of an observable sequence satisfies a condition. + + The type of the elements in the source sequence. + An observable sequence whose elements to apply the predicate to. + A function to test each element for a condition. + An observable sequence containing a single element determining whether any elements in the source sequence pass the test in the specified predicate. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Append a value to an observable sequence. + + The type of the elements in the source sequence. + Source sequence to append the value to. + Value to append to the specified sequence. + The source sequence appended with the specified value. + + is null. + + + + Append a value to an observable sequence. + + The type of the elements in the source sequence. + Source sequence to append the value to. + Value to append to the specified sequence. + Scheduler to emit the append values on. + The source sequence appended with the specified value. + + is null. + + + + Automatically connect the upstream IConnectableObservable at most once when the + specified number of IObservers have subscribed to this IObservable. + + Query provider used to construct the data source. + The type of the elements in the source sequence. + Connectable observable sequence. + The number of observers required to subscribe before the connection to source happens, non-positive value will trigger an immediate subscription. + If not null, the connection's IDisposable is provided to it. + An observable sequence that connects to the source at most once when the given number of observers have subscribed to it. + + is null. + + + + Computes the average of an observable sequence of values. + + A sequence of values to calculate the average of. + An observable sequence containing a single element with the average of the sequence of values. + + is null. + (Asynchronous) The source sequence is empty. + (Asynchronous) The sum of the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of values. + + A sequence of values to calculate the average of. + An observable sequence containing a single element with the average of the sequence of values. + + is null. + (Asynchronous) The source sequence is empty. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of values. + + A sequence of values to calculate the average of. + An observable sequence containing a single element with the average of the sequence of values. + + is null. + (Asynchronous) The source sequence is empty. + (Asynchronous) The sum of the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of values. + + A sequence of values to calculate the average of. + An observable sequence containing a single element with the average of the sequence of values. + + is null. + (Asynchronous) The source sequence is empty. + (Asynchronous) The sum of the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of nullable values. + + A sequence of nullable values to calculate the average of. + An observable sequence containing a single element with the average of the sequence of values, or null if the source sequence is empty or contains only values that are null. + + is null. + (Asynchronous) The source sequence is empty. + (Asynchronous) The sum of the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of nullable values. + + A sequence of nullable values to calculate the average of. + An observable sequence containing a single element with the average of the sequence of values, or null if the source sequence is empty or contains only values that are null. + + is null. + (Asynchronous) The source sequence is empty. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of nullable values. + + A sequence of nullable values to calculate the average of. + An observable sequence containing a single element with the average of the sequence of values, or null if the source sequence is empty or contains only values that are null. + + is null. + (Asynchronous) The source sequence is empty. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + (Asynchronous) The sum of the elements in the source sequence is larger than . + + + + Computes the average of an observable sequence of nullable values. + + A sequence of nullable values to calculate the average of. + An observable sequence containing a single element with the average of the sequence of values, or null if the source sequence is empty or contains only values that are null. + + is null. + (Asynchronous) The source sequence is empty. + (Asynchronous) The sum of the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of nullable values. + + A sequence of nullable values to calculate the average of. + An observable sequence containing a single element with the average of the sequence of values, or null if the source sequence is empty or contains only values that are null. + + is null. + (Asynchronous) The source sequence is empty. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of values. + + A sequence of values to calculate the average of. + An observable sequence containing a single element with the average of the sequence of values. + + is null. + (Asynchronous) The source sequence is empty. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values to calculate the average of. + A transform function to apply to each element. + An observable sequence containing a single element with the average of the sequence of values. + + or is null. + (Asynchronous) The source sequence is empty. + (Asynchronous) The sum of the projected values for the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values to calculate the average of. + A transform function to apply to each element. + An observable sequence containing a single element with the average of the sequence of values. + + or is null. + (Asynchronous) The source sequence is empty. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values to calculate the average of. + A transform function to apply to each element. + An observable sequence containing a single element with the average of the sequence of values. + + or is null. + (Asynchronous) The source sequence is empty. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values to calculate the average of. + A transform function to apply to each element. + An observable sequence containing a single element with the average of the sequence of values. + + or is null. + (Asynchronous) The source sequence is empty. + (Asynchronous) The sum of the projected values for the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values to calculate the average of. + A transform function to apply to each element. + An observable sequence containing a single element with the average of the sequence of values. + + or is null. + (Asynchronous) The source sequence is empty. + (Asynchronous) The sum of the projected values for the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of nullable values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values to calculate the average of. + A transform function to apply to each element. + An observable sequence containing a single element with the average of the sequence of values, or null if the source sequence is empty or contains only values that are null. + + or is null. + (Asynchronous) The source sequence is empty. + (Asynchronous) The sum of the projected values for the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of nullable values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values to calculate the average of. + A transform function to apply to each element. + An observable sequence containing a single element with the average of the sequence of values, or null if the source sequence is empty or contains only values that are null. + + or is null. + (Asynchronous) The source sequence is empty. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of nullable values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values to calculate the average of. + A transform function to apply to each element. + An observable sequence containing a single element with the average of the sequence of values, or null if the source sequence is empty or contains only values that are null. + + or is null. + (Asynchronous) The source sequence is empty. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of nullable values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values to calculate the average of. + A transform function to apply to each element. + An observable sequence containing a single element with the average of the sequence of values, or null if the source sequence is empty or contains only values that are null. + + or is null. + (Asynchronous) The source sequence is empty. + (Asynchronous) The sum of the projected values for the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the average of an observable sequence of nullable values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values to calculate the average of. + A transform function to apply to each element. + An observable sequence containing a single element with the average of the sequence of values, or null if the source sequence is empty or contains only values that are null. + + or is null. + (Asynchronous) The source sequence is empty. + (Asynchronous) The sum of the projected values for the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Projects each element of an observable sequence into consecutive non-overlapping buffers which are produced based on element count information. + + The type of the elements in the source sequence, and in the lists in the result sequence. + Source sequence to produce buffers over. + Length of each buffer. + An observable sequence of buffers. + + is null. + + is less than or equal to zero. + + + + Projects each element of an observable sequence into zero or more buffers which are produced based on element count information. + + The type of the elements in the source sequence, and in the lists in the result sequence. + Source sequence to produce buffers over. + Length of each buffer. + Number of elements to skip between creation of consecutive buffers. + An observable sequence of buffers. + + is null. + + or is less than or equal to zero. + + + + Projects each element of an observable sequence into consecutive non-overlapping buffers which are produced based on timing information. + + The type of the elements in the source sequence, and in the lists in the result sequence. + Source sequence to produce buffers over. + Length of each buffer. + An observable sequence of buffers. + + is null. + + is less than TimeSpan.Zero. + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create buffers as fast as it can. + Because all source sequence elements end up in one of the buffers, some buffers won't have a zero time span. This is a side-effect of the asynchrony introduced + by the scheduler, where the action to close the current buffer and to create a new buffer may not execute immediately, despite the TimeSpan.Zero due time. + + + + + Projects each element of an observable sequence into a buffer that's sent out when either it's full or a given amount of time has elapsed. + A useful real-world analogy of this overload is the behavior of a ferry leaving the dock when all seats are taken, or at the scheduled time of departure, whichever event occurs first. + + The type of the elements in the source sequence, and in the lists in the result sequence. + Source sequence to produce buffers over. + Maximum time length of a window. + Maximum element count of a window. + An observable sequence of buffers. + + is null. + + is less than TimeSpan.Zero. -or- is less than or equal to zero. + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create buffers as fast as it can. + Because all source sequence elements end up in one of the buffers, some buffers won't have a zero time span. This is a side-effect of the asynchrony introduced + by the scheduler, where the action to close the current buffer and to create a new buffer may not execute immediately, despite the TimeSpan.Zero due time. + + + + + Projects each element of an observable sequence into a buffer that's sent out when either it's full or a given amount of time has elapsed, using the specified scheduler to run timers. + A useful real-world analogy of this overload is the behavior of a ferry leaving the dock when all seats are taken, or at the scheduled time of departure, whichever event occurs first. + + The type of the elements in the source sequence, and in the lists in the result sequence. + Source sequence to produce buffers over. + Maximum time length of a buffer. + Maximum element count of a buffer. + Scheduler to run buffering timers on. + An observable sequence of buffers. + + or is null. + + is less than TimeSpan.Zero. -or- is less than or equal to zero. + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create buffers as fast as it can. + Because all source sequence elements end up in one of the buffers, some buffers won't have a zero time span. This is a side-effect of the asynchrony introduced + by the scheduler, where the action to close the current buffer and to create a new buffer may not execute immediately, despite the TimeSpan.Zero due time. + + + + + Projects each element of an observable sequence into consecutive non-overlapping buffers which are produced based on timing information, using the specified scheduler to run timers. + + The type of the elements in the source sequence, and in the lists in the result sequence. + Source sequence to produce buffers over. + Length of each buffer. + Scheduler to run buffering timers on. + An observable sequence of buffers. + + or is null. + + is less than TimeSpan.Zero. + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create buffers as fast as it can. + Because all source sequence elements end up in one of the buffers, some buffers won't have a zero time span. This is a side-effect of the asynchrony introduced + by the scheduler, where the action to close the current buffer and to create a new buffer may not execute immediately, despite the TimeSpan.Zero due time. + + + + + Projects each element of an observable sequence into zero or more buffers which are produced based on timing information. + + The type of the elements in the source sequence, and in the lists in the result sequence. + Source sequence to produce buffers over. + Length of each buffer. + Interval between creation of consecutive buffers. + An observable sequence of buffers. + + is null. + + or is less than TimeSpan.Zero. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create buffers with minimum duration + length. However, some buffers won't have a zero time span. This is a side-effect of the asynchrony introduced by the scheduler, where the action to close the + current buffer may not execute immediately, despite the TimeSpan.Zero due time. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create buffers as fast as it can. + However, this doesn't mean all buffers will start at the beginning of the source sequence. This is a side-effect of the asynchrony introduced by the scheduler, + where the action to create a new buffer may not execute immediately, despite the TimeSpan.Zero due time. + + + + + + Projects each element of an observable sequence into zero or more buffers which are produced based on timing information, using the specified scheduler to run timers. + + The type of the elements in the source sequence, and in the lists in the result sequence. + Source sequence to produce buffers over. + Length of each buffer. + Interval between creation of consecutive buffers. + Scheduler to run buffering timers on. + An observable sequence of buffers. + + or is null. + + or is less than TimeSpan.Zero. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create buffers with minimum duration + length. However, some buffers won't have a zero time span. This is a side-effect of the asynchrony introduced by the scheduler, where the action to close the + current buffer may not execute immediately, despite the TimeSpan.Zero due time. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create buffers as fast as it can. + However, this doesn't mean all buffers will start at the beginning of the source sequence. This is a side-effect of the asynchrony introduced by the scheduler, + where the action to create a new buffer may not execute immediately, despite the TimeSpan.Zero due time. + + + + + + Projects each element of an observable sequence into consecutive non-overlapping buffers. + + The type of the elements in the source sequence, and in the lists in the result sequence. + The type of the elements in the sequences indicating buffer boundary events. + Source sequence to produce buffers over. + Sequence of buffer boundary markers. The current buffer is closed and a new buffer is opened upon receiving a boundary marker. + An observable sequence of buffers. + + or is null. + + + + Projects each element of an observable sequence into consecutive non-overlapping buffers. + + The type of the elements in the source sequence, and in the lists in the result sequence. + The type of the elements in the sequences indicating buffer closing events. + Source sequence to produce buffers over. + A function invoked to define the boundaries of the produced buffers. A new buffer is started when the previous one is closed. + An observable sequence of buffers. + + or is null. + + + + Projects each element of an observable sequence into zero or more buffers. + + The type of the elements in the source sequence, and in the lists in the result sequence. + The type of the elements in the sequence indicating buffer opening events, also passed to the closing selector to obtain a sequence of buffer closing events. + The type of the elements in the sequences indicating buffer closing events. + Source sequence to produce buffers over. + Observable sequence whose elements denote the creation of new buffers. + A function invoked to define the closing of each produced buffer. + An observable sequence of buffers. + + or or is null. + + + + Uses to determine which source in to return, choosing an empty sequence if no match is found. + + Query provider used to construct the data source. + The type of the value returned by the selector function, used to look up the resulting source. + The type of the elements in the result sequence. + Selector function invoked to determine the source to lookup in the dictionary. + Dictionary of sources to select from based on the invocation result. + The observable sequence retrieved from the dictionary based on the invocation result, or an empty sequence if no match is found. + + or is null. + + + + Uses to determine which source in to return, choosing if no match is found. + + Query provider used to construct the data source. + The type of the value returned by the selector function, used to look up the resulting source. + The type of the elements in the result sequence. + Selector function invoked to determine the source to lookup in the dictionary. + Dictionary of sources to select from based on the invocation result. + Default source to select in case no matching source in is found. + The observable sequence retrieved from the dictionary based on the invocation result, or if no match is found. + + or or is null. + + + + Uses to determine which source in to return, choosing an empty sequence on the specified scheduler if no match is found. + + Query provider used to construct the data source. + The type of the value returned by the selector function, used to look up the resulting source. + The type of the elements in the result sequence. + Selector function invoked to determine the source to lookup in the dictionary. + Dictionary of sources to select from based on the invocation result. + Scheduler to generate an empty sequence on in case no matching source in is found. + The observable sequence retrieved from the dictionary based on the invocation result, or an empty sequence if no match is found. + + or or is null. + + + + Converts the elements of an observable sequence to the specified type. + + The type to convert the elements in the source sequence to. + The observable sequence that contains the elements to be converted. + An observable sequence that contains each element of the source sequence converted to the specified type. + + is null. + + + + Continues an observable sequence that is terminated by an exception with the next observable sequence. + + The type of the elements in the source sequence and handler sequence. + First observable sequence whose exception (if any) is caught. + Second observable sequence used to produce results when an error occurred in the first sequence. + An observable sequence containing the first sequence's elements, followed by the elements of the second sequence in case an exception occurred. + + or is null. + + + + Continues an observable sequence that is terminated by an exception with the next observable sequence. + + Query provider used to construct the data source. + The type of the elements in the source and handler sequences. + Observable sequences to catch exceptions for. + An observable sequence containing elements from consecutive source sequences until a source sequence terminates successfully. + + is null. + + + + Continues an observable sequence that is terminated by an exception with the next observable sequence. + + Query provider used to construct the data source. + The type of the elements in the source and handler sequences. + Observable sequences to catch exceptions for. + An observable sequence containing elements from consecutive source sequences until a source sequence terminates successfully. + + is null. + + + + Continues an observable sequence that is terminated by an exception of the specified type with the observable sequence produced by the handler. + + The type of the elements in the source sequence and sequences returned by the exception handler function. + The type of the exception to catch and handle. Needs to derive from . + Source sequence. + Exception handler function, producing another observable sequence. + An observable sequence containing the source sequence's elements, followed by the elements produced by the handler's resulting observable sequence in case an exception occurred. + + or is null. + + + + Produces an enumerable sequence of consecutive (possibly empty) chunks of the source sequence. + + The type of the elements in the source sequence. + Source observable sequence. + The enumerable sequence that returns consecutive (possibly empty) chunks upon each iteration. + + is null. + This operator requires the source's object (see ) to implement . + + + + Produces an enumerable sequence that returns elements collected/aggregated from the source sequence between consecutive iterations. + + The type of the elements in the source sequence. + The type of the elements produced by the merge operation during collection. + Source observable sequence. + Factory to create the initial collector object. + Merges a sequence element with the current collector. + Factory to replace the current collector by a new collector. + The enumerable sequence that returns collected/aggregated elements from the source sequence upon each iteration. + + or or or is null. + This operator requires the source's object (see ) to implement . + + + + Produces an enumerable sequence that returns elements collected/aggregated from the source sequence between consecutive iterations. + + The type of the elements in the source sequence. + The type of the elements produced by the merge operation during collection. + Source observable sequence. + Factory to create a new collector object. + Merges a sequence element with the current collector. + The enumerable sequence that returns collected/aggregated elements from the source sequence upon each iteration. + + or or is null. + This operator requires the source's object (see ) to implement . + + + + Merges the specified observable sequences into one observable sequence by emitting a list with the latest source elements whenever any of the observable sequences produces an element. + + Query provider used to construct the data source. + The type of the elements in the source sequences, and in the lists in the result sequence. + Observable sources. + An observable sequence containing lists of the latest elements of the sources. + + is null. + + + + Merges the specified observable sequences into one observable sequence by emitting a list with the latest source elements whenever any of the observable sequences produces an element. + + Query provider used to construct the data source. + The type of the elements in the source sequences, and in the lists in the result sequence. + Observable sources. + An observable sequence containing lists of the latest elements of the sources. + + is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + Query provider used to construct the data source. + The type of the elements in the source sequences. + The type of the elements in the result sequence, returned by the selector function. + Observable sources. + Function to invoke whenever any of the sources produces an element. For efficiency, the input list is reused after the selector returns. Either aggregate or copy the values during the function call. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or is null. + + + + Merges two observable sequences into one observable sequence by using the selector function whenever one of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Function to invoke whenever either of the sources produces an element. + An observable sequence containing the result of combining elements of both sources using the specified result selector function. + + or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Eleventh observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Eleventh observable source. + Twelfth observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the thirteenth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Eleventh observable source. + Twelfth observable source. + Thirteenth observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the thirteenth source sequence. + The type of the elements in the fourteenth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Eleventh observable source. + Twelfth observable source. + Thirteenth observable source. + Fourteenth observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the thirteenth source sequence. + The type of the elements in the fourteenth source sequence. + The type of the elements in the fifteenth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Eleventh observable source. + Twelfth observable source. + Thirteenth observable source. + Fourteenth observable source. + Fifteenth observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or or or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever any of the observable sequences produces an element. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the thirteenth source sequence. + The type of the elements in the fourteenth source sequence. + The type of the elements in the fifteenth source sequence. + The type of the elements in the sixteenth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Eleventh observable source. + Twelfth observable source. + Thirteenth observable source. + Fourteenth observable source. + Fifteenth observable source. + Sixteenth observable source. + Function to invoke whenever any of the sources produces an element. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or or or or or or or or or or or or or is null. + + + + Concatenates the second observable sequence to the first observable sequence upon successful termination of the first. + + The type of the elements in the source sequences. + First observable sequence. + Second observable sequence. + An observable sequence that contains the elements of the first sequence, followed by those of the second the sequence. + + or is null. + + + + Concatenates all of the specified observable sequences, as long as the previous observable sequence terminated successfully. + + Query provider used to construct the data source. + The type of the elements in the source sequences. + Observable sequences to concatenate. + An observable sequence that contains the elements of each given sequence, in sequential order. + + is null. + + + + Concatenates all observable sequences in the given enumerable sequence, as long as the previous observable sequence terminated successfully. + + Query provider used to construct the data source. + The type of the elements in the source sequences. + Observable sequences to concatenate. + An observable sequence that contains the elements of each given sequence, in sequential order. + + is null. + + + + Concatenates all inner observable sequences, as long as the previous observable sequence terminated successfully. + + The type of the elements in the source sequences. + Observable sequence of inner observable sequences. + An observable sequence that contains the elements of each observed inner sequence, in sequential order. + + is null. + + + + Concatenates all task results, as long as the previous task terminated successfully. + + The type of the results produced by the tasks. + Observable sequence of tasks. + An observable sequence that contains the results of each task, in sequential order. + + is null. + If the tasks support cancellation, consider manual conversion of the tasks using , followed by a concatenation operation using . + + + + Determines whether an observable sequence contains a specified element by using the default equality comparer. + + The type of the elements in the source sequence. + An observable sequence in which to locate a value. + The value to locate in the source sequence. + An observable sequence containing a single element determining whether the source sequence contains an element that has the specified value. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Determines whether an observable sequence contains a specified element by using a specified System.Collections.Generic.IEqualityComparer{T}. + + The type of the elements in the source sequence. + An observable sequence in which to locate a value. + The value to locate in the source sequence. + An equality comparer to compare elements. + An observable sequence containing a single element determining whether the source sequence contains an element that has the specified value. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns an observable sequence containing an that represents the total number of elements in an observable sequence. + + The type of the elements in the source sequence. + An observable sequence that contains elements to be counted. + An observable sequence containing a single element with the number of elements in the input sequence. + + is null. + (Asynchronous) The number of elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns an observable sequence containing an that represents how many elements in the specified observable sequence satisfy a condition. + + The type of the elements in the source sequence. + An observable sequence that contains elements to be counted. + A function to test each element for a condition. + An observable sequence containing a single element with a number that represents how many elements in the input sequence satisfy the condition in the predicate function. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Creates an observable sequence from a specified Subscribe method implementation. + + Query provider used to construct the data source. + The type of the elements in the produced sequence. + Implementation of the resulting observable sequence's Subscribe method. + The observable sequence with the specified implementation for the Subscribe method. + + is null. + + Use of this operator is preferred over manual implementation of the interface. In case + you need a type implementing rather than an anonymous implementation, consider using + the abstract base class. + + + + + Creates an observable sequence from a specified Subscribe method implementation. + + Query provider used to construct the data source. + The type of the elements in the produced sequence. + Implementation of the resulting observable sequence's Subscribe method, returning an Action delegate that will be wrapped in an IDisposable. + The observable sequence with the specified implementation for the Subscribe method. + + is null. + + Use of this operator is preferred over manual implementation of the interface. In case + you need a type implementing rather than an anonymous implementation, consider using + the abstract base class. + + + + + Creates an observable sequence from a specified cancellable asynchronous Subscribe method. + The CancellationToken passed to the asynchronous Subscribe method is tied to the returned disposable subscription, allowing best-effort cancellation. + + Query provider used to construct the data source. + The type of the elements in the produced sequence. + Asynchronous method used to produce elements. + The observable sequence surfacing the elements produced by the asynchronous method. + + is null. + This operator is especially useful in conjunction with the asynchronous programming features introduced in C# 5.0 and Visual Basic 11. + When a subscription to the resulting sequence is disposed, the CancellationToken that was fed to the asynchronous subscribe function will be signaled. + + + + Creates an observable sequence from a specified asynchronous Subscribe method. + + Query provider used to construct the data source. + The type of the elements in the produced sequence. + Asynchronous method used to produce elements. + The observable sequence surfacing the elements produced by the asynchronous method. + + is null. + This operator is especially useful in conjunction with the asynchronous programming features introduced in C# 5.0 and Visual Basic 11. + + + + Creates an observable sequence from a specified cancellable asynchronous Subscribe method. + The CancellationToken passed to the asynchronous Subscribe method is tied to the returned disposable subscription, allowing best-effort cancellation. + + Query provider used to construct the data source. + The type of the elements in the produced sequence. + Asynchronous method used to implement the resulting sequence's Subscribe method. + The observable sequence with the specified implementation for the Subscribe method. + + is null. + This operator is especially useful in conjunction with the asynchronous programming features introduced in C# 5.0 and Visual Basic 11. + When a subscription to the resulting sequence is disposed, the CancellationToken that was fed to the asynchronous subscribe function will be signaled. + + + + Creates an observable sequence from a specified asynchronous Subscribe method. + + Query provider used to construct the data source. + The type of the elements in the produced sequence. + Asynchronous method used to implement the resulting sequence's Subscribe method. + The observable sequence with the specified implementation for the Subscribe method. + + is null. + This operator is especially useful in conjunction with the asynchronous programming features introduced in C# 5.0 and Visual Basic 11. + + + + Creates an observable sequence from a specified cancellable asynchronous Subscribe method. + The CancellationToken passed to the asynchronous Subscribe method is tied to the returned disposable subscription, allowing best-effort cancellation. + + Query provider used to construct the data source. + The type of the elements in the produced sequence. + Asynchronous method used to implement the resulting sequence's Subscribe method, returning an Action delegate that will be wrapped in an IDisposable. + The observable sequence with the specified implementation for the Subscribe method. + + is null. + This operator is especially useful in conjunction with the asynchronous programming features introduced in C# 5.0 and Visual Basic 11. + When a subscription to the resulting sequence is disposed, the CancellationToken that was fed to the asynchronous subscribe function will be signaled. + + + + Creates an observable sequence from a specified asynchronous Subscribe method. + + Query provider used to construct the data source. + The type of the elements in the produced sequence. + Asynchronous method used to implement the resulting sequence's Subscribe method, returning an Action delegate that will be wrapped in an IDisposable. + The observable sequence with the specified implementation for the Subscribe method. + + is null. + This operator is especially useful in conjunction with the asynchronous programming features introduced in C# 5.0 and Visual Basic 11. + + + + Returns the elements of the specified sequence or the type parameter's default value in a singleton sequence if the sequence is empty. + + The type of the elements in the source sequence (if any), whose default value will be taken if the sequence is empty. + The sequence to return a default value for if it is empty. + An observable sequence that contains the default value for the TSource type if the source is empty; otherwise, the elements of the source itself. + + is null. + + + + Returns the elements of the specified sequence or the specified value in a singleton sequence if the sequence is empty. + + The type of the elements in the source sequence (if any), and the specified default value which will be taken if the sequence is empty. + The sequence to return the specified value for if it is empty. + The value to return if the sequence is empty. + An observable sequence that contains the specified default value if the source is empty; otherwise, the elements of the source itself. + + is null. + + + + Returns an observable sequence that invokes the specified factory function whenever a new observer subscribes. + + Query provider used to construct the data source. + The type of the elements in the sequence returned by the factory function, and in the resulting sequence. + Observable factory function to invoke for each observer that subscribes to the resulting sequence. + An observable sequence whose observers trigger an invocation of the given observable factory function. + + is null. + + + + Returns an observable sequence that starts the specified asynchronous factory function whenever a new observer subscribes. + + Query provider used to construct the data source. + The type of the elements in the sequence returned by the factory function, and in the resulting sequence. + Asynchronous factory function to start for each observer that subscribes to the resulting sequence. + An observable sequence whose observers trigger the given asynchronous observable factory function to be started. + + is null. + This operator is especially useful in conjunction with the asynchronous programming features introduced in C# 5.0 and Visual Basic 11. + + + + Returns an observable sequence that starts the specified cancellable asynchronous factory function whenever a new observer subscribes. + The CancellationToken passed to the asynchronous factory function is tied to the returned disposable subscription, allowing best-effort cancellation. + + Query provider used to construct the data source. + The type of the elements in the sequence returned by the factory function, and in the resulting sequence. + Asynchronous factory function to start for each observer that subscribes to the resulting sequence. + An observable sequence whose observers trigger the given asynchronous observable factory function to be started. + + is null. + This operator is especially useful in conjunction with the asynchronous programming features introduced in C# 5.0 and Visual Basic 11. + When a subscription to the resulting sequence is disposed, the CancellationToken that was fed to the asynchronous observable factory function will be signaled. + + + + Time shifts the observable sequence to start propagating notifications at the specified absolute time. + The relative time intervals between the values are preserved. + + The type of the elements in the source sequence. + Source sequence to delay values for. + Absolute time used to shift the observable sequence; the relative time shift gets computed upon subscription. If this value is less than or equal to DateTimeOffset.UtcNow, the scheduler will dispatch observer callbacks as soon as possible. + Time-shifted sequence. + + is null. + + + This operator is less efficient than DelaySubscription because it records all notifications and time-delays those. This allows for immediate propagation of errors. + + + Observer callbacks for the resulting sequence will be run on the default scheduler. This effect is similar to using ObserveOn. + + + Exceptions signaled by the source sequence through an OnError callback are forwarded immediately to the result sequence. Any OnNext notifications that were in the queue at the point of the OnError callback will be dropped. + In order to delay error propagation, consider using the Observable.Materialize and Observable.Dematerialize operators, or use DelaySubscription. + + + + + + Time shifts the observable sequence to start propagating notifications at the specified absolute time, using the specified scheduler to run timers. + The relative time intervals between the values are preserved. + + The type of the elements in the source sequence. + Source sequence to delay values for. + Absolute time used to shift the observable sequence; the relative time shift gets computed upon subscription. If this value is less than or equal to DateTimeOffset.UtcNow, the scheduler will dispatch observer callbacks as soon as possible. + Scheduler to run the delay timers on. + Time-shifted sequence. + + or is null. + + + This operator is less efficient than DelaySubscription because it records all notifications and time-delays those. This allows for immediate propagation of errors. + + + Observer callbacks for the resulting sequence will be run on the specified scheduler. This effect is similar to using ObserveOn. + + + Exceptions signaled by the source sequence through an OnError callback are forwarded immediately to the result sequence. Any OnNext notifications that were in the queue at the point of the OnError callback will be dropped. + In order to delay error propagation, consider using the Observable.Materialize and Observable.Dematerialize operators, or use DelaySubscription. + + + + + + Time shifts the observable sequence by the specified relative time duration. + The relative time intervals between the values are preserved. + + The type of the elements in the source sequence. + Source sequence to delay values for. + Relative time by which to shift the observable sequence. If this value is equal to TimeSpan.Zero, the scheduler will dispatch observer callbacks as soon as possible. + Time-shifted sequence. + + is null. + + is less than TimeSpan.Zero. + + + This operator is less efficient than DelaySubscription because it records all notifications and time-delays those. This allows for immediate propagation of errors. + + + Observer callbacks for the resulting sequence will be run on the default scheduler. This effect is similar to using ObserveOn. + + + Exceptions signaled by the source sequence through an OnError callback are forwarded immediately to the result sequence. Any OnNext notifications that were in the queue at the point of the OnError callback will be dropped. + In order to delay error propagation, consider using the Observable.Materialize and Observable.Dematerialize operators, or use DelaySubscription. + + + + + + Time shifts the observable sequence by the specified relative time duration, using the specified scheduler to run timers. + The relative time intervals between the values are preserved. + + The type of the elements in the source sequence. + Source sequence to delay values for. + Relative time by which to shift the observable sequence. If this value is equal to TimeSpan.Zero, the scheduler will dispatch observer callbacks as soon as possible. + Scheduler to run the delay timers on. + Time-shifted sequence. + + or is null. + + is less than TimeSpan.Zero. + + + This operator is less efficient than DelaySubscription because it records all notifications and time-delays those. This allows for immediate propagation of errors. + + + Observer callbacks for the resulting sequence will be run on the specified scheduler. This effect is similar to using ObserveOn. + + + Exceptions signaled by the source sequence through an OnError callback are forwarded immediately to the result sequence. Any OnNext notifications that were in the queue at the point of the OnError callback will be dropped. + + + Exceptions signaled by the source sequence through an OnError callback are forwarded immediately to the result sequence. Any OnNext notifications that were in the queue at the point of the OnError callback will be dropped. + In order to delay error propagation, consider using the Observable.Materialize and Observable.Dematerialize operators, or use DelaySubscription. + + + + + + Time shifts the observable sequence based on a delay selector function for each element. + + The type of the elements in the source sequence. + The type of the elements in the delay sequences used to denote the delay duration of each element in the source sequence. + Source sequence to delay values for. + Selector function to retrieve a sequence indicating the delay for each given element. + Time-shifted sequence. + + or is null. + + + + Time shifts the observable sequence based on a subscription delay and a delay selector function for each element. + + The type of the elements in the source sequence. + The type of the elements in the delay sequences used to denote the delay duration of each element in the source sequence. + Source sequence to delay values for. + Sequence indicating the delay for the subscription to the source. + Selector function to retrieve a sequence indicating the delay for each given element. + Time-shifted sequence. + + or or is null. + + + + Time shifts the observable sequence by delaying the subscription to the specified absolute time. + + The type of the elements in the source sequence. + Source sequence to delay subscription for. + Absolute time to perform the subscription at. + Time-shifted sequence. + + is null. + + + This operator is more efficient than Delay but postpones all side-effects of subscription and affects error propagation timing. + + + The side-effects of subscribing to the source sequence will be run on the default scheduler. Observer callbacks will not be affected. + + + + + + Time shifts the observable sequence by delaying the subscription to the specified absolute time, using the specified scheduler to run timers. + + The type of the elements in the source sequence. + Source sequence to delay subscription for. + Absolute time to perform the subscription at. + Scheduler to run the subscription delay timer on. + Time-shifted sequence. + + or is null. + + + This operator is more efficient than Delay but postpones all side-effects of subscription and affects error propagation timing. + + + The side-effects of subscribing to the source sequence will be run on the specified scheduler. Observer callbacks will not be affected. + + + + + + Time shifts the observable sequence by delaying the subscription with the specified relative time duration. + + The type of the elements in the source sequence. + Source sequence to delay subscription for. + Relative time shift of the subscription. + Time-shifted sequence. + + is null. + + is less than TimeSpan.Zero. + + + This operator is more efficient than Delay but postpones all side-effects of subscription and affects error propagation timing. + + + The side-effects of subscribing to the source sequence will be run on the default scheduler. Observer callbacks will not be affected. + + + + + + Time shifts the observable sequence by delaying the subscription with the specified relative time duration, using the specified scheduler to run timers. + + The type of the elements in the source sequence. + Source sequence to delay subscription for. + Relative time shift of the subscription. + Scheduler to run the subscription delay timer on. + Time-shifted sequence. + + or is null. + + is less than TimeSpan.Zero. + + + This operator is more efficient than Delay but postpones all side-effects of subscription and affects error propagation timing. + + + The side-effects of subscribing to the source sequence will be run on the specified scheduler. Observer callbacks will not be affected. + + + + + + Dematerializes the explicit notification values of an observable sequence as implicit notifications. + + The type of the elements materialized in the source sequence notification objects. + An observable sequence containing explicit notification values which have to be turned into implicit notifications. + An observable sequence exhibiting the behavior corresponding to the source sequence's notification values. + + is null. + + + + Returns an observable sequence that contains only distinct elements. + + The type of the elements in the source sequence. + An observable sequence to retain distinct elements for. + An observable sequence only containing the distinct elements from the source sequence. + + is null. + Usage of this operator should be considered carefully due to the maintenance of an internal lookup structure which can grow large. + + + + Returns an observable sequence that contains only distinct elements according to the comparer. + + The type of the elements in the source sequence. + An observable sequence to retain distinct elements for. + Equality comparer for source elements. + An observable sequence only containing the distinct elements from the source sequence. + + or is null. + Usage of this operator should be considered carefully due to the maintenance of an internal lookup structure which can grow large. + + + + Returns an observable sequence that contains only distinct elements according to the keySelector. + + The type of the elements in the source sequence. + The type of the discriminator key computed for each element in the source sequence. + An observable sequence to retain distinct elements for. + A function to compute the comparison key for each element. + An observable sequence only containing the distinct elements, based on a computed key value, from the source sequence. + + or is null. + Usage of this operator should be considered carefully due to the maintenance of an internal lookup structure which can grow large. + + + + Returns an observable sequence that contains only distinct elements according to the keySelector and the comparer. + + The type of the elements in the source sequence. + The type of the discriminator key computed for each element in the source sequence. + An observable sequence to retain distinct elements for. + A function to compute the comparison key for each element. + Equality comparer for source elements. + An observable sequence only containing the distinct elements, based on a computed key value, from the source sequence. + + or or is null. + Usage of this operator should be considered carefully due to the maintenance of an internal lookup structure which can grow large. + + + + Returns an observable sequence that contains only distinct contiguous elements. + + The type of the elements in the source sequence. + An observable sequence to retain distinct contiguous elements for. + An observable sequence only containing the distinct contiguous elements from the source sequence. + + is null. + + + + Returns an observable sequence that contains only distinct contiguous elements according to the comparer. + + The type of the elements in the source sequence. + An observable sequence to retain distinct contiguous elements for. + Equality comparer for source elements. + An observable sequence only containing the distinct contiguous elements from the source sequence. + + or is null. + + + + Returns an observable sequence that contains only distinct contiguous elements according to the keySelector. + + The type of the elements in the source sequence. + The type of the discriminator key computed for each element in the source sequence. + An observable sequence to retain distinct contiguous elements for, based on a computed key value. + A function to compute the comparison key for each element. + An observable sequence only containing the distinct contiguous elements, based on a computed key value, from the source sequence. + + or is null. + + + + Returns an observable sequence that contains only distinct contiguous elements according to the keySelector and the comparer. + + The type of the elements in the source sequence. + The type of the discriminator key computed for each element in the source sequence. + An observable sequence to retain distinct contiguous elements for, based on a computed key value. + A function to compute the comparison key for each element. + Equality comparer for computed key values. + An observable sequence only containing the distinct contiguous elements, based on a computed key value, from the source sequence. + + or or is null. + + + + Invokes the observer's methods for each message in the source sequence. + This method can be used for debugging, logging, etc. of query behavior by intercepting the message stream to run arbitrary actions for messages on the pipeline. + + The type of the elements in the source sequence. + Source sequence. + Observer whose methods to invoke as part of the source sequence's observation. + The source sequence with the side-effecting behavior applied. + + or is null. + + + + Invokes an action for each element in the observable sequence, and propagates all observer messages through the result sequence. + This method can be used for debugging, logging, etc. of query behavior by intercepting the message stream to run arbitrary actions for messages on the pipeline. + + The type of the elements in the source sequence. + Source sequence. + Action to invoke for each element in the observable sequence. + The source sequence with the side-effecting behavior applied. + + or is null. + + + + Invokes an action for each element in the observable sequence and invokes an action upon graceful termination of the observable sequence. + This method can be used for debugging, logging, etc. of query behavior by intercepting the message stream to run arbitrary actions for messages on the pipeline. + + The type of the elements in the source sequence. + Source sequence. + Action to invoke for each element in the observable sequence. + Action to invoke upon graceful termination of the observable sequence. + The source sequence with the side-effecting behavior applied. + + or or is null. + + + + Invokes an action for each element in the observable sequence and invokes an action upon exceptional termination of the observable sequence. + This method can be used for debugging, logging, etc. of query behavior by intercepting the message stream to run arbitrary actions for messages on the pipeline. + + The type of the elements in the source sequence. + Source sequence. + Action to invoke for each element in the observable sequence. + Action to invoke upon exceptional termination of the observable sequence. + The source sequence with the side-effecting behavior applied. + + or or is null. + + + + Invokes an action for each element in the observable sequence and invokes an action upon graceful or exceptional termination of the observable sequence. + This method can be used for debugging, logging, etc. of query behavior by intercepting the message stream to run arbitrary actions for messages on the pipeline. + + The type of the elements in the source sequence. + Source sequence. + Action to invoke for each element in the observable sequence. + Action to invoke upon exceptional termination of the observable sequence. + Action to invoke upon graceful termination of the observable sequence. + The source sequence with the side-effecting behavior applied. + + or or or is null. + + + + Repeats the given as long as the specified holds, where the is evaluated after each repeated completed. + + The type of the elements in the source sequence. + Source to repeat as long as the function evaluates to true. + Condition that will be evaluated upon the completion of an iteration through the , to determine whether repetition of the source is required. + The observable sequence obtained by concatenating the sequence as long as the holds. + + or is null. + + + + Returns the element at a specified index in a sequence. + + The type of the elements in the source sequence. + Observable sequence to return the element from. + The zero-based index of the element to retrieve. + An observable sequence that produces the element at the specified position in the source sequence. + + is null. + + is less than zero. + (Asynchronous) is greater than or equal to the number of elements in the source sequence. + + + + Returns the element at a specified index in a sequence or a default value if the index is out of range. + + The type of the elements in the source sequence. + Observable sequence to return the element from. + The zero-based index of the element to retrieve. + An observable sequence that produces the element at the specified position in the source sequence, or a default value if the index is outside the bounds of the source sequence. + + is null. + + is less than zero. + + + + Returns an empty observable sequence. + + Query provider used to construct the data source. + The type used for the type parameter of the resulting sequence. + An observable sequence with no elements. + + + + Returns an empty observable sequence, using the specified scheduler to send out the single OnCompleted message. + + Query provider used to construct the data source. + The type used for the type parameter of the resulting sequence. + Scheduler to send the termination call on. + An observable sequence with no elements. + + is null. + + + + Returns an empty observable sequence, using the specified scheduler to send out the single OnCompleted message. + + Query provider used to construct the data source. + The type used for the type parameter of the resulting sequence. + Scheduler to send the termination call on. + Object solely used to infer the type of the type parameter. This parameter is typically used when creating a sequence of anonymously typed elements. + An observable sequence with no elements. + + is null. + + + + Returns an empty observable sequence. + + Query provider used to construct the data source. + The type used for the type parameter of the resulting sequence. + Object solely used to infer the type of the type parameter. This parameter is typically used when creating a sequence of anonymously typed elements. + An observable sequence with no elements. + + + + Invokes a specified action after the source observable sequence terminates gracefully or exceptionally. + + The type of the elements in the source sequence. + Source sequence. + Action to invoke after the source observable sequence terminates. + Source sequence with the action-invoking termination behavior applied. + + or is null. + + + + Returns the first element of an observable sequence. + + The type of the elements in the source sequence. + Source observable sequence. + Sequence containing the first element in the observable sequence. + + is null. + (Asynchronous) The source sequence is empty. + + + + Returns the first element of an observable sequence that satisfies the condition in the predicate. + + The type of the elements in the source sequence. + Source observable sequence. + A predicate function to evaluate for elements in the source sequence. + Sequence containing the first element in the observable sequence that satisfies the condition in the predicate. + + or is null. + (Asynchronous) No element satisfies the condition in the predicate. -or- The source sequence is empty. + + + + Returns the first element of an observable sequence, or a default value if no such element exists. + + The type of the elements in the source sequence. + Source observable sequence. + Sequence containing the first element in the observable sequence, or a default value if no such element exists. + + is null. + + + + Returns the first element of an observable sequence that satisfies the condition in the predicate, or a default value if no such element exists. + + The type of the elements in the source sequence. + Source observable sequence. + A predicate function to evaluate for elements in the source sequence. + Sequence containing the first element in the observable sequence that satisfies the condition in the predicate, or a default value if no such element exists. + + or is null. + + + + Concatenates the observable sequences obtained by running the for each element in the given enumerable . + + Query provider used to construct the data source. + The type of the elements in the enumerable source sequence. + The type of the elements in the observable result sequence. + Enumerable source for which each element will be mapped onto an observable source that will be concatenated in the result sequence. + Function to select an observable source for each element in the . + The observable sequence obtained by concatenating the sources returned by for each element in the . + + or is null. + + + + Converts to asynchronous action into an observable sequence. Each subscription to the resulting sequence causes the action to be started. + + Query provider used to construct the data source. + Asynchronous action to convert. + An observable sequence exposing a Unit value upon completion of the action, or an exception. + + is null. + + + + Converts to asynchronous action into an observable sequence. Each subscription to the resulting sequence causes the action to be started. + + Query provider used to construct the data source. + Asynchronous action to convert. + Scheduler on which to notify observers. + An observable sequence exposing a Unit value upon completion of the action, or an exception. + + is null or is null. + + + + Converts to asynchronous action into an observable sequence. Each subscription to the resulting sequence causes the action to be started. + The CancellationToken passed to the asynchronous action is tied to the observable sequence's subscription that triggered the action's invocation and can be used for best-effort cancellation. + + Query provider used to construct the data source. + Asynchronous action to convert. + An observable sequence exposing a Unit value upon completion of the action, or an exception. + When a subscription to the resulting sequence is disposed, the CancellationToken that was fed to the asynchronous function will be signaled. + + is null. + + + + Converts to asynchronous action into an observable sequence. Each subscription to the resulting sequence causes the action to be started. + The CancellationToken passed to the asynchronous action is tied to the observable sequence's subscription that triggered the action's invocation and can be used for best-effort cancellation. + + Query provider used to construct the data source. + Asynchronous action to convert. + Scheduler on which to notify observers. + An observable sequence exposing a Unit value upon completion of the action, or an exception. + When a subscription to the resulting sequence is disposed, the CancellationToken that was fed to the asynchronous function will be signaled. + + is null or is null. + + + + Converts to asynchronous function into an observable sequence. Each subscription to the resulting sequence causes the function to be started. + + Query provider used to construct the data source. + The type of the result returned by the asynchronous function. + Asynchronous function to convert. + An observable sequence exposing the result of invoking the function, or an exception. + + is null. + + + + Converts to asynchronous function into an observable sequence. Each subscription to the resulting sequence causes the function to be started. + The CancellationToken passed to the asynchronous function is tied to the observable sequence's subscription that triggered the function's invocation and can be used for best-effort cancellation. + + Query provider used to construct the data source. + The type of the result returned by the asynchronous function. + Asynchronous function to convert. + An observable sequence exposing the result of invoking the function, or an exception. + + is null. + When a subscription to the resulting sequence is disposed, the CancellationToken that was fed to the asynchronous function will be signaled. + + + + Converts to asynchronous function into an observable sequence. Each subscription to the resulting sequence causes the function to be started. + + Query provider used to construct the data source. + The type of the result returned by the asynchronous function. + Asynchronous function to convert. + Scheduler on which to notify observers. + An observable sequence exposing the result of invoking the function, or an exception. + + is null or is null. + + + + Converts to asynchronous function into an observable sequence. Each subscription to the resulting sequence causes the function to be started. + The CancellationToken passed to the asynchronous function is tied to the observable sequence's subscription that triggered the function's invocation and can be used for best-effort cancellation. + + Query provider used to construct the data source. + The type of the result returned by the asynchronous function. + Asynchronous function to convert. + Scheduler on which to notify observers. + An observable sequence exposing the result of invoking the function, or an exception. + + is null or is null. + When a subscription to the resulting sequence is disposed, the CancellationToken that was fed to the asynchronous function will be signaled. + + + + Converts an Action-based .NET event to an observable sequence. Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead. + + Query provider used to construct the data source. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The observable sequence that contains the event argument objects passed to the invocations of the underlying .NET event. + + or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEvent, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEvent, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEvent calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts an Action-based .NET event to an observable sequence. Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead. + + Query provider used to construct the data source. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains the event argument objects passed to the invocations of the underlying .NET event. + + or or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEvent calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEvent that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts a .NET event to an observable sequence, using a supplied event delegate type. Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead. + + Query provider used to construct the data source. + The delegate type of the event to be converted. + The type of the event data generated by the event. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The observable sequence that contains the event argument objects passed to the invocations of the underlying .NET event. + + or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEvent, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEvent, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEvent calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts a .NET event to an observable sequence, using a supplied event delegate type. Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead. + + Query provider used to construct the data source. + The delegate type of the event to be converted. + The type of the event data generated by the event. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains the event argument objects passed to the invocations of the underlying .NET event. + + or or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEvent calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEvent that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts a .NET event to an observable sequence, using a conversion function to obtain the event delegate. Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead. + + Query provider used to construct the data source. + The delegate type of the event to be converted. + The type of the event data generated by the event. + A function used to convert the given event handler to a delegate compatible with the underlying .NET event. The resulting delegate is used in calls to the addHandler and removeHandler action parameters. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The observable sequence that contains the event argument objects passed to the invocations of the underlying .NET event. + + or or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEvent, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEvent, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEvent calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts a .NET event to an observable sequence, using a conversion function to obtain the event delegate. Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead. + + Query provider used to construct the data source. + The delegate type of the event to be converted. + The type of the event data generated by the event. + A function used to convert the given event handler to a delegate compatible with the underlying .NET event. The resulting delegate is used in calls to the addHandler and removeHandler action parameters. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains the event argument objects passed to the invocations of the underlying .NET event. + + or or or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEvent calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEvent that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts a generic Action-based .NET event to an observable sequence. Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead. + + Query provider used to construct the data source. + The type of the event data generated by the event. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The observable sequence that contains the event argument objects passed to the invocations of the underlying .NET event. + + or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEvent, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEvent, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEvent calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts a generic Action-based .NET event to an observable sequence. Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead. + + Query provider used to construct the data source. + The type of the event data generated by the event. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains the event argument objects passed to the invocations of the underlying .NET event. + + or or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEvent calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEvent that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts a .NET event, conforming to the standard .NET event pattern based on , to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Query provider used to construct the data source. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The observable sequence that contains data representations of invocations of the underlying .NET event. + + or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEventPattern, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts a .NET event, conforming to the standard .NET event pattern based on , to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Query provider used to construct the data source. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains data representations of invocations of the underlying .NET event. + + or or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts an instance .NET event, conforming to the standard .NET event pattern with an parameter, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + Reflection is used to discover the event based on the target object type and the specified event name. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Query provider used to construct the data source. + Object instance that exposes the event to convert. + Name of the event to convert. + The observable sequence that contains data representations of invocations of the underlying .NET event. + + or is null. + The event could not be found. -or- The event does not conform to the standard .NET event pattern. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEventPattern, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts an instance .NET event, conforming to the standard .NET event pattern with an parameter, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + Reflection is used to discover the event based on the target object type and the specified event name. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Query provider used to construct the data source. + Object instance that exposes the event to convert. + Name of the event to convert. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains data representations of invocations of the underlying .NET event. + + or or is null. + The event could not be found. -or- The event does not conform to the standard .NET event pattern. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts a static .NET event, conforming to the standard .NET event pattern with an parameter, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + Reflection is used to discover the event based on the specified type and the specified event name. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Query provider used to construct the data source. + Type that exposes the static event to convert. + Name of the event to convert. + The observable sequence that contains data representations of invocations of the underlying .NET event. + + or is null. + The event could not be found. -or- The event does not conform to the standard .NET event pattern. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEventPattern, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts a static .NET event, conforming to the standard .NET event pattern with an parameter, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + Reflection is used to discover the event based on the specified type and the specified event name. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Query provider used to construct the data source. + Type that exposes the static event to convert. + Name of the event to convert. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains data representations of invocations of the underlying .NET event. + + or or is null. + The event could not be found. -or- The event does not conform to the standard .NET event pattern. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts a .NET event, conforming to the standard .NET event pattern based on a supplied event delegate type, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Query provider used to construct the data source. + The delegate type of the event to be converted. + The type of the event data generated by the event. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The observable sequence that contains data representations of invocations of the underlying .NET event. + + or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEventPattern, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts a .NET event, conforming to the standard .NET event pattern based on a supplied event delegate type, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Query provider used to construct the data source. + The delegate type of the event to be converted. + The type of the event data generated by the event. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains data representations of invocations of the underlying .NET event. + + or or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts a .NET event, conforming to the standard .NET event pattern based on , to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Query provider used to construct the data source. + The delegate type of the event to be converted. + The type of the event data generated by the event. + A function used to convert the given event handler to a delegate compatible with the underlying .NET event. The resulting delegate is used in calls to the addHandler and removeHandler action parameters. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The observable sequence that contains data representations of invocations of the underlying .NET event. + + or or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEventPattern, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts a .NET event, conforming to the standard .NET event pattern based on , to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Query provider used to construct the data source. + The delegate type of the event to be converted. + The type of the event data generated by the event. + A function used to convert the given event handler to a delegate compatible with the underlying .NET event. The resulting delegate is used in calls to the addHandler and removeHandler action parameters. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains data representations of invocations of the underlying .NET event. + + or or or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts a .NET event, conforming to the standard .NET event pattern based on a supplied event delegate type with a strongly typed sender parameter, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Query provider used to construct the data source. + The delegate type of the event to be converted. + The type of the sender that raises the event. + The type of the event data generated by the event. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The observable sequence that contains data representations of invocations of the underlying .NET event. + + or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEventPattern, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts a .NET event, conforming to the standard .NET event pattern based on a supplied event delegate type with a strongly typed sender parameter, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Query provider used to construct the data source. + The delegate type of the event to be converted. + The type of the sender that raises the event. + The type of the event data generated by the event. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains data representations of invocations of the underlying .NET event. + + or or is null. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts a .NET event, conforming to the standard .NET event pattern based on , to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Query provider used to construct the data source. + The type of the event data generated by the event. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The observable sequence that contains data representations of invocations of the underlying .NET event. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEventPattern, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts a .NET event, conforming to the standard .NET event pattern based on , to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Query provider used to construct the data source. + The type of the event data generated by the event. + Action that attaches the given event handler to the underlying .NET event. + Action that detaches the given event handler from the underlying .NET event. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains data representations of invocations of the underlying .NET event. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts an instance .NET event, conforming to the standard .NET event pattern with strongly typed event arguments, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + Reflection is used to discover the event based on the target object type and the specified event name. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Query provider used to construct the data source. + The type of the event data generated by the event. + Object instance that exposes the event to convert. + Name of the event to convert. + The observable sequence that contains data representations of invocations of the underlying .NET event. + + or is null. + The event could not be found. -or- The event does not conform to the standard .NET event pattern. -or- The event's second argument type is not assignable to TEventArgs. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEventPattern, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts an instance .NET event, conforming to the standard .NET event pattern with strongly typed event arguments, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + Reflection is used to discover the event based on the target object type and the specified event name. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Query provider used to construct the data source. + The type of the event data generated by the event. + Object instance that exposes the event to convert. + Name of the event to convert. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains data representations of invocations of the underlying .NET event. + + or or is null. + The event could not be found. -or- The event does not conform to the standard .NET event pattern. -or- The event's second argument type is not assignable to TEventArgs. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts a static .NET event, conforming to the standard .NET event pattern with strongly typed event arguments, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + Reflection is used to discover the event based on the specified type and the specified event name. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Query provider used to construct the data source. + The type of the event data generated by the event. + Type that exposes the static event to convert. + Name of the event to convert. + The observable sequence that contains data representations of invocations of the underlying .NET event. + + or is null. + The event could not be found. -or- The event does not conform to the standard .NET event pattern. -or- The event's second argument type is not assignable to TEventArgs. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEventPattern, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts a static .NET event, conforming to the standard .NET event pattern with strongly typed event arguments, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + Reflection is used to discover the event based on the specified type and the specified event name. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Query provider used to construct the data source. + The type of the event data generated by the event. + Type that exposes the static event to convert. + Name of the event to convert. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains data representations of invocations of the underlying .NET event. + + or or is null. + The event could not be found. -or- The event does not conform to the standard .NET event pattern. -or- The event's second argument type is not assignable to TEventArgs. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts an instance .NET event, conforming to the standard .NET event pattern with a strongly typed sender and strongly typed event arguments, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + Reflection is used to discover the event based on the target object type and the specified event name. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Query provider used to construct the data source. + The type of the sender that raises the event. + The type of the event data generated by the event. + Object instance that exposes the event to convert. + Name of the event to convert. + The observable sequence that contains data representations of invocations of the underlying .NET event. + + or is null. + The event could not be found. -or- The event does not conform to the standard .NET event pattern. -or- The event's first argument type is not assignable to TSender. -or- The event's second argument type is not assignable to TEventArgs. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEventPattern, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts an instance .NET event, conforming to the standard .NET event pattern with a strongly typed sender and strongly typed event arguments, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + Reflection is used to discover the event based on the target object type and the specified event name. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Query provider used to construct the data source. + The type of the sender that raises the event. + The type of the event data generated by the event. + Object instance that exposes the event to convert. + Name of the event to convert. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains data representations of invocations of the underlying .NET event. + + or or is null. + The event could not be found. -or- The event does not conform to the standard .NET event pattern. -or- The event's first argument type is not assignable to TSender. -or- The event's second argument type is not assignable to TEventArgs. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Converts a static .NET event, conforming to the standard .NET event pattern with a strongly typed sender and strongly typed event arguments, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + Reflection is used to discover the event based on the specified type and the specified event name. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Query provider used to construct the data source. + The type of the sender that raises the event. + The type of the event data generated by the event. + Type that exposes the static event to convert. + Name of the event to convert. + The observable sequence that contains data representations of invocations of the underlying .NET event. + + or is null. + The event could not be found. -or- The event does not conform to the standard .NET event pattern. -or- The event's first argument type is not assignable to TSender. -or- The event's second argument type is not assignable to TEventArgs. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + The current is captured during the call to FromEventPattern, and is used to post add and remove handler invocations. + This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks. + + + If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread + making the Subscribe or Dispose call, respectively. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so + makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions + more concise and easier to understand. + + + + + + + Converts a static .NET event, conforming to the standard .NET event pattern with a strongly typed sender and strongly typed event arguments, to an observable sequence. + Each event invocation is surfaced through an OnNext message in the resulting sequence. + Reflection is used to discover the event based on the specified type and the specified event name. + For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead. + + Query provider used to construct the data source. + The type of the sender that raises the event. + The type of the event data generated by the event. + Type that exposes the static event to convert. + Name of the event to convert. + The scheduler to run the add and remove event handler logic on. + The observable sequence that contains data representations of invocations of the underlying .NET event. + + or or is null. + The event could not be found. -or- The event does not conform to the standard .NET event pattern. -or- The event's first argument type is not assignable to TSender. -or- The event's second argument type is not assignable to TEventArgs. + + + Add and remove handler invocations are made whenever the number of observers grows beyond zero. + As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting. + + + Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be + accessed from the same context, as required by some UI frameworks. + + + It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries, + making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler + parameter. For more information, see the remarks section on those overloads. + + + + + + + Generates an observable sequence by running a state-driven loop producing the sequence's elements. + + Query provider used to construct the data source. + The type of the state used in the generator loop. + The type of the elements in the produced sequence. + Initial state. + Condition to terminate generation (upon returning false). + Iteration step function. + Selector function for results produced in the sequence. + The generated sequence. + + or or is null. + + + + Generates an observable sequence by running a state-driven loop producing the sequence's elements, using the specified scheduler to send out observer messages. + + Query provider used to construct the data source. + The type of the state used in the generator loop. + The type of the elements in the produced sequence. + Initial state. + Condition to terminate generation (upon returning false). + Iteration step function. + Selector function for results produced in the sequence. + Scheduler on which to run the generator loop. + The generated sequence. + + or or or is null. + + + + Generates an observable sequence by running a state-driven and temporal loop producing the sequence's elements. + + Query provider used to construct the data source. + The type of the state used in the generator loop. + The type of the elements in the produced sequence. + Initial state. + Condition to terminate generation (upon returning false). + Iteration step function. + Selector function for results produced in the sequence. + Time selector function to control the speed of values being produced each iteration. + The generated sequence. + + or or or is null. + + + + Generates an observable sequence by running a state-driven and temporal loop producing the sequence's elements. + + Query provider used to construct the data source. + The type of the state used in the generator loop. + The type of the elements in the produced sequence. + Initial state. + Condition to terminate generation (upon returning false). + Iteration step function. + Selector function for results produced in the sequence. + Time selector function to control the speed of values being produced each iteration. + The generated sequence. + + or or or is null. + + + + Generates an observable sequence by running a state-driven and temporal loop producing the sequence's elements, using the specified scheduler to run timers and to send out observer messages. + + Query provider used to construct the data source. + The type of the state used in the generator loop. + The type of the elements in the produced sequence. + Initial state. + Condition to terminate generation (upon returning false). + Iteration step function. + Selector function for results produced in the sequence. + Time selector function to control the speed of values being produced each iteration. + Scheduler on which to run the generator loop. + The generated sequence. + + or or or or is null. + + + + Generates an observable sequence by running a state-driven and temporal loop producing the sequence's elements, using the specified scheduler to run timers and to send out observer messages. + + Query provider used to construct the data source. + The type of the state used in the generator loop. + The type of the elements in the produced sequence. + Initial state. + Condition to terminate generation (upon returning false). + Iteration step function. + Selector function for results produced in the sequence. + Time selector function to control the speed of values being produced each iteration. + Scheduler on which to run the generator loop. + The generated sequence. + + or or or or is null. + + + + Groups the elements of an observable sequence according to a specified key selector function. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + An observable sequence whose elements to group. + A function to extract the key for each element. + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + + or is null. + + + + Groups the elements of an observable sequence with the specified initial capacity according to a specified key selector function. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + An observable sequence whose elements to group. + A function to extract the key for each element. + The initial number of elements that the underlying dictionary can contain. + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + + or is null. + + is less than 0. + + + + Groups the elements of an observable sequence with the specified initial capacity according to a specified key selector function and comparer. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + An observable sequence whose elements to group. + A function to extract the key for each element. + The initial number of elements that the underlying dictionary can contain. + An equality comparer to compare keys with. + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + + or or is null. + + is less than 0. + + + + Groups the elements of an observable sequence according to a specified key selector function and comparer. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + An observable sequence whose elements to group. + A function to extract the key for each element. + An equality comparer to compare keys with. + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + + or or is null. + + + + Groups the elements of an observable sequence and selects the resulting elements by using a specified function. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + The type of the elements within the groups computed for each element in the source sequence. + An observable sequence whose elements to group. + A function to extract the key for each element. + A function to map each source element to an element in an observable group. + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + + or or is null. + + + + Groups the elements of an observable sequence with the specified initial capacity and selects the resulting elements by using a specified function. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + The type of the elements within the groups computed for each element in the source sequence. + An observable sequence whose elements to group. + A function to extract the key for each element. + A function to map each source element to an element in an observable group. + The initial number of elements that the underlying dictionary can contain. + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + + or or is null. + + is less than 0. + + + + Groups the elements of an observable sequence with the specified initial capacity according to a specified key selector function and comparer and selects the resulting elements by using a specified function. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + The type of the elements within the groups computed for each element in the source sequence. + An observable sequence whose elements to group. + A function to extract the key for each element. + A function to map each source element to an element in an observable group. + The initial number of elements that the underlying dictionary can contain. + An equality comparer to compare keys with. + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + + or or or is null. + + is less than 0. + + + + Groups the elements of an observable sequence according to a specified key selector function and comparer and selects the resulting elements by using a specified function. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + The type of the elements within the groups computed for each element in the source sequence. + An observable sequence whose elements to group. + A function to extract the key for each element. + A function to map each source element to an element in an observable group. + An equality comparer to compare keys with. + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + + or or or is null. + + + + Groups the elements of an observable sequence according to a specified key selector function. + A duration selector function is used to control the lifetime of groups. When a group expires, it receives an OnCompleted notification. When a new element with the same + key value as a reclaimed group occurs, the group will be reborn with a new lifetime request. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + The type of the elements in the duration sequences obtained for each group to denote its lifetime. + An observable sequence whose elements to group. + A function to extract the key for each element. + A function to signal the expiration of a group. + + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + If a group's lifetime expires, a new group with the same key value can be created once an element with such a key value is encountered. + + + or or is null. + + + + Groups the elements of an observable sequence with the specified initial capacity according to a specified key selector function. + A duration selector function is used to control the lifetime of groups. When a group expires, it receives an OnCompleted notification. When a new element with the same + key value as a reclaimed group occurs, the group will be reborn with a new lifetime request. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + The type of the elements in the duration sequences obtained for each group to denote its lifetime. + An observable sequence whose elements to group. + A function to extract the key for each element. + A function to signal the expiration of a group. + The initial number of elements that the underlying dictionary can contain. + + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + If a group's lifetime expires, a new group with the same key value can be created once an element with such a key value is encountered. + + + or or is null. + + is less than 0. + + + + Groups the elements of an observable sequence with the specified initial capacity according to a specified key selector function and comparer. + A duration selector function is used to control the lifetime of groups. When a group expires, it receives an OnCompleted notification. When a new element with the same + key value as a reclaimed group occurs, the group will be reborn with a new lifetime request. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + The type of the elements in the duration sequences obtained for each group to denote its lifetime. + An observable sequence whose elements to group. + A function to extract the key for each element. + A function to signal the expiration of a group. + The initial number of elements that the underlying dictionary can contain. + An equality comparer to compare keys with. + + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + If a group's lifetime expires, a new group with the same key value can be created once an element with such a key value is encountered. + + + or or or is null. + + is less than 0. + + + + Groups the elements of an observable sequence according to a specified key selector function and comparer. + A duration selector function is used to control the lifetime of groups. When a group expires, it receives an OnCompleted notification. When a new element with the same + key value as a reclaimed group occurs, the group will be reborn with a new lifetime request. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + The type of the elements in the duration sequences obtained for each group to denote its lifetime. + An observable sequence whose elements to group. + A function to extract the key for each element. + A function to signal the expiration of a group. + An equality comparer to compare keys with. + + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + If a group's lifetime expires, a new group with the same key value can be created once an element with such a key value is encountered. + + + or or or is null. + + + + Groups the elements of an observable sequence according to a specified key selector function and selects the resulting elements by using a specified function. + A duration selector function is used to control the lifetime of groups. When a group expires, it receives an OnCompleted notification. When a new element with the same + key value as a reclaimed group occurs, the group will be reborn with a new lifetime request. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + The type of the elements within the groups computed for each element in the source sequence. + The type of the elements in the duration sequences obtained for each group to denote its lifetime. + An observable sequence whose elements to group. + A function to extract the key for each element. + A function to map each source element to an element in an observable group. + A function to signal the expiration of a group. + + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + If a group's lifetime expires, a new group with the same key value can be created once an element with such a key value is encountered. + + + or or or is null. + + + + Groups the elements of an observable sequence with the specified initial capacity according to a specified key selector function and selects the resulting elements by using a specified function. + A duration selector function is used to control the lifetime of groups. When a group expires, it receives an OnCompleted notification. When a new element with the same + key value as a reclaimed group occurs, the group will be reborn with a new lifetime request. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + The type of the elements within the groups computed for each element in the source sequence. + The type of the elements in the duration sequences obtained for each group to denote its lifetime. + An observable sequence whose elements to group. + A function to extract the key for each element. + A function to map each source element to an element in an observable group. + A function to signal the expiration of a group. + The initial number of elements that the underlying dictionary can contain. + + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + If a group's lifetime expires, a new group with the same key value can be created once an element with such a key value is encountered. + + + or or or is null. + + is less than 0. + + + + Groups the elements of an observable sequence with the specified initial capacity according to a specified key selector function and comparer and selects the resulting elements by using a specified function. + A duration selector function is used to control the lifetime of groups. When a group expires, it receives an OnCompleted notification. When a new element with the same + key value as a reclaimed group occurs, the group will be reborn with a new lifetime request. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + The type of the elements within the groups computed for each element in the source sequence. + The type of the elements in the duration sequences obtained for each group to denote its lifetime. + An observable sequence whose elements to group. + A function to extract the key for each element. + A function to map each source element to an element in an observable group. + A function to signal the expiration of a group. + The initial number of elements that the underlying dictionary can contain. + An equality comparer to compare keys with. + + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + If a group's lifetime expires, a new group with the same key value can be created once an element with such a key value is encountered. + + + or or or or is null. + + is less than 0. + + + + Groups the elements of an observable sequence according to a specified key selector function and comparer and selects the resulting elements by using a specified function. + A duration selector function is used to control the lifetime of groups. When a group expires, it receives an OnCompleted notification. When a new element with the same + key value as a reclaimed group occurs, the group will be reborn with a new lifetime request. + + The type of the elements in the source sequence. + The type of the grouping key computed for each element in the source sequence. + The type of the elements within the groups computed for each element in the source sequence. + The type of the elements in the duration sequences obtained for each group to denote its lifetime. + An observable sequence whose elements to group. + A function to extract the key for each element. + A function to map each source element to an element in an observable group. + A function to signal the expiration of a group. + An equality comparer to compare keys with. + + A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value. + If a group's lifetime expires, a new group with the same key value can be created once an element with such a key value is encountered. + + + or or or or is null. + + + + Correlates the elements of two sequences based on overlapping durations, and groups the results. + + The type of the elements in the left source sequence. + The type of the elements in the right source sequence. + The type of the elements in the duration sequence denoting the computed duration of each element in the left source sequence. + The type of the elements in the duration sequence denoting the computed duration of each element in the right source sequence. + The type of the elements in the result sequence, obtained by invoking the result selector function for source elements with overlapping duration. + The left observable sequence to join elements for. + The right observable sequence to join elements for. + A function to select the duration of each element of the left observable sequence, used to determine overlap. + A function to select the duration of each element of the right observable sequence, used to determine overlap. + A function invoked to compute a result element for any element of the left sequence with overlapping elements from the right observable sequence. + An observable sequence that contains result elements computed from source elements that have an overlapping duration. + + or or or or is null. + + + + If the specified evaluates true, select the sequence. Otherwise, return an empty sequence. + + Query provider used to construct the data source. + The type of the elements in the result sequence. + Condition evaluated to decide which sequence to return. + Sequence returned in case evaluates true. + + if evaluates true; an empty sequence otherwise. + + or is null. + + + + If the specified evaluates true, select the sequence. Otherwise, select the sequence. + + Query provider used to construct the data source. + The type of the elements in the result sequence. + Condition evaluated to decide which sequence to return. + Sequence returned in case evaluates true. + Sequence returned in case evaluates false. + + if evaluates true; otherwise. + + or or is null. + + + + If the specified evaluates true, select the sequence. Otherwise, return an empty sequence generated on the specified scheduler. + + Query provider used to construct the data source. + The type of the elements in the result sequence. + Condition evaluated to decide which sequence to return. + Sequence returned in case evaluates true. + Scheduler to generate an empty sequence on in case evaluates false. + + if evaluates true; an empty sequence otherwise. + + or or is null. + + + + Ignores all elements in an observable sequence leaving only the termination messages. + + The type of the elements in the source sequence. + Source sequence. + An empty observable sequence that signals termination, successful or exceptional, of the source sequence. + + is null. + + + + Returns an observable sequence that produces a value after each period. + + Query provider used to construct the data source. + Period for producing the values in the resulting sequence. If this value is equal to TimeSpan.Zero, the timer will recur as fast as possible. + An observable sequence that produces a value after each period. + + is less than TimeSpan.Zero. + + Intervals are measured between the start of subsequent notifications, not between the end of the previous and the start of the next notification. + If the observer takes longer than the interval period to handle the message, the subsequent notification will be delivered immediately after the + current one has been handled. In case you need to control the time between the end and the start of consecutive notifications, consider using the + + operator instead. + + + + + Returns an observable sequence that produces a value after each period, using the specified scheduler to run timers and to send out observer messages. + + Query provider used to construct the data source. + Period for producing the values in the resulting sequence. If this value is equal to TimeSpan.Zero, the timer will recur as fast as possible. + Scheduler to run the timer on. + An observable sequence that produces a value after each period. + + is less than TimeSpan.Zero. + + is null. + + Intervals are measured between the start of subsequent notifications, not between the end of the previous and the start of the next notification. + If the observer takes longer than the interval period to handle the message, the subsequent notification will be delivered immediately after the + current one has been handled. In case you need to control the time between the end and the start of consecutive notifications, consider using the + + operator instead. + + + + + Determines whether an observable sequence is empty. + + The type of the elements in the source sequence. + An observable sequence to check for emptiness. + An observable sequence containing a single element determining whether the source sequence is empty. + + is null. + + + + Correlates the elements of two sequences based on overlapping durations. + + The type of the elements in the left source sequence. + The type of the elements in the right source sequence. + The type of the elements in the duration sequence denoting the computed duration of each element in the left source sequence. + The type of the elements in the duration sequence denoting the computed duration of each element in the right source sequence. + The type of the elements in the result sequence, obtained by invoking the result selector function for source elements with overlapping duration. + The left observable sequence to join elements for. + The right observable sequence to join elements for. + A function to select the duration of each element of the left observable sequence, used to determine overlap. + A function to select the duration of each element of the right observable sequence, used to determine overlap. + A function invoked to compute a result element for any two overlapping elements of the left and right observable sequences. + An observable sequence that contains result elements computed from source elements that have an overlapping duration. + + or or or or is null. + + + + Returns the last element of an observable sequence. + + The type of the elements in the source sequence. + Source observable sequence. + Sequence containing the last element in the observable sequence. + + is null. + (Asynchronous) The source sequence is empty. + + + + Returns the last element of an observable sequence that satisfies the condition in the predicate. + + The type of the elements in the source sequence. + Source observable sequence. + A predicate function to evaluate for elements in the source sequence. + Sequence containing the last element in the observable sequence that satisfies the condition in the predicate. + + or is null. + (Asynchronous) No element satisfies the condition in the predicate. -or- The source sequence is empty. + + + + Returns the last element of an observable sequence, or a default value if no such element exists. + + The type of the elements in the source sequence. + Source observable sequence. + Sequence containing the last element in the observable sequence, or a default value if no such element exists. + + is null. + + + + Returns the last element of an observable sequence that satisfies the condition in the predicate, or a default value if no such element exists. + + The type of the elements in the source sequence. + Source observable sequence. + A predicate function to evaluate for elements in the source sequence. + Sequence containing the last element in the observable sequence that satisfies the condition in the predicate, or a default value if no such element exists. + + or is null. + + + + Returns an enumerable sequence whose enumeration returns the latest observed element in the source observable sequence. + Enumerators on the resulting sequence will never produce the same element repeatedly, and will block until the next element becomes available. + + The type of the elements in the source sequence. + Source observable sequence. + The enumerable sequence that returns the last sampled element upon each iteration and subsequently blocks until the next element in the observable source sequence becomes available. + This operator requires the source's object (see ) to implement . + + + + Returns an observable sequence containing an that represents the total number of elements in an observable sequence. + + The type of the elements in the source sequence. + An observable sequence that contains elements to be counted. + An observable sequence containing a single element with the number of elements in the input sequence. + + is null. + (Asynchronous) The number of elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns an observable sequence containing an that represents how many elements in the specified observable sequence satisfy a condition. + + The type of the elements in the source sequence. + An observable sequence that contains elements to be counted. + A function to test each element for a condition. + An observable sequence containing a single element with a number that represents how many elements in the input sequence satisfy the condition in the predicate function. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Materializes the implicit notifications of an observable sequence as explicit notification values. + + The type of the elements in the source sequence. + An observable sequence to get notification values for. + An observable sequence containing the materialized notification values from the source sequence. + + is null. + + + + Returns the maximum value in an observable sequence of values. + + A sequence of values to determine the maximum value of. + An observable sequence containing a single element with the maximum value in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the maximum value in an observable sequence of values. + + A sequence of values to determine the maximum value of. + An observable sequence containing a single element with the maximum value in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the maximum value in an observable sequence of values. + + A sequence of values to determine the maximum value of. + An observable sequence containing a single element with the maximum value in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the maximum value in an observable sequence of values. + + A sequence of values to determine the maximum value of. + An observable sequence containing a single element with the maximum value in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the maximum value in an observable sequence of nullable values. + + A sequence of nullable values to determine the maximum value of. + An observable sequence containing a single element with the maximum value in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the maximum value in an observable sequence of nullable values. + + A sequence of nullable values to determine the maximum value of. + An observable sequence containing a single element with the maximum value in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the maximum value in an observable sequence of nullable values. + + A sequence of nullable values to determine the maximum value of. + An observable sequence containing a single element with the maximum value in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the maximum value in an observable sequence of nullable values. + + A sequence of nullable values to determine the maximum value of. + An observable sequence containing a single element with the maximum value in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the maximum value in an observable sequence of nullable values. + + A sequence of nullable values to determine the maximum value of. + An observable sequence containing a single element with the maximum value in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the maximum value in an observable sequence of values. + + A sequence of values to determine the maximum value of. + An observable sequence containing a single element with the maximum value in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the maximum element in an observable sequence. + + The type of the elements in the source sequence. + An observable sequence to determine the maximum element of. + An observable sequence containing a single element with the maximum element in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the maximum value in an observable sequence according to the specified comparer. + + The type of the elements in the source sequence. + An observable sequence to determine the maximum element of. + Comparer used to compare elements. + An observable sequence containing a single element with the maximum element in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the maximum value. + + The type of the elements in the source sequence. + A sequence of values to determine the maximum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the maximum value in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the maximum value. + + The type of the elements in the source sequence. + A sequence of values to determine the maximum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the maximum value in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the maximum value. + + The type of the elements in the source sequence. + A sequence of values to determine the maximum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the maximum value in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the maximum value. + + The type of the elements in the source sequence. + A sequence of values to determine the maximum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the maximum value in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the maximum value. + + The type of the elements in the source sequence. + A sequence of values to determine the maximum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the maximum value in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the maximum nullable value. + + The type of the elements in the source sequence. + A sequence of values to determine the maximum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the maximum value in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the maximum nullable value. + + The type of the elements in the source sequence. + A sequence of values to determine the maximum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the maximum value in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the maximum nullable value. + + The type of the elements in the source sequence. + A sequence of values to determine the maximum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the maximum value in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the maximum nullable value. + + The type of the elements in the source sequence. + A sequence of values to determine the maximum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the maximum value in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the maximum nullable value. + + The type of the elements in the source sequence. + A sequence of values to determine the maximum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the maximum value in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the maximum value. + + The type of the elements in the source sequence. + The type of the objects derived from the elements in the source sequence to determine the maximum of. + An observable sequence to determine the minimum element of. + A transform function to apply to each element. + An observable sequence containing a single element with the value that corresponds to the maximum element in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the maximum value according to the specified comparer. + + The type of the elements in the source sequence. + The type of the objects derived from the elements in the source sequence to determine the maximum of. + An observable sequence to determine the minimum element of. + A transform function to apply to each element. + Comparer used to compare elements. + An observable sequence containing a single element with the value that corresponds to the maximum element in the source sequence. + + or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the elements in an observable sequence with the maximum key value. + + The type of the elements in the source sequence. + The type of the key computed for each element in the source sequence. + An observable sequence to get the maximum elements for. + Key selector function. + An observable sequence containing a list of zero or more elements that have a maximum key value. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the elements in an observable sequence with the maximum key value according to the specified comparer. + + The type of the elements in the source sequence. + The type of the key computed for each element in the source sequence. + An observable sequence to get the maximum elements for. + Key selector function. + Comparer used to compare key values. + An observable sequence containing a list of zero or more elements that have a maximum key value. + + or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Merges elements from two observable sequences into a single observable sequence. + + The type of the elements in the source sequences. + First observable sequence. + Second observable sequence. + The observable sequence that merges the elements of the given sequences. + + or is null. + + + + Merges elements from two observable sequences into a single observable sequence, using the specified scheduler for enumeration of and subscription to the sources. + + The type of the elements in the source sequences. + First observable sequence. + Second observable sequence. + Scheduler used to introduce concurrency for making subscriptions to the given sequences. + The observable sequence that merges the elements of the given sequences. + + or or is null. + + + + Merges elements from all of the specified observable sequences into a single observable sequence, using the specified scheduler for enumeration of and subscription to the sources. + + Query provider used to construct the data source. + The type of the elements in the source sequences. + Observable sequences. + Scheduler to run the enumeration of the sequence of sources on. + The observable sequence that merges the elements of the observable sequences. + + or is null. + + + + Merges elements from all inner observable sequences into a single observable sequence. + + The type of the elements in the source sequences. + Observable sequence of inner observable sequences. + The observable sequence that merges the elements of the inner sequences. + + is null. + + + + Merges results from all source tasks into a single observable sequence. + + The type of the results produced by the source tasks. + Observable sequence of tasks. + The observable sequence that merges the results of the source tasks. + + is null. + If the tasks support cancellation, consider manual conversion of the tasks using , followed by a merge operation using . + + + + Merges elements from all of the specified observable sequences into a single observable sequence. + + Query provider used to construct the data source. + The type of the elements in the source sequences. + Observable sequences. + The observable sequence that merges the elements of the observable sequences. + + is null. + + + + Merges elements from all observable sequences in the given enumerable sequence into a single observable sequence. + + Query provider used to construct the data source. + The type of the elements in the source sequences. + Enumerable sequence of observable sequences. + The observable sequence that merges the elements of the observable sequences. + + is null. + + + + Merges elements from all inner observable sequences into a single observable sequence, limiting the number of concurrent subscriptions to inner sequences. + + The type of the elements in the source sequences. + Observable sequence of inner observable sequences. + Maximum number of inner observable sequences being subscribed to concurrently. + The observable sequence that merges the elements of the inner sequences. + + is null. + + is less than or equal to zero. + + + + Merges elements from all observable sequences in the given enumerable sequence into a single observable sequence, limiting the number of concurrent subscriptions to inner sequences. + + Query provider used to construct the data source. + The type of the elements in the source sequences. + Enumerable sequence of observable sequences. + Maximum number of observable sequences being subscribed to concurrently. + The observable sequence that merges the elements of the observable sequences. + + is null. + + is less than or equal to zero. + + + + Merges elements from all observable sequences in the given enumerable sequence into a single observable sequence, limiting the number of concurrent subscriptions to inner sequences, and using the specified scheduler for enumeration of and subscription to the sources. + + Query provider used to construct the data source. + The type of the elements in the source sequences. + Enumerable sequence of observable sequences. + Maximum number of observable sequences being subscribed to concurrently. + Scheduler to run the enumeration of the sequence of sources on. + The observable sequence that merges the elements of the observable sequences. + + or is null. + + is less than or equal to zero. + + + + Merges elements from all observable sequences in the given enumerable sequence into a single observable sequence, using the specified scheduler for enumeration of and subscription to the sources. + + Query provider used to construct the data source. + The type of the elements in the source sequences. + Enumerable sequence of observable sequences. + Scheduler to run the enumeration of the sequence of sources on. + The observable sequence that merges the elements of the observable sequences. + + or is null. + + + + Returns the minimum value in an observable sequence of values. + + A sequence of values to determine the minimum value of. + An observable sequence containing a single element with the minimum value in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the minimum value in an observable sequence of values. + + A sequence of values to determine the minimum value of. + An observable sequence containing a single element with the minimum value in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the minimum value in an observable sequence of values. + + A sequence of values to determine the minimum value of. + An observable sequence containing a single element with the minimum value in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the minimum value in an observable sequence of values. + + A sequence of values to determine the minimum value of. + An observable sequence containing a single element with the minimum value in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the minimum value in an observable sequence of nullable values. + + A sequence of nullable values to determine the minimum value of. + An observable sequence containing a single element with the minimum value in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the minimum value in an observable sequence of nullable values. + + A sequence of nullable values to determine the minimum value of. + An observable sequence containing a single element with the minimum value in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the minimum value in an observable sequence of nullable values. + + A sequence of nullable values to determine the minimum value of. + An observable sequence containing a single element with the minimum value in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the minimum value in an observable sequence of nullable values. + + A sequence of nullable values to determine the minimum value of. + An observable sequence containing a single element with the minimum value in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the minimum value in an observable sequence of nullable values. + + A sequence of nullable values to determine the minimum value of. + An observable sequence containing a single element with the minimum value in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the minimum value in an observable sequence of values. + + A sequence of values to determine the minimum value of. + An observable sequence containing a single element with the minimum value in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the minimum element in an observable sequence. + + The type of the elements in the source sequence. + An observable sequence to determine the minimum element of. + An observable sequence containing a single element with the minimum element in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the minimum element in an observable sequence according to the specified comparer. + + The type of the elements in the source sequence. + An observable sequence to determine the minimum element of. + Comparer used to compare elements. + An observable sequence containing a single element with the minimum element in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the minimum value. + + The type of the elements in the source sequence. + A sequence of values to determine the minimum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the minimum value in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the minimum value. + + The type of the elements in the source sequence. + A sequence of values to determine the minimum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the minimum value in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the minimum value. + + The type of the elements in the source sequence. + A sequence of values to determine the minimum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the minimum value in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the minimum value. + + The type of the elements in the source sequence. + A sequence of values to determine the minimum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the minimum value in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the minimum value. + + The type of the elements in the source sequence. + A sequence of values to determine the minimum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the minimum value in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the minimum nullable value. + + The type of the elements in the source sequence. + A sequence of values to determine the minimum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the minimum value in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the minimum nullable value. + + The type of the elements in the source sequence. + A sequence of values to determine the minimum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the minimum value in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the minimum nullable value. + + The type of the elements in the source sequence. + A sequence of values to determine the minimum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the minimum value in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the minimum nullable value. + + The type of the elements in the source sequence. + A sequence of values to determine the minimum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the minimum value in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the minimum nullable value. + + The type of the elements in the source sequence. + A sequence of values to determine the minimum value of. + A transform function to apply to each element. + An observable sequence containing a single element with the value of type that corresponds to the minimum value in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the minimum value. + + The type of the elements in the source sequence. + The type of the objects derived from the elements in the source sequence to determine the minimum of. + An observable sequence to determine the minimum element of. + A transform function to apply to each element. + An observable sequence containing a single element with the value that corresponds to the minimum element in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Invokes a transform function on each element of a sequence and returns the minimum value according to the specified comparer. + + The type of the elements in the source sequence. + The type of the objects derived from the elements in the source sequence to determine the minimum of. + An observable sequence to determine the minimum element of. + A transform function to apply to each element. + Comparer used to compare elements. + An observable sequence containing a single element with the value that corresponds to the minimum element in the source sequence. + + or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the elements in an observable sequence with the minimum key value. + + The type of the elements in the source sequence. + The type of the key computed for each element in the source sequence. + An observable sequence to get the minimum elements for. + Key selector function. + An observable sequence containing a list of zero or more elements that have a minimum key value. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the elements in an observable sequence with the minimum key value according to the specified comparer. + + The type of the elements in the source sequence. + The type of the key computed for each element in the source sequence. + An observable sequence to get the minimum elements for. + Key selector function. + Comparer used to compare key values. + An observable sequence containing a list of zero or more elements that have a minimum key value. + + or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns an enumerable sequence whose enumeration returns the most recently observed element in the source observable sequence, using the specified initial value in case no element has been sampled yet. + Enumerators on the resulting sequence never block and can produce the same element repeatedly. + + The type of the elements in the source sequence. + Source observable sequence. + Initial value that will be yielded by the enumerable sequence if no element has been sampled yet. + The enumerable sequence that returns the last sampled element upon each iteration. + + is null. + This operator requires the source's object (see ) to implement . + + + + Multicasts the source sequence notifications through an instantiated subject into all uses of the sequence within a selector function. Each + subscription to the resulting sequence causes a separate multicast invocation, exposing the sequence resulting from the selector function's + invocation. For specializations with fixed subject types, see Publish, PublishLast, and Replay. + + The type of the elements in the source sequence. + The type of the elements produced by the intermediate subject. + The type of the elements in the result sequence. + Source sequence which will be multicasted in the specified selector function. + Factory function to create an intermediate subject through which the source sequence's elements will be multicast to the selector function. + Selector function which can use the multicasted source sequence subject to the policies enforced by the created subject. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + + or or is null. + + + + Returns a non-terminating observable sequence, which can be used to denote an infinite duration (e.g. when using reactive joins). + + Query provider used to construct the data source. + The type used for the type parameter of the resulting sequence. + An observable sequence whose observers will never get called. + + + + Returns a non-terminating observable sequence, which can be used to denote an infinite duration (e.g. when using reactive joins). + + Query provider used to construct the data source. + The type used for the type parameter of the resulting sequence. + Object solely used to infer the type of the type parameter. This parameter is typically used when creating a sequence of anonymously typed elements. + An observable sequence whose observers will never get called. + + + + Returns an enumerable sequence whose enumeration blocks until the next element in the source observable sequence becomes available. + Enumerators on the resulting sequence will block until the next element becomes available. + + The type of the elements in the source sequence. + Source observable sequence. + The enumerable sequence that blocks upon each iteration until the next element in the observable source sequence becomes available. + + is null. + This operator requires the source's object (see ) to implement . + + + + Wraps the source sequence in order to run its observer callbacks on the specified synchronization context. + + The type of the elements in the source sequence. + Source sequence. + Synchronization context to notify observers on. + The source sequence whose observations happen on the specified synchronization context. + + or is null. + + This only invokes observer callbacks on a synchronization context. In case the subscription and/or unsubscription actions have side-effects + that require to be run on a synchronization context, use . + + + + + Wraps the source sequence in order to run its observer callbacks on the specified scheduler. + + The type of the elements in the source sequence. + Source sequence. + Scheduler to notify observers on. + The source sequence whose observations happen on the specified scheduler. + + or is null. + + This only invokes observer callbacks on a scheduler. In case the subscription and/or unsubscription actions have side-effects + that require to be run on a scheduler, use . + + + + + Filters the elements of an observable sequence based on the specified type. + + The type to filter the elements in the source sequence on. + The observable sequence that contains the elements to be filtered. + An observable sequence that contains elements from the input sequence of type TResult. + + is null. + + + + Concatenates the second observable sequence to the first observable sequence upon successful or exceptional termination of the first. + + The type of the elements in the source sequences. + First observable sequence whose exception (if any) is caught. + Second observable sequence used to produce results after the first sequence terminates. + An observable sequence that concatenates the first and second sequence, even if the first sequence terminates exceptionally. + + or is null. + + + + Concatenates all of the specified observable sequences, even if the previous observable sequence terminated exceptionally. + + Query provider used to construct the data source. + The type of the elements in the source sequences. + Observable sequences to concatenate. + An observable sequence that concatenates the source sequences, even if a sequence terminates exceptionally. + + is null. + + + + Concatenates all observable sequences in the given enumerable sequence, even if the previous observable sequence terminated exceptionally. + + Query provider used to construct the data source. + The type of the elements in the source sequences. + Observable sequences to concatenate. + An observable sequence that concatenates the source sequences, even if a sequence terminates exceptionally. + + is null. + + + + Prepend a value to an observable sequence. + + The type of the elements in the source sequence. + Source sequence to prepend the value to. + Value to prepend to the specified sequence. + The source sequence prepended with the specified value. + + is null. + + + + Prepend a value to an observable sequence. + + The type of the elements in the source sequence. + Source sequence to prepend the value to. + Value to prepend to the specified sequence. + Scheduler to emit the prepend values on. + The source sequence prepended with the specified value. + + is null. + + + + Returns an observable sequence that is the result of invoking the selector on a connectable observable sequence that shares a single subscription to the underlying sequence. + This operator is a specialization of Multicast using a regular . + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will receive all notifications of the source from the time of the subscription on. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + + or is null. + + + + + Returns an observable sequence that is the result of invoking the selector on a connectable observable sequence that shares a single subscription to the underlying sequence and starts with initialValue. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will receive immediately receive the initial value, followed by all notifications of the source from the time of the subscription on. + Initial value received by observers upon subscription. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + + or is null. + + + + + Returns an observable sequence that is the result of invoking the selector on a connectable observable sequence that shares a single subscription to the underlying sequence containing only the last notification. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will only receive the last notification of the source. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + + or is null. + + + + + Generates an observable sequence of integral numbers within a specified range. + + Query provider used to construct the data source. + The value of the first integer in the sequence. + The number of sequential integers to generate. + An observable sequence that contains a range of sequential integral numbers. + + is less than zero. -or- + - 1 is larger than . + + + + Generates an observable sequence of integral numbers within a specified range, using the specified scheduler to send out observer messages. + + Query provider used to construct the data source. + The value of the first integer in the sequence. + The number of sequential integers to generate. + Scheduler to run the generator loop on. + An observable sequence that contains a range of sequential integral numbers. + + is less than zero. -or- + - 1 is larger than . + + is null. + + + + Returns an observable sequence that stays connected to the source as long as there is at least one subscription to the observable sequence. + + Query provider used to construct the data source. + The type of the elements in the source sequence. + Connectable observable sequence. + An observable sequence that stays connected to the source as long as there is at least one subscription to the observable sequence. + + is null. + + + + Returns an observable sequence that stays connected to the source as long as there is at least one subscription to the observable sequence. + + Query provider used to construct the data source. + The type of the elements in the source sequence. + Connectable observable sequence. + The time span that should be waited before possibly unsubscribing from the connectable observable. + An observable sequence that stays connected to the source as long as there is at least one subscription to the observable sequence. + + is null. + + + + Returns an observable sequence that stays connected to the source as long as there is at least one subscription to the observable sequence. + + Query provider used to construct the data source. + The type of the elements in the source sequence. + Connectable observable sequence. + The time span that should be waited before possibly unsubscribing from the connectable observable. + The scheduler to use for delayed unsubscription. + An observable sequence that stays connected to the source as long as there is at least one subscription to the observable sequence. + + is null. + + + + Generates an observable sequence that repeats the given element infinitely. + + Query provider used to construct the data source. + The type of the element that will be repeated in the produced sequence. + Element to repeat. + An observable sequence that repeats the given element infinitely. + + + + Generates an observable sequence that repeats the given element the specified number of times. + + Query provider used to construct the data source. + The type of the element that will be repeated in the produced sequence. + Element to repeat. + Number of times to repeat the element. + An observable sequence that repeats the given element the specified number of times. + + is less than zero. + + + + Generates an observable sequence that repeats the given element the specified number of times, using the specified scheduler to send out observer messages. + + Query provider used to construct the data source. + The type of the element that will be repeated in the produced sequence. + Element to repeat. + Number of times to repeat the element. + Scheduler to run the producer loop on. + An observable sequence that repeats the given element the specified number of times. + + is less than zero. + + is null. + + + + Generates an observable sequence that repeats the given element infinitely, using the specified scheduler to send out observer messages. + + Query provider used to construct the data source. + The type of the element that will be repeated in the produced sequence. + Element to repeat. + Scheduler to run the producer loop on. + An observable sequence that repeats the given element infinitely. + + is null. + + + + Repeats the observable sequence indefinitely. + + The type of the elements in the source sequence. + Observable sequence to repeat. + The observable sequence producing the elements of the given sequence repeatedly and sequentially. + + is null. + + + + Repeats the observable sequence a specified number of times. + + The type of the elements in the source sequence. + Observable sequence to repeat. + Number of times to repeat the sequence. + The observable sequence producing the elements of the given sequence repeatedly. + + is null. + + is less than zero. + + + + Repeatedly resubscribes to the source observable after a normal completion and when the observable + returned by a handler produces an arbitrary item. + + The type of the elements in the source sequence. + The arbitrary element type signaled by the handler observable. + Observable sequence to keep repeating when it successfully terminates. + The function that is called for each observer and takes an observable sequence objects. + It should return an observable of arbitrary items that should signal that arbitrary item in + response to receiving the completion signal from the source observable. If this observable signals + a terminal event, the sequence is terminated with that signal instead. + An observable sequence producing the elements of the given sequence repeatedly while each repetition terminates successfully. + is null. + is null. + + + + Returns an observable sequence that is the result of invoking the selector on a connectable observable sequence that shares a single subscription to the underlying sequence replaying all notifications. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will receive all the notifications of the source. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + + or is null. + + + + + Returns an observable sequence that is the result of invoking the selector on a connectable observable sequence that shares a single subscription to the underlying sequence replaying notifications subject to a maximum element count for the replay buffer. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will receive all the notifications of the source subject to the specified replay buffer trimming policy. + Maximum element count of the replay buffer. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + + or is null. + + is less than zero. + + + + + Returns an observable sequence that is the result of invoking the selector on a connectable observable sequence that shares a single subscription to the underlying sequence replaying notifications subject to a maximum element count for the replay buffer. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will receive all the notifications of the source subject to the specified replay buffer trimming policy. + Maximum element count of the replay buffer. + Scheduler where connected observers within the selector function will be invoked on. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + + or or is null. + + is less than zero. + + + + + Returns an observable sequence that is the result of invoking the selector on a connectable observable sequence that shares a single subscription to the underlying sequence replaying notifications subject to a maximum time length and element count for the replay buffer. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will receive all the notifications of the source subject to the specified replay buffer trimming policy. + Maximum element count of the replay buffer. + Maximum time length of the replay buffer. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + + or is null. + + is less than zero. + + is less than TimeSpan.Zero. + + + + + Returns an observable sequence that is the result of invoking the selector on a connectable observable sequence that shares a single subscription to the underlying sequence replaying notifications subject to a maximum time length and element count for the replay buffer. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will receive all the notifications of the source subject to the specified replay buffer trimming policy. + Maximum element count of the replay buffer. + Maximum time length of the replay buffer. + Scheduler where connected observers within the selector function will be invoked on. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + + or or is null. + + is less than zero. + + is less than TimeSpan.Zero. + + + + + Returns an observable sequence that is the result of invoking the selector on a connectable observable sequence that shares a single subscription to the underlying sequence replaying all notifications. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will receive all the notifications of the source. + Scheduler where connected observers within the selector function will be invoked on. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + + or or is null. + + + + + Returns an observable sequence that is the result of invoking the selector on a connectable observable sequence that shares a single subscription to the underlying sequence replaying notifications subject to a maximum time length for the replay buffer. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will receive all the notifications of the source subject to the specified replay buffer trimming policy. + Maximum time length of the replay buffer. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + + or is null. + + is less than TimeSpan.Zero. + + + + + Returns an observable sequence that is the result of invoking the selector on a connectable observable sequence that shares a single subscription to the underlying sequence replaying notifications subject to a maximum time length for the replay buffer. + This operator is a specialization of Multicast using a . + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence whose elements will be multicasted through a single shared subscription. + Selector function which can use the multicasted source sequence as many times as needed, without causing multiple subscriptions to the source sequence. Subscribers to the given source will receive all the notifications of the source subject to the specified replay buffer trimming policy. + Maximum time length of the replay buffer. + Scheduler where connected observers within the selector function will be invoked on. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + + or or is null. + + is less than TimeSpan.Zero. + + + + + Repeats the source observable sequence until it successfully terminates. + + The type of the elements in the source sequence. + Observable sequence to repeat until it successfully terminates. + An observable sequence producing the elements of the given sequence repeatedly until it terminates successfully. + + is null. + + + + Repeats the source observable sequence the specified number of times or until it successfully terminates. + + The type of the elements in the source sequence. + Observable sequence to repeat until it successfully terminates. + Number of times to repeat the sequence. + An observable sequence producing the elements of the given sequence repeatedly until it terminates successfully. + + is null. + + is less than zero. + + + + Retries (resubscribes to) the source observable after a failure and when the observable + returned by a handler produces an arbitrary item. + + The type of the elements in the source sequence. + The arbitrary element type signaled by the handler observable. + Observable sequence to repeat until it successfully terminates. + The function that is called for each observer and takes an observable sequence of + errors. It should return an observable of arbitrary items that should signal that arbitrary item in + response to receiving the failure Exception from the source observable. If this observable signals + a terminal event, the sequence is terminated with that signal instead. + An observable sequence producing the elements of the given sequence repeatedly until it terminates successfully. + + is null. + + is null. + + + + Returns an observable sequence that contains a single element. + + Query provider used to construct the data source. + The type of the element that will be returned in the produced sequence. + Single element in the resulting observable sequence. + An observable sequence containing the single specified element. + + + + Returns an observable sequence that contains a single element, using the specified scheduler to send out observer messages. + + Query provider used to construct the data source. + The type of the element that will be returned in the produced sequence. + Single element in the resulting observable sequence. + Scheduler to send the single element on. + An observable sequence containing the single specified element. + + is null. + + + + Samples the observable sequence at each interval. + Upon each sampling tick, the latest element (if any) in the source sequence during the last sampling interval is sent to the resulting sequence. + + The type of the elements in the source sequence. + Source sequence to sample. + Interval at which to sample. If this value is equal to TimeSpan.Zero, the scheduler will continuously sample the stream. + Sampled observable sequence. + + is null. + + is less than TimeSpan.Zero. + + Specifying a TimeSpan.Zero value for doesn't guarantee all source sequence elements will be preserved. This is a side-effect + of the asynchrony introduced by the scheduler, where the sampling action may not execute immediately, despite the TimeSpan.Zero due time. + + + + + Samples the observable sequence at each interval, using the specified scheduler to run sampling timers. + Upon each sampling tick, the latest element (if any) in the source sequence during the last sampling interval is sent to the resulting sequence. + + The type of the elements in the source sequence. + Source sequence to sample. + Interval at which to sample. If this value is equal to TimeSpan.Zero, the scheduler will continuously sample the stream. + Scheduler to run the sampling timer on. + Sampled observable sequence. + + or is null. + + is less than TimeSpan.Zero. + + Specifying a TimeSpan.Zero value for doesn't guarantee all source sequence elements will be preserved. This is a side-effect + of the asynchrony introduced by the scheduler, where the sampling action may not execute immediately, despite the TimeSpan.Zero due time. + + + + + Samples the source observable sequence using a sampler observable sequence producing sampling ticks. + Upon each sampling tick, the latest element (if any) in the source sequence during the last sampling interval is sent to the resulting sequence. + + The type of the elements in the source sequence. + The type of the elements in the sampling sequence. + Source sequence to sample. + Sampling tick sequence. + Sampled observable sequence. + + or is null. + + + + Applies an accumulator function over an observable sequence and returns each intermediate result. + For aggregation behavior with no intermediate results, see . + + The type of the elements in the source sequence and the result of the aggregation. + An observable sequence to accumulate over. + An accumulator function to be invoked on each element. + An observable sequence containing the accumulated values. + + or is null. + + + + Applies an accumulator function over an observable sequence and returns each intermediate result. The specified seed value is used as the initial accumulator value. + For aggregation behavior with no intermediate results, see . + + The type of the elements in the source sequence. + The type of the result of the aggregation. + An observable sequence to accumulate over. + The initial accumulator value. + An accumulator function to be invoked on each element. + An observable sequence containing the accumulated values. + + or is null. + + + + Projects each element of an observable sequence into a new form. + + The type of the elements in the source sequence. + The type of the elements in the result sequence, obtained by running the selector function for each element in the source sequence. + A sequence of elements to invoke a transform function on. + A transform function to apply to each source element. + An observable sequence whose elements are the result of invoking the transform function on each element of source. + + or is null. + + + + Projects each element of an observable sequence into a new form by incorporating the element's index. + + The type of the elements in the source sequence. + The type of the elements in the result sequence, obtained by running the selector function for each element in the source sequence. + A sequence of elements to invoke a transform function on. + A transform function to apply to each source element; the second parameter of the function represents the index of the source element. + An observable sequence whose elements are the result of invoking the transform function on each element of source. + + or is null. + + + + Projects each element of an observable sequence to an observable sequence, invokes the result selector for the source element and each of the corresponding inner sequence's elements, and merges the results into one observable sequence. + + The type of the elements in the source sequence. + The type of the elements in the projected intermediate sequences. + The type of the elements in the result sequence, obtained by using the selector to combine source sequence elements with their corresponding intermediate sequence elements. + An observable sequence of elements to project. + A transform function to apply to each element. + A transform function to apply to each element of the intermediate sequence. + An observable sequence whose elements are the result of invoking the one-to-many transform function collectionSelector on each element of the input sequence and then mapping each of those sequence elements and their corresponding source element to a result element. + + or or is null. + + + + Projects each element of an observable sequence to an observable sequence by incorporating the element's index, invokes the result selector for the source element and each of the corresponding inner sequence's elements, and merges the results into one observable sequence. + + The type of the elements in the source sequence. + The type of the elements in the projected intermediate sequences. + The type of the elements in the result sequence, obtained by using the selector to combine source sequence elements with their corresponding intermediate sequence elements. + An observable sequence of elements to project. + A transform function to apply to each element; the second parameter of the function represents the index of the source element. + A transform function to apply to each element of the intermediate sequence; the second parameter of the function represents the index of the source element and the fourth parameter represents the index of the intermediate element. + An observable sequence whose elements are the result of invoking the one-to-many transform function collectionSelector on each element of the input sequence and then mapping each of those sequence elements and their corresponding source element to a result element. + + or or is null. + + + + Projects each element of an observable sequence to an enumerable sequence, invokes the result selector for the source element and each of the corresponding inner sequence's elements, and merges the results into one observable sequence. + + The type of the elements in the source sequence. + The type of the elements in the projected intermediate enumerable sequences. + The type of the elements in the result sequence, obtained by using the selector to combine source sequence elements with their corresponding intermediate sequence elements. + An observable sequence of elements to project. + A transform function to apply to each element. + A transform function to apply to each element of the intermediate sequence. + An observable sequence whose elements are the result of invoking the one-to-many transform function collectionSelector on each element of the input sequence and then mapping each of those sequence elements and their corresponding source element to a result element. + + or or is null. + The projected sequences are enumerated synchronously within the OnNext call of the source sequence. In order to do a concurrent, non-blocking merge, change the selector to return an observable sequence obtained using the conversion. + + + + Projects each element of an observable sequence to an enumerable sequence by incorporating the element's index, invokes the result selector for the source element and each of the corresponding inner sequence's elements, and merges the results into one observable sequence. + + The type of the elements in the source sequence. + The type of the elements in the projected intermediate enumerable sequences. + The type of the elements in the result sequence, obtained by using the selector to combine source sequence elements with their corresponding intermediate sequence elements. + An observable sequence of elements to project. + A transform function to apply to each element; the second parameter of the function represents the index of the source element. + A transform function to apply to each element of the intermediate sequence; the second parameter of the function represents the index of the source element and the fourth parameter represents the index of the intermediate element. + An observable sequence whose elements are the result of invoking the one-to-many transform function collectionSelector on each element of the input sequence and then mapping each of those sequence elements and their corresponding source element to a result element. + + or or is null. + The projected sequences are enumerated synchronously within the OnNext call of the source sequence. In order to do a concurrent, non-blocking merge, change the selector to return an observable sequence obtained using the conversion. + + + + Projects each element of the source observable sequence to the other observable sequence and merges the resulting observable sequences into one observable sequence. + + The type of the elements in the source sequence. + The type of the elements in the other sequence and the elements in the result sequence. + An observable sequence of elements to project. + An observable sequence to project each element from the source sequence onto. + An observable sequence whose elements are the result of projecting each source element onto the other sequence and merging all the resulting sequences together. + + or is null. + + + + Projects each notification of an observable sequence to an observable sequence and merges the resulting observable sequences into one observable sequence. + + The type of the elements in the source sequence. + The type of the elements in the projected inner sequences and the elements in the merged result sequence. + An observable sequence of notifications to project. + A transform function to apply to each element. + A transform function to apply when an error occurs in the source sequence. + A transform function to apply when the end of the source sequence is reached. + An observable sequence whose elements are the result of invoking the one-to-many transform function corresponding to each notification in the input sequence. + + or or or is null. + + + + Projects each notification of an observable sequence to an observable sequence by incorporating the element's index and merges the resulting observable sequences into one observable sequence. + + The type of the elements in the source sequence. + The type of the elements in the projected inner sequences and the elements in the merged result sequence. + An observable sequence of notifications to project. + A transform function to apply to each element; the second parameter of the function represents the index of the source element. + A transform function to apply when an error occurs in the source sequence. + A transform function to apply when the end of the source sequence is reached. + An observable sequence whose elements are the result of invoking the one-to-many transform function corresponding to each notification in the input sequence. + + or or or is null. + + + + Projects each element of an observable sequence to an observable sequence and merges the resulting observable sequences into one observable sequence. + + The type of the elements in the source sequence. + The type of the elements in the projected inner sequences and the elements in the merged result sequence. + An observable sequence of elements to project. + A transform function to apply to each element. + An observable sequence whose elements are the result of invoking the one-to-many transform function on each element of the input sequence. + + or is null. + + + + Projects each element of an observable sequence to an observable sequence by incorporating the element's index and merges the resulting observable sequences into one observable sequence. + + The type of the elements in the source sequence. + The type of the elements in the projected inner sequences and the elements in the merged result sequence. + An observable sequence of elements to project. + A transform function to apply to each element; the second parameter of the function represents the index of the source element. + An observable sequence whose elements are the result of invoking the one-to-many transform function on each element of the input sequence. + + or is null. + + + + Projects each element of an observable sequence to a task and merges all of the task results into one observable sequence. + + The type of the elements in the source sequence. + The type of the result produced by the projected tasks and the elements in the merged result sequence. + An observable sequence of elements to project. + A transform function to apply to each element. + An observable sequence whose elements are the result of the tasks executed for each element of the input sequence. + This overload supports composition of observable sequences and tasks, without requiring manual conversion of the tasks to observable sequences using . + + or is null. + + + + Projects each element of an observable sequence to a task by incorporating the element's index and merges all of the task results into one observable sequence. + + The type of the elements in the source sequence. + The type of the result produced by the projected tasks and the elements in the merged result sequence. + An observable sequence of elements to project. + A transform function to apply to each element; the second parameter of the function represents the index of the source element. + An observable sequence whose elements are the result of the tasks executed for each element of the input sequence. + This overload supports composition of observable sequences and tasks, without requiring manual conversion of the tasks to observable sequences using . + + or is null. + + + + Projects each element of an observable sequence to a task with cancellation support and merges all of the task results into one observable sequence. + + The type of the elements in the source sequence. + The type of the result produced by the projected tasks and the elements in the merged result sequence. + An observable sequence of elements to project. + A transform function to apply to each element. + An observable sequence whose elements are the result of the tasks executed for each element of the input sequence. + This overload supports composition of observable sequences and tasks, without requiring manual conversion of the tasks to observable sequences using . + + or is null. + + + + Projects each element of an observable sequence to a task by incorporating the element's index with cancellation support and merges all of the task results into one observable sequence. + + The type of the elements in the source sequence. + The type of the result produced by the projected tasks and the elements in the merged result sequence. + An observable sequence of elements to project. + A transform function to apply to each element; the second parameter of the function represents the index of the source element. + An observable sequence whose elements are the result of the tasks executed for each element of the input sequence. + This overload supports composition of observable sequences and tasks, without requiring manual conversion of the tasks to observable sequences using . + + or is null. + + + + Projects each element of an observable sequence to an enumerable sequence and concatenates the resulting enumerable sequences into one observable sequence. + + The type of the elements in the source sequence. + The type of the elements in the projected inner enumerable sequences and the elements in the merged result sequence. + An observable sequence of elements to project. + A transform function to apply to each element. + An observable sequence whose elements are the result of invoking the one-to-many transform function on each element of the input sequence. + + or is null. + The projected sequences are enumerated synchronously within the OnNext call of the source sequence. In order to do a concurrent, non-blocking merge, change the selector to return an observable sequence obtained using the conversion. + + + + Projects each element of an observable sequence to an enumerable sequence by incorporating the element's index and concatenates the resulting enumerable sequences into one observable sequence. + + The type of the elements in the source sequence. + The type of the elements in the projected inner enumerable sequences and the elements in the merged result sequence. + An observable sequence of elements to project. + A transform function to apply to each element; the second parameter of the function represents the index of the source element. + An observable sequence whose elements are the result of invoking the one-to-many transform function on each element of the input sequence. + + or is null. + The projected sequences are enumerated synchronously within the OnNext call of the source sequence. In order to do a concurrent, non-blocking merge, change the selector to return an observable sequence obtained using the conversion. + + + + Projects each element of an observable sequence to a task, invokes the result selector for the source element and the task result, and merges the results into one observable sequence. + + The type of the elements in the source sequence. + The type of the results produced by the projected intermediate tasks. + The type of the elements in the result sequence, obtained by using the selector to combine source sequence elements with their corresponding intermediate task results. + An observable sequence of elements to project. + A transform function to apply to each element. + A transform function to apply to each element of the intermediate sequence. + An observable sequence whose elements are the result of obtaining a task for each element of the input sequence and then mapping the task's result and its corresponding source element to a result element. + + or or is null. + This overload supports using LINQ query comprehension syntax in C# and Visual Basic to compose observable sequences and tasks, without requiring manual conversion of the tasks to observable sequences using . + + + + Projects each element of an observable sequence to a task by incorporating the element's index, invokes the result selector for the source element and the task result, and merges the results into one observable sequence. + + The type of the elements in the source sequence. + The type of the results produced by the projected intermediate tasks. + The type of the elements in the result sequence, obtained by using the selector to combine source sequence elements with their corresponding intermediate task results. + An observable sequence of elements to project. + A transform function to apply to each element; the second parameter of the function represents the index of the source element. + A transform function to apply to each element of the intermediate sequence; the second parameter of the function represents the index of the source element. + An observable sequence whose elements are the result of obtaining a task for each element of the input sequence and then mapping the task's result and its corresponding source element to a result element. + + or or is null. + This overload supports using LINQ query comprehension syntax in C# and Visual Basic to compose observable sequences and tasks, without requiring manual conversion of the tasks to observable sequences using . + + + + Projects each element of an observable sequence to a task with cancellation support, invokes the result selector for the source element and the task result, and merges the results into one observable sequence. + + The type of the elements in the source sequence. + The type of the results produced by the projected intermediate tasks. + The type of the elements in the result sequence, obtained by using the selector to combine source sequence elements with their corresponding intermediate task results. + An observable sequence of elements to project. + A transform function to apply to each element. + A transform function to apply to each element of the intermediate sequence. + An observable sequence whose elements are the result of obtaining a task for each element of the input sequence and then mapping the task's result and its corresponding source element to a result element. + + or or is null. + This overload supports using LINQ query comprehension syntax in C# and Visual Basic to compose observable sequences and tasks, without requiring manual conversion of the tasks to observable sequences using . + + + + Projects each element of an observable sequence to a task by incorporating the element's index with cancellation support, invokes the result selector for the source element and the task result, and merges the results into one observable sequence. + + The type of the elements in the source sequence. + The type of the results produced by the projected intermediate tasks. + The type of the elements in the result sequence, obtained by using the selector to combine source sequence elements with their corresponding intermediate task results. + An observable sequence of elements to project. + A transform function to apply to each element; the second parameter of the function represents the index of the source element. + A transform function to apply to each element of the intermediate sequence; the second parameter of the function represents the index of the source element. + An observable sequence whose elements are the result of obtaining a task for each element of the input sequence and then mapping the task's result and its corresponding source element to a result element. + + or or is null. + This overload supports using LINQ query comprehension syntax in C# and Visual Basic to compose observable sequences and tasks, without requiring manual conversion of the tasks to observable sequences using . + + + + Determines whether two sequences are equal by comparing the elements pairwise. + + The type of the elements in the source sequence. + First observable sequence to compare. + Second observable sequence to compare. + An observable sequence that contains a single element which indicates whether both sequences are of equal length and their corresponding elements are equal according to the default equality comparer for their type. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Determines whether an observable and enumerable sequence are equal by comparing the elements pairwise. + + The type of the elements in the source sequence. + First observable sequence to compare. + Second observable sequence to compare. + An observable sequence that contains a single element which indicates whether both sequences are of equal length and their corresponding elements are equal according to the default equality comparer for their type. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Determines whether two sequences are equal by comparing the elements pairwise using a specified equality comparer. + + The type of the elements in the source sequence. + First observable sequence to compare. + Second observable sequence to compare. + Comparer used to compare elements of both sequences. + An observable sequence that contains a single element which indicates whether both sequences are of equal length and their corresponding elements are equal according to the specified equality comparer. + + or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Determines whether an observable and enumerable sequence are equal by comparing the elements pairwise using a specified equality comparer. + + The type of the elements in the source sequence. + First observable sequence to compare. + Second observable sequence to compare. + Comparer used to compare elements of both sequences. + An observable sequence that contains a single element which indicates whether both sequences are of equal length and their corresponding elements are equal according to the specified equality comparer. + + or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Returns the only element of an observable sequence, and reports an exception if there is not exactly one element in the observable sequence. + + The type of the elements in the source sequence. + Source observable sequence. + Sequence containing the single element in the observable sequence. + + is null. + (Asynchronous) The source sequence contains more than one element. -or- The source sequence is empty. + + + + Returns the only element of an observable sequence that satisfies the condition in the predicate, and reports an exception if there is not exactly one element in the observable sequence. + + The type of the elements in the source sequence. + Source observable sequence. + A predicate function to evaluate for elements in the source sequence. + Sequence containing the single element in the observable sequence that satisfies the condition in the predicate. + + or is null. + (Asynchronous) No element satisfies the condition in the predicate. -or- More than one element satisfies the condition in the predicate. -or- The source sequence is empty. + + + + Returns the only element of an observable sequence, or a default value if the observable sequence is empty; this method reports an exception if there is more than one element in the observable sequence. + + The type of the elements in the source sequence. + Source observable sequence. + Sequence containing the single element in the observable sequence, or a default value if no such element exists. + + is null. + (Asynchronous) The source sequence contains more than one element. + + + + Returns the only element of an observable sequence that matches the predicate, or a default value if no such element exists; this method reports an exception if there is more than one element in the observable sequence. + + The type of the elements in the source sequence. + Source observable sequence. + A predicate function to evaluate for elements in the source sequence. + Sequence containing the single element in the observable sequence that satisfies the condition in the predicate, or a default value if no such element exists. + + or is null. + (Asynchronous) The sequence contains more than one element that satisfies the condition in the predicate. + + + + Bypasses a specified number of elements in an observable sequence and then returns the remaining elements. + + The type of the elements in the source sequence. + The sequence to take elements from. + The number of elements to skip before returning the remaining elements. + An observable sequence that contains the elements that occur after the specified index in the input sequence. + + is null. + + is less than zero. + + + + Skips elements for the specified duration from the start of the observable source sequence. + + The type of the elements in the source sequence. + Source sequence to skip elements for. + Duration for skipping elements from the start of the sequence. + An observable sequence with the elements skipped during the specified duration from the start of the source sequence. + + is null. + + is less than TimeSpan.Zero. + + + Specifying a TimeSpan.Zero value for doesn't guarantee no elements will be dropped from the start of the source sequence. + This is a side-effect of the asynchrony introduced by the scheduler, where the action that causes callbacks from the source sequence to be forwarded + may not execute immediately, despite the TimeSpan.Zero due time. + + + Errors produced by the source sequence are always forwarded to the result sequence, even if the error occurs before the . + + + + + + Skips elements for the specified duration from the start of the observable source sequence, using the specified scheduler to run timers. + + The type of the elements in the source sequence. + Source sequence to skip elements for. + Duration for skipping elements from the start of the sequence. + Scheduler to run the timer on. + An observable sequence with the elements skipped during the specified duration from the start of the source sequence. + + or is null. + + is less than TimeSpan.Zero. + + + Specifying a TimeSpan.Zero value for doesn't guarantee no elements will be dropped from the start of the source sequence. + This is a side-effect of the asynchrony introduced by the scheduler, where the action that causes callbacks from the source sequence to be forwarded + may not execute immediately, despite the TimeSpan.Zero due time. + + + Errors produced by the source sequence are always forwarded to the result sequence, even if the error occurs before the . + + + + + + Bypasses a specified number of elements at the end of an observable sequence. + + The type of the elements in the source sequence. + Source sequence. + Number of elements to bypass at the end of the source sequence. + An observable sequence containing the source sequence elements except for the bypassed ones at the end. + + is null. + + is less than zero. + + This operator accumulates a queue with a length enough to store the first elements. As more elements are + received, elements are taken from the front of the queue and produced on the result sequence. This causes elements to be delayed. + + + + + Skips elements for the specified duration from the end of the observable source sequence. + + The type of the elements in the source sequence. + Source sequence to skip elements for. + Duration for skipping elements from the end of the sequence. + An observable sequence with the elements skipped during the specified duration from the end of the source sequence. + + is null. + + is less than TimeSpan.Zero. + + This operator accumulates a queue with a length enough to store elements received during the initial window. + As more elements are received, elements older than the specified are taken from the queue and produced on the + result sequence. This causes elements to be delayed with . + + + + + Skips elements for the specified duration from the end of the observable source sequence, using the specified scheduler to run timers. + + The type of the elements in the source sequence. + Source sequence to skip elements for. + Duration for skipping elements from the end of the sequence. + Scheduler to run the timer on. + An observable sequence with the elements skipped during the specified duration from the end of the source sequence. + + or is null. + + is less than TimeSpan.Zero. + + This operator accumulates a queue with a length enough to store elements received during the initial window. + As more elements are received, elements older than the specified are taken from the queue and produced on the + result sequence. This causes elements to be delayed with . + + + + + Skips elements from the observable source sequence until the specified start time. + + The type of the elements in the source sequence. + Source sequence to skip elements for. + Time to start taking elements from the source sequence. If this value is less than or equal to DateTimeOffset.UtcNow, no elements will be skipped. + An observable sequence with the elements skipped until the specified start time. + + is null. + + Errors produced by the source sequence are always forwarded to the result sequence, even if the error occurs before the . + + + + + Skips elements from the observable source sequence until the specified start time, using the specified scheduler to run timers. + + The type of the elements in the source sequence. + Source sequence to skip elements for. + Time to start taking elements from the source sequence. If this value is less than or equal to DateTimeOffset.UtcNow, no elements will be skipped. + Scheduler to run the timer on. + An observable sequence with the elements skipped until the specified start time. + + or is null. + + Errors produced by the source sequence are always forwarded to the result sequence, even if the error occurs before the . + + + + + Returns the elements from the source observable sequence only after the other observable sequence produces an element. + Starting from Rx.NET 4.0, this will subscribe to before subscribing to + so in case emits an element right away, elements from are not missed. + + The type of the elements in the source sequence. + The type of the elements in the other sequence that indicates the end of skip behavior. + Source sequence to propagate elements for. + Observable sequence that triggers propagation of elements of the source sequence. + An observable sequence containing the elements of the source sequence starting from the point the other sequence triggered propagation. + + or is null. + + + + Bypasses elements in an observable sequence as long as a specified condition is true and then returns the remaining elements. + + The type of the elements in the source sequence. + An observable sequence to return elements from. + A function to test each element for a condition. + An observable sequence that contains the elements from the input sequence starting at the first element in the linear series that does not pass the test specified by predicate. + + or is null. + + + + Bypasses elements in an observable sequence as long as a specified condition is true and then returns the remaining elements. + The element's index is used in the logic of the predicate function. + + The type of the elements in the source sequence. + An observable sequence to return elements from. + A function to test each element for a condition; the second parameter of the function represents the index of the source element. + An observable sequence that contains the elements from the input sequence starting at the first element in the linear series that does not pass the test specified by predicate. + + or is null. + + + + Invokes the action asynchronously, surfacing the result through an observable sequence. + + Query provider used to construct the data source. + Action to run asynchronously. + An observable sequence exposing a Unit value upon completion of the action, or an exception. + + is null. + + + + The action is called immediately, not during the subscription of the resulting sequence. + + + Multiple subscriptions to the resulting sequence can observe the action's outcome. + + + + + + + Invokes the action asynchronously on the specified scheduler, surfacing the result through an observable sequence. + + Query provider used to construct the data source. + Action to run asynchronously. + Scheduler to run the action on. + An observable sequence exposing a Unit value upon completion of the action, or an exception. + + or is null. + + + + The action is called immediately, not during the subscription of the resulting sequence. + + + Multiple subscriptions to the resulting sequence can observe the action's outcome. + + + + + + + Invokes the specified function asynchronously, surfacing the result through an observable sequence. + + Query provider used to construct the data source. + The type of the result returned by the function. + Function to run asynchronously. + An observable sequence exposing the function's result value, or an exception. + + is null. + + + + The function is called immediately, not during the subscription of the resulting sequence. + + + Multiple subscriptions to the resulting sequence can observe the function's result. + + + + + + + Invokes the specified function asynchronously on the specified scheduler, surfacing the result through an observable sequence + + Query provider used to construct the data source. + The type of the result returned by the function. + Function to run asynchronously. + Scheduler to run the function on. + An observable sequence exposing the function's result value, or an exception. + + or is null. + + + + The function is called immediately, not during the subscription of the resulting sequence. + + + Multiple subscriptions to the resulting sequence can observe the function's result. + + + + + + + Invokes the asynchronous action, surfacing the result through an observable sequence. + + Query provider used to construct the data source. + Asynchronous action to run. + An observable sequence exposing a Unit value upon completion of the action, or an exception. + + is null. + + + + The action is started immediately, not during the subscription of the resulting sequence. + + + Multiple subscriptions to the resulting sequence can observe the action's outcome. + + + + + + + Invokes the asynchronous action, surfacing the result through an observable sequence. + + Query provider used to construct the data source. + Asynchronous action to run. + Scheduler on which to notify observers. + An observable sequence exposing a Unit value upon completion of the action, or an exception. + + is null or is null. + + + + The action is started immediately, not during the subscription of the resulting sequence. + + + Multiple subscriptions to the resulting sequence can observe the action's outcome. + + + + + + + Invokes the asynchronous action, surfacing the result through an observable sequence. + The CancellationToken is shared by all subscriptions on the resulting observable sequence. See the remarks section for more information. + + Query provider used to construct the data source. + Asynchronous action to run. + An observable sequence exposing a Unit value upon completion of the action, or an exception. + + is null. + + + + The action is started immediately, not during the subscription of the resulting sequence. + + + Multiple subscriptions to the resulting sequence can observe the action's outcome. + + + + If any subscription to the resulting sequence is disposed, the CancellationToken is set. The observer associated to the disposed + subscription won't see the TaskCanceledException, but other observers will. You can protect against this using the Catch operator. + Be careful when handing out the resulting sequence because of this behavior. The most common use is to have a single subscription + to the resulting sequence, which controls the CancellationToken state. Alternatively, you can control subscription behavior using + multicast operators. + + + + + + + + Invokes the asynchronous action, surfacing the result through an observable sequence. + The CancellationToken is shared by all subscriptions on the resulting observable sequence. See the remarks section for more information. + + Query provider used to construct the data source. + Asynchronous action to run. + Scheduler on which to notify observers. + An observable sequence exposing a Unit value upon completion of the action, or an exception. + + is null or is null. + + + + The action is started immediately, not during the subscription of the resulting sequence. + + + Multiple subscriptions to the resulting sequence can observe the action's outcome. + + + + If any subscription to the resulting sequence is disposed, the CancellationToken is set. The observer associated to the disposed + subscription won't see the TaskCanceledException, but other observers will. You can protect against this using the Catch operator. + Be careful when handing out the resulting sequence because of this behavior. The most common use is to have a single subscription + to the resulting sequence, which controls the CancellationToken state. Alternatively, you can control subscription behavior using + multicast operators. + + + + + + + + Invokes the asynchronous function, surfacing the result through an observable sequence. + + Query provider used to construct the data source. + The type of the result returned by the asynchronous function. + Asynchronous function to run. + An observable sequence exposing the function's result value, or an exception. + + is null. + + + + The function is started immediately, not during the subscription of the resulting sequence. + + + Multiple subscriptions to the resulting sequence can observe the function's result. + + + + + + + Invokes the asynchronous function, surfacing the result through an observable sequence. + The CancellationToken is shared by all subscriptions on the resulting observable sequence. See the remarks section for more information. + + Query provider used to construct the data source. + The type of the result returned by the asynchronous function. + Asynchronous function to run. + An observable sequence exposing the function's result value, or an exception. + + is null. + + + + The function is started immediately, not during the subscription of the resulting sequence. + + + Multiple subscriptions to the resulting sequence can observe the function's result. + + + + If any subscription to the resulting sequence is disposed, the CancellationToken is set. The observer associated to the disposed + subscription won't see the TaskCanceledException, but other observers will. You can protect against this using the Catch operator. + Be careful when handing out the resulting sequence because of this behavior. The most common use is to have a single subscription + to the resulting sequence, which controls the CancellationToken state. Alternatively, you can control subscription behavior using + multicast operators. + + + + + + + + Invokes the asynchronous function, surfacing the result through an observable sequence. + + Query provider used to construct the data source. + The type of the result returned by the asynchronous function. + Asynchronous function to run. + Scheduler on which to notify observers. + An observable sequence exposing the function's result value, or an exception. + + is null or is null. + + + + The function is started immediately, not during the subscription of the resulting sequence. + + + Multiple subscriptions to the resulting sequence can observe the function's result. + + + + + + + Invokes the asynchronous function, surfacing the result through an observable sequence. + The CancellationToken is shared by all subscriptions on the resulting observable sequence. See the remarks section for more information. + + Query provider used to construct the data source. + The type of the result returned by the asynchronous function. + Asynchronous function to run. + Scheduler on which to notify observers. + An observable sequence exposing the function's result value, or an exception. + + is null or is null. + + + + The function is started immediately, not during the subscription of the resulting sequence. + + + Multiple subscriptions to the resulting sequence can observe the function's result. + + + + If any subscription to the resulting sequence is disposed, the CancellationToken is set. The observer associated to the disposed + subscription won't see the TaskCanceledException, but other observers will. You can protect against this using the Catch operator. + Be careful when handing out the resulting sequence because of this behavior. The most common use is to have a single subscription + to the resulting sequence, which controls the CancellationToken state. Alternatively, you can control subscription behavior using + multicast operators. + + + + + + + + Prepends a sequence of values to an observable sequence. + + The type of the elements in the source sequence. + Source sequence to prepend values to. + Scheduler to emit the prepended values on. + Values to prepend to the specified sequence. + The source sequence prepended with the specified values. + + or or is null. + + + + Prepends a sequence of values to an observable sequence. + + The type of the elements in the source sequence. + Source sequence to prepend values to. + Scheduler to emit the prepended values on. + Values to prepend to the specified sequence. + The source sequence prepended with the specified values. + + or or is null. + + + + Prepends a sequence of values to an observable sequence. + + The type of the elements in the source sequence. + Source sequence to prepend values to. + Values to prepend to the specified sequence. + The source sequence prepended with the specified values. + + or is null. + + + + Prepends a sequence of values to an observable sequence. + + The type of the elements in the source sequence. + Source sequence to prepend values to. + Values to prepend to the specified sequence. + The source sequence prepended with the specified values. + + or is null. + + + + Wraps the source sequence in order to run its subscription and unsubscription logic on the specified synchronization context. This operation is not commonly used; + see the remarks section for more information on the distinction between SubscribeOn and ObserveOn. + + The type of the elements in the source sequence. + Source sequence. + Synchronization context to perform subscription and unsubscription actions on. + The source sequence whose subscriptions and unsubscriptions happen on the specified synchronization context. + + or is null. + + This only performs the side-effects of subscription and unsubscription on the specified synchronization context. In order to invoke observer + callbacks on a synchronization context, use . + + + + + Wraps the source sequence in order to run its subscription and unsubscription logic on the specified scheduler. This operation is not commonly used; + see the remarks section for more information on the distinction between SubscribeOn and ObserveOn. + + The type of the elements in the source sequence. + Source sequence. + Scheduler to perform subscription and unsubscription actions on. + The source sequence whose subscriptions and unsubscriptions happen on the specified scheduler. + + or is null. + + This only performs the side-effects of subscription and unsubscription on the specified scheduler. In order to invoke observer + callbacks on a scheduler, use . + + + + + Computes the sum of a sequence of values. + + A sequence of values to calculate the sum of. + An observable sequence containing a single element with the sum of the values in the source sequence. + + is null. + (Asynchronous) The sum of the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of values. + + A sequence of values to calculate the sum of. + An observable sequence containing a single element with the sum of the values in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of values. + + A sequence of values to calculate the sum of. + An observable sequence containing a single element with the sum of the values in the source sequence. + + is null. + (Asynchronous) The sum of the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of values. + + A sequence of values to calculate the sum of. + An observable sequence containing a single element with the sum of the values in the source sequence. + + is null. + (Asynchronous) The sum of the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of nullable values. + + A sequence of nullable values to calculate the sum of. + An observable sequence containing a single element with the sum of the values in the source sequence. + + is null. + (Asynchronous) The sum of the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of nullable values. + + A sequence of nullable values to calculate the sum of. + An observable sequence containing a single element with the sum of the values in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of nullable values. + + A sequence of nullable values to calculate the sum of. + An observable sequence containing a single element with the sum of the values in the source sequence. + + is null. + (Asynchronous) The sum of the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of nullable values. + + A sequence of nullable values to calculate the sum of. + An observable sequence containing a single element with the sum of the values in the source sequence. + + is null. + (Asynchronous) The sum of the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of nullable values. + + A sequence of nullable values to calculate the sum of. + An observable sequence containing a single element with the sum of the values in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of values. + + A sequence of values to calculate the sum of. + An observable sequence containing a single element with the sum of the values in the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values that are used to calculate a sum. + A transform function to apply to each element. + An observable sequence containing a single element with the sum of the values in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values that are used to calculate a sum. + A transform function to apply to each element. + An observable sequence containing a single element with the sum of the values in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values that are used to calculate a sum. + A transform function to apply to each element. + An observable sequence containing a single element with the sum of the values in the source sequence. + + or is null. + (Asynchronous) The sum of the projected values for the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values that are used to calculate a sum. + A transform function to apply to each element. + An observable sequence containing a single element with the sum of the values in the source sequence. + + or is null. + (Asynchronous) The sum of the projected values for the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values that are used to calculate a sum. + A transform function to apply to each element. + An observable sequence containing a single element with the sum of the values in the source sequence. + + or is null. + (Asynchronous) The sum of the projected values for the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of nullable values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values that are used to calculate a sum. + A transform function to apply to each element. + An observable sequence containing a single element with the sum of the values in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of nullable values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values that are used to calculate a sum. + A transform function to apply to each element. + An observable sequence containing a single element with the sum of the values in the source sequence. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of nullable values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values that are used to calculate a sum. + A transform function to apply to each element. + An observable sequence containing a single element with the sum of the values in the source sequence. + + or is null. + (Asynchronous) The sum of the projected values for the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of nullable values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values that are used to calculate a sum. + A transform function to apply to each element. + An observable sequence containing a single element with the sum of the values in the source sequence. + + or is null. + (Asynchronous) The sum of the projected values for the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Computes the sum of a sequence of nullable values that are obtained by invoking a transform function on each element of the input sequence. + + The type of the elements in the source sequence. + A sequence of values that are used to calculate a sum. + A transform function to apply to each element. + An observable sequence containing a single element with the sum of the values in the source sequence. + + or is null. + (Asynchronous) The sum of the projected values for the elements in the source sequence is larger than . + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Transforms an observable sequence of observable sequences into an observable sequence + producing values only from the most recent observable sequence. + Each time a new inner observable sequence is received, unsubscribe from the + previous inner observable sequence. + + The type of the elements in the source sequences. + Observable sequence of inner observable sequences. + The observable sequence that at any point in time produces the elements of the most recent inner observable sequence that has been received. + + is null. + + + + Transforms an observable sequence of tasks into an observable sequence + producing values only from the most recent observable sequence. + Each time a new task is received, the previous task's result is ignored. + + The type of the results produced by the source tasks. + Observable sequence of tasks. + The observable sequence that at any point in time produces the result of the most recent task that has been received. + + is null. + If the tasks support cancellation, consider manual conversion of the tasks using , followed by a switch operation using . + + + + Synchronizes the observable sequence such that observer notifications cannot be delivered concurrently. + This overload is useful to "fix" an observable sequence that exhibits concurrent callbacks on individual observers, which is invalid behavior for the query processor. + + The type of the elements in the source sequence. + Source sequence. + The source sequence whose outgoing calls to observers are synchronized. + + is null. + + It's invalid behavior - according to the observer grammar - for a sequence to exhibit concurrent callbacks on a given observer. + This operator can be used to "fix" a source that doesn't conform to this rule. + + + + + Synchronizes the observable sequence such that observer notifications cannot be delivered concurrently, using the specified gate object. + This overload is useful when writing n-ary query operators, in order to prevent concurrent callbacks from different sources by synchronizing on a common gate object. + + The type of the elements in the source sequence. + Source sequence. + Gate object to synchronize each observer call on. + The source sequence whose outgoing calls to observers are synchronized on the given gate object. + + or is null. + + + + Returns a specified number of contiguous elements from the start of an observable sequence. + + The type of the elements in the source sequence. + The sequence to take elements from. + The number of elements to return. + An observable sequence that contains the specified number of elements from the start of the input sequence. + + is null. + + is less than zero. + + + + Returns a specified number of contiguous elements from the start of an observable sequence, using the specified scheduler for the edge case of Take(0). + + The type of the elements in the source sequence. + The sequence to take elements from. + The number of elements to return. + Scheduler used to produce an OnCompleted message in case count is set to 0. + An observable sequence that contains the specified number of elements from the start of the input sequence. + + or is null. + + is less than zero. + + + + Takes elements for the specified duration from the start of the observable source sequence. + + The type of the elements in the source sequence. + Source sequence to take elements from. + Duration for taking elements from the start of the sequence. + An observable sequence with the elements taken during the specified duration from the start of the source sequence. + + is null. + + is less than TimeSpan.Zero. + + Specifying a TimeSpan.Zero value for doesn't guarantee an empty sequence will be returned. This is a side-effect + of the asynchrony introduced by the scheduler, where the action that stops forwarding callbacks from the source sequence may not execute + immediately, despite the TimeSpan.Zero due time. + + + + + Takes elements for the specified duration from the start of the observable source sequence, using the specified scheduler to run timers. + + The type of the elements in the source sequence. + Source sequence to take elements from. + Duration for taking elements from the start of the sequence. + Scheduler to run the timer on. + An observable sequence with the elements taken during the specified duration from the start of the source sequence. + + or is null. + + is less than TimeSpan.Zero. + + Specifying a TimeSpan.Zero value for doesn't guarantee an empty sequence will be returned. This is a side-effect + of the asynchrony introduced by the scheduler, where the action that stops forwarding callbacks from the source sequence may not execute + immediately, despite the TimeSpan.Zero due time. + + + + + Returns a specified number of contiguous elements from the end of an observable sequence. + + The type of the elements in the source sequence. + Source sequence. + Number of elements to take from the end of the source sequence. + An observable sequence containing the specified number of elements from the end of the source sequence. + + is null. + + is less than zero. + + This operator accumulates a buffer with a length enough to store elements elements. Upon completion of + the source sequence, this buffer is drained on the result sequence. This causes the elements to be delayed. + + + + + Returns a specified number of contiguous elements from the end of an observable sequence, using the specified scheduler to drain the queue. + + The type of the elements in the source sequence. + Source sequence. + Number of elements to take from the end of the source sequence. + Scheduler used to drain the queue upon completion of the source sequence. + An observable sequence containing the specified number of elements from the end of the source sequence. + + or is null. + + is less than zero. + + This operator accumulates a buffer with a length enough to store elements elements. Upon completion of + the source sequence, this buffer is drained on the result sequence. This causes the elements to be delayed. + + + + + Returns elements within the specified duration from the end of the observable source sequence. + + The type of the elements in the source sequence. + Source sequence to take elements from. + Duration for taking elements from the end of the sequence. + An observable sequence with the elements taken during the specified duration from the end of the source sequence. + + is null. + + is less than TimeSpan.Zero. + + This operator accumulates a buffer with a length enough to store elements for any window during the lifetime of + the source sequence. Upon completion of the source sequence, this buffer is drained on the result sequence. This causes the result elements + to be delayed with . + + + + + Returns elements within the specified duration from the end of the observable source sequence, using the specified scheduler to run timers. + + The type of the elements in the source sequence. + Source sequence to take elements from. + Duration for taking elements from the end of the sequence. + Scheduler to run the timer on. + An observable sequence with the elements taken during the specified duration from the end of the source sequence. + + or is null. + + is less than TimeSpan.Zero. + + This operator accumulates a buffer with a length enough to store elements for any window during the lifetime of + the source sequence. Upon completion of the source sequence, this buffer is drained on the result sequence. This causes the result elements + to be delayed with . + + + + + Returns elements within the specified duration from the end of the observable source sequence, using the specified schedulers to run timers and to drain the collected elements. + + The type of the elements in the source sequence. + Source sequence to take elements from. + Duration for taking elements from the end of the sequence. + Scheduler to run the timer on. + Scheduler to drain the collected elements. + An observable sequence with the elements taken during the specified duration from the end of the source sequence. + + or or is null. + + is less than TimeSpan.Zero. + + This operator accumulates a buffer with a length enough to store elements for any window during the lifetime of + the source sequence. Upon completion of the source sequence, this buffer is drained on the result sequence. This causes the result elements + to be delayed with . + + + + + Returns a list with the specified number of contiguous elements from the end of an observable sequence. + + The type of the elements in the source sequence. + Source sequence. + Number of elements to take from the end of the source sequence. + An observable sequence containing a single list with the specified number of elements from the end of the source sequence. + + is null. + + is less than zero. + + This operator accumulates a buffer with a length enough to store elements. Upon completion of the + source sequence, this buffer is produced on the result sequence. + + + + + Returns a list with the elements within the specified duration from the end of the observable source sequence. + + The type of the elements in the source sequence. + Source sequence to take elements from. + Duration for taking elements from the end of the sequence. + An observable sequence containing a single list with the elements taken during the specified duration from the end of the source sequence. + + is null. + + is less than TimeSpan.Zero. + + This operator accumulates a buffer with a length enough to store elements for any window during the lifetime of + the source sequence. Upon completion of the source sequence, this buffer is produced on the result sequence. + + + + + Returns a list with the elements within the specified duration from the end of the observable source sequence, using the specified scheduler to run timers. + + The type of the elements in the source sequence. + Source sequence to take elements from. + Duration for taking elements from the end of the sequence. + Scheduler to run the timer on. + An observable sequence containing a single list with the elements taken during the specified duration from the end of the source sequence. + + or is null. + + is less than TimeSpan.Zero. + + This operator accumulates a buffer with a length enough to store elements for any window during the lifetime of + the source sequence. Upon completion of the source sequence, this buffer is produced on the result sequence. + + + + + Takes elements for the specified duration until the specified end time. + + The type of the elements in the source sequence. + Source sequence to take elements from. + Time to stop taking elements from the source sequence. If this value is less than or equal to DateTimeOffset.UtcNow, the result stream will complete immediately. + An observable sequence with the elements taken until the specified end time. + + is null. + + + + Takes elements for the specified duration until the specified end time, using the specified scheduler to run timers. + + The type of the elements in the source sequence. + Source sequence to take elements from. + Time to stop taking elements from the source sequence. If this value is less than or equal to DateTimeOffset.UtcNow, the result stream will complete immediately. + Scheduler to run the timer on. + An observable sequence with the elements taken until the specified end time. + + or is null. + + + + Returns the elements from the source observable sequence until the other observable sequence produces an element. + + The type of the elements in the source sequence. + The type of the elements in the other sequence that indicates the end of take behavior. + Source sequence to propagate elements for. + Observable sequence that terminates propagation of elements of the source sequence. + An observable sequence containing the elements of the source sequence up to the point the other sequence interrupted further propagation. + + or is null. + + + + Relays elements from the source observable sequence and calls the predicate after an + emission to check if the sequence should stop after that specific item. + + The type of the elements in the source and result sequences. + The source sequence to relay elements of. + Called after each upstream item has been emitted with + that upstream item and should return true to indicate the sequence should + complete. + The observable sequence with the source elements until the stop predicate returns true. + + The following sequence will stop after the value 5 has been encountered: + + Observable.Range(1, 10) + .TakeUntil(item => item == 5) + .Subscribe(Console.WriteLine); + + + If or is null. + + + + Returns elements from an observable sequence as long as a specified condition is true. + + The type of the elements in the source sequence. + A sequence to return elements from. + A function to test each element for a condition. + An observable sequence that contains the elements from the input sequence that occur before the element at which the test no longer passes. + + or is null. + + + + Returns elements from an observable sequence as long as a specified condition is true. + The element's index is used in the logic of the predicate function. + + The type of the elements in the source sequence. + A sequence to return elements from. + A function to test each element for a condition; the second parameter of the function represents the index of the source element. + An observable sequence that contains the elements from the input sequence that occur before the element at which the test no longer passes. + + or is null. + + + + Ignores elements from an observable sequence which are followed by another element within a specified relative time duration. + + The type of the elements in the source sequence. + Source sequence to throttle. + Throttling duration for each element. + The throttled sequence. + + is null. + + is less than TimeSpan.Zero. + + + This operator throttles the source sequence by holding on to each element for the duration specified in . If another + element is produced within this time window, the element is dropped and a new timer is started for the current element, repeating this whole + process. For streams that never have gaps larger than or equal to between elements, the resulting stream won't + produce any elements. In order to reduce the volume of a stream whilst guaranteeing the periodic production of elements, consider using the + Observable.Sample set of operators. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing throttling timers to be scheduled + that are due immediately. However, this doesn't guarantee all elements will be retained in the result sequence. This is a side-effect of the + asynchrony introduced by the scheduler, where the action to forward the current element may not execute immediately, despite the TimeSpan.Zero + due time. In such cases, the next element may arrive before the scheduler gets a chance to run the throttling action. + + + + + + Ignores elements from an observable sequence which are followed by another element within a specified relative time duration, using the specified scheduler to run throttling timers. + + The type of the elements in the source sequence. + Source sequence to throttle. + Throttling duration for each element. + Scheduler to run the throttle timers on. + The throttled sequence. + + or is null. + + is less than TimeSpan.Zero. + + + This operator throttles the source sequence by holding on to each element for the duration specified in . If another + element is produced within this time window, the element is dropped and a new timer is started for the current element, repeating this whole + process. For streams that never have gaps larger than or equal to between elements, the resulting stream won't + produce any elements. In order to reduce the volume of a stream whilst guaranteeing the periodic production of elements, consider using the + Observable.Sample set of operators. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing throttling timers to be scheduled + that are due immediately. However, this doesn't guarantee all elements will be retained in the result sequence. This is a side-effect of the + asynchrony introduced by the scheduler, where the action to forward the current element may not execute immediately, despite the TimeSpan.Zero + due time. In such cases, the next element may arrive before the scheduler gets a chance to run the throttling action. + + + + + + Ignores elements from an observable sequence which are followed by another value within a computed throttle duration. + + The type of the elements in the source sequence. + The type of the elements in the throttle sequences selected for each element in the source sequence. + Source sequence to throttle. + Selector function to retrieve a sequence indicating the throttle duration for each given element. + The throttled sequence. + + or is null. + + This operator throttles the source sequence by holding on to each element for the duration denoted by . + If another element is produced within this time window, the element is dropped and a new timer is started for the current element, repeating this + whole process. For streams where the duration computed by applying the to each element overlaps with + the occurrence of the successor element, the resulting stream won't produce any elements. In order to reduce the volume of a stream whilst + guaranteeing the periodic production of elements, consider using the Observable.Sample set of operators. + + + + + Returns an observable sequence that terminates with an exception. + + Query provider used to construct the data source. + The type used for the type parameter of the resulting sequence. + Exception object used for the sequence's termination. + The observable sequence that terminates exceptionally with the specified exception object. + + is null. + + + + Returns an observable sequence that terminates with an exception, using the specified scheduler to send out the single OnError message. + + Query provider used to construct the data source. + The type used for the type parameter of the resulting sequence. + Exception object used for the sequence's termination. + Scheduler to send the exceptional termination call on. + The observable sequence that terminates exceptionally with the specified exception object. + + or is null. + + + + Returns an observable sequence that terminates with an exception, using the specified scheduler to send out the single OnError message. + + Query provider used to construct the data source. + The type used for the type parameter of the resulting sequence. + Exception object used for the sequence's termination. + Scheduler to send the exceptional termination call on. + Object solely used to infer the type of the type parameter. This parameter is typically used when creating a sequence of anonymously typed elements. + The observable sequence that terminates exceptionally with the specified exception object. + + or is null. + + + + Returns an observable sequence that terminates with an exception. + + Query provider used to construct the data source. + The type used for the type parameter of the resulting sequence. + Exception object used for the sequence's termination. + Object solely used to infer the type of the type parameter. This parameter is typically used when creating a sequence of anonymously typed elements. + The observable sequence that terminates exceptionally with the specified exception object. + + is null. + + + + Records the time interval between consecutive elements in an observable sequence. + + The type of the elements in the source sequence. + Source sequence to record time intervals for. + An observable sequence with time interval information on elements. + + is null. + + + + Records the time interval between consecutive elements in an observable sequence, using the specified scheduler to compute time intervals. + + The type of the elements in the source sequence. + Source sequence to record time intervals for. + Scheduler used to compute time intervals. + An observable sequence with time interval information on elements. + + or is null. + + + + Applies a timeout policy to the observable sequence based on an absolute time. + If the sequence doesn't terminate before the specified absolute due time, a TimeoutException is propagated to the observer. + + The type of the elements in the source sequence. + Source sequence to perform a timeout for. + Time when a timeout occurs. If this value is less than or equal to DateTimeOffset.UtcNow, the timeout occurs immediately. + The source sequence with a TimeoutException in case of a timeout. + + is null. + (Asynchronous) If the sequence hasn't terminated before . + + In case you only want to timeout on the first element, consider using the + operator applied to the source sequence and a delayed sequence. Alternatively, the general-purpose overload + of Timeout, can be used. + + + + + Applies a timeout policy to the observable sequence based on an absolute time. + If the sequence doesn't terminate before the specified absolute due time, the other observable sequence is used to produce future messages from that point on. + + The type of the elements in the source sequence and the other sequence used upon a timeout. + Source sequence to perform a timeout for. + Time when a timeout occurs. If this value is less than or equal to DateTimeOffset.UtcNow, the timeout occurs immediately. + Sequence to return in case of a timeout. + The source sequence switching to the other sequence in case of a timeout. + + or is null. + + In case you only want to timeout on the first element, consider using the + operator applied to the source sequence and a delayed sequence. Alternatively, the general-purpose overload + of Timeout, can be used. + + + + + Applies a timeout policy to the observable sequence based on an absolute time, using the specified scheduler to run timeout timers. + If the sequence doesn't terminate before the specified absolute due time, the other observable sequence is used to produce future messages from that point on. + + The type of the elements in the source sequence and the other sequence used upon a timeout. + Source sequence to perform a timeout for. + Time when a timeout occurs. If this value is less than or equal to DateTimeOffset.UtcNow, the timeout occurs immediately. + Sequence to return in case of a timeout. + Scheduler to run the timeout timers on. + The source sequence switching to the other sequence in case of a timeout. + + or or is null. + + In case you only want to timeout on the first element, consider using the + operator applied to the source sequence and a delayed sequence. Alternatively, the general-purpose overload + of Timeout, can be used. + + + + + Applies a timeout policy to the observable sequence based on an absolute time, using the specified scheduler to run timeout timers. + If the sequence doesn't terminate before the specified absolute due time, a TimeoutException is propagated to the observer. + + The type of the elements in the source sequence. + Source sequence to perform a timeout for. + Time when a timeout occurs. If this value is less than or equal to DateTimeOffset.UtcNow, the timeout occurs immediately. + Scheduler to run the timeout timers on. + The source sequence with a TimeoutException in case of a timeout. + + or is null. + (Asynchronous) If the sequence hasn't terminated before . + + In case you only want to timeout on the first element, consider using the + operator applied to the source sequence and a delayed sequence. Alternatively, the general-purpose overload + of Timeout, can be used. + + + + + Applies a timeout policy for each element in the observable sequence. + If the next element isn't received within the specified timeout duration starting from its predecessor, a TimeoutException is propagated to the observer. + + The type of the elements in the source sequence. + Source sequence to perform a timeout for. + Maximum duration between values before a timeout occurs. + The source sequence with a TimeoutException in case of a timeout. + + is null. + + is less than TimeSpan.Zero. + (Asynchronous) If no element is produced within from the previous element. + + + In case you only want to timeout on the first element, consider using the + operator applied to the source sequence and a delayed sequence. Alternatively, the general-purpose overload + of Timeout, can be used. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing timeout timers to be scheduled that are due + immediately. However, this doesn't guarantee a timeout will occur, even for the first element. This is a side-effect of the asynchrony introduced by the + scheduler, where the action to propagate a timeout may not execute immediately, despite the TimeSpan.Zero due time. In such cases, the next element may + arrive before the scheduler gets a chance to run the timeout action. + + + + + + Applies a timeout policy for each element in the observable sequence. + If the next element isn't received within the specified timeout duration starting from its predecessor, the other observable sequence is used to produce future messages from that point on. + + The type of the elements in the source sequence and the other sequence used upon a timeout. + Source sequence to perform a timeout for. + Maximum duration between values before a timeout occurs. + Sequence to return in case of a timeout. + The source sequence switching to the other sequence in case of a timeout. + + or is null. + + is less than TimeSpan.Zero. + + + In case you only want to timeout on the first element, consider using the + operator applied to the source sequence and a delayed sequence. Alternatively, the general-purpose overload + of Timeout, can be used. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing timeout timers to be scheduled that are due + immediately. However, this doesn't guarantee a timeout will occur, even for the first element. This is a side-effect of the asynchrony introduced by the + scheduler, where the action to propagate a timeout may not execute immediately, despite the TimeSpan.Zero due time. In such cases, the next element may + arrive before the scheduler gets a chance to run the timeout action. + + + + + + Applies a timeout policy for each element in the observable sequence, using the specified scheduler to run timeout timers. + If the next element isn't received within the specified timeout duration starting from its predecessor, the other observable sequence is used to produce future messages from that point on. + + The type of the elements in the source sequence and the other sequence used upon a timeout. + Source sequence to perform a timeout for. + Maximum duration between values before a timeout occurs. + Sequence to return in case of a timeout. + Scheduler to run the timeout timers on. + The source sequence switching to the other sequence in case of a timeout. + + or or is null. + + is less than TimeSpan.Zero. + + + In case you only want to timeout on the first element, consider using the + operator applied to the source sequence and a delayed sequence. Alternatively, the general-purpose overload + of Timeout, can be used. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing timeout timers to be scheduled that are due + immediately. However, this doesn't guarantee a timeout will occur, even for the first element. This is a side-effect of the asynchrony introduced by the + scheduler, where the action to propagate a timeout may not execute immediately, despite the TimeSpan.Zero due time. In such cases, the next element may + arrive before the scheduler gets a chance to run the timeout action. + + + + + + Applies a timeout policy for each element in the observable sequence, using the specified scheduler to run timeout timers. + If the next element isn't received within the specified timeout duration starting from its predecessor, a TimeoutException is propagated to the observer. + + The type of the elements in the source sequence. + Source sequence to perform a timeout for. + Maximum duration between values before a timeout occurs. + Scheduler to run the timeout timers on. + The source sequence with a TimeoutException in case of a timeout. + + or is null. + + is less than TimeSpan.Zero. + (Asynchronous) If no element is produced within from the previous element. + + + In case you only want to timeout on the first element, consider using the + operator applied to the source sequence and a delayed sequence. Alternatively, the general-purpose overload + of Timeout, can be used. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing timeout timers to be scheduled that are due + immediately. However, this doesn't guarantee a timeout will occur, even for the first element. This is a side-effect of the asynchrony introduced by the + scheduler, where the action to propagate a timeout may not execute immediately, despite the TimeSpan.Zero due time. In such cases, the next element may + arrive before the scheduler gets a chance to run the timeout action. + + + + + + Applies a timeout policy to the observable sequence based on an initial timeout duration for the first element, and a timeout duration computed for each subsequent element. + If the next element isn't received within the computed duration starting from its predecessor, a TimeoutException is propagated to the observer. + + The type of the elements in the source sequence. + The type of the elements in the timeout sequences used to indicate the timeout duration for each element in the source sequence. + Source sequence to perform a timeout for. + Observable sequence that represents the timeout for the first element. + Selector to retrieve an observable sequence that represents the timeout between the current element and the next element. + The source sequence with a TimeoutException in case of a timeout. + + or or is null. + + + + Applies a timeout policy to the observable sequence based on an initial timeout duration for the first element, and a timeout duration computed for each subsequent element. + If the next element isn't received within the computed duration starting from its predecessor, the other observable sequence is used to produce future messages from that point on. + + The type of the elements in the source sequence and the other sequence used upon a timeout. + The type of the elements in the timeout sequences used to indicate the timeout duration for each element in the source sequence. + Source sequence to perform a timeout for. + Observable sequence that represents the timeout for the first element. + Selector to retrieve an observable sequence that represents the timeout between the current element and the next element. + Sequence to return in case of a timeout. + The source sequence switching to the other sequence in case of a timeout. + + or or or is null. + + + + Applies a timeout policy to the observable sequence based on a timeout duration computed for each element. + If the next element isn't received within the computed duration starting from its predecessor, a TimeoutException is propagated to the observer. + + The type of the elements in the source sequence. + The type of the elements in the timeout sequences used to indicate the timeout duration for each element in the source sequence. + Source sequence to perform a timeout for. + Selector to retrieve an observable sequence that represents the timeout between the current element and the next element. + The source sequence with a TimeoutException in case of a timeout. + + or is null. + + + + Applies a timeout policy to the observable sequence based on a timeout duration computed for each element. + If the next element isn't received within the computed duration starting from its predecessor, the other observable sequence is used to produce future messages from that point on. + + The type of the elements in the source sequence and the other sequence used upon a timeout. + The type of the elements in the timeout sequences used to indicate the timeout duration for each element in the source sequence. + Source sequence to perform a timeout for. + Selector to retrieve an observable sequence that represents the timeout between the current element and the next element. + Sequence to return in case of a timeout. + The source sequence switching to the other sequence in case of a timeout. + + or or is null. + + + + Returns an observable sequence that produces a single value at the specified absolute due time. + + Query provider used to construct the data source. + Absolute time at which to produce the value. If this value is less than or equal to DateTimeOffset.UtcNow, the timer will fire as soon as possible. + An observable sequence that produces a value at due time. + + + + Returns an observable sequence that periodically produces a value starting at the specified initial absolute due time. + + Query provider used to construct the data source. + Absolute time at which to produce the first value. If this value is less than or equal to DateTimeOffset.UtcNow, the timer will fire as soon as possible. + Period to produce subsequent values. If this value is equal to TimeSpan.Zero, the timer will recur as fast as possible. + An observable sequence that produces a value at due time and then after each period. + + is less than TimeSpan.Zero. + + + + Returns an observable sequence that periodically produces a value starting at the specified initial absolute due time, using the specified scheduler to run timers. + + Query provider used to construct the data source. + Absolute time at which to produce the first value. If this value is less than or equal to DateTimeOffset.UtcNow, the timer will fire as soon as possible. + Period to produce subsequent values. If this value is equal to TimeSpan.Zero, the timer will recur as fast as possible. + Scheduler to run timers on. + An observable sequence that produces a value at due time and then after each period. + + is less than TimeSpan.Zero. + + is null. + + + + Returns an observable sequence that produces a single value at the specified absolute due time, using the specified scheduler to run the timer. + + Query provider used to construct the data source. + Absolute time at which to produce the value. If this value is less than or equal to DateTimeOffset.UtcNow, the timer will fire as soon as possible. + Scheduler to run the timer on. + An observable sequence that produces a value at due time. + + is null. + + + + Returns an observable sequence that produces a single value after the specified relative due time has elapsed. + + Query provider used to construct the data source. + Relative time at which to produce the value. If this value is less than or equal to TimeSpan.Zero, the timer will fire as soon as possible. + An observable sequence that produces a value after the due time has elapsed. + + + + Returns an observable sequence that periodically produces a value after the specified initial relative due time has elapsed. + + Query provider used to construct the data source. + Relative time at which to produce the first value. If this value is less than or equal to TimeSpan.Zero, the timer will fire as soon as possible. + Period to produce subsequent values. If this value is equal to TimeSpan.Zero, the timer will recur as fast as possible. + An observable sequence that produces a value after due time has elapsed and then after each period. + + is less than TimeSpan.Zero. + + + + Returns an observable sequence that periodically produces a value after the specified initial relative due time has elapsed, using the specified scheduler to run timers. + + Query provider used to construct the data source. + Relative time at which to produce the first value. If this value is less than or equal to TimeSpan.Zero, the timer will fire as soon as possible. + Period to produce subsequent values. If this value is equal to TimeSpan.Zero, the timer will recur as fast as possible. + Scheduler to run timers on. + An observable sequence that produces a value after due time has elapsed and then each period. + + is less than TimeSpan.Zero. + + is null. + + + + Returns an observable sequence that produces a single value after the specified relative due time has elapsed, using the specified scheduler to run the timer. + + Query provider used to construct the data source. + Relative time at which to produce the value. If this value is less than or equal to TimeSpan.Zero, the timer will fire as soon as possible. + Scheduler to run the timer on. + An observable sequence that produces a value after the due time has elapsed. + + is null. + + + + Timestamps each element in an observable sequence using the local system clock. + + The type of the elements in the source sequence. + Source sequence to timestamp elements for. + An observable sequence with timestamp information on elements. + + is null. + + + + Timestamp each element in an observable sequence using the clock of the specified scheduler. + + The type of the elements in the source sequence. + Source sequence to timestamp elements for. + Scheduler used to compute timestamps. + An observable sequence with timestamp information on elements. + + or is null. + + + + Creates an array from an observable sequence. + + The type of the elements in the source sequence. + The source observable sequence to get an array of elements for. + An observable sequence containing a single element with an array containing all the elements of the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Creates a dictionary from an observable sequence according to a specified key selector function. + + The type of the elements in the source sequence. + The type of the dictionary key computed for each element in the source sequence. + An observable sequence to create a dictionary for. + A function to extract a key from each element. + An observable sequence containing a single element with a dictionary mapping unique key values onto the corresponding source sequence's element. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Creates a dictionary from an observable sequence according to a specified key selector function, and a comparer. + + The type of the elements in the source sequence. + The type of the dictionary key computed for each element in the source sequence. + An observable sequence to create a dictionary for. + A function to extract a key from each element. + An equality comparer to compare keys. + An observable sequence containing a single element with a dictionary mapping unique key values onto the corresponding source sequence's element. + + or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Creates a dictionary from an observable sequence according to a specified key selector function, and an element selector function. + + The type of the elements in the source sequence. + The type of the dictionary key computed for each element in the source sequence. + The type of the dictionary value computed for each element in the source sequence. + An observable sequence to create a dictionary for. + A function to extract a key from each element. + A transform function to produce a result element value from each element. + An observable sequence containing a single element with a dictionary mapping unique key values onto the corresponding source sequence's element. + + or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Creates a dictionary from an observable sequence according to a specified key selector function, a comparer, and an element selector function. + + The type of the elements in the source sequence. + The type of the dictionary key computed for each element in the source sequence. + The type of the dictionary value computed for each element in the source sequence. + An observable sequence to create a dictionary for. + A function to extract a key from each element. + A transform function to produce a result element value from each element. + An equality comparer to compare keys. + An observable sequence containing a single element with a dictionary mapping unique key values onto the corresponding source sequence's element. + + or or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Converts an observable sequence to an enumerable sequence. + + The type of the elements in the source sequence. + An observable sequence to convert to an enumerable sequence. + The enumerable sequence containing the elements in the observable sequence. + + is null. + This operator requires the source's object (see ) to implement . + + + + Creates a list from an observable sequence. + + The type of the elements in the source sequence. + The source observable sequence to get a list of elements for. + An observable sequence containing a single element with a list containing all the elements of the source sequence. + + is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Creates a lookup from an observable sequence according to a specified key selector function. + + The type of the elements in the source sequence. + The type of the lookup key computed for each element in the source sequence. + An observable sequence to create a lookup for. + A function to extract a key from each element. + An observable sequence containing a single element with a lookup mapping unique key values onto the corresponding source sequence's elements. + + or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Creates a lookup from an observable sequence according to a specified key selector function, and a comparer. + + The type of the elements in the source sequence. + The type of the lookup key computed for each element in the source sequence. + An observable sequence to create a lookup for. + A function to extract a key from each element. + An equality comparer to compare keys. + An observable sequence containing a single element with a lookup mapping unique key values onto the corresponding source sequence's elements. + + or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Creates a lookup from an observable sequence according to a specified key selector function, and an element selector function. + + The type of the elements in the source sequence. + The type of the lookup key computed for each element in the source sequence. + The type of the lookup value computed for each element in the source sequence. + An observable sequence to create a lookup for. + A function to extract a key from each element. + A transform function to produce a result element value from each element. + An observable sequence containing a single element with a lookup mapping unique key values onto the corresponding source sequence's elements. + + or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Creates a lookup from an observable sequence according to a specified key selector function, a comparer, and an element selector function. + + The type of the elements in the source sequence. + The type of the lookup key computed for each element in the source sequence. + The type of the lookup value computed for each element in the source sequence. + An observable sequence to create a lookup for. + A function to extract a key from each element. + A transform function to produce a result element value from each element. + An equality comparer to compare keys. + An observable sequence containing a single element with a lookup mapping unique key values onto the corresponding source sequence's elements. + + or or or is null. + The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior. + + + + Converts an enumerable sequence to an observable sequence. + + Query provider used to construct the data source. + The type of the elements in the source sequence. + Enumerable sequence to convert to an observable sequence. + The observable sequence whose elements are pulled from the given enumerable sequence. + + is null. + + + + Converts an enumerable sequence to an observable sequence, using the specified scheduler to run the enumeration loop. + + Query provider used to construct the data source. + The type of the elements in the source sequence. + Enumerable sequence to convert to an observable sequence. + Scheduler to run the enumeration of the input sequence on. + The observable sequence whose elements are pulled from the given enumerable sequence. + + or is null. + + + + Constructs an observable sequence that depends on a resource object, whose lifetime is tied to the resulting observable sequence's lifetime. + + Query provider used to construct the data source. + The type of the elements in the produced sequence. + The type of the resource used during the generation of the resulting sequence. Needs to implement . + Factory function to obtain a resource object. + Factory function to obtain an observable sequence that depends on the obtained resource. + An observable sequence whose lifetime controls the lifetime of the dependent resource object. + + or is null. + + + + Constructs an observable sequence that depends on a resource object, whose lifetime is tied to the resulting observable sequence's lifetime. The resource is obtained and used through asynchronous methods. + The CancellationToken passed to the asynchronous methods is tied to the returned disposable subscription, allowing best-effort cancellation at any stage of the resource acquisition or usage. + + Query provider used to construct the data source. + The type of the elements in the produced sequence. + The type of the resource used during the generation of the resulting sequence. Needs to implement . + Asynchronous factory function to obtain a resource object. + Asynchronous factory function to obtain an observable sequence that depends on the obtained resource. + An observable sequence whose lifetime controls the lifetime of the dependent resource object. + + or is null. + This operator is especially useful in conjunction with the asynchronous programming features introduced in C# 5.0 and Visual Basic 11. + When a subscription to the resulting sequence is disposed, the CancellationToken that was fed to the asynchronous resource factory and observable factory functions will be signaled. + + + + Filters the elements of an observable sequence based on a predicate. + + The type of the elements in the source sequence. + An observable sequence whose elements to filter. + A function to test each source element for a condition. + An observable sequence that contains elements from the input sequence that satisfy the condition. + + or is null. + + + + Filters the elements of an observable sequence based on a predicate by incorporating the element's index. + + The type of the elements in the source sequence. + An observable sequence whose elements to filter. + A function to test each source element for a condition; the second parameter of the function represents the index of the source element. + An observable sequence that contains elements from the input sequence that satisfy the condition. + + or is null. + + + + Repeats the given as long as the specified holds, where the is evaluated before each repeated is subscribed to. + + Query provider used to construct the data source. + The type of the elements in the source sequence. + Source to repeat as long as the function evaluates to true. + Condition that will be evaluated before subscription to the , to determine whether repetition of the source is required. + The observable sequence obtained by concatenating the sequence as long as the holds. + + or is null. + + + + Projects each element of an observable sequence into consecutive non-overlapping windows which are produced based on element count information. + + The type of the elements in the source sequence, and in the windows in the result sequence. + Source sequence to produce windows over. + Length of each window. + An observable sequence of windows. + + is null. + + is less than or equal to zero. + + + + Projects each element of an observable sequence into zero or more windows which are produced based on element count information. + + The type of the elements in the source sequence, and in the windows in the result sequence. + Source sequence to produce windows over. + Length of each window. + Number of elements to skip between creation of consecutive windows. + An observable sequence of windows. + + is null. + + or is less than or equal to zero. + + + + Projects each element of an observable sequence into consecutive non-overlapping windows which are produced based on timing information. + + The type of the elements in the source sequence, and in the windows in the result sequence. + Source sequence to produce windows over. + Length of each window. + The sequence of windows. + + is null. + + is less than TimeSpan.Zero. + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create windows as fast as it can. + Because all source sequence elements end up in one of the windows, some windows won't have a zero time span. This is a side-effect of the asynchrony introduced + by the scheduler, where the action to close the current window and to create a new window may not execute immediately, despite the TimeSpan.Zero due time. + + + + + Projects each element of an observable sequence into a window that is completed when either it's full or a given amount of time has elapsed. + A useful real-world analogy of this overload is the behavior of a ferry leaving the dock when all seats are taken, or at the scheduled time of departure, whichever event occurs first. + + The type of the elements in the source sequence, and in the windows in the result sequence. + Source sequence to produce windows over. + Maximum time length of a window. + Maximum element count of a window. + An observable sequence of windows. + + is null. + + is less than TimeSpan.Zero. -or- is less than or equal to zero. + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create windows as fast as it can. + Because all source sequence elements end up in one of the windows, some windows won't have a zero time span. This is a side-effect of the asynchrony introduced + by the scheduler, where the action to close the current window and to create a new window may not execute immediately, despite the TimeSpan.Zero due time. + + + + + Projects each element of an observable sequence into a window that is completed when either it's full or a given amount of time has elapsed, using the specified scheduler to run timers. + A useful real-world analogy of this overload is the behavior of a ferry leaving the dock when all seats are taken, or at the scheduled time of departure, whichever event occurs first. + + The type of the elements in the source sequence, and in the windows in the result sequence. + Source sequence to produce windows over. + Maximum time length of a window. + Maximum element count of a window. + Scheduler to run windowing timers on. + An observable sequence of windows. + + or is null. + + is less than TimeSpan.Zero. -or- is less than or equal to zero. + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create windows as fast as it can. + Because all source sequence elements end up in one of the windows, some windows won't have a zero time span. This is a side-effect of the asynchrony introduced + by the scheduler, where the action to close the current window and to create a new window may not execute immediately, despite the TimeSpan.Zero due time. + + + + + Projects each element of an observable sequence into consecutive non-overlapping windows which are produced based on timing information, using the specified scheduler to run timers. + + The type of the elements in the source sequence, and in the windows in the result sequence. + Source sequence to produce windows over. + Length of each window. + Scheduler to run windowing timers on. + An observable sequence of windows. + + or is null. + + is less than TimeSpan.Zero. + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create windows as fast as it can. + Because all source sequence elements end up in one of the windows, some windows won't have a zero time span. This is a side-effect of the asynchrony introduced + by the scheduler, where the action to close the current window and to create a new window may not execute immediately, despite the TimeSpan.Zero due time. + + + + + Projects each element of an observable sequence into zero or more windows which are produced based on timing information. + + The type of the elements in the source sequence, and in the windows in the result sequence. + Source sequence to produce windows over. + Length of each window. + Interval between creation of consecutive windows. + An observable sequence of windows. + + is null. + + or is less than TimeSpan.Zero. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create windows with minimum duration + length. However, some windows won't have a zero time span. This is a side-effect of the asynchrony introduced by the scheduler, where the action to close the + current window may not execute immediately, despite the TimeSpan.Zero due time. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create windows as fast as it can. + However, this doesn't mean all windows will start at the beginning of the source sequence. This is a side-effect of the asynchrony introduced by the scheduler, + where the action to create a new window may not execute immediately, despite the TimeSpan.Zero due time. + + + + + + Projects each element of an observable sequence into zero or more windows which are produced based on timing information, using the specified scheduler to run timers. + + The type of the elements in the source sequence, and in the windows in the result sequence. + Source sequence to produce windows over. + Length of each window. + Interval between creation of consecutive windows. + Scheduler to run windowing timers on. + An observable sequence of windows. + + or is null. + + or is less than TimeSpan.Zero. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create windows with minimum duration + length. However, some windows won't have a zero time span. This is a side-effect of the asynchrony introduced by the scheduler, where the action to close the + current window may not execute immediately, despite the TimeSpan.Zero due time. + + + Specifying a TimeSpan.Zero value for is not recommended but supported, causing the scheduler to create windows as fast as it can. + However, this doesn't mean all windows will start at the beginning of the source sequence. This is a side-effect of the asynchrony introduced by the scheduler, + where the action to create a new window may not execute immediately, despite the TimeSpan.Zero due time. + + + + + + Projects each element of an observable sequence into consecutive non-overlapping windows. + + The type of the elements in the source sequence, and in the windows in the result sequence. + The type of the elements in the sequences indicating window boundary events. + Source sequence to produce windows over. + Sequence of window boundary markers. The current window is closed and a new window is opened upon receiving a boundary marker. + An observable sequence of windows. + + or is null. + + + + Projects each element of an observable sequence into consecutive non-overlapping windows. + + The type of the elements in the source sequence, and in the windows in the result sequence. + The type of the elements in the sequences indicating window closing events. + Source sequence to produce windows over. + A function invoked to define the boundaries of the produced windows. A new window is started when the previous one is closed. + An observable sequence of windows. + + or is null. + + + + Projects each element of an observable sequence into zero or more windows. + + The type of the elements in the source sequence, and in the windows in the result sequence. + The type of the elements in the sequence indicating window opening events, also passed to the closing selector to obtain a sequence of window closing events. + The type of the elements in the sequences indicating window closing events. + Source sequence to produce windows over. + Observable sequence whose elements denote the creation of new windows. + A function invoked to define the closing of each produced window. + An observable sequence of windows. + + or or is null. + + + + Merges two observable sequences into one observable sequence by combining each element from the first source with the latest element from the second source, if any. + Starting from Rx.NET 4.0, this will subscribe to before subscribing to to have a latest element readily available + in case emits an element right away. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Function to invoke for each element from the first source combined with the latest element from the second source, if any. + An observable sequence containing the result of combining each element of the first source with the latest element from the second source, if any, using the specified result selector function. + + or or is null. + + + + Merges the specified observable sequences into one observable sequence by emitting a list with the elements of the observable sequences at corresponding indexes. + + Query provider used to construct the data source. + The type of the elements in the source sequences, and in the lists in the result sequence. + Observable sources. + An observable sequence containing lists of elements at corresponding indexes. + + is null. + + + + Merges the specified observable sequences into one observable sequence by emitting a list with the elements of the observable sequences at corresponding indexes. + + Query provider used to construct the data source. + The type of the elements in the source sequences, and in the lists in the result sequence. + Observable sources. + An observable sequence containing lists of elements at corresponding indexes. + + is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + Query provider used to construct the data source. + The type of the elements in the source sequences. + The type of the elements in the result sequence, returned by the selector function. + Observable sources. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or is null. + + + + Merges two observable sequences into one observable sequence by combining their elements in a pairwise fashion. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Function to invoke for each consecutive pair of elements from the first and second source. + An observable sequence containing the result of pairwise combining the elements of the first and second source using the specified result selector function. + + or or is null. + + + + Merges an observable sequence and an enumerable sequence into one observable sequence by using the selector function. + + The type of the elements in the first observable source sequence. + The type of the elements in the second enumerable source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second enumerable source. + Function to invoke for each consecutive pair of elements from the first and second source. + An observable sequence containing the result of pairwise combining the elements of the first and second source using the specified result selector function. + + or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Eleventh observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Eleventh observable source. + Twelfth observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the thirteenth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Eleventh observable source. + Twelfth observable source. + Thirteenth observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the thirteenth source sequence. + The type of the elements in the fourteenth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Eleventh observable source. + Twelfth observable source. + Thirteenth observable source. + Fourteenth observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the thirteenth source sequence. + The type of the elements in the fourteenth source sequence. + The type of the elements in the fifteenth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Eleventh observable source. + Twelfth observable source. + Thirteenth observable source. + Fourteenth observable source. + Fifteenth observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or or or or or or or or or or or or is null. + + + + Merges the specified observable sequences into one observable sequence by using the selector function whenever all of the observable sequences have produced an element at a corresponding index. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the thirteenth source sequence. + The type of the elements in the fourteenth source sequence. + The type of the elements in the fifteenth source sequence. + The type of the elements in the sixteenth source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable source. + Second observable source. + Third observable source. + Fourth observable source. + Fifth observable source. + Sixth observable source. + Seventh observable source. + Eighth observable source. + Ninth observable source. + Tenth observable source. + Eleventh observable source. + Twelfth observable source. + Thirteenth observable source. + Fourteenth observable source. + Fifteenth observable source. + Sixteenth observable source. + Function to invoke for each series of elements at corresponding indexes in the sources. + An observable sequence containing the result of combining elements of the sources using the specified result selector function. + + or or or or or or or or or or or or or or or or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + Query provider used to construct the data source. + Action to convert to an asynchronous action. + Asynchronous action. + + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + Query provider used to construct the data source. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + The type of the eleventh argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + The type of the eleventh argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + The type of the eleventh argument passed to the action. + The type of the twelfth argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + The type of the eleventh argument passed to the action. + The type of the twelfth argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + The type of the eleventh argument passed to the action. + The type of the twelfth argument passed to the action. + The type of the thirteenth argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + The type of the eleventh argument passed to the action. + The type of the twelfth argument passed to the action. + The type of the thirteenth argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + The type of the eleventh argument passed to the action. + The type of the twelfth argument passed to the action. + The type of the thirteenth argument passed to the action. + The type of the fourteenth argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + The type of the eleventh argument passed to the action. + The type of the twelfth argument passed to the action. + The type of the thirteenth argument passed to the action. + The type of the fourteenth argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + The type of the eleventh argument passed to the action. + The type of the twelfth argument passed to the action. + The type of the thirteenth argument passed to the action. + The type of the fourteenth argument passed to the action. + The type of the fifteenth argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + The type of the eleventh argument passed to the action. + The type of the twelfth argument passed to the action. + The type of the thirteenth argument passed to the action. + The type of the fourteenth argument passed to the action. + The type of the fifteenth argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + + or is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the default scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + The type of the eleventh argument passed to the action. + The type of the twelfth argument passed to the action. + The type of the thirteenth argument passed to the action. + The type of the fourteenth argument passed to the action. + The type of the fifteenth argument passed to the action. + The type of the sixteenth argument passed to the action. + Action to convert to an asynchronous action. + Asynchronous action. + + is null. + + + + Converts the function into an asynchronous action. Each invocation of the resulting asynchronous action causes an invocation of the original synchronous action on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the action. + The type of the second argument passed to the action. + The type of the third argument passed to the action. + The type of the fourth argument passed to the action. + The type of the fifth argument passed to the action. + The type of the sixth argument passed to the action. + The type of the seventh argument passed to the action. + The type of the eighth argument passed to the action. + The type of the ninth argument passed to the action. + The type of the tenth argument passed to the action. + The type of the eleventh argument passed to the action. + The type of the twelfth argument passed to the action. + The type of the thirteenth argument passed to the action. + The type of the fourteenth argument passed to the action. + The type of the fifteenth argument passed to the action. + The type of the sixteenth argument passed to the action. + Action to convert to an asynchronous action. + Scheduler to invoke the original action on. + Asynchronous action. + + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + Query provider used to construct the data source. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + Query provider used to construct the data source. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the eleventh argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the eleventh argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the eleventh argument passed to the function. + The type of the twelfth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the eleventh argument passed to the function. + The type of the twelfth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the eleventh argument passed to the function. + The type of the twelfth argument passed to the function. + The type of the thirteenth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the eleventh argument passed to the function. + The type of the twelfth argument passed to the function. + The type of the thirteenth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the eleventh argument passed to the function. + The type of the twelfth argument passed to the function. + The type of the thirteenth argument passed to the function. + The type of the fourteenth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the eleventh argument passed to the function. + The type of the twelfth argument passed to the function. + The type of the thirteenth argument passed to the function. + The type of the fourteenth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the eleventh argument passed to the function. + The type of the twelfth argument passed to the function. + The type of the thirteenth argument passed to the function. + The type of the fourteenth argument passed to the function. + The type of the fifteenth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the eleventh argument passed to the function. + The type of the twelfth argument passed to the function. + The type of the thirteenth argument passed to the function. + The type of the fourteenth argument passed to the function. + The type of the fifteenth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + + or is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the eleventh argument passed to the function. + The type of the twelfth argument passed to the function. + The type of the thirteenth argument passed to the function. + The type of the fourteenth argument passed to the function. + The type of the fifteenth argument passed to the function. + The type of the sixteenth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Asynchronous function. + + is null. + + + + Converts the function into an asynchronous function. Each invocation of the resulting asynchronous function causes an invocation of the original synchronous function on the specified scheduler. + + Query provider used to construct the data source. + The type of the first argument passed to the function. + The type of the second argument passed to the function. + The type of the third argument passed to the function. + The type of the fourth argument passed to the function. + The type of the fifth argument passed to the function. + The type of the sixth argument passed to the function. + The type of the seventh argument passed to the function. + The type of the eighth argument passed to the function. + The type of the ninth argument passed to the function. + The type of the tenth argument passed to the function. + The type of the eleventh argument passed to the function. + The type of the twelfth argument passed to the function. + The type of the thirteenth argument passed to the function. + The type of the fourteenth argument passed to the function. + The type of the fifteenth argument passed to the function. + The type of the sixteenth argument passed to the function. + The type of the result returned by the function. + Function to convert to an asynchronous function. + Scheduler to invoke the original function on. + Asynchronous function. + + or is null. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the ninth argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the ninth argument passed to the begin delegate. + The type of the tenth argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the ninth argument passed to the begin delegate. + The type of the tenth argument passed to the begin delegate. + The type of the eleventh argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the ninth argument passed to the begin delegate. + The type of the tenth argument passed to the begin delegate. + The type of the eleventh argument passed to the begin delegate. + The type of the twelfth argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the ninth argument passed to the begin delegate. + The type of the tenth argument passed to the begin delegate. + The type of the eleventh argument passed to the begin delegate. + The type of the twelfth argument passed to the begin delegate. + The type of the thirteenth argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the ninth argument passed to the begin delegate. + The type of the tenth argument passed to the begin delegate. + The type of the eleventh argument passed to the begin delegate. + The type of the twelfth argument passed to the begin delegate. + The type of the thirteenth argument passed to the begin delegate. + The type of the fourteenth argument passed to the begin delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result (represented as a Unit value) as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the ninth argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the ninth argument passed to the begin delegate. + The type of the tenth argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the ninth argument passed to the begin delegate. + The type of the tenth argument passed to the begin delegate. + The type of the eleventh argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the ninth argument passed to the begin delegate. + The type of the tenth argument passed to the begin delegate. + The type of the eleventh argument passed to the begin delegate. + The type of the twelfth argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the ninth argument passed to the begin delegate. + The type of the tenth argument passed to the begin delegate. + The type of the eleventh argument passed to the begin delegate. + The type of the twelfth argument passed to the begin delegate. + The type of the thirteenth argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Converts a Begin/End invoke function pair into an asynchronous function. + + Query provider used to construct the data source. + The type of the first argument passed to the begin delegate. + The type of the second argument passed to the begin delegate. + The type of the third argument passed to the begin delegate. + The type of the fourth argument passed to the begin delegate. + The type of the fifth argument passed to the begin delegate. + The type of the sixth argument passed to the begin delegate. + The type of the seventh argument passed to the begin delegate. + The type of the eighth argument passed to the begin delegate. + The type of the ninth argument passed to the begin delegate. + The type of the tenth argument passed to the begin delegate. + The type of the eleventh argument passed to the begin delegate. + The type of the twelfth argument passed to the begin delegate. + The type of the thirteenth argument passed to the begin delegate. + The type of the fourteenth argument passed to the begin delegate. + The type of the result returned by the end delegate. + The delegate that begins the asynchronous operation. + The delegate that ends the asynchronous operation. + Function that can be used to start the asynchronous operation and retrieve the result as an observable sequence. + + or is null. + Each invocation of the resulting function will cause the asynchronous operation to be started. Subscription to the resulting sequence has no observable side-effect, and each subscription will produce the asynchronous operation's result. + + + + Creates a pattern that matches when both observable sequences have an available element. + + The type of the elements in the left sequence. + The type of the elements in the right sequence. + Observable sequence to match with the right sequence. + Observable sequence to match with the left sequence. + Pattern object that matches when both observable sequences have an available element. + or is null. + + + + Matches when the observable sequence has an available element and projects the element by invoking the selector function. + + The type of the elements in the source sequence. + The type of the elements in the result sequence, returned by the selector function. + Observable sequence to apply the selector on. + Selector that will be invoked for elements in the source sequence. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + or is null. + + + + Joins together the results from several patterns. + + The type of the elements in the result sequence, obtained from the specified patterns. + Query provider used to construct the data source. + A series of plans created by use of the Then operator on patterns. + An observable sequence with the results from matching several patterns. + or is null. + + + + Joins together the results from several patterns. + + The type of the elements in the result sequence, obtained from the specified patterns. + Query provider used to construct the data source. + A series of plans created by use of the Then operator on patterns. + An observable sequence with the results form matching several patterns. + or is null. + + + + Provides a set of static methods for writing in-memory queries over observable sequences. + + + + + Subscribes to each observable sequence returned by the iteratorMethod in sequence and returns the observable sequence of values sent to the observer given to the iteratorMethod. + + The type of the elements in the produced sequence. + Iterator method that produces elements in the resulting sequence by calling the given observer. + An observable sequence obtained by running the iterator and returning the elements that were sent to the observer. + is null. + + + + Subscribes to each observable sequence returned by the iteratorMethod in sequence and produces a Unit value on the resulting sequence for each step of the iteration. + + Iterator method that drives the resulting observable sequence. + An observable sequence obtained by running the iterator and returning Unit values for each iteration step. + is null. + + + + Expands an observable sequence by recursively invoking selector, using the specified scheduler to enumerate the queue of obtained sequences. + + The type of the elements in the source sequence and each of the recursively expanded sources obtained by running the selector function. + Source sequence with the initial elements. + Selector function to invoke for each produced element, resulting in another sequence to which the selector will be invoked recursively again. + Scheduler on which to perform the expansion by enumerating the internal queue of obtained sequences. + An observable sequence containing all the elements produced by the recursive expansion. + or or is null. + + + + Expands an observable sequence by recursively invoking selector. + + The type of the elements in the source sequence and each of the recursively expanded sources obtained by running the selector function. + Source sequence with the initial elements. + Selector function to invoke for each produced element, resulting in another sequence to which the selector will be invoked recursively again. + An observable sequence containing all the elements produced by the recursive expansion. + or is null. + + + + Runs two observable sequences in parallel and combines their last elements. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable sequence. + Second observable sequence. + Result selector function to invoke with the last elements of both sequences. + An observable sequence with the result of calling the selector function with the last elements of both input sequences. + or or is null. + + + + Runs all specified observable sequences in parallel and collects their last elements. + + The type of the elements in the source sequences. + Observable sequence to collect the last elements for. + An observable sequence with an array collecting the last elements of all the input sequences. + is null. + + + + Runs all observable sequences in the enumerable sources sequence in parallel and collect their last elements. + + The type of the elements in the source sequences. + Observable sequence to collect the last elements for. + An observable sequence with an array collecting the last elements of all the input sequences. + is null. + + + + Returns an observable sequence that is the result of invoking the selector on the source sequence, without sharing subscriptions. + This operator allows for a fluent style of writing queries that use the same sequence multiple times. + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence that will be shared in the selector function. + Selector function which can use the source sequence as many times as needed, without sharing subscriptions to the source sequence. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + or is null. + + + + Comonadic bind operator. + + + + + Comonadic bind operator. + + + + + Immediately subscribes to source and retains the elements in the observable sequence. + + The type of the elements in the source sequence. + Source sequence. + Object that's both an observable sequence and a list which can be used to access the source sequence's elements. + is null. + + + + Try winning the race for the right of emission. + + If true, the contender is the left source. + True if the contender has won the race. + + + + If true, this observer won the race and now can emit + on a fast path. + + + + + Automatically connect the upstream IConnectableObservable once the + specified number of IObservers have subscribed to this IObservable. + + The upstream value type. + + + + The only instance for a TResult type: this source + is completely stateless and has a constant behavior. + + + + + No need for instantiating this more than once per TResult. + + + + + Contains the current active connection's state or null + if no connection is active at the moment. + Should be manipulated while holding the lock. + + + + + Contains the connection reference the downstream observer + has subscribed to. Its purpose is to + avoid subscribing, connecting and disconnecting + while holding a lock. + + + + + Holds an individual connection state: the observer count and + the connection's IDisposable. + + + + + Relays items to the downstream until the predicate returns true. + + The element type of the sequence + + + + Provides a set of static methods for writing queries over observable sequences, allowing translation to a target query language. + + + + + Subscribes to each observable sequence returned by the iteratorMethod in sequence and produces a Unit value on the resulting sequence for each step of the iteration. + + Query provider used to construct the data source. + Iterator method that drives the resulting observable sequence. + An observable sequence obtained by running the iterator and returning Unit values for each iteration step. + + is null. + + + + Subscribes to each observable sequence returned by the iteratorMethod in sequence and returns the observable sequence of values sent to the observer given to the iteratorMethod. + + Query provider used to construct the data source. + The type of the elements in the produced sequence. + Iterator method that produces elements in the resulting sequence by calling the given observer. + An observable sequence obtained by running the iterator and returning the elements that were sent to the observer. + + is null. + + + + Expands an observable sequence by recursively invoking selector. + + The type of the elements in the source sequence and each of the recursively expanded sources obtained by running the selector function. + Source sequence with the initial elements. + Selector function to invoke for each produced element, resulting in another sequence to which the selector will be invoked recursively again. + An observable sequence containing all the elements produced by the recursive expansion. + + or is null. + + + + Expands an observable sequence by recursively invoking selector, using the specified scheduler to enumerate the queue of obtained sequences. + + The type of the elements in the source sequence and each of the recursively expanded sources obtained by running the selector function. + Source sequence with the initial elements. + Selector function to invoke for each produced element, resulting in another sequence to which the selector will be invoked recursively again. + Scheduler on which to perform the expansion by enumerating the internal queue of obtained sequences. + An observable sequence containing all the elements produced by the recursive expansion. + + or or is null. + + + + Runs all specified observable sequences in parallel and collects their last elements. + + Query provider used to construct the data source. + The type of the elements in the source sequences. + Observable sequence to collect the last elements for. + An observable sequence with an array collecting the last elements of all the input sequences. + + is null. + + + + Runs all observable sequences in the enumerable sources sequence in parallel and collect their last elements. + + Query provider used to construct the data source. + The type of the elements in the source sequences. + Observable sequence to collect the last elements for. + An observable sequence with an array collecting the last elements of all the input sequences. + + is null. + + + + Runs two observable sequences in parallel and combines their last elements. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the result sequence, returned by the selector function. + First observable sequence. + Second observable sequence. + Result selector function to invoke with the last elements of both sequences. + An observable sequence with the result of calling the selector function with the last elements of both input sequences. + + or or is null. + + + + Returns an observable sequence that is the result of invoking the selector on the source sequence, without sharing subscriptions. + This operator allows for a fluent style of writing queries that use the same sequence multiple times. + + The type of the elements in the source sequence. + The type of the elements in the result sequence. + Source sequence that will be shared in the selector function. + Selector function which can use the source sequence as many times as needed, without sharing subscriptions to the source sequence. + An observable sequence that contains the elements of a sequence produced by multicasting the source sequence within a selector function. + + or is null. + + + + Comonadic bind operator. + + + + + Comonadic bind operator. + + + + + (Infrastructure) Implement query debugger services. + + + + + The System.Reactive.Linq namespace contains interfaces and classes that support expressing queries over observable sequences, using Language Integrated Query (LINQ). + Query operators are made available as extension methods for and defined on the Observable and Qbservable classes, respectively. + + + + + Provides a set of static methods for subscribing to IObservables using Windows Forms controls. + + + + + Wraps the source sequence in order to run its subscription and unsubscription logic on the Windows Forms message loop associated with the specified control. + + The type of the elements in the source sequence. + Source sequence. + Windows Forms control whose associated message loop is used to perform subscription and unsubscription actions on. + The source sequence whose subscriptions and unsubscriptions happen on the Windows Forms message loop associated with the specified control. + or is null. + + Only the side-effects of subscribing to the source sequence and disposing subscriptions to the source sequence are run on the specified control. + In order to invoke observer callbacks on the specified control, e.g. to render results in a control, use . + + + + + Wraps the source sequence in order to run its observer callbacks on the Windows Forms message loop associated with the specified control. + + The type of the elements in the source sequence. + Source sequence. + Windows Forms control whose associated message loop is used to notify observers on. + The source sequence whose observations happen on the Windows Forms message loop associated with the specified control. + or is null. + + + + Provides a set of extension methods for scheduling actions performed through observable sequences on UI dispatchers. + + + + + Wraps the source sequence in order to run its observer callbacks on the specified dispatcher. + + The type of the elements in the source sequence. + Source sequence. + Dispatcher whose associated message loop is used to notify observers on. + The source sequence whose observations happen on the specified dispatcher. + or is null. + + + + Wraps the source sequence in order to run its observer callbacks on the specified dispatcher. + + The type of the elements in the source sequence. + Source sequence. + Dispatcher whose associated message loop is used to notify observers on. + Priority to schedule work items at. + The source sequence whose observations happen on the specified dispatcher. + or is null. + + + + Wraps the source sequence in order to run its observer callbacks on the specified dispatcher scheduler. + + The type of the elements in the source sequence. + Source sequence. + Dispatcher scheduler to notify observers on. + The source sequence whose observations happen on the specified dispatcher scheduler. + or is null. + + + + Wraps the source sequence in order to run its observer callbacks on the dispatcher associated with the specified object. + + The type of the elements in the source sequence. + Source sequence. + Object to get the dispatcher from. + The source sequence whose observations happen on the specified object's dispatcher. + or is null. + + + + Wraps the source sequence in order to run its observer callbacks on the dispatcher associated with the specified object. + + The type of the elements in the source sequence. + Source sequence. + Object to get the dispatcher from. + Priority to schedule work items at. + The source sequence whose observations happen on the specified object's dispatcher. + or is null. + + + + Wraps the source sequence in order to run its observer callbacks on the dispatcher associated with the current thread. + + The type of the elements in the source sequence. + Source sequence. + The source sequence whose observations happen on the current thread's dispatcher. + is null. + + + + Wraps the source sequence in order to run its observer callbacks on the dispatcher associated with the current thread. + + The type of the elements in the source sequence. + Source sequence. + Priority to schedule work items at. + The source sequence whose observations happen on the current thread's dispatcher. + is null. + + + + Wraps the source sequence in order to run its subscription and unsubscription logic on the specified dispatcher. + + The type of the elements in the source sequence. + Source sequence. + Dispatcher whose associated message loop is used to perform subscription and unsubscription actions on. + The source sequence whose subscriptions and unsubscriptions happen on the specified dispatcher. + or is null. + + Only the side-effects of subscribing to the source sequence and disposing subscriptions to the source sequence are run on the specified dispatcher. + In order to invoke observer callbacks on the specified dispatcher, e.g. to render results in a control, use . + + + + + Wraps the source sequence in order to run its subscription and unsubscription logic on the specified dispatcher. + + The type of the elements in the source sequence. + Source sequence. + Dispatcher whose associated message loop is used to to perform subscription and unsubscription actions on. + Priority to schedule work items at. + The source sequence whose subscriptions and unsubscriptions happen on the specified dispatcher. + or is null. + + Only the side-effects of subscribing to the source sequence and disposing subscriptions to the source sequence are run on the specified dispatcher. + In order to invoke observer callbacks on the specified dispatcher, e.g. to render results in a control, use . + + + + + Wraps the source sequence in order to run its subscription and unsubscription logic on the specified dispatcher scheduler. + + The type of the elements in the source sequence. + Source sequence. + Dispatcher scheduler to perform subscription and unsubscription actions on. + The source sequence whose subscriptions and unsubscriptions happen on the specified dispatcher scheduler. + or is null. + + Only the side-effects of subscribing to the source sequence and disposing subscriptions to the source sequence are run on the specified scheduler. + In order to invoke observer callbacks on the specified scheduler, e.g. to render results in a control, use . + + + + + Wraps the source sequence in order to run its subscription and unsubscription logic on the dispatcher associated with the specified object. + + The type of the elements in the source sequence. + Source sequence. + Object to get the dispatcher from. + The source sequence whose subscriptions and unsubscriptions happen on the specified object's dispatcher. + or is null. + + Only the side-effects of subscribing to the source sequence and disposing subscriptions to the source sequence are run on the dispatcher associated with the specified object. + In order to invoke observer callbacks on the dispatcher associated with the specified object, e.g. to render results in a control, use . + + + + + Wraps the source sequence in order to run its subscription and unsubscription logic on the dispatcher associated with the specified object. + + The type of the elements in the source sequence. + Source sequence. + Object to get the dispatcher from. + Priority to schedule work items at. + The source sequence whose subscriptions and unsubscriptions happen on the specified object's dispatcher. + or is null. + + Only the side-effects of subscribing to the source sequence and disposing subscriptions to the source sequence are run on the dispatcher associated with the specified object. + In order to invoke observer callbacks on the dispatcher associated with the specified object, e.g. to render results in a control, use . + + + + + Wraps the source sequence in order to run its subscription and unsubscription logic on the dispatcher associated with the current thread. + + The type of the elements in the source sequence. + Source sequence. + The source sequence whose subscriptions and unsubscriptions happen on the current thread's dispatcher. + is null. + + Only the side-effects of subscribing to the source sequence and disposing subscriptions to the source sequence are run on the dispatcher associated with the current thread. + In order to invoke observer callbacks on the dispatcher associated with the current thread, e.g. to render results in a control, use . + + + + + Wraps the source sequence in order to run its subscription and unsubscription logic on the dispatcher associated with the current thread. + + The type of the elements in the source sequence. + Source sequence. + Priority to schedule work items at. + The source sequence whose observations happen on the current thread's dispatcher. + is null. + + Only the side-effects of subscribing to the source sequence and disposing subscriptions to the source sequence are run on the dispatcher associated with the current thread. + In order to invoke observer callbacks on the dispatcher associated with the current thread, e.g. to render results in a control, use . + + + + + Provides a set of static methods for exposing observable sequences through .NET Remoting. + + + + + Makes an observable sequence remotable, using an infinite lease for the wrapping the source. + + The type of the elements in the source sequence. + Source sequence. + The observable sequence that supports remote subscriptions. + is null. + + + + Makes an observable sequence remotable, using a controllable lease for the wrapping the source. + + The type of the elements in the source sequence. + Source sequence. + Lease object to control lifetime of the remotable sequence. Notice null is a supported value. + The observable sequence that supports remote subscriptions. + is null. + + + + Makes an observable sequence remotable, using an infinite lease for the wrapping the source. + + The type of the elements in the source sequence. + Source sequence. + The observable sequence that supports remote subscriptions. + is null. + + + + Makes an observable sequence remotable, using a controllable lease for the wrapping the source. + + The type of the elements in the source sequence. + Source sequence. + Lease object to control lifetime of the remotable sequence. Notice null is a supported value. + The observable sequence that supports remote subscriptions. + is null. + + + + An ObserveOn operator implementation that uses lock-free + techniques to signal events to the downstream. + + The element type of the sequence. + + + + The current task representing a running drain operation. + + + + + Indicates the work-in-progress state of this operator, + zero means no work is currently being done. + + + + + If true, the upstream has issued OnCompleted. + + + + + If is true and this is non-null, the upstream + failed with an OnError. + + + + + Indicates a dispose has been requested. + + + + + Remove remaining elements from the queue upon + cancellation or failure. + + The queue to use. The argument ensures that the + _queue field is not re-read from memory unnecessarily + due to the memory barriers inside TryDequeue mandating it + despite the field is read-only. + + + + Submit the drain task via the appropriate scheduler if + there is no drain currently running (wip > 0). + + + + + The static action to be scheduled on a simple scheduler. + Avoids creating a delegate that captures this + whenever the signals have to be drained. + + + + + Emits at most one signal per run on a scheduler that doesn't like + long running tasks. + + The scheduler to use for scheduling the next signal emission if necessary. + The IDisposable of the recursively scheduled task or an empty disposable. + + + + Executes a drain step by checking the disposed state, + checking for the terminated state and for an + empty queue, issuing the appropriate signals to the + given downstream. + + The queue to use. The argument ensures that the + _queue field is not re-read from memory due to the memory barriers + inside TryDequeue mandating it despite the field is read-only. + In addition, the DrainStep is invoked from the DrainLongRunning's loop + so reading _queue inside this method would still incur the same barrier + overhead otherwise. + + + + Signals events on a ISchedulerLongRunning by blocking the emission thread while waiting + for them from the upstream. + + The element type of the sequence. + + + + This will run a suspending drain task, hogging the backing thread + until the sequence terminates or gets disposed. + + + + + The queue for holding the OnNext items, terminal signals have their own fields. + + + + + Protects the suspension and resumption of the long running drain task. + + + + + The work-in-progress counter. If it jumps from 0 to 1, the drain task is resumed, + if it reaches 0 again, the drain task is suspended. + + + + + Set to true if the upstream terminated. + + + + + Set to a non-null Exception if the upstream terminated with OnError. + + + + + Indicates the sequence has been disposed and the drain task should quit. + + + + + Makes sure the drain task is scheduled only once, when the first signal + from upstream arrives. + + + + + The disposable tracking the drain task. + + + + + Static reference to the Drain method, saves allocation. + + + + + Override this method to dispose additional resources. + The method is guaranteed to be called at most once. + + If true, the method was called from . + + + + Base class for implementation of query operators, providing a lightweight sink that can be disposed to mute the outgoing observer. + + Type of the resulting sequence's elements. + + Implementations of sinks are responsible to enforce the message grammar on the associated observer. Upon sending a terminal message, a pairing Dispose call should be made to trigger cancellation of related resources and to mute the outgoing observer. + + + + Holds onto a singleton IDisposable indicating a ready state. + + + + + This indicates the operation has been prepared and ready for + the next step. + + + + + Provides a mechanism for receiving push-based notifications and returning a response. + + + The type of the elements received by the observer. + This type parameter is contravariant. That is, you can use either the type you specified or any type that is less derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics. + + + The type of the result returned from the observer's notification handlers. + This type parameter is covariant. That is, you can use either the type you specified or any type that is more derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics. + + + + + Notifies the observer of a new element in the sequence. + + The new element in the sequence. + Result returned upon observation of a new element. + + + + Notifies the observer that an exception has occurred. + + The exception that occurred. + Result returned upon observation of an error. + + + + Notifies the observer of the end of the sequence. + + Result returned upon observation of the sequence completion. + + + + Abstract base class for join patterns. + + + + + Represents a join pattern over one observable sequence. + + The type of the elements in the first source sequence. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over two observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + + + + Creates a pattern that matches when all three observable sequences have an available element. + + The type of the elements in the third observable sequence. + Observable sequence to match with the two previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over three observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + + + + Creates a pattern that matches when all four observable sequences have an available element. + + The type of the elements in the fourth observable sequence. + Observable sequence to match with the three previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over four observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + + + + Creates a pattern that matches when all five observable sequences have an available element. + + The type of the elements in the fifth observable sequence. + Observable sequence to match with the four previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over five observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + + + + Creates a pattern that matches when all six observable sequences have an available element. + + The type of the elements in the sixth observable sequence. + Observable sequence to match with the five previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over six observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + + + + Creates a pattern that matches when all seven observable sequences have an available element. + + The type of the elements in the seventh observable sequence. + Observable sequence to match with the six previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over seven observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + + + + Creates a pattern that matches when all eight observable sequences have an available element. + + The type of the elements in the eighth observable sequence. + Observable sequence to match with the seven previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over eight observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + + + + Creates a pattern that matches when all nine observable sequences have an available element. + + The type of the elements in the ninth observable sequence. + Observable sequence to match with the eight previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over nine observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + + + + Creates a pattern that matches when all ten observable sequences have an available element. + + The type of the elements in the tenth observable sequence. + Observable sequence to match with the nine previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over ten observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + + + + Creates a pattern that matches when all eleven observable sequences have an available element. + + The type of the elements in the eleventh observable sequence. + Observable sequence to match with the ten previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over eleven observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + + + + Creates a pattern that matches when all twelve observable sequences have an available element. + + The type of the elements in the twelfth observable sequence. + Observable sequence to match with the eleven previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over twelve observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + + + + Creates a pattern that matches when all thirteen observable sequences have an available element. + + The type of the elements in the thirteenth observable sequence. + Observable sequence to match with the twelve previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over thirteen observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the thirteenth source sequence. + + + + Creates a pattern that matches when all fourteen observable sequences have an available element. + + The type of the elements in the fourteenth observable sequence. + Observable sequence to match with the thirteen previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over fourteen observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the thirteenth source sequence. + The type of the elements in the fourteenth source sequence. + + + + Creates a pattern that matches when all fifteen observable sequences have an available element. + + The type of the elements in the fifteenth observable sequence. + Observable sequence to match with the fourteen previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over fifteen observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the thirteenth source sequence. + The type of the elements in the fourteenth source sequence. + The type of the elements in the fifteenth source sequence. + + + + Creates a pattern that matches when all sixteen observable sequences have an available element. + + The type of the elements in the sixteenth observable sequence. + Observable sequence to match with the fifteen previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over sixteen observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the thirteenth source sequence. + The type of the elements in the fourteenth source sequence. + The type of the elements in the fifteenth source sequence. + The type of the elements in the sixteenth source sequence. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents an execution plan for join patterns. + + The type of the results produced by the plan. + + + + Abstract base class for join patterns represented by an expression tree. + + + + + Creates a new join pattern object using the specified expression tree representation. + + Expression tree representing the join pattern. + + + + Gets the expression tree representing the join pattern. + + + + + Represents a join pattern over two observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + + + + Creates a pattern that matches when all three observable sequences have an available element. + + The type of the elements in the third observable sequence. + Observable sequence to match with the two previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over three observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + + + + Creates a pattern that matches when all four observable sequences have an available element. + + The type of the elements in the fourth observable sequence. + Observable sequence to match with the three previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over four observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + + + + Creates a pattern that matches when all five observable sequences have an available element. + + The type of the elements in the fifth observable sequence. + Observable sequence to match with the four previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over five observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + + + + Creates a pattern that matches when all six observable sequences have an available element. + + The type of the elements in the sixth observable sequence. + Observable sequence to match with the five previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over six observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + + + + Creates a pattern that matches when all seven observable sequences have an available element. + + The type of the elements in the seventh observable sequence. + Observable sequence to match with the six previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over seven observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + + + + Creates a pattern that matches when all eight observable sequences have an available element. + + The type of the elements in the eighth observable sequence. + Observable sequence to match with the seven previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over eight observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + + + + Creates a pattern that matches when all nine observable sequences have an available element. + + The type of the elements in the ninth observable sequence. + Observable sequence to match with the eight previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over nine observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + + + + Creates a pattern that matches when all ten observable sequences have an available element. + + The type of the elements in the tenth observable sequence. + Observable sequence to match with the nine previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over ten observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + + + + Creates a pattern that matches when all eleven observable sequences have an available element. + + The type of the elements in the eleventh observable sequence. + Observable sequence to match with the ten previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over eleven observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + + + + Creates a pattern that matches when all twelve observable sequences have an available element. + + The type of the elements in the twelfth observable sequence. + Observable sequence to match with the eleven previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over twelve observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + + + + Creates a pattern that matches when all thirteen observable sequences have an available element. + + The type of the elements in the thirteenth observable sequence. + Observable sequence to match with the twelve previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over thirteen observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the thirteenth source sequence. + + + + Creates a pattern that matches when all fourteen observable sequences have an available element. + + The type of the elements in the fourteenth observable sequence. + Observable sequence to match with the thirteen previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over fourteen observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the thirteenth source sequence. + The type of the elements in the fourteenth source sequence. + + + + Creates a pattern that matches when all fifteen observable sequences have an available element. + + The type of the elements in the fifteenth observable sequence. + Observable sequence to match with the fourteen previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over fifteen observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the thirteenth source sequence. + The type of the elements in the fourteenth source sequence. + The type of the elements in the fifteenth source sequence. + + + + Creates a pattern that matches when all sixteen observable sequences have an available element. + + The type of the elements in the sixteenth observable sequence. + Observable sequence to match with the fifteen previous sequences. + Pattern object that matches when all observable sequences have an available element. + is null. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents a join pattern over sixteen observable sequences. + + The type of the elements in the first source sequence. + The type of the elements in the second source sequence. + The type of the elements in the third source sequence. + The type of the elements in the fourth source sequence. + The type of the elements in the fifth source sequence. + The type of the elements in the sixth source sequence. + The type of the elements in the seventh source sequence. + The type of the elements in the eighth source sequence. + The type of the elements in the ninth source sequence. + The type of the elements in the tenth source sequence. + The type of the elements in the eleventh source sequence. + The type of the elements in the twelfth source sequence. + The type of the elements in the thirteenth source sequence. + The type of the elements in the fourteenth source sequence. + The type of the elements in the fifteenth source sequence. + The type of the elements in the sixteenth source sequence. + + + + Matches when all observable sequences have an available element and projects the elements by invoking the selector function. + + The type of the elements in the result sequence, returned by the selector function. + Selector that will be invoked for elements in the source sequences. + Plan that produces the projected results, to be fed (with other plans) to the When operator. + is null. + + + + Represents an execution plan for join patterns represented by an expression tree. + + The type of the results produced by the plan. + + + + Gets the expression tree representing the join pattern execution plan. + + + + + The System.Reactive.Joins namespace contains classes used to express join patterns over observable sequences using fluent method syntax. + + + + + Represents an object that retains the elements of the observable sequence and signals the end of the sequence. + + The type of elements received from the source sequence. + + + + Constructs an object that retains the values of source and signals the end of the sequence. + + The observable sequence whose elements will be retained in the list. + is null. + + + + Returns the last value of the observable sequence. + + + + + Determines the index of a specific item in the ListObservable. + + The element to determine the index for. + The index of the specified item in the list; -1 if not found. + + + + Inserts an item to the ListObservable at the specified index. + + The index to insert the item at. + The item to insert in the list. + + + + Removes the ListObservable item at the specified index. + + The index of the item to remove. + + + + Gets or sets the element at the specified index. + + The index of the item to retrieve or set. + + + + Adds an item to the ListObservable. + + The item to add to the list. + + + + Removes all items from the ListObservable. + + + + + Determines whether the ListObservable contains a specific value. + + The item to search for in the list. + true if found; false otherwise. + + + + Copies the elements of the ListObservable to an System.Array, starting at a particular System.Array index. + + The array to copy elements to. + The start index in the array to start copying elements to. + + + + Gets the number of elements contained in the ListObservable. + + + + + Gets a value that indicates whether the ListObservable is read-only. + + + + + Removes the first occurrence of a specific object from the ListObservable. + + The item to remove from the list. + true if the item was found; false otherwise. + + + + Returns an enumerator that iterates through the collection. + + Enumerator over the list. + + + + Subscribes an observer to the ListObservable which will be notified upon completion. + + The observer to send completion or error messages to. + The disposable resource that can be used to unsubscribe. + is null. + + + + The System.Reactive namespace contains interfaces and classes used throughout the Reactive Extensions library. + + + + + The System.Reactive.Subjects namespace contains interfaces and classes to represent subjects, which are objects implementing both and . + Subjects are often used as sources of events, allowing one party to raise events and allowing another party to write queries over the event stream. Because of their ability to + have multiple registered observers, subjects are also used as a facility to provide multicast behavior for event streams in queries. + + + + + Represents the result of an asynchronous operation. + The last value before the OnCompleted notification, or the error received through OnError, is sent to all subscribed observers. + + The type of the elements processed by the subject. + + + + A pre-allocated empty array indicating the AsyncSubject has terminated + + + + + A pre-allocated empty array indicating the AsyncSubject has terminated + + + + + Creates a subject that can only receive one value and that value is cached for all future observations. + + + + + Indicates whether the subject has observers subscribed to it. + + + + + Indicates whether the subject has been disposed. + + + + + Notifies all subscribed observers about the end of the sequence, also causing the last received value to be sent out (if any). + + + + + Notifies all subscribed observers about the exception. + + The exception to send to all observers. + is null. + + + + Sends a value to the subject. The last value received before successful termination will be sent to all subscribed and future observers. + + The value to store in the subject. + + + + Subscribes an observer to the subject. + + Observer to subscribe to the subject. + Disposable object that can be used to unsubscribe the observer from the subject. + is null. + + + + A disposable connecting the AsyncSubject and an IObserver. + + + + + Unsubscribe all observers and release resources. + + + + + Gets an awaitable object for the current AsyncSubject. + + Object that can be awaited. + + + + Specifies a callback action that will be invoked when the subject completes. + + Callback action that will be invoked when the subject completes. + is null. + + + + Gets whether the AsyncSubject has completed. + + + + + Gets the last element of the subject, potentially blocking until the subject completes successfully or exceptionally. + + The last element of the subject. Throws an InvalidOperationException if no element was received. + The source sequence is empty. + + + + Represents a value that changes over time. + Observers can subscribe to the subject to receive the last (or initial) value and all subsequent notifications. + + The type of the elements processed by the subject. + + + + Initializes a new instance of the class which creates a subject that caches its last value and starts with the specified value. + + Initial value sent to observers when no other value has been received by the subject yet. + + + + Indicates whether the subject has observers subscribed to it. + + + + + Indicates whether the subject has been disposed. + + + + + Gets the current value or throws an exception. + + The initial value passed to the constructor until is called; after which, the last value passed to . + + is frozen after is called. + After is called, always throws the specified exception. + An exception is always thrown after is called. + + Reading is a thread-safe operation, though there's a potential race condition when or are being invoked concurrently. + In some cases, it may be necessary for a caller to use external synchronization to avoid race conditions. + + + Dispose was called. + + + + Tries to get the current value or throws an exception. + + The initial value passed to the constructor until is called; after which, the last value passed to . + true if a value is available; false if the subject was disposed. + + The value returned from is frozen after is called. + After is called, always throws the specified exception. + + Calling is a thread-safe operation, though there's a potential race condition when or are being invoked concurrently. + In some cases, it may be necessary for a caller to use external synchronization to avoid race conditions. + + + + + + Notifies all subscribed observers about the end of the sequence. + + + + + Notifies all subscribed observers about the exception. + + The exception to send to all observers. + is null. + + + + Notifies all subscribed observers about the arrival of the specified element in the sequence. + + The value to send to all observers. + + + + Subscribes an observer to the subject. + + Observer to subscribe to the subject. + Disposable object that can be used to unsubscribe the observer from the subject. + is null. + + + + Unsubscribe all observers and release resources. + + + + + Represents an observable wrapper that can be connected and disconnected from its underlying observable sequence. + + The type of the elements in the source sequence. + The type of the elements in the resulting sequence, after transformation through the subject. + + + + Creates an observable that can be connected and disconnected from its source. + + Underlying observable source sequence that can be connected and disconnected from the wrapper. + Subject exposed by the connectable observable, receiving data from the underlying source sequence upon connection. + + + + Connects the observable wrapper to its source. All subscribed observers will receive values from the underlying observable sequence as long as the connection is established. + + Disposable object used to disconnect the observable wrapper from its source, causing subscribed observer to stop receiving values from the underlying observable sequence. + + + + Subscribes an observer to the observable sequence. No values from the underlying observable source will be received unless a connection was established through the Connect method. + + Observer that will receive values from the underlying observable source when the current ConnectableObservable instance is connected through a call to Connect. + Disposable used to unsubscribe from the observable sequence. + + + + Represents an observable wrapper that can be connected and disconnected from its underlying observable sequence. + + + The type of the elements in the sequence. + This type parameter is covariant. That is, you can use either the type you specified or any type that is more derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics. + + + + + Connects the observable wrapper to its source. All subscribed observers will receive values from the underlying observable sequence as long as the connection is established. + + Disposable used to disconnect the observable wrapper from its source, causing subscribed observer to stop receiving values from the underlying observable sequence. + + + + Represents an object that is both an observable sequence as well as an observer. + + The type of the elements processed by the subject. + + + + Represents an object that is both an observable sequence as well as an observer. + + + The type of the elements received by the subject. + This type parameter is contravariant. That is, you can use either the type you specified or any type that is less derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics. + + + The type of the elements produced by the subject. + This type parameter is covariant. That is, you can use either the type you specified or any type that is more derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics. + + + + + Represents an object that is both an observable sequence as well as an observer. + Each notification is broadcasted to all subscribed and future observers, subject to buffer trimming policies. + + The type of the elements processed by the subject. + + + + Underlying optimized implementation of the replay subject. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified scheduler. + + Scheduler the observers are invoked on. + is null. + + + + Initializes a new instance of the class with the specified buffer size. + + Maximum element count of the replay buffer. + is less than zero. + + + + Initializes a new instance of the class with the specified buffer size and scheduler. + + Maximum element count of the replay buffer. + Scheduler the observers are invoked on. + is null. + is less than zero. + + + + Initializes a new instance of the class with the specified window. + + Maximum time length of the replay buffer. + is less than . + + + + Initializes a new instance of the class with the specified window and scheduler. + + Maximum time length of the replay buffer. + Scheduler the observers are invoked on. + is null. + is less than . + + + + Initializes a new instance of the class with the specified buffer size and window. + + Maximum element count of the replay buffer. + Maximum time length of the replay buffer. + is less than zero. -or- is less than . + + + + Initializes a new instance of the class with the specified buffer size, window and scheduler. + + Maximum element count of the replay buffer. + Maximum time length of the replay buffer. + Scheduler the observers are invoked on. + is less than zero. -or- is less than . + is null. + + + + Indicates whether the subject has observers subscribed to it. + + + + + Indicates whether the subject has been disposed. + + + + + Notifies all subscribed and future observers about the arrival of the specified element in the sequence. + + The value to send to all observers. + + + + Notifies all subscribed and future observers about the specified exception. + + The exception to send to all observers. + is null. + + + + Notifies all subscribed and future observers about the end of the sequence. + + + + + Subscribes an observer to the subject. + + Observer to subscribe to the subject. + Disposable object that can be used to unsubscribe the observer from the subject. + is null. + + + + Releases all resources used by the current instance of the class and unsubscribe all observers. + + + + + Original implementation of the ReplaySubject with time based operations (Scheduling, Stopwatch, buffer-by-time). + + + + + Specialized scheduled observer similar to a scheduled observer for the immediate scheduler. + + Type of the elements processed by the observer. + + + + Gate to control ownership transfer and protect data structures. + + + + + Observer to forward notifications to. + + + + + Queue to enqueue OnNext notifications into. + + + + + Standby queue to swap out for _queue when transferring ownership. This allows to reuse + queues in case of busy subjects where the initial replay doesn't suffice to catch up. + + + + + Exception passed to an OnError notification, if any. + + + + + Indicates whether an OnCompleted notification was received. + + + + + Indicates whether the observer is busy, i.e. some thread is actively draining the + notifications that were queued up. + + + + + Indicates whether a failure occurred when the owner was draining the queue. This will + prevent future work to be processed. + + + + + Creates a new scheduled observer that proxies to the specified observer. + + Observer to forward notifications to. + + + + Disposes the observer. + + + + + Notifies the observer of pending work. This will either cause the current owner to + process the newly enqueued notifications, or it will cause the calling thread to + become the owner and start processing the notification queue. + + + + + Notifies the observer of pending work. This will either cause the current owner to + process the newly enqueued notifications, or it will cause the calling thread to + become the owner and start processing the notification queue. + + The number of enqueued notifications to process (ignored). + + + + Enqueues an OnCompleted notification. + + + + + Enqueues an OnError notification. + + Error of the notification. + + + + Enqueues an OnNext notification. + + Value of the notification. + + + + Terminates the observer upon receiving terminal notifications, thus preventing + future notifications to go out. + + Observer to send terminal notifications to. + + + + Represents an object that is both an observable sequence as well as an observer. + Each notification is broadcasted to all subscribed observers. + + The type of the elements processed by the subject. + + + + Creates a subject. + + + + + Indicates whether the subject has observers subscribed to it. + + + + + Indicates whether the subject has been disposed. + + + + + Notifies all subscribed observers about the end of the sequence. + + + + + Notifies all subscribed observers about the specified exception. + + The exception to send to all currently subscribed observers. + is null. + + + + Notifies all subscribed observers about the arrival of the specified element in the sequence. + + The value to send to all currently subscribed observers. + + + + Subscribes an observer to the subject. + + Observer to subscribe to the subject. + Disposable object that can be used to unsubscribe the observer from the subject. + is null. + + + + Releases all resources used by the current instance of the class and unsubscribes all observers. + + + + + Provides a set of static methods for creating subjects. + + + + + Creates a subject from the specified observer and observable. + + The type of the elements received by the observer. + The type of the elements produced by the observable sequence. + The observer used to send messages to the subject. + The observable used to subscribe to messages sent from the subject. + Subject implemented using the given observer and observable. + or is null. + + + + Creates a subject from the specified observer and observable. + + The type of the elements received by the observer and produced by the observable sequence. + The observer used to send messages to the subject. + The observable used to subscribe to messages sent from the subject. + Subject implemented using the given observer and observable. + or is null. + + + + Synchronizes the messages sent to the subject. + + The type of the elements received by the subject. + The type of the elements produced by the subject. + The subject to synchronize. + Subject whose messages are synchronized. + is null. + + + + Synchronizes the messages sent to the subject. + + The type of the elements received and produced by the subject. + The subject to synchronize. + Subject whose messages are synchronized. + is null. + + + + Synchronizes the messages sent to the subject and notifies observers on the specified scheduler. + + The type of the elements received by the subject. + The type of the elements produced by the subject. + The subject to synchronize. + Scheduler to notify observers on. + Subject whose messages are synchronized and whose observers are notified on the given scheduler. + or is null. + + + + Synchronizes the messages sent to the subject and notifies observers on the specified scheduler. + + The type of the elements received and produced by the subject. + The subject to synchronize. + Scheduler to notify observers on. + Subject whose messages are synchronized and whose observers are notified on the given scheduler. + or is null. + + + + Base class for objects that are both an observable sequence as well as an observer. + + The type of the elements processed by the subject. + + + + Indicates whether the subject has observers subscribed to it. + + + + + Indicates whether the subject has been disposed. + + + + + Releases all resources used by the current instance of the subject and unsubscribes all observers. + + + + + Notifies all subscribed observers about the end of the sequence. + + + + + Notifies all subscribed observers about the specified exception. + + The exception to send to all currently subscribed observers. + is null. + + + + Notifies all subscribed observers about the arrival of the specified element in the sequence. + + The value to send to all currently subscribed observers. + + + + Subscribes an observer to the subject. + + Observer to subscribe to the subject. + Disposable object that can be used to unsubscribe the observer from the subject. + is null. + + + + Indicates the type of a notification. + + + + + Represents an OnNext notification. + + + + + Represents an OnError notification. + + + + + Represents an OnCompleted notification. + + + + + Represents a notification to an observer. + + The type of the elements received by the observer. + + + + Default constructor used by derived types. + + + + + Returns the value of an OnNext notification or throws an exception. + + + + + Returns a value that indicates whether the notification has a value. + + + + + Returns the exception of an OnError notification or returns null. + + + + + Gets the kind of notification that is represented. + + + + + Represents an OnNext notification to an observer. + + + + + Constructs a notification of a new value. + + + + + Returns the value of an OnNext notification. + + + + + Returns null. + + + + + Returns true. + + + + + Returns . + + + + + Returns the hash code for this instance. + + + + + Indicates whether this instance and a specified object are equal. + + + + + Returns a string representation of this instance. + + + + + Invokes the observer's method corresponding to the notification. + + Observer to invoke the notification on. + + + + Invokes the observer's method corresponding to the notification and returns the produced result. + + Observer to invoke the notification on. + Result produced by the observation. + + + + Invokes the delegate corresponding to the notification. + + Delegate to invoke for an OnNext notification. + Delegate to invoke for an OnError notification. + Delegate to invoke for an OnCompleted notification. + + + + Invokes the delegate corresponding to the notification and returns the produced result. + + Delegate to invoke for an OnNext notification. + Delegate to invoke for an OnError notification. + Delegate to invoke for an OnCompleted notification. + Result produced by the observation. + + + + Represents an OnError notification to an observer. + + + + + Constructs a notification of an exception. + + + + + Throws the exception. + + + + + Returns the exception. + + + + + Returns false. + + + + + Returns . + + + + + Returns the hash code for this instance. + + + + + Indicates whether this instance and other are equal. + + + + + Returns a string representation of this instance. + + + + + Invokes the observer's method corresponding to the notification. + + Observer to invoke the notification on. + + + + Invokes the observer's method corresponding to the notification and returns the produced result. + + Observer to invoke the notification on. + Result produced by the observation. + + + + Invokes the delegate corresponding to the notification. + + Delegate to invoke for an OnNext notification. + Delegate to invoke for an OnError notification. + Delegate to invoke for an OnCompleted notification. + + + + Invokes the delegate corresponding to the notification and returns the produced result. + + Delegate to invoke for an OnNext notification. + Delegate to invoke for an OnError notification. + Delegate to invoke for an OnCompleted notification. + Result produced by the observation. + + + + Represents an OnCompleted notification to an observer. + + + + + Complete notifications are stateless thus only one instance + can ever exist per type. + + + + + Constructs a notification of the end of a sequence. + + + + + Throws an . + + + + + Returns null. + + + + + Returns false. + + + + + Returns . + + + + + Returns the hash code for this instance. + + + + + Indicates whether this instance and other are equal. + + + + + Returns a string representation of this instance. + + + + + Invokes the observer's method corresponding to the notification. + + Observer to invoke the notification on. + + + + Invokes the observer's method corresponding to the notification and returns the produced result. + + Observer to invoke the notification on. + Result produced by the observation. + + + + Invokes the delegate corresponding to the notification. + + Delegate to invoke for an OnNext notification. + Delegate to invoke for an OnError notification. + Delegate to invoke for an OnCompleted notification. + + + + Invokes the delegate corresponding to the notification and returns the produced result. + + Delegate to invoke for an OnNext notification. + Delegate to invoke for an OnError notification. + Delegate to invoke for an OnCompleted notification. + Result produced by the observation. + + + + Determines whether the current object has the same observer message payload as a specified value. + + An object to compare to the current object. + true if both objects have the same observer message payload; otherwise, false. + + Equality of objects is based on the equality of the observer message payload they represent, including the notification Kind and the Value or Exception (if any). + This means two objects can be equal even though they don't represent the same observer method call, but have the same Kind and have equal parameters passed to the observer method. + In case one wants to determine whether two objects represent the same observer method call, use Object.ReferenceEquals identity equality instead. + + + + + Determines whether the two specified objects have the same observer message payload. + + The first to compare, or null. + The second to compare, or null. + true if the first value has the same observer message payload as the second value; otherwise, false. + + Equality of objects is based on the equality of the observer message payload they represent, including the notification Kind and the Value or Exception (if any). + This means two objects can be equal even though they don't represent the same observer method call, but have the same Kind and have equal parameters passed to the observer method. + In case one wants to determine whether two objects represent the same observer method call, use Object.ReferenceEquals identity equality instead. + + + + + Determines whether the two specified objects have a different observer message payload. + + The first to compare, or null. + The second to compare, or null. + true if the first value has a different observer message payload as the second value; otherwise, false. + + Equality of objects is based on the equality of the observer message payload they represent, including the notification Kind and the Value or Exception (if any). + This means two objects can be equal even though they don't represent the same observer method call, but have the same Kind and have equal parameters passed to the observer method. + In case one wants to determine whether two objects represent a different observer method call, use Object.ReferenceEquals identity equality instead. + + + + + Determines whether the specified System.Object is equal to the current . + + The System.Object to compare with the current . + true if the specified System.Object is equal to the current ; otherwise, false. + + Equality of objects is based on the equality of the observer message payload they represent, including the notification Kind and the Value or Exception (if any). + This means two objects can be equal even though they don't represent the same observer method call, but have the same Kind and have equal parameters passed to the observer method. + In case one wants to determine whether two objects represent the same observer method call, use Object.ReferenceEquals identity equality instead. + + + + + Invokes the observer's method corresponding to the notification. + + Observer to invoke the notification on. + + + + Invokes the observer's method corresponding to the notification and returns the produced result. + + The type of the result returned from the observer's notification handlers. + Observer to invoke the notification on. + Result produced by the observation. + + + + Invokes the delegate corresponding to the notification. + + Delegate to invoke for an OnNext notification. + Delegate to invoke for an OnError notification. + Delegate to invoke for an OnCompleted notification. + + + + Invokes the delegate corresponding to the notification and returns the produced result. + + The type of the result returned from the notification handler delegates. + Delegate to invoke for an OnNext notification. + Delegate to invoke for an OnError notification. + Delegate to invoke for an OnCompleted notification. + Result produced by the observation. + + + + Returns an observable sequence with a single notification, using the immediate scheduler. + + The observable sequence that surfaces the behavior of the notification upon subscription. + + + + Returns an observable sequence with a single notification. + + Scheduler to send out the notification calls on. + The observable sequence that surfaces the behavior of the notification upon subscription. + + + + Provides a set of static methods for constructing notifications. + + + + + Creates an object that represents an OnNext notification to an observer. + + The type of the elements received by the observer. Upon dematerialization of the notifications into an observable sequence, this type is used as the element type for the sequence. + The value contained in the notification. + The OnNext notification containing the value. + + + + Creates an object that represents an OnError notification to an observer. + + The type of the elements received by the observer. Upon dematerialization of the notifications into an observable sequence, this type is used as the element type for the sequence. + The exception contained in the notification. + The OnError notification containing the exception. + is null. + + + + Creates an object that represents an OnCompleted notification to an observer. + + The type of the elements received by the observer. Upon dematerialization of the notifications into an observable sequence, this type is used as the element type for the sequence. + The OnCompleted notification. + + + + Abstract base class for implementations of the interface. + + + If you don't need a named type to create an observable sequence (i.e. you rather need + an instance rather than a reusable type), use the Observable.Create method to create + an observable sequence with specified subscription behavior. + + The type of the elements in the sequence. + + + + Subscribes the given observer to the observable sequence. + + Observer that will receive notifications from the observable sequence. + Disposable object representing an observer's subscription to the observable sequence. + is null. + + + + Implement this method with the core subscription logic for the observable sequence. + + Observer to send notifications to. + Disposable object representing an observer's subscription to the observable sequence. + + + + Provides a set of static methods for creating observers. + + + + + Creates an observer from a notification callback. + + The type of the elements received by the observer. + Action that handles a notification. + The observer object that invokes the specified handler using a notification corresponding to each message it receives. + is null. + + + + Creates a notification callback from an observer. + + The type of the elements received by the observer. + Observer object. + The action that forwards its input notification to the underlying observer. + is null. + + + + Creates an observer from the specified OnNext action. + + The type of the elements received by the observer. + Observer's OnNext action implementation. + The observer object implemented using the given actions. + is null. + + + + Creates an observer from the specified OnNext and OnError actions. + + The type of the elements received by the observer. + Observer's OnNext action implementation. + Observer's OnError action implementation. + The observer object implemented using the given actions. + or is null. + + + + Creates an observer from the specified OnNext and OnCompleted actions. + + The type of the elements received by the observer. + Observer's OnNext action implementation. + Observer's OnCompleted action implementation. + The observer object implemented using the given actions. + or is null. + + + + Creates an observer from the specified OnNext, OnError, and OnCompleted actions. + + The type of the elements received by the observer. + Observer's OnNext action implementation. + Observer's OnError action implementation. + Observer's OnCompleted action implementation. + The observer object implemented using the given actions. + or or is null. + + + + Hides the identity of an observer. + + The type of the elements received by the source observer. + An observer whose identity to hide. + An observer that hides the identity of the specified observer. + is null. + + + + Checks access to the observer for grammar violations. This includes checking for multiple OnError or OnCompleted calls, as well as reentrancy in any of the observer methods. + If a violation is detected, an InvalidOperationException is thrown from the offending observer method call. + + The type of the elements received by the source observer. + The observer whose callback invocations should be checked for grammar violations. + An observer that checks callbacks invocations against the observer grammar and, if the checks pass, forwards those to the specified observer. + is null. + + + + Synchronizes access to the observer such that its callback methods cannot be called concurrently from multiple threads. This overload is useful when coordinating access to an observer. + Notice reentrant observer callbacks on the same thread are still possible. + + The type of the elements received by the source observer. + The observer whose callbacks should be synchronized. + An observer that delivers callbacks to the specified observer in a synchronized manner. + is null. + + Because a Monitor is used to perform the synchronization, there's no protection against reentrancy from the same thread. + Hence, overlapped observer callbacks are still possible, which is invalid behavior according to the observer grammar. In order to protect against this behavior as + well, use the overload, passing true for the second parameter. + + + + + Synchronizes access to the observer such that its callback methods cannot be called concurrently. This overload is useful when coordinating access to an observer. + The parameter configures the type of lock used for synchronization. + + The type of the elements received by the source observer. + The observer whose callbacks should be synchronized. + If set to true, reentrant observer callbacks will be queued up and get delivered to the observer in a sequential manner. + An observer that delivers callbacks to the specified observer in a synchronized manner. + is null. + + When the parameter is set to false, behavior is identical to the overload which uses + a Monitor for synchronization. When the parameter is set to true, an + is used to queue up callbacks to the specified observer if a reentrant call is made. + + + + + Synchronizes access to the observer such that its callback methods cannot be called concurrently by multiple threads, using the specified gate object for use by a Monitor-based lock. + This overload is useful when coordinating multiple observers that access shared state by synchronizing on a common gate object. + Notice reentrant observer callbacks on the same thread are still possible. + + The type of the elements received by the source observer. + The observer whose callbacks should be synchronized. + Gate object to synchronize each observer call on. + An observer that delivers callbacks to the specified observer in a synchronized manner. + or is null. + + Because a Monitor is used to perform the synchronization, there's no protection against reentrancy from the same thread. + Hence, overlapped observer callbacks are still possible, which is invalid behavior according to the observer grammar. In order to protect against this behavior as + well, use the overload. + + + + + Synchronizes access to the observer such that its callback methods cannot be called concurrently, using the specified asynchronous lock to protect against concurrent and reentrant access. + This overload is useful when coordinating multiple observers that access shared state by synchronizing on a common asynchronous lock. + + The type of the elements received by the source observer. + The observer whose callbacks should be synchronized. + Gate object to synchronize each observer call on. + An observer that delivers callbacks to the specified observer in a synchronized manner. + or is null. + + + + Schedules the invocation of observer methods on the given scheduler. + + The type of the elements received by the source observer. + The observer to schedule messages for. + Scheduler to schedule observer messages on. + Observer whose messages are scheduled on the given scheduler. + or is null. + + + + Schedules the invocation of observer methods on the given synchronization context. + + The type of the elements received by the source observer. + The observer to schedule messages for. + Synchronization context to schedule observer messages on. + Observer whose messages are scheduled on the given synchronization context. + or is null. + + + + Converts an observer to a progress object. + + The type of the progress objects received by the source observer. + The observer to convert. + Progress object whose Report messages correspond to the observer's OnNext messages. + is null. + + + + Converts an observer to a progress object, using the specified scheduler to invoke the progress reporting method. + + The type of the progress objects received by the source observer. + The observer to convert. + Scheduler to report progress on. + Progress object whose Report messages correspond to the observer's OnNext messages. + or is null. + + + + Converts a progress object to an observer. + + The type of the progress objects received by the progress reporter. + The progress object to convert. + Observer whose OnNext messages correspond to the progress object's Report messages. + is null. + + + + Abstract base class for implementations of the interface. + + This base class enforces the grammar of observers where and are terminal messages. + The type of the elements in the sequence. + + + + Creates a new observer in a non-stopped state. + + + + + Notifies the observer of a new element in the sequence. + + Next element in the sequence. + + + + Implement this method to react to the receival of a new element in the sequence. + + Next element in the sequence. + This method only gets called when the observer hasn't stopped yet. + + + + Notifies the observer that an exception has occurred. + + The error that has occurred. + is null. + + + + Implement this method to react to the occurrence of an exception. + + The error that has occurred. + This method only gets called when the observer hasn't stopped yet, and causes the observer to stop. + + + + Notifies the observer of the end of the sequence. + + + + + Implement this method to react to the end of the sequence. + + This method only gets called when the observer hasn't stopped yet, and causes the observer to stop. + + + + Disposes the observer, causing it to transition to the stopped state. + + + + + Core implementation of . + + true if the Dispose call was triggered by the method; false if it was triggered by the finalizer. + + + + A strongly-typed resource class, for looking up localized strings, etc. + + + + + Returns the cached ResourceManager instance used by this class. + + + + + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + + + + + Looks up a localized string similar to Using the Scheduler.{0} property is no longer supported due to refactoring of the API surface and elimination of platform-specific dependencies. Please include System.Reactive.PlatformServices for your target platform and use the {0}Scheduler type instead. If you're building a Windows Store app, notice some schedulers are no longer supported. Consider using Scheduler.Default instead.. + + + + + Looks up a localized string similar to OnCompleted notification doesn't have a value.. + + + + + Looks up a localized string similar to Disposable has already been assigned.. + + + + + Looks up a localized string similar to Disposables collection can not contain null values.. + + + + + Looks up a localized string similar to Failed to start monitoring system clock changes.. + + + + + Looks up a localized string similar to Heap is empty.. + + + + + Looks up a localized string similar to Observer has already terminated.. + + + + + Looks up a localized string similar to Reentrancy has been detected.. + + + + + Looks up a localized string similar to This scheduler operation has already been awaited.. + + + + + A strongly-typed resource class, for looking up localized strings, etc. + + + + + Returns the cached ResourceManager instance used by this class. + + + + + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + + + + + Looks up a localized string similar to {0} cannot be called when the scheduler is already running. Try using Sleep instead.. + + + + + Looks up a localized string similar to Could not find event '{0}' on object of type '{1}'.. + + + + + Looks up a localized string similar to Could not find event '{0}' on type '{1}'.. + + + + + Looks up a localized string similar to Add method should take 1 parameter.. + + + + + Looks up a localized string similar to The second parameter of the event delegate must be assignable to '{0}'.. + + + + + Looks up a localized string similar to Event is missing the add method.. + + + + + Looks up a localized string similar to Event is missing the remove method.. + + + + + Looks up a localized string similar to The event delegate must have a void return type.. + + + + + Looks up a localized string similar to The event delegate must have exactly two parameters.. + + + + + Looks up a localized string similar to Remove method should take 1 parameter.. + + + + + Looks up a localized string similar to The first parameter of the event delegate must be assignable to '{0}'.. + + + + + Looks up a localized string similar to Remove method of a WinRT event should take an EventRegistrationToken.. + + + + + Looks up a localized string similar to Sequence contains more than one element.. + + + + + Looks up a localized string similar to Sequence contains more than one matching element.. + + + + + Looks up a localized string similar to Sequence contains no elements.. + + + + + Looks up a localized string similar to Sequence contains no matching element.. + + + + + A strongly-typed resource class, for looking up localized strings, etc. + + + + + Returns the cached ResourceManager instance used by this class. + + + + + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + + + + + Looks up a localized string similar to The WinRT thread pool doesn't support creating periodic timers with a period below 1 millisecond.. + + + + + A strongly-typed resource class, for looking up localized strings, etc. + + + + + Returns the cached ResourceManager instance used by this class. + + + + + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + + + + + Looks up a localized string similar to Expected Qbservable.ToQueryable.. + + + + + Looks up a localized string similar to Invalid expression tree type.. + + + + + Looks up a localized string similar to There is no method '{0}' on type '{1}' that matches the specified arguments.. + + + + + Extension of the interface compatible with async method return types. + + + This class implements a "task-like" type that can be used as the return type of an asynchronous + method in C# 7.0 and beyond. For example: + + async ITaskObservable<int> RxAsync() + { + var res = await Observable.Return(21).Delay(TimeSpan.FromSeconds(1)); + return res * 2; + } + + + The type of the elements in the sequence. + + + + Gets an awaiter that can be used to await the eventual completion of the observable sequence. + + An awaiter that can be used to await the eventual completion of the observable sequence. + + + + Interface representing an awaiter for an . + + The type of the elements in the sequence. + + + + Gets a Boolean indicating whether the observable sequence has completed. + + + + + Gets the result produced by the observable sequence. + + The result produced by the observable sequence. + + + + The System.Reactive.Threading.Tasks namespace contains helpers for the conversion between tasks and observable sequences. + + + + + Provides a set of static methods for converting tasks to observable sequences. + + + + + Returns an observable sequence that signals when the task completes. + + Task to convert to an observable sequence. + An observable sequence that produces a unit value when the task completes, or propagates the exception produced by the task. + is null. + If the specified task object supports cancellation, consider using instead. + + + + Returns an observable sequence that signals when the task completes. + + Task to convert to an observable sequence. + Scheduler on which to notify observers about completion, cancellation or failure. + An observable sequence that produces a unit value when the task completes, or propagates the exception produced by the task. + is null or is null. + If the specified task object supports cancellation, consider using instead. + + + + Returns an observable sequence that propagates the result of the task. + + The type of the result produced by the task. + Task to convert to an observable sequence. + An observable sequence that produces the task's result, or propagates the exception produced by the task. + is null. + If the specified task object supports cancellation, consider using instead. + + + + Returns an observable sequence that propagates the result of the task. + + The type of the result produced by the task. + Task to convert to an observable sequence. + Scheduler on which to notify observers about completion, cancellation or failure. + An observable sequence that produces the task's result, or propagates the exception produced by the task. + is null or is null. + If the specified task object supports cancellation, consider using instead. + + + + Returns a task that will receive the last value or the exception produced by the observable sequence. + + The type of the elements in the source sequence. + Observable sequence to convert to a task. + A task that will receive the last element or the exception produced by the observable sequence. + is null. + + + + Returns a task that will receive the last value or the exception produced by the observable sequence. + + The type of the elements in the source sequence. + Observable sequence to convert to a task. + The state to use as the underlying task's AsyncState. + A task that will receive the last element or the exception produced by the observable sequence. + is null. + + + + Returns a task that will receive the last value or the exception produced by the observable sequence. + + The type of the elements in the source sequence. + Observable sequence to convert to a task. + Cancellation token that can be used to cancel the task, causing unsubscription from the observable sequence. + A task that will receive the last element or the exception produced by the observable sequence. + is null. + + + + Returns a task that will receive the last value or the exception produced by the observable sequence. + + The type of the elements in the source sequence. + Observable sequence to convert to a task. + Cancellation token that can be used to cancel the task, causing unsubscription from the observable sequence. + The state to use as the underlying task's . + A task that will receive the last element or the exception produced by the observable sequence. + is null. + + + + Represents a value associated with time interval information. + The time interval can represent the time it took to produce the value, the interval relative to a previous value, the value's delivery time relative to a base, etc. + + The type of the value being annotated with time interval information. + + + + Constructs a time interval value. + + The value to be annotated with a time interval. + Time interval associated with the value. + + + + Gets the value. + + + + + Gets the interval. + + + + + Determines whether the current value has the same and as a specified value. + + An object to compare to the current value. + true if both values have the same and ; otherwise, false. + + + + Determines whether the two specified values have the same and . + + The first value to compare. + The second value to compare. + true if the first value has the same and as the second value; otherwise, false. + + + + Determines whether the two specified values don't have the same and . + + The first value to compare. + The second value to compare. + true if the first value has a different or as the second value; otherwise, false. + + + + Determines whether the specified System.Object is equal to the current . + + The System.Object to compare with the current . + true if the specified System.Object is equal to the current ; otherwise, false. + + + + Returns the hash code for the current value. + + A hash code for the current value. + + + + Returns a string representation of the current value. + + String representation of the current value. + + + + Represents value with a timestamp on it. + The timestamp typically represents the time the value was received, using an IScheduler's clock to obtain the current time. + + The type of the value being timestamped. + + + + Constructs a timestamped value. + + The value to be annotated with a timestamp. + Timestamp associated with the value. + + + + Gets the value. + + + + + Gets the timestamp. + + + + + Determines whether the current value has the same and as a specified value. + + An object to compare to the current value. + true if both values have the same and ; otherwise, false. + + + + Determines whether the two specified values have the same and . + + The first value to compare. + The second value to compare. + true if the first value has the same and as the second value; otherwise, false. + + + + Determines whether the two specified values don't have the same and . + + The first value to compare. + The second value to compare. + true if the first value has a different or as the second value; otherwise, false. + + + + Determines whether the specified System.Object is equal to the current . + + The System.Object to compare with the current . + true if the specified System.Object is equal to the current ; otherwise, false. + + + + Returns the hash code for the current value. + + A hash code for the current value. + + + + Returns a string representation of the current value. + + String representation of the current value. + + + + A helper class with a factory method for creating instances. + + + + + Creates an instance of a . This is syntactic sugar that uses type inference + to avoid specifying a type in a constructor call, which is very useful when using anonymous types. + + The value to be annotated with a timestamp. + Timestamp associated with the value. + Creates a new timestamped value. + + + + Represents a type with a single value. This type is often used to denote the successful completion of a void-returning method (C#) or a Sub procedure (Visual Basic). + + + + + Determines whether the specified value is equal to the current . Because has a single value, this always returns true. + + An object to compare to the current value. + Because has a single value, this always returns true. + + + + Determines whether the specified System.Object is equal to the current . + + The System.Object to compare with the current . + true if the specified System.Object is a value; otherwise, false. + + + + Returns the hash code for the current value. + + A hash code for the current value. + + + + Returns a string representation of the current value. + + String representation of the current value. + + + + Determines whether the two specified values are equal. Because has a single value, this always returns true. + + The first value to compare. + The second value to compare. + Because has a single value, this always returns true. + + + + Determines whether the two specified values are not equal. Because has a single value, this always returns false. + + The first value to compare. + The second value to compare. + Because has a single value, this always returns false. + + + + Gets the single value. + + + + + A strongly-typed resource class, for looking up localized strings, etc. + + + + + Returns the cached ResourceManager instance used by this class. + + + + + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + + + + + Looks up a localized string similar to The current thread has no Dispatcher associated with it.. + + + + + Looks up a localized string similar to No current Window object found to obtain a CoreDispatcher from.. + + + + + Provides a set of static methods for subscribing delegates to observables. + + + + + Subscribes to the observable sequence without specifying any handlers. + This method can be used to evaluate the observable sequence for its side-effects only. + + The type of the elements in the source sequence. + Observable sequence to subscribe to. + object used to unsubscribe from the observable sequence. + is null. + + + + Subscribes an element handler to an observable sequence. + + The type of the elements in the source sequence. + Observable sequence to subscribe to. + Action to invoke for each element in the observable sequence. + object used to unsubscribe from the observable sequence. + or is null. + + + + Subscribes an element handler and an exception handler to an observable sequence. + + The type of the elements in the source sequence. + Observable sequence to subscribe to. + Action to invoke for each element in the observable sequence. + Action to invoke upon exceptional termination of the observable sequence. + object used to unsubscribe from the observable sequence. + or or is null. + + + + Subscribes an element handler and a completion handler to an observable sequence. + + The type of the elements in the source sequence. + Observable sequence to subscribe to. + Action to invoke for each element in the observable sequence. + Action to invoke upon graceful termination of the observable sequence. + object used to unsubscribe from the observable sequence. + or or is null. + + + + Subscribes an element handler, an exception handler, and a completion handler to an observable sequence. + + The type of the elements in the source sequence. + Observable sequence to subscribe to. + Action to invoke for each element in the observable sequence. + Action to invoke upon exceptional termination of the observable sequence. + Action to invoke upon graceful termination of the observable sequence. + object used to unsubscribe from the observable sequence. + or or or is null. + + + + Subscribes an observer to an observable sequence, using a to support unsubscription. + + The type of the elements in the source sequence. + Observable sequence to subscribe to. + Observer to subscribe to the sequence. + CancellationToken that can be signaled to unsubscribe from the source sequence. + or is null. + + + + Subscribes to the observable sequence without specifying any handlers, using a to support unsubscription. + This method can be used to evaluate the observable sequence for its side-effects only. + + The type of the elements in the source sequence. + Observable sequence to subscribe to. + CancellationToken that can be signaled to unsubscribe from the source sequence. + is null. + + + + Subscribes an element handler to an observable sequence, using a to support unsubscription. + + The type of the elements in the source sequence. + Observable sequence to subscribe to. + Action to invoke for each element in the observable sequence. + CancellationToken that can be signaled to unsubscribe from the source sequence. + or is null. + + + + Subscribes an element handler and an exception handler to an observable sequence, using a to support unsubscription. + + The type of the elements in the source sequence. + Observable sequence to subscribe to. + Action to invoke for each element in the observable sequence. + Action to invoke upon exceptional termination of the observable sequence. + CancellationToken that can be signaled to unsubscribe from the source sequence. + or or is null. + + + + Subscribes an element handler and a completion handler to an observable sequence, using a to support unsubscription. + + The type of the elements in the source sequence. + Observable sequence to subscribe to. + Action to invoke for each element in the observable sequence. + Action to invoke upon graceful termination of the observable sequence. + CancellationToken that can be signaled to unsubscribe from the source sequence. + or or is null. + + + + Subscribes an element handler, an exception handler, and a completion handler to an observable sequence, using a to support unsubscription. + + The type of the elements in the source sequence. + Observable sequence to subscribe to. + Action to invoke for each element in the observable sequence. + Action to invoke upon exceptional termination of the observable sequence. + Action to invoke upon graceful termination of the observable sequence. + CancellationToken that can be signaled to unsubscribe from the source sequence. + or or or is null. + + + + Subscribes to the specified source, re-routing synchronous exceptions during invocation of the method to the observer's channel. + This method is typically used when writing query operators. + + The type of the elements in the source sequence. + Observable sequence to subscribe to. + Observer that will be passed to the observable sequence, and that will be used for exception propagation. + object used to unsubscribe from the observable sequence. + or is null. + + + + Represents a builder for asynchronous methods that return a task-like . + + The type of the elements in the sequence. + + + + The compiler-generated asynchronous state machine representing the execution flow of the asynchronous + method whose return type is a task-like . + + + + + The underlying observable sequence representing the result produced by the asynchronous method. + + + + + Creates an instance of the struct. + + A new instance of the struct. + + + + Begins running the builder with the associated state machine. + + The type of the state machine. + The state machine instance, passed by reference. + is null. + + + + Associates the builder with the specified state machine. + + The state machine instance to associate with the builder. + is null. + The state machine was previously set. + + + + Marks the observable as successfully completed. + + The result to use to complete the observable sequence. + The observable has already completed. + + + + Marks the observable as failed and binds the specified exception to the observable sequence. + + The exception to bind to the observable sequence. + is null. + The observable has already completed. + + + + Gets the observable sequence for this builder. + + + + + Schedules the state machine to proceed to the next action when the specified awaiter completes. + + The type of the awaiter. + The type of the state machine. + The awaiter. + The state machine. + + + + Schedules the state machine to proceed to the next action when the specified awaiter completes. + + The type of the awaiter. + The type of the state machine. + The awaiter. + The state machine. + + + + Rethrows an exception that was thrown from an awaiter's OnCompleted methods. + + The exception to rethrow. + + + + Implementation of the IObservable<T> interface compatible with async method return types. + + + This class implements a "task-like" type that can be used as the return type of an asynchronous + method in C# 7.0 and beyond. For example: + + async Observable<int> RxAsync() + { + var res = await Observable.Return(21).Delay(TimeSpan.FromSeconds(1)); + return res * 2; + } + + + + + + The underlying observable sequence to subscribe to in case the asynchronous method did not + finish synchronously. + + + + + The result returned by the asynchronous method in case the method finished synchronously. + + + + + The exception thrown by the asynchronous method in case the method finished synchronously. + + + + + Creates a new for an asynchronous method that has not finished yet. + + + + + Creates a new for an asynchronous method that synchronously returned + the specified value. + + The result returned by the asynchronous method. + + + + Creates a new for an asynchronous method that synchronously threw + the specified . + + The exception thrown by the asynchronous method. + + + + Marks the observable as successfully completed. + + The result to use to complete the observable sequence. + The observable has already completed. + + + + Marks the observable as failed and binds the specified exception to the observable sequence. + + The exception to bind to the observable sequence. + is null. + The observable has already completed. + + + + Subscribes the given observer to the observable sequence. + + Observer that will receive notifications from the observable sequence. + Disposable object representing an observer's subscription to the observable sequence. + is null. + + + + Gets an awaiter that can be used to await the eventual completion of the observable sequence. + + An awaiter that can be used to await the eventual completion of the observable sequence. + + + + Gets a Boolean indicating whether the observable sequence has completed. + + + + + Gets the result produced by the observable sequence. + + The result produced by the observable sequence. + + + + Attaches the specified to the observable sequence. + + The continuation to attach. + + + diff --git a/packages/FAKE.5.16.0/tools/System.Reflection.Extensions.dll b/packages/FAKE.5.16.0/tools/System.Reflection.Extensions.dll new file mode 100644 index 0000000..6d12687 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Reflection.Extensions.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Reflection.Metadata.dll b/packages/FAKE.5.16.0/tools/System.Reflection.Metadata.dll new file mode 100644 index 0000000..49b7997 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Reflection.Metadata.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Reflection.Metadata.xml b/packages/FAKE.5.16.0/tools/System.Reflection.Metadata.xml new file mode 100644 index 0000000..3b4c163 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/System.Reflection.Metadata.xml @@ -0,0 +1,9351 @@ + + + System.Reflection.Metadata + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents the shape of an array type. + + + Initializes a new instance of the structure. + The number of dimensions in the array. + The size of each dimension. + The lower-bound of each dimension. + + + Gets the lower-bounds of all dimensions. Length may be smaller than rank, in which case the trailing dimensions have unspecified lower bounds. + An array of lower-bounds. + + + Gets the number of dimensions in the array. + The number of dimensions. + + + Gets the sizes of all dimensions. + An array of sizes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Specifies values that represent types of metadata constants. + + + A Boolean type. + + + + An unsigned 1-byte integer. + + + + A character type. + + + + An 8-byte floating point type. + + + + A signed 2-byte integer type. + + + + A signed 4-byte integer type. + + + + A signed 8-byte integer type. + + + + An invalid type. + + + + A null reference. + + + + A signed 1-byte integer type. + + + + A 4-byte floating point type. + + + + A type. + + + + An unsigned 2-byte integer type. + + + + An unsigned 4-byte integer type. + + + + An unsigned 8-byte integer type. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents a named argument decoded from a custom attribute signature. + The type used to represent types of values decoded from the custom attribute signature. + + + Initializes a new instance of the structure using the specified name, kind, type, and value. + The name of the argument. + The kind of the argument. + The type of the argument. + The value of the argument. + + + Gets the kind of argument. + The argument kind. + + + Gets the name of the argument. + The argument name. + + + Gets the type of the argument. + The argument type. + + + Gets the value of the argument. + An object containing the argument value. + + + Specifies constants that define the kinds of arguments in a custom attribute signature. + + + A field argument. + + + + A property argument. + + + + Represents a typed argument for a custom metadata attribute. + The type of the argument. + + + Initializes a new instance of the structure using the specified argument type and value. + The type of the argument. + The argument value. + + + Gets the type of the argument. + The argument type. + + + Gets the value of the argument. + The argument value. + + + Represents a custom atttribute of the type specified by TType. + The attribute type. + + + Initializes a new instance of the structure using the specified fixed arguments and named arguments. + The fixed arguments. + The named arguments. + + + Gets the fixed arguments for the custom attribute. + An immutable array of arguments. + + + Gets the named arguments for the custom attribute value. + An immutable array of arguments. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Specifies constants that indicate whether a references a method or field. + + + The references a field. + + + + The references a method. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents a method (definition, reference, or standalone) or property signature. In the case of properties, the signature matches that of a getter with a distinguishing . + The method type. + + + Initializes a new instance of the structure using the specified header, return type, and parameter information. + The information in the leading byte of the signature (kind, calling convention, flags). + The return type of the method. + The number of required parameters. + The number of generic type parameters. + The parameter types. + + + Gets the number of generic type parameters for the method. + The number of generic type parameters, or 0 for non-generic methods. + + + Gets the information in the leading byte of the signature (kind, calling convention, flags). + The header signature. + + + Gets the method&#39;s parameter types. + An immutable collection of parameter types. + + + Gets the number of parameters that are required for the method. + The number of required parameters. + + + Gets the return type of the method. + The return type. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Specifies constants that define the type codes used to encode types of primitive values in a value blob. + + + A type. + + + + An unsigned 1-byte integer type. + + + + A type. + + + + An 8-byte floating point type. + + + + A signed 2-byte integer type. + + + + A signed 4-byte integer type. + + + + A signed 8-byte integer type. + + + + A signed 1-byte integer type. + + + + A 4-byte floating point type. + + + + A type. + + + + An unsigned 2-byte integer type. + + + + An unsigned 4-byte integer type. + + + + An unsigned 8-byte integer type. + + + + Specifies constants that define primitive types found in metadata signatures. + + + A type. + + + + A type. + + + + A type. + + + + A type. + + + + A type. + + + + A type. + + + + A type. + + + + A type. + + + + An type. + + + + An type. + + + + A type. + + + + An type. + + + + A typed reference. + + + + A type. + + + + A type. + + + + A type. + + + + A type. + + + + A type. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Specifies type codes used to encode the types of values in a blob. + + + A value equivalent to . + + + + A value equivalent to . + + + + A value equivalent to . + + + + A value equivalent to . + + + + The attribute argument is an Enum instance. + + + + A value equivalent to . + + + + A value equivalent to . + + + + A value equivalent to . + + + + A value equivalent to . + + + + A value equivalent to . + + + + A value equivalent to . + + + + A value equivalent to . + + + + A value equivalent to . + + + + The attribute argument is &quot;boxed&quot; (passed to a parameter, field, or property of type object) and carries type information in the attribute blob. + + + + The attribute argument is a instance. + + + + A value equivalent to . + + + + A value equivalent to . + + + + A value equivalent to . + + + + Specifies additional flags that can be applied to method signatures. The underlying values of the fields in this type correspond to the representation in the leading signature byte represented by a structure. + + + Indicates the first explicitly declared parameter that represents the instance pointer. + + + + A generic method. + + + + An instance method. + + + + No flags. + + + + Specifies how arguments in a given signature are passed from the caller to the callee. The underlying values of the fields in this type correspond to the representation in the leading signature byte represented by a structure. + + + An unmanaged C/C++ style calling convention where the call stack is cleaned by the caller. + + + + A managed calling convention with a fixed-length argument list. + + + + An unmanaged calling convention where arguments are passed in registers when possible. + + + + An unmanaged calling convention where the call stack is cleaned up by the callee. + + + + An unmanaged C++ style calling convention for calling instance member functions with a fixed argument list. + + + + A managed calling convention for passing extra arguments. + + + + Represents the signature characteristics specified by the leading byte of signature blobs. + + + Initializes a new instance of the structure using the specified byte value. + The byte. + + + Initializes a new instance of the structure using the specified signature kind, calling convention and signature attributes. + The signature kind. + The calling convention. + The signature attributes. + + + Gets the signature attributes. + The attributes. + + + Gets the calling convention. + The calling convention. + + + Gets the mask value for the calling convention or signature kind. The default value is 15 (0x0F). + + + + Compares the specified object with this for equality. + The object to compare. + true if the objects are equal; otherwise, false. + + + Compares two values for equality. + The value to compare. + true if the values are equal; otherwise, false. + + + Gets a hash code for the current object. + A hash code for the current object. + + + Gets a value that indicates whether this structure has the signature attribute. + true if the attribute is present; otherwise, false. + + + Gets a value that indicates whether this structure has the signature attribute. + true if the attribute is present; otherwise, false. + + + Gets a value that indicates whether this structure has the signature attribute. + true if the attribute is present; otherwise, false. + + + Gets the signature kind. + The signature kind. + + + Compares two values for equality. + The first value to compare. + The second value to compare. + true if the values are equal; otherwise, false. + + + Determines whether two values are unequal. + The first value to compare. + The second value to compare. + true if the values are unequal; otherwise, false. + + + Gets the raw value of the header byte. + The raw value of the header byte. + + + Returns a string that represents the current object. + A string that represents the current object. + + + Specifies the signature kind. The underlying values of the fields in this type correspond to the representation in the leading signature byte represented by a structure. + + + A field signature. + + + + A local variables signature. + + + + A method reference, method definition, or standalone method signature. + + + + A method specification signature. + + + + A property signature. + + + + Specifies constants that define type codes used in signature encoding. + + + Represents a generalized in signatures. + + + + Represents a in signatures. + + + + Represents managed pointers (byref return values and parameters) in signatures. It is followed in the blob by the signature encoding of the underlying type. + + + + Represents a in signatures. + + + + Represents a in signatures. + + + + Represents a in signatures. + + + + Represents function pointer types in signatures. + + + + Represents a generic method parameter used within a signature. + + + + Represents the instantiation of a generic type in signatures. + + + + Represents a generic type parameter used within a signature. + + + + Represents an in signatures. + + + + Represents an in signatures. + + + + Represents an in signatures. + + + + Represents an in signatures. + + + + Represents an invalid or uninitialized type code. It will not appear in valid signatures. + + + + Represents an in signatures. + + + + Represents a custom modifier applied to a type within a signature that the caller can ignore. + + + + Represents a local variable that is pinned by garbage collector. + + + + Represents an unmanaged pointer in signatures. It is followed in the blob by the signature encoding of the underlying type. + + + + Represents a custom modifier applied to a type within a signature that the caller must understand. + + + + Represents an in signatures. + + + + Represents a marker to indicate the end of fixed arguments and the beginning of variable arguments. + + + + Represents a in signatures. + + + + Represents a in signatures. + + + + Represents a single dimensional with a lower bound of 0. + + + + Represents a typed reference in signatures. + + + + Precedes a type in signatures. + + + + Represents a in signatures. + + + + Represents a in signatures. + + + + Represents a in signatures. + + + + Represents a in signatures. + + + + Represents in signatures. + + + + Indicates the type definition of the signature. + + + The type definition or reference refers to a class. + + + + It isn&#39;t known in the current context if the type reference or definition is a class or value type. + + + + The type definition or reference refers to a value type. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Indicates whether a represents a standalone method or local variable signature. + + + The references a local variable signature. + + + + The represents a standalone method signature. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/packages/FAKE.5.16.0/tools/System.Reflection.Primitives.dll b/packages/FAKE.5.16.0/tools/System.Reflection.Primitives.dll new file mode 100644 index 0000000..2c160e9 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Reflection.Primitives.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Reflection.dll b/packages/FAKE.5.16.0/tools/System.Reflection.dll new file mode 100644 index 0000000..ec0b3d2 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Reflection.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Resources.Reader.dll b/packages/FAKE.5.16.0/tools/System.Resources.Reader.dll new file mode 100644 index 0000000..a34c693 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Resources.Reader.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Resources.ResourceManager.dll b/packages/FAKE.5.16.0/tools/System.Resources.ResourceManager.dll new file mode 100644 index 0000000..c4a14ce Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Resources.ResourceManager.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Resources.Writer.dll b/packages/FAKE.5.16.0/tools/System.Resources.Writer.dll new file mode 100644 index 0000000..0ce2946 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Resources.Writer.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Runtime.CompilerServices.Unsafe.dll b/packages/FAKE.5.16.0/tools/System.Runtime.CompilerServices.Unsafe.dll new file mode 100644 index 0000000..d99e9f9 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Runtime.CompilerServices.Unsafe.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Runtime.CompilerServices.Unsafe.xml b/packages/FAKE.5.16.0/tools/System.Runtime.CompilerServices.Unsafe.xml new file mode 100644 index 0000000..6a7cfcf --- /dev/null +++ b/packages/FAKE.5.16.0/tools/System.Runtime.CompilerServices.Unsafe.xml @@ -0,0 +1,200 @@ + + + System.Runtime.CompilerServices.Unsafe + + + + Contains generic, low-level functionality for manipulating pointers. + + + Adds an element offset to the given reference. + The reference to add the offset to. + The offset to add. + The type of reference. + A new reference that reflects the addition of offset to pointer. + + + Adds an element offset to the given reference. + The reference to add the offset to. + The offset to add. + The type of reference. + A new reference that reflects the addition of offset to pointer. + + + Adds a byte offset to the given reference. + The reference to add the offset to. + The offset to add. + The type of reference. + A new reference that reflects the addition of byte offset to pointer. + + + Determines whether the specified references point to the same location. + The first reference to compare. + The second reference to compare. + The type of reference. + true if left and right point to the same location; otherwise, false. + + + Casts the given object to the specified type. + The object to cast. + The type which the object will be cast to. + The original object, casted to the given type. + + + Reinterprets the given reference as a reference to a value of type TTo. + The reference to reinterpret. + The type of reference to reinterpret.. + The desired type of the reference. + A reference to a value of type TTo. + + + Returns a pointer to the given by-ref parameter. + The object whose pointer is obtained. + The type of object. + A pointer to the given value. + + + Reinterprets the given location as a reference to a value of type T. + The location of the value to reference. + The type of the interpreted location. + A reference to a value of type T. + + + Determines the byte offset from origin to target from the given references. + The reference to origin. + The reference to target. + The type of reference. + Byte offset from origin to target i.e. target - origin. + + + Copies a value of type T to the given location. + The location to copy to. + A reference to the value to copy. + The type of value to copy. + + + Copies a value of type T to the given location. + The location to copy to. + A pointer to the value to copy. + The type of value to copy. + + + Copies bytes from the source address to the destination address. + The destination address to copy to. + The source address to copy from. + The number of bytes to copy. + + + Copies bytes from the source address to the destination address. + The destination address to copy to. + The source address to copy from. + The number of bytes to copy. + + + Copies bytes from the source address to the destination address +without assuming architecture dependent alignment of the addresses. + The destination address to copy to. + The source address to copy from. + The number of bytes to copy. + + + Copies bytes from the source address to the destination address +without assuming architecture dependent alignment of the addresses. + The destination address to copy to. + The source address to copy from. + The number of bytes to copy. + + + Initializes a block of memory at the given location with a given initial value. + The address of the start of the memory block to initialize. + The value to initialize the block to. + The number of bytes to initialize. + + + Initializes a block of memory at the given location with a given initial value. + The address of the start of the memory block to initialize. + The value to initialize the block to. + The number of bytes to initialize. + + + Initializes a block of memory at the given location with a given initial value +without assuming architecture dependent alignment of the address. + The address of the start of the memory block to initialize. + The value to initialize the block to. + The number of bytes to initialize. + + + Initializes a block of memory at the given location with a given initial value +without assuming architecture dependent alignment of the address. + The address of the start of the memory block to initialize. + The value to initialize the block to. + The number of bytes to initialize. + + + Reads a value of type T from the given location. + The location to read from. + The type to read. + An object of type T read from the given location. + + + Reads a value of type T from the given location +without assuming architecture dependent alignment of the addresses. + The location to read from. + The type to read. + An object of type T read from the given location. + + + Reads a value of type T from the given location +without assuming architecture dependent alignment of the addresses. + The location to read from. + The type to read. + An object of type T read from the given location. + + + Returns the size of an object of the given type parameter. + The type of object whose size is retrieved. + The size of an object of type T. + + + Subtracts an element offset from the given reference. + The reference to subtract the offset from. + The offset to subtract. + The type of reference. + A new reference that reflects the subraction of offset from pointer. + + + Subtracts an element offset from the given reference. + The reference to subtract the offset from. + The offset to subtract. + The type of reference. + A new reference that reflects the subraction of offset from pointer. + + + Subtracts a byte offset from the given reference. + The reference to subtract the offset from. + + The type of reference. + A new reference that reflects the subraction of byte offset from pointer. + + + Writes a value of type T to the given location. + The location to write to. + The value to write. + The type of value to write. + + + Writes a value of type T to the given location +without assuming architecture dependent alignment of the addresses. + The location to write to. + The value to write. + The type of value to write. + + + Writes a value of type T to the given location +without assuming architecture dependent alignment of the addresses. + The location to write to. + The value to write. + The type of value to write. + + + \ No newline at end of file diff --git a/packages/FAKE.5.16.0/tools/System.Runtime.CompilerServices.VisualC.dll b/packages/FAKE.5.16.0/tools/System.Runtime.CompilerServices.VisualC.dll new file mode 100644 index 0000000..30a2f81 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Runtime.CompilerServices.VisualC.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Runtime.Extensions.dll b/packages/FAKE.5.16.0/tools/System.Runtime.Extensions.dll new file mode 100644 index 0000000..eb0e80b Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Runtime.Extensions.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Runtime.Handles.dll b/packages/FAKE.5.16.0/tools/System.Runtime.Handles.dll new file mode 100644 index 0000000..37f15ff Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Runtime.Handles.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Runtime.InteropServices.RuntimeInformation.dll b/packages/FAKE.5.16.0/tools/System.Runtime.InteropServices.RuntimeInformation.dll new file mode 100644 index 0000000..c3e0c71 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Runtime.InteropServices.RuntimeInformation.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Runtime.InteropServices.dll b/packages/FAKE.5.16.0/tools/System.Runtime.InteropServices.dll new file mode 100644 index 0000000..ab54429 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Runtime.InteropServices.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Runtime.Numerics.dll b/packages/FAKE.5.16.0/tools/System.Runtime.Numerics.dll new file mode 100644 index 0000000..3202cd9 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Runtime.Numerics.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Runtime.Serialization.Formatters.dll b/packages/FAKE.5.16.0/tools/System.Runtime.Serialization.Formatters.dll new file mode 100644 index 0000000..06b5480 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Runtime.Serialization.Formatters.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Runtime.Serialization.Json.dll b/packages/FAKE.5.16.0/tools/System.Runtime.Serialization.Json.dll new file mode 100644 index 0000000..1f30098 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Runtime.Serialization.Json.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Runtime.Serialization.Primitives.dll b/packages/FAKE.5.16.0/tools/System.Runtime.Serialization.Primitives.dll new file mode 100644 index 0000000..19a6dd2 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Runtime.Serialization.Primitives.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Runtime.Serialization.Xml.dll b/packages/FAKE.5.16.0/tools/System.Runtime.Serialization.Xml.dll new file mode 100644 index 0000000..3a839e2 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Runtime.Serialization.Xml.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Runtime.dll b/packages/FAKE.5.16.0/tools/System.Runtime.dll new file mode 100644 index 0000000..344ee77 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Runtime.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Security.Claims.dll b/packages/FAKE.5.16.0/tools/System.Security.Claims.dll new file mode 100644 index 0000000..9cb6423 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Security.Claims.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Security.Cryptography.Algorithms.dll b/packages/FAKE.5.16.0/tools/System.Security.Cryptography.Algorithms.dll new file mode 100644 index 0000000..01b7bb5 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Security.Cryptography.Algorithms.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Security.Cryptography.Csp.dll b/packages/FAKE.5.16.0/tools/System.Security.Cryptography.Csp.dll new file mode 100644 index 0000000..d7721e7 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Security.Cryptography.Csp.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Security.Cryptography.Encoding.dll b/packages/FAKE.5.16.0/tools/System.Security.Cryptography.Encoding.dll new file mode 100644 index 0000000..f588614 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Security.Cryptography.Encoding.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Security.Cryptography.Primitives.dll b/packages/FAKE.5.16.0/tools/System.Security.Cryptography.Primitives.dll new file mode 100644 index 0000000..35a21ef Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Security.Cryptography.Primitives.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Security.Cryptography.X509Certificates.dll b/packages/FAKE.5.16.0/tools/System.Security.Cryptography.X509Certificates.dll new file mode 100644 index 0000000..53d05b2 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Security.Cryptography.X509Certificates.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Security.Principal.dll b/packages/FAKE.5.16.0/tools/System.Security.Principal.dll new file mode 100644 index 0000000..6d7c2ba Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Security.Principal.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Security.SecureString.dll b/packages/FAKE.5.16.0/tools/System.Security.SecureString.dll new file mode 100644 index 0000000..355a050 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Security.SecureString.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Text.Encoding.CodePages.dll b/packages/FAKE.5.16.0/tools/System.Text.Encoding.CodePages.dll new file mode 100644 index 0000000..d0f7adf Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Text.Encoding.CodePages.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Text.Encoding.Extensions.dll b/packages/FAKE.5.16.0/tools/System.Text.Encoding.Extensions.dll new file mode 100644 index 0000000..4f2b83d Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Text.Encoding.Extensions.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Text.Encoding.dll b/packages/FAKE.5.16.0/tools/System.Text.Encoding.dll new file mode 100644 index 0000000..557551f Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Text.Encoding.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Text.RegularExpressions.dll b/packages/FAKE.5.16.0/tools/System.Text.RegularExpressions.dll new file mode 100644 index 0000000..1a64a17 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Text.RegularExpressions.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Threading.Overlapped.dll b/packages/FAKE.5.16.0/tools/System.Threading.Overlapped.dll new file mode 100644 index 0000000..5d7e7b7 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Threading.Overlapped.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Threading.Tasks.Extensions.dll b/packages/FAKE.5.16.0/tools/System.Threading.Tasks.Extensions.dll new file mode 100644 index 0000000..2460649 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Threading.Tasks.Extensions.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Threading.Tasks.Extensions.xml b/packages/FAKE.5.16.0/tools/System.Threading.Tasks.Extensions.xml new file mode 100644 index 0000000..5e02a99 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/System.Threading.Tasks.Extensions.xml @@ -0,0 +1,166 @@ + + + System.Threading.Tasks.Extensions + + + + + + + + + + + + + + + + + + + Provides a value type that wraps a and a TResult, only one of which is used. + The result. + + + Initializes a new instance of the class using the supplied task that represents the operation. + The task. + The task argument is null. + + + Initializes a new instance of the class using the supplied result of a successful operation. + The result. + + + Retrieves a object that represents this . + The object that is wrapped in this if one exists, or a new object that represents the result. + + + Configures an awaiter for this value. + true to attempt to marshal the continuation back to the captured context; otherwise, false. + The configured awaiter. + + + Creates a method builder for use with an async method. + The created builder. + + + Determines whether the specified object is equal to the current object. + The object to compare with the current object. + true if the specified object is equal to the current object; otherwise, false. + + + Determines whether the specified object is equal to the current object. + The object to compare with the current object. + true if the specified object is equal to the current object; otherwise, false. + + + Creates an awaiter for this value. + The awaiter. + + + Returns the hash code for this instance. + The hash code for the current object. + + + Gets a value that indicates whether this object represents a canceled operation. + true if this object represents a canceled operation; otherwise, false. + + + Gets a value that indicates whether this object represents a completed operation. + true if this object represents a completed operation; otherwise, false. + + + Gets a value that indicates whether this object represents a successfully completed operation. + true if this object represents a successfully completed operation; otherwise, false. + + + Gets a value that indicates whether this object represents a failed operation. + true if this object represents a failed operation; otherwise, false. + + + Compares two values for equality. + The first value to compare. + The second value to compare. + true if the two values are equal; otherwise, false. + + + Determines whether two values are unequal. + The first value to compare. + The seconed value to compare. + true if the two values are not equal; otherwise, false. + + + Gets the result. + The result. + + + Returns a string that represents the current object. + A string that represents the current object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/packages/FAKE.5.16.0/tools/System.Threading.Tasks.Parallel.dll b/packages/FAKE.5.16.0/tools/System.Threading.Tasks.Parallel.dll new file mode 100644 index 0000000..c4df330 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Threading.Tasks.Parallel.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Threading.Tasks.dll b/packages/FAKE.5.16.0/tools/System.Threading.Tasks.dll new file mode 100644 index 0000000..25999be Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Threading.Tasks.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Threading.Thread.dll b/packages/FAKE.5.16.0/tools/System.Threading.Thread.dll new file mode 100644 index 0000000..9b7da65 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Threading.Thread.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Threading.ThreadPool.dll b/packages/FAKE.5.16.0/tools/System.Threading.ThreadPool.dll new file mode 100644 index 0000000..9405b8f Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Threading.ThreadPool.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Threading.Timer.dll b/packages/FAKE.5.16.0/tools/System.Threading.Timer.dll new file mode 100644 index 0000000..c9eae71 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Threading.Timer.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Threading.dll b/packages/FAKE.5.16.0/tools/System.Threading.dll new file mode 100644 index 0000000..deae2be Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Threading.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.ValueTuple.dll b/packages/FAKE.5.16.0/tools/System.ValueTuple.dll new file mode 100644 index 0000000..502f8cd Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.ValueTuple.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Xml.ReaderWriter.dll b/packages/FAKE.5.16.0/tools/System.Xml.ReaderWriter.dll new file mode 100644 index 0000000..24df9a0 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Xml.ReaderWriter.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Xml.XDocument.dll b/packages/FAKE.5.16.0/tools/System.Xml.XDocument.dll new file mode 100644 index 0000000..cbbc4f0 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Xml.XDocument.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Xml.XPath.XDocument.dll b/packages/FAKE.5.16.0/tools/System.Xml.XPath.XDocument.dll new file mode 100644 index 0000000..0830ed1 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Xml.XPath.XDocument.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Xml.XPath.dll b/packages/FAKE.5.16.0/tools/System.Xml.XPath.dll new file mode 100644 index 0000000..8327f2e Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Xml.XPath.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Xml.XmlDocument.dll b/packages/FAKE.5.16.0/tools/System.Xml.XmlDocument.dll new file mode 100644 index 0000000..4f044b1 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Xml.XmlDocument.dll differ diff --git a/packages/FAKE.5.16.0/tools/System.Xml.XmlSerializer.dll b/packages/FAKE.5.16.0/tools/System.Xml.XmlSerializer.dll new file mode 100644 index 0000000..7b47de8 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/System.Xml.XmlSerializer.dll differ diff --git a/packages/FAKE.5.16.0/tools/VSFile.dll b/packages/FAKE.5.16.0/tools/VSFile.dll new file mode 100644 index 0000000..35e6df2 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/VSFile.dll differ diff --git a/packages/FAKE.5.16.0/tools/VSFile.xml b/packages/FAKE.5.16.0/tools/VSFile.xml new file mode 100644 index 0000000..73de615 --- /dev/null +++ b/packages/FAKE.5.16.0/tools/VSFile.xml @@ -0,0 +1,951 @@ + + + + VSFile + + + + + Represents a Visual Basic project file. + + + + + Represents a Visual Studio project file. + + + Type of Visual Studio source file referenced in this Visual Studio project file. + + + + + Represents a Visual Studio file. + + + + + File extension of Visual Studio file. + + + + + File path to Visual Studio file. + + + + + Constructor. + + + String representing file extension of Visual Studio file. + + + String representing file path to Visual Studio file. + + + + + Load file. + + + + + Get full path combining directory path and given relative path. + + + String representing relative path. + + + String representing full path combining directory path and given relative path. + + + + + Read file. + + + + + Throw exception if file extension is invalid. + + + + + Throw exception if file path is invalid. + + + + + Get path to directory containing file. + + + String representing path to directory containing this Visual Studio file. + + + + + Get file extension. + + + String representing file extension of this Visual Studio file. + + + + + Get file name. + + + String representing file name of this Visual Studio file. + + + + + Get file name with no file extension. + + + String representing file name of this Visual Studio file with no file extension. + + + + + Get file path. + + + String representing file path to this Visual Studio file. + + + + + Namespace used in project file. + + + + + Namespace prefix used in XPath expressions. + + + + + Name of project. + + + + + File extension of source files referenced in this project file. + + + + + Source files referenced in this project file. + + + + + Constructor for specifying file path. + + + String representing file extension of Visual Studio project file. + + + String representing path to Visual Studio project file. + + + String representing file extension of Visual Studio source files + referenced in this Visual Studio project file. + + + + + Constructor for specifying project name. + + + String representing Visual Studio project name. + + + String representing file extension of Visual Studio project file. + + + String representing path to Visual Studio project file. + + + String representing file extension of Visual Studio source files + referenced in this Visual Studio project file. + + + + + Create instance of source file with given file path. + + + String representing file path. + + + Instance of source file with given file path. + + + + + Read file. + + + + + Add source file contained within given XML node and namespace manager. + + + XmlNode containing source file. + + + XmlNamespaceManager managing XML namespace used in project file. + + + + + Clear referenced source files. + + + + + Get project name. + + + String representing project name. + + + + + Get file extension of Visual Studio source files referenced in this project file. + + + String representing Visual Studio source file extension. + + + + + Get Visual Studio source files referenced in this project file. + + + Enumerable collection of objects representing Visual Studio source + files referenced in this project file. + + + + + XPath expressions used to select elements and attributes in project file. + + + + + File extension of a Visual Basic project file. + + + + + Constructor for specifying file path. + + + String representing path to Visual Basic project file. + + + + + Constructor for specifying project name. + + + String representing Visual Basic project name. + + + String representing path to Visual Basic project file. + + + + + Create instance of source file with given file path. + + + String representing file path. + + + Instance of source file with given file path. + + + + + Represents a Visual C# project file. + + + + + File extension of a Visual C# project file. + + + + + Constructor for specifying file path. + + + String representing path to Visual C# project file. + + + + + Constructor for specifying project name. + + + String representing Visual C# project name. + + + String representing path to Visual C# project file. + + + + + Create instance of source file with given file path. + + + String representing file path. + + + Instance of source file with given file path. + + + + + Represents a Visual F# project file. + + + + + File extension of a Visual F# project file. + + + + + Constructor for specifying file path. + + + String representing path to Visual F# project file. + + + + + Constructor for specifying project name. + + + String representing Visual F# project name. + + + String representing path to Visual F# project file. + + + + + Create instance of source file with given file path. + + + String representing file path. + + + Instance of source file with given file path. + + + + + Represents an ASP.NET web site directory. + + + + + Supported web site file extensions. + + + + + Visual Basic source files contained in this web site. + + + + + Visual C# source files contained in this web site. + + + + + Path to directory containing web site files. + + + + + Web site name. + + + + + Constructor. + + + String representing web site name. + + + String representing path to directory containing web site files. + + + + + Load web site files. + + + + + Throw exception if directory path is invalid. + + + + + Clear web site files. + + + + + Load web site files. + + + + + Get Visual Basic source files contained in this web site. + + + Enumerable collection of BasicSourceFile objects representing + Visual Basic source files contained in this web site. + + + + + Get Visual C# source files contained in this web site. + + + Enumerable collection of CSharpSourceFile objects representing + Visual C# source files contained in this web site. + + + + + Get directory path. + + + String representing path to directory containing web site files. + + + + + Get web site name. + + + String representing web site name. + + + + + Represents a Visual Basic source file. + + + + + Represents a Visual Studio source file. + + + + + Constructor. + + + String representing file extension of Visual Studio source file. + + + String representing file path to Visual Studio source file. + + + + + Read file. + + + + + File extension of a Visual Basic source file. + + + + + Constructor. + + + String representing file path to Visual Basic source file. + + + + + Represents a Visual C# source file. + + + + + File extension of a Visual C# source file. + + + + + Constructor. + + + String representing file path to Visual C# source file. + + + + + Represents a Visual Studio solution file. + + + + + File extension of solution file. + + + + + Visual Basic project files referenced in this solution file. + + + + + Visual C# project files referenced in this solution file. + + + + + Visual F# project files referenced in this solution file. + + + + + ASP.NET web site directories referenced in this solution file. + + + + + Constructor. + + + String representing path to solution file. + + + + + Read file. + + + + + Add project given line of input from solution file. + + + String representing line of input from solution file. + + + + + Clear referenced project files. + + + + + Get match value at given group name. + + + Match representing regular expression match results. + + + String representing name of group to match in given match results. + + + String representing match value at given group name. + + + + + Get Visual Basic project files referenced in this solution file. + + + Enumerable collection of BasicProjectFile objects representing + Visual Basic project files referenced in this solution file. + + + + + Get Visual C# project files referenced in this solution file. + + + Enumerable collection of CSharpProjectFile objects representing + Visual C# project files referenced in this solution file. + + + + + Get Visual F# project files referenced in this solution file. + + + Enumerable collection of FSharpProjectFile objects representing + Visual F# project files referenced in this solution file. + + + + + Get ASP.NET web site directories referenced in this solution file. + + + Enumerable collection of WebSiteDirectory objects representing + ASP.NET web site directories referenced in this solution file. + + + + + Project tag contained in solution file. + + + + + Beginning of project tag. + + + + + Regular expression used to obtain data in project tag. + + + + + Group used to match project name. + + + + + Group used to match project path. + + + + + Pattern used to match project GUIDs, name and path. + + + + + Group used to match project type GUID. + + + + + Group used to match project unique GUID. + + + + + Pattern used to match project name. + + + + + Pattern used to match project path. + + + + + GUID patterns. + + + + + Pattern used to match project type GUID. + + + + + Pattern used to match project unique GUID. + + + + + Beginning of GUID pattern. + + + + + End of GUID pattern. + + + + + GUIDs used to identify types of projects. + + + + + Visual Basic project type. + + + + + Visual C# project type. + + + + + Visual F# project type. + + + + + ASP.NET web site project type. + + + + + Represents a Visual F# source file. + + + + + File extension of a Visual F# source file. + + + + + Constructor. + + + String representing file path to Visual F# source file. + + + + + Manages multiple Visual Studio files of varying type. + + + + + Supported file extensions. + + + + + Initialized Visual Basic project files. + + + + + Initialized Visual Basic source files. + + + + + Initialized Visual C# project files. + + + + + Initialized Visual C# source files. + + + + + Initialized Visual F# project files. + + + + + Initialized Visual F# source files. + + + + + Option to use when searching for files. + + + + + Initialized Visual Studio solution files. + + + + + Constructor for specifying file paths. + + + Enumerable collection of strings representing file paths. + + + + + Constructor for specifying recursive search option. + + + Enumerable collection of strings representing file paths. + + + True if all subdirectories in given file paths are also to be + searched, false otherwise. + + + + + Initialize Visual Studio files at given paths. + + + Enumerable collection of strings representing file paths. + + + + + Initialize file at given path. + + + String representing file path. + + + + + Initialize file at given path with given supported extension. + + + String representing file path. + + + String representing supported file extension. + + + + + Determine if given file extension is supported. + + + String representing file extension. + + + True if file extension is supported, false otherwise. + + + + + Get initialized Visual Basic project files. + + + Enumerable collection of BasicProjectFile objects representing + initialized Visual Basic project files. + + + + + Get initialized Visual Basic source files. + + + Enumerable collection of BasicSourceFile objects representing + initialized Visual Basic source files. + + + + + Get initialized Visual C# project files. + + + Enumerable collection of CSharpProjectFile objects representing + initialized Visual C# project files. + + + + + Get initialized Visual C# source files. + + + Enumerable collection of CSharpSourceFile objects representing + initialized Visual C# source files. + + + + + Get initialized Visual F# project files. + + + Enumerable collection of FSharpProjectFile objects representing + initialized Visual F# project files. + + + + + Get initialized Visual F# source files. + + + Enumerable collection of FSharpSourceFile objects representing + initialized Visual F# source files. + + + + + Get initialized Visual Studio solution files. + + + Enumerable collection of SolutionFile objects representing + initialized Visual Studio solution files. + + + + + Get option to use when searching for files. + + + SearchOption enumeration value specifying whether to search all + subdirectories for files or only current directory. + + + + + Wildcard characters contained in file paths. + + + + + Zero or more characters. + + + + + Zero or one character. + + + + + Wildcard characters. + + + + + Add asterisk wildcard character to given file extension. + + + String representing file extension. + + + String representing file extension prefixed with asterisk wildcard character. + + + + + Determine if given file path contains any wildcard characters. + + + String representing file path. + + + True if file path contains any wildcard characters, false otherwise. + + + + diff --git a/packages/FAKE.5.16.0/tools/netstandard.dll b/packages/FAKE.5.16.0/tools/netstandard.dll new file mode 100644 index 0000000..1f1ab22 Binary files /dev/null and b/packages/FAKE.5.16.0/tools/netstandard.dll differ diff --git a/packages/FSharp.Core.4.0.0.1/FSharp.Core.4.0.0.1.nupkg b/packages/FSharp.Core.4.0.0.1/FSharp.Core.4.0.0.1.nupkg deleted file mode 100644 index e562cbc..0000000 Binary files a/packages/FSharp.Core.4.0.0.1/FSharp.Core.4.0.0.1.nupkg and /dev/null differ diff --git a/packages/FSharp.Core.4.0.0.1/lib/net20/FSharp.Core.dll b/packages/FSharp.Core.4.0.0.1/lib/net20/FSharp.Core.dll deleted file mode 100644 index f27c8a0..0000000 Binary files a/packages/FSharp.Core.4.0.0.1/lib/net20/FSharp.Core.dll and /dev/null differ diff --git a/packages/FSharp.Core.4.0.0.1/lib/net20/FSharp.Core.optdata b/packages/FSharp.Core.4.0.0.1/lib/net20/FSharp.Core.optdata deleted file mode 100644 index d635db2..0000000 Binary files a/packages/FSharp.Core.4.0.0.1/lib/net20/FSharp.Core.optdata and /dev/null differ diff --git a/packages/FSharp.Core.4.0.0.1/lib/net20/FSharp.Core.sigdata b/packages/FSharp.Core.4.0.0.1/lib/net20/FSharp.Core.sigdata deleted file mode 100644 index 75d3484..0000000 Binary files a/packages/FSharp.Core.4.0.0.1/lib/net20/FSharp.Core.sigdata and /dev/null differ diff --git a/packages/FSharp.Core.4.0.0.1/lib/net20/FSharp.Core.xml b/packages/FSharp.Core.4.0.0.1/lib/net20/FSharp.Core.xml deleted file mode 100644 index d9862e3..0000000 --- a/packages/FSharp.Core.4.0.0.1/lib/net20/FSharp.Core.xml +++ /dev/null @@ -1,9715 +0,0 @@ - - -FSharp.Core - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Gets the tail of the list, which is a list containing all the elements of the list, excluding the first element - - - Gets the number of items contained in the list - - - Gets the element of the list at the given position. - Lists are represented as linked lists so this is an O(n) operation. - The index. - The value at the given index. - - - Gets a value indicating if the list contains no entries - - - Gets the first element of the list - - - Returns an empty list of a particular type - - - Returns a list with head as its first element and tail as its subsequent elements - A new head value for the list. - The existing list. - The list with head appended to the front of tail. - - - The type of immutable singly-linked lists. - - Use the constructors [] and :: (infix) to create values of this type, or - the notation [1;2;3]. Use the values in the List module to manipulate - values of this type, or pattern match against the values directly. - - - Lookup an element in the map. Raise KeyNotFoundException if no binding - exists in the map. - The input key. - Thrown when the key is not found. - The value mapped to the key. - - - Returns true if there are no bindings in the map. - - - The number of bindings in the map. - - - Lookup an element in the map, returning a Some value if the element is in the domain - of the map and None if not. - The input key. - The mapped value, or None if the key is not in the map. - - - Removes an element from the domain of the map. No exception is raised if the element is not present. - The input key. - The resulting map. - - - - - - Tests if an element is in the domain of the map. - The input key. - True if the map contains the given key. - - - Returns a new map with the binding added to the given map. - The input key. - The resulting map. - - - Builds a map that contains the bindings of the given IEnumerable. - The input sequence of key/value pairs. - The resulting map. - - - Immutable maps. Keys are ordered by F# generic comparison. - - Maps based on generic comparison are efficient for small keys. They are not a suitable choice if keys are recursive data structures - or if keys require bespoke comparison semantics. - - All members of this class are thread-safe and may be used concurrently from multiple threads. - - - An abbreviation for the CLI type System.Collections.Generic.List<_> - - - Returns a new set with the elements of the second set removed from the first. - The first input set. - The second input set. - A set containing elements of the first set that are not contained in the second set. - - - Compute the union of the two sets. - The first input set. - The second input set. - The union of the two input sets. - - - Returns the lowest element in the set according to the ordering being used for the set. - - - Returns the highest element in the set according to the ordering being used for the set. - - - A useful shortcut for Set.isEmpty. See the Set module for further operations on sets. - - - The number of elements in the set - - - A useful shortcut for Set.remove. Note this operation produces a new set - and does not mutate the original set. The new set will share many storage - nodes with the original. See the Set module for further operations on sets. - The value to remove from the set. - The result set. - - - Evaluates to "true" if all elements of the second set are in the first. - The set to test against. - True if this set is a superset of otherSet. - - - Evaluates to "true" if all elements of the first set are in the second. - The set to test against. - True if this set is a subset of otherSet. - - - Evaluates to "true" if all elements of the second set are in the first, and at least - one element of the first is not in the second. - The set to test against. - True if this set is a proper superset of otherSet. - - - Evaluates to "true" if all elements of the first set are in the second, and at least - one element of the second is not in the first. - The set to test against. - True if this set is a proper subset of otherSet. - - - - - - A useful shortcut for Set.contains. See the Set module for further operations on sets. - The value to check. - True if the set contains value. - - - A useful shortcut for Set.add. Note this operation produces a new set - and does not mutate the original set. The new set will share many storage - nodes with the original. See the Set module for further operations on sets. - The value to add to the set. - The result set. - - - Create a set containing elements drawn from the given sequence. - The input sequence. - The result set. - - - Immutable sets based on binary trees, where comparison is the - F# structural comparison function, potentially using implementations - of the IComparable interface on key values. - - See the Set module for further operations on sets. - - All members of this class are thread-safe and may be used concurrently from multiple threads. - - - An abbreviation for the type of immutable singly-linked lists. - - Use the constructors [] and :: (infix) to create values of this type, or - the notation [1;2;3]. Use the values in the List module to manipulate - values of this type, or pattern match against the values directly. - - - An abbreviation for the CLI type System.Collections.Generic.IEnumerable<_> - - - Fetches an element from a 2D array. You can also use the syntax array.[index1,index2]. - - The input array. - The index along the first dimension. - The index along the second dimension. - - The value of the array at the given index. - Thrown when the indices are negative or exceed the bounds of the array. - - - Sets the value of an element in an array. You can also use the syntax array.[index1,index2] <- value. - - The input array. - The index along the first dimension. - The index along the second dimension. - The value to set in the array. - Thrown when the indices are negative or exceed the bounds of the array. - - - Builds a new array whose elements are the same as the input array but - where a non-zero-based input array generates a corresponding zero-based - output array. - - The input array. - - The zero-based output array. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer indices passed to the - function indicates the element being transformed. - - For non-zero-based arrays the basing on an input array will be propagated to the output - array. - - A function that is applied to transform each element of the array. The two integers - provide the index of the element. - The input array. - - An array whose elements have been transformed by the given mapping. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - - A function that is applied to transform each item of the input array. - The input array. - - An array whose elements have been transformed by the given mapping. - - - Returns the length of an array in the second dimension. - - The input array. - - The length of the array in the second dimension. - - - Returns the length of an array in the first dimension. - - The input array. - - The length of the array in the first dimension. - - - Applies the given function to each element of the array. The integer indices passed to the - function indicates the index of element. - - A function to apply to each element of the array with the indices available as an argument. - The input array. - - - Applies the given function to each element of the array. - - A function to apply to each element of the array. - The input array. - - - Creates a based array where the entries are initially Unchecked.defaultof<'T>. - - The base for the first dimension of the array. - The base for the second dimension of the array. - The length of the first dimension of the array. - The length of the second dimension of the array. - - The created array. - Thrown when base1, base2, length1, or length2 is negative. - - - Creates a based array whose elements are all initially the given value. - - The base for the first dimension of the array. - The base for the second dimension of the array. - The length of the first dimension of the array. - The length of the second dimension of the array. - The value to populate the new array. - - The created array. - Thrown when base1, base2, length1, or length2 is negative. - - - Creates a based array given the dimensions and a generator function to compute the elements. - - The base for the first dimension of the array. - The base for the second dimension of the array. - The length of the first dimension of the array. - The length of the second dimension of the array. - A function to produce elements of the array given the two indices. - - The created array. - Thrown when base1, base2, length1, or length2 is negative. - - - Creates an array where the entries are initially Unchecked.defaultof<'T>. - - The length of the first dimension of the array. - The length of the second dimension of the array. - - The created array. - Thrown when length1 or length2 is negative. - - - Creates an array whose elements are all initially the given value. - - The length of the first dimension of the array. - The length of the second dimension of the array. - The value to populate the new array. - - The created array. - Thrown when length1 or length2 is negative. - - - Creates an array given the dimensions and a generator function to compute the elements. - - The length of the first dimension of the array. - The length of the second dimension of the array. - A function to produce elements of the array given the two indices. - - The generated array. - Thrown when either of the lengths is negative. - - - Reads a range of elements from the first array and write them into the second. - - The source array. - The first-dimension index to begin copying from in the source array. - The second-dimension index to begin copying from in the source array. - The target array. - The first-dimension index to begin copying into in the target array. - The second-dimension index to begin copying into in the target array. - The number of elements to copy across the first dimension of the arrays. - The number of elements to copy across the second dimension of the arrays. - Thrown when any of the indices are negative or if either of - the counts are larger than the dimensions of the array allow. - - - Builds a new array whose elements are the same as the input array. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - - The input array. - - A copy of the input array. - - - Fetches the base-index for the second dimension of the array. - - The input array. - - The base-index of the second dimension of the array. - - - Fetches the base-index for the first dimension of the array. - - The input array. - - The base-index of the first dimension of the array. - - - Basic operations on 2-dimensional arrays. - - F# and CLI multi-dimensional arrays are typically zero-based. - However, CLI multi-dimensional arrays used in conjunction with external - libraries (e.g. libraries associated with Visual Basic) be - non-zero based, using a potentially different base for each dimension. - The operations in this module will accept such arrays, and - the basing on an input array will be propagated to a matching output - array on the Array2D.map and Array2D.mapi operations. - Non-zero-based arrays can also be created using Array2D.zeroCreateBased, - Array2D.createBased and Array2D.initBased. - - - Creates an array where the entries are initially the "default" value. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The created array. - - - Sets the value of an element in an array. You can also - use the syntax 'array.[index1,index2,index3] <- value'. - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The value to set at the given index. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer indices passed to the - function indicates the element being transformed. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - The function to transform the elements at each index in the array. - The input array. - The array created from the transformed elements. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - The function to transform each element of the array. - The input array. - The array created from the transformed elements. - - - Returns the length of an array in the third dimension. - The input array. - The length of the array in the third dimension. - - - Returns the length of an array in the second dimension. - The input array. - The length of the array in the second dimension. - - - Returns the length of an array in the first dimension - The input array. - The length of the array in the first dimension. - - - Applies the given function to each element of the array. The integer indicies passed to the - function indicates the index of element. - The function to apply to each element of the array. - The input array. - - - Applies the given function to each element of the array. - The function to apply to each element of the array. - The input array. - - - Fetches an element from a 3D array. You can also use the syntax 'array.[index1,index2,index3]' - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The value at the given index. - - - Creates an array given the dimensions and a generator function to compute the elements. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The function to create an initial value at each index into the array. - The created array. - - - Creates an array whose elements are all initially the given value. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The value of the array elements. - The created array. - - - Basic operations on rank 3 arrays. - - - Sets the value of an element in an array. You can also - use the syntax 'array.[index1,index2,index3,index4] <- value'. - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The index along the fourth dimension. - The value to set. - - - Fetches an element from a 4D array. You can also use the syntax 'array.[index1,index2,index3,index4]' - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The index along the fourth dimension. - The value at the given index. - - - Creates an array where the entries are initially the "default" value. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The length of the fourth dimension. - The created array. - - - Returns the length of an array in the fourth dimension. - The input array. - The length of the array in the fourth dimension. - - - Returns the length of an array in the third dimension. - The input array. - The length of the array in the third dimension. - - - Returns the length of an array in the second dimension. - The input array. - The length of the array in the second dimension. - - - Returns the length of an array in the first dimension - The input array. - The length of the array in the first dimension. - - - Creates an array given the dimensions and a generator function to compute the elements. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The length of the fourth dimension. - The function to create an initial value at each index in the array. - The created array. - - - Creates an array whose elements are all initially the given value - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The length of the fourth dimension. - The initial value for each element of the array. - The created array. - - - Basic operations on rank 4 arrays. - - - Combines three arrays into an array of pairs. The three arrays must have equal lengths, otherwise an ArgumentException is - raised. - The first input array. - The second input array. - The third input array. - Thrown when the input arrays differ in length. - The array of tupled elements. - - - Combines the two arrays into an array of pairs. The two arrays must have equal lengths, otherwise an ArgumentException is - raised. - The first input array. - The second input array. - Thrown when the input arrays differ in length. - The array of tupled elements. - - - Splits an array of triples into three arrays. - The input array. - The tuple of three arrays. - - - Splits an array of pairs into two arrays. - The input array. - The two arrays. - - - Returns the index of the first element in the array - that satisfies the given predicate. - The function to test the input elements. - The input array. - The index of the first element that satisfies the predicate, or None. - - - Returns the first element for which the given function returns true. - Return None if no such element exists. - The function to test the input elements. - The input array. - The first element that satisfies the predicate, or None. - - - Views the given array as a sequence. - The input array. - The sequence of array elements. - - - Builds a list from the given array. - The input array. - The list of array elements. - - - Returns the sum of the results generated by applying the function to each element of the array. - The function to transform the array elements into the type to be summed. - The input array. - The resulting sum. - - - Returns the sum of the elements in the array. - The input array. - The resulting sum. - - - Sorts the elements of an array by mutating the array in-place, using the given comparison function. - Elements are compared using Operators.compare. - The input array. - - - Sorts the elements of an array by mutating the array in-place, using the given comparison function as the order. - The function to compare pairs of array elements. - The input array. - - - Sorts the elements of an array by mutating the array in-place, using the given projection for the keys. - Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to transform array elements into the type that is compared. - The input array. - - - Sorts the elements of an array, using the given comparison function as the order, returning a new array. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to compare pairs of array elements. - The input array. - The sorted array. - - - Sorts the elements of an array, using the given projection for the keys and returning a new array. - Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to transform array elements into the type that is compared. - The input array. - The sorted array. - - - Sorts the elements of an array, returning a new array. Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The input array. - The sorted array. - - - Builds a new array that contains the given subrange specified by - starting index and length. - The input array. - The index of the first element of the sub array. - The length of the sub array. - The created sub array. - - - Sets an element of an array. - The input array. - The input index. - The input value. - - - Like foldBack, but return both the intermediary and final results. - The function to update the state given the input elements. - The input array. - The initial state. - The array of state values. - - - Like fold, but return the intermediary and final results. - The function to update the state given the input elements. - The initial state. - The input array. - The array of state values. - - - Returns a new array with the elements in reverse order. - The input array. - The reversed array. - - - Applies a function to each element of the array, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f i0 (...(f iN-1 iN)). - Raises ArgumentException if the array has size zero. - The function to reduce a pair of elements to a single element. - The input array. - Thrown when the input array is empty. - The final result of the reductions. - - - Applies a function to each element of the array, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f (... (f i0 i1)...) iN. - Raises ArgumentException if the array has size zero. - The function to reduce a pair of elements to a single element. - The input array. - Thrown when the input array is empty. - The final result of the redcutions. - - - Returns an array with all elements permuted according to the - specified permutation. - The function that maps input indices to output indices. - The input array. - The output array. - - - Splits the collection into two collections, containing the - elements for which the given predicate returns "true" and "false" - respectively. - The function to test the input elements. - The input array. - A pair of arrays. The first containing the elements the predicate evaluated to true, - and the second containing those evaluated to false. - - - Builds a new array from the given enumerable object. - The input sequence. - The array of elements from the sequence. - - - Builds an array from the given list. - The input list. - The array of elements from the list. - - - Returns the lowest of all elements of the array, compared via Operators.min on the function result. - - Throws ArgumentException for empty arrays. - The function to transform the elements into a type supporting comparison. - The input array. - Thrown when the input array is empty. - The minimum element. - - - Returns the lowest of all elements of the array, compared via Operators.min. - - Throws ArgumentException for empty arrays - The input array. - Thrown when the input array is empty. - The minimum element. - - - Returns the greatest of all elements of the array, compared via Operators.max on the function result. - - Throws ArgumentException for empty arrays. - The function to transform the elements into a type supporting comparison. - The input array. - Thrown when the input array is empty. - The maximum element. - - - Returns the greatest of all elements of the array, compared via Operators.max on the function result. - - Throws ArgumentException for empty arrays. - The input array. - Thrown when the input array is empty. - The maximum element. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer index passed to the - function indicates the index of element being transformed. - The function to transform elements and their indices. - The input array. - The array of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the two collections pairwise, also passing the index of - the elements. The two input arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to transform pairs of input elements and their indices. - The first input array. - The second input array. - Thrown when the input arrays differ in length. - The array of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the two collections pairwise. The two input - arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to transform the pairs of the input elements. - The first input array. - The second input array. - Thrown when the input arrays differ in length. - The array of transformed elements. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. - The function to transform elements of the array. - The input array. - The array of transformed elements. - - - Returns the length of an array. You can also use property arr.Length. - The input array. - The length of the array. - - - Applies the given function to pair of elements drawn from matching indices in two arrays, - also passing the index of the elements. The two arrays must have the same lengths, - otherwise an ArgumentException is raised. - The function to apply to each index and pair of elements. - The first input array. - The second input array. - Thrown when the input arrays differ in length. - - - Applies the given function to each element of the array. The integer passed to the - function indicates the index of element. - The function to apply to each index and element. - The input array. - - - Applies the given function to pair of elements drawn from matching indices in two arrays. The - two arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to apply. - The first input array. - The second input array. - Thrown when the input arrays differ in length. - - - Applies the given function to each element of the array. - The function to apply. - The input array. - - - Returns true if the given array is empty, otherwise false. - The input array. - True if the array is empty. - - - Creates an array where the entries are initially the default value Unchecked.defaultof<'T>. - The length of the array to create. - The created array. - - - Creates an array given the dimension and a generator function to compute the elements. - The number of elements to initialize. - The function to generate the initial values for each index. - The created array. - - - Gets an element from an array. - The input array. - The input index. - The value of the array at the given index. - - - Apply a function to pairs of elements drawn from the two collections, right-to-left, - threading an accumulator argument through the computation. The two input - arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to update the state given the input elements. - The first input array. - The second input array. - The initial state. - Thrown when the input arrays differ in length. - The final state. - - - Applies a function to pairs of elements drawn from the two collections, - left-to-right, threading an accumulator argument - through the computation. The two input - arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to update the state given the input elements. - The initial state. - The first input array. - The second input array. - Thrown when the input arrays differ in length. - The final state. - - - Applies a function to each element of the array, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then computes - f i0 (...(f iN s)) - The function to update the state given the input elements. - The input array. - The initial state. - The final state. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then computes - f (... (f s i0)...) iN - The function to update the state given the input elements. - The initial state. - The input array. - The final state. - - - Tests if all corresponding elements of the array satisfy the given predicate pairwise. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns false then the overall result is - false and no further elements are tested. Otherwise, if one collection is longer - than the other then the ArgumentException exception is raised. - Otherwise, true is returned. - The function to test the input elements. - The first input array. - The second input array. - Thrown when the input arrays differ in length. - True if all of the array elements satisfy the predicate. - - - Tests if all elements of the array satisfy the given predicate. - - The predicate is applied to the elements of the input collection. If any application - returns false then the overall result is false and no further elements are tested. - Otherwise, true is returned. - The function to test the input elements. - The input array. - True if all of the array elements satisfy the predicate. - - - Returns the index of the first element in the array - that satisfies the given predicate. Raise KeyNotFoundException if - none of the elements satisy the predicate. - The function to test the input elements. - The input array. - Thrown if predicate - never returns true. - The index of the first element in the array that satisfies the given predicate. - - - Returns the first element for which the given function returns 'true'. - Raise KeyNotFoundException if no such element exists. - The function to test the input elements. - The input array. - Thrown if predicate - never returns true. - The first element for which predicate returns true. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true". - The function to test the input elements. - The input array. - An array containing the elements for which the given predicate returns true. - - - Tests if any pair of corresponding elements of the arrays satisfies the given predicate. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns true then the overall result is - true and no further elements are tested. Otherwise, if one collections is longer - than the other then the ArgumentException exception is raised. - Otherwise, false is returned. - The function to test the input elements. - The first input array. - The second input array. - True if any result from predicate is true. - - - Tests if any element of the array satisfies the given predicate. - - The predicate is applied to the elements of the input array. If any application - returns true then the overall result is true and no further elements are tested. - Otherwise, false is returned. - The function to test the input elements. - The input array. - True if any result from predicate is true. - - - Returns an empty array of the given type. - - - Applies the given function to each element of the array. Returns - the array comprised of the results "x" for each element where - the function returns Some(x) - The function to generate options from the elements. - The input array. - The array of results. - - - Applies the given function to successive elements, returning the first - result where function returns Some(x) for some x. If the function - never returns Some(x) then KeyNotFoundException is raised. - The function to generate options from the elements. - The input array. - Thrown if every result from - chooser is None. - The first result. - - - Fills a range of elements of the array with the given value. - The target array. - The index of the first element to set. - The number of elements to set. - The value to set. - - - Applies the given function to successive elements, returning the first - result where function returns Some(x) for some x. If the function - never returns Some(x) then None is returned. - The function to transform the array elements into options. - The input array. - The first transformed element that is Some(x). - - - Creates an array whose elements are all initially the given value. - The length of the array to create. - The value for the elements. - The created array. - - - Builds a new array that contains the elements of the given array. - The input array. - A copy of the input array. - - - Builds a new array that contains the elements of each of the given sequence of arrays. - The input sequence of arrays. - The concatenation of the sequence of input arrays. - - - For each element of the array, applies the given function. Concatenates all the results and return the combined array. - The function to create sub-arrays from the input array elements. - The input array. - The concatenation of the sub-arrays. - - - Reads a range of elements from the first array and write them into the second. - The source array. - The starting index of the source array. - The target array. - The starting index of the target array. - The number of elements to copy. - - - Returns the average of the elements generated by applying the function to each element of the array. - The function to transform the array elements before averaging. - The input array. - Thrown when array is empty. - The computed average. - - - Returns the average of the elements in the array. - The input array. - Thrown when array is empty. - The average of the elements in the array. - - - Builds a new array that contains the elements of the first array followed by the elements of the second array. - The first input array. - The second input array. - The resulting array. - - - Basic operations on arrays. - - - Compare using the given comparer function. - A function to compare two values. - An object implementing IComparer using the supplied comparer. - - - Structural comparison. Compare using Operators.compare. - - - Common notions of comparison identity used with sorted data structures. - - - Hash using the given hashing and equality functions. - A function to generate a hash code from a value. - A function to test equality of two values. - An object implementing IEqualityComparer using the supplied functions. - - - Physical hashing (hash on reference identity of objects, and the contents of value types). - Hash using LanguagePrimitives.PhysicalEquality and LanguagePrimitives.PhysicalHash, - That is, for value types use GetHashCode and Object.Equals (if no other optimization available), - and for reference types use System.Runtime.CompilerServices.RuntimeHelpers.GetHashCode and - reference equality. - - - - - - Structural hashing. Hash using Operators.(=) and Operators.hash. - - - Common notions of value identity used with hash tables. - - - Combines the three lists into a list of triples. The lists must have equal lengths. - The first input list. - The second input list. - The third input list. - A single list containing triples of matching elements from the input lists. - - - Combines the two lists into a list of pairs. The two lists must have equal lengths. - The first input list. - The second input list. - A single list containing pairs of matching elements from the input lists. - - - Splits a list of triples into three lists. - The input list. - Three lists of split elements. - - - Splits a list of pairs into two lists. - The input list. - Two lists of split elements. - - - Returns the index of the first element in the list - that satisfies the given predicate. - Return None if no such element exists. - The function to test the input elements. - The input list. - The index of the first element for which the predicate returns true, or None if - every element evaluates to false. - - - Returns the first element for which the given function returns true.. - Return None if no such element exists. - The function to test the input elements. - The input list. - The first element for which the predicate returns true, or None if - every element evaluates to false. - - - Applies the given function to successive elements, returning Some(x) the first - result where function returns Some(x) for some x. If no such element - exists then return None. - The function to generate options from the elements. - The input list. - The first resulting value or None. - - - Views the given list as a sequence. - The input list. - The sequence of elements in the list. - - - Builds an array from the given list. - The input list. - The array containing the elements of the list. - - - Returns the list after removing the first element. - - The input list. - Thrown when the list is empty. - The list after removing the first element. - - - Returns the sum of the results generated by applying the function to each element of the list. - The function to transform the list elements into the type to be summed. - The input list. - The resulting sum. - - - Returns the sum of the elements in the list. - The input list. - The resulting sum. - - - Sorts the given list using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The input list. - The sorted list. - - - Sorts the given list using keys given by the given projection. Keys are compared using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The function to transform the list elements into the type to be compared. - The input list. - The sorted list. - - - Sorts the given list using the given comparison function. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The function to compare the list elements. - The input list. - The sorted list. - - - Like foldBack, but returns both the intermediary and final results - The function to update the state given the input elements. - The input list. - The initial state. - The list of states. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. Take the second argument, and apply the function to it - and the first element of the list. Then feed this result into the function along - with the second element and so on. Returns the list of intermediate results and the final result. - The function to update the state given the input elements. - The initial state. - The input list. - The list of states. - - - Returns a new list with the elements in reverse order. - The input list. - The reversed list. - - - Creates a list by calling the given generator on each index. - The number of elements to replicate. - The value to replicate - The generated list. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then computes - f i0 (...(f iN-1 iN)). - - Raises System.ArgumentException if list is empty - The function to reduce two list elements to a single element. - The input list. - Thrown when the list is empty. - The final reduced value. - - - Apply a function to each element of the collection, threading an accumulator argument - through the computation. Apply the function to the first two elements of the list. - Then feed this result into the function along with the third element and so on. - Return the final result. If the input function is f and the elements are i0...iN then computes - f (... (f i0 i1) i2 ...) iN. - - Raises System.ArgumentException if list is empty - The function to reduce two list elements to a single element. - The input list. - Thrown when the list is empty. - The final reduced value. - - - Returns a list with all elements permuted according to the - specified permutation. - The function to map input indices to output indices. - The input list. - The permutated list. - - - Applies the given function to successive elements, returning the first - result where function returns Some(x) for some x. If no such - element exists then raise System.Collections.Generic.KeyNotFoundException - The function to generate options from the elements. - The input list. - Thrown when the list is empty. - The first resulting value. - - - Splits the collection into two collections, containing the - elements for which the given predicate returns true and false - respectively. Element order is preserved in both of the created lists. - The function to test the input elements. - The input list. - A list containing the elements for which the predicate evaluated to false and a list - containing the elements for which the predicate evaluated to true. - - - Builds a new list from the given enumerable object. - The input sequence. - The list of elements from the sequence. - - - Builds a list from the given array. - The input array. - The list of elements from the array. - - - Indexes into the list. The first element has index 0. - The input list. - The index to retrieve. - The value at the given index. - - - Returns the lowest of all elements of the list, compared via Operators.min on the function result - - Raises System.ArgumentException if list is empty. - The function to transform list elements into the type to be compared. - The input list. - Thrown when the list is empty. - The minimum value. - - - Returns the lowest of all elements of the list, compared via Operators.min. - - Raises System.ArgumentException if list is empty - The input list. - Thrown when the list is empty. - The minimum value. - - - Returns the greatest of all elements of the list, compared via Operators.max on the function result. - - Raises System.ArgumentException if list is empty. - The function to transform the list elements into the type to be compared. - The input list. - Thrown when the list is empty. - The maximum element. - - - Return the greatest of all elements of the list, compared via Operators.max. - - Raises System.ArgumentException if list is empty - The input list. - Thrown when the list is empty. - The maximum element. - - - Like mapi, but mapping corresponding elements from two lists of equal length. - The function to transform pairs of elements from the two lists and their index. - The first input list. - The second input list. - The list of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The integer index passed to the - function indicates the index (from 0) of element being transformed. - The function to transform elements and their indices. - The input list. - The list of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the three collections simultaneously. - The function to transform triples of elements from the input lists. - The first input list. - The second input list. - The third input list. - The list of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the two collections pairwise. - The function to transform pairs of elements from the input lists. - The first input list. - The second input list. - The list of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. - The function to transform elements from the input list. - The input list. - The list of transformed elements. - - - Returns the length of the list. - The input list. - The length of the list. - - - Applies the given function to two collections simultaneously. The - collections must have identical size. The integer passed to the - function indicates the index of element. - The function to apply to a pair of elements from the input lists along with their index. - The first input list. - The second input list. - - - Applies the given function to each element of the collection. The integer passed to the - function indicates the index of element. - The function to apply to the elements of the list along with their index. - The input list. - - - Applies the given function to two collections simultaneously. The - collections must have identical size. - The function to apply to pairs of elements from the input lists. - The first input list. - The second input list. - - - Applies the given function to each element of the collection. - The function to apply to elements from the input list. - The input list. - - - Returns true if the list contains no elements, false otherwise. - The input list. - True if the list is empty. - - - Creates a list by calling the given generator on each index. - The length of the list to generate. - The function to generate an element from an index. - The list of generated elements. - - - Returns the first element of the list. - - The input list. - Thrown when the list is empty. - The first element of the list. - - - Tests if all corresponding elements of the collection satisfy the given predicate pairwise. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns false then the overall result is - false and no further elements are tested. Otherwise, if one collection is longer - than the other then the System.ArgumentException exception is raised. - Otherwise, true is returned. - The function to test the input elements. - The first input list. - The second input list. - Thrown when the input lists differ in length. - True if all of the pairs of elements satisfy the predicate. - - - Tests if all elements of the collection satisfy the given predicate. - - The predicate is applied to the elements of the input list. If any application - returns false then the overall result is false and no further elements are tested. - Otherwise, true is returned. - The function to test the input elements. - The input list. - True if all of the elements satisfy the predicate. - - - Applies a function to corresponding elements of two collections, threading an accumulator argument - through the computation. The collections must have identical sizes. - If the input function is f and the elements are i0...iN and j0...jN - then computes f i0 j0 (...(f iN jN s)). - The function to update the state given the input elements. - The first input list. - The second input list. - The initial state. - The final state value. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then - computes f i0 (...(f iN s)). - The function to update the state given the input elements. - The input list. - The initial state. - The final state value. - - - Applies a function to corresponding elements of two collections, threading an accumulator argument - through the computation. The collections must have identical sizes. - If the input function is f and the elements are i0...iN and j0...jN - then computes f (... (f s i0 j0)...) iN jN. - The function to update the state given the input elements. - The initial state. - The first input list. - The second input list. - The final state value. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. Take the second argument, and apply the function to it - and the first element of the list. Then feed this result into the function along - with the second element and so on. Return the final result. - If the input function is f and the elements are i0...iN then - computes f (... (f s i0) i1 ...) iN. - The function to update the state given the input elements. - The initial state. - The input list. - The final state value. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true" - The function to test the input elements. - The input list. - A list containing only the elements that satisfy the predicate. - - - Returns the index of the first element in the list - that satisfies the given predicate. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for all the - elements of the list. - The index of the first element that satisfies the predicate. - - - Returns the first element for which the given function returns true. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for - all the elements of the list. - The first element that satisfies the predicate. - - - Tests if any pair of corresponding elements of the lists satisfies the given predicate. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns true then the overall result is - true and no further elements are tested. Otherwise, if one collections is longer - than the other then the System.ArgumentException exception is raised. - Otherwise, false is returned. - The function to test the input elements. - The first input list. - The second input list. - Thrown when the input lists differ in length. - True if any pair of elements satisfy the predicate. - - - Tests if any element of the list satisfies the given predicate. - - The predicate is applied to the elements of the input list. If any application - returns true then the overall result is true and no further elements are tested. - Otherwise, false is returned. - The function to test the input elements. - The input list. - True if any element satisfies the predicate. - - - Returns an empty list of the given type. - - - Returns a new list that contains the elements of each the lists in order. - The input sequence of lists. - The resulting concatenated list. - - - For each element of the list, applies the given function. Concatenates all the results and return the combined list. - The function to transform each input element into a sublist to be concatenated. - The input list. - The concatenation of the transformed sublists. - - - Applies the given function to each element of the list. Returns - the list comprised of the results x for each element where - the function returns Some(x) - The function to generate options from the elements. - The input list. - The list comprising the values selected from the chooser function. - - - Returns the average of the elements generated by applying the function to each element of the list. - - Raises System.ArgumentException if list is empty. - The function to transform the list elements into the type to be averaged. - The input list. - Thrown when the list is empty. - The resulting average. - - - Returns the average of the elements in the list. - - Raises System.ArgumentException if list is empty. - The input list. - Thrown when the list is empty. - The resulting average. - - - Returns a new list that contains the elements of the first list - followed by elements of the second. - The first input list. - The second input list. - The resulting list. - - - Basic operations on lists. - - - Returns the key of the first mapping in the collection that satisfies the given predicate. - Returns 'None' if no such element exists. - The function to test the input elements. - The input map. - The first key for which the predicate returns true or None if the predicate evaluates to false for each key/value pair. - - - Evaluates the function on each mapping in the collection. Returns the key for the first mapping - where the function returns 'true'. Raise KeyNotFoundException if no such element exists. - The function to test the input elements. - The input map. - Thrown if the key does not exist in the map. - The first key for which the predicate evaluates true. - - - Lookup an element in the map, returning a Some value if the element is in the domain - of the map and None if not. - The input key. - The input map. - The found Some value or None. - - - Removes an element from the domain of the map. No exception is raised if the element is not present. - The input key. - The input map. - The resulting map. - - - Builds two new maps, one containing the bindings for which the given predicate returns 'true', - and the other the remaining bindings. - The function to test the input elements. - The input map. - A pair of maps in which the first contains the elements for which the predicate returned true - and the second containing the elements for which the predicated returned false. - - - Tests if an element is in the domain of the map. - The input key. - The input map. - True if the map contains the key. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The key passed to the - function indicates the key of element being transformed. - The function to transform the key/value pairs. - The input map. - The resulting map of keys and transformed values. - - - Returns true if the given predicate returns true for all of the - bindings in the map. - The function to test the input elements. - The input map. - True if the predicate evaluates to true for all of the bindings in the map. - - - Builds a new map containing only the bindings for which the given predicate returns 'true'. - The function to test the key/value pairs. - The input map. - The filtered map. - - - Returns true if the given predicate returns true for one of the - bindings in the map. - The function to test the input elements. - The input map. - True if the predicate returns true for one of the key/value pairs. - - - Applies the given function to each binding in the dictionary - The function to apply to each key/value pair. - The input map. - - - Folds over the bindings in the map - The function to update the state given the input key/value pairs. - The initial state. - The input map. - The final state value. - - - Folds over the bindings in the map. - The function to update the state given the input key/value pairs. - The input map. - The initial state. - The final state value. - - - Searches the map looking for the first element where the given function returns a Some value - The function to generate options from the key/value pairs. - The input map. - The first result. - - - Searches the map looking for the first element where the given function returns a Some value. - The function to generate options from the key/value pairs. - The input map. - The first result. - - - Lookup an element in the map, raising KeyNotFoundException if no binding - exists in the map. - The input key. - The input map. - Thrown when the key does not exist in the map. - The value mapped to the given key. - - - The empty map. - - - Is the map empty? - The input map. - True if the map is empty. - - - Returns an array of all key-value pairs in the mapping. - The array will be ordered by the keys of the map. - The input map. - The array of key/value pairs. - - - Returns a list of all key-value pairs in the mapping. - The list will be ordered by the keys of the map. - The input map. - The list of key/value pairs. - - - Views the collection as an enumerable sequence of pairs. - The sequence will be ordered by the keys of the map. - The input map. - The sequence of key/value pairs. - - - Returns a new map made from the given bindings. - The input sequence of key/value pairs. - The resulting map. - - - Returns a new map made from the given bindings. - The input array of key/value pairs. - The resulting map. - - - Returns a new map made from the given bindings. - The input list of key/value pairs. - The resulting map. - - - Returns a new map with the binding added to the given map. - The input key. - The input value. - The input map. - The resulting map. - - - Functional programming operators related to the Map<_,_> type. - - - Combines the three sequences into a list of triples. The sequences need not have equal lengths: - when one sequence is exhausted any remaining elements in the other - sequences are ignored. - - The first input sequence. - The second input sequence. - The third input sequence. - - The result sequence. - - Thrown when any of the input sequences is null. - - - Combines the two sequences into a list of pairs. The two sequences need not have equal lengths: - when one sequence is exhausted any remaining elements in the other - sequence are ignored. - - The first input sequence. - The second input sequence. - - The result sequence. - - Thrown when either of the input sequences is null. - - - Returns a sequence that yields sliding windows of containing elements drawn from the input - sequence. Each window is returned as a fresh array. - - The number of elements in each window. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns a sequence that contains the elements generated by the given computation. - The given initial state argument is passed to the element generator. - For each IEnumerator elements in the stream are generated on-demand by applying the element - generator, until a None value is returned by the element generator. Each call to the element - generator returns a new residual state. - - The stream will be recomputed each time an IEnumerator is requested and iterated for the Seq. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - A function that takes in the current state and returns an option tuple of the next - element of the sequence and the next state value. - The initial state value. - - The result sequence. - - - Returns a sequence that when enumerated returns at most N elements. - - The maximum number of items to enumerate. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Applies the given function to successive elements, returning the first - result where the function returns "Some(x)". - - A function that transforms items from the input sequence into options. - The input sequence. - - The chosen element or None. - - Thrown when the input sequence is null. - - - Returns the index of the first element in the sequence - that satisfies the given predicate. Return None if no such element exists. - - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - - The found index or None. - - Thrown when the input sequence is null. - - - Returns the first element for which the given function returns true. - Return None if no such element exists. - - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - - The found element or None. - - Thrown when the input sequence is null. - - - Builds a list from the given collection. - - The input sequence. - - The result list. - - Thrown when the input sequence is null. - - - Builds an array from the given collection. - - The input sequence. - - The result array. - - Thrown when the input sequence is null. - - - Returns a sequence that, when iterated, yields elements of the underlying sequence while the - given predicate returns true, and then returns no further elements. - - A function that evaluates to false when no more items should be returned. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns the first N elements of the sequence. - Throws InvalidOperationException - if the count exceeds the number of elements in the sequence. Seq.truncate - returns as many items as the sequence contains instead of throwing an exception. - - The number of items to take. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - Thrown when count exceeds the number of elements - in the sequence. - - - Returns the sum of the results generated by applying the function to each element of the sequence. - The generated elements are summed using the + operator and Zero property associated with the generated type. - - A function to transform items from the input sequence into the type that will be summed. - The input sequence. - - The computed sum. - - - Returns the sum of the elements in the sequence. - - The elements are summed using the + operator and Zero property associated with the generated type. - - The input sequence. - - The computed sum. - - - Applies a key-generating function to each element of a sequence and yield a sequence ordered - by keys. The keys are compared using generic comparison as implemented by Operators.compare. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - A function to transform items of the input sequence into comparable keys. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Yields a sequence ordered by keys. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that, when iterated, skips elements of the underlying sequence while the - given predicate returns true, and then yields the remaining elements of the sequence. - - A function that evaluates an element of the sequence to a boolean value. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that skips N elements of the underlying sequence and then yields the - remaining elements of the sequence. - - The number of items to skip. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when count exceeds the number of elements - in the sequence. - - - Returns a sequence that yields one item only. - - The input item. - - The result sequence of one item. - - - Like fold, but computes on-demand and returns the sequence of intermediary and final results. - - A function that updates the state with each element from the sequence. - The initial state. - The input sequence. - - The resulting sequence of computed states. - - Thrown when the input sequence is null. - - - Applies a function to each element of the sequence, threading an accumulator argument - through the computation. Begin by applying the function to the first two elements. - Then feed this result into the function along with the third element and so on. - Return the final result. - - A function that takes in the current accumulated result and the next - element of the sequence to produce the next accumulated result. - The input sequence. - - The final result of the reduction function. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Builds a new sequence object that delegates to the given sequence object. This ensures - the original sequence cannot be rediscovered and mutated by a type cast. For example, - if given an array the returned sequence will return the elements of the array, but - you cannot cast the returned sequence object to an array. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Applies the given function to successive elements, returning the first - x where the function returns "Some(x)". - - A function to transform each item of the input sequence into an option of the output type. - The input sequence. - - The selected element. - - Thrown when the input sequence is null. - Thrown when every item of the sequence - evaluates to None when the given function is applied. - - - Returns a sequence of each element in the input sequence and its predecessor, with the - exception of the first element which is only returned as the predecessor of the second element. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Views the given list as a sequence. - - The input list. - - The result sequence. - - - Views the given array as a sequence. - - The input array. - - The result sequence. - - Thrown when the input sequence is null. - - - Computes the nth element in the collection. - - The index of element to retrieve. - The input sequence. - - The nth element of the sequence. - - Thrown when the input sequence is null. - - - Returns the lowest of all elements of the sequence, compared via Operators.min on the function result. - - A function to transform items from the input sequence into comparable keys. - The input sequence. - - The smallest element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the lowest of all elements of the sequence, compared via Operators.min. - - The input sequence. - - The smallest element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the greatest of all elements of the sequence, compared via Operators.max on the function result. - - A function to transform items from the input sequence into comparable keys. - The input sequence. - - The largest element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the greatest of all elements of the sequence, compared via Operators.max - - The input sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - The largest element of the sequence. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The integer index passed to the - function indicates the index (from 0) of element being transformed. - - A function to transform items from the input sequence that also supplies the current index. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding pairs of elements from the two sequences. If one input sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to transform pairs of items from the input sequences. - The first input sequence. - The second input sequence. - - The result sequence. - - Thrown when either of the input sequences is null. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The given function will be applied - as elements are demanded using the MoveNext method on enumerators retrieved from the - object. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - A function to transform items from the input sequence. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns the length of the sequence - - The input sequence. - - The length of the sequence. - - Thrown when the input sequence is null. - - - Applies the given function to two collections simultaneously. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to apply to each pair of elements from the input sequences. - The first input sequence. - The second input sequence. - - Thrown when either of the input sequences is null. - - - Applies the given function to each element of the collection. The integer passed to the - function indicates the index of element. - - A function to apply to each element of the sequence that can also access the current index. - The input sequence. - - Thrown when the input sequence is null. - - - Applies the given function to each element of the collection. - - A function to apply to each element of the sequence. - The input sequence. - - Thrown when the input sequence is null. - - - Generates a new sequence which, when iterated, will return successive - elements by calling the given function. The results of calling the function - will not be saved, that is the function will be reapplied as necessary to - regenerate the elements. The function is passed the index of the item being - generated. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - Iteration can continue up to Int32.MaxValue. - - A function that generates an item in the sequence from a given index. - - The result sequence. - - - Generates a new sequence which, when iterated, will return successive - elements by calling the given function, up to the given count. Each element is saved after its - initialization. The function is passed the index of the item being - generated. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - The maximum number of items to generate for the sequence. - A function that generates an item in the sequence from a given index. - - The result sequence. - - Thrown when count is negative. - - - Returns true if the sequence contains no elements, false otherwise. - - The input sequence. - - True if the sequence is empty; false otherwise. - - Thrown when the input sequence is null. - - - Returns the only element of the sequence. - - The input sequence. - - The last element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input does not have precisely one element. - - - Returns the last element of the sequence. - - The input sequence. - - The last element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input does not have any elements. - - - Returns the first element of the sequence. - - The input sequence. - - The first element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input does not have any elements. - - - Applies a key-generating function to each element of a sequence and yields a sequence of - unique keys. Each unique key contains a sequence of all elements that match - to this key. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - A function that transforms an element of the sequence into a comparable key. - The input sequence. - - The result sequence. - - - Tests the all pairs of elements drawn from the two sequences satisfy the - given predicate. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to test pairs of elements from the input sequences. - The first input sequence. - The second input sequence. - - True if all pairs satisfy the predicate; false otherwise. - - Thrown when either of the input sequences is null. - - - Tests if all elements of the sequence satisfy the given predicate. - - The predicate is applied to the elements of the input sequence. If any application - returns false then the overall result is false and no further elements are tested. - Otherwise, true is returned. - - A function to test an element of the input sequence. - The input sequence. - - True if every element of the sequence satisfies the predicate; false otherwise. - - Thrown when the input sequence is null. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f (... (f s i0)...) iN - - A function that updates the state with each element from the sequence. - The initial state. - The input sequence. - - The state object after the folding function is applied to each element of the sequence. - - Thrown when the input sequence is null. - - - Returns the index of the first element for which the given function returns true. - - A function to test whether the index of a particular element should be returned. - The input sequence. - - The index of the first element for which the predicate returns true. - - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns the first element for which the given function returns true. - - A function to test whether an item in the sequence should be returned. - The input sequence. - - The first element for which the predicate returns true. - - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true". - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - Remember sequence is lazy, effects are delayed until it is enumerated. - - A synonym for Seq.filter. - - A function to test whether each item in the input sequence should be included in the output. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true". This is a synonym for Seq.where. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - Remember sequence is lazy, effects are delayed until it is enumerated. - - A function to test whether each item in the input sequence should be included in the output. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Tests if any pair of corresponding elements of the input sequences satisfies the given predicate. - - The predicate is applied to matching elements in the two sequences up to the lesser of the - two lengths of the collections. If any application returns true then the overall result is - true and no further elements are tested. Otherwise, false is returned. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to test each pair of items from the input sequences. - The first input sequence. - The second input sequence. - - True if any result from the predicate is true; false otherwise. - - Thrown when either of the two input sequences is null. - - - Tests if any element of the sequence satisfies the given predicate. - - The predicate is applied to the elements of the input sequence. If any application - returns true then the overall result is true and no further elements are tested. - Otherwise, false is returned. - - A function to test each item of the input sequence. - The input sequence. - - True if any result from the predicate is true; false otherwise. - - Thrown when the input sequence is null. - - - Creates an empty sequence. - - An empty sequence. - - - Returns a sequence that contains no duplicate entries according to the - generic hash and equality comparisons on the keys returned by the given key-generating function. - If an element occurs multiple times in the sequence then the later occurrences are discarded. - - A function transforming the sequence items into comparable keys. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that contains no duplicate entries according to generic hash and - equality comparisons on the entries. - If an element occurs multiple times in the sequence then the later occurrences are discarded. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that is built from the given delayed specification of a - sequence. - - The input function is evaluated each time an IEnumerator for the sequence - is requested. - - The generating function for the sequence. - - - Applies a key-generating function to each element of a sequence and return a sequence yielding unique - keys and their number of occurrences in the original sequence. - - Note that this function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - A function transforming each item of input sequence into a key to be - compared against the others. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Combines the given enumeration-of-enumerations as a single concatenated - enumeration. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - The input enumeration-of-enumerations. - - The result sequence. - - Thrown when the input sequence is null. - - - Compares two sequences using the given comparison function, element by element. - Returns the first non-zero result from the comparison function. If the end of a sequence - is reached it returns a -1 if the first sequence is shorter and a 1 if the second sequence - is shorter. - - A function that takes an element from each sequence and returns an int. - If it evaluates to a non-zero value iteration is stopped and that value is returned. - The first input sequence. - The second input sequence. - - The first non-zero value from the comparison function. - - Thrown when either of the input sequences - is null. - - - Applies the given function to each element of the sequence and concatenates all the - results. - - Remember sequence is lazy, effects are delayed until it is enumerated. - - A function to transform elements of the input sequence into the sequences - that will then be concatenated. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Applies the given function to each element of the list. Return - the list comprised of the results "x" for each element where - the function returns Some(x). - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not - be accessed concurrently. - - A function to transform items of type T into options of type U. - The input sequence of type T. - - The result sequence. - - Thrown when the input sequence is null. - - - Wraps a loosely-typed System.Collections sequence as a typed sequence. - - The use of this function usually requires a type annotation. - An incorrect type annotation may result in runtime type - errors. - Individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that corresponds to a cached version of the input sequence. - This result sequence will have the same elements as the input sequence. The result - can be enumerated multiple times. The input sequence will be enumerated at most - once and only as far as is necessary. Caching a sequence is typically useful when repeatedly - evaluating items in the original sequence is computationally expensive or if - iterating the sequence causes side-effects that the user does not want to be - repeated multiple times. - - Enumeration of the result sequence is thread safe in the sense that multiple independent IEnumerator - values may be used simultaneously from different threads (accesses to - the internal lookaside table are thread safe). Each individual IEnumerator - is not typically thread safe and should not be accessed concurrently. - - Once enumeration of the input sequence has started, - it's enumerator will be kept live by this object until the enumeration has completed. - At that point, the enumerator will be disposed. - - The enumerator may be disposed and underlying cache storage released by - converting the returned sequence object to type IDisposable, and calling the Dispose method - on this object. The sequence object may then be re-enumerated and a fresh enumerator will - be used. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns the average of the results generated by applying the function to each element - of the sequence. - - The elements are averaged using the + operator, DivideByInt method and Zero property - associated with the generated type. - - A function applied to transform each element of the sequence. - The input sequence. - - The average. - - Thrown when the input sequence is null. - Thrown when the input sequence has zero elements. - - - Returns the average of the elements in the sequence. - - The elements are averaged using the + operator, DivideByInt method and Zero property - associated with the element type. - - The input sequence. - - The average. - - Thrown when the input sequence is null. - Thrown when the input sequence has zero elements. - - - Wraps the two given enumerations as a single concatenated - enumeration. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed - concurrently. - - The first sequence. - The second sequence. - - The result sequence. - - Thrown when either of the two provided sequences is - null. - - - Basic operations on IEnumerables. - - - Returns a new set with the elements of the second set removed from the first. - The first input set. - The set whose elements will be removed from set1. - The set with the elements of set2 removed from set1. - - - Builds a new collection from the given enumerable object. - The input sequence. - The set containing elements. - - - Returns an ordered view of the collection as an enumerable object. - The input set. - An ordered sequence of the elements of set. - - - Builds an array that contains the elements of the set in order. - The input set. - An ordered array of the elements of set. - - - Builds a set that contains the same elements as the given array. - The input array. - A set containing the elements of array. - - - Builds a list that contains the elements of the set in order. - The input set. - An ordered list of the elements of set. - - - Builds a set that contains the same elements as the given list. - The input list. - A set containing the elements form the input list. - - - Returns the highest element in the set according to the ordering being used for the set. - The input set. - The max value from the set. - - - Returns the lowest element in the set according to the ordering being used for the set. - The input set. - The min value from the set. - - - Returns a new set with the given element removed. No exception is raised if - the set doesn't contain the given element. - The element to remove. - The input set. - The input set with value removed. - - - Splits the set into two sets containing the elements for which the given predicate - returns true and false respectively. - The function to test set elements. - The input set. - A pair of sets with the first containing the elements for which predicate returns - true and the second containing the elements for which predicate returns false. - - - Applies the given function to each element of the set, in order according - to the comparison function. - The function to apply to each element. - The input set. - - - Returns "true" if the set is empty. - The input set. - True if set is empty. - - - Computes the union of a sequence of sets. - The sequence of sets to untion. - The union of the input sets. - - - Computes the union of the two sets. - The first input set. - The second input set. - The union of set1 and set2. - - - Computes the intersection of a sequence of sets. The sequence must be non-empty. - The sequence of sets to intersect. - The intersection of the input sets. - - - Computes the intersection of the two sets. - The first input set. - The second input set. - The intersection of set1 and set2. - - - Tests if all elements of the collection satisfy the given predicate. - If the input function is f and the elements are i0...iN and "j0...jN" - then computes p i0 && ... && p iN. - The function to test set elements. - The input set. - True if all elements of set satisfy predicate. - - - Applies the given accumulating function to all the elements of the set. - The accumulating function. - The input set. - The initial state. - The final state. - - - Applies the given accumulating function to all the elements of the set - The accumulating function. - The initial state. - The input set. - The final state. - - - Returns a new collection containing the results of applying the - given function to each element of the input set. - The function to transform elements of the input set. - The input set. - A set containing the transformed elements. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns true. - The function to test set elements. - The input set. - The set containing only the elements for which predicate returns true. - - - Tests if any element of the collection satisfies the given predicate. - If the input function is predicate and the elements are i0...iN - then computes p i0 or ... or p iN. - The function to test set elements. - The input set. - True if any element of set satisfies predicate. - - - Returns the number of elements in the set. Same as size. - The input set. - The number of elements in the set. - - - Evaluates to "true" if all elements of the second set are in the first, and at least - one element of the first is not in the second. - The potential superset. - The set to test against. - True if set1 is a proper superset of set2. - - - Evaluates to "true" if all elements of the second set are in the first. - The potential superset. - The set to test against. - True if set1 is a superset of set2. - - - Evaluates to "true" if all elements of the first set are in the second, and at least - one element of the second is not in the first. - The potential subset. - The set to test against. - True if set1 is a proper subset of set2. - - - Evaluates to "true" if all elements of the first set are in the second - The potential subset. - The set to test against. - True if set1 is a subset of set2. - - - Evaluates to "true" if the given element is in the given set. - The element to test. - The input set. - True if element is in set. - - - Returns a new set with an element added to the set. No exception is raised if - the set already contains the given element. - The value to add. - The input set. - A new set containing value. - - - The set containing the given element. - The value for the set to contain. - The set containing value. - - - The empty set for the type 'T. - - - Functional programming operators related to the Set<_> type. - - - Gets the default cancellation token for executing asynchronous computations. - The default CancellationToken. - - - Creates an asynchronous computation that returns the CancellationToken governing the execution - of the computation. - In async { let! token = Async.CancellationToken ...} token can be used to initiate other - asynchronous operations that will cancel cooperatively with this workflow. - An asynchronous computation capable of retrieving the CancellationToken from a computation - expression. - - - Creates an asynchronous computation that executes computation. - If this computation is cancelled before it completes then the computation generated by - running compensation is executed. - The input asynchronous computation. - The function to be run if the computation is cancelled. - An asynchronous computation that runs the compensation if the input computation - is cancelled. - - - Creates an asynchronous computation that queues a work item that runs - its continuation. - A computation that generates a new work item in the thread pool. - - - Creates an asynchronous computation that creates a new thread and runs - its continuation in that thread. - A computation that will execute on a new thread. - - - Creates an asynchronous computation that runs - its continuation using syncContext.Post. If syncContext is null - then the asynchronous computation is equivalent to SwitchToThreadPool(). - The synchronization context to accept the posted computation. - An asynchronous computation that uses the syncContext context to execute. - - - Runs an asynchronous computation, starting immediately on the current operating system - thread. Call one of the three continuations when the operation completes. - If no cancellation token is provided then the default cancellation token - is used. - The asynchronous computation to execute. - The function called on success. - The function called on exception. - The function called on cancellation. - The CancellationToken to associate with the computation. - The default is used if this parameter is not provided. - - - Runs an asynchronous computation, starting immediately on the current operating system - thread. - If no cancellation token is provided then the default cancellation token is used. - The asynchronous computation to execute. - The CancellationToken to associate with the computation. - The default is used if this parameter is not provided. - - - Starts a child computation within an asynchronous workflow. - This allows multiple asynchronous computations to be executed simultaneously. - - This method should normally be used as the immediate - right-hand-side of a let! binding in an F# asynchronous workflow, that is, - - async { ... - let! completor1 = childComputation1 |> Async.StartChild - let! completor2 = childComputation2 |> Async.StartChild - ... - let! result1 = completor1 - let! result2 = completor2 - ... } - - When used in this way, each use of StartChild starts an instance of childComputation - and returns a completor object representing a computation to wait for the completion of the operation. - When executed, the completor awaits the completion of childComputation. - The child computation. - The timeout value in milliseconds. If one is not provided - then the default value of -1 corresponding to System.Threading.Timeout.Infinite. - A new computation that waits for the input computation to finish. - - - Starts the asynchronous computation in the thread pool. Do not await its result. - - If no cancellation token is provided then the default cancellation token is used. - The computation to run asynchronously. - The cancellation token to be associated with the computation. - If one is not supplied, the default cancellation token is used. - - - Creates an asynchronous computation that will sleep for the given time. This is scheduled - using a System.Threading.Timer object. The operation will not block operating system threads - for the duration of the wait. - The number of milliseconds to sleep. - An asynchronous computation that will sleep for the given time. - Thrown when the due time is negative - and not infinite. - - - Runs the asynchronous computation and await its result. - - If an exception occurs in the asynchronous computation then an exception is re-raised by this - function. - - If no cancellation token is provided then the default cancellation token is used. - - The timeout parameter is given in milliseconds. A value of -1 is equivalent to - System.Threading.Timeout.Infinite. - The computation to run. - The amount of time in milliseconds to wait for the result of the - computation before raising a System.TimeoutException. If no value is provided - for timeout then a default of -1 is used to correspond to System.Threading.Timeout.Infinite. - The cancellation token to be associated with the computation. - If one is not supplied, the default cancellation token is used. - The result of the computation. - - - Creates an asynchronous computation that executes all the given asynchronous computations, - initially queueing each as work items and using a fork/join pattern. - - If all child computations succeed, an array of results is passed to the success continuation. - - If any child computation raises an exception, then the overall computation will trigger an - exception, and cancel the others. - - The overall computation will respond to cancellation while executing the child computations. - If cancelled, the computation will cancel any remaining child computations but will still wait - for the other child computations to complete. - A sequence of distinct computations to be parallelized. - A computation that returns an array of values from the sequence of input computations. - - - Generates a scoped, cooperative cancellation handler for use within an asynchronous workflow. - - For example, - async { use! holder = Async.OnCancel interruption ... } - generates an asynchronous computation where, if a cancellation happens any time during - the execution of the asynchronous computation in the scope of holder, then action - interruption is executed on the thread that is performing the cancellation. This can - be used to arrange for a computation to be asynchronously notified that a cancellation - has occurred, e.g. by setting a flag, or deregistering a pending I/O action. - The function that is executed on the thread performing the - cancellation. - An asynchronous computation that triggers the interruption if it is cancelled - before being disposed. - - - Creates an asynchronous computation that runs the given computation and ignores - its result. - The input computation. - A computation that is equivalent to the input computation, but disregards the result. - - - Creates an asynchronous computation that captures the current - success, exception and cancellation continuations. The callback must - eventually call exactly one of the given continuations. - The function that accepts the current success, exception, and cancellation - continuations. - An asynchronous computation that provides the callback with the current continuations. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. This overlaod should be used if the operation is - qualified by three arguments. For example, - Async.FromBeginEnd(arg1,arg2,arg3,ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The first argument for the operation. - The second argument for the operation. - The third argument for the operation. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. This overlaod should be used if the operation is - qualified by two arguments. For example, - Async.FromBeginEnd(arg1,arg2,ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The first argument for the operation. - The second argument for the operation. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. This overlaod should be used if the operation is - qualified by one argument. For example, - Async.FromBeginEnd(place,ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The argument for the operation. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. For example, - Async.FromBeginEnd(ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation that executes computation. - If this computation completes successfully then return Choice1Of2 with the returned - value. If this computation raises an exception before it completes then return Choice2Of2 - with the raised exception. - The input computation that returns the type T. - A computation that returns a choice of type T or exception. - - - Raises the cancellation condition for the most recent set of asynchronous computations started - without any specific CancellationToken. Replaces the global CancellationTokenSource with a new - global token source for any asynchronous computations created after this point without any - specific CancellationToken. - - - Creates an asynchronous computation that will wait on the given WaitHandle. - - The computation returns true if the handle indicated a result within the given timeout. - The WaitHandle that can be signalled. - The timeout value in milliseconds. If one is not provided - then the default value of -1 corresponding to System.Threading.Timeout.Infinite. - An asynchronous computation that waits on the given WaitHandle. - - - Creates an asynchronous computation that will wait on the IAsyncResult. - - The computation returns true if the handle indicated a result within the given timeout. - The IAsyncResult to wait on. - The timeout value in milliseconds. If one is not provided - then the default value of -1 corresponding to System.Threading.Timeout.Infinite. - An asynchronous computation that waits on the given IAsyncResult. - - - Creates an asynchronous computation that waits for a single invocation of a CLI - event by adding a handler to the event. Once the computation completes or is - cancelled, the handler is removed from the event. - - The computation will respond to cancellation while waiting for the event. If a - cancellation occurs, and cancelAction is specified, then it is executed, and - the computation continues to wait for the event. - - If cancelAction is not specified, then cancellation causes the computation - to cancel immediately. - The event to handle once. - An optional function to execute instead of cancelling when a - cancellation is issued. - An asynchronous computation that waits for the event to be invoked. - - - Creates three functions that can be used to implement the .NET Asynchronous - Programming Model (APM) for a given asynchronous computation. - - The functions should normally be published as members with prefix Begin, - End and Cancel, and can be used within a type definition as follows: - - let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun arg -> computation) - member x.BeginSomeOperation(arg,callback,state:obj) = beginAction(arg,callback,state) - member x.EndSomeOperation(iar) = endAction(iar) - member x.CancelSomeOperation(iar) = cancelAction(iar) - - - If the asynchronous computation takes no arguments, then AsBeginEnd is used as follows: - - let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun () -> computation) - member x.BeginSomeOperation(callback,state:obj) = beginAction((),callback,state) - member x.EndSomeOperation(iar) = endAction(iar) - member x.CancelSomeOperation(iar) = cancelAction(iar) - - - - If the asynchronous computation takes two arguments, then AsBeginEnd is used as follows: - - let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun arg1 arg2 -> computation) - member x.BeginSomeOperation(arg1,arg2,callback,state:obj) = beginAction((),callback,state) - member x.EndSomeOperation(iar) = endAction(iar) - member x.CancelSomeOperation(iar) = cancelAction(iar) - - - In each case, the resulting API will be familiar to programmers in other CLI languages and - is a useful way to publish asynchronous computations in CLI components. - A function generating the asynchronous computation to split into the traditional - .NET Asynchronous Programming Model. - A tuple of the begin, end, and cancel members. - - - This static class holds members for creating and manipulating asynchronous computations. - - - Creates an asynchronous computation that just returns (). - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of empty else branches in the - async { ... } computation expression syntax. - An asynchronous computation that returns (). - - - Creates an asynchronous computation that runs computation repeatedly - until guard() becomes false. - - A cancellation check is performed whenever the computation is executed. - - The existence of this method permits the use of while in the - async { ... } computation expression syntax. - The function to determine when to stop executing computation. - The function to be executed. Equivalent to the body - of a while expression. - An asynchronous computation that behaves similarly to a while loop when run. - - - Creates an asynchronous computation that runs binder(resource). - The action resource.Dispose() is executed as this computation yields its result - or if the asynchronous computation exits by an exception or by cancellation. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of use and use! in the - async { ... } computation expression syntax. - The resource to be used and disposed. - The function that takes the resource and returns an asynchronous - computation. - An asynchronous computation that binds and eventually disposes resource. - - - Creates an asynchronous computation that runs computation and returns its result. - If an exception happens then catchHandler(exn) is called and the resulting computation executed instead. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of try/with in the - async { ... } computation expression syntax. - The input computation. - The function to run when computation throws an exception. - An asynchronous computation that executes computation and calls catchHandler if an - exception is thrown. - - - Creates an asynchronous computation that runs computation. The action compensation is executed - after computation completes, whether computation exits normally or by an exception. If compensation raises an exception itself - the original exception is discarded and the new exception becomes the overall result of the computation. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of try/finally in the - async { ... } computation expression syntax. - The input computation. - The action to be run after computation completes or raises an - exception (including cancellation). - An asynchronous computation that executes computation and compensation aftewards or - when an exception is raised. - - - Delegates to the input computation. - - The existence of this method permits the use of return! in the - async { ... } computation expression syntax. - The input computation. - The input computation. - - - Creates an asynchronous computation that returns the result v. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of return in the - async { ... } computation expression syntax. - The value to return from the computation. - An asynchronous computation that returns value when executed. - - - Creates an asynchronous computation that enumerates the sequence seq - on demand and runs body for each element. - - A cancellation check is performed on each iteration of the loop. - - The existence of this method permits the use of for in the - async { ... } computation expression syntax. - The sequence to enumerate. - A function to take an item from the sequence and create - an asynchronous computation. Can be seen as the body of the for expression. - An asynchronous computation that will enumerate the sequence and run body - for each element. - - - Creates an asynchronous computation that runs generator. - - A cancellation check is performed when the computation is executed. - The function to run. - An asynchronous computation that runs generator. - - - Creates an asynchronous computation that first runs computation1 - and then runs computation2, returning the result of computation2. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of expression sequencing in the - async { ... } computation expression syntax. - The first part of the sequenced computation. - The second part of the sequenced computation. - An asynchronous computation that runs both of the computations sequentially. - - - Creates an asynchronous computation that runs computation, and when - computation generates a result T, runs binder res. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of let! in the - async { ... } computation expression syntax. - The computation to provide an unbound result. - The function to bind the result of computation. - An asynchronous computation that performs a monadic bind on the result - of computation. - - - - Generate an object used to build asynchronous computations using F# computation expressions. The value - 'async' is a pre-defined instance of this type. - - A cancellation check is performed when the computation is executed. - - - - The type of the async operator, used to build workflows for asynchronous computations. - - - Sends a reply to a PostAndReply message. - The value to send. - - - A handle to a capability to reply to a PostAndReply message. - - - A compositional asynchronous computation, which, when run, will eventually produce a value - of type T, or else raises an exception. - - Asynchronous computations are normally specified using an F# computation expression. - - When run, asynchronous computations have two modes: as a work item (executing synchronous - code), or as a wait item (waiting for an event or I/O completion). - - When run, asynchronous computations can be governed by CancellationToken. This can usually - be specified when the async computation is started. The associated CancellationTokenSource - may be used to cancel the asynchronous computation. Asynchronous computations built using - computation expressions can check the cancellation condition regularly. Synchronous - computations within an asynchronous computation do not automatically check this condition. - - - Publishes the event as a first class event value. - - - Triggers the event using the given parameters. - The parameters for the event. - - - Creates an event object suitable for implementing an arbitrary type of delegate. - The event object. - - - Event implementations for an arbitrary type of delegate. - - - Publishes an observation as a first class value. - - - Triggers an observation using the given parameters. - The event parameters. - - - Creates an observable object. - The created event. - - - Event implementations for the IEvent<_> type. - - - Publishes the event as a first class event value. - - - Triggers the event using the given sender object and parameters. The sender object may be null. - The object triggering the event. - The parameters for the event. - - - Creates an event object suitable for delegate types following the standard .NET Framework convention of a first 'sender' argument. - The created event. - - - Event implementations for a delegate types following the standard .NET Framework convention of a first 'sender' argument. - - - - - - A delegate type associated with the F# event type IEvent<_> - The object that fired the event. - The event arguments. - - - Remove a listener delegate from an event listener store. - The delegate to be removed from the event listener store. - - - Connect a handler delegate object to the event. A handler can - be later removed using RemoveHandler. The listener will - be invoked when the event is fired. - A delegate to be invoked when the event is fired. - - - First class event values for arbitrary delegate types. - - F# gives special status to member properties compatible with type IDelegateEvent and - tagged with the CLIEventAttribute. In this case the F# compiler generates approriate - CLI metadata to make the member appear to other CLI languages as a CLI event. - - - First-class listening points (i.e. objects that permit you to register a callback - activated when the event is triggered). - - - First class event values for CLI events conforming to CLI Framework standards. - - - The type of delayed computations. - - Use the values in the Lazy module to manipulate - values of this type, and the notation lazy expr to create values - of type . - - - Raises a timeout exception if a message not received in this amount of time. By default - no timeout is used. - - - Occurs when the execution of the agent results in an exception. - - - Occurs when the execution of the agent results in an exception. - - - Raises a timeout exception if a message not received in this amount of time. By default - no timeout is used. - - - Returns the number of unprocessed messages in the message queue of the agent. - - - Occurs when the execution of the agent results in an exception. - - - Scans for a message by looking through messages in arrival order until scanner - returns a Some value. Other messages remain in the queue. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - The function to return None if the message is to be skipped - or Some if the message is to be processed and removed from the queue. - An optional timeout in milliseconds. Defaults to -1 which corresponds - to System.Threading.Timeout.Infinite. - An asynchronous computation that scanner built off the read message. - - - Waits for a message. This will consume the first message in arrival order. - - This method is for use within the body of the agent. - - Returns None if a timeout is given and the timeout is exceeded. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - An optional timeout in milliseconds. Defaults to -1 which - corresponds to System.Threading.Timeout.Infinite. - An asynchronous computation that returns the received message or - None if the timeout is exceeded. - - - Like PostAndReply, but returns None if no reply within the timeout period. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - The reply from the agent or None if the timeout expires. - - - Starts the agent. - - - Creates and starts an agent. The body function is used to generate the asynchronous - computation executed by the agent. - The function to produce an asynchronous computation that will be executed - as the read loop for the MailboxProcessor when Start is called. - An optional cancellation token for the body. - Defaults to Async.DefaultCancellationToken. - The created MailboxProcessor. - - - Scans for a message by looking through messages in arrival order until scanner - returns a Some value. Other messages remain in the queue. - - Returns None if a timeout is given and the timeout is exceeded. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - The function to return None if the message is to be skipped - or Some if the message is to be processed and removed from the queue. - An optional timeout in milliseconds. Defaults to -1 which corresponds - to System.Threading.Timeout.Infinite. - An asynchronous computation that scanner built off the read message. - Thrown when the timeout is exceeded. - - - Waits for a message. This will consume the first message in arrival order. - - This method is for use within the body of the agent. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - An optional timeout in milliseconds. Defaults to -1 which corresponds - to System.Threading.Timeout.Infinite. - An asynchronous computation that returns the received message. - Thrown when the timeout is exceeded. - - - Like AsyncPostAndReply, but returns None if no reply within the timeout period. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - An asynchronous computation that will return the reply or None if the timeout expires. - - - Posts a message to an agent and await a reply on the channel, synchronously. - - The message is generated by applying buildMessage to a new reply channel - to be incorporated into the message. The receiving agent must process this - message and invoke the Reply method on this reply channel precisely once. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - The reply from the agent. - - - Posts a message to an agent and await a reply on the channel, asynchronously. - - The message is generated by applying buildMessage to a new reply channel - to be incorporated into the message. The receiving agent must process this - message and invoke the Reply method on this reply channel precisely once. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - An asychronous computation that will wait for the reply from the agent. - - - Posts a message to the message queue of the MailboxProcessor, asynchronously. - The message to post. - - - Creates an agent. The body function is used to generate the asynchronous - computation executed by the agent. This function is not executed until - Start is called. - The function to produce an asynchronous computation that will be executed - as the read loop for the MailboxProcessor when Start is called. - An optional cancellation token for the body. - Defaults to Async.DefaultCancellationToken. - The created MailboxProcessor. - - - A message-processing agent which executes an asynchronous computation. - - The agent encapsulates a message queue that supports multiple-writers and - a single reader agent. Writers send messages to the agent by using the Post - method and its variations. - - The agent may wait for messages using the Receive or TryReceive methods or - scan through all available messages using the Scan or TryScan method. - - - - - - Connects a listener function to the observable. The listener will - be invoked for each observation. The listener can be removed by - calling Dispose on the returned IDisposable object. - The function to be called for each observation. - An object that will remove the listener if disposed. - - - Permanently connects a listener function to the observable. The listener will - be invoked for each observation. - The function to be called for each observation. - - - Returns an asynchronous computation that will write the given bytes to the stream. - The buffer to write from. - An optional offset as a number of bytes in the stream. - An optional number of bytes to write to the stream. - An asynchronous computation that will write the given bytes to the stream. - Thrown when the sum of offset and count is longer than - the buffer length. - Thrown when offset or count is negative. - - - Returns an asynchronous computation that will read the given number of bytes from the stream. - The number of bytes to read. - An asynchronous computation that returns the read byte[] when run. - - - Returns an asynchronous computation that will read from the stream into the given buffer. - The buffer to read into. - An optional offset as a number of bytes in the stream. - An optional number of bytes to read from the stream. - An asynchronous computation that will read from the stream into the given buffer. - Thrown when the sum of offset and count is longer than - the buffer length. - Thrown when offset or count is negative. - - - A module of extension members providing asynchronous operations for some basic CLI types related to concurrency and I/O. - - - Returns a new event that triggers on the second and subsequent triggerings of the input event. - The Nth triggering of the input event passes the arguments from the N-1th and Nth triggering as - a pair. The argument passed to the N-1th triggering is held in hidden internal state until the - Nth triggering occurs. - The input event. - An event that triggers on pairs of consecutive values passed from the source event. - - - Runs the given function each time the given event is triggered. - The function to call when the event is triggered. - The input event. - - - Returns a new event consisting of the results of applying the given accumulating function - to successive values triggered on the input event. An item of internal state - records the current value of the state parameter. The internal state is not locked during the - execution of the accumulation function, so care should be taken that the - input IEvent not triggered by multiple threads simultaneously. - The function to update the state with each event value. - The initial state. - The input event. - An event that fires on the updated state values. - - - Returns a new event which fires on a selection of messages from the original event. - The selection function takes an original message to an optional new message. - The function to select and transform event values to pass on. - The input event. - An event that fires only when the chooser returns Some. - - - Returns a new event that listens to the original event and triggers the - first resulting event if the application of the function to the event arguments - returned a Choice1Of2, and the second event if it returns a Choice2Of2. - The function to transform event values into one of two types. - The input event. - A tuple of events. The first fires whenever splitter evaluates to Choice1of1 and - the second fires whenever splitter evaluates to Choice2of2. - - - Returns a new event that listens to the original event and triggers the - first resulting event if the application of the predicate to the event arguments - returned true, and the second event if it returned false. - The function to determine which output event to trigger. - The input event. - A tuple of events. The first is triggered when the predicate evaluates to true - and the second when the predicate evaluates to false. - - - Returns a new event that listens to the original event and triggers the resulting - event only when the argument to the event passes the given function. - The function to determine which triggers from the event to propagate. - The input event. - An event that only passes values that pass the predicate. - - - Returns a new event that passes values transformed by the given function. - The function to transform event values. - The input event. - An event that passes the transformed values. - - - Fires the output event when either of the input events fire. - The first input event. - The second input event. - An event that fires when either of the input events fire. - - - - - - Forces the execution of this value and return its result. Same as Value. Mutual exclusion is used to - prevent other threads also computing the value. - The value of the Lazy object. - - - Creates a lazy computation that evaluates to the given value when forced. - The input value. - The created Lazy object. - - - Creates a lazy computation that evaluates to the result of the given function when forced. - The function to provide the value when needed. - The created Lazy object. - - - Extensions related to Lazy values. - - - Returns a new observable that triggers on the second and subsequent triggerings of the input observable. - The Nth triggering of the input observable passes the arguments from the N-1th and Nth triggering as - a pair. The argument passed to the N-1th triggering is held in hidden internal state until the - Nth triggering occurs. - - For each observer, the registered intermediate observing object is not thread safe. - That is, observations arising from the source must not be triggered concurrently - on different threads. - The input Observable. - An Observable that triggers on successive pairs of observations from the input Observable. - - - Creates an observer which subscribes to the given observable and which calls - the given function for each observation. - The function to be called on each observation. - The input Observable. - An object that will remove the callback if disposed. - - - Creates an observer which permanently subscribes to the given observable and which calls - the given function for each observation. - The function to be called on each observation. - The input Observable. - - - Returns an observable which, for each observer, allocates an item of state - and applies the given accumulating function to successive values arising from - the input. The returned object will trigger observations for each computed - state value, excluding the initial value. The returned object propagates - all errors arising from the source and completes when the source completes. - - For each observer, the registered intermediate observing object is not thread safe. - That is, observations arising from the source must not be triggered concurrently - on different threads. - The function to update the state with each observation. - The initial state. - The input Observable. - An Observable that triggers on the updated state values. - - - Returns an observable which chooses a projection of observations from the source - using the given function. The returned object will trigger observations x - for which the splitter returns Some x. The returned object also propagates - all errors arising from the source and completes when the source completes. - The function that returns Some for observations to be propagated - and None for observations to ignore. - The input Observable. - An Observable that only propagates some of the observations from the source. - - - Returns two observables which split the observations of the source by the - given function. The first will trigger observations x for which the - splitter returns Choice1Of2 x. The second will trigger observations - y for which the splitter returns Choice2Of2 y The splitter is - executed once for each subscribed observer. Both also propagate error - observations arising from the source and each completes when the source - completes. - The function that takes an observation an transforms - it into one of the two output Choice types. - The input Observable. - A tuple of Observables. The first triggers when splitter returns Choice1of2 - and the second triggers when splitter returns Choice2of2. - - - Returns two observables which partition the observations of the source by - the given function. The first will trigger observations for those values - for which the predicate returns true. The second will trigger observations - for those values where the predicate returns false. The predicate is - executed once for each subscribed observer. Both also propagate all error - observations arising from the source and each completes when the source - completes. - The function to determine which output Observable will trigger - a particular observation. - The input Observable. - A tuple of Observables. The first triggers when the predicate returns true, and - the second triggers when the predicate returns false. - - - Returns an observable which filters the observations of the source - by the given function. The observable will see only those observations - for which the predicate returns true. The predicate is executed once for - each subscribed observer. The returned object also propagates error - observations arising from the source and completes when the source completes. - The function to apply to observations to determine if it should - be kept. - The input Observable. - An Observable that filters observations based on filter. - - - Returns an observable which transforms the observations of the source by the - given function. The transformation function is executed once for each - subscribed observer. The returned object also propagates error observations - arising from the source and completes when the source completes. - The function applied to observations from the source. - The input Observable. - An Observable of the type specified by mapping. - - - Returns an observable for the merged observations from the sources. - The returned object propagates success and error values arising - from either source and completes when both the sources have completed. - - For each observer, the registered intermediate observing object is not - thread safe. That is, observations arising from the sources must not - be triggered concurrently on different threads. - The first Observable. - The second Observable. - An Observable that propagates information from both sources. - - - Basic operations on first class event and other observable objects. - - - Returns an asynchronous computation that, when run, will wait for the download of the given URI. - The URI to retrieve. - An asynchronous computation that will wait for the download of the URI. - - - Returns an asynchronous computation that, when run, will wait for a response to the given WebRequest. - An asynchronous computation that waits for response to the WebRequest. - - - A module of extension members providing asynchronous operations for some basic Web operations. - - - Creates an instance of the attribute - AbstractClassAttribute - - - Adding this attribute to class definition makes it abstract, which means it need not - implement all its methods. Instances of abstract classes may not be constructed directly. - - - Creates an instance of the attribute - AllowNullLiteralAttribute - - - Adding this attribute to a type lets the 'null' literal be used for the type - within F# code. This attribute may only be added to F#-defined class or - interface types. - - - Indicates the namespace or module to be automatically opened when an assembly is referenced - or an enclosing module opened. - - - Creates an attribute used to mark a namespace or module path to be 'automatically opened' when an assembly is referenced - The namespace or module to be automatically opened when an assembly is referenced - or an enclosing module opened. - AutoOpenAttribute - - - Creates an attribute used to mark a module as 'automatically opened' when the enclosing namespace is opened - AutoOpenAttribute - - - This attribute is used for two purposes. When applied to an assembly, it must be given a string - argument, and this argument must indicate a valid module or namespace in that assembly. Source - code files compiled with a reference to this assembly are processed in an environment - where the given path is automatically oepned. - - When applied to a module within an assembly, then the attribute must not be given any arguments. - When the enclosing namespace is opened in user source code, the module is also implicitly opened. - - - The value of the attribute, indicating whether the type is automatically marked serializable or not - - - Creates an instance of the attribute - Indicates whether the type should be serializable by default. - AutoSerializableAttribute - - - Adding this attribute to a type with value 'false' disables the behaviour where F# makes the - type Serializable by default. - - - Creates an instance of the attribute - CLIEventAttribute - - - Adding this attribute to a property with event type causes it to be compiled with as a CLI - metadata event, through a syntactic translation to a pair of 'add_EventName' and - 'remove_EventName' methods. - - - Creates an instance of the attribute - CLIMutableAttribute - - - Adding this attribute to a record type causes it to be compiled to a CLI representation - with a default constructor with property getters and setters. - - - Choice 2 of 2 choices - - - Choice 1 of 2 choices - - - Helper types for active patterns with 2 choices. - - - Choice 3 of 3 choices - - - Choice 2 of 3 choices - - - Choice 1 of 3 choices - - - Helper types for active patterns with 3 choices. - - - Choice 4 of 4 choices - - - Choice 3 of 4 choices - - - Choice 2 of 4 choices - - - Choice 1 of 4 choices - - - Helper types for active patterns with 4 choices. - - - Choice 5 of 5 choices - - - Choice 4 of 5 choices - - - Choice 3 of 5 choices - - - Choice 2 of 5 choices - - - Choice 1 of 5 choices - - - Helper types for active patterns with 5 choices. - - - Choice 6 of 6 choices - - - Choice 5 of 6 choices - - - Choice 4 of 6 choices - - - Choice 3 of 6 choices - - - Choice 2 of 6 choices - - - Choice 1 of 6 choices - - - Helper types for active patterns with 6 choices. - - - Choice 7 of 7 choices - - - Choice 6 of 7 choices - - - Choice 5 of 7 choices - - - Choice 4 of 7 choices - - - Choice 3 of 7 choices - - - Choice 2 of 7 choices - - - Choice 1 of 7 choices - - - Helper types for active patterns with 7 choices. - - - Creates an instance of the attribute - ClassAttribute - - - Adding this attribute to a type causes it to be represented using a CLI class. - - - Creates an instance of the attribute - ComparisonConditionalOnAttribute - - - This attribute is used to indicate a generic container type satisfies the F# 'comparison' - constraint only if a generic argument also satisfies this constraint. For example, adding - this attribute to parameter 'T on a type definition C<'T> means that a type C<X> only supports - comparison if the type X also supports comparison and all other conditions for C<X> to support - comparison are also met. The type C<'T> can still be used with other type arguments, but a type such - as C<(int -> int)> will not support comparison because the type (int -> int) is an F# function type - and does not support comparison. - - This attribute will be ignored if it is used on the generic parameters of functions or methods. - - - Indicates the number of arguments in each argument group - - - Creates an instance of the attribute - Indicates the number of arguments in each argument group. - CompilationArgumentCountsAttribute - - - This attribute is generated automatically by the F# compiler to tag functions and members - that accept a partial application of some of their arguments and return a residual function - - - Indicates the variant number of the entity, if any, in a linear sequence of elements with F# source code - - - Indicates the relationship between the compiled entity and F# source code - - - Indicates the sequence number of the entity, if any, in a linear sequence of elements with F# source code - - - Creates an instance of the attribute - Indicates the type of source construct. - CompilationMappingAttribute - - - Creates an instance of the attribute - Indicates the type of source construct. - CompilationMappingAttribute - - - Creates an instance of the attribute - Indicates the type of source construct. - CompilationMappingAttribute - - - This attribute is inserted automatically by the F# compiler to tag types - and methods in the generated CLI code with flags indicating the correspondence - with original source constructs. It is used by the functions in the - Microsoft.FSharp.Reflection namespace to reverse-map compiled constructs to - their original forms. It is not intended for use from user code. - - - Indicates one or more adjustments to the compiled representation of an F# type or member - - - Creates an instance of the attribute - Indicates adjustments to the compiled representation of the type or member. - CompilationRepresentationAttribute - - - This attribute is used to adjust the runtime representation for a type. - For example, it may be used to note that the null representation - may be used for a type. This affects how some constructs are compiled. - - - Compile a property as a CLI event. - - - Permit the use of null as a representation for nullary discriminators in a discriminated union. - - - append 'Module' to the end of a module whose name clashes with a type name in the same namespace. - - - Compile a member as 'instance' even if null is used as a representation for this type. - - - Compile an instance member as 'static' . - - - No special compilation representation. - - - - - - Indicates one or more adjustments to the compiled representation of an F# type or member. - - - Indicates the name of the entity in F# source code - - - Creates an instance of the attribute - The name of the method in source. - CompilationSourceNameAttribute - - - This attribute is inserted automatically by the F# compiler to tag - methods which are given the 'CompiledName' attribute. It is not intended - for use from user code. - - - The name of the value as it appears in compiled code - - - Creates an instance of the attribute - The name to use in compiled code. - CompiledNameAttribute - - - Adding this attribute to a value or function definition in an F# module changes the name used - for the value in compiled CLI code. - - - Indicates if the construct should always be hidden in an editing environment. - - - Indicates if the message should indicate a compiler error. Error numbers less than - 10000 are considered reserved for use by the F# compiler and libraries. - - - Indicates the number associated with the message. - - - Indicates the warning message to be emitted when F# source code uses this construct - - - Indicates if the construct should always be hidden in an editing environment. - - - Indicates if the message should indicate a compiler error. Error numbers less than - 10000 are considered reserved for use by the F# compiler and libraries. - - - Creates an instance of the attribute. - - - Indicates that a message should be emitted when F# source code uses this construct. - - - Creates an instance of the attribute - CustomComparisonAttribute - - - Adding this attribute to a type indicates it is a type with a user-defined implementation of comparison. - - - Creates an instance of the attribute - CustomEqualityAttribute - - - Adding this attribute to a type indicates it is a type with a user-defined implementation of equality. - - - Indicates if the custom operation maintains the variable space of the query of computation expression through the use of a bind operation - - - Indicates if the custom operation maintains the variable space of the query of computation expression - - - Indicates the name used for the 'on' part of the custom query operator for join-like operators - - - Indicates if the custom operation is an operation similar to a zip in a sequence computation, supporting two inputs - - - Indicates if the custom operation is an operation similar to a join in a sequence computation, supporting two inputs and a correlation constraint - - - Indicates if the custom operation is an operation similar to a group join in a sequence computation, supporting two inputs and a correlation constraint, and generating a group - - - Indicates if the custom operation supports the use of 'into' immediately after the use of the operation in a query or other computation expression to consume the results of the operation - - - Get the name of the custom operation when used in a query or other computation expression - - - Indicates if the custom operation maintains the variable space of the query of computation expression through the use of a bind operation - - - Indicates if the custom operation maintains the variable space of the query of computation expression - - - Indicates the name used for the 'on' part of the custom query operator for join-like operators - - - Indicates if the custom operation is an operation similar to a zip in a sequence computation, supporting two inputs - - - Indicates if the custom operation is an operation similar to a join in a sequence computation, supporting two inputs and a correlation constraint - - - Indicates if the custom operation is an operation similar to a group join in a sequence computation, supporting two inputs and a correlation constraint, and generating a group - - - Indicates if the custom operation supports the use of 'into' immediately after the use of the operation in a query or other computation expression to consume the results of the operation - - - Creates an instance of the attribute - CustomOperationAttribute - - - - Indicates that a member on a computation builder type is a custom query operator, - and indicates the name of that operator. - - - - The value of the attribute, indicating whether the type has a default augmentation or not - - - Creates an instance of the attribute - Indicates whether to generate helper members on the CLI class representing a discriminated - union. - DefaultAugmentationAttribute - - - Adding this attribute to a discriminated union with value false - turns off the generation of standard helper member tester, constructor - and accessor members for the generated CLI class for that type. - - - Indicates if a constraint is asserted that the field type supports 'null' - - - Creates an instance of the attribute - Indicates whether to assert that the field type supports null. - DefaultValueAttribute - - - Creates an instance of the attribute - DefaultValueAttribute - - - Adding this attribute to a field declaration means that the field is - not initialized. During type checking a constraint is asserted that the field type supports 'null'. - If the 'check' value is false then the constraint is not asserted. - - - Creates an instance of the attribute - EntryPointAttribute - - - Adding this attribute to a function indicates it is the entrypoint for an application. - If this attribute is not specified for an EXE then the initialization implicit in the - module bindings in the last file in the compilation sequence are used as the entrypoint. - - - Creates an instance of the attribute - EqualityConditionalOnAttribute - - - This attribute is used to indicate a generic container type satisfies the F# 'equality' - constraint only if a generic argument also satisfies this constraint. For example, adding - this attribute to parameter 'T on a type definition C<'T> means that a type C<X> only supports - equality if the type X also supports equality and all other conditions for C<X> to support - equality are also met. The type C<'T> can still be used with other type arguments, but a type such - as C<(int -> int)> will not support equality because the type (int -> int) is an F# function type - and does not support equality. - - This attribute will be ignored if it is used on the generic parameters of functions or methods. - - - Indicates the warning message to be emitted when F# source code uses this construct - - - Creates an instance of the attribute - The warning message to be emitted when code uses this construct. - ExperimentalAttribute - - - This attribute is used to tag values that are part of an experimental library - feature. - - - Convert an value of type System.Converter to a F# first class function value - The input System.Converter. - An F# function of the same type. - - - Convert an F# first class function value to a value of type System.Converter - The input function. - A System.Converter of the function type. - - - Convert an F# first class function value to a value of type System.Converter - The input function. - System.Converter<'T,'U> - - - Invoke an F# first class function value with two curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The function result. - - - Invoke an F# first class function value with three curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The third arg. - The function result. - - - Invoke an F# first class function value with four curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The third arg. - The fourth arg. - The function result. - - - Invoke an F# first class function value with five curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The third arg. - The fourth arg. - The fifth arg. - The function result. - - - Invoke an F# first class function value with one argument - - 'U - - - Convert an value of type System.Converter to a F# first class function value - The input System.Converter. - An F# function of the same type. - - - Construct an instance of an F# first class function value - The created F# function. - - - The CLI type used to represent F# function values. This type is not - typically used directly, though may be used from other CLI languages. - - - The release number of the F# version associated with the attribute - - - The minor version number of the F# version associated with the attribute - - - The major version number of the F# version associated with the attribute - - - Creates an instance of the attribute - The major version number. - The minor version number. - The release number. - FSharpInterfaceDataVersionAttribute - - - This attribute is added to generated assemblies to indicate the - version of the data schema used to encode additional F# - specific information in the resource attached to compiled F# libraries. - - - Specialize the type function at a given type - The specialized type. - - - Construct an instance of an F# first class type function value - FSharpTypeFunc - - - The CLI type used to represent F# first-class type function values. This type is for use - by compiled F# code. - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - Tuple of values generated by scan or match. - - - Convert the given Converter delegate object to an F# function value - The input Converter. - The F# function. - - - Convert the given Action delegate object to an F# function value - The input action. - The F# function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - Helper functions for converting F# first class function values to and from CLI representaions - of functions using delegates. - - - Creates an instance of the attribute - GeneralizableValueAttribute - - - Adding this attribute to a non-function value with generic parameters indicates that - uses of the construct can give rise to generic code through type inference. - - - Creates an instance of the attribute - InterfaceAttribute - - - Adding this attribute to a type causes it to be represented using a CLI interface. - - - Creates an instance of the attribute - LiteralAttribute - - - Adding this attribute to a value causes it to be compiled as a CLI constant literal. - - - Creates an instance of the attribute - MeasureAnnotatedAbbreviationAttribute - - - Adding this attribute to a type causes it to be interpreted as a refined type, currently limited to measure-parameterized types. - This may only be used under very limited conditions. - - - Creates an instance of the attribute - MeasureAttribute - - - Adding this attribute to a type causes it to be interpreted as a unit of measure. - This may only be used under very limited conditions. - - - Creates an instance of the attribute - NoComparisonAttribute - - - Adding this attribute to a type indicates it is a type where comparison is an abnormal operation. - This means that the type does not satisfy the F# 'comparison' constraint. Within the bounds of the - F# type system, this helps ensure that the F# generic comparison function is not instantiated directly - at this type. The attribute and checking does not constrain the use of comparison with base or child - types of this type. - - - Creates an instance of the attribute - NoDynamicInvocationAttribute - - - This attribute is used to tag values that may not be dynamically invoked at runtime. This is - typically added to inlined functions whose implementations include unverifiable code. It - causes the method body emitted for the inlined function to raise an exception if - dynamically invoked, rather than including the unverifiable code in the generated - assembly. - - - Creates an instance of the attribute - NoEqualityAttribute - - - Adding this attribute to a type indicates it is a type where equality is an abnormal operation. - This means that the type does not satisfy the F# 'equality' constraint. Within the bounds of the - F# type system, this helps ensure that the F# generic equality function is not instantiated directly - at this type. The attribute and checking does not constrain the use of comparison with base or child - types of this type. - - - The representation of "Value of type 'T" - The input value. - An option representing the value. - - - The representation of "No value" - - - Get the value of a 'Some' option. A NullReferenceException is raised if the option is 'None'. - - - Create an option value that is a 'None' value. - - - Return 'true' if the option is a 'Some' value. - - - Return 'true' if the option is a 'None' value. - - - Create an option value that is a 'Some' value. - The input value - An option representing the value. - - - The type of optional values. When used from other CLI languages the - empty option is the null value. - - Use the constructors Some and None to create values of this type. - Use the values in the Option module to manipulate values of this type, - or pattern match against the values directly. - - None values will appear as the value null to other CLI languages. - Instance methods on this type will appear as static methods to other CLI languages - due to the use of null as a value representation. - - - Creates an instance of the attribute - OptionalArgumentAttribute - - - This attribute is added automatically for all optional arguments. - - - The raw text of the format string. - - - Construct a format string - The input string. - The PrintfFormat containing the formatted result. - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - - - Construct a format string - The input string. - The created format string. - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - Tuple of values generated by scan or match. - - - Creates an instance of the attribute - ProjectionParameterAttribute - - - Indicates that, when a custom operator is used in a computation expression, - a parameter is automatically parameterized by the variable space of the computation expression - - - - The current value of the reference cell - - - - The current value of the reference cell - - - The current value of the reference cell - - - The type of mutable references. Use the functions [:=] and [!] to get and - set values of this type. - - - Creates an instance of the attribute - ReferenceEqualityAttribute - - - Adding this attribute to a record or union type disables the automatic generation - of overrides for 'System.Object.Equals(obj)', 'System.Object.GetHashCode()' - and 'System.IComparable' for the type. The type will by default use reference equality. - - - Creates an instance of the attribute - ReflectedDefinitionAttribute - - - Adding this attribute to the let-binding for the definition of a top-level - value makes the quotation expression that implements the value available - for use at runtime. - - - Creates an instance of the attribute - RequireQualifiedAccessAttribute - - - This attribute is used to indicate that references to the elements of a module, record or union - type require explicit qualified access. - - - Creates an instance of the attribute - RequiresExplicitTypeArgumentsAttribute - - - Adding this attribute to a type, value or member requires that - uses of the construct must explicitly instantiate any generic type parameters. - - - The value of the attribute, indicating whether the type is sealed or not. - - - Creates an instance of the attribute - Indicates whether the class is sealed. - SealedAttribute - - - Creates an instance of the attribute. - The created attribute. - - - Adding this attribute to class definition makes it sealed, which means it may not - be extended or implemented. - - - Indicates that the compiled entity had private or internal representation in F# source code. - - - The mask of values related to the kind of the compiled entity. - - - Indicates that the compiled entity is part of the representation of an F# value declaration. - - - Indicates that the compiled entity is part of the representation of an F# union case declaration. - - - Indicates that the compiled entity is part of the representation of an F# module declaration. - - - Indicates that the compiled entity is part of the representation of an F# closure. - - - Indicates that the compiled entity is part of the representation of an F# exception declaration. - - - Indicates that the compiled entity is part of the representation of an F# record or union case field declaration. - - - Indicates that the compiled entity is part of the representation of an F# class or other object type declaration. - - - Indicates that the compiled entity is part of the representation of an F# record type declaration. - - - Indicates that the compiled entity is part of the representation of an F# union type declaration. - - - Indicates that the compiled entity has no relationship to an element in F# source code. - - - - - - Indicates the relationship between a compiled entity in a CLI binary and an element in F# source code. - - - Creates an instance of the attribute - StructAttribute - - - Adding this attribute to a type causes it to be represented using a CLI struct. - - - Creates an instance of the attribute - StructuralComparisonAttribute - - - Adding this attribute to a record, union, exception, or struct type confirms the - automatic generation of implementations for 'System.IComparable' for the type. - - - Creates an instance of the attribute - StructuralEqualityAttribute - - - Adding this attribute to a record, union or struct type confirms the automatic - generation of overrides for 'System.Object.Equals(obj)' and - 'System.Object.GetHashCode()' for the type. - - - Indicates the text to display by default when objects of this type are displayed - using '%A' printf formatting patterns and other two-dimensional text-based display - layouts. - - - Creates an instance of the attribute - Indicates the text to display when using the '%A' printf formatting. - StructuredFormatDisplayAttribute - - - This attribute is used to mark how a type is displayed by default when using - '%A' printf formatting patterns and other two-dimensional text-based display layouts. - In this version of F# the only valid values are of the form PreText {PropertyName} PostText. - The property name indicates a property to evaluate and to display instead of the object itself. - - - The type 'unit', which has only one value "()". This value is special and - always uses the representation 'null'. - - - Creates an instance of the attribute - UnverifiableAttribute - - - This attribute is used to tag values whose use will result in the generation - of unverifiable code. These values are inevitably marked 'inline' to ensure that - the unverifiable constructs are not present in the actual code for the F# library, - but are rather copied to the source code of the caller. - - - Creates an instance of the attribute - VolatileFieldAttribute - - - Adding this attribute to an F# mutable binding causes the "volatile" - prefix to be used for all accesses to the field. - - - Four dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - Use the values in the Array4D module - to manipulate values of this type, or the notation arr.[x1,x2,x3,x4] to get and set array - values. - - - Three dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - Use the values in the Array3D module - to manipulate values of this type, or the notation arr.[x1,x2,x3] to get and set array - values. - - - Two dimensional arrays, typically zero-based. - - Use the values in the Array2D module - to manipulate values of this type, or the notation arr.[x,y] to get/set array - values. - - Non-zero-based arrays can also be created using methods on the System.Array type. - - - Single dimensional, zero-based arrays, written int[], string[] etc. - Use the values in the Array module to manipulate values - of this type, or the notation arr.[x] to get/set array - values. - - - Single dimensional, zero-based arrays, written int[], string[] etc. - - Use the values in the Array module to manipulate values - of this type, or the notation arr.[x] to get/set array - values. - - - - - - An abbreviation for the CLI type System.Boolean. - - - Represents a managed pointer in F# code. - - - An abbreviation for the CLI type System.Byte. - - - An abbreviation for the CLI type System.Char. - - - An abbreviation for the CLI type System.Decimal. - - - The type of decimal numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Decimal. - - - An abbreviation for the CLI type System.Double. - - - An abbreviation for the CLI type System.Exception. - - - An abbreviation for the CLI type System.Double. - - - An abbreviation for the CLI type System.Single. - - - The type of floating point numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Single. - - - The type of floating point numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Double. - - - This type is for internal use by the F# code generator. - - - An abbreviation for the CLI type System.Int32. - - - An abbreviation for the CLI type System.Int16. - - - The type of 16-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Int16. - - - An abbreviation for the CLI type System.Int32. - - - An abbreviation for the CLI type System.Int64. - - - The type of 64-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Int64. - - - An abbreviation for the CLI type System.SByte. - - - The type of 32-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Int32. - - - An abbreviation for the CLI type System.IntPtr. - - - Represents an unmanaged pointer in F# code. - - This type should only be used when writing F# code that interoperates - with native code. Use of this type in F# code may result in - unverifiable code being generated. Conversions to and from the - nativeint type may be required. Values of this type can be generated - by the functions in the NativeInterop.NativePtr module. - - - An abbreviation for the CLI type System.Object. - - - The type of optional values. When used from other CLI languages the - empty option is the null value. - - Use the constructors Some and None to create values of this type. - Use the values in the Option module to manipulate values of this type, - or pattern match against the values directly. - - 'None' values will appear as the value null to other CLI languages. - Instance methods on this type will appear as static methods to other CLI languages - due to the use of null as a value representation. - - - The type of mutable references. Use the functions [:=] and [!] to get and - set values of this type. - - - An abbreviation for the CLI type System.SByte. - - - The type of 8-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.SByte. - - - An abbreviation for the CLI type System.Single. - - - An abbreviation for the CLI type System.String. - - - An abbreviation for the CLI type System.UInt16. - - - An abbreviation for the CLI type System.UInt32. - - - An abbreviation for the CLI type System.UInt64. - - - An abbreviation for the CLI type System.Byte. - - - An abbreviation for the CLI type System.UIntPtr. - - - The type 'unit', which has only one value "()". This value is special and - always uses the representation 'null'. - - - - - - - - - - - - Non-exhaustive match failures will raise the MatchFailureException exception - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - A new enumerator for the sequence. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - A reference to the sequence. - - A 0, 1, and 2 respectively indicate Stop, Yield, and Goto conditions for the sequence generator. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - A new sequence generator for the expression. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - - - - - - - - - - - - - Creates an anonymous event with the given handlers. - - A function to handle adding a delegate for the event to trigger. - A function to handle removing a delegate that the event triggers. - A function to produce the delegate type the event can trigger. - - The initialized event. - - - The F# compiler emits calls to this function to implement the use operator for F# sequence - expressions. - - The resource to be used and disposed. - The input sequence. - - The result sequence. - - - The F# compiler emits calls to this function to implement the compiler-intrinsic - conversions from untyped System.Collections.IEnumerable sequences to typed sequences. - - An initializer function. - A function to iterate and test if end of sequence is reached. - A function to retrieve the current element. - - The resulting typed sequence. - - - The F# compiler emits calls to this function to - implement the try/finally operator for F# sequence expressions. - - The input sequence. - A computation to be included in an enumerator's Dispose method. - - The result sequence. - - - The F# compiler emits calls to this function to - implement the while operator for F# sequence expressions. - - A function that indicates whether iteration should continue. - The input sequence. - - The result sequence. - - - A group of functions used as part of the compiled representation of F# sequence expressions. - - - An active pattern to force the execution of values of type Lazy<_>. - - - Special prefix operator for splicing untyped expressions into quotation holes. - - - Special prefix operator for splicing typed expressions into quotation holes. - - - Builds a 2D array from a sequence of sequences of elements. - - - Builds a read-only lookup table from a sequence of key/value pairs. The key objects are indexed using generic hashing and equality. - - - Converts the argument to signed byte. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using SByte.Parse() with InvariantCulture settings. - Otherwise the operation requires and invokes a ToSByte method on the input type. - - - Converts the argument to byte. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Byte.Parse() on strings and otherwise requires a ToByte method on the input type. - - - Converts the argument to 64-bit float. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Double.Parse() with InvariantCulture settings. Otherwise the operation requires and invokes a ToDouble method on the input type. - - - Converts the argument to 32-bit float. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Single.Parse() with InvariantCulture settings. Otherwise the operation requires and invokes a ToSingle method on the input type. - - - Builds an aysnchronous workflow using computation expression syntax. - - - Builds a set from a sequence of objects. The objects are indexed using generic comparison. - The input sequence of elements. - The created set. - - - Print to a file using the given format, and add a newline. - The file TextWriter. - The formatter. - The formatted result. - - - Print to a file using the given format. - The file TextWriter. - The formatter. - The formatted result. - - - Print to a string buffer and raise an exception with the given - result. Helper printers must return strings. - The formatter. - The formatted result. - - - Print to a string using the given format. - The formatter. - The formatted result. - - - Print to stderr using the given format, and add a newline. - The formatter. - The formatted result. - - - Print to stderr using the given format. - The formatter. - The formatted result. - - - Print to stdout using the given format, and add a newline. - The formatter. - The formatted result. - - - Print to stdout using the given format. - The formatter. - The formatted result. - - - - - - Divides a value by an integer. - The input value. - The input int. - The division result. - - - - - - Resolves to the value 'one' for any primitive numeric type or any type with a static member called 'One' - - - Resolves to the zero value for any primitive numeric type or any type with a static member called 'Zero' - - - A compiler intrinsic that implements dynamic invocations for the DivideByInt primitive. - - - A compiler intrinsic that implements dynamic invocations to the checked '*' operator. - - - A compiler intrinsic that implements dynamic invocations to the '*' operator. - - - A compiler intrinsic that implements dynamic invocations to the checked '+' operator. - - - A compiler intrinsic that implements dynamic invocations to the '+' operator. - - - Resolves to the value 'one' for any primitive numeric type or any type with a static member called 'One'. - - - Resolves to the zero value for any primitive numeric type or any type with a static member called 'Zero'. - - - Parse an uint64 according to the rules used by the overloaded 'uint64' conversion operator when applied to strings - The input string. - The parsed value. - - - Parse an int64 according to the rules used by the overloaded 'int64' conversion operator when applied to strings - The input string. - The parsed value. - - - Parse an uint32 according to the rules used by the overloaded 'uint32' conversion operator when applied to strings - The input string. - The parsed value. - - - Parse an int32 according to the rules used by the overloaded 'int32' conversion operator when applied to strings - The input string. - The parsed value. - - - Creates an sbyte value with units-of-measure - The input sbyte. - The sbyte with units-of-measure. - - - Creates an int16 value with units-of-measure - The input int16. - The int16 with units-of-measure. - - - Creates an int64 value with units-of-measure - The input int64. - The int64 with units of measure. - - - Creates an int32 value with units-of-measure - The input int. - The int with units of measure. - - - Creates a decimal value with units-of-measure - The input decimal. - The decimal with units of measure. - - - Creates a float32 value with units-of-measure - The input float. - The float with units-of-measure. - - - Creates a float value with units-of-measure - The input float. - The float with units-of-measure. - - - Get the underlying value for an enum value - The input enum. - The enumeration as a value. - - - Build an enum value from an underlying value - The input value. - The value as an enumeration. - - - Recursively hash a part of a value according to its structure. - The comparison function. - The input object. - The hashed value. - - - Hash a value according to its structure. Use the given limit to restrict the hash when hashing F# - records, lists and union types. - The limit on the number of nodes. - The input object. - The hashed value. - - - Hash a value according to its structure. This hash is not limited by an overall node count when hashing F# - records, lists and union types. - The input object. - The hashed value. - - - Make an F# hash/equality object for the given type using node-limited hashing when hashing F# - records, lists and union types. - The input limit on the number of nodes. - System.Collections.Generic.IEqualityComparer<'T> - - - Make an F# hash/equality object for the given type - - - Make an F# comparer object for the given type, where it can be null if System.Collections.Generic.Comparer<'T>.Default - - - Make an F# comparer object for the given type - - - A static F# comparer object - - - Return an F# comparer object suitable for hashing and equality. This hashing behaviour - of the returned comparer is not limited by an overall node count when hashing F# - records, lists and union types. This equality comparer has equivalence - relation semantics ([nan] = [nan]). - - - Return an F# comparer object suitable for hashing and equality. This hashing behaviour - of the returned comparer is not limited by an overall node count when hashing F# - records, lists and union types. - - - The physical hash. Hashes on the object identity, except for value types, - where we hash on the contents. - The input object. - The hashed value. - - - Reference/physical equality. - True if the inputs are reference-equal, false otherwise. - The first value. - The second value. - The result of the comparison. - - - Take the maximum of two values structurally according to the order given by GenericComparison - The first value. - The second value. - The maximum value. - - - Take the minimum of two values structurally according to the order given by GenericComparison - The first value. - The second value. - The minimum value. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values. May be called as a recursive case from an implementation of System.IComparable to - ensure consistent NaN comparison semantics. - The function to compare the values. - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values for equality - - The first value. - The second value. - The result of the comparison. - - - Compare two values for equality using equivalence relation semantics ([nan] = [nan]) - The first value. - The second value. - The result of the comparison. - - - Compare two values for equality using partial equivalence relation semantics ([nan] <> [nan]) - The first value. - The second value. - The result of the comparison. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs - - - - The standard overloaded associative (4-indexed) mutation operator - - - - The standard overloaded associative (3-indexed) mutation operator - - - The standard overloaded associative (2-indexed) mutation operator - - - The standard overloaded associative (indexed) mutation operator - - - The standard overloaded associative (4-indexed) lookup operator - - - The standard overloaded associative (3-indexed) lookup operator - - - The standard overloaded associative (2-indexed) lookup operator - - - The standard overloaded associative (indexed) lookup operator - - - A compiler intrinsic for checking initialization soundness of recursive bindings - - - A compiler intrinsic for checking initialization soundness of recursive static bindings - - - A compiler intrinsic for checking initialization soundness of recursive bindings - - - A compiler intrinsic for the efficient compilation of sequence expressions - - - This function implements parsing of decimal constants - - - This function implements calls to default constructors - acccessed by 'new' constraints. - - - Primitive used by pattern match compilation - - - A compiler intrinsic that implements the ':?' operator - - - A compiler intrinsic that implements the ':?' operator - - - A compiler intrinsic that implements the ':?>' operator - - - A compiler intrinsic that implements the ':?>' operator - - - The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs - - - Address-of. Uses of this value may result in the generation of unverifiable code. - The input object. - The unmanaged pointer. - - - Address-of. Uses of this value may result in the generation of unverifiable code. - The input object. - The managed pointer. - - - Binary 'or'. When used as a binary operator the right hand value is evaluated only on demand - The first value. - The second value. - The result of the operation. - - - Binary 'or'. When used as a binary operator the right hand value is evaluated only on demand. - - - Binary 'and'. When used as a binary operator the right hand value is evaluated only on demand - The first value. - The second value. - The result of the operation. - - - Binary 'and'. When used as a binary operator the right hand value is evaluated only on demand. - - - The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs - - - - - - - - - - - - - - - - - - For internal use only - - - Language primitives associated with the F# language - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - An active pattern to match values of type System.Collections.Generic.KeyValuePair - The input key/value pair. - A tuple containing the key and value. - - - Converts the argument to character. Numeric inputs are converted according to the UTF-16 - encoding for characters. String inputs must be exactly one character long. For other - input types the operation requires an appropriate static conversion method on the input type. - The input value. - The converted char. - - - Converts the argument to System.Decimal using a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted decimal. - - - Converts the argument to a string using ToString. - - For standard integer and floating point values the ToString conversion - uses CultureInfo.InvariantCulture. - The input value. - The converted string. - - - Converts the argument to unsigned native integer using a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted unativeint - - - Converts the argument to signed native integer. This is a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted nativeint - - - Converts the argument to 64-bit float. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Double.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float - - - Converts the argument to 32-bit float. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Single.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float32 - - - Converts the argument to unsigned 64-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint64 - - - Converts the argument to signed 64-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int64 - - - Converts the argument to unsigned 32-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint32 - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int32 - - - Converts the argument to a particular enum type. - The input value. - The converted enum type. - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int - - - Converts the argument to unsigned 16-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint16 - - - Converts the argument to signed 16-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int16 - - - Converts the argument to signed byte. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using SByte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to byte. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Byte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - Overloaded power operator. If n > 0 then equivalent to x*...*x for n occurrences of x. - The input base. - The input exponent. - The base raised to the exponent. - - - Overloaded power operator. - The input base. - The input exponent. - The base raised to the exponent. - - - Overloaded truncate operator. - The input value. - The truncated value. - - - Hyperbolic tangent of the given number - The input value. - The hyperbolic tangent of the input. - - - Tangent of the given number - The input value. - The tangent of the input. - - - Hyperbolic sine of the given number - The input value. - The hyperbolic sine of the input. - - - Sine of the given number - The input value. - The sine of the input. - - - Hyperbolic cosine of the given number - The input value. - The hyperbolic cosine of the input. - - - Cosine of the given number - The input value. - The cosine of the input. - - - Square root of the given number - The input value. - The square root of the input. - - - Logarithm to base 10 of the given number - The input value. - The logarithm to base 10 of the input. - - - Natural logarithm of the given number - The input value. - The natural logarithm of the input. - - - Round the given number - The input value. - The nearest integer to the input value. - - - Sign of the given number - The input value. - -1, 0, or 1 depending on the sign of the input. - - - Floor of the given number - The input value. - The floor of the input. - - - Exponential of the given number - The input value. - The exponential of the input. - - - Ceiling of the given number - The input value. - The ceiling of the input. - - - Inverse tangent of x/y where x and y are specified separately - The y input value. - The x input value. - The inverse tangent of the input ratio. - - - Inverse tangent of the given number - The input value. - The inverse tangent of the input. - - - Inverse sine of the given number - The input value. - The inverse sine of the input. - - - Inverse cosine of the given number - The input value. - The inverse cosine of the input. - - - Absolute value of the given number. - The input value. - The absolute value of the input. - - - A generic hash function. This function has the same behaviour as 'hash', - however the default structural hashing for F# union, record and tuple - types stops when the given limit of nodes is reached. The exact behaviour of - the function can be adjusted on a type-by-type basis by implementing - GetHashCode for each type. - The limit of nodes. - The input object. - The computed hash. - - - A generic hash function, designed to return equal hash values for items that are - equal according to the "=" operator. By default it will use structural hashing - for F# union, record and tuple types, hashing the complete contents of the - type. The exact behaviour of the function can be adjusted on a - type-by-type basis by implementing GetHashCode for each type. - The input object. - The computed hash. - - - Returns the internal size of a type in bytes. For example, sizeof<int> returns 4. - - - Generate a System.Type representation for a type definition. If the - input type is a generic type instantiation then return the - generic type definition associated with all such instantiations. - - - An internal, library-only compiler intrinsic for compile-time - generation of a RuntimeMethodHandle. - - - Generate a System.Type runtime representation of a static type. - The static type is still maintained on the value returned. - - - Clean up resources associated with the input object after the completion of the given function. - Cleanup occurs even when an exception is raised by the protected - code. - The resource to be disposed after action is called. - The action that accepts the resource. - The resulting value. - - - Execute the function as a mutual-exclusion region using the input value as a lock. - The object to be locked. - The action to perform during the lock. - The resulting value. - - - The standard overloaded skip range operator, e.g. [n..skip..m] for lists, seq {n..skip..m} for sequences - The start value of the range. - The step value of the range. - The end value of the range. - The sequence spanning the range using the specified step size. - - - The standard overloaded range operator, e.g. [n..m] for lists, seq {n..m} for sequences - The start value of the range. - The end value of the range. - The sequence spanning the range. - - - Reads the value of the property System.Console.Out. - - - Reads the value of the property System.Console.Error. - - - Reads the value of the property System.Console.In. - - - Equivalent to System.Single.NaN - - - Equivalent to System.Single.PositiveInfinity - - - Equivalent to System.Double.NaN - - - Equivalent to System.Double.PositiveInfinity - - - Exit the current hardware isolated process, if security settings permit, - otherwise raise an exception. Calls System.Environment.Exit. - The exit code to use. - The result value. - - - Builds a sequence using sequence expression syntax - The input sequence. - The result sequence. - - - Negate a logical value. not true equals false and not false equals true - The value to negate. - The result of the negation. - - - Concatenate two lists. - The first list. - The second list. - The concatenation of the lists. - - - Increment a mutable reference cell containing an integer - The reference cell. - - - Decrement a mutable reference cell containing an integer - The reference cell. - - - Dereference a mutable reference cell - The cell to dereference. - The value contained in the cell. - - - Assign to a mutable reference cell - The cell to mutate. - The value to set inside the cell. - - - Create a mutable reference cell - The value to contain in the cell. - The created reference cell. - - - The identity function - The input value. - The same value. - - - Throw a System.InvalidOperationException exception - The exception message. - The result value. - - - Throw a System.ArgumentNullException exception - The argument name. - The result value. - - - Throw a System.ArgumentException exception with - the given argument name and message. - The argument name. - The exception message. - The result value. - - - Throw a System.Exception exception. - The exception message. - The result value. - - - Boxes a strongly typed value. - The value to box. - The boxed object. - - - Unboxes a strongly typed value. This is the inverse of box, unbox<t>(box<t> a) equals a. - The boxed value. - The unboxed result. - - - Ignore the passed value. This is often used to throw away results of a computation. - The value to ignore. - - - Minimum based on generic comparison - The first value. - The second value. - The minimum value. - - - Maximum based on generic comparison - The first value. - The second value. - The maximum value. - - - Generic comparison. - The first value. - The second value. - The result of the comparison. - - - Return the second element of a tuple, snd (a,b) = b. - The input tuple. - The second value. - - - Return the first element of a tuple, fst (a,b) = a. - The input tuple. - The first value. - - - Matches System.Exception objects whose runtime type is precisely System.Exception - The input exception. - A string option. - - - Builds a System.Exception object. - The message for the Exception. - A System.Exception. - - - Rethrows an exception. This should only be used when handling an exception - The result value. - - - Rethrows an exception. This should only be used when handling an exception - The result value. - - - Raises an exception - The exception to raise. - The result value. - - - Concatenate two strings. The operator '+' may also be used. - - - Used to specify a default value for an optional argument in the implementation of a function - An option representing the argument. - The default value of the argument. - The argument value. If it is None, the defaultValue is returned. - - - Apply a function to three values, the values being a triple on the right, the function on the left - The function. - The first argument. - The second argument. - The third argument. - The function result. - - - Apply a function to two values, the values being a pair on the right, the function on the left - The function. - The first argument. - The second argument. - The function result. - - - Apply a function to a value, the value being on the right, the function on the left - The function. - The argument. - The function result. - - - Apply a function to three values, the values being a triple on the left, the function on the right - The first argument. - The second argument. - The third argument. - The function. - The function result. - - - Apply a function to two values, the values being a pair on the left, the function on the right - The first argument. - The second argument. - The function. - The function result. - - - Apply a function to a value, the value being on the left, the function on the right - The argument. - The function. - The function result. - - - Compose two functions, the function on the right being applied first - The second function to apply. - The first function to apply. - The composition of the input functions. - - - Compose two functions, the function on the left being applied first - The first function to apply. - The second function to apply. - The composition of the input functions. - - - Structural inequality - The first parameter. - The second parameter. - The result of the comparison. - - - Structural equality - The first parameter. - The second parameter. - The result of the comparison. - - - Structural less-than-or-equal comparison - The first parameter. - The second parameter. - The result of the comparison. - - - Structural greater-than-or-equal - The first parameter. - The second parameter. - The result of the comparison. - - - Structural greater-than - The first parameter. - The second parameter. - The result of the comparison. - - - Structural less-than comparison - The first parameter. - The second parameter. - The result of the comparison. - - - Overloaded prefix=plus operator - The input value. - The result of the operation. - - - Overloaded logical-NOT operator - The input value. - The result of the operation. - - - Overloaded byte-shift right operator by a specified number of bits - The input value. - The amount to shift. - The result of the operation. - - - Overloaded byte-shift left operator by a specified number of bits - The input value. - The amount to shift. - The result of the operation. - - - Overloaded logical-XOR operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded logical-OR operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded logical-AND operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded modulo operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded division operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded multiplication operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded subtraction operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded addition operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded unary negation. - The value to negate. - The result of the operation. - - - Converts the argument to char. Numeric inputs are converted using a checked - conversion according to the UTF-16 encoding for characters. String inputs must - be exactly one character long. For other input types the operation requires an - appropriate static conversion method on the input type. - The input value. - The converted char - - - Converts the argument to unativeint. This is a direct, checked conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted unativeint - - - Converts the argument to nativeint. This is a direct, checked conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted nativeint - - - Converts the argument to uint64. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.UInt64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint64 - - - Converts the argument to int64. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int64 - - - Converts the argument to uint32. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.UInt32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint32 - - - Converts the argument to int32. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int32 - - - Converts the argument to int. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int - - - Converts the argument to uint16. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.UInt16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint16 - - - Converts the argument to int16. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int16 - - - Converts the argument to sbyte. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.SByte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to byte. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Byte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - Overloaded multiplication operator (checks for overflow) - The first value. - The second value. - The product of the two input values. - - - Overloaded addition operator (checks for overflow) - The first value. - The second value. - The sum of the two input values. - - - Overloaded subtraction operator (checks for overflow) - The first value. - The second value. - The first value minus the second value. - - - Overloaded unary negation (checks for overflow) - The input value. - The negated value. - - - This module contains the basic arithmetic operations with overflow checks. - - - Perform generic hashing on a value where the type of the value is not - statically required to satisfy the 'equality' constraint. - The computed hash value. - - - Perform generic equality on two values where the type of the values is not - statically required to satisfy the 'equality' constraint. - The result of the comparison. - - - Perform generic comparison on two values where the type of the values is not - statically required to have the 'comparison' constraint. - The result of the comparison. - - - Generate a default value for any type. This is null for reference types, - For structs, this is struct value where all fields have the default value. - This function is unsafe in the sense that some F# values do not have proper null values. - - - Unboxes a strongly typed value. This is the inverse of box, unbox<t>(box<t> a) equals a. - The boxed value. - The unboxed result. - - - This module contains basic operations which do not apply runtime and/or static checks - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'decimal' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'float' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'float32' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'unativeint' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'nativeint' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint64' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int64' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint32' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int32' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint16' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int16' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'sbyte' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'byte' - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - Generate a range of values using the given zero, add, start, step and stop values - - - Generate a range of values using the given zero, add, start, step and stop values - - - Generate a range of char values - - - Generate a range of byte values - - - Generate a range of sbyte values - - - Generate a range of uint16 values - - - Generate a range of int16 values - - - Generate a range of unativeint values - - - Generate a range of nativeint values - - - Generate a range of uint32 values - - - Generate a range of uint64 values - - - Generate a range of int64 values - - - Generate a range of float32 values - - - Generate a range of float values - - - Generate a range of integers - - - Gets a slice from a string - The source string. - The index of the first character of the slice. - The index of the last character of the slice. - The substring from the given indices. - - - Sets a slice of an array - The target array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The start index of the fourth dimension. - The end index of the fourth dimension. - The source array. - - - Gets a slice of an array - The source array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The start index of the fourth dimension. - The end index of the fourth dimension. - The four dimensional sub array from the given indices. - - - Sets a slice of an array - The target array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The source array. - - - Gets a slice of an array - The source array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The three dimensional sub array from the given indices. - - - Sets a slice of an array - The target array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The source array. - - - Gets a slice of an array - The source array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The two dimensional sub array from the input indices. - - - Sets a slice of an array - The target array. - The start index. - The end index. - The source array. - - - Gets a slice of an array - The input array. - The start index. - The end index. - The sub array from the input indices. - - - A module of compiler intrinsic functions for efficient implementations of F# integer ranges - and dynamic invocations of other F# operators - - - Basic F# Operators. This module is automatically opened in all F# code. - - - Invoke an F# first class function value that accepts five curried arguments - without intervening execution - The first arg. - The second arg. - The third arg. - The fourth arg. - The fifth arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept five curried arguments without intervening execution. - The input function. - The optimized function. - - - Construct an optimized function value that can accept five curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept five curried arguments - without intervening execution. This type should not typically used directly from - either F# code or from other CLI languages. - - - Invoke an F# first class function value that accepts four curried arguments - without intervening execution - The first arg. - The second arg. - The third arg. - The fourth arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept four curried arguments without intervening execution. - The input function. - The optimized function. - - - Construct an optimized function value that can accept four curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept four curried arguments - without intervening execution. This type should not typically used directly from - either F# code or from other CLI languages. - - - Invoke an F# first class function value that accepts three curried arguments - without intervening execution - The first arg. - The second arg. - The third arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept three curried arguments without intervening execution. - The input function. - The adapted function. - - - Construct an optimized function value that can accept three curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept - three iterated (curried) arguments without intervening execution. This type should not - typically used directly from either F# code or from other CLI languages. - - - Invoke the optimized function value with two curried arguments - The first arg. - The second arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept two curried arguments without intervening execution. - The input function. - The adapted function. - - - Construct an optimized function value that can accept two curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept - two iterated (curried) arguments without intervening execution. This type should not - typically used directly from either F# code or from other CLI languages. - - - An implementation module used to hold some private implementations of function - value invocation. - - - Convert the option to a list of length 0 or 1. - The input option. - The result list. - - - Convert the option to an array of length 0 or 1. - The input option. - The result array. - - - bind f inp evaluates to match inp with None -> None | Some x -> f x - A function that takes the value of type T from an option and transforms it into - an option containing a value of type U. - The input option. - An option of the output type of the binder. - - - map f inp evaluates to match inp with None -> None | Some x -> Some (f x). - A function to apply to the option value. - The input option. - An option of the input value after applying the mapping function, or None if the input is None. - - - iter f inp executes match inp with None -> () | Some x -> f x. - A function to apply to the option value. - The input option. - Unit if the option is None, otherwise it returns the result of applying the predicate - to the option value. - - - forall p inp evaluates to match inp with None -> true | Some x -> p x. - A function that evaluates to a boolean when given a value from the option type. - The input option. - True if the option is None, otherwise it returns the result of applying the predicate - to the option value. - - - exists p inp evaluates to match inp with None -> false | Some x -> p x. - A function that evaluates to a boolean when given a value from the option type. - The input option. - False if the option is None, otherwise it returns the result of applying the predicate - to the option value. - - - fold f inp s evaluates to match inp with None -> s | Some x -> f x s. - A function to update the state data when given a value from an option. - The input option. - The initial state. - The original state if the option is None, otherwise it returns the updated state with the folder - and the option value. - - - fold f s inp evaluates to match inp with None -> s | Some x -> f s x. - A function to update the state data when given a value from an option. - The initial state. - The input option. - The original state if the option is None, otherwise it returns the updated state with the folder - and the option value. - - - count inp evaluates to match inp with None -> 0 | Some _ -> 1. - The input option. - A zero if the option is None, a one otherwise. - - - Gets the value associated with the option. - The input option. - The value within the option. - Thrown when the option is None. - - - Returns true if the option is None. - The input option. - True if the option is None. - - - Returns true if the option is not None. - The input option. - True if the option is not None. - - - Basic operations on options. - - - Represents a statically-analyzed format associated with writing to a System.IO.TextWriter. The type parameter indicates the - arguments and return type of the format operation. - - - Represents a statically-analyzed format when formatting builds a string. The type parameter indicates the - arguments and return type of the format operation. - - - Represents a statically-analyzed format associated with writing to a System.Text.StringBuilder. The type parameter indicates the - arguments and return type of the format operation. - - - Represents a statically-analyzed format associated with writing to a System.IO.TextWriter. The first type parameter indicates the - arguments of the format operation and the last the overall return type. - - - Represents a statically-analyzed format when formatting builds a string. The first type parameter indicates the - arguments of the format operation and the last the overall return type. - - - Represents a statically-analyzed format associated with writing to a System.Text.StringBuilder. The first type parameter indicates the - arguments of the format operation and the last the overall return type. - - - Print to a string buffer and raise an exception with the given - result. Helper printers must return strings. - The input formatter. - The arguments of the formatter. - - - sprintf, but call the given 'final' function to generate the result. - See kprintf. - The function called to generate a result from the formatted string. - The input formatter. - The arguments of the formatter. - - - printf, but call the given 'final' function to generate the result. - For example, these let the printing force a flush after all output has - been entered onto the channel, but not before. - The function called after formatting to generate the format result. - The input formatter. - The arguments of the formatter. - - - fprintf, but call the given 'final' function to generate the result. - See kprintf. - The function called after formatting to generate the format result. - The input TextWriter. - The input formatter. - The arguments of the formatter. - - - bprintf, but call the given 'final' function to generate the result. - See kprintf. - The function called after formatting to generate the format result. - The input StringBuilder. - The input formatter. - The arguments of the formatter. - - - Print to a string via an internal string buffer and return - the result as a string. Helper printers must return strings. - The input formatter. - The formatted string. - - - Formatted printing to stdout, adding a newline. - The input formatter. - The return type and arguments of the formatter. - - - Formatted printing to stdout - The input formatter. - The return type and arguments of the formatter. - - - Formatted printing to stderr, adding a newline - The input formatter. - The return type and arguments of the formatter. - - - Formatted printing to stderr - The input formatter. - The return type and arguments of the formatter. - - - Print to a text writer, adding a newline - The TextWriter to print to. - The input formatter. - The return type and arguments of the formatter. - - - Print to a text writer. - The TextWriter to print to. - The input formatter. - The return type and arguments of the formatter. - - - Print to a System.Text.StringBuilder - The StringBuilder to print to. - The input formatter. - The return type and arguments of the formatter. - - - Extensible printf-style formatting for numbers and other datatypes - - Format specifications are strings with "%" markers indicating format - placeholders. Format placeholders consist of: - - %[flags][width][.precision][type] - - where the type is interpreted as follows: - - %b: bool, formatted as "true" or "false" - %s: string, formatted as its unescaped contents - %c: character literal - %d, %i: any basic integer type formatted as a decimal integer, signed if the basic integer type is signed. - %u: any basic integer type formatted as an unsigned decimal integer - %x, %X, %o: any basic integer type formatted as an unsigned hexadecimal - (a-f)/Hexadecimal (A-F)/Octal integer - - %e, %E, %f, %F, %g, %G: - any basic floating point type (float,float32) formatted - using a C-style floating point format specifications, i.e - - %e, %E: Signed value having the form [-]d.dddde[sign]ddd where - d is a single decimal digit, dddd is one or more decimal - digits, ddd is exactly three decimal digits, and sign - is + or - - - %f: Signed value having the form [-]dddd.dddd, where dddd is one - or more decimal digits. The number of digits before the - decimal point depends on the magnitude of the number, and - the number of digits after the decimal point depends on - the requested precision. - - %g, %G: Signed value printed in f or e format, whichever is - more compact for the given value and precision. - - - %M: System.Decimal value - - %O: Any value, printed by boxing the object and using it's ToString method(s) - - %A: Any value, printed with the default layout settings - - %a: A general format specifier, requires two arguments: - (1) a function which accepts two arguments: - (a) a context parameter of the appropriate type for the - given formatting function (e.g. an #System.IO.TextWriter) - (b) a value to print - and which either outputs or returns appropriate text. - - (2) the particular value to print - - - %t: A general format specifier, requires one argument: - (1) a function which accepts a context parameter of the - appropriate type for the given formatting function (e.g. - an System.IO.TextWriter)and which either outputs or returns - appropriate text. - - Basic integer types are: - byte,sbyte,int16,uint16,int32,uint32,int64,uint64,nativeint,unativeint - Basic floating point types are: - float, float32 - - The optional width is an integer indicating the minimal width of the - result. For instance, %6d prints an integer, prefixing it with spaces - to fill at least 6 characters. If width is '*', then an extra integer - argument is taken to specify the corresponding width. - - any number - '*': - - Valid flags are: - - 0: add zeros instead of spaces to make up the required width - '-': left justify the result within the width specified - '+': add a '+' character if the number is positive (to match a '-' sign - for negatives) - ' ': add an extra space if the number is positive (to match a '-' - sign for negatives) - - The printf '#' flag is invalid and a compile-time error will be reported if it is used. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Returns the length of the string. - The input string. - The number of characters in the string. - Thrown when the input string is null. - - - Returns a string by concatenating count instances of str. - The number of copies of the input string will be copied. - The input string. - The concatenated string. - Thrown when the input string is null. - - - Tests if any character of the string satisfies the given predicate. - The function to test each character of the string. - The input string. - True if any character returns true for the predicate and false otherwise. - Thrown when the input string is null. - - - Tests if all characters in the string satisfy the given predicate. - The function to test each character of the string. - The input string. - True if all characters return true for the predicate and false otherwise. - Thrown when the input string is null. - - - Builds a new string whose characters are the results of applying the function mapping - to each index from 0 to count-1 and concatenating the resulting - strings. - The number of strings to initialize. - The function to take an index and produce a string to - be concatenated with the others. - The constructed string. - Thrown when count is negative. - - - Builds a new string whose characters are the results of applying the function mapping - to each of the characters of the input string and concatenating the resulting - strings. - The function to produce a string from each character of the input string. - The input string. - The concatenated string. - Thrown when the input string is null. - - - Builds a new string whose characters are the results of applying the function mapping - to each character and index of the input string. - The function to apply to each character and index of the string. - The input string. - The resulting string. - Thrown when the input string is null. - - - Builds a new string whose characters are the results of applying the function mapping - to each of the characters of the input string. - The function to apply to the characters of the string. - The input string. - The resulting string. - Thrown when the input string is null. - - - Applies the function action to the index of each character in the string and the - character itself. - The function to apply to each character and index of the string. - The input string. - Thrown when the input string is null. - - - Applies the function action to each character in the string. - The function to be applied to each character of the string. - The input string. - Thrown when the input string is null. - - - Returns a new string made by concatenating the given strings - with separator sep, that is a1 + sep + ... + sep + aN. - The separator string to be inserted between the strings - of the input sequence. - The sequence of strings to be concatenated. - A new string consisting of the concatenated strings separated by - the separation string. - Thrown when strings is null. - - - Functional programming operators for string processing. Further string operations - are available via the member functions on strings and other functionality in - System.String - and System.Text.RegularExpressions types. - - - - The SI unit of catalytic activity - - - - - The SI unit of does equivalent - - - - - The SI unit of absorbed dose - - - - - The SI unit of activity referred to a radionuclide - - - - - The SI unit of illuminance - - - - - The SI unit of luminous flux - - - - - The SI unit of inductance - - - - - The SI unit of magnetic flux density - - - - - The SI unit of magnetic flux - - - - - The SI unit of electric conductance - - - - - The SI unit of electric resistance - - - - - The SI unit of capacitance - - - - - The SI unit of electric potential difference, electromotive force - - - - - The SI unit of electric charge, amount of electricity - - - - - The SI unit of power, radiant flux - - - - - The SI unit of energy, work, amount of heat - - - - - The SI unit of pressure, stress - - - - - The SI unit of force - - - - - The SI unit of frequency - - - - - The SI unit of luminous intensity - - - - - The SI unit of amount of substance - - - - - The SI unit of thermodynamic temperature - - - - - The SI unit of electric current - - - - - The SI unit of time - - - - - The SI unit of mass - - - - - The SI unit of length - - - - - The SI unit of length - - - - - A synonym for henry, the SI unit of inductance - - - - - A synonym for katal, the SI unit of catalytic activity - - - - - A synonym for sievert, the SI unit of does equivalent - - - - - A synonym for gray, the SI unit of absorbed dose - - - - - A synonym for becquerel, the SI unit of activity referred to a radionuclide - - - - - A synonym for lux, the SI unit of illuminance - - - - - A synonym for lumen, the SI unit of luminous flux - - - - - A synonym for tesla, the SI unit of magnetic flux density - - - - - A synonym for weber, the SI unit of magnetic flux - - - - - A synonym for UnitNames.ohm, the SI unit of electric resistance. - - - - - A synonym for siemens, the SI unit of electric conductance - - - - - A synonym for farad, the SI unit of capacitance - - - - - A synonym for volt, the SI unit of electric potential difference, electromotive force - - - - - A synonym for coulomb, the SI unit of electric charge, amount of electricity - - - - - A synonym for watt, the SI unit of power, radiant flux - - - - - A synonym for joule, the SI unit of energy, work, amount of heat - - - - - A synonym for pascal, the SI unit of pressure, stress - - - - - A synonym for newton, the SI unit of force - - - - - A synonym for hertz, the SI unit of frequency - - - - - A synonym for candela, the SI unit of luminous intensity - - - - - A synonym for mole, the SI unit of amount of substance - - - - - A synonym for kelvin, the SI unit of thermodynamic temperature - - - - - A synonym for ampere, the SI unit of electric current - - - - - A synonym for second, the SI unit of time - - - - - A synonym for kilogram, the SI unit of mass - - - - - A synonym for Metre, the SI unit of length - - - - - Abstract internal type - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Allocates a region of memory on the stack. - The number of objects of type T to allocate. - A typed pointer to the allocated memory. - - - Assigns the value into the memory location referenced by the typed native - pointer computed by adding index * sizeof<'T> to the given input pointer. - The input pointer. - The index by which to offset the pointer. - The value to assign. - - - Assigns the value into the memory location referenced by the given typed native pointer. - The input pointer. - The value to assign. - - - Dereferences the given typed native pointer. - The input pointer. - The value at the pointer address. - - - Dereferences the typed native pointer computed by adding index * sizeof<'T> to the - given input pointer. - The input pointer. - The index by which to offset the pointer. - The value at the pointer address. - - - Returns a typed native pointer by adding index * sizeof<'T> to the - given input pointer. - The input pointer. - The index by which to offset the pointer. - A typed pointer. - - - Returns a machine address for a given typed native pointer. - The input pointer. - The machine address. - - - Returns a typed native pointer for a given machine address. - The pointer address. - A typed pointer. - - - Contains operations on native pointers. Use of these operators may - result in the generation of unverifiable code. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Gets the raw expression associated with this type-carrying expression - - - Type-carrying quoted expressions. Expressions are generated either - by quotations in source text or programatically - - - Returns type of an expression. - - - Returns the custom attributes of an expression. - - - Builds an expression that represents a while loop - The predicate to control the loop iteration. - The body of the while loop. - The resulting expression. - - - Builds an expression that represents setting a mutable variable - The input variable. - The value to set. - The resulting expression. - - - Builds an expression that represents a variable - The input variable. - The resulting expression. - - - Builds an expression that represents a constant value - The typed value. - The resulting expression. - - - Builds an expression that represents a constant value of a particular type - The untyped object. - The type of the object. - The resulting expression. - - - Builds an expression that represents a test of a value is of a particular union case - The expression to test. - The description of the union case. - The resulting expression. - - - Builds an expression that represents a type test. - The expression to test. - The target type. - The resulting expression. - - - Builds an expression that represents getting a field of a tuple - The input tuple. - The index of the tuple element to get. - The resulting expression. - - - Builds an expression that represents a try/with construct for exception filtering and catching. - The body of the try expression. - - - The variable to bind to a caught exception. - The expression evaluated when an exception is caught. - The resulting expression. - - - Try and find a stored reflection definition for the given method. Stored reflection - definitions are added to an F# assembly through the use of the [<ReflectedDefinition>] attribute. - The description of the method to find. - The reflection definition or None if a match could not be found. - - - Builds an expression that represents a try/finally construct - The body of the try expression. - The final part of the expression to be evaluated. - The resulting expression. - - - Format the expression as a string - Indicates if method, property, constructor and type objects should be printed in detail. If false, these are abbreviated to their name. - The formatted string. - - - Substitutes through the given expression using the given functions - to map variables to new values. The functions must give consistent results - at each application. Variable renaming may occur on the target expression - if variable capture occurs. - The function to map variables into expressions. - The expression with the given substitutions. - - - Builds an expression that represents the sequential execution of one expression followed by another - The first expression. - The second expression. - The resulting expression. - - - Permits interactive environments such as F# Interactive - to explicitly register new pickled resources that represent persisted - top level definitions. The string indicates a unique name for the resources - being added. The format for the bytes is the encoding generated by the F# compiler. - The assembly associated with the resource. - The unique name for the resources being added. - The serialized resource to register with the environment. - - - Builds an expression that represents a nested quotation literal - The expression being quoted. - The resulting expression. - - - Builds an expression that represents writing to a static property - The description of the property. - The value to set. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents writing to a property of an object - The input object. - The description of the property. - The value to set. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents reading a static property - The description of the property. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents reading a property of an object - The input object. - The description of the property. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents the creation of a union case value - The description of the union case. - The list of arguments for the case. - The resulting expression. - - - Builds an expression that represents the creation of an F# tuple value - The list of elements of the tuple. - The resulting expression. - - - Builds record-construction expressions - The type of record. - The list of elements of the record. - The resulting expression. - - - Builds an expression that represents the invocation of an object constructor - The description of the constructor. - The list of arguments to the constructor. - The resulting expression. - - - Builds an expression that represents the creation of a delegate value for the given type - The type of delegate. - The parameters for the delegate. - The body of the function. - The resulting expression. - - - Builds an expression that represents the creation of an array value initialized with the given elements - The type for the elements of the array. - The list of elements of the array. - The resulting expression. - - - Builds recursives expressions associated with 'let rec' constructs - The list of bindings for the let expression. - The sub-expression where the bindings are in scope. - The resulting expression. - - - Builds expressions associated with 'let' constructs - The variable in the let expression. - The expression bound to the variable. - The sub-expression where the binding is in scope. - The resulting expression. - - - Builds an expression that represents the constrution of an F# function value - The parameter to the function. - The body of the function. - The resulting expression. - - - Builds 'if ... then ... else' expressions. - The condition expression. - The then sub-expression. - The else sub-expression. - The resulting expression. - - - Fetches or creates a new variable with the given name and type from a global pool of shared variables - indexed by name and type. The type is given by the expicit or inferred type parameter - The variable name. - The created of fetched typed global variable. - - - Gets the free expression variables of an expression as a list. - A sequence of the free variables in the expression. - - - Builds a 'for i = ... to ... do ...' expression that represent loops over integer ranges - The sub-expression declaring the loop variable. - The sub-expression setting the initial value of the loop variable. - The sub-expression declaring the final value of the loop variable. - The sub-expression representing the body of the loop. - The resulting expression. - - - Builds an expression that represents writing to a field of an object - The input object. - The description of the field to write to. - The value to set to the field. - The resulting expression. - - - Builds an expression that represents writing to a static field - The description of the field to write to. - The value to the set to the field. - The resulting expression. - - - Builds an expression that represents the access of a field of an object - The input object. - The description of the field to access. - The resulting expression. - - - Builds an expression that represents the access of a static field - The description of the field to access. - The resulting expression. - - - - - - This function is called automatically when quotation syntax (<@ @>) and related typed-expression - quotations are used. The bytes are a pickled binary representation of an unlinked form of the quoted expression, - and the System.Type argument is any type in the assembly where the quoted - expression occurs, i.e. it helps scope the interpretation of the cross-assembly - references in the bytes. - A type in the assembly where the quotation occurs. - The list of spliced types. - The list of spliced expressions. - The serialized form of the quoted expression. - The resulting expression. - - - Builds an expression that represents the invocation of a default object constructor - The type on which the constructor is invoked. - The resulting expression. - - - Builds an expression that represents the coercion of an expression to a type - The expression to coerce. - The target type. - The resulting expression. - - - Returns a new typed expression given an underlying runtime-typed expression. - A type annotation is usually required to use this function, and - using an incorrect type annotation may result in a later runtime exception. - The expression to cast. - The resulting typed expression. - - - Builds an expression that represents a call to an instance method associated with an object - The input object. - The description of the method to call. - The list of arguments to the method. - The resulting expression. - - - Builds an expression that represents a call to an static method or module-bound function - The MethodInfo describing the method to call. - The list of arguments to the method. - The resulting expression. - - - Builds an expression that represents the application of a first class function value to multiple arguments - The function to apply. - The list of lists of arguments to the function. - The resulting expression. - - - Builds an expression that represents the application of a first class function value to a single argument. - The function to apply. - The argument to the function. - The resulting expression. - - - Builds an expression that represents setting the value held at a particular address. - The target expression. - The value to set at the address. - The resulting expression. - - - Builds an expression that represents getting the address of a value. - The target expression. - The resulting expression. - - - Quoted expressions annotated with System.Type values. - - - The type associated with the variable - - - The declared name of the variable - - - Indicates if the variable represents a mutable storage location - - - Fetches or create a new variable with the given name and type from a global pool of shared variables - indexed by name and type - The name of the variable. - The type associated with the variable. - The retrieved or created variable. - - - Creates a new variable with the given name, type and mutability - The declared name of the variable. - The type associated with the variable. - Indicates if the variable represents a mutable storage location. Default is false. - The created variable. - - - Information at the binding site of a variable - - - Re-build combination expressions. The first parameter should be an object - returned by the ShapeCombination case of the active pattern in this module. - The input shape. - The list of arguments. - The rebuilt expression. - - - An active pattern that performs a complete decomposition viewing the expression tree as a binding structure - The input expression. - The decomposed Var, Lambda, or ConstApp. - - - Active patterns for traversing, visiting, rebuilding and tranforming expressions in a generic way - - - An active pattern to recognize property setters that have an associated ReflectedDefinition - The description of the property. - The expression of the method definition if found, or None. - - - An active pattern to recognize property getters or values in modules that have an associated ReflectedDefinition - The description of the property. - The expression of the method definition if found, or None. - - - An active pattern to recognize methods that have an associated ReflectedDefinition - The description of the method. - The expression of the method definition if found, or None. - - - A parameterized active pattern to recognize calls to a specified function or method. - The returned elements are the optional target object (present if the target is an - instance method), the generic type instantation (non-empty if the target is a generic - instantiation), and the arguments to the function or method. - The input template expression to specify the method to call. - The optional target object (present if the target is an - instance method), the generic type instantation (non-empty if the target is a generic - instantiation), and the arguments to the function or method. - - - An active pattern to recognize constant unsigned int64 expressions - The input expression to match against. - uint64 option - - - An active pattern to recognize constant int64 expressions - The input expression to match against. - int64 option - - - An active pattern to recognize constant unsigned int32 expressions - The input expression to match against. - uint32 option - - - An active pattern to recognize constant int32 expressions - The input expression to match against. - int32 option - - - An active pattern to recognize constant unsigned int16 expressions - The input expression to match against. - uint16 option - - - An active pattern to recognize constant int16 expressions - The input expression to match against. - int16 option - - - An active pattern to recognize constant byte expressions - The input expression to match against. - byte option - - - An active pattern to recognize constant signed byte expressions - The input expression to match against. - sbyte option - - - An active pattern to recognize constant unicode character expressions - The input expression to match against. - char option - - - An active pattern to recognize constant 64-bit floating point number expressions - The input expression to match against. - float option - - - An active pattern to recognize constant 32-bit floating point number expressions - The input expression to match against. - float32 option - - - An active pattern to recognize constant string expressions - The input expression to match against. - string option - - - An active pattern to recognize constant boolean expressions - The input expression to match against. - bool option - - - An active pattern to recognize () constant expressions - The input expression to match against. - unit option - - - An active pattern to recognize expressions of the form a || b - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions of the form a && b - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent the application of a (possibly curried or tupled) first class function value - The input expression to match against. - (Expr * Expr list list) option - - - An active pattern to recognize expressions that represent a (possibly curried or tupled) first class function value - The input expression to match against. - (Var list list * Expr) option - - - Contains a set of derived F# active patterns to analyze F# expression objects - - - An active pattern to recognize expressions that represent setting a mutable variable - The input expression to match against. - (Var * Expr) option - - - An active pattern to recognize expressions that represent a variable - The input expression to match against. - Var option - - - An active pattern to recognize expressions that represent a constant value - The input expression to match against. - (obj * Type) option - - - An active pattern to recognize expressions that represent a test if a value is of a particular union case - The input expression to match against. - (Expr * UnionCaseInfo) option - - - An active pattern to recognize expressions that represent a dynamic type test - The input expression to match against. - (Expr * Type) option - - - An active pattern to recognize expressions that represent getting a tuple field - The input expression to match against. - (Expr * int) option - - - An active pattern to recognize expressions that represent a try/finally construct - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent a try/with construct for exception filtering and catching - The input expression to match against. - (Expr * Var * Expr * Var * Expr) option - - - An active pattern to recognize expressions that represent sequential exeuction of one expression followed by another - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent a nested quotation literal - The input expression to match against. - Expr option - - - An active pattern to recognize expressions that represent setting a static or instance property, or a non-function value declared in a module - The input expression to match against. - (Expr option * PropertyInfo * Expr list * Expr) option - - - An active pattern to recognize expressions that represent the read of a static or instance property, or a non-function value declared in a module - The input expression to match against. - (Expr option * PropertyInfo * Expr list) option - - - An active pattern to recognize expressions that represent construction of tuple values - The input expression to match against. - (Expr list) option - - - An active pattern to recognize expressions that represent construction of particular union case values - The input expression to match against. - (UnionCaseInfo * Expr list) option - - - An active pattern to recognize expressions that represent construction of record values - The input expression to match against. - (Type * Expr list) option - - - An active pattern to recognize expressions that represent invocation of object constructors - The input expression to match against. - (ConstructorInfo * Expr list) option - - - An active pattern to recognize expressions that represent construction of delegate values - The input expression to match against. - (Type * Var list * Expr) option - - - An active pattern to recognize expressions that represent invocations of a default constructor of a struct - The input expression to match against. - Type option - - - An active pattern to recognize expressions that represent the construction of arrays - The input expression to match against. - (Type * Expr list) option - - - An active pattern to recognize expressions that represent recursive let bindings of one or more variables - The input expression to match against. - ((Var * Expr) list * Expr) option - - - An active pattern to recognize expressions that represent let bindings - The input expression to match against. - (Var * Expr * Expr) option - - - An active pattern to recognize expressions that represent first class function values - The input expression to match against. - (Var * Expr) option - - - An active pattern to recognize expressions that represent conditionals - The input expression to match against. - (Expr * Expr * Expr) option - - - An active pattern to recognize expressions that represent while loops - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent loops over integer ranges - The input expression to match against. - (Var * Expr * Expr * Expr) option - - - An active pattern to recognize expressions that represent setting a static or instance field - The input expression to match against. - (Expr option * FieldInfo * Expr) option - - - An active pattern to recognize expressions that represent getting a static or instance field - The input expression to match against. - (Expr option * FieldInfo) option - - - An active pattern to recognize expressions that represent coercions from one type to another - The input expression to match against. - (Expr * Type) option - - - An active pattern to recognize expressions that represent calls to static and instance methods, and functions defined in modules - The input expression to match against. - (Expr option * MethodInfo * Expr list) option - - - An active pattern to recognize expressions that represent applications of first class function values - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent setting the value held at an address - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent getting the address of a value - The input expression to match against. - Expr option - - - Contains a set of primitive F# active patterns to analyze F# expression objects - - - Returns a System.Type representing an F# tuple type with the given element types - An array of types for the tuple elements. - The type representing the tuple containing the input elements. - - - Returns a System.Type representing the F# function type with the given domain and range - The input type of the function. - The output type of the function. - The function type with the given domain and range. - - - Returns true if the typ is a representation of an F# union type or the runtime type of a value of that type - The type to check. - Optional binding flags. - True if the type check succeeds. - - - Return true if the typ is a representation of an F# tuple type - The type to check. - True if the type check succeeds. - - - Return true if the typ is a representation of an F# record type - The type to check. - Optional binding flags. - True if the type check succeeds. - - - Return true if the typ is a System.Type value corresponding to the compiled form of an F# module - The type to check. - True if the type check succeeds. - - - Return true if the typ is a representation of an F# function type or the runtime type of a closure implementing an F# function type - The type to check. - True if the type check succeeds. - - - Returns true if the typ is a representation of an F# exception declaration - The type to check. - Optional binding flags. - True if the type check is an F# exception. - - - Gets the cases of a union type. - - Assumes the given type is a union type. If not, ArgumentException is raised during pre-computation. - The input union type. - Optional binding flags. - Thrown when the input type is not a union type. - An array of descriptions of the cases of the given union type. - - - Gets the tuple elements from the representation of an F# tuple type. - The input tuple type. - An array of the types contained in the given tuple type. - - - Reads all the fields from a record value, in declaration order - - Assumes the given input is a record value. If not, ArgumentException is raised. - The input record type. - Optional binding flags. - An array of descriptions of the properties of the record type. - - - Gets the domain and range types from an F# function type or from the runtime type of a closure implementing an F# type - The input function type. - A tuple of the domain and range types of the input function. - - - Reads all the fields from an F# exception declaration, in declaration order - - Assumes exceptionType is an exception representation type. If not, ArgumentException is raised. - The exception type to read. - Optional binding flags. - Thrown if the given type is not an exception. - An array containing the PropertyInfo of each field in the exception. - - - Contains operations associated with constructing and analyzing F# types such as records, unions and tuples - - - Assumes the given type is a union type. - If not, ArgumentException is raised during pre-computation. - - Using the computed function is more efficient than calling GetUnionCase - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The type of union to optimize reading. - Optional binding flags. - An optimized function to read the tags of the given union type. - - - Precompute a property or static method for reading an integer representing the case tag of a union type. - The type of union to read. - Optional binding flags. - The description of the union case reader. - - - Precomputes a function for reading all the fields for a particular discriminator case of a union type - - Using the computed function will typically be faster than executing a corresponding call to GetFields - The description of the union case to read. - Optional binding flags. - A function to for reading the fields of the given union case. - - - A method that constructs objects of the given case - The description of the union case. - Optional binding flags. - The description of the constructor of the given union case. - - - Precomputes a function for constructing a discriminated union value for a particular union case. - The description of the union case. - Optional binding flags. - A function for constructing values of the given union case. - - - Precomputes a function for reading the values of a particular tuple type - - Assumes the given type is a TupleType. - If not, ArgumentException is raised during pre-computation. - The tuple type to read. - Thrown when the given type is not a tuple type. - A function to read values of the given tuple type. - - - Gets information that indicates how to read a field of a tuple - The input tuple type. - The index of the tuple element to describe. - The description of the tuple element and an optional type and index if the tuple is big. - - - Gets a method that constructs objects of the given tuple type. - For small tuples, no additional type will be returned. - - For large tuples, an additional type is returned indicating that - a nested encoding has been used for the tuple type. In this case - the suffix portion of the tuple type has the given type and an - object of this type must be created and passed as the last argument - to the ConstructorInfo. A recursive call to PreComputeTupleConstructorInfo - can be used to determine the constructor for that the suffix type. - The input tuple type. - The description of the tuple type constructor and an optional extra type - for large tuples. - - - Precomputes a function for reading the values of a particular tuple type - - Assumes the given type is a TupleType. - If not, ArgumentException is raised during pre-computation. - The type of tuple to read. - Thrown when the given type is not a tuple type. - A function to read a particular tuple type. - - - Precompute a function for reading all the fields from a record. The fields are returned in the - same order as the fields reported by a call to Microsoft.FSharp.Reflection.Type.GetInfo for - this type. - - Assumes the given type is a RecordType. - If not, ArgumentException is raised during pre-computation. - - Using the computed function will typically be faster than executing a corresponding call to Value.GetInfo - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The type of record to read. - Optional binding flags. - Thrown when the input type is not a record type. - An optimized reader for the given record type. - - - Precompute a function for reading a particular field from a record. - Assumes the given type is a RecordType with a field of the given name. - If not, ArgumentException is raised during pre-computation. - - Using the computed function will typically be faster than executing a corresponding call to Value.GetInfo - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The PropertyInfo of the field to read. - Thrown when the input type is not a record type. - A function to read the specified field from the record. - - - Get a ConstructorInfo for a record type - The record type. - Optional binding flags. - A ConstructorInfo for the given record type. - - - Precompute a function for constructing a record value. - - Assumes the given type is a RecordType. - If not, ArgumentException is raised during pre-computation. - The type of record to construct. - Optional binding flags. - Thrown when the input type is not a record type. - A function to construct records of the given type. - - - Create a union case value. - The description of the union case to create. - The array of arguments to construct the given case. - Optional binding flags. - The constructed union case. - - - Creates an instance of a tuple type - - Assumes at least one element is given. If not, ArgumentException is raised. - The array of tuple fields. - The tuple type to create. - Thrown if no elements are given. - An instance of the tuple type with the given elements. - - - Creates an instance of a record type. - - Assumes the given input is a record type. - The type of record to make. - The array of values to initialize the record. - Optional binding flags for the record. - Thrown when the input type is not a record type. - The created record. - - - Builds a typed function from object from a dynamic function implementation - The function type of the implementation. - The untyped lambda of the function implementation. - A typed function from the given dynamic implementation. - - - Identify the union case and its fields for an object - - Assumes the given input is a union case value. If not, ArgumentException is raised. - - If the type is not given, then the runtime type of the input object is used to identify the - relevant union type. The type should always be given if the input object may be null. For example, - option values may be represented using the 'null'. - The input union case. - The union type containing the value. - Optional binding flags. - Thrown when the input type is not a union case value. - The description of the union case and its fields. - - - Reads all fields from a tuple. - - Assumes the given input is a tuple value. If not, ArgumentException is raised. - The input tuple. - Thrown when the input is not a tuple value. - An array of the fields from the given tuple. - - - Reads a field from a tuple value. - - Assumes the given input is a tuple value. If not, ArgumentException is raised. - The input tuple. - The index of the field to read. - The value of the field. - - - Reads all the fields from a record value. - - Assumes the given input is a record value. If not, ArgumentException is raised. - The record object. - Optional binding flags for the record. - Thrown when the input type is not a record type. - The array of fields from the record. - - - Reads a field from a record value. - - Assumes the given input is a record value. If not, ArgumentException is raised. - The record object. - The PropertyInfo describing the field to read. - Thrown when the input type is not a record type. - The field from the record. - - - Reads all the fields from a value built using an instance of an F# exception declaration - - Assumes the given input is an F# exception value. If not, ArgumentException is raised. - The exception instance. - Optional binding flags. - Thrown when the input type is not an F# exception. - The fields from the given exception. - - - Contains operations associated with constructing and analyzing values associated with F# types - such as records, unions and tuples. - - - The integer tag for the case. - - - The name of the case. - - - The type in which the case occurs. - - - The fields associated with the case, represented by a PropertyInfo. - The fields associated with the case. - - - Returns the custom attributes associated with the case matching the given attribute type. - The type of attributes to return. - An array of custom attributes. - - - Returns the custom attributes associated with the case. - An array of custom attributes. - - - Represents a case of a discriminated union type - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A record of options to control structural formatting. - For F# Interactive properties matching those of this value can be accessed via the 'fsi' - value. - - Floating Point format given in the same format accepted by System.Double.ToString, - e.g. f6 or g15. - - If ShowProperties is set the printing process will evaluate properties of the values being - displayed. This may cause additional computation. - - The ShowIEnumerable is set the printing process will force the evalution of IEnumerable objects - to a small, finite depth, as determined by the printing parameters. - This may lead to additional computation being performed during printing. - - <example> - From F# Interactive the default settings can be adjusted using, for example, - <pre> - open Microsoft.FSharp.Compiler.Interactive.Settings;; - setPrintWidth 120;; - </pre> - </example> - - - - - Data representing structured layouts of terms. - - - - - Convert any value to a layout using the given formatting options. The - layout can then be processed using formatting display engines such as - those in the LayoutOps module. any_to_string and output_any are - built using any_to_layout with default format options. - - - - - - - - Ouput any value to a channel using the same set of formatting rules - as any_to_string - - - - - Convert any value to a string using a standard formatter - Data is typically formatted in a structured format, e.g. - lists are formatted using the "[1;2]" notation. - The details of the format are not specified and may change - from version to version and according to the flags given - to the F# compiler. The format is intended to be human-readable, - not machine readable. If alternative generic formats are required - you should develop your own formatter, using the code in the - implementation of this file as a starting point. - - Data from other .NET languages is formatted using a virtual - call to Object.ToString() on the boxed version of the input. - - - - - - - - For limitting layout of list-like sequences (lists,arrays,etc). - unfold a list of items using (project and z) making layout list via itemL. - If reach maxLength (before exhausting) then truncate. - - - - - See tagL - - - - - Layout like an F# list. - - - - - Layout like an F# option. - - - - - Layout list vertically. - - - - - Layout two vertically. - - - - - Form tuple of layouts. - - - - - Wrap braces around layout. - - - - - Wrap square brackets around layout. - - - - - Wrap round brackets around Layout. - - - - - Join layouts into a list separated using the given Layout. - - - - - Join layouts into a semi-colon separated list. - - - - - Join layouts into a space separated list. - - - - - Join layouts into a comma separated list. - - - - - Join broken with ident=2 - - - - - Join broken with ident=1 - - - - - Join broken with ident=0 - - - - - Join, possible break with indent=2 - - - - - Join, possible break with indent=1 - - - - - Join, possible break with indent=0 - - - - - Join, unbreakable. - - - - - An string which is left parenthesis (no space on the right). - - - - - An string which is right parenthesis (no space on the left). - - - - - An string which requires no spaces either side. - - - - - An string leaf - - - - - An uninterpreted leaf, to be interpreted into a string - by the layout engine. This allows leaf layouts for numbers, strings and - other atoms to be customized according to culture. - - - - - Is it the empty layout? - - - - - The empty layout - - - - - A layout is a sequence of strings which have been joined together. - The strings are classified as words, separators and left and right parenthesis. - This classification determines where spaces are inserted. - A joint is either unbreakable, breakable or broken. - If a joint is broken the RHS layout occurs on the next line with optional indentation. - A layout can be squashed to for given width which forces breaks as required. - - - - Gets a read-only collection of the Exception instances that caused - the current exception. - - - Represents one or more errors that occur during application execution. - - - Subscribe an observer to the source of results - The observer to be added to those that are notified. - An IDisposable to allow for unsubscription. - - - A source of observable results - - - Notify an observer of a new result - The value to notify observers. - - - Notify an observer of an error - The exception to notify observers. - - - Notify an observer that no more results will be produced. - - - A client that may be subscribed to observe the results from an IObservable. - - - The value contained in the Lazy. - - - Is true if the value is ready to be accessed. - - - Encapsulates a lazily computed value. - - - - - - - - - Compiled versions of F# tuple types. These are not used directly, though - these compiled forms are seen by other CLI languages. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Determines whether the current object precedes, occurs in the same position as, - or follows another object in the sort order. - The object to compare with the current instance. - An object that performs comparisons. - An integer that indicates the relationship of the current object to the target object. - - - - - - Returns a hash code for the current instance. - An object that computes the hash code of the current object. - The hash code for the current instance. - - - Equality comparison against a target object with a given comparer. - The target for comparison. - Compares the two objects. - The result of the comparer. - - - - - - - Return the given big integer - - - - - Return the negation of a big integer - - - - - Return the difference of two big integers - - - - - Return the product of big integers - - - - - Return the modulus of big integers - - - - - This operator is for consistency when this type be used from other CLI languages - - - - - This operator is for consistency when this type be used from other CLI languages - - - - - This operator is for consistency when this type be used from other CLI languages - - - - - This operator is for consistency when this type be used from other CLI languages - - - - - This operator is for consistency when this type be used from other CLI languages - - - - - Convert a big integer to a 32-bit signed integer - - - - - Convert a big integer to a 64-bit signed integer - - - - - Convert a big integer to a floating point number - - - - - This operator is for consistency when this type be used from other CLI languages - - - - - Return the ratio of two big integers - - - - - Return the sum of two big integers - - - - - Get the big integer for zero - - - - - Return the sign of a big integer: 0, +1 or -1 - - - - - Get the big integer for one - - - - - Return true if a big integer is 'zero' - - - - - Return true if a big integer is 'one' - - - - - - - - Return n^m for two big integers - - - - - Parse a big integer from a string format - - - - - Return the greatest common divisor of two big integers - - - - - - - - - - - Compute the ratio and remainder of two big integers - - - - - Compute the absolute value of a big integer - - - - - Construct a BigInteger value for the given 64-bit integer - - - - - Construct a BigInteger value for the given integer - - - - - The type of arbitrary-sized integers - - - - Fetches the token representing the capability to detect cancellation of an operation. - - - Discards resources associated with this capability. - - - Creates a cancellation capability linking two tokens. - The first input token. - The second input token. - The created CancellationTokenSource. - - - Cancels the operation. - - - Creates a new cancellation capability. - - - Signals to a CancellationToken that it should be cancelled. - - - - - - Inequality operator for tokens. - The first input token. - The second input token. - False if the two tokens are equal. - - - Equality operator for tokens. - The first input token. - The second input token. - True if the two tokens are equal. - - - Flags whether an operation should be cancelled. - - - Registers an action to perform with the CancellationToken. - The action to associate with the token. - The state associated with the action. - The created registration object. - - - Equality comparison against another token. - The target for comparison. - True if the two tokens are equal. - - - Represents a capability to detect cancellation of an operation. - - - - - - - - - Inequality operator for registrations. - The first input registration. - The second input registration. - False if the two registrations are equal. - - - Equality operator for registrations. - The first input registration. - The second input registration. - True if the two registrations are equal. - - - Equality comparison against another registration. - The target for comparison. - True if the two registrations are equal. - - - Frees resources associated with the registration. - - - Represents a registration to a Cancellation token source. - - - diff --git a/packages/FSharp.Core.4.0.0.1/lib/net40/FSharp.Core.dll b/packages/FSharp.Core.4.0.0.1/lib/net40/FSharp.Core.dll deleted file mode 100644 index ae969ce..0000000 Binary files a/packages/FSharp.Core.4.0.0.1/lib/net40/FSharp.Core.dll and /dev/null differ diff --git a/packages/FSharp.Core.4.0.0.1/lib/net40/FSharp.Core.optdata b/packages/FSharp.Core.4.0.0.1/lib/net40/FSharp.Core.optdata deleted file mode 100644 index 61f4802..0000000 Binary files a/packages/FSharp.Core.4.0.0.1/lib/net40/FSharp.Core.optdata and /dev/null differ diff --git a/packages/FSharp.Core.4.0.0.1/lib/net40/FSharp.Core.sigdata b/packages/FSharp.Core.4.0.0.1/lib/net40/FSharp.Core.sigdata deleted file mode 100644 index 33f7be9..0000000 Binary files a/packages/FSharp.Core.4.0.0.1/lib/net40/FSharp.Core.sigdata and /dev/null differ diff --git a/packages/FSharp.Core.4.0.0.1/lib/net40/FSharp.Core.xml b/packages/FSharp.Core.4.0.0.1/lib/net40/FSharp.Core.xml deleted file mode 100644 index 2482a25..0000000 --- a/packages/FSharp.Core.4.0.0.1/lib/net40/FSharp.Core.xml +++ /dev/null @@ -1,11118 +0,0 @@ - - -FSharp.Core - - - Gets the tail of the list, which is a list containing all the elements of the list, excluding the first element - - - Gets the number of items contained in the list - - - Gets the element of the list at the given position. - Lists are represented as linked lists so this is an O(n) operation. - The index. - The value at the given index. - - - Gets a value indicating if the list contains no entries - - - Gets the first element of the list - - - Returns an empty list of a particular type - - - Gets a slice of the list, the elements of the list from the given start index to the given end index. - The start index. - The end index. - The sub list specified by the input indices. - - - Returns a list with head as its first element and tail as its subsequent elements - A new head value for the list. - The existing list. - The list with head appended to the front of tail. - - - The type of immutable singly-linked lists. - - Use the constructors [] and :: (infix) to create values of this type, or - the notation [1;2;3]. Use the values in the List module to manipulate - values of this type, or pattern match against the values directly. - - - Lookup an element in the map. Raise KeyNotFoundException if no binding - exists in the map. - The input key. - Thrown when the key is not found. - The value mapped to the key. - - - Returns true if there are no bindings in the map. - - - The number of bindings in the map. - - - Lookup an element in the map, returning a Some value if the element is in the domain - of the map and None if not. - The input key. - The mapped value, or None if the key is not in the map. - - - Removes an element from the domain of the map. No exception is raised if the element is not present. - The input key. - The resulting map. - - - Tests if an element is in the domain of the map. - The input key. - True if the map contains the given key. - - - Returns a new map with the binding added to the given map. - The input key. - The resulting map. - - - Builds a map that contains the bindings of the given IEnumerable. - The input sequence of key/value pairs. - The resulting map. - - - Immutable maps. Keys are ordered by F# generic comparison. - - Maps based on generic comparison are efficient for small keys. They are not a suitable choice if keys are recursive data structures - or if keys require bespoke comparison semantics. - - All members of this class are thread-safe and may be used concurrently from multiple threads. - - - An abbreviation for the CLI type System.Collections.Generic.List<_> - - - Returns a new set with the elements of the second set removed from the first. - The first input set. - The second input set. - A set containing elements of the first set that are not contained in the second set. - - - Compute the union of the two sets. - The first input set. - The second input set. - The union of the two input sets. - - - Returns the lowest element in the set according to the ordering being used for the set. - - - Returns the highest element in the set according to the ordering being used for the set. - - - A useful shortcut for Set.isEmpty. See the Set module for further operations on sets. - - - The number of elements in the set - - - A useful shortcut for Set.remove. Note this operation produces a new set - and does not mutate the original set. The new set will share many storage - nodes with the original. See the Set module for further operations on sets. - The value to remove from the set. - The result set. - - - Evaluates to "true" if all elements of the second set are in the first. - The set to test against. - True if this set is a superset of otherSet. - - - Evaluates to "true" if all elements of the first set are in the second. - The set to test against. - True if this set is a subset of otherSet. - - - Evaluates to "true" if all elements of the second set are in the first, and at least - one element of the first is not in the second. - The set to test against. - True if this set is a proper superset of otherSet. - - - Evaluates to "true" if all elements of the first set are in the second, and at least - one element of the second is not in the first. - The set to test against. - True if this set is a proper subset of otherSet. - - - A useful shortcut for Set.contains. See the Set module for further operations on sets. - The value to check. - True if the set contains value. - - - A useful shortcut for Set.add. Note this operation produces a new set - and does not mutate the original set. The new set will share many storage - nodes with the original. See the Set module for further operations on sets. - The value to add to the set. - The result set. - - - Create a set containing elements drawn from the given sequence. - The input sequence. - The result set. - - - Immutable sets based on binary trees, where comparison is the - F# structural comparison function, potentially using implementations - of the IComparable interface on key values. - - See the Set module for further operations on sets. - - All members of this class are thread-safe and may be used concurrently from multiple threads. - - - An abbreviation for the type of immutable singly-linked lists. - - Use the constructors [] and :: (infix) to create values of this type, or - the notation [1;2;3]. Use the values in the List module to manipulate - values of this type, or pattern match against the values directly. - - - An abbreviation for the CLI type System.Collections.Generic.IEnumerable<_> - - - Fetches an element from a 2D array. You can also use the syntax array.[index1,index2]. - - The input array. - The index along the first dimension. - The index along the second dimension. - - The value of the array at the given index. - Thrown when the indices are negative or exceed the bounds of the array. - - - Sets the value of an element in an array. You can also use the syntax array.[index1,index2] <- value. - - The input array. - The index along the first dimension. - The index along the second dimension. - The value to set in the array. - Thrown when the indices are negative or exceed the bounds of the array. - - - Builds a new array whose elements are the same as the input array but - where a non-zero-based input array generates a corresponding zero-based - output array. - - The input array. - - The zero-based output array. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer indices passed to the - function indicates the element being transformed. - - For non-zero-based arrays the basing on an input array will be propagated to the output - array. - - A function that is applied to transform each element of the array. The two integers - provide the index of the element. - The input array. - - An array whose elements have been transformed by the given mapping. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - - A function that is applied to transform each item of the input array. - The input array. - - An array whose elements have been transformed by the given mapping. - - - Returns the length of an array in the second dimension. - - The input array. - - The length of the array in the second dimension. - - - Returns the length of an array in the first dimension. - - The input array. - - The length of the array in the first dimension. - - - Applies the given function to each element of the array. The integer indices passed to the - function indicates the index of element. - - A function to apply to each element of the array with the indices available as an argument. - The input array. - - - Applies the given function to each element of the array. - - A function to apply to each element of the array. - The input array. - - - Creates a based array where the entries are initially Unchecked.defaultof<'T>. - - The base for the first dimension of the array. - The base for the second dimension of the array. - The length of the first dimension of the array. - The length of the second dimension of the array. - - The created array. - Thrown when base1, base2, length1, or length2 is negative. - - - Creates a based array whose elements are all initially the given value. - - The base for the first dimension of the array. - The base for the second dimension of the array. - The length of the first dimension of the array. - The length of the second dimension of the array. - The value to populate the new array. - - The created array. - Thrown when base1, base2, length1, or length2 is negative. - - - Creates a based array given the dimensions and a generator function to compute the elements. - - The base for the first dimension of the array. - The base for the second dimension of the array. - The length of the first dimension of the array. - The length of the second dimension of the array. - A function to produce elements of the array given the two indices. - - The created array. - Thrown when base1, base2, length1, or length2 is negative. - - - Creates an array where the entries are initially Unchecked.defaultof<'T>. - - The length of the first dimension of the array. - The length of the second dimension of the array. - - The created array. - Thrown when length1 or length2 is negative. - - - Creates an array whose elements are all initially the given value. - - The length of the first dimension of the array. - The length of the second dimension of the array. - The value to populate the new array. - - The created array. - Thrown when length1 or length2 is negative. - - - Creates an array given the dimensions and a generator function to compute the elements. - - The length of the first dimension of the array. - The length of the second dimension of the array. - A function to produce elements of the array given the two indices. - - The generated array. - Thrown when either of the lengths is negative. - - - Reads a range of elements from the first array and write them into the second. - - The source array. - The first-dimension index to begin copying from in the source array. - The second-dimension index to begin copying from in the source array. - The target array. - The first-dimension index to begin copying into in the target array. - The second-dimension index to begin copying into in the target array. - The number of elements to copy across the first dimension of the arrays. - The number of elements to copy across the second dimension of the arrays. - Thrown when any of the indices are negative or if either of - the counts are larger than the dimensions of the array allow. - - - Builds a new array whose elements are the same as the input array. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - - The input array. - - A copy of the input array. - - - Fetches the base-index for the second dimension of the array. - - The input array. - - The base-index of the second dimension of the array. - - - Fetches the base-index for the first dimension of the array. - - The input array. - - The base-index of the first dimension of the array. - - - Basic operations on 2-dimensional arrays. - - F# and CLI multi-dimensional arrays are typically zero-based. - However, CLI multi-dimensional arrays used in conjunction with external - libraries (e.g. libraries associated with Visual Basic) be - non-zero based, using a potentially different base for each dimension. - The operations in this module will accept such arrays, and - the basing on an input array will be propagated to a matching output - array on the Array2D.map and Array2D.mapi operations. - Non-zero-based arrays can also be created using Array2D.zeroCreateBased, - Array2D.createBased and Array2D.initBased. - - - Creates an array where the entries are initially the "default" value. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The created array. - - - Sets the value of an element in an array. You can also - use the syntax 'array.[index1,index2,index3] <- value'. - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The value to set at the given index. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer indices passed to the - function indicates the element being transformed. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - The function to transform the elements at each index in the array. - The input array. - The array created from the transformed elements. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - The function to transform each element of the array. - The input array. - The array created from the transformed elements. - - - Returns the length of an array in the third dimension. - The input array. - The length of the array in the third dimension. - - - Returns the length of an array in the second dimension. - The input array. - The length of the array in the second dimension. - - - Returns the length of an array in the first dimension - The input array. - The length of the array in the first dimension. - - - Applies the given function to each element of the array. The integer indicies passed to the - function indicates the index of element. - The function to apply to each element of the array. - The input array. - - - Applies the given function to each element of the array. - The function to apply to each element of the array. - The input array. - - - Fetches an element from a 3D array. You can also use the syntax 'array.[index1,index2,index3]' - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The value at the given index. - - - Creates an array given the dimensions and a generator function to compute the elements. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The function to create an initial value at each index into the array. - The created array. - - - Creates an array whose elements are all initially the given value. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The value of the array elements. - The created array. - - - Basic operations on rank 3 arrays. - - - Sets the value of an element in an array. You can also - use the syntax 'array.[index1,index2,index3,index4] <- value'. - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The index along the fourth dimension. - The value to set. - - - Fetches an element from a 4D array. You can also use the syntax 'array.[index1,index2,index3,index4]' - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The index along the fourth dimension. - The value at the given index. - - - Creates an array where the entries are initially the "default" value. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The length of the fourth dimension. - The created array. - - - Returns the length of an array in the fourth dimension. - The input array. - The length of the array in the fourth dimension. - - - Returns the length of an array in the third dimension. - The input array. - The length of the array in the third dimension. - - - Returns the length of an array in the second dimension. - The input array. - The length of the array in the second dimension. - - - Returns the length of an array in the first dimension - The input array. - The length of the array in the first dimension. - - - Creates an array given the dimensions and a generator function to compute the elements. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The length of the fourth dimension. - The function to create an initial value at each index in the array. - The created array. - - - Creates an array whose elements are all initially the given value - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The length of the fourth dimension. - The initial value for each element of the array. - The created array. - - - Basic operations on rank 4 arrays. - - - Combines three arrays into an array of pairs. The three arrays must have equal lengths, otherwise an ArgumentException is - raised. - The first input array. - The second input array. - The third input array. - Thrown when any of the input arrays are null. - Thrown when the input arrays differ in length. - The array of tupled elements. - - - Combines the two arrays into an array of pairs. The two arrays must have equal lengths, otherwise an ArgumentException is - raised. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The array of tupled elements. - - - Returns an array of sliding windows containing elements drawn from the input - array. Each window is returned as a fresh array. - The number of elements in each window. - The input array. - The result array. - Thrown when the input array is null. - Thrown when windowSize is not positive. - - - Returns a new array containing only the elements of the array - for which the given predicate returns "true". - The function to test the input elements. - The input array. - An array containing the elements for which the given predicate returns true. - - Thrown when the input array is null. - - - Splits an array of triples into three arrays. - The input array. - The tuple of three arrays. - Thrown when the input array is null. - - - Splits an array of pairs into two arrays. - The input array. - The two arrays. - Thrown when the input array is null. - - - Returns an array that contains the elements generated by the given computation. - The given initial state argument is passed to the element generator. - A function that takes in the current state and returns an option tuple of the next - element of the array and the next state value. - The initial state value. - The result array. - - - Returns the index of the last element in the array - that satisfies the given predicate. - The function to test the input elements. - The input array. - Thrown when the input array is null. - The index of the last element that satisfies the predicate, or None. - - - Tries to find the nth element in the array. - Returns None if index is negative or the input array does not contain enough elements. - The index of element to retrieve. - The input array. - The nth element of the array or None. - Thrown when the input array is null. - - - Returns the index of the first element in the array - that satisfies the given predicate. - The function to test the input elements. - The input array. - Thrown when the input array is null. - The index of the first element that satisfies the predicate, or None. - - - Returns the last element for which the given function returns true. - Return None if no such element exists. - The function to test the input elements. - The input array. - Thrown when the input array is null. - The last element that satisfies the predicate, or None. - - - Returns the first element for which the given function returns true. - Return None if no such element exists. - The function to test the input elements. - The input array. - The first element that satisfies the predicate, or None. - Thrown when the input array is null. - - - Returns at most N elements in a new array. - The maximum number of items to return. - The input array. - The result array. - Thrown when the input array is null. - - - Views the given array as a sequence. - The input array. - The sequence of array elements. - Thrown when the input array is null. - - - Builds a list from the given array. - The input array. - The list of array elements. - Thrown when the input array is null. - - - Returns a new array containing the elements of the original except the first element. - - The input array. - Thrown when the array is empty. - Thrown when the input array is null. - A new array containing the elements of the original except the first element. - - - Returns an array that contains all elements of the original array while the - given predicate returns true, and then returns no further elements. - - A function that evaluates to false when no more items should be returned. - The input array. - - The result array. - - Thrown when the input array is null. - - - Returns the first N elements of the array. - Throws InvalidOperationException - if the count exceeds the number of elements in the array. Array.truncate - returns as many items as the array contains instead of throwing an exception. - - The number of items to take. - The input array. - - The result array. - - Thrown when the input array is null. - Thrown when the input array is empty. - Thrown when count exceeds the number of elements - in the list. - - - Returns the sum of the results generated by applying the function to each element of the array. - The function to transform the array elements into the type to be summed. - The input array. - The resulting sum. - Thrown when the input array is null. - - - Returns the sum of the elements in the array. - The input array. - The resulting sum. - Thrown when the input array is null. - - - Sorts the elements of an array, in descending order, using the given projection for the keys and returning a new array. - Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to transform array elements into the type that is compared. - The input array. - The sorted array. - - - Sorts the elements of an array, in descending order, returning a new array. Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The input array. - The sorted array. - - - Splits an array into two arrays, at the given index. - The index at which the array is split. - The input array. - The two split arrays. - - Thrown when the input array is null. - Thrown when split index exceeds the number of elements - in the array. - - - Sorts the elements of an array by mutating the array in-place, using the given comparison function. - Elements are compared using Operators.compare. - The input array. - Thrown when the input array is null. - - - Sorts the elements of an array by mutating the array in-place, using the given comparison function as the order. - The function to compare pairs of array elements. - The input array. - Thrown when the input array is null. - - - Sorts the elements of an array by mutating the array in-place, using the given projection for the keys. - Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to transform array elements into the type that is compared. - The input array. - Thrown when the input array is null. - - - Sorts the elements of an array, using the given comparison function as the order, returning a new array. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to compare pairs of array elements. - The input array. - The sorted array. - Thrown when the input array is null. - - - Sorts the elements of an array, using the given projection for the keys and returning a new array. - Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to transform array elements into the type that is compared. - The input array. - The sorted array. - Thrown when the input array is null. - - - Sorts the elements of an array, returning a new array. Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The input array. - The sorted array. - Thrown when the input array is null. - - - Builds a new array that contains the given subrange specified by - starting index and length. - The input array. - The index of the first element of the sub array. - The length of the sub array. - The created sub array. - Thrown when the input array is null. - Thrown when either startIndex or count is negative, - or when there aren't enough elements in the input array. - - - Bypasses elements in an array while the given predicate returns true, and then returns - the remaining elements in a new array. - A function that evaluates an element of the array to a boolean value. - The input array. - The created sub array. - Thrown when the input array is null. - - - Builds a new array that contains the elements of the given array, excluding the first N elements. - The number of elements to skip. - The input array. - A copy of the input array, after removing the first N elements. - Thrown when the input array is null. - Thrown when count is negative or exceeds the number of - elements in the array. - - - Sets an element of an array. - The input array. - The input index. - The input value. - Thrown when the input array is null. - Thrown when the index is negative or the input array does not contain enough elements. - - - Returns an array that contains one item only. - - The input item. - - The result array of one item. - - - Like foldBack, but return both the intermediary and final results. - The function to update the state given the input elements. - The input array. - The initial state. - The array of state values. - Thrown when the input array is null. - - - Like fold, but return the intermediary and final results. - The function to update the state given the input elements. - The initial state. - The input array. - The array of state values. - Thrown when the input array is null. - - - Returns a new array with the elements in reverse order. - The input array. - The reversed array. - Thrown when the input array is null. - - - Creates an array by replicating the given initial value. - The number of elements to replicate. - The value to replicate - The generated array. - Thrown when count is negative. - - - Applies a function to each element of the array, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f i0 (...(f iN-1 iN)). - A function that takes in the next-to-last element of the list and the - current accumulated result to produce the next accumulated result. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The final result of the reductions. - - - Applies a function to each element of the array, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f (... (f i0 i1)...) iN. - Raises ArgumentException if the array has size zero. - The function to reduce a pair of elements to a single element. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The final result of the redcutions. - - - Returns an array with all elements permuted according to the - specified permutation. - The function that maps input indices to output indices. - The input array. - The output array. - Thrown when the input array is null. - Thrown when indexMap does not produce a valid permutation. - - - Splits the collection into two collections, containing the - elements for which the given predicate returns "true" and "false" - respectively. - The function to test the input elements. - The input array. - A pair of arrays. The first containing the elements the predicate evaluated to true, - and the second containing those evaluated to false. - Thrown when the input array is null. - - - Returns an array of each element in the input array and its predecessor, with the - exception of the first element which is only returned as the predecessor of the second element. - - The input array. - - The result array. - - Thrown when the input sequence is null. - - - Builds a new array from the given enumerable object. - The input sequence. - The array of elements from the sequence. - Thrown when the input sequence is null. - - - Builds an array from the given list. - The input list. - The array of elements from the list. - - - Returns the lowest of all elements of the array, compared via Operators.min on the function result. - - Throws ArgumentException for empty arrays. - The function to transform the elements into a type supporting comparison. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The minimum element. - - - Returns the lowest of all elements of the array, compared via Operators.min. - - Throws ArgumentException for empty arrays - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The minimum element. - - - Returns the greatest of all elements of the array, compared via Operators.max on the function result. - - Throws ArgumentException for empty arrays. - The function to transform the elements into a type supporting comparison. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The maximum element. - - - Returns the greatest of all elements of the array, compared via Operators.max on the function result. - - Throws ArgumentException for empty arrays. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The maximum element. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer index passed to the - function indicates the index of element being transformed. - The function to transform elements and their indices. - The input array. - The array of transformed elements. - Thrown when the input array is null. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the two collections pairwise, also passing the index of - the elements. The two input arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to transform pairs of input elements and their indices. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The array of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding triples from the three collections. The three input - arrays must have the same length, otherwise an ArgumentException is - raised. - The function to transform the pairs of the input elements. - The first input array. - The second input array. - The third input array. - Thrown when the input arrays differ in length. - Thrown when any of the input arrays is null. - The array of transformed elements. - - - Combines map and foldBack. Builds a new array whose elements are the results of applying the given function - to each of the elements of the input array. The function is also used to accumulate a final value. - The function to transform elements from the input array and accumulate the final value. - The input array. - The initial state. - Thrown when the input array is null. - The array of transformed elements, and the final accumulated value. - - - Combines map and fold. Builds a new array whose elements are the results of applying the given function - to each of the elements of the input array. The function is also used to accumulate a final value. - The function to transform elements from the input array and accumulate the final value. - The initial state. - The input array. - Thrown when the input array is null. - The array of transformed elements, and the final accumulated value. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the two collections pairwise. The two input - arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to transform the pairs of the input elements. - The first input array. - The second input array. - Thrown when the input arrays differ in length. - Thrown when either of the input arrays is null. - The array of transformed elements. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. - The function to transform elements of the array. - The input array. - The array of transformed elements. - Thrown when the input array is null. - - - Returns the last element of the array. - Return None if no such element exists. - The input array. - The last element of the array or None. - Thrown when the input sequence is null. - - - Returns the length of an array. You can also use property arr.Length. - The input array. - The length of the array. - Thrown when the input array is null. - - - Gets an element from an array. - The input index. - The input array. - The value of the array at the given index. - Thrown when the input array is null. - Thrown when the index is negative or the input array does not contain enough elements. - - - Returns the last element of the array. - The input array. - The last element of the array. - Thrown when the input array is null. - Thrown when the input does not have any elements. - - - Applies the given function to pair of elements drawn from matching indices in two arrays, - also passing the index of the elements. The two arrays must have the same lengths, - otherwise an ArgumentException is raised. - The function to apply to each index and pair of elements. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - - - Applies the given function to each element of the array. The integer passed to the - function indicates the index of element. - The function to apply to each index and element. - The input array. - Thrown when the input array is null. - - - Applies the given function to pair of elements drawn from matching indices in two arrays. The - two arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to apply. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - - - Applies the given function to each element of the array. - The function to apply. - The input array. - Thrown when the input array is null. - - - Returns true if the given array is empty, otherwise false. - The input array. - True if the array is empty. - Thrown when the input array is null. - - - Creates an array where the entries are initially the default value Unchecked.defaultof<'T>. - The length of the array to create. - The created array. - Thrown when count is negative. - - - Creates an array given the dimension and a generator function to compute the elements. - The number of elements to initialize. - The function to generate the initial values for each index. - The created array. - Thrown when count is negative. - - - Builds a new array whose elements are the corresponding elements of the input array - paired with the integer index (from 0) of each element. - The input array. - The array of indexed elements. - Thrown when the input array is null. - - - Applies a key-generating function to each element of an array and yields an array of - unique keys. Each unique key contains an array of all elements that match - to this key. - - A function that transforms an element of the array into a comparable key. - The input array. - - The result array. - - Thrown when the input array is null. - - - Returns the first element of the array. - - The input array. - - The first element of the array. - - Thrown when the input array is null. - Thrown when the input array is empty. - - - Gets an element from an array. - The input array. - The input index. - The value of the array at the given index. - Thrown when the input array is null. - Thrown when the index is negative or the input array does not contain enough elements. - - - Apply a function to pairs of elements drawn from the two collections, right-to-left, - threading an accumulator argument through the computation. The two input - arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to update the state given the input elements. - The first input array. - The second input array. - The initial state. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The final state. - - - Applies a function to pairs of elements drawn from the two collections, - left-to-right, threading an accumulator argument - through the computation. The two input - arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to update the state given the input elements. - The initial state. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The final state. - - - Applies a function to each element of the array, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then computes - f i0 (...(f iN s)) - The function to update the state given the input elements. - The input array. - The initial state. - The state object after the folding function is applied to each element of the array. - Thrown when the input array is null. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then computes - f (... (f s i0)...) iN - The function to update the state given the input elements. - The initial state. - The input array. - The final state. - Thrown when the input array is null. - - - Tests if all corresponding elements of the array satisfy the given predicate pairwise. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns false then the overall result is - false and no further elements are tested. Otherwise, if one collection is longer - than the other then the ArgumentException exception is raised. - Otherwise, true is returned. - The function to test the input elements. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - True if all of the array elements satisfy the predicate. - - - Tests if all elements of the array satisfy the given predicate. - - The predicate is applied to the elements of the input collection. If any application - returns false then the overall result is false and no further elements are tested. - Otherwise, true is returned. - The function to test the input elements. - The input array. - True if all of the array elements satisfy the predicate. - Thrown when the input array is null. - - - Returns the index of the last element in the array - that satisfies the given predicate. Raise KeyNotFoundException if - none of the elements satisfy the predicate. - The function to test the input elements. - The input array. - Thrown if predicate - never returns true. - Thrown when the input array is null. - The index of the last element in the array that satisfies the given predicate. - - - Returns the index of the first element in the array - that satisfies the given predicate. Raise KeyNotFoundException if - none of the elements satisfy the predicate. - The function to test the input elements. - The input array. - Thrown if predicate - never returns true. - Thrown when the input array is null. - The index of the first element in the array that satisfies the given predicate. - - - Returns the last element for which the given function returns 'true'. - Raise KeyNotFoundException if no such element exists. - The function to test the input elements. - The input array. - Thrown if predicate - never returns true. - Thrown when the input array is null. - The last element for which predicate returns true. - - - Returns the first element for which the given function returns 'true'. - Raise KeyNotFoundException if no such element exists. - The function to test the input elements. - The input array. - Thrown when the input array is null. - Thrown if predicate - never returns true. - The first element for which predicate returns true. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true". - The function to test the input elements. - The input array. - An array containing the elements for which the given predicate returns true. - Thrown when the input array is null. - - - Tests if any pair of corresponding elements of the arrays satisfies the given predicate. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns true then the overall result is - true and no further elements are tested. Otherwise, if one collections is longer - than the other then the ArgumentException exception is raised. - Otherwise, false is returned. - The function to test the input elements. - The first input array. - The second input array. - True if any result from predicate is true. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - - - Tests if any element of the array satisfies the given predicate. - - The predicate is applied to the elements of the input array. If any application - returns true then the overall result is true and no further elements are tested. - Otherwise, false is returned. - The function to test the input elements. - The input array. - True if any result from predicate is true. - Thrown when the input array is null. - - - Returns a new list with the distinct elements of the input array which do not appear in the itemsToExclude sequence, - using generic hash and equality comparisons to compare values. - - A sequence whose elements that also occur in the input array will cause those elements to be - removed from the result. - An array whose elements that are not also in itemsToExclude will be returned. - - An array that contains the distinct elements of array that do not appear in itemsToExclude. - - Thrown when either itemsToExclude or array is null. - - - Returns the only element of the array. - - The input array. - - The only element of the array. - - Thrown when the input array is null. - Thrown when the input does not have precisely one element. - - - Returns an empty array of the given type. - The empty array. - - - Splits the input array into at most count chunks. - The maximum number of chunks. - The input array. - The array split into chunks. - Thrown when the input array is null. - Thrown when count is not positive. - - - Returns an array that contains no duplicate entries according to the - generic hash and equality comparisons on the keys returned by the given key-generating function. - If an element occurs multiple times in the array then the later occurrences are discarded. - - A function transforming the array items into comparable keys. - The input array. - - The result array. - - Thrown when the input array is null. - - - Returns an array that contains no duplicate entries according to generic hash and - equality comparisons on the entries. - If an element occurs multiple times in the array then the later occurrences are discarded. - - The input array. - - The result array. - - Thrown when the input array is null. - - - Divides the input array into chunks of size at most chunkSize. - The maximum size of each chunk. - The input array. - The array divided into chunks. - Thrown when the input array is null. - Thrown when chunkSize is not positive. - - - Applies the given function to each element of the array. Returns - the array comprised of the results "x" for each element where - the function returns Some(x) - The function to generate options from the elements. - The input array. - The array of results. - Thrown when the input array is null. - - - Applies the given function to successive elements, returning the first - result where function returns Some(x) for some x. If the function - never returns Some(x) then KeyNotFoundException is raised. - The function to generate options from the elements. - The input array. - Thrown when the input array is null. - Thrown if every result from - chooser is None. - The first result. - - - Fills a range of elements of the array with the given value. - The target array. - The index of the first element to set. - The number of elements to set. - The value to set. - Thrown when the input array is null. - Thrown when either targetIndex or count is negative. - - - Applies the given function to successive elements, returning the first - result where function returns Some(x) for some x. If the function - never returns Some(x) then None is returned. - The function to transform the array elements into options. - The input array. - The first transformed element that is Some(x). - Thrown when the input array is null. - - - Returns the first element of the array, or - None if the array is empty. - The input array. - Thrown when the input array is null. - The first element of the array or None. - - - Creates an array whose elements are all initially the given value. - The length of the array to create. - The value for the elements. - The created array. - Thrown when count is negative. - - - Applies a key-generating function to each element of an array and returns an array yielding unique - keys and their number of occurrences in the original array. - - A function transforming each item of the input array into a key to be - compared against the others. - The input array. - - The result array. - - Thrown when the input array is null. - - - Builds a new array that contains the elements of the given array. - The input array. - A copy of the input array. - Thrown when the input array is null. - - - Tests if the array contains the specified element. - The value to locate in the input array. - The input array. - True if the input array contains the specified element; false otherwise. - Thrown when the input array is null. - - - Builds a new array that contains the elements of each of the given sequence of arrays. - The input sequence of arrays. - The concatenation of the sequence of input arrays. - Thrown when the input sequence is null. - - - Compares two arrays using the given comparison function, element by element. - Returns the first non-zero result from the comparison function. If the end of an array - is reached it returns a -1 if the first array is shorter and a 1 if the second array - is shorter. - - A function that takes an element from each array and returns an int. - If it evaluates to a non-zero value iteration is stopped and that value is returned. - The first input array. - The second input array. - - The first non-zero value from the comparison function. - - Thrown when either of the input arrays - is null. - - - For each element of the array, applies the given function. Concatenates all the results and return the combined array. - The function to create sub-arrays from the input array elements. - The input array. - The concatenation of the sub-arrays. - Thrown when the input array is null. - - - Reads a range of elements from the first array and write them into the second. - The source array. - The starting index of the source array. - The target array. - The starting index of the target array. - The number of elements to copy. - Thrown when either of the input arrays is null. - Thrown when any of sourceIndex, targetIndex or count are negative, - or when there aren't enough elements in source or target. - - - Returns the average of the elements generated by applying the function to each element of the array. - The function to transform the array elements before averaging. - The input array. - Thrown when array is empty. - The computed average. - Thrown when the input array is null. - - - Returns the average of the elements in the array. - The input array. - Thrown when array is empty. - The average of the elements in the array. - Thrown when the input array is null. - - - Builds a new array that contains the elements of the first array followed by the elements of the second array. - The first input array. - The second input array. - The resulting array. - Thrown when either of the input arrays is null. - - - Split the collection into two collections, containing the - elements for which the given predicate returns "true" and "false" - respectively - - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to indicies is not specified. - The function to test the input elements. - The input array. - 'T[] * 'T[] - Thrown when the input array is null. - - - Create an array given the dimension and a generator function to compute the elements. - - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to indicies is not specified. - - - 'T[] - - - Apply the given function to each element of the array. The integer passed to the - function indicates the index of element. - - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to elements of the input array is not specified. - - The input array. - Thrown when the input array is null. - - - Apply the given function to each element of the array. - - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to elements of the input array is not specified. - - The input array. - Thrown when the input array is null. - - - Build a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer index passed to the - function indicates the index of element being transformed. - - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to elements of the input array is not specified. - - The input array. - 'U[] - Thrown when the input array is null. - - - Build a new array whose elements are the results of applying the given function - to each of the elements of the array. - - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to elements of the input array is not specified. - - The input array. - 'U[] - Thrown when the input array is null. - - - For each element of the array, apply the given function. Concatenate all the results and return the combined array. - - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to elements of the input array is not specified. - - The input array. - 'U[] - Thrown when the input array is null. - - - Apply the given function to each element of the array. Return - the array comprised of the results "x" for each element where - the function returns Some(x). - - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to elements of the input array is not specified. - The function to generate options from the elements. - The input array. - 'U[] - Thrown when the input array is null. - - - Provides parallel operations on arrays - - - Basic operations on arrays. - - - Compare using the given comparer function. - A function to compare two values. - An object implementing IComparer using the supplied comparer. - - - Non-structural comparison. Compare using NonStructuralComparison.compare. - - - Structural comparison. Compare using Operators.compare. - - - Common notions of comparison identity used with sorted data structures. - - - Hash using the given hashing and equality functions. - A function to generate a hash code from a value. - A function to test equality of two values. - An object implementing IEqualityComparer using the supplied functions. - - - Physical hashing (hash on reference identity of objects, and the contents of value types). - Hash using LanguagePrimitives.PhysicalEquality and LanguagePrimitives.PhysicalHash, - That is, for value types use GetHashCode and Object.Equals (if no other optimization available), - and for reference types use System.Runtime.CompilerServices.RuntimeHelpers.GetHashCode and - reference equality. - - - Non-structural hashing. Equality using NonStructuralComparison.(=) and NonStructuralComparison.hash. - - - Structural hashing. Hash using Operators.(=) and Operators.hash. - - - Common notions of value identity used with hash tables. - - - Combines the three lists into a list of triples. The lists must have equal lengths. - The first input list. - The second input list. - The third input list. - A single list containing triples of matching elements from the input lists. - - - Combines the two lists into a list of pairs. The two lists must have equal lengths. - The first input list. - The second input list. - A single list containing pairs of matching elements from the input lists. - - - Returns a list of sliding windows containing elements drawn from the input - list. Each window is returned as a fresh list. - The number of elements in each window. - The input list. - The result list. - Thrown when windowSize is not positive. - - - Returns a new list containing only the elements of the list - for which the given predicate returns "true" - The function to test the input elements. - The input list. - A list containing only the elements that satisfy the predicate. - - - Splits a list of triples into three lists. - The input list. - Three lists of split elements. - - - Splits a list of pairs into two lists. - The input list. - Two lists of split elements. - - - Returns a list that contains the elements generated by the given computation. - The given initial state argument is passed to the element generator. - A function that takes in the current state and returns an option tuple of the next - element of the list and the next state value. - The initial state value. - The result list. - - - Returns the index of the last element in the list - that satisfies the given predicate. - Return None if no such element exists. - The function to test the input elements. - The input list. - The index of the last element for which the predicate returns true, or None if - every element evaluates to false. - - - Tries to find the nth element in the list. - Returns None if index is negative or the list does not contain enough elements. - The index to retrieve. - The input list. - The value at the given index or None. - - - Returns the index of the first element in the list - that satisfies the given predicate. - Return None if no such element exists. - The function to test the input elements. - The input list. - The index of the first element for which the predicate returns true, or None if - every element evaluates to false. - - - Returns the last element for which the given function returns true.. - Return None if no such element exists. - The function to test the input elements. - The input list. - The last element for which the predicate returns true, or None if - every element evaluates to false. - - - Returns the first element for which the given function returns true.. - Return None if no such element exists. - The function to test the input elements. - The input list. - The first element for which the predicate returns true, or None if - every element evaluates to false. - - - Applies the given function to successive elements, returning Some(x) the first - result where function returns Some(x) for some x. If no such element - exists then return None. - The function to generate options from the elements. - The input list. - The first resulting value or None. - - - Returns at most N elements in a new list. - The maximum number of items to return. - The input list. - The result list. - - - Returns the first element of the list, or - None if the list is empty. - The input list. - The first element of the list or None. - - - Views the given list as a sequence. - The input list. - The sequence of elements in the list. - - - Builds an array from the given list. - The input list. - The array containing the elements of the list. - - - Returns a list that contains all elements of the original list while the - given predicate returns true, and then returns no further elements. - - A function that evaluates to false when no more items should be returned. - The input list. - - The result list. - - - Returns the first N elements of the list. - Throws InvalidOperationException - if the count exceeds the number of elements in the list. List.truncate - returns as many items as the list contains instead of throwing an exception. - - The number of items to take. - The input list. - - The result list. - - Thrown when the input list is empty. - Thrown when count exceeds the number of elements - in the list. - - - Returns the list after removing the first element. - - The input list. - Thrown when the list is empty. - The list after removing the first element. - - - Returns the sum of the results generated by applying the function to each element of the list. - The function to transform the list elements into the type to be summed. - The input list. - The resulting sum. - - - Returns the sum of the elements in the list. - The input list. - The resulting sum. - - - Sorts the given list in descending order using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The input list. - The sorted list. - - - Sorts the given list in descending order using keys given by the given projection. Keys are compared using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The function to transform the list elements into the type to be compared. - The input list. - The sorted list. - - - Splits a list into two lists, at the given index. - The index at which the list is split. - The input list. - The two split lists. - - Thrown when split index exceeds the number of elements - in the list. - - - Sorts the given list using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The input list. - The sorted list. - - - Sorts the given list using keys given by the given projection. Keys are compared using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The function to transform the list elements into the type to be compared. - The input list. - The sorted list. - - - Sorts the given list using the given comparison function. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The function to compare the list elements. - The input list. - The sorted list. - - - Bypasses elements in a list while the given predicate returns true, and then returns - the remaining elements of the list. - A function that evaluates an element of the list to a boolean value. - The input list. - The result list. - - - Returns the list after removing the first N elements. - The number of elements to skip. - The input list. - The list after removing the first N elements. - Thrown when count is negative or exceeds the number of - elements in the list. - - - Returns a list that contains one item only. - - The input item. - - The result list of one item. - - - Like foldBack, but returns both the intermediary and final results - The function to update the state given the input elements. - The input list. - The initial state. - The list of states. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. Take the second argument, and apply the function to it - and the first element of the list. Then feed this result into the function along - with the second element and so on. Returns the list of intermediate results and the final result. - The function to update the state given the input elements. - The initial state. - The input list. - The list of states. - - - Returns a new list with the elements in reverse order. - The input list. - The reversed list. - - - Creates a list by replicating the given initial value. - The number of elements to replicate. - The value to replicate - The generated list. - - - Applies a function to each element of the collection, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then computes - f i0 (...(f iN-1 iN)). - A function that takes in the next-to-last element of the list and the - current accumulated result to produce the next accumulated result. - The input list. - Thrown when the list is empty. - The final result of the reductions. - - - Apply a function to each element of the collection, threading an accumulator argument - through the computation. Apply the function to the first two elements of the list. - Then feed this result into the function along with the third element and so on. - Return the final result. If the input function is f and the elements are i0...iN then computes - f (... (f i0 i1) i2 ...) iN. - - Raises System.ArgumentException if list is empty - The function to reduce two list elements to a single element. - The input list. - Thrown when the list is empty. - The final reduced value. - - - Returns a list with all elements permuted according to the - specified permutation. - The function to map input indices to output indices. - The input list. - The permuted list. - Thrown when indexMap does not produce a valid permutation. - - - Applies the given function to successive elements, returning the first - result where function returns Some(x) for some x. If no such - element exists then raise System.Collections.Generic.KeyNotFoundException - The function to generate options from the elements. - The input list. - Thrown when the list is empty. - The first resulting value. - - - Splits the collection into two collections, containing the - elements for which the given predicate returns true and false - respectively. Element order is preserved in both of the created lists. - The function to test the input elements. - The input list. - A list containing the elements for which the predicate evaluated to false and a list - containing the elements for which the predicate evaluated to true. - - - Returns a list of each element in the input list and its predecessor, with the - exception of the first element which is only returned as the predecessor of the second element. - - The input list. - - The result list. - - - Builds a new list from the given enumerable object. - The input sequence. - The list of elements from the sequence. - - - Builds a list from the given array. - The input array. - The list of elements from the array. - - - Indexes into the list. The first element has index 0. - The input list. - The index to retrieve. - The value at the given index. - Thrown when the index is negative or the input list does not contain enough elements. - - - Returns the lowest of all elements of the list, compared via Operators.min on the function result - - Raises System.ArgumentException if list is empty. - The function to transform list elements into the type to be compared. - The input list. - Thrown when the list is empty. - The minimum value. - - - Returns the lowest of all elements of the list, compared via Operators.min. - - Raises System.ArgumentException if list is empty - The input list. - Thrown when the list is empty. - The minimum value. - - - Returns the greatest of all elements of the list, compared via Operators.max on the function result. - - Raises System.ArgumentException if list is empty. - The function to transform the list elements into the type to be compared. - The input list. - Thrown when the list is empty. - The maximum element. - - - Return the greatest of all elements of the list, compared via Operators.max. - - Raises System.ArgumentException if list is empty - The input list. - Thrown when the list is empty. - The maximum element. - - - Like mapi, but mapping corresponding elements from two lists of equal length. - The function to transform pairs of elements from the two lists and their index. - The first input list. - The second input list. - The list of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The integer index passed to the - function indicates the index (from 0) of element being transformed. - The function to transform elements and their indices. - The input list. - The list of transformed elements. - - - Combines map and foldBack. Builds a new list whose elements are the results of applying the given function - to each of the elements of the input list. The function is also used to accumulate a final value. - The function to transform elements from the input list and accumulate the final value. - The input list. - The initial state. - The list of transformed elements, and the final accumulated value. - - - Combines map and fold. Builds a new list whose elements are the results of applying the given function - to each of the elements of the input list. The function is also used to accumulate a final value. - The function to transform elements from the input list and accumulate the final value. - The initial state. - The input list. - The list of transformed elements, and the final accumulated value. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the three collections simultaneously. - The function to transform triples of elements from the input lists. - The first input list. - The second input list. - The third input list. - The list of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the two collections pairwise. - The function to transform pairs of elements from the input lists. - The first input list. - The second input list. - The list of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. - The function to transform elements from the input list. - The input list. - The list of transformed elements. - - - Returns the last element of the list. - Return None if no such element exists. - The input list. - The last element of the list or None. - - - Returns the length of the list. - The input list. - The length of the list. - - - Returns the last element of the list. - The input list. - The last element of the list. - Thrown when the input does not have any elements. - - - Applies the given function to two collections simultaneously. The - collections must have identical size. The integer passed to the - function indicates the index of element. - The function to apply to a pair of elements from the input lists along with their index. - The first input list. - The second input list. - - - Applies the given function to each element of the collection. The integer passed to the - function indicates the index of element. - The function to apply to the elements of the list along with their index. - The input list. - - - Applies the given function to two collections simultaneously. The - collections must have identical size. - The function to apply to pairs of elements from the input lists. - The first input list. - The second input list. - - - Applies the given function to each element of the collection. - The function to apply to elements from the input list. - The input list. - - - Indexes into the list. The first element has index 0. - The index to retrieve. - The input list. - The value at the given index. - Thrown when the index is negative or the input list does not contain enough elements. - - - Returns true if the list contains no elements, false otherwise. - The input list. - True if the list is empty. - - - Creates a list by calling the given generator on each index. - The length of the list to generate. - The function to generate an element from an index. - The list of generated elements. - - - Returns a new list whose elements are the corresponding elements - of the input list paired with the index (from 0) of each element. - The input list. - The list of indexed elements. - - - Returns the first element of the list. - - The input list. - Thrown when the list is empty. - The first element of the list. - - - Applies a key-generating function to each element of a list and yields a list of - unique keys. Each unique key contains a list of all elements that match - to this key. - - A function that transforms an element of the list into a comparable key. - The input list. - - The result list. - - - Tests if all corresponding elements of the collection satisfy the given predicate pairwise. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns false then the overall result is - false and no further elements are tested. Otherwise, if one collection is longer - than the other then the System.ArgumentException exception is raised. - Otherwise, true is returned. - The function to test the input elements. - The first input list. - The second input list. - Thrown when the input lists differ in length. - True if all of the pairs of elements satisfy the predicate. - - - Tests if all elements of the collection satisfy the given predicate. - - The predicate is applied to the elements of the input list. If any application - returns false then the overall result is false and no further elements are tested. - Otherwise, true is returned. - The function to test the input elements. - The input list. - True if all of the elements satisfy the predicate. - - - Applies a function to corresponding elements of two collections, threading an accumulator argument - through the computation. The collections must have identical sizes. - If the input function is f and the elements are i0...iN and j0...jN - then computes f i0 j0 (...(f iN jN s)). - The function to update the state given the input elements. - The first input list. - The second input list. - The initial state. - The final state value. - - - Applies a function to each element of the collection, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then - computes f i0 (...(f iN s)). - The function to update the state given the input elements. - The input list. - The initial state. - The state object after the folding function is applied to each element of the list. - - - Applies a function to corresponding elements of two collections, threading an accumulator argument - through the computation. The collections must have identical sizes. - If the input function is f and the elements are i0...iN and j0...jN - then computes f (... (f s i0 j0)...) iN jN. - The function to update the state given the input elements. - The initial state. - The first input list. - The second input list. - The final state value. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. Take the second argument, and apply the function to it - and the first element of the list. Then feed this result into the function along - with the second element and so on. Return the final result. - If the input function is f and the elements are i0...iN then - computes f (... (f s i0) i1 ...) iN. - The function to update the state given the input elements. - The initial state. - The input list. - The final state value. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true" - The function to test the input elements. - The input list. - A list containing only the elements that satisfy the predicate. - - - Returns the index of the last element in the list - that satisfies the given predicate. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for all the - elements of the list. - The index of the last element that satisfies the predicate. - - - Returns the index of the first element in the list - that satisfies the given predicate. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for all the - elements of the list. - The index of the first element that satisfies the predicate. - - - Returns the last element for which the given function returns true. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for - all the elements of the list. - The last element that satisfies the predicate. - - - Returns the first element for which the given function returns true. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for - all the elements of the list. - The first element that satisfies the predicate. - - - Tests if any pair of corresponding elements of the lists satisfies the given predicate. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns true then the overall result is - true and no further elements are tested. Otherwise, if one collections is longer - than the other then the System.ArgumentException exception is raised. - Otherwise, false is returned. - The function to test the input elements. - The first input list. - The second input list. - Thrown when the input lists differ in length. - True if any pair of elements satisfy the predicate. - - - Tests if any element of the list satisfies the given predicate. - - The predicate is applied to the elements of the input list. If any application - returns true then the overall result is true and no further elements are tested. - Otherwise, false is returned. - The function to test the input elements. - The input list. - True if any element satisfies the predicate. - - - Returns the only element of the list. - - The input list. - - The only element of the list. - - Thrown when the input does not have precisely one element. - - - Returns a new list with the distinct elements of the input list which do not appear in the itemsToExclude sequence, - using generic hash and equality comparisons to compare values. - - A sequence whose elements that also occur in the input list will cause those elements to be - removed from the result. - A list whose elements that are not also in itemsToExclude will be returned. - - A list that contains the distinct elements of list that do not appear in itemsToExclude. - - Thrown when itemsToExclude is null. - - - Returns an empty list of the given type. - - - Splits the input list into at most count chunks. - The maximum number of chunks. - The input list. - The list split into chunks. - Thrown when count is not positive. - - - Applies a key-generating function to each element of a list and returns a list yielding unique - keys and their number of occurrences in the original list. - - A function transforming each item of the input list into a key to be - compared against the others. - The input list. - - The result list. - - - Returns a list that contains no duplicate entries according to the - generic hash and equality comparisons on the keys returned by the given key-generating function. - If an element occurs multiple times in the list then the later occurrences are discarded. - - A function transforming the list items into comparable keys. - The input list. - - The result list. - - - Returns a list that contains no duplicate entries according to generic hash and - equality comparisons on the entries. - If an element occurs multiple times in the list then the later occurrences are discarded. - - The input list. - - The result list. - - - Tests if the list contains the specified element. - The value to locate in the input list. - The input list. - True if the input list contains the specified element; false otherwise. - - - Returns a new list that contains the elements of each the lists in order. - The input sequence of lists. - The resulting concatenated list. - - - Compares two lists using the given comparison function, element by element. - Returns the first non-zero result from the comparison function. If the end of a list - is reached it returns a -1 if the first list is shorter and a 1 if the second list - is shorter. - - A function that takes an element from each list and returns an int. - If it evaluates to a non-zero value iteration is stopped and that value is returned. - The first input list. - The second input list. - - The first non-zero value from the comparison function. - - - For each element of the list, applies the given function. Concatenates all the results and return the combined list. - The function to transform each input element into a sublist to be concatenated. - The input list. - The concatenation of the transformed sublists. - - - Divides the input list into chunks of size at most chunkSize. - The maximum size of each chunk. - The input list. - The list divided into chunks. - Thrown when chunkSize is not positive. - - - Applies the given function to each element of the list. Returns - the list comprised of the results x for each element where - the function returns Some(x) - The function to generate options from the elements. - The input list. - The list comprising the values selected from the chooser function. - - - Returns the average of the elements generated by applying the function to each element of the list. - - Raises System.ArgumentException if list is empty. - The function to transform the list elements into the type to be averaged. - The input list. - Thrown when the list is empty. - The resulting average. - - - Returns the average of the elements in the list. - - Raises System.ArgumentException if list is empty. - The input list. - Thrown when the list is empty. - The resulting average. - - - Returns a new list that contains the elements of the first list - followed by elements of the second. - The first input list. - The second input list. - The resulting list. - - - Basic operations on lists. - - - Returns the key of the first mapping in the collection that satisfies the given predicate. - Returns 'None' if no such element exists. - The function to test the input elements. - The input map. - The first key for which the predicate returns true or None if the predicate evaluates to false for each key/value pair. - - - Evaluates the function on each mapping in the collection. Returns the key for the first mapping - where the function returns 'true'. Raise KeyNotFoundException if no such element exists. - The function to test the input elements. - The input map. - Thrown if the key does not exist in the map. - The first key for which the predicate evaluates true. - - - Lookup an element in the map, returning a Some value if the element is in the domain - of the map and None if not. - The input key. - The input map. - The found Some value or None. - - - Removes an element from the domain of the map. No exception is raised if the element is not present. - The input key. - The input map. - The resulting map. - - - Builds two new maps, one containing the bindings for which the given predicate returns 'true', - and the other the remaining bindings. - The function to test the input elements. - The input map. - A pair of maps in which the first contains the elements for which the predicate returned true - and the second containing the elements for which the predicated returned false. - - - Tests if an element is in the domain of the map. - The input key. - The input map. - True if the map contains the key. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The key passed to the - function indicates the key of element being transformed. - The function to transform the key/value pairs. - The input map. - The resulting map of keys and transformed values. - - - Returns true if the given predicate returns true for all of the - bindings in the map. - The function to test the input elements. - The input map. - True if the predicate evaluates to true for all of the bindings in the map. - - - Builds a new map containing only the bindings for which the given predicate returns 'true'. - The function to test the key/value pairs. - The input map. - The filtered map. - - - Returns true if the given predicate returns true for one of the - bindings in the map. - The function to test the input elements. - The input map. - True if the predicate returns true for one of the key/value pairs. - - - Applies the given function to each binding in the dictionary - The function to apply to each key/value pair. - The input map. - - - Folds over the bindings in the map - The function to update the state given the input key/value pairs. - The initial state. - The input map. - The final state value. - - - Folds over the bindings in the map. - The function to update the state given the input key/value pairs. - The input map. - The initial state. - The final state value. - - - Searches the map looking for the first element where the given function returns a Some value - The function to generate options from the key/value pairs. - The input map. - The first result. - - - Searches the map looking for the first element where the given function returns a Some value. - The function to generate options from the key/value pairs. - The input map. - The first result. - - - Lookup an element in the map, raising KeyNotFoundException if no binding - exists in the map. - The input key. - The input map. - Thrown when the key does not exist in the map. - The value mapped to the given key. - - - The empty map. - - - Is the map empty? - The input map. - True if the map is empty. - - - Returns an array of all key-value pairs in the mapping. - The array will be ordered by the keys of the map. - The input map. - The array of key/value pairs. - - - Returns a list of all key-value pairs in the mapping. - The list will be ordered by the keys of the map. - The input map. - The list of key/value pairs. - - - Views the collection as an enumerable sequence of pairs. - The sequence will be ordered by the keys of the map. - The input map. - The sequence of key/value pairs. - - - Returns a new map made from the given bindings. - The input sequence of key/value pairs. - The resulting map. - - - Returns a new map made from the given bindings. - The input array of key/value pairs. - The resulting map. - - - Returns a new map made from the given bindings. - The input list of key/value pairs. - The resulting map. - - - Returns a new map with the binding added to the given map. - The input key. - The input value. - The input map. - The resulting map. - - - Functional programming operators related to the Map<_,_> type. - - - Combines the three sequences into a list of triples. The sequences need not have equal lengths: - when one sequence is exhausted any remaining elements in the other - sequences are ignored. - - The first input sequence. - The second input sequence. - The third input sequence. - - The result sequence. - - Thrown when any of the input sequences is null. - - - Combines the two sequences into a list of pairs. The two sequences need not have equal lengths: - when one sequence is exhausted any remaining elements in the other - sequence are ignored. - - The first input sequence. - The second input sequence. - - The result sequence. - - Thrown when either of the input sequences is null. - - - Returns a sequence that yields sliding windows containing elements drawn from the input - sequence. Each window is returned as a fresh array. - The number of elements in each window. - The input sequence. - The result sequence. - Thrown when the input sequence is null. - Thrown when windowSize is not positive. - - - Returns a sequence that contains the elements generated by the given computation. - The given initial state argument is passed to the element generator. - For each IEnumerator elements in the stream are generated on-demand by applying the element - generator, until a None value is returned by the element generator. Each call to the element - generator returns a new residual state. - - The stream will be recomputed each time an IEnumerator is requested and iterated for the Seq. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - A function that takes in the current state and returns an option tuple of the next - element of the sequence and the next state value. - The initial state value. - - The result sequence. - - - Returns a sequence that when enumerated returns at most N elements. - - The maximum number of items to enumerate. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Applies the given function to successive elements, returning the first - result where the function returns "Some(x)". - - A function that transforms items from the input sequence into options. - The input sequence. - - The chosen element or None. - - Thrown when the input sequence is null. - - - Returns the index of the last element in the sequence - that satisfies the given predicate. Return None if no such element exists. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - The found index or None. - Thrown when the input sequence is null. - - - Tries to find the nth element in the sequence. - Returns None if index is negative or the input sequence does not contain enough elements. - The index of element to retrieve. - The input sequence. - The nth element of the sequence or None. - Thrown when the input sequence is null. - - - Returns the index of the first element in the sequence - that satisfies the given predicate. Return None if no such element exists. - - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - - The found index or None. - - Thrown when the input sequence is null. - - - Returns the last element for which the given function returns true. - Return None if no such element exists. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - The found element or None. - Thrown when the input sequence is null. - - - Returns the first element for which the given function returns true. - Return None if no such element exists. - - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - - The found element or None. - - Thrown when the input sequence is null. - - - Builds a list from the given collection. - - The input sequence. - - The result list. - - Thrown when the input sequence is null. - - - Builds an array from the given collection. - - The input sequence. - - The result array. - - Thrown when the input sequence is null. - - - Returns a sequence that, when iterated, yields elements of the underlying sequence while the - given predicate returns true, and then returns no further elements. - - A function that evaluates to false when no more items should be returned. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns the first N elements of the sequence. - Throws InvalidOperationException - if the count exceeds the number of elements in the sequence. Seq.truncate - returns as many items as the sequence contains instead of throwing an exception. - - The number of items to take. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - Thrown when count exceeds the number of elements - in the sequence. - - - Returns a sequence that skips 1 element of the underlying sequence and then yields the - remaining elements of the sequence. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the sum of the results generated by applying the function to each element of the sequence. - The generated elements are summed using the + operator and Zero property associated with the generated type. - - A function to transform items from the input sequence into the type that will be summed. - The input sequence. - - The computed sum. - - - Returns the sum of the elements in the sequence. - - The elements are summed using the + operator and Zero property associated with the generated type. - - The input sequence. - - The computed sum. - - - Applies a key-generating function to each element of a sequence and yield a sequence ordered - descending by keys. The keys are compared using generic comparison as implemented by Operators.compare. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - A function to transform items of the input sequence into comparable keys. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Yields a sequence ordered descending by keys. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Applies a key-generating function to each element of a sequence and yield a sequence ordered - by keys. The keys are compared using generic comparison as implemented by Operators.compare. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - A function to transform items of the input sequence into comparable keys. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Yields a sequence ordered using the given comparison function. - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - The function to compare the collection elements. - The input sequence. - The result sequence. - - - Yields a sequence ordered by keys. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that, when iterated, skips elements of the underlying sequence while the - given predicate returns true, and then yields the remaining elements of the sequence. - - A function that evaluates an element of the sequence to a boolean value. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that skips N elements of the underlying sequence and then yields the - remaining elements of the sequence. - - The number of items to skip. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when count exceeds the number of elements - in the sequence. - - - Returns a sequence that yields one item only. - - The input item. - - The result sequence of one item. - - - Like foldBack, but returns the sequence of intermediary and final results. - This function returns a sequence that digests the whole initial sequence as soon as that - sequence is iterated. As a result this function should not be used with large or infinite sequences. - - A function that updates the state with each element from the sequence. - The input sequence. - The initial state. - The resulting sequence of computed states. - Thrown when the input sequence is null. - - - Like fold, but computes on-demand and returns the sequence of intermediary and final results. - - A function that updates the state with each element from the sequence. - The initial state. - The input sequence. - - The resulting sequence of computed states. - - Thrown when the input sequence is null. - - - Returns a new sequence with the elements in reverse order. - The input sequence. - The reversed sequence. - Thrown when the input sequence is null. - - - Applies a function to each element of the sequence, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f i0 (...(f iN-1 iN)). - A function that takes in the next-to-last element of the sequence and the - current accumulated result to produce the next accumulated result. - The input sequence. - The final result of the reductions. - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Creates a sequence by replicating the given initial value. - The number of elements to replicate. - The value to replicate - The generated sequence. - - - Applies a function to each element of the sequence, threading an accumulator argument - through the computation. Begin by applying the function to the first two elements. - Then feed this result into the function along with the third element and so on. - Return the final result. - - A function that takes in the current accumulated result and the next - element of the sequence to produce the next accumulated result. - The input sequence. - - The final result of the reduction function. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Builds a new sequence object that delegates to the given sequence object. This ensures - the original sequence cannot be rediscovered and mutated by a type cast. For example, - if given an array the returned sequence will return the elements of the array, but - you cannot cast the returned sequence object to an array. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Applies the given function to successive elements, returning the first - x where the function returns "Some(x)". - - A function to transform each item of the input sequence into an option of the output type. - The input sequence. - - The selected element. - - Thrown when the input sequence is null. - Thrown when every item of the sequence - evaluates to None when the given function is applied. - - - Returns a sequence with all elements permuted according to the - specified permutation. - - Note that this function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. - - The function that maps input indices to output indices. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when indexMap does not produce a valid permutation. - - - Returns a sequence of each element in the input sequence and its predecessor, with the - exception of the first element which is only returned as the predecessor of the second element. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Views the given list as a sequence. - - The input list. - - The result sequence. - - - Views the given array as a sequence. - - The input array. - - The result sequence. - - Thrown when the input sequence is null. - - - Computes the nth element in the collection. - - The index of element to retrieve. - The input sequence. - - The nth element of the sequence. - - Thrown when the input sequence is null. - Thrown when the index is negative or the input sequence does not contain enough elements. - - - Returns the lowest of all elements of the sequence, compared via Operators.min on the function result. - - A function to transform items from the input sequence into comparable keys. - The input sequence. - - The smallest element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the lowest of all elements of the sequence, compared via Operators.min. - - The input sequence. - - The smallest element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the greatest of all elements of the sequence, compared via Operators.max on the function result. - - A function to transform items from the input sequence into comparable keys. - The input sequence. - - The largest element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the greatest of all elements of the sequence, compared via Operators.max - - The input sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - The largest element of the sequence. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding pairs of elements from the two sequences. If one input sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. The integer index passed to the - function indicates the index (from 0) of element being transformed. - - A function to transform pairs of items from the input sequences that also supplies the current index. - The first input sequence. - The second input sequence. - - The result sequence. - - Thrown when either of the input sequences is null. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The integer index passed to the - function indicates the index (from 0) of element being transformed. - - A function to transform items from the input sequence that also supplies the current index. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding triples of elements from the three sequences. If one input sequence if shorter than - the others then the remaining elements of the longer sequences are ignored. - - The function to transform triples of elements from the input sequences. - The first input sequence. - The second input sequence. - The third input sequence. - - The result sequence. - - Thrown when any of the input sequences is null. - - - Combines map and foldBack. Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The function is also used to accumulate a final value. - This function digests the whole initial sequence as soon as it is called. As a result this function should - not be used with large or infinite sequences. - The function to transform elements from the input collection and accumulate the final value. - The input collection. - The initial state. - Thrown when the input collection is null. - The collection of transformed elements, and the final accumulated value. - - - Combines map and fold. Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The function is also used to accumulate a final value. - This function digests the whole initial sequence as soon as it is called. As a result this function should - not be used with large or infinite sequences. - The function to transform elements from the input collection and accumulate the final value. - The initial state. - The input collection. - Thrown when the input collection is null. - The collection of transformed elements, and the final accumulated value. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding pairs of elements from the two sequences. If one input sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to transform pairs of items from the input sequences. - The first input sequence. - The second input sequence. - - The result sequence. - - Thrown when either of the input sequences is null. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The given function will be applied - as elements are demanded using the MoveNext method on enumerators retrieved from the - object. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - A function to transform items from the input sequence. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns the length of the sequence - - The input sequence. - - The length of the sequence. - - Thrown when the input sequence is null. - - - Applies the given function to two collections simultaneously. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. The integer passed to the - function indicates the index of element. - - A function to apply to each pair of elements from the input sequences along with their index. - The first input sequence. - The second input sequence. - - Thrown when either of the input sequences is null. - - - Applies the given function to two collections simultaneously. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to apply to each pair of elements from the input sequences. - The first input sequence. - The second input sequence. - - Thrown when either of the input sequences is null. - - - Applies the given function to each element of the collection. The integer passed to the - function indicates the index of element. - - A function to apply to each element of the sequence that can also access the current index. - The input sequence. - - Thrown when the input sequence is null. - - - Applies the given function to each element of the collection. - - A function to apply to each element of the sequence. - The input sequence. - - Thrown when the input sequence is null. - - - Computes the element at the specified index in the collection. - The index of the element to retrieve. - The input sequence. - The element at the specified index of the sequence. - Thrown when the input sequence is null. - Thrown when the index is negative or the input sequence does not contain enough elements. - - - Generates a new sequence which, when iterated, will return successive - elements by calling the given function. The results of calling the function - will not be saved, that is the function will be reapplied as necessary to - regenerate the elements. The function is passed the index of the item being - generated. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - Iteration can continue up to Int32.MaxValue. - - A function that generates an item in the sequence from a given index. - - The result sequence. - - - Generates a new sequence which, when iterated, will return successive - elements by calling the given function, up to the given count. Each element is saved after its - initialization. The function is passed the index of the item being - generated. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - The maximum number of items to generate for the sequence. - A function that generates an item in the sequence from a given index. - - The result sequence. - - Thrown when count is negative. - - - Builds a new collection whose elements are the corresponding elements of the input collection - paired with the integer index (from 0) of each element. - The input sequence. - The result sequence. - Thrown when the input sequence is null. - - - Returns true if the sequence contains no elements, false otherwise. - - The input sequence. - - True if the sequence is empty; false otherwise. - - Thrown when the input sequence is null. - - - Returns the only element of the sequence. - - The input sequence. - - The only element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input does not have precisely one element. - - - Returns the last element of the sequence. - Return None if no such element exists. - - The input sequence. - - The last element of the sequence or None. - - Thrown when the input sequence is null. - - - Returns the last element of the sequence. - The input sequence. - The last element of the sequence. - Thrown when the input sequence is null. - Thrown when the input does not have any elements. - - - Returns the first element of the sequence, or None if the sequence is empty. - - The input sequence. - - The first element of the sequence or None. - - Thrown when the input sequence is null. - - - Returns the first element of the sequence. - - The input sequence. - - The first element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input does not have any elements. - - - Applies a key-generating function to each element of a sequence and yields a sequence of - unique keys. Each unique key contains a sequence of all elements that match - to this key. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - A function that transforms an element of the sequence into a comparable key. - The input sequence. - - The result sequence. - - - Tests the all pairs of elements drawn from the two sequences satisfy the - given predicate. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to test pairs of elements from the input sequences. - The first input sequence. - The second input sequence. - - True if all pairs satisfy the predicate; false otherwise. - - Thrown when either of the input sequences is null. - - - Tests if all elements of the sequence satisfy the given predicate. - - The predicate is applied to the elements of the input sequence. If any application - returns false then the overall result is false and no further elements are tested. - Otherwise, true is returned. - - A function to test an element of the input sequence. - The input sequence. - - True if every element of the sequence satisfies the predicate; false otherwise. - - Thrown when the input sequence is null. - - - Applies a function to corresponding elements of two collections, starting from the end of the shorter collection, - threading an accumulator argument through the computation. The two sequences need not have equal lengths. - If the input function is f and the elements are i0...iN and j0...jM, N < M - then computes f i0 j0 (... (f iN jN s)...). - The function to update the state given the input elements. - The first input sequence. - The second input sequence. - The initial state. - The final state value. - Thrown when the either of the input sequences is null. - - - Applies a function to each element of the collection, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f i0 (... (f iN s)...) - The function to update the state given the input elements. - The input sequence. - The initial state. - The state object after the folding function is applied to each element of the sequence. - Thrown when the input sequence is null. - - - Applies a function to corresponding elements of two collections, threading an accumulator argument - through the computation. The two sequences need not have equal lengths: - when one sequence is exhausted any remaining elements in the other sequence are ignored. - If the input function is f and the elements are i0...iN and j0...jN - then computes f (... (f s i0 j0)...) iN jN. - The function to update the state given the input elements. - The initial state. - The first input sequence. - The second input sequence. - The final state value. - Thrown when the either of the input sequences is null. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f (... (f s i0)...) iN - - A function that updates the state with each element from the sequence. - The initial state. - The input sequence. - - The state object after the folding function is applied to each element of the sequence. - - Thrown when the input sequence is null. - - - Returns the index of the last element for which the given function returns true. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function to test whether the index of a particular element should be returned. - The input sequence. - The index of the last element for which the predicate returns true. - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns the index of the first element for which the given function returns true. - - A function to test whether the index of a particular element should be returned. - The input sequence. - - The index of the first element for which the predicate returns true. - - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns the last element for which the given function returns true. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function to test whether an item in the sequence should be returned. - The input sequence. - The last element for which the predicate returns true. - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns the first element for which the given function returns true. - - A function to test whether an item in the sequence should be returned. - The input sequence. - - The first element for which the predicate returns true. - - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true". - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - Remember sequence is lazy, effects are delayed until it is enumerated. - - A synonym for Seq.filter. - - A function to test whether each item in the input sequence should be included in the output. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true". This is a synonym for Seq.where. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - Remember sequence is lazy, effects are delayed until it is enumerated. - - A function to test whether each item in the input sequence should be included in the output. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Tests if any pair of corresponding elements of the input sequences satisfies the given predicate. - - The predicate is applied to matching elements in the two sequences up to the lesser of the - two lengths of the collections. If any application returns true then the overall result is - true and no further elements are tested. Otherwise, false is returned. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to test each pair of items from the input sequences. - The first input sequence. - The second input sequence. - - True if any result from the predicate is true; false otherwise. - - Thrown when either of the two input sequences is null. - - - Tests if any element of the sequence satisfies the given predicate. - - The predicate is applied to the elements of the input sequence. If any application - returns true then the overall result is true and no further elements are tested. - Otherwise, false is returned. - - A function to test each item of the input sequence. - The input sequence. - - True if any result from the predicate is true; false otherwise. - - Thrown when the input sequence is null. - - - Returns a new sequence with the distinct elements of the second sequence which do not apear in the first sequence, - using generic hash and equality comparisons to compare values. - - Note that this function returns a sequence that digests the whole of the first input sequence as soon as - the result sequence is iterated. As a result this function should not be used with - large or infinite sequences in the first parameter. The function makes no assumption on the ordering of the first input - sequence. - - A sequence whose elements that also occur in the second sequence will cause those elements to be - removed from the returned sequence. - A sequence whose elements that are not also in first will be returned. - - A sequence that contains the set difference of the elements of two sequences. - - Thrown when either of the two input sequences is null. - - - Creates an empty sequence. - - An empty sequence. - - - Splits the input sequence into at most count chunks. - This function returns a sequence that digests the whole initial sequence as soon as that - sequence is iterated. As a result this function should not be used with large or infinite sequences. - The maximum number of chunks. - The input sequence. - The sequence split into chunks. - Thrown when the input sequence is null. - Thrown when count is not positive. - - - Returns a sequence that contains no duplicate entries according to the - generic hash and equality comparisons on the keys returned by the given key-generating function. - If an element occurs multiple times in the sequence then the later occurrences are discarded. - - A function transforming the sequence items into comparable keys. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that contains no duplicate entries according to generic hash and - equality comparisons on the entries. - If an element occurs multiple times in the sequence then the later occurrences are discarded. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that is built from the given delayed specification of a - sequence. - - The input function is evaluated each time an IEnumerator for the sequence - is requested. - - The generating function for the sequence. - - - Applies a key-generating function to each element of a sequence and returns a sequence yielding unique - keys and their number of occurrences in the original sequence. - - Note that this function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - A function transforming each item of the input sequence into a key to be - compared against the others. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Tests if the sequence contains the specified element. - The value to locate in the input sequence. - The input sequence. - True if the input sequence contains the specified element; false otherwise. - Thrown when the input sequence is null. - - - Combines the given enumeration-of-enumerations as a single concatenated - enumeration. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - The input enumeration-of-enumerations. - - The result sequence. - - Thrown when the input sequence is null. - - - Compares two sequences using the given comparison function, element by element. - Returns the first non-zero result from the comparison function. If the end of a sequence - is reached it returns a -1 if the first sequence is shorter and a 1 if the second sequence - is shorter. - - A function that takes an element from each sequence and returns an int. - If it evaluates to a non-zero value iteration is stopped and that value is returned. - The first input sequence. - The second input sequence. - - The first non-zero value from the comparison function. - - Thrown when either of the input sequences - is null. - - - Applies the given function to each element of the sequence and concatenates all the - results. - - Remember sequence is lazy, effects are delayed until it is enumerated. - - A function to transform elements of the input sequence into the sequences - that will then be concatenated. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Divides the input sequence into chunks of size at most chunkSize. - The maximum size of each chunk. - The input sequence. - The sequence divided into chunks. - Thrown when the input sequence is null. - Thrown when chunkSize is not positive. - - - Applies the given function to each element of the list. Return - the list comprised of the results "x" for each element where - the function returns Some(x). - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not - be accessed concurrently. - - A function to transform items of type T into options of type U. - The input sequence of type T. - - The result sequence. - - Thrown when the input sequence is null. - - - Wraps a loosely-typed System.Collections sequence as a typed sequence. - - The use of this function usually requires a type annotation. - An incorrect type annotation may result in runtime type - errors. - Individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that corresponds to a cached version of the input sequence. - This result sequence will have the same elements as the input sequence. The result - can be enumerated multiple times. The input sequence will be enumerated at most - once and only as far as is necessary. Caching a sequence is typically useful when repeatedly - evaluating items in the original sequence is computationally expensive or if - iterating the sequence causes side-effects that the user does not want to be - repeated multiple times. - - Enumeration of the result sequence is thread safe in the sense that multiple independent IEnumerator - values may be used simultaneously from different threads (accesses to - the internal lookaside table are thread safe). Each individual IEnumerator - is not typically thread safe and should not be accessed concurrently. - - Once enumeration of the input sequence has started, - it's enumerator will be kept live by this object until the enumeration has completed. - At that point, the enumerator will be disposed. - - The enumerator may be disposed and underlying cache storage released by - converting the returned sequence object to type IDisposable, and calling the Dispose method - on this object. The sequence object may then be re-enumerated and a fresh enumerator will - be used. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns the average of the results generated by applying the function to each element - of the sequence. - - The elements are averaged using the + operator, DivideByInt method and Zero property - associated with the generated type. - - A function applied to transform each element of the sequence. - The input sequence. - - The average. - - Thrown when the input sequence is null. - Thrown when the input sequence has zero elements. - - - Returns the average of the elements in the sequence. - - The elements are averaged using the + operator, DivideByInt method and Zero property - associated with the element type. - - The input sequence. - - The average. - - Thrown when the input sequence is null. - Thrown when the input sequence has zero elements. - - - Wraps the two given enumerations as a single concatenated - enumeration. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed - concurrently. - - The first sequence. - The second sequence. - - The result sequence. - - Thrown when either of the two provided sequences is - null. - - - Basic operations on IEnumerables. - - - Returns a new set with the elements of the second set removed from the first. - The first input set. - The set whose elements will be removed from set1. - The set with the elements of set2 removed from set1. - - - Builds a new collection from the given enumerable object. - The input sequence. - The set containing elements. - - - Returns an ordered view of the collection as an enumerable object. - The input set. - An ordered sequence of the elements of set. - - - Builds an array that contains the elements of the set in order. - The input set. - An ordered array of the elements of set. - - - Builds a set that contains the same elements as the given array. - The input array. - A set containing the elements of array. - - - Builds a list that contains the elements of the set in order. - The input set. - An ordered list of the elements of set. - - - Builds a set that contains the same elements as the given list. - The input list. - A set containing the elements form the input list. - - - Returns the highest element in the set according to the ordering being used for the set. - The input set. - The max value from the set. - - - Returns the lowest element in the set according to the ordering being used for the set. - The input set. - The min value from the set. - - - Returns a new set with the given element removed. No exception is raised if - the set doesn't contain the given element. - The element to remove. - The input set. - The input set with value removed. - - - Splits the set into two sets containing the elements for which the given predicate - returns true and false respectively. - The function to test set elements. - The input set. - A pair of sets with the first containing the elements for which predicate returns - true and the second containing the elements for which predicate returns false. - - - Applies the given function to each element of the set, in order according - to the comparison function. - The function to apply to each element. - The input set. - - - Returns "true" if the set is empty. - The input set. - True if set is empty. - - - Computes the union of a sequence of sets. - The sequence of sets to untion. - The union of the input sets. - - - Computes the union of the two sets. - The first input set. - The second input set. - The union of set1 and set2. - - - Computes the intersection of a sequence of sets. The sequence must be non-empty. - The sequence of sets to intersect. - The intersection of the input sets. - - - Computes the intersection of the two sets. - The first input set. - The second input set. - The intersection of set1 and set2. - - - Tests if all elements of the collection satisfy the given predicate. - If the input function is f and the elements are i0...iN and "j0...jN" - then computes p i0 && ... && p iN. - The function to test set elements. - The input set. - True if all elements of set satisfy predicate. - - - Applies the given accumulating function to all the elements of the set. - The accumulating function. - The input set. - The initial state. - The final state. - - - Applies the given accumulating function to all the elements of the set - The accumulating function. - The initial state. - The input set. - The final state. - - - Returns a new collection containing the results of applying the - given function to each element of the input set. - The function to transform elements of the input set. - The input set. - A set containing the transformed elements. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns true. - The function to test set elements. - The input set. - The set containing only the elements for which predicate returns true. - - - Tests if any element of the collection satisfies the given predicate. - If the input function is predicate and the elements are i0...iN - then computes p i0 or ... or p iN. - The function to test set elements. - The input set. - True if any element of set satisfies predicate. - - - Returns the number of elements in the set. Same as size. - The input set. - The number of elements in the set. - - - Evaluates to "true" if all elements of the second set are in the first, and at least - one element of the first is not in the second. - The potential superset. - The set to test against. - True if set1 is a proper superset of set2. - - - Evaluates to "true" if all elements of the second set are in the first. - The potential superset. - The set to test against. - True if set1 is a superset of set2. - - - Evaluates to "true" if all elements of the first set are in the second, and at least - one element of the second is not in the first. - The potential subset. - The set to test against. - True if set1 is a proper subset of set2. - - - Evaluates to "true" if all elements of the first set are in the second - The potential subset. - The set to test against. - True if set1 is a subset of set2. - - - Evaluates to "true" if the given element is in the given set. - The element to test. - The input set. - True if element is in set. - - - Returns a new set with an element added to the set. No exception is raised if - the set already contains the given element. - The value to add. - The input set. - A new set containing value. - - - The set containing the given element. - The value for the set to contain. - The set containing value. - - - The empty set for the type 'T. - - - Functional programming operators related to the Set<_> type. - - - Gets the default cancellation token for executing asynchronous computations. - The default CancellationToken. - - - Creates an asynchronous computation that returns the CancellationToken governing the execution - of the computation. - In async { let! token = Async.CancellationToken ...} token can be used to initiate other - asynchronous operations that will cancel cooperatively with this workflow. - An asynchronous computation capable of retrieving the CancellationToken from a computation - expression. - - - Creates an asynchronous computation that executes computation. - If this computation is cancelled before it completes then the computation generated by - running compensation is executed. - The input asynchronous computation. - The function to be run if the computation is cancelled. - An asynchronous computation that runs the compensation if the input computation - is cancelled. - - - Creates an asynchronous computation that queues a work item that runs - its continuation. - A computation that generates a new work item in the thread pool. - - - Creates an asynchronous computation that creates a new thread and runs - its continuation in that thread. - A computation that will execute on a new thread. - - - Creates an asynchronous computation that runs - its continuation using syncContext.Post. If syncContext is null - then the asynchronous computation is equivalent to SwitchToThreadPool(). - The synchronization context to accept the posted computation. - An asynchronous computation that uses the syncContext context to execute. - - - Runs an asynchronous computation, starting immediately on the current operating system - thread. Call one of the three continuations when the operation completes. - If no cancellation token is provided then the default cancellation token - is used. - The asynchronous computation to execute. - The function called on success. - The function called on exception. - The function called on cancellation. - The CancellationToken to associate with the computation. - The default is used if this parameter is not provided. - - - Runs an asynchronous computation, starting immediately on the current operating system - thread. - If no cancellation token is provided then the default cancellation token is used. - The asynchronous computation to execute. - The CancellationToken to associate with the computation. - The default is used if this parameter is not provided. - - - Creates an asynchronous computation which starts the given computation as a System.Threading.Tasks.Task - - - Starts a child computation within an asynchronous workflow. - This allows multiple asynchronous computations to be executed simultaneously. - - This method should normally be used as the immediate - right-hand-side of a let! binding in an F# asynchronous workflow, that is, - - async { ... - let! completor1 = childComputation1 |> Async.StartChild - let! completor2 = childComputation2 |> Async.StartChild - ... - let! result1 = completor1 - let! result2 = completor2 - ... } - - When used in this way, each use of StartChild starts an instance of childComputation - and returns a completor object representing a computation to wait for the completion of the operation. - When executed, the completor awaits the completion of childComputation. - The child computation. - The timeout value in milliseconds. If one is not provided - then the default value of -1 corresponding to System.Threading.Timeout.Infinite. - A new computation that waits for the input computation to finish. - - - Executes a computation in the thread pool. - If no cancellation token is provided then the default cancellation token is used. - A System.Threading.Tasks.Task that will be completed - in the corresponding state once the computation terminates (produces the result, throws exception or gets canceled) - - - - Starts the asynchronous computation in the thread pool. Do not await its result. - - If no cancellation token is provided then the default cancellation token is used. - The computation to run asynchronously. - The cancellation token to be associated with the computation. - If one is not supplied, the default cancellation token is used. - - - Creates an asynchronous computation that will sleep for the given time. This is scheduled - using a System.Threading.Timer object. The operation will not block operating system threads - for the duration of the wait. - The number of milliseconds to sleep. - An asynchronous computation that will sleep for the given time. - Thrown when the due time is negative - and not infinite. - - - Runs the asynchronous computation and await its result. - - If an exception occurs in the asynchronous computation then an exception is re-raised by this - function. - - If no cancellation token is provided then the default cancellation token is used. - - The timeout parameter is given in milliseconds. A value of -1 is equivalent to - System.Threading.Timeout.Infinite. - The computation to run. - The amount of time in milliseconds to wait for the result of the - computation before raising a System.TimeoutException. If no value is provided - for timeout then a default of -1 is used to correspond to System.Threading.Timeout.Infinite. - The cancellation token to be associated with the computation. - If one is not supplied, the default cancellation token is used. - The result of the computation. - - - Creates an asynchronous computation that executes all the given asynchronous computations, - initially queueing each as work items and using a fork/join pattern. - - If all child computations succeed, an array of results is passed to the success continuation. - - If any child computation raises an exception, then the overall computation will trigger an - exception, and cancel the others. - - The overall computation will respond to cancellation while executing the child computations. - If cancelled, the computation will cancel any remaining child computations but will still wait - for the other child computations to complete. - A sequence of distinct computations to be parallelized. - A computation that returns an array of values from the sequence of input computations. - - - Generates a scoped, cooperative cancellation handler for use within an asynchronous workflow. - - For example, - async { use! holder = Async.OnCancel interruption ... } - generates an asynchronous computation where, if a cancellation happens any time during - the execution of the asynchronous computation in the scope of holder, then action - interruption is executed on the thread that is performing the cancellation. This can - be used to arrange for a computation to be asynchronously notified that a cancellation - has occurred, e.g. by setting a flag, or deregistering a pending I/O action. - The function that is executed on the thread performing the - cancellation. - An asynchronous computation that triggers the interruption if it is cancelled - before being disposed. - - - Creates an asynchronous computation that runs the given computation and ignores - its result. - The input computation. - A computation that is equivalent to the input computation, but disregards the result. - - - Creates an asynchronous computation that captures the current - success, exception and cancellation continuations. The callback must - eventually call exactly one of the given continuations. - The function that accepts the current success, exception, and cancellation - continuations. - An asynchronous computation that provides the callback with the current continuations. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. This overlaod should be used if the operation is - qualified by three arguments. For example, - Async.FromBeginEnd(arg1,arg2,arg3,ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The first argument for the operation. - The second argument for the operation. - The third argument for the operation. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. This overlaod should be used if the operation is - qualified by two arguments. For example, - Async.FromBeginEnd(arg1,arg2,ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The first argument for the operation. - The second argument for the operation. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. This overlaod should be used if the operation is - qualified by one argument. For example, - Async.FromBeginEnd(place,ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The argument for the operation. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. For example, - Async.FromBeginEnd(ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation that executes computation. - If this computation completes successfully then return Choice1Of2 with the returned - value. If this computation raises an exception before it completes then return Choice2Of2 - with the raised exception. - The input computation that returns the type T. - A computation that returns a choice of type T or exception. - - - Raises the cancellation condition for the most recent set of asynchronous computations started - without any specific CancellationToken. Replaces the global CancellationTokenSource with a new - global token source for any asynchronous computations created after this point without any - specific CancellationToken. - - - Creates an asynchronous computation that will wait on the given WaitHandle. - - The computation returns true if the handle indicated a result within the given timeout. - The WaitHandle that can be signalled. - The timeout value in milliseconds. If one is not provided - then the default value of -1 corresponding to System.Threading.Timeout.Infinite. - An asynchronous computation that waits on the given WaitHandle. - - - - Return an asynchronous computation that will wait for the given task to complete and return - its result. - - - - - Return an asynchronous computation that will wait for the given task to complete and return - its result. - - - - Creates an asynchronous computation that will wait on the IAsyncResult. - - The computation returns true if the handle indicated a result within the given timeout. - The IAsyncResult to wait on. - The timeout value in milliseconds. If one is not provided - then the default value of -1 corresponding to System.Threading.Timeout.Infinite. - An asynchronous computation that waits on the given IAsyncResult. - - - Creates an asynchronous computation that waits for a single invocation of a CLI - event by adding a handler to the event. Once the computation completes or is - cancelled, the handler is removed from the event. - - The computation will respond to cancellation while waiting for the event. If a - cancellation occurs, and cancelAction is specified, then it is executed, and - the computation continues to wait for the event. - - If cancelAction is not specified, then cancellation causes the computation - to cancel immediately. - The event to handle once. - An optional function to execute instead of cancelling when a - cancellation is issued. - An asynchronous computation that waits for the event to be invoked. - - - Creates three functions that can be used to implement the .NET Asynchronous - Programming Model (APM) for a given asynchronous computation. - - The functions should normally be published as members with prefix Begin, - End and Cancel, and can be used within a type definition as follows: - - let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun arg -> computation) - member x.BeginSomeOperation(arg,callback,state:obj) = beginAction(arg,callback,state) - member x.EndSomeOperation(iar) = endAction(iar) - member x.CancelSomeOperation(iar) = cancelAction(iar) - - - If the asynchronous computation takes no arguments, then AsBeginEnd is used as follows: - - let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun () -> computation) - member x.BeginSomeOperation(callback,state:obj) = beginAction((),callback,state) - member x.EndSomeOperation(iar) = endAction(iar) - member x.CancelSomeOperation(iar) = cancelAction(iar) - - - - If the asynchronous computation takes two arguments, then AsBeginEnd is used as follows: - - let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun arg1 arg2 -> computation) - member x.BeginSomeOperation(arg1,arg2,callback,state:obj) = beginAction((),callback,state) - member x.EndSomeOperation(iar) = endAction(iar) - member x.CancelSomeOperation(iar) = cancelAction(iar) - - - In each case, the resulting API will be familiar to programmers in other CLI languages and - is a useful way to publish asynchronous computations in CLI components. - A function generating the asynchronous computation to split into the traditional - .NET Asynchronous Programming Model. - A tuple of the begin, end, and cancel members. - - - This static class holds members for creating and manipulating asynchronous computations. - - - Creates an asynchronous computation that just returns (). - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of empty else branches in the - async { ... } computation expression syntax. - An asynchronous computation that returns (). - - - Creates an asynchronous computation that runs computation repeatedly - until guard() becomes false. - - A cancellation check is performed whenever the computation is executed. - - The existence of this method permits the use of while in the - async { ... } computation expression syntax. - The function to determine when to stop executing computation. - The function to be executed. Equivalent to the body - of a while expression. - An asynchronous computation that behaves similarly to a while loop when run. - - - Creates an asynchronous computation that runs binder(resource). - The action resource.Dispose() is executed as this computation yields its result - or if the asynchronous computation exits by an exception or by cancellation. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of use and use! in the - async { ... } computation expression syntax. - The resource to be used and disposed. - The function that takes the resource and returns an asynchronous - computation. - An asynchronous computation that binds and eventually disposes resource. - - - Creates an asynchronous computation that runs computation and returns its result. - If an exception happens then catchHandler(exn) is called and the resulting computation executed instead. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of try/with in the - async { ... } computation expression syntax. - The input computation. - The function to run when computation throws an exception. - An asynchronous computation that executes computation and calls catchHandler if an - exception is thrown. - - - Creates an asynchronous computation that runs computation. The action compensation is executed - after computation completes, whether computation exits normally or by an exception. If compensation raises an exception itself - the original exception is discarded and the new exception becomes the overall result of the computation. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of try/finally in the - async { ... } computation expression syntax. - The input computation. - The action to be run after computation completes or raises an - exception (including cancellation). - An asynchronous computation that executes computation and compensation aftewards or - when an exception is raised. - - - Delegates to the input computation. - - The existence of this method permits the use of return! in the - async { ... } computation expression syntax. - The input computation. - The input computation. - - - Creates an asynchronous computation that returns the result v. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of return in the - async { ... } computation expression syntax. - The value to return from the computation. - An asynchronous computation that returns value when executed. - - - Creates an asynchronous computation that enumerates the sequence seq - on demand and runs body for each element. - - A cancellation check is performed on each iteration of the loop. - - The existence of this method permits the use of for in the - async { ... } computation expression syntax. - The sequence to enumerate. - A function to take an item from the sequence and create - an asynchronous computation. Can be seen as the body of the for expression. - An asynchronous computation that will enumerate the sequence and run body - for each element. - - - Creates an asynchronous computation that runs generator. - - A cancellation check is performed when the computation is executed. - The function to run. - An asynchronous computation that runs generator. - - - Creates an asynchronous computation that first runs computation1 - and then runs computation2, returning the result of computation2. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of expression sequencing in the - async { ... } computation expression syntax. - The first part of the sequenced computation. - The second part of the sequenced computation. - An asynchronous computation that runs both of the computations sequentially. - - - Creates an asynchronous computation that runs computation, and when - computation generates a result T, runs binder res. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of let! in the - async { ... } computation expression syntax. - The computation to provide an unbound result. - The function to bind the result of computation. - An asynchronous computation that performs a monadic bind on the result - of computation. - - - - Generate an object used to build asynchronous computations using F# computation expressions. The value - 'async' is a pre-defined instance of this type. - - A cancellation check is performed when the computation is executed. - - - - The type of the async operator, used to build workflows for asynchronous computations. - - - Sends a reply to a PostAndReply message. - The value to send. - - - A handle to a capability to reply to a PostAndReply message. - - - A compositional asynchronous computation, which, when run, will eventually produce a value - of type T, or else raises an exception. - - Asynchronous computations are normally specified using an F# computation expression. - - When run, asynchronous computations have two modes: as a work item (executing synchronous - code), or as a wait item (waiting for an event or I/O completion). - - When run, asynchronous computations can be governed by CancellationToken. This can usually - be specified when the async computation is started. The associated CancellationTokenSource - may be used to cancel the asynchronous computation. Asynchronous computations built using - computation expressions can check the cancellation condition regularly. Synchronous - computations within an asynchronous computation do not automatically check this condition. - - - Publishes the event as a first class event value. - - - Triggers the event using the given parameters. - The parameters for the event. - - - Creates an event object suitable for implementing an arbitrary type of delegate. - The event object. - - - Event implementations for an arbitrary type of delegate. - - - Publishes an observation as a first class value. - - - Triggers an observation using the given parameters. - The event parameters. - - - Creates an observable object. - The created event. - - - Event implementations for the IEvent<_> type. - - - Publishes the event as a first class event value. - - - Triggers the event using the given sender object and parameters. The sender object may be null. - The object triggering the event. - The parameters for the event. - - - Creates an event object suitable for delegate types following the standard .NET Framework convention of a first 'sender' argument. - The created event. - - - Event implementations for a delegate types following the standard .NET Framework convention of a first 'sender' argument. - - - A delegate type associated with the F# event type IEvent<_> - The object that fired the event. - The event arguments. - - - Remove a listener delegate from an event listener store. - The delegate to be removed from the event listener store. - - - Connect a handler delegate object to the event. A handler can - be later removed using RemoveHandler. The listener will - be invoked when the event is fired. - A delegate to be invoked when the event is fired. - - - First class event values for arbitrary delegate types. - - F# gives special status to member properties compatible with type IDelegateEvent and - tagged with the CLIEventAttribute. In this case the F# compiler generates approriate - CLI metadata to make the member appear to other CLI languages as a CLI event. - - - First-class listening points (i.e. objects that permit you to register a callback - activated when the event is triggered). - - - First class event values for CLI events conforming to CLI Framework standards. - - - The type of delayed computations. - - Use the values in the Lazy module to manipulate - values of this type, and the notation lazy expr to create values - of type . - - - Raises a timeout exception if a message not received in this amount of time. By default - no timeout is used. - - - Occurs when the execution of the agent results in an exception. - - - Occurs when the execution of the agent results in an exception. - - - Raises a timeout exception if a message not received in this amount of time. By default - no timeout is used. - - - Returns the number of unprocessed messages in the message queue of the agent. - - - Occurs when the execution of the agent results in an exception. - - - Scans for a message by looking through messages in arrival order until scanner - returns a Some value. Other messages remain in the queue. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - The function to return None if the message is to be skipped - or Some if the message is to be processed and removed from the queue. - An optional timeout in milliseconds. Defaults to -1 which corresponds - to System.Threading.Timeout.Infinite. - An asynchronous computation that scanner built off the read message. - - - Waits for a message. This will consume the first message in arrival order. - - This method is for use within the body of the agent. - - Returns None if a timeout is given and the timeout is exceeded. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - An optional timeout in milliseconds. Defaults to -1 which - corresponds to System.Threading.Timeout.Infinite. - An asynchronous computation that returns the received message or - None if the timeout is exceeded. - - - Like PostAndReply, but returns None if no reply within the timeout period. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - The reply from the agent or None if the timeout expires. - - - Starts the agent. - - - Creates and starts an agent. The body function is used to generate the asynchronous - computation executed by the agent. - The function to produce an asynchronous computation that will be executed - as the read loop for the MailboxProcessor when Start is called. - An optional cancellation token for the body. - Defaults to Async.DefaultCancellationToken. - The created MailboxProcessor. - - - Scans for a message by looking through messages in arrival order until scanner - returns a Some value. Other messages remain in the queue. - - Returns None if a timeout is given and the timeout is exceeded. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - The function to return None if the message is to be skipped - or Some if the message is to be processed and removed from the queue. - An optional timeout in milliseconds. Defaults to -1 which corresponds - to System.Threading.Timeout.Infinite. - An asynchronous computation that scanner built off the read message. - Thrown when the timeout is exceeded. - - - Waits for a message. This will consume the first message in arrival order. - - This method is for use within the body of the agent. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - An optional timeout in milliseconds. Defaults to -1 which corresponds - to System.Threading.Timeout.Infinite. - An asynchronous computation that returns the received message. - Thrown when the timeout is exceeded. - - - Like AsyncPostAndReply, but returns None if no reply within the timeout period. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - An asynchronous computation that will return the reply or None if the timeout expires. - - - Posts a message to an agent and await a reply on the channel, synchronously. - - The message is generated by applying buildMessage to a new reply channel - to be incorporated into the message. The receiving agent must process this - message and invoke the Reply method on this reply channel precisely once. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - The reply from the agent. - - - Posts a message to an agent and await a reply on the channel, asynchronously. - - The message is generated by applying buildMessage to a new reply channel - to be incorporated into the message. The receiving agent must process this - message and invoke the Reply method on this reply channel precisely once. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - An asychronous computation that will wait for the reply from the agent. - - - Posts a message to the message queue of the MailboxProcessor, asynchronously. - The message to post. - - - Creates an agent. The body function is used to generate the asynchronous - computation executed by the agent. This function is not executed until - Start is called. - The function to produce an asynchronous computation that will be executed - as the read loop for the MailboxProcessor when Start is called. - An optional cancellation token for the body. - Defaults to Async.DefaultCancellationToken. - The created MailboxProcessor. - - - A message-processing agent which executes an asynchronous computation. - - The agent encapsulates a message queue that supports multiple-writers and - a single reader agent. Writers send messages to the agent by using the Post - method and its variations. - - The agent may wait for messages using the Receive or TryReceive methods or - scan through all available messages using the Scan or TryScan method. - - - Connects a listener function to the observable. The listener will - be invoked for each observation. The listener can be removed by - calling Dispose on the returned IDisposable object. - The function to be called for each observation. - An object that will remove the listener if disposed. - - - Permanently connects a listener function to the observable. The listener will - be invoked for each observation. - The function to be called for each observation. - - - Returns an asynchronous computation that will write the given bytes to the stream. - The buffer to write from. - An optional offset as a number of bytes in the stream. - An optional number of bytes to write to the stream. - An asynchronous computation that will write the given bytes to the stream. - Thrown when the sum of offset and count is longer than - the buffer length. - Thrown when offset or count is negative. - - - Returns an asynchronous computation that will read the given number of bytes from the stream. - The number of bytes to read. - An asynchronous computation that returns the read byte[] when run. - - - Returns an asynchronous computation that will read from the stream into the given buffer. - The buffer to read into. - An optional offset as a number of bytes in the stream. - An optional number of bytes to read from the stream. - An asynchronous computation that will read from the stream into the given buffer. - Thrown when the sum of offset and count is longer than - the buffer length. - Thrown when offset or count is negative. - - - A module of extension members providing asynchronous operations for some basic CLI types related to concurrency and I/O. - - - Returns a new event that triggers on the second and subsequent triggerings of the input event. - The Nth triggering of the input event passes the arguments from the N-1th and Nth triggering as - a pair. The argument passed to the N-1th triggering is held in hidden internal state until the - Nth triggering occurs. - The input event. - An event that triggers on pairs of consecutive values passed from the source event. - - - Runs the given function each time the given event is triggered. - The function to call when the event is triggered. - The input event. - - - Returns a new event consisting of the results of applying the given accumulating function - to successive values triggered on the input event. An item of internal state - records the current value of the state parameter. The internal state is not locked during the - execution of the accumulation function, so care should be taken that the - input IEvent not triggered by multiple threads simultaneously. - The function to update the state with each event value. - The initial state. - The input event. - An event that fires on the updated state values. - - - Returns a new event which fires on a selection of messages from the original event. - The selection function takes an original message to an optional new message. - The function to select and transform event values to pass on. - The input event. - An event that fires only when the chooser returns Some. - - - Returns a new event that listens to the original event and triggers the - first resulting event if the application of the function to the event arguments - returned a Choice1Of2, and the second event if it returns a Choice2Of2. - The function to transform event values into one of two types. - The input event. - A tuple of events. The first fires whenever splitter evaluates to Choice1of1 and - the second fires whenever splitter evaluates to Choice2of2. - - - Returns a new event that listens to the original event and triggers the - first resulting event if the application of the predicate to the event arguments - returned true, and the second event if it returned false. - The function to determine which output event to trigger. - The input event. - A tuple of events. The first is triggered when the predicate evaluates to true - and the second when the predicate evaluates to false. - - - Returns a new event that listens to the original event and triggers the resulting - event only when the argument to the event passes the given function. - The function to determine which triggers from the event to propagate. - The input event. - An event that only passes values that pass the predicate. - - - Returns a new event that passes values transformed by the given function. - The function to transform event values. - The input event. - An event that passes the transformed values. - - - Fires the output event when either of the input events fire. - The first input event. - The second input event. - An event that fires when either of the input events fire. - - - Forces the execution of this value and return its result. Same as Value. Mutual exclusion is used to - prevent other threads also computing the value. - The value of the Lazy object. - - - Creates a lazy computation that evaluates to the given value when forced. - The input value. - The created Lazy object. - - - Creates a lazy computation that evaluates to the result of the given function when forced. - The function to provide the value when needed. - The created Lazy object. - - - Extensions related to Lazy values. - - - Returns a new observable that triggers on the second and subsequent triggerings of the input observable. - The Nth triggering of the input observable passes the arguments from the N-1th and Nth triggering as - a pair. The argument passed to the N-1th triggering is held in hidden internal state until the - Nth triggering occurs. - - For each observer, the registered intermediate observing object is not thread safe. - That is, observations arising from the source must not be triggered concurrently - on different threads. - The input Observable. - An Observable that triggers on successive pairs of observations from the input Observable. - - - Creates an observer which subscribes to the given observable and which calls - the given function for each observation. - The function to be called on each observation. - The input Observable. - An object that will remove the callback if disposed. - - - Creates an observer which permanently subscribes to the given observable and which calls - the given function for each observation. - The function to be called on each observation. - The input Observable. - - - Returns an observable which, for each observer, allocates an item of state - and applies the given accumulating function to successive values arising from - the input. The returned object will trigger observations for each computed - state value, excluding the initial value. The returned object propagates - all errors arising from the source and completes when the source completes. - - For each observer, the registered intermediate observing object is not thread safe. - That is, observations arising from the source must not be triggered concurrently - on different threads. - The function to update the state with each observation. - The initial state. - The input Observable. - An Observable that triggers on the updated state values. - - - Returns an observable which chooses a projection of observations from the source - using the given function. The returned object will trigger observations x - for which the splitter returns Some x. The returned object also propagates - all errors arising from the source and completes when the source completes. - The function that returns Some for observations to be propagated - and None for observations to ignore. - The input Observable. - An Observable that only propagates some of the observations from the source. - - - Returns two observables which split the observations of the source by the - given function. The first will trigger observations x for which the - splitter returns Choice1Of2 x. The second will trigger observations - y for which the splitter returns Choice2Of2 y The splitter is - executed once for each subscribed observer. Both also propagate error - observations arising from the source and each completes when the source - completes. - The function that takes an observation an transforms - it into one of the two output Choice types. - The input Observable. - A tuple of Observables. The first triggers when splitter returns Choice1of2 - and the second triggers when splitter returns Choice2of2. - - - Returns two observables which partition the observations of the source by - the given function. The first will trigger observations for those values - for which the predicate returns true. The second will trigger observations - for those values where the predicate returns false. The predicate is - executed once for each subscribed observer. Both also propagate all error - observations arising from the source and each completes when the source - completes. - The function to determine which output Observable will trigger - a particular observation. - The input Observable. - A tuple of Observables. The first triggers when the predicate returns true, and - the second triggers when the predicate returns false. - - - Returns an observable which filters the observations of the source - by the given function. The observable will see only those observations - for which the predicate returns true. The predicate is executed once for - each subscribed observer. The returned object also propagates error - observations arising from the source and completes when the source completes. - The function to apply to observations to determine if it should - be kept. - The input Observable. - An Observable that filters observations based on filter. - - - Returns an observable which transforms the observations of the source by the - given function. The transformation function is executed once for each - subscribed observer. The returned object also propagates error observations - arising from the source and completes when the source completes. - The function applied to observations from the source. - The input Observable. - An Observable of the type specified by mapping. - - - Returns an observable for the merged observations from the sources. - The returned object propagates success and error values arising - from either source and completes when both the sources have completed. - - For each observer, the registered intermediate observing object is not - thread safe. That is, observations arising from the sources must not - be triggered concurrently on different threads. - The first Observable. - The second Observable. - An Observable that propagates information from both sources. - - - Basic operations on first class event and other observable objects. - - - Returns an asynchronous computation that, when run, will wait for the download of the given URI to specified file. - The URI to retrieve. - The filename to save download to. - An asynchronous computation that will wait for the download of the URI to specified file. - - - Returns an asynchronous computation that, when run, will wait for the download of the given URI. - The URI to retrieve. - An asynchronous computation that will wait for the download of the URI. - - - Returns an asynchronous computation that, when run, will wait for the download of the given URI. - The URI to retrieve. - An asynchronous computation that will wait for the download of the URI. - - - Returns an asynchronous computation that, when run, will wait for a response to the given WebRequest. - An asynchronous computation that waits for response to the WebRequest. - - - A module of extension members providing asynchronous operations for some basic Web operations. - - - Creates an instance of the attribute - AbstractClassAttribute - - - Adding this attribute to class definition makes it abstract, which means it need not - implement all its methods. Instances of abstract classes may not be constructed directly. - - - The value of the attribute, indicating whether the type allows the null literal or not - - - Creates an instance of the attribute with the specified value - AllowNullLiteralAttribute - - - Creates an instance of the attribute - AllowNullLiteralAttribute - - - Adding this attribute to a type lets the 'null' literal be used for the type - within F# code. This attribute may only be added to F#-defined class or - interface types. - - - Indicates the namespace or module to be automatically opened when an assembly is referenced - or an enclosing module opened. - - - Creates an attribute used to mark a namespace or module path to be 'automatically opened' when an assembly is referenced - The namespace or module to be automatically opened when an assembly is referenced - or an enclosing module opened. - AutoOpenAttribute - - - Creates an attribute used to mark a module as 'automatically opened' when the enclosing namespace is opened - AutoOpenAttribute - - - This attribute is used for two purposes. When applied to an assembly, it must be given a string - argument, and this argument must indicate a valid module or namespace in that assembly. Source - code files compiled with a reference to this assembly are processed in an environment - where the given path is automatically opened. - - When applied to a module within an assembly, then the attribute must not be given any arguments. - When the enclosing namespace is opened in user source code, the module is also implicitly opened. - - - The value of the attribute, indicating whether the type is automatically marked serializable or not - - - Creates an instance of the attribute - Indicates whether the type should be serializable by default. - AutoSerializableAttribute - - - Adding this attribute to a type with value 'false' disables the behaviour where F# makes the - type Serializable by default. - - - Creates an instance of the attribute - CLIEventAttribute - - - Adding this attribute to a property with event type causes it to be compiled with as a CLI - metadata event, through a syntactic translation to a pair of 'add_EventName' and - 'remove_EventName' methods. - - - Creates an instance of the attribute - CLIMutableAttribute - - - Adding this attribute to a record type causes it to be compiled to a CLI representation - with a default constructor with property getters and setters. - - - Choice 2 of 2 choices - - - Choice 1 of 2 choices - - - Helper types for active patterns with 2 choices. - - - Choice 3 of 3 choices - - - Choice 2 of 3 choices - - - Choice 1 of 3 choices - - - Helper types for active patterns with 3 choices. - - - Choice 4 of 4 choices - - - Choice 3 of 4 choices - - - Choice 2 of 4 choices - - - Choice 1 of 4 choices - - - Helper types for active patterns with 4 choices. - - - Choice 5 of 5 choices - - - Choice 4 of 5 choices - - - Choice 3 of 5 choices - - - Choice 2 of 5 choices - - - Choice 1 of 5 choices - - - Helper types for active patterns with 5 choices. - - - Choice 6 of 6 choices - - - Choice 5 of 6 choices - - - Choice 4 of 6 choices - - - Choice 3 of 6 choices - - - Choice 2 of 6 choices - - - Choice 1 of 6 choices - - - Helper types for active patterns with 6 choices. - - - Choice 7 of 7 choices - - - Choice 6 of 7 choices - - - Choice 5 of 7 choices - - - Choice 4 of 7 choices - - - Choice 3 of 7 choices - - - Choice 2 of 7 choices - - - Choice 1 of 7 choices - - - Helper types for active patterns with 7 choices. - - - Creates an instance of the attribute - ClassAttribute - - - Adding this attribute to a type causes it to be represented using a CLI class. - - - Creates an instance of the attribute - ComparisonConditionalOnAttribute - - - This attribute is used to indicate a generic container type satisfies the F# 'comparison' - constraint only if a generic argument also satisfies this constraint. For example, adding - this attribute to parameter 'T on a type definition C<'T> means that a type C<X> only supports - comparison if the type X also supports comparison and all other conditions for C<X> to support - comparison are also met. The type C<'T> can still be used with other type arguments, but a type such - as C<(int -> int)> will not support comparison because the type (int -> int) is an F# function type - and does not support comparison. - - This attribute will be ignored if it is used on the generic parameters of functions or methods. - - - Indicates the number of arguments in each argument group - - - Creates an instance of the attribute - Indicates the number of arguments in each argument group. - CompilationArgumentCountsAttribute - - - This attribute is generated automatically by the F# compiler to tag functions and members - that accept a partial application of some of their arguments and return a residual function - - - Indicates the variant number of the entity, if any, in a linear sequence of elements with F# source code - - - Indicates the type definitions needed to resolve the source construct - - - Indicates the relationship between the compiled entity and F# source code - - - Indicates the sequence number of the entity, if any, in a linear sequence of elements with F# source code - - - Indicates the resource the source construct relates to - - - Creates an instance of the attribute - Indicates the type definitions needed to resolve the source construct. - CompilationMappingAttribute - - - Creates an instance of the attribute - Indicates the type of source construct. - CompilationMappingAttribute - - - Creates an instance of the attribute - Indicates the type of source construct. - CompilationMappingAttribute - - - Creates an instance of the attribute - Indicates the type of source construct. - CompilationMappingAttribute - - - This attribute is inserted automatically by the F# compiler to tag types - and methods in the generated CLI code with flags indicating the correspondence - with original source constructs. It is used by the functions in the - Microsoft.FSharp.Reflection namespace to reverse-map compiled constructs to - their original forms. It is not intended for use from user code. - - - Indicates one or more adjustments to the compiled representation of an F# type or member - - - Creates an instance of the attribute - Indicates adjustments to the compiled representation of the type or member. - CompilationRepresentationAttribute - - - This attribute is used to adjust the runtime representation for a type. - For example, it may be used to note that the null representation - may be used for a type. This affects how some constructs are compiled. - - - Compile a property as a CLI event. - - - Permit the use of null as a representation for nullary discriminators in a discriminated union. - - - append 'Module' to the end of a module whose name clashes with a type name in the same namespace. - - - Compile a member as 'instance' even if null is used as a representation for this type. - - - Compile an instance member as 'static' . - - - No special compilation representation. - - - Indicates one or more adjustments to the compiled representation of an F# type or member. - - - Indicates the name of the entity in F# source code - - - Creates an instance of the attribute - The name of the method in source. - CompilationSourceNameAttribute - - - This attribute is inserted automatically by the F# compiler to tag - methods which are given the 'CompiledName' attribute. It is not intended - for use from user code. - - - The name of the value as it appears in compiled code - - - Creates an instance of the attribute - The name to use in compiled code. - CompiledNameAttribute - - - Adding this attribute to a value or function definition in an F# module changes the name used - for the value in compiled CLI code. - - - Indicates if the construct should always be hidden in an editing environment. - - - Indicates if the message should indicate a compiler error. Error numbers less than - 10000 are considered reserved for use by the F# compiler and libraries. - - - Indicates the number associated with the message. - - - Indicates the warning message to be emitted when F# source code uses this construct - - - Indicates if the construct should always be hidden in an editing environment. - - - Indicates if the message should indicate a compiler error. Error numbers less than - 10000 are considered reserved for use by the F# compiler and libraries. - - - Creates an instance of the attribute. - - - Indicates that a message should be emitted when F# source code uses this construct. - - - Creates an instance of the attribute - CustomComparisonAttribute - - - Adding this attribute to a type indicates it is a type with a user-defined implementation of comparison. - - - Creates an instance of the attribute - CustomEqualityAttribute - - - Adding this attribute to a type indicates it is a type with a user-defined implementation of equality. - - - Indicates if the custom operation maintains the variable space of the query of computation expression through the use of a bind operation - - - Indicates if the custom operation maintains the variable space of the query of computation expression - - - Indicates the name used for the 'on' part of the custom query operator for join-like operators - - - Indicates if the custom operation is an operation similar to a zip in a sequence computation, supporting two inputs - - - Indicates if the custom operation is an operation similar to a join in a sequence computation, supporting two inputs and a correlation constraint - - - Indicates if the custom operation is an operation similar to a group join in a sequence computation, supporting two inputs and a correlation constraint, and generating a group - - - Indicates if the custom operation supports the use of 'into' immediately after the use of the operation in a query or other computation expression to consume the results of the operation - - - Get the name of the custom operation when used in a query or other computation expression - - - Indicates if the custom operation maintains the variable space of the query of computation expression through the use of a bind operation - - - Indicates if the custom operation maintains the variable space of the query of computation expression - - - Indicates the name used for the 'on' part of the custom query operator for join-like operators - - - Indicates if the custom operation is an operation similar to a zip in a sequence computation, supporting two inputs - - - Indicates if the custom operation is an operation similar to a join in a sequence computation, supporting two inputs and a correlation constraint - - - Indicates if the custom operation is an operation similar to a group join in a sequence computation, supporting two inputs and a correlation constraint, and generating a group - - - Indicates if the custom operation supports the use of 'into' immediately after the use of the operation in a query or other computation expression to consume the results of the operation - - - Creates an instance of the attribute - CustomOperationAttribute - - - - Indicates that a member on a computation builder type is a custom query operator, - and indicates the name of that operator. - - - - The value of the attribute, indicating whether the type has a default augmentation or not - - - Creates an instance of the attribute - Indicates whether to generate helper members on the CLI class representing a discriminated - union. - DefaultAugmentationAttribute - - - Adding this attribute to a discriminated union with value false - turns off the generation of standard helper member tester, constructor - and accessor members for the generated CLI class for that type. - - - Indicates if a constraint is asserted that the field type supports 'null' - - - Creates an instance of the attribute - Indicates whether to assert that the field type supports null. - DefaultValueAttribute - - - Creates an instance of the attribute - DefaultValueAttribute - - - Adding this attribute to a field declaration means that the field is - not initialized. During type checking a constraint is asserted that the field type supports 'null'. - If the 'check' value is false then the constraint is not asserted. - - - Creates an instance of the attribute - EntryPointAttribute - - - Adding this attribute to a function indicates it is the entrypoint for an application. - If this attribute is not specified for an EXE then the initialization implicit in the - module bindings in the last file in the compilation sequence are used as the entrypoint. - - - Creates an instance of the attribute - EqualityConditionalOnAttribute - - - This attribute is used to indicate a generic container type satisfies the F# 'equality' - constraint only if a generic argument also satisfies this constraint. For example, adding - this attribute to parameter 'T on a type definition C<'T> means that a type C<X> only supports - equality if the type X also supports equality and all other conditions for C<X> to support - equality are also met. The type C<'T> can still be used with other type arguments, but a type such - as C<(int -> int)> will not support equality because the type (int -> int) is an F# function type - and does not support equality. - - This attribute will be ignored if it is used on the generic parameters of functions or methods. - - - Indicates the warning message to be emitted when F# source code uses this construct - - - Creates an instance of the attribute - The warning message to be emitted when code uses this construct. - ExperimentalAttribute - - - This attribute is used to tag values that are part of an experimental library - feature. - - - Convert an value of type System.Converter to a F# first class function value - The input System.Converter. - An F# function of the same type. - - - Convert an F# first class function value to a value of type System.Converter - The input function. - A System.Converter of the function type. - - - Convert an F# first class function value to a value of type System.Converter - The input function. - System.Converter<'T,'U> - - - Invoke an F# first class function value with two curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The function result. - - - Invoke an F# first class function value with three curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The third arg. - The function result. - - - Invoke an F# first class function value with four curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The third arg. - The fourth arg. - The function result. - - - Invoke an F# first class function value with five curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The third arg. - The fourth arg. - The fifth arg. - The function result. - - - Invoke an F# first class function value with one argument - - 'U - - - Convert an value of type System.Converter to a F# first class function value - The input System.Converter. - An F# function of the same type. - - - Construct an instance of an F# first class function value - The created F# function. - - - The CLI type used to represent F# function values. This type is not - typically used directly, though may be used from other CLI languages. - - - The release number of the F# version associated with the attribute - - - The minor version number of the F# version associated with the attribute - - - The major version number of the F# version associated with the attribute - - - Creates an instance of the attribute - The major version number. - The minor version number. - The release number. - FSharpInterfaceDataVersionAttribute - - - This attribute is added to generated assemblies to indicate the - version of the data schema used to encode additional F# - specific information in the resource attached to compiled F# libraries. - - - Specialize the type function at a given type - The specialized type. - - - Construct an instance of an F# first class type function value - FSharpTypeFunc - - - The CLI type used to represent F# first-class type function values. This type is for use - by compiled F# code. - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - Tuple of values generated by scan or match. - - - Convert the given Converter delegate object to an F# function value - The input Converter. - The F# function. - - - Convert the given Action delegate object to an F# function value - The input action. - The F# function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - Helper functions for converting F# first class function values to and from CLI representaions - of functions using delegates. - - - Creates an instance of the attribute - GeneralizableValueAttribute - - - Adding this attribute to a non-function value with generic parameters indicates that - uses of the construct can give rise to generic code through type inference. - - - Creates an instance of the attribute - InterfaceAttribute - - - Adding this attribute to a type causes it to be represented using a CLI interface. - - - Creates an instance of the attribute - LiteralAttribute - - - Adding this attribute to a value causes it to be compiled as a CLI constant literal. - - - Creates an instance of the attribute - MeasureAnnotatedAbbreviationAttribute - - - Adding this attribute to a type causes it to be interpreted as a refined type, currently limited to measure-parameterized types. - This may only be used under very limited conditions. - - - Creates an instance of the attribute - MeasureAttribute - - - Adding this attribute to a type causes it to be interpreted as a unit of measure. - This may only be used under very limited conditions. - - - Creates an instance of the attribute - NoComparisonAttribute - - - Adding this attribute to a type indicates it is a type where comparison is an abnormal operation. - This means that the type does not satisfy the F# 'comparison' constraint. Within the bounds of the - F# type system, this helps ensure that the F# generic comparison function is not instantiated directly - at this type. The attribute and checking does not constrain the use of comparison with base or child - types of this type. - - - Creates an instance of the attribute - NoDynamicInvocationAttribute - - - This attribute is used to tag values that may not be dynamically invoked at runtime. This is - typically added to inlined functions whose implementations include unverifiable code. It - causes the method body emitted for the inlined function to raise an exception if - dynamically invoked, rather than including the unverifiable code in the generated - assembly. - - - Creates an instance of the attribute - NoEqualityAttribute - - - Adding this attribute to a type indicates it is a type where equality is an abnormal operation. - This means that the type does not satisfy the F# 'equality' constraint. Within the bounds of the - F# type system, this helps ensure that the F# generic equality function is not instantiated directly - at this type. The attribute and checking does not constrain the use of comparison with base or child - types of this type. - - - The representation of "Value of type 'T" - The input value. - An option representing the value. - - - The representation of "No value" - - - Get the value of a 'Some' option. A NullReferenceException is raised if the option is 'None'. - - - Create an option value that is a 'None' value. - - - Return 'true' if the option is a 'Some' value. - - - Return 'true' if the option is a 'None' value. - - - Create an option value that is a 'Some' value. - The input value - An option representing the value. - - - The type of optional values. When used from other CLI languages the - empty option is the null value. - - Use the constructors Some and None to create values of this type. - Use the values in the Option module to manipulate values of this type, - or pattern match against the values directly. - - None values will appear as the value null to other CLI languages. - Instance methods on this type will appear as static methods to other CLI languages - due to the use of null as a value representation. - - - Creates an instance of the attribute - OptionalArgumentAttribute - - - This attribute is added automatically for all optional arguments. - - - The raw text of the format string. - - - Construct a format string - The input string. - The PrintfFormat containing the formatted result. - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - - - Construct a format string - The input string. - The created format string. - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - Tuple of values generated by scan or match. - - - Creates an instance of the attribute - ProjectionParameterAttribute - - - Indicates that, when a custom operator is used in a computation expression, - a parameter is automatically parameterized by the variable space of the computation expression - - - - The current value of the reference cell - - - - The current value of the reference cell - - - The current value of the reference cell - - - The type of mutable references. Use the functions [:=] and [!] to get and - set values of this type. - - - Creates an instance of the attribute - ReferenceEqualityAttribute - - - Adding this attribute to a record or union type disables the automatic generation - of overrides for 'System.Object.Equals(obj)', 'System.Object.GetHashCode()' - and 'System.IComparable' for the type. The type will by default use reference equality. - - - The value of the attribute, indicating whether to include the evaluated value of the definition as the outer node of the quotation - - - Creates an instance of the attribute - Indicates whether to include the evaluated value of the definition as the outer node of the quotation - ReflectedDefinitionAttribute - - - Creates an instance of the attribute - ReflectedDefinitionAttribute - - - Adding this attribute to the let-binding for the definition of a top-level - value makes the quotation expression that implements the value available - for use at runtime. - - - Creates an instance of the attribute - RequireQualifiedAccessAttribute - - - This attribute is used to indicate that references to the elements of a module, record or union - type require explicit qualified access. - - - Creates an instance of the attribute - RequiresExplicitTypeArgumentsAttribute - - - Adding this attribute to a type, value or member requires that - uses of the construct must explicitly instantiate any generic type parameters. - - - The value of the attribute, indicating whether the type is sealed or not. - - - Creates an instance of the attribute - Indicates whether the class is sealed. - SealedAttribute - - - Creates an instance of the attribute. - The created attribute. - - - Adding this attribute to class definition makes it sealed, which means it may not - be extended or implemented. - - - Indicates that the compiled entity had private or internal representation in F# source code. - - - The mask of values related to the kind of the compiled entity. - - - Indicates that the compiled entity is part of the representation of an F# value declaration. - - - Indicates that the compiled entity is part of the representation of an F# union case declaration. - - - Indicates that the compiled entity is part of the representation of an F# module declaration. - - - Indicates that the compiled entity is part of the representation of an F# closure. - - - Indicates that the compiled entity is part of the representation of an F# exception declaration. - - - Indicates that the compiled entity is part of the representation of an F# record or union case field declaration. - - - Indicates that the compiled entity is part of the representation of an F# class or other object type declaration. - - - Indicates that the compiled entity is part of the representation of an F# record type declaration. - - - Indicates that the compiled entity is part of the representation of an F# union type declaration. - - - Indicates that the compiled entity has no relationship to an element in F# source code. - - - Indicates the relationship between a compiled entity in a CLI binary and an element in F# source code. - - - Creates an instance of the attribute - StructAttribute - - - Adding this attribute to a type causes it to be represented using a CLI struct. - - - Creates an instance of the attribute - StructuralComparisonAttribute - - - Adding this attribute to a record, union, exception, or struct type confirms the - automatic generation of implementations for 'System.IComparable' for the type. - - - Creates an instance of the attribute - StructuralEqualityAttribute - - - Adding this attribute to a record, union or struct type confirms the automatic - generation of overrides for 'System.Object.Equals(obj)' and - 'System.Object.GetHashCode()' for the type. - - - Indicates the text to display by default when objects of this type are displayed - using '%A' printf formatting patterns and other two-dimensional text-based display - layouts. - - - Creates an instance of the attribute - Indicates the text to display when using the '%A' printf formatting. - StructuredFormatDisplayAttribute - - - This attribute is used to mark how a type is displayed by default when using - '%A' printf formatting patterns and other two-dimensional text-based display layouts. - In this version of F# valid values are of the form PreText {PropertyName1} PostText {PropertyName2} ... {PropertyNameX} PostText. - The property names indicate properties to evaluate and to display instead of the object itself. - - - The type 'unit', which has only one value "()". This value is special and - always uses the representation 'null'. - - - Creates an instance of the attribute - UnverifiableAttribute - - - This attribute is used to tag values whose use will result in the generation - of unverifiable code. These values are inevitably marked 'inline' to ensure that - the unverifiable constructs are not present in the actual code for the F# library, - but are rather copied to the source code of the caller. - - - Creates an instance of the attribute - VolatileFieldAttribute - - - Adding this attribute to an F# mutable binding causes the "volatile" - prefix to be used for all accesses to the field. - - - Thirty-two dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Thirty-one dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Thirty dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-nine dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-eight dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-seven dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-six dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-five dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-four dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-three dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-two dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-one dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Nineteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Eighteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Seventeen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Sixteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Fifteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Fourteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Thirteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twelve dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Eleven dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Ten dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Nine dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Eight dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Seven dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Six dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Five dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Four dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - Use the values in the Array4D module - to manipulate values of this type, or the notation arr.[x1,x2,x3,x4] to get and set array - values. - - - Three dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - Use the values in the Array3D module - to manipulate values of this type, or the notation arr.[x1,x2,x3] to get and set array - values. - - - Two dimensional arrays, typically zero-based. - - Use the values in the Array2D module - to manipulate values of this type, or the notation arr.[x,y] to get/set array - values. - - Non-zero-based arrays can also be created using methods on the System.Array type. - - - Single dimensional, zero-based arrays, written int[], string[] etc. - Use the values in the Array module to manipulate values - of this type, or the notation arr.[x] to get/set array - values. - - - Single dimensional, zero-based arrays, written int[], string[] etc. - - Use the values in the Array module to manipulate values - of this type, or the notation arr.[x] to get/set array - values. - - - An abbreviation for the CLI type System.Boolean. - - - Represents a managed pointer in F# code. - - - An abbreviation for the CLI type System.Byte. - - - An abbreviation for the CLI type System.Char. - - - An abbreviation for the CLI type System.Decimal. - - - The type of decimal numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Decimal. - - - An abbreviation for the CLI type System.Double. - - - An abbreviation for the CLI type System.Exception. - - - An abbreviation for the CLI type System.Double. - - - An abbreviation for the CLI type System.Single. - - - The type of floating point numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Single. - - - The type of floating point numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Double. - - - This type is for internal use by the F# code generator. - - - An abbreviation for the CLI type System.Int32. - - - An abbreviation for the CLI type System.Int16. - - - The type of 16-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Int16. - - - An abbreviation for the CLI type System.Int32. - - - An abbreviation for the CLI type System.Int64. - - - The type of 64-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Int64. - - - An abbreviation for the CLI type System.SByte. - - - The type of 32-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Int32. - - - An abbreviation for the CLI type System.IntPtr. - - - Represents an unmanaged pointer in F# code. - - This type should only be used when writing F# code that interoperates - with native code. Use of this type in F# code may result in - unverifiable code being generated. Conversions to and from the - nativeint type may be required. Values of this type can be generated - by the functions in the NativeInterop.NativePtr module. - - - An abbreviation for the CLI type System.Object. - - - The type of optional values. When used from other CLI languages the - empty option is the null value. - - Use the constructors Some and None to create values of this type. - Use the values in the Option module to manipulate values of this type, - or pattern match against the values directly. - - 'None' values will appear as the value null to other CLI languages. - Instance methods on this type will appear as static methods to other CLI languages - due to the use of null as a value representation. - - - The type of mutable references. Use the functions [:=] and [!] to get and - set values of this type. - - - An abbreviation for the CLI type System.SByte. - - - The type of 8-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.SByte. - - - An abbreviation for the CLI type System.Single. - - - An abbreviation for the CLI type System.String. - - - An abbreviation for the CLI type System.UInt16. - - - An abbreviation for the CLI type System.UInt32. - - - An abbreviation for the CLI type System.UInt64. - - - An abbreviation for the CLI type System.Byte. - - - An abbreviation for the CLI type System.UIntPtr. - - - The type 'unit', which has only one value "()". This value is special and - always uses the representation 'null'. - - - Non-exhaustive match failures will raise the MatchFailureException exception - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - A new enumerator for the sequence. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - A reference to the sequence. - - A 0, 1, and 2 respectively indicate Stop, Yield, and Goto conditions for the sequence generator. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - A new sequence generator for the expression. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - - Namespace name the provider injects types into. - - - - - Compilers call this method to query a type provider for a type name. - - Resolver should return a type called name in namespace NamespaceName or null if the type is unknown. - - - - - - The top-level types - - - - - - The sub-namespaces in this namespace. An optional member to prevent generation of namespaces until an outer namespace is explored. - - - - - Represents a namespace provided by a type provider component. - - - - - Triggered when an assumption changes that invalidates the resolutions so far reported by the provider - - - - - Triggered when an assumption changes that invalidates the resolutions so far reported by the provider - - - - - Triggered when an assumption changes that invalidates the resolutions so far reported by the provider - - - - - Get the static parameters for a provided type. - - A type returned by GetTypes or ResolveTypeName - - - - - Namespace name the this TypeProvider injects types into. - - - - - Called by the compiler to ask for an Expression tree to replace the given MethodBase with. - - MethodBase that was given to the compiler by a type returned by a GetType(s) call. - Expressions that represent the parameters to this call. - An expression that the compiler will use in place of the given method base. - - - - Get the physical contents of the given logical provided assembly. - - - - - Apply static arguments to a provided type that accepts static arguments. - - The provider must return a type with the given mangled name. - the provided type definition which has static parameters - the full path of the type, including encoded representations of static parameters - the static parameters, indexed by name - - - - - Represents an instantiation of a type provider component. - - - - - Get the static parameters for a provided method. - - A method returned by GetMethod on a provided type - The static parameters of the provided method, if any - - - - Apply static arguments to a provided method that accepts static arguments. - - The provider must return a provided method with the given mangled name. - the provided method definition which has static parameters - the full name of the method that must be returned, including encoded representations of static parameters - the values of the static parameters, indexed by name - The provided method definition corresponding to the given static parameter values - - - - Represents additional, optional information for a type provider component - - - - Represents the inverse of a measure expressions when returned as a generic argument of a provided type. - - - Represents the '1' measure expression when returned as a generic argument of a provided type. - - - Represents the product of two measure expressions when returned as a generic argument of a provided type. - - - Creates an instance of the attribute - TypeProviderAssemblyAttribute - The name of the design-time assembly for this type provider. - - - Creates an instance of the attribute - TypeProviderAssemblyAttribute - - - Place attribute on runtime assembly to indicate that there is a corresponding design-time - assembly that contains a type provider. Runtime and designer assembly may be the same. - - - Creates an instance of the attribute - TypeProviderAttribute - - - Place on a class that implements ITypeProvider to extend the compiler - - - - Get the full path to use for temporary files for the type provider instance. - - - - - version of referenced system runtime assembly - - - - - Get the full path to referenced assembly that caused this type provider instance to be created. - - - - - Get the full path to use to resolve relative paths in any file name arguments given to the type provider instance. - - - - - Get the referenced assemblies for the type provider instance. - - - - - Indicates if the type provider host responds to invalidation events for type provider instances. - - - - - Indicates if the type provider instance is used in an environment which executes provided code such as F# Interactive. - - - - - Get the full path to use for temporary files for the type provider instance. - - - - - version of referenced system runtime assembly - - - - - Get the full path to referenced assembly that caused this type provider instance to be created. - - - - - Get the full path to use to resolve relative paths in any file name arguments given to the type provider instance. - - - - - Get the referenced assemblies for the type provider instance. - - - - - Indicates if the type provider host responds to invalidation events for type provider instances. - - - - - Indicates if the type provider instance is used in an environment which executes provided code such as F# Interactive. - - - - - Checks if given type exists in target system runtime library - - - - - If the class that implements ITypeProvider has a constructor that accepts TypeProviderConfig - then it will be constructed with an instance of TypeProviderConfig. - - - - Creates an instance of the attribute - TypeProviderEditorHideMethodsAttribute - - - Indicates that a code editor should hide all System.Object methods from the intellisense menus for instances of a provided type - - - Additional type attribute flags related to provided types - - - Creates an instance of the attribute - TypeProviderXmlDocAttribute - - - - The TypeProviderXmlDocAttribute attribute can be added to types and members. - The language service will display the CommentText property from the attribute - in the appropriate place when the user hovers over a type or member. - - - - Creates an anonymous event with the given handlers. - - A function to handle adding a delegate for the event to trigger. - A function to handle removing a delegate that the event triggers. - A function to produce the delegate type the event can trigger. - - The initialized event. - - - The F# compiler emits calls to this function to implement the use operator for F# sequence - expressions. - - The resource to be used and disposed. - The input sequence. - - The result sequence. - - - The F# compiler emits calls to this function to implement the compiler-intrinsic - conversions from untyped System.Collections.IEnumerable sequences to typed sequences. - - An initializer function. - A function to iterate and test if end of sequence is reached. - A function to retrieve the current element. - - The resulting typed sequence. - - - The F# compiler emits calls to this function to - implement the try/finally operator for F# sequence expressions. - - The input sequence. - A computation to be included in an enumerator's Dispose method. - - The result sequence. - - - The F# compiler emits calls to this function to - implement the while operator for F# sequence expressions. - - A function that indicates whether iteration should continue. - The input sequence. - - The result sequence. - - - A group of functions used as part of the compiled representation of F# sequence expressions. - - - Builds a query using query syntax and operators. - - - An active pattern to force the execution of values of type Lazy<_>. - - - Special prefix operator for splicing untyped expressions into quotation holes. - - - Special prefix operator for splicing typed expressions into quotation holes. - - - Builds a 2D array from a sequence of sequences of elements. - - - Builds a read-only lookup table from a sequence of key/value pairs. The key objects are indexed using generic hashing and equality. - - - Converts the argument to signed byte. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using SByte.Parse() with InvariantCulture settings. - Otherwise the operation requires and invokes a ToSByte method on the input type. - - - Converts the argument to byte. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Byte.Parse() on strings and otherwise requires a ToByte method on the input type. - - - Converts the argument to 64-bit float. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Double.Parse() with InvariantCulture settings. Otherwise the operation requires and invokes a ToDouble method on the input type. - - - Converts the argument to 32-bit float. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Single.Parse() with InvariantCulture settings. Otherwise the operation requires and invokes a ToSingle method on the input type. - - - Builds an aysnchronous workflow using computation expression syntax. - - - Builds a set from a sequence of objects. The objects are indexed using generic comparison. - The input sequence of elements. - The created set. - - - Print to a file using the given format, and add a newline. - The file TextWriter. - The formatter. - The formatted result. - - - Print to a file using the given format. - The file TextWriter. - The formatter. - The formatted result. - - - Print to a string buffer and raise an exception with the given - result. Helper printers must return strings. - The formatter. - The formatted result. - - - Print to a string using the given format. - The formatter. - The formatted result. - - - Print to stderr using the given format, and add a newline. - The formatter. - The formatted result. - - - Print to stderr using the given format. - The formatter. - The formatted result. - - - Print to stdout using the given format, and add a newline. - The formatter. - The formatted result. - - - Print to stdout using the given format. - The formatter. - The formatted result. - - - Converts the argument to signed byte. - This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using SByte.Parse() with InvariantCulture settings. - Otherwise the operation requires and invokes a ToSByte method on the input type. - - - Converts the argument to byte. - This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using Byte.Parse() on strings and otherwise requires a ToByte method on the input type. - - - Divides a value by an integer. - The input value. - The input int. - The division result. - - - Resolves to the value 'one' for any primitive numeric type or any type with a static member called 'One' - - - Resolves to the zero value for any primitive numeric type or any type with a static member called 'Zero' - - - A compiler intrinsic that implements dynamic invocations for the DivideByInt primitive. - - - A compiler intrinsic that implements dynamic invocations to the checked '*' operator. - - - A compiler intrinsic that implements dynamic invocations to the '*' operator. - - - A compiler intrinsic that implements dynamic invocations to the checked '+' operator. - - - A compiler intrinsic that implements dynamic invocations to the '+' operator. - - - Resolves to the value 'one' for any primitive numeric type or any type with a static member called 'One'. - - - Resolves to the zero value for any primitive numeric type or any type with a static member called 'Zero'. - - - Parse an uint64 according to the rules used by the overloaded 'uint64' conversion operator when applied to strings - The input string. - The parsed value. - - - Parse an int64 according to the rules used by the overloaded 'int64' conversion operator when applied to strings - The input string. - The parsed value. - - - Parse an uint32 according to the rules used by the overloaded 'uint32' conversion operator when applied to strings - The input string. - The parsed value. - - - Parse an int32 according to the rules used by the overloaded 'int32' conversion operator when applied to strings - The input string. - The parsed value. - - - Creates an sbyte value with units-of-measure - The input sbyte. - The sbyte with units-of-measure. - - - Creates an int16 value with units-of-measure - The input int16. - The int16 with units-of-measure. - - - Creates an int64 value with units-of-measure - The input int64. - The int64 with units of measure. - - - Creates an int32 value with units-of-measure - The input int. - The int with units of measure. - - - Creates a decimal value with units-of-measure - The input decimal. - The decimal with units of measure. - - - Creates a float32 value with units-of-measure - The input float. - The float with units-of-measure. - - - Creates a float value with units-of-measure - The input float. - The float with units-of-measure. - - - Get the underlying value for an enum value - The input enum. - The enumeration as a value. - - - Build an enum value from an underlying value - The input value. - The value as an enumeration. - - - Recursively hash a part of a value according to its structure. - The comparison function. - The input object. - The hashed value. - - - Hash a value according to its structure. Use the given limit to restrict the hash when hashing F# - records, lists and union types. - The limit on the number of nodes. - The input object. - The hashed value. - - - Hash a value according to its structure. This hash is not limited by an overall node count when hashing F# - records, lists and union types. - The input object. - The hashed value. - - - Make an F# comparer object for the given type - - - Make an F# hash/equality object for the given type - - - Make an F# hash/equality object for the given type using node-limited hashing when hashing F# - records, lists and union types. - The input limit on the number of nodes. - System.Collections.Generic.IEqualityComparer<'T> - - - Make an F# hash/equality object for the given type - - - Make an F# comparer object for the given type, where it can be null if System.Collections.Generic.Comparer<'T>.Default - - - Make an F# comparer object for the given type - - - A static F# comparer object - - - Return an F# comparer object suitable for hashing and equality. This hashing behaviour - of the returned comparer is not limited by an overall node count when hashing F# - records, lists and union types. This equality comparer has equivalence - relation semantics ([nan] = [nan]). - - - Return an F# comparer object suitable for hashing and equality. This hashing behaviour - of the returned comparer is not limited by an overall node count when hashing F# - records, lists and union types. - - - The physical hash. Hashes on the object identity, except for value types, - where we hash on the contents. - The input object. - The hashed value. - - - Reference/physical equality. - True if the inputs are reference-equal, false otherwise. - The first value. - The second value. - The result of the comparison. - - - Take the maximum of two values structurally according to the order given by GenericComparison - The first value. - The second value. - The maximum value. - - - Take the minimum of two values structurally according to the order given by GenericComparison - The first value. - The second value. - The minimum value. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values. May be called as a recursive case from an implementation of System.IComparable to - ensure consistent NaN comparison semantics. - The function to compare the values. - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values for equality - - The first value. - The second value. - The result of the comparison. - - - Compare two values for equality using equivalence relation semantics ([nan] = [nan]) - The first value. - The second value. - The result of the comparison. - - - Compare two values for equality using partial equivalence relation semantics ([nan] <> [nan]) - The first value. - The second value. - The result of the comparison. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs - - - - The standard overloaded associative (4-indexed) mutation operator - - - - The standard overloaded associative (3-indexed) mutation operator - - - The standard overloaded associative (2-indexed) mutation operator - - - The standard overloaded associative (indexed) mutation operator - - - The standard overloaded associative (4-indexed) lookup operator - - - The standard overloaded associative (3-indexed) lookup operator - - - The standard overloaded associative (2-indexed) lookup operator - - - The standard overloaded associative (indexed) lookup operator - - - A compiler intrinsic for checking initialization soundness of recursive bindings - - - A compiler intrinsic for checking initialization soundness of recursive static bindings - - - A compiler intrinsic for checking initialization soundness of recursive bindings - - - A compiler intrinsic for the efficient compilation of sequence expressions - - - This function implements parsing of decimal constants - - - This function implements calls to default constructors - acccessed by 'new' constraints. - - - Primitive used by pattern match compilation - - - A compiler intrinsic that implements the ':?' operator - - - A compiler intrinsic that implements the ':?' operator - - - A compiler intrinsic that implements the ':?>' operator - - - A compiler intrinsic that implements the ':?>' operator - - - The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs - - - Address-of. Uses of this value may result in the generation of unverifiable code. - The input object. - The unmanaged pointer. - - - Address-of. Uses of this value may result in the generation of unverifiable code. - The input object. - The managed pointer. - - - Binary 'or'. When used as a binary operator the right hand value is evaluated only on demand - The first value. - The second value. - The result of the operation. - - - Binary 'or'. When used as a binary operator the right hand value is evaluated only on demand. - - - Binary 'and'. When used as a binary operator the right hand value is evaluated only on demand - The first value. - The second value. - The result of the operation. - - - Binary 'and'. When used as a binary operator the right hand value is evaluated only on demand. - - - The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs - - - For compiler use only - - - Language primitives associated with the F# language - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - An active pattern to match values of type System.Collections.Generic.KeyValuePair - The input key/value pair. - A tuple containing the key and value. - - - Converts the argument to character. Numeric inputs are converted according to the UTF-16 - encoding for characters. String inputs must be exactly one character long. For other - input types the operation requires an appropriate static conversion method on the input type. - The input value. - The converted char. - - - Converts the argument to System.Decimal using a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted decimal. - - - Converts the argument to a string using ToString. - - For standard integer and floating point values the ToString conversion - uses CultureInfo.InvariantCulture. - The input value. - The converted string. - - - Converts the argument to unsigned native integer using a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted unativeint - - - Converts the argument to signed native integer. This is a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted nativeint - - - Converts the argument to 64-bit float. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Double.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float - - - Converts the argument to 32-bit float. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Single.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float32 - - - Converts the argument to unsigned 64-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint64 - - - Converts the argument to signed 64-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int64 - - - Converts the argument to unsigned 32-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint32 - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int32 - - - Converts the argument to a particular enum type. - The input value. - The converted enum type. - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int - - - Converts the argument to unsigned 16-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint16 - - - Converts the argument to signed 16-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int16 - - - Converts the argument to signed byte. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using SByte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to byte. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Byte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - Overloaded power operator. If n > 0 then equivalent to x*...*x for n occurrences of x. - The input base. - The input exponent. - The base raised to the exponent. - - - Overloaded power operator. - The input base. - The input exponent. - The base raised to the exponent. - - - Overloaded truncate operator. - The input value. - The truncated value. - - - Hyperbolic tangent of the given number - The input value. - The hyperbolic tangent of the input. - - - Tangent of the given number - The input value. - The tangent of the input. - - - Hyperbolic sine of the given number - The input value. - The hyperbolic sine of the input. - - - Sine of the given number - The input value. - The sine of the input. - - - Hyperbolic cosine of the given number - The input value. - The hyperbolic cosine of the input. - - - Cosine of the given number - The input value. - The cosine of the input. - - - Square root of the given number - The input value. - The square root of the input. - - - Logarithm to base 10 of the given number - The input value. - The logarithm to base 10 of the input. - - - Natural logarithm of the given number - The input value. - The natural logarithm of the input. - - - Round the given number - The input value. - The nearest integer to the input value. - - - Sign of the given number - The input value. - -1, 0, or 1 depending on the sign of the input. - - - Floor of the given number - The input value. - The floor of the input. - - - Exponential of the given number - The input value. - The exponential of the input. - - - Ceiling of the given number - The input value. - The ceiling of the input. - - - Inverse tangent of x/y where x and y are specified separately - The y input value. - The x input value. - The inverse tangent of the input ratio. - - - Inverse tangent of the given number - The input value. - The inverse tangent of the input. - - - Inverse sine of the given number - The input value. - The inverse sine of the input. - - - Inverse cosine of the given number - The input value. - The inverse cosine of the input. - - - Absolute value of the given number. - The input value. - The absolute value of the input. - - - A generic hash function. This function has the same behaviour as 'hash', - however the default structural hashing for F# union, record and tuple - types stops when the given limit of nodes is reached. The exact behaviour of - the function can be adjusted on a type-by-type basis by implementing - GetHashCode for each type. - The limit of nodes. - The input object. - The computed hash. - - - A generic hash function, designed to return equal hash values for items that are - equal according to the "=" operator. By default it will use structural hashing - for F# union, record and tuple types, hashing the complete contents of the - type. The exact behaviour of the function can be adjusted on a - type-by-type basis by implementing GetHashCode for each type. - The input object. - The computed hash. - - - Returns the internal size of a type in bytes. For example, sizeof<int> returns 4. - - - Generate a System.Type representation for a type definition. If the - input type is a generic type instantiation then return the - generic type definition associated with all such instantiations. - - - An internal, library-only compiler intrinsic for compile-time - generation of a RuntimeMethodHandle. - - - Generate a System.Type runtime representation of a static type. - - - Clean up resources associated with the input object after the completion of the given function. - Cleanup occurs even when an exception is raised by the protected - code. - The resource to be disposed after action is called. - The action that accepts the resource. - The resulting value. - - - Execute the function as a mutual-exclusion region using the input value as a lock. - The object to be locked. - The action to perform during the lock. - The resulting value. - - - The standard overloaded skip range operator, e.g. [n..skip..m] for lists, seq {n..skip..m} for sequences - The start value of the range. - The step value of the range. - The end value of the range. - The sequence spanning the range using the specified step size. - - - The standard overloaded range operator, e.g. [n..m] for lists, seq {n..m} for sequences - The start value of the range. - The end value of the range. - The sequence spanning the range. - - - Reads the value of the property System.Console.Out. - - - Reads the value of the property System.Console.Error. - - - Reads the value of the property System.Console.In. - - - Equivalent to System.Single.NaN - - - Equivalent to System.Single.PositiveInfinity - - - Equivalent to System.Double.NaN - - - Equivalent to System.Double.PositiveInfinity - - - Exit the current hardware isolated process, if security settings permit, - otherwise raise an exception. Calls System.Environment.Exit. - The exit code to use. - The result value. - - - Builds a sequence using sequence expression syntax - The input sequence. - The result sequence. - - - Negate a logical value. not true equals false and not false equals true - The value to negate. - The result of the negation. - - - Concatenate two lists. - The first list. - The second list. - The concatenation of the lists. - - - Increment a mutable reference cell containing an integer - The reference cell. - - - Decrement a mutable reference cell containing an integer - The reference cell. - - - Dereference a mutable reference cell - The cell to dereference. - The value contained in the cell. - - - Assign to a mutable reference cell - The cell to mutate. - The value to set inside the cell. - - - Create a mutable reference cell - The value to contain in the cell. - The created reference cell. - - - The identity function - The input value. - The same value. - - - Throw a System.InvalidOperationException exception - The exception message. - The result value. - - - Throw a System.ArgumentNullException exception - The argument name. - The result value. - - - Throw a System.ArgumentException exception with - the given argument name and message. - The argument name. - The exception message. - The result value. - - - Throw a System.Exception exception. - The exception message. - The result value. - - - Determines whether the given value is null. - The value to check. - True when value is null, false otherwise. - - - Try to unbox a strongly typed value. - The boxed value. - The unboxed result as an option. - - - Boxes a strongly typed value. - The value to box. - The boxed object. - - - Unboxes a strongly typed value. - The boxed value. - The unboxed result. - - - Ignore the passed value. This is often used to throw away results of a computation. - The value to ignore. - - - Minimum based on generic comparison - The first value. - The second value. - The minimum value. - - - Maximum based on generic comparison - The first value. - The second value. - The maximum value. - - - Generic comparison. - The first value. - The second value. - The result of the comparison. - - - Return the second element of a tuple, snd (a,b) = b. - The input tuple. - The second value. - - - Return the first element of a tuple, fst (a,b) = a. - The input tuple. - The first value. - - - Matches System.Exception objects whose runtime type is precisely System.Exception - The input exception. - A string option. - - - Builds a System.Exception object. - The message for the Exception. - A System.Exception. - - - Rethrows an exception. This should only be used when handling an exception - The result value. - - - Rethrows an exception. This should only be used when handling an exception - The result value. - - - Raises an exception - The exception to raise. - The result value. - - - Concatenate two strings. The operator '+' may also be used. - - - Used to specify a default value for an optional argument in the implementation of a function - An option representing the argument. - The default value of the argument. - The argument value. If it is None, the defaultValue is returned. - - - Apply a function to three values, the values being a triple on the right, the function on the left - The function. - The first argument. - The second argument. - The third argument. - The function result. - - - Apply a function to two values, the values being a pair on the right, the function on the left - The function. - The first argument. - The second argument. - The function result. - - - Apply a function to a value, the value being on the right, the function on the left - The function. - The argument. - The function result. - - - Apply a function to three values, the values being a triple on the left, the function on the right - The first argument. - The second argument. - The third argument. - The function. - The function result. - - - Apply a function to two values, the values being a pair on the left, the function on the right - The first argument. - The second argument. - The function. - The function result. - - - Apply a function to a value, the value being on the left, the function on the right - The argument. - The function. - The function result. - - - Compose two functions, the function on the right being applied first - The second function to apply. - The first function to apply. - The composition of the input functions. - - - Compose two functions, the function on the left being applied first - The first function to apply. - The second function to apply. - The composition of the input functions. - - - Structural inequality - The first parameter. - The second parameter. - The result of the comparison. - - - Structural equality - The first parameter. - The second parameter. - The result of the comparison. - - - Structural less-than-or-equal comparison - The first parameter. - The second parameter. - The result of the comparison. - - - Structural greater-than-or-equal - The first parameter. - The second parameter. - The result of the comparison. - - - Structural greater-than - The first parameter. - The second parameter. - The result of the comparison. - - - Structural less-than comparison - The first parameter. - The second parameter. - The result of the comparison. - - - Overloaded prefix-plus operator - The input value. - The result of the operation. - - - Overloaded bitwise-NOT operator - The input value. - The result of the operation. - - - Overloaded byte-shift right operator by a specified number of bits - The input value. - The amount to shift. - The result of the operation. - - - Overloaded byte-shift left operator by a specified number of bits - The input value. - The amount to shift. - The result of the operation. - - - Overloaded bitwise-XOR operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded bitwise-OR operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded bitwise-AND operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded modulo operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded division operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded multiplication operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded subtraction operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded addition operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded unary negation. - The value to negate. - The result of the operation. - - - Converts the argument to char. Numeric inputs are converted using a checked - conversion according to the UTF-16 encoding for characters. String inputs must - be exactly one character long. For other input types the operation requires an - appropriate static conversion method on the input type. - The input value. - The converted char - - - Converts the argument to unativeint. This is a direct, checked conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted unativeint - - - Converts the argument to nativeint. This is a direct, checked conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted nativeint - - - Converts the argument to uint64. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.UInt64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint64 - - - Converts the argument to int64. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int64 - - - Converts the argument to uint32. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.UInt32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint32 - - - Converts the argument to int32. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int32 - - - Converts the argument to int. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int - - - Converts the argument to uint16. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.UInt16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint16 - - - Converts the argument to int16. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int16 - - - Converts the argument to sbyte. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.SByte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to byte. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Byte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - Overloaded multiplication operator (checks for overflow) - The first value. - The second value. - The product of the two input values. - - - Overloaded addition operator (checks for overflow) - The first value. - The second value. - The sum of the two input values. - - - Overloaded subtraction operator (checks for overflow) - The first value. - The second value. - The first value minus the second value. - - - Overloaded unary negation (checks for overflow) - The input value. - The negated value. - - - This module contains the basic arithmetic operations with overflow checks. - - - Calls GetHashCode() on the value - The value. - The hash code. - - - Minimum of the two values - The first value. - The second value. - The minimum value. - - - Maximum of the two values - The first value. - The second value. - The maximum value. - - - Compares the two values - The first value. - The second value. - The result of the comparison. - - - Compares the two values for inequality - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for equality - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for less-than-or-equal - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for greater-than-or-equal - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for greater-than - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for less-than - The first parameter. - The second parameter. - The result of the comparison. - - - A module of comparison and equality operators that are statically resolved, but which are not fully generic and do not make structural comparison. Opening this - module may make code that relies on structural or generic comparison no longer compile. - - - Perform generic hashing on a value where the type of the value is not - statically required to satisfy the 'equality' constraint. - The computed hash value. - - - Perform generic equality on two values where the type of the values is not - statically required to satisfy the 'equality' constraint. - The result of the comparison. - - - Perform generic comparison on two values where the type of the values is not - statically required to have the 'comparison' constraint. - The result of the comparison. - - - Generate a default value for any type. This is null for reference types, - For structs, this is struct value where all fields have the default value. - This function is unsafe in the sense that some F# values do not have proper null values. - - - Unboxes a strongly typed value. This is the inverse of box, unbox<t>(box<t> a) equals a. - The boxed value. - The unboxed result. - - - This module contains basic operations which do not apply runtime and/or static checks - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'decimal' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'float' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'float32' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'unativeint' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'nativeint' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint64' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int64' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint32' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int32' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint16' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int16' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'sbyte' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'byte' - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - Generate a range of values using the given zero, add, start, step and stop values - - - Generate a range of values using the given zero, add, start, step and stop values - - - Generate a range of char values - - - Generate a range of byte values - - - Generate a range of sbyte values - - - Generate a range of uint16 values - - - Generate a range of int16 values - - - Generate a range of unativeint values - - - Generate a range of nativeint values - - - Generate a range of uint32 values - - - Generate a range of uint64 values - - - Generate a range of int64 values - - - Generate a range of float32 values - - - Generate a range of float values - - - Generate a range of integers - - - Gets a slice from a string - The source string. - The index of the first character of the slice. - The index of the last character of the slice. - The substring from the given indices. - - - Sets a slice of an array - The target array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The start index of the fourth dimension. - The end index of the fourth dimension. - The source array. - - - Gets a slice of an array - The source array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The start index of the fourth dimension. - The end index of the fourth dimension. - The four dimensional sub array from the given indices. - - - Sets a slice of an array - The target array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The source array. - - - Gets a slice of an array - The source array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The three dimensional sub array from the given indices. - - - Sets a vector slice of a 2D array. The index of the second dimension is fixed. - The target array. - The start index of the first dimension. - The end index of the first dimension. - The index of the second dimension. - The source array. - - - Sets a vector slice of a 2D array. The index of the first dimension is fixed. - The target array. - The index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The source array. - - - Sets a region slice of an array - The target array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The source array. - - - Gets a vector slice of a 2D array. The index of the second dimension is fixed. - The source array. - The start index of the first dimension. - The end index of the first dimension. - The fixed index of the second dimension. - The sub array from the input indices. - - - Gets a vector slice of a 2D array. The index of the first dimension is fixed. - The source array. - The index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The sub array from the input indices. - - - Gets a region slice of an array - The source array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The two dimensional sub array from the input indices. - - - Sets a slice of an array - The target array. - The start index. - The end index. - The source array. - - - Gets a slice of an array - The input array. - The start index. - The end index. - The sub array from the input indices. - - - A module of compiler intrinsic functions for efficient implementations of F# integer ranges - and dynamic invocations of other F# operators - - - Basic F# Operators. This module is automatically opened in all F# code. - - - Invoke an F# first class function value that accepts five curried arguments - without intervening execution - The first arg. - The second arg. - The third arg. - The fourth arg. - The fifth arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept five curried arguments without intervening execution. - The input function. - The optimized function. - - - Construct an optimized function value that can accept five curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept five curried arguments - without intervening execution. This type should not typically used directly from - either F# code or from other CLI languages. - - - Invoke an F# first class function value that accepts four curried arguments - without intervening execution - The first arg. - The second arg. - The third arg. - The fourth arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept four curried arguments without intervening execution. - The input function. - The optimized function. - - - Construct an optimized function value that can accept four curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept four curried arguments - without intervening execution. This type should not typically used directly from - either F# code or from other CLI languages. - - - Invoke an F# first class function value that accepts three curried arguments - without intervening execution - The first arg. - The second arg. - The third arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept three curried arguments without intervening execution. - The input function. - The adapted function. - - - Construct an optimized function value that can accept three curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept - three iterated (curried) arguments without intervening execution. This type should not - typically used directly from either F# code or from other CLI languages. - - - Invoke the optimized function value with two curried arguments - The first arg. - The second arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept two curried arguments without intervening execution. - The input function. - The adapted function. - - - Construct an optimized function value that can accept two curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept - two iterated (curried) arguments without intervening execution. This type should not - typically used directly from either F# code or from other CLI languages. - - - An implementation module used to hold some private implementations of function - value invocation. - - - Convert an option to a potentially null value. - The input value. - The result value, which is null if the input was None. - - - Convert a potentially null value to an option. - The input value. - The result option. - - - Convert a Nullable value to an option. - The input nullable value. - The result option. - - - Convert the option to a Nullable value. - The input option. - The result value. - - - Convert the option to a list of length 0 or 1. - The input option. - The result list. - - - Convert the option to an array of length 0 or 1. - The input option. - The result array. - - - filter f inp evaluates to match inp with None -> None | Some x -> if f x then Some x else None. - A function that evaluates whether the value contained in the option should remain, or be filtered out. - The input option. - The input if the predicate evaluates to true; otherwise, None. - - - bind f inp evaluates to match inp with None -> None | Some x -> f x - A function that takes the value of type T from an option and transforms it into - an option containing a value of type U. - The input option. - An option of the output type of the binder. - - - map f inp evaluates to match inp with None -> None | Some x -> Some (f x). - A function to apply to the option value. - The input option. - An option of the input value after applying the mapping function, or None if the input is None. - - - iter f inp executes match inp with None -> () | Some x -> f x. - A function to apply to the option value. - The input option. - Unit if the option is None, otherwise it returns the result of applying the predicate - to the option value. - - - forall p inp evaluates to match inp with None -> true | Some x -> p x. - A function that evaluates to a boolean when given a value from the option type. - The input option. - True if the option is None, otherwise it returns the result of applying the predicate - to the option value. - - - exists p inp evaluates to match inp with None -> false | Some x -> p x. - A function that evaluates to a boolean when given a value from the option type. - The input option. - False if the option is None, otherwise it returns the result of applying the predicate - to the option value. - - - fold f inp s evaluates to match inp with None -> s | Some x -> f x s. - A function to update the state data when given a value from an option. - The input option. - The initial state. - The original state if the option is None, otherwise it returns the updated state with the folder - and the option value. - - - fold f s inp evaluates to match inp with None -> s | Some x -> f s x. - A function to update the state data when given a value from an option. - The initial state. - The input option. - The original state if the option is None, otherwise it returns the updated state with the folder - and the option value. - - - count inp evaluates to match inp with None -> 0 | Some _ -> 1. - The input option. - A zero if the option is None, a one otherwise. - - - Gets the value associated with the option. - The input option. - The value within the option. - Thrown when the option is None. - - - Returns true if the option is None. - The input option. - True if the option is None. - - - Returns true if the option is not None. - The input option. - True if the option is not None. - - - Basic operations on options. - - - Represents a statically-analyzed format associated with writing to a System.IO.TextWriter. The type parameter indicates the - arguments and return type of the format operation. - - - Represents a statically-analyzed format when formatting builds a string. The type parameter indicates the - arguments and return type of the format operation. - - - Represents a statically-analyzed format associated with writing to a System.Text.StringBuilder. The type parameter indicates the - arguments and return type of the format operation. - - - Represents a statically-analyzed format associated with writing to a System.IO.TextWriter. The first type parameter indicates the - arguments of the format operation and the last the overall return type. - - - Represents a statically-analyzed format when formatting builds a string. The first type parameter indicates the - arguments of the format operation and the last the overall return type. - - - Represents a statically-analyzed format associated with writing to a System.Text.StringBuilder. The first type parameter indicates the - arguments of the format operation and the last the overall return type. - - - Print to a string buffer and raise an exception with the given - result. Helper printers must return strings. - The input formatter. - The arguments of the formatter. - - - sprintf, but call the given 'final' function to generate the result. - See kprintf. - The function called to generate a result from the formatted string. - The input formatter. - The arguments of the formatter. - - - printf, but call the given 'final' function to generate the result. - For example, these let the printing force a flush after all output has - been entered onto the channel, but not before. - The function called after formatting to generate the format result. - The input formatter. - The arguments of the formatter. - - - fprintf, but call the given 'final' function to generate the result. - See kprintf. - The function called after formatting to generate the format result. - The input TextWriter. - The input formatter. - The arguments of the formatter. - - - bprintf, but call the given 'final' function to generate the result. - See kprintf. - The function called after formatting to generate the format result. - The input StringBuilder. - The input formatter. - The arguments of the formatter. - - - Print to a string via an internal string buffer and return - the result as a string. Helper printers must return strings. - The input formatter. - The formatted string. - - - Formatted printing to stdout, adding a newline. - The input formatter. - The return type and arguments of the formatter. - - - Formatted printing to stdout - The input formatter. - The return type and arguments of the formatter. - - - Formatted printing to stderr, adding a newline - The input formatter. - The return type and arguments of the formatter. - - - Formatted printing to stderr - The input formatter. - The return type and arguments of the formatter. - - - Print to a text writer, adding a newline - The TextWriter to print to. - The input formatter. - The return type and arguments of the formatter. - - - Print to a text writer. - The TextWriter to print to. - The input formatter. - The return type and arguments of the formatter. - - - Print to a System.Text.StringBuilder - The StringBuilder to print to. - The input formatter. - The return type and arguments of the formatter. - - - Extensible printf-style formatting for numbers and other datatypes - - Format specifications are strings with "%" markers indicating format - placeholders. Format placeholders consist of: - - %[flags][width][.precision][type] - - where the type is interpreted as follows: - - %b: bool, formatted as "true" or "false" - %s: string, formatted as its unescaped contents - %c: character literal - %d, %i: any basic integer type formatted as a decimal integer, signed if the basic integer type is signed. - %u: any basic integer type formatted as an unsigned decimal integer - %x, %X, %o: any basic integer type formatted as an unsigned hexadecimal - (a-f)/Hexadecimal (A-F)/Octal integer - - %e, %E, %f, %F, %g, %G: - any basic floating point type (float,float32) formatted - using a C-style floating point format specifications, i.e - - %e, %E: Signed value having the form [-]d.dddde[sign]ddd where - d is a single decimal digit, dddd is one or more decimal - digits, ddd is exactly three decimal digits, and sign - is + or - - - %f: Signed value having the form [-]dddd.dddd, where dddd is one - or more decimal digits. The number of digits before the - decimal point depends on the magnitude of the number, and - the number of digits after the decimal point depends on - the requested precision. - - %g, %G: Signed value printed in f or e format, whichever is - more compact for the given value and precision. - - - %M: System.Decimal value - - %O: Any value, printed by boxing the object and using it's ToString method(s) - - %A: Any value, printed with the default layout settings - - %a: A general format specifier, requires two arguments: - (1) a function which accepts two arguments: - (a) a context parameter of the appropriate type for the - given formatting function (e.g. an #System.IO.TextWriter) - (b) a value to print - and which either outputs or returns appropriate text. - - (2) the particular value to print - - - %t: A general format specifier, requires one argument: - (1) a function which accepts a context parameter of the - appropriate type for the given formatting function (e.g. - an System.IO.TextWriter)and which either outputs or returns - appropriate text. - - Basic integer types are: - byte,sbyte,int16,uint16,int32,uint32,int64,uint64,nativeint,unativeint - Basic floating point types are: - float, float32 - - The optional width is an integer indicating the minimal width of the - result. For instance, %6d prints an integer, prefixing it with spaces - to fill at least 6 characters. If width is '*', then an extra integer - argument is taken to specify the corresponding width. - - any number - '*': - - Valid flags are: - - 0: add zeros instead of spaces to make up the required width - '-': left justify the result within the width specified - '+': add a '+' character if the number is positive (to match a '-' sign - for negatives) - ' ': add an extra space if the number is positive (to match a '-' - sign for negatives) - - The printf '#' flag is invalid and a compile-time error will be reported if it is used. - - - Returns the length of the string. - The input string. - The number of characters in the string. - - - Returns a string by concatenating count instances of str. - The number of copies of the input string will be copied. - The input string. - The concatenated string. - Thrown when count is negative. - - - Tests if any character of the string satisfies the given predicate. - The function to test each character of the string. - The input string. - True if any character returns true for the predicate and false otherwise. - - - Tests if all characters in the string satisfy the given predicate. - The function to test each character of the string. - The input string. - True if all characters return true for the predicate and false otherwise. - - - Builds a new string whose characters are the results of applying the function mapping - to each index from 0 to count-1 and concatenating the resulting - strings. - The number of strings to initialize. - The function to take an index and produce a string to - be concatenated with the others. - The constructed string. - Thrown when count is negative. - - - Builds a new string containing only the characters of the input string - for which the given predicate returns "true". - - Returns an empty string if the input string is null - - A function to test whether each character in the input sequence should be included in the output string. - The input string. - The resulting string. - - - Builds a new string whose characters are the results of applying the function mapping - to each of the characters of the input string and concatenating the resulting - strings. - The function to produce a string from each character of the input string. - The input string. - The concatenated string. - - - Builds a new string whose characters are the results of applying the function mapping - to each character and index of the input string. - The function to apply to each character and index of the string. - The input string. - The resulting string. - - - Builds a new string whose characters are the results of applying the function mapping - to each of the characters of the input string. - The function to apply to the characters of the string. - The input string. - The resulting string. - - - Applies the function action to the index of each character in the string and the - character itself. - The function to apply to each character and index of the string. - The input string. - - - Applies the function action to each character in the string. - The function to be applied to each character of the string. - The input string. - - - Returns a new string made by concatenating the given strings - with separator sep, that is a1 + sep + ... + sep + aN. - The separator string to be inserted between the strings - of the input sequence. - The sequence of strings to be concatenated. - A new string consisting of the concatenated strings separated by - the separation string. - Thrown when strings is null. - - - Functional programming operators for string processing. Further string operations - are available via the member functions on strings and other functionality in - System.String - and System.Text.RegularExpressions types. - - - - The SI unit of catalytic activity - - - - - The SI unit of does equivalent - - - - - The SI unit of absorbed dose - - - - - The SI unit of activity referred to a radionuclide - - - - - The SI unit of illuminance - - - - - The SI unit of luminous flux - - - - - The SI unit of inductance - - - - - The SI unit of magnetic flux density - - - - - The SI unit of magnetic flux - - - - - The SI unit of electric conductance - - - - - The SI unit of electric resistance - - - - - The SI unit of capacitance - - - - - The SI unit of electric potential difference, electromotive force - - - - - The SI unit of electric charge, amount of electricity - - - - - The SI unit of power, radiant flux - - - - - The SI unit of energy, work, amount of heat - - - - - The SI unit of pressure, stress - - - - - The SI unit of force - - - - - The SI unit of frequency - - - - - The SI unit of luminous intensity - - - - - The SI unit of amount of substance - - - - - The SI unit of thermodynamic temperature - - - - - The SI unit of electric current - - - - - The SI unit of time - - - - - The SI unit of mass - - - - - The SI unit of length - - - - - The SI unit of length - - - - - A synonym for henry, the SI unit of inductance - - - - - A synonym for katal, the SI unit of catalytic activity - - - - - A synonym for sievert, the SI unit of does equivalent - - - - - A synonym for gray, the SI unit of absorbed dose - - - - - A synonym for becquerel, the SI unit of activity referred to a radionuclide - - - - - A synonym for lux, the SI unit of illuminance - - - - - A synonym for lumen, the SI unit of luminous flux - - - - - A synonym for tesla, the SI unit of magnetic flux density - - - - - A synonym for weber, the SI unit of magnetic flux - - - - - A synonym for UnitNames.ohm, the SI unit of electric resistance. - - - - - A synonym for siemens, the SI unit of electric conductance - - - - - A synonym for farad, the SI unit of capacitance - - - - - A synonym for volt, the SI unit of electric potential difference, electromotive force - - - - - A synonym for coulomb, the SI unit of electric charge, amount of electricity - - - - - A synonym for watt, the SI unit of power, radiant flux - - - - - A synonym for joule, the SI unit of energy, work, amount of heat - - - - - A synonym for pascal, the SI unit of pressure, stress - - - - - A synonym for newton, the SI unit of force - - - - - A synonym for hertz, the SI unit of frequency - - - - - A synonym for candela, the SI unit of luminous intensity - - - - - A synonym for mole, the SI unit of amount of substance - - - - - A synonym for kelvin, the SI unit of thermodynamic temperature - - - - - A synonym for ampere, the SI unit of electric current - - - - - A synonym for second, the SI unit of time - - - - - A synonym for kilogram, the SI unit of mass - - - - - A synonym for Metre, the SI unit of length - - - - - A method used to support the F# query syntax. Returns an empty sequence that has the specified type argument. - - - - - A method used to support the F# query syntax. Returns a sequence that contains the specified values. - - - - - A method used to support the F# query syntax. Returns a sequence of length one that contains the specified value. - - - - A query operator that selects those elements based on a specified predicate. - - - - A query operator that performs a subsequent ordering of the elements selected so far in descending order by the given nullable sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - - - - A query operator that performs a subsequent ordering of the elements selected so far in ascending order by the given nullable sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - - - - A query operator that performs a subsequent ordering of the elements selected so far in descending order by the given sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - - - - A query operator that performs a subsequent ordering of the elements selected so far in ascending order by the given sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - - - - A query operator that selects elements from a sequence as long as a specified condition is true, and then skips the remaining elements. - - - - A query operator that selects a specified number of contiguous elements from those selected so far. - - - - A query operator that selects a nullable value for each element selected so far and returns the sum of these values. - If any nullable does not have a value, it is ignored. - - - - A query operator that selects a value for each element selected so far and returns the sum of these values. - - - - - A method used to support the F# query syntax. Inputs to queries are implicitly wrapped by a call to one of the overloads of this method. - - - - - A method used to support the F# query syntax. Inputs to queries are implicitly wrapped by a call to one of the overloads of this method. - - - - A query operator that sorts the elements selected so far in descending order by the given nullable sorting key. - - - - A query operator that sorts the elements selected so far in ascending order by the given nullable sorting key. - - - - A query operator that sorts the elements selected so far in descending order by the given sorting key. - - - - A query operator that sorts the elements selected so far in ascending order by the given sorting key. - - - - A query operator that bypasses elements in a sequence as long as a specified condition is true and then selects the remaining elements. - - - - A query operator that bypasses a specified number of the elements selected so far and selects the remaining elements. - - - - A query operator that projects each of the elements selected so far. - - - - - A method used to support the F# query syntax. Runs the given quotation as a query using LINQ IQueryable rules. - - - - - A method used to support the F# query syntax. Indicates that the query should be passed as a quotation to the Run method. - - - - A query operator that selects the element at a specified index amongst those selected so far. - - - - A query operator that selects a nullable value for each element selected so far and returns the minimum of these values. - If any nullable does not have a value, it is ignored. - - - - A query operator that selects a value for each element selected so far and returns the minimum resulting value. - - - - A query operator that selects a nullable value for each element selected so far and returns the maximum of these values. - If any nullable does not have a value, it is ignored. - - - - A query operator that selects a value for each element selected so far and returns the maximum resulting value. - - - - A query operator that correlates two sets of selected values based on matching keys and groups the results. - If any group is empty, a group with a single default value is used instead. - Normal usage is 'leftOuterJoin y in elements2 on (key1 = key2) into group'. - - - - A query operator that selects the last element of those selected so far, or a default value if no element is found. - - - - A query operator that selects the last element of those selected so far. - - - - A query operator that correlates two sets of selected values based on matching keys. - Normal usage is 'join y in elements2 on (key1 = key2)'. - - - - A query operator that selects the first element of those selected so far, or a default value if the sequence contains no elements. - - - - A query operator that selects the first element from those selected so far. - - - - A query operator that selects a value for each element selected so far and groups the elements by the given key. - - - - A query operator that correlates two sets of selected values based on matching keys and groups the results. - Normal usage is 'groupJoin y in elements2 on (key1 = key2) into group'. - - - - A query operator that groups the elements selected so far according to a specified key selector. - - - - - A method used to support the F# query syntax. Projects each element of a sequence to another sequence and combines the resulting sequences into one sequence. - - - - A query operator that selects the first element selected so far that satisfies a specified condition. - - - - A query operator that determines whether any element selected so far satisfies a condition. - - - - A query operator that selects the single, specific element of those selected so far, or a default value if that element is not found. - - - - A query operator that selects the single, specific element selected so far - - - - A query operator that selects distinct elements from the elements selected so far. - - - - A query operator that returns the number of selected elements. - - - - A query operator that determines whether the selected elements contains a specified element. - - - - A query operator that selects a nullable value for each element selected so far and returns the average of these values. - If any nullable does not have a value, it is ignored. - - - - A query operator that selects a value for each element selected so far and returns the average of these values. - - - - A query operator that determines whether all elements selected so far satisfies a condition. - - - - Create an instance of this builder. Use 'query { ... }' to use the query syntax. - - - - The type used to support the F# query syntax. Use 'query { ... }' to use the query syntax. - - - - - A property used to support the F# query syntax. - - - - - A method used to support the F# query syntax. - - - - - A partial input or result in an F# query. This type is used to support the F# query syntax. - - - - Converts the argument to character. Numeric inputs are converted according to the UTF-16 - encoding for characters. The operation requires an appropriate static conversion method on the input type. - The input value. - The converted char. - - - Converts the argument to System.Decimal using a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted decimal. - - - Converts the argument to unsigned native integer using a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted unativeint - - - Converts the argument to signed native integer. This is a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted nativeint - - - Converts the argument to 64-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float - - - Converts the argument to 32-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float32 - - - Converts the argument to 64-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float - - - Converts the argument to 32-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float32 - - - Converts the argument to unsigned 64-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint64 - - - Converts the argument to signed 64-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int64 - - - Converts the argument to unsigned 32-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint32 - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int32 - - - Converts the argument to a particular enum type. - The input value. - The converted enum type. - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int - - - Converts the argument to unsigned 16-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint16 - - - Converts the argument to signed 16-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int16 - - - Converts the argument to signed byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to signed byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - Converts the argument to byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - - Functions for converting nullable values - - - - - The division operator where a nullable value appears on both left and right sides - - - - - The division operator where a nullable value appears on the right - - - - - The division operator where a nullable value appears on the left - - - - - The modulus operator where a nullable value appears on both left and right sides - - - - - The modulus operator where a nullable value appears on the right - - - - - The modulus operator where a nullable value appears on the left - - - - - The multiplication operator where a nullable value appears on both left and right sides - - - - - The multiplication operator where a nullable value appears on the right - - - - - The multiplication operator where a nullable value appears on the left - - - - - The subtraction operator where a nullable value appears on both left and right sides - - - - - The subtraction operator where a nullable value appears on the right - - - - - The subtraction operator where a nullable value appears on the left - - - - - The addition operator where a nullable value appears on both left and right sides - - - - - The addition operator where a nullable value appears on the right - - - - - The addition operator where a nullable value appears on the left - - - - - The '<>' operator where a nullable value appears on both left and right sides - - - - - The '=' operator where a nullable value appears on both left and right sides - - - - - The '<' operator where a nullable value appears on both left and right sides - - - - - The '<=' operator where a nullable value appears on both left and right sides - - - - - The '>' operator where a nullable value appears on both left and right sides - - - - - The '>=' operator where a nullable value appears on both left and right sides - - - - - The '<>' operator where a nullable value appears on the right - - - - - The '=' operator where a nullable value appears on the right - - - - - The '<' operator where a nullable value appears on the right - - - - - The '<=' operator where a nullable value appears on the right - - - - - The '>' operator where a nullable value appears on the right - - - - - The '>=' operator where a nullable value appears on the right - - - - - The '<>' operator where a nullable value appears on the left - - - - - The '=' operator where a nullable value appears on the left - - - - - The '<' operator where a nullable value appears on the left - - - - - The '<=' operator where a nullable value appears on the left - - - - - The '>' operator where a nullable value appears on the left - - - - - The '>=' operator where a nullable value appears on the left - - - - - Operators for working with nullable values - - - - - A method used to support the F# query syntax. Runs the given quotation as a query using LINQ IEnumerable rules. - - - - - A method used to support the F# query syntax. Runs the given quotation as a query using LINQ rules. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - A type used to reconstruct a grouping after applying a mutable->immutable mapping transformation - on a result of a query. - - - - - The generic MethodInfo for Select function - Describes how we got from productions of immutable objects to productions of anonymous objects, with enough information - that we can invert the process in final query results. - - - - - Given the expression part of a "yield" or "select" which produces a result in terms of immutable tuples or immutable records, - generate an equivalent expression yielding anonymous objects. Also return the conversion for the immutable-to-mutable correspondence - so we can reverse this later. - - - - - Simplify gets of tuples and gets of record fields. - - - - - Cleanup the use of property-set object constructions in leaf expressions that form parts of F# queries. - - - - - Given an type involving immutable tuples and records, logically corresponding to the type produced at a - "yield" or "select", convert it to a type involving anonymous objects according to the conversion data. - - - - - Recognize anonymous type construction written using 'new AnonymousObject(<e1>, <e2>, ...)' - - - - - Recognize object construction written using 'new O(Prop1 = <e>, Prop2 = <e>, ...)' - - - - - Tests whether a list consists only of assignments of properties of the - given variable, null values (ignored) and ends by returning the given variable - (pattern returns only property assignments) - - - - - Recognize sequential series written as (... ((<e>; <e>); <e>); ...) - - - - - A runtime helper used to evaluate nested quotation literals. - - - - - A runtime helper used to evaluate nested quotation literals. - - - - - Evaluates a subset of F# quotations by first converting to a LINQ expression, for the subset of LINQ expressions represented by the - expression syntax in the C# language. - - - - - Converts a subset of F# quotations to a LINQ expression, for the subset of LINQ expressions represented by the - expression syntax in the C# language. - - - - - Converts a subset of F# quotations to a LINQ expression, for the subset of LINQ expressions represented by the - expression syntax in the C# language. - - - - - When used in a quotation, this function indicates a specific conversion - should be performed when converting the quotation to a LINQ expression. - - This function should not be called directly. - - - - - When used in a quotation, this function indicates a specific conversion - should be performed when converting the quotation to a LINQ expression. - - This function should not be called directly. - - - - - When used in a quotation, this function indicates a specific conversion - should be performed when converting the quotation to a LINQ expression. - - This function should not be called directly. - - - - Allocates a region of memory on the stack. - The number of objects of type T to allocate. - A typed pointer to the allocated memory. - - - Assigns the value into the memory location referenced by the typed native - pointer computed by adding index * sizeof<'T> to the given input pointer. - The input pointer. - The index by which to offset the pointer. - The value to assign. - - - Assigns the value into the memory location referenced by the given typed native pointer. - The input pointer. - The value to assign. - - - Dereferences the given typed native pointer. - The input pointer. - The value at the pointer address. - - - Dereferences the typed native pointer computed by adding index * sizeof<'T> to the - given input pointer. - The input pointer. - The index by which to offset the pointer. - The value at the pointer address. - - - Returns a typed native pointer by adding index * sizeof<'T> to the - given input pointer. - The input pointer. - The index by which to offset the pointer. - A typed pointer. - - - Returns a machine address for a given typed native pointer. - The input pointer. - The machine address. - - - Returns a typed native pointer for a given machine address. - The pointer address. - A typed pointer. - - - Contains operations on native pointers. Use of these operators may - result in the generation of unverifiable code. - - - Gets the raw expression associated with this type-carrying expression - - - Type-carrying quoted expressions. Expressions are generated either - by quotations in source text or programatically - - - Returns type of an expression. - - - Returns the custom attributes of an expression. - - - Builds an expression that represents a value and its associated reflected definition as a quotation - The untyped object. - The type of the object. - The definition of the value being quoted. - The resulting expression. - - - Builds an expression that represents a value and its associated reflected definition as a quotation - The value being quoted. - The definition of the value being quoted. - The resulting expression. - - - Builds an expression that represents a while loop - The predicate to control the loop iteration. - The body of the while loop. - The resulting expression. - - - Builds an expression that represents setting a mutable variable - The input variable. - The value to set. - The resulting expression. - - - Builds an expression that represents a variable - The input variable. - The resulting expression. - - - Builds an expression that represents a constant value of a particular type, arising from a variable of the given name - The untyped object. - The type of the object. - The name of the variable. - The resulting expression. - - - Builds an expression that represents a constant value, arising from a variable of the given name - The typed value. - The name of the variable. - The resulting expression. - - - Builds an expression that represents a constant value - The typed value. - The resulting expression. - - - Builds an expression that represents a constant value of a particular type - The untyped object. - The type of the object. - The resulting expression. - - - Builds an expression that represents a test of a value is of a particular union case - The expression to test. - The description of the union case. - The resulting expression. - - - Builds an expression that represents a type test. - The expression to test. - The target type. - The resulting expression. - - - Builds an expression that represents getting a field of a tuple - The input tuple. - The index of the tuple element to get. - The resulting expression. - - - Builds an expression that represents a try/with construct for exception filtering and catching. - The body of the try expression. - - - The variable to bind to a caught exception. - The expression evaluated when an exception is caught. - The resulting expression. - - - Try and find a stored reflection definition for the given method. Stored reflection - definitions are added to an F# assembly through the use of the [<ReflectedDefinition>] attribute. - The description of the method to find. - The reflection definition or None if a match could not be found. - - - Builds an expression that represents a try/finally construct - The body of the try expression. - The final part of the expression to be evaluated. - The resulting expression. - - - Format the expression as a string - Indicates if method, property, constructor and type objects should be printed in detail. If false, these are abbreviated to their name. - The formatted string. - - - Substitutes through the given expression using the given functions - to map variables to new values. The functions must give consistent results - at each application. Variable renaming may occur on the target expression - if variable capture occurs. - The function to map variables into expressions. - The expression with the given substitutions. - - - Builds an expression that represents the sequential execution of one expression followed by another - The first expression. - The second expression. - The resulting expression. - - - Permits interactive environments such as F# Interactive - to explicitly register new pickled resources that represent persisted - top level definitions. - The assembly associated with the resource. - The unique name for the resources being added. - The type definitions referenced. - The serialized resource to register with the environment. - - - Permits interactive environments such as F# Interactive - to explicitly register new pickled resources that represent persisted - top level definitions. - The assembly associated with the resource. - The unique name for the resources being added. - The serialized resource to register with the environment. - - - Builds an expression that represents a nested typed quotation literal - The expression being quoted. - The resulting expression. - - - Builds an expression that represents a nested raw quotation literal - The expression being quoted. - The resulting expression. - - - Builds an expression that represents a nested typed or raw quotation literal - The expression being quoted. - The resulting expression. - - - Builds an expression that represents writing to a static property - The description of the property. - The value to set. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents writing to a property of an object - The input object. - The description of the property. - The value to set. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents reading a static property - The description of the property. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents reading a property of an object - The input object. - The description of the property. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents the creation of a union case value - The description of the union case. - The list of arguments for the case. - The resulting expression. - - - Builds an expression that represents the creation of an F# tuple value - The list of elements of the tuple. - The resulting expression. - - - Builds record-construction expressions - The type of record. - The list of elements of the record. - The resulting expression. - - - Builds an expression that represents the invocation of an object constructor - The description of the constructor. - The list of arguments to the constructor. - The resulting expression. - - - Builds an expression that represents the creation of a delegate value for the given type - The type of delegate. - The parameters for the delegate. - The body of the function. - The resulting expression. - - - Builds an expression that represents the creation of an array value initialized with the given elements - The type for the elements of the array. - The list of elements of the array. - The resulting expression. - - - Builds recursives expressions associated with 'let rec' constructs - The list of bindings for the let expression. - The sub-expression where the bindings are in scope. - The resulting expression. - - - Builds expressions associated with 'let' constructs - The variable in the let expression. - The expression bound to the variable. - The sub-expression where the binding is in scope. - The resulting expression. - - - Builds an expression that represents the constrution of an F# function value - The parameter to the function. - The body of the function. - The resulting expression. - - - Builds 'if ... then ... else' expressions. - The condition expression. - The then sub-expression. - The else sub-expression. - The resulting expression. - - - Fetches or creates a new variable with the given name and type from a global pool of shared variables - indexed by name and type. The type is given by the expicit or inferred type parameter - The variable name. - The created of fetched typed global variable. - - - Gets the free expression variables of an expression as a list. - A sequence of the free variables in the expression. - - - Builds a 'for i = ... to ... do ...' expression that represent loops over integer ranges - The sub-expression declaring the loop variable. - The sub-expression setting the initial value of the loop variable. - The sub-expression declaring the final value of the loop variable. - The sub-expression representing the body of the loop. - The resulting expression. - - - Builds an expression that represents writing to a field of an object - The input object. - The description of the field to write to. - The value to set to the field. - The resulting expression. - - - Builds an expression that represents writing to a static field - The description of the field to write to. - The value to the set to the field. - The resulting expression. - - - Builds an expression that represents the access of a field of an object - The input object. - The description of the field to access. - The resulting expression. - - - Builds an expression that represents the access of a static field - The description of the field to access. - The resulting expression. - - - This function is called automatically when quotation syntax (<@ @>) and other sources of - quotations are used. - A type in the assembly where the quotation occurs. - The type definitions referenced. - The spliced types, to replace references to type variables. - The spliced expressions to replace references to spliced expressions. - The serialized form of the quoted expression. - The resulting expression. - - - This function is called automatically when quotation syntax (<@ @>) and other sources of - quotations are used. - A type in the assembly where the quotation occurs. - The spliced types, to replace references to type variables. - The spliced expressions to replace references to spliced expressions. - The serialized form of the quoted expression. - The resulting expression. - - - Builds an expression that represents the invocation of a default object constructor - The type on which the constructor is invoked. - The resulting expression. - - - Builds an expression that represents the coercion of an expression to a type - The expression to coerce. - The target type. - The resulting expression. - - - Returns a new typed expression given an underlying runtime-typed expression. - A type annotation is usually required to use this function, and - using an incorrect type annotation may result in a later runtime exception. - The expression to cast. - The resulting typed expression. - - - Builds an expression that represents a call to an instance method associated with an object - The input object. - The description of the method to call. - The list of arguments to the method. - The resulting expression. - - - Builds an expression that represents a call to an static method or module-bound function - The MethodInfo describing the method to call. - The list of arguments to the method. - The resulting expression. - - - Builds an expression that represents the application of a first class function value to multiple arguments - The function to apply. - The list of lists of arguments to the function. - The resulting expression. - - - Builds an expression that represents the application of a first class function value to a single argument. - The function to apply. - The argument to the function. - The resulting expression. - - - Builds an expression that represents setting the value held at a particular address. - The target expression. - The value to set at the address. - The resulting expression. - - - Builds an expression that represents getting the address of a value. - The target expression. - The resulting expression. - - - Quoted expressions annotated with System.Type values. - - - The type associated with the variable - - - The declared name of the variable - - - Indicates if the variable represents a mutable storage location - - - Fetches or create a new variable with the given name and type from a global pool of shared variables - indexed by name and type - The name of the variable. - The type associated with the variable. - The retrieved or created variable. - - - Creates a new variable with the given name, type and mutability - The declared name of the variable. - The type associated with the variable. - Indicates if the variable represents a mutable storage location. Default is false. - The created variable. - - - Information at the binding site of a variable - - - Re-build combination expressions. The first parameter should be an object - returned by the ShapeCombination case of the active pattern in this module. - The input shape. - The list of arguments. - The rebuilt expression. - - - An active pattern that performs a complete decomposition viewing the expression tree as a binding structure - The input expression. - The decomposed Var, Lambda, or ConstApp. - - - Active patterns for traversing, visiting, rebuilding and tranforming expressions in a generic way - - - An active pattern to recognize property setters that have an associated ReflectedDefinition - The description of the property. - The expression of the method definition if found, or None. - - - An active pattern to recognize property getters or values in modules that have an associated ReflectedDefinition - The description of the property. - The expression of the method definition if found, or None. - - - An active pattern to recognize methods that have an associated ReflectedDefinition - The description of the method. - The expression of the method definition if found, or None. - - - A parameterized active pattern to recognize calls to a specified function or method. - The returned elements are the optional target object (present if the target is an - instance method), the generic type instantation (non-empty if the target is a generic - instantiation), and the arguments to the function or method. - The input template expression to specify the method to call. - The optional target object (present if the target is an - instance method), the generic type instantation (non-empty if the target is a generic - instantiation), and the arguments to the function or method. - - - An active pattern to recognize constant decimal expressions - The input expression to match against. - decimal option - - - An active pattern to recognize constant unsigned int64 expressions - The input expression to match against. - uint64 option - - - An active pattern to recognize constant int64 expressions - The input expression to match against. - int64 option - - - An active pattern to recognize constant unsigned int32 expressions - The input expression to match against. - uint32 option - - - An active pattern to recognize constant int32 expressions - The input expression to match against. - int32 option - - - An active pattern to recognize constant unsigned int16 expressions - The input expression to match against. - uint16 option - - - An active pattern to recognize constant int16 expressions - The input expression to match against. - int16 option - - - An active pattern to recognize constant byte expressions - The input expression to match against. - byte option - - - An active pattern to recognize constant signed byte expressions - The input expression to match against. - sbyte option - - - An active pattern to recognize constant unicode character expressions - The input expression to match against. - char option - - - An active pattern to recognize constant 64-bit floating point number expressions - The input expression to match against. - float option - - - An active pattern to recognize constant 32-bit floating point number expressions - The input expression to match against. - float32 option - - - An active pattern to recognize constant string expressions - The input expression to match against. - string option - - - An active pattern to recognize constant boolean expressions - The input expression to match against. - bool option - - - An active pattern to recognize () constant expressions - The input expression to match against. - unit option - - - An active pattern to recognize expressions of the form a || b - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions of the form a && b - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent the application of a (possibly curried or tupled) first class function value - The input expression to match against. - (Expr * Expr list list) option - - - An active pattern to recognize expressions that represent a (possibly curried or tupled) first class function value - The input expression to match against. - (Var list list * Expr) option - - - Contains a set of derived F# active patterns to analyze F# expression objects - - - An active pattern to recognize expressions that represent setting a mutable variable - The input expression to match against. - (Var * Expr) option - - - An active pattern to recognize expressions that represent a variable - The input expression to match against. - Var option - - - An active pattern to recognize expressions that are a value with an associated definition - The input expression to match against. - The boxed value, its static type and its definition - - - An active pattern to recognize expressions that represent a constant value - The input expression to match against. - The boxed value, its static type and its name - - - An active pattern to recognize expressions that represent a constant value. This also matches expressions matched by ValueWithName. - The input expression to match against. - The boxed value and its static type - - - An active pattern to recognize expressions that represent a test if a value is of a particular union case - The input expression to match against. - The expression and union case being tested - - - An active pattern to recognize expressions that represent a dynamic type test - The input expression to match against. - The expression and type being tested - - - An active pattern to recognize expressions that represent getting a tuple field - The input expression to match against. - The expression and tuple field being accessed - - - An active pattern to recognize expressions that represent a try/finally construct - The input expression to match against. - The body and handler parts of the try/finally expression - - - An active pattern to recognize expressions that represent a try/with construct for exception filtering and catching - The input expression to match against. - (Expr * Var * Expr * Var * Expr) option - - - An active pattern to recognize expressions that represent sequential exeuction of one expression followed by another - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent a nested typed quotation literal - The input expression to match against. - Expr option - - - An active pattern to recognize expressions that represent a nested raw quotation literal - The input expression to match against. - Expr option - - - An active pattern to recognize expressions that represent a nested quotation literal - The input expression to match against. - Expr option - - - An active pattern to recognize expressions that represent setting a static or instance property, or a non-function value declared in a module - The input expression to match against. - (Expr option * PropertyInfo * Expr list * Expr) option - - - An active pattern to recognize expressions that represent the read of a static or instance property, or a non-function value declared in a module - The input expression to match against. - (Expr option * PropertyInfo * Expr list) option - - - An active pattern to recognize expressions that represent construction of tuple values - The input expression to match against. - (Expr list) option - - - An active pattern to recognize expressions that represent construction of particular union case values - The input expression to match against. - (UnionCaseInfo * Expr list) option - - - An active pattern to recognize expressions that represent construction of record values - The input expression to match against. - (Type * Expr list) option - - - An active pattern to recognize expressions that represent invocation of object constructors - The input expression to match against. - (ConstructorInfo * Expr list) option - - - An active pattern to recognize expressions that represent construction of delegate values - The input expression to match against. - (Type * Var list * Expr) option - - - An active pattern to recognize expressions that represent invocations of a default constructor of a struct - The input expression to match against. - Type option - - - An active pattern to recognize expressions that represent the construction of arrays - The input expression to match against. - (Type * Expr list) option - - - An active pattern to recognize expressions that represent recursive let bindings of one or more variables - The input expression to match against. - ((Var * Expr) list * Expr) option - - - An active pattern to recognize expressions that represent let bindings - The input expression to match against. - (Var * Expr * Expr) option - - - An active pattern to recognize expressions that represent first class function values - The input expression to match against. - (Var * Expr) option - - - An active pattern to recognize expressions that represent conditionals - The input expression to match against. - (Expr * Expr * Expr) option - - - An active pattern to recognize expressions that represent while loops - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent loops over integer ranges - The input expression to match against. - (Var * Expr * Expr * Expr) option - - - An active pattern to recognize expressions that represent setting a static or instance field - The input expression to match against. - (Expr option * FieldInfo * Expr) option - - - An active pattern to recognize expressions that represent getting a static or instance field - The input expression to match against. - (Expr option * FieldInfo) option - - - An active pattern to recognize expressions that represent coercions from one type to another - The input expression to match against. - (Expr * Type) option - - - An active pattern to recognize expressions that represent calls to static and instance methods, and functions defined in modules - The input expression to match against. - (Expr option * MethodInfo * Expr list) option - - - An active pattern to recognize expressions that represent applications of first class function values - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent setting the value held at an address - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent getting the address of a value - The input expression to match against. - Expr option - - - Contains a set of primitive F# active patterns to analyze F# expression objects - - - Returns a System.Type representing an F# tuple type with the given element types - An array of types for the tuple elements. - The type representing the tuple containing the input elements. - - - Returns a System.Type representing the F# function type with the given domain and range - The input type of the function. - The output type of the function. - The function type with the given domain and range. - - - Returns true if the typ is a representation of an F# union type or the runtime type of a value of that type - The type to check. - Optional binding flags. - True if the type check succeeds. - - - Return true if the typ is a representation of an F# tuple type - The type to check. - True if the type check succeeds. - - - Return true if the typ is a representation of an F# record type - The type to check. - Optional binding flags. - True if the type check succeeds. - - - Return true if the typ is a System.Type value corresponding to the compiled form of an F# module - The type to check. - True if the type check succeeds. - - - Return true if the typ is a representation of an F# function type or the runtime type of a closure implementing an F# function type - The type to check. - True if the type check succeeds. - - - Returns true if the typ is a representation of an F# exception declaration - The type to check. - Optional binding flags. - True if the type check is an F# exception. - - - Gets the cases of a union type. - - Assumes the given type is a union type. If not, ArgumentException is raised during pre-computation. - The input union type. - Optional binding flags. - Thrown when the input type is not a union type. - An array of descriptions of the cases of the given union type. - - - Gets the tuple elements from the representation of an F# tuple type. - The input tuple type. - An array of the types contained in the given tuple type. - - - Reads all the fields from a record value, in declaration order - - Assumes the given input is a record value. If not, ArgumentException is raised. - The input record type. - Optional binding flags. - An array of descriptions of the properties of the record type. - - - Gets the domain and range types from an F# function type or from the runtime type of a closure implementing an F# type - The input function type. - A tuple of the domain and range types of the input function. - - - Reads all the fields from an F# exception declaration, in declaration order - - Assumes exceptionType is an exception representation type. If not, ArgumentException is raised. - The exception type to read. - Optional binding flags. - Thrown if the given type is not an exception. - An array containing the PropertyInfo of each field in the exception. - - - Contains operations associated with constructing and analyzing F# types such as records, unions and tuples - - - Assumes the given type is a union type. - If not, ArgumentException is raised during pre-computation. - - Using the computed function is more efficient than calling GetUnionCase - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The type of union to optimize reading. - Optional binding flags. - An optimized function to read the tags of the given union type. - - - Precompute a property or static method for reading an integer representing the case tag of a union type. - The type of union to read. - Optional binding flags. - The description of the union case reader. - - - Precomputes a function for reading all the fields for a particular discriminator case of a union type - - Using the computed function will typically be faster than executing a corresponding call to GetFields - The description of the union case to read. - Optional binding flags. - A function to for reading the fields of the given union case. - - - A method that constructs objects of the given case - The description of the union case. - Optional binding flags. - The description of the constructor of the given union case. - - - Precomputes a function for constructing a discriminated union value for a particular union case. - The description of the union case. - Optional binding flags. - A function for constructing values of the given union case. - - - Precomputes a function for reading the values of a particular tuple type - - Assumes the given type is a TupleType. - If not, ArgumentException is raised during pre-computation. - The tuple type to read. - Thrown when the given type is not a tuple type. - A function to read values of the given tuple type. - - - Gets information that indicates how to read a field of a tuple - The input tuple type. - The index of the tuple element to describe. - The description of the tuple element and an optional type and index if the tuple is big. - - - Gets a method that constructs objects of the given tuple type. - For small tuples, no additional type will be returned. - - For large tuples, an additional type is returned indicating that - a nested encoding has been used for the tuple type. In this case - the suffix portion of the tuple type has the given type and an - object of this type must be created and passed as the last argument - to the ConstructorInfo. A recursive call to PreComputeTupleConstructorInfo - can be used to determine the constructor for that the suffix type. - The input tuple type. - The description of the tuple type constructor and an optional extra type - for large tuples. - - - Precomputes a function for reading the values of a particular tuple type - - Assumes the given type is a TupleType. - If not, ArgumentException is raised during pre-computation. - The type of tuple to read. - Thrown when the given type is not a tuple type. - A function to read a particular tuple type. - - - Precompute a function for reading all the fields from a record. The fields are returned in the - same order as the fields reported by a call to Microsoft.FSharp.Reflection.Type.GetInfo for - this type. - - Assumes the given type is a RecordType. - If not, ArgumentException is raised during pre-computation. - - Using the computed function will typically be faster than executing a corresponding call to Value.GetInfo - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The type of record to read. - Optional binding flags. - Thrown when the input type is not a record type. - An optimized reader for the given record type. - - - Precompute a function for reading a particular field from a record. - Assumes the given type is a RecordType with a field of the given name. - If not, ArgumentException is raised during pre-computation. - - Using the computed function will typically be faster than executing a corresponding call to Value.GetInfo - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The PropertyInfo of the field to read. - Thrown when the input type is not a record type. - A function to read the specified field from the record. - - - Get a ConstructorInfo for a record type - The record type. - Optional binding flags. - A ConstructorInfo for the given record type. - - - Precompute a function for constructing a record value. - - Assumes the given type is a RecordType. - If not, ArgumentException is raised during pre-computation. - The type of record to construct. - Optional binding flags. - Thrown when the input type is not a record type. - A function to construct records of the given type. - - - Create a union case value. - The description of the union case to create. - The array of arguments to construct the given case. - Optional binding flags. - The constructed union case. - - - Creates an instance of a tuple type - - Assumes at least one element is given. If not, ArgumentException is raised. - The array of tuple fields. - The tuple type to create. - Thrown if no elements are given. - An instance of the tuple type with the given elements. - - - Creates an instance of a record type. - - Assumes the given input is a record type. - The type of record to make. - The array of values to initialize the record. - Optional binding flags for the record. - Thrown when the input type is not a record type. - The created record. - - - Builds a typed function from object from a dynamic function implementation - The function type of the implementation. - The untyped lambda of the function implementation. - A typed function from the given dynamic implementation. - - - Identify the union case and its fields for an object - - Assumes the given input is a union case value. If not, ArgumentException is raised. - - If the type is not given, then the runtime type of the input object is used to identify the - relevant union type. The type should always be given if the input object may be null. For example, - option values may be represented using the 'null'. - The input union case. - The union type containing the value. - Optional binding flags. - Thrown when the input type is not a union case value. - The description of the union case and its fields. - - - Reads all fields from a tuple. - - Assumes the given input is a tuple value. If not, ArgumentException is raised. - The input tuple. - Thrown when the input is not a tuple value. - An array of the fields from the given tuple. - - - Reads a field from a tuple value. - - Assumes the given input is a tuple value. If not, ArgumentException is raised. - The input tuple. - The index of the field to read. - The value of the field. - - - Reads all the fields from a record value. - - Assumes the given input is a record value. If not, ArgumentException is raised. - The record object. - Optional binding flags for the record. - Thrown when the input type is not a record type. - The array of fields from the record. - - - Reads a field from a record value. - - Assumes the given input is a record value. If not, ArgumentException is raised. - The record object. - The PropertyInfo describing the field to read. - Thrown when the input type is not a record type. - The field from the record. - - - Reads all the fields from a value built using an instance of an F# exception declaration - - Assumes the given input is an F# exception value. If not, ArgumentException is raised. - The exception instance. - Optional binding flags. - Thrown when the input type is not an F# exception. - The fields from the given exception. - - - Contains operations associated with constructing and analyzing values associated with F# types - such as records, unions and tuples. - - - The integer tag for the case. - - - The name of the case. - - - The type in which the case occurs. - - - The fields associated with the case, represented by a PropertyInfo. - The fields associated with the case. - - - Returns the custom attributes data associated with the case. - An list of custom attribute data items. - - - Returns the custom attributes associated with the case matching the given attribute type. - The type of attributes to return. - An array of custom attributes. - - - Returns the custom attributes associated with the case. - An array of custom attributes. - - - Represents a case of a discriminated union type - - - Returns true if the typ is a representation of an F# exception declaration - The type to check. - Optional flag that denotes accessibility of the private representation. - True if the type check is an F# exception. - - - Reads all the fields from an F# exception declaration, in declaration order - - Assumes exceptionType is an exception representation type. If not, ArgumentException is raised. - The exception type to read. - Optional flag that denotes accessibility of the private representation. - Thrown if the given type is not an exception. - An array containing the PropertyInfo of each field in the exception. - - - Returns true if the typ is a representation of an F# union type or the runtime type of a value of that type - The type to check. - Optional flag that denotes accessibility of the private representation. - True if the type check succeeds. - - - Return true if the typ is a representation of an F# record type - The type to check. - Optional flag that denotes accessibility of the private representation. - True if the type check succeeds. - - - Gets the cases of a union type. - - Assumes the given type is a union type. If not, ArgumentException is raised during pre-computation. - The input union type. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a union type. - An array of descriptions of the cases of the given union type. - - - Reads all the fields from a record value, in declaration order - - Assumes the given input is a record value. If not, ArgumentException is raised. - The input record type. - Optional flag that denotes accessibility of the private representation. - An array of descriptions of the properties of the record type. - - - Reads all the fields from a value built using an instance of an F# exception declaration - - Assumes the given input is an F# exception value. If not, ArgumentException is raised. - The exception instance. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not an F# exception. - The fields from the given exception. - - - A method that constructs objects of the given case - The description of the union case. - Optional flag that denotes accessibility of the private representation. - The description of the constructor of the given union case. - - - Precomputes a function for constructing a discriminated union value for a particular union case. - The description of the union case. - Optional flag that denotes accessibility of the private representation. - A function for constructing values of the given union case. - - - Precomputes a function for reading all the fields for a particular discriminator case of a union type - - Using the computed function will typically be faster than executing a corresponding call to GetFields - The description of the union case to read. - Optional flag that denotes accessibility of the private representation. - A function to for reading the fields of the given union case. - - - Precompute a property or static method for reading an integer representing the case tag of a union type. - The type of union to read. - Optional flag that denotes accessibility of the private representation. - The description of the union case reader. - - - Assumes the given type is a union type. - If not, ArgumentException is raised during pre-computation. - - Using the computed function is more efficient than calling GetUnionCase - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The type of union to optimize reading. - Optional flag that denotes accessibility of the private representation. - An optimized function to read the tags of the given union type. - - - Identify the union case and its fields for an object - - Assumes the given input is a union case value. If not, ArgumentException is raised. - - If the type is not given, then the runtime type of the input object is used to identify the - relevant union type. The type should always be given if the input object may be null. For example, - option values may be represented using the 'null'. - The input union case. - The union type containing the value. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a union case value. - The description of the union case and its fields. - - - Create a union case value. - The description of the union case to create. - The array of arguments to construct the given case. - Optional flag that denotes accessibility of the private representation. - The constructed union case. - - - Get a ConstructorInfo for a record type - The record type. - Optional flag that denotes accessibility of the private representation. - A ConstructorInfo for the given record type. - - - Precompute a function for constructing a record value. - - Assumes the given type is a RecordType. - If not, ArgumentException is raised during pre-computation. - The type of record to construct. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - A function to construct records of the given type. - - - Precompute a function for reading all the fields from a record. The fields are returned in the - same order as the fields reported by a call to Microsoft.FSharp.Reflection.Type.GetInfo for - this type. - - Assumes the given type is a RecordType. - If not, ArgumentException is raised during pre-computation. - - Using the computed function will typically be faster than executing a corresponding call to Value.GetInfo - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The type of record to read. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - An optimized reader for the given record type. - - - Reads all the fields from a record value. - - Assumes the given input is a record value. If not, ArgumentException is raised. - The record object. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - The array of fields from the record. - - - Creates an instance of a record type. - - Assumes the given input is a record type. - The type of record to make. - The array of values to initialize the record. - Optional flags that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - The created record. - - - - A record of options to control structural formatting. - For F# Interactive properties matching those of this value can be accessed via the 'fsi' - value. - - Floating Point format given in the same format accepted by System.Double.ToString, - e.g. f6 or g15. - - If ShowProperties is set the printing process will evaluate properties of the values being - displayed. This may cause additional computation. - - The ShowIEnumerable is set the printing process will force the evalution of IEnumerable objects - to a small, finite depth, as determined by the printing parameters. - This may lead to additional computation being performed during printing. - - <example> - From F# Interactive the default settings can be adjusted using, for example, - <pre> - open Microsoft.FSharp.Compiler.Interactive.Settings;; - setPrintWidth 120;; - </pre> - </example> - - - - - Data representing structured layouts of terms. - - - - - Convert any value to a layout using the given formatting options. The - layout can then be processed using formatting display engines such as - those in the LayoutOps module. any_to_string and output_any are - built using any_to_layout with default format options. - - - - - Ouput any value to a channel using the same set of formatting rules - as any_to_string - - - - - Convert any value to a string using a standard formatter - Data is typically formatted in a structured format, e.g. - lists are formatted using the "[1;2]" notation. - The details of the format are not specified and may change - from version to version and according to the flags given - to the F# compiler. The format is intended to be human-readable, - not machine readable. If alternative generic formats are required - you should develop your own formatter, using the code in the - implementation of this file as a starting point. - - Data from other .NET languages is formatted using a virtual - call to Object.ToString() on the boxed version of the input. - - - - - For limitting layout of list-like sequences (lists,arrays,etc). - unfold a list of items using (project and z) making layout list via itemL. - If reach maxLength (before exhausting) then truncate. - - - - - See tagL - - - - - Layout like an F# list. - - - - - Layout like an F# option. - - - - - Layout list vertically. - - - - - Layout two vertically. - - - - - Form tuple of layouts. - - - - - Wrap braces around layout. - - - - - Wrap square brackets around layout. - - - - - Wrap round brackets around Layout. - - - - - Join layouts into a list separated using the given Layout. - - - - - Join layouts into a semi-colon separated list. - - - - - Join layouts into a space separated list. - - - - - Join layouts into a comma separated list. - - - - - Join broken with ident=2 - - - - - Join broken with ident=1 - - - - - Join broken with ident=0 - - - - - Join, possible break with indent=2 - - - - - Join, possible break with indent=1 - - - - - Join, possible break with indent=0 - - - - - Join, unbreakable. - - - - - An string which is left parenthesis (no space on the right). - - - - - An string which is right parenthesis (no space on the left). - - - - - An string which requires no spaces either side. - - - - - An string leaf - - - - - An uninterpreted leaf, to be interpreted into a string - by the layout engine. This allows leaf layouts for numbers, strings and - other atoms to be customized according to culture. - - - - - Is it the empty layout? - - - - - The empty layout - - - - - A layout is a sequence of strings which have been joined together. - The strings are classified as words, separators and left and right parenthesis. - This classification determines where spaces are inserted. - A joint is either unbreakable, breakable or broken. - If a joint is broken the RHS layout occurs on the next line with optional indentation. - A layout can be squashed to for given width which forces breaks as required. - - - - diff --git a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+monoandroid10+monotouch10+xamarinios10/FSharp.Core.dll b/packages/FSharp.Core.4.0.0.1/lib/portable-net45+monoandroid10+monotouch10+xamarinios10/FSharp.Core.dll deleted file mode 100644 index c1f6345..0000000 Binary files a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+monoandroid10+monotouch10+xamarinios10/FSharp.Core.dll and /dev/null differ diff --git a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+monoandroid10+monotouch10+xamarinios10/FSharp.Core.optdata b/packages/FSharp.Core.4.0.0.1/lib/portable-net45+monoandroid10+monotouch10+xamarinios10/FSharp.Core.optdata deleted file mode 100644 index a559edf..0000000 Binary files a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+monoandroid10+monotouch10+xamarinios10/FSharp.Core.optdata and /dev/null differ diff --git a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+monoandroid10+monotouch10+xamarinios10/FSharp.Core.sigdata b/packages/FSharp.Core.4.0.0.1/lib/portable-net45+monoandroid10+monotouch10+xamarinios10/FSharp.Core.sigdata deleted file mode 100644 index 92dbe60..0000000 Binary files a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+monoandroid10+monotouch10+xamarinios10/FSharp.Core.sigdata and /dev/null differ diff --git a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45+wp8/FSharp.Core.dll b/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45+wp8/FSharp.Core.dll deleted file mode 100644 index ac6db7a..0000000 Binary files a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45+wp8/FSharp.Core.dll and /dev/null differ diff --git a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45+wp8/FSharp.Core.optdata b/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45+wp8/FSharp.Core.optdata deleted file mode 100644 index 7219069..0000000 Binary files a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45+wp8/FSharp.Core.optdata and /dev/null differ diff --git a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45+wp8/FSharp.Core.sigdata b/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45+wp8/FSharp.Core.sigdata deleted file mode 100644 index 3cb2f4f..0000000 Binary files a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45+wp8/FSharp.Core.sigdata and /dev/null differ diff --git a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45+wp8/FSharp.Core.xml b/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45+wp8/FSharp.Core.xml deleted file mode 100644 index 05c2497..0000000 --- a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45+wp8/FSharp.Core.xml +++ /dev/null @@ -1,10918 +0,0 @@ - - -FSharp.Core - - - Gets the tail of the list, which is a list containing all the elements of the list, excluding the first element - - - Gets the number of items contained in the list - - - Gets the element of the list at the given position. - Lists are represented as linked lists so this is an O(n) operation. - The index. - The value at the given index. - - - Gets a value indicating if the list contains no entries - - - Gets the first element of the list - - - Returns an empty list of a particular type - - - Gets a slice of the list, the elements of the list from the given start index to the given end index. - The start index. - The end index. - The sub list specified by the input indices. - - - Returns a list with head as its first element and tail as its subsequent elements - A new head value for the list. - The existing list. - The list with head appended to the front of tail. - - - The type of immutable singly-linked lists. - - Use the constructors [] and :: (infix) to create values of this type, or - the notation [1;2;3]. Use the values in the List module to manipulate - values of this type, or pattern match against the values directly. - - - Lookup an element in the map. Raise KeyNotFoundException if no binding - exists in the map. - The input key. - Thrown when the key is not found. - The value mapped to the key. - - - Returns true if there are no bindings in the map. - - - The number of bindings in the map. - - - Lookup an element in the map, returning a Some value if the element is in the domain - of the map and None if not. - The input key. - The mapped value, or None if the key is not in the map. - - - Removes an element from the domain of the map. No exception is raised if the element is not present. - The input key. - The resulting map. - - - Tests if an element is in the domain of the map. - The input key. - True if the map contains the given key. - - - Returns a new map with the binding added to the given map. - The input key. - The resulting map. - - - Builds a map that contains the bindings of the given IEnumerable. - The input sequence of key/value pairs. - The resulting map. - - - Immutable maps. Keys are ordered by F# generic comparison. - - Maps based on generic comparison are efficient for small keys. They are not a suitable choice if keys are recursive data structures - or if keys require bespoke comparison semantics. - - All members of this class are thread-safe and may be used concurrently from multiple threads. - - - An abbreviation for the CLI type System.Collections.Generic.List<_> - - - Returns a new set with the elements of the second set removed from the first. - The first input set. - The second input set. - A set containing elements of the first set that are not contained in the second set. - - - Compute the union of the two sets. - The first input set. - The second input set. - The union of the two input sets. - - - Returns the lowest element in the set according to the ordering being used for the set. - - - Returns the highest element in the set according to the ordering being used for the set. - - - A useful shortcut for Set.isEmpty. See the Set module for further operations on sets. - - - The number of elements in the set - - - A useful shortcut for Set.remove. Note this operation produces a new set - and does not mutate the original set. The new set will share many storage - nodes with the original. See the Set module for further operations on sets. - The value to remove from the set. - The result set. - - - Evaluates to "true" if all elements of the second set are in the first. - The set to test against. - True if this set is a superset of otherSet. - - - Evaluates to "true" if all elements of the first set are in the second. - The set to test against. - True if this set is a subset of otherSet. - - - Evaluates to "true" if all elements of the second set are in the first, and at least - one element of the first is not in the second. - The set to test against. - True if this set is a proper superset of otherSet. - - - Evaluates to "true" if all elements of the first set are in the second, and at least - one element of the second is not in the first. - The set to test against. - True if this set is a proper subset of otherSet. - - - A useful shortcut for Set.contains. See the Set module for further operations on sets. - The value to check. - True if the set contains value. - - - A useful shortcut for Set.add. Note this operation produces a new set - and does not mutate the original set. The new set will share many storage - nodes with the original. See the Set module for further operations on sets. - The value to add to the set. - The result set. - - - Create a set containing elements drawn from the given sequence. - The input sequence. - The result set. - - - Immutable sets based on binary trees, where comparison is the - F# structural comparison function, potentially using implementations - of the IComparable interface on key values. - - See the Set module for further operations on sets. - - All members of this class are thread-safe and may be used concurrently from multiple threads. - - - An abbreviation for the type of immutable singly-linked lists. - - Use the constructors [] and :: (infix) to create values of this type, or - the notation [1;2;3]. Use the values in the List module to manipulate - values of this type, or pattern match against the values directly. - - - An abbreviation for the CLI type System.Collections.Generic.IEnumerable<_> - - - Fetches an element from a 2D array. You can also use the syntax array.[index1,index2]. - - The input array. - The index along the first dimension. - The index along the second dimension. - - The value of the array at the given index. - Thrown when the indices are negative or exceed the bounds of the array. - - - Sets the value of an element in an array. You can also use the syntax array.[index1,index2] <- value. - - The input array. - The index along the first dimension. - The index along the second dimension. - The value to set in the array. - Thrown when the indices are negative or exceed the bounds of the array. - - - Builds a new array whose elements are the same as the input array but - where a non-zero-based input array generates a corresponding zero-based - output array. - - The input array. - - The zero-based output array. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer indices passed to the - function indicates the element being transformed. - - For non-zero-based arrays the basing on an input array will be propagated to the output - array. - - A function that is applied to transform each element of the array. The two integers - provide the index of the element. - The input array. - - An array whose elements have been transformed by the given mapping. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - - A function that is applied to transform each item of the input array. - The input array. - - An array whose elements have been transformed by the given mapping. - - - Returns the length of an array in the second dimension. - - The input array. - - The length of the array in the second dimension. - - - Returns the length of an array in the first dimension. - - The input array. - - The length of the array in the first dimension. - - - Applies the given function to each element of the array. The integer indices passed to the - function indicates the index of element. - - A function to apply to each element of the array with the indices available as an argument. - The input array. - - - Applies the given function to each element of the array. - - A function to apply to each element of the array. - The input array. - - - Creates a based array where the entries are initially Unchecked.defaultof<'T>. - - The base for the first dimension of the array. - The base for the second dimension of the array. - The length of the first dimension of the array. - The length of the second dimension of the array. - - The created array. - Thrown when base1, base2, length1, or length2 is negative. - - - Creates a based array whose elements are all initially the given value. - - The base for the first dimension of the array. - The base for the second dimension of the array. - The length of the first dimension of the array. - The length of the second dimension of the array. - The value to populate the new array. - - The created array. - Thrown when base1, base2, length1, or length2 is negative. - - - Creates a based array given the dimensions and a generator function to compute the elements. - - The base for the first dimension of the array. - The base for the second dimension of the array. - The length of the first dimension of the array. - The length of the second dimension of the array. - A function to produce elements of the array given the two indices. - - The created array. - Thrown when base1, base2, length1, or length2 is negative. - - - Creates an array where the entries are initially Unchecked.defaultof<'T>. - - The length of the first dimension of the array. - The length of the second dimension of the array. - - The created array. - Thrown when length1 or length2 is negative. - - - Creates an array whose elements are all initially the given value. - - The length of the first dimension of the array. - The length of the second dimension of the array. - The value to populate the new array. - - The created array. - Thrown when length1 or length2 is negative. - - - Creates an array given the dimensions and a generator function to compute the elements. - - The length of the first dimension of the array. - The length of the second dimension of the array. - A function to produce elements of the array given the two indices. - - The generated array. - Thrown when either of the lengths is negative. - - - Reads a range of elements from the first array and write them into the second. - - The source array. - The first-dimension index to begin copying from in the source array. - The second-dimension index to begin copying from in the source array. - The target array. - The first-dimension index to begin copying into in the target array. - The second-dimension index to begin copying into in the target array. - The number of elements to copy across the first dimension of the arrays. - The number of elements to copy across the second dimension of the arrays. - Thrown when any of the indices are negative or if either of - the counts are larger than the dimensions of the array allow. - - - Builds a new array whose elements are the same as the input array. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - - The input array. - - A copy of the input array. - - - Fetches the base-index for the second dimension of the array. - - The input array. - - The base-index of the second dimension of the array. - - - Fetches the base-index for the first dimension of the array. - - The input array. - - The base-index of the first dimension of the array. - - - Basic operations on 2-dimensional arrays. - - F# and CLI multi-dimensional arrays are typically zero-based. - However, CLI multi-dimensional arrays used in conjunction with external - libraries (e.g. libraries associated with Visual Basic) be - non-zero based, using a potentially different base for each dimension. - The operations in this module will accept such arrays, and - the basing on an input array will be propagated to a matching output - array on the Array2D.map and Array2D.mapi operations. - Non-zero-based arrays can also be created using Array2D.zeroCreateBased, - Array2D.createBased and Array2D.initBased. - - - Creates an array where the entries are initially the "default" value. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The created array. - - - Sets the value of an element in an array. You can also - use the syntax 'array.[index1,index2,index3] <- value'. - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The value to set at the given index. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer indices passed to the - function indicates the element being transformed. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - The function to transform the elements at each index in the array. - The input array. - The array created from the transformed elements. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - The function to transform each element of the array. - The input array. - The array created from the transformed elements. - - - Returns the length of an array in the third dimension. - The input array. - The length of the array in the third dimension. - - - Returns the length of an array in the second dimension. - The input array. - The length of the array in the second dimension. - - - Returns the length of an array in the first dimension - The input array. - The length of the array in the first dimension. - - - Applies the given function to each element of the array. The integer indicies passed to the - function indicates the index of element. - The function to apply to each element of the array. - The input array. - - - Applies the given function to each element of the array. - The function to apply to each element of the array. - The input array. - - - Fetches an element from a 3D array. You can also use the syntax 'array.[index1,index2,index3]' - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The value at the given index. - - - Creates an array given the dimensions and a generator function to compute the elements. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The function to create an initial value at each index into the array. - The created array. - - - Creates an array whose elements are all initially the given value. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The value of the array elements. - The created array. - - - Basic operations on rank 3 arrays. - - - Sets the value of an element in an array. You can also - use the syntax 'array.[index1,index2,index3,index4] <- value'. - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The index along the fourth dimension. - The value to set. - - - Fetches an element from a 4D array. You can also use the syntax 'array.[index1,index2,index3,index4]' - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The index along the fourth dimension. - The value at the given index. - - - Creates an array where the entries are initially the "default" value. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The length of the fourth dimension. - The created array. - - - Returns the length of an array in the fourth dimension. - The input array. - The length of the array in the fourth dimension. - - - Returns the length of an array in the third dimension. - The input array. - The length of the array in the third dimension. - - - Returns the length of an array in the second dimension. - The input array. - The length of the array in the second dimension. - - - Returns the length of an array in the first dimension - The input array. - The length of the array in the first dimension. - - - Creates an array given the dimensions and a generator function to compute the elements. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The length of the fourth dimension. - The function to create an initial value at each index in the array. - The created array. - - - Creates an array whose elements are all initially the given value - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The length of the fourth dimension. - The initial value for each element of the array. - The created array. - - - Basic operations on rank 4 arrays. - - - Combines three arrays into an array of pairs. The three arrays must have equal lengths, otherwise an ArgumentException is - raised. - The first input array. - The second input array. - The third input array. - Thrown when any of the input arrays are null. - Thrown when the input arrays differ in length. - The array of tupled elements. - - - Combines the two arrays into an array of pairs. The two arrays must have equal lengths, otherwise an ArgumentException is - raised. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The array of tupled elements. - - - Returns an array of sliding windows containing elements drawn from the input - array. Each window is returned as a fresh array. - The number of elements in each window. - The input array. - The result array. - Thrown when the input array is null. - Thrown when windowSize is not positive. - - - Returns a new array containing only the elements of the array - for which the given predicate returns "true". - The function to test the input elements. - The input array. - An array containing the elements for which the given predicate returns true. - - Thrown when the input array is null. - - - Splits an array of triples into three arrays. - The input array. - The tuple of three arrays. - Thrown when the input array is null. - - - Splits an array of pairs into two arrays. - The input array. - The two arrays. - Thrown when the input array is null. - - - Returns an array that contains the elements generated by the given computation. - The given initial state argument is passed to the element generator. - A function that takes in the current state and returns an option tuple of the next - element of the array and the next state value. - The initial state value. - The result array. - - - Returns the index of the last element in the array - that satisfies the given predicate. - The function to test the input elements. - The input array. - Thrown when the input array is null. - The index of the last element that satisfies the predicate, or None. - - - Tries to find the nth element in the array. - Returns None if index is negative or the input array does not contain enough elements. - The index of element to retrieve. - The input array. - The nth element of the array or None. - Thrown when the input array is null. - - - Returns the index of the first element in the array - that satisfies the given predicate. - The function to test the input elements. - The input array. - Thrown when the input array is null. - The index of the first element that satisfies the predicate, or None. - - - Returns the last element for which the given function returns true. - Return None if no such element exists. - The function to test the input elements. - The input array. - Thrown when the input array is null. - The last element that satisfies the predicate, or None. - - - Returns the first element for which the given function returns true. - Return None if no such element exists. - The function to test the input elements. - The input array. - The first element that satisfies the predicate, or None. - Thrown when the input array is null. - - - Returns at most N elements in a new array. - The maximum number of items to return. - The input array. - The result array. - Thrown when the input array is null. - - - Views the given array as a sequence. - The input array. - The sequence of array elements. - Thrown when the input array is null. - - - Builds a list from the given array. - The input array. - The list of array elements. - Thrown when the input array is null. - - - Returns a new array containing the elements of the original except the first element. - - The input array. - Thrown when the array is empty. - Thrown when the input array is null. - A new array containing the elements of the original except the first element. - - - Returns an array that contains all elements of the original array while the - given predicate returns true, and then returns no further elements. - - A function that evaluates to false when no more items should be returned. - The input array. - - The result array. - - Thrown when the input array is null. - - - Returns the first N elements of the array. - Throws InvalidOperationException - if the count exceeds the number of elements in the array. Array.truncate - returns as many items as the array contains instead of throwing an exception. - - The number of items to take. - The input array. - - The result array. - - Thrown when the input array is null. - Thrown when the input array is empty. - Thrown when count exceeds the number of elements - in the list. - - - Returns the sum of the results generated by applying the function to each element of the array. - The function to transform the array elements into the type to be summed. - The input array. - The resulting sum. - Thrown when the input array is null. - - - Returns the sum of the elements in the array. - The input array. - The resulting sum. - Thrown when the input array is null. - - - Sorts the elements of an array, in descending order, using the given projection for the keys and returning a new array. - Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to transform array elements into the type that is compared. - The input array. - The sorted array. - - - Sorts the elements of an array, in descending order, returning a new array. Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The input array. - The sorted array. - - - Splits an array into two arrays, at the given index. - The index at which the array is split. - The input array. - The two split arrays. - - Thrown when the input array is null. - Thrown when split index exceeds the number of elements - in the array. - - - Sorts the elements of an array by mutating the array in-place, using the given comparison function. - Elements are compared using Operators.compare. - The input array. - Thrown when the input array is null. - - - Sorts the elements of an array by mutating the array in-place, using the given comparison function as the order. - The function to compare pairs of array elements. - The input array. - Thrown when the input array is null. - - - Sorts the elements of an array by mutating the array in-place, using the given projection for the keys. - Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to transform array elements into the type that is compared. - The input array. - Thrown when the input array is null. - - - Sorts the elements of an array, using the given comparison function as the order, returning a new array. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to compare pairs of array elements. - The input array. - The sorted array. - Thrown when the input array is null. - - - Sorts the elements of an array, using the given projection for the keys and returning a new array. - Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to transform array elements into the type that is compared. - The input array. - The sorted array. - Thrown when the input array is null. - - - Sorts the elements of an array, returning a new array. Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The input array. - The sorted array. - Thrown when the input array is null. - - - Builds a new array that contains the given subrange specified by - starting index and length. - The input array. - The index of the first element of the sub array. - The length of the sub array. - The created sub array. - Thrown when the input array is null. - Thrown when either startIndex or count is negative, - or when there aren't enough elements in the input array. - - - Bypasses elements in an array while the given predicate returns true, and then returns - the remaining elements in a new array. - A function that evaluates an element of the array to a boolean value. - The input array. - The created sub array. - Thrown when the input array is null. - - - Builds a new array that contains the elements of the given array, excluding the first N elements. - The number of elements to skip. - The input array. - A copy of the input array, after removing the first N elements. - Thrown when the input array is null. - Thrown when count is negative or exceeds the number of - elements in the array. - - - Sets an element of an array. - The input array. - The input index. - The input value. - Thrown when the input array is null. - Thrown when the index is negative or the input array does not contain enough elements. - - - Returns an array that contains one item only. - - The input item. - - The result array of one item. - - - Like foldBack, but return both the intermediary and final results. - The function to update the state given the input elements. - The input array. - The initial state. - The array of state values. - Thrown when the input array is null. - - - Like fold, but return the intermediary and final results. - The function to update the state given the input elements. - The initial state. - The input array. - The array of state values. - Thrown when the input array is null. - - - Returns a new array with the elements in reverse order. - The input array. - The reversed array. - Thrown when the input array is null. - - - Creates an array by replicating the given initial value. - The number of elements to replicate. - The value to replicate - The generated array. - Thrown when count is negative. - - - Applies a function to each element of the array, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f i0 (...(f iN-1 iN)). - A function that takes in the next-to-last element of the list and the - current accumulated result to produce the next accumulated result. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The final result of the reductions. - - - Applies a function to each element of the array, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f (... (f i0 i1)...) iN. - Raises ArgumentException if the array has size zero. - The function to reduce a pair of elements to a single element. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The final result of the redcutions. - - - Returns an array with all elements permuted according to the - specified permutation. - The function that maps input indices to output indices. - The input array. - The output array. - Thrown when the input array is null. - Thrown when indexMap does not produce a valid permutation. - - - Splits the collection into two collections, containing the - elements for which the given predicate returns "true" and "false" - respectively. - The function to test the input elements. - The input array. - A pair of arrays. The first containing the elements the predicate evaluated to true, - and the second containing those evaluated to false. - Thrown when the input array is null. - - - Returns an array of each element in the input array and its predecessor, with the - exception of the first element which is only returned as the predecessor of the second element. - - The input array. - - The result array. - - Thrown when the input sequence is null. - - - Builds a new array from the given enumerable object. - The input sequence. - The array of elements from the sequence. - Thrown when the input sequence is null. - - - Builds an array from the given list. - The input list. - The array of elements from the list. - - - Returns the lowest of all elements of the array, compared via Operators.min on the function result. - - Throws ArgumentException for empty arrays. - The function to transform the elements into a type supporting comparison. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The minimum element. - - - Returns the lowest of all elements of the array, compared via Operators.min. - - Throws ArgumentException for empty arrays - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The minimum element. - - - Returns the greatest of all elements of the array, compared via Operators.max on the function result. - - Throws ArgumentException for empty arrays. - The function to transform the elements into a type supporting comparison. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The maximum element. - - - Returns the greatest of all elements of the array, compared via Operators.max on the function result. - - Throws ArgumentException for empty arrays. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The maximum element. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer index passed to the - function indicates the index of element being transformed. - The function to transform elements and their indices. - The input array. - The array of transformed elements. - Thrown when the input array is null. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the two collections pairwise, also passing the index of - the elements. The two input arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to transform pairs of input elements and their indices. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The array of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding triples from the three collections. The three input - arrays must have the same length, otherwise an ArgumentException is - raised. - The function to transform the pairs of the input elements. - The first input array. - The second input array. - The third input array. - Thrown when the input arrays differ in length. - Thrown when any of the input arrays is null. - The array of transformed elements. - - - Combines map and foldBack. Builds a new array whose elements are the results of applying the given function - to each of the elements of the input array. The function is also used to accumulate a final value. - The function to transform elements from the input array and accumulate the final value. - The input array. - The initial state. - Thrown when the input array is null. - The array of transformed elements, and the final accumulated value. - - - Combines map and fold. Builds a new array whose elements are the results of applying the given function - to each of the elements of the input array. The function is also used to accumulate a final value. - The function to transform elements from the input array and accumulate the final value. - The initial state. - The input array. - Thrown when the input array is null. - The array of transformed elements, and the final accumulated value. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the two collections pairwise. The two input - arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to transform the pairs of the input elements. - The first input array. - The second input array. - Thrown when the input arrays differ in length. - Thrown when either of the input arrays is null. - The array of transformed elements. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. - The function to transform elements of the array. - The input array. - The array of transformed elements. - Thrown when the input array is null. - - - Returns the last element of the array. - Return None if no such element exists. - The input array. - The last element of the array or None. - Thrown when the input sequence is null. - - - Returns the length of an array. You can also use property arr.Length. - The input array. - The length of the array. - Thrown when the input array is null. - - - Gets an element from an array. - The input index. - The input array. - The value of the array at the given index. - Thrown when the input array is null. - Thrown when the index is negative or the input array does not contain enough elements. - - - Returns the last element of the array. - The input array. - The last element of the array. - Thrown when the input array is null. - Thrown when the input does not have any elements. - - - Applies the given function to pair of elements drawn from matching indices in two arrays, - also passing the index of the elements. The two arrays must have the same lengths, - otherwise an ArgumentException is raised. - The function to apply to each index and pair of elements. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - - - Applies the given function to each element of the array. The integer passed to the - function indicates the index of element. - The function to apply to each index and element. - The input array. - Thrown when the input array is null. - - - Applies the given function to pair of elements drawn from matching indices in two arrays. The - two arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to apply. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - - - Applies the given function to each element of the array. - The function to apply. - The input array. - Thrown when the input array is null. - - - Returns true if the given array is empty, otherwise false. - The input array. - True if the array is empty. - Thrown when the input array is null. - - - Creates an array where the entries are initially the default value Unchecked.defaultof<'T>. - The length of the array to create. - The created array. - Thrown when count is negative. - - - Creates an array given the dimension and a generator function to compute the elements. - The number of elements to initialize. - The function to generate the initial values for each index. - The created array. - Thrown when count is negative. - - - Builds a new array whose elements are the corresponding elements of the input array - paired with the integer index (from 0) of each element. - The input array. - The array of indexed elements. - Thrown when the input array is null. - - - Applies a key-generating function to each element of an array and yields an array of - unique keys. Each unique key contains an array of all elements that match - to this key. - - A function that transforms an element of the array into a comparable key. - The input array. - - The result array. - - Thrown when the input array is null. - - - Returns the first element of the array. - - The input array. - - The first element of the array. - - Thrown when the input array is null. - Thrown when the input array is empty. - - - Gets an element from an array. - The input array. - The input index. - The value of the array at the given index. - Thrown when the input array is null. - Thrown when the index is negative or the input array does not contain enough elements. - - - Apply a function to pairs of elements drawn from the two collections, right-to-left, - threading an accumulator argument through the computation. The two input - arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to update the state given the input elements. - The first input array. - The second input array. - The initial state. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The final state. - - - Applies a function to pairs of elements drawn from the two collections, - left-to-right, threading an accumulator argument - through the computation. The two input - arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to update the state given the input elements. - The initial state. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The final state. - - - Applies a function to each element of the array, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then computes - f i0 (...(f iN s)) - The function to update the state given the input elements. - The input array. - The initial state. - The state object after the folding function is applied to each element of the array. - Thrown when the input array is null. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then computes - f (... (f s i0)...) iN - The function to update the state given the input elements. - The initial state. - The input array. - The final state. - Thrown when the input array is null. - - - Tests if all corresponding elements of the array satisfy the given predicate pairwise. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns false then the overall result is - false and no further elements are tested. Otherwise, if one collection is longer - than the other then the ArgumentException exception is raised. - Otherwise, true is returned. - The function to test the input elements. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - True if all of the array elements satisfy the predicate. - - - Tests if all elements of the array satisfy the given predicate. - - The predicate is applied to the elements of the input collection. If any application - returns false then the overall result is false and no further elements are tested. - Otherwise, true is returned. - The function to test the input elements. - The input array. - True if all of the array elements satisfy the predicate. - Thrown when the input array is null. - - - Returns the index of the last element in the array - that satisfies the given predicate. Raise KeyNotFoundException if - none of the elements satisfy the predicate. - The function to test the input elements. - The input array. - Thrown if predicate - never returns true. - Thrown when the input array is null. - The index of the last element in the array that satisfies the given predicate. - - - Returns the index of the first element in the array - that satisfies the given predicate. Raise KeyNotFoundException if - none of the elements satisfy the predicate. - The function to test the input elements. - The input array. - Thrown if predicate - never returns true. - Thrown when the input array is null. - The index of the first element in the array that satisfies the given predicate. - - - Returns the last element for which the given function returns 'true'. - Raise KeyNotFoundException if no such element exists. - The function to test the input elements. - The input array. - Thrown if predicate - never returns true. - Thrown when the input array is null. - The last element for which predicate returns true. - - - Returns the first element for which the given function returns 'true'. - Raise KeyNotFoundException if no such element exists. - The function to test the input elements. - The input array. - Thrown when the input array is null. - Thrown if predicate - never returns true. - The first element for which predicate returns true. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true". - The function to test the input elements. - The input array. - An array containing the elements for which the given predicate returns true. - Thrown when the input array is null. - - - Tests if any pair of corresponding elements of the arrays satisfies the given predicate. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns true then the overall result is - true and no further elements are tested. Otherwise, if one collections is longer - than the other then the ArgumentException exception is raised. - Otherwise, false is returned. - The function to test the input elements. - The first input array. - The second input array. - True if any result from predicate is true. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - - - Tests if any element of the array satisfies the given predicate. - - The predicate is applied to the elements of the input array. If any application - returns true then the overall result is true and no further elements are tested. - Otherwise, false is returned. - The function to test the input elements. - The input array. - True if any result from predicate is true. - Thrown when the input array is null. - - - Returns a new list with the distinct elements of the input array which do not appear in the itemsToExclude sequence, - using generic hash and equality comparisons to compare values. - - A sequence whose elements that also occur in the input array will cause those elements to be - removed from the result. - An array whose elements that are not also in itemsToExclude will be returned. - - An array that contains the distinct elements of array that do not appear in itemsToExclude. - - Thrown when either itemsToExclude or array is null. - - - Returns the only element of the array. - - The input array. - - The only element of the array. - - Thrown when the input array is null. - Thrown when the input does not have precisely one element. - - - Returns an empty array of the given type. - The empty array. - - - Splits the input array into at most count chunks. - The maximum number of chunks. - The input array. - The array split into chunks. - Thrown when the input array is null. - Thrown when count is not positive. - - - Returns an array that contains no duplicate entries according to the - generic hash and equality comparisons on the keys returned by the given key-generating function. - If an element occurs multiple times in the array then the later occurrences are discarded. - - A function transforming the array items into comparable keys. - The input array. - - The result array. - - Thrown when the input array is null. - - - Returns an array that contains no duplicate entries according to generic hash and - equality comparisons on the entries. - If an element occurs multiple times in the array then the later occurrences are discarded. - - The input array. - - The result array. - - Thrown when the input array is null. - - - Divides the input array into chunks of size at most chunkSize. - The maximum size of each chunk. - The input array. - The array divided into chunks. - Thrown when the input array is null. - Thrown when chunkSize is not positive. - - - Applies the given function to each element of the array. Returns - the array comprised of the results "x" for each element where - the function returns Some(x) - The function to generate options from the elements. - The input array. - The array of results. - Thrown when the input array is null. - - - Applies the given function to successive elements, returning the first - result where function returns Some(x) for some x. If the function - never returns Some(x) then KeyNotFoundException is raised. - The function to generate options from the elements. - The input array. - Thrown when the input array is null. - Thrown if every result from - chooser is None. - The first result. - - - Fills a range of elements of the array with the given value. - The target array. - The index of the first element to set. - The number of elements to set. - The value to set. - Thrown when the input array is null. - Thrown when either targetIndex or count is negative. - - - Applies the given function to successive elements, returning the first - result where function returns Some(x) for some x. If the function - never returns Some(x) then None is returned. - The function to transform the array elements into options. - The input array. - The first transformed element that is Some(x). - Thrown when the input array is null. - - - Returns the first element of the array, or - None if the array is empty. - The input array. - Thrown when the input array is null. - The first element of the array or None. - - - Creates an array whose elements are all initially the given value. - The length of the array to create. - The value for the elements. - The created array. - Thrown when count is negative. - - - Applies a key-generating function to each element of an array and returns an array yielding unique - keys and their number of occurrences in the original array. - - A function transforming each item of the input array into a key to be - compared against the others. - The input array. - - The result array. - - Thrown when the input array is null. - - - Builds a new array that contains the elements of the given array. - The input array. - A copy of the input array. - Thrown when the input array is null. - - - Tests if the array contains the specified element. - The value to locate in the input array. - The input array. - True if the input array contains the specified element; false otherwise. - Thrown when the input array is null. - - - Builds a new array that contains the elements of each of the given sequence of arrays. - The input sequence of arrays. - The concatenation of the sequence of input arrays. - Thrown when the input sequence is null. - - - Compares two arrays using the given comparison function, element by element. - Returns the first non-zero result from the comparison function. If the end of an array - is reached it returns a -1 if the first array is shorter and a 1 if the second array - is shorter. - - A function that takes an element from each array and returns an int. - If it evaluates to a non-zero value iteration is stopped and that value is returned. - The first input array. - The second input array. - - The first non-zero value from the comparison function. - - Thrown when either of the input arrays - is null. - - - For each element of the array, applies the given function. Concatenates all the results and return the combined array. - The function to create sub-arrays from the input array elements. - The input array. - The concatenation of the sub-arrays. - Thrown when the input array is null. - - - Reads a range of elements from the first array and write them into the second. - The source array. - The starting index of the source array. - The target array. - The starting index of the target array. - The number of elements to copy. - Thrown when either of the input arrays is null. - Thrown when any of sourceIndex, targetIndex or count are negative, - or when there aren't enough elements in source or target. - - - Returns the average of the elements generated by applying the function to each element of the array. - The function to transform the array elements before averaging. - The input array. - Thrown when array is empty. - The computed average. - Thrown when the input array is null. - - - Returns the average of the elements in the array. - The input array. - Thrown when array is empty. - The average of the elements in the array. - Thrown when the input array is null. - - - Builds a new array that contains the elements of the first array followed by the elements of the second array. - The first input array. - The second input array. - The resulting array. - Thrown when either of the input arrays is null. - - - Basic operations on arrays. - - - Compare using the given comparer function. - A function to compare two values. - An object implementing IComparer using the supplied comparer. - - - Non-structural comparison. Compare using NonStructuralComparison.compare. - - - Structural comparison. Compare using Operators.compare. - - - Common notions of comparison identity used with sorted data structures. - - - Hash using the given hashing and equality functions. - A function to generate a hash code from a value. - A function to test equality of two values. - An object implementing IEqualityComparer using the supplied functions. - - - Physical hashing (hash on reference identity of objects, and the contents of value types). - Hash using LanguagePrimitives.PhysicalEquality and LanguagePrimitives.PhysicalHash, - That is, for value types use GetHashCode and Object.Equals (if no other optimization available), - and for reference types use System.Runtime.CompilerServices.RuntimeHelpers.GetHashCode and - reference equality. - - - Non-structural hashing. Equality using NonStructuralComparison.(=) and NonStructuralComparison.hash. - - - Structural hashing. Hash using Operators.(=) and Operators.hash. - - - Common notions of value identity used with hash tables. - - - Combines the three lists into a list of triples. The lists must have equal lengths. - The first input list. - The second input list. - The third input list. - A single list containing triples of matching elements from the input lists. - - - Combines the two lists into a list of pairs. The two lists must have equal lengths. - The first input list. - The second input list. - A single list containing pairs of matching elements from the input lists. - - - Returns a list of sliding windows containing elements drawn from the input - list. Each window is returned as a fresh list. - The number of elements in each window. - The input list. - The result list. - Thrown when windowSize is not positive. - - - Returns a new list containing only the elements of the list - for which the given predicate returns "true" - The function to test the input elements. - The input list. - A list containing only the elements that satisfy the predicate. - - - Splits a list of triples into three lists. - The input list. - Three lists of split elements. - - - Splits a list of pairs into two lists. - The input list. - Two lists of split elements. - - - Returns a list that contains the elements generated by the given computation. - The given initial state argument is passed to the element generator. - A function that takes in the current state and returns an option tuple of the next - element of the list and the next state value. - The initial state value. - The result list. - - - Returns the index of the last element in the list - that satisfies the given predicate. - Return None if no such element exists. - The function to test the input elements. - The input list. - The index of the last element for which the predicate returns true, or None if - every element evaluates to false. - - - Tries to find the nth element in the list. - Returns None if index is negative or the list does not contain enough elements. - The index to retrieve. - The input list. - The value at the given index or None. - - - Returns the index of the first element in the list - that satisfies the given predicate. - Return None if no such element exists. - The function to test the input elements. - The input list. - The index of the first element for which the predicate returns true, or None if - every element evaluates to false. - - - Returns the last element for which the given function returns true.. - Return None if no such element exists. - The function to test the input elements. - The input list. - The last element for which the predicate returns true, or None if - every element evaluates to false. - - - Returns the first element for which the given function returns true.. - Return None if no such element exists. - The function to test the input elements. - The input list. - The first element for which the predicate returns true, or None if - every element evaluates to false. - - - Applies the given function to successive elements, returning Some(x) the first - result where function returns Some(x) for some x. If no such element - exists then return None. - The function to generate options from the elements. - The input list. - The first resulting value or None. - - - Returns at most N elements in a new list. - The maximum number of items to return. - The input list. - The result list. - - - Returns the first element of the list, or - None if the list is empty. - The input list. - The first element of the list or None. - - - Views the given list as a sequence. - The input list. - The sequence of elements in the list. - - - Builds an array from the given list. - The input list. - The array containing the elements of the list. - - - Returns a list that contains all elements of the original list while the - given predicate returns true, and then returns no further elements. - - A function that evaluates to false when no more items should be returned. - The input list. - - The result list. - - - Returns the first N elements of the list. - Throws InvalidOperationException - if the count exceeds the number of elements in the list. List.truncate - returns as many items as the list contains instead of throwing an exception. - - The number of items to take. - The input list. - - The result list. - - Thrown when the input list is empty. - Thrown when count exceeds the number of elements - in the list. - - - Returns the list after removing the first element. - - The input list. - Thrown when the list is empty. - The list after removing the first element. - - - Returns the sum of the results generated by applying the function to each element of the list. - The function to transform the list elements into the type to be summed. - The input list. - The resulting sum. - - - Returns the sum of the elements in the list. - The input list. - The resulting sum. - - - Sorts the given list in descending order using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The input list. - The sorted list. - - - Sorts the given list in descending order using keys given by the given projection. Keys are compared using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The function to transform the list elements into the type to be compared. - The input list. - The sorted list. - - - Splits a list into two lists, at the given index. - The index at which the list is split. - The input list. - The two split lists. - - Thrown when split index exceeds the number of elements - in the list. - - - Sorts the given list using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The input list. - The sorted list. - - - Sorts the given list using keys given by the given projection. Keys are compared using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The function to transform the list elements into the type to be compared. - The input list. - The sorted list. - - - Sorts the given list using the given comparison function. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The function to compare the list elements. - The input list. - The sorted list. - - - Bypasses elements in a list while the given predicate returns true, and then returns - the remaining elements of the list. - A function that evaluates an element of the list to a boolean value. - The input list. - The result list. - - - Returns the list after removing the first N elements. - The number of elements to skip. - The input list. - The list after removing the first N elements. - Thrown when count is negative or exceeds the number of - elements in the list. - - - Returns a list that contains one item only. - - The input item. - - The result list of one item. - - - Like foldBack, but returns both the intermediary and final results - The function to update the state given the input elements. - The input list. - The initial state. - The list of states. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. Take the second argument, and apply the function to it - and the first element of the list. Then feed this result into the function along - with the second element and so on. Returns the list of intermediate results and the final result. - The function to update the state given the input elements. - The initial state. - The input list. - The list of states. - - - Returns a new list with the elements in reverse order. - The input list. - The reversed list. - - - Creates a list by replicating the given initial value. - The number of elements to replicate. - The value to replicate - The generated list. - - - Applies a function to each element of the collection, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then computes - f i0 (...(f iN-1 iN)). - A function that takes in the next-to-last element of the list and the - current accumulated result to produce the next accumulated result. - The input list. - Thrown when the list is empty. - The final result of the reductions. - - - Apply a function to each element of the collection, threading an accumulator argument - through the computation. Apply the function to the first two elements of the list. - Then feed this result into the function along with the third element and so on. - Return the final result. If the input function is f and the elements are i0...iN then computes - f (... (f i0 i1) i2 ...) iN. - - Raises System.ArgumentException if list is empty - The function to reduce two list elements to a single element. - The input list. - Thrown when the list is empty. - The final reduced value. - - - Returns a list with all elements permuted according to the - specified permutation. - The function to map input indices to output indices. - The input list. - The permuted list. - Thrown when indexMap does not produce a valid permutation. - - - Applies the given function to successive elements, returning the first - result where function returns Some(x) for some x. If no such - element exists then raise System.Collections.Generic.KeyNotFoundException - The function to generate options from the elements. - The input list. - Thrown when the list is empty. - The first resulting value. - - - Splits the collection into two collections, containing the - elements for which the given predicate returns true and false - respectively. Element order is preserved in both of the created lists. - The function to test the input elements. - The input list. - A list containing the elements for which the predicate evaluated to false and a list - containing the elements for which the predicate evaluated to true. - - - Returns a list of each element in the input list and its predecessor, with the - exception of the first element which is only returned as the predecessor of the second element. - - The input list. - - The result list. - - - Builds a new list from the given enumerable object. - The input sequence. - The list of elements from the sequence. - - - Builds a list from the given array. - The input array. - The list of elements from the array. - - - Indexes into the list. The first element has index 0. - The input list. - The index to retrieve. - The value at the given index. - Thrown when the index is negative or the input list does not contain enough elements. - - - Returns the lowest of all elements of the list, compared via Operators.min on the function result - - Raises System.ArgumentException if list is empty. - The function to transform list elements into the type to be compared. - The input list. - Thrown when the list is empty. - The minimum value. - - - Returns the lowest of all elements of the list, compared via Operators.min. - - Raises System.ArgumentException if list is empty - The input list. - Thrown when the list is empty. - The minimum value. - - - Returns the greatest of all elements of the list, compared via Operators.max on the function result. - - Raises System.ArgumentException if list is empty. - The function to transform the list elements into the type to be compared. - The input list. - Thrown when the list is empty. - The maximum element. - - - Return the greatest of all elements of the list, compared via Operators.max. - - Raises System.ArgumentException if list is empty - The input list. - Thrown when the list is empty. - The maximum element. - - - Like mapi, but mapping corresponding elements from two lists of equal length. - The function to transform pairs of elements from the two lists and their index. - The first input list. - The second input list. - The list of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The integer index passed to the - function indicates the index (from 0) of element being transformed. - The function to transform elements and their indices. - The input list. - The list of transformed elements. - - - Combines map and foldBack. Builds a new list whose elements are the results of applying the given function - to each of the elements of the input list. The function is also used to accumulate a final value. - The function to transform elements from the input list and accumulate the final value. - The input list. - The initial state. - The list of transformed elements, and the final accumulated value. - - - Combines map and fold. Builds a new list whose elements are the results of applying the given function - to each of the elements of the input list. The function is also used to accumulate a final value. - The function to transform elements from the input list and accumulate the final value. - The initial state. - The input list. - The list of transformed elements, and the final accumulated value. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the three collections simultaneously. - The function to transform triples of elements from the input lists. - The first input list. - The second input list. - The third input list. - The list of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the two collections pairwise. - The function to transform pairs of elements from the input lists. - The first input list. - The second input list. - The list of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. - The function to transform elements from the input list. - The input list. - The list of transformed elements. - - - Returns the last element of the list. - Return None if no such element exists. - The input list. - The last element of the list or None. - - - Returns the length of the list. - The input list. - The length of the list. - - - Returns the last element of the list. - The input list. - The last element of the list. - Thrown when the input does not have any elements. - - - Applies the given function to two collections simultaneously. The - collections must have identical size. The integer passed to the - function indicates the index of element. - The function to apply to a pair of elements from the input lists along with their index. - The first input list. - The second input list. - - - Applies the given function to each element of the collection. The integer passed to the - function indicates the index of element. - The function to apply to the elements of the list along with their index. - The input list. - - - Applies the given function to two collections simultaneously. The - collections must have identical size. - The function to apply to pairs of elements from the input lists. - The first input list. - The second input list. - - - Applies the given function to each element of the collection. - The function to apply to elements from the input list. - The input list. - - - Indexes into the list. The first element has index 0. - The index to retrieve. - The input list. - The value at the given index. - Thrown when the index is negative or the input list does not contain enough elements. - - - Returns true if the list contains no elements, false otherwise. - The input list. - True if the list is empty. - - - Creates a list by calling the given generator on each index. - The length of the list to generate. - The function to generate an element from an index. - The list of generated elements. - - - Returns a new list whose elements are the corresponding elements - of the input list paired with the index (from 0) of each element. - The input list. - The list of indexed elements. - - - Returns the first element of the list. - - The input list. - Thrown when the list is empty. - The first element of the list. - - - Applies a key-generating function to each element of a list and yields a list of - unique keys. Each unique key contains a list of all elements that match - to this key. - - A function that transforms an element of the list into a comparable key. - The input list. - - The result list. - - - Tests if all corresponding elements of the collection satisfy the given predicate pairwise. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns false then the overall result is - false and no further elements are tested. Otherwise, if one collection is longer - than the other then the System.ArgumentException exception is raised. - Otherwise, true is returned. - The function to test the input elements. - The first input list. - The second input list. - Thrown when the input lists differ in length. - True if all of the pairs of elements satisfy the predicate. - - - Tests if all elements of the collection satisfy the given predicate. - - The predicate is applied to the elements of the input list. If any application - returns false then the overall result is false and no further elements are tested. - Otherwise, true is returned. - The function to test the input elements. - The input list. - True if all of the elements satisfy the predicate. - - - Applies a function to corresponding elements of two collections, threading an accumulator argument - through the computation. The collections must have identical sizes. - If the input function is f and the elements are i0...iN and j0...jN - then computes f i0 j0 (...(f iN jN s)). - The function to update the state given the input elements. - The first input list. - The second input list. - The initial state. - The final state value. - - - Applies a function to each element of the collection, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then - computes f i0 (...(f iN s)). - The function to update the state given the input elements. - The input list. - The initial state. - The state object after the folding function is applied to each element of the list. - - - Applies a function to corresponding elements of two collections, threading an accumulator argument - through the computation. The collections must have identical sizes. - If the input function is f and the elements are i0...iN and j0...jN - then computes f (... (f s i0 j0)...) iN jN. - The function to update the state given the input elements. - The initial state. - The first input list. - The second input list. - The final state value. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. Take the second argument, and apply the function to it - and the first element of the list. Then feed this result into the function along - with the second element and so on. Return the final result. - If the input function is f and the elements are i0...iN then - computes f (... (f s i0) i1 ...) iN. - The function to update the state given the input elements. - The initial state. - The input list. - The final state value. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true" - The function to test the input elements. - The input list. - A list containing only the elements that satisfy the predicate. - - - Returns the index of the last element in the list - that satisfies the given predicate. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for all the - elements of the list. - The index of the last element that satisfies the predicate. - - - Returns the index of the first element in the list - that satisfies the given predicate. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for all the - elements of the list. - The index of the first element that satisfies the predicate. - - - Returns the last element for which the given function returns true. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for - all the elements of the list. - The last element that satisfies the predicate. - - - Returns the first element for which the given function returns true. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for - all the elements of the list. - The first element that satisfies the predicate. - - - Tests if any pair of corresponding elements of the lists satisfies the given predicate. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns true then the overall result is - true and no further elements are tested. Otherwise, if one collections is longer - than the other then the System.ArgumentException exception is raised. - Otherwise, false is returned. - The function to test the input elements. - The first input list. - The second input list. - Thrown when the input lists differ in length. - True if any pair of elements satisfy the predicate. - - - Tests if any element of the list satisfies the given predicate. - - The predicate is applied to the elements of the input list. If any application - returns true then the overall result is true and no further elements are tested. - Otherwise, false is returned. - The function to test the input elements. - The input list. - True if any element satisfies the predicate. - - - Returns the only element of the list. - - The input list. - - The only element of the list. - - Thrown when the input does not have precisely one element. - - - Returns a new list with the distinct elements of the input list which do not appear in the itemsToExclude sequence, - using generic hash and equality comparisons to compare values. - - A sequence whose elements that also occur in the input list will cause those elements to be - removed from the result. - A list whose elements that are not also in itemsToExclude will be returned. - - A list that contains the distinct elements of list that do not appear in itemsToExclude. - - Thrown when itemsToExclude is null. - - - Returns an empty list of the given type. - - - Splits the input list into at most count chunks. - The maximum number of chunks. - The input list. - The list split into chunks. - Thrown when count is not positive. - - - Applies a key-generating function to each element of a list and returns a list yielding unique - keys and their number of occurrences in the original list. - - A function transforming each item of the input list into a key to be - compared against the others. - The input list. - - The result list. - - - Returns a list that contains no duplicate entries according to the - generic hash and equality comparisons on the keys returned by the given key-generating function. - If an element occurs multiple times in the list then the later occurrences are discarded. - - A function transforming the list items into comparable keys. - The input list. - - The result list. - - - Returns a list that contains no duplicate entries according to generic hash and - equality comparisons on the entries. - If an element occurs multiple times in the list then the later occurrences are discarded. - - The input list. - - The result list. - - - Tests if the list contains the specified element. - The value to locate in the input list. - The input list. - True if the input list contains the specified element; false otherwise. - - - Returns a new list that contains the elements of each the lists in order. - The input sequence of lists. - The resulting concatenated list. - - - Compares two lists using the given comparison function, element by element. - Returns the first non-zero result from the comparison function. If the end of a list - is reached it returns a -1 if the first list is shorter and a 1 if the second list - is shorter. - - A function that takes an element from each list and returns an int. - If it evaluates to a non-zero value iteration is stopped and that value is returned. - The first input list. - The second input list. - - The first non-zero value from the comparison function. - - - For each element of the list, applies the given function. Concatenates all the results and return the combined list. - The function to transform each input element into a sublist to be concatenated. - The input list. - The concatenation of the transformed sublists. - - - Divides the input list into chunks of size at most chunkSize. - The maximum size of each chunk. - The input list. - The list divided into chunks. - Thrown when chunkSize is not positive. - - - Applies the given function to each element of the list. Returns - the list comprised of the results x for each element where - the function returns Some(x) - The function to generate options from the elements. - The input list. - The list comprising the values selected from the chooser function. - - - Returns the average of the elements generated by applying the function to each element of the list. - - Raises System.ArgumentException if list is empty. - The function to transform the list elements into the type to be averaged. - The input list. - Thrown when the list is empty. - The resulting average. - - - Returns the average of the elements in the list. - - Raises System.ArgumentException if list is empty. - The input list. - Thrown when the list is empty. - The resulting average. - - - Returns a new list that contains the elements of the first list - followed by elements of the second. - The first input list. - The second input list. - The resulting list. - - - Basic operations on lists. - - - Returns the key of the first mapping in the collection that satisfies the given predicate. - Returns 'None' if no such element exists. - The function to test the input elements. - The input map. - The first key for which the predicate returns true or None if the predicate evaluates to false for each key/value pair. - - - Evaluates the function on each mapping in the collection. Returns the key for the first mapping - where the function returns 'true'. Raise KeyNotFoundException if no such element exists. - The function to test the input elements. - The input map. - Thrown if the key does not exist in the map. - The first key for which the predicate evaluates true. - - - Lookup an element in the map, returning a Some value if the element is in the domain - of the map and None if not. - The input key. - The input map. - The found Some value or None. - - - Removes an element from the domain of the map. No exception is raised if the element is not present. - The input key. - The input map. - The resulting map. - - - Builds two new maps, one containing the bindings for which the given predicate returns 'true', - and the other the remaining bindings. - The function to test the input elements. - The input map. - A pair of maps in which the first contains the elements for which the predicate returned true - and the second containing the elements for which the predicated returned false. - - - Tests if an element is in the domain of the map. - The input key. - The input map. - True if the map contains the key. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The key passed to the - function indicates the key of element being transformed. - The function to transform the key/value pairs. - The input map. - The resulting map of keys and transformed values. - - - Returns true if the given predicate returns true for all of the - bindings in the map. - The function to test the input elements. - The input map. - True if the predicate evaluates to true for all of the bindings in the map. - - - Builds a new map containing only the bindings for which the given predicate returns 'true'. - The function to test the key/value pairs. - The input map. - The filtered map. - - - Returns true if the given predicate returns true for one of the - bindings in the map. - The function to test the input elements. - The input map. - True if the predicate returns true for one of the key/value pairs. - - - Applies the given function to each binding in the dictionary - The function to apply to each key/value pair. - The input map. - - - Folds over the bindings in the map - The function to update the state given the input key/value pairs. - The initial state. - The input map. - The final state value. - - - Folds over the bindings in the map. - The function to update the state given the input key/value pairs. - The input map. - The initial state. - The final state value. - - - Searches the map looking for the first element where the given function returns a Some value - The function to generate options from the key/value pairs. - The input map. - The first result. - - - Searches the map looking for the first element where the given function returns a Some value. - The function to generate options from the key/value pairs. - The input map. - The first result. - - - Lookup an element in the map, raising KeyNotFoundException if no binding - exists in the map. - The input key. - The input map. - Thrown when the key does not exist in the map. - The value mapped to the given key. - - - The empty map. - - - Is the map empty? - The input map. - True if the map is empty. - - - Returns an array of all key-value pairs in the mapping. - The array will be ordered by the keys of the map. - The input map. - The array of key/value pairs. - - - Returns a list of all key-value pairs in the mapping. - The list will be ordered by the keys of the map. - The input map. - The list of key/value pairs. - - - Views the collection as an enumerable sequence of pairs. - The sequence will be ordered by the keys of the map. - The input map. - The sequence of key/value pairs. - - - Returns a new map made from the given bindings. - The input sequence of key/value pairs. - The resulting map. - - - Returns a new map made from the given bindings. - The input array of key/value pairs. - The resulting map. - - - Returns a new map made from the given bindings. - The input list of key/value pairs. - The resulting map. - - - Returns a new map with the binding added to the given map. - The input key. - The input value. - The input map. - The resulting map. - - - Functional programming operators related to the Map<_,_> type. - - - Combines the three sequences into a list of triples. The sequences need not have equal lengths: - when one sequence is exhausted any remaining elements in the other - sequences are ignored. - - The first input sequence. - The second input sequence. - The third input sequence. - - The result sequence. - - Thrown when any of the input sequences is null. - - - Combines the two sequences into a list of pairs. The two sequences need not have equal lengths: - when one sequence is exhausted any remaining elements in the other - sequence are ignored. - - The first input sequence. - The second input sequence. - - The result sequence. - - Thrown when either of the input sequences is null. - - - Returns a sequence that yields sliding windows containing elements drawn from the input - sequence. Each window is returned as a fresh array. - The number of elements in each window. - The input sequence. - The result sequence. - Thrown when the input sequence is null. - Thrown when windowSize is not positive. - - - Returns a sequence that contains the elements generated by the given computation. - The given initial state argument is passed to the element generator. - For each IEnumerator elements in the stream are generated on-demand by applying the element - generator, until a None value is returned by the element generator. Each call to the element - generator returns a new residual state. - - The stream will be recomputed each time an IEnumerator is requested and iterated for the Seq. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - A function that takes in the current state and returns an option tuple of the next - element of the sequence and the next state value. - The initial state value. - - The result sequence. - - - Returns a sequence that when enumerated returns at most N elements. - - The maximum number of items to enumerate. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Applies the given function to successive elements, returning the first - result where the function returns "Some(x)". - - A function that transforms items from the input sequence into options. - The input sequence. - - The chosen element or None. - - Thrown when the input sequence is null. - - - Returns the index of the last element in the sequence - that satisfies the given predicate. Return None if no such element exists. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - The found index or None. - Thrown when the input sequence is null. - - - Tries to find the nth element in the sequence. - Returns None if index is negative or the input sequence does not contain enough elements. - The index of element to retrieve. - The input sequence. - The nth element of the sequence or None. - Thrown when the input sequence is null. - - - Returns the index of the first element in the sequence - that satisfies the given predicate. Return None if no such element exists. - - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - - The found index or None. - - Thrown when the input sequence is null. - - - Returns the last element for which the given function returns true. - Return None if no such element exists. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - The found element or None. - Thrown when the input sequence is null. - - - Returns the first element for which the given function returns true. - Return None if no such element exists. - - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - - The found element or None. - - Thrown when the input sequence is null. - - - Builds a list from the given collection. - - The input sequence. - - The result list. - - Thrown when the input sequence is null. - - - Builds an array from the given collection. - - The input sequence. - - The result array. - - Thrown when the input sequence is null. - - - Returns a sequence that, when iterated, yields elements of the underlying sequence while the - given predicate returns true, and then returns no further elements. - - A function that evaluates to false when no more items should be returned. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns the first N elements of the sequence. - Throws InvalidOperationException - if the count exceeds the number of elements in the sequence. Seq.truncate - returns as many items as the sequence contains instead of throwing an exception. - - The number of items to take. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - Thrown when count exceeds the number of elements - in the sequence. - - - Returns a sequence that skips 1 element of the underlying sequence and then yields the - remaining elements of the sequence. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the sum of the results generated by applying the function to each element of the sequence. - The generated elements are summed using the + operator and Zero property associated with the generated type. - - A function to transform items from the input sequence into the type that will be summed. - The input sequence. - - The computed sum. - - - Returns the sum of the elements in the sequence. - - The elements are summed using the + operator and Zero property associated with the generated type. - - The input sequence. - - The computed sum. - - - Applies a key-generating function to each element of a sequence and yield a sequence ordered - descending by keys. The keys are compared using generic comparison as implemented by Operators.compare. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - A function to transform items of the input sequence into comparable keys. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Yields a sequence ordered descending by keys. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Applies a key-generating function to each element of a sequence and yield a sequence ordered - by keys. The keys are compared using generic comparison as implemented by Operators.compare. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - A function to transform items of the input sequence into comparable keys. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Yields a sequence ordered using the given comparison function. - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - The function to compare the collection elements. - The input sequence. - The result sequence. - - - Yields a sequence ordered by keys. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that, when iterated, skips elements of the underlying sequence while the - given predicate returns true, and then yields the remaining elements of the sequence. - - A function that evaluates an element of the sequence to a boolean value. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that skips N elements of the underlying sequence and then yields the - remaining elements of the sequence. - - The number of items to skip. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when count exceeds the number of elements - in the sequence. - - - Returns a sequence that yields one item only. - - The input item. - - The result sequence of one item. - - - Like foldBack, but returns the sequence of intermediary and final results. - This function returns a sequence that digests the whole initial sequence as soon as that - sequence is iterated. As a result this function should not be used with large or infinite sequences. - - A function that updates the state with each element from the sequence. - The input sequence. - The initial state. - The resulting sequence of computed states. - Thrown when the input sequence is null. - - - Like fold, but computes on-demand and returns the sequence of intermediary and final results. - - A function that updates the state with each element from the sequence. - The initial state. - The input sequence. - - The resulting sequence of computed states. - - Thrown when the input sequence is null. - - - Returns a new sequence with the elements in reverse order. - The input sequence. - The reversed sequence. - Thrown when the input sequence is null. - - - Applies a function to each element of the sequence, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f i0 (...(f iN-1 iN)). - A function that takes in the next-to-last element of the sequence and the - current accumulated result to produce the next accumulated result. - The input sequence. - The final result of the reductions. - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Creates a sequence by replicating the given initial value. - The number of elements to replicate. - The value to replicate - The generated sequence. - - - Applies a function to each element of the sequence, threading an accumulator argument - through the computation. Begin by applying the function to the first two elements. - Then feed this result into the function along with the third element and so on. - Return the final result. - - A function that takes in the current accumulated result and the next - element of the sequence to produce the next accumulated result. - The input sequence. - - The final result of the reduction function. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Builds a new sequence object that delegates to the given sequence object. This ensures - the original sequence cannot be rediscovered and mutated by a type cast. For example, - if given an array the returned sequence will return the elements of the array, but - you cannot cast the returned sequence object to an array. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Applies the given function to successive elements, returning the first - x where the function returns "Some(x)". - - A function to transform each item of the input sequence into an option of the output type. - The input sequence. - - The selected element. - - Thrown when the input sequence is null. - Thrown when every item of the sequence - evaluates to None when the given function is applied. - - - Returns a sequence with all elements permuted according to the - specified permutation. - - Note that this function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. - - The function that maps input indices to output indices. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when indexMap does not produce a valid permutation. - - - Returns a sequence of each element in the input sequence and its predecessor, with the - exception of the first element which is only returned as the predecessor of the second element. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Views the given list as a sequence. - - The input list. - - The result sequence. - - - Views the given array as a sequence. - - The input array. - - The result sequence. - - Thrown when the input sequence is null. - - - Computes the nth element in the collection. - - The index of element to retrieve. - The input sequence. - - The nth element of the sequence. - - Thrown when the input sequence is null. - Thrown when the index is negative or the input sequence does not contain enough elements. - - - Returns the lowest of all elements of the sequence, compared via Operators.min on the function result. - - A function to transform items from the input sequence into comparable keys. - The input sequence. - - The smallest element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the lowest of all elements of the sequence, compared via Operators.min. - - The input sequence. - - The smallest element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the greatest of all elements of the sequence, compared via Operators.max on the function result. - - A function to transform items from the input sequence into comparable keys. - The input sequence. - - The largest element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the greatest of all elements of the sequence, compared via Operators.max - - The input sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - The largest element of the sequence. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding pairs of elements from the two sequences. If one input sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. The integer index passed to the - function indicates the index (from 0) of element being transformed. - - A function to transform pairs of items from the input sequences that also supplies the current index. - The first input sequence. - The second input sequence. - - The result sequence. - - Thrown when either of the input sequences is null. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The integer index passed to the - function indicates the index (from 0) of element being transformed. - - A function to transform items from the input sequence that also supplies the current index. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding triples of elements from the three sequences. If one input sequence if shorter than - the others then the remaining elements of the longer sequences are ignored. - - The function to transform triples of elements from the input sequences. - The first input sequence. - The second input sequence. - The third input sequence. - - The result sequence. - - Thrown when any of the input sequences is null. - - - Combines map and foldBack. Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The function is also used to accumulate a final value. - This function digests the whole initial sequence as soon as it is called. As a result this function should - not be used with large or infinite sequences. - The function to transform elements from the input collection and accumulate the final value. - The input collection. - The initial state. - Thrown when the input collection is null. - The collection of transformed elements, and the final accumulated value. - - - Combines map and fold. Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The function is also used to accumulate a final value. - This function digests the whole initial sequence as soon as it is called. As a result this function should - not be used with large or infinite sequences. - The function to transform elements from the input collection and accumulate the final value. - The initial state. - The input collection. - Thrown when the input collection is null. - The collection of transformed elements, and the final accumulated value. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding pairs of elements from the two sequences. If one input sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to transform pairs of items from the input sequences. - The first input sequence. - The second input sequence. - - The result sequence. - - Thrown when either of the input sequences is null. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The given function will be applied - as elements are demanded using the MoveNext method on enumerators retrieved from the - object. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - A function to transform items from the input sequence. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns the length of the sequence - - The input sequence. - - The length of the sequence. - - Thrown when the input sequence is null. - - - Applies the given function to two collections simultaneously. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. The integer passed to the - function indicates the index of element. - - A function to apply to each pair of elements from the input sequences along with their index. - The first input sequence. - The second input sequence. - - Thrown when either of the input sequences is null. - - - Applies the given function to two collections simultaneously. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to apply to each pair of elements from the input sequences. - The first input sequence. - The second input sequence. - - Thrown when either of the input sequences is null. - - - Applies the given function to each element of the collection. The integer passed to the - function indicates the index of element. - - A function to apply to each element of the sequence that can also access the current index. - The input sequence. - - Thrown when the input sequence is null. - - - Applies the given function to each element of the collection. - - A function to apply to each element of the sequence. - The input sequence. - - Thrown when the input sequence is null. - - - Computes the element at the specified index in the collection. - The index of the element to retrieve. - The input sequence. - The element at the specified index of the sequence. - Thrown when the input sequence is null. - Thrown when the index is negative or the input sequence does not contain enough elements. - - - Generates a new sequence which, when iterated, will return successive - elements by calling the given function. The results of calling the function - will not be saved, that is the function will be reapplied as necessary to - regenerate the elements. The function is passed the index of the item being - generated. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - Iteration can continue up to Int32.MaxValue. - - A function that generates an item in the sequence from a given index. - - The result sequence. - - - Generates a new sequence which, when iterated, will return successive - elements by calling the given function, up to the given count. Each element is saved after its - initialization. The function is passed the index of the item being - generated. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - The maximum number of items to generate for the sequence. - A function that generates an item in the sequence from a given index. - - The result sequence. - - Thrown when count is negative. - - - Builds a new collection whose elements are the corresponding elements of the input collection - paired with the integer index (from 0) of each element. - The input sequence. - The result sequence. - Thrown when the input sequence is null. - - - Returns true if the sequence contains no elements, false otherwise. - - The input sequence. - - True if the sequence is empty; false otherwise. - - Thrown when the input sequence is null. - - - Returns the only element of the sequence. - - The input sequence. - - The only element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input does not have precisely one element. - - - Returns the last element of the sequence. - Return None if no such element exists. - - The input sequence. - - The last element of the sequence or None. - - Thrown when the input sequence is null. - - - Returns the last element of the sequence. - The input sequence. - The last element of the sequence. - Thrown when the input sequence is null. - Thrown when the input does not have any elements. - - - Returns the first element of the sequence, or None if the sequence is empty. - - The input sequence. - - The first element of the sequence or None. - - Thrown when the input sequence is null. - - - Returns the first element of the sequence. - - The input sequence. - - The first element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input does not have any elements. - - - Applies a key-generating function to each element of a sequence and yields a sequence of - unique keys. Each unique key contains a sequence of all elements that match - to this key. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - A function that transforms an element of the sequence into a comparable key. - The input sequence. - - The result sequence. - - - Tests the all pairs of elements drawn from the two sequences satisfy the - given predicate. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to test pairs of elements from the input sequences. - The first input sequence. - The second input sequence. - - True if all pairs satisfy the predicate; false otherwise. - - Thrown when either of the input sequences is null. - - - Tests if all elements of the sequence satisfy the given predicate. - - The predicate is applied to the elements of the input sequence. If any application - returns false then the overall result is false and no further elements are tested. - Otherwise, true is returned. - - A function to test an element of the input sequence. - The input sequence. - - True if every element of the sequence satisfies the predicate; false otherwise. - - Thrown when the input sequence is null. - - - Applies a function to corresponding elements of two collections, starting from the end of the shorter collection, - threading an accumulator argument through the computation. The two sequences need not have equal lengths. - If the input function is f and the elements are i0...iN and j0...jM, N < M - then computes f i0 j0 (... (f iN jN s)...). - The function to update the state given the input elements. - The first input sequence. - The second input sequence. - The initial state. - The final state value. - Thrown when the either of the input sequences is null. - - - Applies a function to each element of the collection, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f i0 (... (f iN s)...) - The function to update the state given the input elements. - The input sequence. - The initial state. - The state object after the folding function is applied to each element of the sequence. - Thrown when the input sequence is null. - - - Applies a function to corresponding elements of two collections, threading an accumulator argument - through the computation. The two sequences need not have equal lengths: - when one sequence is exhausted any remaining elements in the other sequence are ignored. - If the input function is f and the elements are i0...iN and j0...jN - then computes f (... (f s i0 j0)...) iN jN. - The function to update the state given the input elements. - The initial state. - The first input sequence. - The second input sequence. - The final state value. - Thrown when the either of the input sequences is null. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f (... (f s i0)...) iN - - A function that updates the state with each element from the sequence. - The initial state. - The input sequence. - - The state object after the folding function is applied to each element of the sequence. - - Thrown when the input sequence is null. - - - Returns the index of the last element for which the given function returns true. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function to test whether the index of a particular element should be returned. - The input sequence. - The index of the last element for which the predicate returns true. - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns the index of the first element for which the given function returns true. - - A function to test whether the index of a particular element should be returned. - The input sequence. - - The index of the first element for which the predicate returns true. - - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns the last element for which the given function returns true. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function to test whether an item in the sequence should be returned. - The input sequence. - The last element for which the predicate returns true. - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns the first element for which the given function returns true. - - A function to test whether an item in the sequence should be returned. - The input sequence. - - The first element for which the predicate returns true. - - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true". - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - Remember sequence is lazy, effects are delayed until it is enumerated. - - A synonym for Seq.filter. - - A function to test whether each item in the input sequence should be included in the output. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true". This is a synonym for Seq.where. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - Remember sequence is lazy, effects are delayed until it is enumerated. - - A function to test whether each item in the input sequence should be included in the output. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Tests if any pair of corresponding elements of the input sequences satisfies the given predicate. - - The predicate is applied to matching elements in the two sequences up to the lesser of the - two lengths of the collections. If any application returns true then the overall result is - true and no further elements are tested. Otherwise, false is returned. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to test each pair of items from the input sequences. - The first input sequence. - The second input sequence. - - True if any result from the predicate is true; false otherwise. - - Thrown when either of the two input sequences is null. - - - Tests if any element of the sequence satisfies the given predicate. - - The predicate is applied to the elements of the input sequence. If any application - returns true then the overall result is true and no further elements are tested. - Otherwise, false is returned. - - A function to test each item of the input sequence. - The input sequence. - - True if any result from the predicate is true; false otherwise. - - Thrown when the input sequence is null. - - - Returns a new sequence with the distinct elements of the second sequence which do not apear in the first sequence, - using generic hash and equality comparisons to compare values. - - Note that this function returns a sequence that digests the whole of the first input sequence as soon as - the result sequence is iterated. As a result this function should not be used with - large or infinite sequences in the first parameter. The function makes no assumption on the ordering of the first input - sequence. - - A sequence whose elements that also occur in the second sequence will cause those elements to be - removed from the returned sequence. - A sequence whose elements that are not also in first will be returned. - - A sequence that contains the set difference of the elements of two sequences. - - Thrown when either of the two input sequences is null. - - - Creates an empty sequence. - - An empty sequence. - - - Splits the input sequence into at most count chunks. - This function returns a sequence that digests the whole initial sequence as soon as that - sequence is iterated. As a result this function should not be used with large or infinite sequences. - The maximum number of chunks. - The input sequence. - The sequence split into chunks. - Thrown when the input sequence is null. - Thrown when count is not positive. - - - Returns a sequence that contains no duplicate entries according to the - generic hash and equality comparisons on the keys returned by the given key-generating function. - If an element occurs multiple times in the sequence then the later occurrences are discarded. - - A function transforming the sequence items into comparable keys. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that contains no duplicate entries according to generic hash and - equality comparisons on the entries. - If an element occurs multiple times in the sequence then the later occurrences are discarded. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that is built from the given delayed specification of a - sequence. - - The input function is evaluated each time an IEnumerator for the sequence - is requested. - - The generating function for the sequence. - - - Applies a key-generating function to each element of a sequence and returns a sequence yielding unique - keys and their number of occurrences in the original sequence. - - Note that this function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - A function transforming each item of the input sequence into a key to be - compared against the others. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Tests if the sequence contains the specified element. - The value to locate in the input sequence. - The input sequence. - True if the input sequence contains the specified element; false otherwise. - Thrown when the input sequence is null. - - - Combines the given enumeration-of-enumerations as a single concatenated - enumeration. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - The input enumeration-of-enumerations. - - The result sequence. - - Thrown when the input sequence is null. - - - Compares two sequences using the given comparison function, element by element. - Returns the first non-zero result from the comparison function. If the end of a sequence - is reached it returns a -1 if the first sequence is shorter and a 1 if the second sequence - is shorter. - - A function that takes an element from each sequence and returns an int. - If it evaluates to a non-zero value iteration is stopped and that value is returned. - The first input sequence. - The second input sequence. - - The first non-zero value from the comparison function. - - Thrown when either of the input sequences - is null. - - - Applies the given function to each element of the sequence and concatenates all the - results. - - Remember sequence is lazy, effects are delayed until it is enumerated. - - A function to transform elements of the input sequence into the sequences - that will then be concatenated. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Divides the input sequence into chunks of size at most chunkSize. - The maximum size of each chunk. - The input sequence. - The sequence divided into chunks. - Thrown when the input sequence is null. - Thrown when chunkSize is not positive. - - - Applies the given function to each element of the list. Return - the list comprised of the results "x" for each element where - the function returns Some(x). - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not - be accessed concurrently. - - A function to transform items of type T into options of type U. - The input sequence of type T. - - The result sequence. - - Thrown when the input sequence is null. - - - Wraps a loosely-typed System.Collections sequence as a typed sequence. - - The use of this function usually requires a type annotation. - An incorrect type annotation may result in runtime type - errors. - Individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that corresponds to a cached version of the input sequence. - This result sequence will have the same elements as the input sequence. The result - can be enumerated multiple times. The input sequence will be enumerated at most - once and only as far as is necessary. Caching a sequence is typically useful when repeatedly - evaluating items in the original sequence is computationally expensive or if - iterating the sequence causes side-effects that the user does not want to be - repeated multiple times. - - Enumeration of the result sequence is thread safe in the sense that multiple independent IEnumerator - values may be used simultaneously from different threads (accesses to - the internal lookaside table are thread safe). Each individual IEnumerator - is not typically thread safe and should not be accessed concurrently. - - Once enumeration of the input sequence has started, - it's enumerator will be kept live by this object until the enumeration has completed. - At that point, the enumerator will be disposed. - - The enumerator may be disposed and underlying cache storage released by - converting the returned sequence object to type IDisposable, and calling the Dispose method - on this object. The sequence object may then be re-enumerated and a fresh enumerator will - be used. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns the average of the results generated by applying the function to each element - of the sequence. - - The elements are averaged using the + operator, DivideByInt method and Zero property - associated with the generated type. - - A function applied to transform each element of the sequence. - The input sequence. - - The average. - - Thrown when the input sequence is null. - Thrown when the input sequence has zero elements. - - - Returns the average of the elements in the sequence. - - The elements are averaged using the + operator, DivideByInt method and Zero property - associated with the element type. - - The input sequence. - - The average. - - Thrown when the input sequence is null. - Thrown when the input sequence has zero elements. - - - Wraps the two given enumerations as a single concatenated - enumeration. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed - concurrently. - - The first sequence. - The second sequence. - - The result sequence. - - Thrown when either of the two provided sequences is - null. - - - Basic operations on IEnumerables. - - - Returns a new set with the elements of the second set removed from the first. - The first input set. - The set whose elements will be removed from set1. - The set with the elements of set2 removed from set1. - - - Builds a new collection from the given enumerable object. - The input sequence. - The set containing elements. - - - Returns an ordered view of the collection as an enumerable object. - The input set. - An ordered sequence of the elements of set. - - - Builds an array that contains the elements of the set in order. - The input set. - An ordered array of the elements of set. - - - Builds a set that contains the same elements as the given array. - The input array. - A set containing the elements of array. - - - Builds a list that contains the elements of the set in order. - The input set. - An ordered list of the elements of set. - - - Builds a set that contains the same elements as the given list. - The input list. - A set containing the elements form the input list. - - - Returns the highest element in the set according to the ordering being used for the set. - The input set. - The max value from the set. - - - Returns the lowest element in the set according to the ordering being used for the set. - The input set. - The min value from the set. - - - Returns a new set with the given element removed. No exception is raised if - the set doesn't contain the given element. - The element to remove. - The input set. - The input set with value removed. - - - Splits the set into two sets containing the elements for which the given predicate - returns true and false respectively. - The function to test set elements. - The input set. - A pair of sets with the first containing the elements for which predicate returns - true and the second containing the elements for which predicate returns false. - - - Applies the given function to each element of the set, in order according - to the comparison function. - The function to apply to each element. - The input set. - - - Returns "true" if the set is empty. - The input set. - True if set is empty. - - - Computes the union of a sequence of sets. - The sequence of sets to untion. - The union of the input sets. - - - Computes the union of the two sets. - The first input set. - The second input set. - The union of set1 and set2. - - - Computes the intersection of a sequence of sets. The sequence must be non-empty. - The sequence of sets to intersect. - The intersection of the input sets. - - - Computes the intersection of the two sets. - The first input set. - The second input set. - The intersection of set1 and set2. - - - Tests if all elements of the collection satisfy the given predicate. - If the input function is f and the elements are i0...iN and "j0...jN" - then computes p i0 && ... && p iN. - The function to test set elements. - The input set. - True if all elements of set satisfy predicate. - - - Applies the given accumulating function to all the elements of the set. - The accumulating function. - The input set. - The initial state. - The final state. - - - Applies the given accumulating function to all the elements of the set - The accumulating function. - The initial state. - The input set. - The final state. - - - Returns a new collection containing the results of applying the - given function to each element of the input set. - The function to transform elements of the input set. - The input set. - A set containing the transformed elements. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns true. - The function to test set elements. - The input set. - The set containing only the elements for which predicate returns true. - - - Tests if any element of the collection satisfies the given predicate. - If the input function is predicate and the elements are i0...iN - then computes p i0 or ... or p iN. - The function to test set elements. - The input set. - True if any element of set satisfies predicate. - - - Returns the number of elements in the set. Same as size. - The input set. - The number of elements in the set. - - - Evaluates to "true" if all elements of the second set are in the first, and at least - one element of the first is not in the second. - The potential superset. - The set to test against. - True if set1 is a proper superset of set2. - - - Evaluates to "true" if all elements of the second set are in the first. - The potential superset. - The set to test against. - True if set1 is a superset of set2. - - - Evaluates to "true" if all elements of the first set are in the second, and at least - one element of the second is not in the first. - The potential subset. - The set to test against. - True if set1 is a proper subset of set2. - - - Evaluates to "true" if all elements of the first set are in the second - The potential subset. - The set to test against. - True if set1 is a subset of set2. - - - Evaluates to "true" if the given element is in the given set. - The element to test. - The input set. - True if element is in set. - - - Returns a new set with an element added to the set. No exception is raised if - the set already contains the given element. - The value to add. - The input set. - A new set containing value. - - - The set containing the given element. - The value for the set to contain. - The set containing value. - - - The empty set for the type 'T. - - - Functional programming operators related to the Set<_> type. - - - Gets the default cancellation token for executing asynchronous computations. - The default CancellationToken. - - - Creates an asynchronous computation that returns the CancellationToken governing the execution - of the computation. - In async { let! token = Async.CancellationToken ...} token can be used to initiate other - asynchronous operations that will cancel cooperatively with this workflow. - An asynchronous computation capable of retrieving the CancellationToken from a computation - expression. - - - Creates an asynchronous computation that executes computation. - If this computation is cancelled before it completes then the computation generated by - running compensation is executed. - The input asynchronous computation. - The function to be run if the computation is cancelled. - An asynchronous computation that runs the compensation if the input computation - is cancelled. - - - Creates an asynchronous computation that queues a work item that runs - its continuation. - A computation that generates a new work item in the thread pool. - - - Creates an asynchronous computation that creates a new thread and runs - its continuation in that thread. - A computation that will execute on a new thread. - - - Creates an asynchronous computation that runs - its continuation using syncContext.Post. If syncContext is null - then the asynchronous computation is equivalent to SwitchToThreadPool(). - The synchronization context to accept the posted computation. - An asynchronous computation that uses the syncContext context to execute. - - - Runs an asynchronous computation, starting immediately on the current operating system - thread. Call one of the three continuations when the operation completes. - If no cancellation token is provided then the default cancellation token - is used. - The asynchronous computation to execute. - The function called on success. - The function called on exception. - The function called on cancellation. - The CancellationToken to associate with the computation. - The default is used if this parameter is not provided. - - - Runs an asynchronous computation, starting immediately on the current operating system - thread. - If no cancellation token is provided then the default cancellation token is used. - The asynchronous computation to execute. - The CancellationToken to associate with the computation. - The default is used if this parameter is not provided. - - - Creates an asynchronous computation which starts the given computation as a System.Threading.Tasks.Task - - - Starts a child computation within an asynchronous workflow. - This allows multiple asynchronous computations to be executed simultaneously. - - This method should normally be used as the immediate - right-hand-side of a let! binding in an F# asynchronous workflow, that is, - - async { ... - let! completor1 = childComputation1 |> Async.StartChild - let! completor2 = childComputation2 |> Async.StartChild - ... - let! result1 = completor1 - let! result2 = completor2 - ... } - - When used in this way, each use of StartChild starts an instance of childComputation - and returns a completor object representing a computation to wait for the completion of the operation. - When executed, the completor awaits the completion of childComputation. - The child computation. - The timeout value in milliseconds. If one is not provided - then the default value of -1 corresponding to System.Threading.Timeout.Infinite. - A new computation that waits for the input computation to finish. - - - Executes a computation in the thread pool. - If no cancellation token is provided then the default cancellation token is used. - A System.Threading.Tasks.Task that will be completed - in the corresponding state once the computation terminates (produces the result, throws exception or gets canceled) - - - - Starts the asynchronous computation in the thread pool. Do not await its result. - - If no cancellation token is provided then the default cancellation token is used. - The computation to run asynchronously. - The cancellation token to be associated with the computation. - If one is not supplied, the default cancellation token is used. - - - Creates an asynchronous computation that will sleep for the given time. This is scheduled - using a System.Threading.Timer object. The operation will not block operating system threads - for the duration of the wait. - The number of milliseconds to sleep. - An asynchronous computation that will sleep for the given time. - Thrown when the due time is negative - and not infinite. - - - Runs the asynchronous computation and await its result. - - If an exception occurs in the asynchronous computation then an exception is re-raised by this - function. - - If no cancellation token is provided then the default cancellation token is used. - - The timeout parameter is given in milliseconds. A value of -1 is equivalent to - System.Threading.Timeout.Infinite. - The computation to run. - The amount of time in milliseconds to wait for the result of the - computation before raising a System.TimeoutException. If no value is provided - for timeout then a default of -1 is used to correspond to System.Threading.Timeout.Infinite. - The cancellation token to be associated with the computation. - If one is not supplied, the default cancellation token is used. - The result of the computation. - - - Creates an asynchronous computation that executes all the given asynchronous computations, - initially queueing each as work items and using a fork/join pattern. - - If all child computations succeed, an array of results is passed to the success continuation. - - If any child computation raises an exception, then the overall computation will trigger an - exception, and cancel the others. - - The overall computation will respond to cancellation while executing the child computations. - If cancelled, the computation will cancel any remaining child computations but will still wait - for the other child computations to complete. - A sequence of distinct computations to be parallelized. - A computation that returns an array of values from the sequence of input computations. - - - Generates a scoped, cooperative cancellation handler for use within an asynchronous workflow. - - For example, - async { use! holder = Async.OnCancel interruption ... } - generates an asynchronous computation where, if a cancellation happens any time during - the execution of the asynchronous computation in the scope of holder, then action - interruption is executed on the thread that is performing the cancellation. This can - be used to arrange for a computation to be asynchronously notified that a cancellation - has occurred, e.g. by setting a flag, or deregistering a pending I/O action. - The function that is executed on the thread performing the - cancellation. - An asynchronous computation that triggers the interruption if it is cancelled - before being disposed. - - - Creates an asynchronous computation that runs the given computation and ignores - its result. - The input computation. - A computation that is equivalent to the input computation, but disregards the result. - - - Creates an asynchronous computation that captures the current - success, exception and cancellation continuations. The callback must - eventually call exactly one of the given continuations. - The function that accepts the current success, exception, and cancellation - continuations. - An asynchronous computation that provides the callback with the current continuations. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. This overlaod should be used if the operation is - qualified by three arguments. For example, - Async.FromBeginEnd(arg1,arg2,arg3,ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The first argument for the operation. - The second argument for the operation. - The third argument for the operation. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. This overlaod should be used if the operation is - qualified by two arguments. For example, - Async.FromBeginEnd(arg1,arg2,ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The first argument for the operation. - The second argument for the operation. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. This overlaod should be used if the operation is - qualified by one argument. For example, - Async.FromBeginEnd(place,ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The argument for the operation. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. For example, - Async.FromBeginEnd(ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation that executes computation. - If this computation completes successfully then return Choice1Of2 with the returned - value. If this computation raises an exception before it completes then return Choice2Of2 - with the raised exception. - The input computation that returns the type T. - A computation that returns a choice of type T or exception. - - - Raises the cancellation condition for the most recent set of asynchronous computations started - without any specific CancellationToken. Replaces the global CancellationTokenSource with a new - global token source for any asynchronous computations created after this point without any - specific CancellationToken. - - - Creates an asynchronous computation that will wait on the given WaitHandle. - - The computation returns true if the handle indicated a result within the given timeout. - The WaitHandle that can be signalled. - The timeout value in milliseconds. If one is not provided - then the default value of -1 corresponding to System.Threading.Timeout.Infinite. - An asynchronous computation that waits on the given WaitHandle. - - - - Return an asynchronous computation that will wait for the given task to complete and return - its result. - - - - - Return an asynchronous computation that will wait for the given task to complete and return - its result. - - - - Creates an asynchronous computation that will wait on the IAsyncResult. - - The computation returns true if the handle indicated a result within the given timeout. - The IAsyncResult to wait on. - The timeout value in milliseconds. If one is not provided - then the default value of -1 corresponding to System.Threading.Timeout.Infinite. - An asynchronous computation that waits on the given IAsyncResult. - - - Creates an asynchronous computation that waits for a single invocation of a CLI - event by adding a handler to the event. Once the computation completes or is - cancelled, the handler is removed from the event. - - The computation will respond to cancellation while waiting for the event. If a - cancellation occurs, and cancelAction is specified, then it is executed, and - the computation continues to wait for the event. - - If cancelAction is not specified, then cancellation causes the computation - to cancel immediately. - The event to handle once. - An optional function to execute instead of cancelling when a - cancellation is issued. - An asynchronous computation that waits for the event to be invoked. - - - Creates three functions that can be used to implement the .NET Asynchronous - Programming Model (APM) for a given asynchronous computation. - - The functions should normally be published as members with prefix Begin, - End and Cancel, and can be used within a type definition as follows: - - let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun arg -> computation) - member x.BeginSomeOperation(arg,callback,state:obj) = beginAction(arg,callback,state) - member x.EndSomeOperation(iar) = endAction(iar) - member x.CancelSomeOperation(iar) = cancelAction(iar) - - - If the asynchronous computation takes no arguments, then AsBeginEnd is used as follows: - - let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun () -> computation) - member x.BeginSomeOperation(callback,state:obj) = beginAction((),callback,state) - member x.EndSomeOperation(iar) = endAction(iar) - member x.CancelSomeOperation(iar) = cancelAction(iar) - - - - If the asynchronous computation takes two arguments, then AsBeginEnd is used as follows: - - let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun arg1 arg2 -> computation) - member x.BeginSomeOperation(arg1,arg2,callback,state:obj) = beginAction((),callback,state) - member x.EndSomeOperation(iar) = endAction(iar) - member x.CancelSomeOperation(iar) = cancelAction(iar) - - - In each case, the resulting API will be familiar to programmers in other CLI languages and - is a useful way to publish asynchronous computations in CLI components. - A function generating the asynchronous computation to split into the traditional - .NET Asynchronous Programming Model. - A tuple of the begin, end, and cancel members. - - - This static class holds members for creating and manipulating asynchronous computations. - - - Creates an asynchronous computation that just returns (). - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of empty else branches in the - async { ... } computation expression syntax. - An asynchronous computation that returns (). - - - Creates an asynchronous computation that runs computation repeatedly - until guard() becomes false. - - A cancellation check is performed whenever the computation is executed. - - The existence of this method permits the use of while in the - async { ... } computation expression syntax. - The function to determine when to stop executing computation. - The function to be executed. Equivalent to the body - of a while expression. - An asynchronous computation that behaves similarly to a while loop when run. - - - Creates an asynchronous computation that runs binder(resource). - The action resource.Dispose() is executed as this computation yields its result - or if the asynchronous computation exits by an exception or by cancellation. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of use and use! in the - async { ... } computation expression syntax. - The resource to be used and disposed. - The function that takes the resource and returns an asynchronous - computation. - An asynchronous computation that binds and eventually disposes resource. - - - Creates an asynchronous computation that runs computation and returns its result. - If an exception happens then catchHandler(exn) is called and the resulting computation executed instead. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of try/with in the - async { ... } computation expression syntax. - The input computation. - The function to run when computation throws an exception. - An asynchronous computation that executes computation and calls catchHandler if an - exception is thrown. - - - Creates an asynchronous computation that runs computation. The action compensation is executed - after computation completes, whether computation exits normally or by an exception. If compensation raises an exception itself - the original exception is discarded and the new exception becomes the overall result of the computation. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of try/finally in the - async { ... } computation expression syntax. - The input computation. - The action to be run after computation completes or raises an - exception (including cancellation). - An asynchronous computation that executes computation and compensation aftewards or - when an exception is raised. - - - Delegates to the input computation. - - The existence of this method permits the use of return! in the - async { ... } computation expression syntax. - The input computation. - The input computation. - - - Creates an asynchronous computation that returns the result v. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of return in the - async { ... } computation expression syntax. - The value to return from the computation. - An asynchronous computation that returns value when executed. - - - Creates an asynchronous computation that enumerates the sequence seq - on demand and runs body for each element. - - A cancellation check is performed on each iteration of the loop. - - The existence of this method permits the use of for in the - async { ... } computation expression syntax. - The sequence to enumerate. - A function to take an item from the sequence and create - an asynchronous computation. Can be seen as the body of the for expression. - An asynchronous computation that will enumerate the sequence and run body - for each element. - - - Creates an asynchronous computation that runs generator. - - A cancellation check is performed when the computation is executed. - The function to run. - An asynchronous computation that runs generator. - - - Creates an asynchronous computation that first runs computation1 - and then runs computation2, returning the result of computation2. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of expression sequencing in the - async { ... } computation expression syntax. - The first part of the sequenced computation. - The second part of the sequenced computation. - An asynchronous computation that runs both of the computations sequentially. - - - Creates an asynchronous computation that runs computation, and when - computation generates a result T, runs binder res. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of let! in the - async { ... } computation expression syntax. - The computation to provide an unbound result. - The function to bind the result of computation. - An asynchronous computation that performs a monadic bind on the result - of computation. - - - - Generate an object used to build asynchronous computations using F# computation expressions. The value - 'async' is a pre-defined instance of this type. - - A cancellation check is performed when the computation is executed. - - - - The type of the async operator, used to build workflows for asynchronous computations. - - - Sends a reply to a PostAndReply message. - The value to send. - - - A handle to a capability to reply to a PostAndReply message. - - - A compositional asynchronous computation, which, when run, will eventually produce a value - of type T, or else raises an exception. - - Asynchronous computations are normally specified using an F# computation expression. - - When run, asynchronous computations have two modes: as a work item (executing synchronous - code), or as a wait item (waiting for an event or I/O completion). - - When run, asynchronous computations can be governed by CancellationToken. This can usually - be specified when the async computation is started. The associated CancellationTokenSource - may be used to cancel the asynchronous computation. Asynchronous computations built using - computation expressions can check the cancellation condition regularly. Synchronous - computations within an asynchronous computation do not automatically check this condition. - - - Publishes the event as a first class event value. - - - Triggers the event using the given parameters. - The parameters for the event. - - - Creates an event object suitable for implementing an arbitrary type of delegate. - The event object. - - - Event implementations for an arbitrary type of delegate. - - - Publishes an observation as a first class value. - - - Triggers an observation using the given parameters. - The event parameters. - - - Creates an observable object. - The created event. - - - Event implementations for the IEvent<_> type. - - - Publishes the event as a first class event value. - - - Triggers the event using the given sender object and parameters. The sender object may be null. - The object triggering the event. - The parameters for the event. - - - Creates an event object suitable for delegate types following the standard .NET Framework convention of a first 'sender' argument. - The created event. - - - Event implementations for a delegate types following the standard .NET Framework convention of a first 'sender' argument. - - - A delegate type associated with the F# event type IEvent<_> - The object that fired the event. - The event arguments. - - - Remove a listener delegate from an event listener store. - The delegate to be removed from the event listener store. - - - Connect a handler delegate object to the event. A handler can - be later removed using RemoveHandler. The listener will - be invoked when the event is fired. - A delegate to be invoked when the event is fired. - - - First class event values for arbitrary delegate types. - - F# gives special status to member properties compatible with type IDelegateEvent and - tagged with the CLIEventAttribute. In this case the F# compiler generates approriate - CLI metadata to make the member appear to other CLI languages as a CLI event. - - - First-class listening points (i.e. objects that permit you to register a callback - activated when the event is triggered). - - - First class event values for CLI events conforming to CLI Framework standards. - - - The type of delayed computations. - - Use the values in the Lazy module to manipulate - values of this type, and the notation lazy expr to create values - of type . - - - Raises a timeout exception if a message not received in this amount of time. By default - no timeout is used. - - - Occurs when the execution of the agent results in an exception. - - - Occurs when the execution of the agent results in an exception. - - - Raises a timeout exception if a message not received in this amount of time. By default - no timeout is used. - - - Returns the number of unprocessed messages in the message queue of the agent. - - - Occurs when the execution of the agent results in an exception. - - - Scans for a message by looking through messages in arrival order until scanner - returns a Some value. Other messages remain in the queue. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - The function to return None if the message is to be skipped - or Some if the message is to be processed and removed from the queue. - An optional timeout in milliseconds. Defaults to -1 which corresponds - to System.Threading.Timeout.Infinite. - An asynchronous computation that scanner built off the read message. - - - Waits for a message. This will consume the first message in arrival order. - - This method is for use within the body of the agent. - - Returns None if a timeout is given and the timeout is exceeded. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - An optional timeout in milliseconds. Defaults to -1 which - corresponds to System.Threading.Timeout.Infinite. - An asynchronous computation that returns the received message or - None if the timeout is exceeded. - - - Like PostAndReply, but returns None if no reply within the timeout period. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - The reply from the agent or None if the timeout expires. - - - Starts the agent. - - - Creates and starts an agent. The body function is used to generate the asynchronous - computation executed by the agent. - The function to produce an asynchronous computation that will be executed - as the read loop for the MailboxProcessor when Start is called. - An optional cancellation token for the body. - Defaults to Async.DefaultCancellationToken. - The created MailboxProcessor. - - - Scans for a message by looking through messages in arrival order until scanner - returns a Some value. Other messages remain in the queue. - - Returns None if a timeout is given and the timeout is exceeded. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - The function to return None if the message is to be skipped - or Some if the message is to be processed and removed from the queue. - An optional timeout in milliseconds. Defaults to -1 which corresponds - to System.Threading.Timeout.Infinite. - An asynchronous computation that scanner built off the read message. - Thrown when the timeout is exceeded. - - - Waits for a message. This will consume the first message in arrival order. - - This method is for use within the body of the agent. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - An optional timeout in milliseconds. Defaults to -1 which corresponds - to System.Threading.Timeout.Infinite. - An asynchronous computation that returns the received message. - Thrown when the timeout is exceeded. - - - Like AsyncPostAndReply, but returns None if no reply within the timeout period. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - An asynchronous computation that will return the reply or None if the timeout expires. - - - Posts a message to an agent and await a reply on the channel, synchronously. - - The message is generated by applying buildMessage to a new reply channel - to be incorporated into the message. The receiving agent must process this - message and invoke the Reply method on this reply channel precisely once. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - The reply from the agent. - - - Posts a message to an agent and await a reply on the channel, asynchronously. - - The message is generated by applying buildMessage to a new reply channel - to be incorporated into the message. The receiving agent must process this - message and invoke the Reply method on this reply channel precisely once. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - An asychronous computation that will wait for the reply from the agent. - - - Posts a message to the message queue of the MailboxProcessor, asynchronously. - The message to post. - - - Creates an agent. The body function is used to generate the asynchronous - computation executed by the agent. This function is not executed until - Start is called. - The function to produce an asynchronous computation that will be executed - as the read loop for the MailboxProcessor when Start is called. - An optional cancellation token for the body. - Defaults to Async.DefaultCancellationToken. - The created MailboxProcessor. - - - A message-processing agent which executes an asynchronous computation. - - The agent encapsulates a message queue that supports multiple-writers and - a single reader agent. Writers send messages to the agent by using the Post - method and its variations. - - The agent may wait for messages using the Receive or TryReceive methods or - scan through all available messages using the Scan or TryScan method. - - - Connects a listener function to the observable. The listener will - be invoked for each observation. The listener can be removed by - calling Dispose on the returned IDisposable object. - The function to be called for each observation. - An object that will remove the listener if disposed. - - - Permanently connects a listener function to the observable. The listener will - be invoked for each observation. - The function to be called for each observation. - - - Returns an asynchronous computation that will write the given bytes to the stream. - The buffer to write from. - An optional offset as a number of bytes in the stream. - An optional number of bytes to write to the stream. - An asynchronous computation that will write the given bytes to the stream. - Thrown when the sum of offset and count is longer than - the buffer length. - Thrown when offset or count is negative. - - - Returns an asynchronous computation that will read the given number of bytes from the stream. - The number of bytes to read. - An asynchronous computation that returns the read byte[] when run. - - - Returns an asynchronous computation that will read from the stream into the given buffer. - The buffer to read into. - An optional offset as a number of bytes in the stream. - An optional number of bytes to read from the stream. - An asynchronous computation that will read from the stream into the given buffer. - Thrown when the sum of offset and count is longer than - the buffer length. - Thrown when offset or count is negative. - - - A module of extension members providing asynchronous operations for some basic CLI types related to concurrency and I/O. - - - Returns a new event that triggers on the second and subsequent triggerings of the input event. - The Nth triggering of the input event passes the arguments from the N-1th and Nth triggering as - a pair. The argument passed to the N-1th triggering is held in hidden internal state until the - Nth triggering occurs. - The input event. - An event that triggers on pairs of consecutive values passed from the source event. - - - Runs the given function each time the given event is triggered. - The function to call when the event is triggered. - The input event. - - - Returns a new event consisting of the results of applying the given accumulating function - to successive values triggered on the input event. An item of internal state - records the current value of the state parameter. The internal state is not locked during the - execution of the accumulation function, so care should be taken that the - input IEvent not triggered by multiple threads simultaneously. - The function to update the state with each event value. - The initial state. - The input event. - An event that fires on the updated state values. - - - Returns a new event which fires on a selection of messages from the original event. - The selection function takes an original message to an optional new message. - The function to select and transform event values to pass on. - The input event. - An event that fires only when the chooser returns Some. - - - Returns a new event that listens to the original event and triggers the - first resulting event if the application of the function to the event arguments - returned a Choice1Of2, and the second event if it returns a Choice2Of2. - The function to transform event values into one of two types. - The input event. - A tuple of events. The first fires whenever splitter evaluates to Choice1of1 and - the second fires whenever splitter evaluates to Choice2of2. - - - Returns a new event that listens to the original event and triggers the - first resulting event if the application of the predicate to the event arguments - returned true, and the second event if it returned false. - The function to determine which output event to trigger. - The input event. - A tuple of events. The first is triggered when the predicate evaluates to true - and the second when the predicate evaluates to false. - - - Returns a new event that listens to the original event and triggers the resulting - event only when the argument to the event passes the given function. - The function to determine which triggers from the event to propagate. - The input event. - An event that only passes values that pass the predicate. - - - Returns a new event that passes values transformed by the given function. - The function to transform event values. - The input event. - An event that passes the transformed values. - - - Fires the output event when either of the input events fire. - The first input event. - The second input event. - An event that fires when either of the input events fire. - - - Forces the execution of this value and return its result. Same as Value. Mutual exclusion is used to - prevent other threads also computing the value. - The value of the Lazy object. - - - Creates a lazy computation that evaluates to the given value when forced. - The input value. - The created Lazy object. - - - Creates a lazy computation that evaluates to the result of the given function when forced. - The function to provide the value when needed. - The created Lazy object. - - - Extensions related to Lazy values. - - - Returns a new observable that triggers on the second and subsequent triggerings of the input observable. - The Nth triggering of the input observable passes the arguments from the N-1th and Nth triggering as - a pair. The argument passed to the N-1th triggering is held in hidden internal state until the - Nth triggering occurs. - - For each observer, the registered intermediate observing object is not thread safe. - That is, observations arising from the source must not be triggered concurrently - on different threads. - The input Observable. - An Observable that triggers on successive pairs of observations from the input Observable. - - - Creates an observer which subscribes to the given observable and which calls - the given function for each observation. - The function to be called on each observation. - The input Observable. - An object that will remove the callback if disposed. - - - Creates an observer which permanently subscribes to the given observable and which calls - the given function for each observation. - The function to be called on each observation. - The input Observable. - - - Returns an observable which, for each observer, allocates an item of state - and applies the given accumulating function to successive values arising from - the input. The returned object will trigger observations for each computed - state value, excluding the initial value. The returned object propagates - all errors arising from the source and completes when the source completes. - - For each observer, the registered intermediate observing object is not thread safe. - That is, observations arising from the source must not be triggered concurrently - on different threads. - The function to update the state with each observation. - The initial state. - The input Observable. - An Observable that triggers on the updated state values. - - - Returns an observable which chooses a projection of observations from the source - using the given function. The returned object will trigger observations x - for which the splitter returns Some x. The returned object also propagates - all errors arising from the source and completes when the source completes. - The function that returns Some for observations to be propagated - and None for observations to ignore. - The input Observable. - An Observable that only propagates some of the observations from the source. - - - Returns two observables which split the observations of the source by the - given function. The first will trigger observations x for which the - splitter returns Choice1Of2 x. The second will trigger observations - y for which the splitter returns Choice2Of2 y The splitter is - executed once for each subscribed observer. Both also propagate error - observations arising from the source and each completes when the source - completes. - The function that takes an observation an transforms - it into one of the two output Choice types. - The input Observable. - A tuple of Observables. The first triggers when splitter returns Choice1of2 - and the second triggers when splitter returns Choice2of2. - - - Returns two observables which partition the observations of the source by - the given function. The first will trigger observations for those values - for which the predicate returns true. The second will trigger observations - for those values where the predicate returns false. The predicate is - executed once for each subscribed observer. Both also propagate all error - observations arising from the source and each completes when the source - completes. - The function to determine which output Observable will trigger - a particular observation. - The input Observable. - A tuple of Observables. The first triggers when the predicate returns true, and - the second triggers when the predicate returns false. - - - Returns an observable which filters the observations of the source - by the given function. The observable will see only those observations - for which the predicate returns true. The predicate is executed once for - each subscribed observer. The returned object also propagates error - observations arising from the source and completes when the source completes. - The function to apply to observations to determine if it should - be kept. - The input Observable. - An Observable that filters observations based on filter. - - - Returns an observable which transforms the observations of the source by the - given function. The transformation function is executed once for each - subscribed observer. The returned object also propagates error observations - arising from the source and completes when the source completes. - The function applied to observations from the source. - The input Observable. - An Observable of the type specified by mapping. - - - Returns an observable for the merged observations from the sources. - The returned object propagates success and error values arising - from either source and completes when both the sources have completed. - - For each observer, the registered intermediate observing object is not - thread safe. That is, observations arising from the sources must not - be triggered concurrently on different threads. - The first Observable. - The second Observable. - An Observable that propagates information from both sources. - - - Basic operations on first class event and other observable objects. - - - Returns an asynchronous computation that, when run, will wait for a response to the given WebRequest. - An asynchronous computation that waits for response to the WebRequest. - - - A module of extension members providing asynchronous operations for some basic Web operations. - - - Creates an instance of the attribute - AbstractClassAttribute - - - Adding this attribute to class definition makes it abstract, which means it need not - implement all its methods. Instances of abstract classes may not be constructed directly. - - - The value of the attribute, indicating whether the type allows the null literal or not - - - Creates an instance of the attribute with the specified value - AllowNullLiteralAttribute - - - Creates an instance of the attribute - AllowNullLiteralAttribute - - - Adding this attribute to a type lets the 'null' literal be used for the type - within F# code. This attribute may only be added to F#-defined class or - interface types. - - - Indicates the namespace or module to be automatically opened when an assembly is referenced - or an enclosing module opened. - - - Creates an attribute used to mark a namespace or module path to be 'automatically opened' when an assembly is referenced - The namespace or module to be automatically opened when an assembly is referenced - or an enclosing module opened. - AutoOpenAttribute - - - Creates an attribute used to mark a module as 'automatically opened' when the enclosing namespace is opened - AutoOpenAttribute - - - This attribute is used for two purposes. When applied to an assembly, it must be given a string - argument, and this argument must indicate a valid module or namespace in that assembly. Source - code files compiled with a reference to this assembly are processed in an environment - where the given path is automatically opened. - - When applied to a module within an assembly, then the attribute must not be given any arguments. - When the enclosing namespace is opened in user source code, the module is also implicitly opened. - - - The value of the attribute, indicating whether the type is automatically marked serializable or not - - - Creates an instance of the attribute - Indicates whether the type should be serializable by default. - AutoSerializableAttribute - - - Adding this attribute to a type with value 'false' disables the behaviour where F# makes the - type Serializable by default. - - - Creates an instance of the attribute - CLIEventAttribute - - - Adding this attribute to a property with event type causes it to be compiled with as a CLI - metadata event, through a syntactic translation to a pair of 'add_EventName' and - 'remove_EventName' methods. - - - Creates an instance of the attribute - CLIMutableAttribute - - - Adding this attribute to a record type causes it to be compiled to a CLI representation - with a default constructor with property getters and setters. - - - Choice 2 of 2 choices - - - Choice 1 of 2 choices - - - Helper types for active patterns with 2 choices. - - - Choice 3 of 3 choices - - - Choice 2 of 3 choices - - - Choice 1 of 3 choices - - - Helper types for active patterns with 3 choices. - - - Choice 4 of 4 choices - - - Choice 3 of 4 choices - - - Choice 2 of 4 choices - - - Choice 1 of 4 choices - - - Helper types for active patterns with 4 choices. - - - Choice 5 of 5 choices - - - Choice 4 of 5 choices - - - Choice 3 of 5 choices - - - Choice 2 of 5 choices - - - Choice 1 of 5 choices - - - Helper types for active patterns with 5 choices. - - - Choice 6 of 6 choices - - - Choice 5 of 6 choices - - - Choice 4 of 6 choices - - - Choice 3 of 6 choices - - - Choice 2 of 6 choices - - - Choice 1 of 6 choices - - - Helper types for active patterns with 6 choices. - - - Choice 7 of 7 choices - - - Choice 6 of 7 choices - - - Choice 5 of 7 choices - - - Choice 4 of 7 choices - - - Choice 3 of 7 choices - - - Choice 2 of 7 choices - - - Choice 1 of 7 choices - - - Helper types for active patterns with 7 choices. - - - Creates an instance of the attribute - ClassAttribute - - - Adding this attribute to a type causes it to be represented using a CLI class. - - - Creates an instance of the attribute - ComparisonConditionalOnAttribute - - - This attribute is used to indicate a generic container type satisfies the F# 'comparison' - constraint only if a generic argument also satisfies this constraint. For example, adding - this attribute to parameter 'T on a type definition C<'T> means that a type C<X> only supports - comparison if the type X also supports comparison and all other conditions for C<X> to support - comparison are also met. The type C<'T> can still be used with other type arguments, but a type such - as C<(int -> int)> will not support comparison because the type (int -> int) is an F# function type - and does not support comparison. - - This attribute will be ignored if it is used on the generic parameters of functions or methods. - - - Indicates the number of arguments in each argument group - - - Creates an instance of the attribute - Indicates the number of arguments in each argument group. - CompilationArgumentCountsAttribute - - - This attribute is generated automatically by the F# compiler to tag functions and members - that accept a partial application of some of their arguments and return a residual function - - - Indicates the variant number of the entity, if any, in a linear sequence of elements with F# source code - - - Indicates the type definitions needed to resolve the source construct - - - Indicates the relationship between the compiled entity and F# source code - - - Indicates the sequence number of the entity, if any, in a linear sequence of elements with F# source code - - - Indicates the resource the source construct relates to - - - Creates an instance of the attribute - Indicates the type definitions needed to resolve the source construct. - CompilationMappingAttribute - - - Creates an instance of the attribute - Indicates the type of source construct. - CompilationMappingAttribute - - - Creates an instance of the attribute - Indicates the type of source construct. - CompilationMappingAttribute - - - Creates an instance of the attribute - Indicates the type of source construct. - CompilationMappingAttribute - - - This attribute is inserted automatically by the F# compiler to tag types - and methods in the generated CLI code with flags indicating the correspondence - with original source constructs. It is used by the functions in the - Microsoft.FSharp.Reflection namespace to reverse-map compiled constructs to - their original forms. It is not intended for use from user code. - - - Indicates one or more adjustments to the compiled representation of an F# type or member - - - Creates an instance of the attribute - Indicates adjustments to the compiled representation of the type or member. - CompilationRepresentationAttribute - - - This attribute is used to adjust the runtime representation for a type. - For example, it may be used to note that the null representation - may be used for a type. This affects how some constructs are compiled. - - - Compile a property as a CLI event. - - - Permit the use of null as a representation for nullary discriminators in a discriminated union. - - - append 'Module' to the end of a module whose name clashes with a type name in the same namespace. - - - Compile a member as 'instance' even if null is used as a representation for this type. - - - Compile an instance member as 'static' . - - - No special compilation representation. - - - Indicates one or more adjustments to the compiled representation of an F# type or member. - - - Indicates the name of the entity in F# source code - - - Creates an instance of the attribute - The name of the method in source. - CompilationSourceNameAttribute - - - This attribute is inserted automatically by the F# compiler to tag - methods which are given the 'CompiledName' attribute. It is not intended - for use from user code. - - - The name of the value as it appears in compiled code - - - Creates an instance of the attribute - The name to use in compiled code. - CompiledNameAttribute - - - Adding this attribute to a value or function definition in an F# module changes the name used - for the value in compiled CLI code. - - - Indicates if the construct should always be hidden in an editing environment. - - - Indicates if the message should indicate a compiler error. Error numbers less than - 10000 are considered reserved for use by the F# compiler and libraries. - - - Indicates the number associated with the message. - - - Indicates the warning message to be emitted when F# source code uses this construct - - - Indicates if the construct should always be hidden in an editing environment. - - - Indicates if the message should indicate a compiler error. Error numbers less than - 10000 are considered reserved for use by the F# compiler and libraries. - - - Creates an instance of the attribute. - - - Indicates that a message should be emitted when F# source code uses this construct. - - - Creates an instance of the attribute - CustomComparisonAttribute - - - Adding this attribute to a type indicates it is a type with a user-defined implementation of comparison. - - - Creates an instance of the attribute - CustomEqualityAttribute - - - Adding this attribute to a type indicates it is a type with a user-defined implementation of equality. - - - Indicates if the custom operation maintains the variable space of the query of computation expression through the use of a bind operation - - - Indicates if the custom operation maintains the variable space of the query of computation expression - - - Indicates the name used for the 'on' part of the custom query operator for join-like operators - - - Indicates if the custom operation is an operation similar to a zip in a sequence computation, supporting two inputs - - - Indicates if the custom operation is an operation similar to a join in a sequence computation, supporting two inputs and a correlation constraint - - - Indicates if the custom operation is an operation similar to a group join in a sequence computation, supporting two inputs and a correlation constraint, and generating a group - - - Indicates if the custom operation supports the use of 'into' immediately after the use of the operation in a query or other computation expression to consume the results of the operation - - - Get the name of the custom operation when used in a query or other computation expression - - - Indicates if the custom operation maintains the variable space of the query of computation expression through the use of a bind operation - - - Indicates if the custom operation maintains the variable space of the query of computation expression - - - Indicates the name used for the 'on' part of the custom query operator for join-like operators - - - Indicates if the custom operation is an operation similar to a zip in a sequence computation, supporting two inputs - - - Indicates if the custom operation is an operation similar to a join in a sequence computation, supporting two inputs and a correlation constraint - - - Indicates if the custom operation is an operation similar to a group join in a sequence computation, supporting two inputs and a correlation constraint, and generating a group - - - Indicates if the custom operation supports the use of 'into' immediately after the use of the operation in a query or other computation expression to consume the results of the operation - - - Creates an instance of the attribute - CustomOperationAttribute - - - - Indicates that a member on a computation builder type is a custom query operator, - and indicates the name of that operator. - - - - The value of the attribute, indicating whether the type has a default augmentation or not - - - Creates an instance of the attribute - Indicates whether to generate helper members on the CLI class representing a discriminated - union. - DefaultAugmentationAttribute - - - Adding this attribute to a discriminated union with value false - turns off the generation of standard helper member tester, constructor - and accessor members for the generated CLI class for that type. - - - Indicates if a constraint is asserted that the field type supports 'null' - - - Creates an instance of the attribute - Indicates whether to assert that the field type supports null. - DefaultValueAttribute - - - Creates an instance of the attribute - DefaultValueAttribute - - - Adding this attribute to a field declaration means that the field is - not initialized. During type checking a constraint is asserted that the field type supports 'null'. - If the 'check' value is false then the constraint is not asserted. - - - Creates an instance of the attribute - EntryPointAttribute - - - Adding this attribute to a function indicates it is the entrypoint for an application. - If this attribute is not specified for an EXE then the initialization implicit in the - module bindings in the last file in the compilation sequence are used as the entrypoint. - - - Creates an instance of the attribute - EqualityConditionalOnAttribute - - - This attribute is used to indicate a generic container type satisfies the F# 'equality' - constraint only if a generic argument also satisfies this constraint. For example, adding - this attribute to parameter 'T on a type definition C<'T> means that a type C<X> only supports - equality if the type X also supports equality and all other conditions for C<X> to support - equality are also met. The type C<'T> can still be used with other type arguments, but a type such - as C<(int -> int)> will not support equality because the type (int -> int) is an F# function type - and does not support equality. - - This attribute will be ignored if it is used on the generic parameters of functions or methods. - - - Indicates the warning message to be emitted when F# source code uses this construct - - - Creates an instance of the attribute - The warning message to be emitted when code uses this construct. - ExperimentalAttribute - - - This attribute is used to tag values that are part of an experimental library - feature. - - - Invoke an F# first class function value with two curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The function result. - - - Invoke an F# first class function value with three curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The third arg. - The function result. - - - Invoke an F# first class function value with four curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The third arg. - The fourth arg. - The function result. - - - Invoke an F# first class function value with five curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The third arg. - The fourth arg. - The fifth arg. - The function result. - - - Invoke an F# first class function value with one argument - - 'U - - - Construct an instance of an F# first class function value - The created F# function. - - - The CLI type used to represent F# function values. This type is not - typically used directly, though may be used from other CLI languages. - - - The release number of the F# version associated with the attribute - - - The minor version number of the F# version associated with the attribute - - - The major version number of the F# version associated with the attribute - - - Creates an instance of the attribute - The major version number. - The minor version number. - The release number. - FSharpInterfaceDataVersionAttribute - - - This attribute is added to generated assemblies to indicate the - version of the data schema used to encode additional F# - specific information in the resource attached to compiled F# libraries. - - - Specialize the type function at a given type - The specialized type. - - - Construct an instance of an F# first class type function value - FSharpTypeFunc - - - The CLI type used to represent F# first-class type function values. This type is for use - by compiled F# code. - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - Tuple of values generated by scan or match. - - - Convert the given Action delegate object to an F# function value - The input action. - The F# function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - Helper functions for converting F# first class function values to and from CLI representaions - of functions using delegates. - - - Creates an instance of the attribute - GeneralizableValueAttribute - - - Adding this attribute to a non-function value with generic parameters indicates that - uses of the construct can give rise to generic code through type inference. - - - Creates an instance of the attribute - InterfaceAttribute - - - Adding this attribute to a type causes it to be represented using a CLI interface. - - - Creates an instance of the attribute - LiteralAttribute - - - Adding this attribute to a value causes it to be compiled as a CLI constant literal. - - - Creates an instance of the attribute - MeasureAnnotatedAbbreviationAttribute - - - Adding this attribute to a type causes it to be interpreted as a refined type, currently limited to measure-parameterized types. - This may only be used under very limited conditions. - - - Creates an instance of the attribute - MeasureAttribute - - - Adding this attribute to a type causes it to be interpreted as a unit of measure. - This may only be used under very limited conditions. - - - Creates an instance of the attribute - NoComparisonAttribute - - - Adding this attribute to a type indicates it is a type where comparison is an abnormal operation. - This means that the type does not satisfy the F# 'comparison' constraint. Within the bounds of the - F# type system, this helps ensure that the F# generic comparison function is not instantiated directly - at this type. The attribute and checking does not constrain the use of comparison with base or child - types of this type. - - - Creates an instance of the attribute - NoDynamicInvocationAttribute - - - This attribute is used to tag values that may not be dynamically invoked at runtime. This is - typically added to inlined functions whose implementations include unverifiable code. It - causes the method body emitted for the inlined function to raise an exception if - dynamically invoked, rather than including the unverifiable code in the generated - assembly. - - - Creates an instance of the attribute - NoEqualityAttribute - - - Adding this attribute to a type indicates it is a type where equality is an abnormal operation. - This means that the type does not satisfy the F# 'equality' constraint. Within the bounds of the - F# type system, this helps ensure that the F# generic equality function is not instantiated directly - at this type. The attribute and checking does not constrain the use of comparison with base or child - types of this type. - - - The representation of "Value of type 'T" - The input value. - An option representing the value. - - - The representation of "No value" - - - Get the value of a 'Some' option. A NullReferenceException is raised if the option is 'None'. - - - Create an option value that is a 'None' value. - - - Return 'true' if the option is a 'Some' value. - - - Return 'true' if the option is a 'None' value. - - - Create an option value that is a 'Some' value. - The input value - An option representing the value. - - - The type of optional values. When used from other CLI languages the - empty option is the null value. - - Use the constructors Some and None to create values of this type. - Use the values in the Option module to manipulate values of this type, - or pattern match against the values directly. - - None values will appear as the value null to other CLI languages. - Instance methods on this type will appear as static methods to other CLI languages - due to the use of null as a value representation. - - - Creates an instance of the attribute - OptionalArgumentAttribute - - - This attribute is added automatically for all optional arguments. - - - The raw text of the format string. - - - Construct a format string - The input string. - The PrintfFormat containing the formatted result. - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - - - Construct a format string - The input string. - The created format string. - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - Tuple of values generated by scan or match. - - - Creates an instance of the attribute - ProjectionParameterAttribute - - - Indicates that, when a custom operator is used in a computation expression, - a parameter is automatically parameterized by the variable space of the computation expression - - - - The current value of the reference cell - - - - The current value of the reference cell - - - The current value of the reference cell - - - The type of mutable references. Use the functions [:=] and [!] to get and - set values of this type. - - - Creates an instance of the attribute - ReferenceEqualityAttribute - - - Adding this attribute to a record or union type disables the automatic generation - of overrides for 'System.Object.Equals(obj)', 'System.Object.GetHashCode()' - and 'System.IComparable' for the type. The type will by default use reference equality. - - - The value of the attribute, indicating whether to include the evaluated value of the definition as the outer node of the quotation - - - Creates an instance of the attribute - Indicates whether to include the evaluated value of the definition as the outer node of the quotation - ReflectedDefinitionAttribute - - - Creates an instance of the attribute - ReflectedDefinitionAttribute - - - Adding this attribute to the let-binding for the definition of a top-level - value makes the quotation expression that implements the value available - for use at runtime. - - - Creates an instance of the attribute - RequireQualifiedAccessAttribute - - - This attribute is used to indicate that references to the elements of a module, record or union - type require explicit qualified access. - - - Creates an instance of the attribute - RequiresExplicitTypeArgumentsAttribute - - - Adding this attribute to a type, value or member requires that - uses of the construct must explicitly instantiate any generic type parameters. - - - The value of the attribute, indicating whether the type is sealed or not. - - - Creates an instance of the attribute - Indicates whether the class is sealed. - SealedAttribute - - - Creates an instance of the attribute. - The created attribute. - - - Adding this attribute to class definition makes it sealed, which means it may not - be extended or implemented. - - - Indicates that the compiled entity had private or internal representation in F# source code. - - - The mask of values related to the kind of the compiled entity. - - - Indicates that the compiled entity is part of the representation of an F# value declaration. - - - Indicates that the compiled entity is part of the representation of an F# union case declaration. - - - Indicates that the compiled entity is part of the representation of an F# module declaration. - - - Indicates that the compiled entity is part of the representation of an F# closure. - - - Indicates that the compiled entity is part of the representation of an F# exception declaration. - - - Indicates that the compiled entity is part of the representation of an F# record or union case field declaration. - - - Indicates that the compiled entity is part of the representation of an F# class or other object type declaration. - - - Indicates that the compiled entity is part of the representation of an F# record type declaration. - - - Indicates that the compiled entity is part of the representation of an F# union type declaration. - - - Indicates that the compiled entity has no relationship to an element in F# source code. - - - Indicates the relationship between a compiled entity in a CLI binary and an element in F# source code. - - - Creates an instance of the attribute - StructAttribute - - - Adding this attribute to a type causes it to be represented using a CLI struct. - - - Creates an instance of the attribute - StructuralComparisonAttribute - - - Adding this attribute to a record, union, exception, or struct type confirms the - automatic generation of implementations for 'System.IComparable' for the type. - - - Creates an instance of the attribute - StructuralEqualityAttribute - - - Adding this attribute to a record, union or struct type confirms the automatic - generation of overrides for 'System.Object.Equals(obj)' and - 'System.Object.GetHashCode()' for the type. - - - Indicates the text to display by default when objects of this type are displayed - using '%A' printf formatting patterns and other two-dimensional text-based display - layouts. - - - Creates an instance of the attribute - Indicates the text to display when using the '%A' printf formatting. - StructuredFormatDisplayAttribute - - - This attribute is used to mark how a type is displayed by default when using - '%A' printf formatting patterns and other two-dimensional text-based display layouts. - In this version of F# valid values are of the form PreText {PropertyName1} PostText {PropertyName2} ... {PropertyNameX} PostText. - The property names indicate properties to evaluate and to display instead of the object itself. - - - The type 'unit', which has only one value "()". This value is special and - always uses the representation 'null'. - - - Creates an instance of the attribute - UnverifiableAttribute - - - This attribute is used to tag values whose use will result in the generation - of unverifiable code. These values are inevitably marked 'inline' to ensure that - the unverifiable constructs are not present in the actual code for the F# library, - but are rather copied to the source code of the caller. - - - Creates an instance of the attribute - VolatileFieldAttribute - - - Adding this attribute to an F# mutable binding causes the "volatile" - prefix to be used for all accesses to the field. - - - Thirty-two dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Thirty-one dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Thirty dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-nine dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-eight dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-seven dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-six dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-five dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-four dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-three dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-two dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-one dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Nineteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Eighteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Seventeen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Sixteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Fifteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Fourteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Thirteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twelve dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Eleven dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Ten dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Nine dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Eight dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Seven dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Six dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Five dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Four dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - Use the values in the Array4D module - to manipulate values of this type, or the notation arr.[x1,x2,x3,x4] to get and set array - values. - - - Three dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - Use the values in the Array3D module - to manipulate values of this type, or the notation arr.[x1,x2,x3] to get and set array - values. - - - Two dimensional arrays, typically zero-based. - - Use the values in the Array2D module - to manipulate values of this type, or the notation arr.[x,y] to get/set array - values. - - Non-zero-based arrays can also be created using methods on the System.Array type. - - - Single dimensional, zero-based arrays, written int[], string[] etc. - Use the values in the Array module to manipulate values - of this type, or the notation arr.[x] to get/set array - values. - - - Single dimensional, zero-based arrays, written int[], string[] etc. - - Use the values in the Array module to manipulate values - of this type, or the notation arr.[x] to get/set array - values. - - - An abbreviation for the CLI type System.Boolean. - - - Represents a managed pointer in F# code. - - - An abbreviation for the CLI type System.Byte. - - - An abbreviation for the CLI type System.Char. - - - An abbreviation for the CLI type System.Decimal. - - - The type of decimal numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Decimal. - - - An abbreviation for the CLI type System.Double. - - - An abbreviation for the CLI type System.Exception. - - - An abbreviation for the CLI type System.Double. - - - An abbreviation for the CLI type System.Single. - - - The type of floating point numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Single. - - - The type of floating point numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Double. - - - This type is for internal use by the F# code generator. - - - An abbreviation for the CLI type System.Int32. - - - An abbreviation for the CLI type System.Int16. - - - The type of 16-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Int16. - - - An abbreviation for the CLI type System.Int32. - - - An abbreviation for the CLI type System.Int64. - - - The type of 64-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Int64. - - - An abbreviation for the CLI type System.SByte. - - - The type of 32-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Int32. - - - An abbreviation for the CLI type System.IntPtr. - - - Represents an unmanaged pointer in F# code. - - This type should only be used when writing F# code that interoperates - with native code. Use of this type in F# code may result in - unverifiable code being generated. Conversions to and from the - nativeint type may be required. Values of this type can be generated - by the functions in the NativeInterop.NativePtr module. - - - An abbreviation for the CLI type System.Object. - - - The type of optional values. When used from other CLI languages the - empty option is the null value. - - Use the constructors Some and None to create values of this type. - Use the values in the Option module to manipulate values of this type, - or pattern match against the values directly. - - 'None' values will appear as the value null to other CLI languages. - Instance methods on this type will appear as static methods to other CLI languages - due to the use of null as a value representation. - - - The type of mutable references. Use the functions [:=] and [!] to get and - set values of this type. - - - An abbreviation for the CLI type System.SByte. - - - The type of 8-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.SByte. - - - An abbreviation for the CLI type System.Single. - - - An abbreviation for the CLI type System.String. - - - An abbreviation for the CLI type System.UInt16. - - - An abbreviation for the CLI type System.UInt32. - - - An abbreviation for the CLI type System.UInt64. - - - An abbreviation for the CLI type System.Byte. - - - An abbreviation for the CLI type System.UIntPtr. - - - The type 'unit', which has only one value "()". This value is special and - always uses the representation 'null'. - - - Non-exhaustive match failures will raise the MatchFailureException exception - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - A new enumerator for the sequence. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - A reference to the sequence. - - A 0, 1, and 2 respectively indicate Stop, Yield, and Goto conditions for the sequence generator. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - A new sequence generator for the expression. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - - Namespace name the provider injects types into. - - - - - Compilers call this method to query a type provider for a type name. - - Resolver should return a type called name in namespace NamespaceName or null if the type is unknown. - - - - - - The top-level types - - - - - - The sub-namespaces in this namespace. An optional member to prevent generation of namespaces until an outer namespace is explored. - - - - - Represents a namespace provided by a type provider component. - - - - - Triggered when an assumption changes that invalidates the resolutions so far reported by the provider - - - - - Triggered when an assumption changes that invalidates the resolutions so far reported by the provider - - - - - Triggered when an assumption changes that invalidates the resolutions so far reported by the provider - - - - - Get the static parameters for a provided type. - - A type returned by GetTypes or ResolveTypeName - - - - - Namespace name the this TypeProvider injects types into. - - - - - Called by the compiler to ask for an Expression tree to replace the given MethodBase with. - - MethodBase that was given to the compiler by a type returned by a GetType(s) call. - Expressions that represent the parameters to this call. - An expression that the compiler will use in place of the given method base. - - - - Get the physical contents of the given logical provided assembly. - - - - - Apply static arguments to a provided type that accepts static arguments. - - The provider must return a type with the given mangled name. - the provided type definition which has static parameters - the full path of the type, including encoded representations of static parameters - the static parameters, indexed by name - - - - - Represents an instantiation of a type provider component. - - - - - Get the static parameters for a provided method. - - A method returned by GetMethod on a provided type - The static parameters of the provided method, if any - - - - Apply static arguments to a provided method that accepts static arguments. - - The provider must return a provided method with the given mangled name. - the provided method definition which has static parameters - the full name of the method that must be returned, including encoded representations of static parameters - the values of the static parameters, indexed by name - The provided method definition corresponding to the given static parameter values - - - - Represents additional, optional information for a type provider component - - - - Represents the inverse of a measure expressions when returned as a generic argument of a provided type. - - - Represents the '1' measure expression when returned as a generic argument of a provided type. - - - Represents the product of two measure expressions when returned as a generic argument of a provided type. - - - Creates an instance of the attribute - TypeProviderAssemblyAttribute - The name of the design-time assembly for this type provider. - - - Creates an instance of the attribute - TypeProviderAssemblyAttribute - - - Place attribute on runtime assembly to indicate that there is a corresponding design-time - assembly that contains a type provider. Runtime and designer assembly may be the same. - - - Creates an instance of the attribute - TypeProviderAttribute - - - Place on a class that implements ITypeProvider to extend the compiler - - - - Get the full path to use for temporary files for the type provider instance. - - - - - version of referenced system runtime assembly - - - - - Get the full path to referenced assembly that caused this type provider instance to be created. - - - - - Get the full path to use to resolve relative paths in any file name arguments given to the type provider instance. - - - - - Get the referenced assemblies for the type provider instance. - - - - - Indicates if the type provider host responds to invalidation events for type provider instances. - - - - - Indicates if the type provider instance is used in an environment which executes provided code such as F# Interactive. - - - - - Get the full path to use for temporary files for the type provider instance. - - - - - version of referenced system runtime assembly - - - - - Get the full path to referenced assembly that caused this type provider instance to be created. - - - - - Get the full path to use to resolve relative paths in any file name arguments given to the type provider instance. - - - - - Get the referenced assemblies for the type provider instance. - - - - - Indicates if the type provider host responds to invalidation events for type provider instances. - - - - - Indicates if the type provider instance is used in an environment which executes provided code such as F# Interactive. - - - - - Checks if given type exists in target system runtime library - - - - - If the class that implements ITypeProvider has a constructor that accepts TypeProviderConfig - then it will be constructed with an instance of TypeProviderConfig. - - - - Creates an instance of the attribute - TypeProviderEditorHideMethodsAttribute - - - Indicates that a code editor should hide all System.Object methods from the intellisense menus for instances of a provided type - - - Additional type attribute flags related to provided types - - - Creates an instance of the attribute - TypeProviderXmlDocAttribute - - - - The TypeProviderXmlDocAttribute attribute can be added to types and members. - The language service will display the CommentText property from the attribute - in the appropriate place when the user hovers over a type or member. - - - - Creates an anonymous event with the given handlers. - - A function to handle adding a delegate for the event to trigger. - A function to handle removing a delegate that the event triggers. - A function to produce the delegate type the event can trigger. - - The initialized event. - - - The F# compiler emits calls to this function to implement the use operator for F# sequence - expressions. - - The resource to be used and disposed. - The input sequence. - - The result sequence. - - - The F# compiler emits calls to this function to implement the compiler-intrinsic - conversions from untyped System.Collections.IEnumerable sequences to typed sequences. - - An initializer function. - A function to iterate and test if end of sequence is reached. - A function to retrieve the current element. - - The resulting typed sequence. - - - The F# compiler emits calls to this function to - implement the try/finally operator for F# sequence expressions. - - The input sequence. - A computation to be included in an enumerator's Dispose method. - - The result sequence. - - - The F# compiler emits calls to this function to - implement the while operator for F# sequence expressions. - - A function that indicates whether iteration should continue. - The input sequence. - - The result sequence. - - - A group of functions used as part of the compiled representation of F# sequence expressions. - - - Builds a query using query syntax and operators. - - - An active pattern to force the execution of values of type Lazy<_>. - - - Special prefix operator for splicing untyped expressions into quotation holes. - - - Special prefix operator for splicing typed expressions into quotation holes. - - - Builds a 2D array from a sequence of sequences of elements. - - - Builds a read-only lookup table from a sequence of key/value pairs. The key objects are indexed using generic hashing and equality. - - - Converts the argument to signed byte. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using SByte.Parse() with InvariantCulture settings. - Otherwise the operation requires and invokes a ToSByte method on the input type. - - - Converts the argument to byte. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Byte.Parse() on strings and otherwise requires a ToByte method on the input type. - - - Converts the argument to 64-bit float. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Double.Parse() with InvariantCulture settings. Otherwise the operation requires and invokes a ToDouble method on the input type. - - - Converts the argument to 32-bit float. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Single.Parse() with InvariantCulture settings. Otherwise the operation requires and invokes a ToSingle method on the input type. - - - Builds an aysnchronous workflow using computation expression syntax. - - - Builds a set from a sequence of objects. The objects are indexed using generic comparison. - The input sequence of elements. - The created set. - - - Print to a file using the given format, and add a newline. - The file TextWriter. - The formatter. - The formatted result. - - - Print to a file using the given format. - The file TextWriter. - The formatter. - The formatted result. - - - Print to a string buffer and raise an exception with the given - result. Helper printers must return strings. - The formatter. - The formatted result. - - - Print to a string using the given format. - The formatter. - The formatted result. - - - Converts the argument to signed byte. - This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using SByte.Parse() with InvariantCulture settings. - Otherwise the operation requires and invokes a ToSByte method on the input type. - - - Converts the argument to byte. - This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using Byte.Parse() on strings and otherwise requires a ToByte method on the input type. - - - Divides a value by an integer. - The input value. - The input int. - The division result. - - - Resolves to the value 'one' for any primitive numeric type or any type with a static member called 'One' - - - Resolves to the zero value for any primitive numeric type or any type with a static member called 'Zero' - - - A compiler intrinsic that implements dynamic invocations for the DivideByInt primitive. - - - A compiler intrinsic that implements dynamic invocations to the checked '*' operator. - - - A compiler intrinsic that implements dynamic invocations to the '*' operator. - - - A compiler intrinsic that implements dynamic invocations to the checked '+' operator. - - - A compiler intrinsic that implements dynamic invocations to the '+' operator. - - - Resolves to the value 'one' for any primitive numeric type or any type with a static member called 'One'. - - - Resolves to the zero value for any primitive numeric type or any type with a static member called 'Zero'. - - - Parse an uint64 according to the rules used by the overloaded 'uint64' conversion operator when applied to strings - The input string. - The parsed value. - - - Parse an int64 according to the rules used by the overloaded 'int64' conversion operator when applied to strings - The input string. - The parsed value. - - - Parse an uint32 according to the rules used by the overloaded 'uint32' conversion operator when applied to strings - The input string. - The parsed value. - - - Parse an int32 according to the rules used by the overloaded 'int32' conversion operator when applied to strings - The input string. - The parsed value. - - - Creates an sbyte value with units-of-measure - The input sbyte. - The sbyte with units-of-measure. - - - Creates an int16 value with units-of-measure - The input int16. - The int16 with units-of-measure. - - - Creates an int64 value with units-of-measure - The input int64. - The int64 with units of measure. - - - Creates an int32 value with units-of-measure - The input int. - The int with units of measure. - - - Creates a decimal value with units-of-measure - The input decimal. - The decimal with units of measure. - - - Creates a float32 value with units-of-measure - The input float. - The float with units-of-measure. - - - Creates a float value with units-of-measure - The input float. - The float with units-of-measure. - - - Get the underlying value for an enum value - The input enum. - The enumeration as a value. - - - Build an enum value from an underlying value - The input value. - The value as an enumeration. - - - Recursively hash a part of a value according to its structure. - The comparison function. - The input object. - The hashed value. - - - Hash a value according to its structure. Use the given limit to restrict the hash when hashing F# - records, lists and union types. - The limit on the number of nodes. - The input object. - The hashed value. - - - Hash a value according to its structure. This hash is not limited by an overall node count when hashing F# - records, lists and union types. - The input object. - The hashed value. - - - Make an F# comparer object for the given type - - - Make an F# hash/equality object for the given type - - - Make an F# hash/equality object for the given type using node-limited hashing when hashing F# - records, lists and union types. - The input limit on the number of nodes. - System.Collections.Generic.IEqualityComparer<'T> - - - Make an F# hash/equality object for the given type - - - Make an F# comparer object for the given type, where it can be null if System.Collections.Generic.Comparer<'T>.Default - - - Make an F# comparer object for the given type - - - A static F# comparer object - - - Return an F# comparer object suitable for hashing and equality. This hashing behaviour - of the returned comparer is not limited by an overall node count when hashing F# - records, lists and union types. This equality comparer has equivalence - relation semantics ([nan] = [nan]). - - - Return an F# comparer object suitable for hashing and equality. This hashing behaviour - of the returned comparer is not limited by an overall node count when hashing F# - records, lists and union types. - - - The physical hash. Hashes on the object identity, except for value types, - where we hash on the contents. - The input object. - The hashed value. - - - Reference/physical equality. - True if the inputs are reference-equal, false otherwise. - The first value. - The second value. - The result of the comparison. - - - Take the maximum of two values structurally according to the order given by GenericComparison - The first value. - The second value. - The maximum value. - - - Take the minimum of two values structurally according to the order given by GenericComparison - The first value. - The second value. - The minimum value. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values. May be called as a recursive case from an implementation of System.IComparable to - ensure consistent NaN comparison semantics. - The function to compare the values. - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values for equality - - The first value. - The second value. - The result of the comparison. - - - Compare two values for equality using equivalence relation semantics ([nan] = [nan]) - The first value. - The second value. - The result of the comparison. - - - Compare two values for equality using partial equivalence relation semantics ([nan] <> [nan]) - The first value. - The second value. - The result of the comparison. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs - - - - The standard overloaded associative (4-indexed) mutation operator - - - - The standard overloaded associative (3-indexed) mutation operator - - - The standard overloaded associative (2-indexed) mutation operator - - - The standard overloaded associative (indexed) mutation operator - - - The standard overloaded associative (4-indexed) lookup operator - - - The standard overloaded associative (3-indexed) lookup operator - - - The standard overloaded associative (2-indexed) lookup operator - - - The standard overloaded associative (indexed) lookup operator - - - A compiler intrinsic for checking initialization soundness of recursive bindings - - - A compiler intrinsic for checking initialization soundness of recursive static bindings - - - A compiler intrinsic for checking initialization soundness of recursive bindings - - - A compiler intrinsic for the efficient compilation of sequence expressions - - - This function implements parsing of decimal constants - - - This function implements calls to default constructors - acccessed by 'new' constraints. - - - Primitive used by pattern match compilation - - - A compiler intrinsic that implements the ':?' operator - - - A compiler intrinsic that implements the ':?' operator - - - A compiler intrinsic that implements the ':?>' operator - - - A compiler intrinsic that implements the ':?>' operator - - - The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs - - - Address-of. Uses of this value may result in the generation of unverifiable code. - The input object. - The unmanaged pointer. - - - Address-of. Uses of this value may result in the generation of unverifiable code. - The input object. - The managed pointer. - - - Binary 'or'. When used as a binary operator the right hand value is evaluated only on demand - The first value. - The second value. - The result of the operation. - - - Binary 'or'. When used as a binary operator the right hand value is evaluated only on demand. - - - Binary 'and'. When used as a binary operator the right hand value is evaluated only on demand - The first value. - The second value. - The result of the operation. - - - Binary 'and'. When used as a binary operator the right hand value is evaluated only on demand. - - - The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs - - - For compiler use only - - - Language primitives associated with the F# language - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - An active pattern to match values of type System.Collections.Generic.KeyValuePair - The input key/value pair. - A tuple containing the key and value. - - - Converts the argument to character. Numeric inputs are converted according to the UTF-16 - encoding for characters. String inputs must be exactly one character long. For other - input types the operation requires an appropriate static conversion method on the input type. - The input value. - The converted char. - - - Converts the argument to System.Decimal using a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted decimal. - - - Converts the argument to a string using ToString. - - For standard integer and floating point values the ToString conversion - uses CultureInfo.InvariantCulture. - The input value. - The converted string. - - - Converts the argument to unsigned native integer using a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted unativeint - - - Converts the argument to signed native integer. This is a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted nativeint - - - Converts the argument to 64-bit float. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Double.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float - - - Converts the argument to 32-bit float. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Single.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float32 - - - Converts the argument to unsigned 64-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint64 - - - Converts the argument to signed 64-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int64 - - - Converts the argument to unsigned 32-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint32 - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int32 - - - Converts the argument to a particular enum type. - The input value. - The converted enum type. - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int - - - Converts the argument to unsigned 16-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint16 - - - Converts the argument to signed 16-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int16 - - - Converts the argument to signed byte. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using SByte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to byte. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Byte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - Overloaded power operator. If n > 0 then equivalent to x*...*x for n occurrences of x. - The input base. - The input exponent. - The base raised to the exponent. - - - Overloaded power operator. - The input base. - The input exponent. - The base raised to the exponent. - - - Overloaded truncate operator. - The input value. - The truncated value. - - - Hyperbolic tangent of the given number - The input value. - The hyperbolic tangent of the input. - - - Tangent of the given number - The input value. - The tangent of the input. - - - Hyperbolic sine of the given number - The input value. - The hyperbolic sine of the input. - - - Sine of the given number - The input value. - The sine of the input. - - - Hyperbolic cosine of the given number - The input value. - The hyperbolic cosine of the input. - - - Cosine of the given number - The input value. - The cosine of the input. - - - Square root of the given number - The input value. - The square root of the input. - - - Logarithm to base 10 of the given number - The input value. - The logarithm to base 10 of the input. - - - Natural logarithm of the given number - The input value. - The natural logarithm of the input. - - - Round the given number - The input value. - The nearest integer to the input value. - - - Sign of the given number - The input value. - -1, 0, or 1 depending on the sign of the input. - - - Floor of the given number - The input value. - The floor of the input. - - - Exponential of the given number - The input value. - The exponential of the input. - - - Ceiling of the given number - The input value. - The ceiling of the input. - - - Inverse tangent of x/y where x and y are specified separately - The y input value. - The x input value. - The inverse tangent of the input ratio. - - - Inverse tangent of the given number - The input value. - The inverse tangent of the input. - - - Inverse sine of the given number - The input value. - The inverse sine of the input. - - - Inverse cosine of the given number - The input value. - The inverse cosine of the input. - - - Absolute value of the given number. - The input value. - The absolute value of the input. - - - A generic hash function. This function has the same behaviour as 'hash', - however the default structural hashing for F# union, record and tuple - types stops when the given limit of nodes is reached. The exact behaviour of - the function can be adjusted on a type-by-type basis by implementing - GetHashCode for each type. - The limit of nodes. - The input object. - The computed hash. - - - A generic hash function, designed to return equal hash values for items that are - equal according to the "=" operator. By default it will use structural hashing - for F# union, record and tuple types, hashing the complete contents of the - type. The exact behaviour of the function can be adjusted on a - type-by-type basis by implementing GetHashCode for each type. - The input object. - The computed hash. - - - Returns the internal size of a type in bytes. For example, sizeof<int> returns 4. - - - Generate a System.Type representation for a type definition. If the - input type is a generic type instantiation then return the - generic type definition associated with all such instantiations. - - - An internal, library-only compiler intrinsic for compile-time - generation of a RuntimeMethodHandle. - - - Generate a System.Type runtime representation of a static type. - - - Clean up resources associated with the input object after the completion of the given function. - Cleanup occurs even when an exception is raised by the protected - code. - The resource to be disposed after action is called. - The action that accepts the resource. - The resulting value. - - - Execute the function as a mutual-exclusion region using the input value as a lock. - The object to be locked. - The action to perform during the lock. - The resulting value. - - - The standard overloaded skip range operator, e.g. [n..skip..m] for lists, seq {n..skip..m} for sequences - The start value of the range. - The step value of the range. - The end value of the range. - The sequence spanning the range using the specified step size. - - - The standard overloaded range operator, e.g. [n..m] for lists, seq {n..m} for sequences - The start value of the range. - The end value of the range. - The sequence spanning the range. - - - Equivalent to System.Single.NaN - - - Equivalent to System.Single.PositiveInfinity - - - Equivalent to System.Double.NaN - - - Equivalent to System.Double.PositiveInfinity - - - Builds a sequence using sequence expression syntax - The input sequence. - The result sequence. - - - Negate a logical value. not true equals false and not false equals true - The value to negate. - The result of the negation. - - - Concatenate two lists. - The first list. - The second list. - The concatenation of the lists. - - - Increment a mutable reference cell containing an integer - The reference cell. - - - Decrement a mutable reference cell containing an integer - The reference cell. - - - Dereference a mutable reference cell - The cell to dereference. - The value contained in the cell. - - - Assign to a mutable reference cell - The cell to mutate. - The value to set inside the cell. - - - Create a mutable reference cell - The value to contain in the cell. - The created reference cell. - - - The identity function - The input value. - The same value. - - - Throw a System.InvalidOperationException exception - The exception message. - The result value. - - - Throw a System.ArgumentNullException exception - The argument name. - The result value. - - - Throw a System.ArgumentException exception with - the given argument name and message. - The argument name. - The exception message. - The result value. - - - Throw a System.Exception exception. - The exception message. - The result value. - - - Determines whether the given value is null. - The value to check. - True when value is null, false otherwise. - - - Try to unbox a strongly typed value. - The boxed value. - The unboxed result as an option. - - - Boxes a strongly typed value. - The value to box. - The boxed object. - - - Unboxes a strongly typed value. - The boxed value. - The unboxed result. - - - Ignore the passed value. This is often used to throw away results of a computation. - The value to ignore. - - - Minimum based on generic comparison - The first value. - The second value. - The minimum value. - - - Maximum based on generic comparison - The first value. - The second value. - The maximum value. - - - Generic comparison. - The first value. - The second value. - The result of the comparison. - - - Return the second element of a tuple, snd (a,b) = b. - The input tuple. - The second value. - - - Return the first element of a tuple, fst (a,b) = a. - The input tuple. - The first value. - - - Matches System.Exception objects whose runtime type is precisely System.Exception - The input exception. - A string option. - - - Builds a System.Exception object. - The message for the Exception. - A System.Exception. - - - Rethrows an exception. This should only be used when handling an exception - The result value. - - - Rethrows an exception. This should only be used when handling an exception - The result value. - - - Raises an exception - The exception to raise. - The result value. - - - Concatenate two strings. The operator '+' may also be used. - - - Used to specify a default value for an optional argument in the implementation of a function - An option representing the argument. - The default value of the argument. - The argument value. If it is None, the defaultValue is returned. - - - Apply a function to three values, the values being a triple on the right, the function on the left - The function. - The first argument. - The second argument. - The third argument. - The function result. - - - Apply a function to two values, the values being a pair on the right, the function on the left - The function. - The first argument. - The second argument. - The function result. - - - Apply a function to a value, the value being on the right, the function on the left - The function. - The argument. - The function result. - - - Apply a function to three values, the values being a triple on the left, the function on the right - The first argument. - The second argument. - The third argument. - The function. - The function result. - - - Apply a function to two values, the values being a pair on the left, the function on the right - The first argument. - The second argument. - The function. - The function result. - - - Apply a function to a value, the value being on the left, the function on the right - The argument. - The function. - The function result. - - - Compose two functions, the function on the right being applied first - The second function to apply. - The first function to apply. - The composition of the input functions. - - - Compose two functions, the function on the left being applied first - The first function to apply. - The second function to apply. - The composition of the input functions. - - - Structural inequality - The first parameter. - The second parameter. - The result of the comparison. - - - Structural equality - The first parameter. - The second parameter. - The result of the comparison. - - - Structural less-than-or-equal comparison - The first parameter. - The second parameter. - The result of the comparison. - - - Structural greater-than-or-equal - The first parameter. - The second parameter. - The result of the comparison. - - - Structural greater-than - The first parameter. - The second parameter. - The result of the comparison. - - - Structural less-than comparison - The first parameter. - The second parameter. - The result of the comparison. - - - Overloaded prefix-plus operator - The input value. - The result of the operation. - - - Overloaded bitwise-NOT operator - The input value. - The result of the operation. - - - Overloaded byte-shift right operator by a specified number of bits - The input value. - The amount to shift. - The result of the operation. - - - Overloaded byte-shift left operator by a specified number of bits - The input value. - The amount to shift. - The result of the operation. - - - Overloaded bitwise-XOR operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded bitwise-OR operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded bitwise-AND operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded modulo operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded division operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded multiplication operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded subtraction operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded addition operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded unary negation. - The value to negate. - The result of the operation. - - - Converts the argument to char. Numeric inputs are converted using a checked - conversion according to the UTF-16 encoding for characters. String inputs must - be exactly one character long. For other input types the operation requires an - appropriate static conversion method on the input type. - The input value. - The converted char - - - Converts the argument to unativeint. This is a direct, checked conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted unativeint - - - Converts the argument to nativeint. This is a direct, checked conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted nativeint - - - Converts the argument to uint64. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.UInt64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint64 - - - Converts the argument to int64. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int64 - - - Converts the argument to uint32. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.UInt32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint32 - - - Converts the argument to int32. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int32 - - - Converts the argument to int. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int - - - Converts the argument to uint16. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.UInt16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint16 - - - Converts the argument to int16. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int16 - - - Converts the argument to sbyte. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.SByte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to byte. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Byte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - Overloaded multiplication operator (checks for overflow) - The first value. - The second value. - The product of the two input values. - - - Overloaded addition operator (checks for overflow) - The first value. - The second value. - The sum of the two input values. - - - Overloaded subtraction operator (checks for overflow) - The first value. - The second value. - The first value minus the second value. - - - Overloaded unary negation (checks for overflow) - The input value. - The negated value. - - - This module contains the basic arithmetic operations with overflow checks. - - - Calls GetHashCode() on the value - The value. - The hash code. - - - Minimum of the two values - The first value. - The second value. - The minimum value. - - - Maximum of the two values - The first value. - The second value. - The maximum value. - - - Compares the two values - The first value. - The second value. - The result of the comparison. - - - Compares the two values for inequality - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for equality - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for less-than-or-equal - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for greater-than-or-equal - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for greater-than - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for less-than - The first parameter. - The second parameter. - The result of the comparison. - - - A module of comparison and equality operators that are statically resolved, but which are not fully generic and do not make structural comparison. Opening this - module may make code that relies on structural or generic comparison no longer compile. - - - Perform generic hashing on a value where the type of the value is not - statically required to satisfy the 'equality' constraint. - The computed hash value. - - - Perform generic equality on two values where the type of the values is not - statically required to satisfy the 'equality' constraint. - The result of the comparison. - - - Perform generic comparison on two values where the type of the values is not - statically required to have the 'comparison' constraint. - The result of the comparison. - - - Generate a default value for any type. This is null for reference types, - For structs, this is struct value where all fields have the default value. - This function is unsafe in the sense that some F# values do not have proper null values. - - - Unboxes a strongly typed value. This is the inverse of box, unbox<t>(box<t> a) equals a. - The boxed value. - The unboxed result. - - - This module contains basic operations which do not apply runtime and/or static checks - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'decimal' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'float' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'float32' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'unativeint' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'nativeint' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint64' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int64' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint32' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int32' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint16' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int16' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'sbyte' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'byte' - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - Generate a range of values using the given zero, add, start, step and stop values - - - Generate a range of values using the given zero, add, start, step and stop values - - - Generate a range of char values - - - Generate a range of byte values - - - Generate a range of sbyte values - - - Generate a range of uint16 values - - - Generate a range of int16 values - - - Generate a range of unativeint values - - - Generate a range of nativeint values - - - Generate a range of uint32 values - - - Generate a range of uint64 values - - - Generate a range of int64 values - - - Generate a range of float32 values - - - Generate a range of float values - - - Generate a range of integers - - - Gets a slice from a string - The source string. - The index of the first character of the slice. - The index of the last character of the slice. - The substring from the given indices. - - - Sets a slice of an array - The target array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The start index of the fourth dimension. - The end index of the fourth dimension. - The source array. - - - Gets a slice of an array - The source array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The start index of the fourth dimension. - The end index of the fourth dimension. - The four dimensional sub array from the given indices. - - - Sets a slice of an array - The target array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The source array. - - - Gets a slice of an array - The source array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The three dimensional sub array from the given indices. - - - Sets a vector slice of a 2D array. The index of the second dimension is fixed. - The target array. - The start index of the first dimension. - The end index of the first dimension. - The index of the second dimension. - The source array. - - - Sets a vector slice of a 2D array. The index of the first dimension is fixed. - The target array. - The index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The source array. - - - Sets a region slice of an array - The target array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The source array. - - - Gets a vector slice of a 2D array. The index of the second dimension is fixed. - The source array. - The start index of the first dimension. - The end index of the first dimension. - The fixed index of the second dimension. - The sub array from the input indices. - - - Gets a vector slice of a 2D array. The index of the first dimension is fixed. - The source array. - The index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The sub array from the input indices. - - - Gets a region slice of an array - The source array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The two dimensional sub array from the input indices. - - - Sets a slice of an array - The target array. - The start index. - The end index. - The source array. - - - Gets a slice of an array - The input array. - The start index. - The end index. - The sub array from the input indices. - - - A module of compiler intrinsic functions for efficient implementations of F# integer ranges - and dynamic invocations of other F# operators - - - Basic F# Operators. This module is automatically opened in all F# code. - - - Invoke an F# first class function value that accepts five curried arguments - without intervening execution - The first arg. - The second arg. - The third arg. - The fourth arg. - The fifth arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept five curried arguments without intervening execution. - The input function. - The optimized function. - - - Construct an optimized function value that can accept five curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept five curried arguments - without intervening execution. This type should not typically used directly from - either F# code or from other CLI languages. - - - Invoke an F# first class function value that accepts four curried arguments - without intervening execution - The first arg. - The second arg. - The third arg. - The fourth arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept four curried arguments without intervening execution. - The input function. - The optimized function. - - - Construct an optimized function value that can accept four curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept four curried arguments - without intervening execution. This type should not typically used directly from - either F# code or from other CLI languages. - - - Invoke an F# first class function value that accepts three curried arguments - without intervening execution - The first arg. - The second arg. - The third arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept three curried arguments without intervening execution. - The input function. - The adapted function. - - - Construct an optimized function value that can accept three curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept - three iterated (curried) arguments without intervening execution. This type should not - typically used directly from either F# code or from other CLI languages. - - - Invoke the optimized function value with two curried arguments - The first arg. - The second arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept two curried arguments without intervening execution. - The input function. - The adapted function. - - - Construct an optimized function value that can accept two curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept - two iterated (curried) arguments without intervening execution. This type should not - typically used directly from either F# code or from other CLI languages. - - - An implementation module used to hold some private implementations of function - value invocation. - - - Convert an option to a potentially null value. - The input value. - The result value, which is null if the input was None. - - - Convert a potentially null value to an option. - The input value. - The result option. - - - Convert a Nullable value to an option. - The input nullable value. - The result option. - - - Convert the option to a Nullable value. - The input option. - The result value. - - - Convert the option to a list of length 0 or 1. - The input option. - The result list. - - - Convert the option to an array of length 0 or 1. - The input option. - The result array. - - - filter f inp evaluates to match inp with None -> None | Some x -> if f x then Some x else None. - A function that evaluates whether the value contained in the option should remain, or be filtered out. - The input option. - The input if the predicate evaluates to true; otherwise, None. - - - bind f inp evaluates to match inp with None -> None | Some x -> f x - A function that takes the value of type T from an option and transforms it into - an option containing a value of type U. - The input option. - An option of the output type of the binder. - - - map f inp evaluates to match inp with None -> None | Some x -> Some (f x). - A function to apply to the option value. - The input option. - An option of the input value after applying the mapping function, or None if the input is None. - - - iter f inp executes match inp with None -> () | Some x -> f x. - A function to apply to the option value. - The input option. - Unit if the option is None, otherwise it returns the result of applying the predicate - to the option value. - - - forall p inp evaluates to match inp with None -> true | Some x -> p x. - A function that evaluates to a boolean when given a value from the option type. - The input option. - True if the option is None, otherwise it returns the result of applying the predicate - to the option value. - - - exists p inp evaluates to match inp with None -> false | Some x -> p x. - A function that evaluates to a boolean when given a value from the option type. - The input option. - False if the option is None, otherwise it returns the result of applying the predicate - to the option value. - - - fold f inp s evaluates to match inp with None -> s | Some x -> f x s. - A function to update the state data when given a value from an option. - The input option. - The initial state. - The original state if the option is None, otherwise it returns the updated state with the folder - and the option value. - - - fold f s inp evaluates to match inp with None -> s | Some x -> f s x. - A function to update the state data when given a value from an option. - The initial state. - The input option. - The original state if the option is None, otherwise it returns the updated state with the folder - and the option value. - - - count inp evaluates to match inp with None -> 0 | Some _ -> 1. - The input option. - A zero if the option is None, a one otherwise. - - - Gets the value associated with the option. - The input option. - The value within the option. - Thrown when the option is None. - - - Returns true if the option is None. - The input option. - True if the option is None. - - - Returns true if the option is not None. - The input option. - True if the option is not None. - - - Basic operations on options. - - - Represents a statically-analyzed format associated with writing to a System.IO.TextWriter. The type parameter indicates the - arguments and return type of the format operation. - - - Represents a statically-analyzed format when formatting builds a string. The type parameter indicates the - arguments and return type of the format operation. - - - Represents a statically-analyzed format associated with writing to a System.Text.StringBuilder. The type parameter indicates the - arguments and return type of the format operation. - - - Represents a statically-analyzed format associated with writing to a System.IO.TextWriter. The first type parameter indicates the - arguments of the format operation and the last the overall return type. - - - Represents a statically-analyzed format when formatting builds a string. The first type parameter indicates the - arguments of the format operation and the last the overall return type. - - - Represents a statically-analyzed format associated with writing to a System.Text.StringBuilder. The first type parameter indicates the - arguments of the format operation and the last the overall return type. - - - Print to a string buffer and raise an exception with the given - result. Helper printers must return strings. - The input formatter. - The arguments of the formatter. - - - sprintf, but call the given 'final' function to generate the result. - See kprintf. - The function called to generate a result from the formatted string. - The input formatter. - The arguments of the formatter. - - - printf, but call the given 'final' function to generate the result. - For example, these let the printing force a flush after all output has - been entered onto the channel, but not before. - The function called after formatting to generate the format result. - The input formatter. - The arguments of the formatter. - - - fprintf, but call the given 'final' function to generate the result. - See kprintf. - The function called after formatting to generate the format result. - The input TextWriter. - The input formatter. - The arguments of the formatter. - - - bprintf, but call the given 'final' function to generate the result. - See kprintf. - The function called after formatting to generate the format result. - The input StringBuilder. - The input formatter. - The arguments of the formatter. - - - Print to a string via an internal string buffer and return - the result as a string. Helper printers must return strings. - The input formatter. - The formatted string. - - - Print to a text writer, adding a newline - The TextWriter to print to. - The input formatter. - The return type and arguments of the formatter. - - - Print to a text writer. - The TextWriter to print to. - The input formatter. - The return type and arguments of the formatter. - - - Print to a System.Text.StringBuilder - The StringBuilder to print to. - The input formatter. - The return type and arguments of the formatter. - - - Extensible printf-style formatting for numbers and other datatypes - - Format specifications are strings with "%" markers indicating format - placeholders. Format placeholders consist of: - - %[flags][width][.precision][type] - - where the type is interpreted as follows: - - %b: bool, formatted as "true" or "false" - %s: string, formatted as its unescaped contents - %c: character literal - %d, %i: any basic integer type formatted as a decimal integer, signed if the basic integer type is signed. - %u: any basic integer type formatted as an unsigned decimal integer - %x, %X, %o: any basic integer type formatted as an unsigned hexadecimal - (a-f)/Hexadecimal (A-F)/Octal integer - - %e, %E, %f, %F, %g, %G: - any basic floating point type (float,float32) formatted - using a C-style floating point format specifications, i.e - - %e, %E: Signed value having the form [-]d.dddde[sign]ddd where - d is a single decimal digit, dddd is one or more decimal - digits, ddd is exactly three decimal digits, and sign - is + or - - - %f: Signed value having the form [-]dddd.dddd, where dddd is one - or more decimal digits. The number of digits before the - decimal point depends on the magnitude of the number, and - the number of digits after the decimal point depends on - the requested precision. - - %g, %G: Signed value printed in f or e format, whichever is - more compact for the given value and precision. - - - %M: System.Decimal value - - %O: Any value, printed by boxing the object and using it's ToString method(s) - - %A: Any value, printed with the default layout settings - - %a: A general format specifier, requires two arguments: - (1) a function which accepts two arguments: - (a) a context parameter of the appropriate type for the - given formatting function (e.g. an #System.IO.TextWriter) - (b) a value to print - and which either outputs or returns appropriate text. - - (2) the particular value to print - - - %t: A general format specifier, requires one argument: - (1) a function which accepts a context parameter of the - appropriate type for the given formatting function (e.g. - an System.IO.TextWriter)and which either outputs or returns - appropriate text. - - Basic integer types are: - byte,sbyte,int16,uint16,int32,uint32,int64,uint64,nativeint,unativeint - Basic floating point types are: - float, float32 - - The optional width is an integer indicating the minimal width of the - result. For instance, %6d prints an integer, prefixing it with spaces - to fill at least 6 characters. If width is '*', then an extra integer - argument is taken to specify the corresponding width. - - any number - '*': - - Valid flags are: - - 0: add zeros instead of spaces to make up the required width - '-': left justify the result within the width specified - '+': add a '+' character if the number is positive (to match a '-' sign - for negatives) - ' ': add an extra space if the number is positive (to match a '-' - sign for negatives) - - The printf '#' flag is invalid and a compile-time error will be reported if it is used. - - - Returns the length of the string. - The input string. - The number of characters in the string. - - - Returns a string by concatenating count instances of str. - The number of copies of the input string will be copied. - The input string. - The concatenated string. - Thrown when count is negative. - - - Tests if any character of the string satisfies the given predicate. - The function to test each character of the string. - The input string. - True if any character returns true for the predicate and false otherwise. - - - Tests if all characters in the string satisfy the given predicate. - The function to test each character of the string. - The input string. - True if all characters return true for the predicate and false otherwise. - - - Builds a new string whose characters are the results of applying the function mapping - to each index from 0 to count-1 and concatenating the resulting - strings. - The number of strings to initialize. - The function to take an index and produce a string to - be concatenated with the others. - The constructed string. - Thrown when count is negative. - - - Builds a new string containing only the characters of the input string - for which the given predicate returns "true". - - Returns an empty string if the input string is null - - A function to test whether each character in the input sequence should be included in the output string. - The input string. - The resulting string. - - - Builds a new string whose characters are the results of applying the function mapping - to each of the characters of the input string and concatenating the resulting - strings. - The function to produce a string from each character of the input string. - The input string. - The concatenated string. - - - Builds a new string whose characters are the results of applying the function mapping - to each character and index of the input string. - The function to apply to each character and index of the string. - The input string. - The resulting string. - - - Builds a new string whose characters are the results of applying the function mapping - to each of the characters of the input string. - The function to apply to the characters of the string. - The input string. - The resulting string. - - - Applies the function action to the index of each character in the string and the - character itself. - The function to apply to each character and index of the string. - The input string. - - - Applies the function action to each character in the string. - The function to be applied to each character of the string. - The input string. - - - Returns a new string made by concatenating the given strings - with separator sep, that is a1 + sep + ... + sep + aN. - The separator string to be inserted between the strings - of the input sequence. - The sequence of strings to be concatenated. - A new string consisting of the concatenated strings separated by - the separation string. - Thrown when strings is null. - - - Functional programming operators for string processing. Further string operations - are available via the member functions on strings and other functionality in - System.String - and System.Text.RegularExpressions types. - - - - The SI unit of catalytic activity - - - - - The SI unit of does equivalent - - - - - The SI unit of absorbed dose - - - - - The SI unit of activity referred to a radionuclide - - - - - The SI unit of illuminance - - - - - The SI unit of luminous flux - - - - - The SI unit of inductance - - - - - The SI unit of magnetic flux density - - - - - The SI unit of magnetic flux - - - - - The SI unit of electric conductance - - - - - The SI unit of electric resistance - - - - - The SI unit of capacitance - - - - - The SI unit of electric potential difference, electromotive force - - - - - The SI unit of electric charge, amount of electricity - - - - - The SI unit of power, radiant flux - - - - - The SI unit of energy, work, amount of heat - - - - - The SI unit of pressure, stress - - - - - The SI unit of force - - - - - The SI unit of frequency - - - - - The SI unit of luminous intensity - - - - - The SI unit of amount of substance - - - - - The SI unit of thermodynamic temperature - - - - - The SI unit of electric current - - - - - The SI unit of time - - - - - The SI unit of mass - - - - - The SI unit of length - - - - - The SI unit of length - - - - - A synonym for henry, the SI unit of inductance - - - - - A synonym for katal, the SI unit of catalytic activity - - - - - A synonym for sievert, the SI unit of does equivalent - - - - - A synonym for gray, the SI unit of absorbed dose - - - - - A synonym for becquerel, the SI unit of activity referred to a radionuclide - - - - - A synonym for lux, the SI unit of illuminance - - - - - A synonym for lumen, the SI unit of luminous flux - - - - - A synonym for tesla, the SI unit of magnetic flux density - - - - - A synonym for weber, the SI unit of magnetic flux - - - - - A synonym for UnitNames.ohm, the SI unit of electric resistance. - - - - - A synonym for siemens, the SI unit of electric conductance - - - - - A synonym for farad, the SI unit of capacitance - - - - - A synonym for volt, the SI unit of electric potential difference, electromotive force - - - - - A synonym for coulomb, the SI unit of electric charge, amount of electricity - - - - - A synonym for watt, the SI unit of power, radiant flux - - - - - A synonym for joule, the SI unit of energy, work, amount of heat - - - - - A synonym for pascal, the SI unit of pressure, stress - - - - - A synonym for newton, the SI unit of force - - - - - A synonym for hertz, the SI unit of frequency - - - - - A synonym for candela, the SI unit of luminous intensity - - - - - A synonym for mole, the SI unit of amount of substance - - - - - A synonym for kelvin, the SI unit of thermodynamic temperature - - - - - A synonym for ampere, the SI unit of electric current - - - - - A synonym for second, the SI unit of time - - - - - A synonym for kilogram, the SI unit of mass - - - - - A synonym for Metre, the SI unit of length - - - - - A method used to support the F# query syntax. Returns an empty sequence that has the specified type argument. - - - - - A method used to support the F# query syntax. Returns a sequence that contains the specified values. - - - - - A method used to support the F# query syntax. Returns a sequence of length one that contains the specified value. - - - - A query operator that selects those elements based on a specified predicate. - - - - A query operator that performs a subsequent ordering of the elements selected so far in descending order by the given nullable sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - - - - A query operator that performs a subsequent ordering of the elements selected so far in ascending order by the given nullable sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - - - - A query operator that performs a subsequent ordering of the elements selected so far in descending order by the given sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - - - - A query operator that performs a subsequent ordering of the elements selected so far in ascending order by the given sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - - - - A query operator that selects elements from a sequence as long as a specified condition is true, and then skips the remaining elements. - - - - A query operator that selects a specified number of contiguous elements from those selected so far. - - - - A query operator that selects a nullable value for each element selected so far and returns the sum of these values. - If any nullable does not have a value, it is ignored. - - - - A query operator that selects a value for each element selected so far and returns the sum of these values. - - - - - A method used to support the F# query syntax. Inputs to queries are implicitly wrapped by a call to one of the overloads of this method. - - - - - A method used to support the F# query syntax. Inputs to queries are implicitly wrapped by a call to one of the overloads of this method. - - - - A query operator that sorts the elements selected so far in descending order by the given nullable sorting key. - - - - A query operator that sorts the elements selected so far in ascending order by the given nullable sorting key. - - - - A query operator that sorts the elements selected so far in descending order by the given sorting key. - - - - A query operator that sorts the elements selected so far in ascending order by the given sorting key. - - - - A query operator that bypasses elements in a sequence as long as a specified condition is true and then selects the remaining elements. - - - - A query operator that bypasses a specified number of the elements selected so far and selects the remaining elements. - - - - A query operator that projects each of the elements selected so far. - - - - - A method used to support the F# query syntax. Runs the given quotation as a query using LINQ IQueryable rules. - - - - - A method used to support the F# query syntax. Indicates that the query should be passed as a quotation to the Run method. - - - - A query operator that selects the element at a specified index amongst those selected so far. - - - - A query operator that selects a nullable value for each element selected so far and returns the minimum of these values. - If any nullable does not have a value, it is ignored. - - - - A query operator that selects a value for each element selected so far and returns the minimum resulting value. - - - - A query operator that selects a nullable value for each element selected so far and returns the maximum of these values. - If any nullable does not have a value, it is ignored. - - - - A query operator that selects a value for each element selected so far and returns the maximum resulting value. - - - - A query operator that correlates two sets of selected values based on matching keys and groups the results. - If any group is empty, a group with a single default value is used instead. - Normal usage is 'leftOuterJoin y in elements2 on (key1 = key2) into group'. - - - - A query operator that selects the last element of those selected so far, or a default value if no element is found. - - - - A query operator that selects the last element of those selected so far. - - - - A query operator that correlates two sets of selected values based on matching keys. - Normal usage is 'join y in elements2 on (key1 = key2)'. - - - - A query operator that selects the first element of those selected so far, or a default value if the sequence contains no elements. - - - - A query operator that selects the first element from those selected so far. - - - - A query operator that selects a value for each element selected so far and groups the elements by the given key. - - - - A query operator that correlates two sets of selected values based on matching keys and groups the results. - Normal usage is 'groupJoin y in elements2 on (key1 = key2) into group'. - - - - A query operator that groups the elements selected so far according to a specified key selector. - - - - - A method used to support the F# query syntax. Projects each element of a sequence to another sequence and combines the resulting sequences into one sequence. - - - - A query operator that selects the first element selected so far that satisfies a specified condition. - - - - A query operator that determines whether any element selected so far satisfies a condition. - - - - A query operator that selects the single, specific element of those selected so far, or a default value if that element is not found. - - - - A query operator that selects the single, specific element selected so far - - - - A query operator that selects distinct elements from the elements selected so far. - - - - A query operator that returns the number of selected elements. - - - - A query operator that determines whether the selected elements contains a specified element. - - - - A query operator that selects a nullable value for each element selected so far and returns the average of these values. - If any nullable does not have a value, it is ignored. - - - - A query operator that selects a value for each element selected so far and returns the average of these values. - - - - A query operator that determines whether all elements selected so far satisfies a condition. - - - - Create an instance of this builder. Use 'query { ... }' to use the query syntax. - - - - The type used to support the F# query syntax. Use 'query { ... }' to use the query syntax. - - - - - A property used to support the F# query syntax. - - - - - A method used to support the F# query syntax. - - - - - A partial input or result in an F# query. This type is used to support the F# query syntax. - - - - Converts the argument to character. Numeric inputs are converted according to the UTF-16 - encoding for characters. The operation requires an appropriate static conversion method on the input type. - The input value. - The converted char. - - - Converts the argument to System.Decimal using a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted decimal. - - - Converts the argument to unsigned native integer using a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted unativeint - - - Converts the argument to signed native integer. This is a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted nativeint - - - Converts the argument to 64-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float - - - Converts the argument to 32-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float32 - - - Converts the argument to 64-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float - - - Converts the argument to 32-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float32 - - - Converts the argument to unsigned 64-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint64 - - - Converts the argument to signed 64-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int64 - - - Converts the argument to unsigned 32-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint32 - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int32 - - - Converts the argument to a particular enum type. - The input value. - The converted enum type. - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int - - - Converts the argument to unsigned 16-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint16 - - - Converts the argument to signed 16-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int16 - - - Converts the argument to signed byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to signed byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - Converts the argument to byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - - Functions for converting nullable values - - - - - The division operator where a nullable value appears on both left and right sides - - - - - The division operator where a nullable value appears on the right - - - - - The division operator where a nullable value appears on the left - - - - - The modulus operator where a nullable value appears on both left and right sides - - - - - The modulus operator where a nullable value appears on the right - - - - - The modulus operator where a nullable value appears on the left - - - - - The multiplication operator where a nullable value appears on both left and right sides - - - - - The multiplication operator where a nullable value appears on the right - - - - - The multiplication operator where a nullable value appears on the left - - - - - The subtraction operator where a nullable value appears on both left and right sides - - - - - The subtraction operator where a nullable value appears on the right - - - - - The subtraction operator where a nullable value appears on the left - - - - - The addition operator where a nullable value appears on both left and right sides - - - - - The addition operator where a nullable value appears on the right - - - - - The addition operator where a nullable value appears on the left - - - - - The '<>' operator where a nullable value appears on both left and right sides - - - - - The '=' operator where a nullable value appears on both left and right sides - - - - - The '<' operator where a nullable value appears on both left and right sides - - - - - The '<=' operator where a nullable value appears on both left and right sides - - - - - The '>' operator where a nullable value appears on both left and right sides - - - - - The '>=' operator where a nullable value appears on both left and right sides - - - - - The '<>' operator where a nullable value appears on the right - - - - - The '=' operator where a nullable value appears on the right - - - - - The '<' operator where a nullable value appears on the right - - - - - The '<=' operator where a nullable value appears on the right - - - - - The '>' operator where a nullable value appears on the right - - - - - The '>=' operator where a nullable value appears on the right - - - - - The '<>' operator where a nullable value appears on the left - - - - - The '=' operator where a nullable value appears on the left - - - - - The '<' operator where a nullable value appears on the left - - - - - The '<=' operator where a nullable value appears on the left - - - - - The '>' operator where a nullable value appears on the left - - - - - The '>=' operator where a nullable value appears on the left - - - - - Operators for working with nullable values - - - - - A method used to support the F# query syntax. Runs the given quotation as a query using LINQ IEnumerable rules. - - - - - A method used to support the F# query syntax. Runs the given quotation as a query using LINQ rules. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - A type used to reconstruct a grouping after applying a mutable->immutable mapping transformation - on a result of a query. - - - - - The generic MethodInfo for Select function - Describes how we got from productions of immutable objects to productions of anonymous objects, with enough information - that we can invert the process in final query results. - - - - - Given the expression part of a "yield" or "select" which produces a result in terms of immutable tuples or immutable records, - generate an equivalent expression yielding anonymous objects. Also return the conversion for the immutable-to-mutable correspondence - so we can reverse this later. - - - - - Simplify gets of tuples and gets of record fields. - - - - - Cleanup the use of property-set object constructions in leaf expressions that form parts of F# queries. - - - - - Given an type involving immutable tuples and records, logically corresponding to the type produced at a - "yield" or "select", convert it to a type involving anonymous objects according to the conversion data. - - - - - Recognize anonymous type construction written using 'new AnonymousObject(<e1>, <e2>, ...)' - - - - - Recognize object construction written using 'new O(Prop1 = <e>, Prop2 = <e>, ...)' - - - - - Tests whether a list consists only of assignments of properties of the - given variable, null values (ignored) and ends by returning the given variable - (pattern returns only property assignments) - - - - - Recognize sequential series written as (... ((<e>; <e>); <e>); ...) - - - - - A runtime helper used to evaluate nested quotation literals. - - - - - A runtime helper used to evaluate nested quotation literals. - - - - - Evaluates a subset of F# quotations by first converting to a LINQ expression, for the subset of LINQ expressions represented by the - expression syntax in the C# language. - - - - - Converts a subset of F# quotations to a LINQ expression, for the subset of LINQ expressions represented by the - expression syntax in the C# language. - - - - - Converts a subset of F# quotations to a LINQ expression, for the subset of LINQ expressions represented by the - expression syntax in the C# language. - - - - - When used in a quotation, this function indicates a specific conversion - should be performed when converting the quotation to a LINQ expression. - - This function should not be called directly. - - - - - When used in a quotation, this function indicates a specific conversion - should be performed when converting the quotation to a LINQ expression. - - This function should not be called directly. - - - - - When used in a quotation, this function indicates a specific conversion - should be performed when converting the quotation to a LINQ expression. - - This function should not be called directly. - - - - - Abstract internal type - - - - Allocates a region of memory on the stack. - The number of objects of type T to allocate. - A typed pointer to the allocated memory. - - - Assigns the value into the memory location referenced by the typed native - pointer computed by adding index * sizeof<'T> to the given input pointer. - The input pointer. - The index by which to offset the pointer. - The value to assign. - - - Assigns the value into the memory location referenced by the given typed native pointer. - The input pointer. - The value to assign. - - - Dereferences the given typed native pointer. - The input pointer. - The value at the pointer address. - - - Dereferences the typed native pointer computed by adding index * sizeof<'T> to the - given input pointer. - The input pointer. - The index by which to offset the pointer. - The value at the pointer address. - - - Returns a typed native pointer by adding index * sizeof<'T> to the - given input pointer. - The input pointer. - The index by which to offset the pointer. - A typed pointer. - - - Returns a machine address for a given typed native pointer. - The input pointer. - The machine address. - - - Returns a typed native pointer for a given machine address. - The pointer address. - A typed pointer. - - - Contains operations on native pointers. Use of these operators may - result in the generation of unverifiable code. - - - Gets the raw expression associated with this type-carrying expression - - - Type-carrying quoted expressions. Expressions are generated either - by quotations in source text or programatically - - - Returns type of an expression. - - - Returns the custom attributes of an expression. - - - Builds an expression that represents a value and its associated reflected definition as a quotation - The untyped object. - The type of the object. - The definition of the value being quoted. - The resulting expression. - - - Builds an expression that represents a value and its associated reflected definition as a quotation - The value being quoted. - The definition of the value being quoted. - The resulting expression. - - - Builds an expression that represents a while loop - The predicate to control the loop iteration. - The body of the while loop. - The resulting expression. - - - Builds an expression that represents setting a mutable variable - The input variable. - The value to set. - The resulting expression. - - - Builds an expression that represents a variable - The input variable. - The resulting expression. - - - Builds an expression that represents a constant value of a particular type, arising from a variable of the given name - The untyped object. - The type of the object. - The name of the variable. - The resulting expression. - - - Builds an expression that represents a constant value, arising from a variable of the given name - The typed value. - The name of the variable. - The resulting expression. - - - Builds an expression that represents a constant value - The typed value. - The resulting expression. - - - Builds an expression that represents a constant value of a particular type - The untyped object. - The type of the object. - The resulting expression. - - - Builds an expression that represents a test of a value is of a particular union case - The expression to test. - The description of the union case. - The resulting expression. - - - Builds an expression that represents a type test. - The expression to test. - The target type. - The resulting expression. - - - Builds an expression that represents getting a field of a tuple - The input tuple. - The index of the tuple element to get. - The resulting expression. - - - Builds an expression that represents a try/with construct for exception filtering and catching. - The body of the try expression. - - - The variable to bind to a caught exception. - The expression evaluated when an exception is caught. - The resulting expression. - - - Try and find a stored reflection definition for the given method. Stored reflection - definitions are added to an F# assembly through the use of the [<ReflectedDefinition>] attribute. - The description of the method to find. - The reflection definition or None if a match could not be found. - - - Builds an expression that represents a try/finally construct - The body of the try expression. - The final part of the expression to be evaluated. - The resulting expression. - - - Format the expression as a string - Indicates if method, property, constructor and type objects should be printed in detail. If false, these are abbreviated to their name. - The formatted string. - - - Substitutes through the given expression using the given functions - to map variables to new values. The functions must give consistent results - at each application. Variable renaming may occur on the target expression - if variable capture occurs. - The function to map variables into expressions. - The expression with the given substitutions. - - - Builds an expression that represents the sequential execution of one expression followed by another - The first expression. - The second expression. - The resulting expression. - - - Permits interactive environments such as F# Interactive - to explicitly register new pickled resources that represent persisted - top level definitions. - The assembly associated with the resource. - The unique name for the resources being added. - The type definitions referenced. - The serialized resource to register with the environment. - - - Permits interactive environments such as F# Interactive - to explicitly register new pickled resources that represent persisted - top level definitions. - The assembly associated with the resource. - The unique name for the resources being added. - The serialized resource to register with the environment. - - - Builds an expression that represents a nested typed quotation literal - The expression being quoted. - The resulting expression. - - - Builds an expression that represents a nested raw quotation literal - The expression being quoted. - The resulting expression. - - - Builds an expression that represents a nested typed or raw quotation literal - The expression being quoted. - The resulting expression. - - - Builds an expression that represents writing to a static property - The description of the property. - The value to set. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents writing to a property of an object - The input object. - The description of the property. - The value to set. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents reading a static property - The description of the property. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents reading a property of an object - The input object. - The description of the property. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents the creation of a union case value - The description of the union case. - The list of arguments for the case. - The resulting expression. - - - Builds an expression that represents the creation of an F# tuple value - The list of elements of the tuple. - The resulting expression. - - - Builds record-construction expressions - The type of record. - The list of elements of the record. - The resulting expression. - - - Builds an expression that represents the invocation of an object constructor - The description of the constructor. - The list of arguments to the constructor. - The resulting expression. - - - Builds an expression that represents the creation of a delegate value for the given type - The type of delegate. - The parameters for the delegate. - The body of the function. - The resulting expression. - - - Builds an expression that represents the creation of an array value initialized with the given elements - The type for the elements of the array. - The list of elements of the array. - The resulting expression. - - - Builds recursives expressions associated with 'let rec' constructs - The list of bindings for the let expression. - The sub-expression where the bindings are in scope. - The resulting expression. - - - Builds expressions associated with 'let' constructs - The variable in the let expression. - The expression bound to the variable. - The sub-expression where the binding is in scope. - The resulting expression. - - - Builds an expression that represents the constrution of an F# function value - The parameter to the function. - The body of the function. - The resulting expression. - - - Builds 'if ... then ... else' expressions. - The condition expression. - The then sub-expression. - The else sub-expression. - The resulting expression. - - - Fetches or creates a new variable with the given name and type from a global pool of shared variables - indexed by name and type. The type is given by the expicit or inferred type parameter - The variable name. - The created of fetched typed global variable. - - - Gets the free expression variables of an expression as a list. - A sequence of the free variables in the expression. - - - Builds a 'for i = ... to ... do ...' expression that represent loops over integer ranges - The sub-expression declaring the loop variable. - The sub-expression setting the initial value of the loop variable. - The sub-expression declaring the final value of the loop variable. - The sub-expression representing the body of the loop. - The resulting expression. - - - Builds an expression that represents writing to a field of an object - The input object. - The description of the field to write to. - The value to set to the field. - The resulting expression. - - - Builds an expression that represents writing to a static field - The description of the field to write to. - The value to the set to the field. - The resulting expression. - - - Builds an expression that represents the access of a field of an object - The input object. - The description of the field to access. - The resulting expression. - - - Builds an expression that represents the access of a static field - The description of the field to access. - The resulting expression. - - - This function is called automatically when quotation syntax (<@ @>) and other sources of - quotations are used. - A type in the assembly where the quotation occurs. - The type definitions referenced. - The spliced types, to replace references to type variables. - The spliced expressions to replace references to spliced expressions. - The serialized form of the quoted expression. - The resulting expression. - - - This function is called automatically when quotation syntax (<@ @>) and other sources of - quotations are used. - A type in the assembly where the quotation occurs. - The spliced types, to replace references to type variables. - The spliced expressions to replace references to spliced expressions. - The serialized form of the quoted expression. - The resulting expression. - - - Builds an expression that represents the invocation of a default object constructor - The type on which the constructor is invoked. - The resulting expression. - - - Builds an expression that represents the coercion of an expression to a type - The expression to coerce. - The target type. - The resulting expression. - - - Returns a new typed expression given an underlying runtime-typed expression. - A type annotation is usually required to use this function, and - using an incorrect type annotation may result in a later runtime exception. - The expression to cast. - The resulting typed expression. - - - Builds an expression that represents a call to an instance method associated with an object - The input object. - The description of the method to call. - The list of arguments to the method. - The resulting expression. - - - Builds an expression that represents a call to an static method or module-bound function - The MethodInfo describing the method to call. - The list of arguments to the method. - The resulting expression. - - - Builds an expression that represents the application of a first class function value to multiple arguments - The function to apply. - The list of lists of arguments to the function. - The resulting expression. - - - Builds an expression that represents the application of a first class function value to a single argument. - The function to apply. - The argument to the function. - The resulting expression. - - - Builds an expression that represents setting the value held at a particular address. - The target expression. - The value to set at the address. - The resulting expression. - - - Builds an expression that represents getting the address of a value. - The target expression. - The resulting expression. - - - Quoted expressions annotated with System.Type values. - - - The type associated with the variable - - - The declared name of the variable - - - Indicates if the variable represents a mutable storage location - - - Fetches or create a new variable with the given name and type from a global pool of shared variables - indexed by name and type - The name of the variable. - The type associated with the variable. - The retrieved or created variable. - - - Creates a new variable with the given name, type and mutability - The declared name of the variable. - The type associated with the variable. - Indicates if the variable represents a mutable storage location. Default is false. - The created variable. - - - Information at the binding site of a variable - - - Re-build combination expressions. The first parameter should be an object - returned by the ShapeCombination case of the active pattern in this module. - The input shape. - The list of arguments. - The rebuilt expression. - - - An active pattern that performs a complete decomposition viewing the expression tree as a binding structure - The input expression. - The decomposed Var, Lambda, or ConstApp. - - - Active patterns for traversing, visiting, rebuilding and tranforming expressions in a generic way - - - An active pattern to recognize property setters that have an associated ReflectedDefinition - The description of the property. - The expression of the method definition if found, or None. - - - An active pattern to recognize property getters or values in modules that have an associated ReflectedDefinition - The description of the property. - The expression of the method definition if found, or None. - - - An active pattern to recognize methods that have an associated ReflectedDefinition - The description of the method. - The expression of the method definition if found, or None. - - - A parameterized active pattern to recognize calls to a specified function or method. - The returned elements are the optional target object (present if the target is an - instance method), the generic type instantation (non-empty if the target is a generic - instantiation), and the arguments to the function or method. - The input template expression to specify the method to call. - The optional target object (present if the target is an - instance method), the generic type instantation (non-empty if the target is a generic - instantiation), and the arguments to the function or method. - - - An active pattern to recognize constant decimal expressions - The input expression to match against. - decimal option - - - An active pattern to recognize constant unsigned int64 expressions - The input expression to match against. - uint64 option - - - An active pattern to recognize constant int64 expressions - The input expression to match against. - int64 option - - - An active pattern to recognize constant unsigned int32 expressions - The input expression to match against. - uint32 option - - - An active pattern to recognize constant int32 expressions - The input expression to match against. - int32 option - - - An active pattern to recognize constant unsigned int16 expressions - The input expression to match against. - uint16 option - - - An active pattern to recognize constant int16 expressions - The input expression to match against. - int16 option - - - An active pattern to recognize constant byte expressions - The input expression to match against. - byte option - - - An active pattern to recognize constant signed byte expressions - The input expression to match against. - sbyte option - - - An active pattern to recognize constant unicode character expressions - The input expression to match against. - char option - - - An active pattern to recognize constant 64-bit floating point number expressions - The input expression to match against. - float option - - - An active pattern to recognize constant 32-bit floating point number expressions - The input expression to match against. - float32 option - - - An active pattern to recognize constant string expressions - The input expression to match against. - string option - - - An active pattern to recognize constant boolean expressions - The input expression to match against. - bool option - - - An active pattern to recognize () constant expressions - The input expression to match against. - unit option - - - An active pattern to recognize expressions of the form a || b - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions of the form a && b - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent the application of a (possibly curried or tupled) first class function value - The input expression to match against. - (Expr * Expr list list) option - - - An active pattern to recognize expressions that represent a (possibly curried or tupled) first class function value - The input expression to match against. - (Var list list * Expr) option - - - Contains a set of derived F# active patterns to analyze F# expression objects - - - An active pattern to recognize expressions that represent setting a mutable variable - The input expression to match against. - (Var * Expr) option - - - An active pattern to recognize expressions that represent a variable - The input expression to match against. - Var option - - - An active pattern to recognize expressions that are a value with an associated definition - The input expression to match against. - The boxed value, its static type and its definition - - - An active pattern to recognize expressions that represent a constant value - The input expression to match against. - The boxed value, its static type and its name - - - An active pattern to recognize expressions that represent a constant value. This also matches expressions matched by ValueWithName. - The input expression to match against. - The boxed value and its static type - - - An active pattern to recognize expressions that represent a test if a value is of a particular union case - The input expression to match against. - The expression and union case being tested - - - An active pattern to recognize expressions that represent a dynamic type test - The input expression to match against. - The expression and type being tested - - - An active pattern to recognize expressions that represent getting a tuple field - The input expression to match against. - The expression and tuple field being accessed - - - An active pattern to recognize expressions that represent a try/finally construct - The input expression to match against. - The body and handler parts of the try/finally expression - - - An active pattern to recognize expressions that represent a try/with construct for exception filtering and catching - The input expression to match against. - (Expr * Var * Expr * Var * Expr) option - - - An active pattern to recognize expressions that represent sequential exeuction of one expression followed by another - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent a nested typed quotation literal - The input expression to match against. - Expr option - - - An active pattern to recognize expressions that represent a nested raw quotation literal - The input expression to match against. - Expr option - - - An active pattern to recognize expressions that represent a nested quotation literal - The input expression to match against. - Expr option - - - An active pattern to recognize expressions that represent setting a static or instance property, or a non-function value declared in a module - The input expression to match against. - (Expr option * PropertyInfo * Expr list * Expr) option - - - An active pattern to recognize expressions that represent the read of a static or instance property, or a non-function value declared in a module - The input expression to match against. - (Expr option * PropertyInfo * Expr list) option - - - An active pattern to recognize expressions that represent construction of tuple values - The input expression to match against. - (Expr list) option - - - An active pattern to recognize expressions that represent construction of particular union case values - The input expression to match against. - (UnionCaseInfo * Expr list) option - - - An active pattern to recognize expressions that represent construction of record values - The input expression to match against. - (Type * Expr list) option - - - An active pattern to recognize expressions that represent invocation of object constructors - The input expression to match against. - (ConstructorInfo * Expr list) option - - - An active pattern to recognize expressions that represent construction of delegate values - The input expression to match against. - (Type * Var list * Expr) option - - - An active pattern to recognize expressions that represent invocations of a default constructor of a struct - The input expression to match against. - Type option - - - An active pattern to recognize expressions that represent the construction of arrays - The input expression to match against. - (Type * Expr list) option - - - An active pattern to recognize expressions that represent recursive let bindings of one or more variables - The input expression to match against. - ((Var * Expr) list * Expr) option - - - An active pattern to recognize expressions that represent let bindings - The input expression to match against. - (Var * Expr * Expr) option - - - An active pattern to recognize expressions that represent first class function values - The input expression to match against. - (Var * Expr) option - - - An active pattern to recognize expressions that represent conditionals - The input expression to match against. - (Expr * Expr * Expr) option - - - An active pattern to recognize expressions that represent while loops - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent loops over integer ranges - The input expression to match against. - (Var * Expr * Expr * Expr) option - - - An active pattern to recognize expressions that represent setting a static or instance field - The input expression to match against. - (Expr option * FieldInfo * Expr) option - - - An active pattern to recognize expressions that represent getting a static or instance field - The input expression to match against. - (Expr option * FieldInfo) option - - - An active pattern to recognize expressions that represent coercions from one type to another - The input expression to match against. - (Expr * Type) option - - - An active pattern to recognize expressions that represent calls to static and instance methods, and functions defined in modules - The input expression to match against. - (Expr option * MethodInfo * Expr list) option - - - An active pattern to recognize expressions that represent applications of first class function values - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent setting the value held at an address - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent getting the address of a value - The input expression to match against. - Expr option - - - Contains a set of primitive F# active patterns to analyze F# expression objects - - - Returns a System.Type representing an F# tuple type with the given element types - An array of types for the tuple elements. - The type representing the tuple containing the input elements. - - - Returns a System.Type representing the F# function type with the given domain and range - The input type of the function. - The output type of the function. - The function type with the given domain and range. - - - Return true if the typ is a representation of an F# tuple type - The type to check. - True if the type check succeeds. - - - Return true if the typ is a System.Type value corresponding to the compiled form of an F# module - The type to check. - True if the type check succeeds. - - - Return true if the typ is a representation of an F# function type or the runtime type of a closure implementing an F# function type - The type to check. - True if the type check succeeds. - - - Gets the tuple elements from the representation of an F# tuple type. - The input tuple type. - An array of the types contained in the given tuple type. - - - Gets the domain and range types from an F# function type or from the runtime type of a closure implementing an F# type - The input function type. - A tuple of the domain and range types of the input function. - - - Contains operations associated with constructing and analyzing F# types such as records, unions and tuples - - - Precomputes a function for reading the values of a particular tuple type - - Assumes the given type is a TupleType. - If not, ArgumentException is raised during pre-computation. - The tuple type to read. - Thrown when the given type is not a tuple type. - A function to read values of the given tuple type. - - - Gets information that indicates how to read a field of a tuple - The input tuple type. - The index of the tuple element to describe. - The description of the tuple element and an optional type and index if the tuple is big. - - - Gets a method that constructs objects of the given tuple type. - For small tuples, no additional type will be returned. - - For large tuples, an additional type is returned indicating that - a nested encoding has been used for the tuple type. In this case - the suffix portion of the tuple type has the given type and an - object of this type must be created and passed as the last argument - to the ConstructorInfo. A recursive call to PreComputeTupleConstructorInfo - can be used to determine the constructor for that the suffix type. - The input tuple type. - The description of the tuple type constructor and an optional extra type - for large tuples. - - - Precomputes a function for reading the values of a particular tuple type - - Assumes the given type is a TupleType. - If not, ArgumentException is raised during pre-computation. - The type of tuple to read. - Thrown when the given type is not a tuple type. - A function to read a particular tuple type. - - - Precompute a function for reading a particular field from a record. - Assumes the given type is a RecordType with a field of the given name. - If not, ArgumentException is raised during pre-computation. - - Using the computed function will typically be faster than executing a corresponding call to Value.GetInfo - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The PropertyInfo of the field to read. - Thrown when the input type is not a record type. - A function to read the specified field from the record. - - - Creates an instance of a tuple type - - Assumes at least one element is given. If not, ArgumentException is raised. - The array of tuple fields. - The tuple type to create. - Thrown if no elements are given. - An instance of the tuple type with the given elements. - - - Builds a typed function from object from a dynamic function implementation - The function type of the implementation. - The untyped lambda of the function implementation. - A typed function from the given dynamic implementation. - - - Reads all fields from a tuple. - - Assumes the given input is a tuple value. If not, ArgumentException is raised. - The input tuple. - Thrown when the input is not a tuple value. - An array of the fields from the given tuple. - - - Reads a field from a tuple value. - - Assumes the given input is a tuple value. If not, ArgumentException is raised. - The input tuple. - The index of the field to read. - The value of the field. - - - Reads a field from a record value. - - Assumes the given input is a record value. If not, ArgumentException is raised. - The record object. - The PropertyInfo describing the field to read. - Thrown when the input type is not a record type. - The field from the record. - - - Contains operations associated with constructing and analyzing values associated with F# types - such as records, unions and tuples. - - - The integer tag for the case. - - - The name of the case. - - - The type in which the case occurs. - - - The fields associated with the case, represented by a PropertyInfo. - The fields associated with the case. - - - Returns the custom attributes associated with the case matching the given attribute type. - The type of attributes to return. - An array of custom attributes. - - - Returns the custom attributes associated with the case. - An array of custom attributes. - - - Represents a case of a discriminated union type - - - Returns true if the typ is a representation of an F# exception declaration - The type to check. - Optional flag that denotes accessibility of the private representation. - True if the type check is an F# exception. - - - Reads all the fields from an F# exception declaration, in declaration order - - Assumes exceptionType is an exception representation type. If not, ArgumentException is raised. - The exception type to read. - Optional flag that denotes accessibility of the private representation. - Thrown if the given type is not an exception. - An array containing the PropertyInfo of each field in the exception. - - - Returns true if the typ is a representation of an F# union type or the runtime type of a value of that type - The type to check. - Optional flag that denotes accessibility of the private representation. - True if the type check succeeds. - - - Return true if the typ is a representation of an F# record type - The type to check. - Optional flag that denotes accessibility of the private representation. - True if the type check succeeds. - - - Gets the cases of a union type. - - Assumes the given type is a union type. If not, ArgumentException is raised during pre-computation. - The input union type. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a union type. - An array of descriptions of the cases of the given union type. - - - Reads all the fields from a record value, in declaration order - - Assumes the given input is a record value. If not, ArgumentException is raised. - The input record type. - Optional flag that denotes accessibility of the private representation. - An array of descriptions of the properties of the record type. - - - Reads all the fields from a value built using an instance of an F# exception declaration - - Assumes the given input is an F# exception value. If not, ArgumentException is raised. - The exception instance. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not an F# exception. - The fields from the given exception. - - - A method that constructs objects of the given case - The description of the union case. - Optional flag that denotes accessibility of the private representation. - The description of the constructor of the given union case. - - - Precomputes a function for constructing a discriminated union value for a particular union case. - The description of the union case. - Optional flag that denotes accessibility of the private representation. - A function for constructing values of the given union case. - - - Precomputes a function for reading all the fields for a particular discriminator case of a union type - - Using the computed function will typically be faster than executing a corresponding call to GetFields - The description of the union case to read. - Optional flag that denotes accessibility of the private representation. - A function to for reading the fields of the given union case. - - - Precompute a property or static method for reading an integer representing the case tag of a union type. - The type of union to read. - Optional flag that denotes accessibility of the private representation. - The description of the union case reader. - - - Assumes the given type is a union type. - If not, ArgumentException is raised during pre-computation. - - Using the computed function is more efficient than calling GetUnionCase - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The type of union to optimize reading. - Optional flag that denotes accessibility of the private representation. - An optimized function to read the tags of the given union type. - - - Identify the union case and its fields for an object - - Assumes the given input is a union case value. If not, ArgumentException is raised. - - If the type is not given, then the runtime type of the input object is used to identify the - relevant union type. The type should always be given if the input object may be null. For example, - option values may be represented using the 'null'. - The input union case. - The union type containing the value. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a union case value. - The description of the union case and its fields. - - - Create a union case value. - The description of the union case to create. - The array of arguments to construct the given case. - Optional flag that denotes accessibility of the private representation. - The constructed union case. - - - Get a ConstructorInfo for a record type - The record type. - Optional flag that denotes accessibility of the private representation. - A ConstructorInfo for the given record type. - - - Precompute a function for constructing a record value. - - Assumes the given type is a RecordType. - If not, ArgumentException is raised during pre-computation. - The type of record to construct. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - A function to construct records of the given type. - - - Precompute a function for reading all the fields from a record. The fields are returned in the - same order as the fields reported by a call to Microsoft.FSharp.Reflection.Type.GetInfo for - this type. - - Assumes the given type is a RecordType. - If not, ArgumentException is raised during pre-computation. - - Using the computed function will typically be faster than executing a corresponding call to Value.GetInfo - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The type of record to read. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - An optimized reader for the given record type. - - - Reads all the fields from a record value. - - Assumes the given input is a record value. If not, ArgumentException is raised. - The record object. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - The array of fields from the record. - - - Creates an instance of a record type. - - Assumes the given input is a record type. - The type of record to make. - The array of values to initialize the record. - Optional flags that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - The created record. - - - - A record of options to control structural formatting. - For F# Interactive properties matching those of this value can be accessed via the 'fsi' - value. - - Floating Point format given in the same format accepted by System.Double.ToString, - e.g. f6 or g15. - - If ShowProperties is set the printing process will evaluate properties of the values being - displayed. This may cause additional computation. - - The ShowIEnumerable is set the printing process will force the evalution of IEnumerable objects - to a small, finite depth, as determined by the printing parameters. - This may lead to additional computation being performed during printing. - - <example> - From F# Interactive the default settings can be adjusted using, for example, - <pre> - open Microsoft.FSharp.Compiler.Interactive.Settings;; - setPrintWidth 120;; - </pre> - </example> - - - - - Data representing structured layouts of terms. - - - - - Convert any value to a layout using the given formatting options. The - layout can then be processed using formatting display engines such as - those in the LayoutOps module. any_to_string and output_any are - built using any_to_layout with default format options. - - - - - Ouput any value to a channel using the same set of formatting rules - as any_to_string - - - - - Convert any value to a string using a standard formatter - Data is typically formatted in a structured format, e.g. - lists are formatted using the "[1;2]" notation. - The details of the format are not specified and may change - from version to version and according to the flags given - to the F# compiler. The format is intended to be human-readable, - not machine readable. If alternative generic formats are required - you should develop your own formatter, using the code in the - implementation of this file as a starting point. - - Data from other .NET languages is formatted using a virtual - call to Object.ToString() on the boxed version of the input. - - - - - For limitting layout of list-like sequences (lists,arrays,etc). - unfold a list of items using (project and z) making layout list via itemL. - If reach maxLength (before exhausting) then truncate. - - - - - See tagL - - - - - Layout like an F# list. - - - - - Layout like an F# option. - - - - - Layout list vertically. - - - - - Layout two vertically. - - - - - Form tuple of layouts. - - - - - Wrap braces around layout. - - - - - Wrap square brackets around layout. - - - - - Wrap round brackets around Layout. - - - - - Join layouts into a list separated using the given Layout. - - - - - Join layouts into a semi-colon separated list. - - - - - Join layouts into a space separated list. - - - - - Join layouts into a comma separated list. - - - - - Join broken with ident=2 - - - - - Join broken with ident=1 - - - - - Join broken with ident=0 - - - - - Join, possible break with indent=2 - - - - - Join, possible break with indent=1 - - - - - Join, possible break with indent=0 - - - - - Join, unbreakable. - - - - - An string which is left parenthesis (no space on the right). - - - - - An string which is right parenthesis (no space on the left). - - - - - An string which requires no spaces either side. - - - - - An string leaf - - - - - An uninterpreted leaf, to be interpreted into a string - by the layout engine. This allows leaf layouts for numbers, strings and - other atoms to be customized according to culture. - - - - - Is it the empty layout? - - - - - The empty layout - - - - - A layout is a sequence of strings which have been joined together. - The strings are classified as words, separators and left and right parenthesis. - This classification determines where spaces are inserted. - A joint is either unbreakable, breakable or broken. - If a joint is broken the RHS layout occurs on the next line with optional indentation. - A layout can be squashed to for given width which forces breaks as required. - - - - - Return the given big integer - - - - - Return the negation of a big integer - - - - - Return the difference of two big integers - - - - - Return the product of big integers - - - - - Return the modulus of big integers - - - - - This operator is for consistency when this type be used from other CLI languages - - - - - This operator is for consistency when this type be used from other CLI languages - - - - - This operator is for consistency when this type be used from other CLI languages - - - - - This operator is for consistency when this type be used from other CLI languages - - - - - This operator is for consistency when this type be used from other CLI languages - - - - - Convert a big integer to a 32-bit signed integer - - - - - Convert a big integer to a 64-bit signed integer - - - - - Convert a big integer to a floating point number - - - - - This operator is for consistency when this type be used from other CLI languages - - - - - Return the ratio of two big integers - - - - - Return the sum of two big integers - - - - - Get the big integer for zero - - - - - Return the sign of a big integer: 0, +1 or -1 - - - - - Get the big integer for one - - - - - Return true if a big integer is 'zero' - - - - - Return true if a big integer is 'one' - - - - - Return n^m for two big integers - - - - - Parse a big integer from a string format - - - - - Return the greatest common divisor of two big integers - - - - - Compute the ratio and remainder of two big integers - - - - - Compute the absolute value of a big integer - - - - - Construct a BigInteger value for the given 64-bit integer - - - - - Construct a BigInteger value for the given integer - - - - - The type of arbitrary-sized integers - - - - diff --git a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45+wpa81+wp8/FSharp.Core.dll b/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45+wpa81+wp8/FSharp.Core.dll deleted file mode 100644 index dfcd950..0000000 Binary files a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45+wpa81+wp8/FSharp.Core.dll and /dev/null differ diff --git a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45+wpa81+wp8/FSharp.Core.optdata b/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45+wpa81+wp8/FSharp.Core.optdata deleted file mode 100644 index 95114af..0000000 Binary files a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45+wpa81+wp8/FSharp.Core.optdata and /dev/null differ diff --git a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45+wpa81+wp8/FSharp.Core.sigdata b/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45+wpa81+wp8/FSharp.Core.sigdata deleted file mode 100644 index 5b711ef..0000000 Binary files a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45+wpa81+wp8/FSharp.Core.sigdata and /dev/null differ diff --git a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45+wpa81+wp8/FSharp.Core.xml b/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45+wpa81+wp8/FSharp.Core.xml deleted file mode 100644 index 05c2497..0000000 --- a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45+wpa81+wp8/FSharp.Core.xml +++ /dev/null @@ -1,10918 +0,0 @@ - - -FSharp.Core - - - Gets the tail of the list, which is a list containing all the elements of the list, excluding the first element - - - Gets the number of items contained in the list - - - Gets the element of the list at the given position. - Lists are represented as linked lists so this is an O(n) operation. - The index. - The value at the given index. - - - Gets a value indicating if the list contains no entries - - - Gets the first element of the list - - - Returns an empty list of a particular type - - - Gets a slice of the list, the elements of the list from the given start index to the given end index. - The start index. - The end index. - The sub list specified by the input indices. - - - Returns a list with head as its first element and tail as its subsequent elements - A new head value for the list. - The existing list. - The list with head appended to the front of tail. - - - The type of immutable singly-linked lists. - - Use the constructors [] and :: (infix) to create values of this type, or - the notation [1;2;3]. Use the values in the List module to manipulate - values of this type, or pattern match against the values directly. - - - Lookup an element in the map. Raise KeyNotFoundException if no binding - exists in the map. - The input key. - Thrown when the key is not found. - The value mapped to the key. - - - Returns true if there are no bindings in the map. - - - The number of bindings in the map. - - - Lookup an element in the map, returning a Some value if the element is in the domain - of the map and None if not. - The input key. - The mapped value, or None if the key is not in the map. - - - Removes an element from the domain of the map. No exception is raised if the element is not present. - The input key. - The resulting map. - - - Tests if an element is in the domain of the map. - The input key. - True if the map contains the given key. - - - Returns a new map with the binding added to the given map. - The input key. - The resulting map. - - - Builds a map that contains the bindings of the given IEnumerable. - The input sequence of key/value pairs. - The resulting map. - - - Immutable maps. Keys are ordered by F# generic comparison. - - Maps based on generic comparison are efficient for small keys. They are not a suitable choice if keys are recursive data structures - or if keys require bespoke comparison semantics. - - All members of this class are thread-safe and may be used concurrently from multiple threads. - - - An abbreviation for the CLI type System.Collections.Generic.List<_> - - - Returns a new set with the elements of the second set removed from the first. - The first input set. - The second input set. - A set containing elements of the first set that are not contained in the second set. - - - Compute the union of the two sets. - The first input set. - The second input set. - The union of the two input sets. - - - Returns the lowest element in the set according to the ordering being used for the set. - - - Returns the highest element in the set according to the ordering being used for the set. - - - A useful shortcut for Set.isEmpty. See the Set module for further operations on sets. - - - The number of elements in the set - - - A useful shortcut for Set.remove. Note this operation produces a new set - and does not mutate the original set. The new set will share many storage - nodes with the original. See the Set module for further operations on sets. - The value to remove from the set. - The result set. - - - Evaluates to "true" if all elements of the second set are in the first. - The set to test against. - True if this set is a superset of otherSet. - - - Evaluates to "true" if all elements of the first set are in the second. - The set to test against. - True if this set is a subset of otherSet. - - - Evaluates to "true" if all elements of the second set are in the first, and at least - one element of the first is not in the second. - The set to test against. - True if this set is a proper superset of otherSet. - - - Evaluates to "true" if all elements of the first set are in the second, and at least - one element of the second is not in the first. - The set to test against. - True if this set is a proper subset of otherSet. - - - A useful shortcut for Set.contains. See the Set module for further operations on sets. - The value to check. - True if the set contains value. - - - A useful shortcut for Set.add. Note this operation produces a new set - and does not mutate the original set. The new set will share many storage - nodes with the original. See the Set module for further operations on sets. - The value to add to the set. - The result set. - - - Create a set containing elements drawn from the given sequence. - The input sequence. - The result set. - - - Immutable sets based on binary trees, where comparison is the - F# structural comparison function, potentially using implementations - of the IComparable interface on key values. - - See the Set module for further operations on sets. - - All members of this class are thread-safe and may be used concurrently from multiple threads. - - - An abbreviation for the type of immutable singly-linked lists. - - Use the constructors [] and :: (infix) to create values of this type, or - the notation [1;2;3]. Use the values in the List module to manipulate - values of this type, or pattern match against the values directly. - - - An abbreviation for the CLI type System.Collections.Generic.IEnumerable<_> - - - Fetches an element from a 2D array. You can also use the syntax array.[index1,index2]. - - The input array. - The index along the first dimension. - The index along the second dimension. - - The value of the array at the given index. - Thrown when the indices are negative or exceed the bounds of the array. - - - Sets the value of an element in an array. You can also use the syntax array.[index1,index2] <- value. - - The input array. - The index along the first dimension. - The index along the second dimension. - The value to set in the array. - Thrown when the indices are negative or exceed the bounds of the array. - - - Builds a new array whose elements are the same as the input array but - where a non-zero-based input array generates a corresponding zero-based - output array. - - The input array. - - The zero-based output array. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer indices passed to the - function indicates the element being transformed. - - For non-zero-based arrays the basing on an input array will be propagated to the output - array. - - A function that is applied to transform each element of the array. The two integers - provide the index of the element. - The input array. - - An array whose elements have been transformed by the given mapping. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - - A function that is applied to transform each item of the input array. - The input array. - - An array whose elements have been transformed by the given mapping. - - - Returns the length of an array in the second dimension. - - The input array. - - The length of the array in the second dimension. - - - Returns the length of an array in the first dimension. - - The input array. - - The length of the array in the first dimension. - - - Applies the given function to each element of the array. The integer indices passed to the - function indicates the index of element. - - A function to apply to each element of the array with the indices available as an argument. - The input array. - - - Applies the given function to each element of the array. - - A function to apply to each element of the array. - The input array. - - - Creates a based array where the entries are initially Unchecked.defaultof<'T>. - - The base for the first dimension of the array. - The base for the second dimension of the array. - The length of the first dimension of the array. - The length of the second dimension of the array. - - The created array. - Thrown when base1, base2, length1, or length2 is negative. - - - Creates a based array whose elements are all initially the given value. - - The base for the first dimension of the array. - The base for the second dimension of the array. - The length of the first dimension of the array. - The length of the second dimension of the array. - The value to populate the new array. - - The created array. - Thrown when base1, base2, length1, or length2 is negative. - - - Creates a based array given the dimensions and a generator function to compute the elements. - - The base for the first dimension of the array. - The base for the second dimension of the array. - The length of the first dimension of the array. - The length of the second dimension of the array. - A function to produce elements of the array given the two indices. - - The created array. - Thrown when base1, base2, length1, or length2 is negative. - - - Creates an array where the entries are initially Unchecked.defaultof<'T>. - - The length of the first dimension of the array. - The length of the second dimension of the array. - - The created array. - Thrown when length1 or length2 is negative. - - - Creates an array whose elements are all initially the given value. - - The length of the first dimension of the array. - The length of the second dimension of the array. - The value to populate the new array. - - The created array. - Thrown when length1 or length2 is negative. - - - Creates an array given the dimensions and a generator function to compute the elements. - - The length of the first dimension of the array. - The length of the second dimension of the array. - A function to produce elements of the array given the two indices. - - The generated array. - Thrown when either of the lengths is negative. - - - Reads a range of elements from the first array and write them into the second. - - The source array. - The first-dimension index to begin copying from in the source array. - The second-dimension index to begin copying from in the source array. - The target array. - The first-dimension index to begin copying into in the target array. - The second-dimension index to begin copying into in the target array. - The number of elements to copy across the first dimension of the arrays. - The number of elements to copy across the second dimension of the arrays. - Thrown when any of the indices are negative or if either of - the counts are larger than the dimensions of the array allow. - - - Builds a new array whose elements are the same as the input array. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - - The input array. - - A copy of the input array. - - - Fetches the base-index for the second dimension of the array. - - The input array. - - The base-index of the second dimension of the array. - - - Fetches the base-index for the first dimension of the array. - - The input array. - - The base-index of the first dimension of the array. - - - Basic operations on 2-dimensional arrays. - - F# and CLI multi-dimensional arrays are typically zero-based. - However, CLI multi-dimensional arrays used in conjunction with external - libraries (e.g. libraries associated with Visual Basic) be - non-zero based, using a potentially different base for each dimension. - The operations in this module will accept such arrays, and - the basing on an input array will be propagated to a matching output - array on the Array2D.map and Array2D.mapi operations. - Non-zero-based arrays can also be created using Array2D.zeroCreateBased, - Array2D.createBased and Array2D.initBased. - - - Creates an array where the entries are initially the "default" value. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The created array. - - - Sets the value of an element in an array. You can also - use the syntax 'array.[index1,index2,index3] <- value'. - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The value to set at the given index. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer indices passed to the - function indicates the element being transformed. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - The function to transform the elements at each index in the array. - The input array. - The array created from the transformed elements. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - The function to transform each element of the array. - The input array. - The array created from the transformed elements. - - - Returns the length of an array in the third dimension. - The input array. - The length of the array in the third dimension. - - - Returns the length of an array in the second dimension. - The input array. - The length of the array in the second dimension. - - - Returns the length of an array in the first dimension - The input array. - The length of the array in the first dimension. - - - Applies the given function to each element of the array. The integer indicies passed to the - function indicates the index of element. - The function to apply to each element of the array. - The input array. - - - Applies the given function to each element of the array. - The function to apply to each element of the array. - The input array. - - - Fetches an element from a 3D array. You can also use the syntax 'array.[index1,index2,index3]' - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The value at the given index. - - - Creates an array given the dimensions and a generator function to compute the elements. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The function to create an initial value at each index into the array. - The created array. - - - Creates an array whose elements are all initially the given value. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The value of the array elements. - The created array. - - - Basic operations on rank 3 arrays. - - - Sets the value of an element in an array. You can also - use the syntax 'array.[index1,index2,index3,index4] <- value'. - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The index along the fourth dimension. - The value to set. - - - Fetches an element from a 4D array. You can also use the syntax 'array.[index1,index2,index3,index4]' - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The index along the fourth dimension. - The value at the given index. - - - Creates an array where the entries are initially the "default" value. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The length of the fourth dimension. - The created array. - - - Returns the length of an array in the fourth dimension. - The input array. - The length of the array in the fourth dimension. - - - Returns the length of an array in the third dimension. - The input array. - The length of the array in the third dimension. - - - Returns the length of an array in the second dimension. - The input array. - The length of the array in the second dimension. - - - Returns the length of an array in the first dimension - The input array. - The length of the array in the first dimension. - - - Creates an array given the dimensions and a generator function to compute the elements. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The length of the fourth dimension. - The function to create an initial value at each index in the array. - The created array. - - - Creates an array whose elements are all initially the given value - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The length of the fourth dimension. - The initial value for each element of the array. - The created array. - - - Basic operations on rank 4 arrays. - - - Combines three arrays into an array of pairs. The three arrays must have equal lengths, otherwise an ArgumentException is - raised. - The first input array. - The second input array. - The third input array. - Thrown when any of the input arrays are null. - Thrown when the input arrays differ in length. - The array of tupled elements. - - - Combines the two arrays into an array of pairs. The two arrays must have equal lengths, otherwise an ArgumentException is - raised. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The array of tupled elements. - - - Returns an array of sliding windows containing elements drawn from the input - array. Each window is returned as a fresh array. - The number of elements in each window. - The input array. - The result array. - Thrown when the input array is null. - Thrown when windowSize is not positive. - - - Returns a new array containing only the elements of the array - for which the given predicate returns "true". - The function to test the input elements. - The input array. - An array containing the elements for which the given predicate returns true. - - Thrown when the input array is null. - - - Splits an array of triples into three arrays. - The input array. - The tuple of three arrays. - Thrown when the input array is null. - - - Splits an array of pairs into two arrays. - The input array. - The two arrays. - Thrown when the input array is null. - - - Returns an array that contains the elements generated by the given computation. - The given initial state argument is passed to the element generator. - A function that takes in the current state and returns an option tuple of the next - element of the array and the next state value. - The initial state value. - The result array. - - - Returns the index of the last element in the array - that satisfies the given predicate. - The function to test the input elements. - The input array. - Thrown when the input array is null. - The index of the last element that satisfies the predicate, or None. - - - Tries to find the nth element in the array. - Returns None if index is negative or the input array does not contain enough elements. - The index of element to retrieve. - The input array. - The nth element of the array or None. - Thrown when the input array is null. - - - Returns the index of the first element in the array - that satisfies the given predicate. - The function to test the input elements. - The input array. - Thrown when the input array is null. - The index of the first element that satisfies the predicate, or None. - - - Returns the last element for which the given function returns true. - Return None if no such element exists. - The function to test the input elements. - The input array. - Thrown when the input array is null. - The last element that satisfies the predicate, or None. - - - Returns the first element for which the given function returns true. - Return None if no such element exists. - The function to test the input elements. - The input array. - The first element that satisfies the predicate, or None. - Thrown when the input array is null. - - - Returns at most N elements in a new array. - The maximum number of items to return. - The input array. - The result array. - Thrown when the input array is null. - - - Views the given array as a sequence. - The input array. - The sequence of array elements. - Thrown when the input array is null. - - - Builds a list from the given array. - The input array. - The list of array elements. - Thrown when the input array is null. - - - Returns a new array containing the elements of the original except the first element. - - The input array. - Thrown when the array is empty. - Thrown when the input array is null. - A new array containing the elements of the original except the first element. - - - Returns an array that contains all elements of the original array while the - given predicate returns true, and then returns no further elements. - - A function that evaluates to false when no more items should be returned. - The input array. - - The result array. - - Thrown when the input array is null. - - - Returns the first N elements of the array. - Throws InvalidOperationException - if the count exceeds the number of elements in the array. Array.truncate - returns as many items as the array contains instead of throwing an exception. - - The number of items to take. - The input array. - - The result array. - - Thrown when the input array is null. - Thrown when the input array is empty. - Thrown when count exceeds the number of elements - in the list. - - - Returns the sum of the results generated by applying the function to each element of the array. - The function to transform the array elements into the type to be summed. - The input array. - The resulting sum. - Thrown when the input array is null. - - - Returns the sum of the elements in the array. - The input array. - The resulting sum. - Thrown when the input array is null. - - - Sorts the elements of an array, in descending order, using the given projection for the keys and returning a new array. - Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to transform array elements into the type that is compared. - The input array. - The sorted array. - - - Sorts the elements of an array, in descending order, returning a new array. Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The input array. - The sorted array. - - - Splits an array into two arrays, at the given index. - The index at which the array is split. - The input array. - The two split arrays. - - Thrown when the input array is null. - Thrown when split index exceeds the number of elements - in the array. - - - Sorts the elements of an array by mutating the array in-place, using the given comparison function. - Elements are compared using Operators.compare. - The input array. - Thrown when the input array is null. - - - Sorts the elements of an array by mutating the array in-place, using the given comparison function as the order. - The function to compare pairs of array elements. - The input array. - Thrown when the input array is null. - - - Sorts the elements of an array by mutating the array in-place, using the given projection for the keys. - Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to transform array elements into the type that is compared. - The input array. - Thrown when the input array is null. - - - Sorts the elements of an array, using the given comparison function as the order, returning a new array. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to compare pairs of array elements. - The input array. - The sorted array. - Thrown when the input array is null. - - - Sorts the elements of an array, using the given projection for the keys and returning a new array. - Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to transform array elements into the type that is compared. - The input array. - The sorted array. - Thrown when the input array is null. - - - Sorts the elements of an array, returning a new array. Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The input array. - The sorted array. - Thrown when the input array is null. - - - Builds a new array that contains the given subrange specified by - starting index and length. - The input array. - The index of the first element of the sub array. - The length of the sub array. - The created sub array. - Thrown when the input array is null. - Thrown when either startIndex or count is negative, - or when there aren't enough elements in the input array. - - - Bypasses elements in an array while the given predicate returns true, and then returns - the remaining elements in a new array. - A function that evaluates an element of the array to a boolean value. - The input array. - The created sub array. - Thrown when the input array is null. - - - Builds a new array that contains the elements of the given array, excluding the first N elements. - The number of elements to skip. - The input array. - A copy of the input array, after removing the first N elements. - Thrown when the input array is null. - Thrown when count is negative or exceeds the number of - elements in the array. - - - Sets an element of an array. - The input array. - The input index. - The input value. - Thrown when the input array is null. - Thrown when the index is negative or the input array does not contain enough elements. - - - Returns an array that contains one item only. - - The input item. - - The result array of one item. - - - Like foldBack, but return both the intermediary and final results. - The function to update the state given the input elements. - The input array. - The initial state. - The array of state values. - Thrown when the input array is null. - - - Like fold, but return the intermediary and final results. - The function to update the state given the input elements. - The initial state. - The input array. - The array of state values. - Thrown when the input array is null. - - - Returns a new array with the elements in reverse order. - The input array. - The reversed array. - Thrown when the input array is null. - - - Creates an array by replicating the given initial value. - The number of elements to replicate. - The value to replicate - The generated array. - Thrown when count is negative. - - - Applies a function to each element of the array, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f i0 (...(f iN-1 iN)). - A function that takes in the next-to-last element of the list and the - current accumulated result to produce the next accumulated result. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The final result of the reductions. - - - Applies a function to each element of the array, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f (... (f i0 i1)...) iN. - Raises ArgumentException if the array has size zero. - The function to reduce a pair of elements to a single element. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The final result of the redcutions. - - - Returns an array with all elements permuted according to the - specified permutation. - The function that maps input indices to output indices. - The input array. - The output array. - Thrown when the input array is null. - Thrown when indexMap does not produce a valid permutation. - - - Splits the collection into two collections, containing the - elements for which the given predicate returns "true" and "false" - respectively. - The function to test the input elements. - The input array. - A pair of arrays. The first containing the elements the predicate evaluated to true, - and the second containing those evaluated to false. - Thrown when the input array is null. - - - Returns an array of each element in the input array and its predecessor, with the - exception of the first element which is only returned as the predecessor of the second element. - - The input array. - - The result array. - - Thrown when the input sequence is null. - - - Builds a new array from the given enumerable object. - The input sequence. - The array of elements from the sequence. - Thrown when the input sequence is null. - - - Builds an array from the given list. - The input list. - The array of elements from the list. - - - Returns the lowest of all elements of the array, compared via Operators.min on the function result. - - Throws ArgumentException for empty arrays. - The function to transform the elements into a type supporting comparison. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The minimum element. - - - Returns the lowest of all elements of the array, compared via Operators.min. - - Throws ArgumentException for empty arrays - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The minimum element. - - - Returns the greatest of all elements of the array, compared via Operators.max on the function result. - - Throws ArgumentException for empty arrays. - The function to transform the elements into a type supporting comparison. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The maximum element. - - - Returns the greatest of all elements of the array, compared via Operators.max on the function result. - - Throws ArgumentException for empty arrays. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The maximum element. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer index passed to the - function indicates the index of element being transformed. - The function to transform elements and their indices. - The input array. - The array of transformed elements. - Thrown when the input array is null. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the two collections pairwise, also passing the index of - the elements. The two input arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to transform pairs of input elements and their indices. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The array of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding triples from the three collections. The three input - arrays must have the same length, otherwise an ArgumentException is - raised. - The function to transform the pairs of the input elements. - The first input array. - The second input array. - The third input array. - Thrown when the input arrays differ in length. - Thrown when any of the input arrays is null. - The array of transformed elements. - - - Combines map and foldBack. Builds a new array whose elements are the results of applying the given function - to each of the elements of the input array. The function is also used to accumulate a final value. - The function to transform elements from the input array and accumulate the final value. - The input array. - The initial state. - Thrown when the input array is null. - The array of transformed elements, and the final accumulated value. - - - Combines map and fold. Builds a new array whose elements are the results of applying the given function - to each of the elements of the input array. The function is also used to accumulate a final value. - The function to transform elements from the input array and accumulate the final value. - The initial state. - The input array. - Thrown when the input array is null. - The array of transformed elements, and the final accumulated value. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the two collections pairwise. The two input - arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to transform the pairs of the input elements. - The first input array. - The second input array. - Thrown when the input arrays differ in length. - Thrown when either of the input arrays is null. - The array of transformed elements. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. - The function to transform elements of the array. - The input array. - The array of transformed elements. - Thrown when the input array is null. - - - Returns the last element of the array. - Return None if no such element exists. - The input array. - The last element of the array or None. - Thrown when the input sequence is null. - - - Returns the length of an array. You can also use property arr.Length. - The input array. - The length of the array. - Thrown when the input array is null. - - - Gets an element from an array. - The input index. - The input array. - The value of the array at the given index. - Thrown when the input array is null. - Thrown when the index is negative or the input array does not contain enough elements. - - - Returns the last element of the array. - The input array. - The last element of the array. - Thrown when the input array is null. - Thrown when the input does not have any elements. - - - Applies the given function to pair of elements drawn from matching indices in two arrays, - also passing the index of the elements. The two arrays must have the same lengths, - otherwise an ArgumentException is raised. - The function to apply to each index and pair of elements. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - - - Applies the given function to each element of the array. The integer passed to the - function indicates the index of element. - The function to apply to each index and element. - The input array. - Thrown when the input array is null. - - - Applies the given function to pair of elements drawn from matching indices in two arrays. The - two arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to apply. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - - - Applies the given function to each element of the array. - The function to apply. - The input array. - Thrown when the input array is null. - - - Returns true if the given array is empty, otherwise false. - The input array. - True if the array is empty. - Thrown when the input array is null. - - - Creates an array where the entries are initially the default value Unchecked.defaultof<'T>. - The length of the array to create. - The created array. - Thrown when count is negative. - - - Creates an array given the dimension and a generator function to compute the elements. - The number of elements to initialize. - The function to generate the initial values for each index. - The created array. - Thrown when count is negative. - - - Builds a new array whose elements are the corresponding elements of the input array - paired with the integer index (from 0) of each element. - The input array. - The array of indexed elements. - Thrown when the input array is null. - - - Applies a key-generating function to each element of an array and yields an array of - unique keys. Each unique key contains an array of all elements that match - to this key. - - A function that transforms an element of the array into a comparable key. - The input array. - - The result array. - - Thrown when the input array is null. - - - Returns the first element of the array. - - The input array. - - The first element of the array. - - Thrown when the input array is null. - Thrown when the input array is empty. - - - Gets an element from an array. - The input array. - The input index. - The value of the array at the given index. - Thrown when the input array is null. - Thrown when the index is negative or the input array does not contain enough elements. - - - Apply a function to pairs of elements drawn from the two collections, right-to-left, - threading an accumulator argument through the computation. The two input - arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to update the state given the input elements. - The first input array. - The second input array. - The initial state. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The final state. - - - Applies a function to pairs of elements drawn from the two collections, - left-to-right, threading an accumulator argument - through the computation. The two input - arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to update the state given the input elements. - The initial state. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The final state. - - - Applies a function to each element of the array, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then computes - f i0 (...(f iN s)) - The function to update the state given the input elements. - The input array. - The initial state. - The state object after the folding function is applied to each element of the array. - Thrown when the input array is null. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then computes - f (... (f s i0)...) iN - The function to update the state given the input elements. - The initial state. - The input array. - The final state. - Thrown when the input array is null. - - - Tests if all corresponding elements of the array satisfy the given predicate pairwise. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns false then the overall result is - false and no further elements are tested. Otherwise, if one collection is longer - than the other then the ArgumentException exception is raised. - Otherwise, true is returned. - The function to test the input elements. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - True if all of the array elements satisfy the predicate. - - - Tests if all elements of the array satisfy the given predicate. - - The predicate is applied to the elements of the input collection. If any application - returns false then the overall result is false and no further elements are tested. - Otherwise, true is returned. - The function to test the input elements. - The input array. - True if all of the array elements satisfy the predicate. - Thrown when the input array is null. - - - Returns the index of the last element in the array - that satisfies the given predicate. Raise KeyNotFoundException if - none of the elements satisfy the predicate. - The function to test the input elements. - The input array. - Thrown if predicate - never returns true. - Thrown when the input array is null. - The index of the last element in the array that satisfies the given predicate. - - - Returns the index of the first element in the array - that satisfies the given predicate. Raise KeyNotFoundException if - none of the elements satisfy the predicate. - The function to test the input elements. - The input array. - Thrown if predicate - never returns true. - Thrown when the input array is null. - The index of the first element in the array that satisfies the given predicate. - - - Returns the last element for which the given function returns 'true'. - Raise KeyNotFoundException if no such element exists. - The function to test the input elements. - The input array. - Thrown if predicate - never returns true. - Thrown when the input array is null. - The last element for which predicate returns true. - - - Returns the first element for which the given function returns 'true'. - Raise KeyNotFoundException if no such element exists. - The function to test the input elements. - The input array. - Thrown when the input array is null. - Thrown if predicate - never returns true. - The first element for which predicate returns true. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true". - The function to test the input elements. - The input array. - An array containing the elements for which the given predicate returns true. - Thrown when the input array is null. - - - Tests if any pair of corresponding elements of the arrays satisfies the given predicate. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns true then the overall result is - true and no further elements are tested. Otherwise, if one collections is longer - than the other then the ArgumentException exception is raised. - Otherwise, false is returned. - The function to test the input elements. - The first input array. - The second input array. - True if any result from predicate is true. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - - - Tests if any element of the array satisfies the given predicate. - - The predicate is applied to the elements of the input array. If any application - returns true then the overall result is true and no further elements are tested. - Otherwise, false is returned. - The function to test the input elements. - The input array. - True if any result from predicate is true. - Thrown when the input array is null. - - - Returns a new list with the distinct elements of the input array which do not appear in the itemsToExclude sequence, - using generic hash and equality comparisons to compare values. - - A sequence whose elements that also occur in the input array will cause those elements to be - removed from the result. - An array whose elements that are not also in itemsToExclude will be returned. - - An array that contains the distinct elements of array that do not appear in itemsToExclude. - - Thrown when either itemsToExclude or array is null. - - - Returns the only element of the array. - - The input array. - - The only element of the array. - - Thrown when the input array is null. - Thrown when the input does not have precisely one element. - - - Returns an empty array of the given type. - The empty array. - - - Splits the input array into at most count chunks. - The maximum number of chunks. - The input array. - The array split into chunks. - Thrown when the input array is null. - Thrown when count is not positive. - - - Returns an array that contains no duplicate entries according to the - generic hash and equality comparisons on the keys returned by the given key-generating function. - If an element occurs multiple times in the array then the later occurrences are discarded. - - A function transforming the array items into comparable keys. - The input array. - - The result array. - - Thrown when the input array is null. - - - Returns an array that contains no duplicate entries according to generic hash and - equality comparisons on the entries. - If an element occurs multiple times in the array then the later occurrences are discarded. - - The input array. - - The result array. - - Thrown when the input array is null. - - - Divides the input array into chunks of size at most chunkSize. - The maximum size of each chunk. - The input array. - The array divided into chunks. - Thrown when the input array is null. - Thrown when chunkSize is not positive. - - - Applies the given function to each element of the array. Returns - the array comprised of the results "x" for each element where - the function returns Some(x) - The function to generate options from the elements. - The input array. - The array of results. - Thrown when the input array is null. - - - Applies the given function to successive elements, returning the first - result where function returns Some(x) for some x. If the function - never returns Some(x) then KeyNotFoundException is raised. - The function to generate options from the elements. - The input array. - Thrown when the input array is null. - Thrown if every result from - chooser is None. - The first result. - - - Fills a range of elements of the array with the given value. - The target array. - The index of the first element to set. - The number of elements to set. - The value to set. - Thrown when the input array is null. - Thrown when either targetIndex or count is negative. - - - Applies the given function to successive elements, returning the first - result where function returns Some(x) for some x. If the function - never returns Some(x) then None is returned. - The function to transform the array elements into options. - The input array. - The first transformed element that is Some(x). - Thrown when the input array is null. - - - Returns the first element of the array, or - None if the array is empty. - The input array. - Thrown when the input array is null. - The first element of the array or None. - - - Creates an array whose elements are all initially the given value. - The length of the array to create. - The value for the elements. - The created array. - Thrown when count is negative. - - - Applies a key-generating function to each element of an array and returns an array yielding unique - keys and their number of occurrences in the original array. - - A function transforming each item of the input array into a key to be - compared against the others. - The input array. - - The result array. - - Thrown when the input array is null. - - - Builds a new array that contains the elements of the given array. - The input array. - A copy of the input array. - Thrown when the input array is null. - - - Tests if the array contains the specified element. - The value to locate in the input array. - The input array. - True if the input array contains the specified element; false otherwise. - Thrown when the input array is null. - - - Builds a new array that contains the elements of each of the given sequence of arrays. - The input sequence of arrays. - The concatenation of the sequence of input arrays. - Thrown when the input sequence is null. - - - Compares two arrays using the given comparison function, element by element. - Returns the first non-zero result from the comparison function. If the end of an array - is reached it returns a -1 if the first array is shorter and a 1 if the second array - is shorter. - - A function that takes an element from each array and returns an int. - If it evaluates to a non-zero value iteration is stopped and that value is returned. - The first input array. - The second input array. - - The first non-zero value from the comparison function. - - Thrown when either of the input arrays - is null. - - - For each element of the array, applies the given function. Concatenates all the results and return the combined array. - The function to create sub-arrays from the input array elements. - The input array. - The concatenation of the sub-arrays. - Thrown when the input array is null. - - - Reads a range of elements from the first array and write them into the second. - The source array. - The starting index of the source array. - The target array. - The starting index of the target array. - The number of elements to copy. - Thrown when either of the input arrays is null. - Thrown when any of sourceIndex, targetIndex or count are negative, - or when there aren't enough elements in source or target. - - - Returns the average of the elements generated by applying the function to each element of the array. - The function to transform the array elements before averaging. - The input array. - Thrown when array is empty. - The computed average. - Thrown when the input array is null. - - - Returns the average of the elements in the array. - The input array. - Thrown when array is empty. - The average of the elements in the array. - Thrown when the input array is null. - - - Builds a new array that contains the elements of the first array followed by the elements of the second array. - The first input array. - The second input array. - The resulting array. - Thrown when either of the input arrays is null. - - - Basic operations on arrays. - - - Compare using the given comparer function. - A function to compare two values. - An object implementing IComparer using the supplied comparer. - - - Non-structural comparison. Compare using NonStructuralComparison.compare. - - - Structural comparison. Compare using Operators.compare. - - - Common notions of comparison identity used with sorted data structures. - - - Hash using the given hashing and equality functions. - A function to generate a hash code from a value. - A function to test equality of two values. - An object implementing IEqualityComparer using the supplied functions. - - - Physical hashing (hash on reference identity of objects, and the contents of value types). - Hash using LanguagePrimitives.PhysicalEquality and LanguagePrimitives.PhysicalHash, - That is, for value types use GetHashCode and Object.Equals (if no other optimization available), - and for reference types use System.Runtime.CompilerServices.RuntimeHelpers.GetHashCode and - reference equality. - - - Non-structural hashing. Equality using NonStructuralComparison.(=) and NonStructuralComparison.hash. - - - Structural hashing. Hash using Operators.(=) and Operators.hash. - - - Common notions of value identity used with hash tables. - - - Combines the three lists into a list of triples. The lists must have equal lengths. - The first input list. - The second input list. - The third input list. - A single list containing triples of matching elements from the input lists. - - - Combines the two lists into a list of pairs. The two lists must have equal lengths. - The first input list. - The second input list. - A single list containing pairs of matching elements from the input lists. - - - Returns a list of sliding windows containing elements drawn from the input - list. Each window is returned as a fresh list. - The number of elements in each window. - The input list. - The result list. - Thrown when windowSize is not positive. - - - Returns a new list containing only the elements of the list - for which the given predicate returns "true" - The function to test the input elements. - The input list. - A list containing only the elements that satisfy the predicate. - - - Splits a list of triples into three lists. - The input list. - Three lists of split elements. - - - Splits a list of pairs into two lists. - The input list. - Two lists of split elements. - - - Returns a list that contains the elements generated by the given computation. - The given initial state argument is passed to the element generator. - A function that takes in the current state and returns an option tuple of the next - element of the list and the next state value. - The initial state value. - The result list. - - - Returns the index of the last element in the list - that satisfies the given predicate. - Return None if no such element exists. - The function to test the input elements. - The input list. - The index of the last element for which the predicate returns true, or None if - every element evaluates to false. - - - Tries to find the nth element in the list. - Returns None if index is negative or the list does not contain enough elements. - The index to retrieve. - The input list. - The value at the given index or None. - - - Returns the index of the first element in the list - that satisfies the given predicate. - Return None if no such element exists. - The function to test the input elements. - The input list. - The index of the first element for which the predicate returns true, or None if - every element evaluates to false. - - - Returns the last element for which the given function returns true.. - Return None if no such element exists. - The function to test the input elements. - The input list. - The last element for which the predicate returns true, or None if - every element evaluates to false. - - - Returns the first element for which the given function returns true.. - Return None if no such element exists. - The function to test the input elements. - The input list. - The first element for which the predicate returns true, or None if - every element evaluates to false. - - - Applies the given function to successive elements, returning Some(x) the first - result where function returns Some(x) for some x. If no such element - exists then return None. - The function to generate options from the elements. - The input list. - The first resulting value or None. - - - Returns at most N elements in a new list. - The maximum number of items to return. - The input list. - The result list. - - - Returns the first element of the list, or - None if the list is empty. - The input list. - The first element of the list or None. - - - Views the given list as a sequence. - The input list. - The sequence of elements in the list. - - - Builds an array from the given list. - The input list. - The array containing the elements of the list. - - - Returns a list that contains all elements of the original list while the - given predicate returns true, and then returns no further elements. - - A function that evaluates to false when no more items should be returned. - The input list. - - The result list. - - - Returns the first N elements of the list. - Throws InvalidOperationException - if the count exceeds the number of elements in the list. List.truncate - returns as many items as the list contains instead of throwing an exception. - - The number of items to take. - The input list. - - The result list. - - Thrown when the input list is empty. - Thrown when count exceeds the number of elements - in the list. - - - Returns the list after removing the first element. - - The input list. - Thrown when the list is empty. - The list after removing the first element. - - - Returns the sum of the results generated by applying the function to each element of the list. - The function to transform the list elements into the type to be summed. - The input list. - The resulting sum. - - - Returns the sum of the elements in the list. - The input list. - The resulting sum. - - - Sorts the given list in descending order using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The input list. - The sorted list. - - - Sorts the given list in descending order using keys given by the given projection. Keys are compared using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The function to transform the list elements into the type to be compared. - The input list. - The sorted list. - - - Splits a list into two lists, at the given index. - The index at which the list is split. - The input list. - The two split lists. - - Thrown when split index exceeds the number of elements - in the list. - - - Sorts the given list using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The input list. - The sorted list. - - - Sorts the given list using keys given by the given projection. Keys are compared using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The function to transform the list elements into the type to be compared. - The input list. - The sorted list. - - - Sorts the given list using the given comparison function. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The function to compare the list elements. - The input list. - The sorted list. - - - Bypasses elements in a list while the given predicate returns true, and then returns - the remaining elements of the list. - A function that evaluates an element of the list to a boolean value. - The input list. - The result list. - - - Returns the list after removing the first N elements. - The number of elements to skip. - The input list. - The list after removing the first N elements. - Thrown when count is negative or exceeds the number of - elements in the list. - - - Returns a list that contains one item only. - - The input item. - - The result list of one item. - - - Like foldBack, but returns both the intermediary and final results - The function to update the state given the input elements. - The input list. - The initial state. - The list of states. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. Take the second argument, and apply the function to it - and the first element of the list. Then feed this result into the function along - with the second element and so on. Returns the list of intermediate results and the final result. - The function to update the state given the input elements. - The initial state. - The input list. - The list of states. - - - Returns a new list with the elements in reverse order. - The input list. - The reversed list. - - - Creates a list by replicating the given initial value. - The number of elements to replicate. - The value to replicate - The generated list. - - - Applies a function to each element of the collection, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then computes - f i0 (...(f iN-1 iN)). - A function that takes in the next-to-last element of the list and the - current accumulated result to produce the next accumulated result. - The input list. - Thrown when the list is empty. - The final result of the reductions. - - - Apply a function to each element of the collection, threading an accumulator argument - through the computation. Apply the function to the first two elements of the list. - Then feed this result into the function along with the third element and so on. - Return the final result. If the input function is f and the elements are i0...iN then computes - f (... (f i0 i1) i2 ...) iN. - - Raises System.ArgumentException if list is empty - The function to reduce two list elements to a single element. - The input list. - Thrown when the list is empty. - The final reduced value. - - - Returns a list with all elements permuted according to the - specified permutation. - The function to map input indices to output indices. - The input list. - The permuted list. - Thrown when indexMap does not produce a valid permutation. - - - Applies the given function to successive elements, returning the first - result where function returns Some(x) for some x. If no such - element exists then raise System.Collections.Generic.KeyNotFoundException - The function to generate options from the elements. - The input list. - Thrown when the list is empty. - The first resulting value. - - - Splits the collection into two collections, containing the - elements for which the given predicate returns true and false - respectively. Element order is preserved in both of the created lists. - The function to test the input elements. - The input list. - A list containing the elements for which the predicate evaluated to false and a list - containing the elements for which the predicate evaluated to true. - - - Returns a list of each element in the input list and its predecessor, with the - exception of the first element which is only returned as the predecessor of the second element. - - The input list. - - The result list. - - - Builds a new list from the given enumerable object. - The input sequence. - The list of elements from the sequence. - - - Builds a list from the given array. - The input array. - The list of elements from the array. - - - Indexes into the list. The first element has index 0. - The input list. - The index to retrieve. - The value at the given index. - Thrown when the index is negative or the input list does not contain enough elements. - - - Returns the lowest of all elements of the list, compared via Operators.min on the function result - - Raises System.ArgumentException if list is empty. - The function to transform list elements into the type to be compared. - The input list. - Thrown when the list is empty. - The minimum value. - - - Returns the lowest of all elements of the list, compared via Operators.min. - - Raises System.ArgumentException if list is empty - The input list. - Thrown when the list is empty. - The minimum value. - - - Returns the greatest of all elements of the list, compared via Operators.max on the function result. - - Raises System.ArgumentException if list is empty. - The function to transform the list elements into the type to be compared. - The input list. - Thrown when the list is empty. - The maximum element. - - - Return the greatest of all elements of the list, compared via Operators.max. - - Raises System.ArgumentException if list is empty - The input list. - Thrown when the list is empty. - The maximum element. - - - Like mapi, but mapping corresponding elements from two lists of equal length. - The function to transform pairs of elements from the two lists and their index. - The first input list. - The second input list. - The list of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The integer index passed to the - function indicates the index (from 0) of element being transformed. - The function to transform elements and their indices. - The input list. - The list of transformed elements. - - - Combines map and foldBack. Builds a new list whose elements are the results of applying the given function - to each of the elements of the input list. The function is also used to accumulate a final value. - The function to transform elements from the input list and accumulate the final value. - The input list. - The initial state. - The list of transformed elements, and the final accumulated value. - - - Combines map and fold. Builds a new list whose elements are the results of applying the given function - to each of the elements of the input list. The function is also used to accumulate a final value. - The function to transform elements from the input list and accumulate the final value. - The initial state. - The input list. - The list of transformed elements, and the final accumulated value. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the three collections simultaneously. - The function to transform triples of elements from the input lists. - The first input list. - The second input list. - The third input list. - The list of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the two collections pairwise. - The function to transform pairs of elements from the input lists. - The first input list. - The second input list. - The list of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. - The function to transform elements from the input list. - The input list. - The list of transformed elements. - - - Returns the last element of the list. - Return None if no such element exists. - The input list. - The last element of the list or None. - - - Returns the length of the list. - The input list. - The length of the list. - - - Returns the last element of the list. - The input list. - The last element of the list. - Thrown when the input does not have any elements. - - - Applies the given function to two collections simultaneously. The - collections must have identical size. The integer passed to the - function indicates the index of element. - The function to apply to a pair of elements from the input lists along with their index. - The first input list. - The second input list. - - - Applies the given function to each element of the collection. The integer passed to the - function indicates the index of element. - The function to apply to the elements of the list along with their index. - The input list. - - - Applies the given function to two collections simultaneously. The - collections must have identical size. - The function to apply to pairs of elements from the input lists. - The first input list. - The second input list. - - - Applies the given function to each element of the collection. - The function to apply to elements from the input list. - The input list. - - - Indexes into the list. The first element has index 0. - The index to retrieve. - The input list. - The value at the given index. - Thrown when the index is negative or the input list does not contain enough elements. - - - Returns true if the list contains no elements, false otherwise. - The input list. - True if the list is empty. - - - Creates a list by calling the given generator on each index. - The length of the list to generate. - The function to generate an element from an index. - The list of generated elements. - - - Returns a new list whose elements are the corresponding elements - of the input list paired with the index (from 0) of each element. - The input list. - The list of indexed elements. - - - Returns the first element of the list. - - The input list. - Thrown when the list is empty. - The first element of the list. - - - Applies a key-generating function to each element of a list and yields a list of - unique keys. Each unique key contains a list of all elements that match - to this key. - - A function that transforms an element of the list into a comparable key. - The input list. - - The result list. - - - Tests if all corresponding elements of the collection satisfy the given predicate pairwise. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns false then the overall result is - false and no further elements are tested. Otherwise, if one collection is longer - than the other then the System.ArgumentException exception is raised. - Otherwise, true is returned. - The function to test the input elements. - The first input list. - The second input list. - Thrown when the input lists differ in length. - True if all of the pairs of elements satisfy the predicate. - - - Tests if all elements of the collection satisfy the given predicate. - - The predicate is applied to the elements of the input list. If any application - returns false then the overall result is false and no further elements are tested. - Otherwise, true is returned. - The function to test the input elements. - The input list. - True if all of the elements satisfy the predicate. - - - Applies a function to corresponding elements of two collections, threading an accumulator argument - through the computation. The collections must have identical sizes. - If the input function is f and the elements are i0...iN and j0...jN - then computes f i0 j0 (...(f iN jN s)). - The function to update the state given the input elements. - The first input list. - The second input list. - The initial state. - The final state value. - - - Applies a function to each element of the collection, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then - computes f i0 (...(f iN s)). - The function to update the state given the input elements. - The input list. - The initial state. - The state object after the folding function is applied to each element of the list. - - - Applies a function to corresponding elements of two collections, threading an accumulator argument - through the computation. The collections must have identical sizes. - If the input function is f and the elements are i0...iN and j0...jN - then computes f (... (f s i0 j0)...) iN jN. - The function to update the state given the input elements. - The initial state. - The first input list. - The second input list. - The final state value. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. Take the second argument, and apply the function to it - and the first element of the list. Then feed this result into the function along - with the second element and so on. Return the final result. - If the input function is f and the elements are i0...iN then - computes f (... (f s i0) i1 ...) iN. - The function to update the state given the input elements. - The initial state. - The input list. - The final state value. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true" - The function to test the input elements. - The input list. - A list containing only the elements that satisfy the predicate. - - - Returns the index of the last element in the list - that satisfies the given predicate. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for all the - elements of the list. - The index of the last element that satisfies the predicate. - - - Returns the index of the first element in the list - that satisfies the given predicate. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for all the - elements of the list. - The index of the first element that satisfies the predicate. - - - Returns the last element for which the given function returns true. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for - all the elements of the list. - The last element that satisfies the predicate. - - - Returns the first element for which the given function returns true. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for - all the elements of the list. - The first element that satisfies the predicate. - - - Tests if any pair of corresponding elements of the lists satisfies the given predicate. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns true then the overall result is - true and no further elements are tested. Otherwise, if one collections is longer - than the other then the System.ArgumentException exception is raised. - Otherwise, false is returned. - The function to test the input elements. - The first input list. - The second input list. - Thrown when the input lists differ in length. - True if any pair of elements satisfy the predicate. - - - Tests if any element of the list satisfies the given predicate. - - The predicate is applied to the elements of the input list. If any application - returns true then the overall result is true and no further elements are tested. - Otherwise, false is returned. - The function to test the input elements. - The input list. - True if any element satisfies the predicate. - - - Returns the only element of the list. - - The input list. - - The only element of the list. - - Thrown when the input does not have precisely one element. - - - Returns a new list with the distinct elements of the input list which do not appear in the itemsToExclude sequence, - using generic hash and equality comparisons to compare values. - - A sequence whose elements that also occur in the input list will cause those elements to be - removed from the result. - A list whose elements that are not also in itemsToExclude will be returned. - - A list that contains the distinct elements of list that do not appear in itemsToExclude. - - Thrown when itemsToExclude is null. - - - Returns an empty list of the given type. - - - Splits the input list into at most count chunks. - The maximum number of chunks. - The input list. - The list split into chunks. - Thrown when count is not positive. - - - Applies a key-generating function to each element of a list and returns a list yielding unique - keys and their number of occurrences in the original list. - - A function transforming each item of the input list into a key to be - compared against the others. - The input list. - - The result list. - - - Returns a list that contains no duplicate entries according to the - generic hash and equality comparisons on the keys returned by the given key-generating function. - If an element occurs multiple times in the list then the later occurrences are discarded. - - A function transforming the list items into comparable keys. - The input list. - - The result list. - - - Returns a list that contains no duplicate entries according to generic hash and - equality comparisons on the entries. - If an element occurs multiple times in the list then the later occurrences are discarded. - - The input list. - - The result list. - - - Tests if the list contains the specified element. - The value to locate in the input list. - The input list. - True if the input list contains the specified element; false otherwise. - - - Returns a new list that contains the elements of each the lists in order. - The input sequence of lists. - The resulting concatenated list. - - - Compares two lists using the given comparison function, element by element. - Returns the first non-zero result from the comparison function. If the end of a list - is reached it returns a -1 if the first list is shorter and a 1 if the second list - is shorter. - - A function that takes an element from each list and returns an int. - If it evaluates to a non-zero value iteration is stopped and that value is returned. - The first input list. - The second input list. - - The first non-zero value from the comparison function. - - - For each element of the list, applies the given function. Concatenates all the results and return the combined list. - The function to transform each input element into a sublist to be concatenated. - The input list. - The concatenation of the transformed sublists. - - - Divides the input list into chunks of size at most chunkSize. - The maximum size of each chunk. - The input list. - The list divided into chunks. - Thrown when chunkSize is not positive. - - - Applies the given function to each element of the list. Returns - the list comprised of the results x for each element where - the function returns Some(x) - The function to generate options from the elements. - The input list. - The list comprising the values selected from the chooser function. - - - Returns the average of the elements generated by applying the function to each element of the list. - - Raises System.ArgumentException if list is empty. - The function to transform the list elements into the type to be averaged. - The input list. - Thrown when the list is empty. - The resulting average. - - - Returns the average of the elements in the list. - - Raises System.ArgumentException if list is empty. - The input list. - Thrown when the list is empty. - The resulting average. - - - Returns a new list that contains the elements of the first list - followed by elements of the second. - The first input list. - The second input list. - The resulting list. - - - Basic operations on lists. - - - Returns the key of the first mapping in the collection that satisfies the given predicate. - Returns 'None' if no such element exists. - The function to test the input elements. - The input map. - The first key for which the predicate returns true or None if the predicate evaluates to false for each key/value pair. - - - Evaluates the function on each mapping in the collection. Returns the key for the first mapping - where the function returns 'true'. Raise KeyNotFoundException if no such element exists. - The function to test the input elements. - The input map. - Thrown if the key does not exist in the map. - The first key for which the predicate evaluates true. - - - Lookup an element in the map, returning a Some value if the element is in the domain - of the map and None if not. - The input key. - The input map. - The found Some value or None. - - - Removes an element from the domain of the map. No exception is raised if the element is not present. - The input key. - The input map. - The resulting map. - - - Builds two new maps, one containing the bindings for which the given predicate returns 'true', - and the other the remaining bindings. - The function to test the input elements. - The input map. - A pair of maps in which the first contains the elements for which the predicate returned true - and the second containing the elements for which the predicated returned false. - - - Tests if an element is in the domain of the map. - The input key. - The input map. - True if the map contains the key. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The key passed to the - function indicates the key of element being transformed. - The function to transform the key/value pairs. - The input map. - The resulting map of keys and transformed values. - - - Returns true if the given predicate returns true for all of the - bindings in the map. - The function to test the input elements. - The input map. - True if the predicate evaluates to true for all of the bindings in the map. - - - Builds a new map containing only the bindings for which the given predicate returns 'true'. - The function to test the key/value pairs. - The input map. - The filtered map. - - - Returns true if the given predicate returns true for one of the - bindings in the map. - The function to test the input elements. - The input map. - True if the predicate returns true for one of the key/value pairs. - - - Applies the given function to each binding in the dictionary - The function to apply to each key/value pair. - The input map. - - - Folds over the bindings in the map - The function to update the state given the input key/value pairs. - The initial state. - The input map. - The final state value. - - - Folds over the bindings in the map. - The function to update the state given the input key/value pairs. - The input map. - The initial state. - The final state value. - - - Searches the map looking for the first element where the given function returns a Some value - The function to generate options from the key/value pairs. - The input map. - The first result. - - - Searches the map looking for the first element where the given function returns a Some value. - The function to generate options from the key/value pairs. - The input map. - The first result. - - - Lookup an element in the map, raising KeyNotFoundException if no binding - exists in the map. - The input key. - The input map. - Thrown when the key does not exist in the map. - The value mapped to the given key. - - - The empty map. - - - Is the map empty? - The input map. - True if the map is empty. - - - Returns an array of all key-value pairs in the mapping. - The array will be ordered by the keys of the map. - The input map. - The array of key/value pairs. - - - Returns a list of all key-value pairs in the mapping. - The list will be ordered by the keys of the map. - The input map. - The list of key/value pairs. - - - Views the collection as an enumerable sequence of pairs. - The sequence will be ordered by the keys of the map. - The input map. - The sequence of key/value pairs. - - - Returns a new map made from the given bindings. - The input sequence of key/value pairs. - The resulting map. - - - Returns a new map made from the given bindings. - The input array of key/value pairs. - The resulting map. - - - Returns a new map made from the given bindings. - The input list of key/value pairs. - The resulting map. - - - Returns a new map with the binding added to the given map. - The input key. - The input value. - The input map. - The resulting map. - - - Functional programming operators related to the Map<_,_> type. - - - Combines the three sequences into a list of triples. The sequences need not have equal lengths: - when one sequence is exhausted any remaining elements in the other - sequences are ignored. - - The first input sequence. - The second input sequence. - The third input sequence. - - The result sequence. - - Thrown when any of the input sequences is null. - - - Combines the two sequences into a list of pairs. The two sequences need not have equal lengths: - when one sequence is exhausted any remaining elements in the other - sequence are ignored. - - The first input sequence. - The second input sequence. - - The result sequence. - - Thrown when either of the input sequences is null. - - - Returns a sequence that yields sliding windows containing elements drawn from the input - sequence. Each window is returned as a fresh array. - The number of elements in each window. - The input sequence. - The result sequence. - Thrown when the input sequence is null. - Thrown when windowSize is not positive. - - - Returns a sequence that contains the elements generated by the given computation. - The given initial state argument is passed to the element generator. - For each IEnumerator elements in the stream are generated on-demand by applying the element - generator, until a None value is returned by the element generator. Each call to the element - generator returns a new residual state. - - The stream will be recomputed each time an IEnumerator is requested and iterated for the Seq. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - A function that takes in the current state and returns an option tuple of the next - element of the sequence and the next state value. - The initial state value. - - The result sequence. - - - Returns a sequence that when enumerated returns at most N elements. - - The maximum number of items to enumerate. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Applies the given function to successive elements, returning the first - result where the function returns "Some(x)". - - A function that transforms items from the input sequence into options. - The input sequence. - - The chosen element or None. - - Thrown when the input sequence is null. - - - Returns the index of the last element in the sequence - that satisfies the given predicate. Return None if no such element exists. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - The found index or None. - Thrown when the input sequence is null. - - - Tries to find the nth element in the sequence. - Returns None if index is negative or the input sequence does not contain enough elements. - The index of element to retrieve. - The input sequence. - The nth element of the sequence or None. - Thrown when the input sequence is null. - - - Returns the index of the first element in the sequence - that satisfies the given predicate. Return None if no such element exists. - - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - - The found index or None. - - Thrown when the input sequence is null. - - - Returns the last element for which the given function returns true. - Return None if no such element exists. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - The found element or None. - Thrown when the input sequence is null. - - - Returns the first element for which the given function returns true. - Return None if no such element exists. - - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - - The found element or None. - - Thrown when the input sequence is null. - - - Builds a list from the given collection. - - The input sequence. - - The result list. - - Thrown when the input sequence is null. - - - Builds an array from the given collection. - - The input sequence. - - The result array. - - Thrown when the input sequence is null. - - - Returns a sequence that, when iterated, yields elements of the underlying sequence while the - given predicate returns true, and then returns no further elements. - - A function that evaluates to false when no more items should be returned. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns the first N elements of the sequence. - Throws InvalidOperationException - if the count exceeds the number of elements in the sequence. Seq.truncate - returns as many items as the sequence contains instead of throwing an exception. - - The number of items to take. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - Thrown when count exceeds the number of elements - in the sequence. - - - Returns a sequence that skips 1 element of the underlying sequence and then yields the - remaining elements of the sequence. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the sum of the results generated by applying the function to each element of the sequence. - The generated elements are summed using the + operator and Zero property associated with the generated type. - - A function to transform items from the input sequence into the type that will be summed. - The input sequence. - - The computed sum. - - - Returns the sum of the elements in the sequence. - - The elements are summed using the + operator and Zero property associated with the generated type. - - The input sequence. - - The computed sum. - - - Applies a key-generating function to each element of a sequence and yield a sequence ordered - descending by keys. The keys are compared using generic comparison as implemented by Operators.compare. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - A function to transform items of the input sequence into comparable keys. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Yields a sequence ordered descending by keys. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Applies a key-generating function to each element of a sequence and yield a sequence ordered - by keys. The keys are compared using generic comparison as implemented by Operators.compare. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - A function to transform items of the input sequence into comparable keys. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Yields a sequence ordered using the given comparison function. - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - The function to compare the collection elements. - The input sequence. - The result sequence. - - - Yields a sequence ordered by keys. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that, when iterated, skips elements of the underlying sequence while the - given predicate returns true, and then yields the remaining elements of the sequence. - - A function that evaluates an element of the sequence to a boolean value. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that skips N elements of the underlying sequence and then yields the - remaining elements of the sequence. - - The number of items to skip. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when count exceeds the number of elements - in the sequence. - - - Returns a sequence that yields one item only. - - The input item. - - The result sequence of one item. - - - Like foldBack, but returns the sequence of intermediary and final results. - This function returns a sequence that digests the whole initial sequence as soon as that - sequence is iterated. As a result this function should not be used with large or infinite sequences. - - A function that updates the state with each element from the sequence. - The input sequence. - The initial state. - The resulting sequence of computed states. - Thrown when the input sequence is null. - - - Like fold, but computes on-demand and returns the sequence of intermediary and final results. - - A function that updates the state with each element from the sequence. - The initial state. - The input sequence. - - The resulting sequence of computed states. - - Thrown when the input sequence is null. - - - Returns a new sequence with the elements in reverse order. - The input sequence. - The reversed sequence. - Thrown when the input sequence is null. - - - Applies a function to each element of the sequence, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f i0 (...(f iN-1 iN)). - A function that takes in the next-to-last element of the sequence and the - current accumulated result to produce the next accumulated result. - The input sequence. - The final result of the reductions. - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Creates a sequence by replicating the given initial value. - The number of elements to replicate. - The value to replicate - The generated sequence. - - - Applies a function to each element of the sequence, threading an accumulator argument - through the computation. Begin by applying the function to the first two elements. - Then feed this result into the function along with the third element and so on. - Return the final result. - - A function that takes in the current accumulated result and the next - element of the sequence to produce the next accumulated result. - The input sequence. - - The final result of the reduction function. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Builds a new sequence object that delegates to the given sequence object. This ensures - the original sequence cannot be rediscovered and mutated by a type cast. For example, - if given an array the returned sequence will return the elements of the array, but - you cannot cast the returned sequence object to an array. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Applies the given function to successive elements, returning the first - x where the function returns "Some(x)". - - A function to transform each item of the input sequence into an option of the output type. - The input sequence. - - The selected element. - - Thrown when the input sequence is null. - Thrown when every item of the sequence - evaluates to None when the given function is applied. - - - Returns a sequence with all elements permuted according to the - specified permutation. - - Note that this function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. - - The function that maps input indices to output indices. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when indexMap does not produce a valid permutation. - - - Returns a sequence of each element in the input sequence and its predecessor, with the - exception of the first element which is only returned as the predecessor of the second element. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Views the given list as a sequence. - - The input list. - - The result sequence. - - - Views the given array as a sequence. - - The input array. - - The result sequence. - - Thrown when the input sequence is null. - - - Computes the nth element in the collection. - - The index of element to retrieve. - The input sequence. - - The nth element of the sequence. - - Thrown when the input sequence is null. - Thrown when the index is negative or the input sequence does not contain enough elements. - - - Returns the lowest of all elements of the sequence, compared via Operators.min on the function result. - - A function to transform items from the input sequence into comparable keys. - The input sequence. - - The smallest element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the lowest of all elements of the sequence, compared via Operators.min. - - The input sequence. - - The smallest element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the greatest of all elements of the sequence, compared via Operators.max on the function result. - - A function to transform items from the input sequence into comparable keys. - The input sequence. - - The largest element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the greatest of all elements of the sequence, compared via Operators.max - - The input sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - The largest element of the sequence. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding pairs of elements from the two sequences. If one input sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. The integer index passed to the - function indicates the index (from 0) of element being transformed. - - A function to transform pairs of items from the input sequences that also supplies the current index. - The first input sequence. - The second input sequence. - - The result sequence. - - Thrown when either of the input sequences is null. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The integer index passed to the - function indicates the index (from 0) of element being transformed. - - A function to transform items from the input sequence that also supplies the current index. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding triples of elements from the three sequences. If one input sequence if shorter than - the others then the remaining elements of the longer sequences are ignored. - - The function to transform triples of elements from the input sequences. - The first input sequence. - The second input sequence. - The third input sequence. - - The result sequence. - - Thrown when any of the input sequences is null. - - - Combines map and foldBack. Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The function is also used to accumulate a final value. - This function digests the whole initial sequence as soon as it is called. As a result this function should - not be used with large or infinite sequences. - The function to transform elements from the input collection and accumulate the final value. - The input collection. - The initial state. - Thrown when the input collection is null. - The collection of transformed elements, and the final accumulated value. - - - Combines map and fold. Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The function is also used to accumulate a final value. - This function digests the whole initial sequence as soon as it is called. As a result this function should - not be used with large or infinite sequences. - The function to transform elements from the input collection and accumulate the final value. - The initial state. - The input collection. - Thrown when the input collection is null. - The collection of transformed elements, and the final accumulated value. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding pairs of elements from the two sequences. If one input sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to transform pairs of items from the input sequences. - The first input sequence. - The second input sequence. - - The result sequence. - - Thrown when either of the input sequences is null. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The given function will be applied - as elements are demanded using the MoveNext method on enumerators retrieved from the - object. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - A function to transform items from the input sequence. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns the length of the sequence - - The input sequence. - - The length of the sequence. - - Thrown when the input sequence is null. - - - Applies the given function to two collections simultaneously. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. The integer passed to the - function indicates the index of element. - - A function to apply to each pair of elements from the input sequences along with their index. - The first input sequence. - The second input sequence. - - Thrown when either of the input sequences is null. - - - Applies the given function to two collections simultaneously. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to apply to each pair of elements from the input sequences. - The first input sequence. - The second input sequence. - - Thrown when either of the input sequences is null. - - - Applies the given function to each element of the collection. The integer passed to the - function indicates the index of element. - - A function to apply to each element of the sequence that can also access the current index. - The input sequence. - - Thrown when the input sequence is null. - - - Applies the given function to each element of the collection. - - A function to apply to each element of the sequence. - The input sequence. - - Thrown when the input sequence is null. - - - Computes the element at the specified index in the collection. - The index of the element to retrieve. - The input sequence. - The element at the specified index of the sequence. - Thrown when the input sequence is null. - Thrown when the index is negative or the input sequence does not contain enough elements. - - - Generates a new sequence which, when iterated, will return successive - elements by calling the given function. The results of calling the function - will not be saved, that is the function will be reapplied as necessary to - regenerate the elements. The function is passed the index of the item being - generated. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - Iteration can continue up to Int32.MaxValue. - - A function that generates an item in the sequence from a given index. - - The result sequence. - - - Generates a new sequence which, when iterated, will return successive - elements by calling the given function, up to the given count. Each element is saved after its - initialization. The function is passed the index of the item being - generated. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - The maximum number of items to generate for the sequence. - A function that generates an item in the sequence from a given index. - - The result sequence. - - Thrown when count is negative. - - - Builds a new collection whose elements are the corresponding elements of the input collection - paired with the integer index (from 0) of each element. - The input sequence. - The result sequence. - Thrown when the input sequence is null. - - - Returns true if the sequence contains no elements, false otherwise. - - The input sequence. - - True if the sequence is empty; false otherwise. - - Thrown when the input sequence is null. - - - Returns the only element of the sequence. - - The input sequence. - - The only element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input does not have precisely one element. - - - Returns the last element of the sequence. - Return None if no such element exists. - - The input sequence. - - The last element of the sequence or None. - - Thrown when the input sequence is null. - - - Returns the last element of the sequence. - The input sequence. - The last element of the sequence. - Thrown when the input sequence is null. - Thrown when the input does not have any elements. - - - Returns the first element of the sequence, or None if the sequence is empty. - - The input sequence. - - The first element of the sequence or None. - - Thrown when the input sequence is null. - - - Returns the first element of the sequence. - - The input sequence. - - The first element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input does not have any elements. - - - Applies a key-generating function to each element of a sequence and yields a sequence of - unique keys. Each unique key contains a sequence of all elements that match - to this key. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - A function that transforms an element of the sequence into a comparable key. - The input sequence. - - The result sequence. - - - Tests the all pairs of elements drawn from the two sequences satisfy the - given predicate. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to test pairs of elements from the input sequences. - The first input sequence. - The second input sequence. - - True if all pairs satisfy the predicate; false otherwise. - - Thrown when either of the input sequences is null. - - - Tests if all elements of the sequence satisfy the given predicate. - - The predicate is applied to the elements of the input sequence. If any application - returns false then the overall result is false and no further elements are tested. - Otherwise, true is returned. - - A function to test an element of the input sequence. - The input sequence. - - True if every element of the sequence satisfies the predicate; false otherwise. - - Thrown when the input sequence is null. - - - Applies a function to corresponding elements of two collections, starting from the end of the shorter collection, - threading an accumulator argument through the computation. The two sequences need not have equal lengths. - If the input function is f and the elements are i0...iN and j0...jM, N < M - then computes f i0 j0 (... (f iN jN s)...). - The function to update the state given the input elements. - The first input sequence. - The second input sequence. - The initial state. - The final state value. - Thrown when the either of the input sequences is null. - - - Applies a function to each element of the collection, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f i0 (... (f iN s)...) - The function to update the state given the input elements. - The input sequence. - The initial state. - The state object after the folding function is applied to each element of the sequence. - Thrown when the input sequence is null. - - - Applies a function to corresponding elements of two collections, threading an accumulator argument - through the computation. The two sequences need not have equal lengths: - when one sequence is exhausted any remaining elements in the other sequence are ignored. - If the input function is f and the elements are i0...iN and j0...jN - then computes f (... (f s i0 j0)...) iN jN. - The function to update the state given the input elements. - The initial state. - The first input sequence. - The second input sequence. - The final state value. - Thrown when the either of the input sequences is null. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f (... (f s i0)...) iN - - A function that updates the state with each element from the sequence. - The initial state. - The input sequence. - - The state object after the folding function is applied to each element of the sequence. - - Thrown when the input sequence is null. - - - Returns the index of the last element for which the given function returns true. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function to test whether the index of a particular element should be returned. - The input sequence. - The index of the last element for which the predicate returns true. - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns the index of the first element for which the given function returns true. - - A function to test whether the index of a particular element should be returned. - The input sequence. - - The index of the first element for which the predicate returns true. - - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns the last element for which the given function returns true. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function to test whether an item in the sequence should be returned. - The input sequence. - The last element for which the predicate returns true. - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns the first element for which the given function returns true. - - A function to test whether an item in the sequence should be returned. - The input sequence. - - The first element for which the predicate returns true. - - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true". - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - Remember sequence is lazy, effects are delayed until it is enumerated. - - A synonym for Seq.filter. - - A function to test whether each item in the input sequence should be included in the output. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true". This is a synonym for Seq.where. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - Remember sequence is lazy, effects are delayed until it is enumerated. - - A function to test whether each item in the input sequence should be included in the output. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Tests if any pair of corresponding elements of the input sequences satisfies the given predicate. - - The predicate is applied to matching elements in the two sequences up to the lesser of the - two lengths of the collections. If any application returns true then the overall result is - true and no further elements are tested. Otherwise, false is returned. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to test each pair of items from the input sequences. - The first input sequence. - The second input sequence. - - True if any result from the predicate is true; false otherwise. - - Thrown when either of the two input sequences is null. - - - Tests if any element of the sequence satisfies the given predicate. - - The predicate is applied to the elements of the input sequence. If any application - returns true then the overall result is true and no further elements are tested. - Otherwise, false is returned. - - A function to test each item of the input sequence. - The input sequence. - - True if any result from the predicate is true; false otherwise. - - Thrown when the input sequence is null. - - - Returns a new sequence with the distinct elements of the second sequence which do not apear in the first sequence, - using generic hash and equality comparisons to compare values. - - Note that this function returns a sequence that digests the whole of the first input sequence as soon as - the result sequence is iterated. As a result this function should not be used with - large or infinite sequences in the first parameter. The function makes no assumption on the ordering of the first input - sequence. - - A sequence whose elements that also occur in the second sequence will cause those elements to be - removed from the returned sequence. - A sequence whose elements that are not also in first will be returned. - - A sequence that contains the set difference of the elements of two sequences. - - Thrown when either of the two input sequences is null. - - - Creates an empty sequence. - - An empty sequence. - - - Splits the input sequence into at most count chunks. - This function returns a sequence that digests the whole initial sequence as soon as that - sequence is iterated. As a result this function should not be used with large or infinite sequences. - The maximum number of chunks. - The input sequence. - The sequence split into chunks. - Thrown when the input sequence is null. - Thrown when count is not positive. - - - Returns a sequence that contains no duplicate entries according to the - generic hash and equality comparisons on the keys returned by the given key-generating function. - If an element occurs multiple times in the sequence then the later occurrences are discarded. - - A function transforming the sequence items into comparable keys. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that contains no duplicate entries according to generic hash and - equality comparisons on the entries. - If an element occurs multiple times in the sequence then the later occurrences are discarded. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that is built from the given delayed specification of a - sequence. - - The input function is evaluated each time an IEnumerator for the sequence - is requested. - - The generating function for the sequence. - - - Applies a key-generating function to each element of a sequence and returns a sequence yielding unique - keys and their number of occurrences in the original sequence. - - Note that this function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - A function transforming each item of the input sequence into a key to be - compared against the others. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Tests if the sequence contains the specified element. - The value to locate in the input sequence. - The input sequence. - True if the input sequence contains the specified element; false otherwise. - Thrown when the input sequence is null. - - - Combines the given enumeration-of-enumerations as a single concatenated - enumeration. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - The input enumeration-of-enumerations. - - The result sequence. - - Thrown when the input sequence is null. - - - Compares two sequences using the given comparison function, element by element. - Returns the first non-zero result from the comparison function. If the end of a sequence - is reached it returns a -1 if the first sequence is shorter and a 1 if the second sequence - is shorter. - - A function that takes an element from each sequence and returns an int. - If it evaluates to a non-zero value iteration is stopped and that value is returned. - The first input sequence. - The second input sequence. - - The first non-zero value from the comparison function. - - Thrown when either of the input sequences - is null. - - - Applies the given function to each element of the sequence and concatenates all the - results. - - Remember sequence is lazy, effects are delayed until it is enumerated. - - A function to transform elements of the input sequence into the sequences - that will then be concatenated. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Divides the input sequence into chunks of size at most chunkSize. - The maximum size of each chunk. - The input sequence. - The sequence divided into chunks. - Thrown when the input sequence is null. - Thrown when chunkSize is not positive. - - - Applies the given function to each element of the list. Return - the list comprised of the results "x" for each element where - the function returns Some(x). - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not - be accessed concurrently. - - A function to transform items of type T into options of type U. - The input sequence of type T. - - The result sequence. - - Thrown when the input sequence is null. - - - Wraps a loosely-typed System.Collections sequence as a typed sequence. - - The use of this function usually requires a type annotation. - An incorrect type annotation may result in runtime type - errors. - Individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that corresponds to a cached version of the input sequence. - This result sequence will have the same elements as the input sequence. The result - can be enumerated multiple times. The input sequence will be enumerated at most - once and only as far as is necessary. Caching a sequence is typically useful when repeatedly - evaluating items in the original sequence is computationally expensive or if - iterating the sequence causes side-effects that the user does not want to be - repeated multiple times. - - Enumeration of the result sequence is thread safe in the sense that multiple independent IEnumerator - values may be used simultaneously from different threads (accesses to - the internal lookaside table are thread safe). Each individual IEnumerator - is not typically thread safe and should not be accessed concurrently. - - Once enumeration of the input sequence has started, - it's enumerator will be kept live by this object until the enumeration has completed. - At that point, the enumerator will be disposed. - - The enumerator may be disposed and underlying cache storage released by - converting the returned sequence object to type IDisposable, and calling the Dispose method - on this object. The sequence object may then be re-enumerated and a fresh enumerator will - be used. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns the average of the results generated by applying the function to each element - of the sequence. - - The elements are averaged using the + operator, DivideByInt method and Zero property - associated with the generated type. - - A function applied to transform each element of the sequence. - The input sequence. - - The average. - - Thrown when the input sequence is null. - Thrown when the input sequence has zero elements. - - - Returns the average of the elements in the sequence. - - The elements are averaged using the + operator, DivideByInt method and Zero property - associated with the element type. - - The input sequence. - - The average. - - Thrown when the input sequence is null. - Thrown when the input sequence has zero elements. - - - Wraps the two given enumerations as a single concatenated - enumeration. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed - concurrently. - - The first sequence. - The second sequence. - - The result sequence. - - Thrown when either of the two provided sequences is - null. - - - Basic operations on IEnumerables. - - - Returns a new set with the elements of the second set removed from the first. - The first input set. - The set whose elements will be removed from set1. - The set with the elements of set2 removed from set1. - - - Builds a new collection from the given enumerable object. - The input sequence. - The set containing elements. - - - Returns an ordered view of the collection as an enumerable object. - The input set. - An ordered sequence of the elements of set. - - - Builds an array that contains the elements of the set in order. - The input set. - An ordered array of the elements of set. - - - Builds a set that contains the same elements as the given array. - The input array. - A set containing the elements of array. - - - Builds a list that contains the elements of the set in order. - The input set. - An ordered list of the elements of set. - - - Builds a set that contains the same elements as the given list. - The input list. - A set containing the elements form the input list. - - - Returns the highest element in the set according to the ordering being used for the set. - The input set. - The max value from the set. - - - Returns the lowest element in the set according to the ordering being used for the set. - The input set. - The min value from the set. - - - Returns a new set with the given element removed. No exception is raised if - the set doesn't contain the given element. - The element to remove. - The input set. - The input set with value removed. - - - Splits the set into two sets containing the elements for which the given predicate - returns true and false respectively. - The function to test set elements. - The input set. - A pair of sets with the first containing the elements for which predicate returns - true and the second containing the elements for which predicate returns false. - - - Applies the given function to each element of the set, in order according - to the comparison function. - The function to apply to each element. - The input set. - - - Returns "true" if the set is empty. - The input set. - True if set is empty. - - - Computes the union of a sequence of sets. - The sequence of sets to untion. - The union of the input sets. - - - Computes the union of the two sets. - The first input set. - The second input set. - The union of set1 and set2. - - - Computes the intersection of a sequence of sets. The sequence must be non-empty. - The sequence of sets to intersect. - The intersection of the input sets. - - - Computes the intersection of the two sets. - The first input set. - The second input set. - The intersection of set1 and set2. - - - Tests if all elements of the collection satisfy the given predicate. - If the input function is f and the elements are i0...iN and "j0...jN" - then computes p i0 && ... && p iN. - The function to test set elements. - The input set. - True if all elements of set satisfy predicate. - - - Applies the given accumulating function to all the elements of the set. - The accumulating function. - The input set. - The initial state. - The final state. - - - Applies the given accumulating function to all the elements of the set - The accumulating function. - The initial state. - The input set. - The final state. - - - Returns a new collection containing the results of applying the - given function to each element of the input set. - The function to transform elements of the input set. - The input set. - A set containing the transformed elements. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns true. - The function to test set elements. - The input set. - The set containing only the elements for which predicate returns true. - - - Tests if any element of the collection satisfies the given predicate. - If the input function is predicate and the elements are i0...iN - then computes p i0 or ... or p iN. - The function to test set elements. - The input set. - True if any element of set satisfies predicate. - - - Returns the number of elements in the set. Same as size. - The input set. - The number of elements in the set. - - - Evaluates to "true" if all elements of the second set are in the first, and at least - one element of the first is not in the second. - The potential superset. - The set to test against. - True if set1 is a proper superset of set2. - - - Evaluates to "true" if all elements of the second set are in the first. - The potential superset. - The set to test against. - True if set1 is a superset of set2. - - - Evaluates to "true" if all elements of the first set are in the second, and at least - one element of the second is not in the first. - The potential subset. - The set to test against. - True if set1 is a proper subset of set2. - - - Evaluates to "true" if all elements of the first set are in the second - The potential subset. - The set to test against. - True if set1 is a subset of set2. - - - Evaluates to "true" if the given element is in the given set. - The element to test. - The input set. - True if element is in set. - - - Returns a new set with an element added to the set. No exception is raised if - the set already contains the given element. - The value to add. - The input set. - A new set containing value. - - - The set containing the given element. - The value for the set to contain. - The set containing value. - - - The empty set for the type 'T. - - - Functional programming operators related to the Set<_> type. - - - Gets the default cancellation token for executing asynchronous computations. - The default CancellationToken. - - - Creates an asynchronous computation that returns the CancellationToken governing the execution - of the computation. - In async { let! token = Async.CancellationToken ...} token can be used to initiate other - asynchronous operations that will cancel cooperatively with this workflow. - An asynchronous computation capable of retrieving the CancellationToken from a computation - expression. - - - Creates an asynchronous computation that executes computation. - If this computation is cancelled before it completes then the computation generated by - running compensation is executed. - The input asynchronous computation. - The function to be run if the computation is cancelled. - An asynchronous computation that runs the compensation if the input computation - is cancelled. - - - Creates an asynchronous computation that queues a work item that runs - its continuation. - A computation that generates a new work item in the thread pool. - - - Creates an asynchronous computation that creates a new thread and runs - its continuation in that thread. - A computation that will execute on a new thread. - - - Creates an asynchronous computation that runs - its continuation using syncContext.Post. If syncContext is null - then the asynchronous computation is equivalent to SwitchToThreadPool(). - The synchronization context to accept the posted computation. - An asynchronous computation that uses the syncContext context to execute. - - - Runs an asynchronous computation, starting immediately on the current operating system - thread. Call one of the three continuations when the operation completes. - If no cancellation token is provided then the default cancellation token - is used. - The asynchronous computation to execute. - The function called on success. - The function called on exception. - The function called on cancellation. - The CancellationToken to associate with the computation. - The default is used if this parameter is not provided. - - - Runs an asynchronous computation, starting immediately on the current operating system - thread. - If no cancellation token is provided then the default cancellation token is used. - The asynchronous computation to execute. - The CancellationToken to associate with the computation. - The default is used if this parameter is not provided. - - - Creates an asynchronous computation which starts the given computation as a System.Threading.Tasks.Task - - - Starts a child computation within an asynchronous workflow. - This allows multiple asynchronous computations to be executed simultaneously. - - This method should normally be used as the immediate - right-hand-side of a let! binding in an F# asynchronous workflow, that is, - - async { ... - let! completor1 = childComputation1 |> Async.StartChild - let! completor2 = childComputation2 |> Async.StartChild - ... - let! result1 = completor1 - let! result2 = completor2 - ... } - - When used in this way, each use of StartChild starts an instance of childComputation - and returns a completor object representing a computation to wait for the completion of the operation. - When executed, the completor awaits the completion of childComputation. - The child computation. - The timeout value in milliseconds. If one is not provided - then the default value of -1 corresponding to System.Threading.Timeout.Infinite. - A new computation that waits for the input computation to finish. - - - Executes a computation in the thread pool. - If no cancellation token is provided then the default cancellation token is used. - A System.Threading.Tasks.Task that will be completed - in the corresponding state once the computation terminates (produces the result, throws exception or gets canceled) - - - - Starts the asynchronous computation in the thread pool. Do not await its result. - - If no cancellation token is provided then the default cancellation token is used. - The computation to run asynchronously. - The cancellation token to be associated with the computation. - If one is not supplied, the default cancellation token is used. - - - Creates an asynchronous computation that will sleep for the given time. This is scheduled - using a System.Threading.Timer object. The operation will not block operating system threads - for the duration of the wait. - The number of milliseconds to sleep. - An asynchronous computation that will sleep for the given time. - Thrown when the due time is negative - and not infinite. - - - Runs the asynchronous computation and await its result. - - If an exception occurs in the asynchronous computation then an exception is re-raised by this - function. - - If no cancellation token is provided then the default cancellation token is used. - - The timeout parameter is given in milliseconds. A value of -1 is equivalent to - System.Threading.Timeout.Infinite. - The computation to run. - The amount of time in milliseconds to wait for the result of the - computation before raising a System.TimeoutException. If no value is provided - for timeout then a default of -1 is used to correspond to System.Threading.Timeout.Infinite. - The cancellation token to be associated with the computation. - If one is not supplied, the default cancellation token is used. - The result of the computation. - - - Creates an asynchronous computation that executes all the given asynchronous computations, - initially queueing each as work items and using a fork/join pattern. - - If all child computations succeed, an array of results is passed to the success continuation. - - If any child computation raises an exception, then the overall computation will trigger an - exception, and cancel the others. - - The overall computation will respond to cancellation while executing the child computations. - If cancelled, the computation will cancel any remaining child computations but will still wait - for the other child computations to complete. - A sequence of distinct computations to be parallelized. - A computation that returns an array of values from the sequence of input computations. - - - Generates a scoped, cooperative cancellation handler for use within an asynchronous workflow. - - For example, - async { use! holder = Async.OnCancel interruption ... } - generates an asynchronous computation where, if a cancellation happens any time during - the execution of the asynchronous computation in the scope of holder, then action - interruption is executed on the thread that is performing the cancellation. This can - be used to arrange for a computation to be asynchronously notified that a cancellation - has occurred, e.g. by setting a flag, or deregistering a pending I/O action. - The function that is executed on the thread performing the - cancellation. - An asynchronous computation that triggers the interruption if it is cancelled - before being disposed. - - - Creates an asynchronous computation that runs the given computation and ignores - its result. - The input computation. - A computation that is equivalent to the input computation, but disregards the result. - - - Creates an asynchronous computation that captures the current - success, exception and cancellation continuations. The callback must - eventually call exactly one of the given continuations. - The function that accepts the current success, exception, and cancellation - continuations. - An asynchronous computation that provides the callback with the current continuations. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. This overlaod should be used if the operation is - qualified by three arguments. For example, - Async.FromBeginEnd(arg1,arg2,arg3,ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The first argument for the operation. - The second argument for the operation. - The third argument for the operation. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. This overlaod should be used if the operation is - qualified by two arguments. For example, - Async.FromBeginEnd(arg1,arg2,ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The first argument for the operation. - The second argument for the operation. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. This overlaod should be used if the operation is - qualified by one argument. For example, - Async.FromBeginEnd(place,ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The argument for the operation. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. For example, - Async.FromBeginEnd(ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation that executes computation. - If this computation completes successfully then return Choice1Of2 with the returned - value. If this computation raises an exception before it completes then return Choice2Of2 - with the raised exception. - The input computation that returns the type T. - A computation that returns a choice of type T or exception. - - - Raises the cancellation condition for the most recent set of asynchronous computations started - without any specific CancellationToken. Replaces the global CancellationTokenSource with a new - global token source for any asynchronous computations created after this point without any - specific CancellationToken. - - - Creates an asynchronous computation that will wait on the given WaitHandle. - - The computation returns true if the handle indicated a result within the given timeout. - The WaitHandle that can be signalled. - The timeout value in milliseconds. If one is not provided - then the default value of -1 corresponding to System.Threading.Timeout.Infinite. - An asynchronous computation that waits on the given WaitHandle. - - - - Return an asynchronous computation that will wait for the given task to complete and return - its result. - - - - - Return an asynchronous computation that will wait for the given task to complete and return - its result. - - - - Creates an asynchronous computation that will wait on the IAsyncResult. - - The computation returns true if the handle indicated a result within the given timeout. - The IAsyncResult to wait on. - The timeout value in milliseconds. If one is not provided - then the default value of -1 corresponding to System.Threading.Timeout.Infinite. - An asynchronous computation that waits on the given IAsyncResult. - - - Creates an asynchronous computation that waits for a single invocation of a CLI - event by adding a handler to the event. Once the computation completes or is - cancelled, the handler is removed from the event. - - The computation will respond to cancellation while waiting for the event. If a - cancellation occurs, and cancelAction is specified, then it is executed, and - the computation continues to wait for the event. - - If cancelAction is not specified, then cancellation causes the computation - to cancel immediately. - The event to handle once. - An optional function to execute instead of cancelling when a - cancellation is issued. - An asynchronous computation that waits for the event to be invoked. - - - Creates three functions that can be used to implement the .NET Asynchronous - Programming Model (APM) for a given asynchronous computation. - - The functions should normally be published as members with prefix Begin, - End and Cancel, and can be used within a type definition as follows: - - let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun arg -> computation) - member x.BeginSomeOperation(arg,callback,state:obj) = beginAction(arg,callback,state) - member x.EndSomeOperation(iar) = endAction(iar) - member x.CancelSomeOperation(iar) = cancelAction(iar) - - - If the asynchronous computation takes no arguments, then AsBeginEnd is used as follows: - - let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun () -> computation) - member x.BeginSomeOperation(callback,state:obj) = beginAction((),callback,state) - member x.EndSomeOperation(iar) = endAction(iar) - member x.CancelSomeOperation(iar) = cancelAction(iar) - - - - If the asynchronous computation takes two arguments, then AsBeginEnd is used as follows: - - let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun arg1 arg2 -> computation) - member x.BeginSomeOperation(arg1,arg2,callback,state:obj) = beginAction((),callback,state) - member x.EndSomeOperation(iar) = endAction(iar) - member x.CancelSomeOperation(iar) = cancelAction(iar) - - - In each case, the resulting API will be familiar to programmers in other CLI languages and - is a useful way to publish asynchronous computations in CLI components. - A function generating the asynchronous computation to split into the traditional - .NET Asynchronous Programming Model. - A tuple of the begin, end, and cancel members. - - - This static class holds members for creating and manipulating asynchronous computations. - - - Creates an asynchronous computation that just returns (). - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of empty else branches in the - async { ... } computation expression syntax. - An asynchronous computation that returns (). - - - Creates an asynchronous computation that runs computation repeatedly - until guard() becomes false. - - A cancellation check is performed whenever the computation is executed. - - The existence of this method permits the use of while in the - async { ... } computation expression syntax. - The function to determine when to stop executing computation. - The function to be executed. Equivalent to the body - of a while expression. - An asynchronous computation that behaves similarly to a while loop when run. - - - Creates an asynchronous computation that runs binder(resource). - The action resource.Dispose() is executed as this computation yields its result - or if the asynchronous computation exits by an exception or by cancellation. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of use and use! in the - async { ... } computation expression syntax. - The resource to be used and disposed. - The function that takes the resource and returns an asynchronous - computation. - An asynchronous computation that binds and eventually disposes resource. - - - Creates an asynchronous computation that runs computation and returns its result. - If an exception happens then catchHandler(exn) is called and the resulting computation executed instead. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of try/with in the - async { ... } computation expression syntax. - The input computation. - The function to run when computation throws an exception. - An asynchronous computation that executes computation and calls catchHandler if an - exception is thrown. - - - Creates an asynchronous computation that runs computation. The action compensation is executed - after computation completes, whether computation exits normally or by an exception. If compensation raises an exception itself - the original exception is discarded and the new exception becomes the overall result of the computation. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of try/finally in the - async { ... } computation expression syntax. - The input computation. - The action to be run after computation completes or raises an - exception (including cancellation). - An asynchronous computation that executes computation and compensation aftewards or - when an exception is raised. - - - Delegates to the input computation. - - The existence of this method permits the use of return! in the - async { ... } computation expression syntax. - The input computation. - The input computation. - - - Creates an asynchronous computation that returns the result v. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of return in the - async { ... } computation expression syntax. - The value to return from the computation. - An asynchronous computation that returns value when executed. - - - Creates an asynchronous computation that enumerates the sequence seq - on demand and runs body for each element. - - A cancellation check is performed on each iteration of the loop. - - The existence of this method permits the use of for in the - async { ... } computation expression syntax. - The sequence to enumerate. - A function to take an item from the sequence and create - an asynchronous computation. Can be seen as the body of the for expression. - An asynchronous computation that will enumerate the sequence and run body - for each element. - - - Creates an asynchronous computation that runs generator. - - A cancellation check is performed when the computation is executed. - The function to run. - An asynchronous computation that runs generator. - - - Creates an asynchronous computation that first runs computation1 - and then runs computation2, returning the result of computation2. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of expression sequencing in the - async { ... } computation expression syntax. - The first part of the sequenced computation. - The second part of the sequenced computation. - An asynchronous computation that runs both of the computations sequentially. - - - Creates an asynchronous computation that runs computation, and when - computation generates a result T, runs binder res. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of let! in the - async { ... } computation expression syntax. - The computation to provide an unbound result. - The function to bind the result of computation. - An asynchronous computation that performs a monadic bind on the result - of computation. - - - - Generate an object used to build asynchronous computations using F# computation expressions. The value - 'async' is a pre-defined instance of this type. - - A cancellation check is performed when the computation is executed. - - - - The type of the async operator, used to build workflows for asynchronous computations. - - - Sends a reply to a PostAndReply message. - The value to send. - - - A handle to a capability to reply to a PostAndReply message. - - - A compositional asynchronous computation, which, when run, will eventually produce a value - of type T, or else raises an exception. - - Asynchronous computations are normally specified using an F# computation expression. - - When run, asynchronous computations have two modes: as a work item (executing synchronous - code), or as a wait item (waiting for an event or I/O completion). - - When run, asynchronous computations can be governed by CancellationToken. This can usually - be specified when the async computation is started. The associated CancellationTokenSource - may be used to cancel the asynchronous computation. Asynchronous computations built using - computation expressions can check the cancellation condition regularly. Synchronous - computations within an asynchronous computation do not automatically check this condition. - - - Publishes the event as a first class event value. - - - Triggers the event using the given parameters. - The parameters for the event. - - - Creates an event object suitable for implementing an arbitrary type of delegate. - The event object. - - - Event implementations for an arbitrary type of delegate. - - - Publishes an observation as a first class value. - - - Triggers an observation using the given parameters. - The event parameters. - - - Creates an observable object. - The created event. - - - Event implementations for the IEvent<_> type. - - - Publishes the event as a first class event value. - - - Triggers the event using the given sender object and parameters. The sender object may be null. - The object triggering the event. - The parameters for the event. - - - Creates an event object suitable for delegate types following the standard .NET Framework convention of a first 'sender' argument. - The created event. - - - Event implementations for a delegate types following the standard .NET Framework convention of a first 'sender' argument. - - - A delegate type associated with the F# event type IEvent<_> - The object that fired the event. - The event arguments. - - - Remove a listener delegate from an event listener store. - The delegate to be removed from the event listener store. - - - Connect a handler delegate object to the event. A handler can - be later removed using RemoveHandler. The listener will - be invoked when the event is fired. - A delegate to be invoked when the event is fired. - - - First class event values for arbitrary delegate types. - - F# gives special status to member properties compatible with type IDelegateEvent and - tagged with the CLIEventAttribute. In this case the F# compiler generates approriate - CLI metadata to make the member appear to other CLI languages as a CLI event. - - - First-class listening points (i.e. objects that permit you to register a callback - activated when the event is triggered). - - - First class event values for CLI events conforming to CLI Framework standards. - - - The type of delayed computations. - - Use the values in the Lazy module to manipulate - values of this type, and the notation lazy expr to create values - of type . - - - Raises a timeout exception if a message not received in this amount of time. By default - no timeout is used. - - - Occurs when the execution of the agent results in an exception. - - - Occurs when the execution of the agent results in an exception. - - - Raises a timeout exception if a message not received in this amount of time. By default - no timeout is used. - - - Returns the number of unprocessed messages in the message queue of the agent. - - - Occurs when the execution of the agent results in an exception. - - - Scans for a message by looking through messages in arrival order until scanner - returns a Some value. Other messages remain in the queue. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - The function to return None if the message is to be skipped - or Some if the message is to be processed and removed from the queue. - An optional timeout in milliseconds. Defaults to -1 which corresponds - to System.Threading.Timeout.Infinite. - An asynchronous computation that scanner built off the read message. - - - Waits for a message. This will consume the first message in arrival order. - - This method is for use within the body of the agent. - - Returns None if a timeout is given and the timeout is exceeded. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - An optional timeout in milliseconds. Defaults to -1 which - corresponds to System.Threading.Timeout.Infinite. - An asynchronous computation that returns the received message or - None if the timeout is exceeded. - - - Like PostAndReply, but returns None if no reply within the timeout period. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - The reply from the agent or None if the timeout expires. - - - Starts the agent. - - - Creates and starts an agent. The body function is used to generate the asynchronous - computation executed by the agent. - The function to produce an asynchronous computation that will be executed - as the read loop for the MailboxProcessor when Start is called. - An optional cancellation token for the body. - Defaults to Async.DefaultCancellationToken. - The created MailboxProcessor. - - - Scans for a message by looking through messages in arrival order until scanner - returns a Some value. Other messages remain in the queue. - - Returns None if a timeout is given and the timeout is exceeded. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - The function to return None if the message is to be skipped - or Some if the message is to be processed and removed from the queue. - An optional timeout in milliseconds. Defaults to -1 which corresponds - to System.Threading.Timeout.Infinite. - An asynchronous computation that scanner built off the read message. - Thrown when the timeout is exceeded. - - - Waits for a message. This will consume the first message in arrival order. - - This method is for use within the body of the agent. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - An optional timeout in milliseconds. Defaults to -1 which corresponds - to System.Threading.Timeout.Infinite. - An asynchronous computation that returns the received message. - Thrown when the timeout is exceeded. - - - Like AsyncPostAndReply, but returns None if no reply within the timeout period. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - An asynchronous computation that will return the reply or None if the timeout expires. - - - Posts a message to an agent and await a reply on the channel, synchronously. - - The message is generated by applying buildMessage to a new reply channel - to be incorporated into the message. The receiving agent must process this - message and invoke the Reply method on this reply channel precisely once. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - The reply from the agent. - - - Posts a message to an agent and await a reply on the channel, asynchronously. - - The message is generated by applying buildMessage to a new reply channel - to be incorporated into the message. The receiving agent must process this - message and invoke the Reply method on this reply channel precisely once. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - An asychronous computation that will wait for the reply from the agent. - - - Posts a message to the message queue of the MailboxProcessor, asynchronously. - The message to post. - - - Creates an agent. The body function is used to generate the asynchronous - computation executed by the agent. This function is not executed until - Start is called. - The function to produce an asynchronous computation that will be executed - as the read loop for the MailboxProcessor when Start is called. - An optional cancellation token for the body. - Defaults to Async.DefaultCancellationToken. - The created MailboxProcessor. - - - A message-processing agent which executes an asynchronous computation. - - The agent encapsulates a message queue that supports multiple-writers and - a single reader agent. Writers send messages to the agent by using the Post - method and its variations. - - The agent may wait for messages using the Receive or TryReceive methods or - scan through all available messages using the Scan or TryScan method. - - - Connects a listener function to the observable. The listener will - be invoked for each observation. The listener can be removed by - calling Dispose on the returned IDisposable object. - The function to be called for each observation. - An object that will remove the listener if disposed. - - - Permanently connects a listener function to the observable. The listener will - be invoked for each observation. - The function to be called for each observation. - - - Returns an asynchronous computation that will write the given bytes to the stream. - The buffer to write from. - An optional offset as a number of bytes in the stream. - An optional number of bytes to write to the stream. - An asynchronous computation that will write the given bytes to the stream. - Thrown when the sum of offset and count is longer than - the buffer length. - Thrown when offset or count is negative. - - - Returns an asynchronous computation that will read the given number of bytes from the stream. - The number of bytes to read. - An asynchronous computation that returns the read byte[] when run. - - - Returns an asynchronous computation that will read from the stream into the given buffer. - The buffer to read into. - An optional offset as a number of bytes in the stream. - An optional number of bytes to read from the stream. - An asynchronous computation that will read from the stream into the given buffer. - Thrown when the sum of offset and count is longer than - the buffer length. - Thrown when offset or count is negative. - - - A module of extension members providing asynchronous operations for some basic CLI types related to concurrency and I/O. - - - Returns a new event that triggers on the second and subsequent triggerings of the input event. - The Nth triggering of the input event passes the arguments from the N-1th and Nth triggering as - a pair. The argument passed to the N-1th triggering is held in hidden internal state until the - Nth triggering occurs. - The input event. - An event that triggers on pairs of consecutive values passed from the source event. - - - Runs the given function each time the given event is triggered. - The function to call when the event is triggered. - The input event. - - - Returns a new event consisting of the results of applying the given accumulating function - to successive values triggered on the input event. An item of internal state - records the current value of the state parameter. The internal state is not locked during the - execution of the accumulation function, so care should be taken that the - input IEvent not triggered by multiple threads simultaneously. - The function to update the state with each event value. - The initial state. - The input event. - An event that fires on the updated state values. - - - Returns a new event which fires on a selection of messages from the original event. - The selection function takes an original message to an optional new message. - The function to select and transform event values to pass on. - The input event. - An event that fires only when the chooser returns Some. - - - Returns a new event that listens to the original event and triggers the - first resulting event if the application of the function to the event arguments - returned a Choice1Of2, and the second event if it returns a Choice2Of2. - The function to transform event values into one of two types. - The input event. - A tuple of events. The first fires whenever splitter evaluates to Choice1of1 and - the second fires whenever splitter evaluates to Choice2of2. - - - Returns a new event that listens to the original event and triggers the - first resulting event if the application of the predicate to the event arguments - returned true, and the second event if it returned false. - The function to determine which output event to trigger. - The input event. - A tuple of events. The first is triggered when the predicate evaluates to true - and the second when the predicate evaluates to false. - - - Returns a new event that listens to the original event and triggers the resulting - event only when the argument to the event passes the given function. - The function to determine which triggers from the event to propagate. - The input event. - An event that only passes values that pass the predicate. - - - Returns a new event that passes values transformed by the given function. - The function to transform event values. - The input event. - An event that passes the transformed values. - - - Fires the output event when either of the input events fire. - The first input event. - The second input event. - An event that fires when either of the input events fire. - - - Forces the execution of this value and return its result. Same as Value. Mutual exclusion is used to - prevent other threads also computing the value. - The value of the Lazy object. - - - Creates a lazy computation that evaluates to the given value when forced. - The input value. - The created Lazy object. - - - Creates a lazy computation that evaluates to the result of the given function when forced. - The function to provide the value when needed. - The created Lazy object. - - - Extensions related to Lazy values. - - - Returns a new observable that triggers on the second and subsequent triggerings of the input observable. - The Nth triggering of the input observable passes the arguments from the N-1th and Nth triggering as - a pair. The argument passed to the N-1th triggering is held in hidden internal state until the - Nth triggering occurs. - - For each observer, the registered intermediate observing object is not thread safe. - That is, observations arising from the source must not be triggered concurrently - on different threads. - The input Observable. - An Observable that triggers on successive pairs of observations from the input Observable. - - - Creates an observer which subscribes to the given observable and which calls - the given function for each observation. - The function to be called on each observation. - The input Observable. - An object that will remove the callback if disposed. - - - Creates an observer which permanently subscribes to the given observable and which calls - the given function for each observation. - The function to be called on each observation. - The input Observable. - - - Returns an observable which, for each observer, allocates an item of state - and applies the given accumulating function to successive values arising from - the input. The returned object will trigger observations for each computed - state value, excluding the initial value. The returned object propagates - all errors arising from the source and completes when the source completes. - - For each observer, the registered intermediate observing object is not thread safe. - That is, observations arising from the source must not be triggered concurrently - on different threads. - The function to update the state with each observation. - The initial state. - The input Observable. - An Observable that triggers on the updated state values. - - - Returns an observable which chooses a projection of observations from the source - using the given function. The returned object will trigger observations x - for which the splitter returns Some x. The returned object also propagates - all errors arising from the source and completes when the source completes. - The function that returns Some for observations to be propagated - and None for observations to ignore. - The input Observable. - An Observable that only propagates some of the observations from the source. - - - Returns two observables which split the observations of the source by the - given function. The first will trigger observations x for which the - splitter returns Choice1Of2 x. The second will trigger observations - y for which the splitter returns Choice2Of2 y The splitter is - executed once for each subscribed observer. Both also propagate error - observations arising from the source and each completes when the source - completes. - The function that takes an observation an transforms - it into one of the two output Choice types. - The input Observable. - A tuple of Observables. The first triggers when splitter returns Choice1of2 - and the second triggers when splitter returns Choice2of2. - - - Returns two observables which partition the observations of the source by - the given function. The first will trigger observations for those values - for which the predicate returns true. The second will trigger observations - for those values where the predicate returns false. The predicate is - executed once for each subscribed observer. Both also propagate all error - observations arising from the source and each completes when the source - completes. - The function to determine which output Observable will trigger - a particular observation. - The input Observable. - A tuple of Observables. The first triggers when the predicate returns true, and - the second triggers when the predicate returns false. - - - Returns an observable which filters the observations of the source - by the given function. The observable will see only those observations - for which the predicate returns true. The predicate is executed once for - each subscribed observer. The returned object also propagates error - observations arising from the source and completes when the source completes. - The function to apply to observations to determine if it should - be kept. - The input Observable. - An Observable that filters observations based on filter. - - - Returns an observable which transforms the observations of the source by the - given function. The transformation function is executed once for each - subscribed observer. The returned object also propagates error observations - arising from the source and completes when the source completes. - The function applied to observations from the source. - The input Observable. - An Observable of the type specified by mapping. - - - Returns an observable for the merged observations from the sources. - The returned object propagates success and error values arising - from either source and completes when both the sources have completed. - - For each observer, the registered intermediate observing object is not - thread safe. That is, observations arising from the sources must not - be triggered concurrently on different threads. - The first Observable. - The second Observable. - An Observable that propagates information from both sources. - - - Basic operations on first class event and other observable objects. - - - Returns an asynchronous computation that, when run, will wait for a response to the given WebRequest. - An asynchronous computation that waits for response to the WebRequest. - - - A module of extension members providing asynchronous operations for some basic Web operations. - - - Creates an instance of the attribute - AbstractClassAttribute - - - Adding this attribute to class definition makes it abstract, which means it need not - implement all its methods. Instances of abstract classes may not be constructed directly. - - - The value of the attribute, indicating whether the type allows the null literal or not - - - Creates an instance of the attribute with the specified value - AllowNullLiteralAttribute - - - Creates an instance of the attribute - AllowNullLiteralAttribute - - - Adding this attribute to a type lets the 'null' literal be used for the type - within F# code. This attribute may only be added to F#-defined class or - interface types. - - - Indicates the namespace or module to be automatically opened when an assembly is referenced - or an enclosing module opened. - - - Creates an attribute used to mark a namespace or module path to be 'automatically opened' when an assembly is referenced - The namespace or module to be automatically opened when an assembly is referenced - or an enclosing module opened. - AutoOpenAttribute - - - Creates an attribute used to mark a module as 'automatically opened' when the enclosing namespace is opened - AutoOpenAttribute - - - This attribute is used for two purposes. When applied to an assembly, it must be given a string - argument, and this argument must indicate a valid module or namespace in that assembly. Source - code files compiled with a reference to this assembly are processed in an environment - where the given path is automatically opened. - - When applied to a module within an assembly, then the attribute must not be given any arguments. - When the enclosing namespace is opened in user source code, the module is also implicitly opened. - - - The value of the attribute, indicating whether the type is automatically marked serializable or not - - - Creates an instance of the attribute - Indicates whether the type should be serializable by default. - AutoSerializableAttribute - - - Adding this attribute to a type with value 'false' disables the behaviour where F# makes the - type Serializable by default. - - - Creates an instance of the attribute - CLIEventAttribute - - - Adding this attribute to a property with event type causes it to be compiled with as a CLI - metadata event, through a syntactic translation to a pair of 'add_EventName' and - 'remove_EventName' methods. - - - Creates an instance of the attribute - CLIMutableAttribute - - - Adding this attribute to a record type causes it to be compiled to a CLI representation - with a default constructor with property getters and setters. - - - Choice 2 of 2 choices - - - Choice 1 of 2 choices - - - Helper types for active patterns with 2 choices. - - - Choice 3 of 3 choices - - - Choice 2 of 3 choices - - - Choice 1 of 3 choices - - - Helper types for active patterns with 3 choices. - - - Choice 4 of 4 choices - - - Choice 3 of 4 choices - - - Choice 2 of 4 choices - - - Choice 1 of 4 choices - - - Helper types for active patterns with 4 choices. - - - Choice 5 of 5 choices - - - Choice 4 of 5 choices - - - Choice 3 of 5 choices - - - Choice 2 of 5 choices - - - Choice 1 of 5 choices - - - Helper types for active patterns with 5 choices. - - - Choice 6 of 6 choices - - - Choice 5 of 6 choices - - - Choice 4 of 6 choices - - - Choice 3 of 6 choices - - - Choice 2 of 6 choices - - - Choice 1 of 6 choices - - - Helper types for active patterns with 6 choices. - - - Choice 7 of 7 choices - - - Choice 6 of 7 choices - - - Choice 5 of 7 choices - - - Choice 4 of 7 choices - - - Choice 3 of 7 choices - - - Choice 2 of 7 choices - - - Choice 1 of 7 choices - - - Helper types for active patterns with 7 choices. - - - Creates an instance of the attribute - ClassAttribute - - - Adding this attribute to a type causes it to be represented using a CLI class. - - - Creates an instance of the attribute - ComparisonConditionalOnAttribute - - - This attribute is used to indicate a generic container type satisfies the F# 'comparison' - constraint only if a generic argument also satisfies this constraint. For example, adding - this attribute to parameter 'T on a type definition C<'T> means that a type C<X> only supports - comparison if the type X also supports comparison and all other conditions for C<X> to support - comparison are also met. The type C<'T> can still be used with other type arguments, but a type such - as C<(int -> int)> will not support comparison because the type (int -> int) is an F# function type - and does not support comparison. - - This attribute will be ignored if it is used on the generic parameters of functions or methods. - - - Indicates the number of arguments in each argument group - - - Creates an instance of the attribute - Indicates the number of arguments in each argument group. - CompilationArgumentCountsAttribute - - - This attribute is generated automatically by the F# compiler to tag functions and members - that accept a partial application of some of their arguments and return a residual function - - - Indicates the variant number of the entity, if any, in a linear sequence of elements with F# source code - - - Indicates the type definitions needed to resolve the source construct - - - Indicates the relationship between the compiled entity and F# source code - - - Indicates the sequence number of the entity, if any, in a linear sequence of elements with F# source code - - - Indicates the resource the source construct relates to - - - Creates an instance of the attribute - Indicates the type definitions needed to resolve the source construct. - CompilationMappingAttribute - - - Creates an instance of the attribute - Indicates the type of source construct. - CompilationMappingAttribute - - - Creates an instance of the attribute - Indicates the type of source construct. - CompilationMappingAttribute - - - Creates an instance of the attribute - Indicates the type of source construct. - CompilationMappingAttribute - - - This attribute is inserted automatically by the F# compiler to tag types - and methods in the generated CLI code with flags indicating the correspondence - with original source constructs. It is used by the functions in the - Microsoft.FSharp.Reflection namespace to reverse-map compiled constructs to - their original forms. It is not intended for use from user code. - - - Indicates one or more adjustments to the compiled representation of an F# type or member - - - Creates an instance of the attribute - Indicates adjustments to the compiled representation of the type or member. - CompilationRepresentationAttribute - - - This attribute is used to adjust the runtime representation for a type. - For example, it may be used to note that the null representation - may be used for a type. This affects how some constructs are compiled. - - - Compile a property as a CLI event. - - - Permit the use of null as a representation for nullary discriminators in a discriminated union. - - - append 'Module' to the end of a module whose name clashes with a type name in the same namespace. - - - Compile a member as 'instance' even if null is used as a representation for this type. - - - Compile an instance member as 'static' . - - - No special compilation representation. - - - Indicates one or more adjustments to the compiled representation of an F# type or member. - - - Indicates the name of the entity in F# source code - - - Creates an instance of the attribute - The name of the method in source. - CompilationSourceNameAttribute - - - This attribute is inserted automatically by the F# compiler to tag - methods which are given the 'CompiledName' attribute. It is not intended - for use from user code. - - - The name of the value as it appears in compiled code - - - Creates an instance of the attribute - The name to use in compiled code. - CompiledNameAttribute - - - Adding this attribute to a value or function definition in an F# module changes the name used - for the value in compiled CLI code. - - - Indicates if the construct should always be hidden in an editing environment. - - - Indicates if the message should indicate a compiler error. Error numbers less than - 10000 are considered reserved for use by the F# compiler and libraries. - - - Indicates the number associated with the message. - - - Indicates the warning message to be emitted when F# source code uses this construct - - - Indicates if the construct should always be hidden in an editing environment. - - - Indicates if the message should indicate a compiler error. Error numbers less than - 10000 are considered reserved for use by the F# compiler and libraries. - - - Creates an instance of the attribute. - - - Indicates that a message should be emitted when F# source code uses this construct. - - - Creates an instance of the attribute - CustomComparisonAttribute - - - Adding this attribute to a type indicates it is a type with a user-defined implementation of comparison. - - - Creates an instance of the attribute - CustomEqualityAttribute - - - Adding this attribute to a type indicates it is a type with a user-defined implementation of equality. - - - Indicates if the custom operation maintains the variable space of the query of computation expression through the use of a bind operation - - - Indicates if the custom operation maintains the variable space of the query of computation expression - - - Indicates the name used for the 'on' part of the custom query operator for join-like operators - - - Indicates if the custom operation is an operation similar to a zip in a sequence computation, supporting two inputs - - - Indicates if the custom operation is an operation similar to a join in a sequence computation, supporting two inputs and a correlation constraint - - - Indicates if the custom operation is an operation similar to a group join in a sequence computation, supporting two inputs and a correlation constraint, and generating a group - - - Indicates if the custom operation supports the use of 'into' immediately after the use of the operation in a query or other computation expression to consume the results of the operation - - - Get the name of the custom operation when used in a query or other computation expression - - - Indicates if the custom operation maintains the variable space of the query of computation expression through the use of a bind operation - - - Indicates if the custom operation maintains the variable space of the query of computation expression - - - Indicates the name used for the 'on' part of the custom query operator for join-like operators - - - Indicates if the custom operation is an operation similar to a zip in a sequence computation, supporting two inputs - - - Indicates if the custom operation is an operation similar to a join in a sequence computation, supporting two inputs and a correlation constraint - - - Indicates if the custom operation is an operation similar to a group join in a sequence computation, supporting two inputs and a correlation constraint, and generating a group - - - Indicates if the custom operation supports the use of 'into' immediately after the use of the operation in a query or other computation expression to consume the results of the operation - - - Creates an instance of the attribute - CustomOperationAttribute - - - - Indicates that a member on a computation builder type is a custom query operator, - and indicates the name of that operator. - - - - The value of the attribute, indicating whether the type has a default augmentation or not - - - Creates an instance of the attribute - Indicates whether to generate helper members on the CLI class representing a discriminated - union. - DefaultAugmentationAttribute - - - Adding this attribute to a discriminated union with value false - turns off the generation of standard helper member tester, constructor - and accessor members for the generated CLI class for that type. - - - Indicates if a constraint is asserted that the field type supports 'null' - - - Creates an instance of the attribute - Indicates whether to assert that the field type supports null. - DefaultValueAttribute - - - Creates an instance of the attribute - DefaultValueAttribute - - - Adding this attribute to a field declaration means that the field is - not initialized. During type checking a constraint is asserted that the field type supports 'null'. - If the 'check' value is false then the constraint is not asserted. - - - Creates an instance of the attribute - EntryPointAttribute - - - Adding this attribute to a function indicates it is the entrypoint for an application. - If this attribute is not specified for an EXE then the initialization implicit in the - module bindings in the last file in the compilation sequence are used as the entrypoint. - - - Creates an instance of the attribute - EqualityConditionalOnAttribute - - - This attribute is used to indicate a generic container type satisfies the F# 'equality' - constraint only if a generic argument also satisfies this constraint. For example, adding - this attribute to parameter 'T on a type definition C<'T> means that a type C<X> only supports - equality if the type X also supports equality and all other conditions for C<X> to support - equality are also met. The type C<'T> can still be used with other type arguments, but a type such - as C<(int -> int)> will not support equality because the type (int -> int) is an F# function type - and does not support equality. - - This attribute will be ignored if it is used on the generic parameters of functions or methods. - - - Indicates the warning message to be emitted when F# source code uses this construct - - - Creates an instance of the attribute - The warning message to be emitted when code uses this construct. - ExperimentalAttribute - - - This attribute is used to tag values that are part of an experimental library - feature. - - - Invoke an F# first class function value with two curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The function result. - - - Invoke an F# first class function value with three curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The third arg. - The function result. - - - Invoke an F# first class function value with four curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The third arg. - The fourth arg. - The function result. - - - Invoke an F# first class function value with five curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The third arg. - The fourth arg. - The fifth arg. - The function result. - - - Invoke an F# first class function value with one argument - - 'U - - - Construct an instance of an F# first class function value - The created F# function. - - - The CLI type used to represent F# function values. This type is not - typically used directly, though may be used from other CLI languages. - - - The release number of the F# version associated with the attribute - - - The minor version number of the F# version associated with the attribute - - - The major version number of the F# version associated with the attribute - - - Creates an instance of the attribute - The major version number. - The minor version number. - The release number. - FSharpInterfaceDataVersionAttribute - - - This attribute is added to generated assemblies to indicate the - version of the data schema used to encode additional F# - specific information in the resource attached to compiled F# libraries. - - - Specialize the type function at a given type - The specialized type. - - - Construct an instance of an F# first class type function value - FSharpTypeFunc - - - The CLI type used to represent F# first-class type function values. This type is for use - by compiled F# code. - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - Tuple of values generated by scan or match. - - - Convert the given Action delegate object to an F# function value - The input action. - The F# function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - Helper functions for converting F# first class function values to and from CLI representaions - of functions using delegates. - - - Creates an instance of the attribute - GeneralizableValueAttribute - - - Adding this attribute to a non-function value with generic parameters indicates that - uses of the construct can give rise to generic code through type inference. - - - Creates an instance of the attribute - InterfaceAttribute - - - Adding this attribute to a type causes it to be represented using a CLI interface. - - - Creates an instance of the attribute - LiteralAttribute - - - Adding this attribute to a value causes it to be compiled as a CLI constant literal. - - - Creates an instance of the attribute - MeasureAnnotatedAbbreviationAttribute - - - Adding this attribute to a type causes it to be interpreted as a refined type, currently limited to measure-parameterized types. - This may only be used under very limited conditions. - - - Creates an instance of the attribute - MeasureAttribute - - - Adding this attribute to a type causes it to be interpreted as a unit of measure. - This may only be used under very limited conditions. - - - Creates an instance of the attribute - NoComparisonAttribute - - - Adding this attribute to a type indicates it is a type where comparison is an abnormal operation. - This means that the type does not satisfy the F# 'comparison' constraint. Within the bounds of the - F# type system, this helps ensure that the F# generic comparison function is not instantiated directly - at this type. The attribute and checking does not constrain the use of comparison with base or child - types of this type. - - - Creates an instance of the attribute - NoDynamicInvocationAttribute - - - This attribute is used to tag values that may not be dynamically invoked at runtime. This is - typically added to inlined functions whose implementations include unverifiable code. It - causes the method body emitted for the inlined function to raise an exception if - dynamically invoked, rather than including the unverifiable code in the generated - assembly. - - - Creates an instance of the attribute - NoEqualityAttribute - - - Adding this attribute to a type indicates it is a type where equality is an abnormal operation. - This means that the type does not satisfy the F# 'equality' constraint. Within the bounds of the - F# type system, this helps ensure that the F# generic equality function is not instantiated directly - at this type. The attribute and checking does not constrain the use of comparison with base or child - types of this type. - - - The representation of "Value of type 'T" - The input value. - An option representing the value. - - - The representation of "No value" - - - Get the value of a 'Some' option. A NullReferenceException is raised if the option is 'None'. - - - Create an option value that is a 'None' value. - - - Return 'true' if the option is a 'Some' value. - - - Return 'true' if the option is a 'None' value. - - - Create an option value that is a 'Some' value. - The input value - An option representing the value. - - - The type of optional values. When used from other CLI languages the - empty option is the null value. - - Use the constructors Some and None to create values of this type. - Use the values in the Option module to manipulate values of this type, - or pattern match against the values directly. - - None values will appear as the value null to other CLI languages. - Instance methods on this type will appear as static methods to other CLI languages - due to the use of null as a value representation. - - - Creates an instance of the attribute - OptionalArgumentAttribute - - - This attribute is added automatically for all optional arguments. - - - The raw text of the format string. - - - Construct a format string - The input string. - The PrintfFormat containing the formatted result. - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - - - Construct a format string - The input string. - The created format string. - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - Tuple of values generated by scan or match. - - - Creates an instance of the attribute - ProjectionParameterAttribute - - - Indicates that, when a custom operator is used in a computation expression, - a parameter is automatically parameterized by the variable space of the computation expression - - - - The current value of the reference cell - - - - The current value of the reference cell - - - The current value of the reference cell - - - The type of mutable references. Use the functions [:=] and [!] to get and - set values of this type. - - - Creates an instance of the attribute - ReferenceEqualityAttribute - - - Adding this attribute to a record or union type disables the automatic generation - of overrides for 'System.Object.Equals(obj)', 'System.Object.GetHashCode()' - and 'System.IComparable' for the type. The type will by default use reference equality. - - - The value of the attribute, indicating whether to include the evaluated value of the definition as the outer node of the quotation - - - Creates an instance of the attribute - Indicates whether to include the evaluated value of the definition as the outer node of the quotation - ReflectedDefinitionAttribute - - - Creates an instance of the attribute - ReflectedDefinitionAttribute - - - Adding this attribute to the let-binding for the definition of a top-level - value makes the quotation expression that implements the value available - for use at runtime. - - - Creates an instance of the attribute - RequireQualifiedAccessAttribute - - - This attribute is used to indicate that references to the elements of a module, record or union - type require explicit qualified access. - - - Creates an instance of the attribute - RequiresExplicitTypeArgumentsAttribute - - - Adding this attribute to a type, value or member requires that - uses of the construct must explicitly instantiate any generic type parameters. - - - The value of the attribute, indicating whether the type is sealed or not. - - - Creates an instance of the attribute - Indicates whether the class is sealed. - SealedAttribute - - - Creates an instance of the attribute. - The created attribute. - - - Adding this attribute to class definition makes it sealed, which means it may not - be extended or implemented. - - - Indicates that the compiled entity had private or internal representation in F# source code. - - - The mask of values related to the kind of the compiled entity. - - - Indicates that the compiled entity is part of the representation of an F# value declaration. - - - Indicates that the compiled entity is part of the representation of an F# union case declaration. - - - Indicates that the compiled entity is part of the representation of an F# module declaration. - - - Indicates that the compiled entity is part of the representation of an F# closure. - - - Indicates that the compiled entity is part of the representation of an F# exception declaration. - - - Indicates that the compiled entity is part of the representation of an F# record or union case field declaration. - - - Indicates that the compiled entity is part of the representation of an F# class or other object type declaration. - - - Indicates that the compiled entity is part of the representation of an F# record type declaration. - - - Indicates that the compiled entity is part of the representation of an F# union type declaration. - - - Indicates that the compiled entity has no relationship to an element in F# source code. - - - Indicates the relationship between a compiled entity in a CLI binary and an element in F# source code. - - - Creates an instance of the attribute - StructAttribute - - - Adding this attribute to a type causes it to be represented using a CLI struct. - - - Creates an instance of the attribute - StructuralComparisonAttribute - - - Adding this attribute to a record, union, exception, or struct type confirms the - automatic generation of implementations for 'System.IComparable' for the type. - - - Creates an instance of the attribute - StructuralEqualityAttribute - - - Adding this attribute to a record, union or struct type confirms the automatic - generation of overrides for 'System.Object.Equals(obj)' and - 'System.Object.GetHashCode()' for the type. - - - Indicates the text to display by default when objects of this type are displayed - using '%A' printf formatting patterns and other two-dimensional text-based display - layouts. - - - Creates an instance of the attribute - Indicates the text to display when using the '%A' printf formatting. - StructuredFormatDisplayAttribute - - - This attribute is used to mark how a type is displayed by default when using - '%A' printf formatting patterns and other two-dimensional text-based display layouts. - In this version of F# valid values are of the form PreText {PropertyName1} PostText {PropertyName2} ... {PropertyNameX} PostText. - The property names indicate properties to evaluate and to display instead of the object itself. - - - The type 'unit', which has only one value "()". This value is special and - always uses the representation 'null'. - - - Creates an instance of the attribute - UnverifiableAttribute - - - This attribute is used to tag values whose use will result in the generation - of unverifiable code. These values are inevitably marked 'inline' to ensure that - the unverifiable constructs are not present in the actual code for the F# library, - but are rather copied to the source code of the caller. - - - Creates an instance of the attribute - VolatileFieldAttribute - - - Adding this attribute to an F# mutable binding causes the "volatile" - prefix to be used for all accesses to the field. - - - Thirty-two dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Thirty-one dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Thirty dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-nine dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-eight dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-seven dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-six dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-five dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-four dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-three dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-two dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-one dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Nineteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Eighteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Seventeen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Sixteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Fifteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Fourteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Thirteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twelve dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Eleven dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Ten dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Nine dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Eight dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Seven dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Six dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Five dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Four dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - Use the values in the Array4D module - to manipulate values of this type, or the notation arr.[x1,x2,x3,x4] to get and set array - values. - - - Three dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - Use the values in the Array3D module - to manipulate values of this type, or the notation arr.[x1,x2,x3] to get and set array - values. - - - Two dimensional arrays, typically zero-based. - - Use the values in the Array2D module - to manipulate values of this type, or the notation arr.[x,y] to get/set array - values. - - Non-zero-based arrays can also be created using methods on the System.Array type. - - - Single dimensional, zero-based arrays, written int[], string[] etc. - Use the values in the Array module to manipulate values - of this type, or the notation arr.[x] to get/set array - values. - - - Single dimensional, zero-based arrays, written int[], string[] etc. - - Use the values in the Array module to manipulate values - of this type, or the notation arr.[x] to get/set array - values. - - - An abbreviation for the CLI type System.Boolean. - - - Represents a managed pointer in F# code. - - - An abbreviation for the CLI type System.Byte. - - - An abbreviation for the CLI type System.Char. - - - An abbreviation for the CLI type System.Decimal. - - - The type of decimal numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Decimal. - - - An abbreviation for the CLI type System.Double. - - - An abbreviation for the CLI type System.Exception. - - - An abbreviation for the CLI type System.Double. - - - An abbreviation for the CLI type System.Single. - - - The type of floating point numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Single. - - - The type of floating point numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Double. - - - This type is for internal use by the F# code generator. - - - An abbreviation for the CLI type System.Int32. - - - An abbreviation for the CLI type System.Int16. - - - The type of 16-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Int16. - - - An abbreviation for the CLI type System.Int32. - - - An abbreviation for the CLI type System.Int64. - - - The type of 64-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Int64. - - - An abbreviation for the CLI type System.SByte. - - - The type of 32-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Int32. - - - An abbreviation for the CLI type System.IntPtr. - - - Represents an unmanaged pointer in F# code. - - This type should only be used when writing F# code that interoperates - with native code. Use of this type in F# code may result in - unverifiable code being generated. Conversions to and from the - nativeint type may be required. Values of this type can be generated - by the functions in the NativeInterop.NativePtr module. - - - An abbreviation for the CLI type System.Object. - - - The type of optional values. When used from other CLI languages the - empty option is the null value. - - Use the constructors Some and None to create values of this type. - Use the values in the Option module to manipulate values of this type, - or pattern match against the values directly. - - 'None' values will appear as the value null to other CLI languages. - Instance methods on this type will appear as static methods to other CLI languages - due to the use of null as a value representation. - - - The type of mutable references. Use the functions [:=] and [!] to get and - set values of this type. - - - An abbreviation for the CLI type System.SByte. - - - The type of 8-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.SByte. - - - An abbreviation for the CLI type System.Single. - - - An abbreviation for the CLI type System.String. - - - An abbreviation for the CLI type System.UInt16. - - - An abbreviation for the CLI type System.UInt32. - - - An abbreviation for the CLI type System.UInt64. - - - An abbreviation for the CLI type System.Byte. - - - An abbreviation for the CLI type System.UIntPtr. - - - The type 'unit', which has only one value "()". This value is special and - always uses the representation 'null'. - - - Non-exhaustive match failures will raise the MatchFailureException exception - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - A new enumerator for the sequence. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - A reference to the sequence. - - A 0, 1, and 2 respectively indicate Stop, Yield, and Goto conditions for the sequence generator. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - A new sequence generator for the expression. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - - Namespace name the provider injects types into. - - - - - Compilers call this method to query a type provider for a type name. - - Resolver should return a type called name in namespace NamespaceName or null if the type is unknown. - - - - - - The top-level types - - - - - - The sub-namespaces in this namespace. An optional member to prevent generation of namespaces until an outer namespace is explored. - - - - - Represents a namespace provided by a type provider component. - - - - - Triggered when an assumption changes that invalidates the resolutions so far reported by the provider - - - - - Triggered when an assumption changes that invalidates the resolutions so far reported by the provider - - - - - Triggered when an assumption changes that invalidates the resolutions so far reported by the provider - - - - - Get the static parameters for a provided type. - - A type returned by GetTypes or ResolveTypeName - - - - - Namespace name the this TypeProvider injects types into. - - - - - Called by the compiler to ask for an Expression tree to replace the given MethodBase with. - - MethodBase that was given to the compiler by a type returned by a GetType(s) call. - Expressions that represent the parameters to this call. - An expression that the compiler will use in place of the given method base. - - - - Get the physical contents of the given logical provided assembly. - - - - - Apply static arguments to a provided type that accepts static arguments. - - The provider must return a type with the given mangled name. - the provided type definition which has static parameters - the full path of the type, including encoded representations of static parameters - the static parameters, indexed by name - - - - - Represents an instantiation of a type provider component. - - - - - Get the static parameters for a provided method. - - A method returned by GetMethod on a provided type - The static parameters of the provided method, if any - - - - Apply static arguments to a provided method that accepts static arguments. - - The provider must return a provided method with the given mangled name. - the provided method definition which has static parameters - the full name of the method that must be returned, including encoded representations of static parameters - the values of the static parameters, indexed by name - The provided method definition corresponding to the given static parameter values - - - - Represents additional, optional information for a type provider component - - - - Represents the inverse of a measure expressions when returned as a generic argument of a provided type. - - - Represents the '1' measure expression when returned as a generic argument of a provided type. - - - Represents the product of two measure expressions when returned as a generic argument of a provided type. - - - Creates an instance of the attribute - TypeProviderAssemblyAttribute - The name of the design-time assembly for this type provider. - - - Creates an instance of the attribute - TypeProviderAssemblyAttribute - - - Place attribute on runtime assembly to indicate that there is a corresponding design-time - assembly that contains a type provider. Runtime and designer assembly may be the same. - - - Creates an instance of the attribute - TypeProviderAttribute - - - Place on a class that implements ITypeProvider to extend the compiler - - - - Get the full path to use for temporary files for the type provider instance. - - - - - version of referenced system runtime assembly - - - - - Get the full path to referenced assembly that caused this type provider instance to be created. - - - - - Get the full path to use to resolve relative paths in any file name arguments given to the type provider instance. - - - - - Get the referenced assemblies for the type provider instance. - - - - - Indicates if the type provider host responds to invalidation events for type provider instances. - - - - - Indicates if the type provider instance is used in an environment which executes provided code such as F# Interactive. - - - - - Get the full path to use for temporary files for the type provider instance. - - - - - version of referenced system runtime assembly - - - - - Get the full path to referenced assembly that caused this type provider instance to be created. - - - - - Get the full path to use to resolve relative paths in any file name arguments given to the type provider instance. - - - - - Get the referenced assemblies for the type provider instance. - - - - - Indicates if the type provider host responds to invalidation events for type provider instances. - - - - - Indicates if the type provider instance is used in an environment which executes provided code such as F# Interactive. - - - - - Checks if given type exists in target system runtime library - - - - - If the class that implements ITypeProvider has a constructor that accepts TypeProviderConfig - then it will be constructed with an instance of TypeProviderConfig. - - - - Creates an instance of the attribute - TypeProviderEditorHideMethodsAttribute - - - Indicates that a code editor should hide all System.Object methods from the intellisense menus for instances of a provided type - - - Additional type attribute flags related to provided types - - - Creates an instance of the attribute - TypeProviderXmlDocAttribute - - - - The TypeProviderXmlDocAttribute attribute can be added to types and members. - The language service will display the CommentText property from the attribute - in the appropriate place when the user hovers over a type or member. - - - - Creates an anonymous event with the given handlers. - - A function to handle adding a delegate for the event to trigger. - A function to handle removing a delegate that the event triggers. - A function to produce the delegate type the event can trigger. - - The initialized event. - - - The F# compiler emits calls to this function to implement the use operator for F# sequence - expressions. - - The resource to be used and disposed. - The input sequence. - - The result sequence. - - - The F# compiler emits calls to this function to implement the compiler-intrinsic - conversions from untyped System.Collections.IEnumerable sequences to typed sequences. - - An initializer function. - A function to iterate and test if end of sequence is reached. - A function to retrieve the current element. - - The resulting typed sequence. - - - The F# compiler emits calls to this function to - implement the try/finally operator for F# sequence expressions. - - The input sequence. - A computation to be included in an enumerator's Dispose method. - - The result sequence. - - - The F# compiler emits calls to this function to - implement the while operator for F# sequence expressions. - - A function that indicates whether iteration should continue. - The input sequence. - - The result sequence. - - - A group of functions used as part of the compiled representation of F# sequence expressions. - - - Builds a query using query syntax and operators. - - - An active pattern to force the execution of values of type Lazy<_>. - - - Special prefix operator for splicing untyped expressions into quotation holes. - - - Special prefix operator for splicing typed expressions into quotation holes. - - - Builds a 2D array from a sequence of sequences of elements. - - - Builds a read-only lookup table from a sequence of key/value pairs. The key objects are indexed using generic hashing and equality. - - - Converts the argument to signed byte. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using SByte.Parse() with InvariantCulture settings. - Otherwise the operation requires and invokes a ToSByte method on the input type. - - - Converts the argument to byte. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Byte.Parse() on strings and otherwise requires a ToByte method on the input type. - - - Converts the argument to 64-bit float. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Double.Parse() with InvariantCulture settings. Otherwise the operation requires and invokes a ToDouble method on the input type. - - - Converts the argument to 32-bit float. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Single.Parse() with InvariantCulture settings. Otherwise the operation requires and invokes a ToSingle method on the input type. - - - Builds an aysnchronous workflow using computation expression syntax. - - - Builds a set from a sequence of objects. The objects are indexed using generic comparison. - The input sequence of elements. - The created set. - - - Print to a file using the given format, and add a newline. - The file TextWriter. - The formatter. - The formatted result. - - - Print to a file using the given format. - The file TextWriter. - The formatter. - The formatted result. - - - Print to a string buffer and raise an exception with the given - result. Helper printers must return strings. - The formatter. - The formatted result. - - - Print to a string using the given format. - The formatter. - The formatted result. - - - Converts the argument to signed byte. - This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using SByte.Parse() with InvariantCulture settings. - Otherwise the operation requires and invokes a ToSByte method on the input type. - - - Converts the argument to byte. - This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using Byte.Parse() on strings and otherwise requires a ToByte method on the input type. - - - Divides a value by an integer. - The input value. - The input int. - The division result. - - - Resolves to the value 'one' for any primitive numeric type or any type with a static member called 'One' - - - Resolves to the zero value for any primitive numeric type or any type with a static member called 'Zero' - - - A compiler intrinsic that implements dynamic invocations for the DivideByInt primitive. - - - A compiler intrinsic that implements dynamic invocations to the checked '*' operator. - - - A compiler intrinsic that implements dynamic invocations to the '*' operator. - - - A compiler intrinsic that implements dynamic invocations to the checked '+' operator. - - - A compiler intrinsic that implements dynamic invocations to the '+' operator. - - - Resolves to the value 'one' for any primitive numeric type or any type with a static member called 'One'. - - - Resolves to the zero value for any primitive numeric type or any type with a static member called 'Zero'. - - - Parse an uint64 according to the rules used by the overloaded 'uint64' conversion operator when applied to strings - The input string. - The parsed value. - - - Parse an int64 according to the rules used by the overloaded 'int64' conversion operator when applied to strings - The input string. - The parsed value. - - - Parse an uint32 according to the rules used by the overloaded 'uint32' conversion operator when applied to strings - The input string. - The parsed value. - - - Parse an int32 according to the rules used by the overloaded 'int32' conversion operator when applied to strings - The input string. - The parsed value. - - - Creates an sbyte value with units-of-measure - The input sbyte. - The sbyte with units-of-measure. - - - Creates an int16 value with units-of-measure - The input int16. - The int16 with units-of-measure. - - - Creates an int64 value with units-of-measure - The input int64. - The int64 with units of measure. - - - Creates an int32 value with units-of-measure - The input int. - The int with units of measure. - - - Creates a decimal value with units-of-measure - The input decimal. - The decimal with units of measure. - - - Creates a float32 value with units-of-measure - The input float. - The float with units-of-measure. - - - Creates a float value with units-of-measure - The input float. - The float with units-of-measure. - - - Get the underlying value for an enum value - The input enum. - The enumeration as a value. - - - Build an enum value from an underlying value - The input value. - The value as an enumeration. - - - Recursively hash a part of a value according to its structure. - The comparison function. - The input object. - The hashed value. - - - Hash a value according to its structure. Use the given limit to restrict the hash when hashing F# - records, lists and union types. - The limit on the number of nodes. - The input object. - The hashed value. - - - Hash a value according to its structure. This hash is not limited by an overall node count when hashing F# - records, lists and union types. - The input object. - The hashed value. - - - Make an F# comparer object for the given type - - - Make an F# hash/equality object for the given type - - - Make an F# hash/equality object for the given type using node-limited hashing when hashing F# - records, lists and union types. - The input limit on the number of nodes. - System.Collections.Generic.IEqualityComparer<'T> - - - Make an F# hash/equality object for the given type - - - Make an F# comparer object for the given type, where it can be null if System.Collections.Generic.Comparer<'T>.Default - - - Make an F# comparer object for the given type - - - A static F# comparer object - - - Return an F# comparer object suitable for hashing and equality. This hashing behaviour - of the returned comparer is not limited by an overall node count when hashing F# - records, lists and union types. This equality comparer has equivalence - relation semantics ([nan] = [nan]). - - - Return an F# comparer object suitable for hashing and equality. This hashing behaviour - of the returned comparer is not limited by an overall node count when hashing F# - records, lists and union types. - - - The physical hash. Hashes on the object identity, except for value types, - where we hash on the contents. - The input object. - The hashed value. - - - Reference/physical equality. - True if the inputs are reference-equal, false otherwise. - The first value. - The second value. - The result of the comparison. - - - Take the maximum of two values structurally according to the order given by GenericComparison - The first value. - The second value. - The maximum value. - - - Take the minimum of two values structurally according to the order given by GenericComparison - The first value. - The second value. - The minimum value. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values. May be called as a recursive case from an implementation of System.IComparable to - ensure consistent NaN comparison semantics. - The function to compare the values. - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values for equality - - The first value. - The second value. - The result of the comparison. - - - Compare two values for equality using equivalence relation semantics ([nan] = [nan]) - The first value. - The second value. - The result of the comparison. - - - Compare two values for equality using partial equivalence relation semantics ([nan] <> [nan]) - The first value. - The second value. - The result of the comparison. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs - - - - The standard overloaded associative (4-indexed) mutation operator - - - - The standard overloaded associative (3-indexed) mutation operator - - - The standard overloaded associative (2-indexed) mutation operator - - - The standard overloaded associative (indexed) mutation operator - - - The standard overloaded associative (4-indexed) lookup operator - - - The standard overloaded associative (3-indexed) lookup operator - - - The standard overloaded associative (2-indexed) lookup operator - - - The standard overloaded associative (indexed) lookup operator - - - A compiler intrinsic for checking initialization soundness of recursive bindings - - - A compiler intrinsic for checking initialization soundness of recursive static bindings - - - A compiler intrinsic for checking initialization soundness of recursive bindings - - - A compiler intrinsic for the efficient compilation of sequence expressions - - - This function implements parsing of decimal constants - - - This function implements calls to default constructors - acccessed by 'new' constraints. - - - Primitive used by pattern match compilation - - - A compiler intrinsic that implements the ':?' operator - - - A compiler intrinsic that implements the ':?' operator - - - A compiler intrinsic that implements the ':?>' operator - - - A compiler intrinsic that implements the ':?>' operator - - - The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs - - - Address-of. Uses of this value may result in the generation of unverifiable code. - The input object. - The unmanaged pointer. - - - Address-of. Uses of this value may result in the generation of unverifiable code. - The input object. - The managed pointer. - - - Binary 'or'. When used as a binary operator the right hand value is evaluated only on demand - The first value. - The second value. - The result of the operation. - - - Binary 'or'. When used as a binary operator the right hand value is evaluated only on demand. - - - Binary 'and'. When used as a binary operator the right hand value is evaluated only on demand - The first value. - The second value. - The result of the operation. - - - Binary 'and'. When used as a binary operator the right hand value is evaluated only on demand. - - - The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs - - - For compiler use only - - - Language primitives associated with the F# language - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - An active pattern to match values of type System.Collections.Generic.KeyValuePair - The input key/value pair. - A tuple containing the key and value. - - - Converts the argument to character. Numeric inputs are converted according to the UTF-16 - encoding for characters. String inputs must be exactly one character long. For other - input types the operation requires an appropriate static conversion method on the input type. - The input value. - The converted char. - - - Converts the argument to System.Decimal using a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted decimal. - - - Converts the argument to a string using ToString. - - For standard integer and floating point values the ToString conversion - uses CultureInfo.InvariantCulture. - The input value. - The converted string. - - - Converts the argument to unsigned native integer using a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted unativeint - - - Converts the argument to signed native integer. This is a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted nativeint - - - Converts the argument to 64-bit float. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Double.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float - - - Converts the argument to 32-bit float. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Single.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float32 - - - Converts the argument to unsigned 64-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint64 - - - Converts the argument to signed 64-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int64 - - - Converts the argument to unsigned 32-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint32 - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int32 - - - Converts the argument to a particular enum type. - The input value. - The converted enum type. - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int - - - Converts the argument to unsigned 16-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint16 - - - Converts the argument to signed 16-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int16 - - - Converts the argument to signed byte. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using SByte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to byte. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Byte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - Overloaded power operator. If n > 0 then equivalent to x*...*x for n occurrences of x. - The input base. - The input exponent. - The base raised to the exponent. - - - Overloaded power operator. - The input base. - The input exponent. - The base raised to the exponent. - - - Overloaded truncate operator. - The input value. - The truncated value. - - - Hyperbolic tangent of the given number - The input value. - The hyperbolic tangent of the input. - - - Tangent of the given number - The input value. - The tangent of the input. - - - Hyperbolic sine of the given number - The input value. - The hyperbolic sine of the input. - - - Sine of the given number - The input value. - The sine of the input. - - - Hyperbolic cosine of the given number - The input value. - The hyperbolic cosine of the input. - - - Cosine of the given number - The input value. - The cosine of the input. - - - Square root of the given number - The input value. - The square root of the input. - - - Logarithm to base 10 of the given number - The input value. - The logarithm to base 10 of the input. - - - Natural logarithm of the given number - The input value. - The natural logarithm of the input. - - - Round the given number - The input value. - The nearest integer to the input value. - - - Sign of the given number - The input value. - -1, 0, or 1 depending on the sign of the input. - - - Floor of the given number - The input value. - The floor of the input. - - - Exponential of the given number - The input value. - The exponential of the input. - - - Ceiling of the given number - The input value. - The ceiling of the input. - - - Inverse tangent of x/y where x and y are specified separately - The y input value. - The x input value. - The inverse tangent of the input ratio. - - - Inverse tangent of the given number - The input value. - The inverse tangent of the input. - - - Inverse sine of the given number - The input value. - The inverse sine of the input. - - - Inverse cosine of the given number - The input value. - The inverse cosine of the input. - - - Absolute value of the given number. - The input value. - The absolute value of the input. - - - A generic hash function. This function has the same behaviour as 'hash', - however the default structural hashing for F# union, record and tuple - types stops when the given limit of nodes is reached. The exact behaviour of - the function can be adjusted on a type-by-type basis by implementing - GetHashCode for each type. - The limit of nodes. - The input object. - The computed hash. - - - A generic hash function, designed to return equal hash values for items that are - equal according to the "=" operator. By default it will use structural hashing - for F# union, record and tuple types, hashing the complete contents of the - type. The exact behaviour of the function can be adjusted on a - type-by-type basis by implementing GetHashCode for each type. - The input object. - The computed hash. - - - Returns the internal size of a type in bytes. For example, sizeof<int> returns 4. - - - Generate a System.Type representation for a type definition. If the - input type is a generic type instantiation then return the - generic type definition associated with all such instantiations. - - - An internal, library-only compiler intrinsic for compile-time - generation of a RuntimeMethodHandle. - - - Generate a System.Type runtime representation of a static type. - - - Clean up resources associated with the input object after the completion of the given function. - Cleanup occurs even when an exception is raised by the protected - code. - The resource to be disposed after action is called. - The action that accepts the resource. - The resulting value. - - - Execute the function as a mutual-exclusion region using the input value as a lock. - The object to be locked. - The action to perform during the lock. - The resulting value. - - - The standard overloaded skip range operator, e.g. [n..skip..m] for lists, seq {n..skip..m} for sequences - The start value of the range. - The step value of the range. - The end value of the range. - The sequence spanning the range using the specified step size. - - - The standard overloaded range operator, e.g. [n..m] for lists, seq {n..m} for sequences - The start value of the range. - The end value of the range. - The sequence spanning the range. - - - Equivalent to System.Single.NaN - - - Equivalent to System.Single.PositiveInfinity - - - Equivalent to System.Double.NaN - - - Equivalent to System.Double.PositiveInfinity - - - Builds a sequence using sequence expression syntax - The input sequence. - The result sequence. - - - Negate a logical value. not true equals false and not false equals true - The value to negate. - The result of the negation. - - - Concatenate two lists. - The first list. - The second list. - The concatenation of the lists. - - - Increment a mutable reference cell containing an integer - The reference cell. - - - Decrement a mutable reference cell containing an integer - The reference cell. - - - Dereference a mutable reference cell - The cell to dereference. - The value contained in the cell. - - - Assign to a mutable reference cell - The cell to mutate. - The value to set inside the cell. - - - Create a mutable reference cell - The value to contain in the cell. - The created reference cell. - - - The identity function - The input value. - The same value. - - - Throw a System.InvalidOperationException exception - The exception message. - The result value. - - - Throw a System.ArgumentNullException exception - The argument name. - The result value. - - - Throw a System.ArgumentException exception with - the given argument name and message. - The argument name. - The exception message. - The result value. - - - Throw a System.Exception exception. - The exception message. - The result value. - - - Determines whether the given value is null. - The value to check. - True when value is null, false otherwise. - - - Try to unbox a strongly typed value. - The boxed value. - The unboxed result as an option. - - - Boxes a strongly typed value. - The value to box. - The boxed object. - - - Unboxes a strongly typed value. - The boxed value. - The unboxed result. - - - Ignore the passed value. This is often used to throw away results of a computation. - The value to ignore. - - - Minimum based on generic comparison - The first value. - The second value. - The minimum value. - - - Maximum based on generic comparison - The first value. - The second value. - The maximum value. - - - Generic comparison. - The first value. - The second value. - The result of the comparison. - - - Return the second element of a tuple, snd (a,b) = b. - The input tuple. - The second value. - - - Return the first element of a tuple, fst (a,b) = a. - The input tuple. - The first value. - - - Matches System.Exception objects whose runtime type is precisely System.Exception - The input exception. - A string option. - - - Builds a System.Exception object. - The message for the Exception. - A System.Exception. - - - Rethrows an exception. This should only be used when handling an exception - The result value. - - - Rethrows an exception. This should only be used when handling an exception - The result value. - - - Raises an exception - The exception to raise. - The result value. - - - Concatenate two strings. The operator '+' may also be used. - - - Used to specify a default value for an optional argument in the implementation of a function - An option representing the argument. - The default value of the argument. - The argument value. If it is None, the defaultValue is returned. - - - Apply a function to three values, the values being a triple on the right, the function on the left - The function. - The first argument. - The second argument. - The third argument. - The function result. - - - Apply a function to two values, the values being a pair on the right, the function on the left - The function. - The first argument. - The second argument. - The function result. - - - Apply a function to a value, the value being on the right, the function on the left - The function. - The argument. - The function result. - - - Apply a function to three values, the values being a triple on the left, the function on the right - The first argument. - The second argument. - The third argument. - The function. - The function result. - - - Apply a function to two values, the values being a pair on the left, the function on the right - The first argument. - The second argument. - The function. - The function result. - - - Apply a function to a value, the value being on the left, the function on the right - The argument. - The function. - The function result. - - - Compose two functions, the function on the right being applied first - The second function to apply. - The first function to apply. - The composition of the input functions. - - - Compose two functions, the function on the left being applied first - The first function to apply. - The second function to apply. - The composition of the input functions. - - - Structural inequality - The first parameter. - The second parameter. - The result of the comparison. - - - Structural equality - The first parameter. - The second parameter. - The result of the comparison. - - - Structural less-than-or-equal comparison - The first parameter. - The second parameter. - The result of the comparison. - - - Structural greater-than-or-equal - The first parameter. - The second parameter. - The result of the comparison. - - - Structural greater-than - The first parameter. - The second parameter. - The result of the comparison. - - - Structural less-than comparison - The first parameter. - The second parameter. - The result of the comparison. - - - Overloaded prefix-plus operator - The input value. - The result of the operation. - - - Overloaded bitwise-NOT operator - The input value. - The result of the operation. - - - Overloaded byte-shift right operator by a specified number of bits - The input value. - The amount to shift. - The result of the operation. - - - Overloaded byte-shift left operator by a specified number of bits - The input value. - The amount to shift. - The result of the operation. - - - Overloaded bitwise-XOR operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded bitwise-OR operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded bitwise-AND operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded modulo operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded division operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded multiplication operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded subtraction operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded addition operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded unary negation. - The value to negate. - The result of the operation. - - - Converts the argument to char. Numeric inputs are converted using a checked - conversion according to the UTF-16 encoding for characters. String inputs must - be exactly one character long. For other input types the operation requires an - appropriate static conversion method on the input type. - The input value. - The converted char - - - Converts the argument to unativeint. This is a direct, checked conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted unativeint - - - Converts the argument to nativeint. This is a direct, checked conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted nativeint - - - Converts the argument to uint64. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.UInt64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint64 - - - Converts the argument to int64. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int64 - - - Converts the argument to uint32. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.UInt32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint32 - - - Converts the argument to int32. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int32 - - - Converts the argument to int. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int - - - Converts the argument to uint16. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.UInt16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint16 - - - Converts the argument to int16. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int16 - - - Converts the argument to sbyte. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.SByte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to byte. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Byte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - Overloaded multiplication operator (checks for overflow) - The first value. - The second value. - The product of the two input values. - - - Overloaded addition operator (checks for overflow) - The first value. - The second value. - The sum of the two input values. - - - Overloaded subtraction operator (checks for overflow) - The first value. - The second value. - The first value minus the second value. - - - Overloaded unary negation (checks for overflow) - The input value. - The negated value. - - - This module contains the basic arithmetic operations with overflow checks. - - - Calls GetHashCode() on the value - The value. - The hash code. - - - Minimum of the two values - The first value. - The second value. - The minimum value. - - - Maximum of the two values - The first value. - The second value. - The maximum value. - - - Compares the two values - The first value. - The second value. - The result of the comparison. - - - Compares the two values for inequality - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for equality - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for less-than-or-equal - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for greater-than-or-equal - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for greater-than - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for less-than - The first parameter. - The second parameter. - The result of the comparison. - - - A module of comparison and equality operators that are statically resolved, but which are not fully generic and do not make structural comparison. Opening this - module may make code that relies on structural or generic comparison no longer compile. - - - Perform generic hashing on a value where the type of the value is not - statically required to satisfy the 'equality' constraint. - The computed hash value. - - - Perform generic equality on two values where the type of the values is not - statically required to satisfy the 'equality' constraint. - The result of the comparison. - - - Perform generic comparison on two values where the type of the values is not - statically required to have the 'comparison' constraint. - The result of the comparison. - - - Generate a default value for any type. This is null for reference types, - For structs, this is struct value where all fields have the default value. - This function is unsafe in the sense that some F# values do not have proper null values. - - - Unboxes a strongly typed value. This is the inverse of box, unbox<t>(box<t> a) equals a. - The boxed value. - The unboxed result. - - - This module contains basic operations which do not apply runtime and/or static checks - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'decimal' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'float' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'float32' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'unativeint' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'nativeint' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint64' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int64' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint32' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int32' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint16' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int16' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'sbyte' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'byte' - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - Generate a range of values using the given zero, add, start, step and stop values - - - Generate a range of values using the given zero, add, start, step and stop values - - - Generate a range of char values - - - Generate a range of byte values - - - Generate a range of sbyte values - - - Generate a range of uint16 values - - - Generate a range of int16 values - - - Generate a range of unativeint values - - - Generate a range of nativeint values - - - Generate a range of uint32 values - - - Generate a range of uint64 values - - - Generate a range of int64 values - - - Generate a range of float32 values - - - Generate a range of float values - - - Generate a range of integers - - - Gets a slice from a string - The source string. - The index of the first character of the slice. - The index of the last character of the slice. - The substring from the given indices. - - - Sets a slice of an array - The target array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The start index of the fourth dimension. - The end index of the fourth dimension. - The source array. - - - Gets a slice of an array - The source array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The start index of the fourth dimension. - The end index of the fourth dimension. - The four dimensional sub array from the given indices. - - - Sets a slice of an array - The target array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The source array. - - - Gets a slice of an array - The source array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The three dimensional sub array from the given indices. - - - Sets a vector slice of a 2D array. The index of the second dimension is fixed. - The target array. - The start index of the first dimension. - The end index of the first dimension. - The index of the second dimension. - The source array. - - - Sets a vector slice of a 2D array. The index of the first dimension is fixed. - The target array. - The index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The source array. - - - Sets a region slice of an array - The target array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The source array. - - - Gets a vector slice of a 2D array. The index of the second dimension is fixed. - The source array. - The start index of the first dimension. - The end index of the first dimension. - The fixed index of the second dimension. - The sub array from the input indices. - - - Gets a vector slice of a 2D array. The index of the first dimension is fixed. - The source array. - The index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The sub array from the input indices. - - - Gets a region slice of an array - The source array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The two dimensional sub array from the input indices. - - - Sets a slice of an array - The target array. - The start index. - The end index. - The source array. - - - Gets a slice of an array - The input array. - The start index. - The end index. - The sub array from the input indices. - - - A module of compiler intrinsic functions for efficient implementations of F# integer ranges - and dynamic invocations of other F# operators - - - Basic F# Operators. This module is automatically opened in all F# code. - - - Invoke an F# first class function value that accepts five curried arguments - without intervening execution - The first arg. - The second arg. - The third arg. - The fourth arg. - The fifth arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept five curried arguments without intervening execution. - The input function. - The optimized function. - - - Construct an optimized function value that can accept five curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept five curried arguments - without intervening execution. This type should not typically used directly from - either F# code or from other CLI languages. - - - Invoke an F# first class function value that accepts four curried arguments - without intervening execution - The first arg. - The second arg. - The third arg. - The fourth arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept four curried arguments without intervening execution. - The input function. - The optimized function. - - - Construct an optimized function value that can accept four curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept four curried arguments - without intervening execution. This type should not typically used directly from - either F# code or from other CLI languages. - - - Invoke an F# first class function value that accepts three curried arguments - without intervening execution - The first arg. - The second arg. - The third arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept three curried arguments without intervening execution. - The input function. - The adapted function. - - - Construct an optimized function value that can accept three curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept - three iterated (curried) arguments without intervening execution. This type should not - typically used directly from either F# code or from other CLI languages. - - - Invoke the optimized function value with two curried arguments - The first arg. - The second arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept two curried arguments without intervening execution. - The input function. - The adapted function. - - - Construct an optimized function value that can accept two curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept - two iterated (curried) arguments without intervening execution. This type should not - typically used directly from either F# code or from other CLI languages. - - - An implementation module used to hold some private implementations of function - value invocation. - - - Convert an option to a potentially null value. - The input value. - The result value, which is null if the input was None. - - - Convert a potentially null value to an option. - The input value. - The result option. - - - Convert a Nullable value to an option. - The input nullable value. - The result option. - - - Convert the option to a Nullable value. - The input option. - The result value. - - - Convert the option to a list of length 0 or 1. - The input option. - The result list. - - - Convert the option to an array of length 0 or 1. - The input option. - The result array. - - - filter f inp evaluates to match inp with None -> None | Some x -> if f x then Some x else None. - A function that evaluates whether the value contained in the option should remain, or be filtered out. - The input option. - The input if the predicate evaluates to true; otherwise, None. - - - bind f inp evaluates to match inp with None -> None | Some x -> f x - A function that takes the value of type T from an option and transforms it into - an option containing a value of type U. - The input option. - An option of the output type of the binder. - - - map f inp evaluates to match inp with None -> None | Some x -> Some (f x). - A function to apply to the option value. - The input option. - An option of the input value after applying the mapping function, or None if the input is None. - - - iter f inp executes match inp with None -> () | Some x -> f x. - A function to apply to the option value. - The input option. - Unit if the option is None, otherwise it returns the result of applying the predicate - to the option value. - - - forall p inp evaluates to match inp with None -> true | Some x -> p x. - A function that evaluates to a boolean when given a value from the option type. - The input option. - True if the option is None, otherwise it returns the result of applying the predicate - to the option value. - - - exists p inp evaluates to match inp with None -> false | Some x -> p x. - A function that evaluates to a boolean when given a value from the option type. - The input option. - False if the option is None, otherwise it returns the result of applying the predicate - to the option value. - - - fold f inp s evaluates to match inp with None -> s | Some x -> f x s. - A function to update the state data when given a value from an option. - The input option. - The initial state. - The original state if the option is None, otherwise it returns the updated state with the folder - and the option value. - - - fold f s inp evaluates to match inp with None -> s | Some x -> f s x. - A function to update the state data when given a value from an option. - The initial state. - The input option. - The original state if the option is None, otherwise it returns the updated state with the folder - and the option value. - - - count inp evaluates to match inp with None -> 0 | Some _ -> 1. - The input option. - A zero if the option is None, a one otherwise. - - - Gets the value associated with the option. - The input option. - The value within the option. - Thrown when the option is None. - - - Returns true if the option is None. - The input option. - True if the option is None. - - - Returns true if the option is not None. - The input option. - True if the option is not None. - - - Basic operations on options. - - - Represents a statically-analyzed format associated with writing to a System.IO.TextWriter. The type parameter indicates the - arguments and return type of the format operation. - - - Represents a statically-analyzed format when formatting builds a string. The type parameter indicates the - arguments and return type of the format operation. - - - Represents a statically-analyzed format associated with writing to a System.Text.StringBuilder. The type parameter indicates the - arguments and return type of the format operation. - - - Represents a statically-analyzed format associated with writing to a System.IO.TextWriter. The first type parameter indicates the - arguments of the format operation and the last the overall return type. - - - Represents a statically-analyzed format when formatting builds a string. The first type parameter indicates the - arguments of the format operation and the last the overall return type. - - - Represents a statically-analyzed format associated with writing to a System.Text.StringBuilder. The first type parameter indicates the - arguments of the format operation and the last the overall return type. - - - Print to a string buffer and raise an exception with the given - result. Helper printers must return strings. - The input formatter. - The arguments of the formatter. - - - sprintf, but call the given 'final' function to generate the result. - See kprintf. - The function called to generate a result from the formatted string. - The input formatter. - The arguments of the formatter. - - - printf, but call the given 'final' function to generate the result. - For example, these let the printing force a flush after all output has - been entered onto the channel, but not before. - The function called after formatting to generate the format result. - The input formatter. - The arguments of the formatter. - - - fprintf, but call the given 'final' function to generate the result. - See kprintf. - The function called after formatting to generate the format result. - The input TextWriter. - The input formatter. - The arguments of the formatter. - - - bprintf, but call the given 'final' function to generate the result. - See kprintf. - The function called after formatting to generate the format result. - The input StringBuilder. - The input formatter. - The arguments of the formatter. - - - Print to a string via an internal string buffer and return - the result as a string. Helper printers must return strings. - The input formatter. - The formatted string. - - - Print to a text writer, adding a newline - The TextWriter to print to. - The input formatter. - The return type and arguments of the formatter. - - - Print to a text writer. - The TextWriter to print to. - The input formatter. - The return type and arguments of the formatter. - - - Print to a System.Text.StringBuilder - The StringBuilder to print to. - The input formatter. - The return type and arguments of the formatter. - - - Extensible printf-style formatting for numbers and other datatypes - - Format specifications are strings with "%" markers indicating format - placeholders. Format placeholders consist of: - - %[flags][width][.precision][type] - - where the type is interpreted as follows: - - %b: bool, formatted as "true" or "false" - %s: string, formatted as its unescaped contents - %c: character literal - %d, %i: any basic integer type formatted as a decimal integer, signed if the basic integer type is signed. - %u: any basic integer type formatted as an unsigned decimal integer - %x, %X, %o: any basic integer type formatted as an unsigned hexadecimal - (a-f)/Hexadecimal (A-F)/Octal integer - - %e, %E, %f, %F, %g, %G: - any basic floating point type (float,float32) formatted - using a C-style floating point format specifications, i.e - - %e, %E: Signed value having the form [-]d.dddde[sign]ddd where - d is a single decimal digit, dddd is one or more decimal - digits, ddd is exactly three decimal digits, and sign - is + or - - - %f: Signed value having the form [-]dddd.dddd, where dddd is one - or more decimal digits. The number of digits before the - decimal point depends on the magnitude of the number, and - the number of digits after the decimal point depends on - the requested precision. - - %g, %G: Signed value printed in f or e format, whichever is - more compact for the given value and precision. - - - %M: System.Decimal value - - %O: Any value, printed by boxing the object and using it's ToString method(s) - - %A: Any value, printed with the default layout settings - - %a: A general format specifier, requires two arguments: - (1) a function which accepts two arguments: - (a) a context parameter of the appropriate type for the - given formatting function (e.g. an #System.IO.TextWriter) - (b) a value to print - and which either outputs or returns appropriate text. - - (2) the particular value to print - - - %t: A general format specifier, requires one argument: - (1) a function which accepts a context parameter of the - appropriate type for the given formatting function (e.g. - an System.IO.TextWriter)and which either outputs or returns - appropriate text. - - Basic integer types are: - byte,sbyte,int16,uint16,int32,uint32,int64,uint64,nativeint,unativeint - Basic floating point types are: - float, float32 - - The optional width is an integer indicating the minimal width of the - result. For instance, %6d prints an integer, prefixing it with spaces - to fill at least 6 characters. If width is '*', then an extra integer - argument is taken to specify the corresponding width. - - any number - '*': - - Valid flags are: - - 0: add zeros instead of spaces to make up the required width - '-': left justify the result within the width specified - '+': add a '+' character if the number is positive (to match a '-' sign - for negatives) - ' ': add an extra space if the number is positive (to match a '-' - sign for negatives) - - The printf '#' flag is invalid and a compile-time error will be reported if it is used. - - - Returns the length of the string. - The input string. - The number of characters in the string. - - - Returns a string by concatenating count instances of str. - The number of copies of the input string will be copied. - The input string. - The concatenated string. - Thrown when count is negative. - - - Tests if any character of the string satisfies the given predicate. - The function to test each character of the string. - The input string. - True if any character returns true for the predicate and false otherwise. - - - Tests if all characters in the string satisfy the given predicate. - The function to test each character of the string. - The input string. - True if all characters return true for the predicate and false otherwise. - - - Builds a new string whose characters are the results of applying the function mapping - to each index from 0 to count-1 and concatenating the resulting - strings. - The number of strings to initialize. - The function to take an index and produce a string to - be concatenated with the others. - The constructed string. - Thrown when count is negative. - - - Builds a new string containing only the characters of the input string - for which the given predicate returns "true". - - Returns an empty string if the input string is null - - A function to test whether each character in the input sequence should be included in the output string. - The input string. - The resulting string. - - - Builds a new string whose characters are the results of applying the function mapping - to each of the characters of the input string and concatenating the resulting - strings. - The function to produce a string from each character of the input string. - The input string. - The concatenated string. - - - Builds a new string whose characters are the results of applying the function mapping - to each character and index of the input string. - The function to apply to each character and index of the string. - The input string. - The resulting string. - - - Builds a new string whose characters are the results of applying the function mapping - to each of the characters of the input string. - The function to apply to the characters of the string. - The input string. - The resulting string. - - - Applies the function action to the index of each character in the string and the - character itself. - The function to apply to each character and index of the string. - The input string. - - - Applies the function action to each character in the string. - The function to be applied to each character of the string. - The input string. - - - Returns a new string made by concatenating the given strings - with separator sep, that is a1 + sep + ... + sep + aN. - The separator string to be inserted between the strings - of the input sequence. - The sequence of strings to be concatenated. - A new string consisting of the concatenated strings separated by - the separation string. - Thrown when strings is null. - - - Functional programming operators for string processing. Further string operations - are available via the member functions on strings and other functionality in - System.String - and System.Text.RegularExpressions types. - - - - The SI unit of catalytic activity - - - - - The SI unit of does equivalent - - - - - The SI unit of absorbed dose - - - - - The SI unit of activity referred to a radionuclide - - - - - The SI unit of illuminance - - - - - The SI unit of luminous flux - - - - - The SI unit of inductance - - - - - The SI unit of magnetic flux density - - - - - The SI unit of magnetic flux - - - - - The SI unit of electric conductance - - - - - The SI unit of electric resistance - - - - - The SI unit of capacitance - - - - - The SI unit of electric potential difference, electromotive force - - - - - The SI unit of electric charge, amount of electricity - - - - - The SI unit of power, radiant flux - - - - - The SI unit of energy, work, amount of heat - - - - - The SI unit of pressure, stress - - - - - The SI unit of force - - - - - The SI unit of frequency - - - - - The SI unit of luminous intensity - - - - - The SI unit of amount of substance - - - - - The SI unit of thermodynamic temperature - - - - - The SI unit of electric current - - - - - The SI unit of time - - - - - The SI unit of mass - - - - - The SI unit of length - - - - - The SI unit of length - - - - - A synonym for henry, the SI unit of inductance - - - - - A synonym for katal, the SI unit of catalytic activity - - - - - A synonym for sievert, the SI unit of does equivalent - - - - - A synonym for gray, the SI unit of absorbed dose - - - - - A synonym for becquerel, the SI unit of activity referred to a radionuclide - - - - - A synonym for lux, the SI unit of illuminance - - - - - A synonym for lumen, the SI unit of luminous flux - - - - - A synonym for tesla, the SI unit of magnetic flux density - - - - - A synonym for weber, the SI unit of magnetic flux - - - - - A synonym for UnitNames.ohm, the SI unit of electric resistance. - - - - - A synonym for siemens, the SI unit of electric conductance - - - - - A synonym for farad, the SI unit of capacitance - - - - - A synonym for volt, the SI unit of electric potential difference, electromotive force - - - - - A synonym for coulomb, the SI unit of electric charge, amount of electricity - - - - - A synonym for watt, the SI unit of power, radiant flux - - - - - A synonym for joule, the SI unit of energy, work, amount of heat - - - - - A synonym for pascal, the SI unit of pressure, stress - - - - - A synonym for newton, the SI unit of force - - - - - A synonym for hertz, the SI unit of frequency - - - - - A synonym for candela, the SI unit of luminous intensity - - - - - A synonym for mole, the SI unit of amount of substance - - - - - A synonym for kelvin, the SI unit of thermodynamic temperature - - - - - A synonym for ampere, the SI unit of electric current - - - - - A synonym for second, the SI unit of time - - - - - A synonym for kilogram, the SI unit of mass - - - - - A synonym for Metre, the SI unit of length - - - - - A method used to support the F# query syntax. Returns an empty sequence that has the specified type argument. - - - - - A method used to support the F# query syntax. Returns a sequence that contains the specified values. - - - - - A method used to support the F# query syntax. Returns a sequence of length one that contains the specified value. - - - - A query operator that selects those elements based on a specified predicate. - - - - A query operator that performs a subsequent ordering of the elements selected so far in descending order by the given nullable sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - - - - A query operator that performs a subsequent ordering of the elements selected so far in ascending order by the given nullable sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - - - - A query operator that performs a subsequent ordering of the elements selected so far in descending order by the given sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - - - - A query operator that performs a subsequent ordering of the elements selected so far in ascending order by the given sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - - - - A query operator that selects elements from a sequence as long as a specified condition is true, and then skips the remaining elements. - - - - A query operator that selects a specified number of contiguous elements from those selected so far. - - - - A query operator that selects a nullable value for each element selected so far and returns the sum of these values. - If any nullable does not have a value, it is ignored. - - - - A query operator that selects a value for each element selected so far and returns the sum of these values. - - - - - A method used to support the F# query syntax. Inputs to queries are implicitly wrapped by a call to one of the overloads of this method. - - - - - A method used to support the F# query syntax. Inputs to queries are implicitly wrapped by a call to one of the overloads of this method. - - - - A query operator that sorts the elements selected so far in descending order by the given nullable sorting key. - - - - A query operator that sorts the elements selected so far in ascending order by the given nullable sorting key. - - - - A query operator that sorts the elements selected so far in descending order by the given sorting key. - - - - A query operator that sorts the elements selected so far in ascending order by the given sorting key. - - - - A query operator that bypasses elements in a sequence as long as a specified condition is true and then selects the remaining elements. - - - - A query operator that bypasses a specified number of the elements selected so far and selects the remaining elements. - - - - A query operator that projects each of the elements selected so far. - - - - - A method used to support the F# query syntax. Runs the given quotation as a query using LINQ IQueryable rules. - - - - - A method used to support the F# query syntax. Indicates that the query should be passed as a quotation to the Run method. - - - - A query operator that selects the element at a specified index amongst those selected so far. - - - - A query operator that selects a nullable value for each element selected so far and returns the minimum of these values. - If any nullable does not have a value, it is ignored. - - - - A query operator that selects a value for each element selected so far and returns the minimum resulting value. - - - - A query operator that selects a nullable value for each element selected so far and returns the maximum of these values. - If any nullable does not have a value, it is ignored. - - - - A query operator that selects a value for each element selected so far and returns the maximum resulting value. - - - - A query operator that correlates two sets of selected values based on matching keys and groups the results. - If any group is empty, a group with a single default value is used instead. - Normal usage is 'leftOuterJoin y in elements2 on (key1 = key2) into group'. - - - - A query operator that selects the last element of those selected so far, or a default value if no element is found. - - - - A query operator that selects the last element of those selected so far. - - - - A query operator that correlates two sets of selected values based on matching keys. - Normal usage is 'join y in elements2 on (key1 = key2)'. - - - - A query operator that selects the first element of those selected so far, or a default value if the sequence contains no elements. - - - - A query operator that selects the first element from those selected so far. - - - - A query operator that selects a value for each element selected so far and groups the elements by the given key. - - - - A query operator that correlates two sets of selected values based on matching keys and groups the results. - Normal usage is 'groupJoin y in elements2 on (key1 = key2) into group'. - - - - A query operator that groups the elements selected so far according to a specified key selector. - - - - - A method used to support the F# query syntax. Projects each element of a sequence to another sequence and combines the resulting sequences into one sequence. - - - - A query operator that selects the first element selected so far that satisfies a specified condition. - - - - A query operator that determines whether any element selected so far satisfies a condition. - - - - A query operator that selects the single, specific element of those selected so far, or a default value if that element is not found. - - - - A query operator that selects the single, specific element selected so far - - - - A query operator that selects distinct elements from the elements selected so far. - - - - A query operator that returns the number of selected elements. - - - - A query operator that determines whether the selected elements contains a specified element. - - - - A query operator that selects a nullable value for each element selected so far and returns the average of these values. - If any nullable does not have a value, it is ignored. - - - - A query operator that selects a value for each element selected so far and returns the average of these values. - - - - A query operator that determines whether all elements selected so far satisfies a condition. - - - - Create an instance of this builder. Use 'query { ... }' to use the query syntax. - - - - The type used to support the F# query syntax. Use 'query { ... }' to use the query syntax. - - - - - A property used to support the F# query syntax. - - - - - A method used to support the F# query syntax. - - - - - A partial input or result in an F# query. This type is used to support the F# query syntax. - - - - Converts the argument to character. Numeric inputs are converted according to the UTF-16 - encoding for characters. The operation requires an appropriate static conversion method on the input type. - The input value. - The converted char. - - - Converts the argument to System.Decimal using a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted decimal. - - - Converts the argument to unsigned native integer using a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted unativeint - - - Converts the argument to signed native integer. This is a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted nativeint - - - Converts the argument to 64-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float - - - Converts the argument to 32-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float32 - - - Converts the argument to 64-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float - - - Converts the argument to 32-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float32 - - - Converts the argument to unsigned 64-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint64 - - - Converts the argument to signed 64-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int64 - - - Converts the argument to unsigned 32-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint32 - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int32 - - - Converts the argument to a particular enum type. - The input value. - The converted enum type. - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int - - - Converts the argument to unsigned 16-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint16 - - - Converts the argument to signed 16-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int16 - - - Converts the argument to signed byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to signed byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - Converts the argument to byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - - Functions for converting nullable values - - - - - The division operator where a nullable value appears on both left and right sides - - - - - The division operator where a nullable value appears on the right - - - - - The division operator where a nullable value appears on the left - - - - - The modulus operator where a nullable value appears on both left and right sides - - - - - The modulus operator where a nullable value appears on the right - - - - - The modulus operator where a nullable value appears on the left - - - - - The multiplication operator where a nullable value appears on both left and right sides - - - - - The multiplication operator where a nullable value appears on the right - - - - - The multiplication operator where a nullable value appears on the left - - - - - The subtraction operator where a nullable value appears on both left and right sides - - - - - The subtraction operator where a nullable value appears on the right - - - - - The subtraction operator where a nullable value appears on the left - - - - - The addition operator where a nullable value appears on both left and right sides - - - - - The addition operator where a nullable value appears on the right - - - - - The addition operator where a nullable value appears on the left - - - - - The '<>' operator where a nullable value appears on both left and right sides - - - - - The '=' operator where a nullable value appears on both left and right sides - - - - - The '<' operator where a nullable value appears on both left and right sides - - - - - The '<=' operator where a nullable value appears on both left and right sides - - - - - The '>' operator where a nullable value appears on both left and right sides - - - - - The '>=' operator where a nullable value appears on both left and right sides - - - - - The '<>' operator where a nullable value appears on the right - - - - - The '=' operator where a nullable value appears on the right - - - - - The '<' operator where a nullable value appears on the right - - - - - The '<=' operator where a nullable value appears on the right - - - - - The '>' operator where a nullable value appears on the right - - - - - The '>=' operator where a nullable value appears on the right - - - - - The '<>' operator where a nullable value appears on the left - - - - - The '=' operator where a nullable value appears on the left - - - - - The '<' operator where a nullable value appears on the left - - - - - The '<=' operator where a nullable value appears on the left - - - - - The '>' operator where a nullable value appears on the left - - - - - The '>=' operator where a nullable value appears on the left - - - - - Operators for working with nullable values - - - - - A method used to support the F# query syntax. Runs the given quotation as a query using LINQ IEnumerable rules. - - - - - A method used to support the F# query syntax. Runs the given quotation as a query using LINQ rules. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - A type used to reconstruct a grouping after applying a mutable->immutable mapping transformation - on a result of a query. - - - - - The generic MethodInfo for Select function - Describes how we got from productions of immutable objects to productions of anonymous objects, with enough information - that we can invert the process in final query results. - - - - - Given the expression part of a "yield" or "select" which produces a result in terms of immutable tuples or immutable records, - generate an equivalent expression yielding anonymous objects. Also return the conversion for the immutable-to-mutable correspondence - so we can reverse this later. - - - - - Simplify gets of tuples and gets of record fields. - - - - - Cleanup the use of property-set object constructions in leaf expressions that form parts of F# queries. - - - - - Given an type involving immutable tuples and records, logically corresponding to the type produced at a - "yield" or "select", convert it to a type involving anonymous objects according to the conversion data. - - - - - Recognize anonymous type construction written using 'new AnonymousObject(<e1>, <e2>, ...)' - - - - - Recognize object construction written using 'new O(Prop1 = <e>, Prop2 = <e>, ...)' - - - - - Tests whether a list consists only of assignments of properties of the - given variable, null values (ignored) and ends by returning the given variable - (pattern returns only property assignments) - - - - - Recognize sequential series written as (... ((<e>; <e>); <e>); ...) - - - - - A runtime helper used to evaluate nested quotation literals. - - - - - A runtime helper used to evaluate nested quotation literals. - - - - - Evaluates a subset of F# quotations by first converting to a LINQ expression, for the subset of LINQ expressions represented by the - expression syntax in the C# language. - - - - - Converts a subset of F# quotations to a LINQ expression, for the subset of LINQ expressions represented by the - expression syntax in the C# language. - - - - - Converts a subset of F# quotations to a LINQ expression, for the subset of LINQ expressions represented by the - expression syntax in the C# language. - - - - - When used in a quotation, this function indicates a specific conversion - should be performed when converting the quotation to a LINQ expression. - - This function should not be called directly. - - - - - When used in a quotation, this function indicates a specific conversion - should be performed when converting the quotation to a LINQ expression. - - This function should not be called directly. - - - - - When used in a quotation, this function indicates a specific conversion - should be performed when converting the quotation to a LINQ expression. - - This function should not be called directly. - - - - - Abstract internal type - - - - Allocates a region of memory on the stack. - The number of objects of type T to allocate. - A typed pointer to the allocated memory. - - - Assigns the value into the memory location referenced by the typed native - pointer computed by adding index * sizeof<'T> to the given input pointer. - The input pointer. - The index by which to offset the pointer. - The value to assign. - - - Assigns the value into the memory location referenced by the given typed native pointer. - The input pointer. - The value to assign. - - - Dereferences the given typed native pointer. - The input pointer. - The value at the pointer address. - - - Dereferences the typed native pointer computed by adding index * sizeof<'T> to the - given input pointer. - The input pointer. - The index by which to offset the pointer. - The value at the pointer address. - - - Returns a typed native pointer by adding index * sizeof<'T> to the - given input pointer. - The input pointer. - The index by which to offset the pointer. - A typed pointer. - - - Returns a machine address for a given typed native pointer. - The input pointer. - The machine address. - - - Returns a typed native pointer for a given machine address. - The pointer address. - A typed pointer. - - - Contains operations on native pointers. Use of these operators may - result in the generation of unverifiable code. - - - Gets the raw expression associated with this type-carrying expression - - - Type-carrying quoted expressions. Expressions are generated either - by quotations in source text or programatically - - - Returns type of an expression. - - - Returns the custom attributes of an expression. - - - Builds an expression that represents a value and its associated reflected definition as a quotation - The untyped object. - The type of the object. - The definition of the value being quoted. - The resulting expression. - - - Builds an expression that represents a value and its associated reflected definition as a quotation - The value being quoted. - The definition of the value being quoted. - The resulting expression. - - - Builds an expression that represents a while loop - The predicate to control the loop iteration. - The body of the while loop. - The resulting expression. - - - Builds an expression that represents setting a mutable variable - The input variable. - The value to set. - The resulting expression. - - - Builds an expression that represents a variable - The input variable. - The resulting expression. - - - Builds an expression that represents a constant value of a particular type, arising from a variable of the given name - The untyped object. - The type of the object. - The name of the variable. - The resulting expression. - - - Builds an expression that represents a constant value, arising from a variable of the given name - The typed value. - The name of the variable. - The resulting expression. - - - Builds an expression that represents a constant value - The typed value. - The resulting expression. - - - Builds an expression that represents a constant value of a particular type - The untyped object. - The type of the object. - The resulting expression. - - - Builds an expression that represents a test of a value is of a particular union case - The expression to test. - The description of the union case. - The resulting expression. - - - Builds an expression that represents a type test. - The expression to test. - The target type. - The resulting expression. - - - Builds an expression that represents getting a field of a tuple - The input tuple. - The index of the tuple element to get. - The resulting expression. - - - Builds an expression that represents a try/with construct for exception filtering and catching. - The body of the try expression. - - - The variable to bind to a caught exception. - The expression evaluated when an exception is caught. - The resulting expression. - - - Try and find a stored reflection definition for the given method. Stored reflection - definitions are added to an F# assembly through the use of the [<ReflectedDefinition>] attribute. - The description of the method to find. - The reflection definition or None if a match could not be found. - - - Builds an expression that represents a try/finally construct - The body of the try expression. - The final part of the expression to be evaluated. - The resulting expression. - - - Format the expression as a string - Indicates if method, property, constructor and type objects should be printed in detail. If false, these are abbreviated to their name. - The formatted string. - - - Substitutes through the given expression using the given functions - to map variables to new values. The functions must give consistent results - at each application. Variable renaming may occur on the target expression - if variable capture occurs. - The function to map variables into expressions. - The expression with the given substitutions. - - - Builds an expression that represents the sequential execution of one expression followed by another - The first expression. - The second expression. - The resulting expression. - - - Permits interactive environments such as F# Interactive - to explicitly register new pickled resources that represent persisted - top level definitions. - The assembly associated with the resource. - The unique name for the resources being added. - The type definitions referenced. - The serialized resource to register with the environment. - - - Permits interactive environments such as F# Interactive - to explicitly register new pickled resources that represent persisted - top level definitions. - The assembly associated with the resource. - The unique name for the resources being added. - The serialized resource to register with the environment. - - - Builds an expression that represents a nested typed quotation literal - The expression being quoted. - The resulting expression. - - - Builds an expression that represents a nested raw quotation literal - The expression being quoted. - The resulting expression. - - - Builds an expression that represents a nested typed or raw quotation literal - The expression being quoted. - The resulting expression. - - - Builds an expression that represents writing to a static property - The description of the property. - The value to set. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents writing to a property of an object - The input object. - The description of the property. - The value to set. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents reading a static property - The description of the property. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents reading a property of an object - The input object. - The description of the property. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents the creation of a union case value - The description of the union case. - The list of arguments for the case. - The resulting expression. - - - Builds an expression that represents the creation of an F# tuple value - The list of elements of the tuple. - The resulting expression. - - - Builds record-construction expressions - The type of record. - The list of elements of the record. - The resulting expression. - - - Builds an expression that represents the invocation of an object constructor - The description of the constructor. - The list of arguments to the constructor. - The resulting expression. - - - Builds an expression that represents the creation of a delegate value for the given type - The type of delegate. - The parameters for the delegate. - The body of the function. - The resulting expression. - - - Builds an expression that represents the creation of an array value initialized with the given elements - The type for the elements of the array. - The list of elements of the array. - The resulting expression. - - - Builds recursives expressions associated with 'let rec' constructs - The list of bindings for the let expression. - The sub-expression where the bindings are in scope. - The resulting expression. - - - Builds expressions associated with 'let' constructs - The variable in the let expression. - The expression bound to the variable. - The sub-expression where the binding is in scope. - The resulting expression. - - - Builds an expression that represents the constrution of an F# function value - The parameter to the function. - The body of the function. - The resulting expression. - - - Builds 'if ... then ... else' expressions. - The condition expression. - The then sub-expression. - The else sub-expression. - The resulting expression. - - - Fetches or creates a new variable with the given name and type from a global pool of shared variables - indexed by name and type. The type is given by the expicit or inferred type parameter - The variable name. - The created of fetched typed global variable. - - - Gets the free expression variables of an expression as a list. - A sequence of the free variables in the expression. - - - Builds a 'for i = ... to ... do ...' expression that represent loops over integer ranges - The sub-expression declaring the loop variable. - The sub-expression setting the initial value of the loop variable. - The sub-expression declaring the final value of the loop variable. - The sub-expression representing the body of the loop. - The resulting expression. - - - Builds an expression that represents writing to a field of an object - The input object. - The description of the field to write to. - The value to set to the field. - The resulting expression. - - - Builds an expression that represents writing to a static field - The description of the field to write to. - The value to the set to the field. - The resulting expression. - - - Builds an expression that represents the access of a field of an object - The input object. - The description of the field to access. - The resulting expression. - - - Builds an expression that represents the access of a static field - The description of the field to access. - The resulting expression. - - - This function is called automatically when quotation syntax (<@ @>) and other sources of - quotations are used. - A type in the assembly where the quotation occurs. - The type definitions referenced. - The spliced types, to replace references to type variables. - The spliced expressions to replace references to spliced expressions. - The serialized form of the quoted expression. - The resulting expression. - - - This function is called automatically when quotation syntax (<@ @>) and other sources of - quotations are used. - A type in the assembly where the quotation occurs. - The spliced types, to replace references to type variables. - The spliced expressions to replace references to spliced expressions. - The serialized form of the quoted expression. - The resulting expression. - - - Builds an expression that represents the invocation of a default object constructor - The type on which the constructor is invoked. - The resulting expression. - - - Builds an expression that represents the coercion of an expression to a type - The expression to coerce. - The target type. - The resulting expression. - - - Returns a new typed expression given an underlying runtime-typed expression. - A type annotation is usually required to use this function, and - using an incorrect type annotation may result in a later runtime exception. - The expression to cast. - The resulting typed expression. - - - Builds an expression that represents a call to an instance method associated with an object - The input object. - The description of the method to call. - The list of arguments to the method. - The resulting expression. - - - Builds an expression that represents a call to an static method or module-bound function - The MethodInfo describing the method to call. - The list of arguments to the method. - The resulting expression. - - - Builds an expression that represents the application of a first class function value to multiple arguments - The function to apply. - The list of lists of arguments to the function. - The resulting expression. - - - Builds an expression that represents the application of a first class function value to a single argument. - The function to apply. - The argument to the function. - The resulting expression. - - - Builds an expression that represents setting the value held at a particular address. - The target expression. - The value to set at the address. - The resulting expression. - - - Builds an expression that represents getting the address of a value. - The target expression. - The resulting expression. - - - Quoted expressions annotated with System.Type values. - - - The type associated with the variable - - - The declared name of the variable - - - Indicates if the variable represents a mutable storage location - - - Fetches or create a new variable with the given name and type from a global pool of shared variables - indexed by name and type - The name of the variable. - The type associated with the variable. - The retrieved or created variable. - - - Creates a new variable with the given name, type and mutability - The declared name of the variable. - The type associated with the variable. - Indicates if the variable represents a mutable storage location. Default is false. - The created variable. - - - Information at the binding site of a variable - - - Re-build combination expressions. The first parameter should be an object - returned by the ShapeCombination case of the active pattern in this module. - The input shape. - The list of arguments. - The rebuilt expression. - - - An active pattern that performs a complete decomposition viewing the expression tree as a binding structure - The input expression. - The decomposed Var, Lambda, or ConstApp. - - - Active patterns for traversing, visiting, rebuilding and tranforming expressions in a generic way - - - An active pattern to recognize property setters that have an associated ReflectedDefinition - The description of the property. - The expression of the method definition if found, or None. - - - An active pattern to recognize property getters or values in modules that have an associated ReflectedDefinition - The description of the property. - The expression of the method definition if found, or None. - - - An active pattern to recognize methods that have an associated ReflectedDefinition - The description of the method. - The expression of the method definition if found, or None. - - - A parameterized active pattern to recognize calls to a specified function or method. - The returned elements are the optional target object (present if the target is an - instance method), the generic type instantation (non-empty if the target is a generic - instantiation), and the arguments to the function or method. - The input template expression to specify the method to call. - The optional target object (present if the target is an - instance method), the generic type instantation (non-empty if the target is a generic - instantiation), and the arguments to the function or method. - - - An active pattern to recognize constant decimal expressions - The input expression to match against. - decimal option - - - An active pattern to recognize constant unsigned int64 expressions - The input expression to match against. - uint64 option - - - An active pattern to recognize constant int64 expressions - The input expression to match against. - int64 option - - - An active pattern to recognize constant unsigned int32 expressions - The input expression to match against. - uint32 option - - - An active pattern to recognize constant int32 expressions - The input expression to match against. - int32 option - - - An active pattern to recognize constant unsigned int16 expressions - The input expression to match against. - uint16 option - - - An active pattern to recognize constant int16 expressions - The input expression to match against. - int16 option - - - An active pattern to recognize constant byte expressions - The input expression to match against. - byte option - - - An active pattern to recognize constant signed byte expressions - The input expression to match against. - sbyte option - - - An active pattern to recognize constant unicode character expressions - The input expression to match against. - char option - - - An active pattern to recognize constant 64-bit floating point number expressions - The input expression to match against. - float option - - - An active pattern to recognize constant 32-bit floating point number expressions - The input expression to match against. - float32 option - - - An active pattern to recognize constant string expressions - The input expression to match against. - string option - - - An active pattern to recognize constant boolean expressions - The input expression to match against. - bool option - - - An active pattern to recognize () constant expressions - The input expression to match against. - unit option - - - An active pattern to recognize expressions of the form a || b - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions of the form a && b - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent the application of a (possibly curried or tupled) first class function value - The input expression to match against. - (Expr * Expr list list) option - - - An active pattern to recognize expressions that represent a (possibly curried or tupled) first class function value - The input expression to match against. - (Var list list * Expr) option - - - Contains a set of derived F# active patterns to analyze F# expression objects - - - An active pattern to recognize expressions that represent setting a mutable variable - The input expression to match against. - (Var * Expr) option - - - An active pattern to recognize expressions that represent a variable - The input expression to match against. - Var option - - - An active pattern to recognize expressions that are a value with an associated definition - The input expression to match against. - The boxed value, its static type and its definition - - - An active pattern to recognize expressions that represent a constant value - The input expression to match against. - The boxed value, its static type and its name - - - An active pattern to recognize expressions that represent a constant value. This also matches expressions matched by ValueWithName. - The input expression to match against. - The boxed value and its static type - - - An active pattern to recognize expressions that represent a test if a value is of a particular union case - The input expression to match against. - The expression and union case being tested - - - An active pattern to recognize expressions that represent a dynamic type test - The input expression to match against. - The expression and type being tested - - - An active pattern to recognize expressions that represent getting a tuple field - The input expression to match against. - The expression and tuple field being accessed - - - An active pattern to recognize expressions that represent a try/finally construct - The input expression to match against. - The body and handler parts of the try/finally expression - - - An active pattern to recognize expressions that represent a try/with construct for exception filtering and catching - The input expression to match against. - (Expr * Var * Expr * Var * Expr) option - - - An active pattern to recognize expressions that represent sequential exeuction of one expression followed by another - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent a nested typed quotation literal - The input expression to match against. - Expr option - - - An active pattern to recognize expressions that represent a nested raw quotation literal - The input expression to match against. - Expr option - - - An active pattern to recognize expressions that represent a nested quotation literal - The input expression to match against. - Expr option - - - An active pattern to recognize expressions that represent setting a static or instance property, or a non-function value declared in a module - The input expression to match against. - (Expr option * PropertyInfo * Expr list * Expr) option - - - An active pattern to recognize expressions that represent the read of a static or instance property, or a non-function value declared in a module - The input expression to match against. - (Expr option * PropertyInfo * Expr list) option - - - An active pattern to recognize expressions that represent construction of tuple values - The input expression to match against. - (Expr list) option - - - An active pattern to recognize expressions that represent construction of particular union case values - The input expression to match against. - (UnionCaseInfo * Expr list) option - - - An active pattern to recognize expressions that represent construction of record values - The input expression to match against. - (Type * Expr list) option - - - An active pattern to recognize expressions that represent invocation of object constructors - The input expression to match against. - (ConstructorInfo * Expr list) option - - - An active pattern to recognize expressions that represent construction of delegate values - The input expression to match against. - (Type * Var list * Expr) option - - - An active pattern to recognize expressions that represent invocations of a default constructor of a struct - The input expression to match against. - Type option - - - An active pattern to recognize expressions that represent the construction of arrays - The input expression to match against. - (Type * Expr list) option - - - An active pattern to recognize expressions that represent recursive let bindings of one or more variables - The input expression to match against. - ((Var * Expr) list * Expr) option - - - An active pattern to recognize expressions that represent let bindings - The input expression to match against. - (Var * Expr * Expr) option - - - An active pattern to recognize expressions that represent first class function values - The input expression to match against. - (Var * Expr) option - - - An active pattern to recognize expressions that represent conditionals - The input expression to match against. - (Expr * Expr * Expr) option - - - An active pattern to recognize expressions that represent while loops - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent loops over integer ranges - The input expression to match against. - (Var * Expr * Expr * Expr) option - - - An active pattern to recognize expressions that represent setting a static or instance field - The input expression to match against. - (Expr option * FieldInfo * Expr) option - - - An active pattern to recognize expressions that represent getting a static or instance field - The input expression to match against. - (Expr option * FieldInfo) option - - - An active pattern to recognize expressions that represent coercions from one type to another - The input expression to match against. - (Expr * Type) option - - - An active pattern to recognize expressions that represent calls to static and instance methods, and functions defined in modules - The input expression to match against. - (Expr option * MethodInfo * Expr list) option - - - An active pattern to recognize expressions that represent applications of first class function values - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent setting the value held at an address - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent getting the address of a value - The input expression to match against. - Expr option - - - Contains a set of primitive F# active patterns to analyze F# expression objects - - - Returns a System.Type representing an F# tuple type with the given element types - An array of types for the tuple elements. - The type representing the tuple containing the input elements. - - - Returns a System.Type representing the F# function type with the given domain and range - The input type of the function. - The output type of the function. - The function type with the given domain and range. - - - Return true if the typ is a representation of an F# tuple type - The type to check. - True if the type check succeeds. - - - Return true if the typ is a System.Type value corresponding to the compiled form of an F# module - The type to check. - True if the type check succeeds. - - - Return true if the typ is a representation of an F# function type or the runtime type of a closure implementing an F# function type - The type to check. - True if the type check succeeds. - - - Gets the tuple elements from the representation of an F# tuple type. - The input tuple type. - An array of the types contained in the given tuple type. - - - Gets the domain and range types from an F# function type or from the runtime type of a closure implementing an F# type - The input function type. - A tuple of the domain and range types of the input function. - - - Contains operations associated with constructing and analyzing F# types such as records, unions and tuples - - - Precomputes a function for reading the values of a particular tuple type - - Assumes the given type is a TupleType. - If not, ArgumentException is raised during pre-computation. - The tuple type to read. - Thrown when the given type is not a tuple type. - A function to read values of the given tuple type. - - - Gets information that indicates how to read a field of a tuple - The input tuple type. - The index of the tuple element to describe. - The description of the tuple element and an optional type and index if the tuple is big. - - - Gets a method that constructs objects of the given tuple type. - For small tuples, no additional type will be returned. - - For large tuples, an additional type is returned indicating that - a nested encoding has been used for the tuple type. In this case - the suffix portion of the tuple type has the given type and an - object of this type must be created and passed as the last argument - to the ConstructorInfo. A recursive call to PreComputeTupleConstructorInfo - can be used to determine the constructor for that the suffix type. - The input tuple type. - The description of the tuple type constructor and an optional extra type - for large tuples. - - - Precomputes a function for reading the values of a particular tuple type - - Assumes the given type is a TupleType. - If not, ArgumentException is raised during pre-computation. - The type of tuple to read. - Thrown when the given type is not a tuple type. - A function to read a particular tuple type. - - - Precompute a function for reading a particular field from a record. - Assumes the given type is a RecordType with a field of the given name. - If not, ArgumentException is raised during pre-computation. - - Using the computed function will typically be faster than executing a corresponding call to Value.GetInfo - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The PropertyInfo of the field to read. - Thrown when the input type is not a record type. - A function to read the specified field from the record. - - - Creates an instance of a tuple type - - Assumes at least one element is given. If not, ArgumentException is raised. - The array of tuple fields. - The tuple type to create. - Thrown if no elements are given. - An instance of the tuple type with the given elements. - - - Builds a typed function from object from a dynamic function implementation - The function type of the implementation. - The untyped lambda of the function implementation. - A typed function from the given dynamic implementation. - - - Reads all fields from a tuple. - - Assumes the given input is a tuple value. If not, ArgumentException is raised. - The input tuple. - Thrown when the input is not a tuple value. - An array of the fields from the given tuple. - - - Reads a field from a tuple value. - - Assumes the given input is a tuple value. If not, ArgumentException is raised. - The input tuple. - The index of the field to read. - The value of the field. - - - Reads a field from a record value. - - Assumes the given input is a record value. If not, ArgumentException is raised. - The record object. - The PropertyInfo describing the field to read. - Thrown when the input type is not a record type. - The field from the record. - - - Contains operations associated with constructing and analyzing values associated with F# types - such as records, unions and tuples. - - - The integer tag for the case. - - - The name of the case. - - - The type in which the case occurs. - - - The fields associated with the case, represented by a PropertyInfo. - The fields associated with the case. - - - Returns the custom attributes associated with the case matching the given attribute type. - The type of attributes to return. - An array of custom attributes. - - - Returns the custom attributes associated with the case. - An array of custom attributes. - - - Represents a case of a discriminated union type - - - Returns true if the typ is a representation of an F# exception declaration - The type to check. - Optional flag that denotes accessibility of the private representation. - True if the type check is an F# exception. - - - Reads all the fields from an F# exception declaration, in declaration order - - Assumes exceptionType is an exception representation type. If not, ArgumentException is raised. - The exception type to read. - Optional flag that denotes accessibility of the private representation. - Thrown if the given type is not an exception. - An array containing the PropertyInfo of each field in the exception. - - - Returns true if the typ is a representation of an F# union type or the runtime type of a value of that type - The type to check. - Optional flag that denotes accessibility of the private representation. - True if the type check succeeds. - - - Return true if the typ is a representation of an F# record type - The type to check. - Optional flag that denotes accessibility of the private representation. - True if the type check succeeds. - - - Gets the cases of a union type. - - Assumes the given type is a union type. If not, ArgumentException is raised during pre-computation. - The input union type. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a union type. - An array of descriptions of the cases of the given union type. - - - Reads all the fields from a record value, in declaration order - - Assumes the given input is a record value. If not, ArgumentException is raised. - The input record type. - Optional flag that denotes accessibility of the private representation. - An array of descriptions of the properties of the record type. - - - Reads all the fields from a value built using an instance of an F# exception declaration - - Assumes the given input is an F# exception value. If not, ArgumentException is raised. - The exception instance. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not an F# exception. - The fields from the given exception. - - - A method that constructs objects of the given case - The description of the union case. - Optional flag that denotes accessibility of the private representation. - The description of the constructor of the given union case. - - - Precomputes a function for constructing a discriminated union value for a particular union case. - The description of the union case. - Optional flag that denotes accessibility of the private representation. - A function for constructing values of the given union case. - - - Precomputes a function for reading all the fields for a particular discriminator case of a union type - - Using the computed function will typically be faster than executing a corresponding call to GetFields - The description of the union case to read. - Optional flag that denotes accessibility of the private representation. - A function to for reading the fields of the given union case. - - - Precompute a property or static method for reading an integer representing the case tag of a union type. - The type of union to read. - Optional flag that denotes accessibility of the private representation. - The description of the union case reader. - - - Assumes the given type is a union type. - If not, ArgumentException is raised during pre-computation. - - Using the computed function is more efficient than calling GetUnionCase - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The type of union to optimize reading. - Optional flag that denotes accessibility of the private representation. - An optimized function to read the tags of the given union type. - - - Identify the union case and its fields for an object - - Assumes the given input is a union case value. If not, ArgumentException is raised. - - If the type is not given, then the runtime type of the input object is used to identify the - relevant union type. The type should always be given if the input object may be null. For example, - option values may be represented using the 'null'. - The input union case. - The union type containing the value. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a union case value. - The description of the union case and its fields. - - - Create a union case value. - The description of the union case to create. - The array of arguments to construct the given case. - Optional flag that denotes accessibility of the private representation. - The constructed union case. - - - Get a ConstructorInfo for a record type - The record type. - Optional flag that denotes accessibility of the private representation. - A ConstructorInfo for the given record type. - - - Precompute a function for constructing a record value. - - Assumes the given type is a RecordType. - If not, ArgumentException is raised during pre-computation. - The type of record to construct. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - A function to construct records of the given type. - - - Precompute a function for reading all the fields from a record. The fields are returned in the - same order as the fields reported by a call to Microsoft.FSharp.Reflection.Type.GetInfo for - this type. - - Assumes the given type is a RecordType. - If not, ArgumentException is raised during pre-computation. - - Using the computed function will typically be faster than executing a corresponding call to Value.GetInfo - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The type of record to read. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - An optimized reader for the given record type. - - - Reads all the fields from a record value. - - Assumes the given input is a record value. If not, ArgumentException is raised. - The record object. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - The array of fields from the record. - - - Creates an instance of a record type. - - Assumes the given input is a record type. - The type of record to make. - The array of values to initialize the record. - Optional flags that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - The created record. - - - - A record of options to control structural formatting. - For F# Interactive properties matching those of this value can be accessed via the 'fsi' - value. - - Floating Point format given in the same format accepted by System.Double.ToString, - e.g. f6 or g15. - - If ShowProperties is set the printing process will evaluate properties of the values being - displayed. This may cause additional computation. - - The ShowIEnumerable is set the printing process will force the evalution of IEnumerable objects - to a small, finite depth, as determined by the printing parameters. - This may lead to additional computation being performed during printing. - - <example> - From F# Interactive the default settings can be adjusted using, for example, - <pre> - open Microsoft.FSharp.Compiler.Interactive.Settings;; - setPrintWidth 120;; - </pre> - </example> - - - - - Data representing structured layouts of terms. - - - - - Convert any value to a layout using the given formatting options. The - layout can then be processed using formatting display engines such as - those in the LayoutOps module. any_to_string and output_any are - built using any_to_layout with default format options. - - - - - Ouput any value to a channel using the same set of formatting rules - as any_to_string - - - - - Convert any value to a string using a standard formatter - Data is typically formatted in a structured format, e.g. - lists are formatted using the "[1;2]" notation. - The details of the format are not specified and may change - from version to version and according to the flags given - to the F# compiler. The format is intended to be human-readable, - not machine readable. If alternative generic formats are required - you should develop your own formatter, using the code in the - implementation of this file as a starting point. - - Data from other .NET languages is formatted using a virtual - call to Object.ToString() on the boxed version of the input. - - - - - For limitting layout of list-like sequences (lists,arrays,etc). - unfold a list of items using (project and z) making layout list via itemL. - If reach maxLength (before exhausting) then truncate. - - - - - See tagL - - - - - Layout like an F# list. - - - - - Layout like an F# option. - - - - - Layout list vertically. - - - - - Layout two vertically. - - - - - Form tuple of layouts. - - - - - Wrap braces around layout. - - - - - Wrap square brackets around layout. - - - - - Wrap round brackets around Layout. - - - - - Join layouts into a list separated using the given Layout. - - - - - Join layouts into a semi-colon separated list. - - - - - Join layouts into a space separated list. - - - - - Join layouts into a comma separated list. - - - - - Join broken with ident=2 - - - - - Join broken with ident=1 - - - - - Join broken with ident=0 - - - - - Join, possible break with indent=2 - - - - - Join, possible break with indent=1 - - - - - Join, possible break with indent=0 - - - - - Join, unbreakable. - - - - - An string which is left parenthesis (no space on the right). - - - - - An string which is right parenthesis (no space on the left). - - - - - An string which requires no spaces either side. - - - - - An string leaf - - - - - An uninterpreted leaf, to be interpreted into a string - by the layout engine. This allows leaf layouts for numbers, strings and - other atoms to be customized according to culture. - - - - - Is it the empty layout? - - - - - The empty layout - - - - - A layout is a sequence of strings which have been joined together. - The strings are classified as words, separators and left and right parenthesis. - This classification determines where spaces are inserted. - A joint is either unbreakable, breakable or broken. - If a joint is broken the RHS layout occurs on the next line with optional indentation. - A layout can be squashed to for given width which forces breaks as required. - - - - - Return the given big integer - - - - - Return the negation of a big integer - - - - - Return the difference of two big integers - - - - - Return the product of big integers - - - - - Return the modulus of big integers - - - - - This operator is for consistency when this type be used from other CLI languages - - - - - This operator is for consistency when this type be used from other CLI languages - - - - - This operator is for consistency when this type be used from other CLI languages - - - - - This operator is for consistency when this type be used from other CLI languages - - - - - This operator is for consistency when this type be used from other CLI languages - - - - - Convert a big integer to a 32-bit signed integer - - - - - Convert a big integer to a 64-bit signed integer - - - - - Convert a big integer to a floating point number - - - - - This operator is for consistency when this type be used from other CLI languages - - - - - Return the ratio of two big integers - - - - - Return the sum of two big integers - - - - - Get the big integer for zero - - - - - Return the sign of a big integer: 0, +1 or -1 - - - - - Get the big integer for one - - - - - Return true if a big integer is 'zero' - - - - - Return true if a big integer is 'one' - - - - - Return n^m for two big integers - - - - - Parse a big integer from a string format - - - - - Return the greatest common divisor of two big integers - - - - - Compute the ratio and remainder of two big integers - - - - - Compute the absolute value of a big integer - - - - - Construct a BigInteger value for the given 64-bit integer - - - - - Construct a BigInteger value for the given integer - - - - - The type of arbitrary-sized integers - - - - diff --git a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45/FSharp.Core.dll b/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45/FSharp.Core.dll deleted file mode 100644 index 8924a8d..0000000 Binary files a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45/FSharp.Core.dll and /dev/null differ diff --git a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45/FSharp.Core.optdata b/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45/FSharp.Core.optdata deleted file mode 100644 index 7e800d2..0000000 Binary files a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45/FSharp.Core.optdata and /dev/null differ diff --git a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45/FSharp.Core.sigdata b/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45/FSharp.Core.sigdata deleted file mode 100644 index 04c4184..0000000 Binary files a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45/FSharp.Core.sigdata and /dev/null differ diff --git a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45/FSharp.Core.xml b/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45/FSharp.Core.xml deleted file mode 100644 index 953fa26..0000000 --- a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+netcore45/FSharp.Core.xml +++ /dev/null @@ -1,10856 +0,0 @@ - - -FSharp.Core - - - Gets the tail of the list, which is a list containing all the elements of the list, excluding the first element - - - Gets the number of items contained in the list - - - Gets the element of the list at the given position. - Lists are represented as linked lists so this is an O(n) operation. - The index. - The value at the given index. - - - Gets a value indicating if the list contains no entries - - - Gets the first element of the list - - - Returns an empty list of a particular type - - - Gets a slice of the list, the elements of the list from the given start index to the given end index. - The start index. - The end index. - The sub list specified by the input indices. - - - Returns a list with head as its first element and tail as its subsequent elements - A new head value for the list. - The existing list. - The list with head appended to the front of tail. - - - The type of immutable singly-linked lists. - - Use the constructors [] and :: (infix) to create values of this type, or - the notation [1;2;3]. Use the values in the List module to manipulate - values of this type, or pattern match against the values directly. - - - Lookup an element in the map. Raise KeyNotFoundException if no binding - exists in the map. - The input key. - Thrown when the key is not found. - The value mapped to the key. - - - Returns true if there are no bindings in the map. - - - The number of bindings in the map. - - - Lookup an element in the map, returning a Some value if the element is in the domain - of the map and None if not. - The input key. - The mapped value, or None if the key is not in the map. - - - Removes an element from the domain of the map. No exception is raised if the element is not present. - The input key. - The resulting map. - - - Tests if an element is in the domain of the map. - The input key. - True if the map contains the given key. - - - Returns a new map with the binding added to the given map. - The input key. - The resulting map. - - - Builds a map that contains the bindings of the given IEnumerable. - The input sequence of key/value pairs. - The resulting map. - - - Immutable maps. Keys are ordered by F# generic comparison. - - Maps based on generic comparison are efficient for small keys. They are not a suitable choice if keys are recursive data structures - or if keys require bespoke comparison semantics. - - All members of this class are thread-safe and may be used concurrently from multiple threads. - - - An abbreviation for the CLI type System.Collections.Generic.List<_> - - - Returns a new set with the elements of the second set removed from the first. - The first input set. - The second input set. - A set containing elements of the first set that are not contained in the second set. - - - Compute the union of the two sets. - The first input set. - The second input set. - The union of the two input sets. - - - Returns the lowest element in the set according to the ordering being used for the set. - - - Returns the highest element in the set according to the ordering being used for the set. - - - A useful shortcut for Set.isEmpty. See the Set module for further operations on sets. - - - The number of elements in the set - - - A useful shortcut for Set.remove. Note this operation produces a new set - and does not mutate the original set. The new set will share many storage - nodes with the original. See the Set module for further operations on sets. - The value to remove from the set. - The result set. - - - Evaluates to "true" if all elements of the second set are in the first. - The set to test against. - True if this set is a superset of otherSet. - - - Evaluates to "true" if all elements of the first set are in the second. - The set to test against. - True if this set is a subset of otherSet. - - - Evaluates to "true" if all elements of the second set are in the first, and at least - one element of the first is not in the second. - The set to test against. - True if this set is a proper superset of otherSet. - - - Evaluates to "true" if all elements of the first set are in the second, and at least - one element of the second is not in the first. - The set to test against. - True if this set is a proper subset of otherSet. - - - A useful shortcut for Set.contains. See the Set module for further operations on sets. - The value to check. - True if the set contains value. - - - A useful shortcut for Set.add. Note this operation produces a new set - and does not mutate the original set. The new set will share many storage - nodes with the original. See the Set module for further operations on sets. - The value to add to the set. - The result set. - - - Create a set containing elements drawn from the given sequence. - The input sequence. - The result set. - - - Immutable sets based on binary trees, where comparison is the - F# structural comparison function, potentially using implementations - of the IComparable interface on key values. - - See the Set module for further operations on sets. - - All members of this class are thread-safe and may be used concurrently from multiple threads. - - - An abbreviation for the type of immutable singly-linked lists. - - Use the constructors [] and :: (infix) to create values of this type, or - the notation [1;2;3]. Use the values in the List module to manipulate - values of this type, or pattern match against the values directly. - - - An abbreviation for the CLI type System.Collections.Generic.IEnumerable<_> - - - Fetches an element from a 2D array. You can also use the syntax array.[index1,index2]. - - The input array. - The index along the first dimension. - The index along the second dimension. - - The value of the array at the given index. - Thrown when the indices are negative or exceed the bounds of the array. - - - Sets the value of an element in an array. You can also use the syntax array.[index1,index2] <- value. - - The input array. - The index along the first dimension. - The index along the second dimension. - The value to set in the array. - Thrown when the indices are negative or exceed the bounds of the array. - - - Builds a new array whose elements are the same as the input array but - where a non-zero-based input array generates a corresponding zero-based - output array. - - The input array. - - The zero-based output array. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer indices passed to the - function indicates the element being transformed. - - For non-zero-based arrays the basing on an input array will be propagated to the output - array. - - A function that is applied to transform each element of the array. The two integers - provide the index of the element. - The input array. - - An array whose elements have been transformed by the given mapping. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - - A function that is applied to transform each item of the input array. - The input array. - - An array whose elements have been transformed by the given mapping. - - - Returns the length of an array in the second dimension. - - The input array. - - The length of the array in the second dimension. - - - Returns the length of an array in the first dimension. - - The input array. - - The length of the array in the first dimension. - - - Applies the given function to each element of the array. The integer indices passed to the - function indicates the index of element. - - A function to apply to each element of the array with the indices available as an argument. - The input array. - - - Applies the given function to each element of the array. - - A function to apply to each element of the array. - The input array. - - - Creates a based array where the entries are initially Unchecked.defaultof<'T>. - - The base for the first dimension of the array. - The base for the second dimension of the array. - The length of the first dimension of the array. - The length of the second dimension of the array. - - The created array. - Thrown when base1, base2, length1, or length2 is negative. - - - Creates a based array whose elements are all initially the given value. - - The base for the first dimension of the array. - The base for the second dimension of the array. - The length of the first dimension of the array. - The length of the second dimension of the array. - The value to populate the new array. - - The created array. - Thrown when base1, base2, length1, or length2 is negative. - - - Creates a based array given the dimensions and a generator function to compute the elements. - - The base for the first dimension of the array. - The base for the second dimension of the array. - The length of the first dimension of the array. - The length of the second dimension of the array. - A function to produce elements of the array given the two indices. - - The created array. - Thrown when base1, base2, length1, or length2 is negative. - - - Creates an array where the entries are initially Unchecked.defaultof<'T>. - - The length of the first dimension of the array. - The length of the second dimension of the array. - - The created array. - Thrown when length1 or length2 is negative. - - - Creates an array whose elements are all initially the given value. - - The length of the first dimension of the array. - The length of the second dimension of the array. - The value to populate the new array. - - The created array. - Thrown when length1 or length2 is negative. - - - Creates an array given the dimensions and a generator function to compute the elements. - - The length of the first dimension of the array. - The length of the second dimension of the array. - A function to produce elements of the array given the two indices. - - The generated array. - Thrown when either of the lengths is negative. - - - Reads a range of elements from the first array and write them into the second. - - The source array. - The first-dimension index to begin copying from in the source array. - The second-dimension index to begin copying from in the source array. - The target array. - The first-dimension index to begin copying into in the target array. - The second-dimension index to begin copying into in the target array. - The number of elements to copy across the first dimension of the arrays. - The number of elements to copy across the second dimension of the arrays. - Thrown when any of the indices are negative or if either of - the counts are larger than the dimensions of the array allow. - - - Builds a new array whose elements are the same as the input array. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - - The input array. - - A copy of the input array. - - - Fetches the base-index for the second dimension of the array. - - The input array. - - The base-index of the second dimension of the array. - - - Fetches the base-index for the first dimension of the array. - - The input array. - - The base-index of the first dimension of the array. - - - Basic operations on 2-dimensional arrays. - - F# and CLI multi-dimensional arrays are typically zero-based. - However, CLI multi-dimensional arrays used in conjunction with external - libraries (e.g. libraries associated with Visual Basic) be - non-zero based, using a potentially different base for each dimension. - The operations in this module will accept such arrays, and - the basing on an input array will be propagated to a matching output - array on the Array2D.map and Array2D.mapi operations. - Non-zero-based arrays can also be created using Array2D.zeroCreateBased, - Array2D.createBased and Array2D.initBased. - - - Creates an array where the entries are initially the "default" value. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The created array. - - - Sets the value of an element in an array. You can also - use the syntax 'array.[index1,index2,index3] <- value'. - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The value to set at the given index. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer indices passed to the - function indicates the element being transformed. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - The function to transform the elements at each index in the array. - The input array. - The array created from the transformed elements. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - The function to transform each element of the array. - The input array. - The array created from the transformed elements. - - - Returns the length of an array in the third dimension. - The input array. - The length of the array in the third dimension. - - - Returns the length of an array in the second dimension. - The input array. - The length of the array in the second dimension. - - - Returns the length of an array in the first dimension - The input array. - The length of the array in the first dimension. - - - Applies the given function to each element of the array. The integer indicies passed to the - function indicates the index of element. - The function to apply to each element of the array. - The input array. - - - Applies the given function to each element of the array. - The function to apply to each element of the array. - The input array. - - - Fetches an element from a 3D array. You can also use the syntax 'array.[index1,index2,index3]' - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The value at the given index. - - - Creates an array given the dimensions and a generator function to compute the elements. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The function to create an initial value at each index into the array. - The created array. - - - Creates an array whose elements are all initially the given value. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The value of the array elements. - The created array. - - - Basic operations on rank 3 arrays. - - - Sets the value of an element in an array. You can also - use the syntax 'array.[index1,index2,index3,index4] <- value'. - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The index along the fourth dimension. - The value to set. - - - Fetches an element from a 4D array. You can also use the syntax 'array.[index1,index2,index3,index4]' - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The index along the fourth dimension. - The value at the given index. - - - Creates an array where the entries are initially the "default" value. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The length of the fourth dimension. - The created array. - - - Returns the length of an array in the fourth dimension. - The input array. - The length of the array in the fourth dimension. - - - Returns the length of an array in the third dimension. - The input array. - The length of the array in the third dimension. - - - Returns the length of an array in the second dimension. - The input array. - The length of the array in the second dimension. - - - Returns the length of an array in the first dimension - The input array. - The length of the array in the first dimension. - - - Creates an array given the dimensions and a generator function to compute the elements. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The length of the fourth dimension. - The function to create an initial value at each index in the array. - The created array. - - - Creates an array whose elements are all initially the given value - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The length of the fourth dimension. - The initial value for each element of the array. - The created array. - - - Basic operations on rank 4 arrays. - - - Combines three arrays into an array of pairs. The three arrays must have equal lengths, otherwise an ArgumentException is - raised. - The first input array. - The second input array. - The third input array. - Thrown when any of the input arrays are null. - Thrown when the input arrays differ in length. - The array of tupled elements. - - - Combines the two arrays into an array of pairs. The two arrays must have equal lengths, otherwise an ArgumentException is - raised. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The array of tupled elements. - - - Returns an array of sliding windows containing elements drawn from the input - array. Each window is returned as a fresh array. - The number of elements in each window. - The input array. - The result array. - Thrown when the input array is null. - Thrown when windowSize is not positive. - - - Returns a new array containing only the elements of the array - for which the given predicate returns "true". - The function to test the input elements. - The input array. - An array containing the elements for which the given predicate returns true. - - Thrown when the input array is null. - - - Splits an array of triples into three arrays. - The input array. - The tuple of three arrays. - Thrown when the input array is null. - - - Splits an array of pairs into two arrays. - The input array. - The two arrays. - Thrown when the input array is null. - - - Returns an array that contains the elements generated by the given computation. - The given initial state argument is passed to the element generator. - A function that takes in the current state and returns an option tuple of the next - element of the array and the next state value. - The initial state value. - The result array. - - - Returns the index of the last element in the array - that satisfies the given predicate. - The function to test the input elements. - The input array. - Thrown when the input array is null. - The index of the last element that satisfies the predicate, or None. - - - Tries to find the nth element in the array. - Returns None if index is negative or the input array does not contain enough elements. - The index of element to retrieve. - The input array. - The nth element of the array or None. - Thrown when the input array is null. - - - Returns the index of the first element in the array - that satisfies the given predicate. - The function to test the input elements. - The input array. - Thrown when the input array is null. - The index of the first element that satisfies the predicate, or None. - - - Returns the last element for which the given function returns true. - Return None if no such element exists. - The function to test the input elements. - The input array. - Thrown when the input array is null. - The last element that satisfies the predicate, or None. - - - Returns the first element for which the given function returns true. - Return None if no such element exists. - The function to test the input elements. - The input array. - The first element that satisfies the predicate, or None. - Thrown when the input array is null. - - - Returns at most N elements in a new array. - The maximum number of items to return. - The input array. - The result array. - Thrown when the input array is null. - - - Views the given array as a sequence. - The input array. - The sequence of array elements. - Thrown when the input array is null. - - - Builds a list from the given array. - The input array. - The list of array elements. - Thrown when the input array is null. - - - Returns a new array containing the elements of the original except the first element. - - The input array. - Thrown when the array is empty. - Thrown when the input array is null. - A new array containing the elements of the original except the first element. - - - Returns an array that contains all elements of the original array while the - given predicate returns true, and then returns no further elements. - - A function that evaluates to false when no more items should be returned. - The input array. - - The result array. - - Thrown when the input array is null. - - - Returns the first N elements of the array. - Throws InvalidOperationException - if the count exceeds the number of elements in the array. Array.truncate - returns as many items as the array contains instead of throwing an exception. - - The number of items to take. - The input array. - - The result array. - - Thrown when the input array is null. - Thrown when the input array is empty. - Thrown when count exceeds the number of elements - in the list. - - - Returns the sum of the results generated by applying the function to each element of the array. - The function to transform the array elements into the type to be summed. - The input array. - The resulting sum. - Thrown when the input array is null. - - - Returns the sum of the elements in the array. - The input array. - The resulting sum. - Thrown when the input array is null. - - - Sorts the elements of an array, in descending order, using the given projection for the keys and returning a new array. - Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to transform array elements into the type that is compared. - The input array. - The sorted array. - - - Sorts the elements of an array, in descending order, returning a new array. Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The input array. - The sorted array. - - - Splits an array into two arrays, at the given index. - The index at which the array is split. - The input array. - The two split arrays. - - Thrown when the input array is null. - Thrown when split index exceeds the number of elements - in the array. - - - Sorts the elements of an array by mutating the array in-place, using the given comparison function. - Elements are compared using Operators.compare. - The input array. - Thrown when the input array is null. - - - Sorts the elements of an array by mutating the array in-place, using the given comparison function as the order. - The function to compare pairs of array elements. - The input array. - Thrown when the input array is null. - - - Sorts the elements of an array by mutating the array in-place, using the given projection for the keys. - Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to transform array elements into the type that is compared. - The input array. - Thrown when the input array is null. - - - Sorts the elements of an array, using the given comparison function as the order, returning a new array. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to compare pairs of array elements. - The input array. - The sorted array. - Thrown when the input array is null. - - - Sorts the elements of an array, using the given projection for the keys and returning a new array. - Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to transform array elements into the type that is compared. - The input array. - The sorted array. - Thrown when the input array is null. - - - Sorts the elements of an array, returning a new array. Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The input array. - The sorted array. - Thrown when the input array is null. - - - Builds a new array that contains the given subrange specified by - starting index and length. - The input array. - The index of the first element of the sub array. - The length of the sub array. - The created sub array. - Thrown when the input array is null. - Thrown when either startIndex or count is negative, - or when there aren't enough elements in the input array. - - - Bypasses elements in an array while the given predicate returns true, and then returns - the remaining elements in a new array. - A function that evaluates an element of the array to a boolean value. - The input array. - The created sub array. - Thrown when the input array is null. - - - Builds a new array that contains the elements of the given array, excluding the first N elements. - The number of elements to skip. - The input array. - A copy of the input array, after removing the first N elements. - Thrown when the input array is null. - Thrown when count is negative or exceeds the number of - elements in the array. - - - Sets an element of an array. - The input array. - The input index. - The input value. - Thrown when the input array is null. - Thrown when the index is negative or the input array does not contain enough elements. - - - Returns an array that contains one item only. - - The input item. - - The result array of one item. - - - Like foldBack, but return both the intermediary and final results. - The function to update the state given the input elements. - The input array. - The initial state. - The array of state values. - Thrown when the input array is null. - - - Like fold, but return the intermediary and final results. - The function to update the state given the input elements. - The initial state. - The input array. - The array of state values. - Thrown when the input array is null. - - - Returns a new array with the elements in reverse order. - The input array. - The reversed array. - Thrown when the input array is null. - - - Creates an array by replicating the given initial value. - The number of elements to replicate. - The value to replicate - The generated array. - Thrown when count is negative. - - - Applies a function to each element of the array, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f i0 (...(f iN-1 iN)). - A function that takes in the next-to-last element of the list and the - current accumulated result to produce the next accumulated result. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The final result of the reductions. - - - Applies a function to each element of the array, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f (... (f i0 i1)...) iN. - Raises ArgumentException if the array has size zero. - The function to reduce a pair of elements to a single element. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The final result of the redcutions. - - - Returns an array with all elements permuted according to the - specified permutation. - The function that maps input indices to output indices. - The input array. - The output array. - Thrown when the input array is null. - Thrown when indexMap does not produce a valid permutation. - - - Splits the collection into two collections, containing the - elements for which the given predicate returns "true" and "false" - respectively. - The function to test the input elements. - The input array. - A pair of arrays. The first containing the elements the predicate evaluated to true, - and the second containing those evaluated to false. - Thrown when the input array is null. - - - Returns an array of each element in the input array and its predecessor, with the - exception of the first element which is only returned as the predecessor of the second element. - - The input array. - - The result array. - - Thrown when the input sequence is null. - - - Builds a new array from the given enumerable object. - The input sequence. - The array of elements from the sequence. - Thrown when the input sequence is null. - - - Builds an array from the given list. - The input list. - The array of elements from the list. - - - Returns the lowest of all elements of the array, compared via Operators.min on the function result. - - Throws ArgumentException for empty arrays. - The function to transform the elements into a type supporting comparison. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The minimum element. - - - Returns the lowest of all elements of the array, compared via Operators.min. - - Throws ArgumentException for empty arrays - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The minimum element. - - - Returns the greatest of all elements of the array, compared via Operators.max on the function result. - - Throws ArgumentException for empty arrays. - The function to transform the elements into a type supporting comparison. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The maximum element. - - - Returns the greatest of all elements of the array, compared via Operators.max on the function result. - - Throws ArgumentException for empty arrays. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The maximum element. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer index passed to the - function indicates the index of element being transformed. - The function to transform elements and their indices. - The input array. - The array of transformed elements. - Thrown when the input array is null. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the two collections pairwise, also passing the index of - the elements. The two input arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to transform pairs of input elements and their indices. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The array of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding triples from the three collections. The three input - arrays must have the same length, otherwise an ArgumentException is - raised. - The function to transform the pairs of the input elements. - The first input array. - The second input array. - The third input array. - Thrown when the input arrays differ in length. - Thrown when any of the input arrays is null. - The array of transformed elements. - - - Combines map and foldBack. Builds a new array whose elements are the results of applying the given function - to each of the elements of the input array. The function is also used to accumulate a final value. - The function to transform elements from the input array and accumulate the final value. - The input array. - The initial state. - Thrown when the input array is null. - The array of transformed elements, and the final accumulated value. - - - Combines map and fold. Builds a new array whose elements are the results of applying the given function - to each of the elements of the input array. The function is also used to accumulate a final value. - The function to transform elements from the input array and accumulate the final value. - The initial state. - The input array. - Thrown when the input array is null. - The array of transformed elements, and the final accumulated value. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the two collections pairwise. The two input - arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to transform the pairs of the input elements. - The first input array. - The second input array. - Thrown when the input arrays differ in length. - Thrown when either of the input arrays is null. - The array of transformed elements. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. - The function to transform elements of the array. - The input array. - The array of transformed elements. - Thrown when the input array is null. - - - Returns the last element of the array. - Return None if no such element exists. - The input array. - The last element of the array or None. - Thrown when the input sequence is null. - - - Returns the length of an array. You can also use property arr.Length. - The input array. - The length of the array. - Thrown when the input array is null. - - - Gets an element from an array. - The input index. - The input array. - The value of the array at the given index. - Thrown when the input array is null. - Thrown when the index is negative or the input array does not contain enough elements. - - - Returns the last element of the array. - The input array. - The last element of the array. - Thrown when the input array is null. - Thrown when the input does not have any elements. - - - Applies the given function to pair of elements drawn from matching indices in two arrays, - also passing the index of the elements. The two arrays must have the same lengths, - otherwise an ArgumentException is raised. - The function to apply to each index and pair of elements. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - - - Applies the given function to each element of the array. The integer passed to the - function indicates the index of element. - The function to apply to each index and element. - The input array. - Thrown when the input array is null. - - - Applies the given function to pair of elements drawn from matching indices in two arrays. The - two arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to apply. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - - - Applies the given function to each element of the array. - The function to apply. - The input array. - Thrown when the input array is null. - - - Returns true if the given array is empty, otherwise false. - The input array. - True if the array is empty. - Thrown when the input array is null. - - - Creates an array where the entries are initially the default value Unchecked.defaultof<'T>. - The length of the array to create. - The created array. - Thrown when count is negative. - - - Creates an array given the dimension and a generator function to compute the elements. - The number of elements to initialize. - The function to generate the initial values for each index. - The created array. - Thrown when count is negative. - - - Builds a new array whose elements are the corresponding elements of the input array - paired with the integer index (from 0) of each element. - The input array. - The array of indexed elements. - Thrown when the input array is null. - - - Applies a key-generating function to each element of an array and yields an array of - unique keys. Each unique key contains an array of all elements that match - to this key. - - A function that transforms an element of the array into a comparable key. - The input array. - - The result array. - - Thrown when the input array is null. - - - Returns the first element of the array. - - The input array. - - The first element of the array. - - Thrown when the input array is null. - Thrown when the input array is empty. - - - Gets an element from an array. - The input array. - The input index. - The value of the array at the given index. - Thrown when the input array is null. - Thrown when the index is negative or the input array does not contain enough elements. - - - Apply a function to pairs of elements drawn from the two collections, right-to-left, - threading an accumulator argument through the computation. The two input - arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to update the state given the input elements. - The first input array. - The second input array. - The initial state. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The final state. - - - Applies a function to pairs of elements drawn from the two collections, - left-to-right, threading an accumulator argument - through the computation. The two input - arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to update the state given the input elements. - The initial state. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The final state. - - - Applies a function to each element of the array, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then computes - f i0 (...(f iN s)) - The function to update the state given the input elements. - The input array. - The initial state. - The state object after the folding function is applied to each element of the array. - Thrown when the input array is null. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then computes - f (... (f s i0)...) iN - The function to update the state given the input elements. - The initial state. - The input array. - The final state. - Thrown when the input array is null. - - - Tests if all corresponding elements of the array satisfy the given predicate pairwise. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns false then the overall result is - false and no further elements are tested. Otherwise, if one collection is longer - than the other then the ArgumentException exception is raised. - Otherwise, true is returned. - The function to test the input elements. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - True if all of the array elements satisfy the predicate. - - - Tests if all elements of the array satisfy the given predicate. - - The predicate is applied to the elements of the input collection. If any application - returns false then the overall result is false and no further elements are tested. - Otherwise, true is returned. - The function to test the input elements. - The input array. - True if all of the array elements satisfy the predicate. - Thrown when the input array is null. - - - Returns the index of the last element in the array - that satisfies the given predicate. Raise KeyNotFoundException if - none of the elements satisfy the predicate. - The function to test the input elements. - The input array. - Thrown if predicate - never returns true. - Thrown when the input array is null. - The index of the last element in the array that satisfies the given predicate. - - - Returns the index of the first element in the array - that satisfies the given predicate. Raise KeyNotFoundException if - none of the elements satisfy the predicate. - The function to test the input elements. - The input array. - Thrown if predicate - never returns true. - Thrown when the input array is null. - The index of the first element in the array that satisfies the given predicate. - - - Returns the last element for which the given function returns 'true'. - Raise KeyNotFoundException if no such element exists. - The function to test the input elements. - The input array. - Thrown if predicate - never returns true. - Thrown when the input array is null. - The last element for which predicate returns true. - - - Returns the first element for which the given function returns 'true'. - Raise KeyNotFoundException if no such element exists. - The function to test the input elements. - The input array. - Thrown when the input array is null. - Thrown if predicate - never returns true. - The first element for which predicate returns true. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true". - The function to test the input elements. - The input array. - An array containing the elements for which the given predicate returns true. - Thrown when the input array is null. - - - Tests if any pair of corresponding elements of the arrays satisfies the given predicate. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns true then the overall result is - true and no further elements are tested. Otherwise, if one collections is longer - than the other then the ArgumentException exception is raised. - Otherwise, false is returned. - The function to test the input elements. - The first input array. - The second input array. - True if any result from predicate is true. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - - - Tests if any element of the array satisfies the given predicate. - - The predicate is applied to the elements of the input array. If any application - returns true then the overall result is true and no further elements are tested. - Otherwise, false is returned. - The function to test the input elements. - The input array. - True if any result from predicate is true. - Thrown when the input array is null. - - - Returns a new list with the distinct elements of the input array which do not appear in the itemsToExclude sequence, - using generic hash and equality comparisons to compare values. - - A sequence whose elements that also occur in the input array will cause those elements to be - removed from the result. - An array whose elements that are not also in itemsToExclude will be returned. - - An array that contains the distinct elements of array that do not appear in itemsToExclude. - - Thrown when either itemsToExclude or array is null. - - - Returns the only element of the array. - - The input array. - - The only element of the array. - - Thrown when the input array is null. - Thrown when the input does not have precisely one element. - - - Returns an empty array of the given type. - The empty array. - - - Splits the input array into at most count chunks. - The maximum number of chunks. - The input array. - The array split into chunks. - Thrown when the input array is null. - Thrown when count is not positive. - - - Returns an array that contains no duplicate entries according to the - generic hash and equality comparisons on the keys returned by the given key-generating function. - If an element occurs multiple times in the array then the later occurrences are discarded. - - A function transforming the array items into comparable keys. - The input array. - - The result array. - - Thrown when the input array is null. - - - Returns an array that contains no duplicate entries according to generic hash and - equality comparisons on the entries. - If an element occurs multiple times in the array then the later occurrences are discarded. - - The input array. - - The result array. - - Thrown when the input array is null. - - - Divides the input array into chunks of size at most chunkSize. - The maximum size of each chunk. - The input array. - The array divided into chunks. - Thrown when the input array is null. - Thrown when chunkSize is not positive. - - - Applies the given function to each element of the array. Returns - the array comprised of the results "x" for each element where - the function returns Some(x) - The function to generate options from the elements. - The input array. - The array of results. - Thrown when the input array is null. - - - Applies the given function to successive elements, returning the first - result where function returns Some(x) for some x. If the function - never returns Some(x) then KeyNotFoundException is raised. - The function to generate options from the elements. - The input array. - Thrown when the input array is null. - Thrown if every result from - chooser is None. - The first result. - - - Fills a range of elements of the array with the given value. - The target array. - The index of the first element to set. - The number of elements to set. - The value to set. - Thrown when the input array is null. - Thrown when either targetIndex or count is negative. - - - Applies the given function to successive elements, returning the first - result where function returns Some(x) for some x. If the function - never returns Some(x) then None is returned. - The function to transform the array elements into options. - The input array. - The first transformed element that is Some(x). - Thrown when the input array is null. - - - Returns the first element of the array, or - None if the array is empty. - The input array. - Thrown when the input array is null. - The first element of the array or None. - - - Creates an array whose elements are all initially the given value. - The length of the array to create. - The value for the elements. - The created array. - Thrown when count is negative. - - - Applies a key-generating function to each element of an array and returns an array yielding unique - keys and their number of occurrences in the original array. - - A function transforming each item of the input array into a key to be - compared against the others. - The input array. - - The result array. - - Thrown when the input array is null. - - - Builds a new array that contains the elements of the given array. - The input array. - A copy of the input array. - Thrown when the input array is null. - - - Tests if the array contains the specified element. - The value to locate in the input array. - The input array. - True if the input array contains the specified element; false otherwise. - Thrown when the input array is null. - - - Builds a new array that contains the elements of each of the given sequence of arrays. - The input sequence of arrays. - The concatenation of the sequence of input arrays. - Thrown when the input sequence is null. - - - Compares two arrays using the given comparison function, element by element. - Returns the first non-zero result from the comparison function. If the end of an array - is reached it returns a -1 if the first array is shorter and a 1 if the second array - is shorter. - - A function that takes an element from each array and returns an int. - If it evaluates to a non-zero value iteration is stopped and that value is returned. - The first input array. - The second input array. - - The first non-zero value from the comparison function. - - Thrown when either of the input arrays - is null. - - - For each element of the array, applies the given function. Concatenates all the results and return the combined array. - The function to create sub-arrays from the input array elements. - The input array. - The concatenation of the sub-arrays. - Thrown when the input array is null. - - - Reads a range of elements from the first array and write them into the second. - The source array. - The starting index of the source array. - The target array. - The starting index of the target array. - The number of elements to copy. - Thrown when either of the input arrays is null. - Thrown when any of sourceIndex, targetIndex or count are negative, - or when there aren't enough elements in source or target. - - - Returns the average of the elements generated by applying the function to each element of the array. - The function to transform the array elements before averaging. - The input array. - Thrown when array is empty. - The computed average. - Thrown when the input array is null. - - - Returns the average of the elements in the array. - The input array. - Thrown when array is empty. - The average of the elements in the array. - Thrown when the input array is null. - - - Builds a new array that contains the elements of the first array followed by the elements of the second array. - The first input array. - The second input array. - The resulting array. - Thrown when either of the input arrays is null. - - - Split the collection into two collections, containing the - elements for which the given predicate returns "true" and "false" - respectively - - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to indicies is not specified. - The function to test the input elements. - The input array. - 'T[] * 'T[] - Thrown when the input array is null. - - - Create an array given the dimension and a generator function to compute the elements. - - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to indicies is not specified. - - - 'T[] - - - Apply the given function to each element of the array. The integer passed to the - function indicates the index of element. - - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to elements of the input array is not specified. - - The input array. - Thrown when the input array is null. - - - Apply the given function to each element of the array. - - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to elements of the input array is not specified. - - The input array. - Thrown when the input array is null. - - - Build a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer index passed to the - function indicates the index of element being transformed. - - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to elements of the input array is not specified. - - The input array. - 'U[] - Thrown when the input array is null. - - - Build a new array whose elements are the results of applying the given function - to each of the elements of the array. - - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to elements of the input array is not specified. - - The input array. - 'U[] - Thrown when the input array is null. - - - For each element of the array, apply the given function. Concatenate all the results and return the combined array. - - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to elements of the input array is not specified. - - The input array. - 'U[] - Thrown when the input array is null. - - - Apply the given function to each element of the array. Return - the array comprised of the results "x" for each element where - the function returns Some(x). - - Performs the operation in parallel using System.Threading.Parallel.For. - The order in which the given function is applied to elements of the input array is not specified. - The function to generate options from the elements. - The input array. - 'U[] - Thrown when the input array is null. - - - Provides parallel operations on arrays - - - Basic operations on arrays. - - - Compare using the given comparer function. - A function to compare two values. - An object implementing IComparer using the supplied comparer. - - - Non-structural comparison. Compare using NonStructuralComparison.compare. - - - Structural comparison. Compare using Operators.compare. - - - Common notions of comparison identity used with sorted data structures. - - - Hash using the given hashing and equality functions. - A function to generate a hash code from a value. - A function to test equality of two values. - An object implementing IEqualityComparer using the supplied functions. - - - Physical hashing (hash on reference identity of objects, and the contents of value types). - Hash using LanguagePrimitives.PhysicalEquality and LanguagePrimitives.PhysicalHash, - That is, for value types use GetHashCode and Object.Equals (if no other optimization available), - and for reference types use System.Runtime.CompilerServices.RuntimeHelpers.GetHashCode and - reference equality. - - - Non-structural hashing. Equality using NonStructuralComparison.(=) and NonStructuralComparison.hash. - - - Structural hashing. Hash using Operators.(=) and Operators.hash. - - - Common notions of value identity used with hash tables. - - - Combines the three lists into a list of triples. The lists must have equal lengths. - The first input list. - The second input list. - The third input list. - A single list containing triples of matching elements from the input lists. - - - Combines the two lists into a list of pairs. The two lists must have equal lengths. - The first input list. - The second input list. - A single list containing pairs of matching elements from the input lists. - - - Returns a list of sliding windows containing elements drawn from the input - list. Each window is returned as a fresh list. - The number of elements in each window. - The input list. - The result list. - Thrown when windowSize is not positive. - - - Returns a new list containing only the elements of the list - for which the given predicate returns "true" - The function to test the input elements. - The input list. - A list containing only the elements that satisfy the predicate. - - - Splits a list of triples into three lists. - The input list. - Three lists of split elements. - - - Splits a list of pairs into two lists. - The input list. - Two lists of split elements. - - - Returns a list that contains the elements generated by the given computation. - The given initial state argument is passed to the element generator. - A function that takes in the current state and returns an option tuple of the next - element of the list and the next state value. - The initial state value. - The result list. - - - Returns the index of the last element in the list - that satisfies the given predicate. - Return None if no such element exists. - The function to test the input elements. - The input list. - The index of the last element for which the predicate returns true, or None if - every element evaluates to false. - - - Tries to find the nth element in the list. - Returns None if index is negative or the list does not contain enough elements. - The index to retrieve. - The input list. - The value at the given index or None. - - - Returns the index of the first element in the list - that satisfies the given predicate. - Return None if no such element exists. - The function to test the input elements. - The input list. - The index of the first element for which the predicate returns true, or None if - every element evaluates to false. - - - Returns the last element for which the given function returns true.. - Return None if no such element exists. - The function to test the input elements. - The input list. - The last element for which the predicate returns true, or None if - every element evaluates to false. - - - Returns the first element for which the given function returns true.. - Return None if no such element exists. - The function to test the input elements. - The input list. - The first element for which the predicate returns true, or None if - every element evaluates to false. - - - Applies the given function to successive elements, returning Some(x) the first - result where function returns Some(x) for some x. If no such element - exists then return None. - The function to generate options from the elements. - The input list. - The first resulting value or None. - - - Returns at most N elements in a new list. - The maximum number of items to return. - The input list. - The result list. - - - Returns the first element of the list, or - None if the list is empty. - The input list. - The first element of the list or None. - - - Views the given list as a sequence. - The input list. - The sequence of elements in the list. - - - Builds an array from the given list. - The input list. - The array containing the elements of the list. - - - Returns a list that contains all elements of the original list while the - given predicate returns true, and then returns no further elements. - - A function that evaluates to false when no more items should be returned. - The input list. - - The result list. - - - Returns the first N elements of the list. - Throws InvalidOperationException - if the count exceeds the number of elements in the list. List.truncate - returns as many items as the list contains instead of throwing an exception. - - The number of items to take. - The input list. - - The result list. - - Thrown when the input list is empty. - Thrown when count exceeds the number of elements - in the list. - - - Returns the list after removing the first element. - - The input list. - Thrown when the list is empty. - The list after removing the first element. - - - Returns the sum of the results generated by applying the function to each element of the list. - The function to transform the list elements into the type to be summed. - The input list. - The resulting sum. - - - Returns the sum of the elements in the list. - The input list. - The resulting sum. - - - Sorts the given list in descending order using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The input list. - The sorted list. - - - Sorts the given list in descending order using keys given by the given projection. Keys are compared using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The function to transform the list elements into the type to be compared. - The input list. - The sorted list. - - - Splits a list into two lists, at the given index. - The index at which the list is split. - The input list. - The two split lists. - - Thrown when split index exceeds the number of elements - in the list. - - - Sorts the given list using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The input list. - The sorted list. - - - Sorts the given list using keys given by the given projection. Keys are compared using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The function to transform the list elements into the type to be compared. - The input list. - The sorted list. - - - Sorts the given list using the given comparison function. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The function to compare the list elements. - The input list. - The sorted list. - - - Bypasses elements in a list while the given predicate returns true, and then returns - the remaining elements of the list. - A function that evaluates an element of the list to a boolean value. - The input list. - The result list. - - - Returns the list after removing the first N elements. - The number of elements to skip. - The input list. - The list after removing the first N elements. - Thrown when count is negative or exceeds the number of - elements in the list. - - - Returns a list that contains one item only. - - The input item. - - The result list of one item. - - - Like foldBack, but returns both the intermediary and final results - The function to update the state given the input elements. - The input list. - The initial state. - The list of states. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. Take the second argument, and apply the function to it - and the first element of the list. Then feed this result into the function along - with the second element and so on. Returns the list of intermediate results and the final result. - The function to update the state given the input elements. - The initial state. - The input list. - The list of states. - - - Returns a new list with the elements in reverse order. - The input list. - The reversed list. - - - Creates a list by replicating the given initial value. - The number of elements to replicate. - The value to replicate - The generated list. - - - Applies a function to each element of the collection, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then computes - f i0 (...(f iN-1 iN)). - A function that takes in the next-to-last element of the list and the - current accumulated result to produce the next accumulated result. - The input list. - Thrown when the list is empty. - The final result of the reductions. - - - Apply a function to each element of the collection, threading an accumulator argument - through the computation. Apply the function to the first two elements of the list. - Then feed this result into the function along with the third element and so on. - Return the final result. If the input function is f and the elements are i0...iN then computes - f (... (f i0 i1) i2 ...) iN. - - Raises System.ArgumentException if list is empty - The function to reduce two list elements to a single element. - The input list. - Thrown when the list is empty. - The final reduced value. - - - Returns a list with all elements permuted according to the - specified permutation. - The function to map input indices to output indices. - The input list. - The permuted list. - Thrown when indexMap does not produce a valid permutation. - - - Applies the given function to successive elements, returning the first - result where function returns Some(x) for some x. If no such - element exists then raise System.Collections.Generic.KeyNotFoundException - The function to generate options from the elements. - The input list. - Thrown when the list is empty. - The first resulting value. - - - Splits the collection into two collections, containing the - elements for which the given predicate returns true and false - respectively. Element order is preserved in both of the created lists. - The function to test the input elements. - The input list. - A list containing the elements for which the predicate evaluated to false and a list - containing the elements for which the predicate evaluated to true. - - - Returns a list of each element in the input list and its predecessor, with the - exception of the first element which is only returned as the predecessor of the second element. - - The input list. - - The result list. - - - Builds a new list from the given enumerable object. - The input sequence. - The list of elements from the sequence. - - - Builds a list from the given array. - The input array. - The list of elements from the array. - - - Indexes into the list. The first element has index 0. - The input list. - The index to retrieve. - The value at the given index. - Thrown when the index is negative or the input list does not contain enough elements. - - - Returns the lowest of all elements of the list, compared via Operators.min on the function result - - Raises System.ArgumentException if list is empty. - The function to transform list elements into the type to be compared. - The input list. - Thrown when the list is empty. - The minimum value. - - - Returns the lowest of all elements of the list, compared via Operators.min. - - Raises System.ArgumentException if list is empty - The input list. - Thrown when the list is empty. - The minimum value. - - - Returns the greatest of all elements of the list, compared via Operators.max on the function result. - - Raises System.ArgumentException if list is empty. - The function to transform the list elements into the type to be compared. - The input list. - Thrown when the list is empty. - The maximum element. - - - Return the greatest of all elements of the list, compared via Operators.max. - - Raises System.ArgumentException if list is empty - The input list. - Thrown when the list is empty. - The maximum element. - - - Like mapi, but mapping corresponding elements from two lists of equal length. - The function to transform pairs of elements from the two lists and their index. - The first input list. - The second input list. - The list of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The integer index passed to the - function indicates the index (from 0) of element being transformed. - The function to transform elements and their indices. - The input list. - The list of transformed elements. - - - Combines map and foldBack. Builds a new list whose elements are the results of applying the given function - to each of the elements of the input list. The function is also used to accumulate a final value. - The function to transform elements from the input list and accumulate the final value. - The input list. - The initial state. - The list of transformed elements, and the final accumulated value. - - - Combines map and fold. Builds a new list whose elements are the results of applying the given function - to each of the elements of the input list. The function is also used to accumulate a final value. - The function to transform elements from the input list and accumulate the final value. - The initial state. - The input list. - The list of transformed elements, and the final accumulated value. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the three collections simultaneously. - The function to transform triples of elements from the input lists. - The first input list. - The second input list. - The third input list. - The list of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the two collections pairwise. - The function to transform pairs of elements from the input lists. - The first input list. - The second input list. - The list of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. - The function to transform elements from the input list. - The input list. - The list of transformed elements. - - - Returns the last element of the list. - Return None if no such element exists. - The input list. - The last element of the list or None. - - - Returns the length of the list. - The input list. - The length of the list. - - - Returns the last element of the list. - The input list. - The last element of the list. - Thrown when the input does not have any elements. - - - Applies the given function to two collections simultaneously. The - collections must have identical size. The integer passed to the - function indicates the index of element. - The function to apply to a pair of elements from the input lists along with their index. - The first input list. - The second input list. - - - Applies the given function to each element of the collection. The integer passed to the - function indicates the index of element. - The function to apply to the elements of the list along with their index. - The input list. - - - Applies the given function to two collections simultaneously. The - collections must have identical size. - The function to apply to pairs of elements from the input lists. - The first input list. - The second input list. - - - Applies the given function to each element of the collection. - The function to apply to elements from the input list. - The input list. - - - Indexes into the list. The first element has index 0. - The index to retrieve. - The input list. - The value at the given index. - Thrown when the index is negative or the input list does not contain enough elements. - - - Returns true if the list contains no elements, false otherwise. - The input list. - True if the list is empty. - - - Creates a list by calling the given generator on each index. - The length of the list to generate. - The function to generate an element from an index. - The list of generated elements. - - - Returns a new list whose elements are the corresponding elements - of the input list paired with the index (from 0) of each element. - The input list. - The list of indexed elements. - - - Returns the first element of the list. - - The input list. - Thrown when the list is empty. - The first element of the list. - - - Applies a key-generating function to each element of a list and yields a list of - unique keys. Each unique key contains a list of all elements that match - to this key. - - A function that transforms an element of the list into a comparable key. - The input list. - - The result list. - - - Tests if all corresponding elements of the collection satisfy the given predicate pairwise. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns false then the overall result is - false and no further elements are tested. Otherwise, if one collection is longer - than the other then the System.ArgumentException exception is raised. - Otherwise, true is returned. - The function to test the input elements. - The first input list. - The second input list. - Thrown when the input lists differ in length. - True if all of the pairs of elements satisfy the predicate. - - - Tests if all elements of the collection satisfy the given predicate. - - The predicate is applied to the elements of the input list. If any application - returns false then the overall result is false and no further elements are tested. - Otherwise, true is returned. - The function to test the input elements. - The input list. - True if all of the elements satisfy the predicate. - - - Applies a function to corresponding elements of two collections, threading an accumulator argument - through the computation. The collections must have identical sizes. - If the input function is f and the elements are i0...iN and j0...jN - then computes f i0 j0 (...(f iN jN s)). - The function to update the state given the input elements. - The first input list. - The second input list. - The initial state. - The final state value. - - - Applies a function to each element of the collection, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then - computes f i0 (...(f iN s)). - The function to update the state given the input elements. - The input list. - The initial state. - The state object after the folding function is applied to each element of the list. - - - Applies a function to corresponding elements of two collections, threading an accumulator argument - through the computation. The collections must have identical sizes. - If the input function is f and the elements are i0...iN and j0...jN - then computes f (... (f s i0 j0)...) iN jN. - The function to update the state given the input elements. - The initial state. - The first input list. - The second input list. - The final state value. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. Take the second argument, and apply the function to it - and the first element of the list. Then feed this result into the function along - with the second element and so on. Return the final result. - If the input function is f and the elements are i0...iN then - computes f (... (f s i0) i1 ...) iN. - The function to update the state given the input elements. - The initial state. - The input list. - The final state value. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true" - The function to test the input elements. - The input list. - A list containing only the elements that satisfy the predicate. - - - Returns the index of the last element in the list - that satisfies the given predicate. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for all the - elements of the list. - The index of the last element that satisfies the predicate. - - - Returns the index of the first element in the list - that satisfies the given predicate. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for all the - elements of the list. - The index of the first element that satisfies the predicate. - - - Returns the last element for which the given function returns true. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for - all the elements of the list. - The last element that satisfies the predicate. - - - Returns the first element for which the given function returns true. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for - all the elements of the list. - The first element that satisfies the predicate. - - - Tests if any pair of corresponding elements of the lists satisfies the given predicate. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns true then the overall result is - true and no further elements are tested. Otherwise, if one collections is longer - than the other then the System.ArgumentException exception is raised. - Otherwise, false is returned. - The function to test the input elements. - The first input list. - The second input list. - Thrown when the input lists differ in length. - True if any pair of elements satisfy the predicate. - - - Tests if any element of the list satisfies the given predicate. - - The predicate is applied to the elements of the input list. If any application - returns true then the overall result is true and no further elements are tested. - Otherwise, false is returned. - The function to test the input elements. - The input list. - True if any element satisfies the predicate. - - - Returns the only element of the list. - - The input list. - - The only element of the list. - - Thrown when the input does not have precisely one element. - - - Returns a new list with the distinct elements of the input list which do not appear in the itemsToExclude sequence, - using generic hash and equality comparisons to compare values. - - A sequence whose elements that also occur in the input list will cause those elements to be - removed from the result. - A list whose elements that are not also in itemsToExclude will be returned. - - A list that contains the distinct elements of list that do not appear in itemsToExclude. - - Thrown when itemsToExclude is null. - - - Returns an empty list of the given type. - - - Splits the input list into at most count chunks. - The maximum number of chunks. - The input list. - The list split into chunks. - Thrown when count is not positive. - - - Applies a key-generating function to each element of a list and returns a list yielding unique - keys and their number of occurrences in the original list. - - A function transforming each item of the input list into a key to be - compared against the others. - The input list. - - The result list. - - - Returns a list that contains no duplicate entries according to the - generic hash and equality comparisons on the keys returned by the given key-generating function. - If an element occurs multiple times in the list then the later occurrences are discarded. - - A function transforming the list items into comparable keys. - The input list. - - The result list. - - - Returns a list that contains no duplicate entries according to generic hash and - equality comparisons on the entries. - If an element occurs multiple times in the list then the later occurrences are discarded. - - The input list. - - The result list. - - - Tests if the list contains the specified element. - The value to locate in the input list. - The input list. - True if the input list contains the specified element; false otherwise. - - - Returns a new list that contains the elements of each the lists in order. - The input sequence of lists. - The resulting concatenated list. - - - Compares two lists using the given comparison function, element by element. - Returns the first non-zero result from the comparison function. If the end of a list - is reached it returns a -1 if the first list is shorter and a 1 if the second list - is shorter. - - A function that takes an element from each list and returns an int. - If it evaluates to a non-zero value iteration is stopped and that value is returned. - The first input list. - The second input list. - - The first non-zero value from the comparison function. - - - For each element of the list, applies the given function. Concatenates all the results and return the combined list. - The function to transform each input element into a sublist to be concatenated. - The input list. - The concatenation of the transformed sublists. - - - Divides the input list into chunks of size at most chunkSize. - The maximum size of each chunk. - The input list. - The list divided into chunks. - Thrown when chunkSize is not positive. - - - Applies the given function to each element of the list. Returns - the list comprised of the results x for each element where - the function returns Some(x) - The function to generate options from the elements. - The input list. - The list comprising the values selected from the chooser function. - - - Returns the average of the elements generated by applying the function to each element of the list. - - Raises System.ArgumentException if list is empty. - The function to transform the list elements into the type to be averaged. - The input list. - Thrown when the list is empty. - The resulting average. - - - Returns the average of the elements in the list. - - Raises System.ArgumentException if list is empty. - The input list. - Thrown when the list is empty. - The resulting average. - - - Returns a new list that contains the elements of the first list - followed by elements of the second. - The first input list. - The second input list. - The resulting list. - - - Basic operations on lists. - - - Returns the key of the first mapping in the collection that satisfies the given predicate. - Returns 'None' if no such element exists. - The function to test the input elements. - The input map. - The first key for which the predicate returns true or None if the predicate evaluates to false for each key/value pair. - - - Evaluates the function on each mapping in the collection. Returns the key for the first mapping - where the function returns 'true'. Raise KeyNotFoundException if no such element exists. - The function to test the input elements. - The input map. - Thrown if the key does not exist in the map. - The first key for which the predicate evaluates true. - - - Lookup an element in the map, returning a Some value if the element is in the domain - of the map and None if not. - The input key. - The input map. - The found Some value or None. - - - Removes an element from the domain of the map. No exception is raised if the element is not present. - The input key. - The input map. - The resulting map. - - - Builds two new maps, one containing the bindings for which the given predicate returns 'true', - and the other the remaining bindings. - The function to test the input elements. - The input map. - A pair of maps in which the first contains the elements for which the predicate returned true - and the second containing the elements for which the predicated returned false. - - - Tests if an element is in the domain of the map. - The input key. - The input map. - True if the map contains the key. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The key passed to the - function indicates the key of element being transformed. - The function to transform the key/value pairs. - The input map. - The resulting map of keys and transformed values. - - - Returns true if the given predicate returns true for all of the - bindings in the map. - The function to test the input elements. - The input map. - True if the predicate evaluates to true for all of the bindings in the map. - - - Builds a new map containing only the bindings for which the given predicate returns 'true'. - The function to test the key/value pairs. - The input map. - The filtered map. - - - Returns true if the given predicate returns true for one of the - bindings in the map. - The function to test the input elements. - The input map. - True if the predicate returns true for one of the key/value pairs. - - - Applies the given function to each binding in the dictionary - The function to apply to each key/value pair. - The input map. - - - Folds over the bindings in the map - The function to update the state given the input key/value pairs. - The initial state. - The input map. - The final state value. - - - Folds over the bindings in the map. - The function to update the state given the input key/value pairs. - The input map. - The initial state. - The final state value. - - - Searches the map looking for the first element where the given function returns a Some value - The function to generate options from the key/value pairs. - The input map. - The first result. - - - Searches the map looking for the first element where the given function returns a Some value. - The function to generate options from the key/value pairs. - The input map. - The first result. - - - Lookup an element in the map, raising KeyNotFoundException if no binding - exists in the map. - The input key. - The input map. - Thrown when the key does not exist in the map. - The value mapped to the given key. - - - The empty map. - - - Is the map empty? - The input map. - True if the map is empty. - - - Returns an array of all key-value pairs in the mapping. - The array will be ordered by the keys of the map. - The input map. - The array of key/value pairs. - - - Returns a list of all key-value pairs in the mapping. - The list will be ordered by the keys of the map. - The input map. - The list of key/value pairs. - - - Views the collection as an enumerable sequence of pairs. - The sequence will be ordered by the keys of the map. - The input map. - The sequence of key/value pairs. - - - Returns a new map made from the given bindings. - The input sequence of key/value pairs. - The resulting map. - - - Returns a new map made from the given bindings. - The input array of key/value pairs. - The resulting map. - - - Returns a new map made from the given bindings. - The input list of key/value pairs. - The resulting map. - - - Returns a new map with the binding added to the given map. - The input key. - The input value. - The input map. - The resulting map. - - - Functional programming operators related to the Map<_,_> type. - - - Combines the three sequences into a list of triples. The sequences need not have equal lengths: - when one sequence is exhausted any remaining elements in the other - sequences are ignored. - - The first input sequence. - The second input sequence. - The third input sequence. - - The result sequence. - - Thrown when any of the input sequences is null. - - - Combines the two sequences into a list of pairs. The two sequences need not have equal lengths: - when one sequence is exhausted any remaining elements in the other - sequence are ignored. - - The first input sequence. - The second input sequence. - - The result sequence. - - Thrown when either of the input sequences is null. - - - Returns a sequence that yields sliding windows containing elements drawn from the input - sequence. Each window is returned as a fresh array. - The number of elements in each window. - The input sequence. - The result sequence. - Thrown when the input sequence is null. - Thrown when windowSize is not positive. - - - Returns a sequence that contains the elements generated by the given computation. - The given initial state argument is passed to the element generator. - For each IEnumerator elements in the stream are generated on-demand by applying the element - generator, until a None value is returned by the element generator. Each call to the element - generator returns a new residual state. - - The stream will be recomputed each time an IEnumerator is requested and iterated for the Seq. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - A function that takes in the current state and returns an option tuple of the next - element of the sequence and the next state value. - The initial state value. - - The result sequence. - - - Returns a sequence that when enumerated returns at most N elements. - - The maximum number of items to enumerate. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Applies the given function to successive elements, returning the first - result where the function returns "Some(x)". - - A function that transforms items from the input sequence into options. - The input sequence. - - The chosen element or None. - - Thrown when the input sequence is null. - - - Returns the index of the last element in the sequence - that satisfies the given predicate. Return None if no such element exists. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - The found index or None. - Thrown when the input sequence is null. - - - Tries to find the nth element in the sequence. - Returns None if index is negative or the input sequence does not contain enough elements. - The index of element to retrieve. - The input sequence. - The nth element of the sequence or None. - Thrown when the input sequence is null. - - - Returns the index of the first element in the sequence - that satisfies the given predicate. Return None if no such element exists. - - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - - The found index or None. - - Thrown when the input sequence is null. - - - Returns the last element for which the given function returns true. - Return None if no such element exists. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - The found element or None. - Thrown when the input sequence is null. - - - Returns the first element for which the given function returns true. - Return None if no such element exists. - - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - - The found element or None. - - Thrown when the input sequence is null. - - - Builds a list from the given collection. - - The input sequence. - - The result list. - - Thrown when the input sequence is null. - - - Builds an array from the given collection. - - The input sequence. - - The result array. - - Thrown when the input sequence is null. - - - Returns a sequence that, when iterated, yields elements of the underlying sequence while the - given predicate returns true, and then returns no further elements. - - A function that evaluates to false when no more items should be returned. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns the first N elements of the sequence. - Throws InvalidOperationException - if the count exceeds the number of elements in the sequence. Seq.truncate - returns as many items as the sequence contains instead of throwing an exception. - - The number of items to take. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - Thrown when count exceeds the number of elements - in the sequence. - - - Returns a sequence that skips 1 element of the underlying sequence and then yields the - remaining elements of the sequence. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the sum of the results generated by applying the function to each element of the sequence. - The generated elements are summed using the + operator and Zero property associated with the generated type. - - A function to transform items from the input sequence into the type that will be summed. - The input sequence. - - The computed sum. - - - Returns the sum of the elements in the sequence. - - The elements are summed using the + operator and Zero property associated with the generated type. - - The input sequence. - - The computed sum. - - - Applies a key-generating function to each element of a sequence and yield a sequence ordered - descending by keys. The keys are compared using generic comparison as implemented by Operators.compare. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - A function to transform items of the input sequence into comparable keys. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Yields a sequence ordered descending by keys. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Applies a key-generating function to each element of a sequence and yield a sequence ordered - by keys. The keys are compared using generic comparison as implemented by Operators.compare. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - A function to transform items of the input sequence into comparable keys. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Yields a sequence ordered using the given comparison function. - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - The function to compare the collection elements. - The input sequence. - The result sequence. - - - Yields a sequence ordered by keys. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that, when iterated, skips elements of the underlying sequence while the - given predicate returns true, and then yields the remaining elements of the sequence. - - A function that evaluates an element of the sequence to a boolean value. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that skips N elements of the underlying sequence and then yields the - remaining elements of the sequence. - - The number of items to skip. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when count exceeds the number of elements - in the sequence. - - - Returns a sequence that yields one item only. - - The input item. - - The result sequence of one item. - - - Like foldBack, but returns the sequence of intermediary and final results. - This function returns a sequence that digests the whole initial sequence as soon as that - sequence is iterated. As a result this function should not be used with large or infinite sequences. - - A function that updates the state with each element from the sequence. - The input sequence. - The initial state. - The resulting sequence of computed states. - Thrown when the input sequence is null. - - - Like fold, but computes on-demand and returns the sequence of intermediary and final results. - - A function that updates the state with each element from the sequence. - The initial state. - The input sequence. - - The resulting sequence of computed states. - - Thrown when the input sequence is null. - - - Returns a new sequence with the elements in reverse order. - The input sequence. - The reversed sequence. - Thrown when the input sequence is null. - - - Applies a function to each element of the sequence, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f i0 (...(f iN-1 iN)). - A function that takes in the next-to-last element of the sequence and the - current accumulated result to produce the next accumulated result. - The input sequence. - The final result of the reductions. - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Creates a sequence by replicating the given initial value. - The number of elements to replicate. - The value to replicate - The generated sequence. - - - Applies a function to each element of the sequence, threading an accumulator argument - through the computation. Begin by applying the function to the first two elements. - Then feed this result into the function along with the third element and so on. - Return the final result. - - A function that takes in the current accumulated result and the next - element of the sequence to produce the next accumulated result. - The input sequence. - - The final result of the reduction function. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Builds a new sequence object that delegates to the given sequence object. This ensures - the original sequence cannot be rediscovered and mutated by a type cast. For example, - if given an array the returned sequence will return the elements of the array, but - you cannot cast the returned sequence object to an array. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Applies the given function to successive elements, returning the first - x where the function returns "Some(x)". - - A function to transform each item of the input sequence into an option of the output type. - The input sequence. - - The selected element. - - Thrown when the input sequence is null. - Thrown when every item of the sequence - evaluates to None when the given function is applied. - - - Returns a sequence with all elements permuted according to the - specified permutation. - - Note that this function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. - - The function that maps input indices to output indices. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when indexMap does not produce a valid permutation. - - - Returns a sequence of each element in the input sequence and its predecessor, with the - exception of the first element which is only returned as the predecessor of the second element. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Views the given list as a sequence. - - The input list. - - The result sequence. - - - Views the given array as a sequence. - - The input array. - - The result sequence. - - Thrown when the input sequence is null. - - - Computes the nth element in the collection. - - The index of element to retrieve. - The input sequence. - - The nth element of the sequence. - - Thrown when the input sequence is null. - Thrown when the index is negative or the input sequence does not contain enough elements. - - - Returns the lowest of all elements of the sequence, compared via Operators.min on the function result. - - A function to transform items from the input sequence into comparable keys. - The input sequence. - - The smallest element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the lowest of all elements of the sequence, compared via Operators.min. - - The input sequence. - - The smallest element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the greatest of all elements of the sequence, compared via Operators.max on the function result. - - A function to transform items from the input sequence into comparable keys. - The input sequence. - - The largest element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the greatest of all elements of the sequence, compared via Operators.max - - The input sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - The largest element of the sequence. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding pairs of elements from the two sequences. If one input sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. The integer index passed to the - function indicates the index (from 0) of element being transformed. - - A function to transform pairs of items from the input sequences that also supplies the current index. - The first input sequence. - The second input sequence. - - The result sequence. - - Thrown when either of the input sequences is null. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The integer index passed to the - function indicates the index (from 0) of element being transformed. - - A function to transform items from the input sequence that also supplies the current index. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding triples of elements from the three sequences. If one input sequence if shorter than - the others then the remaining elements of the longer sequences are ignored. - - The function to transform triples of elements from the input sequences. - The first input sequence. - The second input sequence. - The third input sequence. - - The result sequence. - - Thrown when any of the input sequences is null. - - - Combines map and foldBack. Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The function is also used to accumulate a final value. - This function digests the whole initial sequence as soon as it is called. As a result this function should - not be used with large or infinite sequences. - The function to transform elements from the input collection and accumulate the final value. - The input collection. - The initial state. - Thrown when the input collection is null. - The collection of transformed elements, and the final accumulated value. - - - Combines map and fold. Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The function is also used to accumulate a final value. - This function digests the whole initial sequence as soon as it is called. As a result this function should - not be used with large or infinite sequences. - The function to transform elements from the input collection and accumulate the final value. - The initial state. - The input collection. - Thrown when the input collection is null. - The collection of transformed elements, and the final accumulated value. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding pairs of elements from the two sequences. If one input sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to transform pairs of items from the input sequences. - The first input sequence. - The second input sequence. - - The result sequence. - - Thrown when either of the input sequences is null. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The given function will be applied - as elements are demanded using the MoveNext method on enumerators retrieved from the - object. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - A function to transform items from the input sequence. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns the length of the sequence - - The input sequence. - - The length of the sequence. - - Thrown when the input sequence is null. - - - Applies the given function to two collections simultaneously. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. The integer passed to the - function indicates the index of element. - - A function to apply to each pair of elements from the input sequences along with their index. - The first input sequence. - The second input sequence. - - Thrown when either of the input sequences is null. - - - Applies the given function to two collections simultaneously. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to apply to each pair of elements from the input sequences. - The first input sequence. - The second input sequence. - - Thrown when either of the input sequences is null. - - - Applies the given function to each element of the collection. The integer passed to the - function indicates the index of element. - - A function to apply to each element of the sequence that can also access the current index. - The input sequence. - - Thrown when the input sequence is null. - - - Applies the given function to each element of the collection. - - A function to apply to each element of the sequence. - The input sequence. - - Thrown when the input sequence is null. - - - Computes the element at the specified index in the collection. - The index of the element to retrieve. - The input sequence. - The element at the specified index of the sequence. - Thrown when the input sequence is null. - Thrown when the index is negative or the input sequence does not contain enough elements. - - - Generates a new sequence which, when iterated, will return successive - elements by calling the given function. The results of calling the function - will not be saved, that is the function will be reapplied as necessary to - regenerate the elements. The function is passed the index of the item being - generated. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - Iteration can continue up to Int32.MaxValue. - - A function that generates an item in the sequence from a given index. - - The result sequence. - - - Generates a new sequence which, when iterated, will return successive - elements by calling the given function, up to the given count. Each element is saved after its - initialization. The function is passed the index of the item being - generated. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - The maximum number of items to generate for the sequence. - A function that generates an item in the sequence from a given index. - - The result sequence. - - Thrown when count is negative. - - - Builds a new collection whose elements are the corresponding elements of the input collection - paired with the integer index (from 0) of each element. - The input sequence. - The result sequence. - Thrown when the input sequence is null. - - - Returns true if the sequence contains no elements, false otherwise. - - The input sequence. - - True if the sequence is empty; false otherwise. - - Thrown when the input sequence is null. - - - Returns the only element of the sequence. - - The input sequence. - - The only element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input does not have precisely one element. - - - Returns the last element of the sequence. - Return None if no such element exists. - - The input sequence. - - The last element of the sequence or None. - - Thrown when the input sequence is null. - - - Returns the last element of the sequence. - The input sequence. - The last element of the sequence. - Thrown when the input sequence is null. - Thrown when the input does not have any elements. - - - Returns the first element of the sequence, or None if the sequence is empty. - - The input sequence. - - The first element of the sequence or None. - - Thrown when the input sequence is null. - - - Returns the first element of the sequence. - - The input sequence. - - The first element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input does not have any elements. - - - Applies a key-generating function to each element of a sequence and yields a sequence of - unique keys. Each unique key contains a sequence of all elements that match - to this key. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - A function that transforms an element of the sequence into a comparable key. - The input sequence. - - The result sequence. - - - Tests the all pairs of elements drawn from the two sequences satisfy the - given predicate. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to test pairs of elements from the input sequences. - The first input sequence. - The second input sequence. - - True if all pairs satisfy the predicate; false otherwise. - - Thrown when either of the input sequences is null. - - - Tests if all elements of the sequence satisfy the given predicate. - - The predicate is applied to the elements of the input sequence. If any application - returns false then the overall result is false and no further elements are tested. - Otherwise, true is returned. - - A function to test an element of the input sequence. - The input sequence. - - True if every element of the sequence satisfies the predicate; false otherwise. - - Thrown when the input sequence is null. - - - Applies a function to corresponding elements of two collections, starting from the end of the shorter collection, - threading an accumulator argument through the computation. The two sequences need not have equal lengths. - If the input function is f and the elements are i0...iN and j0...jM, N < M - then computes f i0 j0 (... (f iN jN s)...). - The function to update the state given the input elements. - The first input sequence. - The second input sequence. - The initial state. - The final state value. - Thrown when the either of the input sequences is null. - - - Applies a function to each element of the collection, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f i0 (... (f iN s)...) - The function to update the state given the input elements. - The input sequence. - The initial state. - The state object after the folding function is applied to each element of the sequence. - Thrown when the input sequence is null. - - - Applies a function to corresponding elements of two collections, threading an accumulator argument - through the computation. The two sequences need not have equal lengths: - when one sequence is exhausted any remaining elements in the other sequence are ignored. - If the input function is f and the elements are i0...iN and j0...jN - then computes f (... (f s i0 j0)...) iN jN. - The function to update the state given the input elements. - The initial state. - The first input sequence. - The second input sequence. - The final state value. - Thrown when the either of the input sequences is null. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f (... (f s i0)...) iN - - A function that updates the state with each element from the sequence. - The initial state. - The input sequence. - - The state object after the folding function is applied to each element of the sequence. - - Thrown when the input sequence is null. - - - Returns the index of the last element for which the given function returns true. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function to test whether the index of a particular element should be returned. - The input sequence. - The index of the last element for which the predicate returns true. - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns the index of the first element for which the given function returns true. - - A function to test whether the index of a particular element should be returned. - The input sequence. - - The index of the first element for which the predicate returns true. - - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns the last element for which the given function returns true. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function to test whether an item in the sequence should be returned. - The input sequence. - The last element for which the predicate returns true. - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns the first element for which the given function returns true. - - A function to test whether an item in the sequence should be returned. - The input sequence. - - The first element for which the predicate returns true. - - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true". - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - Remember sequence is lazy, effects are delayed until it is enumerated. - - A synonym for Seq.filter. - - A function to test whether each item in the input sequence should be included in the output. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true". This is a synonym for Seq.where. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - Remember sequence is lazy, effects are delayed until it is enumerated. - - A function to test whether each item in the input sequence should be included in the output. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Tests if any pair of corresponding elements of the input sequences satisfies the given predicate. - - The predicate is applied to matching elements in the two sequences up to the lesser of the - two lengths of the collections. If any application returns true then the overall result is - true and no further elements are tested. Otherwise, false is returned. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to test each pair of items from the input sequences. - The first input sequence. - The second input sequence. - - True if any result from the predicate is true; false otherwise. - - Thrown when either of the two input sequences is null. - - - Tests if any element of the sequence satisfies the given predicate. - - The predicate is applied to the elements of the input sequence. If any application - returns true then the overall result is true and no further elements are tested. - Otherwise, false is returned. - - A function to test each item of the input sequence. - The input sequence. - - True if any result from the predicate is true; false otherwise. - - Thrown when the input sequence is null. - - - Returns a new sequence with the distinct elements of the second sequence which do not apear in the first sequence, - using generic hash and equality comparisons to compare values. - - Note that this function returns a sequence that digests the whole of the first input sequence as soon as - the result sequence is iterated. As a result this function should not be used with - large or infinite sequences in the first parameter. The function makes no assumption on the ordering of the first input - sequence. - - A sequence whose elements that also occur in the second sequence will cause those elements to be - removed from the returned sequence. - A sequence whose elements that are not also in first will be returned. - - A sequence that contains the set difference of the elements of two sequences. - - Thrown when either of the two input sequences is null. - - - Creates an empty sequence. - - An empty sequence. - - - Splits the input sequence into at most count chunks. - This function returns a sequence that digests the whole initial sequence as soon as that - sequence is iterated. As a result this function should not be used with large or infinite sequences. - The maximum number of chunks. - The input sequence. - The sequence split into chunks. - Thrown when the input sequence is null. - Thrown when count is not positive. - - - Returns a sequence that contains no duplicate entries according to the - generic hash and equality comparisons on the keys returned by the given key-generating function. - If an element occurs multiple times in the sequence then the later occurrences are discarded. - - A function transforming the sequence items into comparable keys. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that contains no duplicate entries according to generic hash and - equality comparisons on the entries. - If an element occurs multiple times in the sequence then the later occurrences are discarded. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that is built from the given delayed specification of a - sequence. - - The input function is evaluated each time an IEnumerator for the sequence - is requested. - - The generating function for the sequence. - - - Applies a key-generating function to each element of a sequence and returns a sequence yielding unique - keys and their number of occurrences in the original sequence. - - Note that this function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - A function transforming each item of the input sequence into a key to be - compared against the others. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Tests if the sequence contains the specified element. - The value to locate in the input sequence. - The input sequence. - True if the input sequence contains the specified element; false otherwise. - Thrown when the input sequence is null. - - - Combines the given enumeration-of-enumerations as a single concatenated - enumeration. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - The input enumeration-of-enumerations. - - The result sequence. - - Thrown when the input sequence is null. - - - Compares two sequences using the given comparison function, element by element. - Returns the first non-zero result from the comparison function. If the end of a sequence - is reached it returns a -1 if the first sequence is shorter and a 1 if the second sequence - is shorter. - - A function that takes an element from each sequence and returns an int. - If it evaluates to a non-zero value iteration is stopped and that value is returned. - The first input sequence. - The second input sequence. - - The first non-zero value from the comparison function. - - Thrown when either of the input sequences - is null. - - - Applies the given function to each element of the sequence and concatenates all the - results. - - Remember sequence is lazy, effects are delayed until it is enumerated. - - A function to transform elements of the input sequence into the sequences - that will then be concatenated. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Divides the input sequence into chunks of size at most chunkSize. - The maximum size of each chunk. - The input sequence. - The sequence divided into chunks. - Thrown when the input sequence is null. - Thrown when chunkSize is not positive. - - - Applies the given function to each element of the list. Return - the list comprised of the results "x" for each element where - the function returns Some(x). - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not - be accessed concurrently. - - A function to transform items of type T into options of type U. - The input sequence of type T. - - The result sequence. - - Thrown when the input sequence is null. - - - Wraps a loosely-typed System.Collections sequence as a typed sequence. - - The use of this function usually requires a type annotation. - An incorrect type annotation may result in runtime type - errors. - Individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that corresponds to a cached version of the input sequence. - This result sequence will have the same elements as the input sequence. The result - can be enumerated multiple times. The input sequence will be enumerated at most - once and only as far as is necessary. Caching a sequence is typically useful when repeatedly - evaluating items in the original sequence is computationally expensive or if - iterating the sequence causes side-effects that the user does not want to be - repeated multiple times. - - Enumeration of the result sequence is thread safe in the sense that multiple independent IEnumerator - values may be used simultaneously from different threads (accesses to - the internal lookaside table are thread safe). Each individual IEnumerator - is not typically thread safe and should not be accessed concurrently. - - Once enumeration of the input sequence has started, - it's enumerator will be kept live by this object until the enumeration has completed. - At that point, the enumerator will be disposed. - - The enumerator may be disposed and underlying cache storage released by - converting the returned sequence object to type IDisposable, and calling the Dispose method - on this object. The sequence object may then be re-enumerated and a fresh enumerator will - be used. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns the average of the results generated by applying the function to each element - of the sequence. - - The elements are averaged using the + operator, DivideByInt method and Zero property - associated with the generated type. - - A function applied to transform each element of the sequence. - The input sequence. - - The average. - - Thrown when the input sequence is null. - Thrown when the input sequence has zero elements. - - - Returns the average of the elements in the sequence. - - The elements are averaged using the + operator, DivideByInt method and Zero property - associated with the element type. - - The input sequence. - - The average. - - Thrown when the input sequence is null. - Thrown when the input sequence has zero elements. - - - Wraps the two given enumerations as a single concatenated - enumeration. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed - concurrently. - - The first sequence. - The second sequence. - - The result sequence. - - Thrown when either of the two provided sequences is - null. - - - Basic operations on IEnumerables. - - - Returns a new set with the elements of the second set removed from the first. - The first input set. - The set whose elements will be removed from set1. - The set with the elements of set2 removed from set1. - - - Builds a new collection from the given enumerable object. - The input sequence. - The set containing elements. - - - Returns an ordered view of the collection as an enumerable object. - The input set. - An ordered sequence of the elements of set. - - - Builds an array that contains the elements of the set in order. - The input set. - An ordered array of the elements of set. - - - Builds a set that contains the same elements as the given array. - The input array. - A set containing the elements of array. - - - Builds a list that contains the elements of the set in order. - The input set. - An ordered list of the elements of set. - - - Builds a set that contains the same elements as the given list. - The input list. - A set containing the elements form the input list. - - - Returns the highest element in the set according to the ordering being used for the set. - The input set. - The max value from the set. - - - Returns the lowest element in the set according to the ordering being used for the set. - The input set. - The min value from the set. - - - Returns a new set with the given element removed. No exception is raised if - the set doesn't contain the given element. - The element to remove. - The input set. - The input set with value removed. - - - Splits the set into two sets containing the elements for which the given predicate - returns true and false respectively. - The function to test set elements. - The input set. - A pair of sets with the first containing the elements for which predicate returns - true and the second containing the elements for which predicate returns false. - - - Applies the given function to each element of the set, in order according - to the comparison function. - The function to apply to each element. - The input set. - - - Returns "true" if the set is empty. - The input set. - True if set is empty. - - - Computes the union of a sequence of sets. - The sequence of sets to untion. - The union of the input sets. - - - Computes the union of the two sets. - The first input set. - The second input set. - The union of set1 and set2. - - - Computes the intersection of a sequence of sets. The sequence must be non-empty. - The sequence of sets to intersect. - The intersection of the input sets. - - - Computes the intersection of the two sets. - The first input set. - The second input set. - The intersection of set1 and set2. - - - Tests if all elements of the collection satisfy the given predicate. - If the input function is f and the elements are i0...iN and "j0...jN" - then computes p i0 && ... && p iN. - The function to test set elements. - The input set. - True if all elements of set satisfy predicate. - - - Applies the given accumulating function to all the elements of the set. - The accumulating function. - The input set. - The initial state. - The final state. - - - Applies the given accumulating function to all the elements of the set - The accumulating function. - The initial state. - The input set. - The final state. - - - Returns a new collection containing the results of applying the - given function to each element of the input set. - The function to transform elements of the input set. - The input set. - A set containing the transformed elements. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns true. - The function to test set elements. - The input set. - The set containing only the elements for which predicate returns true. - - - Tests if any element of the collection satisfies the given predicate. - If the input function is predicate and the elements are i0...iN - then computes p i0 or ... or p iN. - The function to test set elements. - The input set. - True if any element of set satisfies predicate. - - - Returns the number of elements in the set. Same as size. - The input set. - The number of elements in the set. - - - Evaluates to "true" if all elements of the second set are in the first, and at least - one element of the first is not in the second. - The potential superset. - The set to test against. - True if set1 is a proper superset of set2. - - - Evaluates to "true" if all elements of the second set are in the first. - The potential superset. - The set to test against. - True if set1 is a superset of set2. - - - Evaluates to "true" if all elements of the first set are in the second, and at least - one element of the second is not in the first. - The potential subset. - The set to test against. - True if set1 is a proper subset of set2. - - - Evaluates to "true" if all elements of the first set are in the second - The potential subset. - The set to test against. - True if set1 is a subset of set2. - - - Evaluates to "true" if the given element is in the given set. - The element to test. - The input set. - True if element is in set. - - - Returns a new set with an element added to the set. No exception is raised if - the set already contains the given element. - The value to add. - The input set. - A new set containing value. - - - The set containing the given element. - The value for the set to contain. - The set containing value. - - - The empty set for the type 'T. - - - Functional programming operators related to the Set<_> type. - - - Gets the default cancellation token for executing asynchronous computations. - The default CancellationToken. - - - Creates an asynchronous computation that returns the CancellationToken governing the execution - of the computation. - In async { let! token = Async.CancellationToken ...} token can be used to initiate other - asynchronous operations that will cancel cooperatively with this workflow. - An asynchronous computation capable of retrieving the CancellationToken from a computation - expression. - - - Creates an asynchronous computation that executes computation. - If this computation is cancelled before it completes then the computation generated by - running compensation is executed. - The input asynchronous computation. - The function to be run if the computation is cancelled. - An asynchronous computation that runs the compensation if the input computation - is cancelled. - - - Creates an asynchronous computation that queues a work item that runs - its continuation. - A computation that generates a new work item in the thread pool. - - - Creates an asynchronous computation that creates a new thread and runs - its continuation in that thread. - A computation that will execute on a new thread. - - - Creates an asynchronous computation that runs - its continuation using syncContext.Post. If syncContext is null - then the asynchronous computation is equivalent to SwitchToThreadPool(). - The synchronization context to accept the posted computation. - An asynchronous computation that uses the syncContext context to execute. - - - Runs an asynchronous computation, starting immediately on the current operating system - thread. Call one of the three continuations when the operation completes. - If no cancellation token is provided then the default cancellation token - is used. - The asynchronous computation to execute. - The function called on success. - The function called on exception. - The function called on cancellation. - The CancellationToken to associate with the computation. - The default is used if this parameter is not provided. - - - Runs an asynchronous computation, starting immediately on the current operating system - thread. - If no cancellation token is provided then the default cancellation token is used. - The asynchronous computation to execute. - The CancellationToken to associate with the computation. - The default is used if this parameter is not provided. - - - Creates an asynchronous computation which starts the given computation as a System.Threading.Tasks.Task - - - Starts a child computation within an asynchronous workflow. - This allows multiple asynchronous computations to be executed simultaneously. - - This method should normally be used as the immediate - right-hand-side of a let! binding in an F# asynchronous workflow, that is, - - async { ... - let! completor1 = childComputation1 |> Async.StartChild - let! completor2 = childComputation2 |> Async.StartChild - ... - let! result1 = completor1 - let! result2 = completor2 - ... } - - When used in this way, each use of StartChild starts an instance of childComputation - and returns a completor object representing a computation to wait for the completion of the operation. - When executed, the completor awaits the completion of childComputation. - The child computation. - The timeout value in milliseconds. If one is not provided - then the default value of -1 corresponding to System.Threading.Timeout.Infinite. - A new computation that waits for the input computation to finish. - - - Executes a computation in the thread pool. - If no cancellation token is provided then the default cancellation token is used. - A System.Threading.Tasks.Task that will be completed - in the corresponding state once the computation terminates (produces the result, throws exception or gets canceled) - - - - Starts the asynchronous computation in the thread pool. Do not await its result. - - If no cancellation token is provided then the default cancellation token is used. - The computation to run asynchronously. - The cancellation token to be associated with the computation. - If one is not supplied, the default cancellation token is used. - - - Creates an asynchronous computation that will sleep for the given time. This is scheduled - using a System.Threading.Timer object. The operation will not block operating system threads - for the duration of the wait. - The number of milliseconds to sleep. - An asynchronous computation that will sleep for the given time. - Thrown when the due time is negative - and not infinite. - - - Runs the asynchronous computation and await its result. - - If an exception occurs in the asynchronous computation then an exception is re-raised by this - function. - - If no cancellation token is provided then the default cancellation token is used. - - The timeout parameter is given in milliseconds. A value of -1 is equivalent to - System.Threading.Timeout.Infinite. - The computation to run. - The amount of time in milliseconds to wait for the result of the - computation before raising a System.TimeoutException. If no value is provided - for timeout then a default of -1 is used to correspond to System.Threading.Timeout.Infinite. - The cancellation token to be associated with the computation. - If one is not supplied, the default cancellation token is used. - The result of the computation. - - - Creates an asynchronous computation that executes all the given asynchronous computations, - initially queueing each as work items and using a fork/join pattern. - - If all child computations succeed, an array of results is passed to the success continuation. - - If any child computation raises an exception, then the overall computation will trigger an - exception, and cancel the others. - - The overall computation will respond to cancellation while executing the child computations. - If cancelled, the computation will cancel any remaining child computations but will still wait - for the other child computations to complete. - A sequence of distinct computations to be parallelized. - A computation that returns an array of values from the sequence of input computations. - - - Generates a scoped, cooperative cancellation handler for use within an asynchronous workflow. - - For example, - async { use! holder = Async.OnCancel interruption ... } - generates an asynchronous computation where, if a cancellation happens any time during - the execution of the asynchronous computation in the scope of holder, then action - interruption is executed on the thread that is performing the cancellation. This can - be used to arrange for a computation to be asynchronously notified that a cancellation - has occurred, e.g. by setting a flag, or deregistering a pending I/O action. - The function that is executed on the thread performing the - cancellation. - An asynchronous computation that triggers the interruption if it is cancelled - before being disposed. - - - Creates an asynchronous computation that runs the given computation and ignores - its result. - The input computation. - A computation that is equivalent to the input computation, but disregards the result. - - - Creates an asynchronous computation that captures the current - success, exception and cancellation continuations. The callback must - eventually call exactly one of the given continuations. - The function that accepts the current success, exception, and cancellation - continuations. - An asynchronous computation that provides the callback with the current continuations. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. This overlaod should be used if the operation is - qualified by three arguments. For example, - Async.FromBeginEnd(arg1,arg2,arg3,ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The first argument for the operation. - The second argument for the operation. - The third argument for the operation. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. This overlaod should be used if the operation is - qualified by two arguments. For example, - Async.FromBeginEnd(arg1,arg2,ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The first argument for the operation. - The second argument for the operation. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. This overlaod should be used if the operation is - qualified by one argument. For example, - Async.FromBeginEnd(place,ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The argument for the operation. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. For example, - Async.FromBeginEnd(ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation that executes computation. - If this computation completes successfully then return Choice1Of2 with the returned - value. If this computation raises an exception before it completes then return Choice2Of2 - with the raised exception. - The input computation that returns the type T. - A computation that returns a choice of type T or exception. - - - Raises the cancellation condition for the most recent set of asynchronous computations started - without any specific CancellationToken. Replaces the global CancellationTokenSource with a new - global token source for any asynchronous computations created after this point without any - specific CancellationToken. - - - Creates an asynchronous computation that will wait on the given WaitHandle. - - The computation returns true if the handle indicated a result within the given timeout. - The WaitHandle that can be signalled. - The timeout value in milliseconds. If one is not provided - then the default value of -1 corresponding to System.Threading.Timeout.Infinite. - An asynchronous computation that waits on the given WaitHandle. - - - - Return an asynchronous computation that will wait for the given task to complete and return - its result. - - - - - Return an asynchronous computation that will wait for the given task to complete and return - its result. - - - - Creates an asynchronous computation that will wait on the IAsyncResult. - - The computation returns true if the handle indicated a result within the given timeout. - The IAsyncResult to wait on. - The timeout value in milliseconds. If one is not provided - then the default value of -1 corresponding to System.Threading.Timeout.Infinite. - An asynchronous computation that waits on the given IAsyncResult. - - - Creates an asynchronous computation that waits for a single invocation of a CLI - event by adding a handler to the event. Once the computation completes or is - cancelled, the handler is removed from the event. - - The computation will respond to cancellation while waiting for the event. If a - cancellation occurs, and cancelAction is specified, then it is executed, and - the computation continues to wait for the event. - - If cancelAction is not specified, then cancellation causes the computation - to cancel immediately. - The event to handle once. - An optional function to execute instead of cancelling when a - cancellation is issued. - An asynchronous computation that waits for the event to be invoked. - - - Creates three functions that can be used to implement the .NET Asynchronous - Programming Model (APM) for a given asynchronous computation. - - The functions should normally be published as members with prefix Begin, - End and Cancel, and can be used within a type definition as follows: - - let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun arg -> computation) - member x.BeginSomeOperation(arg,callback,state:obj) = beginAction(arg,callback,state) - member x.EndSomeOperation(iar) = endAction(iar) - member x.CancelSomeOperation(iar) = cancelAction(iar) - - - If the asynchronous computation takes no arguments, then AsBeginEnd is used as follows: - - let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun () -> computation) - member x.BeginSomeOperation(callback,state:obj) = beginAction((),callback,state) - member x.EndSomeOperation(iar) = endAction(iar) - member x.CancelSomeOperation(iar) = cancelAction(iar) - - - - If the asynchronous computation takes two arguments, then AsBeginEnd is used as follows: - - let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun arg1 arg2 -> computation) - member x.BeginSomeOperation(arg1,arg2,callback,state:obj) = beginAction((),callback,state) - member x.EndSomeOperation(iar) = endAction(iar) - member x.CancelSomeOperation(iar) = cancelAction(iar) - - - In each case, the resulting API will be familiar to programmers in other CLI languages and - is a useful way to publish asynchronous computations in CLI components. - A function generating the asynchronous computation to split into the traditional - .NET Asynchronous Programming Model. - A tuple of the begin, end, and cancel members. - - - This static class holds members for creating and manipulating asynchronous computations. - - - Creates an asynchronous computation that just returns (). - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of empty else branches in the - async { ... } computation expression syntax. - An asynchronous computation that returns (). - - - Creates an asynchronous computation that runs computation repeatedly - until guard() becomes false. - - A cancellation check is performed whenever the computation is executed. - - The existence of this method permits the use of while in the - async { ... } computation expression syntax. - The function to determine when to stop executing computation. - The function to be executed. Equivalent to the body - of a while expression. - An asynchronous computation that behaves similarly to a while loop when run. - - - Creates an asynchronous computation that runs binder(resource). - The action resource.Dispose() is executed as this computation yields its result - or if the asynchronous computation exits by an exception or by cancellation. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of use and use! in the - async { ... } computation expression syntax. - The resource to be used and disposed. - The function that takes the resource and returns an asynchronous - computation. - An asynchronous computation that binds and eventually disposes resource. - - - Creates an asynchronous computation that runs computation and returns its result. - If an exception happens then catchHandler(exn) is called and the resulting computation executed instead. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of try/with in the - async { ... } computation expression syntax. - The input computation. - The function to run when computation throws an exception. - An asynchronous computation that executes computation and calls catchHandler if an - exception is thrown. - - - Creates an asynchronous computation that runs computation. The action compensation is executed - after computation completes, whether computation exits normally or by an exception. If compensation raises an exception itself - the original exception is discarded and the new exception becomes the overall result of the computation. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of try/finally in the - async { ... } computation expression syntax. - The input computation. - The action to be run after computation completes or raises an - exception (including cancellation). - An asynchronous computation that executes computation and compensation aftewards or - when an exception is raised. - - - Delegates to the input computation. - - The existence of this method permits the use of return! in the - async { ... } computation expression syntax. - The input computation. - The input computation. - - - Creates an asynchronous computation that returns the result v. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of return in the - async { ... } computation expression syntax. - The value to return from the computation. - An asynchronous computation that returns value when executed. - - - Creates an asynchronous computation that enumerates the sequence seq - on demand and runs body for each element. - - A cancellation check is performed on each iteration of the loop. - - The existence of this method permits the use of for in the - async { ... } computation expression syntax. - The sequence to enumerate. - A function to take an item from the sequence and create - an asynchronous computation. Can be seen as the body of the for expression. - An asynchronous computation that will enumerate the sequence and run body - for each element. - - - Creates an asynchronous computation that runs generator. - - A cancellation check is performed when the computation is executed. - The function to run. - An asynchronous computation that runs generator. - - - Creates an asynchronous computation that first runs computation1 - and then runs computation2, returning the result of computation2. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of expression sequencing in the - async { ... } computation expression syntax. - The first part of the sequenced computation. - The second part of the sequenced computation. - An asynchronous computation that runs both of the computations sequentially. - - - Creates an asynchronous computation that runs computation, and when - computation generates a result T, runs binder res. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of let! in the - async { ... } computation expression syntax. - The computation to provide an unbound result. - The function to bind the result of computation. - An asynchronous computation that performs a monadic bind on the result - of computation. - - - - Generate an object used to build asynchronous computations using F# computation expressions. The value - 'async' is a pre-defined instance of this type. - - A cancellation check is performed when the computation is executed. - - - - The type of the async operator, used to build workflows for asynchronous computations. - - - Sends a reply to a PostAndReply message. - The value to send. - - - A handle to a capability to reply to a PostAndReply message. - - - A compositional asynchronous computation, which, when run, will eventually produce a value - of type T, or else raises an exception. - - Asynchronous computations are normally specified using an F# computation expression. - - When run, asynchronous computations have two modes: as a work item (executing synchronous - code), or as a wait item (waiting for an event or I/O completion). - - When run, asynchronous computations can be governed by CancellationToken. This can usually - be specified when the async computation is started. The associated CancellationTokenSource - may be used to cancel the asynchronous computation. Asynchronous computations built using - computation expressions can check the cancellation condition regularly. Synchronous - computations within an asynchronous computation do not automatically check this condition. - - - Publishes the event as a first class event value. - - - Triggers the event using the given parameters. - The parameters for the event. - - - Creates an event object suitable for implementing an arbitrary type of delegate. - The event object. - - - Event implementations for an arbitrary type of delegate. - - - Publishes an observation as a first class value. - - - Triggers an observation using the given parameters. - The event parameters. - - - Creates an observable object. - The created event. - - - Event implementations for the IEvent<_> type. - - - Publishes the event as a first class event value. - - - Triggers the event using the given sender object and parameters. The sender object may be null. - The object triggering the event. - The parameters for the event. - - - Creates an event object suitable for delegate types following the standard .NET Framework convention of a first 'sender' argument. - The created event. - - - Event implementations for a delegate types following the standard .NET Framework convention of a first 'sender' argument. - - - A delegate type associated with the F# event type IEvent<_> - The object that fired the event. - The event arguments. - - - Remove a listener delegate from an event listener store. - The delegate to be removed from the event listener store. - - - Connect a handler delegate object to the event. A handler can - be later removed using RemoveHandler. The listener will - be invoked when the event is fired. - A delegate to be invoked when the event is fired. - - - First class event values for arbitrary delegate types. - - F# gives special status to member properties compatible with type IDelegateEvent and - tagged with the CLIEventAttribute. In this case the F# compiler generates approriate - CLI metadata to make the member appear to other CLI languages as a CLI event. - - - First-class listening points (i.e. objects that permit you to register a callback - activated when the event is triggered). - - - First class event values for CLI events conforming to CLI Framework standards. - - - The type of delayed computations. - - Use the values in the Lazy module to manipulate - values of this type, and the notation lazy expr to create values - of type . - - - Raises a timeout exception if a message not received in this amount of time. By default - no timeout is used. - - - Occurs when the execution of the agent results in an exception. - - - Occurs when the execution of the agent results in an exception. - - - Raises a timeout exception if a message not received in this amount of time. By default - no timeout is used. - - - Returns the number of unprocessed messages in the message queue of the agent. - - - Occurs when the execution of the agent results in an exception. - - - Scans for a message by looking through messages in arrival order until scanner - returns a Some value. Other messages remain in the queue. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - The function to return None if the message is to be skipped - or Some if the message is to be processed and removed from the queue. - An optional timeout in milliseconds. Defaults to -1 which corresponds - to System.Threading.Timeout.Infinite. - An asynchronous computation that scanner built off the read message. - - - Waits for a message. This will consume the first message in arrival order. - - This method is for use within the body of the agent. - - Returns None if a timeout is given and the timeout is exceeded. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - An optional timeout in milliseconds. Defaults to -1 which - corresponds to System.Threading.Timeout.Infinite. - An asynchronous computation that returns the received message or - None if the timeout is exceeded. - - - Like PostAndReply, but returns None if no reply within the timeout period. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - The reply from the agent or None if the timeout expires. - - - Starts the agent. - - - Creates and starts an agent. The body function is used to generate the asynchronous - computation executed by the agent. - The function to produce an asynchronous computation that will be executed - as the read loop for the MailboxProcessor when Start is called. - An optional cancellation token for the body. - Defaults to Async.DefaultCancellationToken. - The created MailboxProcessor. - - - Scans for a message by looking through messages in arrival order until scanner - returns a Some value. Other messages remain in the queue. - - Returns None if a timeout is given and the timeout is exceeded. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - The function to return None if the message is to be skipped - or Some if the message is to be processed and removed from the queue. - An optional timeout in milliseconds. Defaults to -1 which corresponds - to System.Threading.Timeout.Infinite. - An asynchronous computation that scanner built off the read message. - Thrown when the timeout is exceeded. - - - Waits for a message. This will consume the first message in arrival order. - - This method is for use within the body of the agent. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - An optional timeout in milliseconds. Defaults to -1 which corresponds - to System.Threading.Timeout.Infinite. - An asynchronous computation that returns the received message. - Thrown when the timeout is exceeded. - - - Like AsyncPostAndReply, but returns None if no reply within the timeout period. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - An asynchronous computation that will return the reply or None if the timeout expires. - - - Posts a message to an agent and await a reply on the channel, synchronously. - - The message is generated by applying buildMessage to a new reply channel - to be incorporated into the message. The receiving agent must process this - message and invoke the Reply method on this reply channel precisely once. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - The reply from the agent. - - - Posts a message to an agent and await a reply on the channel, asynchronously. - - The message is generated by applying buildMessage to a new reply channel - to be incorporated into the message. The receiving agent must process this - message and invoke the Reply method on this reply channel precisely once. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - An asychronous computation that will wait for the reply from the agent. - - - Posts a message to the message queue of the MailboxProcessor, asynchronously. - The message to post. - - - Creates an agent. The body function is used to generate the asynchronous - computation executed by the agent. This function is not executed until - Start is called. - The function to produce an asynchronous computation that will be executed - as the read loop for the MailboxProcessor when Start is called. - An optional cancellation token for the body. - Defaults to Async.DefaultCancellationToken. - The created MailboxProcessor. - - - A message-processing agent which executes an asynchronous computation. - - The agent encapsulates a message queue that supports multiple-writers and - a single reader agent. Writers send messages to the agent by using the Post - method and its variations. - - The agent may wait for messages using the Receive or TryReceive methods or - scan through all available messages using the Scan or TryScan method. - - - Connects a listener function to the observable. The listener will - be invoked for each observation. The listener can be removed by - calling Dispose on the returned IDisposable object. - The function to be called for each observation. - An object that will remove the listener if disposed. - - - Permanently connects a listener function to the observable. The listener will - be invoked for each observation. - The function to be called for each observation. - - - Returns an asynchronous computation that will write the given bytes to the stream. - The buffer to write from. - An optional offset as a number of bytes in the stream. - An optional number of bytes to write to the stream. - An asynchronous computation that will write the given bytes to the stream. - Thrown when the sum of offset and count is longer than - the buffer length. - Thrown when offset or count is negative. - - - Returns an asynchronous computation that will read the given number of bytes from the stream. - The number of bytes to read. - An asynchronous computation that returns the read byte[] when run. - - - Returns an asynchronous computation that will read from the stream into the given buffer. - The buffer to read into. - An optional offset as a number of bytes in the stream. - An optional number of bytes to read from the stream. - An asynchronous computation that will read from the stream into the given buffer. - Thrown when the sum of offset and count is longer than - the buffer length. - Thrown when offset or count is negative. - - - A module of extension members providing asynchronous operations for some basic CLI types related to concurrency and I/O. - - - Returns a new event that triggers on the second and subsequent triggerings of the input event. - The Nth triggering of the input event passes the arguments from the N-1th and Nth triggering as - a pair. The argument passed to the N-1th triggering is held in hidden internal state until the - Nth triggering occurs. - The input event. - An event that triggers on pairs of consecutive values passed from the source event. - - - Runs the given function each time the given event is triggered. - The function to call when the event is triggered. - The input event. - - - Returns a new event consisting of the results of applying the given accumulating function - to successive values triggered on the input event. An item of internal state - records the current value of the state parameter. The internal state is not locked during the - execution of the accumulation function, so care should be taken that the - input IEvent not triggered by multiple threads simultaneously. - The function to update the state with each event value. - The initial state. - The input event. - An event that fires on the updated state values. - - - Returns a new event which fires on a selection of messages from the original event. - The selection function takes an original message to an optional new message. - The function to select and transform event values to pass on. - The input event. - An event that fires only when the chooser returns Some. - - - Returns a new event that listens to the original event and triggers the - first resulting event if the application of the function to the event arguments - returned a Choice1Of2, and the second event if it returns a Choice2Of2. - The function to transform event values into one of two types. - The input event. - A tuple of events. The first fires whenever splitter evaluates to Choice1of1 and - the second fires whenever splitter evaluates to Choice2of2. - - - Returns a new event that listens to the original event and triggers the - first resulting event if the application of the predicate to the event arguments - returned true, and the second event if it returned false. - The function to determine which output event to trigger. - The input event. - A tuple of events. The first is triggered when the predicate evaluates to true - and the second when the predicate evaluates to false. - - - Returns a new event that listens to the original event and triggers the resulting - event only when the argument to the event passes the given function. - The function to determine which triggers from the event to propagate. - The input event. - An event that only passes values that pass the predicate. - - - Returns a new event that passes values transformed by the given function. - The function to transform event values. - The input event. - An event that passes the transformed values. - - - Fires the output event when either of the input events fire. - The first input event. - The second input event. - An event that fires when either of the input events fire. - - - Forces the execution of this value and return its result. Same as Value. Mutual exclusion is used to - prevent other threads also computing the value. - The value of the Lazy object. - - - Creates a lazy computation that evaluates to the given value when forced. - The input value. - The created Lazy object. - - - Creates a lazy computation that evaluates to the result of the given function when forced. - The function to provide the value when needed. - The created Lazy object. - - - Extensions related to Lazy values. - - - Returns a new observable that triggers on the second and subsequent triggerings of the input observable. - The Nth triggering of the input observable passes the arguments from the N-1th and Nth triggering as - a pair. The argument passed to the N-1th triggering is held in hidden internal state until the - Nth triggering occurs. - - For each observer, the registered intermediate observing object is not thread safe. - That is, observations arising from the source must not be triggered concurrently - on different threads. - The input Observable. - An Observable that triggers on successive pairs of observations from the input Observable. - - - Creates an observer which subscribes to the given observable and which calls - the given function for each observation. - The function to be called on each observation. - The input Observable. - An object that will remove the callback if disposed. - - - Creates an observer which permanently subscribes to the given observable and which calls - the given function for each observation. - The function to be called on each observation. - The input Observable. - - - Returns an observable which, for each observer, allocates an item of state - and applies the given accumulating function to successive values arising from - the input. The returned object will trigger observations for each computed - state value, excluding the initial value. The returned object propagates - all errors arising from the source and completes when the source completes. - - For each observer, the registered intermediate observing object is not thread safe. - That is, observations arising from the source must not be triggered concurrently - on different threads. - The function to update the state with each observation. - The initial state. - The input Observable. - An Observable that triggers on the updated state values. - - - Returns an observable which chooses a projection of observations from the source - using the given function. The returned object will trigger observations x - for which the splitter returns Some x. The returned object also propagates - all errors arising from the source and completes when the source completes. - The function that returns Some for observations to be propagated - and None for observations to ignore. - The input Observable. - An Observable that only propagates some of the observations from the source. - - - Returns two observables which split the observations of the source by the - given function. The first will trigger observations x for which the - splitter returns Choice1Of2 x. The second will trigger observations - y for which the splitter returns Choice2Of2 y The splitter is - executed once for each subscribed observer. Both also propagate error - observations arising from the source and each completes when the source - completes. - The function that takes an observation an transforms - it into one of the two output Choice types. - The input Observable. - A tuple of Observables. The first triggers when splitter returns Choice1of2 - and the second triggers when splitter returns Choice2of2. - - - Returns two observables which partition the observations of the source by - the given function. The first will trigger observations for those values - for which the predicate returns true. The second will trigger observations - for those values where the predicate returns false. The predicate is - executed once for each subscribed observer. Both also propagate all error - observations arising from the source and each completes when the source - completes. - The function to determine which output Observable will trigger - a particular observation. - The input Observable. - A tuple of Observables. The first triggers when the predicate returns true, and - the second triggers when the predicate returns false. - - - Returns an observable which filters the observations of the source - by the given function. The observable will see only those observations - for which the predicate returns true. The predicate is executed once for - each subscribed observer. The returned object also propagates error - observations arising from the source and completes when the source completes. - The function to apply to observations to determine if it should - be kept. - The input Observable. - An Observable that filters observations based on filter. - - - Returns an observable which transforms the observations of the source by the - given function. The transformation function is executed once for each - subscribed observer. The returned object also propagates error observations - arising from the source and completes when the source completes. - The function applied to observations from the source. - The input Observable. - An Observable of the type specified by mapping. - - - Returns an observable for the merged observations from the sources. - The returned object propagates success and error values arising - from either source and completes when both the sources have completed. - - For each observer, the registered intermediate observing object is not - thread safe. That is, observations arising from the sources must not - be triggered concurrently on different threads. - The first Observable. - The second Observable. - An Observable that propagates information from both sources. - - - Basic operations on first class event and other observable objects. - - - Returns an asynchronous computation that, when run, will wait for a response to the given WebRequest. - An asynchronous computation that waits for response to the WebRequest. - - - A module of extension members providing asynchronous operations for some basic Web operations. - - - Creates an instance of the attribute - AbstractClassAttribute - - - Adding this attribute to class definition makes it abstract, which means it need not - implement all its methods. Instances of abstract classes may not be constructed directly. - - - The value of the attribute, indicating whether the type allows the null literal or not - - - Creates an instance of the attribute with the specified value - AllowNullLiteralAttribute - - - Creates an instance of the attribute - AllowNullLiteralAttribute - - - Adding this attribute to a type lets the 'null' literal be used for the type - within F# code. This attribute may only be added to F#-defined class or - interface types. - - - Indicates the namespace or module to be automatically opened when an assembly is referenced - or an enclosing module opened. - - - Creates an attribute used to mark a namespace or module path to be 'automatically opened' when an assembly is referenced - The namespace or module to be automatically opened when an assembly is referenced - or an enclosing module opened. - AutoOpenAttribute - - - Creates an attribute used to mark a module as 'automatically opened' when the enclosing namespace is opened - AutoOpenAttribute - - - This attribute is used for two purposes. When applied to an assembly, it must be given a string - argument, and this argument must indicate a valid module or namespace in that assembly. Source - code files compiled with a reference to this assembly are processed in an environment - where the given path is automatically opened. - - When applied to a module within an assembly, then the attribute must not be given any arguments. - When the enclosing namespace is opened in user source code, the module is also implicitly opened. - - - The value of the attribute, indicating whether the type is automatically marked serializable or not - - - Creates an instance of the attribute - Indicates whether the type should be serializable by default. - AutoSerializableAttribute - - - Adding this attribute to a type with value 'false' disables the behaviour where F# makes the - type Serializable by default. - - - Creates an instance of the attribute - CLIEventAttribute - - - Adding this attribute to a property with event type causes it to be compiled with as a CLI - metadata event, through a syntactic translation to a pair of 'add_EventName' and - 'remove_EventName' methods. - - - Creates an instance of the attribute - CLIMutableAttribute - - - Adding this attribute to a record type causes it to be compiled to a CLI representation - with a default constructor with property getters and setters. - - - Choice 2 of 2 choices - - - Choice 1 of 2 choices - - - Helper types for active patterns with 2 choices. - - - Choice 3 of 3 choices - - - Choice 2 of 3 choices - - - Choice 1 of 3 choices - - - Helper types for active patterns with 3 choices. - - - Choice 4 of 4 choices - - - Choice 3 of 4 choices - - - Choice 2 of 4 choices - - - Choice 1 of 4 choices - - - Helper types for active patterns with 4 choices. - - - Choice 5 of 5 choices - - - Choice 4 of 5 choices - - - Choice 3 of 5 choices - - - Choice 2 of 5 choices - - - Choice 1 of 5 choices - - - Helper types for active patterns with 5 choices. - - - Choice 6 of 6 choices - - - Choice 5 of 6 choices - - - Choice 4 of 6 choices - - - Choice 3 of 6 choices - - - Choice 2 of 6 choices - - - Choice 1 of 6 choices - - - Helper types for active patterns with 6 choices. - - - Choice 7 of 7 choices - - - Choice 6 of 7 choices - - - Choice 5 of 7 choices - - - Choice 4 of 7 choices - - - Choice 3 of 7 choices - - - Choice 2 of 7 choices - - - Choice 1 of 7 choices - - - Helper types for active patterns with 7 choices. - - - Creates an instance of the attribute - ClassAttribute - - - Adding this attribute to a type causes it to be represented using a CLI class. - - - Creates an instance of the attribute - ComparisonConditionalOnAttribute - - - This attribute is used to indicate a generic container type satisfies the F# 'comparison' - constraint only if a generic argument also satisfies this constraint. For example, adding - this attribute to parameter 'T on a type definition C<'T> means that a type C<X> only supports - comparison if the type X also supports comparison and all other conditions for C<X> to support - comparison are also met. The type C<'T> can still be used with other type arguments, but a type such - as C<(int -> int)> will not support comparison because the type (int -> int) is an F# function type - and does not support comparison. - - This attribute will be ignored if it is used on the generic parameters of functions or methods. - - - Indicates the number of arguments in each argument group - - - Creates an instance of the attribute - Indicates the number of arguments in each argument group. - CompilationArgumentCountsAttribute - - - This attribute is generated automatically by the F# compiler to tag functions and members - that accept a partial application of some of their arguments and return a residual function - - - Indicates the variant number of the entity, if any, in a linear sequence of elements with F# source code - - - Indicates the type definitions needed to resolve the source construct - - - Indicates the relationship between the compiled entity and F# source code - - - Indicates the sequence number of the entity, if any, in a linear sequence of elements with F# source code - - - Indicates the resource the source construct relates to - - - Creates an instance of the attribute - Indicates the type definitions needed to resolve the source construct. - CompilationMappingAttribute - - - Creates an instance of the attribute - Indicates the type of source construct. - CompilationMappingAttribute - - - Creates an instance of the attribute - Indicates the type of source construct. - CompilationMappingAttribute - - - Creates an instance of the attribute - Indicates the type of source construct. - CompilationMappingAttribute - - - This attribute is inserted automatically by the F# compiler to tag types - and methods in the generated CLI code with flags indicating the correspondence - with original source constructs. It is used by the functions in the - Microsoft.FSharp.Reflection namespace to reverse-map compiled constructs to - their original forms. It is not intended for use from user code. - - - Indicates one or more adjustments to the compiled representation of an F# type or member - - - Creates an instance of the attribute - Indicates adjustments to the compiled representation of the type or member. - CompilationRepresentationAttribute - - - This attribute is used to adjust the runtime representation for a type. - For example, it may be used to note that the null representation - may be used for a type. This affects how some constructs are compiled. - - - Compile a property as a CLI event. - - - Permit the use of null as a representation for nullary discriminators in a discriminated union. - - - append 'Module' to the end of a module whose name clashes with a type name in the same namespace. - - - Compile a member as 'instance' even if null is used as a representation for this type. - - - Compile an instance member as 'static' . - - - No special compilation representation. - - - Indicates one or more adjustments to the compiled representation of an F# type or member. - - - Indicates the name of the entity in F# source code - - - Creates an instance of the attribute - The name of the method in source. - CompilationSourceNameAttribute - - - This attribute is inserted automatically by the F# compiler to tag - methods which are given the 'CompiledName' attribute. It is not intended - for use from user code. - - - The name of the value as it appears in compiled code - - - Creates an instance of the attribute - The name to use in compiled code. - CompiledNameAttribute - - - Adding this attribute to a value or function definition in an F# module changes the name used - for the value in compiled CLI code. - - - Indicates if the construct should always be hidden in an editing environment. - - - Indicates if the message should indicate a compiler error. Error numbers less than - 10000 are considered reserved for use by the F# compiler and libraries. - - - Indicates the number associated with the message. - - - Indicates the warning message to be emitted when F# source code uses this construct - - - Indicates if the construct should always be hidden in an editing environment. - - - Indicates if the message should indicate a compiler error. Error numbers less than - 10000 are considered reserved for use by the F# compiler and libraries. - - - Creates an instance of the attribute. - - - Indicates that a message should be emitted when F# source code uses this construct. - - - Creates an instance of the attribute - CustomComparisonAttribute - - - Adding this attribute to a type indicates it is a type with a user-defined implementation of comparison. - - - Creates an instance of the attribute - CustomEqualityAttribute - - - Adding this attribute to a type indicates it is a type with a user-defined implementation of equality. - - - Indicates if the custom operation maintains the variable space of the query of computation expression through the use of a bind operation - - - Indicates if the custom operation maintains the variable space of the query of computation expression - - - Indicates the name used for the 'on' part of the custom query operator for join-like operators - - - Indicates if the custom operation is an operation similar to a zip in a sequence computation, supporting two inputs - - - Indicates if the custom operation is an operation similar to a join in a sequence computation, supporting two inputs and a correlation constraint - - - Indicates if the custom operation is an operation similar to a group join in a sequence computation, supporting two inputs and a correlation constraint, and generating a group - - - Indicates if the custom operation supports the use of 'into' immediately after the use of the operation in a query or other computation expression to consume the results of the operation - - - Get the name of the custom operation when used in a query or other computation expression - - - Indicates if the custom operation maintains the variable space of the query of computation expression through the use of a bind operation - - - Indicates if the custom operation maintains the variable space of the query of computation expression - - - Indicates the name used for the 'on' part of the custom query operator for join-like operators - - - Indicates if the custom operation is an operation similar to a zip in a sequence computation, supporting two inputs - - - Indicates if the custom operation is an operation similar to a join in a sequence computation, supporting two inputs and a correlation constraint - - - Indicates if the custom operation is an operation similar to a group join in a sequence computation, supporting two inputs and a correlation constraint, and generating a group - - - Indicates if the custom operation supports the use of 'into' immediately after the use of the operation in a query or other computation expression to consume the results of the operation - - - Creates an instance of the attribute - CustomOperationAttribute - - - - Indicates that a member on a computation builder type is a custom query operator, - and indicates the name of that operator. - - - - The value of the attribute, indicating whether the type has a default augmentation or not - - - Creates an instance of the attribute - Indicates whether to generate helper members on the CLI class representing a discriminated - union. - DefaultAugmentationAttribute - - - Adding this attribute to a discriminated union with value false - turns off the generation of standard helper member tester, constructor - and accessor members for the generated CLI class for that type. - - - Indicates if a constraint is asserted that the field type supports 'null' - - - Creates an instance of the attribute - Indicates whether to assert that the field type supports null. - DefaultValueAttribute - - - Creates an instance of the attribute - DefaultValueAttribute - - - Adding this attribute to a field declaration means that the field is - not initialized. During type checking a constraint is asserted that the field type supports 'null'. - If the 'check' value is false then the constraint is not asserted. - - - Creates an instance of the attribute - EntryPointAttribute - - - Adding this attribute to a function indicates it is the entrypoint for an application. - If this attribute is not specified for an EXE then the initialization implicit in the - module bindings in the last file in the compilation sequence are used as the entrypoint. - - - Creates an instance of the attribute - EqualityConditionalOnAttribute - - - This attribute is used to indicate a generic container type satisfies the F# 'equality' - constraint only if a generic argument also satisfies this constraint. For example, adding - this attribute to parameter 'T on a type definition C<'T> means that a type C<X> only supports - equality if the type X also supports equality and all other conditions for C<X> to support - equality are also met. The type C<'T> can still be used with other type arguments, but a type such - as C<(int -> int)> will not support equality because the type (int -> int) is an F# function type - and does not support equality. - - This attribute will be ignored if it is used on the generic parameters of functions or methods. - - - Indicates the warning message to be emitted when F# source code uses this construct - - - Creates an instance of the attribute - The warning message to be emitted when code uses this construct. - ExperimentalAttribute - - - This attribute is used to tag values that are part of an experimental library - feature. - - - Invoke an F# first class function value with two curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The function result. - - - Invoke an F# first class function value with three curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The third arg. - The function result. - - - Invoke an F# first class function value with four curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The third arg. - The fourth arg. - The function result. - - - Invoke an F# first class function value with five curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The third arg. - The fourth arg. - The fifth arg. - The function result. - - - Invoke an F# first class function value with one argument - - 'U - - - Construct an instance of an F# first class function value - The created F# function. - - - The CLI type used to represent F# function values. This type is not - typically used directly, though may be used from other CLI languages. - - - The release number of the F# version associated with the attribute - - - The minor version number of the F# version associated with the attribute - - - The major version number of the F# version associated with the attribute - - - Creates an instance of the attribute - The major version number. - The minor version number. - The release number. - FSharpInterfaceDataVersionAttribute - - - This attribute is added to generated assemblies to indicate the - version of the data schema used to encode additional F# - specific information in the resource attached to compiled F# libraries. - - - Specialize the type function at a given type - The specialized type. - - - Construct an instance of an F# first class type function value - FSharpTypeFunc - - - The CLI type used to represent F# first-class type function values. This type is for use - by compiled F# code. - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - Tuple of values generated by scan or match. - - - Convert the given Action delegate object to an F# function value - The input action. - The F# function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - Helper functions for converting F# first class function values to and from CLI representaions - of functions using delegates. - - - Creates an instance of the attribute - GeneralizableValueAttribute - - - Adding this attribute to a non-function value with generic parameters indicates that - uses of the construct can give rise to generic code through type inference. - - - Creates an instance of the attribute - InterfaceAttribute - - - Adding this attribute to a type causes it to be represented using a CLI interface. - - - Creates an instance of the attribute - LiteralAttribute - - - Adding this attribute to a value causes it to be compiled as a CLI constant literal. - - - Creates an instance of the attribute - MeasureAnnotatedAbbreviationAttribute - - - Adding this attribute to a type causes it to be interpreted as a refined type, currently limited to measure-parameterized types. - This may only be used under very limited conditions. - - - Creates an instance of the attribute - MeasureAttribute - - - Adding this attribute to a type causes it to be interpreted as a unit of measure. - This may only be used under very limited conditions. - - - Creates an instance of the attribute - NoComparisonAttribute - - - Adding this attribute to a type indicates it is a type where comparison is an abnormal operation. - This means that the type does not satisfy the F# 'comparison' constraint. Within the bounds of the - F# type system, this helps ensure that the F# generic comparison function is not instantiated directly - at this type. The attribute and checking does not constrain the use of comparison with base or child - types of this type. - - - Creates an instance of the attribute - NoDynamicInvocationAttribute - - - This attribute is used to tag values that may not be dynamically invoked at runtime. This is - typically added to inlined functions whose implementations include unverifiable code. It - causes the method body emitted for the inlined function to raise an exception if - dynamically invoked, rather than including the unverifiable code in the generated - assembly. - - - Creates an instance of the attribute - NoEqualityAttribute - - - Adding this attribute to a type indicates it is a type where equality is an abnormal operation. - This means that the type does not satisfy the F# 'equality' constraint. Within the bounds of the - F# type system, this helps ensure that the F# generic equality function is not instantiated directly - at this type. The attribute and checking does not constrain the use of comparison with base or child - types of this type. - - - The representation of "Value of type 'T" - The input value. - An option representing the value. - - - The representation of "No value" - - - Get the value of a 'Some' option. A NullReferenceException is raised if the option is 'None'. - - - Create an option value that is a 'None' value. - - - Return 'true' if the option is a 'Some' value. - - - Return 'true' if the option is a 'None' value. - - - Create an option value that is a 'Some' value. - The input value - An option representing the value. - - - The type of optional values. When used from other CLI languages the - empty option is the null value. - - Use the constructors Some and None to create values of this type. - Use the values in the Option module to manipulate values of this type, - or pattern match against the values directly. - - None values will appear as the value null to other CLI languages. - Instance methods on this type will appear as static methods to other CLI languages - due to the use of null as a value representation. - - - Creates an instance of the attribute - OptionalArgumentAttribute - - - This attribute is added automatically for all optional arguments. - - - The raw text of the format string. - - - Construct a format string - The input string. - The PrintfFormat containing the formatted result. - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - - - Construct a format string - The input string. - The created format string. - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - Tuple of values generated by scan or match. - - - Creates an instance of the attribute - ProjectionParameterAttribute - - - Indicates that, when a custom operator is used in a computation expression, - a parameter is automatically parameterized by the variable space of the computation expression - - - - The current value of the reference cell - - - - The current value of the reference cell - - - The current value of the reference cell - - - The type of mutable references. Use the functions [:=] and [!] to get and - set values of this type. - - - Creates an instance of the attribute - ReferenceEqualityAttribute - - - Adding this attribute to a record or union type disables the automatic generation - of overrides for 'System.Object.Equals(obj)', 'System.Object.GetHashCode()' - and 'System.IComparable' for the type. The type will by default use reference equality. - - - The value of the attribute, indicating whether to include the evaluated value of the definition as the outer node of the quotation - - - Creates an instance of the attribute - Indicates whether to include the evaluated value of the definition as the outer node of the quotation - ReflectedDefinitionAttribute - - - Creates an instance of the attribute - ReflectedDefinitionAttribute - - - Adding this attribute to the let-binding for the definition of a top-level - value makes the quotation expression that implements the value available - for use at runtime. - - - Creates an instance of the attribute - RequireQualifiedAccessAttribute - - - This attribute is used to indicate that references to the elements of a module, record or union - type require explicit qualified access. - - - Creates an instance of the attribute - RequiresExplicitTypeArgumentsAttribute - - - Adding this attribute to a type, value or member requires that - uses of the construct must explicitly instantiate any generic type parameters. - - - The value of the attribute, indicating whether the type is sealed or not. - - - Creates an instance of the attribute - Indicates whether the class is sealed. - SealedAttribute - - - Creates an instance of the attribute. - The created attribute. - - - Adding this attribute to class definition makes it sealed, which means it may not - be extended or implemented. - - - Indicates that the compiled entity had private or internal representation in F# source code. - - - The mask of values related to the kind of the compiled entity. - - - Indicates that the compiled entity is part of the representation of an F# value declaration. - - - Indicates that the compiled entity is part of the representation of an F# union case declaration. - - - Indicates that the compiled entity is part of the representation of an F# module declaration. - - - Indicates that the compiled entity is part of the representation of an F# closure. - - - Indicates that the compiled entity is part of the representation of an F# exception declaration. - - - Indicates that the compiled entity is part of the representation of an F# record or union case field declaration. - - - Indicates that the compiled entity is part of the representation of an F# class or other object type declaration. - - - Indicates that the compiled entity is part of the representation of an F# record type declaration. - - - Indicates that the compiled entity is part of the representation of an F# union type declaration. - - - Indicates that the compiled entity has no relationship to an element in F# source code. - - - Indicates the relationship between a compiled entity in a CLI binary and an element in F# source code. - - - Creates an instance of the attribute - StructAttribute - - - Adding this attribute to a type causes it to be represented using a CLI struct. - - - Creates an instance of the attribute - StructuralComparisonAttribute - - - Adding this attribute to a record, union, exception, or struct type confirms the - automatic generation of implementations for 'System.IComparable' for the type. - - - Creates an instance of the attribute - StructuralEqualityAttribute - - - Adding this attribute to a record, union or struct type confirms the automatic - generation of overrides for 'System.Object.Equals(obj)' and - 'System.Object.GetHashCode()' for the type. - - - Indicates the text to display by default when objects of this type are displayed - using '%A' printf formatting patterns and other two-dimensional text-based display - layouts. - - - Creates an instance of the attribute - Indicates the text to display when using the '%A' printf formatting. - StructuredFormatDisplayAttribute - - - This attribute is used to mark how a type is displayed by default when using - '%A' printf formatting patterns and other two-dimensional text-based display layouts. - In this version of F# valid values are of the form PreText {PropertyName1} PostText {PropertyName2} ... {PropertyNameX} PostText. - The property names indicate properties to evaluate and to display instead of the object itself. - - - The type 'unit', which has only one value "()". This value is special and - always uses the representation 'null'. - - - Creates an instance of the attribute - UnverifiableAttribute - - - This attribute is used to tag values whose use will result in the generation - of unverifiable code. These values are inevitably marked 'inline' to ensure that - the unverifiable constructs are not present in the actual code for the F# library, - but are rather copied to the source code of the caller. - - - Creates an instance of the attribute - VolatileFieldAttribute - - - Adding this attribute to an F# mutable binding causes the "volatile" - prefix to be used for all accesses to the field. - - - Thirty-two dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Thirty-one dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Thirty dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-nine dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-eight dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-seven dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-six dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-five dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-four dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-three dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-two dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-one dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Nineteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Eighteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Seventeen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Sixteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Fifteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Fourteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Thirteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twelve dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Eleven dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Ten dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Nine dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Eight dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Seven dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Six dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Five dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Four dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - Use the values in the Array4D module - to manipulate values of this type, or the notation arr.[x1,x2,x3,x4] to get and set array - values. - - - Three dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - Use the values in the Array3D module - to manipulate values of this type, or the notation arr.[x1,x2,x3] to get and set array - values. - - - Two dimensional arrays, typically zero-based. - - Use the values in the Array2D module - to manipulate values of this type, or the notation arr.[x,y] to get/set array - values. - - Non-zero-based arrays can also be created using methods on the System.Array type. - - - Single dimensional, zero-based arrays, written int[], string[] etc. - Use the values in the Array module to manipulate values - of this type, or the notation arr.[x] to get/set array - values. - - - Single dimensional, zero-based arrays, written int[], string[] etc. - - Use the values in the Array module to manipulate values - of this type, or the notation arr.[x] to get/set array - values. - - - An abbreviation for the CLI type System.Boolean. - - - Represents a managed pointer in F# code. - - - An abbreviation for the CLI type System.Byte. - - - An abbreviation for the CLI type System.Char. - - - An abbreviation for the CLI type System.Decimal. - - - The type of decimal numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Decimal. - - - An abbreviation for the CLI type System.Double. - - - An abbreviation for the CLI type System.Exception. - - - An abbreviation for the CLI type System.Double. - - - An abbreviation for the CLI type System.Single. - - - The type of floating point numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Single. - - - The type of floating point numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Double. - - - This type is for internal use by the F# code generator. - - - An abbreviation for the CLI type System.Int32. - - - An abbreviation for the CLI type System.Int16. - - - The type of 16-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Int16. - - - An abbreviation for the CLI type System.Int32. - - - An abbreviation for the CLI type System.Int64. - - - The type of 64-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Int64. - - - An abbreviation for the CLI type System.SByte. - - - The type of 32-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Int32. - - - An abbreviation for the CLI type System.IntPtr. - - - Represents an unmanaged pointer in F# code. - - This type should only be used when writing F# code that interoperates - with native code. Use of this type in F# code may result in - unverifiable code being generated. Conversions to and from the - nativeint type may be required. Values of this type can be generated - by the functions in the NativeInterop.NativePtr module. - - - An abbreviation for the CLI type System.Object. - - - The type of optional values. When used from other CLI languages the - empty option is the null value. - - Use the constructors Some and None to create values of this type. - Use the values in the Option module to manipulate values of this type, - or pattern match against the values directly. - - 'None' values will appear as the value null to other CLI languages. - Instance methods on this type will appear as static methods to other CLI languages - due to the use of null as a value representation. - - - The type of mutable references. Use the functions [:=] and [!] to get and - set values of this type. - - - An abbreviation for the CLI type System.SByte. - - - The type of 8-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.SByte. - - - An abbreviation for the CLI type System.Single. - - - An abbreviation for the CLI type System.String. - - - An abbreviation for the CLI type System.UInt16. - - - An abbreviation for the CLI type System.UInt32. - - - An abbreviation for the CLI type System.UInt64. - - - An abbreviation for the CLI type System.Byte. - - - An abbreviation for the CLI type System.UIntPtr. - - - The type 'unit', which has only one value "()". This value is special and - always uses the representation 'null'. - - - Non-exhaustive match failures will raise the MatchFailureException exception - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - A new enumerator for the sequence. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - A reference to the sequence. - - A 0, 1, and 2 respectively indicate Stop, Yield, and Goto conditions for the sequence generator. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - A new sequence generator for the expression. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - - Namespace name the provider injects types into. - - - - - Compilers call this method to query a type provider for a type name. - - Resolver should return a type called name in namespace NamespaceName or null if the type is unknown. - - - - - - The top-level types - - - - - - The sub-namespaces in this namespace. An optional member to prevent generation of namespaces until an outer namespace is explored. - - - - - Represents a namespace provided by a type provider component. - - - - - Triggered when an assumption changes that invalidates the resolutions so far reported by the provider - - - - - Triggered when an assumption changes that invalidates the resolutions so far reported by the provider - - - - - Triggered when an assumption changes that invalidates the resolutions so far reported by the provider - - - - - Get the static parameters for a provided type. - - A type returned by GetTypes or ResolveTypeName - - - - - Namespace name the this TypeProvider injects types into. - - - - - Called by the compiler to ask for an Expression tree to replace the given MethodBase with. - - MethodBase that was given to the compiler by a type returned by a GetType(s) call. - Expressions that represent the parameters to this call. - An expression that the compiler will use in place of the given method base. - - - - Get the physical contents of the given logical provided assembly. - - - - - Apply static arguments to a provided type that accepts static arguments. - - The provider must return a type with the given mangled name. - the provided type definition which has static parameters - the full path of the type, including encoded representations of static parameters - the static parameters, indexed by name - - - - - Represents an instantiation of a type provider component. - - - - - Get the static parameters for a provided method. - - A method returned by GetMethod on a provided type - The static parameters of the provided method, if any - - - - Apply static arguments to a provided method that accepts static arguments. - - The provider must return a provided method with the given mangled name. - the provided method definition which has static parameters - the full name of the method that must be returned, including encoded representations of static parameters - the values of the static parameters, indexed by name - The provided method definition corresponding to the given static parameter values - - - - Represents additional, optional information for a type provider component - - - - Represents the inverse of a measure expressions when returned as a generic argument of a provided type. - - - Represents the '1' measure expression when returned as a generic argument of a provided type. - - - Represents the product of two measure expressions when returned as a generic argument of a provided type. - - - Creates an instance of the attribute - TypeProviderAssemblyAttribute - The name of the design-time assembly for this type provider. - - - Creates an instance of the attribute - TypeProviderAssemblyAttribute - - - Place attribute on runtime assembly to indicate that there is a corresponding design-time - assembly that contains a type provider. Runtime and designer assembly may be the same. - - - Creates an instance of the attribute - TypeProviderAttribute - - - Place on a class that implements ITypeProvider to extend the compiler - - - - Get the full path to use for temporary files for the type provider instance. - - - - - version of referenced system runtime assembly - - - - - Get the full path to referenced assembly that caused this type provider instance to be created. - - - - - Get the full path to use to resolve relative paths in any file name arguments given to the type provider instance. - - - - - Get the referenced assemblies for the type provider instance. - - - - - Indicates if the type provider host responds to invalidation events for type provider instances. - - - - - Indicates if the type provider instance is used in an environment which executes provided code such as F# Interactive. - - - - - Get the full path to use for temporary files for the type provider instance. - - - - - version of referenced system runtime assembly - - - - - Get the full path to referenced assembly that caused this type provider instance to be created. - - - - - Get the full path to use to resolve relative paths in any file name arguments given to the type provider instance. - - - - - Get the referenced assemblies for the type provider instance. - - - - - Indicates if the type provider host responds to invalidation events for type provider instances. - - - - - Indicates if the type provider instance is used in an environment which executes provided code such as F# Interactive. - - - - - Checks if given type exists in target system runtime library - - - - - If the class that implements ITypeProvider has a constructor that accepts TypeProviderConfig - then it will be constructed with an instance of TypeProviderConfig. - - - - Creates an instance of the attribute - TypeProviderEditorHideMethodsAttribute - - - Indicates that a code editor should hide all System.Object methods from the intellisense menus for instances of a provided type - - - Additional type attribute flags related to provided types - - - Creates an instance of the attribute - TypeProviderXmlDocAttribute - - - - The TypeProviderXmlDocAttribute attribute can be added to types and members. - The language service will display the CommentText property from the attribute - in the appropriate place when the user hovers over a type or member. - - - - Creates an anonymous event with the given handlers. - - A function to handle adding a delegate for the event to trigger. - A function to handle removing a delegate that the event triggers. - A function to produce the delegate type the event can trigger. - - The initialized event. - - - The F# compiler emits calls to this function to implement the use operator for F# sequence - expressions. - - The resource to be used and disposed. - The input sequence. - - The result sequence. - - - The F# compiler emits calls to this function to implement the compiler-intrinsic - conversions from untyped System.Collections.IEnumerable sequences to typed sequences. - - An initializer function. - A function to iterate and test if end of sequence is reached. - A function to retrieve the current element. - - The resulting typed sequence. - - - The F# compiler emits calls to this function to - implement the try/finally operator for F# sequence expressions. - - The input sequence. - A computation to be included in an enumerator's Dispose method. - - The result sequence. - - - The F# compiler emits calls to this function to - implement the while operator for F# sequence expressions. - - A function that indicates whether iteration should continue. - The input sequence. - - The result sequence. - - - A group of functions used as part of the compiled representation of F# sequence expressions. - - - Builds a query using query syntax and operators. - - - An active pattern to force the execution of values of type Lazy<_>. - - - Special prefix operator for splicing untyped expressions into quotation holes. - - - Special prefix operator for splicing typed expressions into quotation holes. - - - Builds a 2D array from a sequence of sequences of elements. - - - Builds a read-only lookup table from a sequence of key/value pairs. The key objects are indexed using generic hashing and equality. - - - Converts the argument to signed byte. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using SByte.Parse() with InvariantCulture settings. - Otherwise the operation requires and invokes a ToSByte method on the input type. - - - Converts the argument to byte. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Byte.Parse() on strings and otherwise requires a ToByte method on the input type. - - - Converts the argument to 64-bit float. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Double.Parse() with InvariantCulture settings. Otherwise the operation requires and invokes a ToDouble method on the input type. - - - Converts the argument to 32-bit float. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Single.Parse() with InvariantCulture settings. Otherwise the operation requires and invokes a ToSingle method on the input type. - - - Builds an aysnchronous workflow using computation expression syntax. - - - Builds a set from a sequence of objects. The objects are indexed using generic comparison. - The input sequence of elements. - The created set. - - - Print to a file using the given format, and add a newline. - The file TextWriter. - The formatter. - The formatted result. - - - Print to a file using the given format. - The file TextWriter. - The formatter. - The formatted result. - - - Print to a string buffer and raise an exception with the given - result. Helper printers must return strings. - The formatter. - The formatted result. - - - Print to a string using the given format. - The formatter. - The formatted result. - - - Converts the argument to signed byte. - This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using SByte.Parse() with InvariantCulture settings. - Otherwise the operation requires and invokes a ToSByte method on the input type. - - - Converts the argument to byte. - This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using Byte.Parse() on strings and otherwise requires a ToByte method on the input type. - - - Divides a value by an integer. - The input value. - The input int. - The division result. - - - Resolves to the value 'one' for any primitive numeric type or any type with a static member called 'One' - - - Resolves to the zero value for any primitive numeric type or any type with a static member called 'Zero' - - - A compiler intrinsic that implements dynamic invocations for the DivideByInt primitive. - - - A compiler intrinsic that implements dynamic invocations to the checked '*' operator. - - - A compiler intrinsic that implements dynamic invocations to the '*' operator. - - - A compiler intrinsic that implements dynamic invocations to the checked '+' operator. - - - A compiler intrinsic that implements dynamic invocations to the '+' operator. - - - Resolves to the value 'one' for any primitive numeric type or any type with a static member called 'One'. - - - Resolves to the zero value for any primitive numeric type or any type with a static member called 'Zero'. - - - Parse an uint64 according to the rules used by the overloaded 'uint64' conversion operator when applied to strings - The input string. - The parsed value. - - - Parse an int64 according to the rules used by the overloaded 'int64' conversion operator when applied to strings - The input string. - The parsed value. - - - Parse an uint32 according to the rules used by the overloaded 'uint32' conversion operator when applied to strings - The input string. - The parsed value. - - - Parse an int32 according to the rules used by the overloaded 'int32' conversion operator when applied to strings - The input string. - The parsed value. - - - Creates an sbyte value with units-of-measure - The input sbyte. - The sbyte with units-of-measure. - - - Creates an int16 value with units-of-measure - The input int16. - The int16 with units-of-measure. - - - Creates an int64 value with units-of-measure - The input int64. - The int64 with units of measure. - - - Creates an int32 value with units-of-measure - The input int. - The int with units of measure. - - - Creates a decimal value with units-of-measure - The input decimal. - The decimal with units of measure. - - - Creates a float32 value with units-of-measure - The input float. - The float with units-of-measure. - - - Creates a float value with units-of-measure - The input float. - The float with units-of-measure. - - - Get the underlying value for an enum value - The input enum. - The enumeration as a value. - - - Build an enum value from an underlying value - The input value. - The value as an enumeration. - - - Recursively hash a part of a value according to its structure. - The comparison function. - The input object. - The hashed value. - - - Hash a value according to its structure. Use the given limit to restrict the hash when hashing F# - records, lists and union types. - The limit on the number of nodes. - The input object. - The hashed value. - - - Hash a value according to its structure. This hash is not limited by an overall node count when hashing F# - records, lists and union types. - The input object. - The hashed value. - - - Make an F# comparer object for the given type - - - Make an F# hash/equality object for the given type - - - Make an F# hash/equality object for the given type using node-limited hashing when hashing F# - records, lists and union types. - The input limit on the number of nodes. - System.Collections.Generic.IEqualityComparer<'T> - - - Make an F# hash/equality object for the given type - - - Make an F# comparer object for the given type, where it can be null if System.Collections.Generic.Comparer<'T>.Default - - - Make an F# comparer object for the given type - - - A static F# comparer object - - - Return an F# comparer object suitable for hashing and equality. This hashing behaviour - of the returned comparer is not limited by an overall node count when hashing F# - records, lists and union types. This equality comparer has equivalence - relation semantics ([nan] = [nan]). - - - Return an F# comparer object suitable for hashing and equality. This hashing behaviour - of the returned comparer is not limited by an overall node count when hashing F# - records, lists and union types. - - - The physical hash. Hashes on the object identity, except for value types, - where we hash on the contents. - The input object. - The hashed value. - - - Reference/physical equality. - True if the inputs are reference-equal, false otherwise. - The first value. - The second value. - The result of the comparison. - - - Take the maximum of two values structurally according to the order given by GenericComparison - The first value. - The second value. - The maximum value. - - - Take the minimum of two values structurally according to the order given by GenericComparison - The first value. - The second value. - The minimum value. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values. May be called as a recursive case from an implementation of System.IComparable to - ensure consistent NaN comparison semantics. - The function to compare the values. - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values for equality - - The first value. - The second value. - The result of the comparison. - - - Compare two values for equality using equivalence relation semantics ([nan] = [nan]) - The first value. - The second value. - The result of the comparison. - - - Compare two values for equality using partial equivalence relation semantics ([nan] <> [nan]) - The first value. - The second value. - The result of the comparison. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs - - - - The standard overloaded associative (4-indexed) mutation operator - - - - The standard overloaded associative (3-indexed) mutation operator - - - The standard overloaded associative (2-indexed) mutation operator - - - The standard overloaded associative (indexed) mutation operator - - - The standard overloaded associative (4-indexed) lookup operator - - - The standard overloaded associative (3-indexed) lookup operator - - - The standard overloaded associative (2-indexed) lookup operator - - - The standard overloaded associative (indexed) lookup operator - - - A compiler intrinsic for checking initialization soundness of recursive bindings - - - A compiler intrinsic for checking initialization soundness of recursive static bindings - - - A compiler intrinsic for checking initialization soundness of recursive bindings - - - A compiler intrinsic for the efficient compilation of sequence expressions - - - This function implements parsing of decimal constants - - - This function implements calls to default constructors - acccessed by 'new' constraints. - - - Primitive used by pattern match compilation - - - A compiler intrinsic that implements the ':?' operator - - - A compiler intrinsic that implements the ':?' operator - - - A compiler intrinsic that implements the ':?>' operator - - - A compiler intrinsic that implements the ':?>' operator - - - The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs - - - Address-of. Uses of this value may result in the generation of unverifiable code. - The input object. - The unmanaged pointer. - - - Address-of. Uses of this value may result in the generation of unverifiable code. - The input object. - The managed pointer. - - - Binary 'or'. When used as a binary operator the right hand value is evaluated only on demand - The first value. - The second value. - The result of the operation. - - - Binary 'or'. When used as a binary operator the right hand value is evaluated only on demand. - - - Binary 'and'. When used as a binary operator the right hand value is evaluated only on demand - The first value. - The second value. - The result of the operation. - - - Binary 'and'. When used as a binary operator the right hand value is evaluated only on demand. - - - The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs - - - For compiler use only - - - Language primitives associated with the F# language - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - An active pattern to match values of type System.Collections.Generic.KeyValuePair - The input key/value pair. - A tuple containing the key and value. - - - Converts the argument to character. Numeric inputs are converted according to the UTF-16 - encoding for characters. String inputs must be exactly one character long. For other - input types the operation requires an appropriate static conversion method on the input type. - The input value. - The converted char. - - - Converts the argument to System.Decimal using a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted decimal. - - - Converts the argument to a string using ToString. - - For standard integer and floating point values the ToString conversion - uses CultureInfo.InvariantCulture. - The input value. - The converted string. - - - Converts the argument to unsigned native integer using a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted unativeint - - - Converts the argument to signed native integer. This is a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted nativeint - - - Converts the argument to 64-bit float. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Double.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float - - - Converts the argument to 32-bit float. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Single.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float32 - - - Converts the argument to unsigned 64-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint64 - - - Converts the argument to signed 64-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int64 - - - Converts the argument to unsigned 32-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint32 - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int32 - - - Converts the argument to a particular enum type. - The input value. - The converted enum type. - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int - - - Converts the argument to unsigned 16-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint16 - - - Converts the argument to signed 16-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int16 - - - Converts the argument to signed byte. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using SByte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to byte. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Byte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - Overloaded power operator. If n > 0 then equivalent to x*...*x for n occurrences of x. - The input base. - The input exponent. - The base raised to the exponent. - - - Overloaded power operator. - The input base. - The input exponent. - The base raised to the exponent. - - - Overloaded truncate operator. - The input value. - The truncated value. - - - Hyperbolic tangent of the given number - The input value. - The hyperbolic tangent of the input. - - - Tangent of the given number - The input value. - The tangent of the input. - - - Hyperbolic sine of the given number - The input value. - The hyperbolic sine of the input. - - - Sine of the given number - The input value. - The sine of the input. - - - Hyperbolic cosine of the given number - The input value. - The hyperbolic cosine of the input. - - - Cosine of the given number - The input value. - The cosine of the input. - - - Square root of the given number - The input value. - The square root of the input. - - - Logarithm to base 10 of the given number - The input value. - The logarithm to base 10 of the input. - - - Natural logarithm of the given number - The input value. - The natural logarithm of the input. - - - Round the given number - The input value. - The nearest integer to the input value. - - - Sign of the given number - The input value. - -1, 0, or 1 depending on the sign of the input. - - - Floor of the given number - The input value. - The floor of the input. - - - Exponential of the given number - The input value. - The exponential of the input. - - - Ceiling of the given number - The input value. - The ceiling of the input. - - - Inverse tangent of x/y where x and y are specified separately - The y input value. - The x input value. - The inverse tangent of the input ratio. - - - Inverse tangent of the given number - The input value. - The inverse tangent of the input. - - - Inverse sine of the given number - The input value. - The inverse sine of the input. - - - Inverse cosine of the given number - The input value. - The inverse cosine of the input. - - - Absolute value of the given number. - The input value. - The absolute value of the input. - - - A generic hash function. This function has the same behaviour as 'hash', - however the default structural hashing for F# union, record and tuple - types stops when the given limit of nodes is reached. The exact behaviour of - the function can be adjusted on a type-by-type basis by implementing - GetHashCode for each type. - The limit of nodes. - The input object. - The computed hash. - - - A generic hash function, designed to return equal hash values for items that are - equal according to the "=" operator. By default it will use structural hashing - for F# union, record and tuple types, hashing the complete contents of the - type. The exact behaviour of the function can be adjusted on a - type-by-type basis by implementing GetHashCode for each type. - The input object. - The computed hash. - - - Returns the internal size of a type in bytes. For example, sizeof<int> returns 4. - - - Generate a System.Type representation for a type definition. If the - input type is a generic type instantiation then return the - generic type definition associated with all such instantiations. - - - An internal, library-only compiler intrinsic for compile-time - generation of a RuntimeMethodHandle. - - - Generate a System.Type runtime representation of a static type. - - - Clean up resources associated with the input object after the completion of the given function. - Cleanup occurs even when an exception is raised by the protected - code. - The resource to be disposed after action is called. - The action that accepts the resource. - The resulting value. - - - Execute the function as a mutual-exclusion region using the input value as a lock. - The object to be locked. - The action to perform during the lock. - The resulting value. - - - The standard overloaded skip range operator, e.g. [n..skip..m] for lists, seq {n..skip..m} for sequences - The start value of the range. - The step value of the range. - The end value of the range. - The sequence spanning the range using the specified step size. - - - The standard overloaded range operator, e.g. [n..m] for lists, seq {n..m} for sequences - The start value of the range. - The end value of the range. - The sequence spanning the range. - - - Equivalent to System.Single.NaN - - - Equivalent to System.Single.PositiveInfinity - - - Equivalent to System.Double.NaN - - - Equivalent to System.Double.PositiveInfinity - - - Builds a sequence using sequence expression syntax - The input sequence. - The result sequence. - - - Negate a logical value. not true equals false and not false equals true - The value to negate. - The result of the negation. - - - Concatenate two lists. - The first list. - The second list. - The concatenation of the lists. - - - Increment a mutable reference cell containing an integer - The reference cell. - - - Decrement a mutable reference cell containing an integer - The reference cell. - - - Dereference a mutable reference cell - The cell to dereference. - The value contained in the cell. - - - Assign to a mutable reference cell - The cell to mutate. - The value to set inside the cell. - - - Create a mutable reference cell - The value to contain in the cell. - The created reference cell. - - - The identity function - The input value. - The same value. - - - Throw a System.InvalidOperationException exception - The exception message. - The result value. - - - Throw a System.ArgumentNullException exception - The argument name. - The result value. - - - Throw a System.ArgumentException exception with - the given argument name and message. - The argument name. - The exception message. - The result value. - - - Throw a System.Exception exception. - The exception message. - The result value. - - - Determines whether the given value is null. - The value to check. - True when value is null, false otherwise. - - - Try to unbox a strongly typed value. - The boxed value. - The unboxed result as an option. - - - Boxes a strongly typed value. - The value to box. - The boxed object. - - - Unboxes a strongly typed value. - The boxed value. - The unboxed result. - - - Ignore the passed value. This is often used to throw away results of a computation. - The value to ignore. - - - Minimum based on generic comparison - The first value. - The second value. - The minimum value. - - - Maximum based on generic comparison - The first value. - The second value. - The maximum value. - - - Generic comparison. - The first value. - The second value. - The result of the comparison. - - - Return the second element of a tuple, snd (a,b) = b. - The input tuple. - The second value. - - - Return the first element of a tuple, fst (a,b) = a. - The input tuple. - The first value. - - - Matches System.Exception objects whose runtime type is precisely System.Exception - The input exception. - A string option. - - - Builds a System.Exception object. - The message for the Exception. - A System.Exception. - - - Rethrows an exception. This should only be used when handling an exception - The result value. - - - Rethrows an exception. This should only be used when handling an exception - The result value. - - - Raises an exception - The exception to raise. - The result value. - - - Concatenate two strings. The operator '+' may also be used. - - - Used to specify a default value for an optional argument in the implementation of a function - An option representing the argument. - The default value of the argument. - The argument value. If it is None, the defaultValue is returned. - - - Apply a function to three values, the values being a triple on the right, the function on the left - The function. - The first argument. - The second argument. - The third argument. - The function result. - - - Apply a function to two values, the values being a pair on the right, the function on the left - The function. - The first argument. - The second argument. - The function result. - - - Apply a function to a value, the value being on the right, the function on the left - The function. - The argument. - The function result. - - - Apply a function to three values, the values being a triple on the left, the function on the right - The first argument. - The second argument. - The third argument. - The function. - The function result. - - - Apply a function to two values, the values being a pair on the left, the function on the right - The first argument. - The second argument. - The function. - The function result. - - - Apply a function to a value, the value being on the left, the function on the right - The argument. - The function. - The function result. - - - Compose two functions, the function on the right being applied first - The second function to apply. - The first function to apply. - The composition of the input functions. - - - Compose two functions, the function on the left being applied first - The first function to apply. - The second function to apply. - The composition of the input functions. - - - Structural inequality - The first parameter. - The second parameter. - The result of the comparison. - - - Structural equality - The first parameter. - The second parameter. - The result of the comparison. - - - Structural less-than-or-equal comparison - The first parameter. - The second parameter. - The result of the comparison. - - - Structural greater-than-or-equal - The first parameter. - The second parameter. - The result of the comparison. - - - Structural greater-than - The first parameter. - The second parameter. - The result of the comparison. - - - Structural less-than comparison - The first parameter. - The second parameter. - The result of the comparison. - - - Overloaded prefix-plus operator - The input value. - The result of the operation. - - - Overloaded bitwise-NOT operator - The input value. - The result of the operation. - - - Overloaded byte-shift right operator by a specified number of bits - The input value. - The amount to shift. - The result of the operation. - - - Overloaded byte-shift left operator by a specified number of bits - The input value. - The amount to shift. - The result of the operation. - - - Overloaded bitwise-XOR operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded bitwise-OR operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded bitwise-AND operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded modulo operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded division operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded multiplication operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded subtraction operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded addition operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded unary negation. - The value to negate. - The result of the operation. - - - Converts the argument to char. Numeric inputs are converted using a checked - conversion according to the UTF-16 encoding for characters. String inputs must - be exactly one character long. For other input types the operation requires an - appropriate static conversion method on the input type. - The input value. - The converted char - - - Converts the argument to unativeint. This is a direct, checked conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted unativeint - - - Converts the argument to nativeint. This is a direct, checked conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted nativeint - - - Converts the argument to uint64. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.UInt64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint64 - - - Converts the argument to int64. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int64 - - - Converts the argument to uint32. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.UInt32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint32 - - - Converts the argument to int32. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int32 - - - Converts the argument to int. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int - - - Converts the argument to uint16. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.UInt16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint16 - - - Converts the argument to int16. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int16 - - - Converts the argument to sbyte. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.SByte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to byte. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Byte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - Overloaded multiplication operator (checks for overflow) - The first value. - The second value. - The product of the two input values. - - - Overloaded addition operator (checks for overflow) - The first value. - The second value. - The sum of the two input values. - - - Overloaded subtraction operator (checks for overflow) - The first value. - The second value. - The first value minus the second value. - - - Overloaded unary negation (checks for overflow) - The input value. - The negated value. - - - This module contains the basic arithmetic operations with overflow checks. - - - Calls GetHashCode() on the value - The value. - The hash code. - - - Minimum of the two values - The first value. - The second value. - The minimum value. - - - Maximum of the two values - The first value. - The second value. - The maximum value. - - - Compares the two values - The first value. - The second value. - The result of the comparison. - - - Compares the two values for inequality - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for equality - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for less-than-or-equal - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for greater-than-or-equal - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for greater-than - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for less-than - The first parameter. - The second parameter. - The result of the comparison. - - - A module of comparison and equality operators that are statically resolved, but which are not fully generic and do not make structural comparison. Opening this - module may make code that relies on structural or generic comparison no longer compile. - - - Perform generic hashing on a value where the type of the value is not - statically required to satisfy the 'equality' constraint. - The computed hash value. - - - Perform generic equality on two values where the type of the values is not - statically required to satisfy the 'equality' constraint. - The result of the comparison. - - - Perform generic comparison on two values where the type of the values is not - statically required to have the 'comparison' constraint. - The result of the comparison. - - - Generate a default value for any type. This is null for reference types, - For structs, this is struct value where all fields have the default value. - This function is unsafe in the sense that some F# values do not have proper null values. - - - Unboxes a strongly typed value. This is the inverse of box, unbox<t>(box<t> a) equals a. - The boxed value. - The unboxed result. - - - This module contains basic operations which do not apply runtime and/or static checks - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'decimal' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'float' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'float32' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'unativeint' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'nativeint' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint64' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int64' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint32' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int32' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint16' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int16' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'sbyte' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'byte' - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - Generate a range of values using the given zero, add, start, step and stop values - - - Generate a range of values using the given zero, add, start, step and stop values - - - Generate a range of char values - - - Generate a range of byte values - - - Generate a range of sbyte values - - - Generate a range of uint16 values - - - Generate a range of int16 values - - - Generate a range of unativeint values - - - Generate a range of nativeint values - - - Generate a range of uint32 values - - - Generate a range of uint64 values - - - Generate a range of int64 values - - - Generate a range of float32 values - - - Generate a range of float values - - - Generate a range of integers - - - Gets a slice from a string - The source string. - The index of the first character of the slice. - The index of the last character of the slice. - The substring from the given indices. - - - Sets a slice of an array - The target array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The start index of the fourth dimension. - The end index of the fourth dimension. - The source array. - - - Gets a slice of an array - The source array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The start index of the fourth dimension. - The end index of the fourth dimension. - The four dimensional sub array from the given indices. - - - Sets a slice of an array - The target array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The source array. - - - Gets a slice of an array - The source array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The three dimensional sub array from the given indices. - - - Sets a vector slice of a 2D array. The index of the second dimension is fixed. - The target array. - The start index of the first dimension. - The end index of the first dimension. - The index of the second dimension. - The source array. - - - Sets a vector slice of a 2D array. The index of the first dimension is fixed. - The target array. - The index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The source array. - - - Sets a region slice of an array - The target array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The source array. - - - Gets a vector slice of a 2D array. The index of the second dimension is fixed. - The source array. - The start index of the first dimension. - The end index of the first dimension. - The fixed index of the second dimension. - The sub array from the input indices. - - - Gets a vector slice of a 2D array. The index of the first dimension is fixed. - The source array. - The index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The sub array from the input indices. - - - Gets a region slice of an array - The source array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The two dimensional sub array from the input indices. - - - Sets a slice of an array - The target array. - The start index. - The end index. - The source array. - - - Gets a slice of an array - The input array. - The start index. - The end index. - The sub array from the input indices. - - - A module of compiler intrinsic functions for efficient implementations of F# integer ranges - and dynamic invocations of other F# operators - - - Basic F# Operators. This module is automatically opened in all F# code. - - - Invoke an F# first class function value that accepts five curried arguments - without intervening execution - The first arg. - The second arg. - The third arg. - The fourth arg. - The fifth arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept five curried arguments without intervening execution. - The input function. - The optimized function. - - - Construct an optimized function value that can accept five curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept five curried arguments - without intervening execution. This type should not typically used directly from - either F# code or from other CLI languages. - - - Invoke an F# first class function value that accepts four curried arguments - without intervening execution - The first arg. - The second arg. - The third arg. - The fourth arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept four curried arguments without intervening execution. - The input function. - The optimized function. - - - Construct an optimized function value that can accept four curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept four curried arguments - without intervening execution. This type should not typically used directly from - either F# code or from other CLI languages. - - - Invoke an F# first class function value that accepts three curried arguments - without intervening execution - The first arg. - The second arg. - The third arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept three curried arguments without intervening execution. - The input function. - The adapted function. - - - Construct an optimized function value that can accept three curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept - three iterated (curried) arguments without intervening execution. This type should not - typically used directly from either F# code or from other CLI languages. - - - Invoke the optimized function value with two curried arguments - The first arg. - The second arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept two curried arguments without intervening execution. - The input function. - The adapted function. - - - Construct an optimized function value that can accept two curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept - two iterated (curried) arguments without intervening execution. This type should not - typically used directly from either F# code or from other CLI languages. - - - An implementation module used to hold some private implementations of function - value invocation. - - - Convert an option to a potentially null value. - The input value. - The result value, which is null if the input was None. - - - Convert a potentially null value to an option. - The input value. - The result option. - - - Convert a Nullable value to an option. - The input nullable value. - The result option. - - - Convert the option to a Nullable value. - The input option. - The result value. - - - Convert the option to a list of length 0 or 1. - The input option. - The result list. - - - Convert the option to an array of length 0 or 1. - The input option. - The result array. - - - filter f inp evaluates to match inp with None -> None | Some x -> if f x then Some x else None. - A function that evaluates whether the value contained in the option should remain, or be filtered out. - The input option. - The input if the predicate evaluates to true; otherwise, None. - - - bind f inp evaluates to match inp with None -> None | Some x -> f x - A function that takes the value of type T from an option and transforms it into - an option containing a value of type U. - The input option. - An option of the output type of the binder. - - - map f inp evaluates to match inp with None -> None | Some x -> Some (f x). - A function to apply to the option value. - The input option. - An option of the input value after applying the mapping function, or None if the input is None. - - - iter f inp executes match inp with None -> () | Some x -> f x. - A function to apply to the option value. - The input option. - Unit if the option is None, otherwise it returns the result of applying the predicate - to the option value. - - - forall p inp evaluates to match inp with None -> true | Some x -> p x. - A function that evaluates to a boolean when given a value from the option type. - The input option. - True if the option is None, otherwise it returns the result of applying the predicate - to the option value. - - - exists p inp evaluates to match inp with None -> false | Some x -> p x. - A function that evaluates to a boolean when given a value from the option type. - The input option. - False if the option is None, otherwise it returns the result of applying the predicate - to the option value. - - - fold f inp s evaluates to match inp with None -> s | Some x -> f x s. - A function to update the state data when given a value from an option. - The input option. - The initial state. - The original state if the option is None, otherwise it returns the updated state with the folder - and the option value. - - - fold f s inp evaluates to match inp with None -> s | Some x -> f s x. - A function to update the state data when given a value from an option. - The initial state. - The input option. - The original state if the option is None, otherwise it returns the updated state with the folder - and the option value. - - - count inp evaluates to match inp with None -> 0 | Some _ -> 1. - The input option. - A zero if the option is None, a one otherwise. - - - Gets the value associated with the option. - The input option. - The value within the option. - Thrown when the option is None. - - - Returns true if the option is None. - The input option. - True if the option is None. - - - Returns true if the option is not None. - The input option. - True if the option is not None. - - - Basic operations on options. - - - Represents a statically-analyzed format associated with writing to a System.IO.TextWriter. The type parameter indicates the - arguments and return type of the format operation. - - - Represents a statically-analyzed format when formatting builds a string. The type parameter indicates the - arguments and return type of the format operation. - - - Represents a statically-analyzed format associated with writing to a System.Text.StringBuilder. The type parameter indicates the - arguments and return type of the format operation. - - - Represents a statically-analyzed format associated with writing to a System.IO.TextWriter. The first type parameter indicates the - arguments of the format operation and the last the overall return type. - - - Represents a statically-analyzed format when formatting builds a string. The first type parameter indicates the - arguments of the format operation and the last the overall return type. - - - Represents a statically-analyzed format associated with writing to a System.Text.StringBuilder. The first type parameter indicates the - arguments of the format operation and the last the overall return type. - - - Print to a string buffer and raise an exception with the given - result. Helper printers must return strings. - The input formatter. - The arguments of the formatter. - - - sprintf, but call the given 'final' function to generate the result. - See kprintf. - The function called to generate a result from the formatted string. - The input formatter. - The arguments of the formatter. - - - printf, but call the given 'final' function to generate the result. - For example, these let the printing force a flush after all output has - been entered onto the channel, but not before. - The function called after formatting to generate the format result. - The input formatter. - The arguments of the formatter. - - - fprintf, but call the given 'final' function to generate the result. - See kprintf. - The function called after formatting to generate the format result. - The input TextWriter. - The input formatter. - The arguments of the formatter. - - - bprintf, but call the given 'final' function to generate the result. - See kprintf. - The function called after formatting to generate the format result. - The input StringBuilder. - The input formatter. - The arguments of the formatter. - - - Print to a string via an internal string buffer and return - the result as a string. Helper printers must return strings. - The input formatter. - The formatted string. - - - Print to a text writer, adding a newline - The TextWriter to print to. - The input formatter. - The return type and arguments of the formatter. - - - Print to a text writer. - The TextWriter to print to. - The input formatter. - The return type and arguments of the formatter. - - - Print to a System.Text.StringBuilder - The StringBuilder to print to. - The input formatter. - The return type and arguments of the formatter. - - - Extensible printf-style formatting for numbers and other datatypes - - Format specifications are strings with "%" markers indicating format - placeholders. Format placeholders consist of: - - %[flags][width][.precision][type] - - where the type is interpreted as follows: - - %b: bool, formatted as "true" or "false" - %s: string, formatted as its unescaped contents - %c: character literal - %d, %i: any basic integer type formatted as a decimal integer, signed if the basic integer type is signed. - %u: any basic integer type formatted as an unsigned decimal integer - %x, %X, %o: any basic integer type formatted as an unsigned hexadecimal - (a-f)/Hexadecimal (A-F)/Octal integer - - %e, %E, %f, %F, %g, %G: - any basic floating point type (float,float32) formatted - using a C-style floating point format specifications, i.e - - %e, %E: Signed value having the form [-]d.dddde[sign]ddd where - d is a single decimal digit, dddd is one or more decimal - digits, ddd is exactly three decimal digits, and sign - is + or - - - %f: Signed value having the form [-]dddd.dddd, where dddd is one - or more decimal digits. The number of digits before the - decimal point depends on the magnitude of the number, and - the number of digits after the decimal point depends on - the requested precision. - - %g, %G: Signed value printed in f or e format, whichever is - more compact for the given value and precision. - - - %M: System.Decimal value - - %O: Any value, printed by boxing the object and using it's ToString method(s) - - %A: Any value, printed with the default layout settings - - %a: A general format specifier, requires two arguments: - (1) a function which accepts two arguments: - (a) a context parameter of the appropriate type for the - given formatting function (e.g. an #System.IO.TextWriter) - (b) a value to print - and which either outputs or returns appropriate text. - - (2) the particular value to print - - - %t: A general format specifier, requires one argument: - (1) a function which accepts a context parameter of the - appropriate type for the given formatting function (e.g. - an System.IO.TextWriter)and which either outputs or returns - appropriate text. - - Basic integer types are: - byte,sbyte,int16,uint16,int32,uint32,int64,uint64,nativeint,unativeint - Basic floating point types are: - float, float32 - - The optional width is an integer indicating the minimal width of the - result. For instance, %6d prints an integer, prefixing it with spaces - to fill at least 6 characters. If width is '*', then an extra integer - argument is taken to specify the corresponding width. - - any number - '*': - - Valid flags are: - - 0: add zeros instead of spaces to make up the required width - '-': left justify the result within the width specified - '+': add a '+' character if the number is positive (to match a '-' sign - for negatives) - ' ': add an extra space if the number is positive (to match a '-' - sign for negatives) - - The printf '#' flag is invalid and a compile-time error will be reported if it is used. - - - Returns the length of the string. - The input string. - The number of characters in the string. - - - Returns a string by concatenating count instances of str. - The number of copies of the input string will be copied. - The input string. - The concatenated string. - Thrown when count is negative. - - - Tests if any character of the string satisfies the given predicate. - The function to test each character of the string. - The input string. - True if any character returns true for the predicate and false otherwise. - - - Tests if all characters in the string satisfy the given predicate. - The function to test each character of the string. - The input string. - True if all characters return true for the predicate and false otherwise. - - - Builds a new string whose characters are the results of applying the function mapping - to each index from 0 to count-1 and concatenating the resulting - strings. - The number of strings to initialize. - The function to take an index and produce a string to - be concatenated with the others. - The constructed string. - Thrown when count is negative. - - - Builds a new string containing only the characters of the input string - for which the given predicate returns "true". - - Returns an empty string if the input string is null - - A function to test whether each character in the input sequence should be included in the output string. - The input string. - The resulting string. - - - Builds a new string whose characters are the results of applying the function mapping - to each of the characters of the input string and concatenating the resulting - strings. - The function to produce a string from each character of the input string. - The input string. - The concatenated string. - - - Builds a new string whose characters are the results of applying the function mapping - to each character and index of the input string. - The function to apply to each character and index of the string. - The input string. - The resulting string. - - - Builds a new string whose characters are the results of applying the function mapping - to each of the characters of the input string. - The function to apply to the characters of the string. - The input string. - The resulting string. - - - Applies the function action to the index of each character in the string and the - character itself. - The function to apply to each character and index of the string. - The input string. - - - Applies the function action to each character in the string. - The function to be applied to each character of the string. - The input string. - - - Returns a new string made by concatenating the given strings - with separator sep, that is a1 + sep + ... + sep + aN. - The separator string to be inserted between the strings - of the input sequence. - The sequence of strings to be concatenated. - A new string consisting of the concatenated strings separated by - the separation string. - Thrown when strings is null. - - - Functional programming operators for string processing. Further string operations - are available via the member functions on strings and other functionality in - System.String - and System.Text.RegularExpressions types. - - - - The SI unit of catalytic activity - - - - - The SI unit of does equivalent - - - - - The SI unit of absorbed dose - - - - - The SI unit of activity referred to a radionuclide - - - - - The SI unit of illuminance - - - - - The SI unit of luminous flux - - - - - The SI unit of inductance - - - - - The SI unit of magnetic flux density - - - - - The SI unit of magnetic flux - - - - - The SI unit of electric conductance - - - - - The SI unit of electric resistance - - - - - The SI unit of capacitance - - - - - The SI unit of electric potential difference, electromotive force - - - - - The SI unit of electric charge, amount of electricity - - - - - The SI unit of power, radiant flux - - - - - The SI unit of energy, work, amount of heat - - - - - The SI unit of pressure, stress - - - - - The SI unit of force - - - - - The SI unit of frequency - - - - - The SI unit of luminous intensity - - - - - The SI unit of amount of substance - - - - - The SI unit of thermodynamic temperature - - - - - The SI unit of electric current - - - - - The SI unit of time - - - - - The SI unit of mass - - - - - The SI unit of length - - - - - The SI unit of length - - - - - A synonym for henry, the SI unit of inductance - - - - - A synonym for katal, the SI unit of catalytic activity - - - - - A synonym for sievert, the SI unit of does equivalent - - - - - A synonym for gray, the SI unit of absorbed dose - - - - - A synonym for becquerel, the SI unit of activity referred to a radionuclide - - - - - A synonym for lux, the SI unit of illuminance - - - - - A synonym for lumen, the SI unit of luminous flux - - - - - A synonym for tesla, the SI unit of magnetic flux density - - - - - A synonym for weber, the SI unit of magnetic flux - - - - - A synonym for UnitNames.ohm, the SI unit of electric resistance. - - - - - A synonym for siemens, the SI unit of electric conductance - - - - - A synonym for farad, the SI unit of capacitance - - - - - A synonym for volt, the SI unit of electric potential difference, electromotive force - - - - - A synonym for coulomb, the SI unit of electric charge, amount of electricity - - - - - A synonym for watt, the SI unit of power, radiant flux - - - - - A synonym for joule, the SI unit of energy, work, amount of heat - - - - - A synonym for pascal, the SI unit of pressure, stress - - - - - A synonym for newton, the SI unit of force - - - - - A synonym for hertz, the SI unit of frequency - - - - - A synonym for candela, the SI unit of luminous intensity - - - - - A synonym for mole, the SI unit of amount of substance - - - - - A synonym for kelvin, the SI unit of thermodynamic temperature - - - - - A synonym for ampere, the SI unit of electric current - - - - - A synonym for second, the SI unit of time - - - - - A synonym for kilogram, the SI unit of mass - - - - - A synonym for Metre, the SI unit of length - - - - - A method used to support the F# query syntax. Returns an empty sequence that has the specified type argument. - - - - - A method used to support the F# query syntax. Returns a sequence that contains the specified values. - - - - - A method used to support the F# query syntax. Returns a sequence of length one that contains the specified value. - - - - A query operator that selects those elements based on a specified predicate. - - - - A query operator that performs a subsequent ordering of the elements selected so far in descending order by the given nullable sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - - - - A query operator that performs a subsequent ordering of the elements selected so far in ascending order by the given nullable sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - - - - A query operator that performs a subsequent ordering of the elements selected so far in descending order by the given sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - - - - A query operator that performs a subsequent ordering of the elements selected so far in ascending order by the given sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - - - - A query operator that selects elements from a sequence as long as a specified condition is true, and then skips the remaining elements. - - - - A query operator that selects a specified number of contiguous elements from those selected so far. - - - - A query operator that selects a nullable value for each element selected so far and returns the sum of these values. - If any nullable does not have a value, it is ignored. - - - - A query operator that selects a value for each element selected so far and returns the sum of these values. - - - - - A method used to support the F# query syntax. Inputs to queries are implicitly wrapped by a call to one of the overloads of this method. - - - - - A method used to support the F# query syntax. Inputs to queries are implicitly wrapped by a call to one of the overloads of this method. - - - - A query operator that sorts the elements selected so far in descending order by the given nullable sorting key. - - - - A query operator that sorts the elements selected so far in ascending order by the given nullable sorting key. - - - - A query operator that sorts the elements selected so far in descending order by the given sorting key. - - - - A query operator that sorts the elements selected so far in ascending order by the given sorting key. - - - - A query operator that bypasses elements in a sequence as long as a specified condition is true and then selects the remaining elements. - - - - A query operator that bypasses a specified number of the elements selected so far and selects the remaining elements. - - - - A query operator that projects each of the elements selected so far. - - - - - A method used to support the F# query syntax. Runs the given quotation as a query using LINQ IQueryable rules. - - - - - A method used to support the F# query syntax. Indicates that the query should be passed as a quotation to the Run method. - - - - A query operator that selects the element at a specified index amongst those selected so far. - - - - A query operator that selects a nullable value for each element selected so far and returns the minimum of these values. - If any nullable does not have a value, it is ignored. - - - - A query operator that selects a value for each element selected so far and returns the minimum resulting value. - - - - A query operator that selects a nullable value for each element selected so far and returns the maximum of these values. - If any nullable does not have a value, it is ignored. - - - - A query operator that selects a value for each element selected so far and returns the maximum resulting value. - - - - A query operator that correlates two sets of selected values based on matching keys and groups the results. - If any group is empty, a group with a single default value is used instead. - Normal usage is 'leftOuterJoin y in elements2 on (key1 = key2) into group'. - - - - A query operator that selects the last element of those selected so far, or a default value if no element is found. - - - - A query operator that selects the last element of those selected so far. - - - - A query operator that correlates two sets of selected values based on matching keys. - Normal usage is 'join y in elements2 on (key1 = key2)'. - - - - A query operator that selects the first element of those selected so far, or a default value if the sequence contains no elements. - - - - A query operator that selects the first element from those selected so far. - - - - A query operator that selects a value for each element selected so far and groups the elements by the given key. - - - - A query operator that correlates two sets of selected values based on matching keys and groups the results. - Normal usage is 'groupJoin y in elements2 on (key1 = key2) into group'. - - - - A query operator that groups the elements selected so far according to a specified key selector. - - - - - A method used to support the F# query syntax. Projects each element of a sequence to another sequence and combines the resulting sequences into one sequence. - - - - A query operator that selects the first element selected so far that satisfies a specified condition. - - - - A query operator that determines whether any element selected so far satisfies a condition. - - - - A query operator that selects the single, specific element of those selected so far, or a default value if that element is not found. - - - - A query operator that selects the single, specific element selected so far - - - - A query operator that selects distinct elements from the elements selected so far. - - - - A query operator that returns the number of selected elements. - - - - A query operator that determines whether the selected elements contains a specified element. - - - - A query operator that selects a nullable value for each element selected so far and returns the average of these values. - If any nullable does not have a value, it is ignored. - - - - A query operator that selects a value for each element selected so far and returns the average of these values. - - - - A query operator that determines whether all elements selected so far satisfies a condition. - - - - Create an instance of this builder. Use 'query { ... }' to use the query syntax. - - - - The type used to support the F# query syntax. Use 'query { ... }' to use the query syntax. - - - - - A property used to support the F# query syntax. - - - - - A method used to support the F# query syntax. - - - - - A partial input or result in an F# query. This type is used to support the F# query syntax. - - - - Converts the argument to character. Numeric inputs are converted according to the UTF-16 - encoding for characters. The operation requires an appropriate static conversion method on the input type. - The input value. - The converted char. - - - Converts the argument to System.Decimal using a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted decimal. - - - Converts the argument to unsigned native integer using a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted unativeint - - - Converts the argument to signed native integer. This is a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted nativeint - - - Converts the argument to 64-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float - - - Converts the argument to 32-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float32 - - - Converts the argument to 64-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float - - - Converts the argument to 32-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float32 - - - Converts the argument to unsigned 64-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint64 - - - Converts the argument to signed 64-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int64 - - - Converts the argument to unsigned 32-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint32 - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int32 - - - Converts the argument to a particular enum type. - The input value. - The converted enum type. - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int - - - Converts the argument to unsigned 16-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint16 - - - Converts the argument to signed 16-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int16 - - - Converts the argument to signed byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to signed byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - Converts the argument to byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - - Functions for converting nullable values - - - - - The division operator where a nullable value appears on both left and right sides - - - - - The division operator where a nullable value appears on the right - - - - - The division operator where a nullable value appears on the left - - - - - The modulus operator where a nullable value appears on both left and right sides - - - - - The modulus operator where a nullable value appears on the right - - - - - The modulus operator where a nullable value appears on the left - - - - - The multiplication operator where a nullable value appears on both left and right sides - - - - - The multiplication operator where a nullable value appears on the right - - - - - The multiplication operator where a nullable value appears on the left - - - - - The subtraction operator where a nullable value appears on both left and right sides - - - - - The subtraction operator where a nullable value appears on the right - - - - - The subtraction operator where a nullable value appears on the left - - - - - The addition operator where a nullable value appears on both left and right sides - - - - - The addition operator where a nullable value appears on the right - - - - - The addition operator where a nullable value appears on the left - - - - - The '<>' operator where a nullable value appears on both left and right sides - - - - - The '=' operator where a nullable value appears on both left and right sides - - - - - The '<' operator where a nullable value appears on both left and right sides - - - - - The '<=' operator where a nullable value appears on both left and right sides - - - - - The '>' operator where a nullable value appears on both left and right sides - - - - - The '>=' operator where a nullable value appears on both left and right sides - - - - - The '<>' operator where a nullable value appears on the right - - - - - The '=' operator where a nullable value appears on the right - - - - - The '<' operator where a nullable value appears on the right - - - - - The '<=' operator where a nullable value appears on the right - - - - - The '>' operator where a nullable value appears on the right - - - - - The '>=' operator where a nullable value appears on the right - - - - - The '<>' operator where a nullable value appears on the left - - - - - The '=' operator where a nullable value appears on the left - - - - - The '<' operator where a nullable value appears on the left - - - - - The '<=' operator where a nullable value appears on the left - - - - - The '>' operator where a nullable value appears on the left - - - - - The '>=' operator where a nullable value appears on the left - - - - - Operators for working with nullable values - - - - - A method used to support the F# query syntax. Runs the given quotation as a query using LINQ IEnumerable rules. - - - - - A method used to support the F# query syntax. Runs the given quotation as a query using LINQ rules. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - A type used to reconstruct a grouping after applying a mutable->immutable mapping transformation - on a result of a query. - - - - - The generic MethodInfo for Select function - Describes how we got from productions of immutable objects to productions of anonymous objects, with enough information - that we can invert the process in final query results. - - - - - Given the expression part of a "yield" or "select" which produces a result in terms of immutable tuples or immutable records, - generate an equivalent expression yielding anonymous objects. Also return the conversion for the immutable-to-mutable correspondence - so we can reverse this later. - - - - - Simplify gets of tuples and gets of record fields. - - - - - Cleanup the use of property-set object constructions in leaf expressions that form parts of F# queries. - - - - - Given an type involving immutable tuples and records, logically corresponding to the type produced at a - "yield" or "select", convert it to a type involving anonymous objects according to the conversion data. - - - - - Recognize anonymous type construction written using 'new AnonymousObject(<e1>, <e2>, ...)' - - - - - Recognize object construction written using 'new O(Prop1 = <e>, Prop2 = <e>, ...)' - - - - - Tests whether a list consists only of assignments of properties of the - given variable, null values (ignored) and ends by returning the given variable - (pattern returns only property assignments) - - - - - Recognize sequential series written as (... ((<e>; <e>); <e>); ...) - - - - - A runtime helper used to evaluate nested quotation literals. - - - - - A runtime helper used to evaluate nested quotation literals. - - - - - Evaluates a subset of F# quotations by first converting to a LINQ expression, for the subset of LINQ expressions represented by the - expression syntax in the C# language. - - - - - Converts a subset of F# quotations to a LINQ expression, for the subset of LINQ expressions represented by the - expression syntax in the C# language. - - - - - Converts a subset of F# quotations to a LINQ expression, for the subset of LINQ expressions represented by the - expression syntax in the C# language. - - - - - When used in a quotation, this function indicates a specific conversion - should be performed when converting the quotation to a LINQ expression. - - This function should not be called directly. - - - - - When used in a quotation, this function indicates a specific conversion - should be performed when converting the quotation to a LINQ expression. - - This function should not be called directly. - - - - - When used in a quotation, this function indicates a specific conversion - should be performed when converting the quotation to a LINQ expression. - - This function should not be called directly. - - - - Allocates a region of memory on the stack. - The number of objects of type T to allocate. - A typed pointer to the allocated memory. - - - Assigns the value into the memory location referenced by the typed native - pointer computed by adding index * sizeof<'T> to the given input pointer. - The input pointer. - The index by which to offset the pointer. - The value to assign. - - - Assigns the value into the memory location referenced by the given typed native pointer. - The input pointer. - The value to assign. - - - Dereferences the given typed native pointer. - The input pointer. - The value at the pointer address. - - - Dereferences the typed native pointer computed by adding index * sizeof<'T> to the - given input pointer. - The input pointer. - The index by which to offset the pointer. - The value at the pointer address. - - - Returns a typed native pointer by adding index * sizeof<'T> to the - given input pointer. - The input pointer. - The index by which to offset the pointer. - A typed pointer. - - - Returns a machine address for a given typed native pointer. - The input pointer. - The machine address. - - - Returns a typed native pointer for a given machine address. - The pointer address. - A typed pointer. - - - Contains operations on native pointers. Use of these operators may - result in the generation of unverifiable code. - - - Gets the raw expression associated with this type-carrying expression - - - Type-carrying quoted expressions. Expressions are generated either - by quotations in source text or programatically - - - Returns type of an expression. - - - Returns the custom attributes of an expression. - - - Builds an expression that represents a value and its associated reflected definition as a quotation - The untyped object. - The type of the object. - The definition of the value being quoted. - The resulting expression. - - - Builds an expression that represents a value and its associated reflected definition as a quotation - The value being quoted. - The definition of the value being quoted. - The resulting expression. - - - Builds an expression that represents a while loop - The predicate to control the loop iteration. - The body of the while loop. - The resulting expression. - - - Builds an expression that represents setting a mutable variable - The input variable. - The value to set. - The resulting expression. - - - Builds an expression that represents a variable - The input variable. - The resulting expression. - - - Builds an expression that represents a constant value of a particular type, arising from a variable of the given name - The untyped object. - The type of the object. - The name of the variable. - The resulting expression. - - - Builds an expression that represents a constant value, arising from a variable of the given name - The typed value. - The name of the variable. - The resulting expression. - - - Builds an expression that represents a constant value - The typed value. - The resulting expression. - - - Builds an expression that represents a constant value of a particular type - The untyped object. - The type of the object. - The resulting expression. - - - Builds an expression that represents a test of a value is of a particular union case - The expression to test. - The description of the union case. - The resulting expression. - - - Builds an expression that represents a type test. - The expression to test. - The target type. - The resulting expression. - - - Builds an expression that represents getting a field of a tuple - The input tuple. - The index of the tuple element to get. - The resulting expression. - - - Builds an expression that represents a try/with construct for exception filtering and catching. - The body of the try expression. - - - The variable to bind to a caught exception. - The expression evaluated when an exception is caught. - The resulting expression. - - - Try and find a stored reflection definition for the given method. Stored reflection - definitions are added to an F# assembly through the use of the [<ReflectedDefinition>] attribute. - The description of the method to find. - The reflection definition or None if a match could not be found. - - - Builds an expression that represents a try/finally construct - The body of the try expression. - The final part of the expression to be evaluated. - The resulting expression. - - - Format the expression as a string - Indicates if method, property, constructor and type objects should be printed in detail. If false, these are abbreviated to their name. - The formatted string. - - - Substitutes through the given expression using the given functions - to map variables to new values. The functions must give consistent results - at each application. Variable renaming may occur on the target expression - if variable capture occurs. - The function to map variables into expressions. - The expression with the given substitutions. - - - Builds an expression that represents the sequential execution of one expression followed by another - The first expression. - The second expression. - The resulting expression. - - - Permits interactive environments such as F# Interactive - to explicitly register new pickled resources that represent persisted - top level definitions. - The assembly associated with the resource. - The unique name for the resources being added. - The type definitions referenced. - The serialized resource to register with the environment. - - - Permits interactive environments such as F# Interactive - to explicitly register new pickled resources that represent persisted - top level definitions. - The assembly associated with the resource. - The unique name for the resources being added. - The serialized resource to register with the environment. - - - Builds an expression that represents a nested typed quotation literal - The expression being quoted. - The resulting expression. - - - Builds an expression that represents a nested raw quotation literal - The expression being quoted. - The resulting expression. - - - Builds an expression that represents a nested typed or raw quotation literal - The expression being quoted. - The resulting expression. - - - Builds an expression that represents writing to a static property - The description of the property. - The value to set. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents writing to a property of an object - The input object. - The description of the property. - The value to set. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents reading a static property - The description of the property. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents reading a property of an object - The input object. - The description of the property. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents the creation of a union case value - The description of the union case. - The list of arguments for the case. - The resulting expression. - - - Builds an expression that represents the creation of an F# tuple value - The list of elements of the tuple. - The resulting expression. - - - Builds record-construction expressions - The type of record. - The list of elements of the record. - The resulting expression. - - - Builds an expression that represents the invocation of an object constructor - The description of the constructor. - The list of arguments to the constructor. - The resulting expression. - - - Builds an expression that represents the creation of a delegate value for the given type - The type of delegate. - The parameters for the delegate. - The body of the function. - The resulting expression. - - - Builds an expression that represents the creation of an array value initialized with the given elements - The type for the elements of the array. - The list of elements of the array. - The resulting expression. - - - Builds recursives expressions associated with 'let rec' constructs - The list of bindings for the let expression. - The sub-expression where the bindings are in scope. - The resulting expression. - - - Builds expressions associated with 'let' constructs - The variable in the let expression. - The expression bound to the variable. - The sub-expression where the binding is in scope. - The resulting expression. - - - Builds an expression that represents the constrution of an F# function value - The parameter to the function. - The body of the function. - The resulting expression. - - - Builds 'if ... then ... else' expressions. - The condition expression. - The then sub-expression. - The else sub-expression. - The resulting expression. - - - Fetches or creates a new variable with the given name and type from a global pool of shared variables - indexed by name and type. The type is given by the expicit or inferred type parameter - The variable name. - The created of fetched typed global variable. - - - Gets the free expression variables of an expression as a list. - A sequence of the free variables in the expression. - - - Builds a 'for i = ... to ... do ...' expression that represent loops over integer ranges - The sub-expression declaring the loop variable. - The sub-expression setting the initial value of the loop variable. - The sub-expression declaring the final value of the loop variable. - The sub-expression representing the body of the loop. - The resulting expression. - - - Builds an expression that represents writing to a field of an object - The input object. - The description of the field to write to. - The value to set to the field. - The resulting expression. - - - Builds an expression that represents writing to a static field - The description of the field to write to. - The value to the set to the field. - The resulting expression. - - - Builds an expression that represents the access of a field of an object - The input object. - The description of the field to access. - The resulting expression. - - - Builds an expression that represents the access of a static field - The description of the field to access. - The resulting expression. - - - This function is called automatically when quotation syntax (<@ @>) and other sources of - quotations are used. - A type in the assembly where the quotation occurs. - The type definitions referenced. - The spliced types, to replace references to type variables. - The spliced expressions to replace references to spliced expressions. - The serialized form of the quoted expression. - The resulting expression. - - - This function is called automatically when quotation syntax (<@ @>) and other sources of - quotations are used. - A type in the assembly where the quotation occurs. - The spliced types, to replace references to type variables. - The spliced expressions to replace references to spliced expressions. - The serialized form of the quoted expression. - The resulting expression. - - - Builds an expression that represents the invocation of a default object constructor - The type on which the constructor is invoked. - The resulting expression. - - - Builds an expression that represents the coercion of an expression to a type - The expression to coerce. - The target type. - The resulting expression. - - - Returns a new typed expression given an underlying runtime-typed expression. - A type annotation is usually required to use this function, and - using an incorrect type annotation may result in a later runtime exception. - The expression to cast. - The resulting typed expression. - - - Builds an expression that represents a call to an instance method associated with an object - The input object. - The description of the method to call. - The list of arguments to the method. - The resulting expression. - - - Builds an expression that represents a call to an static method or module-bound function - The MethodInfo describing the method to call. - The list of arguments to the method. - The resulting expression. - - - Builds an expression that represents the application of a first class function value to multiple arguments - The function to apply. - The list of lists of arguments to the function. - The resulting expression. - - - Builds an expression that represents the application of a first class function value to a single argument. - The function to apply. - The argument to the function. - The resulting expression. - - - Builds an expression that represents setting the value held at a particular address. - The target expression. - The value to set at the address. - The resulting expression. - - - Builds an expression that represents getting the address of a value. - The target expression. - The resulting expression. - - - Quoted expressions annotated with System.Type values. - - - The type associated with the variable - - - The declared name of the variable - - - Indicates if the variable represents a mutable storage location - - - Fetches or create a new variable with the given name and type from a global pool of shared variables - indexed by name and type - The name of the variable. - The type associated with the variable. - The retrieved or created variable. - - - Creates a new variable with the given name, type and mutability - The declared name of the variable. - The type associated with the variable. - Indicates if the variable represents a mutable storage location. Default is false. - The created variable. - - - Information at the binding site of a variable - - - Re-build combination expressions. The first parameter should be an object - returned by the ShapeCombination case of the active pattern in this module. - The input shape. - The list of arguments. - The rebuilt expression. - - - An active pattern that performs a complete decomposition viewing the expression tree as a binding structure - The input expression. - The decomposed Var, Lambda, or ConstApp. - - - Active patterns for traversing, visiting, rebuilding and tranforming expressions in a generic way - - - An active pattern to recognize property setters that have an associated ReflectedDefinition - The description of the property. - The expression of the method definition if found, or None. - - - An active pattern to recognize property getters or values in modules that have an associated ReflectedDefinition - The description of the property. - The expression of the method definition if found, or None. - - - An active pattern to recognize methods that have an associated ReflectedDefinition - The description of the method. - The expression of the method definition if found, or None. - - - A parameterized active pattern to recognize calls to a specified function or method. - The returned elements are the optional target object (present if the target is an - instance method), the generic type instantation (non-empty if the target is a generic - instantiation), and the arguments to the function or method. - The input template expression to specify the method to call. - The optional target object (present if the target is an - instance method), the generic type instantation (non-empty if the target is a generic - instantiation), and the arguments to the function or method. - - - An active pattern to recognize constant decimal expressions - The input expression to match against. - decimal option - - - An active pattern to recognize constant unsigned int64 expressions - The input expression to match against. - uint64 option - - - An active pattern to recognize constant int64 expressions - The input expression to match against. - int64 option - - - An active pattern to recognize constant unsigned int32 expressions - The input expression to match against. - uint32 option - - - An active pattern to recognize constant int32 expressions - The input expression to match against. - int32 option - - - An active pattern to recognize constant unsigned int16 expressions - The input expression to match against. - uint16 option - - - An active pattern to recognize constant int16 expressions - The input expression to match against. - int16 option - - - An active pattern to recognize constant byte expressions - The input expression to match against. - byte option - - - An active pattern to recognize constant signed byte expressions - The input expression to match against. - sbyte option - - - An active pattern to recognize constant unicode character expressions - The input expression to match against. - char option - - - An active pattern to recognize constant 64-bit floating point number expressions - The input expression to match against. - float option - - - An active pattern to recognize constant 32-bit floating point number expressions - The input expression to match against. - float32 option - - - An active pattern to recognize constant string expressions - The input expression to match against. - string option - - - An active pattern to recognize constant boolean expressions - The input expression to match against. - bool option - - - An active pattern to recognize () constant expressions - The input expression to match against. - unit option - - - An active pattern to recognize expressions of the form a || b - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions of the form a && b - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent the application of a (possibly curried or tupled) first class function value - The input expression to match against. - (Expr * Expr list list) option - - - An active pattern to recognize expressions that represent a (possibly curried or tupled) first class function value - The input expression to match against. - (Var list list * Expr) option - - - Contains a set of derived F# active patterns to analyze F# expression objects - - - An active pattern to recognize expressions that represent setting a mutable variable - The input expression to match against. - (Var * Expr) option - - - An active pattern to recognize expressions that represent a variable - The input expression to match against. - Var option - - - An active pattern to recognize expressions that are a value with an associated definition - The input expression to match against. - The boxed value, its static type and its definition - - - An active pattern to recognize expressions that represent a constant value - The input expression to match against. - The boxed value, its static type and its name - - - An active pattern to recognize expressions that represent a constant value. This also matches expressions matched by ValueWithName. - The input expression to match against. - The boxed value and its static type - - - An active pattern to recognize expressions that represent a test if a value is of a particular union case - The input expression to match against. - The expression and union case being tested - - - An active pattern to recognize expressions that represent a dynamic type test - The input expression to match against. - The expression and type being tested - - - An active pattern to recognize expressions that represent getting a tuple field - The input expression to match against. - The expression and tuple field being accessed - - - An active pattern to recognize expressions that represent a try/finally construct - The input expression to match against. - The body and handler parts of the try/finally expression - - - An active pattern to recognize expressions that represent a try/with construct for exception filtering and catching - The input expression to match against. - (Expr * Var * Expr * Var * Expr) option - - - An active pattern to recognize expressions that represent sequential exeuction of one expression followed by another - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent a nested typed quotation literal - The input expression to match against. - Expr option - - - An active pattern to recognize expressions that represent a nested raw quotation literal - The input expression to match against. - Expr option - - - An active pattern to recognize expressions that represent a nested quotation literal - The input expression to match against. - Expr option - - - An active pattern to recognize expressions that represent setting a static or instance property, or a non-function value declared in a module - The input expression to match against. - (Expr option * PropertyInfo * Expr list * Expr) option - - - An active pattern to recognize expressions that represent the read of a static or instance property, or a non-function value declared in a module - The input expression to match against. - (Expr option * PropertyInfo * Expr list) option - - - An active pattern to recognize expressions that represent construction of tuple values - The input expression to match against. - (Expr list) option - - - An active pattern to recognize expressions that represent construction of particular union case values - The input expression to match against. - (UnionCaseInfo * Expr list) option - - - An active pattern to recognize expressions that represent construction of record values - The input expression to match against. - (Type * Expr list) option - - - An active pattern to recognize expressions that represent invocation of object constructors - The input expression to match against. - (ConstructorInfo * Expr list) option - - - An active pattern to recognize expressions that represent construction of delegate values - The input expression to match against. - (Type * Var list * Expr) option - - - An active pattern to recognize expressions that represent invocations of a default constructor of a struct - The input expression to match against. - Type option - - - An active pattern to recognize expressions that represent the construction of arrays - The input expression to match against. - (Type * Expr list) option - - - An active pattern to recognize expressions that represent recursive let bindings of one or more variables - The input expression to match against. - ((Var * Expr) list * Expr) option - - - An active pattern to recognize expressions that represent let bindings - The input expression to match against. - (Var * Expr * Expr) option - - - An active pattern to recognize expressions that represent first class function values - The input expression to match against. - (Var * Expr) option - - - An active pattern to recognize expressions that represent conditionals - The input expression to match against. - (Expr * Expr * Expr) option - - - An active pattern to recognize expressions that represent while loops - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent loops over integer ranges - The input expression to match against. - (Var * Expr * Expr * Expr) option - - - An active pattern to recognize expressions that represent setting a static or instance field - The input expression to match against. - (Expr option * FieldInfo * Expr) option - - - An active pattern to recognize expressions that represent getting a static or instance field - The input expression to match against. - (Expr option * FieldInfo) option - - - An active pattern to recognize expressions that represent coercions from one type to another - The input expression to match against. - (Expr * Type) option - - - An active pattern to recognize expressions that represent calls to static and instance methods, and functions defined in modules - The input expression to match against. - (Expr option * MethodInfo * Expr list) option - - - An active pattern to recognize expressions that represent applications of first class function values - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent setting the value held at an address - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent getting the address of a value - The input expression to match against. - Expr option - - - Contains a set of primitive F# active patterns to analyze F# expression objects - - - Returns a System.Type representing an F# tuple type with the given element types - An array of types for the tuple elements. - The type representing the tuple containing the input elements. - - - Returns a System.Type representing the F# function type with the given domain and range - The input type of the function. - The output type of the function. - The function type with the given domain and range. - - - Return true if the typ is a representation of an F# tuple type - The type to check. - True if the type check succeeds. - - - Return true if the typ is a System.Type value corresponding to the compiled form of an F# module - The type to check. - True if the type check succeeds. - - - Return true if the typ is a representation of an F# function type or the runtime type of a closure implementing an F# function type - The type to check. - True if the type check succeeds. - - - Gets the tuple elements from the representation of an F# tuple type. - The input tuple type. - An array of the types contained in the given tuple type. - - - Gets the domain and range types from an F# function type or from the runtime type of a closure implementing an F# type - The input function type. - A tuple of the domain and range types of the input function. - - - Contains operations associated with constructing and analyzing F# types such as records, unions and tuples - - - Precomputes a function for reading the values of a particular tuple type - - Assumes the given type is a TupleType. - If not, ArgumentException is raised during pre-computation. - The tuple type to read. - Thrown when the given type is not a tuple type. - A function to read values of the given tuple type. - - - Gets information that indicates how to read a field of a tuple - The input tuple type. - The index of the tuple element to describe. - The description of the tuple element and an optional type and index if the tuple is big. - - - Gets a method that constructs objects of the given tuple type. - For small tuples, no additional type will be returned. - - For large tuples, an additional type is returned indicating that - a nested encoding has been used for the tuple type. In this case - the suffix portion of the tuple type has the given type and an - object of this type must be created and passed as the last argument - to the ConstructorInfo. A recursive call to PreComputeTupleConstructorInfo - can be used to determine the constructor for that the suffix type. - The input tuple type. - The description of the tuple type constructor and an optional extra type - for large tuples. - - - Precomputes a function for reading the values of a particular tuple type - - Assumes the given type is a TupleType. - If not, ArgumentException is raised during pre-computation. - The type of tuple to read. - Thrown when the given type is not a tuple type. - A function to read a particular tuple type. - - - Precompute a function for reading a particular field from a record. - Assumes the given type is a RecordType with a field of the given name. - If not, ArgumentException is raised during pre-computation. - - Using the computed function will typically be faster than executing a corresponding call to Value.GetInfo - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The PropertyInfo of the field to read. - Thrown when the input type is not a record type. - A function to read the specified field from the record. - - - Creates an instance of a tuple type - - Assumes at least one element is given. If not, ArgumentException is raised. - The array of tuple fields. - The tuple type to create. - Thrown if no elements are given. - An instance of the tuple type with the given elements. - - - Builds a typed function from object from a dynamic function implementation - The function type of the implementation. - The untyped lambda of the function implementation. - A typed function from the given dynamic implementation. - - - Reads all fields from a tuple. - - Assumes the given input is a tuple value. If not, ArgumentException is raised. - The input tuple. - Thrown when the input is not a tuple value. - An array of the fields from the given tuple. - - - Reads a field from a tuple value. - - Assumes the given input is a tuple value. If not, ArgumentException is raised. - The input tuple. - The index of the field to read. - The value of the field. - - - Reads a field from a record value. - - Assumes the given input is a record value. If not, ArgumentException is raised. - The record object. - The PropertyInfo describing the field to read. - Thrown when the input type is not a record type. - The field from the record. - - - Contains operations associated with constructing and analyzing values associated with F# types - such as records, unions and tuples. - - - The integer tag for the case. - - - The name of the case. - - - The type in which the case occurs. - - - The fields associated with the case, represented by a PropertyInfo. - The fields associated with the case. - - - Returns the custom attributes associated with the case matching the given attribute type. - The type of attributes to return. - An array of custom attributes. - - - Returns the custom attributes associated with the case. - An array of custom attributes. - - - Represents a case of a discriminated union type - - - Returns true if the typ is a representation of an F# exception declaration - The type to check. - Optional flag that denotes accessibility of the private representation. - True if the type check is an F# exception. - - - Reads all the fields from an F# exception declaration, in declaration order - - Assumes exceptionType is an exception representation type. If not, ArgumentException is raised. - The exception type to read. - Optional flag that denotes accessibility of the private representation. - Thrown if the given type is not an exception. - An array containing the PropertyInfo of each field in the exception. - - - Returns true if the typ is a representation of an F# union type or the runtime type of a value of that type - The type to check. - Optional flag that denotes accessibility of the private representation. - True if the type check succeeds. - - - Return true if the typ is a representation of an F# record type - The type to check. - Optional flag that denotes accessibility of the private representation. - True if the type check succeeds. - - - Gets the cases of a union type. - - Assumes the given type is a union type. If not, ArgumentException is raised during pre-computation. - The input union type. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a union type. - An array of descriptions of the cases of the given union type. - - - Reads all the fields from a record value, in declaration order - - Assumes the given input is a record value. If not, ArgumentException is raised. - The input record type. - Optional flag that denotes accessibility of the private representation. - An array of descriptions of the properties of the record type. - - - Reads all the fields from a value built using an instance of an F# exception declaration - - Assumes the given input is an F# exception value. If not, ArgumentException is raised. - The exception instance. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not an F# exception. - The fields from the given exception. - - - A method that constructs objects of the given case - The description of the union case. - Optional flag that denotes accessibility of the private representation. - The description of the constructor of the given union case. - - - Precomputes a function for constructing a discriminated union value for a particular union case. - The description of the union case. - Optional flag that denotes accessibility of the private representation. - A function for constructing values of the given union case. - - - Precomputes a function for reading all the fields for a particular discriminator case of a union type - - Using the computed function will typically be faster than executing a corresponding call to GetFields - The description of the union case to read. - Optional flag that denotes accessibility of the private representation. - A function to for reading the fields of the given union case. - - - Precompute a property or static method for reading an integer representing the case tag of a union type. - The type of union to read. - Optional flag that denotes accessibility of the private representation. - The description of the union case reader. - - - Assumes the given type is a union type. - If not, ArgumentException is raised during pre-computation. - - Using the computed function is more efficient than calling GetUnionCase - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The type of union to optimize reading. - Optional flag that denotes accessibility of the private representation. - An optimized function to read the tags of the given union type. - - - Identify the union case and its fields for an object - - Assumes the given input is a union case value. If not, ArgumentException is raised. - - If the type is not given, then the runtime type of the input object is used to identify the - relevant union type. The type should always be given if the input object may be null. For example, - option values may be represented using the 'null'. - The input union case. - The union type containing the value. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a union case value. - The description of the union case and its fields. - - - Create a union case value. - The description of the union case to create. - The array of arguments to construct the given case. - Optional flag that denotes accessibility of the private representation. - The constructed union case. - - - Get a ConstructorInfo for a record type - The record type. - Optional flag that denotes accessibility of the private representation. - A ConstructorInfo for the given record type. - - - Precompute a function for constructing a record value. - - Assumes the given type is a RecordType. - If not, ArgumentException is raised during pre-computation. - The type of record to construct. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - A function to construct records of the given type. - - - Precompute a function for reading all the fields from a record. The fields are returned in the - same order as the fields reported by a call to Microsoft.FSharp.Reflection.Type.GetInfo for - this type. - - Assumes the given type is a RecordType. - If not, ArgumentException is raised during pre-computation. - - Using the computed function will typically be faster than executing a corresponding call to Value.GetInfo - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The type of record to read. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - An optimized reader for the given record type. - - - Reads all the fields from a record value. - - Assumes the given input is a record value. If not, ArgumentException is raised. - The record object. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - The array of fields from the record. - - - Creates an instance of a record type. - - Assumes the given input is a record type. - The type of record to make. - The array of values to initialize the record. - Optional flags that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - The created record. - - - - A record of options to control structural formatting. - For F# Interactive properties matching those of this value can be accessed via the 'fsi' - value. - - Floating Point format given in the same format accepted by System.Double.ToString, - e.g. f6 or g15. - - If ShowProperties is set the printing process will evaluate properties of the values being - displayed. This may cause additional computation. - - The ShowIEnumerable is set the printing process will force the evalution of IEnumerable objects - to a small, finite depth, as determined by the printing parameters. - This may lead to additional computation being performed during printing. - - <example> - From F# Interactive the default settings can be adjusted using, for example, - <pre> - open Microsoft.FSharp.Compiler.Interactive.Settings;; - setPrintWidth 120;; - </pre> - </example> - - - - - Data representing structured layouts of terms. - - - - - Convert any value to a layout using the given formatting options. The - layout can then be processed using formatting display engines such as - those in the LayoutOps module. any_to_string and output_any are - built using any_to_layout with default format options. - - - - - Ouput any value to a channel using the same set of formatting rules - as any_to_string - - - - - Convert any value to a string using a standard formatter - Data is typically formatted in a structured format, e.g. - lists are formatted using the "[1;2]" notation. - The details of the format are not specified and may change - from version to version and according to the flags given - to the F# compiler. The format is intended to be human-readable, - not machine readable. If alternative generic formats are required - you should develop your own formatter, using the code in the - implementation of this file as a starting point. - - Data from other .NET languages is formatted using a virtual - call to Object.ToString() on the boxed version of the input. - - - - - For limitting layout of list-like sequences (lists,arrays,etc). - unfold a list of items using (project and z) making layout list via itemL. - If reach maxLength (before exhausting) then truncate. - - - - - See tagL - - - - - Layout like an F# list. - - - - - Layout like an F# option. - - - - - Layout list vertically. - - - - - Layout two vertically. - - - - - Form tuple of layouts. - - - - - Wrap braces around layout. - - - - - Wrap square brackets around layout. - - - - - Wrap round brackets around Layout. - - - - - Join layouts into a list separated using the given Layout. - - - - - Join layouts into a semi-colon separated list. - - - - - Join layouts into a space separated list. - - - - - Join layouts into a comma separated list. - - - - - Join broken with ident=2 - - - - - Join broken with ident=1 - - - - - Join broken with ident=0 - - - - - Join, possible break with indent=2 - - - - - Join, possible break with indent=1 - - - - - Join, possible break with indent=0 - - - - - Join, unbreakable. - - - - - An string which is left parenthesis (no space on the right). - - - - - An string which is right parenthesis (no space on the left). - - - - - An string which requires no spaces either side. - - - - - An string leaf - - - - - An uninterpreted leaf, to be interpreted into a string - by the layout engine. This allows leaf layouts for numbers, strings and - other atoms to be customized according to culture. - - - - - Is it the empty layout? - - - - - The empty layout - - - - - A layout is a sequence of strings which have been joined together. - The strings are classified as words, separators and left and right parenthesis. - This classification determines where spaces are inserted. - A joint is either unbreakable, breakable or broken. - If a joint is broken the RHS layout occurs on the next line with optional indentation. - A layout can be squashed to for given width which forces breaks as required. - - - - diff --git a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+sl5+netcore45/FSharp.Core.dll b/packages/FSharp.Core.4.0.0.1/lib/portable-net45+sl5+netcore45/FSharp.Core.dll deleted file mode 100644 index 1c14928..0000000 Binary files a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+sl5+netcore45/FSharp.Core.dll and /dev/null differ diff --git a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+sl5+netcore45/FSharp.Core.optdata b/packages/FSharp.Core.4.0.0.1/lib/portable-net45+sl5+netcore45/FSharp.Core.optdata deleted file mode 100644 index 79ace41..0000000 Binary files a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+sl5+netcore45/FSharp.Core.optdata and /dev/null differ diff --git a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+sl5+netcore45/FSharp.Core.sigdata b/packages/FSharp.Core.4.0.0.1/lib/portable-net45+sl5+netcore45/FSharp.Core.sigdata deleted file mode 100644 index 76f5428..0000000 Binary files a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+sl5+netcore45/FSharp.Core.sigdata and /dev/null differ diff --git a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+sl5+netcore45/FSharp.Core.xml b/packages/FSharp.Core.4.0.0.1/lib/portable-net45+sl5+netcore45/FSharp.Core.xml deleted file mode 100644 index 7197616..0000000 --- a/packages/FSharp.Core.4.0.0.1/lib/portable-net45+sl5+netcore45/FSharp.Core.xml +++ /dev/null @@ -1,10912 +0,0 @@ - - -FSharp.Core - - - Gets the tail of the list, which is a list containing all the elements of the list, excluding the first element - - - Gets the number of items contained in the list - - - Gets the element of the list at the given position. - Lists are represented as linked lists so this is an O(n) operation. - The index. - The value at the given index. - - - Gets a value indicating if the list contains no entries - - - Gets the first element of the list - - - Returns an empty list of a particular type - - - Gets a slice of the list, the elements of the list from the given start index to the given end index. - The start index. - The end index. - The sub list specified by the input indices. - - - Returns a list with head as its first element and tail as its subsequent elements - A new head value for the list. - The existing list. - The list with head appended to the front of tail. - - - The type of immutable singly-linked lists. - - Use the constructors [] and :: (infix) to create values of this type, or - the notation [1;2;3]. Use the values in the List module to manipulate - values of this type, or pattern match against the values directly. - - - Lookup an element in the map. Raise KeyNotFoundException if no binding - exists in the map. - The input key. - Thrown when the key is not found. - The value mapped to the key. - - - Returns true if there are no bindings in the map. - - - The number of bindings in the map. - - - Lookup an element in the map, returning a Some value if the element is in the domain - of the map and None if not. - The input key. - The mapped value, or None if the key is not in the map. - - - Removes an element from the domain of the map. No exception is raised if the element is not present. - The input key. - The resulting map. - - - Tests if an element is in the domain of the map. - The input key. - True if the map contains the given key. - - - Returns a new map with the binding added to the given map. - The input key. - The resulting map. - - - Builds a map that contains the bindings of the given IEnumerable. - The input sequence of key/value pairs. - The resulting map. - - - Immutable maps. Keys are ordered by F# generic comparison. - - Maps based on generic comparison are efficient for small keys. They are not a suitable choice if keys are recursive data structures - or if keys require bespoke comparison semantics. - - All members of this class are thread-safe and may be used concurrently from multiple threads. - - - An abbreviation for the CLI type System.Collections.Generic.List<_> - - - Returns a new set with the elements of the second set removed from the first. - The first input set. - The second input set. - A set containing elements of the first set that are not contained in the second set. - - - Compute the union of the two sets. - The first input set. - The second input set. - The union of the two input sets. - - - Returns the lowest element in the set according to the ordering being used for the set. - - - Returns the highest element in the set according to the ordering being used for the set. - - - A useful shortcut for Set.isEmpty. See the Set module for further operations on sets. - - - The number of elements in the set - - - A useful shortcut for Set.remove. Note this operation produces a new set - and does not mutate the original set. The new set will share many storage - nodes with the original. See the Set module for further operations on sets. - The value to remove from the set. - The result set. - - - Evaluates to "true" if all elements of the second set are in the first. - The set to test against. - True if this set is a superset of otherSet. - - - Evaluates to "true" if all elements of the first set are in the second. - The set to test against. - True if this set is a subset of otherSet. - - - Evaluates to "true" if all elements of the second set are in the first, and at least - one element of the first is not in the second. - The set to test against. - True if this set is a proper superset of otherSet. - - - Evaluates to "true" if all elements of the first set are in the second, and at least - one element of the second is not in the first. - The set to test against. - True if this set is a proper subset of otherSet. - - - A useful shortcut for Set.contains. See the Set module for further operations on sets. - The value to check. - True if the set contains value. - - - A useful shortcut for Set.add. Note this operation produces a new set - and does not mutate the original set. The new set will share many storage - nodes with the original. See the Set module for further operations on sets. - The value to add to the set. - The result set. - - - Create a set containing elements drawn from the given sequence. - The input sequence. - The result set. - - - Immutable sets based on binary trees, where comparison is the - F# structural comparison function, potentially using implementations - of the IComparable interface on key values. - - See the Set module for further operations on sets. - - All members of this class are thread-safe and may be used concurrently from multiple threads. - - - An abbreviation for the type of immutable singly-linked lists. - - Use the constructors [] and :: (infix) to create values of this type, or - the notation [1;2;3]. Use the values in the List module to manipulate - values of this type, or pattern match against the values directly. - - - An abbreviation for the CLI type System.Collections.Generic.IEnumerable<_> - - - Fetches an element from a 2D array. You can also use the syntax array.[index1,index2]. - - The input array. - The index along the first dimension. - The index along the second dimension. - - The value of the array at the given index. - Thrown when the indices are negative or exceed the bounds of the array. - - - Sets the value of an element in an array. You can also use the syntax array.[index1,index2] <- value. - - The input array. - The index along the first dimension. - The index along the second dimension. - The value to set in the array. - Thrown when the indices are negative or exceed the bounds of the array. - - - Builds a new array whose elements are the same as the input array but - where a non-zero-based input array generates a corresponding zero-based - output array. - - The input array. - - The zero-based output array. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer indices passed to the - function indicates the element being transformed. - - For non-zero-based arrays the basing on an input array will be propagated to the output - array. - - A function that is applied to transform each element of the array. The two integers - provide the index of the element. - The input array. - - An array whose elements have been transformed by the given mapping. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - - A function that is applied to transform each item of the input array. - The input array. - - An array whose elements have been transformed by the given mapping. - - - Returns the length of an array in the second dimension. - - The input array. - - The length of the array in the second dimension. - - - Returns the length of an array in the first dimension. - - The input array. - - The length of the array in the first dimension. - - - Applies the given function to each element of the array. The integer indices passed to the - function indicates the index of element. - - A function to apply to each element of the array with the indices available as an argument. - The input array. - - - Applies the given function to each element of the array. - - A function to apply to each element of the array. - The input array. - - - Creates an array where the entries are initially Unchecked.defaultof<'T>. - - The length of the first dimension of the array. - The length of the second dimension of the array. - - The created array. - Thrown when length1 or length2 is negative. - - - Creates an array whose elements are all initially the given value. - - The length of the first dimension of the array. - The length of the second dimension of the array. - The value to populate the new array. - - The created array. - Thrown when length1 or length2 is negative. - - - Creates an array given the dimensions and a generator function to compute the elements. - - The length of the first dimension of the array. - The length of the second dimension of the array. - A function to produce elements of the array given the two indices. - - The generated array. - Thrown when either of the lengths is negative. - - - Reads a range of elements from the first array and write them into the second. - - The source array. - The first-dimension index to begin copying from in the source array. - The second-dimension index to begin copying from in the source array. - The target array. - The first-dimension index to begin copying into in the target array. - The second-dimension index to begin copying into in the target array. - The number of elements to copy across the first dimension of the arrays. - The number of elements to copy across the second dimension of the arrays. - Thrown when any of the indices are negative or if either of - the counts are larger than the dimensions of the array allow. - - - Builds a new array whose elements are the same as the input array. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - - The input array. - - A copy of the input array. - - - Fetches the base-index for the second dimension of the array. - - The input array. - - The base-index of the second dimension of the array. - - - Fetches the base-index for the first dimension of the array. - - The input array. - - The base-index of the first dimension of the array. - - - Basic operations on 2-dimensional arrays. - - F# and CLI multi-dimensional arrays are typically zero-based. - However, CLI multi-dimensional arrays used in conjunction with external - libraries (e.g. libraries associated with Visual Basic) be - non-zero based, using a potentially different base for each dimension. - The operations in this module will accept such arrays, and - the basing on an input array will be propagated to a matching output - array on the Array2D.map and Array2D.mapi operations. - Non-zero-based arrays can also be created using Array2D.zeroCreateBased, - Array2D.createBased and Array2D.initBased. - - - Creates an array where the entries are initially the "default" value. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The created array. - - - Sets the value of an element in an array. You can also - use the syntax 'array.[index1,index2,index3] <- value'. - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The value to set at the given index. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer indices passed to the - function indicates the element being transformed. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - The function to transform the elements at each index in the array. - The input array. - The array created from the transformed elements. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. - - For non-zero-based arrays the basing on an input array will be propogated to the output - array. - The function to transform each element of the array. - The input array. - The array created from the transformed elements. - - - Returns the length of an array in the third dimension. - The input array. - The length of the array in the third dimension. - - - Returns the length of an array in the second dimension. - The input array. - The length of the array in the second dimension. - - - Returns the length of an array in the first dimension - The input array. - The length of the array in the first dimension. - - - Applies the given function to each element of the array. The integer indicies passed to the - function indicates the index of element. - The function to apply to each element of the array. - The input array. - - - Applies the given function to each element of the array. - The function to apply to each element of the array. - The input array. - - - Fetches an element from a 3D array. You can also use the syntax 'array.[index1,index2,index3]' - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The value at the given index. - - - Creates an array given the dimensions and a generator function to compute the elements. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The function to create an initial value at each index into the array. - The created array. - - - Creates an array whose elements are all initially the given value. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The value of the array elements. - The created array. - - - Basic operations on rank 3 arrays. - - - Sets the value of an element in an array. You can also - use the syntax 'array.[index1,index2,index3,index4] <- value'. - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The index along the fourth dimension. - The value to set. - - - Fetches an element from a 4D array. You can also use the syntax 'array.[index1,index2,index3,index4]' - The input array. - The index along the first dimension. - The index along the second dimension. - The index along the third dimension. - The index along the fourth dimension. - The value at the given index. - - - Creates an array where the entries are initially the "default" value. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The length of the fourth dimension. - The created array. - - - Returns the length of an array in the fourth dimension. - The input array. - The length of the array in the fourth dimension. - - - Returns the length of an array in the third dimension. - The input array. - The length of the array in the third dimension. - - - Returns the length of an array in the second dimension. - The input array. - The length of the array in the second dimension. - - - Returns the length of an array in the first dimension - The input array. - The length of the array in the first dimension. - - - Creates an array given the dimensions and a generator function to compute the elements. - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The length of the fourth dimension. - The function to create an initial value at each index in the array. - The created array. - - - Creates an array whose elements are all initially the given value - The length of the first dimension. - The length of the second dimension. - The length of the third dimension. - The length of the fourth dimension. - The initial value for each element of the array. - The created array. - - - Basic operations on rank 4 arrays. - - - Combines three arrays into an array of pairs. The three arrays must have equal lengths, otherwise an ArgumentException is - raised. - The first input array. - The second input array. - The third input array. - Thrown when any of the input arrays are null. - Thrown when the input arrays differ in length. - The array of tupled elements. - - - Combines the two arrays into an array of pairs. The two arrays must have equal lengths, otherwise an ArgumentException is - raised. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The array of tupled elements. - - - Returns an array of sliding windows containing elements drawn from the input - array. Each window is returned as a fresh array. - The number of elements in each window. - The input array. - The result array. - Thrown when the input array is null. - Thrown when windowSize is not positive. - - - Returns a new array containing only the elements of the array - for which the given predicate returns "true". - The function to test the input elements. - The input array. - An array containing the elements for which the given predicate returns true. - - Thrown when the input array is null. - - - Splits an array of triples into three arrays. - The input array. - The tuple of three arrays. - Thrown when the input array is null. - - - Splits an array of pairs into two arrays. - The input array. - The two arrays. - Thrown when the input array is null. - - - Returns an array that contains the elements generated by the given computation. - The given initial state argument is passed to the element generator. - A function that takes in the current state and returns an option tuple of the next - element of the array and the next state value. - The initial state value. - The result array. - - - Returns the index of the last element in the array - that satisfies the given predicate. - The function to test the input elements. - The input array. - Thrown when the input array is null. - The index of the last element that satisfies the predicate, or None. - - - Tries to find the nth element in the array. - Returns None if index is negative or the input array does not contain enough elements. - The index of element to retrieve. - The input array. - The nth element of the array or None. - Thrown when the input array is null. - - - Returns the index of the first element in the array - that satisfies the given predicate. - The function to test the input elements. - The input array. - Thrown when the input array is null. - The index of the first element that satisfies the predicate, or None. - - - Returns the last element for which the given function returns true. - Return None if no such element exists. - The function to test the input elements. - The input array. - Thrown when the input array is null. - The last element that satisfies the predicate, or None. - - - Returns the first element for which the given function returns true. - Return None if no such element exists. - The function to test the input elements. - The input array. - The first element that satisfies the predicate, or None. - Thrown when the input array is null. - - - Returns at most N elements in a new array. - The maximum number of items to return. - The input array. - The result array. - Thrown when the input array is null. - - - Views the given array as a sequence. - The input array. - The sequence of array elements. - Thrown when the input array is null. - - - Builds a list from the given array. - The input array. - The list of array elements. - Thrown when the input array is null. - - - Returns a new array containing the elements of the original except the first element. - - The input array. - Thrown when the array is empty. - Thrown when the input array is null. - A new array containing the elements of the original except the first element. - - - Returns an array that contains all elements of the original array while the - given predicate returns true, and then returns no further elements. - - A function that evaluates to false when no more items should be returned. - The input array. - - The result array. - - Thrown when the input array is null. - - - Returns the first N elements of the array. - Throws InvalidOperationException - if the count exceeds the number of elements in the array. Array.truncate - returns as many items as the array contains instead of throwing an exception. - - The number of items to take. - The input array. - - The result array. - - Thrown when the input array is null. - Thrown when the input array is empty. - Thrown when count exceeds the number of elements - in the list. - - - Returns the sum of the results generated by applying the function to each element of the array. - The function to transform the array elements into the type to be summed. - The input array. - The resulting sum. - Thrown when the input array is null. - - - Returns the sum of the elements in the array. - The input array. - The resulting sum. - Thrown when the input array is null. - - - Sorts the elements of an array, in descending order, using the given projection for the keys and returning a new array. - Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to transform array elements into the type that is compared. - The input array. - The sorted array. - - - Sorts the elements of an array, in descending order, returning a new array. Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The input array. - The sorted array. - - - Splits an array into two arrays, at the given index. - The index at which the array is split. - The input array. - The two split arrays. - - Thrown when the input array is null. - Thrown when split index exceeds the number of elements - in the array. - - - Sorts the elements of an array by mutating the array in-place, using the given comparison function. - Elements are compared using Operators.compare. - The input array. - Thrown when the input array is null. - - - Sorts the elements of an array by mutating the array in-place, using the given comparison function as the order. - The function to compare pairs of array elements. - The input array. - Thrown when the input array is null. - - - Sorts the elements of an array by mutating the array in-place, using the given projection for the keys. - Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to transform array elements into the type that is compared. - The input array. - Thrown when the input array is null. - - - Sorts the elements of an array, using the given comparison function as the order, returning a new array. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to compare pairs of array elements. - The input array. - The sorted array. - Thrown when the input array is null. - - - Sorts the elements of an array, using the given projection for the keys and returning a new array. - Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The function to transform array elements into the type that is compared. - The input array. - The sorted array. - Thrown when the input array is null. - - - Sorts the elements of an array, returning a new array. Elements are compared using Operators.compare. - - This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. - For a stable sort, consider using Seq.sort. - The input array. - The sorted array. - Thrown when the input array is null. - - - Builds a new array that contains the given subrange specified by - starting index and length. - The input array. - The index of the first element of the sub array. - The length of the sub array. - The created sub array. - Thrown when the input array is null. - Thrown when either startIndex or count is negative, - or when there aren't enough elements in the input array. - - - Bypasses elements in an array while the given predicate returns true, and then returns - the remaining elements in a new array. - A function that evaluates an element of the array to a boolean value. - The input array. - The created sub array. - Thrown when the input array is null. - - - Builds a new array that contains the elements of the given array, excluding the first N elements. - The number of elements to skip. - The input array. - A copy of the input array, after removing the first N elements. - Thrown when the input array is null. - Thrown when count is negative or exceeds the number of - elements in the array. - - - Sets an element of an array. - The input array. - The input index. - The input value. - Thrown when the input array is null. - Thrown when the index is negative or the input array does not contain enough elements. - - - Returns an array that contains one item only. - - The input item. - - The result array of one item. - - - Like foldBack, but return both the intermediary and final results. - The function to update the state given the input elements. - The input array. - The initial state. - The array of state values. - Thrown when the input array is null. - - - Like fold, but return the intermediary and final results. - The function to update the state given the input elements. - The initial state. - The input array. - The array of state values. - Thrown when the input array is null. - - - Returns a new array with the elements in reverse order. - The input array. - The reversed array. - Thrown when the input array is null. - - - Creates an array by replicating the given initial value. - The number of elements to replicate. - The value to replicate - The generated array. - Thrown when count is negative. - - - Applies a function to each element of the array, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f i0 (...(f iN-1 iN)). - A function that takes in the next-to-last element of the list and the - current accumulated result to produce the next accumulated result. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The final result of the reductions. - - - Applies a function to each element of the array, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f (... (f i0 i1)...) iN. - Raises ArgumentException if the array has size zero. - The function to reduce a pair of elements to a single element. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The final result of the redcutions. - - - Returns an array with all elements permuted according to the - specified permutation. - The function that maps input indices to output indices. - The input array. - The output array. - Thrown when the input array is null. - Thrown when indexMap does not produce a valid permutation. - - - Splits the collection into two collections, containing the - elements for which the given predicate returns "true" and "false" - respectively. - The function to test the input elements. - The input array. - A pair of arrays. The first containing the elements the predicate evaluated to true, - and the second containing those evaluated to false. - Thrown when the input array is null. - - - Returns an array of each element in the input array and its predecessor, with the - exception of the first element which is only returned as the predecessor of the second element. - - The input array. - - The result array. - - Thrown when the input sequence is null. - - - Builds a new array from the given enumerable object. - The input sequence. - The array of elements from the sequence. - Thrown when the input sequence is null. - - - Builds an array from the given list. - The input list. - The array of elements from the list. - - - Returns the lowest of all elements of the array, compared via Operators.min on the function result. - - Throws ArgumentException for empty arrays. - The function to transform the elements into a type supporting comparison. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The minimum element. - - - Returns the lowest of all elements of the array, compared via Operators.min. - - Throws ArgumentException for empty arrays - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The minimum element. - - - Returns the greatest of all elements of the array, compared via Operators.max on the function result. - - Throws ArgumentException for empty arrays. - The function to transform the elements into a type supporting comparison. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The maximum element. - - - Returns the greatest of all elements of the array, compared via Operators.max on the function result. - - Throws ArgumentException for empty arrays. - The input array. - Thrown when the input array is null. - Thrown when the input array is empty. - The maximum element. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. The integer index passed to the - function indicates the index of element being transformed. - The function to transform elements and their indices. - The input array. - The array of transformed elements. - Thrown when the input array is null. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the two collections pairwise, also passing the index of - the elements. The two input arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to transform pairs of input elements and their indices. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The array of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding triples from the three collections. The three input - arrays must have the same length, otherwise an ArgumentException is - raised. - The function to transform the pairs of the input elements. - The first input array. - The second input array. - The third input array. - Thrown when the input arrays differ in length. - Thrown when any of the input arrays is null. - The array of transformed elements. - - - Combines map and foldBack. Builds a new array whose elements are the results of applying the given function - to each of the elements of the input array. The function is also used to accumulate a final value. - The function to transform elements from the input array and accumulate the final value. - The input array. - The initial state. - Thrown when the input array is null. - The array of transformed elements, and the final accumulated value. - - - Combines map and fold. Builds a new array whose elements are the results of applying the given function - to each of the elements of the input array. The function is also used to accumulate a final value. - The function to transform elements from the input array and accumulate the final value. - The initial state. - The input array. - Thrown when the input array is null. - The array of transformed elements, and the final accumulated value. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the two collections pairwise. The two input - arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to transform the pairs of the input elements. - The first input array. - The second input array. - Thrown when the input arrays differ in length. - Thrown when either of the input arrays is null. - The array of transformed elements. - - - Builds a new array whose elements are the results of applying the given function - to each of the elements of the array. - The function to transform elements of the array. - The input array. - The array of transformed elements. - Thrown when the input array is null. - - - Returns the last element of the array. - Return None if no such element exists. - The input array. - The last element of the array or None. - Thrown when the input sequence is null. - - - Returns the length of an array. You can also use property arr.Length. - The input array. - The length of the array. - Thrown when the input array is null. - - - Gets an element from an array. - The input index. - The input array. - The value of the array at the given index. - Thrown when the input array is null. - Thrown when the index is negative or the input array does not contain enough elements. - - - Returns the last element of the array. - The input array. - The last element of the array. - Thrown when the input array is null. - Thrown when the input does not have any elements. - - - Applies the given function to pair of elements drawn from matching indices in two arrays, - also passing the index of the elements. The two arrays must have the same lengths, - otherwise an ArgumentException is raised. - The function to apply to each index and pair of elements. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - - - Applies the given function to each element of the array. The integer passed to the - function indicates the index of element. - The function to apply to each index and element. - The input array. - Thrown when the input array is null. - - - Applies the given function to pair of elements drawn from matching indices in two arrays. The - two arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to apply. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - - - Applies the given function to each element of the array. - The function to apply. - The input array. - Thrown when the input array is null. - - - Returns true if the given array is empty, otherwise false. - The input array. - True if the array is empty. - Thrown when the input array is null. - - - Creates an array where the entries are initially the default value Unchecked.defaultof<'T>. - The length of the array to create. - The created array. - Thrown when count is negative. - - - Creates an array given the dimension and a generator function to compute the elements. - The number of elements to initialize. - The function to generate the initial values for each index. - The created array. - Thrown when count is negative. - - - Builds a new array whose elements are the corresponding elements of the input array - paired with the integer index (from 0) of each element. - The input array. - The array of indexed elements. - Thrown when the input array is null. - - - Applies a key-generating function to each element of an array and yields an array of - unique keys. Each unique key contains an array of all elements that match - to this key. - - A function that transforms an element of the array into a comparable key. - The input array. - - The result array. - - Thrown when the input array is null. - - - Returns the first element of the array. - - The input array. - - The first element of the array. - - Thrown when the input array is null. - Thrown when the input array is empty. - - - Gets an element from an array. - The input array. - The input index. - The value of the array at the given index. - Thrown when the input array is null. - Thrown when the index is negative or the input array does not contain enough elements. - - - Apply a function to pairs of elements drawn from the two collections, right-to-left, - threading an accumulator argument through the computation. The two input - arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to update the state given the input elements. - The first input array. - The second input array. - The initial state. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The final state. - - - Applies a function to pairs of elements drawn from the two collections, - left-to-right, threading an accumulator argument - through the computation. The two input - arrays must have the same lengths, otherwise an ArgumentException is - raised. - The function to update the state given the input elements. - The initial state. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - The final state. - - - Applies a function to each element of the array, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then computes - f i0 (...(f iN s)) - The function to update the state given the input elements. - The input array. - The initial state. - The state object after the folding function is applied to each element of the array. - Thrown when the input array is null. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then computes - f (... (f s i0)...) iN - The function to update the state given the input elements. - The initial state. - The input array. - The final state. - Thrown when the input array is null. - - - Tests if all corresponding elements of the array satisfy the given predicate pairwise. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns false then the overall result is - false and no further elements are tested. Otherwise, if one collection is longer - than the other then the ArgumentException exception is raised. - Otherwise, true is returned. - The function to test the input elements. - The first input array. - The second input array. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - True if all of the array elements satisfy the predicate. - - - Tests if all elements of the array satisfy the given predicate. - - The predicate is applied to the elements of the input collection. If any application - returns false then the overall result is false and no further elements are tested. - Otherwise, true is returned. - The function to test the input elements. - The input array. - True if all of the array elements satisfy the predicate. - Thrown when the input array is null. - - - Returns the index of the last element in the array - that satisfies the given predicate. Raise KeyNotFoundException if - none of the elements satisfy the predicate. - The function to test the input elements. - The input array. - Thrown if predicate - never returns true. - Thrown when the input array is null. - The index of the last element in the array that satisfies the given predicate. - - - Returns the index of the first element in the array - that satisfies the given predicate. Raise KeyNotFoundException if - none of the elements satisfy the predicate. - The function to test the input elements. - The input array. - Thrown if predicate - never returns true. - Thrown when the input array is null. - The index of the first element in the array that satisfies the given predicate. - - - Returns the last element for which the given function returns 'true'. - Raise KeyNotFoundException if no such element exists. - The function to test the input elements. - The input array. - Thrown if predicate - never returns true. - Thrown when the input array is null. - The last element for which predicate returns true. - - - Returns the first element for which the given function returns 'true'. - Raise KeyNotFoundException if no such element exists. - The function to test the input elements. - The input array. - Thrown when the input array is null. - Thrown if predicate - never returns true. - The first element for which predicate returns true. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true". - The function to test the input elements. - The input array. - An array containing the elements for which the given predicate returns true. - Thrown when the input array is null. - - - Tests if any pair of corresponding elements of the arrays satisfies the given predicate. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns true then the overall result is - true and no further elements are tested. Otherwise, if one collections is longer - than the other then the ArgumentException exception is raised. - Otherwise, false is returned. - The function to test the input elements. - The first input array. - The second input array. - True if any result from predicate is true. - Thrown when either of the input arrays is null. - Thrown when the input arrays differ in length. - - - Tests if any element of the array satisfies the given predicate. - - The predicate is applied to the elements of the input array. If any application - returns true then the overall result is true and no further elements are tested. - Otherwise, false is returned. - The function to test the input elements. - The input array. - True if any result from predicate is true. - Thrown when the input array is null. - - - Returns a new list with the distinct elements of the input array which do not appear in the itemsToExclude sequence, - using generic hash and equality comparisons to compare values. - - A sequence whose elements that also occur in the input array will cause those elements to be - removed from the result. - An array whose elements that are not also in itemsToExclude will be returned. - - An array that contains the distinct elements of array that do not appear in itemsToExclude. - - Thrown when either itemsToExclude or array is null. - - - Returns the only element of the array. - - The input array. - - The only element of the array. - - Thrown when the input array is null. - Thrown when the input does not have precisely one element. - - - Returns an empty array of the given type. - The empty array. - - - Splits the input array into at most count chunks. - The maximum number of chunks. - The input array. - The array split into chunks. - Thrown when the input array is null. - Thrown when count is not positive. - - - Returns an array that contains no duplicate entries according to the - generic hash and equality comparisons on the keys returned by the given key-generating function. - If an element occurs multiple times in the array then the later occurrences are discarded. - - A function transforming the array items into comparable keys. - The input array. - - The result array. - - Thrown when the input array is null. - - - Returns an array that contains no duplicate entries according to generic hash and - equality comparisons on the entries. - If an element occurs multiple times in the array then the later occurrences are discarded. - - The input array. - - The result array. - - Thrown when the input array is null. - - - Divides the input array into chunks of size at most chunkSize. - The maximum size of each chunk. - The input array. - The array divided into chunks. - Thrown when the input array is null. - Thrown when chunkSize is not positive. - - - Applies the given function to each element of the array. Returns - the array comprised of the results "x" for each element where - the function returns Some(x) - The function to generate options from the elements. - The input array. - The array of results. - Thrown when the input array is null. - - - Applies the given function to successive elements, returning the first - result where function returns Some(x) for some x. If the function - never returns Some(x) then KeyNotFoundException is raised. - The function to generate options from the elements. - The input array. - Thrown when the input array is null. - Thrown if every result from - chooser is None. - The first result. - - - Fills a range of elements of the array with the given value. - The target array. - The index of the first element to set. - The number of elements to set. - The value to set. - Thrown when the input array is null. - Thrown when either targetIndex or count is negative. - - - Applies the given function to successive elements, returning the first - result where function returns Some(x) for some x. If the function - never returns Some(x) then None is returned. - The function to transform the array elements into options. - The input array. - The first transformed element that is Some(x). - Thrown when the input array is null. - - - Returns the first element of the array, or - None if the array is empty. - The input array. - Thrown when the input array is null. - The first element of the array or None. - - - Creates an array whose elements are all initially the given value. - The length of the array to create. - The value for the elements. - The created array. - Thrown when count is negative. - - - Applies a key-generating function to each element of an array and returns an array yielding unique - keys and their number of occurrences in the original array. - - A function transforming each item of the input array into a key to be - compared against the others. - The input array. - - The result array. - - Thrown when the input array is null. - - - Builds a new array that contains the elements of the given array. - The input array. - A copy of the input array. - Thrown when the input array is null. - - - Tests if the array contains the specified element. - The value to locate in the input array. - The input array. - True if the input array contains the specified element; false otherwise. - Thrown when the input array is null. - - - Builds a new array that contains the elements of each of the given sequence of arrays. - The input sequence of arrays. - The concatenation of the sequence of input arrays. - Thrown when the input sequence is null. - - - Compares two arrays using the given comparison function, element by element. - Returns the first non-zero result from the comparison function. If the end of an array - is reached it returns a -1 if the first array is shorter and a 1 if the second array - is shorter. - - A function that takes an element from each array and returns an int. - If it evaluates to a non-zero value iteration is stopped and that value is returned. - The first input array. - The second input array. - - The first non-zero value from the comparison function. - - Thrown when either of the input arrays - is null. - - - For each element of the array, applies the given function. Concatenates all the results and return the combined array. - The function to create sub-arrays from the input array elements. - The input array. - The concatenation of the sub-arrays. - Thrown when the input array is null. - - - Reads a range of elements from the first array and write them into the second. - The source array. - The starting index of the source array. - The target array. - The starting index of the target array. - The number of elements to copy. - Thrown when either of the input arrays is null. - Thrown when any of sourceIndex, targetIndex or count are negative, - or when there aren't enough elements in source or target. - - - Returns the average of the elements generated by applying the function to each element of the array. - The function to transform the array elements before averaging. - The input array. - Thrown when array is empty. - The computed average. - Thrown when the input array is null. - - - Returns the average of the elements in the array. - The input array. - Thrown when array is empty. - The average of the elements in the array. - Thrown when the input array is null. - - - Builds a new array that contains the elements of the first array followed by the elements of the second array. - The first input array. - The second input array. - The resulting array. - Thrown when either of the input arrays is null. - - - Basic operations on arrays. - - - Compare using the given comparer function. - A function to compare two values. - An object implementing IComparer using the supplied comparer. - - - Non-structural comparison. Compare using NonStructuralComparison.compare. - - - Structural comparison. Compare using Operators.compare. - - - Common notions of comparison identity used with sorted data structures. - - - Hash using the given hashing and equality functions. - A function to generate a hash code from a value. - A function to test equality of two values. - An object implementing IEqualityComparer using the supplied functions. - - - Physical hashing (hash on reference identity of objects, and the contents of value types). - Hash using LanguagePrimitives.PhysicalEquality and LanguagePrimitives.PhysicalHash, - That is, for value types use GetHashCode and Object.Equals (if no other optimization available), - and for reference types use System.Runtime.CompilerServices.RuntimeHelpers.GetHashCode and - reference equality. - - - Non-structural hashing. Equality using NonStructuralComparison.(=) and NonStructuralComparison.hash. - - - Structural hashing. Hash using Operators.(=) and Operators.hash. - - - Common notions of value identity used with hash tables. - - - Combines the three lists into a list of triples. The lists must have equal lengths. - The first input list. - The second input list. - The third input list. - A single list containing triples of matching elements from the input lists. - - - Combines the two lists into a list of pairs. The two lists must have equal lengths. - The first input list. - The second input list. - A single list containing pairs of matching elements from the input lists. - - - Returns a list of sliding windows containing elements drawn from the input - list. Each window is returned as a fresh list. - The number of elements in each window. - The input list. - The result list. - Thrown when windowSize is not positive. - - - Returns a new list containing only the elements of the list - for which the given predicate returns "true" - The function to test the input elements. - The input list. - A list containing only the elements that satisfy the predicate. - - - Splits a list of triples into three lists. - The input list. - Three lists of split elements. - - - Splits a list of pairs into two lists. - The input list. - Two lists of split elements. - - - Returns a list that contains the elements generated by the given computation. - The given initial state argument is passed to the element generator. - A function that takes in the current state and returns an option tuple of the next - element of the list and the next state value. - The initial state value. - The result list. - - - Returns the index of the last element in the list - that satisfies the given predicate. - Return None if no such element exists. - The function to test the input elements. - The input list. - The index of the last element for which the predicate returns true, or None if - every element evaluates to false. - - - Tries to find the nth element in the list. - Returns None if index is negative or the list does not contain enough elements. - The index to retrieve. - The input list. - The value at the given index or None. - - - Returns the index of the first element in the list - that satisfies the given predicate. - Return None if no such element exists. - The function to test the input elements. - The input list. - The index of the first element for which the predicate returns true, or None if - every element evaluates to false. - - - Returns the last element for which the given function returns true.. - Return None if no such element exists. - The function to test the input elements. - The input list. - The last element for which the predicate returns true, or None if - every element evaluates to false. - - - Returns the first element for which the given function returns true.. - Return None if no such element exists. - The function to test the input elements. - The input list. - The first element for which the predicate returns true, or None if - every element evaluates to false. - - - Applies the given function to successive elements, returning Some(x) the first - result where function returns Some(x) for some x. If no such element - exists then return None. - The function to generate options from the elements. - The input list. - The first resulting value or None. - - - Returns at most N elements in a new list. - The maximum number of items to return. - The input list. - The result list. - - - Returns the first element of the list, or - None if the list is empty. - The input list. - The first element of the list or None. - - - Views the given list as a sequence. - The input list. - The sequence of elements in the list. - - - Builds an array from the given list. - The input list. - The array containing the elements of the list. - - - Returns a list that contains all elements of the original list while the - given predicate returns true, and then returns no further elements. - - A function that evaluates to false when no more items should be returned. - The input list. - - The result list. - - - Returns the first N elements of the list. - Throws InvalidOperationException - if the count exceeds the number of elements in the list. List.truncate - returns as many items as the list contains instead of throwing an exception. - - The number of items to take. - The input list. - - The result list. - - Thrown when the input list is empty. - Thrown when count exceeds the number of elements - in the list. - - - Returns the list after removing the first element. - - The input list. - Thrown when the list is empty. - The list after removing the first element. - - - Returns the sum of the results generated by applying the function to each element of the list. - The function to transform the list elements into the type to be summed. - The input list. - The resulting sum. - - - Returns the sum of the elements in the list. - The input list. - The resulting sum. - - - Sorts the given list in descending order using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The input list. - The sorted list. - - - Sorts the given list in descending order using keys given by the given projection. Keys are compared using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The function to transform the list elements into the type to be compared. - The input list. - The sorted list. - - - Splits a list into two lists, at the given index. - The index at which the list is split. - The input list. - The two split lists. - - Thrown when split index exceeds the number of elements - in the list. - - - Sorts the given list using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The input list. - The sorted list. - - - Sorts the given list using keys given by the given projection. Keys are compared using Operators.compare. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The function to transform the list elements into the type to be compared. - The input list. - The sorted list. - - - Sorts the given list using the given comparison function. - - This is a stable sort, i.e. the original order of equal elements is preserved. - The function to compare the list elements. - The input list. - The sorted list. - - - Bypasses elements in a list while the given predicate returns true, and then returns - the remaining elements of the list. - A function that evaluates an element of the list to a boolean value. - The input list. - The result list. - - - Returns the list after removing the first N elements. - The number of elements to skip. - The input list. - The list after removing the first N elements. - Thrown when count is negative or exceeds the number of - elements in the list. - - - Returns a list that contains one item only. - - The input item. - - The result list of one item. - - - Like foldBack, but returns both the intermediary and final results - The function to update the state given the input elements. - The input list. - The initial state. - The list of states. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. Take the second argument, and apply the function to it - and the first element of the list. Then feed this result into the function along - with the second element and so on. Returns the list of intermediate results and the final result. - The function to update the state given the input elements. - The initial state. - The input list. - The list of states. - - - Returns a new list with the elements in reverse order. - The input list. - The reversed list. - - - Creates a list by replicating the given initial value. - The number of elements to replicate. - The value to replicate - The generated list. - - - Applies a function to each element of the collection, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then computes - f i0 (...(f iN-1 iN)). - A function that takes in the next-to-last element of the list and the - current accumulated result to produce the next accumulated result. - The input list. - Thrown when the list is empty. - The final result of the reductions. - - - Apply a function to each element of the collection, threading an accumulator argument - through the computation. Apply the function to the first two elements of the list. - Then feed this result into the function along with the third element and so on. - Return the final result. If the input function is f and the elements are i0...iN then computes - f (... (f i0 i1) i2 ...) iN. - - Raises System.ArgumentException if list is empty - The function to reduce two list elements to a single element. - The input list. - Thrown when the list is empty. - The final reduced value. - - - Returns a list with all elements permuted according to the - specified permutation. - The function to map input indices to output indices. - The input list. - The permuted list. - Thrown when indexMap does not produce a valid permutation. - - - Applies the given function to successive elements, returning the first - result where function returns Some(x) for some x. If no such - element exists then raise System.Collections.Generic.KeyNotFoundException - The function to generate options from the elements. - The input list. - Thrown when the list is empty. - The first resulting value. - - - Splits the collection into two collections, containing the - elements for which the given predicate returns true and false - respectively. Element order is preserved in both of the created lists. - The function to test the input elements. - The input list. - A list containing the elements for which the predicate evaluated to false and a list - containing the elements for which the predicate evaluated to true. - - - Returns a list of each element in the input list and its predecessor, with the - exception of the first element which is only returned as the predecessor of the second element. - - The input list. - - The result list. - - - Builds a new list from the given enumerable object. - The input sequence. - The list of elements from the sequence. - - - Builds a list from the given array. - The input array. - The list of elements from the array. - - - Indexes into the list. The first element has index 0. - The input list. - The index to retrieve. - The value at the given index. - Thrown when the index is negative or the input list does not contain enough elements. - - - Returns the lowest of all elements of the list, compared via Operators.min on the function result - - Raises System.ArgumentException if list is empty. - The function to transform list elements into the type to be compared. - The input list. - Thrown when the list is empty. - The minimum value. - - - Returns the lowest of all elements of the list, compared via Operators.min. - - Raises System.ArgumentException if list is empty - The input list. - Thrown when the list is empty. - The minimum value. - - - Returns the greatest of all elements of the list, compared via Operators.max on the function result. - - Raises System.ArgumentException if list is empty. - The function to transform the list elements into the type to be compared. - The input list. - Thrown when the list is empty. - The maximum element. - - - Return the greatest of all elements of the list, compared via Operators.max. - - Raises System.ArgumentException if list is empty - The input list. - Thrown when the list is empty. - The maximum element. - - - Like mapi, but mapping corresponding elements from two lists of equal length. - The function to transform pairs of elements from the two lists and their index. - The first input list. - The second input list. - The list of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The integer index passed to the - function indicates the index (from 0) of element being transformed. - The function to transform elements and their indices. - The input list. - The list of transformed elements. - - - Combines map and foldBack. Builds a new list whose elements are the results of applying the given function - to each of the elements of the input list. The function is also used to accumulate a final value. - The function to transform elements from the input list and accumulate the final value. - The input list. - The initial state. - The list of transformed elements, and the final accumulated value. - - - Combines map and fold. Builds a new list whose elements are the results of applying the given function - to each of the elements of the input list. The function is also used to accumulate a final value. - The function to transform elements from the input list and accumulate the final value. - The initial state. - The input list. - The list of transformed elements, and the final accumulated value. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the three collections simultaneously. - The function to transform triples of elements from the input lists. - The first input list. - The second input list. - The third input list. - The list of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding elements of the two collections pairwise. - The function to transform pairs of elements from the input lists. - The first input list. - The second input list. - The list of transformed elements. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. - The function to transform elements from the input list. - The input list. - The list of transformed elements. - - - Returns the last element of the list. - Return None if no such element exists. - The input list. - The last element of the list or None. - - - Returns the length of the list. - The input list. - The length of the list. - - - Returns the last element of the list. - The input list. - The last element of the list. - Thrown when the input does not have any elements. - - - Applies the given function to two collections simultaneously. The - collections must have identical size. The integer passed to the - function indicates the index of element. - The function to apply to a pair of elements from the input lists along with their index. - The first input list. - The second input list. - - - Applies the given function to each element of the collection. The integer passed to the - function indicates the index of element. - The function to apply to the elements of the list along with their index. - The input list. - - - Applies the given function to two collections simultaneously. The - collections must have identical size. - The function to apply to pairs of elements from the input lists. - The first input list. - The second input list. - - - Applies the given function to each element of the collection. - The function to apply to elements from the input list. - The input list. - - - Indexes into the list. The first element has index 0. - The index to retrieve. - The input list. - The value at the given index. - Thrown when the index is negative or the input list does not contain enough elements. - - - Returns true if the list contains no elements, false otherwise. - The input list. - True if the list is empty. - - - Creates a list by calling the given generator on each index. - The length of the list to generate. - The function to generate an element from an index. - The list of generated elements. - - - Returns a new list whose elements are the corresponding elements - of the input list paired with the index (from 0) of each element. - The input list. - The list of indexed elements. - - - Returns the first element of the list. - - The input list. - Thrown when the list is empty. - The first element of the list. - - - Applies a key-generating function to each element of a list and yields a list of - unique keys. Each unique key contains a list of all elements that match - to this key. - - A function that transforms an element of the list into a comparable key. - The input list. - - The result list. - - - Tests if all corresponding elements of the collection satisfy the given predicate pairwise. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns false then the overall result is - false and no further elements are tested. Otherwise, if one collection is longer - than the other then the System.ArgumentException exception is raised. - Otherwise, true is returned. - The function to test the input elements. - The first input list. - The second input list. - Thrown when the input lists differ in length. - True if all of the pairs of elements satisfy the predicate. - - - Tests if all elements of the collection satisfy the given predicate. - - The predicate is applied to the elements of the input list. If any application - returns false then the overall result is false and no further elements are tested. - Otherwise, true is returned. - The function to test the input elements. - The input list. - True if all of the elements satisfy the predicate. - - - Applies a function to corresponding elements of two collections, threading an accumulator argument - through the computation. The collections must have identical sizes. - If the input function is f and the elements are i0...iN and j0...jN - then computes f i0 j0 (...(f iN jN s)). - The function to update the state given the input elements. - The first input list. - The second input list. - The initial state. - The final state value. - - - Applies a function to each element of the collection, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN then - computes f i0 (...(f iN s)). - The function to update the state given the input elements. - The input list. - The initial state. - The state object after the folding function is applied to each element of the list. - - - Applies a function to corresponding elements of two collections, threading an accumulator argument - through the computation. The collections must have identical sizes. - If the input function is f and the elements are i0...iN and j0...jN - then computes f (... (f s i0 j0)...) iN jN. - The function to update the state given the input elements. - The initial state. - The first input list. - The second input list. - The final state value. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. Take the second argument, and apply the function to it - and the first element of the list. Then feed this result into the function along - with the second element and so on. Return the final result. - If the input function is f and the elements are i0...iN then - computes f (... (f s i0) i1 ...) iN. - The function to update the state given the input elements. - The initial state. - The input list. - The final state value. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true" - The function to test the input elements. - The input list. - A list containing only the elements that satisfy the predicate. - - - Returns the index of the last element in the list - that satisfies the given predicate. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for all the - elements of the list. - The index of the last element that satisfies the predicate. - - - Returns the index of the first element in the list - that satisfies the given predicate. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for all the - elements of the list. - The index of the first element that satisfies the predicate. - - - Returns the last element for which the given function returns true. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for - all the elements of the list. - The last element that satisfies the predicate. - - - Returns the first element for which the given function returns true. - Raises KeyNotFoundException if no such element exists. - The function to test the input elements. - The input list. - Thrown if the predicate evaluates to false for - all the elements of the list. - The first element that satisfies the predicate. - - - Tests if any pair of corresponding elements of the lists satisfies the given predicate. - - The predicate is applied to matching elements in the two collections up to the lesser of the - two lengths of the collections. If any application returns true then the overall result is - true and no further elements are tested. Otherwise, if one collections is longer - than the other then the System.ArgumentException exception is raised. - Otherwise, false is returned. - The function to test the input elements. - The first input list. - The second input list. - Thrown when the input lists differ in length. - True if any pair of elements satisfy the predicate. - - - Tests if any element of the list satisfies the given predicate. - - The predicate is applied to the elements of the input list. If any application - returns true then the overall result is true and no further elements are tested. - Otherwise, false is returned. - The function to test the input elements. - The input list. - True if any element satisfies the predicate. - - - Returns the only element of the list. - - The input list. - - The only element of the list. - - Thrown when the input does not have precisely one element. - - - Returns a new list with the distinct elements of the input list which do not appear in the itemsToExclude sequence, - using generic hash and equality comparisons to compare values. - - A sequence whose elements that also occur in the input list will cause those elements to be - removed from the result. - A list whose elements that are not also in itemsToExclude will be returned. - - A list that contains the distinct elements of list that do not appear in itemsToExclude. - - Thrown when itemsToExclude is null. - - - Returns an empty list of the given type. - - - Splits the input list into at most count chunks. - The maximum number of chunks. - The input list. - The list split into chunks. - Thrown when count is not positive. - - - Applies a key-generating function to each element of a list and returns a list yielding unique - keys and their number of occurrences in the original list. - - A function transforming each item of the input list into a key to be - compared against the others. - The input list. - - The result list. - - - Returns a list that contains no duplicate entries according to the - generic hash and equality comparisons on the keys returned by the given key-generating function. - If an element occurs multiple times in the list then the later occurrences are discarded. - - A function transforming the list items into comparable keys. - The input list. - - The result list. - - - Returns a list that contains no duplicate entries according to generic hash and - equality comparisons on the entries. - If an element occurs multiple times in the list then the later occurrences are discarded. - - The input list. - - The result list. - - - Tests if the list contains the specified element. - The value to locate in the input list. - The input list. - True if the input list contains the specified element; false otherwise. - - - Returns a new list that contains the elements of each the lists in order. - The input sequence of lists. - The resulting concatenated list. - - - Compares two lists using the given comparison function, element by element. - Returns the first non-zero result from the comparison function. If the end of a list - is reached it returns a -1 if the first list is shorter and a 1 if the second list - is shorter. - - A function that takes an element from each list and returns an int. - If it evaluates to a non-zero value iteration is stopped and that value is returned. - The first input list. - The second input list. - - The first non-zero value from the comparison function. - - - For each element of the list, applies the given function. Concatenates all the results and return the combined list. - The function to transform each input element into a sublist to be concatenated. - The input list. - The concatenation of the transformed sublists. - - - Divides the input list into chunks of size at most chunkSize. - The maximum size of each chunk. - The input list. - The list divided into chunks. - Thrown when chunkSize is not positive. - - - Applies the given function to each element of the list. Returns - the list comprised of the results x for each element where - the function returns Some(x) - The function to generate options from the elements. - The input list. - The list comprising the values selected from the chooser function. - - - Returns the average of the elements generated by applying the function to each element of the list. - - Raises System.ArgumentException if list is empty. - The function to transform the list elements into the type to be averaged. - The input list. - Thrown when the list is empty. - The resulting average. - - - Returns the average of the elements in the list. - - Raises System.ArgumentException if list is empty. - The input list. - Thrown when the list is empty. - The resulting average. - - - Returns a new list that contains the elements of the first list - followed by elements of the second. - The first input list. - The second input list. - The resulting list. - - - Basic operations on lists. - - - Returns the key of the first mapping in the collection that satisfies the given predicate. - Returns 'None' if no such element exists. - The function to test the input elements. - The input map. - The first key for which the predicate returns true or None if the predicate evaluates to false for each key/value pair. - - - Evaluates the function on each mapping in the collection. Returns the key for the first mapping - where the function returns 'true'. Raise KeyNotFoundException if no such element exists. - The function to test the input elements. - The input map. - Thrown if the key does not exist in the map. - The first key for which the predicate evaluates true. - - - Lookup an element in the map, returning a Some value if the element is in the domain - of the map and None if not. - The input key. - The input map. - The found Some value or None. - - - Removes an element from the domain of the map. No exception is raised if the element is not present. - The input key. - The input map. - The resulting map. - - - Builds two new maps, one containing the bindings for which the given predicate returns 'true', - and the other the remaining bindings. - The function to test the input elements. - The input map. - A pair of maps in which the first contains the elements for which the predicate returned true - and the second containing the elements for which the predicated returned false. - - - Tests if an element is in the domain of the map. - The input key. - The input map. - True if the map contains the key. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The key passed to the - function indicates the key of element being transformed. - The function to transform the key/value pairs. - The input map. - The resulting map of keys and transformed values. - - - Returns true if the given predicate returns true for all of the - bindings in the map. - The function to test the input elements. - The input map. - True if the predicate evaluates to true for all of the bindings in the map. - - - Builds a new map containing only the bindings for which the given predicate returns 'true'. - The function to test the key/value pairs. - The input map. - The filtered map. - - - Returns true if the given predicate returns true for one of the - bindings in the map. - The function to test the input elements. - The input map. - True if the predicate returns true for one of the key/value pairs. - - - Applies the given function to each binding in the dictionary - The function to apply to each key/value pair. - The input map. - - - Folds over the bindings in the map - The function to update the state given the input key/value pairs. - The initial state. - The input map. - The final state value. - - - Folds over the bindings in the map. - The function to update the state given the input key/value pairs. - The input map. - The initial state. - The final state value. - - - Searches the map looking for the first element where the given function returns a Some value - The function to generate options from the key/value pairs. - The input map. - The first result. - - - Searches the map looking for the first element where the given function returns a Some value. - The function to generate options from the key/value pairs. - The input map. - The first result. - - - Lookup an element in the map, raising KeyNotFoundException if no binding - exists in the map. - The input key. - The input map. - Thrown when the key does not exist in the map. - The value mapped to the given key. - - - The empty map. - - - Is the map empty? - The input map. - True if the map is empty. - - - Returns an array of all key-value pairs in the mapping. - The array will be ordered by the keys of the map. - The input map. - The array of key/value pairs. - - - Returns a list of all key-value pairs in the mapping. - The list will be ordered by the keys of the map. - The input map. - The list of key/value pairs. - - - Views the collection as an enumerable sequence of pairs. - The sequence will be ordered by the keys of the map. - The input map. - The sequence of key/value pairs. - - - Returns a new map made from the given bindings. - The input sequence of key/value pairs. - The resulting map. - - - Returns a new map made from the given bindings. - The input array of key/value pairs. - The resulting map. - - - Returns a new map made from the given bindings. - The input list of key/value pairs. - The resulting map. - - - Returns a new map with the binding added to the given map. - The input key. - The input value. - The input map. - The resulting map. - - - Functional programming operators related to the Map<_,_> type. - - - Combines the three sequences into a list of triples. The sequences need not have equal lengths: - when one sequence is exhausted any remaining elements in the other - sequences are ignored. - - The first input sequence. - The second input sequence. - The third input sequence. - - The result sequence. - - Thrown when any of the input sequences is null. - - - Combines the two sequences into a list of pairs. The two sequences need not have equal lengths: - when one sequence is exhausted any remaining elements in the other - sequence are ignored. - - The first input sequence. - The second input sequence. - - The result sequence. - - Thrown when either of the input sequences is null. - - - Returns a sequence that yields sliding windows containing elements drawn from the input - sequence. Each window is returned as a fresh array. - The number of elements in each window. - The input sequence. - The result sequence. - Thrown when the input sequence is null. - Thrown when windowSize is not positive. - - - Returns a sequence that contains the elements generated by the given computation. - The given initial state argument is passed to the element generator. - For each IEnumerator elements in the stream are generated on-demand by applying the element - generator, until a None value is returned by the element generator. Each call to the element - generator returns a new residual state. - - The stream will be recomputed each time an IEnumerator is requested and iterated for the Seq. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - A function that takes in the current state and returns an option tuple of the next - element of the sequence and the next state value. - The initial state value. - - The result sequence. - - - Returns a sequence that when enumerated returns at most N elements. - - The maximum number of items to enumerate. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Applies the given function to successive elements, returning the first - result where the function returns "Some(x)". - - A function that transforms items from the input sequence into options. - The input sequence. - - The chosen element or None. - - Thrown when the input sequence is null. - - - Returns the index of the last element in the sequence - that satisfies the given predicate. Return None if no such element exists. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - The found index or None. - Thrown when the input sequence is null. - - - Tries to find the nth element in the sequence. - Returns None if index is negative or the input sequence does not contain enough elements. - The index of element to retrieve. - The input sequence. - The nth element of the sequence or None. - Thrown when the input sequence is null. - - - Returns the index of the first element in the sequence - that satisfies the given predicate. Return None if no such element exists. - - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - - The found index or None. - - Thrown when the input sequence is null. - - - Returns the last element for which the given function returns true. - Return None if no such element exists. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - The found element or None. - Thrown when the input sequence is null. - - - Returns the first element for which the given function returns true. - Return None if no such element exists. - - A function that evaluates to a Boolean when given an item in the sequence. - The input sequence. - - The found element or None. - - Thrown when the input sequence is null. - - - Builds a list from the given collection. - - The input sequence. - - The result list. - - Thrown when the input sequence is null. - - - Builds an array from the given collection. - - The input sequence. - - The result array. - - Thrown when the input sequence is null. - - - Returns a sequence that, when iterated, yields elements of the underlying sequence while the - given predicate returns true, and then returns no further elements. - - A function that evaluates to false when no more items should be returned. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns the first N elements of the sequence. - Throws InvalidOperationException - if the count exceeds the number of elements in the sequence. Seq.truncate - returns as many items as the sequence contains instead of throwing an exception. - - The number of items to take. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - Thrown when count exceeds the number of elements - in the sequence. - - - Returns a sequence that skips 1 element of the underlying sequence and then yields the - remaining elements of the sequence. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the sum of the results generated by applying the function to each element of the sequence. - The generated elements are summed using the + operator and Zero property associated with the generated type. - - A function to transform items from the input sequence into the type that will be summed. - The input sequence. - - The computed sum. - - - Returns the sum of the elements in the sequence. - - The elements are summed using the + operator and Zero property associated with the generated type. - - The input sequence. - - The computed sum. - - - Applies a key-generating function to each element of a sequence and yield a sequence ordered - descending by keys. The keys are compared using generic comparison as implemented by Operators.compare. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - A function to transform items of the input sequence into comparable keys. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Yields a sequence ordered descending by keys. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Applies a key-generating function to each element of a sequence and yield a sequence ordered - by keys. The keys are compared using generic comparison as implemented by Operators.compare. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - A function to transform items of the input sequence into comparable keys. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Yields a sequence ordered using the given comparison function. - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - The function to compare the collection elements. - The input sequence. - The result sequence. - - - Yields a sequence ordered by keys. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - This is a stable sort, that is the original order of equal elements is preserved. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that, when iterated, skips elements of the underlying sequence while the - given predicate returns true, and then yields the remaining elements of the sequence. - - A function that evaluates an element of the sequence to a boolean value. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that skips N elements of the underlying sequence and then yields the - remaining elements of the sequence. - - The number of items to skip. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when count exceeds the number of elements - in the sequence. - - - Returns a sequence that yields one item only. - - The input item. - - The result sequence of one item. - - - Like foldBack, but returns the sequence of intermediary and final results. - This function returns a sequence that digests the whole initial sequence as soon as that - sequence is iterated. As a result this function should not be used with large or infinite sequences. - - A function that updates the state with each element from the sequence. - The input sequence. - The initial state. - The resulting sequence of computed states. - Thrown when the input sequence is null. - - - Like fold, but computes on-demand and returns the sequence of intermediary and final results. - - A function that updates the state with each element from the sequence. - The initial state. - The input sequence. - - The resulting sequence of computed states. - - Thrown when the input sequence is null. - - - Returns a new sequence with the elements in reverse order. - The input sequence. - The reversed sequence. - Thrown when the input sequence is null. - - - Applies a function to each element of the sequence, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f i0 (...(f iN-1 iN)). - A function that takes in the next-to-last element of the sequence and the - current accumulated result to produce the next accumulated result. - The input sequence. - The final result of the reductions. - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Creates a sequence by replicating the given initial value. - The number of elements to replicate. - The value to replicate - The generated sequence. - - - Applies a function to each element of the sequence, threading an accumulator argument - through the computation. Begin by applying the function to the first two elements. - Then feed this result into the function along with the third element and so on. - Return the final result. - - A function that takes in the current accumulated result and the next - element of the sequence to produce the next accumulated result. - The input sequence. - - The final result of the reduction function. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Builds a new sequence object that delegates to the given sequence object. This ensures - the original sequence cannot be rediscovered and mutated by a type cast. For example, - if given an array the returned sequence will return the elements of the array, but - you cannot cast the returned sequence object to an array. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Applies the given function to successive elements, returning the first - x where the function returns "Some(x)". - - A function to transform each item of the input sequence into an option of the output type. - The input sequence. - - The selected element. - - Thrown when the input sequence is null. - Thrown when every item of the sequence - evaluates to None when the given function is applied. - - - Returns a sequence with all elements permuted according to the - specified permutation. - - Note that this function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. - - The function that maps input indices to output indices. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - Thrown when indexMap does not produce a valid permutation. - - - Returns a sequence of each element in the input sequence and its predecessor, with the - exception of the first element which is only returned as the predecessor of the second element. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Views the given list as a sequence. - - The input list. - - The result sequence. - - - Views the given array as a sequence. - - The input array. - - The result sequence. - - Thrown when the input sequence is null. - - - Computes the nth element in the collection. - - The index of element to retrieve. - The input sequence. - - The nth element of the sequence. - - Thrown when the input sequence is null. - Thrown when the index is negative or the input sequence does not contain enough elements. - - - Returns the lowest of all elements of the sequence, compared via Operators.min on the function result. - - A function to transform items from the input sequence into comparable keys. - The input sequence. - - The smallest element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the lowest of all elements of the sequence, compared via Operators.min. - - The input sequence. - - The smallest element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the greatest of all elements of the sequence, compared via Operators.max on the function result. - - A function to transform items from the input sequence into comparable keys. - The input sequence. - - The largest element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - - Returns the greatest of all elements of the sequence, compared via Operators.max - - The input sequence. - - Thrown when the input sequence is null. - Thrown when the input sequence is empty. - - The largest element of the sequence. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding pairs of elements from the two sequences. If one input sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. The integer index passed to the - function indicates the index (from 0) of element being transformed. - - A function to transform pairs of items from the input sequences that also supplies the current index. - The first input sequence. - The second input sequence. - - The result sequence. - - Thrown when either of the input sequences is null. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The integer index passed to the - function indicates the index (from 0) of element being transformed. - - A function to transform items from the input sequence that also supplies the current index. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding triples of elements from the three sequences. If one input sequence if shorter than - the others then the remaining elements of the longer sequences are ignored. - - The function to transform triples of elements from the input sequences. - The first input sequence. - The second input sequence. - The third input sequence. - - The result sequence. - - Thrown when any of the input sequences is null. - - - Combines map and foldBack. Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The function is also used to accumulate a final value. - This function digests the whole initial sequence as soon as it is called. As a result this function should - not be used with large or infinite sequences. - The function to transform elements from the input collection and accumulate the final value. - The input collection. - The initial state. - Thrown when the input collection is null. - The collection of transformed elements, and the final accumulated value. - - - Combines map and fold. Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The function is also used to accumulate a final value. - This function digests the whole initial sequence as soon as it is called. As a result this function should - not be used with large or infinite sequences. - The function to transform elements from the input collection and accumulate the final value. - The initial state. - The input collection. - Thrown when the input collection is null. - The collection of transformed elements, and the final accumulated value. - - - Builds a new collection whose elements are the results of applying the given function - to the corresponding pairs of elements from the two sequences. If one input sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to transform pairs of items from the input sequences. - The first input sequence. - The second input sequence. - - The result sequence. - - Thrown when either of the input sequences is null. - - - Builds a new collection whose elements are the results of applying the given function - to each of the elements of the collection. The given function will be applied - as elements are demanded using the MoveNext method on enumerators retrieved from the - object. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - A function to transform items from the input sequence. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns the length of the sequence - - The input sequence. - - The length of the sequence. - - Thrown when the input sequence is null. - - - Applies the given function to two collections simultaneously. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. The integer passed to the - function indicates the index of element. - - A function to apply to each pair of elements from the input sequences along with their index. - The first input sequence. - The second input sequence. - - Thrown when either of the input sequences is null. - - - Applies the given function to two collections simultaneously. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to apply to each pair of elements from the input sequences. - The first input sequence. - The second input sequence. - - Thrown when either of the input sequences is null. - - - Applies the given function to each element of the collection. The integer passed to the - function indicates the index of element. - - A function to apply to each element of the sequence that can also access the current index. - The input sequence. - - Thrown when the input sequence is null. - - - Applies the given function to each element of the collection. - - A function to apply to each element of the sequence. - The input sequence. - - Thrown when the input sequence is null. - - - Computes the element at the specified index in the collection. - The index of the element to retrieve. - The input sequence. - The element at the specified index of the sequence. - Thrown when the input sequence is null. - Thrown when the index is negative or the input sequence does not contain enough elements. - - - Generates a new sequence which, when iterated, will return successive - elements by calling the given function. The results of calling the function - will not be saved, that is the function will be reapplied as necessary to - regenerate the elements. The function is passed the index of the item being - generated. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - Iteration can continue up to Int32.MaxValue. - - A function that generates an item in the sequence from a given index. - - The result sequence. - - - Generates a new sequence which, when iterated, will return successive - elements by calling the given function, up to the given count. Each element is saved after its - initialization. The function is passed the index of the item being - generated. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - The maximum number of items to generate for the sequence. - A function that generates an item in the sequence from a given index. - - The result sequence. - - Thrown when count is negative. - - - Builds a new collection whose elements are the corresponding elements of the input collection - paired with the integer index (from 0) of each element. - The input sequence. - The result sequence. - Thrown when the input sequence is null. - - - Returns true if the sequence contains no elements, false otherwise. - - The input sequence. - - True if the sequence is empty; false otherwise. - - Thrown when the input sequence is null. - - - Returns the only element of the sequence. - - The input sequence. - - The only element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input does not have precisely one element. - - - Returns the last element of the sequence. - Return None if no such element exists. - - The input sequence. - - The last element of the sequence or None. - - Thrown when the input sequence is null. - - - Returns the last element of the sequence. - The input sequence. - The last element of the sequence. - Thrown when the input sequence is null. - Thrown when the input does not have any elements. - - - Returns the first element of the sequence, or None if the sequence is empty. - - The input sequence. - - The first element of the sequence or None. - - Thrown when the input sequence is null. - - - Returns the first element of the sequence. - - The input sequence. - - The first element of the sequence. - - Thrown when the input sequence is null. - Thrown when the input does not have any elements. - - - Applies a key-generating function to each element of a sequence and yields a sequence of - unique keys. Each unique key contains a sequence of all elements that match - to this key. - - This function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - A function that transforms an element of the sequence into a comparable key. - The input sequence. - - The result sequence. - - - Tests the all pairs of elements drawn from the two sequences satisfy the - given predicate. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to test pairs of elements from the input sequences. - The first input sequence. - The second input sequence. - - True if all pairs satisfy the predicate; false otherwise. - - Thrown when either of the input sequences is null. - - - Tests if all elements of the sequence satisfy the given predicate. - - The predicate is applied to the elements of the input sequence. If any application - returns false then the overall result is false and no further elements are tested. - Otherwise, true is returned. - - A function to test an element of the input sequence. - The input sequence. - - True if every element of the sequence satisfies the predicate; false otherwise. - - Thrown when the input sequence is null. - - - Applies a function to corresponding elements of two collections, starting from the end of the shorter collection, - threading an accumulator argument through the computation. The two sequences need not have equal lengths. - If the input function is f and the elements are i0...iN and j0...jM, N < M - then computes f i0 j0 (... (f iN jN s)...). - The function to update the state given the input elements. - The first input sequence. - The second input sequence. - The initial state. - The final state value. - Thrown when the either of the input sequences is null. - - - Applies a function to each element of the collection, starting from the end, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f i0 (... (f iN s)...) - The function to update the state given the input elements. - The input sequence. - The initial state. - The state object after the folding function is applied to each element of the sequence. - Thrown when the input sequence is null. - - - Applies a function to corresponding elements of two collections, threading an accumulator argument - through the computation. The two sequences need not have equal lengths: - when one sequence is exhausted any remaining elements in the other sequence are ignored. - If the input function is f and the elements are i0...iN and j0...jN - then computes f (... (f s i0 j0)...) iN jN. - The function to update the state given the input elements. - The initial state. - The first input sequence. - The second input sequence. - The final state value. - Thrown when the either of the input sequences is null. - - - Applies a function to each element of the collection, threading an accumulator argument - through the computation. If the input function is f and the elements are i0...iN - then computes f (... (f s i0)...) iN - - A function that updates the state with each element from the sequence. - The initial state. - The input sequence. - - The state object after the folding function is applied to each element of the sequence. - - Thrown when the input sequence is null. - - - Returns the index of the last element for which the given function returns true. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function to test whether the index of a particular element should be returned. - The input sequence. - The index of the last element for which the predicate returns true. - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns the index of the first element for which the given function returns true. - - A function to test whether the index of a particular element should be returned. - The input sequence. - - The index of the first element for which the predicate returns true. - - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns the last element for which the given function returns true. - This function digests the whole initial sequence as soon as it is called. As a - result this function should not be used with large or infinite sequences. - A function to test whether an item in the sequence should be returned. - The input sequence. - The last element for which the predicate returns true. - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns the first element for which the given function returns true. - - A function to test whether an item in the sequence should be returned. - The input sequence. - - The first element for which the predicate returns true. - - Thrown if no element returns true when - evaluated by the predicate - Thrown when the input sequence is null - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true". - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - Remember sequence is lazy, effects are delayed until it is enumerated. - - A synonym for Seq.filter. - - A function to test whether each item in the input sequence should be included in the output. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns "true". This is a synonym for Seq.where. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - Remember sequence is lazy, effects are delayed until it is enumerated. - - A function to test whether each item in the input sequence should be included in the output. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Tests if any pair of corresponding elements of the input sequences satisfies the given predicate. - - The predicate is applied to matching elements in the two sequences up to the lesser of the - two lengths of the collections. If any application returns true then the overall result is - true and no further elements are tested. Otherwise, false is returned. If one sequence is shorter than - the other then the remaining elements of the longer sequence are ignored. - - A function to test each pair of items from the input sequences. - The first input sequence. - The second input sequence. - - True if any result from the predicate is true; false otherwise. - - Thrown when either of the two input sequences is null. - - - Tests if any element of the sequence satisfies the given predicate. - - The predicate is applied to the elements of the input sequence. If any application - returns true then the overall result is true and no further elements are tested. - Otherwise, false is returned. - - A function to test each item of the input sequence. - The input sequence. - - True if any result from the predicate is true; false otherwise. - - Thrown when the input sequence is null. - - - Returns a new sequence with the distinct elements of the second sequence which do not apear in the first sequence, - using generic hash and equality comparisons to compare values. - - Note that this function returns a sequence that digests the whole of the first input sequence as soon as - the result sequence is iterated. As a result this function should not be used with - large or infinite sequences in the first parameter. The function makes no assumption on the ordering of the first input - sequence. - - A sequence whose elements that also occur in the second sequence will cause those elements to be - removed from the returned sequence. - A sequence whose elements that are not also in first will be returned. - - A sequence that contains the set difference of the elements of two sequences. - - Thrown when either of the two input sequences is null. - - - Creates an empty sequence. - - An empty sequence. - - - Splits the input sequence into at most count chunks. - This function returns a sequence that digests the whole initial sequence as soon as that - sequence is iterated. As a result this function should not be used with large or infinite sequences. - The maximum number of chunks. - The input sequence. - The sequence split into chunks. - Thrown when the input sequence is null. - Thrown when count is not positive. - - - Returns a sequence that contains no duplicate entries according to the - generic hash and equality comparisons on the keys returned by the given key-generating function. - If an element occurs multiple times in the sequence then the later occurrences are discarded. - - A function transforming the sequence items into comparable keys. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that contains no duplicate entries according to generic hash and - equality comparisons on the entries. - If an element occurs multiple times in the sequence then the later occurrences are discarded. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that is built from the given delayed specification of a - sequence. - - The input function is evaluated each time an IEnumerator for the sequence - is requested. - - The generating function for the sequence. - - - Applies a key-generating function to each element of a sequence and returns a sequence yielding unique - keys and their number of occurrences in the original sequence. - - Note that this function returns a sequence that digests the whole initial sequence as soon as - that sequence is iterated. As a result this function should not be used with - large or infinite sequences. The function makes no assumption on the ordering of the original - sequence. - - A function transforming each item of the input sequence into a key to be - compared against the others. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Tests if the sequence contains the specified element. - The value to locate in the input sequence. - The input sequence. - True if the input sequence contains the specified element; false otherwise. - Thrown when the input sequence is null. - - - Combines the given enumeration-of-enumerations as a single concatenated - enumeration. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - The input enumeration-of-enumerations. - - The result sequence. - - Thrown when the input sequence is null. - - - Compares two sequences using the given comparison function, element by element. - Returns the first non-zero result from the comparison function. If the end of a sequence - is reached it returns a -1 if the first sequence is shorter and a 1 if the second sequence - is shorter. - - A function that takes an element from each sequence and returns an int. - If it evaluates to a non-zero value iteration is stopped and that value is returned. - The first input sequence. - The second input sequence. - - The first non-zero value from the comparison function. - - Thrown when either of the input sequences - is null. - - - Applies the given function to each element of the sequence and concatenates all the - results. - - Remember sequence is lazy, effects are delayed until it is enumerated. - - A function to transform elements of the input sequence into the sequences - that will then be concatenated. - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Divides the input sequence into chunks of size at most chunkSize. - The maximum size of each chunk. - The input sequence. - The sequence divided into chunks. - Thrown when the input sequence is null. - Thrown when chunkSize is not positive. - - - Applies the given function to each element of the list. Return - the list comprised of the results "x" for each element where - the function returns Some(x). - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not - be accessed concurrently. - - A function to transform items of type T into options of type U. - The input sequence of type T. - - The result sequence. - - Thrown when the input sequence is null. - - - Wraps a loosely-typed System.Collections sequence as a typed sequence. - - The use of this function usually requires a type annotation. - An incorrect type annotation may result in runtime type - errors. - Individual IEnumerator values generated from the returned sequence should not be accessed concurrently. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns a sequence that corresponds to a cached version of the input sequence. - This result sequence will have the same elements as the input sequence. The result - can be enumerated multiple times. The input sequence will be enumerated at most - once and only as far as is necessary. Caching a sequence is typically useful when repeatedly - evaluating items in the original sequence is computationally expensive or if - iterating the sequence causes side-effects that the user does not want to be - repeated multiple times. - - Enumeration of the result sequence is thread safe in the sense that multiple independent IEnumerator - values may be used simultaneously from different threads (accesses to - the internal lookaside table are thread safe). Each individual IEnumerator - is not typically thread safe and should not be accessed concurrently. - - Once enumeration of the input sequence has started, - it's enumerator will be kept live by this object until the enumeration has completed. - At that point, the enumerator will be disposed. - - The enumerator may be disposed and underlying cache storage released by - converting the returned sequence object to type IDisposable, and calling the Dispose method - on this object. The sequence object may then be re-enumerated and a fresh enumerator will - be used. - - The input sequence. - - The result sequence. - - Thrown when the input sequence is null. - - - Returns the average of the results generated by applying the function to each element - of the sequence. - - The elements are averaged using the + operator, DivideByInt method and Zero property - associated with the generated type. - - A function applied to transform each element of the sequence. - The input sequence. - - The average. - - Thrown when the input sequence is null. - Thrown when the input sequence has zero elements. - - - Returns the average of the elements in the sequence. - - The elements are averaged using the + operator, DivideByInt method and Zero property - associated with the element type. - - The input sequence. - - The average. - - Thrown when the input sequence is null. - Thrown when the input sequence has zero elements. - - - Wraps the two given enumerations as a single concatenated - enumeration. - - The returned sequence may be passed between threads safely. However, - individual IEnumerator values generated from the returned sequence should not be accessed - concurrently. - - The first sequence. - The second sequence. - - The result sequence. - - Thrown when either of the two provided sequences is - null. - - - Basic operations on IEnumerables. - - - Returns a new set with the elements of the second set removed from the first. - The first input set. - The set whose elements will be removed from set1. - The set with the elements of set2 removed from set1. - - - Builds a new collection from the given enumerable object. - The input sequence. - The set containing elements. - - - Returns an ordered view of the collection as an enumerable object. - The input set. - An ordered sequence of the elements of set. - - - Builds an array that contains the elements of the set in order. - The input set. - An ordered array of the elements of set. - - - Builds a set that contains the same elements as the given array. - The input array. - A set containing the elements of array. - - - Builds a list that contains the elements of the set in order. - The input set. - An ordered list of the elements of set. - - - Builds a set that contains the same elements as the given list. - The input list. - A set containing the elements form the input list. - - - Returns the highest element in the set according to the ordering being used for the set. - The input set. - The max value from the set. - - - Returns the lowest element in the set according to the ordering being used for the set. - The input set. - The min value from the set. - - - Returns a new set with the given element removed. No exception is raised if - the set doesn't contain the given element. - The element to remove. - The input set. - The input set with value removed. - - - Splits the set into two sets containing the elements for which the given predicate - returns true and false respectively. - The function to test set elements. - The input set. - A pair of sets with the first containing the elements for which predicate returns - true and the second containing the elements for which predicate returns false. - - - Applies the given function to each element of the set, in order according - to the comparison function. - The function to apply to each element. - The input set. - - - Returns "true" if the set is empty. - The input set. - True if set is empty. - - - Computes the union of a sequence of sets. - The sequence of sets to untion. - The union of the input sets. - - - Computes the union of the two sets. - The first input set. - The second input set. - The union of set1 and set2. - - - Computes the intersection of a sequence of sets. The sequence must be non-empty. - The sequence of sets to intersect. - The intersection of the input sets. - - - Computes the intersection of the two sets. - The first input set. - The second input set. - The intersection of set1 and set2. - - - Tests if all elements of the collection satisfy the given predicate. - If the input function is f and the elements are i0...iN and "j0...jN" - then computes p i0 && ... && p iN. - The function to test set elements. - The input set. - True if all elements of set satisfy predicate. - - - Applies the given accumulating function to all the elements of the set. - The accumulating function. - The input set. - The initial state. - The final state. - - - Applies the given accumulating function to all the elements of the set - The accumulating function. - The initial state. - The input set. - The final state. - - - Returns a new collection containing the results of applying the - given function to each element of the input set. - The function to transform elements of the input set. - The input set. - A set containing the transformed elements. - - - Returns a new collection containing only the elements of the collection - for which the given predicate returns true. - The function to test set elements. - The input set. - The set containing only the elements for which predicate returns true. - - - Tests if any element of the collection satisfies the given predicate. - If the input function is predicate and the elements are i0...iN - then computes p i0 or ... or p iN. - The function to test set elements. - The input set. - True if any element of set satisfies predicate. - - - Returns the number of elements in the set. Same as size. - The input set. - The number of elements in the set. - - - Evaluates to "true" if all elements of the second set are in the first, and at least - one element of the first is not in the second. - The potential superset. - The set to test against. - True if set1 is a proper superset of set2. - - - Evaluates to "true" if all elements of the second set are in the first. - The potential superset. - The set to test against. - True if set1 is a superset of set2. - - - Evaluates to "true" if all elements of the first set are in the second, and at least - one element of the second is not in the first. - The potential subset. - The set to test against. - True if set1 is a proper subset of set2. - - - Evaluates to "true" if all elements of the first set are in the second - The potential subset. - The set to test against. - True if set1 is a subset of set2. - - - Evaluates to "true" if the given element is in the given set. - The element to test. - The input set. - True if element is in set. - - - Returns a new set with an element added to the set. No exception is raised if - the set already contains the given element. - The value to add. - The input set. - A new set containing value. - - - The set containing the given element. - The value for the set to contain. - The set containing value. - - - The empty set for the type 'T. - - - Functional programming operators related to the Set<_> type. - - - Gets the default cancellation token for executing asynchronous computations. - The default CancellationToken. - - - Creates an asynchronous computation that returns the CancellationToken governing the execution - of the computation. - In async { let! token = Async.CancellationToken ...} token can be used to initiate other - asynchronous operations that will cancel cooperatively with this workflow. - An asynchronous computation capable of retrieving the CancellationToken from a computation - expression. - - - Creates an asynchronous computation that executes computation. - If this computation is cancelled before it completes then the computation generated by - running compensation is executed. - The input asynchronous computation. - The function to be run if the computation is cancelled. - An asynchronous computation that runs the compensation if the input computation - is cancelled. - - - Creates an asynchronous computation that queues a work item that runs - its continuation. - A computation that generates a new work item in the thread pool. - - - Creates an asynchronous computation that creates a new thread and runs - its continuation in that thread. - A computation that will execute on a new thread. - - - Creates an asynchronous computation that runs - its continuation using syncContext.Post. If syncContext is null - then the asynchronous computation is equivalent to SwitchToThreadPool(). - The synchronization context to accept the posted computation. - An asynchronous computation that uses the syncContext context to execute. - - - Runs an asynchronous computation, starting immediately on the current operating system - thread. Call one of the three continuations when the operation completes. - If no cancellation token is provided then the default cancellation token - is used. - The asynchronous computation to execute. - The function called on success. - The function called on exception. - The function called on cancellation. - The CancellationToken to associate with the computation. - The default is used if this parameter is not provided. - - - Runs an asynchronous computation, starting immediately on the current operating system - thread. - If no cancellation token is provided then the default cancellation token is used. - The asynchronous computation to execute. - The CancellationToken to associate with the computation. - The default is used if this parameter is not provided. - - - Creates an asynchronous computation which starts the given computation as a System.Threading.Tasks.Task - - - Starts a child computation within an asynchronous workflow. - This allows multiple asynchronous computations to be executed simultaneously. - - This method should normally be used as the immediate - right-hand-side of a let! binding in an F# asynchronous workflow, that is, - - async { ... - let! completor1 = childComputation1 |> Async.StartChild - let! completor2 = childComputation2 |> Async.StartChild - ... - let! result1 = completor1 - let! result2 = completor2 - ... } - - When used in this way, each use of StartChild starts an instance of childComputation - and returns a completor object representing a computation to wait for the completion of the operation. - When executed, the completor awaits the completion of childComputation. - The child computation. - The timeout value in milliseconds. If one is not provided - then the default value of -1 corresponding to System.Threading.Timeout.Infinite. - A new computation that waits for the input computation to finish. - - - Executes a computation in the thread pool. - If no cancellation token is provided then the default cancellation token is used. - A System.Threading.Tasks.Task that will be completed - in the corresponding state once the computation terminates (produces the result, throws exception or gets canceled) - - - - Starts the asynchronous computation in the thread pool. Do not await its result. - - If no cancellation token is provided then the default cancellation token is used. - The computation to run asynchronously. - The cancellation token to be associated with the computation. - If one is not supplied, the default cancellation token is used. - - - Creates an asynchronous computation that will sleep for the given time. This is scheduled - using a System.Threading.Timer object. The operation will not block operating system threads - for the duration of the wait. - The number of milliseconds to sleep. - An asynchronous computation that will sleep for the given time. - Thrown when the due time is negative - and not infinite. - - - Runs the asynchronous computation and await its result. - - If an exception occurs in the asynchronous computation then an exception is re-raised by this - function. - - If no cancellation token is provided then the default cancellation token is used. - - The timeout parameter is given in milliseconds. A value of -1 is equivalent to - System.Threading.Timeout.Infinite. - The computation to run. - The amount of time in milliseconds to wait for the result of the - computation before raising a System.TimeoutException. If no value is provided - for timeout then a default of -1 is used to correspond to System.Threading.Timeout.Infinite. - The cancellation token to be associated with the computation. - If one is not supplied, the default cancellation token is used. - The result of the computation. - - - Creates an asynchronous computation that executes all the given asynchronous computations, - initially queueing each as work items and using a fork/join pattern. - - If all child computations succeed, an array of results is passed to the success continuation. - - If any child computation raises an exception, then the overall computation will trigger an - exception, and cancel the others. - - The overall computation will respond to cancellation while executing the child computations. - If cancelled, the computation will cancel any remaining child computations but will still wait - for the other child computations to complete. - A sequence of distinct computations to be parallelized. - A computation that returns an array of values from the sequence of input computations. - - - Generates a scoped, cooperative cancellation handler for use within an asynchronous workflow. - - For example, - async { use! holder = Async.OnCancel interruption ... } - generates an asynchronous computation where, if a cancellation happens any time during - the execution of the asynchronous computation in the scope of holder, then action - interruption is executed on the thread that is performing the cancellation. This can - be used to arrange for a computation to be asynchronously notified that a cancellation - has occurred, e.g. by setting a flag, or deregistering a pending I/O action. - The function that is executed on the thread performing the - cancellation. - An asynchronous computation that triggers the interruption if it is cancelled - before being disposed. - - - Creates an asynchronous computation that runs the given computation and ignores - its result. - The input computation. - A computation that is equivalent to the input computation, but disregards the result. - - - Creates an asynchronous computation that captures the current - success, exception and cancellation continuations. The callback must - eventually call exactly one of the given continuations. - The function that accepts the current success, exception, and cancellation - continuations. - An asynchronous computation that provides the callback with the current continuations. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. This overlaod should be used if the operation is - qualified by three arguments. For example, - Async.FromBeginEnd(arg1,arg2,arg3,ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The first argument for the operation. - The second argument for the operation. - The third argument for the operation. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. This overlaod should be used if the operation is - qualified by two arguments. For example, - Async.FromBeginEnd(arg1,arg2,ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The first argument for the operation. - The second argument for the operation. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. This overlaod should be used if the operation is - qualified by one argument. For example, - Async.FromBeginEnd(place,ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The argument for the operation. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation in terms of a Begin/End pair of actions in - the style used in CLI APIs. For example, - Async.FromBeginEnd(ws.BeginGetWeather,ws.EndGetWeather) - When the computation is run, beginFunc is executed, with - a callback which represents the continuation of the computation. - When the callback is invoked, the overall result is fetched using endFunc. - - The computation will respond to cancellation while waiting for the completion - of the operation. If a cancellation occurs, and cancelAction is specified, then it is - executed, and the computation continues to wait for the completion of the operation. - - If cancelAction is not specified, then cancellation causes the computation - to stop immediately, and subsequent invocations of the callback are ignored. - The function initiating a traditional CLI asynchronous operation. - The function completing a traditional CLI asynchronous operation. - An optional function to be executed when a cancellation is requested. - An asynchronous computation wrapping the given Begin/End functions. - - - Creates an asynchronous computation that executes computation. - If this computation completes successfully then return Choice1Of2 with the returned - value. If this computation raises an exception before it completes then return Choice2Of2 - with the raised exception. - The input computation that returns the type T. - A computation that returns a choice of type T or exception. - - - Raises the cancellation condition for the most recent set of asynchronous computations started - without any specific CancellationToken. Replaces the global CancellationTokenSource with a new - global token source for any asynchronous computations created after this point without any - specific CancellationToken. - - - Creates an asynchronous computation that will wait on the given WaitHandle. - - The computation returns true if the handle indicated a result within the given timeout. - The WaitHandle that can be signalled. - The timeout value in milliseconds. If one is not provided - then the default value of -1 corresponding to System.Threading.Timeout.Infinite. - An asynchronous computation that waits on the given WaitHandle. - - - - Return an asynchronous computation that will wait for the given task to complete and return - its result. - - - - - Return an asynchronous computation that will wait for the given task to complete and return - its result. - - - - Creates an asynchronous computation that will wait on the IAsyncResult. - - The computation returns true if the handle indicated a result within the given timeout. - The IAsyncResult to wait on. - The timeout value in milliseconds. If one is not provided - then the default value of -1 corresponding to System.Threading.Timeout.Infinite. - An asynchronous computation that waits on the given IAsyncResult. - - - Creates an asynchronous computation that waits for a single invocation of a CLI - event by adding a handler to the event. Once the computation completes or is - cancelled, the handler is removed from the event. - - The computation will respond to cancellation while waiting for the event. If a - cancellation occurs, and cancelAction is specified, then it is executed, and - the computation continues to wait for the event. - - If cancelAction is not specified, then cancellation causes the computation - to cancel immediately. - The event to handle once. - An optional function to execute instead of cancelling when a - cancellation is issued. - An asynchronous computation that waits for the event to be invoked. - - - Creates three functions that can be used to implement the .NET Asynchronous - Programming Model (APM) for a given asynchronous computation. - - The functions should normally be published as members with prefix Begin, - End and Cancel, and can be used within a type definition as follows: - - let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun arg -> computation) - member x.BeginSomeOperation(arg,callback,state:obj) = beginAction(arg,callback,state) - member x.EndSomeOperation(iar) = endAction(iar) - member x.CancelSomeOperation(iar) = cancelAction(iar) - - - If the asynchronous computation takes no arguments, then AsBeginEnd is used as follows: - - let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun () -> computation) - member x.BeginSomeOperation(callback,state:obj) = beginAction((),callback,state) - member x.EndSomeOperation(iar) = endAction(iar) - member x.CancelSomeOperation(iar) = cancelAction(iar) - - - - If the asynchronous computation takes two arguments, then AsBeginEnd is used as follows: - - let beginAction,endAction,cancelAction = Async.AsBeginEnd (fun arg1 arg2 -> computation) - member x.BeginSomeOperation(arg1,arg2,callback,state:obj) = beginAction((),callback,state) - member x.EndSomeOperation(iar) = endAction(iar) - member x.CancelSomeOperation(iar) = cancelAction(iar) - - - In each case, the resulting API will be familiar to programmers in other CLI languages and - is a useful way to publish asynchronous computations in CLI components. - A function generating the asynchronous computation to split into the traditional - .NET Asynchronous Programming Model. - A tuple of the begin, end, and cancel members. - - - This static class holds members for creating and manipulating asynchronous computations. - - - Creates an asynchronous computation that just returns (). - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of empty else branches in the - async { ... } computation expression syntax. - An asynchronous computation that returns (). - - - Creates an asynchronous computation that runs computation repeatedly - until guard() becomes false. - - A cancellation check is performed whenever the computation is executed. - - The existence of this method permits the use of while in the - async { ... } computation expression syntax. - The function to determine when to stop executing computation. - The function to be executed. Equivalent to the body - of a while expression. - An asynchronous computation that behaves similarly to a while loop when run. - - - Creates an asynchronous computation that runs binder(resource). - The action resource.Dispose() is executed as this computation yields its result - or if the asynchronous computation exits by an exception or by cancellation. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of use and use! in the - async { ... } computation expression syntax. - The resource to be used and disposed. - The function that takes the resource and returns an asynchronous - computation. - An asynchronous computation that binds and eventually disposes resource. - - - Creates an asynchronous computation that runs computation and returns its result. - If an exception happens then catchHandler(exn) is called and the resulting computation executed instead. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of try/with in the - async { ... } computation expression syntax. - The input computation. - The function to run when computation throws an exception. - An asynchronous computation that executes computation and calls catchHandler if an - exception is thrown. - - - Creates an asynchronous computation that runs computation. The action compensation is executed - after computation completes, whether computation exits normally or by an exception. If compensation raises an exception itself - the original exception is discarded and the new exception becomes the overall result of the computation. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of try/finally in the - async { ... } computation expression syntax. - The input computation. - The action to be run after computation completes or raises an - exception (including cancellation). - An asynchronous computation that executes computation and compensation aftewards or - when an exception is raised. - - - Delegates to the input computation. - - The existence of this method permits the use of return! in the - async { ... } computation expression syntax. - The input computation. - The input computation. - - - Creates an asynchronous computation that returns the result v. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of return in the - async { ... } computation expression syntax. - The value to return from the computation. - An asynchronous computation that returns value when executed. - - - Creates an asynchronous computation that enumerates the sequence seq - on demand and runs body for each element. - - A cancellation check is performed on each iteration of the loop. - - The existence of this method permits the use of for in the - async { ... } computation expression syntax. - The sequence to enumerate. - A function to take an item from the sequence and create - an asynchronous computation. Can be seen as the body of the for expression. - An asynchronous computation that will enumerate the sequence and run body - for each element. - - - Creates an asynchronous computation that runs generator. - - A cancellation check is performed when the computation is executed. - The function to run. - An asynchronous computation that runs generator. - - - Creates an asynchronous computation that first runs computation1 - and then runs computation2, returning the result of computation2. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of expression sequencing in the - async { ... } computation expression syntax. - The first part of the sequenced computation. - The second part of the sequenced computation. - An asynchronous computation that runs both of the computations sequentially. - - - Creates an asynchronous computation that runs computation, and when - computation generates a result T, runs binder res. - - A cancellation check is performed when the computation is executed. - - The existence of this method permits the use of let! in the - async { ... } computation expression syntax. - The computation to provide an unbound result. - The function to bind the result of computation. - An asynchronous computation that performs a monadic bind on the result - of computation. - - - - Generate an object used to build asynchronous computations using F# computation expressions. The value - 'async' is a pre-defined instance of this type. - - A cancellation check is performed when the computation is executed. - - - - The type of the async operator, used to build workflows for asynchronous computations. - - - Sends a reply to a PostAndReply message. - The value to send. - - - A handle to a capability to reply to a PostAndReply message. - - - A compositional asynchronous computation, which, when run, will eventually produce a value - of type T, or else raises an exception. - - Asynchronous computations are normally specified using an F# computation expression. - - When run, asynchronous computations have two modes: as a work item (executing synchronous - code), or as a wait item (waiting for an event or I/O completion). - - When run, asynchronous computations can be governed by CancellationToken. This can usually - be specified when the async computation is started. The associated CancellationTokenSource - may be used to cancel the asynchronous computation. Asynchronous computations built using - computation expressions can check the cancellation condition regularly. Synchronous - computations within an asynchronous computation do not automatically check this condition. - - - Publishes the event as a first class event value. - - - Triggers the event using the given parameters. - The parameters for the event. - - - Creates an event object suitable for implementing an arbitrary type of delegate. - The event object. - - - Event implementations for an arbitrary type of delegate. - - - Publishes an observation as a first class value. - - - Triggers an observation using the given parameters. - The event parameters. - - - Creates an observable object. - The created event. - - - Event implementations for the IEvent<_> type. - - - Publishes the event as a first class event value. - - - Triggers the event using the given sender object and parameters. The sender object may be null. - The object triggering the event. - The parameters for the event. - - - Creates an event object suitable for delegate types following the standard .NET Framework convention of a first 'sender' argument. - The created event. - - - Event implementations for a delegate types following the standard .NET Framework convention of a first 'sender' argument. - - - A delegate type associated with the F# event type IEvent<_> - The object that fired the event. - The event arguments. - - - Remove a listener delegate from an event listener store. - The delegate to be removed from the event listener store. - - - Connect a handler delegate object to the event. A handler can - be later removed using RemoveHandler. The listener will - be invoked when the event is fired. - A delegate to be invoked when the event is fired. - - - First class event values for arbitrary delegate types. - - F# gives special status to member properties compatible with type IDelegateEvent and - tagged with the CLIEventAttribute. In this case the F# compiler generates approriate - CLI metadata to make the member appear to other CLI languages as a CLI event. - - - First-class listening points (i.e. objects that permit you to register a callback - activated when the event is triggered). - - - First class event values for CLI events conforming to CLI Framework standards. - - - The type of delayed computations. - - Use the values in the Lazy module to manipulate - values of this type, and the notation lazy expr to create values - of type . - - - Raises a timeout exception if a message not received in this amount of time. By default - no timeout is used. - - - Occurs when the execution of the agent results in an exception. - - - Occurs when the execution of the agent results in an exception. - - - Raises a timeout exception if a message not received in this amount of time. By default - no timeout is used. - - - Returns the number of unprocessed messages in the message queue of the agent. - - - Occurs when the execution of the agent results in an exception. - - - Scans for a message by looking through messages in arrival order until scanner - returns a Some value. Other messages remain in the queue. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - The function to return None if the message is to be skipped - or Some if the message is to be processed and removed from the queue. - An optional timeout in milliseconds. Defaults to -1 which corresponds - to System.Threading.Timeout.Infinite. - An asynchronous computation that scanner built off the read message. - - - Waits for a message. This will consume the first message in arrival order. - - This method is for use within the body of the agent. - - Returns None if a timeout is given and the timeout is exceeded. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - An optional timeout in milliseconds. Defaults to -1 which - corresponds to System.Threading.Timeout.Infinite. - An asynchronous computation that returns the received message or - None if the timeout is exceeded. - - - Like PostAndReply, but returns None if no reply within the timeout period. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - The reply from the agent or None if the timeout expires. - - - Starts the agent. - - - Creates and starts an agent. The body function is used to generate the asynchronous - computation executed by the agent. - The function to produce an asynchronous computation that will be executed - as the read loop for the MailboxProcessor when Start is called. - An optional cancellation token for the body. - Defaults to Async.DefaultCancellationToken. - The created MailboxProcessor. - - - Scans for a message by looking through messages in arrival order until scanner - returns a Some value. Other messages remain in the queue. - - Returns None if a timeout is given and the timeout is exceeded. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - The function to return None if the message is to be skipped - or Some if the message is to be processed and removed from the queue. - An optional timeout in milliseconds. Defaults to -1 which corresponds - to System.Threading.Timeout.Infinite. - An asynchronous computation that scanner built off the read message. - Thrown when the timeout is exceeded. - - - Waits for a message. This will consume the first message in arrival order. - - This method is for use within the body of the agent. - - This method is for use within the body of the agent. For each agent, at most - one concurrent reader may be active, so no more than one concurrent call to - Receive, TryReceive, Scan and/or TryScan may be active. - An optional timeout in milliseconds. Defaults to -1 which corresponds - to System.Threading.Timeout.Infinite. - An asynchronous computation that returns the received message. - Thrown when the timeout is exceeded. - - - Like AsyncPostAndReply, but returns None if no reply within the timeout period. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - An asynchronous computation that will return the reply or None if the timeout expires. - - - Posts a message to an agent and await a reply on the channel, synchronously. - - The message is generated by applying buildMessage to a new reply channel - to be incorporated into the message. The receiving agent must process this - message and invoke the Reply method on this reply channel precisely once. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - The reply from the agent. - - - Posts a message to an agent and await a reply on the channel, asynchronously. - - The message is generated by applying buildMessage to a new reply channel - to be incorporated into the message. The receiving agent must process this - message and invoke the Reply method on this reply channel precisely once. - The function to incorporate the AsyncReplyChannel into - the message to be sent. - An optional timeout parameter (in milliseconds) to wait for a reply message. - Defaults to -1 which corresponds to System.Threading.Timeout.Infinite. - An asychronous computation that will wait for the reply from the agent. - - - Posts a message to the message queue of the MailboxProcessor, asynchronously. - The message to post. - - - Creates an agent. The body function is used to generate the asynchronous - computation executed by the agent. This function is not executed until - Start is called. - The function to produce an asynchronous computation that will be executed - as the read loop for the MailboxProcessor when Start is called. - An optional cancellation token for the body. - Defaults to Async.DefaultCancellationToken. - The created MailboxProcessor. - - - A message-processing agent which executes an asynchronous computation. - - The agent encapsulates a message queue that supports multiple-writers and - a single reader agent. Writers send messages to the agent by using the Post - method and its variations. - - The agent may wait for messages using the Receive or TryReceive methods or - scan through all available messages using the Scan or TryScan method. - - - Connects a listener function to the observable. The listener will - be invoked for each observation. The listener can be removed by - calling Dispose on the returned IDisposable object. - The function to be called for each observation. - An object that will remove the listener if disposed. - - - Permanently connects a listener function to the observable. The listener will - be invoked for each observation. - The function to be called for each observation. - - - Returns an asynchronous computation that will write the given bytes to the stream. - The buffer to write from. - An optional offset as a number of bytes in the stream. - An optional number of bytes to write to the stream. - An asynchronous computation that will write the given bytes to the stream. - Thrown when the sum of offset and count is longer than - the buffer length. - Thrown when offset or count is negative. - - - Returns an asynchronous computation that will read the given number of bytes from the stream. - The number of bytes to read. - An asynchronous computation that returns the read byte[] when run. - - - Returns an asynchronous computation that will read from the stream into the given buffer. - The buffer to read into. - An optional offset as a number of bytes in the stream. - An optional number of bytes to read from the stream. - An asynchronous computation that will read from the stream into the given buffer. - Thrown when the sum of offset and count is longer than - the buffer length. - Thrown when offset or count is negative. - - - A module of extension members providing asynchronous operations for some basic CLI types related to concurrency and I/O. - - - Returns a new event that triggers on the second and subsequent triggerings of the input event. - The Nth triggering of the input event passes the arguments from the N-1th and Nth triggering as - a pair. The argument passed to the N-1th triggering is held in hidden internal state until the - Nth triggering occurs. - The input event. - An event that triggers on pairs of consecutive values passed from the source event. - - - Runs the given function each time the given event is triggered. - The function to call when the event is triggered. - The input event. - - - Returns a new event consisting of the results of applying the given accumulating function - to successive values triggered on the input event. An item of internal state - records the current value of the state parameter. The internal state is not locked during the - execution of the accumulation function, so care should be taken that the - input IEvent not triggered by multiple threads simultaneously. - The function to update the state with each event value. - The initial state. - The input event. - An event that fires on the updated state values. - - - Returns a new event which fires on a selection of messages from the original event. - The selection function takes an original message to an optional new message. - The function to select and transform event values to pass on. - The input event. - An event that fires only when the chooser returns Some. - - - Returns a new event that listens to the original event and triggers the - first resulting event if the application of the function to the event arguments - returned a Choice1Of2, and the second event if it returns a Choice2Of2. - The function to transform event values into one of two types. - The input event. - A tuple of events. The first fires whenever splitter evaluates to Choice1of1 and - the second fires whenever splitter evaluates to Choice2of2. - - - Returns a new event that listens to the original event and triggers the - first resulting event if the application of the predicate to the event arguments - returned true, and the second event if it returned false. - The function to determine which output event to trigger. - The input event. - A tuple of events. The first is triggered when the predicate evaluates to true - and the second when the predicate evaluates to false. - - - Returns a new event that listens to the original event and triggers the resulting - event only when the argument to the event passes the given function. - The function to determine which triggers from the event to propagate. - The input event. - An event that only passes values that pass the predicate. - - - Returns a new event that passes values transformed by the given function. - The function to transform event values. - The input event. - An event that passes the transformed values. - - - Fires the output event when either of the input events fire. - The first input event. - The second input event. - An event that fires when either of the input events fire. - - - Forces the execution of this value and return its result. Same as Value. Mutual exclusion is used to - prevent other threads also computing the value. - The value of the Lazy object. - - - Creates a lazy computation that evaluates to the given value when forced. - The input value. - The created Lazy object. - - - Creates a lazy computation that evaluates to the result of the given function when forced. - The function to provide the value when needed. - The created Lazy object. - - - Extensions related to Lazy values. - - - Returns a new observable that triggers on the second and subsequent triggerings of the input observable. - The Nth triggering of the input observable passes the arguments from the N-1th and Nth triggering as - a pair. The argument passed to the N-1th triggering is held in hidden internal state until the - Nth triggering occurs. - - For each observer, the registered intermediate observing object is not thread safe. - That is, observations arising from the source must not be triggered concurrently - on different threads. - The input Observable. - An Observable that triggers on successive pairs of observations from the input Observable. - - - Creates an observer which subscribes to the given observable and which calls - the given function for each observation. - The function to be called on each observation. - The input Observable. - An object that will remove the callback if disposed. - - - Creates an observer which permanently subscribes to the given observable and which calls - the given function for each observation. - The function to be called on each observation. - The input Observable. - - - Returns an observable which, for each observer, allocates an item of state - and applies the given accumulating function to successive values arising from - the input. The returned object will trigger observations for each computed - state value, excluding the initial value. The returned object propagates - all errors arising from the source and completes when the source completes. - - For each observer, the registered intermediate observing object is not thread safe. - That is, observations arising from the source must not be triggered concurrently - on different threads. - The function to update the state with each observation. - The initial state. - The input Observable. - An Observable that triggers on the updated state values. - - - Returns an observable which chooses a projection of observations from the source - using the given function. The returned object will trigger observations x - for which the splitter returns Some x. The returned object also propagates - all errors arising from the source and completes when the source completes. - The function that returns Some for observations to be propagated - and None for observations to ignore. - The input Observable. - An Observable that only propagates some of the observations from the source. - - - Returns two observables which split the observations of the source by the - given function. The first will trigger observations x for which the - splitter returns Choice1Of2 x. The second will trigger observations - y for which the splitter returns Choice2Of2 y The splitter is - executed once for each subscribed observer. Both also propagate error - observations arising from the source and each completes when the source - completes. - The function that takes an observation an transforms - it into one of the two output Choice types. - The input Observable. - A tuple of Observables. The first triggers when splitter returns Choice1of2 - and the second triggers when splitter returns Choice2of2. - - - Returns two observables which partition the observations of the source by - the given function. The first will trigger observations for those values - for which the predicate returns true. The second will trigger observations - for those values where the predicate returns false. The predicate is - executed once for each subscribed observer. Both also propagate all error - observations arising from the source and each completes when the source - completes. - The function to determine which output Observable will trigger - a particular observation. - The input Observable. - A tuple of Observables. The first triggers when the predicate returns true, and - the second triggers when the predicate returns false. - - - Returns an observable which filters the observations of the source - by the given function. The observable will see only those observations - for which the predicate returns true. The predicate is executed once for - each subscribed observer. The returned object also propagates error - observations arising from the source and completes when the source completes. - The function to apply to observations to determine if it should - be kept. - The input Observable. - An Observable that filters observations based on filter. - - - Returns an observable which transforms the observations of the source by the - given function. The transformation function is executed once for each - subscribed observer. The returned object also propagates error observations - arising from the source and completes when the source completes. - The function applied to observations from the source. - The input Observable. - An Observable of the type specified by mapping. - - - Returns an observable for the merged observations from the sources. - The returned object propagates success and error values arising - from either source and completes when both the sources have completed. - - For each observer, the registered intermediate observing object is not - thread safe. That is, observations arising from the sources must not - be triggered concurrently on different threads. - The first Observable. - The second Observable. - An Observable that propagates information from both sources. - - - Basic operations on first class event and other observable objects. - - - Returns an asynchronous computation that, when run, will wait for a response to the given WebRequest. - An asynchronous computation that waits for response to the WebRequest. - - - A module of extension members providing asynchronous operations for some basic Web operations. - - - Creates an instance of the attribute - AbstractClassAttribute - - - Adding this attribute to class definition makes it abstract, which means it need not - implement all its methods. Instances of abstract classes may not be constructed directly. - - - The value of the attribute, indicating whether the type allows the null literal or not - - - Creates an instance of the attribute with the specified value - AllowNullLiteralAttribute - - - Creates an instance of the attribute - AllowNullLiteralAttribute - - - Adding this attribute to a type lets the 'null' literal be used for the type - within F# code. This attribute may only be added to F#-defined class or - interface types. - - - Indicates the namespace or module to be automatically opened when an assembly is referenced - or an enclosing module opened. - - - Creates an attribute used to mark a namespace or module path to be 'automatically opened' when an assembly is referenced - The namespace or module to be automatically opened when an assembly is referenced - or an enclosing module opened. - AutoOpenAttribute - - - Creates an attribute used to mark a module as 'automatically opened' when the enclosing namespace is opened - AutoOpenAttribute - - - This attribute is used for two purposes. When applied to an assembly, it must be given a string - argument, and this argument must indicate a valid module or namespace in that assembly. Source - code files compiled with a reference to this assembly are processed in an environment - where the given path is automatically opened. - - When applied to a module within an assembly, then the attribute must not be given any arguments. - When the enclosing namespace is opened in user source code, the module is also implicitly opened. - - - The value of the attribute, indicating whether the type is automatically marked serializable or not - - - Creates an instance of the attribute - Indicates whether the type should be serializable by default. - AutoSerializableAttribute - - - Adding this attribute to a type with value 'false' disables the behaviour where F# makes the - type Serializable by default. - - - Creates an instance of the attribute - CLIEventAttribute - - - Adding this attribute to a property with event type causes it to be compiled with as a CLI - metadata event, through a syntactic translation to a pair of 'add_EventName' and - 'remove_EventName' methods. - - - Creates an instance of the attribute - CLIMutableAttribute - - - Adding this attribute to a record type causes it to be compiled to a CLI representation - with a default constructor with property getters and setters. - - - Choice 2 of 2 choices - - - Choice 1 of 2 choices - - - Helper types for active patterns with 2 choices. - - - Choice 3 of 3 choices - - - Choice 2 of 3 choices - - - Choice 1 of 3 choices - - - Helper types for active patterns with 3 choices. - - - Choice 4 of 4 choices - - - Choice 3 of 4 choices - - - Choice 2 of 4 choices - - - Choice 1 of 4 choices - - - Helper types for active patterns with 4 choices. - - - Choice 5 of 5 choices - - - Choice 4 of 5 choices - - - Choice 3 of 5 choices - - - Choice 2 of 5 choices - - - Choice 1 of 5 choices - - - Helper types for active patterns with 5 choices. - - - Choice 6 of 6 choices - - - Choice 5 of 6 choices - - - Choice 4 of 6 choices - - - Choice 3 of 6 choices - - - Choice 2 of 6 choices - - - Choice 1 of 6 choices - - - Helper types for active patterns with 6 choices. - - - Choice 7 of 7 choices - - - Choice 6 of 7 choices - - - Choice 5 of 7 choices - - - Choice 4 of 7 choices - - - Choice 3 of 7 choices - - - Choice 2 of 7 choices - - - Choice 1 of 7 choices - - - Helper types for active patterns with 7 choices. - - - Creates an instance of the attribute - ClassAttribute - - - Adding this attribute to a type causes it to be represented using a CLI class. - - - Creates an instance of the attribute - ComparisonConditionalOnAttribute - - - This attribute is used to indicate a generic container type satisfies the F# 'comparison' - constraint only if a generic argument also satisfies this constraint. For example, adding - this attribute to parameter 'T on a type definition C<'T> means that a type C<X> only supports - comparison if the type X also supports comparison and all other conditions for C<X> to support - comparison are also met. The type C<'T> can still be used with other type arguments, but a type such - as C<(int -> int)> will not support comparison because the type (int -> int) is an F# function type - and does not support comparison. - - This attribute will be ignored if it is used on the generic parameters of functions or methods. - - - Indicates the number of arguments in each argument group - - - Creates an instance of the attribute - Indicates the number of arguments in each argument group. - CompilationArgumentCountsAttribute - - - This attribute is generated automatically by the F# compiler to tag functions and members - that accept a partial application of some of their arguments and return a residual function - - - Indicates the variant number of the entity, if any, in a linear sequence of elements with F# source code - - - Indicates the type definitions needed to resolve the source construct - - - Indicates the relationship between the compiled entity and F# source code - - - Indicates the sequence number of the entity, if any, in a linear sequence of elements with F# source code - - - Indicates the resource the source construct relates to - - - Creates an instance of the attribute - Indicates the type definitions needed to resolve the source construct. - CompilationMappingAttribute - - - Creates an instance of the attribute - Indicates the type of source construct. - CompilationMappingAttribute - - - Creates an instance of the attribute - Indicates the type of source construct. - CompilationMappingAttribute - - - Creates an instance of the attribute - Indicates the type of source construct. - CompilationMappingAttribute - - - This attribute is inserted automatically by the F# compiler to tag types - and methods in the generated CLI code with flags indicating the correspondence - with original source constructs. It is used by the functions in the - Microsoft.FSharp.Reflection namespace to reverse-map compiled constructs to - their original forms. It is not intended for use from user code. - - - Indicates one or more adjustments to the compiled representation of an F# type or member - - - Creates an instance of the attribute - Indicates adjustments to the compiled representation of the type or member. - CompilationRepresentationAttribute - - - This attribute is used to adjust the runtime representation for a type. - For example, it may be used to note that the null representation - may be used for a type. This affects how some constructs are compiled. - - - Compile a property as a CLI event. - - - Permit the use of null as a representation for nullary discriminators in a discriminated union. - - - append 'Module' to the end of a module whose name clashes with a type name in the same namespace. - - - Compile a member as 'instance' even if null is used as a representation for this type. - - - Compile an instance member as 'static' . - - - No special compilation representation. - - - Indicates one or more adjustments to the compiled representation of an F# type or member. - - - Indicates the name of the entity in F# source code - - - Creates an instance of the attribute - The name of the method in source. - CompilationSourceNameAttribute - - - This attribute is inserted automatically by the F# compiler to tag - methods which are given the 'CompiledName' attribute. It is not intended - for use from user code. - - - The name of the value as it appears in compiled code - - - Creates an instance of the attribute - The name to use in compiled code. - CompiledNameAttribute - - - Adding this attribute to a value or function definition in an F# module changes the name used - for the value in compiled CLI code. - - - Indicates if the construct should always be hidden in an editing environment. - - - Indicates if the message should indicate a compiler error. Error numbers less than - 10000 are considered reserved for use by the F# compiler and libraries. - - - Indicates the number associated with the message. - - - Indicates the warning message to be emitted when F# source code uses this construct - - - Indicates if the construct should always be hidden in an editing environment. - - - Indicates if the message should indicate a compiler error. Error numbers less than - 10000 are considered reserved for use by the F# compiler and libraries. - - - Creates an instance of the attribute. - - - Indicates that a message should be emitted when F# source code uses this construct. - - - Creates an instance of the attribute - CustomComparisonAttribute - - - Adding this attribute to a type indicates it is a type with a user-defined implementation of comparison. - - - Creates an instance of the attribute - CustomEqualityAttribute - - - Adding this attribute to a type indicates it is a type with a user-defined implementation of equality. - - - Indicates if the custom operation maintains the variable space of the query of computation expression through the use of a bind operation - - - Indicates if the custom operation maintains the variable space of the query of computation expression - - - Indicates the name used for the 'on' part of the custom query operator for join-like operators - - - Indicates if the custom operation is an operation similar to a zip in a sequence computation, supporting two inputs - - - Indicates if the custom operation is an operation similar to a join in a sequence computation, supporting two inputs and a correlation constraint - - - Indicates if the custom operation is an operation similar to a group join in a sequence computation, supporting two inputs and a correlation constraint, and generating a group - - - Indicates if the custom operation supports the use of 'into' immediately after the use of the operation in a query or other computation expression to consume the results of the operation - - - Get the name of the custom operation when used in a query or other computation expression - - - Indicates if the custom operation maintains the variable space of the query of computation expression through the use of a bind operation - - - Indicates if the custom operation maintains the variable space of the query of computation expression - - - Indicates the name used for the 'on' part of the custom query operator for join-like operators - - - Indicates if the custom operation is an operation similar to a zip in a sequence computation, supporting two inputs - - - Indicates if the custom operation is an operation similar to a join in a sequence computation, supporting two inputs and a correlation constraint - - - Indicates if the custom operation is an operation similar to a group join in a sequence computation, supporting two inputs and a correlation constraint, and generating a group - - - Indicates if the custom operation supports the use of 'into' immediately after the use of the operation in a query or other computation expression to consume the results of the operation - - - Creates an instance of the attribute - CustomOperationAttribute - - - - Indicates that a member on a computation builder type is a custom query operator, - and indicates the name of that operator. - - - - The value of the attribute, indicating whether the type has a default augmentation or not - - - Creates an instance of the attribute - Indicates whether to generate helper members on the CLI class representing a discriminated - union. - DefaultAugmentationAttribute - - - Adding this attribute to a discriminated union with value false - turns off the generation of standard helper member tester, constructor - and accessor members for the generated CLI class for that type. - - - Indicates if a constraint is asserted that the field type supports 'null' - - - Creates an instance of the attribute - Indicates whether to assert that the field type supports null. - DefaultValueAttribute - - - Creates an instance of the attribute - DefaultValueAttribute - - - Adding this attribute to a field declaration means that the field is - not initialized. During type checking a constraint is asserted that the field type supports 'null'. - If the 'check' value is false then the constraint is not asserted. - - - Creates an instance of the attribute - EntryPointAttribute - - - Adding this attribute to a function indicates it is the entrypoint for an application. - If this attribute is not specified for an EXE then the initialization implicit in the - module bindings in the last file in the compilation sequence are used as the entrypoint. - - - Creates an instance of the attribute - EqualityConditionalOnAttribute - - - This attribute is used to indicate a generic container type satisfies the F# 'equality' - constraint only if a generic argument also satisfies this constraint. For example, adding - this attribute to parameter 'T on a type definition C<'T> means that a type C<X> only supports - equality if the type X also supports equality and all other conditions for C<X> to support - equality are also met. The type C<'T> can still be used with other type arguments, but a type such - as C<(int -> int)> will not support equality because the type (int -> int) is an F# function type - and does not support equality. - - This attribute will be ignored if it is used on the generic parameters of functions or methods. - - - Indicates the warning message to be emitted when F# source code uses this construct - - - Creates an instance of the attribute - The warning message to be emitted when code uses this construct. - ExperimentalAttribute - - - This attribute is used to tag values that are part of an experimental library - feature. - - - Invoke an F# first class function value with two curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The function result. - - - Invoke an F# first class function value with three curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The third arg. - The function result. - - - Invoke an F# first class function value with four curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The third arg. - The fourth arg. - The function result. - - - Invoke an F# first class function value with five curried arguments. In some cases this - will result in a more efficient application than applying the arguments successively. - The input function. - The first arg. - The second arg. - The third arg. - The fourth arg. - The fifth arg. - The function result. - - - Invoke an F# first class function value with one argument - - 'U - - - Construct an instance of an F# first class function value - The created F# function. - - - The CLI type used to represent F# function values. This type is not - typically used directly, though may be used from other CLI languages. - - - The release number of the F# version associated with the attribute - - - The minor version number of the F# version associated with the attribute - - - The major version number of the F# version associated with the attribute - - - Creates an instance of the attribute - The major version number. - The minor version number. - The release number. - FSharpInterfaceDataVersionAttribute - - - This attribute is added to generated assemblies to indicate the - version of the data schema used to encode additional F# - specific information in the resource attached to compiled F# libraries. - - - Specialize the type function at a given type - The specialized type. - - - Construct an instance of an F# first class type function value - FSharpTypeFunc - - - The CLI type used to represent F# first-class type function values. This type is for use - by compiled F# code. - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - Tuple of values generated by scan or match. - - - Convert the given Action delegate object to an F# function value - The input action. - The F# function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - A utility function to convert function values from tupled to curried form - The input tupled function. - The output curried function. - - - Helper functions for converting F# first class function values to and from CLI representaions - of functions using delegates. - - - Creates an instance of the attribute - GeneralizableValueAttribute - - - Adding this attribute to a non-function value with generic parameters indicates that - uses of the construct can give rise to generic code through type inference. - - - Creates an instance of the attribute - InterfaceAttribute - - - Adding this attribute to a type causes it to be represented using a CLI interface. - - - Creates an instance of the attribute - LiteralAttribute - - - Adding this attribute to a value causes it to be compiled as a CLI constant literal. - - - Creates an instance of the attribute - MeasureAnnotatedAbbreviationAttribute - - - Adding this attribute to a type causes it to be interpreted as a refined type, currently limited to measure-parameterized types. - This may only be used under very limited conditions. - - - Creates an instance of the attribute - MeasureAttribute - - - Adding this attribute to a type causes it to be interpreted as a unit of measure. - This may only be used under very limited conditions. - - - Creates an instance of the attribute - NoComparisonAttribute - - - Adding this attribute to a type indicates it is a type where comparison is an abnormal operation. - This means that the type does not satisfy the F# 'comparison' constraint. Within the bounds of the - F# type system, this helps ensure that the F# generic comparison function is not instantiated directly - at this type. The attribute and checking does not constrain the use of comparison with base or child - types of this type. - - - Creates an instance of the attribute - NoDynamicInvocationAttribute - - - This attribute is used to tag values that may not be dynamically invoked at runtime. This is - typically added to inlined functions whose implementations include unverifiable code. It - causes the method body emitted for the inlined function to raise an exception if - dynamically invoked, rather than including the unverifiable code in the generated - assembly. - - - Creates an instance of the attribute - NoEqualityAttribute - - - Adding this attribute to a type indicates it is a type where equality is an abnormal operation. - This means that the type does not satisfy the F# 'equality' constraint. Within the bounds of the - F# type system, this helps ensure that the F# generic equality function is not instantiated directly - at this type. The attribute and checking does not constrain the use of comparison with base or child - types of this type. - - - The representation of "Value of type 'T" - The input value. - An option representing the value. - - - The representation of "No value" - - - Get the value of a 'Some' option. A NullReferenceException is raised if the option is 'None'. - - - Create an option value that is a 'None' value. - - - Return 'true' if the option is a 'Some' value. - - - Return 'true' if the option is a 'None' value. - - - Create an option value that is a 'Some' value. - The input value - An option representing the value. - - - The type of optional values. When used from other CLI languages the - empty option is the null value. - - Use the constructors Some and None to create values of this type. - Use the values in the Option module to manipulate values of this type, - or pattern match against the values directly. - - None values will appear as the value null to other CLI languages. - Instance methods on this type will appear as static methods to other CLI languages - due to the use of null as a value representation. - - - Creates an instance of the attribute - OptionalArgumentAttribute - - - This attribute is added automatically for all optional arguments. - - - The raw text of the format string. - - - Construct a format string - The input string. - The PrintfFormat containing the formatted result. - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - - - Construct a format string - The input string. - The created format string. - - - Type of a formatting expression. - Function type generated by printf. - Type argument passed to %a formatters - Value generated by the overall printf action (e.g. sprint generates a string) - Value generated after post processing (e.g. failwithf generates a string internally then raises an exception) - Tuple of values generated by scan or match. - - - Creates an instance of the attribute - ProjectionParameterAttribute - - - Indicates that, when a custom operator is used in a computation expression, - a parameter is automatically parameterized by the variable space of the computation expression - - - - The current value of the reference cell - - - - The current value of the reference cell - - - The current value of the reference cell - - - The type of mutable references. Use the functions [:=] and [!] to get and - set values of this type. - - - Creates an instance of the attribute - ReferenceEqualityAttribute - - - Adding this attribute to a record or union type disables the automatic generation - of overrides for 'System.Object.Equals(obj)', 'System.Object.GetHashCode()' - and 'System.IComparable' for the type. The type will by default use reference equality. - - - The value of the attribute, indicating whether to include the evaluated value of the definition as the outer node of the quotation - - - Creates an instance of the attribute - Indicates whether to include the evaluated value of the definition as the outer node of the quotation - ReflectedDefinitionAttribute - - - Creates an instance of the attribute - ReflectedDefinitionAttribute - - - Adding this attribute to the let-binding for the definition of a top-level - value makes the quotation expression that implements the value available - for use at runtime. - - - Creates an instance of the attribute - RequireQualifiedAccessAttribute - - - This attribute is used to indicate that references to the elements of a module, record or union - type require explicit qualified access. - - - Creates an instance of the attribute - RequiresExplicitTypeArgumentsAttribute - - - Adding this attribute to a type, value or member requires that - uses of the construct must explicitly instantiate any generic type parameters. - - - The value of the attribute, indicating whether the type is sealed or not. - - - Creates an instance of the attribute - Indicates whether the class is sealed. - SealedAttribute - - - Creates an instance of the attribute. - The created attribute. - - - Adding this attribute to class definition makes it sealed, which means it may not - be extended or implemented. - - - Indicates that the compiled entity had private or internal representation in F# source code. - - - The mask of values related to the kind of the compiled entity. - - - Indicates that the compiled entity is part of the representation of an F# value declaration. - - - Indicates that the compiled entity is part of the representation of an F# union case declaration. - - - Indicates that the compiled entity is part of the representation of an F# module declaration. - - - Indicates that the compiled entity is part of the representation of an F# closure. - - - Indicates that the compiled entity is part of the representation of an F# exception declaration. - - - Indicates that the compiled entity is part of the representation of an F# record or union case field declaration. - - - Indicates that the compiled entity is part of the representation of an F# class or other object type declaration. - - - Indicates that the compiled entity is part of the representation of an F# record type declaration. - - - Indicates that the compiled entity is part of the representation of an F# union type declaration. - - - Indicates that the compiled entity has no relationship to an element in F# source code. - - - Indicates the relationship between a compiled entity in a CLI binary and an element in F# source code. - - - Creates an instance of the attribute - StructAttribute - - - Adding this attribute to a type causes it to be represented using a CLI struct. - - - Creates an instance of the attribute - StructuralComparisonAttribute - - - Adding this attribute to a record, union, exception, or struct type confirms the - automatic generation of implementations for 'System.IComparable' for the type. - - - Creates an instance of the attribute - StructuralEqualityAttribute - - - Adding this attribute to a record, union or struct type confirms the automatic - generation of overrides for 'System.Object.Equals(obj)' and - 'System.Object.GetHashCode()' for the type. - - - Indicates the text to display by default when objects of this type are displayed - using '%A' printf formatting patterns and other two-dimensional text-based display - layouts. - - - Creates an instance of the attribute - Indicates the text to display when using the '%A' printf formatting. - StructuredFormatDisplayAttribute - - - This attribute is used to mark how a type is displayed by default when using - '%A' printf formatting patterns and other two-dimensional text-based display layouts. - In this version of F# valid values are of the form PreText {PropertyName1} PostText {PropertyName2} ... {PropertyNameX} PostText. - The property names indicate properties to evaluate and to display instead of the object itself. - - - The type 'unit', which has only one value "()". This value is special and - always uses the representation 'null'. - - - Creates an instance of the attribute - UnverifiableAttribute - - - This attribute is used to tag values whose use will result in the generation - of unverifiable code. These values are inevitably marked 'inline' to ensure that - the unverifiable constructs are not present in the actual code for the F# library, - but are rather copied to the source code of the caller. - - - Creates an instance of the attribute - VolatileFieldAttribute - - - Adding this attribute to an F# mutable binding causes the "volatile" - prefix to be used for all accesses to the field. - - - Thirty-two dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Thirty-one dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Thirty dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-nine dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-eight dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-seven dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-six dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-five dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-four dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-three dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-two dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty-one dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twenty dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Nineteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Eighteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Seventeen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Sixteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Fifteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Fourteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Thirteen dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Twelve dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Eleven dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Ten dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Nine dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Eight dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Seven dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Six dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Five dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - - Four dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - Use the values in the Array4D module - to manipulate values of this type, or the notation arr.[x1,x2,x3,x4] to get and set array - values. - - - Three dimensional arrays, typically zero-based. Non-zero-based arrays - can be created using methods on the System.Array type. - - Use the values in the Array3D module - to manipulate values of this type, or the notation arr.[x1,x2,x3] to get and set array - values. - - - Two dimensional arrays, typically zero-based. - - Use the values in the Array2D module - to manipulate values of this type, or the notation arr.[x,y] to get/set array - values. - - Non-zero-based arrays can also be created using methods on the System.Array type. - - - Single dimensional, zero-based arrays, written int[], string[] etc. - Use the values in the Array module to manipulate values - of this type, or the notation arr.[x] to get/set array - values. - - - Single dimensional, zero-based arrays, written int[], string[] etc. - - Use the values in the Array module to manipulate values - of this type, or the notation arr.[x] to get/set array - values. - - - An abbreviation for the CLI type System.Boolean. - - - Represents a managed pointer in F# code. - - - An abbreviation for the CLI type System.Byte. - - - An abbreviation for the CLI type System.Char. - - - An abbreviation for the CLI type System.Decimal. - - - The type of decimal numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Decimal. - - - An abbreviation for the CLI type System.Double. - - - An abbreviation for the CLI type System.Exception. - - - An abbreviation for the CLI type System.Double. - - - An abbreviation for the CLI type System.Single. - - - The type of floating point numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Single. - - - The type of floating point numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Double. - - - This type is for internal use by the F# code generator. - - - An abbreviation for the CLI type System.Int32. - - - An abbreviation for the CLI type System.Int16. - - - The type of 16-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Int16. - - - An abbreviation for the CLI type System.Int32. - - - An abbreviation for the CLI type System.Int64. - - - The type of 64-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Int64. - - - An abbreviation for the CLI type System.SByte. - - - The type of 32-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.Int32. - - - An abbreviation for the CLI type System.IntPtr. - - - Represents an unmanaged pointer in F# code. - - This type should only be used when writing F# code that interoperates - with native code. Use of this type in F# code may result in - unverifiable code being generated. Conversions to and from the - nativeint type may be required. Values of this type can be generated - by the functions in the NativeInterop.NativePtr module. - - - An abbreviation for the CLI type System.Object. - - - The type of optional values. When used from other CLI languages the - empty option is the null value. - - Use the constructors Some and None to create values of this type. - Use the values in the Option module to manipulate values of this type, - or pattern match against the values directly. - - 'None' values will appear as the value null to other CLI languages. - Instance methods on this type will appear as static methods to other CLI languages - due to the use of null as a value representation. - - - The type of mutable references. Use the functions [:=] and [!] to get and - set values of this type. - - - An abbreviation for the CLI type System.SByte. - - - The type of 8-bit signed integer numbers, annotated with a unit of measure. The unit - of measure is erased in compiled code and when values of this type - are analyzed using reflection. The type is representationally equivalent to - System.SByte. - - - An abbreviation for the CLI type System.Single. - - - An abbreviation for the CLI type System.String. - - - An abbreviation for the CLI type System.UInt16. - - - An abbreviation for the CLI type System.UInt32. - - - An abbreviation for the CLI type System.UInt64. - - - An abbreviation for the CLI type System.Byte. - - - An abbreviation for the CLI type System.UIntPtr. - - - The type 'unit', which has only one value "()". This value is special and - always uses the representation 'null'. - - - Non-exhaustive match failures will raise the MatchFailureException exception - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - A new enumerator for the sequence. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - A reference to the sequence. - - A 0, 1, and 2 respectively indicate Stop, Yield, and Goto conditions for the sequence generator. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - A new sequence generator for the expression. - - - The F# compiler emits implementations of this type for compiled sequence expressions. - - - - Namespace name the provider injects types into. - - - - - Compilers call this method to query a type provider for a type name. - - Resolver should return a type called name in namespace NamespaceName or null if the type is unknown. - - - - - - The top-level types - - - - - - The sub-namespaces in this namespace. An optional member to prevent generation of namespaces until an outer namespace is explored. - - - - - Represents a namespace provided by a type provider component. - - - - - Triggered when an assumption changes that invalidates the resolutions so far reported by the provider - - - - - Triggered when an assumption changes that invalidates the resolutions so far reported by the provider - - - - - Triggered when an assumption changes that invalidates the resolutions so far reported by the provider - - - - - Get the static parameters for a provided type. - - A type returned by GetTypes or ResolveTypeName - - - - - Namespace name the this TypeProvider injects types into. - - - - - Called by the compiler to ask for an Expression tree to replace the given MethodBase with. - - MethodBase that was given to the compiler by a type returned by a GetType(s) call. - Expressions that represent the parameters to this call. - An expression that the compiler will use in place of the given method base. - - - - Get the physical contents of the given logical provided assembly. - - - - - Apply static arguments to a provided type that accepts static arguments. - - The provider must return a type with the given mangled name. - the provided type definition which has static parameters - the full path of the type, including encoded representations of static parameters - the static parameters, indexed by name - - - - - Represents an instantiation of a type provider component. - - - - - Get the static parameters for a provided method. - - A method returned by GetMethod on a provided type - The static parameters of the provided method, if any - - - - Apply static arguments to a provided method that accepts static arguments. - - The provider must return a provided method with the given mangled name. - the provided method definition which has static parameters - the full name of the method that must be returned, including encoded representations of static parameters - the values of the static parameters, indexed by name - The provided method definition corresponding to the given static parameter values - - - - Represents additional, optional information for a type provider component - - - - Represents the inverse of a measure expressions when returned as a generic argument of a provided type. - - - Represents the '1' measure expression when returned as a generic argument of a provided type. - - - Represents the product of two measure expressions when returned as a generic argument of a provided type. - - - Creates an instance of the attribute - TypeProviderAssemblyAttribute - The name of the design-time assembly for this type provider. - - - Creates an instance of the attribute - TypeProviderAssemblyAttribute - - - Place attribute on runtime assembly to indicate that there is a corresponding design-time - assembly that contains a type provider. Runtime and designer assembly may be the same. - - - Creates an instance of the attribute - TypeProviderAttribute - - - Place on a class that implements ITypeProvider to extend the compiler - - - - Get the full path to use for temporary files for the type provider instance. - - - - - version of referenced system runtime assembly - - - - - Get the full path to referenced assembly that caused this type provider instance to be created. - - - - - Get the full path to use to resolve relative paths in any file name arguments given to the type provider instance. - - - - - Get the referenced assemblies for the type provider instance. - - - - - Indicates if the type provider host responds to invalidation events for type provider instances. - - - - - Indicates if the type provider instance is used in an environment which executes provided code such as F# Interactive. - - - - - Get the full path to use for temporary files for the type provider instance. - - - - - version of referenced system runtime assembly - - - - - Get the full path to referenced assembly that caused this type provider instance to be created. - - - - - Get the full path to use to resolve relative paths in any file name arguments given to the type provider instance. - - - - - Get the referenced assemblies for the type provider instance. - - - - - Indicates if the type provider host responds to invalidation events for type provider instances. - - - - - Indicates if the type provider instance is used in an environment which executes provided code such as F# Interactive. - - - - - Checks if given type exists in target system runtime library - - - - - If the class that implements ITypeProvider has a constructor that accepts TypeProviderConfig - then it will be constructed with an instance of TypeProviderConfig. - - - - Creates an instance of the attribute - TypeProviderEditorHideMethodsAttribute - - - Indicates that a code editor should hide all System.Object methods from the intellisense menus for instances of a provided type - - - Additional type attribute flags related to provided types - - - Creates an instance of the attribute - TypeProviderXmlDocAttribute - - - - The TypeProviderXmlDocAttribute attribute can be added to types and members. - The language service will display the CommentText property from the attribute - in the appropriate place when the user hovers over a type or member. - - - - Creates an anonymous event with the given handlers. - - A function to handle adding a delegate for the event to trigger. - A function to handle removing a delegate that the event triggers. - A function to produce the delegate type the event can trigger. - - The initialized event. - - - The F# compiler emits calls to this function to implement the use operator for F# sequence - expressions. - - The resource to be used and disposed. - The input sequence. - - The result sequence. - - - The F# compiler emits calls to this function to implement the compiler-intrinsic - conversions from untyped System.Collections.IEnumerable sequences to typed sequences. - - An initializer function. - A function to iterate and test if end of sequence is reached. - A function to retrieve the current element. - - The resulting typed sequence. - - - The F# compiler emits calls to this function to - implement the try/finally operator for F# sequence expressions. - - The input sequence. - A computation to be included in an enumerator's Dispose method. - - The result sequence. - - - The F# compiler emits calls to this function to - implement the while operator for F# sequence expressions. - - A function that indicates whether iteration should continue. - The input sequence. - - The result sequence. - - - A group of functions used as part of the compiled representation of F# sequence expressions. - - - Builds a query using query syntax and operators. - - - An active pattern to force the execution of values of type Lazy<_>. - - - Special prefix operator for splicing untyped expressions into quotation holes. - - - Special prefix operator for splicing typed expressions into quotation holes. - - - Builds a 2D array from a sequence of sequences of elements. - - - Builds a read-only lookup table from a sequence of key/value pairs. The key objects are indexed using generic hashing and equality. - - - Converts the argument to signed byte. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using SByte.Parse() with InvariantCulture settings. - Otherwise the operation requires and invokes a ToSByte method on the input type. - - - Converts the argument to byte. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Byte.Parse() on strings and otherwise requires a ToByte method on the input type. - - - Converts the argument to 64-bit float. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Double.Parse() with InvariantCulture settings. Otherwise the operation requires and invokes a ToDouble method on the input type. - - - Converts the argument to 32-bit float. - This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Single.Parse() with InvariantCulture settings. Otherwise the operation requires and invokes a ToSingle method on the input type. - - - Builds an aysnchronous workflow using computation expression syntax. - - - Builds a set from a sequence of objects. The objects are indexed using generic comparison. - The input sequence of elements. - The created set. - - - Print to a file using the given format, and add a newline. - The file TextWriter. - The formatter. - The formatted result. - - - Print to a file using the given format. - The file TextWriter. - The formatter. - The formatted result. - - - Print to a string buffer and raise an exception with the given - result. Helper printers must return strings. - The formatter. - The formatted result. - - - Print to a string using the given format. - The formatter. - The formatted result. - - - Converts the argument to signed byte. - This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using SByte.Parse() with InvariantCulture settings. - Otherwise the operation requires and invokes a ToSByte method on the input type. - - - Converts the argument to byte. - This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using Byte.Parse() on strings and otherwise requires a ToByte method on the input type. - - - Divides a value by an integer. - The input value. - The input int. - The division result. - - - Resolves to the value 'one' for any primitive numeric type or any type with a static member called 'One' - - - Resolves to the zero value for any primitive numeric type or any type with a static member called 'Zero' - - - A compiler intrinsic that implements dynamic invocations for the DivideByInt primitive. - - - A compiler intrinsic that implements dynamic invocations to the checked '*' operator. - - - A compiler intrinsic that implements dynamic invocations to the '*' operator. - - - A compiler intrinsic that implements dynamic invocations to the checked '+' operator. - - - A compiler intrinsic that implements dynamic invocations to the '+' operator. - - - Resolves to the value 'one' for any primitive numeric type or any type with a static member called 'One'. - - - Resolves to the zero value for any primitive numeric type or any type with a static member called 'Zero'. - - - Parse an uint64 according to the rules used by the overloaded 'uint64' conversion operator when applied to strings - The input string. - The parsed value. - - - Parse an int64 according to the rules used by the overloaded 'int64' conversion operator when applied to strings - The input string. - The parsed value. - - - Parse an uint32 according to the rules used by the overloaded 'uint32' conversion operator when applied to strings - The input string. - The parsed value. - - - Parse an int32 according to the rules used by the overloaded 'int32' conversion operator when applied to strings - The input string. - The parsed value. - - - Creates an sbyte value with units-of-measure - The input sbyte. - The sbyte with units-of-measure. - - - Creates an int16 value with units-of-measure - The input int16. - The int16 with units-of-measure. - - - Creates an int64 value with units-of-measure - The input int64. - The int64 with units of measure. - - - Creates an int32 value with units-of-measure - The input int. - The int with units of measure. - - - Creates a decimal value with units-of-measure - The input decimal. - The decimal with units of measure. - - - Creates a float32 value with units-of-measure - The input float. - The float with units-of-measure. - - - Creates a float value with units-of-measure - The input float. - The float with units-of-measure. - - - Get the underlying value for an enum value - The input enum. - The enumeration as a value. - - - Build an enum value from an underlying value - The input value. - The value as an enumeration. - - - Recursively hash a part of a value according to its structure. - The comparison function. - The input object. - The hashed value. - - - Hash a value according to its structure. Use the given limit to restrict the hash when hashing F# - records, lists and union types. - The limit on the number of nodes. - The input object. - The hashed value. - - - Hash a value according to its structure. This hash is not limited by an overall node count when hashing F# - records, lists and union types. - The input object. - The hashed value. - - - Make an F# comparer object for the given type - - - Make an F# hash/equality object for the given type - - - Make an F# hash/equality object for the given type using node-limited hashing when hashing F# - records, lists and union types. - The input limit on the number of nodes. - System.Collections.Generic.IEqualityComparer<'T> - - - Make an F# hash/equality object for the given type - - - Make an F# comparer object for the given type, where it can be null if System.Collections.Generic.Comparer<'T>.Default - - - Make an F# comparer object for the given type - - - A static F# comparer object - - - Return an F# comparer object suitable for hashing and equality. This hashing behaviour - of the returned comparer is not limited by an overall node count when hashing F# - records, lists and union types. This equality comparer has equivalence - relation semantics ([nan] = [nan]). - - - Return an F# comparer object suitable for hashing and equality. This hashing behaviour - of the returned comparer is not limited by an overall node count when hashing F# - records, lists and union types. - - - The physical hash. Hashes on the object identity, except for value types, - where we hash on the contents. - The input object. - The hashed value. - - - Reference/physical equality. - True if the inputs are reference-equal, false otherwise. - The first value. - The second value. - The result of the comparison. - - - Take the maximum of two values structurally according to the order given by GenericComparison - The first value. - The second value. - The maximum value. - - - Take the minimum of two values structurally according to the order given by GenericComparison - The first value. - The second value. - The minimum value. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values. May be called as a recursive case from an implementation of System.IComparable to - ensure consistent NaN comparison semantics. - The function to compare the values. - The first value. - The second value. - The result of the comparison. - - - Compare two values - The first value. - The second value. - The result of the comparison. - - - Compare two values for equality - - The first value. - The second value. - The result of the comparison. - - - Compare two values for equality using equivalence relation semantics ([nan] = [nan]) - The first value. - The second value. - The result of the comparison. - - - Compare two values for equality using partial equivalence relation semantics ([nan] <> [nan]) - The first value. - The second value. - The result of the comparison. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - A primitive entry point used by the F# compiler for optimization purposes. - - - The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs - - - - The standard overloaded associative (4-indexed) mutation operator - - - - The standard overloaded associative (3-indexed) mutation operator - - - The standard overloaded associative (2-indexed) mutation operator - - - The standard overloaded associative (indexed) mutation operator - - - The standard overloaded associative (4-indexed) lookup operator - - - The standard overloaded associative (3-indexed) lookup operator - - - The standard overloaded associative (2-indexed) lookup operator - - - The standard overloaded associative (indexed) lookup operator - - - A compiler intrinsic for checking initialization soundness of recursive bindings - - - A compiler intrinsic for checking initialization soundness of recursive static bindings - - - A compiler intrinsic for checking initialization soundness of recursive bindings - - - A compiler intrinsic for the efficient compilation of sequence expressions - - - This function implements parsing of decimal constants - - - This function implements calls to default constructors - acccessed by 'new' constraints. - - - Primitive used by pattern match compilation - - - A compiler intrinsic that implements the ':?' operator - - - A compiler intrinsic that implements the ':?' operator - - - A compiler intrinsic that implements the ':?>' operator - - - A compiler intrinsic that implements the ':?>' operator - - - The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs - - - Address-of. Uses of this value may result in the generation of unverifiable code. - The input object. - The unmanaged pointer. - - - Address-of. Uses of this value may result in the generation of unverifiable code. - The input object. - The managed pointer. - - - Binary 'or'. When used as a binary operator the right hand value is evaluated only on demand - The first value. - The second value. - The result of the operation. - - - Binary 'or'. When used as a binary operator the right hand value is evaluated only on demand. - - - Binary 'and'. When used as a binary operator the right hand value is evaluated only on demand - The first value. - The second value. - The result of the operation. - - - Binary 'and'. When used as a binary operator the right hand value is evaluated only on demand. - - - The F# compiler emits calls to some of the functions in this module as part of the compiled form of some language constructs - - - For compiler use only - - - Language primitives associated with the F# language - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - - Provides a default implementations of F# numeric literal syntax for literals fo the form 'dddI' - - - - An active pattern to match values of type System.Collections.Generic.KeyValuePair - The input key/value pair. - A tuple containing the key and value. - - - Converts the argument to character. Numeric inputs are converted according to the UTF-16 - encoding for characters. String inputs must be exactly one character long. For other - input types the operation requires an appropriate static conversion method on the input type. - The input value. - The converted char. - - - Converts the argument to System.Decimal using a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted decimal. - - - Converts the argument to a string using ToString. - - For standard integer and floating point values the ToString conversion - uses CultureInfo.InvariantCulture. - The input value. - The converted string. - - - Converts the argument to unsigned native integer using a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted unativeint - - - Converts the argument to signed native integer. This is a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted nativeint - - - Converts the argument to 64-bit float. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Double.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float - - - Converts the argument to 32-bit float. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Single.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float32 - - - Converts the argument to unsigned 64-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint64 - - - Converts the argument to signed 64-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int64 - - - Converts the argument to unsigned 32-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint32 - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int32 - - - Converts the argument to a particular enum type. - The input value. - The converted enum type. - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int - - - Converts the argument to unsigned 16-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using UInt16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint16 - - - Converts the argument to signed 16-bit integer. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Int16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int16 - - - Converts the argument to signed byte. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using SByte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to byte. This is a direct conversion for all - primitive numeric types. For strings, the input is converted using Byte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - Overloaded power operator. If n > 0 then equivalent to x*...*x for n occurrences of x. - The input base. - The input exponent. - The base raised to the exponent. - - - Overloaded power operator. - The input base. - The input exponent. - The base raised to the exponent. - - - Hyperbolic tangent of the given number - The input value. - The hyperbolic tangent of the input. - - - Tangent of the given number - The input value. - The tangent of the input. - - - Hyperbolic sine of the given number - The input value. - The hyperbolic sine of the input. - - - Sine of the given number - The input value. - The sine of the input. - - - Hyperbolic cosine of the given number - The input value. - The hyperbolic cosine of the input. - - - Cosine of the given number - The input value. - The cosine of the input. - - - Square root of the given number - The input value. - The square root of the input. - - - Logarithm to base 10 of the given number - The input value. - The logarithm to base 10 of the input. - - - Natural logarithm of the given number - The input value. - The natural logarithm of the input. - - - Round the given number - The input value. - The nearest integer to the input value. - - - Sign of the given number - The input value. - -1, 0, or 1 depending on the sign of the input. - - - Floor of the given number - The input value. - The floor of the input. - - - Exponential of the given number - The input value. - The exponential of the input. - - - Ceiling of the given number - The input value. - The ceiling of the input. - - - Inverse tangent of x/y where x and y are specified separately - The y input value. - The x input value. - The inverse tangent of the input ratio. - - - Inverse tangent of the given number - The input value. - The inverse tangent of the input. - - - Inverse sine of the given number - The input value. - The inverse sine of the input. - - - Inverse cosine of the given number - The input value. - The inverse cosine of the input. - - - Absolute value of the given number. - The input value. - The absolute value of the input. - - - A generic hash function. This function has the same behaviour as 'hash', - however the default structural hashing for F# union, record and tuple - types stops when the given limit of nodes is reached. The exact behaviour of - the function can be adjusted on a type-by-type basis by implementing - GetHashCode for each type. - The limit of nodes. - The input object. - The computed hash. - - - A generic hash function, designed to return equal hash values for items that are - equal according to the "=" operator. By default it will use structural hashing - for F# union, record and tuple types, hashing the complete contents of the - type. The exact behaviour of the function can be adjusted on a - type-by-type basis by implementing GetHashCode for each type. - The input object. - The computed hash. - - - Returns the internal size of a type in bytes. For example, sizeof<int> returns 4. - - - Generate a System.Type representation for a type definition. If the - input type is a generic type instantiation then return the - generic type definition associated with all such instantiations. - - - An internal, library-only compiler intrinsic for compile-time - generation of a RuntimeMethodHandle. - - - Generate a System.Type runtime representation of a static type. - - - Clean up resources associated with the input object after the completion of the given function. - Cleanup occurs even when an exception is raised by the protected - code. - The resource to be disposed after action is called. - The action that accepts the resource. - The resulting value. - - - Execute the function as a mutual-exclusion region using the input value as a lock. - The object to be locked. - The action to perform during the lock. - The resulting value. - - - The standard overloaded skip range operator, e.g. [n..skip..m] for lists, seq {n..skip..m} for sequences - The start value of the range. - The step value of the range. - The end value of the range. - The sequence spanning the range using the specified step size. - - - The standard overloaded range operator, e.g. [n..m] for lists, seq {n..m} for sequences - The start value of the range. - The end value of the range. - The sequence spanning the range. - - - Equivalent to System.Single.NaN - - - Equivalent to System.Single.PositiveInfinity - - - Equivalent to System.Double.NaN - - - Equivalent to System.Double.PositiveInfinity - - - Builds a sequence using sequence expression syntax - The input sequence. - The result sequence. - - - Negate a logical value. not true equals false and not false equals true - The value to negate. - The result of the negation. - - - Concatenate two lists. - The first list. - The second list. - The concatenation of the lists. - - - Increment a mutable reference cell containing an integer - The reference cell. - - - Decrement a mutable reference cell containing an integer - The reference cell. - - - Dereference a mutable reference cell - The cell to dereference. - The value contained in the cell. - - - Assign to a mutable reference cell - The cell to mutate. - The value to set inside the cell. - - - Create a mutable reference cell - The value to contain in the cell. - The created reference cell. - - - The identity function - The input value. - The same value. - - - Throw a System.InvalidOperationException exception - The exception message. - The result value. - - - Throw a System.ArgumentNullException exception - The argument name. - The result value. - - - Throw a System.ArgumentException exception with - the given argument name and message. - The argument name. - The exception message. - The result value. - - - Throw a System.Exception exception. - The exception message. - The result value. - - - Determines whether the given value is null. - The value to check. - True when value is null, false otherwise. - - - Try to unbox a strongly typed value. - The boxed value. - The unboxed result as an option. - - - Boxes a strongly typed value. - The value to box. - The boxed object. - - - Unboxes a strongly typed value. - The boxed value. - The unboxed result. - - - Ignore the passed value. This is often used to throw away results of a computation. - The value to ignore. - - - Minimum based on generic comparison - The first value. - The second value. - The minimum value. - - - Maximum based on generic comparison - The first value. - The second value. - The maximum value. - - - Generic comparison. - The first value. - The second value. - The result of the comparison. - - - Return the second element of a tuple, snd (a,b) = b. - The input tuple. - The second value. - - - Return the first element of a tuple, fst (a,b) = a. - The input tuple. - The first value. - - - Matches System.Exception objects whose runtime type is precisely System.Exception - The input exception. - A string option. - - - Builds a System.Exception object. - The message for the Exception. - A System.Exception. - - - Rethrows an exception. This should only be used when handling an exception - The result value. - - - Rethrows an exception. This should only be used when handling an exception - The result value. - - - Raises an exception - The exception to raise. - The result value. - - - Concatenate two strings. The operator '+' may also be used. - - - Used to specify a default value for an optional argument in the implementation of a function - An option representing the argument. - The default value of the argument. - The argument value. If it is None, the defaultValue is returned. - - - Apply a function to three values, the values being a triple on the right, the function on the left - The function. - The first argument. - The second argument. - The third argument. - The function result. - - - Apply a function to two values, the values being a pair on the right, the function on the left - The function. - The first argument. - The second argument. - The function result. - - - Apply a function to a value, the value being on the right, the function on the left - The function. - The argument. - The function result. - - - Apply a function to three values, the values being a triple on the left, the function on the right - The first argument. - The second argument. - The third argument. - The function. - The function result. - - - Apply a function to two values, the values being a pair on the left, the function on the right - The first argument. - The second argument. - The function. - The function result. - - - Apply a function to a value, the value being on the left, the function on the right - The argument. - The function. - The function result. - - - Compose two functions, the function on the right being applied first - The second function to apply. - The first function to apply. - The composition of the input functions. - - - Compose two functions, the function on the left being applied first - The first function to apply. - The second function to apply. - The composition of the input functions. - - - Structural inequality - The first parameter. - The second parameter. - The result of the comparison. - - - Structural equality - The first parameter. - The second parameter. - The result of the comparison. - - - Structural less-than-or-equal comparison - The first parameter. - The second parameter. - The result of the comparison. - - - Structural greater-than-or-equal - The first parameter. - The second parameter. - The result of the comparison. - - - Structural greater-than - The first parameter. - The second parameter. - The result of the comparison. - - - Structural less-than comparison - The first parameter. - The second parameter. - The result of the comparison. - - - Overloaded prefix-plus operator - The input value. - The result of the operation. - - - Overloaded bitwise-NOT operator - The input value. - The result of the operation. - - - Overloaded byte-shift right operator by a specified number of bits - The input value. - The amount to shift. - The result of the operation. - - - Overloaded byte-shift left operator by a specified number of bits - The input value. - The amount to shift. - The result of the operation. - - - Overloaded bitwise-XOR operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded bitwise-OR operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded bitwise-AND operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded modulo operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded division operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded multiplication operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded subtraction operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded addition operator - The first parameter. - The second parameter. - The result of the operation. - - - Overloaded unary negation. - The value to negate. - The result of the operation. - - - Converts the argument to char. Numeric inputs are converted using a checked - conversion according to the UTF-16 encoding for characters. String inputs must - be exactly one character long. For other input types the operation requires an - appropriate static conversion method on the input type. - The input value. - The converted char - - - Converts the argument to unativeint. This is a direct, checked conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted unativeint - - - Converts the argument to nativeint. This is a direct, checked conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted nativeint - - - Converts the argument to uint64. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.UInt64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint64 - - - Converts the argument to int64. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int64.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int64 - - - Converts the argument to uint32. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.UInt32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint32 - - - Converts the argument to int32. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int32 - - - Converts the argument to int. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int32.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int - - - Converts the argument to uint16. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.UInt16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint16 - - - Converts the argument to int16. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Int16.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int16 - - - Converts the argument to sbyte. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.SByte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to byte. This is a direct, checked conversion for all - primitive numeric types. For strings, the input is converted using System.Byte.Parse() - with InvariantCulture settings. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - Overloaded multiplication operator (checks for overflow) - The first value. - The second value. - The product of the two input values. - - - Overloaded addition operator (checks for overflow) - The first value. - The second value. - The sum of the two input values. - - - Overloaded subtraction operator (checks for overflow) - The first value. - The second value. - The first value minus the second value. - - - Overloaded unary negation (checks for overflow) - The input value. - The negated value. - - - This module contains the basic arithmetic operations with overflow checks. - - - Calls GetHashCode() on the value - The value. - The hash code. - - - Minimum of the two values - The first value. - The second value. - The minimum value. - - - Maximum of the two values - The first value. - The second value. - The maximum value. - - - Compares the two values - The first value. - The second value. - The result of the comparison. - - - Compares the two values for inequality - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for equality - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for less-than-or-equal - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for greater-than-or-equal - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for greater-than - The first parameter. - The second parameter. - The result of the comparison. - - - Compares the two values for less-than - The first parameter. - The second parameter. - The result of the comparison. - - - A module of comparison and equality operators that are statically resolved, but which are not fully generic and do not make structural comparison. Opening this - module may make code that relies on structural or generic comparison no longer compile. - - - Perform generic hashing on a value where the type of the value is not - statically required to satisfy the 'equality' constraint. - The computed hash value. - - - Perform generic equality on two values where the type of the values is not - statically required to satisfy the 'equality' constraint. - The result of the comparison. - - - Perform generic comparison on two values where the type of the values is not - statically required to have the 'comparison' constraint. - The result of the comparison. - - - Generate a default value for any type. This is null for reference types, - For structs, this is struct value where all fields have the default value. - This function is unsafe in the sense that some F# values do not have proper null values. - - - Unboxes a strongly typed value. This is the inverse of box, unbox<t>(box<t> a) equals a. - The boxed value. - The unboxed result. - - - This module contains basic operations which do not apply runtime and/or static checks - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'decimal' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'float' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'float32' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'unativeint' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'nativeint' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint64' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int64' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint32' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int32' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'uint16' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'int16' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'sbyte' - - - This is a library intrinsic. Calls to this function may be generated by uses of the generic 'pown' operator on values of type 'byte' - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - This is a library intrinsic. Calls to this function may be generated by evaluating quotations. - - - Generate a range of values using the given zero, add, start, step and stop values - - - Generate a range of values using the given zero, add, start, step and stop values - - - Generate a range of char values - - - Generate a range of byte values - - - Generate a range of sbyte values - - - Generate a range of uint16 values - - - Generate a range of int16 values - - - Generate a range of unativeint values - - - Generate a range of nativeint values - - - Generate a range of uint32 values - - - Generate a range of uint64 values - - - Generate a range of int64 values - - - Generate a range of float32 values - - - Generate a range of float values - - - Generate a range of integers - - - Gets a slice from a string - The source string. - The index of the first character of the slice. - The index of the last character of the slice. - The substring from the given indices. - - - Sets a slice of an array - The target array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The start index of the fourth dimension. - The end index of the fourth dimension. - The source array. - - - Gets a slice of an array - The source array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The start index of the fourth dimension. - The end index of the fourth dimension. - The four dimensional sub array from the given indices. - - - Sets a slice of an array - The target array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The source array. - - - Gets a slice of an array - The source array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The start index of the third dimension. - The end index of the third dimension. - The three dimensional sub array from the given indices. - - - Sets a vector slice of a 2D array. The index of the second dimension is fixed. - The target array. - The start index of the first dimension. - The end index of the first dimension. - The index of the second dimension. - The source array. - - - Sets a vector slice of a 2D array. The index of the first dimension is fixed. - The target array. - The index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The source array. - - - Sets a region slice of an array - The target array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The source array. - - - Gets a vector slice of a 2D array. The index of the second dimension is fixed. - The source array. - The start index of the first dimension. - The end index of the first dimension. - The fixed index of the second dimension. - The sub array from the input indices. - - - Gets a vector slice of a 2D array. The index of the first dimension is fixed. - The source array. - The index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The sub array from the input indices. - - - Gets a region slice of an array - The source array. - The start index of the first dimension. - The end index of the first dimension. - The start index of the second dimension. - The end index of the second dimension. - The two dimensional sub array from the input indices. - - - Sets a slice of an array - The target array. - The start index. - The end index. - The source array. - - - Gets a slice of an array - The input array. - The start index. - The end index. - The sub array from the input indices. - - - A module of compiler intrinsic functions for efficient implementations of F# integer ranges - and dynamic invocations of other F# operators - - - Basic F# Operators. This module is automatically opened in all F# code. - - - Invoke an F# first class function value that accepts five curried arguments - without intervening execution - The first arg. - The second arg. - The third arg. - The fourth arg. - The fifth arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept five curried arguments without intervening execution. - The input function. - The optimized function. - - - Construct an optimized function value that can accept five curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept five curried arguments - without intervening execution. This type should not typically used directly from - either F# code or from other CLI languages. - - - Invoke an F# first class function value that accepts four curried arguments - without intervening execution - The first arg. - The second arg. - The third arg. - The fourth arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept four curried arguments without intervening execution. - The input function. - The optimized function. - - - Construct an optimized function value that can accept four curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept four curried arguments - without intervening execution. This type should not typically used directly from - either F# code or from other CLI languages. - - - Invoke an F# first class function value that accepts three curried arguments - without intervening execution - The first arg. - The second arg. - The third arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept three curried arguments without intervening execution. - The input function. - The adapted function. - - - Construct an optimized function value that can accept three curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept - three iterated (curried) arguments without intervening execution. This type should not - typically used directly from either F# code or from other CLI languages. - - - Invoke the optimized function value with two curried arguments - The first arg. - The second arg. - The function result. - - - Adapt an F# first class function value to be an optimized function value that can - accept two curried arguments without intervening execution. - The input function. - The adapted function. - - - Construct an optimized function value that can accept two curried - arguments without intervening execution. - The optimized function. - - - The CLI type used to represent F# function values that accept - two iterated (curried) arguments without intervening execution. This type should not - typically used directly from either F# code or from other CLI languages. - - - An implementation module used to hold some private implementations of function - value invocation. - - - Convert an option to a potentially null value. - The input value. - The result value, which is null if the input was None. - - - Convert a potentially null value to an option. - The input value. - The result option. - - - Convert a Nullable value to an option. - The input nullable value. - The result option. - - - Convert the option to a Nullable value. - The input option. - The result value. - - - Convert the option to a list of length 0 or 1. - The input option. - The result list. - - - Convert the option to an array of length 0 or 1. - The input option. - The result array. - - - filter f inp evaluates to match inp with None -> None | Some x -> if f x then Some x else None. - A function that evaluates whether the value contained in the option should remain, or be filtered out. - The input option. - The input if the predicate evaluates to true; otherwise, None. - - - bind f inp evaluates to match inp with None -> None | Some x -> f x - A function that takes the value of type T from an option and transforms it into - an option containing a value of type U. - The input option. - An option of the output type of the binder. - - - map f inp evaluates to match inp with None -> None | Some x -> Some (f x). - A function to apply to the option value. - The input option. - An option of the input value after applying the mapping function, or None if the input is None. - - - iter f inp executes match inp with None -> () | Some x -> f x. - A function to apply to the option value. - The input option. - Unit if the option is None, otherwise it returns the result of applying the predicate - to the option value. - - - forall p inp evaluates to match inp with None -> true | Some x -> p x. - A function that evaluates to a boolean when given a value from the option type. - The input option. - True if the option is None, otherwise it returns the result of applying the predicate - to the option value. - - - exists p inp evaluates to match inp with None -> false | Some x -> p x. - A function that evaluates to a boolean when given a value from the option type. - The input option. - False if the option is None, otherwise it returns the result of applying the predicate - to the option value. - - - fold f inp s evaluates to match inp with None -> s | Some x -> f x s. - A function to update the state data when given a value from an option. - The input option. - The initial state. - The original state if the option is None, otherwise it returns the updated state with the folder - and the option value. - - - fold f s inp evaluates to match inp with None -> s | Some x -> f s x. - A function to update the state data when given a value from an option. - The initial state. - The input option. - The original state if the option is None, otherwise it returns the updated state with the folder - and the option value. - - - count inp evaluates to match inp with None -> 0 | Some _ -> 1. - The input option. - A zero if the option is None, a one otherwise. - - - Gets the value associated with the option. - The input option. - The value within the option. - Thrown when the option is None. - - - Returns true if the option is None. - The input option. - True if the option is None. - - - Returns true if the option is not None. - The input option. - True if the option is not None. - - - Basic operations on options. - - - Represents a statically-analyzed format associated with writing to a System.IO.TextWriter. The type parameter indicates the - arguments and return type of the format operation. - - - Represents a statically-analyzed format when formatting builds a string. The type parameter indicates the - arguments and return type of the format operation. - - - Represents a statically-analyzed format associated with writing to a System.Text.StringBuilder. The type parameter indicates the - arguments and return type of the format operation. - - - Represents a statically-analyzed format associated with writing to a System.IO.TextWriter. The first type parameter indicates the - arguments of the format operation and the last the overall return type. - - - Represents a statically-analyzed format when formatting builds a string. The first type parameter indicates the - arguments of the format operation and the last the overall return type. - - - Represents a statically-analyzed format associated with writing to a System.Text.StringBuilder. The first type parameter indicates the - arguments of the format operation and the last the overall return type. - - - Print to a string buffer and raise an exception with the given - result. Helper printers must return strings. - The input formatter. - The arguments of the formatter. - - - sprintf, but call the given 'final' function to generate the result. - See kprintf. - The function called to generate a result from the formatted string. - The input formatter. - The arguments of the formatter. - - - printf, but call the given 'final' function to generate the result. - For example, these let the printing force a flush after all output has - been entered onto the channel, but not before. - The function called after formatting to generate the format result. - The input formatter. - The arguments of the formatter. - - - fprintf, but call the given 'final' function to generate the result. - See kprintf. - The function called after formatting to generate the format result. - The input TextWriter. - The input formatter. - The arguments of the formatter. - - - bprintf, but call the given 'final' function to generate the result. - See kprintf. - The function called after formatting to generate the format result. - The input StringBuilder. - The input formatter. - The arguments of the formatter. - - - Print to a string via an internal string buffer and return - the result as a string. Helper printers must return strings. - The input formatter. - The formatted string. - - - Print to a text writer, adding a newline - The TextWriter to print to. - The input formatter. - The return type and arguments of the formatter. - - - Print to a text writer. - The TextWriter to print to. - The input formatter. - The return type and arguments of the formatter. - - - Print to a System.Text.StringBuilder - The StringBuilder to print to. - The input formatter. - The return type and arguments of the formatter. - - - Extensible printf-style formatting for numbers and other datatypes - - Format specifications are strings with "%" markers indicating format - placeholders. Format placeholders consist of: - - %[flags][width][.precision][type] - - where the type is interpreted as follows: - - %b: bool, formatted as "true" or "false" - %s: string, formatted as its unescaped contents - %c: character literal - %d, %i: any basic integer type formatted as a decimal integer, signed if the basic integer type is signed. - %u: any basic integer type formatted as an unsigned decimal integer - %x, %X, %o: any basic integer type formatted as an unsigned hexadecimal - (a-f)/Hexadecimal (A-F)/Octal integer - - %e, %E, %f, %F, %g, %G: - any basic floating point type (float,float32) formatted - using a C-style floating point format specifications, i.e - - %e, %E: Signed value having the form [-]d.dddde[sign]ddd where - d is a single decimal digit, dddd is one or more decimal - digits, ddd is exactly three decimal digits, and sign - is + or - - - %f: Signed value having the form [-]dddd.dddd, where dddd is one - or more decimal digits. The number of digits before the - decimal point depends on the magnitude of the number, and - the number of digits after the decimal point depends on - the requested precision. - - %g, %G: Signed value printed in f or e format, whichever is - more compact for the given value and precision. - - - %M: System.Decimal value - - %O: Any value, printed by boxing the object and using it's ToString method(s) - - %A: Any value, printed with the default layout settings - - %a: A general format specifier, requires two arguments: - (1) a function which accepts two arguments: - (a) a context parameter of the appropriate type for the - given formatting function (e.g. an #System.IO.TextWriter) - (b) a value to print - and which either outputs or returns appropriate text. - - (2) the particular value to print - - - %t: A general format specifier, requires one argument: - (1) a function which accepts a context parameter of the - appropriate type for the given formatting function (e.g. - an System.IO.TextWriter)and which either outputs or returns - appropriate text. - - Basic integer types are: - byte,sbyte,int16,uint16,int32,uint32,int64,uint64,nativeint,unativeint - Basic floating point types are: - float, float32 - - The optional width is an integer indicating the minimal width of the - result. For instance, %6d prints an integer, prefixing it with spaces - to fill at least 6 characters. If width is '*', then an extra integer - argument is taken to specify the corresponding width. - - any number - '*': - - Valid flags are: - - 0: add zeros instead of spaces to make up the required width - '-': left justify the result within the width specified - '+': add a '+' character if the number is positive (to match a '-' sign - for negatives) - ' ': add an extra space if the number is positive (to match a '-' - sign for negatives) - - The printf '#' flag is invalid and a compile-time error will be reported if it is used. - - - Returns the length of the string. - The input string. - The number of characters in the string. - - - Returns a string by concatenating count instances of str. - The number of copies of the input string will be copied. - The input string. - The concatenated string. - Thrown when count is negative. - - - Tests if any character of the string satisfies the given predicate. - The function to test each character of the string. - The input string. - True if any character returns true for the predicate and false otherwise. - - - Tests if all characters in the string satisfy the given predicate. - The function to test each character of the string. - The input string. - True if all characters return true for the predicate and false otherwise. - - - Builds a new string whose characters are the results of applying the function mapping - to each index from 0 to count-1 and concatenating the resulting - strings. - The number of strings to initialize. - The function to take an index and produce a string to - be concatenated with the others. - The constructed string. - Thrown when count is negative. - - - Builds a new string containing only the characters of the input string - for which the given predicate returns "true". - - Returns an empty string if the input string is null - - A function to test whether each character in the input sequence should be included in the output string. - The input string. - The resulting string. - - - Builds a new string whose characters are the results of applying the function mapping - to each of the characters of the input string and concatenating the resulting - strings. - The function to produce a string from each character of the input string. - The input string. - The concatenated string. - - - Builds a new string whose characters are the results of applying the function mapping - to each character and index of the input string. - The function to apply to each character and index of the string. - The input string. - The resulting string. - - - Builds a new string whose characters are the results of applying the function mapping - to each of the characters of the input string. - The function to apply to the characters of the string. - The input string. - The resulting string. - - - Applies the function action to the index of each character in the string and the - character itself. - The function to apply to each character and index of the string. - The input string. - - - Applies the function action to each character in the string. - The function to be applied to each character of the string. - The input string. - - - Returns a new string made by concatenating the given strings - with separator sep, that is a1 + sep + ... + sep + aN. - The separator string to be inserted between the strings - of the input sequence. - The sequence of strings to be concatenated. - A new string consisting of the concatenated strings separated by - the separation string. - Thrown when strings is null. - - - Functional programming operators for string processing. Further string operations - are available via the member functions on strings and other functionality in - System.String - and System.Text.RegularExpressions types. - - - - The SI unit of catalytic activity - - - - - The SI unit of does equivalent - - - - - The SI unit of absorbed dose - - - - - The SI unit of activity referred to a radionuclide - - - - - The SI unit of illuminance - - - - - The SI unit of luminous flux - - - - - The SI unit of inductance - - - - - The SI unit of magnetic flux density - - - - - The SI unit of magnetic flux - - - - - The SI unit of electric conductance - - - - - The SI unit of electric resistance - - - - - The SI unit of capacitance - - - - - The SI unit of electric potential difference, electromotive force - - - - - The SI unit of electric charge, amount of electricity - - - - - The SI unit of power, radiant flux - - - - - The SI unit of energy, work, amount of heat - - - - - The SI unit of pressure, stress - - - - - The SI unit of force - - - - - The SI unit of frequency - - - - - The SI unit of luminous intensity - - - - - The SI unit of amount of substance - - - - - The SI unit of thermodynamic temperature - - - - - The SI unit of electric current - - - - - The SI unit of time - - - - - The SI unit of mass - - - - - The SI unit of length - - - - - The SI unit of length - - - - - A synonym for henry, the SI unit of inductance - - - - - A synonym for katal, the SI unit of catalytic activity - - - - - A synonym for sievert, the SI unit of does equivalent - - - - - A synonym for gray, the SI unit of absorbed dose - - - - - A synonym for becquerel, the SI unit of activity referred to a radionuclide - - - - - A synonym for lux, the SI unit of illuminance - - - - - A synonym for lumen, the SI unit of luminous flux - - - - - A synonym for tesla, the SI unit of magnetic flux density - - - - - A synonym for weber, the SI unit of magnetic flux - - - - - A synonym for UnitNames.ohm, the SI unit of electric resistance. - - - - - A synonym for siemens, the SI unit of electric conductance - - - - - A synonym for farad, the SI unit of capacitance - - - - - A synonym for volt, the SI unit of electric potential difference, electromotive force - - - - - A synonym for coulomb, the SI unit of electric charge, amount of electricity - - - - - A synonym for watt, the SI unit of power, radiant flux - - - - - A synonym for joule, the SI unit of energy, work, amount of heat - - - - - A synonym for pascal, the SI unit of pressure, stress - - - - - A synonym for newton, the SI unit of force - - - - - A synonym for hertz, the SI unit of frequency - - - - - A synonym for candela, the SI unit of luminous intensity - - - - - A synonym for mole, the SI unit of amount of substance - - - - - A synonym for kelvin, the SI unit of thermodynamic temperature - - - - - A synonym for ampere, the SI unit of electric current - - - - - A synonym for second, the SI unit of time - - - - - A synonym for kilogram, the SI unit of mass - - - - - A synonym for Metre, the SI unit of length - - - - - A method used to support the F# query syntax. Returns an empty sequence that has the specified type argument. - - - - - A method used to support the F# query syntax. Returns a sequence that contains the specified values. - - - - - A method used to support the F# query syntax. Returns a sequence of length one that contains the specified value. - - - - A query operator that selects those elements based on a specified predicate. - - - - A query operator that performs a subsequent ordering of the elements selected so far in descending order by the given nullable sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - - - - A query operator that performs a subsequent ordering of the elements selected so far in ascending order by the given nullable sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - - - - A query operator that performs a subsequent ordering of the elements selected so far in descending order by the given sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - - - - A query operator that performs a subsequent ordering of the elements selected so far in ascending order by the given sorting key. - This operator may only be used immediately after a 'sortBy', 'sortByDescending', 'thenBy' or 'thenByDescending', or their nullable variants. - - - - A query operator that selects elements from a sequence as long as a specified condition is true, and then skips the remaining elements. - - - - A query operator that selects a specified number of contiguous elements from those selected so far. - - - - A query operator that selects a nullable value for each element selected so far and returns the sum of these values. - If any nullable does not have a value, it is ignored. - - - - A query operator that selects a value for each element selected so far and returns the sum of these values. - - - - - A method used to support the F# query syntax. Inputs to queries are implicitly wrapped by a call to one of the overloads of this method. - - - - - A method used to support the F# query syntax. Inputs to queries are implicitly wrapped by a call to one of the overloads of this method. - - - - A query operator that sorts the elements selected so far in descending order by the given nullable sorting key. - - - - A query operator that sorts the elements selected so far in ascending order by the given nullable sorting key. - - - - A query operator that sorts the elements selected so far in descending order by the given sorting key. - - - - A query operator that sorts the elements selected so far in ascending order by the given sorting key. - - - - A query operator that bypasses elements in a sequence as long as a specified condition is true and then selects the remaining elements. - - - - A query operator that bypasses a specified number of the elements selected so far and selects the remaining elements. - - - - A query operator that projects each of the elements selected so far. - - - - - A method used to support the F# query syntax. Runs the given quotation as a query using LINQ IQueryable rules. - - - - - A method used to support the F# query syntax. Indicates that the query should be passed as a quotation to the Run method. - - - - A query operator that selects the element at a specified index amongst those selected so far. - - - - A query operator that selects a nullable value for each element selected so far and returns the minimum of these values. - If any nullable does not have a value, it is ignored. - - - - A query operator that selects a value for each element selected so far and returns the minimum resulting value. - - - - A query operator that selects a nullable value for each element selected so far and returns the maximum of these values. - If any nullable does not have a value, it is ignored. - - - - A query operator that selects a value for each element selected so far and returns the maximum resulting value. - - - - A query operator that correlates two sets of selected values based on matching keys and groups the results. - If any group is empty, a group with a single default value is used instead. - Normal usage is 'leftOuterJoin y in elements2 on (key1 = key2) into group'. - - - - A query operator that selects the last element of those selected so far, or a default value if no element is found. - - - - A query operator that selects the last element of those selected so far. - - - - A query operator that correlates two sets of selected values based on matching keys. - Normal usage is 'join y in elements2 on (key1 = key2)'. - - - - A query operator that selects the first element of those selected so far, or a default value if the sequence contains no elements. - - - - A query operator that selects the first element from those selected so far. - - - - A query operator that selects a value for each element selected so far and groups the elements by the given key. - - - - A query operator that correlates two sets of selected values based on matching keys and groups the results. - Normal usage is 'groupJoin y in elements2 on (key1 = key2) into group'. - - - - A query operator that groups the elements selected so far according to a specified key selector. - - - - - A method used to support the F# query syntax. Projects each element of a sequence to another sequence and combines the resulting sequences into one sequence. - - - - A query operator that selects the first element selected so far that satisfies a specified condition. - - - - A query operator that determines whether any element selected so far satisfies a condition. - - - - A query operator that selects the single, specific element of those selected so far, or a default value if that element is not found. - - - - A query operator that selects the single, specific element selected so far - - - - A query operator that selects distinct elements from the elements selected so far. - - - - A query operator that returns the number of selected elements. - - - - A query operator that determines whether the selected elements contains a specified element. - - - - A query operator that selects a nullable value for each element selected so far and returns the average of these values. - If any nullable does not have a value, it is ignored. - - - - A query operator that selects a value for each element selected so far and returns the average of these values. - - - - A query operator that determines whether all elements selected so far satisfies a condition. - - - - Create an instance of this builder. Use 'query { ... }' to use the query syntax. - - - - The type used to support the F# query syntax. Use 'query { ... }' to use the query syntax. - - - - - A property used to support the F# query syntax. - - - - - A method used to support the F# query syntax. - - - - - A partial input or result in an F# query. This type is used to support the F# query syntax. - - - - Converts the argument to character. Numeric inputs are converted according to the UTF-16 - encoding for characters. The operation requires an appropriate static conversion method on the input type. - The input value. - The converted char. - - - Converts the argument to System.Decimal using a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted decimal. - - - Converts the argument to unsigned native integer using a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted unativeint - - - Converts the argument to signed native integer. This is a direct conversion for all - primitive numeric types. Otherwise the operation requires an appropriate - static conversion method on the input type. - The input value. - The converted nativeint - - - Converts the argument to 64-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float - - - Converts the argument to 32-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float32 - - - Converts the argument to 64-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float - - - Converts the argument to 32-bit float. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted float32 - - - Converts the argument to unsigned 64-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint64 - - - Converts the argument to signed 64-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int64 - - - Converts the argument to unsigned 32-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint32 - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int32 - - - Converts the argument to a particular enum type. - The input value. - The converted enum type. - - - Converts the argument to signed 32-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int - - - Converts the argument to unsigned 16-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted uint16 - - - Converts the argument to signed 16-bit integer. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted int16 - - - Converts the argument to signed byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to signed byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted sbyte - - - Converts the argument to byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - Converts the argument to byte. This is a direct conversion for all - primitive numeric types. The operation requires an appropriate - static conversion method on the input type. - The input value. - The converted byte - - - - Functions for converting nullable values - - - - - The division operator where a nullable value appears on both left and right sides - - - - - The division operator where a nullable value appears on the right - - - - - The division operator where a nullable value appears on the left - - - - - The modulus operator where a nullable value appears on both left and right sides - - - - - The modulus operator where a nullable value appears on the right - - - - - The modulus operator where a nullable value appears on the left - - - - - The multiplication operator where a nullable value appears on both left and right sides - - - - - The multiplication operator where a nullable value appears on the right - - - - - The multiplication operator where a nullable value appears on the left - - - - - The subtraction operator where a nullable value appears on both left and right sides - - - - - The subtraction operator where a nullable value appears on the right - - - - - The subtraction operator where a nullable value appears on the left - - - - - The addition operator where a nullable value appears on both left and right sides - - - - - The addition operator where a nullable value appears on the right - - - - - The addition operator where a nullable value appears on the left - - - - - The '<>' operator where a nullable value appears on both left and right sides - - - - - The '=' operator where a nullable value appears on both left and right sides - - - - - The '<' operator where a nullable value appears on both left and right sides - - - - - The '<=' operator where a nullable value appears on both left and right sides - - - - - The '>' operator where a nullable value appears on both left and right sides - - - - - The '>=' operator where a nullable value appears on both left and right sides - - - - - The '<>' operator where a nullable value appears on the right - - - - - The '=' operator where a nullable value appears on the right - - - - - The '<' operator where a nullable value appears on the right - - - - - The '<=' operator where a nullable value appears on the right - - - - - The '>' operator where a nullable value appears on the right - - - - - The '>=' operator where a nullable value appears on the right - - - - - The '<>' operator where a nullable value appears on the left - - - - - The '=' operator where a nullable value appears on the left - - - - - The '<' operator where a nullable value appears on the left - - - - - The '<=' operator where a nullable value appears on the left - - - - - The '>' operator where a nullable value appears on the left - - - - - The '>=' operator where a nullable value appears on the left - - - - - Operators for working with nullable values - - - - - A method used to support the F# query syntax. Runs the given quotation as a query using LINQ IEnumerable rules. - - - - - A method used to support the F# query syntax. Runs the given quotation as a query using LINQ rules. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - This type shouldn't be used directly from user code. - - - - - A type used to reconstruct a grouping after applying a mutable->immutable mapping transformation - on a result of a query. - - - - - The generic MethodInfo for Select function - Describes how we got from productions of immutable objects to productions of anonymous objects, with enough information - that we can invert the process in final query results. - - - - - Given the expression part of a "yield" or "select" which produces a result in terms of immutable tuples or immutable records, - generate an equivalent expression yielding anonymous objects. Also return the conversion for the immutable-to-mutable correspondence - so we can reverse this later. - - - - - Simplify gets of tuples and gets of record fields. - - - - - Cleanup the use of property-set object constructions in leaf expressions that form parts of F# queries. - - - - - Given an type involving immutable tuples and records, logically corresponding to the type produced at a - "yield" or "select", convert it to a type involving anonymous objects according to the conversion data. - - - - - Recognize anonymous type construction written using 'new AnonymousObject(<e1>, <e2>, ...)' - - - - - Recognize object construction written using 'new O(Prop1 = <e>, Prop2 = <e>, ...)' - - - - - Tests whether a list consists only of assignments of properties of the - given variable, null values (ignored) and ends by returning the given variable - (pattern returns only property assignments) - - - - - Recognize sequential series written as (... ((<e>; <e>); <e>); ...) - - - - - A runtime helper used to evaluate nested quotation literals. - - - - - A runtime helper used to evaluate nested quotation literals. - - - - - Evaluates a subset of F# quotations by first converting to a LINQ expression, for the subset of LINQ expressions represented by the - expression syntax in the C# language. - - - - - Converts a subset of F# quotations to a LINQ expression, for the subset of LINQ expressions represented by the - expression syntax in the C# language. - - - - - Converts a subset of F# quotations to a LINQ expression, for the subset of LINQ expressions represented by the - expression syntax in the C# language. - - - - - When used in a quotation, this function indicates a specific conversion - should be performed when converting the quotation to a LINQ expression. - - This function should not be called directly. - - - - - When used in a quotation, this function indicates a specific conversion - should be performed when converting the quotation to a LINQ expression. - - This function should not be called directly. - - - - - When used in a quotation, this function indicates a specific conversion - should be performed when converting the quotation to a LINQ expression. - - This function should not be called directly. - - - - Allocates a region of memory on the stack. - The number of objects of type T to allocate. - A typed pointer to the allocated memory. - - - Assigns the value into the memory location referenced by the typed native - pointer computed by adding index * sizeof<'T> to the given input pointer. - The input pointer. - The index by which to offset the pointer. - The value to assign. - - - Assigns the value into the memory location referenced by the given typed native pointer. - The input pointer. - The value to assign. - - - Dereferences the given typed native pointer. - The input pointer. - The value at the pointer address. - - - Dereferences the typed native pointer computed by adding index * sizeof<'T> to the - given input pointer. - The input pointer. - The index by which to offset the pointer. - The value at the pointer address. - - - Returns a typed native pointer by adding index * sizeof<'T> to the - given input pointer. - The input pointer. - The index by which to offset the pointer. - A typed pointer. - - - Returns a machine address for a given typed native pointer. - The input pointer. - The machine address. - - - Returns a typed native pointer for a given machine address. - The pointer address. - A typed pointer. - - - Contains operations on native pointers. Use of these operators may - result in the generation of unverifiable code. - - - Gets the raw expression associated with this type-carrying expression - - - Type-carrying quoted expressions. Expressions are generated either - by quotations in source text or programatically - - - Returns type of an expression. - - - Returns the custom attributes of an expression. - - - Builds an expression that represents a value and its associated reflected definition as a quotation - The untyped object. - The type of the object. - The definition of the value being quoted. - The resulting expression. - - - Builds an expression that represents a value and its associated reflected definition as a quotation - The value being quoted. - The definition of the value being quoted. - The resulting expression. - - - Builds an expression that represents a while loop - The predicate to control the loop iteration. - The body of the while loop. - The resulting expression. - - - Builds an expression that represents setting a mutable variable - The input variable. - The value to set. - The resulting expression. - - - Builds an expression that represents a variable - The input variable. - The resulting expression. - - - Builds an expression that represents a constant value of a particular type, arising from a variable of the given name - The untyped object. - The type of the object. - The name of the variable. - The resulting expression. - - - Builds an expression that represents a constant value, arising from a variable of the given name - The typed value. - The name of the variable. - The resulting expression. - - - Builds an expression that represents a constant value - The typed value. - The resulting expression. - - - Builds an expression that represents a constant value of a particular type - The untyped object. - The type of the object. - The resulting expression. - - - Builds an expression that represents a test of a value is of a particular union case - The expression to test. - The description of the union case. - The resulting expression. - - - Builds an expression that represents a type test. - The expression to test. - The target type. - The resulting expression. - - - Builds an expression that represents getting a field of a tuple - The input tuple. - The index of the tuple element to get. - The resulting expression. - - - Builds an expression that represents a try/with construct for exception filtering and catching. - The body of the try expression. - - - The variable to bind to a caught exception. - The expression evaluated when an exception is caught. - The resulting expression. - - - Try and find a stored reflection definition for the given method. Stored reflection - definitions are added to an F# assembly through the use of the [<ReflectedDefinition>] attribute. - The description of the method to find. - The reflection definition or None if a match could not be found. - - - Builds an expression that represents a try/finally construct - The body of the try expression. - The final part of the expression to be evaluated. - The resulting expression. - - - Format the expression as a string - Indicates if method, property, constructor and type objects should be printed in detail. If false, these are abbreviated to their name. - The formatted string. - - - Substitutes through the given expression using the given functions - to map variables to new values. The functions must give consistent results - at each application. Variable renaming may occur on the target expression - if variable capture occurs. - The function to map variables into expressions. - The expression with the given substitutions. - - - Builds an expression that represents the sequential execution of one expression followed by another - The first expression. - The second expression. - The resulting expression. - - - Permits interactive environments such as F# Interactive - to explicitly register new pickled resources that represent persisted - top level definitions. - The assembly associated with the resource. - The unique name for the resources being added. - The type definitions referenced. - The serialized resource to register with the environment. - - - Permits interactive environments such as F# Interactive - to explicitly register new pickled resources that represent persisted - top level definitions. - The assembly associated with the resource. - The unique name for the resources being added. - The serialized resource to register with the environment. - - - Builds an expression that represents a nested typed quotation literal - The expression being quoted. - The resulting expression. - - - Builds an expression that represents a nested raw quotation literal - The expression being quoted. - The resulting expression. - - - Builds an expression that represents a nested typed or raw quotation literal - The expression being quoted. - The resulting expression. - - - Builds an expression that represents writing to a static property - The description of the property. - The value to set. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents writing to a property of an object - The input object. - The description of the property. - The value to set. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents reading a static property - The description of the property. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents reading a property of an object - The input object. - The description of the property. - List of indices for the property if it is an indexed property. - The resulting expression. - - - Builds an expression that represents the creation of a union case value - The description of the union case. - The list of arguments for the case. - The resulting expression. - - - Builds an expression that represents the creation of an F# tuple value - The list of elements of the tuple. - The resulting expression. - - - Builds record-construction expressions - The type of record. - The list of elements of the record. - The resulting expression. - - - Builds an expression that represents the invocation of an object constructor - The description of the constructor. - The list of arguments to the constructor. - The resulting expression. - - - Builds an expression that represents the creation of a delegate value for the given type - The type of delegate. - The parameters for the delegate. - The body of the function. - The resulting expression. - - - Builds an expression that represents the creation of an array value initialized with the given elements - The type for the elements of the array. - The list of elements of the array. - The resulting expression. - - - Builds recursives expressions associated with 'let rec' constructs - The list of bindings for the let expression. - The sub-expression where the bindings are in scope. - The resulting expression. - - - Builds expressions associated with 'let' constructs - The variable in the let expression. - The expression bound to the variable. - The sub-expression where the binding is in scope. - The resulting expression. - - - Builds an expression that represents the constrution of an F# function value - The parameter to the function. - The body of the function. - The resulting expression. - - - Builds 'if ... then ... else' expressions. - The condition expression. - The then sub-expression. - The else sub-expression. - The resulting expression. - - - Fetches or creates a new variable with the given name and type from a global pool of shared variables - indexed by name and type. The type is given by the expicit or inferred type parameter - The variable name. - The created of fetched typed global variable. - - - Gets the free expression variables of an expression as a list. - A sequence of the free variables in the expression. - - - Builds a 'for i = ... to ... do ...' expression that represent loops over integer ranges - The sub-expression declaring the loop variable. - The sub-expression setting the initial value of the loop variable. - The sub-expression declaring the final value of the loop variable. - The sub-expression representing the body of the loop. - The resulting expression. - - - Builds an expression that represents writing to a field of an object - The input object. - The description of the field to write to. - The value to set to the field. - The resulting expression. - - - Builds an expression that represents writing to a static field - The description of the field to write to. - The value to the set to the field. - The resulting expression. - - - Builds an expression that represents the access of a field of an object - The input object. - The description of the field to access. - The resulting expression. - - - Builds an expression that represents the access of a static field - The description of the field to access. - The resulting expression. - - - This function is called automatically when quotation syntax (<@ @>) and other sources of - quotations are used. - A type in the assembly where the quotation occurs. - The type definitions referenced. - The spliced types, to replace references to type variables. - The spliced expressions to replace references to spliced expressions. - The serialized form of the quoted expression. - The resulting expression. - - - This function is called automatically when quotation syntax (<@ @>) and other sources of - quotations are used. - A type in the assembly where the quotation occurs. - The spliced types, to replace references to type variables. - The spliced expressions to replace references to spliced expressions. - The serialized form of the quoted expression. - The resulting expression. - - - Builds an expression that represents the invocation of a default object constructor - The type on which the constructor is invoked. - The resulting expression. - - - Builds an expression that represents the coercion of an expression to a type - The expression to coerce. - The target type. - The resulting expression. - - - Returns a new typed expression given an underlying runtime-typed expression. - A type annotation is usually required to use this function, and - using an incorrect type annotation may result in a later runtime exception. - The expression to cast. - The resulting typed expression. - - - Builds an expression that represents a call to an instance method associated with an object - The input object. - The description of the method to call. - The list of arguments to the method. - The resulting expression. - - - Builds an expression that represents a call to an static method or module-bound function - The MethodInfo describing the method to call. - The list of arguments to the method. - The resulting expression. - - - Builds an expression that represents the application of a first class function value to multiple arguments - The function to apply. - The list of lists of arguments to the function. - The resulting expression. - - - Builds an expression that represents the application of a first class function value to a single argument. - The function to apply. - The argument to the function. - The resulting expression. - - - Builds an expression that represents setting the value held at a particular address. - The target expression. - The value to set at the address. - The resulting expression. - - - Builds an expression that represents getting the address of a value. - The target expression. - The resulting expression. - - - Quoted expressions annotated with System.Type values. - - - The type associated with the variable - - - The declared name of the variable - - - Indicates if the variable represents a mutable storage location - - - Fetches or create a new variable with the given name and type from a global pool of shared variables - indexed by name and type - The name of the variable. - The type associated with the variable. - The retrieved or created variable. - - - Creates a new variable with the given name, type and mutability - The declared name of the variable. - The type associated with the variable. - Indicates if the variable represents a mutable storage location. Default is false. - The created variable. - - - Information at the binding site of a variable - - - Re-build combination expressions. The first parameter should be an object - returned by the ShapeCombination case of the active pattern in this module. - The input shape. - The list of arguments. - The rebuilt expression. - - - An active pattern that performs a complete decomposition viewing the expression tree as a binding structure - The input expression. - The decomposed Var, Lambda, or ConstApp. - - - Active patterns for traversing, visiting, rebuilding and tranforming expressions in a generic way - - - An active pattern to recognize property setters that have an associated ReflectedDefinition - The description of the property. - The expression of the method definition if found, or None. - - - An active pattern to recognize property getters or values in modules that have an associated ReflectedDefinition - The description of the property. - The expression of the method definition if found, or None. - - - An active pattern to recognize methods that have an associated ReflectedDefinition - The description of the method. - The expression of the method definition if found, or None. - - - A parameterized active pattern to recognize calls to a specified function or method. - The returned elements are the optional target object (present if the target is an - instance method), the generic type instantation (non-empty if the target is a generic - instantiation), and the arguments to the function or method. - The input template expression to specify the method to call. - The optional target object (present if the target is an - instance method), the generic type instantation (non-empty if the target is a generic - instantiation), and the arguments to the function or method. - - - An active pattern to recognize constant decimal expressions - The input expression to match against. - decimal option - - - An active pattern to recognize constant unsigned int64 expressions - The input expression to match against. - uint64 option - - - An active pattern to recognize constant int64 expressions - The input expression to match against. - int64 option - - - An active pattern to recognize constant unsigned int32 expressions - The input expression to match against. - uint32 option - - - An active pattern to recognize constant int32 expressions - The input expression to match against. - int32 option - - - An active pattern to recognize constant unsigned int16 expressions - The input expression to match against. - uint16 option - - - An active pattern to recognize constant int16 expressions - The input expression to match against. - int16 option - - - An active pattern to recognize constant byte expressions - The input expression to match against. - byte option - - - An active pattern to recognize constant signed byte expressions - The input expression to match against. - sbyte option - - - An active pattern to recognize constant unicode character expressions - The input expression to match against. - char option - - - An active pattern to recognize constant 64-bit floating point number expressions - The input expression to match against. - float option - - - An active pattern to recognize constant 32-bit floating point number expressions - The input expression to match against. - float32 option - - - An active pattern to recognize constant string expressions - The input expression to match against. - string option - - - An active pattern to recognize constant boolean expressions - The input expression to match against. - bool option - - - An active pattern to recognize () constant expressions - The input expression to match against. - unit option - - - An active pattern to recognize expressions of the form a || b - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions of the form a && b - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent the application of a (possibly curried or tupled) first class function value - The input expression to match against. - (Expr * Expr list list) option - - - An active pattern to recognize expressions that represent a (possibly curried or tupled) first class function value - The input expression to match against. - (Var list list * Expr) option - - - Contains a set of derived F# active patterns to analyze F# expression objects - - - An active pattern to recognize expressions that represent setting a mutable variable - The input expression to match against. - (Var * Expr) option - - - An active pattern to recognize expressions that represent a variable - The input expression to match against. - Var option - - - An active pattern to recognize expressions that are a value with an associated definition - The input expression to match against. - The boxed value, its static type and its definition - - - An active pattern to recognize expressions that represent a constant value - The input expression to match against. - The boxed value, its static type and its name - - - An active pattern to recognize expressions that represent a constant value. This also matches expressions matched by ValueWithName. - The input expression to match against. - The boxed value and its static type - - - An active pattern to recognize expressions that represent a test if a value is of a particular union case - The input expression to match against. - The expression and union case being tested - - - An active pattern to recognize expressions that represent a dynamic type test - The input expression to match against. - The expression and type being tested - - - An active pattern to recognize expressions that represent getting a tuple field - The input expression to match against. - The expression and tuple field being accessed - - - An active pattern to recognize expressions that represent a try/finally construct - The input expression to match against. - The body and handler parts of the try/finally expression - - - An active pattern to recognize expressions that represent a try/with construct for exception filtering and catching - The input expression to match against. - (Expr * Var * Expr * Var * Expr) option - - - An active pattern to recognize expressions that represent sequential exeuction of one expression followed by another - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent a nested typed quotation literal - The input expression to match against. - Expr option - - - An active pattern to recognize expressions that represent a nested raw quotation literal - The input expression to match against. - Expr option - - - An active pattern to recognize expressions that represent a nested quotation literal - The input expression to match against. - Expr option - - - An active pattern to recognize expressions that represent setting a static or instance property, or a non-function value declared in a module - The input expression to match against. - (Expr option * PropertyInfo * Expr list * Expr) option - - - An active pattern to recognize expressions that represent the read of a static or instance property, or a non-function value declared in a module - The input expression to match against. - (Expr option * PropertyInfo * Expr list) option - - - An active pattern to recognize expressions that represent construction of tuple values - The input expression to match against. - (Expr list) option - - - An active pattern to recognize expressions that represent construction of particular union case values - The input expression to match against. - (UnionCaseInfo * Expr list) option - - - An active pattern to recognize expressions that represent construction of record values - The input expression to match against. - (Type * Expr list) option - - - An active pattern to recognize expressions that represent invocation of object constructors - The input expression to match against. - (ConstructorInfo * Expr list) option - - - An active pattern to recognize expressions that represent construction of delegate values - The input expression to match against. - (Type * Var list * Expr) option - - - An active pattern to recognize expressions that represent invocations of a default constructor of a struct - The input expression to match against. - Type option - - - An active pattern to recognize expressions that represent the construction of arrays - The input expression to match against. - (Type * Expr list) option - - - An active pattern to recognize expressions that represent recursive let bindings of one or more variables - The input expression to match against. - ((Var * Expr) list * Expr) option - - - An active pattern to recognize expressions that represent let bindings - The input expression to match against. - (Var * Expr * Expr) option - - - An active pattern to recognize expressions that represent first class function values - The input expression to match against. - (Var * Expr) option - - - An active pattern to recognize expressions that represent conditionals - The input expression to match against. - (Expr * Expr * Expr) option - - - An active pattern to recognize expressions that represent while loops - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent loops over integer ranges - The input expression to match against. - (Var * Expr * Expr * Expr) option - - - An active pattern to recognize expressions that represent setting a static or instance field - The input expression to match against. - (Expr option * FieldInfo * Expr) option - - - An active pattern to recognize expressions that represent getting a static or instance field - The input expression to match against. - (Expr option * FieldInfo) option - - - An active pattern to recognize expressions that represent coercions from one type to another - The input expression to match against. - (Expr * Type) option - - - An active pattern to recognize expressions that represent calls to static and instance methods, and functions defined in modules - The input expression to match against. - (Expr option * MethodInfo * Expr list) option - - - An active pattern to recognize expressions that represent applications of first class function values - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent setting the value held at an address - The input expression to match against. - (Expr * Expr) option - - - An active pattern to recognize expressions that represent getting the address of a value - The input expression to match against. - Expr option - - - Contains a set of primitive F# active patterns to analyze F# expression objects - - - Returns a System.Type representing an F# tuple type with the given element types - An array of types for the tuple elements. - The type representing the tuple containing the input elements. - - - Returns a System.Type representing the F# function type with the given domain and range - The input type of the function. - The output type of the function. - The function type with the given domain and range. - - - Returns true if the typ is a representation of an F# union type or the runtime type of a value of that type - The type to check. - Optional binding flags. - True if the type check succeeds. - - - Return true if the typ is a representation of an F# tuple type - The type to check. - True if the type check succeeds. - - - Return true if the typ is a representation of an F# record type - The type to check. - Optional binding flags. - True if the type check succeeds. - - - Return true if the typ is a System.Type value corresponding to the compiled form of an F# module - The type to check. - True if the type check succeeds. - - - Return true if the typ is a representation of an F# function type or the runtime type of a closure implementing an F# function type - The type to check. - True if the type check succeeds. - - - Returns true if the typ is a representation of an F# exception declaration - The type to check. - Optional binding flags. - True if the type check is an F# exception. - - - Gets the cases of a union type. - - Assumes the given type is a union type. If not, ArgumentException is raised during pre-computation. - The input union type. - Optional binding flags. - Thrown when the input type is not a union type. - An array of descriptions of the cases of the given union type. - - - Gets the tuple elements from the representation of an F# tuple type. - The input tuple type. - An array of the types contained in the given tuple type. - - - Reads all the fields from a record value, in declaration order - - Assumes the given input is a record value. If not, ArgumentException is raised. - The input record type. - Optional binding flags. - An array of descriptions of the properties of the record type. - - - Gets the domain and range types from an F# function type or from the runtime type of a closure implementing an F# type - The input function type. - A tuple of the domain and range types of the input function. - - - Reads all the fields from an F# exception declaration, in declaration order - - Assumes exceptionType is an exception representation type. If not, ArgumentException is raised. - The exception type to read. - Optional binding flags. - Thrown if the given type is not an exception. - An array containing the PropertyInfo of each field in the exception. - - - Contains operations associated with constructing and analyzing F# types such as records, unions and tuples - - - Assumes the given type is a union type. - If not, ArgumentException is raised during pre-computation. - - Using the computed function is more efficient than calling GetUnionCase - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The type of union to optimize reading. - Optional binding flags. - An optimized function to read the tags of the given union type. - - - Precompute a property or static method for reading an integer representing the case tag of a union type. - The type of union to read. - Optional binding flags. - The description of the union case reader. - - - Precomputes a function for reading all the fields for a particular discriminator case of a union type - - Using the computed function will typically be faster than executing a corresponding call to GetFields - The description of the union case to read. - Optional binding flags. - A function to for reading the fields of the given union case. - - - A method that constructs objects of the given case - The description of the union case. - Optional binding flags. - The description of the constructor of the given union case. - - - Precomputes a function for constructing a discriminated union value for a particular union case. - The description of the union case. - Optional binding flags. - A function for constructing values of the given union case. - - - Precomputes a function for reading the values of a particular tuple type - - Assumes the given type is a TupleType. - If not, ArgumentException is raised during pre-computation. - The tuple type to read. - Thrown when the given type is not a tuple type. - A function to read values of the given tuple type. - - - Gets information that indicates how to read a field of a tuple - The input tuple type. - The index of the tuple element to describe. - The description of the tuple element and an optional type and index if the tuple is big. - - - Gets a method that constructs objects of the given tuple type. - For small tuples, no additional type will be returned. - - For large tuples, an additional type is returned indicating that - a nested encoding has been used for the tuple type. In this case - the suffix portion of the tuple type has the given type and an - object of this type must be created and passed as the last argument - to the ConstructorInfo. A recursive call to PreComputeTupleConstructorInfo - can be used to determine the constructor for that the suffix type. - The input tuple type. - The description of the tuple type constructor and an optional extra type - for large tuples. - - - Precomputes a function for reading the values of a particular tuple type - - Assumes the given type is a TupleType. - If not, ArgumentException is raised during pre-computation. - The type of tuple to read. - Thrown when the given type is not a tuple type. - A function to read a particular tuple type. - - - Precompute a function for reading all the fields from a record. The fields are returned in the - same order as the fields reported by a call to Microsoft.FSharp.Reflection.Type.GetInfo for - this type. - - Assumes the given type is a RecordType. - If not, ArgumentException is raised during pre-computation. - - Using the computed function will typically be faster than executing a corresponding call to Value.GetInfo - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The type of record to read. - Optional binding flags. - Thrown when the input type is not a record type. - An optimized reader for the given record type. - - - Precompute a function for reading a particular field from a record. - Assumes the given type is a RecordType with a field of the given name. - If not, ArgumentException is raised during pre-computation. - - Using the computed function will typically be faster than executing a corresponding call to Value.GetInfo - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The PropertyInfo of the field to read. - Thrown when the input type is not a record type. - A function to read the specified field from the record. - - - Get a ConstructorInfo for a record type - The record type. - Optional binding flags. - A ConstructorInfo for the given record type. - - - Precompute a function for constructing a record value. - - Assumes the given type is a RecordType. - If not, ArgumentException is raised during pre-computation. - The type of record to construct. - Optional binding flags. - Thrown when the input type is not a record type. - A function to construct records of the given type. - - - Create a union case value. - The description of the union case to create. - The array of arguments to construct the given case. - Optional binding flags. - The constructed union case. - - - Creates an instance of a tuple type - - Assumes at least one element is given. If not, ArgumentException is raised. - The array of tuple fields. - The tuple type to create. - Thrown if no elements are given. - An instance of the tuple type with the given elements. - - - Creates an instance of a record type. - - Assumes the given input is a record type. - The type of record to make. - The array of values to initialize the record. - Optional binding flags for the record. - Thrown when the input type is not a record type. - The created record. - - - Builds a typed function from object from a dynamic function implementation - The function type of the implementation. - The untyped lambda of the function implementation. - A typed function from the given dynamic implementation. - - - Identify the union case and its fields for an object - - Assumes the given input is a union case value. If not, ArgumentException is raised. - - If the type is not given, then the runtime type of the input object is used to identify the - relevant union type. The type should always be given if the input object may be null. For example, - option values may be represented using the 'null'. - The input union case. - The union type containing the value. - Optional binding flags. - Thrown when the input type is not a union case value. - The description of the union case and its fields. - - - Reads all fields from a tuple. - - Assumes the given input is a tuple value. If not, ArgumentException is raised. - The input tuple. - Thrown when the input is not a tuple value. - An array of the fields from the given tuple. - - - Reads a field from a tuple value. - - Assumes the given input is a tuple value. If not, ArgumentException is raised. - The input tuple. - The index of the field to read. - The value of the field. - - - Reads all the fields from a record value. - - Assumes the given input is a record value. If not, ArgumentException is raised. - The record object. - Optional binding flags for the record. - Thrown when the input type is not a record type. - The array of fields from the record. - - - Reads a field from a record value. - - Assumes the given input is a record value. If not, ArgumentException is raised. - The record object. - The PropertyInfo describing the field to read. - Thrown when the input type is not a record type. - The field from the record. - - - Reads all the fields from a value built using an instance of an F# exception declaration - - Assumes the given input is an F# exception value. If not, ArgumentException is raised. - The exception instance. - Optional binding flags. - Thrown when the input type is not an F# exception. - The fields from the given exception. - - - Contains operations associated with constructing and analyzing values associated with F# types - such as records, unions and tuples. - - - The integer tag for the case. - - - The name of the case. - - - The type in which the case occurs. - - - The fields associated with the case, represented by a PropertyInfo. - The fields associated with the case. - - - Returns the custom attributes associated with the case matching the given attribute type. - The type of attributes to return. - An array of custom attributes. - - - Returns the custom attributes associated with the case. - An array of custom attributes. - - - Represents a case of a discriminated union type - - - Returns true if the typ is a representation of an F# exception declaration - The type to check. - Optional flag that denotes accessibility of the private representation. - True if the type check is an F# exception. - - - Reads all the fields from an F# exception declaration, in declaration order - - Assumes exceptionType is an exception representation type. If not, ArgumentException is raised. - The exception type to read. - Optional flag that denotes accessibility of the private representation. - Thrown if the given type is not an exception. - An array containing the PropertyInfo of each field in the exception. - - - Returns true if the typ is a representation of an F# union type or the runtime type of a value of that type - The type to check. - Optional flag that denotes accessibility of the private representation. - True if the type check succeeds. - - - Return true if the typ is a representation of an F# record type - The type to check. - Optional flag that denotes accessibility of the private representation. - True if the type check succeeds. - - - Gets the cases of a union type. - - Assumes the given type is a union type. If not, ArgumentException is raised during pre-computation. - The input union type. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a union type. - An array of descriptions of the cases of the given union type. - - - Reads all the fields from a record value, in declaration order - - Assumes the given input is a record value. If not, ArgumentException is raised. - The input record type. - Optional flag that denotes accessibility of the private representation. - An array of descriptions of the properties of the record type. - - - Reads all the fields from a value built using an instance of an F# exception declaration - - Assumes the given input is an F# exception value. If not, ArgumentException is raised. - The exception instance. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not an F# exception. - The fields from the given exception. - - - A method that constructs objects of the given case - The description of the union case. - Optional flag that denotes accessibility of the private representation. - The description of the constructor of the given union case. - - - Precomputes a function for constructing a discriminated union value for a particular union case. - The description of the union case. - Optional flag that denotes accessibility of the private representation. - A function for constructing values of the given union case. - - - Precomputes a function for reading all the fields for a particular discriminator case of a union type - - Using the computed function will typically be faster than executing a corresponding call to GetFields - The description of the union case to read. - Optional flag that denotes accessibility of the private representation. - A function to for reading the fields of the given union case. - - - Precompute a property or static method for reading an integer representing the case tag of a union type. - The type of union to read. - Optional flag that denotes accessibility of the private representation. - The description of the union case reader. - - - Assumes the given type is a union type. - If not, ArgumentException is raised during pre-computation. - - Using the computed function is more efficient than calling GetUnionCase - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The type of union to optimize reading. - Optional flag that denotes accessibility of the private representation. - An optimized function to read the tags of the given union type. - - - Identify the union case and its fields for an object - - Assumes the given input is a union case value. If not, ArgumentException is raised. - - If the type is not given, then the runtime type of the input object is used to identify the - relevant union type. The type should always be given if the input object may be null. For example, - option values may be represented using the 'null'. - The input union case. - The union type containing the value. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a union case value. - The description of the union case and its fields. - - - Create a union case value. - The description of the union case to create. - The array of arguments to construct the given case. - Optional flag that denotes accessibility of the private representation. - The constructed union case. - - - Get a ConstructorInfo for a record type - The record type. - Optional flag that denotes accessibility of the private representation. - A ConstructorInfo for the given record type. - - - Precompute a function for constructing a record value. - - Assumes the given type is a RecordType. - If not, ArgumentException is raised during pre-computation. - The type of record to construct. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - A function to construct records of the given type. - - - Precompute a function for reading all the fields from a record. The fields are returned in the - same order as the fields reported by a call to Microsoft.FSharp.Reflection.Type.GetInfo for - this type. - - Assumes the given type is a RecordType. - If not, ArgumentException is raised during pre-computation. - - Using the computed function will typically be faster than executing a corresponding call to Value.GetInfo - because the path executed by the computed function is optimized given the knowledge that it will be - used to read values of the given type. - The type of record to read. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - An optimized reader for the given record type. - - - Reads all the fields from a record value. - - Assumes the given input is a record value. If not, ArgumentException is raised. - The record object. - Optional flag that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - The array of fields from the record. - - - Creates an instance of a record type. - - Assumes the given input is a record type. - The type of record to make. - The array of values to initialize the record. - Optional flags that denotes accessibility of the private representation. - Thrown when the input type is not a record type. - The created record. - - - - A record of options to control structural formatting. - For F# Interactive properties matching those of this value can be accessed via the 'fsi' - value. - - Floating Point format given in the same format accepted by System.Double.ToString, - e.g. f6 or g15. - - If ShowProperties is set the printing process will evaluate properties of the values being - displayed. This may cause additional computation. - - The ShowIEnumerable is set the printing process will force the evalution of IEnumerable objects - to a small, finite depth, as determined by the printing parameters. - This may lead to additional computation being performed during printing. - - <example> - From F# Interactive the default settings can be adjusted using, for example, - <pre> - open Microsoft.FSharp.Compiler.Interactive.Settings;; - setPrintWidth 120;; - </pre> - </example> - - - - - Data representing structured layouts of terms. - - - - - Convert any value to a layout using the given formatting options. The - layout can then be processed using formatting display engines such as - those in the LayoutOps module. any_to_string and output_any are - built using any_to_layout with default format options. - - - - - Ouput any value to a channel using the same set of formatting rules - as any_to_string - - - - - Convert any value to a string using a standard formatter - Data is typically formatted in a structured format, e.g. - lists are formatted using the "[1;2]" notation. - The details of the format are not specified and may change - from version to version and according to the flags given - to the F# compiler. The format is intended to be human-readable, - not machine readable. If alternative generic formats are required - you should develop your own formatter, using the code in the - implementation of this file as a starting point. - - Data from other .NET languages is formatted using a virtual - call to Object.ToString() on the boxed version of the input. - - - - - For limitting layout of list-like sequences (lists,arrays,etc). - unfold a list of items using (project and z) making layout list via itemL. - If reach maxLength (before exhausting) then truncate. - - - - - See tagL - - - - - Layout like an F# list. - - - - - Layout like an F# option. - - - - - Layout list vertically. - - - - - Layout two vertically. - - - - - Form tuple of layouts. - - - - - Wrap braces around layout. - - - - - Wrap square brackets around layout. - - - - - Wrap round brackets around Layout. - - - - - Join layouts into a list separated using the given Layout. - - - - - Join layouts into a semi-colon separated list. - - - - - Join layouts into a space separated list. - - - - - Join layouts into a comma separated list. - - - - - Join broken with ident=2 - - - - - Join broken with ident=1 - - - - - Join broken with ident=0 - - - - - Join, possible break with indent=2 - - - - - Join, possible break with indent=1 - - - - - Join, possible break with indent=0 - - - - - Join, unbreakable. - - - - - An string which is left parenthesis (no space on the right). - - - - - An string which is right parenthesis (no space on the left). - - - - - An string which requires no spaces either side. - - - - - An string leaf - - - - - An uninterpreted leaf, to be interpreted into a string - by the layout engine. This allows leaf layouts for numbers, strings and - other atoms to be customized according to culture. - - - - - Is it the empty layout? - - - - - The empty layout - - - - - A layout is a sequence of strings which have been joined together. - The strings are classified as words, separators and left and right parenthesis. - This classification determines where spaces are inserted. - A joint is either unbreakable, breakable or broken. - If a joint is broken the RHS layout occurs on the next line with optional indentation. - A layout can be squashed to for given width which forces breaks as required. - - - - Subscribe an observer to the source of results - The observer to be added to those that are notified. - An IDisposable to allow for unsubscription. - - - A source of observable results - - - Notify an observer of a new result - The value to notify observers. - - - Notify an observer of an error - The exception to notify observers. - - - Notify an observer that no more results will be produced. - - - A client that may be subscribed to observe the results from an IObservable. - - - diff --git a/packages/FsCheck.2.2.4/FsCheck.2.2.4.nupkg b/packages/FsCheck.2.2.4/FsCheck.2.2.4.nupkg deleted file mode 100644 index 10c75e7..0000000 Binary files a/packages/FsCheck.2.2.4/FsCheck.2.2.4.nupkg and /dev/null differ diff --git a/packages/FsCheck.2.2.4/lib/net45/FsCheck.dll b/packages/FsCheck.2.2.4/lib/net45/FsCheck.dll deleted file mode 100644 index 3138fa5..0000000 Binary files a/packages/FsCheck.2.2.4/lib/net45/FsCheck.dll and /dev/null differ diff --git a/packages/FsCheck.2.2.4/lib/net45/FsCheck.xml b/packages/FsCheck.2.2.4/lib/net45/FsCheck.xml deleted file mode 100644 index 7765158..0000000 --- a/packages/FsCheck.2.2.4/lib/net45/FsCheck.xml +++ /dev/null @@ -1,1667 +0,0 @@ - - -FsCheck - - - - Return an Arbitrary instance that is a mapped and filtered version of an existing arbitrary instance. - The generator uses Gen.map with the given mapper and then Gen.suchThat with the given predicate, - and the shrinks are filtered using Seq.filter with the given predicate. -This is sometimes useful if using just a filter would reduce the chance of getting a good value -from the generator - and you can map the value instead. E.g. PositiveInt. - - - - - Return an Arbitrary instance that is a filtered version of an existing arbitrary instance. - The generator uses Gen.suchThat, and the shrinks are filtered using Seq.filter with the given predicate. - - - - -Construct an Arbitrary instance for a type that can be mapped to and from another type (e.g. a wrapper), -based on a Arbitrary instance for the source type and two mapping functions. - - - - -Extensons to transform Arbitrary instances into other Arbitrary instances. - - - - -Returns a generator for 'a. - - - - -Returns a sequence of the immediate shrinks of the given value. The immediate shrinks should not include -doubles or the given value itself. The default implementation returns the empty sequence (i.e. no shrinking). - - - - - Check all public static methods on the given type that have a testable return type with the verbose configuration, -and throws on failure or exhaustion. - - - - - Check all public static methods on the given type that have a testable return type with vthe erbose configuration, -and throws on failure or exhaustion. - - - - -Check one property with the verbose configuration, and throw an exception if it fails or is exhausted. - - - - - Check all public static methods on the given type that have a testable return type with vthe erbose configuration - - - - - Check all public static methods on the given type that have a testable return type with vthe erbose configuration - - - - -Check one property with the verbose configuration, and using the given name. - - - - -Check one property with the verbose configuration. - - - - -Check all public static methods on the given type that have a testable return type with quick configuration - - - - -Check all public static methods on the given type that have a testable return type with quick configuration, -and throw on failure or exhaustion. - - - - -Check one property with the quick configuration, and throw an exception if it fails or is exhausted. - - - - -Check all public static methods on the given type that have a testable return type with quick configuration - - - - -Check all public static methods on the given type that have a testable return type with quick configuration - - - - -Check one property with the quick configuration, and using the given name. - - - - -Check one property with the quick configuration. - - - - -Check the given property using the given config, and the given test name. - - - - -Check the given property using the given config. - - - - -Check the given property identified by the given MethodInfo. - - - - -Check all public static methods on the given type that have a testable return type with the given configuration. -This includes let-bound functions in a module. - - - - -Check all public static methods on the given type that have a testable return type with the given configuration. -This includes let-bound functions in a module. - - - - -Executes the command on the model of the object. - - - - -Excecutes the command on the actual object under test. - - - - -The default precondition is true. - - - - -Precondition for execution of the command. When this does not hold, the test continues -but the command will not be executed. - - - - -The default postcondition is true. - - - - -Postcondition that must hold after execution of the command. Compares state of model and actual -object and fails the property if they do not match. - - - - -A single command describes pre and post conditions and the model for a single method under test. -The post-conditions are the invariants that will be checked; when these do not hold the test fails. - - - - -A custom test runner, e.g. to integrate with a test framework like xUnit or NUnit. - - - - -The Arbitrary instances on this class will be merged in back to front order, i.e. instances for the same generated type at the front -of the list will override those at the back. The instances on Arb.Default are always known, and are at the back (so they can always be -overridden) - - - - -What to print every time a counter-example is succesfully shrunk - - - - -What to print when new arguments args are generated in test n - - - - -If set, suppresses the output from the test if the test is successful. - - - - -The size to use for the last test, when all the tests are passing. The size increases linearly between Start- and EndSize. - - - - -The size to use for the first test. - - - - -Name of the test. - - - - -If set, the seed to use to start testing. Allows reproduction of previous runs. - - - - -The maximum number of tests where values are rejected, e.g. as the result of ==> - - - - -The maximum number of tests that are run. - - - - -Like the Verbose configuration, only throws an exception with the error message if the test fails or is exhausted. -Useful for use within other unit testing frameworks that usually adopt this methodolgy to signal failure. - - - - -The verbose configuration prints each generated argument. - - - - -Like the Quick configuration, only throws an exception with the error message if the test fails or is exhausted. -Useful for use within other unit testing frameworks that usually adopt this methodolgy to signal failure. - - - - -The quick configuration only prints a summary result at the end of the test. - - - - -The default configuration is the quick configuration. - - - - -For configuring a run. - - - - -The size to use for the first test. - - - - -A custom test runner, e.g. to integrate with a test framework like xUnit or NUnit. - - - - -If set, the seed to use to start testing. Allows reproduction of previous runs. - - - - -If set, suppresses the output from the test if the test is successful. - - - - -Name of the test. - - - - -The maximum number of tests that are run. - - - - -The maximum number of tests where values are rejected - - - - -What to print every time a counter-example is succesfully shrunk - - - - -What to print when new arguments args are generated in test n - - - - -The size to use for the last test, when all the tests are passing. The size increases linearly between Start- and EndSize. - - - - -The size to use for the first test. - - - - -A custom test runner, e.g. to integrate with a test framework like xUnit or NUnit. - - - - -If set, the seed to use to start testing. Allows reproduction of previous runs. - - - - -If set, suppresses the output from the test if the test is successful. - - - - -Name of the test. - - - - -The maximum number of tests that are run. - - - - -The maximum number of tests where values are rejected - - - - -What to print every time a counter-example is succesfully shrunk - - - - -What to print when new arguments args are generated in test n - - - - -The size to use for the last test, when all the tests are passing. The size increases linearly between Start- and EndSize. - - - - -Configure the test run. - - - - -Use the generator for 'a, but don't shrink. - - - - -Whereas most types are restricted by a size that grows -as the test gets further, by applying this type the underlying -type will ignore this size and always generate from the full range. -Note that this only makes a difference for types that have a range - -currently Int16, Int32, Int64 have DontSize Arbitrary instances. -This is typically (and at least currently) only applicable for value types -that are comparable, hence the type constraints. - - - - -Represents an array whose length does not change when shrinking. - - - - -A function (F# function) that can be displayed and shrunk. - - - - -Generates a value that satisfies a predicate. This function keeps re-trying -by increasing the size of the original generator ad infinitum. Make sure there is a high chance that -the predicate is satisfied. - - - - -Build a generator that generates a 2-tuple of the values generated by the given generator. - - - - - Construct an Arbitrary instance from a generator and a shrinker. - - - - - Construct an Arbitrary instance from a generator. - Shrink is not supported for this type. - - - - -Build a generator that generates a 3-tuple of the values generated by the given generator. - - - - -Map the given function to the value in the generator, yielding a new generator of the result type. - - - - -Generates n values of the given size. - - - - -Override the current size of the test. - - - - - Generates a non-empty list of random length. The maximum length - depends on the size parameter. - - - - - Generates a list of random length. The maximum length depends on the - size parameter. - - - - -Generates a list of given length, containing values generated by the given generator. - - - - -Build a generator that generates a 4-tuple of the values generated by the given generator. - - - - -Generates a value with maximum size n. - - - - - Generates an array using the specified generator. - The maximum length is size+1. - - - - - Generates an array of a specified length. - - - - - Generates a 2D array. The square root of the size is the maximum number of rows and columns. - - - - - Generates a 2D array of the given dimensions. - - - - -Apply the given Gen function to this generator, aka the applicative <*> operator. - - - - -Extension methods to build generators - contains among other the Linq methods. - - - - - Lifted function application = apply f to a, all in the Gen applicative functor. - - - - - Like <*>, but puts f in a Gen first. - - - - - Bind operator; runs the first generator, then feeds the result - to the second generator function. - - - - -map the given function to the value in the generator, yielding a new generator of the result type. - - - - -Generator of a random value, based on a size parameter and a randomly generated int. - - - - -Initial state of model object. Should correspond to initial state of actual object. - - - - -Initial state of actual object. Should correspond to initial state of model object. - - - - -Generate a number of possible commands based on the current state of the model. -Preconditions are still checked, so even if a Command is returned, it is not chosen -if its precondition does not hold. - - - - -Defines the initial state for actual and model object, and allows to define the generator to use -for the next state, based on the model. - - - - -Called before a group of properties on a type are checked. - - - - -Called on a succesful shrink. - - - - -Called whenever all tests are done, either True, False or Exhausted. - - - - -Called whenever arguments are generated and after the test is run. - - - - -For implementing your own test runner. - - - - -Represents an int that can include int.MinValue and int.MaxValue. - - - - -Represents an integer interval. - - - - -Represents a non-empty array. - - - - -Represents a non-empty Set. - - - - -Represents a string that is not null or empty, and does not contain any null characters ('\000') - - - - -Represents an int >= 0 - - - - -Wrap a type in NonNull to prevent null being generated for the wrapped type. - - - - -Represents an int <> 0 - - - - -Represents a float that is not NaN or Infinity. - - - - - determines for which Outcome the result should be shrunk, or shrinking should continue. - - - - -Represents an int > 0 - - - - -A Property can be checked by FsCheck. - - - - -Conditional property combinator. Resulting property holds if the property holds when the condition does. - - - - -Conditional property combinator. Resulting property holds if the property holds when the condition does. - - - - -Conditional property combinator. Resulting property holds if the property holds when the condition does. - - - - -Count trivial cases. Test cases for which the condition is True are classified as trivial. - - - - -Count trivial cases. Test cases for which the condition is True are classified as trivial. - - - - -Count trivial cases. Test cases for which the condition is True are classified as trivial. - - - - -Count trivial cases. Test cases for which the condition is True are classified as trivial. - - - - - Turns a testable type into a property. - - - - - Turns a testable type into a property. - - - - - Turns a testable type into a property. - - - - -Construct a property that fails if both fail. (cfr 'or') - - - - -Construct a property that fails if both fail. (cfr 'or') - - - - -Construct a property that fails if both fail. (cfr 'or') - - - - -Construct a property that fails if both fail. (cfr 'or') - - - - -Add the given label to the property. The labels of a failing sub-property are displayed when it fails. - - - - -Add the given label to the property. The labels of a failing sub-property are displayed when it fails. - - - - -Add the given label to the property. The labels of a failing sub-property are displayed when it fails. - - - - -Add the given label to the property. The labels of a failing sub-property are displayed when it fails. - - - - -Collect data values. The argument of collect is evaluated in each test case, -and the distribution of values is reported. - - - - -Collect data values. The argument of collect is evaluated in each test case, -and the distribution of values is reported. - - - - -Collect data values. The argument of collect is evaluated in each test case, -and the distribution of values is reported. - - - - -Collect data values. The argument of collect is evaluated in each test case, -and the distribution of values is reported. - - - - -Classify test cases. Test cases satisfying the condition are assigned the classification given. - - - - -Classify test cases. Test cases satisfying the condition are assigned the classification given. - - - - -Classify test cases. Test cases satisfying the condition are assigned the classification given. - - - - -Construct a property that succeeds if both succeed. (cfr 'and') - - - - -Construct a property that succeeds if both succeed. (cfr 'and') - - - - -Construct a property that succeeds if both succeed. (cfr 'and') - - - - -Construct a property that succeeds if both succeed. (cfr 'and') - - - - -Extensons to construct Properties. - - - - -Returns a new result that is Succeeded if and only if both this -and the given Result are Succeeded. - - - - -The result of one execution of a property. - - - - -Represents a string that does not contain null characters ('\000') - - - - -2-tuple containing a weight and a value, used in some Gen methods to indicate -the probability of a value. - - - - -Generates (), of the unit type. - - - - -Generate arbitrary uint64 that is between 0 and size. - - - - -Generate arbitrary uint32 that is between 0 and size. - - - - -Generate arbitrary uint16 that is between 0 and size. - - - - -Generates an arbitrary TimeSpan. A TimeSpan is shrunk by removing days, hours, minutes, second and milliseconds. - - - - -Generates a Func'4. - - - - -Generates a Func'3. - - - - -Generates a Func'2. - - - - -Generates a Func'1. - - - - -Generates an Action'3 - - - - -Generates an Action'2 - - - - -Generates an Action'1 - - - - -Generates an Action'0 - - - - -Generates arbitrary strings, which are lists of chars generated by Char. - - - - -Generates an arbitrary signed byte. - - - - -Generate an option value that is 'None' 1/8 of the time. - - - - -Generate an object - a boxed char, string or boolean value. - - - - -Generate a nullable value that is null 1/8 of the time. - - - - - Generates an Float (without NaN, Infinity) - - - - -Generate underlying values that are not null. - - - - - Generate a System.Collections.Generic.List of values. - - - - -Generates an interval between two non-negative integers. - - - - -Generate arbitrary int64 that is between -size and size. -Note that since the size is an int32, this does not actually cover the full -range of int64. See DontSize<int64> instead. - - - - -Generate arbitrary int32 that is between -size and size. - - - - -Generate arbitrary int16 that is between -size and size. - - - - - Generate a System.Collections.Generic.IList of values. - - - - - Generate a System.Collections.Generic.IDictionary of values. - Shrinks by reducing the number of elements - - - - - Generate a System.Collections.Generic.ICollection of values. - - - - -Generate a Function value that can be printed and shrunk. Function values can be generated for types 'a->'b -where 'b has an Arbitrary instance. - - - - -Generate a list of values. The size of the list is between 0 and the test size + 1. - - - - -Generates arbitrary floats, NaN, NegativeInfinity, PositiveInfinity, Maxvalue, MinValue, Epsilon included fairly frequently. - - - - -Generates arbitrary floats, NaN, NegativeInfinity, PositiveInfinity, Maxvalue, MinValue, Epsilon included fairly frequently. - - - - -Arrays whose length does not change when shrinking. - - - - -Generate arbitrary uint32 that is uniformly distributed in the whole range of uint32 values. - - - - -Generate arbitrary uint32 that is uniformly distributed in the whole range of uint32 values. - - - - -Generate arbitrary uint16 that is uniformly distributed in the whole range of uint16 values. - - - - -Generate arbitrary int64 between Int64.MinValue and Int64.MaxValue - - - - -Generate arbitrary int32 that is between Int32.MinValue and Int32.MaxValue - - - - -Generate arbitrary int16 that is uniformly distributed in the whole range of int16 values. - - - - -Overrides the shrinker of any type to be empty, i.e. not to shrink at all. - - - - - Generate a System.Collections.Generic.Dictionary of values. - Shrinks by reducing the number of elements - - - - -Try to derive an arbitrary instance for the given type reflectively. -Generates and shrinks values for record, union, tuple and enum types. -Also generates (but doesn't shrink) values for immutable classes -(i.e. single constructor, no mutable properties or fields). - - - - -Generate arbitrary decimal. - - - - -Generates an arbitrary DateTimeOffset between 1900 and 2100. - A DateTimeOffset is shrunk first by shrinking its offset, then by removing its second, minute and hour components. - - - - -Generates an arbitrary DateTime between 1900 and 2100. -A DateTime is shrunk by removing its second, minute and hour components. - - - - -Generates arbitrary chars, between ASCII codes Char.MinValue and 127. - - - - -Generates an arbitrary byte. - - - - -Generates an arbitrary bool. - - - - -Arbitray instance for BigInteger. - - - - -Generate a function value. Function values can be generated for types 'a->'b where 'b has an Arbitrary instance. -THere is no shrinking function values. - - - - -Generate a rank 2, zero based array. - - - - -Generate a rank 1 array. - - - - - Return an Arbitrary instance that is a mapped and filtered version of an existing arbitrary instance. - The generator uses Gen.map with the given mapper and then Gen.suchThat with the given predicate, - and the shrinks are filtered using Seq.filter with the given predicate. -This is sometimes useful if using just a filter would reduce the chance of getting a good value -from the generator - and you can map the value instead. E.g. PositiveInt. - - - - - Return an Arbitrary instance that is a filtered version of an existing arbitrary instance. - The generator uses Gen.suchThat, and the shrinks are filtered using Seq.filter with the given predicate. - - - - -Construct an Arbitrary instance for a type that can be mapped to and from another type (e.g. a wrapper), -based on a Arbitrary instance for the source type and two mapping functions. - - - - - Construct an Arbitrary instance from a generator and shrinker. - - - - - Construct an Arbitrary instance from a generator. - Shrink is not supported for this type. - - - - -A generic shrinker that should work for most number-like types. - - - - -Returns the immediate shrinks for the given value based on its type. - - - - -Returns a Gen<'Value> - - - - -Get the Arbitrary instance for the given type. - - - - -Register the generators that are static members of the type argument. - - - - -Register the generators that are static members of the given type. - - - - -Turn a specification into a property. - - - - -Memoize the given function. - - - - -Memoize the given function using the given dictionary - - - - -Generate a number of possible commands based on the current state of the model. -Preconditions are still checked, so even if a Command is returned, it is not chosen -if its precondition does not hold. - - - - -Defines the initial state for actual and model object, and allows to define the generator to use -for the next state, based on the model. - - - - -Executes the command on the model of the object. - - - - -The default precondition is true. - - - - -Optional precondition for execution of the command. When this does not hold, the test continues -but the command is not executed. - - - - -Excecutes the command on the object under test, and returns a property that must hold. -This property typically compares the state of the model with the state of the object after -execution of the command. - - - - -An operation describes pre and post conditions and the model for a single operation under test. -The post-conditions are the invariants that will be checked; when these do not hold the test fails. - - - - -Initial state of model object. Must correspond to initial state of actual object. - - - - -Randomly generate the initial state of the actual object. Should still correspond to the -initial state of model object; so you should only randomly generate parameters to the instance -that don't affect the model. -Note:make sure that each value is truly a new instance if the commands change the state -of the object. Gen.connstant in particular is a bad idea - use Gen.fresh instead. - - - - -Turn a specification into a property. - - - - -Basic co-arbitrary generator transformer, which is dependent on an int. -Only used for generating arbitrary functions. - - - - -Promote the given function f to a function generator. Only used for generating arbitrary functions. - - - - -Apply the given Gen function to the given generator, aka the applicative <*> operator. - - - - -Generate a fresh instance every time the generatoris called. Useful for mutable objects. -See also constant. - - - - -Generate a fresh instance every time the generatoris called. Useful for mutable objects. -See also constant. - - - - -Always generate the same instance v. See also fresh. - - - - - Generates a 2D array. The square root of the size is the maximum number of rows and columns. - - - - - Generates a 2D array of the given dimensions. - - - - - Generates an array using the specified generator. The maximum length is the size+1. - - - - - Generates an array of a specified length. - - - - - Generates sublists of the given arguments. - - - - - Generates sublists of the given IEnumerable. - - - - - Generates sublists of the given sequence. - - - - - Generates a non-empty list of random length. The maximum length - depends on the size parameter. - - - - - Generates a list of random length. The maximum length depends on the - size parameter. - - - - -Generates a value that satisfies a predicate. Contrary to suchThatOption, this function keeps re-trying -by increasing the size of the original generator ad infinitum. Make sure there is a high chance that -the predicate is satisfied. - - - - -Tries to generate a value that satisfies a predicate. This function 'gives up' by generating None -if the given original generator did not generate any values that satisfied the predicate, after trying to -get values from by increasing its size. - - - - -Generates a list of given length, containing values generated by the given generator. - - - - -Sequence the given list of generators into a generator of a list. - - - - -Sequence the given list of generators into a generator of a list. - - - - -Sequence the given seq of generators into a generator of a list. - - - - -Map the given function over values to a function over generators of those values. - - - - -Map the given function over values to a function over generators of those values. - - - - -Build a generator that generates a 4-tuple of the values generated by the given generator. - - - - -Map the given function over values to a function over generators of those values. - - - - -Build a generator that generates a 3-tuple of the values generated by the given generator. - - - - -Map the given function over values to a function over generators of those values. - - - - -Build a generator that generates a 2-tuple of the values generated by the given generator. - - - - -Map the given function over values to a function over generators of those values. - - - - -Build a generator that generates a value from one of the generators in the given non-empty seq, with -given probabilities. The sum of the probabilities must be larger than zero. - - - - -Build a generator that generates a value from one of the generators in the given non-empty seq, with -given probabilities. The sum of the probabilities must be larger than zero. - - - - -Build a generator that generates a value from one of the generators in the given non-empty seq, with -given probabilities. The sum of the probabilities must be larger than zero. - - - - -Build a generator that generates a value from one of the generators in the given non-empty seq, with -given probabilities. The sum of the probabilities must be larger than zero. - - - - -Build a generator that generates a value from one of the given generators, with -equal probability. - - - - -Build a generator that generates a value from one of the generators in the given non-empty seq, with -equal probability. - - - - -Build a generator that randomly generates one of the values in the given non-empty seq. - - - - -Build a generator that randomly generates one of the values in the given non-empty seq. - - - - -Generates an integer between l and h, inclusive. - - - - -Generates n values of the given size. - - - - -Generates a value with maximum size n. - - - - -Override the current size of the test. resize n g invokes generator g with size parameter n. - - - - -Obtain the current size. sized g calls g, passing it the current size as a parameter. - - - - -Obtain the current size. sized g calls g, passing it the current size as a parameter. - - - - -Apply the function f to the value in the generator, yielding a new generator. - - - - -Combinators to build custom random generators for any type. - - - - -The workflow type for generators. - - - - -The workflow function for generators, e.g. gen { ... } - - - - -Computation expression builder for Gen. - - - - - Turns a testable type into a property. Testables are unit, boolean, Lazy testables, Gen testables, functions - from a type for which a generator is know to a testable, tuples up to 6 tuple containing testables, and lists - containing testables. - - - - -Fails the property if it does not complete within t milliseconds. Note that the called property gets a -cancel signal, but whether it responds to that is up to the property; the execution may not actually stop. - - - - -Add the given label to the property. The labels of a failing sub-property are displayed when it fails. - - - - -Collect data values. The argument of collect is evaluated in each test case, -and the distribution of values is reported, using sprintf "%A". - - - - -Count trivial cases. Test cases for which the condition is True are classified as trivial. - - - - -Classify test cases. Test cases satisfying the condition are assigned the classification given. - - - - -Expect exception 't when executing p. So, results in success if an exception of the given type is thrown, -and a failure otherwise. - - - - -Depending on the condition, return the first testable if true and the second if false. - - - - -Quantified property combinator. Provide a custom test data generator to a property. - - - - -Combinators to build properties, which define the property to be tested, with some -convenience methods to investigate the generated arguments and any found counter-examples. - - - - -Construct a property that fails if both fail. (cfr 'or') - - - - -Construct a property that succeeds if both succeed. (cfr 'and') - - - - -Add the given label to the property. Property on the left hand side, label on the right. - - - - -Add the given label to the property. label on the left hand side, property on the right. - - - - -Add the given label to the property. Property on the left hand side, label on the right. - - - - -Conditional property combinator. Resulting property holds if the property after ==> holds whenever the condition does. - - - - -Operators for Prop. - - - - -Generate random numbers based on splitting seeds. Based Hugs' Random implementation. - - - - - Get reader for union case name (aka tag) - - - - - Returns the case name, type, and functions that will construct a constructor and a reader of a union type respectively - - - - - Get reader for record type - - - - - Get constructor for record type - - - - - Get information on the fields of a record type - - - - -Build a reflection-based generator for the given Type. Since we memoize based on type, can't use a -typed variant reflectGen<'a> much here, as we need to be able to partially apply on the getGenerator. -See also Default.Derive. - - - - - Generate a random enum of the type specified by the System.Type - - - - -Force this value to do the necessary initializations of typeclasses. Normally this initialization happens automatically. -In any case, it can be forced any number of times without problem. - - - - -A runner that prints results to the standard output. - - - - -A function that returns the default string that is printed as a result of the test. - - - - -Merge the instances defined by the given instances type with the ones already defined in this TypeClass. -Instances defined in the given type override the instances in this TypeClass instance. - - - - -Get the instance registered on this TypeClass for the given type parameter 'T. The result will be cast -to TypeClassT, which should be 'TypeClass<'T> but that's impossible to express in .NET's type system. - - - - -Get the instance registered on this TypeClass for the given type and optionally the given arguments. -The result is of type 'TypeClass<'T>, dynamically. - - - - -Discover instances for this TypeClass on the given type. Merge the result with this TypeClass, -with the newly discovered instances overriding the instances on this TypeClass. - - - - -Make a new TypeClass with only the instances registered on the given type. -Note that the instances of this TypeClass will not be registered on the new TypeClass. -Use Merge in addition to achieve that, or use DiscoverAndMerge to do both. - - - - -Compares this TypeClass with the given TypeClass. Returns, respectively, the new instances, overridden instances, -new array instances, overridden array instances, new catch all or overridden catchall introduced by the other TypeClass. - - - - -Haskell typeclass concept simulation. For internal use. - - - - diff --git a/packages/FsCheck.2.2.4/lib/portable-net45+netcore45+wp8/FsCheck.XML b/packages/FsCheck.2.2.4/lib/portable-net45+netcore45+wp8/FsCheck.XML deleted file mode 100644 index 7765158..0000000 --- a/packages/FsCheck.2.2.4/lib/portable-net45+netcore45+wp8/FsCheck.XML +++ /dev/null @@ -1,1667 +0,0 @@ - - -FsCheck - - - - Return an Arbitrary instance that is a mapped and filtered version of an existing arbitrary instance. - The generator uses Gen.map with the given mapper and then Gen.suchThat with the given predicate, - and the shrinks are filtered using Seq.filter with the given predicate. -This is sometimes useful if using just a filter would reduce the chance of getting a good value -from the generator - and you can map the value instead. E.g. PositiveInt. - - - - - Return an Arbitrary instance that is a filtered version of an existing arbitrary instance. - The generator uses Gen.suchThat, and the shrinks are filtered using Seq.filter with the given predicate. - - - - -Construct an Arbitrary instance for a type that can be mapped to and from another type (e.g. a wrapper), -based on a Arbitrary instance for the source type and two mapping functions. - - - - -Extensons to transform Arbitrary instances into other Arbitrary instances. - - - - -Returns a generator for 'a. - - - - -Returns a sequence of the immediate shrinks of the given value. The immediate shrinks should not include -doubles or the given value itself. The default implementation returns the empty sequence (i.e. no shrinking). - - - - - Check all public static methods on the given type that have a testable return type with the verbose configuration, -and throws on failure or exhaustion. - - - - - Check all public static methods on the given type that have a testable return type with vthe erbose configuration, -and throws on failure or exhaustion. - - - - -Check one property with the verbose configuration, and throw an exception if it fails or is exhausted. - - - - - Check all public static methods on the given type that have a testable return type with vthe erbose configuration - - - - - Check all public static methods on the given type that have a testable return type with vthe erbose configuration - - - - -Check one property with the verbose configuration, and using the given name. - - - - -Check one property with the verbose configuration. - - - - -Check all public static methods on the given type that have a testable return type with quick configuration - - - - -Check all public static methods on the given type that have a testable return type with quick configuration, -and throw on failure or exhaustion. - - - - -Check one property with the quick configuration, and throw an exception if it fails or is exhausted. - - - - -Check all public static methods on the given type that have a testable return type with quick configuration - - - - -Check all public static methods on the given type that have a testable return type with quick configuration - - - - -Check one property with the quick configuration, and using the given name. - - - - -Check one property with the quick configuration. - - - - -Check the given property using the given config, and the given test name. - - - - -Check the given property using the given config. - - - - -Check the given property identified by the given MethodInfo. - - - - -Check all public static methods on the given type that have a testable return type with the given configuration. -This includes let-bound functions in a module. - - - - -Check all public static methods on the given type that have a testable return type with the given configuration. -This includes let-bound functions in a module. - - - - -Executes the command on the model of the object. - - - - -Excecutes the command on the actual object under test. - - - - -The default precondition is true. - - - - -Precondition for execution of the command. When this does not hold, the test continues -but the command will not be executed. - - - - -The default postcondition is true. - - - - -Postcondition that must hold after execution of the command. Compares state of model and actual -object and fails the property if they do not match. - - - - -A single command describes pre and post conditions and the model for a single method under test. -The post-conditions are the invariants that will be checked; when these do not hold the test fails. - - - - -A custom test runner, e.g. to integrate with a test framework like xUnit or NUnit. - - - - -The Arbitrary instances on this class will be merged in back to front order, i.e. instances for the same generated type at the front -of the list will override those at the back. The instances on Arb.Default are always known, and are at the back (so they can always be -overridden) - - - - -What to print every time a counter-example is succesfully shrunk - - - - -What to print when new arguments args are generated in test n - - - - -If set, suppresses the output from the test if the test is successful. - - - - -The size to use for the last test, when all the tests are passing. The size increases linearly between Start- and EndSize. - - - - -The size to use for the first test. - - - - -Name of the test. - - - - -If set, the seed to use to start testing. Allows reproduction of previous runs. - - - - -The maximum number of tests where values are rejected, e.g. as the result of ==> - - - - -The maximum number of tests that are run. - - - - -Like the Verbose configuration, only throws an exception with the error message if the test fails or is exhausted. -Useful for use within other unit testing frameworks that usually adopt this methodolgy to signal failure. - - - - -The verbose configuration prints each generated argument. - - - - -Like the Quick configuration, only throws an exception with the error message if the test fails or is exhausted. -Useful for use within other unit testing frameworks that usually adopt this methodolgy to signal failure. - - - - -The quick configuration only prints a summary result at the end of the test. - - - - -The default configuration is the quick configuration. - - - - -For configuring a run. - - - - -The size to use for the first test. - - - - -A custom test runner, e.g. to integrate with a test framework like xUnit or NUnit. - - - - -If set, the seed to use to start testing. Allows reproduction of previous runs. - - - - -If set, suppresses the output from the test if the test is successful. - - - - -Name of the test. - - - - -The maximum number of tests that are run. - - - - -The maximum number of tests where values are rejected - - - - -What to print every time a counter-example is succesfully shrunk - - - - -What to print when new arguments args are generated in test n - - - - -The size to use for the last test, when all the tests are passing. The size increases linearly between Start- and EndSize. - - - - -The size to use for the first test. - - - - -A custom test runner, e.g. to integrate with a test framework like xUnit or NUnit. - - - - -If set, the seed to use to start testing. Allows reproduction of previous runs. - - - - -If set, suppresses the output from the test if the test is successful. - - - - -Name of the test. - - - - -The maximum number of tests that are run. - - - - -The maximum number of tests where values are rejected - - - - -What to print every time a counter-example is succesfully shrunk - - - - -What to print when new arguments args are generated in test n - - - - -The size to use for the last test, when all the tests are passing. The size increases linearly between Start- and EndSize. - - - - -Configure the test run. - - - - -Use the generator for 'a, but don't shrink. - - - - -Whereas most types are restricted by a size that grows -as the test gets further, by applying this type the underlying -type will ignore this size and always generate from the full range. -Note that this only makes a difference for types that have a range - -currently Int16, Int32, Int64 have DontSize Arbitrary instances. -This is typically (and at least currently) only applicable for value types -that are comparable, hence the type constraints. - - - - -Represents an array whose length does not change when shrinking. - - - - -A function (F# function) that can be displayed and shrunk. - - - - -Generates a value that satisfies a predicate. This function keeps re-trying -by increasing the size of the original generator ad infinitum. Make sure there is a high chance that -the predicate is satisfied. - - - - -Build a generator that generates a 2-tuple of the values generated by the given generator. - - - - - Construct an Arbitrary instance from a generator and a shrinker. - - - - - Construct an Arbitrary instance from a generator. - Shrink is not supported for this type. - - - - -Build a generator that generates a 3-tuple of the values generated by the given generator. - - - - -Map the given function to the value in the generator, yielding a new generator of the result type. - - - - -Generates n values of the given size. - - - - -Override the current size of the test. - - - - - Generates a non-empty list of random length. The maximum length - depends on the size parameter. - - - - - Generates a list of random length. The maximum length depends on the - size parameter. - - - - -Generates a list of given length, containing values generated by the given generator. - - - - -Build a generator that generates a 4-tuple of the values generated by the given generator. - - - - -Generates a value with maximum size n. - - - - - Generates an array using the specified generator. - The maximum length is size+1. - - - - - Generates an array of a specified length. - - - - - Generates a 2D array. The square root of the size is the maximum number of rows and columns. - - - - - Generates a 2D array of the given dimensions. - - - - -Apply the given Gen function to this generator, aka the applicative <*> operator. - - - - -Extension methods to build generators - contains among other the Linq methods. - - - - - Lifted function application = apply f to a, all in the Gen applicative functor. - - - - - Like <*>, but puts f in a Gen first. - - - - - Bind operator; runs the first generator, then feeds the result - to the second generator function. - - - - -map the given function to the value in the generator, yielding a new generator of the result type. - - - - -Generator of a random value, based on a size parameter and a randomly generated int. - - - - -Initial state of model object. Should correspond to initial state of actual object. - - - - -Initial state of actual object. Should correspond to initial state of model object. - - - - -Generate a number of possible commands based on the current state of the model. -Preconditions are still checked, so even if a Command is returned, it is not chosen -if its precondition does not hold. - - - - -Defines the initial state for actual and model object, and allows to define the generator to use -for the next state, based on the model. - - - - -Called before a group of properties on a type are checked. - - - - -Called on a succesful shrink. - - - - -Called whenever all tests are done, either True, False or Exhausted. - - - - -Called whenever arguments are generated and after the test is run. - - - - -For implementing your own test runner. - - - - -Represents an int that can include int.MinValue and int.MaxValue. - - - - -Represents an integer interval. - - - - -Represents a non-empty array. - - - - -Represents a non-empty Set. - - - - -Represents a string that is not null or empty, and does not contain any null characters ('\000') - - - - -Represents an int >= 0 - - - - -Wrap a type in NonNull to prevent null being generated for the wrapped type. - - - - -Represents an int <> 0 - - - - -Represents a float that is not NaN or Infinity. - - - - - determines for which Outcome the result should be shrunk, or shrinking should continue. - - - - -Represents an int > 0 - - - - -A Property can be checked by FsCheck. - - - - -Conditional property combinator. Resulting property holds if the property holds when the condition does. - - - - -Conditional property combinator. Resulting property holds if the property holds when the condition does. - - - - -Conditional property combinator. Resulting property holds if the property holds when the condition does. - - - - -Count trivial cases. Test cases for which the condition is True are classified as trivial. - - - - -Count trivial cases. Test cases for which the condition is True are classified as trivial. - - - - -Count trivial cases. Test cases for which the condition is True are classified as trivial. - - - - -Count trivial cases. Test cases for which the condition is True are classified as trivial. - - - - - Turns a testable type into a property. - - - - - Turns a testable type into a property. - - - - - Turns a testable type into a property. - - - - -Construct a property that fails if both fail. (cfr 'or') - - - - -Construct a property that fails if both fail. (cfr 'or') - - - - -Construct a property that fails if both fail. (cfr 'or') - - - - -Construct a property that fails if both fail. (cfr 'or') - - - - -Add the given label to the property. The labels of a failing sub-property are displayed when it fails. - - - - -Add the given label to the property. The labels of a failing sub-property are displayed when it fails. - - - - -Add the given label to the property. The labels of a failing sub-property are displayed when it fails. - - - - -Add the given label to the property. The labels of a failing sub-property are displayed when it fails. - - - - -Collect data values. The argument of collect is evaluated in each test case, -and the distribution of values is reported. - - - - -Collect data values. The argument of collect is evaluated in each test case, -and the distribution of values is reported. - - - - -Collect data values. The argument of collect is evaluated in each test case, -and the distribution of values is reported. - - - - -Collect data values. The argument of collect is evaluated in each test case, -and the distribution of values is reported. - - - - -Classify test cases. Test cases satisfying the condition are assigned the classification given. - - - - -Classify test cases. Test cases satisfying the condition are assigned the classification given. - - - - -Classify test cases. Test cases satisfying the condition are assigned the classification given. - - - - -Construct a property that succeeds if both succeed. (cfr 'and') - - - - -Construct a property that succeeds if both succeed. (cfr 'and') - - - - -Construct a property that succeeds if both succeed. (cfr 'and') - - - - -Construct a property that succeeds if both succeed. (cfr 'and') - - - - -Extensons to construct Properties. - - - - -Returns a new result that is Succeeded if and only if both this -and the given Result are Succeeded. - - - - -The result of one execution of a property. - - - - -Represents a string that does not contain null characters ('\000') - - - - -2-tuple containing a weight and a value, used in some Gen methods to indicate -the probability of a value. - - - - -Generates (), of the unit type. - - - - -Generate arbitrary uint64 that is between 0 and size. - - - - -Generate arbitrary uint32 that is between 0 and size. - - - - -Generate arbitrary uint16 that is between 0 and size. - - - - -Generates an arbitrary TimeSpan. A TimeSpan is shrunk by removing days, hours, minutes, second and milliseconds. - - - - -Generates a Func'4. - - - - -Generates a Func'3. - - - - -Generates a Func'2. - - - - -Generates a Func'1. - - - - -Generates an Action'3 - - - - -Generates an Action'2 - - - - -Generates an Action'1 - - - - -Generates an Action'0 - - - - -Generates arbitrary strings, which are lists of chars generated by Char. - - - - -Generates an arbitrary signed byte. - - - - -Generate an option value that is 'None' 1/8 of the time. - - - - -Generate an object - a boxed char, string or boolean value. - - - - -Generate a nullable value that is null 1/8 of the time. - - - - - Generates an Float (without NaN, Infinity) - - - - -Generate underlying values that are not null. - - - - - Generate a System.Collections.Generic.List of values. - - - - -Generates an interval between two non-negative integers. - - - - -Generate arbitrary int64 that is between -size and size. -Note that since the size is an int32, this does not actually cover the full -range of int64. See DontSize<int64> instead. - - - - -Generate arbitrary int32 that is between -size and size. - - - - -Generate arbitrary int16 that is between -size and size. - - - - - Generate a System.Collections.Generic.IList of values. - - - - - Generate a System.Collections.Generic.IDictionary of values. - Shrinks by reducing the number of elements - - - - - Generate a System.Collections.Generic.ICollection of values. - - - - -Generate a Function value that can be printed and shrunk. Function values can be generated for types 'a->'b -where 'b has an Arbitrary instance. - - - - -Generate a list of values. The size of the list is between 0 and the test size + 1. - - - - -Generates arbitrary floats, NaN, NegativeInfinity, PositiveInfinity, Maxvalue, MinValue, Epsilon included fairly frequently. - - - - -Generates arbitrary floats, NaN, NegativeInfinity, PositiveInfinity, Maxvalue, MinValue, Epsilon included fairly frequently. - - - - -Arrays whose length does not change when shrinking. - - - - -Generate arbitrary uint32 that is uniformly distributed in the whole range of uint32 values. - - - - -Generate arbitrary uint32 that is uniformly distributed in the whole range of uint32 values. - - - - -Generate arbitrary uint16 that is uniformly distributed in the whole range of uint16 values. - - - - -Generate arbitrary int64 between Int64.MinValue and Int64.MaxValue - - - - -Generate arbitrary int32 that is between Int32.MinValue and Int32.MaxValue - - - - -Generate arbitrary int16 that is uniformly distributed in the whole range of int16 values. - - - - -Overrides the shrinker of any type to be empty, i.e. not to shrink at all. - - - - - Generate a System.Collections.Generic.Dictionary of values. - Shrinks by reducing the number of elements - - - - -Try to derive an arbitrary instance for the given type reflectively. -Generates and shrinks values for record, union, tuple and enum types. -Also generates (but doesn't shrink) values for immutable classes -(i.e. single constructor, no mutable properties or fields). - - - - -Generate arbitrary decimal. - - - - -Generates an arbitrary DateTimeOffset between 1900 and 2100. - A DateTimeOffset is shrunk first by shrinking its offset, then by removing its second, minute and hour components. - - - - -Generates an arbitrary DateTime between 1900 and 2100. -A DateTime is shrunk by removing its second, minute and hour components. - - - - -Generates arbitrary chars, between ASCII codes Char.MinValue and 127. - - - - -Generates an arbitrary byte. - - - - -Generates an arbitrary bool. - - - - -Arbitray instance for BigInteger. - - - - -Generate a function value. Function values can be generated for types 'a->'b where 'b has an Arbitrary instance. -THere is no shrinking function values. - - - - -Generate a rank 2, zero based array. - - - - -Generate a rank 1 array. - - - - - Return an Arbitrary instance that is a mapped and filtered version of an existing arbitrary instance. - The generator uses Gen.map with the given mapper and then Gen.suchThat with the given predicate, - and the shrinks are filtered using Seq.filter with the given predicate. -This is sometimes useful if using just a filter would reduce the chance of getting a good value -from the generator - and you can map the value instead. E.g. PositiveInt. - - - - - Return an Arbitrary instance that is a filtered version of an existing arbitrary instance. - The generator uses Gen.suchThat, and the shrinks are filtered using Seq.filter with the given predicate. - - - - -Construct an Arbitrary instance for a type that can be mapped to and from another type (e.g. a wrapper), -based on a Arbitrary instance for the source type and two mapping functions. - - - - - Construct an Arbitrary instance from a generator and shrinker. - - - - - Construct an Arbitrary instance from a generator. - Shrink is not supported for this type. - - - - -A generic shrinker that should work for most number-like types. - - - - -Returns the immediate shrinks for the given value based on its type. - - - - -Returns a Gen<'Value> - - - - -Get the Arbitrary instance for the given type. - - - - -Register the generators that are static members of the type argument. - - - - -Register the generators that are static members of the given type. - - - - -Turn a specification into a property. - - - - -Memoize the given function. - - - - -Memoize the given function using the given dictionary - - - - -Generate a number of possible commands based on the current state of the model. -Preconditions are still checked, so even if a Command is returned, it is not chosen -if its precondition does not hold. - - - - -Defines the initial state for actual and model object, and allows to define the generator to use -for the next state, based on the model. - - - - -Executes the command on the model of the object. - - - - -The default precondition is true. - - - - -Optional precondition for execution of the command. When this does not hold, the test continues -but the command is not executed. - - - - -Excecutes the command on the object under test, and returns a property that must hold. -This property typically compares the state of the model with the state of the object after -execution of the command. - - - - -An operation describes pre and post conditions and the model for a single operation under test. -The post-conditions are the invariants that will be checked; when these do not hold the test fails. - - - - -Initial state of model object. Must correspond to initial state of actual object. - - - - -Randomly generate the initial state of the actual object. Should still correspond to the -initial state of model object; so you should only randomly generate parameters to the instance -that don't affect the model. -Note:make sure that each value is truly a new instance if the commands change the state -of the object. Gen.connstant in particular is a bad idea - use Gen.fresh instead. - - - - -Turn a specification into a property. - - - - -Basic co-arbitrary generator transformer, which is dependent on an int. -Only used for generating arbitrary functions. - - - - -Promote the given function f to a function generator. Only used for generating arbitrary functions. - - - - -Apply the given Gen function to the given generator, aka the applicative <*> operator. - - - - -Generate a fresh instance every time the generatoris called. Useful for mutable objects. -See also constant. - - - - -Generate a fresh instance every time the generatoris called. Useful for mutable objects. -See also constant. - - - - -Always generate the same instance v. See also fresh. - - - - - Generates a 2D array. The square root of the size is the maximum number of rows and columns. - - - - - Generates a 2D array of the given dimensions. - - - - - Generates an array using the specified generator. The maximum length is the size+1. - - - - - Generates an array of a specified length. - - - - - Generates sublists of the given arguments. - - - - - Generates sublists of the given IEnumerable. - - - - - Generates sublists of the given sequence. - - - - - Generates a non-empty list of random length. The maximum length - depends on the size parameter. - - - - - Generates a list of random length. The maximum length depends on the - size parameter. - - - - -Generates a value that satisfies a predicate. Contrary to suchThatOption, this function keeps re-trying -by increasing the size of the original generator ad infinitum. Make sure there is a high chance that -the predicate is satisfied. - - - - -Tries to generate a value that satisfies a predicate. This function 'gives up' by generating None -if the given original generator did not generate any values that satisfied the predicate, after trying to -get values from by increasing its size. - - - - -Generates a list of given length, containing values generated by the given generator. - - - - -Sequence the given list of generators into a generator of a list. - - - - -Sequence the given list of generators into a generator of a list. - - - - -Sequence the given seq of generators into a generator of a list. - - - - -Map the given function over values to a function over generators of those values. - - - - -Map the given function over values to a function over generators of those values. - - - - -Build a generator that generates a 4-tuple of the values generated by the given generator. - - - - -Map the given function over values to a function over generators of those values. - - - - -Build a generator that generates a 3-tuple of the values generated by the given generator. - - - - -Map the given function over values to a function over generators of those values. - - - - -Build a generator that generates a 2-tuple of the values generated by the given generator. - - - - -Map the given function over values to a function over generators of those values. - - - - -Build a generator that generates a value from one of the generators in the given non-empty seq, with -given probabilities. The sum of the probabilities must be larger than zero. - - - - -Build a generator that generates a value from one of the generators in the given non-empty seq, with -given probabilities. The sum of the probabilities must be larger than zero. - - - - -Build a generator that generates a value from one of the generators in the given non-empty seq, with -given probabilities. The sum of the probabilities must be larger than zero. - - - - -Build a generator that generates a value from one of the generators in the given non-empty seq, with -given probabilities. The sum of the probabilities must be larger than zero. - - - - -Build a generator that generates a value from one of the given generators, with -equal probability. - - - - -Build a generator that generates a value from one of the generators in the given non-empty seq, with -equal probability. - - - - -Build a generator that randomly generates one of the values in the given non-empty seq. - - - - -Build a generator that randomly generates one of the values in the given non-empty seq. - - - - -Generates an integer between l and h, inclusive. - - - - -Generates n values of the given size. - - - - -Generates a value with maximum size n. - - - - -Override the current size of the test. resize n g invokes generator g with size parameter n. - - - - -Obtain the current size. sized g calls g, passing it the current size as a parameter. - - - - -Obtain the current size. sized g calls g, passing it the current size as a parameter. - - - - -Apply the function f to the value in the generator, yielding a new generator. - - - - -Combinators to build custom random generators for any type. - - - - -The workflow type for generators. - - - - -The workflow function for generators, e.g. gen { ... } - - - - -Computation expression builder for Gen. - - - - - Turns a testable type into a property. Testables are unit, boolean, Lazy testables, Gen testables, functions - from a type for which a generator is know to a testable, tuples up to 6 tuple containing testables, and lists - containing testables. - - - - -Fails the property if it does not complete within t milliseconds. Note that the called property gets a -cancel signal, but whether it responds to that is up to the property; the execution may not actually stop. - - - - -Add the given label to the property. The labels of a failing sub-property are displayed when it fails. - - - - -Collect data values. The argument of collect is evaluated in each test case, -and the distribution of values is reported, using sprintf "%A". - - - - -Count trivial cases. Test cases for which the condition is True are classified as trivial. - - - - -Classify test cases. Test cases satisfying the condition are assigned the classification given. - - - - -Expect exception 't when executing p. So, results in success if an exception of the given type is thrown, -and a failure otherwise. - - - - -Depending on the condition, return the first testable if true and the second if false. - - - - -Quantified property combinator. Provide a custom test data generator to a property. - - - - -Combinators to build properties, which define the property to be tested, with some -convenience methods to investigate the generated arguments and any found counter-examples. - - - - -Construct a property that fails if both fail. (cfr 'or') - - - - -Construct a property that succeeds if both succeed. (cfr 'and') - - - - -Add the given label to the property. Property on the left hand side, label on the right. - - - - -Add the given label to the property. label on the left hand side, property on the right. - - - - -Add the given label to the property. Property on the left hand side, label on the right. - - - - -Conditional property combinator. Resulting property holds if the property after ==> holds whenever the condition does. - - - - -Operators for Prop. - - - - -Generate random numbers based on splitting seeds. Based Hugs' Random implementation. - - - - - Get reader for union case name (aka tag) - - - - - Returns the case name, type, and functions that will construct a constructor and a reader of a union type respectively - - - - - Get reader for record type - - - - - Get constructor for record type - - - - - Get information on the fields of a record type - - - - -Build a reflection-based generator for the given Type. Since we memoize based on type, can't use a -typed variant reflectGen<'a> much here, as we need to be able to partially apply on the getGenerator. -See also Default.Derive. - - - - - Generate a random enum of the type specified by the System.Type - - - - -Force this value to do the necessary initializations of typeclasses. Normally this initialization happens automatically. -In any case, it can be forced any number of times without problem. - - - - -A runner that prints results to the standard output. - - - - -A function that returns the default string that is printed as a result of the test. - - - - -Merge the instances defined by the given instances type with the ones already defined in this TypeClass. -Instances defined in the given type override the instances in this TypeClass instance. - - - - -Get the instance registered on this TypeClass for the given type parameter 'T. The result will be cast -to TypeClassT, which should be 'TypeClass<'T> but that's impossible to express in .NET's type system. - - - - -Get the instance registered on this TypeClass for the given type and optionally the given arguments. -The result is of type 'TypeClass<'T>, dynamically. - - - - -Discover instances for this TypeClass on the given type. Merge the result with this TypeClass, -with the newly discovered instances overriding the instances on this TypeClass. - - - - -Make a new TypeClass with only the instances registered on the given type. -Note that the instances of this TypeClass will not be registered on the new TypeClass. -Use Merge in addition to achieve that, or use DiscoverAndMerge to do both. - - - - -Compares this TypeClass with the given TypeClass. Returns, respectively, the new instances, overridden instances, -new array instances, overridden array instances, new catch all or overridden catchall introduced by the other TypeClass. - - - - -Haskell typeclass concept simulation. For internal use. - - - - diff --git a/packages/FsCheck.2.2.4/lib/portable-net45+netcore45+wp8/FsCheck.dll b/packages/FsCheck.2.2.4/lib/portable-net45+netcore45+wp8/FsCheck.dll deleted file mode 100644 index 30bc2a2..0000000 Binary files a/packages/FsCheck.2.2.4/lib/portable-net45+netcore45+wp8/FsCheck.dll and /dev/null differ diff --git a/packages/FsCheck.2.2.4/lib/portable-net45+netcore45+wpa81+wp8/FsCheck.XML b/packages/FsCheck.2.2.4/lib/portable-net45+netcore45+wpa81+wp8/FsCheck.XML deleted file mode 100644 index 7765158..0000000 --- a/packages/FsCheck.2.2.4/lib/portable-net45+netcore45+wpa81+wp8/FsCheck.XML +++ /dev/null @@ -1,1667 +0,0 @@ - - -FsCheck - - - - Return an Arbitrary instance that is a mapped and filtered version of an existing arbitrary instance. - The generator uses Gen.map with the given mapper and then Gen.suchThat with the given predicate, - and the shrinks are filtered using Seq.filter with the given predicate. -This is sometimes useful if using just a filter would reduce the chance of getting a good value -from the generator - and you can map the value instead. E.g. PositiveInt. - - - - - Return an Arbitrary instance that is a filtered version of an existing arbitrary instance. - The generator uses Gen.suchThat, and the shrinks are filtered using Seq.filter with the given predicate. - - - - -Construct an Arbitrary instance for a type that can be mapped to and from another type (e.g. a wrapper), -based on a Arbitrary instance for the source type and two mapping functions. - - - - -Extensons to transform Arbitrary instances into other Arbitrary instances. - - - - -Returns a generator for 'a. - - - - -Returns a sequence of the immediate shrinks of the given value. The immediate shrinks should not include -doubles or the given value itself. The default implementation returns the empty sequence (i.e. no shrinking). - - - - - Check all public static methods on the given type that have a testable return type with the verbose configuration, -and throws on failure or exhaustion. - - - - - Check all public static methods on the given type that have a testable return type with vthe erbose configuration, -and throws on failure or exhaustion. - - - - -Check one property with the verbose configuration, and throw an exception if it fails or is exhausted. - - - - - Check all public static methods on the given type that have a testable return type with vthe erbose configuration - - - - - Check all public static methods on the given type that have a testable return type with vthe erbose configuration - - - - -Check one property with the verbose configuration, and using the given name. - - - - -Check one property with the verbose configuration. - - - - -Check all public static methods on the given type that have a testable return type with quick configuration - - - - -Check all public static methods on the given type that have a testable return type with quick configuration, -and throw on failure or exhaustion. - - - - -Check one property with the quick configuration, and throw an exception if it fails or is exhausted. - - - - -Check all public static methods on the given type that have a testable return type with quick configuration - - - - -Check all public static methods on the given type that have a testable return type with quick configuration - - - - -Check one property with the quick configuration, and using the given name. - - - - -Check one property with the quick configuration. - - - - -Check the given property using the given config, and the given test name. - - - - -Check the given property using the given config. - - - - -Check the given property identified by the given MethodInfo. - - - - -Check all public static methods on the given type that have a testable return type with the given configuration. -This includes let-bound functions in a module. - - - - -Check all public static methods on the given type that have a testable return type with the given configuration. -This includes let-bound functions in a module. - - - - -Executes the command on the model of the object. - - - - -Excecutes the command on the actual object under test. - - - - -The default precondition is true. - - - - -Precondition for execution of the command. When this does not hold, the test continues -but the command will not be executed. - - - - -The default postcondition is true. - - - - -Postcondition that must hold after execution of the command. Compares state of model and actual -object and fails the property if they do not match. - - - - -A single command describes pre and post conditions and the model for a single method under test. -The post-conditions are the invariants that will be checked; when these do not hold the test fails. - - - - -A custom test runner, e.g. to integrate with a test framework like xUnit or NUnit. - - - - -The Arbitrary instances on this class will be merged in back to front order, i.e. instances for the same generated type at the front -of the list will override those at the back. The instances on Arb.Default are always known, and are at the back (so they can always be -overridden) - - - - -What to print every time a counter-example is succesfully shrunk - - - - -What to print when new arguments args are generated in test n - - - - -If set, suppresses the output from the test if the test is successful. - - - - -The size to use for the last test, when all the tests are passing. The size increases linearly between Start- and EndSize. - - - - -The size to use for the first test. - - - - -Name of the test. - - - - -If set, the seed to use to start testing. Allows reproduction of previous runs. - - - - -The maximum number of tests where values are rejected, e.g. as the result of ==> - - - - -The maximum number of tests that are run. - - - - -Like the Verbose configuration, only throws an exception with the error message if the test fails or is exhausted. -Useful for use within other unit testing frameworks that usually adopt this methodolgy to signal failure. - - - - -The verbose configuration prints each generated argument. - - - - -Like the Quick configuration, only throws an exception with the error message if the test fails or is exhausted. -Useful for use within other unit testing frameworks that usually adopt this methodolgy to signal failure. - - - - -The quick configuration only prints a summary result at the end of the test. - - - - -The default configuration is the quick configuration. - - - - -For configuring a run. - - - - -The size to use for the first test. - - - - -A custom test runner, e.g. to integrate with a test framework like xUnit or NUnit. - - - - -If set, the seed to use to start testing. Allows reproduction of previous runs. - - - - -If set, suppresses the output from the test if the test is successful. - - - - -Name of the test. - - - - -The maximum number of tests that are run. - - - - -The maximum number of tests where values are rejected - - - - -What to print every time a counter-example is succesfully shrunk - - - - -What to print when new arguments args are generated in test n - - - - -The size to use for the last test, when all the tests are passing. The size increases linearly between Start- and EndSize. - - - - -The size to use for the first test. - - - - -A custom test runner, e.g. to integrate with a test framework like xUnit or NUnit. - - - - -If set, the seed to use to start testing. Allows reproduction of previous runs. - - - - -If set, suppresses the output from the test if the test is successful. - - - - -Name of the test. - - - - -The maximum number of tests that are run. - - - - -The maximum number of tests where values are rejected - - - - -What to print every time a counter-example is succesfully shrunk - - - - -What to print when new arguments args are generated in test n - - - - -The size to use for the last test, when all the tests are passing. The size increases linearly between Start- and EndSize. - - - - -Configure the test run. - - - - -Use the generator for 'a, but don't shrink. - - - - -Whereas most types are restricted by a size that grows -as the test gets further, by applying this type the underlying -type will ignore this size and always generate from the full range. -Note that this only makes a difference for types that have a range - -currently Int16, Int32, Int64 have DontSize Arbitrary instances. -This is typically (and at least currently) only applicable for value types -that are comparable, hence the type constraints. - - - - -Represents an array whose length does not change when shrinking. - - - - -A function (F# function) that can be displayed and shrunk. - - - - -Generates a value that satisfies a predicate. This function keeps re-trying -by increasing the size of the original generator ad infinitum. Make sure there is a high chance that -the predicate is satisfied. - - - - -Build a generator that generates a 2-tuple of the values generated by the given generator. - - - - - Construct an Arbitrary instance from a generator and a shrinker. - - - - - Construct an Arbitrary instance from a generator. - Shrink is not supported for this type. - - - - -Build a generator that generates a 3-tuple of the values generated by the given generator. - - - - -Map the given function to the value in the generator, yielding a new generator of the result type. - - - - -Generates n values of the given size. - - - - -Override the current size of the test. - - - - - Generates a non-empty list of random length. The maximum length - depends on the size parameter. - - - - - Generates a list of random length. The maximum length depends on the - size parameter. - - - - -Generates a list of given length, containing values generated by the given generator. - - - - -Build a generator that generates a 4-tuple of the values generated by the given generator. - - - - -Generates a value with maximum size n. - - - - - Generates an array using the specified generator. - The maximum length is size+1. - - - - - Generates an array of a specified length. - - - - - Generates a 2D array. The square root of the size is the maximum number of rows and columns. - - - - - Generates a 2D array of the given dimensions. - - - - -Apply the given Gen function to this generator, aka the applicative <*> operator. - - - - -Extension methods to build generators - contains among other the Linq methods. - - - - - Lifted function application = apply f to a, all in the Gen applicative functor. - - - - - Like <*>, but puts f in a Gen first. - - - - - Bind operator; runs the first generator, then feeds the result - to the second generator function. - - - - -map the given function to the value in the generator, yielding a new generator of the result type. - - - - -Generator of a random value, based on a size parameter and a randomly generated int. - - - - -Initial state of model object. Should correspond to initial state of actual object. - - - - -Initial state of actual object. Should correspond to initial state of model object. - - - - -Generate a number of possible commands based on the current state of the model. -Preconditions are still checked, so even if a Command is returned, it is not chosen -if its precondition does not hold. - - - - -Defines the initial state for actual and model object, and allows to define the generator to use -for the next state, based on the model. - - - - -Called before a group of properties on a type are checked. - - - - -Called on a succesful shrink. - - - - -Called whenever all tests are done, either True, False or Exhausted. - - - - -Called whenever arguments are generated and after the test is run. - - - - -For implementing your own test runner. - - - - -Represents an int that can include int.MinValue and int.MaxValue. - - - - -Represents an integer interval. - - - - -Represents a non-empty array. - - - - -Represents a non-empty Set. - - - - -Represents a string that is not null or empty, and does not contain any null characters ('\000') - - - - -Represents an int >= 0 - - - - -Wrap a type in NonNull to prevent null being generated for the wrapped type. - - - - -Represents an int <> 0 - - - - -Represents a float that is not NaN or Infinity. - - - - - determines for which Outcome the result should be shrunk, or shrinking should continue. - - - - -Represents an int > 0 - - - - -A Property can be checked by FsCheck. - - - - -Conditional property combinator. Resulting property holds if the property holds when the condition does. - - - - -Conditional property combinator. Resulting property holds if the property holds when the condition does. - - - - -Conditional property combinator. Resulting property holds if the property holds when the condition does. - - - - -Count trivial cases. Test cases for which the condition is True are classified as trivial. - - - - -Count trivial cases. Test cases for which the condition is True are classified as trivial. - - - - -Count trivial cases. Test cases for which the condition is True are classified as trivial. - - - - -Count trivial cases. Test cases for which the condition is True are classified as trivial. - - - - - Turns a testable type into a property. - - - - - Turns a testable type into a property. - - - - - Turns a testable type into a property. - - - - -Construct a property that fails if both fail. (cfr 'or') - - - - -Construct a property that fails if both fail. (cfr 'or') - - - - -Construct a property that fails if both fail. (cfr 'or') - - - - -Construct a property that fails if both fail. (cfr 'or') - - - - -Add the given label to the property. The labels of a failing sub-property are displayed when it fails. - - - - -Add the given label to the property. The labels of a failing sub-property are displayed when it fails. - - - - -Add the given label to the property. The labels of a failing sub-property are displayed when it fails. - - - - -Add the given label to the property. The labels of a failing sub-property are displayed when it fails. - - - - -Collect data values. The argument of collect is evaluated in each test case, -and the distribution of values is reported. - - - - -Collect data values. The argument of collect is evaluated in each test case, -and the distribution of values is reported. - - - - -Collect data values. The argument of collect is evaluated in each test case, -and the distribution of values is reported. - - - - -Collect data values. The argument of collect is evaluated in each test case, -and the distribution of values is reported. - - - - -Classify test cases. Test cases satisfying the condition are assigned the classification given. - - - - -Classify test cases. Test cases satisfying the condition are assigned the classification given. - - - - -Classify test cases. Test cases satisfying the condition are assigned the classification given. - - - - -Construct a property that succeeds if both succeed. (cfr 'and') - - - - -Construct a property that succeeds if both succeed. (cfr 'and') - - - - -Construct a property that succeeds if both succeed. (cfr 'and') - - - - -Construct a property that succeeds if both succeed. (cfr 'and') - - - - -Extensons to construct Properties. - - - - -Returns a new result that is Succeeded if and only if both this -and the given Result are Succeeded. - - - - -The result of one execution of a property. - - - - -Represents a string that does not contain null characters ('\000') - - - - -2-tuple containing a weight and a value, used in some Gen methods to indicate -the probability of a value. - - - - -Generates (), of the unit type. - - - - -Generate arbitrary uint64 that is between 0 and size. - - - - -Generate arbitrary uint32 that is between 0 and size. - - - - -Generate arbitrary uint16 that is between 0 and size. - - - - -Generates an arbitrary TimeSpan. A TimeSpan is shrunk by removing days, hours, minutes, second and milliseconds. - - - - -Generates a Func'4. - - - - -Generates a Func'3. - - - - -Generates a Func'2. - - - - -Generates a Func'1. - - - - -Generates an Action'3 - - - - -Generates an Action'2 - - - - -Generates an Action'1 - - - - -Generates an Action'0 - - - - -Generates arbitrary strings, which are lists of chars generated by Char. - - - - -Generates an arbitrary signed byte. - - - - -Generate an option value that is 'None' 1/8 of the time. - - - - -Generate an object - a boxed char, string or boolean value. - - - - -Generate a nullable value that is null 1/8 of the time. - - - - - Generates an Float (without NaN, Infinity) - - - - -Generate underlying values that are not null. - - - - - Generate a System.Collections.Generic.List of values. - - - - -Generates an interval between two non-negative integers. - - - - -Generate arbitrary int64 that is between -size and size. -Note that since the size is an int32, this does not actually cover the full -range of int64. See DontSize<int64> instead. - - - - -Generate arbitrary int32 that is between -size and size. - - - - -Generate arbitrary int16 that is between -size and size. - - - - - Generate a System.Collections.Generic.IList of values. - - - - - Generate a System.Collections.Generic.IDictionary of values. - Shrinks by reducing the number of elements - - - - - Generate a System.Collections.Generic.ICollection of values. - - - - -Generate a Function value that can be printed and shrunk. Function values can be generated for types 'a->'b -where 'b has an Arbitrary instance. - - - - -Generate a list of values. The size of the list is between 0 and the test size + 1. - - - - -Generates arbitrary floats, NaN, NegativeInfinity, PositiveInfinity, Maxvalue, MinValue, Epsilon included fairly frequently. - - - - -Generates arbitrary floats, NaN, NegativeInfinity, PositiveInfinity, Maxvalue, MinValue, Epsilon included fairly frequently. - - - - -Arrays whose length does not change when shrinking. - - - - -Generate arbitrary uint32 that is uniformly distributed in the whole range of uint32 values. - - - - -Generate arbitrary uint32 that is uniformly distributed in the whole range of uint32 values. - - - - -Generate arbitrary uint16 that is uniformly distributed in the whole range of uint16 values. - - - - -Generate arbitrary int64 between Int64.MinValue and Int64.MaxValue - - - - -Generate arbitrary int32 that is between Int32.MinValue and Int32.MaxValue - - - - -Generate arbitrary int16 that is uniformly distributed in the whole range of int16 values. - - - - -Overrides the shrinker of any type to be empty, i.e. not to shrink at all. - - - - - Generate a System.Collections.Generic.Dictionary of values. - Shrinks by reducing the number of elements - - - - -Try to derive an arbitrary instance for the given type reflectively. -Generates and shrinks values for record, union, tuple and enum types. -Also generates (but doesn't shrink) values for immutable classes -(i.e. single constructor, no mutable properties or fields). - - - - -Generate arbitrary decimal. - - - - -Generates an arbitrary DateTimeOffset between 1900 and 2100. - A DateTimeOffset is shrunk first by shrinking its offset, then by removing its second, minute and hour components. - - - - -Generates an arbitrary DateTime between 1900 and 2100. -A DateTime is shrunk by removing its second, minute and hour components. - - - - -Generates arbitrary chars, between ASCII codes Char.MinValue and 127. - - - - -Generates an arbitrary byte. - - - - -Generates an arbitrary bool. - - - - -Arbitray instance for BigInteger. - - - - -Generate a function value. Function values can be generated for types 'a->'b where 'b has an Arbitrary instance. -THere is no shrinking function values. - - - - -Generate a rank 2, zero based array. - - - - -Generate a rank 1 array. - - - - - Return an Arbitrary instance that is a mapped and filtered version of an existing arbitrary instance. - The generator uses Gen.map with the given mapper and then Gen.suchThat with the given predicate, - and the shrinks are filtered using Seq.filter with the given predicate. -This is sometimes useful if using just a filter would reduce the chance of getting a good value -from the generator - and you can map the value instead. E.g. PositiveInt. - - - - - Return an Arbitrary instance that is a filtered version of an existing arbitrary instance. - The generator uses Gen.suchThat, and the shrinks are filtered using Seq.filter with the given predicate. - - - - -Construct an Arbitrary instance for a type that can be mapped to and from another type (e.g. a wrapper), -based on a Arbitrary instance for the source type and two mapping functions. - - - - - Construct an Arbitrary instance from a generator and shrinker. - - - - - Construct an Arbitrary instance from a generator. - Shrink is not supported for this type. - - - - -A generic shrinker that should work for most number-like types. - - - - -Returns the immediate shrinks for the given value based on its type. - - - - -Returns a Gen<'Value> - - - - -Get the Arbitrary instance for the given type. - - - - -Register the generators that are static members of the type argument. - - - - -Register the generators that are static members of the given type. - - - - -Turn a specification into a property. - - - - -Memoize the given function. - - - - -Memoize the given function using the given dictionary - - - - -Generate a number of possible commands based on the current state of the model. -Preconditions are still checked, so even if a Command is returned, it is not chosen -if its precondition does not hold. - - - - -Defines the initial state for actual and model object, and allows to define the generator to use -for the next state, based on the model. - - - - -Executes the command on the model of the object. - - - - -The default precondition is true. - - - - -Optional precondition for execution of the command. When this does not hold, the test continues -but the command is not executed. - - - - -Excecutes the command on the object under test, and returns a property that must hold. -This property typically compares the state of the model with the state of the object after -execution of the command. - - - - -An operation describes pre and post conditions and the model for a single operation under test. -The post-conditions are the invariants that will be checked; when these do not hold the test fails. - - - - -Initial state of model object. Must correspond to initial state of actual object. - - - - -Randomly generate the initial state of the actual object. Should still correspond to the -initial state of model object; so you should only randomly generate parameters to the instance -that don't affect the model. -Note:make sure that each value is truly a new instance if the commands change the state -of the object. Gen.connstant in particular is a bad idea - use Gen.fresh instead. - - - - -Turn a specification into a property. - - - - -Basic co-arbitrary generator transformer, which is dependent on an int. -Only used for generating arbitrary functions. - - - - -Promote the given function f to a function generator. Only used for generating arbitrary functions. - - - - -Apply the given Gen function to the given generator, aka the applicative <*> operator. - - - - -Generate a fresh instance every time the generatoris called. Useful for mutable objects. -See also constant. - - - - -Generate a fresh instance every time the generatoris called. Useful for mutable objects. -See also constant. - - - - -Always generate the same instance v. See also fresh. - - - - - Generates a 2D array. The square root of the size is the maximum number of rows and columns. - - - - - Generates a 2D array of the given dimensions. - - - - - Generates an array using the specified generator. The maximum length is the size+1. - - - - - Generates an array of a specified length. - - - - - Generates sublists of the given arguments. - - - - - Generates sublists of the given IEnumerable. - - - - - Generates sublists of the given sequence. - - - - - Generates a non-empty list of random length. The maximum length - depends on the size parameter. - - - - - Generates a list of random length. The maximum length depends on the - size parameter. - - - - -Generates a value that satisfies a predicate. Contrary to suchThatOption, this function keeps re-trying -by increasing the size of the original generator ad infinitum. Make sure there is a high chance that -the predicate is satisfied. - - - - -Tries to generate a value that satisfies a predicate. This function 'gives up' by generating None -if the given original generator did not generate any values that satisfied the predicate, after trying to -get values from by increasing its size. - - - - -Generates a list of given length, containing values generated by the given generator. - - - - -Sequence the given list of generators into a generator of a list. - - - - -Sequence the given list of generators into a generator of a list. - - - - -Sequence the given seq of generators into a generator of a list. - - - - -Map the given function over values to a function over generators of those values. - - - - -Map the given function over values to a function over generators of those values. - - - - -Build a generator that generates a 4-tuple of the values generated by the given generator. - - - - -Map the given function over values to a function over generators of those values. - - - - -Build a generator that generates a 3-tuple of the values generated by the given generator. - - - - -Map the given function over values to a function over generators of those values. - - - - -Build a generator that generates a 2-tuple of the values generated by the given generator. - - - - -Map the given function over values to a function over generators of those values. - - - - -Build a generator that generates a value from one of the generators in the given non-empty seq, with -given probabilities. The sum of the probabilities must be larger than zero. - - - - -Build a generator that generates a value from one of the generators in the given non-empty seq, with -given probabilities. The sum of the probabilities must be larger than zero. - - - - -Build a generator that generates a value from one of the generators in the given non-empty seq, with -given probabilities. The sum of the probabilities must be larger than zero. - - - - -Build a generator that generates a value from one of the generators in the given non-empty seq, with -given probabilities. The sum of the probabilities must be larger than zero. - - - - -Build a generator that generates a value from one of the given generators, with -equal probability. - - - - -Build a generator that generates a value from one of the generators in the given non-empty seq, with -equal probability. - - - - -Build a generator that randomly generates one of the values in the given non-empty seq. - - - - -Build a generator that randomly generates one of the values in the given non-empty seq. - - - - -Generates an integer between l and h, inclusive. - - - - -Generates n values of the given size. - - - - -Generates a value with maximum size n. - - - - -Override the current size of the test. resize n g invokes generator g with size parameter n. - - - - -Obtain the current size. sized g calls g, passing it the current size as a parameter. - - - - -Obtain the current size. sized g calls g, passing it the current size as a parameter. - - - - -Apply the function f to the value in the generator, yielding a new generator. - - - - -Combinators to build custom random generators for any type. - - - - -The workflow type for generators. - - - - -The workflow function for generators, e.g. gen { ... } - - - - -Computation expression builder for Gen. - - - - - Turns a testable type into a property. Testables are unit, boolean, Lazy testables, Gen testables, functions - from a type for which a generator is know to a testable, tuples up to 6 tuple containing testables, and lists - containing testables. - - - - -Fails the property if it does not complete within t milliseconds. Note that the called property gets a -cancel signal, but whether it responds to that is up to the property; the execution may not actually stop. - - - - -Add the given label to the property. The labels of a failing sub-property are displayed when it fails. - - - - -Collect data values. The argument of collect is evaluated in each test case, -and the distribution of values is reported, using sprintf "%A". - - - - -Count trivial cases. Test cases for which the condition is True are classified as trivial. - - - - -Classify test cases. Test cases satisfying the condition are assigned the classification given. - - - - -Expect exception 't when executing p. So, results in success if an exception of the given type is thrown, -and a failure otherwise. - - - - -Depending on the condition, return the first testable if true and the second if false. - - - - -Quantified property combinator. Provide a custom test data generator to a property. - - - - -Combinators to build properties, which define the property to be tested, with some -convenience methods to investigate the generated arguments and any found counter-examples. - - - - -Construct a property that fails if both fail. (cfr 'or') - - - - -Construct a property that succeeds if both succeed. (cfr 'and') - - - - -Add the given label to the property. Property on the left hand side, label on the right. - - - - -Add the given label to the property. label on the left hand side, property on the right. - - - - -Add the given label to the property. Property on the left hand side, label on the right. - - - - -Conditional property combinator. Resulting property holds if the property after ==> holds whenever the condition does. - - - - -Operators for Prop. - - - - -Generate random numbers based on splitting seeds. Based Hugs' Random implementation. - - - - - Get reader for union case name (aka tag) - - - - - Returns the case name, type, and functions that will construct a constructor and a reader of a union type respectively - - - - - Get reader for record type - - - - - Get constructor for record type - - - - - Get information on the fields of a record type - - - - -Build a reflection-based generator for the given Type. Since we memoize based on type, can't use a -typed variant reflectGen<'a> much here, as we need to be able to partially apply on the getGenerator. -See also Default.Derive. - - - - - Generate a random enum of the type specified by the System.Type - - - - -Force this value to do the necessary initializations of typeclasses. Normally this initialization happens automatically. -In any case, it can be forced any number of times without problem. - - - - -A runner that prints results to the standard output. - - - - -A function that returns the default string that is printed as a result of the test. - - - - -Merge the instances defined by the given instances type with the ones already defined in this TypeClass. -Instances defined in the given type override the instances in this TypeClass instance. - - - - -Get the instance registered on this TypeClass for the given type parameter 'T. The result will be cast -to TypeClassT, which should be 'TypeClass<'T> but that's impossible to express in .NET's type system. - - - - -Get the instance registered on this TypeClass for the given type and optionally the given arguments. -The result is of type 'TypeClass<'T>, dynamically. - - - - -Discover instances for this TypeClass on the given type. Merge the result with this TypeClass, -with the newly discovered instances overriding the instances on this TypeClass. - - - - -Make a new TypeClass with only the instances registered on the given type. -Note that the instances of this TypeClass will not be registered on the new TypeClass. -Use Merge in addition to achieve that, or use DiscoverAndMerge to do both. - - - - -Compares this TypeClass with the given TypeClass. Returns, respectively, the new instances, overridden instances, -new array instances, overridden array instances, new catch all or overridden catchall introduced by the other TypeClass. - - - - -Haskell typeclass concept simulation. For internal use. - - - - diff --git a/packages/FsCheck.2.2.4/lib/portable-net45+netcore45+wpa81+wp8/FsCheck.dll b/packages/FsCheck.2.2.4/lib/portable-net45+netcore45+wpa81+wp8/FsCheck.dll deleted file mode 100644 index e0d2a3d..0000000 Binary files a/packages/FsCheck.2.2.4/lib/portable-net45+netcore45+wpa81+wp8/FsCheck.dll and /dev/null differ diff --git a/packages/FsCheck.2.2.4/lib/portable-net45+netcore45/FsCheck.XML b/packages/FsCheck.2.2.4/lib/portable-net45+netcore45/FsCheck.XML deleted file mode 100644 index 7765158..0000000 --- a/packages/FsCheck.2.2.4/lib/portable-net45+netcore45/FsCheck.XML +++ /dev/null @@ -1,1667 +0,0 @@ - - -FsCheck - - - - Return an Arbitrary instance that is a mapped and filtered version of an existing arbitrary instance. - The generator uses Gen.map with the given mapper and then Gen.suchThat with the given predicate, - and the shrinks are filtered using Seq.filter with the given predicate. -This is sometimes useful if using just a filter would reduce the chance of getting a good value -from the generator - and you can map the value instead. E.g. PositiveInt. - - - - - Return an Arbitrary instance that is a filtered version of an existing arbitrary instance. - The generator uses Gen.suchThat, and the shrinks are filtered using Seq.filter with the given predicate. - - - - -Construct an Arbitrary instance for a type that can be mapped to and from another type (e.g. a wrapper), -based on a Arbitrary instance for the source type and two mapping functions. - - - - -Extensons to transform Arbitrary instances into other Arbitrary instances. - - - - -Returns a generator for 'a. - - - - -Returns a sequence of the immediate shrinks of the given value. The immediate shrinks should not include -doubles or the given value itself. The default implementation returns the empty sequence (i.e. no shrinking). - - - - - Check all public static methods on the given type that have a testable return type with the verbose configuration, -and throws on failure or exhaustion. - - - - - Check all public static methods on the given type that have a testable return type with vthe erbose configuration, -and throws on failure or exhaustion. - - - - -Check one property with the verbose configuration, and throw an exception if it fails or is exhausted. - - - - - Check all public static methods on the given type that have a testable return type with vthe erbose configuration - - - - - Check all public static methods on the given type that have a testable return type with vthe erbose configuration - - - - -Check one property with the verbose configuration, and using the given name. - - - - -Check one property with the verbose configuration. - - - - -Check all public static methods on the given type that have a testable return type with quick configuration - - - - -Check all public static methods on the given type that have a testable return type with quick configuration, -and throw on failure or exhaustion. - - - - -Check one property with the quick configuration, and throw an exception if it fails or is exhausted. - - - - -Check all public static methods on the given type that have a testable return type with quick configuration - - - - -Check all public static methods on the given type that have a testable return type with quick configuration - - - - -Check one property with the quick configuration, and using the given name. - - - - -Check one property with the quick configuration. - - - - -Check the given property using the given config, and the given test name. - - - - -Check the given property using the given config. - - - - -Check the given property identified by the given MethodInfo. - - - - -Check all public static methods on the given type that have a testable return type with the given configuration. -This includes let-bound functions in a module. - - - - -Check all public static methods on the given type that have a testable return type with the given configuration. -This includes let-bound functions in a module. - - - - -Executes the command on the model of the object. - - - - -Excecutes the command on the actual object under test. - - - - -The default precondition is true. - - - - -Precondition for execution of the command. When this does not hold, the test continues -but the command will not be executed. - - - - -The default postcondition is true. - - - - -Postcondition that must hold after execution of the command. Compares state of model and actual -object and fails the property if they do not match. - - - - -A single command describes pre and post conditions and the model for a single method under test. -The post-conditions are the invariants that will be checked; when these do not hold the test fails. - - - - -A custom test runner, e.g. to integrate with a test framework like xUnit or NUnit. - - - - -The Arbitrary instances on this class will be merged in back to front order, i.e. instances for the same generated type at the front -of the list will override those at the back. The instances on Arb.Default are always known, and are at the back (so they can always be -overridden) - - - - -What to print every time a counter-example is succesfully shrunk - - - - -What to print when new arguments args are generated in test n - - - - -If set, suppresses the output from the test if the test is successful. - - - - -The size to use for the last test, when all the tests are passing. The size increases linearly between Start- and EndSize. - - - - -The size to use for the first test. - - - - -Name of the test. - - - - -If set, the seed to use to start testing. Allows reproduction of previous runs. - - - - -The maximum number of tests where values are rejected, e.g. as the result of ==> - - - - -The maximum number of tests that are run. - - - - -Like the Verbose configuration, only throws an exception with the error message if the test fails or is exhausted. -Useful for use within other unit testing frameworks that usually adopt this methodolgy to signal failure. - - - - -The verbose configuration prints each generated argument. - - - - -Like the Quick configuration, only throws an exception with the error message if the test fails or is exhausted. -Useful for use within other unit testing frameworks that usually adopt this methodolgy to signal failure. - - - - -The quick configuration only prints a summary result at the end of the test. - - - - -The default configuration is the quick configuration. - - - - -For configuring a run. - - - - -The size to use for the first test. - - - - -A custom test runner, e.g. to integrate with a test framework like xUnit or NUnit. - - - - -If set, the seed to use to start testing. Allows reproduction of previous runs. - - - - -If set, suppresses the output from the test if the test is successful. - - - - -Name of the test. - - - - -The maximum number of tests that are run. - - - - -The maximum number of tests where values are rejected - - - - -What to print every time a counter-example is succesfully shrunk - - - - -What to print when new arguments args are generated in test n - - - - -The size to use for the last test, when all the tests are passing. The size increases linearly between Start- and EndSize. - - - - -The size to use for the first test. - - - - -A custom test runner, e.g. to integrate with a test framework like xUnit or NUnit. - - - - -If set, the seed to use to start testing. Allows reproduction of previous runs. - - - - -If set, suppresses the output from the test if the test is successful. - - - - -Name of the test. - - - - -The maximum number of tests that are run. - - - - -The maximum number of tests where values are rejected - - - - -What to print every time a counter-example is succesfully shrunk - - - - -What to print when new arguments args are generated in test n - - - - -The size to use for the last test, when all the tests are passing. The size increases linearly between Start- and EndSize. - - - - -Configure the test run. - - - - -Use the generator for 'a, but don't shrink. - - - - -Whereas most types are restricted by a size that grows -as the test gets further, by applying this type the underlying -type will ignore this size and always generate from the full range. -Note that this only makes a difference for types that have a range - -currently Int16, Int32, Int64 have DontSize Arbitrary instances. -This is typically (and at least currently) only applicable for value types -that are comparable, hence the type constraints. - - - - -Represents an array whose length does not change when shrinking. - - - - -A function (F# function) that can be displayed and shrunk. - - - - -Generates a value that satisfies a predicate. This function keeps re-trying -by increasing the size of the original generator ad infinitum. Make sure there is a high chance that -the predicate is satisfied. - - - - -Build a generator that generates a 2-tuple of the values generated by the given generator. - - - - - Construct an Arbitrary instance from a generator and a shrinker. - - - - - Construct an Arbitrary instance from a generator. - Shrink is not supported for this type. - - - - -Build a generator that generates a 3-tuple of the values generated by the given generator. - - - - -Map the given function to the value in the generator, yielding a new generator of the result type. - - - - -Generates n values of the given size. - - - - -Override the current size of the test. - - - - - Generates a non-empty list of random length. The maximum length - depends on the size parameter. - - - - - Generates a list of random length. The maximum length depends on the - size parameter. - - - - -Generates a list of given length, containing values generated by the given generator. - - - - -Build a generator that generates a 4-tuple of the values generated by the given generator. - - - - -Generates a value with maximum size n. - - - - - Generates an array using the specified generator. - The maximum length is size+1. - - - - - Generates an array of a specified length. - - - - - Generates a 2D array. The square root of the size is the maximum number of rows and columns. - - - - - Generates a 2D array of the given dimensions. - - - - -Apply the given Gen function to this generator, aka the applicative <*> operator. - - - - -Extension methods to build generators - contains among other the Linq methods. - - - - - Lifted function application = apply f to a, all in the Gen applicative functor. - - - - - Like <*>, but puts f in a Gen first. - - - - - Bind operator; runs the first generator, then feeds the result - to the second generator function. - - - - -map the given function to the value in the generator, yielding a new generator of the result type. - - - - -Generator of a random value, based on a size parameter and a randomly generated int. - - - - -Initial state of model object. Should correspond to initial state of actual object. - - - - -Initial state of actual object. Should correspond to initial state of model object. - - - - -Generate a number of possible commands based on the current state of the model. -Preconditions are still checked, so even if a Command is returned, it is not chosen -if its precondition does not hold. - - - - -Defines the initial state for actual and model object, and allows to define the generator to use -for the next state, based on the model. - - - - -Called before a group of properties on a type are checked. - - - - -Called on a succesful shrink. - - - - -Called whenever all tests are done, either True, False or Exhausted. - - - - -Called whenever arguments are generated and after the test is run. - - - - -For implementing your own test runner. - - - - -Represents an int that can include int.MinValue and int.MaxValue. - - - - -Represents an integer interval. - - - - -Represents a non-empty array. - - - - -Represents a non-empty Set. - - - - -Represents a string that is not null or empty, and does not contain any null characters ('\000') - - - - -Represents an int >= 0 - - - - -Wrap a type in NonNull to prevent null being generated for the wrapped type. - - - - -Represents an int <> 0 - - - - -Represents a float that is not NaN or Infinity. - - - - - determines for which Outcome the result should be shrunk, or shrinking should continue. - - - - -Represents an int > 0 - - - - -A Property can be checked by FsCheck. - - - - -Conditional property combinator. Resulting property holds if the property holds when the condition does. - - - - -Conditional property combinator. Resulting property holds if the property holds when the condition does. - - - - -Conditional property combinator. Resulting property holds if the property holds when the condition does. - - - - -Count trivial cases. Test cases for which the condition is True are classified as trivial. - - - - -Count trivial cases. Test cases for which the condition is True are classified as trivial. - - - - -Count trivial cases. Test cases for which the condition is True are classified as trivial. - - - - -Count trivial cases. Test cases for which the condition is True are classified as trivial. - - - - - Turns a testable type into a property. - - - - - Turns a testable type into a property. - - - - - Turns a testable type into a property. - - - - -Construct a property that fails if both fail. (cfr 'or') - - - - -Construct a property that fails if both fail. (cfr 'or') - - - - -Construct a property that fails if both fail. (cfr 'or') - - - - -Construct a property that fails if both fail. (cfr 'or') - - - - -Add the given label to the property. The labels of a failing sub-property are displayed when it fails. - - - - -Add the given label to the property. The labels of a failing sub-property are displayed when it fails. - - - - -Add the given label to the property. The labels of a failing sub-property are displayed when it fails. - - - - -Add the given label to the property. The labels of a failing sub-property are displayed when it fails. - - - - -Collect data values. The argument of collect is evaluated in each test case, -and the distribution of values is reported. - - - - -Collect data values. The argument of collect is evaluated in each test case, -and the distribution of values is reported. - - - - -Collect data values. The argument of collect is evaluated in each test case, -and the distribution of values is reported. - - - - -Collect data values. The argument of collect is evaluated in each test case, -and the distribution of values is reported. - - - - -Classify test cases. Test cases satisfying the condition are assigned the classification given. - - - - -Classify test cases. Test cases satisfying the condition are assigned the classification given. - - - - -Classify test cases. Test cases satisfying the condition are assigned the classification given. - - - - -Construct a property that succeeds if both succeed. (cfr 'and') - - - - -Construct a property that succeeds if both succeed. (cfr 'and') - - - - -Construct a property that succeeds if both succeed. (cfr 'and') - - - - -Construct a property that succeeds if both succeed. (cfr 'and') - - - - -Extensons to construct Properties. - - - - -Returns a new result that is Succeeded if and only if both this -and the given Result are Succeeded. - - - - -The result of one execution of a property. - - - - -Represents a string that does not contain null characters ('\000') - - - - -2-tuple containing a weight and a value, used in some Gen methods to indicate -the probability of a value. - - - - -Generates (), of the unit type. - - - - -Generate arbitrary uint64 that is between 0 and size. - - - - -Generate arbitrary uint32 that is between 0 and size. - - - - -Generate arbitrary uint16 that is between 0 and size. - - - - -Generates an arbitrary TimeSpan. A TimeSpan is shrunk by removing days, hours, minutes, second and milliseconds. - - - - -Generates a Func'4. - - - - -Generates a Func'3. - - - - -Generates a Func'2. - - - - -Generates a Func'1. - - - - -Generates an Action'3 - - - - -Generates an Action'2 - - - - -Generates an Action'1 - - - - -Generates an Action'0 - - - - -Generates arbitrary strings, which are lists of chars generated by Char. - - - - -Generates an arbitrary signed byte. - - - - -Generate an option value that is 'None' 1/8 of the time. - - - - -Generate an object - a boxed char, string or boolean value. - - - - -Generate a nullable value that is null 1/8 of the time. - - - - - Generates an Float (without NaN, Infinity) - - - - -Generate underlying values that are not null. - - - - - Generate a System.Collections.Generic.List of values. - - - - -Generates an interval between two non-negative integers. - - - - -Generate arbitrary int64 that is between -size and size. -Note that since the size is an int32, this does not actually cover the full -range of int64. See DontSize<int64> instead. - - - - -Generate arbitrary int32 that is between -size and size. - - - - -Generate arbitrary int16 that is between -size and size. - - - - - Generate a System.Collections.Generic.IList of values. - - - - - Generate a System.Collections.Generic.IDictionary of values. - Shrinks by reducing the number of elements - - - - - Generate a System.Collections.Generic.ICollection of values. - - - - -Generate a Function value that can be printed and shrunk. Function values can be generated for types 'a->'b -where 'b has an Arbitrary instance. - - - - -Generate a list of values. The size of the list is between 0 and the test size + 1. - - - - -Generates arbitrary floats, NaN, NegativeInfinity, PositiveInfinity, Maxvalue, MinValue, Epsilon included fairly frequently. - - - - -Generates arbitrary floats, NaN, NegativeInfinity, PositiveInfinity, Maxvalue, MinValue, Epsilon included fairly frequently. - - - - -Arrays whose length does not change when shrinking. - - - - -Generate arbitrary uint32 that is uniformly distributed in the whole range of uint32 values. - - - - -Generate arbitrary uint32 that is uniformly distributed in the whole range of uint32 values. - - - - -Generate arbitrary uint16 that is uniformly distributed in the whole range of uint16 values. - - - - -Generate arbitrary int64 between Int64.MinValue and Int64.MaxValue - - - - -Generate arbitrary int32 that is between Int32.MinValue and Int32.MaxValue - - - - -Generate arbitrary int16 that is uniformly distributed in the whole range of int16 values. - - - - -Overrides the shrinker of any type to be empty, i.e. not to shrink at all. - - - - - Generate a System.Collections.Generic.Dictionary of values. - Shrinks by reducing the number of elements - - - - -Try to derive an arbitrary instance for the given type reflectively. -Generates and shrinks values for record, union, tuple and enum types. -Also generates (but doesn't shrink) values for immutable classes -(i.e. single constructor, no mutable properties or fields). - - - - -Generate arbitrary decimal. - - - - -Generates an arbitrary DateTimeOffset between 1900 and 2100. - A DateTimeOffset is shrunk first by shrinking its offset, then by removing its second, minute and hour components. - - - - -Generates an arbitrary DateTime between 1900 and 2100. -A DateTime is shrunk by removing its second, minute and hour components. - - - - -Generates arbitrary chars, between ASCII codes Char.MinValue and 127. - - - - -Generates an arbitrary byte. - - - - -Generates an arbitrary bool. - - - - -Arbitray instance for BigInteger. - - - - -Generate a function value. Function values can be generated for types 'a->'b where 'b has an Arbitrary instance. -THere is no shrinking function values. - - - - -Generate a rank 2, zero based array. - - - - -Generate a rank 1 array. - - - - - Return an Arbitrary instance that is a mapped and filtered version of an existing arbitrary instance. - The generator uses Gen.map with the given mapper and then Gen.suchThat with the given predicate, - and the shrinks are filtered using Seq.filter with the given predicate. -This is sometimes useful if using just a filter would reduce the chance of getting a good value -from the generator - and you can map the value instead. E.g. PositiveInt. - - - - - Return an Arbitrary instance that is a filtered version of an existing arbitrary instance. - The generator uses Gen.suchThat, and the shrinks are filtered using Seq.filter with the given predicate. - - - - -Construct an Arbitrary instance for a type that can be mapped to and from another type (e.g. a wrapper), -based on a Arbitrary instance for the source type and two mapping functions. - - - - - Construct an Arbitrary instance from a generator and shrinker. - - - - - Construct an Arbitrary instance from a generator. - Shrink is not supported for this type. - - - - -A generic shrinker that should work for most number-like types. - - - - -Returns the immediate shrinks for the given value based on its type. - - - - -Returns a Gen<'Value> - - - - -Get the Arbitrary instance for the given type. - - - - -Register the generators that are static members of the type argument. - - - - -Register the generators that are static members of the given type. - - - - -Turn a specification into a property. - - - - -Memoize the given function. - - - - -Memoize the given function using the given dictionary - - - - -Generate a number of possible commands based on the current state of the model. -Preconditions are still checked, so even if a Command is returned, it is not chosen -if its precondition does not hold. - - - - -Defines the initial state for actual and model object, and allows to define the generator to use -for the next state, based on the model. - - - - -Executes the command on the model of the object. - - - - -The default precondition is true. - - - - -Optional precondition for execution of the command. When this does not hold, the test continues -but the command is not executed. - - - - -Excecutes the command on the object under test, and returns a property that must hold. -This property typically compares the state of the model with the state of the object after -execution of the command. - - - - -An operation describes pre and post conditions and the model for a single operation under test. -The post-conditions are the invariants that will be checked; when these do not hold the test fails. - - - - -Initial state of model object. Must correspond to initial state of actual object. - - - - -Randomly generate the initial state of the actual object. Should still correspond to the -initial state of model object; so you should only randomly generate parameters to the instance -that don't affect the model. -Note:make sure that each value is truly a new instance if the commands change the state -of the object. Gen.connstant in particular is a bad idea - use Gen.fresh instead. - - - - -Turn a specification into a property. - - - - -Basic co-arbitrary generator transformer, which is dependent on an int. -Only used for generating arbitrary functions. - - - - -Promote the given function f to a function generator. Only used for generating arbitrary functions. - - - - -Apply the given Gen function to the given generator, aka the applicative <*> operator. - - - - -Generate a fresh instance every time the generatoris called. Useful for mutable objects. -See also constant. - - - - -Generate a fresh instance every time the generatoris called. Useful for mutable objects. -See also constant. - - - - -Always generate the same instance v. See also fresh. - - - - - Generates a 2D array. The square root of the size is the maximum number of rows and columns. - - - - - Generates a 2D array of the given dimensions. - - - - - Generates an array using the specified generator. The maximum length is the size+1. - - - - - Generates an array of a specified length. - - - - - Generates sublists of the given arguments. - - - - - Generates sublists of the given IEnumerable. - - - - - Generates sublists of the given sequence. - - - - - Generates a non-empty list of random length. The maximum length - depends on the size parameter. - - - - - Generates a list of random length. The maximum length depends on the - size parameter. - - - - -Generates a value that satisfies a predicate. Contrary to suchThatOption, this function keeps re-trying -by increasing the size of the original generator ad infinitum. Make sure there is a high chance that -the predicate is satisfied. - - - - -Tries to generate a value that satisfies a predicate. This function 'gives up' by generating None -if the given original generator did not generate any values that satisfied the predicate, after trying to -get values from by increasing its size. - - - - -Generates a list of given length, containing values generated by the given generator. - - - - -Sequence the given list of generators into a generator of a list. - - - - -Sequence the given list of generators into a generator of a list. - - - - -Sequence the given seq of generators into a generator of a list. - - - - -Map the given function over values to a function over generators of those values. - - - - -Map the given function over values to a function over generators of those values. - - - - -Build a generator that generates a 4-tuple of the values generated by the given generator. - - - - -Map the given function over values to a function over generators of those values. - - - - -Build a generator that generates a 3-tuple of the values generated by the given generator. - - - - -Map the given function over values to a function over generators of those values. - - - - -Build a generator that generates a 2-tuple of the values generated by the given generator. - - - - -Map the given function over values to a function over generators of those values. - - - - -Build a generator that generates a value from one of the generators in the given non-empty seq, with -given probabilities. The sum of the probabilities must be larger than zero. - - - - -Build a generator that generates a value from one of the generators in the given non-empty seq, with -given probabilities. The sum of the probabilities must be larger than zero. - - - - -Build a generator that generates a value from one of the generators in the given non-empty seq, with -given probabilities. The sum of the probabilities must be larger than zero. - - - - -Build a generator that generates a value from one of the generators in the given non-empty seq, with -given probabilities. The sum of the probabilities must be larger than zero. - - - - -Build a generator that generates a value from one of the given generators, with -equal probability. - - - - -Build a generator that generates a value from one of the generators in the given non-empty seq, with -equal probability. - - - - -Build a generator that randomly generates one of the values in the given non-empty seq. - - - - -Build a generator that randomly generates one of the values in the given non-empty seq. - - - - -Generates an integer between l and h, inclusive. - - - - -Generates n values of the given size. - - - - -Generates a value with maximum size n. - - - - -Override the current size of the test. resize n g invokes generator g with size parameter n. - - - - -Obtain the current size. sized g calls g, passing it the current size as a parameter. - - - - -Obtain the current size. sized g calls g, passing it the current size as a parameter. - - - - -Apply the function f to the value in the generator, yielding a new generator. - - - - -Combinators to build custom random generators for any type. - - - - -The workflow type for generators. - - - - -The workflow function for generators, e.g. gen { ... } - - - - -Computation expression builder for Gen. - - - - - Turns a testable type into a property. Testables are unit, boolean, Lazy testables, Gen testables, functions - from a type for which a generator is know to a testable, tuples up to 6 tuple containing testables, and lists - containing testables. - - - - -Fails the property if it does not complete within t milliseconds. Note that the called property gets a -cancel signal, but whether it responds to that is up to the property; the execution may not actually stop. - - - - -Add the given label to the property. The labels of a failing sub-property are displayed when it fails. - - - - -Collect data values. The argument of collect is evaluated in each test case, -and the distribution of values is reported, using sprintf "%A". - - - - -Count trivial cases. Test cases for which the condition is True are classified as trivial. - - - - -Classify test cases. Test cases satisfying the condition are assigned the classification given. - - - - -Expect exception 't when executing p. So, results in success if an exception of the given type is thrown, -and a failure otherwise. - - - - -Depending on the condition, return the first testable if true and the second if false. - - - - -Quantified property combinator. Provide a custom test data generator to a property. - - - - -Combinators to build properties, which define the property to be tested, with some -convenience methods to investigate the generated arguments and any found counter-examples. - - - - -Construct a property that fails if both fail. (cfr 'or') - - - - -Construct a property that succeeds if both succeed. (cfr 'and') - - - - -Add the given label to the property. Property on the left hand side, label on the right. - - - - -Add the given label to the property. label on the left hand side, property on the right. - - - - -Add the given label to the property. Property on the left hand side, label on the right. - - - - -Conditional property combinator. Resulting property holds if the property after ==> holds whenever the condition does. - - - - -Operators for Prop. - - - - -Generate random numbers based on splitting seeds. Based Hugs' Random implementation. - - - - - Get reader for union case name (aka tag) - - - - - Returns the case name, type, and functions that will construct a constructor and a reader of a union type respectively - - - - - Get reader for record type - - - - - Get constructor for record type - - - - - Get information on the fields of a record type - - - - -Build a reflection-based generator for the given Type. Since we memoize based on type, can't use a -typed variant reflectGen<'a> much here, as we need to be able to partially apply on the getGenerator. -See also Default.Derive. - - - - - Generate a random enum of the type specified by the System.Type - - - - -Force this value to do the necessary initializations of typeclasses. Normally this initialization happens automatically. -In any case, it can be forced any number of times without problem. - - - - -A runner that prints results to the standard output. - - - - -A function that returns the default string that is printed as a result of the test. - - - - -Merge the instances defined by the given instances type with the ones already defined in this TypeClass. -Instances defined in the given type override the instances in this TypeClass instance. - - - - -Get the instance registered on this TypeClass for the given type parameter 'T. The result will be cast -to TypeClassT, which should be 'TypeClass<'T> but that's impossible to express in .NET's type system. - - - - -Get the instance registered on this TypeClass for the given type and optionally the given arguments. -The result is of type 'TypeClass<'T>, dynamically. - - - - -Discover instances for this TypeClass on the given type. Merge the result with this TypeClass, -with the newly discovered instances overriding the instances on this TypeClass. - - - - -Make a new TypeClass with only the instances registered on the given type. -Note that the instances of this TypeClass will not be registered on the new TypeClass. -Use Merge in addition to achieve that, or use DiscoverAndMerge to do both. - - - - -Compares this TypeClass with the given TypeClass. Returns, respectively, the new instances, overridden instances, -new array instances, overridden array instances, new catch all or overridden catchall introduced by the other TypeClass. - - - - -Haskell typeclass concept simulation. For internal use. - - - - diff --git a/packages/FsCheck.2.2.4/lib/portable-net45+netcore45/FsCheck.dll b/packages/FsCheck.2.2.4/lib/portable-net45+netcore45/FsCheck.dll deleted file mode 100644 index c24a21c..0000000 Binary files a/packages/FsCheck.2.2.4/lib/portable-net45+netcore45/FsCheck.dll and /dev/null differ diff --git a/packages/FsCheck.Xunit.2.2.4/FsCheck.Xunit.2.2.4.nupkg b/packages/FsCheck.Xunit.2.2.4/FsCheck.Xunit.2.2.4.nupkg deleted file mode 100644 index efa2204..0000000 Binary files a/packages/FsCheck.Xunit.2.2.4/FsCheck.Xunit.2.2.4.nupkg and /dev/null differ diff --git a/packages/FsCheck.Xunit.2.2.4/lib/net45/FsCheck.Xunit.XML b/packages/FsCheck.Xunit.2.2.4/lib/net45/FsCheck.Xunit.XML deleted file mode 100644 index 2087987..0000000 --- a/packages/FsCheck.Xunit.2.2.4/lib/net45/FsCheck.Xunit.XML +++ /dev/null @@ -1,124 +0,0 @@ - - -FsCheck.Xunit - - - - xUnit2 test case discoverer to link the method with the PropertyAttribute to the PropertyTestCase - so the test can be run via FsCheck. - - - - - The xUnit2 test runner for the PropertyAttribute that executes the test via FsCheck - - - - -Output all generated arguments. - - - - -The size to use for the first test. - - - - -If set, the seed to use to start testing. Allows reproduction of previous runs. You can just paste -the tuple from the output window, e.g. 12344,12312 or (123,123). - - - - -If set, suppresses the output from the test if the test is successful. This can be useful when running tests -with TestDriven.net, because TestDriven.net pops up the Output window in Visual Studio if a test fails; thus, -when conditioned to that behaviour, it's always a bit jarring to receive output from passing tests. -The default is false, which means that FsCheck will also output test results on success, but if set to true, -FsCheck will suppress output in the case of a passing test. This setting doesn't affect the behaviour in case of -test failures. - - - - -The maximum number of tests that are run. - - - - -The maximum number of tests where values are rejected, e.g. as the result of ==> - - - - -The size to use for the last test, when all the tests are passing. The size increases linearly between Start- and EndSize. - - - - -The Arbitrary instances to use for this test method. The Arbitrary instances -are merged in back to front order i.e. instances for the same generated type -at the front of the array will override those at the back. - - - - -Output all generated arguments. - - - - -The size to use for the first test. - - - - -If set, the seed to use to start testing. Allows reproduction of previous runs. You can just paste -the tuple from the output window, e.g. 12344,12312 or (123,123). - - - - -If set, suppresses the output from the test if the test is successful. This can be useful when running tests -with TestDriven.net, because TestDriven.net pops up the Output window in Visual Studio if a test fails; thus, -when conditioned to that behaviour, it's always a bit jarring to receive output from passing tests. -The default is false, which means that FsCheck will also output test results on success, but if set to true, -FsCheck will suppress output in the case of a passing test. This setting doesn't affect the behaviour in case of -test failures. - - - - -The maximum number of tests that are run. - - - - -The maximum number of tests where values are rejected, e.g. as the result of ==> - - - - -The size to use for the last test, when all the tests are passing. The size increases linearly between Start- and EndSize. - - - - -The Arbitrary instances to use for this test method. The Arbitrary instances -are merged in back to front order i.e. instances for the same generated type -at the front of the array will override those at the back. - - - - -Run this method as an FsCheck test. - - - - -Override Arbitrary instances for FsCheck tests within the attributed class -or module. - - - - diff --git a/packages/FsCheck.Xunit.2.2.4/lib/net45/FsCheck.Xunit.dll b/packages/FsCheck.Xunit.2.2.4/lib/net45/FsCheck.Xunit.dll deleted file mode 100644 index f0be729..0000000 Binary files a/packages/FsCheck.Xunit.2.2.4/lib/net45/FsCheck.Xunit.dll and /dev/null differ diff --git a/packages/NuGet.CommandLine.3.3.0/NuGet.CommandLine.3.3.0.nupkg b/packages/NuGet.CommandLine.3.3.0/NuGet.CommandLine.3.3.0.nupkg deleted file mode 100644 index ed35755..0000000 Binary files a/packages/NuGet.CommandLine.3.3.0/NuGet.CommandLine.3.3.0.nupkg and /dev/null differ diff --git a/packages/NuGet.CommandLine.3.3.0/tools/NuGet.exe b/packages/NuGet.CommandLine.3.3.0/tools/NuGet.exe deleted file mode 100644 index 9f8781d..0000000 Binary files a/packages/NuGet.CommandLine.3.3.0/tools/NuGet.exe and /dev/null differ diff --git a/packages/Unquote.3.1.0/Unquote.3.1.0.nupkg b/packages/Unquote.3.1.0/Unquote.3.1.0.nupkg deleted file mode 100644 index 53801f7..0000000 Binary files a/packages/Unquote.3.1.0/Unquote.3.1.0.nupkg and /dev/null differ diff --git a/packages/Unquote.3.1.0/lib/net40/Unquote.dll b/packages/Unquote.3.1.0/lib/net40/Unquote.dll deleted file mode 100644 index ed53ff3..0000000 Binary files a/packages/Unquote.3.1.0/lib/net40/Unquote.dll and /dev/null differ diff --git a/packages/Unquote.3.1.0/lib/net40/Unquote.xml b/packages/Unquote.3.1.0/lib/net40/Unquote.xml deleted file mode 100644 index a7c6218..0000000 --- a/packages/Unquote.3.1.0/lib/net40/Unquote.xml +++ /dev/null @@ -1,1107 +0,0 @@ - - -Unquote - - - - - - - - - - - - - - - -Exception used to signal assertion failure to be caught by any exception framework -(used when not NUnit or xUnit.net or when compiled for framework versions lacking serialization features) - - - - - - - - - - - - - - - - -Exception used to distinguish an error in the quotation evaluation engine. - - - - - - - - - - -Exception used to indicate an exception captured during reduction (typically not raised itself). - - - - - - - - - - - - - - - - - - - -The exception, if any, that was raised during reduction. Note that this is the actual exception raised, not the wrapper ReductionException. - - - - - - - - - - - - - - - - -An "unquoted" view of a quotation. i.e. provides info about the reduction steps -of a quotation. - - - - - - - - - - - - - - - - - - - - - - -Test wether the given expr fails with the given expected exception (or a subclass thereof) when the additional assertion on the exception object holds. - - - - -Test wether the given expr fails with the given expected exception (or a subclass thereof). - - - - -Evaluate the given boolean expression: if false output incremental eval steps using -1) stdout if fsi mode -2) Framework fail methods if xUnit.net (v1 or v2), NUnit, or Fuchu present -3) System.Exception if release mode. - - - - - - - - - - - - - - - - - - - - - - -These '?' suffixed operators conflict with F# 3.0's nullable operators and have been replaced by equivalent '!' suffixed operators. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -raise is not inlined in Core.Operators, so shows up in stack traces. We inline it here for clean stacktraces. - - - - -Functions and values public inline Operator functions rely on (and therefore must be public, -even though we do not want to expose them publically). - - - - -Operators on Expr and Expr<'a> for performing unit test assertions. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -aty is the arg type, bty is the return type, x is the arg - - - - - - - - - - - - - - - - - - - - - - -name is the name of the unary op method, aty is the arg type, x is the arg - - - - - - - - - - - - - -Binary ops of the form 'a->int->'a - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -name is the name of the method, aty is the type of the first arg, bty is the type of the second arg, -x is the first arg, y is the second arg. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -The purpose of these operator implementations is two fold 1) many F# operators do not include dynamic impls, -so we must give them. 2) even those operators which are given dynamic impls do not perform well since they -need to be accessed via reflection, so we give "native" impls here. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -"reraise" the given exception, preserving the stacktrace (e.g. for InnerExceptions of TargetInvocation exceptions) - - - - -Strip possibly nested target invocation exception - - - - - - - -The F#-style signature. Note: this property is out-of-place in this assembly and may be moved elsewhere in future versions. - - - - -Determine whether this expression is reduced. - - - - -Convert the given expression to a list of all of its Reduce steps in order. - - - - -Convert this expression with the given variable environment to a list of all of its Reduce steps in order. - - - - -Reduce this expression by one step: convert each branch of the given expression to a Value expression of its -evaluation if each sub-branch of the branch is reduced. -If this expression is already reduced, or cannot be reduced, returns itself. - - - - -Reduce this expression by one step with the given variable environment: convert each branch of the given expression to a Value expression of its -evaluation if each sub-branch of the branch is reduced. -If this expression is already reduced, or cannot be reduced, returns itself. - - - - -Decompile this expression to its source code representation. Sub-expressions which are -not currently supported will fallback on the default Expr.ToString() implementation. - - - - -Evaluate this untyped expression. - - - - -Evaluate this untyped expression with the given variable environment. - - - - -Evaluate this typed expression with the given variable environment. - - - - -Evaluate this typed expression. - - - - -Extensions methods on Expr and Expr<'a> for decompiling, evaluating, and incrementally reducing quotation expressions. Also includes a bonus -extension method on Type for getting the short, F#-style name of a type. - - - - -Match Call(None, ...) patterns for NumericLiterals, returning the literal value as a string and suffix on success - - - - -Match a sequence, list, or array op_RangeStep expression, return (startToken, endToken, startExpression, stepExpression, endExpression). Must come before Call patterns. - - - - -Match a sequence, list, or array op_Range expression, return (startToken, endToken, startExpression, endExpression). Must come before Call patterns. - - - - - - - -Partial application and zero application of Lambda call (e.g. List.map (+), or id). -Must come before Let and Lambdas patterns. -Cases: 1) Let .. Lambdas .. Call - 2) Lambdas .. Call - - - - -Test whether the given expression represents a tuple let binding: e.g. let x,y = 1,2. -Must come before Let pattern and after IncompleteLambdaCall pattern. - - - - -Test whether the Expr is a Var and equals the given Var property-wise - - - - - - - -Match non-custom binary infix Call patterns. -Must come before Call pattern. - - - - -Matches lambda values, returning the demangled (but not source) name of the lambda - - - - - - - -Extra Quoation patterns for sprinting and reducing Quotation Expressions - - - - - - - - - - - - - - - - - - - -sprints the generic arguments of a call if definitely not inferable. - - - - - - - -Determine whether the generic args for a call are inferable - - - - -Sprint the F#-style type signature of the given Type. Handles known type abbreviations, -simple types, arbitrarily complex generic types (multiple parameters and nesting), -lambdas, tuples, and arrays. - - - - - - - -get the source name for the Module or F# Function represented by the given MemberInfo - - - - - - - - - - -is the top-level FSI module - - - - - - - - - - - - - - - - - - - -try to find the first class symbolic function representation of a "op_" function name - - - - - - - - - - - - - - - - - - - -Extra reflection functions sprinting and reducing Quotation Expressions - - - - - - - - - - - - - -Precedence - - - - -Associativity - - - - - - - -Represents an operator's precedence. The lower the precedence value, the lower the binding. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Build an UnquotedExpression from the given quotation. - - - - -Determine whether the given expression is reduced. - - - - -Convert the given expression with the given variable environment to a list of all of its Reduce steps in order. - - - - -Reduce the given expression by one step with the given variable environment: convert each branch of the given expression to a Value expression of its -evaluation if each sub-branch of the branch is reduced. -If this expression is already reduced, or cannot be reduced, returns itself. - - - - -Evaluate the given typed expression with the given variable environment. - - - - -Evaluate the given untyped expression with the given variable environment. - - - - -Convert the given expression to a list of all of its Reduce steps in order. - - - - -Reduce by one step: convert each branch of the given expression to a Value expression of its -evaluation if each sub-branch of the branch is reduced. -If this expression is already reduced, or cannot be reduced, returns itself. - - - - -Decompile given expression to its source code representation. Sub-expressions which are -not currently supported will fallback on the default Expr.ToString() implementation. - - - - -Evaluate the given typed expression. - - - - -Evaluate the given untyped expression. - - - - -Operators on Expr and Expr<'a> for decompiling, evaluating, and incrementally reducing quotation expressions. - - - - - - - - - - - - - - - - - - - -Construct a Value from an evaluated expression - - - - - - - - - - - - - -Test whether the two lists are pairwise equal using the given boolean comparison function - - - - - - - - - - - - - - - - - - - - - - - - - -Normalize newlines to stdout.NewLine: if stdout.NewLine = "\n", then do nothing. -Otherwise replace all occurences of "\n", but not "\r\n", with "\r\n" and then replace -all occurences of "\r\n" with stdout.NewLine. - - - - -Normalize newlines to Environment.NewLine: if Environment.NewLine = "\n", then do nothing. -If Environment.NewLine = "\r\n", then replace all occurences of "\n", but not "\r\n", with "\r\n". -This allows "\n" to be used as an environment safe newline character, which may be mixed -with uses of Environment.NewLine. - - - - -Matches "\n", but not "\r\n" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Test an input string against a regex pattern using the given RegexOptions flags. -If the match succeeds, returns an ActiveMatch instance, which can be used for further pattern matching. -Note that the implementation takes advantage of the .NET Regex cache. - - -The first argument allows you pass in RegexOptions flags. - - -The second argument is the regex pattern. Cannot be null. - - -The last argument is the input string to test. The input -may be null which would result in a no-match. - - - - - - - -Convenience versions of our regex active patterns using RegexOptions.None flag - - - - - - - -When silverlight mode is None, else is Compiled - - - - -Convenience versions of our regex active patterns using RegexOptions.Compiled flag. -If PORTABLE compiler directive defined, then RegexOptions.None flag used. - - - - -Regex extensions - - - - - - - - - - - - - diff --git a/packages/Unquote.3.1.0/lib/net45/Unquote.dll b/packages/Unquote.3.1.0/lib/net45/Unquote.dll deleted file mode 100644 index a7baa93..0000000 Binary files a/packages/Unquote.3.1.0/lib/net45/Unquote.dll and /dev/null differ diff --git a/packages/Unquote.3.1.0/lib/net45/Unquote.xml b/packages/Unquote.3.1.0/lib/net45/Unquote.xml deleted file mode 100644 index 35ee4b6..0000000 --- a/packages/Unquote.3.1.0/lib/net45/Unquote.xml +++ /dev/null @@ -1,1107 +0,0 @@ - - -Unquote - - - - - - - - - - - - - - - -Exception used to signal assertion failure to be caught by any exception framework -(used when not NUnit or xUnit.net or when compiled for framework versions lacking serialization features) - - - - - - - - - - - - - - - - -Exception used to distinguish an error in the quotation evaluation engine. - - - - - - - - - - -Exception used to indicate an exception captured during reduction (typically not raised itself). - - - - - - - - - - - - - - - - - - - -The exception, if any, that was raised during reduction. Note that this is the actual exception raised, not the wrapper ReductionException. - - - - - - - - - - - - - - - - -An "unquoted" view of a quotation. i.e. provides info about the reduction steps -of a quotation. - - - - - - - - - - - - - - - - - - - - - - -Test wether the given expr fails with the given expected exception (or a subclass thereof) when the additional assertion on the exception object holds. - - - - -Test wether the given expr fails with the given expected exception (or a subclass thereof). - - - - -Evaluate the given boolean expression: if false output incremental eval steps using -1) stdout if fsi mode -2) Framework fail methods if xUnit.net (v1 or v2), NUnit, or Fuchu present -3) System.Exception if release mode. - - - - - - - - - - - - - - - - - - - - - - -These '?' suffixed operators conflict with F# 3.0's nullable operators and have been replaced by equivalent '!' suffixed operators. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -raise is not inlined in Core.Operators, so shows up in stack traces. We inline it here for clean stacktraces. - - - - -Functions and values public inline Operator functions rely on (and therefore must be public, -even though we do not want to expose them publically). - - - - -Operators on Expr and Expr<'a> for performing unit test assertions. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -aty is the arg type, bty is the return type, x is the arg - - - - - - - - - - - - - - - - - - - - - - -name is the name of the unary op method, aty is the arg type, x is the arg - - - - - - - - - - - - - -Binary ops of the form 'a->int->'a - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -name is the name of the method, aty is the type of the first arg, bty is the type of the second arg, -x is the first arg, y is the second arg. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -The purpose of these operator implementations is two fold 1) many F# operators do not include dynamic impls, -so we must give them. 2) even those operators which are given dynamic impls do not perform well since they -need to be accessed via reflection, so we give "native" impls here. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -"reraise" the given exception, preserving the stacktrace (e.g. for InnerExceptions of TargetInvocation exceptions) - - - - -Strip possibly nested target invocation exception - - - - - - - -The F#-style signature. Note: this property is out-of-place in this assembly and may be moved elsewhere in future versions. - - - - -Determine whether this expression is reduced. - - - - -Convert the given expression to a list of all of its Reduce steps in order. - - - - -Convert this expression with the given variable environment to a list of all of its Reduce steps in order. - - - - -Reduce this expression by one step: convert each branch of the given expression to a Value expression of its -evaluation if each sub-branch of the branch is reduced. -If this expression is already reduced, or cannot be reduced, returns itself. - - - - -Reduce this expression by one step with the given variable environment: convert each branch of the given expression to a Value expression of its -evaluation if each sub-branch of the branch is reduced. -If this expression is already reduced, or cannot be reduced, returns itself. - - - - -Decompile this expression to its source code representation. Sub-expressions which are -not currently supported will fallback on the default Expr.ToString() implementation. - - - - -Evaluate this untyped expression. - - - - -Evaluate this untyped expression with the given variable environment. - - - - -Evaluate this typed expression with the given variable environment. - - - - -Evaluate this typed expression. - - - - -Extensions methods on Expr and Expr<'a> for decompiling, evaluating, and incrementally reducing quotation expressions. Also includes a bonus -extension method on Type for getting the short, F#-style name of a type. - - - - -Match Call(None, ...) patterns for NumericLiterals, returning the literal value as a string and suffix on success - - - - -Match a sequence, list, or array op_RangeStep expression, return (startToken, endToken, startExpression, stepExpression, endExpression). Must come before Call patterns. - - - - -Match a sequence, list, or array op_Range expression, return (startToken, endToken, startExpression, endExpression). Must come before Call patterns. - - - - - - - -Partial application and zero application of Lambda call (e.g. List.map (+), or id). -Must come before Let and Lambdas patterns. -Cases: 1) Let .. Lambdas .. Call - 2) Lambdas .. Call - - - - -Test whether the given expression represents a tuple let binding: e.g. let x,y = 1,2. -Must come before Let pattern and after IncompleteLambdaCall pattern. - - - - -Test whether the Expr is a Var and equals the given Var property-wise - - - - - - - -Match non-custom binary infix Call patterns. -Must come before Call pattern. - - - - -Matches lambda values, returning the demangled (but not source) name of the lambda - - - - - - - -Extra Quoation patterns for sprinting and reducing Quotation Expressions - - - - - - - - - - - - - - - - - - - -sprints the generic arguments of a call if definitely not inferable. - - - - - - - -Determine whether the generic args for a call are inferable - - - - -Sprint the F#-style type signature of the given Type. Handles known type abbreviations, -simple types, arbitrarily complex generic types (multiple parameters and nesting), -lambdas, tuples, and arrays. - - - - - - - -get the source name for the Module or F# Function represented by the given MemberInfo - - - - - - - - - - -is the top-level FSI module - - - - - - - - - - - - - - - - - - - -try to find the first class symbolic function representation of a "op_" function name - - - - - - - - - - - - - - - - - - - -Extra reflection functions sprinting and reducing Quotation Expressions - - - - - - - - - - - - - -Precedence - - - - -Associativity - - - - - - - -Represents an operator's precedence. The lower the precedence value, the lower the binding. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Build an UnquotedExpression from the given quotation. - - - - -Determine whether the given expression is reduced. - - - - -Convert the given expression with the given variable environment to a list of all of its Reduce steps in order. - - - - -Reduce the given expression by one step with the given variable environment: convert each branch of the given expression to a Value expression of its -evaluation if each sub-branch of the branch is reduced. -If this expression is already reduced, or cannot be reduced, returns itself. - - - - -Evaluate the given typed expression with the given variable environment. - - - - -Evaluate the given untyped expression with the given variable environment. - - - - -Convert the given expression to a list of all of its Reduce steps in order. - - - - -Reduce by one step: convert each branch of the given expression to a Value expression of its -evaluation if each sub-branch of the branch is reduced. -If this expression is already reduced, or cannot be reduced, returns itself. - - - - -Decompile given expression to its source code representation. Sub-expressions which are -not currently supported will fallback on the default Expr.ToString() implementation. - - - - -Evaluate the given typed expression. - - - - -Evaluate the given untyped expression. - - - - -Operators on Expr and Expr<'a> for decompiling, evaluating, and incrementally reducing quotation expressions. - - - - - - - - - - - - - - - - - - - -Construct a Value from an evaluated expression - - - - - - - - - - - - - -Test whether the two lists are pairwise equal using the given boolean comparison function - - - - - - - - - - - - - - - - - - - - - - - - - -Normalize newlines to stdout.NewLine: if stdout.NewLine = "\n", then do nothing. -Otherwise replace all occurences of "\n", but not "\r\n", with "\r\n" and then replace -all occurences of "\r\n" with stdout.NewLine. - - - - -Normalize newlines to Environment.NewLine: if Environment.NewLine = "\n", then do nothing. -If Environment.NewLine = "\r\n", then replace all occurences of "\n", but not "\r\n", with "\r\n". -This allows "\n" to be used as an environment safe newline character, which may be mixed -with uses of Environment.NewLine. - - - - -Matches "\n", but not "\r\n" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Test an input string against a regex pattern using the given RegexOptions flags. -If the match succeeds, returns an ActiveMatch instance, which can be used for further pattern matching. -Note that the implementation takes advantage of the .NET Regex cache. - - -The first argument allows you pass in RegexOptions flags. - - -The second argument is the regex pattern. Cannot be null. - - -The last argument is the input string to test. The input -may be null which would result in a no-match. - - - - - - - -Convenience versions of our regex active patterns using RegexOptions.None flag - - - - - - - -When silverlight mode is None, else is Compiled - - - - -Convenience versions of our regex active patterns using RegexOptions.Compiled flag. -If PORTABLE compiler directive defined, then RegexOptions.None flag used. - - - - -Regex extensions - - - - - - - - - - - - - diff --git a/packages/Unquote.3.1.0/lib/portable-net45+netcore45+wpa81+wp8+MonoAndroid1+MonoTouch1/Unquote.dll b/packages/Unquote.3.1.0/lib/portable-net45+netcore45+wpa81+wp8+MonoAndroid1+MonoTouch1/Unquote.dll deleted file mode 100644 index b62840b..0000000 Binary files a/packages/Unquote.3.1.0/lib/portable-net45+netcore45+wpa81+wp8+MonoAndroid1+MonoTouch1/Unquote.dll and /dev/null differ diff --git a/packages/Unquote.3.1.0/lib/portable-net45+netcore45+wpa81+wp8+MonoAndroid1+MonoTouch1/Unquote.xml b/packages/Unquote.3.1.0/lib/portable-net45+netcore45+wpa81+wp8+MonoAndroid1+MonoTouch1/Unquote.xml deleted file mode 100644 index 2223578..0000000 --- a/packages/Unquote.3.1.0/lib/portable-net45+netcore45+wpa81+wp8+MonoAndroid1+MonoTouch1/Unquote.xml +++ /dev/null @@ -1,1115 +0,0 @@ - - -Unquote - - - - - - - - - - - - -Exception used to signal assertion failure to be caught by any exception framework -(used when not NUnit or xUnit.net or when compiled for framework versions lacking serialization features) - - - - - - - - - - - - - -Exception used to distinguish an error in the quotation evaluation engine. - - - - - - - -Exception used to indicate an exception captured during reduction (typically not raised itself). - - - - - - - - - - - - - - - - - - - -The exception, if any, that was raised during reduction. Note that this is the actual exception raised, not the wrapper ReductionException. - - - - - - - - - - - - - - - - -An "unquoted" view of a quotation. i.e. provides info about the reduction steps -of a quotation. - - - - - - - - - - - - - - - - - - - - - - -Test wether the given expr fails with the given expected exception (or a subclass thereof) when the additional assertion on the exception object holds. - - - - -Test wether the given expr fails with the given expected exception (or a subclass thereof). - - - - -Evaluate the given boolean expression: if false output incremental eval steps using -1) stdout if fsi mode -2) Framework fail methods if xUnit.net (v1 or v2), NUnit, or Fuchu present -3) System.Exception if release mode. - - - - - - - - - - - - - - - - - - - - - - -These '?' suffixed operators conflict with F# 3.0's nullable operators and have been replaced by equivalent '!' suffixed operators. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -raise is not inlined in Core.Operators, so shows up in stack traces. We inline it here for clean stacktraces. - - - - -Functions and values public inline Operator functions rely on (and therefore must be public, -even though we do not want to expose them publically). - - - - -Operators on Expr and Expr<'a> for performing unit test assertions. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -aty is the arg type, bty is the return type, x is the arg - - - - - - - - - - - - - - - - - - - - - - -name is the name of the unary op method, aty is the arg type, x is the arg - - - - - - - - - - - - - -Binary ops of the form 'a->int->'a - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -name is the name of the method, aty is the type of the first arg, bty is the type of the second arg, -x is the first arg, y is the second arg. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -The purpose of these operator implementations is two fold 1) many F# operators do not include dynamic impls, -so we must give them. 2) even those operators which are given dynamic impls do not perform well since they -need to be accessed via reflection, so we give "native" impls here. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -"reraise" the given exception, preserving the stacktrace (e.g. for InnerExceptions of TargetInvocation exceptions) - - - - -Strip possibly nested target invocation exception - - - - - - - -The F#-style signature. Note: this property is out-of-place in this assembly and may be moved elsewhere in future versions. - - - - -Determine whether this expression is reduced. - - - - -Convert the given expression to a list of all of its Reduce steps in order. - - - - -Convert this expression with the given variable environment to a list of all of its Reduce steps in order. - - - - -Reduce this expression by one step: convert each branch of the given expression to a Value expression of its -evaluation if each sub-branch of the branch is reduced. -If this expression is already reduced, or cannot be reduced, returns itself. - - - - -Reduce this expression by one step with the given variable environment: convert each branch of the given expression to a Value expression of its -evaluation if each sub-branch of the branch is reduced. -If this expression is already reduced, or cannot be reduced, returns itself. - - - - -Decompile this expression to its source code representation. Sub-expressions which are -not currently supported will fallback on the default Expr.ToString() implementation. - - - - -Evaluate this untyped expression. - - - - -Evaluate this untyped expression with the given variable environment. - - - - -Evaluate this typed expression with the given variable environment. - - - - -Evaluate this typed expression. - - - - -Extensions methods on Expr and Expr<'a> for decompiling, evaluating, and incrementally reducing quotation expressions. Also includes a bonus -extension method on Type for getting the short, F#-style name of a type. - - - - -Match Call(None, ...) patterns for NumericLiterals, returning the literal value as a string and suffix on success - - - - -Match a sequence, list, or array op_RangeStep expression, return (startToken, endToken, startExpression, stepExpression, endExpression). Must come before Call patterns. - - - - -Match a sequence, list, or array op_Range expression, return (startToken, endToken, startExpression, endExpression). Must come before Call patterns. - - - - - - - -Partial application and zero application of Lambda call (e.g. List.map (+), or id). -Must come before Let and Lambdas patterns. -Cases: 1) Let .. Lambdas .. Call - 2) Lambdas .. Call - - - - -Test whether the given expression represents a tuple let binding: e.g. let x,y = 1,2. -Must come before Let pattern and after IncompleteLambdaCall pattern. - - - - -Test whether the Expr is a Var and equals the given Var property-wise - - - - - - - -Match non-custom binary infix Call patterns. -Must come before Call pattern. - - - - -Matches lambda values, returning the demangled (but not source) name of the lambda - - - - - - - -Extra Quoation patterns for sprinting and reducing Quotation Expressions - - - - - - - - - - - - - - - - - - - -sprints the generic arguments of a call if definitely not inferable. - - - - - - - -Determine whether the generic args for a call are inferable - - - - -Sprint the F#-style type signature of the given Type. Handles known type abbreviations, -simple types, arbitrarily complex generic types (multiple parameters and nesting), -lambdas, tuples, and arrays. - - - - - - - -get the source name for the Module or F# Function represented by the given MemberInfo - - - - - - - - - - -is the top-level FSI module - - - - - - - - - - - - - - - - - - - -try to find the first class symbolic function representation of a "op_" function name - - - - - - - - - - - - - - - - - - - -Extra reflection functions sprinting and reducing Quotation Expressions - - - - - - - - - - - - - -Precedence - - - - -Associativity - - - - - - - -Represents an operator's precedence. The lower the precedence value, the lower the binding. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Build an UnquotedExpression from the given quotation. - - - - -Determine whether the given expression is reduced. - - - - -Convert the given expression with the given variable environment to a list of all of its Reduce steps in order. - - - - -Reduce the given expression by one step with the given variable environment: convert each branch of the given expression to a Value expression of its -evaluation if each sub-branch of the branch is reduced. -If this expression is already reduced, or cannot be reduced, returns itself. - - - - -Evaluate the given typed expression with the given variable environment. - - - - -Evaluate the given untyped expression with the given variable environment. - - - - -Convert the given expression to a list of all of its Reduce steps in order. - - - - -Reduce by one step: convert each branch of the given expression to a Value expression of its -evaluation if each sub-branch of the branch is reduced. -If this expression is already reduced, or cannot be reduced, returns itself. - - - - -Decompile given expression to its source code representation. Sub-expressions which are -not currently supported will fallback on the default Expr.ToString() implementation. - - - - -Evaluate the given typed expression. - - - - -Evaluate the given untyped expression. - - - - -Operators on Expr and Expr<'a> for decompiling, evaluating, and incrementally reducing quotation expressions. - - - - - - - - - - - - - - - - - - - -Construct a Value from an evaluated expression - - - - - - - - - - - - - -Test whether the two lists are pairwise equal using the given boolean comparison function - - - - - - - - - - - - - - - - - - - -Normalize newlines to Environment.NewLine: if Environment.NewLine = "\n", then do nothing. -If Environment.NewLine = "\r\n", then replace all occurences of "\n", but not "\r\n", with "\r\n". -This allows "\n" to be used as an environment safe newline character, which may be mixed -with uses of Environment.NewLine. - - - - -Matches "\n", but not "\r\n" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Test an input string against a regex pattern using the given RegexOptions flags. -If the match succeeds, returns an ActiveMatch instance, which can be used for further pattern matching. -Note that the implementation takes advantage of the .NET Regex cache. - - -The first argument allows you pass in RegexOptions flags. - - -The second argument is the regex pattern. Cannot be null. - - -The last argument is the input string to test. The input -may be null which would result in a no-match. - - - - - - - -Convenience versions of our regex active patterns using RegexOptions.None flag - - - - - - - -When silverlight mode is None, else is Compiled - - - - -Convenience versions of our regex active patterns using RegexOptions.Compiled flag. -If PORTABLE compiler directive defined, then RegexOptions.None flag used. - - - - -Regex extensions - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/packages/Zero29.0.6.2/Zero29.0.6.2.nupkg b/packages/Zero29.0.6.2/Zero29.0.6.2.nupkg deleted file mode 100644 index c65bcb3..0000000 Binary files a/packages/Zero29.0.6.2/Zero29.0.6.2.nupkg and /dev/null differ diff --git a/packages/Zero29.0.6.2/tools/FSharp.Core.dll b/packages/Zero29.0.6.2/tools/FSharp.Core.dll deleted file mode 100644 index a8ab078..0000000 Binary files a/packages/Zero29.0.6.2/tools/FSharp.Core.dll and /dev/null differ diff --git a/packages/Zero29.0.6.2/tools/Ploeh.ZeroToNine.XML b/packages/Zero29.0.6.2/tools/Ploeh.ZeroToNine.XML deleted file mode 100644 index ab62b3b..0000000 --- a/packages/Zero29.0.6.2/tools/Ploeh.ZeroToNine.XML +++ /dev/null @@ -1,57 +0,0 @@ - - -Ploeh.ZeroToNine - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/packages/Zero29.0.6.2/tools/Ploeh.ZeroToNine.dll b/packages/Zero29.0.6.2/tools/Ploeh.ZeroToNine.dll deleted file mode 100644 index ef18ceb..0000000 Binary files a/packages/Zero29.0.6.2/tools/Ploeh.ZeroToNine.dll and /dev/null differ diff --git a/packages/Zero29.0.6.2/tools/Zero29.XML b/packages/Zero29.0.6.2/tools/Zero29.XML deleted file mode 100644 index 27b757e..0000000 --- a/packages/Zero29.0.6.2/tools/Zero29.XML +++ /dev/null @@ -1,84 +0,0 @@ - - -Zero29 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/packages/Zero29.0.6.2/tools/Zero29.exe b/packages/Zero29.0.6.2/tools/Zero29.exe deleted file mode 100644 index 094297f..0000000 Binary files a/packages/Zero29.0.6.2/tools/Zero29.exe and /dev/null differ diff --git a/packages/xunit.2.1.0/xunit.2.1.0.nupkg b/packages/xunit.2.1.0/xunit.2.1.0.nupkg deleted file mode 100644 index c7c606b..0000000 Binary files a/packages/xunit.2.1.0/xunit.2.1.0.nupkg and /dev/null differ diff --git a/packages/xunit.abstractions.2.0.0/lib/net35/xunit.abstractions.dll b/packages/xunit.abstractions.2.0.0/lib/net35/xunit.abstractions.dll deleted file mode 100644 index f645709..0000000 Binary files a/packages/xunit.abstractions.2.0.0/lib/net35/xunit.abstractions.dll and /dev/null differ diff --git a/packages/xunit.abstractions.2.0.0/lib/net35/xunit.abstractions.xml b/packages/xunit.abstractions.2.0.0/lib/net35/xunit.abstractions.xml deleted file mode 100644 index 7dba65f..0000000 --- a/packages/xunit.abstractions.2.0.0/lib/net35/xunit.abstractions.xml +++ /dev/null @@ -1,1087 +0,0 @@ - - - - xunit.abstractions - - - - - Represents source information about a test case. - - - - - Interface implement by objects that want to support serialization in xUnit.net. - - - - - Called when the object should populate itself with data from the serialization info. - - The info to get the data from - - - - Called when the object should store its data into the serialization info. - - The info to store the data in - - - - Gets or sets the source file name. A null value indicates that the - source file name is not known. - - - - - Gets or sets the source file line. A null value indicates that the - source file line is not known. - - - - - Represents a provider which gives source line information for a test case. Generally - consumed by an implementation of during Find operations. - - - - - Returns the source information for a test case. - - The test case to retrieve information for. - The source information, with null string and int values when the information is not available. - Note: return value should never be null, only the interior data values inside. - - - - Represents a test framework. There are two pieces to test frameworks: discovery and - execution. The two factory methods represent these two pieces. Test frameworks can - implement an empty constructor, or they can implement one that takes - if they want to be able to send diagnostic messages. - - - - - Get a test discoverer. - - The assembly from which to discover the tests. - The test discoverer. - - - - Get a test executor. - - The name of the assembly to run tests from. - The test executor. - - - - Sets the source information provider to be used during discovery. - - - - - Represents an implementation of the discovery part of a test framework. - - - - - Starts the process of finding all tests in an assembly. - - Whether to include source file information, if possible. - The message sink to report results back to. - The options used by the test framework during discovery. - - - - Starts the process of finding all tests in a class. - - The fully qualified type name to find tests in. - Whether to include source file information, if possible. - The message sink to report results back to. - The options used by the test framework during discovery. - - - - Serializes a test case into string form. - - The test case to be serialized. - The serialized representation of the test case. - - - - Gets the target framework that the test assembly is linked against. - - - - - Returns the display name of the test framework that this discoverer is running tests for. - - - - - Represents an instance of that is to be used for - test discovery purposes. - - - - - This interface should not be consumed directly; instead, you should - consume - or . - - - - - Gets an option value. - - The type of the value. - The name of the value. - The value. - - - - Sets an option value. - - The type of the value. - The name of the value. - The value to be set. - - - - Represents an instance of that is to be used for - test execution purposes. - - - - - Represents an implementation of the execution part of a test framework. - - - - - De-serializes a test case. - - The string representation of the test case. - The de-serialized test case. - - - - Starts the process of running all the tests in the assembly. - - The message sink to report results back to. - The options to be used during test discovery. - The options to be used during test execution. - - - - Starts the process of running selected tests in the assembly. - - The test cases to run. - The message sink to report results back to. - The options to be used during test execution. - - - - Base message interface for all messages related to test execution. It includes the list - of test cases that are associated with this execution step. - - - - - This is the base interface for all test messages. A test message is a message that is - used to communicate the status of discovery and execution of tests. - - - - - The test cases that are associated with this message. - - - - - This represents failure information for the test runner. It encapsulates multiple sets - of exceptions so that it can provide inner exception information, including support for - . The parent indices indicate the hierarchy of the exceptions - as extracted during the failure; the 0th exception is always the single parent of the tree, - and will have an index of -1. - - - - - The fully-qualified type name of the exceptions. - - - - - The messages of the exceptions. - - - - - The stack traces of the exceptions. - - - - - The parent exception index for the exceptions; a -1 indicates that - the exception in question has no parent. - - - - - This is the base message for various types of completion that can occur during the - various phases of execution process (e.g., test case, test class, test collection, - and assembly). - - - - - The execution time (in seconds) for this execution. - - - - - The number of failing tests. - - - - - The total number of tests run. - - - - - The number of skipped tests. - - - - - Represents an endpoint for the reception of test messages. - - - - - Reports the presence of a message on the message bus. This method should - never throw exceptions. - - The message from the message bus - Return true to continue running tests, or false to stop. - - - - Base message interface for all messages related to test assemblies. - - - - - The test assembly that is associated with this message. - - - - - Base message interface for all messages related to test cases. - - - - - Base message interface for all messages related to test methods. - - - - - Base message interface for all messages related to test classes. - - - - - Base message interface for all messages related to test collections. - - - - - The test collection that is associated with this message. - - - - - The test class that is associated with this message. - - - - - The test method that is associated with this message. - - - - - The test case that is associated with this message. - - - - - Base message interface for all messages related to tests. - - - - - The test that is associated with this message. - - - - - This is the base interface for all individual test results (e.g., tests which - pass, fail, or are skipped). - - - - - The execution time of the test, in seconds. - - - - - The captured output of the test. - - - - - This message is sent during execution to indicate that the After method of - a has completed executing. - - - - - The fully qualified type name of the . - - - - - This message is sent during execution to indicate that the After method of - a is about to execute. - - - - - The fully qualified type name of the . - - - - - This message is sent during execution to indicate that the Before method of - a has completed executing. - - - - - The fully qualified type name of the . - - - - - This message is sent during execution to indicate that the Before method of - a is about to execute. - - - - - The fully qualified type name of the . - - - - - This message is sent when the test framework wants to report a diagnostic message - to the end user. - - - - - Gets the diagnostic message. - - - - - This message indicates that the discovery process has been completed for - the requested assembly. - - - - - This message indicates that an error has occurred in the execution process. - - - - - This message indicates that an error has occurred in test assembly cleanup. - - - - - This message indicates that the execution process has been completed for - the requested assembly. - - - - - This message indicates that the execution process is about to start for - the requested assembly. - - - - - Gets the local date and time when the test assembly execution began. - - - - - Gets a display string that describes the test execution environment. - - - - - Gets a display string which describes the test framework and version number. - - - - - This message indicates that an error has occurred during test case cleanup. - - - - - This message indicates that a test case had been found during the discovery process. - - - - - This message indicates that a test case has finished executing. - - - - - This message indicates that a test case is about to start executing. - - - - - This message indicates that an error has occurred during test class cleanup. - - - - - This message indicates that an instance of a test class has just been constructed. - Instance (non-static) methods of tests get a new instance of the test class for each - individual test execution; static methods do not get an instance of the test class. - - - - - This message indicates that an instance of a test class is about to be constructed. - Instance (non-static) methods of tests get a new instance of the test class for each - individual test execution; static methods do not get an instance of the test class. - - - - - This message indicates that the method was - just called on the test class for the test case that just finished executing. - - - - - This message indicates that the method is - about to be called on the test class for the test case that just finished executing. - - - - - This message indicates that a test class has finished executing (meaning, all of the - test cases in this test class have finished running). - - - - - This message indicates that a test class is about to begin running. - - - - - This message indicates that an error has occurred during test cleanup. - - - - - This message indicates that an error has occurred during test collection cleanup. - - - - - This message indicates that a test collection has just finished executing (meaning, - all the test classes in the collection has finished). - - - - - This message indicates that a test collection has is about to start executing. - - - - - This message indicates that a test has failed. - - - - - This message indicates that a test has finished executing. - - - - - Gets the time spent executing the test, in seconds. - - - - - The captured output of the test. - - - - - This message indicates that an error has occurred during test method cleanup. - - - - - This message indicates that a test method has finished executing (meaning, all - the test cases that derived from the test method have finished). - - - - - This message indicates that a test method is about to begin executing. - - - - - This message indicates that a line of output was provided for a test. - - - - - Gets the line of output. - - - - - Indicates that a test has passed. - - - - - This message indicates that a test was skipped. - - - - - The reason given for skipping the test. - - - - - This message indicates that a test is about to start executing. - - - - - Represents information about an assembly. The primary implementation is based on runtime - reflection, but may also be implemented by runner authors to provide non-reflection-based - test discovery (for example, AST-based runners like CodeRush or Resharper). - - - - - Gets all the custom attributes for the given assembly. - - The type of the attribute, in assembly-qualified form - The matching attributes that decorate the assembly - - - - Gets a for the given type. - - The fully qualified type name. - The if the type exists, or null if not. - - - - Gets all the types for the assembly. - - Set to true to return all types in the assembly, - or false to return only public types. - The types in the assembly. - - - - Gets the on-disk location of the assembly under test. If the assembly path is not - known (for example, in AST-based runners), you must return null. - - - This is used by the test framework wrappers to find the co-located unit test framework - assembly (f.e., xunit.dll or xunit.execution.dll). AST-based runners will need to directly create - instances of and (using the constructors that - support an explicit path to the test framework DLL) rather than relying on the - use of . - - - - - Gets the assembly name. May return a fully qualified name for assemblies found via - reflection (i.e., "mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"), - or may return just assembly name only for assemblies found via source code introspection - (i.e., "mscorlib"). - - - - - Represents information about an attribute. The primary implementation is based on runtime - reflection, but may also be implemented by runner authors to provide non-reflection-based - test discovery (for example, AST-based runners like CodeRush or Resharper). - - - - - Gets the arguments passed to the constructor. - - The constructor arguments, in order - - - - Gets all the custom attributes for the given attribute. - - The type of the attribute to find, in assembly-qualified form - The matching attributes that decorate the attribute - - - - Gets a named-argument initialized value of the attribute. If there is no named argument for the given name - on this attribute, then returns default(TValue). - - The type of the argument - The name of the argument - The argument value - - - - Represents information about a method. The primary implementation is based on runtime - reflection, but may also be implemented by runner authors to provide non-reflection-based - test discovery (for example, AST-based runners like CodeRush or Resharper). - - - - - Gets all the custom attributes for the method that are of the given type. - - The type of the attribute, in assembly qualified form - The matching attributes that decorate the method - - - - Gets the types of the generic arguments for generic methods. - - The argument types. - - - - Gets information about the parameters to the method. - - The method's parameters. - - - - Converts an open generic method into a closed generic method, using the provided type arguments. - - The type arguments to be used in the generic definition. - A new that represents the closed generic method. - - - - Gets a value indicating whether the method is abstract. - - - - - Gets a value indicating whether the method is a generic definition (i.e., an open generic). - - - - - Gets a value indicating whether the method is public. - - - - - Gets a value indicating whether the method is static. - - - - - Gets the name of the method. - - - - - Gets the fully qualified type name of the return type. - - - - - Gets a value which represents the class that this method was - reflected from (i.e., equivalent to MethodInfo.ReflectedType) - - - - - Represents information about a method parameter. The primary implementation is based on runtime - reflection, but may also be implemented by runner authors to provide non-reflection-based - test discovery (for example, AST-based runners like CodeRush or Resharper). - - - - - The name of the parameter. - - - - - Gets the type of the parameter. - - - - - Represents a reflection-backed implementation of . - - - - - Gets the underlying for the assembly. - - - - - Represents a reflection-backed implementation of . - - - - - Gets the instance of the attribute, if available. - - - - - Represents a reflection-backed implementation of . - - - - - Gets the underlying for the method. - - - - - Represents a reflection-backed implementation of . - - - - - Gets the underlying for the parameter. - - - - - Represents a reflection-backed implementation of . - - - - - Represents information about a type. The primary implementation is based on runtime - reflection, but may also be implemented by runner authors to provide non-reflection-based - test discovery (for example, AST-based runners like CodeRush or Resharper). - - - - - Gets all the custom attributes for the given type. - - The type of the attribute, in assembly qualified form - The matching attributes that decorate the type - - - - Gets the generic type arguments for a generic type. - - The list of generic types. - - - - Gets a specific method. - - The name of the method. - Set to true to look for the method in both public and private. - The method. - - - - Gets all the methods in this type. - - Set to true to return all methods in the type, - or false to return only public methods. - - - - Gets the assembly this type is located in. - - - - - Gets the base type of the given type. - - - - - Gets the interfaces implemented by the given type. - - - - - Gets a value indicating whether the type is abstract. - - - - - Gets a value indicating whether the type represents a generic parameter. - - - - - Gets a value indicating whether the type is a generic type. - - - - - Gets a value indicating whether the type is sealed. - - - - - Gets a value indicating whether the type is a value type. - - - - - Gets the fully qualified type name (for non-generic parameters), or the - simple type name (for generic parameters). - - - - - Gets the underlying object. - - - - - Represents serialization support in xUnit.net. - - - - - Adds a value to the serialization. Supported value types include the built-in - intrinsics (string, int, long, float, double, and decimal, including nullable - versions of those), any class which implements ), - or arrays of any supported types. - - The key - The value - The optional type of the value - - - - Gets a value from the serialization. - - The key - The type of the value - The value, if present; null, otherwise - - - - Gets a value from the serialization. - - The key - The value, if present; default(T), otherwise - - - - Represents a single test in the system. A test case typically contains only a single test, - but may contain many if circumstances warrant it (for example, test data for a theory cannot - be pre-enumerated, so the theory yields a single test case with multiple tests). - - - - - Gets the display name of the test. - - - - - Gets the test case this test belongs to. - - - - - Represents a test assembly. - - - - - Gets the assembly that this test assembly belongs to. - - - - - Gets the full path of the configuration file name, if one is present. - May be null if there is no configuration file. - - - - - Represents a single test case in the system. This test case usually represents a single test, but in - the case of dynamically generated data for data driven tests, the test case may actually return - multiple results when run. - - - - - Gets the display name of the test case. - - - - - Gets the display text for the reason a test is being skipped; if the test - is not skipped, returns null. - - - - - Get or sets the source file name and line where the test is defined, if requested (and known). - - - - - Gets the test method this test case belongs to. - - - - - Gets the arguments that will be passed to the test method. - - - - - Gets the trait values associated with this test case. If - there are none, or the framework does not support traits, - this should return an empty dictionary (not null). This - dictionary must be treated as read-only. - - - - - Gets a unique identifier for the test case. - - - The unique identifier for a test case should be able to discriminate - among test cases, even those which are varied invocations against the - same test method (i.e., theories). Ideally, this identifier would remain - stable until such time as the developer changes some fundamental part - of the identity (assembly, class name, test name, or test data); however, - the minimum stability of the identifier must at least extend across - multiple discoveries of the same test in the same (non-recompiled) - assembly. - - - - - Represents a test class. - - - - - Gets the class that this test case is attached to. - - - - - Gets the test collection this test case belongs to. - - - - - Represents a group of test cases. Test collections form the basis of the parallelization in - xUnit.net. Test cases which are in the same test collection will not be run in parallel - against sibling tests, but will run in parallel against tests in other collections. - - - - - Gets the type that the test collection was defined with, if available; may be null - if the test collection didn't have a definition type. - - - - - Gets the display name of the test collection. - - - - - Gets the test assembly this test collection belongs to. - - - - - Gets the test collection ID. Test collection equality is determined by comparing IDs. - - - - - Represents a test method. - - - - - Gets the method associated with this test method. - - - - - Gets the test class that this test method belongs to. - - - - - Represents a class which can be used to provide test output. - - - - - Adds a line of text to the output. - - The message - - - - Formats a line of text and adds it to the output. - - The message format - The format arguments - - - diff --git a/packages/xunit.abstractions.2.0.0/lib/portable-net45+win+wpa81+wp80+monotouch+monoandroid+Xamarin.iOS/xunit.abstractions.dll b/packages/xunit.abstractions.2.0.0/lib/portable-net45+win+wpa81+wp80+monotouch+monoandroid+Xamarin.iOS/xunit.abstractions.dll deleted file mode 100644 index 926e59d..0000000 Binary files a/packages/xunit.abstractions.2.0.0/lib/portable-net45+win+wpa81+wp80+monotouch+monoandroid+Xamarin.iOS/xunit.abstractions.dll and /dev/null differ diff --git a/packages/xunit.abstractions.2.0.0/lib/portable-net45+win+wpa81+wp80+monotouch+monoandroid+Xamarin.iOS/xunit.abstractions.xml b/packages/xunit.abstractions.2.0.0/lib/portable-net45+win+wpa81+wp80+monotouch+monoandroid+Xamarin.iOS/xunit.abstractions.xml deleted file mode 100644 index 7dba65f..0000000 --- a/packages/xunit.abstractions.2.0.0/lib/portable-net45+win+wpa81+wp80+monotouch+monoandroid+Xamarin.iOS/xunit.abstractions.xml +++ /dev/null @@ -1,1087 +0,0 @@ - - - - xunit.abstractions - - - - - Represents source information about a test case. - - - - - Interface implement by objects that want to support serialization in xUnit.net. - - - - - Called when the object should populate itself with data from the serialization info. - - The info to get the data from - - - - Called when the object should store its data into the serialization info. - - The info to store the data in - - - - Gets or sets the source file name. A null value indicates that the - source file name is not known. - - - - - Gets or sets the source file line. A null value indicates that the - source file line is not known. - - - - - Represents a provider which gives source line information for a test case. Generally - consumed by an implementation of during Find operations. - - - - - Returns the source information for a test case. - - The test case to retrieve information for. - The source information, with null string and int values when the information is not available. - Note: return value should never be null, only the interior data values inside. - - - - Represents a test framework. There are two pieces to test frameworks: discovery and - execution. The two factory methods represent these two pieces. Test frameworks can - implement an empty constructor, or they can implement one that takes - if they want to be able to send diagnostic messages. - - - - - Get a test discoverer. - - The assembly from which to discover the tests. - The test discoverer. - - - - Get a test executor. - - The name of the assembly to run tests from. - The test executor. - - - - Sets the source information provider to be used during discovery. - - - - - Represents an implementation of the discovery part of a test framework. - - - - - Starts the process of finding all tests in an assembly. - - Whether to include source file information, if possible. - The message sink to report results back to. - The options used by the test framework during discovery. - - - - Starts the process of finding all tests in a class. - - The fully qualified type name to find tests in. - Whether to include source file information, if possible. - The message sink to report results back to. - The options used by the test framework during discovery. - - - - Serializes a test case into string form. - - The test case to be serialized. - The serialized representation of the test case. - - - - Gets the target framework that the test assembly is linked against. - - - - - Returns the display name of the test framework that this discoverer is running tests for. - - - - - Represents an instance of that is to be used for - test discovery purposes. - - - - - This interface should not be consumed directly; instead, you should - consume - or . - - - - - Gets an option value. - - The type of the value. - The name of the value. - The value. - - - - Sets an option value. - - The type of the value. - The name of the value. - The value to be set. - - - - Represents an instance of that is to be used for - test execution purposes. - - - - - Represents an implementation of the execution part of a test framework. - - - - - De-serializes a test case. - - The string representation of the test case. - The de-serialized test case. - - - - Starts the process of running all the tests in the assembly. - - The message sink to report results back to. - The options to be used during test discovery. - The options to be used during test execution. - - - - Starts the process of running selected tests in the assembly. - - The test cases to run. - The message sink to report results back to. - The options to be used during test execution. - - - - Base message interface for all messages related to test execution. It includes the list - of test cases that are associated with this execution step. - - - - - This is the base interface for all test messages. A test message is a message that is - used to communicate the status of discovery and execution of tests. - - - - - The test cases that are associated with this message. - - - - - This represents failure information for the test runner. It encapsulates multiple sets - of exceptions so that it can provide inner exception information, including support for - . The parent indices indicate the hierarchy of the exceptions - as extracted during the failure; the 0th exception is always the single parent of the tree, - and will have an index of -1. - - - - - The fully-qualified type name of the exceptions. - - - - - The messages of the exceptions. - - - - - The stack traces of the exceptions. - - - - - The parent exception index for the exceptions; a -1 indicates that - the exception in question has no parent. - - - - - This is the base message for various types of completion that can occur during the - various phases of execution process (e.g., test case, test class, test collection, - and assembly). - - - - - The execution time (in seconds) for this execution. - - - - - The number of failing tests. - - - - - The total number of tests run. - - - - - The number of skipped tests. - - - - - Represents an endpoint for the reception of test messages. - - - - - Reports the presence of a message on the message bus. This method should - never throw exceptions. - - The message from the message bus - Return true to continue running tests, or false to stop. - - - - Base message interface for all messages related to test assemblies. - - - - - The test assembly that is associated with this message. - - - - - Base message interface for all messages related to test cases. - - - - - Base message interface for all messages related to test methods. - - - - - Base message interface for all messages related to test classes. - - - - - Base message interface for all messages related to test collections. - - - - - The test collection that is associated with this message. - - - - - The test class that is associated with this message. - - - - - The test method that is associated with this message. - - - - - The test case that is associated with this message. - - - - - Base message interface for all messages related to tests. - - - - - The test that is associated with this message. - - - - - This is the base interface for all individual test results (e.g., tests which - pass, fail, or are skipped). - - - - - The execution time of the test, in seconds. - - - - - The captured output of the test. - - - - - This message is sent during execution to indicate that the After method of - a has completed executing. - - - - - The fully qualified type name of the . - - - - - This message is sent during execution to indicate that the After method of - a is about to execute. - - - - - The fully qualified type name of the . - - - - - This message is sent during execution to indicate that the Before method of - a has completed executing. - - - - - The fully qualified type name of the . - - - - - This message is sent during execution to indicate that the Before method of - a is about to execute. - - - - - The fully qualified type name of the . - - - - - This message is sent when the test framework wants to report a diagnostic message - to the end user. - - - - - Gets the diagnostic message. - - - - - This message indicates that the discovery process has been completed for - the requested assembly. - - - - - This message indicates that an error has occurred in the execution process. - - - - - This message indicates that an error has occurred in test assembly cleanup. - - - - - This message indicates that the execution process has been completed for - the requested assembly. - - - - - This message indicates that the execution process is about to start for - the requested assembly. - - - - - Gets the local date and time when the test assembly execution began. - - - - - Gets a display string that describes the test execution environment. - - - - - Gets a display string which describes the test framework and version number. - - - - - This message indicates that an error has occurred during test case cleanup. - - - - - This message indicates that a test case had been found during the discovery process. - - - - - This message indicates that a test case has finished executing. - - - - - This message indicates that a test case is about to start executing. - - - - - This message indicates that an error has occurred during test class cleanup. - - - - - This message indicates that an instance of a test class has just been constructed. - Instance (non-static) methods of tests get a new instance of the test class for each - individual test execution; static methods do not get an instance of the test class. - - - - - This message indicates that an instance of a test class is about to be constructed. - Instance (non-static) methods of tests get a new instance of the test class for each - individual test execution; static methods do not get an instance of the test class. - - - - - This message indicates that the method was - just called on the test class for the test case that just finished executing. - - - - - This message indicates that the method is - about to be called on the test class for the test case that just finished executing. - - - - - This message indicates that a test class has finished executing (meaning, all of the - test cases in this test class have finished running). - - - - - This message indicates that a test class is about to begin running. - - - - - This message indicates that an error has occurred during test cleanup. - - - - - This message indicates that an error has occurred during test collection cleanup. - - - - - This message indicates that a test collection has just finished executing (meaning, - all the test classes in the collection has finished). - - - - - This message indicates that a test collection has is about to start executing. - - - - - This message indicates that a test has failed. - - - - - This message indicates that a test has finished executing. - - - - - Gets the time spent executing the test, in seconds. - - - - - The captured output of the test. - - - - - This message indicates that an error has occurred during test method cleanup. - - - - - This message indicates that a test method has finished executing (meaning, all - the test cases that derived from the test method have finished). - - - - - This message indicates that a test method is about to begin executing. - - - - - This message indicates that a line of output was provided for a test. - - - - - Gets the line of output. - - - - - Indicates that a test has passed. - - - - - This message indicates that a test was skipped. - - - - - The reason given for skipping the test. - - - - - This message indicates that a test is about to start executing. - - - - - Represents information about an assembly. The primary implementation is based on runtime - reflection, but may also be implemented by runner authors to provide non-reflection-based - test discovery (for example, AST-based runners like CodeRush or Resharper). - - - - - Gets all the custom attributes for the given assembly. - - The type of the attribute, in assembly-qualified form - The matching attributes that decorate the assembly - - - - Gets a for the given type. - - The fully qualified type name. - The if the type exists, or null if not. - - - - Gets all the types for the assembly. - - Set to true to return all types in the assembly, - or false to return only public types. - The types in the assembly. - - - - Gets the on-disk location of the assembly under test. If the assembly path is not - known (for example, in AST-based runners), you must return null. - - - This is used by the test framework wrappers to find the co-located unit test framework - assembly (f.e., xunit.dll or xunit.execution.dll). AST-based runners will need to directly create - instances of and (using the constructors that - support an explicit path to the test framework DLL) rather than relying on the - use of . - - - - - Gets the assembly name. May return a fully qualified name for assemblies found via - reflection (i.e., "mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"), - or may return just assembly name only for assemblies found via source code introspection - (i.e., "mscorlib"). - - - - - Represents information about an attribute. The primary implementation is based on runtime - reflection, but may also be implemented by runner authors to provide non-reflection-based - test discovery (for example, AST-based runners like CodeRush or Resharper). - - - - - Gets the arguments passed to the constructor. - - The constructor arguments, in order - - - - Gets all the custom attributes for the given attribute. - - The type of the attribute to find, in assembly-qualified form - The matching attributes that decorate the attribute - - - - Gets a named-argument initialized value of the attribute. If there is no named argument for the given name - on this attribute, then returns default(TValue). - - The type of the argument - The name of the argument - The argument value - - - - Represents information about a method. The primary implementation is based on runtime - reflection, but may also be implemented by runner authors to provide non-reflection-based - test discovery (for example, AST-based runners like CodeRush or Resharper). - - - - - Gets all the custom attributes for the method that are of the given type. - - The type of the attribute, in assembly qualified form - The matching attributes that decorate the method - - - - Gets the types of the generic arguments for generic methods. - - The argument types. - - - - Gets information about the parameters to the method. - - The method's parameters. - - - - Converts an open generic method into a closed generic method, using the provided type arguments. - - The type arguments to be used in the generic definition. - A new that represents the closed generic method. - - - - Gets a value indicating whether the method is abstract. - - - - - Gets a value indicating whether the method is a generic definition (i.e., an open generic). - - - - - Gets a value indicating whether the method is public. - - - - - Gets a value indicating whether the method is static. - - - - - Gets the name of the method. - - - - - Gets the fully qualified type name of the return type. - - - - - Gets a value which represents the class that this method was - reflected from (i.e., equivalent to MethodInfo.ReflectedType) - - - - - Represents information about a method parameter. The primary implementation is based on runtime - reflection, but may also be implemented by runner authors to provide non-reflection-based - test discovery (for example, AST-based runners like CodeRush or Resharper). - - - - - The name of the parameter. - - - - - Gets the type of the parameter. - - - - - Represents a reflection-backed implementation of . - - - - - Gets the underlying for the assembly. - - - - - Represents a reflection-backed implementation of . - - - - - Gets the instance of the attribute, if available. - - - - - Represents a reflection-backed implementation of . - - - - - Gets the underlying for the method. - - - - - Represents a reflection-backed implementation of . - - - - - Gets the underlying for the parameter. - - - - - Represents a reflection-backed implementation of . - - - - - Represents information about a type. The primary implementation is based on runtime - reflection, but may also be implemented by runner authors to provide non-reflection-based - test discovery (for example, AST-based runners like CodeRush or Resharper). - - - - - Gets all the custom attributes for the given type. - - The type of the attribute, in assembly qualified form - The matching attributes that decorate the type - - - - Gets the generic type arguments for a generic type. - - The list of generic types. - - - - Gets a specific method. - - The name of the method. - Set to true to look for the method in both public and private. - The method. - - - - Gets all the methods in this type. - - Set to true to return all methods in the type, - or false to return only public methods. - - - - Gets the assembly this type is located in. - - - - - Gets the base type of the given type. - - - - - Gets the interfaces implemented by the given type. - - - - - Gets a value indicating whether the type is abstract. - - - - - Gets a value indicating whether the type represents a generic parameter. - - - - - Gets a value indicating whether the type is a generic type. - - - - - Gets a value indicating whether the type is sealed. - - - - - Gets a value indicating whether the type is a value type. - - - - - Gets the fully qualified type name (for non-generic parameters), or the - simple type name (for generic parameters). - - - - - Gets the underlying object. - - - - - Represents serialization support in xUnit.net. - - - - - Adds a value to the serialization. Supported value types include the built-in - intrinsics (string, int, long, float, double, and decimal, including nullable - versions of those), any class which implements ), - or arrays of any supported types. - - The key - The value - The optional type of the value - - - - Gets a value from the serialization. - - The key - The type of the value - The value, if present; null, otherwise - - - - Gets a value from the serialization. - - The key - The value, if present; default(T), otherwise - - - - Represents a single test in the system. A test case typically contains only a single test, - but may contain many if circumstances warrant it (for example, test data for a theory cannot - be pre-enumerated, so the theory yields a single test case with multiple tests). - - - - - Gets the display name of the test. - - - - - Gets the test case this test belongs to. - - - - - Represents a test assembly. - - - - - Gets the assembly that this test assembly belongs to. - - - - - Gets the full path of the configuration file name, if one is present. - May be null if there is no configuration file. - - - - - Represents a single test case in the system. This test case usually represents a single test, but in - the case of dynamically generated data for data driven tests, the test case may actually return - multiple results when run. - - - - - Gets the display name of the test case. - - - - - Gets the display text for the reason a test is being skipped; if the test - is not skipped, returns null. - - - - - Get or sets the source file name and line where the test is defined, if requested (and known). - - - - - Gets the test method this test case belongs to. - - - - - Gets the arguments that will be passed to the test method. - - - - - Gets the trait values associated with this test case. If - there are none, or the framework does not support traits, - this should return an empty dictionary (not null). This - dictionary must be treated as read-only. - - - - - Gets a unique identifier for the test case. - - - The unique identifier for a test case should be able to discriminate - among test cases, even those which are varied invocations against the - same test method (i.e., theories). Ideally, this identifier would remain - stable until such time as the developer changes some fundamental part - of the identity (assembly, class name, test name, or test data); however, - the minimum stability of the identifier must at least extend across - multiple discoveries of the same test in the same (non-recompiled) - assembly. - - - - - Represents a test class. - - - - - Gets the class that this test case is attached to. - - - - - Gets the test collection this test case belongs to. - - - - - Represents a group of test cases. Test collections form the basis of the parallelization in - xUnit.net. Test cases which are in the same test collection will not be run in parallel - against sibling tests, but will run in parallel against tests in other collections. - - - - - Gets the type that the test collection was defined with, if available; may be null - if the test collection didn't have a definition type. - - - - - Gets the display name of the test collection. - - - - - Gets the test assembly this test collection belongs to. - - - - - Gets the test collection ID. Test collection equality is determined by comparing IDs. - - - - - Represents a test method. - - - - - Gets the method associated with this test method. - - - - - Gets the test class that this test method belongs to. - - - - - Represents a class which can be used to provide test output. - - - - - Adds a line of text to the output. - - The message - - - - Formats a line of text and adds it to the output. - - The message format - The format arguments - - - diff --git a/packages/xunit.abstractions.2.0.0/xunit.abstractions.2.0.0.nupkg b/packages/xunit.abstractions.2.0.0/xunit.abstractions.2.0.0.nupkg deleted file mode 100644 index 2ee1659..0000000 Binary files a/packages/xunit.abstractions.2.0.0/xunit.abstractions.2.0.0.nupkg and /dev/null differ diff --git a/packages/xunit.assert.2.1.0/lib/dotnet/xunit.assert.dll b/packages/xunit.assert.2.1.0/lib/dotnet/xunit.assert.dll deleted file mode 100644 index 3f155ab..0000000 Binary files a/packages/xunit.assert.2.1.0/lib/dotnet/xunit.assert.dll and /dev/null differ diff --git a/packages/xunit.assert.2.1.0/lib/dotnet/xunit.assert.xml b/packages/xunit.assert.2.1.0/lib/dotnet/xunit.assert.xml deleted file mode 100644 index 342e7e7..0000000 --- a/packages/xunit.assert.2.1.0/lib/dotnet/xunit.assert.xml +++ /dev/null @@ -1,1414 +0,0 @@ - - - - xunit.assert - - - - - Contains various static methods that are used to verify that conditions are met during the - process of running tests. - - - - - Initializes a new instance of the class. - - - - Do not call this method. - - - Do not call this method. - - - - Verifies that the condition is false. - - The condition to be tested - Thrown if the condition is not false - - - - Verifies that the condition is false. - - The condition to be tested - Thrown if the condition is not false - - - - Verifies that the condition is false. - - The condition to be tested - The message to show when the condition is not false - Thrown if the condition is not false - - - - Verifies that the condition is false. - - The condition to be tested - The message to show when the condition is not false - Thrown if the condition is not false - - - - Verifies that an expression is true. - - The condition to be inspected - Thrown when the condition is false - - - - Verifies that an expression is true. - - The condition to be inspected - Thrown when the condition is false - - - - Verifies that an expression is true. - - The condition to be inspected - The message to be shown when the condition is false - Thrown when the condition is false - - - - Verifies that an expression is true. - - The condition to be inspected - The message to be shown when the condition is false - Thrown when the condition is false - - - - Verifies that all items in the collection pass when executed against - action. - - The type of the object to be verified - The collection - The action to test each item against - Thrown when the collection contains at least one non-matching element - - - - Verifies that a collection contains exactly a given number of elements, which meet - the criteria provided by the element inspectors. - - The type of the object to be verified - The collection to be inspected - The element inspectors, which inspect each element in turn. The - total number of element inspectors must exactly match the number of elements in the collection. - - - - Verifies that a collection contains a given object. - - The type of the object to be verified - The object expected to be in the collection - The collection to be inspected - Thrown when the object is not present in the collection - - - - Verifies that a collection contains a given object, using an equality comparer. - - The type of the object to be verified - The object expected to be in the collection - The collection to be inspected - The comparer used to equate objects in the collection with the expected object - Thrown when the object is not present in the collection - - - - Verifies that a collection contains a given object. - - The type of the object to be verified - The collection to be inspected - The filter used to find the item you're ensuring the collection contains - Thrown when the object is not present in the collection - - - - Verifies that a collection does not contain a given object. - - The type of the object to be compared - The object that is expected not to be in the collection - The collection to be inspected - Thrown when the object is present inside the container - - - - Verifies that a collection does not contain a given object, using an equality comparer. - - The type of the object to be compared - The object that is expected not to be in the collection - The collection to be inspected - The comparer used to equate objects in the collection with the expected object - Thrown when the object is present inside the container - - - - Verifies that a collection does not contain a given object. - - The type of the object to be compared - The collection to be inspected - The filter used to find the item you're ensuring the collection does not contain - Thrown when the object is present inside the container - - - - Verifies that a collection is empty. - - The collection to be inspected - Thrown when the collection is null - Thrown when the collection is not empty - - - - Verifies that two sequences are equivalent, using a default comparer. - - The type of the objects to be compared - The expected value - The value to be compared against - Thrown when the objects are not equal - - - - Verifies that two sequences are equivalent, using a custom equatable comparer. - - The type of the objects to be compared - The expected value - The value to be compared against - The comparer used to compare the two objects - Thrown when the objects are not equal - - - - Verifies that a collection is not empty. - - The collection to be inspected - Thrown when a null collection is passed - Thrown when the collection is empty - - - - Verifies that two sequences are not equivalent, using a default comparer. - - The type of the objects to be compared - The expected object - The actual object - Thrown when the objects are equal - - - - Verifies that two sequences are not equivalent, using a custom equality comparer. - - The type of the objects to be compared - The expected object - The actual object - The comparer used to compare the two objects - Thrown when the objects are equal - - - - Verifies that the given collection contains only a single - element of the given type. - - The collection. - The single item in the collection. - Thrown when the collection does not contain - exactly one element. - - - - Verifies that the given collection contains only a single - element of the given value. The collection may or may not - contain other values. - - The collection. - The value to find in the collection. - The single item in the collection. - Thrown when the collection does not contain - exactly one element. - - - - Verifies that the given collection contains only a single - element of the given type. - - The collection type. - The collection. - The single item in the collection. - Thrown when the collection does not contain - exactly one element. - - - - Verifies that the given collection contains only a single - element of the given type which matches the given predicate. The - collection may or may not contain other values which do not - match the given predicate. - - The collection type. - The collection. - The item matching predicate. - The single item in the filtered collection. - Thrown when the filtered collection does - not contain exactly one element. - - - - Verifies that two objects are equal, using a default comparer. - - The type of the objects to be compared - The expected value - The value to be compared against - Thrown when the objects are not equal - - - - Verifies that two objects are equal, using a custom equatable comparer. - - The type of the objects to be compared - The expected value - The value to be compared against - The comparer used to compare the two objects - Thrown when the objects are not equal - - - - Verifies that two values are equal, within the number of decimal - places given by . - - The expected value - The value to be compared against - The number of decimal places (valid values: 0-15) - Thrown when the values are not equal - - - - Verifies that two values are equal, within the number of decimal - places given by . - - The expected value - The value to be compared against - The number of decimal places (valid values: 0-15) - Thrown when the values are not equal - - - - Verifies that two objects are strictly equal, using the type's default comparer. - - The type of the objects to be compared - The expected value - The value to be compared against - Thrown when the objects are not equal - - - - Verifies that two objects are not equal, using a default comparer. - - The type of the objects to be compared - The expected object - The actual object - Thrown when the objects are equal - - - - Verifies that two objects are not equal, using a custom equality comparer. - - The type of the objects to be compared - The expected object - The actual object - The comparer used to examine the objects - Thrown when the objects are equal - - - - Verifies that two values are not equal, within the number of decimal - places given by . - - The expected value - The value to be compared against - The number of decimal places (valid values: 0-15) - Thrown when the values are equal - - - - Verifies that two values are not equal, within the number of decimal - places given by . - - The expected value - The value to be compared against - The number of decimal places (valid values: 0-15) - Thrown when the values are equal - - - - Verifies that two objects are strictly not equal, using the type's default comparer. - - The type of the objects to be compared - The expected object - The actual object - Thrown when the objects are equal - - - - Verifies that the exact exception is thrown (and not a derived exception type). - - The type of the exception expected to be thrown - A delegate to the code to be tested - The exception that was thrown, when successful - Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown - - - - Verifies that the exact exception is thrown (and not a derived exception type). - Generally used to test property accessors. - - The type of the exception expected to be thrown - A delegate to the code to be tested - The exception that was thrown, when successful - Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown - - - - - - - Verifies that the exact exception is thrown (and not a derived exception type). - - The type of the exception expected to be thrown - A delegate to the task to be tested - The exception that was thrown, when successful - Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown - - - - Verifies that the exact exception or a derived exception type is thrown. - - The type of the exception expected to be thrown - A delegate to the code to be tested - The exception that was thrown, when successful - Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown - - - - Verifies that the exact exception or a derived exception type is thrown. - Generally used to test property accessors. - - The type of the exception expected to be thrown - A delegate to the code to be tested - The exception that was thrown, when successful - Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown - - - - Verifies that the exact exception or a derived exception type is thrown. - - The type of the exception expected to be thrown - A delegate to the task to be tested - The exception that was thrown, when successful - Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown - - - - Verifies that the exact exception is thrown (and not a derived exception type). - - The type of the exception expected to be thrown - A delegate to the code to be tested - The exception that was thrown, when successful - Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown - - - - Verifies that the exact exception is thrown (and not a derived exception type). - Generally used to test property accessors. - - The type of the exception expected to be thrown - A delegate to the code to be tested - The exception that was thrown, when successful - Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown - - - - Verifies that the exact exception is thrown (and not a derived exception type). - - The type of the exception expected to be thrown - A delegate to the task to be tested - The exception that was thrown, when successful - Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown - - - - Verifies that the exact exception is thrown (and not a derived exception type), where the exception - derives from and has the given parameter name. - - The parameter name that is expected to be in the exception - A delegate to the code to be tested - The exception that was thrown, when successful - Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown - - - - Verifies that the exact exception is thrown (and not a derived exception type), where the exception - derives from and has the given parameter name. - - The parameter name that is expected to be in the exception - A delegate to the code to be tested - The exception that was thrown, when successful - Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown - - - - - - - Verifies that the exact exception is thrown (and not a derived exception type), where the exception - derives from and has the given parameter name. - - The parameter name that is expected to be in the exception - A delegate to the task to be tested - The exception that was thrown, when successful - Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown - - - - - - - Records any exception which is thrown by the given code. - - The code which may thrown an exception. - Returns the exception that was thrown by the code; null, otherwise. - - - - Records any exception which is thrown by the given code that has - a return value. Generally used for testing property accessors. - - The code which may thrown an exception. - Returns the exception that was thrown by the code; null, otherwise. - - - - - - - Records any exception which is thrown by the given task. - - The task which may thrown an exception. - Returns the exception that was thrown by the code; null, otherwise. - - - - Verifies that two objects are not the same instance. - - The expected object instance - The actual object instance - Thrown when the objects are the same instance - - - - Verifies that two objects are the same instance. - - The expected object instance - The actual object instance - Thrown when the objects are not the same instance - - - - Verifies that an object reference is not null. - - The object to be validated - Thrown when the object is not null - - - - Verifies that an object reference is null. - - The object to be inspected - Thrown when the object reference is not null - - - - Verifies that the provided object raised INotifyPropertyChanged.PropertyChanged - as a result of executing the given test code. - - The object which should raise the notification - The property name for which the notification should be raised - The test code which should cause the notification to be raised - Thrown when the notification is not raised - - - - Verifies that a value is within a given range. - - The type of the value to be compared - The actual value to be evaluated - The (inclusive) low value of the range - The (inclusive) high value of the range - Thrown when the value is not in the given range - - - - Verifies that a value is within a given range, using a comparer. - - The type of the value to be compared - The actual value to be evaluated - The (inclusive) low value of the range - The (inclusive) high value of the range - The comparer used to evaluate the value's range - Thrown when the value is not in the given range - - - - Verifies that a value is not within a given range, using the default comparer. - - The type of the value to be compared - The actual value to be evaluated - The (inclusive) low value of the range - The (inclusive) high value of the range - Thrown when the value is in the given range - - - - Verifies that a value is not within a given range, using a comparer. - - The type of the value to be compared - The actual value to be evaluated - The (inclusive) low value of the range - The (inclusive) high value of the range - The comparer used to evaluate the value's range - Thrown when the value is in the given range - - - - Verifies that a set is a proper subset of another set. - - The type of the object to be verified - The expected superset - The set expected to be a proper subset - Thrown when the actual set is not a proper subset of the expected set - - - - Verifies that a set is a proper superset of another set. - - The type of the object to be verified - The expected subset - The set expected to be a proper superset - Thrown when the actual set is not a proper superset of the expected set - - - - Verifies that a set is a subset of another set. - - The type of the object to be verified - The expected superset - The set expected to be a subset - Thrown when the actual set is not a subset of the expected set - - - - Verifies that a set is a superset of another set. - - The type of the object to be verified - The expected subset - The set expected to be a superset - Thrown when the actual set is not a superset of the expected set - - - - Verifies that a string contains a given sub-string, using the current culture. - - The sub-string expected to be in the string - The string to be inspected - Thrown when the sub-string is not present inside the string - - - - Verifies that a string contains a given sub-string, using the given comparison type. - - The sub-string expected to be in the string - The string to be inspected - The type of string comparison to perform - Thrown when the sub-string is not present inside the string - - - - Verifies that a string does not contain a given sub-string, using the current culture. - - The sub-string which is expected not to be in the string - The string to be inspected - Thrown when the sub-string is present inside the string - - - - Verifies that a string does not contain a given sub-string, using the current culture. - - The sub-string which is expected not to be in the string - The string to be inspected - The type of string comparison to perform - Thrown when the sub-string is present inside the given string - - - - Verifies that a string starts with a given string, using the current culture. - - The string expected to be at the start of the string - The string to be inspected - Thrown when the string does not start with the expected string - - - - Verifies that a string starts with a given string, using the given comparison type. - - The string expected to be at the start of the string - The string to be inspected - The type of string comparison to perform - Thrown when the string does not start with the expected string - - - - Verifies that a string ends with a given string, using the current culture. - - The string expected to be at the end of the string - The string to be inspected - Thrown when the string does not end with the expected string - - - - Verifies that a string ends with a given string, using the given comparison type. - - The string expected to be at the end of the string - The string to be inspected - The type of string comparison to perform - Thrown when the string does not end with the expected string - - - - Verifies that a string matches a regular expression. - - The regex pattern expected to match - The string to be inspected - Thrown when the string does not match the regex pattern - - - - Verifies that a string matches a regular expression. - - The regex expected to match - The string to be inspected - Thrown when the string does not match the regex - - - - Verifies that a string does not match a regular expression. - - The regex pattern expected not to match - The string to be inspected - Thrown when the string matches the regex pattern - - - - Verifies that a string does not match a regular expression. - - The regex expected not to match - The string to be inspected - Thrown when the string matches the regex - - - - Verifies that two strings are equivalent. - - The expected string value. - The actual string value. - Thrown when the strings are not equivalent. - - - - Verifies that two strings are equivalent. - - The expected string value. - The actual string value. - If set to true, ignores cases differences. The invariant culture is used. - If set to true, treats \r\n, \r, and \n as equivalent. - If set to true, treats spaces and tabs (in any non-zero quantity) as equivalent. - Thrown when the strings are not equivalent. - - - - Verifies that an object is of the given type or a derived type. - - The type the object should be - The object to be evaluated - The object, casted to type T when successful - Thrown when the object is not the given type - - - - Verifies that an object is of the given type or a derived type. - - The type the object should be - The object to be evaluated - Thrown when the object is not the given type - - - - Verifies that an object is not exactly the given type. - - The type the object should not be - The object to be evaluated - Thrown when the object is the given type - - - - Verifies that an object is not exactly the given type. - - The type the object should not be - The object to be evaluated - Thrown when the object is the given type - - - - Verifies that an object is exactly the given type (and not a derived type). - - The type the object should be - The object to be evaluated - The object, casted to type T when successful - Thrown when the object is not the given type - - - - Verifies that an object is exactly the given type (and not a derived type). - - The type the object should be - The object to be evaluated - Thrown when the object is not the given type - - - - Formats arguments for display in theories. - - - - - Format the value for presentation. - - The value to be formatted. - The formatted value. - - - - Default implementation of used by the xUnit.net range assertions. - - The type that is being compared. - - - - - - - Default implementation of used by the xUnit.net equality assertions. - - The type that is being compared. - - - - Initializes a new instance of the class. - - Set to true to skip type equality checks. - The inner comparer to be used when the compared objects are enumerable. - - - - - - - - - - A class that wraps to create . - - The type that is being compared. - - - - Initializes a new instance of the class. - - The comparer that is being adapted. - - - - - - - - - - Base class for exceptions that have actual and expected values - - - - - Creates a new instance of the class. - - The expected value - The actual value - The user message to be shown - The title to use for the expected value (defaults to "Expected") - The title to use for the actual value (defaults to "Actual") - - - - Gets the actual value. - - - - - Gets the title used for the actual value. - - - - - Gets the expected value. - - - - - Gets the title used for the expected value. - - - - - Gets a message that describes the current exception. Includes the expected and actual values. - - The error message that explains the reason for the exception, or an empty string(""). - 1 - - - - Exception thrown when the collection did not contain exactly the given number element. - - - - - Initializes a new instance of the class. - - The expected number of items in the collection. - The actual number of items in the collection. - - - - Exception thrown when Assert.Collection fails. - - - - - Creates a new instance of the class. - - The expected number of items in the collection. - The actual number of items in the collection. - The index of the position where the first comparison failure occurred. - The exception that was thrown during the comparison failure. - - - - The actual number of items in the collection. - - - - - The expected number of items in the collection. - - - - - The index of the position where the first comparison failure occurred, or -1 if - comparisions did not occur (because the actual and expected counts differed). - - - - - - - - - - - Exception thrown when an All assertion has one or more items fail an assertion. - - - - - Creates a new instance of the class. - - The total number of items that were in the collection. - The list of errors that occurred during the test pass. - - - - The errors that occurred during execution of the test. - - - - - - - - Exception thrown when a collection unexpectedly does not contain the expected value. - - - - - Creates a new instance of the class. - - The expected object value - The actual value - - - - Exception thrown when a collection unexpectedly contains the expected value. - - - - - Creates a new instance of the class. - - The expected object value - The actual value - - - - Exception thrown when a string unexpectedly matches a regular expression. - - - - - Creates a new instance of the class. - - The regular expression pattern expected not to match - The actual value - - - - Exception thrown when a collection is unexpectedly not empty. - - - - - Creates a new instance of the class. - - - - - Exception thrown when a string does not end with the expected value. - - - - - Creates a new instance of the class. - - The expected string value - The actual value - - - - Exception thrown when two values are unexpectedly not equal. - - - - - Creates a new instance of the class. - - The expected object value - The actual object value - - - - Creates a new instance of the class for string comparisons. - - The expected string value - The actual string value - The first index in the expected string where the strings differ - The first index in the actual string where the strings differ - - - - Gets the index into the actual value where the values first differed. - Returns -1 if the difference index points were not provided. - - - - - Gets the index into the expected value where the values first differed. - Returns -1 if the difference index points were not provided. - - - - - - - - Exception thrown when a value is unexpectedly true. - - - - - Creates a new instance of the class. - - The user message to be display, or null for the default message - The actual value - - - - Exception thrown when a value is unexpectedly not in the given range. - - - - - Creates a new instance of the class. - - The actual object value - The low value of the range - The high value of the range - - - - Gets the actual object value - - - - - Gets the high value of the range - - - - - Gets the low value of the range - - - - - Gets a message that describes the current exception. - - The error message that explains the reason for the exception, or an empty string(""). - - - - Exception thrown when the value is unexpectedly not of the given type or a derived type. - - - - - Creates a new instance of the class. - - The expected type - The actual object value - - - - Exception thrown when the value is unexpectedly of the exact given type. - - - - - Creates a new instance of the class. - - The expected type - The actual object value - - - - Exception thrown when the value is unexpectedly not of the exact given type. - - - - - Creates a new instance of the class. - - The expected type name - The actual type name - - - - Exception thrown when a string does not match a regular expression. - - - - - Creates a new instance of the class. - - The expected regular expression pattern - The actual value - - - - Exception thrown when a collection is unexpectedly empty. - - - - - Creates a new instance of the class. - - - - - Exception thrown when two values are unexpectedly equal. - - - - - Creates a new instance of the class. - - - - - Exception thrown when a value is unexpectedly in the given range. - - - - - Creates a new instance of the class. - - The actual object value - The low value of the range - The high value of the range - - - - Gets the actual object value - - - - - Gets the high value of the range - - - - - Gets the low value of the range - - - - - Gets a message that describes the current exception. - - The error message that explains the reason for the exception, or an empty string(""). - - - - Exception thrown when an object is unexpectedly null. - - - - - Creates a new instance of the class. - - - - - Exception thrown when two values are unexpected the same instance. - - - - - Creates a new instance of the class. - - - - - Exception thrown when an object reference is unexpectedly not null. - - - - - Creates a new instance of the class. - - - - - - Exception to be thrown from theory execution when the number of - parameter values does not the test method signature. - - - - - Exception thrown when a set is not a proper subset of another set. - - - - - Creates a new instance of the class. - - - - - Exception thrown when a set is not a proper superset of another set. - - - - - Creates a new instance of the class. - - - - - Exception thrown when code unexpectedly fails change a property. - - - - - Creates a new instance of the class. Call this constructor - when no exception was thrown. - - The name of the property that was expected to be changed. - - - - Exception thrown when two object references are unexpectedly not the same instance. - - - - - Creates a new instance of the class. - - The expected object reference - The actual object reference - - - - Exception thrown when the collection did not contain exactly one element. - - - - - Initializes a new instance of the class. - - The numbers of items in the collection. - - - - Exception thrown when a string does not start with the expected value. - - - - - Creates a new instance of the class. - - The expected string value - The actual value - - - - Exception thrown when a set is not a subset of another set. - - - - - Creates a new instance of the class. - - - - - Exception thrown when a set is not a superset of another set. - - - - - Creates a new instance of the class. - - - - - Exception thrown when code unexpectedly fails to throw an exception. - - - - - Creates a new instance of the class. Call this constructor - when no exception was thrown. - - The type of the exception that was expected - - - - Creates a new instance of the class. Call this constructor - when an exception of the wrong type was thrown. - - The type of the exception that was expected - The actual exception that was thrown - - - - THIS CONSTRUCTOR IS FOR UNIT TESTING PURPOSES ONLY. - - - - - Gets a string representation of the frames on the call stack at the time the current exception was thrown. - - A string that describes the contents of the call stack, with the most recent method call appearing first. - - - - Exception thrown when a value is unexpectedly false. - - - - - Creates a new instance of the class. - - The user message to be displayed, or null for the default message - The actual value - - - - The base assert exception class - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The user message to be displayed - - - - Initializes a new instance of the class. - - The user message to be displayed - The inner exception - - - - Initializes a new instance of the class. - - The user message to be displayed - The stack trace to be displayed - - - - Gets a string representation of the frames on the call stack at the time the current exception was thrown. - - A string that describes the contents of the call stack, with the most recent method call appearing first. - - - - Gets the user message - - - - - - - diff --git a/packages/xunit.assert.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.assert.dll b/packages/xunit.assert.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.assert.dll deleted file mode 100644 index 3f155ab..0000000 Binary files a/packages/xunit.assert.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.assert.dll and /dev/null differ diff --git a/packages/xunit.assert.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.assert.xml b/packages/xunit.assert.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.assert.xml deleted file mode 100644 index 342e7e7..0000000 --- a/packages/xunit.assert.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.assert.xml +++ /dev/null @@ -1,1414 +0,0 @@ - - - - xunit.assert - - - - - Contains various static methods that are used to verify that conditions are met during the - process of running tests. - - - - - Initializes a new instance of the class. - - - - Do not call this method. - - - Do not call this method. - - - - Verifies that the condition is false. - - The condition to be tested - Thrown if the condition is not false - - - - Verifies that the condition is false. - - The condition to be tested - Thrown if the condition is not false - - - - Verifies that the condition is false. - - The condition to be tested - The message to show when the condition is not false - Thrown if the condition is not false - - - - Verifies that the condition is false. - - The condition to be tested - The message to show when the condition is not false - Thrown if the condition is not false - - - - Verifies that an expression is true. - - The condition to be inspected - Thrown when the condition is false - - - - Verifies that an expression is true. - - The condition to be inspected - Thrown when the condition is false - - - - Verifies that an expression is true. - - The condition to be inspected - The message to be shown when the condition is false - Thrown when the condition is false - - - - Verifies that an expression is true. - - The condition to be inspected - The message to be shown when the condition is false - Thrown when the condition is false - - - - Verifies that all items in the collection pass when executed against - action. - - The type of the object to be verified - The collection - The action to test each item against - Thrown when the collection contains at least one non-matching element - - - - Verifies that a collection contains exactly a given number of elements, which meet - the criteria provided by the element inspectors. - - The type of the object to be verified - The collection to be inspected - The element inspectors, which inspect each element in turn. The - total number of element inspectors must exactly match the number of elements in the collection. - - - - Verifies that a collection contains a given object. - - The type of the object to be verified - The object expected to be in the collection - The collection to be inspected - Thrown when the object is not present in the collection - - - - Verifies that a collection contains a given object, using an equality comparer. - - The type of the object to be verified - The object expected to be in the collection - The collection to be inspected - The comparer used to equate objects in the collection with the expected object - Thrown when the object is not present in the collection - - - - Verifies that a collection contains a given object. - - The type of the object to be verified - The collection to be inspected - The filter used to find the item you're ensuring the collection contains - Thrown when the object is not present in the collection - - - - Verifies that a collection does not contain a given object. - - The type of the object to be compared - The object that is expected not to be in the collection - The collection to be inspected - Thrown when the object is present inside the container - - - - Verifies that a collection does not contain a given object, using an equality comparer. - - The type of the object to be compared - The object that is expected not to be in the collection - The collection to be inspected - The comparer used to equate objects in the collection with the expected object - Thrown when the object is present inside the container - - - - Verifies that a collection does not contain a given object. - - The type of the object to be compared - The collection to be inspected - The filter used to find the item you're ensuring the collection does not contain - Thrown when the object is present inside the container - - - - Verifies that a collection is empty. - - The collection to be inspected - Thrown when the collection is null - Thrown when the collection is not empty - - - - Verifies that two sequences are equivalent, using a default comparer. - - The type of the objects to be compared - The expected value - The value to be compared against - Thrown when the objects are not equal - - - - Verifies that two sequences are equivalent, using a custom equatable comparer. - - The type of the objects to be compared - The expected value - The value to be compared against - The comparer used to compare the two objects - Thrown when the objects are not equal - - - - Verifies that a collection is not empty. - - The collection to be inspected - Thrown when a null collection is passed - Thrown when the collection is empty - - - - Verifies that two sequences are not equivalent, using a default comparer. - - The type of the objects to be compared - The expected object - The actual object - Thrown when the objects are equal - - - - Verifies that two sequences are not equivalent, using a custom equality comparer. - - The type of the objects to be compared - The expected object - The actual object - The comparer used to compare the two objects - Thrown when the objects are equal - - - - Verifies that the given collection contains only a single - element of the given type. - - The collection. - The single item in the collection. - Thrown when the collection does not contain - exactly one element. - - - - Verifies that the given collection contains only a single - element of the given value. The collection may or may not - contain other values. - - The collection. - The value to find in the collection. - The single item in the collection. - Thrown when the collection does not contain - exactly one element. - - - - Verifies that the given collection contains only a single - element of the given type. - - The collection type. - The collection. - The single item in the collection. - Thrown when the collection does not contain - exactly one element. - - - - Verifies that the given collection contains only a single - element of the given type which matches the given predicate. The - collection may or may not contain other values which do not - match the given predicate. - - The collection type. - The collection. - The item matching predicate. - The single item in the filtered collection. - Thrown when the filtered collection does - not contain exactly one element. - - - - Verifies that two objects are equal, using a default comparer. - - The type of the objects to be compared - The expected value - The value to be compared against - Thrown when the objects are not equal - - - - Verifies that two objects are equal, using a custom equatable comparer. - - The type of the objects to be compared - The expected value - The value to be compared against - The comparer used to compare the two objects - Thrown when the objects are not equal - - - - Verifies that two values are equal, within the number of decimal - places given by . - - The expected value - The value to be compared against - The number of decimal places (valid values: 0-15) - Thrown when the values are not equal - - - - Verifies that two values are equal, within the number of decimal - places given by . - - The expected value - The value to be compared against - The number of decimal places (valid values: 0-15) - Thrown when the values are not equal - - - - Verifies that two objects are strictly equal, using the type's default comparer. - - The type of the objects to be compared - The expected value - The value to be compared against - Thrown when the objects are not equal - - - - Verifies that two objects are not equal, using a default comparer. - - The type of the objects to be compared - The expected object - The actual object - Thrown when the objects are equal - - - - Verifies that two objects are not equal, using a custom equality comparer. - - The type of the objects to be compared - The expected object - The actual object - The comparer used to examine the objects - Thrown when the objects are equal - - - - Verifies that two values are not equal, within the number of decimal - places given by . - - The expected value - The value to be compared against - The number of decimal places (valid values: 0-15) - Thrown when the values are equal - - - - Verifies that two values are not equal, within the number of decimal - places given by . - - The expected value - The value to be compared against - The number of decimal places (valid values: 0-15) - Thrown when the values are equal - - - - Verifies that two objects are strictly not equal, using the type's default comparer. - - The type of the objects to be compared - The expected object - The actual object - Thrown when the objects are equal - - - - Verifies that the exact exception is thrown (and not a derived exception type). - - The type of the exception expected to be thrown - A delegate to the code to be tested - The exception that was thrown, when successful - Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown - - - - Verifies that the exact exception is thrown (and not a derived exception type). - Generally used to test property accessors. - - The type of the exception expected to be thrown - A delegate to the code to be tested - The exception that was thrown, when successful - Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown - - - - - - - Verifies that the exact exception is thrown (and not a derived exception type). - - The type of the exception expected to be thrown - A delegate to the task to be tested - The exception that was thrown, when successful - Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown - - - - Verifies that the exact exception or a derived exception type is thrown. - - The type of the exception expected to be thrown - A delegate to the code to be tested - The exception that was thrown, when successful - Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown - - - - Verifies that the exact exception or a derived exception type is thrown. - Generally used to test property accessors. - - The type of the exception expected to be thrown - A delegate to the code to be tested - The exception that was thrown, when successful - Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown - - - - Verifies that the exact exception or a derived exception type is thrown. - - The type of the exception expected to be thrown - A delegate to the task to be tested - The exception that was thrown, when successful - Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown - - - - Verifies that the exact exception is thrown (and not a derived exception type). - - The type of the exception expected to be thrown - A delegate to the code to be tested - The exception that was thrown, when successful - Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown - - - - Verifies that the exact exception is thrown (and not a derived exception type). - Generally used to test property accessors. - - The type of the exception expected to be thrown - A delegate to the code to be tested - The exception that was thrown, when successful - Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown - - - - Verifies that the exact exception is thrown (and not a derived exception type). - - The type of the exception expected to be thrown - A delegate to the task to be tested - The exception that was thrown, when successful - Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown - - - - Verifies that the exact exception is thrown (and not a derived exception type), where the exception - derives from and has the given parameter name. - - The parameter name that is expected to be in the exception - A delegate to the code to be tested - The exception that was thrown, when successful - Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown - - - - Verifies that the exact exception is thrown (and not a derived exception type), where the exception - derives from and has the given parameter name. - - The parameter name that is expected to be in the exception - A delegate to the code to be tested - The exception that was thrown, when successful - Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown - - - - - - - Verifies that the exact exception is thrown (and not a derived exception type), where the exception - derives from and has the given parameter name. - - The parameter name that is expected to be in the exception - A delegate to the task to be tested - The exception that was thrown, when successful - Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown - - - - - - - Records any exception which is thrown by the given code. - - The code which may thrown an exception. - Returns the exception that was thrown by the code; null, otherwise. - - - - Records any exception which is thrown by the given code that has - a return value. Generally used for testing property accessors. - - The code which may thrown an exception. - Returns the exception that was thrown by the code; null, otherwise. - - - - - - - Records any exception which is thrown by the given task. - - The task which may thrown an exception. - Returns the exception that was thrown by the code; null, otherwise. - - - - Verifies that two objects are not the same instance. - - The expected object instance - The actual object instance - Thrown when the objects are the same instance - - - - Verifies that two objects are the same instance. - - The expected object instance - The actual object instance - Thrown when the objects are not the same instance - - - - Verifies that an object reference is not null. - - The object to be validated - Thrown when the object is not null - - - - Verifies that an object reference is null. - - The object to be inspected - Thrown when the object reference is not null - - - - Verifies that the provided object raised INotifyPropertyChanged.PropertyChanged - as a result of executing the given test code. - - The object which should raise the notification - The property name for which the notification should be raised - The test code which should cause the notification to be raised - Thrown when the notification is not raised - - - - Verifies that a value is within a given range. - - The type of the value to be compared - The actual value to be evaluated - The (inclusive) low value of the range - The (inclusive) high value of the range - Thrown when the value is not in the given range - - - - Verifies that a value is within a given range, using a comparer. - - The type of the value to be compared - The actual value to be evaluated - The (inclusive) low value of the range - The (inclusive) high value of the range - The comparer used to evaluate the value's range - Thrown when the value is not in the given range - - - - Verifies that a value is not within a given range, using the default comparer. - - The type of the value to be compared - The actual value to be evaluated - The (inclusive) low value of the range - The (inclusive) high value of the range - Thrown when the value is in the given range - - - - Verifies that a value is not within a given range, using a comparer. - - The type of the value to be compared - The actual value to be evaluated - The (inclusive) low value of the range - The (inclusive) high value of the range - The comparer used to evaluate the value's range - Thrown when the value is in the given range - - - - Verifies that a set is a proper subset of another set. - - The type of the object to be verified - The expected superset - The set expected to be a proper subset - Thrown when the actual set is not a proper subset of the expected set - - - - Verifies that a set is a proper superset of another set. - - The type of the object to be verified - The expected subset - The set expected to be a proper superset - Thrown when the actual set is not a proper superset of the expected set - - - - Verifies that a set is a subset of another set. - - The type of the object to be verified - The expected superset - The set expected to be a subset - Thrown when the actual set is not a subset of the expected set - - - - Verifies that a set is a superset of another set. - - The type of the object to be verified - The expected subset - The set expected to be a superset - Thrown when the actual set is not a superset of the expected set - - - - Verifies that a string contains a given sub-string, using the current culture. - - The sub-string expected to be in the string - The string to be inspected - Thrown when the sub-string is not present inside the string - - - - Verifies that a string contains a given sub-string, using the given comparison type. - - The sub-string expected to be in the string - The string to be inspected - The type of string comparison to perform - Thrown when the sub-string is not present inside the string - - - - Verifies that a string does not contain a given sub-string, using the current culture. - - The sub-string which is expected not to be in the string - The string to be inspected - Thrown when the sub-string is present inside the string - - - - Verifies that a string does not contain a given sub-string, using the current culture. - - The sub-string which is expected not to be in the string - The string to be inspected - The type of string comparison to perform - Thrown when the sub-string is present inside the given string - - - - Verifies that a string starts with a given string, using the current culture. - - The string expected to be at the start of the string - The string to be inspected - Thrown when the string does not start with the expected string - - - - Verifies that a string starts with a given string, using the given comparison type. - - The string expected to be at the start of the string - The string to be inspected - The type of string comparison to perform - Thrown when the string does not start with the expected string - - - - Verifies that a string ends with a given string, using the current culture. - - The string expected to be at the end of the string - The string to be inspected - Thrown when the string does not end with the expected string - - - - Verifies that a string ends with a given string, using the given comparison type. - - The string expected to be at the end of the string - The string to be inspected - The type of string comparison to perform - Thrown when the string does not end with the expected string - - - - Verifies that a string matches a regular expression. - - The regex pattern expected to match - The string to be inspected - Thrown when the string does not match the regex pattern - - - - Verifies that a string matches a regular expression. - - The regex expected to match - The string to be inspected - Thrown when the string does not match the regex - - - - Verifies that a string does not match a regular expression. - - The regex pattern expected not to match - The string to be inspected - Thrown when the string matches the regex pattern - - - - Verifies that a string does not match a regular expression. - - The regex expected not to match - The string to be inspected - Thrown when the string matches the regex - - - - Verifies that two strings are equivalent. - - The expected string value. - The actual string value. - Thrown when the strings are not equivalent. - - - - Verifies that two strings are equivalent. - - The expected string value. - The actual string value. - If set to true, ignores cases differences. The invariant culture is used. - If set to true, treats \r\n, \r, and \n as equivalent. - If set to true, treats spaces and tabs (in any non-zero quantity) as equivalent. - Thrown when the strings are not equivalent. - - - - Verifies that an object is of the given type or a derived type. - - The type the object should be - The object to be evaluated - The object, casted to type T when successful - Thrown when the object is not the given type - - - - Verifies that an object is of the given type or a derived type. - - The type the object should be - The object to be evaluated - Thrown when the object is not the given type - - - - Verifies that an object is not exactly the given type. - - The type the object should not be - The object to be evaluated - Thrown when the object is the given type - - - - Verifies that an object is not exactly the given type. - - The type the object should not be - The object to be evaluated - Thrown when the object is the given type - - - - Verifies that an object is exactly the given type (and not a derived type). - - The type the object should be - The object to be evaluated - The object, casted to type T when successful - Thrown when the object is not the given type - - - - Verifies that an object is exactly the given type (and not a derived type). - - The type the object should be - The object to be evaluated - Thrown when the object is not the given type - - - - Formats arguments for display in theories. - - - - - Format the value for presentation. - - The value to be formatted. - The formatted value. - - - - Default implementation of used by the xUnit.net range assertions. - - The type that is being compared. - - - - - - - Default implementation of used by the xUnit.net equality assertions. - - The type that is being compared. - - - - Initializes a new instance of the class. - - Set to true to skip type equality checks. - The inner comparer to be used when the compared objects are enumerable. - - - - - - - - - - A class that wraps to create . - - The type that is being compared. - - - - Initializes a new instance of the class. - - The comparer that is being adapted. - - - - - - - - - - Base class for exceptions that have actual and expected values - - - - - Creates a new instance of the class. - - The expected value - The actual value - The user message to be shown - The title to use for the expected value (defaults to "Expected") - The title to use for the actual value (defaults to "Actual") - - - - Gets the actual value. - - - - - Gets the title used for the actual value. - - - - - Gets the expected value. - - - - - Gets the title used for the expected value. - - - - - Gets a message that describes the current exception. Includes the expected and actual values. - - The error message that explains the reason for the exception, or an empty string(""). - 1 - - - - Exception thrown when the collection did not contain exactly the given number element. - - - - - Initializes a new instance of the class. - - The expected number of items in the collection. - The actual number of items in the collection. - - - - Exception thrown when Assert.Collection fails. - - - - - Creates a new instance of the class. - - The expected number of items in the collection. - The actual number of items in the collection. - The index of the position where the first comparison failure occurred. - The exception that was thrown during the comparison failure. - - - - The actual number of items in the collection. - - - - - The expected number of items in the collection. - - - - - The index of the position where the first comparison failure occurred, or -1 if - comparisions did not occur (because the actual and expected counts differed). - - - - - - - - - - - Exception thrown when an All assertion has one or more items fail an assertion. - - - - - Creates a new instance of the class. - - The total number of items that were in the collection. - The list of errors that occurred during the test pass. - - - - The errors that occurred during execution of the test. - - - - - - - - Exception thrown when a collection unexpectedly does not contain the expected value. - - - - - Creates a new instance of the class. - - The expected object value - The actual value - - - - Exception thrown when a collection unexpectedly contains the expected value. - - - - - Creates a new instance of the class. - - The expected object value - The actual value - - - - Exception thrown when a string unexpectedly matches a regular expression. - - - - - Creates a new instance of the class. - - The regular expression pattern expected not to match - The actual value - - - - Exception thrown when a collection is unexpectedly not empty. - - - - - Creates a new instance of the class. - - - - - Exception thrown when a string does not end with the expected value. - - - - - Creates a new instance of the class. - - The expected string value - The actual value - - - - Exception thrown when two values are unexpectedly not equal. - - - - - Creates a new instance of the class. - - The expected object value - The actual object value - - - - Creates a new instance of the class for string comparisons. - - The expected string value - The actual string value - The first index in the expected string where the strings differ - The first index in the actual string where the strings differ - - - - Gets the index into the actual value where the values first differed. - Returns -1 if the difference index points were not provided. - - - - - Gets the index into the expected value where the values first differed. - Returns -1 if the difference index points were not provided. - - - - - - - - Exception thrown when a value is unexpectedly true. - - - - - Creates a new instance of the class. - - The user message to be display, or null for the default message - The actual value - - - - Exception thrown when a value is unexpectedly not in the given range. - - - - - Creates a new instance of the class. - - The actual object value - The low value of the range - The high value of the range - - - - Gets the actual object value - - - - - Gets the high value of the range - - - - - Gets the low value of the range - - - - - Gets a message that describes the current exception. - - The error message that explains the reason for the exception, or an empty string(""). - - - - Exception thrown when the value is unexpectedly not of the given type or a derived type. - - - - - Creates a new instance of the class. - - The expected type - The actual object value - - - - Exception thrown when the value is unexpectedly of the exact given type. - - - - - Creates a new instance of the class. - - The expected type - The actual object value - - - - Exception thrown when the value is unexpectedly not of the exact given type. - - - - - Creates a new instance of the class. - - The expected type name - The actual type name - - - - Exception thrown when a string does not match a regular expression. - - - - - Creates a new instance of the class. - - The expected regular expression pattern - The actual value - - - - Exception thrown when a collection is unexpectedly empty. - - - - - Creates a new instance of the class. - - - - - Exception thrown when two values are unexpectedly equal. - - - - - Creates a new instance of the class. - - - - - Exception thrown when a value is unexpectedly in the given range. - - - - - Creates a new instance of the class. - - The actual object value - The low value of the range - The high value of the range - - - - Gets the actual object value - - - - - Gets the high value of the range - - - - - Gets the low value of the range - - - - - Gets a message that describes the current exception. - - The error message that explains the reason for the exception, or an empty string(""). - - - - Exception thrown when an object is unexpectedly null. - - - - - Creates a new instance of the class. - - - - - Exception thrown when two values are unexpected the same instance. - - - - - Creates a new instance of the class. - - - - - Exception thrown when an object reference is unexpectedly not null. - - - - - Creates a new instance of the class. - - - - - - Exception to be thrown from theory execution when the number of - parameter values does not the test method signature. - - - - - Exception thrown when a set is not a proper subset of another set. - - - - - Creates a new instance of the class. - - - - - Exception thrown when a set is not a proper superset of another set. - - - - - Creates a new instance of the class. - - - - - Exception thrown when code unexpectedly fails change a property. - - - - - Creates a new instance of the class. Call this constructor - when no exception was thrown. - - The name of the property that was expected to be changed. - - - - Exception thrown when two object references are unexpectedly not the same instance. - - - - - Creates a new instance of the class. - - The expected object reference - The actual object reference - - - - Exception thrown when the collection did not contain exactly one element. - - - - - Initializes a new instance of the class. - - The numbers of items in the collection. - - - - Exception thrown when a string does not start with the expected value. - - - - - Creates a new instance of the class. - - The expected string value - The actual value - - - - Exception thrown when a set is not a subset of another set. - - - - - Creates a new instance of the class. - - - - - Exception thrown when a set is not a superset of another set. - - - - - Creates a new instance of the class. - - - - - Exception thrown when code unexpectedly fails to throw an exception. - - - - - Creates a new instance of the class. Call this constructor - when no exception was thrown. - - The type of the exception that was expected - - - - Creates a new instance of the class. Call this constructor - when an exception of the wrong type was thrown. - - The type of the exception that was expected - The actual exception that was thrown - - - - THIS CONSTRUCTOR IS FOR UNIT TESTING PURPOSES ONLY. - - - - - Gets a string representation of the frames on the call stack at the time the current exception was thrown. - - A string that describes the contents of the call stack, with the most recent method call appearing first. - - - - Exception thrown when a value is unexpectedly false. - - - - - Creates a new instance of the class. - - The user message to be displayed, or null for the default message - The actual value - - - - The base assert exception class - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The user message to be displayed - - - - Initializes a new instance of the class. - - The user message to be displayed - The inner exception - - - - Initializes a new instance of the class. - - The user message to be displayed - The stack trace to be displayed - - - - Gets a string representation of the frames on the call stack at the time the current exception was thrown. - - A string that describes the contents of the call stack, with the most recent method call appearing first. - - - - Gets the user message - - - - - - - diff --git a/packages/xunit.assert.2.1.0/xunit.assert.2.1.0.nupkg b/packages/xunit.assert.2.1.0/xunit.assert.2.1.0.nupkg deleted file mode 100644 index eb627db..0000000 Binary files a/packages/xunit.assert.2.1.0/xunit.assert.2.1.0.nupkg and /dev/null differ diff --git a/packages/xunit.core.2.1.0/build/_desktop/xunit.execution.desktop.dll b/packages/xunit.core.2.1.0/build/_desktop/xunit.execution.desktop.dll deleted file mode 100644 index e5ca3bf..0000000 Binary files a/packages/xunit.core.2.1.0/build/_desktop/xunit.execution.desktop.dll and /dev/null differ diff --git a/packages/xunit.core.2.1.0/build/dnx451/_._ b/packages/xunit.core.2.1.0/build/dnx451/_._ deleted file mode 100644 index e69de29..0000000 diff --git a/packages/xunit.core.2.1.0/build/monoandroid/_._ b/packages/xunit.core.2.1.0/build/monoandroid/_._ deleted file mode 100644 index e69de29..0000000 diff --git a/packages/xunit.core.2.1.0/build/monotouch/_._ b/packages/xunit.core.2.1.0/build/monotouch/_._ deleted file mode 100644 index e69de29..0000000 diff --git a/packages/xunit.core.2.1.0/build/net45/_._ b/packages/xunit.core.2.1.0/build/net45/_._ deleted file mode 100644 index e69de29..0000000 diff --git a/packages/xunit.core.2.1.0/build/portable-net45+win8+wp8+wpa81/xunit.core.props b/packages/xunit.core.2.1.0/build/portable-net45+win8+wp8+wpa81/xunit.core.props deleted file mode 100644 index a00a545..0000000 --- a/packages/xunit.core.2.1.0/build/portable-net45+win8+wp8+wpa81/xunit.core.props +++ /dev/null @@ -1,10 +0,0 @@ - - - - - xunit.execution.desktop.dll - PreserveNewest - False - - - \ No newline at end of file diff --git a/packages/xunit.core.2.1.0/build/win8/_._ b/packages/xunit.core.2.1.0/build/win8/_._ deleted file mode 100644 index e69de29..0000000 diff --git a/packages/xunit.core.2.1.0/build/win81/xunit.core.props b/packages/xunit.core.2.1.0/build/win81/xunit.core.props deleted file mode 100644 index a00a545..0000000 --- a/packages/xunit.core.2.1.0/build/win81/xunit.core.props +++ /dev/null @@ -1,10 +0,0 @@ - - - - - xunit.execution.desktop.dll - PreserveNewest - False - - - \ No newline at end of file diff --git a/packages/xunit.core.2.1.0/build/wp8/_._ b/packages/xunit.core.2.1.0/build/wp8/_._ deleted file mode 100644 index e69de29..0000000 diff --git a/packages/xunit.core.2.1.0/build/wpa81/xunit.core.props b/packages/xunit.core.2.1.0/build/wpa81/xunit.core.props deleted file mode 100644 index a00a545..0000000 --- a/packages/xunit.core.2.1.0/build/wpa81/xunit.core.props +++ /dev/null @@ -1,10 +0,0 @@ - - - - - xunit.execution.desktop.dll - PreserveNewest - False - - - \ No newline at end of file diff --git a/packages/xunit.core.2.1.0/build/xamarinios/_._ b/packages/xunit.core.2.1.0/build/xamarinios/_._ deleted file mode 100644 index e69de29..0000000 diff --git a/packages/xunit.core.2.1.0/xunit.core.2.1.0.nupkg b/packages/xunit.core.2.1.0/xunit.core.2.1.0.nupkg deleted file mode 100644 index b646888..0000000 Binary files a/packages/xunit.core.2.1.0/xunit.core.2.1.0.nupkg and /dev/null differ diff --git a/packages/xunit.extensibility.core.2.1.0/lib/dotnet/xunit.core.dll b/packages/xunit.extensibility.core.2.1.0/lib/dotnet/xunit.core.dll deleted file mode 100644 index 7b3a9c1..0000000 Binary files a/packages/xunit.extensibility.core.2.1.0/lib/dotnet/xunit.core.dll and /dev/null differ diff --git a/packages/xunit.extensibility.core.2.1.0/lib/dotnet/xunit.core.dll.tdnet b/packages/xunit.extensibility.core.2.1.0/lib/dotnet/xunit.core.dll.tdnet deleted file mode 100644 index 4d8afc8..0000000 --- a/packages/xunit.extensibility.core.2.1.0/lib/dotnet/xunit.core.dll.tdnet +++ /dev/null @@ -1,5 +0,0 @@ - - xUnit.net {0}.{1}.{2} build {3} - xunit.runner.tdnet.dll - Xunit.Runner.TdNet.TdNetRunner - \ No newline at end of file diff --git a/packages/xunit.extensibility.core.2.1.0/lib/dotnet/xunit.core.xml b/packages/xunit.extensibility.core.2.1.0/lib/dotnet/xunit.core.xml deleted file mode 100644 index 8bd3ce5..0000000 --- a/packages/xunit.extensibility.core.2.1.0/lib/dotnet/xunit.core.xml +++ /dev/null @@ -1,1001 +0,0 @@ - - - - xunit.core - - - - - Rethrows an exception object without losing the existing stack trace information - - The exception to re-throw. - - For more information on this technique, see - http://www.dotnetjunkies.com/WebLog/chris.taylor/archive/2004/03/03/8353.aspx. - The remote_stack_trace string is here to support Mono. - - - - - Unwraps an exception to remove any wrappers, like . - - The exception to unwrap. - The unwrapped exception. - - - - Guard class, used for guard clauses and argument validation - - - - - - - - - - - - - - Indicates the default display name format for test methods. - - - - - Use a fully qualified name (namespace + class + method) - - - - - Use just the method name (without class) - - - - - Formats arguments for display in theories. - - - - - Format the value for presentation. - - The value to be formatted. - The formatted value. - - - - Default implementation of used by the xUnit.net equality assertions. - - The type that is being compared. - - - - Initializes a new instance of the class. - - Set to true to skip type equality checks. - The inner comparer to be used when the compared objects are enumerable. - - - - - - - - - - A class that wraps to create . - - The type that is being compared. - - - - Initializes a new instance of the class. - - The comparer that is being adapted. - - - - - - - - - - Base attribute which indicates a test method interception (allows code to be run before and - after the test is run). - - - - - This method is called after the test method is executed. - - The method under test - - - - This method is called before the test method is executed. - - The method under test - - - - Abstract attribute which represents a data source for a data theory. - Data source providers derive from this attribute and implement GetData - to return the data for the theory. - - - - - Returns the data to be used to test the theory. - - The method that is being tested - One or more sets of theory data. Each invocation of the test method - is represented by a single object array. - - - - Implementation of for discovering . - - - - - - - - Default implementation of . Uses reflection to find the - data associated with ; may return null when called - without reflection-based abstraction implementations. - - - - - - - - - - - An attribute used to decorate classes which derive from , - to indicate how data elements should be discovered. - - - - - Initializes an instance of . - - The fully qualified type name of the discoverer - (f.e., 'Xunit.Sdk.DataDiscoverer') - The name of the assembly that the discoverer type - is located in, without file extension (f.e., 'xunit.execution') - - - - Aggregates exceptions. Intended to run one or more code blocks, and collect the - exceptions thrown by those code blocks. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class that - contains the exception list of its parent. - - The parent aggregator to copy exceptions from. - - - - Returns true if the aggregator has at least one exception inside it. - - - - - Adds an exception to the aggregator. - - The exception to be added. - - - - Adds exceptions from another aggregator into this aggregator. - - The aggregator whose exceptions should be copied. - - - - Clears the aggregator. - - - - - Runs the code, catching the exception that is thrown and adding it to - the aggregate. - - The code to be run. - - - - Runs the code, catching the exception that is thrown and adding it to - the aggregate. - - The code to be run. - - - - Runs the code, catching the exception that is thrown and adding it to - the aggregate. - - The code to be run. - - - - Returns an exception that represents the exceptions thrown by the code - passed to the or method. - - Returns null if no exceptions were thrown; returns the - exact exception is a single exception was thrown; returns - if more than one exception was thrown. - - - - This class is responsible for discovering the data available in an implementation - of . The discovery process may not always have access - to reflection (i.e., running in Resharper), so the discoverer must make a best - effort to return data, but may return null when there is not enough information - available (for example, if reflection is required to answer the question). - - - - - Returns the data to be used to test the theory. - - - This will be called during - discovery, at which point the may or may not - be backed by reflection (i.e., implementing ). - If the data is not available because reflection is required, then you may return - null to inform xUnit that the quantity of data is unknown at this point. - When the tests are run, if you returned back null during discovery, then this method - will be called again to retrieve the data, this time guaranteed to provide - an implementation of . At this time, you - must return the actual data, and returning null is not legal. - - The data attribute being discovered - The method that is being tested/discovered - The theory data (or null during discovery, if not enough - information is available to enumerate the data) - - - - Returns true if the data attribute supports enumeration during - discovery; false otherwise. Data attributes with expensive computational - costs and/or randomized data sets should return false. - - - - - Used by discovery, execution, and extensibility code to send messages to the runner. - - - - - Queues a message to be sent to the runner. - - The message to be sent to the runner - - Returns true if discovery/execution should continue; false, otherwise. - The return value may be safely ignored by components which are not directly responsible - for discovery or execution, and this is intended to communicate to those sub-systems that - that they should short circuit and stop their work as quickly as is reasonable. - - - - - Implementation of used to discover the data - provided by . - - - - - - - - - - - A class implements this interface to participate in ordering tests - for the test runner. Test case orderers are applied using the - , which can be applied at - the assembly, test collection, and test class level. - - - - - Orders test cases for execution. - - The test cases to be ordered. - The test cases in the order to be run. - - - - Marker interface that must be implemented by test framework attributes, so - that the test framework attribute discoverer can find them. - - - - - Interface to be implemented by classes which are used to discover the test framework. - - - - - Gets the type that implements to be used to discover - and run tests. - - The test framework attribute that decorated the assembly - The test framework type - - - - Marker interface used by attributes which provide trait data. - - - - - This interface is implemented by discoverers that provide trait values to - xUnit.net v2 tests. - - - - - Gets the trait values from the trait attribute. - - The trait attribute containing the trait values. - The trait values. - - - - Interface to be implemented by classes which are used to discover tests cases attached - to test methods that are attributed with (or a subclass). - - - - - Discover test cases from a test method. - - The discovery options to be used. - The test method the test cases belong to. - The fact attribute attached to the test method. - Returns zero or more test cases represented by the test method. - - - - Represents a single test case from xUnit.net v2. - - - - - Gets the method to be run. Differs from . in that - any generic argument types will have been closed based on the arguments. - - - - - Executes the test case, returning 0 or more result messages through the message sink. - - The message sink used to send diagnostic messages to. - The message bus to report results to. - The arguments to pass to the constructor. - The error aggregator to use for catching exception. - The cancellation token source that indicates whether cancellation has been requested. - Returns the summary of the test case run. - - - - This interface is intended to be implemented by components which generate test collections. - End users specify the desired test collection factory by applying - at the assembly level. Classes which implement this interface must have a constructor - that takes and . - - - - - Gets the display name for the test collection factory. This information is shown to the end - user as part of the description of the test environment. - - - - - Gets the test collection for a given test class. - - The test class. - The test collection. - - - - Marks an assembly as a platform specific assembly for use with xUnit.net. Type references from - such assemblies are allowed to use a special suffix ("My.Assembly.{Platform}"), which will - automatically be translated into the correct platform-specific name ("My.Assembly.desktop", - "My.Assembly.win8", etc.). This affects both extensibility points which require specifying - a string-based type name and assembly, as well as serialization. - - In v2.1 and later, the supported platform target names include: - - "desktop" (for desktop and PCL tests), - "dotnet" (everything else). - - In v2.0, the following names were also supported: - - "iOS-Universal" (for Xamarin test projects targeting iOS), - "MonoAndroid" (for Xamarin MonoAndroid tests), - "MonoTouch" (for Xamarin MonoTouch tests), - "universal" (for Windows Phone 8.1 and Windows 8.1 tests), - "win8" (for Windows 8 tests), - "wp8" (for Windows Phone 8 Silverlight tests). - - For backward compatibility reasons, the v2.1 runners will support tests linked against - the v2.0 execution libraries. - - Note that file names may be case sensitive (when running on platforms with case sensitive - file systems like Linux), so ensure that your assembly file name casing is consistent, and - that you use the suffixes here with the exact case shown. - - - - - Represents the statistical summary from a run of one or more tests. - - - - - The total number of tests run. - - - - - The number of failed tests. - - - - - The number of skipped tests. - - - - - The total time taken to run the tests, in seconds. - - - - - Adds a run summary's totals into this run summary. - - The run summary to be added. - - - - Decorates an implementation of that is used to - determine which test framework is used to discover and run tests. - - - - - Initializes an instance of . - - The fully qualified type name of the discoverer - (f.e., 'Xunit.Sdk.DataDiscoverer') - The name of the assembly that the discoverer type - is located in, without file extension (f.e., 'xunit.execution') - - - - An attribute used to decorate classes which derive from , - to indicate how test cases should be discovered. - - - - - Initializes an instance of the class. - - The fully qualified type name of the discoverer - (f.e., 'Xunit.Sdk.FactDiscoverer') - The name of the assembly that the discoverer type - is located in, without file extension (f.e., 'xunit.execution') - - - - The implementation of which returns the trait values - for . - - - - - - - - An attribute used to decorate classes which implement , - to indicate how trait values should be discovered. The discoverer type must implement - . - - - - - Initializes an instance of . - - The fully qualified type name of the discoverer - (f.e., 'Xunit.Sdk.TraitDiscoverer') - The name of the assembly that the discoverer type - is located in, without file extension (f.e., 'xunit.execution') - - - - Provides a data source for a data theory, with the data coming from a class - which must implement IEnumerable<object[]>. - - - - - Initializes a new instance of the class. - - The class that provides the data. - - - - Gets the type of the class that provides the data. - - - - - - - - Used to declare a specific test collection for a test class. - - - - - Initializes a new instance of the class. - - The test collection name. - - - - Defines the built-in behavior types for collections in xUnit.net. - - - - - By default, generates a collection per assembly, and any test classes that are not - decorated with will be placed into the assembly-level - collection. - - - - - By default, generates a collection per test class for any test classes that are not - decorated with . - - - - - Used to declare a the default test collection behavior for the assembly. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The collection behavior for the assembly. - - - - Initializes a new instance of the class. - - The type name of the test collection factory (that implements ). - The assembly that exists in. - - - - Determines whether tests in this assembly are run in parallel. - - - - - Determines how many tests can run in parallel with each other. If set to 0, the system will - use . If set to a negative number, then there will - be no limit to the number of threads. - - - - - Used to declare a test collection container class. The container class gives - developers a place to attach interfaces like and - that will be applied to all tests classes - that are members of the test collection. - - - - - Initializes a new instance of the class. - - The test collection name. - - - - Attribute that is applied to a method to indicate that it is a fact that should be run - by the test runner. It can also be extended to support a customized definition of a - test method. - - - - - Gets the name of the test to be used when the test is skipped. Defaults to - null, which will cause the fully qualified test name to be used. - - - - - Marks the test so that it will not be run, and gets or sets the skip reason - - - - - Used to provide asynchronous lifetime functionality. Currently supported: - - Test classes - - Classes used in - - Classes used in . - - - - - Called immediately after the class has been created, before it is used. - - - - - Called when an object is no longer needed. Called just before - if the class also implements that. - - - - - Used to decorate xUnit.net test classes and collections to indicate a test which has - per-test-class fixture data. An instance of the fixture data is initialized just before - the first test in the class is run, and if it implements IDisposable, is disposed - after the last test in the class is run. To gain access to the fixture data from - inside the test, a constructor argument should be added to the test class which - exactly matches the . Class fixtures must have a - single parameterless constructor, and may take collection fixture types as constructor - arguments. - - The type of the fixture. - - If asynchronous setup of is required - it should implement the interface. - - - - - Used to decorate xUnit.net test classes and collections to indicate a test which has - per-test-collection fixture data. An instance of the fixture data is initialized just before - the first test in the collection is run, and if it implements IDisposable, is disposed - after the last test in the collection is run. To gain access to the fixture data from - inside the test, a constructor argument should be added to the test class which - exactly matches the . - - The type of the fixture. - - If asynchronous setup of is required - it should implement the interface. - - - - - Provides a data source for a data theory, with the data coming from inline values. - - - - - Initializes a new instance of the class. - - The data values to pass to the theory. - - - - - - - A class implements this interface to participate in ordering tests - for the test runner. Test collection orderers are applied using the - , which can be applied at - the assembly level. - - - - - Orders test collections for execution. - - The test collections to be ordered. - The test collections in the order to be run. - - - - Provides a data source for a data theory, with the data coming from one of the following sources: - 1. A static property - 2. A static field - 3. A static method (with parameters) - The member must return something compatible with IEnumerable<object[]> with the test data. - - - - - Initializes a new instance of the class. - - The name of the public static member on the test class that will provide the test data - The parameters for the member (only supported for methods; ignored for everything else) - - - - - - - Provides a base class for attributes that will provide member data. The member data must return - something compatible with . - - - - - Initializes a new instance of the class. - - The name of the public static member on the test class that will provide the test data - The parameters for the member (only supported for methods; ignored for everything else) - - - - Returns true if the data attribute wants to skip enumerating data during discovery. - This will cause the theory to yield a single test case for all data, and the data discovery - will be during test execution instead of discovery. - - - - - Gets the member name. - - - - - Gets or sets the type to retrieve the member from. If not set, then the property will be - retrieved from the unit test class. - - - - - Gets or sets the parameters passed to the member. Only supported for static methods. - - - - - - - - Converts an item yielded by the data member to an object array, for return from . - - The method that is being tested. - An item yielded from the data member. - An suitable for return from . - - - - - - - - - - - - - Allows the user to record actions for a test. - - - - - Records any exception which is thrown by the given code. - - The code which may thrown an exception. - Returns the exception that was thrown by the code; null, otherwise. - - - - Records any exception which is thrown by the given code that has - a return value. Generally used for testing property accessors. - - The code which may thrown an exception. - Returns the exception that was thrown by the code; null, otherwise. - - - - - - - Records any exception which is thrown by the given task. - - The task which may thrown an exception. - Returns the exception that was thrown by the code; null, otherwise. - - - - - - - Used to decorate an assembly to allow the use a custom . - - - - - Initializes a new instance of the class. - - The type name of the orderer class (that implements ). - The assembly that exists in. - - - - Used to decorate an assembly, test collection, or test class to allow - the use a custom . - - - - - Initializes a new instance of the class. - - The type name of the orderer class (that implements ). - The assembly that exists in. - - - - Used to decorate an assembly to allow the use a custom . - - - - - Initializes an instance of . - - The fully qualified type name of the test framework - (f.e., 'Xunit.Sdk.XunitTestFramework') - The name of the assembly that the test framework type - is located in, without file extension (f.e., 'xunit.execution') - - - - Marks a test method as being a data theory. Data theories are tests which are fed - various bits of data from a data source, mapping to parameters on the test method. - If the data source contains multiple rows, then the test method is executed - multiple times (once with each data row). Data is provided by attributes which - derive from (notably, and - ). - - - - - Provides data for theories based on collection initialization syntax. - - - - - Adds a row to the theory. - - The values to be added. - - - - - - - - - - Represents a set of data for a theory with a single parameter. Data can - be added to the data set using the collection initializer syntax. - - The parameter type. - - - - Adds data to the theory data set. - - The data value. - - - - Represents a set of data for a theory with 2 parameters. Data can - be added to the data set using the collection initializer syntax. - - The first parameter type. - The second parameter type. - - - - Adds data to the theory data set. - - The first data value. - The second data value. - - - - Represents a set of data for a theory with 3 parameters. Data can - be added to the data set using the collection initializer syntax. - - The first parameter type. - The second parameter type. - The third parameter type. - - - - Adds data to the theory data set. - - The first data value. - The second data value. - The third data value. - - - - Represents a set of data for a theory with 3 parameters. Data can - be added to the data set using the collection initializer syntax. - - The first parameter type. - The second parameter type. - The third parameter type. - The fourth parameter type. - - - - Adds data to the theory data set. - - The first data value. - The second data value. - The third data value. - The fourth data value. - - - - Represents a set of data for a theory with 3 parameters. Data can - be added to the data set using the collection initializer syntax. - - The first parameter type. - The second parameter type. - The third parameter type. - The fourth parameter type. - The fifth parameter type. - - - - Adds data to the theory data set. - - The first data value. - The second data value. - The third data value. - The fourth data value. - The fifth data value. - - - - Attribute used to decorate a test method with arbitrary name/value pairs ("traits"). - - - - - Creates a new instance of the class. - - The trait name - The trait value - - - diff --git a/packages/xunit.extensibility.core.2.1.0/lib/dotnet/xunit.runner.tdnet.dll b/packages/xunit.extensibility.core.2.1.0/lib/dotnet/xunit.runner.tdnet.dll deleted file mode 100644 index d844b91..0000000 Binary files a/packages/xunit.extensibility.core.2.1.0/lib/dotnet/xunit.runner.tdnet.dll and /dev/null differ diff --git a/packages/xunit.extensibility.core.2.1.0/lib/dotnet/xunit.runner.utility.desktop.dll b/packages/xunit.extensibility.core.2.1.0/lib/dotnet/xunit.runner.utility.desktop.dll deleted file mode 100644 index fc88513..0000000 Binary files a/packages/xunit.extensibility.core.2.1.0/lib/dotnet/xunit.runner.utility.desktop.dll and /dev/null differ diff --git a/packages/xunit.extensibility.core.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.core.dll b/packages/xunit.extensibility.core.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.core.dll deleted file mode 100644 index 7b3a9c1..0000000 Binary files a/packages/xunit.extensibility.core.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.core.dll and /dev/null differ diff --git a/packages/xunit.extensibility.core.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.core.dll.tdnet b/packages/xunit.extensibility.core.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.core.dll.tdnet deleted file mode 100644 index 4d8afc8..0000000 --- a/packages/xunit.extensibility.core.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.core.dll.tdnet +++ /dev/null @@ -1,5 +0,0 @@ - - xUnit.net {0}.{1}.{2} build {3} - xunit.runner.tdnet.dll - Xunit.Runner.TdNet.TdNetRunner - \ No newline at end of file diff --git a/packages/xunit.extensibility.core.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.core.xml b/packages/xunit.extensibility.core.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.core.xml deleted file mode 100644 index 8bd3ce5..0000000 --- a/packages/xunit.extensibility.core.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.core.xml +++ /dev/null @@ -1,1001 +0,0 @@ - - - - xunit.core - - - - - Rethrows an exception object without losing the existing stack trace information - - The exception to re-throw. - - For more information on this technique, see - http://www.dotnetjunkies.com/WebLog/chris.taylor/archive/2004/03/03/8353.aspx. - The remote_stack_trace string is here to support Mono. - - - - - Unwraps an exception to remove any wrappers, like . - - The exception to unwrap. - The unwrapped exception. - - - - Guard class, used for guard clauses and argument validation - - - - - - - - - - - - - - Indicates the default display name format for test methods. - - - - - Use a fully qualified name (namespace + class + method) - - - - - Use just the method name (without class) - - - - - Formats arguments for display in theories. - - - - - Format the value for presentation. - - The value to be formatted. - The formatted value. - - - - Default implementation of used by the xUnit.net equality assertions. - - The type that is being compared. - - - - Initializes a new instance of the class. - - Set to true to skip type equality checks. - The inner comparer to be used when the compared objects are enumerable. - - - - - - - - - - A class that wraps to create . - - The type that is being compared. - - - - Initializes a new instance of the class. - - The comparer that is being adapted. - - - - - - - - - - Base attribute which indicates a test method interception (allows code to be run before and - after the test is run). - - - - - This method is called after the test method is executed. - - The method under test - - - - This method is called before the test method is executed. - - The method under test - - - - Abstract attribute which represents a data source for a data theory. - Data source providers derive from this attribute and implement GetData - to return the data for the theory. - - - - - Returns the data to be used to test the theory. - - The method that is being tested - One or more sets of theory data. Each invocation of the test method - is represented by a single object array. - - - - Implementation of for discovering . - - - - - - - - Default implementation of . Uses reflection to find the - data associated with ; may return null when called - without reflection-based abstraction implementations. - - - - - - - - - - - An attribute used to decorate classes which derive from , - to indicate how data elements should be discovered. - - - - - Initializes an instance of . - - The fully qualified type name of the discoverer - (f.e., 'Xunit.Sdk.DataDiscoverer') - The name of the assembly that the discoverer type - is located in, without file extension (f.e., 'xunit.execution') - - - - Aggregates exceptions. Intended to run one or more code blocks, and collect the - exceptions thrown by those code blocks. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class that - contains the exception list of its parent. - - The parent aggregator to copy exceptions from. - - - - Returns true if the aggregator has at least one exception inside it. - - - - - Adds an exception to the aggregator. - - The exception to be added. - - - - Adds exceptions from another aggregator into this aggregator. - - The aggregator whose exceptions should be copied. - - - - Clears the aggregator. - - - - - Runs the code, catching the exception that is thrown and adding it to - the aggregate. - - The code to be run. - - - - Runs the code, catching the exception that is thrown and adding it to - the aggregate. - - The code to be run. - - - - Runs the code, catching the exception that is thrown and adding it to - the aggregate. - - The code to be run. - - - - Returns an exception that represents the exceptions thrown by the code - passed to the or method. - - Returns null if no exceptions were thrown; returns the - exact exception is a single exception was thrown; returns - if more than one exception was thrown. - - - - This class is responsible for discovering the data available in an implementation - of . The discovery process may not always have access - to reflection (i.e., running in Resharper), so the discoverer must make a best - effort to return data, but may return null when there is not enough information - available (for example, if reflection is required to answer the question). - - - - - Returns the data to be used to test the theory. - - - This will be called during - discovery, at which point the may or may not - be backed by reflection (i.e., implementing ). - If the data is not available because reflection is required, then you may return - null to inform xUnit that the quantity of data is unknown at this point. - When the tests are run, if you returned back null during discovery, then this method - will be called again to retrieve the data, this time guaranteed to provide - an implementation of . At this time, you - must return the actual data, and returning null is not legal. - - The data attribute being discovered - The method that is being tested/discovered - The theory data (or null during discovery, if not enough - information is available to enumerate the data) - - - - Returns true if the data attribute supports enumeration during - discovery; false otherwise. Data attributes with expensive computational - costs and/or randomized data sets should return false. - - - - - Used by discovery, execution, and extensibility code to send messages to the runner. - - - - - Queues a message to be sent to the runner. - - The message to be sent to the runner - - Returns true if discovery/execution should continue; false, otherwise. - The return value may be safely ignored by components which are not directly responsible - for discovery or execution, and this is intended to communicate to those sub-systems that - that they should short circuit and stop their work as quickly as is reasonable. - - - - - Implementation of used to discover the data - provided by . - - - - - - - - - - - A class implements this interface to participate in ordering tests - for the test runner. Test case orderers are applied using the - , which can be applied at - the assembly, test collection, and test class level. - - - - - Orders test cases for execution. - - The test cases to be ordered. - The test cases in the order to be run. - - - - Marker interface that must be implemented by test framework attributes, so - that the test framework attribute discoverer can find them. - - - - - Interface to be implemented by classes which are used to discover the test framework. - - - - - Gets the type that implements to be used to discover - and run tests. - - The test framework attribute that decorated the assembly - The test framework type - - - - Marker interface used by attributes which provide trait data. - - - - - This interface is implemented by discoverers that provide trait values to - xUnit.net v2 tests. - - - - - Gets the trait values from the trait attribute. - - The trait attribute containing the trait values. - The trait values. - - - - Interface to be implemented by classes which are used to discover tests cases attached - to test methods that are attributed with (or a subclass). - - - - - Discover test cases from a test method. - - The discovery options to be used. - The test method the test cases belong to. - The fact attribute attached to the test method. - Returns zero or more test cases represented by the test method. - - - - Represents a single test case from xUnit.net v2. - - - - - Gets the method to be run. Differs from . in that - any generic argument types will have been closed based on the arguments. - - - - - Executes the test case, returning 0 or more result messages through the message sink. - - The message sink used to send diagnostic messages to. - The message bus to report results to. - The arguments to pass to the constructor. - The error aggregator to use for catching exception. - The cancellation token source that indicates whether cancellation has been requested. - Returns the summary of the test case run. - - - - This interface is intended to be implemented by components which generate test collections. - End users specify the desired test collection factory by applying - at the assembly level. Classes which implement this interface must have a constructor - that takes and . - - - - - Gets the display name for the test collection factory. This information is shown to the end - user as part of the description of the test environment. - - - - - Gets the test collection for a given test class. - - The test class. - The test collection. - - - - Marks an assembly as a platform specific assembly for use with xUnit.net. Type references from - such assemblies are allowed to use a special suffix ("My.Assembly.{Platform}"), which will - automatically be translated into the correct platform-specific name ("My.Assembly.desktop", - "My.Assembly.win8", etc.). This affects both extensibility points which require specifying - a string-based type name and assembly, as well as serialization. - - In v2.1 and later, the supported platform target names include: - - "desktop" (for desktop and PCL tests), - "dotnet" (everything else). - - In v2.0, the following names were also supported: - - "iOS-Universal" (for Xamarin test projects targeting iOS), - "MonoAndroid" (for Xamarin MonoAndroid tests), - "MonoTouch" (for Xamarin MonoTouch tests), - "universal" (for Windows Phone 8.1 and Windows 8.1 tests), - "win8" (for Windows 8 tests), - "wp8" (for Windows Phone 8 Silverlight tests). - - For backward compatibility reasons, the v2.1 runners will support tests linked against - the v2.0 execution libraries. - - Note that file names may be case sensitive (when running on platforms with case sensitive - file systems like Linux), so ensure that your assembly file name casing is consistent, and - that you use the suffixes here with the exact case shown. - - - - - Represents the statistical summary from a run of one or more tests. - - - - - The total number of tests run. - - - - - The number of failed tests. - - - - - The number of skipped tests. - - - - - The total time taken to run the tests, in seconds. - - - - - Adds a run summary's totals into this run summary. - - The run summary to be added. - - - - Decorates an implementation of that is used to - determine which test framework is used to discover and run tests. - - - - - Initializes an instance of . - - The fully qualified type name of the discoverer - (f.e., 'Xunit.Sdk.DataDiscoverer') - The name of the assembly that the discoverer type - is located in, without file extension (f.e., 'xunit.execution') - - - - An attribute used to decorate classes which derive from , - to indicate how test cases should be discovered. - - - - - Initializes an instance of the class. - - The fully qualified type name of the discoverer - (f.e., 'Xunit.Sdk.FactDiscoverer') - The name of the assembly that the discoverer type - is located in, without file extension (f.e., 'xunit.execution') - - - - The implementation of which returns the trait values - for . - - - - - - - - An attribute used to decorate classes which implement , - to indicate how trait values should be discovered. The discoverer type must implement - . - - - - - Initializes an instance of . - - The fully qualified type name of the discoverer - (f.e., 'Xunit.Sdk.TraitDiscoverer') - The name of the assembly that the discoverer type - is located in, without file extension (f.e., 'xunit.execution') - - - - Provides a data source for a data theory, with the data coming from a class - which must implement IEnumerable<object[]>. - - - - - Initializes a new instance of the class. - - The class that provides the data. - - - - Gets the type of the class that provides the data. - - - - - - - - Used to declare a specific test collection for a test class. - - - - - Initializes a new instance of the class. - - The test collection name. - - - - Defines the built-in behavior types for collections in xUnit.net. - - - - - By default, generates a collection per assembly, and any test classes that are not - decorated with will be placed into the assembly-level - collection. - - - - - By default, generates a collection per test class for any test classes that are not - decorated with . - - - - - Used to declare a the default test collection behavior for the assembly. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The collection behavior for the assembly. - - - - Initializes a new instance of the class. - - The type name of the test collection factory (that implements ). - The assembly that exists in. - - - - Determines whether tests in this assembly are run in parallel. - - - - - Determines how many tests can run in parallel with each other. If set to 0, the system will - use . If set to a negative number, then there will - be no limit to the number of threads. - - - - - Used to declare a test collection container class. The container class gives - developers a place to attach interfaces like and - that will be applied to all tests classes - that are members of the test collection. - - - - - Initializes a new instance of the class. - - The test collection name. - - - - Attribute that is applied to a method to indicate that it is a fact that should be run - by the test runner. It can also be extended to support a customized definition of a - test method. - - - - - Gets the name of the test to be used when the test is skipped. Defaults to - null, which will cause the fully qualified test name to be used. - - - - - Marks the test so that it will not be run, and gets or sets the skip reason - - - - - Used to provide asynchronous lifetime functionality. Currently supported: - - Test classes - - Classes used in - - Classes used in . - - - - - Called immediately after the class has been created, before it is used. - - - - - Called when an object is no longer needed. Called just before - if the class also implements that. - - - - - Used to decorate xUnit.net test classes and collections to indicate a test which has - per-test-class fixture data. An instance of the fixture data is initialized just before - the first test in the class is run, and if it implements IDisposable, is disposed - after the last test in the class is run. To gain access to the fixture data from - inside the test, a constructor argument should be added to the test class which - exactly matches the . Class fixtures must have a - single parameterless constructor, and may take collection fixture types as constructor - arguments. - - The type of the fixture. - - If asynchronous setup of is required - it should implement the interface. - - - - - Used to decorate xUnit.net test classes and collections to indicate a test which has - per-test-collection fixture data. An instance of the fixture data is initialized just before - the first test in the collection is run, and if it implements IDisposable, is disposed - after the last test in the collection is run. To gain access to the fixture data from - inside the test, a constructor argument should be added to the test class which - exactly matches the . - - The type of the fixture. - - If asynchronous setup of is required - it should implement the interface. - - - - - Provides a data source for a data theory, with the data coming from inline values. - - - - - Initializes a new instance of the class. - - The data values to pass to the theory. - - - - - - - A class implements this interface to participate in ordering tests - for the test runner. Test collection orderers are applied using the - , which can be applied at - the assembly level. - - - - - Orders test collections for execution. - - The test collections to be ordered. - The test collections in the order to be run. - - - - Provides a data source for a data theory, with the data coming from one of the following sources: - 1. A static property - 2. A static field - 3. A static method (with parameters) - The member must return something compatible with IEnumerable<object[]> with the test data. - - - - - Initializes a new instance of the class. - - The name of the public static member on the test class that will provide the test data - The parameters for the member (only supported for methods; ignored for everything else) - - - - - - - Provides a base class for attributes that will provide member data. The member data must return - something compatible with . - - - - - Initializes a new instance of the class. - - The name of the public static member on the test class that will provide the test data - The parameters for the member (only supported for methods; ignored for everything else) - - - - Returns true if the data attribute wants to skip enumerating data during discovery. - This will cause the theory to yield a single test case for all data, and the data discovery - will be during test execution instead of discovery. - - - - - Gets the member name. - - - - - Gets or sets the type to retrieve the member from. If not set, then the property will be - retrieved from the unit test class. - - - - - Gets or sets the parameters passed to the member. Only supported for static methods. - - - - - - - - Converts an item yielded by the data member to an object array, for return from . - - The method that is being tested. - An item yielded from the data member. - An suitable for return from . - - - - - - - - - - - - - Allows the user to record actions for a test. - - - - - Records any exception which is thrown by the given code. - - The code which may thrown an exception. - Returns the exception that was thrown by the code; null, otherwise. - - - - Records any exception which is thrown by the given code that has - a return value. Generally used for testing property accessors. - - The code which may thrown an exception. - Returns the exception that was thrown by the code; null, otherwise. - - - - - - - Records any exception which is thrown by the given task. - - The task which may thrown an exception. - Returns the exception that was thrown by the code; null, otherwise. - - - - - - - Used to decorate an assembly to allow the use a custom . - - - - - Initializes a new instance of the class. - - The type name of the orderer class (that implements ). - The assembly that exists in. - - - - Used to decorate an assembly, test collection, or test class to allow - the use a custom . - - - - - Initializes a new instance of the class. - - The type name of the orderer class (that implements ). - The assembly that exists in. - - - - Used to decorate an assembly to allow the use a custom . - - - - - Initializes an instance of . - - The fully qualified type name of the test framework - (f.e., 'Xunit.Sdk.XunitTestFramework') - The name of the assembly that the test framework type - is located in, without file extension (f.e., 'xunit.execution') - - - - Marks a test method as being a data theory. Data theories are tests which are fed - various bits of data from a data source, mapping to parameters on the test method. - If the data source contains multiple rows, then the test method is executed - multiple times (once with each data row). Data is provided by attributes which - derive from (notably, and - ). - - - - - Provides data for theories based on collection initialization syntax. - - - - - Adds a row to the theory. - - The values to be added. - - - - - - - - - - Represents a set of data for a theory with a single parameter. Data can - be added to the data set using the collection initializer syntax. - - The parameter type. - - - - Adds data to the theory data set. - - The data value. - - - - Represents a set of data for a theory with 2 parameters. Data can - be added to the data set using the collection initializer syntax. - - The first parameter type. - The second parameter type. - - - - Adds data to the theory data set. - - The first data value. - The second data value. - - - - Represents a set of data for a theory with 3 parameters. Data can - be added to the data set using the collection initializer syntax. - - The first parameter type. - The second parameter type. - The third parameter type. - - - - Adds data to the theory data set. - - The first data value. - The second data value. - The third data value. - - - - Represents a set of data for a theory with 3 parameters. Data can - be added to the data set using the collection initializer syntax. - - The first parameter type. - The second parameter type. - The third parameter type. - The fourth parameter type. - - - - Adds data to the theory data set. - - The first data value. - The second data value. - The third data value. - The fourth data value. - - - - Represents a set of data for a theory with 3 parameters. Data can - be added to the data set using the collection initializer syntax. - - The first parameter type. - The second parameter type. - The third parameter type. - The fourth parameter type. - The fifth parameter type. - - - - Adds data to the theory data set. - - The first data value. - The second data value. - The third data value. - The fourth data value. - The fifth data value. - - - - Attribute used to decorate a test method with arbitrary name/value pairs ("traits"). - - - - - Creates a new instance of the class. - - The trait name - The trait value - - - diff --git a/packages/xunit.extensibility.core.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.runner.tdnet.dll b/packages/xunit.extensibility.core.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.runner.tdnet.dll deleted file mode 100644 index d844b91..0000000 Binary files a/packages/xunit.extensibility.core.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.runner.tdnet.dll and /dev/null differ diff --git a/packages/xunit.extensibility.core.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.runner.utility.desktop.dll b/packages/xunit.extensibility.core.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.runner.utility.desktop.dll deleted file mode 100644 index fc88513..0000000 Binary files a/packages/xunit.extensibility.core.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.runner.utility.desktop.dll and /dev/null differ diff --git a/packages/xunit.extensibility.core.2.1.0/xunit.extensibility.core.2.1.0.nupkg b/packages/xunit.extensibility.core.2.1.0/xunit.extensibility.core.2.1.0.nupkg deleted file mode 100644 index 2c8eacd..0000000 Binary files a/packages/xunit.extensibility.core.2.1.0/xunit.extensibility.core.2.1.0.nupkg and /dev/null differ diff --git a/packages/xunit.extensibility.execution.2.1.0/lib/dnx451/xunit.execution.dotnet.dll b/packages/xunit.extensibility.execution.2.1.0/lib/dnx451/xunit.execution.dotnet.dll deleted file mode 100644 index 3c43440..0000000 Binary files a/packages/xunit.extensibility.execution.2.1.0/lib/dnx451/xunit.execution.dotnet.dll and /dev/null differ diff --git a/packages/xunit.extensibility.execution.2.1.0/lib/dnx451/xunit.execution.dotnet.xml b/packages/xunit.extensibility.execution.2.1.0/lib/dnx451/xunit.execution.dotnet.xml deleted file mode 100644 index d819501..0000000 --- a/packages/xunit.extensibility.execution.2.1.0/lib/dnx451/xunit.execution.dotnet.xml +++ /dev/null @@ -1,4157 +0,0 @@ - - - - xunit.execution.dotnet - - - - - Rethrows an exception object without losing the existing stack trace information - - The exception to re-throw. - - For more information on this technique, see - http://www.dotnetjunkies.com/WebLog/chris.taylor/archive/2004/03/03/8353.aspx. - The remote_stack_trace string is here to support Mono. - - - - - Unwraps an exception to remove any wrappers, like . - - The exception to unwrap. - The unwrapped exception. - - - - Utility classes for dealing with Exception objects. - - - - - Combines multiple levels of messages into a single message. - - The failure information from which to get the messages. - The combined string. - - - - Combines multiple levels of stack traces into a single stack trace. - - The failure information from which to get the stack traces. - The combined string. - - - - Unwraps exceptions and their inner exceptions. - - The exception to be converted. - The failure information. - - - - An implementation of that ignores all messages. - - - - - - - - Serializes and de-serializes objects - - - - - De-serializes an object. - - The type of the object - The object's serialized value - The de-serialized object - - - - Serializes an object. - - The value to serialize - The serialized value - - - Gets whether the specified is serializable with . - The object to test for serializability. - true if the object can be serialized; otherwise, false. - - - - Converts an assembly qualified type name into a object. - - The assembly qualified type name. - The instance of the , if available; null, otherwise. - - - - Converts an assembly name + type name into a object. - - The assembly name. - The type name. - The instance of the , if available; null, otherwise. - - - - Gets an assembly qualified type name for serialization, with special dispensation for types which - originate in the execution assembly. - - - - - Retrieves a substring from the string, with whitespace trimmed on both ends. - - The string. - The starting index. - The length. - - A substring starting no earlier than startIndex and ending no later - than startIndex + length. - - - - - Default implementation of . - - - - - - - - - - - - - - - - - An implementation of that provides several Visit methods that - can provide access to specific message types without the burden of casting. - - - - - Dispatches the message to the given callback, if it's of the correct type. - - The message type - The message - The callback - The result of the callback, if called; true, otherwise - - - - Dispatches the message to the given callback, if it's of the correct type. - The callback is provided with both the message and this instance of the visitor. - - The message type - The message - The callback - The result of the callback, if called; true, otherwise - - - - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering/executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - An implementation of that provides several Visit methods that - can provide access to specific message types without the burden of casting. It also records - when it sees a completion message, and sets the event appropriately. - - The type of the completion message. - - - - Initializes a new instance of the class. - - - - - This event is triggered when the completion message has been seen. - - - - - - - - - - - Formats arguments for display in theories. - - - - - Format the value for presentation. - - The value to be formatted. - The formatted value. - - - - Default implementation of used by the xUnit.net equality assertions. - - The type that is being compared. - - - - Initializes a new instance of the class. - - Set to true to skip type equality checks. - The inner comparer to be used when the compared objects are enumerable. - - - - - - - - - - A class that wraps to create . - - The type that is being compared. - - - - Initializes a new instance of the class. - - The comparer that is being adapted. - - - - - - - - - - Base class for all long-lived objects that may cross over an AppDomain. - - - - - Creates a new instance of the type. - - - - - Disconnects all remote objects. - - - - - This implementation of allows the developer to track the count - of outstanding "async void" operations, and wait for them all to complete. - - - - - Initializes a new instance of the class. - - The existing synchronization context (may be null). - - - - - - - - - - - - - - - - Returns a task which is signaled when all outstanding operations are complete. - - - - - Default implementation of . Orders tests in - an unpredictable but stable order, so that repeated test runs of the - identical test assembly run tests in the same order. - - - - - Initializes a new instance of the class. - - Message sink to report diagnostic messages to - - - - - - - Default implementation of . Orders tests in - an unpredictable and unstable order, so that repeated test runs of the - identical test assembly run test collections in a random order. - - - - - - - - Tracks disposable objects, and disposes them in the reverse order they were added to - the tracker. - - - - - Add an object to be disposed. - - The object to be disposed. - - - - - - - Represents a caching factory for the types used for extensibility throughout the system. - - - - - Disposes the instances that are contained in the cache. - - - - - Gets an instance of the given type, casting it to , using the provided - constructor arguments. There is a single instance of a given type that is cached and reused, - so classes retrieved from this factory must be stateless and thread-safe. - - The interface type. - The message sink used to send diagnostic messages - The implementation type. - The constructor arguments. Since diagnostic message sinks are optional, - the code first looks for a type that takes the given arguments plus the message sink, and only - falls back to the message sink-less constructor if none was found. - The instance of the type. - - - - Gets a data discoverer. - - The message sink used to send diagnostic messages - The discoverer type - - - - Gets a data discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The data discoverer attribute - The data discoverer, if the type is loadable; null, otherwise. - - - - Gets a test case orderer. - - The message sink used to send diagnostic messages - The test case orderer type - - - - Gets a test case orderer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test case orderer attribute. - The test case orderer, if the type is loadable; null, otherwise. - - - - Gets a test collection orderer. - - The message sink used to send diagnostic messages - The test collection orderer type - - - - Gets a test collection orderer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test collection orderer attribute. - The test collection orderer, if the type is loadable; null, otherwise. - - - - Gets a test framework discoverer. - - The message sink used to send diagnostic messages - The test framework type discoverer type - - - - Gets a test framework discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test framework discoverer attribute - - - - Gets a trait discoverer. - - The message sink used to send diagnostic messages - The trait discoverer type - - - - Gets a trait discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The trait discoverer attribute. - The trait discoverer, if the type is loadable; null, otherwise. - - - - Gets an xUnit.net v2 test discoverer. - - The message sink used to send diagnostic messages - The test case discoverer type - - - - Gets an xUnit.net v2 test collection factory. - - The message sink used to send diagnostic messages - The test collection factory type - The test assembly under test - - - - Gets an xUnit.net v2 test collection factory, as specified in a reflected . - - The message sink used to send diagnostic messages - The collection behavior attribute. - The test assembly. - The collection factory. - - - - Implementation of that creates a single - default test collection for the assembly, and places any tests classes without - the into it. - - - - - Initializes a new instance of the class. - - The assembly. - The message sink used to send diagnostic messages - - - - - - - - - - Implementation of which creates a new test - collection for each test class that isn't decorated with . - - - - - Initializes a new instance of the class. - - The assembly info. - The message sink used to send diagnostic messages - - - - - - - - - - A simple implementation of that can be used to report an error - rather than running a test. - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The test method. - The error message to report for the test. - - - - Gets the error message that will be display when the test is run. - - - - - - - - - - - - - - Measures and aggregates execution time of one or more actions. - - - - - Returns the total time aggregated across all the actions. - - - - - Executes an action and aggregates its run time into the total. - - The action to measure. - - - - Executes an asynchronous action and aggregates its run time into the total. - - The action to measure. - - - - Aggregates a time span into the total time. - - The time to add. - - - - Implementation of that supports finding test cases - on methods decorated with . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Creates a single for the given test method. - - The discovery options to be used. - The test method. - The attribute that decorates the test method. - - - - - Discover test cases from a test method. By default, inspects the test method's argument list - to ensure it's empty, and if not, returns a single ; - otherwise, it returns the result of calling . - - The discovery options to be used. - The test method the test cases belong to. - The fact attribute attached to the test method. - Returns zero or more test cases represented by the test method. - - - - An implementation of to support . - - - - - Initializes a new instance of the class. - - The test case that the lambda represents. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - - - - A base class that provides default behavior when running tests in an assembly. It groups the tests - by test collection, and then runs the individual test collections. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The assembly that contains the tests to be run. - The test cases to be run. - The message sink to report diagnostic messages to. - The message sink to report run status to. - The user's requested execution options. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the user's requested execution options. - - - - - Gets or sets the message sink to report diagnostic messages to. - - - - - Gets or sets the message sink to report run status to. - - - - - Gets or sets the assembly that contains the tests to be run. - - - - - Gets or sets the test case orderer that will be used to decide how to order the tests. - - - - - Gets or sets the test collection orderer that will be used to decide how to order the test collections. - - - - - Gets or sets the test cases to be run. - - - - - - - - Override this to provide the display name for the test framework (f.e., "xUnit.net 2.0"). - This value is placed into . - - - - - Override this to provide the environment information (f.e., "32-bit .NET 4.0"). This value is - placed into . - - - - - This method is called just after is sent, but before any test collections are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Creates the message bus to be used for test execution. By default, it inspects - the options for the - flag, and if present, creates a message bus that ensures all messages are delivered - on the same thread. - - The message bus. - - - - Orders the test collections using the . - - Test collections (and the associated test cases) in run order - - - - Runs the tests in the test assembly. - - Returns summary information about the tests that were run. - - - - Runs the list of test collections. By default, groups the tests by collection and runs them synchronously. - - The message bus to report run status to. - The task cancellation token source, used to cancel the test run. - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test collection. - - The message bus to report run status to. - The test collection that is being run. - The test cases to be run. - The task cancellation token source, used to cancel the test run. - Returns summary information about the tests that were run. - - - - A base class that provides default behavior when running test cases. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test case to be run. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case to be run. - - - - - This method is called just after is sent, but before any test collections are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test case. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test method. - - Returns summary information about the tests that were run. - - - - A base class that provides default behavior when running tests in a test class. It groups the tests - by test method, and then runs the individual test methods. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test class to be run. - The test class that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the CLR class that contains the tests to be run. - - - - - Gets the message sink used to send diagnostic messages. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case orderer that will be used to decide how to order the test. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test class to be run. - - - - - Creates the arguments for the test class constructor. Attempts to resolve each parameter - individually, and adds an error when the constructor arguments cannot all be provided. - If the class is static, does not look for constructor, since one will not be needed. - - The test class constructor arguments. - - - - Gets the message to be used when the constructor is missing arguments. - - - - - This method is called just after is sent, but before any test methods are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test class. - - Returns summary information about the tests that were run. - - - - Runs the list of test methods. By default, orders the tests, groups them by method and runs them synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test method. - - The test method that contains the test cases. - The CLR method that contains the tests to be run. - The test cases to be run. - The constructor arguments that will be used to create the test class. - Returns summary information about the tests that were run. - - - - Selects the constructor to be used for the test class. By default, chooses the parameterless - constructor. Override to change the constructor selection logic. - - The constructor to be used for creating the test class. - - - - Tries to supply a test class constructor argument. By default, always fails. Override to - change the argument lookup logic. - - The constructor that will be used to create the test class. - The parameter index. - The parameter information. - The argument value that should be used for the parameter. - Returns true if the argument was supplied; false, otherwise. - - - - A base class that provides default behavior when running tests in a test collection. It groups the tests - by test class, and then runs the individual test classes. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test collection that contains the tests to be run. - The test cases to be run. - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case orderer that will be used to decide how to order the test. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test collection that contains the tests to be run. - - - - - This method is called just after is sent, but before any test classes are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test collection. - - Returns summary information about the tests that were run. - - - - Runs the list of test classes. By default, groups the tests by class and runs them synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test class. - - The test class to be run. - The CLR class that contains the tests to be run. - The test cases to be run. - Returns summary information about the tests that were run. - - - - A base class that provides default behavior to invoke a test method. This includes - support for async test methods (both "async Task" and "async void") as well as - creation and disposal of the test class. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the constructor arguments used to construct the test class. - - - - - Gets the display name of the invoked test. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test to be run. - - - - - Gets the test case to be run. - - - - - Gets or sets the runtime type of the class that contains the test method. - - - - - Gets or sets the runtime method of the method that contains the test. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - Gets or sets the object which measures execution time. - - - - - Creates the test class, unless the test method is static or there have already been errors. Note that - this method times the creation of the test class (using ). It is also responsible for - sending the and - messages, so if you override this method without calling the base, you are responsible for all of this behavior. - This method should NEVER throw; any exceptions should be placed into the . - - The class instance, if appropriate; null, otherwise - - - - This method is called just after the test method has finished executing. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before the test method is invoked. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method calls the test method via reflection. This is an available override point - if you need to do some other form of invocation of the actual test method. - - The instance of the test class - The return value from the test method invocation - - - - Creates the test class (if necessary), and invokes the test method. - - Returns the time (in seconds) spent creating the test class, running - the test, and disposing of the test class. - - - - Invokes the test method on the given test class instance. This method sets up support for "async void" - test methods, ensures that the test method has the correct number of arguments, then calls - to do the actual method invocation. It ensure that any async test method is fully completed before returning, and - returns the measured clock time that the invocation took. - - The test class instance - Returns the time taken to invoke the test method - - - - A base class that provides default behavior when running tests in a test method. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test method under test. - The CLR class that contains the test method. - The CLR method that contains the tests to be run. - The test cases to be run. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the CLR class that contains the test method. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the CLR method that contains the tests to be run. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test method that contains the test cases. - - - - - This method is called just after is sent, but before any test cases are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test method. - - Returns summary information about the tests that were run. - - - - Runs the list of test cases. By default, it runs the cases in order, synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run an individual test case. - - The test case to be run. - Returns summary information about the test case run. - - - - A base class that provides default behavior when running a test. This includes support - for skipping tests. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The skip reason, if the test is to be skipped. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the constructor arguments used to construct the test class. - - - - - Gets or sets the display name of the invoked test. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the skip reason for the test, if set. - - - - - Gets or sets the test to be run. - - - - - Gets the test case to be run. - - - - - Gets or sets the runtime type of the class that contains the test method. - - - - - Gets or sets the runtime method of the method that contains the test. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - This method is called just after is sent, but before the test class is created. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the test. - - Returns summary information about the test that was run. - - - - Override this method to invoke the test. - - The exception aggregator used to run code and collect exceptions. - Returns a tuple which includes the execution time (in seconds) spent running the - test method, and any output that was returned by the test. - - - - The test assembly runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The assembly that contains the tests to be run. - The test cases to be run. - The message sink to report diagnostic messages to. - The message sink to report run status to. - The user's requested execution options. - - - - - - - - - - - - - Gets the synchronization context used when potentially running tests in parallel. - If is greater than 0, it creates - and uses an instance of . - - The maximum number of parallel threads. - - - - Ensures the assembly runner is initialized (sets up the collection behavior, - parallelization options, and test orderers from their assembly attributes). - - - - - - - - - - - - - - - - - The test case runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test case to be run. - The display name of the test case. - The skip reason, if the test is to be skipped. - The arguments to be passed to the test class constructor. - The arguments to be passed to the test method. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s that will be used for this test case. - - - - - Gets or sets the arguments passed to the test class constructor - - - - - Gets or sets the display name of the test case - - - - - Gets or sets the skip reason for the test, if set. - - - - - Gets or sets the runtime type for the test class that the test method belongs to. - - - - - Gets of sets the runtime method for the test method that the test case belongs to. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - - - - The test class runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test class to be run. - The test class that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - The mapping of collection fixture types to fixtures. - - - - Gets the fixture mappings that were created during . - - - - - Creates the instance of a class fixture type to be used by the test class. If the fixture can be created, - it should be placed into the dictionary; if it cannot, then the method - should record the error by calling Aggregator.Add. - - The type of the fixture to be created - - - - - - - - - - - - - - - - - - - - - - The test collection runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test collection that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the fixture mappings that were created during . - - - - - - - - - - - Creates the instance of a collection fixture type to be used by the test collection. If the fixture can be created, - it should be placed into the dictionary; if it cannot, then the method - should record the error by calling Aggregator.Add. - - The type of the fixture to be created - - - - Gives an opportunity to override test case orderer. By default, this method gets the - orderer from the collection definition. If this function returns null, the - test case orderer passed into the constructor will be used. - - - - - - - - The test invoker for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The list of s for this test invocation. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s for this test invocation. - - - - - - - - - - - The test method runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test method to be run. - The test class that contains the test method. - The test method that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages to. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - The constructor arguments for the test class. - - - - - - - The test runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The skip reason, if the test is to be skipped. - The list of s for this test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s for this test. - - - - - - - - Override this method to invoke the test method. - - The exception aggregator used to run code and collect exceptions. - Returns the execution time (in seconds) spent running the test method. - - - - The test case runner for xUnit.net v2 theories (which could not be pre-enumerated; - pre-enumerated test cases use ). - - - - - Initializes a new instance of the class. - - The test case to be run. - The display name of the test case. - The skip reason, if the test is to be skipped. - The arguments to be passed to the test class constructor. - The message sink used to send diagnostic messages - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test assembly. - The optional configuration filename (defaults to the - configuration file of the current app domain if not provided) - The version number of the assembly (defaults to "0.0.0.0") - - - - - - - - - - Gets or sets the assembly version. - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test collection the class belongs to - The test class - - - - - - - - - - - - - - - - An implementation of for . - Compares the fully qualified names of the types. - - - - - The singleton instance of the comparer. - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test assembly the collection belongs to - The optional type which contains the collection definition - The display name for the test collection - - - - - - - - - - - - - - - - - - - - - - An implementation of for . - Compares the IDs of the test collections. - - - - - The singleton instance of the comparer. - - - - - - - - - - - A helper class that gets the list of test collection definitions for a given assembly. - Reports any misconfigurations of the test assembly via the diagnostic message sink. - - - - - Gets the test collection definitions for the given assembly. - - The assembly. - The message sink used to send diagnostic messages - A list of mappings from test collection name to test collection definitions (as - - - - A default implementation of that tracks objects to be - disposed when the framework is disposed. The discoverer and executor are automatically - tracked for disposal, since those interfaces mandate an implementation of . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Gets the message sink used to send diagnostic messages. - - - - - Gets the disposal tracker for the test framework. - - - - - - - - - - - Override this method to provide the implementation of . - - The assembly that is being discovered. - Returns the test framework discoverer. - - - - Override this method to provide the implementation of . - - The assembly that is being executed. - Returns the test framework executor. - - - - - - - - - - A base implementation of that supports test filtering - and runs the discovery process on a thread pool thread. - - - - - Initializes a new instance of the class. - - The test assembly. - The source information provider. - The message sink used to send diagnostic messages - - - - Gets the assembly that's being discovered. - - - - - Gets the message sink used to report diagnostic messages. - - - - - Gets the disposal tracker for the test framework discoverer. - - - - - Get the source code information provider used during discovery. - - - - - - - - - - - Implement this method to create a test class for the given CLR type. - - The CLR type. - The test class. - - - - - - - - - - - - - Core implementation to discover unit tests in a given test class. - - The test class. - Set to true to attempt to include source information. - The message sink to send discovery messages to. - The options used by the test framework during discovery. - Returns true if discovery should continue; false otherwise. - - - - Determines if a type should be used for discovery. Can be used to filter out types that - are not desirable. The default implementation filters out abstract (non-static) classes. - - The type. - Returns true if the type can contain tests; false, otherwise. - - - - Reports a discovered test case to the message bus, after updating the source code information - (if desired). - - - - - - - - - - - - A reusable implementation of which contains the basic behavior - for running tests. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - Name of the test assembly. - The source line number information provider. - The message sink to report diagnostic messages to. - - - - Gets the assembly information of the assembly under test. - - - - - Gets the message sink to send diagnostic messages to. - - - - - Gets the disposal tracker for the test framework discoverer. - - - - - Gets the source information provider. - - - - - Override to create a test framework discoverer that can be used to discover - tests when the user asks to run all test. - - The test framework discoverer - - - - - - - - - - - - - - - - Override to run test cases. - - The test cases to be run. - The message sink to report run status to. - The user's requested execution options. - - - - This class proxies for the real implementation of , based on - whether the user has overridden the choice via . If - no attribute is found, defaults to . - - - - - Initializes a new instance of the class. - - The test assembly (expected to implement ). - The source information provider (expected to implement ). - The diagnostic message sink (expected to implement ). - - - - Gets the test framework that's being wrapped by the proxy. - - - - - - - - - - - - - - - - - INTERNAL CLASS. DO NOT USE. - - - - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test class - The test method - - - - - - - - - - - - - - - - An implementation of for . - Compares the names of the methods. - - - - - The singleton instance of the comparer. - - - - - - - - - - - A base class implementation of which is based on test cases being - related directly to test methods. - - - - - Used for de-serialization. - - - - - Initializes a new instance of the class. - - Default method display to use (when not customized). - The test method this test case belongs to. - The arguments for the test method. - - - - Returns the base display name for a test ("TestClassName.MethodName"). - - - - - Returns the default method display to use (when not customized). - - - - - - - - - - - Gets the generic types that were used to close the generic test method, if - applicable; null, if the test method was not an open generic. - - - - - - - - - - - - - - - - - - - - - - - - - - Call to ensure the object is fully initialized(). - - - - - Gets the unique ID for the test case. - - - - Converts an array of bytes to its hexadecimal value as a string. - The bytes. - A string containing the hexademical representation of the provided bytes. - - - Gets a hexademical digit character from the 4-bit value. - A value in the range [0, 15]. - A character in the range ['0','9'] or ['a','f']. - - - - Called when initializing the test cases, either after constructor or de-serialization. - Override this method to add additional initialization-time work. - - - - - - - - - - - Default implementation of . - - - - - Gets the output provided by the test. - - - - - Initialize the test output helper with information about a test case. - - - - - Resets the test output helper to its uninitialized state. - - - - - - - - - - - Implementation of that supports finding test cases - on methods decorated with . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Creates a test case for a single row of data. By default, returns an instance of - with the data row inside of it. - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The row of data for this test case. - The test case - - - - Creates a test case for a skipped theory. By default, returns an instance of - (which inherently discovers the skip reason via the fact attribute). - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The skip reason that decorates . - The test case - - - - Creates a test case for the entire theory. This is used when one or more of the theory data items - are not serializable, or if the user has requested to skip theory pre-enumeration. By default, - returns an instance of , which performs the data discovery at runtime. - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The test case - - - - Discover test cases from a test method. - - - This method performs the following steps: - - If the theory attribute is marked with Skip, returns the single test case from ; - - If pre-enumeration is off, or any of the test data is non serializable, returns the single test case from ; - - If there is no theory data, returns a single test case of with the error in it; - - Otherwise, it returns one test case per data row, created by calling . - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - Returns zero or more test cases represented by the test method. - - - - An implementation of for xUnit v2. - - - - - Initializes a new instance of the class. - - The test case this test belongs to. - The display name for this test. - - - - - - - Gets the xUnit v2 test case. - - - - - - - - Default implementation of for xUnit v2 that supports tests decorated with - both and . - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The test method this test case belongs to. - The arguments for the test method. - - - - Gets the display name for the test case. Calls - with the given base display name (which is itself either derived from , - falling back to . - - The fact attribute the decorated the test case. - The base display name from . - The display name for the test case. - - - - Gets the skip reason for the test case. By default, pulls the skip reason from the - property. - - The fact attribute the decorated the test case. - The skip reason, if skipped; null, otherwise. - - - - - - - - - - The implementation of that supports discovery and - execution of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - - - - - - - The implementation of that supports discovery - of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Gets the display name of the xUnit.net v2 test framework. - - - - - Initializes a new instance of the class. - - The test assembly. - The source information provider. - The message sink used to send diagnostic messages - The test collection factory used to look up test collections. - - - - Gets the test collection factory that makes test collections. - - - - - - - - Finds the tests on a test method. - - The test method. - Set to true to indicate that source information should be included. - The message bus to report discovery messages to. - The options used by the test framework during discovery. - Return true to continue test discovery, false, otherwise. - - - - - - - Gets the test case discover instance for the given discoverer type. The instances are cached - and reused, since they should not be stateful. - - The discoverer type. - Returns the test case discoverer instance. - - - - The implementation of that supports execution - of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Initializes a new instance of the class. - - Name of the test assembly. - The source line number information provider. - The message sink to report diagnostic messages to. - - - - Gets the test assembly that contains the test. - - - - - - - - - - - Represents a test case which runs multiple tests for theory data, either because the - data was not enumerable or because the data was not serializable. - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The method under test. - - - - - - - An implementation of which runs work on custom threads - rather than in the thread pool, and limits the number of in-flight actions. - - - - - Initializes a new instance of the class. - - The maximum number of tasks to run at any one time. - - - - Gets a flag indicating whether maximum concurrency is supported. - - - - - - - - - - - - - - This is an internal class, and is not intended to be called from end-user code. - - - - - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. - - - - - Initializes a new instance of the class. - - The message bus to delegate to. - The callback to send messages to. - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. In addition, - it issues a event when a message of the type - is seen. - - The type of the T final message. - - - - Initializes a new instance of the class. - - The message bus to delegate to. - The callback to send messages to. - - - - The final message that was seen that caused to be triggered. - - - - - An event that is triggered when a message of type is seen. - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. - - - - - Initializes a new instance of the class. - - The inner message sink. - The callback. - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. In addition, - it issues a event when a message of the type - is seen. - - The type of the T final message. - - - - Initializes a new instance of the class. - - The inner message sink. - The callback. - - - - The final message that was seen that caused to be triggered. - - - - - An event that is triggered when a message of type is seen. - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The assembly to be wrapped. - - - - Initializes a new instance of the class. - - The assembly to be wrapped. - - - - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The attribute to be wrapped. - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The method to be wrapped. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The parameter to be wrapped. - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The type to wrap. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Wrapper to implement types from xunit.abstractions.dll using reflection. - - - - - Converts arguments into their target types. Can be particularly useful when pulling attribute - constructor arguments, whose types may not strictly match the parameter types. - - The arguments to be converted. - The target types for the conversion. - The converted arguments. - - - - Converts an into an . - - The assembly to wrap. - The wrapper - - - - Converts an into an using reflection. - - The attribute to wrap. - The wrapper - - - - Converts a into an using reflection. - - The method to wrap - The wrapper - - - - Converts a into an using reflection. - - THe parameter to wrap - The wrapper - - - - Converts a into an using reflection. - - The type to wrap - The wrapper - - - - This is an internal class, and is not intended to be called from end-user code. - - - - - - - - - - - - - - Represents an exception that happened during the process of a test class. This typically - means there were problems identifying the correct test class constructor, or problems - creating the fixture data for the test class. - - - - - Initializes a new instance of the class. - - The exception message. - - - - The implementation of that supports attributes - of type . - - - - - - - - A helper class to retrieve the traits from a method. - - - - - Get the traits from a method. - - The method to get the traits for. - A list of traits that are defined on the method. - - - - Extension methods for . - - - - - Formulates the extended portion of the display name for a test method. For tests with no arguments, this will - return just the base name; for tests with arguments, attempts to format the arguments and appends the argument - list to the test name. - - The test method - The base part of the display name - The test method arguments - The test method's generic types - The full display name for the test method - - - - Resolves a generic type for a test method. The test parameters (and associated parameter infos) are - used to determine the best matching generic type for the test method that can be satisfied by all - the generic parameters and their values. - - The generic type to be resolved - The parameter values being passed to the test method - The parameter infos for the test method - The best matching generic type - - - - Resolves all the generic types for a test method. The test parameters are used to determine - the best matching generic types for the test method that can be satisfied by all - the generic parameters and their values. - - The test method - The parameter values being passed to the test method - The best matching generic types - - - base implementation of MD4 family style digest as outlined in - "Handbook of Applied Cryptography", pages 344 - 347. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - implementation of SHA-1 as outlined in "Handbook of Applied Cryptography", pages 346 - 349. - - It is interesting to ponder why the, apart from the extra IV, the other difference here from MD5 - is the "endianness" of the word processing! - - - - - - - Copy constructor. This will copy the state of the provided - message digest. - - - - - - - - - - - - reset the chaining variables - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of and . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message to send - - - - Initializes a new instance of the class. - - The format of the message to send - The arguments used to format the message - - - - - - - Default implementation of . - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Gets the substitution token used as assembly name suffix to indicate that the assembly is - a generalized reference to the platform-specific assembly. - - - - - A mirror class of the CLR's class. - - - - - Initializes a new instance of the class. - - The data to copy into the serialization info - - - - - - - - - - - - - Returns BASE64 encoded string that represents the entirety of the data. - - - - - Returns a triple for a key/value pair of data in a complex object - - The triple to be serialized - The serialized version of the triple - - - - Returns the triple values out of a serialized triple. - - The serialized triple - The de-serialized triple - - - - De-serializes a value that was serialized with . - - The type of the object to de-serialize into - The serialized value - The de-serialized object - - - - Serializes an object. - - The value to be serialized - The serialized object - - - - Represents a triple of information used when serializing complex types: the property name, - the value to be serialized, and the value's type. - - - - - Gets the triple's key - - - - - Gets the triple's value - - - - - Gets the triple's value type - - - - - Initializes a new instance of the class. - - The triple's key - The triple's value - The triple's value type - - - - Guard class, used for guard clauses and argument validation - - - - - - - - - - - - - - Methods which help bridge and contain the differences between Type and TypeInfo. - - - - - This class represents utility methods needed to supplement the - reflection capabilities provided by the CLR - - - - - Creates an instance of the test class for the given test case. Sends the - and messages as appropriate. - - The test - The type of the test class - The constructor arguments for the test class - The message bus used to send the test messages - The timer used to measure the time taken for construction - The cancellation token source - - - - - Disposes the test class instance. Sends the and - messages as appropriate. - - The test - The test class instance to be disposed - The message bus used to send the test messages - The timer used to measure the time taken for construction - The cancellation token source - - - - Gets methods in the target type that match the protection level of the supplied method - - The type - The method - The reflection method informations that match - - - - Gets all the custom attributes for the given assembly. - - The assembly - The type of the attribute - The matching attributes that decorate the assembly - - - - Gets all the custom attributes for the given attribute. - - The attribute - The type of the attribute to find - The matching attributes that decorate the attribute - - - - Gets all the custom attributes for the method that are of the given type. - - The method - The type of the attribute - The matching attributes that decorate the method - - - - Gets all the custom attributes for the given type. - - The type - The type of the attribute - The matching attributes that decorate the type - - - - Converts an into a , if possible (for example, this - will not work when the test method is based on source code rather than binaries). - - The method to convert - The runtime method, if available; null, otherwise - - - - Converts an into a , if possible (for example, this - will not work when the test class is based on source code rather than binaries). - - The type to convert - The runtime type, if available, null, otherwise - - - - Extension methods for reading and . - - - - - Gets a flag that determines whether diagnostic messages will be emitted. - - - - - Gets a flag that determines whether diagnostic messages will be emitted. If the flag is not present, - returns the default value (false). - - - - - Gets a flag that determines the default display name format for test methods. - - - - - Gets a flag that determines the default display name format for test methods. If the flag is not present, - returns the default value (). - - - - - Gets a flag that determines whether theories are pre-enumerated. If they enabled, then the - discovery system will return a test case for each row of test data; they are disabled, then the - discovery system will return a single test case for the theory. - - - - - Gets a flag that determines whether theories are pre-enumerated. If they enabled, then the - discovery system will return a test case for each row of test data; they are disabled, then the - discovery system will return a single test case for the theory. If the flag is not present, - returns the default value (true). - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - If the flag is not set, returns the default value (false). - - - - - Gets a flag that determines whether diagnostic messages will be emitted. - - - - - Gets a flag that determines whether diagnostic messages will be emitted. If the flag is not - present, returns the default value (false). - - - - - Gets a flag to disable parallelization. - - - - - Gets a flag to disable parallelization. If the flag is not present, returns the - default value (false). - - - - - Gets the maximum number of threads to use when running tests in parallel. - - - - - Gets the maximum number of threads to use when running tests in parallel. If set to 0 (or not set), - the value of is used; if set to a value less - than 0, does not limit the number of threads. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - If the flag is not set, returns the default value (false). - - - - diff --git a/packages/xunit.extensibility.execution.2.1.0/lib/dotnet/xunit.execution.dotnet.dll b/packages/xunit.extensibility.execution.2.1.0/lib/dotnet/xunit.execution.dotnet.dll deleted file mode 100644 index 3c43440..0000000 Binary files a/packages/xunit.extensibility.execution.2.1.0/lib/dotnet/xunit.execution.dotnet.dll and /dev/null differ diff --git a/packages/xunit.extensibility.execution.2.1.0/lib/dotnet/xunit.execution.dotnet.xml b/packages/xunit.extensibility.execution.2.1.0/lib/dotnet/xunit.execution.dotnet.xml deleted file mode 100644 index d819501..0000000 --- a/packages/xunit.extensibility.execution.2.1.0/lib/dotnet/xunit.execution.dotnet.xml +++ /dev/null @@ -1,4157 +0,0 @@ - - - - xunit.execution.dotnet - - - - - Rethrows an exception object without losing the existing stack trace information - - The exception to re-throw. - - For more information on this technique, see - http://www.dotnetjunkies.com/WebLog/chris.taylor/archive/2004/03/03/8353.aspx. - The remote_stack_trace string is here to support Mono. - - - - - Unwraps an exception to remove any wrappers, like . - - The exception to unwrap. - The unwrapped exception. - - - - Utility classes for dealing with Exception objects. - - - - - Combines multiple levels of messages into a single message. - - The failure information from which to get the messages. - The combined string. - - - - Combines multiple levels of stack traces into a single stack trace. - - The failure information from which to get the stack traces. - The combined string. - - - - Unwraps exceptions and their inner exceptions. - - The exception to be converted. - The failure information. - - - - An implementation of that ignores all messages. - - - - - - - - Serializes and de-serializes objects - - - - - De-serializes an object. - - The type of the object - The object's serialized value - The de-serialized object - - - - Serializes an object. - - The value to serialize - The serialized value - - - Gets whether the specified is serializable with . - The object to test for serializability. - true if the object can be serialized; otherwise, false. - - - - Converts an assembly qualified type name into a object. - - The assembly qualified type name. - The instance of the , if available; null, otherwise. - - - - Converts an assembly name + type name into a object. - - The assembly name. - The type name. - The instance of the , if available; null, otherwise. - - - - Gets an assembly qualified type name for serialization, with special dispensation for types which - originate in the execution assembly. - - - - - Retrieves a substring from the string, with whitespace trimmed on both ends. - - The string. - The starting index. - The length. - - A substring starting no earlier than startIndex and ending no later - than startIndex + length. - - - - - Default implementation of . - - - - - - - - - - - - - - - - - An implementation of that provides several Visit methods that - can provide access to specific message types without the burden of casting. - - - - - Dispatches the message to the given callback, if it's of the correct type. - - The message type - The message - The callback - The result of the callback, if called; true, otherwise - - - - Dispatches the message to the given callback, if it's of the correct type. - The callback is provided with both the message and this instance of the visitor. - - The message type - The message - The callback - The result of the callback, if called; true, otherwise - - - - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering/executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - An implementation of that provides several Visit methods that - can provide access to specific message types without the burden of casting. It also records - when it sees a completion message, and sets the event appropriately. - - The type of the completion message. - - - - Initializes a new instance of the class. - - - - - This event is triggered when the completion message has been seen. - - - - - - - - - - - Formats arguments for display in theories. - - - - - Format the value for presentation. - - The value to be formatted. - The formatted value. - - - - Default implementation of used by the xUnit.net equality assertions. - - The type that is being compared. - - - - Initializes a new instance of the class. - - Set to true to skip type equality checks. - The inner comparer to be used when the compared objects are enumerable. - - - - - - - - - - A class that wraps to create . - - The type that is being compared. - - - - Initializes a new instance of the class. - - The comparer that is being adapted. - - - - - - - - - - Base class for all long-lived objects that may cross over an AppDomain. - - - - - Creates a new instance of the type. - - - - - Disconnects all remote objects. - - - - - This implementation of allows the developer to track the count - of outstanding "async void" operations, and wait for them all to complete. - - - - - Initializes a new instance of the class. - - The existing synchronization context (may be null). - - - - - - - - - - - - - - - - Returns a task which is signaled when all outstanding operations are complete. - - - - - Default implementation of . Orders tests in - an unpredictable but stable order, so that repeated test runs of the - identical test assembly run tests in the same order. - - - - - Initializes a new instance of the class. - - Message sink to report diagnostic messages to - - - - - - - Default implementation of . Orders tests in - an unpredictable and unstable order, so that repeated test runs of the - identical test assembly run test collections in a random order. - - - - - - - - Tracks disposable objects, and disposes them in the reverse order they were added to - the tracker. - - - - - Add an object to be disposed. - - The object to be disposed. - - - - - - - Represents a caching factory for the types used for extensibility throughout the system. - - - - - Disposes the instances that are contained in the cache. - - - - - Gets an instance of the given type, casting it to , using the provided - constructor arguments. There is a single instance of a given type that is cached and reused, - so classes retrieved from this factory must be stateless and thread-safe. - - The interface type. - The message sink used to send diagnostic messages - The implementation type. - The constructor arguments. Since diagnostic message sinks are optional, - the code first looks for a type that takes the given arguments plus the message sink, and only - falls back to the message sink-less constructor if none was found. - The instance of the type. - - - - Gets a data discoverer. - - The message sink used to send diagnostic messages - The discoverer type - - - - Gets a data discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The data discoverer attribute - The data discoverer, if the type is loadable; null, otherwise. - - - - Gets a test case orderer. - - The message sink used to send diagnostic messages - The test case orderer type - - - - Gets a test case orderer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test case orderer attribute. - The test case orderer, if the type is loadable; null, otherwise. - - - - Gets a test collection orderer. - - The message sink used to send diagnostic messages - The test collection orderer type - - - - Gets a test collection orderer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test collection orderer attribute. - The test collection orderer, if the type is loadable; null, otherwise. - - - - Gets a test framework discoverer. - - The message sink used to send diagnostic messages - The test framework type discoverer type - - - - Gets a test framework discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test framework discoverer attribute - - - - Gets a trait discoverer. - - The message sink used to send diagnostic messages - The trait discoverer type - - - - Gets a trait discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The trait discoverer attribute. - The trait discoverer, if the type is loadable; null, otherwise. - - - - Gets an xUnit.net v2 test discoverer. - - The message sink used to send diagnostic messages - The test case discoverer type - - - - Gets an xUnit.net v2 test collection factory. - - The message sink used to send diagnostic messages - The test collection factory type - The test assembly under test - - - - Gets an xUnit.net v2 test collection factory, as specified in a reflected . - - The message sink used to send diagnostic messages - The collection behavior attribute. - The test assembly. - The collection factory. - - - - Implementation of that creates a single - default test collection for the assembly, and places any tests classes without - the into it. - - - - - Initializes a new instance of the class. - - The assembly. - The message sink used to send diagnostic messages - - - - - - - - - - Implementation of which creates a new test - collection for each test class that isn't decorated with . - - - - - Initializes a new instance of the class. - - The assembly info. - The message sink used to send diagnostic messages - - - - - - - - - - A simple implementation of that can be used to report an error - rather than running a test. - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The test method. - The error message to report for the test. - - - - Gets the error message that will be display when the test is run. - - - - - - - - - - - - - - Measures and aggregates execution time of one or more actions. - - - - - Returns the total time aggregated across all the actions. - - - - - Executes an action and aggregates its run time into the total. - - The action to measure. - - - - Executes an asynchronous action and aggregates its run time into the total. - - The action to measure. - - - - Aggregates a time span into the total time. - - The time to add. - - - - Implementation of that supports finding test cases - on methods decorated with . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Creates a single for the given test method. - - The discovery options to be used. - The test method. - The attribute that decorates the test method. - - - - - Discover test cases from a test method. By default, inspects the test method's argument list - to ensure it's empty, and if not, returns a single ; - otherwise, it returns the result of calling . - - The discovery options to be used. - The test method the test cases belong to. - The fact attribute attached to the test method. - Returns zero or more test cases represented by the test method. - - - - An implementation of to support . - - - - - Initializes a new instance of the class. - - The test case that the lambda represents. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - - - - A base class that provides default behavior when running tests in an assembly. It groups the tests - by test collection, and then runs the individual test collections. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The assembly that contains the tests to be run. - The test cases to be run. - The message sink to report diagnostic messages to. - The message sink to report run status to. - The user's requested execution options. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the user's requested execution options. - - - - - Gets or sets the message sink to report diagnostic messages to. - - - - - Gets or sets the message sink to report run status to. - - - - - Gets or sets the assembly that contains the tests to be run. - - - - - Gets or sets the test case orderer that will be used to decide how to order the tests. - - - - - Gets or sets the test collection orderer that will be used to decide how to order the test collections. - - - - - Gets or sets the test cases to be run. - - - - - - - - Override this to provide the display name for the test framework (f.e., "xUnit.net 2.0"). - This value is placed into . - - - - - Override this to provide the environment information (f.e., "32-bit .NET 4.0"). This value is - placed into . - - - - - This method is called just after is sent, but before any test collections are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Creates the message bus to be used for test execution. By default, it inspects - the options for the - flag, and if present, creates a message bus that ensures all messages are delivered - on the same thread. - - The message bus. - - - - Orders the test collections using the . - - Test collections (and the associated test cases) in run order - - - - Runs the tests in the test assembly. - - Returns summary information about the tests that were run. - - - - Runs the list of test collections. By default, groups the tests by collection and runs them synchronously. - - The message bus to report run status to. - The task cancellation token source, used to cancel the test run. - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test collection. - - The message bus to report run status to. - The test collection that is being run. - The test cases to be run. - The task cancellation token source, used to cancel the test run. - Returns summary information about the tests that were run. - - - - A base class that provides default behavior when running test cases. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test case to be run. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case to be run. - - - - - This method is called just after is sent, but before any test collections are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test case. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test method. - - Returns summary information about the tests that were run. - - - - A base class that provides default behavior when running tests in a test class. It groups the tests - by test method, and then runs the individual test methods. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test class to be run. - The test class that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the CLR class that contains the tests to be run. - - - - - Gets the message sink used to send diagnostic messages. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case orderer that will be used to decide how to order the test. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test class to be run. - - - - - Creates the arguments for the test class constructor. Attempts to resolve each parameter - individually, and adds an error when the constructor arguments cannot all be provided. - If the class is static, does not look for constructor, since one will not be needed. - - The test class constructor arguments. - - - - Gets the message to be used when the constructor is missing arguments. - - - - - This method is called just after is sent, but before any test methods are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test class. - - Returns summary information about the tests that were run. - - - - Runs the list of test methods. By default, orders the tests, groups them by method and runs them synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test method. - - The test method that contains the test cases. - The CLR method that contains the tests to be run. - The test cases to be run. - The constructor arguments that will be used to create the test class. - Returns summary information about the tests that were run. - - - - Selects the constructor to be used for the test class. By default, chooses the parameterless - constructor. Override to change the constructor selection logic. - - The constructor to be used for creating the test class. - - - - Tries to supply a test class constructor argument. By default, always fails. Override to - change the argument lookup logic. - - The constructor that will be used to create the test class. - The parameter index. - The parameter information. - The argument value that should be used for the parameter. - Returns true if the argument was supplied; false, otherwise. - - - - A base class that provides default behavior when running tests in a test collection. It groups the tests - by test class, and then runs the individual test classes. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test collection that contains the tests to be run. - The test cases to be run. - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case orderer that will be used to decide how to order the test. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test collection that contains the tests to be run. - - - - - This method is called just after is sent, but before any test classes are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test collection. - - Returns summary information about the tests that were run. - - - - Runs the list of test classes. By default, groups the tests by class and runs them synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test class. - - The test class to be run. - The CLR class that contains the tests to be run. - The test cases to be run. - Returns summary information about the tests that were run. - - - - A base class that provides default behavior to invoke a test method. This includes - support for async test methods (both "async Task" and "async void") as well as - creation and disposal of the test class. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the constructor arguments used to construct the test class. - - - - - Gets the display name of the invoked test. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test to be run. - - - - - Gets the test case to be run. - - - - - Gets or sets the runtime type of the class that contains the test method. - - - - - Gets or sets the runtime method of the method that contains the test. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - Gets or sets the object which measures execution time. - - - - - Creates the test class, unless the test method is static or there have already been errors. Note that - this method times the creation of the test class (using ). It is also responsible for - sending the and - messages, so if you override this method without calling the base, you are responsible for all of this behavior. - This method should NEVER throw; any exceptions should be placed into the . - - The class instance, if appropriate; null, otherwise - - - - This method is called just after the test method has finished executing. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before the test method is invoked. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method calls the test method via reflection. This is an available override point - if you need to do some other form of invocation of the actual test method. - - The instance of the test class - The return value from the test method invocation - - - - Creates the test class (if necessary), and invokes the test method. - - Returns the time (in seconds) spent creating the test class, running - the test, and disposing of the test class. - - - - Invokes the test method on the given test class instance. This method sets up support for "async void" - test methods, ensures that the test method has the correct number of arguments, then calls - to do the actual method invocation. It ensure that any async test method is fully completed before returning, and - returns the measured clock time that the invocation took. - - The test class instance - Returns the time taken to invoke the test method - - - - A base class that provides default behavior when running tests in a test method. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test method under test. - The CLR class that contains the test method. - The CLR method that contains the tests to be run. - The test cases to be run. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the CLR class that contains the test method. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the CLR method that contains the tests to be run. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test method that contains the test cases. - - - - - This method is called just after is sent, but before any test cases are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test method. - - Returns summary information about the tests that were run. - - - - Runs the list of test cases. By default, it runs the cases in order, synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run an individual test case. - - The test case to be run. - Returns summary information about the test case run. - - - - A base class that provides default behavior when running a test. This includes support - for skipping tests. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The skip reason, if the test is to be skipped. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the constructor arguments used to construct the test class. - - - - - Gets or sets the display name of the invoked test. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the skip reason for the test, if set. - - - - - Gets or sets the test to be run. - - - - - Gets the test case to be run. - - - - - Gets or sets the runtime type of the class that contains the test method. - - - - - Gets or sets the runtime method of the method that contains the test. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - This method is called just after is sent, but before the test class is created. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the test. - - Returns summary information about the test that was run. - - - - Override this method to invoke the test. - - The exception aggregator used to run code and collect exceptions. - Returns a tuple which includes the execution time (in seconds) spent running the - test method, and any output that was returned by the test. - - - - The test assembly runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The assembly that contains the tests to be run. - The test cases to be run. - The message sink to report diagnostic messages to. - The message sink to report run status to. - The user's requested execution options. - - - - - - - - - - - - - Gets the synchronization context used when potentially running tests in parallel. - If is greater than 0, it creates - and uses an instance of . - - The maximum number of parallel threads. - - - - Ensures the assembly runner is initialized (sets up the collection behavior, - parallelization options, and test orderers from their assembly attributes). - - - - - - - - - - - - - - - - - The test case runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test case to be run. - The display name of the test case. - The skip reason, if the test is to be skipped. - The arguments to be passed to the test class constructor. - The arguments to be passed to the test method. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s that will be used for this test case. - - - - - Gets or sets the arguments passed to the test class constructor - - - - - Gets or sets the display name of the test case - - - - - Gets or sets the skip reason for the test, if set. - - - - - Gets or sets the runtime type for the test class that the test method belongs to. - - - - - Gets of sets the runtime method for the test method that the test case belongs to. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - - - - The test class runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test class to be run. - The test class that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - The mapping of collection fixture types to fixtures. - - - - Gets the fixture mappings that were created during . - - - - - Creates the instance of a class fixture type to be used by the test class. If the fixture can be created, - it should be placed into the dictionary; if it cannot, then the method - should record the error by calling Aggregator.Add. - - The type of the fixture to be created - - - - - - - - - - - - - - - - - - - - - - The test collection runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test collection that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the fixture mappings that were created during . - - - - - - - - - - - Creates the instance of a collection fixture type to be used by the test collection. If the fixture can be created, - it should be placed into the dictionary; if it cannot, then the method - should record the error by calling Aggregator.Add. - - The type of the fixture to be created - - - - Gives an opportunity to override test case orderer. By default, this method gets the - orderer from the collection definition. If this function returns null, the - test case orderer passed into the constructor will be used. - - - - - - - - The test invoker for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The list of s for this test invocation. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s for this test invocation. - - - - - - - - - - - The test method runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test method to be run. - The test class that contains the test method. - The test method that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages to. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - The constructor arguments for the test class. - - - - - - - The test runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The skip reason, if the test is to be skipped. - The list of s for this test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s for this test. - - - - - - - - Override this method to invoke the test method. - - The exception aggregator used to run code and collect exceptions. - Returns the execution time (in seconds) spent running the test method. - - - - The test case runner for xUnit.net v2 theories (which could not be pre-enumerated; - pre-enumerated test cases use ). - - - - - Initializes a new instance of the class. - - The test case to be run. - The display name of the test case. - The skip reason, if the test is to be skipped. - The arguments to be passed to the test class constructor. - The message sink used to send diagnostic messages - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test assembly. - The optional configuration filename (defaults to the - configuration file of the current app domain if not provided) - The version number of the assembly (defaults to "0.0.0.0") - - - - - - - - - - Gets or sets the assembly version. - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test collection the class belongs to - The test class - - - - - - - - - - - - - - - - An implementation of for . - Compares the fully qualified names of the types. - - - - - The singleton instance of the comparer. - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test assembly the collection belongs to - The optional type which contains the collection definition - The display name for the test collection - - - - - - - - - - - - - - - - - - - - - - An implementation of for . - Compares the IDs of the test collections. - - - - - The singleton instance of the comparer. - - - - - - - - - - - A helper class that gets the list of test collection definitions for a given assembly. - Reports any misconfigurations of the test assembly via the diagnostic message sink. - - - - - Gets the test collection definitions for the given assembly. - - The assembly. - The message sink used to send diagnostic messages - A list of mappings from test collection name to test collection definitions (as - - - - A default implementation of that tracks objects to be - disposed when the framework is disposed. The discoverer and executor are automatically - tracked for disposal, since those interfaces mandate an implementation of . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Gets the message sink used to send diagnostic messages. - - - - - Gets the disposal tracker for the test framework. - - - - - - - - - - - Override this method to provide the implementation of . - - The assembly that is being discovered. - Returns the test framework discoverer. - - - - Override this method to provide the implementation of . - - The assembly that is being executed. - Returns the test framework executor. - - - - - - - - - - A base implementation of that supports test filtering - and runs the discovery process on a thread pool thread. - - - - - Initializes a new instance of the class. - - The test assembly. - The source information provider. - The message sink used to send diagnostic messages - - - - Gets the assembly that's being discovered. - - - - - Gets the message sink used to report diagnostic messages. - - - - - Gets the disposal tracker for the test framework discoverer. - - - - - Get the source code information provider used during discovery. - - - - - - - - - - - Implement this method to create a test class for the given CLR type. - - The CLR type. - The test class. - - - - - - - - - - - - - Core implementation to discover unit tests in a given test class. - - The test class. - Set to true to attempt to include source information. - The message sink to send discovery messages to. - The options used by the test framework during discovery. - Returns true if discovery should continue; false otherwise. - - - - Determines if a type should be used for discovery. Can be used to filter out types that - are not desirable. The default implementation filters out abstract (non-static) classes. - - The type. - Returns true if the type can contain tests; false, otherwise. - - - - Reports a discovered test case to the message bus, after updating the source code information - (if desired). - - - - - - - - - - - - A reusable implementation of which contains the basic behavior - for running tests. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - Name of the test assembly. - The source line number information provider. - The message sink to report diagnostic messages to. - - - - Gets the assembly information of the assembly under test. - - - - - Gets the message sink to send diagnostic messages to. - - - - - Gets the disposal tracker for the test framework discoverer. - - - - - Gets the source information provider. - - - - - Override to create a test framework discoverer that can be used to discover - tests when the user asks to run all test. - - The test framework discoverer - - - - - - - - - - - - - - - - Override to run test cases. - - The test cases to be run. - The message sink to report run status to. - The user's requested execution options. - - - - This class proxies for the real implementation of , based on - whether the user has overridden the choice via . If - no attribute is found, defaults to . - - - - - Initializes a new instance of the class. - - The test assembly (expected to implement ). - The source information provider (expected to implement ). - The diagnostic message sink (expected to implement ). - - - - Gets the test framework that's being wrapped by the proxy. - - - - - - - - - - - - - - - - - INTERNAL CLASS. DO NOT USE. - - - - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test class - The test method - - - - - - - - - - - - - - - - An implementation of for . - Compares the names of the methods. - - - - - The singleton instance of the comparer. - - - - - - - - - - - A base class implementation of which is based on test cases being - related directly to test methods. - - - - - Used for de-serialization. - - - - - Initializes a new instance of the class. - - Default method display to use (when not customized). - The test method this test case belongs to. - The arguments for the test method. - - - - Returns the base display name for a test ("TestClassName.MethodName"). - - - - - Returns the default method display to use (when not customized). - - - - - - - - - - - Gets the generic types that were used to close the generic test method, if - applicable; null, if the test method was not an open generic. - - - - - - - - - - - - - - - - - - - - - - - - - - Call to ensure the object is fully initialized(). - - - - - Gets the unique ID for the test case. - - - - Converts an array of bytes to its hexadecimal value as a string. - The bytes. - A string containing the hexademical representation of the provided bytes. - - - Gets a hexademical digit character from the 4-bit value. - A value in the range [0, 15]. - A character in the range ['0','9'] or ['a','f']. - - - - Called when initializing the test cases, either after constructor or de-serialization. - Override this method to add additional initialization-time work. - - - - - - - - - - - Default implementation of . - - - - - Gets the output provided by the test. - - - - - Initialize the test output helper with information about a test case. - - - - - Resets the test output helper to its uninitialized state. - - - - - - - - - - - Implementation of that supports finding test cases - on methods decorated with . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Creates a test case for a single row of data. By default, returns an instance of - with the data row inside of it. - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The row of data for this test case. - The test case - - - - Creates a test case for a skipped theory. By default, returns an instance of - (which inherently discovers the skip reason via the fact attribute). - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The skip reason that decorates . - The test case - - - - Creates a test case for the entire theory. This is used when one or more of the theory data items - are not serializable, or if the user has requested to skip theory pre-enumeration. By default, - returns an instance of , which performs the data discovery at runtime. - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The test case - - - - Discover test cases from a test method. - - - This method performs the following steps: - - If the theory attribute is marked with Skip, returns the single test case from ; - - If pre-enumeration is off, or any of the test data is non serializable, returns the single test case from ; - - If there is no theory data, returns a single test case of with the error in it; - - Otherwise, it returns one test case per data row, created by calling . - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - Returns zero or more test cases represented by the test method. - - - - An implementation of for xUnit v2. - - - - - Initializes a new instance of the class. - - The test case this test belongs to. - The display name for this test. - - - - - - - Gets the xUnit v2 test case. - - - - - - - - Default implementation of for xUnit v2 that supports tests decorated with - both and . - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The test method this test case belongs to. - The arguments for the test method. - - - - Gets the display name for the test case. Calls - with the given base display name (which is itself either derived from , - falling back to . - - The fact attribute the decorated the test case. - The base display name from . - The display name for the test case. - - - - Gets the skip reason for the test case. By default, pulls the skip reason from the - property. - - The fact attribute the decorated the test case. - The skip reason, if skipped; null, otherwise. - - - - - - - - - - The implementation of that supports discovery and - execution of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - - - - - - - The implementation of that supports discovery - of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Gets the display name of the xUnit.net v2 test framework. - - - - - Initializes a new instance of the class. - - The test assembly. - The source information provider. - The message sink used to send diagnostic messages - The test collection factory used to look up test collections. - - - - Gets the test collection factory that makes test collections. - - - - - - - - Finds the tests on a test method. - - The test method. - Set to true to indicate that source information should be included. - The message bus to report discovery messages to. - The options used by the test framework during discovery. - Return true to continue test discovery, false, otherwise. - - - - - - - Gets the test case discover instance for the given discoverer type. The instances are cached - and reused, since they should not be stateful. - - The discoverer type. - Returns the test case discoverer instance. - - - - The implementation of that supports execution - of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Initializes a new instance of the class. - - Name of the test assembly. - The source line number information provider. - The message sink to report diagnostic messages to. - - - - Gets the test assembly that contains the test. - - - - - - - - - - - Represents a test case which runs multiple tests for theory data, either because the - data was not enumerable or because the data was not serializable. - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The method under test. - - - - - - - An implementation of which runs work on custom threads - rather than in the thread pool, and limits the number of in-flight actions. - - - - - Initializes a new instance of the class. - - The maximum number of tasks to run at any one time. - - - - Gets a flag indicating whether maximum concurrency is supported. - - - - - - - - - - - - - - This is an internal class, and is not intended to be called from end-user code. - - - - - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. - - - - - Initializes a new instance of the class. - - The message bus to delegate to. - The callback to send messages to. - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. In addition, - it issues a event when a message of the type - is seen. - - The type of the T final message. - - - - Initializes a new instance of the class. - - The message bus to delegate to. - The callback to send messages to. - - - - The final message that was seen that caused to be triggered. - - - - - An event that is triggered when a message of type is seen. - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. - - - - - Initializes a new instance of the class. - - The inner message sink. - The callback. - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. In addition, - it issues a event when a message of the type - is seen. - - The type of the T final message. - - - - Initializes a new instance of the class. - - The inner message sink. - The callback. - - - - The final message that was seen that caused to be triggered. - - - - - An event that is triggered when a message of type is seen. - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The assembly to be wrapped. - - - - Initializes a new instance of the class. - - The assembly to be wrapped. - - - - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The attribute to be wrapped. - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The method to be wrapped. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The parameter to be wrapped. - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The type to wrap. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Wrapper to implement types from xunit.abstractions.dll using reflection. - - - - - Converts arguments into their target types. Can be particularly useful when pulling attribute - constructor arguments, whose types may not strictly match the parameter types. - - The arguments to be converted. - The target types for the conversion. - The converted arguments. - - - - Converts an into an . - - The assembly to wrap. - The wrapper - - - - Converts an into an using reflection. - - The attribute to wrap. - The wrapper - - - - Converts a into an using reflection. - - The method to wrap - The wrapper - - - - Converts a into an using reflection. - - THe parameter to wrap - The wrapper - - - - Converts a into an using reflection. - - The type to wrap - The wrapper - - - - This is an internal class, and is not intended to be called from end-user code. - - - - - - - - - - - - - - Represents an exception that happened during the process of a test class. This typically - means there were problems identifying the correct test class constructor, or problems - creating the fixture data for the test class. - - - - - Initializes a new instance of the class. - - The exception message. - - - - The implementation of that supports attributes - of type . - - - - - - - - A helper class to retrieve the traits from a method. - - - - - Get the traits from a method. - - The method to get the traits for. - A list of traits that are defined on the method. - - - - Extension methods for . - - - - - Formulates the extended portion of the display name for a test method. For tests with no arguments, this will - return just the base name; for tests with arguments, attempts to format the arguments and appends the argument - list to the test name. - - The test method - The base part of the display name - The test method arguments - The test method's generic types - The full display name for the test method - - - - Resolves a generic type for a test method. The test parameters (and associated parameter infos) are - used to determine the best matching generic type for the test method that can be satisfied by all - the generic parameters and their values. - - The generic type to be resolved - The parameter values being passed to the test method - The parameter infos for the test method - The best matching generic type - - - - Resolves all the generic types for a test method. The test parameters are used to determine - the best matching generic types for the test method that can be satisfied by all - the generic parameters and their values. - - The test method - The parameter values being passed to the test method - The best matching generic types - - - base implementation of MD4 family style digest as outlined in - "Handbook of Applied Cryptography", pages 344 - 347. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - implementation of SHA-1 as outlined in "Handbook of Applied Cryptography", pages 346 - 349. - - It is interesting to ponder why the, apart from the extra IV, the other difference here from MD5 - is the "endianness" of the word processing! - - - - - - - Copy constructor. This will copy the state of the provided - message digest. - - - - - - - - - - - - reset the chaining variables - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of and . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message to send - - - - Initializes a new instance of the class. - - The format of the message to send - The arguments used to format the message - - - - - - - Default implementation of . - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Gets the substitution token used as assembly name suffix to indicate that the assembly is - a generalized reference to the platform-specific assembly. - - - - - A mirror class of the CLR's class. - - - - - Initializes a new instance of the class. - - The data to copy into the serialization info - - - - - - - - - - - - - Returns BASE64 encoded string that represents the entirety of the data. - - - - - Returns a triple for a key/value pair of data in a complex object - - The triple to be serialized - The serialized version of the triple - - - - Returns the triple values out of a serialized triple. - - The serialized triple - The de-serialized triple - - - - De-serializes a value that was serialized with . - - The type of the object to de-serialize into - The serialized value - The de-serialized object - - - - Serializes an object. - - The value to be serialized - The serialized object - - - - Represents a triple of information used when serializing complex types: the property name, - the value to be serialized, and the value's type. - - - - - Gets the triple's key - - - - - Gets the triple's value - - - - - Gets the triple's value type - - - - - Initializes a new instance of the class. - - The triple's key - The triple's value - The triple's value type - - - - Guard class, used for guard clauses and argument validation - - - - - - - - - - - - - - Methods which help bridge and contain the differences between Type and TypeInfo. - - - - - This class represents utility methods needed to supplement the - reflection capabilities provided by the CLR - - - - - Creates an instance of the test class for the given test case. Sends the - and messages as appropriate. - - The test - The type of the test class - The constructor arguments for the test class - The message bus used to send the test messages - The timer used to measure the time taken for construction - The cancellation token source - - - - - Disposes the test class instance. Sends the and - messages as appropriate. - - The test - The test class instance to be disposed - The message bus used to send the test messages - The timer used to measure the time taken for construction - The cancellation token source - - - - Gets methods in the target type that match the protection level of the supplied method - - The type - The method - The reflection method informations that match - - - - Gets all the custom attributes for the given assembly. - - The assembly - The type of the attribute - The matching attributes that decorate the assembly - - - - Gets all the custom attributes for the given attribute. - - The attribute - The type of the attribute to find - The matching attributes that decorate the attribute - - - - Gets all the custom attributes for the method that are of the given type. - - The method - The type of the attribute - The matching attributes that decorate the method - - - - Gets all the custom attributes for the given type. - - The type - The type of the attribute - The matching attributes that decorate the type - - - - Converts an into a , if possible (for example, this - will not work when the test method is based on source code rather than binaries). - - The method to convert - The runtime method, if available; null, otherwise - - - - Converts an into a , if possible (for example, this - will not work when the test class is based on source code rather than binaries). - - The type to convert - The runtime type, if available, null, otherwise - - - - Extension methods for reading and . - - - - - Gets a flag that determines whether diagnostic messages will be emitted. - - - - - Gets a flag that determines whether diagnostic messages will be emitted. If the flag is not present, - returns the default value (false). - - - - - Gets a flag that determines the default display name format for test methods. - - - - - Gets a flag that determines the default display name format for test methods. If the flag is not present, - returns the default value (). - - - - - Gets a flag that determines whether theories are pre-enumerated. If they enabled, then the - discovery system will return a test case for each row of test data; they are disabled, then the - discovery system will return a single test case for the theory. - - - - - Gets a flag that determines whether theories are pre-enumerated. If they enabled, then the - discovery system will return a test case for each row of test data; they are disabled, then the - discovery system will return a single test case for the theory. If the flag is not present, - returns the default value (true). - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - If the flag is not set, returns the default value (false). - - - - - Gets a flag that determines whether diagnostic messages will be emitted. - - - - - Gets a flag that determines whether diagnostic messages will be emitted. If the flag is not - present, returns the default value (false). - - - - - Gets a flag to disable parallelization. - - - - - Gets a flag to disable parallelization. If the flag is not present, returns the - default value (false). - - - - - Gets the maximum number of threads to use when running tests in parallel. - - - - - Gets the maximum number of threads to use when running tests in parallel. If set to 0 (or not set), - the value of is used; if set to a value less - than 0, does not limit the number of threads. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - If the flag is not set, returns the default value (false). - - - - diff --git a/packages/xunit.extensibility.execution.2.1.0/lib/monoandroid/xunit.execution.dotnet.dll b/packages/xunit.extensibility.execution.2.1.0/lib/monoandroid/xunit.execution.dotnet.dll deleted file mode 100644 index 3c43440..0000000 Binary files a/packages/xunit.extensibility.execution.2.1.0/lib/monoandroid/xunit.execution.dotnet.dll and /dev/null differ diff --git a/packages/xunit.extensibility.execution.2.1.0/lib/monoandroid/xunit.execution.dotnet.xml b/packages/xunit.extensibility.execution.2.1.0/lib/monoandroid/xunit.execution.dotnet.xml deleted file mode 100644 index d819501..0000000 --- a/packages/xunit.extensibility.execution.2.1.0/lib/monoandroid/xunit.execution.dotnet.xml +++ /dev/null @@ -1,4157 +0,0 @@ - - - - xunit.execution.dotnet - - - - - Rethrows an exception object without losing the existing stack trace information - - The exception to re-throw. - - For more information on this technique, see - http://www.dotnetjunkies.com/WebLog/chris.taylor/archive/2004/03/03/8353.aspx. - The remote_stack_trace string is here to support Mono. - - - - - Unwraps an exception to remove any wrappers, like . - - The exception to unwrap. - The unwrapped exception. - - - - Utility classes for dealing with Exception objects. - - - - - Combines multiple levels of messages into a single message. - - The failure information from which to get the messages. - The combined string. - - - - Combines multiple levels of stack traces into a single stack trace. - - The failure information from which to get the stack traces. - The combined string. - - - - Unwraps exceptions and their inner exceptions. - - The exception to be converted. - The failure information. - - - - An implementation of that ignores all messages. - - - - - - - - Serializes and de-serializes objects - - - - - De-serializes an object. - - The type of the object - The object's serialized value - The de-serialized object - - - - Serializes an object. - - The value to serialize - The serialized value - - - Gets whether the specified is serializable with . - The object to test for serializability. - true if the object can be serialized; otherwise, false. - - - - Converts an assembly qualified type name into a object. - - The assembly qualified type name. - The instance of the , if available; null, otherwise. - - - - Converts an assembly name + type name into a object. - - The assembly name. - The type name. - The instance of the , if available; null, otherwise. - - - - Gets an assembly qualified type name for serialization, with special dispensation for types which - originate in the execution assembly. - - - - - Retrieves a substring from the string, with whitespace trimmed on both ends. - - The string. - The starting index. - The length. - - A substring starting no earlier than startIndex and ending no later - than startIndex + length. - - - - - Default implementation of . - - - - - - - - - - - - - - - - - An implementation of that provides several Visit methods that - can provide access to specific message types without the burden of casting. - - - - - Dispatches the message to the given callback, if it's of the correct type. - - The message type - The message - The callback - The result of the callback, if called; true, otherwise - - - - Dispatches the message to the given callback, if it's of the correct type. - The callback is provided with both the message and this instance of the visitor. - - The message type - The message - The callback - The result of the callback, if called; true, otherwise - - - - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering/executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - An implementation of that provides several Visit methods that - can provide access to specific message types without the burden of casting. It also records - when it sees a completion message, and sets the event appropriately. - - The type of the completion message. - - - - Initializes a new instance of the class. - - - - - This event is triggered when the completion message has been seen. - - - - - - - - - - - Formats arguments for display in theories. - - - - - Format the value for presentation. - - The value to be formatted. - The formatted value. - - - - Default implementation of used by the xUnit.net equality assertions. - - The type that is being compared. - - - - Initializes a new instance of the class. - - Set to true to skip type equality checks. - The inner comparer to be used when the compared objects are enumerable. - - - - - - - - - - A class that wraps to create . - - The type that is being compared. - - - - Initializes a new instance of the class. - - The comparer that is being adapted. - - - - - - - - - - Base class for all long-lived objects that may cross over an AppDomain. - - - - - Creates a new instance of the type. - - - - - Disconnects all remote objects. - - - - - This implementation of allows the developer to track the count - of outstanding "async void" operations, and wait for them all to complete. - - - - - Initializes a new instance of the class. - - The existing synchronization context (may be null). - - - - - - - - - - - - - - - - Returns a task which is signaled when all outstanding operations are complete. - - - - - Default implementation of . Orders tests in - an unpredictable but stable order, so that repeated test runs of the - identical test assembly run tests in the same order. - - - - - Initializes a new instance of the class. - - Message sink to report diagnostic messages to - - - - - - - Default implementation of . Orders tests in - an unpredictable and unstable order, so that repeated test runs of the - identical test assembly run test collections in a random order. - - - - - - - - Tracks disposable objects, and disposes them in the reverse order they were added to - the tracker. - - - - - Add an object to be disposed. - - The object to be disposed. - - - - - - - Represents a caching factory for the types used for extensibility throughout the system. - - - - - Disposes the instances that are contained in the cache. - - - - - Gets an instance of the given type, casting it to , using the provided - constructor arguments. There is a single instance of a given type that is cached and reused, - so classes retrieved from this factory must be stateless and thread-safe. - - The interface type. - The message sink used to send diagnostic messages - The implementation type. - The constructor arguments. Since diagnostic message sinks are optional, - the code first looks for a type that takes the given arguments plus the message sink, and only - falls back to the message sink-less constructor if none was found. - The instance of the type. - - - - Gets a data discoverer. - - The message sink used to send diagnostic messages - The discoverer type - - - - Gets a data discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The data discoverer attribute - The data discoverer, if the type is loadable; null, otherwise. - - - - Gets a test case orderer. - - The message sink used to send diagnostic messages - The test case orderer type - - - - Gets a test case orderer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test case orderer attribute. - The test case orderer, if the type is loadable; null, otherwise. - - - - Gets a test collection orderer. - - The message sink used to send diagnostic messages - The test collection orderer type - - - - Gets a test collection orderer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test collection orderer attribute. - The test collection orderer, if the type is loadable; null, otherwise. - - - - Gets a test framework discoverer. - - The message sink used to send diagnostic messages - The test framework type discoverer type - - - - Gets a test framework discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test framework discoverer attribute - - - - Gets a trait discoverer. - - The message sink used to send diagnostic messages - The trait discoverer type - - - - Gets a trait discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The trait discoverer attribute. - The trait discoverer, if the type is loadable; null, otherwise. - - - - Gets an xUnit.net v2 test discoverer. - - The message sink used to send diagnostic messages - The test case discoverer type - - - - Gets an xUnit.net v2 test collection factory. - - The message sink used to send diagnostic messages - The test collection factory type - The test assembly under test - - - - Gets an xUnit.net v2 test collection factory, as specified in a reflected . - - The message sink used to send diagnostic messages - The collection behavior attribute. - The test assembly. - The collection factory. - - - - Implementation of that creates a single - default test collection for the assembly, and places any tests classes without - the into it. - - - - - Initializes a new instance of the class. - - The assembly. - The message sink used to send diagnostic messages - - - - - - - - - - Implementation of which creates a new test - collection for each test class that isn't decorated with . - - - - - Initializes a new instance of the class. - - The assembly info. - The message sink used to send diagnostic messages - - - - - - - - - - A simple implementation of that can be used to report an error - rather than running a test. - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The test method. - The error message to report for the test. - - - - Gets the error message that will be display when the test is run. - - - - - - - - - - - - - - Measures and aggregates execution time of one or more actions. - - - - - Returns the total time aggregated across all the actions. - - - - - Executes an action and aggregates its run time into the total. - - The action to measure. - - - - Executes an asynchronous action and aggregates its run time into the total. - - The action to measure. - - - - Aggregates a time span into the total time. - - The time to add. - - - - Implementation of that supports finding test cases - on methods decorated with . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Creates a single for the given test method. - - The discovery options to be used. - The test method. - The attribute that decorates the test method. - - - - - Discover test cases from a test method. By default, inspects the test method's argument list - to ensure it's empty, and if not, returns a single ; - otherwise, it returns the result of calling . - - The discovery options to be used. - The test method the test cases belong to. - The fact attribute attached to the test method. - Returns zero or more test cases represented by the test method. - - - - An implementation of to support . - - - - - Initializes a new instance of the class. - - The test case that the lambda represents. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - - - - A base class that provides default behavior when running tests in an assembly. It groups the tests - by test collection, and then runs the individual test collections. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The assembly that contains the tests to be run. - The test cases to be run. - The message sink to report diagnostic messages to. - The message sink to report run status to. - The user's requested execution options. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the user's requested execution options. - - - - - Gets or sets the message sink to report diagnostic messages to. - - - - - Gets or sets the message sink to report run status to. - - - - - Gets or sets the assembly that contains the tests to be run. - - - - - Gets or sets the test case orderer that will be used to decide how to order the tests. - - - - - Gets or sets the test collection orderer that will be used to decide how to order the test collections. - - - - - Gets or sets the test cases to be run. - - - - - - - - Override this to provide the display name for the test framework (f.e., "xUnit.net 2.0"). - This value is placed into . - - - - - Override this to provide the environment information (f.e., "32-bit .NET 4.0"). This value is - placed into . - - - - - This method is called just after is sent, but before any test collections are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Creates the message bus to be used for test execution. By default, it inspects - the options for the - flag, and if present, creates a message bus that ensures all messages are delivered - on the same thread. - - The message bus. - - - - Orders the test collections using the . - - Test collections (and the associated test cases) in run order - - - - Runs the tests in the test assembly. - - Returns summary information about the tests that were run. - - - - Runs the list of test collections. By default, groups the tests by collection and runs them synchronously. - - The message bus to report run status to. - The task cancellation token source, used to cancel the test run. - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test collection. - - The message bus to report run status to. - The test collection that is being run. - The test cases to be run. - The task cancellation token source, used to cancel the test run. - Returns summary information about the tests that were run. - - - - A base class that provides default behavior when running test cases. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test case to be run. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case to be run. - - - - - This method is called just after is sent, but before any test collections are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test case. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test method. - - Returns summary information about the tests that were run. - - - - A base class that provides default behavior when running tests in a test class. It groups the tests - by test method, and then runs the individual test methods. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test class to be run. - The test class that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the CLR class that contains the tests to be run. - - - - - Gets the message sink used to send diagnostic messages. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case orderer that will be used to decide how to order the test. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test class to be run. - - - - - Creates the arguments for the test class constructor. Attempts to resolve each parameter - individually, and adds an error when the constructor arguments cannot all be provided. - If the class is static, does not look for constructor, since one will not be needed. - - The test class constructor arguments. - - - - Gets the message to be used when the constructor is missing arguments. - - - - - This method is called just after is sent, but before any test methods are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test class. - - Returns summary information about the tests that were run. - - - - Runs the list of test methods. By default, orders the tests, groups them by method and runs them synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test method. - - The test method that contains the test cases. - The CLR method that contains the tests to be run. - The test cases to be run. - The constructor arguments that will be used to create the test class. - Returns summary information about the tests that were run. - - - - Selects the constructor to be used for the test class. By default, chooses the parameterless - constructor. Override to change the constructor selection logic. - - The constructor to be used for creating the test class. - - - - Tries to supply a test class constructor argument. By default, always fails. Override to - change the argument lookup logic. - - The constructor that will be used to create the test class. - The parameter index. - The parameter information. - The argument value that should be used for the parameter. - Returns true if the argument was supplied; false, otherwise. - - - - A base class that provides default behavior when running tests in a test collection. It groups the tests - by test class, and then runs the individual test classes. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test collection that contains the tests to be run. - The test cases to be run. - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case orderer that will be used to decide how to order the test. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test collection that contains the tests to be run. - - - - - This method is called just after is sent, but before any test classes are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test collection. - - Returns summary information about the tests that were run. - - - - Runs the list of test classes. By default, groups the tests by class and runs them synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test class. - - The test class to be run. - The CLR class that contains the tests to be run. - The test cases to be run. - Returns summary information about the tests that were run. - - - - A base class that provides default behavior to invoke a test method. This includes - support for async test methods (both "async Task" and "async void") as well as - creation and disposal of the test class. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the constructor arguments used to construct the test class. - - - - - Gets the display name of the invoked test. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test to be run. - - - - - Gets the test case to be run. - - - - - Gets or sets the runtime type of the class that contains the test method. - - - - - Gets or sets the runtime method of the method that contains the test. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - Gets or sets the object which measures execution time. - - - - - Creates the test class, unless the test method is static or there have already been errors. Note that - this method times the creation of the test class (using ). It is also responsible for - sending the and - messages, so if you override this method without calling the base, you are responsible for all of this behavior. - This method should NEVER throw; any exceptions should be placed into the . - - The class instance, if appropriate; null, otherwise - - - - This method is called just after the test method has finished executing. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before the test method is invoked. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method calls the test method via reflection. This is an available override point - if you need to do some other form of invocation of the actual test method. - - The instance of the test class - The return value from the test method invocation - - - - Creates the test class (if necessary), and invokes the test method. - - Returns the time (in seconds) spent creating the test class, running - the test, and disposing of the test class. - - - - Invokes the test method on the given test class instance. This method sets up support for "async void" - test methods, ensures that the test method has the correct number of arguments, then calls - to do the actual method invocation. It ensure that any async test method is fully completed before returning, and - returns the measured clock time that the invocation took. - - The test class instance - Returns the time taken to invoke the test method - - - - A base class that provides default behavior when running tests in a test method. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test method under test. - The CLR class that contains the test method. - The CLR method that contains the tests to be run. - The test cases to be run. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the CLR class that contains the test method. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the CLR method that contains the tests to be run. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test method that contains the test cases. - - - - - This method is called just after is sent, but before any test cases are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test method. - - Returns summary information about the tests that were run. - - - - Runs the list of test cases. By default, it runs the cases in order, synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run an individual test case. - - The test case to be run. - Returns summary information about the test case run. - - - - A base class that provides default behavior when running a test. This includes support - for skipping tests. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The skip reason, if the test is to be skipped. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the constructor arguments used to construct the test class. - - - - - Gets or sets the display name of the invoked test. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the skip reason for the test, if set. - - - - - Gets or sets the test to be run. - - - - - Gets the test case to be run. - - - - - Gets or sets the runtime type of the class that contains the test method. - - - - - Gets or sets the runtime method of the method that contains the test. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - This method is called just after is sent, but before the test class is created. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the test. - - Returns summary information about the test that was run. - - - - Override this method to invoke the test. - - The exception aggregator used to run code and collect exceptions. - Returns a tuple which includes the execution time (in seconds) spent running the - test method, and any output that was returned by the test. - - - - The test assembly runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The assembly that contains the tests to be run. - The test cases to be run. - The message sink to report diagnostic messages to. - The message sink to report run status to. - The user's requested execution options. - - - - - - - - - - - - - Gets the synchronization context used when potentially running tests in parallel. - If is greater than 0, it creates - and uses an instance of . - - The maximum number of parallel threads. - - - - Ensures the assembly runner is initialized (sets up the collection behavior, - parallelization options, and test orderers from their assembly attributes). - - - - - - - - - - - - - - - - - The test case runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test case to be run. - The display name of the test case. - The skip reason, if the test is to be skipped. - The arguments to be passed to the test class constructor. - The arguments to be passed to the test method. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s that will be used for this test case. - - - - - Gets or sets the arguments passed to the test class constructor - - - - - Gets or sets the display name of the test case - - - - - Gets or sets the skip reason for the test, if set. - - - - - Gets or sets the runtime type for the test class that the test method belongs to. - - - - - Gets of sets the runtime method for the test method that the test case belongs to. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - - - - The test class runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test class to be run. - The test class that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - The mapping of collection fixture types to fixtures. - - - - Gets the fixture mappings that were created during . - - - - - Creates the instance of a class fixture type to be used by the test class. If the fixture can be created, - it should be placed into the dictionary; if it cannot, then the method - should record the error by calling Aggregator.Add. - - The type of the fixture to be created - - - - - - - - - - - - - - - - - - - - - - The test collection runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test collection that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the fixture mappings that were created during . - - - - - - - - - - - Creates the instance of a collection fixture type to be used by the test collection. If the fixture can be created, - it should be placed into the dictionary; if it cannot, then the method - should record the error by calling Aggregator.Add. - - The type of the fixture to be created - - - - Gives an opportunity to override test case orderer. By default, this method gets the - orderer from the collection definition. If this function returns null, the - test case orderer passed into the constructor will be used. - - - - - - - - The test invoker for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The list of s for this test invocation. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s for this test invocation. - - - - - - - - - - - The test method runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test method to be run. - The test class that contains the test method. - The test method that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages to. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - The constructor arguments for the test class. - - - - - - - The test runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The skip reason, if the test is to be skipped. - The list of s for this test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s for this test. - - - - - - - - Override this method to invoke the test method. - - The exception aggregator used to run code and collect exceptions. - Returns the execution time (in seconds) spent running the test method. - - - - The test case runner for xUnit.net v2 theories (which could not be pre-enumerated; - pre-enumerated test cases use ). - - - - - Initializes a new instance of the class. - - The test case to be run. - The display name of the test case. - The skip reason, if the test is to be skipped. - The arguments to be passed to the test class constructor. - The message sink used to send diagnostic messages - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test assembly. - The optional configuration filename (defaults to the - configuration file of the current app domain if not provided) - The version number of the assembly (defaults to "0.0.0.0") - - - - - - - - - - Gets or sets the assembly version. - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test collection the class belongs to - The test class - - - - - - - - - - - - - - - - An implementation of for . - Compares the fully qualified names of the types. - - - - - The singleton instance of the comparer. - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test assembly the collection belongs to - The optional type which contains the collection definition - The display name for the test collection - - - - - - - - - - - - - - - - - - - - - - An implementation of for . - Compares the IDs of the test collections. - - - - - The singleton instance of the comparer. - - - - - - - - - - - A helper class that gets the list of test collection definitions for a given assembly. - Reports any misconfigurations of the test assembly via the diagnostic message sink. - - - - - Gets the test collection definitions for the given assembly. - - The assembly. - The message sink used to send diagnostic messages - A list of mappings from test collection name to test collection definitions (as - - - - A default implementation of that tracks objects to be - disposed when the framework is disposed. The discoverer and executor are automatically - tracked for disposal, since those interfaces mandate an implementation of . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Gets the message sink used to send diagnostic messages. - - - - - Gets the disposal tracker for the test framework. - - - - - - - - - - - Override this method to provide the implementation of . - - The assembly that is being discovered. - Returns the test framework discoverer. - - - - Override this method to provide the implementation of . - - The assembly that is being executed. - Returns the test framework executor. - - - - - - - - - - A base implementation of that supports test filtering - and runs the discovery process on a thread pool thread. - - - - - Initializes a new instance of the class. - - The test assembly. - The source information provider. - The message sink used to send diagnostic messages - - - - Gets the assembly that's being discovered. - - - - - Gets the message sink used to report diagnostic messages. - - - - - Gets the disposal tracker for the test framework discoverer. - - - - - Get the source code information provider used during discovery. - - - - - - - - - - - Implement this method to create a test class for the given CLR type. - - The CLR type. - The test class. - - - - - - - - - - - - - Core implementation to discover unit tests in a given test class. - - The test class. - Set to true to attempt to include source information. - The message sink to send discovery messages to. - The options used by the test framework during discovery. - Returns true if discovery should continue; false otherwise. - - - - Determines if a type should be used for discovery. Can be used to filter out types that - are not desirable. The default implementation filters out abstract (non-static) classes. - - The type. - Returns true if the type can contain tests; false, otherwise. - - - - Reports a discovered test case to the message bus, after updating the source code information - (if desired). - - - - - - - - - - - - A reusable implementation of which contains the basic behavior - for running tests. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - Name of the test assembly. - The source line number information provider. - The message sink to report diagnostic messages to. - - - - Gets the assembly information of the assembly under test. - - - - - Gets the message sink to send diagnostic messages to. - - - - - Gets the disposal tracker for the test framework discoverer. - - - - - Gets the source information provider. - - - - - Override to create a test framework discoverer that can be used to discover - tests when the user asks to run all test. - - The test framework discoverer - - - - - - - - - - - - - - - - Override to run test cases. - - The test cases to be run. - The message sink to report run status to. - The user's requested execution options. - - - - This class proxies for the real implementation of , based on - whether the user has overridden the choice via . If - no attribute is found, defaults to . - - - - - Initializes a new instance of the class. - - The test assembly (expected to implement ). - The source information provider (expected to implement ). - The diagnostic message sink (expected to implement ). - - - - Gets the test framework that's being wrapped by the proxy. - - - - - - - - - - - - - - - - - INTERNAL CLASS. DO NOT USE. - - - - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test class - The test method - - - - - - - - - - - - - - - - An implementation of for . - Compares the names of the methods. - - - - - The singleton instance of the comparer. - - - - - - - - - - - A base class implementation of which is based on test cases being - related directly to test methods. - - - - - Used for de-serialization. - - - - - Initializes a new instance of the class. - - Default method display to use (when not customized). - The test method this test case belongs to. - The arguments for the test method. - - - - Returns the base display name for a test ("TestClassName.MethodName"). - - - - - Returns the default method display to use (when not customized). - - - - - - - - - - - Gets the generic types that were used to close the generic test method, if - applicable; null, if the test method was not an open generic. - - - - - - - - - - - - - - - - - - - - - - - - - - Call to ensure the object is fully initialized(). - - - - - Gets the unique ID for the test case. - - - - Converts an array of bytes to its hexadecimal value as a string. - The bytes. - A string containing the hexademical representation of the provided bytes. - - - Gets a hexademical digit character from the 4-bit value. - A value in the range [0, 15]. - A character in the range ['0','9'] or ['a','f']. - - - - Called when initializing the test cases, either after constructor or de-serialization. - Override this method to add additional initialization-time work. - - - - - - - - - - - Default implementation of . - - - - - Gets the output provided by the test. - - - - - Initialize the test output helper with information about a test case. - - - - - Resets the test output helper to its uninitialized state. - - - - - - - - - - - Implementation of that supports finding test cases - on methods decorated with . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Creates a test case for a single row of data. By default, returns an instance of - with the data row inside of it. - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The row of data for this test case. - The test case - - - - Creates a test case for a skipped theory. By default, returns an instance of - (which inherently discovers the skip reason via the fact attribute). - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The skip reason that decorates . - The test case - - - - Creates a test case for the entire theory. This is used when one or more of the theory data items - are not serializable, or if the user has requested to skip theory pre-enumeration. By default, - returns an instance of , which performs the data discovery at runtime. - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The test case - - - - Discover test cases from a test method. - - - This method performs the following steps: - - If the theory attribute is marked with Skip, returns the single test case from ; - - If pre-enumeration is off, or any of the test data is non serializable, returns the single test case from ; - - If there is no theory data, returns a single test case of with the error in it; - - Otherwise, it returns one test case per data row, created by calling . - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - Returns zero or more test cases represented by the test method. - - - - An implementation of for xUnit v2. - - - - - Initializes a new instance of the class. - - The test case this test belongs to. - The display name for this test. - - - - - - - Gets the xUnit v2 test case. - - - - - - - - Default implementation of for xUnit v2 that supports tests decorated with - both and . - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The test method this test case belongs to. - The arguments for the test method. - - - - Gets the display name for the test case. Calls - with the given base display name (which is itself either derived from , - falling back to . - - The fact attribute the decorated the test case. - The base display name from . - The display name for the test case. - - - - Gets the skip reason for the test case. By default, pulls the skip reason from the - property. - - The fact attribute the decorated the test case. - The skip reason, if skipped; null, otherwise. - - - - - - - - - - The implementation of that supports discovery and - execution of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - - - - - - - The implementation of that supports discovery - of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Gets the display name of the xUnit.net v2 test framework. - - - - - Initializes a new instance of the class. - - The test assembly. - The source information provider. - The message sink used to send diagnostic messages - The test collection factory used to look up test collections. - - - - Gets the test collection factory that makes test collections. - - - - - - - - Finds the tests on a test method. - - The test method. - Set to true to indicate that source information should be included. - The message bus to report discovery messages to. - The options used by the test framework during discovery. - Return true to continue test discovery, false, otherwise. - - - - - - - Gets the test case discover instance for the given discoverer type. The instances are cached - and reused, since they should not be stateful. - - The discoverer type. - Returns the test case discoverer instance. - - - - The implementation of that supports execution - of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Initializes a new instance of the class. - - Name of the test assembly. - The source line number information provider. - The message sink to report diagnostic messages to. - - - - Gets the test assembly that contains the test. - - - - - - - - - - - Represents a test case which runs multiple tests for theory data, either because the - data was not enumerable or because the data was not serializable. - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The method under test. - - - - - - - An implementation of which runs work on custom threads - rather than in the thread pool, and limits the number of in-flight actions. - - - - - Initializes a new instance of the class. - - The maximum number of tasks to run at any one time. - - - - Gets a flag indicating whether maximum concurrency is supported. - - - - - - - - - - - - - - This is an internal class, and is not intended to be called from end-user code. - - - - - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. - - - - - Initializes a new instance of the class. - - The message bus to delegate to. - The callback to send messages to. - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. In addition, - it issues a event when a message of the type - is seen. - - The type of the T final message. - - - - Initializes a new instance of the class. - - The message bus to delegate to. - The callback to send messages to. - - - - The final message that was seen that caused to be triggered. - - - - - An event that is triggered when a message of type is seen. - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. - - - - - Initializes a new instance of the class. - - The inner message sink. - The callback. - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. In addition, - it issues a event when a message of the type - is seen. - - The type of the T final message. - - - - Initializes a new instance of the class. - - The inner message sink. - The callback. - - - - The final message that was seen that caused to be triggered. - - - - - An event that is triggered when a message of type is seen. - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The assembly to be wrapped. - - - - Initializes a new instance of the class. - - The assembly to be wrapped. - - - - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The attribute to be wrapped. - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The method to be wrapped. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The parameter to be wrapped. - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The type to wrap. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Wrapper to implement types from xunit.abstractions.dll using reflection. - - - - - Converts arguments into their target types. Can be particularly useful when pulling attribute - constructor arguments, whose types may not strictly match the parameter types. - - The arguments to be converted. - The target types for the conversion. - The converted arguments. - - - - Converts an into an . - - The assembly to wrap. - The wrapper - - - - Converts an into an using reflection. - - The attribute to wrap. - The wrapper - - - - Converts a into an using reflection. - - The method to wrap - The wrapper - - - - Converts a into an using reflection. - - THe parameter to wrap - The wrapper - - - - Converts a into an using reflection. - - The type to wrap - The wrapper - - - - This is an internal class, and is not intended to be called from end-user code. - - - - - - - - - - - - - - Represents an exception that happened during the process of a test class. This typically - means there were problems identifying the correct test class constructor, or problems - creating the fixture data for the test class. - - - - - Initializes a new instance of the class. - - The exception message. - - - - The implementation of that supports attributes - of type . - - - - - - - - A helper class to retrieve the traits from a method. - - - - - Get the traits from a method. - - The method to get the traits for. - A list of traits that are defined on the method. - - - - Extension methods for . - - - - - Formulates the extended portion of the display name for a test method. For tests with no arguments, this will - return just the base name; for tests with arguments, attempts to format the arguments and appends the argument - list to the test name. - - The test method - The base part of the display name - The test method arguments - The test method's generic types - The full display name for the test method - - - - Resolves a generic type for a test method. The test parameters (and associated parameter infos) are - used to determine the best matching generic type for the test method that can be satisfied by all - the generic parameters and their values. - - The generic type to be resolved - The parameter values being passed to the test method - The parameter infos for the test method - The best matching generic type - - - - Resolves all the generic types for a test method. The test parameters are used to determine - the best matching generic types for the test method that can be satisfied by all - the generic parameters and their values. - - The test method - The parameter values being passed to the test method - The best matching generic types - - - base implementation of MD4 family style digest as outlined in - "Handbook of Applied Cryptography", pages 344 - 347. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - implementation of SHA-1 as outlined in "Handbook of Applied Cryptography", pages 346 - 349. - - It is interesting to ponder why the, apart from the extra IV, the other difference here from MD5 - is the "endianness" of the word processing! - - - - - - - Copy constructor. This will copy the state of the provided - message digest. - - - - - - - - - - - - reset the chaining variables - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of and . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message to send - - - - Initializes a new instance of the class. - - The format of the message to send - The arguments used to format the message - - - - - - - Default implementation of . - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Gets the substitution token used as assembly name suffix to indicate that the assembly is - a generalized reference to the platform-specific assembly. - - - - - A mirror class of the CLR's class. - - - - - Initializes a new instance of the class. - - The data to copy into the serialization info - - - - - - - - - - - - - Returns BASE64 encoded string that represents the entirety of the data. - - - - - Returns a triple for a key/value pair of data in a complex object - - The triple to be serialized - The serialized version of the triple - - - - Returns the triple values out of a serialized triple. - - The serialized triple - The de-serialized triple - - - - De-serializes a value that was serialized with . - - The type of the object to de-serialize into - The serialized value - The de-serialized object - - - - Serializes an object. - - The value to be serialized - The serialized object - - - - Represents a triple of information used when serializing complex types: the property name, - the value to be serialized, and the value's type. - - - - - Gets the triple's key - - - - - Gets the triple's value - - - - - Gets the triple's value type - - - - - Initializes a new instance of the class. - - The triple's key - The triple's value - The triple's value type - - - - Guard class, used for guard clauses and argument validation - - - - - - - - - - - - - - Methods which help bridge and contain the differences between Type and TypeInfo. - - - - - This class represents utility methods needed to supplement the - reflection capabilities provided by the CLR - - - - - Creates an instance of the test class for the given test case. Sends the - and messages as appropriate. - - The test - The type of the test class - The constructor arguments for the test class - The message bus used to send the test messages - The timer used to measure the time taken for construction - The cancellation token source - - - - - Disposes the test class instance. Sends the and - messages as appropriate. - - The test - The test class instance to be disposed - The message bus used to send the test messages - The timer used to measure the time taken for construction - The cancellation token source - - - - Gets methods in the target type that match the protection level of the supplied method - - The type - The method - The reflection method informations that match - - - - Gets all the custom attributes for the given assembly. - - The assembly - The type of the attribute - The matching attributes that decorate the assembly - - - - Gets all the custom attributes for the given attribute. - - The attribute - The type of the attribute to find - The matching attributes that decorate the attribute - - - - Gets all the custom attributes for the method that are of the given type. - - The method - The type of the attribute - The matching attributes that decorate the method - - - - Gets all the custom attributes for the given type. - - The type - The type of the attribute - The matching attributes that decorate the type - - - - Converts an into a , if possible (for example, this - will not work when the test method is based on source code rather than binaries). - - The method to convert - The runtime method, if available; null, otherwise - - - - Converts an into a , if possible (for example, this - will not work when the test class is based on source code rather than binaries). - - The type to convert - The runtime type, if available, null, otherwise - - - - Extension methods for reading and . - - - - - Gets a flag that determines whether diagnostic messages will be emitted. - - - - - Gets a flag that determines whether diagnostic messages will be emitted. If the flag is not present, - returns the default value (false). - - - - - Gets a flag that determines the default display name format for test methods. - - - - - Gets a flag that determines the default display name format for test methods. If the flag is not present, - returns the default value (). - - - - - Gets a flag that determines whether theories are pre-enumerated. If they enabled, then the - discovery system will return a test case for each row of test data; they are disabled, then the - discovery system will return a single test case for the theory. - - - - - Gets a flag that determines whether theories are pre-enumerated. If they enabled, then the - discovery system will return a test case for each row of test data; they are disabled, then the - discovery system will return a single test case for the theory. If the flag is not present, - returns the default value (true). - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - If the flag is not set, returns the default value (false). - - - - - Gets a flag that determines whether diagnostic messages will be emitted. - - - - - Gets a flag that determines whether diagnostic messages will be emitted. If the flag is not - present, returns the default value (false). - - - - - Gets a flag to disable parallelization. - - - - - Gets a flag to disable parallelization. If the flag is not present, returns the - default value (false). - - - - - Gets the maximum number of threads to use when running tests in parallel. - - - - - Gets the maximum number of threads to use when running tests in parallel. If set to 0 (or not set), - the value of is used; if set to a value less - than 0, does not limit the number of threads. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - If the flag is not set, returns the default value (false). - - - - diff --git a/packages/xunit.extensibility.execution.2.1.0/lib/monotouch/xunit.execution.dotnet.dll b/packages/xunit.extensibility.execution.2.1.0/lib/monotouch/xunit.execution.dotnet.dll deleted file mode 100644 index 3c43440..0000000 Binary files a/packages/xunit.extensibility.execution.2.1.0/lib/monotouch/xunit.execution.dotnet.dll and /dev/null differ diff --git a/packages/xunit.extensibility.execution.2.1.0/lib/monotouch/xunit.execution.dotnet.xml b/packages/xunit.extensibility.execution.2.1.0/lib/monotouch/xunit.execution.dotnet.xml deleted file mode 100644 index d819501..0000000 --- a/packages/xunit.extensibility.execution.2.1.0/lib/monotouch/xunit.execution.dotnet.xml +++ /dev/null @@ -1,4157 +0,0 @@ - - - - xunit.execution.dotnet - - - - - Rethrows an exception object without losing the existing stack trace information - - The exception to re-throw. - - For more information on this technique, see - http://www.dotnetjunkies.com/WebLog/chris.taylor/archive/2004/03/03/8353.aspx. - The remote_stack_trace string is here to support Mono. - - - - - Unwraps an exception to remove any wrappers, like . - - The exception to unwrap. - The unwrapped exception. - - - - Utility classes for dealing with Exception objects. - - - - - Combines multiple levels of messages into a single message. - - The failure information from which to get the messages. - The combined string. - - - - Combines multiple levels of stack traces into a single stack trace. - - The failure information from which to get the stack traces. - The combined string. - - - - Unwraps exceptions and their inner exceptions. - - The exception to be converted. - The failure information. - - - - An implementation of that ignores all messages. - - - - - - - - Serializes and de-serializes objects - - - - - De-serializes an object. - - The type of the object - The object's serialized value - The de-serialized object - - - - Serializes an object. - - The value to serialize - The serialized value - - - Gets whether the specified is serializable with . - The object to test for serializability. - true if the object can be serialized; otherwise, false. - - - - Converts an assembly qualified type name into a object. - - The assembly qualified type name. - The instance of the , if available; null, otherwise. - - - - Converts an assembly name + type name into a object. - - The assembly name. - The type name. - The instance of the , if available; null, otherwise. - - - - Gets an assembly qualified type name for serialization, with special dispensation for types which - originate in the execution assembly. - - - - - Retrieves a substring from the string, with whitespace trimmed on both ends. - - The string. - The starting index. - The length. - - A substring starting no earlier than startIndex and ending no later - than startIndex + length. - - - - - Default implementation of . - - - - - - - - - - - - - - - - - An implementation of that provides several Visit methods that - can provide access to specific message types without the burden of casting. - - - - - Dispatches the message to the given callback, if it's of the correct type. - - The message type - The message - The callback - The result of the callback, if called; true, otherwise - - - - Dispatches the message to the given callback, if it's of the correct type. - The callback is provided with both the message and this instance of the visitor. - - The message type - The message - The callback - The result of the callback, if called; true, otherwise - - - - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering/executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - An implementation of that provides several Visit methods that - can provide access to specific message types without the burden of casting. It also records - when it sees a completion message, and sets the event appropriately. - - The type of the completion message. - - - - Initializes a new instance of the class. - - - - - This event is triggered when the completion message has been seen. - - - - - - - - - - - Formats arguments for display in theories. - - - - - Format the value for presentation. - - The value to be formatted. - The formatted value. - - - - Default implementation of used by the xUnit.net equality assertions. - - The type that is being compared. - - - - Initializes a new instance of the class. - - Set to true to skip type equality checks. - The inner comparer to be used when the compared objects are enumerable. - - - - - - - - - - A class that wraps to create . - - The type that is being compared. - - - - Initializes a new instance of the class. - - The comparer that is being adapted. - - - - - - - - - - Base class for all long-lived objects that may cross over an AppDomain. - - - - - Creates a new instance of the type. - - - - - Disconnects all remote objects. - - - - - This implementation of allows the developer to track the count - of outstanding "async void" operations, and wait for them all to complete. - - - - - Initializes a new instance of the class. - - The existing synchronization context (may be null). - - - - - - - - - - - - - - - - Returns a task which is signaled when all outstanding operations are complete. - - - - - Default implementation of . Orders tests in - an unpredictable but stable order, so that repeated test runs of the - identical test assembly run tests in the same order. - - - - - Initializes a new instance of the class. - - Message sink to report diagnostic messages to - - - - - - - Default implementation of . Orders tests in - an unpredictable and unstable order, so that repeated test runs of the - identical test assembly run test collections in a random order. - - - - - - - - Tracks disposable objects, and disposes them in the reverse order they were added to - the tracker. - - - - - Add an object to be disposed. - - The object to be disposed. - - - - - - - Represents a caching factory for the types used for extensibility throughout the system. - - - - - Disposes the instances that are contained in the cache. - - - - - Gets an instance of the given type, casting it to , using the provided - constructor arguments. There is a single instance of a given type that is cached and reused, - so classes retrieved from this factory must be stateless and thread-safe. - - The interface type. - The message sink used to send diagnostic messages - The implementation type. - The constructor arguments. Since diagnostic message sinks are optional, - the code first looks for a type that takes the given arguments plus the message sink, and only - falls back to the message sink-less constructor if none was found. - The instance of the type. - - - - Gets a data discoverer. - - The message sink used to send diagnostic messages - The discoverer type - - - - Gets a data discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The data discoverer attribute - The data discoverer, if the type is loadable; null, otherwise. - - - - Gets a test case orderer. - - The message sink used to send diagnostic messages - The test case orderer type - - - - Gets a test case orderer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test case orderer attribute. - The test case orderer, if the type is loadable; null, otherwise. - - - - Gets a test collection orderer. - - The message sink used to send diagnostic messages - The test collection orderer type - - - - Gets a test collection orderer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test collection orderer attribute. - The test collection orderer, if the type is loadable; null, otherwise. - - - - Gets a test framework discoverer. - - The message sink used to send diagnostic messages - The test framework type discoverer type - - - - Gets a test framework discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test framework discoverer attribute - - - - Gets a trait discoverer. - - The message sink used to send diagnostic messages - The trait discoverer type - - - - Gets a trait discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The trait discoverer attribute. - The trait discoverer, if the type is loadable; null, otherwise. - - - - Gets an xUnit.net v2 test discoverer. - - The message sink used to send diagnostic messages - The test case discoverer type - - - - Gets an xUnit.net v2 test collection factory. - - The message sink used to send diagnostic messages - The test collection factory type - The test assembly under test - - - - Gets an xUnit.net v2 test collection factory, as specified in a reflected . - - The message sink used to send diagnostic messages - The collection behavior attribute. - The test assembly. - The collection factory. - - - - Implementation of that creates a single - default test collection for the assembly, and places any tests classes without - the into it. - - - - - Initializes a new instance of the class. - - The assembly. - The message sink used to send diagnostic messages - - - - - - - - - - Implementation of which creates a new test - collection for each test class that isn't decorated with . - - - - - Initializes a new instance of the class. - - The assembly info. - The message sink used to send diagnostic messages - - - - - - - - - - A simple implementation of that can be used to report an error - rather than running a test. - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The test method. - The error message to report for the test. - - - - Gets the error message that will be display when the test is run. - - - - - - - - - - - - - - Measures and aggregates execution time of one or more actions. - - - - - Returns the total time aggregated across all the actions. - - - - - Executes an action and aggregates its run time into the total. - - The action to measure. - - - - Executes an asynchronous action and aggregates its run time into the total. - - The action to measure. - - - - Aggregates a time span into the total time. - - The time to add. - - - - Implementation of that supports finding test cases - on methods decorated with . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Creates a single for the given test method. - - The discovery options to be used. - The test method. - The attribute that decorates the test method. - - - - - Discover test cases from a test method. By default, inspects the test method's argument list - to ensure it's empty, and if not, returns a single ; - otherwise, it returns the result of calling . - - The discovery options to be used. - The test method the test cases belong to. - The fact attribute attached to the test method. - Returns zero or more test cases represented by the test method. - - - - An implementation of to support . - - - - - Initializes a new instance of the class. - - The test case that the lambda represents. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - - - - A base class that provides default behavior when running tests in an assembly. It groups the tests - by test collection, and then runs the individual test collections. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The assembly that contains the tests to be run. - The test cases to be run. - The message sink to report diagnostic messages to. - The message sink to report run status to. - The user's requested execution options. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the user's requested execution options. - - - - - Gets or sets the message sink to report diagnostic messages to. - - - - - Gets or sets the message sink to report run status to. - - - - - Gets or sets the assembly that contains the tests to be run. - - - - - Gets or sets the test case orderer that will be used to decide how to order the tests. - - - - - Gets or sets the test collection orderer that will be used to decide how to order the test collections. - - - - - Gets or sets the test cases to be run. - - - - - - - - Override this to provide the display name for the test framework (f.e., "xUnit.net 2.0"). - This value is placed into . - - - - - Override this to provide the environment information (f.e., "32-bit .NET 4.0"). This value is - placed into . - - - - - This method is called just after is sent, but before any test collections are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Creates the message bus to be used for test execution. By default, it inspects - the options for the - flag, and if present, creates a message bus that ensures all messages are delivered - on the same thread. - - The message bus. - - - - Orders the test collections using the . - - Test collections (and the associated test cases) in run order - - - - Runs the tests in the test assembly. - - Returns summary information about the tests that were run. - - - - Runs the list of test collections. By default, groups the tests by collection and runs them synchronously. - - The message bus to report run status to. - The task cancellation token source, used to cancel the test run. - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test collection. - - The message bus to report run status to. - The test collection that is being run. - The test cases to be run. - The task cancellation token source, used to cancel the test run. - Returns summary information about the tests that were run. - - - - A base class that provides default behavior when running test cases. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test case to be run. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case to be run. - - - - - This method is called just after is sent, but before any test collections are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test case. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test method. - - Returns summary information about the tests that were run. - - - - A base class that provides default behavior when running tests in a test class. It groups the tests - by test method, and then runs the individual test methods. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test class to be run. - The test class that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the CLR class that contains the tests to be run. - - - - - Gets the message sink used to send diagnostic messages. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case orderer that will be used to decide how to order the test. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test class to be run. - - - - - Creates the arguments for the test class constructor. Attempts to resolve each parameter - individually, and adds an error when the constructor arguments cannot all be provided. - If the class is static, does not look for constructor, since one will not be needed. - - The test class constructor arguments. - - - - Gets the message to be used when the constructor is missing arguments. - - - - - This method is called just after is sent, but before any test methods are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test class. - - Returns summary information about the tests that were run. - - - - Runs the list of test methods. By default, orders the tests, groups them by method and runs them synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test method. - - The test method that contains the test cases. - The CLR method that contains the tests to be run. - The test cases to be run. - The constructor arguments that will be used to create the test class. - Returns summary information about the tests that were run. - - - - Selects the constructor to be used for the test class. By default, chooses the parameterless - constructor. Override to change the constructor selection logic. - - The constructor to be used for creating the test class. - - - - Tries to supply a test class constructor argument. By default, always fails. Override to - change the argument lookup logic. - - The constructor that will be used to create the test class. - The parameter index. - The parameter information. - The argument value that should be used for the parameter. - Returns true if the argument was supplied; false, otherwise. - - - - A base class that provides default behavior when running tests in a test collection. It groups the tests - by test class, and then runs the individual test classes. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test collection that contains the tests to be run. - The test cases to be run. - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case orderer that will be used to decide how to order the test. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test collection that contains the tests to be run. - - - - - This method is called just after is sent, but before any test classes are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test collection. - - Returns summary information about the tests that were run. - - - - Runs the list of test classes. By default, groups the tests by class and runs them synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test class. - - The test class to be run. - The CLR class that contains the tests to be run. - The test cases to be run. - Returns summary information about the tests that were run. - - - - A base class that provides default behavior to invoke a test method. This includes - support for async test methods (both "async Task" and "async void") as well as - creation and disposal of the test class. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the constructor arguments used to construct the test class. - - - - - Gets the display name of the invoked test. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test to be run. - - - - - Gets the test case to be run. - - - - - Gets or sets the runtime type of the class that contains the test method. - - - - - Gets or sets the runtime method of the method that contains the test. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - Gets or sets the object which measures execution time. - - - - - Creates the test class, unless the test method is static or there have already been errors. Note that - this method times the creation of the test class (using ). It is also responsible for - sending the and - messages, so if you override this method without calling the base, you are responsible for all of this behavior. - This method should NEVER throw; any exceptions should be placed into the . - - The class instance, if appropriate; null, otherwise - - - - This method is called just after the test method has finished executing. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before the test method is invoked. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method calls the test method via reflection. This is an available override point - if you need to do some other form of invocation of the actual test method. - - The instance of the test class - The return value from the test method invocation - - - - Creates the test class (if necessary), and invokes the test method. - - Returns the time (in seconds) spent creating the test class, running - the test, and disposing of the test class. - - - - Invokes the test method on the given test class instance. This method sets up support for "async void" - test methods, ensures that the test method has the correct number of arguments, then calls - to do the actual method invocation. It ensure that any async test method is fully completed before returning, and - returns the measured clock time that the invocation took. - - The test class instance - Returns the time taken to invoke the test method - - - - A base class that provides default behavior when running tests in a test method. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test method under test. - The CLR class that contains the test method. - The CLR method that contains the tests to be run. - The test cases to be run. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the CLR class that contains the test method. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the CLR method that contains the tests to be run. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test method that contains the test cases. - - - - - This method is called just after is sent, but before any test cases are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test method. - - Returns summary information about the tests that were run. - - - - Runs the list of test cases. By default, it runs the cases in order, synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run an individual test case. - - The test case to be run. - Returns summary information about the test case run. - - - - A base class that provides default behavior when running a test. This includes support - for skipping tests. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The skip reason, if the test is to be skipped. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the constructor arguments used to construct the test class. - - - - - Gets or sets the display name of the invoked test. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the skip reason for the test, if set. - - - - - Gets or sets the test to be run. - - - - - Gets the test case to be run. - - - - - Gets or sets the runtime type of the class that contains the test method. - - - - - Gets or sets the runtime method of the method that contains the test. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - This method is called just after is sent, but before the test class is created. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the test. - - Returns summary information about the test that was run. - - - - Override this method to invoke the test. - - The exception aggregator used to run code and collect exceptions. - Returns a tuple which includes the execution time (in seconds) spent running the - test method, and any output that was returned by the test. - - - - The test assembly runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The assembly that contains the tests to be run. - The test cases to be run. - The message sink to report diagnostic messages to. - The message sink to report run status to. - The user's requested execution options. - - - - - - - - - - - - - Gets the synchronization context used when potentially running tests in parallel. - If is greater than 0, it creates - and uses an instance of . - - The maximum number of parallel threads. - - - - Ensures the assembly runner is initialized (sets up the collection behavior, - parallelization options, and test orderers from their assembly attributes). - - - - - - - - - - - - - - - - - The test case runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test case to be run. - The display name of the test case. - The skip reason, if the test is to be skipped. - The arguments to be passed to the test class constructor. - The arguments to be passed to the test method. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s that will be used for this test case. - - - - - Gets or sets the arguments passed to the test class constructor - - - - - Gets or sets the display name of the test case - - - - - Gets or sets the skip reason for the test, if set. - - - - - Gets or sets the runtime type for the test class that the test method belongs to. - - - - - Gets of sets the runtime method for the test method that the test case belongs to. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - - - - The test class runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test class to be run. - The test class that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - The mapping of collection fixture types to fixtures. - - - - Gets the fixture mappings that were created during . - - - - - Creates the instance of a class fixture type to be used by the test class. If the fixture can be created, - it should be placed into the dictionary; if it cannot, then the method - should record the error by calling Aggregator.Add. - - The type of the fixture to be created - - - - - - - - - - - - - - - - - - - - - - The test collection runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test collection that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the fixture mappings that were created during . - - - - - - - - - - - Creates the instance of a collection fixture type to be used by the test collection. If the fixture can be created, - it should be placed into the dictionary; if it cannot, then the method - should record the error by calling Aggregator.Add. - - The type of the fixture to be created - - - - Gives an opportunity to override test case orderer. By default, this method gets the - orderer from the collection definition. If this function returns null, the - test case orderer passed into the constructor will be used. - - - - - - - - The test invoker for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The list of s for this test invocation. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s for this test invocation. - - - - - - - - - - - The test method runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test method to be run. - The test class that contains the test method. - The test method that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages to. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - The constructor arguments for the test class. - - - - - - - The test runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The skip reason, if the test is to be skipped. - The list of s for this test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s for this test. - - - - - - - - Override this method to invoke the test method. - - The exception aggregator used to run code and collect exceptions. - Returns the execution time (in seconds) spent running the test method. - - - - The test case runner for xUnit.net v2 theories (which could not be pre-enumerated; - pre-enumerated test cases use ). - - - - - Initializes a new instance of the class. - - The test case to be run. - The display name of the test case. - The skip reason, if the test is to be skipped. - The arguments to be passed to the test class constructor. - The message sink used to send diagnostic messages - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test assembly. - The optional configuration filename (defaults to the - configuration file of the current app domain if not provided) - The version number of the assembly (defaults to "0.0.0.0") - - - - - - - - - - Gets or sets the assembly version. - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test collection the class belongs to - The test class - - - - - - - - - - - - - - - - An implementation of for . - Compares the fully qualified names of the types. - - - - - The singleton instance of the comparer. - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test assembly the collection belongs to - The optional type which contains the collection definition - The display name for the test collection - - - - - - - - - - - - - - - - - - - - - - An implementation of for . - Compares the IDs of the test collections. - - - - - The singleton instance of the comparer. - - - - - - - - - - - A helper class that gets the list of test collection definitions for a given assembly. - Reports any misconfigurations of the test assembly via the diagnostic message sink. - - - - - Gets the test collection definitions for the given assembly. - - The assembly. - The message sink used to send diagnostic messages - A list of mappings from test collection name to test collection definitions (as - - - - A default implementation of that tracks objects to be - disposed when the framework is disposed. The discoverer and executor are automatically - tracked for disposal, since those interfaces mandate an implementation of . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Gets the message sink used to send diagnostic messages. - - - - - Gets the disposal tracker for the test framework. - - - - - - - - - - - Override this method to provide the implementation of . - - The assembly that is being discovered. - Returns the test framework discoverer. - - - - Override this method to provide the implementation of . - - The assembly that is being executed. - Returns the test framework executor. - - - - - - - - - - A base implementation of that supports test filtering - and runs the discovery process on a thread pool thread. - - - - - Initializes a new instance of the class. - - The test assembly. - The source information provider. - The message sink used to send diagnostic messages - - - - Gets the assembly that's being discovered. - - - - - Gets the message sink used to report diagnostic messages. - - - - - Gets the disposal tracker for the test framework discoverer. - - - - - Get the source code information provider used during discovery. - - - - - - - - - - - Implement this method to create a test class for the given CLR type. - - The CLR type. - The test class. - - - - - - - - - - - - - Core implementation to discover unit tests in a given test class. - - The test class. - Set to true to attempt to include source information. - The message sink to send discovery messages to. - The options used by the test framework during discovery. - Returns true if discovery should continue; false otherwise. - - - - Determines if a type should be used for discovery. Can be used to filter out types that - are not desirable. The default implementation filters out abstract (non-static) classes. - - The type. - Returns true if the type can contain tests; false, otherwise. - - - - Reports a discovered test case to the message bus, after updating the source code information - (if desired). - - - - - - - - - - - - A reusable implementation of which contains the basic behavior - for running tests. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - Name of the test assembly. - The source line number information provider. - The message sink to report diagnostic messages to. - - - - Gets the assembly information of the assembly under test. - - - - - Gets the message sink to send diagnostic messages to. - - - - - Gets the disposal tracker for the test framework discoverer. - - - - - Gets the source information provider. - - - - - Override to create a test framework discoverer that can be used to discover - tests when the user asks to run all test. - - The test framework discoverer - - - - - - - - - - - - - - - - Override to run test cases. - - The test cases to be run. - The message sink to report run status to. - The user's requested execution options. - - - - This class proxies for the real implementation of , based on - whether the user has overridden the choice via . If - no attribute is found, defaults to . - - - - - Initializes a new instance of the class. - - The test assembly (expected to implement ). - The source information provider (expected to implement ). - The diagnostic message sink (expected to implement ). - - - - Gets the test framework that's being wrapped by the proxy. - - - - - - - - - - - - - - - - - INTERNAL CLASS. DO NOT USE. - - - - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test class - The test method - - - - - - - - - - - - - - - - An implementation of for . - Compares the names of the methods. - - - - - The singleton instance of the comparer. - - - - - - - - - - - A base class implementation of which is based on test cases being - related directly to test methods. - - - - - Used for de-serialization. - - - - - Initializes a new instance of the class. - - Default method display to use (when not customized). - The test method this test case belongs to. - The arguments for the test method. - - - - Returns the base display name for a test ("TestClassName.MethodName"). - - - - - Returns the default method display to use (when not customized). - - - - - - - - - - - Gets the generic types that were used to close the generic test method, if - applicable; null, if the test method was not an open generic. - - - - - - - - - - - - - - - - - - - - - - - - - - Call to ensure the object is fully initialized(). - - - - - Gets the unique ID for the test case. - - - - Converts an array of bytes to its hexadecimal value as a string. - The bytes. - A string containing the hexademical representation of the provided bytes. - - - Gets a hexademical digit character from the 4-bit value. - A value in the range [0, 15]. - A character in the range ['0','9'] or ['a','f']. - - - - Called when initializing the test cases, either after constructor or de-serialization. - Override this method to add additional initialization-time work. - - - - - - - - - - - Default implementation of . - - - - - Gets the output provided by the test. - - - - - Initialize the test output helper with information about a test case. - - - - - Resets the test output helper to its uninitialized state. - - - - - - - - - - - Implementation of that supports finding test cases - on methods decorated with . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Creates a test case for a single row of data. By default, returns an instance of - with the data row inside of it. - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The row of data for this test case. - The test case - - - - Creates a test case for a skipped theory. By default, returns an instance of - (which inherently discovers the skip reason via the fact attribute). - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The skip reason that decorates . - The test case - - - - Creates a test case for the entire theory. This is used when one or more of the theory data items - are not serializable, or if the user has requested to skip theory pre-enumeration. By default, - returns an instance of , which performs the data discovery at runtime. - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The test case - - - - Discover test cases from a test method. - - - This method performs the following steps: - - If the theory attribute is marked with Skip, returns the single test case from ; - - If pre-enumeration is off, or any of the test data is non serializable, returns the single test case from ; - - If there is no theory data, returns a single test case of with the error in it; - - Otherwise, it returns one test case per data row, created by calling . - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - Returns zero or more test cases represented by the test method. - - - - An implementation of for xUnit v2. - - - - - Initializes a new instance of the class. - - The test case this test belongs to. - The display name for this test. - - - - - - - Gets the xUnit v2 test case. - - - - - - - - Default implementation of for xUnit v2 that supports tests decorated with - both and . - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The test method this test case belongs to. - The arguments for the test method. - - - - Gets the display name for the test case. Calls - with the given base display name (which is itself either derived from , - falling back to . - - The fact attribute the decorated the test case. - The base display name from . - The display name for the test case. - - - - Gets the skip reason for the test case. By default, pulls the skip reason from the - property. - - The fact attribute the decorated the test case. - The skip reason, if skipped; null, otherwise. - - - - - - - - - - The implementation of that supports discovery and - execution of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - - - - - - - The implementation of that supports discovery - of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Gets the display name of the xUnit.net v2 test framework. - - - - - Initializes a new instance of the class. - - The test assembly. - The source information provider. - The message sink used to send diagnostic messages - The test collection factory used to look up test collections. - - - - Gets the test collection factory that makes test collections. - - - - - - - - Finds the tests on a test method. - - The test method. - Set to true to indicate that source information should be included. - The message bus to report discovery messages to. - The options used by the test framework during discovery. - Return true to continue test discovery, false, otherwise. - - - - - - - Gets the test case discover instance for the given discoverer type. The instances are cached - and reused, since they should not be stateful. - - The discoverer type. - Returns the test case discoverer instance. - - - - The implementation of that supports execution - of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Initializes a new instance of the class. - - Name of the test assembly. - The source line number information provider. - The message sink to report diagnostic messages to. - - - - Gets the test assembly that contains the test. - - - - - - - - - - - Represents a test case which runs multiple tests for theory data, either because the - data was not enumerable or because the data was not serializable. - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The method under test. - - - - - - - An implementation of which runs work on custom threads - rather than in the thread pool, and limits the number of in-flight actions. - - - - - Initializes a new instance of the class. - - The maximum number of tasks to run at any one time. - - - - Gets a flag indicating whether maximum concurrency is supported. - - - - - - - - - - - - - - This is an internal class, and is not intended to be called from end-user code. - - - - - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. - - - - - Initializes a new instance of the class. - - The message bus to delegate to. - The callback to send messages to. - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. In addition, - it issues a event when a message of the type - is seen. - - The type of the T final message. - - - - Initializes a new instance of the class. - - The message bus to delegate to. - The callback to send messages to. - - - - The final message that was seen that caused to be triggered. - - - - - An event that is triggered when a message of type is seen. - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. - - - - - Initializes a new instance of the class. - - The inner message sink. - The callback. - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. In addition, - it issues a event when a message of the type - is seen. - - The type of the T final message. - - - - Initializes a new instance of the class. - - The inner message sink. - The callback. - - - - The final message that was seen that caused to be triggered. - - - - - An event that is triggered when a message of type is seen. - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The assembly to be wrapped. - - - - Initializes a new instance of the class. - - The assembly to be wrapped. - - - - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The attribute to be wrapped. - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The method to be wrapped. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The parameter to be wrapped. - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The type to wrap. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Wrapper to implement types from xunit.abstractions.dll using reflection. - - - - - Converts arguments into their target types. Can be particularly useful when pulling attribute - constructor arguments, whose types may not strictly match the parameter types. - - The arguments to be converted. - The target types for the conversion. - The converted arguments. - - - - Converts an into an . - - The assembly to wrap. - The wrapper - - - - Converts an into an using reflection. - - The attribute to wrap. - The wrapper - - - - Converts a into an using reflection. - - The method to wrap - The wrapper - - - - Converts a into an using reflection. - - THe parameter to wrap - The wrapper - - - - Converts a into an using reflection. - - The type to wrap - The wrapper - - - - This is an internal class, and is not intended to be called from end-user code. - - - - - - - - - - - - - - Represents an exception that happened during the process of a test class. This typically - means there were problems identifying the correct test class constructor, or problems - creating the fixture data for the test class. - - - - - Initializes a new instance of the class. - - The exception message. - - - - The implementation of that supports attributes - of type . - - - - - - - - A helper class to retrieve the traits from a method. - - - - - Get the traits from a method. - - The method to get the traits for. - A list of traits that are defined on the method. - - - - Extension methods for . - - - - - Formulates the extended portion of the display name for a test method. For tests with no arguments, this will - return just the base name; for tests with arguments, attempts to format the arguments and appends the argument - list to the test name. - - The test method - The base part of the display name - The test method arguments - The test method's generic types - The full display name for the test method - - - - Resolves a generic type for a test method. The test parameters (and associated parameter infos) are - used to determine the best matching generic type for the test method that can be satisfied by all - the generic parameters and their values. - - The generic type to be resolved - The parameter values being passed to the test method - The parameter infos for the test method - The best matching generic type - - - - Resolves all the generic types for a test method. The test parameters are used to determine - the best matching generic types for the test method that can be satisfied by all - the generic parameters and their values. - - The test method - The parameter values being passed to the test method - The best matching generic types - - - base implementation of MD4 family style digest as outlined in - "Handbook of Applied Cryptography", pages 344 - 347. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - implementation of SHA-1 as outlined in "Handbook of Applied Cryptography", pages 346 - 349. - - It is interesting to ponder why the, apart from the extra IV, the other difference here from MD5 - is the "endianness" of the word processing! - - - - - - - Copy constructor. This will copy the state of the provided - message digest. - - - - - - - - - - - - reset the chaining variables - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of and . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message to send - - - - Initializes a new instance of the class. - - The format of the message to send - The arguments used to format the message - - - - - - - Default implementation of . - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Gets the substitution token used as assembly name suffix to indicate that the assembly is - a generalized reference to the platform-specific assembly. - - - - - A mirror class of the CLR's class. - - - - - Initializes a new instance of the class. - - The data to copy into the serialization info - - - - - - - - - - - - - Returns BASE64 encoded string that represents the entirety of the data. - - - - - Returns a triple for a key/value pair of data in a complex object - - The triple to be serialized - The serialized version of the triple - - - - Returns the triple values out of a serialized triple. - - The serialized triple - The de-serialized triple - - - - De-serializes a value that was serialized with . - - The type of the object to de-serialize into - The serialized value - The de-serialized object - - - - Serializes an object. - - The value to be serialized - The serialized object - - - - Represents a triple of information used when serializing complex types: the property name, - the value to be serialized, and the value's type. - - - - - Gets the triple's key - - - - - Gets the triple's value - - - - - Gets the triple's value type - - - - - Initializes a new instance of the class. - - The triple's key - The triple's value - The triple's value type - - - - Guard class, used for guard clauses and argument validation - - - - - - - - - - - - - - Methods which help bridge and contain the differences between Type and TypeInfo. - - - - - This class represents utility methods needed to supplement the - reflection capabilities provided by the CLR - - - - - Creates an instance of the test class for the given test case. Sends the - and messages as appropriate. - - The test - The type of the test class - The constructor arguments for the test class - The message bus used to send the test messages - The timer used to measure the time taken for construction - The cancellation token source - - - - - Disposes the test class instance. Sends the and - messages as appropriate. - - The test - The test class instance to be disposed - The message bus used to send the test messages - The timer used to measure the time taken for construction - The cancellation token source - - - - Gets methods in the target type that match the protection level of the supplied method - - The type - The method - The reflection method informations that match - - - - Gets all the custom attributes for the given assembly. - - The assembly - The type of the attribute - The matching attributes that decorate the assembly - - - - Gets all the custom attributes for the given attribute. - - The attribute - The type of the attribute to find - The matching attributes that decorate the attribute - - - - Gets all the custom attributes for the method that are of the given type. - - The method - The type of the attribute - The matching attributes that decorate the method - - - - Gets all the custom attributes for the given type. - - The type - The type of the attribute - The matching attributes that decorate the type - - - - Converts an into a , if possible (for example, this - will not work when the test method is based on source code rather than binaries). - - The method to convert - The runtime method, if available; null, otherwise - - - - Converts an into a , if possible (for example, this - will not work when the test class is based on source code rather than binaries). - - The type to convert - The runtime type, if available, null, otherwise - - - - Extension methods for reading and . - - - - - Gets a flag that determines whether diagnostic messages will be emitted. - - - - - Gets a flag that determines whether diagnostic messages will be emitted. If the flag is not present, - returns the default value (false). - - - - - Gets a flag that determines the default display name format for test methods. - - - - - Gets a flag that determines the default display name format for test methods. If the flag is not present, - returns the default value (). - - - - - Gets a flag that determines whether theories are pre-enumerated. If they enabled, then the - discovery system will return a test case for each row of test data; they are disabled, then the - discovery system will return a single test case for the theory. - - - - - Gets a flag that determines whether theories are pre-enumerated. If they enabled, then the - discovery system will return a test case for each row of test data; they are disabled, then the - discovery system will return a single test case for the theory. If the flag is not present, - returns the default value (true). - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - If the flag is not set, returns the default value (false). - - - - - Gets a flag that determines whether diagnostic messages will be emitted. - - - - - Gets a flag that determines whether diagnostic messages will be emitted. If the flag is not - present, returns the default value (false). - - - - - Gets a flag to disable parallelization. - - - - - Gets a flag to disable parallelization. If the flag is not present, returns the - default value (false). - - - - - Gets the maximum number of threads to use when running tests in parallel. - - - - - Gets the maximum number of threads to use when running tests in parallel. If set to 0 (or not set), - the value of is used; if set to a value less - than 0, does not limit the number of threads. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - If the flag is not set, returns the default value (false). - - - - diff --git a/packages/xunit.extensibility.execution.2.1.0/lib/net45/xunit.execution.desktop.dll b/packages/xunit.extensibility.execution.2.1.0/lib/net45/xunit.execution.desktop.dll deleted file mode 100644 index e5ca3bf..0000000 Binary files a/packages/xunit.extensibility.execution.2.1.0/lib/net45/xunit.execution.desktop.dll and /dev/null differ diff --git a/packages/xunit.extensibility.execution.2.1.0/lib/net45/xunit.execution.desktop.xml b/packages/xunit.extensibility.execution.2.1.0/lib/net45/xunit.execution.desktop.xml deleted file mode 100644 index 3d0ebb8..0000000 --- a/packages/xunit.extensibility.execution.2.1.0/lib/net45/xunit.execution.desktop.xml +++ /dev/null @@ -1,4163 +0,0 @@ - - - - xunit.execution.desktop - - - - - Rethrows an exception object without losing the existing stack trace information - - The exception to re-throw. - - For more information on this technique, see - http://www.dotnetjunkies.com/WebLog/chris.taylor/archive/2004/03/03/8353.aspx. - The remote_stack_trace string is here to support Mono. - - - - - Unwraps an exception to remove any wrappers, like . - - The exception to unwrap. - The unwrapped exception. - - - - Utility classes for dealing with Exception objects. - - - - - Combines multiple levels of messages into a single message. - - The failure information from which to get the messages. - The combined string. - - - - Combines multiple levels of stack traces into a single stack trace. - - The failure information from which to get the stack traces. - The combined string. - - - - Unwraps exceptions and their inner exceptions. - - The exception to be converted. - The failure information. - - - - An implementation of that ignores all messages. - - - - - - - - Serializes and de-serializes objects - - - - - De-serializes an object. - - The type of the object - The object's serialized value - The de-serialized object - - - - Serializes an object. - - The value to serialize - The serialized value - - - Gets whether the specified is serializable with . - The object to test for serializability. - true if the object can be serialized; otherwise, false. - - - - Converts an assembly qualified type name into a object. - - The assembly qualified type name. - The instance of the , if available; null, otherwise. - - - - Converts an assembly name + type name into a object. - - The assembly name. - The type name. - The instance of the , if available; null, otherwise. - - - - Gets an assembly qualified type name for serialization, with special dispensation for types which - originate in the execution assembly. - - - - - Retrieves a substring from the string, with whitespace trimmed on both ends. - - The string. - The starting index. - The length. - - A substring starting no earlier than startIndex and ending no later - than startIndex + length. - - - - - Default implementation of . - - - - - - - - - - - - - - - - - An implementation of that provides several Visit methods that - can provide access to specific message types without the burden of casting. - - - - - Dispatches the message to the given callback, if it's of the correct type. - - The message type - The message - The callback - The result of the callback, if called; true, otherwise - - - - Dispatches the message to the given callback, if it's of the correct type. - The callback is provided with both the message and this instance of the visitor. - - The message type - The message - The callback - The result of the callback, if called; true, otherwise - - - - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering/executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - An implementation of that provides several Visit methods that - can provide access to specific message types without the burden of casting. It also records - when it sees a completion message, and sets the event appropriately. - - The type of the completion message. - - - - Initializes a new instance of the class. - - - - - This event is triggered when the completion message has been seen. - - - - - - - - - - - Formats arguments for display in theories. - - - - - Format the value for presentation. - - The value to be formatted. - The formatted value. - - - - Default implementation of used by the xUnit.net equality assertions. - - The type that is being compared. - - - - Initializes a new instance of the class. - - Set to true to skip type equality checks. - The inner comparer to be used when the compared objects are enumerable. - - - - - - - - - - A class that wraps to create . - - The type that is being compared. - - - - Initializes a new instance of the class. - - The comparer that is being adapted. - - - - - - - - - - Base class for all long-lived objects that may cross over an AppDomain. - - - - - Creates a new instance of the type. - - - - - - - - Disconnects all remote objects. - - - - - This implementation of allows the developer to track the count - of outstanding "async void" operations, and wait for them all to complete. - - - - - Initializes a new instance of the class. - - The existing synchronization context (may be null). - - - - - - - - - - - - - - - - Returns a task which is signaled when all outstanding operations are complete. - - - - - Default implementation of . Orders tests in - an unpredictable but stable order, so that repeated test runs of the - identical test assembly run tests in the same order. - - - - - Initializes a new instance of the class. - - Message sink to report diagnostic messages to - - - - - - - Default implementation of . Orders tests in - an unpredictable and unstable order, so that repeated test runs of the - identical test assembly run test collections in a random order. - - - - - - - - Tracks disposable objects, and disposes them in the reverse order they were added to - the tracker. - - - - - Add an object to be disposed. - - The object to be disposed. - - - - - - - Represents a caching factory for the types used for extensibility throughout the system. - - - - - Disposes the instances that are contained in the cache. - - - - - Gets an instance of the given type, casting it to , using the provided - constructor arguments. There is a single instance of a given type that is cached and reused, - so classes retrieved from this factory must be stateless and thread-safe. - - The interface type. - The message sink used to send diagnostic messages - The implementation type. - The constructor arguments. Since diagnostic message sinks are optional, - the code first looks for a type that takes the given arguments plus the message sink, and only - falls back to the message sink-less constructor if none was found. - The instance of the type. - - - - Gets a data discoverer. - - The message sink used to send diagnostic messages - The discoverer type - - - - Gets a data discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The data discoverer attribute - The data discoverer, if the type is loadable; null, otherwise. - - - - Gets a test case orderer. - - The message sink used to send diagnostic messages - The test case orderer type - - - - Gets a test case orderer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test case orderer attribute. - The test case orderer, if the type is loadable; null, otherwise. - - - - Gets a test collection orderer. - - The message sink used to send diagnostic messages - The test collection orderer type - - - - Gets a test collection orderer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test collection orderer attribute. - The test collection orderer, if the type is loadable; null, otherwise. - - - - Gets a test framework discoverer. - - The message sink used to send diagnostic messages - The test framework type discoverer type - - - - Gets a test framework discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test framework discoverer attribute - - - - Gets a trait discoverer. - - The message sink used to send diagnostic messages - The trait discoverer type - - - - Gets a trait discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The trait discoverer attribute. - The trait discoverer, if the type is loadable; null, otherwise. - - - - Gets an xUnit.net v2 test discoverer. - - The message sink used to send diagnostic messages - The test case discoverer type - - - - Gets an xUnit.net v2 test collection factory. - - The message sink used to send diagnostic messages - The test collection factory type - The test assembly under test - - - - Gets an xUnit.net v2 test collection factory, as specified in a reflected . - - The message sink used to send diagnostic messages - The collection behavior attribute. - The test assembly. - The collection factory. - - - - Implementation of that creates a single - default test collection for the assembly, and places any tests classes without - the into it. - - - - - Initializes a new instance of the class. - - The assembly. - The message sink used to send diagnostic messages - - - - - - - - - - Implementation of which creates a new test - collection for each test class that isn't decorated with . - - - - - Initializes a new instance of the class. - - The assembly info. - The message sink used to send diagnostic messages - - - - - - - - - - A simple implementation of that can be used to report an error - rather than running a test. - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The test method. - The error message to report for the test. - - - - Gets the error message that will be display when the test is run. - - - - - - - - - - - - - - Measures and aggregates execution time of one or more actions. - - - - - Returns the total time aggregated across all the actions. - - - - - Executes an action and aggregates its run time into the total. - - The action to measure. - - - - Executes an asynchronous action and aggregates its run time into the total. - - The action to measure. - - - - Aggregates a time span into the total time. - - The time to add. - - - - Implementation of that supports finding test cases - on methods decorated with . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Creates a single for the given test method. - - The discovery options to be used. - The test method. - The attribute that decorates the test method. - - - - - Discover test cases from a test method. By default, inspects the test method's argument list - to ensure it's empty, and if not, returns a single ; - otherwise, it returns the result of calling . - - The discovery options to be used. - The test method the test cases belong to. - The fact attribute attached to the test method. - Returns zero or more test cases represented by the test method. - - - - An implementation of to support . - - - - - Initializes a new instance of the class. - - The test case that the lambda represents. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - - - - A base class that provides default behavior when running tests in an assembly. It groups the tests - by test collection, and then runs the individual test collections. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The assembly that contains the tests to be run. - The test cases to be run. - The message sink to report diagnostic messages to. - The message sink to report run status to. - The user's requested execution options. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the user's requested execution options. - - - - - Gets or sets the message sink to report diagnostic messages to. - - - - - Gets or sets the message sink to report run status to. - - - - - Gets or sets the assembly that contains the tests to be run. - - - - - Gets or sets the test case orderer that will be used to decide how to order the tests. - - - - - Gets or sets the test collection orderer that will be used to decide how to order the test collections. - - - - - Gets or sets the test cases to be run. - - - - - - - - Override this to provide the display name for the test framework (f.e., "xUnit.net 2.0"). - This value is placed into . - - - - - Override this to provide the environment information (f.e., "32-bit .NET 4.0"). This value is - placed into . - - - - - This method is called just after is sent, but before any test collections are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Creates the message bus to be used for test execution. By default, it inspects - the options for the - flag, and if present, creates a message bus that ensures all messages are delivered - on the same thread. - - The message bus. - - - - Orders the test collections using the . - - Test collections (and the associated test cases) in run order - - - - Runs the tests in the test assembly. - - Returns summary information about the tests that were run. - - - - Runs the list of test collections. By default, groups the tests by collection and runs them synchronously. - - The message bus to report run status to. - The task cancellation token source, used to cancel the test run. - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test collection. - - The message bus to report run status to. - The test collection that is being run. - The test cases to be run. - The task cancellation token source, used to cancel the test run. - Returns summary information about the tests that were run. - - - - A base class that provides default behavior when running test cases. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test case to be run. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case to be run. - - - - - This method is called just after is sent, but before any test collections are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test case. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test method. - - Returns summary information about the tests that were run. - - - - A base class that provides default behavior when running tests in a test class. It groups the tests - by test method, and then runs the individual test methods. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test class to be run. - The test class that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the CLR class that contains the tests to be run. - - - - - Gets the message sink used to send diagnostic messages. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case orderer that will be used to decide how to order the test. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test class to be run. - - - - - Creates the arguments for the test class constructor. Attempts to resolve each parameter - individually, and adds an error when the constructor arguments cannot all be provided. - If the class is static, does not look for constructor, since one will not be needed. - - The test class constructor arguments. - - - - Gets the message to be used when the constructor is missing arguments. - - - - - This method is called just after is sent, but before any test methods are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test class. - - Returns summary information about the tests that were run. - - - - Runs the list of test methods. By default, orders the tests, groups them by method and runs them synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test method. - - The test method that contains the test cases. - The CLR method that contains the tests to be run. - The test cases to be run. - The constructor arguments that will be used to create the test class. - Returns summary information about the tests that were run. - - - - Selects the constructor to be used for the test class. By default, chooses the parameterless - constructor. Override to change the constructor selection logic. - - The constructor to be used for creating the test class. - - - - Tries to supply a test class constructor argument. By default, always fails. Override to - change the argument lookup logic. - - The constructor that will be used to create the test class. - The parameter index. - The parameter information. - The argument value that should be used for the parameter. - Returns true if the argument was supplied; false, otherwise. - - - - A base class that provides default behavior when running tests in a test collection. It groups the tests - by test class, and then runs the individual test classes. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test collection that contains the tests to be run. - The test cases to be run. - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case orderer that will be used to decide how to order the test. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test collection that contains the tests to be run. - - - - - This method is called just after is sent, but before any test classes are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test collection. - - Returns summary information about the tests that were run. - - - - Runs the list of test classes. By default, groups the tests by class and runs them synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test class. - - The test class to be run. - The CLR class that contains the tests to be run. - The test cases to be run. - Returns summary information about the tests that were run. - - - - A base class that provides default behavior to invoke a test method. This includes - support for async test methods (both "async Task" and "async void") as well as - creation and disposal of the test class. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the constructor arguments used to construct the test class. - - - - - Gets the display name of the invoked test. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test to be run. - - - - - Gets the test case to be run. - - - - - Gets or sets the runtime type of the class that contains the test method. - - - - - Gets or sets the runtime method of the method that contains the test. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - Gets or sets the object which measures execution time. - - - - - Creates the test class, unless the test method is static or there have already been errors. Note that - this method times the creation of the test class (using ). It is also responsible for - sending the and - messages, so if you override this method without calling the base, you are responsible for all of this behavior. - This method should NEVER throw; any exceptions should be placed into the . - - The class instance, if appropriate; null, otherwise - - - - This method is called just after the test method has finished executing. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before the test method is invoked. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method calls the test method via reflection. This is an available override point - if you need to do some other form of invocation of the actual test method. - - The instance of the test class - The return value from the test method invocation - - - - Creates the test class (if necessary), and invokes the test method. - - Returns the time (in seconds) spent creating the test class, running - the test, and disposing of the test class. - - - - Invokes the test method on the given test class instance. This method sets up support for "async void" - test methods, ensures that the test method has the correct number of arguments, then calls - to do the actual method invocation. It ensure that any async test method is fully completed before returning, and - returns the measured clock time that the invocation took. - - The test class instance - Returns the time taken to invoke the test method - - - - A base class that provides default behavior when running tests in a test method. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test method under test. - The CLR class that contains the test method. - The CLR method that contains the tests to be run. - The test cases to be run. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the CLR class that contains the test method. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the CLR method that contains the tests to be run. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test method that contains the test cases. - - - - - This method is called just after is sent, but before any test cases are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test method. - - Returns summary information about the tests that were run. - - - - Runs the list of test cases. By default, it runs the cases in order, synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run an individual test case. - - The test case to be run. - Returns summary information about the test case run. - - - - A base class that provides default behavior when running a test. This includes support - for skipping tests. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The skip reason, if the test is to be skipped. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the constructor arguments used to construct the test class. - - - - - Gets or sets the display name of the invoked test. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the skip reason for the test, if set. - - - - - Gets or sets the test to be run. - - - - - Gets the test case to be run. - - - - - Gets or sets the runtime type of the class that contains the test method. - - - - - Gets or sets the runtime method of the method that contains the test. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - This method is called just after is sent, but before the test class is created. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the test. - - Returns summary information about the test that was run. - - - - Override this method to invoke the test. - - The exception aggregator used to run code and collect exceptions. - Returns a tuple which includes the execution time (in seconds) spent running the - test method, and any output that was returned by the test. - - - - The test assembly runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The assembly that contains the tests to be run. - The test cases to be run. - The message sink to report diagnostic messages to. - The message sink to report run status to. - The user's requested execution options. - - - - - - - - - - - - - Gets the synchronization context used when potentially running tests in parallel. - If is greater than 0, it creates - and uses an instance of . - - The maximum number of parallel threads. - - - - Ensures the assembly runner is initialized (sets up the collection behavior, - parallelization options, and test orderers from their assembly attributes). - - - - - - - - - - - - - - - - - The test case runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test case to be run. - The display name of the test case. - The skip reason, if the test is to be skipped. - The arguments to be passed to the test class constructor. - The arguments to be passed to the test method. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s that will be used for this test case. - - - - - Gets or sets the arguments passed to the test class constructor - - - - - Gets or sets the display name of the test case - - - - - Gets or sets the skip reason for the test, if set. - - - - - Gets or sets the runtime type for the test class that the test method belongs to. - - - - - Gets of sets the runtime method for the test method that the test case belongs to. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - - - - The test class runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test class to be run. - The test class that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - The mapping of collection fixture types to fixtures. - - - - Gets the fixture mappings that were created during . - - - - - Creates the instance of a class fixture type to be used by the test class. If the fixture can be created, - it should be placed into the dictionary; if it cannot, then the method - should record the error by calling Aggregator.Add. - - The type of the fixture to be created - - - - - - - - - - - - - - - - - - - - - - The test collection runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test collection that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the fixture mappings that were created during . - - - - - - - - - - - Creates the instance of a collection fixture type to be used by the test collection. If the fixture can be created, - it should be placed into the dictionary; if it cannot, then the method - should record the error by calling Aggregator.Add. - - The type of the fixture to be created - - - - Gives an opportunity to override test case orderer. By default, this method gets the - orderer from the collection definition. If this function returns null, the - test case orderer passed into the constructor will be used. - - - - - - - - The test invoker for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The list of s for this test invocation. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s for this test invocation. - - - - - - - - - - - The test method runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test method to be run. - The test class that contains the test method. - The test method that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages to. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - The constructor arguments for the test class. - - - - - - - The test runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The skip reason, if the test is to be skipped. - The list of s for this test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s for this test. - - - - - - - - Override this method to invoke the test method. - - The exception aggregator used to run code and collect exceptions. - Returns the execution time (in seconds) spent running the test method. - - - - The test case runner for xUnit.net v2 theories (which could not be pre-enumerated; - pre-enumerated test cases use ). - - - - - Initializes a new instance of the class. - - The test case to be run. - The display name of the test case. - The skip reason, if the test is to be skipped. - The arguments to be passed to the test class constructor. - The message sink used to send diagnostic messages - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test assembly. - The optional configuration filename (defaults to the - configuration file of the current app domain if not provided) - The version number of the assembly (defaults to "0.0.0.0") - - - - - - - - - - Gets or sets the assembly version. - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test collection the class belongs to - The test class - - - - - - - - - - - - - - - - An implementation of for . - Compares the fully qualified names of the types. - - - - - The singleton instance of the comparer. - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test assembly the collection belongs to - The optional type which contains the collection definition - The display name for the test collection - - - - - - - - - - - - - - - - - - - - - - An implementation of for . - Compares the IDs of the test collections. - - - - - The singleton instance of the comparer. - - - - - - - - - - - A helper class that gets the list of test collection definitions for a given assembly. - Reports any misconfigurations of the test assembly via the diagnostic message sink. - - - - - Gets the test collection definitions for the given assembly. - - The assembly. - The message sink used to send diagnostic messages - A list of mappings from test collection name to test collection definitions (as - - - - A default implementation of that tracks objects to be - disposed when the framework is disposed. The discoverer and executor are automatically - tracked for disposal, since those interfaces mandate an implementation of . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Gets the message sink used to send diagnostic messages. - - - - - Gets the disposal tracker for the test framework. - - - - - - - - - - - Override this method to provide the implementation of . - - The assembly that is being discovered. - Returns the test framework discoverer. - - - - Override this method to provide the implementation of . - - The assembly that is being executed. - Returns the test framework executor. - - - - - - - - - - A base implementation of that supports test filtering - and runs the discovery process on a thread pool thread. - - - - - Initializes a new instance of the class. - - The test assembly. - The source information provider. - The message sink used to send diagnostic messages - - - - Gets the assembly that's being discovered. - - - - - Gets the message sink used to report diagnostic messages. - - - - - Gets the disposal tracker for the test framework discoverer. - - - - - Get the source code information provider used during discovery. - - - - - - - - - - - Implement this method to create a test class for the given CLR type. - - The CLR type. - The test class. - - - - - - - - - - - - - Core implementation to discover unit tests in a given test class. - - The test class. - Set to true to attempt to include source information. - The message sink to send discovery messages to. - The options used by the test framework during discovery. - Returns true if discovery should continue; false otherwise. - - - - Determines if a type should be used for discovery. Can be used to filter out types that - are not desirable. The default implementation filters out abstract (non-static) classes. - - The type. - Returns true if the type can contain tests; false, otherwise. - - - - Reports a discovered test case to the message bus, after updating the source code information - (if desired). - - - - - - - - - - - - A reusable implementation of which contains the basic behavior - for running tests. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - Name of the test assembly. - The source line number information provider. - The message sink to report diagnostic messages to. - - - - Gets the assembly information of the assembly under test. - - - - - Gets the message sink to send diagnostic messages to. - - - - - Gets the disposal tracker for the test framework discoverer. - - - - - Gets the source information provider. - - - - - Override to create a test framework discoverer that can be used to discover - tests when the user asks to run all test. - - The test framework discoverer - - - - - - - - - - - - - - - - Override to run test cases. - - The test cases to be run. - The message sink to report run status to. - The user's requested execution options. - - - - This class proxies for the real implementation of , based on - whether the user has overridden the choice via . If - no attribute is found, defaults to . - - - - - Initializes a new instance of the class. - - The test assembly (expected to implement ). - The source information provider (expected to implement ). - The diagnostic message sink (expected to implement ). - - - - Gets the test framework that's being wrapped by the proxy. - - - - - - - - - - - - - - - - - INTERNAL CLASS. DO NOT USE. - - - - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test class - The test method - - - - - - - - - - - - - - - - An implementation of for . - Compares the names of the methods. - - - - - The singleton instance of the comparer. - - - - - - - - - - - A base class implementation of which is based on test cases being - related directly to test methods. - - - - - Used for de-serialization. - - - - - Initializes a new instance of the class. - - Default method display to use (when not customized). - The test method this test case belongs to. - The arguments for the test method. - - - - Returns the base display name for a test ("TestClassName.MethodName"). - - - - - Returns the default method display to use (when not customized). - - - - - - - - - - - Gets the generic types that were used to close the generic test method, if - applicable; null, if the test method was not an open generic. - - - - - - - - - - - - - - - - - - - - - - - - - - Call to ensure the object is fully initialized(). - - - - - Gets the unique ID for the test case. - - - - Converts an array of bytes to its hexadecimal value as a string. - The bytes. - A string containing the hexademical representation of the provided bytes. - - - Gets a hexademical digit character from the 4-bit value. - A value in the range [0, 15]. - A character in the range ['0','9'] or ['a','f']. - - - - Called when initializing the test cases, either after constructor or de-serialization. - Override this method to add additional initialization-time work. - - - - - - - - - - - Default implementation of . - - - - - Gets the output provided by the test. - - - - - Initialize the test output helper with information about a test case. - - - - - Resets the test output helper to its uninitialized state. - - - - - - - - - - - Implementation of that supports finding test cases - on methods decorated with . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Creates a test case for a single row of data. By default, returns an instance of - with the data row inside of it. - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The row of data for this test case. - The test case - - - - Creates a test case for a skipped theory. By default, returns an instance of - (which inherently discovers the skip reason via the fact attribute). - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The skip reason that decorates . - The test case - - - - Creates a test case for the entire theory. This is used when one or more of the theory data items - are not serializable, or if the user has requested to skip theory pre-enumeration. By default, - returns an instance of , which performs the data discovery at runtime. - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The test case - - - - Discover test cases from a test method. - - - This method performs the following steps: - - If the theory attribute is marked with Skip, returns the single test case from ; - - If pre-enumeration is off, or any of the test data is non serializable, returns the single test case from ; - - If there is no theory data, returns a single test case of with the error in it; - - Otherwise, it returns one test case per data row, created by calling . - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - Returns zero or more test cases represented by the test method. - - - - An implementation of for xUnit v2. - - - - - Initializes a new instance of the class. - - The test case this test belongs to. - The display name for this test. - - - - - - - Gets the xUnit v2 test case. - - - - - - - - Default implementation of for xUnit v2 that supports tests decorated with - both and . - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The test method this test case belongs to. - The arguments for the test method. - - - - Gets the display name for the test case. Calls - with the given base display name (which is itself either derived from , - falling back to . - - The fact attribute the decorated the test case. - The base display name from . - The display name for the test case. - - - - Gets the skip reason for the test case. By default, pulls the skip reason from the - property. - - The fact attribute the decorated the test case. - The skip reason, if skipped; null, otherwise. - - - - - - - - - - The implementation of that supports discovery and - execution of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - - - - - - - The implementation of that supports discovery - of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Gets the display name of the xUnit.net v2 test framework. - - - - - Initializes a new instance of the class. - - The test assembly. - The source information provider. - The message sink used to send diagnostic messages - The test collection factory used to look up test collections. - - - - Gets the test collection factory that makes test collections. - - - - - - - - Finds the tests on a test method. - - The test method. - Set to true to indicate that source information should be included. - The message bus to report discovery messages to. - The options used by the test framework during discovery. - Return true to continue test discovery, false, otherwise. - - - - - - - Gets the test case discover instance for the given discoverer type. The instances are cached - and reused, since they should not be stateful. - - The discoverer type. - Returns the test case discoverer instance. - - - - The implementation of that supports execution - of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Initializes a new instance of the class. - - Name of the test assembly. - The source line number information provider. - The message sink to report diagnostic messages to. - - - - Gets the test assembly that contains the test. - - - - - - - - - - - Represents a test case which runs multiple tests for theory data, either because the - data was not enumerable or because the data was not serializable. - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The method under test. - - - - - - - An implementation of which runs work on custom threads - rather than in the thread pool, and limits the number of in-flight actions. - - - - - Initializes a new instance of the class. - - The maximum number of tasks to run at any one time. - - - - Gets a flag indicating whether maximum concurrency is supported. - - - - - - - - - - - - - - This is an internal class, and is not intended to be called from end-user code. - - - - - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. - - - - - Initializes a new instance of the class. - - The message bus to delegate to. - The callback to send messages to. - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. In addition, - it issues a event when a message of the type - is seen. - - The type of the T final message. - - - - Initializes a new instance of the class. - - The message bus to delegate to. - The callback to send messages to. - - - - The final message that was seen that caused to be triggered. - - - - - An event that is triggered when a message of type is seen. - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. - - - - - Initializes a new instance of the class. - - The inner message sink. - The callback. - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. In addition, - it issues a event when a message of the type - is seen. - - The type of the T final message. - - - - Initializes a new instance of the class. - - The inner message sink. - The callback. - - - - The final message that was seen that caused to be triggered. - - - - - An event that is triggered when a message of type is seen. - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The assembly to be wrapped. - - - - Initializes a new instance of the class. - - The assembly to be wrapped. - - - - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The attribute to be wrapped. - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The method to be wrapped. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The parameter to be wrapped. - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The type to wrap. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Wrapper to implement types from xunit.abstractions.dll using reflection. - - - - - Converts arguments into their target types. Can be particularly useful when pulling attribute - constructor arguments, whose types may not strictly match the parameter types. - - The arguments to be converted. - The target types for the conversion. - The converted arguments. - - - - Converts an into an . - - The assembly to wrap. - The wrapper - - - - Converts an into an using reflection. - - The attribute to wrap. - The wrapper - - - - Converts a into an using reflection. - - The method to wrap - The wrapper - - - - Converts a into an using reflection. - - THe parameter to wrap - The wrapper - - - - Converts a into an using reflection. - - The type to wrap - The wrapper - - - - This is an internal class, and is not intended to be called from end-user code. - - - - - - - - - - - - - - Represents an exception that happened during the process of a test class. This typically - means there were problems identifying the correct test class constructor, or problems - creating the fixture data for the test class. - - - - - Initializes a new instance of the class. - - The exception message. - - - - - - - The implementation of that supports attributes - of type . - - - - - - - - A helper class to retrieve the traits from a method. - - - - - Get the traits from a method. - - The method to get the traits for. - A list of traits that are defined on the method. - - - - Extension methods for . - - - - - Formulates the extended portion of the display name for a test method. For tests with no arguments, this will - return just the base name; for tests with arguments, attempts to format the arguments and appends the argument - list to the test name. - - The test method - The base part of the display name - The test method arguments - The test method's generic types - The full display name for the test method - - - - Resolves a generic type for a test method. The test parameters (and associated parameter infos) are - used to determine the best matching generic type for the test method that can be satisfied by all - the generic parameters and their values. - - The generic type to be resolved - The parameter values being passed to the test method - The parameter infos for the test method - The best matching generic type - - - - Resolves all the generic types for a test method. The test parameters are used to determine - the best matching generic types for the test method that can be satisfied by all - the generic parameters and their values. - - The test method - The parameter values being passed to the test method - The best matching generic types - - - base implementation of MD4 family style digest as outlined in - "Handbook of Applied Cryptography", pages 344 - 347. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - implementation of SHA-1 as outlined in "Handbook of Applied Cryptography", pages 346 - 349. - - It is interesting to ponder why the, apart from the extra IV, the other difference here from MD5 - is the "endianness" of the word processing! - - - - - - - Copy constructor. This will copy the state of the provided - message digest. - - - - - - - - - - - - reset the chaining variables - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of and . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message to send - - - - Initializes a new instance of the class. - - The format of the message to send - The arguments used to format the message - - - - - - - Default implementation of . - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Gets the substitution token used as assembly name suffix to indicate that the assembly is - a generalized reference to the platform-specific assembly. - - - - - A mirror class of the CLR's class. - - - - - Initializes a new instance of the class. - - The data to copy into the serialization info - - - - - - - - - - - - - Returns BASE64 encoded string that represents the entirety of the data. - - - - - Returns a triple for a key/value pair of data in a complex object - - The triple to be serialized - The serialized version of the triple - - - - Returns the triple values out of a serialized triple. - - The serialized triple - The de-serialized triple - - - - De-serializes a value that was serialized with . - - The type of the object to de-serialize into - The serialized value - The de-serialized object - - - - Serializes an object. - - The value to be serialized - The serialized object - - - - Represents a triple of information used when serializing complex types: the property name, - the value to be serialized, and the value's type. - - - - - Gets the triple's key - - - - - Gets the triple's value - - - - - Gets the triple's value type - - - - - Initializes a new instance of the class. - - The triple's key - The triple's value - The triple's value type - - - - Guard class, used for guard clauses and argument validation - - - - - - - - - - - - - - Methods which help bridge and contain the differences between Type and TypeInfo. - - - - - This class represents utility methods needed to supplement the - reflection capabilities provided by the CLR - - - - - Creates an instance of the test class for the given test case. Sends the - and messages as appropriate. - - The test - The type of the test class - The constructor arguments for the test class - The message bus used to send the test messages - The timer used to measure the time taken for construction - The cancellation token source - - - - - Disposes the test class instance. Sends the and - messages as appropriate. - - The test - The test class instance to be disposed - The message bus used to send the test messages - The timer used to measure the time taken for construction - The cancellation token source - - - - Gets methods in the target type that match the protection level of the supplied method - - The type - The method - The reflection method informations that match - - - - Gets all the custom attributes for the given assembly. - - The assembly - The type of the attribute - The matching attributes that decorate the assembly - - - - Gets all the custom attributes for the given attribute. - - The attribute - The type of the attribute to find - The matching attributes that decorate the attribute - - - - Gets all the custom attributes for the method that are of the given type. - - The method - The type of the attribute - The matching attributes that decorate the method - - - - Gets all the custom attributes for the given type. - - The type - The type of the attribute - The matching attributes that decorate the type - - - - Converts an into a , if possible (for example, this - will not work when the test method is based on source code rather than binaries). - - The method to convert - The runtime method, if available; null, otherwise - - - - Converts an into a , if possible (for example, this - will not work when the test class is based on source code rather than binaries). - - The type to convert - The runtime type, if available, null, otherwise - - - - Extension methods for reading and . - - - - - Gets a flag that determines whether diagnostic messages will be emitted. - - - - - Gets a flag that determines whether diagnostic messages will be emitted. If the flag is not present, - returns the default value (false). - - - - - Gets a flag that determines the default display name format for test methods. - - - - - Gets a flag that determines the default display name format for test methods. If the flag is not present, - returns the default value (). - - - - - Gets a flag that determines whether theories are pre-enumerated. If they enabled, then the - discovery system will return a test case for each row of test data; they are disabled, then the - discovery system will return a single test case for the theory. - - - - - Gets a flag that determines whether theories are pre-enumerated. If they enabled, then the - discovery system will return a test case for each row of test data; they are disabled, then the - discovery system will return a single test case for the theory. If the flag is not present, - returns the default value (true). - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - If the flag is not set, returns the default value (false). - - - - - Gets a flag that determines whether diagnostic messages will be emitted. - - - - - Gets a flag that determines whether diagnostic messages will be emitted. If the flag is not - present, returns the default value (false). - - - - - Gets a flag to disable parallelization. - - - - - Gets a flag to disable parallelization. If the flag is not present, returns the - default value (false). - - - - - Gets the maximum number of threads to use when running tests in parallel. - - - - - Gets the maximum number of threads to use when running tests in parallel. If set to 0 (or not set), - the value of is used; if set to a value less - than 0, does not limit the number of threads. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - If the flag is not set, returns the default value (false). - - - - diff --git a/packages/xunit.extensibility.execution.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.execution.dotnet.dll b/packages/xunit.extensibility.execution.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.execution.dotnet.dll deleted file mode 100644 index 3c43440..0000000 Binary files a/packages/xunit.extensibility.execution.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.execution.dotnet.dll and /dev/null differ diff --git a/packages/xunit.extensibility.execution.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.execution.dotnet.xml b/packages/xunit.extensibility.execution.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.execution.dotnet.xml deleted file mode 100644 index d819501..0000000 --- a/packages/xunit.extensibility.execution.2.1.0/lib/portable-net45+win8+wp8+wpa81/xunit.execution.dotnet.xml +++ /dev/null @@ -1,4157 +0,0 @@ - - - - xunit.execution.dotnet - - - - - Rethrows an exception object without losing the existing stack trace information - - The exception to re-throw. - - For more information on this technique, see - http://www.dotnetjunkies.com/WebLog/chris.taylor/archive/2004/03/03/8353.aspx. - The remote_stack_trace string is here to support Mono. - - - - - Unwraps an exception to remove any wrappers, like . - - The exception to unwrap. - The unwrapped exception. - - - - Utility classes for dealing with Exception objects. - - - - - Combines multiple levels of messages into a single message. - - The failure information from which to get the messages. - The combined string. - - - - Combines multiple levels of stack traces into a single stack trace. - - The failure information from which to get the stack traces. - The combined string. - - - - Unwraps exceptions and their inner exceptions. - - The exception to be converted. - The failure information. - - - - An implementation of that ignores all messages. - - - - - - - - Serializes and de-serializes objects - - - - - De-serializes an object. - - The type of the object - The object's serialized value - The de-serialized object - - - - Serializes an object. - - The value to serialize - The serialized value - - - Gets whether the specified is serializable with . - The object to test for serializability. - true if the object can be serialized; otherwise, false. - - - - Converts an assembly qualified type name into a object. - - The assembly qualified type name. - The instance of the , if available; null, otherwise. - - - - Converts an assembly name + type name into a object. - - The assembly name. - The type name. - The instance of the , if available; null, otherwise. - - - - Gets an assembly qualified type name for serialization, with special dispensation for types which - originate in the execution assembly. - - - - - Retrieves a substring from the string, with whitespace trimmed on both ends. - - The string. - The starting index. - The length. - - A substring starting no earlier than startIndex and ending no later - than startIndex + length. - - - - - Default implementation of . - - - - - - - - - - - - - - - - - An implementation of that provides several Visit methods that - can provide access to specific message types without the burden of casting. - - - - - Dispatches the message to the given callback, if it's of the correct type. - - The message type - The message - The callback - The result of the callback, if called; true, otherwise - - - - Dispatches the message to the given callback, if it's of the correct type. - The callback is provided with both the message and this instance of the visitor. - - The message type - The message - The callback - The result of the callback, if called; true, otherwise - - - - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering/executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - An implementation of that provides several Visit methods that - can provide access to specific message types without the burden of casting. It also records - when it sees a completion message, and sets the event appropriately. - - The type of the completion message. - - - - Initializes a new instance of the class. - - - - - This event is triggered when the completion message has been seen. - - - - - - - - - - - Formats arguments for display in theories. - - - - - Format the value for presentation. - - The value to be formatted. - The formatted value. - - - - Default implementation of used by the xUnit.net equality assertions. - - The type that is being compared. - - - - Initializes a new instance of the class. - - Set to true to skip type equality checks. - The inner comparer to be used when the compared objects are enumerable. - - - - - - - - - - A class that wraps to create . - - The type that is being compared. - - - - Initializes a new instance of the class. - - The comparer that is being adapted. - - - - - - - - - - Base class for all long-lived objects that may cross over an AppDomain. - - - - - Creates a new instance of the type. - - - - - Disconnects all remote objects. - - - - - This implementation of allows the developer to track the count - of outstanding "async void" operations, and wait for them all to complete. - - - - - Initializes a new instance of the class. - - The existing synchronization context (may be null). - - - - - - - - - - - - - - - - Returns a task which is signaled when all outstanding operations are complete. - - - - - Default implementation of . Orders tests in - an unpredictable but stable order, so that repeated test runs of the - identical test assembly run tests in the same order. - - - - - Initializes a new instance of the class. - - Message sink to report diagnostic messages to - - - - - - - Default implementation of . Orders tests in - an unpredictable and unstable order, so that repeated test runs of the - identical test assembly run test collections in a random order. - - - - - - - - Tracks disposable objects, and disposes them in the reverse order they were added to - the tracker. - - - - - Add an object to be disposed. - - The object to be disposed. - - - - - - - Represents a caching factory for the types used for extensibility throughout the system. - - - - - Disposes the instances that are contained in the cache. - - - - - Gets an instance of the given type, casting it to , using the provided - constructor arguments. There is a single instance of a given type that is cached and reused, - so classes retrieved from this factory must be stateless and thread-safe. - - The interface type. - The message sink used to send diagnostic messages - The implementation type. - The constructor arguments. Since diagnostic message sinks are optional, - the code first looks for a type that takes the given arguments plus the message sink, and only - falls back to the message sink-less constructor if none was found. - The instance of the type. - - - - Gets a data discoverer. - - The message sink used to send diagnostic messages - The discoverer type - - - - Gets a data discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The data discoverer attribute - The data discoverer, if the type is loadable; null, otherwise. - - - - Gets a test case orderer. - - The message sink used to send diagnostic messages - The test case orderer type - - - - Gets a test case orderer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test case orderer attribute. - The test case orderer, if the type is loadable; null, otherwise. - - - - Gets a test collection orderer. - - The message sink used to send diagnostic messages - The test collection orderer type - - - - Gets a test collection orderer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test collection orderer attribute. - The test collection orderer, if the type is loadable; null, otherwise. - - - - Gets a test framework discoverer. - - The message sink used to send diagnostic messages - The test framework type discoverer type - - - - Gets a test framework discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test framework discoverer attribute - - - - Gets a trait discoverer. - - The message sink used to send diagnostic messages - The trait discoverer type - - - - Gets a trait discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The trait discoverer attribute. - The trait discoverer, if the type is loadable; null, otherwise. - - - - Gets an xUnit.net v2 test discoverer. - - The message sink used to send diagnostic messages - The test case discoverer type - - - - Gets an xUnit.net v2 test collection factory. - - The message sink used to send diagnostic messages - The test collection factory type - The test assembly under test - - - - Gets an xUnit.net v2 test collection factory, as specified in a reflected . - - The message sink used to send diagnostic messages - The collection behavior attribute. - The test assembly. - The collection factory. - - - - Implementation of that creates a single - default test collection for the assembly, and places any tests classes without - the into it. - - - - - Initializes a new instance of the class. - - The assembly. - The message sink used to send diagnostic messages - - - - - - - - - - Implementation of which creates a new test - collection for each test class that isn't decorated with . - - - - - Initializes a new instance of the class. - - The assembly info. - The message sink used to send diagnostic messages - - - - - - - - - - A simple implementation of that can be used to report an error - rather than running a test. - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The test method. - The error message to report for the test. - - - - Gets the error message that will be display when the test is run. - - - - - - - - - - - - - - Measures and aggregates execution time of one or more actions. - - - - - Returns the total time aggregated across all the actions. - - - - - Executes an action and aggregates its run time into the total. - - The action to measure. - - - - Executes an asynchronous action and aggregates its run time into the total. - - The action to measure. - - - - Aggregates a time span into the total time. - - The time to add. - - - - Implementation of that supports finding test cases - on methods decorated with . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Creates a single for the given test method. - - The discovery options to be used. - The test method. - The attribute that decorates the test method. - - - - - Discover test cases from a test method. By default, inspects the test method's argument list - to ensure it's empty, and if not, returns a single ; - otherwise, it returns the result of calling . - - The discovery options to be used. - The test method the test cases belong to. - The fact attribute attached to the test method. - Returns zero or more test cases represented by the test method. - - - - An implementation of to support . - - - - - Initializes a new instance of the class. - - The test case that the lambda represents. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - - - - A base class that provides default behavior when running tests in an assembly. It groups the tests - by test collection, and then runs the individual test collections. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The assembly that contains the tests to be run. - The test cases to be run. - The message sink to report diagnostic messages to. - The message sink to report run status to. - The user's requested execution options. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the user's requested execution options. - - - - - Gets or sets the message sink to report diagnostic messages to. - - - - - Gets or sets the message sink to report run status to. - - - - - Gets or sets the assembly that contains the tests to be run. - - - - - Gets or sets the test case orderer that will be used to decide how to order the tests. - - - - - Gets or sets the test collection orderer that will be used to decide how to order the test collections. - - - - - Gets or sets the test cases to be run. - - - - - - - - Override this to provide the display name for the test framework (f.e., "xUnit.net 2.0"). - This value is placed into . - - - - - Override this to provide the environment information (f.e., "32-bit .NET 4.0"). This value is - placed into . - - - - - This method is called just after is sent, but before any test collections are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Creates the message bus to be used for test execution. By default, it inspects - the options for the - flag, and if present, creates a message bus that ensures all messages are delivered - on the same thread. - - The message bus. - - - - Orders the test collections using the . - - Test collections (and the associated test cases) in run order - - - - Runs the tests in the test assembly. - - Returns summary information about the tests that were run. - - - - Runs the list of test collections. By default, groups the tests by collection and runs them synchronously. - - The message bus to report run status to. - The task cancellation token source, used to cancel the test run. - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test collection. - - The message bus to report run status to. - The test collection that is being run. - The test cases to be run. - The task cancellation token source, used to cancel the test run. - Returns summary information about the tests that were run. - - - - A base class that provides default behavior when running test cases. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test case to be run. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case to be run. - - - - - This method is called just after is sent, but before any test collections are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test case. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test method. - - Returns summary information about the tests that were run. - - - - A base class that provides default behavior when running tests in a test class. It groups the tests - by test method, and then runs the individual test methods. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test class to be run. - The test class that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the CLR class that contains the tests to be run. - - - - - Gets the message sink used to send diagnostic messages. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case orderer that will be used to decide how to order the test. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test class to be run. - - - - - Creates the arguments for the test class constructor. Attempts to resolve each parameter - individually, and adds an error when the constructor arguments cannot all be provided. - If the class is static, does not look for constructor, since one will not be needed. - - The test class constructor arguments. - - - - Gets the message to be used when the constructor is missing arguments. - - - - - This method is called just after is sent, but before any test methods are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test class. - - Returns summary information about the tests that were run. - - - - Runs the list of test methods. By default, orders the tests, groups them by method and runs them synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test method. - - The test method that contains the test cases. - The CLR method that contains the tests to be run. - The test cases to be run. - The constructor arguments that will be used to create the test class. - Returns summary information about the tests that were run. - - - - Selects the constructor to be used for the test class. By default, chooses the parameterless - constructor. Override to change the constructor selection logic. - - The constructor to be used for creating the test class. - - - - Tries to supply a test class constructor argument. By default, always fails. Override to - change the argument lookup logic. - - The constructor that will be used to create the test class. - The parameter index. - The parameter information. - The argument value that should be used for the parameter. - Returns true if the argument was supplied; false, otherwise. - - - - A base class that provides default behavior when running tests in a test collection. It groups the tests - by test class, and then runs the individual test classes. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test collection that contains the tests to be run. - The test cases to be run. - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case orderer that will be used to decide how to order the test. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test collection that contains the tests to be run. - - - - - This method is called just after is sent, but before any test classes are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test collection. - - Returns summary information about the tests that were run. - - - - Runs the list of test classes. By default, groups the tests by class and runs them synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test class. - - The test class to be run. - The CLR class that contains the tests to be run. - The test cases to be run. - Returns summary information about the tests that were run. - - - - A base class that provides default behavior to invoke a test method. This includes - support for async test methods (both "async Task" and "async void") as well as - creation and disposal of the test class. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the constructor arguments used to construct the test class. - - - - - Gets the display name of the invoked test. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test to be run. - - - - - Gets the test case to be run. - - - - - Gets or sets the runtime type of the class that contains the test method. - - - - - Gets or sets the runtime method of the method that contains the test. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - Gets or sets the object which measures execution time. - - - - - Creates the test class, unless the test method is static or there have already been errors. Note that - this method times the creation of the test class (using ). It is also responsible for - sending the and - messages, so if you override this method without calling the base, you are responsible for all of this behavior. - This method should NEVER throw; any exceptions should be placed into the . - - The class instance, if appropriate; null, otherwise - - - - This method is called just after the test method has finished executing. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before the test method is invoked. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method calls the test method via reflection. This is an available override point - if you need to do some other form of invocation of the actual test method. - - The instance of the test class - The return value from the test method invocation - - - - Creates the test class (if necessary), and invokes the test method. - - Returns the time (in seconds) spent creating the test class, running - the test, and disposing of the test class. - - - - Invokes the test method on the given test class instance. This method sets up support for "async void" - test methods, ensures that the test method has the correct number of arguments, then calls - to do the actual method invocation. It ensure that any async test method is fully completed before returning, and - returns the measured clock time that the invocation took. - - The test class instance - Returns the time taken to invoke the test method - - - - A base class that provides default behavior when running tests in a test method. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test method under test. - The CLR class that contains the test method. - The CLR method that contains the tests to be run. - The test cases to be run. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the CLR class that contains the test method. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the CLR method that contains the tests to be run. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test method that contains the test cases. - - - - - This method is called just after is sent, but before any test cases are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test method. - - Returns summary information about the tests that were run. - - - - Runs the list of test cases. By default, it runs the cases in order, synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run an individual test case. - - The test case to be run. - Returns summary information about the test case run. - - - - A base class that provides default behavior when running a test. This includes support - for skipping tests. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The skip reason, if the test is to be skipped. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the constructor arguments used to construct the test class. - - - - - Gets or sets the display name of the invoked test. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the skip reason for the test, if set. - - - - - Gets or sets the test to be run. - - - - - Gets the test case to be run. - - - - - Gets or sets the runtime type of the class that contains the test method. - - - - - Gets or sets the runtime method of the method that contains the test. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - This method is called just after is sent, but before the test class is created. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the test. - - Returns summary information about the test that was run. - - - - Override this method to invoke the test. - - The exception aggregator used to run code and collect exceptions. - Returns a tuple which includes the execution time (in seconds) spent running the - test method, and any output that was returned by the test. - - - - The test assembly runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The assembly that contains the tests to be run. - The test cases to be run. - The message sink to report diagnostic messages to. - The message sink to report run status to. - The user's requested execution options. - - - - - - - - - - - - - Gets the synchronization context used when potentially running tests in parallel. - If is greater than 0, it creates - and uses an instance of . - - The maximum number of parallel threads. - - - - Ensures the assembly runner is initialized (sets up the collection behavior, - parallelization options, and test orderers from their assembly attributes). - - - - - - - - - - - - - - - - - The test case runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test case to be run. - The display name of the test case. - The skip reason, if the test is to be skipped. - The arguments to be passed to the test class constructor. - The arguments to be passed to the test method. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s that will be used for this test case. - - - - - Gets or sets the arguments passed to the test class constructor - - - - - Gets or sets the display name of the test case - - - - - Gets or sets the skip reason for the test, if set. - - - - - Gets or sets the runtime type for the test class that the test method belongs to. - - - - - Gets of sets the runtime method for the test method that the test case belongs to. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - - - - The test class runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test class to be run. - The test class that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - The mapping of collection fixture types to fixtures. - - - - Gets the fixture mappings that were created during . - - - - - Creates the instance of a class fixture type to be used by the test class. If the fixture can be created, - it should be placed into the dictionary; if it cannot, then the method - should record the error by calling Aggregator.Add. - - The type of the fixture to be created - - - - - - - - - - - - - - - - - - - - - - The test collection runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test collection that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the fixture mappings that were created during . - - - - - - - - - - - Creates the instance of a collection fixture type to be used by the test collection. If the fixture can be created, - it should be placed into the dictionary; if it cannot, then the method - should record the error by calling Aggregator.Add. - - The type of the fixture to be created - - - - Gives an opportunity to override test case orderer. By default, this method gets the - orderer from the collection definition. If this function returns null, the - test case orderer passed into the constructor will be used. - - - - - - - - The test invoker for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The list of s for this test invocation. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s for this test invocation. - - - - - - - - - - - The test method runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test method to be run. - The test class that contains the test method. - The test method that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages to. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - The constructor arguments for the test class. - - - - - - - The test runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The skip reason, if the test is to be skipped. - The list of s for this test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s for this test. - - - - - - - - Override this method to invoke the test method. - - The exception aggregator used to run code and collect exceptions. - Returns the execution time (in seconds) spent running the test method. - - - - The test case runner for xUnit.net v2 theories (which could not be pre-enumerated; - pre-enumerated test cases use ). - - - - - Initializes a new instance of the class. - - The test case to be run. - The display name of the test case. - The skip reason, if the test is to be skipped. - The arguments to be passed to the test class constructor. - The message sink used to send diagnostic messages - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test assembly. - The optional configuration filename (defaults to the - configuration file of the current app domain if not provided) - The version number of the assembly (defaults to "0.0.0.0") - - - - - - - - - - Gets or sets the assembly version. - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test collection the class belongs to - The test class - - - - - - - - - - - - - - - - An implementation of for . - Compares the fully qualified names of the types. - - - - - The singleton instance of the comparer. - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test assembly the collection belongs to - The optional type which contains the collection definition - The display name for the test collection - - - - - - - - - - - - - - - - - - - - - - An implementation of for . - Compares the IDs of the test collections. - - - - - The singleton instance of the comparer. - - - - - - - - - - - A helper class that gets the list of test collection definitions for a given assembly. - Reports any misconfigurations of the test assembly via the diagnostic message sink. - - - - - Gets the test collection definitions for the given assembly. - - The assembly. - The message sink used to send diagnostic messages - A list of mappings from test collection name to test collection definitions (as - - - - A default implementation of that tracks objects to be - disposed when the framework is disposed. The discoverer and executor are automatically - tracked for disposal, since those interfaces mandate an implementation of . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Gets the message sink used to send diagnostic messages. - - - - - Gets the disposal tracker for the test framework. - - - - - - - - - - - Override this method to provide the implementation of . - - The assembly that is being discovered. - Returns the test framework discoverer. - - - - Override this method to provide the implementation of . - - The assembly that is being executed. - Returns the test framework executor. - - - - - - - - - - A base implementation of that supports test filtering - and runs the discovery process on a thread pool thread. - - - - - Initializes a new instance of the class. - - The test assembly. - The source information provider. - The message sink used to send diagnostic messages - - - - Gets the assembly that's being discovered. - - - - - Gets the message sink used to report diagnostic messages. - - - - - Gets the disposal tracker for the test framework discoverer. - - - - - Get the source code information provider used during discovery. - - - - - - - - - - - Implement this method to create a test class for the given CLR type. - - The CLR type. - The test class. - - - - - - - - - - - - - Core implementation to discover unit tests in a given test class. - - The test class. - Set to true to attempt to include source information. - The message sink to send discovery messages to. - The options used by the test framework during discovery. - Returns true if discovery should continue; false otherwise. - - - - Determines if a type should be used for discovery. Can be used to filter out types that - are not desirable. The default implementation filters out abstract (non-static) classes. - - The type. - Returns true if the type can contain tests; false, otherwise. - - - - Reports a discovered test case to the message bus, after updating the source code information - (if desired). - - - - - - - - - - - - A reusable implementation of which contains the basic behavior - for running tests. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - Name of the test assembly. - The source line number information provider. - The message sink to report diagnostic messages to. - - - - Gets the assembly information of the assembly under test. - - - - - Gets the message sink to send diagnostic messages to. - - - - - Gets the disposal tracker for the test framework discoverer. - - - - - Gets the source information provider. - - - - - Override to create a test framework discoverer that can be used to discover - tests when the user asks to run all test. - - The test framework discoverer - - - - - - - - - - - - - - - - Override to run test cases. - - The test cases to be run. - The message sink to report run status to. - The user's requested execution options. - - - - This class proxies for the real implementation of , based on - whether the user has overridden the choice via . If - no attribute is found, defaults to . - - - - - Initializes a new instance of the class. - - The test assembly (expected to implement ). - The source information provider (expected to implement ). - The diagnostic message sink (expected to implement ). - - - - Gets the test framework that's being wrapped by the proxy. - - - - - - - - - - - - - - - - - INTERNAL CLASS. DO NOT USE. - - - - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test class - The test method - - - - - - - - - - - - - - - - An implementation of for . - Compares the names of the methods. - - - - - The singleton instance of the comparer. - - - - - - - - - - - A base class implementation of which is based on test cases being - related directly to test methods. - - - - - Used for de-serialization. - - - - - Initializes a new instance of the class. - - Default method display to use (when not customized). - The test method this test case belongs to. - The arguments for the test method. - - - - Returns the base display name for a test ("TestClassName.MethodName"). - - - - - Returns the default method display to use (when not customized). - - - - - - - - - - - Gets the generic types that were used to close the generic test method, if - applicable; null, if the test method was not an open generic. - - - - - - - - - - - - - - - - - - - - - - - - - - Call to ensure the object is fully initialized(). - - - - - Gets the unique ID for the test case. - - - - Converts an array of bytes to its hexadecimal value as a string. - The bytes. - A string containing the hexademical representation of the provided bytes. - - - Gets a hexademical digit character from the 4-bit value. - A value in the range [0, 15]. - A character in the range ['0','9'] or ['a','f']. - - - - Called when initializing the test cases, either after constructor or de-serialization. - Override this method to add additional initialization-time work. - - - - - - - - - - - Default implementation of . - - - - - Gets the output provided by the test. - - - - - Initialize the test output helper with information about a test case. - - - - - Resets the test output helper to its uninitialized state. - - - - - - - - - - - Implementation of that supports finding test cases - on methods decorated with . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Creates a test case for a single row of data. By default, returns an instance of - with the data row inside of it. - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The row of data for this test case. - The test case - - - - Creates a test case for a skipped theory. By default, returns an instance of - (which inherently discovers the skip reason via the fact attribute). - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The skip reason that decorates . - The test case - - - - Creates a test case for the entire theory. This is used when one or more of the theory data items - are not serializable, or if the user has requested to skip theory pre-enumeration. By default, - returns an instance of , which performs the data discovery at runtime. - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The test case - - - - Discover test cases from a test method. - - - This method performs the following steps: - - If the theory attribute is marked with Skip, returns the single test case from ; - - If pre-enumeration is off, or any of the test data is non serializable, returns the single test case from ; - - If there is no theory data, returns a single test case of with the error in it; - - Otherwise, it returns one test case per data row, created by calling . - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - Returns zero or more test cases represented by the test method. - - - - An implementation of for xUnit v2. - - - - - Initializes a new instance of the class. - - The test case this test belongs to. - The display name for this test. - - - - - - - Gets the xUnit v2 test case. - - - - - - - - Default implementation of for xUnit v2 that supports tests decorated with - both and . - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The test method this test case belongs to. - The arguments for the test method. - - - - Gets the display name for the test case. Calls - with the given base display name (which is itself either derived from , - falling back to . - - The fact attribute the decorated the test case. - The base display name from . - The display name for the test case. - - - - Gets the skip reason for the test case. By default, pulls the skip reason from the - property. - - The fact attribute the decorated the test case. - The skip reason, if skipped; null, otherwise. - - - - - - - - - - The implementation of that supports discovery and - execution of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - - - - - - - The implementation of that supports discovery - of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Gets the display name of the xUnit.net v2 test framework. - - - - - Initializes a new instance of the class. - - The test assembly. - The source information provider. - The message sink used to send diagnostic messages - The test collection factory used to look up test collections. - - - - Gets the test collection factory that makes test collections. - - - - - - - - Finds the tests on a test method. - - The test method. - Set to true to indicate that source information should be included. - The message bus to report discovery messages to. - The options used by the test framework during discovery. - Return true to continue test discovery, false, otherwise. - - - - - - - Gets the test case discover instance for the given discoverer type. The instances are cached - and reused, since they should not be stateful. - - The discoverer type. - Returns the test case discoverer instance. - - - - The implementation of that supports execution - of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Initializes a new instance of the class. - - Name of the test assembly. - The source line number information provider. - The message sink to report diagnostic messages to. - - - - Gets the test assembly that contains the test. - - - - - - - - - - - Represents a test case which runs multiple tests for theory data, either because the - data was not enumerable or because the data was not serializable. - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The method under test. - - - - - - - An implementation of which runs work on custom threads - rather than in the thread pool, and limits the number of in-flight actions. - - - - - Initializes a new instance of the class. - - The maximum number of tasks to run at any one time. - - - - Gets a flag indicating whether maximum concurrency is supported. - - - - - - - - - - - - - - This is an internal class, and is not intended to be called from end-user code. - - - - - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. - - - - - Initializes a new instance of the class. - - The message bus to delegate to. - The callback to send messages to. - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. In addition, - it issues a event when a message of the type - is seen. - - The type of the T final message. - - - - Initializes a new instance of the class. - - The message bus to delegate to. - The callback to send messages to. - - - - The final message that was seen that caused to be triggered. - - - - - An event that is triggered when a message of type is seen. - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. - - - - - Initializes a new instance of the class. - - The inner message sink. - The callback. - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. In addition, - it issues a event when a message of the type - is seen. - - The type of the T final message. - - - - Initializes a new instance of the class. - - The inner message sink. - The callback. - - - - The final message that was seen that caused to be triggered. - - - - - An event that is triggered when a message of type is seen. - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The assembly to be wrapped. - - - - Initializes a new instance of the class. - - The assembly to be wrapped. - - - - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The attribute to be wrapped. - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The method to be wrapped. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The parameter to be wrapped. - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The type to wrap. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Wrapper to implement types from xunit.abstractions.dll using reflection. - - - - - Converts arguments into their target types. Can be particularly useful when pulling attribute - constructor arguments, whose types may not strictly match the parameter types. - - The arguments to be converted. - The target types for the conversion. - The converted arguments. - - - - Converts an into an . - - The assembly to wrap. - The wrapper - - - - Converts an into an using reflection. - - The attribute to wrap. - The wrapper - - - - Converts a into an using reflection. - - The method to wrap - The wrapper - - - - Converts a into an using reflection. - - THe parameter to wrap - The wrapper - - - - Converts a into an using reflection. - - The type to wrap - The wrapper - - - - This is an internal class, and is not intended to be called from end-user code. - - - - - - - - - - - - - - Represents an exception that happened during the process of a test class. This typically - means there were problems identifying the correct test class constructor, or problems - creating the fixture data for the test class. - - - - - Initializes a new instance of the class. - - The exception message. - - - - The implementation of that supports attributes - of type . - - - - - - - - A helper class to retrieve the traits from a method. - - - - - Get the traits from a method. - - The method to get the traits for. - A list of traits that are defined on the method. - - - - Extension methods for . - - - - - Formulates the extended portion of the display name for a test method. For tests with no arguments, this will - return just the base name; for tests with arguments, attempts to format the arguments and appends the argument - list to the test name. - - The test method - The base part of the display name - The test method arguments - The test method's generic types - The full display name for the test method - - - - Resolves a generic type for a test method. The test parameters (and associated parameter infos) are - used to determine the best matching generic type for the test method that can be satisfied by all - the generic parameters and their values. - - The generic type to be resolved - The parameter values being passed to the test method - The parameter infos for the test method - The best matching generic type - - - - Resolves all the generic types for a test method. The test parameters are used to determine - the best matching generic types for the test method that can be satisfied by all - the generic parameters and their values. - - The test method - The parameter values being passed to the test method - The best matching generic types - - - base implementation of MD4 family style digest as outlined in - "Handbook of Applied Cryptography", pages 344 - 347. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - implementation of SHA-1 as outlined in "Handbook of Applied Cryptography", pages 346 - 349. - - It is interesting to ponder why the, apart from the extra IV, the other difference here from MD5 - is the "endianness" of the word processing! - - - - - - - Copy constructor. This will copy the state of the provided - message digest. - - - - - - - - - - - - reset the chaining variables - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of and . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message to send - - - - Initializes a new instance of the class. - - The format of the message to send - The arguments used to format the message - - - - - - - Default implementation of . - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Gets the substitution token used as assembly name suffix to indicate that the assembly is - a generalized reference to the platform-specific assembly. - - - - - A mirror class of the CLR's class. - - - - - Initializes a new instance of the class. - - The data to copy into the serialization info - - - - - - - - - - - - - Returns BASE64 encoded string that represents the entirety of the data. - - - - - Returns a triple for a key/value pair of data in a complex object - - The triple to be serialized - The serialized version of the triple - - - - Returns the triple values out of a serialized triple. - - The serialized triple - The de-serialized triple - - - - De-serializes a value that was serialized with . - - The type of the object to de-serialize into - The serialized value - The de-serialized object - - - - Serializes an object. - - The value to be serialized - The serialized object - - - - Represents a triple of information used when serializing complex types: the property name, - the value to be serialized, and the value's type. - - - - - Gets the triple's key - - - - - Gets the triple's value - - - - - Gets the triple's value type - - - - - Initializes a new instance of the class. - - The triple's key - The triple's value - The triple's value type - - - - Guard class, used for guard clauses and argument validation - - - - - - - - - - - - - - Methods which help bridge and contain the differences between Type and TypeInfo. - - - - - This class represents utility methods needed to supplement the - reflection capabilities provided by the CLR - - - - - Creates an instance of the test class for the given test case. Sends the - and messages as appropriate. - - The test - The type of the test class - The constructor arguments for the test class - The message bus used to send the test messages - The timer used to measure the time taken for construction - The cancellation token source - - - - - Disposes the test class instance. Sends the and - messages as appropriate. - - The test - The test class instance to be disposed - The message bus used to send the test messages - The timer used to measure the time taken for construction - The cancellation token source - - - - Gets methods in the target type that match the protection level of the supplied method - - The type - The method - The reflection method informations that match - - - - Gets all the custom attributes for the given assembly. - - The assembly - The type of the attribute - The matching attributes that decorate the assembly - - - - Gets all the custom attributes for the given attribute. - - The attribute - The type of the attribute to find - The matching attributes that decorate the attribute - - - - Gets all the custom attributes for the method that are of the given type. - - The method - The type of the attribute - The matching attributes that decorate the method - - - - Gets all the custom attributes for the given type. - - The type - The type of the attribute - The matching attributes that decorate the type - - - - Converts an into a , if possible (for example, this - will not work when the test method is based on source code rather than binaries). - - The method to convert - The runtime method, if available; null, otherwise - - - - Converts an into a , if possible (for example, this - will not work when the test class is based on source code rather than binaries). - - The type to convert - The runtime type, if available, null, otherwise - - - - Extension methods for reading and . - - - - - Gets a flag that determines whether diagnostic messages will be emitted. - - - - - Gets a flag that determines whether diagnostic messages will be emitted. If the flag is not present, - returns the default value (false). - - - - - Gets a flag that determines the default display name format for test methods. - - - - - Gets a flag that determines the default display name format for test methods. If the flag is not present, - returns the default value (). - - - - - Gets a flag that determines whether theories are pre-enumerated. If they enabled, then the - discovery system will return a test case for each row of test data; they are disabled, then the - discovery system will return a single test case for the theory. - - - - - Gets a flag that determines whether theories are pre-enumerated. If they enabled, then the - discovery system will return a test case for each row of test data; they are disabled, then the - discovery system will return a single test case for the theory. If the flag is not present, - returns the default value (true). - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - If the flag is not set, returns the default value (false). - - - - - Gets a flag that determines whether diagnostic messages will be emitted. - - - - - Gets a flag that determines whether diagnostic messages will be emitted. If the flag is not - present, returns the default value (false). - - - - - Gets a flag to disable parallelization. - - - - - Gets a flag to disable parallelization. If the flag is not present, returns the - default value (false). - - - - - Gets the maximum number of threads to use when running tests in parallel. - - - - - Gets the maximum number of threads to use when running tests in parallel. If set to 0 (or not set), - the value of is used; if set to a value less - than 0, does not limit the number of threads. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - If the flag is not set, returns the default value (false). - - - - diff --git a/packages/xunit.extensibility.execution.2.1.0/lib/win8/xunit.execution.dotnet.dll b/packages/xunit.extensibility.execution.2.1.0/lib/win8/xunit.execution.dotnet.dll deleted file mode 100644 index 3c43440..0000000 Binary files a/packages/xunit.extensibility.execution.2.1.0/lib/win8/xunit.execution.dotnet.dll and /dev/null differ diff --git a/packages/xunit.extensibility.execution.2.1.0/lib/win8/xunit.execution.dotnet.xml b/packages/xunit.extensibility.execution.2.1.0/lib/win8/xunit.execution.dotnet.xml deleted file mode 100644 index d819501..0000000 --- a/packages/xunit.extensibility.execution.2.1.0/lib/win8/xunit.execution.dotnet.xml +++ /dev/null @@ -1,4157 +0,0 @@ - - - - xunit.execution.dotnet - - - - - Rethrows an exception object without losing the existing stack trace information - - The exception to re-throw. - - For more information on this technique, see - http://www.dotnetjunkies.com/WebLog/chris.taylor/archive/2004/03/03/8353.aspx. - The remote_stack_trace string is here to support Mono. - - - - - Unwraps an exception to remove any wrappers, like . - - The exception to unwrap. - The unwrapped exception. - - - - Utility classes for dealing with Exception objects. - - - - - Combines multiple levels of messages into a single message. - - The failure information from which to get the messages. - The combined string. - - - - Combines multiple levels of stack traces into a single stack trace. - - The failure information from which to get the stack traces. - The combined string. - - - - Unwraps exceptions and their inner exceptions. - - The exception to be converted. - The failure information. - - - - An implementation of that ignores all messages. - - - - - - - - Serializes and de-serializes objects - - - - - De-serializes an object. - - The type of the object - The object's serialized value - The de-serialized object - - - - Serializes an object. - - The value to serialize - The serialized value - - - Gets whether the specified is serializable with . - The object to test for serializability. - true if the object can be serialized; otherwise, false. - - - - Converts an assembly qualified type name into a object. - - The assembly qualified type name. - The instance of the , if available; null, otherwise. - - - - Converts an assembly name + type name into a object. - - The assembly name. - The type name. - The instance of the , if available; null, otherwise. - - - - Gets an assembly qualified type name for serialization, with special dispensation for types which - originate in the execution assembly. - - - - - Retrieves a substring from the string, with whitespace trimmed on both ends. - - The string. - The starting index. - The length. - - A substring starting no earlier than startIndex and ending no later - than startIndex + length. - - - - - Default implementation of . - - - - - - - - - - - - - - - - - An implementation of that provides several Visit methods that - can provide access to specific message types without the burden of casting. - - - - - Dispatches the message to the given callback, if it's of the correct type. - - The message type - The message - The callback - The result of the callback, if called; true, otherwise - - - - Dispatches the message to the given callback, if it's of the correct type. - The callback is provided with both the message and this instance of the visitor. - - The message type - The message - The callback - The result of the callback, if called; true, otherwise - - - - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering/executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - An implementation of that provides several Visit methods that - can provide access to specific message types without the burden of casting. It also records - when it sees a completion message, and sets the event appropriately. - - The type of the completion message. - - - - Initializes a new instance of the class. - - - - - This event is triggered when the completion message has been seen. - - - - - - - - - - - Formats arguments for display in theories. - - - - - Format the value for presentation. - - The value to be formatted. - The formatted value. - - - - Default implementation of used by the xUnit.net equality assertions. - - The type that is being compared. - - - - Initializes a new instance of the class. - - Set to true to skip type equality checks. - The inner comparer to be used when the compared objects are enumerable. - - - - - - - - - - A class that wraps to create . - - The type that is being compared. - - - - Initializes a new instance of the class. - - The comparer that is being adapted. - - - - - - - - - - Base class for all long-lived objects that may cross over an AppDomain. - - - - - Creates a new instance of the type. - - - - - Disconnects all remote objects. - - - - - This implementation of allows the developer to track the count - of outstanding "async void" operations, and wait for them all to complete. - - - - - Initializes a new instance of the class. - - The existing synchronization context (may be null). - - - - - - - - - - - - - - - - Returns a task which is signaled when all outstanding operations are complete. - - - - - Default implementation of . Orders tests in - an unpredictable but stable order, so that repeated test runs of the - identical test assembly run tests in the same order. - - - - - Initializes a new instance of the class. - - Message sink to report diagnostic messages to - - - - - - - Default implementation of . Orders tests in - an unpredictable and unstable order, so that repeated test runs of the - identical test assembly run test collections in a random order. - - - - - - - - Tracks disposable objects, and disposes them in the reverse order they were added to - the tracker. - - - - - Add an object to be disposed. - - The object to be disposed. - - - - - - - Represents a caching factory for the types used for extensibility throughout the system. - - - - - Disposes the instances that are contained in the cache. - - - - - Gets an instance of the given type, casting it to , using the provided - constructor arguments. There is a single instance of a given type that is cached and reused, - so classes retrieved from this factory must be stateless and thread-safe. - - The interface type. - The message sink used to send diagnostic messages - The implementation type. - The constructor arguments. Since diagnostic message sinks are optional, - the code first looks for a type that takes the given arguments plus the message sink, and only - falls back to the message sink-less constructor if none was found. - The instance of the type. - - - - Gets a data discoverer. - - The message sink used to send diagnostic messages - The discoverer type - - - - Gets a data discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The data discoverer attribute - The data discoverer, if the type is loadable; null, otherwise. - - - - Gets a test case orderer. - - The message sink used to send diagnostic messages - The test case orderer type - - - - Gets a test case orderer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test case orderer attribute. - The test case orderer, if the type is loadable; null, otherwise. - - - - Gets a test collection orderer. - - The message sink used to send diagnostic messages - The test collection orderer type - - - - Gets a test collection orderer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test collection orderer attribute. - The test collection orderer, if the type is loadable; null, otherwise. - - - - Gets a test framework discoverer. - - The message sink used to send diagnostic messages - The test framework type discoverer type - - - - Gets a test framework discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test framework discoverer attribute - - - - Gets a trait discoverer. - - The message sink used to send diagnostic messages - The trait discoverer type - - - - Gets a trait discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The trait discoverer attribute. - The trait discoverer, if the type is loadable; null, otherwise. - - - - Gets an xUnit.net v2 test discoverer. - - The message sink used to send diagnostic messages - The test case discoverer type - - - - Gets an xUnit.net v2 test collection factory. - - The message sink used to send diagnostic messages - The test collection factory type - The test assembly under test - - - - Gets an xUnit.net v2 test collection factory, as specified in a reflected . - - The message sink used to send diagnostic messages - The collection behavior attribute. - The test assembly. - The collection factory. - - - - Implementation of that creates a single - default test collection for the assembly, and places any tests classes without - the into it. - - - - - Initializes a new instance of the class. - - The assembly. - The message sink used to send diagnostic messages - - - - - - - - - - Implementation of which creates a new test - collection for each test class that isn't decorated with . - - - - - Initializes a new instance of the class. - - The assembly info. - The message sink used to send diagnostic messages - - - - - - - - - - A simple implementation of that can be used to report an error - rather than running a test. - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The test method. - The error message to report for the test. - - - - Gets the error message that will be display when the test is run. - - - - - - - - - - - - - - Measures and aggregates execution time of one or more actions. - - - - - Returns the total time aggregated across all the actions. - - - - - Executes an action and aggregates its run time into the total. - - The action to measure. - - - - Executes an asynchronous action and aggregates its run time into the total. - - The action to measure. - - - - Aggregates a time span into the total time. - - The time to add. - - - - Implementation of that supports finding test cases - on methods decorated with . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Creates a single for the given test method. - - The discovery options to be used. - The test method. - The attribute that decorates the test method. - - - - - Discover test cases from a test method. By default, inspects the test method's argument list - to ensure it's empty, and if not, returns a single ; - otherwise, it returns the result of calling . - - The discovery options to be used. - The test method the test cases belong to. - The fact attribute attached to the test method. - Returns zero or more test cases represented by the test method. - - - - An implementation of to support . - - - - - Initializes a new instance of the class. - - The test case that the lambda represents. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - - - - A base class that provides default behavior when running tests in an assembly. It groups the tests - by test collection, and then runs the individual test collections. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The assembly that contains the tests to be run. - The test cases to be run. - The message sink to report diagnostic messages to. - The message sink to report run status to. - The user's requested execution options. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the user's requested execution options. - - - - - Gets or sets the message sink to report diagnostic messages to. - - - - - Gets or sets the message sink to report run status to. - - - - - Gets or sets the assembly that contains the tests to be run. - - - - - Gets or sets the test case orderer that will be used to decide how to order the tests. - - - - - Gets or sets the test collection orderer that will be used to decide how to order the test collections. - - - - - Gets or sets the test cases to be run. - - - - - - - - Override this to provide the display name for the test framework (f.e., "xUnit.net 2.0"). - This value is placed into . - - - - - Override this to provide the environment information (f.e., "32-bit .NET 4.0"). This value is - placed into . - - - - - This method is called just after is sent, but before any test collections are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Creates the message bus to be used for test execution. By default, it inspects - the options for the - flag, and if present, creates a message bus that ensures all messages are delivered - on the same thread. - - The message bus. - - - - Orders the test collections using the . - - Test collections (and the associated test cases) in run order - - - - Runs the tests in the test assembly. - - Returns summary information about the tests that were run. - - - - Runs the list of test collections. By default, groups the tests by collection and runs them synchronously. - - The message bus to report run status to. - The task cancellation token source, used to cancel the test run. - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test collection. - - The message bus to report run status to. - The test collection that is being run. - The test cases to be run. - The task cancellation token source, used to cancel the test run. - Returns summary information about the tests that were run. - - - - A base class that provides default behavior when running test cases. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test case to be run. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case to be run. - - - - - This method is called just after is sent, but before any test collections are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test case. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test method. - - Returns summary information about the tests that were run. - - - - A base class that provides default behavior when running tests in a test class. It groups the tests - by test method, and then runs the individual test methods. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test class to be run. - The test class that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the CLR class that contains the tests to be run. - - - - - Gets the message sink used to send diagnostic messages. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case orderer that will be used to decide how to order the test. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test class to be run. - - - - - Creates the arguments for the test class constructor. Attempts to resolve each parameter - individually, and adds an error when the constructor arguments cannot all be provided. - If the class is static, does not look for constructor, since one will not be needed. - - The test class constructor arguments. - - - - Gets the message to be used when the constructor is missing arguments. - - - - - This method is called just after is sent, but before any test methods are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test class. - - Returns summary information about the tests that were run. - - - - Runs the list of test methods. By default, orders the tests, groups them by method and runs them synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test method. - - The test method that contains the test cases. - The CLR method that contains the tests to be run. - The test cases to be run. - The constructor arguments that will be used to create the test class. - Returns summary information about the tests that were run. - - - - Selects the constructor to be used for the test class. By default, chooses the parameterless - constructor. Override to change the constructor selection logic. - - The constructor to be used for creating the test class. - - - - Tries to supply a test class constructor argument. By default, always fails. Override to - change the argument lookup logic. - - The constructor that will be used to create the test class. - The parameter index. - The parameter information. - The argument value that should be used for the parameter. - Returns true if the argument was supplied; false, otherwise. - - - - A base class that provides default behavior when running tests in a test collection. It groups the tests - by test class, and then runs the individual test classes. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test collection that contains the tests to be run. - The test cases to be run. - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case orderer that will be used to decide how to order the test. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test collection that contains the tests to be run. - - - - - This method is called just after is sent, but before any test classes are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test collection. - - Returns summary information about the tests that were run. - - - - Runs the list of test classes. By default, groups the tests by class and runs them synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test class. - - The test class to be run. - The CLR class that contains the tests to be run. - The test cases to be run. - Returns summary information about the tests that were run. - - - - A base class that provides default behavior to invoke a test method. This includes - support for async test methods (both "async Task" and "async void") as well as - creation and disposal of the test class. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the constructor arguments used to construct the test class. - - - - - Gets the display name of the invoked test. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test to be run. - - - - - Gets the test case to be run. - - - - - Gets or sets the runtime type of the class that contains the test method. - - - - - Gets or sets the runtime method of the method that contains the test. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - Gets or sets the object which measures execution time. - - - - - Creates the test class, unless the test method is static or there have already been errors. Note that - this method times the creation of the test class (using ). It is also responsible for - sending the and - messages, so if you override this method without calling the base, you are responsible for all of this behavior. - This method should NEVER throw; any exceptions should be placed into the . - - The class instance, if appropriate; null, otherwise - - - - This method is called just after the test method has finished executing. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before the test method is invoked. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method calls the test method via reflection. This is an available override point - if you need to do some other form of invocation of the actual test method. - - The instance of the test class - The return value from the test method invocation - - - - Creates the test class (if necessary), and invokes the test method. - - Returns the time (in seconds) spent creating the test class, running - the test, and disposing of the test class. - - - - Invokes the test method on the given test class instance. This method sets up support for "async void" - test methods, ensures that the test method has the correct number of arguments, then calls - to do the actual method invocation. It ensure that any async test method is fully completed before returning, and - returns the measured clock time that the invocation took. - - The test class instance - Returns the time taken to invoke the test method - - - - A base class that provides default behavior when running tests in a test method. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test method under test. - The CLR class that contains the test method. - The CLR method that contains the tests to be run. - The test cases to be run. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the CLR class that contains the test method. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the CLR method that contains the tests to be run. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test method that contains the test cases. - - - - - This method is called just after is sent, but before any test cases are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test method. - - Returns summary information about the tests that were run. - - - - Runs the list of test cases. By default, it runs the cases in order, synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run an individual test case. - - The test case to be run. - Returns summary information about the test case run. - - - - A base class that provides default behavior when running a test. This includes support - for skipping tests. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The skip reason, if the test is to be skipped. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the constructor arguments used to construct the test class. - - - - - Gets or sets the display name of the invoked test. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the skip reason for the test, if set. - - - - - Gets or sets the test to be run. - - - - - Gets the test case to be run. - - - - - Gets or sets the runtime type of the class that contains the test method. - - - - - Gets or sets the runtime method of the method that contains the test. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - This method is called just after is sent, but before the test class is created. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the test. - - Returns summary information about the test that was run. - - - - Override this method to invoke the test. - - The exception aggregator used to run code and collect exceptions. - Returns a tuple which includes the execution time (in seconds) spent running the - test method, and any output that was returned by the test. - - - - The test assembly runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The assembly that contains the tests to be run. - The test cases to be run. - The message sink to report diagnostic messages to. - The message sink to report run status to. - The user's requested execution options. - - - - - - - - - - - - - Gets the synchronization context used when potentially running tests in parallel. - If is greater than 0, it creates - and uses an instance of . - - The maximum number of parallel threads. - - - - Ensures the assembly runner is initialized (sets up the collection behavior, - parallelization options, and test orderers from their assembly attributes). - - - - - - - - - - - - - - - - - The test case runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test case to be run. - The display name of the test case. - The skip reason, if the test is to be skipped. - The arguments to be passed to the test class constructor. - The arguments to be passed to the test method. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s that will be used for this test case. - - - - - Gets or sets the arguments passed to the test class constructor - - - - - Gets or sets the display name of the test case - - - - - Gets or sets the skip reason for the test, if set. - - - - - Gets or sets the runtime type for the test class that the test method belongs to. - - - - - Gets of sets the runtime method for the test method that the test case belongs to. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - - - - The test class runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test class to be run. - The test class that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - The mapping of collection fixture types to fixtures. - - - - Gets the fixture mappings that were created during . - - - - - Creates the instance of a class fixture type to be used by the test class. If the fixture can be created, - it should be placed into the dictionary; if it cannot, then the method - should record the error by calling Aggregator.Add. - - The type of the fixture to be created - - - - - - - - - - - - - - - - - - - - - - The test collection runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test collection that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the fixture mappings that were created during . - - - - - - - - - - - Creates the instance of a collection fixture type to be used by the test collection. If the fixture can be created, - it should be placed into the dictionary; if it cannot, then the method - should record the error by calling Aggregator.Add. - - The type of the fixture to be created - - - - Gives an opportunity to override test case orderer. By default, this method gets the - orderer from the collection definition. If this function returns null, the - test case orderer passed into the constructor will be used. - - - - - - - - The test invoker for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The list of s for this test invocation. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s for this test invocation. - - - - - - - - - - - The test method runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test method to be run. - The test class that contains the test method. - The test method that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages to. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - The constructor arguments for the test class. - - - - - - - The test runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The skip reason, if the test is to be skipped. - The list of s for this test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s for this test. - - - - - - - - Override this method to invoke the test method. - - The exception aggregator used to run code and collect exceptions. - Returns the execution time (in seconds) spent running the test method. - - - - The test case runner for xUnit.net v2 theories (which could not be pre-enumerated; - pre-enumerated test cases use ). - - - - - Initializes a new instance of the class. - - The test case to be run. - The display name of the test case. - The skip reason, if the test is to be skipped. - The arguments to be passed to the test class constructor. - The message sink used to send diagnostic messages - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test assembly. - The optional configuration filename (defaults to the - configuration file of the current app domain if not provided) - The version number of the assembly (defaults to "0.0.0.0") - - - - - - - - - - Gets or sets the assembly version. - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test collection the class belongs to - The test class - - - - - - - - - - - - - - - - An implementation of for . - Compares the fully qualified names of the types. - - - - - The singleton instance of the comparer. - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test assembly the collection belongs to - The optional type which contains the collection definition - The display name for the test collection - - - - - - - - - - - - - - - - - - - - - - An implementation of for . - Compares the IDs of the test collections. - - - - - The singleton instance of the comparer. - - - - - - - - - - - A helper class that gets the list of test collection definitions for a given assembly. - Reports any misconfigurations of the test assembly via the diagnostic message sink. - - - - - Gets the test collection definitions for the given assembly. - - The assembly. - The message sink used to send diagnostic messages - A list of mappings from test collection name to test collection definitions (as - - - - A default implementation of that tracks objects to be - disposed when the framework is disposed. The discoverer and executor are automatically - tracked for disposal, since those interfaces mandate an implementation of . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Gets the message sink used to send diagnostic messages. - - - - - Gets the disposal tracker for the test framework. - - - - - - - - - - - Override this method to provide the implementation of . - - The assembly that is being discovered. - Returns the test framework discoverer. - - - - Override this method to provide the implementation of . - - The assembly that is being executed. - Returns the test framework executor. - - - - - - - - - - A base implementation of that supports test filtering - and runs the discovery process on a thread pool thread. - - - - - Initializes a new instance of the class. - - The test assembly. - The source information provider. - The message sink used to send diagnostic messages - - - - Gets the assembly that's being discovered. - - - - - Gets the message sink used to report diagnostic messages. - - - - - Gets the disposal tracker for the test framework discoverer. - - - - - Get the source code information provider used during discovery. - - - - - - - - - - - Implement this method to create a test class for the given CLR type. - - The CLR type. - The test class. - - - - - - - - - - - - - Core implementation to discover unit tests in a given test class. - - The test class. - Set to true to attempt to include source information. - The message sink to send discovery messages to. - The options used by the test framework during discovery. - Returns true if discovery should continue; false otherwise. - - - - Determines if a type should be used for discovery. Can be used to filter out types that - are not desirable. The default implementation filters out abstract (non-static) classes. - - The type. - Returns true if the type can contain tests; false, otherwise. - - - - Reports a discovered test case to the message bus, after updating the source code information - (if desired). - - - - - - - - - - - - A reusable implementation of which contains the basic behavior - for running tests. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - Name of the test assembly. - The source line number information provider. - The message sink to report diagnostic messages to. - - - - Gets the assembly information of the assembly under test. - - - - - Gets the message sink to send diagnostic messages to. - - - - - Gets the disposal tracker for the test framework discoverer. - - - - - Gets the source information provider. - - - - - Override to create a test framework discoverer that can be used to discover - tests when the user asks to run all test. - - The test framework discoverer - - - - - - - - - - - - - - - - Override to run test cases. - - The test cases to be run. - The message sink to report run status to. - The user's requested execution options. - - - - This class proxies for the real implementation of , based on - whether the user has overridden the choice via . If - no attribute is found, defaults to . - - - - - Initializes a new instance of the class. - - The test assembly (expected to implement ). - The source information provider (expected to implement ). - The diagnostic message sink (expected to implement ). - - - - Gets the test framework that's being wrapped by the proxy. - - - - - - - - - - - - - - - - - INTERNAL CLASS. DO NOT USE. - - - - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test class - The test method - - - - - - - - - - - - - - - - An implementation of for . - Compares the names of the methods. - - - - - The singleton instance of the comparer. - - - - - - - - - - - A base class implementation of which is based on test cases being - related directly to test methods. - - - - - Used for de-serialization. - - - - - Initializes a new instance of the class. - - Default method display to use (when not customized). - The test method this test case belongs to. - The arguments for the test method. - - - - Returns the base display name for a test ("TestClassName.MethodName"). - - - - - Returns the default method display to use (when not customized). - - - - - - - - - - - Gets the generic types that were used to close the generic test method, if - applicable; null, if the test method was not an open generic. - - - - - - - - - - - - - - - - - - - - - - - - - - Call to ensure the object is fully initialized(). - - - - - Gets the unique ID for the test case. - - - - Converts an array of bytes to its hexadecimal value as a string. - The bytes. - A string containing the hexademical representation of the provided bytes. - - - Gets a hexademical digit character from the 4-bit value. - A value in the range [0, 15]. - A character in the range ['0','9'] or ['a','f']. - - - - Called when initializing the test cases, either after constructor or de-serialization. - Override this method to add additional initialization-time work. - - - - - - - - - - - Default implementation of . - - - - - Gets the output provided by the test. - - - - - Initialize the test output helper with information about a test case. - - - - - Resets the test output helper to its uninitialized state. - - - - - - - - - - - Implementation of that supports finding test cases - on methods decorated with . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Creates a test case for a single row of data. By default, returns an instance of - with the data row inside of it. - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The row of data for this test case. - The test case - - - - Creates a test case for a skipped theory. By default, returns an instance of - (which inherently discovers the skip reason via the fact attribute). - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The skip reason that decorates . - The test case - - - - Creates a test case for the entire theory. This is used when one or more of the theory data items - are not serializable, or if the user has requested to skip theory pre-enumeration. By default, - returns an instance of , which performs the data discovery at runtime. - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The test case - - - - Discover test cases from a test method. - - - This method performs the following steps: - - If the theory attribute is marked with Skip, returns the single test case from ; - - If pre-enumeration is off, or any of the test data is non serializable, returns the single test case from ; - - If there is no theory data, returns a single test case of with the error in it; - - Otherwise, it returns one test case per data row, created by calling . - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - Returns zero or more test cases represented by the test method. - - - - An implementation of for xUnit v2. - - - - - Initializes a new instance of the class. - - The test case this test belongs to. - The display name for this test. - - - - - - - Gets the xUnit v2 test case. - - - - - - - - Default implementation of for xUnit v2 that supports tests decorated with - both and . - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The test method this test case belongs to. - The arguments for the test method. - - - - Gets the display name for the test case. Calls - with the given base display name (which is itself either derived from , - falling back to . - - The fact attribute the decorated the test case. - The base display name from . - The display name for the test case. - - - - Gets the skip reason for the test case. By default, pulls the skip reason from the - property. - - The fact attribute the decorated the test case. - The skip reason, if skipped; null, otherwise. - - - - - - - - - - The implementation of that supports discovery and - execution of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - - - - - - - The implementation of that supports discovery - of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Gets the display name of the xUnit.net v2 test framework. - - - - - Initializes a new instance of the class. - - The test assembly. - The source information provider. - The message sink used to send diagnostic messages - The test collection factory used to look up test collections. - - - - Gets the test collection factory that makes test collections. - - - - - - - - Finds the tests on a test method. - - The test method. - Set to true to indicate that source information should be included. - The message bus to report discovery messages to. - The options used by the test framework during discovery. - Return true to continue test discovery, false, otherwise. - - - - - - - Gets the test case discover instance for the given discoverer type. The instances are cached - and reused, since they should not be stateful. - - The discoverer type. - Returns the test case discoverer instance. - - - - The implementation of that supports execution - of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Initializes a new instance of the class. - - Name of the test assembly. - The source line number information provider. - The message sink to report diagnostic messages to. - - - - Gets the test assembly that contains the test. - - - - - - - - - - - Represents a test case which runs multiple tests for theory data, either because the - data was not enumerable or because the data was not serializable. - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The method under test. - - - - - - - An implementation of which runs work on custom threads - rather than in the thread pool, and limits the number of in-flight actions. - - - - - Initializes a new instance of the class. - - The maximum number of tasks to run at any one time. - - - - Gets a flag indicating whether maximum concurrency is supported. - - - - - - - - - - - - - - This is an internal class, and is not intended to be called from end-user code. - - - - - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. - - - - - Initializes a new instance of the class. - - The message bus to delegate to. - The callback to send messages to. - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. In addition, - it issues a event when a message of the type - is seen. - - The type of the T final message. - - - - Initializes a new instance of the class. - - The message bus to delegate to. - The callback to send messages to. - - - - The final message that was seen that caused to be triggered. - - - - - An event that is triggered when a message of type is seen. - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. - - - - - Initializes a new instance of the class. - - The inner message sink. - The callback. - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. In addition, - it issues a event when a message of the type - is seen. - - The type of the T final message. - - - - Initializes a new instance of the class. - - The inner message sink. - The callback. - - - - The final message that was seen that caused to be triggered. - - - - - An event that is triggered when a message of type is seen. - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The assembly to be wrapped. - - - - Initializes a new instance of the class. - - The assembly to be wrapped. - - - - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The attribute to be wrapped. - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The method to be wrapped. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The parameter to be wrapped. - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The type to wrap. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Wrapper to implement types from xunit.abstractions.dll using reflection. - - - - - Converts arguments into their target types. Can be particularly useful when pulling attribute - constructor arguments, whose types may not strictly match the parameter types. - - The arguments to be converted. - The target types for the conversion. - The converted arguments. - - - - Converts an into an . - - The assembly to wrap. - The wrapper - - - - Converts an into an using reflection. - - The attribute to wrap. - The wrapper - - - - Converts a into an using reflection. - - The method to wrap - The wrapper - - - - Converts a into an using reflection. - - THe parameter to wrap - The wrapper - - - - Converts a into an using reflection. - - The type to wrap - The wrapper - - - - This is an internal class, and is not intended to be called from end-user code. - - - - - - - - - - - - - - Represents an exception that happened during the process of a test class. This typically - means there were problems identifying the correct test class constructor, or problems - creating the fixture data for the test class. - - - - - Initializes a new instance of the class. - - The exception message. - - - - The implementation of that supports attributes - of type . - - - - - - - - A helper class to retrieve the traits from a method. - - - - - Get the traits from a method. - - The method to get the traits for. - A list of traits that are defined on the method. - - - - Extension methods for . - - - - - Formulates the extended portion of the display name for a test method. For tests with no arguments, this will - return just the base name; for tests with arguments, attempts to format the arguments and appends the argument - list to the test name. - - The test method - The base part of the display name - The test method arguments - The test method's generic types - The full display name for the test method - - - - Resolves a generic type for a test method. The test parameters (and associated parameter infos) are - used to determine the best matching generic type for the test method that can be satisfied by all - the generic parameters and their values. - - The generic type to be resolved - The parameter values being passed to the test method - The parameter infos for the test method - The best matching generic type - - - - Resolves all the generic types for a test method. The test parameters are used to determine - the best matching generic types for the test method that can be satisfied by all - the generic parameters and their values. - - The test method - The parameter values being passed to the test method - The best matching generic types - - - base implementation of MD4 family style digest as outlined in - "Handbook of Applied Cryptography", pages 344 - 347. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - implementation of SHA-1 as outlined in "Handbook of Applied Cryptography", pages 346 - 349. - - It is interesting to ponder why the, apart from the extra IV, the other difference here from MD5 - is the "endianness" of the word processing! - - - - - - - Copy constructor. This will copy the state of the provided - message digest. - - - - - - - - - - - - reset the chaining variables - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of and . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message to send - - - - Initializes a new instance of the class. - - The format of the message to send - The arguments used to format the message - - - - - - - Default implementation of . - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Gets the substitution token used as assembly name suffix to indicate that the assembly is - a generalized reference to the platform-specific assembly. - - - - - A mirror class of the CLR's class. - - - - - Initializes a new instance of the class. - - The data to copy into the serialization info - - - - - - - - - - - - - Returns BASE64 encoded string that represents the entirety of the data. - - - - - Returns a triple for a key/value pair of data in a complex object - - The triple to be serialized - The serialized version of the triple - - - - Returns the triple values out of a serialized triple. - - The serialized triple - The de-serialized triple - - - - De-serializes a value that was serialized with . - - The type of the object to de-serialize into - The serialized value - The de-serialized object - - - - Serializes an object. - - The value to be serialized - The serialized object - - - - Represents a triple of information used when serializing complex types: the property name, - the value to be serialized, and the value's type. - - - - - Gets the triple's key - - - - - Gets the triple's value - - - - - Gets the triple's value type - - - - - Initializes a new instance of the class. - - The triple's key - The triple's value - The triple's value type - - - - Guard class, used for guard clauses and argument validation - - - - - - - - - - - - - - Methods which help bridge and contain the differences between Type and TypeInfo. - - - - - This class represents utility methods needed to supplement the - reflection capabilities provided by the CLR - - - - - Creates an instance of the test class for the given test case. Sends the - and messages as appropriate. - - The test - The type of the test class - The constructor arguments for the test class - The message bus used to send the test messages - The timer used to measure the time taken for construction - The cancellation token source - - - - - Disposes the test class instance. Sends the and - messages as appropriate. - - The test - The test class instance to be disposed - The message bus used to send the test messages - The timer used to measure the time taken for construction - The cancellation token source - - - - Gets methods in the target type that match the protection level of the supplied method - - The type - The method - The reflection method informations that match - - - - Gets all the custom attributes for the given assembly. - - The assembly - The type of the attribute - The matching attributes that decorate the assembly - - - - Gets all the custom attributes for the given attribute. - - The attribute - The type of the attribute to find - The matching attributes that decorate the attribute - - - - Gets all the custom attributes for the method that are of the given type. - - The method - The type of the attribute - The matching attributes that decorate the method - - - - Gets all the custom attributes for the given type. - - The type - The type of the attribute - The matching attributes that decorate the type - - - - Converts an into a , if possible (for example, this - will not work when the test method is based on source code rather than binaries). - - The method to convert - The runtime method, if available; null, otherwise - - - - Converts an into a , if possible (for example, this - will not work when the test class is based on source code rather than binaries). - - The type to convert - The runtime type, if available, null, otherwise - - - - Extension methods for reading and . - - - - - Gets a flag that determines whether diagnostic messages will be emitted. - - - - - Gets a flag that determines whether diagnostic messages will be emitted. If the flag is not present, - returns the default value (false). - - - - - Gets a flag that determines the default display name format for test methods. - - - - - Gets a flag that determines the default display name format for test methods. If the flag is not present, - returns the default value (). - - - - - Gets a flag that determines whether theories are pre-enumerated. If they enabled, then the - discovery system will return a test case for each row of test data; they are disabled, then the - discovery system will return a single test case for the theory. - - - - - Gets a flag that determines whether theories are pre-enumerated. If they enabled, then the - discovery system will return a test case for each row of test data; they are disabled, then the - discovery system will return a single test case for the theory. If the flag is not present, - returns the default value (true). - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - If the flag is not set, returns the default value (false). - - - - - Gets a flag that determines whether diagnostic messages will be emitted. - - - - - Gets a flag that determines whether diagnostic messages will be emitted. If the flag is not - present, returns the default value (false). - - - - - Gets a flag to disable parallelization. - - - - - Gets a flag to disable parallelization. If the flag is not present, returns the - default value (false). - - - - - Gets the maximum number of threads to use when running tests in parallel. - - - - - Gets the maximum number of threads to use when running tests in parallel. If set to 0 (or not set), - the value of is used; if set to a value less - than 0, does not limit the number of threads. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - If the flag is not set, returns the default value (false). - - - - diff --git a/packages/xunit.extensibility.execution.2.1.0/lib/wp8/xunit.execution.dotnet.dll b/packages/xunit.extensibility.execution.2.1.0/lib/wp8/xunit.execution.dotnet.dll deleted file mode 100644 index 3c43440..0000000 Binary files a/packages/xunit.extensibility.execution.2.1.0/lib/wp8/xunit.execution.dotnet.dll and /dev/null differ diff --git a/packages/xunit.extensibility.execution.2.1.0/lib/wp8/xunit.execution.dotnet.xml b/packages/xunit.extensibility.execution.2.1.0/lib/wp8/xunit.execution.dotnet.xml deleted file mode 100644 index d819501..0000000 --- a/packages/xunit.extensibility.execution.2.1.0/lib/wp8/xunit.execution.dotnet.xml +++ /dev/null @@ -1,4157 +0,0 @@ - - - - xunit.execution.dotnet - - - - - Rethrows an exception object without losing the existing stack trace information - - The exception to re-throw. - - For more information on this technique, see - http://www.dotnetjunkies.com/WebLog/chris.taylor/archive/2004/03/03/8353.aspx. - The remote_stack_trace string is here to support Mono. - - - - - Unwraps an exception to remove any wrappers, like . - - The exception to unwrap. - The unwrapped exception. - - - - Utility classes for dealing with Exception objects. - - - - - Combines multiple levels of messages into a single message. - - The failure information from which to get the messages. - The combined string. - - - - Combines multiple levels of stack traces into a single stack trace. - - The failure information from which to get the stack traces. - The combined string. - - - - Unwraps exceptions and their inner exceptions. - - The exception to be converted. - The failure information. - - - - An implementation of that ignores all messages. - - - - - - - - Serializes and de-serializes objects - - - - - De-serializes an object. - - The type of the object - The object's serialized value - The de-serialized object - - - - Serializes an object. - - The value to serialize - The serialized value - - - Gets whether the specified is serializable with . - The object to test for serializability. - true if the object can be serialized; otherwise, false. - - - - Converts an assembly qualified type name into a object. - - The assembly qualified type name. - The instance of the , if available; null, otherwise. - - - - Converts an assembly name + type name into a object. - - The assembly name. - The type name. - The instance of the , if available; null, otherwise. - - - - Gets an assembly qualified type name for serialization, with special dispensation for types which - originate in the execution assembly. - - - - - Retrieves a substring from the string, with whitespace trimmed on both ends. - - The string. - The starting index. - The length. - - A substring starting no earlier than startIndex and ending no later - than startIndex + length. - - - - - Default implementation of . - - - - - - - - - - - - - - - - - An implementation of that provides several Visit methods that - can provide access to specific message types without the burden of casting. - - - - - Dispatches the message to the given callback, if it's of the correct type. - - The message type - The message - The callback - The result of the callback, if called; true, otherwise - - - - Dispatches the message to the given callback, if it's of the correct type. - The callback is provided with both the message and this instance of the visitor. - - The message type - The message - The callback - The result of the callback, if called; true, otherwise - - - - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering/executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - An implementation of that provides several Visit methods that - can provide access to specific message types without the burden of casting. It also records - when it sees a completion message, and sets the event appropriately. - - The type of the completion message. - - - - Initializes a new instance of the class. - - - - - This event is triggered when the completion message has been seen. - - - - - - - - - - - Formats arguments for display in theories. - - - - - Format the value for presentation. - - The value to be formatted. - The formatted value. - - - - Default implementation of used by the xUnit.net equality assertions. - - The type that is being compared. - - - - Initializes a new instance of the class. - - Set to true to skip type equality checks. - The inner comparer to be used when the compared objects are enumerable. - - - - - - - - - - A class that wraps to create . - - The type that is being compared. - - - - Initializes a new instance of the class. - - The comparer that is being adapted. - - - - - - - - - - Base class for all long-lived objects that may cross over an AppDomain. - - - - - Creates a new instance of the type. - - - - - Disconnects all remote objects. - - - - - This implementation of allows the developer to track the count - of outstanding "async void" operations, and wait for them all to complete. - - - - - Initializes a new instance of the class. - - The existing synchronization context (may be null). - - - - - - - - - - - - - - - - Returns a task which is signaled when all outstanding operations are complete. - - - - - Default implementation of . Orders tests in - an unpredictable but stable order, so that repeated test runs of the - identical test assembly run tests in the same order. - - - - - Initializes a new instance of the class. - - Message sink to report diagnostic messages to - - - - - - - Default implementation of . Orders tests in - an unpredictable and unstable order, so that repeated test runs of the - identical test assembly run test collections in a random order. - - - - - - - - Tracks disposable objects, and disposes them in the reverse order they were added to - the tracker. - - - - - Add an object to be disposed. - - The object to be disposed. - - - - - - - Represents a caching factory for the types used for extensibility throughout the system. - - - - - Disposes the instances that are contained in the cache. - - - - - Gets an instance of the given type, casting it to , using the provided - constructor arguments. There is a single instance of a given type that is cached and reused, - so classes retrieved from this factory must be stateless and thread-safe. - - The interface type. - The message sink used to send diagnostic messages - The implementation type. - The constructor arguments. Since diagnostic message sinks are optional, - the code first looks for a type that takes the given arguments plus the message sink, and only - falls back to the message sink-less constructor if none was found. - The instance of the type. - - - - Gets a data discoverer. - - The message sink used to send diagnostic messages - The discoverer type - - - - Gets a data discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The data discoverer attribute - The data discoverer, if the type is loadable; null, otherwise. - - - - Gets a test case orderer. - - The message sink used to send diagnostic messages - The test case orderer type - - - - Gets a test case orderer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test case orderer attribute. - The test case orderer, if the type is loadable; null, otherwise. - - - - Gets a test collection orderer. - - The message sink used to send diagnostic messages - The test collection orderer type - - - - Gets a test collection orderer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test collection orderer attribute. - The test collection orderer, if the type is loadable; null, otherwise. - - - - Gets a test framework discoverer. - - The message sink used to send diagnostic messages - The test framework type discoverer type - - - - Gets a test framework discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test framework discoverer attribute - - - - Gets a trait discoverer. - - The message sink used to send diagnostic messages - The trait discoverer type - - - - Gets a trait discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The trait discoverer attribute. - The trait discoverer, if the type is loadable; null, otherwise. - - - - Gets an xUnit.net v2 test discoverer. - - The message sink used to send diagnostic messages - The test case discoverer type - - - - Gets an xUnit.net v2 test collection factory. - - The message sink used to send diagnostic messages - The test collection factory type - The test assembly under test - - - - Gets an xUnit.net v2 test collection factory, as specified in a reflected . - - The message sink used to send diagnostic messages - The collection behavior attribute. - The test assembly. - The collection factory. - - - - Implementation of that creates a single - default test collection for the assembly, and places any tests classes without - the into it. - - - - - Initializes a new instance of the class. - - The assembly. - The message sink used to send diagnostic messages - - - - - - - - - - Implementation of which creates a new test - collection for each test class that isn't decorated with . - - - - - Initializes a new instance of the class. - - The assembly info. - The message sink used to send diagnostic messages - - - - - - - - - - A simple implementation of that can be used to report an error - rather than running a test. - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The test method. - The error message to report for the test. - - - - Gets the error message that will be display when the test is run. - - - - - - - - - - - - - - Measures and aggregates execution time of one or more actions. - - - - - Returns the total time aggregated across all the actions. - - - - - Executes an action and aggregates its run time into the total. - - The action to measure. - - - - Executes an asynchronous action and aggregates its run time into the total. - - The action to measure. - - - - Aggregates a time span into the total time. - - The time to add. - - - - Implementation of that supports finding test cases - on methods decorated with . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Creates a single for the given test method. - - The discovery options to be used. - The test method. - The attribute that decorates the test method. - - - - - Discover test cases from a test method. By default, inspects the test method's argument list - to ensure it's empty, and if not, returns a single ; - otherwise, it returns the result of calling . - - The discovery options to be used. - The test method the test cases belong to. - The fact attribute attached to the test method. - Returns zero or more test cases represented by the test method. - - - - An implementation of to support . - - - - - Initializes a new instance of the class. - - The test case that the lambda represents. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - - - - A base class that provides default behavior when running tests in an assembly. It groups the tests - by test collection, and then runs the individual test collections. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The assembly that contains the tests to be run. - The test cases to be run. - The message sink to report diagnostic messages to. - The message sink to report run status to. - The user's requested execution options. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the user's requested execution options. - - - - - Gets or sets the message sink to report diagnostic messages to. - - - - - Gets or sets the message sink to report run status to. - - - - - Gets or sets the assembly that contains the tests to be run. - - - - - Gets or sets the test case orderer that will be used to decide how to order the tests. - - - - - Gets or sets the test collection orderer that will be used to decide how to order the test collections. - - - - - Gets or sets the test cases to be run. - - - - - - - - Override this to provide the display name for the test framework (f.e., "xUnit.net 2.0"). - This value is placed into . - - - - - Override this to provide the environment information (f.e., "32-bit .NET 4.0"). This value is - placed into . - - - - - This method is called just after is sent, but before any test collections are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Creates the message bus to be used for test execution. By default, it inspects - the options for the - flag, and if present, creates a message bus that ensures all messages are delivered - on the same thread. - - The message bus. - - - - Orders the test collections using the . - - Test collections (and the associated test cases) in run order - - - - Runs the tests in the test assembly. - - Returns summary information about the tests that were run. - - - - Runs the list of test collections. By default, groups the tests by collection and runs them synchronously. - - The message bus to report run status to. - The task cancellation token source, used to cancel the test run. - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test collection. - - The message bus to report run status to. - The test collection that is being run. - The test cases to be run. - The task cancellation token source, used to cancel the test run. - Returns summary information about the tests that were run. - - - - A base class that provides default behavior when running test cases. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test case to be run. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case to be run. - - - - - This method is called just after is sent, but before any test collections are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test case. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test method. - - Returns summary information about the tests that were run. - - - - A base class that provides default behavior when running tests in a test class. It groups the tests - by test method, and then runs the individual test methods. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test class to be run. - The test class that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the CLR class that contains the tests to be run. - - - - - Gets the message sink used to send diagnostic messages. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case orderer that will be used to decide how to order the test. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test class to be run. - - - - - Creates the arguments for the test class constructor. Attempts to resolve each parameter - individually, and adds an error when the constructor arguments cannot all be provided. - If the class is static, does not look for constructor, since one will not be needed. - - The test class constructor arguments. - - - - Gets the message to be used when the constructor is missing arguments. - - - - - This method is called just after is sent, but before any test methods are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test class. - - Returns summary information about the tests that were run. - - - - Runs the list of test methods. By default, orders the tests, groups them by method and runs them synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test method. - - The test method that contains the test cases. - The CLR method that contains the tests to be run. - The test cases to be run. - The constructor arguments that will be used to create the test class. - Returns summary information about the tests that were run. - - - - Selects the constructor to be used for the test class. By default, chooses the parameterless - constructor. Override to change the constructor selection logic. - - The constructor to be used for creating the test class. - - - - Tries to supply a test class constructor argument. By default, always fails. Override to - change the argument lookup logic. - - The constructor that will be used to create the test class. - The parameter index. - The parameter information. - The argument value that should be used for the parameter. - Returns true if the argument was supplied; false, otherwise. - - - - A base class that provides default behavior when running tests in a test collection. It groups the tests - by test class, and then runs the individual test classes. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test collection that contains the tests to be run. - The test cases to be run. - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case orderer that will be used to decide how to order the test. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test collection that contains the tests to be run. - - - - - This method is called just after is sent, but before any test classes are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test collection. - - Returns summary information about the tests that were run. - - - - Runs the list of test classes. By default, groups the tests by class and runs them synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test class. - - The test class to be run. - The CLR class that contains the tests to be run. - The test cases to be run. - Returns summary information about the tests that were run. - - - - A base class that provides default behavior to invoke a test method. This includes - support for async test methods (both "async Task" and "async void") as well as - creation and disposal of the test class. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the constructor arguments used to construct the test class. - - - - - Gets the display name of the invoked test. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test to be run. - - - - - Gets the test case to be run. - - - - - Gets or sets the runtime type of the class that contains the test method. - - - - - Gets or sets the runtime method of the method that contains the test. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - Gets or sets the object which measures execution time. - - - - - Creates the test class, unless the test method is static or there have already been errors. Note that - this method times the creation of the test class (using ). It is also responsible for - sending the and - messages, so if you override this method without calling the base, you are responsible for all of this behavior. - This method should NEVER throw; any exceptions should be placed into the . - - The class instance, if appropriate; null, otherwise - - - - This method is called just after the test method has finished executing. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before the test method is invoked. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method calls the test method via reflection. This is an available override point - if you need to do some other form of invocation of the actual test method. - - The instance of the test class - The return value from the test method invocation - - - - Creates the test class (if necessary), and invokes the test method. - - Returns the time (in seconds) spent creating the test class, running - the test, and disposing of the test class. - - - - Invokes the test method on the given test class instance. This method sets up support for "async void" - test methods, ensures that the test method has the correct number of arguments, then calls - to do the actual method invocation. It ensure that any async test method is fully completed before returning, and - returns the measured clock time that the invocation took. - - The test class instance - Returns the time taken to invoke the test method - - - - A base class that provides default behavior when running tests in a test method. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test method under test. - The CLR class that contains the test method. - The CLR method that contains the tests to be run. - The test cases to be run. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the CLR class that contains the test method. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the CLR method that contains the tests to be run. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test method that contains the test cases. - - - - - This method is called just after is sent, but before any test cases are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test method. - - Returns summary information about the tests that were run. - - - - Runs the list of test cases. By default, it runs the cases in order, synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run an individual test case. - - The test case to be run. - Returns summary information about the test case run. - - - - A base class that provides default behavior when running a test. This includes support - for skipping tests. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The skip reason, if the test is to be skipped. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the constructor arguments used to construct the test class. - - - - - Gets or sets the display name of the invoked test. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the skip reason for the test, if set. - - - - - Gets or sets the test to be run. - - - - - Gets the test case to be run. - - - - - Gets or sets the runtime type of the class that contains the test method. - - - - - Gets or sets the runtime method of the method that contains the test. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - This method is called just after is sent, but before the test class is created. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the test. - - Returns summary information about the test that was run. - - - - Override this method to invoke the test. - - The exception aggregator used to run code and collect exceptions. - Returns a tuple which includes the execution time (in seconds) spent running the - test method, and any output that was returned by the test. - - - - The test assembly runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The assembly that contains the tests to be run. - The test cases to be run. - The message sink to report diagnostic messages to. - The message sink to report run status to. - The user's requested execution options. - - - - - - - - - - - - - Gets the synchronization context used when potentially running tests in parallel. - If is greater than 0, it creates - and uses an instance of . - - The maximum number of parallel threads. - - - - Ensures the assembly runner is initialized (sets up the collection behavior, - parallelization options, and test orderers from their assembly attributes). - - - - - - - - - - - - - - - - - The test case runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test case to be run. - The display name of the test case. - The skip reason, if the test is to be skipped. - The arguments to be passed to the test class constructor. - The arguments to be passed to the test method. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s that will be used for this test case. - - - - - Gets or sets the arguments passed to the test class constructor - - - - - Gets or sets the display name of the test case - - - - - Gets or sets the skip reason for the test, if set. - - - - - Gets or sets the runtime type for the test class that the test method belongs to. - - - - - Gets of sets the runtime method for the test method that the test case belongs to. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - - - - The test class runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test class to be run. - The test class that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - The mapping of collection fixture types to fixtures. - - - - Gets the fixture mappings that were created during . - - - - - Creates the instance of a class fixture type to be used by the test class. If the fixture can be created, - it should be placed into the dictionary; if it cannot, then the method - should record the error by calling Aggregator.Add. - - The type of the fixture to be created - - - - - - - - - - - - - - - - - - - - - - The test collection runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test collection that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the fixture mappings that were created during . - - - - - - - - - - - Creates the instance of a collection fixture type to be used by the test collection. If the fixture can be created, - it should be placed into the dictionary; if it cannot, then the method - should record the error by calling Aggregator.Add. - - The type of the fixture to be created - - - - Gives an opportunity to override test case orderer. By default, this method gets the - orderer from the collection definition. If this function returns null, the - test case orderer passed into the constructor will be used. - - - - - - - - The test invoker for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The list of s for this test invocation. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s for this test invocation. - - - - - - - - - - - The test method runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test method to be run. - The test class that contains the test method. - The test method that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages to. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - The constructor arguments for the test class. - - - - - - - The test runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The skip reason, if the test is to be skipped. - The list of s for this test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s for this test. - - - - - - - - Override this method to invoke the test method. - - The exception aggregator used to run code and collect exceptions. - Returns the execution time (in seconds) spent running the test method. - - - - The test case runner for xUnit.net v2 theories (which could not be pre-enumerated; - pre-enumerated test cases use ). - - - - - Initializes a new instance of the class. - - The test case to be run. - The display name of the test case. - The skip reason, if the test is to be skipped. - The arguments to be passed to the test class constructor. - The message sink used to send diagnostic messages - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test assembly. - The optional configuration filename (defaults to the - configuration file of the current app domain if not provided) - The version number of the assembly (defaults to "0.0.0.0") - - - - - - - - - - Gets or sets the assembly version. - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test collection the class belongs to - The test class - - - - - - - - - - - - - - - - An implementation of for . - Compares the fully qualified names of the types. - - - - - The singleton instance of the comparer. - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test assembly the collection belongs to - The optional type which contains the collection definition - The display name for the test collection - - - - - - - - - - - - - - - - - - - - - - An implementation of for . - Compares the IDs of the test collections. - - - - - The singleton instance of the comparer. - - - - - - - - - - - A helper class that gets the list of test collection definitions for a given assembly. - Reports any misconfigurations of the test assembly via the diagnostic message sink. - - - - - Gets the test collection definitions for the given assembly. - - The assembly. - The message sink used to send diagnostic messages - A list of mappings from test collection name to test collection definitions (as - - - - A default implementation of that tracks objects to be - disposed when the framework is disposed. The discoverer and executor are automatically - tracked for disposal, since those interfaces mandate an implementation of . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Gets the message sink used to send diagnostic messages. - - - - - Gets the disposal tracker for the test framework. - - - - - - - - - - - Override this method to provide the implementation of . - - The assembly that is being discovered. - Returns the test framework discoverer. - - - - Override this method to provide the implementation of . - - The assembly that is being executed. - Returns the test framework executor. - - - - - - - - - - A base implementation of that supports test filtering - and runs the discovery process on a thread pool thread. - - - - - Initializes a new instance of the class. - - The test assembly. - The source information provider. - The message sink used to send diagnostic messages - - - - Gets the assembly that's being discovered. - - - - - Gets the message sink used to report diagnostic messages. - - - - - Gets the disposal tracker for the test framework discoverer. - - - - - Get the source code information provider used during discovery. - - - - - - - - - - - Implement this method to create a test class for the given CLR type. - - The CLR type. - The test class. - - - - - - - - - - - - - Core implementation to discover unit tests in a given test class. - - The test class. - Set to true to attempt to include source information. - The message sink to send discovery messages to. - The options used by the test framework during discovery. - Returns true if discovery should continue; false otherwise. - - - - Determines if a type should be used for discovery. Can be used to filter out types that - are not desirable. The default implementation filters out abstract (non-static) classes. - - The type. - Returns true if the type can contain tests; false, otherwise. - - - - Reports a discovered test case to the message bus, after updating the source code information - (if desired). - - - - - - - - - - - - A reusable implementation of which contains the basic behavior - for running tests. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - Name of the test assembly. - The source line number information provider. - The message sink to report diagnostic messages to. - - - - Gets the assembly information of the assembly under test. - - - - - Gets the message sink to send diagnostic messages to. - - - - - Gets the disposal tracker for the test framework discoverer. - - - - - Gets the source information provider. - - - - - Override to create a test framework discoverer that can be used to discover - tests when the user asks to run all test. - - The test framework discoverer - - - - - - - - - - - - - - - - Override to run test cases. - - The test cases to be run. - The message sink to report run status to. - The user's requested execution options. - - - - This class proxies for the real implementation of , based on - whether the user has overridden the choice via . If - no attribute is found, defaults to . - - - - - Initializes a new instance of the class. - - The test assembly (expected to implement ). - The source information provider (expected to implement ). - The diagnostic message sink (expected to implement ). - - - - Gets the test framework that's being wrapped by the proxy. - - - - - - - - - - - - - - - - - INTERNAL CLASS. DO NOT USE. - - - - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test class - The test method - - - - - - - - - - - - - - - - An implementation of for . - Compares the names of the methods. - - - - - The singleton instance of the comparer. - - - - - - - - - - - A base class implementation of which is based on test cases being - related directly to test methods. - - - - - Used for de-serialization. - - - - - Initializes a new instance of the class. - - Default method display to use (when not customized). - The test method this test case belongs to. - The arguments for the test method. - - - - Returns the base display name for a test ("TestClassName.MethodName"). - - - - - Returns the default method display to use (when not customized). - - - - - - - - - - - Gets the generic types that were used to close the generic test method, if - applicable; null, if the test method was not an open generic. - - - - - - - - - - - - - - - - - - - - - - - - - - Call to ensure the object is fully initialized(). - - - - - Gets the unique ID for the test case. - - - - Converts an array of bytes to its hexadecimal value as a string. - The bytes. - A string containing the hexademical representation of the provided bytes. - - - Gets a hexademical digit character from the 4-bit value. - A value in the range [0, 15]. - A character in the range ['0','9'] or ['a','f']. - - - - Called when initializing the test cases, either after constructor or de-serialization. - Override this method to add additional initialization-time work. - - - - - - - - - - - Default implementation of . - - - - - Gets the output provided by the test. - - - - - Initialize the test output helper with information about a test case. - - - - - Resets the test output helper to its uninitialized state. - - - - - - - - - - - Implementation of that supports finding test cases - on methods decorated with . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Creates a test case for a single row of data. By default, returns an instance of - with the data row inside of it. - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The row of data for this test case. - The test case - - - - Creates a test case for a skipped theory. By default, returns an instance of - (which inherently discovers the skip reason via the fact attribute). - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The skip reason that decorates . - The test case - - - - Creates a test case for the entire theory. This is used when one or more of the theory data items - are not serializable, or if the user has requested to skip theory pre-enumeration. By default, - returns an instance of , which performs the data discovery at runtime. - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The test case - - - - Discover test cases from a test method. - - - This method performs the following steps: - - If the theory attribute is marked with Skip, returns the single test case from ; - - If pre-enumeration is off, or any of the test data is non serializable, returns the single test case from ; - - If there is no theory data, returns a single test case of with the error in it; - - Otherwise, it returns one test case per data row, created by calling . - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - Returns zero or more test cases represented by the test method. - - - - An implementation of for xUnit v2. - - - - - Initializes a new instance of the class. - - The test case this test belongs to. - The display name for this test. - - - - - - - Gets the xUnit v2 test case. - - - - - - - - Default implementation of for xUnit v2 that supports tests decorated with - both and . - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The test method this test case belongs to. - The arguments for the test method. - - - - Gets the display name for the test case. Calls - with the given base display name (which is itself either derived from , - falling back to . - - The fact attribute the decorated the test case. - The base display name from . - The display name for the test case. - - - - Gets the skip reason for the test case. By default, pulls the skip reason from the - property. - - The fact attribute the decorated the test case. - The skip reason, if skipped; null, otherwise. - - - - - - - - - - The implementation of that supports discovery and - execution of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - - - - - - - The implementation of that supports discovery - of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Gets the display name of the xUnit.net v2 test framework. - - - - - Initializes a new instance of the class. - - The test assembly. - The source information provider. - The message sink used to send diagnostic messages - The test collection factory used to look up test collections. - - - - Gets the test collection factory that makes test collections. - - - - - - - - Finds the tests on a test method. - - The test method. - Set to true to indicate that source information should be included. - The message bus to report discovery messages to. - The options used by the test framework during discovery. - Return true to continue test discovery, false, otherwise. - - - - - - - Gets the test case discover instance for the given discoverer type. The instances are cached - and reused, since they should not be stateful. - - The discoverer type. - Returns the test case discoverer instance. - - - - The implementation of that supports execution - of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Initializes a new instance of the class. - - Name of the test assembly. - The source line number information provider. - The message sink to report diagnostic messages to. - - - - Gets the test assembly that contains the test. - - - - - - - - - - - Represents a test case which runs multiple tests for theory data, either because the - data was not enumerable or because the data was not serializable. - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The method under test. - - - - - - - An implementation of which runs work on custom threads - rather than in the thread pool, and limits the number of in-flight actions. - - - - - Initializes a new instance of the class. - - The maximum number of tasks to run at any one time. - - - - Gets a flag indicating whether maximum concurrency is supported. - - - - - - - - - - - - - - This is an internal class, and is not intended to be called from end-user code. - - - - - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. - - - - - Initializes a new instance of the class. - - The message bus to delegate to. - The callback to send messages to. - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. In addition, - it issues a event when a message of the type - is seen. - - The type of the T final message. - - - - Initializes a new instance of the class. - - The message bus to delegate to. - The callback to send messages to. - - - - The final message that was seen that caused to be triggered. - - - - - An event that is triggered when a message of type is seen. - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. - - - - - Initializes a new instance of the class. - - The inner message sink. - The callback. - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. In addition, - it issues a event when a message of the type - is seen. - - The type of the T final message. - - - - Initializes a new instance of the class. - - The inner message sink. - The callback. - - - - The final message that was seen that caused to be triggered. - - - - - An event that is triggered when a message of type is seen. - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The assembly to be wrapped. - - - - Initializes a new instance of the class. - - The assembly to be wrapped. - - - - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The attribute to be wrapped. - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The method to be wrapped. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The parameter to be wrapped. - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The type to wrap. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Wrapper to implement types from xunit.abstractions.dll using reflection. - - - - - Converts arguments into their target types. Can be particularly useful when pulling attribute - constructor arguments, whose types may not strictly match the parameter types. - - The arguments to be converted. - The target types for the conversion. - The converted arguments. - - - - Converts an into an . - - The assembly to wrap. - The wrapper - - - - Converts an into an using reflection. - - The attribute to wrap. - The wrapper - - - - Converts a into an using reflection. - - The method to wrap - The wrapper - - - - Converts a into an using reflection. - - THe parameter to wrap - The wrapper - - - - Converts a into an using reflection. - - The type to wrap - The wrapper - - - - This is an internal class, and is not intended to be called from end-user code. - - - - - - - - - - - - - - Represents an exception that happened during the process of a test class. This typically - means there were problems identifying the correct test class constructor, or problems - creating the fixture data for the test class. - - - - - Initializes a new instance of the class. - - The exception message. - - - - The implementation of that supports attributes - of type . - - - - - - - - A helper class to retrieve the traits from a method. - - - - - Get the traits from a method. - - The method to get the traits for. - A list of traits that are defined on the method. - - - - Extension methods for . - - - - - Formulates the extended portion of the display name for a test method. For tests with no arguments, this will - return just the base name; for tests with arguments, attempts to format the arguments and appends the argument - list to the test name. - - The test method - The base part of the display name - The test method arguments - The test method's generic types - The full display name for the test method - - - - Resolves a generic type for a test method. The test parameters (and associated parameter infos) are - used to determine the best matching generic type for the test method that can be satisfied by all - the generic parameters and their values. - - The generic type to be resolved - The parameter values being passed to the test method - The parameter infos for the test method - The best matching generic type - - - - Resolves all the generic types for a test method. The test parameters are used to determine - the best matching generic types for the test method that can be satisfied by all - the generic parameters and their values. - - The test method - The parameter values being passed to the test method - The best matching generic types - - - base implementation of MD4 family style digest as outlined in - "Handbook of Applied Cryptography", pages 344 - 347. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - implementation of SHA-1 as outlined in "Handbook of Applied Cryptography", pages 346 - 349. - - It is interesting to ponder why the, apart from the extra IV, the other difference here from MD5 - is the "endianness" of the word processing! - - - - - - - Copy constructor. This will copy the state of the provided - message digest. - - - - - - - - - - - - reset the chaining variables - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of and . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message to send - - - - Initializes a new instance of the class. - - The format of the message to send - The arguments used to format the message - - - - - - - Default implementation of . - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Gets the substitution token used as assembly name suffix to indicate that the assembly is - a generalized reference to the platform-specific assembly. - - - - - A mirror class of the CLR's class. - - - - - Initializes a new instance of the class. - - The data to copy into the serialization info - - - - - - - - - - - - - Returns BASE64 encoded string that represents the entirety of the data. - - - - - Returns a triple for a key/value pair of data in a complex object - - The triple to be serialized - The serialized version of the triple - - - - Returns the triple values out of a serialized triple. - - The serialized triple - The de-serialized triple - - - - De-serializes a value that was serialized with . - - The type of the object to de-serialize into - The serialized value - The de-serialized object - - - - Serializes an object. - - The value to be serialized - The serialized object - - - - Represents a triple of information used when serializing complex types: the property name, - the value to be serialized, and the value's type. - - - - - Gets the triple's key - - - - - Gets the triple's value - - - - - Gets the triple's value type - - - - - Initializes a new instance of the class. - - The triple's key - The triple's value - The triple's value type - - - - Guard class, used for guard clauses and argument validation - - - - - - - - - - - - - - Methods which help bridge and contain the differences between Type and TypeInfo. - - - - - This class represents utility methods needed to supplement the - reflection capabilities provided by the CLR - - - - - Creates an instance of the test class for the given test case. Sends the - and messages as appropriate. - - The test - The type of the test class - The constructor arguments for the test class - The message bus used to send the test messages - The timer used to measure the time taken for construction - The cancellation token source - - - - - Disposes the test class instance. Sends the and - messages as appropriate. - - The test - The test class instance to be disposed - The message bus used to send the test messages - The timer used to measure the time taken for construction - The cancellation token source - - - - Gets methods in the target type that match the protection level of the supplied method - - The type - The method - The reflection method informations that match - - - - Gets all the custom attributes for the given assembly. - - The assembly - The type of the attribute - The matching attributes that decorate the assembly - - - - Gets all the custom attributes for the given attribute. - - The attribute - The type of the attribute to find - The matching attributes that decorate the attribute - - - - Gets all the custom attributes for the method that are of the given type. - - The method - The type of the attribute - The matching attributes that decorate the method - - - - Gets all the custom attributes for the given type. - - The type - The type of the attribute - The matching attributes that decorate the type - - - - Converts an into a , if possible (for example, this - will not work when the test method is based on source code rather than binaries). - - The method to convert - The runtime method, if available; null, otherwise - - - - Converts an into a , if possible (for example, this - will not work when the test class is based on source code rather than binaries). - - The type to convert - The runtime type, if available, null, otherwise - - - - Extension methods for reading and . - - - - - Gets a flag that determines whether diagnostic messages will be emitted. - - - - - Gets a flag that determines whether diagnostic messages will be emitted. If the flag is not present, - returns the default value (false). - - - - - Gets a flag that determines the default display name format for test methods. - - - - - Gets a flag that determines the default display name format for test methods. If the flag is not present, - returns the default value (). - - - - - Gets a flag that determines whether theories are pre-enumerated. If they enabled, then the - discovery system will return a test case for each row of test data; they are disabled, then the - discovery system will return a single test case for the theory. - - - - - Gets a flag that determines whether theories are pre-enumerated. If they enabled, then the - discovery system will return a test case for each row of test data; they are disabled, then the - discovery system will return a single test case for the theory. If the flag is not present, - returns the default value (true). - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - If the flag is not set, returns the default value (false). - - - - - Gets a flag that determines whether diagnostic messages will be emitted. - - - - - Gets a flag that determines whether diagnostic messages will be emitted. If the flag is not - present, returns the default value (false). - - - - - Gets a flag to disable parallelization. - - - - - Gets a flag to disable parallelization. If the flag is not present, returns the - default value (false). - - - - - Gets the maximum number of threads to use when running tests in parallel. - - - - - Gets the maximum number of threads to use when running tests in parallel. If set to 0 (or not set), - the value of is used; if set to a value less - than 0, does not limit the number of threads. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - If the flag is not set, returns the default value (false). - - - - diff --git a/packages/xunit.extensibility.execution.2.1.0/lib/wpa81/xunit.execution.dotnet.dll b/packages/xunit.extensibility.execution.2.1.0/lib/wpa81/xunit.execution.dotnet.dll deleted file mode 100644 index 3c43440..0000000 Binary files a/packages/xunit.extensibility.execution.2.1.0/lib/wpa81/xunit.execution.dotnet.dll and /dev/null differ diff --git a/packages/xunit.extensibility.execution.2.1.0/lib/wpa81/xunit.execution.dotnet.xml b/packages/xunit.extensibility.execution.2.1.0/lib/wpa81/xunit.execution.dotnet.xml deleted file mode 100644 index d819501..0000000 --- a/packages/xunit.extensibility.execution.2.1.0/lib/wpa81/xunit.execution.dotnet.xml +++ /dev/null @@ -1,4157 +0,0 @@ - - - - xunit.execution.dotnet - - - - - Rethrows an exception object without losing the existing stack trace information - - The exception to re-throw. - - For more information on this technique, see - http://www.dotnetjunkies.com/WebLog/chris.taylor/archive/2004/03/03/8353.aspx. - The remote_stack_trace string is here to support Mono. - - - - - Unwraps an exception to remove any wrappers, like . - - The exception to unwrap. - The unwrapped exception. - - - - Utility classes for dealing with Exception objects. - - - - - Combines multiple levels of messages into a single message. - - The failure information from which to get the messages. - The combined string. - - - - Combines multiple levels of stack traces into a single stack trace. - - The failure information from which to get the stack traces. - The combined string. - - - - Unwraps exceptions and their inner exceptions. - - The exception to be converted. - The failure information. - - - - An implementation of that ignores all messages. - - - - - - - - Serializes and de-serializes objects - - - - - De-serializes an object. - - The type of the object - The object's serialized value - The de-serialized object - - - - Serializes an object. - - The value to serialize - The serialized value - - - Gets whether the specified is serializable with . - The object to test for serializability. - true if the object can be serialized; otherwise, false. - - - - Converts an assembly qualified type name into a object. - - The assembly qualified type name. - The instance of the , if available; null, otherwise. - - - - Converts an assembly name + type name into a object. - - The assembly name. - The type name. - The instance of the , if available; null, otherwise. - - - - Gets an assembly qualified type name for serialization, with special dispensation for types which - originate in the execution assembly. - - - - - Retrieves a substring from the string, with whitespace trimmed on both ends. - - The string. - The starting index. - The length. - - A substring starting no earlier than startIndex and ending no later - than startIndex + length. - - - - - Default implementation of . - - - - - - - - - - - - - - - - - An implementation of that provides several Visit methods that - can provide access to specific message types without the burden of casting. - - - - - Dispatches the message to the given callback, if it's of the correct type. - - The message type - The message - The callback - The result of the callback, if called; true, otherwise - - - - Dispatches the message to the given callback, if it's of the correct type. - The callback is provided with both the message and this instance of the visitor. - - The message type - The message - The callback - The result of the callback, if called; true, otherwise - - - - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering/executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - An implementation of that provides several Visit methods that - can provide access to specific message types without the burden of casting. It also records - when it sees a completion message, and sets the event appropriately. - - The type of the completion message. - - - - Initializes a new instance of the class. - - - - - This event is triggered when the completion message has been seen. - - - - - - - - - - - Formats arguments for display in theories. - - - - - Format the value for presentation. - - The value to be formatted. - The formatted value. - - - - Default implementation of used by the xUnit.net equality assertions. - - The type that is being compared. - - - - Initializes a new instance of the class. - - Set to true to skip type equality checks. - The inner comparer to be used when the compared objects are enumerable. - - - - - - - - - - A class that wraps to create . - - The type that is being compared. - - - - Initializes a new instance of the class. - - The comparer that is being adapted. - - - - - - - - - - Base class for all long-lived objects that may cross over an AppDomain. - - - - - Creates a new instance of the type. - - - - - Disconnects all remote objects. - - - - - This implementation of allows the developer to track the count - of outstanding "async void" operations, and wait for them all to complete. - - - - - Initializes a new instance of the class. - - The existing synchronization context (may be null). - - - - - - - - - - - - - - - - Returns a task which is signaled when all outstanding operations are complete. - - - - - Default implementation of . Orders tests in - an unpredictable but stable order, so that repeated test runs of the - identical test assembly run tests in the same order. - - - - - Initializes a new instance of the class. - - Message sink to report diagnostic messages to - - - - - - - Default implementation of . Orders tests in - an unpredictable and unstable order, so that repeated test runs of the - identical test assembly run test collections in a random order. - - - - - - - - Tracks disposable objects, and disposes them in the reverse order they were added to - the tracker. - - - - - Add an object to be disposed. - - The object to be disposed. - - - - - - - Represents a caching factory for the types used for extensibility throughout the system. - - - - - Disposes the instances that are contained in the cache. - - - - - Gets an instance of the given type, casting it to , using the provided - constructor arguments. There is a single instance of a given type that is cached and reused, - so classes retrieved from this factory must be stateless and thread-safe. - - The interface type. - The message sink used to send diagnostic messages - The implementation type. - The constructor arguments. Since diagnostic message sinks are optional, - the code first looks for a type that takes the given arguments plus the message sink, and only - falls back to the message sink-less constructor if none was found. - The instance of the type. - - - - Gets a data discoverer. - - The message sink used to send diagnostic messages - The discoverer type - - - - Gets a data discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The data discoverer attribute - The data discoverer, if the type is loadable; null, otherwise. - - - - Gets a test case orderer. - - The message sink used to send diagnostic messages - The test case orderer type - - - - Gets a test case orderer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test case orderer attribute. - The test case orderer, if the type is loadable; null, otherwise. - - - - Gets a test collection orderer. - - The message sink used to send diagnostic messages - The test collection orderer type - - - - Gets a test collection orderer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test collection orderer attribute. - The test collection orderer, if the type is loadable; null, otherwise. - - - - Gets a test framework discoverer. - - The message sink used to send diagnostic messages - The test framework type discoverer type - - - - Gets a test framework discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test framework discoverer attribute - - - - Gets a trait discoverer. - - The message sink used to send diagnostic messages - The trait discoverer type - - - - Gets a trait discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The trait discoverer attribute. - The trait discoverer, if the type is loadable; null, otherwise. - - - - Gets an xUnit.net v2 test discoverer. - - The message sink used to send diagnostic messages - The test case discoverer type - - - - Gets an xUnit.net v2 test collection factory. - - The message sink used to send diagnostic messages - The test collection factory type - The test assembly under test - - - - Gets an xUnit.net v2 test collection factory, as specified in a reflected . - - The message sink used to send diagnostic messages - The collection behavior attribute. - The test assembly. - The collection factory. - - - - Implementation of that creates a single - default test collection for the assembly, and places any tests classes without - the into it. - - - - - Initializes a new instance of the class. - - The assembly. - The message sink used to send diagnostic messages - - - - - - - - - - Implementation of which creates a new test - collection for each test class that isn't decorated with . - - - - - Initializes a new instance of the class. - - The assembly info. - The message sink used to send diagnostic messages - - - - - - - - - - A simple implementation of that can be used to report an error - rather than running a test. - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The test method. - The error message to report for the test. - - - - Gets the error message that will be display when the test is run. - - - - - - - - - - - - - - Measures and aggregates execution time of one or more actions. - - - - - Returns the total time aggregated across all the actions. - - - - - Executes an action and aggregates its run time into the total. - - The action to measure. - - - - Executes an asynchronous action and aggregates its run time into the total. - - The action to measure. - - - - Aggregates a time span into the total time. - - The time to add. - - - - Implementation of that supports finding test cases - on methods decorated with . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Creates a single for the given test method. - - The discovery options to be used. - The test method. - The attribute that decorates the test method. - - - - - Discover test cases from a test method. By default, inspects the test method's argument list - to ensure it's empty, and if not, returns a single ; - otherwise, it returns the result of calling . - - The discovery options to be used. - The test method the test cases belong to. - The fact attribute attached to the test method. - Returns zero or more test cases represented by the test method. - - - - An implementation of to support . - - - - - Initializes a new instance of the class. - - The test case that the lambda represents. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - - - - A base class that provides default behavior when running tests in an assembly. It groups the tests - by test collection, and then runs the individual test collections. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The assembly that contains the tests to be run. - The test cases to be run. - The message sink to report diagnostic messages to. - The message sink to report run status to. - The user's requested execution options. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the user's requested execution options. - - - - - Gets or sets the message sink to report diagnostic messages to. - - - - - Gets or sets the message sink to report run status to. - - - - - Gets or sets the assembly that contains the tests to be run. - - - - - Gets or sets the test case orderer that will be used to decide how to order the tests. - - - - - Gets or sets the test collection orderer that will be used to decide how to order the test collections. - - - - - Gets or sets the test cases to be run. - - - - - - - - Override this to provide the display name for the test framework (f.e., "xUnit.net 2.0"). - This value is placed into . - - - - - Override this to provide the environment information (f.e., "32-bit .NET 4.0"). This value is - placed into . - - - - - This method is called just after is sent, but before any test collections are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Creates the message bus to be used for test execution. By default, it inspects - the options for the - flag, and if present, creates a message bus that ensures all messages are delivered - on the same thread. - - The message bus. - - - - Orders the test collections using the . - - Test collections (and the associated test cases) in run order - - - - Runs the tests in the test assembly. - - Returns summary information about the tests that were run. - - - - Runs the list of test collections. By default, groups the tests by collection and runs them synchronously. - - The message bus to report run status to. - The task cancellation token source, used to cancel the test run. - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test collection. - - The message bus to report run status to. - The test collection that is being run. - The test cases to be run. - The task cancellation token source, used to cancel the test run. - Returns summary information about the tests that were run. - - - - A base class that provides default behavior when running test cases. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test case to be run. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case to be run. - - - - - This method is called just after is sent, but before any test collections are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test case. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test method. - - Returns summary information about the tests that were run. - - - - A base class that provides default behavior when running tests in a test class. It groups the tests - by test method, and then runs the individual test methods. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test class to be run. - The test class that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the CLR class that contains the tests to be run. - - - - - Gets the message sink used to send diagnostic messages. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case orderer that will be used to decide how to order the test. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test class to be run. - - - - - Creates the arguments for the test class constructor. Attempts to resolve each parameter - individually, and adds an error when the constructor arguments cannot all be provided. - If the class is static, does not look for constructor, since one will not be needed. - - The test class constructor arguments. - - - - Gets the message to be used when the constructor is missing arguments. - - - - - This method is called just after is sent, but before any test methods are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test class. - - Returns summary information about the tests that were run. - - - - Runs the list of test methods. By default, orders the tests, groups them by method and runs them synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test method. - - The test method that contains the test cases. - The CLR method that contains the tests to be run. - The test cases to be run. - The constructor arguments that will be used to create the test class. - Returns summary information about the tests that were run. - - - - Selects the constructor to be used for the test class. By default, chooses the parameterless - constructor. Override to change the constructor selection logic. - - The constructor to be used for creating the test class. - - - - Tries to supply a test class constructor argument. By default, always fails. Override to - change the argument lookup logic. - - The constructor that will be used to create the test class. - The parameter index. - The parameter information. - The argument value that should be used for the parameter. - Returns true if the argument was supplied; false, otherwise. - - - - A base class that provides default behavior when running tests in a test collection. It groups the tests - by test class, and then runs the individual test classes. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test collection that contains the tests to be run. - The test cases to be run. - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case orderer that will be used to decide how to order the test. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test collection that contains the tests to be run. - - - - - This method is called just after is sent, but before any test classes are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test collection. - - Returns summary information about the tests that were run. - - - - Runs the list of test classes. By default, groups the tests by class and runs them synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test class. - - The test class to be run. - The CLR class that contains the tests to be run. - The test cases to be run. - Returns summary information about the tests that were run. - - - - A base class that provides default behavior to invoke a test method. This includes - support for async test methods (both "async Task" and "async void") as well as - creation and disposal of the test class. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the constructor arguments used to construct the test class. - - - - - Gets the display name of the invoked test. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test to be run. - - - - - Gets the test case to be run. - - - - - Gets or sets the runtime type of the class that contains the test method. - - - - - Gets or sets the runtime method of the method that contains the test. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - Gets or sets the object which measures execution time. - - - - - Creates the test class, unless the test method is static or there have already been errors. Note that - this method times the creation of the test class (using ). It is also responsible for - sending the and - messages, so if you override this method without calling the base, you are responsible for all of this behavior. - This method should NEVER throw; any exceptions should be placed into the . - - The class instance, if appropriate; null, otherwise - - - - This method is called just after the test method has finished executing. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before the test method is invoked. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method calls the test method via reflection. This is an available override point - if you need to do some other form of invocation of the actual test method. - - The instance of the test class - The return value from the test method invocation - - - - Creates the test class (if necessary), and invokes the test method. - - Returns the time (in seconds) spent creating the test class, running - the test, and disposing of the test class. - - - - Invokes the test method on the given test class instance. This method sets up support for "async void" - test methods, ensures that the test method has the correct number of arguments, then calls - to do the actual method invocation. It ensure that any async test method is fully completed before returning, and - returns the measured clock time that the invocation took. - - The test class instance - Returns the time taken to invoke the test method - - - - A base class that provides default behavior when running tests in a test method. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test method under test. - The CLR class that contains the test method. - The CLR method that contains the tests to be run. - The test cases to be run. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the CLR class that contains the test method. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the CLR method that contains the tests to be run. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test method that contains the test cases. - - - - - This method is called just after is sent, but before any test cases are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test method. - - Returns summary information about the tests that were run. - - - - Runs the list of test cases. By default, it runs the cases in order, synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run an individual test case. - - The test case to be run. - Returns summary information about the test case run. - - - - A base class that provides default behavior when running a test. This includes support - for skipping tests. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The skip reason, if the test is to be skipped. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the constructor arguments used to construct the test class. - - - - - Gets or sets the display name of the invoked test. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the skip reason for the test, if set. - - - - - Gets or sets the test to be run. - - - - - Gets the test case to be run. - - - - - Gets or sets the runtime type of the class that contains the test method. - - - - - Gets or sets the runtime method of the method that contains the test. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - This method is called just after is sent, but before the test class is created. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the test. - - Returns summary information about the test that was run. - - - - Override this method to invoke the test. - - The exception aggregator used to run code and collect exceptions. - Returns a tuple which includes the execution time (in seconds) spent running the - test method, and any output that was returned by the test. - - - - The test assembly runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The assembly that contains the tests to be run. - The test cases to be run. - The message sink to report diagnostic messages to. - The message sink to report run status to. - The user's requested execution options. - - - - - - - - - - - - - Gets the synchronization context used when potentially running tests in parallel. - If is greater than 0, it creates - and uses an instance of . - - The maximum number of parallel threads. - - - - Ensures the assembly runner is initialized (sets up the collection behavior, - parallelization options, and test orderers from their assembly attributes). - - - - - - - - - - - - - - - - - The test case runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test case to be run. - The display name of the test case. - The skip reason, if the test is to be skipped. - The arguments to be passed to the test class constructor. - The arguments to be passed to the test method. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s that will be used for this test case. - - - - - Gets or sets the arguments passed to the test class constructor - - - - - Gets or sets the display name of the test case - - - - - Gets or sets the skip reason for the test, if set. - - - - - Gets or sets the runtime type for the test class that the test method belongs to. - - - - - Gets of sets the runtime method for the test method that the test case belongs to. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - - - - The test class runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test class to be run. - The test class that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - The mapping of collection fixture types to fixtures. - - - - Gets the fixture mappings that were created during . - - - - - Creates the instance of a class fixture type to be used by the test class. If the fixture can be created, - it should be placed into the dictionary; if it cannot, then the method - should record the error by calling Aggregator.Add. - - The type of the fixture to be created - - - - - - - - - - - - - - - - - - - - - - The test collection runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test collection that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the fixture mappings that were created during . - - - - - - - - - - - Creates the instance of a collection fixture type to be used by the test collection. If the fixture can be created, - it should be placed into the dictionary; if it cannot, then the method - should record the error by calling Aggregator.Add. - - The type of the fixture to be created - - - - Gives an opportunity to override test case orderer. By default, this method gets the - orderer from the collection definition. If this function returns null, the - test case orderer passed into the constructor will be used. - - - - - - - - The test invoker for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The list of s for this test invocation. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s for this test invocation. - - - - - - - - - - - The test method runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test method to be run. - The test class that contains the test method. - The test method that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages to. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - The constructor arguments for the test class. - - - - - - - The test runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The skip reason, if the test is to be skipped. - The list of s for this test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s for this test. - - - - - - - - Override this method to invoke the test method. - - The exception aggregator used to run code and collect exceptions. - Returns the execution time (in seconds) spent running the test method. - - - - The test case runner for xUnit.net v2 theories (which could not be pre-enumerated; - pre-enumerated test cases use ). - - - - - Initializes a new instance of the class. - - The test case to be run. - The display name of the test case. - The skip reason, if the test is to be skipped. - The arguments to be passed to the test class constructor. - The message sink used to send diagnostic messages - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test assembly. - The optional configuration filename (defaults to the - configuration file of the current app domain if not provided) - The version number of the assembly (defaults to "0.0.0.0") - - - - - - - - - - Gets or sets the assembly version. - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test collection the class belongs to - The test class - - - - - - - - - - - - - - - - An implementation of for . - Compares the fully qualified names of the types. - - - - - The singleton instance of the comparer. - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test assembly the collection belongs to - The optional type which contains the collection definition - The display name for the test collection - - - - - - - - - - - - - - - - - - - - - - An implementation of for . - Compares the IDs of the test collections. - - - - - The singleton instance of the comparer. - - - - - - - - - - - A helper class that gets the list of test collection definitions for a given assembly. - Reports any misconfigurations of the test assembly via the diagnostic message sink. - - - - - Gets the test collection definitions for the given assembly. - - The assembly. - The message sink used to send diagnostic messages - A list of mappings from test collection name to test collection definitions (as - - - - A default implementation of that tracks objects to be - disposed when the framework is disposed. The discoverer and executor are automatically - tracked for disposal, since those interfaces mandate an implementation of . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Gets the message sink used to send diagnostic messages. - - - - - Gets the disposal tracker for the test framework. - - - - - - - - - - - Override this method to provide the implementation of . - - The assembly that is being discovered. - Returns the test framework discoverer. - - - - Override this method to provide the implementation of . - - The assembly that is being executed. - Returns the test framework executor. - - - - - - - - - - A base implementation of that supports test filtering - and runs the discovery process on a thread pool thread. - - - - - Initializes a new instance of the class. - - The test assembly. - The source information provider. - The message sink used to send diagnostic messages - - - - Gets the assembly that's being discovered. - - - - - Gets the message sink used to report diagnostic messages. - - - - - Gets the disposal tracker for the test framework discoverer. - - - - - Get the source code information provider used during discovery. - - - - - - - - - - - Implement this method to create a test class for the given CLR type. - - The CLR type. - The test class. - - - - - - - - - - - - - Core implementation to discover unit tests in a given test class. - - The test class. - Set to true to attempt to include source information. - The message sink to send discovery messages to. - The options used by the test framework during discovery. - Returns true if discovery should continue; false otherwise. - - - - Determines if a type should be used for discovery. Can be used to filter out types that - are not desirable. The default implementation filters out abstract (non-static) classes. - - The type. - Returns true if the type can contain tests; false, otherwise. - - - - Reports a discovered test case to the message bus, after updating the source code information - (if desired). - - - - - - - - - - - - A reusable implementation of which contains the basic behavior - for running tests. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - Name of the test assembly. - The source line number information provider. - The message sink to report diagnostic messages to. - - - - Gets the assembly information of the assembly under test. - - - - - Gets the message sink to send diagnostic messages to. - - - - - Gets the disposal tracker for the test framework discoverer. - - - - - Gets the source information provider. - - - - - Override to create a test framework discoverer that can be used to discover - tests when the user asks to run all test. - - The test framework discoverer - - - - - - - - - - - - - - - - Override to run test cases. - - The test cases to be run. - The message sink to report run status to. - The user's requested execution options. - - - - This class proxies for the real implementation of , based on - whether the user has overridden the choice via . If - no attribute is found, defaults to . - - - - - Initializes a new instance of the class. - - The test assembly (expected to implement ). - The source information provider (expected to implement ). - The diagnostic message sink (expected to implement ). - - - - Gets the test framework that's being wrapped by the proxy. - - - - - - - - - - - - - - - - - INTERNAL CLASS. DO NOT USE. - - - - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test class - The test method - - - - - - - - - - - - - - - - An implementation of for . - Compares the names of the methods. - - - - - The singleton instance of the comparer. - - - - - - - - - - - A base class implementation of which is based on test cases being - related directly to test methods. - - - - - Used for de-serialization. - - - - - Initializes a new instance of the class. - - Default method display to use (when not customized). - The test method this test case belongs to. - The arguments for the test method. - - - - Returns the base display name for a test ("TestClassName.MethodName"). - - - - - Returns the default method display to use (when not customized). - - - - - - - - - - - Gets the generic types that were used to close the generic test method, if - applicable; null, if the test method was not an open generic. - - - - - - - - - - - - - - - - - - - - - - - - - - Call to ensure the object is fully initialized(). - - - - - Gets the unique ID for the test case. - - - - Converts an array of bytes to its hexadecimal value as a string. - The bytes. - A string containing the hexademical representation of the provided bytes. - - - Gets a hexademical digit character from the 4-bit value. - A value in the range [0, 15]. - A character in the range ['0','9'] or ['a','f']. - - - - Called when initializing the test cases, either after constructor or de-serialization. - Override this method to add additional initialization-time work. - - - - - - - - - - - Default implementation of . - - - - - Gets the output provided by the test. - - - - - Initialize the test output helper with information about a test case. - - - - - Resets the test output helper to its uninitialized state. - - - - - - - - - - - Implementation of that supports finding test cases - on methods decorated with . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Creates a test case for a single row of data. By default, returns an instance of - with the data row inside of it. - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The row of data for this test case. - The test case - - - - Creates a test case for a skipped theory. By default, returns an instance of - (which inherently discovers the skip reason via the fact attribute). - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The skip reason that decorates . - The test case - - - - Creates a test case for the entire theory. This is used when one or more of the theory data items - are not serializable, or if the user has requested to skip theory pre-enumeration. By default, - returns an instance of , which performs the data discovery at runtime. - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The test case - - - - Discover test cases from a test method. - - - This method performs the following steps: - - If the theory attribute is marked with Skip, returns the single test case from ; - - If pre-enumeration is off, or any of the test data is non serializable, returns the single test case from ; - - If there is no theory data, returns a single test case of with the error in it; - - Otherwise, it returns one test case per data row, created by calling . - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - Returns zero or more test cases represented by the test method. - - - - An implementation of for xUnit v2. - - - - - Initializes a new instance of the class. - - The test case this test belongs to. - The display name for this test. - - - - - - - Gets the xUnit v2 test case. - - - - - - - - Default implementation of for xUnit v2 that supports tests decorated with - both and . - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The test method this test case belongs to. - The arguments for the test method. - - - - Gets the display name for the test case. Calls - with the given base display name (which is itself either derived from , - falling back to . - - The fact attribute the decorated the test case. - The base display name from . - The display name for the test case. - - - - Gets the skip reason for the test case. By default, pulls the skip reason from the - property. - - The fact attribute the decorated the test case. - The skip reason, if skipped; null, otherwise. - - - - - - - - - - The implementation of that supports discovery and - execution of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - - - - - - - The implementation of that supports discovery - of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Gets the display name of the xUnit.net v2 test framework. - - - - - Initializes a new instance of the class. - - The test assembly. - The source information provider. - The message sink used to send diagnostic messages - The test collection factory used to look up test collections. - - - - Gets the test collection factory that makes test collections. - - - - - - - - Finds the tests on a test method. - - The test method. - Set to true to indicate that source information should be included. - The message bus to report discovery messages to. - The options used by the test framework during discovery. - Return true to continue test discovery, false, otherwise. - - - - - - - Gets the test case discover instance for the given discoverer type. The instances are cached - and reused, since they should not be stateful. - - The discoverer type. - Returns the test case discoverer instance. - - - - The implementation of that supports execution - of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Initializes a new instance of the class. - - Name of the test assembly. - The source line number information provider. - The message sink to report diagnostic messages to. - - - - Gets the test assembly that contains the test. - - - - - - - - - - - Represents a test case which runs multiple tests for theory data, either because the - data was not enumerable or because the data was not serializable. - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The method under test. - - - - - - - An implementation of which runs work on custom threads - rather than in the thread pool, and limits the number of in-flight actions. - - - - - Initializes a new instance of the class. - - The maximum number of tasks to run at any one time. - - - - Gets a flag indicating whether maximum concurrency is supported. - - - - - - - - - - - - - - This is an internal class, and is not intended to be called from end-user code. - - - - - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. - - - - - Initializes a new instance of the class. - - The message bus to delegate to. - The callback to send messages to. - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. In addition, - it issues a event when a message of the type - is seen. - - The type of the T final message. - - - - Initializes a new instance of the class. - - The message bus to delegate to. - The callback to send messages to. - - - - The final message that was seen that caused to be triggered. - - - - - An event that is triggered when a message of type is seen. - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. - - - - - Initializes a new instance of the class. - - The inner message sink. - The callback. - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. In addition, - it issues a event when a message of the type - is seen. - - The type of the T final message. - - - - Initializes a new instance of the class. - - The inner message sink. - The callback. - - - - The final message that was seen that caused to be triggered. - - - - - An event that is triggered when a message of type is seen. - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The assembly to be wrapped. - - - - Initializes a new instance of the class. - - The assembly to be wrapped. - - - - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The attribute to be wrapped. - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The method to be wrapped. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The parameter to be wrapped. - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The type to wrap. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Wrapper to implement types from xunit.abstractions.dll using reflection. - - - - - Converts arguments into their target types. Can be particularly useful when pulling attribute - constructor arguments, whose types may not strictly match the parameter types. - - The arguments to be converted. - The target types for the conversion. - The converted arguments. - - - - Converts an into an . - - The assembly to wrap. - The wrapper - - - - Converts an into an using reflection. - - The attribute to wrap. - The wrapper - - - - Converts a into an using reflection. - - The method to wrap - The wrapper - - - - Converts a into an using reflection. - - THe parameter to wrap - The wrapper - - - - Converts a into an using reflection. - - The type to wrap - The wrapper - - - - This is an internal class, and is not intended to be called from end-user code. - - - - - - - - - - - - - - Represents an exception that happened during the process of a test class. This typically - means there were problems identifying the correct test class constructor, or problems - creating the fixture data for the test class. - - - - - Initializes a new instance of the class. - - The exception message. - - - - The implementation of that supports attributes - of type . - - - - - - - - A helper class to retrieve the traits from a method. - - - - - Get the traits from a method. - - The method to get the traits for. - A list of traits that are defined on the method. - - - - Extension methods for . - - - - - Formulates the extended portion of the display name for a test method. For tests with no arguments, this will - return just the base name; for tests with arguments, attempts to format the arguments and appends the argument - list to the test name. - - The test method - The base part of the display name - The test method arguments - The test method's generic types - The full display name for the test method - - - - Resolves a generic type for a test method. The test parameters (and associated parameter infos) are - used to determine the best matching generic type for the test method that can be satisfied by all - the generic parameters and their values. - - The generic type to be resolved - The parameter values being passed to the test method - The parameter infos for the test method - The best matching generic type - - - - Resolves all the generic types for a test method. The test parameters are used to determine - the best matching generic types for the test method that can be satisfied by all - the generic parameters and their values. - - The test method - The parameter values being passed to the test method - The best matching generic types - - - base implementation of MD4 family style digest as outlined in - "Handbook of Applied Cryptography", pages 344 - 347. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - implementation of SHA-1 as outlined in "Handbook of Applied Cryptography", pages 346 - 349. - - It is interesting to ponder why the, apart from the extra IV, the other difference here from MD5 - is the "endianness" of the word processing! - - - - - - - Copy constructor. This will copy the state of the provided - message digest. - - - - - - - - - - - - reset the chaining variables - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of and . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message to send - - - - Initializes a new instance of the class. - - The format of the message to send - The arguments used to format the message - - - - - - - Default implementation of . - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Gets the substitution token used as assembly name suffix to indicate that the assembly is - a generalized reference to the platform-specific assembly. - - - - - A mirror class of the CLR's class. - - - - - Initializes a new instance of the class. - - The data to copy into the serialization info - - - - - - - - - - - - - Returns BASE64 encoded string that represents the entirety of the data. - - - - - Returns a triple for a key/value pair of data in a complex object - - The triple to be serialized - The serialized version of the triple - - - - Returns the triple values out of a serialized triple. - - The serialized triple - The de-serialized triple - - - - De-serializes a value that was serialized with . - - The type of the object to de-serialize into - The serialized value - The de-serialized object - - - - Serializes an object. - - The value to be serialized - The serialized object - - - - Represents a triple of information used when serializing complex types: the property name, - the value to be serialized, and the value's type. - - - - - Gets the triple's key - - - - - Gets the triple's value - - - - - Gets the triple's value type - - - - - Initializes a new instance of the class. - - The triple's key - The triple's value - The triple's value type - - - - Guard class, used for guard clauses and argument validation - - - - - - - - - - - - - - Methods which help bridge and contain the differences between Type and TypeInfo. - - - - - This class represents utility methods needed to supplement the - reflection capabilities provided by the CLR - - - - - Creates an instance of the test class for the given test case. Sends the - and messages as appropriate. - - The test - The type of the test class - The constructor arguments for the test class - The message bus used to send the test messages - The timer used to measure the time taken for construction - The cancellation token source - - - - - Disposes the test class instance. Sends the and - messages as appropriate. - - The test - The test class instance to be disposed - The message bus used to send the test messages - The timer used to measure the time taken for construction - The cancellation token source - - - - Gets methods in the target type that match the protection level of the supplied method - - The type - The method - The reflection method informations that match - - - - Gets all the custom attributes for the given assembly. - - The assembly - The type of the attribute - The matching attributes that decorate the assembly - - - - Gets all the custom attributes for the given attribute. - - The attribute - The type of the attribute to find - The matching attributes that decorate the attribute - - - - Gets all the custom attributes for the method that are of the given type. - - The method - The type of the attribute - The matching attributes that decorate the method - - - - Gets all the custom attributes for the given type. - - The type - The type of the attribute - The matching attributes that decorate the type - - - - Converts an into a , if possible (for example, this - will not work when the test method is based on source code rather than binaries). - - The method to convert - The runtime method, if available; null, otherwise - - - - Converts an into a , if possible (for example, this - will not work when the test class is based on source code rather than binaries). - - The type to convert - The runtime type, if available, null, otherwise - - - - Extension methods for reading and . - - - - - Gets a flag that determines whether diagnostic messages will be emitted. - - - - - Gets a flag that determines whether diagnostic messages will be emitted. If the flag is not present, - returns the default value (false). - - - - - Gets a flag that determines the default display name format for test methods. - - - - - Gets a flag that determines the default display name format for test methods. If the flag is not present, - returns the default value (). - - - - - Gets a flag that determines whether theories are pre-enumerated. If they enabled, then the - discovery system will return a test case for each row of test data; they are disabled, then the - discovery system will return a single test case for the theory. - - - - - Gets a flag that determines whether theories are pre-enumerated. If they enabled, then the - discovery system will return a test case for each row of test data; they are disabled, then the - discovery system will return a single test case for the theory. If the flag is not present, - returns the default value (true). - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - If the flag is not set, returns the default value (false). - - - - - Gets a flag that determines whether diagnostic messages will be emitted. - - - - - Gets a flag that determines whether diagnostic messages will be emitted. If the flag is not - present, returns the default value (false). - - - - - Gets a flag to disable parallelization. - - - - - Gets a flag to disable parallelization. If the flag is not present, returns the - default value (false). - - - - - Gets the maximum number of threads to use when running tests in parallel. - - - - - Gets the maximum number of threads to use when running tests in parallel. If set to 0 (or not set), - the value of is used; if set to a value less - than 0, does not limit the number of threads. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - If the flag is not set, returns the default value (false). - - - - diff --git a/packages/xunit.extensibility.execution.2.1.0/lib/xamarinios/xunit.execution.dotnet.dll b/packages/xunit.extensibility.execution.2.1.0/lib/xamarinios/xunit.execution.dotnet.dll deleted file mode 100644 index 3c43440..0000000 Binary files a/packages/xunit.extensibility.execution.2.1.0/lib/xamarinios/xunit.execution.dotnet.dll and /dev/null differ diff --git a/packages/xunit.extensibility.execution.2.1.0/lib/xamarinios/xunit.execution.dotnet.xml b/packages/xunit.extensibility.execution.2.1.0/lib/xamarinios/xunit.execution.dotnet.xml deleted file mode 100644 index d819501..0000000 --- a/packages/xunit.extensibility.execution.2.1.0/lib/xamarinios/xunit.execution.dotnet.xml +++ /dev/null @@ -1,4157 +0,0 @@ - - - - xunit.execution.dotnet - - - - - Rethrows an exception object without losing the existing stack trace information - - The exception to re-throw. - - For more information on this technique, see - http://www.dotnetjunkies.com/WebLog/chris.taylor/archive/2004/03/03/8353.aspx. - The remote_stack_trace string is here to support Mono. - - - - - Unwraps an exception to remove any wrappers, like . - - The exception to unwrap. - The unwrapped exception. - - - - Utility classes for dealing with Exception objects. - - - - - Combines multiple levels of messages into a single message. - - The failure information from which to get the messages. - The combined string. - - - - Combines multiple levels of stack traces into a single stack trace. - - The failure information from which to get the stack traces. - The combined string. - - - - Unwraps exceptions and their inner exceptions. - - The exception to be converted. - The failure information. - - - - An implementation of that ignores all messages. - - - - - - - - Serializes and de-serializes objects - - - - - De-serializes an object. - - The type of the object - The object's serialized value - The de-serialized object - - - - Serializes an object. - - The value to serialize - The serialized value - - - Gets whether the specified is serializable with . - The object to test for serializability. - true if the object can be serialized; otherwise, false. - - - - Converts an assembly qualified type name into a object. - - The assembly qualified type name. - The instance of the , if available; null, otherwise. - - - - Converts an assembly name + type name into a object. - - The assembly name. - The type name. - The instance of the , if available; null, otherwise. - - - - Gets an assembly qualified type name for serialization, with special dispensation for types which - originate in the execution assembly. - - - - - Retrieves a substring from the string, with whitespace trimmed on both ends. - - The string. - The starting index. - The length. - - A substring starting no earlier than startIndex and ending no later - than startIndex + length. - - - - - Default implementation of . - - - - - - - - - - - - - - - - - An implementation of that provides several Visit methods that - can provide access to specific message types without the burden of casting. - - - - - Dispatches the message to the given callback, if it's of the correct type. - - The message type - The message - The callback - The result of the callback, if called; true, otherwise - - - - Dispatches the message to the given callback, if it's of the correct type. - The callback is provided with both the message and this instance of the visitor. - - The message type - The message - The callback - The result of the callback, if called; true, otherwise - - - - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering/executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue discovering tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - Called when an instance of is sent to the message sink. - - The message. - Return true to continue executing tests; false otherwise. - - - - An implementation of that provides several Visit methods that - can provide access to specific message types without the burden of casting. It also records - when it sees a completion message, and sets the event appropriately. - - The type of the completion message. - - - - Initializes a new instance of the class. - - - - - This event is triggered when the completion message has been seen. - - - - - - - - - - - Formats arguments for display in theories. - - - - - Format the value for presentation. - - The value to be formatted. - The formatted value. - - - - Default implementation of used by the xUnit.net equality assertions. - - The type that is being compared. - - - - Initializes a new instance of the class. - - Set to true to skip type equality checks. - The inner comparer to be used when the compared objects are enumerable. - - - - - - - - - - A class that wraps to create . - - The type that is being compared. - - - - Initializes a new instance of the class. - - The comparer that is being adapted. - - - - - - - - - - Base class for all long-lived objects that may cross over an AppDomain. - - - - - Creates a new instance of the type. - - - - - Disconnects all remote objects. - - - - - This implementation of allows the developer to track the count - of outstanding "async void" operations, and wait for them all to complete. - - - - - Initializes a new instance of the class. - - The existing synchronization context (may be null). - - - - - - - - - - - - - - - - Returns a task which is signaled when all outstanding operations are complete. - - - - - Default implementation of . Orders tests in - an unpredictable but stable order, so that repeated test runs of the - identical test assembly run tests in the same order. - - - - - Initializes a new instance of the class. - - Message sink to report diagnostic messages to - - - - - - - Default implementation of . Orders tests in - an unpredictable and unstable order, so that repeated test runs of the - identical test assembly run test collections in a random order. - - - - - - - - Tracks disposable objects, and disposes them in the reverse order they were added to - the tracker. - - - - - Add an object to be disposed. - - The object to be disposed. - - - - - - - Represents a caching factory for the types used for extensibility throughout the system. - - - - - Disposes the instances that are contained in the cache. - - - - - Gets an instance of the given type, casting it to , using the provided - constructor arguments. There is a single instance of a given type that is cached and reused, - so classes retrieved from this factory must be stateless and thread-safe. - - The interface type. - The message sink used to send diagnostic messages - The implementation type. - The constructor arguments. Since diagnostic message sinks are optional, - the code first looks for a type that takes the given arguments plus the message sink, and only - falls back to the message sink-less constructor if none was found. - The instance of the type. - - - - Gets a data discoverer. - - The message sink used to send diagnostic messages - The discoverer type - - - - Gets a data discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The data discoverer attribute - The data discoverer, if the type is loadable; null, otherwise. - - - - Gets a test case orderer. - - The message sink used to send diagnostic messages - The test case orderer type - - - - Gets a test case orderer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test case orderer attribute. - The test case orderer, if the type is loadable; null, otherwise. - - - - Gets a test collection orderer. - - The message sink used to send diagnostic messages - The test collection orderer type - - - - Gets a test collection orderer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test collection orderer attribute. - The test collection orderer, if the type is loadable; null, otherwise. - - - - Gets a test framework discoverer. - - The message sink used to send diagnostic messages - The test framework type discoverer type - - - - Gets a test framework discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The test framework discoverer attribute - - - - Gets a trait discoverer. - - The message sink used to send diagnostic messages - The trait discoverer type - - - - Gets a trait discoverer, as specified in a reflected . - - The message sink used to send diagnostic messages - The trait discoverer attribute. - The trait discoverer, if the type is loadable; null, otherwise. - - - - Gets an xUnit.net v2 test discoverer. - - The message sink used to send diagnostic messages - The test case discoverer type - - - - Gets an xUnit.net v2 test collection factory. - - The message sink used to send diagnostic messages - The test collection factory type - The test assembly under test - - - - Gets an xUnit.net v2 test collection factory, as specified in a reflected . - - The message sink used to send diagnostic messages - The collection behavior attribute. - The test assembly. - The collection factory. - - - - Implementation of that creates a single - default test collection for the assembly, and places any tests classes without - the into it. - - - - - Initializes a new instance of the class. - - The assembly. - The message sink used to send diagnostic messages - - - - - - - - - - Implementation of which creates a new test - collection for each test class that isn't decorated with . - - - - - Initializes a new instance of the class. - - The assembly info. - The message sink used to send diagnostic messages - - - - - - - - - - A simple implementation of that can be used to report an error - rather than running a test. - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The test method. - The error message to report for the test. - - - - Gets the error message that will be display when the test is run. - - - - - - - - - - - - - - Measures and aggregates execution time of one or more actions. - - - - - Returns the total time aggregated across all the actions. - - - - - Executes an action and aggregates its run time into the total. - - The action to measure. - - - - Executes an asynchronous action and aggregates its run time into the total. - - The action to measure. - - - - Aggregates a time span into the total time. - - The time to add. - - - - Implementation of that supports finding test cases - on methods decorated with . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Creates a single for the given test method. - - The discovery options to be used. - The test method. - The attribute that decorates the test method. - - - - - Discover test cases from a test method. By default, inspects the test method's argument list - to ensure it's empty, and if not, returns a single ; - otherwise, it returns the result of calling . - - The discovery options to be used. - The test method the test cases belong to. - The fact attribute attached to the test method. - Returns zero or more test cases represented by the test method. - - - - An implementation of to support . - - - - - Initializes a new instance of the class. - - The test case that the lambda represents. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - - - - A base class that provides default behavior when running tests in an assembly. It groups the tests - by test collection, and then runs the individual test collections. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The assembly that contains the tests to be run. - The test cases to be run. - The message sink to report diagnostic messages to. - The message sink to report run status to. - The user's requested execution options. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the user's requested execution options. - - - - - Gets or sets the message sink to report diagnostic messages to. - - - - - Gets or sets the message sink to report run status to. - - - - - Gets or sets the assembly that contains the tests to be run. - - - - - Gets or sets the test case orderer that will be used to decide how to order the tests. - - - - - Gets or sets the test collection orderer that will be used to decide how to order the test collections. - - - - - Gets or sets the test cases to be run. - - - - - - - - Override this to provide the display name for the test framework (f.e., "xUnit.net 2.0"). - This value is placed into . - - - - - Override this to provide the environment information (f.e., "32-bit .NET 4.0"). This value is - placed into . - - - - - This method is called just after is sent, but before any test collections are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Creates the message bus to be used for test execution. By default, it inspects - the options for the - flag, and if present, creates a message bus that ensures all messages are delivered - on the same thread. - - The message bus. - - - - Orders the test collections using the . - - Test collections (and the associated test cases) in run order - - - - Runs the tests in the test assembly. - - Returns summary information about the tests that were run. - - - - Runs the list of test collections. By default, groups the tests by collection and runs them synchronously. - - The message bus to report run status to. - The task cancellation token source, used to cancel the test run. - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test collection. - - The message bus to report run status to. - The test collection that is being run. - The test cases to be run. - The task cancellation token source, used to cancel the test run. - Returns summary information about the tests that were run. - - - - A base class that provides default behavior when running test cases. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test case to be run. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case to be run. - - - - - This method is called just after is sent, but before any test collections are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test case. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test method. - - Returns summary information about the tests that were run. - - - - A base class that provides default behavior when running tests in a test class. It groups the tests - by test method, and then runs the individual test methods. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test class to be run. - The test class that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the CLR class that contains the tests to be run. - - - - - Gets the message sink used to send diagnostic messages. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case orderer that will be used to decide how to order the test. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test class to be run. - - - - - Creates the arguments for the test class constructor. Attempts to resolve each parameter - individually, and adds an error when the constructor arguments cannot all be provided. - If the class is static, does not look for constructor, since one will not be needed. - - The test class constructor arguments. - - - - Gets the message to be used when the constructor is missing arguments. - - - - - This method is called just after is sent, but before any test methods are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test class. - - Returns summary information about the tests that were run. - - - - Runs the list of test methods. By default, orders the tests, groups them by method and runs them synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test method. - - The test method that contains the test cases. - The CLR method that contains the tests to be run. - The test cases to be run. - The constructor arguments that will be used to create the test class. - Returns summary information about the tests that were run. - - - - Selects the constructor to be used for the test class. By default, chooses the parameterless - constructor. Override to change the constructor selection logic. - - The constructor to be used for creating the test class. - - - - Tries to supply a test class constructor argument. By default, always fails. Override to - change the argument lookup logic. - - The constructor that will be used to create the test class. - The parameter index. - The parameter information. - The argument value that should be used for the parameter. - Returns true if the argument was supplied; false, otherwise. - - - - A base class that provides default behavior when running tests in a test collection. It groups the tests - by test class, and then runs the individual test classes. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test collection that contains the tests to be run. - The test cases to be run. - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test case orderer that will be used to decide how to order the test. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test collection that contains the tests to be run. - - - - - This method is called just after is sent, but before any test classes are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test collection. - - Returns summary information about the tests that were run. - - - - Runs the list of test classes. By default, groups the tests by class and runs them synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run the tests in an individual test class. - - The test class to be run. - The CLR class that contains the tests to be run. - The test cases to be run. - Returns summary information about the tests that were run. - - - - A base class that provides default behavior to invoke a test method. This includes - support for async test methods (both "async Task" and "async void") as well as - creation and disposal of the test class. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the constructor arguments used to construct the test class. - - - - - Gets the display name of the invoked test. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the test to be run. - - - - - Gets the test case to be run. - - - - - Gets or sets the runtime type of the class that contains the test method. - - - - - Gets or sets the runtime method of the method that contains the test. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - Gets or sets the object which measures execution time. - - - - - Creates the test class, unless the test method is static or there have already been errors. Note that - this method times the creation of the test class (using ). It is also responsible for - sending the and - messages, so if you override this method without calling the base, you are responsible for all of this behavior. - This method should NEVER throw; any exceptions should be placed into the . - - The class instance, if appropriate; null, otherwise - - - - This method is called just after the test method has finished executing. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before the test method is invoked. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method calls the test method via reflection. This is an available override point - if you need to do some other form of invocation of the actual test method. - - The instance of the test class - The return value from the test method invocation - - - - Creates the test class (if necessary), and invokes the test method. - - Returns the time (in seconds) spent creating the test class, running - the test, and disposing of the test class. - - - - Invokes the test method on the given test class instance. This method sets up support for "async void" - test methods, ensures that the test method has the correct number of arguments, then calls - to do the actual method invocation. It ensure that any async test method is fully completed before returning, and - returns the measured clock time that the invocation took. - - The test class instance - Returns the time taken to invoke the test method - - - - A base class that provides default behavior when running tests in a test method. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test method under test. - The CLR class that contains the test method. - The CLR method that contains the tests to be run. - The test cases to be run. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the CLR class that contains the test method. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the CLR method that contains the tests to be run. - - - - - Gets or sets the test cases to be run. - - - - - Gets or sets the test method that contains the test cases. - - - - - This method is called just after is sent, but before any test cases are run. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the tests in the test method. - - Returns summary information about the tests that were run. - - - - Runs the list of test cases. By default, it runs the cases in order, synchronously. - - Returns summary information about the tests that were run. - - - - Override this method to run an individual test case. - - The test case to be run. - Returns summary information about the test case run. - - - - A base class that provides default behavior when running a test. This includes support - for skipping tests. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The skip reason, if the test is to be skipped. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets or sets the exception aggregator used to run code and collect exceptions. - - - - - Gets or sets the task cancellation token source, used to cancel the test run. - - - - - Gets or sets the constructor arguments used to construct the test class. - - - - - Gets or sets the display name of the invoked test. - - - - - Gets or sets the message bus to report run status to. - - - - - Gets or sets the skip reason for the test, if set. - - - - - Gets or sets the test to be run. - - - - - Gets the test case to be run. - - - - - Gets or sets the runtime type of the class that contains the test method. - - - - - Gets or sets the runtime method of the method that contains the test. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - This method is called just after is sent, but before the test class is created. - This method should NEVER throw; any exceptions should be placed into the . - - - - - This method is called just before is sent. - This method should NEVER throw; any exceptions should be placed into the . - - - - - Runs the test. - - Returns summary information about the test that was run. - - - - Override this method to invoke the test. - - The exception aggregator used to run code and collect exceptions. - Returns a tuple which includes the execution time (in seconds) spent running the - test method, and any output that was returned by the test. - - - - The test assembly runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The assembly that contains the tests to be run. - The test cases to be run. - The message sink to report diagnostic messages to. - The message sink to report run status to. - The user's requested execution options. - - - - - - - - - - - - - Gets the synchronization context used when potentially running tests in parallel. - If is greater than 0, it creates - and uses an instance of . - - The maximum number of parallel threads. - - - - Ensures the assembly runner is initialized (sets up the collection behavior, - parallelization options, and test orderers from their assembly attributes). - - - - - - - - - - - - - - - - - The test case runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test case to be run. - The display name of the test case. - The skip reason, if the test is to be skipped. - The arguments to be passed to the test class constructor. - The arguments to be passed to the test method. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s that will be used for this test case. - - - - - Gets or sets the arguments passed to the test class constructor - - - - - Gets or sets the display name of the test case - - - - - Gets or sets the skip reason for the test, if set. - - - - - Gets or sets the runtime type for the test class that the test method belongs to. - - - - - Gets of sets the runtime method for the test method that the test case belongs to. - - - - - Gets or sets the arguments to pass to the test method when it's being invoked. - - - - - - - - The test class runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test class to be run. - The test class that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - The mapping of collection fixture types to fixtures. - - - - Gets the fixture mappings that were created during . - - - - - Creates the instance of a class fixture type to be used by the test class. If the fixture can be created, - it should be placed into the dictionary; if it cannot, then the method - should record the error by calling Aggregator.Add. - - The type of the fixture to be created - - - - - - - - - - - - - - - - - - - - - - The test collection runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test collection that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages - The message bus to report run status to. - The test case orderer that will be used to decide how to order the test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the fixture mappings that were created during . - - - - - - - - - - - Creates the instance of a collection fixture type to be used by the test collection. If the fixture can be created, - it should be placed into the dictionary; if it cannot, then the method - should record the error by calling Aggregator.Add. - - The type of the fixture to be created - - - - Gives an opportunity to override test case orderer. By default, this method gets the - orderer from the collection definition. If this function returns null, the - test case orderer passed into the constructor will be used. - - - - - - - - The test invoker for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The list of s for this test invocation. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s for this test invocation. - - - - - - - - - - - The test method runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test method to be run. - The test class that contains the test method. - The test method that contains the tests to be run. - The test cases to be run. - The message sink used to send diagnostic messages to. - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - The constructor arguments for the test class. - - - - - - - The test runner for xUnit.net v2 tests. - - - - - Initializes a new instance of the class. - - The test that this invocation belongs to. - The message bus to report run status to. - The test class that the test method belongs to. - The arguments to be passed to the test class constructor. - The test method that will be invoked. - The arguments to be passed to the test method. - The skip reason, if the test is to be skipped. - The list of s for this test. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - Gets the list of s for this test. - - - - - - - - Override this method to invoke the test method. - - The exception aggregator used to run code and collect exceptions. - Returns the execution time (in seconds) spent running the test method. - - - - The test case runner for xUnit.net v2 theories (which could not be pre-enumerated; - pre-enumerated test cases use ). - - - - - Initializes a new instance of the class. - - The test case to be run. - The display name of the test case. - The skip reason, if the test is to be skipped. - The arguments to be passed to the test class constructor. - The message sink used to send diagnostic messages - The message bus to report run status to. - The exception aggregator used to run code and collect exceptions. - The task cancellation token source, used to cancel the test run. - - - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test assembly. - The optional configuration filename (defaults to the - configuration file of the current app domain if not provided) - The version number of the assembly (defaults to "0.0.0.0") - - - - - - - - - - Gets or sets the assembly version. - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test collection the class belongs to - The test class - - - - - - - - - - - - - - - - An implementation of for . - Compares the fully qualified names of the types. - - - - - The singleton instance of the comparer. - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test assembly the collection belongs to - The optional type which contains the collection definition - The display name for the test collection - - - - - - - - - - - - - - - - - - - - - - An implementation of for . - Compares the IDs of the test collections. - - - - - The singleton instance of the comparer. - - - - - - - - - - - A helper class that gets the list of test collection definitions for a given assembly. - Reports any misconfigurations of the test assembly via the diagnostic message sink. - - - - - Gets the test collection definitions for the given assembly. - - The assembly. - The message sink used to send diagnostic messages - A list of mappings from test collection name to test collection definitions (as - - - - A default implementation of that tracks objects to be - disposed when the framework is disposed. The discoverer and executor are automatically - tracked for disposal, since those interfaces mandate an implementation of . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Gets the message sink used to send diagnostic messages. - - - - - Gets the disposal tracker for the test framework. - - - - - - - - - - - Override this method to provide the implementation of . - - The assembly that is being discovered. - Returns the test framework discoverer. - - - - Override this method to provide the implementation of . - - The assembly that is being executed. - Returns the test framework executor. - - - - - - - - - - A base implementation of that supports test filtering - and runs the discovery process on a thread pool thread. - - - - - Initializes a new instance of the class. - - The test assembly. - The source information provider. - The message sink used to send diagnostic messages - - - - Gets the assembly that's being discovered. - - - - - Gets the message sink used to report diagnostic messages. - - - - - Gets the disposal tracker for the test framework discoverer. - - - - - Get the source code information provider used during discovery. - - - - - - - - - - - Implement this method to create a test class for the given CLR type. - - The CLR type. - The test class. - - - - - - - - - - - - - Core implementation to discover unit tests in a given test class. - - The test class. - Set to true to attempt to include source information. - The message sink to send discovery messages to. - The options used by the test framework during discovery. - Returns true if discovery should continue; false otherwise. - - - - Determines if a type should be used for discovery. Can be used to filter out types that - are not desirable. The default implementation filters out abstract (non-static) classes. - - The type. - Returns true if the type can contain tests; false, otherwise. - - - - Reports a discovered test case to the message bus, after updating the source code information - (if desired). - - - - - - - - - - - - A reusable implementation of which contains the basic behavior - for running tests. - - The type of the test case used by the test framework. Must - derive from . - - - - Initializes a new instance of the class. - - Name of the test assembly. - The source line number information provider. - The message sink to report diagnostic messages to. - - - - Gets the assembly information of the assembly under test. - - - - - Gets the message sink to send diagnostic messages to. - - - - - Gets the disposal tracker for the test framework discoverer. - - - - - Gets the source information provider. - - - - - Override to create a test framework discoverer that can be used to discover - tests when the user asks to run all test. - - The test framework discoverer - - - - - - - - - - - - - - - - Override to run test cases. - - The test cases to be run. - The message sink to report run status to. - The user's requested execution options. - - - - This class proxies for the real implementation of , based on - whether the user has overridden the choice via . If - no attribute is found, defaults to . - - - - - Initializes a new instance of the class. - - The test assembly (expected to implement ). - The source information provider (expected to implement ). - The diagnostic message sink (expected to implement ). - - - - Gets the test framework that's being wrapped by the proxy. - - - - - - - - - - - - - - - - - INTERNAL CLASS. DO NOT USE. - - - - - - - - - - - - - - The default implementation of . - - - - - - - - Initializes a new instance of the class. - - The test class - The test method - - - - - - - - - - - - - - - - An implementation of for . - Compares the names of the methods. - - - - - The singleton instance of the comparer. - - - - - - - - - - - A base class implementation of which is based on test cases being - related directly to test methods. - - - - - Used for de-serialization. - - - - - Initializes a new instance of the class. - - Default method display to use (when not customized). - The test method this test case belongs to. - The arguments for the test method. - - - - Returns the base display name for a test ("TestClassName.MethodName"). - - - - - Returns the default method display to use (when not customized). - - - - - - - - - - - Gets the generic types that were used to close the generic test method, if - applicable; null, if the test method was not an open generic. - - - - - - - - - - - - - - - - - - - - - - - - - - Call to ensure the object is fully initialized(). - - - - - Gets the unique ID for the test case. - - - - Converts an array of bytes to its hexadecimal value as a string. - The bytes. - A string containing the hexademical representation of the provided bytes. - - - Gets a hexademical digit character from the 4-bit value. - A value in the range [0, 15]. - A character in the range ['0','9'] or ['a','f']. - - - - Called when initializing the test cases, either after constructor or de-serialization. - Override this method to add additional initialization-time work. - - - - - - - - - - - Default implementation of . - - - - - Gets the output provided by the test. - - - - - Initialize the test output helper with information about a test case. - - - - - Resets the test output helper to its uninitialized state. - - - - - - - - - - - Implementation of that supports finding test cases - on methods decorated with . - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - Creates a test case for a single row of data. By default, returns an instance of - with the data row inside of it. - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The row of data for this test case. - The test case - - - - Creates a test case for a skipped theory. By default, returns an instance of - (which inherently discovers the skip reason via the fact attribute). - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The skip reason that decorates . - The test case - - - - Creates a test case for the entire theory. This is used when one or more of the theory data items - are not serializable, or if the user has requested to skip theory pre-enumeration. By default, - returns an instance of , which performs the data discovery at runtime. - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - The test case - - - - Discover test cases from a test method. - - - This method performs the following steps: - - If the theory attribute is marked with Skip, returns the single test case from ; - - If pre-enumeration is off, or any of the test data is non serializable, returns the single test case from ; - - If there is no theory data, returns a single test case of with the error in it; - - Otherwise, it returns one test case per data row, created by calling . - - The discovery options to be used. - The test method the test cases belong to. - The theory attribute attached to the test method. - Returns zero or more test cases represented by the test method. - - - - An implementation of for xUnit v2. - - - - - Initializes a new instance of the class. - - The test case this test belongs to. - The display name for this test. - - - - - - - Gets the xUnit v2 test case. - - - - - - - - Default implementation of for xUnit v2 that supports tests decorated with - both and . - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The test method this test case belongs to. - The arguments for the test method. - - - - Gets the display name for the test case. Calls - with the given base display name (which is itself either derived from , - falling back to . - - The fact attribute the decorated the test case. - The base display name from . - The display name for the test case. - - - - Gets the skip reason for the test case. By default, pulls the skip reason from the - property. - - The fact attribute the decorated the test case. - The skip reason, if skipped; null, otherwise. - - - - - - - - - - The implementation of that supports discovery and - execution of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - - - - - - - - - - The implementation of that supports discovery - of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Gets the display name of the xUnit.net v2 test framework. - - - - - Initializes a new instance of the class. - - The test assembly. - The source information provider. - The message sink used to send diagnostic messages - The test collection factory used to look up test collections. - - - - Gets the test collection factory that makes test collections. - - - - - - - - Finds the tests on a test method. - - The test method. - Set to true to indicate that source information should be included. - The message bus to report discovery messages to. - The options used by the test framework during discovery. - Return true to continue test discovery, false, otherwise. - - - - - - - Gets the test case discover instance for the given discoverer type. The instances are cached - and reused, since they should not be stateful. - - The discoverer type. - Returns the test case discoverer instance. - - - - The implementation of that supports execution - of unit tests linked against xunit.core.dll, using xunit.execution.dll. - - - - - Initializes a new instance of the class. - - Name of the test assembly. - The source line number information provider. - The message sink to report diagnostic messages to. - - - - Gets the test assembly that contains the test. - - - - - - - - - - - Represents a test case which runs multiple tests for theory data, either because the - data was not enumerable or because the data was not serializable. - - - - - - - - Initializes a new instance of the class. - - The message sink used to send diagnostic messages - Default method display to use (when not customized). - The method under test. - - - - - - - An implementation of which runs work on custom threads - rather than in the thread pool, and limits the number of in-flight actions. - - - - - Initializes a new instance of the class. - - The maximum number of tasks to run at any one time. - - - - Gets a flag indicating whether maximum concurrency is supported. - - - - - - - - - - - - - - This is an internal class, and is not intended to be called from end-user code. - - - - - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. - - - - - Initializes a new instance of the class. - - The message bus to delegate to. - The callback to send messages to. - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. In addition, - it issues a event when a message of the type - is seen. - - The type of the T final message. - - - - Initializes a new instance of the class. - - The message bus to delegate to. - The callback to send messages to. - - - - The final message that was seen that caused to be triggered. - - - - - An event that is triggered when a message of type is seen. - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. - - - - - Initializes a new instance of the class. - - The inner message sink. - The callback. - - - - - - - - - - Implementation of that delegates to another implementation of - while calling into a callback for each message. In addition, - it issues a event when a message of the type - is seen. - - The type of the T final message. - - - - Initializes a new instance of the class. - - The inner message sink. - The callback. - - - - The final message that was seen that caused to be triggered. - - - - - An event that is triggered when a message of type is seen. - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The assembly to be wrapped. - - - - Initializes a new instance of the class. - - The assembly to be wrapped. - - - - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The attribute to be wrapped. - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The method to be wrapped. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The parameter to be wrapped. - - - - - - - - - - - - - Reflection-based implementation of . - - - - - Initializes a new instance of the class. - - The type to wrap. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Wrapper to implement types from xunit.abstractions.dll using reflection. - - - - - Converts arguments into their target types. Can be particularly useful when pulling attribute - constructor arguments, whose types may not strictly match the parameter types. - - The arguments to be converted. - The target types for the conversion. - The converted arguments. - - - - Converts an into an . - - The assembly to wrap. - The wrapper - - - - Converts an into an using reflection. - - The attribute to wrap. - The wrapper - - - - Converts a into an using reflection. - - The method to wrap - The wrapper - - - - Converts a into an using reflection. - - THe parameter to wrap - The wrapper - - - - Converts a into an using reflection. - - The type to wrap - The wrapper - - - - This is an internal class, and is not intended to be called from end-user code. - - - - - - - - - - - - - - Represents an exception that happened during the process of a test class. This typically - means there were problems identifying the correct test class constructor, or problems - creating the fixture data for the test class. - - - - - Initializes a new instance of the class. - - The exception message. - - - - The implementation of that supports attributes - of type . - - - - - - - - A helper class to retrieve the traits from a method. - - - - - Get the traits from a method. - - The method to get the traits for. - A list of traits that are defined on the method. - - - - Extension methods for . - - - - - Formulates the extended portion of the display name for a test method. For tests with no arguments, this will - return just the base name; for tests with arguments, attempts to format the arguments and appends the argument - list to the test name. - - The test method - The base part of the display name - The test method arguments - The test method's generic types - The full display name for the test method - - - - Resolves a generic type for a test method. The test parameters (and associated parameter infos) are - used to determine the best matching generic type for the test method that can be satisfied by all - the generic parameters and their values. - - The generic type to be resolved - The parameter values being passed to the test method - The parameter infos for the test method - The best matching generic type - - - - Resolves all the generic types for a test method. The test parameters are used to determine - the best matching generic types for the test method that can be satisfied by all - the generic parameters and their values. - - The test method - The parameter values being passed to the test method - The best matching generic types - - - base implementation of MD4 family style digest as outlined in - "Handbook of Applied Cryptography", pages 344 - 347. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - implementation of SHA-1 as outlined in "Handbook of Applied Cryptography", pages 346 - 349. - - It is interesting to ponder why the, apart from the extra IV, the other difference here from MD5 - is the "endianness" of the word processing! - - - - - - - Copy constructor. This will copy the state of the provided - message digest. - - - - - - - - - - - - reset the chaining variables - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of and . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message to send - - - - Initializes a new instance of the class. - - The format of the message to send - The arguments used to format the message - - - - - - - Default implementation of . - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - - - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - - - - Default implementation of . - - - - - Initializes a new instance of the class. - - - - - Gets the substitution token used as assembly name suffix to indicate that the assembly is - a generalized reference to the platform-specific assembly. - - - - - A mirror class of the CLR's class. - - - - - Initializes a new instance of the class. - - The data to copy into the serialization info - - - - - - - - - - - - - Returns BASE64 encoded string that represents the entirety of the data. - - - - - Returns a triple for a key/value pair of data in a complex object - - The triple to be serialized - The serialized version of the triple - - - - Returns the triple values out of a serialized triple. - - The serialized triple - The de-serialized triple - - - - De-serializes a value that was serialized with . - - The type of the object to de-serialize into - The serialized value - The de-serialized object - - - - Serializes an object. - - The value to be serialized - The serialized object - - - - Represents a triple of information used when serializing complex types: the property name, - the value to be serialized, and the value's type. - - - - - Gets the triple's key - - - - - Gets the triple's value - - - - - Gets the triple's value type - - - - - Initializes a new instance of the class. - - The triple's key - The triple's value - The triple's value type - - - - Guard class, used for guard clauses and argument validation - - - - - - - - - - - - - - Methods which help bridge and contain the differences between Type and TypeInfo. - - - - - This class represents utility methods needed to supplement the - reflection capabilities provided by the CLR - - - - - Creates an instance of the test class for the given test case. Sends the - and messages as appropriate. - - The test - The type of the test class - The constructor arguments for the test class - The message bus used to send the test messages - The timer used to measure the time taken for construction - The cancellation token source - - - - - Disposes the test class instance. Sends the and - messages as appropriate. - - The test - The test class instance to be disposed - The message bus used to send the test messages - The timer used to measure the time taken for construction - The cancellation token source - - - - Gets methods in the target type that match the protection level of the supplied method - - The type - The method - The reflection method informations that match - - - - Gets all the custom attributes for the given assembly. - - The assembly - The type of the attribute - The matching attributes that decorate the assembly - - - - Gets all the custom attributes for the given attribute. - - The attribute - The type of the attribute to find - The matching attributes that decorate the attribute - - - - Gets all the custom attributes for the method that are of the given type. - - The method - The type of the attribute - The matching attributes that decorate the method - - - - Gets all the custom attributes for the given type. - - The type - The type of the attribute - The matching attributes that decorate the type - - - - Converts an into a , if possible (for example, this - will not work when the test method is based on source code rather than binaries). - - The method to convert - The runtime method, if available; null, otherwise - - - - Converts an into a , if possible (for example, this - will not work when the test class is based on source code rather than binaries). - - The type to convert - The runtime type, if available, null, otherwise - - - - Extension methods for reading and . - - - - - Gets a flag that determines whether diagnostic messages will be emitted. - - - - - Gets a flag that determines whether diagnostic messages will be emitted. If the flag is not present, - returns the default value (false). - - - - - Gets a flag that determines the default display name format for test methods. - - - - - Gets a flag that determines the default display name format for test methods. If the flag is not present, - returns the default value (). - - - - - Gets a flag that determines whether theories are pre-enumerated. If they enabled, then the - discovery system will return a test case for each row of test data; they are disabled, then the - discovery system will return a single test case for the theory. - - - - - Gets a flag that determines whether theories are pre-enumerated. If they enabled, then the - discovery system will return a test case for each row of test data; they are disabled, then the - discovery system will return a single test case for the theory. If the flag is not present, - returns the default value (true). - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - If the flag is not set, returns the default value (false). - - - - - Gets a flag that determines whether diagnostic messages will be emitted. - - - - - Gets a flag that determines whether diagnostic messages will be emitted. If the flag is not - present, returns the default value (false). - - - - - Gets a flag to disable parallelization. - - - - - Gets a flag to disable parallelization. If the flag is not present, returns the - default value (false). - - - - - Gets the maximum number of threads to use when running tests in parallel. - - - - - Gets the maximum number of threads to use when running tests in parallel. If set to 0 (or not set), - the value of is used; if set to a value less - than 0, does not limit the number of threads. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - - - - - Gets a flag that determines whether xUnit.net should report test results synchronously. - If the flag is not set, returns the default value (false). - - - - diff --git a/packages/xunit.extensibility.execution.2.1.0/xunit.extensibility.execution.2.1.0.nupkg b/packages/xunit.extensibility.execution.2.1.0/xunit.extensibility.execution.2.1.0.nupkg deleted file mode 100644 index 14a3ee8..0000000 Binary files a/packages/xunit.extensibility.execution.2.1.0/xunit.extensibility.execution.2.1.0.nupkg and /dev/null differ diff --git a/packages/xunit.runner.console.2.1.0/tools/HTML.xslt b/packages/xunit.runner.console.2.1.0/tools/HTML.xslt deleted file mode 100644 index cf055bf..0000000 --- a/packages/xunit.runner.console.2.1.0/tools/HTML.xslt +++ /dev/null @@ -1,239 +0,0 @@ - - - - - - ]]> - - - xUnit.net Test Results - - - - -

- Assemblies Run -

- -

- Summary -

-
- Tests run:   - - Errors: , - - - Failures: , - - - Skipped: , - - Run time: s -
- -
-

- Errors -

- -
- -
-

- Failed tests -

- - - -
- -
-

- Collection failures -

- - - -
- -
-

- Skipped tests -

- - - -
-
-

- All tests -

-
Click test class name to expand/collapse test details
- - - -

- - s - - - ToggleClass('class') - ToggleClass('class') - - - - - - -   -   - ( tests) - - -
-

-
- - display: none; - - class - - - -
-
- - -
- - -
- -
-
- - -
- altrow - - - s - - - - Skipped - - - - - - - - -   -
- -
-
- -
-
- -
Output:
-
-
- -
Traits:
- - -
-
-
-
- - - - - - - - - -

- -
- altrow -
- -
-
- -
-
-
-
-
- - - -
- - altrow - - - Test Assembly Cleanup - Test Collection Cleanup - Test Class Cleanup - Test Method Cleanup - Test Case Cleanup - Test Cleanup - Fatal Error - - () - -
- -
-
- -
-
-
-
-
- -
\ No newline at end of file diff --git a/packages/xunit.runner.console.2.1.0/tools/NUnitXml.xslt b/packages/xunit.runner.console.2.1.0/tools/NUnitXml.xslt deleted file mode 100644 index 228fbed..0000000 --- a/packages/xunit.runner.console.2.1.0/tools/NUnitXml.xslt +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - False - True - - - - - - - - - - - - - - - - - - False - True - - - - - - - - - - - - - - - - - False - True - - - - - - - - - - - - - - - - - - - - - - - - - False - True - - - - False - True - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/packages/xunit.runner.console.2.1.0/tools/xUnit1.xslt b/packages/xunit.runner.console.2.1.0/tools/xUnit1.xslt deleted file mode 100644 index a8425d3..0000000 --- a/packages/xunit.runner.console.2.1.0/tools/xUnit1.xslt +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/packages/xunit.runner.console.2.1.0/tools/xunit.abstractions.dll b/packages/xunit.runner.console.2.1.0/tools/xunit.abstractions.dll deleted file mode 100644 index f645709..0000000 Binary files a/packages/xunit.runner.console.2.1.0/tools/xunit.abstractions.dll and /dev/null differ diff --git a/packages/xunit.runner.console.2.1.0/tools/xunit.console.exe b/packages/xunit.runner.console.2.1.0/tools/xunit.console.exe deleted file mode 100644 index 4adb57f..0000000 Binary files a/packages/xunit.runner.console.2.1.0/tools/xunit.console.exe and /dev/null differ diff --git a/packages/xunit.runner.console.2.1.0/tools/xunit.console.exe.config b/packages/xunit.runner.console.2.1.0/tools/xunit.console.exe.config deleted file mode 100644 index 6f7877d..0000000 --- a/packages/xunit.runner.console.2.1.0/tools/xunit.console.exe.config +++ /dev/null @@ -1,18 +0,0 @@ - - - -
- - - - - - - - - - - - - - diff --git a/packages/xunit.runner.console.2.1.0/tools/xunit.console.x86.exe b/packages/xunit.runner.console.2.1.0/tools/xunit.console.x86.exe deleted file mode 100644 index 0a9881d..0000000 Binary files a/packages/xunit.runner.console.2.1.0/tools/xunit.console.x86.exe and /dev/null differ diff --git a/packages/xunit.runner.console.2.1.0/tools/xunit.console.x86.exe.config b/packages/xunit.runner.console.2.1.0/tools/xunit.console.x86.exe.config deleted file mode 100644 index f68633b..0000000 --- a/packages/xunit.runner.console.2.1.0/tools/xunit.console.x86.exe.config +++ /dev/null @@ -1,18 +0,0 @@ - - - -
- - - - - - - - - - - - - - diff --git a/packages/xunit.runner.console.2.1.0/tools/xunit.runner.reporters.desktop.dll b/packages/xunit.runner.console.2.1.0/tools/xunit.runner.reporters.desktop.dll deleted file mode 100644 index 8be2ed3..0000000 Binary files a/packages/xunit.runner.console.2.1.0/tools/xunit.runner.reporters.desktop.dll and /dev/null differ diff --git a/packages/xunit.runner.console.2.1.0/tools/xunit.runner.utility.desktop.dll b/packages/xunit.runner.console.2.1.0/tools/xunit.runner.utility.desktop.dll deleted file mode 100644 index fc88513..0000000 Binary files a/packages/xunit.runner.console.2.1.0/tools/xunit.runner.utility.desktop.dll and /dev/null differ diff --git a/packages/xunit.runner.console.2.1.0/xunit.runner.console.2.1.0.nupkg b/packages/xunit.runner.console.2.1.0/xunit.runner.console.2.1.0.nupkg deleted file mode 100644 index 29efca1..0000000 Binary files a/packages/xunit.runner.console.2.1.0/xunit.runner.console.2.1.0.nupkg and /dev/null differ